` tags. [#2281](https://github.com/gocodebox/lifterlms/issues/2281)
+ When an order post is restored from the trash its post status will now be "llms-pending" in favor of the default "draft" status.
##### Bug Fixes
+ Fixed unclosed checkout div wrapper on empty cart. [#2277](https://github.com/gocodebox/lifterlms/issues/2277)
+ Don't attempt to lookup the default payment gateway from user meta data.
+ Fixed required fields duplication when the form is a child of a `.wp-block-column` element. [#2134](https://github.com/gocodebox/lifterlms/issues/2134)
+ Fixed an issue that prevented disabling the access plan’s option, Override Membership Redirects, once enabled. [#2234](https://github.com/gocodebox/lifterlms/issues/2234)
+ Disabled `scroll-behavior: smooth` on checkout screen to address form element validity checking issues on Chromium-based browsers. [#2206](https://github.com/gocodebox/lifterlms/issues/2206)
##### Deprecations
+ Deprecated `LLMS_Controller_Orders::switch_payment_source()` in favor of `LLMS_Controller_Checkout::switch_payment_source()`.
+ Deprecated the `lifterlms_update_option_{$type}` action in favor of the `llms_update_option_{$type}` filter.
+ Method `LLMS_Controller_Orders::confirm_pending_order()` is deprecated in favor of `LLMS_Controller_Checkout::confirm_pending_order()`.
+ Method `LLMS_Controller_Orders::create_pending_order()` is deprecated in favor of `LLMS_Controller_Checkout::create_pending_order()`.
+ Method `LLMS_Controller_Orders::switch_payment_source()` is deprecated in favor of `LLMS_Controller_Checkout::switch_payment_source()`.
+ Passing jQuery selections into the `window.LLMS.Spinner` functions is deprecated. Use JS `Elements` or selection strings parseable by `document.querySelector()` instead.
+ Deprecated hook `llms_{$method}_title` in favor of `llms_{$method}_refund_title`.
##### Developer Notes
+ Added admin settings helper function, `llms_get_dashicon_link()`, intended to enable the addition of external resource helper links to settings field descriptions.
+ The `LLMS_Student` object can be instantiated as an empty object and bypass current user autoloading. In the future this may affect integrations using the `lifterlms_new_pending_order` action hook which will receive an "empty" student object during order setup by gateways utilizing new AJAX-powered checkout endpoints.
+ Added a filter, `llms_gateway_{$this->id}_logging_enabled`, which will allow force enabling/disabling of gateway logging functions.
+ Improved payment gateway secure string logging by adding a method, `add_secure_string()` allowing developers to add secure strings during runtime without the necessity of registering the strings using filters.
+ Introduces new function `llms_is_option_secure()` for determining if an "secured" option is defined in a "secure" manner.
+ Implemented new gateway feature: `modify_recurring_payments`. [#2176](https://github.com/gocodebox/lifterlms/issues/2176)
+ Added two new parameters to LLMS_Access_Plan::get_redirection_url() - `$encode` to optionally get a raw (not encoded) URL. - `$querystring_only` to optionally get only the redirect URL if set via NPUT_GET variable.
+ Added new parameter `$querystring_only` to the filter hook `llms_plan_get_checkout_redirection`.
+ Admin settings fields now display `after_html` for additional field types which support `desc`.
+ The CSS for `.llms-spinning` and `.llms-spinner` elements is no longer loaded as part of the `lifterlms.css` and `admin.css` files, instead it is loaded dynamically when `window.LLMS.Spinner` functions are called. In some cases CSS overrides to these elements which relied on CSS rule load order may no longer successfully override the default CSS rules. These overrides may need to be updated to have more specific selectors in order to ensure the overrides are retained.
+ The Javascript object, `window.LLMS.Spinner`, has been converted to a module accessible from the same variable.
+ The `window.LLMS.Spinner` methods now accept JS Elements and selector strings parseable by `document.querySelector()` in addition to jQuery selections.
+ Added new filter `llms_transaction_can_be_refunded` enabling custom refund restrictions to be applied to a transaction.
##### Updated Templates
+ [templates/block-templates/archive-course.html](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/block-templates/archive-course.html)
+ [templates/block-templates/archive-llms_membership.html](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/block-templates/archive-llms_membership.html)
+ [templates/block-templates/single-no-access.html](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/block-templates/single-no-access.html)
+ [templates/block-templates/taxonomy-course_cat.html](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/block-templates/taxonomy-course_cat.html)
+ [templates/block-templates/taxonomy-course_difficulty.html](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/block-templates/taxonomy-course_difficulty.html)
+ [templates/block-templates/taxonomy-course_tag.html](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/block-templates/taxonomy-course_tag.html)
+ [templates/block-templates/taxonomy-course_track.html](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/block-templates/taxonomy-course_track.html)
+ [templates/block-templates/taxonomy-membership_cat.html](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/block-templates/taxonomy-membership_cat.html)
+ [templates/block-templates/taxonomy-membership_tag.html](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/block-templates/taxonomy-membership_tag.html)
+ [templates/checkout/form-gateways.php](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/checkout/form-gateways.php)
+ [templates/checkout/form-switch-source.php](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/checkout/form-switch-source.php)
+ [templates/myaccount/view-order-actions.php](https://github.com/gocodebox/lifterlms/blob/7.0.0/templates/myaccount/view-order-actions.php)
v6.11.0 - 2022-09-22
--------------------
##### Updates and Enhancements
+ Since version 6.0.0, the Certificate Title Block provided the option to use four Google-hosted fonts. These fonts will now be served from the site's server in favor of serving them from the Google Fonts CDN. For more information about this change, please refer to https://make.wordpress.org/themes/2022/06/18/complying-with-gdpr-when-using-google-fonts/. If you wish to continue loading fonts from Google's CDN, add the following code to your functions.php file: `add_filter( 'llms_use_google_webfonts', '__return_true' );`. [#2189](https://github.com/gocodebox/lifterlms/issues/2189)
+ Upgraded included library, `@woocommerce/action-scheduler`, to version [3.5.2](https://github.com/woocommerce/action-scheduler/releases/tag/3.5.2).
##### Bug Fixes
+ Fixed a division by zero error encountered on quiz reporting screens for quizzes with 0 total available points. [#2270](https://github.com/gocodebox/lifterlms/issues/2270)
v7.0.0-rc.1 - 2022-09-14
------------------------
##### New Features
+ Added handling for admin settings options that store their option values in a nested array.
+ Added new AJAX checkout and payment source switching endpoints for payment gateways to utilize instead of the preexisting synchronous form submission methods.
+ On purchase completed retrieve the redirection URL from the INPUT_POST 'redirect' variable, if no 'redirect' variable is passed via INPUT_GET. The INPUT_POST 'redirect' variable comes from the new checkout form's hidden field 'redirect' populated with LLMS_Access_Plan::get_redirection_url(). [#2229](https://github.com/gocodebox/lifterlms/issues/2229)
##### Updates and Enhancements
+ When an order post is restored from the trash its post status will now be "llms-pending" in favor of the default "draft" status.
##### Bug Fixes
+ Don't attempt to lookup the default payment gateway from user meta data.
+ Fixed an issue that prevented disabling the access plan’s option, Override Membership Redirects, once enabled. [#2234](https://github.com/gocodebox/lifterlms/issues/2234)
+ Disabled `scroll-behavior: smooth` on checkout screen to address form element validity checking issues on Chromium-based browsers. [#2206](https://github.com/gocodebox/lifterlms/issues/2206)
##### Deprecations
+ Deprecated `LLMS_Controller_Orders::switch_payment_source()` in favor of `LLMS_Controller_Checkout::switch_payment_source()`.
+ Deprecated the `lifterlms_update_option_{$type}` action in favor of the `llms_update_option_{$type}` filter.
+ Method `LLMS_Controller_Orders::confirm_pending_order()` is deprecated in favor of `LLMS_Controller_Checkout::confirm_pending_order()`.
+ Method `LLMS_Controller_Orders::create_pending_order()` is deprecated in favor of `LLMS_Controller_Checkout::create_pending_order()`.
+ Method `LLMS_Controller_Orders::switch_payment_source()` is deprecated in favor of `LLMS_Controller_Checkout::switch_payment_source()`.
+ Passing jQuery selections into the `window.LLMS.Spinner` functions is deprecated. Use JS `Elements` or selection strings parseable by `document.querySelector()` instead.
+ Deprecated hook `llms_{$method}_title` in favor of `llms_{$method}_refund_title`.
##### Developer Notes
+ Added admin settings helper function, `llms_get_dashicon_link()`, intended to enable the addition of external resource helper links to settings field descriptions.
+ The `LLMS_Student` object can be instantiated as an empty object and bypass current user autoloading. In the future this may affect integrations using the `lifterlms_new_pending_order` action hook which will receive an "empty" student object during order setup by gateways utilizing new AJAX-powered checkout endpoints.
+ Added a filter, `llms_gateway_{$this->id}_logging_enabled`, which will allow force enabling/disabling of gateway logging functions.
+ Improved payment gateway secure string logging by adding a method, `add_secure_string()` allowing developers to add secure strings during runtime without the necessity of registering the strings using filters.
+ Introduces new function `llms_is_option_secure()` for determining if an "secured" option is defined in a "secure" manner.
+ Implemented new gateway feature: `modify_recurring_payments`. [#2176](https://github.com/gocodebox/lifterlms/issues/2176)
+ Added two new parameters to LLMS_Access_Plan::get_redirection_url() - `$encode` to optionally get a raw (not encoded) URL. - `$querystring_only` to optionally get only the redirect URL if set via NPUT_GET variable.
+ Added new parameter `$querystring_only` to the filter hook `llms_plan_get_checkout_redirection`.
+ Admin settings fields now display `after_html` for additional field types which support `desc`.
+ The CSS for `.llms-spinning` and `.llms-spinner` elements is no longer loaded as part of the `lifterlms.css` and `admin.css` files, instead it is loaded dynamically when `window.LLMS.Spinner` functions are called. In some cases CSS overrides to these elements which relied on CSS rule load order may no longer successfully override the default CSS rules. These overrides may need to be updated to have more specific selectors in order to ensure the overrides are retained.
+ The Javascript object, `window.LLMS.Spinner`, has been converted to a module accessible from the same variable.
+ The `window.LLMS.Spinner` methods now accept JS Elements and selector strings parseable by `document.querySelector()` in addition to jQuery selections.
+ Added new filter `llms_transaction_can_be_refunded` enabling custom refund restrictions to be applied to a transaction.
##### Updated Templates
+ [templates/checkout/form-gateways.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-rc.1/templates/checkout/form-gateways.php)
+ [templates/checkout/form-switch-source.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-rc.1/templates/checkout/form-switch-source.php)
+ [templates/myaccount/view-order-actions.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-rc.1/templates/myaccount/view-order-actions.php)
v6.10.2 - 2022-09-14
--------------------
##### Updates and Enhancements
+ Updated `woocommerce/action-scheduler` to version [3.5.1](https://github.com/woocommerce/action-scheduler/releases/tag/3.5.1).
##### Security Fixes
+ Fixed a data sanitization issue related to achievement permalinks.
v6.10.1 - 2022-09-07
--------------------
##### Bug Fixes
+ Fixed a PHP warning raised when logging errors during email notification dispatch. [#2250](https://github.com/gocodebox/lifterlms/issues/2250)
+ Fixed issue preventing one-time orders for being included in membership revenue reporting widgets. [#2254](https://github.com/gocodebox/lifterlms/issues/2254)
v7.0.0-beta.1 - 2022-08-29
--------------------------
##### New Features
+ Added handling for admin settings options that store their option values in a nested array.
+ Added new AJAX checkout and payment source switching endpoints for payment gateways to utilize instead of the preexisting synchronous form submission methods.
+ On purchase completed retrieve the redirection URL from the INPUT_POST 'redirect' variable, if no 'redirect' variable is passed via INPUT_GET. The INPUT_POST 'redirect' variable comes from the new checkout form's hidden field 'redirect' populated with LLMS_Access_Plan::get_redirection_url(). [#2229](https://github.com/gocodebox/lifterlms/issues/2229)
##### Updates and Enhancements
+ When an order post is restored from the trash its post status will now be "llms-pending" in favor of the default "draft" status.
##### Bug Fixes
+ Don't attempt to lookup the default payment gateway from user meta data.
+ Fixed an issue that prevented disabling the access plan’s option, Override Membership Redirects, once enabled. [#2234](https://github.com/gocodebox/lifterlms/issues/2234)
+ Disabled `scroll-behavior: smooth` on checkout screen to address form element validity checking issues on Chromium-based browsers. [#2206](https://github.com/gocodebox/lifterlms/issues/2206)
##### Deprecations
+ Deprecated `LLMS_Controller_Orders::switch_payment_source()` in favor of `LLMS_Controller_Checkout::switch_payment_source()`.
+ Deprecated the `lifterlms_update_option_{$type}` action in favor of the `llms_update_option_{$type}` filter.
+ Method `LLMS_Controller_Orders::confirm_pending_order()` is deprecated in favor of `LLMS_Controller_Checkout::confirm_pending_order()`.
+ Method `LLMS_Controller_Orders::create_pending_order()` is deprecated in favor of `LLMS_Controller_Checkout::create_pending_order()`.
+ Method `LLMS_Controller_Orders::switch_payment_source()` is deprecated in favor of `LLMS_Controller_Checkout::switch_payment_source()`.
+ Passing jQuery selections into the `window.LLMS.Spinner` functions is deprecated. Use JS `Elements` or selection strings parseable by `document.querySelector()` instead.
+ Deprecated hook `llms_{$method}_title` in favor of `llms_{$method}_refund_title`.
##### Developer Notes
+ Added admin settings helper function, `llms_get_dashicon_link()`, intended to enable the addition of external resource helper links to settings field descriptions.
+ The `LLMS_Student` object can be instantiated as an empty object and bypass current user autoloading. In the future this may affect integrations using the `lifterlms_new_pending_order` action hook which will receive an "empty" student object during order setup by gateways utilizing new AJAX-powered checkout endpoints.
+ Added a filter, `llms_gateway_{$this->id}_logging_enabled`, which will allow force enabling/disabling of gateway logging functions.
+ Improved payment gateway secure string logging by adding a method, `add_secure_string()` allowing developers to add secure strings during runtime without the necessity of registering the strings using filters.
+ Introduces new function `llms_is_option_secure()` for determining if an "secured" option is defined in a "secure" manner.
+ Implemented new gateway feature: `modify_recurring_payments`. [#2176](https://github.com/gocodebox/lifterlms/issues/2176)
+ Added two new parameters to LLMS_Access_Plan::get_redirection_url() - `$encode` to optionally get a raw (not encoded) URL. - `$querystring_only` to optionally get only the redirect URL if set via NPUT_GET variable.
+ Added new parameter `$querystring_only` to the filter hook `llms_plan_get_checkout_redirection`.
+ Admin settings fields now display `after_html` for additional field types which support `desc`.
+ The CSS for `.llms-spinning` and `.llms-spinner` elements is no longer loaded as part of the `lifterlms.css` and `admin.css` files, instead it is loaded dynamically when `window.LLMS.Spinner` functions are called. In some cases CSS overrides to these elements which relied on CSS rule load order may no longer successfully override the default CSS rules. These overrides may need to be updated to have more specific selectors in order to ensure the overrides are retained.
+ The Javascript object, `window.LLMS.Spinner`, has been converted to a module accessible from the same variable.
+ The `window.LLMS.Spinner` methods now accept JS Elements and selector strings parseable by `document.querySelector()` in addition to jQuery selections.
+ Added new filter `llms_transaction_can_be_refunded` enabling custom refund restrictions to be applied to a transaction.
##### Updated Templates
+ [templates/checkout/form-gateways.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-beta.1/templates/checkout/form-gateways.php)
+ [templates/checkout/form-switch-source.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-beta.1/templates/checkout/form-switch-source.php)
+ [templates/myaccount/view-order-actions.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-beta.1/templates/myaccount/view-order-actions.php)
v6.10.0 - 2022-08-29
--------------------
##### Updates and Enhancements
+ Updtaed woocommerce/action-scheduler to version [3.5.0](https://github.com/woocommerce/action-scheduler/releases/tag/3.5.0).
+ Upgrades the bundled `quill-wordcount` module to version 2.0, addressing an issue encountered when counting words with non-Latin character languages.
##### Bug Fixes
+ Make `
` elements in quiz attempt results scrollable.
+ Make sure the current user can edit the lesson, when changing its completion status from the admin reporting.
+ Added missing textodmain for the string 'Move {post_title} to the Trash'. [#2224](https://github.com/gocodebox/lifterlms/issues/2224)
+ Fixed PHP fatal error when quick editing an award. [#2231](https://github.com/gocodebox/lifterlms/issues/2231)
+ Updated Spain's provinces list. [#2243](https://github.com/gocodebox/lifterlms/issues/2243)
##### Deprecations
+ The files `assets/vendor/quill/quill.module.wordcount.js` and `assets/vendor/quill/quill.module.wordcount.min.js` are to be removed in the next major release. Instead of loading these files directly, use `wp_enqueue_script( 'llms-quill-wordcount' )`.
v6.9.0 - 2022-07-28
-------------------
##### Updates and Enhancements
+ Removed site-wide font-weight styles targeting `` through `` elements. [#2217](https://github.com/gocodebox/lifterlms/issues/2217)
##### Bug Fixes
+ Fixed issue preventing decimals from being used for coupon discount amounts. [#2149](https://github.com/gocodebox/lifterlms/issues/2149)
+ Added AR (Arezzo) to Italy's states list. [#2214](https://github.com/gocodebox/lifterlms/issues/2214)
v7.0.0-alpha.4 - 2022-07-18
---------------------------
+ Fixed error causing recurring payment reschedules to fail with a fatal error.
v7.0.0-alpha.3 - 2022-07-16
---------------------------
+ Add max-length sanitization to admin settings which specify a max length.
+ Fixed invalid user links on admin order screens when viewing incomplete orders missing a registered user.
+ Added new function `llms_is_secure()`.
+ Added `lifterlms-` and `llms-` as automatically stripped prefixed when using `llms_strip_prefixes()`.
+ Added new temporary metadata, `temp_gateway_ids` to orders for use by gateways when switching payment methods.
+ Moved `LLMS.Spinner` Javascript into an `@lifterlms/components` module and removed its reliance on jQuery.
+ Disabled `scroll-behavior: scroll` on checkout screens to address a validity reporting issue on Chromium-based browsers.
v6.8.0 - 2022-07-12
-------------------
##### Bug Fixes
+ Fixed Hello Theme's word-break and spacing for quiz answer options. [#2132](https://github.com/gocodebox/lifterlms/issues/2132)
+ Fixed text/label alignment in Twenty-Twenty-Two theme.
+ Fixed regression introduced in version 6.3.0 which prevented the Courses nav item from being customized in the BuddyPress profile nav menu. [#2142](https://github.com/gocodebox/lifterlms/issues/2142)
##### Developer Notes
+ Added new filter `llms_product_get_restrictions` hook to filter the list of restrictions placed on a given product. [#2201](https://github.com/gocodebox/lifterlms/issues/2201)
v7.0.0-alpha.2 - 2022-06-23
---------------------------
##### New Features
+ Added handling for admin settings options that store their option values in a nested array.
+ Added new AJAX checkout and payment source switching endpoints for payment gateways to utilize instead of the preexisting synchronous form submission methods.
##### Bug Fixes
+ Don't attempt to lookup the default payment gateway from user meta data.
+ Fixes Hello Theme's word-break and spacing for quiz answer options. Also fixes text/label alignment in Twenty-Twenty-Two Theme. [#2132](https://github.com/gocodebox/lifterlms/issues/2132)
##### Deprecations
+ Deprecated `LLMS_Controller_Orders::switch_payment_source()` in favor of `LLMS_Controller_Checkout::switch_payment_source()`.
+ Deprecated the `lifterlms_update_option_{$type}` action in favor of the `llms_update_option_{$type}` filter.
+ Method `LLMS_Controller_Orders::confirm_pending_order()` is deprecated in favor of `LLMS_Controller_Checkout::confirm_pending_order()`.
+ Method `LLMS_Controller_Orders::create_pending_order()` is deprecated in favor of `LLMS_Controller_Checkout::create_pending_order()`.
+ Method `LLMS_Controller_Orders::switch_payment_source()` is deprecated in favor of `LLMS_Controller_Checkout::switch_payment_source()`.
+ Deprecated hook `llms_{$method}_title` in favor of `llms_{$method}_refund_title`.
##### Developer Notes
+ Added admin settings helper function, `llms_get_dashicon_link()`, intended to enable the addition of external resource helper links to settings field descriptions.
+ The `LLMS_Student` object can be instantiated as an empty object and bypass current user autoloading. In the future this may affect integrations using the `lifterlms_new_pending_order` action hook which will receive an "empty" student object during order setup by gateways utilizing new AJAX-powered checkout endpoints.
+ Added a filter, `llms_gateway_{$this->id}_logging_enabled`, which will allow force enabling/disabling of gateway logging functions.
+ Improved payment gateway secure string logging by adding a method, `add_secure_string()` allowing developers to add secure strings during runtime without the necessity of registering the strings using filters.
+ Implemented new gateway feature: `modify_recurring_payments`. [#2176](https://github.com/gocodebox/lifterlms/issues/2176)
+ Admin settings fields now display `after_html` for additional field types which support `desc`.
+ Added new filter `llms_transaction_can_be_refunded` enabling custom refund restrictions to be applied to a transaction.
##### Updated Templates
+ [templates/checkout/form-gateways.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-alpha.2/templates/checkout/form-gateways.php)
+ [templates/checkout/form-switch-source.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-alpha.2/templates/checkout/form-switch-source.php)
+ [templates/myaccount/view-order-actions.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-alpha.2/templates/myaccount/view-order-actions.php)
v7.0.0-alpha.1 - 2022-06-15
---------------------------
##### New Features
+ Added new AJAX checkout and payment source switching endpoints for payment gateways to utilize instead of the preexisting synchronous form submission methods.
##### Bug Fixes
+ Don't attempt to lookup the default payment gateway from user meta data.
##### Deprecations
+ Deprecated `LLMS_Controller_Orders::switch_payment_source()` in favor of `LLMS_Controller_Checkout::switch_payment_source()`.
+ Method `LLMS_Controller_Orders::confirm_pending_order()` is deprecated in favor of `LLMS_Controller_Checkout::confirm_pending_order()`.
+ Method `LLMS_Controller_Orders::create_pending_order()` is deprecated in favor of `LLMS_Controller_Checkout::create_pending_order()`.
+ Method `LLMS_Controller_Orders::switch_payment_source()` is deprecated in favor of `LLMS_Controller_Checkout::switch_payment_source()`.
+ Deprecated hook `llms_{$method}_title` in favor of `llms_{$method}_refund_title`.
##### Developer Notes
+ The `LLMS_Student` object can be instantiated as an empty object and bypass current user autoloading. In the future this may affect integrations using the `lifterlms_new_pending_order` action hook which will receive an "empty" student object during order setup by gateways utilizing new AJAX-powered checkout endpoints.
+ Improved payment gateway secure string logging by adding a method, `add_secure_string()` allowing developers to add secure strings during runtime without the necessity of registering the strings using filters.
+ Implemented new gateway feature: `modify_recurring_payments`. [#2176](https://github.com/gocodebox/lifterlms/issues/2176)
+ Added new filter `llms_transaction_can_be_refunded` enabling custom refund restrictions to be applied to a transaction.
##### Updated Templates
+ [templates/checkout/form-gateways.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-alpha.1/templates/checkout/form-gateways.php)
+ [templates/checkout/form-switch-source.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-alpha.1/templates/checkout/form-switch-source.php)
+ [templates/myaccount/view-order-actions.php](https://github.com/gocodebox/lifterlms/blob/7.0.0-alpha.1/templates/myaccount/view-order-actions.php)
v6.7.0 - 2022-06-09
-------------------
##### Updates and Enhancements
+ Update LifterLMS Blocks to [v2.4.3](https://make.lifterlms.com/2022/06/09/lifterlms-blocks-version-2-4-3/).
+ Upgraded Action Scheduler to [v3.4.1](https://github.com/woocommerce/action-scheduler/releases/tag/3.4.1).
+ Upgraded Action Scheduler to [v3.4.2](https://github.com/woocommerce/action-scheduler/releases/tag/3.4.2).
##### Bug Fixes
+ Fixed a fatal error on PHP 8+ when restoring a post type from revision. [#2164](https://github.com/gocodebox/lifterlms/issues/2164)
v6.6.0 - 2022-05-23
-------------------
##### PHP Minimum Required Version Change
+ **Raised the minimum supported PHP version to 7.4.**
##### WordPress Minimum Required Version Change
+ **Raised the minimum supported WordPress core version to 5.6.**
##### New Features
+ Added support for WordPress 6.0.
##### Bug Fixes
+ Fixed the ability for 3rd party plugins to use the `lifterlms_external_engagement_handler_arguments` and `lifterlms_external_engagement_query_arguments` filters.
+ Added automatic exclusion of "no cache" pages from the WP Engine server-side cache when using "pretty" permalinks. [#1717](https://github.com/gocodebox/lifterlms/issues/1717)
+ Stop subtracting LifterLMS order note comments from global comment counts via the `wp_count_comments` filter on WordPress 6.0 and later. See related WordPress Trac ticket [#19901](https://core.trac.wordpress.org/ticket/19901)
v6.5.0 - 2022-05-11
-------------------
##### Upcoming PHP Version Requirement Change
**This will be the last version of LifterLMS to support PHP 7.3. The next version of LifterLMS, expected before the end of May 2022, will raise the minimum supported PHP version to 7.4. PHP 7.3 reached its official [end of life](https://www.php.net/eol.php) on December 6, 2021. If you are still using PHP 7.3 please upgrade to PHP 7.4 or later as soon as possible.**
##### Updates and Enhancements
+ Updates LifterLMS Rest to [v1.0.0-beta.25](https://make.lifterlms.com/2022/05/11/lifterlms-rest-api-version-1-0-0-beta-25/).
##### Bug Fixes
+ Students who have already completed a lesson will now automatically bypass the lesson's drip restrictions. [#1835](https://github.com/gocodebox/lifterlms/issues/1835)
+ Properly encode certificate JS localization data. [#2140](https://github.com/gocodebox/lifterlms/issues/2140)
##### Developer Notes
+ Added a new filter, `llms_lesson_drip_bypass_if_completed`, which controls the automatic bypass of drip restrictions for completed lessons. [#1835](https://github.com/gocodebox/lifterlms/issues/1835)
+ Allow avoiding error return when updating an `LLMS_Post_Model` post meta with the same value as the one stored in the database. [#909](https://github.com/gocodebox/lifterlms/issues/909)
v6.4.0 - 2022-04-19
-------------------
##### Upcoming PHP Version Requirement Change
**LifterLMS will drop support for PHP 7.3 by May, 2022. This will raise the minimum supported PHP version to 7.4. PHP 7.3 reached its official [end of life](https://www.php.net/eol.php) on December 6, 2021. If you are still using PHP 7.3 please upgrade to PHP 7.4 or later as soon as possible.**
##### New Features
+ Any "secure" payment gateway options will be automatically masked when written to debug log files.
##### Updates and Enhancements
+ When building notification content, only parse merge codes used in the notification. [#1465](https://github.com/gocodebox/lifterlms/issues/1465)
+ Improved checks related to the number of quiz attempts allowed for each student.
+ Prevent browser page caching on quizzes. [#2092](https://github.com/gocodebox/lifterlms/issues/2092)
##### Bug Fixes
+ Allowed classes extended from the manual payment gateway class to display payment instructions.
+ Allowed the `LLMS_Shortcode_User_Info` class to be filtered by the `llms_load_shortcodes` and `llms_load_shortcode_path` hooks.
+ Stop using the deprecated `FILTER_SANITIZE_STRING` constant.
+ Fixed an issue that caused shortcodes to not be replaced in some engagement emails. [#2070](https://github.com/gocodebox/lifterlms/issues/2070)
+ Improve core forms detection so to exclude duplicates. [#2052](https://github.com/gocodebox/lifterlms/issues/2052)
+ Added Aosta (AO) to the list of Italian provinces. [#2098](https://github.com/gocodebox/lifterlms/issues/2098)
+ Fixed a compatibility issue with the Elementor Pro Theme Builder encountered on course and membership catalogs. [#2111](https://github.com/gocodebox/lifterlms/issues/2111)
+ Fixed an issue where merge codes in reusable blocks on certificate templates were not replaced when the template was displayed or when the certificate was awarded and published. [#2058](https://github.com/gocodebox/lifterlms/issues/2058)
+ Fixed an issue with OceanWP and Twenty Twenty themes where the Terms and Conditions checkbox was displayed incorrectly. [#1938](https://github.com/gocodebox/lifterlms/issues/1938)
##### Developer Notes
+ Added a new filter, `llms_secure_strings` allowing developers to register strings that should be automatically masked when written to log files.
+ Added new filter `llms_no_cache` to control whether or not LifterLMS will send nocache headers. [#2092](https://github.com/gocodebox/lifterlms/issues/2092)
+ Added new filter `llms_template_loader_restricted_priority` to control the priority of the `template_include` hook callback used to load restricted content single templates.
v6.3.0 - 2022-04-07
-------------------
##### Upcoming PHP Version Requirement Change
**LifterLMS will drop support for PHP 7.3 by May, 2022. This will raise the minimum supported PHP version to 7.4. PHP 7.3 reached its official [end of life](https://www.php.net/eol.php) on December 6, 2021. If you are still using PHP 7.3 please upgrade to PHP 7.4 or later as soon as possible.**
##### New Features
+ Automatically add student's dashboard endpoints to the BuddyPress profile nav. [#627](https://github.com/gocodebox/lifterlms/issues/627)
##### Updates and Enhancements
+ Upgraded LifterLMS Blocks to [v2.4.2](https://make.lifterlms.com/2022/04/07/lifterlms-blocks-version-2-4-2/).
+ Updated LifterLMS Helper to [v3.4.2](https://make.lifterlms.com/2022/04/01/lifterlms-helper-version-3-4-2/).
##### Bug Fixes
+ Fixed paged queries in student dashboard not working when using plain permalinks.
+ Fixed an issue that prevented searching students in some admin areas when WordPress was installed in a subdirectory. [#2096](https://github.com/gocodebox/lifterlms/issues/2096)
+ Fixed lesson's comments status not reflecting default global setting when created with the course builder. [#2099](https://github.com/gocodebox/lifterlms/issues/2099)
##### Deprecations
+ Deprecated `LLMS_Integration_Buddypress::achievements_screen()` method with no replacement.
+ Deprecated `LLMS_Integration_Buddypress::certificates_screen()` method with no replacement.
+ Deprecated `LLMS_Integration_Buddypress::courses_screen()` method with no replacement.
+ Deprecated `LLMS_Integration_Buddypress::memberships_screen()` method with no replacement.
+ Deprecated `LLMS_Integration_Buddypress::remove_courses_paginate_links_filter()` method with no replacement.
+ Deprecated `LLMS_Integration_Buddypress::modify_courses_paginate_links()` method with no replacement.
##### Developer Notes
+ Added `llms_get_paged_query_var()` function that returns the page number query var for the current request.
+ Added new filter `llms_buddypress_profile_endpoints` to control the LifterLMS endpoints to be added to the BuddyPress profile.
+ Added new filter `llms_buddypress_min_nav_item_slug` to control the LifterLMS main BuddyPress' nav item slug.
+ Added new filter `llms_buddypress_min_nav_item_label` to control the LifterLMS main BuddyPress' nav item label.
+ Added new filter `llms_buddypress_min_nav_item_position` to control the LifterLMS main BuddyPress' nav item position.
v6.2.0 - 2022-03-30
-------------------
##### Updates and Enhancements
+ Changed the `llmsStudentsSelect2()` JavaScript function to use the LifterLMS REST API "list students" endpoint instead of the `LLMS_AJAX_Handler::query_students()` PHP function.
+ Upgraded LifterLMS Blocks to [v2.4.1](https://make.lifterlms.com/2022/03/30/lifterlms-blocks-version-2-4-1/).
##### Bug Fixes
+ Fixed issue with hidden checkboxes on LifterLMS forms.
+ Fixed a compatiblity issue with the Divi Theme Builder ignoring access restrictions when using template with custom body. [#2063](https://github.com/gocodebox/lifterlms/issues/2063)
+ Fixed an error encountered on the Engagements > Certificates screen when using the BuddyBoss theme. [#2080](https://github.com/gocodebox/lifterlms/issues/2080)
##### Deprecations
+ Deprecated `LLMS_AJAX_Handler::query_students()`. Use the [REST API list students](https://developer.lifterlms.com/rest-api/#tag/Students/paths/~1students/get) endpoint instead.
##### Developer Notes
+ Added new filter `llms_template_loader_priority` to control the priority of the `template_include` hook callback used to load restricted content templates.
v6.1.0 - 2022-03-23
-------------------
##### Upcoming PHP Version Requirement Change
**LifterLMS will drop support for PHP 7.3 by May, 2022. This will raise the minimum supported PHP version to 7.4. PHP 7.3 reached its official [end of life](https://www.php.net/eol.php) on December 6, 2021. If you are still using PHP 7.3 please upgrade to PHP 7.4 or later as soon as possible.**
##### New Features
+ Added the `{earned_date}` certificate merge code.
##### Updates and Enhancements
+ Changed the label for the `{current_date}` certificate merge code from 'Earned Date' to 'Current Date'.
+ Updates LifterLMS REST to [v1.0.0-beta.24](https://make.lifterlms.com/2022/03/17/lifterlms-rest-api-version-1-0-0-beta-24/).
##### Bug Fixes
+ Fixed an issue encountered when editing an order with a completed payment plan. [#2067](https://github.com/gocodebox/lifterlms/issues/2067)
+ Fixed access of protected LLMS_Abstract_Query properties.
v6.0.0 - 2022-03-08
-------------------
**This major release of LifterLMS focuses on improving the experience of creating, designing, and managing achievements and certificates: use the block editor to design certificates, sync awards with their templates, award achievements and certificates on demand without requiring an engagement trigger, and [much more](https://lifterlms.com/docs/getting-started-with-lifterlms-6-0/). In addition, this release removes a significant number of previously deprecated classes, methods, and functions. Please read the full Breaking Changes sections for more information on removed code.**
##### New Features
+ The block editor is now enabled by default for certificates when using WordPress versions 5.8 and later.
+ Existing certificates are marked as "legacy" and will continue to use the classic editor until migrated.
+ To migrate a certificate, click the "Migrate Certificate" button. This will force the certificate's content into blocks.
+ A number of new settings are available to certificates when using the block editor:
+ Set the certificate's display (and print) size using common paper sizes such as US Letter, US Legal, A3, A4, and more.
+ Set the certificate's display orientation: portrait of landscape.
+ Set the certificate's inner margins.
+ Set the certificate's background color.
+ A new block, the Certificate Title Block, has been made available to certificates.
+ The block works like a WordPress core Heading Block with added options for selecting from a few display fonts (provided by Google Web Fonts).
+ The block controls the title of awarded certificates.
+ Added the ability for administrators and LMS managers to edit earned certificates/achievements from the students reporting screen, as well as award new certificates/achievements to students.
+ Added the ability to sync awarded certificates with the template used to generate them. [#1078](https://github.com/gocodebox/lifterlms/issues/1078)
+ The `post_name` of earned certificate posts will be generated with a randomized 3+ character string in favor of relying on sequential numbers.
+ Added certificate global options for the default size of new certificates and certificate templates.
+ Certificate and email template merge code buttons now include [llms-user] information shortcodes.
+ Added certificate sequential ID functionality merge code.
+ Added a link to return to the student dashboard when viewing an awarded certificate. [#1959](https://github.com/gocodebox/lifterlms/issues/1959)
+ Provide additional information to hooks on the student single course reporting screen.
##### Updates and Enhancements
+ Added new default images for use with achievements and certificates.
+ The site-wide default images can be customized on the admin panel under Settings -> Engagements.
+ The old default images will automatically be used for legacy certificates and can be forced by filtering `llms_use_legacy_engagement_images`. [#1081](https://github.com/gocodebox/lifterlms/issues/1081)
+ Certificates no longer use the `header.php` and `footer.php` files from the site's theme, instead custom templates (`templates/certificates/header.php` and `templates/certificates/footer.php`) are used instead. These templates are minimal and exclude theme wrappers which reduces the visual conflicts encountered from theme wrappers, backgrounds, and more, especially when printing certificates. [#463](https://github.com/gocodebox/lifterlms/issues/463)
+ The achievements and certificates dashboard endpoints are now paginated. [#669](https://github.com/gocodebox/lifterlms/issues/669)
+ Added pagination to achievement and certificate reporting pages.
+ The URL of earned user certificates has been changed from "my_certificate" to "certificate". Requests to the old url are automatically redirected to the new url, including instances where the URL slug has been translated.
+ The URL of certificate template previews has been changed from "certificate" to "certificate-template".
+ The certificate merge code, `{first_name}`, now outputs an empty string in favor of falling back to the user's nickname when there is no first name for the user. [#1640](https://github.com/gocodebox/lifterlms/issues/1640)
+ The look and behavior of the certificate {{MINI_CERTIFICATE}} pop-over notification merge code now displays a placeholder preview of the certificate in favor of attempting to render a tiny version of the actual certificate. [#1950](https://github.com/gocodebox/lifterlms/issues/1950)
+ The coupon code in the student's order details table is now wrapped in a `` tag instead of an `` tag. [#2033](https://github.com/gocodebox/lifterlms/issues/2033)
+ Updates LifterLMS REST to [v1.0.0-beta.23](https://make.lifterlms.com/2022/02/23/lifterlms-rest-api-version-1-0-0-beta-23/).
+ Updated LifterLMS Blocks to [version 2.4.0](https://make.lifterlms.com/2022/02/25/lifterlms-blocks-version-2-4-0/).
##### Bug Fixes
+ Delayed engagements are automatically unscheduled when the related post is deleted.
+ A disabled student dashboard endpoint will no longer display the endpoint's summary on the main dashboard page. [#535](https://github.com/gocodebox/lifterlms/issues/535)
+ Prior to sending a delayed engagement the recipient's enrollment in the related post is verified resulting the engagement not being triggered if the recipient's enrollment has been terminated. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ Post search filter boxes on various post tables will now longer display a link to the selected post.
+ Basic notification code is no longer loaded on the admin panel.
+ Fixed the label hover on picture type quizzes in some themes. [#2015](https://github.com/gocodebox/lifterlms/issues/2015)
##### Database Migration
+ A database migration is required when upgrading from versions earlier than 6.0.0. A description of the required updates can be found at [https://lifterlms.com/docs/lifterlms-database-updates/#600](https://lifterlms.com/docs/lifterlms-database-updates/#600).
##### Deprecations
+ Public access to properties of the abstract `LLMS_Database_Query` has been deprecated.
+ Public access to class property `LLMS_Database_Query::$found_results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_found_results()`.
+ Public access to class property `LLMS_Database_Query::$max_pages`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_max_pages()`.
+ Public access to class property `LLMS_Database_Query::$number_results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_number_results()`.
+ Public access to class property `LLMS_Database_Query::$results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_results()`.
+ Public access to class property `LLMS_Database_Query::$query_vars`. The variable as a whole cannot be publicly accessed, instead use `LLMS_Database_Query::get()` and `LLMS_Database_Query::set()` to read and write to the array.
+ The above changes were made to the abstract class `LLMS_Database_Query` but the following concrete classes that utilize the abstract are also affected by this change: `LLMS_Query_User_Postmeta`, `LLMS_Student_Query`, `LLMS_Query_Quiz_Attempt`, `LLMS_Events_Query`, and `LLMS_Notifications_Query`.
+ Class `LLMS_Achievement_User` is deprecated with no direct replacement.
+ Method `LLMS_Achievement::is_enabled()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_blogname()` is deprecated with no replacement.
+ Method `LLMS_Achievement::format_string()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_title()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_content()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Achievement::create()` is deprecated with no replacement.
+ Method `LLMS_Achievements::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement()`.
+ Class `LLMS_Certificate` is deprecated with no direct replacement.
+ Method `LLMS_Certificate::is_enabled()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_blogname()` is deprecated with no replacement.
+ Method `LLMS_Certificate::format_string()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_title()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_content()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_title()` is deprecated with no replacement.
+ Method `LLMS_Certificates::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate()`.
+ Method `LLMS_Engagements::init()` is deprecated with no replacement.
+ Method `LLMS_Engagements::handle_achievement` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement`.
+ Method `LLMS_Engagements::handle_certificate` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate`.
+ Method `LLMS_Engagements::handle_email` is deprecated in favor of `LLMS_Engagement_Handler::handle_email`.
+ Method `LLMS_Database_Query::set_found_results()` is deprecated.
+ Class `LLMS_Achievement_User` is deprecated with no direct replacement.
+ Method `LLMS_Achievement_User::has_user_earned()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::init()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::trigger()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::get_content_html()` is deprecated with no replacement.
+ Class `LLMS_Certificate_User` is deprecated with no direct replacement.
+ Method `LLMS_Certificate_User::init()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::trigger()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::set_shortcode_user()` is deprecated with no replacement.
+ Engagement debug logging is removed. Use `llms_log()` directly instead.
+ Filter `llms_db_query_get_default_args` is deprecated in favor of `llms_{$this->id}_query_get_default_args`.
+ Filter `llms_certificate_has_user_earned` is deprecated in favor of `llms_earned_certificate_dupcheck`.
+ Unused public class property `LLMS_Achievements::$content` is deprecated with no replacement.
+ Method `LLMS_Admin_Post_Types::meta_metabox_init()` is deprecated with no replacement.
+ The site options `lifterlms_certificate_bg_img_width`, `lifterlms_certificate_bg_img_height`, and `lifterlms_certificate_legacy_image_size` are now used only for certificates and certificate templates created using the classic editor.
+ The settings, found on the Engagements Settings screen, are hidden by default.
+ During the database upgrade from versions earlier than 6.x, an site option, `llms_has_legacy_certificates` is added when at least one certificate is found. This option will display the settings so they can continue to be used for legacy certificates.
+ After migrating all certificates on a site, the settings will still display. In order to remove them from the screen a developer can either delete the option `llms_has_legacy_certificates` or return `false` from the filter `llms_has_legacy_certificates`.
+ Method `LLMS_Engagements::handle_certificate` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate`. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ Method `LLMS_Engagements::handle_achievement` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement`. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ The constant `LLMS_ENGAGEMENT_DEBUG` is deprecated with no replacement.
+ Engagement debugging via `LLMS_Engagements::log` is deprecated. Use `llms_log()` instead.
+ Method `LLMS_Engagements::handle_email` is deprecated in favor of `LLMS_Engagement_Handler::handle_email`.
+ Filter `lifterlms_register_post_type_llms_my_certificate` is deprecated in favor of `lifterlms_register_post_type_my_certificate`.
+ Deprecated the misspelled protected method `LLMS_Database_Query::preprare_query()` and replaced with `LLMS_Database_Query::prepare_query()`.
+ Class method `LLMS_Events_Query::preprare_query` replaced with `LLMS_Events_Query::prepare_query()`.
+ Class method `LLMS_Query_Quiz_Attempt::preprare_query` replaced with `LLMS_Query_Quiz_Attempt::prepare_query()`.
+ Class method `LLMS_Query_User_Postmeta::preprare_query` replaced with `LLMS_Query_User_Postmeta::prepare_query()`.
+ Class method `LLMS_Student_Query::preprare_query` replaced with `LLMS_Student_Query::prepare_query()`.
+ Class method `LLMS_Notifications_Query::preprare_query` replaced with `LLMS_Notifications_Query::prepare_query()`.
+ Class method `LLMS_Notifications_Query::preprare_query` replaced with `LLMS_Notifications_Query::prepare_query()`. [#859](https://github.com/gocodebox/lifterlms/issues/859)
##### Breaking Changes
+ Removed FSE template: `templates/block-templates/single-certificate.html`.
+ Removed the deprecated `LLMS()` function in favor of the `llms()` function.
+ Removed the deprecated the `LLMS_SendWP::do_remote_install()` method in favor of the `LLMS_Abstract_Email_Provider::do_remote_install()` method.
+ Removed the deprecated `LLMS_Abstract_Email_Provider::output_css()` method.
+ Removed the deprecated `LLMS_Abstract_Generator_Posts::increment()` method.
+ Removed the deprecated `LLMS_Admin_Users_Table::load_dependencies()` method.
+ Removed the deprecated `LLMS_Admin_Import::localize_stat()` method.
+ Removed the deprecated `LLMS_Admin_Notices_Core::check_staging()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::generator_course_status()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::output_step_html()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::scripts()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::watch_course_generation()` method.
+ Removed the deprecated `llms_format_decimal()` function.
+ Removed the deprecated `llms_set_person_auth_cookie()` function.
+ Removed the deprecated `LLMS_Course::sections` property.
+ Removed the deprecated `LLMS_Course::sku` property.
+ Removed the deprecated `LLMS_Frontend_Assets::enqueue_inline_pw_script()` method.
+ Removed the deprecated `LLMS_Frontend_Assets::enqueue_inline_script()` method.
+ Removed the deprecated `LLMS_Frontend_Assets::is_inline_script_enqueued()` method.
+ Removed the deprecated `LLMS_Generator::add_custom_values()` method.
+ Removed the deprecated `LLMS_Generator::add_custom_values()` method.
+ Removed the deprecated `LLMS_Generator::format_date()` method.
+ Removed the deprecated `LLMS_Generator::get_author_id_from_raw()` method.
+ Removed the deprecated `LLMS_Generator::get_default_post_status()` method.
+ Removed the deprecated `LLMS_Generator::get_generated_posts()` method.
+ Removed the deprecated `LLMS_Generator::increment()` method.
+ Removed the deprecated `llms__created` action hook from the `LLMS_Abstract_Database_Store::create()` method.
+ Removed the deprecated `llms__deleted` action hook from the `LLMS_Abstract_Database_Store::delete()` method.
+ Removed the deprecated `llms__updated` action hook from the `LLMS_Abstract_Database_Store::update()` method.
+ Removed the deprecated `llms_user_removed_from_membership_level` action hook from the `LLMS_Student::unenroll()` method.
+ Removed the deprecated and misspelled `$purchaseable` global variable in the `lifterlms_template_pricing_table()` function.
+ Removed the deprecated and misspelled `$purchaseable` global variable in the `templates/product/pricing-table.php` file.
+ Removed the deprecated `LLMS_Frontend_Password` class.
+ Removed the deprecated `LLMS_Install::db_updates()` method.
+ Removed the deprecated `LLMS_Install::update_notice()` method.
+ Removed the deprecated `LLMS_Notifications::dispatch_processors()` method.
+ Removed the deprecated `llms_processors_async_dispatching` filter hook from the `LLMS_Notifications::__construct()` method.
+ Removed the deprecated `LLMS_Notifications::$_instance` property.
+ Removed the deprecated `LLMS_Person_Handler::register()` method.
+ Removed the deprecated `LLMS_Person_Handler::sanitize_field()` method.
+ Removed the deprecated `LLMS_Person_Handler::update()` method.
+ Removed the deprecated `LLMS_Person_Handler::validate_fields()` method.
+ Removed the deprecated `LLMS_Person_Handler::voucher_toggle_script()` method.
+ Removed the deprecated `templates/admin/notices/db-update.php` file.
+ Removed the deprecated `templates/admin/notices/db-updating.php` file.
+ Removed the deprecated `llms_usernames_blacklist` filter hook in the `llms_get_usernames_blocklist()` function.
+ Removed the deprecated `includes/libraries/wp-background-processing/index.php` file.
+ Removed the deprecated `includes/libraries/wp-background-processing/wp-async-request.php` file.
+ Removed the deprecated `includes/libraries/wp-background-processing/wp-background-process.php` file.
+ Removed the deprecated `LLMS_Section::get_next_available_lesson_order()` method.
+ Removed the deprecated `LLMS_Section::get_order()` method.
+ Removed the deprecated `LLMS_Section::get_parent_course()` method.
+ Removed the deprecated `LLMS_Section::set_parent_course()` method.
+ Removed the deprecated `LLMS_AJAX::check_voucher_duplicate()` method.
+ Removed the deprecated `LLMS_AJAX::get_ajax_data()` method.
+ Removed the deprecated `LLMS_AJAX::register_script()` method.
+ Removed the deprecated `LLMS_Interface_Post_Audio` interface.
+ Removed the deprecated `LLMS_Interface_Post_Sales_Page` interface.
+ Removed the deprecated `LLMS_Interface_Post_Video` interface.
+ Removed the deprecated `LLMS_Achievements::$_instance` property.
+ Removed the deprecated `LLMS_Certificates::$_instance` property.
+ Removed the deprecated `LLMS_Emails::$_instance` property.
+ Removed the deprecated `LLMS_Engagements::$_instance` property.
+ Removed the deprecated `LLMS_Events::$_instance` property.
+ Removed the deprecated `LLMS_Grades::$_instance` property.
+ Removed the deprecated `LLMS_Integrations::$_instance` property.
+ Removed the deprecated `LLMS_Payment_Gateways::$_instance` property.
+ Removed the deprecated `LLMS_Processors::$_instance` property.
+ Removed the deprecated `LLMS_Sessions::$_instance` property.
##### Developer Notes
+ Added `LLMS_Awards_Query`, used for querying data about awarded certificates and achievements.
+ The method signature `LLMS_Student::get_achievements()` and `LLMS_Student::get_certificates()` now use this class under tho hood.
+ The previous method signature, which passed data into a direct SQL query, is now deprecated.
+ Achievement and certificate data storage locations have been modified, primarily to reduce reliance on the `wp_postmeta` table which will result in a site-wide performance improvement, especially on large sites.
+ Meta properties `_llms_achievement_content` and `_llms_certificate_content` have been removed in favor of `WP_Post::$post_content`.
+ Meta properties `_llms_achievement_title` and `_llms_certificate_title` have been removed in favor of `WP_Post::$post_title`.
+ Meta properties `_llms_achievement_template` and `_llms_certificate_template` have been removed in favor of `WP_Post::$post_parent`.
+ Meta properties `_llms_achievement_image` and `_llms_certificate_image` have been moved the meta property `_thumbnail_id` in order to utilize the WordPress core's featured image functionality and internal APIs.
+ Reliance on `lifterlms_user_postmeta` for achievement and certificate data will be removed in a future release.
+ User postmeta properties `_achievement_earned` and `_certificate_earned` will continue to be recorded but are no longer being used internally.
+ The `updated_date` is now accessible via `WP_Post::$post_date`.
+ The `user_id` is now accessible via `WP_Post::$post_author`.
+ Added new Javascript UI components library, modeled after `@wordpress/components`. [Read more](https://github.com/gocodebox/lifterlms/tree/dev-600/packages/components).
+ Added a new SVG icon library, modeled after `@wordpress/icons`. [Read more](https://github.com/gocodebox/lifterlms/tree/dev-600/packages/icons).
+ The merge code button seen on certificate and email template editors is now an SVG image instead of a PNG.
+ Added utility function for escaping and quoting strings. [#1027](https://github.com/gocodebox/lifterlms/issues/1027)
+ Added the ability to force an admin metabox field value through the new `meta` arg. [#2016](https://github.com/gocodebox/lifterlms/issues/2016)
+ Added new utility function for stripping prefixes from strings.
##### Performance Improvements
+ Increased the number of files that are autoloaded instead of manually loaded.
##### Updated Templates
+ [templates/achievements/loop.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/achievements/loop.php)
+ [templates/achievements/template.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/achievements/template.php)
+ [templates/admin/notices/db-update.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/admin/notices/db-update.php)
+ [templates/admin/notices/db-updating.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/admin/notices/db-updating.php)
+ [templates/admin/reporting/reporting.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/admin/reporting/reporting.php)
+ [templates/admin/reporting/tabs/students/courses-course.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/admin/reporting/tabs/students/courses-course.php)
+ [templates/admin/reporting/tabs/students/information.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/admin/reporting/tabs/students/information.php)
+ [templates/block-templates/single-certificate.html](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/block-templates/single-certificate.html)
+ [templates/certificates/actions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/certificates/actions.php)
+ [templates/certificates/content-legacy.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/certificates/content-legacy.php)
+ [templates/certificates/content.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/certificates/content.php)
+ [templates/certificates/dynamic-styles.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/certificates/dynamic-styles.php)
+ [templates/certificates/footer.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/certificates/footer.php)
+ [templates/certificates/header.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/certificates/header.php)
+ [templates/certificates/loop.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/certificates/loop.php)
+ [templates/certificates/preview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/certificates/preview.php)
+ [templates/certificates/template.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/certificates/template.php)
+ [templates/checkout/form-switch-source.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/checkout/form-switch-source.php)
+ [templates/content-certificate.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/content-certificate.php)
+ [templates/emails/footer.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/emails/footer.php)
+ [templates/emails/header.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/emails/header.php)
+ [templates/myaccount/my-grades-single-table.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/myaccount/my-grades-single-table.php)
+ [templates/myaccount/view-order-actions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/myaccount/view-order-actions.php)
+ [templates/myaccount/view-order-information.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/myaccount/view-order-information.php)
+ [templates/myaccount/view-order-transactions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/myaccount/view-order-transactions.php)
+ [templates/myaccount/view-order.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/myaccount/view-order.php)
+ [templates/product/pricing-table.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/product/pricing-table.php)
+ [templates/single-certificate.php](https://github.com/gocodebox/lifterlms/blob/6.0.0/templates/single-certificate.php)
v6.0.0-rc.1 - 2022-03-03
------------------------
##### New Features
+ Added a link to return to the student dashboard when viewing an awarded certificate. [#1959](https://github.com/gocodebox/lifterlms/issues/1959)
+ The block editor is now enabled by default for certificates when using WordPress versions 5.8 and later.
+ Existing certificates are marked as "legacy" and will continue to use the classic editor until migrated.
+ To migrate a certificate, click the "Migrate Certificate" button. This will force the certificate's content into blocks.
+ A number of new settings are available to certificates when using the block editor:
+ Set the certificate's display (and print) size using common paper sizes such as US Letter, US Legal, A3, A4, and more.
+ Set the certificate's display orientation: portrait of landscape.
+ Set the certificate's inner margins.
+ Set the certificate's background color.
+ A new block, the Certificate Title Block, has been made available to certificates.
+ The block works like a WordPress core Heading Block with added options for selecting from a few display fonts (provided by Google Web Fonts).
+ The block controls the title of awarded certificates.
+ + Added the ability to sync awarded certificates with the template used to generate them. [#1078](https://github.com/gocodebox/lifterlms/issues/1078)
+ The `post_name` of earned certificate posts will be generated with a randomized 3+ character string in favor of relying on sequential numbers.
+ Added the ability for administrators and LMS managers to edit earned certificates/achievements from the students reporting screen, as well as award new certificates/achievements to students.
+ + Added certificate global options for the default size of new certificates and certificate templates.
+ Certificate and email template merge code buttons now include [llms-user] information shortcodes.
+ Added certificate sequential ID functionality merge code. [Read more](@TODO).
+ Provide additional information to hooks on the student single course reporting screen.
##### Updates and Enhancements
+ Added pagination to achievement and certificate reporting pages.
+ Certificates no longer use the `header.php` and `footer.php` files from the site's theme, instead custom templates (`templates/certificates/header.php` and `templates/certificates/footer.php`) are used instead. These templates are minimal and exclude theme wrappers which reduces the visual conflicts encountered from theme wrappers, backgrounds, and more, especially when printing certificates. [#463](https://github.com/gocodebox/lifterlms/issues/463)
+ The achievements and certificates dashboard endpoints are now paginated. [#669](https://github.com/gocodebox/lifterlms/issues/669)
+ Added new default images for use with achievements and certificates.
+ The site-wide default images can be customized on the admin panel under Settings -> Engagements.
+ The old default images can be used by filtering `llms_use_legacy_engagement_images`. [#1081](https://github.com/gocodebox/lifterlms/issues/1081)
+ The URL of earned user certificates has been changed from "my_certificate" to "certificate". Requests to the old url are automatically redirected to the new url, including instances where the URL slug has been translated.
+ The URL of certificate template previews has been changed from "certificate" to "certificate-template".
+ The certificate merge code, `{first_name}`, now outputs an empty string in favor of falling back to the user's nickname when there is no first name for the user. [#1640](https://github.com/gocodebox/lifterlms/issues/1640)
+ Updates LifterLMS REST to [v1.0.0-beta.23](https://make.lifterlms.com/2022/02/23/lifterlms-rest-api-version-1-0-0-beta-23/).
+ Updated LifterLMS Blocks to [version 2.4.0](https://make.lifterlms.com/2022/02/25/lifterlms-blocks-version-2-4-0/).
+ The look and behavior of the certificate {{MINI_CERTIFICATE}} pop-over notification merge code now displays a placeholder preview of the certificate in favor of attempting to render a tiny version of the actual certificate. [#1950](https://github.com/gocodebox/lifterlms/issues/1950)
##### Bug Fixes
+ + Fixed how the protected `LLMS_Notifications_Query::$found_results` property is accessed in `LLMS_Abstract_Notification_Controller::has_subscriber_received()`. + Fixed how the protected `LLMS_Notifications_Query::$max_pages` property is accessed in `lifterlms_template_student_dashboard_my_notifications()`.
+ Delayed engagements are automatically unscheduled when the related post is deleted.
+ Prior to sending a delayed engagement the recipient's enrollment in the related post is verified resulting the engagement not being triggered if the recipient's enrollment has been terminated. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ A disabled student dashboard endpoint will no longer display the endpoint's summary on the main dashboard page. [#535](https://github.com/gocodebox/lifterlms/issues/535)
+ Post search filter boxes on various post tables will now longer display a link to the selected post.
+ Basic notification code is no longer loaded on the admin panel.
##### Deprecations
+ Public access to properties of the abstract `LLMS_Database_Query` has been deprecated.
+ Public access to class property `LLMS_Database_Query::$found_results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_found_results()`.
+ Public access to class property `LLMS_Database_Query::$max_pages`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_max_pages()`.
+ Public access to class property `LLMS_Database_Query::$number_results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_number_results()`.
+ Public access to class property `LLMS_Database_Query::$results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_results()`.
+ Public access to class property `LLMS_Database_Query::$query_vars`. The variable as a whole cannot be publicly accessed, instead use `LLMS_Database_Query::get()` and `LLMS_Database_Query::set()` to read and write to the array.
+ The above changes were made to the abstract class `LLMS_Database_Query` but the following concrete classes that utilize the abstract are also affected by this change: `LLMS_Query_User_Postmeta`, `LLMS_Student_Query`, `LLMS_Query_Quiz_Attempt`, `LLMS_Events_Query`, and `LLMS_Notifications_Query`.
+ Class `LLMS_Achievement_User` is deprecated with no direct replacement.
+ Method `LLMS_Achievement::is_enabled()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_blogname()` is deprecated with no replacement.
+ Method `LLMS_Achievement::format_string()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_title()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_content()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Achievement::create()` is deprecated with no replacement.
+ Method `LLMS_Achievements::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement()`.
+ Class `LLMS_Certificate` is deprecated with no direct replacement.
+ Method `LLMS_Certificate::is_enabled()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_blogname()` is deprecated with no replacement.
+ Method `LLMS_Certificate::format_string()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_title()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_content()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_title()` is deprecated with no replacement.
+ Method `LLMS_Certificates::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate()`.
+ Method `LLMS_Engagements::init()` is deprecated with no replacement.
+ Method `LLMS_Engagements::handle_achievement` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement`.
+ Method `LLMS_Engagements::handle_certificate` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate`.
+ Method `LLMS_Engagements::handle_email` is deprecated in favor of `LLMS_Engagement_Handler::handle_email`.
+ Method `LLMS_Database_Query::set_found_results()` is deprecated.
+ Class `LLMS_Achievement_User` is deprecated with no direct replacement.
+ Method `LLMS_Achievement_User::has_user_earned()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::init()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::trigger()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::get_content_html()` is deprecated with no replacement.
+ Class `LLMS_Certificate_User` is deprecated with no direct replacement.
+ Method `LLMS_Certificate_User::init()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::trigger()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::set_shortcode_user()` is deprecated with no replacement.
+ Engagement debug logging is removed. Use `llms_log()` directly instead.
+ Filter `llms_db_query_get_default_args` is deprecated in favor of `llms_{$this->id}_query_get_default_args`.
+ Filter `llms_certificate_has_user_earned` is deprecated in favor of `llms_earned_certificate_dupcheck`.
+ Unused public class property `LLMS_Achievements::$content` is deprecated with no replacement.
+ Method `LLMS_Admin_Post_Types::meta_metabox_init()` is deprecated with no replacement.
+ The site options `lifterlms_certificate_bg_img_width`, `lifterlms_certificate_bg_img_height`, and `lifterlms_certificate_legacy_image_size` are now used only for certificates and certificate templates created using the classic editor.
+ The settings, found on the Engagements Settings screen, are hidden by default.
+ During the database upgrade from versions earlier than 6.x, an site option, `llms_has_legacy_certificates` is added when at least one certificate is found. This option will display the settings so they can continue to be used for legacy certificates.
+ After migrating all certificates on a site, the settings will still display. In order to remove them from the screen a developer can either delete the option `llms_has_legacy_certificates` or return `false` from the filter `llms_has_legacy_certificates`.
+ Method `LLMS_Engagements::handle_certificate` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate`. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ Method `LLMS_Engagements::handle_achievement` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement`. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ The constant `LLMS_ENGAGEMENT_DEBUG` is deprecated with no replacement.
+ Engagement debugging via `LLMS_Engagements::log` is deprecated. Use `llms_log()` instead.
+ Method `LLMS_Engagements::handle_email` is deprecated in favor of `LLMS_Engagement_Handler::handle_email`.
+ Filter `lifterlms_register_post_type_llms_my_certificate` is deprecated in favor of `lifterlms_register_post_type_my_certificate`.
+ Deprecated the misspelled protected method `LLMS_Database_Query::preprare_query()` and replaced with `LLMS_Database_Query::prepare_query()`.
+ Class method `LLMS_Events_Query::preprare_query` replaced with `LLMS_Events_Query::prepare_query()`.
+ Class method `LLMS_Query_Quiz_Attempt::preprare_query` replaced with `LLMS_Query_Quiz_Attempt::prepare_query()`.
+ Class method `LLMS_Query_User_Postmeta::preprare_query` replaced with `LLMS_Query_User_Postmeta::prepare_query()`.
+ Class method `LLMS_Student_Query::preprare_query` replaced with `LLMS_Student_Query::prepare_query()`.
+ Class method `LLMS_Notifications_Query::preprare_query` replaced with `LLMS_Notifications_Query::prepare_query()`.
+ Class method `LLMS_Notifications_Query::preprare_query` replaced with `LLMS_Notifications_Query::prepare_query()`. [#859](https://github.com/gocodebox/lifterlms/issues/859)
##### Breaking Changes
+ Removed FSE template: `templates/block-templates/single-certificate.html`.
+ Removed the deprecated `LLMS()` function in favor of the `llms()` function.
+ Removed the deprecated the `LLMS_SendWP::do_remote_install()` method in favor of the `LLMS_Abstract_Email_Provider::do_remote_install()` method.
+ Removed the deprecated `LLMS_Abstract_Email_Provider::output_css()` method.
+ Removed the deprecated `LLMS_Abstract_Generator_Posts::increment()` method.
+ Removed the deprecated `LLMS_Admin_Users_Table::load_dependencies()` method.
+ Removed the deprecated `LLMS_Admin_Import::localize_stat()` method.
+ Removed the deprecated `LLMS_Admin_Notices_Core::check_staging()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::generator_course_status()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::output_step_html()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::scripts()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::watch_course_generation()` method.
+ Removed the deprecated `llms_format_decimal()` function.
+ Removed the deprecated `llms_set_person_auth_cookie()` function.
+ Removed the deprecated `LLMS_Course::sections` property.
+ Removed the deprecated `LLMS_Course::sku` property.
+ Removed the deprecated `LLMS_Frontend_Assets::enqueue_inline_pw_script()` method.
+ Removed the deprecated `LLMS_Frontend_Assets::enqueue_inline_script()` method.
+ Removed the deprecated `LLMS_Frontend_Assets::is_inline_script_enqueued()` method.
+ Removed the deprecated `LLMS_Generator::add_custom_values()` method.
+ Removed the deprecated `LLMS_Generator::add_custom_values()` method.
+ Removed the deprecated `LLMS_Generator::format_date()` method.
+ Removed the deprecated `LLMS_Generator::get_author_id_from_raw()` method.
+ Removed the deprecated `LLMS_Generator::get_default_post_status()` method.
+ Removed the deprecated `LLMS_Generator::get_generated_posts()` method.
+ Removed the deprecated `LLMS_Generator::increment()` method.
+ Removed the deprecated `llms__created` action hook from the `LLMS_Abstract_Database_Store::create()` method.
+ Removed the deprecated `llms__deleted` action hook from the `LLMS_Abstract_Database_Store::delete()` method.
+ Removed the deprecated `llms__updated` action hook from the `LLMS_Abstract_Database_Store::update()` method.
+ Removed the deprecated `llms_user_removed_from_membership_level` action hook from the `LLMS_Student::unenroll()` method.
+ Removed the deprecated and misspelled `$purchaseable` global variable in the `lifterlms_template_pricing_table()` function.
+ Removed the deprecated and misspelled `$purchaseable` global variable in the `templates/product/pricing-table.php` file.
+ Removed the deprecated `LLMS_Frontend_Password` class.
+ Removed the deprecated `LLMS_Install::db_updates()` method.
+ Removed the deprecated `LLMS_Install::update_notice()` method.
+ Removed the deprecated `LLMS_Notifications::dispatch_processors()` method.
+ Removed the deprecated `llms_processors_async_dispatching` filter hook from the `LLMS_Notifications::__construct()` method.
+ Removed the deprecated `LLMS_Notifications::$_instance` property.
+ Removed the deprecated `LLMS_Person_Handler::register()` method.
+ Removed the deprecated `LLMS_Person_Handler::sanitize_field()` method.
+ Removed the deprecated `LLMS_Person_Handler::update()` method.
+ Removed the deprecated `LLMS_Person_Handler::validate_fields()` method.
+ Removed the deprecated `LLMS_Person_Handler::voucher_toggle_script()` method.
+ Removed the deprecated `templates/admin/notices/db-update.php` file.
+ Removed the deprecated `templates/admin/notices/db-updating.php` file.
+ Removed the deprecated `llms_usernames_blacklist` filter hook in the `llms_get_usernames_blocklist()` function.
+ Removed the deprecated `includes/libraries/wp-background-processing/index.php` file.
+ Removed the deprecated `includes/libraries/wp-background-processing/wp-async-request.php` file.
+ Removed the deprecated `includes/libraries/wp-background-processing/wp-background-process.php` file.
+ Removed the deprecated `LLMS_Section::get_next_available_lesson_order()` method.
+ Removed the deprecated `LLMS_Section::get_order()` method.
+ Removed the deprecated `LLMS_Section::get_parent_course()` method.
+ Removed the deprecated `LLMS_Section::set_parent_course()` method.
+ Removed the deprecated `LLMS_AJAX::check_voucher_duplicate()` method.
+ Removed the deprecated `LLMS_AJAX::get_ajax_data()` method.
+ Removed the deprecated `LLMS_AJAX::register_script()` method.
+ Removed the deprecated `LLMS_Interface_Post_Audio` interface.
+ Removed the deprecated `LLMS_Interface_Post_Sales_Page` interface.
+ Removed the deprecated `LLMS_Interface_Post_Video` interface.
+ Removed the deprecated `LLMS_Achievements::$_instance` property.
+ Removed the deprecated `LLMS_Certificates::$_instance` property.
+ Removed the deprecated `LLMS_Emails::$_instance` property.
+ Removed the deprecated `LLMS_Engagements::$_instance` property.
+ Removed the deprecated `LLMS_Events::$_instance` property.
+ Removed the deprecated `LLMS_Grades::$_instance` property.
+ Removed the deprecated `LLMS_Integrations::$_instance` property.
+ Removed the deprecated `LLMS_Payment_Gateways::$_instance` property.
+ Removed the deprecated `LLMS_Processors::$_instance` property.
+ Removed the deprecated `LLMS_Sessions::$_instance` property.
##### Developer Notes
+ Added `LLMS_Awards_Query`, used for querying data about awarded certificates and achievements.
+ The method signature `LLMS_Student::get_achievements()` and `LLMS_Student::get_certificates()` now use this class under tho hood.
+ The previous method signature, which passed data into a direct SQL query, is now deprecated.
+ Achievement and certificate data storage locations have been modified, primarily to reduce reliance on the `wp_postmeta` table which will result in a site-wide performance improvement, especially on large sites.
+ Meta properties `_llms_achievement_content` and `_llms_certificate_content` have been removed in favor of `WP_Post::$post_content`.
+ Meta properties `_llms_achievement_title` and `_llms_certificate_title` have been removed in favor of `WP_Post::$post_title`.
+ Meta properties `_llms_achievement_template` and `_llms_certificate_template` have been removed in favor of `WP_Post::$post_parent`.
+ Meta properties `_llms_achievement_image` and `_llms_certificate_image` have been moved the meta property `_thumbnail_id` in order to utilize the WordPress core's featured image functionality and internal APIs.
+ Reliance on `lifterlms_user_postmeta` for achievement and certificate data will be removed in a future release.
+ User postmeta properties `_achievement_earned` and `_certificate_earned` will continue to be recorded but are no longer being used internally.
+ The `updated_date` is now accessible via `WP_Post::$post_date`.
+ The `user_id` is now accessible via `WP_Post::$post_author`.
+ Added new Javascript UI components library, modeled after `@wordpress/components`. [Read more](https://github.com/gocodebox/lifterlms/tree/dev-600/packages/components).
+ Added a new SVG icon library, modeled after `@wordpress/icons`. [Read more](https://github.com/gocodebox/lifterlms/tree/dev-600/packages/icons).
+ The merge code button seen on certificate and email template editors is now an SVG image instead of a PNG.
+ Added utility function for escaping and quoting strings. [#1027](https://github.com/gocodebox/lifterlms/issues/1027)
+ Added the ability to force an admin metabox field value through the new `meta` arg. [#2016](https://github.com/gocodebox/lifterlms/issues/2016)
+ Added new utility function for stripping prefixes from strings.
##### Performance Improvements
+ Increased the number of files that are autoloaded instead of manually loaded.
##### Updated Templates
+ [templates/achievements/loop.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/achievements/loop.php)
+ [templates/achievements/template.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/achievements/template.php)
+ [templates/admin/notices/db-update.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/admin/notices/db-update.php)
+ [templates/admin/notices/db-updating.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/admin/notices/db-updating.php)
+ [templates/admin/reporting/reporting.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/admin/reporting/reporting.php)
+ [templates/admin/reporting/tabs/students/courses-course.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/admin/reporting/tabs/students/courses-course.php)
+ [templates/admin/reporting/tabs/students/information.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/admin/reporting/tabs/students/information.php)
+ [templates/block-templates/single-certificate.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/block-templates/single-certificate.html)
+ [templates/certificates/actions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/certificates/actions.php)
+ [templates/certificates/content-legacy.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/certificates/content-legacy.php)
+ [templates/certificates/content.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/certificates/content.php)
+ [templates/certificates/dynamic-styles.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/certificates/dynamic-styles.php)
+ [templates/certificates/footer.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/certificates/footer.php)
+ [templates/certificates/header.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/certificates/header.php)
+ [templates/certificates/loop.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/certificates/loop.php)
+ [templates/certificates/preview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/certificates/preview.php)
+ [templates/certificates/template.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/certificates/template.php)
+ [templates/checkout/form-switch-source.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/checkout/form-switch-source.php)
+ [templates/content-certificate.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/content-certificate.php)
+ [templates/emails/footer.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/emails/footer.php)
+ [templates/emails/header.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/emails/header.php)
+ [templates/myaccount/my-grades-single-table.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/myaccount/my-grades-single-table.php)
+ [templates/myaccount/view-order-actions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/myaccount/view-order-actions.php)
+ [templates/myaccount/view-order-information.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/myaccount/view-order-information.php)
+ [templates/myaccount/view-order-transactions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/myaccount/view-order-transactions.php)
+ [templates/myaccount/view-order.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/myaccount/view-order.php)
+ [templates/product/pricing-table.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/product/pricing-table.php)
+ [templates/single-certificate.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-rc.1/templates/single-certificate.php)
v6.0.0-beta.2 - 2022-02-22
--------------------------
##### New Features
+ Added a link to return to the student dashboard when viewing an awarded certificate. [#1959](https://github.com/gocodebox/lifterlms/issues/1959)
+ The block editor is now enabled by default for certificates when using WordPress versions 5.8 and later.
+ Existing certificates are marked as "legacy" and will continue to use the classic editor until migrated.
+ To migrate a certificate, click the "Migrate Certificate" button. This will force the certificate's content into blocks.
+ A number of new settings are available to certificates when using the block editor:
+ Set the certificate's display (and print) size using common paper sizes such as US Letter, US Legal, A3, A4, and more.
+ Set the certificate's display orientation: portrait of landscape.
+ Set the certificate's inner margins.
+ Set the certificate's background color.
+ A new block, the Certificate Title Block, has been made available to certificates.
+ The block works like a WordPress core Heading Block with added options for selecting from a few display fonts (provided by Google Web Fonts).
+ The block controls the title of awarded certificates.
+ + Added the ability to sync awarded certificates with the template used to generate them. [#1078](https://github.com/gocodebox/lifterlms/issues/1078)
+ The `post_name` of earned certificate posts will be generated with a randomized 3+ character string in favor of relying on sequential numbers.
+ Added the ability for administrators and LMS managers to edit earned certificates/achievements from the students reporting screen, as well as award new certificates/achievements to students.
+ + Added certificate global options for the default size of new certificates and certificate templates.
+ Certificate and email template merge code buttons now include [llms-user] information shortcodes.
+ Added certificate sequential ID functionality merge code. [Read more](@TODO).
##### Updates and Enhancements
+ Added pagination to achievement and certificate reporting pages.
+ Certificates no longer use the `header.php` and `footer.php` files from the site's theme, instead custom templates (`templates/certificates/header.php` and `templates/certificates/footer.php`) are used instead. These templates are minimal and exclude theme wrappers which reduces the visual conflicts encountered from theme wrappers, backgrounds, and more, especially when printing certificates. [#463](https://github.com/gocodebox/lifterlms/issues/463)
+ The achievements and certificates dashboard endpoints are now paginated. [#669](https://github.com/gocodebox/lifterlms/issues/669)
+ Added new default images for use with achievements and certificates.
+ The site-wide default images can be customized on the admin panel under Settings -> Engagements.
+ The old default images can be used by filtering `llms_use_legacy_engagement_images`. [#1081](https://github.com/gocodebox/lifterlms/issues/1081)
+ The URL of earned user certificates has been changed from "my_certificate" to "certificate". Requests to the old url are automatically redirected to the new url, including instances where the URL slug has been translated.
+ The URL of certificate template previews has been changed from "certificate" to "certificate-template".
+ The certificate merge code, `{first_name}`, now outputs an empty string in favor of falling back to the user's nickname when there is no first name for the user. [#1640](https://github.com/gocodebox/lifterlms/issues/1640)
+ Updates LifterLMS REST to [v1.0.0-beta.22](https://make.lifterlms.com/2021/12/15/lifterlms-rest-api-version-1-0-0-beta-22/).
+ The look and behavior of the certificate {{MINI_CERTIFICATE}} pop-over notification merge code now displays a placeholder preview of the certificate in favor of attempting to render a tiny version of the actual certificate. [#1950](https://github.com/gocodebox/lifterlms/issues/1950)
##### Bug Fixes
+ + Fixed how the protected `LLMS_Notifications_Query::$found_results` property is accessed in `LLMS_Abstract_Notification_Controller::has_subscriber_received()`. + Fixed how the protected `LLMS_Notifications_Query::$max_pages` property is accessed in `lifterlms_template_student_dashboard_my_notifications()`.
+ Delayed engagements are automatically unscheduled when the related post is deleted.
+ Prior to sending a delayed engagement the recipient's enrollment in the related post is verified resulting the engagement not being triggered if the recipient's enrollment has been terminated. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ A disabled student dashboard endpoint will no longer display the endpoint's summary on the main dashboard page. [#535](https://github.com/gocodebox/lifterlms/issues/535)
+ Post search filter boxes on various post tables will now longer display a link to the selected post.
+ Basic notification code is no longer loaded on the admin panel.
##### Deprecations
+ Public access to properties of the abstract `LLMS_Database_Query` has been deprecated.
+ Public access to class property `LLMS_Database_Query::$found_results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_found_results()`.
+ Public access to class property `LLMS_Database_Query::$max_pages`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_max_pages()`.
+ Public access to class property `LLMS_Database_Query::$number_results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_number_results()`.
+ Public access to class property `LLMS_Database_Query::$results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_results()`.
+ Public access to class property `LLMS_Database_Query::$query_vars`. The variable as a whole cannot be publicly accessed, instead use `LLMS_Database_Query::get()` and `LLMS_Database_Query::set()` to read and write to the array.
+ The above changes were made to the abstract class `LLMS_Database_Query` but the following concrete classes that utilize the abstract are also affected by this change: `LLMS_Query_User_Postmeta`, `LLMS_Student_Query`, `LLMS_Query_Quiz_Attempt`, `LLMS_Events_Query`, and `LLMS_Notifications_Query`.
+ Class `LLMS_Achievement_User` is deprecated with no direct replacement.
+ Method `LLMS_Achievement::is_enabled()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_blogname()` is deprecated with no replacement.
+ Method `LLMS_Achievement::format_string()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_title()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_content()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Achievement::create()` is deprecated with no replacement.
+ Method `LLMS_Achievements::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement()`.
+ Class `LLMS_Certificate` is deprecated with no direct replacement.
+ Method `LLMS_Certificate::is_enabled()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_blogname()` is deprecated with no replacement.
+ Method `LLMS_Certificate::format_string()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_title()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_content()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_title()` is deprecated with no replacement.
+ Method `LLMS_Certificates::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate()`.
+ Method `LLMS_Engagements::init()` is deprecated with no replacement.
+ Method `LLMS_Engagements::handle_achievement` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement`.
+ Method `LLMS_Engagements::handle_certificate` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate`.
+ Method `LLMS_Engagements::handle_email` is deprecated in favor of `LLMS_Engagement_Handler::handle_email`.
+ Method `LLMS_Database_Query::set_found_results()` is deprecated.
+ Class `LLMS_Achievement_User` is deprecated with no direct replacement.
+ Method `LLMS_Achievement_User::has_user_earned()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::init()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::trigger()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::get_content_html()` is deprecated with no replacement.
+ Class `LLMS_Certificate_User` is deprecated with no direct replacement.
+ Method `LLMS_Certificate_User::init()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::trigger()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::set_shortcode_user()` is deprecated with no replacement.
+ Engagement debug logging is removed. Use `llms_log()` directly instead.
+ Filter `llms_db_query_get_default_args` is deprecated in favor of `llms_{$this->id}_query_get_default_args`.
+ Filter `llms_certificate_has_user_earned` is deprecated in favor of `llms_earned_certificate_dupcheck`.
+ Unused public class property `LLMS_Achievements::$content` is deprecated with no replacement.
+ Method `LLMS_Admin_Post_Types::meta_metabox_init()` is deprecated with no replacement.
+ The site options `lifterlms_certificate_bg_img_width`, `lifterlms_certificate_bg_img_height`, and `lifterlms_certificate_legacy_image_size` are now used only for certificates and certificate templates created using the classic editor.
+ The settings, found on the Engagements Settings screen, are hidden by default.
+ During the database upgrade from versions earlier than 6.x, an site option, `llms_has_legacy_certificates` is added when at least one certificate is found. This option will display the settings so they can continue to be used for legacy certificates.
+ After migrating all certificates on a site, the settings will still display. In order to remove them from the screen a developer can either delete the option `llms_has_legacy_certificates` or return `false` from the filter `llms_has_legacy_certificates`.
+ Method `LLMS_Engagements::handle_certificate` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate`. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ Method `LLMS_Engagements::handle_achievement` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement`. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ The constant `LLMS_ENGAGEMENT_DEBUG` is deprecated with no replacement.
+ Engagement debugging via `LLMS_Engagements::log` is deprecated. Use `llms_log()` instead.
+ Method `LLMS_Engagements::handle_email` is deprecated in favor of `LLMS_Engagement_Handler::handle_email`.
+ Filter `lifterlms_register_post_type_llms_my_certificate` is deprecated in favor of `lifterlms_register_post_type_my_certificate`.
+ Deprecated the misspelled protected method `LLMS_Database_Query::preprare_query()` and replaced with `LLMS_Database_Query::prepare_query()`.
+ Class method `LLMS_Events_Query::preprare_query` replaced with `LLMS_Events_Query::prepare_query()`.
+ Class method `LLMS_Query_Quiz_Attempt::preprare_query` replaced with `LLMS_Query_Quiz_Attempt::prepare_query()`.
+ Class method `LLMS_Query_User_Postmeta::preprare_query` replaced with `LLMS_Query_User_Postmeta::prepare_query()`.
+ Class method `LLMS_Student_Query::preprare_query` replaced with `LLMS_Student_Query::prepare_query()`.
+ Class method `LLMS_Notifications_Query::preprare_query` replaced with `LLMS_Notifications_Query::prepare_query()`.
+ Class method `LLMS_Notifications_Query::preprare_query` replaced with `LLMS_Notifications_Query::prepare_query()`. [#859](https://github.com/gocodebox/lifterlms/issues/859)
##### Breaking Changes
+ Removed FSE template: `templates/block-templates/single-certificate.html`.
+ Removed the deprecated `LLMS()` function in favor of the `llms()` function.
+ Removed the deprecated the `LLMS_SendWP::do_remote_install()` method in favor of the `LLMS_Abstract_Email_Provider::do_remote_install()` method.
+ Removed the deprecated `LLMS_Abstract_Email_Provider::output_css()` method.
+ Removed the deprecated `LLMS_Abstract_Generator_Posts::increment()` method.
+ Removed the deprecated `LLMS_Admin_Users_Table::load_dependencies()` method.
+ Removed the deprecated `LLMS_Admin_Import::localize_stat()` method.
+ Removed the deprecated `LLMS_Admin_Notices_Core::check_staging()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::generator_course_status()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::output_step_html()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::scripts()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::watch_course_generation()` method.
+ Removed the deprecated `llms_format_decimal()` function.
+ Removed the deprecated `llms_set_person_auth_cookie()` function.
+ Removed the deprecated `LLMS_Course::sections` property.
+ Removed the deprecated `LLMS_Course::sku` property.
+ Removed the deprecated `LLMS_Frontend_Assets::enqueue_inline_pw_script()` method.
+ Removed the deprecated `LLMS_Frontend_Assets::enqueue_inline_script()` method.
+ Removed the deprecated `LLMS_Frontend_Assets::is_inline_script_enqueued()` method.
+ Removed the deprecated `LLMS_Generator::add_custom_values()` method.
+ Removed the deprecated `LLMS_Generator::add_custom_values()` method.
+ Removed the deprecated `LLMS_Generator::format_date()` method.
+ Removed the deprecated `LLMS_Generator::get_author_id_from_raw()` method.
+ Removed the deprecated `LLMS_Generator::get_default_post_status()` method.
+ Removed the deprecated `LLMS_Generator::get_generated_posts()` method.
+ Removed the deprecated `LLMS_Generator::increment()` method.
+ Removed the deprecated `llms__created` action hook from the `LLMS_Abstract_Database_Store::create()` method.
+ Removed the deprecated `llms__deleted` action hook from the `LLMS_Abstract_Database_Store::delete()` method.
+ Removed the deprecated `llms__updated` action hook from the `LLMS_Abstract_Database_Store::update()` method.
+ Removed the deprecated `llms_user_removed_from_membership_level` action hook from the `LLMS_Student::unenroll()` method.
+ Removed the deprecated and misspelled `$purchaseable` global variable in the `lifterlms_template_pricing_table()` function.
+ Removed the deprecated and misspelled `$purchaseable` global variable in the `templates/product/pricing-table.php` file.
+ Removed the deprecated `LLMS_Frontend_Password` class.
+ Removed the deprecated `LLMS_Install::db_updates()` method.
+ Removed the deprecated `LLMS_Install::update_notice()` method.
+ Removed the deprecated `LLMS_Notifications::dispatch_processors()` method.
+ Removed the deprecated `llms_processors_async_dispatching` filter hook from the `LLMS_Notifications::__construct()` method.
+ Removed the deprecated `LLMS_Notifications::$_instance` property.
+ Removed the deprecated `LLMS_Person_Handler::register()` method.
+ Removed the deprecated `LLMS_Person_Handler::sanitize_field()` method.
+ Removed the deprecated `LLMS_Person_Handler::update()` method.
+ Removed the deprecated `LLMS_Person_Handler::validate_fields()` method.
+ Removed the deprecated `LLMS_Person_Handler::voucher_toggle_script()` method.
+ Removed the deprecated `templates/admin/notices/db-update.php` file.
+ Removed the deprecated `templates/admin/notices/db-updating.php` file.
+ Removed the deprecated `llms_usernames_blacklist` filter hook in the `llms_get_usernames_blocklist()` function.
+ Removed the deprecated `includes/libraries/wp-background-processing/index.php` file.
+ Removed the deprecated `includes/libraries/wp-background-processing/wp-async-request.php` file.
+ Removed the deprecated `includes/libraries/wp-background-processing/wp-background-process.php` file.
+ Removed the deprecated `LLMS_Section::get_next_available_lesson_order()` method.
+ Removed the deprecated `LLMS_Section::get_order()` method.
+ Removed the deprecated `LLMS_Section::get_parent_course()` method.
+ Removed the deprecated `LLMS_Section::set_parent_course()` method.
+ Removed the deprecated `LLMS_AJAX::check_voucher_duplicate()` method.
+ Removed the deprecated `LLMS_AJAX::get_ajax_data()` method.
+ Removed the deprecated `LLMS_AJAX::register_script()` method.
+ Removed the deprecated `LLMS_Interface_Post_Audio` interface.
+ Removed the deprecated `LLMS_Interface_Post_Sales_Page` interface.
+ Removed the deprecated `LLMS_Interface_Post_Video` interface.
+ Removed the deprecated `LLMS_Achievements::$_instance` property.
+ Removed the deprecated `LLMS_Certificates::$_instance` property.
+ Removed the deprecated `LLMS_Emails::$_instance` property.
+ Removed the deprecated `LLMS_Engagements::$_instance` property.
+ Removed the deprecated `LLMS_Events::$_instance` property.
+ Removed the deprecated `LLMS_Grades::$_instance` property.
+ Removed the deprecated `LLMS_Integrations::$_instance` property.
+ Removed the deprecated `LLMS_Payment_Gateways::$_instance` property.
+ Removed the deprecated `LLMS_Processors::$_instance` property.
+ Removed the deprecated `LLMS_Sessions::$_instance` property.
##### Developer Notes
+ Added `LLMS_Awards_Query`, used for querying data about awarded certificates and achievements.
+ The method signature `LLMS_Student::get_achievements()` and `LLMS_Student::get_certificates()` now use this class under tho hood.
+ The previous method signature, which passed data into a direct SQL query, is now deprecated.
+ Achievement and certificate data storage locations have been modified, primarily to reduce reliance on the `wp_postmeta` table which will result in a site-wide performance improvement, especially on large sites.
+ Meta properties `_llms_achievement_content` and `_llms_certificate_content` have been removed in favor of `WP_Post::$post_content`.
+ Meta properties `_llms_achievement_title` and `_llms_certificate_title` have been removed in favor of `WP_Post::$post_title`.
+ Meta properties `_llms_achievement_template` and `_llms_certificate_template` have been removed in favor of `WP_Post::$post_parent`.
+ Meta properties `_llms_achievement_image` and `_llms_certificate_image` have been moved the meta property `_thumbnail_id` in order to utilize the WordPress core's featured image functionality and internal APIs.
+ Reliance on `lifterlms_user_postmeta` for achievement and certificate data will be removed in a future release.
+ User postmeta properties `_achievement_earned` and `_certificate_earned` will continue to be recorded but are no longer being used internally.
+ The `updated_date` is now accessible via `WP_Post::$post_date`.
+ The `user_id` is now accessible via `WP_Post::$post_author`.
+ Added new Javascript UI components library, modeled after `@wordpress/components`. [Read more](https://github.com/gocodebox/lifterlms/tree/dev-600/packages/components).
+ Added a new SVG icon library, modeled after `@wordpress/icons`. [Read more](https://github.com/gocodebox/lifterlms/tree/dev-600/packages/icons).
+ The merge code button seen on certificate and email template editors is now an SVG image instead of a PNG.
+ Added utility function for escaping and quoting strings. [#1027](https://github.com/gocodebox/lifterlms/issues/1027)
+ Added new utility function for stripping prefixes from strings.
##### Performance Improvements
+ Increased the number of files that are autoloaded instead of manually loaded.
##### Updated Templates
+ [templates/achievements/loop.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/achievements/loop.php)
+ [templates/achievements/template.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/achievements/template.php)
+ [templates/admin/notices/db-update.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/admin/notices/db-update.php)
+ [templates/admin/notices/db-updating.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/admin/notices/db-updating.php)
+ [templates/admin/reporting/reporting.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/admin/reporting/reporting.php)
+ [templates/admin/reporting/tabs/courses/overview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/admin/reporting/tabs/courses/overview.php)
+ [templates/admin/reporting/tabs/memberships/overview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/admin/reporting/tabs/memberships/overview.php)
+ [templates/admin/reporting/tabs/quizzes/overview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/admin/reporting/tabs/quizzes/overview.php)
+ [templates/admin/reporting/tabs/students/information.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/admin/reporting/tabs/students/information.php)
+ [templates/block-templates/archive-course.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/block-templates/archive-course.html)
+ [templates/block-templates/archive-llms_membership.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/block-templates/archive-llms_membership.html)
+ [templates/block-templates/single-no-access.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/block-templates/single-no-access.html)
+ [templates/block-templates/taxonomy-course_cat.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/block-templates/taxonomy-course_cat.html)
+ [templates/block-templates/taxonomy-course_difficulty.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/block-templates/taxonomy-course_difficulty.html)
+ [templates/block-templates/taxonomy-course_tag.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/block-templates/taxonomy-course_tag.html)
+ [templates/block-templates/taxonomy-course_track.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/block-templates/taxonomy-course_track.html)
+ [templates/block-templates/taxonomy-membership_cat.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/block-templates/taxonomy-membership_cat.html)
+ [templates/block-templates/taxonomy-membership_tag.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/block-templates/taxonomy-membership_tag.html)
+ [templates/certificates/actions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/certificates/actions.php)
+ [templates/certificates/content-legacy.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/certificates/content-legacy.php)
+ [templates/certificates/content.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/certificates/content.php)
+ [templates/certificates/dynamic-styles.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/certificates/dynamic-styles.php)
+ [templates/certificates/footer.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/certificates/footer.php)
+ [templates/certificates/header.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/certificates/header.php)
+ [templates/certificates/loop.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/certificates/loop.php)
+ [templates/certificates/preview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/certificates/preview.php)
+ [templates/certificates/template.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/certificates/template.php)
+ [templates/checkout/form-confirm-payment.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/checkout/form-confirm-payment.php)
+ [templates/checkout/form-switch-source.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/checkout/form-switch-source.php)
+ [templates/content-certificate.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/content-certificate.php)
+ [templates/course/lesson-navigation.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/course/lesson-navigation.php)
+ [templates/course/lesson-preview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/course/lesson-preview.php)
+ [templates/course/parent-course.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/course/parent-course.php)
+ [templates/emails/footer.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/emails/footer.php)
+ [templates/emails/header.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/emails/header.php)
+ [templates/loop-main.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/loop-main.php)
+ [templates/loop.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/loop.php)
+ [templates/myaccount/my-grades-single-table.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/myaccount/my-grades-single-table.php)
+ [templates/myaccount/view-order-actions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/myaccount/view-order-actions.php)
+ [templates/myaccount/view-order-information.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/myaccount/view-order-information.php)
+ [templates/myaccount/view-order-transactions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/myaccount/view-order-transactions.php)
+ [templates/myaccount/view-order.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/myaccount/view-order.php)
+ [templates/product/pricing-table.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/product/pricing-table.php)
+ [templates/quiz/questions/content-picture_choice.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/quiz/questions/content-picture_choice.php)
+ [templates/quiz/results.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/quiz/results.php)
+ [templates/single-certificate.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.2/templates/single-certificate.php)
v5.10.0 - 2022-02-22
--------------------
##### Updates and Enhancements
+ Added an option to specify a custom checkout form title for free access plans. [#1774](https://github.com/gocodebox/lifterlms/issues/1774)
+ Updated LifterLMS Blocks to [v2.3.2](https://make.lifterlms.com/2022/02/22/lifterlms-blocks-version-2-3-2/). [#1774](https://github.com/gocodebox/lifterlms/issues/1774)
##### Bug Fixes
+ Fixed ability to sort course students table by completed date. [#1969](https://github.com/gocodebox/lifterlms/issues/1969)
+ Fixed reporting issue encountered when a course has no lessons. [#2012](https://github.com/gocodebox/lifterlms/issues/2012)
+ Fixed broken checkout on Twenty Twenty-Two Theme when using the password strength meter. [#1997](https://github.com/gocodebox/lifterlms/issues/1997)
+ Fixed block template slug generation from path in Windows environments. [#2001](https://github.com/gocodebox/lifterlms/issues/2001)
+ Fixed an issue encountered when using the search box on the voucher admin posts list screen. [#2005](https://github.com/gocodebox/lifterlms/issues/2005)
##### Updated Templates
+ [templates/admin/reporting/tabs/courses/overview.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/admin/reporting/tabs/courses/overview.php)
+ [templates/admin/reporting/tabs/memberships/overview.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/admin/reporting/tabs/memberships/overview.php)
+ [templates/admin/reporting/tabs/quizzes/overview.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/admin/reporting/tabs/quizzes/overview.php)
+ [templates/block-templates/archive-course.html](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/block-templates/archive-course.html)
+ [templates/block-templates/archive-llms_membership.html](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/block-templates/archive-llms_membership.html)
+ [templates/block-templates/single-certificate.html](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/block-templates/single-certificate.html)
+ [templates/block-templates/single-no-access.html](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/block-templates/single-no-access.html)
+ [templates/block-templates/taxonomy-course_cat.html](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/block-templates/taxonomy-course_cat.html)
+ [templates/block-templates/taxonomy-course_difficulty.html](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/block-templates/taxonomy-course_difficulty.html)
+ [templates/block-templates/taxonomy-course_tag.html](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/block-templates/taxonomy-course_tag.html)
+ [templates/block-templates/taxonomy-course_track.html](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/block-templates/taxonomy-course_track.html)
+ [templates/block-templates/taxonomy-membership_cat.html](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/block-templates/taxonomy-membership_cat.html)
+ [templates/block-templates/taxonomy-membership_tag.html](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/block-templates/taxonomy-membership_tag.html)
+ [templates/checkout/form-confirm-payment.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/checkout/form-confirm-payment.php)
+ [templates/course/lesson-navigation.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/course/lesson-navigation.php)
+ [templates/course/lesson-preview.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/course/lesson-preview.php)
+ [templates/course/parent-course.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/course/parent-course.php)
+ [templates/loop-main.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/loop-main.php)
+ [templates/loop.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/loop.php)
+ [templates/myaccount/view-order.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/myaccount/view-order.php)
+ [templates/quiz/questions/content-picture_choice.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/quiz/questions/content-picture_choice.php)
+ [templates/quiz/results.php](https://github.com/gocodebox/lifterlms/blob/5.10.0/templates/quiz/results.php)
v6.0.0-beta.1 - 2022-02-16
--------------------------
##### New Features
+ Added a link to return to the student dashboard when viewing an awarded certificate. [#1959](https://github.com/gocodebox/lifterlms/issues/1959)
+ The block editor is now enabled by default for certificates when using WordPress versions 5.8 and later.
+ Existing certificates are marked as "legacy" and will continue to use the classic editor until migrated.
+ To migrate a certificate, click the "Migrate Certificate" button. This will force the certificate's content into blocks.
+ A number of new settings are available to certificates when using the block editor:
+ Set the certificate's display (and print) size using common paper sizes such as US Letter, US Legal, A3, A4, and more.
+ Set the certificate's display orientation: portrait of landscape.
+ Set the certificate's inner margins.
+ Set the certificate's background color.
+ A new block, the Certificate Title Block, has been made available to certificates.
+ The block works like a WordPress core Heading Block with added options for selecting from a few display fonts (provided by Google Web Fonts).
+ The block controls the title of awarded certificates.
+ + Added the ability to sync awarded certificates with the template used to generate them. [#1078](https://github.com/gocodebox/lifterlms/issues/1078)
+ The `post_name` of earned certificate posts will be generated with a randomized 3+ character string in favor of relying on sequential numbers.
+ Added the ability for administrators and LMS managers to edit earned certificates/achievements from the students reporting screen, as well as award new certificates/achievements to students.
+ + Added certificate global options for the default size of new certificates and certificate templates.
+ Certificate and email template merge code buttons now include `[llms-user]` information shortcodes.
+ Added certificate sequential ID functionality merge code.
##### Updates and Enhancements
+ Added pagination to achievement and certificate reporting pages.
+ Certificates no longer use the `header.php` and `footer.php` files from the site's theme, instead custom templates (`templates/certificates/header.php` and `templates/certificates/footer.php`) are used instead. These templates are minimal and exclude theme wrappers which reduces the visual conflicts encountered from theme wrappers, backgrounds, and more, especially when printing certificates. [#463](https://github.com/gocodebox/lifterlms/issues/463)
+ The achievements and certificates dashboard endpoints are now paginated. [#669](https://github.com/gocodebox/lifterlms/issues/669)
+ Added new default images for use with achievements and certificates.
+ The site-wide default images can be customized on the admin panel under Settings -> Engagements.
+ The old default images can be used by filtering `llms_use_legacy_engagement_images`. [#1081](https://github.com/gocodebox/lifterlms/issues/1081)
+ The URL of earned user certificates has been changed from "my_certificate" to "certificate". Requests to the old url are automatically redirected to the new url, including instances where the URL slug has been translated.
+ The URL of certificate template previews has been changed from "certificate" to "certificate-template".
+ The certificate merge code, `{first_name}`, now outputs an empty string in favor of falling back to the user's nickname when there is no first name for the user. [#1640](https://github.com/gocodebox/lifterlms/issues/1640)
+ Updates LifterLMS REST to [v1.0.0-beta.22](https://make.lifterlms.com/2021/12/15/lifterlms-rest-api-version-1-0-0-beta-22/).
+ The look and behavior of the certificate {{MINI_CERTIFICATE}} pop-over notification merge code now displays a placeholder preview of the certificate in favor of attempting to render a tiny version of the actual certificate. [#1950](https://github.com/gocodebox/lifterlms/issues/1950)
##### Bug Fixes
+ + Fixed how the protected `LLMS_Notifications_Query::$found_results` property is accessed in `LLMS_Abstract_Notification_Controller::has_subscriber_received()`. + Fixed how the protected `LLMS_Notifications_Query::$max_pages` property is accessed in `lifterlms_template_student_dashboard_my_notifications()`.
+ Delayed engagements are automatically unscheduled when the related post is deleted.
+ Prior to sending a delayed engagement the recipient's enrollment in the related post is verified resulting the engagement not being triggered if the recipient's enrollment has been terminated. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ A disabled student dashboard endpoint will no longer display the endpoint's summary on the main dashboard page. [#535](https://github.com/gocodebox/lifterlms/issues/535)
+ Post search filter boxes on various post tables will now longer display a link to the selected post.
+ Basic notification code is no longer loaded on the admin panel.
##### Deprecations
+ Public access to properties of the abstract `LLMS_Database_Query` has been deprecated.
+ Public access to class property `LLMS_Database_Query::$found_results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_found_results()`.
+ Public access to class property `LLMS_Database_Query::$max_pages`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_max_pages()`.
+ Public access to class property `LLMS_Database_Query::$number_results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_number_results()`.
+ Public access to class property `LLMS_Database_Query::$results`. The property is no longer publicly writable but can be read via `LLMS_Database_Query::get_results()`.
+ Public access to class property `LLMS_Database_Query::$query_vars`. The variable as a whole cannot be publicly accessed, instead use `LLMS_Database_Query::get()` and `LLMS_Database_Query::set()` to read and write to the array.
+ The above changes were made to the abstract class `LLMS_Database_Query` but the following concrete classes that utilize the abstract are also affected by this change: `LLMS_Query_User_Postmeta`, `LLMS_Student_Query`, `LLMS_Query_Quiz_Attempt`, `LLMS_Events_Query`, and `LLMS_Notifications_Query`.
+ Class `LLMS_Achievement_User` is deprecated with no direct replacement.
+ Method `LLMS_Achievement::is_enabled()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_blogname()` is deprecated with no replacement.
+ Method `LLMS_Achievement::format_string()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_title()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_content()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Achievement::create()` is deprecated with no replacement.
+ Method `LLMS_Achievements::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement()`.
+ Class `LLMS_Certificate` is deprecated with no direct replacement.
+ Method `LLMS_Certificate::is_enabled()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_blogname()` is deprecated with no replacement.
+ Method `LLMS_Certificate::format_string()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_title()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_content()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_title()` is deprecated with no replacement.
+ Method `LLMS_Certificates::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate()`.
+ Method `LLMS_Engagements::init()` is deprecated with no replacement.
+ Method `LLMS_Engagements::handle_achievement` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement`.
+ Method `LLMS_Engagements::handle_certificate` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate`.
+ Method `LLMS_Engagements::handle_email` is deprecated in favor of `LLMS_Engagement_Handler::handle_email`.
+ Method `LLMS_Database_Query::set_found_results()` is deprecated.
+ Class `LLMS_Achievement_User` is deprecated with no direct replacement.
+ Method `LLMS_Achievement_User::has_user_earned()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::init()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::trigger()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::get_content_html()` is deprecated with no replacement.
+ Class `LLMS_Certificate_User` is deprecated with no direct replacement.
+ Method `LLMS_Certificate_User::init()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::trigger()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::set_shortcode_user()` is deprecated with no replacement.
+ Engagement debug logging is removed. Use `llms_log()` directly instead.
+ Filter `llms_db_query_get_default_args` is deprecated in favor of `llms_{$this->id}_query_get_default_args`.
+ Filter `llms_certificate_has_user_earned` is deprecated in favor of `llms_earned_certificate_dupcheck`.
+ Unused public class property `LLMS_Achievements::$content` is deprecated with no replacement.
+ Method `LLMS_Admin_Post_Types::meta_metabox_init()` is deprecated with no replacement.
+ The site options `lifterlms_certificate_bg_img_width`, `lifterlms_certificate_bg_img_height`, and `lifterlms_certificate_legacy_image_size` are now used only for certificates and certificate templates created using the classic editor.
+ The settings, found on the Engagements Settings screen, are hidden by default.
+ During the database upgrade from versions earlier than 6.x, an site option, `llms_has_legacy_certificates` is added when at least one certificate is found. This option will display the settings so they can continue to be used for legacy certificates.
+ After migrating all certificates on a site, the settings will still display. In order to remove them from the screen a developer can either delete the option `llms_has_legacy_certificates` or return `false` from the filter `llms_has_legacy_certificates`.
+ Method `LLMS_Engagements::handle_certificate` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate`. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ Method `LLMS_Engagements::handle_achievement` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement`. [#290](https://github.com/gocodebox/lifterlms/issues/290)
+ The constant `LLMS_ENGAGEMENT_DEBUG` is deprecated with no replacement.
+ Engagement debugging via `LLMS_Engagements::log` is deprecated. Use `llms_log()` instead.
+ Method `LLMS_Engagements::handle_email` is deprecated in favor of `LLMS_Engagement_Handler::handle_email`.
+ Filter `lifterlms_register_post_type_llms_my_certificate` is deprecated in favor of `lifterlms_register_post_type_my_certificate`.
+ Deprecated the misspelled protected method `LLMS_Database_Query::preprare_query()` and replaced with `LLMS_Database_Query::prepare_query()`.
+ Class method `LLMS_Events_Query::preprare_query` replaced with `LLMS_Events_Query::prepare_query()`.
+ Class method `LLMS_Query_Quiz_Attempt::preprare_query` replaced with `LLMS_Query_Quiz_Attempt::prepare_query()`.
+ Class method `LLMS_Query_User_Postmeta::preprare_query` replaced with `LLMS_Query_User_Postmeta::prepare_query()`.
+ Class method `LLMS_Student_Query::preprare_query` replaced with `LLMS_Student_Query::prepare_query()`.
+ Class method `LLMS_Notifications_Query::preprare_query` replaced with `LLMS_Notifications_Query::prepare_query()`.
+ Class method `LLMS_Notifications_Query::preprare_query` replaced with `LLMS_Notifications_Query::prepare_query()`. [#859](https://github.com/gocodebox/lifterlms/issues/859)
##### Breaking Changes
+ Removed FSE template: `templates/block-templates/single-certificate.html`.
+ Removed the deprecated `LLMS()` function in favor of the `llms()` function.
+ Removed the deprecated the `LLMS_SendWP::do_remote_install()` method in favor of the `LLMS_Abstract_Email_Provider::do_remote_install()` method.
+ Removed the deprecated `LLMS_Abstract_Email_Provider::output_css()` method.
+ Removed the deprecated `LLMS_Abstract_Generator_Posts::increment()` method.
+ Removed the deprecated `LLMS_Admin_Users_Table::load_dependencies()` method.
+ Removed the deprecated `LLMS_Admin_Import::localize_stat()` method.
+ Removed the deprecated `LLMS_Admin_Notices_Core::check_staging()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::generator_course_status()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::output_step_html()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::scripts()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::watch_course_generation()` method.
+ Removed the deprecated `llms_format_decimal()` function.
+ Removed the deprecated `llms_set_person_auth_cookie()` function.
+ Removed the deprecated `LLMS_Course::sections` property.
+ Removed the deprecated `LLMS_Course::sku` property.
+ Removed the deprecated `LLMS_Frontend_Assets::enqueue_inline_pw_script()` method.
+ Removed the deprecated `LLMS_Frontend_Assets::enqueue_inline_script()` method.
+ Removed the deprecated `LLMS_Frontend_Assets::is_inline_script_enqueued()` method.
+ Removed the deprecated `LLMS_Generator::add_custom_values()` method.
+ Removed the deprecated `LLMS_Generator::add_custom_values()` method.
+ Removed the deprecated `LLMS_Generator::format_date()` method.
+ Removed the deprecated `LLMS_Generator::get_author_id_from_raw()` method.
+ Removed the deprecated `LLMS_Generator::get_default_post_status()` method.
+ Removed the deprecated `LLMS_Generator::get_generated_posts()` method.
+ Removed the deprecated `LLMS_Generator::increment()` method.
+ Removed the deprecated `llms__created` action hook from the `LLMS_Abstract_Database_Store::create()` method.
+ Removed the deprecated `llms__deleted` action hook from the `LLMS_Abstract_Database_Store::delete()` method.
+ Removed the deprecated `llms__updated` action hook from the `LLMS_Abstract_Database_Store::update()` method.
+ Removed the deprecated `llms_user_removed_from_membership_level` action hook from the `LLMS_Student::unenroll()` method.
+ Removed the deprecated and misspelled `$purchaseable` global variable in the `lifterlms_template_pricing_table()` function.
+ Removed the deprecated and misspelled `$purchaseable` global variable in the `templates/product/pricing-table.php` file.
+ Removed the deprecated `LLMS_Frontend_Password` class.
+ Removed the deprecated `LLMS_Install::db_updates()` method.
+ Removed the deprecated `LLMS_Install::update_notice()` method.
+ Removed the deprecated `LLMS_Notifications::dispatch_processors()` method.
+ Removed the deprecated `llms_processors_async_dispatching` filter hook from the `LLMS_Notifications::__construct()` method.
+ Removed the deprecated `LLMS_Notifications::$_instance` property.
+ Removed the deprecated `LLMS_Person_Handler::register()` method.
+ Removed the deprecated `LLMS_Person_Handler::sanitize_field()` method.
+ Removed the deprecated `LLMS_Person_Handler::update()` method.
+ Removed the deprecated `LLMS_Person_Handler::validate_fields()` method.
+ Removed the deprecated `LLMS_Person_Handler::voucher_toggle_script()` method.
+ Removed the deprecated `templates/admin/notices/db-update.php` file.
+ Removed the deprecated `templates/admin/notices/db-updating.php` file.
+ Removed the deprecated `llms_usernames_blacklist` filter hook in the `llms_get_usernames_blocklist()` function.
+ Removed the deprecated `includes/libraries/wp-background-processing/index.php` file.
+ Removed the deprecated `includes/libraries/wp-background-processing/wp-async-request.php` file.
+ Removed the deprecated `includes/libraries/wp-background-processing/wp-background-process.php` file.
+ Removed the deprecated `LLMS_Section::get_next_available_lesson_order()` method.
+ Removed the deprecated `LLMS_Section::get_order()` method.
+ Removed the deprecated `LLMS_Section::get_parent_course()` method.
+ Removed the deprecated `LLMS_Section::set_parent_course()` method.
+ Removed the deprecated `LLMS_AJAX::check_voucher_duplicate()` method.
+ Removed the deprecated `LLMS_AJAX::get_ajax_data()` method.
+ Removed the deprecated `LLMS_AJAX::register_script()` method.
+ Removed the deprecated `LLMS_Interface_Post_Audio` interface.
+ Removed the deprecated `LLMS_Interface_Post_Sales_Page` interface.
+ Removed the deprecated `LLMS_Interface_Post_Video` interface.
+ Removed the deprecated `LLMS_Achievements::$_instance` property.
+ Removed the deprecated `LLMS_Certificates::$_instance` property.
+ Removed the deprecated `LLMS_Emails::$_instance` property.
+ Removed the deprecated `LLMS_Engagements::$_instance` property.
+ Removed the deprecated `LLMS_Events::$_instance` property.
+ Removed the deprecated `LLMS_Grades::$_instance` property.
+ Removed the deprecated `LLMS_Integrations::$_instance` property.
+ Removed the deprecated `LLMS_Payment_Gateways::$_instance` property.
+ Removed the deprecated `LLMS_Processors::$_instance` property.
+ Removed the deprecated `LLMS_Sessions::$_instance` property.
##### Developer Notes
+ Added `LLMS_Awards_Query`, used for querying data about awarded certificates and achievements.
+ The method signature `LLMS_Student::get_achievements()` and `LLMS_Student::get_certificates()` now use this class under tho hood.
+ The previous method signature, which passed data into a direct SQL query, is now deprecated.
+ Achievement and certificate data storage locations have been modified, primarily to reduce reliance on the `wp_postmeta` table which will result in a site-wide performance improvement, especially on large sites.
+ Meta properties `_llms_achievement_content` and `_llms_certificate_content` have been removed in favor of `WP_Post::$post_content`.
+ Meta properties `_llms_achievement_title` and `_llms_certificate_title` have been removed in favor of `WP_Post::$post_title`.
+ Meta properties `_llms_achievement_template` and `_llms_certificate_template` have been removed in favor of `WP_Post::$post_parent`.
+ Meta properties `_llms_achievement_image` and `_llms_certificate_image` have been moved the meta property `_thumbnail_id` in order to utilize the WordPress core's featured image functionality and internal APIs.
+ Reliance on `lifterlms_user_postmeta` for achievement and certificate data will be removed in a future release.
+ User postmeta properties `_achievement_earned` and `_certificate_earned` will continue to be recorded but are no longer being used internally.
+ The `updated_date` is now accessible via `WP_Post::$post_date`.
+ The `user_id` is now accessible via `WP_Post::$post_author`.
+ Added new Javascript UI components library, modeled after `@wordpress/components`. [Read more](https://github.com/gocodebox/lifterlms/tree/dev-600/packages/components).
+ Added a new SVG icon library, modeled after `@wordpress/icons`. [Read more](https://github.com/gocodebox/lifterlms/tree/dev-600/packages/icons).
+ The merge code button seen on certificate and email template editors is now an SVG image instead of a PNG.
+ Added utility function for escaping and quoting strings. [#1027](https://github.com/gocodebox/lifterlms/issues/1027)
+ Added new utility function for stripping prefixes from strings.
##### Performance Improvements
+ Increased the number of files that are autoloaded instead of manually loaded.
##### Updated Templates
+ [templates/achievements/loop.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/achievements/loop.php)
+ [templates/achievements/template.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/achievements/template.php)
+ [templates/admin/notices/db-update.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/admin/notices/db-update.php)
+ [templates/admin/notices/db-updating.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/admin/notices/db-updating.php)
+ [templates/admin/reporting/reporting.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/admin/reporting/reporting.php)
+ [templates/admin/reporting/tabs/courses/overview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/admin/reporting/tabs/courses/overview.php)
+ [templates/admin/reporting/tabs/memberships/overview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/admin/reporting/tabs/memberships/overview.php)
+ [templates/admin/reporting/tabs/quizzes/overview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/admin/reporting/tabs/quizzes/overview.php)
+ [templates/admin/reporting/tabs/students/information.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/admin/reporting/tabs/students/information.php)
+ [templates/block-templates/archive-course.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/block-templates/archive-course.html)
+ [templates/block-templates/archive-llms_membership.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/block-templates/archive-llms_membership.html)
+ [templates/block-templates/single-no-access.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/block-templates/single-no-access.html)
+ [templates/block-templates/taxonomy-course_cat.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/block-templates/taxonomy-course_cat.html)
+ [templates/block-templates/taxonomy-course_difficulty.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/block-templates/taxonomy-course_difficulty.html)
+ [templates/block-templates/taxonomy-course_tag.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/block-templates/taxonomy-course_tag.html)
+ [templates/block-templates/taxonomy-course_track.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/block-templates/taxonomy-course_track.html)
+ [templates/block-templates/taxonomy-membership_cat.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/block-templates/taxonomy-membership_cat.html)
+ [templates/block-templates/taxonomy-membership_tag.html](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/block-templates/taxonomy-membership_tag.html)
+ [templates/certificates/actions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/certificates/actions.php)
+ [templates/certificates/content-legacy.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/certificates/content-legacy.php)
+ [templates/certificates/content.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/certificates/content.php)
+ [templates/certificates/dynamic-styles.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/certificates/dynamic-styles.php)
+ [templates/certificates/footer.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/certificates/footer.php)
+ [templates/certificates/header.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/certificates/header.php)
+ [templates/certificates/loop.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/certificates/loop.php)
+ [templates/certificates/preview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/certificates/preview.php)
+ [templates/certificates/template.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/certificates/template.php)
+ [templates/checkout/form-confirm-payment.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/checkout/form-confirm-payment.php)
+ [templates/checkout/form-switch-source.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/checkout/form-switch-source.php)
+ [templates/content-certificate.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/content-certificate.php)
+ [templates/course/lesson-navigation.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/course/lesson-navigation.php)
+ [templates/course/lesson-preview.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/course/lesson-preview.php)
+ [templates/course/parent-course.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/course/parent-course.php)
+ [templates/emails/footer.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/emails/footer.php)
+ [templates/emails/header.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/emails/header.php)
+ [templates/loop-main.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/loop-main.php)
+ [templates/loop.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/loop.php)
+ [templates/myaccount/my-grades-single-table.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/myaccount/my-grades-single-table.php)
+ [templates/myaccount/view-order-actions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/myaccount/view-order-actions.php)
+ [templates/myaccount/view-order-information.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/myaccount/view-order-information.php)
+ [templates/myaccount/view-order-transactions.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/myaccount/view-order-transactions.php)
+ [templates/myaccount/view-order.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/myaccount/view-order.php)
+ [templates/product/pricing-table.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/product/pricing-table.php)
+ [templates/quiz/questions/content-picture_choice.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/quiz/questions/content-picture_choice.php)
+ [templates/quiz/results.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/quiz/results.php)
+ [templates/single-certificate.php](https://github.com/gocodebox/lifterlms/blob/6.0.0-beta.1/templates/single-certificate.php)
v5.9.0 - 2022-02-15
-------------------
##### Updates and Enhancements
+ Picture choice questions are now organized using flexbox in favor of a float-powered column layout.
+ Resolved PHP 8.1 deprecation warnings. [#1859](https://github.com/gocodebox/lifterlms/issues/1859)
##### Bug Fixes
+ Updated `llms_get_endpoint_url()` to better adhere to a site's permalink structure with regards to the presence of a trailing slash in the generated url. [#1983](https://github.com/gocodebox/lifterlms/issues/1983)
+ Only allow users with `edit_post` capabilities to bypass content restrictions.
+ Fixed stretched images in quiz description/questions when using the Twenty Twenty-Two theme. [#1976](https://github.com/gocodebox/lifterlms/issues/1976)
##### Deprecations
+ Method `LLMS_AJAX::check_voucher_duplicate()` is deprecated in favor of `LLMS_AJAX_HANDLER::check_voucher_duplicate()`.
##### Updated Templates
+ [templates/admin/reporting/tabs/courses/overview.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/admin/reporting/tabs/courses/overview.php)
+ [templates/admin/reporting/tabs/memberships/overview.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/admin/reporting/tabs/memberships/overview.php)
+ [templates/admin/reporting/tabs/quizzes/overview.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/admin/reporting/tabs/quizzes/overview.php)
+ [templates/block-templates/archive-course.html](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/block-templates/archive-course.html)
+ [templates/block-templates/archive-llms_membership.html](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/block-templates/archive-llms_membership.html)
+ [templates/block-templates/single-certificate.html](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/block-templates/single-certificate.html)
+ [templates/block-templates/single-no-access.html](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/block-templates/single-no-access.html)
+ [templates/block-templates/taxonomy-course_cat.html](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/block-templates/taxonomy-course_cat.html)
+ [templates/block-templates/taxonomy-course_difficulty.html](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/block-templates/taxonomy-course_difficulty.html)
+ [templates/block-templates/taxonomy-course_tag.html](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/block-templates/taxonomy-course_tag.html)
+ [templates/block-templates/taxonomy-course_track.html](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/block-templates/taxonomy-course_track.html)
+ [templates/block-templates/taxonomy-membership_cat.html](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/block-templates/taxonomy-membership_cat.html)
+ [templates/block-templates/taxonomy-membership_tag.html](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/block-templates/taxonomy-membership_tag.html)
+ [templates/checkout/form-confirm-payment.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/checkout/form-confirm-payment.php)
+ [templates/course/lesson-navigation.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/course/lesson-navigation.php)
+ [templates/course/lesson-preview.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/course/lesson-preview.php)
+ [templates/course/parent-course.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/course/parent-course.php)
+ [templates/loop-main.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/loop-main.php)
+ [templates/loop.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/loop.php)
+ [templates/myaccount/view-order.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/myaccount/view-order.php)
+ [templates/quiz/questions/content-picture_choice.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/quiz/questions/content-picture_choice.php)
+ [templates/quiz/results.php](https://github.com/gocodebox/lifterlms/blob/5.9.0/templates/quiz/results.php)
v6.0.0-alpha.4 - 2022-02-11
---------------------------
##### Updates and Enhancements
+ Removed usage of PHP features deprecated in PHP 8.1.
+ Added a link to return to the student dashboard when viewing an awarded certificate.
+ Allow block templates to be overridden from themes or plugins.
+ Added a "Reset Certificate" button to restore certificates to the default template.
+ Added links from achievement and certificate templates to view all awards generated from the template.
+ Added the ability to sync achievements (sync all awards to the parent template and sync one award to it's parent).
+ Improved class autoloading.
##### Bug Fixes
+ Fixed certificate print compatibility issues with the OceanWP and Genesis themes.
+ Fixed custom font usage in the Certificate Title block to utilize WP Core functionality introduced in version 5.9.
+ Fixed access to protected properties in the `LLMS_Notifications_Query` class.
##### Breaking Changes
+ Removed the Single Certificate block template.
v5.8.0 - 2022-01-26
-------------------
##### New Features
+ Add theme support for the Twenty Twenty-Two theme. [#1824](https://github.com/gocodebox/lifterlms/issues/1824)
+ Added WordPress Full Site Editing compatibility for various LifterLMS-powered templates.
##### Updates and Enhancements
+ The minimum required WordPress core version is now version 5.5.
+ Tested against WordPress version 5.9.
+ Updated LifterLMS Blocks: [v2.3.0](https://make.lifterlms.com/2022/01/25/lifterlms-blocks-version-2-3-0/), [v2.3.1](https://make.lifterlms.com/2022/01/26/lifterlms-blocks-version-2-3-1/).
+ Remove the "description" registered with LifterLMS custom post types. [#710](https://github.com/gocodebox/lifterlms/issues/710)
##### Updated Templates
+ [templates/block-templates/archive-course.html](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/block-templates/archive-course.html)
+ [templates/block-templates/archive-llms_membership.html](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/block-templates/archive-llms_membership.html)
+ [templates/block-templates/single-certificate.html](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/block-templates/single-certificate.html)
+ [templates/block-templates/single-no-access.html](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/block-templates/single-no-access.html)
+ [templates/block-templates/taxonomy-course_cat.html](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/block-templates/taxonomy-course_cat.html)
+ [templates/block-templates/taxonomy-course_difficulty.html](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/block-templates/taxonomy-course_difficulty.html)
+ [templates/block-templates/taxonomy-course_tag.html](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/block-templates/taxonomy-course_tag.html)
+ [templates/block-templates/taxonomy-course_track.html](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/block-templates/taxonomy-course_track.html)
+ [templates/block-templates/taxonomy-membership_cat.html](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/block-templates/taxonomy-membership_cat.html)
+ [templates/block-templates/taxonomy-membership_tag.html](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/block-templates/taxonomy-membership_tag.html)
+ [templates/course/lesson-navigation.php](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/course/lesson-navigation.php)
+ [templates/course/lesson-preview.php](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/course/lesson-preview.php)
+ [templates/course/parent-course.php](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/course/parent-course.php)
+ [templates/loop-main.php](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/loop-main.php)
+ [templates/loop.php](https://github.com/gocodebox/lifterlms/blob/5.8.0/templates/loop.php)
v6.0.0-alpha.3 - 2022-01-14
---------------------------
##### Updates and Enhancements
+ Automatically dequeue print-only stylesheets to reduce theme and plugin conflicts when printing certificates.
+ Only enable the Certificate Title block font-family selector for WordPress 5.9 and later.
+ Only enable the Block Editor for certificates on WordPress 5.8 and later.
+ Replaced welcome message placeholder text with a real welcome message.
##### Bug Fixes
+ Explicitly define a default font-family ("default") for the Certificate Title block.
+ Fixed visual issues encountered on certificates when resizing the browser window.
+ Fixed issue with the certificate block template on WordPress 5.8 (divider blocks aren't centered by default).
##### Breaking Changes
+ Removed the deprecated `LLMS()` function in favor of the `llms()` function.
+ Removed the deprecated `LLMS_SendWP::do_remote_install()` method in favor of the `LLMS_Abstract_Email_Provider::do_remote_install()` method.
+ Removed the deprecated `LLMS_Abstract_Email_Provider::output_css()` method.
+ Removed the deprecated `LLMS_Abstract_Generator_Posts::increment()` method.
+ Removed the deprecated `LLMS_Admin_Users_Table::load_dependencies()` method.
+ Removed the deprecated `LLMS_Admin_Import::localize_stat()` method.
+ Removed the deprecated `LLMS_Admin_Notices_Core::check_staging()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::generator_course_status()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::output_step_html()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::scripts()` method.
+ Removed the deprecated `LLMS_Admin_Setup_Wizard::watch_course_generation()` method.
+ Removed the deprecated `llms_format_decimal()` function.
+ Removed the deprecated `llms_set_person_auth_cookie()` function.
+ Removed the deprecated `LLMS_Course::sections` property.
+ Removed the deprecated `LLMS_Course::sku` property.
+ Removed the deprecated `LLMS_Frontend_Assets::enqueue_inline_pw_script()` method.
+ Removed the deprecated `LLMS_Frontend_Assets::enqueue_inline_script()` method.
+ Removed the deprecated `LLMS_Frontend_Assets::is_inline_script_enqueued()` method.
+ Removed the deprecated `LLMS_Generator::add_custom_values()` method.
+ Removed the deprecated `LLMS_Generator::add_custom_values()` method.
+ Removed the deprecated `LLMS_Generator::format_date()` method.
+ Removed the deprecated `LLMS_Generator::get_author_id_from_raw()` method.
+ Removed the deprecated `LLMS_Generator::get_default_post_status()` method.
+ Removed the deprecated `LLMS_Generator::get_generated_posts()` method.
+ Removed the deprecated `LLMS_Generator::increment()` method.
+ Removed the deprecated `llms__created` action hook from the `LLMS_Abstract_Database_Store::create()` method.
+ Removed the deprecated `llms__deleted` action hook from the `LLMS_Abstract_Database_Store::delete()` method.
+ Removed the deprecated `llms__updated` action hook from the `LLMS_Abstract_Database_Store::update()` method.
+ Removed the deprecated `llms_user_removed_from_membership_level` action hook from the `LLMS_Student::unenroll()` method.
+ Removed the deprecated and misspelled `$purchaseable` global variable in the `lifterlms_template_pricing_table()` function.
+ Removed the deprecated and misspelled `$purchaseable` global variable in the `templates/product/pricing-table.php` file.
+ Removed the deprecated `LLMS_Frontend_Password` class.
+ Removed the deprecated `LLMS_Install::db_updates()` method.
+ Removed the deprecated `LLMS_Install::update_notice()` method.
+ Removed the deprecated `LLMS_Notifications::dispatch_processors()` method.
+ Removed the deprecated `llms_processors_async_dispatching` filter hook from the `LLMS_Notifications::__construct()` method.
+ Removed the deprecated `LLMS_Notifications::$_instance` property.
+ Removed the deprecated `LLMS_Person_Handler::register()` method.
+ Removed the deprecated `LLMS_Person_Handler::sanitize_field()` method.
+ Removed the deprecated `LLMS_Person_Handler::update()` method.
+ Removed the deprecated `LLMS_Person_Handler::validate_fields()` method.
+ Removed the deprecated `LLMS_Person_Handler::voucher_toggle_script()` method.
+ Removed the deprecated `templates/admin/notices/db-update.php` file.
+ Removed the deprecated `templates/admin/notices/db-updating.php` file.
+ Removed the deprecated `llms_usernames_blacklist` filter hook in the `llms_get_usernames_blocklist()` function.
+ Removed the deprecated `includes/libraries/wp-background-processing/index.php` file.
+ Removed the deprecated `includes/libraries/wp-background-processing/wp-async-request.php` file.
+ Removed the deprecated `includes/libraries/wp-background-processing/wp-background-process.php` file.
+ Removed the deprecated `LLMS_Section::get_next_available_lesson_order()` method.
+ Removed the deprecated `LLMS_Section::get_order()` method.
+ Removed the deprecated `LLMS_Section::get_parent_course()` method.
+ Removed the deprecated `LLMS_Section::set_parent_course()` method.
+ Removed the deprecated `LLMS_AJAX::get_ajax_data()` method.
+ Removed the deprecated `LLMS_AJAX::register_script()` method.
+ Removed the deprecated `LLMS_Interface_Post_Audio` interface.
+ Removed the deprecated `LLMS_Interface_Post_Sales_Page` interface.
+ Removed the deprecated `LLMS_Interface_Post_Video` interface.
+ Removed the deprecated `LLMS_Achievements::$_instance` property.
+ Removed the deprecated `LLMS_Certificates::$_instance` property.
+ Removed the deprecated `LLMS_Emails::$_instance` property.
+ Removed the deprecated `LLMS_Engagements::$_instance` property.
+ Removed the deprecated `LLMS_Events::$_instance` property.
+ Removed the deprecated `LLMS_Grades::$_instance` property.
+ Removed the deprecated `LLMS_Integrations::$_instance` property.
+ Removed the deprecated `LLMS_Payment_Gateways::$_instance` property.
+ Removed the deprecated `LLMS_Processors::$_instance` property.
+ Removed the deprecated `LLMS_Sessions::$_instance` property.
v5.7.0 - 2022-01-11
-------------------
##### Updates and Enhancements
+ Informed developers about the deprecated `LLMS_Section::get_next_available_lesson_order()` method.
+ Informed developers about the deprecated `LLMS_Section::get_order()` method.
+ Informed developers about the deprecated `LLMS_Section::get_parent_course()` method.
+ Informed developers about the deprecated `LLMS_Section::set_parent_course()` method.
##### Deprecations
+ Deprecated `LLMS_Frontend_Assets::enqueue_inline_pw_script()` with no replacement.
+ Deprecated the `LLMS_Lesson::get_order()` method in favor of the `LLMS_Lesson::get( 'order' )` method.
+ Deprecated the `LLMS_Lesson::get_parent_course()` method in favor of the `LLMS_Lesson::get( 'parent_course' )` method.
+ Deprecated the `LLMS_Lesson::set_parent_course()` method in favor of the `LLMS_Lesson::set( 'parent_course', $course_id )` method.
+ Deprecated the `LLMS_AJAX_Handler::add_lesson_to_course()` method with no replacement.
+ Deprecated the `LLMS_AJAX_Handler::create_lesson()` method with no replacement.
+ Deprecated the `LLMS_AJAX_Handler::create_section()` method with no replacement.
+ Deprecated the `LLMS_Lesson_Handler::assign_to_course()` method with no replacement.
+ Deprecated the `LLMS_Post_Handler::create_section()` method with no replacement.
##### Updated Templates
+ [templates/course/lesson-navigation.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/course/lesson-navigation.php)
+ [templates/course/lesson-preview.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/course/lesson-preview.php)
+ [templates/course/parent-course.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/course/parent-course.php)
v6.0.0-alpha.2 - 2022-01-04
---------------------------
##### New Features
+ Added certificate global options for the default size of new certificates and certificate templates.
##### Updates and enhancements
+ The site options `lifterlms_certificate_bg_img_width`,
`lifterlms_certificate_bg_img_height`, and
`lifterlms_certificate_legacy_image_size` are now used only for certificates
and certificate templates created using the classic editor.
+ The settings, found on the Engagements Settings screen, are hidden by default.
+ During the database upgrade from versions earlier than 6.x, an site option, `llms_has_legacy_certificates` is added when at least one certificate is found. This option will display the settings so they can continue to be used for legacy certificates.
+ After migrating all certificates on a site, the settings will still display. In order to remove them from the screen a developer can either delete the option `llms_has_legacy_certificates` or return `false` from the filter `llms_has_legacy_certificates`.
+ Restore certificate save hooks after executing callback updates to facilitate scenarios where more than one certificate is updated in a single request.
##### Bug Fixes
+ Only register the Certificate Title block for use on certificate post types.
##### Updated Templates
+ [templates/certificates/content-legacy.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/certificates/content-legacy.php)
v6.0.0-alpha.1 - 2021-12-28
---------------------------
**This version is an unstable pre-release! We strongly advise against installing this in a production environment.**
##### New Features
+ The block editor is now enabled by default for certificates.
+ Existing certificates are marked as "legacy" and will continue to use the classic editor until migrated.
+ To migrate a certificate, click the "Migrate Certificate" button. This will force the certificate's content into blocks.
+ A number of new settings are available to certificates when using the block editor:
+ Set the certificate's display (and print) size using common paper sizes such as US Letter, US Legal, A3, A4, and more.
+ Set the certificate's display orientation: portrait of landscape.
+ Set the certificate's inner margins.
+ Set the certificate's background color.
+ A new block, the Certificate Title Block, has been made available to certificates.
+ The block works like a WordPress core Heading Block with added options for selecting from a few display fonts (provided by Google Web Fonts).
+ The block controls the title of awarded certificates.
+ + Added the ability to sync awarded certificates with the template used to generate them. [#1078](https://github.com/gocodebox/lifterlms#1078)
+ The `post_name` of earned certificate posts will be generated with a randomized 3+ character string in favor of relying on sequential numbers.
+ Added the ability for administrators and LMS managers to edit earned certificates/achievements from the students reporting screen, as well as award new certificates/achievements to students.
+ Certificate and email template merge code buttons now include [llms-user] information shortcodes.
+ Added certificate sequential ID functionality merge code. [Read more](@TODO).
##### Updates and Enhancements
+ Added pagination to achievement and certificate reporting pages.
+ Certificates no longer use the `header.php` and `footer.php` files from the site's theme, instead custom templates (`templates/certificates/header.php` and `templates/certificates/footer.php`) are used instead. These templates are minimal and exclude theme wrappers which reduces the visual conflicts encountered from theme wrappers, backgrounds, and more, especially when printing certificates. [#463](https://github.com/gocodebox/lifterlms#463)
+ The achievements and certificates dashboard endpoints are now paginated. [#669](https://github.com/gocodebox/lifterlms#669)
+ Added new default images for use with achievements and certificates.
+ The site-wide default images can be customized on the admin panel under Settings -> Engagements.
+ The old default images can be used by filtering `llms_use_legacy_engagement_images`. [#1081](https://github.com/gocodebox/lifterlms#1081)
+ The URL of earned user certificates has been changed from "my_certificate" to "certificate". Requests to the old url are automatically redirected to the new url, including instances where the URL slug has been translated.
+ The URL of certificate template previews has been changed from "certificate" to "certificate-template".
+ The certificate merge code, `{first_name}`, now outputs an empty string in favor of falling back to the user's nickname when there is no first name for the user. [#1640](https://github.com/gocodebox/lifterlms#1640)
+ Updates LifterLMS REST to [v1.0.0-beta.22](https://make.lifterlms.com/2021/12/15/lifterlms-rest-api-version-1-0-0-beta-22/).
##### Bug Fixes
+ Delayed engagements are automatically unscheduled when the related post is deleted.
+ Prior to sending a delayed engagement the recipient's enrollment in the related post is verified resulting the engagement not being triggered if the recipient's enrollment has been terminated. [#290](https://github.com/gocodebox/lifterlms#290)
+ A disabled student dashboard endpoint will no longer display the endpoint's summary on the main dashboard page. [#535](https://github.com/gocodebox/lifterlms#535)
+ Post search filter boxes on various post tables will now longer display a link to the selected post.
+ Basic notification code is no longer loaded on the admin panel.
##### Deprecations
+ Class `LLMS_Achievement_User` is deprecated with no direct replacement.
+ Method `LLMS_Achievement::is_enabled()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_blogname()` is deprecated with no replacement.
+ Method `LLMS_Achievement::format_string()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_title()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_content()` is deprecated with no replacement.
+ Method `LLMS_Achievement::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Achievement::create()` is deprecated with no replacement.
+ Method `LLMS_Achievments::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement()`.
+ Class `LLMS_Certificate` is deprecated with no direct replacement.
+ Method `LLMS_Certificate::is_enabled()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_blogname()` is deprecated with no replacement.
+ Method `LLMS_Certificate::format_string()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_title()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_content()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Certificate::get_title()` is deprecated with no replacement.
+ Method `LLMS_Certificates::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate()`.
+ Method `LLMS_Engagements::init()` is deprecated with no replacement.
+ Method `LLMS_Engagements::handle_achievement` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement`.
+ Method `LLMS_Engagements::handle_certificate` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate`.
+ Method `LLMS_Engagements::handle_email` is deprecated in favor of `LLMS_Engagement_Handler::handle_email`.
+ Method `LLMS_Database_Query::set_found_results()` is deprecated.
+ Class `LLMS_Achievement_User` is deprecated with no direct replacement.
+ Method `LLMS_Achievement_User::has_user_earned()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::init()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::trigger()` is deprecated with no replacement.
+ Method `LLMS_Achievement_User::get_content_html()` is deprecated with no replacement.
+ Class `LLMS_Certificate_User` is deprecated with no direct replacement.
+ Method `LLMS_Certificate_User::init()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::trigger()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::get_content_html()` is deprecated with no replacement.
+ Method `LLMS_Certificate_User::set_shortcode_user()` is deprecated with no replacement.
+ Engagement debug logging is removed. Use `llms_log()` directly instead.
+ Filter `llms_db_query_get_default_args` is deprecated in favor of `llms_{$this->id}_query_get_default_args`.
+ Filter `llms_certificate_has_user_earned` is deprecated in favor of `llms_earned_certificate_dupcheck`.
+ Unused public class property `LLMS_Achievements::$content` is deprecated with no replacement.
+ Method `LLMS_Engagements::handle_certificate` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate`. [#290](https://github.com/gocodebox/lifterlms#290)
+ Method `LLMS_Engagements::handle_achievement` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement`. [#290](https://github.com/gocodebox/lifterlms#290)
+ The constant `LLMS_ENGAGEMENT_DEBUG` is deprecated with no replacement.
+ Engagement debugging via `LLMS_Engagements::log` is deprecated. Use `llms_log()` instead.
+ Method `LLMS_Engagements::handle_email` is deprecated in favor of `LLMS_Engagement_Handler::handle_email`.
+ Filter `lifterlms_register_post_type_llms_my_certificate` is deprecated in favor of `lifterlms_register_post_type_my_certificate`.
+ Deprecated the misspelled protected method `LLMS_Database_Query::preprare_query()` and replaced with `LLMS_Database_Query::prepare_query()`.
+ Class method `LLMS_Events_Query::preprare_query` replaced with `LLMS_Events_Query::prepare_query()`.
+ Class method `LLMS_Query_Quiz_Attempt::preprare_query` replaced with `LLMS_Query_Quiz_Attempt::prepare_query()`.
+ Class method `LLMS_Query_User_Postmeta::preprare_query` replaced with `LLMS_Query_User_Postmeta::prepare_query()`.
+ Class method `LLMS_Student_Query::preprare_query` replaced with `LLMS_Student_Query::prepare_query()`.
+ Class method `LLMS_Notifications_Query::preprare_query` replaced with `LLMS_Notifications_Query::prepare_query()`.
+ Class method `LLMS_Notifications_Query::preprare_query` replaced with `LLMS_Notifications_Query::prepare_query()`. [#859](https://github.com/gocodebox/lifterlms#859)
##### Developer Notes
+ Added `LLMS_Awards_Query`, used for querying data about awarded certificates and achievements.
+ The method signature `LLMS_Student::get_achievements()` and `LLMS_Student::get_certificates()` now use this class under tho hood.
+ The previous method signature, which passed data into a direct SQL query, is now deprecated.
+ Achievement and certificate data storage locations have been modified, primarily to reduce reliance on the `wp_postmeta` table which will result in a site-wide performance improvement, especially on large sites.
+ Meta properties `_llms_achievement_content` and `_llms_certificate_content` have been removed in favor of `WP_Post::$post_content`.
+ Meta properties `_llms_achievement_title` and `_llms_certificate_title` have been removed in favor of `WP_Post::$post_title`.
+ Meta properties `_llms_achievement_template` and `_llms_certificate_template` have been removed in favor of `WP_Post::$post_parent`.
+ Meta properties `_llms_achievement_image` and `_llms_certificate_image` have been moved the meta property `_thumbnail_id` in order to utilize the WordPress core's featured image functionality and internal APIs.
+ Reliance on `lifterlms_user_postmeta` for achievement and certificate data will be removed in a future release.
+ User postmeta properties `_achievement_earned` and `_certificate_earned` will continue to be recorded but are no longer being used internally.
+ The `updated_date` is now accessible via `WP_Post::$post_date`.
+ The `user_id` is now accessible via `WP_Post::$post_author`.
+ Added new Javascript UI components library, modeled after `@wordpress/components`. [Read more](https://github.com/gocodebox/lifterlms/tree/dev-600/packages/components).
+ Added a new SVG icon library, modeled after `@wordpress/icons`. [Read more](https://github.com/gocodebox/lifterlms/tree/dev-600/packages/icons).
+ The merge code button seen on certificate and email template editors is now an SVG image instead of a PNG.
+ Added utility function for escaping and quoting strings. [#1027](https://github.com/gocodebox/lifterlms#1027)
+ Added new utility function for stripping prefixes from strings.
##### Updated Templates
+ [templates/achievements/loop.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/achievements/loop.php)
+ [templates/achievements/template.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/achievements/template.php)
+ [templates/admin/reporting/tabs/students/information.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/admin/reporting/tabs/students/information.php)
+ [templates/certificates/actions.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/certificates/actions.php)
+ [templates/certificates/content-legacy.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/certificates/content-legacy.php)
+ [templates/certificates/content.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/certificates/content.php)
+ [templates/certificates/dynamic-styles.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/certificates/dynamic-styles.php)
+ [templates/certificates/footer.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/certificates/footer.php)
+ [templates/certificates/header.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/certificates/header.php)
+ [templates/certificates/loop.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/certificates/loop.php)
+ [templates/certificates/preview.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/certificates/preview.php)
+ [templates/certificates/template.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/certificates/template.php)
+ [templates/content-certificate.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/content-certificate.php)
+ [templates/single-certificate.php](https://github.com/gocodebox/lifterlms/blob/trunk/templates/single-certificate.php)
v5.6.0 - 2021-12-07
-------------------
##### New Features
+ Added an option to prevent users (by role) from copying site content and saving local copies of images.
+ Added new site setting to disallow concurrent user sessions for specified user roles.
##### Updates and Enhancements
+ Updates LifterLMS REST to [v1.0.0-beta.21](https://make.lifterlms.com/2021/12/07/lifterlms-rest-api-version-1-0-0-beta-21/).
##### Developer Notes
+ Database migration functions can now be namespaced, eliminating the need to prefix update function names with a version number.
v5.5.0 - 2021-11-05
-------------------
##### New Features
+ Includes the LLMS-CLI beta, a set of WP-CLI commands for LifterLMS and LifterLMS add-ons, as part of the core plugin:
+ To get started, run `wp llms --help` in your terminal or read the [online command documentation](https://developer.lifterlms.com/cli/commands/llms/).
+ Please note that the LLMS-CLI is included as a public beta feature. The command API is in a pre-release state and, as such, is subject to change without warning.
+ If you encounter any issues or wish to provide feedback on the LLMS-CLI please get in touch at [https://github.com/gocodebox/lifterlms-cli](https://github.com/gocodebox/lifterlms-cli).
##### Bug Fixes
+ Fix AJAX post search when using search queries containing quotes.
##### Deprecations
+ The `lifterlms_register_post_type_llms_engagement` is deprecated in favor of `lifterlms_register_post_type_engagement`.
+ The `lifterlms_register_post_type_llms_achievement` is deprecated in favor of `lifterlms_register_post_type_achievement`.
+ The `lifterlms_register_post_type_llms_certificate` is deprecated in favor of `lifterlms_register_post_type_certificate`.
+ The `lifterlms_register_post_type_llms_my_certificate` is deprecated in favor of `lifterlms_register_post_type_my_certificate`.
+ The `lifterlms_register_post_type_llms_email` is deprecated in favor of `lifterlms_register_post_type_email`.
+ The `lifterlms_register_post_type_llms_coupon` is deprecated in favor of `lifterlms_register_post_type_coupon`.
+ The `lifterlms_register_post_type_llms_voucher` is deprecated in favor of `lifterlms_register_post_type_voucher`.
##### Developer Notes
+ The `llms-addons` style asset no longer ships an unminified version.
+ The `llms-admin-add-ons` style asset no longer ships an unminified version and the filename of the distributed file has changed.
+ All the LifterLMS post types are now registered using the static method `LLMS_Post_Types::register_post_type()`.
+ Upgraded woocommerce/action-scheduler to [v3.4.0](https://github.com/woocommerce/action-scheduler/releases/tag/3.4.0).
v5.4.1 - 2021-10-26
-------------------
##### Bug fixes
+ Exclude internal-use-only properties (related to reporting caches and student counts) when exporting or cloning courses. [#1532](https://github.com/gocodebox/lifterlms/issues/1532)
+ Don't sanitize input from user forms until validation has succeeded. [#1829](https://github.com/gocodebox/lifterlms/issues/1829.)
+ Fixed an issue encountered when fields are removed from reusable blocks, causing some user forms from functioning as expected. [#1832](https://github.com/gocodebox/lifterlms/issues/1832)
v5.4.0 - 2021-10-14
-------------------
##### Updates
+ Added logic to prevent the permanent deletion of courses or memberships with active subscriptions.
+ When a subscription attempts to charge a recurring payment against a deleted course or membership the transaction will be cancelled and the order marked as failed.
+ Updates LifterLMS Blocks to [v2.2.1](https://make.lifterlms.com/2021/09/29/lifterlms-blocks-version-2-2-1/).
+ Updates LifterLMS REST to [v1.0.0-beta.20](https://make.lifterlms.com/2021/10/11/lifterlms-rest-api-version-1-0-0-beta-20/).
##### Bug fixes
+ Fixed issue encountered when cloning lessons with attached assignments.
+ Fixed an error encountered when viewing an order for a deleted course or membership on the student dashboard.
##### Templates Updated
+ templates/myaccount/view-order.php
v5.3.3 - 2021-10-05
-------------------
##### Updates
+ Update woocommerce/actions-scheduler to version 3.3.0.
##### Bug fixes
+ Fixed an issue causing the latest earned achievement to not display on the "My Grades" tab in certain scenarios.
+ Fix issue causing a `waiting...` message to display on the JS dev console.
+ Fix improper usage of `apply_filters_deprecated()` encountered when using deprecated theme settings filters in the course builder.
+ Fixed missing text domain, thanks [chetansatasiya](https://github.com/chetansatasiya)!
##### Developer notes
+ Improved the `LLMS.waitFor()` runtime JS dependency loader to output improved debugging information.
v5.3.2 - 2021-09-21
-------------------
##### Updates
+ Updated the SendWP integration account management URL.
##### Bug fixes
+ Fixed issue encountered with TinyMCE editor instances in repeater metabox groups.
+ Fixed issue causing the latest achievement to not display when reviewing grades on the student dashboard.
v5.3.1 - 2021-09-13
-------------------
##### Bug fixes
+ Fixed quote slashing for non-admin roles when editing content in the course builder.
+ The LifterLMS admin icon now uses an encoded SVG to improve admin color scheme compatibility.
+ Fixed an issue with empty admin notices.
##### Dev updates
+ The creation date of `llms_orders` is now determined by `llms_current_time()`.
v5.3.0 - 2021-08-31
-------------------
##### Updates
+ Improved logic used to determine when a limited length subscription has completed its payment schedule.
+ Improved accessibility of various icon buttons on the admin orders view/edit screen.
+ Improved display of quiz attempts containing questions which have been deleted from the database.
+ POT files from included library plugins (like LifterLMS REST) are now excluded from LifterLMS distributions.
##### Development updates
+ Introduced `LLMS_Trait_Singleton` to replace redundant singleton pattern definitions across classes in the codebase.
+ Moved the loading of the autoloader to the main `lifterlms.php` file.
+ Updated the `LLMS_Payment_Gateway` abstract class to utilize `LLMS_Abstract_Options_Data` for accessing gateway options.
+ Audio and video embed methods shared by `LLMS_Course` and `LLMS_Membership` have been relocated to `LLMS_Trait_Audio_Video_Embed`.
+ Sales page methods shared by `LLMS_Course` and `LLMS_Membership` have been relocated to `LLMS_Trait_Sales_Page`.
##### Bug Fixes
+ Fixed a visual issue encountered on the payment confirmation screen on small screens / mobile devices.
+ Fix untranslatable time period strings (day, week, month, and year) found on the admin orders view/edit screen.
+ Fixed an error encountered when attempting to grade a quiz attempt containing deleted questions.
##### Deprecations
+ Removed usage and references to the `LLMS_Order` post meta property `date_billing_end`. To determine if a subscription has ended, use `LLMS_Order::get_remaining_payments()` instead.
+ Removed private method `LLMS_Order::calculate_billing_end_date()`.
+ Deprecated the class property `$_instance` from the following classes, use the public method `instance()` instead:
+ `LLMS_Achievements`
+ `LLMS_Certificates`
+ `LLMS_Emails`
+ `LLMS_Engagements`
+ `LLMS_Events`
+ `LLMS_Grades`
+ `LLMS_Integrations`
+ `LLMS_Notifications`
+ `LLMS_Payment_Gateways`
+ `LLMS_Processors`
+ `LLMS_Sessions`
##### Templates Updated
+ templates/checkout/form-confirm-payment.php
+ templates/admin/reporting/tabs/quizzes/attempt.php
+ templates/quiz/results-attempt-questions-list.php
v5.2.1 - 2021-08-17
-------------------
##### Updates
+ [LifterLMS Helper Version 3.4.1](https://make.lifterlms.com/2021/08/17/lifterlms-helper-version-3-4-1/).
+ Made minor development-related changes to the `LLMS_Order` class.
##### Bug Fixes
+ Fixed an issue encountered when a course or membership sales page redirect is enabled but no URL is saved.
v5.2.0 - 2021-08-10
-------------------
##### Upcoming Payment Reminder Notification
+ A new notification, the "Upcoming Payment Reminder" notification has been added. This notification sends a reminder to students a configurable number of days before a payment is do for a recurring subscription.
+ When upgrading to version 5.2.0, this notification will be automatically *disabled*, visit LifterLMS -> Settings -> Notifications and select the new notification to enable it after upgrading.
+ Props to [@niluzok](https://github.com/niluzok) for doing the initial work required to build this notification!
##### Updates
+ Reworked the database upgrader script to allow for minor upgrades which don't require significant data migration to upgrade silently without requiring user consent to initiate.
+ Improved internal methods used to generate tables in the body of email notifications.
##### Bug Fixes
+ Student registration date is now displayed in the site's timezone in favor of UTC time.
+ Properly pass options `template_path` and `default_path` to the template handler when creating an admin notice using a template.
+ Removed translation (and incorrect text domain) from a logging function encountered when a recurring payment errors as a result of the payment gateway having been deactivated.
##### Deprecations
+ `LLMS_Install::db_updates()` is deprecated, use ``LLMS_DB_Upgrader::enqueue_updates()` instead.
+ `LLMS_Install::update_notice()` is deprecated with no replacement.
+ Template `admin/notices/db-update.php` is deprecated in favor of `includes/admin/views/db-update.php`.
+ Template `admin/notices/db-updating.php` is deprecated with no replacement.
v5.1.3 - 2021-08-04
-------------------
+ Bugfix: Fixed an issue where a white box would be output over the certificate background image.
+ Bugfix: Fixed an issue in the course builder causing lessons to be orphaned from a course when moved into an unsaved section.
+ [LifterLMS Helper Version 3.4.0](https://make.lifterlms.com/2021/08/04/lifterlms-helper-version-3-4-0/)
v5.1.2 - 2021-07-28
-------------------
+ Bugfix: Pass second parameter to the `get_the_excerpt` filter.
+ Fix: Corrected typos in error messages encountered during password reset.
v5.1.1 - 2021-07-26
-------------------
+ Bugfix: Fixed a bug causing malformed character codes to be rendered in forms when installing forms with translated labels.
+ [LifterLMS Helper version 3.3.1](https://make.lifterlms.com/2021/07/26/lifterlms-helper-version-3-3-1/)
v5.1.0 - 2021-07-19
-------------------
##### Updates
+ **Raised the minimum required WordPress core version to 5.8!**
+ Adds WordPress core 5.8 compatibility.
+ Improved user information forms required field validation.
+ Added functionality to ensure that user email and password fields are *always* displayed to logged out users on checkout and registration forms.
+ Added functionality to ensure that user email and password fields are *always* displayed on the account edit form.
+ [LifterLMS Blocks version 2.2.0](https://make.lifterlms.com/2021/07/19/lifterlms-blocks-version-2-2-0/)
##### Bug fixes
+ Fixed an issue preventing certain orphaned quizzes from being deleted.
+ Prevent users from submitting a password change without submitting their current password.
+ Allow logged in users to checkout when no form fields are set to display.
v5.0.2 - 2021-07-08
-------------------
##### LifterLMS Blocks
+ Upgraded to [version 2.1.1](https://make.lifterlms.com/2021/07/08/lifterlms-blocks-version-2-1-1/).
##### Bug Fixes
+ Fixed issue with non-Latin characters in dashboard endpoint URL slugs.
+ Fixed issue preventing address localization when using the [lifterlms_registration] shortcode.
v5.0.1 - 2021-06-28
-------------------
##### Updates
+ Update to [LifterLMS Blocks v2.1.0](https://make.lifterlms.com/2021/06/28/lifterlms-blocks-version-2-1-0/).
+ Added a new filter to allow programmatically alter required field validation results.
##### Bugfixes
+ Fixed an issue causing preventing form layout options from working when passed into shortcodes.
+ Fixed an issue preventing custom radio, select, and dropdown fields from working during checkout.
+ Fixed an accessibility issue encountered during password strength validation.
v5.0.0 - 2021-06-22
-------------------
##### User Information Form Builder
+ Customize all user information collection forms using the block editor for drag and drop and WYSIWYG form building.
+ Customize field labels, placeholders, descriptions and more with an easy point and click interface.
+ Determine if fields are required or optional with a simple toggle switch.
+ Update the form layout with the block editor. Reorder fields, add columns, and more with a simple drag and drop interface.
+ Remove unwanted fields with the click of a button.
##### User Location Information Form Fields
+ During user account creation and updates the user location fields are now locale aware ensuring that the proper terminology is used and only locale-required fields are displayed for the selected locale.
+ The "Country" field has been updated to be automatically populated with a list of countries. View the full list in the file at `languages/countries.php` and the filter `lifterlms_countries` can be used to modify the default list at runtime.
+ The "State" field on user forms has been updated to be automatically populated with a list of states (provinces or regions) for the selected country. This list of states can be found in the file at `languages/states.php` and the filter `lifterlms_states` can be used to modify the default list at runtime.
+ Both "Country" and "State" fields are now searchable dropdowns elements.
+ The lists of countries and states will be automatically updated during future releases based on information provided by [GeoNames](https://www.geonames.org/) APIs.
##### Mergecodes everywhere via new `[llms-user]` shortcode
+ Allows merging most user information field data into any post or page, email, or notification (as well as widgets and more).
##### Updates
+ Email and password confirmation fields may now be made optional.
+ "User Information Options" have been largely removed in favor of determining which fields are displayed via the forms UI
+ The former "User Information Options" settings area has been renamed to "User Privacy Options".
+ Removed email lookup logic since `wp_authenticate()` supports email addresses as `user_login` since WP 4.5.
+ Custom user fields added via filters are now displayed on the admin panel at priority 11 instead of 10.
+ Added shortcode processing in LifterLMS-generated emails.
+ If a symbol cannot be found for the supplied currency code, return the code instead of an empty string.
##### Bug Fixes
+ Changed the filter on return of `LLMS_Person_Handler::get_password_reset_fields()` from `lifterlms_lost_password_fields` to `llms_password_reset_fields`.
+ Fixed duplicate references to the `llms-select2` script.
##### Development changes
+ Added before and after actions hooks for admin tools.
+ The filter `lifterlms_before_user_${action}` is now triggered by `do_action_ref_array()` instead of `do_action()` allowing modification of `$posted_data` and `$fields` via hooks.
+ A number of action and filter hooks have been moved to new locations within the codebase. They will continue to function as expected (with some minor exceptions).
+ Enqueue select2 on account and checkout pages for searchable dropdowns for country & state.
+ Stop loading removed processor "table_to_csv".
##### Library & Vendor Updates
+ Updates LifterLMS Blocks to version 2.0.1.
+ Updates woocommerce/actions-scheduler to version 3.2.1.
+ Load core libraries from new location and load WP Background Processing lib.
+ The vendor script dependency `topModal.js` has been removed.
##### Templates Updated
+ templates/checkout/form-checkout.php
+ templates/checkout/form-confirm-payment.php
+ templates/checkout/form-gateways.php
+ templates/global/form-login.php
+ templates/global/form-registration.php
+ templates/myaccount/form-edit-account.php
+ templates/product/free-enroll-form.php
##### Deprecations
The following have been deprecated and will be removed from LifterLMS in a major update following version 5.0.0.
+ Class Method: `LLMS_Person_Handler::get_available_fields()` is deprecated in favor of `LLMS_Forms::get_form_fields()`.
+ Class Method: `LLMS_Person_Handler::register()` is deprecated, in favor of `llms_register_user()`.
+ Class Method: `LLMS_Person_Handler::sanitize_field()` (private method) is deprecated with no replacement.
+ Class Method: `LLMS_Person_Handler::update()` is deprecated, in favor of `llms_update_user()`.
+ Class Method: `LLMS_Person_Handler::validate_fields()` is deprecated with no replacement.
+ Class Method: `LLMS_Person_Handler::voucher_toggle_script()` is deprecated with no replacement.
+ Filter: `llms_usernames_blacklist` is deprecated, use `llms_usernames_blocklist` instead.
+ Filter: `lifterlms_get_user_custom_fields` is deprecated with no replacement.
+ Function: `llms_get_minimum_password_strength()` is deprecated with no replacement.
+ Option: `lifterlms_registration_generate_username` is deprecated in favor of the new method `LLMS_Forms::are_usernames_enabled()`.
##### Removed Items
+ Private method `LLMS_Processors::includes()` has been removed.
+ Private methods `LLMS_Person_Handler::fill_fields()` and `LLMS_Person_Handler::insert_data()` were removed.
+ Previously deprecated class method `LLMS_Quiz::get_lessons()` has been removed.
+ Previously deprecated class method `LLMS_Controller_Quizzes::take_quiz()` has been removed.
+ Previously deprecated class `LLMS_Processor_Table_To_Csv` has been removed.
v5.0.0-rc.2 - 2021-06-18
------------------------
+ Remove password description merge codes from reusable block schema.
+ Explicitly define required field attributes on reusable block schema.
+ Requires WP 5.7 or later to edit forms & show an upgrade nudge when requirements are not met.
+ Add a link from the (now) legacy account settings area to help experienced users find the new form building area
+ Add a (subtle) custom fields add-on upgrade nudge when viewing the forms list on the admin panel
+ Update LifterLMS Blocks to 2.0.0-rc.2
v5.0.0-rc.1 - 2021-06-15
------------------------
+ Updates Action Scheduler library to version 3.2.0
+ Remove the {min_strength} and {min_length} merge codes from the User Password block description.
+ Don't load removed files during OptimizePress compatibility.
+ Add a 5.0.0 DB upgrade routine and welcome notice
+ Add the LifterLMS Helper as an included library
+ Add WordPress 5.8 compatibility on the Widgets and Customizer screens.
+ Move form location definitions into a schema file
+ Require WordPress 5.7+ to manage forms via the block editor
+ Upgrades LifterLMS Blocks to 2.0.0-rc.1
v5.0.0-beta.2 - 2021-06-01
---------------------------
+ Updates LifterLMS Blocks to 2.0.0-beta.6.
+ (Re-)introduces the user information shortcode as `[llms-user]`.
+ Add Admins status tool to reinstall core forms & reusable blocks.
+ Fixed issue causing data from conditionally disabled fields (like state) from being cleared during form submission
+ Updated form post type labels and added missing labels
+ Removed the previously deprecated class `LLMS_Frontend_Forms` and it's deprecated class methods `reset_password()` and `voucher_check()`.
+ Removed the previously deprecated class `LLMS_Frontend_Password` and it's deprecated class methods: `retrieve_password()`, `check_password()`, and `reset_password()`.
+ Updated country and state localization lists.
v5.0.0-beta.1 - 2021-05-19
---------------------------
+ LifterLMS Blocks 2.0.0-beta.5
+ Added site-wide field name validation
+ Reworked the output of user information fields on the admin panel to share a handler and APIs with frontend fields.
+ Deprecated filter: `lifterlms_get_user_custom_fields` in favor of `llms_admin_profile_fields`
+ Improved previewing of form posts using WP Core block editor UI elements
+ Open Registration form can now always be previewed regardless of the open registration site setting
v5.0.0-alpha.6 - 2021-05-07
---------------------------
+ LifterLMS Blocks 2.0.0-beta.4
+ Fix default reusable password field type from plain text to password
+ Change the default reusable block post titles to reduce confusion when searching for blocks in the editor
v5.0.0-alpha.5 - 2021-05-03
---------------------------
+ Reorganized new files into subdirectories.
+ Added serverside password minimum length validation.
+ Fix duplicate password strength meter output.
+ Fix the user password field type from text to password
+ Fix the phone number field type from text to tel
+ Fix user state select field
+ Don't autoload field values from specified datastore when a "value" is explicitly passed to the field.
+ Only load published reusable blocks on the frontend of the website
+ Improved the UX for editing a users account by automatically "hiding" password and email fields and only requiring them to be submitted when users explicit request an update via the field's "change" toggle button.
v5.0.0-alpha.4 - 2021-04-26
---------------------------
+ Default form templates now use reusable blocks.
+ Improved the user experience surrounding fields with a confirmation field (email address and password).
+ Added the ability to define a field's column width instead of requiring the usage of WP column blocks.
+ Added support for reusable blocks on form posts
+ Upgraded LifterLMS Blocks to 2.0.0-beta.3.
v5.0.0-alpha.3 - 2021-03-23
---------------------------
+ Fixed issue preventing users from editing their email address and password on the dashboard account edit screens.
+ Fixed issues with country names with the article "the" in their name, for example "The Netherlands" instead of "Netherlands The".
+ Upgraded LifterLMS Blocks to version 2.0.0-beta.2.
v5.0.0-alpha.2 - 2021-03-22
---------------------------
##### Updates
+ Updates LifterLMS Blocks to version 2.0.0-beta.1
+ Adds functionality to force usage of the Block Editor for editing LifterLMS forms
+ Updates localization functionality and methods to have more accurate information.
+ Added a function for determining if open registration is enabled.
+ Added a WP Admin Bar link below the "Edit Page" link to enable editing the form (if a form exists on the page).
##### Bug Fixes
+ Fixed an issue encountered when custom HTML fields exist on a form (backwards compatibility for pre 5.x fields API).
v5.0.0-alpha.1 - 2021-01-07
---------------------------
##### User Information Form Builder
+ Customize all user information collection forms using the block editor for drag and drop and WYSIWYG form building.
+ Customize field labels, placeholders, descriptions and more with an easy point and click interface.
+ Determine if fields are required or optional with a simple toggle switch.
+ Update the form layout with the block editor. Reorder fields, add columns, and more with a simple drag and drop interface.
+ Remove unwanted fields with the click of a button.
##### User Location Information Form Fields
+ During user account creation and updates the user location fields are now locale aware ensuring that the proper terminology is used and only locale-required fields are displayed for the selected locale.
+ The "Country" field has been updated to be automatically populated with a list of countries. View the full list in the file at `languages/countries.php` and the filter `lifterlms_countries` can be used to modify the default list at runtime.
+ The "State" field on user forms has been updated to be automatically populated with a list of states (provinces or regions) for the selected country. This list of states can be found in the file at `languages/states.php` and the filter `lifterlms_states` can be used to modify the default list at runtime.
+ Both "Country" and "State" fields are now searchable dropdowns elements.
+ The lists of countries and states will be automatically updated during future releases based on information provided by [GeoNames](https://www.geonames.org/) APIs.
##### Mergecodes everywhere via new `[user]` shortcode
+ TODO.
##### Updates
+ Email and password confirmation fields may now be made optional.
+ "User Information Options" have been largely removed in favor of determining which fields are displayed via the forms UI
+ The former "User Information Options" settings area has been renamed to "User Privacy Options".
##### Bug Fixes
+ Changed the filter on return of `LLMS_Person_Handler::get_password_reset_fields()` from `lifterlms_lost_password_fields` to `llms_password_reset_fields`.
##### Development changes
+ The filter `lifterlms_before_user_${action}` is now triggered by `do_action_ref_array()` instead of `do_action()` allowing modification of `$posted_data` and `$fields` via hooks.
+ A number of action and filter hooks have been moved to new locations within the codebase. They will continue to function as expected (with some minor exceptions).
+ Enqueue select2 on account and checkout pages for searchable dropdowns for country & state.
##### Library & Vendor Updates
+ Load core libraries from new location and load WP Background Processing lib.
+ The vendor script dependency `topModal.js` has been removed.
##### Templates Updated
+ templates/global/form-login.php
+ templates/global/form-registration.php
+ templates/product/free-enroll-form.php
##### Deprecations
The following have been deprecated and will be removed from LifterLMS in a major update following version 5.0.0.
+ Class Method: `LLMS_Person_Handler::get_available_fields()` is deprecated in favor of `LLMS_Forms::get_form_fields()`.
+ Class Method: `LLMS_Person_Handler::register()` is deprecated, in favor of `llms_register_user()`.
+ Class Method: `LLMS_Person_Handler::sanitize_field()` (private method) is deprecated with no replacement.
+ Class Method: `LLMS_Person_Handler::update()` is deprecated, in favor of `llms_update_user()`.
+ Class Method: `LLMS_Person_Handler::validate_fields()` is deprecated with no replacement.
+ Class Method: `LLMS_Person_Handler::voucher_toggle_script()` is deprecated with no replacement.
+ Filter: `llms_usernames_blacklist` is deprecated, use `llms_usernames_blocklist` instead.
+ Function: `llms_get_minimum_password_strength()` is deprecated with no replacement.
+ Option: `lifterlms_registration_generate_username` is deprecated in favor of the new method `LLMS_Forms::are_usernames_enabled()`.
##### Removed Items
+ Private method `LLMS_Processors::includes()` has been removed.
+ Private methods `LLMS_Person_Handler::fill_fields()` and `LLMS_Person_Handler::insert_data()` were removed.
+ Previously deprecated class method `LLMS_Quiz::get_lessons()` has been removed.
+ Previously deprecated class method `LLMS_Controller_Quizzes::take_quiz()` has been removed.
+ Previously deprecated class `LLMS_Processor_Table_To_Csv` has been removed.
v4.21.3 - 2021-05-31
--------------------
##### Updates
+ Increase 3rd party support for WP core hook `lostpassword_post` hook.
##### Bug fixes
+ Props to [Hemant Patidar](https://www.linkedin.com/in/hemantsolo/) for discovering an issue preventing rate limiting in various security plugins from working on the LifterLMS password recovery form.
+ Fixed an issue encountered when updating LifterLMS premium add-ons via the LifterLMS Helper encountered when API errors are occur.
+ Updated the failure error code from 'activation' to 'deactivation' in the `LLMS_Add_On` class.
+ Updated the API connection error message returned when using the `LLMS_Abstract_API_Handler` class.
##### Deprecations
+ Class `LLMS_Frontend_Password` is deprecated, see deprecated methods and their replacements below:
+ `LLMS_Frontend_Password::retrieve_password()` is deprecated in favor of `LLMS_Controller_Account::lost_password()`.
+ `LLMS_Frontend_Password::check_password_reset_key()` is deprecated in favor of `check_password_reset_key()`.
+ `LLMS_Frontend_Password::reset_password()` is deprecated in favor of `reset_password()`.
v4.21.2 - 2021-05-17
--------------------
##### Security Update
This releases fixes a security issue affecting LifterLMS versions 4.21.1 and earlier:
+ Thank you to [Amirmohammad vakili](https://www.linkedin.com/in/amirmuhammad-vakili-65a7a11b3/) for reporting an insecure direct object reference issue.
##### Updates
+ Added the `view_grades` capability which is used to determine whether or not a user has the ability to view another user's grades on the website's frontend.
##### Bug fixes
+ Fixed an issue causing PHP errors when attempting to access a quiz attempt that doesn't exist.
+ Fixed a localization issue encountered when entering transaction amounts on the admin panel.
v4.21.1 - 2021-04-29
--------------------
##### Security Update
This releases fixes two security issues affecting LifterLMS versions 4.21.0 and earlier:
+ Thank you to [Amirmohammad vakili](https://www.linkedin.com/in/amirmuhammad-vakili-65a7a11b3/) for reporting a way to store XSS.
+ Thank you to Ashish Jha from [Bluefire Redteam](https://www.bluefire-redteam.com/) for reporting a reflected XSS issue on checkout screens.
v4.21.0 - 2021-04-19
--------------------
##### Updates
+ Certificate exports will now automatically include (most) externally hosted images and stylesheets.
+ Opt-in forward compatibility changes have been made to the `LLMS_Abstract_Options_Data` class.
##### Bugfixes
+ Fixed an issue causing one-time payment orders from being included in totals on some reporting screens.
+ Fixed an issue causing student enrollment counts to be incorrect under some circumstances.
+ Fixed issues resulting in unnecessary duplicated instances of course background data processing.
+ Fixed an error encountered when a course is deleted prior to its background data being processed.
+ Fixed an escaping issue causing passwords with a backslash character from being usable following a password reset.
v4.20.0 - 2021-03-16
--------------------
##### Bugfixes
+ Fixed an issue causing a fatal error when attempting to access reports for deleted students. Thanks Thanks [@pondermatic](https://github.com/pondermatic)!
+ Fixed an issue encountered on the builder causing the last section to be returned when retrieving the previous section for the first section.
v4.19.0 - 2021-03-11
--------------------
##### Supported Version Requirement Updates
+ **The minimum supported PHP version has been raised to PHP 7.3. Please upgrade to a [supported PHP version](https://www.php.net/supported-versions).**
+ **The minimum supported WordPress core version has been raised to version 5.3.**
##### Bug fixes
+ Fixed an issue causing TinyMCE editor instances to be unusable within metaboxes when using the block editor.
v4.18.0 - 2021-03-04
--------------------
**This is the last release of LifterLMS that will declare support for PHP 7.2. PHP 7.2 reached its official [end of life](https://www.php.net/eol.php) on November 30, 2020. With the next release of LifterLMS the minimum supported PHP version will be raised to 7.3. If you're currently using PHP 7.2 please contact your host and request an upgrade to a [supported PHP version](https://www.php.net/supported-versions) as soon as possible!**
##### Updates
+ Tested up to WordPress core version 5.7
+ Updated several occurrences of `json_encode()` with preferred `wp_json_encode()`.
##### Bug fixes
+ Added a tie-breaker when there are multiple enrollment statuses with the same date & time. Thanks [@pondermatic](https://github.com/pondermatic)!
+ On admin order pages and tables don't print links for deleted students.
+ Fixed an issue on admin order pages when viewing an order for a deleted student.
v4.17.0 - 2021-02-22
--------------------
##### Updates
+ The post type feature "llms-sales-page" has been added to course and membership post types, signifying they support custom sales pages.
##### Bug fixes
+ Fixed compatibility issues with Yoast SEO 15.8.
+ Fixed duplicate action hook in `content-no-access-after.php` template.
+ Added early returns to several templates to prevent undefined variables errors.
+ Fixed an undefined variable encountered in course builder JS debug logging.
##### Templates Updated
+ content-no-access-after.php
+ quiz/meta-information.php
+ quiz/results.php
+ quiz/start-button.php
v4.16.0 - 2021-02-18
--------------------
##### Updates
+ Added preview management to the student dashboard to allow previewing of the dashboard as a site visitor.
+ Added a new filter to allow customization of courses output by the [lifterlms_courses] shortcode. Thanks [@reedhewitt](https://github.com/reedhewitt)!
+ Added compatibility code to reduce plugin conflicts encountered in the course builder. Resolves a conflict encountered when building quizzes with Yoast SEO installed.
##### Bug fixes
+ Fixed undefined variable error encountered when creating custom notification types. Thanks [@pondermatic](https://github.com/pondermatic)!
+ Fixed incorrect variables passed to `sprintf()` in logging functions used by the course data background processor. Thanks [@pondermatic](https://github.com/pondermatic)!
v4.15.0 - 2021-02-09
--------------------
##### Updates
+ Database migration: remove any "orphaned" access plans which were not properly cleaned up during deletion of parent course or membership.
+ Improved performance of membership post association query methods.
##### Bug fixes
+ Access plans will now be automatically deleted when their parent course or membership is deleted.
+ Fix an issue with donut charts/graphs on RTL sites.
+ Fix an issue causing unpublished (draft/private) courses from being returned during queries for membership post associations.
##### LifterLMS REST 1.0.0-beta.15
###### Updates
+ Added Access Plan resource and endpoint.
+ Provide a more significant error message when trying to delete an item without permissions.
+ Use `WP_Http` constants in favor of integers when referencing HTTP status codes.
###### Bug fixes
+ Fixes localization issues where a singular name was used in favor of the expected plural form.
+ Fixed issues where an error object was not properly returned when expected
+ Fixed call to undefined function `llms_bad_request_error()`, must be `llms_rest_bad_request_error()`.
+ Fixed access plans resource link.
+ Fixed wrong trigger retrieved when multiple trigger were present for the same user/post pair on Student Enrollment resources.
v4.14.0 - 2021-02-04
--------------------
##### Updates
+ Added a user preference option allowing users to opt-out of the course builder's autosave functionality. [More information](https://lifterlms.com/docs/using-course-builder/#manual-saving).
+ 5-star review request displayed at 30 enrollments instead of 50.
##### Bug fixes
+ Fixed an issue encountered when using shortcodes in the description of an access plan.
+ Fixed an issue encountered when editing auto-draft courses on the course builder.
##### Deprecations
+ `LLMS_Controller_Quizzes::take_quiz()` is deprecated in favor of `LLMS_AJAX_Handler::quiz_start()`.
+ Method `LLMS_Quiz::get_lessons()` is deprecated with no replacement.
v4.13.0 - 2021-01-26
--------------------
##### Updates
+ **The minimum supported WordPress core version has been raised to 5.2.** For more information, please review the [LifterLMS Minimum System Requirements](https://lifterlms.com/docs/minimum-system-requirements-lifterlms/).
+ When cloning courses and lessons the cloned post will be created as a draft.
+ When cloning courses the suffix "(Clone)" will be appended to the title of the course to unify cloning behavior with lessons.
+ Added information about LifterLMS specific constant values to the LifterLMS system report.
+ Added a new constant `LLMS_IS_SITE_CLONE` which can be used to force the site's clone status.
##### Bug fixes
+ Reverts site clone detection check changes implemented in 4.12.0 to restore pre 4.12.0 functionality which only runs checks on the admin panel for logged in users with the `manage_lifterlms` capability.
+ Restore reliance on `mb_convert_encoding()` when passing html strings into `DOMDocument` and use the alternate method introduced in version 4.8.0 as a fallback.
+ Fixed an issue encountered when unexpected or malformed data is stored in the LifterLMS admin notices option.
v4.12.0 - 2021-01-20
--------------------
##### Updates
+ Automatic site clone detection checks have been adjusted to always run in favor of only running on the admin panel.
+ LifterLMS Site Features (like recurring payment status) can now be configured via constant values.
+ Added `llms_load_admin_tools` action to allow 3rd parties to easily hook into our admin tools system.
+ Made numerous performance improvements on the course data background processor.
+ Course data background processing will now be automatically throttled for courses with 500 students or more as opposed to the old value of 2,500 or more.
##### Bug fixes
+ Fixed an incorrect HTML `for` attribute and added an `id` to the related input element on the student dashboard voucher redemption endpoint.
+ Fixed a pagination error encountered when using course or membership list shortcodes on the static front page.
+ Make sure `is_lifterlms()` exists before calling it in navigation menu-related classes.
##### Deprecations
+ `LLMS_Admin_Notices_Core::check_staging()` is deprecated in favor of `LLMS_Staging::notice()`.
+ Unused property `LLMS_Course::$sections` is replaced by `LLMS_Course::get_sections()`.
+ Unused property `LLMS_Course::$sku` is deprecated with no replacement.
+ `LLMS_Frontend_Forms` is deprecated, functionality is available via `LLMS_Controller_Account`.
+ `LLMS_Frontend_Forms::reset_password()` is deprecated in favor of `LLMS_Controller_Account::reset_password()`.
##### Templates Updated
+ templates/myaccount/form-redeem-voucher.php
v4.11.0 - 2021-01-07
--------------------
##### Updates
+ Adds the ability to use the Instructors blocks on the membership post type. Thanks [@alaa-alshamy](https://github.com/alaa-alshamy)!
+ Updated LifterLMS Blocks to [Version 1.11.1](https://make.lifterlms.com/2020/12/29/lifterlms-blocks-version-1-11-1/).
##### Bug fixes
+ Fixed a PHP Notice encountered when trying to retrieve next lesson from an empty section.
##### Templates updated
+ templates/course/author.php
v4.10.2 - 2021-01-04
--------------------
##### Updates
+ Improved performance of `llms_get_enrolled_students()`.
+ Refactored lesson navigation query functions.
##### Bug fixes
+ Fixed sorting error when sorting student reports by name.
v4.10.1 - 2020-12-10
--------------------
##### Bug fixes
+ Fixed visual issues encountered on the admin Add-Ons screen.
+ Use `hr.wp-header-end` in favor of a second (hidden) to "catch" admin notices on the Add-Ons screen.
+ Replace incorrect usage of invalid ID `llms_shop` with `courses` during catalog template loader checks.
+ Function `llms_get_post()` will now only allow instantiation of LifterLMS classes.
+ Remove unneeded require autoloaded file `includes/class.llms.quiz.data.php`.
v4.10.0 - 2020-12-01
--------------------
##### Updates
+ Adds native theme support for the WordPress default theme Twenty Twenty-One.
+ Improved the `llms_archive_description()` function and related filter.
##### Bug fixes
+ Fix issue encountered when using multiple role plugins to add the Instructor role to an Administrator user account. Thanks [@daniel-shuy](https://github.com/daniel-shuy)!
+ Fixed an issue encountered when using non-latin characters in a course post URL slug. Thanks [@alaa-alshamy](https://github.com/alaa-alshamy)!
##### Templates Updated
+ templates/loop/pagination.php
v4.9.0 - 2020-11-24
-------------------
+ Tested up to WordPress core 5.6 (RC.1).
+ Raised the minimum required WordPress core version to 5.1.
+ Add new localization utilities for developers.
+ Fixed various issues found on PHP 8.
+ Added script localization for block editor scripts.
+ Updated LifterLMS Rest to [Version 1.0.0-beta.17](https://make.lifterlms.com/2020/11/24/lifterlms-rest-api-version-1-0-0-beta-17/).
+ Updated LifterLMS Blocks to [Version 1.10.0](https://make.lifterlms.com/2020/11/24/lifterlms-blocks-version-1-10-0/).
v4.8.0 - 2020-11-16
-------------------
##### Updates
+ Added additional course imports and templates at the end of the setup wizard
+ Added a cloud importer enabling 1-click importing of courses and course templates via the importer at LifterLMS -> Import
+ Added strict comparisons in several places.
+ Course "extra" data is only added to course arrays during exports to improve performance on the course builder.
+ Improved template override loading performance on sites with no child theme.
##### Bug fixes
+ Fixed issues related to reliance on methods provided by the `mb_string` PHP module.
##### Deprecations
+ `LLMS_Admin_Setup_Wizard::generator_course_status()` is deprecated with no replacement.
+ `LLMS_Admin_Setup_Wizard::watch_course_generation()` is deprecated with no replacement.
v4.7.1 - 2020-11-05
-------------------
##### Bug fixes
+ During import generation set the post excerpt during the initial post insert instead of during metadata updates after creation.
##### LifterLMS REST API 1.0.0-beta.16
+ Improved performance of various database queries.
v4.7.0 - 2020-11-02
-------------------
##### Updates
+ Major refactor of the `LLMS_Generator` class.
+ Course export structure improved to include images and reusable blocks found in post content.
+ When importing courses images will be automatically sideloaded into the media library as new attachment posts
+ When importing courses reusable blocks will be imported
+ Improved the success message displayed following a course import
+ The class `LLMS_Admin_Reporting` is now always loaded on the admin panel.
+ Performance improvements have been made to the `LLMS_Events_Query` to support using the `no_found_rows` query argument.
+ When an order's billing plan "completes", a new meta property will be added to the order, `plan_ended`, which can be used to query orders with completed plans.
+ Made improvements to the admin payment rescheduler tool to have more accurate reporting information.
##### Bug fixes
+ Replaced an instance of the LifterLMS (old) 1.0 rocket logo with the current rocket logo. Thanks [@imknight](https://github.com/imknight)!
+ Ensure builder `switch-number` fields are set with the `number` type attribute. Thanks [@imknight](https://github.com/imknight)!
+ Don't display a "View Post" link when updating post types that aren't publicly queryable. Thanks [@imknight](https://github.com/imknight)!
+ Fixed the incorrect output of an achievement's title in a popover notification when using the {{ACHIEVEMENT_TITLE}} merge code. Thanks [@CadenG150](https://github.com/@CadenG150)!
+ Fixed an error encountered when plugins utilize the `WP_Users_List_Table` class outside of the `users.php` screen.
##### Deprecations
+ `LLMS_Admin_Import::localize_stat()` is deprecated with no replacement.
+ `LLMS_Admin_Users_Table::load_dependencies()` is deprecated with no replacement. The included class, `LLMS_Admin_Reporting` is now always loaded.
+ `LLMS_Generator::add_custom_values()` is deprecated in favor of `LLMS_Generator_Courses::add_custom_values`.
+ `LLMS_Generator::get_author_id_from_raw()` is deprecated in favor of `LLMS_Generator_Courses::get_author_id_from_raw()`.
+ `LLMS_Generator::get_default_post_status()` is deprecated in favor of `LLMS_Generator_Courses::get_default_post_status()`.
+ `LLMS_Generator::get_generated_posts()` is deprecated in favor of `LLMS_Generator::get_generated_content()`.
+ `LLMS_Generator::format_date()` is deprecated in favor of `LLMS_Generator_Courses::format_date()`.
+ `LLMS_Generator::increment()` is deprecated with no replacement.
v4.6.0 - 2020-10-19
-------------------
+ Added an admin tool to help automatically identify and schedule missed recurring payments
+ Use `llms_deprecated_function()` in favor of `llms_log()`.
+ Removed logging and use `apply_filters_deprecated()` in favor of `apply_filters()`.
v4.5.1 - 2020-10-14
-------------------
##### Updates
+ Added logic in `LLMS_Database_Query` to reduce unnecessary DB reads when total results are not required.
##### Bug fixes
+ Removed the course "Excerpt" area in favor of utilization of the course sales page content.
+ Show sales reporting currency symbol based on LifterLMS site options in favor of the browser's locale settings.
+ Fixed an issue causing achievement-related JS DOM events to be bound unnecessarily. Thanks to [@imknight](https://github.com/imknight)!
+ Fixed an issue causing site administrator capabilities to be removed during LifterLMS data removal.
+ Fixed an issue causing an instructors course post count to display 0 on the admin panel courses post table. Thanks to [nhandl3](https://github.com/nhandl3)!
+ Only display the admin bar "View Manager" to users who can bypass content restrictions.
+ Updated jQuery code to stop using deprecated events and methods in preparation for jQuery upgrades in the WordPress core.
+ Fixed PHP notice encountered on the admin panel when using Yoast SEO.
v4.5.0 - 2020-10-06
-------------------
##### Updates
+ Students can now choose to make their certificates publicly accessible. Huge thanks to [@alaa-alshamy](https://github.com/alaa-alshamy) for contributing this awesome new feature!
+ When accessing a certificate that does not have sharing enabled, a 404 will be served in favor of an error message.
+ Admin payment gateway notices will no longer redisplay a week after being dismissed.
+ Log files will be automatically split when a file is 5MB or larger, ensuring that log files never grow too large.
+ During student registration, `wp_signon()` is used to login the newly created user.
+ Improved slow background process database queries run during the automatic "closing" of idle user sessions.
##### Bug fixes
+ `LLMS_User_Certificate::get_related_post_id()` and `LLMS_User_Certificate::get_user_id()` will now always return an integer.
+ Fixes issues related to account sign on/out and session start/end events being recorded incorrectly.
##### Deprecations
+ `llms_set_person_auth_cookie()` is deprecated in favor of WP core methods such as `wp_signon()`, `wp_set_current_user()`, and/or `wp_set_auth_cookie()`.
v4.4.4 - 2020-09-21
-------------------
##### Bug fixes
+ Don't pass unsupported parameter `$use_cache` to the `calculate_grade()` method, thanks [@pondermatic](https://github.com/pondermatic)!
+ Add an HTML title attribute to the admin setup wizard page.
+ Fix issue causing notices to be logged during quiz attempt deletion on the admin panel.
##### Deprecations
+ Method `LLMS_Admin_Setup_Wizard::scripts()` & `LLMS_Admin_Setup_Wizard::output_step_html()` are deprecated with no replacements.
##### LifterLMS REST API version 1.0.0-beta.15
+ Bugfix: Created lessons will now have the derivative `course_id` property set according to the ID of the lesson's parent section.
+ Bugfix: The `course_id` property of lessons is now properly marked as read-only.
v4.4.3 - 2020-09-16
-------------------
+ Bugfix: Fix engagement email duplicate check issue.
+ Bugfix: Fix transposition issue found in engagement email dupcheck debug log message.
v4.4.2 - 2020-09-08
-------------------
+ Bugfix: Fix lesson navigation regression introduced in 4.4.0.
v4.4.1 - 2020-09-04
-------------------
+ Bugfix: Delayed engagement emails will not be sent to students who's enrollment is not active in the related course or membership which triggered the email.
+ Bugfix: Fixed regression introduced in 4.4.0 preventing the `certificates.css` stylesheet from loading on certificate screens.
+ Update: Engagement email related logs will be logged to a separate logfile, `engagement-emails` in favor of the main `llms` log.
v4.4.0 - 2020-09-02
-------------------
##### Updates
+ Improved LifterLMS static asset registration, queuing, definitions, and management.
+ Added strict comparators in various areas of the codebase.
##### Changes to deprecated function logs and warnings
+ The `llms_deprecated_function()` method now uses `_deprecated_function()` (from the WP core) under the hood.
+ LifterLMS deprecation warnings are logged to the WP core `debug.log` file in favor of the LifterLMS log file.
+ LifterLMS deprecation warnings will now trigger a `E_USER_DEPRECATED` error when `WP_DEBUG` is enabled.
##### Bugfixes
+ Fixed a lesson navigation issue encountered when sections contain unpublished lessons.
+ Fixed an undefined variable notice encountered on the student dashboard.
+ Fixed an issue encountered when the `wp_login_url()` function returns an empty string.
+ Fixed a double slash found in an asset URI.
##### Deprecations
+ `LLMS_Frontend_Assets::is_inline_script_enqueued()` is deprecated in favor of `LLMS_Frontend_Assets::is_inline_enqueued()`.
+ `LLMS_Ajax::register_script()` is deprecated with no replacement.
+ `LLMS_Ajax::get_ajax_data()` is deprecated with no replacement.
+ Javascript AJAX nonce variable is moved from `wp_ajax_data.nonce` to `window.llms.ajax-nonce`.
##### Templates Updated
+ templates/checkout/form-gateways.php
+ templates/course/lesson-preview.php
+ templates/course/syllabus.php
v4.3.3 - 2020-08-17
-------------------
+ Fixed an issue causing legends of reporting charts to be truncated and only readable after a mouse hover.
+ Fixed an issue caused by passing `null` values to `wp_insert_post()`.
+ Fixed a javascript error encountered on LifterLMS settings screens.
v4.3.2 - 2020-08-10
-------------------
+ WP 5.5 compatibility: Automatically deregister "protected" post types from wp-sitemap.xml.
v4.3.1 - 2020-08-06
-------------------
+ When resetting tracking data cookies, set a "secure" cookie where possible.
+ Catch an unhandled error encountered when generating certificate exports.
+ When an error is encountered during certificate export generation, display an error notice instead of a general notice.
v4.3.0 - 2020-07-28
-------------------
##### Security Fix
+ Fixed an XSS issue on account edit and registration forms. Thanks to [Morningstar](https://twitter.com/0xMstar) for reporting this issue!
##### Bug fixes
+ Fixed an error encountered during customizer live theme preview encountered when Twenty-twenty is the current theme.
+ The `$type` property of the `LLMS_Abstract_Database_Store` is now set to a default placeholder value (`_db_record_`) in favor of an empty string.
+ Set the `$type` property of the `LLMS_Event` class to `event`.
+ Set the `$type` property of the `LLMS_Quiz_Attempt` class to `quiz_attempt`.
+ Set the `$type` property of the `LLMS_User_Post_Meta` class to `user_postmeta`.
##### Updates
+ Added a filter `llms_form_field_args` to allow extending form fields prior to HTML rendering.
##### Deprecations
The following filter hooks have been deprecated. These hooks were being called as the result of a bug (noted above) and should no longer be used. They will be removed in the next *major* version of LifterLMS.
+ `llms__created` has been deprecated, use `llms_{$type}_created` where `{$type}` is the database record type defined by the class property.
+ `llms__deleted` has been deprecated, use `llms_{$type}_deleted` where `{$type}` is the database record type defined by the class property.
+ `llms__updated` has been deprecated, use `llms_{$type}_updated` where `{$type}` is the database record type defined by the class property.
v4.2.0 - 2020-07-21
-------------------
##### Updates
+ Admins can now preview the checkout screen as visitors or students using the "View As" function from the WP Admin bar
+ Javascript cookies now set cookies with `sameSite` set to `strict` as recommended by Firefox/Mozilla.
+ Added filters to allow 3rd parties to use LifterLMS completion tracking APIs to "complete" external or non-LMS content.
+ Added "deep" orphan checks when checking the relationship between a quiz and a lesson.
+ Normalized the return structure in `LLMS_Post_Instructors::get_instructors()` when no instructor set, thanks [@nicolas-jaussaud](https://github.com/nicolas-jaussaud)!
+ Update LifterLMS rocket icon used in the WP Admin Bar in the "View As" area.
##### Bug fixes
+ When deleting a quiz attempt the related lesson will now be automatically marked as "Incomplete" when appropriate.
+ `LLMS_Abstract_User_Data::get_id()` now always returns an integer.
+ Fixed a 404 error resulting from settings tooltips referencing a missing icon asset.
+ Added logic to set the order status to 'cancelled' when an enrollment linked to an order is deleted.
v4.1.0 - 2020-07-06
-------------------
##### LifterLMS REST 1.0.0-beta.14
+ **Breaking**: `LLMS_REST_Controller::prepare_links()` now requires a second parameter, the `WP_REST_Request` for the current request. Any classes extending and overwriting this method must adjust their method signature to accommodate this change.
+ Bugfix: Fixed issue causing response objects to unintentionally include keys of remapped fields. This error occurs only when extending core controllers and attempting to exclude core fields.
v4.0.0 - 2020-06-25
-------------------
This is a *major* release. Many backwards incompatible changes have been made that may affect your site if you have custom code which rely on previously deprecated functions or methods. If you're not sure about your custom code, test the upgrade in a [staging site](https://lifterlms.com/docs/staging/).
##### Bug Fixes
+ Fixed an issue encountered during quiz grading.
+ Add RTL language support for popover interfaces found throughout the course builder.
+ Fixed issue encountered in MySQL 8.0 when using the bbPress integration.
##### LifterLMS REST API 1.0.0-beta.13
+ Bugfix: Fixed error response messages on the instructors endpoint.
+ Bugfix: Fixed student progress deletion endpoint issues preventing progress from being fully removed.
##### Action Scheduler Library
Switches from prospress/action-scheduler to woocommerce/action-scheduler. The repository has been moved but it's the same library & upgrades to latest version (3.1.6).
While this is a semantically major upgrade of the library there are no backwards incompatible changes to the public API.
There have been several deprecated functions/classes. The LifterLMS core does not directly use any of these deprecated functions but 3rd parties might and should review the changelog of the library to see if they are affected by any deprecations: https://github.com/woocommerce/action-scheduler/releases.
##### Deprecations
+ Function `LLMS()` is deprecated in favor of `llms()`.
##### Templates Modified
+ templates/global/form-login.php
+ templates/global/form-registration.php
##### Miscellaneous Breaking Changes
**WP Session Manager Library**
Removes the bundled WP Session Manager plugin dependency, all public methods included with this plugin have been removed without direct replacements.
**Removed JS dependencies**
Removes bundled JS bootstrap 3 dependencies: "collapse" and "transition"
**Removed CSS Classes**
Removes classnames from student dashboard login and registration form wrapper elements which conflict with bootstrap causing visual issues.
These classes are not used by the LifterLMS core or add-ons and are a legacy class that hasn't been removed for fear of creating backwards compatibility issues with any custom css, 3rd party themes, etc...
+ templates/global/form-login.php: Removes `col-1` class from the `div.llms-person-login-form-wrapper` element.
+ templates/global/form-registration.php: : Removes `col-2` class from the `div.llms-new-person-form-wrapper` element.
**Removed SVG assets and functionality**
+ LifterLMS no longer utilizes SVGs powered by the `LLMS_Svg` class. The class has been deprecated and removed (see below).
+ The `assets/svg` directory (and all SVG assets contained within) has been removed.
+ The constant `LLMS_SVG_DIR` has been removed.
##### Previously deprecated classes (and files) that have been removed
+ `LLMS_Admin_Analytics`: `includes/admin/class.llms.admin.analytics.php`
+ `LLMS_Analytics`: `includes/class.llms.analytics.php`
+ `LLMS_Analytics_Courses`: `includes/admin/analytics/class.llms.analytics.courses.php`
+ `LLMS_Analytics_Memberships`: `includes/admin/analytics/class.llms.analytics.memberships.php`
+ `LLMS_Analytics_Page`: `includes/admin/analytics/class.llms.analytics.page.php`
+ `LLMS_Analytics_Sales`: `includes/admin/analytics/class.llms.analytics.sales.php`
+ `LLMS_Course_Basic`: `includes/class.llms.course.basic.php`
+ `LLMS_Course_Handler`: `includes/class.llms.course.handler.php`
+ `LLMS_Course_Factory`: `includes/class.llms.course.factory.php`
+ `LLMS_Lesson_Basic`: `includes/class.llms.lesson.basic.php`
+ `LLMS_Meta_Box_Expiration`: `includes/admin/post-types/meta-boxes/class.llms.meta.box.expiration.php`
+ `LLMS_Meta_Box_Video`: `includes/admin/post-types/meta-boxes/class.llms.meta.box.video.php`
+ `LLMS_Number`: `includes/class.llms.number.php`
+ `LLMS_Person`: `includes/class.llms.person.php`
+ `LLMS_Quiz_Legacy`: `includes/class.llms.quiz.legacy.php`
+ `LLMS_Svg`: `includes/class.llms.svg.php`
+ `LLMS_Table_Questions`: `includes/admin/reporting/tables/llms.table.questions.php`
+ `LLMS\Users\User`: `includes/Users/User.php`
##### Previously deprecated class properties that have been removed
+ `LifterLMS->person` (generally accessed via `LLMS()->person`).
+ `LLMS_Analytics_Widget->date_end`
+ `LLMS_Analytics_Widget->date_start`
+ `LLMS_Analytics_Widget->output`
+ `LLMS_Certificate->enabled`
+ `LLMS_Course_Data->$course`
+ `LLMS_Course_Data->$course_id`
##### Previously deprecated class methods that have been removed:
+ `LLMS_Admin_Table::queue_export()`
+ `LLMS_AJAX::get_achievements()`
+ `LLMS_AJAX::get_all_posts()`
+ `LLMS_AJAX::get_associated_lessons()`
+ `LLMS_AJAX::get_certificates()`
+ `LLMS_AJAX::get_courses()`
+ `LLMS_AJAX::get_course_tracks()`
+ `LLMS_AJAX::get_emails()`
+ `LLMS_AJAX::get_enrolled_students()`
+ `LLMS_AJAX::get_enrolled_students_ids()`
+ `LLMS_AJAX::get_lesson()`
+ `LLMS_AJAX::get_lessons()`
+ `LLMS_AJAX::get_lessons_alt()`
+ `LLMS_AJAX::get_memberships()`
+ `LLMS_AJAX::get_question()`
+ `LLMS_AJAX::get_sections()`
+ `LLMS_AJAX::get_sections_alt()`
+ `LLMS_AJAX::get_students()`
+ `LLMS_AJAX::update_syllabus()`
+ `LLMS_Course::get_children_sections()`
+ `LLMS_Course::get_children_lessons()`
+ `LLMS_Course::get_author()`
+ `LLMS_Course::get_author_id()`
+ `LLMS_Course::get_author_name()`
+ `LLMS_Course::get_sku()`
+ `LLMS_Course::get_id()`
+ `LLMS_Course::get_title()`
+ `LLMS_Course::get_permalink()`
+ `LLMS_Course::get_user_postmeta_data()`
+ `LLMS_Course::get_user_postmetas_by_key()`
+ `LLMS_Course::get_checkout_url()`
+ `LLMS_Course::get_start_date()`
+ `LLMS_Course::get_end_date()`
+ `LLMS_Course::get_next_uncompleted_lesson()`
+ `LLMS_Course::get_lesson_ids()`
+ `LLMS_Course::get_syllabus_sections()`
+ `LLMS_Course::get_short_description()`
+ `LLMS_Course::get_syllabus()`
+ `LLMS_Course::get_user_enroll_date()`
+ `LLMS_Course::get_user_post_data()`
+ `LLMS_Course::check_enrollment()`
+ `LLMS_Course::is_user_enrolled()`
+ `LLMS_Course::get_student_progress()`
+ `LLMS_Course::get_membership_link()`
+ `LLMS_Lesson::get_assigned_quiz()`
+ `LLMS_Lesson::get_drip_days()`
+ `LLMS_Lesson::mark_complete()`
+ `LLMS_PlayNice::divi_fb_wc_product_tabs_after()`
+ `LLMS_PlayNice::divi_fb_wc_product_tabs_before()`
+ `LLMS_PlayNice::wc_is_account_page()`
+ `LLMS_Post_Instructors::get_defaults()`
+ `LLMS_Query::set_dashboard_pagination()`
+ `LLMS_Query::add_query_vars()`
+ `LLMS_Question::get_correct_option()`
+ `LLMS_Question::get_correct_option_key()`
+ `LLMS_Question::get_options()`
+ `LLMS_Quiz::get_assoc_lesson()`
+ `LLMS_Quiz::get_passing_percent()`
+ `LLMS_Quiz::get_remaining_attempts_by_user()`
+ `LLMS_Quiz::get_time_limit()`
+ `LLMS_Quiz::get_total_allowed_attempts()`
+ `LLMS_Quiz::get_total_attempts_by_user()`
+ `LLMS_Quiz_Attempt::get_status()`
+ `LLMS_Shortcode_My_Account::lost_password()`
+ `LLMS_Section::count_children_lessons()`
+ `LLMS_Section::delete()`
+ `LLMS_Section::get_children_lessons()`
+ `LLMS_Section::remove_all_child_lessons()`
+ `LLMS_Section::remove_child_lesson()`
+ `LLMS_Section::set_order()`
+ `LLMS_Section::set_title()`
+ `LLMS_Section::update()`
+ `LLMS_Session::init()`
+ `LLMS_Session::maybe_start_session()`
+ `LLMS_Session::set_expiration_variant_time()`
+ `LLMS_Session::set_expiration_time()`
+ `LLMS_Session::use_php_sessions()`
+ `LLMS_Student::delete_quiz_attempt()`
+ `LLMS_Student::get_best_quiz_attempt()`
+ `LLMS_Student::get_quiz_data()`
+ `LLMS_Student::has_access()`
+ `LLMS_Student_Dashboard::output_courses_content()`
+ `LLMS_Student_Dashboard::output_dashboard_content()`
+ `LLMS_Student_Dashboard::output_notifications_content()`
+ `LLMS_Widget_Course_Progress::widget_contents()`
##### Previously deprecated functions that have been removed
+ `is_filtered()`
+ `lifterlms_template_loop_view_link()`
+ `llms_add_user_table_columns()`
+ `llms_add_user_table_rows()`
+ `llms_create_new_person()`
+ `llms_get_question()`
+ `llms_get_quiz()`
+ `llms_set_user_password_rest_key()`
+ `llms_setup_product_data()`
+ `llms_setup_question_data()`
+ `llms_verify_password_reset_key()`
##### Previously deprecated hooks that have been removed
+ Action: `lifterlms_before_memberships_loop_item_title`
+ Action: `lifterlms_after_memberships_loop_item_title`
+ Action: `lifterlms_after_memberships_loop_item_title`
+ Filter: `lifterlms_completed_transaction_message`
+ Filter: `lifterlms_is_filtered`
+ Filter: `lifterlms_get_analytics_pages`
+ Filter: `lifterlms_analytics_tabs_array`
##### Previously deprecated shortcodes that have been removed
+ `[courses]`
+ `[lifterlms_user_statistics]`
##### Previously deprecated templates that have been removed
+ `templates/loop/view-link.php`
##### Previously deprecated global variables that have been removed
+ `$product`
+ `$question`
v3.41.1 - 2020-06-23
--------------------
+ Apply restrictions to post content and excerpts during WP REST requests.
v4.0.0-rc.1 - 2020-06-18
------------------------
View release notes at [https://make.lifterlms.com/2020/06/18/lifterlms-version-4-0-0-rc-1/](https://make.lifterlms.com/2020/06/18/lifterlms-version-4-0-0-rc-1/).
v3.41.0 - 2020-06-12
--------------------
##### Bug Fixes
+ Fix issues encountered when a user role with the `edit_users` capability has multiple LifterLMS roles (like Student).
##### LifterLMS 4.0.0 Release Preparation
LifterLMS 4.0.0, our first major release in several years, is nearing the end of it's beta testing cycle. Many unused legacy functions, classes, and files are being removed in version 4.0.0 and well as many functions, classes, and files that were previously deprecated.
The following is a list of items that have not been previously deprecated but will be removed from LifterLMS 4.0.0.
For full details on the release, information on beta testing, and more, see our [blog post on the release](https://make.lifterlms.com/2020/06/01/preparing-for-lifterlms-4-0-0/).
##### Deprecations
The WP Session Manager plugin / library that is bundled into the LifterLMS core code base is deprecated from our code base and is being fully removed in favor of an internal session manager.
The bundled Javascript Boostrap 3 modules, "collapse" and "transition" are deprecated from our codebase and are being removed.
The following CSS classes are deprecated and will be removed:
+ `templates/global/form-login.php`: The `col-1` class from the `div.llms-person-login-form-wrapper` element will be removed.
+ `templates/global/form-registration.php`: : The `col-2` class from the `div.llms-new-person-form-wrapper` element will be removed.
The following classes are deprecated:
+ `LLMS_Number`: `includes/class.llms.number.php`
+ `LLMS_Person`: `includes/class.llms.person.php`
+ `LLMS_Table_Questions`: `includes/admin/reporting/tables/llms.table.questions.php`
The following class methods are deprecated:
+ `LLMS_PlayNice::divi_fb_wc_product_tabs_after()`
+ `LLMS_PlayNice::divi_fb_wc_product_tabs_before()`
+ `LLMS_Question::get_correct_option()`
+ `LLMS_Question::get_correct_option_key()`
+ `LLMS_Quiz::get_passing_percent()`, use `LLMS_Quiz::get( 'passing_percent' )` instead.
+ `LLMS_Quiz::get_assoc_lesson()`, use `LLMS_Quiz::get( 'lesson_id' )` instead.
+ `LLMS_Session::init()`
+ `LLMS_Session::maybe_start_session()`
+ `LLMS_Session::set_expiration_variant_time()`
+ `LLMS_Session::set_expiration_time()`
+ `LLMS_Session::use_php_sessions()`
The following class properties are deprecated:
+ `LifterLMS->person` (generally accessed via `LLMS()->person`).
The following functions are deprecated:
+ `lifterlms_template_loop_view_link()`
+ `llms_add_user_table_columns()`
+ `llms_add_user_table_rows()`
+ `llms_get_question()`
+ `llms_get_quiz()`
+ `llms_setup_product_data()`
+ `llms_setup_question_data()`
The following global variables are deprecated:
+ `$product`
+ `$question`
The following action hooks are deprecated:
+ `lifterlms_before_memberships_loop_item_title`
+ `lifterlms_after_memberships_loop_item_title`
+ `lifterlms_after_memberships_loop_item_title`
The following template file is deprecated:
+ `templates/loop/view-link.php`
v4.0.0-beta.3 - 2020-06-10
--------------------------
View beta release notes at [https://make.lifterlms.com/2020/06/10/lifterlms-version-4-0-0-beta-3/](https://make.lifterlms.com/2020/06/10/lifterlms-version-4-0-0-beta-3/).
v3.40.0 - 2020-06-09
--------------------
##### Updates
+ Adds a 1-click installation connector for the MailHawk email delivery plugin.
##### Bugfixes
+ Fixed an issue encountered during checkout when using a coupon against an access plan with a free trial.
##### Deprecations
+ `LLMS_SendWP::do_remote_install()` will be converted to a protected method and should no longer be called directly.
+ `LLMS_Abstract_Email_Provider::output_css()`
##### Templates updated
+ templates/checkout/form-gateways.php
v4.0.0-beta.2 - 2020-06-04
--------------------------
View beta release notes at [https://make.lifterlms.com/2020/06/04/lifterlms-version-4-0-0-beta-2/](https://make.lifterlms.com/2020/06/04/lifterlms-version-4-0-0-beta-2/).
v4.0.0-beta.1 - 2020-06-01
--------------------------
View beta release notes at [https://make.lifterlms.com/2020/06/01/lifterlms-version-4-0-0-beta-1/](https://make.lifterlms.com/2020/06/01/lifterlms-version-4-0-0-beta-1/).
v3.39.0 - 2020-05-28
--------------------
+ Student Welcome notifications and user registered engagements now fire when users are created via the REST POST requests to the `/students` endpoint.
+ Bugfix: Error encountered when printing full-page certificates on certain themes.
##### LifterLMS REST 1.0.0-beta.12
+ Feature: Added the ability to filter student and instructor collection list requests by various user information fields.
+ Fix: Prevent infinite loops encountered when invalid API keys are utilized.
+ Fix: Add an action used to fire LifterLMS core engagement and notification emails
v3.38.2 - 2020-05-19
--------------------
+ Added a default question type ("choice") to prevent malformed questions from being inadvertently stored in the database.
+ When retrieving question data from the database, automatically fall back to the default question type value if no question type is saved.
v3.38.1 - 2020-05-11
--------------------
+ Update: Added methods for retrieving a list of posts associated with a membership.
+ Bug fix: Fixed an issue causing certificate backgrounds to be cropped or cut in certain circumstances.
+ Bug fix: Fixed an issue generating certificate downloads on servers where `mime_content_type()` does not exist.
+ Bug fix: Fixed an issue which caused bbPress course forum restrictions to stop working.
v3.38.0 - 2020-04-29
--------------------
##### Updates
+ The output of course restriction errors which may prevent enrollment is now displayed in it's own template in favor of the logic being included in the `product/pricing-table.php` template.
+ The course progress bar shortcode will now only display the progress bar to enrolled users. An additional option has been added to the shortcode to allow showing a 0% progress bar to non-enrolled users. [Read more](https://lifterlms.com/docs/shortcodes/#lifterlms_course_progress).
+ The "Course Progress" widget now has an option to optionally display the progress bar to non-enrolled users. By default it will display only to enrolled students.
+ Updates LifterLMS Blocks to version 1.9.0
##### Bug fixes
+ Fixed an issue causing free access plans to bypass course enrollment restrictions like capacity and enrollment time periods.
+ Fixed an issue causing custom checkout success redirects to fail when using gateways that require a payment confirmation step. This fixes an issue in the LifterLMS PayPal payment gateway.
+ Fixed an issue causing deprecation theme-compatibility related deprecation notices to be incorrectly thrown.
+ Fixed spelling error in variable passed to the `product/pricing-table.php` template. The misspelled variable is still being passed to the variable for backwards compatibility.
+ Updated the way notification background processors are dispatched. This fixes an issue in the LifterLMS Twilio add-on.
##### Deprecations
+ `LLMS_Notifications::dispatch_processors()` is deprecated in favor of async dispatching via `LLMS_Notifications::schedule_processors_dispatch()`.
##### Templates Updated
+ templates/product/pricing-table.php
##### LifterLMS Blocks
+ Update: Improved script dependencies definitions.
+ Update: Updated asset paths for consistency with other LifterLMS projects.
+ Update: Updated various WP Core references that have been deprecated (maintains backwards compatibility).
+ Update: The Lesson Progression block is no longer rendered server-side in the block editor (minor performance improvement).
+ Update: Converted the course progress block into a dynamic block. Fixes an issue allowing the progress block to be visible to non-enrolled students.
+ Update: Added a filter on the output of the Pricing Table block: `llms_blocks_render_pricing_table_block`.
+ Bug fix: Fixed an issue encountered when using the WP Core "Table" block.
+ Bug fix: Fixed a few areas where `class` was being used instead of `className` to define CSS classes on elements in the block editor.
+ Bug fix: Fixed a user-experience issues encountered on the Course Information block when all possible information is disabled.
+ Bug fix: Fixed an issue causing visibility attributes to render on blocks that don't support them.
+ Bug fix: Fixed an issue preventing 3rd party blocks from modifying default block visibility settings.
+ Bug fix: Fixed a spelling error visible inside the block editor.
+ Bug fix: Fixed an issue causing the "Course Progress" block to be shown to non-enrolled students and visitors.
+ Bug fix: Removed redundant CSS from frontend.
+ Bug fix: Stop outputting editor CSS on the frontend.
+ Bug fix: Dynamic blocks with no content to render will now only output their empty render messages inside the block editor, not on the frontend.
+ Changes to the Classic Editor Block:
+ The classic editor block will no longer show block visibility settings because it is impossible to use those settings to filter the block on the frontend.
+ In order to apply visibility settings to the classic editor block, place the Classic Editor within a "Group" block and apply visibility settings to the Group.
v3.37.19 - 2020-04-20
---------------------
##### Updates
+ Added a new debugging tool to clear pending batches created by background processors.
+ Added a new method `LLMS_Abstract_Notification_View::get_object()` which can be used by notification views to override the loading of the post (or object) which triggered the notification.
##### Bug Fixes
+ Added localization to strings on the coupon admin screen. Thanks [parfilov](https://github.com/parfilov)!
+ Fixed issue encountered in metaboxes when the `$post` global variable is not set.
v3.37.18 - 2020-04-14
---------------------
+ Fix regression introduced in version 3.34.0 which prevented checkout success redirection to external domains.
+ Resolved a conflict with LifterLMS, Divi, and WooCommerce encountered when using the Divi frontend pagebuilder on courses and memberships.
+ Fixed issue causing localization issues when creating access plans, thanks [@mcguffin](https://github.com/mcguffin)!
v3.37.17 - 2020-04-10
---------------------
##### Updates
+ Updated the lost password and password reset form handlers for improved error handling and extendability by other plugins.
##### Bug Fixes
+ Fixed a conflict with WooCommerce resulting in password reset issues on the WooCommerce account dashboard.
+ Fixed an issue allowing voucher codes from deleted vouchers to still be redeemed.
+ Fixed an issue with pagination on the courses tab of a users BuddyPress profile.
+ Fixed a typo in the `post_status` query arg when retrieving access plans for a course or membership.
##### Deprecations
+ `LLMS_PlayNice::wc_is_account_page()` is no longer required and is deprecated with no replacement
+ WP core `get_password_reset_key()` should be used in favor of `llms_set_user_password_rest_key()`.
+ WP core `check_password_reset_key()` should be used in favor of `llms_verify_password_reset_key()`.
v3.37.16 - 2020-03-31
---------------------
+ Bugfix: Fix issue causing student dashboard notification view to work incorrectly.
v3.37.15 - 2020-03-27
---------------------
##### Security Notice
**This releases fixes a security issue. Please upgrade immediately!**
Props to [Omri Herscovici and Sagi Tzadik from Check Point Research](https://www.checkpoint.com/) who found and disclosed the vulnerability resolved in this release.
##### Updates & Bug Fixes
+ Excluded `page.*` events in order to keep the events table small.
+ Fixed error encountered when errors encountered validating custom fields. Thanks to [@wenchen](https://github.com/wenchen)!
+ Fixed issue causing course pagination issues in certain scenarios.
##### LifterLMS REST API Version 1.0.0-beta.11
+ Bugfix: Correctly store user `billing_postcode` meta data.
+ Bugfix: Fixed issue preventing course.created (and other post.created) webhooks from firing.
v3.37.14 - 2020-03-25
---------------------
+ Update: Added the ability to view the PHP error log file (as defined by `ini_get( 'error_log' )` ) on the LifterLMS -> Status -> Logs page.
+ Update: Added strict comparisons for various condition checks.
+ Bugfix: Fixed an issue where users might be redirected to the wrong course following a course import at the conclusion of the setup wizard.
+ Bugfix: Fixed issue with tracking event data being lost due to cookie size limitations.
+ Bugfix: Fixed issue potentially encountered when checking user capabilities for certificates and achievements.
+ Bugfix: Fixed an issue preventing additional instances of the JS `LLMS.Storage` class from being instantiated.
v3.37.13 - 2020-03-10
---------------------
+ Remove usage of internal functions marked as deprecated.
v3.37.12 - 2020-03-10
---------------------
##### Updates
+ Tested up to WordPress Core version 5.4.
+ Added support for post revisions for course, lesson, and membership post types.
##### Developer updates
+ Added strict comparisons for various condition checks.
+ Added a new filter, `llms_builder_{$post_type}_force_delete` which allows control over whether a post is moved to the trash or immediately deleted when trashed via the course builder.
##### Bugfixes
+ Fixed the name of the "actions" column on the quiz reporting screen.
+ Fixed PHP warnings resulting from functions used to exclude order notes from comment counts.
+ Fixed issue causing order notes to be included in the count displayed on the admin comments list despite their exclusion from the table itself.
+ Fixed PHP notice thrown on the WordPress menu editor interface encountered when student dashboard endpoints have been deleted or removed.
+ Fixed issue causing quotes to be encoded in various email, achievement, and certificate fields.
##### Deprecations
The following have been deprecated with no replacements and will be removed in the next major update:
+ `LLMS_Course_Factory::get_course()`
+ `LLMS_Course_Factory::get_lesson()`
+ `LLMS_Course_Factory::get_product()`
+ `LLMS_Course_Factory::get_quiz()`
+ `LLMS_Course_Factory::get_question()`
+ `LLMS_Course_Handler::get_users_not_enrolled()`
v3.37.11 - 2020-03-03
---------------------
##### Updates
+ Resolved a conflict with the "Starter Templates" plugin which made it impossible to edit quizzes while the plugin was enabled.
##### Bugfixes
+ Fixed an issue causing lesson post authors to be "lost" when adding an existing lesson to a course.
+ Fixed an issue causing php notices to be generated during existing lesson addition on the course builder.
+ Fixed an issue causing course bbPress forums to be lost when editing that course using the "Quick Edit" function from the courses table.
##### LifterLMS REST v1.0.0-beta.10
+ Added text domain to i18n functions that were missing the domain.
+ Added a "trigger" parameter to enrollment-related endpoints.
+ Added `llms_rest_enrollments_item_schema`, `llms_rest_prepare_enrollment_object_response`, `llms_rest_enrollment_links` filter hooks.
+ Fixed setting roles instead of appending them when updating user, thanks [@pondermatic](https://github.com/pondermatic)!
+ Fixed return when the enrollment to be deleted doesn't exist, returns `204` instead of `404`.
+ Fixed 'context' query parameter schema, thanks [@pondermatic](https://github.com/pondermatic)!
v3.37.10 - 2020-02-19
---------------------
+ Update: Exclude the privacy policy page from the sitewide restriction.
+ Update: Added filter `llms_enable_open_registration`.
+ Fix: Notices are printed on pages configured as a membership restriction redirect page.
+ Fix: Do not apply membership restrictions on the page set as membership's restriction redirect page.
+ Fix: Added flag to print notices when landing on the redirected page.
v3.37.9 - 2020-02-11
--------------------
+ Updated CSS classes used in privacy policy text suggestions per changes in WordPress core 5.3. Thanks [@garretthyder](https://github.com/garretthyder)!
+ Added privacy exported group descriptions. Thanks [@garretthyder](https://github.com/garretthyder)!
+ Added filters `llms_user_enrollment_allowed_post_types` & `llms_user_enrollment_status_allowed_post_types` which allow 3rd parties to enroll users into additional post types via core enrollment methods.
+ Added option for admin settings fields to show an asterisk for required fields.
+ Added option for integration plugins can now add automatically generated "Settings" link to the plugins screen.
+ Bugfix: Fixed an IE compatibility issue related to usage of `Object.assign()`.
v3.37.8 - 2020-01-21
--------------------
+ Fix: Student quiz attempts are now automatically deleted when a quiz is deleted.
+ Fix: "Orphaned" quizzes (those with no parent course and/or lesson) can be deleted from the Quiz reporting table.
+ Fix: Quiz IDs on the quiz reporting screen now link to the quiz within the course builder. If the quiz is an "orphan" there will be no link.
v3.38.0-beta.2 - 2019-12-19
---------------------------
+ Update LifterLMS Blocks to v1.7.3.
v3.38.0-beta.1 - 2019-12-13
---------------------------
##### Form Management Improvements
+ Forms (registration, checkout, account) are now managed via a block editor interface.
+ Customize field labels, description, and placeholders in a simple WYSIWYG interface.
+ Mark fields as required with a toggle.
+ Reorder fields with drag and drop.
+ Customize layout using block editor columns.
+ Use LifterLMS block-level visibility to conditionally display fields based on enrollment or logged in status.
##### Form Localization
+ Added default country and state/region lists (see the "languages" directory).
+ Country and state forms are now searchable dropdowns that adjusted based on the currently selected country.
+ Each country's locale information (such as what a "post code" is called and whether or not the country has states or post codes) will update automatically based on the selected country.
+ Enqueue select2 on account and checkout pages for searchable dropdowns for country & state.
##### Updates
+ New shortcode `[user]` which is used to output user information in a merge code interface.
+ Improved form field generation via `LLMS_Form_Field` class.
+ LifterLMS Settings: renamed "User Information Options" to "User Privacy Options".
+ Reorganized open registration setting.
+ Use `LLMS.wait_for()` for dependency waiting.
+ Moved checkout template variable declarations to the checkout shortcode controller.
+ Removed field display settings in favor of form customization using the form editors.
+ Organized function files. Some functions have been moved.
+ Function `llms_get_minimum_password_strength_name()` now accepts a parameter to retrieve strength name by key.
+ Use `LLMS.wait_for()` for dependency waiting.
##### LifterLMS Blocks v1.6.0
+ Feature: Added form field blocks for use on the Forms manager.
+ Feature: Add logic for `logged_in` and `logged_out` block visibility options.
+ Update: Added isDisabled property to Search component.
+ Update: Adjusted priority of `render_block` filter to 20.
+ Bug fix: Import `InspectorControls` from `wp.blockEditor` in favor of deprecated `wp.editor`
+ Bug fix: Automatically store course/membership instructor with `post_author` data when the post is created.
+ Bug fix: Pass style rules as camelCase.
##### Removed unused Javascript assets
+ Remove unused bootstrap transition and collapse scripts.
+ Remove topModal vendor dependency.
+ Remove password strength inline enqueues.
##### Bug fixes
+ Only attempt to add a nonce to the datastore when a nonce exists in the settings object.
##### Deprecations
+ Deprecated `LLMS_Person_Handler::register()` method, use `llms_register_user()` instead.
+ Deprecated `llms_get_minimum_password_strength()` with no replacement.
##### Template Updates
+ templates/checkout/form-checkout.php
+ templates/checkout/form-gateways.php
+ templates/global/form-registration.php
v3.37.7 - 2020-01-08
--------------------
+ Fix error resulting from undefined default value.
+ Fix PHP 7.4 deprecation notice.
v3.37.6 - 2019-12-12
--------------------
+ New transaction creation date is now specified using `llms_current_time()`.
+ Use the last successful transaction time to calculate from when the previously stored next payment date is in the future.
+ Fixed an issue causing transaction post titles to be recorded with missing data due to invalid `strftime()` placeholders.
v3.37.5 - 2019-12-09
--------------------
+ Update LifterLMS Blocks to v1.7.2: fixes a bug causing the block editor to encounter a fatal error when accessing custom post types that don't support custom fields.
v3.37.4 - 2019-12-06
--------------------
##### Bug Fixes
+ Fixed a bug causing certificate _template_ exports to export the site's homepage instead of the certificate preview.
+ When exporting a certificate template, use the `post_author` to determine what user to use for merge code data.
+ Revert Accounts settings tab page id to "account".
##### LifterLMS Blocks v1.7.1
+ Feature: Add logic for `logged_in` and `logged_out` block visibility options.
+ Update: Added `isDisabled` property to Search component.
+ Update: Adjusted priority of `render_block` filter to 20.
+ Update: Added filter, `llms_block_supports_visibility` to allow modification of the return of the check.
+ Update: Disabled block visibility on registration & account forms to prevent a potentially confusing form creation experience.
+ Update: Added block editor rendering for password type fields.
+ Update: Perform post migrations on `current_screen` instead of `admin_enqueue_scripts`.
+ Update: Update various dependencies to use updated gutenberg packages.
+ Bug fix: Fixed a WordPress 5.3 issues with JSON data affecting the ability to save course/membership instructors.
+ Bug fix: Import `InspectorControls` from `wp.blockEditor` in favor of deprecated `wp.editor`
+ Bug fix: Automatically store course/membership instructor with `post_author` data when the post is created.
+ Bug fix: Pass style rules as camelCase.
+ Bug fix: Fixed an issue causing "No HTML Returned" to be displayed in place of the Lesson Progression block on free lessons when viewed by a logged-out user.
v3.37.3 - 2019-12-03
--------------------
+ Added an action `llms_certificate_generate_export` to allow modification of certificate exports before being stored on the server.
+ Don't unslash uploaded file `tmp_name`, thanks [@pondermatic](https://github.com/pondermatic)!
+ TwentyTwenty Theme Support: Hide site header and footer, and set a white body background in single certificates.
+ Renamed setting field IDs to be unique for open/close wrapper fields on the engagements and account settings pages.
+ Removed redundant functions defined in the `LLMS_Settings_Page` class to reduce code redundancy in account and engagement setting page classes.
+ The `LLMS_Settings_Page` base class now automatically defines actions to save and output settings content.
v3.37.2 - 2019-11-22
--------------------
+ LifterLMS notices will now be displayed on pages defined as a Course or Membership sales page.
+ TwentyTwenty Theme: Updated to use `background-color` property instead of `background` shorthand when adding custom elements to style.
+ Added filter `llms_sessions_end_idle_cron_recurrence` to allow customization of the recurrence of the idle session cleanup cronjob.
+ Added filter `llms_quiz_is_open` to allow customization of whether or not a quiz is available to a student.
+ When adding an client-side tracking events to the always make sure the server-side verification nonce is always set on the storage object.
+ The Course/Membership filter on the main students reporting screen now correctly limits post results based on instructor access.
v3.37.1 - 2019-11-13
--------------------
+ TwentyTwenty Theme: Fixed course information block misalignment.
+ Fixed conflict with WooCommerce resulting from the movement of the deprecated LifterLMS function `is_filtered()`.
v3.37.0 - 2019-11-11
--------------------
##### Updates
+ Tested and compatible with WordPress core 5.3.
+ Add theme support for the TwentyTwenty core default theme.
+ Improved security and data sanitization in with regards to the SendWP integration connector.
##### LifterLMS Rest API 1.0.0-beta.8
+ Added memberships controller, huge thanks to [@pondermatic](https://github.com/pondermatic)!
+ Added new filters:
+ `llms_rest_lesson_filters_removed_for_response`
+ `llms_rest_course_item_schema`
+ `llms_rest_pre_insert_course`
+ `llms_rest_prepare_course_object_response`
+ `llms_rest_course_links`
+ Improved validation when defining instructors for courses.
+ Improved performance on post collection listing functions.
+ Ensure that a course instructor is always set for courses.
+ Fixed `sales_page_url` not returned in `edit` context.
+ In `update_additional_object_fields()` method, use `WP_Error::$errors` in place of `WP_Error::has_errors()` to support WordPress version prior to 5.1.
v3.36.5 - 2019-11-05
--------------------
+ Add filter: `llms_user_caps_edit_others_posts_post_types` to allow 3rd parties to utilize core methods for determining if a user can manage another users LMS content on the admin panel.
v3.36.4 - 2019-11-01
--------------------
+ Fixes a conflict with CartFlows introduced by a Divi theme compatibility fix added in 3.36.3. Is WordPress complicated or what?
v3.36.3 - 2019-10-24
--------------------
##### Updates
+ Added new `LLMS_Membership` class methods: `get_categories()`, `get_tags()` and `toArrayAfter()` methods. Thanks [@pondermatic](https://github.com/pondermatic)!
##### Compatibility
+ Fixed access plan description conflicts with the Classic Editor block. This also resolves compatibility issues with Elementor which uses a hidden TinyMCE instance.
+ Changed `pre_get_posts` callback from `10` (default) to `15`. Fixes conflict with Divi (and possibly other themes) which prevented LifterLMS catalog settings from functioning properly.
##### Bugfixes
+ Added translation to error message encountered when non-members attempt to purchase a members-only access plan. Thanks [@mrosati84](https://github.com/mrosati84)!
+ Fix return of `LLMS_Generator::set_generator()`.
+ Fixed a typo causing invalid imports from returning the expected error. Thanks [@pondermatic](https://github.com/pondermatic)!
+ Fixed issue preventing membership post type settings from saving properly due to incorrect sanitization filters.
+ Fixed issue where `wp_list_pluck()` would run on non arrays.
v3.36.2 - 2019-10-01
--------------------
##### Updates
+ Tested to WordPress 5.3.0-beta.2
+ Upgrade UI on student course reporting screens.
+ Added logic to physically remove from the membership level and remove enrollments data on related products, when deleting a membership enrollment.
+ Lesson metabox "start" drip method made available only if the parent course has a start date set.
##### Bugfixes
+ Fixed JS error when client-side event tracking settings aren't loaded, thanks [@wenchen](https://github.com/wenchen)!
+ Fixed PHP warning resulting from drip the "Course Start" lesson drip settings when no course start date exists.
+ Fixed fatal error encountered when reviewing an order placed with a payment gateway that's been deactivated.
##### Files Updated
+ assets/js/app/llms-tracking.js
+ includes/admin/post-types/meta-boxes/class.llms.meta.box.lesson.php
+ includes/models/model.llms.lesson.php
+ includes/models/model.llms.student.php
+ lifterlms.php
##### Templates Updated
+ templates/admin/post-types/order-details.php
+ templates/admin/reporting/tabs/students/courses-course.php
v3.36.1 - 2019-09-24
--------------------
##### Updates
+ Include SendWP Connector in LifterLMS Engagement Settings.
+ Removed usage of `WP_Error::has_errors()` to support WordPress version prior to 5.1.
+ Improve performances when checking if an event is valid in `LLMS_Events->is_event_valid()`.
+ Remove redundant check on `is_singular()` and `is_post_type_archive()` in `LLMS_Events->should_track_client_events()`.
##### Bugfixes
+ Fixed a compatibility issue with FitVids.js causing excess white space displayed around videos when using the library, WP plugin, or themes that utilize the library.
+ Fixed an issue allowing recurring charges to continue processing after the order or customer had been deleted from the site.
+ Fixed issue causing Membership Restriction settings from properly saving.
+ Fixed issue that allowed instructors to see all quizzes on a site when the instructor had either no courses or only empty courses (courses with no lessons).
+ Fixed "Last Seen" column displaying wrong date when the student last login date was saved as timestamp.
+ Fixed an issue causing popover notifications to be skipped (never displayed) as a result of redirects.
v3.36.0 - 2019-09-16
--------------------
##### User Interaction event and session Tracking
+ Added user interaction tracking for the following events:
+ User sign in and out.
+ Page load and exit (for LMS content)
+ Page focus and blur (for LMS content)
+ And more to come
+ Interaction events are grouped into sessions automatically. A session is "closed" after 30 minutes of inactivity or a log-out event.
+ Added "Last Seen" student reporting column which reports the last recorded activity for the student.
##### Enhancements
+ Automatically hydrate when calling LLMS_Abstract_Database_Store::to_array().
+ Added CSS to make course and lesson video embeds automatically responsive.
##### Bug Fixes
+ Correctly pass the `$remember` variable when using `llms_set_person_auth_cookie()`.
+ Fixed undefined index error when retrieving an unset value from an unsaved database model.
+ Fix issue causing quotes to be encoded in shortcodes used in course and membership restriction message settings fields.
+ Fix issue preventing manual updates of order dates (next payment, trial expiration, and access expiration) from being saved properly.
v3.35.2 - 2019-09-06
--------------------
+ When sanitizing settings, don't strip tags on editor and textarea fields that allow HTML.
+ Added JS filter `llms_lesson_rerender_change_events` to lesson editor view re-render change events.
v3.35.1 - 2019-09-04
--------------------
+ Fix instances of improper input sanitization and handling.
+ Include scripts, styles, and images for reporting charts and datepickers
v3.35.0 - 2019-09-04
--------------------
##### Security Notice
+ Fixed a security vulnerability disclosed by the WordPress plugin review team. Please upgrade immediately!
##### Updates
+ Explicitly setting css and js file versions for various static assets..
+ Added data sanitization methods in various form handlers.
+ Added nonce verification to various form handlers.
##### Bug fixes
+ Fixed some translation strings that had literal variables instead of placeholders.
+ Fixed undefined index error encountered when attempting to email a voucher export.
+ Fixed undefined index error when PHP file upload errors are encountered during a course import.
##### Deprecations
The following unused classes have been marked as deprecated and will be removed from LifterLMS in the next major release.
+ LLMS_Analytics_Memberships
+ LLMS_Analytics_Courses
+ LLMS_Analytics_Sales
+ LLMS_Meta_Box_Expiration
+ LLMS_Meta_Box_Video
##### Template Updates
+ [admin/reporting/tabs/courses/overview.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/reporting/tabs/courses/overview.php)
+ [admin/reporting/tabs/memberships/overview.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/reporting/tabs/memberships/overview.php)
+ [admin/reporting/tabs/quizzes/attempts.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/reporting/tabs/quizzes/attempts.php)
+ [admin/reporting/tabs/quizzes/overview.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/reporting/tabs/quizzes/overview.php)
+ [admin/reporting/tabs/students/courses-course.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/reporting/tabs/students/courses-course.php)
+ [admin/reporting/tabs/students/courses.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/reporting/tabs/students/courses.php)
+ [loop/featured-image.php](https://github.com/gocodebox/lifterlms/blob/master/templates/loop/featured-image.php)
+ [myaccount/view-order.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/view-order.php)
+ [quiz/results.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/results.php)
+ [single-certificate.php](https://github.com/gocodebox/lifterlms/blob/master/templates/single-certificate.php)
+ [single-no-access.php](https://github.com/gocodebox/lifterlms/blob/master/templates/single-no-access.php)
+ [taxonomy-course_cat.php](https://github.com/gocodebox/lifterlms/blob/master/templates/taxonomy-course_cat.php)
+ [taxonomy-course_difficulty.php](https://github.com/gocodebox/lifterlms/blob/master/templates/taxonomy-course_difficulty.php)
+ [taxonomy-course_tag.php](https://github.com/gocodebox/lifterlms/blob/master/templates/taxonomy-course_tag.php)
+ [taxonomy-course_track.php](https://github.com/gocodebox/lifterlms/blob/master/templates/taxonomy-course_track.php)
+ [taxonomy-membership_cat.php](https://github.com/gocodebox/lifterlms/blob/master/templates/taxonomy-membership_cat.php)
+ [taxonomy-membership_tag.php](https://github.com/gocodebox/lifterlms/blob/master/templates/taxonomy-membership_tag.php)
v3.34.5 - 2019-08-29
--------------------
+ Fixed logic issues preventing pending orders from being completed.
##### Templates Changed
+ [checkout/form-confirm-payment.php](https://github.com/gocodebox/lifterlms/blob/master/templates/checkout/form-confirm-payment.php)
v3.34.4 - 2019-08-27
--------------------
+ Add a new admin settings field type, "keyval", used for displaying custom html alongside a setting.
+ Added filter `llms_order_can_be_confirmed`.
+ Always bind JS for the login form handler on checkout and registration screens.
##### Templates Changed
+ [checkout/form-confirm-payment.php](https://github.com/gocodebox/lifterlms/blob/master/templates/checkout/form-confirm-payment.php)
##### LifterLMS REST API v1.0.0-beta.6
+ Fix issue causing certain webhooks to not trigger as a result of action load order.
+ Change "access_plans" to "Access Plans" for better human reading.
v3.34.3 - 2019-08-22
--------------------
+ During payment gateway order completion, use `llms_redirect_and_exit()` instead of `wp_redirect()` and `exit()`.
##### LifterLMS REST API v1.0.0-beta.5
+ Load all required files and functions when authentication is triggered.
+ Access `$_SERVER` variables via `filter_var` instead of `llms_filter_input` to work around PHP bug https://bugs.php.net/bug.php?id=49184.
v3.34.2 - 2019-08-21
--------------------
##### LifterLMS REST API v1.0.0-beta.4
+ Load authentication handlers as early as possible. Fixes conflicts with numerous plugins which load user information earlier than expected by the WordPress core.
+ Harden permissions associated with viewing student enrollment information.
+ Returns a 400 Bad Request when invalid dates are supplied.
+ Student Enrollment objects return student and post id's as integers instead of strings.
+ Fixed references to an undefined function.
v3.34.1 - 2019-08-19
--------------------
+ Update LifterLMS REST to v1.0.0-beta.3
##### Interface and Experience improvements during API Key creation
+ Better expose that API Keys are never shown again after the initial creation.
+ Allow downloading of API Credentials as a `.txt` file.
+ Add `required` properties to required fields.
##### Updates
+ Added the ability to CRUD webhooks via the REST API.
+ Conditionally throw `_doing_it_wrong` on server controller stubs.
+ Improve performance by returning early when errors are encountered for various methods.
+ Utilizes a new custom property `show_in_llms_rest` to determine if taxonomies should be displayed in the LifterLMS REST API.
+ On the webhooks table the "Delivery URL" is trimmed to 40 characters to improve table readability.
##### Bug fixes
+ Fixed a formatting error when creating webhooks with the default auto-generated webhook name.
+ On the webhooks table a translatable string is output for the status instead of the database value.
+ Fix an issue causing the "Last" page pagination link to display for lists with 0 possible results.
+ Don't output the "Last" page pagination link on the last page.
v3.34.0 - 2019-08-15
--------------------
##### LifterLMS REST API v1.0.0-beta.1
+ A robust REST API is now included in the LifterLMS core.
+ Create API Keys to consume and manage LifterLMS resources and students from external applications.
+ Create webhooks to pass LifterLMS resource data to external applications (like Zapier!).
+ The full API specification can be found at [https://gocodebox.github.io/lifterlms-rest/](https://gocodebox.github.io/lifterlms-rest/).
##### Student management capabilities
+ Explicit capabilities have been added to determine which users can create, view, update, and delete students.
+ Admins and LMS Managers have all student management capabilities.
+ Instructors and instructors assistants are granted limited view capabilities allowing them to only view students enrolled in their own courses/memberships.
+ Added the `list_users` capability to the "Instructor" role, allowing instructor's to better view and manage their assistant instructors.
+ The new capabilities are: `create_students`, `view_students`, `view_others_students`, `edit_students`, `edit_others_students`, `delete_students`, & `delete_others_students`.
##### Updates
+ Added new actions to help differentiate enrollment creation and update events.
+ Added methods and logic for managing user management of other users.
+ Added a filter `llms_table_get_table_classes` to LifterLMS admin tables which allows customization of the CSS classes applied to the `
` elements. Thanks [@pondermatic](https://github.com/pondermatic)!
+ Added a filter `llms_install_get_schema` to the database schema to allow 3rd parties to run table installations alongside the core.
+ Added the ability to pull "raw" (unfiltered) data from the database via classes extending the `LLMS_Post_Model` abstract.
+ Added a `bulk_set()` method to the `LLMS_Post_Model` abstract allowing the updating of multiple properties in one command.
+ Added `comment_status`, `ping_status`, `date_gmt`, `modified_gmt`, `menu_order`, `post_password` as gettable\settable post properties via the `LLMS_Post_Model` abstract.
+ Links on reporting tables are now the proper color.
+ The `editable_roles` filter which determines which roles can manage which other roles is now always loaded (instead of being loaded only on the admin panel).
+ Updated LifterLMS Blocks to 1.5.2
##### Bug Fixes
+ Fixed an issue preventing the `user_url` property from being retrieved by the `get()` method of the `LLMS_Abstract_User_Data` class.
+ Fixed an issue causing the `LLMS_Instructors::get_assistants()` method to return assistants for the currently logged in user instead of the instructor of the instantiated object.
+ Fixed an issue which would allow LMS Managers to edit and delete site administrators.
##### Deprecations
**The following functions and methods have been marked as deprecated and will be removed from LifterLMS with the next major release.**
+ LLMS_Course::get_children_sections() use LLMS_Course::get_sections( 'posts' )" instead
+ LLMS_Course::get_children_lessons() use LLMS_Course::get_lessons( 'posts' )" instead
+ LLMS_Course::get_author()
+ LLMS_Course::get_author_id() use LLMS_Course::get( "author" ) instead
+ LLMS_Course::get_author_name()
+ LLMS_Course::get_sku() use LLMS_Course::get( "sku" ) instead
+ LLMS_Course::get_id() use LLMS_Course::get( "id" ) instead
+ LLMS_Course::get_title() use get_the_title() instead
+ LLMS_Course::get_permalink() use get_permalink() instead
+ LLMS_Course::get_user_postmeta_data()
+ LLMS_Course::get_user_postmetas_by_key()
+ LLMS_Course::get_checkout_url()
+ LLMS_Course::get_start_date() use LLMS_Course::get_date( "start_date" ) instead
+ LLMS_Course::get_end_date() use LLMS_Course::get_date( "end_date" ) instead
+ LLMS_Course::get_next_uncompleted_lesson()
+ LLMS_Course::get_lesson_ids() use LLMS_Course::get_lessons( "ids" ) instead
+ LLMS_Course::get_syllabus_sections() use LLMS_Course::get_sections() instead
+ LLMS_Course::get_short_description() use LLMS_Course::get( "excerpt" ) instead
+ LLMS_Course::get_syllabus() use LLMS_Course::get_sections() instead
+ LLMS_Course::get_user_enroll_date()
+ LLMS_Course::get_user_post_data()
+ LLMS_Course::check_enrollment()
+ LLMS_Course::is_user_enrolled() use llms_is_user_enrolled() instead
+ LLMS_Course::get_student_progress() use LLMS_Student::get_progress() instead
+ LLMS_Course::get_membership_link()
v3.33.2 - 2019-06-26
--------------------
+ It is now possible to send test copies of the "Student Welcome" email to yourself.
+ Improved information logged when an error is encountered during an email send.
+ Add backwards compatibility for legacy add-on integrations priority loading method.
+ Fixed undefined index notice when viewing log files on the admin status screen.
v3.33.1 - 2019-06-25
--------------------
##### Updates
+ Added method to retrieve the load priority of integrations.
+ The capabilities used to determine if uses can clone and export courses now check `edit_course` instead of `edit_post`.
##### Bug Fixes
+ Fixed an issue which would cause the "Net Sales" line to sometimes display as a bar on the sales revenue reporting chart.
+ Fixed an issue causing a PHP notice to be logged when viewing the sales reporting screen.
+ Fixed an issue causing backslashes to be added before quotation marks in access plan descriptions.
+ Integration classes are now loaded in the order defined by the integration class.
+ Fixed an issue causing a PHP error when viewing the admin logs screen when no logs exist.
v3.33.0 - 2019-05-21
--------------------
##### Updates
+ Added the ability for site administrators to delete (completely remove) enrollment records from the database.
+ Catalogs sorted by Order (`menu_order`) now have an additional sort (by post title) to improve ordering consistency for items with the same order, thanks [@pondermatic](https://github.com/pondermatic)!
+ Hooks in the dashboard order review template now pass the `LLMS_Order`.
##### LifterLMS Blocks
+ Updated to version 1.5.1
+ All blocks are now registered only for post types where they can actually be used.
+ Only register block visibility settings on static blocks. Fixes an issue causing core (or 3rd party) dynamic blocks from being managed within the block editor.
##### Bug Fixes
+ If an enrolled student accesses checkout for a course/membership they're already enrolled in they will be shown a message stating as much.
+ Removed a redundant check for the existence of an order on the dashboard order review template.
+ When an order is deleted, student enrollment records for that order will be removed. This fixes an issue causing admins to not be able to manage the enrollment status of a student enrolled via a deleted order.
+ Fix issue causing errors when using the `[lifterlms_lesson_mark_complete]` shortcode on course post types.
+ Fixed an issue causing quiz questions to generate publicly accessible permalinks which could be indexed by search engines.
##### Templates Changed
+ [course/complete-lesson-link.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/complete-lesson-link.php)
+ [templates/myaccount/view-order.php](https://github.com/gocodebox/lifterlms/blob/master/templates/templates/myaccount/view-order.php)
v3.32.0 - 2019-05-13
--------------------
##### Updates
+ Added Membership reporting
+ Added the ability to restrict coupons to courses and memberships which are in draft or scheduled status.
+ When recurring payments are disabled, output a "Staging" bubble on the "Orders" menu item.
+ Recurring recharges now add order notes and trigger actions when gateway or recurring payment status errors are encountered.
+ When managing recurring payment status through the warning notice, stay on the same page and clear nonces instead of redirecting to the LifterLMS Settings screen.
+ Updated the Action Scheduler library to the latest version (2.2.5)
+ Exposed the Action Scheduler's scheduled actions interface as a tab on the LifterLMS Status page.
##### LifterLMS Blocks
+ Updated to version 1.4.1.
+ Fixed issue causing asset paths to have invalid double slashes.
+ Fixed issue causing frontend css assets to look for an unresolvable dependency.
##### Bug Fixes
+ Fixed an issue allowing instructors to view a list of students from courses and memberships they don't have access to.
+ WooCommerce compatibility filters added in 3.31.0 are now scheduled at `init` instead of `plugins_loaded`, resolves conflicts with several WooCommerce add-ons which utilize core WC functions before LifterLMS functions are loaded.
v3.31.0 - 2019-05-06
--------------------
##### Updates
+ Tested to WordPress 5.2
+ Adds explicit support for the twentynineteen default theme.
+ The main students reporting table can now be filtered to show only students enrolled in a specific course or membership.
+ Resolve conflict with WooCommerce (3.6 and later) resulting in 404s on the dashboard endpoints "lost password", "order history", and "edit account".
+ Adds a dynamic filter (`llms_notification_view{$trigger_id}_basic_options`) to basic (pop-over) notifications to allow configuration of their settings.
+ The filter `llms_plan_get_checkout_url` now passes a 3rd parameter: `$check_availability`
+ Improves `LLMS_Course_Data` and `LLMS_Quiz_Data` classes by adding shared functionality to a shared abstract, `LLMS_Abstract_Post_Data`
+ Changed access on class methods in `LLMS_Shortcode_Courses` from private to protected, thanks [@andrewvaughan](https://github.com/andrewvaughan)!
##### Bug fixes
+ Treats `post_excerpt` data as HTML instead of plain text. Fixes an issue resulting in HTML tags being stripped from lesson excerpts when duplicating a lesson in the course builder or importing lessons via the course importer.
+ Fix an issue allowing access plan sales prices to be set as negative values.
##### LifterLMS Blocks
+ Updated to LifterLMS Blocks 1.4.0.
+ Adds an "unmigration" utility to LifterLMS -> Status -> Tools & Utilities which can be used to remove LifterLMS blocks from courses and lessons which were migrated to the block editor structure.
+ This tool is only available when the Classic Editor plugin is installed and enabled and it will remove blocks from ALL courses and lessons regardless of whether or not the block editor is being utilized on that post.
##### Deprecations
+ `LLMS_Query::add_query_vars()` use `LLMS_Query::set_query_vars()` instead.
v3.30.3 - 2019-04-22
--------------------
##### Updates
+ Fixed typos and spelling errors in various strings.
+ Corrected a typo in the `content-disposition` header used when exporting voucher CSVs, thanks [@pondermatic](https://github.com/pondermatic)!
+ Improved the quiz attempt grading experience by automatically focusing the remarks field and only toggling the first answer if it's not visible, thanks [@eri-trabiccolo](https://github.com/eri-trabiccolo)!
+ Removed commented out code on the Student Dashboard Notifications Tab template, thanks [@tnorthcutt](https://github.com/tnorthcutt)!
##### Bug Fixes
+ Renamed "descrpition" key to "description" found in the return of `LLMS_Instructor()->toArray()`.
+ Fixed an issue causing slashes to be stripped from course content when cloning a course.
+ Fixed an issue causing JS warnings to be thrown in the Javascript console on Course and Membership edit pages on the admin panel due to variables being defined too late, thanks [@eri-trabiccolo](https://github.com/eri-trabiccolo)!
+ Fixed an undefined variable notice encountered when filtering quiz attempts on the quiz attempts reporting screen, thanks [@eri-trabiccolo](https://github.com/eri-trabiccolo)!
+ Fixed an issue causing slashes to appear before quotation marks when saving remarks on a quiz attempt, thanks [@eri-trabiccolo](https://github.com/eri-trabiccolo)!
+ [@pondermatic](https://github.com/pondermatic) fixed typos and misspellings in comment and docs in over 200 files and while that doesn't concern most users it's worthy of a mention.
##### Deprecations
The following unused classes have been marked as deprecated and will be removed from LifterLMS in the next major release.
+ `LLMS\Users\User`
+ `LLMS_Analytics_Page`
+ `LLMS_Course_Basic`
+ `LLMS_Lesson_Basic`
+ `LLMS_Quiz_Legacy`
##### Template Updates
+ [templates/myaccount/my-notifications.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/my-notifications.php)
v3.30.2 - 2019-04-09
--------------------
+ Added new filter to allow 3rd parties to determine if a `LLMS_Post_Model` field should be added to the `custom` array when converting the post to an array.
+ Added hooks and filters to the `LLMS_Generator` class to allow 3rd parties to easily generate content during course clone and import operations.
+ Fixed an issue causing all available courses to display when the [lifterlms_courses] shortcode is used with the "mine" parameter and the current user viewing the shortcode is not enrolled in any courses.
+ Fixed a PHP undefined variable warning present on the payment confirmation screen.
##### Template Updates
+ [templates/checkout/form-confirm-payment.php](https://github.com/gocodebox/lifterlms/blob/master/templates/checkout/form-confirm-payment.php)
v3.30.1 - 2019-04-04
--------------------
##### Updates
+ Added handler to automatically resume pending (incomplete or abandoned) orders.
+ Classes extending the `LLMS_Abstract_API_Handler` can now prevent a request body from being sent.
+ Added dynamic filter `'llms_' . $action . '_more'` to allow customization of the "More" button text and url for student dashboard sections. Thanks @[pondermatic](https://github.com/pondermatic).
+ Remove unused CSS code on the admin panel.
##### Bug Fixes
+ Fixed a bug preventing course imports as a result of action priority ordering issues.
+ Function `llms_get_order_by_key()` correctly returns `null` instead of false when no order is found and will return an `int` instead of a numeric string when an order is found.
+ Changed the method used to sort question choices to accommodate numeric choice markers. This fixes an issue in the Advanced Quizzes add-on causing reorder questions with 10+ choices to sort display in the incorrect order.
+ Increased the specificity of LifterLMS element tooltip hovers. Resolves a conflict causing issues on the WooCommerce tax rate management screen.
+ Fixed an issue causing certain fields in the Customizer from displaying a blue background as a result of very unspecific CSS rules, thanks [@Swapnildhanrale](https://github.com/Swapnildhanrale)!
+ Fixed builder deep links to quizzes freezing due to dependencies not being available during initialization.
+ Fixed builder issue causing duplicate copies of questions to be added when adding existing questions multiple times.
##### Template Updates
+ [templates/myaccount/dashboard-section.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/dashboard-section.php)
v3.30.0 - 2019-03-21
--------------------
##### Updates
+ **Create custom thank you pages with new access plan checkout redirect options.**
+ Added the ability to sort items on the membership auto enrollment table (drag and drop to sort and reorder).
+ Improved the interface and interactions with the membership auto enrollment table settings.
##### LifterLMS Blocks
+ Updated LifterLMS Blocks to 1.3.8.
+ Fixed an issue causing some installations to be unable to use certain blocks due to jQuery dependencies being declared improperly.
##### Bug Fixes
+ Fixed issue preventing courses with the same title from properly displayed on the membership automatic enrollment courses table on the admin panel.
+ Fixed an issue preventing builder custom fields from being able to specify a custom sanitization callback.
+ Fixed an issue preventing builder custom fields from being able to properly save and render multi-select data.
##### Template Updates
+ [templates/product/access-plan-restrictions.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/access-plan-restrictions.php)
+ [templates/product/free-enroll-form.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/free-enroll-form.php)
v3.29.4 - 2019-03-08
--------------------
+ Fixed an issue preventing users with email addresses containing an apostrophe from being able to login.
v3.29.3 - 2019-03-01
--------------------
##### Bug Fixes
+ Removed attempts to validate & save access plan data when the Classic Editor "post" form is submitted.
+ Fix issue causing 1-click free-enrollment for logged in users to refresh the screen without actually performing an enrollment.
##### Template Updates
+ [product/free-enroll-form.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/free-enroll-form.php)
v3.29.2 - 2019-02-28
--------------------
+ Fix issue causing blank "period" values on access plans from being updated.
+ Fix an issue preventing paid access plans from being switched to "Free".
v3.29.1 - 2019-02-27
--------------------
+ Automatically reorder access plans when a plan is deleted.
+ Skip (don't create) empty plans passed to the access plan save method as a result of deleted access plans.
v3.29.0 - 2019-02-27
--------------------
##### Improved Access Plan Management
+ Added a set of methods for creating access plans programmatically.
+ Updated the Access Plan metabox on courses and lessons with improved data validation.
+ When using the block editor, the "Pricing Table" block will automatically update when access plan changes are saved to the database (from LifterLMS Blocks 1.3.5).
+ Access plans are now created and updated via AJAX requests, resolves a 5.0 editor issue causing duplicated access plans to be created.
##### Student Management Improvements
+ Added the ability for instructors and admins to mark lessons complete and incomplete for students via the student course reporting table.
##### Admin Panel Settings and Reporting Design Changes
+ Replaced LifterLMS logos and icons on the admin panel with our new logo LifterLMS Logo and Icons.
+ Revamped the design and layout of settings and reporting screens.
##### Checkout Improvements
+ Updated checkout javascript to expose an error addition functions
+ Abstracted the checkout form submission functionality into a callable function not directly tied to `$_POST` data
+ Removed display order field from payment gateway settings in favor of using the gateway table sortable list
##### Other Updates
+ Removed code related to an incompatibility between Yoast SEO Premium and LifterLMS resulting from former access plan save methods.
+ Reduced application logic in the `course/complete-lesson-link.php` template file by refactoring button display filters into functions.
+ Added function for checking if request is a REST request
+ Updated LifterLMS Blocks to version 1.3.7
##### Bug Fixes
+ Fixed an issue preventing "Pricing Table" blocks from displaying on the admin panel when the current user was enrolled in the course or no payment gateways were enabled on the site.
+ Fixed the checkout nonce to have a unique ID & name
+ Fixed an issue with deleted quizzes causing quiz notification's to throw fatal errors.
+ Fixed an issue preventing notification timestamps from displaying on the notifications dashboard page.
+ Fix an issue causing `GET` requests with no query string variables from causing issues via incorrect JSON encoding via the API Handler abstract.
+ Fix an issue causing access plan sale end dates from using the default WordPress date format settings.
+ `LLMS_Lesson::has_quiz()` will now properly return a boolean instead of the ID of the associated quiz (or 0 when none found)
##### Template Updates
+ [checkout/form-checkout.php](https://github.com/gocodebox/lifterlms/blob/master/templates/checkout/form-checkout.php)
+ [course/complete-lesson-link.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/complete-lesson-link.php)
+ [product/access-plan-pricing.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/access-plan-pricing.php)
+ [notifications/basic.php](https://github.com/gocodebox/lifterlms/blob/master/templates/notifications/basic.php)
##### Templates Removed
Admin panel templates replaced with view files which cannot be overridden from a theme or custom plugin.
+ `admin/post-types/product-access-plan.php`
+ `admin/post-types/product.php`
v3.28.3 - 2019-02-14
--------------------
+ ❤❤❤ Happy Valentines Day or whatever ❤❤❤
+ Tested to WordPress 5.1
+ Fixed an issue causing JSON data saved by 3rd party plugins in course or lesson postmeta fields to be not duplicate properly during course duplications and imports.
v3.28.2 - 2019-02-11
--------------------
##### Updates
+ Updated default country list to remove non-existent countries and resolve capitalization issues, thanks [nrherron92](https://github.com/nrherron92)!
##### Bug fixes
+ Fixed an issue causing the email notification content getter to use the same filter as popover notifications.
+ Fixed an issue preventing default blog date & time settings from being used when displaying an access plan's access expiration date on course and membership pricing tables.
+ Fixed an issue causing 404s on paginated dashboard endpoints when the permalink structure is set to anything other than `%postname%`.
##### Deprecations
+ `LLMS_Query->set_dashboard_pagination()`
v3.28.1 - 2019-02-01
--------------------
+ Fixed an issues preventing exports to be accessible on Apache servers.
+ Fixed an issue causing servers with certain nginx rules to open CSV exports directly instead of downloading them.
v3.28.0 - 2019-01-29
--------------------
##### Updates
+ Updated reporting table export functions to provide immediate download prompts of the files. Exports are generated in real time and you *must* remain on the page while it generates. The good news is if your site had issues with email or cronjobs it'll no longer be an issue for you.
+ Updated lesson metabox to use icons for attached quizzes
+ Added an orange highlight to the admin "Add-Ons & More" menu item
+ Removed unused cron event.
##### LifterLMS Blocks
+ Updated LifterLMS Blocks to 1.3.4
+ Adds support for handling courses & lessons in "Classic Editor" mode as defined by the Divi page builder
+ Skips course and lesson migration when "Classic" mode is enabled.
+ Adds conditions to identify "Classic" mode when the Classic Editor plugin settings are configured to enforce classic (or block) mode for *all* posts.
##### Database Updates
+ Unschedules the aforementioned unused cron event.
##### Bug fixes
+ Fixed an issue preventing the temp directory old file cleanup cron from firing on schedule.
+ During plugin uninstallation the tmp cleanup cron will now be properly unscheduled.
+ Fixed an issue causing notifications on the student dashboard to appear on top of static headers or the WP Admin Bar when scrolling.
+ Fixed an issue preventing manual updating of customer and source information on orders resulting from unfocusable hidden form fields.
+ Fixed mismatched HTML tags on the Admin Add-Ons screen
##### Deprecations
+ Class method: `LLMS_Admin_Table::queue_export()`
+ Class: `LLMS_Processor_Table_To_Csv`
v3.27.0 - 2019-01-22
--------------------
###### Updates
+ Added the ability to add existing questions to a quiz in the course builder. This allows cloning of existing questions as well as attaching "orphaned" questions currently attached to no quizzes.
+ Added the ability to detach questions from quizzes. Coupled with adding existing questions, questions can now be easily moved between quizzes.
+ Added permalink capabilities to the builder to allow linking to specific items within the builder (a lesson, quiz, etc...).
+ Quizzes with 0 possible points will no longer show a Pass/Fail chart with a 0% (failing) grade on quiz results screens.
+ Replaced option `lifterlms_lock_down` which cannot be set via any setting with a filter to reduce database calls. This will have no effect on anyone unless you manually set this option to "no" via a database query. Having done this would allow the admin bar to be shown to students.
##### Bug Fixes
+ Fixed an issue causing the default "Redeem Voucher" and "My Orders" student dashboard endpoint slugs from not having the correct default values. Thanks [@tnorthcutt](https://github.com/tnorthcutt)!
+ Fixed an issue causing quotation marks in quiz question answers to show escaping slashes on results screens.
+ Fixed a bug preventing viewing quiz results for quizzes with questions that have been deleted.
+ Fixed a bug causing a PHP Notice to be output when registering a new user with a valid voucher.
##### Templates Changed
+ [quiz/results-attempt.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/results-attempt.php)
v3.26.4 - 2019-01-16
--------------------
+ Update to [LifterLMS Blocks 1.3.2](https://make.lifterlms.com/2019/01/15/lifterlms-blocks-version-1-3-1/), fixing an issue preventing template actions from being removed from migrated courses & lessons.
v3.26.3 - 2019-01-15
--------------------
##### Updates
+ Fix issue preventing course difficulty and course length from being edited when using the classic editor plugin.
+ Improved pagination methods on Student Dashboard Endpoints
+ "My Notifications" dashboard tab now consistently paginated like other dashboard endpoints
+ Update to [LifterLMS Blocks 1.3.1](https://make.lifterlms.com/2019/01/15/lifterlms-blocks-version-1-3-1/).
##### Bug Fixes
+ Fixed an issue preventing course difficulty and course length from being edited when using various page builders.
+ Fixed issues causing errors on quiz reporting screens for quiz attempts made by deleted users.
##### Deprecated Functions
+ `LLMS_Student_Dashboard::output_notifications_content()` replaced with `lifterlms_template_student_dashboard_my_notifications()`
##### Templates Changed
+ [myaccount/my-notifications.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/my-notifications.php)
+ [admin/reporting/tabs/quizzes/attempt.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/reporting/tabs/quizzes/attempt.php)
v3.26.2 - 2019-01-09
--------------------
+ Fast follow to fix incorrect version number pushed to the readme files for 3.26.1 which prevents upgrading to 3.26.1
v3.26.1 - 2019-01-09
--------------------
##### Updates
+ Tested to WordPress 5.0.3
+ Student CSV reports will now bypass cached data during report generation.
+ Add course and membership catalog visibility settings into the block editor.
+ Includes LifterLMS Blocks 1.3.0.
##### Bug Fixes
+ Fixed issue preventing the course instructors metabox from displaying when using the classic editor plugin.
+ Fixed an issue causing membership background enrollment from processing when the course background processor is disabled via filters.
+ Fixed an issue causing errors when reviewing orders on the admin panel which were placed via a payment gateway which is no longer active.
+ Fixed an issue preventing course difficulty and course length from being edited when using the classic editor plugin.
+ Fixed a very convoluted conflict between LifterLMS, WooCommerce, and Elementor explained at https://github.com/gocodebox/lifterlms/issues/730.
v3.26.0 - 2018-12-27
--------------------
+ Adds conditional support for page builders: Beaver Builder, Divi Builder, and Elementor.
+ Fixed issue causing LifterLMS core sales pages from outputting automatic content (like pricing tables) on migrated posts.
+ Student unenrollment calls always bypass cache during enrollment precheck.
+ Membership post type "name" label is now plural (as it is supposed to be).
v3.25.4 - 2018-12-17
--------------------
+ Adds a filter (`llms_blocks_is_post_migrated`) to allow determining if a course or lesson has been migrated to the WP 5.0 block editor.
+ Added a filter (`llms_dashboard_courses_wp_query_args`) to the WP_Query used to display courses on the student dashboard.
+ Fixed issue on course builder causing prerequisites to not be saved when the first lesson in a course was selected as the prereq.
+ Fixed issue on course builder causing lesson settings to be inaccessible without first saving the lesson to the database.
v3.25.3 - 2018-12-14
--------------------
+ Fixed compatibility issue with the Classic Editor plugin when it was added after a post was migrated to the new editor structure.
v3.25.2 - 2018-12-13
--------------------
+ Added new filters to the `LLMS_Product` model.
+ Fix issue with student dashboard login redirect causing a white screen on initial login.
v3.25.1 - 2018-12-12
--------------------
##### Updates
+ Editor blocks now display a lock icon when hovering/selecting a block which corresponds to the enrollment visibility settings of the block.
+ Removal of core actions is now handled by a general migrator function instead of by individual blocks.
##### Bug fixes
+ Fixed issue preventing strings from the lifterlms-blocks package from being translatable.
+ Fix issue causing block visibility options to not be properly set when enrollment visibility is first enabled for a block.
+ Fixed compatibility issue with Yoast SEO Premium redirect manager settings, thanks [@moorscode](https://github.com/moorscode)!
+ Fixed typo preventing tag size options (or filters) of course information block from functioning properly. Thanks [@tnorthcutt](https://github.com/tnorthcutt)!
##### Templates Changed
+ [templates/course/meta-wrapper-start.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/meta-wrapper-start.php)
v3.25.0 - 2018-12-05
--------------------
##### WordPress 5.0 Ready!
+ **Tested with WordPress core 5.0 (Gutenberg)!**
+ Editor Blocks: Course and Lesson layouts are now (preferably) powered by various editor blocks.
+ When a block is added to a course or lesson, the template hook that automatically outputs that element is removed automatically (preventing duplicates).
+ If you use the LifterLMS Labs: Action Manager you may no longer need it!
+ Course & Membership instructors are now managed through an editor "plugin". Check out the rocket icon near the "Publish/Update" button.
+ Instructor metabox will load conditionally based on presence of the block editor
+ New courses and lessons will automatically have a preloaded block editor template
+ Courses and lessons will automatically be "migrated" to these templates when edited on the admin panel
+ Various course settings conditionally load based on the presence of the block editor
+ Added filter to the headline size in the `course/meta-wrapper-start.php` template. Allows customization of headline via the "Course Information" block settings.
+ If you're not ready for WordPress 5.0 you can still upgrade LifterLMS. This release is fully functional without the block editor.
##### Bug Fixes
+ Fixed typo in `quiz/start-button.php` template.
+ Fixed error occurring during activation of LaunchPad via the Add-Ons & More screen.
+ Fixed issue causing quiz reporting screens to be blank for users without `view_others_lifterlms_reports` capabilities.
##### Templates Changed
+ [templates/course/author.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/author.php)
+ [course/meta-wrapper-start.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/meta-wrapper-start.php)
+ [quiz/start-button.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/start-button.php)
v3.24.3 - 2018-11-13
--------------------
##### Updates
+ Added user email, login, url, nicename, display name, first name, and last name as fields searched when searching orders. Thanks Thanks [@yojance](https://github.com/yojance)!
##### Bug Fixes
+ Fixed issue causing fatal errors encountered during certificate downloading caused by CSS `` tags existing outside of the `` element.
+ Certificates downloaded by users who can see the WP Admin Bar will no longer show the admin bar on the downloaded certificate
+ Fixed issue on iOS Safari causing multiple choice quiz questions to require a "long press" to be properly selected
+ Fixed issue causing access plan sales to end 36m and 1s prior to end of the day on the desired sale end date. Thanks [@eri-trabiccolo](https://github.com/eri-trabiccolo)!
+ Ensure that fallback url slugs for course & membership archives are translatable.
v3.24.2 - 2018-10-30
--------------------
+ Fix issue causing newline characters to be malformed on course builder description fields, resulting in `n` characters being output in strange places.
v3.24.1 - 2018-10-29
--------------------
##### Updates
+ The shortcode `[lifterlms_hide_content]` now accepts multiple IDs and can specify whether the user must belong to either *all* or *any one* of the specified memberships. Thanks [@yojance](https://github.com/yojance)!
+ The action `llms_voucher_used`, called when a voucher code is used, will now pass the voucher code as a 3rd parameter. Thanks [@yojance](https://github.com/yojance)!
##### Bug Fixes
+ Fixed a typo in engagement drop creation dropdown. Thanks [README1ST](https://github.com/README1ST)!
+ Fixed issue causing backslash characters (`\`) to be removed from course elements (sections, lessons, quizzes, and assignments) constructed in the course builder.
+ Fixed an issue in the 3.16.0 database migration script that would cause migrations to get stuck as a result of malformed data saved in an invalid format.
+ Added processing handlers to payment confirmation form. Fixes an issue which would allow multiple payment confirmation requests to be made (if the form was submitted multiple times before the page reloaded) resulting in duplicate charges.
##### Templates Changed
+ templates/checkout/form-confirm-payment.php
v3.24.0 - 2018-10-23
--------------------
##### "My Grades" Student Dashboard Endpoint
+ A new student dashboard endpoint, "My Grades", has been added
+ The main screen displays a paginated and sortable list of all courses a student is enrolled in and outputs their progress and grade in the courses
+ Students can drill into individual reporting screens for each course where specific details for each course are available for review
##### Grading Enhancements
+ Each lesson can now be assigned an individual "points" value
+ When a course is graded the points assigned to each lesson will be used to calculate the value of the lesson's grade within the overall course grade
+ Lessons can also be assigned a value of "0" to allow a lesson to not count towards the overall grade of the course.
+ Email notifications are now sent to a student when an instructor reviews, grades, or leaves remarks on a quiz attempt.
##### Test Email Notifications
+ An interface and API for sending test email notifications has been added, the following notifications can now be tested:
+ Purchase Receipt
+ Quizzes: Failed (Thanks [@philwp](https://github.com/philwp)!)
+ Quizzes: Graded
+ Quizzes: Passed (Thanks [@philwp](https://github.com/philwp)!)
##### Updates and Enhancements
+ Quiz Passed & Quiz Failed notifications have new names on the admin panel ("Quizzes: Quiz Passed" & "Quizzes: Quiz Failed")
+ The default content for Quiz Passed and Quiz Failed notifications have been enhanced. If you've modified these you can delete your modified content to have your notifications "restored" to the improved defaults.
+ Change the page title of the Student Dashboard page installed via the Setup Wizard to be "Dashboard" instead of "My Courses." Thanks [@philwp](https://github.com/philwp)!
+ In the course builder when a lesson is duplicated, the attached quiz will be duplicated as well
+ Minor increase to performance in the `LLMS_Course->get_lessons()` method
+ Added `student_id` as a parameter passed to the `llms_student_get_progress` filter
+ Updated all access plan templates added in 3.23.0 to ensure `ABSPATH` is defined to prevent direct template access
+ Remove use of deprecated `LLMS_Lesson->get_children_lessons()` in the `LLMS_Course` and `LLMS_Lesson` models as well as in the `course/syllabus.php` template
+ Refactored the `LLMS_Section->get_percent_complete()` method to utilize methods from the `LLMS_Student` model
+ Added the ability for admin table classes to define `` element CSS classes
+ Admin settings pages with no settings to save (like the Notifications list) no longer display a "Save" button
+ Added actions when creating, updating, and deleting records managed by `LLMS_Abstract_Database_Store` classes
+ Updated system report to include URLs to settings with URLs, adds a small speed boost to support request turn around time.
##### Please Rate & Review LifterLMS on WordPress.org
+ Added a WordPress.org review request link to the footer of LifterLMS admin pages.
+ Added a WordPress.org review request notice which displays a week after installation if the site has 50+ active students.
##### Bug fixes
+ Fixed issue causing HTML entity codes to display in email subject lines. Thanks [@philwp](https://github.com/philwp)!
+ Fixed issue causing post cleanup functions to run queries against unsupported post types.
+ Fixed typos in a handful of i18n functions so that the proper textdomain is now being used
+ Removed `get_option()` call to unused option `lifterlms_logout_endpoint` which ran on WordPress initialization unnecessarily.
+ Removed 3.21.0 fixes for iOS touch issues that are now causing iOS touch issues on quizzes.
+ When an order is deleted, all order transactions will also be deleted. This does not happen until the order is deleted (transactions will remain while the order is in the trash)
+ Fixed an issue causing duplicated quizzes to initially show images for question images & image choices (reorder pictures & picture choice) but the image data would not be properly saved so when returning to the builder or viewing a quiz on the frontend the images would be lost
##### Deprecated Functions & Methods
+ Deprecated `LLMS_Section->get_children_lessons()`, use `LLMS_Section->get_lessons( 'posts' )` instead
##### Template Updates
+ [course/syllabus.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/syllabus.php)
+ [product/access-plan-button.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/access-plan-button.php)
+ [product/access-plan-description.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/access-plan-description.php)
+ [product/access-plan-feature.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/access-plan-feature.php)
+ [product/access-plan-pricing.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/access-plan-pricing.php)
+ [product/access-plan-restrictions.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/access-plan-restrictions.php)
+ [product/access-plan-title.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/access-plan-title.php)
+ [product/access-plan-trial.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/access-plan-trial.php)
+ [product/free-enroll-form.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/free-enroll-form.php)
v3.23.0 - 2018-08-27
--------------------
##### Access Plan & Pricing Table Template Improvements
+ The pricing table template has been split into multiple templates which are now rendered via action hooks. No visual changes have been made but if you've customized the template using a template override you'll want to review the template changes before updating!
+ New action hooks are available to modify the rendering of access plans in course / membership pricing tables.
+ `llms_access_plan`: Main hook for outputting an entire access plan within the pricing table
+ `llms_before_access_plan`: Called before main content of access plan. Outputs the "Featured" area of plans
+ `llms_acces_plan_content`: Main access plan content. Outputs title, pricing info, restrictions, and description
+ `llms_acces_plan_footer`: Called after main content. Outputs trial info and the checkout / enrollment button
+ Added filters to the returns of many of the functions in the `LLMS_Acces_Plan` model.
+ Minor improvements made to `LLMS_Access_Plan` model
##### Updates and Enhancements
+ Improved handling of empty blank / empty data when adding instructors to courses and memberships
+ Added filters to the "Sales Page Content" type options & functions for courses and memberships to allow 3rd parties to define their own type of sales page functionality
+ Added filters to the saving of access plan data
+ Improved the HTML and added CSS classes to the access plan admin panel html view
##### Bug Fixes
+ Fixes issue causing the "Preview Changes" button on courses to lock the "Update" publishing button which prevents changes from being properly saved.gi
+ Fixed issue causing PHP errors when viewing courses / memberships on the admin panel when an instructor user was deleted
+ Fixed issue causing PHP notices when viewing course / membership post lists on the admin panel when an instructor user was deleted
+ Fixed issue causing PHP warnings to be generated when viewing the user add / edit screen on the admin panel
+ Fixed an issue which would cause access plans to never be available to users. *This bug didn't affect any existing installations except if you wrote custom code that called the `LLMS_Access_Plan::is_available_to_user()` method.*
##### Template Updates
+ [templates/admin/post-types/product-access-plan.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/post-types/product-access-plan.php)
+ [templates/product/pricing-table.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/pricing-table.php)
v3.22.2 - 2018-08-13
--------------------
+ Fixed issue causing banners on general settings screen to cause a fatal error when api connection errors occurred
+ Improved CSS on setup wizard
v3.22.1 - 2018-08-06
--------------------
+ Fix issue causing themes to appear as requiring updates when using the LifterLMS Helper
v3.22.0 - 2018-07-31
--------------------
+ Frontend notifications are no longer powered by AJAX requests. This change will significantly reduce the number of requests made but will remove the ability for students to receive asynchronous notifications. This means that notifications will only be displayed on page load as notification polling will no longer occur while a student is on a page (while reading the content a lesson, for example).
+ Course and membership catalogs items in navigation menus will now have expected CSS classes to identify current item and current item parents
+ The admin panel add-ons screen has been reworked to be powered by the lifterlms.com REST api
+ Some visual changes have been made to the add-ons screen
+ The colors on the voucher screen on the admin panel have been updated to match the rest of the interfaces in LifterLMS
v3.21.1 - 2018-07-24
--------------------
+ Fixed issue causing visual issues on checkout summary when using coupons which apply discounts to a plan trial
+ Fixed issue causing `.mo` files stored in the `languages/lifterlms` safe directory from being loaded before files stored in the default location `languages/plugins`
+ Added methods to integration abstract to allow integration developers to automatically describe missing integration dependencies
+ Tested to WordPress 4.9.8
##### Template Updates
+ [templates/checkout/form-summary.php](https://github.com/gocodebox/lifterlms/blob/master/templates/checkout/form-summary.php)
v3.21.0 - 2018-07-18
--------------------
##### Updates and Enhancements
+ Added new actions before and after global login form HTML: `llms_before_person_login_form` & `llms_after_person_login_form`
+ Settings API can now create disabled fields
+ Added new actions to the checkout form: `lifterlms_pre_checkout_form` && `lifterlms_post_checkout_form`
+ Added CRUD functions for interacting with data located in the `wp_lifterlms_user_postmeta` table
+ Replaced various database queries for CRUD user postmeta data with new CRUD functions
+ Added new utility function to allow splicing data into associative arrays
##### Bug Fixes
+ If all user information fields are disabled, the "Student Information" are will now be hidden during checkout for logged in users instead of displaying an empty information box
+ Fixed plugin compatibility issue with Advanced Custom Fields
+ Fixed issue causing multiple choice quiz questions to require a double tap on some iOS devices
+ Fixed incorrectly named filter causing section titles to not display on student course reporting screens
+ We do not advocate using PHP 5.5 or lower but if you were using 5.5 or lower and encountered an error during bulk enrollment we've fixed that for. Please upgrade to 7.2 though. We all want faster more secure websites.
##### Template Updates
+ [templates/checkout/form-checkout.php](https://github.com/gocodebox/lifterlms/blob/master/templates/checkout/form-checkout.php)
+ [templates/global/form-login.php](https://github.com/gocodebox/lifterlms/blob/master/templates/global/form-login.php)
v3.20.0 - 2018-07-12
--------------------
+ Updated user interfaces on admin panel for courses and memberships with relation to "Enrolled" and "Non-Enrolled" student descriptions
+ "Enrolled Student Description" is now the default WordPress editor
+ "Non-Enrolled Student Description" is now the "Sales Page"
+ Additional options for sales pages (the content displayed to visitors and non-enrolled students) have been added:
+ Do nothing (show course description)
+ Show custom content (use a WYSIWYG editor to define content)
+ Redirect to a WordPress page (use custom templates and enhance page builder compatibility and capabilities)
+ Redirect to a custom URL (use a sales page hosted on another domain!)
+ Tested to WordPress 4.9.7
v3.19.6 - 2018-07-06
--------------------
+ Fix file load paths in OptimizePress plugin compatibility function
v3.19.5 - 2018-07-05
--------------------
+ Fixed bug causing `select2` multi-selects from functioning as multi-selects
+ Fixed visual issue with `select2` elements being set without a width causing them to be both too small and too large in various scenarios.
+ Fixed duplicate action on dashboard section template
##### Template Updates
+ [templates/myaccount/dashboard-section.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/dashboard-section.php)
v3.19.4 - 2018-07-02
--------------------
##### Updates and enhancements
+ Bulk enroll multiple users into a course or membership from the Users table on your admin panel. See how at [https://lifterlms.com/docs/student-bulk-enrollment/](https://lifterlms.com/docs/student-bulk-enrollment/)
+ Added event on builder to allow integrations to run trigger events when course elements are saved
+ Added general redirect method `llms_redirect_and_exit()` which is a wrapper for `wp_redirect()` and `wp_safe_redirect()` which can be plugged (and tested via phpunit)
+ Added new action called before validation occurs for a user account update form submission: `llms_before_user_account_update_submit`
+ Removed placeholders from form fields. Fixes a UX issue causing registration forms to appear cluttered due to having both placeholders and labels.
##### Bug fixes
+ Fixed issue allowing nonce checks to be bypassed on login and registration forms
+ Fixed issue causing a PHP notice if the registration form is submitted without an email address and automatic username generation is enabled
+ Fixed issue preventing email addresses with the "'" character from being able to register, login, or update account information
+ Fixed typo in automatic username generation filter `lifterlms_generated_username` (previously was `lifterlms_gnerated_username`)
+ Fixed issue causing admin panel static assets to have a double slash (//) in the asset URI path
+ Fixed issue allowing users with `view_lifterlms_reports` capability (Instructors) to access sales & enrollment reporting screens. The `view_others_lifterlms_reports` capability (Admins & LMS Managers) is now required to view these reporting tabs.
+ Updated IDs of login and registration nonces to be unique. Fixes an issue causing Chrome to throw non-unique ID warnings in the developer console. Also, IDs are supposed to be unique _anyway_ but thanks for helping us out Google.
v3.19.3 - 2018-06-14
--------------------
+ Fix issue causing new quizzes to be unable to load questions list without reloading the builder
v3.19.2 - 2018-06-14
--------------------
##### Updates and enhancements
+ The course builder will now load quiz question data when the quiz is opened instead of loading all quizzes on builder page load. Improves builder load times and addresses an issue which could cause timeouts in certain environments when attempting to edit very large courses.
+ The currently viewed lesson will now be bold in the lesson outline widget.
+ Added a CSS class `.llms-widget-syllabus .llms-lesson.current-lesson` which can be used to customize the display of the current lesson in the widget.
+ Added the ability to filter quiz attempt reports by quiz status
+ Updated language for access plans on with a limited number of payments to reflect the total number of payments due as opposed to the length (for example in years) that the plan will run.
##### Bug fixes
+ Fixed issue preventing oEmbed media from being used in quiz question descriptions
+ Fixed issue preventing `` from being used in quiz question descriptions
+ Quiz results will now exclude questions with 0 points value when displaying the number of questions in the quiz.
+ Fixed error occurring when sorting was applied to quiz attempt reports which would cause quiz attempts from other quizzes to be included in the new sorted report
+ Fixed filter `lifterlms_reviews_section_title` which was unusable due to the incorrect usage of `_e()` within the filter. Now using `__()` as expected.
+ Fixed issue causing course featured image to display in place of lesson feature images
##### Template Updates
+ [templates/course/lesson-preview.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/lesson-preview.php)
+ [templates/course/outline-list-small.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/outline-list-small.php)
+ [templates/quiz/results-attempt.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/results-attempt.php)
v3.19.1 - 2018-06-07
--------------------
+ Fixed CSS specificity issue on admin panel causing white text on white background on system status pages
v3.19.0 - 2018-06-07
--------------------
##### Updates and enhancements
+ Added a "My Memberships" tab to the student dashboard
+ "My Memberships" preview area
+ Updated admin panel order status badges to match frontend order status badges
+ Added a new recurring order status "Pending Cancel." Orders in this state will allow students to access course / membership content until the next payment is due, on this date, instead of a recurring charge being made the order will move to "Cancelled" and the student's enrollment status will change to "Cancelled" removing their access to the course or membership.
+ When a student cancels an active recurring order from the student dashboard, the order will move to "Pending Cancellation" instead of "Cancelled"
+ Students can re-activate an order that's Pending Cancellation moving the expiration date to the next payment due date
+ Added the ability to edit the access expiration date for orders with limited access settings and for orders in the "pending-cancel" state
+ Added a filter to allow customization of the URL used to generate certificate downloads from
+ When viewing taxonomy archives for any course or membership taxonomy (categories, tags, and tracks), if a term description exists, it will be used instead of the default catalog description content defined on the catalog page.
+ Added a filter (`llms_archive_description`) to allow filtering of the archive description
+ When `WP_DEBUG` is disabled the scheduled-actions posttype interface is now available via direct link. Useful for debugging but don't want to expose a menu-item link to clients. Access via wp-admin/edit.php?post_type=scheduled-action. Be warned: you shouldn't be modifying scheduled actions manually and that's why we're not exposing this directly, this should be used for debugging only!
+ Updated the function used to check if lessons have featured images to improve performance and resolve an incompatibility issue with WP Overlays plugin.
##### Bug fixes
+ Fixed issue causing "My Courses" title to be duplicated on the student dashboard when viewing the endpoint
+ Fixed issue causing the trial price to be displayed with a strike-through during a sale
+ Fixed coupon issue causing coupons to expire at the beginning of the day on the expiration date instead of at the end of the day
+ Fixed issue causing CSS rules to lose their declared order during exports causing export rendering issues with certain themes and plugin combinations
##### Template Updates
+ [templates/checkout/form-summary.php](https://github.com/gocodebox/lifterlms/blob/master/templates/checkout/form-summary.php)
+ [templates/checkout/form-switch-source.php](https://github.com/gocodebox/lifterlms/blob/master/templates/checkout/form-switch-source.php)
+ [templates/course/lesson-preview.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/lesson-preview.php)
+ [templates/myaccount/view-order.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/view-order.php)
v3.18.2 - 2018-05-24
--------------------
+ Improved integrations settings screen to allow each integration to have it's own settings tab (page) with only its own settings
+ Allow programmatic access to notification content when notification views are accessed via filters
+ Fixed issue causing subscription cancellation notifications to be sent to admins when new orders were created
+ Fixed warning message displayed prior to membership bulk enrollment
+ Fixed multibyte character encoding issue encountered during certificate exports
v3.18.1 - 2018-05-18
--------------------
+ Attached `llms_privacy_policy_form_field()` and `llms_agree_to_terms_form_field()` to an action hook `llms_registration_privacy`
+ Define minimum WordPress version requirement as 4.8.
##### Template Updates
+ [templates/checkout/form-checkout.php](https://github.com/gocodebox/lifterlms/blob/master/templates/checkout/form-checkout.php)
+ [templates/global/form-registration.php](https://github.com/gocodebox/lifterlms/blob/master/templates/global/form-registration.php)
v3.18.0 - 2018-05-16
--------------------
##### Privacy & GDPR Compliance Tools
+ Added privacy policy notice on checkout, enrollment, and registration that integrates with the WP Core 4.9.6 Privacy Policy Page setting
+ Added settings to allow customization of the privacy policy and terms & conditions notices during checkout, enrollment, and registration
+ Added suggested Privacy Policy language outlining information gathered by a default LifterLMS site
+ During a WordPress Personal Data Export request the following LifterLMS information will be added to the export
+ All personal information gathered from registration, checkout, and enrollment forms
+ Course and membership enrollments, progress, and grades
+ Earned achievements and certificates
+ All order data
+ During a WordPress Personal Data Erasure request the following LifterLMS information will be erased
+ All personal information gathered from registration, checkout, and enrollment forms
+ Earned achievements and certificates
+ All notifications for or about the user
+ If the "Remove Order Data" setting is enabled, the order will be anonymized by removing student personal information from the order and, if the order is a recurring order, it will be cancelled.
+ If the "Remove Student LMS Data" setting is enabled, all student data related to course and membership activity will be removed
+ All of the above relies on features available in WordPress core 4.9.6
##### Updates and Enhancements
+ Tested up to WordPress 4.9.6
+ Improved pricing table UX for members-only access plans. An access plan button for a plan belonging to only one membership will click directly to the membership as opposed to opening a popover. Plan's with access via multiple memberships will continue to open a popover listing all availability options.
+ Added a "My Certificates" tab to the Student Dashboard
+ Certificates can be downloaded as HTML files (available when viewing a certificate or from the certificate reporting screen on the admin panel)
+ Admins can now delete certificates and achievements from reporting screens on the admin panel
+ Added additional information to certificate and achievement reporting tables
+ Expanded widths of admin settings page setting names to be a bit wider and more readable
+ Now conditionally hiding some settings when they are no longer relevant
+ Added daily cron automatically remove files from the `LLMS_TMP_DIR` which are more that 24 hours old
+ Removed unused template `content-llms_membership.php`
+ Added initialization actions for use by integration classes
##### Bug Fixes
+ Fixed issue causing coupon reports to always display "1" regardless of actual number of coupons used
+ Fixed issue causing new posts created via the Course Builder to always be created for user_id #1
+ Fixed issue causing "My Achievements" to display twice on the My Achievements student dashboard tab
+ Fixed issue preventing lessons from being completed when a quiz in draft mode was attached to the lesson
+ Fixed issue causing minified RTL stylesheets to 404
##### Template Updates
+ [templates/admin/post-types/order-details.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/post-types/order-details.php)
+ [templates/checkout/form-checkout.php](https://github.com/gocodebox/lifterlms/blob/master/templates/checkout/form-checkout.php)
+ [templates/content-certificate.php](https://github.com/gocodebox/lifterlms/blob/master/templates/content-certificate.php)
+ [templates/global/form-registration.php](https://github.com/gocodebox/lifterlms/blob/master/templates/global/form-registration.php)
+ [templates/myaccount/dashboard-section.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/dashboard-section.php)
v3.17.8 - 2018-05-04
--------------------
##### Updates and Enhancements
+ Added admin email notification when student cancels a subscription
+ Quiz results will now display the question's description when reviewing results as a student and on the admin panel during grading
+ Add action hook fired when a student cancels a subscription (`llms_subscription_cancelled_by_student`)
+ Reduce unnecessary DB queries for integrations by checking for dependencies and then calling querying the options table to see if the integration has been enabled.
+ Updated the notifications settings table to be more friendly to the human eye
##### Bug Fixes
+ Fix admin scripts enqueue order. Fixes issue preventing manual student enrollment selection from functioning properly in certain scenarios.
+ Shift + Enter when in a question choice field now adds a return as expected instead of exiting the field
+ When pasting into question choice fields HTML from RTF documents will be automatically stripped
+ Ensure certificates print with a white background regardless of theme CSS
+ Fix issue causing themes with `overflow:hidden` on divs from cutting certificate background images
+ Upon export completion unlock tables regardless of mail success / failure
+ Resolve issue causing incorrect number of access plans to be returned on systems that have custom defaults set for `WP_Query` `post_per_page` parameter
+ Fix error occurring when all 3rd party integrations are disabled by filter, credit to [@Mte90](https://github.com/Mte90)!
+ Ensure `LLMS()->integrations()->integrations()` returns all integrations regardless of availability.
+ Updated `LLMS_Abstract_Options_Data` to have an option set method
##### Template Updates
+ [templates/quiz/results-attempt-questions-list.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/results-attempt-questions-list.php)
v3.17.7 - 2018-04-27
--------------------
+ Fix issue preventing assignments passing grade requirement from saving properly
+ Fix issue preventing builder toggle switches from properly saving some switch field data
+ Fix with "Launch Builder" button causing it to extend outside the bounds of its container
+ Fix issue with builder radio select fields during view rerenders
+ Course Outline shortcode (and widget) now retrieve parent course of the current page more consistently with other shortcodes
+ Added ability to filter which custom post types which can be children of a course (allows course shortcodes & widgets to be used in assignment sidebars of custom content areas)
v3.17.6 - 2018-04-26
--------------------
+ Updated language on recurring orders with no expiration settings. Orders no longer say "Lifetime Access" and instead output no expiration information
+ Quiz editor on builder updated to be consistent visually and functionally to the lesson settings editor
+ Improved the builder field API to allow for radio element fields
+ Fix issue causing JS error on admin settings pages
+ Updated CSS for Certificates to be more generally compatible with theme styles when printed
+ Allow system print settings to control print layout for certificates by removing explicit landscape declarations
+ Now passing additional data to filters used to create custom columns on reporting screens
+ Remove unused JS files & Chosen JS library
+ Added filter to allow opting into alternate student dashboard order layout. Use `add_filter( 'llms_sd_stacked_order_layout', '__return_true' )` to stack the payment update sidebar below the main order information. This is disabled by default.
+ Achievement and Certificate basic notifications now auto-dismiss after 10 seconds like all other basic notifications
+ Deprecated Filter `llms_get_quiz_theme_settings` and added backwards compatible methods to transition themes using this filter to the new custom field api. For more information see new methods at https://lifterlms.com/docs/course-builder-custom-fields-for-developers/
+ Increased default z-index on notifications to prevent notifications from being hidden behind floating / static navigation menus
##### Template Updates
+ [templates/myaccount/my-orders.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/my-orders.php)
+ [templates/myaccount/view-order.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/view-order.php)
v3.17.5 - 2018-04-23
--------------------
##### Admin Settings Interface Improvements
+ Improved admin settings page interface to allow for section navigation
+ Updated checkout setting pages to utilize a separate section (page) for each available payment gateway
+ Added a table of payment gateways to see at a glance which gateways are enabled and allows drag and drop reordering of gateway display order
+ Moved dashboard endpoints to a separate section on the accounts settings area
+ Updated CSS on settings page to have more regular spacing between subtitles and settings fields
+ Added a "View" button next to any admin setting post/page selection field to allow quick viewing of the selected post
+ Purchase page setting field is now ajax powered like all other page selection settings
+ Renamed dashboard settings section titles to be more consistent with language in other areas of LifterLMS
+ All dashboard endpoints now automatically sanitized to be URL safe
##### Updates and Enhancements
+ Dashboard endpoints can now be deregistered by setting the endpoint slug to be blank on account settings
##### Bug Fixes
+ Fix issue causing 404s for various script files when SCRIPT_DEBUG is enabled
+ Fix issue with audio & video embeds to prevent fallback to default post attachments
+ Fix issue causing student selection boxes to malfunction due to missing dependencies when loaded over slow connections
##### Template Updates
+ [templates/myaccount/navigation.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/navigation.php)
v3.17.4 - 2018-04-17
--------------------
+ Added core RTL language support
+ Fixed fatal error on student management tables resulting from deleted admin users who manually enrolled students
+ Added filter to allow 3rd parties to disable achievement dupchecking (`llms_achievement_has_user_earned`)
+ Added {student_id} merge code which can be utilized on certificates
+ Added merge code insert button to certificates editor
+ Added filter to allow 3rd parties to disable certificate dupchecking (`llms_certificate_has_user_earned`)
+ Added filter to allow 3rd parties to add custom merge codes to certificates (`llms_certificate_merge_codes`)
+ Fix restriction check issue for lessons with drip or prerequisites on course outline widget / shortcode
+ Bumped WP tested to version to 4.9.5
##### Template Updates
+ [templates/course/complete-lesson-link.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/complete-lesson-link.php)
+ [templates/course/outline-list-small.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/outline-list-small.php)
v3.17.3 - 2018-04-11
--------------------
+ Course and Membership instructor metabox search field now correctly states "Select an Instructor" instead of previous "Select a Student"
+ Added missing translation for "Select a Student" on admin panel student selection search fields
+ Fix issue causing reporting export CSVs to throw a SYLK interpretation error when opened in Excel
+ Fix issue causing drafted courses and memberships to be published when the "Update" button is clicked to save changes
+ Remove use of PHP 7.2 deprecated `create_function`
+ Fix errors resulting from quiz questions which have been deleted
+ Fix issue causing current date / time to display as the End Date for incomplete quiz attempts on quiz reporting screens
##### Template Updates
+ [templates/admin/reporting/tabs/quizzes/attempt.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/reporting/tabs/quizzes/attempt.php)
+ [templates/quiz/results-attempt-questions-list.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/results-attempt-questions-list.php)
v3.17.2 - 2018-04-09
--------------------
+ Fixed issue preventing lesson video and audio embeds from being *removed* when using the course builder settings editor
+ Fixed issue causing question images to lose the image source
+ Updated student management table for courses and memberships to show the name (and a link to the user profile) of the site user who manually enrolled the student.
+ Add "All Time" reporting to various reporting filters
+ Added API for builder fields to enable multiple select fields
+ Fix memory leak related to assignments rendering on course builder
+ Fix issue causing course progress and enrollment checks to incorrectly display progress data cached for other users
+ Lesson progression actions (Mark Complete & Take Quiz buttons) will now always display to users with edit capabilities regardless of enrollment status
##### Template Updates
+ [templates/course/complete-lesson-link.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/complete-lesson-link.php)
+ [templates/course/outline-list-small.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/outline-list-small.php)
v3.17.1 - 2018-03-30
--------------------
+ Refactored lesson completion methods to allow 3rd party customization of lesson completion behavior via filters and hooks.
+ Remove duplicate lesson completion notice implemented. Only popover notifications will display now instead of popovers and inline messages.
+ Object completion will now automatically prevent multiple records of completion from being recorded for a single object.
+ Lesson Mark Complete button and lessons completed by quiz now utilizes a generic trigger to mark lessons as complete: `llms_trigger_lesson_completion`.
+ Removed several unused functions from frontend forms class
+ Moved lesson completion form controllers to their own class
##### Templates updates
+ [templates/course/complete-lesson-link.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/complete-lesson-link.php)
v3.17.0 - 2018-03-27
--------------------
##### Builder Updates
+ Moved action buttons for each lesson (for opening quiz and lesson editor) to be static below the lesson title as opposed to only being visible on hover
+ Added new audio and video status indicator icons for each lesson
+ Various status indicator icons will now have different icons in addition to different colors depending on their state
+ Replaced "pencil" icons that open the WordPress post editor with a small "WP" icon
+ Added several actions and filters to backend functions so that 3rd parties can hook into builder saves
+ Added lesson settings editing to the builder. Lesson settings can now be updated from settings metaboxes on the lesson post edit screen AND on the builder.
+ Added prerequisite validation for lessons to prevent accidental impossible prerequisite creating (eg: Lesson 5 can never be a prerequisite for Lesson 4)
+ Added functions and filters to allow 3rd parties to add custom fields to the builder. For more details see [an example](https://lifterlms.com/docs/course-builder-custom-fields-for-developers/).
+ Fixed issue causing changes made in "Text" mode on content editors wouldn't trigger save events
+ Fixed issue causing lesson prerequisites to not properly display on the course builder
+ Fixed CSS z-index issues related to builder field tooltip displays
+ Removed unused Javascript dependencies
##### Bug Fixes
+ Fixed typo on filter on quiz question image getter function
##### Updates
+ Performance improvements made to database queries and functions related to student enrollment status and student course progress queries. Thanks to [@mte90](https://github.com/Mte90) for raising issues and testing solutions related to these updates and changes!
+ Added PHP Requires plugin header (5.6 minimum)
+ Added HTTP User Agent data to the system report
+ [LifterLMS Assignments Beta](https://lifterlms.com/product/lifterlms-assignments?utm_source=LifterLMS%20Plugin&utm_medium=CHANGELOG&utm_campaign=assignments%20preorder) is imminent and this release adds functionality to the Builder which will be extended by Assignments upon when availability
v3.16.16 - 2018-03-19
---------------------
+ Fixed builder issue causing multiple question choices to be incorrectly selected
+ Fixed builder issue with media library uploads causing an error message to prevent new uploads before the quiz or question has been persisted to the database
+ Fixed builder issue preventing quizzes from being deleted before they were persisted to the database
+ Fixed builder issue causing autosaves to interrupt typing and reset lesson and section titles
+ Fixed JS console error related to LifterLMS JS dependency checks
v3.16.15 - 2018-03-13
---------------------
##### Quiz Results Improvements and fixes
+ Improved quiz result user and correct answer handling functions for more consistent HTML output
+ Result answers (correct and user) will display as lists
+ image question types will display without bullets and will "float" next to each other
+ Fixed issue causing quiz results with multiple answers from outputting all HTMLS with no spaces between them
##### Quiz Grading
+ Fixed issue causing advanced reorder and reorder question types from being graded incorrectly in some scenarios
+ Advanced fill in the blank questions are now case insensitive. Case sensitivity can be enabled with a filter: `add_filter( 'llms_quiz_grading_case_sensitive', '__return_true' )`
##### Fixes
+ Updated spacing and returns found in the email header and footer templates to prevent line breaks from occurring in undesirable places on previews of HTML emails in mobile email clients
+ Added options for themes to add layout support to quizzes where the custom field utilizes an underscore at the beginning of the field key
+ Fixed CSS issue causing blanks of fill in the blanks to not be visible on the course builder when using Chrome on Windows
+ Removed unnecessary `get_option()` call to unused option `lifterlms_permalinks`
+ Updated permissions required to see various LifterLMS post types to rely on `manage_lifterlms` capabilities as opposed to `manage_options`
+ This will only affect the LMS Manager core role or any custom role which was provided with the `manage_options` capability. Manages will now be able to access all LMS content and custom roles would now not be able to access LMS content
+ Affected content types are: Orders, Coupons, Vouchers, Engagements, Achievements, Certificates, and Emails
+ Several references to an option removed in LifterLMS 3.0 still existed in the codebase and have now been removed.
+ Option `lifterlms_course_display_banner` is no longer called or referenced
+ Template function `lifterlms_template_single_featured_image()` has been removed
+ Actions referencing `lifterlms_template_single_featured_image()` have been removed
+ Template function `lifterlms_get_featured_image_banner()` has been removed
+ Template `templates/course/featured-image.php` has been removed
##### Templates updates
+ [quiz/results-attempt-questions-list.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/results-attempt-questions-list.php)
v3.16.14 - 2018-03-07
---------------------
+ Courses reporting table now includes courses with the "Private" status
+ Fixed issue causing some achievement notifications to be blank
+ Added tooltips to question choice add / delete icon buttons
+ Quiz results meta information elements now have unique CSS classes
+ Removed reliance PHP 7.2 deprecated function `create_function()`
+ Fixed invalid PHP 7.2 syntax creating a warning found on the setup wizard
+ Fixed undefined index error related to admin notices
+ Fixed untranslatable string on Users table ("No Memberships")
+ Fixed discrepancy between membership restrictions as presented to logged out users and logged in users who cannot access membership
+ Fixed FireFox and Edge issue causing changes to number inputs made via HTML5 input arrows from properly triggering save events
v3.16.13 - 2018-02-28
---------------------
+ Hotfix: Only create quizzes on the builder if quizzes exist on the lesson
v3.16.12 - 2018-02-27
---------------------
+ Quizzes can now be detached (removed from a lesson) or deleted (deleted from the lesson and the database) via the Course Builder
+ Improved question choice randomization to ensure randomized choices never display in their original order.
+ When a lesson is deleted, any quiz attached to the lesson will become an orphan
+ When a lesson is deleted, any lesson with this lesson as a prerequisite will have it's prerequisite data removed
+ When a quiz is deleted, all questions attached to the quiz will also be deleted
+ When a quiz is deleted, the lesson associated with the quiz will have those associations removed
+ Fixed grammar issue on restricted lesson tooltips when no custom message is stored on the course.
+ Updated functions causing issues in PHP 5.4 to work on PHP 5.4. This has been done to reduce frustration for users still using PHP 5.4 and lower; [This does not mean we advocate using software past the end of its life or that we support PHP 5.4 and lower](https://lifterlms.com/docs/minimum-system-requirements-lifterlms/).
v3.16.11 - 2018-02-22
---------------------
+ Course import/exports and lesson duplication now carry custom meta data from 3rd party plugins and themes
+ Added course completion date column to Course reporting students list
+ Restriction checks made against a quiz will now properly cascade to the quiz's parent lesson
+ Fixed issue preventing featured images from being exported with courses and lessons
+ Fixed duplicate lesson issue causing quizzes to be double assigned to the old and new lesson
+ Fixed issue allowing blog archive to be viewed by non-members when sitewide membership is enabled
+ Fixed builder issue causing data to be lost during autosaves if data was edited during an autosave
+ Fixed builder issue preventing lessons from moving between sections when clicking the "Prev" and "Next" section buttons
+ Added actions to `LLMS_Generator` to allow 3rd parties to extend core generator functionality
v3.16.10 - 2018-02-19
---------------------
+ Content added to the editor of course & membership catalog pages will now be output *above* the catalog loop
+ Fix issue preventing iframes and some shortcodes from working when added to a Quiz question description
+ Added new columns to the Quizzes reporting table to display Course and Lesson relationships
+ Improved the task handler of background updater to ensure upgrade functions that need to run multiple times can do so
+ Fixed JS Backup confirmation dialog on the background updater.
+ Add support for 32-bit systems in the `LLMS_Hasher` class
+ Fix issue causing HTML template content to be added to lessons when duplicating an existing lesson within the course builder
##### 3.16.0 migration improvements
+ Accommodates questions imported by 3rd party Excel to LifterLMS Quiz plugin. Fixes an issue where choices would have no correct answer designated after migration.
+ All migration functions now run on a loop. This improves progress reporting of the migration and prevents timeouts on mature databases with lots of quizzes, questions, and/or attempts.
+ Fix an issue that caused duplicate quizzes or questions to be created when the "Taking too long?" link was clicked
v3.16.9 - 2018-02-15
--------------------
+ Fix issue causing error on student dashboard when reviewing an order with an access plan that was deleted.
+ Fixed spelling error on course metabox
+ Fixed spelling error on frontend quiz interface
+ Fixed issues with 0 point questions:
+ Will no longer prevent quizzes from being automatically graded when a 0 point question is in an otherwise automatically gradable quiz
+ Point value not editable during review
+ Visual display on results displays with grey background not as an orange "pending" question
+ Table schema uses default database charset. Fixes an issue with databases that don't support `utf8mb4` charsets.
+ Updated `LLMS_Hasher` class for better compatibility with older versions of PHP
v3.16.8 - 2018-02-13
--------------------
##### Updates
+ Added theme compatibility API so theme developers can add layout options to the quiz settings on the course builder. For details on adding theme compatibility see: [https://lifterlms.com/docs/quiz-theme-compatibility-developers/](https://lifterlms.com/docs/quiz-theme-compatibility-developers/).
+ Quiz results "donut" chart had alternate styles for quizzes pending review (Dark grey text rather than red). You can target with the `.llms-donut.pending` CSS class to customize appearance.
+ Allow filtering when retrieving student answer for a quiz attempt question via `llms_quiz_attempt_question_get_answer` filter
##### Bug Fixes
+ Fix issues causing conditionally gradable question types (fill in the blank and scale) from displaying without a status icon or possible points when awaiting admin review / grading.
+ Fix issue preventing conditionally gradable question types (fill in the blank and scale) from being reviewable on the admin panel when the question is configured as requiring manual grading.
+ Fix analytics widget undefined index warning during admin-ajax calls. Thanks [@Mte90](https://github.com/Mte90)!
+ Fix issue causing `is_search()` to be called incorrectly. Thanks [@Mte90](https://github.com/Mte90)!
+ Fix issue preventing text / html formatting from saving properly for access plan description fields
+ Fix html character encoding issue on reporting widgets causing currency symbols to display as a character code instead of the symbol glyph.
##### Templates changed
+ templates/quiz/results-attempt-questions-list.php
+ templates/quiz/results-attempt.php
v3.16.7 - 2018-02-08
--------------------
+ Added manual saving methods for the course builder that passes data via standard ajax calls. Allows users (hosts) to disable the Heartbeat API but still save builder data.
+ Added an "Exit" button to the builder sidebar to allow exiting the builder back to the WP Edit Post screen for the current course
+ Added dashboard links to the WP Admin Bar to allow existing the course builder to various areas of the dashboard
+ Added data attribute to progress bars so JS (or CSS) can read the progress of a progress bar. Thanks [@dineshchouhan](https://github.com/dineshchouhan)!
+ Fixed issue causing newly created lessons to lose their assigned quiz
+ Fixed php `max_input_vars` issue causing a 400 Bad Request error when trying to save large courses in the course builder
+ Removed reliance on PHP bcmath functions
v3.16.6 - 2018-02-07
--------------------
+ Removed reliance on PHP Hashids Library in favor of a simpler solution with no PHP module dependencies
+ Added interfaces to allow customization of quiz url / slug
+ Fixed [audio] shortcodes added to quiz question descriptions
+ Fixed untranslatable strings on frontend of quizzes
+ Fix issue causing certificate notifications to display as empty
+ Fix issue preventing quiz pass/fail notifications from triggering properly for manually graded quizzes
+ Fix undefined index warning on quiz pass/fail notifications
v3.16.5 - 2018-02-06
--------------------
+ Fix issue preventing manually graded quiz review points from saving properly
+ Improved background updater to ensure scripts don't timeout during upgrades
+ Admin builder JS now minified for increased performance
+ Made frontend quiz and quiz-builder strings output via Javascript translatable
v3.16.4 - 2018-02-05
--------------------
+ Fix issue causing newly created quizzes to not be properly related to their parent lesson
+ Fix issue preventing quiz time limits from starting unless an attempt limit is also set
+ Fixes a WP Engine issue that prevented the builder from loading due to a blocked dependency
v3.16.3 - 2018-02-02
--------------------
+ When switching a quiz to "Published" it will now update the parent lesson to ensure it's recorded as having an enabled quiz.
+ Declared the WordPress heartbeat API script as a dependency for the Course Builder JS. It seems that some servers and hosts dequeue the heartbeat when not explicitly required. This resolves a saving issue on those hosts.
+ Added a Quiz Description content editor under quiz settings. This is the "Editor" from pre 3.16.0 quizzes and any content saved in these fields is now available in this description field
+ Fixed issue causing points percentage calculation tooltip on quiz builder to show the incorrect percentage value
+ Fix issue preventing lessons with no drip settings from being updated on the WP post editor
+ Fix issue causing 500 error on lesson settings metabox for lessons not attached to sections
+ Add a "Quiz Description" field to allow quiz post content to be edited on the quiz builder
+ Added a database migration script to ensure quizzes migrated from 3.16 and lower that had quiz post content to automatically have the optional quiz description to be enabled
v3.16.2 - 2018-02-02
--------------------
+ Add an update notice to 3.16.0 migration scripts to provide more information about the major update.
+ Removed quiz assignment fields on the lesson metabox to reduce confusion as quizzes are now managed exclusively on the quiz builder.
+ Ensure questions migrated during 3.16 updates retain their initial points value from the quiz.
v3.16.1 - 2018-02-01
--------------------
+ Ensure quizzes in draft mode are only accessible by those with edit access (instructors, admins, etc...)
+ Restore pre 3.16 actions and filters related to quiz start buttons
+ Remove legacy error message for quiz accessibility issues by site admins
+ Students who cannot access a quiz are redirected to the parent lesson if they attempt to access a quiz directly
+ Fix undefined index warning on wp-login.php related to LifterLMS js assets. Thanks [Mte90](https://github.com/Mte90)!
+ Update checkout error message to provide user with direction when they already have access to a course. Thanks [@andreasblumberg](https://github.com/andreasblumberg)!
v3.16.0 - 2018-02-01
--------------------
##### Quizzes
+ New question types: True/False, Picture Choice, and Non-question content
+ Picture & Multiple choice have options for multiple correct answers (checkbox-like questions)
+ You can now create questions with NO POINTS (maybe for surveys?)
+ Upgraded student quiz review interface
+ Upgraded instructor quiz attempt review interface
+ Admins may now leave remarks on questions directly
+ Improved data available related to quizzes and quiz attempts on reporting screens
+ Improved quiz user interface
+ Added a progress bar to the quiz interface
+ Shrunk the quiz timer
+ Added a question # counter on the quiz interface
+ Fixed issue causing randomized questions to get "lost" when navigating back through a quiz attempt
+ Improved error handling on quizzes
+ Overhauled quiz data structure for improved performance and scalability
+ Requires database migration and update: [3.16.0](https://lifterlms.com/docs/lifterlms-database-updates/#3160)
##### Course Builder Improvements
+ Quiz-building is now available on the course builder
+ Quiz and Question WordPress editors no longer available. Quizzes and Questions HAVE NOT DISAPPEARED, they've been improved and relocated
+ All hooks & filters attached to `the_content` and `the_title` are now being removed when loading the course builder. This should prevent infinite spinners on builder loading and builder AJAX calls due to third-parties accidentally outputting html during these events.
##### Updates
+ Added space between arrows and "Next" and "Previous" text on pagination lists. Thanks [sujaypawar](https://github.com/sujaypawar)!
+ Updated Quiz post type slug from "llms_quiz" to "quiz".
+ Updated default return of `llms_get_post()` to be `false` rather than a `WP_Post` object when a LifterLMS post cannot be located
##### Bug Fixes
+ Fixed a potential database read error related to database store abstract
+ Now passing Post ID as second parameter to the `the_title` filter called on post model getters
##### Removed templates
The following quiz templates have been removed. Customization of these templates causes quiz application functionality to break and they should not have been available for customization but were due to oversights. This has been corrected.
+ templates/content-single-question-after.php
+ templates/content-single-question-before.php
+ templates/quiz/next-question.php
+ templates/quiz/previous-question.php
+ templates/quiz/question-count.php
+ templates/quiz/quiz-question.php
+ templates/quiz/single-choice.php
+ templates/quiz/single-choice_ajax.php
+ templates/quiz/summary.php
+ templates/quiz/timer.php
+ templates/quiz/wrapper-end.php
+ templates/quiz/wrapper-start.php
##### Removed Functions
Various template functions related to quizzes were removed due to the deprecation of their related templates
+ `lifterlms_template_quiz_timer()`
+ `lifterlms_template_single_next_question()`
+ `lifterlms_template_single_prev_question()`
+ `lifterlms_template_single_single_choice()`
+ `lifterlms_template_single_single_choice_ajax()`
+ `lifterlms_template_single_question_count()`
v3.15.1 - 2017-12-05
--------------------
+ Ensure course & membership titles with HTML characters are decoded during reporting exports
+ Fix issue causing some courses to display in membership columns on reporting exports
v3.15.0 - 2017-12-04
--------------------
##### Reporting Updates (and CSV exports!)
+ Added course-level reporting table (see "Courses" tab of Reporting screen)
+ Updated the interface on reporting screen when reviewing a single student
+ Added reporting exports: students list, courses list, and list of students per course
##### Bug fixes
+ Fix error when `[lifterlms_course_continue_button]` shortcode is displayed to logged out or students not enrolled in the chosen course
##### Minor updates
+ Tested up to WordPress 4.9.1
+ Added background data processors to ensure reporting data stays up to date in close to real time
+ Add nocache constants and headers on student dashboard & checkout page to increase compatibility with caching plugins
+ Added filter to student dashboard courses query
v3.14.9 - 2017-11-27
--------------------
+ Tested up to WordPress 4.9
+ Fix error during uninstall related to missing file
+ Fix issue with rewinding quiz using "Previous Question" button
+ On final question of a quiz the "Next Lesson" button now says "Complete Quiz"
+ When completing a quiz, the loading message will now say "Grading Quiz" the entire time instead of "Loading Question" and then "Grading Quiz"
+ Fix issue causing the `` element on course builder pages from being partially empty
v3.14.8 - 2017-11-06
--------------------
+ Lessons can be cloned via the "Clone" action from the lessons post table
##### Builder Improvements & Fixes
+ Add "Existing Lesson" functionality can now clone and attach the clone (when adding a lesson currently attached to a course) OR attach orphans
+ Lessons created via Course builder will have their slugs renamed the first time the lesson title is updated via the builder
+ No longer display notices on the course builder
+ Add extra space to the scrollable area on course builder
+ Removed logging and debugging functions from admin builder class
+ JS-generated error messages on the course builder are now translatable
##### Bug Fixes
+ Fix: Show all memberships on dashboard
v3.14.7 - 2017-10-25
--------------------
##### Navigation Menu Items
+ Add LifterLMS endpoints to your nav menu
+ Add Sign In and Sign Out links which display conditionally based on whether or not the visitor is logged in
+ Checkout the docs at [https://lifterlms.com/docs/lifterlms-navigation-menu-items/](https://lifterlms.com/docs/lifterlms-navigation-menu-items/)
##### Bug Fixes
+ Fix SQL query issue with orphaned lesson query on course builder
+ Fix undefined index warning occurring during theme switches
+ Fix issue causing duplicate error messages to display on certain servers
v3.14.6 - 2017-10-21
--------------------
+ Fix: `<iframes>` are no longer stripped when exporting or duplicating courses (this applies to lessons within the courses as well)
+ Fix: Achievements on student dashboard now output the correct achievement title
+ Fix: Courses on student dashboard ordered by Order attributes will obey settings correctly
v3.14.5 - 2017-10-14
--------------------
+ Course builder will persist open/collapsed state of sections when they are re-ordered
+ Course builder lessons in a section are draggable after reordering a section
v3.14.4 - 2017-10-13
--------------------
+ You were right and we were wrong & we are sorry. This update returns the ability to add existing lessons to a course via the course builder.
+ Lessons added to a section will no longer visually disappear when editing a section title on the course builder
+ BuddyPress integration BP template fixes
v3.14.3 - 2017-10-12
--------------------
+ Fix [lifterlms_my_account] shortcode issue affecting Divi theme users
v3.14.2 - 2017-10-11
--------------------
+ Instructor query utilizes correct `$wpdb->prefix` for filtering by role instead of `wp_` which will not work when the `$table_prefix` in wp-config.php is customized
+ include the admin notices class when running database update functions
v3.14.1 - 2017-10-10
--------------------
+ Fix `[lifterlms_my_achievements]` shortcode
+ Fix reference to deprecated core function related to checking the permissions of content restricted to a membership
+ Builder titles will be saved on all field focusout/blur events, not just tab & enter key presses
+ LifterLMS custom meta save metaboxes will not trigger actions during ajax requests
+ Fix issue displaying certificates on admin panel reporting screens
v3.14.0 - 2017-10-10
--------------------
+ Updated JS for 3.13 course builder to address issues on PHP 5.6 servers with asp_tags enabled
+ Normalized date returns with various dates related to enrollments, achievements, and certificates. These dates now utilize the WP Core `date_format` option.
+ Fixed strict comparison issue related to database query abstract (affected checks for last page & first page on admin reporting screens)
+ Added a new capability `llms_instructor` for admins, lms managers, instructors, and instructor's assistant to easily differentiate "instructors" from "students"
+ Fix `$wpdb->prepare` issue related to notification queries. Fixes WP 4.9-beta issue.
##### Student Dashboard Updates
+ Achievements on student dashboard now viewable in popover modal.
+ Achievements tab added to student dashboard
+ Courses, Memberships, Achievements, and Certificates have been updated to have a unified style
+ Courses & Memberships extend the default catalog tiles
+ Courses shortcode has new parameters useful for displaying a list of a specific users courses only. [More info](https://lifterlms.com/docs/shortcodes/#lifterlms_courses)
##### Deprecated functions
+ `LLMS_Student_Dashboard::output_courses_content()` replaced with `lifterlms_template_student_dashboard_my_courses( false )`
+ `LLMS_Student_Dashboard::output_dashboard_content` replaced with `lifterlms_template_student_dashboard_home()`
##### Template Updates
+ [achievements/loop.php](https://github.com/gocodebox/lifterlms/blob/master/templates/achievements/loop.php)
+ [achievements/template.php](https://github.com/gocodebox/lifterlms/blob/master/templates/achievements/template.php)
+ [certificates/loop.php](https://github.com/gocodebox/lifterlms/blob/master/templates/certificates/loop.php)
+ [certificates/preview.php](https://github.com/gocodebox/lifterlms/blob/master/templates/certificates/preview.php)
+ [loop.php](https://github.com/gocodebox/lifterlms/blob/master/templates/loop.php)
+ [loop/content.php](https://github.com/gocodebox/lifterlms/blob/master/templates/loop/content.php)
+ [loop/enroll-date.php](https://github.com/gocodebox/lifterlms/blob/master/templates/loop/enroll-date.php)
+ [loop/enroll-status.php](https://github.com/gocodebox/lifterlms/blob/master/templates/loop/enroll-status.php)
+ [loop/pagination.php](https://github.com/gocodebox/lifterlms/blob/master/templates/loop/pagination.php)
+ [myaccount/dashboard-section.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/dashboard-section.php)
+ [myaccount/dashboard.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/dashboard.php)
+ [myaccount/header.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/header.php)
##### Deleted Templates
+ /myaccount/my-achievements.php
+ /myaccount/my-courses.php
+ /myaccount/my-memberships.php
v3.13.1 - 2017-10-04
--------------------
+ Fix caching issue preventing quiz pass & fail engagements from triggering.
+ Fix issue causing the "Builder" link to display on the lesson post table screen.
+ Fix issue preventing new courses & memberships from being moved from draft -> published.
+ Fix `wpdb->prepare()` empty placeholder issue related to engagement queries. Fixes warning added in WP 4.9.
+ Add better version numbering to static assets to prevent caching issues during plugin updates
v3.13.0 - 2017-10-02
--------------------
##### An All New Course Builder
+ The "Course Outline" metabox found on the admin panel when editing any LifterLMS course has been savagely beaten. We stole its lunch money and we put it towards the construction of an all interface
+ Asynchronous loading: fixes issues where very large courses would drastically slow and possibly even time out the loading of the course edit screen
+ Course outline is now collapsible and expandable. This Fixes issues where it was very hard to move lessons and sections around on very large courses
+ In addition to the familiar (and now improved) drag and drop functionality, you may now also move sections and lessons up and down with button clicks. You can also move lessons between sections with button clicks
+ Add new lessons and sections with a click or drag a new lesson or section into the existing course
+ Edit section and lesson titles faster with inline title editing. No more modals with a potentially slow ajax load to update a title. Click the title, change it, and exit the field to automatically save!
+ Delete sections and lessons with the click of a button
+ Quick links to view (frontend) and edit (backend) lessons
+ Completely internationalized. Thanks for you patience translators!
+ Want to know more? Check out the [docs](https://lifterlms.com/docs/using-course-builder/).
##### New User Roles
+ Added new roles to enable you to provide access to LifterLMS (settings, courses building, etc...) without having to make an admin or mess with complicated code snippets.
+ New Roles:
+ LMS Manager: Do everything in LifterLMS and nothing with plugins, themes, core settings, and so on
+ Instructor: Create, update, and delete courses and memberships
+ Instructor's Assistant: Edit courses and memberships
+ More details and a full list of new LifterLMS capabilities are available [here](https://lifterlms.com/docs/roles-and-capabilities/).
##### Updates & Fixes
+ Tested up to WordPress 4.8.2
+ The "Lesson Tree" metabox has been replaced with a simplified version of the lesson tree and a link to the launch the Course Builder.
+ Course and membership categories and tags will now display on their respective post tables for sorting and filtering. They can be disabled on a per-user basis via the screen options.
+ Removed `var_dump()` from bbPress integration restriction check
##### Uninstall Script
+ Uninstall script now removes all the things LifterLMS creates in your database if a constant is defined. Read more [here](https://lifterlms.com/docs/remove-lifterlms-data-plugin-uninstallation/).
##### Database Update
+ Adds default Instructor data for all LifterLMS Courses & Memberships based off of the post author of the course or membership
+ [More information](https://lifterlms.com/docs/lifterlms-database-updates/#3130)
##### Template Updates
+ [admin/post-types/students.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/post-types/students.php)
+ [admin/reporting/tabs/students/courses.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/reporting/tabs/students/courses.php)
##### Deprecated Functions
+ The following AJAX functions are no longer utilized by LifterLMS core. If you are utilizing them find alternatives (they all exist). These will be remove in the next **major** release:
+ `LLMS_AJAX::get_achievements()`
+ `LLMS_AJAX::get_all_posts()`
+ `LLMS_AJAX::get_associated_lessons()`
+ `LLMS_AJAX::get_certificates()`
+ `LLMS_AJAX::get_courses()`
+ `LLMS_AJAX::get_course_tracks()`
+ `LLMS_AJAX::get_emails()`
+ `LLMS_AJAX::get_enrolled_students()`
+ `LLMS_AJAX::get_enrolled_students_ids()`
+ `LLMS_AJAX::get_lesson()`
+ `LLMS_AJAX::get_lessons()`
+ `LLMS_AJAX::get_lessons_alt()`
+ `LLMS_AJAX::get_memberships()`
+ `LLMS_AJAX::get_question()`
+ `LLMS_AJAX::get_sections()`
+ `LLMS_AJAX::get_sections_alt()`
+ `LLMS_AJAX::get_students()`
+ `LLMS_AJAX::update_syllabus()`
##### Removed Filters
+ The following filters have been removed and are no longer in use.
+ `lifterlms_admin_courses_access`: replaced with user capability `edit_courses`
+ `lifterlms_admin_membership_access`: replaced with user capability `edit_memberships`
+ `lifterlms_admin_reporting_access`: replaced with user capability `manage_lifterlms`
+ `lifterlms_admin_settings_access`: replaced with user capability `manage_lifterlms`
+ `lifterlms_admin_import_access`: replaced with user capability `manage_lifterlms`
+ `lifterlms_admin_system_report_access`: replaced with user capability `manage_lifterlms`
v3.12.2 - 2017-09-18
--------------------
##### Bug fixes
+ Fix issue with LifterLMS bbPress integration preventing course-restricted topics from being accessible by enrolled students
+ Fix an issue preventing students expired from courses via access expiration settings from being manually re-enrolled by admins
##### Deprecations
+ `LLMS_Student` class function `has_access` is scheduled for deprecation in next major release. Developers should switch to `LLMS_Student->is_enrolled()`
v3.12.1 - 2017-08-25
--------------------
+ Prevent duplicate loading of repeater metabox fields
+ Fix undefined warning related to quiz completion
+ Ensure that the bbPress course forums shortcode & widget properly cascade up when used on a lesson or quiz
v3.12.0 - 2017-08-17
--------------------
+ New quiz feature: randomize the order of quiz questions each attempt! Props to [Larry Groebe](https://github.com/larrygroebe)
+ Fixed logic error related to access checks when bubbling from quiz->lesson->course
+ Fixed JS loader check for tinyMCE editors in repeater fields
+ Fixed CSS issue related to tinyMCE editors in repeater fields
+ Fixed issue causing tinyMCE editors in repeater fields to stop working after reordering rows
+ LifterLMS alert box notices are now cleared during shutdown instead of immediately after rendering. Fixes some plugin compatibility issues.
+ Fix reference to invalid meta key on order notes admin screen.
+ Record order note when orders with a defined length complete
+ When a payment is scheduled for an order with a defined length, calculate end date if no end date is saved
+ Minor updates to the `LLMS_Abstract_Integration` class
+ Fix undefined reference error on 404 pages resulting from the preview manager.
##### bbPress Integration Updates
+ Add "Private" Course Forums which allows forums to be made available only to students enrolled in the associated course
+ Adds a shortcode and widget for outputting a list of forums associated with a course
+ Adds the ability to restrict the page set as the bbPress forum index (via bbPress settings) to be restricted to LifterLMS memberships
+ Adds engagement triggers to allow engagements to be fired when a student posts a reply or creates a new topic
+ Improves integration membership restriction check performance
+ Migrated to the `LLMS_Abstract_Integration` class. Visually changes the settings display but has no other impact
+ [More information](https://lifterlms.com/docs/lifterlms-and-bbpress/)
##### BuddyPress Integration Updates
+ Add the ability to restrict activity, group, and member directory pages to LifterLMS memberships.
+ Migrated to the `LLMS_Abstract_Integration` class. Visually changes the settings display but has no other impact
+ [More information](https://lifterlms.com/docs/lifterlms-and-bbpress/)
##### Database update
+ calculate and store end dates for orders created prior to version 3.11.0 which have a defined length and do not have a stored end date.
+ migrate bbPress and BuddyPress options to `LLMS_Abstract_Integration` naming convention
+ [More information](https://lifterlms.com/docs/lifterlms-database-updates/#3120)
##### Admin Post Table Upgrades
+ Lessons
+ Fix section titles which formerly were a dead link. Now they're just text
+ Add filtering the table by associated course
+ Quizzes
+ Display associated course and lesson columns with links
+ Add filtering by associated course and/or lesson
+ Quiz Questions
+ Display associated Quizzes with links
+ Add filtering by associated quiz
##### Template Updates
+ [admin/post-types/order-details.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/post-types/order-details.php)
v3.11.2 - 2017-08-14
--------------------
+ Tested up to WP Core 3.8.1
##### System Status and Reporting updates
+ System Report renamed to "Status"
+ Added information of template overrides to the system report
+ Added "Get Help" button linking to LifterLMS Ticketing submission page
+ Added "Logs" tab which allows for easy viewing & management of LifterLMS logs
+ Added "Tools and Utilities" tab and moved tools from the General Settings screen to this tab
+ Improved Session Reset tool
v3.11.1 - 2017-08-03
--------------------
+ New shortcode: `[lifterlms_course_continue_button]`. See [shortcode docs](https://lifterlms.com/docs/shortcodes/#lifterlms_course_continue_button) for more information.
+ New shortcode: `[lifterlms_lesson_mark_complete]`. See [shortcode docs](https://lifterlms.com/docs/shortcodes/#lifterlms_lesson_mark_complete) for more information.
+ Added filter `llms_product_pricing_table_enrollment_status` to allow forceful display of course/membership pricing tables regardless of user enrollment status.
+ Fix course author shortcode to allow usage outside of a course via the `course_id` parameter.
##### Template Updates
+ [product/pricing-table.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/pricing-table.php)
+ [product/course/progress.php](https://github.com/gocodebox/lifterlms/blob/master/templates/product/course/progress.php)
v3.11.0 - 2017-07-31
--------------------
+ New engagement trigger "Student purchases access plan" allows engagements to be triggered from a specific access plan!
+ Minor performance improvements to notification-related database queries
+ Fix issue causing payment gateways to always use test mode links from Orders on the admin panel
+ Added default email notification merge code for outputting an HTML divider
+ Added new actions to Dashboard template to allow adding custom content to course tiles on the dashboard
##### Template Updates
+ [myaccount/my-courses.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/my-courses.php)
v3.10.2 - 2017-07-14
--------------------
+ Fix fatal error related to purchase receipts for trashed or deleted orders
+ l10n "Reviews" tab title on course settings
+ Remove commented out sample preheader text from email header template which was displaying in some email clients.
##### Template Updates
+ [emails/header.php](https://github.com/gocodebox/lifterlms/blob/master/templates/emails/header.php)
v3.10.1 - 2017-07-12
--------------------
##### Bugfixes
+ Prevent errors related to attempting to display notification data related to deleted students
+ Fix errors related to displaying notifications for deleted post (courses, sections, lessons, quizzes, etc...)
+ Fix error causing email notifications being sent after related user has been deleted
+ Fix typo preventing `llms_form_field()` from outputting textareas
##### Updates
+ Add new filter `llms_allow_subscription_cancellation` useful for preventing students from self-cancelling their subscriptions on the student dashboard. [More info](https://lifterlms.com/docs/lifterlms-filters/#llms_allow_subscription_cancellation).
+ Add new API for querying students via AJAX select2 elements
+ Select2 Post Query elements can now query multiple post types simultaneously
+ Select2 Post Query elements can now support `<optgroup>`
###### i18n
+ Course option metabox for reviews is not translatable
v3.10.0 - 2017-07-05
--------------------
##### Recurring Order Management (for Admins)
+ Admins can now edit various pieces of data related to a recurring order from the order screen on the admin panel
+ Allow editing of the Next Payment Date
+ Allow editing of the Trial End Date (when a trial is active for the order)
+ Edit Payment Gateway and related gateway fields (Customer ID, Source ID, and Subscription ID)
+ If you're using LifterLMS Stripe or LifterLMS PayPal please update to the latest version of these add-ons to take advantage of these new features!
##### Recurring Order Management (for Students)
+ Students can now switch the payment method (source) for their recurring subscriptions from the student dashboard
+ Students can now cancel their recurring orders to prevent future payments on recurring orders
+ If you're using LifterLMS Stripe or LifterLMS PayPal please update to the latest version of these add-ons to take advantage of these new features!
##### Automatic Payment Retries (for supporting gateways)
+ LifterLMS Stripe and LifterLMS PayPal can now automatically retry failed payments to help recover lost revenue as a result of temporary declines to payment sources. Please see our documentation on this new feature [here](https://lifterlms.com/docs/automatic-retry-failed-payments/).
+ If you're using LifterLMS Stripe or LifterLMS PayPal please update to the latest version of these add-ons to take advantage of these new features!
##### Manual Payment Gateway Enhancements
+ The Manual Payment Gateway (bundled with LifterLMS Core) can now handle recurring payments. For more information on utilizing recurring payments with the Manual Gateway please see the [gateway documentation](https://lifterlms.com/docs/using-lifterlms-manual-payment-gateway/).
##### Updates and Fixes
+ Force SSL setting now applies to Student Dashboard screens. This is useful as Google now recommends any page where a password is submitted should be encrypted and allows gateway communication from student dashboard screen with APIs that require an SSL connection.
+ Fixed spelling error related to quizzes
##### Templates changed
**NEW**
+ [checkout/form-switch-source.php](https://github.com/gocodebox/lifterlms/blob/master/templates/checkout/form-switch-source.php)
+ [myaccount/view-order-transactions.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/view-order-transactions.php)
**UPDATED**
+ [admin/post-types/order-details.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/post-types/order-details.php)
+ [myaccount/my-orders.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/my-orders.php)
+ [myaccount/navigation.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/navigation.php)
+ [myaccount/view-order.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/view-order.php)
+ [quiz/summary.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/summary.php)
v3.9.5 - 2017-06-13
-------------------
+ Increased css z-index of basic notifications to prevent issues with themes that have high z-index on menus and other elements
+ Increased the frequency of basic notification heartbeat check from 10 to 20 seconds
+ Added filter to allow for customization of the notifications heartbeat interval, example [here](https://lifterlms.com/docs/lifterlms-filters/#llms_notifications_settings).
+ Fixed error related to password reset when the "Disable Usernames" account setting is disabled
v3.9.4 - 2017-06-12
-------------------
+ Fix hardcoded db reference to `wp_posts` table
v3.9.3 - 2017-06-09
-------------------
+ Fix typo in notifications query
v3.9.2 - 2017-06-07
-------------------
+ Tested up to WordPress 4.8
+ Fixed issue with merge codes on WP Editors for notifications, emails, etc...
+ Update notifications query to only return results related to posts which actually exist. Prevents errors occurring when reviewing achievements on the student dashboard for courses, lessons, etc which have been deleted/trashed.
+ Only display quiz time limit meta information when a time limit exists
+ Fix display of quiz question order (question x of x)
+ Improved logic powering quiz attempt grading for increased consistency, especially with regards to floats and rounding
##### Templates Changed
+ [quiz/meta-information.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/meta-information.php)
+ [quiz/question-count.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/question-count.php)
v3.9.1 - 2017-06-02
-------------------
+ Fix engagement triggers with relation to quizzes to properly receive 3.9 api updates
+ Fix quiz attempt counting issue resulting in the total attempts by a student always being one more than the actual value
+ Fix membership access plan restrictions tooltip
v3.9.0 - 2017-06-02
-------------------
##### Quizzes
+ All new quiz results interface for students
+ Donut charts are now animated
+ Donuts will be green for passing attempt and red for failing
+ Students can now review previous quiz attempts and summaries
+ Removed the juxtaposition of the current and best attempts to reduce confusion on the interface
+ Improved the consistency of the quiz meta information markup
+ Adjusted various pieces of language for an improved student experience
+ Improvements to the quiz taking experience
+ Added the LLMS_Spinner (seen on checkout screens and various places on the admin panel) and various loading messages when starting quiz, transitioning between questions, and completing a quiz
+ Better error handling and management should issues arise during a quiz
+ Better unload & beforeunload JS management to warn students when they attempt to leave a quiz in progress
+ Improved quiz data handling and management
+ Improved API calls and handlers related to taking quizzes for increased performance and consistency
+ quiz data can now be programmatically queried via consistent apis and data classes, see `LLMS_Student->quizzes()` and `LLMS_Quiz_Attempt`
+ Quizzes no longer rely on session and cookie data. All quiz data will always be saved directly to the database and related to the student. Fixes an issue on certain servers preventing student from starting quizzes.
+ Deprecated `LLMS_Quiz::start_quiz()`, `LLMS_Quiz::answer_question()`, and, `LLMS_Quiz::complete_quiz()`
+ Ajax handler functions of the same names should be used instead.
+ To programmatically "take" quizzes use related functions of similar names from the `LLMS_Quiz_Attempt` class
##### Templates changed
+ New
+ [quiz/meta-information.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/meta-information.php)
+ Updated
+ [admin/reporting/tabs/students/courses.php](https://github.com/gocodebox/lifterlms/blob/master/templates/admin/reporting/tabs/students/courses.php)
+ [content-certificate.php](https://github.com/gocodebox/lifterlms/blob/master/templates/content-certificate.php)
+ [course/complete-lesson-link.php](https://github.com/gocodebox/lifterlms/blob/master/templates/course/complete-lesson-link.php)
+ [myaccount/my-notifications.php](https://github.com/gocodebox/lifterlms/blob/master/templates/myaccount/my-notifications.php)
+ [quiz/next-question.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/next-question.php)
+ [quiz/previous-question.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/previous-question.php)
+ [quiz/question-count.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/question-count.php)
+ [quiz/quiz-question.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/quiz-question.php)
+ [quiz/quiz-wrapper-end.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/quiz-wrapper-end.php)
+ [quiz/quiz-wrapper-start.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/quiz-wrapper-start.php)
+ [quiz/results.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/results.php)
+ [quiz/return-to-lesson.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/return-to-lesson.php)
+ [quiz/single-choice_ajax.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/single-choice_ajax.php)
+ [quiz/start-button.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/start-button.php)
+ [quiz/summary.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/summary.php)
+ Removed
+ quiz/attempts.php - replaced by [quiz/meta-information.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/meta-information.php)
+ quiz/passing-percent.php - replaced by [quiz/meta-information.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/meta-information.php)
+ quiz/time-limit.php - replaced by [quiz/meta-information.php](https://github.com/gocodebox/lifterlms/blob/master/templates/quiz/meta-information.php)
##### Fixes
+ Student Dashboard notifications page will not display pagination links unless there's results to page through
+ Student Dashboard notifications page will now display a message when no notifications are found
+ Certificate previewing now takes into consideration the preview setting roles to allow admins (or other roles) to preview certificates
+ Made student name self fallback (you) i18n friendly
v3.8.1 - 2017-05-21
-------------------
+ Fix merge code issue related to course title on quiz notifications
v3.8.0 - 2017-05-20
-------------------
+ Automatic email and basic (on-screen) notifications for various events within LifterLMS
+ All notifications can be customized
+ Email notifications can be optionally sent to custom email address, course authors, and more
+ Students will automatically receive email receipts when making purchases and when recurring access plans rebill
+ Hidden Access Plans
+ Add a "Purchase Link" view button to access plans so admins can quickly grab the direct URL to an access plan
+ Notifications history screen on Student Dashboard to review past notifications that have been received
+ Updated LLMS_Email class and functionality
+ Email templates have been completely rewritten and styled
+ Updated and rewritten password reset flow
+ Earned certificates are only accessible by the student who earned the certificate
+ Added the functionality for image upload via options & settings api
+ Removed a handful of unused templates related to LifterLMS certificates that were replaced a long time ago but still existed in the codebase for unknown reasons.
+ Fixed filter on engagements settings page
+ Minor adjustments to language and settings order on Engagements settings screen for email settings
+ Email Header Image field is now an upload field as opposed to a "paste a url here" setting
+ Phone number recorded to order and displayed on order for admin panel during purchases
+ Order details now display full country name as opposed to the country code
+ Fix installation script to ensure admin can preview by default
v3.7.7 - 2017-05-16
-------------------
+ Updated a few strings on the admin panel to be translatable
+ Fix PHP warning output during plugin activation
+ Fix reporting issue related to outputting quiz question answers where the correct answer is the first available answer
+ Fix PHP 7.1 issue on the checkout screen
+ Removed some unnecessary files from vendor libraries
v3.7.6 - 2017-05-05
-------------------
+ New translations for new categories on Add-ons screen
+ Update to general settings which utilizes featured items from the general settings screen
+ Update readme & related meta files
+ Removed advert image files
v3.7.5 - 2017-05-02
-------------------
+ Upgrade WP Session Manager to latest version
+ Code style updates across most files in codebase to bring to most recent styling guidelines put forth by [WP Coding Standards](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards)
v3.7.4 - 2017-04-26
-------------------
+ When cloned site detected automatically disable recurring_payments feature & trigger an action 3rd parties can hook into for custom 3rd party features
+ Add better JS dependency management to prevent issues where assets loaded in the wrong order
+ Fix issue where dismiss icon on LifterLMS admin notices was positioned poorly on non-LifterLMS admin screens
+ Fix issue preventing edit account form submission on student dashboard when password strength meter is disabled
v3.7.3 - 2017-04-21
-------------------
+ Fixed issues where Course Track checks were not functioning properly with relation to prerequisite associations
+ `LLMS_Generator` can now be used to generate course(s) from a raw array of course data using the SingleCourseGenerator and BulkCourseGenerator
+ `LLMS_Generator` default post status can be set at runtime using `set_default_post_status()`
+ Fixed an issue causing JS errors on the `wp-login.php` screen
+ Tested up to WordPress 4.7.4
### Template Updates
+ `course/prerequisites.php` - Prerequisite checks check for 'course_track' rather than 'track'
v3.7.2 - 2017-04-17
-------------------
+ Resolved a JS errors on admin panel resulting from overly strict asset loading added in 3.7.0
v3.7.1 - 2017-04-14
-------------------
+ Fix php notice when no roles are selected for preview management feature
v3.7.0 - 2017-04-13
-------------------
**Preview Management**
+ All new view management for users to make editing content easier for course builders
+ Admins may customize the roles of users who can access view management
+ Qualifying users can view content as an enrolled student or a non-enrolled visitor
+ Default view allows users to bypass all restrictions (drip, membership, enrollment, and so on) for easy course navigation and management
+ Thanks to [@fabianmarz](https://github.com/fabianmarz) and the team at and the team at [netzstrategen](https://github.com/netzstrategen) for their assistance with this feature!
**Improvements**
+ Edit Account Screen now utilizes updated APIs for better customization management
+ Improve intelligence of enqueued admin js & css files
**Fixes**
+ Fixed coupon calculation issue related to currencies using commas as the decimal separator
+ Properly display track related information when reviewing engagements on the admin panel
+ fixed issue preventing course tracks from being recorded as completed
v3.6.2 - 2017-04-10
-------------------
+ Fix issue preventing export of vouchers via email
+ added action `after_llms_mark_complete` to allow custom actions to happen after a course, lesson, etc... is marked complete
v3.6.1 - 2017-03-28
-------------------
+ Fix issue related to taking a quiz for the first time when no quiz data is available for a user
+ Fix issue when course outline shortcode is displayed on non LifterLMS post types
v3.6.0 - 2017-03-27
-------------------
+ Courses and Memberships now have settings to control their visibility in catalogs and search results. For more information visit the [knowledge base](https://lifterlms.com/docs/course-membership-visibility-settings/).
+ Courses are now a searchable post type. All existing courses will automatically remain excluded from search via new catalog visibility settings. New courses added after this date will be searchable unless the visibility is updated prior to publishing the course.
+ Added options (and filters) to allow customization of the order of courses displayed on the Student Dashboard
+ Existing behavior (ordered by enrollment date, most recent to least recent) will be preserved
+ New installations will default (by popular demand) to Order (Low to High) which will obey the "Order" settings of courses
+ Customize or update the order for your site by visiting LifterLMS -> Settings -> Accounts and changing the setting for "Courses Sorting" under "Account Dashboard"
+ New Shortcodes:
+ `[lifterlms_course_author]` - Display the Course Author's name, avatar, and (optionally) biography. [Info & Usage](https://lifterlms.com/docs/shortcodes/#lifterlms_course_author)
+ `[lifterlms_course_continue]` - Display a progress bar and continue button for enrolled students only. [Info & Usage](https://lifterlms.com/docs/shortcodes/#lifterlms_course_continue)
+ `[lifterlms_course_meta_info]` - Display all meta information for a course. [Info & Usage](https://lifterlms.com/docs/shortcodes/#lifterlms_course_meta_info)
+ `[lifterlms_course_prerequisites]` - Display a notice describing unfulfilled prerequisites for a course. [Info & Usage](https://lifterlms.com/docs/shortcodes/#lifterlms_course_prerequisites)
+ `[lifterlms_course_reviews]` - Display reviews and review form for a LifterLMS Course. [Info & Usage](https://lifterlms.com/docs/shortcodes/#lifterlms_course_reviews)
+ `[lifterlms_course_syllabus]` - Display the course syllabus. [Info & Usage](https://lifterlms.com/docs/shortcodes/#lifterlms_course_syllabus)
+ "Back" & "Next" pagination links on Student Dashboard View Courses are now buttons instead of text links
+ Fixed an issue preventing pagination links from displaying on the "View Courses" page of the student dashboard when the endpoint slug was customized
+ Course and Membership taxonomy archive pages will now properly match the heights of tiles
+ Fixed typo in `lifterlms_get_enrollment_status_name` filter
+ Fixed typo in `lifterlms_get_order_status_name` filter
+ Reduced complexity and redundancy of `llms_get_enrolled_students()`
v3.5.3 - 2017-03-21
-------------------
+ Ensure that access plan subscription schedule details are fully translatable
+ Ensure "Services" title on admin add-ons screen can be translated
+ Fix "View All My Courses" link on Student Dashboard to obey endpoint slug customizations
+ Membership restriction checks only run on singular posts (not on archives)
+ Ensure `[lifterlms_course_outline]` and Course Syllabus widget can be used on Quizzes.
+ Fix reporting widgets for course & lesson completions to report the correct completion types only
v3.5.2 - 2017-03-16
-------------------
+ Fix course outline shortcode when used on a lesson
+ Fix custom html form fields produced by `llms_form_field()`
v3.5.1 - 2017-03-15
-------------------
+ Lessons marked as incomplete will now display as incomplete in the course outline generated by the above Course Syllabus Widget and the course outline shortcode
+ Updated course outline shortcode / course syllabus widget to utilize new APIs
+ The template at `templates/course/outline-list-small.php` updated to reflect above changes. If you're overriding this template please review the changes and update accordingly
+ Fix issue preventing course auto advance on lesson completion
+ Shortcodes added within `[lifterlms_hide_content]` will now be processed
v3.5.0 - 2017-03-13
-------------------
+ New course setting **Retake Lessons** allows students to mark lessons as "incomplete" after completing lessons. Admins may enable this site-wide setting under Settings -> Courses.
+ Course and Membership catalog per page settings will now only accept numbers
+ "Catalogs" settings tab has been split into "Course" and "Membership" settings
+ Settings added via filter `lifterlms_catalogs_settings` will be added to the "Course" settings tab and deprecated in the next major release
+ Default course and membership catalog courses per page changed to 9. Previous default was 10 which results in a 4th row on catalogs with only one item.
+ Tweaked size of LifterLMS admin tab menu items
+ Pass API Mode Context to links generated by LifterLMS payment gateways
+ Fixed typo on general settings screen
+ Moved LifterLMS Add-on Banners from General Settings to an Add-Ons menu
+ If required fields exist on checkout and are empty during free quick enrollment users will be redirected to the normal checkout page where they can enter required fields
+ Updated action scheduler lib to latest version. Minor changes, fixes compatibility with WooMemberships.
+ Recent activity stats widgets on general settings screen updated to be more reliable and accurate (and performant!)
+ Added 3 new widgets to enrollments reporting tab: courses completed, lessons completed, and user registrations
v3.4.8 - 2017-03-07
-------------------
+ Tested to WordPress Version 4.7.3
+ Fixed undefined index notice on admin panel
+ Added a real description to new `_nx()` functions
+ Access plan trial periods now allow proper translations
v3.4.7 - 2017-03-03
-------------------
+ Ensure run when the `lifterlms_db_version` option doesn't exist in the database
v3.4.6 - 2017-03-03
-------------------
+ Fixed a text domain typo preventing translation of "Correct Answer" on quiz results screen
+ Ensure access plan "periods" are translatable
+ Now using `date_i18n()` for certificate dates so that dates are properly localized
+ Load plugin textdomain during `init` rather than `plugins_loaded`
v3.4.5 - 2017-02-23
-------------------
+ Ensure free access plans are available to logged out users
v3.4.4 - 2017-02-22
-------------------
+ Added a popup to warn students when leaving a quiz they've already started
+ Enable removal of student quiz attempts by admins from student reporting screens
+ Fix an undefined error on quiz reporting screens for incomplete quizzes
+ Display incomplete (abandoned) quizzes as incomplete (instead of as still running) on the quiz reporting screen
+ Prevent logged in users from bypassing membership restrictions for free members-only access plans
v3.4.3 - 2017-02-20
-------------------
+ Fix issue with bbPress integration so that forums restricted to multiple memberships allow users of at least one membership that the forum is restricted to access topics within that forum
+ Ensure that the correct ajax url is used for quizzes, resolves issue for sites utilizing `FORCE_SSL_ADMIN`
+ Refactored database background update scripts for increased reliability & performance
+ Database update 3.3.0 moved to 3.4.3 in order to accommodate users who were unable to run the 3.3.0 update, please read the [3.4.3 database update notes](https://lifterlms.com/docs/lifterlms-database-updates/#343) for more information.
+ WIP: refactoring shortcodes to a more sane set of functions and classes
v3.4.2 - 2017-02-14
-------------------
+ Backwards compatible css for tooltips
v3.4.1 - 2017-02-14
-------------------
+ Password strength meter now functions correctly when using the [lifterlms_registration] shortcode
+ Ensure open registration with required voucher prevents registration with invalid vouchers
+ Lesson completion via quiz completion only recorded the first time the quiz is completed
+ Fix issue preventing membership catalog from obeying the catalog's ordering settings
+ Prevent duplicate engagements from being triggered
+ Admin tables can display percentages as a progress bar!
+ Students reporting table displays overall progress as a progress bar
+ Refactored frontend assets class to allow better management of inline scripts
v3.4.0 - 2017-02-10
-------------------
+ Enrollment for free access plans has improved based on your feedback. For more information see [https://lifterlms.com/docs/checkout-free-access-plans/](https://lifterlms.com/docs/checkout-free-access-plans/)
+ Upgraded Student Management Table for courses and memberships:
+ Allow searching students by name / email
+ Allow filtering of students by current status
+ Allow sorting of students by name, user id, status, and enrollment updated date
+ Added student's grade to the table (courses only)
+ Table pagination allows skipping to the first and last pages
+ Student names link to full student reporting screen
+ Student IDs added to the table. ID links to the WP User Edit screen which was previously accessible by clicking the student's name
+ Utilizing improved database queries for displaying data on the table
+ One-click bulk enrollment of all current members of a membership into an auto-enrollment course. More info [here](https://lifterlms.com/docs/membership-auto-enrollment/#bulk-enrollment)
+ Students reporting table pagination can now jump to first and last page
+ Students reporting table pagination now displays current page and total number of pages
+ Added new class `LLMS_Student_Query` which is modeled, loosely, off of the `WP_User_Query` and allows for querying student data in relation to courses
+ `LLMS_Admin_Table` abstract now supports filtering and jump to first and last page pagination options
+ `llms_get_enrolled_students` now utilizes `LLMS_Student_Query` and resolves a bug where some users returned by this query would be returned with the incorrect status.
+ Ensure `LLMS_Course::has_prerequisite( 'course' )` & `LLMS_Course::has_prerequisite( 'track' )` always return booleans
+ Made a small performance tweak for courses without audio / video embeds
+ Fix coupon expiration dates check to be more i18n friendly
+ Update `LLMS_Coupon` class to utilize 3.3.0 class property enhancements
+ added `llms_current_time`, a pluggable wrapper for `current_time()` to enable easier unit testing of date-related functions
+ Shortcodes within course restriction messages are now handled properly to output their intend content rather than the raw shortcode
+ Ensure the Page Attributes area is available on lessons so WordPress 4.7 custom post type page templates can be utilized
v3.3.1 - 2017-01-31
-------------------
+ Tested up to WordPress core 4.7.2
+ Added new engagement triggers for Quiz completion, quiz failure, and quiz passed.
+ Refactored Lesson Completion for sanity
+ Added function `llms_mark_complete()` for simple programmatic completion of courses, sections, lessons, and tracks. See [usage docs](https://github.com/gocodebox/lifterlms/blob/master/includes/functions/llms.functions.person.php#L146-L162) for more information.
+ Class function `LLMS_Lesson::mark_complete()` has been staged for deprecation. It will still function but developers should update code to use above function.
+ LifterLMS background updaters will now display a progress report on the admin panel to add some transparency to how the update is doing.
+ Added `author` support to `llms_membership` post type
+ Added a way to remove all LifterLMS-generated data during plugin uninstallation.
+ `llms_get_post()` will now work with any LifterLMS Post Model post types
+ Removed references to `LLMS_Activate` class which was removed back in 2.0.
+ Changed include method to session related classes for better handling via phpunit
+ Refactored some of the `LLMS_Install` class for reliability and test coverage
+ Changed order of table and option creation during installation. Prevents a database warning from being thrown during installation.
+ Added function for retrieving default difficulty categories added during installation
+ Added function for removing default categories added during installation
+ `llms_are_terms_and_conditions_required()` ensure the page id used in this function is an absint
+ Removed redundant function `LLMS_Lesson::single_mark_complete_text()`
+ Add css classes for buttons to be auto-width rather than the width of their containers
+ Fix ID of engagement email class. Allows some filters and actions to actually be used.
+ Properly display quiz failures as failures on the quiz results screen
+ `loop/feature-image.php` now works for unsupported PHP 5.5 and down
+ Fix issue with modifying section titles from within the course builder
+ Fix undefined warning resulting from admin notice "flash" being undefined on pre-existing saved notices
+ Updated template at `templates/course/complete-lesson-link.php` to include a few new CSS classes and utilize `llms_form_field()` to standardize buttons
v3.3.0 - 2017-01-23
-------------------
+ New course option allows displaying the video embed in place of the featured image on course tiles displayed on the course catalog screen
+ Courses can now be exported individually or in bulk. Export of a course includes all course content, sections, lessons, and quizzes.
+ Courses can now be duplicated. Duplication duplicates all course content, sections, lessons, and quizzes.
+ Upon completion of the Setup Wizard a sample course can be automatically installed.
+ Postmeta keys for Lessons and Sections which denote their relationship to their parents have been renamed for consistency, database upgrade 330 included in this release will rename the keys automatically. [Read more here](https://lifterlms.com/docs/lifterlms-database-updates/#330)
+ Update to `LLMS_Post_Model` to allow easier programmatic definition and handling of extending class properties
+ classes extending `LLMS_Post_Model` can now be serialized to json and converted to arrays programmatically
+ new function `llms_get_post()` allows easier instantiation of an `LLMS_Post_Model` instance
+ Added LifterLMS Database Version to the system report
v3.2.7 - 2017-01-16
-------------------
+ Fix float conversion of large numbers with relation to coupon price adjustments
v3.2.6 - 2017-01-16
-------------------
+ Tested up to WordPress Core 4.7.1
+ Fix the display of track-related engagements on the engagement admin screen
+ Fix float conversion of large numbers with relation to prices
v3.2.5 - 2017-01-10
-------------------
+ New shortcode: `[lifterlms_pricing_table]` allows pricing table display outside of a course or membership. See [https://lifterlms.com/docs/shortcodes/#lifterlms_pricing_table](https://lifterlms.com/docs/shortcodes/#lifterlms_pricing_table) for usage information.
+ New shortcode: `[lifterlms_access_plan_button]` allows custom buttons for individual access plans to be created outside of a pricing table. See [https://lifterlms.com/docs/shortcodes/#lifterlms_access_plan_button](https://lifterlms.com/docs/shortcodes/#lifterlms_access_plan_button) for usage information.
+ ensure every return from `llms_page_restricted` is filtered. Thanks to @matthalliday
+ Ensure purchase page can only load for valid access plans
+ Course / Membership taxonomy archives now obey orders defined by their respective catalog settings
+ Fix language of automatic validation error message for numeric field types
+ Fix translation function error causing course syllabus to display incorrect "x of x" text
+ Added correct text domain to an i18n string displayed on the checkout confirmation screen, thanks @ymashev
+ Ensure search result pages are viewable by members and non members regardless of result membership restrictions (unless site is restricted to sitewide membership)
v3.2.4 - 2017-01-03
-------------------
+ Fixed tooltips on lesson preview tiles (in course syllabus and on next/prev tiles inside lessons) to show the actual reason the lesson is inaccessible rather than always showing a generic enrollment message
+ Removed the language "You must enroll in this course to unlock this lesson" in favor of "You do not have permission to access to this content" as a restriction message fallback when no better message is available
+ "Quiz Results" title is now translatable
+ Removed deprecated JS file "llms-metabox-data.js" which controlled UI/X for 2.x subscription data on courses and memberships
+ Non LMS Content (pages, posts, forums, etc...) restricted to multiple memberships will now correctly allow users access to the content as long as they have access to at least one of the memberships
+ Fixed a redirect loop encountered if direct access to a lesson with an incomplete prerequisite was attempted
v3.2.3 - 2016-12-29
-------------------
+ Progress and Grade are now sortable columns on the student reporting table
+ Make enrollment statuses translatable for courses and memberships on the Student Dashboard
+ "Sign Out" text on student dashboard is now translatable, thanks @yumashev
+ Fixed prerequisite lesson display on lesson post tables
+ Ensure post archive (blog) is visible regardless of post membership restrictions
+ Moved lesson post table management functions to their own class
+ Unused section post table management functions removed
v3.2.2 - 2016-12-21
-------------------
+ Adds filter `llms_student_dashboard_login_redirect` allowing customization of the redirect upon login via the Student Dashboard
+ Adds a shortcode parameter, `login_redirect` to `[lifterlms_my_account]` allowing customization of the redirect upon login via the Student Dashboard
+ Adds a new tool under "Tools and Utilities" on the LifterLMS Settings screen which allows users to clear the cached student overall progress and overall grade data
+ Fixes a compatibility issue with the OptimizePress live editor
+ Adds a text domain to a translation function where none was present, rendering the string untranslatable
v3.2.1 - 2016-12-14
-------------------
+ Fix operator position on `is_complete` check
v3.2.0 - 2016-12-13
-------------------
##### LifterLMS Reporting Beta
+ Students overview displays broad information about your students in a searchable and sortable table
+ Review data about individual students including:
+ Membership enrollments and statuses
+ Course enrollments, status, and progress
+ Quiz attempts and and their submitted answers
+ Earned achievements and certificates
+ Sales and Enrollments analytics are now found under the "Reporting" screen
+ Feedback on the beta? Let us know at [https://lifterlms.com/docs/lifterlms-reporting-beta/](https://lifterlms.com/docs/lifterlms-reporting-beta/)
##### Other Updates & Fixes
+ Lesson completion checks now look for at least one record of the completed lesson as opposed to looking for exactly one
+ Fix positioning of teacher avatar on course/membership tiles
+ Remove explicit color definition from Student Dashboard navigation links for greater theme compatibility
v3.1.7 - 2016-12-06
-------------------
+ Added support for WordPress Twenty Seventeen theme
+ Improved the messaging and functions related to LifterLMS Sidebar support
+ Add alternate language for a quiz requiring 100% grade to pass
+ Added CSS class `.llms-button-primaray` to lesson "Mark as Complete" buttons
+ Add box-sizing css rule to LifterLMS form field elements. Fixes layout issues on themes that don't border-box everything.
+ Fix an issue that prevented the admin notice to enable/disable recurring payments from clearing when a button was pressed from screens other than the LLMS Settings screen
+ Fix next payment date error when viewing a cancelled recurring order on the student dashboard
+ Recurring payments now scheduled based on UTC time in accordance with the action scheduler which executes based on UTC rather than site timezone
+ Add existing lesson to course modal now relies on async search. Improves performance and prevents timeouts on sites with a 500+ lessons
+ Removed 2.x -> 3.x update notification message
+ Fix an issue with comment counting on PHP7
+ Updated action scheduler library to latest version
v3.1.6 - 2016-11-11
-------------------
+ Handle empty responses on analytics more responsibly
+ Fix typo preventing completed orders from displaying in analytics when using course / membership filters
+ Quiz builder now leverages llmsSelect2 rather than select2 directly. Resolves a number of theme and plugin compatibility issues.
+ Prevent bullets and weird margins on LifterLMS notices with slightly more specific CSS
+ Login error messages will now display regardless of whether or not open registration is enabled
+ Attempts to access quizzes are redirected or error messages are output when student is not enrolled.
v3.1.5 - 2016-11-10
-------------------
+ Fix Month display on Analytics Screen
v3.1.4 - 2016-11-10
-------------------
+ Progress bars are slightly more intelligent to prevent a widowed "%" on themes with larger base font sizes
+ LifterLMS Merge code button only displays where it's supposed to now
+ Fix issue where users removed from a membership were not properly removed from courses they were auto-enrolled into because of that membership
+ Fix analytics screen JS parsing error
v3.1.3 - 2016-11-04
-------------------
+ Added new action hooks to the course syllabus widget/shortcode template
+ Added a small text link on the student dashboard which links to the full courses list of the dashboard
+ Display order revenue for legacy orders instead of 0
+ Make the Order History table on the Student Dashboard responsive
+ Only display _published_ courses on the student dashboard
+ Fixes a conflict with WP Seo Premium's redirect manager which was creating access plan redirects
+ Reenable course review options on the admin panel
+ Updates review output method so reviews are now output via a removeable action
v3.1.2 - 2016-10-31
-------------------
+ Update all course and lesson templates to rely only on `global $post` rather than on `$course` and `$lesson` globals which are working inconsistently across environments
+ Fix typo related to the line-height of LifterLMS order notes on the admin panel. Thanks [@edent](https://github.com/edent)!
v3.1.1 - 2016-10-28
-------------------
+ Shortcode `[lifterlms_hide_content]` has some new functionality. See [documentation](https://lifterlms.com/docs/shortcodes/#lifterlms_hide_content) for usage and more information!
+ Fix logic when determining if terms and condition checkboxes should be displayed on checkout & open registration.
+ Define a placeholder on the Terms & Conditions page selection so it can be removed
+ Explicitly declare `LLMS_Lesson` on lesson audio/video embed templates instead of relying the global `$lesson`. Some environments appear to be losing the global.
+ Removed unused lesson template "full-description"
v3.1.0 - 2016-10-27
-------------------
+ New engagement triggers available to allow engagements to be fired when a student enrolls into a course or membership!
+ Add custom email addresses for to, cc, and bcc when sending email engagements
+ New Merge Code button for easy merging of custom merge codes when creating emails
+ Added post table data for LifterLMS Engagements
+ Added new filter `llms_email_engagement_date_format` which allows customization of the format of the `{current_date}` merge code available in LifterLMS Emails
+ Added explicit max width declaration to images within LLMS Catalogs to prevent image overflow. Fixes some theme compatibility issues.
+ Optimize course and lesson audio video templates for faster loads
+ Fix course & lesson video to load videos instead of duplicating audio embeds
+ Fix coupon usage query so that coupons cannot be used more than the maximum number of times. Also now displays the correct number of coupons used on the coupons post table.
+ Fix LLMS Engagement Email merge codes to work in subject line
v3.0.4 - 2016-10-20
-------------------
+ Added shortcode `[lifterlms_login]` so the login form can be displayed. Information usage at [https://lifterlms.com/docs/shortcodes/#lifterlms_login](https://lifterlms.com/docs/shortcodes/#lifterlms_login)
+ Added internal function `LLMS_Student->get_name()`
+ Three basic course difficulties will be automatically created on installation and upgrades
+ Updated course difficulty save methods to rely only on the taxonomy rather than the taxonomy and postmeta table
+ Updated admin settings screens to only flush rewrite rules on screens where it is necessary to update rewrites
+ Fix issue with customization of LifterLMS account endpoint URLs
+ Fix a conflict with [Redirection](https://wordpress.org/plugins/redirection/) url monitoring that was causing redirects to be created from Courses and Memberships to the site home page automatically whenever updating the post
+ Fix an undefined index warning on courses / memberships when updating post data
+ Remove confusing and invalid warning message from Membership post screen on admin panel
v3.0.3 - 2016-10-17
-------------------
+ Added filter `llms_show_preview_excerpt` which can be used to hide the excerpt on course syllabus or next/back preview tiles in lesson navigation
+ Fix logic so that only free lessons are marked as free lessons post 3.0 upgrade
+ Fix incorrect display of the "restricted" and "non-restricted" content areas for memberships
+ Fix undefined index warning output by membership metaboxes
+ Fix dead like under "Force SSL" checkout setting
+ Course & Membership tiles output by course or membership shortcodes now automatically match column heights like the default catalogs do.
+ Correctly register students as the "Student" Role
+ Database Upgrade script converts users with the role "studnet" to "student"
v3.0.2 - 2016-10-14
-------------------
+ Added action `lifterlms_before_student_dashboard_tab`
+ Added action `lifterlms_after_student_dashboard_greeting`
+ Added action `lifterlms_after_student_dashboard_tab`
+ Added action `lifterlms_sd_before_membership`
+ Added action `lifterlms_sd_after_membership`
+ Fix membership shortcode
+ Fix issue that prevented "Student Dashboard" from rendering if the page was set as the child of another page
+ Fix undefined function error in admin notices
+ Fix nonce errors resulting from admin notice html being served from the database rather than being dynamically generated
+ Fix db upgrade script which was enabling course time period for restrictions for all courses regardless of their pre 3.0 restriction settings
+ Fix db upgrade script that was causing empty sale dates to show start of unix epoch b/c they were empty strings
+ Fix Javascript parse error preventing section & lesson editing from within the course outline on the admin panel
+ Fix lesson icons from highlighting lesson settings like drip delay & quiz association
+ Updated course outline color scheme to match the 3.0 admin color scheme overhaul
+ `LLMS_Lesson::get_assigned_quiz()` will output deprecation warnings for those using debug mode. LLMS core no longer uses this function and will be deprecated in the next major release.
+ Handle enrollment status of legacy orders based on enrollment rather than enrollment AND order status
v3.0.1 - 2016-10-13
-------------------
+ Properly prefix `llms_is_ajax()` to prevent 500 errors when leaving HTTPS forced checkout screen
+ Fix student unenrollment from memberships which was leaving a trace of enrollment in the user_meta table
+ Update student dashboard nav list items to have more specific no styles to prevent "double discs" on various themes
+ Return course progress bar and "continue" button which was accidentally removed
+ Added core support for "Divi" theme sidebars
v3.0.0 - 2016-10-10
-------------------
**This is a massive update which _breaks_ backwards compatibility for many LifterLMS features. A database migration is also necessary for upgrading users to reformat certain pieces of information which are being accessed differently in 3.0.0**
**We strongly recommend that you backup your website before upgrading and, if possible, test LifterLMS 3.0.0 in a non-public-facing testing environment to ensure compatibility with your theme and other plugins and to ensure that 3.0.0 changes do not adversely affect your existing website.**
**Please thoroughly read the following changelog and, if necessary, submit support tickets or post in the forums with any questions _prior_ to upgrading. LifterLMS Support _cannot_ and _will not_ manually resolve migration issues which may arise from upgrading to 3.0.0.**
+ New shortcodes to be documented later, checkout "includes/class.llms.shortcodes.php" if you're feeling anxious
+ All kinds of CSS changes to make LifterLMS, in general, be a little less old looking
+ Added a number of CSS classes to various areas in the Checkout template at "templates/checkout/form-checkout.php"
+ Added a "Cancel" button that allows you to hide the coupon form if the user decides not to add a coupon
+ Removed jQuery animations from the coupon form toggle in favor of a CSS class toggle. If you decide you want some animations on the form add some CSS transitions to the `.llms-coupon-entry` element (and children) to change when the class `.active` is added or removed from the element.
+ Refactored JavaScript related to LifterLMS Checkout. Improvements are minimal (if any) but the file is now smaller and more readable! Yay code stuff.
+ Fixed some redundant text on single payment confirmation screen. ("Single payment of single payment of")
+ Added a link to memberships listed under "My Memberships" on the LifterLMS Account Screen
+ LifterLMS Order posts have been renamed in the database from "order" to "llms_order" to prevent any potential conflicts with other plugins. Automated database migration will handle the renaming of old orders.
+ Fixed undefined variable notice generated by Sections without any lessons inside of them
+ renamed function `add_query_var_product_id()` to `llms_add_query_var_product_id()`
+ added a class for interacting with a course TRACK, instantiated by a track term or term_id (`LLMS_Track`)
+ password strength meter and related settings / options via utilizing WordPress password strength functions available
+ cleaned up the lesson locked tooltips to be a bit more sane and also utilized in course navigation on individual lessons.
+ Updated admin menus for LifterLMS content to be more sane and organized and intuitive and so on and so forth
##### Payment Gateways
**NOTE: at this release, LifterLMS PayPal is the only payment gateway that will work with this release. We haven't started working on Stripe 4.0.0 which will work with LifterLMS 3.0.0**
+ Payment gateways powered by a new abstract gateway class
+ PayPal has been removed from LifterLMS and is available as premium extension
##### Frontend Notices
+ LifterLMS "Notices" have been rewritten, slightly.
+ Most templates have been updated
+ associated CSS has been updated
+ Some sanity has been added to the related functions
##### Post "Model" Concept / Overhaul
Updated classes for programmatically accessing all sorts of data related to custom post types registered by LifterLMS.
These post types currently include:
+ Access Plans -- a non-public post type associated with courses and memberships which store payment related information
+ Coupons (replaces includes/class.llms.coupon.php)
+ Courses (replaces includes/class.llms.course.php)
+ Lessons (replaces includes/class.llms.lesson.php)
+ Memberships
+ Orders (replaces includes/class.llms.order.php
+ Products -- can be instantiated from courses or memberships (replaces includes/class.llms.product.php)
+ Transaction -- a non-public post type associated with orders which store completed/attempted transaction data
##### Improved admin metabox methods (and related)
+ Updated custom LifterLMS Admin Metaboxes to have a more sane programmatic interface. This affects nearly all admin metabox classes in the plugin.
+ A set of methods and classes have been added to improve the programmatic interface around custom post type post tables. These can be found in "includes/admin/post-types/post-tables"
##### Coupons
+ New class `LLMS_Coupon` allows for easy getting & setting of coupon data.
+ Updated coupon post table to include relevant coupon information for all coupons at a glance
+ Refactored admin panel coupon metabox generation to utilize new model for saving data
+ Added translation functions to all strings in coupon settings screen
+ Added new coupon settings
+ _Expiration Date_ -- coupons cannot be applied to a purchase after the expiration date
+ _Payment Type_ -- coupons can only be applied to either single or recurring payment plans. Existing coupons will be treated as single payment coupons until updated by the Admin.
+ _First Payment Discount_ -- Applies only to recurring payment coupons. Determines the discount applied to the first payment of a recurring payment transaction.
+ _Recurring Payments Discount_ -- Applies only to recurring payment coupons. Determines the discount applied all payments (other than the first) of a recurring payment transaction.
+ _Description_ -- Record internal notes for a coupon visible only by admins on the admin panel
+ The "Coupon Code" field has been removed in favor of the WordPress Coupon Post Title being utilized as the code. After upgrading, an automated database migration will move all coupon code fields to the title. The title previously functioned as the coupon description. During the migration the existing title will be moved to the new description field.
##### Orders
+ Added Order Statuses
+ Completed - Single payment only. Denotes a successful transaction
+ Active - Recurring only. Denotes the subscription is active with no issues
+ Expired - Recurring only. Denotes the subscription has ended and is no longer active
+ Refunded - Denotes the order has been refunded.
+ Cancelled - Denotes the order has been cancelled manually by an admin.
+ Failed - Denotes payment has failed. For subscriptions a failed payment will switch from "active" to "failed"
+ Pending - Denotes that the order has been created but payment has not been completed yet
+ Admin panel order table new features:
+ The following columns are now sortable in ascending and descending orders: Order, Product, and Date
+ Added totals based on order type (single or recurring) to the "Total" column
+ Added an order status column for quick status review
+ Order notes available for internal and system notes. powered by WP comments. lots of inspiration (and code) from WooCommerce, thank you <3
+ Added a bunch of currency settings (as well as right-side currency and decimal-less currency support!)
##### New Templates
+ __Pricing Table__ at "templates/product/pricing-table.php" utilized by courses and memberships for displaying access plan information. Replaces "templates/membership/purchase-link.php" and "templates/course/purchase-link.php"
+ __Course Taxonomy Templates__ at "templates/course/categories.php", "templates/course/tags.php", and "templates/course/tracks.php" display comma separated lists for course custom taxonomy terms
+ __Course Prerequisite Template__ at "templates/course/prerequisites.php" displays prerequisite information (course and tracks) for a given course.
+ __Meta Wrapper__ templates at "templates/course/meta-wrapper-end.php" and "templates/course/meta-wrapper-start.php" wrap some HTML around various meta data output about a course
+ Significantly updated checkout process with all kinds of new templates including:
+ templates/checkout/form-gateways.php
+ templates/checkout/form-summary.php
+ __Unified "Lesson Preview"__ at "templates/course/lesson-preview.php" displays "buttons" in course syllabus (on course page) and in course navigation (on lesson pages)
+ Various template hook priority changes in order to make adding content between default LifterLMS areas easier
##### Deleted Templates
+ templates/checkout/form-checkout-cc.php
+ templates/checkout/form-pricing.php
##### New & Updated Admin Interfaces & Templates
+ Significantly improved, changed, or brand new templates for metaboxes for various post types:
+ templates/admin/post-types/order-details.php
+ templates/admin/post-types/order-transactions.php
+ templates/admin/post-types/product-access-plan.php
+ templates/admin/post-types/product.php
##### New Functions
+ `llms_confirm_payment_url()` - Retrieve the URL used for confirming LifterLMS Payments
+ `llms_cancel_payment_url()` - Retrieve the URL users are directed to when cancelling a payment
##### Install Script
+ Removed some legacy default options that were being created and are no longer required for new installations.
+ Removed unused `update_courses_archive()` function & related hook
##### Select2
Now utilizing a forked version of Select2 to prevent 3.5.x conflicts we've been plagued with
##### Deprecated
+ Removed filter `lifterlms_get_price_html`, use `lifterlms_get_single_price_html` instead
+ Removed unused `LLMS_Product->get_price_suffix_html()` function
+ Removed `LLMS_Product->set_price_html_as_value()` because we didn't like it anymore, don't use anything instead.
+ Removed `add_query_var_course_id()` function
+ Removed `displaying_sidebar_in_post_types()` function with the `LLMS_Sidebars::replace_default_sidebars()` function
+ Filter `lifterlms_order_process_pending_redirect` has been replaced with `lifterlms_order_process_payment_redirect`
+ Action `lifterlms_order_process_begin` has been deprecated
+ Removed `lifterlms_order_process_complete` action
+ Replaced `LLMS_Course::check_enrollment()` with various new utilities. See `llms_is_user_enrolled()` for fastest use.
+ Officially removed the `LLMS_Language` class
+ Officially removed the `PluginUpdateChecker` class stubs we created to prevent updating issues with LifterLMS extensions during our transition to 2.0.0. This library has caused nothing but pain for everyone on our team and many of our users. It's gone now, forever.
+ Removed function `lifterlms_template_single_price()` and replaced with `lifterlms_template_pricing_table()`
+ Removed templates at "includes/course/price.php" and "includes/membership/price.php" in favor of "includes/product/pricing-table.php"
+ Removed `LLMS_Person::create_new_person()` in favor of `LLMS_Person_Handler::register()` or `llms_create_new_person()`
+ Removed `LLMS_Person->set_user_login_timestamp_on_register()` and are simply adding the metadata during registration
+ Removed `lifterlms_register_post` action hook which fired after new user registration validation, this has been replaced with `lifterlms_user_registration_after_validation`
+ Removed `lifterlms_new_person_data` and `lifterlms_new_person_address` filters, replaced with `lifterlms_user_registration_data`
+ Removed `LLMS_Person::login_user()` in favor of `LLMS_Person_Handler::login()`
+ background updater
+ system report facelift + inclusion of all new settings via `LLMS_Data` class
+ Fix setup wizard styles to follow update admin panel styles
+ add links to last step of setup wizard for documentation and demo
+ removed a bunch of deprecated coupon-related functions
+ added a "force ssl" option to ensure checkout is secured
+ added settings and options around recurring payments and staging sites to prevent duplicate charges when testing on a cloned site
+ Check course restrictions automatically when checking lesson
+ Added user_id to all access function checks to allow for checks for non current user
+ course restriction messages display regardless of enrollment status
+ check memberships and lock purchase of members only access plans
+ Fixed titles of course closed and open messages on the course restrictions options
+ record a start date for access plans based off when order moves to complete or active for the first time
+ automatically expire limited access plans
+ gave a quick facelift & unification to a lot of admin panel elements
+ Color consistency updated according to LLMS brand guide
+ Unified front and backend button classes
+ Updated all frontend buttons to have consistent classes
+ Removed the "FREE" lesson SVG in favor of simple text which allows translating
+ Install & activation overhauls. Resolves [#179](https://github.com/gocodebox/lifterlms/issues/179)
+ jQuery MatchHeight lib unignored
+ A bunch of settings pages updated and a bunch of settings deprecated
+ Gateways setting page removed
+ Memberships & Courses page combined into "Catalogs" settings
+ Added a data getting class used by the tracker class
+ added a new page creation function with better intelligence that (hopefully) prevents duplicate pages from being created during core page installation
+ new default country setting
+ all order status changes recorded as order notes
+ pending orders can be completed after failed payments
+ better handling for gateways with fields
+ JS spinners support multiples via start & stop!
+ Updated (and semi-finished) analytics
+ achievement metabox converted
+ minor updates to voucher class
+ Added a "post state" visible on the Pages posts table identifying if the page is saved as a LifterLMS page (EG: Checkout Page)
+ Fixed copy/paste error of duplicate enrollment closed message on course restrictions tab
+ Removed WC integration in favor of WC
+ Upgrade "back to course" template to new lesson API
+ Renamed `course/parent_course.php` to `course/parent-course.php` for template naming consistency
+ use `strict` when auto generating usernames when creating from email addresses, resolves [#182](https://github.com/gocodebox/lifterlms/issues/182)
##### 3.0.0 Auto Upgrader
+ lots of postmeta data rekeyed
+ intelligently generated defaults for various pieces of new meta data on courses, lessons, and memberships
+ automatically generate access plans from existing course and membership data
+ update existing orders to pull semi-accurate data into analytics based on new database structure
+ cleans database of a ton of deprecated options and postmeta data
##### Deprecated
+ function `llms_is_user_member()`, use `llms_is_user_enrolled()` instead
+ function `llms_check_course_date_restrictions()`
+ function `quiz_restricted()`
+ function `membership_page_restricted()`
+ function `is_topic_restricted()`
+ function `llms_get_post_memberships()`
+ function `llms_get_parent_post_memberships()`
+ function `parent_page_restricted_by_membership()`
+ function `outstanding_prerequisite_exists()`
+ function `find_prerequisite()`
+ function `llms_get_course_enrolled_date()`
+ function `llms_get_lesson_start_date()`
+ function `lesson_start_date_in_future()`
+ function `page_restricted_by_membership_alert()`
+ function `llms_does_user_memberships_contain_course()`
+ class `LLMS_Checkout`
+ function `LLMS()->checkout()`
##### Auto Enrollment
+ Course auto enrollment for Memberships has been restored
+ Works exactly the same as previously except auto-enrollment is not dependent on a course "belonging to" the membership via membership restrictions. This is because membership restrictions no longer apply to courses
##### Analytics
+ Charts! I'm really excited about this. I know we still need more data but please say nice things to me, I worked really hard on these little charts.
+ Updated styles & interface
##### bbPress
+ Restrict individual forums (and their topics) to LifterLMS Membership levels
##### BuddyPress
+ Fixes broken course display on bp profile
+ Adds memberships subpage to bp profile
##### notices
+ Admin notices class for managing admin notices, it's pretty neat!
##### Student Management on Courses and Memberships
+ All new and improved student management interface for managing student enrollments from courses and memberships
##### Deprecated
+ filter: `llms_meta_fields_course_main`, replace with `llms_metabox_fields_lifterlms_course_options`
##### Manual Payments
+ Manual Payment Gateway can now be enabled on the frontend!
+ When a manual payment is recorded the user will be redirected to a view order page where they will be prompted to make a manual payment
+ Define the payment instructions on the admin panel "Checkout Settings"
+ Once you verify payment, head to the pending order and hit the "Record a Manual Payment" button to record the transaction
+ Upon recording the order status will be upgraded to "Complete" and the user will be enrolled automatically
##### Student Dashboard Upgrades
+ More sane template hooks and functions
+ Pagination on Courses endpoint (view only a preview on the main dashboard)
+ Orders history & view orders screens!
Deprecated options (and related functions where applicable) for the following course & membership options:
+ `lifterlms_button_purchase_membership_custom_text`
+ `lifterlms_course_display_outline_lesson_thumbnails`
+ `lifterlms_course_display_author`
+ `lifterlms_course_display_banner`
+ `lifterlms_course_display_difficulty`
+ `lifterlms_course_display_length`
+ `lifterlms_course_display_categories`
+ `lifterlms_course_display_tags`
+ `lifterlms_course_display_tracks`
+ `lifterlms_lesson_nav_display_excerpt`
+ `lifterlms_course_display_outline`
+ `lifterlms_course_display_outline_titles`
+ `lifterlms_course_display_outline_lesson_thumbnails`
+ `lifterlms_display_lesson_complete_placeholders`
+ `redirect_to_checkout`
In all scenarios either a `add_filter` (returning false) or a `remove_action()` can be used to replicate the option.
v3.0.0-beta.4 - 2016-09-01
--------------------------
+ fix issue with course prereq checks
+ next payment due date visible on order admin view
+ trial end date visible on order admin view
##### Free Access Plans
+ "Free" access plans now defined as such based on a checkbox rather than by entering 0 into the price
+ Only single payment access plans can be free (a free recurring payment makes no sense but we can certainly discuss this if you disagree with me)
+ trials are disabled with free plans (because trials only apply to recurring plans)
+ sales are disabled for free access plans
##### Checkout Form JS API
+ unified JS checkout handler
+ allows extensions to enqueue validation or pre-submission JS functions that should run prior to checkout form submission
##### Manual Payment Gateway
+ handles purchase of access plans marked ar FREE & orders that are discounted to 100% via coupons
##### Open Enrollment
+ Open Enrollment allows users to register on the account dashboard without purchasing a course
+ Voucher settings are available to customize whether vouchers should be optional or required during open registration
+ Better error reporting around voucher usage during enrollment
##### Deprecated Functions
+ `llms_get_coupon()`
+ `get_section_id()`
+ `check_course_capacity()`
##### Quizzes
+ Updated admin metaboxes to use new metabox abstract class
+ display 0 instead of negative attempts on quiz summary
+ updated logic in start button template
##### Emails (for engagements)
+ Admin metabox updated to new API
+ Postmeta data migration:
+ `_email_subject` renamed to `_llms_email_subject`
+ `_email_heading` renamed to `_llms_email_heading`
v2.7.12 - 2016-09-22
--------------------
+ Added a new filter on content returned after port permission checks
+ Added additional information to plugin update message in preparation for major 3.0 release
+ Updated plugin contributor metadata
v2.7.11 - 2016-07-22
--------------------
+ Removed a duplicate action hook on course archive loop.
+ Switched registration template include to use a more sane function
+ Added updated banner adds with prettier ones. Wooooooo.
v2.7.10 - 2016-07-19
--------------------
+ Fix undefined noticed related to LifterLMS custom post type archive filtering
+ Fix filter which was supposed to allow custom engagement types to be queried & triggered by engagements automatically but was passing data incorrectly
v2.7.9 - 2016-07-11
-------------------
+ We are now properly storing delayed engagement trigger data.
+ Fixed an issue with our engagement query functions that caused, in very rare circumstances, the extra engagements to be triggered during an engagement trigger due to a lack of specificity in our query
+ Fixed an undefined property notice related to email engagements when the email had no subject or header
+ Fixed a typo in the description of a translation function.
+ Added an engagement debug logging function. You can log all sorts of data related to engagements by adding `define( 'LLMS_ENGAGEMENT_DEBUG', true );` to your `wp-config.php` file.
+ Allow course title shortcode to be used on course pages (and quizzes too). Documentation incorrectly said it was available on courses so we've fixed the function to allow for use on courses.
v2.7.8 - 2016-07-05
-------------------
+ Bugfix: Restore access to quiz results on quiz completion
v2.7.7 - 2016-07-01
-------------------
##### Russian
+ LifterLMS is now 100% Translated into Russian thanks to our new Russian Translation Editor [@kellerpt](https://profiles.wordpress.org/kellerpt/)
##### l18n
+ All transition messages between questions during a Quiz are now translatable.
+ LifterLMS subpages below the LifterLMS icon on the admin panel will now always display regardless of how you've chosen to translate the menu items. Hopefully puts to rest a long-standing i18n issue.
###### Bug fixes
+ Attempting to access a quiz when not enrolled in the associated course and having not properly started the quiz now results in a useful error message rather than a PHP warning.
+ We've adjusted the way we're adding a admin panel "separator" to reduce conflicts with other plugins that have menu items with the same position as our separator (51).
+ Added new logic to display an error message (instead of nothing) if there's an error during question loading.
+ Resolve issue with course progress bar when added to a quiz sidebar (assuming your theme has sidebar support on your quizzes).
+ Updated version number in the changelog for last version (it was supposed to be 2.7.6)
v2.7.6 - 2016-06-28
-------------------
+ Students manually removed by Memberships by using the "Students" tab of a LifterLMS Membership will now be fully removed from the membership.
+ Updated a few time-related strings to be l18n friendly. These items were all around Quiz time reporting and quiz time limits.
+ Updated testing information, tested up to WP 4.5.3
+ Fixed date of last release on changelog. It had the wrong date. Does that really matter?
+ Updated readme.txt description area, we have a new youtube video! Yassss.
v2.7.5 - 2016-06-13
-------------------
##### New features
+ Added an "id" parameter to both LifterLMS Courses and LifterLMS Memberships shortcodes
##### i18n
+ Allow date translation on quiz results screen by using `date_i18n()` instead of `date()`
+ Allow date translation on my courses screen by using `date_i18n()` instead of `date()`
+ Ensure course status "Enrolled" is translatable on my courses screen
##### Fixes
+ Thanks to [@kjohnson](https://github.com/kjohnson) who fixed undefined index warnings & errors which occurred when viewing the last lesson in a section when the next section contained no lessons.
+ Resolved an issue where formatting for "Restricted Access Description" course content would not display proper formatting.
+ Fixed an issue with the "FREE" stamp for a free lesson caused layout issues.
+ Removed the "is-complete" css class from incorrectly being added to lesson preview tiles for free lessons
+ Fix an escaping issue when rendering Course titles inside LifterLMS notices. Prevents "\'s" from displaying when "'s" should be displaying (and similar issues).
v2.7.4 - 2016-05-26
-------------------
+ Fixed a bug with the new localization methods from 2.7.3
+ Removed bundled it_IT translation files in favor of official language pack available at [https://translate.wordpress.org/projects/wp-plugins/lifterlms/language-packs](https://translate.wordpress.org/projects/wp-plugins/lifterlms/language-packs).
+ Removed bundled en_US translation files because LifterLMS is in English so the files are unnecessary.
+ Fixed a few mis-labeled filters applied when registering LifterLMS Custom Post Types
+ Adjusted the default supported features of LifterLMS Quizzes and Questions
+ Quizzes now support custom fields as per user request
+ Commenting, thumbnails, and excerpts are no longer "supported" as they were never intended to be and were never correctly implemented.
+ If you are relying on any of these features for your quizzes or questions please use the following filters to re-implement these features: `lifterlms_register_post_type_quiz` or `lifterlms_register_post_type_question`. These will allow you filter the default arguments LifterLMS passes to the WordPress function `register_post_type()`
v2.7.3 - 2016-05-23
-------------------
+ Added a separate filter for login redirects `lifterlms_login_redirect` and added the user_id as a second parameter available to the filter.
+ Added second parameter to `lifterlms_registration_redirect` to allow access to the registered user's user_id.
+ Fixed a timestamp conversion issue on Course sale price checks that caused indefinite sales (those with no date restrictions) to appear not on sale during certain periods of time. The period would differ depending on the server's timezone settings and the time of visit.
+ Added a "Pointer" when hovering quiz summary accordion to allow for a slightly more obvious user experience that the elements are expandable.
+ Added some new localization methods to ensure strings that only appear in Javascript files will be translator friendly. This initially fixes a few issues on the Quiz Summary page and during quiz taking where strings only appeared in Javascript and were, therefore, completely inaccessible to translators.
v2.7.2 - 2016-05-19
-------------------
+ In course syllabus widget & shortcodes free lessons will now be clickable links.
+ Record `llms_last_login` timestamp in usermeta when a user registers.
v2.7.1 - 2016-05-09
-------------------
##### Enrollment & Voucher Checks
+ Enrollment functions will now automatically check to ensure that users are not already enrolled in a course or membership before enrolling. This addresses an issue which would create double enrollment for user redeeming a voucher for a product they were already enrolled in.
+ Vouchers will now automatically check to see if the user has already redeemed this voucher before allowing the user to redeem it. This would have caused multiple enrollments and would allow one user to eat up an entire voucher by using it over and over again for funsies. A voucher can now *only* be redeemed once by a user as intended.
+ `llms_is_user_enrolled()` now allows developers to check membership enrollment. Previously this function would only check enrollment of Courses despite what the documentation stated.
##### Translation
+ 3 strings have had translation functions added to them. This makes LifterLMS voucher redemptions translatable!
##### Bugs & Fixes
+ Fix javascript dependency & enqueueing issue on admin panel which prevented LifterLMS settings from saving correctly in various places
+ Removed inline CSS from "next lesson button" on quiz completion / summary screen. This was overriding some default styles and making the button very thin and gross.
v2.7.0 - 2016-05-05
-------------------
##### LifterLMS Custom User Fields Exposed
+ Custom fields added during registration via LifterLMS account settings are now exposed on the admin panel via the student's WordPress user profile
+ All custom fields that are available (billing and phone) are editable on the WordPress user profile by anyone with profile edit access regardless of LifterLMS settings. If the settings are disabled (eg not required for registration) you can still add this information manually to a user's profile. This is useful if you require the information and then disable it later, you would still be able to access the information on the admin panel but would no longer be required for user's during registration.
+ A few new filters added to help developers customize the experience here. Check out the documentation at [https://lifterlms.com/docs/lifterlms-filters/#admin-user-custom-fields](https://lifterlms.com/docs/lifterlms-filters/#admin-user-custom-fields)
##### Membership Manual Add & Remove Student Functions
+ Duplicated "Students" tab from the Course admin screen to Memberships
+ Students can be manually added to a membership by an admin
+ Students can be removed manually from a membership by an admin
##### Updates
+ Added the ability for students to edit their phone number via their account settings page if the phone number registration option is enabled on the site.
##### Fixes
+ Fixed a few spelling errors on LifterLMS admin panel order screens
+ Fixed a typo on meta data for LifterLMS admin created (manual) orders
v2.6.3 - 2016-05-02
-------------------
+ Removed redirecting action from WooCommerce integration that was causing issues on multiple product purchase checkouts with larger databases.
+ Added a new payment action `lifterlms_order_complete` which runs at the same time as some previous actions during payment processing but servers a different purpose. This is mostly in preparation for a forthcoming AffiliateWP integration.
+ Fixed an issue with LifterLMS certificate background image that caused the wrong dimensions to be returned when outputting a LifterLMS certificate background image
v2.6.2 - 2016-04-27
-------------------
+ Fix class conflict in collapsible course outline widget template which caused some UX issues.
+ Added new filters run during course & lesson sidebar registration to allow customization of LifterLMS sidebars
+ `lifterlms_register_course_sidebar`
+ `lifterlms_register_lesson_sidebar`
+ Removed a stray logging function.
+ Cleaned up some undefined variable warnings & notices on the quiz summary template
+ Fixed an issue appearing when registering users did not submit the optional phone number which caused a PHP notice
+ LifterLMS Orders generated by WooCommerce will now have a payment method of "WooCommerce". This also addresses an undefined notice produced during WooCommerce order completion because a LifterLMS Payment Method wasn't being defined.
v2.6.1 - 2016-04-26
-------------------
+ Fix class conflict in collapsible course outline widget template which caused some UX issues.
v2.6.0 - 2016-04-25
-------------------
##### Collapsible Course Outline Widget
+ By request we've added an option to make your course outline widgets collapsible!
+ View feature [Documentation](https://lifterlms.com/docs/course-syllabus-widget/)
+ New translations available related to feature. I think it's 4 strings.
##### Bug Fixes
+ Removed an unused CSS selector that caused some issues on the admin panel. This resolves an issue identified with the Page Builder by SiteOrigin plugin. The selector was very generic (`.title`) and may have caused issues with other themes or plugins using that class.
+ Resolved an issue that prevented post update, save, and publishing messages for core post types (posts, pages) from displaying properly.
v2.5.1 - 2016-04-22
-------------------
+ Fixed session handler initialization as it was being initialized prior to user data availability.
+ Staged `LLMS_Language` class for deprecation in favor of WordPress translation functions `__()`, `_e()`, etc... **If you're a developer you'll start seeing warning's on screen or in your logs if you're using this function, it will be completely removed in the next MAJOR release (3.0.0)**
+ Added a new function to handle the deprecation warning above (`llms_deprecated_function`) and now that we have this function we'll start deprecating all the things. Just kidding, or am I?
+ This gives translators access to 69 new strings that were previously untranslatable! However, this number might be inaccurate +/- 5 strings. I only counted it once and I don't feel like the exact number is important enough for a recount to ensure accuracy. /shrug
v2.5.0 - 2016-04-15
-------------------
**Admin Panel Order Table Updates**
+ Several visual improvements to the table
+ Exposed the following fields on the table
+ Order number
+ Customer name (with a link to their WP profile)
+ Customer email (mailto link)
+ Payment gateway used (this is filterable per gateway as well so gateways can improve the functionality here in the future)
+ Added a link to the product edit page from the product column
+ Free orders will now display as "Free" as opposed to {currency}0.00
+ Removed the not-so-useful "Order" column which was a long ugly string of data that was displayed in other columns already
+ Removed the "Password Protected" flag since *all* orders are always automatically password protected for added security. This flag distracts from the interface so we've removed it. Orders _are_ still password protected though.
+ Numerous strings that were previously not translatable have been made translatable on this screen
+ A few new strings that previously didn't exist are now available for translation
**Fixes and other small changes**
+ Fixed a translation issue on the LifterLMS menu that we thought we fixed in the last release but have now really fixed (probably).
+ Fixed a few small issues with engagements as they related to external engagements triggered by other plugins and LifterLMS extensions.
+ Tired of seeing a banner for a plugin you've already installed? We have your back! The general settings area will now only display banners for plugins that aren't installed.
+ Fixed various javascript issues, mostly removed `console.log()` statements.
+ Fixed a spelling error on the membership admin panel settings screen
v2.4.1 - 2016-04-07
-------------------
+ Tested and compatible with WordPress 4.5 Release Candidate.
+ Fixed a pagination issue related to updates to the quiz builder from 2.4.0 which would cause results to return incorrect results on the last page of paginated results in the "Add Question" dropdown.
+ Added translation functions to LifterLMS Menu Items. Resolves an issue where translated LifterLMS installations might not see all the menu items under the LifterLMS Icon.
+ Italian translation updates courtesy of [@AndreaBarghigiani](https://github.com/AndreaBarghigiani)
+ On some themes the "Next Lesson" button was displayed while quizzes were being taken. We now *always* hide the next lesson button when a quiz is being taken.
+ Adjusted some static functions to be non static in `class.llms.post-types.php`
+ Added a function to ensure support for post thumbnails on LifterLMS custom post types
+ If a user views a course that is available to them because it belongs to a membership level they are a member of, course pricing information will no longer be visible. This addresses a confusing user experience issue. Previously it _appeared_ like payment for a course was still required even though it really wasn't.
+ Fixed undefined variable warning on quiz summary screen
+ Resolve an issue with quiz timer that caused issues on time display if the time limit was set to a fraction of a minute (eg 1.5 minutes)
+ resolved an undefined variable warning resulting from courses still holding a reference to a membership after the membership has been deleted or trashed
v2.4.0 - 2016-03-29
-------------------
##### Performance Improvements on the LifterLMS Quiz Builder
+ Completely rewrote Javascript associated with building a LifterLMS Quiz. Our users have been identifying some performance issues and slowness when working with larger databases. We've refactored the Javascript and our related database queries to allow faster quiz building and fewer timeouts when working in the quiz builder.
+ Fixed a bunch of undefined variables that would produce PHP warnings in various quiz templates
+ Added validation to quiz questions on the admin panel to prevent the same question from being added to a quiz multiple times.
+ Fixed an issue that prevented quizzes from correctly marking the lesson as completed when the quiz was passed.
+ Added three new actions now available for developers to hook into.
+ `lifterlms_quiz_completed` called upon completion of a quiz (regardless of grade)
+ `lifterlms_quiz_passed` called when a quiz is completed with a passing grade
+ `lifterlms_quiz_failed` called when a quiz is completed with a failing grade
+ Course Progress and Course Syllabus shortcodes (and widgets) now work on Quiz pages
+ Completed Metabox refactor for the LifterLMS Quiz post type and removed `LLMS_Meta_Box_Quiz_General` class. All functions now exist in `LLMS_Meta_Box_Quiz`
+ Added validation to the Quiz general settings
+ Cannot only enter numbers in attempts, percentage, and time limit fields
+ Cannot enter a negative number or a number greater than 100 in the percentage field
+ Removed the membership restriction metabox from quiz admin and question admin screens
##### Other fixes
+ Fixed an issue that caused multiple certificates awarded for the same Course or Lesson to not properly display on the My Account page.
+ Removed an event bound to the publishing of a LifterLMS Question that called a function that didn't exist and caused a Javascript error on the console (but didn't actually cause any problems)
+ Removed a warning message that would display on sidebars when a shortcode was being displayed in a place that it couldn't function. We now simply don't display any content if the shortcode can't function.
+ Resolved an issue that prevent users from "purchasing" products when using a 100% coupon and the Stripe payment gateway. Users experiencing this issue should also update to Stripe 3.0.1.
+ Fixed an AJAX related issue that was incompatible with PHP7
+ Added the ability to have a "max" value on LifterLMS Admin Metabox number fields
v2.3.0 - 2016-03-24
-------------------
##### Engagements Refactoring (lots of bugfixes, performance improvements, more hook & filter friendly)
+ We've completely rewritten the LifterLMS Engagement Handler methods (`class LLMS_Engagements`) and added some new engagement actions.
+ The rewrite unifies engagement handling into one function that can be easily hooked into by plugin and theme developers.
+ We've moved any engagement related data out of the main `LifterLMS` class
+ Fixed the broken engagement delay functionality which now runs of `wp_schedule_single_event`. This makes the function more reliable and also keeps it within the traditional WordPress architecture.
+ Added an additional check before sending emails or triggering any engagements that will prevent the achievement from being awarded or the email from being sent if the post is in not published. This fixes an issue that caused emails in the trash from still being emailed.
+ Removed the unused `LLMS_Engagements` class and file
+ Added two new engagement trigger events "Membership Purchased" and "Course Purchased"
+ Deprecated actions -- Removes some redundancy because the triggering actions (`lifterlms_course_completed` triggered the notification action, instead `lifterlms_course_completed` simply triggers the engagement now).
+ `lifterlms_lesson_completed_notification`
+ `lifterlms_section_completed_notification`
+ `lifterlms_course_completed_notification`
+ `lifterlms_course_track_completed_notification`
+ `lifterlms_course_completed_notification`
+ `lifterlms_user_purchased_product_notification`
+ `lifterlms_created_person_notification`
##### Bug and Issue fixes
+ Adjusted the size of the LifterLMS Admin Menu Icon. It was super big because of, perhaps, some overcompensation. It caused an issue on Gravity Forms admin pages for some reason (we didn't ever determine why) but we've resolved it by using an appropriately sized icon.
+ Fixed a CSS issue that caused some weirdness on the course archive page on mobile devices
+ Fixed an issue with automated membership expirations
+ Fixed a function that should have been called statically in `LLMS_Ajax` class
+ Fixed a ton of issues related to the triggering of engagements and cleaned up a lot of classes and functions associated with them.
+ Properly instantiate `LifterLMS` singleton via LLMS() function and prevent direct instantiation of the class via `new LifterLMS()`.
+ Removed the deprecated 'class.llms.email.person.new.php' file as it was rendered useless a long time ago and caused some duplicate emails.
v2.2.3 - 2016-03-15
-------------------
##### Translations
+ Added translation functions around quite a few untranslated strings. Thanks to the team at [Netzstrategen](http://netzstrategen.com)
+ Added German translation .mo and .po files again thanks to the team at [Netzstrategen](http://netzstrategen.com)
##### Student Enrollment Functions
We've refactored a bit of our code related to how to programmatically enroll a student in a course or membership during registration and purchase.
A new class `LLMS_Student` makes working with a LifterLMS student (user) a bit easier. We'll begin exposing user meta data through this class as we continue to improve the usability of the codebase for other developers.
We've also created a simple enrollment function `llms_enroll_student()` which enables programmatic enrollment to LifterLMS courses or memberships. This was previously handled in a pretty schizophrenic manner and this unifies various ways of enrollment into one clean function. All enrollment moving forward will use this functions.
The enrollment function calls a new action as well as calling existing enrollment-related actions:
+ `before_llms_user_enrollment` - called immediately prior to beginning the user enrollment function
+ `llms_user_enrolled_in_course` (previously existing)
+ `llms_user_added_to_membership_level` (previously existing)
This also addresses an issue that prevented the `llms_user_enrolled_in_course` action from being called when a user was auto-enrolled in a course because they joined a membership level that included auto-enrollment in one or more courses.
##### Bug and Issue fixes
+ Fixed an inconsistency in the way membership IDs were being saved to the postmeta table that would cause courses to not *appear* restricted on the Membership Enrollment tab, even though they were actually restricted and functioning correctly.
+ New lines are now preserved in the quiz question clarification text areas, thanks to @atimmer
+ Escape HTML in the quiz question description fields on the admin panel to allow outputting html without rendering it, thanks @atimmer
+ Fixed an issue related to the outputting of restricted course and membership content which caused errors on certain themes
+ added a clearfix to the `.llms-lesson-preview` element on the course syllabus template
+ Removed the `class.llms.person.handler.php` file as it wasn't actually being used by anything anywhere and contained no functions
+ Removed some unused and deprecated class functions from the LLMS Student Metabox class
+ Fixed an undefined javascript error resulting from code cleanup in 2.2.2. This issue prevented Vouchers from being published. The code has been further cleaned.
v2.2.2 - 2016-03-15
-------------------
##### One step closer to a public GitHub repository
We've made a massive syntactical update to almost every file in the codebase for a (finally) unified and clearly defined coding standard. This puts us one step closer to beginning to open our GitHub repo publicly and accepting pull requests and contributions from developers everywhere.
Okay, we haven't exactly _clearly_ defined it yet. We're working off a modified version of the [WordPress Coding Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/).
Notable exceptions are related to file names because Thomas Levy didn't have the energy to rename a bunch of files as well as ignoring the Yoda Conditions standards. We'll be fixing these deviations in the future.
##### Quizzes
+ Created new time calculation and humanizing functions related to the display of quiz time on quiz results pages
+ Quizzes will now display hours, minutes, and seconds depending on the time it took to take the quiz
+ Timing calculations are more accurate and quizzes that are completed in less than 60 seconds will not bug out and display incredibly long lengths
+ Resolved an issue that occasionally prevented quiz data from saving during the last question causing the quiz to hang in an uncompletable state
+ Quiz questions now have a default point value of 1, thanks @atimmer
+ Quiz question answers now accept valid HTML as per `wp_kses_post`, thanks again to @atimmer
##### Translations
+ Thanks to @AndreaBarghigiani and the team at [codeat](http://codeat.co/) LifterLMS now ships with Italian language files!
##### Issue and bug resolutions
+ Fixed a restriction issue that would happen when individual lessons were restricted to a membership level
+ Fixed an issue with the `[lifterlms_my_account]` shortcode that was preventing the shortcode from working on the Divi theme.
+ Engagements will now only be triggered if they are "Published". Resolves an issue where draft or trashed engagements were still firing.
+ Fixed CSS overflow on LifterLMS Meta boxes. Fixes an issue where select boxes would be hidden inside a metabox.
+ Changed the ConvertKit extension banner image on the LifterLMS general settings page and replaced added a link to the extension now that it's available.
+ Added a link to the new ConvertKit extension to the .org readme
+ When restricting an entire site to a membership level the page selected as the "Terms and Conditions" page in LifterLMS settings will automatically bypass Membership restriction settings. This will allow your unregistered users to actually read the T&C that they're confirming during registration.
+ CSS fix for `has-icon` class on course syllabus
+ Fixed a PHP warning that displayed when purchasing a membership with no auto-enrollment courses
+ Fixed an undefined variable warning in the WooCommerce integration class
+ Fixed a few templating issues related to certificates
+ Added a few new CSS rules that should make certificates more compatible across various themes
+ Added a css class to LifterLMS Next Lesson buttons, `llms-next-lesson`
+ Updated the scheduled event name for cleaning up LifterLMS session data from the WP database. It had a conflicting name with the scheduled event for expiring LifterLMS memberships.
v2.2.1 - 2016-03-07
-------------------
+ Added a few actions to the `class.llms.voucher.php` class.
v2.2.0 - 2016-03-04
-------------------
##### Translations
+ We've updated our .pot file for the first time in quite a while. We're really sorry for de-emphasizing translation. An updated .pot file will now accompany each version of LifterLMS whenever a translatable string is adjusted or when a new string is added.
+ We've also made it easier to include custom translations. Read our [Translation Guide](https://lifterlms.readme.io/docs/getting-started-with-translation).
##### Certificate Background Images
_We've completely rewritten the certificates template (but it's all backwards compatible)._
+ New filters are available to make customizing the certificate template easier for developers. All new filters are documented at [https://lifterlms.readme.io/docs/functions-certificates](https://lifterlms.readme.io/docs/functions-certificates).
+ A new WordPress Image Size is now available and will be used for generating the image used by default when uploading certificates to the media library. Fore more information on these new settings visit [https://lifterlms.com/docs/certificate-background-image-sizes/](https://lifterlms.com/docs/certificate-background-image-sizes/).
##### Course and Membership Pricing & Sales
+ Sale price start and end date are now completely optional.
+ Provide neither a start date nor an end date to have a sale run indefinitely
+ Provide a start date with no end date to have a sale start at a pre-determined time with no pre-determined ending
+ Provide an end date with no start date to have a sale end a a pre-determined date but start immediately
+ Provide a start date and an end date to have a sale run for a pre-determined period of time
+ Optimized the `LLMS_Product` class to provide more reliable and extendable use of the class
+ The templates related to pricing functions have been refactored. Affected templates include: "templates/course/price.php", "templates/loop/price.php", "templates/membership/price.php"
+ Many people complained about the size of the `.llms-price` element on course and membership tiles on loop pages. We removed the inflated size and will now default to your theme for sizing. You selector remains the same if you wish to customize the size of the price text.
##### Coupon Updates
+ Coupons can (finally) be removed after being applied!
+ Coupons can now be restricted to specific courses and/or memberships
+ Percentage based coupons can no longer be created with a value larger than 100%
+ Added numeric restrictions to usage and coupon amount fields on the admin panel
+ Fixed a programmatic error that prevented product restrictions from being entirely removed
+ Fixed a few instances where hardcoded a US Dollar symbol ($) where a dynamic currency symbol should have been displayed.
##### Wow Bad Syntax, Very Typo, Such Grammar, So Undefined
+ Fixed a typo in filter associated with modifying the registration of the lesson post type (`lifterlms_register_post_type_lesson`)
+ Fixed a grammatical error in a Membership restriction message
+ Fixed a syntax error in "/templates/course/outline-list-small.php" that prevented the `done` CSS class from being properly applied to completed lessons
+ Fixed a few typos and grammatical errors on the Course and Membership settings metaboxes
+ Fixed an undefined variable in "templates/course/syllabus.php"
+ Fixed an issue on the system report that prevented the "Courses Page" from being reported properly
+ Fixed an issue that caused PHP warnings on the admin panel for students or WP users with no LifterLMS menu permissions
+ Fixed an installation warning caused by a reference to an undefined class variable
+ Fixed an HTML character encoding issue that caused `–` to display on the admin panel when viewing LifterLMS Orders
+ Fixed an undefined variable found during engagement triggering for non-email engagements.
##### Additional, less exciting updates
+ Added input type restrictions to course & membership price fields.
+ The "Emails" LifterLMS Settings Tab has been renamed "Engagements." All Email settings are found under this tab as well as some new settings related to other kinds of LifterLMS engagements.
+ Added `the_content` filter to the content of emails sent by LifterLMS
+ Fixed some CSS issues on Voucher screens
+ Updated Courses settings retrieval function to retrieve the correct "shop" page id
+ Added translation functions to voucher export meta box class
+ Vouchers Export metabox will only allow export after a voucher has been published. This prevents an issue caused by attempting to export voucher codes before they were saved in the database via the publish / save action.
+ Vouchers can no longer be saved with a use of "0"
+ added a CSS class for various syllabus outputs that notes that the lesson has an icon. Previously CSS relied on "is-complete" to output styles for having an icon but with the addition of placeholders the "is-complete" is used only to note that the lesson is completed and "has-icon" is a more semantic class that applies to both complete and incomplete lessons with an icon.
+ Removed the membership restriction metabox from some post types where it shouldn't have been displaying.
+ admin select fields now have an option `allow_null` (default to "true") which can be set to `false` in order to prevent the output of the default "None" option
v2.1.1 - 2016-02-15
-------------------
##### System Report
+ A new LifterLMS Admin Page is available which reports information about various server, WordPress, and LifterLMS settings that will help expedite support requests.
+ More information about the system report is available at [https://lifterlms.com/docs/how-to-use-the-lifterlms-system-report/](https://lifterlms.com/docs/how-to-use-the-lifterlms-system-report/)
##### Additional Updates
+ Fixed a javascript issue which prevented users from saving vouchers
+ Cleaned up formatting in a large number of included PHP files
v2.0.5 - 2016-02-15
-------------------
+ PayPal requests now using HTTP Version 1.1 in preparation for June 2016 [TLS 1.2 and HTTP/1.1 Updates](https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US). This resolves user's inability to begin PayPal checkout when using Sandbox mode.
+ Updated deprecated function opt out to run off a constant that can be defined in `wp-config.php` instead of using a filter that is hard to use in the way that it is intended.
v2.0.4 - 2016-02-15
-------------------
+ Fixed a typo on the `class_exists` check in the deprecated functions file
+ added a filter so that progressive users can opt out of loading the deprecated functions file
v2.0.3 - 2016-02-12
-------------------
+ Removed an unused quiz stub
v2.0.2 - 2016-02-11
-------------------
+ Bugfix: removed a progressive syntax array that caused fatal errors on older versions of PHP
v2.0.1 - 2016-02-11
-------------------
##### Updated General Settings Screen
+ Improved the general settings interface to be more visually appealing and to provide some ad space to alert customers to other LifterLMS products and information.
+ Moved Currency options to the Checkout settings screen
##### Bug Fixes
+ Properly initialized jQuery on the vouchers metabox admin scripts
+ removed some php shortcut echos (`<?= $var; ?>`)
+ Resolve issue where courses that are available with a membership or on it's own outside of the membership would prevent users from accessing content if they were not a member.
+ Fixed a few files where undefined variables were being referenced and generating php notices
+ removed an call to a WordPress core function that has never existed. Not sure what we were thinking there...
###### Enhancements
+ Updated CSS to provide better course syllabus layout on smaller screens
+ Added validation to prevent against duplicate voucher code creation
v2.0.0 - 2016-02-04
-------------------
##### Auto-advancing lessons
+ We've heard your feedback and added a new global course option which will auto-advance a student to the next lesson upon lesson completion.
##### Bug Fixes
+ Added spaces between numbers and "of" on the counter for course syllabus templates
+ Removed a template hook that was creating duplicate lesson thumbnails on quite a few themes
##### Membership Admin Improvements
Visit the "Enrollment" tab on any membership to see some new additions to make managing your memberships easier.
+ You can now add courses to and remove courses from a Membership from the Membership itself
+ You can now opt to automatically enroll students in a course (or multiple courses) when they sign up for a membership by checking "Auto Enroll" next to the course on the Membership enrollment tab
##### Student Enrollment & Removal on Courses Admin Screen
We've updated the Students tab interface for performance and usability!
+ AJAX enabled searching by student name and or email
+ Increased performance for course page load by only calling student information when needed. This resolves a bug identified by users with large user databases and/or low-powered servers.
+ Allow for addition or removal of several students at a time.
##### Syllabus Template
+ Added a Course setting to optionally enable Lesson Thumbnails on the Course Syllabus
+ Added a Course setting Display greyed out lesson completion checkmark icons on lessons not competed in the course syllabus
+ Reworded CSS on the course syllabus to rely on floats rather than absolute positioning, should allow for more robust customization with less frustration
+ Refactored the syllabus template at "templates/course/syllabus.php" for better performance and readability
##### Updates and enhancements
+ User email is now displayed on the "Students" table on student analytics screens
+ Membership now has it's own admin menu
+ Reordered the LifterLMS admin menu and submenu items
+ Removed membership specific taxonomies from courses
+ Removed course specific taxonomies from memberships
+ Coupon code is now a required field when creating a coupon
+ "Humbled" the metabox on all post types that restricts the post to a membership. The metabox would previously gain priority over the WordPress publishing actions metabox. The priority has been reduced to "default" and will to fall into line with all other metaboxes on the screen and appear based on registration priority. If you can't find the metabox, SCROLL DOWN! If you want to put it back up on the top, you can simply drag it up there and WordPress will save your preference.
##### Deprecated Classes
We've added a "deprecated" file which holds a few stubs for classes and functions deprecated below as to prevent fatal errors. The functions and classes in the deprecated class are classes which we know are being utilized by approved LifterLMS extensions and will allow users to upgrade LifterLMS without upgrade extensions without breaking their websites!
+ `LLMS_Activate` which as previously used to activate the plugin for updates via the LifterLMS Update Server and is no longer required.
+ PUC (plugin update checker) Library has been completely removed as it is no longer required for plugin updates.
+ `LLMS_Analytics_Dashboard` was removed as it was a stub that was never used and shouldn't have ever been released as a part of the LifterLMS codebase. I can't believe no one reported this bug!
##### Deprecated Functions
+ `lifterlms_template_section_syllabus()`
**The following are officially deprecated and removed to prevent WooCommerce compatibility conflicts**
+ `is_shop()` replaced by `is_llms_shop()`
+ `is_account_page()` replaced by `is_llms_account_page()`
+ `is_checkout()` replaced by `is_llms_checkot()`
##### Deprecated Templates
+ templates/course/section_syllabus.php
##### New Account Dashboard Filters
*[View documentation for more information](https://lifterlms.readme.io/docs/filters-account)*
+ `lifterlms_account_greeting`
+ `lifterlms_my_courses_title`
+ `lifterlms_my_courses_enrollment_status_html`
+ `lifterlms_my_courses_start_date_html`
+ `lifterlms_my_courses_course_button_text`
+ `lifterlms_my_certificates_title`
##### New Checkout Page Filters:
*[View documentation for more information](https://lifterlms.readme.io/docs/filters-checkout)*
+ `lifterlms_checkout_user_logged_in_output`
+ `lifterlms_checkout_user_not_logged_in_output`
##### New Course Filters:
*[View documentation for more information](https://lifterlms.readme.io/docs/filters-course)*
+ `lifterlms_product_purchase_account_redirect`
+ `lifterlms_product_purchase_redirect_membership_required`
+ `lifterlms_product_purchase_checkout_redirect`
+ `lifterlms_product_purchase_membership_redirect`
+ `lifterlms_lesson_complete_icon`
v1.5.0 - 2016-01-22
-------------------
##### WooCommerce Integration Enhancements
__NOTE: The following enhancements only apply when the WooCommerce Integration is enabled__
**Always redirect to the WooCommerce Cart when a SKU Matched Product can be found**
+ LifterLMS Products (courses and memberships) which are SKU matched to a WooCommerce product will now automatically add the related WooCommerce product to the WooCommerce shopping cart and then automatically redirect the visitor to the WooCommerce cart when the visitor attempts to enroll in a course or membership from the LifterLMS course or membership page.
+ If no WooCommerce product is found via a SKU match, the user will proceed to the LifterLMS checkout.
+ This will enable you to determine which Cart you want a user to use on a product by product basis. You may sell certain courses via WooCommerce and others via LifterLMS (should you choose to do so).
**Multiple Item Checkout**
+ When a WooCommerce order is complete user's will now be automatically enrolled in **all** courses and/or memberships in the WooCommerce order. This improves upon a previously limitation that would only allow WooCommerce checkout with one LifterLMS product at a time.
+ The products in the order will be intelligently SKU matched to LifterLMS Courses or Memberships.
+ You may also mix and match between WooCommerce products matched to LifterLMS products and those which are not matched to LifterLMS products. For example, your customers may now buy a Course via SKU matching as well as a T-Shirt that is not matched to a LifterLMS course via a SKU.
##### Other Fixes and improvements
+ Fixed a bug that caused quiz results to display for users who had never taken the quiz.
+ Added Wistia as an oEmbed provider to fix an issue related to default oembed handling in WordPress 4.4.
+ added a `.cc_cvv` class that mimics the existing `#cc_cvv` styles to allow gateway extensions to change the ID of the field in their credit card forms
+ Added support for new 1.4.5 capability fixes to be also be reflected under the "+New" menu item in the WP Admin Bar. There are no changes to the filters, the capability filters will simply also remove restricted post types from the admin bar now (as they should).
+ Tested and compatible up to WordPress 4.4.1
##### Deprecations
**The following functions have been staged for deprecation in LifterLMS 2.0!**
+ Setup the `is_account_page()` function to be replaced by `is_llms_account_page()` function. The original causes conflicts when WooCommerce is installed as WooCommerce includes a core function by the same name. All references to `is_account_page()` in LifterLMS have been removed and the original has been left to prevent issues with developers currently relying on the LifterLMS version of the function.
+ Setup the `is_checkout()` function to be replaced by `is_llms_checkout()` function. The original causes conflicts when WooCommerce is installed as WooCommerce includes a core function by the same name. All references to `is_checkout()` in LifterLMS have been removed and the original has been left to prevent issues with developers currently relying on the LifterLMS version of the function.
v1.4.5 - 2016-01-13
-------------------
+ Significant improvements to LifterLMS admin permissions as well as a hardening of permissions. Previously LifterLMS admin screens and menus were available to any users with `edit_posts` capabilities. This has been changed to `manage_options`. Filters for all screens and menus have been added with this release. If you're site currently relies on users with `edit_posts` to be able to access LifterLMS settings and analytics screens you must utilize these new filters in order to maintain their access. Please see full documentation on the new filters at [https://lifterlms.readme.io/docs/filters-admin-menu-and-screen-permissions](https://lifterlms.readme.io/docs/filters-admin-menu-and-screen-permissions). **Please consider testing your changes outside of production before updating to LifterLMS 1.4.5 in production.**
+ Allow "Payment Method" to be translated on the "Confirm Payment" screen
+ Allow the name of the payment gateway to be filtered on the "Confirm Payment" screen
+ Added pagination support to lifterlms membership archive pages
+ Fixed a bug related to some required global variables for quizzes and lessons being incorrectly set on certain hosts
+ updated readme file to remove incomplete documentation
+ Added Chosen multi-select options to admin panel metaboxes (settings and posts)
+ Added two new actions that developers can hook into:
+ `llms_user_enrolled_in_course`, called when users are enrolled in a course. Usage details available [here](https://lifterlms.readme.io/docs/actions-user#llms_user_enrolled_in_course).
+ `llms_user_added_to_membership_level`, called when users are added to a membership level. Usage details available [here](https://lifterlms.readme.io/docs/actions-user#llms_user_added_to_membership_level).
v1.4.4 - 2015-12-21
-------------------
##### Updates
+ My account page can now (optionally) display a list of memberships a student is currently enrolled in
+ Student analytics on the admin panel display student's Memberships
+ Student analytics on the admin panel will now display student's progress through courses in addition to their current enrollment status.
+ Custom taxonomy archive templates for Course tags, categories, tracks, and difficulties now exist and properly function.
+ Custom taxonomy archive templates for Membership categories and tags now exist and properly function.
+ Added the `[lifterlms_memberships]` shortcode which was documented but never implemented. Details on usage available at [https://lifterlms.readme.io/docs/short-codes#memberships-lifterlms_memberships](https://lifterlms.readme.io/docs/short-codes#memberships-lifterlms_memberships)
+ Added basic styles to LifterLMS pagination HTML elements (elements with class `.llms-pagination`) which formerly had no associated CSS.
##### Deprecations
+ Setup the `is_shop()` function to be replaced by `is_llms_shop()` function. The original causes conflicts when WooCommerce is installed as WooCommerce includes a core function by the same name. All references to `is_shop()` in LifterLMS have been removed and the original has been left to prevent issues with developers currently relying on the LifterLMS version of the function. It *will* be removed in the next major update (2.0) and will be noted as an officially deprecated feature at that time.
##### Bug fixes
+ Fixed pagination issues when using the `[lifterlms_courses]` shortcode
+ Fixed an issue with the `is_shop()` function that prevented courses per page option from functioning properly on the default course archive page
+ Student analytics profile on admin panel will display the correct number of memberships the student is enrolled in.
+ Fixed a small CSS issue that caused extra white space to be displayed above Course or Membership tiles on archive pages when using the WordPress Twentyfifteen default theme
##### Miscellaneous
+ Account settings screen displays the correct title ("Account Settings" it previously said "Archive Settings")
+ Made language changes to the LifterLMS settings intro screen copy
+ Added link to CourseClinic on settings intro screen
+ Added link to LifterLMS documentation on the settings intro screen
v1.4.3 - 2015-12-11
-------------------
+ Fixed an issue that could prevent some older servers from being able to run LifterLMS
v1.4.2 - 2015-12-10
-------------------
+ Tested and compatible with WordPress version 4.4
+ BugFixes: fixed issue in `llms_featured_img()` that was preventing the `$size` variable from being passed to the WP core function being utilized.
+ BugFixes: correctly handling conflicts with Plugin Update library
v1.4.1 - 2015-12-02
-------------------
+ Feature: Custom single price text - Display custom text for the single price on the courses and course page. Custom field does not require a single payment price be set. IE: Free!
+ Feature: Custom Purchase Course Button Text Option. Change the text of the Take This Course button in Settings->Courses.
+ Feature: New Become A Member button on courses that are restricted to memberships.
+ Feature: Custom Become A Member Text Option. Change the text of the become a member button in Settings->Courses.
+ Feature: Paypal Debug Mode. Enable debug mode in Settings->Gateways to view responses from Paypal API when errors occur.
+ Updates: Updated support links in Settings->General.
+ Updates: added minor styling to course page to increase margin and padding for some themes.
+ Updates: Achievement content now available to pull into custom templates. The Achievement content is not by default displayed but can now be used in custom templates.
+ BugFixes: Resolved issue with no default price selected at checkout when only recurring option existed.
+ BugFixes: Lesson prerequisite now alert the user and provide a link to redirect the user to the next required lesson in the course.
+ BugFixes: Paypal errors now return error message instead of white screen when Paypal API fails.
+ BugFixes: Corrected JavaScript error with modals on course edit page in Internet Explorer 11.
v1.4.0 - 2015-10-29
-------------------
+ Feature: Free lessons - demo lessons that can be taken at any time by any user
+ Feature: Guest lessons - demo lessons that can be taken by a non-logged in user
+ Feature: Random quiz question - quiz questions can now be set to be in user set order or random order
+ Updates: Automatically registers appropriate sidebars for Genesis theme
+ Updates: Backend file cleanup
+ Updates: Text cleanup
+ Updates: Adds greater localization support (more strings to translate! yay!)
+ Updates: Cleans up some unnecessary console.log() calls
+ Updates: Removes mass of commented out code (cleaner reading)
+ Updates: 'Next Lesson' button added after successful completion of quiz
+ Updates: 'Next Lesson' button at bottom of lesson properly gets starting lesson of next section at the end of the previous section
+ Updates: 'Previous Lesson' button at bottom of lesson will now properly get last lesson of previous section (if applicable)
+ Updates: Move Registration Form to global templates to allow users to disable registration on login page but use registration form on custom page.
+ BugFixes: WordPress pages are now properly restricted by memberships
+ BugFixes: Fixes bug that caused order screen to act up if user was deleted
+ BugFixes: Resolves nasty little bug that caused syllabus numbers to be out of whack
+ BugFixes: Resolved error with WooCommerce integration where courses would not always register the user
+ BugFixes: Corrected CSS conflict with Bridge theme settings page
v1.3.10 - 2015-10-15
--------------------
+ Updates: Clarifies some prerequisite text
+ Updates: Quiz questions are now randomized!
+ Updates: Fixes small CSS issue
+ BugFixes: Resolves fatal errors with a small subset of premium themes
v1.3.9 - 2015-10-5
------------------
+ BugFixes: Removes conflict with Yoast SEO
+ BugFixes: Fixes CSS issues with box-sizing takeover
+ Feature: New Settings Tile: Session Management. Found at LifterLMS->Settings->General.
+ Feature: Clear User Session Tool. You can now clear all LifterLMS user session data from your site in LifterLMS->Settings->General
+ Updates: Backend code cleanup
v1.3.8 - 2015-10-02
-------------------
+ BugFixes: Fixes Random error notices
+ Updates: Updates email template handler
v1.3.7 - 2015-09-25
-------------------
+ Updates: Adds Spanish translation
+ Updates: Adds new filter 'lifterlms_single_payment_text' to customize single payment string on checkout
+ Updates: Student analytics now indicate which courses a student has completed
+ BugFixes: Resolved security issue with WordPress searches and lessons
+ BugFixes: Fixes analytics bug that potentially arises after a course is deleted
v1.3.6 - 2015-09-18
-------------------
+ BugFixes: Fixes pesky Zend Error that plagued some unfortunate victims
+ BugFixes: Students can now be properly deleted from the course
+ BugFixes: Fixes random class redeclaration error messages
+ Updates: Adds new filter 'lifterlms_quiz_passed' to customize 'Passed' text after quiz
+ Updates: Adds new filter 'lifterlms_quiz_failed' to customize 'Failed' text after quiz
v1.3.5 - 2015-09-11
-------------------
+ Revisions: Fixes typos
+ Updates: Adds sidebar functionality to various themes
v1.3.4 - 2015-09-04
-------------------
+ BugFixes: Fixes bug with featured image on course page
+ BugFixes: Fixes issue with lesson completed percentage on analytics page
v1.3.3 - 2015-09-01
-------------------
+ Updates: Removes deprecated plugin updater
+ Updates: Adds Course Track prerequisite
+ Updates: Various text fixes
+ BugFixes: Fixes lesson name on prerequisite notification
+ BugFixes: Fixes critical error with WordPress customizer
v1.3.2 - 2015-08-30
-------------------
+ Hotfix: resolves issues with sidebar shortcodes
+ Updates: Text clarifications
v1.3.1 - 2015-08-28
-------------------
+ Hotfix: resolves issue with ajax url
v1.3.0 - 2015-08-28
-------------------
+ Improved popover behavior in course creation.
+ BugFixing. Prevent multiple lesson and section form submission
+ Fixed typos at backend quiz page
+ Fixed check for update bug when plugin isn't properly activated.
+ BugFixing, quiz post type should show author metabox
+ Added course category filter to lifter_lms shortcode
+ BugFixing, typo in [lifterlms_course_progress shortcode]
+ BugFixing, Analytics shouldn't fetch students meta info from users were deleted.
+ Adds in basic review functionality
+ Updates plugin-updater to remedy PHP conflicts
+ Fixes date bug in Analytics
+ Cleans up jQuery console messages
+ Adds in course tracks
v1.2.8 - 2015-07-17
-------------------
+ Updated Portuguese translation file
+ Fixed issue where quiz score could not be equal to required grade.
+ New Feature: Quiz Results Summary. Display the quiz results to the user on quiz completion.
+ New feature: Clarification. Display information about correct and incorrect answers to users
+ New Feature: Display correct answers to user on quiz completion
+ Removed ability to add negative time limit to quiz
+ New Membership feature: Make membership archive links go directly to checkout. Setting allows you to skip membership sales page and send users directly to registration and checkout.
+ Sidebar support for prototype theme
+ Sidebar support for X theme
+ Sidebar support for WooCanvas
+ New Shortcode: [lifterlms_hide_content]: Use to restrict content on a page, course or lesson to a specific membership. Pass the post id of the membership you want to restrict the content to. Example: [lifterlms_hide_content membership="5"]
+ New updates to gulp build process
+ Class autoloading and LLMS namespace introduced for more efficient coding.
v1.2.7 - 2015-06-05
-------------------
+ Minor bug fix with lesson redirect to quiz
+ Minor change to global Course object instantiation.
+ Bug Fix: Remove student from course
+ Bug Fix: Appearance Menus missing select field (THANKS ANDREA!)
+ New Course Setting: Hide Course Outline on course page
+ New Shortcode: [lifterlms_course_outline] - displays course outline with settings (see documentation)
+ Membership metabox design update
+ Certificate metabox design update
+ Achievement metabox design update
+ Lesson metabox design update
+ Emails metabox design update
+ Coupons metabox design update
+ Update to certificate design (better alignment and theme functionality)
+ Better theme sidebar support
+ More awesome control for developers building new settings for LifterLMS
+ Advanced filter system for metabox fields with finite control for 3rd party developers.
+ Woocommerce conflict correction to archive templates
+ Style updates to allow themes better control on design
v1.2.6 - 2015-04-28
-------------------
+ Corrected issue with lesson re-order on save
+ corrected html formatting issue on purchase page
+ corrected html formatting issue on course page
v1.2.5 - 2015-04-23
-------------------
+ Corrected excerpt to not pull in lesson navigation
+ Modified metabox api for better extension integration
+ Corrected issue with order not displaying all information if coupon was not applied to order
v1.2.4 - 2015-04-22
-------------------
+ Moved All Course metaboxes to global Course Options Metabox
+ Move Enrolled and Non-Enrolled user wysiwyg post editors to Options Metabox
+ Removed Course Syllabus metabox, Added Course Outline Metabox
+ Set priority of Course Outline and Course Options Metabox to top
+ Added ability to Create new section to Course Outline
+ Added ability to Create new lesson to Course Outline
+ Added ability to add existing Lesson to Course Outline
+ Added Lesson duplicate functionality when adding lesson previously assigned to another course.
+ Added ability to drag lessons between sections in Course Outline
+ Added ability to edit Section Title in Course Outline
+ Added ability to edit lesson title and excerpt in Course Outline
+ Added New Style and Design for better usability to Course Outline
+ Added Lesson Icon with tooltip to Course Outline: Prerequisite - shows if prerequisite exists and displays name of prerequisite
+ Added Lesson Icon with tooltip to Course Outline: Quiz - shows if quiz is assigned to course and displays name of quiz
+ Added Lesson Icon with tooltip to Course Outline: Drip Content - shows if drip days are set and # of days
+ Added Lesson Icon with tooltip to Course Outline: Content - displays if lesson has content added.
+ Added Course Outline Metabox to Lesson Post Editor: Allows you to assign lesson to section and view entire course tree. Links to Course and all other lessons in course.
+ Style Update: backgrounds on frontend. Removed all references to white background on front end elements
+ Corrected Restriction for course in past. Updated course in past message to display as Course ended instead of Course not available until.
+ Added restriction message when user attempts to visit a restricted lesson.
+ Updated course syllabus sidebar widget to not display lessons as links if user is not enrolled in course.
+ Added ability to use Attribute Order for sorting Courses and Memberships on Archive pages.
+ Added support for selling memberships with Woocommerce. LifterLMS now checks memberships for SKU matches in addition to Courses when products are purchased using WooCommerce.
+ Added gulp for scss, js and svg management
+ Added svg sprite and svg class for managing svg elements on front and backend.
+ Added better language translation support for strings
+ Refactored Ajax Classes for cleaner, faster development
+ Refactored metabox build class for cleaner, faster development
+ Refactored Course syllabus to reduce query size for larger, complex courses
+ Added Handler classes for Lessons, Sections, Courses and Posts
+ Refactored Course get / set methods to reduce database queries
v1.2.3 - 2015-03-12
-------------------
+ Achievement design and functionality updates
+ Achievement shortcode added
+ Better searching added to engagement screen
+ Achievement bug fixes
+ On screen error reporting added to activation for trouble shooting
+ Custom engagement methods added to certificate, achievement and sections
+ Corrected new user registration engagement bug
+ LifterLMS access reduced from manage_options to edit_posts
+ Filters added to analytics to allow custom development
+ Engagement bug fix: Section and Lesson bug select
+ Syllabus bug corrected: No longer displays lessons in section box if no sections exist.
+ Removed depreciated achievement template
+ Membership Bug fix: Membership restriction will now only display on single posts.
v1.2.2 - 2015-02-23
-------------------
+ Corrected drip content bug
+ Added Ajax functionality to quiz
+ rounded quiz grades
+ Added quiz time limit setting to Quiz
+ Added quiz timer to quiz, front end
+ Quiz allowed attempts field now allows unlimited attempts
+ Set Ajax lesson delete method to not return empty lesson value
+ Set next and previous questions to display below quiz question
+ Decoupled Single option select question type from quiz to allow for more question types
+ Added Quiz time limit to display on Quiz page
+ Added functionality to automatically complete quiz when quiz timer reaches 0
+ Moved Quiz functionality methods from front end forms class to Quiz class
v1.2.1 - 2015-02-19
-------------------
+ Updated settings page theming
+ Added Set up Quick Start Guide
+ Added Plugin Deactivation Option
+ Updated language POT file
+ Added Portuguese language support. Thank you Fernando Cassino for the translation :)
v1.2.0 - 2015-02-17
-------------------
+ Admin Course Analytics Dashboard Page. View at LifterLMS->Analytics->Course
+ Admin Sales Analytics Dashboard Page. View at LifterLMS->Analytics->Sales
+ Admin Memberships Analytics Dashboard Page. View at LifterLMS->Analytics->Memberships
+ Admin Students Search Page. View at LifterLMS->Students
+ Admin Student Profile Page ( View user information related to courses and memberships )
+ Lesson and Course Sidebar Widgets ( Syllabus, Course Progress )
+ Course Syllabus: Lesson blocks greyed out. Clicking lesson displays message to take course.
+ Misc. Front end bug fixes
+ Misc. Admin bug fixes
+ Course and Lesson prerequisites: Can no longer select a prerequisite without marking "Has Prerequisite"
+ Admin CSS updates
+ Better Session Management
+ Number and Date formatting handled by separate classes to provide consistent date formats across system
+ Zero dollar coupon management: Coupons that set total to 0 will bypass payment gateway, generate order and enroll users.
+ Better coupon verification.
+ Better third party payment gateway support. Third party gateway plugins are now easier to develop and integrate.
+ User Registration: Phone Number Registration field option now available in Accounts settings page.
v1.1.2 - 2014-12-18
-------------------
+ Moved Sidebar registration from plugin install to init
v1.1.1 - 2014-12-16
-------------------
+ Added user registration settings to require users to agree to Terms and Conditions on user registration
+ Added comments to all classes methods and functions
+ Removed unused and depreciated methods
+ Added Lesson and Course Sidebar Widget Areas
+ Fixed bug with course capacity option
+ Fixed bug with endpoint rewrite
+ Added localization POT file and us_EN.po translation file
v1.1.0 - 2014-12-08
-------------------
+ Updated HTML / CSS on Registration form
+ Added Coupon Creation
+ Added Coupon support for checkout processing
+ Added Credit Card Support processing support
+ Added Form filters for external integration
+ Added Form templates for external integration
+ Added Account Setting: Require First and Last Name on registration
+ Added Account Setting: Require Billing Address on registration
+ Added Account Setting: Require users to validate email address (double entry)
+ Added password validation (double entry) on user registration / account creation
+ Added Quiz Question post type and associated metaboxes
+ Added Quiz post type and associated metaboxes
+ Added ability to assign a quiz to a lesson
+ Added front end quiz functionality
+ Added Course capacity (limit # of students)
### User Admin Table
+ Added Membership Custom Column that displays user's membership information
+ Added "Last Login" custom column that displays user's last login date/time
### User Roles
+ Updated user role from "person" to "student"
+ Added temporary migration function to transition any register users with "person" role to "student" role
+ Added "Student" role install function
### BUDDYPRESS
+ BuddyPress Screen Permission Fix
+ Added two additional screens to BuddyPress: Certificates and Achievements
### MISC
+ Added llms options for course archive pagination and added course archive page pagination template
+ Added user statistics shortcode
v1.0.5 - 2014-11-12
-------------------
+ Fixed a mis-placed parenthesis in templates/course/lesson-navigation.php related to outputting excerpt in navigation option
+ Changed theme override template directory from /llms to /lifterlms
+ Update the position & name of the "My Courses" Menu in BuddyPress Compatibility file
+ New meta_key _parent_section added for easier connection and quicker queries.
+ Section sorting on course syllabus
+ Edit links added to course syllabus
+ Assign section to course and view associated lessons metabox added to sections
+ Assign lesson to section and view associated lessons metabox added to lessons
+ Assigned Course, Assigned Section, Prerequisite and Membership Required added to lesson edit grid
+ Assigned Course added to section edit grid'
+ New membership setting: Restrict Entire Site by Membership Level (allows site restriction to everything but membership purchase and account).
+ Updated template overriding to check child & parent themes
+ Updated template overriding to apply filters to directories to check for overrides to allow themes and plugins to add their own directories
v1.0.4 - 2014-11-04
-------------------
+ Templating bug fix
+ Added shortcode and autop support to course and lesson content / excerpt
v1.0.3 - 2014-11-04
-------------------
+ Major Templating Update!
+ Removed Course, Lesson and Membership single lesson templates.
+ Course and Section content templates now filter through WP content
v1.0.2 - 2014-10-31
-------------------
+ Added lesson short description to previous lesson preview links -- it was rendering on "Next" but not "Previous"
+ Added a class to course shop links wrapper to signify the course has been completed
+ Removed an unnecessary CSS rule related to the progress bar
v1.0.2 - 2014-10-30
-------------------
+ Fixed SSL certificate issues when retrieving data from https://lifterlms.com
+ Added rocket settings icon back into repo
v1.0.1 - 2014-10-30
-------------------
+ Updated activation endpoint url to point towards live server rather than dev
v1.0.0 - 2014-10-30
-------------------
+ Initial public release.
================================================
FILE: LICENSE
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
{one line to give the program's name and a brief idea of what it does.}
Copyright (C) {year} {name of author}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
{project} Copyright (C) {year} {fullname}
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
================================================
FILE: README.md
================================================
<h1 align="center">
<img src=".github/lifterlms-logo.png" alt="LifterLMS logo" width="300">
</h1>
<p align="center"><a href="https://lifterlms.com" title="LifterLMS website external link">LifterLMS</a> is a powerful WordPress learning management system plugin that makes it easy to create, sell, and protect engaging online courses and training based membership websites.</p>
<hr />
<div align="center">
[![WordPress Plugin Version][img-wp-plugin]][link-wp-repo]
[![WordPress Plugin Tested WP Version][img-wp-tested]][link-wp-repo]
[![PHP Supported Version][img-php]][link-php]
[![WordPress Plugin Rating][img-wp-rating]][link-wp-reviews]
[![WordPress Plugin Downloads][img-wp-downloads]][link-wp-advanced]
[![WordPress Plugin Active Installs][img-wp-installs]][link-wp-advanced]
[![PHPUnit Tests][img-phpunit-tests]][link-phpunit-tests]
[![PHPCS Coding Standards][img-phpcs-checks]][link-phpcs-checks]
[![Code Climate maintainability][img-cc-maintainability]][link-cc]
[![Code Climate test coverage][img-cc-coverage]][link-cc-coverage]
[![Contributions Welcome][img-contributions-welcome]](.github/CONTRIBUTING.md)
[![Contributors][img-contributors]](#contributors)
[![Slack community][img-slack]][link-slack]
</div>
<hr />
Welcome to the LifterLMS GitHub repository. This repository serves as the core project's central location for issue tracking and feature development.
If you're not a developer or contributor, please use [LifterLMS plugin page][link-wp-repo] at WordPress.org.
### Getting Help and Support
GitHub is for bug reports and contributions only! If you have a support question or a request for a customization this is not the right place to post it. Please refer to [LifterLMS Support][link-support] or the [community forums][link-support-forums]. If you're looking for help customizing LifterLMS, please consider hiring a [LifterLMS Expert][link-experts].
### Resources and Documentation
+ [Changelog](./CHANGELOG.md)
+ User documentation and knowledge base: https://lifterlms.com/docs/
+ Contributor's blog: https://make.lifterlms.com/
+ Developer portal: https://developer.lifterlms.com/
### Included Core Packages
The LifterLMS core includes several additional packages which are included in releases through composer. These core projects are installable as standalone plugins for development and testing purposes. The stable versions are automatically included in LifterLMS core releases.
These packages have their own GitHub repositories:
+ [LifterLMS Blocks](https://github.com/gocodebox/lifterlms-blocks)
+ [LifterLMS REST API](https://github.com/gocodebox/lifterlms-rest)
### Reporting a Bug
Bugs can be reported at https://github.com/gocodebox/lifterlms/issues/new.
Before reporting a bug, [search existing issues](https://github.com/gocodebox/lifterlms/issues) and ensure you're not creating a duplicate. If the issue already exists you can add your information to the existing report.
Also check our [known issues and conflicts](https://lifterlms.com/doc-category/lifterlms/known-conflicts/) for possible resolutions.
### Reporting a Security Vulnerability
Security issues and vulnerabilities should be responsibly disclosed directly to the LifterLMS core developers via email. Please see our [Security Policy](.github/SECURITY.md) for details on disclosing a security vulnerability.
### Installing
If you clone or download this repo directly it will not run as a plugin inside WordPress!
Installable production releases are available in on the [Releases tab](https://github.com/gocodebox/lifterlms/releases). You can get the latest stable release from [WordPress.org](https://downloads.wordpress.org/plugin/lifterlms.zip)
If you're interested in installing development versions, see [Installing for Development](docs/installing.md)
### Contributing
[![Contributions Welcome][img-contributions-welcome]](.github/CONTRIBUTING.md)
Interested in contributing to LifterLMS? We'd love to have your contributions. Read our contributor's guidelines [here](.github/CONTRIBUTING.md).
### Contributors
[![Contributors][img-contributors]](#contributors)
Endless thanks to all our incredible contributors!
[//]: contributor-faces
<a href="https://github.com/thomasplevy"><img src="https://avatars.githubusercontent.com/u/1290739?v=4" title="thomasplevy" width="80" height="80"></a>
<a href="https://github.com/eri-trabiccolo"><img src="https://avatars.githubusercontent.com/u/7689242?v=4" title="eri-trabiccolo" width="80" height="80"></a>
<a href="https://github.com/brianhogg"><img src="https://avatars.githubusercontent.com/u/627497?v=4" title="brianhogg" width="80" height="80"></a>
<a href="https://github.com/pondermatic"><img src="https://avatars.githubusercontent.com/u/5377968?v=4" title="pondermatic" width="80" height="80"></a>
<a href="https://github.com/ideadude"><img src="https://avatars.githubusercontent.com/u/33220397?v=4" title="ideadude" width="80" height="80"></a>
<a href="https://github.com/therealmarknelson"><img src="https://avatars.githubusercontent.com/u/5050601?v=4" title="therealmarknelson" width="80" height="80"></a>
<a href="https://github.com/PSmolic"><img src="https://avatars.githubusercontent.com/u/4542049?v=4" title="PSmolic" width="80" height="80"></a>
<a href="https://github.com/actuallyakash"><img src="https://avatars.githubusercontent.com/u/18614782?v=4" title="actuallyakash" width="80" height="80"></a>
<a href="https://github.com/seothemes"><img src="https://avatars.githubusercontent.com/u/24793388?v=4" title="seothemes" width="80" height="80"></a>
<a href="https://github.com/kimcoleman"><img src="https://avatars.githubusercontent.com/u/5312875?v=4" title="kimcoleman" width="80" height="80"></a>
<a href="https://github.com/bmatt468"><img src="https://avatars.githubusercontent.com/u/8673706?v=4" title="bmatt468" width="80" height="80"></a>
<a href="https://github.com/chrisbadgett"><img src="https://avatars.githubusercontent.com/u/12163552?v=4" title="chrisbadgett" width="80" height="80"></a>
<a href="https://github.com/MaximilianoRicoTabo"><img src="https://avatars.githubusercontent.com/u/1678457?v=4" title="MaximilianoRicoTabo" width="80" height="80"></a>
<a href="https://github.com/alimathis"><img src="https://avatars.githubusercontent.com/u/16086976?v=4" title="alimathis" width="80" height="80"></a>
<a href="https://github.com/nrherron92"><img src="https://avatars.githubusercontent.com/u/47434271?v=4" title="nrherron92" width="80" height="80"></a>
<a href="https://github.com/daniel-shuy"><img src="https://avatars.githubusercontent.com/u/17351764?v=4" title="daniel-shuy" width="80" height="80"></a>
<a href="https://github.com/andreasblumberg"><img src="https://avatars.githubusercontent.com/u/1697968?v=4" title="andreasblumberg" width="80" height="80"></a>
<a href="https://github.com/imknight"><img src="https://avatars.githubusercontent.com/u/77604?v=4" title="imknight" width="80" height="80"></a>
<a href="https://github.com/philwp"><img src="https://avatars.githubusercontent.com/u/5949352?v=4" title="philwp" width="80" height="80"></a>
<a href="https://github.com/alaa-alshamy"><img src="https://avatars.githubusercontent.com/u/2883734?v=4" title="alaa-alshamy" width="80" height="80"></a>
<a href="https://github.com/chetansatasiya"><img src="https://avatars.githubusercontent.com/u/7081284?v=4" title="chetansatasiya" width="80" height="80"></a>
<a href="https://github.com/actual-saurabh"><img src="https://avatars.githubusercontent.com/u/1739834?v=4" title="actual-saurabh" width="80" height="80"></a>
<a href="https://github.com/Mte90"><img src="https://avatars.githubusercontent.com/u/403283?v=4" title="Mte90" width="80" height="80"></a>
<a href="https://github.com/nikolapasic"><img src="https://avatars.githubusercontent.com/u/10199798?v=4" title="nikolapasic" width="80" height="80"></a>
<a href="https://github.com/AndreaBarghigiani"><img src="https://avatars.githubusercontent.com/u/190159?v=4" title="AndreaBarghigiani" width="80" height="80"></a>
<a href="https://github.com/yojance"><img src="https://avatars.githubusercontent.com/u/1916064?v=4" title="yojance" width="80" height="80"></a>
<a href="https://github.com/tpkemme"><img src="https://avatars.githubusercontent.com/u/3424234?v=4" title="tpkemme" width="80" height="80"></a>
<a href="https://github.com/paulgoodchild"><img src="https://avatars.githubusercontent.com/u/10562196?v=4" title="paulgoodchild" width="80" height="80"></a>
<a href="https://github.com/wenchen"><img src="https://avatars.githubusercontent.com/u/959457?v=4" title="wenchen" width="80" height="80"></a>
<a href="https://github.com/mcguffin"><img src="https://avatars.githubusercontent.com/u/402988?v=4" title="mcguffin" width="80" height="80"></a>
<a href="https://github.com/dineshchouhan"><img src="https://avatars.githubusercontent.com/u/15683967?v=4" title="dineshchouhan" width="80" height="80"></a>
<a href="https://github.com/hovpoghosyan"><img src="https://avatars.githubusercontent.com/u/9405480?v=4" title="hovpoghosyan" width="80" height="80"></a>
<a href="https://github.com/tnorthcutt"><img src="https://avatars.githubusercontent.com/u/796639?v=4" title="tnorthcutt" width="80" height="80"></a>
<a href="https://github.com/ThePikJoker"><img src="https://avatars.githubusercontent.com/u/16877156?v=4" title="ThePikJoker" width="80" height="80"></a>
<a href="https://github.com/nicolas-jaussaud"><img src="https://avatars.githubusercontent.com/u/33153717?v=4" title="nicolas-jaussaud" width="80" height="80"></a>
<a href="https://github.com/mrosati84"><img src="https://avatars.githubusercontent.com/u/855068?v=4" title="mrosati84" width="80" height="80"></a>
<a href="https://github.com/jasonyingling"><img src="https://avatars.githubusercontent.com/u/4986487?v=4" title="jasonyingling" width="80" height="80"></a>
<a href="https://github.com/jasonyingling-hlk"><img src="https://avatars.githubusercontent.com/u/196813470?v=4" title="jasonyingling-hlk" width="80" height="80"></a>
<a href="https://github.com/bsetiawan88"><img src="https://avatars.githubusercontent.com/u/5827051?v=4" title="bsetiawan88" width="80" height="80"></a>
<a href="https://github.com/yumashev"><img src="https://avatars.githubusercontent.com/u/37841388?v=4" title="yumashev" width="80" height="80"></a>
<a href="https://github.com/sujaypawar"><img src="https://avatars.githubusercontent.com/u/2222249?v=4" title="sujaypawar" width="80" height="80"></a>
<a href="https://github.com/AlexVCS"><img src="https://avatars.githubusercontent.com/u/49458917?v=4" title="AlexVCS" width="80" height="80"></a>
<a href="https://github.com/edent"><img src="https://avatars.githubusercontent.com/u/837136?v=4" title="edent" width="80" height="80"></a>
<a href="https://github.com/sekanderb"><img src="https://avatars.githubusercontent.com/u/3262638?v=4" title="sekanderb" width="80" height="80"></a>
<a href="https://github.com/sapayth"><img src="https://avatars.githubusercontent.com/u/15567340?v=4" title="sapayth" width="80" height="80"></a>
<a href="https://github.com/reedhewitt"><img src="https://avatars.githubusercontent.com/u/957141?v=4" title="reedhewitt" width="80" height="80"></a>
<a href="https://github.com/Nikschavan"><img src="https://avatars.githubusercontent.com/u/2931091?v=4" title="Nikschavan" width="80" height="80"></a>
<a href="https://github.com/nhandl3"><img src="https://avatars.githubusercontent.com/u/1247539?v=4" title="nhandl3" width="80" height="80"></a>
<a href="https://github.com/matthalliday"><img src="https://avatars.githubusercontent.com/u/249506?v=4" title="matthalliday" width="80" height="80"></a>
<a href="https://github.com/kamalahmed"><img src="https://avatars.githubusercontent.com/u/6803549?v=4" title="kamalahmed" width="80" height="80"></a>
<a href="https://github.com/moorscode"><img src="https://avatars.githubusercontent.com/u/2005352?v=4" title="moorscode" width="80" height="80"></a>
<a href="https://github.com/iTechsTR"><img src="https://avatars.githubusercontent.com/u/33372714?v=4" title="iTechsTR" width="80" height="80"></a>
<a href="https://github.com/unt01d"><img src="https://avatars.githubusercontent.com/u/11303423?v=4" title="unt01d" width="80" height="80"></a>
<a href="https://github.com/cadengrey"><img src="https://avatars.githubusercontent.com/u/30481164?v=4" title="cadengrey" width="80" height="80"></a>
<a href="https://github.com/andrewvaughan"><img src="https://avatars.githubusercontent.com/u/1119590?v=4" title="andrewvaughan" width="80" height="80"></a>
<a href="https://github.com/andrewlimaza"><img src="https://avatars.githubusercontent.com/u/12629136?v=4" title="andrewlimaza" width="80" height="80"></a>
<a href="https://github.com/README1ST"><img src="https://avatars.githubusercontent.com/u/30046495?v=4" title="README1ST" width="80" height="80"></a>
[//]: contributor-faces
### Partners and Sponsors
[<img src="https://raw.githubusercontent.com/gocodebox/lifterlms/trunk/.github/sponsors/browserstack-logo.png" height="60" alt="BrowserStack">](https://www.browserstack.com/)
[BrowserStack](https://www.browserstack.com/) helps us ensure LifterLMS looks great and works on every imaginable browser and device.
<!-- References: Links -->
[link-cc]: https://codeclimate.com/github/gocodebox/lifterlms "LifterLMS on Code Climate"
[link-cc-coverage]: https://codeclimate.com/github/gocodebox/lifterlms/coverage "Code coverage reports on Code Climate"
[link-experts]: https://lifterlms.com/docs/do-you-have-any-recommended-developers-who-can-modifycustomize-lifterlms/ "Hire a LifterLMS Expert"
[link-php]: https://www.php.net/supported-versions "PHP Support Versions"
[link-phpunit-tests]: https://github.com/gocodebox/lifterlms/actions/workflows/test-phpunit.yml "PHPUnit Tests Status"
[link-phpcs-checks]: https://github.com/gocodebox/lifterlms/actions/workflows/coding-standards.yml "PHPCS Coding Standards Checks"
[link-slack]: https://lifterlms.com/slack "Chat with the community on Slack"
[link-support]: https://lifterlms.com/my-account/my-tickets "LifterLMS customer support"
[link-support-forums]: https://wordpress.org/support/plugin/lifterlms "LifterLMS user support forums"
[link-wp-advanced]:https://wordpress.org/plugins/lifterlms/advanced/ "Advanced plugin details on the WordPress plugin repository"
[link-wp-repo]:https://wordpress.org/plugins/lifterlms/ "LifterLMS on the WordPress plugin repository"
[link-wp-reviews]:https://wordpress.org/support/plugin/lifterlms/reviews/ "Leave a review on the WordPress plugin repository"
[img-cc-coverage]:https://img.shields.io/codeclimate/coverage/gocodebox/lifterlms?style=for-the-badge&logo=code-climate
[img-cc-maintainability]:https://img.shields.io/codeclimate/maintainability/gocodebox/lifterlms?logo=code-climate&style=for-the-badge
[img-contributors]: https://img.shields.io/github/contributors/gocodebox/lifterlms?color=blue&style=for-the-badge&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48c3ZnIGlkPSJzdmcyIiB3aWR0aD0iNjQ1IiBoZWlnaHQ9IjU4NSIgdmVyc2lvbj0iMS4wIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPiA8ZyBpZD0ibGF5ZXIxIj4gIDxwYXRoIGlkPSJwYXRoMjQxNyIgZD0ibTI5Ny4zIDU1MC44N2MtMTMuNzc1LTE1LjQzNi00OC4xNzEtNDUuNTMtNzYuNDM1LTY2Ljg3NC04My43NDQtNjMuMjQyLTk1LjE0Mi03Mi4zOTQtMTI5LjE0LTEwMy43LTYyLjY4NS01Ny43Mi04OS4zMDYtMTE1LjcxLTg5LjIxNC0xOTQuMzQgMC4wNDQ1MTItMzguMzg0IDIuNjYwOC01My4xNzIgMTMuNDEtNzUuNzk3IDE4LjIzNy0zOC4zODYgNDUuMS02Ni45MDkgNzkuNDQ1LTg0LjM1NSAyNC4zMjUtMTIuMzU2IDM2LjMyMy0xNy44NDUgNzYuOTQ0LTE4LjA3IDQyLjQ5My0wLjIzNDgzIDUxLjQzOSA0LjcxOTcgNzYuNDM1IDE4LjQ1MiAzMC40MjUgMTYuNzE0IDYxLjc0IDUyLjQzNiA2OC4yMTMgNzcuODExbDMuOTk4MSAxNS42NzIgOS44NTk2LTIxLjU4NWM1NS43MTYtMTIxLjk3IDIzMy42LTEyMC4xNSAyOTUuNSAzLjAzMTYgMTkuNjM4IDM5LjA3NiAyMS43OTQgMTIyLjUxIDQuMzgwMSAxNjkuNTEtMjIuNzE1IDYxLjMwOS02NS4zOCAxMDguMDUtMTY0LjAxIDE3OS42OC02NC42ODEgNDYuOTc0LTEzNy44OCAxMTguMDUtMTQyLjk4IDEyOC4wMy01LjkxNTUgMTEuNTg4LTAuMjgyMTYgMS44MTU5LTI2LjQwOC0yNy40NjF6IiBmaWxsPSIjZGQ1MDRmIi8%2BIDwvZz48L3N2Zz4%3D
[img-contributions-welcome]: https://img.shields.io/badge/contributions-welcome-blue.svg?style=for-the-badge&logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPHN2ZyB3aWR0aD0iMTc5MiIgaGVpZ2h0PSIxNzkyIiB2aWV3Qm94PSIwIDAgMTc5MiAxNzkyIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPjxwYXRoIGQ9Ik02NzIgMTQ3MnEwLTQwLTI4LTY4dC02OC0yOC02OCAyOC0yOCA2OCAyOCA2OCA2OCAyOCA2OC0yOCAyOC02OHptMC0xMTUycTAtNDAtMjgtNjh0LTY4LTI4LTY4IDI4LTI4IDY4IDI4IDY4IDY4IDI4IDY4LTI4IDI4LTY4em02NDAgMTI4cTAtNDAtMjgtNjh0LTY4LTI4LTY4IDI4LTI4IDY4IDI4IDY4IDY4IDI4IDY4LTI4IDI4LTY4em05NiAwcTAgNTItMjYgOTYuNXQtNzAgNjkuNXEtMiAyODctMjI2IDQxNC02NyAzOC0yMDMgODEtMTI4IDQwLTE2OS41IDcxdC00MS41IDEwMHYyNnE0NCAyNSA3MCA2OS41dDI2IDk2LjVxMCA4MC01NiAxMzZ0LTEzNiA1Ni0xMzYtNTYtNTYtMTM2cTAtNTIgMjYtOTYuNXQ3MC02OS41di04MjBxLTQ0LTI1LTcwLTY5LjV0LTI2LTk2LjVxMC04MCA1Ni0xMzZ0MTM2LTU2IDEzNiA1NiA1NiAxMzZxMCA1Mi0yNiA5Ni41dC03MCA2OS41djQ5N3E1NC0yNiAxNTQtNTcgNTUtMTcgODcuNS0yOS41dDcwLjUtMzEgNTktMzkuNSA0MC41LTUxIDI4LTY5LjUgOC41LTkxLjVxLTQ0LTI1LTcwLTY5LjV0LTI2LTk2LjVxMC04MCA1Ni0xMzZ0MTM2LTU2IDEzNiA1NiA1NiAxMzZ6IiBmaWxsPSIjZmZmIi8+PC9zdmc+
[img-php]: https://img.shields.io/badge/PHP-7.2%2B-brightgreen?style=for-the-badge&logoColor=white&logo=php
[img-phpunit-tests]: https://img.shields.io/github/workflow/status/gocodebox/lifterlms/Test%20PHPUnit?label=PHPUnit&logo=github&style=for-the-badge
[img-phpcs-checks]: https://img.shields.io/github/workflow/status/gocodebox/lifterlms/Coding%20Standards?label=PHPCS&logo=github&style=for-the-badge
[img-slack]: https://img.shields.io/badge/chat-on%20slack-blueviolet?style=for-the-badge&logo=slack
[img-wp-downloads]: https://img.shields.io/wordpress/plugin/dt/lifterlms.svg?style=for-the-badge&logo=wordpress
[img-wp-installs]: https://img.shields.io/wordpress/plugin/installs/lifterlms.svg?style=for-the-badge&logo=wordpress
[img-wp-plugin]:https://img.shields.io/wordpress/plugin/v/lifterlms.svg?style=for-the-badge&logo=wordpress
[img-wp-rating]:https://img.shields.io/wordpress/plugin/r/lifterlms.svg?style=for-the-badge&logo=wordpress
[img-wp-tested]:https://img.shields.io/wordpress/v/lifterlms.svg?style=for-the-badge&logo=wordpress
================================================
FILE: assets/css/bricks-editor.css
================================================
i.llms-bricks-icon:before {
content: "";
display: block;
height: 20px;
width: 20px;
background-size: 20px 20px;
background-repeat: no-repeat;
margin: 15px auto;
}
i.llms-bricks-icon-lesson-progression::before {
background-image: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512' width='24' height='24' class='llms-block-icon' aria-hidden='true' focusable='false'><path d='M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM369 209L241 337c-9.4 9.4-24.6 9.4-33.9 0l-64-64c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l47 47L335 175c9.4-9.4 24.6-9.4 33.9 0s9.4 24.6 0 33.9z'></path></svg>");
}
i.llms-bricks-icon-course-author:before {
background-image: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512' class='llms-block-icon' aria-hidden='true' focusable='false'><path d='M224 256A128 128 0 1 0 224 0a128 128 0 1 0 0 256zm-45.7 48C79.8 304 0 383.8 0 482.3C0 498.7 13.3 512 29.7 512H418.3c16.4 0 29.7-13.3 29.7-29.7C448 383.8 368.2 304 269.7 304H178.3z'></path></svg>")
}
i.llms-bricks-icon-course-continue:before {
background-image: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512' class='llms-block-icon' aria-hidden='true' focusable='false'><path d='M448 160H320V128H448v32zM48 64C21.5 64 0 85.5 0 112v64c0 26.5 21.5 48 48 48H464c26.5 0 48-21.5 48-48V112c0-26.5-21.5-48-48-48H48zM448 352v32H192V352H448zM48 288c-26.5 0-48 21.5-48 48v64c0 26.5 21.5 48 48 48H464c26.5 0 48-21.5 48-48V336c0-26.5-21.5-48-48-48H48z'></path></svg>")
}
i.llms-bricks-icon-course-information:before {
background-image: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512' width='24' height='24' class='llms-block-icon' aria-hidden='true' focusable='false'><path d='M0 96C0 60.7 28.7 32 64 32H448c35.3 0 64 28.7 64 64V416c0 35.3-28.7 64-64 64H64c-35.3 0-64-28.7-64-64V96zm64 0v64h64V96H64zm384 0H192v64H448V96zM64 224v64h64V224H64zm384 0H192v64H448V224zM64 352v64h64V352H64zm384 0H192v64H448V352z'></path></svg>")
}
i.llms-bricks-icon-course-meta-info:before {
background-image: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512' class='llms-block-icon' aria-hidden='true' focusable='false'><path d='M256 512A256 256 0 1 0 256 0a256 256 0 1 0 0 512zM216 336h24V272H216c-13.3 0-24-10.7-24-24s10.7-24 24-24h48c13.3 0 24 10.7 24 24v88h8c13.3 0 24 10.7 24 24s-10.7 24-24 24H216c-13.3 0-24-10.7-24-24s10.7-24 24-24zm40-208a32 32 0 1 1 0 64 32 32 0 1 1 0-64z'></path></svg>")
}
i.llms-bricks-icon-course-progress:before {
background-image: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512' width='24' height='24' class='llms-block-icon' aria-hidden='true' focusable='false'><path d='M64 64c0-17.7-14.3-32-32-32S0 46.3 0 64V400c0 44.2 35.8 80 80 80H480c17.7 0 32-14.3 32-32s-14.3-32-32-32H80c-8.8 0-16-7.2-16-16V64zm406.6 86.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0L320 210.7l-57.4-57.4c-12.5-12.5-32.8-12.5-45.3 0l-112 112c-12.5 12.5-12.5 32.8 0 45.3s32.8 12.5 45.3 0L240 221.3l57.4 57.4c12.5 12.5 32.8 12.5 45.3 0l128-128z'></path></svg>")
}
i.llms-bricks-icon-course-syllabus:before {
background-image: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 512 512' class='llms-block-icon' aria-hidden='true' focusable='false'><path d='M152.1 38.2c9.9 8.9 10.7 24 1.8 33.9l-72 80c-4.4 4.9-10.6 7.8-17.2 7.9s-12.9-2.4-17.6-7L7 113C-2.3 103.6-2.3 88.4 7 79s24.6-9.4 33.9 0l22.1 22.1 55.1-61.2c8.9-9.9 24-10.7 33.9-1.8zm0 160c9.9 8.9 10.7 24 1.8 33.9l-72 80c-4.4 4.9-10.6 7.8-17.2 7.9s-12.9-2.4-17.6-7L7 273c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0l22.1 22.1 55.1-61.2c8.9-9.9 24-10.7 33.9-1.8zM224 96c0-17.7 14.3-32 32-32H480c17.7 0 32 14.3 32 32s-14.3 32-32 32H256c-17.7 0-32-14.3-32-32zm0 160c0-17.7 14.3-32 32-32H480c17.7 0 32 14.3 32 32s-14.3 32-32 32H256c-17.7 0-32-14.3-32-32zM160 416c0-17.7 14.3-32 32-32H480c17.7 0 32 14.3 32 32s-14.3 32-32 32H192c-17.7 0-32-14.3-32-32zM48 368a48 48 0 1 1 0 96 48 48 0 1 1 0-96z'></path></svg>")
}
i.llms-bricks-icon-instructors:before {
background-image: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 640 512' width='24' height='24' class='llms-block-icon' aria-hidden='true' focusable='false'><path d='M192 96a48 48 0 1 0 0-96 48 48 0 1 0 0 96zm-8 384V352h16V480c0 17.7 14.3 32 32 32s32-14.3 32-32V192h56 64 16c17.7 0 32-14.3 32-32s-14.3-32-32-32H384V64H576V256H384V224H320v48c0 26.5 21.5 48 48 48H592c26.5 0 48-21.5 48-48V48c0-26.5-21.5-48-48-48H368c-26.5 0-48 21.5-48 48v80H243.1 177.1c-33.7 0-64.9 17.7-82.3 46.6l-58.3 97c-9.1 15.1-4.2 34.8 10.9 43.9s34.8 4.2 43.9-10.9L120 256.9V480c0 17.7 14.3 32 32 32s32-14.3 32-32z'></path></svg>")
}
i.llms-bricks-icon-pricing-table:before {
background-image: url("data:image/svg+xml;utf8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 576 512' width='24' height='24' class='llms-block-icon' aria-hidden='true' focusable='false'><path d='M64 64C28.7 64 0 92.7 0 128V384c0 35.3 28.7 64 64 64H512c35.3 0 64-28.7 64-64V128c0-35.3-28.7-64-64-64H64zM272 192H496c8.8 0 16 7.2 16 16s-7.2 16-16 16H272c-8.8 0-16-7.2-16-16s7.2-16 16-16zM256 304c0-8.8 7.2-16 16-16H496c8.8 0 16 7.2 16 16s-7.2 16-16 16H272c-8.8 0-16-7.2-16-16zM164 152v13.9c7.5 1.2 14.6 2.9 21.1 4.7c10.7 2.8 17 13.8 14.2 24.5s-13.8 17-24.5 14.2c-11-2.9-21.6-5-31.2-5.2c-7.9-.1-16 1.8-21.5 5c-4.8 2.8-6.2 5.6-6.2 9.3c0 1.8 .1 3.5 5.3 6.7c6.3 3.8 15.5 6.7 28.3 10.5l.7 .2c11.2 3.4 25.6 7.7 37.1 15c12.9 8.1 24.3 21.3 24.6 41.6c.3 20.9-10.5 36.1-24.8 45c-7.2 4.5-15.2 7.3-23.2 9V360c0 11-9 20-20 20s-20-9-20-20V345.4c-10.3-2.2-20-5.5-28.2-8.4l0 0 0 0c-2.1-.7-4.1-1.4-6.1-2.1c-10.5-3.5-16.1-14.8-12.6-25.3s14.8-16.1 25.3-12.6c2.5 .8 4.9 1.7 7.2 2.4c13.6 4.6 24 8.1 35.1 8.5c8.6 .3 16.5-1.6 21.4-4.7c4.1-2.5 6-5.5 5.9-10.5c0-2.9-.8-5-5.9-8.2c-6.3-4-15.4-6.9-28-10.7l-1.7-.5c-10.9-3.3-24.6-7.4-35.6-14c-12.7-7.7-24.6-20.5-24.7-40.7c-.1-21.1 11.8-35.7 25.8-43.9c6.9-4.1 14.5-6.8 22.2-8.5V152c0-11 9-20 20-20s20 9 20 20z'></path></svg>")
}
================================================
FILE: assets/css/dancing-script.css
================================================
/* vietnamese */
@font-face {
font-family: 'Dancing Script';
src: url("../fonts/dancing-script/dancing-script-vietnamese-regular.woff2") format("woff2");
font-style: normal;
font-weight: 400;
font-display: swap;
unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+1EA0-1EF9, U+20AB;
}
/* latin-ext */
@font-face {
font-family: 'Dancing Script';
src: url("../fonts/dancing-script/dancing-script-latin-ext.woff2") format("woff2");
font-style: normal;
font-weight: 400;
font-display: swap;
unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-family: 'Dancing Script';
src: url("../fonts/dancing-script/dancing-script-latin-regular.woff2") format("woff2");
font-style: normal;
font-weight: 400;
font-display: swap;
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}
================================================
FILE: assets/css/imperial-script.css
================================================
/* vietnamese */
@font-face {
font-family: 'Imperial Script';
font-style: normal;
font-weight: 400;
font-display: swap;
src: url("../fonts/imperial-script/imperial-script-vietnamese-regular.woff2") format('woff2');
unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+1EA0-1EF9, U+20AB;
}
/* latin-ext */
@font-face {
font-family: 'Imperial Script';
font-style: normal;
font-weight: 400;
font-display: swap;
src: url("../fonts/imperial-script/imperial-script-latin-ext.woff2") format('woff2');
unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-family: 'Imperial Script';
font-style: normal;
font-weight: 400;
font-display: swap;
src: url("../fonts/imperial-script/imperial-script-latin-regular.woff2") format('woff2');
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}
================================================
FILE: assets/css/pirata-one.css
================================================
/* latin-ext */
@font-face {
font-family: 'Pirata One';
src: url("../fonts/pirata-one/pirata-one-latin-ext.woff2") format('woff2');
font-style: normal;
font-weight: 400;
font-display: swap;
unicode-range: U+0100-024F, U+0259, U+1E00-1EFF, U+2020, U+20A0-20AB, U+20AD-20CF, U+2113, U+2C60-2C7F, U+A720-A7FF;
}
/* latin */
@font-face {
font-family: 'Pirata One';
src: url("../fonts/pirata-one/pirata-one-latin-regular.woff2") format('woff2');
font-style: normal;
font-weight: 400;
font-display: swap;
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}
================================================
FILE: assets/css/unifraktur-maguntia.css
================================================
/* latin */
@font-face {
font-family: 'UnifrakturMaguntia';
src: url("../fonts/unifraktur-maguntia/unifraktur-maguntia-latin-regular.woff2") format('woff2');
font-style: normal;
font-weight: 400;
font-display: swap;
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
}
================================================
FILE: assets/js/app/llms-achievements.js
================================================
/**
* Front End Achievements
*
* @package LifterLMS/Scripts
*
* @since 3.14.0
* @version 6.10.2
*/
LLMS.Achievements = {
/**
* Init
*
* @since 3.14.0
* @since 4.5.1 Fix conditional loading check.
*
* @return {void}
*/
init: function() {
if ( $( '.llms-achievement' ).length ) {
var self = this;
$( function() {
self.bind();
self.maybe_open();
} );
}
},
/**
* Bind DOM events
*
* @since 3.14.0
*
* @return {void}
*/
bind: function() {
var self = this;
$( '.llms-achievement' ).each( function() {
self.create_modal( $( this ) );
} );
$( '.llms-achievement' ).on( 'click', function() {
var $this = $( this ),
id = 'achievement-' + $this.attr( 'data-id' ),
$modal = $( '#' + id );
if ( ! $modal.length ) {
self.create_modal( $this );
}
$modal.iziModal( 'open' );
} );
},
/**
* Creates modal a modal for an achievement
*
* @since 3.14.0
*
* @param obj $el The jQuery selector for the modal card.
* @return {void}
*/
create_modal: function( $el ) {
var id = 'achievement-' + $el.attr( 'data-id' ),
$modal = $( '#' + id );
if ( ! $modal.length ) {
$modal = $( '<div class="llms-achievement-modal" id="' + id + '" />' );
$( 'body' ).append( $modal );
}
$modal.iziModal( {
headerColor: '#3a3a3a',
group: 'achievements',
history: true,
loop: true,
overlayColor: 'rgba( 0, 0, 0, 0.6 )',
transitionIn: 'fadeInDown',
transitionOut: 'fadeOutDown',
width: 340,
onOpening: function( modal ) {
modal.setTitle( $el.find( '.llms-achievement-title' ).html() );
modal.setSubtitle( $el.find( '.llms-achievement-date' ).html() );
modal.setContent( '<div class="llms-achievement">' + $el.html() + '</div>' );
},
onClosing: function() {
window.history.pushState( '', document.title, window.location.pathname + window.location.search );
},
} );
},
/**
* On page load, opens a modal if the URL contains an achievement in the location hash
*
* @since 3.14.0
* @since 6.10.2 Sanitize achievement IDs before using window.location.hash to trigger the modal open.
*
* @return {void}
*/
maybe_open: function() {
let hash = window.location.hash.split( '-' );
if ( 2 !== hash.length ) {
return;
}
hash[1] = parseInt( hash[1] );
if ( '#achievement-' !== hash[0] || ! Number.isInteger( hash[1] ) ) {
return;
}
const a = document.querySelector( `a[href="${ hash.join( '-' ) }"]` )
if ( ! a ) {
return;
}
a.click();
}
};
================================================
FILE: assets/js/app/llms-ajax.js
================================================
/**
* Main Ajax class
* Handles Primary Ajax connection
*
* @package LifterLMS/Scripts
*
* @since Unknown
* @version Unknown
*/
LLMS.Ajax = {
/**
* Url
*
* @type {String}
*/
url: window.ajaxurl || window.llms.ajaxurl,
/**
* Type
*
* @type {[type]}
*/
type: 'post',
/**
* Data
*
* @type {[type]}
*/
data: [],
/**
* Cache
*
* @type {[type]}
*/
cache: false,
/**
* DataType
* defaulted to json
*
* @type {String}
*/
dataType: 'json',
/**
* Async
* default to false
*
* @type {Boolean}
*/
async: true,
response:[],
/**
* Initialize Ajax methods
*
* @since Unknown
* @since 4.4.0 Update ajax nonce source.
*
* @param {Object} obj Options object.
* @return {Object}
*/
init: function( obj ) {
// If obj is not of type object or null return false.
if ( obj === null || typeof obj !== 'object' ) {
return false;
}
// set object defaults if values are not supplied
obj.url = 'url' in obj ? obj.url : this.url;
obj.type = 'type' in obj ? obj.type : this.type;
obj.data = 'data' in obj ? obj.data : this.data;
obj.cache = 'cache' in obj ? obj.cache : this.cache;
obj.dataType = 'dataType' in obj ? obj.dataType : this.dataType;
obj.async = 'async' in obj ? obj.async : this.async;
// Add nonce to data object.
obj.data._ajax_nonce = window.llms.ajax_nonce || wp_ajax_data.nonce;
// Add post id to data object.
var $R = LLMS.Rest,
query_vars = $R.get_query_vars();
obj.data.post_id = 'post' in query_vars ? query_vars.post : null;
if ( ! obj.data.post_id && $( 'input#post_ID' ).length ) {
obj.data.post_id = $( 'input#post_ID' ).val();
}
return obj;
},
/**
* Call
* Called by external classes
* Sets up jQuery Ajax object
*
* @param {[object]} [object of ajax settings]
* @return {[mixed]} [false if not object or this]
*/
call: function(obj) {
// get default variables if not included in call
var settings = this.init( obj );
// if init return a response of false
if ( ! settings) {
return false;
} else {
this.request( settings );
}
return this;
},
/**
* Calls jQuery Ajax on settings object
*
* @return {[object]} [this]
*/
request: function(settings) {
$.ajax( settings );
return this;
}
};
================================================
FILE: assets/js/app/llms-donut.js
================================================
/**
* Create a Donut Chart
*
* @package LifterLMS/Scripts
*
* @since 3.9.0
* @version 4.15.0
*
* @link https://gist.github.com/joeyinbox/8205962
*
* @param {Object} $el jQuery element to draw a chart within.
*/
LLMS.Donut = function( $el ) {
/**
* Constructor
*
* @since 3.9.0
* @since 4.15.0 Flip animation in RTL.
*
* @param {Object} options Donut options.
* @return {Void}
*/
function Donut(options) {
this.settings = $.extend( {
element: options.element,
percent: 100
}, options );
this.circle = this.settings.element.find( 'path' );
this.settings.stroke_width = parseInt( this.circle.css( 'stroke-width' ) );
this.radius = ( parseInt( this.settings.element.css( 'width' ) ) - this.settings.stroke_width ) / 2;
this.angle = $( 'body' ).hasClass( 'rtl' ) ? 82.5 : 97.5; // Origin of the draw at the top of the circle
this.i = Math.round( 0.75 * this.settings.percent );
this.first = true;
this.increment = $( 'body' ).hasClass( 'rtl' ) ? -5 : 5;
this.animate = function() {
this.timer = setInterval( this.loop.bind( this ), 10 );
};
this.loop = function() {
this.angle += this.increment;
this.angle %= 360;
var radians = ( this.angle / 180 ) * Math.PI,
x = this.radius + this.settings.stroke_width / 2 + Math.cos( radians ) * this.radius,
y = this.radius + this.settings.stroke_width / 2 + Math.sin( radians ) * this.radius,
d;
if (this.first === true) {
d = this.circle.attr( 'd' ) + ' M ' + x + ' ' + y;
this.first = false;
} else {
d = this.circle.attr( 'd' ) + ' L ' + x + ' ' + y;
}
this.circle.attr( 'd', d );
this.i--;
if (this.i <= 0) {
clearInterval( this.timer );
}
};
}
/**
* Draw donut element
*
* @since 3.9.0
*
* @param {Object} $el jQuery element to draw a chart within.
* @return {Void}
*/
function draw( $el ) {
var path = '<path d="M100,100" />';
$el.append( '<svg preserveAspectRatio="xMidYMid" xmlns:xlink="http://www.w3.org/1999/xlink">' + path + '</svg>' );
var donut = new Donut( {
element: $el,
percent: $el.attr( 'data-perc' )
} );
donut.animate();
}
draw( $el );
};
================================================
FILE: assets/js/app/llms-forms.js
================================================
/**
* Forms
*
* @package LifterLMS/Scripts
*
* @since 5.0.0
* @version 7.0.0
*/
LLMS.Forms = {
/**
* Stores locale information.
*
* Added via PHP.
*
* @type {Object}
*/
address_info: {},
/**
* jQuery ref. to the city text field.
*
* @type {Object}
*/
$cities: null,
/**
* jQuery ref. to the countries select field.
*
* @type {Object}
*/
$countries: null,
/**
* jQuery ref. to the states select field.
*
* @type {Object}
*/
$states: null,
/**
* jQuery ref. to the hidden states holder field.
*
* @type {Object}
*/
$states_holder: null,
/**
* Init
*
* @since 5.0.0
* @since 5.3.3 Move select2 dependency check into the `bind_l10_selects()` method.
*
* @return {void}
*/
init: function() {
if ( $( 'body' ).hasClass( 'wp-admin' ) ) {
if ( ! ( $( 'body' ).hasClass( 'profile-php' ) || $( 'body' ).hasClass( 'user-edit-php' ) ) ) {
return;
}
}
var self = this;
self.bind_matching_fields();
self.bind_voucher_field();
self.bind_edit_account();
self.bind_l10n_selects();
},
/**
* Bind DOM events for the edit account screen.
*
* @since 5.0.0
*
* @return {void}
*/
bind_edit_account: function() {
// Not an edit account form.
if ( ! $( 'form.llms-person-form.edit-account' ).length ) {
return;
}
$( '.llms-toggle-fields' ).on( 'click', this.handle_toggle_click );
},
/**
* Bind DOM Events fields with dynamic localization values and language.
*
* @since 5.0.0
* @since 5.3.3 Bind select2-related events after ensuring select2 is available.
*
* @return {void}
*/
bind_l10n_selects: function() {
var self = this;
self.$cities = $( '#llms_billing_city' );
self.$countries = $( '.llms-l10n-country-select select' );
self.$states = $( '.llms-l10n-state-select select' );
self.$zips = $( '#llms_billing_zip' );
if ( ! self.$countries.length ) {
return;
}
var isSelect2Available = function() {
return ( undefined !== $.fn.llmsSelect2 );
};
LLMS.wait_for( isSelect2Available, function() {
if ( self.$states.length ) {
self.prep_state_field();
}
self.$countries.add( self.$states ).llmsSelect2( { width: '100%' } );
if ( window.llms.address_info ) {
self.address_info = JSON.parse( window.llms.address_info );
}
self.$countries.on( 'change', function() {
var val = $( this ).val();
self.update_locale_info( val );
} ).trigger( 'change' );
}, 'llmsSelect2' );
},
/**
* Ensure "matching" fields match.
*
* @since 5.0.0
*
* @return {Void}
*/
bind_matching_fields: function() {
var $fields = $( 'input[data-match]' ).not( '[type="password"]' );
$fields.each( function() {
var $field = $( this ),
$match = $( '#' + $field.attr( 'data-match' ) ),
$parents;
if ( $match.length ) {
$parents = $field.closest( '.llms-form-field' ).add( $match.closest( '.llms-form-field' ) );
$field.on( 'input change', function() {
var val_1 = $field.val(),
val_2 = $match.val();
if ( val_1 && val_2 && val_1 !== val_2 ) {
$parents.addClass( 'invalid' );
} else {
$parents.removeClass( 'invalid' );
}
} );
}
} );
},
/**
* Bind DOM events for voucher toggles UX.
*
* @since 5.0.0
*
* @return {void}
*/
bind_voucher_field: function() {
$( '#llms-voucher-toggle' ).on( 'click', function( e ) {
e.preventDefault();
$( '#llms_voucher' ).toggle();
} );
},
/**
* Retrieve the parent element for a given field.
*
* The parent element is hidden when the field isn't required.
*
* @since 5.0.0
* @since 7.0.0 Do not look for a WP column wrapper anymore, always return the field's wrapper div.
*
* @param {Object} $field jQuery dom object.
* @return {Object}
*/
get_field_parent: function( $field ) {
return $field.closest( '.llms-form-field' );
},
/**
* Retrieve the text of a label
*
* Removes any children HTML elements (eg: required span elements) and returns only the labels text.
*
* @since 5.0.0
*
* @param {Object} $label jQuery object for a label element.
* @return {String}
*/
get_label_text: function( $label ) {
var $clone = $label.clone();
$clone.find( '*' ).remove();
return $clone.text().trim();
},
/**
* Callback function to handle the "toggle" button links for changing email address and password on account edit forms
*
* @since 5.0.0
*
* @param {Object} event Native JS event object.
* @return {void}
*/
handle_toggle_click: function( event ) {
event.preventDefault();
var $this = $( this ),
$fields = $( $( this ).attr( 'data-fields' ) ),
isShowing = $this.attr( 'data-is-showing' ) || 'no',
displayFunc = 'yes' === isShowing ? 'hide' : 'show',
disabled = 'yes' === isShowing ? 'disabled' : null,
textAttr = 'yes' === isShowing ? 'data-change-text' : 'data-cancel-text';
$fields.each( function() {
$( this ).closest( '.llms-form-field' )[ displayFunc ]();
$( this ).attr( 'disabled', disabled );
} );
$this.text( $this.attr( textAttr ) );
$this.attr( 'data-is-showing', 'yes' === isShowing ? 'no' : 'yes' );
},
/**
* Prepares the state select field.
*
* Moves All optgroup elements into a hidden & disabled select element.
*
* @since 5.0.0
*
* @return {void}
*/
prep_state_field: function() {
var $parent = this.$states.closest( '.llms-form-field' );
this.$holder = $( '<select disabled style="display:none !important;" />' );
this.$holder.appendTo( $parent );
this.$states.find( 'optgroup' ).appendTo( this.$holder );
},
/**
* Updates the text of a label for a given field.
*
* @since 5.0.0
*
* @param {Object} $field jQuery object of the form field.
* @param {String} text Label text.
* @return {void}
*/
update_label: function( $field, text ) {
var $label = this.get_field_parent( $field ).find( 'label' ),
$required = $label.find( '.llms-required' ).clone();
$label.html( text );
$label.append( $required );
},
/**
* Update form fields based on selected country
*
* Replaces label text with locale-specific language and
* hides or shows zip fields based on whether or not
* they are required for the given country.
*
* @since 5.0.0
*
* @param {String} country_code Currently selected country code.
* @return {void}
*/
update_locale_info: function( country_code ) {
if ( ! this.address_info || ! this.address_info[ country_code ] ) {
return;
}
var info = this.address_info[ country_code ];
this.update_state_options( country_code );
this.update_label( this.$states, info.state );
this.update_locale_info_for_field( this.$cities, info.city );
this.update_locale_info_for_field( this.$zips, info.postcode );
},
/**
* Update locale info for a given field.
*
* @since 5.0.0
*
* @param {Object} $field The jQuery object for the field.
* @param {String|Boolean} label The text of the label, or `false` when the field isn't supported.
* @return {Void}
*/
update_locale_info_for_field: function( $field, label ) {
if ( label ) {
this.update_label( $field, label );
this.enable_field( $field );
} else {
this.disable_field( $field );
}
},
/**
* Update the available options in the state field
*
* Removes existing options and copies the options
* for the requested country from the hidden select field.
*
* If there are no states for the given country the state
* field will be hidden.
*
* @since 5.0.0
*
* @param {String} country_code Currently selected country code.
* @return {void}
*/
update_state_options: function( country_code ) {
if ( ! this.$states.length ) {
return;
}
var opts = this.$holder.find( 'optgroup[data-key="' + country_code + '"] option' ).clone();
if ( ! opts.length ) {
this.$states.html( '<option> </option>' );
this.disable_field( this.$states );
} else {
this.enable_field( this.$states );
this.$states.html( opts );
}
},
/**
* Disable a given field
*
* It also hides the parent element, and adds an empty hidden input field
* with the same 'name' as teh being disabled field so to be sure to clear the field.
*
* @since 5.0.0
*
* @param {Object} $field The jQuery object for the field.
*/
disable_field: function( $field ) {
$(
'<input>',
{ name: $field.attr('name'), class: $field.attr( 'class' ) + ' hidden', type: 'hidden' }
).insertAfter( $field );
$field.attr( 'disabled', 'disabled' );
this.get_field_parent( $field ).hide();
},
/**
* Enable a given field
*
* It also shows the parent element, and removes the empty hidden input field
* previously added by disable_field().
*
* @since 5.0.0
*
* @param {Object} $field The jQuery object for the field.
*/
enable_field: function( $field ) {
$field.removeAttr( 'disabled' );
$field.next( '.hidden[name='+$field.attr('name')+']' ).detach();
this.get_field_parent( $field ).show();
}
};
================================================
FILE: assets/js/app/llms-instructors.js
================================================
/**
* Instructors List
*
* @package LifterLMS/Scripts
*
* @since Unknown
* @version Unknown
*/
LLMS.Instructors = {
/**
* Init
*/
init: function() {
var self = this;
if ( $( 'body' ).hasClass( 'wp-admin' ) ) {
return;
}
if ( $( '.llms-instructors' ).length ) {
LLMS.wait_for_matchHeight( function() {
self.bind();
} );
}
},
/**
* Bind Method
* Handles dom binding on load
*
* @return {[type]} [description]
*/
bind: function() {
$( '.llms-instructors .llms-author' ).matchHeight();
},
};
================================================
FILE: assets/js/app/llms-l10n.js
================================================
/**
* Localization functions for LifterLMS Javascript
*
* @package LifterLMS/Scripts
*
* @since 2.7.3
* @version 2.7.3
*
* @todo we need more robust translation functions to handle sprintf and pluralization
* at this moment we don't need those and haven't stubbed them out
* those will be added when they're needed
*/
LLMS.l10n = LLMS.l10n || {};
LLMS.l10n.translate = function ( string ) {
var self = this;
if ( self.strings[string] ) {
return self.strings[string];
} else {
return string;
}
};
/**
* Translate and replace placeholders in a string
*
* @example LLMS.l10n.replace( 'This is a %2$s %1$s String', {
* '%1$s': 'cool',
* '%2$s': 'very'
* } );
* Output: "This is a very cool String"
*
* @param string string text string
* @param object replacements object containing token => replacement pairs
* @return string
* @since 3.16.0
* @version 3.16.0
*/
LLMS.l10n.replace = function( string, replacements ) {
var str = this.translate( string );
$.each( replacements, function( token, value ) {
if ( -1 !== token.indexOf( 's' ) ) {
value = value.toString();
} else if ( -1 !== token.indexOf( 'd' ) ) {
value = value * 1;
}
str = str.replace( token, value );
} );
return str;
};
================================================
FILE: assets/js/app/llms-lesson-preview.js
================================================
/**
* Handle Lesson Preview Elements
*
* @package LifterLMS/Scripts
*
* @since 3.0.0
* @version 3.16.12
*/
LLMS.LessonPreview = {
/**
* A jQuery object of all outlines present on the current screen
*
* @type obj
*/
$els: null,
/**
* Initialize
*
* @return void
*/
init: function() {
var self = this;
this.$locked = $( '.llms-lesson-locked' );
if ( this.$locked.length ) {
self.bind();
}
if ( $( '.llms-course-navigation' ).length ) {
LLMS.wait_for_matchHeight( function() {
self.match_height();
} );
}
},
/**
* Bind DOM events
*
* @return void
* @since 3.0.0
* @version 3.16.12
*/
bind: function() {
var self = this;
this.$locked.on( 'mouseenter', function() {
var $tip = $( this ).find( '.llms-tooltip' );
if ( ! $tip.length ) {
var msg = $( this ).attr( 'data-tooltip-msg' );
if ( ! msg ) {
msg = LLMS.l10n.translate( 'You do not have permission to access this content' );
}
$tip = self.get_tooltip( msg );
$( this ).append( $tip );
}
setTimeout( function() {
$tip.addClass( 'show' );
}, 10 );
} );
this.$locked.on( 'mouseleave', function() {
var $tip = $( this ).find( '.llms-tooltip' );
$tip.removeClass( 'show' );
} );
},
/**
* Match the height of lesson preview items in course navigation blocks
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
match_height: function() {
$( '.llms-course-navigation .llms-lesson-link' ).matchHeight();
},
/**
* Get a tooltip element
*
* @param string msg message to display inside the tooltip
* @return obj
* @since 3.0.0
* @version 3.2.4
*/
get_tooltip: function( msg ) {
var $el = $( '<div class="llms-tooltip" />' );
$el.append(
$('<div>', {
'class': 'llms-tooltip-content',
'aria-hidden': 'true'
}).text( msg )
);
return $el;
},
};
================================================
FILE: assets/js/app/llms-outline-collapse.js
================================================
/**
* Handle the Collapsible Syllabus Widget / Shortcode
*
* @package LifterLMS/Scripts
*
* @since Unknown
* @version Unknown
*/
LLMS.OutlineCollapse = {
/**
* A jQuery object of all outlines present on the current screen
*
* @type obj
*/
$outlines: null,
/**
* Initialize
*
* @return void
*/
init: function() {
this.$outlines = $( '.llms-widget-syllabus--collapsible' );
if ( this.$outlines.length ) {
this.bind();
}
},
/**
* Bind DOM events
*
* @return void
*/
bind: function() {
var self = this;
this.$outlines.each( function() {
var $outline = $( this ),
$headers = $outline.find( '.llms-section .section-header' );
// bind header clicks
$headers.on( 'click', function( e ) {
e.preventDefault();
var $toggle = $( this ),
$section = $toggle.closest( '.llms-section' ),
state = self.get_section_state( $section );
switch ( state ) {
case 'closed':
self.open_section( $section );
break;
case 'opened':
self.close_section( $section );
break;
}
} );
// bind optional toggle "buttons"
$outline.find( '.llms-collapse-toggle' ).on( 'click', function( e ) {
e.preventDefault();
var $btn = $( this ),
action = $btn.attr( 'data-action' ),
opposite_action = ( 'close' === action ) ? 'opened' : 'closed';
$headers.each( function() {
var $section = $( this ).closest( '.llms-section' ),
state = self.get_section_state( $section );
if ( opposite_action !== state ) {
return true;
}
switch ( state ) {
case 'closed':
self.close_section( $section );
break;
case 'opened':
self.open_section( $section );
break;
}
$( this ).trigger( 'click' );
} );
} );
} );
},
/**
* Close an outline section
*
* @param obj $section jQuery selector of a '.llms-section'
* @return void
*/
close_section: function( $section ) {
$section.removeClass( 'llms-section--opened' ).addClass( 'llms-section--closed' );
},
/**
* Open an outline section
*
* @param obj $section jQuery selector of a '.llms-section'
* @return void
*/
open_section: function( $section ) {
$section.removeClass( 'llms-section--closed' ).addClass( 'llms-section--opened' );
},
/**
* Get the current state (open or closed) of an outline section
*
* @param obj $section jQuery selector of a '.llms-section'
* @return string 'opened' or 'closed'
*/
get_section_state: function( $section ) {
return $section.hasClass( 'llms-section--opened' ) ? 'opened' : 'closed';
}
};
================================================
FILE: assets/js/app/llms-password-strength.js
================================================
/**
* Handle Password Strength Meter for registration and password update fields
*
* @package LifterLMS/Scripts
*
* @since 3.0.0
* @version 5.0.0
*/
$.extend( LLMS.PasswordStrength, {
/**
* jQuery ref for the password strength meter object.
*
* @type {Object}
*/
$meter: $( '.llms-password-strength-meter' ),
/**
* jQuery ref for the password field.
*
* @type {Object}
*/
$pass: null,
/**
* jQuery ref for the password confirmation field
*
* @type {Object}
*/
$conf: null,
/**
* jQuery ref for form element.
*
* @type {Object}
*/
$form: null,
/**
* Init
* loads class methods
*
* @since 3.0.0
* @since 3.7.0 Unknown
* @since 5.0.0 Move reference setup to `setup_references()`.
* Use `LLMS.wait_for()` for dependency waiting.
*
* @return {Void}
*/
init: function() {
if ( $( 'body' ).hasClass( 'wp-admin' ) ) {
return;
}
if ( ! this.setup_references() ) {
return;
}
var self = this;
LLMS.wait_for( function() {
return ( 'undefined' !== typeof wp && 'undefined' !== typeof wp.passwordStrength );
}, function() {
self.bind();
self.$form.trigger( 'llms-password-strength-ready' );
} );
},
/**
* Bind DOM Events
*
* @since 3.0.0
*
* @return void
*/
bind: function() {
var self = this;
// add submission event handlers when not on a checkout form
if ( ! this.$form.hasClass( 'llms-checkout' ) ) {
self.$form.on( 'submit', self, self.submit );
}
// check password strength on keyup
self.$pass.add( self.$conf ).on( 'keyup', function() {
self.check_strength();
} );
},
/**
* Check the strength of a user entered password
* and update elements depending on the current strength
*
* @since 3.0.0
* @since 5.0.0 Allow password confirmation to be optional when checking strength.
*
* @return void
*/
check_strength: function() {
var $pass_field = this.$pass.closest( '.llms-form-field' ),
$conf_field = this.$conf && this.$conf.length ? this.$conf.closest( '.llms-form-field' ) : null,
pass_length = this.$pass.val().length,
conf_length = this.$conf && this.$conf.length ? this.$conf.val().length : 0;
// hide the meter if both fields are empty
if ( ! pass_length && ! conf_length ) {
$pass_field.removeClass( 'valid invalid' );
if ( $conf_field ) {
$conf_field.removeClass( 'valid invalid' );
}
this.$meter.hide();
return;
}
if ( this.get_current_strength_status() ) {
$pass_field.removeClass( 'invalid' ).addClass( 'valid' );
if ( conf_length ) {
$conf_field.removeClass( 'invalid' ).addClass( 'valid' );
}
} else {
$pass_field.removeClass( 'valid' ).addClass( 'invalid' );
if ( conf_length ) {
$conf_field.removeClass( 'valid' ).addClass( 'invalid' );
}
}
this.$meter.removeClass( 'too-short very-weak weak medium strong mismatch' );
this.$meter.show().addClass( this.get_current_strength( 'slug' ) );
this.$meter.html( this.get_current_strength( 'text' ) );
},
/**
* Form submission action called during registration on checkout screen
*
* @since 3.0.0
*
* @param obj self instance of this class
* @param Function callback callback function, passes error message or success back to checkout handler
* @return void
*/
checkout: function( self, callback ) {
if ( self.get_current_strength_status() ) {
callback( true );
} else {
callback( LLMS.l10n.translate( 'There is an issue with your chosen password.' ) );
}
},
/**
* Get the list of blocklisted strings
*
* @since 5.0.0
*
* @return array
*/
get_blocklist: function() {
// Default values from WP Core + any values added via settings filter..
var blocklist = wp.passwordStrength.userInputDisallowedList().concat( this.get_setting( 'blocklist', [] ) );
// Add values from all text fields in the form.
this.$form.find( 'input[type="text"], input[type="email"], input[type="tel"], input[type="number"]' ).each( function() {
var val = $( this ).val();
if ( val ) {
blocklist.push( val );
}
} );
return blocklist;
},
/**
* Retrieve current strength as a number, a slug, or a translated text string
*
* @since 3.0.0
* @since 5.0.0 Allow password confirmation to be optional when checking strength.
*
* @param {String} format Derived return format [int|slug|text] defaults to int.
* @return mixed
*/
get_current_strength: function( format ) {
format = format || 'int';
var pass = this.$pass.val(),
conf = this.$conf && this.$conf.length ? this.$conf.val() : '',
val;
// enforce custom length requirement
if ( pass.length < this.get_setting( 'min_length', 6 ) ) {
val = -1;
} else {
val = wp.passwordStrength.meter( pass, this.get_blocklist(), conf );
// 0 is very weak (ie. using something on the block list), 1 is considered weak.
if ( 1 === val ) {
val = 2;
}
if ( 0 === val ) {
val = 1;
}
}
if ( 'slug' === format ) {
return this.get_strength_slug( val );
} else if ( 'text' === format ) {
return this.get_strength_text( val );
} else {
return val;
}
},
/**
* Determines if the current password strength meets the user-defined
* minimum password strength requirements
*
* @since 3.0.0
*
* @return boolean
*/
get_current_strength_status: function() {
var curr = this.get_current_strength(),
min = this.get_strength_value( this.get_minimum_strength() );
return ( 5 === curr ) ? false : ( curr >= min );
},
/**
* Retrieve the minimum password strength for the current form.
*
* @since 3.0.0
* @since 5.0.0 Replaces the version output via an inline PHP script in favor of utilizing values configured in the settings object.
*
* @return {string}
*/
get_minimum_strength: function() {
return this.get_setting( 'min_strength', 'weak' );
},
/**
* Get a setting and fallback to a default value.
*
* @since 5.0.0
*
* @param {String} key Setting key.
* @param {mixed} default_val Default value when the requested setting cannot be located.
* @return {mixed}
*/
get_setting: function( key, default_val ) {
var settings = this.get_settings();
return settings[ key ] ? settings[ key ] : default_val;
},
/**
* Get the slug associated with a strength value
*
* @since 3.0.0
*
* @param int strength_val Strength value number.
* @return string
*/
get_strength_slug: function( strength_val ) {
var slugs = {
'-1': 'too-short',
1: 'very-weak',
2: 'weak',
3: 'medium',
4: 'strong',
5: 'mismatch',
};
return ( slugs[ strength_val ] ) ? slugs[ strength_val ] : slugs[5];
},
/**
* Gets the translated text associated with a strength value
*
* @since 3.0.0
*
* @param {Integer} strength_val Strength value
* @return {String}
*/
get_strength_text: function( strength_val ) {
var texts = {
'-1': LLMS.l10n.translate( 'Too Short' ),
1: LLMS.l10n.translate( 'Very Weak' ),
2: LLMS.l10n.translate( 'Weak' ),
3: LLMS.l10n.translate( 'Medium' ),
4: LLMS.l10n.translate( 'Strong' ),
5: LLMS.l10n.translate( 'Mismatch' ),
};
return ( texts[ strength_val ] ) ? texts[ strength_val ] : texts[5];
},
/**
* Get the value associated with a strength slug
*
* @since 3.0.0
*
* @param string strength_slug A strength slug.
* @return {Integer}
*/
get_strength_value: function( strength_slug ) {
var values = {
'too-short': -1,
'very-weak': 1,
weak: 2,
medium: 3,
strong: 4,
mismatch: 5,
};
return ( values[ strength_slug ] ) ? values[ strength_slug ] : values.mismatch;
},
/**
* Setup jQuery references to DOM elements needed to power the password meter.
*
* @since 5.0.0
*
* @return {Boolean} Returns `true` if a meter element and password field are found, otherwise returns `false`.
*/
setup_references: function() {
if ( ! this.$meter.length ) {
return false;
}
this.$form = this.$meter.closest( 'form' );
this.$pass = this.$form.find( 'input#password' );
if ( this.$pass.length && this.$pass.attr( 'data-match' ) ) {
this.$conf = this.$form.find( '#' + this.$pass.attr( 'data-match' ) );
}
return ( this.$pass.length > 0 );
},
/**
* Form submission handler for registration and update forms
*
* @since 3.0.0
* @since 5.0.0 Allow the account edit for to bypass strength checking when the password field is disabled (not being submitted).
*
* @param obj e Event data.
* @return void
*/
submit: function( e ) {
var self = e.data;
e.preventDefault();
self.$pass.trigger( 'keyup' );
// Meets the status requirements OR we're on the account edit form and the password field is disabled.
if ( self.get_current_strength_status() || ( self.$form.hasClass( 'edit-account' ) && 'disabled' === self.$pass.attr( 'disabled' ) ) ) {
self.$form.off( 'submit', self.submit );
self.$form.trigger( 'submit' );
} else {
$( 'html, body' ).animate( {
scrollTop: self.$meter.offset().top - 100,
}, 200 );
self.$meter.hide();
setTimeout( function() {
self.$meter.fadeIn( 400 );
}, 220 );
}
},
/**
* Get the list of blocklist strings
*
* @since 3.0.0
* @deprecated 5.0.0 `LLMS.PasswordStrength.get_blacklist()` is deprecated in favor of `LLMS.PasswordStrength.get_blocklist()`.
*
* @return array
*/
get_blacklist: function() {
console.log( 'Method `get_blacklist()` is deprecated in favor of `get_blocklist()`.' );
return this.get_blacklist();
},
} );
================================================
FILE: assets/js/app/llms-pricing-tables.js
================================================
/**
* Pricing Table UI
*
* @package LifterLMS/Scripts
*
* @since Unknown.
* @version Unknown.
*/
LLMS.Pricing_Tables = {
/**
* Init
*/
init: function() {
var self = this;
if ( $( 'body' ).hasClass( 'wp-admin' ) ) {
return;
}
if ( $( '.llms-access-plans' ).length ) {
LLMS.wait_for_matchHeight( function() {
self.bind();
} );
this.$locked = $( 'a[href="#llms-plan-locked"]' );
if ( this.$locked.length ) {
LLMS.wait_for_popover( function() {
self.bind_locked();
} );
}
}
},
/**
* Bind Method
* Handles dom binding on load
*
* @return {[type]} [description]
*/
bind: function() {
$( '.llms-access-plan-content' ).matchHeight();
$( '.llms-access-plan-pricing.trial' ).matchHeight();
},
/**
* Setup a popover for members-only restricted plans
*
* @return void
* @since 3.0.0
* @version 3.9.1
*/
bind_locked: function() {
this.$locked.each( function() {
$( this ).webuiPopover( {
animation: 'pop',
closeable: true,
content: function( e ) {
var $content = $( '<div class="llms-members-only-restrictions" />' );
$content.append( e.$element.closest( '.llms-access-plan' ).find( '.llms-access-plan-restrictions ul' ).clone() );
return $content;
},
placement: 'top',
style: 'inverse',
title: LLMS.l10n.translate( 'Members Only Pricing' ),
width: '280px',
} );
} );
},
};
================================================
FILE: assets/js/app/llms-quiz-attempt.js
================================================
/**
* Quiz Attempt
*
* @package LifterLMS/Scripts
*
* @since 7.3.0
* @version 7.3.0
*/
LLMS.Quiz_Attempt = {
/**
* Initialize
*
* @return void
*/
init: function() {
$( '.llms-quiz-attempt-question-header a.toggle-answer' ).on( 'click', function( e ) {
e.preventDefault();
var $curr = $( this ).closest( 'header' ).next( '.llms-quiz-attempt-question-main' );
$( this ).closest( 'li' ).siblings().find( '.llms-quiz-attempt-question-main' ).slideUp( 200 );
if ( $curr.is( ':visible' ) ) {
$curr.slideUp( 200 );
} else {
$curr.slideDown( 200 );
}
} );
}
}
================================================
FILE: assets/js/app/llms-review.js
================================================
/**
* LifterLMS Reviews JS
*
* @package LifterLMS/Scripts
*
* @since Unknown
* @version Unknown
*/
LLMS.Review = {
/**
* Init
* loads class methods
*/
init: function() {
// console.log('Initializing Review ');
this.bind();
},
/**
* This function binds actions to the appropriate hooks
*/
bind: function() {
$( '#llms_review_submit_button' ).click(function()
{
if ($( '#review_title' ).val() !== '' && $( '#review_text' ).val() !== '') {
jQuery.ajax({
type : 'post',
dataType : 'json',
url : window.llms.ajaxurl,
data : {
action : 'LLMSSubmitReview',
review_title: $( '#review_title' ).val(),
review_text: $( '#review_text' ).val(),
pageID : $( '#post_ID' ).val(),
llms_review_nonce: $( '#llms_review_nonce' ).val()
},
success: function()
{
console.log( 'Review success' );
$( '#review_box' ).hide( 'swing' );
$( '#thank_you_box' ).show( 'swing' );
},
error: function(jqXHR, textStatus, errorThrown )
{
console.log( jqXHR );
console.log( textStatus );
console.log( errorThrown );
},
});
} else {
if ($( '#review_title' ).val() === '') {
$( '#review_title_error' ).show( 'swing' );
} else {
$( '#review_title_error' ).hide( 'swing' );
}
if ($( '#review_text' ).val() === '') {
$( '#review_text_error' ).show( 'swing' );
} else {
$( '#review_text_error' ).hide( 'swing' );
}
}
});
if ( $( '#_llms_display_reviews' ).attr( 'checked' ) ) {
$( '.llms-num-reviews-top' ).addClass( 'top' );
$( '.llms-num-reviews-bottom' ).show();
} else {
$( '.llms-num-reviews-bottom' ).hide();
}
$( '#_llms_display_reviews' ).change(function() {
if ( $( '#_llms_display_reviews' ).attr( 'checked' ) ) {
$( '.llms-num-reviews-top' ).addClass( 'top' );
$( '.llms-num-reviews-bottom' ).show();
} else {
$( '.llms-num-reviews-top' ).removeClass( 'top' );
$( '.llms-num-reviews-bottom' ).hide();
}
});
},
};
================================================
FILE: assets/js/app/llms-storage.js
================================================
/* global LLMS, $ */
// = include ../vendor/js.cookie.js
/**
* Create a no conflict reference to JS Cookies.
*
* @type {Object}
*/
LLMS.CookieStore = Cookies.noConflict();
/**
* Store information in Local Storage by group.
*
* @since 3.36.0
* @since 3.37.14 Use persistent reference to JS Cookies.
* @since 4.2.0 Set sameSite to `strict` for cookies.
*
* @param string group Storage group id/name.
*/
LLMS.Storage = function( group ) {
var self = this,
store = LLMS.CookieStore;
/**
* Clear all data for the group.
*
* @since 3.36.0
*
* @return void
*/
this.clearAll = function() {
store.remove( group );
};
/**
* Clear a single item from the group by key.
*
* @since 3.36.0
*
* @return obj
*/
this.clear = function( key ) {
var data = self.getAll();
delete data[ key ];
return store.set( group, data );
};
/**
* Retrieve (and parse) all data stored for the group.
*
* @since 3.36.0
*
* @return obj
*/
this.getAll = function() {
return store.getJSON( group ) || {};
}
/**
* Retrieve an item from the group by key.
*
* @since 3.36.0
*
* @param string key Item key/name.
* @param mixed default_val Item default value to be returned when item not found in the group.
* @return mixed
*/
this.get = function( key, default_val ) {
var data = self.getAll();
return data[ key ] ? data[ key ] : default_val;
}
/**
* Store an item in the group by key.
*
* @since 3.36.0
* @since 4.2.0 Set sameSite to `strict` for cookies.
*
* @param string key Item key name.
* @param mixed val Item value
* @return obj
*/
this.set = function( key, val ) {
var data = self.getAll();
data[ key ] = val;
return store.set( group, data, { sameSite: 'strict' } );
};
}
================================================
FILE: assets/js/app/llms-student-dashboard.js
================================================
/**
* Student Dashboard related JS
*
* @package LifterLMS/Scripts
*
* @since 3.7.0
* @since 3.10.0 Bind events on the orders screen.
* @since 5.0.0 Removed redundant password toggle logic for edit account screen.
* @version 5.0.0
*/
LLMS.StudentDashboard = {
/**
* Slug for the current screen/endpoint
*
* @type {String}
*/
screen: '',
/**
* Init
*
* @since 3.7.0
* @since 3.10.0 Unknown
* @since 5.0.0 Removed password toggle logic.
*
* @return void
*/
init: function() {
if ( $( '.llms-student-dashboard' ).length ) {
this.bind();
if ( 'orders' === this.get_screen() ) {
this.bind_orders();
}
}
},
/**
* Bind DOM events
*
* @since 3.7.0
* @since 3.7.4 Unknown.
* @since 5.0.0 Removed password toggle logic.
*
* @return void
*/
bind: function() {
$( '.llms-donut' ).each( function() {
LLMS.Donut( $( this ) );
} );
},
/**
* Bind events related to the orders screen on the dashboard
*
* @since 3.10.0
*
* @return void
*/
bind_orders: function() {
$( '#llms-cancel-subscription-form' ).on( 'submit', this.order_cancel_warning );
$( '#llms_update_payment_method' ).on( 'click', function() {
$( 'input[name="llms_payment_gateway"]:checked' ).trigger( 'change' );
$( this ).closest( 'form' ).find( '.llms-switch-payment-source-main' ).slideToggle( '200' );
} );
},
/**
* Get the current dashboard endpoint/tab slug
*
* @since 3.10.0
*
* @return void
*/
get_screen: function() {
if ( ! this.screen ) {
this.screen = $( '.llms-student-dashboard' ).attr( 'data-current' );
}
return this.screen;
},
/**
* Show a confirmation warning when Cancel Subscription form is submitted
*
* @since 3.10.0
*
* @param obj e JS event data.
* @return void
*/
order_cancel_warning: function( e ) {
e.preventDefault();
var msg = LLMS.l10n.translate( 'Are you sure you want to cancel your subscription?' );
if ( window.confirm( LLMS.l10n.translate( msg ) ) ) {
$( this ).off( 'submit', this.order_cancel_warning );
$( this ).submit();
}
},
};
================================================
FILE: assets/js/app/llms-tracking.js
================================================
/* global LLMS, $ */
/**
* User event/interaction tracking.
*
* @since 3.36.0
* @since 3.36.2 Fix JS error when settings aren't loaded.
* @since 3.37.2 When adding an event to the storae also make sure the nonce is set for server-side verification.
* @since 3.37.9 Fix IE compatibility issue related to usage of `Object.assign()`.
* @since 3.37.14 Persist the tracking events via ajax when reaching the cookie size limit.
* @since 5.0.0 Set `settings` as an empty object when no settings supplied.
* @since 7.1.0 Only attempt to add a nonce to the datastore when a nonce exists in the settings object.
*/
LLMS.Tracking = function( settings ) {
settings = settings || {};
var self = this,
store = new LLMS.Storage( 'llms-tracking' );
settings = 'string' === typeof settings ? JSON.parse( settings ) : settings;
/**
* Initialize / Bind all tracking event listeners.
*
* @since 3.36.0
* @since 5.0.0 Only attempt to add a nonce to the datastore when a nonce exists in the settings object.
* @since 7.1.0 Do not add a nonce to the datastore by default, will be added/updated
* when storing an event to track.
*
* @return {void}
*/
function init() {
self.addEvent( 'page.load' );
window.addEventListener( 'beforeunload', onBeforeUnload );
window.addEventListener( 'pagehide', onUnload );
document.addEventListener( 'visibilitychange', onVisibilityChange );
};
/**
* Add an event.
*
* @since 3.36.0
* @since 3.36.2 Fix error when settings aren't loaded.
* @since 3.37.2 Always make sure the nonce is set for server-side verification.
* @since 3.37.14 Persist the tracking events via ajax when reaching the cookie size limit.
* @since 7.1.0 Only attempt to add a nonce to the datastore when a nonce exists in the settings object.
*
* @param string|obj event Event Id (type.event) or a full event object from `this.makeEventObj()`.
* @param int args Optional additional arguments to pass to `this.makeEventObj()`.
* @return {void}
*/
this.addEvent = function( event, args ) {
args = args || {};
if ( 'string' === typeof event ) {
args.event = event;
}
// If the event isn't registered in the settings don't proceed.
if ( !settings.events || -1 === settings.events.indexOf( args.event ) ) {
return;
}
// Make sure the nonce is set for server-side verification.
if ( settings.nonce ) {
store.set( 'nonce', settings.nonce );
}
event = self.makeEventObj( args );
var all = store.get( 'events', [] );
all.push( event );
store.set( 'events', all );
// If couldn't store the latest event because of size limits.
if ( settings.saving_frequency === 'always' || all.length > store.get( 'events', [] ).length ) {
// Copy the cookie in a temporary variable.
var _temp = store.getAll();
// Clear the events from the cookie.
store.clear('events');
// Add the latest event to the temporary variable.
_temp['events'].push( event );
// Send the temporary variable as string via ajax.
LLMS.Ajax.call( {
data: {
action: 'persist_tracking_events',
'llms-tracking': JSON.stringify(_temp)
},
error: function( xhr, status, error ) {
console.log( xhr, status, error );
},
success: function( r ) {
if ( 'error' === r.code ) {
console.log(r.code, r.message);
}
}
} );
}
}
/**
* Retrieve initialization settings.
*
* @since 3.36.0
*
* @return obj
*/
this.getSettings = function() {
return settings;
}
/**
* Create an event object suitable to save as an event.
*
* @since 3.36.0
* @since 3.37.9 Use `$.extend()` in favor of `Object.assign()`.
*
* @param obj event {
* Event hash
*
* @param {string} event (Required) Event ID, eg: "page.load".
* @param {url} url Event URL. (Optional, added automatically) Stored as metadata and used to infer an object_id for post events.
* @param {time} float (Optional, added automatically) Timestamp (in milliseconds). Used for the event creation date.
* @param {int} obj_id (Optional). The object ID. Inferred automatically via `url` if not provided.
* @param {obj} meta (Optional) Hash of metadata to store with the event.
* }
* @return obj
*/
this.makeEventObj = function( event ) {
return $.extend( event, {
url: window.location.href,
time: Math.round( new Date().getTime() / 1000 ),
} );
}
/**
* Remove the visibility change event listener on window.beforeunload
*
* Prevents actual unloading from recording a blur event from the visibility change listener
*
* @param obj e JS event object.
* @return void
*/
function onBeforeUnload( e ) {
document.removeEventListener( 'visibilitychange', onVisibilityChange );
}
/**
* Record a `page.exit` event on window.unload.
*
* @since 3.36.0
*
* @param obj e JS event object.
* @return void
*/
function onUnload( e ) {
self.addEvent( 'page.exit' );
}
/**
* Record `page.blur` and `page.focus` events via document.visilibitychange events.
*
* @since 3.36.0
*
* @param obj e JS event object.
* @return void
*/
function onVisibilityChange( e ) {
var event = document.hidden ? 'page.blur' : 'page.focus';
self.addEvent( event );
}
// Initialize on the frontend only.
if ( ! $( 'body' ).hasClass( 'wp-admin' ) ) {
init();
}
};
llms.tracking = new LLMS.Tracking( llms.tracking );
================================================
FILE: assets/js/app/llms-visibility-toggle.js
================================================
/**
* Handle Password Visibility Toggle for LifterLMS Forms
*
* @package LifterLMS/Scripts
*
* @since TBD
*/
LLMS.PasswordVisibility = {
/**
* Initialize references and setup event binding
*
* @since TBD
* @return void
*/
init: function() {
this.$toggleButtons = $( '.llms-visibility-toggle button' );
if ( this.$toggleButtons.length ) {
this.$toggleButtons.removeClass( 'hide-if-no-js' );
this.bind();
}
},
/**
* Bind DOM events for toggle buttons
*
* @since TBD
* @return void
*/
bind: function() {
var self = this;
// Remove any previous click events and bind the new click event
this.$toggleButtons.off('click').on('click', function(event) {
self.toggleVisibility( $(this) );
});
},
/**
* Toggle visibility of password fields
*
* @since TBD
* @param {Object} $button The jQuery object of the clicked button
* @return void
*/
toggleVisibility: function( $button ) {
var isVisible = parseInt( $button.attr('data-toggle'), 10 );
var $form = $button.closest( '.llms-form-fields' );
var $passwordFields = $form.find( 'input.llms-field-input' );
var $icon = $button.find( 'i' );
var $stateText = $button.find( '.llms-visibility-toggle-state' );
// Toggle the visibility state
if ( isVisible === 1 ) {
// Show password
$passwordFields.filter('[type="password"]').attr('type', 'text');
$button.attr('data-toggle', 0);
$icon.removeClass('fa-eye').addClass('fa-eye-slash');
$stateText.text(LLMS.l10n.translate('Hide Password'));
} else {
// Hide password
$passwordFields.filter('[type="text"]').attr('type', 'password');
$button.attr('data-toggle', 1);
$icon.removeClass('fa-eye-slash').addClass('fa-eye');
$stateText.text(LLMS.l10n.translate('Show Password'));
}
}
};
// Initialize the Password Visibility module on document ready
jQuery(document).ready(function($) {
LLMS.PasswordVisibility.init();
});
================================================
FILE: assets/js/app/rest.js
================================================
/**
* Rest Methods
* Manages URL and Rest object parsing
*
* @package LifterLMS/Scripts
*
* @since Unknown
* @version Unknown
*/
LLMS.Rest = {
/**
* Init
* loads class methods
*/
init: function() {
this.bind();
},
/**
* Bind Method
* Handles dom binding on load
*
* @return {[type]} [description]
*/
bind: function() {
},
/**
* Searches for string matches in url path
*
* @param {Array} strings [Array of strings to search for matches]
* @return {Boolean} [Was a match found?]
*/
is_path: function( strings ) {
var path_exists = false,
url = window.location.href;
for ( var i = 0; i < strings.length; i++ ) {
if ( url.search( strings[i] ) > 0 && ! path_exists ) {
path_exists = true;
}
}
return path_exists;
},
/**
* Retrieves query variables
*
* @return {[Array]} [array object of query variable key=>value pairs]
*/
get_query_vars: function() {
var vars = [], hash,
hashes = window.location.href.slice( window.location.href.indexOf( '?' ) + 1 ).split( '&' );
for (var i = 0; i < hashes.length; i++) {
hash = hashes[i].split( '=' );
vars.push( hash[0] );
vars[hash[0]] = hash[1];
}
return vars;
}
};
================================================
FILE: assets/js/builder/Collections/Lessons.js
================================================
/**
* Lessons Collection
*
* @since 3.13.0
* @version 3.17.0
*/
define( [ 'Models/Lesson' ], function( model ) {
return Backbone.Collection.extend( {
/**
* Model for collection items
*
* @type obj
*/
model: model,
/**
* Initializer
*
* @return void
* @since 3.16.0
* @version 3.17.0
*/
initialize: function() {
// reorder called by LessonList view when sortable drops occur
this.on( 'reorder', this.on_reorder );
// when a lesson is added or removed, update order
this.on( 'add', this.on_reorder );
this.on( 'remove', this.on_reorder );
},
/**
* On lesson reorder callback
*
* Update the order attr of each lesson to reflect the new lesson order
* Validate prerequisite (if set) and unset it if it's no longer a valid prereq
*
* @return void
* @since 3.17.0
* @version 3.17.0
*/
on_reorder: function() {
this.update_order();
this.validate_prereqs();
},
/**
* Update lesson order attribute of all lessons when lessons are reordered
*
* @return void
* @since 3.16.0
* @version 3.17.0
*/
update_order: function() {
this.each( function( lesson ) {
lesson.set( 'order', this.indexOf( lesson ) + 1 );
}, this );
},
/**
* Validate prerequisite (if set) and unset it if it's no longer a valid prereq
*
* @return void
* @since 3.17.0
* @version 3.17.0
*/
validate_prereqs: function() {
this.each( function( lesson ) {
// validate prereqs
if ( 'yes' === lesson.get( 'has_prerequisite' ) ) {
var valid = _.pluck( _.flatten( _.pluck( lesson.get_available_prereq_options(), 'options' ) ), 'key' );
if ( -1 === valid.indexOf( lesson.get( 'prerequisite' ) * 1 ) ) {
lesson.set( {
prerequisite: 0,
has_prerequisite: 'no',
} );
}
}
}, this );
},
} );
} );
================================================
FILE: assets/js/builder/Collections/QuestionChoices.js
================================================
/**
* Question Choice Collection
*
* @since 3.16.0
* @version 3.16.0
*/
define( [ 'Models/QuestionChoice' ], function( model ) {
return Backbone.Collection.extend( {
/**
* Model for collection items
*
* @type obj
*/
model: model,
initialize: function() {
// reorder called by QuestionList view when sortable drops occur
this.on( 'reorder', this.update_order );
// when a choice is added or removed, update order
this.on( 'add', this.update_order );
this.on( 'remove', this.update_order );
// when a choice is added or remove, ensure min/max correct answers exist
this.on( 'add', this.update_correct );
this.on( 'remove', this.update_correct );
// when a choice is toggled, ensure min/max correct exist
this.on( 'correct-update', this.update_correct );
},
/**
* Retrieve the number of correct choices in the collection
*
* @return int
* @since 3.16.0
* @version 3.16.0
*/
count_correct: function() {
return _.size( this.get_correct() );
},
/**
* Retrieve the collection reduced to only correct choices
*
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
get_correct: function() {
return this.filter( function( choice ) {
return choice.get( 'correct' );
} );
},
/**
* Ensure min/max correct choices exist in the collection based on the question's settings
*
* @param obj choice model of the choice that was toggled
* @return void
* @since 3.16.0
* @version 3.16.0
*/
update_correct: function( choice ) {
if ( ! this.parent.get( 'question_type' ).get_choice_selectable() ) {
return;
}
var siblings = this.without( choice ), // exclude the toggled choice from loops
question = this.parent;
// if multiple choices aren't enabled turn all other choices to incorrect
if ( 'no' === question.get( 'multi_choices' ) ) {
_.each( siblings, function( model ) {
model.set( 'correct', false );
} );
}
// if we don't have a single correct answer & the question has points, set one
// allows users to create quizzes / questions with no points and therefore no correct answers are allowed
if ( 0 === this.count_correct() && question.get( 'points' ) > 0 ) {
var models = 1 === this.size() ? this.models : siblings;
_.first( models ).set( 'correct', true );
}
},
/**
* Update the marker attr of each choice in the list to reflect the order of the collection
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
update_order: function() {
var self = this,
question = this.parent;
this.each( function( choice ) {
choice.set( 'marker', question.get( 'question_type' ).get_choice_markers()[ self.indexOf( choice ) ] );
} );
},
} );
} );
================================================
FILE: assets/js/builder/Collections/QuestionTypes.js
================================================
/**
* Quiz Question Type Collection
*
* @since 3.16.0
* @version 3.16.0
*/
define( [ 'Models/QuestionType' ], function( model ) {
return Backbone.Collection.extend( {
/**
* Model for collection items
*
* @type obj
*/
model: model,
/**
* Initializer
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
initialize: function() {
this.on( 'add', this.comparator );
this.on( 'remove', this.comparator );
},
/**
* Comparator (sorts collection)
*
* @param obj model QuestionType model
* @return void
* @since 3.16.0
* @version 3.16.0
*/
comparator: function( model ) {
return model.get( 'group' ).order;
},
} );
} );
================================================
FILE: assets/js/builder/Collections/Questions.js
================================================
/**
* Questions Collection
*
* @since 3.16.0
* @version 3.16.0
*/
define( [ 'Models/Question' ], function( model ) {
return Backbone.Collection.extend( {
/**
* Model for collection items
*
* @type obj
*/
model: model,
/**
* Initialize
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
initialize: function() {
// reorder called by QuestionList view when sortable drops occur
this.on( 'reorder', this.update_order );
// when a question is added or removed, update order
this.on( 'add', this.update_order );
this.on( 'remove', this.update_order );
this.on( 'add', this.update_parent );
},
/**
* Update the order attr of each question in the list to reflect the order of the collection
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
update_order: function() {
var self = this;
this.each( function( question ) {
question.set( 'menu_order', self.indexOf( question ) + 1 );
} );
},
/**
* When adding a question to a question list, update the question's parent
* Will ensure that questions moved into and out of groups always have the correct parent_id
*
* @param obj model instance of the question model
* @return void
* @since 3.16.0
* @version 3.16.0
*/
update_parent: function( model ) {
model.set( 'parent_id', this.parent.get( 'id' ) );
},
} );
} );
================================================
FILE: assets/js/builder/Collections/Sections.js
================================================
/**
* Sections Collection
*
* @since 3.16.0
* @version 3.16.0
*/
define( [ 'Models/Section' ], function( model ) {
return Backbone.Collection.extend( {
/**
* Model for collection items
*
* @type obj
*/
model: model,
/**
* Initialize
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
initialize: function() {
var self = this;
// reorder called by SectionList view when sortable drops occur
this.on( 'reorder', this.update_order );
// when a section is added or removed, update order
this.on( 'add', this.update_order );
this.on( 'remove', this.update_order );
},
/**
* Update the order attr of each section in the list to reflect the order of the collection
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
update_order: function() {
var self = this;
this.each( function( section ) {
section.set( 'order', self.indexOf( section ) + 1 );
} );
},
} );
} );
================================================
FILE: assets/js/builder/Collections/loader.js
================================================
/**
* Lessons Collection
*
* @since 3.13.0
* @version 3.16.0
*/
define( [
'Collections/Lessons',
'Collections/QuestionChoices',
'Collections/Questions',
'Collections/QuestionTypes',
'Collections/Sections'
], function(
Lessons,
QuestionChoices,
Questions,
QuestionTypes,
Sections
) {
return {
Lessons: Lessons,
QuestionChoices: QuestionChoices,
Questions: Questions,
QuestionTypes: QuestionTypes,
Sections: Sections,
};
} );
================================================
FILE: assets/js/builder/Controllers/Construct.js
================================================
/**
* Constructor functions for constructing models, views, and collections
*
* @since 3.16.0
* @version 3.17.1
*/
define( [
'Collections/loader',
'Models/loader',
'Views/_loader'
], function(
Collections,
Models,
Views
) {
return function() {
/**
* Internal getter
* Constructs new Collections, Models, and Views
*
* @param obj type type of object to construct [Collection,Model,View]
* @param string name name of the object to construct
* @param obj data object data to pass into the object's constructor
* @param obj options object options to pass into the constructor
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
function get( type, name, data, options ) {
if ( ! type[ name ] ) {
console.log( '"' + name + '" not found.' );
return false;
}
return new type[ name ]( data, options );
}
/**
* Instantiate a collection
*
* @param string name Collection class name (EG: "Sections")
* @param array data Array of model objects to pass to the constructor
* @param obj options Object of options to pass to the constructor
* @return obj
* @since 3.17.0
* @version 3.17.0
*/
this.get_collection = function( name, data, options ) {
return get( Collections, name, data, options );
};
/**
* Instantiate a model
*
* @param string name Model class name (EG: "Section")
* @param obj data Object of model attributes to pass to the constructor
* @param obj options Object of options to pass to the constructor
* @return obj
* @since 3.17.0
* @version 3.17.0
*/
this.get_model = function( name, data, options ) {
return get( Models, name, data, options );
};
/**
* Let 3rd parties extend a view using any of the mixin (_) views
*
* @param {obj} view base object used for the view
* @param... {string} extends any number of strings that should be mixed into the view
* @return obj
* @since 3.17.1
* @version 3.17.1
*/
this.extend_view = function() {
var view = arguments[0],
i = 1;
while ( arguments[ i ] ) {
var classname = arguments[ i ];
if ( Views[ classname ] ) {
if ( view.events && Views[ classname ].events ) {
view.events = _.defaults( view.events, Views[ classname ].events );
}
view = _.defaults( view, Views[ classname ] );
}
i++;
}
return Backbone.View.extend( view );
};
/**
* Allows custom collection registration by extending the default BackBone collection
*
* @param string name model name
* @param obj props properties to extend the collection with
* @return void
* @since 3.17.1
* @version 3.17.1
*/
this.register_collection = function( name, props ) {
Collections[ name ] = Backbone.Collection.extend( props );
};
/**
* Allows custom model registration by extending the default abstract model
*
* @param string name model name
* @param obj props properties to extend the abstract model with
* @return void
* @since 3.17.0
* @version 3.17.0
*/
this.register_model = function( name, props ) {
Models[ name ] = Models['Abstract'].extend( props );
};
return this;
};
} );
================================================
FILE: assets/js/builder/Controllers/Debug.js
================================================
/**
* LifterLMS Builder Debugging suite
*
* @since 3.16.0
* @version 3.16.0
*/
define( [], function() {
return function( settings ) {
var self = this,
enabled = settings.enabled || false;
/**
* Disable debugging
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
this.disable = function() {
self.log( 'LifterLMS Builder debugging disabled' );
enabled = false;
};
/**
* Enable debugging
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
this.enable = function() {
enabled = true;
self.log( 'LifterLMS Builder debugging enabled' );
};
/**
* General logging function
* Logs to the js console only if logging is enabled
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
this.log = function() {
if ( ! enabled ) {
return;
}
_.each( arguments, function( data ) {
console.log( data );
} );
};
/**
* Toggles current state of the logger on or off
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
this.toggle = function() {
if ( enabled ) {
self.disable();
} else {
self.enable();
}
};
// on startup, log a message if logging is enabled
if ( enabled ) {
self.enable();
}
}
} );
================================================
FILE: assets/js/builder/Controllers/Schemas.js
================================================
/**
* Model schema functions
*
* @since 3.17.0
* @version 3.17.0
*/
define( [], function() {
/**
* Main Schemas class
*
* @param obj schemas schemas definitions initialized via PHP filters
* @return obj
* @since 3.17.0
* @version 3.17.0
*/
return function( schemas ) {
// initialize any custom schemas defined via PHP
var custom_schemas = schemas;
_.each( custom_schemas, function( type ) {
_.each( type, function( schema ) {
schema.custom = true;
} );
} );
/**
* Retrieve a schema for a given model by type
* Extends default schemas definitions with custom 3rd party definitions
*
* @param obj schema default schema definition from the model (or empty object if none defined)
* @param string model_type the model type ('lesson', 'quiz', etc)
* @param obj model Instance of the Backbone.Model for the given model
* @return obj
* @since 3.17.0
* @version 3.17.0
*/
this.get = function( schema, model_type, model ) {
// extend the default schema with custom php schemas for the type if they exist
if ( custom_schemas[ model_type ] ) {
schema = _.extend( schema, custom_schemas[ model_type ] );
}
return schema;
};
return this;
};
} );
================================================
FILE: assets/js/builder/Controllers/Sync.js
================================================
/**
* Sync builder data to the server
*
* @since 3.16.0
* @version 4.17.0
*/
define( [], function() {
return function( Course, settings ) {
this.saving = false;
var self = this,
autosave = ( 'yes' === window.llms_builder.autosave ),
check_interval = null,
check_interval_ms = settings.check_interval_ms || ( ( 'yes' === window.llms_builder.autosave ) ? 10000 : 1000 ),
detached = new Backbone.Collection(),
trashed = new Backbone.Collection();
/**
* init
*
* @since 3.16.7
*
* @return {Void}
*/
function init() {
// determine if autosaving is possible
if ( 'undefined' === typeof wp.heartbeat ) {
window.llms_builder.debug.log( 'WordPress Heartbeat disabled. Autosaving is disabled!' );
autosave = false;
}
// setup the check interval
if ( check_interval_ms ) {
self.set_check_interval( check_interval_ms );
}
// warn when users attempt to leave the page
$( window ).on( 'beforeunload', function() {
if ( self.has_unsaved_changes() ) {
check_for_changes();
return 'Are you sure you want to abandon your changes?';
}
} );
};
/*
/$$ /$$ /$$ /$$
|__/ | $$ | $$ |__/
/$$ /$$$$$$$ /$$$$$$ /$$$$$$ /$$$$$$ /$$$$$$$ /$$$$$$ | $$ /$$$$$$ /$$$$$$ /$$
| $$| $$__ $$|_ $$_/ /$$__ $$ /$$__ $$| $$__ $$ |____ $$| $$ |____ $$ /$$__ $$| $$
| $$| $$ \ $$ | $$ | $$$$$$$$| $$ \__/| $$ \ $$ /$$$$$$$| $$ /$$$$$$$| $$ \ $$| $$
| $$| $$ | $$ | $$ /$$| $$_____/| $$ | $$ | $$ /$$__ $$| $$ /$$__ $$| $$ | $$| $$
| $$| $$ | $$ | $$$$/| $$$$$$$| $$ | $$ | $$| $$$$$$$| $$ | $$$$$$$| $$$$$$$/| $$
|__/|__/ |__/ \___/ \_______/|__/ |__/ |__/ \_______/|__/ \_______/| $$____/ |__/
| $$
| $$
|__/
*/
/**
* Adds error message(s) to the data object returned by heartbeat-tick
*
* @param obj data llms_builder data object from heartbeat-tick
* @param string|array err error messages array or string
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
function add_error_msg( data, err ) {
if ( 'success' === data.status ) {
data.message = [];
}
data.status = 'error';
if ( 'string' === typeof err ) {
err = [ err ];
}
data.message = data.message.concat( err );
return data;
};
/**
* Publish sync status so other areas of the application can see what's happening here
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
function check_for_changes() {
var data = {};
data.changes = self.get_unsaved_changes();
data.has_unsaved_changes = self.has_unsaved_changes( data.changes );
data.saving = self.saving;
window.llms_builder.debug.log( '==== start changes check ====', data, '==== finish changes check ====' );
Backbone.pubSub.trigger( 'current-save-status', data );
};
/**
* Manually Save data via Admin AJAX when the heartbeat API has been disabled
*
* @since 3.16.7
* @since 4.17.0 Fixed undefined variable error when logging an error response.
*
* @return void
*/
function do_ajax_save() {
// prevent simultaneous saves
if ( self.saving ) {
return;
}
var changes = self.get_unsaved_changes();
// only send data if we have data to send
if ( self.has_unsaved_changes( changes ) ) {
changes.id = Course.get( 'id' );
LLMS.Ajax.call( {
data: {
action: 'llms_builder',
action_type: 'ajax_save',
course_id: changes.id,
llms_builder: JSON.stringify( changes ),
},
beforeSend: function() {
window.llms_builder.debug.log( '==== start do_ajax_save before ====', changes, '==== finish do_ajax_save before ====' );
self.saving = true;
Backbone.pubSub.trigger( 'heartbeat-send', self );
},
error: function( xhr, status, error ) {
window.llms_builder.debug.log( '==== start do_ajax_save error ====', xhr, '==== finish do_ajax_save error ====' );
self.saving = false;
Backbone.pubSub.trigger( 'heartbeat-tick', self, {
status: 'error',
message: xhr.responseText + ' (' + error + ' ' + status + ')',
} );
},
success: function( res ) {
if ( ! res.llms_builder ) {
return;
}
window.llms_builder.debug.log( '==== start do_ajax_save success ====', res, '==== finish do_ajax_save success ====' );
res.llms_builder = process_removals( res.llms_builder );
res.llms_builder = process_updates( res.llms_builder );
self.saving = false;
Backbone.pubSub.trigger( 'heartbeat-tick', self, res.llms_builder );
}
} );
}
};
/**
* Retrieve all the attributes changed on a model since the last sync
*
* For a new model (a model with a temp ID) or a model where _forceSync has been defined ALL atts will be returned
* For an existing model (without a temp ID) only retrieves changed attributes as tracked by Backbone.TrackIt
*
* This function excludes any attributes defined as child attributes via the models relationship settings
*
* @param obj model instance of a Backbone.Model
* @return obj
* @since 3.16.0
* @version 3.16.6
*/
function get_changed_attributes( model ) {
var atts = {},
sync_type;
// don't save mid editing
if ( model.get( '_has_focus' ) ) {
return atts;
}
// model hasn't been persisted to the database to get a real ID yet
// send *all* of it's atts
if ( has_temp_id( model ) || true === model.get( '_forceSync' ) ) {
atts = _.clone( model.attributes );
sync_type = 'full';
// only send the changed atts
} else {
atts = model.unsavedAttributes();
sync_type = 'partial';
}
var exclude = ( model.get_relationships ) ? model.get_child_props() : [];
atts = _.omit( atts, function( val, key ) {
// exclude keys that start with an underscore which are used by the
// application but don't need to be stored in the database
if ( 0 === key.indexOf( '_' ) ) {
return true;
} else if ( -1 !== exclude.indexOf( key ) ) {
return true;
}
return false;
} );
if ( model.before_save ) {
atts = model.before_save( atts, sync_type );
}
return atts;
};
/**
* Get all the changes to an object (either a Model or a Collection of models)
* Returns only changes to models and the IDs of that model (should changes exist)
* Uses get_changed_attributes() to determine if all atts or only changed atts are needed
* Processes children intelligently to only return changed children rather than the entire collection of children
*
* @param obj object instance of a Backbone.Model or Backbone.Collection
* @return obj|array if object is a model, returns an object
* if object is a collection, returns an array of objects
* @since 3.16.0
* @version 3.16.11
*/
function get_changes_to_object( object ) {
var changed_atts;
if ( object instanceof Backbone.Model ) {
changed_atts = get_changed_attributes( object );
if ( object.get_relationships ) {
_.each( object.get_child_props(), function( prop ) {
var children = get_changes_to_object( object.get( prop ) );
if ( ! _.isEmpty( children ) ) {
changed_atts[ prop ] = children;
}
} );
}
// if we have any data, add the id to the model
if ( ! _.isEmpty( changed_atts ) ) {
changed_atts.id = object.get( 'id' );
}
} else if ( object instanceof Backbone.Collection ) {
changed_atts = [];
object.each( function( model ) {
var model_changes = get_changes_to_object( model );
if ( ! _.isEmpty( model_changes ) ) {
changed_atts.push( model_changes );
}
} );
}
return changed_atts;
};
/**
* Determines if a model has a temporary ID or a real persisted ID
*
* @param obj model instance of a model
* @return boolean
* @since 3.16.0
* @version 3.16.0
*/
function has_temp_id( model ) {
return ( ! _.isNumber( model.id ) && 0 === model.id.indexOf( 'temp_' ) );
};
/**
* Compares changes synced to the server against current model and restarts
* tracking on elements that haven't changed since the last sync
*
* @param obj model instance of a Backbone.Model
* @param obj data data set that was processed by the server
* @return void
* @since 3.16.11
* @version 3.19.4
*/
function maybe_restart_tracking( model, data ) {
Backbone.pubSub.trigger( model.get( 'type' ) + '-maybe-restart-tracking', model, data );
var omit = [ 'id', 'orig_id' ];
if ( model.get_relationships ) {
omit.concat( model.get_child_props() );
}
_.each( _.omit( data, omit ), function( val, prop ) {
if ( _.isEqual( model.get( prop ), val ) ) {
delete model._unsavedChanges[ prop ];
model._originalAttrs[ prop ] = val;
}
} );
// if syncing was forced, allow tracking to move forward as normal moving forward
model.unset( '_forceSync' );
};
/**
* Processes response data from heartbeat-tick related to trashing & detaching models
* On success, removes from local removal collection
* On error, appends error messages to the data object returned to UI for on-screen feedback
*
* @param obj data data.llms_builder object from heartbeat-tick response
* @return obj
* @since 3.16.0
* @version 3.17.1
*/
function process_removals( data ) {
// check removals for errors
var removals = {
detach: detached,
trash: trashed,
};
_.each( removals, function( coll, key ) {
if ( data[ key ] ) {
var errors = [];
_.each( data[ key ] , function( info ) {
// successfully detached, remove it from the detached collection
if ( ! info.error ) {
coll.remove( info.id );
} else {
errors.push( info.error );
}
} );
if ( errors.length ) {
_.extend( data, add_error_msg( data, errors ) );
}
}
} );
return data;
}
/**
* Processes response data from heartbeat-tick related to creating / updating a single object
* Handles both collections and models as a recursive function
*
* @param {[type]} data [description]
* @param {[type]} type [description]
* @param {[type]} parent [description]
* @param {[type]} main_data [description]
* @return {[type]}
* @since 3.16.0
* @version 3.16.11
*/
function process_object_updates( data, type, parent, main_data ) {
if ( ! data[ type ] ) {
return data;
}
if ( parent.get( type ) instanceof Backbone.Model ) {
var info = data[ type ];
if ( info.error ) {
_.extend( main_data, add_error_msg( main_data, info.error ) );
} else {
var model = parent.get( type );
// update temp ids with the real id
if ( info.id != info.orig_id ) {
model.set( 'id', info.id );
delete model._unsavedChanges.id;
}
if ( info.permalink ) {
model.set( 'permalink', info.permalink );
}
if ( info.name ) {
model.set( 'name', info.name );
}
if ( info.content_added_in_builder ) {
model.set( 'content_added_in_builder', info.content_added_in_builder );
}
maybe_restart_tracking( model, info );
// check children
if ( model.get_relationships ) {
_.each( model.get_child_props(), function( child_key ) {
_.extend( data[ type ], process_object_updates( data[ type ], child_key, model, main_data ) );
} );
}
}
} else if ( parent.get( type ) instanceof Backbone.Collection ) {
_.each( data[ type ], function( info, index ) {
if ( info.error ) {
_.extend( main_data, add_error_msg( main_data, info.error ) );
} else {
var model = parent.get( type ).get( info.orig_id );
// update temp ids with the real id
if ( info.id != info.orig_id ) {
model.set( 'id', info.id );
delete model._unsavedChanges.id;
}
// Update permalink and name if provided by the server.
if ( info.permalink ) {
model.set( 'permalink', info.permalink );
}
if ( info.name ) {
model.set( 'name', info.name );
}
if ( info.content_added_in_builder ) {
model.set( 'content_added_in_builder', info.content_added_in_builder );
}
maybe_restart_tracking( model, info );
// check children
if ( model.get_relationships ) {
_.each( model.get_child_props(), function( child_key ) {
_.extend( data[ type ], process_object_updates( data[ type ][ index ], child_key, model, main_data ) );
} );
}
}
} );
}
return main_data;
};
/**
* Processes response data from heartbeat-tick related to updating & creating new models
* On success, removes from local removal collection
* On error, appends error messages to the data object returned to UI for on-screen feedback
*
* @param obj data data.llms_builder object from heartbeat-tick response
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
function process_updates( data ) {
// only mess with updates data
if ( ! data.updates ) {
return data;
}
if ( data.updates ) {
data = process_object_updates( data.updates, 'sections', Course, data );
}
return data;
};
/*
/$$ /$$ /$$ /$$
| $$ | $$|__/ |__/
/$$$$$$ /$$ /$$| $$$$$$$ | $$ /$$ /$$$$$$$ /$$$$$$ /$$$$$$ /$$
/$$__ $$| $$ | $$| $$__ $$| $$| $$ /$$_____/ |____ $$ /$$__ $$| $$
| $$ \ $$| $$ | $$| $$ \ $$| $$| $$| $$ /$$$$$$$| $$ \ $$| $$
| $$ | $$| $$ | $$| $$ | $$| $$| $$| $$ /$$__ $$| $$ | $$| $$
| $$$$$$$/| $$$$$$/| $$$$$$$/| $$| $$| $$$$$$$ | $$$$$$$| $$$$$$$/| $$
| $$____/ \______/ |_______/ |__/|__/ \_______/ \_______/| $$____/ |__/
| $$ | $$
| $$ | $$
|__/ |__/
*/
/**
* Retrieve all unsaved changes for the builder instance
*
* @return obj
* @since 3.16.0
* @version 3.17.1
*/
this.get_unsaved_changes = function() {
return {
detach: detached.pluck( 'id' ),
trash: trashed.pluck( 'id' ),
updates: get_changes_to_object( Course ),
}
};
/**
* Check if the builder instance has unsaved changes
*
* @param obj changes optionally pass in an object from the return of this.get_unsaved_changes()
* save some resources by not running the check twice during heartbeats
* @return boolean
* @since 3.16.0
* @version 3.16.0
*/
this.has_unsaved_changes = function( changes ) {
if ( 'undefined' === typeof changes ) {
changes = self.get_unsaved_changes();
}
// check all possible keys, once we find one with content we have some changes to persist
var found = _.find( changes, function( data ) {
return ( false === _.isEmpty( data ) );
} );
return found ? true : false;
};
/**
* Save changes right now.
*
* @return void
* @since 3.16.0
* @version 3.16.7
*/
this.save_now = function() {
if ( autosave ) {
wp.heartbeat.connectNow();
} else {
do_ajax_save();
}
};
/**
* Update the interval that checks for changes to the builder instance
*
* @param int ms time (in milliseconds) to run the check on
* pass 0 to disable the check
* @return void
* @since 3.16.0
* @version 3.16.0
*/
this.set_check_interval = function( ms ) {
check_interval_ms = ms;
if ( check_interval ) {
clearInterval( check_interval );
}
if ( check_interval_ms ) {
check_interval = setInterval( check_for_changes, check_interval_ms );
}
};
/*
/$$ /$$ /$$
| $$|__/ | $$
| $$ /$$ /$$$$$$$ /$$$$$$ /$$$$$$ /$$$$$$$ /$$$$$$ /$$$$$$ /$$$$$$$
| $$| $$ /$$_____/|_ $$_/ /$$__ $$| $$__ $$ /$$__ $$ /$$__ $$ /$$_____/
| $$| $$| $$$$$$ | $$ | $$$$$$$$| $$ \ $$| $$$$$$$$| $$ \__/| $$$$$$
| $$| $$ \____ $$ | $$ /$$| $$_____/| $$ | $$| $$_____/| $$ \____ $$
| $$| $$ /$$$$$$$/ | $$$$/| $$$$$$$| $$ | $$| $$$$$$$| $$ /$$$$$$$/
|__/|__/|_______/ \___/ \_______/|__/ |__/ \_______/|__/ |_______/
*/
/**
* Listen for detached models and send them to the server for persistence
*
* @since 3.16.0
* @version 3.16.0
*/
Backbone.pubSub.on( 'model-detached', function( model ) {
// detached models with temp ids haven't been persisted so we don't care
if ( has_temp_id( model ) ) {
return;
}
detached.add( _.clone( model.attributes ) );
} );
/**
* Listen for trashed models and send them to the server for deletion
*
* @since 3.16.0
* @version 3.17.1
*/
Backbone.pubSub.on( 'model-trashed', function( model ) {
// if the model has a temp ID we don't have to persist the deletion
if ( has_temp_id( model ) ) {
return;
}
var data = _.clone( model.attributes );
if ( model.get_trash_id ) {
data.id = model.get_trash_id();
}
trashed.add( data );
} );
/*
/$$ /$$ /$$ /$$
| $$ | $$ | $$ | $$
| $$$$$$$ /$$$$$$ /$$$$$$ /$$$$$$ /$$$$$$ | $$$$$$$ /$$$$$$ /$$$$$$ /$$$$$$
| $$__ $$ /$$__ $$ |____ $$ /$$__ $$|_ $$_/ | $$__ $$ /$$__ $$ |____ $$|_ $$_/
| $$ \ $$| $$$$$$$$ /$$$$$$$| $$ \__/ | $$ | $$ \ $$| $$$$$$$$ /$$$$$$$ | $$
| $$ | $$| $$_____/ /$$__ $$| $$ | $$ /$$| $$ | $$| $$_____/ /$$__ $$ | $$ /$$
| $$ | $$| $$$$$$$| $$$$$$$| $$ | $$$$/| $$$$$$$/| $$$$$$$| $$$$$$$ | $$$$/
|__/ |__/ \_______/ \_______/|__/ \___/ |_______/ \_______/ \_______/ \___/
*/
/**
* Add data to the WP heartbeat to persist new models, changes, and deletions to the DB
*
* @since 3.16.0
* @since 3.16.7 Unknown
* @since 4.14.0 Return early when autosaving is disabled.
*/
$( document ).on( 'heartbeat-send', function( event, data ) {
// Autosaving is disabled.
if ( ! autosave ) {
return;
}
// prevent simultaneous saves
if ( self.saving ) {
return;
}
var changes = self.get_unsaved_changes();
// only send data if we have data to send
if ( self.has_unsaved_changes( changes ) ) {
changes.id = Course.get( 'id' );
self.saving = true;
data.llms_builder = JSON.stringify( changes );
}
window.llms_builder.debug.log( '==== start heartbeat-send ====', data, '==== finish heartbeat-send ====' );
Backbone.pubSub.trigger( 'heartbeat-send', self );
} );
/**
* Confirm detachments & deletions and replace temp IDs with new persisted IDs
*
* @since 3.16.0
* @since 4.14.0 Return early when autosaving is disabled.
*/
$( document ).on( 'heartbeat-tick', function( event, data ) {
// Autosaving is disabled.
if ( ! autosave ) {
return;
}
if ( ! data.llms_builder ) {
return;
}
window.llms_builder.debug.log( '==== start heartbeat-tick ====', data, '==== finish heartbeat-tick ====' );
data.llms_builder = process_removals( data.llms_builder );
data.llms_builder = process_updates( data.llms_builder );
self.saving = false;
Backbone.pubSub.trigger( 'heartbeat-tick', self, data.llms_builder );
} );
/**
* On heartbeat errors publish an error to the main builder application
*
* @since 3.16.0
* @since 4.14.0 Return early when autosaving is disabled.
*/
$( document ).on( 'heartbeat-error', function( event, data ) {
// Autosaving is disabled.
if ( ! autosave ) {
return;
}
window.llms_builder.debug.log( '==== start heartbeat-error ====', data, '==== finish heartbeat-error ====' );
self.saving = false;
Backbone.pubSub.trigger( 'heartbeat-tick', self, {
status: 'error',
message: data.responseText + ' (' + data.status + ' ' + data.statusText + ')',
} );
} );
/*
/$$ /$$ /$$
|__/ |__/ | $$
/$$ /$$$$$$$ /$$ /$$$$$$
| $$| $$__ $$| $$|_ $$_/
| $$| $$ \ $$| $$ | $$
| $$| $$ | $$| $$ | $$ /$$
| $$| $$ | $$| $$ | $$$$/
|__/|__/ |__/|__/ \___/
*/
init();
return this;
};
} );
================================================
FILE: assets/js/builder/Models/Abstract.js
================================================
/**
* Abstract LifterLMS Model
*
* @since 3.17.0
* @version 3.17.0
*/
define( [ 'Models/_Relationships', 'Models/_Utilities' ], function( Relationships, Utilities ) {
return Backbone.Model.extend( _.defaults( {}, Relationships, Utilities ) );
} );
================================================
FILE: assets/js/builder/Models/Course.js
================================================
/**
* Course Model.
*
* @since 3.16.0
* @since 3.24.0 Added `get_total_points()` method.
* @since 3.37.11 Use lesson author ID instead of author object when adding existing lessons to a course.
* @version 5.4.0
*/
define( [ 'Collections/Sections', 'Models/_Relationships', 'Models/_Utilities' ], function( Sections, Relationships, Utilities ) {
return Backbone.Model.extend( _.defaults( {
relationships: {
children: {
sections: {
class: 'Sections',
model: 'section',
type: 'collection',
},
}
},
/**
* New Course Defaults.
*
* @since 3.16.0
*
* @return {Object}
*/
defaults: function() {
return {
edit_url: '',
sections: [],
title: 'New Course',
type: 'course',
view_url: '',
}
},
/**
* Init.
*
* @since 3.16.0
*
* @return {Void}
*/
initialize: function() {
this.startTracking();
this.init_relationships();
// Sidebar "New Section" button broadcast.
Backbone.pubSub.on( 'add-new-section', this.add_section, this );
// Sidebar "New Lesson" button broadcast.
Backbone.pubSub.on( 'add-new-lesson', this.add_lesson, this );
Backbone.pubSub.on( 'lesson-search-select', this.add_existing_lesson, this );
},
/**
* Add an existing lesson to the course.
*
* Duplicate a lesson from this or another course or attach an orphaned lesson.
*
* @since 3.16.0
* @since 3.24.0 Unknown.
* @since 3.37.11 Use the author id instead of the author object.
* @since 5.4.0 Added filter hook 'llms_adding_existing_lesson_data'.
* On cloning, duplicate assignments too, if assignment add-on active and assignment attached.
*
* @param {Object} lesson Lesson data obj.
* @return {Void}
*/
add_existing_lesson: function( lesson ) {
var data = lesson.data;
if ( 'clone' === lesson.action ) {
delete data.id;
// If a quiz is attached, duplicate the quiz also.
if ( data.quiz ) {
data.quiz = _.prepareQuizObjectForCloning( data.quiz );
data.quiz._questions_loaded = true;
}
// If assignment add-on active and assignment attached, duplicate the assignment too.
if ( window.llms_builder.assignments && data.assignment ) {
data.assignment = _.prepareAssignmentObjectForCloning( data.assignment );
}
} else {
data._forceSync = true;
}
delete data.order;
delete data.parent_course;
delete data.parent_section;
// Use author id instead of the lesson author object.
data = _.prepareExistingPostObjectDataForAddingOrCloning( data );
/**
* Filters the data of the existing lesson being added.
*
* @since 5.4.0
*
* @param {Object} data Lesson data.
* @param {String} action Action being performed. [clone|attach].
* @param {Object} course The lesson's course parent model.
*/
data = window.llms.hooks.applyFilters( 'llms_adding_existing_lesson_data', data, lesson.action, this );
this.add_lesson( data );
},
/**
* Add a new lesson to the course.
*
* @since 3.16.0
*
* @param {Object} data Lesson data.
* @return {Object} Backbone.Model of the lesson.
*/
add_lesson: function( data ) {
data = data || {};
var options = {},
section;
if ( ! data.parent_section ) {
section = this.get_selected_section();
if ( ! section ) {
section = this.get( 'sections' ).last();
}
} else {
section = this.get( 'sections' ).get( data.parent_section );
}
data._selected = true;
data.parent_course = this.get( 'id' );
var lesson = section.add_lesson( data, options );
Backbone.pubSub.trigger( 'new-lesson-added', lesson );
// Expand the section.
section.set( '_expanded', true );
return lesson;
},
/**
* Add a new section to the course.
*
* @since 3.16.0
*
* @param {Object} data Section data.
* @return {Void}
*/
add_section: function( data ) {
data = data || {};
var sections = this.get( 'sections' ),
options = {},
selected = this.get_selected_section();
// If a section is selected, add the new section after the currently selected one.
if ( selected ) {
options.at = sections.indexOf( selected ) + 1;
}
sections.add( data, options );
},
/**
* Retrieve the currently selected section in the course.
*
* @since 3.16.0
*
* @return {Object|undefined}
*/
get_selected_section: function() {
return this.get( 'sections' ).find( function( model ) {
return model.get( '_selected' );
} );
},
/**
* Retrieve the total number of points in the course.
*
* @since 3.24.0
*
* @return {Integer}
*/
get_total_points: function() {
var points = 0;
this.get( 'sections' ).each( function( section ) {
section.get( 'lessons' ).each( function( lesson ) {
var lesson_points = lesson.get( 'points' );
if ( ! _.isNumber( lesson_points ) ) {
lesson_points = 0;
}
points += lesson_points * 1;
} );
} );
return points;
},
}, Relationships, Utilities ) );
} );
================================================
FILE: assets/js/builder/Models/Image.js
================================================
/**
* Image object model for use in various models for the 'image' attribute
*
* @since 3.16.0
* @version 3.16.0
*/
define( [], function() {
return Backbone.Model.extend( {
defaults: {
enabled: 'no',
id: '',
size: 'full',
src: '',
},
initialize: function() {
this.startTracking();
},
} );
} );
================================================
FILE: assets/js/builder/Models/Lesson.js
================================================
/**
* Lesson Model
*
* @since 3.13.0
* @version 4.20.0
*/
define( [ 'Models/Quiz', 'Models/_Relationships', 'Models/_Utilities', 'Schemas/Lesson' ], function( Quiz, Relationships, Utilities, LessonSchema ) {
return Backbone.Model.extend( _.defaults( {
/**
* Model relationships
*
* @type {Object}
*/
relationships: {
parents: {
model: 'section',
type: 'model',
},
children: {
quiz: {
class: 'Quiz',
conditional: function( model ) {
// if quiz is enabled OR not enabled but we have some quiz data as an obj
return ( 'yes' === model.get( 'quiz_enabled' ) || ! _.isEmpty( model.get( 'quiz' ) ) );
},
model: 'llms_quiz',
type: 'model',
},
},
},
/**
* Lesson Settings Schema
*
* @type {Object}
*/
schema: LessonSchema,
/**
* New lesson defaults
*
* @since 3.13.0
* @since 3.24.0 Unknown.
*
* @return {Object} Default options associative array (js object).
*/
defaults: function() {
return {
id: _.uniqueId( 'temp_' ),
title: LLMS.l10n.translate( 'New Lesson' ),
type: 'lesson',
order: this.collection ? this.collection.length + 1 : 1,
parent_course: window.llms_builder.course.id,
parent_section: '',
// Urls.
edit_url: '',
view_url: '',
// Editable fields.
content: '',
audio_embed: '',
has_prerequisite: 'no',
require_passing_grade: 'yes',
require_assignment_passing_grade: 'yes',
video_embed: '',
free_lesson: '',
points: 1,
// Other fields.
assignment: {}, // Assignment model/data.
assignment_enabled: 'no',
quiz: {}, // Quiz model/data.
quiz_enabled: 'no',
content_added_in_builder: '',
_forceSync: false,
};
},
/**
* Initializer
*
* @since 3.16.0
* @since 3.17.0 Unknown
*
* @return {void}
*/
initialize: function() {
this.init_custom_schema();
this.startTracking();
this.maybe_init_assignments();
this.init_relationships();
// If the lesson ID isn't set on a quiz, set it.
var quiz = this.get( 'quiz' );
if ( ! _.isEmpty( quiz ) && ! quiz.get( 'lesson_id' ) ) {
quiz.set( 'lesson_id', this.get( 'id' ) );
}
window.llms.hooks.doAction( 'llms_lesson_model_init', this );
},
/**
* Retrieve a reference to the parent course of the lesson
*
* @since 3.16.0
* @since 4.14.0 Use Section.get_course() in favor of Section.get_parent().
*
* @return {Object} The parent course model of the lesson.
*/
get_course: function() {
return this.get_parent().get_course();
},
/**
* Retrieve the translated post type name for the model's type
*
* @since 3.16.12
*
* @param bool plural If true, returns the plural, otherwise returns singular.
* @return string The translated post type name.
*/
get_l10n_type: function( plural ) {
if ( plural ) {
return LLMS.l10n.translate( 'lessons' );
}
return LLMS.l10n.translate( 'lesson' );
},
/**
* Override default get_parent to grab from collection if models parent isn't set
*
* @since 3.17.0
*
* @return {Object}|false The parent model or false if not available.
*/
get_parent: function() {
var rels = this.get_relationships();
if ( rels.parent && rels.parent.reference ) {
return rels.parent.reference;
} else if ( this.collection && this.collection.parent ) {
return this.collection.parent;
}
return false;
},
/**
* Retrieve the questions percentage value within the quiz
*
* @since 3.24.0
*
* @return {String} Questions percentage value within the quiz.
*/
get_points_percentage: function() {
var total = this.get_course().get_total_points(),
points = this.get( 'points' ) * 1;
if ( ! _.isNumber( points ) ) {
points = 0;
}
if ( 0 === total ) {
return '0%';
}
return ( ( points / total ) * 100 ).toFixed( 2 ) + '%';
},
/**
* Retrieve an array of prerequisite options available for the current lesson
*
* @since 3.17.0
*
* @return {Object} Prerequisite options.
*/
get_available_prereq_options: function() {
var parent_section_index = this.get_parent().collection.indexOf( this.get_parent() ),
lesson_index_in_section = this.collection.indexOf( this ),
options = [];
this.get_course().get( 'sections' ).each( function( section, curr_sec_index ) {
if ( curr_sec_index <= parent_section_index ) {
var group = {
// Translators: %1$d = section order number, %2$s = section title.
label: LLMS.l10n.replace( 'Section %1$d: %2$s', {
'%1$d': section.get( 'order' ),
'%2$s': section.get( 'title' )
} ),
options: [],
};
section.get( 'lessons' ).each( function( lesson, curr_les_index ) {
if ( curr_sec_index !== parent_section_index || curr_les_index < lesson_index_in_section ) {
// Translators: %1$d = lesson order number, %2$s = lesson title.
group.options.push( {
key: lesson.get( 'id' ),
val: LLMS.l10n.replace( 'Lesson %1$d: %2$s', {
'%1$d': lesson.get( 'order' ),
'%2$s': lesson.get( 'title' )
} ),
} );
}
}, this );
options.push( group );
}
}, this );
return options;
},
/**
* Add a new quiz to the lesson
*
* @since 3.16.0
* @since 3.27.0 Unknown.
*
* @param {Object} data Object of quiz data used to construct a new quiz model.
* @return {Object} Model for the created quiz.
*/
add_quiz: function( data ) {
data = data || {};
data.lesson_id = this.id;
data._questions_loaded = true;
if ( ! data.title ) {
data.title = LLMS.l10n.replace( '%1$s Quiz', {
'%1$s': this.get( 'title' ),
} );
}
this.set( 'quiz', data );
this.init_relationships();
var quiz = this.get( 'quiz' );
this.set( 'quiz_enabled', 'yes' );
window.llms.hooks.doAction( 'llms_lesson_add_quiz', quiz, this );
return quiz;
},
/**
* Determine if this is the first lesson
*
* @since 3.17.0
* @since 4.20.0 Use is_first_in_section() new method.
*
* @return {Boolean} Whether this is the first lesson of its course.
*/
is_first_in_course: function() {
// If it's not the first item in the section it cant be the first lesson.
if ( ! this.is_first_in_section() ) {
return false;
}
// If it's not the first section it cant' be first lesson.
var section = this.get_parent();
if ( section.collection.indexOf( section ) ) {
return false;
}
// It's first lesson in first section.
return true;
},
/**
* Determine if this is the last lesson of the course
*
* @since 4.20.0
*
* @return {Boolean} Whether this is the last lesson of its course.
*/
is_last_in_course: function() {
// If it's not last item in the section it cant be the last lesson.
if ( ! this.is_last_in_section() ) {
return false;
}
// If it's not the last section it cant' be last lesson.
var section = this.get_parent();
if ( section.collection.indexOf( section ) < ( section.collection.size() - 1 ) ) {
return false;
}
// It's last lesson in last section.
return true;
},
/**
* Determine if this is the first lesson within its section
*
* @since 4.20.0
*
* @return {Boolean} Whether this is the first lesson of its section.
*/
is_first_in_section: function() {
return 0 === this.collection.indexOf( this );
},
/**
* Determine if this is the last lesson within its section
*
* @since 4.20.0
*
* @return {Boolean} Whether this is the last lesson of its section.
*/
is_last_in_section: function() {
return this.collection.indexOf( this ) === ( this.collection.size() - 1 );
},
/**
* Get prev lesson in a course
*
* @since 4.20.0
*
* @param {String} status Prev lesson post status. If not specified any status will be taken into account.
* @return {Object}|false Previous lesson model or `false` if no previous lesson could be found.
*/
get_prev: function( status ) {
return this.get_sibling( 'prev', status );
},
/**
* Get next lesson in a course
*
* @since 4.20.0
*
* @param {String} status Next lesson post status. If not specified any status will be taken into account.
* @return {Object}|false Next lesson model or `false` if no next lesson could be found.
*/
get_next: function( status ) {
return this.get_sibling( 'next', status );
},
/**
* Get a sibling lesson
*
* @param {String} direction Siblings direction [next|prev]. If not specified will fall back on 'prev'.
* @param {String} status Sibling lesson post status. If not specified any status will be taken into account.
* @return {Object}|false Sibling lesson model, in the specified direction, or `false` if no sibling lesson could be found.
*/
get_sibling: function( direction, status ) {
direction = 'next' === direction ? direction : 'prev';
// Functions and vars to use when direction is 'prev' (default).
var is_course_limit_reached_f = 'is_first_in_course',
is_section_limit_reached_f = 'is_first_in_section',
sibling_index_increment = -1,
get_sibling_lesson_in_sibling_section_f = 'last';
if ( 'next' === direction ) {
is_course_limit_reached_f = 'is_last_in_course';
is_section_limit_reached_f = 'is_last_in_section';
sibling_index_increment = 1,
get_sibling_lesson_in_sibling_section_f = 'first';
}
if ( this[ is_course_limit_reached_f ]() ) {
return false;
}
var sibling_index = this.collection.indexOf( this ) + sibling_index_increment,
sibling_lesson = this.collection.at( sibling_index );
if ( this[ 'next' === direction ? 'is_last_in_section' : 'is_first_in_section' ]() ) {
var cur_section = this.get_parent(),
sibling_section = cur_section[ 'get_' + direction ]( false );
// Skip sibling empty sections.
while ( sibling_section && ! sibling_section.get( 'lessons' ).size() ) {
sibling_section = sibling_section[ 'get_' + direction ]( false );
}
// Couldn't find any suitable lesson.
if ( ! sibling_section || ! sibling_section.get( 'lessons' ).size() ) {
return false;
}
sibling_lesson = sibling_section.get( 'lessons' )[ get_sibling_lesson_in_sibling_section_f ]();
}
// If we need a specific lesson status.
if ( status && status !== sibling_lesson.get( 'status' ) ) {
return sibling_lesson.get_sibling( direction, status );
}
return sibling_lesson;
},
/**
* Initialize lesson assignments *if* the assignments addon is available and enabled
*
* @since 3.17.0
*
* @return {Void}
*/
maybe_init_assignments: function() {
if ( ! window.llms_builder.assignments ) {
return;
}
this.relationships.children.assignment = {
class: 'Assignment',
conditional: function( model ) {
// If assignment is enabled OR not enabled but we have some assignment data as an obj.
return ( 'yes' === model.get( 'assignment_enabled' ) || ! _.isEmpty( model.get( 'assignment' ) ) );
},
model: 'llms_assignment',
type: 'model',
};
},
}, Relationships, Utilities ) );
} );
================================================
FILE: assets/js/builder/Models/Question.js
================================================
/**
* Quiz Question
*
* @since 3.16.0
* @version 3.27.0
*/
define( [
'Models/Image',
'Collections/Questions',
'Collections/QuestionChoices',
'Models/QuestionType',
'Models/_Relationships',
'Models/_Utilities'
], function(
Image,
Questions,
QuestionChoices,
QuestionType,
Relationships,
Utilities
) {
return Backbone.Model.extend( _.defaults( {
/**
* Model relationships
*
* @type {Object}
*/
relationships: {
parent: {
model: 'llms_quiz',
type: 'model',
},
children: {
choices: {
class: 'QuestionChoices',
model: 'choice',
type: 'collection',
},
image: {
class: 'Image',
model: 'image',
type: 'model',
},
questions: {
class: 'Questions',
conditional: function( model ) {
var type = model.get( 'question_type' ),
type_id = _.isString( type ) ? type : type.get( 'id' );
return ( 'group' === type_id );
},
model: 'llms_question',
type: 'collection',
},
question_type: {
class: 'QuestionType',
lookup: function( val ) {
if ( _.isString( val ) ) {
return window.llms_builder.questions.get( val );
}
return val;
},
model: 'question_type',
type: 'model',
},
}
},
/**
* Model defaults
*
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
defaults: function() {
return {
id: _.uniqueId( 'temp_' ),
choices: [],
content: '',
description_enabled: 'no',
image: {},
multi_choices: 'no',
menu_order: 1,
points: 1,
question_type: 'generic',
questions: [], // for question groups
parent_id: '',
title: '',
type: 'llms_question',
video_enabled: 'no',
video_src: '',
_expanded: false,
}
},
/**
* Initializer
*
* @param obj data object of data for the model
* @param obj options additional options
* @return void
* @since 3.16.0
* @version 3.16.0
*/
initialize: function( data, options ) {
var self = this;
this.startTracking();
this.init_relationships( options );
if ( false !== this.get( 'question_type' ).choices ) {
this._ensure_min_choices();
// when a choice is removed, maybe add back some defaults so we always have the minimum
this.listenTo( this.get( 'choices' ), 'remove', function() {
// new items are added at index 0 when there's only 1 item in the collection, not sure why exactly...
setTimeout( function() {
self._ensure_min_choices();
}, 0 );
} );
}
// ensure question types that don't support points don't record default 1 point in database
if ( ! this.get( 'question_type' ).get( 'points' ) ) {
this.set( 'points', 0 );
}
_.delay( function( self ) {
self.on( 'change:points', self.get_parent().update_points, self.get_parent() );
}, 1, this );
},
/**
* Add a new question choice
*
* @param obj data object of choice data
* @param obj options additional options
* @since 3.16.0
* @version 3.16.0
*/
add_choice: function( data, options ) {
var max = this.get( 'question_type' ).get_max_choices();
if ( this.get( 'choices' ).size() >= max ) {
return;
}
data = data || {};
options = options || {};
data.choice_type = this.get( 'question_type' ).get_choice_type();
data.question_id = this.get( 'id' );
options.parent = this;
var choice = this.get( 'choices' ).add( data, options );
Backbone.pubSub.trigger( 'question-add-choice', choice, this );
},
/**
* Collapse question_type attribute during full syncs to save to database
* Not needed because question types cannot be adjusted after question creation
* Called from sync controller
*
* @param obj atts flat object of attributes to be saved to db
* @param string sync_type full or partial
* full indicates a force resync or that the model isn't persisted yet
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
before_save: function( atts, sync_type ) {
if ( 'full' === sync_type ) {
atts.question_type = this.get( 'question_type' ).get( 'id' );
}
return atts;
},
/**
* Retrieve the model's parent (if set)
*
* @return obj|false
* @since 3.16.0
* @version 3.16.0
*/
get_parent: function() {
var rels = this.get_relationships();
if ( rels.parent ) {
if ( this.collection && this.collection.parent ) {
return this.collection.parent;
} else if ( rels.parent.reference ) {
return rels.parent.reference;
}
}
return false;
},
/**
* Retrieve the translated post type name for the model's type
*
* @param bool plural if true, returns the plural, otherwise returns singular
* @return string
* @since 3.27.0
* @version 3.27.0
*/
get_l10n_type: function( plural ) {
if ( plural ) {
return LLMS.l10n.translate( 'questions' );
}
return LLMS.l10n.translate( 'question' );
},
/**
* Gets the index of the question within it's parent
* Question numbers skip content elements
* & content elements skip questions
*
* @return int
* @since 3.16.0
* @version 3.16.0
*/
get_type_index: function() {
// current models type, used to check the predicate in the filter function below
var curr_type = this.get( 'question_type' ).get( 'id' ),
questions;
questions = this.collection.filter( function( question ) {
var type = question.get( 'question_type' ).get( 'id' );
// if current model is not content, return all non-content questions
if ( curr_type !== 'content' ) {
return ( 'content' !== type );
}
// current model is content, return only content questions
return 'content' === type;
} );
return questions.indexOf( this );
},
/**
* Gets iterator for the given type
* Questions use numbers and content uses alphabet
*
* @return mixed
* @since 3.16.0
* @version 3.16.0
*/
get_type_iterator: function() {
var index = this.get_type_index();
if ( -1 === index ) {
return '';
}
if ( 'content' === this.get( 'question_type' ).get( 'id' ) ) {
var alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'.split( '' );
return alphabet[ index ];
}
return index + 1;
},
get_qid: function() {
var parent = this.get_parent_question(),
prefix = '';
if ( parent ) {
prefix = parent.get_qid() + '.';
}
// return short_id + this.get_type_iterator();
return prefix + this.get_type_iterator();
},
/**
* Retrieve the parent question (if the question is in a question group)
*
* @return obj|false
* @since 3.16.0
* @version 3.16.0
*/
get_parent_question: function() {
if ( this.is_in_group() ) {
return this.collection.parent;
}
return false;
},
/**
* Retrieve the parent quiz
*
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
get_parent_quiz: function() {
return this.get_parent();
},
/**
* Points getter
* ensures that 0 is always returned if the question type doesn't support points
*
* @return int
* @since 3.16.0
* @version 3.16.0
*/
get_points: function() {
if ( ! this.get( 'question_type' ).get( 'points' ) ) {
return 0;
}
return this.get( 'points' );
},
/**
* Retrieve the questions percentage value within the quiz
*
* @return string
* @since 3.16.0
* @version 3.16.0
*/
get_points_percentage: function() {
var total = this.get_parent().get( '_points' ),
points = this.get( 'points' );
if ( 0 === total ) {
return '0%';
}
return ( ( points / total ) * 100 ).toFixed( 2 ) + '%';
},
/**
* Determine if the question belongs to a question group
*
* @return {Boolean}
* @since 3.16.0
* @version 3.16.0
*/
is_in_group: function() {
return ( 'question' === this.collection.parent.get( 'type' ) );
},
_ensure_min_choices: function() {
var choices = this.get( 'choices' );
while ( choices.size() < this.get( 'question_type' ).get_min_choices() ) {
this.add_choice();
}
},
}, Relationships, Utilities ) );
} );
================================================
FILE: assets/js/builder/Models/QuestionChoice.js
================================================
/**
* Quiz Question Choice
*
* @since 3.16.0
* @version 3.16.0
*/
define( [ 'Models/Image', 'Models/_Relationships' ], function( Image, Relationships ) {
return Backbone.Model.extend( _.defaults( {
/**
* Model relationships
*
* @type {Object}
*/
relationships: {
parent: {
model: 'llms_question',
type: 'model',
},
children: {
choice: {
conditional: function( model ) {
return ( 'image' === model.get( 'choice_type' ) );
},
class: 'Image',
model: 'image',
type: 'model',
},
},
},
/**
* Model defaults
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
defaults: function() {
return {
id: _.uniqueId( 'temp_' ),
choice: '',
choice_type: 'text',
correct: false,
marker: 'A',
question_id: '',
type: 'choice',
}
},
/**
* Initializer
*
* @param obj data object of model attributes
* @param obj options additional options
* @return void
* @since 3.16.0
* @version 3.16.0
*/
initialize: function( data, options ) {
this.startTracking();
this.init_relationships( options );
},
/**
* Retrieve the choice's parent question
*
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
get_parent: function() {
return this.collection.parent;
},
/**
* Retrieve the ID used when trashing the model
*
* @return string
* @since 3.17.1
* @version 3.17.1
*/
get_trash_id: function() {
return this.get( 'question_id' ) + ':' + this.get( 'id' );
},
/**
* Determine if "selection" is enabled for the question type
* Choice type questions are selectable by reorder type questions are not but still use choices
*
* @return {Boolean}
* @since 3.16.0
* @version 3.16.0
*/
is_selectable: function() {
return this.get_parent().get( 'question_type' ).get_choice_selectable();
},
}, Relationships ) );
} );
================================================
FILE: assets/js/builder/Models/QuestionType.js
================================================
/**
* Quiz Question Type
*
* @since 3.16.0
* @version 3.16.0
*/
define( [], function() {
return Backbone.Model.extend( {
/**
* Get model default attributes
*
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
defaults: function() {
return {
choices: false,
clarifications: true,
default_choices: [],
description: true,
icon: 'question',
id: 'generic',
image: true,
keywords: [],
name: 'Generic',
placeholder: '',
points: true,
video: true,
}
},
/**
* Retrieve an array of keywords for the question type
* Used for filtering questions by search term in the quiz builder
*
* @return array
* @since 3.16.0
* @version 3.16.0
*/
get_keywords: function() {
var name = this.get( 'name' ),
words = [ name ];
return words.concat( this.get( 'keywords' ) ).concat( name.split( ' ' ) );
},
/**
* Get marker array for the question choices
*
* @return array
* @since 3.16.0
* @version 3.16.0
*/
get_choice_markers: function() {
return this._get_choice_option( 'markers' );
},
/**
* Determine if the question's choices are selectable
*
* @return bool
* @since 3.16.0
* @version 3.16.0
*/
get_choice_selectable: function() {
return this._get_choice_option( 'selectable' );
},
/**
* Get the choice type (text,image)
*
* @return string
* @since 3.16.0
* @version 3.16.0
*/
get_choice_type: function() {
return this._get_choice_option( 'type' );
},
/**
* Retrieve defined min. choices
*
* @return int
* @since 3.16.0
* @version 3.16.0
*/
get_min_choices: function() {
return this._get_choice_option( 'min' );
},
/**
* Get type-defined max choices
*
* @return string
* @since 3.16.0
* @version 3.16.0
*/
get_max_choices: function() {
return this._get_choice_option( 'max' );
},
/**
* Determine if multi-choice selection is enabled
*
* @return bool
* @since 3.16.0
* @version 3.16.0
*/
get_multi_choices: function() {
var choices = this.get( 'choices' );
if ( ! choices ) {
return false;
}
return this._get_choice_option( 'multi' );
},
/**
* Retrieve data from the type's "choices" attribute
* Allows quick handling of types with no choice definitions w/o additional checks
*
* @param string option name of the choice option to retrieve
* @return mixed
* @since 3.16.0
* @version 3.16.0
*/
_get_choice_option: function( option ) {
var choices = this.get( 'choices' );
if ( ! choices || ! choices[ option ] ) {
return false;
}
return choices[ option ];
},
} );
} );
================================================
FILE: assets/js/builder/Models/Quiz.js
================================================
/**
* Quiz Model.
*
* @since 3.16.0
* @version 7.5.0
*/
define( [
'Collections/Questions',
'Models/Lesson',
'Models/Question',
'Models/_Relationships',
'Models/_Utilities',
'Schemas/Quiz',
], function(
Questions,
Lesson,
Question,
Relationships,
Utilities,
QuizSchema
) {
return Backbone.Model.extend( _.defaults( {
/**
* model relationships
* @type {Object}
*/
relationships: {
parent: {
model: 'lesson',
type: 'model',
},
children: {
questions: {
class: 'Questions',
model: 'llms_question',
type: 'collection',
},
}
},
/**
* Lesson Settings Schema
* @type {Object}
*/
schema: QuizSchema,
/**
* New quiz defaults.
*
* @since 3.16.0
* @since 7.4.0 Added filter for filtering defaults.
* @since 7.5.0 Replaced unused `random_answers` property with `random_questions`.
* @since 7.8.0 Added filter for filtering defaults and `can_be_resumed` property.
*
* @return {Object}
*/
defaults: function() {
return window.llms.hooks.applyFilters( 'llms_quiz_model_defaults', {
id: _.uniqueId( 'temp_' ),
title: LLMS.l10n.translate( 'New Quiz' ),
type: 'llms_quiz',
lesson_id: '',
status: 'publish',
// editable fields.
content: '',
allowed_attempts: 5,
limit_attempts: 'no',
limit_time: 'no',
passing_percent: 65,
name: '',
random_questions: 'no',
time_limit: 30,
show_correct_answer: 'no',
can_be_resumed: 'no',
disable_retake: 'no',
questions: [],
// calculated.
_points: 0,
// display.
permalink: '',
_show_settings: false,
_questions_loaded: false,
} );
},
/**
* Initializer
* @return void
* @since 3.16.0
* @version 3.24.0
*/
initialize: function() {
this.init_custom_schema();
this.startTracking();
this.init_relationships();
this.listenTo( this.get( 'questions' ), 'add', this.update_points );
this.listenTo( this.get( 'questions' ), 'remove', this.update_points );
this.set( '_points', this.get_total_points() );
// when a quiz is published, ensure the parent lesson is marked as "Enabled" for quizzing
this.on( 'change:status', function() {
if ( 'publish' === this.get( 'status' ) ) {
this.get_parent().set( 'quiz_enabled', 'yes' );
}
} );
window.llms.hooks.doAction( 'llms_quiz_model_init', this );
},
/**
* Add a new question to the quiz
* @param obj data question data
* @return void
* @since 3.16.0
* @version 3.16.0
*/
add_question: function( data ) {
data.parent_id = this.get( 'id' );
var question = this.get( 'questions' ).add( data, {
parent: this,
} );
Backbone.pubSub.trigger( 'quiz-add-question', question, this );
},
/**
* Retrieve the translated post type name for the model's type
* @param bool plural if true, returns the plural, otherwise returns singular
* @return string
* @since 3.16.12
* @version 3.16.12
*/
get_l10n_type: function( plural ) {
if ( plural ) {
return LLMS.l10n.translate( 'quizzes' );
}
return LLMS.l10n.translate( 'quiz' );
},
/**
* Retrieve the quiz's total points
* @return int
* @since 3.16.0
* @version 3.16.0
*/
get_total_points: function() {
var points = 0;
this.get( 'questions' ).each( function( question ) {
points += question.get_points();
} );
return points;
},
/**
* Lazy load questions via AJAX
* @param {Function} cb callback function
* @return void
* @since 3.19.2
* @version 3.19.2
*/
load_questions: function( cb ) {
if ( this.get( '_questions_loaded' ) ) {
cb();
} else {
var self = this;
LLMS.Ajax.call( {
data: {
action: 'llms_builder',
action_type: 'lazy_load',
course_id: window.llms_builder.CourseModel.get( 'id' ),
load_id: this.get( 'id' ),
},
error: function( xhr, status, error ) {
console.log( xhr, status, error );
window.llms_builder.debug.log( '==== start load_questions error ====', xhr, status, error, '==== finish load_questions error ====' );
cb( true );
},
success: function( res ) {
if ( res && res.questions ) {
self.set( '_questions_loaded', true );
if ( res.questions ) {
_.each( res.questions, self.add_question, self );
}
cb();
} else {
cb( true );
}
}
} );
}
},
/**
* Update total number of points calculated property
* @return int
* @since 3.16.0
* @version 3.16.0
*/
update_points: function() {
this.set( '_points', this.get_total_points() );
},
}, Relationships, Utilities ) );
} );
================================================
FILE: assets/js/builder/Models/Section.js
================================================
/**
* Section Model
*
* @since 3.16.0
* @version 4.20.0
*/
define( [ 'Collections/Lessons', 'Models/_Relationships' ], function( Lessons, Relationships ) {
return Backbone.Model.extend( _.defaults( {
relationships: {
parent: {
model: 'course',
type: 'model',
},
children: {
lessons: {
class: 'Lessons',
model: 'lesson',
type: 'collection',
},
}
},
/**
* New section defaults
*
* @since 3.16.0
*
* @return {Object}
*/
defaults: function() {
return {
id: _.uniqueId( 'temp_' ),
lessons: [],
order: this.collection ? this.collection.length + 1 : 1,
parent_course: window.llms_builder.course.id,
title: LLMS.l10n.translate( 'New Section' ),
type: 'section',
// Expand the first 100 sections by default to avoid timeout issues.
_expanded: ! this.collection || this.collection.length <= 100 ? true : false,
_selected: false,
};
},
/**
* Initialize
*
* @since 3.16.0
*
* @return {void}
*/
initialize: function() {
this.startTracking();
this.init_relationships();
},
/**
* Add a lesson to the section
*
* @since 3.16.0
* @since 3.16.11 Unknown.
*
* @param {Object} data Hash of lesson data (creates new lesson)
* or existing lesson as a Backbone.Model.
* @param {Object} options Hash of options.
* @return {Object} Backbone.Model of the new/updated lesson.
*/
add_lesson: function( data, options ) {
data = data || {};
options = options || {};
if ( data instanceof Backbone.Model ) {
data.set( 'status', 'publish' );
data.set( 'parent_section', this.get( 'id' ) );
data.set_parent( this );
} else {
data.status = 'publish';
data.parent_section = this.get( 'id' );
}
return this.get( 'lessons' ).add( data, options );
},
/**
* Retrieve the translated post type name for the model's type
*
* @since 3.16.12
*
* @param {Boolean} plural If true, returns the plural, otherwise returns singular.
* @return {String}
*/
get_l10n_type: function( plural ) {
if ( plural ) {
return LLMS.l10n.translate( 'sections' );
}
return LLMS.l10n.translate( 'section' );
},
/**
* Get next section in the collection
*
* @since 3.16.11
*
* @param {boolean} circular If true handles the collection in a circle.
* If current is the last section, returns the first section.
* @return {Object}|false
*/
get_next: function( circular ) {
return this._get_sibling( 'next', circular );
},
/**
* Retrieve a reference to the parent course of the section
*
* @since 4.14.0
*
* @return {Object}
*/
get_course: function() {
// When working with an unsaved draft course the parent isn't properly set on the creation of a section.
if ( ! this.get_parent() ) {
this.set_parent( window.llms_builder.CourseModel );
}
return this.get_parent();
},
/**
* Get prev section in the collection
*
* @since 3.16.11
*
* @param {Boolean} circular If true handles the collection in a circle.
* If current is the first section, returns the last section.
* @return {Object}|false
*/
get_prev: function( circular ) {
return this._get_sibling( 'prev', circular );
},
/**
* Get a sibling section
*
* @since 3.16.11
* @since 4.20.0 Fix case when the last section was returned when looking for the prev of the first section and not `circular`.
*
* @param {String} direction Siblings direction [next|prev].
* @param {Boolean} circular If true handles the collection in a circle.
* If current is the last section, returns the first section.
* If current is the first section, returns the last section.
* @return {Object}|false
*/
_get_sibling: function( direction, circular ) {
circular = ( 'undefined' === circular ) ? true : circular;
var max = this.collection.size() - 1,
index = this.collection.indexOf( this ),
sibling_index;
if ( 'next' === direction ) {
sibling_index = index + 1;
} else if ( 'prev' === direction ) {
sibling_index = index - 1;
}
// Don't retrieve greater than max or less than min.
if ( sibling_index <= max || sibling_index >= 0 ) {
return this.collection.at( sibling_index );
} else if ( circular ) {
if ( 'next' === direction ) {
return this.collection.first();
} else if ( 'prev' === direction ) {
return this.collection.last();
}
}
return false;
},
}, Relationships ) );
} );
================================================
FILE: assets/js/builder/Models/_Relationships.js
================================================
/**
* Model relationships mixin
*
* @since 3.16.0
* @version 3.16.11
*/
define( [], function() {
return {
/**
* Default relationship settings object
*
* @type {Object}
*/
relationship_defaults: {
parent: {},
children: {},
},
/**
* Relationship settings object
* Should be overridden in the model
*
* @type {Object}
*/
relationships: {},
/**
* Initialize all parent and child relationships
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
init_relationships: function( options ) {
var rels = this.get_relationships();
// initialize parent relationships
// useful when adding a model to ensure parent is initialized
if ( rels.parent && options && options.parent ) {
this.set_parent( options.parent );
}
// initialize all children relationships
_.each( rels.children, function( child_data, child_key ) {
if ( ! child_data.conditional || true === child_data.conditional( this ) ) {
var child_val = this.get( child_key ),
child;
if ( child_data.lookup ) {
child = child_data.lookup( child_val );
} else if ( 'model' === child_data.type ) {
child = window.llms_builder.construct.get_model( child_data.class, child_val );
} else if ( 'collection' === child_data.type ) {
child = window.llms_builder.construct.get_collection( child_data.class, child_val );
}
this.set( child_key, child );
// if the child defines a parent, save a reference to the parent on the child
if ( 'model' === child_data.type ) {
this._maybe_set_parent_reference( child );
// save directly to each model in the collection
} else if ( 'collection' === child_data.type ) {
child.parent = this;
child.each( function( child_model ) {
this._maybe_set_parent_reference( child_model );
}, this );
}
}
}, this );
},
/**
* Retrieve the property names for all children of the model
*
* @return array
* @since 3.16.11
* @version 3.16.11
*/
get_child_props: function() {
var props = [];
_.each( this.get_relationships().children, function( data, key ) {
if ( ! data.conditional || true === data.conditional( this ) ) {
props.push( key );
}
}, this );
return props;
},
/**
* Retrieve the model's parent (if set)
*
* @return obj|false
* @since 3.16.0
* @version 3.16.0
*/
get_parent: function() {
var rels = this.get_relationships();
if ( rels.parent ) {
return rels.parent.reference;
}
return false;
},
/**
* Retrieve relationships for the model
* Extends with defaults
*
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
get_relationships: function() {
return $.extend( true, this.relationships, this.relationship_defaults );
},
/**
* Set the parent reference for the given model
*
* @param obj obj parent model obj
* @return void
* @since 3.16.0
* @version 3.16.0
*/
set_parent: function( obj ) {
this.relationships.parent.reference = obj;
},
/**
* Set up the parent relationships for qualifying children during relationship initialization
*
* @param obj model child model
* @return void
* @since 3.16.0
* @version 3.16.0
*/
_maybe_set_parent_reference: function( model ) {
if ( ! model || ! model.get_relationships ) {
return;
}
var rels = model.get_relationships();
if ( rels.parent && rels.parent.model === this.get( 'type' ) ) {
model.set_parent( this );
}
},
};
} );
================================================
FILE: assets/js/builder/Models/_Utilities.js
================================================
/**
* Utility functions for Models.
*
* @since 3.16.0
* @version 7.4.0
*/
define( [], function() {
return {
fields: [],
/**
* Override Backbone `set` method.
*
* Takes into account attributes of the form object[prop].
*
* @since 7.4.0
*
* @param {Mixed} attr The attribute to be set.
* @param {Mixed} val The value to set.
*/
set: function ( attr, val ) {
if ( 'string' === typeof attr ) {
const matches = attr.match( /(.*?)\[(.*?)\]/ );
if ( matches && 3 === matches.length ) {
const
realAttr = matches[1],
currentVal = Backbone.Model.prototype.get.call( this, realAttr );
var newVal = undefined !== currentVal ? currentVal : {};
newVal[ matches[2] ] = val;
arguments[0] = realAttr;
arguments[1] = newVal;
}
}
// Continue with Backbone default `set` behavior.
Backbone.Model.prototype.set.apply( this, arguments );
},
/**
* Override Backbone `get` method.
*
* Takes into account attributes of the form object[prop].
*
* @since 7.4.0
*
* @param {Mixed} attr The attribute name.
*/
get: function( attr ) {
const matches = attr.match( /(.*?)\[(.*?)\]/ );
if ( matches && 3 === matches.length ) {
const val = Backbone.Model.prototype.get.call( this, matches[1] );
if ( val && undefined !== val[ matches[2] ] ) {
return val[ matches[2] ];
}
}
// Continue with Backbone default `get` behavior.
return Backbone.Model.prototype.get.call( this, attr );
},
/**
* Retrieve the edit post link for the current model.
*
* @since 3.16.0
*
* @return string
*/
get_edit_post_link: function() {
if ( this.has_temp_id() ) {
return '';
}
return window.llms_builder.admin_url + 'post.php?post=' + this.get( 'id' ) + '&action=edit';
},
get_view_post_link: function() {
if ( this.has_temp_id() ) {
return '';
}
if ( this.get( 'permalink' ) ) {
return this.get( 'permalink' );
}
if ( this.get( 'status' ) === 'publish' ) {
return window.llms_builder.home_url + '?p=' + this.get( 'id' );
}
return window.llms_builder.home_url + '?p=' + this.get( 'id' ) + '&preview=true&post_type=' + this.get( 'type' );
},
/**
* Retrieve schema fields defined for the model
*
* @return object
* @since 3.17.0
* @version 3.17.1
*/
get_settings_fields: function() {
var schema = this.schema || {};
return window.llms_builder.schemas.get( schema, this.get( 'type' ).replace( 'llms_', '' ), this );
},
/**
* Determine if the model has a temporary ID
*
* @return {Boolean}
* @since 3.16.0
* @version 3.16.0
*/
has_temp_id: function() {
return ( ! _.isNumber( this.get( 'id' ) ) && 0 === this.get( 'id' ).indexOf( 'temp_' ) );
},
/**
* Initializes 3rd party custom schema (field) data for a model
*
* @return void
* @since 3.17.0
* @version 3.17.0
*/
init_custom_schema: function() {
var groups = _.filter( this.get_settings_fields(), function( group ) {
return ( group.custom );
} );
_.each( groups, function( group ) {
_.each( _.flatten( group.fields ), function( field ) {
var keys = [ field.attribute ],
customs = this.get( 'custom' );
if ( field.switch_attribute ) {
keys.push( field.switch_attribute );
}
_.each( keys, function( key ) {
var attr = field.attribute_prefix ? field.attribute_prefix + key : key;
if ( customs && customs[ attr ] ) {
this.set( key, customs[ attr ][0] );
}
}, this );
}, this );
}, this );
},
};
} );
================================================
FILE: assets/js/builder/Models/loader.js
================================================
/**
* Load all models
*
* @return obj
* @since 3.16.0
* @version 3.17.0
*/
define( [
'Models/Abstract',
'Models/Course',
'Models/Image',
'Models/Lesson',
'Models/Question',
'Models/QuestionChoice',
'Models/QuestionType',
'Models/Quiz',
'Models/Section'
],
function(
Abstract,
Course,
Image,
Lesson,
Question,
QuestionChoice,
QuestionType,
Quiz,
Section
) {
return {
Abstract: Abstract,
Course: Course,
Image: Image,
Lesson: Lesson,
Question: Question,
QuestionChoice: QuestionChoice,
QuestionType: QuestionType,
Quiz: Quiz,
Section: Section,
};
} );
================================================
FILE: assets/js/builder/Schemas/Lesson.js
================================================
/**
* Lesson Schemas
*
* @since 3.17.0
* @version 3.25.4
*/
define( [], function() {
return window.llms.hooks.applyFilters( 'llms_define_lesson_schema', {
default: {
title: LLMS.l10n.translate( 'General Settings' ),
toggleable: true,
fields: [
[
{
attribute: 'permalink',
id: 'permalink',
type: 'permalink',
},
], [
{
attribute: 'content',
id: 'content',
label: LLMS.l10n.translate( 'Content' ),
type: 'editor',
condition: function() {
return '' === this.get( 'content' ) || 'yes' === this.get( 'content_added_in_builder' );
},
},
], [
{
id: 'content-page-builder-notice',
label: LLMS.l10n.translate( 'Content' ),
type: 'page_builder_notice',
condition: function() {
return '' !== this.get( 'content' ) && 'yes' !== this.get( 'content_added_in_builder' );
},
},
], [
{
attribute: 'video_embed',
id: 'video-embed',
label: LLMS.l10n.translate( 'Video Embed URL' ),
type: 'video_embed',
},
{
attribute: 'audio_embed',
id: 'audio-embed',
label: LLMS.l10n.translate( 'Audio Embed URL' ),
type: 'audio_embed',
},
], [
{
attribute: 'free_lesson',
id: 'free-lesson',
label: LLMS.l10n.translate( 'Free Lesson' ),
tip: LLMS.l10n.translate( 'Free lessons can be accessed without enrollment.' ),
type: 'switch',
},
{
attribute: 'require_passing_grade',
id: 'require-passing-grade',
label: LLMS.l10n.translate( 'Require Passing Grade on Quiz' ),
tip: LLMS.l10n.translate( 'When enabled, students must pass this quiz before the lesson can be completed.' ),
type: 'switch',
condition: function() {
return ( 'yes' === this.get( 'quiz_enabled' ) );
},
},
{
attribute: 'require_assignment_passing_grade',
id: 'require-assignment-passing-grade',
label: LLMS.l10n.translate( 'Require Passing Grade on Assignment' ),
tip: LLMS.l10n.translate( 'When enabled, students must pass this assignment before the lesson can be completed.' ),
type: 'switch',
condition: function() {
return ( 'undefined' !== window.llms_builder.assignments && 'yes' === this.get( 'assignment_enabled' ) );
},
},
{
attribute: 'points',
id: 'points',
label: LLMS.l10n.translate( 'Lesson Weight' ),
label_after: LLMS.l10n.translate( 'POINTS' ),
min: 0,
max: 99,
tip: LLMS.l10n.translate( 'Determines the weight of the lesson when calculating the overall grade of the course.' ),
tip_position: 'top-left',
type: 'number',
condition: function() {
return ( ( 'yes' === this.get( 'quiz_enabled' ) ) || ( 'undefined' !== window.llms_builder.assignments && 'yes' === this.get( 'assignment_enabled' ) ) );
},
},
], [
{
attribute: 'prerequisite',
condition: function() {
return ( false === this.is_first_in_course() );
},
id: 'prerequisite',
label: LLMS.l10n.translate( 'Prerequisite' ),
switch_attribute: 'has_prerequisite',
type: 'switch-select',
options: function() {
return this.get_available_prereq_options();
},
},
], [
{
label: LLMS.l10n.translate( 'Course Drip Method' ),
id: 'course-drip',
type: 'heading',
condition: function() {
return ( this.get_course() && 'yes' === this.get_course().get( 'lesson_drip' ) && this.get_course().get( 'drip_method' ) );
},
detail: LLMS.l10n.translate( 'Drip settings are currently set at the course level, under the Restrictions settings tab. Disable to allow lesson level drip settings.' ) + ' <a href=\"javascript:document.getElementById(\'llms-exit-button\').click()\">' + LLMS.l10n.translate( 'Edit Course' ) + '</a>',
},
], [
{
label: LLMS.l10n.translate( 'Course Drip Method' ),
id: 'course-drip',
type: 'heading',
condition: function() {
return ( ! this.get_course() || 'yes' !== this.get_course().get( 'lesson_drip' ) || ! this.get_course().get( 'drip_method' ) );
},
detail: LLMS.l10n.translate( 'Drip settings can be set at the course level to release course content at a specified interval, in the Restrictions settings tab.' ) + ' <a href=\"javascript:document.getElementById(\'llms-exit-button\').click()\">' + LLMS.l10n.translate( 'Edit Course' ) + '</a>',
},
], [
{
attribute: 'drip_method',
id: 'drip-method',
label: LLMS.l10n.translate( 'Drip Method' ),
switch_attribute: 'drip_method',
type: 'select',
condition: function() {
return ( ! this.get_course() || 'yes' !== this.get_course().get( 'lesson_drip' ) || ! this.get_course().get( 'drip_method' ) );
},
options: function() {
var options = [
{
key: '',
val: LLMS.l10n.translate( 'None' ),
},
{
key: 'date',
val: LLMS.l10n.translate( 'On a specific date' ),
},
{
key: 'enrollment',
val: LLMS.l10n.translate( '# of days after course enrollment' ),
},
];
if ( this.get_course() && this.get_course().get( 'start_date' ) ) {
options.push( {
key: 'start',
val: LLMS.l10n.translate( '# of days after course start date' ),
} );
}
if ( 'yes' === this.get( 'has_prerequisite' ) ) {
options.push( {
key: 'prerequisite',
val: LLMS.l10n.translate( '# of days after prerequisite lesson completion' ),
} );
}
return options;
},
},
{
attribute: 'days_before_available',
condition: function() {
if ( this.get_course() && 'yes' === this.get_course().get( 'lesson_drip' ) && this.get_course().get( 'drip_method' ) ) {
return false;
}
return ( -1 !== [ 'enrollment', 'start', 'prerequisite' ].indexOf( this.get( 'drip_method' ) ) );
},
id: 'days-before-available',
label: LLMS.l10n.translate( '# of days' ),
min: 0,
type: 'number',
},
{
attribute: 'date_available',
date_format: 'Y-m-d',
condition: function() {
if ( this.get_course() && 'yes' === this.get_course().get( 'lesson_drip' ) && this.get_course().get( 'drip_method' ) ) {
return false;
}
return ( 'date' === this.get( 'drip_method' ) );
},
id: 'date-available',
label: LLMS.l10n.translate( 'Date' ),
timepicker: 'false',
type: 'datepicker',
},
{
attribute: 'time_available',
condition: function() {
if ( this.get_course() && 'yes' === this.get_course().get( 'lesson_drip' ) && this.get_course().get( 'drip_method' ) ) {
return false;
}
return ( 'date' === this.get( 'drip_method' ) );
},
datepicker: 'false',
date_format: 'h:i A',
id: 'time-available',
label: LLMS.l10n.translate( 'Time' ),
type: 'datepicker',
},
], [
{
label: LLMS.l10n.translate( 'Associated Event(s)' ),
id: 'llms-events-promo',
type: 'heading',
detail: LLMS.l10n.translate( 'Schedule events for your lessons with the LifterLMS Events add-on.' ) + ' <a href="https://lifterlms.com/product/lifterlms-events/?utm_source=LifterLMS%20Plugin&utm_medium=Lesson%20Builder&utm_campaign=Events%20Addon%20Upsell" target="_blank">' + LLMS.l10n.translate( 'Learn More' ) + '</a>',
condition: function() {
return ! window.llms_builder.events;
},
},
],
],
},
} );
} );
================================================
FILE: assets/js/builder/Schemas/Quiz.js
================================================
/**
* Quiz Schema.
*
* @since 3.17.6
* @since 7.4.0 Added upsell for Question Bank and condition in `random_questions` schema.
* @since 7.6.2 Added `disable_retake` schema.
* @since 7.8.0 Added `can_be_resumed` option.
* @version 7.8.0
*/
define( [], function() {
return window.llms.hooks.applyFilters( 'llms_define_quiz_schema', {
default: {
title: LLMS.l10n.translate( 'General Settings' ),
toggleable: true,
fields: [
[
{
attribute: 'permalink',
id: 'permalink',
type: 'permalink',
},
], [
{
attribute: 'content',
id: 'description',
label: LLMS.l10n.translate( 'Description' ),
type: 'editor',
},
], [
{
attribute: 'passing_percent',
id: 'passing-percent',
label: LLMS.l10n.translate( 'Passing Percentage' ),
min: 0,
max: 100,
tip: LLMS.l10n.translate( 'Minimum percentage of total points required to pass the quiz' ),
type: 'number',
},
{
attribute: 'allowed_attempts',
id: 'allowed-attempts',
label: LLMS.l10n.translate( 'Limit Attempts' ),
switch_attribute: 'limit_attempts',
tip: LLMS.l10n.translate( 'Limit the maximum number of times a student can take this quiz' ),
type: 'switch-number',
},
{
attribute: 'time_limit',
id: 'time-limit',
label: LLMS.l10n.translate( 'Time Limit' ),
min: 1,
max: 360,
switch_attribute: 'limit_time',
tip: LLMS.l10n.translate( 'Enforce a maximum number of minutes a student can spend on each attempt' ),
type: 'switch-number',
},
], [
{
attribute: 'can_be_resumed',
id: 'resume',
label: LLMS.l10n.translate( 'Can be resumed' ),
tip: LLMS.l10n.translate( 'Allow a new attempt on this quiz to be resumed' ),
type: 'switch',
condition: function() {
return 'yes' === this.get( 'limit_time' ) ? false : true;
}
},
{
attribute: 'show_correct_answer',
id: 'show-correct-answer',
label: LLMS.l10n.translate( 'Show Correct Answers' ),
tip: LLMS.l10n.translate( 'When enabled, students will be shown the correct answer to any question they answered incorrectly.' ),
type: 'switch',
},
{
attribute: 'random_questions',
id: 'random-questions',
label: LLMS.l10n.translate( 'Randomize Question Order' ),
tip: LLMS.l10n.translate( 'Display questions in a random order for each attempt. Content questions are locked into their defined positions.' ),
type: 'switch',
condition: function() {
return 'yes' === this.get( 'question_bank' ) ? false : true;
}
},
{
attribute: 'disable_retake',
id: 'disable-retake',
label: LLMS.l10n.translate( 'Disable Retake' ),
tip: LLMS.l10n.translate( 'Prevent quiz retake after student passed the quiz.' ),
type: 'switch',
},
], [
{
id: 'question-bank',
label: LLMS.l10n.translate( 'Question Bank' ),
tip: LLMS.l10n.translate( 'A question bank helps prevent cheating and reinforces learning by allowing instructors to create assessments with randomized questions pulled from a bank of questions. (Available in Advanced Quizzes addon)' ),
type: 'upsell',
text: LLMS.l10n.translate( 'Get LifterLMS Advanced Quizzes' ),
url: 'https://lifterlms.com/product/advanced-quizzes/?utm_source=LifterLMS%20Plugin&utm_medium=Quiz%20Builder%20Button&utm_campaign=Advanced%20Question%20Upsell&utm_content=3.16.0&utm_term=Questions%20Bank'
}
]
],
},
} );
} );
================================================
FILE: assets/js/builder/Views/Assignment.js
================================================
/**
* Single Assignment View.
*
* @package LifterLMS/Scripts
*
* @since 3.17.0
* @version 5.4.0
*/
define( [
'Views/Popover',
'Views/PostSearch',
'Views/_Detachable',
'Views/_Editable',
'Views/_Trashable',
'Views/_Subview',
'Views/SettingsFields'
], function(
Popover,
PostSearch,
Detachable,
Editable,
Trashable,
Subview,
SettingsFields
) {
return Backbone.View.extend( _.defaults( {
/**
* Current view state.
*
* @type {String}
*/
state: 'default',
/**
* Current Subviews.
*
* @type {Object}
*/
views: {
settings: {
class: SettingsFields,
instance: null,
state: 'default',
},
},
el: '#llms-editor-assignment',
/**
* DOM Events.
*
* @since 3.17.1
*
* @return {Object}
*/
events: function() {
var addon_events = this.is_addon_available() ? window.llms_builder.assignments.get_view_events() : {};
return _.defaults( {
'click #llms-existing-assignment': 'add_existing_assignment_click',
'click #llms-new-assignment': 'add_new_assignment',
}, Detachable.events, Editable.events, Trashable.events, addon_events );
},
/**
* Wrapper Tag name.
*
* @type {String}
*/
tagName: 'div',
/**
* Get the underscore template.
*
* @type {[type]}
*/
template: wp.template( 'llms-assignment-template' ),
/**
* Initialization callback func (renders the element on screen).
*
* @since 3.17.0
* @since 3.17.2 Unknown.
*
* @return {Void}
*/
initialize: function( data ) {
this.lesson = data.lesson;
// initialize the model if the assignment is enabled or it's disabled but we still have data for a assignment
if ( 'yes' === this.lesson.get( 'assignment_enabled' ) || ! _.isEmpty( this.lesson.get( 'assignment' ) ) ) {
this.model = this.lesson.get( 'assignment' );
/**
* Todo Item.
*
* @todo this is a terrible terrible patch
* I've spent nearly 3 days trying to figure out how to not use this line of code
* ISSUE REPRODUCTION:
* Open course builder
* Open a lesson (A) and add a assignment
* Switch to a new lesson (B)
* Add a new assignment
* Return to lesson A and the assignment's parent will be set to LESSON B
* This will happen for *every* assignment in the builder...
* Adding this set_parent on init guarantees that the assignment's correct parent is set
* after adding new assignment's to other lessons
* it's awful and it's gross...
* I'm confused and tired and going to miss release dates again because of it
*/
this.model.set_parent( this.lesson );
this.listenTo( this.model, 'change:permalink', this.render_settings );
}
this.on( 'model-trashed', this.on_trashed );
},
/**
* Compiles the template and renders the view.
*
* @since 3.17.0
* @since 3.17.7 Unknown.
*
* @return {Self} For chaining.
*/
render: function() {
this.$el.html( this.template( this.model ) );
if ( this.model && this.is_addon_available() ) {
this.stopListening( this.model, 'change:assignment_type', this.render );
this.render_subview( 'settings', {
el: '#llms-assignment-settings-fields',
model: this.model,
} );
// this.init_datepickers();
this.init_selects();
window.llms_builder.assignments.render_editor( this );
this.listenTo( this.model, 'change:assignment_type', this.render );
}
return this;
},
/**
* Re-render the settings subview when permalink updates after saving.
*
* @since 10.0.0
*
* @return {Void}
*/
render_settings: function() {
var view = this.get_subview( 'settings' );
if ( view && view.instance ) {
view.instance.render();
this.init_selects();
}
},
/**
* Adds a new assignment to a lesson which currently has no assignment associated with it.
*
* @since 3.17.0
*
* @return {Void}
*/
add_new_assignment: function() {
if ( this.is_addon_available() ) {
this.model = window.llms_builder.assignments.get_assignment( {
/* Translators: %1$s = associated lesson title */
title: LLMS.l10n.replace( '%1$s Assignment', {
'%1$s': this.lesson.get( 'title' ),
} ),
lesson_id: this.lesson.get( 'id' ),
} );
this.lesson.set( 'assignment_enabled', 'yes' );
this.lesson.set( 'assignment', this.model );
this.listenTo( this.model, 'change:permalink', this.render_settings );
this.render();
} else {
this.show_ad_popover( '#llms-new-assignment' );
}
},
/**
* When an assignment is selected from the post select popover
* instantiate it and add it to the current lesson.
*
* @param {Object} event Data from the select2 select event.
*
* @since 3.17.0
* @since 5.4.0 Prepare assignment object for cloning and use author id instead of the quiz author object.
*/
add_existing_assignment: function( event ) {
this.post_search_popover.hide();
var assignment = event.data;
if ( 'clone' === event.action ) {
assignment = _.prepareAssignmentObjectForCloning( assignment );
} else {
// Use author id instead of the assignment author object.
assignment = _.prepareExistingPostObjectDataForAddingOrCloning( assignment );
assignment._forceSync = true;
}
assignment.lesson_id = this.lesson.get( 'id' )
assignment = window.llms_builder.construct.get_model( 'Assignment', assignment );
this.lesson.set( 'assignment_enabled', 'yes' );
this.lesson.set( 'assignment', assignment );
this.model = assignment;
this.listenTo( this.model, 'change:permalink', this.render_settings );
this.render();
},
/**
* Open add existing assignment popover.
*
* @since 3.17.0
*
* @param {Object} event JS event object.
* @return {Void}
*/
add_existing_assignment_click: function( event ) {
event.preventDefault();
if ( this.is_addon_available() ) {
this.post_search_popover = new Popover( {
el: '#llms-existing-assignment',
args: {
backdrop: true,
closeable: true,
container: '.wrap.lifterlms.llms-builder',
dismissible: true,
placement: 'left',
width: 480,
title: LLMS.l10n.translate( 'Add Existing Assignment' ),
content: new PostSearch( {
post_type: 'llms_assignment',
searching_message: LLMS.l10n.translate( 'Search for existing assignments...' ),
} ).render().$el,
onHide: function() {
Backbone.pubSub.off( 'assignment-search-select' );
},
}
} );
this.post_search_popover.show();
Backbone.pubSub.once( 'assignment-search-select', this.add_existing_assignment, this );
} else {
this.show_ad_popover( '#llms-existing-assignment' );
}
},
/**
* Determine if Assignments addon is available to use.
*
* @since 3.17.0
*
* @return {Boolean}
*/
is_addon_available: function() {
return ( window.llms_builder.assignments );
},
/**
* Called when assignment is trashed.
*
* @since 3.17.0
*
* @param {Oject} assignment Assignment Model.
* @return {Void}
*/
on_trashed: function( assignment ) {
this.lesson.set( 'assignment_enabled', 'no' );
this.lesson.set( 'assignment', '' );
delete this.model;
this.render();
},
/**
* Shows a dirty dirty ad popover for advanced assignments.
*
* @since 3.17.0
*
* @param {Sring} el The jQuery selector string.
* @return {Void}
*/
show_ad_popover: function( el ) {
var h3 = LLMS.l10n.translate( 'Get Your Students Taking Action' ),
p = 'Great learning content is only half of teaching online. When your learners fully engage, they will take your content and move into action. Remove barriers for your learners by telling them what to do to apply what they just learned. Create graded assignments or simply give them a checklist of action items to complete before moving on.',
btn = LLMS.l10n.translate( 'Get Assignments Now!' ),
url = 'https://lifterlms.com/product/lifterlms-assignments?utm_source=LifterLMS%20Plugin&utm_medium=Assignment%20Builder%20Button&utm_campaign=Assignment%20Addon%20Upsell&utm_content=3.17.0';
this.ad_popover = new Popover( {
el: el,
args: {
backdrop: true,
closeable: true,
container: '.wrap.lifterlms.llms-builder',
dismissible: true,
// placement: 'left',
width: 380,
title: LLMS.l10n.translate( 'Unlock LifterLMS Assignments' ),
// This is here for translation but not actually used by the popover.
closeLabel: LLMS.l10n.translate( 'Close' ),
content: '<h3>' + h3 + '</h3><p>' + p + '</p><br><p><a class="llms-button-primary" href="' + url + '" target="_blank">' + btn + '</a></p>'
}
} );
this.ad_popover.show();
},
}, Detachable, Editable, Trashable, Subview, SettingsFields ) );
} );
================================================
FILE: assets/js/builder/Views/Course.js
================================================
/**
* Single Course View
*
* @since 3.13.0
* @version 3.16.0
*/
define( [
'Views/SectionList',
'Views/_Detachable',
'Views/_Editable',
'Views/_Shiftable',
'Views/_Trashable'
], function(
SectionListView,
Detachable,
Editable,
Shiftable,
Trashable
) {
return Backbone.View.extend( _.defaults( {
/**
* Get default attributes for the html wrapper element
*
* @return obj
* @since 3.13.0
* @version 3.13.0
*/
attributes: function() {
return {
'data-id': this.model.id,
};
},
/**
* HTML element selector
*
* @type {String}
*/
el: '#llms-builder-main',
/**
* Wrapper Tag name
*
* @type {String}
*/
tagName: 'div',
/**
* Get the underscore template
*
* @type {[type]}
*/
template: wp.template( 'llms-course-template' ),
/**
* Initialization callback func (renders the element on screen)
*
* @return void
* @since 3.13.0
* @version 3.13.0
*/
initialize: function() {
var self = this;
// this.listenTo( this.model, 'sync', this.render );
this.render();
this.sectionListView = new SectionListView( {
collection: this.model.get( 'sections' ),
} );
this.sectionListView.render();
// drag and drop start
this.sectionListView.on( 'sortStart', this.sectionListView.sortable_start );
// drag and drop stop
this.sectionListView.on( 'sortStop', this.sectionListView.sortable_stop );
// selection changes
this.sectionListView.on( 'selectionChanged', this.active_section_change );
// "select" a section when it's added to the course
this.listenTo( this.model.get( 'sections' ), 'add', this.on_section_add );
Backbone.pubSub.on( 'section-toggle', this.on_section_toggle, this );
Backbone.pubSub.on( 'section-select', this.on_section_select, this );
Backbone.pubSub.on( 'expand-section', this.expand_section, this );
Backbone.pubSub.on( 'lesson-selected', this.active_lesson_change, this );
// Select the first section by default on load.
var firstSection = this.model.get( 'sections' ).first();
if ( firstSection ) {
this.sectionListView.setSelectedModel( firstSection );
}
},
/**
* Events
* @type {Object}
* @version 7.6.0
*/
events: _.defaults( {
'click .new-section': 'add_new_section',
}, Detachable.events, Editable.events, Trashable.events ),
/**
* Compiles the template and renders the view
*
* @return self (for chaining)
* @since 3.13.0
* @version 3.13.0
*/
render: function() {
this.$el.html( this.template( this.model ) );
return this;
},
active_lesson_change: function( model ) {
// set parent section to be active
var section = this.model.get( 'sections' ).get( model.get( 'parent_section' ) );
this.sectionListView.setSelectedModel( section );
},
/**
* When a section "selection" changes in the list
* Update each section model so we can figure out which one is selected from other views
*
* @param array current array of selected models
* @param array previous array of previously selected models
* @return void
* @since 3.16.0
* @version 3.16.0
*/
active_section_change: function( current, previous ) {
_.each( current, function( model ) {
model.set( '_selected', true, { silent: true } );
} );
_.each( previous, function( model ) {
model.set( '_selected', false, { silent: true } );
} );
},
/**
* "Selects" the new section when it's added to the course
*
* @param obj model Section model that's just been added
* @return void
* @since 3.16.0
* @version 3.16.0
*/
on_section_add: function( model ) {
this.sectionListView.setSelectedModel( model );
},
/**
* When expanding/collapsing sections
* if collapsing, unselect, if expanding, select
*
* @param obj model toggled section
* @return void
* @since 3.16.0
* @version 3.16.0
*/
on_section_toggle: function( model ) {
this.sectionListView.setSelectedModel( model );
},
/**
* When doing things like adding a lesson, seelct the section.
*
* @param obj model toggled section
* @return void
* @since 7.6.0
* @version 7.6.0
*/
on_section_select: function( model ) {
this.sectionListView.setSelectedModel( model );
},
add_new_section: function( event ) {
event.preventDefault();
Backbone.pubSub.trigger( 'add-new-section' );
},
}, Editable ) );
} );
================================================
FILE: assets/js/builder/Views/Editor.js
================================================
/**
* Sidebar Editor View
*
* @since 3.16.0
* @version 3.27.0
*/
define( [
'Views/LessonEditor',
'Views/Quiz',
'Views/Assignment',
'Views/_Subview'
], function(
LessonEditor,
Quiz,
Assignment,
Subview
) {
return Backbone.View.extend( _.defaults( {
/**
* Current view state
*
* @type {String}
*/
state: 'lesson', // [lesson|quiz]
/**
* Current Subviews
*
* @type {Object}
*/
views: {
lesson: {
class: LessonEditor,
instance: null,
state: 'lesson',
},
assignment: {
class: Assignment,
instance: null,
state: 'assignment',
},
quiz: {
class: Quiz,
instance: null,
state: 'quiz',
},
},
/**
* HTML element selector
*
* @type {String}
*/
el: '#llms-editor',
events: {
'click .llms-editor-nav a[href="#llms-editor-close"]': 'close_editor',
'click .llms-editor-nav a:not([href="#llms-editor-close"])': 'switch_tab',
},
/**
* Wrapper Tag name
*
* @type {String}
*/
tagName: 'div',
/**
* Get the underscore template
*
* @type {[type]}
*/
template: wp.template( 'llms-editor-template' ),
/**
* Initialization callback func (renders the element on screen)
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
initialize: function( data ) {
this.SidebarView = data.SidebarView;
if ( data.tab ) {
this.state = data.tab;
}
},
/**
* Compiles the template and renders the view
*
* @return self (for chaining)
* @since 3.16.0
* @version 3.16.0
*/
render: function( view_data ) {
view_data = view_data || {};
this.$el.html( this.template( this ) );
this.render_subviews( _.extend( view_data, {
lesson: this.model,
} ) );
return this;
},
/**
* Click event for close sidebar editor button
* Sends event to main SidebarView to trigger editor closing events
*
* @param obj event js event obj
* @return void
* @since 3.16.0
* @version 3.27.0
*/
close_editor: function( event ) {
event.preventDefault();
Backbone.pubSub.trigger( 'sidebar-editor-close' );
window.location.hash = '';
},
/**
* Click event for switching tabs in the editor navigation
*
* @param object event js event object
* @return void
* @since 3.16.0
* @version 3.27.0
*/
switch_tab: function( event ) {
event.preventDefault();
var $btn = $( event.target ),
view = $btn.attr( 'data-view' ),
$tab = this.$el.find( $btn.attr( 'href' ) );
this.set_state( view ).render();
this.set_hash( view );
// Backbone.pubSub.trigger( 'editor-tab-activated', $btn.attr( 'href' ).substring( 1 ) );
},
/**
* Adds a hash for deep linking to a specific lesson tab
*
* @param string subtab subtab [quiz|assignment]
* @return void
* @since 3.27.0
* @version 3.27.0
*/
set_hash: function( subtab ) {
var hash = 'lesson:' + this.model.get( 'id' );
if ( 'lesson' !== subtab ) {
hash += ':' + subtab;
}
window.location.hash = hash;
},
}, Subview ) );
} );
================================================
FILE: assets/js/builder/Views/Elements.js
================================================
/**
* Sidebar Elements View
*
* @since 3.16.0
* @version 3.16.12
*/
define( [ 'Models/Section', 'Views/Section', 'Models/Lesson', 'Views/Lesson', 'Views/Popover', 'Views/PostSearch' ], function( Section, SectionView, Lesson, LessonView, Popover, LessonSearch ) {
return Backbone.View.extend( {
/**
* HTML element selector
*
* @type {String}
*/
el: '#llms-elements',
events: {
'click #llms-new-section': 'add_new_section',
'click #llms-new-lesson': 'add_new_lesson',
'click #llms-existing-lesson': 'add_existing_lesson',
},
/**
* Wrapper Tag name
*
* @type {String}
*/
tagName: 'div',
/**
* Get the underscore template
*
* @type {[type]}
*/
template: wp.template( 'llms-elements-template' ),
/**
* Initialization callback func (renders the element on screen)
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
initialize: function( data ) {
// save a reference to the main Course view
this.SidebarView = data.SidebarView;
// watch course sections and enable/disable lesson buttons conditionally
this.listenTo( this.SidebarView.CourseView.model.get( 'sections' ), 'add', this.maybe_disable_buttons );
this.listenTo( this.SidebarView.CourseView.model.get( 'sections' ), 'remove', this.maybe_disable_buttons );
},
/**
* Compiles the template and renders the view
*
* @return self (for chaining)
* @since 3.16.0
* @version 3.16.0
*/
render: function() {
this.$el.html( this.template() );
this.draggable();
this.maybe_add_initial_section();
return this;
},
draggable: function() {
$( '#llms-new-section' ).draggable( {
appendTo: '#llms-sections',
cancel: false,
connectToSortable: '.llms-sections',
helper: function() {
return new SectionView( { model: new Section() } ).render().$el;
},
start: function() {
$( '.llms-sections' ).addClass( 'dragging' );
},
stop: function() {
$( '.llms-sections' ).removeClass( 'dragging' );
},
} );
$( '#llms-new-lesson' ).draggable( {
// appendTo: '#llms-sections .llms-section:first-child .llms-lessons',
appendTo: '#llms-sections',
cancel: false,
connectToSortable: '.llms-lessons',
helper: function() {
return new LessonView( { model: new Lesson() } ).render().$el;
},
start: function() {
$( '.llms-lessons' ).addClass( 'dragging' );
},
stop: function() {
$( '.llms-lessons' ).removeClass( 'dragging' );
$( '.drag-expanded' ).removeClass( '.drag-expanded' );
},
} );
},
add_new_section: function( event ) {
event.preventDefault();
Backbone.pubSub.trigger( 'add-new-section' );
},
add_new_lesson: function( event ) {
event.preventDefault();
Backbone.pubSub.trigger( 'add-new-lesson' );
},
/**
* Show the popover to add an existing lessons
*
* @param object event JS Event Object
* @return void
* @since 3.16.12
* @version 3.16.12
*/
add_existing_lesson: function( event ) {
event.preventDefault();
var pop, onLessonSelect;
pop = new Popover( {
el: '#llms-existing-lesson',
args: {
backdrop: true,
closeable: true,
container: '.wrap.lifterlms.llms-builder',
dismissible: true,
placement: 'left',
width: 480,
title: LLMS.l10n.translate( 'Add Existing Lesson' ),
content: new LessonSearch( {
post_type: 'lesson',
searching_message: LLMS.l10n.translate( 'Search for existing lessons...' ),
} ).render().$el,
onHide: function() {
Backbone.pubSub.off( 'lesson-search-select', onLessonSelect );
},
}
} );
onLessonSelect = function() {
pop.hide();
// Ref #3097 — pop.hide() doesn't always remove the DOM elements.
$( '.webui-popover' ).remove();
$( '.webui-popover-backdrop' ).remove();
};
pop.show();
Backbone.pubSub.once( 'lesson-search-select', onLessonSelect );
},
/**
* Disables lesson add buttons if no sections are available to add a lesson to
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
maybe_add_initial_section: function() {
var $els = $( '#llms-new-lesson, #llms-existing-lesson' );
if ( ! this.SidebarView.CourseView.model.get( 'sections' ).length ) {
Backbone.pubSub.trigger( 'add-new-section' );
Backbone.pubSub.trigger( 'add-new-lesson' );
Backbone.pubSub.trigger( 'add-new-lesson' );
Backbone.pubSub.trigger( 'add-new-lesson' );
} else {
$els.removeAttr( 'disabled' );
}
},
} );
} );
================================================
FILE: assets/js/builder/Views/FormattingToolbar.js
================================================
/**
* Sidebar Elements View
*
* @since 3.16.0
* @version 3.16.0
*/
define( [], function() {
return Backbone.View.extend( {
className: 'llms-input-formatting',
events: {
'mousedown a[href="#llms-formatting"]': 'on_click',
},
/**
* Wrapper Tag name
*
* @type {String}
*/
tagName: 'div',
/**
* Initialization callback func (renders the element on screen)
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
initialize: function( data ) {
var self = this;
this.$input = data.$input;
this.tags = data.tags;
this.$input.on( 'keyup focus click', function() {
_.each( self.tags, function( tag ) {
var name = self._get_formatting_name( tag );
if ( document.queryCommandState( name ) ) {
self.toggle_button_state( name, 'on' );
} else {
self.toggle_button_state( name, 'off' );
}
} );
} );
},
/**
* Compiles the template and renders the view
*
* @return self (for chaining)
* @since 3.16.0
* @version 3.16.0
*/
render: function() {
this.$el.html( this.template() );
return this;
},
template: function() {
var self = this,
$toolbar = $( '<div />' );
_.each( this.tags, function( tag ) {
$toolbar.append( self._get_formatting_icon( tag ) );
} );
return $toolbar.html();
},
on_click: function( event ) {
event.preventDefault();
var $btn = $( event.target ),
selection = window.getSelection(),
commands = [ 'bold', 'italic', 'underline' ],
range, cmd;
if ( $btn.hasClass( 'fa' ) ) {
$btn = $btn.closest( 'a' );
}
cmd = $btn.attr( 'data-cmd' );
if ( -1 === commands.indexOf( cmd ) ) {
return;
}
$btn.addClass( 'active' );
document.execCommand( cmd );
},
toggle_button_state: function( tag_name, state ) {
var $btn = this.$el.find( 'a[data-cmd="' + tag_name + '"]' ),
del = 'on' === state ? '' : 'active',
add = 'on' === state ? 'active' : '';
$btn.removeClass( del ).addClass( add );
},
_get_formatting_name: function( tag ) {
var tags = {
b: 'bold',
i: 'italic',
u: 'underline',
};
return tags[ tag ];
},
_get_formatting_icon: function( tag ) {
var name = this._get_formatting_name( tag );
return '<a class="llms-action-icon" data-cmd="' + name + '" href="#llms-formatting"><i class="fa fa-' + name + '" aria-hidden="true"></i></a>';
},
} );
} );
================================================
FILE: assets/js/builder/Views/Lesson.js
================================================
/**
* Single Lesson View
* @since 3.16.0
* @version 3.27.0
*/
define( [
'Views/_Detachable',
'Views/_Editable',
'Views/_Shiftable',
'Views/_Trashable'
], function(
Detachable,
Editable,
Shiftable,
Trashable
) {
return Backbone.View.extend( _.defaults( {
/**
* Get default attributes for the html wrapper element
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
attributes: function() {
return {
'data-id': this.model.id,
'data-section-id': this.model.get( 'parent_section' ),
};
},
/**
* HTML class names
* @type {String}
*/
className: 'llms-builder-item llms-lesson',
/**
* Events
* @type {Object}
* @since 3.16.0
* @version 3.16.12
*/
events: _.defaults( {
'click .edit-lesson': 'edit_lesson',
'click .llms-headline': 'edit_lesson',
'click .edit-quiz': 'open_quiz_editor',
'click .edit-assignment': 'open_assignment_editor',
'click .section-prev': 'section_prev',
'click .section-next': 'section_next',
'click .shift-up--lesson': 'shift_up',
'click .shift-down--lesson': 'shift_down',
}, Detachable.events, Editable.events, Trashable.events ),
/**
* HTML element wrapper ID attribute
* @return string
* @since 3.16.0
* @version 3.16.0
*/
id: function() {
return 'llms-lesson-' + this.model.id;
},
/**
* Wrapper Tag name
* @type {String}
*/
tagName: 'li',
/**
* Get the underscore template
* @type {[type]}
*/
template: wp.template( 'llms-lesson-template' ),
/**
* Initialization callback func (renders the element on screen)
* @return void
* @since 3.14.1
* @version 3.14.1
*/
initialize: function() {
this.render();
this.listenTo( this.model, 'change', this.render );
Backbone.pubSub.on( 'lesson-selected', this.on_select, this );
Backbone.pubSub.on( 'new-lesson-added', this.maybe_open_editor, this );
},
/**
* Compiles the template and renders the view
* @return self (for chaining)
* @since 3.16.0
* @version 3.16.0
*/
render: function() {
this.$el.html( this.template( this.model ) );
this.maybe_hide_shiftable_buttons();
if ( this.model.get( '_selected' ) ) {
this.$el.addClass( 'selected' );
} else {
this.$el.removeClass( 'selected' );
}
return this;
},
/**
* Click event for the assignment editor action icon
* Opens sidebar to the assignment editor tab
* @param obj event JS Event obj.
* @return void
* @since 3.17.0
* @version 3.27.0
*/
open_assignment_editor: function( event ) {
if ( event ) {
event.preventDefault();
}
Backbone.pubSub.trigger( 'lesson-selected', this.model, 'assignment' );
this.model.set( '_selected', true );
this.set_hash( 'assignment' );
},
/**
* Click event for lesson settings action icon
* Opens sidebar to the lesson editor tab
* @param obj event JS Event obj.
* @return void
* @since 3.16.0
* @version 3.27.0
*/
edit_lesson: function( event ) {
if ( event ) {
event.preventDefault();
}
this.open_lesson_editor();
},
open_lesson_editor: function() {
Backbone.pubSub.trigger( 'lesson-selected', this.model, 'lesson' );
this.model.set( '_selected', true );
this.set_hash( false );
},
maybe_open_editor: function( model ) {
if ( this.model.id === model.id ) {
this.open_lesson_editor();
}
},
/**
* Click event for the quiz editor action icon
* Opens sidebar to the quiz editor tab
* @param obj event JS Event obj.
* @return void
* @since 3.16.0
* @version 3.27.0
*/
open_quiz_editor: function( event ) {
if ( event ) {
event.preventDefault();
}
Backbone.pubSub.trigger( 'lesson-selected', this.model, 'quiz' );
this.model.set( '_selected', true );
this.set_hash( 'quiz' );
},
/**
* When a lesson is selected mark it as selected in the hidden prop
* Allows views to re-render and reflect current state properly
* @param obj model lesson model that's been selected
* @return void
* @since 3.16.0
* @version 3.16.0
*/
on_select: function( model ) {
if ( this.model.id !== model.id ) {
this.model.set( '_selected', false );
}
},
/**
* Click event for the "Next Section" button
* @param obj event js event obj
* @return void
* @since 3.16.11
* @version 3.16.11
*/
section_next: function( event ) {
event.preventDefault();
this._move_to_section( 'next' );
},
/**
* Click event for the "Previous Section" button
* @param obj event js event obj
* @return void
* @since 3.16.11
* @version 3.16.11
*/
section_prev: function( event ) {
event.preventDefault();
this._move_to_section( 'prev' );
},
/**
* Adds a hash for deep linking to a specific lesson tab
* @param string subtab subtab [quiz|assignment]
* @return void
* @since 3.27.0
* @version 3.27.0
*/
set_hash: function( subtab ) {
var hash = 'lesson:' + this.model.get( 'id' );
if ( subtab ) {
hash += ':' + subtab;
}
window.location.hash = hash;
},
/**
* Move the lesson into a new section
* @param string direction direction [prev|next]
* @return void
* @since 3.16.11
* @version 3.16.11
*/
_move_to_section: function( direction ) {
var from_coll = this.model.collection,
to_section;
if ( 'next' === direction ) {
to_section = from_coll.parent.get_next();
} else if ( 'prev' === direction ) {
to_section = from_coll.parent.get_prev();
}
if ( to_section ) {
from_coll.remove( this.model );
to_section.add_lesson( this.model );
to_section.set( '_expanded', true );
}
},
}, Detachable, Editable, Shiftable, Trashable ) );
} );
================================================
FILE: assets/js/builder/Views/LessonEditor.js
================================================
/**
* Lesson Editor (Sidebar) View
*
* @package LifterLMS/Scripts/Builder
*
* @since 3.17.0
* @since 3.35.2 Added filter `llms_lesson_rerender_change_events` to view re-render change events.
* @version 3.35.2
*/
define( [
'Views/_Detachable',
'Views/_Editable',
'Views/_Trashable',
'Views/_Subview',
'Views/SettingsFields'
], function(
Detachable,
Editable,
Trashable,
Subview,
SettingsFields
) {
return Backbone.View.extend( _.defaults( {
/**
* Current view state
*
* @type {String}
*/
state: 'default',
/**
* Current Subviews
*
* @type {Object}
*/
views: {
settings: {
class: SettingsFields,
instance: null,
state: 'default',
},
},
el: '#llms-editor-lesson',
/**
* Events
*
* @type {Object}
*/
events: _.defaults( {}, Detachable.events, Editable.events, Trashable.events ),
/**
* Template function
*
* @type {[type]}
*/
template: wp.template( 'llms-lesson-settings-template' ),
/**
* Init
*
* @since 3.17.0
* @since 3.24.0 Unknown
* @since 3.35.2 Added filter to change events.
*
* @param {obj} data Parent template data.
* @return {void}
*/
initialize: function( data ) {
this.model = data.lesson;
var change_events = window.llms.hooks.applyFilters( 'llms_lesson_rerender_change_events', [
'change:date_available',
'change:drip_method',
'change:permalink',
'change:content_added_in_builder',
'change:name',
'change:time_available',
] );
_.each( change_events, function( event ) {
this.listenTo( this.model, event, this.render );
}, this );
// render only the tooltip for points percentage when points change
this.listenTo( this.model, 'change:points', this.render_points_percentage );
// when the "has_prerequisite" attr is toggled ON
// trigger the prereq select object to set the default (first available) prereq for the lesson
this.listenTo( this.model, 'change:has_prerequisite', function( lesson, val ) {
if ( 'yes' === val ) {
this.$el.find( 'select[name="prerequisite"]' ).trigger( 'change' );
}
} );
},
/**
* Render the view
*
* @return obj
* @since 3.17.0
* @version 3.24.0
*/
render: function() {
this.$el.html( this.template( this.model ) );
this.remove_subview( 'settings' );
this.render_subview( 'settings', {
el: '#llms-lesson-settings-fields',
model: this.model,
} );
this.init_datepickers();
this.init_selects();
this.render_points_percentage();
this.$('.llms-editable-title').focus();
return this;
},
/**
* Render the portion of the template which displays the points percentage
*
* @return void
* @since 3.24.0
* @version 3.24.0
*/
render_points_percentage: function() {
this.$el.find( '#llms-model-settings-field--points .llms-editable-input' )
.addClass( 'tip--top-left' )
.attr( 'data-tip', this.model.get_points_percentage() );
}
}, Detachable, Editable, Trashable, Subview, SettingsFields ) );
} );
================================================
FILE: assets/js/builder/Views/LessonList.js
================================================
/**
* Single Section View
*
* @since 3.13.0
* @version 3.16.0
*/
define( [ 'Views/Lesson', 'Views/_Receivable' ], function( LessonView, Receivable ) {
return Backbone.CollectionView.extend( _.defaults( {
className: 'llms-lessons',
/**
* Section model
*
* @type {[type]}
*/
modelView: LessonView,
/**
* Are sections selectable?
*
* @type {Bool}
*/
selectable: false,
/**
* Are sections sortable?
*
* @type {Bool}
*/
sortable: true,
sortableOptions: {
axis: false,
connectWith: '.llms-lessons',
cursor: 'move',
handle: '.drag-lesson',
items: '.llms-lesson',
placeholder: 'llms-lesson llms-sortable-placeholder',
},
sortable_start: function( collection ) {
$( '.llms-lessons' ).addClass( 'dragging' );
},
sortable_stop: function( collection ) {
$( '.llms-lessons' ).removeClass( 'dragging' );
},
/**
* Overloads the function from Backbone.CollectionView core because it doesn't send stop events
* if moving from one sortable to another... :-(
*
* @param obj event js event object
* @param obj ui jQuery UI object
* @return void
* @since 3.16.0
* @version 3.16.0
*/
_sortStop : function( event, ui ) {
var modelBeingSorted = this.collection.get( ui.item.attr( 'data-model-cid' ) ),
modelViewContainerEl = this._getContainerEl(),
newIndex = modelViewContainerEl.children().index( ui.item );
if ( newIndex == -1 && modelBeingSorted ) {
this.collection.remove( modelBeingSorted );
}
this._reorderCollectionBasedOnHTML();
this.updateDependentControls();
if ( this._isBackboneCourierAvailable() ) {
this.spawn( 'sortStop', { modelBeingSorted : modelBeingSorted, newIndex : newIndex } );
} else {
this.trigger( 'sortStop', modelBeingSorted, newIndex );
}
},
}, Receivable ) );
} );
================================================
FILE: assets/js/builder/Views/Popover.js
================================================
/**
* Popover View
*
* @since 3.16.0
* @version 4.0.0
*/
define( [], function() {
return Backbone.View.extend( {
/**
* Default Properties
*
* @type {Object}
*/
defaults: {
placement: 'auto',
// container: document.body,
width: 'auto',
trigger: 'manual',
style: 'light',
animation: 'pop',
title: '',
content: '',
closeable: false,
backdrop: false,
onShow: function( $el ) {},
onHide: function( $el ) {},
},
/**
* Wrapper Tag name
*
* @type {String}
*/
tagName: 'div',
/**
* Initialization callback func (renders the element on screen)
*
* @since 3.14.1
* @since 4.0.0 Add RTL support for popovers.
*
* @return void
*/
initialize: function( data ) {
if ( this.$el.length ) {
this.defaults.container = this.$el.parent();
}
this.args = _.defaults( data.args, this.defaults );
// Reverse directions for RTL sites.
if ( $( 'body' ).hasClass( 'rtl' ) ) {
if ( -1 !== this.args.placement.indexOf( 'left' ) ) {
this.args.placement = this.args.placement.replace( 'left', 'right' );
} else if ( -1 !== this.args.placement.indexOf( 'right' ) ) {
this.args.placement = this.args.placement.replace( 'right', 'left' );
}
}
this.render();
},
/**
* Compiles the template and renders the view
*
* @since 3.16.0
*
* @return {Object} Instance of the Backbone.view.
*/
render: function() {
this.$el.webuiPopover( this.args );
return this;
},
/**
* Hide the popover
*
* @since 3.16.0
* @since 3.16.12 Unknown.
*
* @return {Object} Instance of the Backbone.view.
*/
hide: function() {
this.$el.webuiPopover( 'hide' );
return this;
},
/**
* Show the popover
*
* @since 3.16.0
* @since 3.16.12 Unknown.
*
* @return {Object} Instance of the Backbone.view.
*/
show: function() {
this.$el.webuiPopover( 'show' );
return this;
},
} );
} );
================================================
FILE: assets/js/builder/Views/PostSearch.js
================================================
/**
* Post Popover Search content View
*
* @since 3.16.0
* @version 4.4.0
*/
define( [], function() {
return Backbone.View.extend( {
/**
* DOM Events
*
* @type obj
* @since 3.16.0
* @version 3.16.0
*/
events: {
'select2:select': 'add_post',
},
/**
* Wrapper Tag name
*
* @type {String}
*/
tagName: 'select',
/**
* Initializer
*
* @param obj data customize the search box with data
* @return void
* @since 3.16.12
* @version 3.16.12
*/
initialize: function( data ) {
this.post_type = data.post_type;
this.searching_message = data.searching_message || LLMS.l10n.translate( 'Searching...' );
},
/**
* Select event, adds the existing lesson to the course
*
* @param obj event select2:select event object
* @since 3.16.0
* @version 3.17.0
*/
add_post: function( event ) {
var type = this.$el.attr( 'data-post-type' );
Backbone.pubSub.trigger( type.replace( 'llms_', '' ) + '-search-select', event.params.data, event );
this.$el.val( null ).trigger( 'change' );
},
/**
* Render the section
*
* Initializes a new collection and views for all lessons in the section.
*
* @since 3.16.0
* @since 3.16.12 Unknown.
* @since 4.4.0 Update ajax nonce source.
*
* @return void
*/
render: function() {
var self = this;
setTimeout( function () {
self.$el.llmsSelect2( {
ajax: {
dataType: 'JSON',
delay: 250,
method: 'POST',
url: window.ajaxurl,
data: function( params ) {
return {
action: 'llms_builder',
action_type: 'search',
course_id: window.llms_builder.course.id,
post_type: self.post_type,
term: params.term,
page: params.page,
_ajax_nonce: window.llms.ajax_nonce,
};
},
},
dropdownParent: $( '.wrap.lifterlms.llms-builder' ),
// Don't escape html from render_result.
escapeMarkup: function( markup ) {
return markup;
},
placeholder: self.searching_message,
templateResult: self.render_result,
width: '100%',
} );
self.$el.attr( 'data-post-type', self.post_type );
}, 0 );
return this;
},
/**
* Render a nicer UI for each search result in the in the Select2 search results
*
* @param object res result data
* @return string
* @since 3.16.0
* @version 3.16.12
*/
render_result: function( res ) {
var $html = $( '<div class="llms-existing-lesson-result" />' );
if ( res.loading ) {
return $html.append( res.text );
}
var $side = $( '<aside class="llms-existing-action" />' ),
$main = $( '<div class="llms-existing-info" />' );
icon = ( 'attach' === res.action ) ? 'paperclip' : 'clone',
text = ( 'attach' === res.action ) ? LLMS.l10n.translate( 'Attach' ) : LLMS.l10n.translate( 'Clone' );
$side.append( '<i class="fa fa-' + icon + '" aria-hidden="true"></i><small>' + text + '</small>' );
$main.append( '<h4>' + res.data.title + '</h4>' );
$main.append( '<h5>' + LLMS.l10n.translate( 'ID' ) + ': <em>' + res.data.id + '</em></h5>' );
_.each( res.parents, function( parent ) {
$main.append( '<h5>' + parent + '</em></h5>' );
} );
return $html.append( $side ).append( $main );
},
} );
} );
================================================
FILE: assets/js/builder/Views/Question.js
================================================
/**
* Single Question View.
*
* @since 3.16.0
* @version 7.8.0
*/
define( [
'Views/_Detachable',
'Views/_Editable',
'Views/QuestionChoiceList'
], function(
Detachable,
Editable,
ChoiceListView
) {
return Backbone.View.extend( _.defaults( {
/**
* Generate CSS classes for the question
* @return string
* @since 3.16.0
* @version 3.16.0
*/
className: function() {
return 'llms-question qtype--' + this.model.get( 'question_type' ).get( 'id' );
},
events: _.defaults( {
'click .clone--question': 'clone',
'click .delete--question': 'delete',
'click .expand--question': 'expand',
'click .collapse--question': 'collapse',
'change input[name="question_points"]': 'update_points',
}, Detachable.events, Editable.events ),
/**
* HTML element wrapper ID attribute
* @return string
* @since 3.16.0
* @version 3.16.0
*/
id: function() {
return 'llms-question-' + this.model.id;
},
/**
* Wrapper Tag name
* @type {String}
*/
tagName: 'li',
/**
* Get the underscore template
* @type {[type]}
*/
template: wp.template( 'llms-question-template' ),
/**
* Initialization callback func (renders the element on screen)
* @return void
* @since 3.16.0
* @version 3.16.0
*/
initialize: function() {
var change_events = [
'change:_expanded',
'change:menu_order',
];
_.each( change_events, function( event ) {
this.listenTo( this.model, event, this.render );
}, this );
this.listenTo( this.model.get( 'image' ), 'change', this.render );
this.listenTo( this.model.get_parent(), 'change:_points', this.render_points_percentage );
this.on( 'multi_choices_toggle', this.multi_choices_toggle, this );
Backbone.pubSub.on( 'del-question-choice', this.del_choice, this );
},
/**
* Compiles the template and renders the view.
*
* @since 3.16.0
* @since 7.8.0 Added support for image upload in tinyMCE editor.
*
* @return self (for chaining)
*/
render: function() {
this.$el.html( this.template( this.model ) );
if ( this.model.get( 'question_type').get( 'choices' ) ) {
this.choiceListView = new ChoiceListView( {
el: this.$el.find( '.llms-question-choices' ),
collection: this.model.get( 'choices' ),
} );
this.choiceListView.render();
this.choiceListView.on( 'sortStart', this.choiceListView.sortable_start );
this.choiceListView.on( 'sortStop', this.choiceListView.sortable_stop );
}
if ( 'group' === this.model.get( 'question_type' ).get( 'id' ) ) {
var self = this;
setTimeout( function() {
self.questionListView = self.collectionListView.quiz.get_question_list( {
el: self.$el.find( '.llms-quiz-questions' ),
collection: self.model.get( 'questions' ),
} );
self.questionListView.render();
self.questionListView.on( 'sortStart', self.questionListView.sortable_start );
self.questionListView.on( 'sortStop', self.questionListView.sortable_stop );
}, 1 );
}
if ( this.model.get( 'description_enabled' ) ) {
this.init_editor( 'question-desc--' + this.model.get( 'id' ) );
}
if ( this.model.get( 'clarifications_enabled' ) ) {
this.init_editor( 'question-clarifications--' + this.model.get( 'id' ), {
mediaButtons: true,
tinymce: {
toolbar1: 'bold,italic,strikethrough,bullist,numlist,alignleft,aligncenter,alignright',
toolbar2: '',
setup: _.bind( this.on_editor_ready, this ),
}
} );
}
this.init_formatting_els();
this.init_selects();
return this;
},
/**
* rerender points percentage when question points are updated
* @return void
* @since 3.16.0
* @version 3.16.0
*/
render_points_percentage: function() {
this.$el.find( '.llms-question-points' ).attr( 'data-tip', this.model.get_points_percentage() );
},
/**
* Click event to duplicate a question within a quiz
* @param obj event js event object
* @return void
* @since 3.16.0
* @version 3.16.0
*/
clone: function( event ) {
event.stopPropagation();
event.preventDefault();
this.model.collection.add( this._get_question_clone( this.model ) );
},
/**
* Recursive clone function which will correctly clone children of a question
* @param obj question question model
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
_get_question_clone: function( question ) {
// create a duplicate
var clone = _.clone( question.attributes );
// remove id (we want the duplicate to have a temp id)
delete clone.id;
clone.parent_id = question.get( 'id' );
// set the question type ID
clone.question_type = question.get( 'question_type' ).get( 'id' );
// clone the image attributes separately
clone.image = _.clone( question.get( 'image' ).attributes );
// if it has choices clone all the choices
if ( question.get( 'choices' ) ) {
clone.choices = [];
question.get( 'choices' ).each( function ( choice ) {
var choice_clone = _.clone( choice.attributes );
delete choice_clone.id;
delete choice_clone.question_id;
clone.choices.push( choice_clone );
} );
}
if ( 'group' === question.get( 'question_type' ).get( 'id' ) ) {
clone.questions = [];
question.get( 'questions' ).each( function( child ) {
clone.questions.push( this._get_question_clone( child ) );
}, this );
}
return clone;
},
/**
* Collapse a question and hide it's settings
* @param obj event js event obj.
* @return void
* @since 3.16.0
* @version 3.27.0
*/
collapse: function( event ) {
if ( event ) {
event.preventDefault();
}
this.model.set( '_expanded', false );
},
/**
* Delete the question from a quiz / question group
* @param obj event js event object
* @return void
* @since 3.16.0
* @version 3.16.0
*/
delete: function( event ) {
event.preventDefault();
if ( window.confirm( LLMS.l10n.translate( 'Are you sure you want to delete this question?' ) ) ) {
this.model.collection.remove( this.model );
Backbone.pubSub.trigger( 'model-trashed', this.model );
}
},
/**
* Click event to reveal a question's settings & choices
* @param obj event js event obj.
* @return void
* @since 3.16.0
* @version 3.27.0
*/
expand: function( event ) {
if ( event ) {
event.preventDefault();
}
this.model.set( '_expanded', true );
},
/**
* When toggling multiple correct answers *off* remove all correct choices except the first correct choice in the list
* @param string val value of the question's `multi_choice` attr [yes|no]
* @return void
* @since 3.16.0
* @version 3.16.0
*/
multi_choices_toggle: function( val ) {
if ( 'yes' === val ) {
return;
}
this.model.get( 'choices' ).update_correct( _.first( this.model.get( 'choices' ).get_correct() ) );
},
/**
* Update the model's points when the value of the points input is updated
* @return void
* @since 3.16.0
* @version 3.16.0
*/
update_points: function() {
this.model.set( 'points', this.$el.find( 'input[name="question_points"]' ).val() * 1 );
}
}, Detachable, Editable ) );
} );
================================================
FILE: assets/js/builder/Views/QuestionBank.js
================================================
/**
* Quiz question bank view
*
* @since 3.16.0
* @version 3.16.0
*/
define( [ 'Views/QuestionType' ], function( QuestionView ) {
return Backbone.CollectionView.extend( {
className: 'llms-question',
/**
* Parent element
*
* @type {String}
*/
el: '#llms-question-bank',
/**
* Section model
*
* @type {[type]}
*/
modelView: QuestionView,
/**
* Are sections selectable?
*
* @type {Bool}
*/
selectable: false,
/**
* Are sections sortable?
*
* @type {Bool}
*/
sortable: false,
} );
} );
================================================
FILE: assets/js/builder/Views/QuestionChoice.js
================================================
/**
* Single Question Choice View
* @since 3.16.0
* @version 3.16.0
*/
define( [ 'Views/_Editable', ], function( Editable ) {
return Backbone.View.extend( _.defaults( {
/**
* HTML class names
* @type {String}
*/
className: 'llms-question-choice',
events: _.defaults( {
'change input[name="correct"]': 'toggle_correct',
'click .llms-action-icon[href="#llms-add-choice"]': 'add_choice',
'click .llms-action-icon[href="#llms-del-choice"]': 'del_choice',
}, Editable.events ),
/**
* HTML element wrapper ID attribute
* @return string
* @since 3.16.0
* @version 3.16.0
*/
id: function() {
return 'llms-question-choice-' + this.model.id;
},
/**
* Wrapper Tag name
* @type {String}
*/
tagName: 'li',
/**
* Get the underscore template
* @type {[type]}
*/
template: wp.template( 'llms-question-choice-template' ),
/**
* Initialization callback func (renders the element on screen)
* @return void
* @since 3.14.1
* @version 3.14.1
*/
initialize: function() {
this.render();
this.listenTo( this.model.collection, 'add', this.maybe_disable_buttons );
this.listenTo( this.model, 'change', this.render );
if ( 'image' === this.model.get( 'choice_type' ) ) {
this.listenTo( this.model.get( 'choice' ), 'change', this.render );
}
},
/**
* Compiles the template and renders the view
* @return self (for chaining)
* @since 3.16.0
* @version 3.16.0
*/
render: function() {
this.$el.html( this.template( this.model ) );
return this;
},
/**
* Add a new choice to the current choice list
* Adds *after* the clicked choice
* @param obj event JS event object
* @return void
* @since 3.16.0
* @version 3.16.0
*/
add_choice: function( event ) {
event.stopPropagation();
event.preventDefault();
var index = this.model.collection.indexOf( this.model );
this.model.collection.parent.add_choice( {}, {
at: index + 1,
} );
},
/**
* Delete the choice from the choice list & ensure there's at least one correct choice
* @param obj event js event obj
* @return void
* @since 3.16.0
* @version 3.16.0
*/
del_choice: function( event ) {
event.preventDefault();
Backbone.pubSub.trigger( 'model-trashed', this.model );
this.model.collection.remove( this.model );
},
/**
* When the correct answer input changes sync status to model
* @return void
* @since 3.16.0
* @version 3.16.0
*/
toggle_correct: function() {
var correct = this.$el.find( 'input[name="correct"]' ).is( ':checked' );
this.model.set( 'correct', correct );
this.model.collection.trigger( 'correct-update', this.model );
},
}, Editable ) );
} );
================================================
FILE: assets/js/builder/Views/QuestionChoiceList.js
================================================
/**
* Quiz question bank view
*
* @since 3.16.0
* @version 3.16.0
*/
define( [ 'Views/QuestionChoice' ], function( ChoiceView ) {
return Backbone.CollectionView.extend( {
className: 'llms-quiz-questions',
/**
* Choice model view
*
* @type {[type]}
*/
modelView: ChoiceView,
/**
* Enable keyboard events
*
* @type {Bool}
*/
processKeyEvents: false,
/**
* Are sections selectable?
*
* @type {Bool}
*/
selectable: false,
/**
* Are sections sortable?
*
* @type {Bool}
*/
sortable: true,
sortableOptions: {
axis: false,
// connectWith: '.llms-lessons',
cursor: 'move',
handle: '.llms-choice-id',
items: '.llms-question-choice',
placeholder: 'llms-question-choice llms-sortable-placeholder',
},
sortable_start: function( model ) {
this.$el.addClass( 'dragging' );
},
sortable_stop: function( model ) {
this.$el.removeClass( 'dragging' );
},
} );
} );
================================================
FILE: assets/js/builder/Views/QuestionList.js
================================================
/**
* Quiz question bank view
* @since 3.16.0
* @version 3.16.0
*/
define( [ 'Views/Question' ], function( QuestionView ) {
return Backbone.CollectionView.extend( {
className: 'llms-quiz-questions',
/**
* Parent element
* @type {String}
*/
// el: '#llms-quiz-questions',
/**
* Section model
* @type {[type]}
*/
modelView: QuestionView,
/**
* Enable keyboard events
* @type {Bool}
*/
processKeyEvents: false,
/**
* Are sections selectable?
* @type {Bool}
*/
selectable: false,
/**
* Are sections sortable?
* @type {Bool}
*/
sortable: true,
sortableOptions: {
axis: false,
connectWith: '.llms-quiz-questions',
cursor: 'move',
handle: '.llms-data-stamp',
items: '.llms-question',
placeholder: 'llms-question llms-sortable-placeholder',
},
/**
* Highlight drop areas when dragging starts
* @param obj model model being sorted
* @return void
* @since 3.16.0
* @version 3.16.0
*/
sortable_start: function( model ) {
var selector = 'group' === model.get( 'question_type' ).get( 'id' ) ? '.llms-editor-tab > .llms-quiz-questions' : '.llms-quiz-questions';
$( selector ).addClass( 'dragging' );
},
/**
* Remove highlights when dragging stops
* @param obj model model being sorted
* @return void
* @since 3.16.0
* @version 3.16.0
*/
sortable_stop: function() {
$( '.llms-quiz-questions' ).removeClass( 'dragging' );
},
/**
* Overrides receive to ensure that question groups can't be moved into question groups
* @param obj event js event object
* @param obj ui jQuery UI Sortable ui object
* @return void
* @since 3.16.0
* @version 3.16.0
*/
_receive : function( event, ui ) {
event.stopPropagation();
// prevent moving a question group into a question group
if ( ui.item.hasClass( 'qtype--group' ) && $( event.target ).closest( '.qtype--group' ).length ) {;
ui.sender.sortable( 'cancel' );
return;
}
var senderListEl = ui.sender;
var senderCollectionListView = senderListEl.data( "view" );
if( ! senderCollectionListView || ! senderCollectionListView.collection ) return;
var newIndex = this._getContainerEl().children().index( ui.item );
var modelReceived = senderCollectionListView.collection.get( ui.item.attr( "data-model-cid" ) );
senderCollectionListView.collection.remove( modelReceived );
this.collection.add( modelReceived, { at : newIndex } );
modelReceived.collection = this.collection; // otherwise will not get properly set, since modelReceived.collection might already have a value.
this.setSelectedModel( modelReceived );
},
/**
* Override to allow manipulation of placeholder element
* @param {[type]} event [description]
* @param {[type]} ui [description]
* @return {[type]}
* @since 3.16.0
* @version 3.16.0
*/
_sortStart : function( event, ui ) {
var modelBeingSorted = this.collection.get( ui.item.attr( "data-model-cid" ) );
ui.placeholder.addClass( 'qtype--' + modelBeingSorted.get( 'question_type' ).get( 'id' ) );
if( this._isBackboneCourierAvailable() )
this.spawn( "sortStart", { modelBeingSorted : modelBeingSorted } );
else this.trigger( "sortStart", modelBeingSorted );
},
/**
* Overloads the function from Backbone.CollectionView core because it doesn't send stop events
* if moving from one sortable to another... :-(
* @param obj event js event object
* @param obj ui jQuery UI object
* @return void
* @since 3.16.0
* @version 3.16.0
*/
_sortStop : function( event, ui ) {
event.stopPropagation();
var modelBeingSorted = this.collection.get( ui.item.attr( 'data-model-cid' ) ),
modelViewContainerEl = this._getContainerEl(),
newIndex = modelViewContainerEl.children().index( ui.item );
if ( newIndex == -1 && modelBeingSorted ) {
this.collection.remove( modelBeingSorted );
}
this._reorderCollectionBasedOnHTML();
this.updateDependentControls();
if( this._isBackboneCourierAvailable() ) {
this.spawn( 'sortStop', { modelBeingSorted : modelBeingSorted, newIndex : newIndex } );
} else {
this.trigger( 'sortStop', modelBeingSorted, newIndex );
}
},
} );
} );
================================================
FILE: assets/js/builder/Views/QuestionType.js
================================================
/**
* Question Type View
*
* @since 3.16.0
* @since 3.30.1 Fixed issue causing multiple binds for add_existing_question events.
* @version 5.4.0
*/
define( [ 'Views/Popover', 'Views/PostSearch' ], function( Popover, QuestionSearch ) {
return Backbone.View.extend( {
/**
* HTML class names.
*
* @type {String}
*/
className: 'llms-question-type',
events: {
'click .llms-add-question': 'add_question',
},
/**
* HTML element wrapper ID attribute.
*
* @since 3.16.0
*
* @return {String}
*/
id: function() {
return 'llms-question-type-' + this.model.id;
},
/**
* Wrapper Tag name.
*
* @type {String}
*/
tagName: 'li',
/**
* Get the underscore template.
*
* @type {[type]}
*/
template: wp.template( 'llms-question-type-template' ),
/**
* Initialization callback func (renders the element on screen).
*
* @since 3.16.0
*
* @return {Void}
*/
initialize: function() {
this.render();
},
/**
* Compiles the template and renders the view.
*
* @since 3.16.0
*
* @return {Self} For chaining.
*/
render: function() {
this.$el.html( this.template( this.model ) );
return this;
},
/**
* Add a question of the selected type to the current quiz.
*
* @since 3.16.0
* @since 3.27.0 Unknown.
*
* @return {Void}
*/
add_question: function() {
if ( 'existing' === this.model.get( 'id' ) ) {
this.add_existing_question_click();
} else {
this.add_new_question();
}
},
/**
* Add a new question to the quiz.
*
* @since 3.27.0
* @since 3.30.1 Fixed issue causing multiple binds.
*
* @return {Void}
*/
add_existing_question_click: function() {
var pop = new Popover( {
el: '#llms-add-question--existing',
args: {
backdrop: true,
closeable: true,
container: '#llms-builder-sidebar',
dismissible: true,
placement: 'top-left',
width: 'calc( 100% - 40px )',
offsetLeft: 250,
offsetTop: 60,
title: LLMS.l10n.translate( 'Add Existing Question' ),
content: new QuestionSearch( {
post_type: 'llms_question',
searching_message: LLMS.l10n.translate( 'Search for existing questions...' ),
} ).render().$el,
}
} );
pop.show();
Backbone.pubSub.on( 'question-search-select', this.add_existing_question, this );
Backbone.pubSub.on( 'question-search-select', function( event ) {
pop.hide();
Backbone.pubSub.off( 'question-search-select', this.add_existing_question, this );
}, this );
},
/**
* Callback event fired when a question is selected from the Add Existing Question popover interface.
*
* @since 3.27.0
* @since 5.4.0 Use author id instead of the question author object.
*
* @param {Object} event JS event object.
* @return {Void}
*/
add_existing_question: function( event ) {
var question = event.data;
if ( 'clone' === event.action ) {
question = _.prepareQuestionObjectForCloning( question );
} else {
// Use author id instead of the question author object.
question = _.prepareExistingPostObjectDataForAddingOrCloning( question );
question._forceSync = true;
}
question._expanded = true;
this.quiz.add_question( question );
this.quiz.trigger( 'new-question-added' );
},
/**
* Add a new question to the quiz.
*
* @since 3.27.0
*
* @return {Void}
*/
add_new_question: function() {
this.quiz.add_question( {
_expanded: true,
choices: this.model.get( 'default_choices' ) ? this.model.get( 'default_choices' ) : null,
question_type: this.model,
} );
this.quiz.trigger( 'new-question-added' );
},
// filter: function( term ) {
// var words = this.model.get_keywords().map( function( word ) {
// return word.toLowerCase();
// } );
// term = term.toLowerCase();
// if ( -1 === words.indexOf( term ) ) {
// this.$el.addClass( 'filtered' );
// } else {
// this.$el.removeClass( 'filtered' );
// }
// },
// clear_filter: function() {
// this.$el.removeClass( 'filtered' );
// }
} );
} );
================================================
FILE: assets/js/builder/Views/Quiz.js
================================================
/**
* Single Quiz View.
*
* @since 3.16.0
* @version 5.4.0
*/
define( [
'Models/Quiz',
'Views/Popover',
'Views/PostSearch',
'Views/QuestionBank',
'Views/QuestionList',
'Views/SettingsFields',
'Views/_Detachable',
'Views/_Editable',
'Views/_Subview',
'Views/_Trashable'
], function(
QuizModel,
Popover,
PostSearch,
QuestionBank,
QuestionList,
SettingsFields,
Detachable,
Editable,
Subview,
Trashable
) {
return Backbone.View.extend( _.defaults( {
/**
* Current view state.
*
* @type {String}
*/
state: 'default',
/**
* Current Subviews.
*
* @type {Object}
*/
views: {
settings: {
class: SettingsFields,
instance: null,
state: 'default',
},
bank: {
class: QuestionBank,
instance: null,
state: 'default',
},
list: {
class: QuestionList,
instance: null,
state: 'default',
},
},
el: '#llms-editor-quiz',
/**
* Events.
*
* @type {Object}
*/
events: _.defaults( {
'click #llms-existing-quiz': 'add_existing_quiz_click',
'click #llms-new-quiz': 'add_new_quiz',
'click #llms-show-question-bank': 'show_tools',
'click .bulk-toggle': 'bulk_toggle',
// 'keyup #llms-question-bank-filter': 'filter_question_types',
// 'search #llms-question-bank-filter': 'filter_question_types',
}, Detachable.events, Editable.events, Trashable.events ),
/**
* Wrapper Tag name.
*
* @type {String}
*/
tagName: 'div',
/**
* Get the underscore template
*
* @type {[type]}
*/
template: wp.template( 'llms-quiz-template' ),
/**
* Initialization callback func (renders the element on screen).
*
* @since 3.16.0
* @since 3.19.2 Unknown.
*
* @return {Void}
*/
initialize: function( data ) {
this.lesson = data.lesson;
// Initialize the model if the quiz is enabled or it's disabled but we still have data for a quiz.
if ( 'yes' === this.lesson.get( 'quiz_enabled' ) || ! _.isEmpty( this.lesson.get( 'quiz' ) ) ) {
this.model = this.lesson.get( 'quiz' );
/**
* @todo this is a terrible terrible patch
* I've spent nearly 3 days trying to figure out how to not use this line of code
* ISSUE REPRODUCTION:
* Open course builder
* Open a lesson (A) and add a quiz
* Switch to a new lesson (B)
* Add a new quiz
* Return to lesson A and the quizzes parent will be set to LESSON B
* This will happen for *every* quiz in the builder...
* Adding this set_parent on init guarantees that the quizzes correct parent is set
* after adding new quizzes to other lessons
* it's awful and it's gross...
* I'm confused and tired and going to miss release dates again because of it
*/
this.model.set_parent( this.lesson );
this.listenTo( this.model, 'change:_points', this.render_points );
this.listenTo( this.model, 'change:permalink', this.render_settings );
this.listenTo( this.model, 'change:name', this.render_settings );
}
this.on( 'model-trashed', this.on_trashed );
},
/**
* Compiles the template and renders the view.
*
* @since 3.16.0
* @since 3.19.2 Unknown.
*
* @return {Self} For chaining.
*/
render: function() {
this.$el.html( this.template( this.model ) );
// Render the quiz builder.
if ( this.model ) {
// Don't allow interaction until questions are lazy loaded.
LLMS.Spinner.start( this.$el );
this.render_subview( 'settings', {
el: '#llms-quiz-settings-fields',
model: this.model,
} );
this.init_datepickers();
this.init_selects();
this.render_subview( 'bank', {
collection: window.llms_builder.questions,
} );
var last_group = null,
group = null;
// Let all the question types reference the quiz for adding questions quickly.
this.get_subview( 'bank' ).instance.viewManager.each( function( view ) {
view.quiz = this.model;
group = view.model.get( 'group' ).name;
if ( last_group !== group ) {
last_group = group;
view.$el.before( '<li class="llms-question-bank-header"><h4>' + group + '</h4></li>' );
}
}, this );
this.model.load_questions( _.bind( function( err ) {
if ( err ) {
alert( LLMS.l10n.translate( 'An error occurred while trying to load the questions. Please refresh the page and try again.' ) );
return this;
}
LLMS.Spinner.stop( this.$el );
this.render_subview( 'list', {
el: '#llms-quiz-questions',
collection: this.model.get( 'questions' ),
} );
var list = this.get_subview( 'list' ).instance;
list.quiz = this;
list.collection.on( 'add', function() {
list.collection.trigger( 'reorder' );
}, this );
list.on( 'sortStart', list.sortable_start );
list.on( 'sortStop', list.sortable_stop );
}, this ) );
this.model.on( 'new-question-added', function() {
var $questions = this.$el.find( '#llms-quiz-questions' );
$questions.animate( { scrollTop: $questions.prop( 'scrollHeight' ) }, 200 );
}, this );
}
return this;
},
/**
* On quiz points update, update the value of the Total Points area in the header.
*
* @since 3.17.6
*
* @param {Object} quiz Instance of the quiz model.
* @param {Int} points Updated number of points.
* @return {Void}
*/
render_points: function( quiz, points ) {
this.$el.find( '#llms-quiz-total-points' ).text( points );
},
/**
* Re-render the settings subview.
*
* Used when the permalink is updated after saving so the settings
* panel reflects the new permalink without a full re-render.
*
* @since 10.0.0
*
* @return {Void}
*/
render_settings: function() {
var view = this.get_subview( 'settings' );
if ( view && view.instance ) {
view.instance.render();
this.init_datepickers();
this.init_selects();
}
},
/**
* Bulk expand / collapse question buttons.
*
* @since 3.16.0
*
* @param {Object} Event JS event object.
* @return {Void}
*/
bulk_toggle: function( event ) {
var expanded = ( 'expand' === $( event.target ).attr( 'data-action' ) );
this.model.get( 'questions' ).each( function( question ) {
question.set( '_expanded', expanded );
} );
},
/**
* Adds a new quiz to a lesson which currently has no quiz associated with it.
*
* @since 3.16.0
*
* @return {Void}
*/
add_new_quiz: function() {
var quiz = this.lesson.get( 'quiz' );
if ( _.isEmpty( quiz ) ) {
quiz = this.lesson.add_quiz();
} else {
this.lesson.set( 'quiz_enabled', 'yes' );
}
this.model = quiz;
this.listenTo( this.model, 'change:_points', this.render_points );
this.listenTo( this.model, 'change:permalink', this.render_settings );
this.listenTo( this.model, 'change:name', this.render_settings );
this.render();
},
/**
* Add an existing quiz to a lesson.
*
* @since 3.16.0
* @since 3.24.0 Unknown.
* @since 5.4.0 Use author id instead of the quiz author object.
*
* @param {Object} event JS event object.
* @return {Void}
*/
add_existing_quiz: function( event ) {
this.post_search_popover.hide();
var quiz = event.data;
if ( 'clone' === event.action ) {
quiz = _.prepareQuizObjectForCloning( quiz );
} else {
// Use author id instead of the quiz author object.
quiz = _.prepareExistingPostObjectDataForAddingOrCloning( quiz );
quiz._forceSync = true;
}
delete quiz.lesson_id;
this.lesson.add_quiz( quiz );
this.model = this.lesson.get( 'quiz' );
this.listenTo( this.model, 'change:_points', this.render_points );
this.listenTo( this.model, 'change:permalink', this.render_settings );
this.listenTo( this.model, 'change:name', this.render_settings );
this.render();
},
/**
* Open add existing quiz popover.
*
* @since 3.16.12
*
* @param {Object} event JS event object.
* @return {Void}
*/
add_existing_quiz_click: function( event ) {
event.preventDefault();
this.post_search_popover = new Popover( {
el: '#llms-existing-quiz',
args: {
backdrop: true,
closeable: true,
container: '.wrap.lifterlms.llms-builder',
dismissible: true,
placement: 'left',
width: 480,
title: LLMS.l10n.translate( 'Add Existing Quiz' ),
content: new PostSearch( {
post_type: 'llms_quiz',
searching_message: LLMS.l10n.translate( 'Search for existing quizzes...' ),
} ).render().$el,
onHide: function() {
Backbone.pubSub.off( 'quiz-search-select' );
},
}
} );
this.post_search_popover.show();
Backbone.pubSub.once( 'quiz-search-select', this.add_existing_quiz, this );
},
// filter_question_types: _.debounce( function( event ) {
// var term = $( event.target ).val();
// this.QuestionBankView.viewManager.each( function( view ) {
// if ( ! term ) {
// view.clear_filter();
// } else {
// view.filter( term );
// }
// } );
// }, 300 ),
/**
* Callback function when the quiz has been deleted.
*
* @since 3.16.6
*
* @param {Oject} quiz Quiz Model.
* @return {Void}
*/
on_trashed: function( quiz ) {
this.lesson.set( 'quiz_enabled', 'no' );
this.lesson.set( 'quiz', '' );
delete this.model;
this.render();
},
/**
* "Add Question" button click event.
*
* @since 3.16.0
*
* Creates a popover with question type list interface.
*
* @return {Void}
*/
show_tools: function() {
// Create popover,
var pop = new Popover( {
el: '#llms-show-question-bank',
args: {
backdrop: true,
closeable: true,
container: '#llms-builder-sidebar',
dismissible: true,
placement: 'top-left',
width: 'calc( 100% - 40px )',
title: LLMS.l10n.translate( 'Add a Question' ),
url: '#llms-quiz-tools',
}
} );
// Show it.
pop.show();
// If a question is added, hide the popover.
this.model.on( 'new-question-added', function() {
pop.hide();
} );
},
get_question_list: function( options ) {
return new QuestionList( options );
}
}, Detachable, Editable, Subview, Trashable, SettingsFields ) );
} );
================================================
FILE: assets/js/builder/Views/Section.js
================================================
/**
* Single Section View
* @since 3.13.0
* @version 3.16.12
*/
define( [
'Views/LessonList',
'Views/_Editable',
'Views/_Shiftable',
'Views/_Trashable'
], function(
LessonListView,
Editable,
Shiftable,
Trashable
) {
return Backbone.View.extend( _.defaults( {
/**
* Get default attributes for the html wrapper element
* @return obj
* @since 3.13.0
* @version 3.13.0
*/
attributes: function() {
return {
'data-id': this.model.id,
};
},
/**
* Element class names
* @type {String}
*/
className: 'llms-builder-item llms-section',
/**
* Events
* @type {Object}
* @since 3.16.0
* @version 3.16.12
*/
events: _.defaults( {
'click .expand': 'expand',
'click .collapse': 'collapse',
'click .shift-up--section': 'shift_up',
'click .shift-down--section': 'shift_down',
'click .new-lesson': 'add_new_lesson',
'click .llms-builder-header': 'toggle',
'mouseenter .llms-lessons': 'on_mouseenter',
}, Editable.events, Trashable.events ),
/**
* HTML element wrapper ID attribute
* @return string
* @since 3.13.0
* @version 3.13.0
*/
id: function() {
return 'llms-section-' + this.model.id;
},
/**
* Wrapper Tag name
* @type {String}
*/
tagName: 'li',
/**
* Get the underscore template
* @type {[type]}
*/
template: wp.template( 'llms-section-template' ),
/**
* Initialization callback func (renders the element on screen)
* @return void
* @since 3.13.0
* @version 3.16.0
*/
initialize: function() {
this.render();
this.listenTo( this.model, 'change', this.render );
this.listenTo( this.model, 'change:_expanded', this.toggle_expanded );
this.lessonListView.collection.on( 'add', this.on_lesson_add, this );
this.dragTimeout = null;
Backbone.pubSub.on( 'expand-all', this.expand, this );
Backbone.pubSub.on( 'collapse-all', this.collapse, this );
},
/**
* Render the section
* Initializes a new collection and views for all lessons in the section
* @return void
* @since 3.13.0
* @version 3.16.0
*/
render: function() {
this.$el.html( this.template( this.model.toJSON() ) );
this.maybe_hide_shiftable_buttons();
this.lessonListView = new LessonListView( {
el: this.$el.find( '.llms-lessons' ),
collection: this.model.get( 'lessons' ),
} );
this.lessonListView.render();
this.lessonListView.on( 'sortStart', this.lessonListView.sortable_start );
this.lessonListView.on( 'sortStop', this.lessonListView.sortable_stop );
// selection changes
this.lessonListView.on( 'selectionChanged', this.active_lesson_change, this );
this.maybe_hide_trash_button();
return this;
},
add_new_lesson: function( event ) {
event.preventDefault();
Backbone.pubSub.trigger( 'section-select', this.model );
Backbone.pubSub.trigger( 'add-new-lesson' );
},
active_lesson_change: function( current, previous ) {
Backbone.pubSub.trigger( 'active-lesson-change', {
current: current,
previous: previous,
} );
},
toggle: function( event, update ) {
// We only want to expand/collapse when the actual header div is clicked, not an element inside it.
if ( 'llms-builder-header' !== event.target.className ) {
return;
}
if ( this.model.get( '_expanded' ) ) {
this.collapse( event, update );
} else {
this.expand( event, update );
}
},
/**
* Collapse lessons within the section
* @param obj event js event object
* @param bool update if true, updates the model to reflect the new state
* @return void
* @since 3.16.0
* @version 3.16.0
*/
collapse: function( event, update ) {
if ( 'undefined' === typeof update ) {
update = true;
}
if ( event ) {
event.stopPropagation();
event.preventDefault();
}
this.$el.removeClass( 'expanded' ).find( '.drag-expanded' ).removeClass( 'drag-expanded' );
if ( update ) {
this.model.set( '_expanded', false );
}
Backbone.pubSub.trigger( 'section-toggle', this.model );
},
/**
* Expand lessons within the section
* @param obj event js event object
* @param bool update if true, updates the model to reflect the new state
* @return void
* @since 3.16.0
* @version 3.16.0
*/
expand: function( event, update ) {
if ( 'undefined' === typeof update ) {
update = true;
}
if ( event ) {
event.stopPropagation();
event.preventDefault();
}
this.$el.addClass( 'expanded' );
if ( update ) {
this.model.set( '_expanded', true );
}
Backbone.pubSub.trigger( 'section-toggle', this.model );
},
maybe_hide_trash_button: function() {
var $btn = this.$el.find( '.trash--section' );
if ( this.model.get( 'lessons' ).isEmpty() ) {
$btn.show();
} else {
$btn.hide()
}
},
/**
* When a lesson is added to the section trigger a collection reorder & update the lesson's id
* @param obj model Lesson model
* @return void
* @since 3.16.0
* @version 3.16.0
*/
on_lesson_add: function( model ) {
this.lessonListView.collection.trigger( 'reorder' );
model.set( 'parent_section', this.model.get( 'id' ) );
this.expand();
},
on_mouseenter: function( event ) {
if ( $( event.target ).hasClass( 'dragging' ) ) {
$( '.drag-expanded' ).removeClass( 'drag-expanded' );
$( event.target ).addClass( 'drag-expanded' );
}
},
/**
* Expand
* @param {[type]} model [description]
* @param {[type]} value [description]
* @return {[type]}
* @since 3.16.0
* @version 3.16.0
*/
toggle_expanded: function( model, value ) {
if ( value ) {
this.expand( null, false );
} else {
this.collapse( null, false );
}
},
}, Editable, Shiftable, Trashable ) );
} );
================================================
FILE: assets/js/builder/Views/SectionList.js
================================================
/**
* Single Section View
*
* @since 3.13.0
* @version 3.16.0
*/
define( [ 'Views/Section', 'Views/_Receivable' ], function( SectionView, Receivable ) {
return Backbone.CollectionView.extend( _.defaults( {
/**
* Parent element
*
* @type {String}
*/
el: '#llms-sections',
events : {
'mousedown > li.llms-section' : '_listItem_onMousedown',
// 'dblclick > li, tbody > tr > td' : '_listItem_onDoubleClick',
'click' : '_listBackground_onClick',
'click ul.collection-view' : '_listBackground_onClick',
'keydown' : '_onKeydown'
},
/**
* Section model
*
* @type {[type]}
*/
modelView: SectionView,
/**
* Enable keyboard events
*
* @type {Bool}
*/
processKeyEvents: false,
/**
* Are sections selectable?
*
* @type {Bool}
*/
selectable: true,
/**
* Are sections sortable?
*
* @type {Bool}
*/
sortable: true,
sortableOptions: {
axis: false,
cursor: 'move',
handle: '.drag-section',
items: '.llms-section',
placeholder: 'llms-section llms-sortable-placeholder',
},
sortable_start: function( collection ) {
this.$el.addClass( 'dragging' );
},
sortable_stop: function( collection ) {
this.$el.removeClass( 'dragging' );
},
}, Receivable ) );
} );
================================================
FILE: assets/js/builder/Views/SettingsFields.js
================================================
/**
* Model settings fields view
*
* @since 3.17.0
* @version 4.7.0
*/
define( [], function() {
return Backbone.View.extend( _.defaults( {
/**
* DOM events
*
* @type {Object}
*/
events: {
'click .llms-settings-group-toggle': 'toggle_group',
},
/**
* Processed fields data
* Allows access by ID without traversing the schema
*
* @type {Object}
*/
fields: {},
/**
* Wrapper Tag name
*
* @type {String}
*/
tagName: 'div',
/**
* Get the underscore template
*
* @type {[type]}
*/
template: wp.template( 'llms-settings-fields-template' ),
/**
* Initialization callback func (renders the element on screen)
*
* @return void
* @since 3.17.0
* @version 3.17.0
*/
// initialize: function() {},
/**
* Retrieve an array of all editor fields in all groups
*
* @return array
* @since 3.17.1
* @version 3.17.1
*/
get_editor_fields: function() {
return _.filter( this.fields, function( field ) {
return this.is_editor_field( field.type );
}, this );
},
/**
* Get settings group data from a model
*
* @return {[type]}
* @since 3.17.0
* @version 3.17.0
*/
get_groups: function() {
return this.model.get_settings_fields();
},
/**
* Determine if a settings group is hidden in localStorage
*
* @param string group_id id of the group
* @return {Boolean}
* @since 3.17.0
* @version 3.17.0
*/
is_group_hidden: function( group_id ) {
var id = 'llms-' + this.model.get( 'type' ) + '-settings-group--' + group_id;
if ( 'undefined' !== window.localStorage ) {
return ( 'hidden' === window.localStorage.getItem( id ) );
}
return false;
},
/**
* Get the switch attribute for a field with switches
*
* @param obj field field data obj
* @return string
* @since 3.17.0
* @version 3.17.0
*/
get_switch_attribute: function( field ) {
return field.switch_attribute ? field.switch_attribute : field.attribute;
},
/**
* Determine if a field has a switch
*
* @param string type field type string
* @return {Boolean}
* @since 3.17.0
* @version 3.17.0
*/
has_switch: function( type ) {
return ( -1 !== type.indexOf( 'switch' ) );
},
/**
* Determine if a field is a default (text) field
*
* @param string type field type string
* @return {Boolean}
* @since 3.17.0
* @version 3.17.0
*/
is_default_field: function( type ) {
var types = [ 'audio_embed', 'datepicker', 'number', 'text', 'video_embed' ];
return ( -1 !== types.indexOf( type.replace( 'switch-', '' ) ) );
},
/**
* Determine if a field is a WYSIWYG editor field
*
* @param string type field type string
* @return {Boolean}
* @since 3.17.1
* @version 3.17.1
*/
is_editor_field: function( type ) {
var types = [ 'editor', 'switch-editor' ];
return ( -1 !== types.indexOf( type.replace( 'switch-', '' ) ) );
},
/**
* Determine if a switch is enabled for a field
*
* @param obj field field data object
* @return {Boolean}
* @since 3.17.0
* @version 3.17.6
*/
is_switch_condition_met: function( field ) {
return ( field.switch_on === this.model.get( field.switch_attribute ) );
},
/**
* Compiles the template and renders the view
*
* @return self (for chaining)
* @since 3.17.0
* @version 3.17.1
*/
render: function() {
this.$el.html( this.template( this ) );
// if editors exist, render them
_.each( this.get_editor_fields(), function( field ) {
this.render_editor( field );
}, this );
return this;
},
/**
* Renders an editor field
*
* @since 3.17.1
* @since 3.37.11 Replace references to `wp.editor` with `_.getEditor()` helper.
*
* @param {Object} field Field data object.
* @return {Void}
*/
render_editor: function( field ) {
var self = this,
wpEditor = _.getEditor();
// Exit early if there's no editor to work with.
if ( undefined === wpEditor ) {
console.error( 'Unable to access `wp.oldEditor` or `wp.editor`.' );
return;
}
wpEditor.remove( field.id );
field.settings.tinymce.setup = function( editor ) {
var $ed = $( '#' + editor.id ),
$parent = $ed.closest( '.llms-editable-editor' ),
$label = $parent.find( '.llms-label' ),
prop = $ed.attr( 'data-attribute' )
if ( $label.length ) {
$label.prependTo( $parent.find( '.wp-editor-tools' ) );
}
// save changes to the model via Visual ed
editor.on( 'change', function( event ) {
self.model.set( prop, wpEditor.getContent( editor.id ) );
} );
// save changes via Text ed
$ed.on( 'input', function( event ) {
self.model.set( prop, $ed.val() );
} );
// trigger an input on the Text ed when quicktags buttons are clicked
$parent.on( 'click', '.quicktags-toolbar .ed_button', function() {
setTimeout( function() {
$ed.trigger( 'input' );
}, 10 );
} );
};
wpEditor.initialize( field.id, field.settings );
},
/**
* Get the HTML for a select field
*
* @param obj options flat or multi-dimensional options object
* @param string attribute name of the select field's attribute
* @return string
* @since 3.17.0
* @version 3.17.2
*/
render_select_options: function( options, attribute ) {
var html = '',
selected = this.model.get( attribute );
function option_html( label, val ) {
return '<option value="' + val + '"' + _.selected( val, selected ) + '>' + label.substring( 0, 100 ) + ( label.length > 100 ? '...' : '' ) + '</option>';
}
_.each( options, function( option, index ) {
// this will be an key:val object
if ( 'string' === typeof option ) {
html += option_html( option, index );
// either option group or array of key,val objects
} else if ( 'object' === typeof option ) {
// option group
if ( option.label && option.options ) {
html += '<optgroup label="' + option.label + '">';
html += this.render_select_options( option.options, attribute );
} else {
html += option_html( option.val, option.key );
}
}
}, this );
return html;
},
/**
* Setup and fill fields with default data based on field type
*
* @since 3.17.0
* @since 3.24.0 Unknown.
* @since 3.37.11 Replace reference to `wp.editor` with `_.getEditor()` helper.
* @since 4.7.0 Ensure `switch-number` fields are set with the `number` type attribute.
*
* @param {Object} orig_field Original field as defined in the settings.
* @param {Integer} field_index Index of the field in the current row.
* @return {Object}
*/
setup_field: function( orig_field, field_index ) {
var defaults = {
classes: [],
id: _.uniqueId( orig_field.attribute + '_' ),
input_type: 'text',
label: '',
options: {},
placeholder: '',
tip: '',
tip_position: 'top-right',
settings: {},
};
// check the field condition if set
if ( orig_field.condition && false === _.bind( orig_field.condition, this.model )() ) {
return false;
}
switch ( orig_field.type ) {
case 'audio_embed':
defaults.classes.push( 'llms-editable-audio' );
defaults.placeholder = 'https://';
defaults.tip = LLMS.l10n.translate( 'Use SoundCloud or Spotify audio URLS.' );
defaults.input_type = 'url';
break;
case 'datepicker':
defaults.classes.push( 'llms-editable-date' );
break;
case 'editor':
case 'switch-editor':
var orig_settings = orig_field.settings || {};
defaults.settings = $.extend( true, _.getEditor().getDefaultSettings(), {
mediaButtons: true,
tinymce: {
toolbar1: 'bold,italic,strikethrough,bullist,numlist,blockquote,hr,alignleft,aligncenter,alignright,link,unlink,wp_adv',
toolbar2: 'formatselect,underline,alignjustify,forecolor,pastetext,removeformat,charmap,outdent,indent,undo,redo,wp_help',
}
}, orig_settings );
break;
case 'number':
case 'switch-number':
defaults.input_type = 'number';
break;
case 'permalink':
defaults.label = LLMS.l10n.translate( 'Permalink' );
break;
case 'video_embed':
defaults.classes.push( 'llms-editable-video' );
defaults.placeholder = 'https://';
defaults.tip = LLMS.l10n.translate( 'Use YouTube, Vimeo, or Wistia video URLS.' );
defaults.input_type = 'url';
break;
}
if ( this.has_switch( orig_field.type ) ) {
defaults.switch_on = 'yes';
defaults.switch_off = 'no';
}
var field = _.defaults( _.deepClone( orig_field ), defaults );
// if options is a function run it
if ( _.isFunction( field.options ) ) {
field.options = _.bind( field.options, this.model )();
}
// if it's a radio field options values can be submitted as images
// this will transform those images into <img> html
if ( -1 !== [ 'radio', 'switch-radio' ].indexOf( orig_field.type ) ) {
var has_images = false;
_.each( orig_field.options, function( val, key ) {
if ( -1 !== val.indexOf( '.png' ) || -1 !== val.indexOf( '.jpg' ) ) {
field.options[key] = '<span><img src="' + val + '"></span>';
has_images = true;
}
} );
if ( has_images ) {
field.classes.push( 'has-images' );
}
}
// transform classes array to a css class string
if ( field.classes.length ) {
field.classes = ' ' + field.classes.join( ' ' );
}
this.fields[ field.id ] = field;
return field;
},
/**
* Determine if toggling a switch select should rerender the view
*
* @param string field_type field type string
* @return boolean
* @since 3.17.0
* @version 3.17.0
*/
should_rerender_on_toggle: function( field_type ) {
return ( -1 !== field_type.indexOf( 'switch-' ) ) ? 'yes' : 'no';
},
/**
* Click event for toggling visibility of settings groups
* If localStorage is available, persist state
*
* @param obj event js event object
* @return void
* @since 3.17.0
* @version 3.17.0
*/
toggle_group: function( event ) {
event.preventDefault();
var $el = $( event.currentTarget ),
$group = $el.closest( '.llms-model-settings' );
$group.toggleClass( 'hidden' );
if ( 'undefined' !== window.localStorage ) {
var id = $group.attr( 'id' );
if ( $group.hasClass( 'hidden' ) ) {
window.localStorage.setItem( id, 'hidden' );
} else {
window.localStorage.removeItem( id );
}
}
},
} ) );
} );
================================================
FILE: assets/js/builder/Views/Sidebar.js
================================================
/**
* Main sidebar view
*
* @since 3.16.0
* @version 7.2.0
*/
define( [
'Views/Editor',
'Views/Elements',
'Views/Utilities',
'Views/_Subview'
], function(
Editor,
Elements,
Utilities,
Subview
) {
return Backbone.View.extend( _.defaults( {
/**
* Current builder state
* @type {String}
*/
state: 'builder', // [builder|editor]
/**
* Current Subviews
* @type {Object}
*/
views: {
elements: {
class: Elements,
instance: null,
state: 'builder',
},
utilities: {
class: Utilities,
instance: null,
state: 'builder',
},
editor: {
class: Editor,
instance: null,
state: 'editor',
},
},
/**
* HTML element selector
* @type {String}
*/
el: '#llms-builder-sidebar',
/**
* DOM events
* @type {Object}
*/
events: {
'click #llms-save-button': 'save_now',
'click #llms-exit-button': 'exit_now',
'click .llms-builder-error': 'clear_errors',
},
/**
* Wrapper Tag name
* @type {String}
*/
tagName: 'aside',
/**
* Get the underscore template
* @type {[type]}
*/
template: wp.template( 'llms-sidebar-template' ),
/**
* Initialization callback func (renders the element on screen)
* @return void
* @since 3.16.0
* @version 3.16.0
*/
initialize: function( data ) {
// save a reference to the main Course view
this.CourseView = data.CourseView;
this.render();
Backbone.pubSub.on( 'current-save-status', this.changes_made, this );
Backbone.pubSub.on( 'heartbeat-send', this.heartbeat_send, this );
Backbone.pubSub.on( 'heartbeat-tick', this.heartbeat_tick, this );
Backbone.pubSub.on( 'lesson-selected', this.on_lesson_select, this );
Backbone.pubSub.on( 'sidebar-editor-close', this.on_editor_close, this );
this.$saveButton = $( '#llms-save-button' );
},
/**
* Compiles the template and renders the view
* @return self (for chaining)
* @since 3.16.0
* @version 3.16.0
*/
render: function( view_data ) {
view_data = view_data || {};
this.$el.html( this.template() );
this.render_subviews( _.extend( view_data, {
SidebarView: this,
} ) );
var $el = $( '.wrap.lifterlms.llms-builder' );
if ( 'builder' === this.state ) {
$el.removeClass( 'editor-active' );
} else {
$el.addClass( 'editor-active' );
}
this.$saveButton = this.$el.find( '#llms-save-button' );
return this;
},
/**
* Adds error message element
* @param {[type]} $err [description]
* @since 3.16.0
* @version 3.16.0
*/
add_error: function( $err ) {
this.$el.find( '.llms-builder-save' ).prepend( $err );
},
/**
* Clear any existing error message elements
* @return void
* @since 3.16.0
* @version 3.16.0
*/
clear_errors: function() {
this.$el.find( '.llms-builder-save .llms-builder-error' ).remove();
},
/**
* Update save status button when changes are detected
* runs on an interval to check status of course regularly for unsaved changes
* @param obj sync instance of the sync controller
* @return void
* @since 3.16.0
* @version 3.16.0
*/
changes_made: function( sync ) {
// if a save is currently running, don't do anything
if ( sync.saving ) {
return;
}
if ( sync.has_unsaved_changes ) {
this.$saveButton.attr( 'data-status', 'unsaved' );
this.$saveButton.removeAttr( 'disabled' );
} else {
this.$saveButton.attr( 'data-status', 'saved' );
this.$saveButton.attr( 'disabled', 'disabled' );
}
},
/**
* Exit the builder and return to the WP Course Editor
* @return void
* @since 3.16.7
* @version 3.16.7
*/
exit_now: function() {
window.location.href = window.llms_builder.CourseModel.get_edit_post_link();
},
/**
* Triggered when a heartbeat send event starts containing builder information
* @param obj sync instance of the sync controller
* @return void
* @since 3.16.0
* @version 3.16.0
*/
heartbeat_send: function( sync ) {
if ( sync.saving ) {
LLMS.Spinner.start( this.$saveButton.find( 'i' ), 'small' );
this.$saveButton.attr( {
'data-status': 'saving',
disabled: 'disabled',
} );
}
},
/**
* Triggered when a heartbeat tick completes and updates save status or appends errors
* @param obj sync instance of the sync controller
* @param obj data updated data
* @return void
* @since 3.16.0
* @version 3.16.0
*/
heartbeat_tick: function( sync, data ) {
if ( ! sync.saving ) {
var status = 'saved';
this.clear_errors();
if ( 'error' === data.status ) {
status = 'error';
var msg = data.message,
$err = $( '<ol class="llms-builder-error" />' );
if ( 'object' === typeof msg ) {
_.each( msg, function( txt ) {
$err.append( '<li>' + txt + '</li>' );
} );
} else {
$err = $err.append( '<li>' + msg + '</li>' );;
}
this.add_error( $err );
}
this.$saveButton.find( '.llms-spinning' ).remove();
this.$saveButton.attr( {
'data-status': status,
disabled: 'disabled',
} );
}
},
/**
* Determine if the editor is the currently active state
* @return boolean
* @since 3.16.0
* @version 3.16.0
*/
is_editor_active: function() {
return ( 'editor' === this.state );
},
/**
* Triggered when the editor closes, updates state to be the course builder view
* @return void
* @since 3.16.0
* @version 3.16.0
*/
on_editor_close: function() {
this.set_state( 'builder' ).render();
},
/**
* When a lesson is selected, opens the sidebar to the editor view
* @param obj lesson_model instance of the lesson model which was selected
* @return void
* @since 3.16.0
* @version 3.16.0
*/
on_lesson_select: function( lesson_model, tab ) {
if ( 'editor' !== this.state ) {
this.set_state( 'editor' );
} else {
this.remove_subview( 'editor' );
}
this.render( {
model: lesson_model,
tab: tab,
} );
},
/**
* Save button click event
* @return void
* @since 3.16.0
* @version 3.16.0
*/
save_now: function() {
window.llms_builder.sync.save_now();
},
}, Subview ) );
} );
================================================
FILE: assets/js/builder/Views/Utilities.js
================================================
/**
* Sidebar Utilities View
*
* @since 3.16.0
* @version 3.16.0
*/
define( [], function() {
return Backbone.View.extend( {
/**
* HTML element selector
*
* @type {String}
*/
el: '#llms-utilities',
events: {
'click #llms-collapse-all': 'collapse_all',
'click #llms-expand-all': 'expand_all'
},
/**
* Wrapper Tag name
*
* @type {String}
*/
tagName: 'div',
/**
* Get the underscore template
*
* @type {[type]}
*/
template: wp.template( 'llms-utilities-template' ),
/**
* Initialization callback func (renders the element on screen)
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
initialize: function() {
// this.render();
},
/**
* Compiles the template and renders the view
*
* @return self (for chaining)
* @since 3.16.0
* @version 3.16.0
*/
render: function() {
this.$el.html( this.template() );
return this;
},
/**
* Collapse all sections
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
collapse_all: function( event ) {
event.preventDefault();
Backbone.pubSub.trigger( 'collapse-all' );
},
/**
* Expand all sections
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
expand_all: function( event ) {
event.preventDefault();
Backbone.pubSub.trigger( 'expand-all' );
},
} );
} );
================================================
FILE: assets/js/builder/Views/_Detachable.js
================================================
/**
* Detachable model
*
* @package LifterLMS/Scripts
*
* @since 3.16.12
* @version 3.16.12
*/
define( [], function() {
return {
/**
* DOM Events
*
* @type {Object}
* @since 3.16.12
* @version 3.16.12
*/
events: {
'click a[href="#llms-detach-model"]': 'detach_model',
'click button.llms-detach-model': 'detach_model',
},
/**
* Detaches a model from it's parent (doesn't delete)
*
* @param obj event js event object
* @return void
* @since 3.16.12
* @version 3.16.12
*/
detach_model: function( event ) {
if ( event ) {
event.preventDefault();
event.stopPropagation();
}
var msg = LLMS.l10n.replace( 'Are you sure you want to detach this %s?', {
'%s': this.model.get_l10n_type(),
} );
if ( window.confirm( msg ) ) {
if ( this.model.collection ) {
this.model.collection.remove( this.model );
}
// publish global event
Backbone.pubSub.trigger( 'model-detached', this.model );
// trigger local event so extending views can run other actions where necessary
this.trigger( 'model-trashed', this.model );
}
},
}
} );
================================================
FILE: assets/js/builder/Views/_Editable.js
================================================
/**
* Handles UX and Events for inline editing of views
*
* Use with a Model's View
* Allows editing model.title field via .llms-editable-title elements
*
* @package LifterLMS/Scripts
*
* @since 3.16.0
* @since 3.25.4 Unknown
* @since 3.37.11 Replace reference to `wp.editor` with `_.getEditor()` helper.
* @since 10.0.0 Add paste event handler for plain contenteditable elements to strip formatting. Fixes #3057.
* @version 10.0.0
*/
define( [], function() {
return {
media_lib: null,
/**
* DOM Events
*
* @type {Object}
* @since 3.16.0
* @version 3.17.8
*/
events: {
'click .llms-add-image': 'open_media_lib',
'click a[href="#llms-edit-slug"]': 'make_slug_editable',
'click a[href="#llms-remove-image"]': 'remove_image',
'change .llms-editable-select select': 'on_select',
'change .llms-switch input[type="checkbox"]': 'toggle_switch',
'change .llms-editable-radio input': 'on_radio_select',
'focusin .llms-input': 'on_focus',
'focusout .llms-input': 'on_blur',
'keydown .llms-input': 'on_keydown',
'input .llms-input[type="number"]': 'on_blur',
'paste .llms-input[data-formatting]': 'on_paste',
'paste .llms-input[contenteditable]:not([data-formatting])': 'on_paste',
},
/**
* Retrieve a list of allowed tags for a given element
*
* @param obj $el jQuery selector for the element
* @return array
* @since 3.16.0
* @version 3.17.8
*/
get_allowed_tags: function( $el ) {
if ( $el.attr( 'data-formatting' ) ) {
return _.map( $el.attr( 'data-formatting' ).split( ',' ), function( tag ) {
return tag.trim();
} );
}
return [ 'b', 'i', 'u', 'strong', 'em' ];
},
/**
* Retrieve the content of an element
*
* @param obj $el jQuery object of the element
* @return string
* @since 3.16.0
* @version 3.17.8
*/
get_content: function( $el ) {
if ( 'INPUT' === $el[0].tagName ) {
return $el.val();
}
if ( ! $el.attr( 'data-formatting' ) && ! $el.hasClass( 'ql-editor' ) ) {
return $el.text();
}
return _.stripFormatting( $el.html(), this.get_allowed_tags( $el ) );
},
/**
* Determine if changes have been made to the element
*
* @param {[obj]} event js event object
* @return {Boolean} true when changes have been made, false otherwise
* @since 3.16.0
* @version 3.16.0
*/
has_changed: function( event ) {
var $el = $( event.target );
return ( $el.attr( 'data-original-content' ) !== this.get_content( $el ) );
},
/**
* Ensure that new content is at least 1 character long
*
* @param obj event js event object
* @return boolean
* @since 3.16.0
* @version 3.17.2
*/
is_valid: function( event ) {
var self = this,
$el = $( event.target ),
content = this.get_content( $el ),
type = $el.attr( 'data-type' );
if ( ( $el.attr( 'required' ) || $el.attr( 'data-required' ) ) && content.length < 1 ) {
return false;
}
if ( 'url' === type || 'video' === type ) {
if ( ! this._validate_url( this.get_content( $el ) ) ) {
return false;
}
} else if ( 'permalink' === type ) {
LLMS.Ajax.call( {
data: {
action: 'llms_builder',
action_type: 'get_permalink',
course_id: window.llms_builder.CourseModel.get( 'id' ),
id: self.model.get( 'id' ),
title: self.model.get( 'title' ),
slug: content,
},
beforeSend: function() {
LLMS.Spinner.start( $el.closest( '.llms-editable-toggle-group' ), 'small' );
},
success: function( r ) {
if ( r.permalink && r.slug ) {
self.model.set( 'permalink', r.permalink );
self.model.set( 'name', r.slug );
self.render();
}
}
} );
}
return true;
},
/**
* Initialize datepicker elements
*
* @return void
* @since 3.17.0
* @version 3.17.0
*/
init_datepickers: function() {
this.$el.find( '.llms-editable-date input' ).each( function() {
$( this ).datetimepicker( {
format: $( this ).attr( 'data-date-format' ) || 'Y-m-d h:i A',
datepicker: ( undefined === $( this ).attr( 'data-date-datepicker' ) ) ? true : ( 'true' == $( this ).attr( 'data-date-datepicker' ) ),
timepicker: ( undefined === $( this ).attr( 'data-date-timepicker' ) ) ? true : ( 'true' == $( this ).attr( 'data-date-timepicker' ) ),
onClose: function( current_time, $input ) {
$input.blur();
}
} );
} );
},
/**
* Initialize elements that allow inline formatting
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
init_formatting_els: function() {
var self = this;
this.$el.find( '.llms-input-formatting[data-formatting]' ).each( function() {
var formatting = $( this ).attr( 'data-formatting' ).split( ',' ),
attr = $( this ).attr( 'data-attribute' );
var ed = new Quill( this, {
modules: {
toolbar: [ formatting ],
keyboard: {
bindings: {
tab: {
key: 9,
handler: function( range, context ) {
return true;
},
},
13: {
key: 13,
handler: function( range, context ) {
ed.root.blur();
return false;
},
},
},
},
},
placeholder: $( this ).attr( 'data-placeholder' ),
theme: 'bubble',
} );
ed.on( 'text-change', function( delta, oldDelta, source ) {
self.model.set( attr, self.get_content( $( ed.root ) ) );
} );
Backbone.pubSub.trigger( 'formatting-ed-init', ed, $( this ), self );
} );
},
/**
* Initialize editable select elements
*
* @return void
* @since 3.16.0
* @version 3.25.4
*/
init_selects: function() {
this.$el.find( '.llms-editable-select select' ).llmsSelect2( {
width: '100%',
} ).trigger( 'change' );
},
/**
* Blur/focusout function for .llms-editable-title elements
* Automatically saves changes if changes have been made
*
* @param obj event js event object
* @return void
* @since 3.16.0
* @version 3.16.6
*/
on_blur: function( event ) {
event.stopPropagation();
this.model.set( '_has_focus', false, { silent: true } );
var self = this,
$el = $( event.target ),
changed = this.has_changed( event );
if ( changed ) {
if ( ! self.is_valid( event ) ) {
self.revert_edits( event );
} else {
this.save_edits( event );
}
}
},
/**
* Focus event for editable inputs
*
* @param obj event js event object
* @return void
* @since 3.16.6
* @version 3.16.6
*/
on_focus: function( event ) {
event.stopPropagation();
this.model.set( '_has_focus', true, { silent: true } );
},
/**
* Handle content pasted into contenteditable fields
* This will ensure that HTML from RTF editors isn't pasted into the dom
*
* @param obj event js event obj
* @return void
* @since 3.17.8
* @version 3.17.8
*/
on_paste: function( event ) {
event.preventDefault();
event.stopPropagation();
var text = ( event.originalEvent || event ).clipboardData.getData( 'text/plain' );
window.document.execCommand( 'insertText', false, text );
},
/**
* Change event for selectables
*
* @param obj event js event object
* @return void
* @since 3.16.0
* @version 3.16.0
*/
on_select: function( event ) {
event.stopPropagation();
var $el = $( event.target ),
multi = ( $el.attr( 'multiple' ) ),
attr = $el.attr( 'name' ),
$selected = $el.find( 'option:selected' ),
val;
if ( multi ) {
val = [];
val = $selected.map( function() {
return this.value;
} ).get();
} else {
val = $selected[0].value;
}
this.model.set( attr, val );
},
/**
* Change event for radio element groups
*
* @param obj event js event object
* @return void
* @since 3.17.6
* @version 3.17.6
*/
on_radio_select: function( event ) {
var $el = $( event.target ),
attr = $el.attr( 'name' ),
val = $el.val();
this.model.set( attr, val );
},
/**
* Keydown function for .llms-editable-title elements
* Blurs
*
* @param {obj} event js event object
* @return void
* @since 3.16.0
* @version 3.17.8
*/
on_keydown: function( event ) {
event.stopPropagation();
var self = this,
key = event.which || event.keyCode,
shift = event.shiftKey;
// ctrl = event.metaKey || event.ctrlKey;
switch ( key ) {
case 13: // enter
// shift + enter should add a return
if ( ! shift ) {
event.preventDefault();
event.target.blur();
}
break;
case 27: // escape
event.preventDefault();
this.revert_edits( event );
event.target.blur();
break;
}
},
/**
* Open the WP media lib
*
* @param obj event js event object
* @return void
* @since 3.16.0
* @version 3.16.6
*/
open_media_lib: function( event ) {
event.stopPropagation();
var self = this,
$el = $( event.currentTarget );
if ( self.media_lib ) {
self.media_lib.uploader.uploader.param( 'post_id' );
} else {
self.media_lib = wp.media.frames.file_frame = wp.media( {
title: LLMS.l10n.translate( 'Select an image' ),
button: {
text: LLMS.l10n.translate( 'Use this image' ),
},
multiple: false // Set to true to allow multiple files to be selected
} );
self.media_lib.on( 'select', function() {
var size = $el.attr( 'data-image-size' ),
attachment = self.media_lib.state().get( 'selection' ).first().toJSON(),
image = self.model.get( $el.attr( 'data-attribute' ) ),
url;
if ( size && attachment.sizes[ size ] ) {
url = attachment.sizes[ size ].url;
} else {
url = attachment.url;
}
image.set( {
id: attachment.id,
src: url,
} );
} );
}
// This flag is used to protect the media files uploaded via places like the Quiz questions (Picture type)
self.media_lib.uploader.options.uploader.params.llms = 1;
self.media_lib.open();
},
/**
* Click event to remove an image
*
* @param obj event js event obj
* @return voids
* @since 3.16.0
* @version 3.16.0
*/
remove_image: function( event ) {
event.preventDefault();
this.model.get( $( event.currentTarget ).attr( 'data-attribute' ) ).set( {
id: '',
src: '',
} );
},
/**
* Helper to undo changes
* Bound to "escape" key via on_keydown function
*
* @param obj event js event object
* @return void
* @since 3.16.0
* @version 3.16.0
*/
revert_edits: function( event ) {
var $el = $( event.target ),
val = $el.attr( 'data-original-content' );
$el.html( val );
},
/**
* Sync changes to the model and DB
*
* @param {obj} event js event object
* @return void
* @since 3.16.0
* @version 3.16.0
*/
save_edits: function( event ) {
var $el = $( event.target ),
val = this.get_content( $el );
this.model.set( $el.attr( 'data-attribute' ), val );
},
/**
* Change event for a switch element
*
* @param obj event js event object
* @return void
* @since 3.16.0
* @version 3.17.0
*/
toggle_switch: function( event ) {
event.stopPropagation();
var $el = $( event.target ),
attr = $el.attr( 'name' ),
rerender = $el.attr( 'data-rerender' ),
val;
if ( $el.is( ':checked' ) ) {
val = $el.attr( 'data-on' ) ? $el.attr( 'data-on' ) : 'yes';
} else {
val = $el.attr( 'data-off' ) ? $el.attr( 'data-off' ) : 'no';
}
if ( -1 !== attr.indexOf( '.' ) ) {
var split = attr.split( '.' );
if ( 'parent' === split[0] ) {
this.model.get_parent().set( split[1], val );
} else {
this.model.get( split[0] ).set( split[1], val );
}
} else {
this.model.set( attr, val );
}
this.trigger( attr.replace( '.', '-' ) + '_toggle', val );
if ( ! rerender || 'yes' === rerender ) {
var self = this;
setTimeout( function() {
self.render();
}, 100 );
}
},
/**
* Initializes a WP Editor on a textarea
*
* @since 3.16.0
* @since 3.37.11 Replace reference to `wp.editor` with `_.getEditor()` helper.
*
* @param {String} id CSS ID of the editor (don't include #).
* @param {Object} settings Optional object of settings to pass to wp.oldEditor.initialize().
* @return {Void}
*/
init_editor: function( id, settings ) {
settings = settings || {};
var editor = _.getEditor();
editor.remove( id );
editor.initialize( id, $.extend( true, editor.getDefaultSettings(), {
mediaButtons: true,
tinymce: {
toolbar1: 'bold,italic,strikethrough,bullist,numlist,blockquote,hr,alignleft,aligncenter,alignright,link,unlink,wp_adv',
toolbar2: 'formatselect,underline,alignjustify,forecolor,pastetext,removeformat,charmap,outdent,indent,undo,redo,wp_help',
setup: _.bind( this.on_editor_ready, this ),
}
}, settings ) );
},
/**
* Setup a permalink editor to allow editing of a permalink
*
* @param obj event js event object
* @return void
* @since 3.16.6
* @version 3.16.6
*/
make_slug_editable: function( event ) {
var self = this,
$btn = $( event.currentTarget ),
$link = $btn.prevAll( 'a' ),
$input = $btn.prev( 'input.permalink' ),
full_url = $link.attr( 'href' ),
slug = $input.val(),
short_url = full_url.replace( slug, '' );
// hide the button
$btn.hide();
// make the link not clickable
$link.css( {
color: '#999',
'pointer-events': 'none',
'text-decoration': 'none',
} );
// remove the current slug & trailing slash from the URL
$link.text( short_url.substring( 0, short_url.length - 1 ) );
// focus in on the field
$input.show().focus();
},
/**
* Callback function called after initialization of an editor
*
* Updates UI if a label is present.
*
* Binds a change event to ensure editor changes are saved to the model.
*
* @since 3.16.0
* @since 3.17.1 Uknown.
* @since 3.37.11 Replace references to `wp.editor` with `_.getEditor()` helper.
*
* @param {Object} editor TinyMCE Editor instance.
* @return {Void}
*/
on_editor_ready: function( editor ) {
var self = this,
$ed = $( '#' + editor.id ),
$parent = $ed.closest( '.llms-editable-editor' ),
$label = $parent.find( '.llms-label' ),
prop = $ed.attr( 'data-attribute' )
if ( $label.length ) {
$label.prependTo( $parent.find( '.wp-editor-tools' ) );
}
// save changes to the model via Visual ed
editor.on( 'change', function( event ) {
self.model.set( prop, _.getEditor().getContent( editor.id ) );
} );
// save changes via Text ed
$ed.on( 'input', function( event ) {
self.model.set( prop, $ed.val() );
} );
// trigger an input on the Text ed when quicktags buttons are clicked
$parent.on( 'click', '.quicktags-toolbar .ed_button', function() {
setTimeout( function() {
$ed.trigger( 'input' );
}, 10 );
} );
},
_validate_url: function( str ) {
var a = document.createElement( 'a' );
a.href = str;
return ( a.host && a.host !== window.location.host );
}
};
} );
================================================
FILE: assets/js/builder/Views/_Receivable.js
================================================
/**
* _receive override for Backbone.CollectionView core
* enables connection with jQuery UI draggable buttons
*
* @since 3.16.0
* @version 3.16.0
*/
define( [], function() {
return {
/**
* Overloads the function from Backbone.CollectionView core because it doesn't properly handle
* receives from a jQuery UI draggable object
*
* @param obj event js event object
* @param obj ui jQuery UI object
* @return void
* @since 3.16.0
* @version 3.16.0
*/
_receive : function( event, ui ) {
// came from sidebar drag
if ( ui.sender.hasClass( 'ui-draggable' ) ) {
var index = this._getContainerEl().children().index( ui.helper );
ui.helper.remove(); // remove the helper
this.collection.add( {}, { at: index } );
return;
}
var senderListEl = ui.sender;
var senderCollectionListView = senderListEl.data( 'view' );
if ( ! senderCollectionListView || ! senderCollectionListView.collection ) {
return;
}
var newIndex = this._getContainerEl().children().index( ui.item );
var modelReceived = senderCollectionListView.collection.get( ui.item.attr( 'data-model-cid' ) );
senderCollectionListView.collection.remove( modelReceived );
this.collection.add( modelReceived, { at : newIndex } );
modelReceived.collection = this.collection; // otherwise will not get properly set, since modelReceived.collection might already have a value.
this.setSelectedModel( modelReceived );
},
}
} );
================================================
FILE: assets/js/builder/Views/_Shiftable.js
================================================
/**
* Shiftable view mixin function
*
* @since 3.16.0
* @version 3.16.0
*/
define( [], function() {
return {
/**
* Conditionally hide action buttons based on section position in collection
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
maybe_hide_shiftable_buttons: function() {
if ( ! this.model.collection ) {
return;
}
var type = this.model.get( 'type' );
if ( this.model.collection.first() === this.model ) {
this.$el.find( '.shift-up--' + type ).hide();
} else if ( this.model.collection.last() === this.model ) {
this.$el.find( '.shift-down--' + type ).hide();
}
},
/**
* Move an item in a collection from one position to another
*
* @param int old_index current (old) index within the collection
* @param int new_index desired (new) index within the collection
* @return void
* @since 3.16.0
* @version 3.16.0
*/
shift: function( old_index, new_index ) {
var collection = this.model.collection;
collection.remove( this.model );
collection.add( this.model, { at: new_index } );
collection.trigger( 'reorder' );
},
/**
* Move an item down the tree one position
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
shift_down: function( e ) {
e.preventDefault();
var index = this.model.collection.indexOf( this.model );
this.shift( index, index + 1 );
},
/**
* Move an item up the tree one position
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
shift_up: function( e ) {
e.preventDefault();
var index = this.model.collection.indexOf( this.model );
this.shift( index, index - 1 );
},
};
} );
================================================
FILE: assets/js/builder/Views/_Subview.js
================================================
/**
* Subview utility mixin
*
* @since 3.16.0
* @version 3.16.0
*/
define( [], function() {
return {
subscriptions: {},
/**
* Name of the current subview
*
* @type {String}
*/
state: '',
/**
* Object of subview data
*
* @type {Object}
*/
views: {},
/**
* Retrieve a subview by name from this.views
*
* @param string name name of the subview
* @return obl|false
* @since 3.16.0
* @version 3.16.0
*/
get_subview: function( name ) {
if ( this.views[ name ] ) {
return this.views[ name ];
}
return false;
},
events_subscribe: function( events ) {
_.each( events, function( func, event ) {
this.subscriptions[ event ] = func;
Backbone.pubSub.on( event, func, this );
}, this );
},
events_unsubscribe: function() {
_.each( this.subscriptions, function( func, event ) {
Backbone.pubSub.off( event, func, this );
delete this.subscriptions[ event ];
}, this );
},
/**
* Remove a single subview (and all it's subviews) by name
*
* @param string name name of the subview
* @return void
* @since 3.16.0
* @version 3.16.0
*/
remove_subview: function( name ) {
var view = this.get_subview( name );
if ( ! view ) {
return;
}
if ( view.instance ) {
// remove the subviews if the view has subviews
if ( ! _.isEmpty( view.instance.views ) ) {
view.instance.events_unsubscribe();
view.instance.remove_subviews();
}
view.instance.off();
view.instance.off( null, null, null );
view.instance.remove();
view.instance.undelegateEvents();
// _.each( view.instance, function( val, key ) {
// delete view.instance[ key ];
// } );
view.instance = null;
}
},
/**
* Remove all subviews (and all the subviews of those subviews)
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
remove_subviews: function() {
_.each( this.views, function( data, name ) {
this.remove_subview( name );
}, this );
},
/**
* Render subviews based on current state
*
* @param obj view_data additional data to pass to the subviews
* @return void
* @since 3.16.0
* @version 3.16.0
*/
render_subviews: function( view_data ) {
view_data = view_data || {};
_.each( this.views, function( data, name ) {
if ( this.state === data.state ) {
this.render_subview( name, view_data );
} else {
this.remove_subview( name );
}
}, this );
},
/**
* Render a single subview by name
*
* @param string name name of the subview
* @param obj view_data additional data to pass to the subview initializer
* @return void
* @since 3.16.0
* @version 3.16.0
*/
render_subview: function( name, view_data ) {
var view = this.get_subview( name );
if ( ! view ) {
return;
}
this.remove_subview( name );
if ( ! view.instance ) {
view.instance = new view.class( view_data );
}
view.instance.render();
},
/**
* Set the current subview
* Must call render after!
*
* @param string state name of the state [builder|editor]
* @return obj this for chaining
* @since 3.16.0
* @version 3.16.0
*/
set_state: function ( state ) {
this.state = state;
return this;
},
}
} );
================================================
FILE: assets/js/builder/Views/_Trashable.js
================================================
/**
* Trashable model
*
* @type {Object}
* @since 3.16.12
* @version 3.16.12
*/
define( [], function() {
return {
/**
* DOM Events
*
* @type {Object}
* @since 3.16.12
* @version 3.16.12
*/
events: {
'click a[href="#llms-trash-model"]': 'trash_model',
'click button.llms-trash-model': 'trash_model',
},
/**
* Remove a model from it's parent and delete it
*
* @param obj event js event object
* @return void
* @since 3.16.12
* @version 3.16.12
*/
trash_model: function( event ) {
if ( event ) {
event.preventDefault();
event.stopPropagation();
}
var msg = LLMS.l10n.replace( 'Are you sure you want to move this %s to the trash?', {
'%s': this.model.get_l10n_type(),
} );
if ( window.confirm( msg ) ) {
if ( this.model.collection ) {
this.model.collection.remove( this.model );
}
// publish event
Backbone.pubSub.trigger( 'model-trashed', this.model );
// close the editor sidebar if the trashed model is the one currently being edited
if ( this.model.get( '_selected' ) ) {
Backbone.pubSub.trigger( 'sidebar-editor-close' );
}
// trigger local event so extending views can run other actions where necessary
this.trigger( 'model-trashed', this.model );
}
},
}
} );
================================================
FILE: assets/js/builder/Views/_loader.js
================================================
/**
* Load view mixins
*
* @package LifterLMS/Scripts
*
* @since 3.17.1
* @version 3.17.1
*/
define( [
'Views/_Detachable',
'Views/_Editable',
'Views/_Receivable',
'Views/_Shiftable',
'Views/_Subview',
'Views/_Trashable'
],
function(
Detachable,
Editable,
Receivable,
Shiftable,
Subview,
Trashable
) {
return {
Detachable: Detachable,
Editable: Editable,
Receivable: Receivable,
Shiftable: Shiftable,
Subview: Subview,
Trashable: Trashable,
};
} );
================================================
FILE: assets/js/builder/backbone.js
================================================
/**
* Returns the WordPress-loaded version of Backbone for use with things that need it and use Require.
*
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
define( function() {
return Backbone;
} );
================================================
FILE: assets/js/builder/jquery.js
================================================
/**
* Returns the WordPress-loaded version of Underscore for use with things that need it and use Require.
*
* @package LifterLMS/Scripts
*
* @since 3.16.0
* @version 3.16.0
*/
define( function() {
return jQuery;
} );
================================================
FILE: assets/js/builder/main.js
================================================
/**
* LifterLMS JS Builder App Bootstrap
*
* @since 3.16.0
* @since 3.37.11 Added `_.getEditor()` helper.
* @version 5.4.0
*/
require( [
'vendor/wp-hooks',
'vendor/backbone.collectionView',
'vendor/backbone.trackit',
'Controllers/Construct',
'Controllers/Debug',
'Controllers/Schemas',
'Controllers/Sync',
'Models/loader',
'Views/Course',
'Views/Sidebar'
], function(
Hooks,
CV,
TrackIt,
Construct,
Debug,
Schemas,
Sync,
Models,
CourseView,
SidebarView
) {
window.llms_builder.debug = new Debug( window.llms_builder.debug );
window.llms_builder.construct = new Construct();
window.llms_builder.schemas = new Schemas( window.llms_builder.schemas );
/**
* Compare values, used by _.checked & _.selected mixins.
*
* @since 3.17.2
*
* @param {Mixed} expected expected Value, probably a string (the value of a select option or checkbox element).
* @param {Mixed} mixed actual Actual value, probably a string (the return of model.get( 'something' ) )
* but could be an array like a multiselect.
* @return {Bool}
*/
function value_compare( expected, actual ) {
return ( ( _.isArray( actual ) && -1 !== actual.indexOf( expected ) ) || expected == actual );
};
/**
* Underscores templating utilities
*
* @since 3.17.0
* @version 3.27.0
*/
_.mixin( {
/**
* Determine if two values are equal and output checked attribute if they are.
*
* Useful for templating checkboxes & radio elements
* like WP Core PHP checked() but in JS.
*
* @since 3.17.0
* @since 3.17.2 Unknown.
*
* @param {Mixed} expected Expected element value.
* @param {Mixed} actual Actual element value.
* @return {String}
*/
checked: function( expected, actual ) {
if ( value_compare( expected, actual ) ) {
return ' checked="checked"';
}
return '';
},
/**
* Recursively clone an object via _.clone().
*
* @since 3.17.7
*
* @param {Object} obj Object to clone.
* @return {Object}
*/
deepClone: function( obj ) {
var clone = _.clone( obj );
_.each( clone, function( val, key ) {
if ( ! _.isFunction( val ) && _.isObject( val ) ) {
clone[ key ] = _.deepClone( val );
};
} );
return clone;
},
/**
* Retrieve the wp.editor instance.
*
* Uses `wp.oldEditor` (when available) which was added in WordPress 5.0.
*
* Falls back to `wp.editor()` which will usually be the same as `wp.oldEditor` unless
* the `@wordpress/editor` module has been loaded by another plugin or a theme.
*
* @since 3.37.11
*
* @return {Object}
*/
getEditor: function() {
if ( undefined !== wp.oldEditor ) {
var ed = wp.oldEditor;
// Inline scripts added by WordPress are not ported to `wp.oldEditor`, see https://github.com/WordPress/WordPress/blob/641c632b0c9fde4e094b217f50749984ca43a2fa/wp-includes/class-wp-editor.php#L977.
if ( undefined !== wp.editor && undefined !== wp.editor.getDefaultSettings ) {
ed.getDefaultSettings = wp.editor.getDefaultSettings;
}
return ed;
} else if ( undefined !== wp.editor && undefined !== wp.editor.autop ){
return wp.editor;
}
},
/**
* Strips IDs & Parent References from quizzes and all quiz questions.
*
* @since 3.24.0
* @since 3.27.0 Unknown.
* @since 5.4.0 Use author id instead of the question author object.
*
* @param {Object} quiz Raw quiz object (not a model).
* @return {Object}
*/
prepareQuizObjectForCloning: function( quiz ) {
delete quiz.id;
delete quiz.lesson_id;
_.each( quiz.questions, function( question ) {
question = _.prepareQuestionObjectForCloning( question );
} );
// Use author id instead of the quiz author object.
quiz = _.prepareExistingPostObjectDataForAddingOrCloning( quiz );
return quiz;
},
/**
* Strips IDs & Parent References from a question.
*
* @since 3.27.0
* @since 5.4.0 Use author id instead of the question author object.
*
* @param {Object} question Raw question object (not a model).
* @return {Object}
*/
prepareQuestionObjectForCloning: function( question ) {
delete question.id;
delete question.parent_id;
if ( question.image && _.isObject( question.image ) ) {
question.image._forceSync = true;
}
if ( question.choices ) {
_.each( question.choices, function( choice ) {
delete choice.question_id;
delete choice.id;
if ( 'image' === choice.choice_type && _.isObject( choice.choice ) ) {
choice.choice._forceSync = true;
}
} );
}
// Use author id instead of the question author object.
question = _.prepareExistingPostObjectDataForAddingOrCloning( question );
return question;
},
/**
* Strips IDs & Parent References from assignments and all assignment tasks.
*
* @since 5.4.0
*
* @param {Object} assignment Raw assignment object (not a model).
* @return {Object}
*/
prepareAssignmentObjectForCloning: function( assignment ) {
delete assignment.id;
delete assignment.lesson_id;
// Clone tasks.
if ( 'tasklist' === assignment.assignment_type ) {
_.each( assignment.tasks, function( task ) {
delete task.id;
delete task.assignment_id;
} );
}
// Use author id instead of the quiz author object.
assignment = _.prepareExistingPostObjectDataForAddingOrCloning( assignment );
return assignment;
},
/**
* Prepare post object data for adding or cloning.
*
* Use author id instead of the post type author object.
*
* @since 5.4.0
*
* @param {Object} quiz Raw post object (not a model).
* @return {Object}
*/
prepareExistingPostObjectDataForAddingOrCloning: function( post_data ) {
if ( post_data.author && _.isObject( post_data.author ) && post_data.author.id ) {
post_data.author = post_data.author.id;
}
return post_data;
},
/**
* Determine if two values are equal and output selected attribute if they are.
*
* Useful for templating select elements
* like WP Core PHP selected() but in JS.
*
*
* @since 3.17.0
* @since 3.17.2 Unknown.
*
* @param {Mixed} expected Expected element value.
* @param {Mixed} actual Actual element value.
* @return {String}
*/
selected: function( expected, actual ) {
if ( value_compare( expected, actual ) ) {
return ' selected="selected"';
}
return '';
},
/**
* Generic function for stripping HTML tags from a string.
*
* @since 3.17.8
*
* @param {String} content Raw string.
* @param {Array} allowed_tags Array of allowed HTML tags.
* @return {String}
*/
stripFormatting: function( content, allowed_tags ) {
if ( ! allowed_tags ) {
allowed_tags = [ 'b', 'i', 'u', 'strong', 'em' ];
}
var $html = $( '<div>' + content + '</div>' );
$html.find( '*' ).not( allowed_tags.join( ',' ) ).each( function( ) {
$( this ).replaceWith( this.innerHTML );
} );
return $html.html();
},
} );
Backbone.pubSub = _.extend( {}, Backbone.Events );
$( document ).trigger( 'llms-builder-pre-init' );
window.llms_builder.questions = window.llms_builder.construct.get_collection( 'QuestionTypes', window.llms_builder.questions );
var CourseModel = window.llms_builder.construct.get_model( 'Course', window.llms_builder.course );
window.llms_builder.CourseModel = CourseModel;
window.llms_builder.sync = new Sync( CourseModel, window.llms_builder.sync );
var Course = new CourseView( {
model: CourseModel,
} );
var Sidebar = new SidebarView( {
CourseView: Course
} );
$( document ).trigger( 'llms-builder-init', {
course: Course,
sidebar: Sidebar,
} );
/**
* Do deep linking to Lesson / Quiz / Assignments.
*
* Hash should be in the form of #lesson:{lesson_id}:{subtab}
* subtab can be either "quiz" or "assignment". If none found assumes the "lesson" tab.
*
* @since 3.27.0
* @since 3.30.1 Wait for wp.editor & window.tinymce to load before opening deep link tabs.
* @since 3.37.11 Use `_.getEditor()` helper when checking for the presence of `wp.editor`.
*/
if ( window.location.hash ) {
var hash = window.location.hash;
if ( -1 === hash.indexOf( '#lesson:' ) ) {
return;
}
var parts = hash.replace( '#lesson:', '' ).split( ':' ),
$lesson = $( '#llms-lesson-' + parts[0] );
if ( $lesson.length ) {
LLMS.wait_for( function() {
return ( undefined !== _.getEditor() && undefined !== window.tinymce );
}, function() {
$lesson.closest( '.llms-builder-item.llms-section' ).find( 'a.llms-action-icon.expand' ).trigger( 'click' );
var subtab = parts[1] ? parts[1] : 'lesson';
$( '#llms-lesson-' + parts[0] ).find( 'a.llms-action-icon.edit-' + subtab ).trigger( 'click' );
} );
}
}
} );
================================================
FILE: assets/js/builder/underscore.js
================================================
/**
* Returns the WordPress-loaded version of Underscore for use with things that need it and use Require.
*
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
define( function() {
return _;
} );
================================================
FILE: assets/js/builder/vendor/almond.js
================================================
/**
* @license almond 0.3.3 Copyright jQuery Foundation and other contributors.
* Released under MIT license, http://github.com/requirejs/almond/LICENSE
*/
//Going sloppy to avoid 'use strict' string cost, but strict practices should
//be followed.
/*global setTimeout: false */
var requirejs, require, define;
(function (undef) {
var main, req, makeMap, handlers,
defined = {},
waiting = {},
config = {},
defining = {},
hasOwn = Object.prototype.hasOwnProperty,
aps = [].slice,
jsSuffixRegExp = /\.js$/;
function hasProp(obj, prop) {
return hasOwn.call(obj, prop);
}
/**
* Given a relative module name, like ./something, normalize it to
* a real name that can be mapped to a path.
* @param {String} name the relative name
* @param {String} baseName a real name that the name arg is relative
* to.
* @returns {String} normalized name
*/
function normalize(name, baseName) {
var nameParts, nameSegment, mapValue, foundMap, lastIndex,
foundI, foundStarMap, starI, i, j, part, normalizedBaseParts,
baseParts = baseName && baseName.split("/"),
map = config.map,
starMap = (map && map['*']) || {};
//Adjust any relative paths.
if (name) {
name = name.split('/');
lastIndex = name.length - 1;
// If wanting node ID compatibility, strip .js from end
// of IDs. Have to do this here, and not in nameToUrl
// because node allows either .js or non .js to map
// to same file.
if (config.nodeIdCompat && jsSuffixRegExp.test(name[lastIndex])) {
name[lastIndex] = name[lastIndex].replace(jsSuffixRegExp, '');
}
// Starts with a '.' so need the baseName
if (name[0].charAt(0) === '.' && baseParts) {
//Convert baseName to array, and lop off the last part,
//so that . matches that 'directory' and not name of the baseName's
//module. For instance, baseName of 'one/two/three', maps to
//'one/two/three.js', but we want the directory, 'one/two' for
//this normalization.
normalizedBaseParts = baseParts.slice(0, baseParts.length - 1);
name = normalizedBaseParts.concat(name);
}
//start trimDots
for (i = 0; i < name.length; i++) {
part = name[i];
if (part === '.') {
name.splice(i, 1);
i -= 1;
} else if (part === '..') {
// If at the start, or previous value is still ..,
// keep them so that when converted to a path it may
// still work when converted to a path, even though
// as an ID it is less than ideal. In larger point
// releases, may be better to just kick out an error.
if (i === 0 || (i === 1 && name[2] === '..') || name[i - 1] === '..') {
continue;
} else if (i > 0) {
name.splice(i - 1, 2);
i -= 2;
}
}
}
//end trimDots
name = name.join('/');
}
//Apply map config if available.
if ((baseParts || starMap) && map) {
nameParts = name.split('/');
for (i = nameParts.length; i > 0; i -= 1) {
nameSegment = nameParts.slice(0, i).join("/");
if (baseParts) {
//Find the longest baseName segment match in the config.
//So, do joins on the biggest to smallest lengths of baseParts.
for (j = baseParts.length; j > 0; j -= 1) {
mapValue = map[baseParts.slice(0, j).join('/')];
//baseName segment has config, find if it has one for
//this name.
if (mapValue) {
mapValue = mapValue[nameSegment];
if (mapValue) {
//Match, update name to the new value.
foundMap = mapValue;
foundI = i;
break;
}
}
}
}
if (foundMap) {
break;
}
//Check for a star map match, but just hold on to it,
//if there is a shorter segment match later in a matching
//config, then favor over this star map.
if (!foundStarMap && starMap && starMap[nameSegment]) {
foundStarMap = starMap[nameSegment];
starI = i;
}
}
if (!foundMap && foundStarMap) {
foundMap = foundStarMap;
foundI = starI;
}
if (foundMap) {
nameParts.splice(0, foundI, foundMap);
name = nameParts.join('/');
}
}
return name;
}
function makeRequire(relName, forceSync) {
return function () {
//A version of a require function that passes a moduleName
//value for items that may need to
//look up paths relative to the moduleName
var args = aps.call(arguments, 0);
//If first arg is not require('string'), and there is only
//one arg, it is the array form without a callback. Insert
//a null so that the following concat is correct.
if (typeof args[0] !== 'string' && args.length === 1) {
args.push(null);
}
return req.apply(undef, args.concat([relName, forceSync]));
};
}
function makeNormalize(relName) {
return function (name) {
return normalize(name, relName);
};
}
function makeLoad(depName) {
return function (value) {
defined[depName] = value;
};
}
function callDep(name) {
if (hasProp(waiting, name)) {
var args = waiting[name];
delete waiting[name];
defining[name] = true;
main.apply(undef, args);
}
if (!hasProp(defined, name) && !hasProp(defining, name)) {
throw new Error('No ' + name);
}
return defined[name];
}
//Turns a plugin!resource to [plugin, resource]
//with the plugin being undefined if the name
//did not have a plugin prefix.
function splitPrefix(name) {
var prefix,
index = name ? name.indexOf('!') : -1;
if (index > -1) {
prefix = name.substring(0, index);
name = name.substring(index + 1, name.length);
}
return [prefix, name];
}
//Creates a parts array for a relName where first part is plugin ID,
//second part is resource ID. Assumes relName has already been normalized.
function makeRelParts(relName) {
return relName ? splitPrefix(relName) : [];
}
/**
* Makes a name map, normalizing the name, and using a plugin
* for normalization if necessary. Grabs a ref to plugin
* too, as an optimization.
*/
makeMap = function (name, relParts) {
var plugin,
parts = splitPrefix(name),
prefix = parts[0],
relResourceName = relParts[1];
name = parts[1];
if (prefix) {
prefix = normalize(prefix, relResourceName);
plugin = callDep(prefix);
}
//Normalize according
if (prefix) {
if (plugin && plugin.normalize) {
name = plugin.normalize(name, makeNormalize(relResourceName));
} else {
name = normalize(name, relResourceName);
}
} else {
name = normalize(name, relResourceName);
parts = splitPrefix(name);
prefix = parts[0];
name = parts[1];
if (prefix) {
plugin = callDep(prefix);
}
}
//Using ridiculous property names for space reasons
return {
f: prefix ? prefix + '!' + name : name, //fullName
n: name,
pr: prefix,
p: plugin
};
};
function makeConfig(name) {
return function () {
return (config && config.config && config.config[name]) || {};
};
}
handlers = {
require: function (name) {
return makeRequire(name);
},
exports: function (name) {
var e = defined[name];
if (typeof e !== 'undefined') {
return e;
} else {
return (defined[name] = {});
}
},
module: function (name) {
return {
id: name,
uri: '',
exports: defined[name],
config: makeConfig(name)
};
}
};
main = function (name, deps, callback, relName) {
var cjsModule, depName, ret, map, i, relParts,
args = [],
callbackType = typeof callback,
usingExports;
//Use name if no relName
relName = relName || name;
relParts = makeRelParts(relName);
//Call the callback to define the module, if necessary.
if (callbackType === 'undefined' || callbackType === 'function') {
//Pull out the defined dependencies and pass the ordered
//values to the callback.
//Default to [require, exports, module] if no deps
deps = !deps.length && callback.length ? ['require', 'exports', 'module'] : deps;
for (i = 0; i < deps.length; i += 1) {
map = makeMap(deps[i], relParts);
depName = map.f;
//Fast path CommonJS standard dependencies.
if (depName === "require") {
args[i] = handlers.require(name);
} else if (depName === "exports") {
//CommonJS module spec 1.1
args[i] = handlers.exports(name);
usingExports = true;
} else if (depName === "module") {
//CommonJS module spec 1.1
cjsModule = args[i] = handlers.module(name);
} else if (hasProp(defined, depName) ||
hasProp(waiting, depName) ||
hasProp(defining, depName)) {
args[i] = callDep(depName);
} else if (map.p) {
map.p.load(map.n, makeRequire(relName, true), makeLoad(depName), {});
args[i] = defined[depName];
} else {
throw new Error(name + ' missing ' + depName);
}
}
ret = callback ? callback.apply(defined[name], args) : undefined;
if (name) {
//If setting exports via "module" is in play,
//favor that over return value and exports. After that,
//favor a non-undefined return value over exports use.
if (cjsModule && cjsModule.exports !== undef &&
cjsModule.exports !== defined[name]) {
defined[name] = cjsModule.exports;
} else if (ret !== undef || !usingExports) {
//Use the return value from the function.
defined[name] = ret;
}
}
} else if (name) {
//May just be an object definition for the module. Only
//worry about defining if have a module name.
defined[name] = callback;
}
};
requirejs = require = req = function (deps, callback, relName, forceSync, alt) {
if (typeof deps === "string") {
if (handlers[deps]) {
//callback in this case is really relName
return handlers[deps](callback);
}
//Just return the module wanted. In this scenario, the
//deps arg is the module name, and second arg (if passed)
//is just the relName.
//Normalize module name, if it contains . or ..
return callDep(makeMap(deps, makeRelParts(callback)).f);
} else if (!deps.splice) {
//deps is a config object, not an array.
config = deps;
if (config.deps) {
req(config.deps, config.callback);
}
if (!callback) {
return;
}
if (callback.splice) {
//callback is an array, which means it is a dependency list.
//Adjust args if there are dependencies
deps = callback;
callback = relName;
relName = null;
} else {
deps = undef;
}
}
//Support require(['a'])
callback = callback || function () {};
//If relName is a function, it is an errback handler,
//so remove it.
if (typeof relName === 'function') {
relName = forceSync;
forceSync = alt;
}
//Simulate async callback;
if (forceSync) {
main(undef, deps, callback, relName);
} else {
//Using a non-zero value because of concern for what old browsers
//do, and latest browsers "upgrade" to 4 if lower value is used:
//http://www.whatwg.org/specs/web-apps/current-work/multipage/timers.html#dom-windowtimers-settimeout:
//If want a value immediately, use require('id') instead -- something
//that works in almond on the global level, but not guaranteed and
//unlikely to work in other AMD implementations.
setTimeout(function () {
main(undef, deps, callback, relName);
}, 4);
}
return req;
};
/**
* Just drops the config on the floor, but returns req in case
* the config return value is used.
*/
req.config = function (cfg) {
return req(cfg);
};
/**
* Expose module registry for debugging and tooling
*/
requirejs._defined = defined;
define = function (name, deps, callback) {
if (typeof name !== 'string') {
throw new Error('See almond README: incorrect module build, no module name');
}
//This module may not have dependencies
if (!deps.splice) {
//deps is not an array, so probably means
//an object literal or factory function for
//the value. Adjust args.
callback = deps;
deps = [];
}
if (!hasProp(defined, name) && !hasProp(waiting, name)) {
waiting[name] = [name, deps, callback];
}
};
define.amd = {
jQuery: true
};
}());
================================================
FILE: assets/js/builder/vendor/backbone.collectionView.js
================================================
/*!
* Backbone.CollectionView, v1.3.4
* Copyright (c)2013 Rotunda Software, LLC.
* Distributed under MIT license
* http://github.com/rotundasoftware/backbone-collection-view
*/
( function( root, factory ) {
// UMD wrapper
if ( typeof define === 'function' && define.amd ) {
// AMD
define( [ 'underscore', 'backbone', 'jquery' ], factory );
} else if ( typeof exports !== 'undefined' ) {
// Node/CommonJS
module.exports = factory( require('underscore' ), require( 'backbone' ), require( 'backbone' ).$ );
} else {
// Browser globals
factory( root._, root.Backbone, ( root.jQuery || root.Zepto || root.$ ) );
}
}( this, function( _, Backbone, $ ) {
var mDefaultModelViewConstructor = Backbone.View;
var kDefaultReferenceBy = "model";
var kOptionsRequiringRerendering = [ "collection", "modelView", "modelViewOptions", "itemTemplate", "itemTemplateFunction", "detachedRendering" ];
var kStylesForEmptyListCaption = {
"background" : "transparent",
"border" : "none",
"box-shadow" : "none"
};
Backbone.CollectionView = Backbone.View.extend( {
tagName : "ul",
events : {
"mousedown > li, tbody > tr > td" : "_listItem_onMousedown",
"dblclick > li, tbody > tr > td" : "_listItem_onDoubleClick",
"click" : "_listBackground_onClick",
"click ul.collection-view, table.collection-view" : "_listBackground_onClick",
"keydown" : "_onKeydown"
},
// only used if Backbone.Courier is available
spawnMessages : {
"focus" : "focus"
},
//only used if Backbone.Courier is available
passMessages : { "*" : "." },
// viewOption definitions with default values.
initializationOptions : [
{ "collection" : null },
{ "modelView" : null },
{ "modelViewOptions" : {} },
{ "itemTemplate" : null },
{ "itemTemplateFunction" : null },
{ "selectable" : true },
{ "clickToSelect" : true },
{ "selectableModelsFilter" : null },
{ "visibleModelsFilter" : null },
{ "sortableModelsFilter" : null },
{ "selectMultiple" : false },
{ "clickToToggle" : false },
{ "processKeyEvents" : true },
{ "sortable" : false },
{ "sortableOptions" : null },
{ "reuseModelViews" : true },
{ "detachedRendering" : false },
{ "emptyListCaption" : null }
],
initialize : function( options ) {
Backbone.ViewOptions.add( this, "initializationOptions" ); // setup the ViewOptions functionality.
this.setOptions( options ); // and make use of any provided options
if( ! this.collection ) this.collection = new Backbone.Collection();
this._hasBeenRendered = false;
if( this._isBackboneCourierAvailable() ) {
Backbone.Courier.add( this );
}
this.$el.data( "view", this ); // needed for connected sortable lists
this.$el.addClass( "collection-view collection-list" ); // collection-list is in there for legacy purposes
if( this.selectable ) this.$el.addClass( "selectable" );
if( this.selectable && this.processKeyEvents )
this.$el.attr( "tabindex", 0 ); // so we get keyboard events
this.selectedItems = [];
this._updateItemTemplate();
if( this.collection )
this._registerCollectionEvents();
this.viewManager = new ChildViewContainer();
},
_onOptionsChanged : function( changedOptions, originalOptions ) {
var _this = this;
var rerender = false;
_.each( _.keys( changedOptions ), function( changedOptionKey ) {
var newVal = changedOptions[ changedOptionKey ];
var oldVal = originalOptions[ changedOptionKey ];
switch( changedOptionKey ) {
case "collection" :
if ( newVal !== oldVal ) {
_this.stopListening( oldVal );
_this._registerCollectionEvents();
}
break;
case "selectMultiple" :
if( ! newVal && _this.selectedItems.length > 1 )
_this.setSelectedModel( _.first( _this.selectedItems ), { by : "cid" } );
break;
case "selectable" :
if( ! newVal && _this.selectedItems.length > 0 )
_this.setSelectedModels( [] );
if( newVal && this.processKeyEvents ) _this.$el.attr( "tabindex", 0 ); // so we get keyboard events
else _this.$el.removeAttr( "tabindex", 0 );
break;
case "sortable" :
changedOptions.sortable ? _this._setupSortable() : _this.$el.sortable( "destroy" );
break;
case "selectableModelsFilter" :
_this.reapplyFilter( 'selectableModels' );
break;
case "sortableOptions" :
_this.$el.sortable( "destroy" );
_this._setupSortable();
break;
case "sortableModelsFilter" :
_this.reapplyFilter( 'sortableModels' );
break;
case "visibleModelsFilter" :
_this.reapplyFilter( 'visibleModels' );
break;
case "itemTemplate" :
_this._updateItemTemplate();
break;
case "processKeyEvents" :
if( newVal && this.selectable ) _this.$el.attr( "tabindex", 0 ); // so we get keyboard events
else _this.$el.removeAttr( "tabindex", 0 );
break;
case "modelView" :
//need to remove all old view instances
_this.viewManager.each( function( view ) {
_this.viewManager.remove( view );
// destroy the View itself
view.remove();
} );
break;
}
if( _.contains( kOptionsRequiringRerendering, changedOptionKey ) ) rerender = true;
} );
if( this._hasBeenRendered && rerender ) {
this.render();
}
},
setOption : function( optionName, optionValue ) { // now is merely a wrapper around backbone.viewOptions' setOptions()
var optionHash = {};
optionHash[ optionName ] = optionValue;
this.setOptions( optionHash );
},
getSelectedModel : function( options ) {
return this.selectedItems.length ? _.first( this.getSelectedModels( options ) ) : null;
},
getSelectedModels : function ( options ) {
var _this = this;
options = _.extend( {}, {
by : kDefaultReferenceBy
}, options );
var referenceBy = options.by;
var items = [];
switch( referenceBy ) {
case "id" :
_.each( this.selectedItems, function ( item ) {
items.push( _this.collection.get( item ).id );
} );
break;
case "cid" :
items = items.concat( this.selectedItems );
break;
case "offset" :
var curLineNumber = 0;
var itemElements = this._getVisibleItemEls();
itemElements.each( function() {
var thisItemEl = $( this );
if( thisItemEl.is( ".selected" ) )
items.push( curLineNumber );
curLineNumber++;
} );
break;
case "model" :
_.each( this.selectedItems, function ( item ) {
items.push( _this.collection.get( item ) );
} );
break;
case "view" :
_.each( this.selectedItems, function ( item ) {
items.push( _this.viewManager.findByModel( _this.collection.get( item ) ) );
} );
break;
default :
throw new Error( "Invalid referenceBy option: " + referenceBy );
break;
}
return items;
},
setSelectedModels : function( newSelectedItems, options ) {
if( ! _.isArray( newSelectedItems ) ) throw "Invalid parameter value";
if( ! this.selectable && newSelectedItems.length > 0 ) return; // used to throw error, but there are some circumstances in which a list can be selectable at times and not at others, don't want to have to worry about catching errors
options = _.extend( {}, {
silent : false,
by : kDefaultReferenceBy
}, options );
var referenceBy = options.by;
var newSelectedCids = [];
switch( referenceBy ) {
case "cid" :
newSelectedCids = newSelectedItems;
break;
case "id" :
this.collection.each( function( thisModel ) {
if( _.contains( newSelectedItems, thisModel.id ) ) newSelectedCids.push( thisModel.cid );
} );
break;
case "model" :
newSelectedCids = _.pluck( newSelectedItems, "cid" );
break;
case "view" :
_.each( newSelectedItems, function( item ) {
newSelectedCids.push( item.model.cid );
} );
break;
case "offset" :
var curLineNumber = 0;
var selectedItems = [];
var itemElements = this._getVisibleItemEls();
itemElements.each( function() {
var thisItemEl = $( this );
if( _.contains( newSelectedItems, curLineNumber ) )
newSelectedCids.push( thisItemEl.attr( "data-model-cid" ) );
curLineNumber++;
} );
break;
default :
throw new Error( "Invalid referenceBy option: " + referenceBy );
break;
}
var oldSelectedModels = this.getSelectedModels();
var oldSelectedCids = _.clone( this.selectedItems );
this.selectedItems = this._convertStringsToInts( newSelectedCids );
this._validateSelection();
var newSelectedModels = this.getSelectedModels();
if( ! this._containSameElements( oldSelectedCids, this.selectedItems ) )
{
this._addSelectedClassToSelectedItems( oldSelectedCids );
if( ! options.silent )
{
if( this._isBackboneCourierAvailable() ) {
this.spawn( "selectionChanged", {
selectedModels : newSelectedModels,
oldSelectedModels : oldSelectedModels
} );
} else this.trigger( "selectionChanged", newSelectedModels, oldSelectedModels );
}
this.updateDependentControls();
}
},
setSelectedModel : function( newSelectedItem, options ) {
if( ! newSelectedItem && newSelectedItem !== 0 )
this.setSelectedModels( [], options );
else
this.setSelectedModels( [ newSelectedItem ], options );
},
getView : function( reference, options ) {
options = _.extend( {}, {
by : kDefaultReferenceBy
}, options );
switch( options.by ) {
case "id" :
case "cid" :
var model = this.collection.get( reference ) || null;
return model && this.viewManager.findByModel( model );
break;
case "offset" :
var itemElements = this._getVisibleItemEls();
return $( itemElements.get( reference ) );
break;
case "model" :
return this.viewManager.findByModel( reference );
break;
default :
throw new Error( "Invalid referenceBy option: " + referenceBy );
break;
}
},
render : function() {
var _this = this;
this._hasBeenRendered = true;
if( this.selectable ) this._saveSelection();
var modelViewContainerEl;
// If collection view element is a table and it has a tbody
// within it, render the model views inside of the tbody
modelViewContainerEl = this._getContainerEl();
var oldViewManager = this.viewManager;
this.viewManager = new ChildViewContainer();
// detach each of our subviews that we have already created to represent models
// in the collection. We are going to re-use the ones that represent models that
// are still here, instead of creating new ones, so that we don't loose state
// information in the views.
oldViewManager.each( function( thisModelView ) {
// to boost performance, only detach those views that will be sticking around.
// we won't need the other ones later, so no need to detach them individually.
if( this.reuseModelViews && this.collection.get( thisModelView.model.cid ) ) {
thisModelView.$el.detach();
} else thisModelView.remove();
}, this );
modelViewContainerEl.empty();
var fragmentContainer;
if( this.detachedRendering )
fragmentContainer = document.createDocumentFragment();
this.collection.each( function( thisModel ) {
var thisModelView = oldViewManager.findByModelCid( thisModel.cid );
if( ! this.reuseModelViews || _.isUndefined( thisModelView ) ) {
// if the model view has not already been created on a
// previous render then create and initialize it now.
thisModelView = this._createNewModelView( thisModel, this._getModelViewOptions( thisModel ) );
}
this._insertAndRenderModelView( thisModelView, fragmentContainer || modelViewContainerEl );
}, this );
if( this.detachedRendering )
modelViewContainerEl.append( fragmentContainer );
if( this.sortable ) this._setupSortable();
this._showEmptyListCaptionIfAppropriate();
if( this._isBackboneCourierAvailable() )
this.spawn( "render" );
else this.trigger( "render" );
if( this.selectable ) {
this._restoreSelection();
this.updateDependentControls();
}
this.forceRerenderOnNextSortEvent = false;
},
_showEmptyListCaptionIfAppropriate : function ( ) {
this._removeEmptyListCaption();
if( this.emptyListCaption ) {
var visibleEls = this._getVisibleItemEls();
if( visibleEls.length === 0 ) {
var emptyListString;
if( _.isFunction( this.emptyListCaption ) )
emptyListString = this.emptyListCaption();
else
emptyListString = this.emptyListCaption;
var $emptyListCaptionEl;
var $varEl = $( "<var class='empty-list-caption'>" + emptyListString + "</var>" );
// need to wrap the empty caption to make it fit the rendered list structure (either with an li or a tr td)
if( this._isRenderedAsList() )
$emptyListCaptionEl = $varEl.wrapAll( "<li class='not-sortable'></li>" ).parent().css( kStylesForEmptyListCaption );
else
$emptyListCaptionEl = $varEl.wrapAll( "<tr class='not-sortable'><td colspan='1000'></td></tr>" ).parent().parent().css( kStylesForEmptyListCaption );
this._getContainerEl().append( $emptyListCaptionEl );
}
}
},
_removeEmptyListCaption : function( ) {
if( this._isRenderedAsList() )
this._getContainerEl().find( "> li > var.empty-list-caption" ).parent().remove();
else
this._getContainerEl().find( "> tr > td > var.empty-list-caption" ).parent().parent().remove();
},
// Render a single model view in container object "parentElOrDocumentFragment", which is either
// a documentFragment or a jquery object. optional arg atIndex is not support for document fragments.
_insertAndRenderModelView : function( modelView, parentElOrDocumentFragment, atIndex ) {
var thisModelViewWrapped = this._wrapModelView( modelView );
if( parentElOrDocumentFragment.nodeType === 11 ) // if we are inserting into a document fragment, we need to use the DOM appendChild method
parentElOrDocumentFragment.appendChild( thisModelViewWrapped.get( 0 ) );
else {
var numberOfModelViewsCurrentlyInDOM = parentElOrDocumentFragment.children().length;
if( ! _.isUndefined( atIndex ) && atIndex >= 0 && atIndex < numberOfModelViewsCurrentlyInDOM )
// note this.collection.length might be greater than parentElOrDocumentFragment.children().length here
parentElOrDocumentFragment.children().eq( atIndex ).before( thisModelViewWrapped );
else {
// if we are attempting to insert a modelView in an position that is beyond what is currently in the
// DOM, then make a note that we need to re-render the collection view on the next sort event. If we dont
// force this re-render, we can end up with modelViews in the wrong order when the collection defines
// a comparator and multiple models are added at once. See https://github.com/rotundasoftware/backbone.collectionView/issues/69
if( ! _.isUndefined( atIndex ) && atIndex > numberOfModelViewsCurrentlyInDOM ) this.forceRerenderOnNextSortEvent = true;
parentElOrDocumentFragment.append( thisModelViewWrapped );
}
}
this.viewManager.add( modelView );
// we have to render the modelView after it has been put in context, as opposed to in the
// initialize function of the modelView, because some rendering might be dependent on
// the modelView's context in the DOM tree. For example, if the modelView stretch()'s itself,
// it must be in full context in the DOM tree or else the stretch will not behave as intended.
var renderResult = modelView.render();
// return false from the view's render function to hide this item
if( renderResult === false ) {
thisModelViewWrapped.hide();
thisModelViewWrapped.addClass( "not-visible" );
}
var hideThisModelView = false;
if( _.isFunction( this.visibleModelsFilter ) )
hideThisModelView = ! this.visibleModelsFilter( modelView.model );
if( thisModelViewWrapped.children().length === 1 )
thisModelViewWrapped.toggle( ! hideThisModelView );
else modelView.$el.toggle( ! hideThisModelView );
thisModelViewWrapped.toggleClass( "not-visible", hideThisModelView );
if( ! hideThisModelView && this.emptyListCaption ) this._removeEmptyListCaption();
},
updateDependentControls : function() {
if( this._isBackboneCourierAvailable() ) {
this.spawn( "updateDependentControls", {
selectedModels : this.getSelectedModels()
} );
} else this.trigger( "updateDependentControls", this.getSelectedModels() );
},
// Override `Backbone.View.remove` to also destroy all Views in `viewManager`
remove : function() {
this.viewManager.each( function( view ) {
view.remove();
} );
Backbone.View.prototype.remove.apply( this, arguments );
},
reapplyFilter : function( whichFilter ) {
var _this = this;
if( ! _.contains( [ "selectableModels", "sortableModels", "visibleModels" ], whichFilter ) ) {
throw new Error( "Invalid filter identifier supplied to reapplyFilter: " + whichFilter );
}
switch( whichFilter ) {
case "visibleModels":
_this.viewManager.each( function( thisModelView ) {
var notVisible = _this.visibleModelsFilter && ! _this.visibleModelsFilter.call( _this, thisModelView.model );
thisModelView.$el.toggleClass( "not-visible", notVisible );
if( _this._modelViewHasWrapperLI( thisModelView ) ) {
thisModelView.$el.closest( "li" ).toggleClass( "not-visible", notVisible ).toggle( ! notVisible );
} else thisModelView.$el.toggle( ! notVisible );
} );
this._showEmptyListCaptionIfAppropriate();
break;
case "sortableModels":
_this.$el.sortable( "destroy" );
_this.viewManager.each( function( thisModelView ) {
var notSortable = _this.sortableModelsFilter && ! _this.sortableModelsFilter.call( _this, thisModelView.model );
thisModelView.$el.toggleClass( "not-sortable", notSortable );
if( _this._modelViewHasWrapperLI( thisModelView ) ) {
thisModelView.$el.closest( "li" ).toggleClass( "not-sortable", notSortable );
}
} );
_this._setupSortable();
break;
case "selectableModels":
_this.viewManager.each( function( thisModelView ) {
var notSelectable = _this.selectableModelsFilter && ! _this.selectableModelsFilter.call( _this, thisModelView.model );
thisModelView.$el.toggleClass( "not-selectable", notSelectable );
if( _this._modelViewHasWrapperLI( thisModelView ) ) {
thisModelView.$el.closest( "li" ).toggleClass( "not-selectable", notSelectable );
}
} );
_this._validateSelection();
break;
}
},
// A method to remove the view relating to model.
_removeModelView : function( modelView ) {
if( this.selectable ) this._saveSelection();
this.viewManager.remove( modelView ); // Remove the view from the viewManager
if( this._modelViewHasWrapperLI( modelView ) ) modelView.$el.parent().remove(); // Remove the li wrapper from the DOM
modelView.remove(); // Remove the view from the DOM and stop listening to events
if( this.selectable ) this._restoreSelection();
this._showEmptyListCaptionIfAppropriate();
},
_validateSelectionAndRender : function() {
this._validateSelection();
this.render();
},
_registerCollectionEvents : function() {
this.listenTo( this.collection, "add", function( model ) {
var modelView;
if( this._hasBeenRendered ) {
modelView = this._createNewModelView( model, this._getModelViewOptions( model ) );
this._insertAndRenderModelView( modelView, this._getContainerEl(), this.collection.indexOf( model ) );
}
if( this._isBackboneCourierAvailable() )
this.spawn( "add", modelView );
else this.trigger( "add", modelView );
} );
this.listenTo( this.collection, "remove", function( model ) {
var modelView;
if( this._hasBeenRendered ) {
modelView = this.viewManager.findByModelCid( model.cid );
this._removeModelView( modelView );
}
if( this._isBackboneCourierAvailable() )
this.spawn( "remove" );
else this.trigger( "remove" );
} );
this.listenTo( this.collection, "reset", function() {
if( this._hasBeenRendered ) this.render();
if( this._isBackboneCourierAvailable() )
this.spawn( "reset" );
else this.trigger( "reset" );
} );
// we should not be listening to change events on the model as a default behavior. the models
// should be responsible for re-rendering themselves if necessary, and if the collection does
// also need to re-render as a result of a model change, this should be handled by overriding
// this method. by default the collection view should not re-render in response to model changes
// this.listenTo( this.collection, "change", function( model ) {
// if( this._hasBeenRendered ) this.viewManager.findByModel( model ).render();
// if( this._isBackboneCourierAvailable() )
// this.spawn( "change", { model : model } );
// } );
this.listenTo( this.collection, "sort", function( collection, options ) {
if( this._hasBeenRendered && ( options.add !== true || this.forceRerenderOnNextSortEvent ) ) this.render();
if( this._isBackboneCourierAvailable() )
this.spawn( "sort" );
else this.trigger( "sort" );
} );
},
_getContainerEl : function() {
if ( this._isRenderedAsTable() ) {
// not all tables have a tbody, so we test
var tbody = this.$el.find( "> tbody" );
if ( tbody.length > 0 )
return tbody;
}
return this.$el;
},
_getClickedItemId : function( theEvent ) {
var clickedItemId = null;
// important to use currentTarget as opposed to target, since we could be bubbling
// an event that took place within another collectionList
var clickedItemEl = $( theEvent.currentTarget );
if( clickedItemEl.closest( ".collection-view" ).get(0) !== this.$el.get(0) ) return;
// determine which list item was clicked. If we clicked in the blank area
// underneath all the elements, we want to know that too, since in this
// case we will want to deselect all elements. so check to see if the clicked
// DOM element is the list itself to find that out.
var clickedItem = clickedItemEl.closest( "[data-model-cid]" );
if( clickedItem.length > 0 )
{
clickedItemId = clickedItem.attr( "data-model-cid" );
if( $.isNumeric( clickedItemId ) ) clickedItemId = parseInt( clickedItemId, 10 );
}
return clickedItemId;
},
_updateItemTemplate : function() {
var itemTemplateHtml;
if( this.itemTemplate )
{
if( $( this.itemTemplate ).length === 0 )
throw "Could not find item template from selector: " + this.itemTemplate;
itemTemplateHtml = $( this.itemTemplate ).html();
}
else
itemTemplateHtml = this.$( ".item-template" ).html();
if( itemTemplateHtml ) this.itemTemplateFunction = _.template( itemTemplateHtml );
},
_validateSelection : function() {
// note can't use the collection's proxy to underscore because "cid" is not an attribute,
// but an element of the model object itself.
var modelReferenceIds = _.pluck( this.collection.models, "cid" );
this.selectedItems = _.intersection( modelReferenceIds, this.selectedItems );
if( _.isFunction( this.selectableModelsFilter ) )
{
this.selectedItems = _.filter( this.selectedItems, function( thisItemId ) {
return this.selectableModelsFilter.call( this, this.collection.get( thisItemId ) );
}, this );
}
},
_saveSelection : function() {
// save the current selection. use restoreSelection() to restore the selection to the state it was in the last time saveSelection() was called.
if( ! this.selectable ) throw "Attempt to save selection on non-selectable list";
this.savedSelection = {
items : _.clone( this.selectedItems ),
offset : this.getSelectedModel( { by : "offset" } )
};
},
_restoreSelection : function() {
if( ! this.savedSelection ) throw "Attempt to restore selection but no selection has been saved!";
// reset selectedItems to empty so that we "redraw" all "selected" classes
// when we set our new selection. We do this because it is likely that our
// contents have been refreshed, and we have thus lost all old "selected" classes.
this.setSelectedModels( [], { silent : true } );
if( this.savedSelection.items.length > 0 )
{
// first try to restore the old selected items using their reference ids.
this.setSelectedModels( this.savedSelection.items, { by : "cid", silent : true } );
// all the items with the saved reference ids have been removed from the list.
// ok. try to restore the selection based on the offset that used to be selected.
// this is the expected behavior after a item is deleted from a list (i.e. select
// the line that immediately follows the deleted line).
if( this.selectedItems.length === 0 )
this.setSelectedModel( this.savedSelection.offset, { by : "offset" } );
// Trigger a selection changed if the previously selected items were not all found
if (this.selectedItems.length !== this.savedSelection.items.length)
{
if( this._isBackboneCourierAvailable() ) {
this.spawn( "selectionChanged", {
selectedModels : this.getSelectedModels(),
oldSelectedModels : []
} );
} else this.trigger( "selectionChanged", this.getSelectedModels(), [] );
}
}
},
_addSelectedClassToSelectedItems : function( oldItemsIdsWithSelectedClass ) {
if( _.isUndefined( oldItemsIdsWithSelectedClass ) ) oldItemsIdsWithSelectedClass = [];
// oldItemsIdsWithSelectedClass is used for optimization purposes only. If this info is supplied then we
// only have to add / remove the "selected" class from those items that "selected" state has changed.
var itemsIdsFromWhichSelectedClassNeedsToBeRemoved = oldItemsIdsWithSelectedClass;
itemsIdsFromWhichSelectedClassNeedsToBeRemoved = _.without( itemsIdsFromWhichSelectedClassNeedsToBeRemoved, this.selectedItems );
_.each( itemsIdsFromWhichSelectedClassNeedsToBeRemoved, function( thisItemId ) {
this._getContainerEl().find( "[data-model-cid=" + thisItemId + "]" ).removeClass( "selected" );
if( this._isRenderedAsList() ) {
this._getContainerEl().find( "li[data-model-cid=" + thisItemId + "] > *" ).removeClass( "selected" );
}
}, this );
var itemsIdsFromWhichSelectedClassNeedsToBeAdded = this.selectedItems;
itemsIdsFromWhichSelectedClassNeedsToBeAdded = _.without( itemsIdsFromWhichSelectedClassNeedsToBeAdded, oldItemsIdsWithSelectedClass );
_.each( itemsIdsFromWhichSelectedClassNeedsToBeAdded, function( thisItemId ) {
this._getContainerEl().find( "[data-model-cid=" + thisItemId + "]" ).addClass( "selected" );
if( this._isRenderedAsList() ) {
this._getContainerEl().find( "li[data-model-cid=" + thisItemId + "] > *" ).addClass( "selected" );
}
}, this );
},
_reorderCollectionBasedOnHTML : function() {
var _this = this;
this._getContainerEl().children().each( function() {
var thisModelCid = $( this ).attr( "data-model-cid" );
if( thisModelCid )
{
// remove the current model and then add it back (at the end of the collection).
// When we are done looping through all models, they will be in the correct order.
var thisModel = _this.collection.get( thisModelCid );
if( thisModel )
{
_this.collection.remove( thisModel, { silent : true } );
_this.collection.add( thisModel, { silent : true, sort : ! _this.collection.comparator } );
}
}
} );
if( this._isBackboneCourierAvailable() ) this.spawn( "reorder" );
else this.collection.trigger( "reorder" );
if( this.collection.comparator ) this.collection.sort();
},
_getModelViewConstructor : function( thisModel ) {
return this.modelView || mDefaultModelViewConstructor;
},
_getModelViewOptions : function( thisModel ) {
var modelViewOptions = this.modelViewOptions;
if( _.isFunction( modelViewOptions ) ) modelViewOptions = modelViewOptions( thisModel );
return _.extend( { model : thisModel }, modelViewOptions );
},
_createNewModelView : function( model, modelViewOptions ) {
var modelViewConstructor = this._getModelViewConstructor( model );
if( _.isUndefined( modelViewConstructor ) ) throw "Could not find modelView constructor for model";
var newModelView = new( modelViewConstructor )( modelViewOptions );
newModelView.collectionListView = newModelView.collectionView = this; // collectionListView for legacy
return newModelView;
},
_wrapModelView : function( modelView ) {
var _this = this;
// we use items client ids as opposed to real ids, since we may not have a representation
// of these models on the server
var modelViewWrapperEl;
if( this._isRenderedAsTable() ) {
// if we are rendering the collection in a table, the template $el is a tr so we just need to set the data-model-cid
modelViewWrapperEl = modelView.$el;
modelView.$el.attr( "data-model-cid", modelView.model.cid );
}
else if( this._isRenderedAsList() ) {
// if we are rendering the collection in a list, we need wrap each item in an <li></li> (if its not already an <li>)
// and set the data-model-cid
if( modelView.$el.is( "li" ) ) {
modelViewWrapperEl = modelView.$el;
modelView.$el.attr( "data-model-cid", modelView.model.cid );
} else {
modelViewWrapperEl = modelView.$el.wrapAll( "<li data-model-cid='" + modelView.model.cid + "'></li>" ).parent();
}
}
if( _.isFunction( this.sortableModelsFilter ) )
if( ! this.sortableModelsFilter.call( _this, modelView.model ) ) {
modelViewWrapperEl.addClass( "not-sortable" );
modelView.$el.addClass( "not-selectable" );
}
if( _.isFunction( this.selectableModelsFilter ) )
if( ! this.selectableModelsFilter.call( _this, modelView.model ) ) {
modelViewWrapperEl.addClass( "not-selectable" );
modelView.$el.addClass( "not-selectable" );
}
return modelViewWrapperEl;
},
_convertStringsToInts : function( theArray ) {
return _.map( theArray, function( thisEl ) {
if( ! _.isString( thisEl ) ) return thisEl;
var thisElAsNumber = parseInt( thisEl, 10 );
return( thisElAsNumber == thisEl ? thisElAsNumber : thisEl );
} );
},
_containSameElements : function( arrayA, arrayB ) {
if( arrayA.length != arrayB.length ) return false;
var intersectionSize = _.intersection( arrayA, arrayB ).length;
return intersectionSize == arrayA.length; // and must also equal arrayB.length, since arrayA.length == arrayB.length
},
_isRenderedAsTable : function() {
return this.$el.prop( "tagName" ).toLowerCase() === "table";
},
_isRenderedAsList : function() {
return ! this._isRenderedAsTable();
},
_modelViewHasWrapperLI : function( modelView ) {
return this._isRenderedAsList() && ! modelView.$el.is( "li" );
},
// Returns the wrapper HTML element for each visible modelView.
// When rendering in a table context, the returned elements are the $el of each modelView.
// When rendering in a list context,
// If the $el of the modelView is an <li>, the returned elements are the $el of each modelView.
// Otherwise, the returned elements are the <li>'s the collectionView wrapped around each modelView $el.
_getVisibleItemEls : function() {
var itemElements = [];
itemElements = this._getContainerEl().find( "> [data-model-cid]:not(.not-visible)" );
return itemElements;
},
_charCodes : {
upArrow : 38,
downArrow : 40
},
_isBackboneCourierAvailable : function() {
return !_.isUndefined( Backbone.Courier );
},
_setupSortable : function() {
var sortableOptions = _.extend( {
axis : "y",
distance : 10,
forcePlaceholderSize : true,
items : this._isRenderedAsTable() ? "> tbody > tr:not(.not-sortable)" : "> li:not(.not-sortable)",
start : _.bind( this._sortStart, this ),
change : _.bind( this._sortChange, this ),
stop : _.bind( this._sortStop, this ),
receive : _.bind( this._receive, this ),
over : _.bind( this._over, this )
}, _.result( this, "sortableOptions" ) );
this.$el = this.$el.sortable( sortableOptions );
//this.$el.sortable( "enable" ); // in case it was disabled previously
},
_sortStart : function( event, ui ) {
var modelBeingSorted = this.collection.get( ui.item.attr( "data-model-cid" ) );
if( this._isBackboneCourierAvailable() )
this.spawn( "sortStart", { modelBeingSorted : modelBeingSorted } );
else this.trigger( "sortStart", modelBeingSorted );
},
_sortChange : function( event, ui ) {
var modelBeingSorted = this.collection.get( ui.item.attr( "data-model-cid" ) );
if( this._isBackboneCourierAvailable() )
this.spawn( "sortChange", { modelBeingSorted : modelBeingSorted } );
else this.trigger( "sortChange", modelBeingSorted );
},
_sortStop : function( event, ui ) {
var modelBeingSorted = this.collection.get( ui.item.attr( "data-model-cid" ) );
var modelViewContainerEl = this._getContainerEl();
var newIndex = modelViewContainerEl.children().index( ui.item );
if( newIndex == -1 && modelBeingSorted ) {
// the element was removed from this list. can happen if this sortable is connected
// to another sortable, and the item was dropped into the other sortable.
this.collection.remove( modelBeingSorted );
}
if( ! modelBeingSorted ) return; // something is wacky. we don't mess with this case, preferring to guarantee that we can always provide a reference to the model
this._reorderCollectionBasedOnHTML();
this.updateDependentControls();
if( this._isBackboneCourierAvailable() )
this.spawn( "sortStop", { modelBeingSorted : modelBeingSorted, newIndex : newIndex } );
else this.trigger( "sortStop", modelBeingSorted, newIndex );
},
_receive : function( event, ui ) {
var senderListEl = ui.sender;
var senderCollectionListView = senderListEl.data( "view" );
if( ! senderCollectionListView || ! senderCollectionListView.collection ) return;
var newIndex = this._getContainerEl().children().index( ui.item );
var modelReceived = senderCollectionListView.collection.get( ui.item.attr( "data-model-cid" ) );
senderCollectionListView.collection.remove( modelReceived );
this.collection.add( modelReceived, { at : newIndex } );
modelReceived.collection = this.collection; // otherwise will not get properly set, since modelReceived.collection might already have a value.
this.setSelectedModel( modelReceived );
},
_over : function( event, ui ) {
// when an item is being dragged into the sortable,
// hide the empty list caption if it exists
this._getContainerEl().find( "> var.empty-list-caption" ).hide();
},
_onKeydown : function( event ) {
if( ! this.processKeyEvents ) return true;
var trap = false;
if( this.getSelectedModels( { by : "offset" } ).length == 1 )
{
// need to trap down and up arrows or else the browser
// will end up scrolling a autoscroll div.
var currentOffset = this.getSelectedModel( { by : "offset" } );
if( event.which === this._charCodes.upArrow && currentOffset !== 0 )
{
this.setSelectedModel( currentOffset - 1, { by : "offset" } );
trap = true;
}
else if( event.which === this._charCodes.downArrow && currentOffset !== this.collection.length - 1 )
{
this.setSelectedModel( currentOffset + 1, { by : "offset" } );
trap = true;
}
}
return ! trap;
},
_listItem_onMousedown : function( theEvent ) {
var clickedItemId = this._getClickedItemId( theEvent );
if( clickedItemId ) {
var clickedModel = this.collection.get( clickedItemId );
if( this._isBackboneCourierAvailable() ) {
var data = {
clickedModel : clickedModel,
metaKeyPressed : theEvent.ctrlKey || theEvent.metaKey
};
_.each( [ 'preventDefault', 'stopPropagation', 'stopImmediatePropagation' ], function( thisMethod ) {
data[ thisMethod ] = function() {
theEvent[ thisMethod ]();
};
} );
this.spawn( "click", data );
}
else this.trigger( "click", clickedModel );
}
if( ! this.selectable || ! this.clickToSelect ) return;
if( clickedItemId )
{
// Exit if an unselectable item was clicked
if( _.isFunction( this.selectableModelsFilter ) &&
! this.selectableModelsFilter.call( this, this.collection.get( clickedItemId ) ) )
{
return;
}
// a selectable list item was clicked
if( this.selectMultiple && theEvent.shiftKey )
{
var firstSelectedItemIndex = -1;
if( this.selectedItems.length > 0 )
{
this.collection.find( function( thisItemModel ) {
firstSelectedItemIndex++;
// exit when we find our first selected element
return _.contains( this.selectedItems, thisItemModel.cid );
}, this );
}
var clickedItemIndex = -1;
this.collection.find( function( thisItemModel ) {
clickedItemIndex++;
// exit when we find the clicked element
return thisItemModel.cid == clickedItemId;
}, this );
var shiftKeyRootSelectedItemIndex = firstSelectedItemIndex == -1 ? clickedItemIndex : firstSelectedItemIndex;
var minSelectedItemIndex = Math.min( clickedItemIndex, shiftKeyRootSelectedItemIndex );
var maxSelectedItemIndex = Math.max( clickedItemIndex, shiftKeyRootSelectedItemIndex );
var newSelectedItems = [];
for( var thisIndex = minSelectedItemIndex; thisIndex <= maxSelectedItemIndex; thisIndex ++ )
newSelectedItems.push( this.collection.at( thisIndex ).cid );
this.setSelectedModels( newSelectedItems, { by : "cid" } );
// shift clicking will usually highlight selectable text, which we do not want.
// this is a cross browser (hopefully) snippet that deselects all text selection.
if( document.selection && document.selection.empty )
document.selection.empty();
else if(window.getSelection) {
var sel = window.getSelection();
if( sel && sel.removeAllRanges )
sel.removeAllRanges();
}
}
else if( ( this.selectMultiple || _.contains( this.selectedItems, clickedItemId ) ) && ( this.clickToToggle || theEvent.metaKey || theEvent.ctrlKey ) )
{
if( _.contains( this.selectedItems, clickedItemId ) )
this.setSelectedModels( _.without( this.selectedItems, clickedItemId ), { by : "cid" } );
else this.setSelectedModels( _.union( this.selectedItems, [clickedItemId] ), { by : "cid" } );
}
else
this.setSelectedModels( [ clickedItemId ], { by : "cid" } );
}
else
// the blank area of the list was clicked
this.setSelectedModels( [] );
},
_listItem_onDoubleClick : function( theEvent ) {
var clickedItemId = this._getClickedItemId( theEvent );
if( clickedItemId )
{
var clickedModel = this.collection.get( clickedItemId );
if( this._isBackboneCourierAvailable() )
this.spawn( "doubleClick", { clickedModel : clickedModel, metaKeyPressed : theEvent.ctrlKey || theEvent.metaKey } );
else this.trigger( "doubleClick", clickedModel );
}
},
_listBackground_onClick : function( theEvent ) {
if( ! this.selectable || ! this.clickToSelect ) return;
if( ! $( theEvent.target ).is( ".collection-view" ) ) return;
this.setSelectedModels( [] );
}
}, {
setDefaultModelViewConstructor : function( theConstructor ) {
mDefaultModelViewConstructor = theConstructor;
}
});
/*
* Backbone.ViewOptions, v0.2.4
* Copyright (c)2014 Rotunda Software, LLC.
* Distributed under MIT license
* http://github.com/rotundasoftware/backbone.viewOptions
*/
Backbone.ViewOptions = {};
Backbone.ViewOptions.add = function( view, optionsDeclarationsProperty ) {
if( _.isUndefined( optionsDeclarationsProperty ) ) optionsDeclarationsProperty = "options";
// ****************** Public methods added to view ******************
view.setOptions = function( options ) {
var _this = this;
var optionsThatWereChanged = {};
var optionsThatWereChangedPreviousValues = {};
var optionDeclarations = _.result( this, optionsDeclarationsProperty );
if( ! _.isUndefined( optionDeclarations ) ) {
var normalizedOptionDeclarations = _normalizeOptionDeclarations( optionDeclarations );
_.each( normalizedOptionDeclarations, function( thisOptionProperties, thisOptionName ) {
var thisOptionRequired = thisOptionProperties.required;
var thisOptionDefaultValue = thisOptionProperties.defaultValue;
if( thisOptionRequired ) {
// note we do not throw an error if a required option is not supplied, but it is
// found on the object itself (due to a prior call of view.setOptions, most likely)
if( ( ! options || ! _.contains( _.keys( options ), thisOptionName ) ) && _.isUndefined( _this[ thisOptionName ] ) )
throw new Error( "Required option \"" + thisOptionName + "\" was not supplied." );
if( options && _.contains( _.keys( options ), thisOptionName ) && _.isUndefined( options[ thisOptionName ] ) )
throw new Error( "Required option \"" + thisOptionName + "\" can not be set to undefined." );
}
// attach the supplied value of this option, or the appropriate default value, to the view object
if( options && thisOptionName in options && ! _.isUndefined( options[ thisOptionName ] ) ) {
var oldValue = _this[ thisOptionName ];
var newValue = options[ thisOptionName ];
// if this option already exists on the view, and the new value is different,
// make a note that we will be changing it
if( ! _.isUndefined( oldValue ) && oldValue !== newValue ) {
optionsThatWereChangedPreviousValues[ thisOptionName ] = oldValue;
optionsThatWereChanged[ thisOptionName ] = newValue;
}
_this[ thisOptionName ] = newValue;
// note we do NOT delete the option off the options object here so that
// multiple views can be passed the same options object without issue.
}
else if( _.isUndefined( _this[ thisOptionName ] ) ) {
// note defaults do not write over any existing properties on the view itself.
_this[ thisOptionName ] = thisOptionDefaultValue;
}
} );
}
if( _.keys( optionsThatWereChanged ).length > 0 ) {
if( _.isFunction( _this.onOptionsChanged ) )
_this.onOptionsChanged( optionsThatWereChanged, optionsThatWereChangedPreviousValues );
else if( _.isFunction( _this._onOptionsChanged ) )
_this._onOptionsChanged( optionsThatWereChanged, optionsThatWereChangedPreviousValues );
}
};
view.getOptions = function() {
var optionDeclarations = _.result( this, optionsDeclarationsProperty );
if( _.isUndefined( optionDeclarations ) ) return {};
var normalizedOptionDeclarations = _normalizeOptionDeclarations( optionDeclarations );
var optionsNames = _.keys( normalizedOptionDeclarations );
return _.pick( this, optionsNames );
};
};
// ****************** Private Utility Functions ******************
function _normalizeOptionDeclarations( optionDeclarations ) {
// convert our short-hand option syntax (with exclamation marks, etc.)
// to a simple array of standard option declaration objects.
var normalizedOptionDeclarations = {};
if( ! _.isArray( optionDeclarations ) ) throw new Error( "Option declarations must be an array." );
_.each( optionDeclarations, function( thisOptionDeclaration ) {
var thisOptionName, thisOptionRequired, thisOptionDefaultValue;
thisOptionRequired = false;
thisOptionDefaultValue = undefined;
if( _.isString( thisOptionDeclaration ) )
thisOptionName = thisOptionDeclaration;
else if( _.isObject( thisOptionDeclaration ) ) {
thisOptionName = _.first( _.keys( thisOptionDeclaration ) );
if( _.isFunction( thisOptionDeclaration[ thisOptionName ] ) )
thisOptionDefaultValue = thisOptionDeclaration[ thisOptionName ];
else
thisOptionDefaultValue = _.clone( thisOptionDeclaration[ thisOptionName ] );
}
else throw new Error( "Each element in the option declarations array must be either a string or an object." );
if( thisOptionName[ thisOptionName.length - 1 ] === "!" ) {
thisOptionRequired = true;
thisOptionName = thisOptionName.slice( 0, thisOptionName.length - 1 );
}
normalizedOptionDeclarations[ thisOptionName ] = normalizedOptionDeclarations[ thisOptionName ] || {};
normalizedOptionDeclarations[ thisOptionName ].required = thisOptionRequired;
if( ! _.isUndefined( thisOptionDefaultValue ) ) normalizedOptionDeclarations[ thisOptionName ].defaultValue = thisOptionDefaultValue;
} );
return normalizedOptionDeclarations;
}
// Backbone.BabySitter
// -------------------
// v0.0.6
//
// Copyright (c)2013 Derick Bailey, Muted Solutions, LLC.
// Distributed under MIT license
//
// http://github.com/babysitterjs/backbone.babysitter
// Backbone.ChildViewContainer
// ---------------------------
//
// Provide a container to store, retrieve and
// shut down child views.
ChildViewContainer = (function(Backbone, _){
// Container Constructor
// ---------------------
var Container = function(views){
this._views = {};
this._indexByModel = {};
this._indexByCustom = {};
this._updateLength();
_.each(views, this.add, this);
};
// Container Methods
// -----------------
_.extend(Container.prototype, {
// Add a view to this container. Stores the view
// by `cid` and makes it searchable by the model
// cid (and model itself). Optionally specify
// a custom key to store an retrieve the view.
add: function(view, customIndex){
var viewCid = view.cid;
// store the view
this._views[viewCid] = view;
// index it by model
if (view.model){
this._indexByModel[view.model.cid] = viewCid;
}
// index by custom
if (customIndex){
this._indexByCustom[customIndex] = viewCid;
}
this._updateLength();
},
// Find a view by the model that was attached to
// it. Uses the model's `cid` to find it.
findByModel: function(model){
return this.findByModelCid(model.cid);
},
// Find a view by the `cid` of the model that was attached to
// it. Uses the model's `cid` to find the view `cid` and
// retrieve the view using it.
findByModelCid: function(modelCid){
var viewCid = this._indexByModel[modelCid];
return this.findByCid(viewCid);
},
// Find a view by a custom indexer.
findByCustom: function(index){
var viewCid = this._indexByCustom[index];
return this.findByCid(viewCid);
},
// Find by index. This is not guaranteed to be a
// stable index.
findByIndex: function(index){
return _.values(this._views)[index];
},
// retrieve a view by it's `cid` directly
findByCid: function(cid){
return this._views[cid];
},
findIndexByCid : function( cid ) {
var index = -1;
var view = _.find( this._views, function ( view ) {
index++;
if( view.model.cid == cid )
return view;
} );
return ( view ) ? index : -1;
},
// Remove a view
remove: function(view){
var viewCid = view.cid;
// delete model index
if (view.model){
delete this._indexByModel[view.model.cid];
}
// delete custom index
_.any(this._indexByCustom, function(cid, key) {
if (cid === viewCid) {
delete this._indexByCustom[key];
return true;
}
}, this);
// remove the view from the container
delete this._views[viewCid];
// update the length
this._updateLength();
},
// Call a method on every view in the container,
// passing parameters to the call method one at a
// time, like `function.call`.
call: function(method){
this.apply(method, _.tail(arguments));
},
// Apply a method on every view in the container,
// passing parameters to the call method one at a
// time, like `function.apply`.
apply: function(method, args){
_.each(this._views, function(view){
if (_.isFunction(view[method])){
view[method].apply(view, args || []);
}
});
},
// Update the `.length` attribute on this container
_updateLength: function(){
this.length = _.size(this._views);
}
});
// Borrowing this code from Backbone.Collection:
// http://backbonejs.org/docs/backbone.html#section-106
//
// Mix in methods from Underscore, for iteration, and other
// collection related features.
var methods = ['forEach', 'each', 'map', 'find', 'detect', 'filter',
'select', 'reject', 'every', 'all', 'some', 'any', 'include',
'contains', 'invoke', 'toArray', 'first', 'initial', 'rest',
'last', 'without', 'isEmpty', 'pluck'];
_.each(methods, function(method) {
Container.prototype[method] = function() {
var views = _.values(this._views);
var args = [views].concat(_.toArray(arguments));
return _[method].apply(_, args);
};
});
// return the public API
return Container;
})(Backbone, _);
return Backbone.CollectionView;
} ) );
================================================
FILE: assets/js/builder/vendor/backbone.trackit.js
================================================
/**
* backbone.trackit - 0.1.0
*
* The MIT License
* Copyright (c) 2013 The New York Times, CMS Group, Matthew DeLambo <delambo@gmail.com>
*
* @since 7.4.0 Added support for deep models (attributes that are objects themselves).
*/
(function() {
// Unsaved Record Keeping
// ----------------------
// Collection of all models in an app that have unsaved changes.
var unsavedModels = [];
// If the given model has unsaved changes then add it to
// the `unsavedModels` collection, otherwise remove it.
var updateUnsavedModels = function(model) {
if (!_.isEmpty(model._unsavedChanges)) {
if (!_.findWhere(unsavedModels, {cid:model.cid})) unsavedModels.push(model);
} else {
unsavedModels = _.filter(unsavedModels, function(m) { return model.cid != m.cid; });
}
};
// Unload Handlers
// ---------------
// Helper which returns a prompt message for an unload handler.
// Uses the given function name (one of the callback names
// from the `model.unsaved` configuration hash) to evaluate
// whether a prompt is needed/returned.
var getPrompt = function(fnName) {
var prompt, args = _.rest(arguments);
// Evaluate and return a boolean result. The given `fn` may be a
// boolean value, a function, or the name of a function on the model.
var evaluateModelFn = function(model, fn) {
if (_.isBoolean(fn)) return fn;
return (_.isString(fn) ? model[fn] : fn).apply(model, args);
};
_.each(unsavedModels, function(model) {
if (!prompt && evaluateModelFn(model, model._unsavedConfig[fnName]))
prompt = model._unsavedConfig.prompt;
});
return prompt;
};
// Wrap Backbone.History.navigate so that in-app routing
// (`router.navigate('/path')`) can be intercepted with a
// confirmation if there are any unsaved models.
Backbone.History.prototype.navigate = _.wrap(Backbone.History.prototype.navigate, function(oldNav, fragment, options) {
var prompt = getPrompt('unloadRouterPrompt', fragment, options);
if (prompt) {
if (confirm(prompt + ' \n\nAre you sure you want to leave this page?')) {
oldNav.call(this, fragment, options);
}
} else {
oldNav.call(this, fragment, options);
}
});
// Create a browser unload handler which is triggered
// on the refresh, back, or forward button.
window.onbeforeunload = function(e) {
return getPrompt('unloadWindowPrompt', e);
};
// Backbone.Model API
// ------------------
_.extend(Backbone.Model.prototype, {
unsaved: {},
_trackingChanges: false,
_originalAttrs: {},
_unsavedChanges: {},
// Opt in to tracking attribute changes
// between saves.
startTracking: function() {
this._unsavedConfig = _.extend({}, {
prompt: 'You have unsaved changes!',
unloadRouterPrompt: false,
unloadWindowPrompt: false
}, this.unsaved || {});
this._trackingChanges = true;
this._resetTracking();
this._triggerUnsavedChanges();
return this;
},
// Resets the default tracking values
// and stops tracking attribute changes.
stopTracking: function() {
this._trackingChanges = false;
this._originalAttrs = {};
this._unsavedChanges = {};
this._triggerUnsavedChanges();
return this;
},
// Gets rid of accrued changes and
// resets state.
restartTracking: function() {
this._resetTracking();
this._triggerUnsavedChanges();
return this;
},
// Restores this model's attributes to
// their original values since tracking
// started, the last save, or last restart.
resetAttributes: function() {
if (!this._trackingChanges) return;
this.attributes = this._originalAttrs;
this._resetTracking();
this._triggerUnsavedChanges();
return this;
},
// Symmetric to Backbone's `model.changedAttributes()`,
// except that this returns a hash of the model's attributes that
// have changed since the last save, or `false` if there are none.
// Like `changedAttributes`, an external attributes hash can be
// passed in, returning the attributes in that hash which differ
// from the model.
unsavedAttributes: function(attrs) {
if (!attrs) return _.isEmpty(this._unsavedChanges) ? false : _.clone(this._unsavedChanges);
var val, changed = false, old = this._unsavedChanges;
for (var attr in attrs) {
if (_.isEqual(old[attr], (val = attrs[attr]))) continue;
(changed || (changed = {}))[attr] = val;
}
return changed;
},
/**
* Reset tracking.
*
* @since 7.4.0 Added support for deep models (attributes that are objects themselves),
* by using `_.deepClone` in place of `_.clone`.
*/
_resetTracking: function() {
this._originalAttrs = _.deepClone(this.attributes);
this._unsavedChanges = {};
},
// Trigger an `unsavedChanges` event on this model,
// supplying the result of whether there are unsaved
// changes and a changed attributes hash.
_triggerUnsavedChanges: function() {
this.trigger('unsavedChanges', !_.isEmpty(this._unsavedChanges), _.clone(this._unsavedChanges));
if (this.unsaved) updateUnsavedModels(this);
}
});
// Wrap `model.set()` and update the internal
// unsaved changes record keeping.
Backbone.Model.prototype.set = _.wrap(Backbone.Model.prototype.set, function(oldSet, key, val, options) {
var attrs, ret;
if (key == null) return this;
// Handle both `"key", value` and `{key: value}` -style arguments.
if (typeof key === 'object') {
attrs = key;
options = val;
} else {
(attrs = {})[key] = val;
}
options || (options = {});
// Delegate to Backbone's set.
ret = oldSet.call(this, attrs, options);
if (this._trackingChanges && !options.silent) {
_.each(attrs, _.bind(function(val, key) {
if (_.isEqual(this._originalAttrs[key], val))
delete this._unsavedChanges[key];
else
this._unsavedChanges[key] = val;
}, this));
this._triggerUnsavedChanges();
}
return ret;
});
// Intercept `model.save()` and reset tracking/unsaved
// changes if it was successful.
Backbone.sync = _.wrap(Backbone.sync, function(oldSync, method, model, options) {
options || (options = {});
if (method == 'update') {
options.success = _.wrap(options.success, _.bind(function(oldSuccess, data, textStatus, jqXHR) {
var ret;
if (oldSuccess) ret = oldSuccess.call(this, data, textStatus, jqXHR);
if (model._trackingChanges) {
model._resetTracking();
model._triggerUnsavedChanges();
}
return ret;
}, this));
}
return oldSync(method, model, options);
});
})();
================================================
FILE: assets/js/builder/vendor/wp-hooks.js
================================================
/**
* This is a slightly modified and forward compatible version of the @wordpress/hooks package
* as included in the Gutenberg feature plugin version 3.8.0
*/
window.llms=window.llms||{};
// use the core hooks if available
if ( 'undefined' !== typeof window.wp && 'undefined' !== typeof window.wp.hooks ) {
window.llms.hooks = window.wp.hooks;
// otherwise load our own
} else {
window.llms.hooks=function(n){var r={};function e(t){if(r[t])return r[t].exports;var o=r[t]={i:t,l:!1,exports:{}};return n[t].call(o.exports,o,o.exports,e),o.l=!0,o.exports}return e.m=n,e.c=r,e.d=function(n,r,t){e.o(n,r)||Object.defineProperty(n,r,{configurable:!1,enumerable:!0,get:t})},e.r=function(n){Object.defineProperty(n,"__esModule",{value:!0})},e.n=function(n){var r=n&&n.__esModule?function(){return n.default}:function(){return n};return e.d(r,"a",r),r},e.o=function(n,r){return Object.prototype.hasOwnProperty.call(n,r)},e.p="",e(e.s=209)}({209:function(n,r,e){"use strict";e.r(r);var t=function(n){return"string"!=typeof n||""===n?(console.error("The namespace must be a non-empty string."),!1):!!/^[a-zA-Z][a-zA-Z0-9_.\-\/]*$/.test(n)||(console.error("The namespace can only contain numbers, letters, dashes, periods, underscores and slashes."),!1)};var o=function(n){return"string"!=typeof n||""===n?(console.error("The hook name must be a non-empty string."),!1):/^__/.test(n)?(console.error("The hook name cannot begin with `__`."),!1):!!/^[a-zA-Z][a-zA-Z0-9_.-]*$/.test(n)||(console.error("The hook name can only contain numbers, letters, dashes, periods and underscores."),!1)};var i=function(n){return function(r,e,i){var u=arguments.length>3&&void 0!==arguments[3]?arguments[3]:10;if(o(r)&&t(e))if("function"==typeof i)if("number"==typeof u){var c={callback:i,priority:u,namespace:e};if(n[r]){for(var a=n[r].handlers,l=0;l<a.length&&!(a[l].priority>u);)l++;a.splice(l,0,c),(n.__current||[]).forEach(function(n){n.name===r&&n.currentIndex>=l&&n.currentIndex++})}else n[r]={handlers:[c],runs:0};"hookAdded"!==r&&b("hookAdded",r,e,i,u)}else console.error("If specified, the hook priority must be a number.");else console.error("The hook callback must be a function.")}};var u=function(n,r){return function(e,i){if(o(e)&&(r||t(i))){if(!n[e])return 0;var u=0;if(r)u=n[e].handlers.length,n[e]={runs:n[e].runs,handlers:[]};else for(var c=n[e].handlers,a=function(r){c[r].namespace===i&&(c.splice(r,1),u++,(n.__current||[]).forEach(function(n){n.name===e&&n.currentIndex>=r&&n.currentIndex--}))},l=c.length-1;l>=0;l--)a(l);return"hookRemoved"!==e&&b("hookRemoved",e,i),u}}};var c=function(n){return function(r){return r in n}};var a=function(n,r){return function(e){n[e]||(n[e]={handlers:[],runs:0}),n[e].runs++;for(var t=n[e].handlers,o=arguments.length,i=new Array(o>1?o-1:0),u=1;u<o;u++)i[u-1]=arguments[u];if(!t||!t.length)return r?i[0]:void 0;var c={name:e,currentIndex:0};for(n.__current.push(c),n[e]||(n[e]={runs:0,handlers:[]});c.currentIndex<t.length;){var a=t[c.currentIndex].callback.apply(null,i);r&&(i[0]=a),c.currentIndex++}return n.__current.pop(),r?i[0]:void 0}};var l=function(n){return function(){return n.__current&&n.__current.length?n.__current[n.__current.length-1].name:null}};var s=function(n){return function(r){return void 0===r?void 0!==n.__current[0]:!!n.__current[0]&&r===n.__current[0].name}};var d=function(n){return function(r){if(o(r))return n[r]&&n[r].runs?n[r].runs:0}};var f=function(){var n=Object.create(null),r=Object.create(null);return n.__current=[],r.__current=[],{addAction:i(n),addFilter:i(r),removeAction:u(n),removeFilter:u(r),hasAction:c(n),hasFilter:c(r),removeAllActions:u(n,!0),removeAllFilters:u(r,!0),doAction:a(n),applyFilters:a(r,!0),currentAction:l(n),currentFilter:l(r),doingAction:s(n),doingFilter:s(r),didAction:d(n),didFilter:d(r),actions:n,filters:r}};e.d(r,"addAction",function(){return p}),e.d(r,"addFilter",function(){return v}),e.d(r,"removeAction",function(){return m}),e.d(r,"removeFilter",function(){return A}),e.d(r,"hasAction",function(){return _}),e.d(r,"hasFilter",function(){return F}),e.d(r,"removeAllActions",function(){return g}),e.d(r,"removeAllFilters",function(){return y}),e.d(r,"doAction",function(){return b}),e.d(r,"applyFilters",function(){return k}),e.d(r,"currentAction",function(){return x}),e.d(r,"currentFilter",function(){return I}),e.d(r,"doingAction",function(){return w}),e.d(r,"doingFilter",function(){return O}),e.d(r,"didAction",function(){return T}),e.d(r,"didFilter",function(){return j}),e.d(r,"actions",function(){return z}),e.d(r,"filters",function(){return Z}),e.d(r,"createHooks",function(){return f});var h=f(),p=h.addAction,v=h.addFilter,m=h.removeAction,A=h.removeFilter,_=h.hasAction,F=h.hasFilter,g=h.removeAllActions,y=h.removeAllFilters,b=h.doAction,k=h.applyFilters,x=h.currentAction,I=h.currentFilter,w=h.doingAction,O=h.doingFilter,T=h.didAction,j=h.didFilter,z=h.actions,Z=h.filters}});
}
================================================
FILE: assets/js/llms-admin-forms.js
================================================
/**
* Show an upgrade to custom fields notice when viewing the forms post type table
*
* @since 5.0.0
* @version 5.0.0
*/
( function() {
var __ = window.wp.i18n.__,
BTN_CLASS = 'page-title-action',
HELP_CLASS = 'llms-forms-help-text',
addNewBtn = document.querySelector( '.' + BTN_CLASS );
// Don't do anything if the button already exists.
if ( addNewBtn ) {
return;
}
/**
* Create the disabled "Add New Form" button
*
* @since 5.0.0
*
* @return {Element} Button DOM node.
*/
function createNewButton() {
var btn = document.createElement( 'button' );
btn.className = BTN_CLASS + ' button';
btn.innerHTML = __( 'Add New Form', 'lifterlms' );
btn.disabled = 'disabled';
btn.style = 'vertical-align: inherit';
return btn;
}
/**
* Create the toggle "Help" icon button
*
* @since 5.0.0
*
* @return {Element} Button DOM node.
*/
function createHelpIcon() {
var btn = document.createElement( 'button' ),
txt = __( 'Help', 'lifterlms' );
btn.className = 'button dashicons dashicons-editor-help';
btn.style = [
'background-color: #466dd8',
'border-radius: 50%;',
'border-color: #466dd8',
'color: #FFF',
'font-size: 23px;',
'height: 30px;',
'line-height: 1;',
'margin-left: 5px;',
'padding: 0;',
'position: relative;',
'top: 3px',
'vertical-align: baseline;',
'width: 30px;',
].join( ';' );
btn.innerHTML = '<span class="screen-reader-text>' + txt + '</span>';
btn.title = __( 'Help', 'lifterlms' );
btn.addEventListener( 'click', toggleHelpNode );
return btn;
}
/**
* Create the help notice node
*
* @since 5.0.0
*
* @return {Element} Notice div DOM node.
*/
function createHelpNode() {
var div = document.createElement( 'div' );
div.className = HELP_CLASS;
div.style = 'display:none';
div.innerHTML = '<div class="llms-admin-notice-icon"></div><div class="llms-admin-notice-content"><h3>Create Custom Forms and Fields</h3><p>Create unique student information forms for specific courses and memberships. Also unlock the power of custom fields so you can collect and display any form field data you can imagine.</p><p><a class="llms-button-primary" target="_blank" rel="noopener" href="https://lifterlms.com/product/custom-fields/?utm_source=LifterLMS%20Plugin&utm_medium=Add%20Form%20Notice&utm_campaign=Add%20Form%20In%20App%20Upgrade%20Flow">Learn More</a></p></div>';
return div;
}
/**
* Callback function for toggling the help notice dispaly
*
* @since 5.0.0
*
* @return {void}
*/
function toggleHelpNode() {
var el = document.querySelector( '.' + HELP_CLASS );
if ( 'none' === el.style.display ) {
el.style.display = 'flex';
el.className += ' notice notice-info llms-admin-notice';
} else {
el.style.display = 'none';
}
}
/**
* Initialize
*
* Creates and add elements to the dom and binds UI events.
*
* @since 5.0.0
*
* @return {void}
*/
function init() {
var title = document.querySelector( '.wp-heading-inline' ),
btn = createNewButton();
title.after( btn );
btn.after( createHelpIcon() );
document.querySelector( '.wrap' ).insertBefore( createHelpNode(), document.querySelector( '.wp-header-end' ) );
}
// Go.
init();
} )();
================================================
FILE: assets/js/llms-admin-media-protection-attachment-settings.js
================================================
( function() {
if ( 'undefined' === typeof wp || 'undefined' === typeof wp.media || 'undefined' === typeof wp.media.view || 'undefined' === typeof wp.media.view.Attachment || 'undefined' === typeof wp.media.view.Attachment.Details ) {
return;
}
var originalCompat = wp.media.view.AttachmentCompat;
wp.media.view.AttachmentCompat = originalCompat.extend( {
initialize: function() {
// Call the parent initialize.
originalCompat.prototype.initialize.apply( this, arguments );
// Bind to the render event.
this.on( 'compatRendered', this.initializeLifterlmsSelect2 );
// Listen for changes to the protection dropdown.
this.listenTo( this.model, 'change', this.refreshAttachmentUrl );
},
render: function() {
// Call the parent render
originalCompat.prototype.render.apply(this, arguments);
// Trigger our custom event after render.
// TODO: Check if we need the defer.
_.defer(() => {
this.trigger( 'compatRendered' );
});
return this;
},
initializeLifterlmsSelect2: function() {
const $select = jQuery( '.media-modal .llms-posts-select2' );
if ( $select.length && ! $select.data( 'select2' )) {
$select.llmsPostsSelect2();
}
},
refreshAttachmentUrl: function() {
// When the protection setting changes, we need to refresh the URL
if ( this.model.hasChanged( 'url' ) ) {
// Update the URL in the UI.
jQuery( '#attachment-details-copy-link' ).val( this.model.get( 'url' ) );
}
}
} );
} )();
================================================
FILE: assets/js/llms-admin-settings.js
================================================
;/**
* LifterLMS Settings Pages UI / UX
*
* @since 3.7.3
* @version 3.18.0
*/( function( $, undefined ) {
window.llms = window.llms || {};
window.llms.admin_settings = function() {
this.file_frame = null;
/**
* Initialize
*
* @return void
* @since 3.7.3
* @version 3.18.0
*/
this.init = function() {
this.bind();
this.bind_conditionals();
};
/**
* Bind DOM events
*
* @return void
* @since 3.7.3
* @version 3.17.5
*/
this.bind = function() {
var self = this;
if ( $( '.llms-image-field-upload' ).length ) {
$( '.llms-image-field-upload' ).on( 'click', function( e ) {
e.preventDefault();
self.image_upload_click( $( this ), e );
} );
$( '.llms-image-field-remove' ).on( 'click', function( e ) {
e.preventDefault();
self.update_image( $( this ), '', '' );
} );
}
if ( $( '.llms-gateway-table' ).length ) {
$( '.llms-gateway-table tbody' ).sortable( {
axis: 'y',
cursor: 'move',
items: 'tr',
// containment: 'parent',
handle: 'td.sort',
helper: function( event, ui ) {
ui.children().each( function() {
$( this ).width( $( this ).width() );
} );
// ui.css( 'left', '0' );
return ui;
},
update: function( event, ui ) {
$( this ).find( 'td.sort input' ).each( function( i ) {
$( this ).val( i );
} );
}
} );
}
};
/**
* Allow checkboxes to conditionally display other settings
*
* @return void
* @since 3.18.0
* @version 3.18.0
*/
this.bind_conditionals = function() {
$( '.llms-conditional-controller' ).each( function() {
$( this ).on( 'change', function() {
if ( 'checkbox' === $( this ).attr( 'type' ) ) {
var $controls = $( $( this ).attr( 'data-controls' ) ).closest( 'tr' );
if ( $( this ).is( ':checked' ) ) {
$controls.show();
} else {
$controls.hide();
}
return;
}
if ( 'select' !== $( this ).prop( 'tagName' ).toLowerCase() ) {
return;
}
$( this ).find( 'option' ).each( function() {
var val = $( this ).val();
if ( ! val ) {
return true;
}
var $controls_for_option = $( $( this ).parent().attr( 'data-controls-' + $.escapeSelector( val ) ) ).closest( 'tr' );
if ( $( this ).is( ':selected' ) ) {
$controls_for_option.show();
} else {
$controls_for_option.hide();
}
} );
} ).trigger( 'change' );
} );
};
/**
* Click event for image upload fields
*
* @param obj $btn jQuery object for clicked button
* @param obj e JS event object
* @return void
* @since 3.7.3
* @version 3.7.3
*/
this.image_upload_click = function( $btn, e ) {
var self = this,
frame = null;
if ( ! frame ) {
var title = $btn.attr( 'data-frame-title' ) || LLMS.l10n.translate( 'Select an Image' ),
button_text = $btn.attr( 'data-frame-button' ) || LLMS.l10n.translate( 'Select Image' );
frame = wp.media.frames.file_frame = wp.media({
title: title,
button: {
text: button_text,
},
multiple: false // Set to true to allow multiple files to be selected
});
}
frame.on( 'select', function() {
// We set multiple to false so only get one image from the uploader
var attachment = frame.state().get( 'selection' ).first().toJSON();
self.update_image( $btn, attachment.id, attachment.url );
});
frame.open();
};
/**
* Update the DOM with a selected image
*
* @param obj $btn jQuery object of the clicked button
* @param int id WP Attachment ID of the image
* @param string src <img> src of the selected image
* @return void
* @since 3.7.3
* @version 3.7.3
*/
this.update_image = function( $btn, id, src ) {
var $input = $( '#' + $btn.attr( 'data-id' ) ),
$preview = $btn.prevAll( 'img.llms-image-field-preview' )
$remove = $btn.hasClass( 'llms-image-field-remove' ) ? $btn : $btn.next( 'input.llms-image-field-remove' );
$input.val( id );
$preview.attr( 'src', src );
if ( '' !== id ) {
$remove.removeClass( 'hidden' );
} else {
$remove.addClass( 'hidden' );
}
}
// go
this.init();
};
var a = new window.llms.admin_settings();
} )( jQuery );
================================================
FILE: assets/js/llms-admin-tables.js
================================================
/**
* LifterLMS Admin Tables
* @since 3.2.0
* @version 3.28.1
*/
;( function( $, undefined ) {
window.llms = window.llms || {};
var AdminTables = function() {
this.$tables = null;
/**
* Initialize
* @return void
* @since 3.2.0
*/
this.init = function() {
var self = this;
self.$tables = $( '.llms-gb-table' );
if ( self.$tables.length ) {
self.bind();
}
};
/**
* Bind DOM events
* @return void
* @since 2.3.0
* @version 3.28.0
*/
this.bind = function() {
var self = this;
this.$tables.each( function() {
var $table = $( this );
$table.parent().find('form#llms-clear-student-progress-cache' ).on( 'submit', function( e ) {
e.preventDefault();
self.clear_cache( $table, $( this ) );
} );
$table.on( 'click', 'button[name="llms-table-paging"]', function( e ) {
e.preventDefault();
self.change_page( $table, $( this ) );
} );
$table.on( 'click', 'button[name="llms-table-export"]', function( e ) {
e.preventDefault();
self.export( $table, $( this ) );
} );
$table.on( 'click', 'a.llms-sortable', function( e ) {
e.preventDefault();
self.change_order( $table, $( this ) );
} );
$table.parent().find( '.llms-table-filters' ).on( 'change', 'select.llms-table-filter', function( e ) {
self.change_filter( $table, $( this ) );
} );
$table.parent().find( '.llms-table-search' ).on( 'keyup', 'input', debounce( function( e ) {
switch ( e.keyCode ) {
case 37:
case 38:
case 39:
case 40:
return;
break;
default:
self.search( $table, $( this ) );
}
}, 250 ) );
} );
};
this.clear_cache = function( $table, $form ) {
var self = this;
var $btn = $form.find( 'button' );
LLMS.Ajax.call( {
url: $form.attr( 'action' ),
method: 'POST',
dataType: 'html',
data: {
'_wpnonce' : $form.find('[name="_wpnonce"]').val(),
'_wp_http_referer' : $form.find('[name="_wp_http_referer"]').val(),
'llms_tool': 'clear-cache'
},
beforeSend: function() {
if ( $btn ) {
$btn.prop( 'disabled', true );
LLMS.Spinner.start( $btn, 'small' );
}
},
error: function( jqXHR, status, error ) {
if ( $btn ) {
$btn.prop( 'disabled', false );
LLMS.Spinner.stop( $btn );
}
console.error( error );
},
success: function( res ) {
if ( $btn ) {
$btn.prop( 'disabled', false );
LLMS.Spinner.stop( $btn );
}
self.reload( $table, {} );
}
} );
};
/**
* Handle clicks on sortable column headers
* @param obj $table jQuery selector for the current table
* @param obj $anchor jQuery selector for the clicked column head anchor
* @return void
* @since 3.2.0
* @version 3.2.0
*/
this.change_order = function( $table, $anchor ) {
this.reload( $table, {
order: $anchor.attr( 'data-order' ),
orderby: $anchor.attr( 'data-orderby' ),
page: 1,
} );
};
this.change_filter = function( $table, $select ) {
this.reload( $table, {
filter: $select.val(),
filterby: $select.attr( 'name' ),
page: 1,
} );
};
/**
* Change the current page of the table on a next/back click
* @param obj $table jQuery selector for the current table
* @param obj $btn jQuery selector for the clicked button
* @return void
* @since 3.2.0
* @version 3.4.0
*/
this.change_page = function( $table, $btn ) {
this.reload( $table, {
order: this.get_args( $table, 'order' ),
orderby: this.get_args( $table, 'orderby' ),
page: $btn.attr( 'data-page' ),
} );
};
/**
* Handle
* @param obj $table jQuery object for the table
* @param obj $btn jQuery object for the clicked button
* @param string filename filename of the export in progress.
* @return void
* @since 3.15.0
* @version 3.28.1
*/
this.export = function( $table, $btn, filename ) {
var self = this,
$msg = $table.find( '.llms-table-export .llms-table-export-msg' ),
$progress = $table.find( '.llms-table-export .llms-table-progress' );
function activate_button() {
LLMS.Spinner.stop( $btn, 'small' );
$btn.removeAttr( 'disabled' );
}
LLMS.Ajax.call( {
data: $.extend( {
action: 'export_admin_table',
handler: $table.attr( 'data-handler' ),
filename: filename,
}, JSON.parse( $table.attr( 'data-args' ) ) ),
beforeSend: function() {
if ( ! $btn.attr( 'disabled' ) ) {
$btn.attr( 'disabled', 'disabled' );
LLMS.Spinner.start( $btn, 'small' );
}
},
error: function( jqXHR, status, error ) {
var msg = LLMS.l10n.translate( 'An error was encountered generating the export' );
activate_button();
$progress.hide();
$msg.html( '<span class="llms-error">' + msg + ': ' + error + '</span>' );
console.error( jqXHR );
},
success: function( res ) {
if ( ! res.success && res.message ) {
activate_button();
$progress.hide();
$msg.html( '<span class="llms-error">' + res.message + '</span>' );
} else if ( res.success && res.data && res.data.progress ) {
$msg.html( '' );
// only show a progress bar if it's going to take more than one request.
if ( ! $progress.is( 'visible' ) && res.data.progress !== 100 ) {
$progress.css( 'display', 'inline-block' );
}
$progress.find( '.llms-table-progress-text' ).text( res.data.progress + '%' );
$progress.find( '.llms-table-progress-inner' ).css( 'width', res.data.progress + '%' );
// if we're not finished, make another request.
if ( 100 !== res.data.progress ) {
self.export( $table, $btn, res.data.filename );
// finished, download the file and cleanup the interface.
} else {
setTimeout( function() {
var id = 'llms-dl-export';
$( '#' + id ).remove();
$( '<a />', {
id: id,
href: res.data.url,
style: 'display: hidden;',
download: '',
} ).appendTo( 'body' );
$( '#' + id )[0].click();
activate_button();
$progress.hide();
}, 1000 );
}
}
}
} );
}
/**
* Retrieve arguments stored in the table and parse into a readable object
* @param obj $table jQuery selector for the current table
* @param string item key to grab a specific value from the args object
* @return mixed
* @since 3.2.0
* @version 3.2.0
*/
this.get_args = function( $table, item ) {
var args = JSON.parse( $table.attr( 'data-args' ) );
if ( item ) {
return ( args[ item ] ) ? args[ item ] : false;
} else {
return args;
}
};
/**
* Reload a table
* @param obj $table jQuery selector for the current table
* @param obj args arguments to pass with the ajax query
* @return void
* @since 3.2.0
* @version 3.2.0
*/
this.reload = function( $table, args ) {
args = $.extend( {
action: 'get_admin_table_data',
handler: $table.attr( 'data-handler' ),
}, JSON.parse( $table.attr( 'data-args' ) ), args );
LLMS.Ajax.call( {
data: args,
beforeSend: function() {
LLMS.Spinner.start( $table.closest( '.llms-table-wrap' ) );
},
success: function( r ) {
LLMS.Spinner.stop( $table.closest( '.llms-table-wrap' ) )
if ( r.success ) {
$table.attr( 'data-args', r.data.args );
$table.find( 'thead' ).replaceWith( r.data.thead );
$table.find( 'tbody' ).replaceWith( r.data.tbody );
$table.find( 'tfoot' ).replaceWith( r.data.tfoot );
}
}
} );
};
/**
* Executes an AJAX search query
* @param obj $table jQuery selector for the current table
* @param obj $input jQuery selector for the search input
* @return void
* @since 3.2.0
* @version 3.2.0
*/
this.search = function( $table, $input ) {
var val = $input.val()
len = val.length;
if ( 0 === len || len >= 3 ) {
this.reload( $table, {
page: 1,
search: $input.val(),
} );
}
};
/**
* Throttle function by a delay in ms
* @param Function fn callback function
* @param int delay delay in millisecond
* @return function
* @since 3.2.0
* @version 3.2.0
*/
function debounce( fn, delay ) {
var timer = null;
return function () {
var context = this,
args = arguments;
window.clearTimeout( timer );
timer = window.setTimeout( function () {
fn.apply( context, args );
}, delay );
};
}
// go
this.init();
};
// initialize the object
window.llms.admin_tables = new AdminTables();
} )( jQuery );
================================================
FILE: assets/js/llms-admin-wizard.js
================================================
/**
* JS from the admin setup wizard
*
* @since 4.8.0
* @version 4.8.0
*/
( function() {
const
currStep = document.getElementById( 'llms-setup-current-step' ),
exitLink = document.querySelector( '.llms-exit-setup' ),
imports = document.querySelectorAll( 'input[name="llms_setup_course_import_ids[]"]' ),
checkboxToggle = document.getElementsByClassName( 'llms-checkbox-toggle' )[ 0 ] ?? null;
if ( imports.length ) {
const
submit = document.getElementById( 'llms-setup-submit' ),
msgs = document.querySelectorAll( '.llms-importing-msgs .llms-importing-msg' );
/**
* Retrieve the number of courses to be imported
*
* @since 4.8.0
*
* @return {Number} The number of courses to be imported.
*/
function getSelectedImportCount() {
let count = 0;
imports.forEach( function( el ) {
if ( el.checked ) {
++count;
}
} );
return count;
}
/**
* Update UI when a user toggles an import on or off.
*
* @since 4.8.0
*/
imports.forEach( function( el ) {
el.addEventListener( 'change', function() {
// Hide all messages.
msgs.forEach( function( msg ) {
msg.style.display = 'none';
} );
const selectedCount = getSelectedImportCount();
// If there's no courses to be imported, disable the submit button.
submit.disabled = 0 === getSelectedImportCount() ? 'disabled' : null;
// Show messages where applicable.
if ( 1 === selectedCount ) {
msgs[0].style.display = 'block';
} else if ( selectedCount >= 2 ) {
msgs[1].style.display = 'block';
document.getElementById( 'llms-importing-number' ).textContent = selectedCount;
}
} );
} );
// Trigger a change event so the UI displays properly on page load.
imports[0].dispatchEvent( new Event( 'change' ) );
/**
* Start a spinner when the "Import Courses" button is clicked.
*
* @since 4.8.0
*/
submit.addEventListener( 'click', function() {
LLMS.Spinner.start( jQuery( submit ), 'small' );
} );
}
if ( exitLink && 'finish' !== currStep.value ) {
/**
* When users click "Exit Setup" prior to setup completion, open a confirmation dialog
*
* @since 4.8.0
*/
exitLink.addEventListener( 'click', function( e ) {
if ( ! window.confirm( exitLink.dataset.confirm ) ) {
e.preventDefault();
}
} );
}
if ( checkboxToggle ) {
checkboxToggle.addEventListener( 'click', function() {
const hiddenFields = this.parentNode.parentNode.querySelectorAll( '.is-hidden,.is-visible' );
for ( let i = 0; i < hiddenFields.length; i++ ) {
hiddenFields[ i ].classList.toggle( 'is-visible' );
hiddenFields[ i ].classList.toggle( 'is-hidden' );
}
} );
}
}() );
================================================
FILE: assets/js/llms-admin.js
================================================
/**
* LifterLMS Admin Panel Javascript
*
* @since Unknown
* @version 7.3.0
*
* @param obj $ Traditional jQuery reference.
* @return void
*/
;( function( $ ) {
window.llms = window.llms || {};
window.llms.widgets = function() {
this.$widgets = $( '.llms-widget' );
this.$info_toggles = $( '.llms-widget-info-toggle' );
this.init = function() {
this.bind();
};
this.bind = function() {
this.$info_toggles.on( 'mouseenter mouseleave', function( evt ) {
$(this).closest( '.llms-widget' )
.toggleClass( 'info-showing', 'mouseenter' === evt.type );
} );
};
// Go.
this.init();
return this;
};
var llms_widgets = new window.llms.widgets();
var $headerEnd = $( '.wp-header-end' );
if ( ! $headerEnd.length ) {
$headerEnd = $( '.wrap h1, .wrap h2' ).first();
}
$( '#lifterlms-notifications' ).insertAfter( $headerEnd );
$( document ).ready(function () {
$( document ).on('click', '.lifterlms-notice-button.notice-dismiss', function () {
var notification_id = $( this ).val();
var nonce = $( this ).data( 'nonce' );
var postData = {
action: 'lifterlms_hide_notice',
notification_id: notification_id,
nonce: nonce
}
$.ajax( {
type: "POST",
data: postData,
url: ajaxurl,
success: function (response) {
$( '#' + notification_id ).hide();
}
} );
});
});
/**
* Simple jQuery plugin to transform select elements into Select2-powered elements to query for Courses/Memberships via AJAX.
*
* @since 3.19.4
* @since 3.32.0 Added ability to fetch posts based on their post status.
* @since 3.37.2 Added ability to fetch posts (llms posts) filtered by their instructor id.
* @since 4.4.0 Update ajax nonce source.
*
* @param obj options Options passed to Select2.
* Each default option will pulled from the elements data-attributes.
* @return void
*/
$.fn.llmsPostsSelect2 = function( options ) {
var localOptions = options;
this.each( function() {
var self = $( this ),
options = localOptions || {},
defaults = {
multiple: false,
placeholder: self.attr( 'data-placeholder' ) || ( undefined !== LLMS.l10n ? LLMS.l10n.translate( 'Select a Course/Membership' ) : 'Select a Course/Membership' ),
post_type: self.attr( 'data-post-type' ) || 'post',
post_statuses: self.attr( 'data-post-statuses' ) || 'publish',
instructor_id: null,
allow_clear: self.attr( 'data-post-type' ) || false,
width: null,
};
$.each( defaults, function( setting ) {
if ( self.attr( 'data-' + setting ) ) {
options[ setting ] = self.attr( 'data-' + setting );
}
} );
if ( 'multiple' === self.attr( 'multiple' ) ) {
options.multiple = true;
}
options = $.extend( defaults, options );
$( this ).llmsSelect2( {
allowClear: options.allow_clear,
ajax: {
dataType: 'JSON',
delay: 250,
method: 'POST',
url: window.ajaxurl,
data: function( params ) {
return {
action: 'select2_query_posts',
page: ( params.page ) ? params.page - 1 : 0, // 0 index the pages to make it simpler for the database query
post_type: options.post_type,
instructor_id : options.instructor_id,
post_statuses: options.post_statuses,
term: params.term,
_ajax_nonce: window.llms.ajax_nonce,
};
},
processResults: function( data, params ) {
// recursive function for creating
function map_data( items ) {
// this is a flat array of results
// used when only one post type is selected
// and to format children when using optgroups with multiple post types
if ( Array.isArray( items ) ) {
return $.map( items, function( item ) {
return format_item( item );
} );
// this sets up the top level optgroups when using multiple post types
} else {
return $.map( items, function( item ) {
return {
text: item.label,
children: map_data( item.items ),
}
} );
}
}
// format a single result (option)
function format_item( item ) {
return {
text: item.name,
id: item.id,
};
}
return {
results: map_data( data.items ),
pagination: {
more: data.more
}
};
},
},
cache: true,
placeholder: options.placeholder,
multiple: options.multiple,
width: options.width,
} );
} );
};
// automatically setup any select with the `llms-posts-select2` class
$( 'select.llms-posts-select2' ).llmsPostsSelect2();
/**
* Simple jQuery plugin to transform select elements into Select2-powered elements to query for Students via AJAX
*
* @since Unknown
* @since 3.17.5 Unknown.
* @since 4.4.0 Update ajax nonce source.
* @since 6.2.0 Use the LifterLMS REST API "list students" endpoint
* instead of the `LLMS_AJAX_Handler::query_students()` PHP function.
* @since 6.3.0 Fixed student's REST API URL.
* @since 7.3.0 Early bail when the element doesn't exist.
*
* @param {Object} options Options passed to Select2. Each default option will be pulled from the elements data-attributes.
* @return {jQuery}
*/
$.fn.llmsStudentsSelect2 = function( options ) {
if ( ! this.length ) {
return this;
}
var self = this,
options = options || {},
defaults = {
allow_clear: false,
enrolled_in: '',
multiple: false,
not_enrolled_in: '',
placeholder: undefined !== LLMS.l10n ? LLMS.l10n.translate( 'Select a student' ) : 'Select a student',
roles: '',
width: '100%',
};
$.each( defaults, function( setting ) {
if ( self.attr( 'data-' + setting ) ) {
options[ setting ] = self.attr( 'data-' + setting );
}
} );
options = $.extend( defaults, options );
this.llmsSelect2({
allowClear: options.allow_clear,
ajax: {
dataType: 'JSON',
delay: 250,
method: 'GET',
url: window.wpApiSettings.root + 'wp/v2/users',
data: function( params ) {
return {
_wpnonce: window.wpApiSettings.nonce,
context: 'edit',
page: params.page || 1,
per_page: 10,
not_enrolled_in: params.not_enrolled_in || options.not_enrolled_in,
enrolled_in: params.enrolled_in || options.enrolled_in,
roles: params.roles || options.roles,
search: params.term,
search_columns: 'email,name,username',
};
},
processResults: function( data, params ) {
var page = params.page || 1;
var totalPages = this._request.getResponseHeader( 'X-WP-TotalPages' );
return {
results: $.map( data, function( item ) {
return {
text: item.name + ' <' + item.email + '>',
id: item.id,
};
} ),
pagination: {
more: page < totalPages
}
};
},
},
cache: true,
placeholder: options.placeholder,
multiple: options.multiple,
width: options.width,
});
return this;
};
/**
* Scripts for use on the engagements settings tab for email provider connector plugins
*
* @since 3.40.0
*/
window.llms.emailConnectors = {
/**
* Register a client
*
* Builds and submits a form used to direct the user to the connector's oAuth
* authorization endpoint.
*
* @since 3.40.0
*
* @param {String} url Redirect URL.
* @param {Object} fields Hash of fields where the key is the field name and the value if the field value.
* @return {Void}
*/
registerClient: function( url, fields ) {
var form = document.createElement( 'form' );
form.setAttribute( 'method', 'POST' );
form.setAttribute( 'action', url );
function appendInput( name, value ) {
var input = document.createElement( 'input' );
input.setAttribute( 'type', 'hidden' );
input.setAttribute( 'name', name );
input.setAttribute( 'value', value );
form.appendChild( input );
}
$.each( fields, function( key, val ) {
appendInput( key, val );
} );
document.body.appendChild( form );
form.submit();
},
/**
* Performs an AJAX request to perform remote installation of the connector plugin
*
* The callback will more than likely use `registerClient()` on success.
*
* @since 3.40.0
*
* @param {Object} $btn jQuery object for the connector button.
* @param {Object} data Hash of data used for the ajax request.
* @param {Function} callback Success callback function.
* @return {Void}
*/
remoteInstall: function( $btn, data, callback ) {
const self = this;
$btn.parent().find( '.llms-error' ).remove();
$.post( ajaxurl, data, function() {
// Do a second call to get the redirect URL, since the plugin isn't in memory initially.
data.action = data.action + '_verify';
$.post( ajaxurl, data, callback ).fail( function( jqxhr ) {
self.handleRemoteInstallFailure( $btn, jqxhr );
} );
} )
.fail( function (jqxhr ) {
self.handleRemoteInstallFailure( $btn, jqxhr );
} );
},
handleRemoteInstallFailure: function( $btn, jqxhr ) {
LLMS.Spinner.stop( $btn );
var msg = jqxhr.responseJSON && jqxhr.responseJSON.message ? jqxhr.responseJSON.message : jqxhr.responseText;
if ( msg ) {
$( '<p class="llms-error">' + LLMS.l10n.replace( 'Error: %s', { '%s': msg } ) + '</p>' ).insertAfter( $btn );
}
},
};
} )( jQuery );
================================================
FILE: assets/js/llms-ajax.js
================================================
function Ajax ( type, data, cache ) {
this.type = type;
this.data = data;
this.cache = cache;
this.dataType = 'json';
this.url = window.ajaxurl || window.llms.ajaxurl;
}
Ajax.prototype.check_voucher_duplicate = function () {
jQuery.ajax({
type : this.type,
url : this.url,
data : this.data,
cache : this.cache,
dataType : this.dataType,
success : function( response ) {
llms_on_voucher_duplicate( response.duplicates );
}
});
};
================================================
FILE: assets/js/llms-analytics.js
================================================
;/**
* LifterLMS Admin Reporting Widgets & Charts
*
* @since 3.0.0
* @since 3.17.2 Unknown.
* @since 3.33.1 Fix issue that produced series options not aligned with the chart data.
* @since 3.36.3 Added the `allow_clear` paramater when initializiing the `llmsStudentSelect2`.
* @since 4.3.3 Legends will automatically display on top of the chart.
* @since 4.5.1 Show sales reporting currency symbol based on LifterLMS site options.
* @version 7.3.0
*
*/( function( $, undefined ) {
window.llms = window.llms || {};
/**
* LifterLMS Admin Analytics.
*
* @since 3.0.0
* @since 3.5.0 Unknown
* @since 4.5.1 Added `opts` parameter.
* @since [verison] Early bail if no `#llms-analytics-json` is available.
*
* @param {Object} options Options object.
* @return {Object} Class instance.
*/
var Analytics = function( opts ) {
if ( ! $( '#llms-analytics-json' ).length ) {
return;
}
this.charts_loaded = false;
this.data = {};
this.query = $.parseJSON( $( '#llms-analytics-json' ).text() );
this.timeout = 8000;
this.options = opts;
this.$widgets = $( '.llms-widget[data-method]' );
/**
* Initializer
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.init = function() {
google.charts.load( 'current', {
packages: [
'corechart'
]
} );
google.charts.setOnLoadCallback( this.charts_ready );
this.bind();
this.load_widgets();
};
/**
* Bind DOM events.
*
* @since 3.0.0
* @since 3.36.3 Added the `allow_clear` paramater when initializiing the `llmsStudentSelect2`.
* @since 7.2.0 Added check for datepicker before initializing.
*
* @return {Void}
*/
this.bind = function() {
if ( $( '.llms-datepicker' ).length && $.fn.datepicker ) {
$( '.llms-datepicker' ).datepicker( {
dateFormat: 'yy-mm-dd',
maxDate: 0,
} );
}
$( '#llms-students-ids-filter' ).llmsStudentsSelect2( {
multiple: true,
placeholder: LLMS.l10n.translate( 'Filter by Student(s)' ),
allow_clear: true,
} );
$( 'a[href="#llms-toggle-filters"]' ).on( 'click', function( e ) {
e.preventDefault();
$( '.llms-analytics-filters' ).slideToggle( 100 );
} );
$( '#llms-custom-date-submit' ).on( 'click', function() {
$( 'input[name="range"]' ).val( 'custom' );
} );
$( '#llms-date-quick-filters a.llms-nav-link[data-range]' ).on( 'click', function( e ) {
e.preventDefault();
$( 'input[name="range"]' ).val( $( this ).attr( 'data-range' ) );
$( 'form.llms-reporting-nav' ).submit();
} );
};
/**
* Called by Google Charts when the library is loaded and ready
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.charts_ready = function() {
window.llms.analytics.charts_loaded = true;
window.llms.analytics.draw_chart();
};
/**
* Render the chart
*
* @since 3.0.0
* @since 3.17.6 Unknown
* @since 4.3.3 Force the legend to appear on top of the chart.
* @since 4.5.1 Display sales numbers according to the site's currency settings instead of the browser's locale.
*
* @return {void}
*/
this.draw_chart = function() {
if ( ! this.charts_loaded || ! this.is_loading_finished() ) {
return;
}
var el = document.getElementById( 'llms-charts-wrapper' );
if ( ! el ) {
return;
}
var self = this,
chart = new google.visualization.ComboChart( el ),
data = self.get_chart_data(),
options = {
legend: 'top',
chartArea: {
height: '75%',
width: '85%',
},
colors: ['#606C38','#E85D75','#EF8354','#C64191','#731963','#2B6CB0','#E1B530','#319795'],
height: 560,
lineWidth: 4,
seriesType: 'bars',
series: self.get_chart_series_options(),
vAxes: {
0: {
format: this.options.currency_format || 'currency',
},
1: {
format: '',
},
},
};
if ( data.length ) {
data = google.visualization.arrayToDataTable( data );
data.sort( [{column: 0}] );
chart.draw( data, options );
}
};
/**
* Check if a widget is still loading
*
* @return bool
* @since 3.0.0
* @version 3.0.0
*/
this.is_loading_finished = function() {
if ( $( '.llms-widget.is-loading' ).length ) {
return false;
}
return true;
};
/**
* Start loading all widgets on the current screen
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.load_widgets = function() {
var self = this;
this.$widgets.each( function() {
self.load_widget( $( this ) );
} );
};
/**
* Load a specific widget.
*
* @since 3.0.0
* @since 7.2.0 Change h1 tag to .llms-widget-content.
* @since 7.3.0 Append `_ajax_nonce` to the ajax data packet.
*
* @param {Object} $widget The jQuery selector of the widget element.
* @return {Void}
*/
this.load_widget = function( $widget ) {
var self = this,
method = $widget.attr( 'data-method' ),
$content = $widget.find( '.llms-widget-content' ),
$retry = $widget.find( '.llms-reload-widget' ),
content_text = LLMS.l10n.translate( 'Error' ),
status;
$widget.addClass( 'is-loading' );
$.ajax( {
data: {
action: 'llms_widget_' + method,
dates: self.query.dates,
courses: self.query.current_courses,
memberships: self.query.current_memberships,
students: self.query.current_students,
_ajax_nonce: window.llms.ajax_nonce,
},
method: 'POST',
timeout: self.timeout,
url: window.ajaxurl,
success: function( r ) {
status = 'success';
if ( 'undefined' !== typeof r.response ) {
content_text = r.response;
self.data[method] = {
chart_data: r.chart_data,
response: r.response,
results: r.results,
};
$retry.remove();
}
},
error: function( r ) {
status = 'error';
},
complete: function( r ) {
if ( 'error' === status ) {
if ( 'timeout' === r.statusText ) {
content_text = LLMS.l10n.translate( 'Request timed out' );
} else {
content_text = LLMS.l10n.translate( 'Error' );
}
if ( ! $retry.length ) {
$retry = $( '<a class="llms-reload-widget" href="#">' + LLMS.l10n.translate( 'Retry' ) + '</a>' );
$retry.on( 'click', function( e ) {
e.preventDefault();
self.load_widget( $widget );
} );
$widget.append( $retry );
}
}
$widget.removeClass( 'is-loading' );
$content.html( content_text );
self.widget_finished( $widget );
}
} );
};
/**
* Get the time in seconds between the queried dates
*
* @return int
* @since 3.0.0
* @version 3.0.0
*/
this.get_date_diff = function() {
var end = new Date( this.query.dates.end ),
start = new Date( this.query.dates.start );
return Math.abs( end.getTime() - start.getTime() );
};
/**
* Builds an object of data that can be used to, ultimately, draw the screen's chart
*
* @return obj
* @since 3.0.0
* @version 3.1.6
*/
this.get_chart_data_object = function() {
var self = this,
max_for_days = ( ( 1000 * 3600 * 24 ) * 30 ) * 4, // 4 months in seconds
diff = this.get_date_diff(),
data = {},
res, i, d, date;
for ( var method in self.data ) {
if ( ! self.data.hasOwnProperty( method ) ) {
continue;
}
if ( 'object' !== typeof self.data[ method ].chart_data || 'object' !== typeof self.data[ method ].results ) {
continue;
}
res = self.data[ method ].results;
if ( res ) {
for ( i = 0; i < res.length; i++ ) {
d = this.init_date( res[i].date );
// group by days
if ( diff <= max_for_days ) {
date = new Date( d.getFullYear(), d.getMonth(), d.getDate() );
}
// group by months
else {
date = new Date( d.getFullYear(), d.getMonth(), 1 );
}
if ( ! data[ date ] ) {
data[ date ] = this.get_empty_data_object( date )
}
switch ( self.data[ method ].chart_data.type ) {
case 'amount':
data[ date ][ method ] = data[ date ][ method ] + ( res[i][ self.data[ method ].chart_data.key ] * 1 );
break;
case 'count':
default:
data[ date ][ method ]++;
break;
}
}
}
}
return data;
};
/**
* Get the data google charts needs to initiate the current chart
*
* @return obj
* @since 3.0.0
* @version 3.0.0
*/
this.get_chart_data = function() {
var self = this,
obj = self.get_chart_data_object(),
data = self.get_chart_headers();
for ( var date in obj ) {
if ( ! obj.hasOwnProperty( date ) ) {
continue;
}
var row = [ obj[ date ]._date ];
for ( var item in obj[ date ] ) {
if ( ! obj[ date ].hasOwnProperty( item ) ) {
continue;
}
// skip meta items
if ( 0 === item.indexOf( '_' ) ) {
continue;
}
row.push( obj[ date ][ item ] );
}
data.push( row );
}
return data;
};
/**
* Get a stub of the data object used by this.get_data_object
*
* @param string date date to instantiate the object with
* @return obj
* @since 3.0.0
* @version 3.0.0
*/
this.get_empty_data_object = function( date ) {
var self = this,
obj = {
_date: date,
};
for ( var method in self.data ) {
if ( ! self.data.hasOwnProperty( method ) ) {
continue;
}
if ( self.data[ method ].chart_data ) {
obj[ method ] = 0;
}
}
return obj;
};
/**
* Builds an array of chart header data
*
* @return array
* @since 3.0.0
* @version 3.0.0
*/
this.get_chart_headers = function() {
var self = this,
h = [];
// date headers go first
h.push( {
label: LLMS.l10n.translate( 'Date' ),
id: 'date',
type: 'date',
} );
for ( var method in self.data ) {
if ( ! self.data.hasOwnProperty( method ) ) {
continue;
}
if ( self.data[ method ].chart_data ) {
h.push( self.data[ method ].chart_data.header );
}
}
return [ h ];
};
/**
* Get a object of series options needed to draw the chart.
*
* @since 3.0.0
* @since Fix issue that produced series options not aligned with the chart data.
*
* @return void
*/
this.get_chart_series_options = function() {
var self = this,
options = {}
i = 0;
for ( var method in self.data ) {
if ( ! self.data.hasOwnProperty( method ) ) {
continue;
}
if ( self.data[ method ].chart_data ) {
var type = self.data[ method ].chart_data.type;
options[ i ] = {
type: ( 'count' === type ) ? 'bars' : 'line',
targetAxisIndex: ( 'count' === type ) ? 1 : 0,
};
i++;
}
}
return options;
};
/**
* Instantiate a Date instance via a date string
*
* @param string string date string, expected format should be from php date( 'Y-m-d H:i:s' )
* @return obj
* @since 3.1.4
* @version 3.1.5
*/
this.init_date = function( string ) {
var parts, date, time;
parts = string.split( ' ' );
date = parts[0].split( '-' );
time = parts[1].split( ':' );
return new Date( date[0], date[1] - 1, date[2], time[0], time[1], time[2] );
};
/**
* Called when a widget is finished loading
* Updates the current chart with the new data from the widget
*
* @param obj $widget jQuery selector of the widget element
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.widget_finished = function( $widget ) {
if ( this.is_loading_finished() ) {
this.draw_chart();
}
};
// go
this.init();
// return
return this;
};
window.llms.analytics = new Analytics( window.llms.analytics || {} );
} )( jQuery );
================================================
FILE: assets/js/llms-favorites.js
================================================
/* global LLMS, $ */
/* jshint strict: true */
/**
* Front End Favorite Class.
*
* @type {Object}
*
* @since 7.5.0
* @version 7.5.0
*/
( function( $ ) {
var favorite = {
/**
* Bind DOM events.
*
* @since 7.5.0
*
* @return {Void}
*/
bind: function() {
var self = this;
// Favorite clicked.
$( '.llms-favorite-wrapper button' ).on( 'click', function( e ) {
e.preventDefault();
self.favorite( $( this ) );
} );
// Adding class in Favorite's parent.
$( '.llms-favorite-wrapper' ).parent().addClass( 'llms-has-favorite' );
},
/**
* Favorite / Unfavorite an object.
*
* @since 7.5.0
*
* @param {Object} $btn jQuery object for the "Favorite / Unfavorite" button.
* @return {Void}
*/
favorite: function( $btn ) {
var object_id = $btn.attr( 'data-id' ),
object_type = $btn.attr( 'data-type' ),
user_action = $btn.attr( 'data-action' );
LLMS.Ajax.call( {
data: {
action: 'favorite_object',
object_id: object_id,
object_type: object_type,
user_action: user_action
},
beforeSend: function() {},
success: function( r ) {
/**
* Get all the favorite buttons on the page related to the same lesson, e.g. when the syllabus
* is shown on the sidebar of a lesson or a course, in that case you will have the same favorite
* button twice. The code below makes sure both the buttons are updated.
*/
var $fav_btns = $( '[data-id='+object_id+'][data-type='+object_type+'][data-action='+user_action+']' );
if( r.success ) {
$fav_btns.each(
function() {
if( 'favorite' === user_action ) {
$(this).find( '.llms-heart-btn' ).removeClass( 'fa-heart-o' ).addClass( 'fa-heart' );
$(this).attr( 'data-action', 'unfavorite' );
$(this).attr( 'aria-pressed', true );
} else if ( 'unfavorite' === user_action ) {
$(this).find( '.llms-heart-btn' ).removeClass( 'fa-heart' ).addClass( 'fa-heart-o' );
$(this).attr( 'data-action', 'favorite' );
$(this).attr( 'aria-pressed', false );
}
// Updating count.
$(this).closest( '.llms-favorite-wrapper' ).find( '.llms-favorites-count' ).text( r.total_favorites );
}
);
}
}
} );
}
};
favorite.bind();
window.llms = window.llms || {};
window.llms.favorites = favorite;
} )( jQuery );
================================================
FILE: assets/js/llms-focus-mode.js
================================================
/**
* LifterLMS Focus Mode sidebar toggle.
*
* @package LifterLMS
*
* @since 10.0.0
* @version 10.0.0
*/
( function() {
'use strict';
var STORAGE_KEY = 'llms_focus_sidebar_collapsed';
function init() {
var toggle = document.querySelector( '.llms-focus-mode-sidebar-toggle' );
if ( ! toggle ) {
return;
}
var body = document.body;
if ( localStorage.getItem( STORAGE_KEY ) === '1' ) {
body.classList.add( 'llms-sidebar-collapsed' );
}
toggle.addEventListener( 'click', function() {
var collapsed = body.classList.toggle( 'llms-sidebar-collapsed' );
localStorage.setItem( STORAGE_KEY, collapsed ? '1' : '0' );
} );
}
if ( document.readyState === 'loading' ) {
document.addEventListener( 'DOMContentLoaded', init );
} else {
init();
}
} )();
================================================
FILE: assets/js/llms-form-checkout.js
================================================
/**
* LifterLMS Checkout Screen related events and interactions
*
* @package LifterLMS/Scripts
*
* @since 3.0.0
* @version 7.0.0
*/
( function( $ ) {
var llms_checkout = function() {
/**
* Array of validation functions to call on form submission
*
* @type array
* @since 3.0.0
* @version 3.0.0
*/
var before_submit = [];
/**
* Array of gateways to be automatically bound when needed
*
* @type array
* @since 3.0.0
* @version 3.0.0
*/
var gateways = [];
this.$checkout_form = $( '#llms-product-purchase-form' );
this.$confirm_form = $( '#llms-product-purchase-confirm-form' );
this.$form_sections = false;
this.form_action = false;
/**
* Initialize checkout JS & bind if on the checkout screen
*
* @since 3.0.0
* @since 3.34.5 Make sure we bind click events for the Show / Hide login area at the top of the checkout screen
* even if there's no llms product purchase form.
* @since 7.0.0 Disable smooth scroll-behavior on checkout.
*
* @return void
*/
this.init = function() {
var self = this;
if ( $( '.llms-checkout-wrapper' ).length ) {
this.bind_login();
}
if ( this.$checkout_form.length ) {
this.form_action = 'checkout';
this.$form_sections = this.$checkout_form.find( '.llms-checkout-section' );
this.$checkout_form.on( 'submit', this, this.submit );
/**
* Fix `HTMLFormElement.reportValidity()` when `scroll-behavior: smooth`.
*
* @see {@link https://github.com/gocodebox/lifterlms/issues/2206}
*/
document.querySelector( 'html' ).style.scrollBehavior = 'auto';
// add before submit event for password strength meter if one's found
if ( $( '.llms-password-strength-meter' ).length ) {
this.add_before_submit_event( {
data: LLMS.PasswordStrength,
handler: LLMS.PasswordStrength.checkout,
} );
}
this.bind_coupon();
this.bind_gateways();
$( document ).trigger( "llms-checkout-refreshed" );
} else if ( this.$confirm_form.length ) {
this.form_action = 'confirm';
this.$form_sections = this.$confirm_form.find( '.llms-checkout-section' );
this.$confirm_form.on( 'submit', function() {
self.processing( 'start' );
} );
}
};
/**
* Public function which allows other classes or extensions to add
* before submit events to llms checkout private "before_submit" array
*
* @param object obj object of data to push to the array
* requires at least a "handler" key which should pass a callable function
* "data" can be anything, will be passed as the first parameter to the handler function
* @since 3.0.0
* @version 3.0.0
*/
this.add_before_submit_event = function( obj ) {
if ( ! obj.handler || 'function' !== typeof obj.handler ) {
return;
}
if ( ! obj.data ) {
obj.data = null;
}
before_submit.push( obj );
};
/**
* Add an error message
*
* @param string message error message string
* @param mixed data optional error data to output on the console
* @return void
* @since 3.27.0
* @version 3.27.0
*/
this.add_error = function( message, data ) {
var id = 'llms-checkout-errors';
$err = $( '#' + id );
if ( ! $err.length ) {
$err = $( '<ul class="llms-notice llms-error" id="' + id + '" />' );
$( '.llms-checkout-wrapper' ).prepend( $err );
}
$err.append( '<li>' + message + '</li>' );
if ( data ) {
console.error( data );
}
};
/**
* Public function which allows other classes or extensions to add
* gateways classes that should be bound by this class
*
* @param obj gateway_class callable class object
* @since 3.0.0
* @version 3.0.0
*/
this.add_gateway = function( gateway_class ) {
gateways.push( gateway_class );
};
/**
* Bind coupon add & remove button events
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.bind_coupon = function() {
var self = this;
// show & hide the coupon field & button
$( 'a[href="#llms-coupon-toggle"]' ).on( 'click', function( e ) {
e.preventDefault();
$( '.llms-coupon-entry' ).slideToggle( 400 );
} );
// apply coupon click
$( '#llms-apply-coupon' ).on( 'click', function( e ) {
e.preventDefault();
self.coupon_apply( $( this ) );
} );
// remove coupon click
$( '#llms-remove-coupon' ).on( 'click', function( e ) {
e.preventDefault();
self.coupon_remove( $( this ) );
} );
};
/**
* Bind gateway section events
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.bind_gateways = function() {
this.load_gateways();
if ( ! $( 'input[name="llms_payment_gateway"]' ).length ) {
$( '#llms_create_pending_order' ).removeAttr( 'disabled' );
}
// add class and trigger watchable event when gateway selection changes
$( 'input[name="llms_payment_gateway"]' ).on( 'change', function() {
$( 'input[name="llms_payment_gateway"]' ).each( function() {
var $el = $( this ),
$parent = $el.closest( '.llms-payment-gateway' ),
$fields = $parent.find( '.llms-gateway-fields' ).find( 'input, textarea, select' ),
checked = $el.is( ':checked' ),
display_func = ( checked ) ? 'addClass' : 'removeClass';
$parent[ display_func ]( 'is-selected' );
if ( checked ) {
// enable fields
$fields.removeAttr( 'disabled' );
// emit a watchable event for extensions to hook onto
$( '.llms-payment-gateways' ).trigger( 'llms-gateway-selected', {
id: $el.val(),
$selector: $parent,
} );
} else {
// disable fields
$fields.attr( 'disabled', 'disabled' );
}
} );
} );
// enable / disable buttons depending on field validation status
$( '.llms-payment-gateways' ).on( 'llms-gateway-selected', function( e, data ) {
var $submit = $( '#llms_create_pending_order' );
if ( data.$selector && data.$selector.find( '.llms-gateway-fields .invalid' ).length ) {
$submit.attr( 'disabled', 'disabled' );
} else {
$submit.removeAttr( 'disabled' );
}
} );
};
/**
* Bind click events for the Show / Hide login area at the top of the checkout screen
*
* @since 3.0.0
* @since 3.34.5 When showing the login form area make sure we slide up the `.llms-notice` link's parent too.
*
* @return void
*/
this.bind_login = function() {
$( 'a[href="#llms-show-login"]' ).on( 'click', function( e ) {
e.preventDefault();
$( this ).closest( '.llms-info,.llms-notice' ).slideUp( 400 );
$( 'form.llms-login' ).slideDown( 400 );
} );
};
/**
* Clear error messages
*
* @return void
* @since 3.27.0
* @version 3.27.0
*/
this.clear_errors = function() {
$( '#llms-checkout-errors' ).remove();
};
/**
* Triggered by clicking the "Apply Coupon" Button
* Validates the coupon via JS and adds error / success messages
* On success it will replace partials on the checkout screen with updated
* prices and a "remove coupon" button
*
* @param obj $btn jQuery selector of the Apply button
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.coupon_apply = function ( $btn ) {
var self = this,
$code = $( '#llms_coupon_code' ),
code = $code.val(),
$messages = $( '.llms-coupon-messages' ),
$errors = $messages.find( '.llms-error' ),
$container = $( 'form.llms-checkout' );
LLMS.Spinner.start( $container );
window.LLMS.Ajax.call( {
data: {
action: 'validate_coupon_code',
code: code,
plan_id: $( '#llms-plan-id' ).val(),
},
beforeSend: function() {
$errors.hide();
},
success: function( r ) {
LLMS.Spinner.stop( $container );
if ( 'error' === r.code ) {
var $message = $( '<li>' + r.message + '</li>' );
if ( ! $errors.length ) {
$errors = $( '<ul class="llms-notice llms-error" />' );
$messages.append( $errors );
} else {
$errors.empty();
}
$message.appendTo( $errors );
$errors.show();
} else if ( r.success ) {
$( '.llms-coupon-wrapper' ).replaceWith( r.data.coupon_html );
self.bind_coupon();
$( '.llms-payment-gateways' ).replaceWith( r.data.gateways_html );
self.bind_gateways();
$( '.llms-order-summary' ).replaceWith( r.data.summary_html );
$( document ).trigger( "llms-checkout-refreshed" );
}
}
} );
};
/**
* Called by clicking the "Remove Coupon" button
* Removes the coupon via AJAX and unsets related session data
*
* @param obj $btn jQuery selector of the Remove button
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.coupon_remove = function( $btn ) {
var self = this,
$container = $( 'form.llms-checkout' );
LLMS.Spinner.start( $container );
window.LLMS.Ajax.call( {
data: {
action: 'remove_coupon_code',
plan_id: $( '#llms-plan-id' ).val(),
},
success: function( r ) {
LLMS.Spinner.stop( $container );
if ( r.success ) {
$( '.llms-coupon-wrapper' ).replaceWith( r.data.coupon_html );
self.bind_coupon();
$( '.llms-order-summary' ).replaceWith( r.data.summary_html );
$( '.llms-payment-gateways' ).replaceWith( r.data.gateways_html );
self.bind_gateways();
$( document ).trigger( "llms-checkout-refreshed" );
}
}
} );
};
/**
* Scroll error messages into view
*
* @return void
* @since 3.27.0
* @version 3.27.0
*/
this.focus_errors = function() {
$( 'html, body' ).animate( {
scrollTop: $( '#llms-checkout-errors' ).offset().top - 50,
}, 200 );
};
/**
* Bind external gateway JS
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.load_gateways = function() {
for ( var i = 0; i <= gateways.length; i++ ) {
var g = gateways[i];
if ( typeof g === 'object' && g !== null ) {
if ( g.bind !== undefined && 'function' === typeof g.bind ) {
g.bind();
}
}
}
};
/**
* Start or stop processing events on the checkout form
*
* @param string action whether to start or stop processing [start|stop]
* @return void
* @since 3.0.0
* @version 3.24.1
*/
this.processing = function( action ) {
var func, $form;
switch ( action ) {
case 'stop':
func = 'removeClass';
break;
case 'start':
default:
func = 'addClass';
break;
}
if ( 'checkout' === this.form_action ) {
$form = this.$checkout_form;
} else if ( 'confirm' === this.form_action ) {
$form = this.$confirm_form;
}
$form[ func ]( 'llms-is-processing' );
LLMS.Spinner[ action ]( this.$form_sections );
};
/**
* Handles form submission
* Calls all validation events in `before_submit[]`
* waits for call backs and either displays returned errors
* or submits the form when all are successful
*
* @param obj e JS event object
* @return void
* @since 3.0.0
* @version 3.27.0
*/
this.submit = async function( e ) {
var self = e.data;
e.preventDefault();
// add spinners
self.processing( 'start' );
// remove errors to prevent duplicates
self.clear_errors();
// Turn every handler into a promise-returning function
function runHandler({ handler, data }) {
return new Promise((resolve, reject) => {
const timer = setTimeout(() => {
reject( new Error( LLMS.l10n.translate('Operation timed out, please try again' ) ) );
}, 60000 );
handler(data, result => {
clearTimeout( timer );
if ( result === true ) {
resolve();
} else if ( typeof result === 'string' ) {
reject( new Error( result ) );
} else {
reject( new Error( LLMS.l10n.translate( 'Unknown response' ) ) );
}
});
});
}
// Run all before-submit handlers sequentially to avoid issues of handlers interfering with each other.
try {
for ( const obj of before_submit ) {
await runHandler( obj );
}
self.$checkout_form.off( 'submit', self.submit );
self.$checkout_form.trigger( 'submit' );
self.processing( 'stop' );
} catch (err) {
self.add_error(err.message);
self.focus_errors();
self.processing( 'stop' );
}
};
// initialize
this.init();
return this;
};
window.llms = window.llms || {};
window.llms.checkout = new llms_checkout();
} )( jQuery );
================================================
FILE: assets/js/llms-launch-course-button.js
================================================
/**
* Add Launch Course Builder button to the classic editor.
*
* @since Unknown
* @version 3.35.0
*/
( function( $ ){
var mainCourseButton = $( '.page-title-action' );
if ( mainCourseButton.length ) {
// Add your custom button beside the "Add Course" button
$( '<a href="' + llms_launch_course.builder_url + '" class="page-title-action button-primary">' + LLMS.l10n.translate( 'Launch Course Builder' ) + '</a>' ).insertAfter( mainCourseButton );
}
} )( jQuery );
================================================
FILE: assets/js/llms-metabox-achievement.js
================================================
( function( $ ) {
// Open Media Manager modal.
$( '.achievement_image_button' ).click( function( e ) {
// Create Media Manager On Click to allow multiple on one Page
var achievement_uploader;
e.preventDefault();
// Setup the Variables based on the Button Clicked to enable multiple
var achievement_img_input_id = '#' + this.id + '.upload_achievement_image';
var achievement_img_src = 'img#' + this.id + '.llms_achievement_image';
// If the uploader object has already been created, reopen the dialog
if (achievement_uploader) {
achievement_uploader.open();
return;
}
// Extend the wp.media object
achievement_uploader = wp.media.frames.file_frame = wp.media({
title: 'Choose Achievement Image',
button: {
text: 'Choose Achievement'
},
multiple: false
});
// When a file is selected, grab the URL and set it as the text field's value
achievement_uploader.on('select', function() {
attachment = achievement_uploader.state().get( 'selection' ).first().toJSON();
// Set the Field with the Image ID
$( achievement_img_input_id ).val( attachment.id );
// Set the Sample Image with the URL
$( achievement_img_src ).attr( 'src', attachment.url );
});
// Open the uploader dialog
achievement_uploader.open();
});
// Remove Image and replace with default and Erase Image ID for achievement
$( '.llms_achievement_clear_image_button' ).click(function(e) {
e.preventDefault();
var achievement_remove_input_id = 'input#' + this.id + '.upload_achievement_image';
var achievement_img_src = 'img#' + this.id + '.llms_achievement_image';
var achievement_default_img_src = $( 'img#' + this.id + '.llms_achievement_default_image' ).attr( "src" );
$( achievement_remove_input_id ).val( '' );
$( achievement_img_src ).attr( 'src', achievement_default_img_src );
});
} )( jQuery );
================================================
FILE: assets/js/llms-metabox-certificate.js
================================================
jQuery( document ).ready(function($){
$( '.certificate_image_button' ).click(function(e) {
// Create Media Manager On Click to allow multiple on one Page
var certificate_uploader;
e.preventDefault();
// Setup the Variables based on the Button Clicked to enable multiple
var certificate_img_input_id = '#' + this.id + '.upload_certificate_image';
var certificate_img_src = 'img#' + this.id + '.llms_certificate_image';
// If the uploader object has already been created, reopen the dialog
if (certificate_uploader) {
certificate_uploader.open();
return;
}
// Extend the wp.media object
certificate_uploader = wp.media.frames.file_frame = wp.media({
title: 'Choose Certificate Image',
button: {
text: 'Choose Certificate'
},
multiple: false
});
// When a file is selected, grab the URL and set it as the text field's value
certificate_uploader.on('select', function() {
attachment = certificate_uploader.state().get( 'selection' ).first().toJSON();
// Set the Field with the Image ID
$( certificate_img_input_id ).val( attachment.id );
// Set the Sample Image with the URL
$( certificate_img_src ).attr( 'src', attachment.url );
});
// Open the uploader dialog
certificate_uploader.open();
});
});
/*
* Media Manager 3.5
* @version 1.70
*/
jQuery( document ).ready(function($){
// Remove Image and replace with default and Erase Image ID for Certificate
$( '.llms_certificate_clear_image_button' ).click(function(e) {
e.preventDefault();
var certificate_remove_input_id = 'input#' + this.id + '.upload_certificate_image';
var certificate_img_src = 'img#' + this.id + '.llms_certificate_image';
var certificate_default_img_src = $( 'img#' + this.id + '.llms_certificate_default_image' ).attr( "src" );
$( certificate_remove_input_id ).val( '' );
$( certificate_img_src ).attr( 'src', certificate_default_img_src );
});
});
================================================
FILE: assets/js/llms-metabox-fields.js
================================================
/**
* Global admin functions.
*
* @since Unknown
* @version 3.35.0
*/
( function( $ ){
// Toggle sales price settings.
clear_fields = function (fields) {
var fields = fields;
$.each( fields, function( i, val ) {
$( val ).val( '' );
});
}
// Load ajax animation functionality
load_ajax_animation = function() {
$( '#loading' ).hide();
$( document ).ajaxStop(function(){
$( '#loading' ).hide();
});
$( document ).ajaxStart(function(){
$( '#loading' ).show();
});
}
} )( jQuery );
================================================
FILE: assets/js/llms-metabox-instructors.js
================================================
/**
* Instructors Metabox
*
* @since 3.13.0
* @version 3.13.0
*/
( function( $ ) {
window.llms = window.llms || {};
window.llms.metabox_instructors = function() {
/**
* Initialize
*
* @return void
* @since 3.13.0
* @version 3.13.0
*/
this.init = function() {
// before saving, update the wp core hidden field for post_author
// so that the first instructor is always set as the post author
$( '._llms_instructors_data.repeater' ).on( 'llms-repeater-before-save', function( e, params ) {
var author_id = params.$el.find( '.llms-repeater-rows .llms-repeater-row' ).first().find( 'select[name^="_llms_id"]' ).val();
$( '#post_author' ).val( author_id );
} );
$( '._llms_instructors_data.repeater' ).on( 'llms-new-repeater-row', function( e, params ) {
var $instructor = params.$row.find( 'select[name^="_llms_id"]' ),
$target = params.$row.find( '.llms-repeater-title' );
$instructor.on( 'select2:select', function( e ) {
if ( ! e.params ) {
$target.html( $instructor.find( 'option[selected="selected"]' ).html() );
} else {
$target.text( e.params.data.text );
}
} ).trigger( 'select2:select' );
} );
};
// go
this.init();
};
var a = new window.llms.metabox_instructors();
} )( jQuery );
================================================
FILE: assets/js/llms-metabox-options.js
================================================
/**
* JS for the Course and Membership metabox options
*
* @since 8.0.0
*/
( function( $ ){
$( '.llms-mb-container .llms-basic-editor' ).each( function() {
const name = $( this ).attr( 'data-name' );
const ed = new Quill( this, {
modules: {
toolbar: ['bold', 'italic', 'underline', 'strike', { 'script': 'sub'}, { 'script': 'super' }],
keyboard: {
bindings: {
tab: {
key: 9,
handler: function( range, context ) {
return true;
},
},
13: {
key: 13,
handler: function( range, context ) {
ed.root.blur();
return false;
},
},
},
},
},
placeholder: $( this ).attr( 'data-placeholder' ),
theme: 'bubble',
} );
const keyboard = ed.getModule('keyboard');
keyboard.bindings['Enter'] = null;
ed.on( 'text-change', function() {
$( 'input[name="' + name + '"]' ).val( ed.getSemanticHTML() );
});
} );
} )( jQuery );
================================================
FILE: assets/js/llms-metabox-product.js
================================================
/**
* Product Options MetaBox.
*
* Displays on Course & Membership Post Types.
*
* @since 3.0.0
* @since 3.30.3 Unknown.
* @since 3.36.3 Fixed conflicts with the Classic Editor block.
* @version 7.3.0
*/
( function( $ ) {
window.llms = window.llms || {};
window.llms.metabox_product = function() {
/**
* jQuery obj for the main $( '#llms-access-plans' ) element.
*
* @type obj
*/
this.$plans = null;
/**
* jQuery obj for the main $( '#llms-save-access-plans' ) save button element.
*
* @type obj
*/
this.$save = null;
this.$plan_dialog = null;
/**
* A randomly generated temporary ID used for the tinyMCE editor's id
* when a new plan is added
*
* @type int
*/
this.temp_id = Math.floor( ( Math.random() * 7777 ) + 777 );
/**
* CSS class name used to highlight validation errors for plan fields
*
* @type string
*/
this.validation_class = 'llms-invalid';
/**
* Initialize.
*
* @param bool skip_dep_checks If true, skips dependency checks.
*
* @since 3.0.0
* @since 3.29.3 Unknown.
* @since 7.3.0 Check on whether access plans require attention.
*
* @return {Void}
*/
this.init = function( skip_dep_checks ) {
var self = this;
self.$plans = $( '#llms-access-plans' );
self.$save = $( '#llms-save-access-plans' );
self.bind_visibility();
var $mb = $( '#lifterlms-product #llms-product-options-access-plans' );
if ( ! $mb.length ) {
return;
}
// Check whether the warning icon should be displayed.
self.requiresAttention();
if ( skip_dep_checks ) {
self.bind();
return;
}
LLMS.Spinner.start( $mb );
// we rely on TinyMCE but WordPress doesn't register TinyMCE
// like every other admin script so we'll do a little dependency check here...
var counter = 0,
interval;
interval = setInterval( function() {
// if we get to 30 seconds display an error message
if ( counter >= 300 ) {
$mb.html( LLMS.l10n.translate( 'There was an error loading the necessary resources. Please try again.' ) );
}
// if we can't access tinyMCE, increment and wait...
else if ( 'undefined' === typeof tinyMCE ) {
counter++;
return;
}
// bind the events, we're good!
else {
self.bind();
}
clearInterval( interval );
LLMS.Spinner.stop( $mb );
}, 100 );
};
/**
* Bind DOM Events.
*
* @since 3.0.0
* @since 3.30.0 Add checkout redirect fields events.
*
* @return {Void}
*/
this.bind = function() {
var self = this;
setTimeout( function() {
if ( self.has_plan_limit_been_reached() ) {
self.toggle_create_button( 'disable' );
}
}, 500 );
if ( 0 === self.get_current_plan_count() ) {
self.toggle_save_button( 'disable' );
}
// save access plans button.
self.$save.on( 'click', function( e ) {
e.preventDefault();
self.save_plans();
} );
// bind change events to form element that controls another form element
self.$plans.on( 'change', '[data-controller-id]', function() {
self.controller_change( $( this ) );
} );
// @todo Replace this with multiple data-controller functionality in llms-metaboxes.js
self.$plans.on( 'change', 'select[name$="[availability]"]', function() {
var $plan_container = $( this ).closest( '.llms-access-plan' ),
$plan_redirect_forced = $plan_container.find( 'input[name$="[checkout_redirect_forced]"]' ),
$plan_redirect_settings = $plan_container.find( '.llms-checkout-redirect-settings' );
if ( 'members' === $( this ).val() ) {
if ( ! $plan_redirect_forced.prop( 'checked' ) ) {
$plan_redirect_settings.hide();
} else {
$plan_redirect_settings.show();
}
$plan_redirect_forced.on( 'change', function() {
$plan_redirect_settings.toggle();
} );
} else {
$plan_redirect_forced.off( 'change' );
$plan_redirect_settings.show();
}
} );
$( '#llms-access-plans .llms-access-plan-datepicker' ).datepicker( {
dateFormat: "mm/dd/yy"
} );
// trigger changes on load for all existing plans
$( '#llms-access-plans [data-controller-id]' ).trigger( 'change' );
var dialogEl = document.getElementById( 'llms-access-plan-dialog' );
if ( dialogEl ) {
self.$plan_dialog = new A11yDialog( dialogEl );
}
// If PMPro or others are hiding the Restrictions tab, or there's no time period option, we want to hide the Presell option.
if ( ! $( 'span.llms-nav-link' ).filter(function() {
return $( this ).text().trim() === LLMS.l10n.translate( 'Restrictions' );
}).length ||
! $( '#_llms_time_period' ).length ) {
$( '.llms-access-plan-templates button[data-template="presell"]' ).hide();
}
// add a new empty plan interface on new plan button click.
$( '#llms-new-access-plan' ).on( 'click', function() {
self.init_plan();
if ( self.$plan_dialog ) {
self.$plan_dialog.show();
}
self.toggle_create_button( 'disable' );
self.toggle_save_button( 'enable' );
setTimeout( function() {
if ( ! self.has_plan_limit_been_reached() ) {
self.toggle_create_button( 'enable' );
}
}, 500 );
} );
$( '#llms-access-plan-dialog .llms-access-plan-templates button.template').on( 'click', function( e ) {
e.preventDefault();
if ( self.$plan_dialog ) {
self.$plan_dialog.hide();
}
var $last_access_plan = self.$plans.find( '.llms-access-plan' ).last();
switch ( $( this ).attr( 'data-template' ) ) {
case 'free':
$last_access_plan.find('input[name^="_llms_plans["][name$="[title]"]').val( LLMS.l10n.translate( 'Free' ) ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[is_free]"]').val( 'yes' ).change();
break;
case 'monthly':
$last_access_plan.find('input[name^="_llms_plans["][name$="[title]"]').val( LLMS.l10n.translate( 'Monthly' ) ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[price]"]').val( '100' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[frequency]"]').val( '1' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[period]"]').val( 'month' ).change();
break;
case 'annual':
$last_access_plan.find('input[name^="_llms_plans["][name$="[title]"]').val( LLMS.l10n.translate( 'Annual' ) ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[price]"]').val( '1000' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[frequency]"]').val( '1' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[period]"]').val( 'year' ).change();
break;
case 'one-time':
$last_access_plan.find('input[name^="_llms_plans["][name$="[title]"]').val( LLMS.l10n.translate( 'One Time' ) ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[price]"]').val( '1000' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[frequency]"]').val( '0' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[access_expiration]"]').val( 'limited-period' ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[access_length]"]').val( '1' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[access_period]"]').val( 'year' ).change();
break;
case 'lifetime':
$last_access_plan.find('input[name^="_llms_plans["][name$="[title]"]').val( LLMS.l10n.translate( 'Lifetime' ) ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[price]"]').val( '1000' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[frequency]"]').val( '0' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[access_expiration]"]').val( 'lifetime' ).change();
break;
case 'paid-trial':
$last_access_plan.find('input[name^="_llms_plans["][name$="[title]"]').val( LLMS.l10n.translate( 'Paid Trial' ) ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[price]"]').val( '100' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[frequency]"]').val( '1' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[period]"]').val( 'month' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[trial_offer]"]').val( 'yes' ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[trial_price]"]').val( '1' ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[trial_length]"]').val( '1' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[trial_period]"]').val( 'week' ).change();
break;
case 'free-trial':
$last_access_plan.find('input[name^="_llms_plans["][name$="[title]"]').val( LLMS.l10n.translate( 'Free Trial' ) ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[price]"]').val( '100' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[frequency]"]').val( '1' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[period]"]').val( 'month' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[trial_offer]"]').val( 'yes' ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[trial_price]"]').val( '0' ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[trial_length]"]').val( '1' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[trial_period]"]').val( 'week' ).change();
break;
case 'hidden-access':
$last_access_plan.find('input[name^="_llms_plans["][name$="[title]"]').val( LLMS.l10n.translate( 'Hidden Access' ) ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[visibility]"]').val( 'hidden' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[is_free]"]').val( 'yes' ).change();
break;
case 'sale':
$last_access_plan.find('input[name^="_llms_plans["][name$="[title]"]').val( LLMS.l10n.translate( 'Sale' ) ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[price]"]').val( '1000' ).change();
$last_access_plan.find('select[name^="_llms_plans["][name$="[on_sale]"]').val( 'yes' ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[sale_price]"]').val( '500' ).change();
break;
case 'presell':
$last_access_plan.find('input[name^="_llms_plans["][name$="[title]"]').val( LLMS.l10n.translate( 'Pre-sale' ) ).change();
$last_access_plan.find('input[name^="_llms_plans["][name$="[price]"]').val( '1000' ).change();
var $restrictions_tab = $('span.llms-nav-link').filter(function() {
return $(this).text().trim() === 'Restrictions';
});
if ( $restrictions_tab.length ) {
$restrictions_tab.click();
if ( ! $('#_llms_time_period').is(':checked') ) {
$('#_llms_time_period').click();
}
var today = new Date();
today.setMonth(today.getMonth() + 1);
var month = (today.getMonth() + 1).toString().padStart(2, '0');
var day = today.getDate().toString().padStart(2, '0');
var year = today.getFullYear().toString();
var formattedDate = `${month}/${day}/${year}`;
$('#_llms_start_date').val( formattedDate ).change();
// TODO: Add some kind of a notice or something to let the user know that the start date has been set.
}
break;
case 'advanced':
break;
default:
self.$plans.trigger( 'llms-access-plan-template-' + $( this ).attr( 'data-template' ) );
break;
}
} );
self.$plans.sortable( {
handle: '.llms-drag-handle',
items: '.llms-access-plan',
start: function( event, ui ) {
self.$plans.addClass( 'dragging' );
},
stop: function( event, ui ) {
self.$plans.removeClass( 'dragging' );
self.update_plan_orders();
},
} );
// bind text entered into the title to the displayed title for fancy fun
self.$plans.on( 'keyup', 'input.llms-plan-title', function( ) {
var $input = $( this ),
$plan = $input.closest( '.llms-access-plan' ),
$display = $plan.find( 'span.llms-plan-title' ),
val = $input.val(),
title = ( val ) ? val : $display.attr( 'data-default' );
$display.text( title );
} );
// Record that a field has been focused so we can tweak validation to only validate "edited" fields.
self.$plans.on( 'focusin', 'input', function( e, data ) {
$( this ).addClass( 'llms-has-been-focused' );
} );
// Validate a single input field
self.$plans.on( 'keyup focusout llms-validate-plan-field', 'input', function( e, data ) {
var $input = $( this );
if ( $input[0].checkValidity() ) {
$input.removeClass( self.validation_class );
} else {
$input.addClass( self.validation_class );
if ( 'keyup' === e.type ) {
$input[0].reportValidity();
}
}
if ( ! data || data.cascade ) {
$input.closest( '.llms-access-plan' ).trigger( 'llms-validate-plan', { original_event: e.type } );
}
} );
self.$plans.on( 'llms-validate-plan', '.llms-access-plan', function( e, data ) {
data = data || {};
var $plan = $( this ),
// only validate "edited" fields during cascading validation from input validations.
selector = data.original_event ? 'input.llms-has-been-focused' : 'input';
$plan.find( selector ).each( function() {
$( this ).trigger( 'llms-validate-plan-field', { cascade: false } );
} );
if ( $plan.find( '.' + self.validation_class ).length ) {
$plan.addClass( self.validation_class );
} else {
$plan.removeClass( self.validation_class );
}
} );
self.$plans.on( 'llms-collapsible-toggled', '.llms-access-plan', function() {
var $plan = $( this );
if ( $plan.hasClass( 'opened' ) ) {
// wait for animation to complete to prevent focusable errors in the console.
setTimeout( function() {
$plan.find( 'input.llms-invalid' ).each( function() {
$( this )[0].reportValidity();
} );
}, 500 );
}
} );
self.$plans.on( 'click', '.llms-plan-delete', function( e ) {
e.stopPropagation();
self.delete_plan( $( this ) );
} );
// select2ify membership availability fields
window.llms.metaboxes.post_select( $( '#llms-access-plans .llms-availability-restrictions' ) );
// select2ify redirection page fields
window.llms.metaboxes.post_select( $( '#llms-access-plans .llms-checkout-redirect-page' ) );
// disable the textarea generated by the wp_editor function
// can't figure out how to do this during initialization
$( '#_llms_plans_content_llms-new-access-plan-model' ).attr( 'disabled', 'disabled' );
tinyMCE.EditorManager.execCommand( 'mceRemoveEditor', true, '_llms_plans_content_llms-new-access-plan-model' );
};
/**
* Bind DOM events for editing product visibility
*
* @return void
* @since 3.6.0
* @version 3.6.0
*/
this.bind_visibility = function() {
var $radios = $( '#llms-catalog-visibility-select' ),
$toggle = $( 'a.llms-edit-catalog-visibility' ),
$save = $( 'a.llms-save-catalog-visibility' ),
$cancel = $( 'a.llms-cancel-catalog-visibility' );
$toggle.on( 'click', function( e ) {
e.preventDefault();
$radios.slideDown( 'fast' );
$toggle.hide();
} );
$save.on( 'click', function( e ) {
e.preventDefault();
$radios.slideUp( 'fast' );
$toggle.show();
$( '#llms-catalog-visibility-display' ).text( $( 'input[name="_llms_visibility"]:checked' ).attr( 'data-label' ) );
} );
$cancel.on( 'click', function( e ) {
e.preventDefault();
$radios.slideUp( 'fast' );
$toggle.show();
} );
};
/**
* Checks whether the access plan requires attention, e.g. because it contains notices.
*
* And if so adds the class `llms-needs-attention` to the access plan.
*
* @since 7.3.0
*
* @return {Void}
*/
this.requiresAttention = function() {
var self = this;
self.$plans.find( '.llms-access-plan' ).each(
function() {
$(this).toggleClass( 'llms-needs-attention', $(this).find('.notice').not('.llms-payment-gateway-warning').length > 0 );
}
);
}
/**
* Handle physical deletion of a plan element
* If the plan hasn't be persisted to the database it's removed from the dom
* if it already exists in the database a confirm modal is displayed
* upon confirmation AJAX call will be made to move the plan to the trash
* and upon success the element will be removed from the dom
*
* @param obj $btn jQuery selector of the "X" button clicked to initiate deletion
* @return void
* @since 3.0.0
* @version 3.29.1
*/
this.delete_plan = function( $btn ) {
var self = this,
$plan = $btn.closest( '.llms-access-plan' ),
plan_id = $plan.attr( 'data-id' ),
warning = LLMS.l10n.translate( 'After deleting this access plan, any students subscribed to this plan will still have access and will continue to make recurring payments according to the access plan\'s settings. If you wish to terminate their plans you must do so manually. This action cannot be reversed.' );
// if there's no ID just remove the element from the DOM
if ( ! plan_id ) {
self.remove_plan_el( $plan );
// Throw a confirmation warning
} else if ( window.confirm( warning ) ) {
LLMS.Spinner.start( $plan );
window.LLMS.Ajax.call( {
data: {
action: 'delete_access_plan',
plan_id: plan_id,
},
success: function( r ) {
setTimeout( function() {
LLMS.Spinner.stop( $plan );
}, 550 );
if ( r.success ) {
self.remove_plan_el( $plan );
self.trigger_update_hook();
setTimeout( function() {
self.update_plan_orders();
}, 500 );
} else if ( r.message ) {
alert( r.message );
}
}
} );
}
};
/**
* Handle hiding & showing various pieces of an access plan form
* This is bound to any form element with a "data-controller-id" property
*
* @param obj $el jQuery selector for the changed form element
* @return void
* @since 3.0.0
*/
this.controller_change = function( $el ) {
var id = $el.attr( 'data-controller-id' ),
val = $el.val(),
$form = $el.closest( '.llms-access-plan' ),
$controls = $form.find( '[data-controller="' + id + '"]' );
if ( 'checkbox' === $el.attr( 'type' ) ) {
val = ( $el.is( ':checked' ) ) ? val : 'no';
}
$controls.each( function() {
var $c = $( this ),
$els = ( 'SELECT' === $c[0].nodeName || 'INPUT' === $c[0].nodeName || 'TEXTAREA' === $c[0].nodeName ) ? $c : $c.find( 'input, select, textarea' ),
equals = $c.attr( 'data-value-is' ),
not_equals = $c.attr( 'data-value-is-not' ),
action, operator;
if ( typeof equals !== typeof undefined && equals !== false ) {
operator = '==';
} else if ( typeof not_equals !== typeof undefined && not_equals !== false ) {
operator = '!=';
}
switch ( operator ) {
case '==':
if ( val == equals ) {
action = 'show';
} else {
action = 'hide';
}
break;
case '!=':
if ( val != not_equals ) {
action = 'show';
} else {
action = 'hide';
}
break;
}
if ( 'show' === action ) {
$c.show();
$els.removeAttr( 'disabled' ).trigger( 'change' );
} else if ( 'hide' === action ) {
$c.hide();
$els.attr( 'disabled', 'disabled' );
}
} );
};
/**
* Retrieve the current number of access plans for the course / membership (saved or unsaved)
*
* @return int
* @since 3.29.0
* @version 3.29.0
*/
this.get_current_plan_count = function() {
return this.$plans.find( '.llms-access-plan' ).length;
}
/**
* Retrieve access plan data as an array of JSON built from the dom element field values.
*
* @return array
* @since 3.29.0
* @version 3.29.0
*/
this.get_plans_array = function() {
// ensure all content editors are saved properly.
tinyMCE.triggerSave();
var self = this,
form = self.$plans.closest( 'form' ).serializeArray(),
plans = [];
for ( var i = 0; i < form.length; i++ ) {
// Skip non plan data from the form.
if ( -1 === form[ i ].name.indexOf( '_llms_plans' ) ) {
continue;
}
var keys = form[ i ].name.replace( '_llms_plans[', '' ).split( '][' ),
index = ( keys[0] * 1 ) - 1,
name = keys[1].replace( ']', '' ),
type = 3 === keys.length ? 'array' : 'single';
if ( ! plans[ index ] ) {
plans[ index ] = {};
}
if ( 'array' === type ) {
if ( ! plans[ index ][ name ] ) {
plans[ index ][ name ] = [];
}
plans[ index ][ name ].push( form[ i ].value );
} else {
plans[ index ][ name ] = form[ i ].value;
}
}
return plans;
};
/**
* Determine if the access plan limit has been reached
*
* @return Boolean
* @since 3.0.0
* @version 3.29.0
*/
this.has_plan_limit_been_reached = function() {
var limit = window.llms.product.access_plan_limit;
return this.get_current_plan_count() >= limit;
};
/**
* Initializes a new plan and adds it to the list of plans in the DOM
*
* @since 3.0.0
* @since 3.30.0 Initialize select2 on checkout redirect fields.
* @version 3.30.0
*
* @return void
*/
this.init_plan = function() {
// don't do anything if we've reached the plan limit
if ( this.has_plan_limit_been_reached() ) {
return;
}
var $clone = $( '#llms-new-access-plan-model' ).clone()
$existing_plans = $( '#llms-access-plans .llms-access-plan' ),
$editor = $clone.find( '#_llms_plans_content_llms-new-access-plan-model' );
// remove ID from the item
$clone.removeAttr( 'id' );
// give a temporary id to the editor element
$editor.removeAttr( 'id' ).attr( 'id', '_llms_plans_content_' + this.temp_id );
this.temp_id++; // increment the temp_id ID so we don't use it again
// activate all elements
$clone.find( 'select, input, textarea' ).each( function() {
$( this ).removeAttr( 'disabled' ); // enabled the field
} );
$clone.appendTo( '#llms-access-plans' );
// rewrite the order of all elements
this.update_plan_orders();
// Bind the datepicker to the new plan AFTER the input names have been updated via update_plan_orders() above.
$clone.find( '.llms-access-plan-datepicker' ).datepicker( {
dateFormat: "mm/dd/yy"
} );
$clone.find( '.llms-collapsible-header' ).trigger( 'click' );
// check if the limit has been reached and toggle the button if it has
if ( this.has_plan_limit_been_reached() ) {
this.toggle_create_button( 'disable' );
}
// select2ify membership availability field
window.llms.metaboxes.post_select( $clone.find( '.llms-availability-restrictions' ) );
// select2ify redirection page fields
window.llms.metaboxes.post_select( $clone.find( '.llms-checkout-redirect-page' ) );
$clone.find( '[data-controller-id]' ).trigger( 'change' );
$( document ).trigger( 'llms-plan-init', $clone );
};
/**
* Persist access plans to the DB if they pass validation
*
* @since 3.29.0
* @since 3.30.3 Fixed typo in error message.
*
* @return void
*/
this.save_plans = function() {
var self = this;
self.$plans.find( '.llms-access-plan' ).not( '#llms-new-access-plan-model' ).each( function() {
$( this ).trigger( 'llms-validate-plan' );
} );
if ( self.$plans.find( '.' + self.validation_class ).length ) {
self.$plans.find( '.llms-access-plan.' + self.validation_class ).not( '.opened' ).first().find( '.llms-collapsible-header' ).trigger( 'click' );
$( document ).trigger( 'llms-access-plan-validation-errors' );
return;
}
LLMS.Spinner.start( self.$plans );
self.$save.attr( 'disabled', 'disabled' );
window.LLMS.Ajax.call( {
data: {
action: 'llms_update_access_plans',
plans: self.get_plans_array(),
},
complete: function() {
LLMS.Spinner.stop( self.$plans );
self.$save.removeAttr( 'disabled' );
},
error: function( jqXHR, textStatus, errorThrown ) {
console.error( 'llms access plan save error encounterd:', jqXHR );
alert( LLMS.l10n.translate( 'An error was encountered during the save attempt. Please try again.' ) + ' [' + textStatus + ': ' + errorThrown + ']' );
},
success: function( res ) {
if ( ! res.success && res.code && 'error' === res.code ) {
alert( res.message );
} else if ( res.data && res.data.html ) {
// replace the metabox with updated data from the server.
$( '#llms-product-options-access-plans' ).replaceWith( res.data.html );
// reinit.
self.init( true );
window.llms.metaboxes.init();
self.update_plan_orders();
// notify the block editor
self.trigger_update_hook();
}
},
} );
};
/**
* Toggle the status of a button
*
* @param Object $btn jQuery selector of a button element
* @param string status enable or disable
* @return void
* @since 3.29.0
* @version 3.29.0
*/
this.toggle_button = function( $btn, status ) {
if ( 'disable' === status ) {
$btn.attr( 'disabled', 'disabled' );
} else {
$btn.removeAttr( 'disabled' );
}
};
/**
* Control the status of the "New Access Plan" Button
*
* @param string status enable or disable
* @return void
* @since 3.0.0
* @since 3.29.0
*/
this.toggle_create_button = function( status ) {
this.toggle_button( $( '#llms-new-access-plan' ), status );
};
/**
* Control the status of the "Save Access Plans" Button
*
* @param string status enable or disable
* @return void
* @since 3.0.0
* @since 3.29.0
*/
this.toggle_save_button = function( status ) {
this.toggle_button( this.$save, status );
}
/**
* Visually hide and then physically remove a plan element from the DOM
* Additionally determines if the New Plan Button should be re-enabled
* after deletion
*
* @param obj $plan jQuery selector of the plan element
* @return void
* @since 3.0.0
* @version 3.29.0
*/
this.remove_plan_el = function( $plan ) {
var self = this;
// fade out nicely
$plan.fadeOut( 400 );
// remove from dom after it's hidden visually
setTimeout(function() {
$plan.remove();
// check if we need to reenable the create button and hide the message
if ( ! self.has_plan_limit_been_reached() ) {
self.toggle_create_button( 'enable' );
}
if ( 0 === self.get_current_plan_count() ) {
self.toggle_save_button( 'disable' );
}
}, 450 );
};
/**
* Trigger WP Block Editor hook so the pricing table block can be re-rendered with new plan information.
*
* @return void
* @since 3.29.0
* @version 3.29.0
*/
this.trigger_update_hook = function() {
$( document ).trigger( 'llms-access-plans-updated' );
};
/**
* Reorder the array indexes and the menu order hidden inputs.
* Called by jQuery UI Sortable on sort completion.
* Also called after adding a new plan to the DOM so the newest item is always
* persisted as the last in the database if no UX reorders the item.
*
* @since 3.0.0
* @since 3.36.3 Fixed conflicts with the classic editor block.
*
* @return void
*/
this.update_plan_orders = function() {
$( '#llms-access-plans .llms-access-plan' ).each( function() {
var $p = $( this ),
$order = $p.find( '.plan-order' ),
$editor = $p.find( 'textarea[id^="_llms_plans_content_"]' ),
editor_id = $editor.attr( 'id' ),
orig = $order.val() * 1,
curr = $p.index(),
editor = tinyMCE.EditorManager.get(editor_id),
esettings = editor ? editor.settings : tinyMCE.EditorManager.settings;
// make sure the editor settings have the right selector.
esettings.selector = '#' + editor_id;
// de-init tinyMCE from the editor.
tinyMCE.EditorManager.execCommand( 'mceRemoveEditor', true, editor_id );
// update the order of each label and field in the plan.
$p.find( 'label, select, input, textarea' ).each( function() {
var labelFor = $( this ).attr( 'for' );
if ( labelFor ) {
$( this ).attr( 'for', labelFor.replace( orig, curr ) );
}
var inputID = $( this ).attr( 'id' );
if ( inputID ) {
$( this ).attr( 'id', inputID.replace( orig, curr ) );
}
var inputName = $( this ).attr( 'name' );
if ( inputName ) {
$( this ).attr( 'name', inputName.replace( orig, curr ) );
}
} );
// re-init tinyMCE on the editor.
// We used: tinyMCE.EditorManager.execCommand( 'mceAddEditor', true, editor_id );
// but it turned out to create conflicts with the Classic Editor block.
tinyMCE.EditorManager.init( esettings );
$order.val( curr );
} );
};
// go
this.init();
};
var a = new window.llms.metabox_product();
} )( jQuery );
================================================
FILE: assets/js/llms-metabox-students.js
================================================
/**
* LifterLMS Students Metabox Functions
*
* @package LifterLMS/Scripts
*
* @since 3.0.0
* @version 3.33.0
*/
/**
* LifterLMS Students Metabox Functions
*
* @since 3.0.0
* @since 3.33.0 Added the logic to handle the Student's enrollment deletion.
*/
( function( $, undefined ) {
window.llms = window.llms || {};
var MetaboxStudents = function() {
/**
* Initialize
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.init = function() {
var screens = [ 'course', 'llms_membership' ];
if ( window.llms.post.post_type && -1 !== screens.indexOf( window.llms.post.post_type ) ) {
this.$metabox = $( '#lifterlms-students' );
this.bind();
}
};
/**
* Bind dom events
*
* @since 3.0.0
* @since 3.4.0 Unknown.
* @since 3.33.0 Added enrollment deletion handlers.
*
* @return void
*/
this.bind = function() {
var self = this;
this.$metabox.on( 'click', 'a.llms-remove-student', function( e ) {
e.preventDefault();
self.remove_student( $( this ) );
} );
this.$metabox.on( 'click', 'a.llms-delete-enrollment', function( e ) {
e.preventDefault();
self.delete_student_enrollment( $( this ) );
} );
this.$metabox.on( 'click', 'a.llms-add-student', function( e ) {
e.preventDefault();
self.add_student( $( this ) );
} );
$( '#llms-add-student-select' ).llmsStudentsSelect2( { multiple: true } );
$( '#llms-enroll-students' ).on( 'click', function() {
self.enroll_students( $( this ) );
} );
};
/**
* Add a Student
*
* @param obj $el jQuery selector of the add button
* @since 3.0.0
* @version 3.0.0
*/
this.add_student = function( $el ) {
this.update_student_enrollment( $el.attr( 'data-id' ), 'add' );
};
/**
* Handle bulk enrollment via "Enroll New Students" area
*
* @param obj $el jQuery selector for the triggering button
* @return void
* @since 3.0.0
* @version 3.4.0
*/
this.enroll_students = function( $el ) {
var self = this,
$select = $( '#llms-add-student-select' ),
ids = $select.val(),
$container = this.$metabox.find( '.llms-metabox-students-add-new' );
LLMS.Spinner.start( $container );
window.LLMS.Ajax.call( {
data: {
action: 'bulk_enroll_students',
student_ids: ids,
},
beforeSend: function( xhr ) {
if ( ! ids ) {
$el.before( '<span class="llms-error">' + LLMS.l10n.translate( 'Please select a student to enroll' ) + '</span>' );
xhr.abort();
LLMS.Spinner.stop( $container );
}
},
success: function( r ) {
$select.val( null ).trigger( 'change' );
LLMS.Spinner.stop( $container );
window.llms.admin_tables.reload( $( '#llms-gb-table-student-management' ) );
},
} );
};
/**
* Remove a Student
*
* @param obj $el jQuery selector of the add button
* @since 3.0.0
* @version 3.0.0
*/
this.remove_student = function( $el ) {
this.update_student_enrollment( $el.attr( 'data-id' ), 'remove' );
};
/**
* Delete a Student's enrollment.
*
* @since 3.33.0
*
* @param obj $el jQuery selector of the add button.
* @return void
*/
this.delete_student_enrollment = function( $el ) {
this.update_student_enrollment( $el.attr( 'data-id' ), 'delete' );
};
/**
* Execute AJAX call, add spinners, update html view
*
* @since 3.0.0
*
* @param int id Student id.
* @param string status New status [add|remove|delete].
* @return void
*/
this.update_student_enrollment = function( id, status ) {
var $table = $( '#llms-gb-table-student-management' ),
$container = $table.closest( '.llms-table-wrap' );
LLMS.Spinner.start( $container );
window.LLMS.Ajax.call( {
data: {
action: 'update_student_enrollment',
status: status,
student_id: id,
},
success: function() {
// spinner doesn't stop because the table reloader will stop it
window.llms.admin_tables.reload( $table );
},
} );
};
// go
this.init();
};
// initialize the object
window.llms.MetaboxStudents = new MetaboxStudents();
} )( jQuery );
================================================
FILE: assets/js/llms-metabox-voucher.js
================================================
( function( $ ) {
var deleteIds = [];
$( document ).ready( function () {
var changeNotSaved = false;
var codesAddedSinceLastSave = 0;
$( '#llms_voucher_add_codes' ).click(function ( e ) {
e.preventDefault();
var qty = $( '#llms_voucher_add_quantity' ).val();
var uses = $( '#llms_voucher_add_uses' ).val();
var html = '';
changeNotSaved = true;
if ( $.isNumeric( qty ) && $.isNumeric( uses ) ) {
if ( parseInt( qty ) > 0 && parseInt( uses ) > 0 ) {
if ( qty > 50 ) {
alert( "You can only generate 50 rows at a time" );
return;
}
codesAddedSinceLastSave += parseInt( qty );
if ( codesAddedSinceLastSave > 50 ) {
alert( "Please save before adding any more codes, limit is 50 at a time" );
codesAddedSinceLastSave -= parseInt( qty );
return;
}
for ( var i = 1; i <= parseInt( qty ); i++ ) {
html += '<tr>' +
'<td></td>' +
'<td>' +
'<input type="text" maxlength="20" placeholder="Code" value="' + randomizeCode() + '" name="llms_voucher_code[]">' +
'<input type="hidden" name="llms_voucher_code_id[]" value="0">' +
'</td>' +
'<td><span>0 / </span><input type="text" placeholder="Uses" value="' + uses + '" class="llms-voucher-uses" name="llms_voucher_uses[]"></td>' +
'<td><a href="#" class="llms-voucher-delete">' + delete_icon + '</a></td>' +
'</tr>';
}
}
}
$( '#llms_voucher_tbody' ).append( html );
bindDeleteVoucherCode();
} );
bindDeleteVoucherCode();
$( '#llms_voucher_tbody input' ).change( function() {
changeNotSaved = true;
} );
$( "#post" ).on( 'submit', function() {
if ( $( '#publish' ).attr( 'name' ) === 'publish' ) {
$( '<input />' ).attr( 'type', 'hidden' )
.attr( 'name', "publish" )
.attr( 'value', "true" )
.appendTo( '#post' );
}
return true;
} );
window.onbeforeunload = function() {
return changeNotSaved ? "If you leave this page you will lose your unsaved changes." : null;
};
$( 'input[type=submit][name=publish], input[type=submit][name=save]' ).click( function ( e ) {
var unique_values = {};
var duplicate = false;
$( 'input[name="llms_voucher_code[]"]' ).each( function() {
var val = $( this ).val()
if ( ! unique_values[val] ) {
unique_values[val] = true;
} else {
$( this ).css( 'background-color', 'rgba(226, 96, 73, 0.6)' );
duplicate = true;
}
} );
if ( duplicate ) {
alert( 'Please make sure that there are no duplicate voucher codes.' );
return false;
}
// If course or membership is not selected, don't allow user to save.
if ( ! $( '#_llms_voucher_courses' ).val().length && ! $( '#_llms_voucher_membership' ).val().length ) {
alert( 'Please select course or membership before saving.' );
return false;
}
changeNotSaved = false;
check_voucher_duplicate();
return false;
} );
function bindDeleteVoucherCode() {
$( '.llms-voucher-delete' ).unbind( 'click' );
$( '.llms-voucher-delete' ).click( function ( e ) {
e.preventDefault();
var t = $( this );
var old = t.data( 'id' );
changeNotSaved = true;
if ( old ) {
deleteIds.push( old );
$( '#delete_ids' ).val( deleteIds.join( ',' ) );
} else {
codesAddedSinceLastSave--;
}
// remove html block
t.closest( 'tr' ).remove();
} );
}
} );
function randomizeCode() {
var text = '';
var possible = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
for ( var i = 0; i < 12; i++ ) {
text += possible.charAt( Math.floor( Math.random() * possible.length ) );
}
return text;
}
/**
* Check for voucher duplicates in other posts.
*
* @since Unknown
* @since 5.9.0 Add nonce.
* @since 7.1.3 Add check for empty vouchers.
*
* @return {void}
*/
function check_voucher_duplicate() {
var vouchers = get_codes_from_inputs();
if( ! vouchers.length ) {
$( "#post" ).submit();
return;
}
var data = {
action: 'check_voucher_duplicate',
postId: $( '#post_ID' ).val(),
codes: vouchers,
_ajax_nonce: window.llms.ajax_nonce,
};
var ajax = new Ajax( 'post', data, false );
ajax.check_voucher_duplicate();
}
function get_codes_from_inputs() {
var codes = [];
$( 'input[name="llms_voucher_code[]"]' ).each( function() {
codes.push( $( this ).val() );
} );
return codes;
}
} )( jQuery );
function llms_on_voucher_duplicate( results ) {
if ( results.length ) {
for ( var i = 0; i < results.length; i++ ) {
jQuery( 'input[value="' + results[i].code + '"]' ).css( 'background-color', 'rgba(226, 96, 73, 0.6)' );
}
alert( 'Please make sure that there are no duplicate voucher codes.' );
} else {
jQuery( "#post" ).submit();
}
}
================================================
FILE: assets/js/llms-notifications.js
================================================
;/**
* LifterLMS Basic Notifications Displayer
*
* @since 3.8.0
* @version 3.22.0
*/( function( $ ) {
var llms_notifications = function() {
var self = this,
notifications = [];
/**
* Bind dom events
*
* @return void
* @since 3.8.0
* @version 3.8.0
*/
function bind_events() {
$( 'body' ).on( 'click', '.llms-notification-dismiss', function() {
self.dismiss( $( this ).closest( '.llms-notification' ) );
} );
};
/**
* Initialize
*
* @return void
* @since 3.8.0
* @version 3.22.0
*/
this.init = function() {
var self = this;
if ( ! this.is_user_logged_in() ) {
return;
}
if ( window.llms.queued_notifications ) {
self.queue( window.llms.queued_notifications );
self.show_all();
}
bind_events();
};
/**
* Queue notifications to be displayed
*
* @param object new_notis array of notifications
* @return void
* @since 3.8.0
* @version 3.8.0
*/
this.queue = function( new_notis ) {
var self = this;
for ( var n in new_notis ) {
if ( ! new_notis.hasOwnProperty( n ) ) {
continue;
}
// add the new notification if it doesnt exist
if ( false === self.notification_exists( new_notis[ n ].id ) ) {
notifications.push( new_notis[ n ] );
}
}
};
/**
* Dismiss a notification
*
* @param obj $el notification dom element
* @return void
* @since 3.8.0
* @version 3.22.0
*/
this.dismiss = function( $el ) {
var self = this;
$el.removeClass( 'visible' );
setTimeout( function() {
self.reposition( $el.next( '.llms-notification.visible' ) );
}, 10 );
};
/**
* Determine if a notification already exists in the notifications array
*
* @param int id notification id
* @return int|false index of the notification in the array OR false if not found
* @since 3.8.0
* @version 3.8.0
*/
this.notification_exists = function( id ) {
for ( var noti in notifications ) {
if ( ! notifications.hasOwnProperty( noti ) ) {
continue;
}
if ( id === notifications[ noti ].id ) {
return noti;
}
}
return false;
};
/**
* Get the vertical offset (on screen) relative to an element
* used for notification positioning
*
* @param obj $relative_el element to get an offset relative to
* @return int
* @since 3.8.0
* @version 3.8.0
*/
this.get_offset = function( $relative_el ) {
var spacer = 12;
if ( ! $relative_el ) {
$relative_el = $( '.llms-notification.visible' ).last()
}
if ( ! $relative_el.offset() ) {
return 24;
}
var top = $relative_el.offset().top,
height = $relative_el.outerHeight();
return top + height + spacer;
};
/**
* Determine if there are notifications to show
*
* @return Boolean
* @since 3.8.0
* @version 3.8.0
*/
this.has_notifications = function() {
return ( notifications.length );
};
/**
* Determine if a user is logged in
*
* @return boolean
* @since 3.8.0
* @version 3.8.0
*/
this.is_user_logged_in = function() {
return $( 'body' ).hasClass( 'logged-in' );
};
/**
* Reposition elements, starting with the specified element
*
* @param obj $start_el element to start repositioning with
* @return void
* @since 3.8.0
* @version 3.8.0
*/
this.reposition = function( $start_el ) {
var self = this,
selector = '.llms-notification.visible',
$next_el;
if ( ! $start_el.length ) {
$start_el = $( selector ).first();
}
$start_el.css( 'top', self.get_offset( $start_el.prevAll( selector ).first() ) );
$next_el = $start_el.next( selector );
if ( $next_el.length ) {
setTimeout( function() {
self.reposition( $next_el );
}, 150 );
}
};
/**
* Show all queued notifications
*
* @return void
* @since 3.8.0
* @version 3.8.0
*/
this.show_all = function() {
var self = this,
i = 0,
interval;
interval = setInterval( function() {
if ( i < notifications.length ) {
if ( ! notifications[ i ].shown ) {
notifications[ i ].shown = true;
self.show_one( notifications[ i ] );
}
i++;
} else {
clearInterval( interval );
}
}, 100 );
}
/**
* Show a single notification
*
* @param object n notification object data
* @return void
* @since 3.8.0
* @version 3.22.0
*/
this.show_one = function( n ) {
var self = this,
$html = $( n.html );
$html.find( 'a' ).on( 'click', function( e ) {
e.preventDefault();
var $this = $( this );
window.location = $this.attr( 'href' );
} );
$( 'body' ).append( $html );
$html.css( 'top', self.get_offset() );
setTimeout( function() {
$html.addClass( 'visible' );
}, 1 );
// if it's auto dismissing, set up a dismissal
if ( $html.attr( 'data-auto-dismiss' ) ) {
setTimeout( function() {
self.dismiss( $html );
}, $html.attr( 'data-auto-dismiss' ) );
}
}
// initialize
this.init();
return this;
};
window.llms = window.llms || {};
window.llms.notifications = new llms_notifications();
} )( jQuery );
================================================
FILE: assets/js/llms-quiz-attempt-review.js
================================================
;/**
* Quiz attempt review / grading UI & UX
*
* @since 3.16.0
* @since 3.30.3 Unknown.
* @version 5.3.0
*/( function( $ ) {
/**
* Handle UX for graving quiz attempts.
*
* @since 3.16.0
* @since 3.30.3 Improve grading UX
*/
var Grading = function() {
/**
* Bind DOM events
*
* @since 3.16.0
* @since 3.16.9 Unknown.
* @return {Void}
*/
function bind() {
$( 'button[name="llms_quiz_attempt_action"][value="llms_attempt_grade"]' ).one( 'click', function( e ) {
e.preventDefault();
$( this ).addClass( 'grading' );
setup_fields();
} );
}
/**
* Create editable fields for grading / remarking
*
* @since 3.16.0
* @since 3.30.3 When starting a review only toggle first item if it's hidden and always automatically focus on the remarks field.
* @since 5.3.0 Exclude removed question items.
*
* @return {Grading}
*/
function setup_fields() {
$els = $( '.llms-quiz-attempt-question:not(.type--content):not(.type--removed)' );
if ( $els.length < 1 ) {
return;
}
var title = LLMS.l10n.translate( 'Remarks to Student' ),
points = LLMS.l10n.translate( 'points' );
$els.each( function() {
var id = $( this ).attr( 'data-question-id' ),
$existing = $( this ).find( '.llms-quiz-attempt-answer-section.llms-remarks' ),
$ui = $( '<div class="llms-quiz-attempt-answer-section llms-remarks" />' ),
$textarea = $( '<textarea class="llms-remarks-field" name="remarks[' + id + ']"></textarea>' )
gradeable = ( 'yes' === $( this ).attr( 'data-grading-manual' ) );
$ui.append( '<p class="llms-quiz-results-label remarks">' + title + ':</p>' )
$ui.append( $textarea );
if ( gradeable ) {
var pts = $( this ).attr( 'data-points-curr' ),
max = $( this ).attr( 'data-points' );
$ui.append( '<input name="points[' + id + ']" max="' + max + '" min="0" type="number" value="' + pts + '"> / ' + max + ' ' + points );
}
if ( $existing.length ) {
$textarea.text( $existing.find( '.llms-remarks' ).text() );
$existing.replaceWith( $ui );
} else {
$( this ).find( '.llms-quiz-attempt-question-main' ).append( $ui );
}
} );
var $els_first = $els.first();
if ( ! $els_first.find( '.llms-quiz-attempt-question-main' ).is( ':visible' ) ) {
// expand the first question toggle.
$els_first.find( '.toggle-answer' ).trigger( 'click' );
}
// focus on its remark textarea.
$els_first.find( '.llms-remarks-field' ).focus();
}
bind();
return this;
};
window.llms = window.llms || {};
window.llms.grading = new Grading();
} )( jQuery );
================================================
FILE: assets/js/llms-quiz.js
================================================
;/* global LLMS, $ */
/* jshint strict: true */
/**
* Front End Quiz Class.
*
* @type {Object}
*
* @since 1.0.0
* @version 7.8.0
*/( function( $ ) {
var quiz = {
/**
* Selector of all the available button elements
*
* @type {Object}
*/
$buttons: null,
/**
* Main Question Container Element.
*
* @type {Object}
*/
$container: null,
/**
* Main Quiz container UI element.
*
* @type {Object}
*/
$ui: null,
/**
* Attempt key for the current quiz.
*
* @type {[type]}
*/
attempt_key: null,
/**
* Question ID of the current question.
*
* @type {Number}
*/
current_question: 0,
/**
* Total number of questions in the current quiz.
*
* @type {Number}
*/
total_questions: 0,
/**
* Object of quiz question HTML.
*
* @type {Object}
*/
questions: {},
/**
* Validator functions for question type.
* Third party custom question types can register validators for use when answering questions.
*
* @type {Object}
*/
validators: {},
/**
* Records current status of a quiz session.
* If a user attempts to navigate away from a quiz
* while taking the quiz they'll be warned that their progress
* will not be saved if this status is not null.
*
* @type {Bool}
*/
status: null,
/**
* Records if the quiz can be resumed.
*/
resumable: null,
/**
* Flag if the user is exiting the quiz.
*/
exiting_quiz: false,
/**
* Bind DOM events.
*
* @since 1.0.0
* @since 3.16.6 Unknown.
* @since 7.8.0 Add quiz resume and hide leave warning if quiz is resumable.
*
* @return {Void}
*/
bind: function() {
var self = this;
// Start quiz.
$( '#llms_start_quiz' ).on( 'click', function( e ) {
e.preventDefault();
self.start_quiz();
} );
// Resume quiz.
$( '#llms_resume_quiz' ).on( 'click', function( e ) {
e.preventDefault();
self.resume_quiz();
} );
// Draw quiz grade circular chart.
$( '.llms-donut' ).each( function() {
LLMS.Donut( $( this ) );
} );
// Redirect to attempt on attempt selection change.
$( '#llms-quiz-attempt-select' ).on( 'change', function() {
var val = $( this ).val();
if ( val ) {
window.location.href = val;
}
} );
// Warn when quiz is running and user tries to leave the page when quiz is not resumable.
$( window ).on( 'beforeunload', function() {
if ( self.status && ! self.exiting_quiz ) {
return LLMS.l10n.translate( 'Are you sure you wish to quit this quiz attempt?' );
}
return;
} );
// Complete the quiz attempt when user leaves if the quiz is running.
$( window ).on( 'unload', function() {
if ( self.status && ! self.resumable ) {
self.complete_quiz();
}
} );
$( document ).on( 'llms-post-append-question', self.post_append_question );
// Register validators.
this.register_validator( 'content', this.validate );
this.register_validator( 'choice', this.validate_choice );
this.register_validator( 'picture_choice', this.validate_choice );
this.register_validator( 'true_false', this.validate_choice );
},
/**
* Add an error message to the UI
*
* @param string msg error message string
* @return void
* @since 3.16.0
* @version 3.16.0
*/
add_error: function( msg ) {
var self = this;
self.$container.find( '#llms-quiz-error-container' ).remove();
self.$container.append( '<div id="llms-quiz-error-container" role="alert" aria-atomic="true"></div>' );
const $error_container = self.$container.find( '#llms-quiz-error-container' );
var $err = $( '<p class="llms-error">' + msg + '<a href="#"><i class="fa fa-times-circle" aria-hidden="true"></i></a></p>' );
$err.on( 'click', 'a', function( e ) {
e.preventDefault();
$err.fadeOut( '200' );
setTimeout( function() {
$err.remove();
}, 210 );
} );
$error_container.append( $err );
},
save_question: function( options ) {
var self = this,
$question = this.$container.find( '.llms-question-wrapper' ),
type = $question.attr( 'data-type' ),
valid;
if ( ! this.validators[ type ] ) {
console.log( 'No validator registered for question type ' + type );
return;
}
valid = this.validators[ type ]( $question );
var requestData = {
action: 'quiz_answer_question',
answer: valid.answer,
attempt_key: self.attempt_key,
question_id: $question.attr( 'data-id' ),
question_type: $question.attr( 'data-type' ),
};
if ( options && options.exit_quiz ) {
requestData.via_exit_quiz = true;
}
if ( options && options.previous_question ) {
requestData.via_previous_question = true;
}
LLMS.Ajax.call( {
data: requestData,
success: function( r ) {
if (options && typeof options.callback === 'function') {
options.callback();
}
},
});
},
/**
* Answer a Question
*
* @param obj $btn jQuery object for the "Next Lesson" button
* @return void
* @since 1.0.0
* @version 3.16.6
*/
answer_question: function( $btn ) {
var self = this,
$question = this.$container.find( '.llms-question-wrapper' ),
type = $question.attr( 'data-type' ),
valid;
if ( ! this.validators[ type ] ) {
console.log( 'No validator registered for question type ' + type );
return;
}
valid = this.validators[ type ]( $question );
if ( ! valid || true !== valid.valid || ! valid.answer ) {
return self.add_error( valid.valid );
}
LLMS.Ajax.call( {
data: {
action: 'quiz_answer_question',
answer: valid.answer,
attempt_key: self.attempt_key,
question_id: $question.attr( 'data-id' ),
question_type: $question.attr( 'data-type' ),
},
beforeSend: function() {
var msg = $btn.hasClass( 'llms-button-quiz-complete' ) ? LLMS.l10n.translate( 'Grading Quiz...' ) : LLMS.l10n.translate( 'Loading Question...' );
self.toggle_loader( 'show', msg );
self.update_progress_bar( 'increment' );
},
success: function( r ) {
self.toggle_loader( 'hide' );
if ( r.data && r.data.html ) {
// load html from the cached questions if it exists already
if ( r.data.question_id && self.questions[ 'q-' + r.data.question_id ] ) {
self.load_question( self.questions[ 'q-' + r.data.question_id ] );
// load html from server if the question's never been seen before
} else {
self.load_question( r.data.html );
}
} else if ( r.data && r.data.redirect ) {
self.redirect( r.data.redirect );
} else if ( r.message ) {
self.$container.append( '<p>' + r.message + '</p>' );
} else {
var msg = LLMS.l10n.translate( 'An unknown error occurred. Please try again.' );
self.$container.append( '<p>' + msg + '</p>' );
}
},
error: function ( jqXHR, status, error ) {
self.reload_question();
self.add_error( LLMS.l10n.translate( 'An unknown error occurred. Please try again.' ) );
console.log( error );
}
} );
},
/**
* Complete the quiz
* Called when timed quizzes reach time limit
* & during unload events to record the attempt as abandoned
*
* @return void
* @since 1.0.0
* @version 3.9.0
*/
complete_quiz: function() {
var self = this;
LLMS.Ajax.call( {
data: {
action: 'quiz_end',
attempt_key: self.attempt_key,
},
beforeSend: function() {
self.toggle_loader( 'show', 'Grading Quiz...' );
},
success: function( r ) {
self.toggle_loader( 'hide' );
if ( r.data && r.data.redirect ) {
self.redirect( r.data.redirect );
} else if ( r.message ) {
self.$container.append( '<p>' + r.message + '</p>' );
} else {
var msg = LLMS.l10n.translate( 'An unknown error occurred. Please try again.' );
self.$container.append( '<p>' + msg + '</p>' );
}
}
} );
},
/**
* Retrieve the index of a question by question id
*
* @param int qid WP Post ID of the question
* @return int
* @since 3.16.0
* @version 3.16.0
*/
get_question_index: function( qid ) {
return Object.keys( this.questions ).indexOf( 'q-' + qid );
},
/**
* Redirect on quiz completion / timeout
*
* @param string url redirect url
* @return void
* @since 3.9.0
* @version 3.16.0
*/
redirect: function( url ) {
this.toggle_loader( 'show', 'Grading Quiz...' );
this.status = null;
window.location.href = url;
},
reload_question: function() {
var self = this;
self.toggle_loader( 'show', LLMS.l10n.translate( 'Loading Question...' ) );
self.update_progress_bar( 'reload' );
setTimeout( function() {
self.toggle_loader( 'hide' );
self.load_question( self.questions[ 'q-' + self.current_question ] );
}, 100 );
},
/**
* Return to the previous question.
*
* @since 1.0.0
* @since 3.16.6 Unknown.
* @since 7.8.0 Retrieve question HTML from the server when not cached.
*
* @return {Void}
*/
previous_question: function() {
var self = this;
this.save_question( {
previous_question: true,
callback: function() {
self.toggle_loader( 'show', LLMS.l10n.translate( 'Loading Question...' ) );
self.update_progress_bar( 'decrement' );
var ids = Object.keys( self.questions ),
curr = ids.indexOf( 'q-' + self.current_question ),
prev_id = ids[0];
if ( curr >= 1 ) {
prev_id = ids[ curr - 1 ];
}
// Retrieve previous question HTML from the server.
if ( ! self.questions[ prev_id ] ) {
LLMS.Ajax.call( {
data: {
action : 'quiz_get_question',
attempt_key: self.attempt_key,
question_id: prev_id.substring(2), // Remove 'q-'.
},
success: function( r ) {
self.toggle_loader( 'hide' );
if ( r.data && r.data.html ) {
self.load_question( r.data.html );
} else if ( r.data && r.data.redirect ) {
self.redirect( r.data.redirect );
} else if ( r.message ) {
self.$container.append( '<p>' + r.message + '</p>' );
} else {
var msg = LLMS.l10n.translate( 'An unknown error occurred. Please try again.' );
self.$container.append( '<p>' + msg + '</p>' );
}
}
} );
} else {
setTimeout( function() {
self.toggle_loader( 'hide' );
self.load_question( self.questions[ prev_id ] );
}, 100 );
}
}
});
},
/**
* Register question type validator functions
*
* @param string type question type id
* @param function func callback function to validate the question with
* @return void
* @since 3.16.0
* @version 3.16.0
*/
register_validator: function( type, func ) {
this.validators[ type ] = func;
},
/**
* Start a Quiz.
*
* @since 1.0.0
* @since 3.24.3 Unknown.
* @since 7.8.0 Abstracted the function in `init_quiz`.
*
* @return {Void}
*/
start_quiz: function () {
this.init_quiz( 'quiz_start' );
},
/**
* Resume a Quiz.
*
* @since 7.8.0
*
* @return {Void}
*/
resume_quiz: function () {
this.init_quiz( 'quiz_resume' );
},
/**
* Initiate 'Start' or 'Resume' action on a Quiz via AJAX call.
*
* @since 7.8.0
*
* @return {Void}
*/
init_quiz: function ( action ) {
var self = this;
if( 'quiz_resume' === action ) {
// Disable resume button.
$( '#llms_resume_quiz' ).attr( 'disabled', 'disabled' );
}
this.load_ui_elements();
this.$ui = $( '#llms-quiz-ui' );
this.$buttons = $( '#llms-quiz-nav button' );
this.$container = $( '#llms-quiz-question-wrapper' );
// Bind submission event for answering questions.
$( '#llms-next-question, #llms-complete-quiz' ).on( 'click', function( e ) {
e.preventDefault();
self.answer_question( $( this ) );
} );
// Bind submission event for navigating backwards.
$( '#llms-prev-question' ).on( 'click', function( e ) {
e.preventDefault();
self.previous_question();
} );
// Bind exit event for quiz.
$( '#llms-quiz-nav' ).on( 'click', '#llms-exit-quiz', function( e ) {
e.preventDefault();
self.save_question( {
exit_quiz: true,
callback: function() {
self.exiting_quiz = true;
window.location.reload();
}
});
} );
if ( 'quiz_resume' === action ) {
data = {
action: 'quiz_resume',
attempt_key: $( '#llms-attempt-key' ).val(),
};
} else {
data = {
action: 'quiz_start',
attempt_key: $( '#llms-attempt-key' ).val(),
lesson_id : $( '#llms-lesson-id' ).val(),
quiz_id : $( '#llms-quiz-id' ).val(),
};
}
LLMS.Ajax.call( {
data: data,
beforeSend: function() {
self.status = true;
$( '#llms-quiz-wrapper, #quiz-start-button, #quiz-resume-button' ).remove();
$( 'html, body' ).stop().animate( {scrollTop: 0 }, 500 );
self.toggle_loader( 'show', LLMS.l10n.translate( 'Loading Quiz...' ) );
},
error: function( r, s, t ) {
console.log( r, s, t );
},
success: function( r ) {
self.toggle_loader( 'hide' );
if ( r.data && r.data.html ) {
self.attempt_key = r.data.attempt_key;
self.total_questions = r.data.total;
self.resumable = r.data.can_be_resumed;
if( 'quiz_resume' === action ) {
r.data.question_ids.forEach( id => self.questions[`q-${id}`] = '' );
} else if ( r.data.time_limit ) {
self.start_quiz_timer( r.data.time_limit );
}
// Adding Exit Button in Layout if quiz is resumable.
if ( self.resumable ) {
$( '#llms-quiz-nav' ).append( '<button class="button llms-button-secondary" id="llms-exit-quiz" name="llms_exit_quiz">' + LLMS.l10n.translate( 'Save & Exit Quiz' ) + '</button>' );
}
self.load_question( r.data.html );
if ( 'quiz_resume' === action ) {
self.update_progress_bar( 'reload' );
}
} else if ( r.message ) {
self.$container.append( '<p>' + r.message + '</p>' );
} else {
var msg = LLMS.l10n.translate( 'An unknown error occurred. Please try again.' );
self.$container.append( '<p>' + msg + '</p>' );
}
}
} );
/**
* Use JS mouse events instead of CSS :hover because iOS is really smart
*
* @see: https://css-tricks.com/annoying-mobile-double-tap-link-issue/
*/
if ( ! LLMS.is_touch_device() ) {
this.$ui.on( 'mouseenter', 'li.llms-choice label', function() {
$( this ).addClass( 'hovered' );
} );
this.$ui.on( 'mouseleave', 'li.llms-choice label', function() {
$( this ).removeClass( 'hovered' );
} );
}
},
/**
* Start Quiz Timer
* Gets minutes from hidden field
* Not used as actual quiz timer. Quiz is timed on the server from the quiz class
* Calculates minutes to milliseconds and then converts to hours / minutes
* When time limit reaches 0 calls complete_quiz() to complete quiz.
*
* @return Calls get_count_down at a set interval of 1 second
* @since 1.0.0
* @version 3.16.0
*/
start_quiz_timer: function( total_minutes ) {
// create and append the UI for the countdown clock
var $el = $( '<div class="llms-quiz-timer" id="llms-quiz-timer" />' ),
msg = LLMS.l10n.translate( 'Time Remaining' );
$el.append( '<i class="fa fa-clock-o" aria-hidden="true"></i><span class="screen-reader-text">' + msg + '</span>' );
const quiz_header = $( '#llms-quiz-header' );
$el.append( '<time aria-describedby="llms-timer-hint" id="llms-quiz-time-remaining" class="llms-tiles" datetime=""></time>' );
quiz_header.append( $el );
quiz_header.append( '<div id="llms-timer-live" class="sr-only" aria-live="polite" aria-atomic="true"></div>' );
quiz_header.append( '<p id="llms-timer-hint" class="sr-only">Announcements every minute; every 10 seconds in the last minute.</p>' );
// start the timer
var self = this,
target_date = new Date().getTime() + ( ( total_minutes * 60 ) * 1000 ), // set the countdown date
time_limit = ( ( total_minutes * 60 ) * 1000 ),
countdown = document.getElementById( 'llms-quiz-time-remaining' ), // get tag element
days, hours, minutes, seconds; // variables for time units
// set actual timer
setTimeout( function() {
self.complete_quiz();
}, time_limit + 1000 );
this.getCountdown(
total_minutes,
target_date,
time_limit,
days,
hours,
minutes,
seconds,
countdown
);
// call get_count_down every 1 second
setInterval( function () {
self.getCountdown(
total_minutes,
target_date,
time_limit,
days,
hours,
minutes,
seconds,
countdown
);
}, 1000 );
},
/**
* Trigger events
*
* @param string event event to trigger
* @return void
* @since 3.16.0
* @version 3.16.0
*/
trigger: function( event ) {
var self = this;
// trigger question submission for the current question
if ( 'answer_question' === event ) {
if ( this.get_question_index( self.current_question ) === self.total_questions ) {
$( '#llms-complete-quiz' ).trigger( 'click' );
} else {
$( '#llms-next-question' ).trigger( 'click' );
}
}
},
/**
* Load the HTML of a question into the DOM and the question cache
*
* @param string html string of html
* @return void
* @since 3.9.0
* @version 3.16.6
*/
load_question: function( html ) {
var $html = $( html ),
qid = $html.attr( 'data-id' );
// cache the question HTML for faster rewinds
if ( ! this.questions[ 'q-' + qid ] ) {
this.questions[ 'q-' + qid ] = $html;
}
this.update_progress( qid );
this.current_question = qid;
$( document ).trigger( 'llms-pre-append-question', $html );
this.$container.append( $html );
$( document ).trigger( 'llms-post-append-question', $html );
var $quizUi = $( '#llms-quiz-ui' );
if ( $quizUi.length ) {
$( 'html, body' ).animate( {
scrollTop: $quizUi.offset().top - 50
}, 300 );
}
},
/**
* Constructs the quiz UI & adds the elements into the DOM
*
* @return void
* @since 3.16.0
* @version 3.16.9
*/
load_ui_elements: function() {
// Removing the quiz UI elements if they already exist.
if ( $( '#llms-quiz-ui').length > 0 ) {
$( '#llms-quiz-ui' ).remove();
}
var $html = $( '<div class="llms-quiz-ui" id="llms-quiz-ui" />' ),
$header = $( '<header class="llms-quiz-header" id="llms-quiz-header" />' )
$footer = $( '<footer class="llms-quiz-nav" id="llms-quiz-nav" />' );
$footer.append( '<button class="button large llms-button-action" id="llms-next-question" name="llms_next_question" type="submit">' + LLMS.l10n.translate( 'Next Question' ) + '</button>' );
$footer.append( '<button class="button large llms-button-action llms-button-quiz-complete" id="llms-complete-quiz" name="llms_complete_quiz" type="submit" style="display:none;">' + LLMS.l10n.translate( 'Complete Quiz' ) + '</button>' );
$footer.append( '<button class="button llms-button-secondary" id="llms-prev-question" name="llms_prev_question" type="submit" style="display:none;">' + LLMS.l10n.translate( 'Previous Question' ) + '</button>' );
$header.append( '<div class="llms-progress"><div class="progress-bar-complete"></div></div>' );
$footer.append( '<div class="llms-quiz-counter" id="llms-quiz-counter"><span class="llms-current"></span><span class="llms-sep">/</span><span class="llms-total"></span></div>' )
$html.append( $header )
.append( '<div class="llms-quiz-question-wrapper" id="llms-quiz-question-wrapper" />' )
.append( $footer );
$( '#llms-quiz-wrapper' ).after( $html );
},
/**
* Perform actions on question HTML after it's been appended to the DOM
*
* @param obj event js event object
* @param obj html js HTML object
* @return void
* @since 3.16.6
* @version 3.16.6
*/
post_append_question: function( event, html ) {
var $html = $( html );
if ( $html.find( 'audio' ).length ) {
wp.mediaelement.initialize();
}
},
/**
* Show or hide the "loading" spinner with an option message
*
* @param string display show|hide
* @param string msg text to display when showing
* @return void
* @since 3.9.0
* @version 3.16.6
*/
toggle_loader: function( display, msg ) {
if ( 'show' === display ) {
msg = msg || LLMS.l10n.translate( 'Loading...' );
this.$buttons.attr( 'disabled', 'disabled' );
this.$container.empty();
LLMS.Spinner.start( this.$container );
this.$container.append( '<div class="llms-quiz-loading">' + LLMS.l10n.translate( msg ) + '</div>' );
} else {
LLMS.Spinner.stop( this.$container );
this.$buttons.removeAttr( 'disabled' );
this.$container.find( '.llms-quiz-loading' ).remove();
}
},
/**
* Update the progress bar and toggle button availability based on question the question being shown.
*
* @since 3.16.0
* @since 7.8.0 Show counter and set the total as when needed.
*
* @param {Int} qid Question ID.
* @return {Void}
*/
update_progress: function( qid ) {
var index = this.get_question_index( qid );
if ( -1 === index ) {
return;
}
index++;
$( '#llms-quiz-counter .llms-current' ).text( index );
if ( index > 0 && ! $( '#llms-quiz-counter .llms-total' ).text() ) {
$( '#llms-quiz-counter .llms-total' ).text( this.total_questions );
$( '#llms-quiz-counter' ).show();
}
// Handle prev question.
if ( index >= 2 ) {
$( '#llms-prev-question' ).show();
} else {
$( '#llms-prev-question' ).hide();
}
if ( index === this.total_questions ) {
$( '#llms-next-question' ).hide();
$( '#llms-complete-quiz' ).show();
} else {
$( '#llms-next-question' ).show();
$( '#llms-complete-quiz' ).hide();
}
},
/**
* Increase progress bar ui element
*
* @param string dir update direction [increment|decrement|reload]
* @return void
* @since 3.16.0
* @version 3.16.0
*/
update_progress_bar: function( dir ) {
var index = this.get_question_index( this.current_question );
switch ( dir ) {
case 'increment':
index++;
break;
case 'decrement':
index--;
break;
case 'reload':
break;
}
progress = ( index / this.total_questions ) * 100;
this.$ui.find( '.progress-bar-complete' ).css( 'width', progress + '%' );
},
/**
* Get Count Down
* Called every second to update the on screen countdown timer
* Changes color to yellow at 1/2 of total time
* Changes color to red at 1/4 of total time
*
* @param {[int]} minutes [description]
* @param {[date]} target_date [description]
* @param {[int]} time_limit [description]
* @param {[int]} days [description]
* @param {[int]} hours [description]
* @param {[int]} minutes [description]
* @param {[int]} seconds [description]
* @param {[int]} countdown [description]
* @return Displays updates hours, minutes on quiz timer
* @since 1.0.0
* @version 1.0.0
*/
getCountdown: function( total_minutes, target_date, time_limit, days, hours, minutes, seconds, countdown ){
// find the amount of "seconds" between now and target
var current_date = new Date().getTime(),
seconds_left = parseInt( ( target_date - current_date ) / 1000 );
const live = document.getElementById( 'llms-timer-live' );
if ( seconds_left >= 0 ) {
if ( ( seconds_left * 1000 ) < ( time_limit / 2 ) ) {
$( '#llms-quiz-timer' ).addClass( 'color-half' );
}
if ( ( seconds_left * 1000 ) < ( time_limit / 4 ) ) {
$( '#llms-quiz-timer' ).removeClass( 'color-half' );
$( '#llms-quiz-timer' ).addClass( 'color-empty' );
}
const shouldAnnounce = (s) => {
if ( s === parseInt( time_limit / 1000 ) ) return true; // first render
if ( s <= 10 ) return true; // last 10 seconds: every second
if ( s <= 60 ) return s % 10 === 0; // last minute: every 10s
return s % 60 === 0; // otherwise: each minute mark
};
const speak = ( hours, mins, secs ) => {
if ( hours > 0 ) {
// Translators: %1$s hours, %2$s minutes, and %3$s seconds remaining.
live.textContent = hours > 1 ? LLMS.l10n.replace( '%1$s hours, %2$s minutes remaining', {
'%1$s': hours,
'%2$s': mins,
} ) :
// Translators: 1 hour, %2$s minutes.
LLMS.l10n.replace( '1 hour, %2$s minutes remaining', {
'%2$s': mins,
} );
} else if ( mins > 0 && secs === 0 ) {
// Translators: %1$s minutes remaining.
live.textContent = mins > 1 ? LLMS.l10n.replace( '%1$s minutes remaining', {
'%1$s': mins,
} ) :
// Translators: 1 minute remaining.
LLMS.l10n.replace( '%1$s minute remaining', {
minutes: mins,
} );
} else if ( mins === 0 ) {
live.textContent = LLMS.l10n.replace( '%1$s seconds remaining', {
'%1$s': secs,
} );
}
};
days = parseInt( seconds_left / 86400 );
let remainder = seconds_left % 86400;
hours = parseInt( remainder / 3600 );
remainder = seconds_left % 3600;
minutes = parseInt( remainder / 60 );
seconds = parseInt( remainder % 60 );
countdown.innerHTML = this.pad( hours ) + ':' + this.pad( minutes ) + ':' + this.pad( seconds );
$( countdown ).attr( 'datetime', 'PT' + ( hours > 0 ? hours + 'H' : '' ) + ( minutes > 0 ? minutes + 'M' : '' ) + ( seconds > 0 ? seconds + 'S' : '' ) );
if ( shouldAnnounce( seconds_left ) ) {
speak( hours, minutes, seconds );
}
}
},
/**
* Pad Number
* pads number with 0 if single digit.
*
* @param {[int]} n [number]
* @return {[string]} [padded number]
* @since 1.0.0
* @version 1.0.0
*/
pad: function(n) {
return (n < 10 ? '0' : '') + n;
},
/**
* Basic validation method which performs no validation and returns a validation object
* in the format required by the application
*
* @param obj $question jQuery selector of the question
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
validate: function( $question ) {
return {
answer: [],
valid: true,
};
},
/**
* Validates a choice question to ensure there's at least one checked input
*
* @param obj $question jQuery selector of the question
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
validate_choice: function( $question ) {
var ret = window.llms.quizzes.validate( $question ),
checked = $question.find( 'input:checked' );
if ( ! checked.length ) {
ret.valid = LLMS.l10n.translate( 'You must select an answer to continue.' );
} else {
checked.each( function() {
ret.answer.push( $( this ).val() );
} );
}
return ret;
},
};
quiz.bind();
window.llms = window.llms || {};
window.llms.quizzes = quiz;
} )( jQuery );
================================================
FILE: assets/js/llms-view-manager.js
================================================
/**
* JS events for the view manager
*
* @package LifterLMS/Scripts
*
* @since 3.8.0
* @since 4.2.0 Added access plans action button selector to the list of links to update.
*
* @version 4.2.0
*/
( function( $, undefined ) {
window.llms = window.llms || {};
var ViewManager = function() {
var currentView = 'self',
currentNonce;
/**
* Set the current Nonce
*
* @param string nonce a nonce
* @since 3.8.0
* @version 3.8.0
*/
this.set_nonce = function( nonce ) {
currentNonce = nonce;
return this;
}
/**
* Set the current view
*
* @param string view a view option
* @since 3.8.0
* @version 3.8.0
*/
this.set_view = function( view ) {
currentView = view;
return this;
}
/**
* Update various links on the page for easy navigation when using views.
*
* @since 3.8.0
* @since 4.2.0 Added access plans action button selector to the list of links to update.
*
* @return void
*/
this.update_links = function() {
if ( 'self' === currentView || ! currentNonce ) {
return;
}
var $links = $( '.llms-widget-syllabus .llms-lesson a, .llms-course-progress a, .llms-lesson-preview a.llms-lesson-link, .llms-parent-course-link a.llms-lesson-link, .llms-access-plans a.llms-button-action' );
$links.each( function() {
var $link = $( this ),
href = $link.attr( 'href' ),
split = href.split( '?' ),
qs = {};
if ( split.length > 1 ) {
$.each( split[1].split( '&' ), function( i, pair ) {
pair = pair.split( '=' );
qs[ pair[0] ] = pair[1];
} );
}
qs['llms-view-as'] = currentView;
qs.view_nonce = currentNonce;
$link.attr( 'href', split[0] + '?' + $.param( qs ) );
} );
}
};
// initialize the object
window.llms.ViewManager = new ViewManager();
} )( jQuery );
================================================
FILE: assets/js/llms-widget-syllabus.js
================================================
( function( $ ) {
window.llms = window.llms || {};
/**
* Manage
*
* @return obj instance of the class
* @since 2.6.0
*/
window.llms.widget_syllabus = function() {
/**
* Init
*
* @return void
* @since 2.6.0
*/
this.init = function() {
this.bind();
};
/**
* Bind DOM events
*
* @return void
* @since 2.6.0
*/
this.bind = function() {
var self = this;
// bind all existing toggles on load
self.bind_toggles( $( '#widgets-right .llms-course-outline-collapse' ) );
$( document ).on( 'ajaxStop', function( r ) {
// self.toggle( $( this ) );
$( '#widgets-right .llms-course-outline-collapse:not([data-is-bound="true"])' ).each( function() {
self.bind_toggles( $( this ) );
} );
} );
};
/**
* Bind change events to a specific toggle or set of toggles
*
* @param obj $toggles jQuery selector of toggle input ('input.llms-course-outline-collapse')
* @return void
* @since 2.6.0
*/
this.bind_toggles = function( $toggles ) {
var self = this;
$toggles.attr( 'data-is-bound', 'true' );
// bind input change on load
$toggles.on( 'change', function() {
self.toggle( $( this ) );
} );
};
/**
* Toggle the visibility of the secondary option to display toggles
*
* @param obj $input jQuery selector of a single collapse toggle element ('input.llms-course-outline-collapse')
* @return void
* @since 2.6.0
*/
this.toggle = function( $input ) {
$input.closest( '.widget' ).find( '.llms-course-outline-toggle-wrapper' ).toggle();
};
// GO
this.init();
// whatever
return this;
};
var a = new window.llms.widget_syllabus();
} )( jQuery );
================================================
FILE: assets/js/partials/_metabox-field-repeater.js
================================================
/**
* LifterLMS Admin Metabox Repeater Field
*
* @package LifterLMS/Scripts/Partials
*
* @since 3.11.0
* @version 5.3.2
*/
this.repeaters = {
/**
* Reference to the parent metabox class
*
* @type {Object}
*/
metaboxes: this,
/**
* A jQuery selector for all repeater elements on the current screen
*
* @type {Object}
*/
$repeaters: null,
/**
* Init
*
* @since 3.11.0
* @since 3.23.0 Unknown.
*
* @return {void}
*/
init: function() {
var self = this;
self.$repeaters = $( '.llms-mb-list.repeater' );
if ( self.$repeaters.length ) {
// Wait for tinyMCE just in case their editors in the repeaters.
LLMS.wait_for(
function() {
return ( 'undefined' !== typeof tinyMCE );
},
function() {
self.load();
self.bind();
}
);
/**
* On click of any post submit buttons add some data to the submit button
* so we can see which button to trigger after repeaters are finished.
*/
$( '#post input[type="submit"], #post-preview' ).on( 'click', function() {
$( this ).attr( 'data-llms-clicked', 'yes' );
} );
// Handle post submission.
$( '#post' ).on( 'submit', self.handle_submit );
}
},
/**
* Bind DOM Events
*
* @since 3.11.0
* @since 3.13.0 Unknown.
* @since 5.3.2 Don't remove the model's mceEditor instance (it's removed before cloning a row now).
*
* @return {void}
*/
bind: function() {
var self = this;
self.$repeaters.each( function() {
var $repeater = $( this ),
$rows = $repeater.find( '.llms-repeater-rows' );
// For the repeater + button.
$repeater.find( '.llms-repeater-new-btn' ).on( 'click', function() {
self.add_row( $repeater, null, true );
} );
// Make repeater rows sortable.
$rows.sortable( {
handle: '.llms-drag-handle',
items: '.llms-repeater-row',
start: function( event, ui ) {
$rows.addClass( 'dragging' );
},
stop: function( event, ui ) {
$rows.removeClass( 'dragging' );
var $eds = ui.item.find( 'textarea.wp-editor-area' );
$eds.each( function() {
var ed_id = $( this ).attr( 'id' );
tinyMCE.EditorManager.execCommand( 'mceRemoveEditor', true, ed_id );
tinyMCE.EditorManager.execCommand( 'mceAddEditor', true, ed_id );
} );
self.save( $repeater );
},
} );
$repeater.on( 'click', '.llms-repeater-remove', function( e ) {
e.stopPropagation();
var $row = $( this ).closest( '.llms-repeater-row' );
if ( window.confirm( LLMS.l10n.translate( 'Are you sure you want to delete this row? This cannot be undone.' ) ) ) {
$row.remove();
setTimeout( function() {
self.save( $repeater );
}, 1 );
}
} );
} );
},
/**
* Add a new row to a repeater rows group
*
* @since 3.11.0
* @since 5.3.2 Use `self.clone_row()` to retrieve the model's base HTML for the row to be added.
*
* @param {Object} $repeater A jQuery selector for the repeater to add a row to.
* @param {Object} data Optional object of data to fill fields in the row with.
* @param {Boolean} expand If true, will automatically open the row after adding it to the dom.
* @return {void}
*/
add_row: function( $repeater, data, expand ) {
var self = this,
$rows = $repeater.find( '.llms-repeater-rows' ),
$model = $repeater.find( '.llms-repeater-model' ),
$row = self.clone_row( $model.find( '.llms-repeater-row' ) ),
new_index = $repeater.find( '.llms-repeater-row' ).length,
editor = self.reindex( $row, new_index );
if ( data ) {
$.each( data, function( key, val ) {
var $field = $row.find( '[name^="' + key + '"]' );
if ( $field.hasClass( 'llms-select2-student' ) ) {
$.each( val, function( i, data ) {
$field.append( '<option value="' + data.key + '" selected="selected">' + data.title + '</option>' )
} );
$field.trigger( 'change' );
} else {
$field.val( val );
}
} );
}
setTimeout( function() {
self.bind_row( $row );
}, 1 );
$rows.append( $row );
if ( expand ) {
$row.find( '.llms-collapsible-header' ).trigger( 'click' );
}
tinyMCE.EditorManager.execCommand( 'mceAddEditor', true, editor );
$repeater.trigger( 'llms-new-repeater-row', {
$row: $row,
data: data,
} );
},
/**
* Bind DOM events for a single repeater row
*
* @since 3.11.0
* @since 3.13.0 Unknown.
*
* @param {Object} $row A jQuery selector for the row.
* @return {void}
*/
bind_row: function( $row ) {
this.bind_row_header( $row );
$row.find( '.llms-select2' ).llmsSelect2( {
width: '100%',
} );
$row.find( '.llms-select2-student' ).llmsStudentsSelect2();
this.metaboxes.bind_datepickers( $row.find( '.llms-datepicker' ) );
this.metaboxes.bind_controllers( $row.find( '[data-is-controller]' ) );
// This.metaboxes.bind_merge_code_buttons( $row.find( '.llms-merge-code-wrapper' ) );.
},
/**
* Bind row header events
*
* @since 3.11.0
*
* @param {Object} $row jQuery selector for the row.
* @return {void}
*/
bind_row_header: function( $row ) {
// Handle the title field binding.
var $title = $row.find( '.llms-repeater-title' ),
$field = $row.find( '.llms-collapsible-header-title-field' );
$title.attr( 'data-default', $title.text() );
$field.on( 'keyup focusout blur', function() {
var val = $( this ).val();
if ( ! val ) {
val = $title.attr( 'data-default' );
}
$title.text( val );
} ).trigger( 'keyup' );
},
/**
* Create a copy of the model's row after removing any tinyMCE editor instances present in the model.
*
* @since 5.3.2
*
* @param {Object} $row A jQuery object of the row to be cloned.
* @return {Object} A clone of the jQuery object.
*/
clone_row: function( $row ) {
$ed = $row.find( '.editor textarea' );
if ( $ed.length ) {
tinyMCE.EditorManager.execCommand( 'mceRemoveEditor', true, $ed.attr( 'id' ) );
}
return $row.clone()
},
/**
* Handle WP Post form submission to ensure repeaters are saved before submitting the form to save/publish the post
*
* @since 3.11.0
* @since 3.23.0 Unknown.
*
* @param {Object} e An event object.
* @return {void}
*/
handle_submit: function( e ) {
// Get the button used to submit the form.
var $btn = $( '#post [data-llms-clicked="yes"]' ),
$spinner = $btn.parent().find( '.spinner' );
if ( $btn.is( '#post-preview' ) ) {
$btn.removeAttr( 'data-llms-clicked' );
return;
}
e.preventDefault();
// Core UX to prevent multi-click/or the appearance of a delay.
$( '#post input[type="submit"]' ).addClass( 'disabled' ).attr( 'disabled', 'disabled' );
$spinner.addClass( 'is-active' );
var self = window.llms.metaboxes.repeaters,
i = 0,
wait;
self.$repeaters.each( function() {
self.save( $( this ) );
} );
wait = setInterval( function() {
if ( i >= 59 || ! $( '.llms-mb-list.repeater.processing' ).length ) {
clearInterval( wait );
$( '#post' ).off( 'submit', this.handle_submit );
$spinner.removeClass( 'is-active' );
$btn.removeClass( 'disabled' ).removeAttr( 'disabled' ).trigger( 'click' );
} else {
i++;
}
}, 1000 );
},
/**
* Load repeater data from the server and create rows in the DOM
*
* @since 3.11.0
* @since 3.12.1 Unknown.
*
* @return {void}
*/
load: function() {
var self = this;
self.$repeaters.each( function() {
var $repeater = $( this );
// Ensure the repeater is only loaded once to prevent duplicates resulting from duplicating binding.
// On certain sites which I cannot quite explain...
if ( $repeater.hasClass( 'is-loaded' ) || $repeater.hasClass( 'processing' ) ) {
return;
}
self.store( $repeater, 'load', function( data ) {
$repeater.addClass( 'is-loaded' );
$.each( data.data, function( i, obj ) {
self.add_row( $repeater, obj, false );
} );
// For each row within the repeater.
$repeater.find( '.llms-repeater-rows .llms-repeater-row' ).each( function() {
self.bind_row( $( this ) );
} );
} );
} );
},
/**
* Reindex a row
*
* Renames ids, attrs, and etc...
*
* Used when cloning the model for new rows.
*
* @since 3.11.0
*
* @param {Object} $row jQuery selector for the row.
* @param {string} index The index (or id) to use when renaming.
* @return {string}
*/
reindex: function( $row, index ) {
var old_index = $row.attr( 'data-row-order' ),
$ed = $row.find( '.llms-mb-list.editor textarea' );
tinyMCE.EditorManager.execCommand( 'mceRemoveEditor', true, $ed.attr( 'id' ) );
function replace_attr( $el, attr ) {
$el.each( function() {
var str = $( this ).attr( attr );
$( this ).attr( attr, str.replace( old_index, index ) );
} );
};
$row.attr( 'data-row-order', index );
replace_attr( $row, 'data-row-order' );
replace_attr( $row.find( 'button.insert-media' ), 'data-editor' );
replace_attr( $row.find( 'input[name^="_llms"], textarea[name^="_llms"], select[name^="_llms"]' ), 'id' );
replace_attr( $row.find( 'input[name^="_llms"], textarea[name^="_llms"], select[name^="_llms"]' ), 'name' );
replace_attr( $row.find( '[data-controller]' ), 'data-controller' );
replace_attr( $row.find( '[data-controller]' ), 'data-controller' );
replace_attr( $row.find( 'button.wp-switch-editor' ), 'data-wp-editor-id' );
replace_attr( $row.find( 'button.wp-switch-editor' ), 'id' );
replace_attr( $row.find( '.wp-editor-tools' ), 'id' );
replace_attr( $row.find( '.wp-editor-container' ), 'id' );
return $ed.attr( 'id' );
},
/**
* Save a single repeaters data to the server
*
* @since 3.11.0
* @since 3.13.0 Unknown.
*
* @param {Object} $repeater jQuery selector for a repeater element.
* @return {void}
*/
save: function( $repeater ) {
$repeater.trigger( 'llms-repeater-before-save', { $el: $repeater } );
this.store( $repeater, 'save' );
},
/**
* Convert a repeater element into an array of objects that can be saved to the database
*
* @since 3.11.0
*
* @param {Object} $repeater A jQuery selector for a repeater element.
* @return {void}
*/
serialize: function( $repeater ) {
var rows = [];
$repeater.find( '.llms-repeater-rows .llms-repeater-row' ).each( function() {
var obj = {};
// Easy...
$( this ).find( 'input[name^="_llms"], select[name^="_llms"]' ).each( function() {
obj[ $( this ).attr( 'name' ) ] = $( this ).val();
} );
// Check if the textarea is a tinyMCE instance.
$( this ).find( 'textarea[name^="_llms"]' ).each( function() {
var name = $( this ).attr( 'name' );
// If it is an editor.
if ( tinyMCE.editors[ name ] ) {
obj[ name ] = tinyMCE.editors[ name ].getContent();
// Grab the val of the textarea.
} else {
obj[ name ] = $( this ).val();
}
} );
rows.push( obj );
} );
return rows;
},
/**
* AJAX method for interacting with the repeater's handler on the server
*
* @since 3.11.0
*
* @param {Object} $repeater jQuery selector for the repeater element.
* @param {string} action Action to call [save|load].
* @param {Function} cb Callback function.
* @return {void}
*/
store: function( $repeater, action, cb ) {
cb = cb || function(){};
var self = this,
data = {
action: $repeater.find( '.llms-repeater-field-handler' ).val(),
store_action: action,
};
if ( 'save' === action ) {
data.rows = self.serialize( $repeater );
}
LLMS.Ajax.call( {
data: data,
beforeSend: function() {
$repeater.addClass( 'processing' );
LLMS.Spinner.start( $repeater );
},
success: function( r ) {
cb( r );
LLMS.Spinner.stop( $repeater );
$repeater.removeClass( 'processing' );
}
} );
}
};
this.repeaters.init();
================================================
FILE: assets/js/private/llms-metaboxes.js
================================================
/**
* LifterLMS Admin Panel Metabox Functions
*
* @since 3.0.0
* @version 7.1.1
*/
( function( $ ) {
$( document ).ready( function() {
// Avoid confusion by hiding the visibility option for coupons and vouchers if currently set to public.
if ( $( 'input[name="visibility"]:checked' ).val() === 'public' ) {
$( 'body.post-type-llms_coupon #visibility, body.post-type-llms_voucher #visibility' ).hide();
}
} );
const collapseHeaderClicked = function() {
var $parent = $(this).closest('.llms-collapsible'),
$siblings = $parent.siblings('.llms-collapsible');
$parent.toggleClass('opened').trigger('llms-collapsible-toggled');
$parent.find('.llms-collapsible-body').slideToggle(400);
$siblings.each(function () {
$(this).removeClass('opened');
$(this).find('.llms-collapsible-body').slideUp(400);
});
}
/**
* jQuery plugin to allow "collapsible" sections
*
* @return jQuery object
* @since 3.0.0
* @version 3.29.0
*/
$.fn.llmsCollapsible = function() {
var $group = this;
this.off( 'click', '.llms-collapsible-header', collapseHeaderClicked )
.on( 'click', '.llms-collapsible-header', collapseHeaderClicked );
return this;
};
window.llms = window.llms || {};
var Metaboxes = function() {
/**
* load all partials
*/
// = include ../partials/*.js
/**
* Initialize
*
* @since 3.0.0
* @since 3.13.0 Unknown.
* @since 4.19.0 Add `this.bind_mce_fixes()`.
* @since 5.3.0 Bind editables when editable buttons are present in addition to anchors.
*
* @return void
*/
this.init = function() {
var self = this;
$( '.llms-select2-post' ).each( function() {
self.post_select( $( this ) );
} );
$( '.llms-collapsible-group' ).llmsCollapsible();
this.bind_tabs();
this.bind_mce_fixes();
// bind everything better and less repetitively...
var bindings = [
{
selector: $( '.llms-datepicker' ),
func: 'bind_datepickers',
},
{
selector: $( '.llms-select2' ),
func: function( $selector ) {
$selector.llmsSelect2( {
width: '100%',
} );
},
},
{
selector: $( '.llms-select2-student' ),
func: function( $selector ) {
$selector.llmsStudentsSelect2();
}
},
{
selector: $( 'input[type="checkbox"][data-controls]' ),
func: 'bind_cb_controllers',
},
{
selector: $( '[data-is-controller]' ),
func: 'bind_controllers',
},
{
selector: $( '.llms-table' ),
func: 'bind_tables',
},
{
selector: $( '.llms-merge-code-wrapper' ),
func: 'bind_merge_code_buttons',
},
{
selector: $( 'a.llms-editable, button.llms-editable' ),
func: 'bind_editables',
},
];
// bind all the bindables but don't bind things in repeaters
$.each( bindings, function( index, obj ) {
if ( obj.selector.length ) {
// reduce the selector to exclude items in a repeater
var reduced = obj.selector.filter( function() {
return ( 0 === $( this ).closest( '.llms-repeater-model' ).length );
} );
// bind by string
if ( 'string' === typeof obj.func ) {
self[ obj.func ]( reduced );
}
// bind by an anonymous function
else if ( 'function' === typeof obj.func ) {
obj.func( reduced );
}
}
} );
// if a post type is set & a bind exists for it, bind it
if ( window.llms.post.post_type ) {
var func = 'bind_' + window.llms.post.post_type;
if ( 'function' === typeof this[func] ) {
this[func]();
}
}
};
/**
* Bind checkboxes that control the display of other elements
*
* @param obj $controllers jQuery selector for checkboxes to be bound as checkbox controllers
* @return void
* @since 3.0.0
* @version 3.11.0
*/
this.bind_cb_controllers = function( $controllers ) {
$controllers = $controllers || $( 'input[type="checkbox"][data-controls]' );
$controllers.each( function() {
var $cb = $( this ),
$controlled = $( $cb.attr( 'data-controls' ) ).closest( '.llms-mb-list' );
$cb.on( 'change', function() {
if ( $( this ).is( ':checked' ) ) {
$controlled.slideDown( 200 );
} else {
$controlled.slideUp( 200 );
}
} );
$cb.trigger( 'change' );
} );
};
/**
* Bind elements that control the display of other elements
*
* @param obj $controllers jQuery selector for elements to be bound as checkbox controllers
* @return void
* @since 3.0.0
* @version 3.11.0
*/
this.bind_controllers = function( $controllers ) {
$controllers = $controllers || $( '[data-is-controller]' );
$controllers.each( function() {
var $el = $( this ),
$controlled = $( '[data-controller="#' + $el.attr( 'id' ) + '"]' ),
val;
$el.on( 'change', function() {
if ( 'checkbox' === $el.attr( 'type' ) ) {
val = $el.is( ':checked' ) ? $el.val() : 'false';
} else {
val = $el.val();
}
$controlled.each( function() {
var possible = $( this ).attr( 'data-controller-value' ),
vals = [];
if ( -1 !== possible.indexOf( ',' ) ) {
vals = possible.split( ',' );
} else {
vals.push( possible );
}
if ( -1 !== vals.indexOf( val ) ) {
$( this ).slideDown( 200 );
} else {
$( this ).slideUp( 200 );
}
} );
} );
$el.trigger( 'change' );
} );
};
/**
* Bind a single datepicker element
*
* @param obj $el jQuery selector for the input to bind the datepicker to
* @return void
* @since 3.0.0
* @version 3.10.0
*/
this.bind_datepicker = function( $el ) {
var format = $el.attr( 'data-format' ) || 'mm/dd/yy',
altFormat = $el.attr( 'data-alt-format' ) || '',
altField = $el.attr( 'data-alt-field' ) || '',
maxDate = $el.attr( 'data-max-date' ) || null,
minDate = $el.attr( 'data-min-date' ) || null;
$el.datepicker( {
dateFormat: format,
maxDate: maxDate,
minDate: minDate,
altField: altField,
altFormat: altFormat
} ).on( "keyup", function() {
var date;
try {
date = $.datepicker.parseDate( $.datepicker._defaults.dateFormat, this.value );
} catch ( e ) { }
if ( !date && altField.length > 0 ) {
if ( /^#[A-Za-z0-9\-_]+$/.test( altField ) ) {
$( altField ).val( "" );
}
}
} );
}
/**
* Bind all LifterLMS datepickers
*
* @param obj $datepickers jQuery selector for the elements to bind
* @return void
* @since 3.0.0
* @version 3.11.0
*/
this.bind_datepickers = function( $datepickers ) {
var self = this;
$datepickers = $datepickers || $( '.llms-datepicker' );
$datepickers.each( function() {
self.bind_datepicker( $( this ) );
} );
};
/**
* Bind llms-editable metabox fields and related dom interactions
*
* @since 3.10.0
* @since 3.28.0 Unknown.
* @since 5.3.0 Bind editables when editable buttons are present in addition to anchors.
*
* @return void
*/
this.bind_editables = function() {
var self = this;
function make_editable( $field ) {
var $label = $field.find( 'label' ).clone(),
name = $field.attr( 'data-llms-editable' ),
type = $field.attr( 'data-llms-editable-type' ),
required = $field.attr( 'data-llms-editable-required' ) || 'no',
val = $field.attr( 'data-llms-editable-value' ),
$input;
required = ( 'yes' === required ) ? ' required="required"' : '';
if ( 'select' === type ) {
var options = JSON.parse( $field.attr( 'data-llms-editable-options' ) ),
selected;
$input = $( '<select name="' + name + '"' + required + ' />' );
for ( var key in options ) {
selected = val === key ? ' selected="selected"' : '';
$input.append( '<option value="' + key + '"' + selected + '>' + options[ key ] + '</option>' );
}
} else if ( 'datetime' === type ) {
$input = $( '<div class="llms-datetime-field" />' );
val = JSON.parse( val );
var format = $field.attr( 'data-llms-editable-date-format' ) || '',
min_date = $field.attr( 'data-llms-editable-date-min' ) || '',
max_date = $field.attr( 'data-llms-editable-date-max' ) || '';
$picker = $( '<input class="llms-date-input llms-datepicker" data-format="' + format + '" data-max-date="' + max_date + '" data-min-date="' + min_date + '" name="' + name + '[date]" type="text" value="' + val.date + '">' );
self.bind_datepicker( $picker );
$input.append( $picker );
$input.append( '<em>@</em>' );
$input.append( '<input class="llms-time-input" max="23" min="0" name="' + name + '[hour]" type="number" value="' + val.hour + '">' );
$input.append( '<em>:</em>' );
$input.append( '<input class="llms-time-input" max="59" min="0" name="' + name + '[minute]" type="number" value="' + val.minute + '">' );
} else if ( 'price' === type ) {
$input = $( '<input>' )
.attr('name', name)
.attr('type', 'number')
.attr('min', '0')
.attr('step', 'any')
.attr('value', val);
if (required) {
$input.attr('required', 'required');
}
} else {
$input = $( '<input>' )
.attr('name', name)
.attr('type', type)
.attr('value', val);
if (required) {
$input.attr('required', 'required');
}
}
$field.empty().append( $label ).append( $input );
if ( 'select' === type ) {
setTimeout( function() {
$input.trigger( 'change' );
}, 100 );
}
};
$( 'a.llms-editable, button.llms-editable' ).on( 'click', function( e ) {
e.preventDefault();
var $btn = $( this ),
$fields;
if ( $btn.attr( 'data-fields' ) ) {
$fields = $( $btn.attr( 'data-fields' ) );
} else {
$fields = $btn.closest( '.llms-metabox-section' ).find( '[data-llms-editable]' );
}
$btn.remove();
$fields.each( function() {
make_editable( $( this ) );
} );
} );
};
/**
* Bind Engagement post type JS
*
* @return void
* @since 3.1.0
* @version 3.1.0
*/
this.bind_llms_engagement = function() {
var self = this;
// when the engagement type changes we need to do some things to the UI
$( '#_llms_engagement_type' ).on( 'change', function() {
$( '#_llms_engagement' ).trigger( 'llms-engagement-type-change', $( this ).val() );
} );
// custom trigger when called when the engagement type changes
$( '#_llms_engagement' ).on( 'llms-engagement-type-change', function( e, engagement_type ) {
var $select = $( this );
switch ( engagement_type ) {
/**
* core engagements related to a CPT
*/
case 'achievement':
case 'certificate':
case 'email':
var cpt = 'llms_' + engagement_type;
$select.val( null ).attr( 'data-post-type', cpt ).trigger( 'change' );
self.post_select( $select );
break;
/**
* Allow other plugins and developers to hook into the engagement type change action
*/
default:
$select.trigger( 'llms-engagement-type-change-external', engagement_type );
}
} );
};
this.bind_course = function() {
const canEditPost =
wp?.data &&
typeof wp.data.dispatch === 'function' &&
wp.data.dispatch( 'core/editor' ) !== null &&
typeof wp.data.dispatch( 'core/editor' ).editPost === 'function';
if ( ! canEditPost ) {
return;
}
var $course_length = $( '#_llms_length' );
$course_length.on( 'input change', function( e ) {
wp.data.dispatch( 'core/editor' ).editPost( {
meta: { _llms_length: e.target.value }
} );
} );
};
/**
* Actions for memberships
*
* @since 3.0.0
* @since 3.30.0 Made autoenroll table sortable, added AJAX save for adding new courses.
* @version 3.30.0
*
* @return void
*/
this.bind_llms_membership = function() {
var $table = $( '.llms-mb-list._llms_content_table' );
/**
* Hide/Show empty message header row depending on the number of rows in the tbody
*
* @since 3.30.0
* @version 3.30.0
*
* @return void
*/
function toggle_header_row() {
var $rows = $table.find( 'tbody tr' );
if ( 1 === $rows.length ) {
$rows.first().show();
} else {
$rows.first().hide();
}
}
/**
* Retrieve an array of course IDs in the table.
*
* @since 3.30.0
* @version 3.30.0
*
* @return array
*/
function get_course_ids() {
var courses = [];
$table.find( 'tbody tr a[href="#llms-course-remove"]' ).each( function() {
courses.push( $( this ).attr( 'data-id' ) );
} );
return courses;
}
// On init, toggle the header row visibility.
toggle_header_row();
// remove auto-enroll course
$table.on( 'click', 'a[href="#llms-course-remove"]', function( e ) {
e.preventDefault();
var $el = $( this ),
$row = $el.closest( 'tr' ),
$container = $el.closest( '.llms-mb-list' );
LLMS.Spinner.start( $container );
window.LLMS.Ajax.call( {
data: {
action: 'membership_remove_auto_enroll_course',
course_id: $el.attr( 'data-id' ),
},
beforeSend: function() {
$container.find( 'p.error' ).remove();
},
success: function( r ) {
if ( r.success ) {
$row.fadeOut( 200 );
setTimeout( function() {
$row.remove();
toggle_header_row();
}, 400 );
} else {
$container.prepend( '<p class="error">' + r.message + '</p>' );
}
LLMS.Spinner.stop( $container );
},
} );
} );
// bulk enroll all members into a course
$table.on( 'click', 'a[href="#llms-course-bulk-enroll"]', function( e ) {
e.preventDefault();
var $el = $( this ),
$row = $el.closest( 'tr' ),
$container = $el.closest( '.llms-mb-list' );
if ( ! window.confirm( LLMS.l10n.translate( 'Click okay to enroll all active members into the selected course. Enrollment will take place in the background and you may leave your site after confirmation. This action cannot be undone!' ) ) ) {
return;
}
LLMS.Spinner.start( $container );
window.LLMS.Ajax.call( {
data: {
action: 'bulk_enroll_membership_into_course',
course_id: $el.attr( 'data-id' ),
},
beforeSend: function() {
$container.find( 'p.error' ).remove();
},
success: function( r ) {
if ( r.success ) {
$el.replaceWith( '<strong style="float:right;">' + r.data.message + ' </strong>' );
} else {
$container.prepend( '<p class="error">' + r.message + '</p>' );
}
LLMS.Spinner.stop( $container );
},
} );
} );
// Add an item to the autoenroll table on select.
$( '#_llms_auto_enroll' ).on( 'change', function() {
var id = $( this ).val(),
title = $( this ).find( 'option[value="' + $( this ).val() + '"]' ).text();
// If there's no ID
if ( ! id ) {
return;
// Prevent Dupes.
} else if ( -1 !== get_course_ids().indexOf( id ) ) {
alert( LLMS.l10n.replace( '"%s" is already in the course list.', { '%s': title } ) )
// reset the select field.
$( this ).val( '' ).trigger( 'change' );
return;
}
var $table = $( '.llms-mb-list._llms_content_table' );
$tr = $( '<tr />' );
$tr.append( '<td><span class="dashicons dashicons-menu llms-drag-handle ui-sortable-handle"></span></td>' );
$tr.append( '<td><a href="' + window.llms.admin_url + 'post.php?action=edit&post=' + id + '">' + title + '</a></td>' );
$tr.append( '<td><a class="llms-button-danger small" data-id="' + id + '" href="#llms-course-remove" style="float:right;">' + LLMS.l10n.translate( 'Remove course' ) + '</a><a class="llms-button-secondary small" data-id="' + id + '" href="#llms-course-bulk-enroll" style="float:right;margin-right:5px;">' + LLMS.l10n.translate( 'Enroll All Members' ) + '</a></td>' );
// append the element to the table.
$table.find( 'table tbody' ).append( $tr );
// reset the select field.
$( this ).val( '' ).trigger( 'change' );
// Show the header row.
toggle_header_row();
// trigger a save event.
$table.trigger( 'llms-save-autoenroll-courses' );
} );
// Make autoenrollment table sortable.
$table.find( 'table tbody' ).sortable( {
handle: '.llms-drag-handle',
// Save order on stop.
stop: function( event, ui ) {
ui.item.closest( '.llms-mb-list' ).trigger( 'llms-save-autoenroll-courses' );
},
} );
// Save courses & course order.
$table.on( 'llms-save-autoenroll-courses', function() {
var $container = $( this );
LLMS.Spinner.start( $container );
window.LLMS.Ajax.call( {
data: {
action: 'llms_save_membership_autoenroll_courses',
courses: get_course_ids(),
},
error: function( jqxhr, code, error_msg ) {
alert( error_msg );
},
complete: function() {
LLMS.Spinner.stop( $container );
},
} );
} );
};
/**
* Actions for ORDERS
*
* @return void
* @since 3.0.0
* @version 3.28.0
*/
this.bind_llms_order = function() {
$( 'button[name="llms-refund-toggle"]' ).on( 'click', function() {
var $btn = $( this ),
$row = $btn.closest( 'tr' ),
txn_id = $row.attr( 'data-transaction-id' ),
refundable_amount = $btn.attr( 'data-refundable' ),
gateway_supports = ( '1' === $btn.attr( 'data-gateway-supports' ) ) ? true : false,
gateway_title = $btn.attr( 'data-gateway' ),
$new_row = $( '#llms-txn-refund-model .llms-txn-refund-form' ).clone(),
$gateway_btn = $new_row.find( '.gateway-btn' );
// configure and add the form
if ( 'remove' !== $btn.attr( 'data-action' ) ) {
$btn.text( LLMS.l10n.translate( 'Cancel' ) );
$btn.attr( 'data-action', 'remove' );
$new_row.find( 'input' ).removeAttr( 'disabled' );
$new_row.find( 'input[name="llms_refund_amount"]' ).attr( 'max', refundable_amount );
$new_row.find( 'input[name="llms_refund_txn_id"]' ).val( txn_id );
if ( gateway_supports ) {
$gateway_btn.find( '.llms-gateway-title' ).text( gateway_title );
$gateway_btn.show();
}
$row.after( $new_row );
} else {
$btn.text( LLMS.l10n.translate( 'Refund' ) );
$btn.attr( 'data-action', '' );
$row.next( 'tr' ).remove();
}
} );
$( 'button[name="llms-manual-txn-toggle"]' ).on( 'click', function() {
var $btn = $( this ),
$row = $btn.closest( 'tr' ),
$new_row = $( '#llms-manual-txn-model .llms-manual-txn-form' ).clone();
// configure and add the form
if ( 'remove' !== $btn.attr( 'data-action' ) ) {
$btn.text( LLMS.l10n.translate( 'Cancel' ) );
$btn.attr( 'data-action', 'remove' );
$new_row.find( 'input' ).removeAttr( 'disabled' );
$row.after( $new_row );
} else {
$btn.text( LLMS.l10n.translate( 'Record a Manual Payment' ) );
$btn.attr( 'data-action', '' );
$row.next( 'tr' ).remove();
}
} );
// cache the original value when focusing on a payment gateway select
// used below so the original field related data can be restored when switching back to the originally selected gateway
$( '.llms-metabox' ).one( 'focus', '.llms-metabox-field[data-llms-editable="payment_gateway"] select', function() {
if ( ! $( this ).attr( 'data-original-value' ) ) {
$( this ).attr( 'data-original-value', $( this ).val() );
}
} );
// when selecting a new payment gateway get field data and update the dom to only display the fields
// supported/needed by the newly selected gateway
$( '.llms-metabox' ).on( 'change', '.llms-metabox-field[data-llms-editable="payment_gateway"] select', function() {
var $select = $( this ),
gateway = $select.val(),
data = JSON.parse( $select.closest( '.llms-metabox-field' ).attr( 'data-gateway-fields' ) ),
gateway_data = data[ gateway ];
for ( var field in gateway_data ) {
var $field = $( 'input[name="' + gateway_data[ field ].name + '"]' ),
$wrap = $field.closest( '.llms-metabox-field' );
// if the field is enabled show it the field and, if we're switching back to the originally selected
// gateway, reload the value from the dom
if ( gateway_data[ field ].enabled ) {
$wrap.show();
$field.attr( 'required', 'required' );
$field.removeAttr( 'disabled' );
if ( gateway === $select.attr( 'data-original-value' ) ) {
$field.val( $wrap.attr( 'data-llms-editable-value' ) );
}
// otherwise hide the field
// this will ensure it gets updated in the database
} else {
// always clear the value when switching
// ensures that outdated data is removed from the DB
$field.attr( 'value', '' );
$field.removeAttr( 'required' );
// $field.attr( 'disabled', 'disabled' );
$wrap.hide();
}
}
} );
};
/**
* Re-initializes TinyMCE Editors found within metaboxes
*
* @since 4.19.0
* @since 4.21.2 Improve early return dependency check.
* @since 7.0.1 Add `undefined` condition on early return check.
*
* @link https://github.com/gocodebox/lifterlms/issues/1553
* @link https://github.com/gocodebox/lifterlms/pull/1618
* @link https://github.com/gocodebox/lifterlms/issues/2298
*
* @return {void}
*/
this.bind_mce_fixes = function() {
// We need `wp.data` to proceed.
if ( undefined === wp.data || [ null, undefined ].includes( wp.data.select( 'core/edit-post' ) ) ) {
return;
}
LLMS.wait_for(
function() {
return undefined !== wp.data.select( 'core/edit-post' ).getMetaBoxesPerLocation( 'normal' );
},
function() {
var shouldRun = false;
find = [ 'lifterlms-product', 'lifterlms-membership', 'lifterlms-course-options' ];
metaboxes = wp.data.select( 'core/edit-post' ).getMetaBoxesPerLocation( 'normal' );
// Determine if we should run the fixer.
for ( var key in metaboxes ) {
if ( -1 !== find.indexOf( metaboxes[ key ].id ) ) {
shouldRun = true;
break;
}
}
if ( ! shouldRun ) {
return;
}
// Fix them.
var toFix = {};
/**
* Determines if the TinyMCE instance should be fixed.
*
* @since 4.19.0
*
* @param {string} key Editor Key. This is the HTML id attribute of the textarea powering the editor instance.
* @return {Boolean} Returns `true` if the editor should be fixed.
*/
function llmsShouldFixTinyMCEEditor( key ) {
return ( 'excerpt' === key || -1 !== key.indexOf( 'llms' ) || -1 !== key.indexOf( 'lifterlms' ) )
};
// Loop through all the loaded editors.
for ( var key in tinyMCE.EditorManager.editors ) {
// Mark LifterLMS editors to be fixed & de-init the editor.
if ( llmsShouldFixTinyMCEEditor( key ) ) {
toFix[ key ] = tinyMCE.EditorManager.get( key );
tinyMCE.EditorManager.execCommand( 'mceRemoveEditor', true, key );
}
}
// If we remove and re-init immediately it doesn't work, so we'll wait a bit and then re-init them all.
setTimeout( function() {
for ( var key in toFix ) {
tinyMCE.EditorManager.init( toFix[ key ].settings || tinyMCE.EditorManager.settings );
}
}, 500 );
}
);
};
/**
* Binds custom llms merge code buttons
*
* @return void
* @since 3.1.0
* @version 3.9.2
*/
this.bind_merge_code_buttons = function( $wrappers ) {
$wrappers = $wrappers || $( '.llms-merge-code-wrapper' );
$wrappers.find( '.llms-merge-code-button' ).on( 'click', function() {
$( this ).next( '.llms-merge-codes' ).toggleClass( 'active' );
} );
$wrappers.find( '.llms-merge-codes li' ).on( 'click', function() {
var $el = $( this ),
$parent = $el.closest( '.llms-merge-codes' ),
target = $parent.attr( 'data-target' ),
code = $el.attr( 'data-code' );
// dealing with a tinymce instance
if ( -1 === target.indexOf( '#' ) ) {
var editor = window.tinymce.editors[ target ];
if ( editor ) {
editor.insertContent( code );
} // fallback in case we can't access the editor directly
else {
alert( LLMS.l10n.translate( 'Copy this code and paste it into the desired area' ) + ': ' + code );
}
}
// dealing with a DOM id
else {
$( target ).val( $( target ).val() + code );
}
$parent.removeClass( 'active' );
} );
};
/**
* Bind metabox tabs
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.bind_tabs = function() {
$( '.llms-nav-tab-wrapper .tabs li' ).on( 'click', function() {
var $btn = $( this ),
$metabox = $btn.closest( '.llms-mb-container' ),
tab_id = $btn.attr( 'data-tab' );
$btn.siblings().removeClass( 'llms-active' );
$metabox.find( '.tab-content' ).removeClass( 'llms-active' );
$btn.addClass( 'llms-active' );
$( '#' + tab_id ).addClass( 'llms-active' );
} );
};
/**
* Enable WP Post Table searches for applicable select2 boxes
*
* @since 3.0.0
* @since 3.21.0 Unknown.
* @since 6.0.0 Show element at 100% width if not displaying a view button.
* @since 7.1.1 Fixed `home_url` for view button.
*
* @return void
*/
this.post_select = function( $el ) {
var multi = 'multiple' === $el.attr( 'multiple' ),
noViewBtn = $el.attr( 'data-no-view-button' ),
editBtn = $el.attr( 'data-edit-button' );
$el.llmsPostsSelect2( {
width: multi || noViewBtn ? '100%' : '65%',
} );
if ( multi || noViewBtn ) {
return;
}
// add a "View" button to see what the selected page looks like, if it doesn't already exist.
$btn = $el.next('.select2').next( 'a.llms-button-secondary' );
if ( ! $btn.length ) {
var msg = editBtn ? LLMS.l10n.translate( 'Edit' ) : LLMS.l10n.translate( 'View' ),
$btn = $( '<a class="llms-button-secondary small" style="margin-left:5px;" target="_blank" href="#">' + msg + ' <i class="fa fa-external-link" aria-hidden="true"></i></a>' );
$el.next( '.select2' ).after( $btn );
$el.on( 'change', function() {
var id = $( this ).val();
if ( id ) {
if ( editBtn ) {
$btn.attr( 'href', window.llms.admin_url + 'post.php?action=edit&post=' + parseInt( id ) ).show();
} else {
$btn.attr( 'href', window.llms.home_url + '/?p=' + parseInt( id ) ).show();
}
} else {
$btn.hide();
}
} );
}
$el.trigger( 'change' );
};
/**
* Bind dom events for .llms-tables
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
this.bind_tables = function() {
$( '.llms-table button[name="llms-expand-table"]' ).on( 'click', function() {
var $btn = $( this ),
$table = $btn.closest( '.llms-table' )
// switch the text on the button if alt text is found
if ( $btn.attr( 'data-text' ) ) {
var text = $btn.text();
$btn.text( $btn.attr( 'data-text' ) );
$btn.attr( 'data-text', text );
}
// switch classes on all expandable elements
$table.find( '.expandable' ).each( function() {
if ( $( this ).hasClass( 'closed' ) ) {
$( this ).addClass( 'opened' ).removeClass( 'closed' );
} else {
$( this ).addClass( 'closed' ).removeClass( 'opened' );
}
} );
} );
};
// go
this.init();
};
// initialize the object
window.llms.metaboxes = new Metaboxes();
} )( jQuery );
================================================
FILE: assets/js/private/llms.js
================================================
/**
* Main LLMS Namespace
*
* @since 1.0.0
* @version 5.3.3
*/
var LLMS = window.LLMS || {};
( function( $ ){
'use strict';
/**
* Load all app modules
*/
// = include ../app/*.js
// = include ../llms-spinner.js
/**
* Initializes all classes within the LLMS Namespace
*
* @since Unknown
*
* @return {void}
*/
LLMS.init = function() {
for (var func in LLMS) {
if ( typeof LLMS[func] === 'object' && LLMS[func] !== null ) {
if ( LLMS[func].init !== undefined ) {
if ( typeof LLMS[func].init === 'function') {
LLMS[func].init();
}
}
}
}
};
/**
* Determine if the current device is touch-enabled
*
* @since 3.24.3
*
* @see {@link https://stackoverflow.com/a/4819886/400568}
*
* @return {Boolean} Whether or not the device is touch-enabled.
*/
LLMS.is_touch_device = function() {
var prefixes = ' -webkit- -moz- -o- -ms- '.split( ' ' );
var mq = function( query ) {
return window.matchMedia( query ).matches;
}
if ( ( 'ontouchstart' in window ) || window.DocumentTouch && document instanceof DocumentTouch ) {
return true;
}
/**
* Include the 'heartz' as a way to have a non matching MQ to help terminate the join.
*
* @see {@link https://git.io/vznFH}
*/
var query = ['(', prefixes.join( 'touch-enabled),(' ), 'heartz', ')'].join( '' );
return mq( query );
};
/**
* Wait for matchHeight to load
*
* @since 3.0.0
* @since 3.16.6 Unknown.
* @since 5.3.3 Pass a dependency name to `wait_for()`.
*
* @param {Function} cb Callback function to run when matchheight is ready.
* @return {void}
*/
LLMS.wait_for_matchHeight = function( cb ) {
this.wait_for( function() {
return ( undefined !== $.fn.matchHeight );
}, cb, 'matchHeight' );
}
/**
* Wait for webuiPopover to load
*
* @since 3.9.1
* @since 3.16.6 Unknown.
*
* @param {Function} cb Callback function to run when matchheight is ready.
* @return {void}
*/
LLMS.wait_for_popover = function( cb ) {
this.wait_for( function() {
return ( undefined !== $.fn.webuiPopover );
}, cb, 'webuiPopover' );
}
/**
* Wait for a dependency to load and then run a callback once it has
*
* Temporary fix for a less-than-optimal assets loading function on the PHP side of things.
*
* @since 3.9.1
* @since 5.3.3 Added optional `name` parameter.
*
* @param {Function} test A function that returns a truthy if the dependency is loaded.
* @param {Function} cb A callback function executed once the dependency is loaded.
* @param {string} name The dependency name.
* @return {void}
*/
LLMS.wait_for = function( test, cb, name ) {
var counter = 0,
interval;
name = name ? name : 'unnamed';
interval = setInterval( function() {
// If we get to 30 seconds log an error message.
if ( counter >= 300 ) {
console.log( 'Unable to load dependency: ' + name );
// If we can't access yet, increment and wait...
} else {
// Bind the events, we're good!
if ( test() ) {
cb();
} else {
// console.log( 'Waiting for dependency: ' + name );
counter++;
return;
}
}
clearInterval( interval );
}, 100 );
};
LLMS.init( $ );
} )( jQuery );
================================================
FILE: assets/js/vendor/jquery.matchHeight.js
================================================
/**
* jquery-match-height 0.7.0 by @liabru
* http://brm.io/jquery-match-height/
* License: MIT
*/
;(function(factory) { // eslint-disable-line no-extra-semi
'use strict';
if (typeof define === 'function' && define.amd) {
// AMD
define(['jquery'], factory);
} else if (typeof module !== 'undefined' && module.exports) {
// CommonJS
module.exports = factory(require('jquery'));
} else {
// Global
factory(jQuery);
}
})(function($) {
/*
* internal
*/
var _previousResizeWidth = -1,
_updateTimeout = -1;
/*
* _parse
* value parse utility function
*/
var _parse = function(value) {
// parse value and convert NaN to 0
return parseFloat(value) || 0;
};
/*
* _rows
* utility function returns array of jQuery selections representing each row
* (as displayed after float wrapping applied by browser)
*/
var _rows = function(elements) {
var tolerance = 1,
$elements = $(elements),
lastTop = null,
rows = [];
// group elements by their top position
$elements.each(function(){
var $that = $(this),
top = $that.offset().top - _parse($that.css('margin-top')),
lastRow = rows.length > 0 ? rows[rows.length - 1] : null;
if (lastRow === null) {
// first item on the row, so just push it
rows.push($that);
} else {
// if the row top is the same, add to the row group
if (Math.floor(Math.abs(lastTop - top)) <= tolerance) {
rows[rows.length - 1] = lastRow.add($that);
} else {
// otherwise start a new row group
rows.push($that);
}
}
// keep track of the last row top
lastTop = top;
});
return rows;
};
/*
* _parseOptions
* handle plugin options
*/
var _parseOptions = function(options) {
var opts = {
byRow: true,
property: 'height',
target: null,
remove: false
};
if (typeof options === 'object') {
return $.extend(opts, options);
}
if (typeof options === 'boolean') {
opts.byRow = options;
} else if (options === 'remove') {
opts.remove = true;
}
return opts;
};
/*
* matchHeight
* plugin definition
*/
var matchHeight = $.fn.matchHeight = function(options) {
var opts = _parseOptions(options);
// handle remove
if (opts.remove) {
var that = this;
// remove fixed height from all selected elements
this.css(opts.property, '');
// remove selected elements from all groups
$.each(matchHeight._groups, function(key, group) {
group.elements = group.elements.not(that);
});
// TODO: cleanup empty groups
return this;
}
if (this.length <= 1 && !opts.target) {
return this;
}
// keep track of this group so we can re-apply later on load and resize events
matchHeight._groups.push({
elements: this,
options: opts
});
// match each element's height to the tallest element in the selection
matchHeight._apply(this, opts);
return this;
};
/*
* plugin global options
*/
matchHeight.version = '0.7.0';
matchHeight._groups = [];
matchHeight._throttle = 80;
matchHeight._maintainScroll = false;
matchHeight._beforeUpdate = null;
matchHeight._afterUpdate = null;
matchHeight._rows = _rows;
matchHeight._parse = _parse;
matchHeight._parseOptions = _parseOptions;
/*
* matchHeight._apply
* apply matchHeight to given elements
*/
matchHeight._apply = function(elements, options) {
var opts = _parseOptions(options),
$elements = $(elements),
rows = [$elements];
// take note of scroll position
var scrollTop = $(window).scrollTop(),
htmlHeight = $('html').outerHeight(true);
// get hidden parents
var $hiddenParents = $elements.parents().filter(':hidden');
// cache the original inline style
$hiddenParents.each(function() {
var $that = $(this);
$that.data('style-cache', $that.attr('style'));
});
// temporarily must force hidden parents visible
$hiddenParents.css('display', 'block');
// get rows if using byRow, otherwise assume one row
if (opts.byRow && !opts.target) {
// must first force an arbitrary equal height so floating elements break evenly
$elements.each(function() {
var $that = $(this),
display = $that.css('display');
// temporarily force a usable display value
if (display !== 'inline-block' && display !== 'flex' && display !== 'inline-flex') {
display = 'block';
}
// cache the original inline style
$that.data('style-cache', $that.attr('style'));
$that.css({
'display': display,
'padding-top': '0',
'padding-bottom': '0',
'margin-top': '0',
'margin-bottom': '0',
'border-top-width': '0',
'border-bottom-width': '0',
'height': '100px',
'overflow': 'hidden'
});
});
// get the array of rows (based on element top position)
rows = _rows($elements);
// revert original inline styles
$elements.each(function() {
var $that = $(this);
$that.attr('style', $that.data('style-cache') || '');
});
}
$.each(rows, function(key, row) {
var $row = $(row),
targetHeight = 0;
if (!opts.target) {
// skip apply to rows with only one item
if (opts.byRow && $row.length <= 1) {
$row.css(opts.property, '');
return;
}
// iterate the row and find the max height
$row.each(function(){
var $that = $(this),
style = $that.attr('style'),
display = $that.css('display');
// temporarily force a usable display value
if (display !== 'inline-block' && display !== 'flex' && display !== 'inline-flex') {
display = 'block';
}
// ensure we get the correct actual height (and not a previously set height value)
var css = { 'display': display };
css[opts.property] = '';
$that.css(css);
// find the max height (including padding, but not margin)
if ($that.outerHeight(false) > targetHeight) {
targetHeight = $that.outerHeight(false);
}
// revert styles
if (style) {
$that.attr('style', style);
} else {
$that.css('display', '');
}
});
} else {
// if target set, use the height of the target element
targetHeight = opts.target.outerHeight(false);
}
// iterate the row and apply the height to all elements
$row.each(function(){
var $that = $(this),
verticalPadding = 0;
// don't apply to a target
if (opts.target && $that.is(opts.target)) {
return;
}
// handle padding and border correctly (required when not using border-box)
if ($that.css('box-sizing') !== 'border-box') {
verticalPadding += _parse($that.css('border-top-width')) + _parse($that.css('border-bottom-width'));
verticalPadding += _parse($that.css('padding-top')) + _parse($that.css('padding-bottom'));
}
// set the height (accounting for padding and border)
$that.css(opts.property, (targetHeight - verticalPadding) + 'px');
});
});
// revert hidden parents
$hiddenParents.each(function() {
var $that = $(this);
$that.attr('style', $that.data('style-cache') || null);
});
// restore scroll position if enabled
if (matchHeight._maintainScroll) {
$(window).scrollTop((scrollTop / htmlHeight) * $('html').outerHeight(true));
}
return this;
};
/*
* matchHeight._applyDataApi
* applies matchHeight to all elements with a data-match-height attribute
*/
matchHeight._applyDataApi = function() {
var groups = {};
// generate groups by their groupId set by elements using data-match-height
$('[data-match-height], [data-mh]').each(function() {
var $this = $(this),
groupId = $this.attr('data-mh') || $this.attr('data-match-height');
if (groupId in groups) {
groups[groupId] = groups[groupId].add($this);
} else {
groups[groupId] = $this;
}
});
// apply matchHeight to each group
$.each(groups, function() {
this.matchHeight(true);
});
};
/*
* matchHeight._update
* updates matchHeight on all current groups with their correct options
*/
var _update = function(event) {
if (matchHeight._beforeUpdate) {
matchHeight._beforeUpdate(event, matchHeight._groups);
}
$.each(matchHeight._groups, function() {
matchHeight._apply(this.elements, this.options);
});
if (matchHeight._afterUpdate) {
matchHeight._afterUpdate(event, matchHeight._groups);
}
};
matchHeight._update = function(throttle, event) {
// prevent update if fired from a resize event
// where the viewport width hasn't actually changed
// fixes an event looping bug in IE8
if (event && event.type === 'resize') {
var windowWidth = $(window).width();
if (windowWidth === _previousResizeWidth) {
return;
}
_previousResizeWidth = windowWidth;
}
// throttle updates
if (!throttle) {
_update(event);
} else if (_updateTimeout === -1) {
_updateTimeout = setTimeout(function() {
_update(event);
_updateTimeout = -1;
}, matchHeight._throttle);
}
};
/*
* bind events
*/
// apply on DOM ready event
$(matchHeight._applyDataApi);
// update heights on load and resize events
$(window).bind('load', function(event) {
matchHeight._update(false, event);
});
// throttled update heights on resize events
$(window).bind('resize orientationchange', function(event) {
matchHeight._update(true, event);
});
});
================================================
FILE: assets/js/vendor/js.cookie.js
================================================
/*!
* JavaScript Cookie v2.2.1
* https://github.com/js-cookie/js-cookie
*
* Copyright 2006, 2015 Klaus Hartl & Fagner Brack
* Released under the MIT license
*/
;(function (factory) {
var registeredInModuleLoader;
if (typeof define === 'function' && define.amd) {
define(factory);
registeredInModuleLoader = true;
}
if (typeof exports === 'object') {
module.exports = factory();
registeredInModuleLoader = true;
}
if (!registeredInModuleLoader) {
var OldCookies = window.Cookies;
var api = window.Cookies = factory();
api.noConflict = function () {
window.Cookies = OldCookies;
return api;
};
}
}(function () {
function extend () {
var i = 0;
var result = {};
for (; i < arguments.length; i++) {
var attributes = arguments[ i ];
for (var key in attributes) {
result[key] = attributes[key];
}
}
return result;
}
function decode (s) {
return s.replace(/(%[0-9A-Z]{2})+/g, decodeURIComponent);
}
function init (converter) {
function api() {}
function set (key, value, attributes) {
if (typeof document === 'undefined') {
return;
}
attributes = extend({
path: '/'
}, api.defaults, attributes);
if (typeof attributes.expires === 'number') {
attributes.expires = new Date(new Date() * 1 + attributes.expires * 864e+5);
}
// We're using "expires" because "max-age" is not supported by IE
attributes.expires = attributes.expires ? attributes.expires.toUTCString() : '';
try {
var result = JSON.stringify(value);
if (/^[\{\[]/.test(result)) {
value = result;
}
} catch (e) {}
value = converter.write ?
converter.write(value, key) :
encodeURIComponent(String(value))
.replace(/%(23|24|26|2B|3A|3C|3E|3D|2F|3F|40|5B|5D|5E|60|7B|7D|7C)/g, decodeURIComponent);
key = encodeURIComponent(String(key))
.replace(/%(23|24|26|2B|5E|60|7C)/g, decodeURIComponent)
.replace(/[\(\)]/g, escape);
var stringifiedAttributes = '';
for (var attributeName in attributes) {
if (!attributes[attributeName]) {
continue;
}
stringifiedAttributes += '; ' + attributeName;
if (attributes[attributeName] === true) {
continue;
}
// Considers RFC 6265 section 5.2:
// ...
// 3. If the remaining unparsed-attributes contains a %x3B (";")
// character:
// Consume the characters of the unparsed-attributes up to,
// not including, the first %x3B (";") character.
// ...
stringifiedAttributes += '=' + attributes[attributeName].split(';')[0];
}
return (document.cookie = key + '=' + value + stringifiedAttributes);
}
function get (key, json) {
if (typeof document === 'undefined') {
return;
}
var jar = {};
// To prevent the for loop in the first place assign an empty array
// in case there are no cookies at all.
var cookies = document.cookie ? document.cookie.split('; ') : [];
var i = 0;
for (; i < cookies.length; i++) {
var parts = cookies[i].split('=');
var cookie = parts.slice(1).join('=');
if (!json && cookie.charAt(0) === '"') {
cookie = cookie.slice(1, -1);
}
try {
var name = decode(parts[0]);
cookie = (converter.read || converter)(cookie, name) ||
decode(cookie);
if (json) {
try {
cookie = JSON.parse(cookie);
} catch (e) {}
}
jar[name] = cookie;
if (key === name) {
break;
}
} catch (e) {}
}
return key ? jar[key] : jar;
}
api.set = set;
api.get = function (key) {
return get(key, false /* read as raw */);
};
api.getJSON = function (key) {
return get(key, true /* read as json */);
};
api.remove = function (key, attributes) {
set(key, '', extend(attributes, {
expires: -1
}));
};
api.defaults = {};
api.withConverter = init;
return api;
}
return init(function () {});
}));
================================================
FILE: assets/scss/_includes/_buttons.scss
================================================
.llms-button-action,
.llms-button-danger,
.llms-button-primary,
.llms-button-secondary {
border:none;
border-radius: 8px;
color: $color-white;
cursor: pointer;
display: inline-block;
font-size: 18px;
font-weight: 700;
text-decoration: none;
text-shadow: none;
line-height: 1;
margin: 0;
max-width: 100%;
padding: 12px 24px;
position: relative;
transition: all .5s ease;
white-space: nowrap;
&:disabled {
opacity: 0.5;
}
&:hover, &:active {
color: $color-white;
}
&:focus {
color: $color-white;
}
&.auto {
width: auto;
}
&.full {
display: block;
text-align: center;
width: 100%;
}
&.square {
padding: 12px;
}
&.small {
font-size: 13px;
padding: 8px 14px;
&.square { padding: 8px; }
}
&.large {
font-size: 18px;
line-height: 1.2;
padding: 16px 32px;
&.square { padding: 16px; }
.fa {
left: -7px;
position: relative;
}
}
}
/* Fix for cases where link color overrides the button color */
a.llms-button-action,
a.llms-button-danger,
a.llms-button-primary {
color: $color-white;
}
.llms-button-primary {
background: $color-brand-blue;
&:hover,
&.clicked {
background: $color-brand-blue-dark;
}
&:focus,
&:active {
background: $color-brand-blue-light;
}
}
.llms-button-secondary {
background: #e1e1e1;
color: $color-cinder;
&:hover {
color: #414141;
background: darken( #e1e1e1, 8 );
}
&:focus,
&:active {
color: #414141;
background: lighten( #e1e1e1, 4 );
}
}
/* Fix for cases where link color overrides the button color */
a.llms-button-secondary {
color: $color-cinder;
}
.llms-button-action {
background: $color-orange;
&:hover,
&.clicked {
background: $color-brand-orange-dark;
}
&:focus,
&:active {
background: $color-brand-orange-light;
}
}
.llms-button-danger {
background: $color-danger;
&:hover {
background: darken( $color-danger, 8 );
}
&:focus,
&:active {
background: lighten( $color-danger, 4 );
}
}
.llms-button-outline {
background: transparent;
border: 3px solid #1D2327;
border-radius: 8px;
color: #1D2327;
cursor: pointer;
font-size: 16px;
font-weight: 700;
text-decoration: none;
text-shadow: none;
line-height: 1;
margin: 0;
max-width: 100%;
padding: 12px 24px;
position: relative;
transition: all .5s ease;
&:disabled {
opacity: 0.5;
}
&:hover, &:active {
color: #1D2327;
}
&:focus {
color: #1D2327;
}
&.auto {
width: auto;
}
&.full {
display: block;
text-align: center;
width: 100%;
}
&.square {
padding: 12px;
}
}
.llms-button-plain {
background: transparent;
border: none;
border-radius: 3px;
color: #1D2327;
cursor: pointer;
font-size: 16px;
font-weight: 700;
text-decoration: none;
text-shadow: none;
line-height: 1;
margin: 0;
max-width: 100%;
padding: 1px 3px;
position: relative;
&:hover, &:active {
color: #1D2327;
}
&:focus {
color: #1D2327;
}
}
.llms-course-continue-button {
display: inline-block;
}
================================================
FILE: assets/scss/_includes/_extends.scss
================================================
%cf,
%clearfix {
&:before,
&:after {
content: " ";
display: table;
}
&:after {
clear: both;
}
}
%llms-element {
background: $el-background;
box-shadow: $el-box-shadow;
display: block;
color: #212121;
min-height: 85px;
padding: 15px;
text-decoration: none;
position: relative;
transition: background .4s ease;
&:hover {
background: $el-background-hover;
}
}
================================================
FILE: assets/scss/_includes/_grid.scss
================================================
//
// Floated columns.
//
// Utilized prior to the introduction of `.llms-flex-cols`. Prefer
// usage of flex cols for new code where possible.
//
.llms-cols {
@extend %clearfix;
.llms-col { width: 100%; }
@media all and (min-width: 600px) {
[class*="llms-col-"] {
float: left;
}
}
}
//
// Flex-box columns.
//
// Preferred over floated `.llms-cols` wherever possible.
//
.llms-flex-cols {
display: flex;
flex-flow: row wrap;
[class*="llms-col"] {
flex: 0 1 auto;
width: 100%;
}
}
@media all and (min-width: 600px) {
.llms-cols, .llms-flex-cols {
$cols: 1;
@while $cols <= 12 {
.llms-col-#{$cols} {
width: calc( 100% / $cols );
}
$cols: $cols + 1;
}
}
}
================================================
FILE: assets/scss/_includes/_llms-donut.scss
================================================
.llms-donut {
@include clearfix;
background-color: #f1f1f1;
background-image: none;
border-radius: 50%;
color: $color-brand-blue;
height: 200px;
overflow: hidden;
position: relative;
width: 200px;
svg {
overflow: visible !important;
pointer-events: none;
width: 100%;
}
svg path {
fill: none;
stroke-width: 35px;
stroke: $color-brand-blue;
}
&.mini {
height: 36px;
width: 36px;
.percentage {
font-size: 10px;
}
}
&.small {
height: 100px;
width: 100px;
.percentage {
font-size: 18px;
}
}
&.medium {
height: 130px;
width: 130px;
.percentage {
font-size: 26px;
}
}
&.large {
height: 260px;
width: 260px;
.percentage {
font-size: 48px;
}
}
.inside {
align-items: center;
background: #fff;
border-radius: 50%;
box-sizing: border-box;
display: flex;
flex-wrap: wrap;
height: 80%;
justify-content: center;
left: 50%;
position: absolute;
text-align: center;
transform: translate(-50%, -50%);
width: 80%;
top: 50%;
z-index: 3;
}
.percentage {
line-height: 1.2;
font-size: 34px;
}
.caption {
font-size: 75%;
}
}
================================================
FILE: assets/scss/_includes/_llms-form-field.scss
================================================
.llms-form-fields {
@extend %clearfix;
box-sizing: border-box;
& * {
box-sizing: border-box;
}
&.flush {
.llms-form-field {
padding: 0 0 20px;
}
}
label:not(.llms-field-html label) {
font-weight: 700;
}
.wp-block-columns, .wp-block-column {
margin-bottom: 0;
}
}
.llms-form-heading {
padding: 0 10px 10px;
}
.llms-form-field {
float: left;
padding: 0 10px 20px;
position: relative;
width: 100%;
// Ensure "empty" labels don't break the layout.
// See the billing_address_2 field which has no label.
label:empty:after {
content: '\00a0';
}
[type="text"],
[type="password"],
[type="email"],
[type="url"],
[type="tel"],
[type="number"] {
background-color: $color-white;
background-clip: padding-box;
border: 1px solid $color-grey;
border-radius: $radius-small;
box-sizing: border-box;
font-size: 16px;
line-height: 1;
padding: 8px 12px;
transition: border-color 0.15s ease-in-out, box-shadow 0.15s ease-in-out;
width: 100%;
}
input:focus,
input:focus-visible {
border-color: $color-brand-blue-light;
outline: thin solid;
}
select {
-webkit-appearance: none;
-moz-appearance: none;
-ms-appearance: none;
appearance: none;
background-color: $color-white;
border: 1px solid $color-grey;
border-radius: $radius-small;
box-sizing: border-box;
color: $color-black;
padding: 8px 12px;
margin: 0;
width: 100%;
font-family: inherit;
font-size: 16px;
cursor: inherit;
line-height: 1.6;
z-index: 1;
outline: none;
background-repeat: no-repeat;
background-image: linear-gradient(45deg, transparent 50%, currentcolor 50%), linear-gradient(135deg, currentcolor 50%, transparent 50%);
background-position: right 15px top 1.3rem, right 10px top 1.3rem;
background-size: 5px 5px, 5px 5px;
}
select::-ms-expand {
display: none;
}
select:focus {
border: 1px solid $color-brand-blue-light;
outline: thin solid;
}
&.valid {
input[type="date"], input[type="time"], input[type="datetime-local"], input[type="week"], input[type="month"], input[type="text"], input[type="email"], input[type="url"], input[type="password"], input[type="search"], input[type="tel"], input[type="number"], textarea, select {
background: rgba( #83c373, .3 );
border-color: #83c373;
}
}
&.error,
&.invalid {
input[type="date"], input[type="time"], input[type="datetime-local"], input[type="week"], input[type="month"], input[type="text"], input[type="email"], input[type="url"], input[type="password"], input[type="search"], input[type="tel"], input[type="number"], textarea, select {
background: rgba( $color-red, .3 );
border-color: $color-red;
}
}
&.llms-visually-hidden-field {
display: none;
}
&.align-right {
text-align: right;
}
@media screen and ( min-width: 600px ) {
$i: 1;
@while $i <= 12 {
&.llms-cols-#{$i} {
width: calc( $i / 12 ) * 100%;
$i: $i + 1;
}
}
}
&.type-hidden { padding: 0; }
&.type-radio,
&.type-checkbox {
input,
label {
display: inline-block;
width: auto;
}
input {
margin-right: 10px;
}
label + .llms-description {
display: block;
}
}
&.type-radio:not(.is-group) {
input[type="radio"] {
position: absolute;
opacity: 0;
visibility: none;
}
label:before {
background: #fafafa;
background-position: -24px 0;
background-repeat: no-repeat;
border-radius: 50%;
box-shadow: hsla( 0,0%,100%,.15) 0 1px 1px, inset hsla(0,0%,0%,.35) 0 0 0 1px;
content: '';
cursor: pointer;
display: inline-block;
height: 22px;
margin-right: 5px;
position: relative;
transition: background-position .15s cubic-bezier(.8, 0, 1, 1);
top: -3px;
vertical-align: middle;
width: 22px;
z-index: 2;
}
input[type="radio"]:checked + label:before {
transition: background-position .2s .15s cubic-bezier(0, 0, .2, 1);
background-position: 0 0;
background-image: radial-gradient(ellipse at center, $color-brand-blue 0%,$color-brand-blue 40%, #fafafa 45%);
}
}
.llms-input-group {
margin-top: 5px;
.llms-form-field {
padding: 0 0 5px 5px;
}
}
&.type-reset,
&.type-button,
&.type-submit {
button:not(.auto) { width: 100%; }
}
.llms-description {
font-size: 14px;
font-style: italic;
line-height: 18px;
}
.llms-required {
color: $color-red;
margin-left: 4px;
}
input, textarea, select {
width: 100%;
margin-bottom: 5px;
}
.select2-container .select2-selection--single {
height: auto;
padding: 4px 6px;
}
.select2-container--default .select2-selection--single .select2-selection__arrow {
height: 100%;
}
&:has(.llms-visibility-toggle) {
align-items: center;
display: grid;
grid-template-areas:
"label toggle"
"input input";
grid-template-columns: 1fr auto;
label {
grid-area: label;
}
input {
grid-area: input;
}
.llms-visibility-toggle {
grid-area: toggle;
justify-self: end;
}
}
}
.llms-password-strength-meter {
border: 1px solid #dadada;
display: none;
font-size: 10px;
margin-top: -10px;
padding: 1px;
position: relative;
text-align: center;
&:before {
bottom: 0;
content: '';
left: 0;
position: absolute;
top: 0;
transition: width .4s ease;
}
&.mismatch,
&.too-short,
&.very-weak {
border-color: #e35b5b;
&:before {
background: rgba( #e35b5b, 0.25 );
width: 25%;
}
}
&.too-short:before {
width: 0;
}
&.weak {
border-color: #f78b53;
&:before {
background: rgba( #f78b53, 0.25 );
width: 50%;
}
}
&.medium {
border-color: #ffc733;
&:before {
background: rgba( #ffc733, 0.25 );
width: 75%;
}
}
&.strong {
border-color: #83c373;
&:before {
background: rgba( #83c373, 0.25 );
width: 100%;
}
}
+ .llms-description {
display: block;
}
}
================================================
FILE: assets/scss/_includes/_mixins.scss
================================================
@mixin clearfix() {
&:before,
&:after {
content: " ";
display: table;
}
&:after {
clear: both;
}
}
//
// Positioning mixin
//
// @param [string] $position: position
// @param [list] $args (()): offsets list
//
// @source http://hugogiraudel.com/2013/08/05/offsets-sass-mixin/
//
@mixin position($position, $args: ()) {
$offsets: top right bottom left;
position: $position;
@each $offset in $offsets {
$index: index($args, $offset);
@if $index {
@if $index == length($args) {
#{$offset}: 0;
}
@else {
$next: nth($args, $index + 1);
@if is-valid-length($next) {
#{$offset}: $next;
}
@else if index($offsets, $next) {
#{$offset}: 0;
}
@else {
@warn "Invalid value `#{$next}` for offset `#{$offset}`.";
}
}
}
}
}
//
// Function checking if $value is a valid length
// @param [literal] $value: value to test
// @return [bool]
//
@function is-valid-length($value) {
$r: (type-of($value) == "number" and not unitless($value)) or (index(auto initial inherit 0, $value) != null);
@return $r;
}
//
// Shorthands
//
@mixin absolute($args: ()) {
@include position(absolute, $args);
}
@mixin fixed($args: ()) {
@include position(fixed, $args);
}
@mixin relative($args: ()) {
@include position(relative, $args);
}
@mixin order_status_badges() {
.llms-status {
border-radius: $radius-small;
display: inline-block;
font-size: 13px;
font-weight: 700;
line-height: 1.4;
padding: 2px 6px;
vertical-align: middle;
&.llms-size--large {
font-size: 105%;
padding: 6px 12px;
}
&.llms-active,
&.llms-completed,
&.llms-pass, // quiz
&.llms-txn-succeeded {
color: $color-green;
background-color: rgba( $color-green, .15 );
}
&.llms-fail, // quiz
&.llms-failed,
&.llms-expired,
&.llms-cancelled,
&.llms-txn-failed {
color: $color-red;
background-color: rgba( $color-red, .15 );
}
&.llms-incomplete, // assignment
&.llms-on-hold,
&.llms-pending,
&.llms-pending-cancel,
&.llms-refunded,
&.llms-txn-pending,
&.llms-txn-refunded {
color: $color-orange;
background-color: rgba( $color-orange, .15 );
}
}
}
================================================
FILE: assets/scss/_includes/_quiz-result-question-list.scss
================================================
.llms-quiz-attempt-results {
margin: 0;
padding: 0;
list-style-type: none;
.llms-quiz-attempt-question {
background: #efefef;
border-radius: $radius-small;
margin: 0 0 15px;
position: relative;
list-style-type: none;
.toggle-answer {
color: inherit;
display: flex;
gap: 10px;
justify-content: space-between;
padding: 15px 35px 15px 15px;
text-decoration: none;
}
&.status--waiting.correct,
&.status--waiting.incorrect {
background: rgba( $color-orange, 0.2 );
.llms-status-icon {
background-color: $color-orange;
}
}
&.status--graded.correct {
background: rgba( $color-green, 0.15 );
.llms-status-icon {
background-color: $color-green;
}
}
&.status--graded.incorrect {
background: rgba( $color-red, 0.15 );
.llms-status-icon {
background-color: $color-red;
}
}
pre {
overflow: auto;
}
.llms-question-title {
font-size: 22px;
margin: 0;
line-height: 1.4;
}
.llms-points {
line-height: 1.4;
}
.llms-status-icon-tip {
position: absolute;
right: -12px;
top: -2px;
}
.llms-status-icon {
color: rgba( 255, 255, 255, 0.65 );
border-radius: 50%;
font-size: 30px;
height: 40px;
line-height: 40px;
text-align: center;
width: 40px;
}
.llms-quiz-attempt-question-main {
display: none;
padding: 0 15px 15px;
.llms-quiz-results-label {
font-weight: 700;
margin: 0 0 10px;
padding: 0;
}
ul.llms-quiz-attempt-answers {
margin: 0;
padding: 0;
li.llms-quiz-attempt-answer {
padding: 0;
margin: 0 0 0 30px;
&:only-child {
list-style-type: none;
margin-left: 0;
}
}
}
img {
height: auto;
max-width: 200px;
}
.llms-quiz-attempt-answer-section {
border-top: 2px solid rgba( #fff, 0.5 );
margin-top: 20px;
padding-top: 20px;
&:first-child {
border-top: none;
margin-top: 0;
padding-top: 0;
}
}
}
&.type--picture_choice,
&.type--picture_reorder {
ul.llms-quiz-attempt-answers {
list-style-type: none;
margin: 0;
padding: 0;
li.llms-quiz-attempt-answer {
display: inline-block;
list-style-type: none;
margin: 0;
padding: 5px;
}
}
}
&.type--removed {
.llms-question-title {
font-style: italic;
font-weight: normal;
}
opacity: .5;
}
}
}
================================================
FILE: assets/scss/_includes/_tooltip.scss
================================================
.lifterlms, // Settings & Course Builder.
.llms-metabox, // Some Metaboxes.
.llms-mb-container, // Other Metaboxes.
.llms-quiz-wrapper { // Quiz results.
[data-tip],
[data-title-default],
[data-title-active] {
$bgcolor: #444;
position: relative;
&.tip--top-right {
&:before {
bottom: 100%;
left: -10px;
}
&:hover:before {
bottom: calc( 100% + 6px );
}
&:after {
border-top-color: $bgcolor;
left: 6px;
top: 0;
}
&:hover:after {
top: -6px;
}
}
&.tip--top-left {
&:before {
bottom: 100%;
right: -10px;
}
&:hover:before {
bottom: calc( 100% + 6px );
}
&:after {
border-top-color: $bgcolor;
right: 6px;
top: 0;
}
&:hover:after {
top: -6px;
}
}
&.tip--bottom-left {
&:before {
top: 100%;
right: -10px;
}
&:hover:before {
top: calc( 100% + 6px );
}
&:after {
border-bottom-color: $bgcolor;
right: 6px;
bottom: 0;
}
&:hover:after {
bottom: -6px;
}
}
&.tip--bottom-right {
&:before {
top: 100%;
left: -10px;
}
&:hover:before {
top: calc( 100% + 6px );
}
&:after {
border-bottom-color: $bgcolor;
left: 6px;
bottom: 0;
}
&:hover:after {
bottom: -6px;
}
}
&:before {
background: $bgcolor;
border-radius: 4px;
color: #fff;
font-size: 13px;
line-height: 1.2;
padding: 8px;
max-width: 300px;
width: max-content;
}
&:after {
content: '';
border: 6px solid transparent;
height: 0;
width: 0;
}
&:before,
&:after {
opacity: 0;
transition: all 0.2s 0.1s ease;
position: absolute;
pointer-events: none;
visibility: hidden;
}
&:hover:before,
&:hover:after {
opacity: 1;
transition: all 0 0.1s ease;
visibility: visible;
z-index: 99999999;
}
}
[data-tip] {
&:before {
content: attr(data-tip);
}
}
[data-tip].active {
&:before {
content: attr(data-tip-active);
}
}
}
================================================
FILE: assets/scss/_includes/_vars-brand-colors.scss
================================================
//
// LifterLMS Brand Colors
// Currently overrides brand colors on the admin panel
//
$color-brand-blue: #466dd8;
$color-brand-blue-dark: darken( $color-brand-blue, 8 );
$color-brand-dark-blue: darken( $color-brand-blue, 24 );
$color-brand-blue-light: lighten( $color-brand-blue, 8 );
$color-brand-orange: #f8954f;
$color-brand-orange-dark: #f67d28;
$color-brand-orange-light: lighten( $color-brand-orange, 8 );
$color-brand-aqua: #17bebb;
$color-brand-pink: #ef476f;
$color-blue: $color-brand-blue;
================================================
FILE: assets/scss/_includes/_vars.scss
================================================
// ----- LifterLMS Brand Colors ----- \\
$color-brand-dark-blue: #243c56;
$color-brand-blue: #466dd8;
$color-brand-blue-dark: darken( $color-brand-blue, 12 ); // #0077e4
$color-brand-blue-light: lighten( $color-brand-blue, 8 );
$color-brand-orange: #f8954f;
$color-brand-orange-dark: #f67d28;
$color-brand-orange-light: lighten( $color-brand-orange, 8 );
$color-brand-aqua: #17bebb;
$color-brand-pink: #ef476f;
// ----- name our versions of common colors ----- \\
$color-black: #010101;
$color-green: #4d8d3c;
$color-blue: $color-brand-blue;
$color-red: #bb231c;
$color-white: #fefefe;
$color-aqua: #35bbaa;
$color-purple: #845ef7;
$color-orange: #c05621;
$color-red-hover: darken($color-red,5);
// ----- state / action names ----- \\
$color-success: $color-green;
$color-danger: $color-red;
$color-lightgrey: #ccc;
$color-grey: #999;
$color-darkgrey: #666;
$color-cinder: #444;
$color-lightblue: #33b1cb;
$color-darkblue: #0185a3;
$color-border: #dedede;
$el-box-shadow: 0 1px 2px 0 rgba($color-black,0.4);
$el-background: #f1f1f1;
$el-background-hover: #eaeaea;
$break-xsmall: 320px;
$break-small: 641px;
$break-medium: 768px;
$break-large: 1024px;
$radius-small: 6px;
$radius-medium: 12px;
================================================
FILE: assets/scss/_includes/vendor/_font-awesome.scss
================================================
/*!
* Font Awesome 4.7.0 by @davegandy - http://fontawesome.io - @fontawesome
* License - http://fontawesome.io/license (Font: SIL OFL 1.1, CSS: MIT License)
*/
/* FONT PATH
* -------------------------- */
@font-face {
font-family: 'FontAwesome';
src: url('../fonts/fontawesome-webfont.eot?v=4.7.0');
src: url('../fonts/fontawesome-webfont.eot?#iefix&v=4.7.0') format('embedded-opentype'), url('../fonts/fontawesome-webfont.woff2?v=4.7.0') format('woff2'), url('../fonts/fontawesome-webfont.woff?v=4.7.0') format('woff'), url('../fonts/fontawesome-webfont.ttf?v=4.7.0') format('truetype'), url('../fonts/fontawesome-webfont.svg?v=4.7.0#fontawesomeregular') format('svg');
font-weight: normal;
font-style: normal;
}
.fa {
display: inline-block;
font: normal normal normal 14px/1 FontAwesome;
font-size: inherit;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
/* makes the font 33% larger relative to the icon container */
.fa-lg {
font-size: 1.33333333em;
line-height: 0.75em;
vertical-align: -15%;
}
.fa-2x {
font-size: 2em;
}
.fa-3x {
font-size: 3em;
}
.fa-4x {
font-size: 4em;
}
.fa-5x {
font-size: 5em;
}
.fa-fw {
width: 1.28571429em;
text-align: center;
}
.fa-ul {
padding-left: 0;
margin-left: 2.14285714em;
list-style-type: none;
}
.fa-ul > li {
position: relative;
}
.fa-li {
position: absolute;
left: -2.14285714em;
width: 2.14285714em;
top: 0.14285714em;
text-align: center;
}
.fa-li.fa-lg {
left: -1.85714286em;
}
.fa-border {
padding: .2em .25em .15em;
border: solid 0.08em #eeeeee;
border-radius: .1em;
}
.fa-pull-left {
float: left;
}
.fa-pull-right {
float: right;
}
.fa.fa-pull-left {
margin-right: .3em;
}
.fa.fa-pull-right {
margin-left: .3em;
}
/* Deprecated as of 4.4.0 */
.pull-right {
float: right;
}
.pull-left {
float: left;
}
.fa.pull-left {
margin-right: .3em;
}
.fa.pull-right {
margin-left: .3em;
}
.fa-spin {
-webkit-animation: fa-spin 2s infinite linear;
animation: fa-spin 2s infinite linear;
}
.fa-pulse {
-webkit-animation: fa-spin 1s infinite steps(8);
animation: fa-spin 1s infinite steps(8);
}
@-webkit-keyframes fa-spin {
0% {
-webkit-transform: rotate(0deg);
transform: rotate(0deg);
}
100% {
-webkit-transform: rotate(359deg);
transform: rotate(359deg);
}
}
@keyframes fa-spin {
0% {
-webkit-transform: rotate(0deg);
transform: rotate(0deg);
}
100% {
-webkit-transform: rotate(359deg);
transform: rotate(359deg);
}
}
.fa-rotate-90 {
-ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=1)";
-webkit-transform: rotate(90deg);
-ms-transform: rotate(90deg);
transform: rotate(90deg);
}
.fa-rotate-180 {
-ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=2)";
-webkit-transform: rotate(180deg);
-ms-transform: rotate(180deg);
transform: rotate(180deg);
}
.fa-rotate-270 {
-ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=3)";
-webkit-transform: rotate(270deg);
-ms-transform: rotate(270deg);
transform: rotate(270deg);
}
.fa-flip-horizontal {
-ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=0, mirror=1)";
-webkit-transform: scale(-1, 1);
-ms-transform: scale(-1, 1);
transform: scale(-1, 1);
}
.fa-flip-vertical {
-ms-filter: "progid:DXImageTransform.Microsoft.BasicImage(rotation=2, mirror=1)";
-webkit-transform: scale(1, -1);
-ms-transform: scale(1, -1);
transform: scale(1, -1);
}
:root .fa-rotate-90,
:root .fa-rotate-180,
:root .fa-rotate-270,
:root .fa-flip-horizontal,
:root .fa-flip-vertical {
filter: none;
}
.fa-stack {
position: relative;
display: inline-block;
width: 2em;
height: 2em;
line-height: 2em;
vertical-align: middle;
}
.fa-stack-1x,
.fa-stack-2x {
position: absolute;
left: 0;
width: 100%;
text-align: center;
}
.fa-stack-1x {
line-height: inherit;
}
.fa-stack-2x {
font-size: 2em;
}
.fa-inverse {
color: #ffffff;
}
/* Font Awesome uses the Unicode Private Use Area (PUA) to ensure screen
readers do not read off random characters that represent icons */
.fa-glass:before {
content: "\f000";
}
.fa-music:before {
content: "\f001";
}
.fa-search:before {
content: "\f002";
}
.fa-envelope-o:before {
content: "\f003";
}
.fa-heart:before {
content: "\f004";
}
.fa-star:before {
content: "\f005";
}
.fa-star-o:before {
content: "\f006";
}
.fa-user:before {
content: "\f007";
}
.fa-film:before {
content: "\f008";
}
.fa-th-large:before {
content: "\f009";
}
.fa-th:before {
content: "\f00a";
}
.fa-th-list:before {
content: "\f00b";
}
.fa-check:before {
content: "\f00c";
}
.fa-remove:before,
.fa-close:before,
.fa-times:before {
content: "\f00d";
}
.fa-search-plus:before {
content: "\f00e";
}
.fa-search-minus:before {
content: "\f010";
}
.fa-power-off:before {
content: "\f011";
}
.fa-signal:before {
content: "\f012";
}
.fa-gear:before,
.fa-cog:before {
content: "\f013";
}
.fa-trash-o:before {
content: "\f014";
}
.fa-home:before {
content: "\f015";
}
.fa-file-o:before {
content: "\f016";
}
.fa-clock-o:before {
content: "\f017";
}
.fa-road:before {
content: "\f018";
}
.fa-download:before {
content: "\f019";
}
.fa-arrow-circle-o-down:before {
content: "\f01a";
}
.fa-arrow-circle-o-up:before {
content: "\f01b";
}
.fa-inbox:before {
content: "\f01c";
}
.fa-play-circle-o:before {
content: "\f01d";
}
.fa-rotate-right:before,
.fa-repeat:before {
content: "\f01e";
}
.fa-refresh:before {
content: "\f021";
}
.fa-list-alt:before {
content: "\f022";
}
.fa-lock:before {
content: "\f023";
}
.fa-flag:before {
content: "\f024";
}
.fa-headphones:before {
content: "\f025";
}
.fa-volume-off:before {
content: "\f026";
}
.fa-volume-down:before {
content: "\f027";
}
.fa-volume-up:before {
content: "\f028";
}
.fa-qrcode:before {
content: "\f029";
}
.fa-barcode:before {
content: "\f02a";
}
.fa-tag:before {
content: "\f02b";
}
.fa-tags:before {
content: "\f02c";
}
.fa-book:before {
content: "\f02d";
}
.fa-bookmark:before {
content: "\f02e";
}
.fa-print:before {
content: "\f02f";
}
.fa-camera:before {
content: "\f030";
}
.fa-font:before {
content: "\f031";
}
.fa-bold:before {
content: "\f032";
}
.fa-italic:before {
content: "\f033";
}
.fa-text-height:before {
content: "\f034";
}
.fa-text-width:before {
content: "\f035";
}
.fa-align-left:before {
content: "\f036";
}
.fa-align-center:before {
content: "\f037";
}
.fa-align-right:before {
content: "\f038";
}
.fa-align-justify:before {
content: "\f039";
}
.fa-list:before {
content: "\f03a";
}
.fa-dedent:before,
.fa-outdent:before {
content: "\f03b";
}
.fa-indent:before {
content: "\f03c";
}
.fa-video-camera:before {
content: "\f03d";
}
.fa-photo:before,
.fa-image:before,
.fa-picture-o:before {
content: "\f03e";
}
.fa-pencil:before {
content: "\f040";
}
.fa-map-marker:before {
content: "\f041";
}
.fa-adjust:before {
content: "\f042";
}
.fa-tint:before {
content: "\f043";
}
.fa-edit:before,
.fa-pencil-square-o:before {
content: "\f044";
}
.fa-share-square-o:before {
content: "\f045";
}
.fa-check-square-o:before {
content: "\f046";
}
.fa-arrows:before {
content: "\f047";
}
.fa-step-backward:before {
content: "\f048";
}
.fa-fast-backward:before {
content: "\f049";
}
.fa-backward:before {
content: "\f04a";
}
.fa-play:before {
content: "\f04b";
}
.fa-pause:before {
content: "\f04c";
}
.fa-stop:before {
content: "\f04d";
}
.fa-forward:before {
content: "\f04e";
}
.fa-fast-forward:before {
content: "\f050";
}
.fa-step-forward:before {
content: "\f051";
}
.fa-eject:before {
content: "\f052";
}
.fa-chevron-left:before {
content: "\f053";
}
.fa-chevron-right:before {
content: "\f054";
}
.fa-plus-circle:before {
content: "\f055";
}
.fa-minus-circle:before {
content: "\f056";
}
.fa-times-circle:before {
content: "\f057";
}
.fa-check-circle:before {
content: "\f058";
}
.fa-question-circle:before {
content: "\f059";
}
.fa-info-circle:before {
content: "\f05a";
}
.fa-crosshairs:before {
content: "\f05b";
}
.fa-times-circle-o:before {
content: "\f05c";
}
.fa-check-circle-o:before {
content: "\f05d";
}
.fa-ban:before {
content: "\f05e";
}
.fa-arrow-left:before {
content: "\f060";
}
.fa-arrow-right:before {
content: "\f061";
}
.fa-arrow-up:before {
content: "\f062";
}
.fa-arrow-down:before {
content: "\f063";
}
.fa-mail-forward:before,
.fa-share:before {
content: "\f064";
}
.fa-expand:before {
content: "\f065";
}
.fa-compress:before {
content: "\f066";
}
.fa-plus:before {
content: "\f067";
}
.fa-minus:before {
content: "\f068";
}
.fa-asterisk:before {
content: "\f069";
}
.fa-exclamation-circle:before {
content: "\f06a";
}
.fa-gift:before {
content: "\f06b";
}
.fa-leaf:before {
content: "\f06c";
}
.fa-fire:before {
content: "\f06d";
}
.fa-eye:before {
content: "\f06e";
}
.fa-eye-slash:before {
content: "\f070";
}
.fa-warning:before,
.fa-exclamation-triangle:before {
content: "\f071";
}
.fa-plane:before {
content: "\f072";
}
.fa-calendar:before {
content: "\f073";
}
.fa-random:before {
content: "\f074";
}
.fa-comment:before {
content: "\f075";
}
.fa-magnet:before {
content: "\f076";
}
.fa-chevron-up:before {
content: "\f077";
}
.fa-chevron-down:before {
content: "\f078";
}
.fa-retweet:before {
content: "\f079";
}
.fa-shopping-cart:before {
content: "\f07a";
}
.fa-folder:before {
content: "\f07b";
}
.fa-folder-open:before {
content: "\f07c";
}
.fa-arrows-v:before {
content: "\f07d";
}
.fa-arrows-h:before {
content: "\f07e";
}
.fa-bar-chart-o:before,
.fa-bar-chart:before {
content: "\f080";
}
.fa-twitter-square:before {
content: "\f081";
}
.fa-facebook-square:before {
content: "\f082";
}
.fa-camera-retro:before {
content: "\f083";
}
.fa-key:before {
content: "\f084";
}
.fa-gears:before,
.fa-cogs:before {
content: "\f085";
}
.fa-comments:before {
content: "\f086";
}
.fa-thumbs-o-up:before {
content: "\f087";
}
.fa-thumbs-o-down:before {
content: "\f088";
}
.fa-star-half:before {
content: "\f089";
}
.fa-heart-o:before {
content: "\f08a";
}
.fa-sign-out:before {
content: "\f08b";
}
.fa-linkedin-square:before {
content: "\f08c";
}
.fa-thumb-tack:before {
content: "\f08d";
}
.fa-external-link:before {
content: "\f08e";
}
.fa-sign-in:before {
content: "\f090";
}
.fa-trophy:before {
content: "\f091";
}
.fa-github-square:before {
content: "\f092";
}
.fa-upload:before {
content: "\f093";
}
.fa-lemon-o:before {
content: "\f094";
}
.fa-phone:before {
content: "\f095";
}
.fa-square-o:before {
content: "\f096";
}
.fa-bookmark-o:before {
content: "\f097";
}
.fa-phone-square:before {
content: "\f098";
}
.fa-twitter:before {
content: "\f099";
}
.fa-facebook-f:before,
.fa-facebook:before {
content: "\f09a";
}
.fa-github:before {
content: "\f09b";
}
.fa-unlock:before {
content: "\f09c";
}
.fa-credit-card:before {
content: "\f09d";
}
.fa-feed:before,
.fa-rss:before {
content: "\f09e";
}
.fa-hdd-o:before {
content: "\f0a0";
}
.fa-bullhorn:before {
content: "\f0a1";
}
.fa-bell:before {
content: "\f0f3";
}
.fa-certificate:before {
content: "\f0a3";
}
.fa-hand-o-right:before {
content: "\f0a4";
}
.fa-hand-o-left:before {
content: "\f0a5";
}
.fa-hand-o-up:before {
content: "\f0a6";
}
.fa-hand-o-down:before {
content: "\f0a7";
}
.fa-arrow-circle-left:before {
content: "\f0a8";
}
.fa-arrow-circle-right:before {
content: "\f0a9";
}
.fa-arrow-circle-up:before {
content: "\f0aa";
}
.fa-arrow-circle-down:before {
content: "\f0ab";
}
.fa-globe:before {
content: "\f0ac";
}
.fa-wrench:before {
content: "\f0ad";
}
.fa-tasks:before {
content: "\f0ae";
}
.fa-filter:before {
content: "\f0b0";
}
.fa-briefcase:before {
content: "\f0b1";
}
.fa-arrows-alt:before {
content: "\f0b2";
}
.fa-group:before,
.fa-users:before {
content: "\f0c0";
}
.fa-chain:before,
.fa-link:before {
content: "\f0c1";
}
.fa-cloud:before {
content: "\f0c2";
}
.fa-flask:before {
content: "\f0c3";
}
.fa-cut:before,
.fa-scissors:before {
content: "\f0c4";
}
.fa-copy:before,
.fa-files-o:before {
content: "\f0c5";
}
.fa-paperclip:before {
content: "\f0c6";
}
.fa-save:before,
.fa-floppy-o:before {
content: "\f0c7";
}
.fa-square:before {
content: "\f0c8";
}
.fa-navicon:before,
.fa-reorder:before,
.fa-bars:before {
content: "\f0c9";
}
.fa-list-ul:before {
content: "\f0ca";
}
.fa-list-ol:before {
content: "\f0cb";
}
.fa-strikethrough:before {
content: "\f0cc";
}
.fa-underline:before {
content: "\f0cd";
}
.fa-table:before {
content: "\f0ce";
}
.fa-magic:before {
content: "\f0d0";
}
.fa-truck:before {
content: "\f0d1";
}
.fa-pinterest:before {
content: "\f0d2";
}
.fa-pinterest-square:before {
content: "\f0d3";
}
.fa-google-plus-square:before {
content: "\f0d4";
}
.fa-google-plus:before {
content: "\f0d5";
}
.fa-money:before {
content: "\f0d6";
}
.fa-caret-down:before {
content: "\f0d7";
}
.fa-caret-up:before {
content: "\f0d8";
}
.fa-caret-left:before {
content: "\f0d9";
}
.fa-caret-right:before {
content: "\f0da";
}
.fa-columns:before {
content: "\f0db";
}
.fa-unsorted:before,
.fa-sort:before {
content: "\f0dc";
}
.fa-sort-down:before,
.fa-sort-desc:before {
content: "\f0dd";
}
.fa-sort-up:before,
.fa-sort-asc:before {
content: "\f0de";
}
.fa-envelope:before {
content: "\f0e0";
}
.fa-linkedin:before {
content: "\f0e1";
}
.fa-rotate-left:before,
.fa-undo:before {
content: "\f0e2";
}
.fa-legal:before,
.fa-gavel:before {
content: "\f0e3";
}
.fa-dashboard:before,
.fa-tachometer:before {
content: "\f0e4";
}
.fa-comment-o:before {
content: "\f0e5";
}
.fa-comments-o:before {
content: "\f0e6";
}
.fa-flash:before,
.fa-bolt:before {
content: "\f0e7";
}
.fa-sitemap:before {
content: "\f0e8";
}
.fa-umbrella:before {
content: "\f0e9";
}
.fa-paste:before,
.fa-clipboard:before {
content: "\f0ea";
}
.fa-lightbulb-o:before {
content: "\f0eb";
}
.fa-exchange:before {
content: "\f0ec";
}
.fa-cloud-download:before {
content: "\f0ed";
}
.fa-cloud-upload:before {
content: "\f0ee";
}
.fa-user-md:before {
content: "\f0f0";
}
.fa-stethoscope:before {
content: "\f0f1";
}
.fa-suitcase:before {
content: "\f0f2";
}
.fa-bell-o:before {
content: "\f0a2";
}
.fa-coffee:before {
content: "\f0f4";
}
.fa-cutlery:before {
content: "\f0f5";
}
.fa-file-text-o:before {
content: "\f0f6";
}
.fa-building-o:before {
content: "\f0f7";
}
.fa-hospital-o:before {
content: "\f0f8";
}
.fa-ambulance:before {
content: "\f0f9";
}
.fa-medkit:before {
content: "\f0fa";
}
.fa-fighter-jet:before {
content: "\f0fb";
}
.fa-beer:before {
content: "\f0fc";
}
.fa-h-square:before {
content: "\f0fd";
}
.fa-plus-square:before {
content: "\f0fe";
}
.fa-angle-double-left:before {
content: "\f100";
}
.fa-angle-double-right:before {
content: "\f101";
}
.fa-angle-double-up:before {
content: "\f102";
}
.fa-angle-double-down:before {
content: "\f103";
}
.fa-angle-left:before {
content: "\f104";
}
.fa-angle-right:before {
content: "\f105";
}
.fa-angle-up:before {
content: "\f106";
}
.fa-angle-down:before {
content: "\f107";
}
.fa-desktop:before {
content: "\f108";
}
.fa-laptop:before {
content: "\f109";
}
.fa-tablet:before {
content: "\f10a";
}
.fa-mobile-phone:before,
.fa-mobile:before {
content: "\f10b";
}
.fa-circle-o:before {
content: "\f10c";
}
.fa-quote-left:before {
content: "\f10d";
}
.fa-quote-right:before {
content: "\f10e";
}
.fa-spinner:before {
content: "\f110";
}
.fa-circle:before {
content: "\f111";
}
.fa-mail-reply:before,
.fa-reply:before {
content: "\f112";
}
.fa-github-alt:before {
content: "\f113";
}
.fa-folder-o:before {
content: "\f114";
}
.fa-folder-open-o:before {
content: "\f115";
}
.fa-smile-o:before {
content: "\f118";
}
.fa-frown-o:before {
content: "\f119";
}
.fa-meh-o:before {
content: "\f11a";
}
.fa-gamepad:before {
content: "\f11b";
}
.fa-keyboard-o:before {
content: "\f11c";
}
.fa-flag-o:before {
content: "\f11d";
}
.fa-flag-checkered:before {
content: "\f11e";
}
.fa-terminal:before {
content: "\f120";
}
.fa-code:before {
content: "\f121";
}
.fa-mail-reply-all:before,
.fa-reply-all:before {
content: "\f122";
}
.fa-star-half-empty:before,
.fa-star-half-full:before,
.fa-star-half-o:before {
content: "\f123";
}
.fa-location-arrow:before {
content: "\f124";
}
.fa-crop:before {
content: "\f125";
}
.fa-code-fork:before {
content: "\f126";
}
.fa-unlink:before,
.fa-chain-broken:before {
content: "\f127";
}
.fa-question:before {
content: "\f128";
}
.fa-info:before {
content: "\f129";
}
.fa-exclamation:before {
content: "\f12a";
}
.fa-superscript:before {
content: "\f12b";
}
.fa-subscript:before {
content: "\f12c";
}
.fa-eraser:before {
content: "\f12d";
}
.fa-puzzle-piece:before {
content: "\f12e";
}
.fa-microphone:before {
content: "\f130";
}
.fa-microphone-slash:before {
content: "\f131";
}
.fa-shield:before {
content: "\f132";
}
.fa-calendar-o:before {
content: "\f133";
}
.fa-fire-extinguisher:before {
content: "\f134";
}
.fa-rocket:before {
content: "\f135";
}
.fa-maxcdn:before {
content: "\f136";
}
.fa-chevron-circle-left:before {
content: "\f137";
}
.fa-chevron-circle-right:before {
content: "\f138";
}
.fa-chevron-circle-up:before {
content: "\f139";
}
.fa-chevron-circle-down:before {
content: "\f13a";
}
.fa-html5:before {
content: "\f13b";
}
.fa-css3:before {
content: "\f13c";
}
.fa-anchor:before {
content: "\f13d";
}
.fa-unlock-alt:before {
content: "\f13e";
}
.fa-bullseye:before {
content: "\f140";
}
.fa-ellipsis-h:before {
content: "\f141";
}
.fa-ellipsis-v:before {
content: "\f142";
}
.fa-rss-square:before {
content: "\f143";
}
.fa-play-circle:before {
content: "\f144";
}
.fa-ticket:before {
content: "\f145";
}
.fa-minus-square:before {
content: "\f146";
}
.fa-minus-square-o:before {
content: "\f147";
}
.fa-level-up:before {
content: "\f148";
}
.fa-level-down:before {
content: "\f149";
}
.fa-check-square:before {
content: "\f14a";
}
.fa-pencil-square:before {
content: "\f14b";
}
.fa-external-link-square:before {
content: "\f14c";
}
.fa-share-square:before {
content: "\f14d";
}
.fa-compass:before {
content: "\f14e";
}
.fa-toggle-down:before,
.fa-caret-square-o-down:before {
content: "\f150";
}
.fa-toggle-up:before,
.fa-caret-square-o-up:before {
content: "\f151";
}
.fa-toggle-right:before,
.fa-caret-square-o-right:before {
content: "\f152";
}
.fa-euro:before,
.fa-eur:before {
content: "\f153";
}
.fa-gbp:before {
content: "\f154";
}
.fa-dollar:before,
.fa-usd:before {
content: "\f155";
}
.fa-rupee:before,
.fa-inr:before {
content: "\f156";
}
.fa-cny:before,
.fa-rmb:before,
.fa-yen:before,
.fa-jpy:before {
content: "\f157";
}
.fa-ruble:before,
.fa-rouble:before,
.fa-rub:before {
content: "\f158";
}
.fa-won:before,
.fa-krw:before {
content: "\f159";
}
.fa-bitcoin:before,
.fa-btc:before {
content: "\f15a";
}
.fa-file:before {
content: "\f15b";
}
.fa-file-text:before {
content: "\f15c";
}
.fa-sort-alpha-asc:before {
content: "\f15d";
}
.fa-sort-alpha-desc:before {
content: "\f15e";
}
.fa-sort-amount-asc:before {
content: "\f160";
}
.fa-sort-amount-desc:before {
content: "\f161";
}
.fa-sort-numeric-asc:before {
content: "\f162";
}
.fa-sort-numeric-desc:before {
content: "\f163";
}
.fa-thumbs-up:before {
content: "\f164";
}
.fa-thumbs-down:before {
content: "\f165";
}
.fa-youtube-square:before {
content: "\f166";
}
.fa-youtube:before {
content: "\f167";
}
.fa-xing:before {
content: "\f168";
}
.fa-xing-square:before {
content: "\f169";
}
.fa-youtube-play:before {
content: "\f16a";
}
.fa-dropbox:before {
content: "\f16b";
}
.fa-stack-overflow:before {
content: "\f16c";
}
.fa-instagram:before {
content: "\f16d";
}
.fa-flickr:before {
content: "\f16e";
}
.fa-adn:before {
content: "\f170";
}
.fa-bitbucket:before {
content: "\f171";
}
.fa-bitbucket-square:before {
content: "\f172";
}
.fa-tumblr:before {
content: "\f173";
}
.fa-tumblr-square:before {
content: "\f174";
}
.fa-long-arrow-down:before {
content: "\f175";
}
.fa-long-arrow-up:before {
content: "\f176";
}
.fa-long-arrow-left:before {
content: "\f177";
}
.fa-long-arrow-right:before {
content: "\f178";
}
.fa-apple:before {
content: "\f179";
}
.fa-windows:before {
content: "\f17a";
}
.fa-android:before {
content: "\f17b";
}
.fa-linux:before {
content: "\f17c";
}
.fa-dribbble:before {
content: "\f17d";
}
.fa-skype:before {
content: "\f17e";
}
.fa-foursquare:before {
content: "\f180";
}
.fa-trello:before {
content: "\f181";
}
.fa-female:before {
content: "\f182";
}
.fa-male:before {
content: "\f183";
}
.fa-gittip:before,
.fa-gratipay:before {
content: "\f184";
}
.fa-sun-o:before {
content: "\f185";
}
.fa-moon-o:before {
content: "\f186";
}
.fa-archive:before {
content: "\f187";
}
.fa-bug:before {
content: "\f188";
}
.fa-vk:before {
content: "\f189";
}
.fa-weibo:before {
content: "\f18a";
}
.fa-renren:before {
content: "\f18b";
}
.fa-pagelines:before {
content: "\f18c";
}
.fa-stack-exchange:before {
content: "\f18d";
}
.fa-arrow-circle-o-right:before {
content: "\f18e";
}
.fa-arrow-circle-o-left:before {
content: "\f190";
}
.fa-toggle-left:before,
.fa-caret-square-o-left:before {
content: "\f191";
}
.fa-dot-circle-o:before {
content: "\f192";
}
.fa-wheelchair:before {
content: "\f193";
}
.fa-vimeo-square:before {
content: "\f194";
}
.fa-turkish-lira:before,
.fa-try:before {
content: "\f195";
}
.fa-plus-square-o:before {
content: "\f196";
}
.fa-space-shuttle:before {
content: "\f197";
}
.fa-slack:before {
content: "\f198";
}
.fa-envelope-square:before {
content: "\f199";
}
.fa-wordpress:before {
content: "\f19a";
}
.fa-openid:before {
content: "\f19b";
}
.fa-institution:before,
.fa-bank:before,
.fa-university:before {
content: "\f19c";
}
.fa-mortar-board:before,
.fa-graduation-cap:before {
content: "\f19d";
}
.fa-yahoo:before {
content: "\f19e";
}
.fa-google:before {
content: "\f1a0";
}
.fa-reddit:before {
content: "\f1a1";
}
.fa-reddit-square:before {
content: "\f1a2";
}
.fa-stumbleupon-circle:before {
content: "\f1a3";
}
.fa-stumbleupon:before {
content: "\f1a4";
}
.fa-delicious:before {
content: "\f1a5";
}
.fa-digg:before {
content: "\f1a6";
}
.fa-pied-piper-pp:before {
content: "\f1a7";
}
.fa-pied-piper-alt:before {
content: "\f1a8";
}
.fa-drupal:before {
content: "\f1a9";
}
.fa-joomla:before {
content: "\f1aa";
}
.fa-language:before {
content: "\f1ab";
}
.fa-fax:before {
content: "\f1ac";
}
.fa-building:before {
content: "\f1ad";
}
.fa-child:before {
content: "\f1ae";
}
.fa-paw:before {
content: "\f1b0";
}
.fa-spoon:before {
content: "\f1b1";
}
.fa-cube:before {
content: "\f1b2";
}
.fa-cubes:before {
content: "\f1b3";
}
.fa-behance:before {
content: "\f1b4";
}
.fa-behance-square:before {
content: "\f1b5";
}
.fa-steam:before {
content: "\f1b6";
}
.fa-steam-square:before {
content: "\f1b7";
}
.fa-recycle:before {
content: "\f1b8";
}
.fa-automobile:before,
.fa-car:before {
content: "\f1b9";
}
.fa-cab:before,
.fa-taxi:before {
content: "\f1ba";
}
.fa-tree:before {
content: "\f1bb";
}
.fa-spotify:before {
content: "\f1bc";
}
.fa-deviantart:before {
content: "\f1bd";
}
.fa-soundcloud:before {
content: "\f1be";
}
.fa-database:before {
content: "\f1c0";
}
.fa-file-pdf-o:before {
content: "\f1c1";
}
.fa-file-word-o:before {
content: "\f1c2";
}
.fa-file-excel-o:before {
content: "\f1c3";
}
.fa-file-powerpoint-o:before {
content: "\f1c4";
}
.fa-file-photo-o:before,
.fa-file-picture-o:before,
.fa-file-image-o:before {
content: "\f1c5";
}
.fa-file-zip-o:before,
.fa-file-archive-o:before {
content: "\f1c6";
}
.fa-file-sound-o:before,
.fa-file-audio-o:before {
content: "\f1c7";
}
.fa-file-movie-o:before,
.fa-file-video-o:before {
content: "\f1c8";
}
.fa-file-code-o:before {
content: "\f1c9";
}
.fa-vine:before {
content: "\f1ca";
}
.fa-codepen:before {
content: "\f1cb";
}
.fa-jsfiddle:before {
content: "\f1cc";
}
.fa-life-bouy:before,
.fa-life-buoy:before,
.fa-life-saver:before,
.fa-support:before,
.fa-life-ring:before {
content: "\f1cd";
}
.fa-circle-o-notch:before {
content: "\f1ce";
}
.fa-ra:before,
.fa-resistance:before,
.fa-rebel:before {
content: "\f1d0";
}
.fa-ge:before,
.fa-empire:before {
content: "\f1d1";
}
.fa-git-square:before {
content: "\f1d2";
}
.fa-git:before {
content: "\f1d3";
}
.fa-y-combinator-square:before,
.fa-yc-square:before,
.fa-hacker-news:before {
content: "\f1d4";
}
.fa-tencent-weibo:before {
content: "\f1d5";
}
.fa-qq:before {
content: "\f1d6";
}
.fa-wechat:before,
.fa-weixin:before {
content: "\f1d7";
}
.fa-send:before,
.fa-paper-plane:before {
content: "\f1d8";
}
.fa-send-o:before,
.fa-paper-plane-o:before {
content: "\f1d9";
}
.fa-history:before {
content: "\f1da";
}
.fa-circle-thin:before {
content: "\f1db";
}
.fa-header:before {
content: "\f1dc";
}
.fa-paragraph:before {
content: "\f1dd";
}
.fa-sliders:before {
content: "\f1de";
}
.fa-share-alt:before {
content: "\f1e0";
}
.fa-share-alt-square:before {
content: "\f1e1";
}
.fa-bomb:before {
content: "\f1e2";
}
.fa-soccer-ball-o:before,
.fa-futbol-o:before {
content: "\f1e3";
}
.fa-tty:before {
content: "\f1e4";
}
.fa-binoculars:before {
content: "\f1e5";
}
.fa-plug:before {
content: "\f1e6";
}
.fa-slideshare:before {
content: "\f1e7";
}
.fa-twitch:before {
content: "\f1e8";
}
.fa-yelp:before {
content: "\f1e9";
}
.fa-newspaper-o:before {
content: "\f1ea";
}
.fa-wifi:before {
content: "\f1eb";
}
.fa-calculator:before {
content: "\f1ec";
}
.fa-paypal:before {
content: "\f1ed";
}
.fa-google-wallet:before {
content: "\f1ee";
}
.fa-cc-visa:before {
content: "\f1f0";
}
.fa-cc-mastercard:before {
content: "\f1f1";
}
.fa-cc-discover:before {
content: "\f1f2";
}
.fa-cc-amex:before {
content: "\f1f3";
}
.fa-cc-paypal:before {
content: "\f1f4";
}
.fa-cc-stripe:before {
content: "\f1f5";
}
.fa-bell-slash:before {
content: "\f1f6";
}
.fa-bell-slash-o:before {
content: "\f1f7";
}
.fa-trash:before {
content: "\f1f8";
}
.fa-copyright:before {
content: "\f1f9";
}
.fa-at:before {
content: "\f1fa";
}
.fa-eyedropper:before {
content: "\f1fb";
}
.fa-paint-brush:before {
content: "\f1fc";
}
.fa-birthday-cake:before {
content: "\f1fd";
}
.fa-area-chart:before {
content: "\f1fe";
}
.fa-pie-chart:before {
content: "\f200";
}
.fa-line-chart:before {
content: "\f201";
}
.fa-lastfm:before {
content: "\f202";
}
.fa-lastfm-square:before {
content: "\f203";
}
.fa-toggle-off:before {
content: "\f204";
}
.fa-toggle-on:before {
content: "\f205";
}
.fa-bicycle:before {
content: "\f206";
}
.fa-bus:before {
content: "\f207";
}
.fa-ioxhost:before {
content: "\f208";
}
.fa-angellist:before {
content: "\f209";
}
.fa-cc:before {
content: "\f20a";
}
.fa-shekel:before,
.fa-sheqel:before,
.fa-ils:before {
content: "\f20b";
}
.fa-meanpath:before {
content: "\f20c";
}
.fa-buysellads:before {
content: "\f20d";
}
.fa-connectdevelop:before {
content: "\f20e";
}
.fa-dashcube:before {
content: "\f210";
}
.fa-forumbee:before {
content: "\f211";
}
.fa-leanpub:before {
content: "\f212";
}
.fa-sellsy:before {
content: "\f213";
}
.fa-shirtsinbulk:before {
content: "\f214";
}
.fa-simplybuilt:before {
content: "\f215";
}
.fa-skyatlas:before {
content: "\f216";
}
.fa-cart-plus:before {
content: "\f217";
}
.fa-cart-arrow-down:before {
content: "\f218";
}
.fa-diamond:before {
content: "\f219";
}
.fa-ship:before {
content: "\f21a";
}
.fa-user-secret:before {
content: "\f21b";
}
.fa-motorcycle:before {
content: "\f21c";
}
.fa-street-view:before {
content: "\f21d";
}
.fa-heartbeat:before {
content: "\f21e";
}
.fa-venus:before {
content: "\f221";
}
.fa-mars:before {
content: "\f222";
}
.fa-mercury:before {
content: "\f223";
}
.fa-intersex:before,
.fa-transgender:before {
content: "\f224";
}
.fa-transgender-alt:before {
content: "\f225";
}
.fa-venus-double:before {
content: "\f226";
}
.fa-mars-double:before {
content: "\f227";
}
.fa-venus-mars:before {
content: "\f228";
}
.fa-mars-stroke:before {
content: "\f229";
}
.fa-mars-stroke-v:before {
content: "\f22a";
}
.fa-mars-stroke-h:before {
content: "\f22b";
}
.fa-neuter:before {
content: "\f22c";
}
.fa-genderless:before {
content: "\f22d";
}
.fa-facebook-official:before {
content: "\f230";
}
.fa-pinterest-p:before {
content: "\f231";
}
.fa-whatsapp:before {
content: "\f232";
}
.fa-server:before {
content: "\f233";
}
.fa-user-plus:before {
content: "\f234";
}
.fa-user-times:before {
content: "\f235";
}
.fa-hotel:before,
.fa-bed:before {
content: "\f236";
}
.fa-viacoin:before {
content: "\f237";
}
.fa-train:before {
content: "\f238";
}
.fa-subway:before {
content: "\f239";
}
.fa-medium:before {
content: "\f23a";
}
.fa-yc:before,
.fa-y-combinator:before {
content: "\f23b";
}
.fa-optin-monster:before {
content: "\f23c";
}
.fa-opencart:before {
content: "\f23d";
}
.fa-expeditedssl:before {
content: "\f23e";
}
.fa-battery-4:before,
.fa-battery:before,
.fa-battery-full:before {
content: "\f240";
}
.fa-battery-3:before,
.fa-battery-three-quarters:before {
content: "\f241";
}
.fa-battery-2:before,
.fa-battery-half:before {
content: "\f242";
}
.fa-battery-1:before,
.fa-battery-quarter:before {
content: "\f243";
}
.fa-battery-0:before,
.fa-battery-empty:before {
content: "\f244";
}
.fa-mouse-pointer:before {
content: "\f245";
}
.fa-i-cursor:before {
content: "\f246";
}
.fa-object-group:before {
content: "\f247";
}
.fa-object-ungroup:before {
content: "\f248";
}
.fa-sticky-note:before {
content: "\f249";
}
.fa-sticky-note-o:before {
content: "\f24a";
}
.fa-cc-jcb:before {
content: "\f24b";
}
.fa-cc-diners-club:before {
content: "\f24c";
}
.fa-clone:before {
content: "\f24d";
}
.fa-balance-scale:before {
content: "\f24e";
}
.fa-hourglass-o:before {
content: "\f250";
}
.fa-hourglass-1:before,
.fa-hourglass-start:before {
content: "\f251";
}
.fa-hourglass-2:before,
.fa-hourglass-half:before {
content: "\f252";
}
.fa-hourglass-3:before,
.fa-hourglass-end:before {
content: "\f253";
}
.fa-hourglass:before {
content: "\f254";
}
.fa-hand-grab-o:before,
.fa-hand-rock-o:before {
content: "\f255";
}
.fa-hand-stop-o:before,
.fa-hand-paper-o:before {
content: "\f256";
}
.fa-hand-scissors-o:before {
content: "\f257";
}
.fa-hand-lizard-o:before {
content: "\f258";
}
.fa-hand-spock-o:before {
content: "\f259";
}
.fa-hand-pointer-o:before {
content: "\f25a";
}
.fa-hand-peace-o:before {
content: "\f25b";
}
.fa-trademark:before {
content: "\f25c";
}
.fa-registered:before {
content: "\f25d";
}
.fa-creative-commons:before {
content: "\f25e";
}
.fa-gg:before {
content: "\f260";
}
.fa-gg-circle:before {
content: "\f261";
}
.fa-tripadvisor:before {
content: "\f262";
}
.fa-odnoklassniki:before {
content: "\f263";
}
.fa-odnoklassniki-square:before {
content: "\f264";
}
.fa-get-pocket:before {
content: "\f265";
}
.fa-wikipedia-w:before {
content: "\f266";
}
.fa-safari:before {
content: "\f267";
}
.fa-chrome:before {
content: "\f268";
}
.fa-firefox:before {
content: "\f269";
}
.fa-opera:before {
content: "\f26a";
}
.fa-internet-explorer:before {
content: "\f26b";
}
.fa-tv:before,
.fa-television:before {
content: "\f26c";
}
.fa-contao:before {
content: "\f26d";
}
.fa-500px:before {
content: "\f26e";
}
.fa-amazon:before {
content: "\f270";
}
.fa-calendar-plus-o:before {
content: "\f271";
}
.fa-calendar-minus-o:before {
content: "\f272";
}
.fa-calendar-times-o:before {
content: "\f273";
}
.fa-calendar-check-o:before {
content: "\f274";
}
.fa-industry:before {
content: "\f275";
}
.fa-map-pin:before {
content: "\f276";
}
.fa-map-signs:before {
content: "\f277";
}
.fa-map-o:before {
content: "\f278";
}
.fa-map:before {
content: "\f279";
}
.fa-commenting:before {
content: "\f27a";
}
.fa-commenting-o:before {
content: "\f27b";
}
.fa-houzz:before {
content: "\f27c";
}
.fa-vimeo:before {
content: "\f27d";
}
.fa-black-tie:before {
content: "\f27e";
}
.fa-fonticons:before {
content: "\f280";
}
.fa-reddit-alien:before {
content: "\f281";
}
.fa-edge:before {
content: "\f282";
}
.fa-credit-card-alt:before {
content: "\f283";
}
.fa-codiepie:before {
content: "\f284";
}
.fa-modx:before {
content: "\f285";
}
.fa-fort-awesome:before {
content: "\f286";
}
.fa-usb:before {
content: "\f287";
}
.fa-product-hunt:before {
content: "\f288";
}
.fa-mixcloud:before {
content: "\f289";
}
.fa-scribd:before {
content: "\f28a";
}
.fa-pause-circle:before {
content: "\f28b";
}
.fa-pause-circle-o:before {
content: "\f28c";
}
.fa-stop-circle:before {
content: "\f28d";
}
.fa-stop-circle-o:before {
content: "\f28e";
}
.fa-shopping-bag:before {
content: "\f290";
}
.fa-shopping-basket:before {
content: "\f291";
}
.fa-hashtag:before {
content: "\f292";
}
.fa-bluetooth:before {
content: "\f293";
}
.fa-bluetooth-b:before {
content: "\f294";
}
.fa-percent:before {
content: "\f295";
}
.fa-gitlab:before {
content: "\f296";
}
.fa-wpbeginner:before {
content: "\f297";
}
.fa-wpforms:before {
content: "\f298";
}
.fa-envira:before {
content: "\f299";
}
.fa-universal-access:before {
content: "\f29a";
}
.fa-wheelchair-alt:before {
content: "\f29b";
}
.fa-question-circle-o:before {
content: "\f29c";
}
.fa-blind:before {
content: "\f29d";
}
.fa-audio-description:before {
content: "\f29e";
}
.fa-volume-control-phone:before {
content: "\f2a0";
}
.fa-braille:before {
content: "\f2a1";
}
.fa-assistive-listening-systems:before {
content: "\f2a2";
}
.fa-asl-interpreting:before,
.fa-american-sign-language-interpreting:before {
content: "\f2a3";
}
.fa-deafness:before,
.fa-hard-of-hearing:before,
.fa-deaf:before {
content: "\f2a4";
}
.fa-glide:before {
content: "\f2a5";
}
.fa-glide-g:before {
content: "\f2a6";
}
.fa-signing:before,
.fa-sign-language:before {
content: "\f2a7";
}
.fa-low-vision:before {
content: "\f2a8";
}
.fa-viadeo:before {
content: "\f2a9";
}
.fa-viadeo-square:before {
content: "\f2aa";
}
.fa-snapchat:before {
content: "\f2ab";
}
.fa-snapchat-ghost:before {
content: "\f2ac";
}
.fa-snapchat-square:before {
content: "\f2ad";
}
.fa-pied-piper:before {
content: "\f2ae";
}
.fa-first-order:before {
content: "\f2b0";
}
.fa-yoast:before {
content: "\f2b1";
}
.fa-themeisle:before {
content: "\f2b2";
}
.fa-google-plus-circle:before,
.fa-google-plus-official:before {
content: "\f2b3";
}
.fa-fa:before,
.fa-font-awesome:before {
content: "\f2b4";
}
.fa-handshake-o:before {
content: "\f2b5";
}
.fa-envelope-open:before {
content: "\f2b6";
}
.fa-envelope-open-o:before {
content: "\f2b7";
}
.fa-linode:before {
content: "\f2b8";
}
.fa-address-book:before {
content: "\f2b9";
}
.fa-address-book-o:before {
content: "\f2ba";
}
.fa-vcard:before,
.fa-address-card:before {
content: "\f2bb";
}
.fa-vcard-o:before,
.fa-address-card-o:before {
content: "\f2bc";
}
.fa-user-circle:before {
content: "\f2bd";
}
.fa-user-circle-o:before {
content: "\f2be";
}
.fa-user-o:before {
content: "\f2c0";
}
.fa-id-badge:before {
content: "\f2c1";
}
.fa-drivers-license:before,
.fa-id-card:before {
content: "\f2c2";
}
.fa-drivers-license-o:before,
.fa-id-card-o:before {
content: "\f2c3";
}
.fa-quora:before {
content: "\f2c4";
}
.fa-free-code-camp:before {
content: "\f2c5";
}
.fa-telegram:before {
content: "\f2c6";
}
.fa-thermometer-4:before,
.fa-thermometer:before,
.fa-thermometer-full:before {
content: "\f2c7";
}
.fa-thermometer-3:before,
.fa-thermometer-three-quarters:before {
content: "\f2c8";
}
.fa-thermometer-2:before,
.fa-thermometer-half:before {
content: "\f2c9";
}
.fa-thermometer-1:before,
.fa-thermometer-quarter:before {
content: "\f2ca";
}
.fa-thermometer-0:before,
.fa-thermometer-empty:before {
content: "\f2cb";
}
.fa-shower:before {
content: "\f2cc";
}
.fa-bathtub:before,
.fa-s15:before,
.fa-bath:before {
content: "\f2cd";
}
.fa-podcast:before {
content: "\f2ce";
}
.fa-window-maximize:before {
content: "\f2d0";
}
.fa-window-minimize:before {
content: "\f2d1";
}
.fa-window-restore:before {
content: "\f2d2";
}
.fa-times-rectangle:before,
.fa-window-close:before {
content: "\f2d3";
}
.fa-times-rectangle-o:before,
.fa-window-close-o:before {
content: "\f2d4";
}
.fa-bandcamp:before {
content: "\f2d5";
}
.fa-grav:before {
content: "\f2d6";
}
.fa-etsy:before {
content: "\f2d7";
}
.fa-imdb:before {
content: "\f2d8";
}
.fa-ravelry:before {
content: "\f2d9";
}
.fa-eercast:before {
content: "\f2da";
}
.fa-microchip:before {
content: "\f2db";
}
.fa-snowflake-o:before {
content: "\f2dc";
}
.fa-superpowers:before {
content: "\f2dd";
}
.fa-wpexplorer:before {
content: "\f2de";
}
.fa-meetup:before {
content: "\f2e0";
}
.sr-only {
position: absolute;
width: 1px;
height: 1px;
padding: 0;
margin: -1px;
overflow: hidden;
clip: rect(0, 0, 0, 0);
border: 0;
}
.sr-only-focusable:active,
.sr-only-focusable:focus {
position: static;
width: auto;
height: auto;
margin: 0;
overflow: visible;
clip: auto;
}
================================================
FILE: assets/scss/admin/_course-builder.scss
================================================
body.admin_page_llms-course-builder {
background: #fff;
#adminmenumain { display: none; }
#wpbody-content { padding-bottom: 0; }
#wpfooter { display: none; }
#wpcontent, #wpfooter {
margin-left: 0;
}
.llms-button-secondary {
.fa {
margin-right: 5px;
}
}
// &.folded {
// .llms-course-builder {
// left: 56px;
// }
// }
.webui-popover {
.select2-container--default {
.select2-results__group {
font-size: 16px;
}
.select2-results__option .select2-results__option {
padding-left: 2em;
}
}
}
}
.wrap.lifterlms.llms-builder {
margin: 0;
padding: 0;
position: relative;
&.editor-active {
.llms-video-explainer {
display: none;
}
.llms-builder-sidebar {
padding: 10px;
width: calc( 100% - 200px );
z-index: 3;
}
@media only screen and ( min-width: 1200px ) {
.llms-builder-main {
width: 560px;
}
.llms-builder-sidebar {
width: calc( 100% - 640px );
}
}
@media only screen and ( min-width: 1440px ) {
.llms-builder-main {
width: calc( 100% - 780px );
}
.llms-builder-sidebar {
width: 720px;
}
}
@media only screen and ( min-width: 1680px ) {
.llms-builder-main {
width: calc( 100% - 1000px );
}
.llms-builder-sidebar {
width: 940px;
}
}
@media only screen and ( max-width: 782px ) {
.llms-builder-sidebar {
position: absolute;
top: 0;
width: auto;
}
}
}
.llms-headline {
display: inline-block;
font-weight: 400;
margin: 0;
padding: 0;
transition: width 0.3s ease-in-out;
vertical-align: middle;
}
.llms-builder-main {
padding: 30px 30px 30px 0;
position: relative;
width: calc( 100% - 450px );
z-index: 2;
.llms-action-icons {
display: inline-block;
position: relative;
vertical-align: middle;
button {
background: none;
color: inherit;
border: none;
padding: 0;
cursor: pointer;
outline: inherit;
}
}
.llms-action-icons-lesson-id {
vertical-align: top;
}
// Course
.llms-course-header {
align-items: center;
display: flex;
flex-wrap: wrap;
gap: 15px;
position: relative;
z-index: 1;
.llms-button-secondary {
margin-right: 10px;
}
}
// Sections
ul.llms-sections {
box-shadow: 0 0 0 3px transparent;
min-height: 60px;
padding: 10px 0;
transition: box-shadow 0.6s ease, min-height 0.2s ease;
&.dragging {
box-shadow: 0 0 0 3px $color-brand-blue;
}
}
li.llms-section {
background: #fff;
border: 1px solid #efefef;
border-radius: 6px;
box-shadow: 2px 2px 8px rgba( 0, 0, 0, 0.08 );
position: relative;
margin: 0 0 20px 0;
padding: 0;
> .llms-builder-header {
align-items: center;
display: flex;
gap: 15px;
justify-content: space-between;
padding: 20px 10px 20px 30px;
.llms-action-icons {
align-items: center;
display: flex;
gap: 15px;
justify-content: space-between;
.llms-action-icons-right {
display: flex;
gap: 0px;
margin-top: -5px;
.llms-action-icon {
padding: 5px 10px;
}
}
.llms-action-icons-left {
display: flex;
gap: 15px;
}
@media only screen and ( min-width: 1200px ) {
.llms-action-icons-right,
.llms-action-icons-left {
white-space: nowrap;
}
}
}
}
&.expanded {
.llms-lessons { overflow: visible; }
}
&.selected {
border-left: 3px solid $color-brand-blue;
box-shadow: 2px 2px 8px rgba( 0, 0, 0, 0.12 );
margin-left: -2px;
.llms-drag-utility.drag-section {
border-color: $color-brand-blue;
}
> .llms-builder-header .llms-headline {
font-weight: 400;
color: $color-brand-blue;
}
}
> .llms-builder-footer {
border-top: 1px solid #efefef;
padding: 20px 20px 20px 30px;
}
}
li.llms-section:first-child:before {
top: 30px;
}
li.llms-section:last-child:before {
bottom: 55px;
}
li.llms-section.expanded:last-child:before {
bottom: 86px;
}
// Lessons
ul.llms-lessons {
box-shadow: 0 0 0 3px transparent;
height: 0;
margin: 0;
padding: 0;
transition: box-shadow 0.6s ease, min-height 0.2s ease;
&.dragging {
box-shadow: 0 0 0 3px $color-brand-blue;
min-height: 60px;
}
&.expanded, // added via backbone view events
&.drag-expanded { // added only during dragover events and ignores model attrs
height: auto;
li.llms-lesson {
pointer-events: auto;
visibility: visible;
}
}
}
li.llms-lesson {
background: #fff;
border-top: 1px solid #efefef;
margin: 0;
padding: 20px 10px 20px 30px;
position: relative;
pointer-events: none;
visibility: hidden;
&.selected {
.llms-drag-utility.drag-lesson {
border-color: $color-brand-blue;
}
> .llms-builder-header .llms-headline {
color: $color-brand-blue;
}
}
> .llms-builder-header {
.llms-headline {
font-weight: 700;
margin-left: 10px;
cursor: pointer;
}
align-items: center;
display: flex;
flex-wrap: wrap;
gap: 15px;
justify-content: space-between;
.llms-action-icons {
align-items: center;
display: flex;
flex: 1;
gap: 15px;
justify-content: space-between;
.llms-action-icons-left {
display: flex;
gap: 15px;
}
.llms-action-icons-right {
display: flex;
gap: 0;
margin-top: -5px;
.llms-action-icon {
padding: 5px 10px;
}
}
@media only screen and ( min-width: 1200px ) {
.llms-action-icons-right,
.llms-action-icons-left {
white-space: nowrap;
}
}
}
@media only screen and ( min-width: 1200px ) {
> .llms-builder-header {
flex-wrap: nowrap;
}
}
}
}
// Drag Utilities
li.llms-section .llms-drag-utility {
background: #fff;
border: 2px solid #ccc;
border-radius: 50%;
height: 10px;
left: 13px;
position: absolute;
top: 24px;
width: 10px;
}
li.llms-lesson .llms-drag-utility {
height: 6px;
left: 14px;
top: 25px !important;
width: 6px;
}
.llms-section:hover > .llms-drag-utility,
.llms-lesson:hover > .llms-drag-utility {
border-color: #fff;
cursor: move;
&:hover:after {
color: $color-brand-blue;
}
&:after {
background: #fff;
content: '\00b7\00b7\A\00b7\00b7\A\00b7\00b7';
color: #ccc;
display: block;
font-size: 36px;
height: 29px;
letter-spacing: -1px;
line-height: 8px;
left: -7px;
position: absolute;
text-align: center;
top: -12px;
width: 23px;
}
}
// Sortable
li.llms-section,
li.llms-lesson {
&.ui-sortable-helper,
&.ui-draggable-dragging {
border: 1px solid #ccc;
background: #fff;
transform: rotate( 2deg );
visibility: visible !important;
z-index: 999;
}
&.llms-sortable-placeholder {
border: 3px dashed $color-brand-blue;
background: rgba( $color-brand-blue, 0.3 );
margin: 0 10px;
padding: 5px;
&:before { display: none; }
}
}
ul.llms-sections > li.llms-lesson.ui-draggable-dragging .llms-drag-utility {
position: relative;
&:after {
left: -35px;
top: -28px;
}
}
}
// Editable
.llms-input-wrapper {
position: relative;
}
.llms-input-formatting.ql-container {
font-size: inherit;
font-family: inherit;
.ql-editor.ql-blank::before {
color: #a0a0a0;
left: 8px;
right: 8px;
}
.ql-editor {
p {
font-size: inherit;
line-height: 1;
}
}
.ql-tooltip {
z-index: 1;
}
}
.llms-input,
.llms-input-formatting .ql-editor {
border: none;
border-bottom: 2px dotted transparent;
box-shadow: none;
cursor: text;
display: inline-block;
font-size: inherit;
font-weight: 700;
height: auto;
line-height: 1;
margin: 0 8px;
min-width: 60px;
padding: 0;
transition: border 0.2s ease, box-shadow 0.2s ease;
&:empty:before {
color: #a0a0a0;
content: attr( data-placeholder );
}
&:hover {
border-bottom-color: $color-brand-blue;
}
&[disabled] {
cursor: not-allowed;
&:hover {
border-bottom-color: transparent;
}
}
&:focus {
background: #fff;
box-shadow: 0 0 0 4px #fff, 0 0 0 6px $color-brand-blue;
border-bottom: none;
outline: none;
}
b, strong {
font-weight: 700;
}
&.standard {
border: 1px solid #e6e6e6;
margin: 2px;
padding: 5px 3px;
&:hover {
border-color: #d6d6d6;
}
&:focus {
box-shadow: 0 0 0 2px $color-brand-blue;
}
}
&.permalink {
display: none;
}
}
.llms-input-formatting .ql-editor {
padding: 0 1px;
}
.llms-label {
font-weight: 500;
.fa {
color: #aaa;
padding-left: 6px;
}
}
// .llms-editable-image,
// .llms-editable-video,
// .llms-editable-editor {
// }
.llms-editable-editor {
.llms-label {
float: left;
margin-right: 10px;
position: relative;
top: 10px;
}
textarea {
border: none;
padding: 10px;
display: block;
width: 100%;
}
}
.llms-editable-image {
button.llms-add-image {
width: 130px;
}
.llms-image {
display: inline-block;
position: relative;
&:hover .llms-action-icon {
opacity: 1;
}
.llms-action-icon {
color: #fff;
font-size: 24px;
opacity: 0;
padding: 0;
position: absolute;
transition: opacity 0.2s ease;
right: 3px;
top: 1px;
z-index: 1;
}
img {
display: block;
height: 100px;
max-width: 100%;
width: auto;
}
}
}
.llms-settings-field,
.llms-editable-toggle-group {
background: #f4f4f4;
padding: 10px;
position: relative;
margin: 0 1px;
&.has-label-after {
align-items: center;
display: flex;
flex-wrap: wrap;
.llms-label {
min-width: 100%;
}
.llms-editable-input {
flex: 2;
}
.llms-label--after {
color: #888;
min-width: auto;
font-size: 85%;
padding-left: 10px;
}
}
.llms-switch {
display: block;
width: 100%;
@include clearfix;
.llms-label {
width: calc( 100% - 34px );
}
}
.llms-editable-image,
.llms-editable-video,
.llms-editable-editor {
margin-top: 2px;
}
.llms-input.standard {
display: block;
width: 100%;
&.two-digits,
&.three-digits,
&.four-digits {
display: inline-block;
}
}
}
.llms-editable-number {
.llms-input {
color: #888;
min-width: 30px;
text-align: right;
&.two-digits {
width: 30px;
}
&.three-digits {
width: 40px;
}
&.four-digits {
width: 60px;
}
}
small {
color: #888;
text-transform: uppercase;
}
}
.llms-model-settings {
background-color: #FFF;
-webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.13);
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.13);
@include clearfix();
.llms-settings-group-header {
border-bottom: 1px solid #efefef;
padding: 10px;
.fa-caret-up { display: block; }
.fa-caret-down { display: none; }
}
&.hidden {
.llms-settings-group-header {
.fa-caret-up { display: none; }
.fa-caret-down { display: block; }
}
.llms-settings-group-body { display: none; }
}
}
.llms-settings-group-header {
@include clearfix();
.llms-settings-group-title {
display: inline-block;
font-size: 16px;
font-weight: 700;
line-height: 1.5;
margin: 0 5px;
padding: 0;
}
.llms-settings-group-toggle {
float: right;
font-size: 18px;
padding: 2px;
}
}
.llms-settings-group-body {
padding: 16px;
}
.llms-settings-row {
display: flex;
flex-wrap: wrap;
margin: 2px 0;
.llms-settings-field,
.llms-editable-toggle-group {
flex: 1;
&:first-child {
margin-left: 0;
}
&:last-child {
margin-right: 0;
}
}
.llms-breaker {
margin: 2px 0;
width: 100%;
}
}
.llms-editable-select {
margin: 2px 0;
.select2-container--default.select2-container--focus .select2-selection--multiple {
border-color: #aaa;
}
}
.llms-editable-radio {
label {
display: block;
}
&.has-images {
input { display: none; }
label {
display: inline-block;
margin: 0 3px;
}
label > span {
transition: background 0.2s ease;
display: inline-block;
padding: 3px;
}
img { display: block; }
input:checked + span {
background: $color-brand-blue;
}
}
}
.settings-field--disabled {
opacity: 0.5;
}
// Icons
.llms-action-icon {
color: #666;
display: inline-block;
font-size: 13px;
text-decoration: none;
&:hover {
color: $color-brand-blue;
&.danger { color: $color-danger; }
}
&.circle {
border: 2px solid #aaa;
border-radius: 50%;
font-size: 9px;
height: 8px;
line-height: 1;
padding: 5px;
text-align: center;
width: 8px;
&:hover {
border-color: $color-brand-blue;
&.danger {
border-color: $color-danger;
}
}
}
}
ul.llms-info-list {
display: flex;
flex-wrap: wrap;
gap: 15px;
margin: 10px 0 0 8px;
padding: 0;
li.llms-info-item {
color: #666;
font-size: 13px;
margin: 0;
&.active,
&.active .llms-action-icon {
color: $color-brand-blue;
.fa {
margin-right: 5px;
}
}
button {
background: none;
color: inherit;
border: none;
padding: 0;
cursor: pointer;
outline: inherit;
&:hover {
text-decoration: underline;
}
}
}
}
// Sidebar
.llms-builder-sidebar {
background: #e6e6e6;
bottom: 0;
overflow: hidden;
padding: 30px;
position: fixed;
transition: width 0.3s ease-in-out;
top: 32px;
right: 0;
width: 360px;
z-index: 1;
.llms-utilities {
ul, li {
margin: 0;
padding: 0;
}
ul {
display: flex;
gap: 15px;
li {
flex: 1;
&:last-child {
margin-right: 0;
}
}
}
.llms-utility {
background: #efefef;
border: 1px solid #ccc;
border-radius: 8px;
color: inherit;
cursor: pointer;
display: block;
overflow: hidden;
padding: 6px 12px;
position: relative;
text-align: center;
width: 100%;
&:hover {
background: #fefefe;
}
.fa {
background: #848484;
position: absolute;
left: 0;
top: 0;
padding: 7px;
color: #fff;
}
}
}
.llms-sidebar-headline {
margin: 0 0 10px;
font-size: 22px;
}
.llms-elements-list {
margin-bottom: 30px;
li {
margin-bottom: 10px;
}
}
.llms-utility {
color: #444;
text-decoration: none;
}
.llms-element-button {
background: $color-brand-blue;
border-radius: 8px;
border: none;
color: #fff;
cursor: pointer;
display: block;
margin: 0;
overflow: hidden;
padding: 17px 20px;
position: relative;
transition: background 0.2s ease, color 0.2s ease;
text-align: center;
width: 100%;
&:hover {
background: $color-brand-blue-dark;
}
&.secondary {
background: #efefef;
color: #444;
&:hover {
background: #fefefe;
}
.fa {
background: #848484;
}
}
.fa {
background: $color-brand-dark-blue;
border-radius: 4px 0 0 4px;
color: #fff;
display: block;
font-size: 20px;
padding: 15px 20px;
position: absolute;
top: 0;
left: 0;
}
&[disabled="disabled"] {
opacity: 0.4;
}
&.small {
padding: 8px 10px 8px 46px;
.fa {
font-size: 15px;
padding: 9px 10px;
width: 20px;
}
}
&.right {
&.small {
padding-left: 10px;
padding-right: 46px;
}
.fa {
border-radius: 0 4px 4px 0;
left: auto;
right: 0;
}
}
}
.llms-editor {
height: 100%;
min-height: 100%;
position: relative;
}
// .llms-builder-close-editor {
// background: $color-brand-blue;
// border: none;
// border-radius: 50%;
// color: #fff;
// cursor: pointer;
// display: inline-block;
// font-size: 18px;
// height: 30px;
// margin: 0;
// position: absolute;
// right: 0;
// text-align: center;
// top: 3px;
// width: 30px;
// z-index: 3;
// }
.llms-editor-nav {
background-color: $color-brand-dark-blue;
margin: 0;
padding: 8px 0 0 8px;
font-size: 0;
margin: -10px -10px 10px -10px;
position: relative;
z-index: 2;
.llms-editor-menu {
list-style-type: none;
margin: 0;
padding: 0;
position: relative;
.llms-editor-menu-item {
display: inline-block;
margin: 0 6px 0 0;
padding: 0;
> .llms-editor-menu {
display: none;
&:before {
border: 8px solid transparent;
border-left-color: #cacaca;
content: '';
position: absolute;
top: 11px;
left: 0;
}
.llms-editor-menu-item:hover > a,
.llms-editor-menu-item.active > a {
background: #dfdfdf;
}
}
&:hover > a {
background-color: $color-brand-blue;
}
&.active > a {
background-color: #e6e6e6;
color: $color-brand-blue;
font-weight: 700;
&:focus {
box-shadow: none;
}
}
&.active > .llms-editor-menu {
display: inline-block;
}
a {
border-top-left-radius: 4px;
border-top-right-radius: 4px;
color: #FFF;
display: inline-block;
padding: 9px 18px;
text-decoration: none;
transition: background 0.2s ease;
font-size: 15px;
}
&.right {
float: right;
a,
&:hover {
background: transparent;
}
}
}
}
}
.llms-editor-tab {
display: none;
height: calc( 100% - 90px );
overflow: scroll;
position: relative;
z-index: 1;
&.active {
display: block;
&.tab--quiz {
display: flex;
flex-direction: column;
.llms-quiz-questions {
flex: 1 0 auto;
overflow: scroll;
// groups
.llms-quiz-questions {
overflow: visible;
}
}
}
}
}
// .llms-builder-editor {
// opacity: 0;
// margin: 10px 0;
// transition: opacity 0.2s linear;
// &.ready {
// opacity: 1;
// }
// textarea {
// border: none;
// display: block;
// width: 100%;
// }
// }
.llms-builder-save {
bottom: 10px;
left: 10px;
position: absolute;
right: 10px;
z-index: 1;
.llms-builder-error {
background: $color-danger;
border-radius: 4px;
color: #fff;
display: inline-block;
font-style: italic;
padding: 5px 15px 7px 25px;
margin: 0 0 10px;
li {
margin: 0;
padding: 0;
}
}
.llms-save {
width: 75%;
}
.llms-exit {
padding-left: 5px;
padding-right: 5px;
width: 23%;
}
button {
position: relative;
i {
position: absolute;
left: 10px;
top: 10px;
.llms-spinner {
border-color: #fff;
}
}
}
button[data-status] .llms-status-indicator { display: none; }
button[data-status="saved"] .status--saved { display: block; }
button[data-status="unsaved"] {
background-color: $color-brand-orange;
.status--unsaved { display: block; }
}
button[data-status="saving"] .status--saving { display: block; }
button[data-status="error"] .status--error { display: block; }
}
}
@media only screen and ( max-width: 782px ) {
.llms-builder-sidebar {
margin-right: 10px;
position: relative;
top: 0;
width: auto;
}
.llms-builder-main {
padding-right: 10px;
width: auto;
}
}
// Search Popover
.select2-container {
z-index: 99999999;
}
.select2-results__option {
padding: 0;
}
.select2-container--default .select2-results__option--highlighted[aria-selected] {
background: $color-brand-blue;
.llms-existing-action {
color: #fff;
}
}
.llms-existing-lesson-result {
align-items: center;
display: flex;
padding: 5px 5px 5px 0;
.llms-existing-info {
flex: 6;
h4, h5 {
margin: 0;
}
h4 {
font-weight: 400;
}
h5 {
font-weight: 300;
}
}
.llms-existing-action {
color: $color-brand-blue;
flex: 1;
text-align: center;
.fa {
display: block;
font-size: 30px;
}
small {
text-transform: uppercase;
}
}
}
// Quiz
.llms-quiz-empty {
margin: 100px auto;
text-align: center;
p { font-size: 18px; }
button.llms-element-button {
max-width: 320px;
margin: 0 auto;
}
}
.llms-editor-tab.tab--quiz {
.llms-model-header {
.llms-model-title {
width: calc( 100% - 310px );
}
.llms-quiz-points {
float: left;
margin-right: 10px;
width: 100px;
}
}
}
.llms-model-header {
background-color: #FFF;
-webkit-box-shadow: 0 1px 3px rgba(0, 0, 0, 0.13);
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.13);
padding: 10px;
@include clearfix();
.llms-model-title {
float: left;
margin-right: 10px;
width: calc( 100% - 200px );
.llms-input {
width: calc( 100% - 65px );
}
}
.llms-model-status.llms-switch {
float: left;
margin-right: 10px;
position: relative;
text-align: right;
top: -2px;
width: 100px;
}
.llms-action-icons {
float: left;
position: relative;
text-align: right;
width: 80px;
z-index: 1;
.llms-action-icon {
margin-left: 10px;
}
.fa {
max-width: 15px;
}
}
}
.llms-model-header + .llms-model-settings.active {
margin-top: -10px;
}
.llms-model-settings {
clear: both;
display: none;
&.active {
display: block;
margin-top: 10px;
}
}
.llms-quiz-footer {
display: flex;
button.llms-element-button {
flex: 1;
margin: 0 5px;
&:first-child { margin-left: 0; }
&:last-child { margin-right: 0; }
&.llms-show-question-bank {
flex: 2;
}
}
}
// Question Bank
.llms-quiz-tools {
display: none;
width: 100%;
position: relative;
// .llms-quiz-tools-search {
// padding: 0 10px;
// margin-bottom: 15px;
// .fa {
// color: #888;
// font-size: 16px;
// }
// input[type="search"] {
// background: inherit;
// border: none;
// border-bottom: 1px solid #bbb;
// box-shadow: none;
// font-size: 16px;
// margin: 8px 0 0;
// padding: 2px 5px;
// width: calc( 100% - 200px );
// &:focus {
// border-bottom-color: $color-brand-blue;
// }
// }
// }
}
ul.llms-question-bank {
list-style-type: none;
margin: 0;
padding: 0;
@include clearfix;
li.llms-question-bank-header {
clear: both;
padding-top: 20px;
&:first-child {
padding-top: 0;
}
h4 {
font-size: 20px;
margin: 10px 5px;
}
}
li.llms-question-type {
box-sizing: border-box;
float: left;
margin: 0;
padding: 3px;
width: 33.3333%;
transition: opacity 0.3s ease-in-out;
&.filtered {
opacity: 0.3;
}
.llms-type-unavailable {
display: block;
position: relative;
text-decoration: none;
.llms-element-button {
opacity: 0.5;
pointer-events: none;
}
}
}
}
// Quiz Questions
ul.llms-quiz-questions {
margin: 10px 3px;
padding: 5px;
transition: box-shadow 0.6s ease;
&.dragging {
box-shadow: 0 0 0 3px $color-brand-blue;
}
&:empty:before {
background: #fff;
content: attr(data-empty-msg);
display: block;
font-size: 18px;
margin: 0 auto;
padding: 100px 0;
text-align: center;
}
li.llms-question {
background: #fff;
margin: 0 0 3px;
padding: 15px 12px 10px;
&:hover {
> .llms-builder-header .llms-action-icons {
opacity: 1;
pointer-events: auto;
}
}
// groups
ul.llms-quiz-questions {
margin-left: 12px;
.llms-question {
border-bottom: 2px solid #e6e6e6;
}
&:empty:before {
content: attr(data-empty-msg);
display: block;
font-size: 18px;
text-align: center;
margin: 20px auto;
}
li.llms-question.llms-sortable-placeholder.qtype--group {
display: none !important;
}
}
.llms-builder-header {
@include clearfix;
> * {
float: left;
}
}
.llms-question-body {
display: none;
&.active {
display: block;
}
}
.llms-data-stamp {
background: $color-brand-blue;
border-radius: 4px;
color: #fff;
cursor: move;
font-size: 90%;
margin-top: -5px;
padding: 4px 10px 6px;
small, .fa {
line-height: 1.2;
vertical-align: middle;
}
.fa {
margin-right: 4px;
}
}
.llms-headline {
width: calc( 100% - 110px - 90px - 55px );
.ql-editor {
width: calc( 100% - 16px );
}
}
.llms-action-icons {
width: 110px;
opacity: 0;
pointer-events: none;
}
.llms-question-points {
width: 90px;
}
.llms-question-features {
margin: 10px 0 0;
&:last-child {
margin: 0;
}
.llms-switch {
margin-right: 15px;
}
}
.llms-editable-video {
position: relative;
z-index: 1;
}
}
.llms-question-choices-wrapper {
background: #f4f4f4;
margin: 2px 1px;
padding: 10px;
}
.llms-question-choices-list-header {
@include clearfix;
margin-bottom: 10px;
.llms-switch {
float: right;
text-align: right;
width: 260px;
}
}
ul.llms-question-choices {
border: 3px solid #f4f4f4;
margin: -3px;
padding: 0;
transition: box-shadow 0.6s ease;
&.dragging {
box-shadow: 0 0 0 3px $color-brand-blue;
}
&.multi-choices li.llms-question-choice .llms-choice-id span {
border-radius: 4px;
}
}
li.llms-question-choice {
margin: 0 0 5px;
padding: 0;
&:last-child { margin-bottom: 0; }
.llms-choice-id {
input[type="checkbox"] {
display: none;
}
input[type="checkbox"]:checked + .llms-marker {
background: $color-green;
}
.llms-marker {
border-radius: 50%;
background: #d0d0d0;
box-shadow: inset 0 0 1px #848484;
color: #444;
display: inline-block;
font-size: 16px;
height: 20px;
line-height: 20px;
padding: 5px;
position: relative;
text-align: center;
transition: background 0.1s ease;
width: 20px;
.fa {
left: 7px;
opacity: 0;
position: absolute;
top: 7px;
}
&.selectable:hover {
b { opacity: 0 }
.fa { opacity: 1; }
}
}
}
.llms-input-wrapper,
.llms-editable-image {
display: inline-block;
// action icons width, label width, ul margins
width: calc( 100% - 55px - 35px - 5px );
}
.llms-input {
width: calc( 100% - 16px );
}
.llms-editable-image .llms-image {
vertical-align: middle;
img {
height: 50px;
}
}
.llms-action-icons {
display: inline-block;
opacity: 1;
pointer-events: auto;
text-align: right;
width: 55px;
}
}
li.llms-question-choice.llms-sortable-placeholder {
border: 3px dashed $color-brand-blue !important;
background: rgba( $color-brand-blue, 0.3 );
}
li.llms-question-choice.ui-sortable-helper {
border: 1px solid #ccc;
background: #fff;
padding: 10px;
transform: rotate( 2deg );
z-index: 999;
}
li.llms-question.ui-sortable-helper,
li.llms-question.ui-draggable-dragging {
border: 1px solid #ccc;
background: #fff;
transform: rotate( 2deg );
z-index: 999;
}
li.llms-question.llms-sortable-placeholder {
border: 3px dashed $color-brand-blue !important;
background: rgba( $color-brand-blue, 0.3 );
}
}
.llms-switch {
display: inline-block;
float: none;
width: auto;
input[type="checkbox"] {
display: none;
}
input[type="checkbox"]:checked + .llms-switch-slider {
background: $color-green;
}
input[type="checkbox"]:checked + .llms-switch-slider:after {
transform: translateX( 14px );
}
.llms-label {
display: inline-block;
vertical-align: top;
}
.llms-switch-slider {
background: #e0e0e0;
border-radius: 8px;
display: inline-block;
height: 16px;
margin-top: 2px;
position: relative;
transition: background 0.2s ease;
vertical-align: top;
width: 30px;
&:after {
background: #fff;
border-radius: 8px;
content: '';
display: block;
height: 12px;
left: 2px;
position: relative;
transition: transform 0.2s ease;
top: 2px;
width: 12px;
}
}
}
.llms-video-explainer-trigger {
display: block;
margin: 40px 0 0;
cursor: pointer;
position: relative;
width: 100%;
transition: color 0.2s ease;
color: initial;
&:hover {
color: currentColor;
}
&:after {
position: absolute;
inset: 0;
margin: auto;
pointer-events: none;
content: '▶';
display: flex;
justify-content: center;
align-items: center;
clear: both;
height: 2em;
width: 2em;
border-radius: 4em;
border: 4px solid currentColor;
font-size: 2.5em;
}
img {
display: block;
width: 100%;
border-radius: 4px;
}
}
}
.llms-multi-input .llms-input-wrapper {
width: 50%;
float: left;
margin-bottom: 6px;
font-size: 12px;
}
.llms-multi-input .llms-input-wrapper .llms-input {
font-size: 12px;
padding: 5px;
}
================================================
FILE: assets/scss/admin/_dashboard-widget.scss
================================================
#llms_dashboard_widget {
.inside {
margin: 0;
padding-bottom: 8px;
}
.llms-dashboard-widget-wrap {
display: flex;
justify-content: space-between;
align-items: center;
padding-top: 12px;
}
.activity-block {
padding-bottom: 8px;
border-color: #e8e8e8;
}
h3 {
margin-bottom: 0;
}
.llms-charts-wrapper {
display: none;
}
.llms-widget-row {
display: flex;
justify-content: space-between;
gap: 8px;
width: 100%;
align-items: stretch;
padding: 4px 0;
&:before,
&:after {
display: none;
}
}
.llms-widget-1-4 {
padding: 0;
flex: 1;
}
.llms-widget {
padding: 8px 8px 12px;
margin: 0;
border-radius: 6px;
border: 1px solid #e8e8e8;
box-shadow: 0px 2px 4px rgb(246 247 247);
height: 100%;
display: flex;
flex-wrap: wrap;
justify-content: center;
align-items: flex-end;
}
.llms-label {
font-size: 14px;
width: 100%;
align-self: flex-start;
white-space: nowrap;
text-overflow: ellipsis;
overflow: hidden;
}
.llms-widget-content {
font-size: 20px;
margin: 0;
}
.llms-widget-info-toggle {
display: none;
}
a {
border: 0;
}
.subsubsub {
color: #dcdcde;
}
}
.llms-dashboard-widget-feed {
margin: 0 -12px;
padding: 0;
background-color: #f6f7f7;
li {
margin: 0;
padding: 8px 12px;
border-bottom: 1px solid #e8e8e8;
}
span {
display: block;
}
}
================================================
FILE: assets/scss/admin/_dashboard.scss
================================================
.wrap.llms-dashboard {
.llms-inside-wrap {
padding-top: 30px;
}
#poststuff {
h2 {
padding: 12px 20px;
}
}
.llms-dashboard-activity {
h2 {
font-size: 20px;
font-weight: 700;
line-height: 1.5;
margin-top: 0;
text-align: center;
}
}
.postbox {
background-color: #FFF;
border: none;
box-shadow: 0 1px 3px rgba( 0, 0, 0, 0.13 );
.postbox-header {
border-bottom-color: #efefef;
}
.inside {
padding: 20px;
}
}
#llms_dashboard_addons {
.llms-addons-wrap {
margin-top: 0;
.llms-add-on-item {
margin-top: 0;
p {
text-align: left;
}
footer.llms-actions {
padding-top: 0;
}
}
}
p {
text-align: center;
.llms-button-primary {
display: inline-block;
margin-top: 15px;
}
}
}
#llms_dashboard_quick_links {
ul {
list-style: disc;
margin: 5px 0 0 20px;
li {
font-size: 15px;
line-height: 1.5;
}
}
.llms-quick-links {
display: grid;
grid-template-columns: 1fr;
grid-gap: 30px;
a {
display: inline-block;
}
.llms-list {
h3 {
margin: 0 0 10px 0;
}
ul {
margin-bottom: 20px;
&.llms-checklist {
list-style: none;
margin-left: 0;
}
}
.fa {
text-align: center;
width: 16px;
}
.fa-check {
color: #008a20;
}
.fa-times {
color: #d63638;
}
.llms-button-primary,
.llms-button-secondary,
.llms-button-action {
display: block;
text-align: center;
}
}
@media only screen and (min-width: 782px) {
grid-template-columns: 1fr 1fr 1fr;
}
}
.llms-help-links {
display: grid;
grid-template-columns: 1fr 1fr;
grid-gap: 20px;
.llms-list {
h3 {
margin: 0;
.dashicons {
color: #AAA;
}
}
}
@media only screen and (min-width: 782px) {
grid-template-columns: 1fr 1fr 1fr 1fr;
}
}
}
#llms_dashboard_blog,
#llms_dashboard_podcast {
ul {
margin: 0;
li {
margin: 0 0 15px 0;
a {
display: block;
}
}
}
p {
margin: 15px 0;
text-align: center;
a {
display: inline-block;
}
}
}
}
================================================
FILE: assets/scss/admin/_fonts.scss
================================================
#llms-options-page-contents {
h2 {
color: #999;
font-weight: 500;
letter-spacing: 2px;
border-bottom: 1px solid #999;
}
}
================================================
FILE: assets/scss/admin/_llms-table.scss
================================================
.llms-table-wrap {
position: relative;
}
.llms-table-header {
padding: 0;
@include clearfix();
h2 {
font-size: 20px;
padding: 0;
display: inline-block;
line-height: 1.5;
margin: 0 0 20px 0;
vertical-align: middle;
}
.llms-table-search,
.llms-table-filters {
float: right;
padding-left: 10px;
}
.llms-table-search input {
margin: 0;
padding: 0 8px;
}
}
.llms-table {
border: 1px solid #c3c4c7;
border-collapse: collapse;
width: 100%;
a:not(.small) {
color: $color-brand-blue;
&:hover {
color: $color-brand-blue-dark;
}
}
td, th {
border-bottom: 1px solid #c3c4c7;
padding: 10px 12px;
text-align: center;
&.expandable.closed {
display: none;
}
.llms-button-primary,
.llms-button-secondary,
.llms-button-action,
.llms-button-danger {
display: inline-block;
}
}
tr.llms-quiz-pending {
td {
font-weight: 700;
}
}
thead th,
tfoot th {
background-color: #FFF;
font-weight: 700;
a.llms-sortable {
// display: block;
padding-right: 16px;
position: relative;
text-decoration: none;
width: 100%;
&.active {
// show the current sorted when a sort is active
&[data-order="DESC"] .asc { opacity: 1; }
&[data-order="ASC"] .desc { opacity: 1; }
}
// show the opposite on hover
&:hover {
&[data-order="DESC"] {
.asc { opacity: 0; }
.desc { opacity: 1; }
}
&[data-order="ASC"] {
.asc { opacity: 1; }
.desc { opacity: 0; }
}
}
.dashicons {
color: #444;
font-size: 16px;
height: 16px;
opacity: 0;
position: absolute;
width: 16px;
}
}
}
tfoot th {
border-bottom: none;
.llms-table-export {
float: left;
.llms-table-progress {
background: #efefef;
display: none;
margin-left: 8px;
vertical-align: middle;
width: 100px;
}
}
.llms-clear-resumable-attempts {
float: left;
}
.llms-table-pagination {
float: right;
}
}
&.zebra tbody tr:nth-child( even ) {
th, td { background-color: #fff; }
}
&.zebra tbody tr:nth-child( odd ) {
th, td { background-color: #f6f7f7; }
}
&.text-left {
td, th {
text-align: left;
}
}
&.size-large {
td, th {
font-size: 14px;
padding: 10px 12px;
}
}
.llms-drag-handle {
color: #777;
cursor: pointer;
-webkit-transition: color 0.4s ease;
transition: color 0.4s ease;
}
.llms-action-icon {
color: #777;
text-decoration: none;
.tooltip {
cursor: pointer;
}
&:hover {
color: $color-blue;
}
&.danger:hover {
color: $color-danger;
}
}
.llms-table-page-count {
font-size: 12px;
padding: 0 5px;
}
}
// progress bars within the tables
.llms-table-progress {
text-align: center;
.llms-table-progress-bar {
background: #eee;
border-radius: 10px;
height: 16px;
overflow: hidden;
position: relative;
.llms-table-progress-inner {
background: $color-brand-blue;
height: 100%;
transition: width 0.2s ease;
}
}
.llms-table-progress-text {
color: $color-brand-blue;
font-size: 12px;
font-weight: 700;
line-height: 16px;
}
}
.llms-table.llms-gateway-table,
.llms-table.llms-integrations-table {
.status {
.fa {
color: $color-brand-blue;
font-size: 22px;
}
}
.sort {
cursor: move;
text-align: center;
width: 10px;
}
}
.llms-gb-table-notifications {
th, td {
text-align: left;
}
}
================================================
FILE: assets/scss/admin/_main.scss
================================================
.wrap.lifterlms {
margin-top: 0;
}
.llms-header {
background-color: #FFF;
margin: 0 0 0 -20px;
padding: 20px 10px;
position: relative;
z-index: 1;
.llms-inside-wrap {
display: flex;
padding: 0 10px;
}
.lifterlms-logo {
flex: 0 0 190px;
max-height: 52px;
margin-right: 10px;
}
.llms-meta {
align-self: center;
display: flex;
flex: 1;
font-size: 16px;
justify-content: space-between;
line-height: 1.5;
.llms-version {
background-color: #1d2327;
color: #FFF;
border-radius: 999px;
font-size: 13px;
font-weight: 700;
padding: 6px 12px;
}
a {
display: inline-block;
}
.llms-license {
border-right: 1px solid #CCC;
font-weight: 700;
margin-right: 12px;
padding-right: 12px;
a {
text-decoration: none;
&:before {
content: "\f534";
display: inline-block;
font: 400 16px/1 dashicons;
left: 0;
padding-right: 3px;
position: relative;
text-decoration: none;
vertical-align: text-bottom;
}
&.llms-license-none {
color: #888;
&:before {
content: "\f335";
}
}
&.llms-license-active {
color: #008a20;
&:before {
content: "\f112";
}
}
}
}
.llms-support {
font-weight: 700;
a {
color: #1d2327;
text-decoration: none;
}
}
}
}
.llms-subheader {
align-items: center;
background-color: #FFF;
box-shadow: 0 1px 3px rgba( 0, 0, 0, 0.15 );
display: flex;
flex-direction: row;
margin-left: -20px;
padding: 10px 20px;
width: 100%;
z-index: 1;
h1 {
font-weight: 700;
padding: 0;
a {
color: inherit;
text-decoration: none;
}
}
}
#post_course_difficulty {
min-width: 200px;
}
#_video-embed, #_audio-embed {
width: 100%;
}
hr {
background-color: #CCC;
border: none;
height: 1px;
margin: 30px 0;
padding: 0;
}
.llms_certificate_default_image, .llms_certificate_image {
width: 300px;
}
.llms_achievement_default_image, .llms_achievement_image {
width: 120px;
}
div[id^="lifterlms-"] .inside {
overflow: visible;
}
.lifterlms_notification {
margin-bottom: 15px;
}
.notice.llms-admin-notice, #lifterlms-notifications .lifterlms_notification {
background-color: #FFF;
border: 1px solid #ccd0d4;
box-shadow: 0 1px 4px rgba( 0, 0, 0, 0.15 );
display: flex;
padding: 0 !important;
position: relative;
.notice-dismiss {
text-decoration: none;
}
&.notice-warning, &.lifterlms_notification-warning {
border-left: 4px solid #F8954F;
.llms-admin-notice-icon, .lifterlms_notification-icon {
background-color: #FEF4ED;
}
}
&.notice-info, &.lifterlms_notification-info {
border-left: 4px solid #466DD8;
h3 {
color: #466DD8;
}
.llms-admin-notice-icon, .lifterlms_notification-icon {
background-color: #EDF0FB;
}
}
&.notice-success, &.lifterlms_notification-success {
border-left: 4px solid #18A957;
h3 {
color: #18A957;
}
.llms-admin-notice-icon, .lifterlms_notification-icon {
background-color: #E8F6EE;
}
}
&.notice-error, &.lifterlms_notification-error {
border-left: 4px solid #DF1642;
h3 {
color: #9C0F2E;
}
.llms-admin-notice-icon, .lifterlms_notification-icon {
background-color: #FCE8EC;
}
}
.llms-admin-notice-icon {
background-image: url(../../assets/images/lifterlms-icon-color.png);
background-position: center center;
background-repeat: no-repeat;
background-size: 30px;
min-width: 70px;
}
.lifterlms_notification-icon {
display: flex;
align-items: center;
justify-content: center;
min-width: 70px;
span.dashicons {
font-size: 30px; /* Set icon size */
line-height: 1; /* Remove excess line height */
color: #0073aa; /* Optional: icon color */
display: flex; /* Ensures the icon is centered as content */
align-items: center;
justify-content: center;
width: 100%; /* Fill container horizontally */
height: 100%; /* Fill container vertically */
}
}
.llms-admin-notice-content, .lifterlms_notification-content {
color: #111;
padding: 20px;
}
h3 {
font-size: 18px;
font-weight: 700;
line-height: 25px;
margin: 0 0 15px 0;
}
button,
.llms-button-primary {
display: inline-block;
}
p {
font-size: 14px;
line-height: 22px;
margin: 0 0 15px 0;
max-width: 65em;
padding: 0;
}
p:last-of-type {
margin-bottom: 0;
}
.lifterlms_notification-content p:last-of-type {
margin-bottom: 15px;
}
}
.llms-button-action,
.llms-button-danger,
.llms-button-primary,
.llms-button-secondary {
&.small .dashicons {
font-size: 13px;
height: 13px;
width: 13px;
}
&:hover {
box-shadow: none;
}
}
a.llms-view-as {
line-height: 2;
margin-right: 8px;
}
.llms-image-field-preview {
max-height: 80px;
vertical-align: middle;
width: auto;
}
.llms-image-field-remove {
&.hidden { display: none; }
}
.llms-log-viewer {
background: #fff;
border: 1px solid #e5e5e5;
box-shadow: 0 1px 1px rgba(0,0,0,.04);
margin: 20px 0;
padding: 25px;
pre {
font-family: monospace;
margin: 0;
padding: 0;
white-space: pre-wrap;
}
}
.llms-status--tools {
.llms-table {
background: #fff;
border: 1px solid #e5e5e5;
box-shadow: 0 1px 1px rgba(0,0,0,.04);
td, th {
padding: 10px;
vertical-align: top;
}
th {
width: 28%;
}
p {
margin: 0 0 10px;
}
}
}
.llms-error {
color: $color-red;
font-style: italic;
}
.llms-rating-stars {
color: #ffb900;
text-decoration: none;
}
@media screen and (max-width: 782px) {
.llms-header {
top: 46px;
.llms-inside-wrap {
flex-direction: column;
gap: 20px;
.lifterlms-logo {
align-self: center;
flex: inherit;
max-height: initial;
max-width: 200px;
}
.llms-meta {
column-gap: 10px;
}
}
}
}
.llms-basic-editor.ql-container .ql-editor {
border-radius: 4px;
border: 1px solid #8c8f94;
&:focus {
border-color: var(--wp-admin-theme-color);
box-shadow: 0 0 0 .5px var(--wp-admin-theme-color);
outline: 2px solid #0000;
}
}
================================================
FILE: assets/scss/admin/_media-protection.scss
================================================
.llms-media-protection-warning {
border-left: 4px solid $color-orange;
padding-left: 10px;
max-width: 400px;
margin: 10px 0;
}
================================================
FILE: assets/scss/admin/_quiz-attempt-review.scss
================================================
.llms-remarks {
.llms-remarks-field {
height: 120px;
width: 100%;
}
input[type="number"] {
width: 60px;
}
}
button[name="llms_quiz_attempt_action"] {
.save { display: none; }
&.grading {
.default { display: none };
.save { display: inline; }
}
}
================================================
FILE: assets/scss/admin/_reporting.scss
================================================
.llms-reporting.wrap {
.llms-options-page-contents {
.llms-nav-tab-wrapper.llms-nav-secondary {
box-shadow: 0 1px 3px rgba( 0, 0, 0, 0.15 );
margin: 0;
padding: 0;
}
}
.llms-stab-title {
color: $color-brand-dark-blue;
font-size: 36px;
font-weight: 300;
margin-bottom: 20px;
}
td.id a {
text-decoration: none;
}
th.id, td.id,
th.name, td.name,
th.registered, td.registered,
th.last_seen, td.last_seen,
th.overall_progress, td.overall_progress,
th.title, td.title,
th.course, td.course,
th.lesson, td.lesson { text-align: left; }
td.section-title {
background: #eaeaea;
text-align: left;
font-weight: 700;
padding: 16px 4px;
}
td.questions-table {
text-align: left;
.correct,
.question,
.selected {
text-align: left;
max-width: 300px;
img {
height: auto;
max-width: 64px;
}
}
}
table.quiz-attempts {
margin-bottom: 40px;
}
&.tab--students {
.llms-options-page-contents {
#llms-award-certificate-wrapper .components-button.is-secondary {
background: #e1e1e1;
border-radius: 8px;
box-shadow: none;
color: #414141;
font-size: 13px;
font-weight: 700;
height: auto;
padding: 8px 14px;
}
}
}
&.tab--enrollments,
&.tab--sales {
.llms-nav-tab-wrapper.llms-nav-secondary {
margin-bottom: 0;
}
.llms-options-page-contents {
box-shadow: none;
background: none;
margin-top: 20px;
padding: 0;
}
.llms-nav-style-filters {
.llms-analytics-form {
align-items: center;
align-self: center;
color: #FFF;
display: flex;
font-size: 13px;
gap: 5px;
label {
font-weight: 700;
}
input {
border: 0;
font-size: 13px;
margin: 0;
padding: 0 4px;
vertical-align: middle;
width: 110px;
}
.select2-container {
input {
width: 100% !important;
}
}
}
}
.button.small {
height: 23px;
line-height: 23px;
}
.llms-analytics-filters {
display: none;
.llms-inside-wrap {
background-color: #FFF;
background-color: #FFF;
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.13);
margin: -20px 10px 20px 10px;
padding: 20px;
}
.llms-nav-items {
display: flex;
flex-direction: column;
gap: 20px;
justify-content: space-between;
margin: 0;
@media only screen and (min-width: 782px) {
flex-direction: row;
}
}
.llms-nav-item {
box-sizing: border-box;
width: 100%;
label {
display: block;
font-weight: 700;
margin: 0 0 5px 0;
}
.select2-selection__rendered{
word-wrap: break-word;
text-overflow: inherit;
white-space: normal;
}
}
p {
margin: 0;
text-align: right;
.llms-button-primary {
display: inline-block;
}
}
}
}
.llms-reporting-tab.llms-reporting-quiz .llms-table-filter-wrap {
width: 160px;
}
.llms-table-header {
form { display: inline; }
.button {
margin-left: 5px;
}
}
}
.llms-charts-wrapper {
background-color: #FFF;
border: 1px solid #dedede;
border-radius: 12px;
box-shadow: 0px 0px 1px rgba(48, 49, 51, 0.05), 0px 2px 4px rgba(48, 49, 51, 0.1);
padding: 20px;
}
.llms-reporting-tab {
h1, h2, h3, h4, h5, h6 {
margin: 0;
a {
color: $color-brand-blue;
text-decoration: none;
&:hover {
color: $color-brand-blue;
}
}
}
h2 {
font-size: 22px;
line-height: 1.5;
&.llms-table-title {
margin-bottom: 20px;
}
}
h5 {
font-size: 15px;
line-height: 1.5;
}
.llms-reporting-body {
background-color: #FFF;
box-shadow: 0 1px 3px rgba( 0, 0, 0, .13 );
margin: 20px auto;
padding: 0;
.llms-reporting-stab {
padding: 30px;
.llms-table-header {
margin: 0;
}
}
.llms-gb-tab {
padding: 30px;
}
.llms-reporting-header {
padding: 30px;
margin: 0;
.llms-reporting-header-img {
border-radius: 50%;
display: inline-block;
margin-right: 10px;
overflow: hidden;
vertical-align: middle;
img {
display: block;
max-height: 64px;
width: auto;
}
}
.llms-reporting-header-info {
display: inline-block;
vertical-align: middle;
}
}
}
}
.llms-reporting-breadcrumbs {
margin: 0;
padding: 0;
a {
color: $color-brand-blue;
font-size: 15px;
text-decoration: none;
&:hover {
color: $color-brand-blue-dark;
}
&:after {
content: ' > ';
color: #646970;
}
&:last-child {
color: #000;
font-weight: 700;
&:after { display: none; }
}
}
}
#llms-students-table .name {
text-align: left;
}
.llms-reporting-tab-content {
display: flex;
> header {
@include clearfix;
}
h3 {
margin-bottom: 20px;
}
.llms-reporting-tab-filter {
float: right;
position: relative;
margin-right: 0.75em;
width: 180px;
top: -3px;
}
.llms-reporting-tab-main {
flex: 3;
max-width: 75%;
}
.llms-reporting-tab-side {
flex: 1;
margin-left: 20px;
}
> .llms-table-wrap {
flex: 1;
}
}
.llms-reporting-widgets {
@include clearfix;
}
.llms-reporting-widget {
border-top: 4px solid $color-brand-blue;
background: #fafafa;
margin-bottom: 10px;
padding: 30px;
@include clearfix;
.fa {
color: #999;
float: left;
font-size: 32px;
margin-right: 10px;
}
strong {
color: #333;
font-size: 20px;
line-height: 1.2;
}
&.llms-reporting-student-address {
strong {
line-height: 1.1;
}
}
sup,
.llms-price-currency-symbol {
font-size: 75%;
position: relative;
top: -4px;
vertical-align: baseline;
}
small {
font-size: 13px;
&.compare {
margin-left: 5px;
&.positive {
color: $color-green;
}
&.negative {
color: $color-red;
}
}
}
}
.llms-reporting-event {
border-left: 4px solid #555;
background: #fafafa;
font-size: 11px;
line-height: 1.2;
margin-bottom: 0.75em;
padding: 10px;
@include clearfix;
&.color--blue {
border-left-color: $color-blue;
}
&.color--green,
&._enrollment_trigger,
&._is_complete.yes {
border-left-color: $color-green;
}
&.color--purple,
&._status.enrolled {
border-left-color: $color-purple;
}
&.color--red,
&._status.expired,
&._status.cancelled {
border-left-color: $color-red;
}
&.color--orange,
&._achievement_earned,
&._certificate_earned,
&._email_sent {
border-left-color: $color-orange;
}
time {
color: #888;
}
.llms-student-avatar {
margin-left: 10px;
float: right;
}
a {
text-decoration: none;
color: inherit;
}
}
@media only screen and (min-width: 782px) {
.llms-reporting.wrap {
.llms-options-page-contents {
.llms-nav-tab-wrapper.llms-nav-secondary {
margin-left: 0;
margin-right: 0;
}
}
}
}
@import "../_includes/quiz-result-question-list";
================================================
FILE: assets/scss/admin/_resources.scss
================================================
.wrap.llms-resources {
.llms-inside-wrap {
padding-top: 30px;
}
#poststuff {
#post-body.columns-2 {
margin-right: 350px;
#side-sortables {
width: 330px;
@media only screen and (max-width: 850px) {
width: auto;
}
}
}
#postbox-container-1 {
float: right;
margin-right: -350px;
width: 330px
}
h2 {
padding: 12px 20px;
}
}
#poststuff
.postbox {
background-color: #FFF;
border: none;
box-shadow: 0 1px 3px rgba( 0, 0, 0, 0.13 );
.postbox-header {
border-bottom-color: #efefef;
}
.inside {
margin: 0;
padding: 20px;
}
}
#llms_dashboard_welcome_video {
.llms-welcome-video {
p {
font-size: 15px;
line-height: 1.5;
margin: 0 0 40px 0;
}
.llms-welcome-video-container {
height: 0;
overflow: hidden;
padding-top: 30px;
padding-bottom: 56.25%;
position: relative;
iframe,
object,
embed {
left: 0;
height: 100%;
position: absolute;
top: 0;
width: 100%;
}
}
}
}
#llms_dashboard_getting_started {
ul {
margin: 0 0 20px 0;
li {
font-size: 15px;
line-height: 1.5;
margin-bottom: 15px;
}
}
.llms-button-primary {
display: block;
margin-top: auto;
max-width: 300px;
text-align: center;
}
}
#llms_dashboard_resource_links {
ul {
list-style: disc;
margin: 5px 0 0 20px;
li {
font-size: 15px;
line-height: 1.5;
}
}
.llms-resource-links {
display: grid;
grid-template-columns: 1fr;
grid-gap: 60px;
a {
display: inline-block;
}
.llms-list {
display: flex;
flex-direction: column;
h3 {
margin: 0 0 10px 0;
.dashicons {
color: #AAA;
}
}
ul {
margin-bottom: 20px;
}
.llms-button-primary,
.llms-button-secondary,
.llms-button-action {
display: block;
margin-top: auto;
max-width: 300px;
text-align: center;
}
}
@media only screen and (min-width: 782px) {
grid-template-columns: 1fr 1fr 1fr;
}
}
}
}
================================================
FILE: assets/scss/admin/_settings.scss
================================================
.wrap.llms-reporting,
.wrap.lifterlms-settings,
.wrap.llms-status {
.llms-inside-wrap {
box-sizing: border-box;
margin: 0 auto;
.llms-nav-text {
margin: 0 auto;
}
}
.llms-subheader {
.llms-save {
flex: auto;
text-align: right;
}
}
.llms-nav-tab-wrapper.llms-nav-secondary {
background-color: #FFF;
box-shadow: 0 1px 3px rgba( 0, 0, 0, 0.15 );
margin: 0 -20px 20px -10px;
.llms-nav-items {
padding-left: 0;
}
.llms-nav-item {
.llms-nav-link:hover {
background: #f0f0f1;
color: #222222;
}
&.llms-active .llms-nav-link {
background: #fafafa;
color: $color-blue;
border-top-color: $color-blue;
}
&.llms-active .llms-nav-link {
font-weight: 700;
}
}
.llms-nav-link {
border-top: 2px solid transparent;
padding: 14px;
}
}
.llms-setting-group {
background-color: #FFF;
box-shadow: 0 1px 3px rgba( 0, 0, 0, .13 );
margin: 20px auto;
padding: 20px;
.llms-label {
border-bottom: 1px solid #efefef;
font-weight: 700;
font-size: 20px;
padding: 20px;
margin: -20px -20px 20px;
.llms-button-primary {
margin-left: 10px;
}
}
.llms-help-tooltip .dashicons {
color: #444;
cursor: help;
}
.form-table {
margin: 0;
tr:first-child .llms-subtitle {
margin-top: 0;
}
}
td[colspan="2"] {
padding-top: 0;
padding-left: 0;
}
tr.llms-disabled-field {
opacity: 0.5;
pointer-events: none;
}
p {
font-size: 14px;
}
input[type="text"],
input[type="password"],
input[type="datetime"],
input[type="datetime-local"],
input[type="date"],
input[type="month"],
input[type="time"],
input[type="week"],
input[type="number"],
input[type="email"],
input[type="url"],
input[type="search"],
input[type="tel"],
input[type="color"],
select,
textarea:not(.wp-editor-area) {
width: 50%;
&.medium { width: 30%; }
&.small { width: 20%; }
&.tiny { width: 10%; }
}
}
@media only screen and (min-width: 782px) {
.llms-nav-tab-wrapper.llms-nav-secondary {
.llms-nav-item {
&.llms-active .llms-nav-link {
background: #fff;
}
}
}
}
// Email Delivery providers.
#llms-mailhawk-connect {
height: auto;
margin: 0 0 6px;
position: relative;
.dashicons {
margin: -4px 4px 0 0;
vertical-align: middle;
}
}
#llms-sendwp-connect {
height: auto;
margin: 0 0 6px;
position: relative;
.fa {
margin-right: 4px;
}
}
}
@media only screen and (min-width: 782px) {
.wrap.lifterlms-settings {
.llms-subheader {
height: 40px;
position: sticky;
top: 32px;
}
.llms-nav-tab-wrapper.llms-nav-secondary {
margin: 0 -20px 20px -22px;
.llms-nav-items {
padding-left: 10px;
}
}
}
.wrap.llms-reporting {
.llms-nav-tab-wrapper.llms-nav-secondary {
margin: 0 -20px 20px -22px;
.llms-nav-items {
padding-left: 10px;
}
}
}
.wrap.llms-status {
.llms-nav-tab-wrapper.llms-nav-secondary {
margin: 0 -20px 20px -22px;
.llms-nav-items {
padding-left: 10px;
}
}
}
}
================================================
FILE: assets/scss/admin/_tabs.scss
================================================
.llms-nav-tab-wrapper {
background: $color-blue;
margin: 20px 0;
&.llms-nav-secondary {
background: #e1e1e1;
.llms-nav-item {
margin: 0;
.llms-nav-link:hover,
&.llms-active .llms-nav-link {
background: darken( #e1e1e1, 8 );
}
}
.llms-nav-link {
color: #414141;
font-size: 15px;
padding: 8px 14px;
.dashicons {
font-size: 15px;
height: 15px;
width: 15px;
}
}
}
&.llms-nav-text {
background: inherit;
.llms-nav-items {
padding-left: 0;
}
.llms-nav-item {
background: inherit;
color: #646970;
&:last-child:after {
display: none;
}
&:after {
content: '|';
display: inline-block;
margin: 0 8px 0 6px;
}
.llms-nav-link:hover {
background: inherit;
color: $color-brand-blue;
}
&.llms-active .llms-nav-link {
background: inherit;
color: #000;
font-weight: 600;
text-decoration: none;
}
.llms-nav-link {
color: $color-brand-blue;
display: inline-block;
letter-spacing: 0;
margin: 0;
padding: 0;
text-decoration: underline;
text-transform: none;
}
}
}
&.llms-nav-style-tabs {
background-color: $color-brand-dark-blue;
margin: 0;
padding-top: 8px;
.llms-nav-item {
margin: 0 3px;
.llms-nav-link {
border-top-left-radius: 4px;
border-top-right-radius: 4px;
}
&.llms-active .llms-nav-link {
background-color: #FFF;
color: $color-brand-blue;
font-weight: 700;
}
}
}
&.llms-nav-style-filters {
background-color: $color-brand-blue;
border-radius: 12px;
margin: 20px 0;
overflow: hidden;
padding: 0;
.llms-nav-items {
display: flex;
flex-direction: column;
justify-content: space-between;
padding-left: 0;
@media only screen and (min-width: 782px) {
flex-direction: row;
}
.llms-nav-item {
float: none;
.llms-nav-link {
padding: 14px;
}
}
}
}
.llms-nav-items {
@include clearfix;
margin: 0;
padding-left: 10px;
}
.llms-nav-item {
margin: 0;
.llms-nav-link:hover {
background: $color-brand-blue;
}
&.llms-active .llms-nav-link {
background: $color-brand-dark-blue;
}
&.llms-active .llms-nav-link {
font-weight: 400;
}
@media only screen and (min-width: 768px) {
float: left;
&.llms-nav-item-right {
float: right;
}
}
}
.llms-nav-link {
color: #fff;
cursor: pointer;
display: block;
font-weight: 400;
font-size: 15px;
padding: 9px 18px;
text-align: center;
text-decoration: none;
transition: all .3s ease;
}
}
================================================
FILE: assets/scss/admin/_wp-menu.scss
================================================
#adminmenu {
.toplevel_page_lifterlms .wp-menu-image img {
padding-top: 6px;
width: 20px;
}
.toplevel_page_lifterlms,
.opensub .wp-submenu li.current,
.wp-submenu li.current,
.wp-submenu li.current,
.wp-submenu li.current,
a.wp-has-current-submenu:focus+.wp-submenu li.current {
a[href*="page=llms-add-ons"] {
color: $color-brand-orange;
}
}
}
================================================
FILE: assets/scss/admin/breakpoints/_1030up.scss
================================================
/******************************************************************
Desktop Stylesheet
******************************************************************/
//option page tab menu
.llms-nav-tab {
display: inline-block;
width: 33.333%;
}
.llms-nav-tab-settings {
display: inline-block;
width: 25%;
}
//select box form wrapper
#llms-form-wrapper {
.llms-select {
display: inline-block;
width: 47.5%;
&:first-child {
margin-right: 5%;
}
}.llms-filter-options {
display: inline-block;
width: 47.5%;
&.date-filter {
margin-right: 5%;
}.llms-date-select {
margin-bottom: 0;
}
}.llms-date-select {
width: 47.5%;
&:first-child {
margin-right: 5%
}
}
}
.llms-widget-row {
@include clearfix;
.llms-widget-1-5 {
vertical-align: top;
width: 20%;
float: left;
box-sizing: border-box;
padding: 0 5px;
}
.llms-widget-1-4 {
vertical-align: top;
width: 25%;
float: left;
box-sizing: border-box;
padding: 0 5px;
}
.llms-widget-1-3 {
width: 33.3%;
float: left;
box-sizing: border-box;
padding: 0 5px;
}
.llms-widget-1-2 {
width: 50%;
float: left;
box-sizing: border-box;
padding: 0 5px;
vertical-align: top;
}
}
================================================
FILE: assets/scss/admin/breakpoints/_1240up.scss
================================================
/******************************************************************
large Monitor Stylesheet
******************************************************************/
.llms-nav-tab-filters,
.llms-nav-tab-settings {
float: left;
width: 12.5%;
}
================================================
FILE: assets/scss/admin/breakpoints/_481up.scss
================================================
/******************************************************************
Larger Phones
******************************************************************/
//select box form wrapper
#llms-form-wrapper {
.llms-checkbox {
width: 33%;
//text-align: center;
}
}
================================================
FILE: assets/scss/admin/breakpoints/_768up.scss
================================================
/******************************************************************
Tablets and small computers
******************************************************************/
ul.tabs li{
display: inline-block;
}
//option page tab menu
.llms-nav-tab {
display: inline-block;
width: 33%;
}
.llms-nav-tab-settings {
display: inline-block;
width: 25%;
}
//select box form wrapper
#llms-form-wrapper {
.llms-select {
width: 50%;
max-width: 500px;
}.llms-filter-options {
width: 50%;
//display: inline-block;
max-width: 500px;
}.llms-date-select {
width: 47.5%;
&:first-child {
margin-right: 5%
}
}
}
.llms-widget {
input[type="text"],
input[type="password"],
input[type="datetime"],
input[type="datetime-local"],
input[type="date"],
input[type="month"],
input[type="time"],
input[type="week"],
input[type="number"],
input[type="email"],
input[type="url"],
input[type="search"],
input[type="tel"],
input[type="color"],
select,
textarea, {
width: 50%;
&.medium { width: 30%; }
&.small { width: 20%; }
&.tiny { width: 10%; }
}
// .form-table th {
// width: 140px;
// }
}
================================================
FILE: assets/scss/admin/breakpoints/_base.scss
================================================
/******************************************************************
Base Mobile
******************************************************************/
.llms-nav-tab,
.llms-nav-tab-filters {
display: block;
width: 100%;
}
form.llms-nav-tab-filters.full-width {
width: 100%;
label {
display: inline-block;
width: 10%;
text-align: left;
}
.select2-container {
width: 85% !important;
}
}
.llms-nav-tab-settings {
display: block;
width: 100%;
}
//select box form wrapper
#llms-form-wrapper {
.llms-select {
width: 100%;
margin-bottom: 20px;
}.llms-checkbox {
display: inline-block;
width: 100%;
text-align: left;
}.llms-filter-options {
width: 100%;
//margin-bottom: 20px;
}.llms-date-select {
width: 100%;
display: inline-block;
margin-bottom: 20px;
input[type="text"] {
width: 100%;
}
}.llms-search-button {
//display: inline-block;
//width: 30%;
#llms-search-button {
//float: right;
}
}
}
// .llms-widget-full {
// &.top {
// margin-top: 20px;
// }
// }
// .llms-widget {
// .form-table td {
// padding: 15px 0;
// ul { margin: 5px 0 0; }
// .conditional-field {
// display: none;
// margin-left: 25px;
// }
// .conditional-radio:checked ~ .conditional-field {
// display: block;
// }
// }
// }
ul.tabs li{
display: block;
}
================================================
FILE: assets/scss/admin/metaboxes/_builder-launcher.scss
================================================
.llms-builder-launcher {
p {
margin-top: 0;
}
ol {
margin-top: -6px;
}
.llms-button-primary {
box-sizing: border-box;
}
}
================================================
FILE: assets/scss/admin/metaboxes/_llms-metabox.scss
================================================
// This is a "legacy" rule that may be removable
.llms-mb-list {
label {
font-size: 15px;
font-weight: 700;
line-height: 1.5;
display: block;
width: 100%;
}
.description {
margin-bottom: 8px;
}
.input-full {
width: 100%;
}
}
#poststuff .llms-metabox {
@extend %cf;
h2, h3, h4, h6 {
margin: 0;
padding: 0;
}
h2 {
font-size: 18px;
font-weight: 700;
}
h3 {
color: #1e1e1e;
font-size: 16px;
}
h4 {
color: #1e1e1e;
font-size: 16px;
line-height: 1.5;
padding: 0;
margin: 0;
}
h4:not(.llms-collapsible-body h4:first-of-type) {
margin-top: 20px;
}
.llms-transaction-test-mode {
background: #ffffd7;
font-style: italic;
left: 0;
padding: 2px;
position: absolute;
right: 0;
top: 0;
text-align: center;
}
a.llms-editable,
.llms-metabox-icon,
button.llms-editable {
color: $color-grey;
text-decoration: none;
&:hover {
color: $color-brand-blue;
}
}
button.llms-editable {
border: none;
background: none;
cursor: pointer;
padding: 0;
vertical-align: top;
}
h4 button.llms-editable {
float: right;
}
.llms-table {
margin-top: 10px;
}
.llms-button-primary {
border-radius: 8px;
font-size: 16px;
font-weight: 700;
height: auto;
}
}
.llms-metabox-section {
background: #fff;
margin-top: 25px;
position: relative;
&.no-top-margin {
margin-top: 0;
}
.llms-metabox-field {
margin: 5px 0;
position: relative;
label {
color: #1e1e1e;
display: block;
margin-bottom: 5px;
font-size: 14px;
font-weight: 400;
}
select,
textarea,
input[type="text"],
input[type="number"] {
width: 100%;
}
input.md-text {
width: 105px;
}
input.sm-text {
width: 45px;
}
.llms-datetime-field {
.llms-date-input {
width: 95px;
}
.llms-time-input {
width: 45px;
}
em {
font-style: normal;
padding: 0 3px;
}
}
.select2-container--default .select2-search--inline .select2-search__field {
min-height: auto;
}
.select2-container--default .select2-selection--multiple .select2-selection__rendered li {
margin-bottom: 0;
}
}
/* Fixes to tighten the space between tinymce editor and label */
.llms-metabox-field:has(.wp-editor-wrap) label {
position: relative;
z-index: 5;
}
.llms-metabox-field .wp-editor-wrap {
margin-top: -30px;
}
}
.llms-collapsible {
@extend %clearfix;
background: #fff;
border: 1px solid #efefef;
border-radius: 6px;
box-shadow: 2px 2px 8px rgba(0, 0, 0, 0.08);
display: block;
margin: 0;
padding: 0;
position: relative;
text-align: center;
margin-top: 0;
&:last-child {
margin-bottom: 0;
}
&.opened .llms-collapsible-header {
.dashicons-arrow-down {
display: none;
}
.dashicons-arrow-up {
display: inline;
}
}
.llms-collapsible-header {
@extend %clearfix;
padding: 15px;
[class^="d-"] {
align-items: center;
display: flex;
gap: 5px;
}
.d-right {
justify-content: flex-end;
padding-right: 0;
}
h3 {
color: #1e1e1e;
display: inline;
margin: 0;
font-size: 16px;
font-weight: 700;
small {
font-weight: 400;
}
}
.dashicons-arrow-up {
display: inline;
}
.dashicons-arrow-up {
display: none;
}
a {
text-decoration: none;
}
.dashicons {
color: #1e1e1e;
cursor: pointer;
transition: color .4s ease;
&:hover {
color: $color-blue;
}
&.dashicons-warning,&.dashicons-warning:hover,
&.dashicons-trash:hover,
&.dashicons-no:hover {
color: $color-danger;
}
&.dashicons-warning.medium-danger {
&,
&:hover {
color: $color-orange;
}
}
}
}
.llms-collapsible-body {
@extend %clearfix;
display: none;
padding: 15px;
}
}
================================================
FILE: assets/scss/admin/metaboxes/_metabox-engagements-type.scss
================================================
.submitbox .llms-mb-section,
.llms-award-engagement-submitbox .llms-mb-list {
margin-bottom: 12px;
&:last-of-type {
margin-bottom: 0;
}
@at-root .sync-action,
&.student-info,
&.post_author_override label {
&:before {
// dashicons-admin-users.
font: normal 20px/1 dashicons;
speak: never;
display: inline-block;
margin-left: -1px;
padding-right: 3px;
vertical-align: top;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
position: relative;
top: -1px;
color: #8c8f94;
body:not(.admin-color-fresh) & {
color: currentColor; // Used when selecting a different admin color scheme from the default one.
}
}
}
&.student-info,
&.post_author_override label {
&:before {
content: '\f110';
}
}
@at-root .sync-action:before {
content: '\f113';
color: white;
}
&.post_author_override label {
display: inline-block;
width: auto;;
}
}
================================================
FILE: assets/scss/admin/metaboxes/_metabox-field-repeater.scss
================================================
.llms-mb-container .tab-content ul:not(.select2-selection__rendered).llms-mb-repeater-fields > li.llms-mb-list {
border-bottom: none;
padding: 0 0 10px;
}
.llms-mb-list.repeater {
.llms-repeater-rows {
position: relative;
margin-top: 10px;
min-height: 10px;
&.dragging {
background: #efefef;
box-shadow: inset 0 0 0 1px #e5e5e5;
}
}
.llms-repeater-row {
background: #fff;
}
.llms-mb-repeater-fields {
}
.llms-mb-repeater-footer {
text-align: right;
margin-top: 20px;
}
.tmce-active .wp-editor-area {
color: #32373c; // wp core default color
}
}
================================================
FILE: assets/scss/admin/metaboxes/_metabox-instructors.scss
================================================
._llms_instructors_data.repeater {
.llms-repeater-rows .llms-repeater-row:first-child {
.llms-repeater-remove { display: none; }
}
.llms-mb-list {
padding: 0 5px !important;
}
}
================================================
FILE: assets/scss/admin/metaboxes/_metabox-orders.scss
================================================
.post-type-llms_order #post-body-content { display: none; }
#lifterlms-order-details {
.handlediv,
.handlediv.button-link,
.postbox-header { display: none;}
.inside {
padding: 20px;
margin-top: 0;
}
}
// failed transaction color
.llms-table tbody tr.llms-txn-failed td {
background-color: rgba( $color-red, 0.5 );
border-bottom-color: rgba( $color-red, 0.5 );
}
// refunded transaction color
.llms-table tbody tr.llms-txn-refunded td {
background-color: rgba( orange, 0.5 );
border-bottom-color: rgba( orange, 0.5 );
}
.llms-txn-refund-form,
.llms-manual-txn-form {
.llms-metabox-section {
margin-top: 0;
}
.llms-metabox-field {
text-align: right;
input {
&[type="number"] { max-width: 100px; }
&[type="text"] { max-width: 340px; }
}
}
}
.llms-manual-txn-form {
background-color: #eaeaea;
.llms-metabox-section {
background-color: #eaeaea;
}
}
#llms-remaining-edit {
display: none;
}
.llms-remaining-edit--content {
label, span, textarea {
display: block;
}
label {
margin-bottom: 20px;
}
textarea, input {
width: 100%;
}
}
================================================
FILE: assets/scss/admin/metaboxes/_metabox-product.scss
================================================
.llms-metabox {
> p:first-child {
margin-top: 0;
}
#llms-new-access-plan-model {
display: none;
}
.llms-access-plans {
@extend %clearfix;
color: #1e1e1e;
> .llms-no-plans-msg {
display: none;
.notice {
margin-right: 0;
margin-left: 0;
}
}
> .llms-no-plans-msg:last-child {
display: block;
}
&.dragging {
background: #efefef;
box-shadow: inset 0 0 0 1px #e5e5e5;
}
.llms-spinning {
z-index: 1;
}
.llms-invalid {
border-color: $color-danger;
.dashicons-warning {
display: inline;
}
}
.llms-needs-attention .dashicons-warning.medium-danger {
display: inline;
}
.dashicons-warning {
display: none;
}
}
.llms-access-plan {
margin-bottom: 20px;
text-align: left;
[data-tip]:before {
text-align: center;
}
.llms-plan-link,
[data-controller] {
display: none;
}
&:hover,
&.opened {
.llms-plan-link {
display: inline-block;
}
}
.llms-metabox-field {
margin: 15px 0;
}
.llms-required {
color: $color-danger;
margin-left: 3px;
}
.notice {
margin-left: 0;
}
}
}
.llms-dialog-container,
.llms-dialog-overlay {
position: fixed;
inset: 0;
}
.llms-dialog-container {
z-index: 2;
display: flex;
.llms-dialog-overlay {
background-color: rgb(43 46 56 / 0.9);
}
&[aria-hidden='true'] {
display: none;
}
.llms-dialog-content {
margin: auto;
padding: 2em;
z-index: 2;
max-width: 90%;
width: 700px;
border-radius: 6px;
position: relative;
background-color: white;
overflow: auto;
max-height: 90vh;
.llms-dialog-close {
position: absolute;
top: 0.5em;
right: 0.5em;
border: 0;
padding: 0.25em;
background-color: transparent;
font-size: 1.5em;
width: 1.5em;
height: 1.5em;
text-align: center;
cursor: pointer;
transition: 0.15s;
border-radius: 50%;
}
.llms-access-plan-templates {
display: grid;
grid-template-columns: 1fr 1fr 1fr;
grid-gap: 15px;
button, a {
background: #e1e1e1;
border: 1px solid $color-cinder;
color: $color-cinder;
padding: 25px;
font-size: 14px;
text-align: center;
vertical-align: baseline;
strong {
font-size: 18px;
display: block;
margin-bottom: 10px;
}
span {
display: block;
}
position: relative;
text-decoration: none;
transition: transform .2s;
cursor: pointer;
}
a {
border: 1px solid $color-brand-blue;
background: #efefef;
}
span.add-on {
background-color: #999;
border-bottom-left-radius: 5px;
border-bottom-right-radius: 5px;
color: #FFF;
font-size: 11px;
font-weight: bold;
left: 10px;
text-align: center;
padding: 2px 6px;
position: absolute;
text-transform: uppercase;
top: 0;
width: auto;
}
}
}
}
================================================
FILE: assets/scss/admin/metaboxes/_metabox-students.scss
================================================
.llms-metabox-students {
.llms-table {
tr .name {
text-align: left;
}
}
.llms-add-student:hover {
color: $color-green;
}
.llms-remove-student:hover {
color: $color-red;
}
}
================================================
FILE: assets/scss/admin/modules/_forms.scss
================================================
/******************************************************************
Form Styles
******************************************************************/
// lifterlms form wrapper
#llms-form-wrapper {
// setup defaults
input[type="text"],
input[type="password"],
input[type="datetime"],
input[type="datetime-local"],
input[type="date"],
input[type="month"],
input[type="time"],
input[type="week"],
input[type="number"],
input[type="email"],
input[type="url"],
input[type="search"],
input[type="tel"],
input[type="color"],
input[type="checkbox"],
select,
textarea,
.llms-field {
// a focused input (or hovered on)
&:focus,
&:active {
} // end hover or focus
}
// sub wrapper for search filter form (analytics)
.llms-search-form-wrapper {
border-bottom: 1px solid $color-grey;
margin: 20px 0;
}
#llms_analytics_search {
border:none !important;
text-shadow: none !important;
border: none !important;
outline: none !important;
box-shadow: none !important;
margin: 0 !important;
color: $color-white !important;
background: $color-blue !important;
border-radius: 0;
transition: .5s;
&:hover {
background: $color-darkblue !important;
}&:active {
background: $color-lightblue !important;
}
}
} // end input defaults
#llms-skip-setup-form {
.llms-admin-link {
background:none!important;
border:none;
padding:0!important;
color:#0074a2;
cursor:pointer;
&:hover {
color:#2ea2cc
}&:focus{
color:#124964;
}
}
}
/**
* Toggle Switch ( replaces checkbox on admin panels )
*/
.llms-switch {
position: relative;
.llms-toggle {
position: absolute;
margin-left: -9999px;
visibility: hidden;
}
.llms-toggle + label {
box-sizing: border-box;
display: block;
position: relative;
cursor: pointer;
outline: none;
user-select: none;
}
input.llms-toggle-round + label {
border: 2px solid #6c7781;
border-radius: 10px;
height: 20px;
width: 36px;
}
input.llms-toggle-round + label:before,
input.llms-toggle-round + label:after {
box-sizing: border-box;
content: '';
display: block;
position: absolute;
transition: background 0.4s;
}
input.llms-toggle-round:checked + label {
border-color: #11a0d2;
background-color: #11a0d2;
}
// Primary dot (that moves.)
input.llms-toggle-round + label:after {
height: 12px;
left: 2px;
top: 2px;
background-color: #6c7781;
border-radius: 50%;
transition: margin 0.4s;
width: 12px;
z-index: 3;
}
// Primary dot when toggle on.
input.llms-toggle-round:checked + label:after {
background-color: $color-white;
margin-left: 16px;
}
// Secondary dot: empty on the right side of the toggle when toggled off.
input.llms-toggle-round + label:before {
height: 8px;
top: 4px;
border: 1px solid #6c7781;
border-radius: 50%;
right: 4px;
width: 8px;
z-index: 2;
}
input.llms-toggle-round:checked + label:before {
border-color: $color-white;
border-radius: 0;
left: 6px;
right: auto;
width: 2px;
}
}
#llms-profile-fields {
margin: 50px 0;
.llms-form-field {
padding-left: 0;
}
label {
display: block;
font-weight: bold;
padding: 8px 0 2px;
}
.type-checkbox .type-checkbox {
label {
display: initial;
font-weight: initial;
padding: 0;
}
input {
display: inline-block;
margin-bottom: 0;
width: 1rem;
}
}
select {
max-width: 100%;
}
}
================================================
FILE: assets/scss/admin/modules/_icons.scss
================================================
/******************************************************************
SVG Styles
******************************************************************/
svg {
&.icon {
height: 24px;
width: 24px;
display: inline-block;
fill: currentColor; // Inherit color
vertical-align: baseline; // Options: baseline, sub, super, text-top, text-bottom, middle, top, bottom
// Different styling for when an icon appears in a button element
button & {
height: 18px;
width: 18px;
margin: 4px -4px 0 4px;
filter: drop-shadow( 0 1px #eee );
float: right;
}&.menu-icon {
height: 20px;
width: 20px;
display: inline-block;
fill: currentColor;
vertical-align: text-bottom;
margin-right: 10px;
}&.tree-icon {
height: 13px;
width: 13px;
vertical-align: middle;
}&.section-icon {
height: 16px;
width: 16px;
vertical-align: text-bottom;
}&.button-icon {
height: 16px;
width: 16px;
vertical-align: text-bottom;
}&.button-icon-attr {
height: 10px;
width: 10px;
vertical-align: middle;
}&.list-icon {
height: 12px;
width: 12px;
vertical-align: middle;
&.on {
color: $color-blue;
}&.off {
color: $color-cinder;
}
}&.detail-icon {
height: 16px;
width: 16px;
vertical-align: text-bottom;
cursor:default;
&.on {
color: $color-blue;
}&.off {
color: $color-lightgrey;
}
}
}
&.icon-ion {}
&.icon-ion-edit {}
// rotate for arrow tips
&.icon-ion-arrow-up {
transform: rotate(90deg);
}
use {
pointer-events: none;
}
}
================================================
FILE: assets/scss/admin/modules/_llms-order-note.scss
================================================
.llms-order-note {
.llms-order-note-content {
background: #efefef;
margin-bottom: 10px;
padding: 10px;
position: relative;
&:after {
border-style: solid;
border-color: #efefef transparent;
border-width: 10px 10px 0 0;
bottom: -10px;
content: '';
display: block;
height: 0;
left: 20px;
position: absolute;
width: 0;
}
p {
font-size: 13px;
margin: 0;
line-height: 1.5;
}
}
.llms-order-note-meta {
color: #999;
font-size: 11px;
margin-left: 10px;
}
}
================================================
FILE: assets/scss/admin/modules/_mb-tabs.scss
================================================
/******************************************************************
Metabox Tabs
******************************************************************/
// free space up if the metabox is on the side
#side-sortables .tab-content {
padding: 0;
}
.llms-mb-container .tab-content{
display: none;
background-color: #FFF;
padding: 0 20px;
ul:not(.select2-selection__rendered) {
margin: 0 0 15px 0;
> li {
padding: 20px 0;
margin: 0;
&.select:not([class*="d-"]) {
width: 100%;
}
&:last-child {
border: 0;
padding-bottom: 0;
}
&.top {
border-bottom: 0;
padding-bottom: 0;
}
}
}
.full-width { width: 100%; }
#wp-content-editor-tools {
background: none;
}
}
.llms-mb-container .tab-content.llms-active{
display: inherit;
}
.llms-mb-container .tab-content .no-border {
border-bottom: 0px;
}
================================================
FILE: assets/scss/admin/modules/_merge-codes.scss
================================================
.button.llms-merge-code-button {
vertical-align: middle;
svg {
margin-right: 2px;
position: relative;
top: 4px;
width: 16px;
g {
fill: currentColor;
}
}
}
.llms-mb-container {
.llms-merge-code-wrapper {
float: right;
top: -5px;
}
}
.llms-merge-code-wrapper {
display: inline;
position: relative;
}
.llms-merge-codes {
background: #f7f7f7;
border: 1px solid #ccc;
border-radius: 3px;
box-shadow: 0 1px 0 #ccc;
color: #555;
display: none;
left: 1px;
overflow: hidden;
position: absolute;
top: 30px;
width: 200px;
ul {
margin: 0;
padding: 0;
}
li {
cursor: pointer;
margin: 0;
padding: 4px 8px !important;
border-bottom: 1px solid #ccc;
}
li:hover {
color: #23282d;
background: #fefefe;
}
&.active {
display: block;
z-index: 777;
}
}
================================================
FILE: assets/scss/admin/modules/_top-modal.scss
================================================
/******************************************************************
Styles for topModal modal
******************************************************************/
/**
* Base modal styles
*/
.topModal {
display:none;
position:relative;
border:4px solid #808080;
background:#fff;
z-index:1000001;
padding:2px;
max-width:500px;
margin: 34px auto 0;
box-sizing: border-box;
box-shadow: 0 3px 9px rgba(0, 0, 0, 0.5);
background-color: #ffffff;
border-radius: 2px;
border: 1px solid #dddddd;
}.topModalClose {
float:right;
cursor:pointer;
margin-right: 10px;
margin-top: 10px;
}.topModalContainer {
display: none;
overflow: auto;
overflow-y: hidden;
position: fixed;
top: 0 !important;
right: 0;
bottom: 0;
left: 0;
-webkit-overflow-scrolling: touch;
width: auto !important;
margin-left: 0 !important;
background-color: transparent !important;
z-index: 100002 !important;
}.topModalBackground {
display:none;
background:#000;
position:fixed;
height:100%;
width:100%;
top:0 !important;
left:0;
margin-left: 0 !important;
z-index: 100002 !important;
box-sizing: border-box;
overflow: auto;
overflow-y: hidden;
}body.modal-open {
overflow: hidden;
}.llms-modal-header {
border-top-right-radius: 1px;
border-top-left-radius: 1px;
background: $color-blue;
color: #eeeeee;
padding: 10px 15px;
font-size: 18px;
}#llms-icon-modal-close {
width:16px;
height: 16px;
fill: $color-white;
}.llms-modal-content {
padding: 20px;
h3 {
margin-top: 0;
}
}
/**
* Custom Modal Styles for LifterLMS
*/
.llms-modal-form {
h1 {
margin-top: 0;
}
input[type=text] {
width: 100%;
}
textarea,
input[type="text"],
input[type="password"],
input[type="file"],
input[type="datetime"],
input[type="datetime-local"],
input[type="date"],
input[type="month"],
input[type="time"],
input[type="week"],
input[type="number"],
input[type="email"],
input[type="url"],
input[type="search"],
input[type="tel"],
input[type="color"] {
padding: 0 .4em 0 .4em;
margin-bottom: 2em;
vertical-align: middle;
border-radius: 3px;
min-width: 50px;
max-width: 635px;
width: 100%;
min-height: 32px;
background-color: #fff;
border: 1px solid $color-lightgrey;
margin: 0 0 24px 0;
outline: none;
transition: border 0.3s ease-in-out 0s;
&:focus {
background: $color-white;
border: 1px solid $color-blue;
}
}
textarea {
padding: .4em !important;
height: 100px !important;
border-radius: 3px;
vertical-align: middle;
min-height: 32px;
outline: none;
box-sizing: border-box;
&:focus {
background: $color-white;
border: 1px solid $color-blue;
}
}
.chosen-container-single .chosen-single {
border-radius: 3px;
vertical-align: middle;
min-height: 32px;
border: 1px solid $color-lightgrey;
width: 100%;
background: $color-white !important;
outline: none;
box-sizing: border-box;
box-shadow: 0 0 0 #fff;
line-height: 32px;
margin: 0 0 24px 0;
&:focus {
background: $color-white;
border: 1px solid $color-blue;
}
}
.chosen-container-single .chosen-single div b {
margin-top: 4px;
}
.chosen-search input[type=text] {
border: 1px solid $color-lightgrey;
&:focus {
background-color: $color-white;
border: 1px solid $color-blue;
}
}
.chosen-container-single .chosen-drop {
margin-top: -28px;
}
.llms-button-primary, .llms-button-secondary {
padding: 10px 10px;
border-radius: 0;
transition: .5s;
box-shadow: 0 1px 1px #ccc;
&.full {
width: 100%;
}
}
}
.modal-open .select2-dropdown {
z-index: 1000005;
}
================================================
FILE: assets/scss/admin/modules/_voucher.scss
================================================
a.llms-voucher-delete {
background: $color-danger;
color: $color-white;
display: block;
padding: 4px 2px;
text-decoration: none;
transition: ease .3s all;
&:hover {
background: #af3a26;
}
}
.llms-voucher-codes-wrapper,
.llms-voucher-redemption-wrapper {
table {
width: 100%;
border-collapse: collapse;
th, td {
border: none;
}
thead {
background-color: $color-blue;
color:#fff;
th {
padding: 10px 10px;
}
}
tr {
counter-increment: row-counter;
&:nth-child(even) {
background-color: #F1F1F1;
}
td {
padding: 5px;
&:first-child:before {
content: counter( row-counter );
}
}
}
}
}
.llms-voucher-codes-wrapper {
table {
width: 100%;
border-collapse: collapse;
th, td {
border: none;
}
thead {
background-color: $color-blue;
color:#fff;
}
tr {
&:nth-child(even) {
background-color: #F1F1F1;
}
td {
span {
display: inline-block;
min-width: 30px;
}
}
}
}
button {
cursor: pointer;
}
.llms-voucher-delete {
float: right;
margin-right: 15px;
}
.llms-voucher-uses {
width: 50px;
}
.llms-voucher-add-codes {
float: right;
input[type="text"] {
width: 30px;
}
}
}
.llms-voucher-export-wrapper {
.llms-voucher-export-type {
width: 100%;
p {
margin: 0 0 0 15px;
}
}
.llms-voucher-email-wrapper {
width: 100%;
margin: 25px 0;
input[type="text"] {
width: 100%;
}
p {
margin: 0;
}
}
> button {
float: right;
}
}
.postbox .inside {
overflow: auto;
}
================================================
FILE: assets/scss/admin/modules/_widgets.scss
================================================
.llms-widget {
background-color: #FFF;
border: 1px solid #dedede;
border-radius: 12px;
box-shadow: 0px 0px 1px rgba(48, 49, 51, 0.05), 0px 2px 4px rgba(48, 49, 51, 0.1);
box-sizing: border-box;
margin-bottom: 20px;
padding: 20px;
position: relative;
width: 100%;
&.alt {
border: 1px solid $color-lightgrey;
background-color: #efefef;
margin-bottom: 10px;
.llms-label {
color: #777;
font-size: 14px;
margin-bottom: 10px;
padding-bottom: 5px;
}
h2 {
color: #444;
font-weight: 300;
}
}
a {
border-bottom: 1px dotted $color-brand-blue;
display: inline-block;
text-decoration: none;
&:hover {
border-bottom: 1px dotted $color-brand-blue-dark;
}
}
// Nested for specificity (matches h1).
.llms-widget-content {
margin: .67em 0;
color: $color-brand-blue;
font-size: 2.4em;
font-weight: 700;
line-height: 1;
word-break: break-all;
}
h2 {
font-size: 1.8em;
}
.llms-label {
box-sizing: border-box;
font-size: 18px;
font-weight: 400;
margin: 0 0 10px 0;
text-align: center;
}
.llms-chart {
width: 100%;
padding: 10px;
box-sizing: border-box;
}
mark.yes {
background-color: #7ad03a;
}
.llms-subtitle {
margin-bottom: 0;
}
.spinner {
float: none;
left: 50%;
margin: -10px 0 0 -10px;
position: absolute;
top: 50%;
z-index: 2;
}
&.is-loading {
&:before {
background: $color-white;
bottom: 0;
content: '';
left: 0;
opacity: 0.9;
position: absolute;
right: 0;
top: 0;
z-index: 1;
}
.spinner {
visibility: visible;
}
}
td[colspan="2"] {
padding-left: 0;
}
tr.llms-disabled-field {
opacity: 0.5;
pointer-events: none;
}
}
.llms-widget-1-3,
.llms-widget-1-4,
.llms-widget-1-5 {
text-align: center;
}
.llms-widget {
.llms-widget-info-toggle {
color: #AAA;
cursor: pointer;
font-size: 16px;
position: absolute;
right: 20px;
top: 20px;
}
&.info-showing {
.llms-widget-info {
display: block;
}
}
}
.llms-widget-info {
background: $color-cinder;
color: $color-white;
bottom: -50px;
display: none;
padding: 15px;
position: absolute;
text-align: center;
left: 10px;
right: 15px;
z-index: 3;
&:before {
content: '';
border: 12px solid transparent;
border-bottom-color: $color-cinder;
left: 50%;
margin-left: -12px;
position: absolute;
top: -24px;
}
p {
margin: 0;
}
}
.llms-widget-row {
@include clearfix();
}
.llms-widget-row .no-padding {
padding: 0 !important;
}
================================================
FILE: assets/scss/admin/partials/_grid.scss
================================================
/******************************************************************
Grids for Breakpoints
******************************************************************/
// using a mixin since we can't use placeholder selectors
@mixin grid-col {
float: left;
padding-right: 0.75em;
box-sizing: border-box;
}
// the last column
.last-col {
float: right;
padding-right: 0 !important;
}
.last-col:after {
clear: both;
}
/*
Mobile Grid Styles
These are the widths for the mobile grid.
There are four types, but you can add or customize
them however you see fit.
*/
@media (max-width: 767px) {
.m-all {
@include grid-col;
width: 100%;
padding-right: 0;
}
.m-1of2 {
@include grid-col;
width: 50%;
}
.m-1of3 {
@include grid-col;
width: 33.33%;
}
.m-2of3 {
@include grid-col;
width: 66.66%;
}
.m-1of4 {
@include grid-col;
width: 25%;
}
.m-3of4 {
@include grid-col;
width: 75%;
}
.m-right {
text-align: center;
}
.m-center {
text-align: center;
}
.m-left {
text-align: center;
}
.d-right {
text-align: right;
}
.d-center {
text-align: center;
}
.d-left {
text-align: left;
}
} // end mobile styles
/* Portrait tablet to landscape */
@media (min-width: 768px) and (max-width: 1029px) {
.t-all {
@include grid-col;
width: 100%;
padding-right: 0;
}
.t-1of2 {
@include grid-col;
width: 50%;
}
.t-1of3 {
@include grid-col;
width: 33.33%;
}
.t-2of3 {
@include grid-col;
width: 66.66%;
}
.t-1of4 {
@include grid-col;
width: 25%;
}
.t-3of4 {
@include grid-col;
width: 75%;
}
.t-1of5 {
@include grid-col;
width: 20%;
}
.t-2of5 {
@include grid-col;
width: 40%;
}
.t-3of5 {
@include grid-col;
width: 60%;
}
.t-4of5 {
@include grid-col;
width: 80%;
}
.d-right {
text-align: right;
}
.d-center {
text-align: center;
}
.d-left {
text-align: left;
}
} // end tablet
/* Landscape to small desktop */
@media (min-width: 1030px) {
.d-all {
@include grid-col;
width: 100%;
padding-right: 0;
}
.d-1of2 {
@include grid-col;
width: 50%;
}
.d-1of3 {
@include grid-col;
width: 33.33%;
}
.d-2of3 {
@include grid-col;
width: 66.66%;
}
.d-1of4 {
@include grid-col;
width: 25%;
}
.d-3of4 {
@include grid-col;
width: 75%;
}
.d-1of5 {
@include grid-col;
width: 20%;
}
.d-2of5 {
@include grid-col;
width: 40%;
}
.d-3of5 {
@include grid-col;
width: 60%;
}
.d-4of5 {
@include grid-col;
width: 80%;
}
.d-1of6 {
@include grid-col;
width: 16.6666666667%;
}
.d-1of7 {
@include grid-col;
width: 14.2857142857%;
}
.d-2of7 {
@include grid-col;
width: 28.5714286%;
}
.d-3of7 {
@include grid-col;
width: 42.8571429%;
}
.d-4of7 {
@include grid-col;
width: 57.1428572%;
}
.d-5of7 {
@include grid-col;
width: 71.4285715%;
}
.d-6of7 {
@include grid-col;
width: 85.7142857%;
}
.d-1of8 {
@include grid-col;
width: 12.5%;
}
.d-1of9 {
@include grid-col;
width: 11.1111111111%;
}
.d-1of10 {
@include grid-col;
width: 10%;
}
.d-1of11 {
@include grid-col;
width: 9.09090909091%;
}
.d-1of12 {
@include grid-col;
width: 8.33%;
}
.d-right {
text-align: right;
}
.d-center {
text-align: center;
}
.d-left {
text-align: left;
}
} // end desktop styles
================================================
FILE: assets/scss/admin/post-tables/_llms_orders.scss
================================================
.wp-list-table {
@include order_status_badges();
}
#lifterlms-order-transactions .llms-table tfoot th {
text-align: right;
}
================================================
FILE: assets/scss/admin/post-tables/_post-tables.scss
================================================
.llms-post-table-post-filter {
display: inline-block;
margin-right: 6px;
max-width: 100%;
width: 220px;
}
================================================
FILE: assets/scss/admin-importer.scss
================================================
@import "_includes/vars";
@import "_includes/mixins";
.llms-import-file-wrap {
background: #fafafa;
border: 1px solid #ccd0d4;
padding: 10px;
margin: 20px auto;
display: inline-flex;
justify-content: space-between;
align-items: center;
}
.llms-cloud-import-help.button-link {
color: inherit;
vertical-align: top;
text-decoration: none;
}
.wrap.llms-import-export {
ul.llms-importable-courses {
display: flex;
flex-direction: column;
flex-wrap: wrap;
gap: 20px;
@media only screen and ( min-width: 680px ) {
flex-direction: row;
}
.llms-importable-course {
background-color: #FFF;
border: 1px solid #dedede;
border-radius: 12px;
box-shadow: 0px 0px 1px rgba(48, 49, 51, 0.05), 0px 2px 4px rgba(48, 49, 51, 0.1);
list-style: none;
margin: 20px 0;
overflow: hidden;
@media only screen and ( min-width: 680px ) {
-webkit-box-flex: 0;
flex-grow: 0;
flex-shrink: 1;
flex-basis: calc(31%);
}
img {
display: block;
max-width: 100%;
}
h3 {
color: #1d2327;
font-size: 20px;
line-height: 1.5;
margin: 30px 20px 15px;
}
p {
font-size: 15px;
line-height: 1.5;
margin: 0 20px 15px;
}
&.has-action-button {
padding-bottom: 10px;
position: relative;
.button {
bottom: 20px;
right: 20px;
position: absolute;
}
}
}
}
@media only screen and (min-width: 600px) {
ul.llms-importable-courses {
display: flex;
flex-wrap: wrap;
}
}
@media only screen and (min-width: 600px) and (max-width: 767px) {
ul.llms-importable-courses {
li.llms-importable-course {
flex: 1 0 calc( 50% - 20px );
max-width: calc( 50% - 20px );
}
}
}
@media only screen and (min-width: 768px) {
ul.llms-importable-courses {
li.llms-importable-course {
flex: 1 0 calc( 33% - 20px );
max-width: calc( 33% - 20px );
}
}
}
}
================================================
FILE: assets/scss/admin-wizard.scss
================================================
@import "_includes/vars";
$input_padding: 0.3em 0.6em;
#wpadminbar, #adminmenumain, #wpfooter {
display: none;
}
#llms-setup-wizard {
background-color: #F0F0F1;
height: 100%;
left: 0;
overflow: scroll;
position: fixed;
top: 0;
width: 100%;
}
.llms-setup-wrapper {
margin: 30px auto;
max-width: 640px;
}
#llms-logo {
text-align: center;
a {
display: inline-block;
}
img {
max-width: 200px;
}
}
.llms-setup-content {
background-color: #FFF;
box-shadow: 0 1px 3px rgba(0, 0, 0, 0.13);
padding: 30px;
h1, h2, h3, h4, h5, h6 {
color: #3C434A;
}
a:not( .llms-button-primary ):not( .llms-button-secondary ) {
color: $color-brand-blue;
}
p, li {
color: #3C434A;
font-size: 16px;
}
p.error {
color: $color-red;
background: rgba($color-red,0.1);
border: 1px solid currentColor;
padding: 1em;
border-radius: 4px;
margin: 1.5em 0 0;
font-size: 15px;
text-align: left;
}
label {
font-weight: 500;
}
table {
border-bottom: 1px solid #f1f1f1;
border-collapse: collapse;
width: 100%;
}
td {
border-top: 1px solid #f1f1f1;
&:first-child {
padding-right: 10px;
width: 33%;
a {
font-size: 16px;
font-weight: 500;
}
i {
display: block;
font-size: 13px;
margin-top: 10px;
a {
font-size: 13px;
}
}
}
}
small {
font-size: small;
}
.has-checkbox-field {
display: flex;
flex-direction: row-reverse;
justify-content: flex-end;
align-items: center;
align-content: center;
gap: 0.5em;
font-weight: normal;
font-size: 16px;
input {
margin: 0;
}
}
label {
font-size: 16px;
display: block;
margin-bottom: 0.5em;
}
small + label {
margin-top: 1em;
}
[type=text] {
width: 100%;
clear: both;
margin: 0;
padding: $input_padding;
}
.has-date-field {
font-size: 16px;
display: flex;
margin-bottom: 0.5em;
flex-wrap: wrap;
flex-direction: column;
gap: 0.5em;
}
[type=date] {
padding: $input_padding;
}
.is-hidden {
display: none;
}
}
.llms-setup-date-fields {
display: flex;
justify-content: space-between;
gap: 1em;
padding-top: 2em;
}
.llms-setup-date-field {
flex: 1;
}
.llms-setup-actions {
margin-top: 2em;
text-align: right;
display: flex;
justify-content: space-between;
align-items: center;
gap: 1em;
.llms-button-primary {
display: inline-block;
&:after {
content: "\f054";
font-family: 'FontAwesome';
font-weight: 900;
padding-left: 10px;
}
}
}
.llms-exit-setup {
color: inherit !important;
margin-right: 10px;
+ .llms-button-primary,
+ .llms-button-secondary {
margin-left: auto;
}
}
.llms-importing-msgs {
a {
color: $color-brand-blue;
}
.llms-importing-msg {
display: none;
font-size: 14px;
font-style: italic;
text-align: right;
}
}
ul.llms-importable-courses {
border-bottom: 1px solid #f1f1f1;
display: block;
li.llms-importable-course {
border-top: 1px solid #f1f1f1;
display: block;
margin: 0;
max-width: 100%;
padding: 20px 0;
h3 {
grid-area: title;
line-height: 1.5;
margin: 0;
}
p {
grid-area: description;
margin: 0;
}
label {
column-gap: 20px;
display: grid;
font-weight: 400;
grid-template-areas:
"image title switch"
"image description switch";
;
grid-template-columns: 1fr 3fr auto;
row-gap: 5px;
}
img {
grid-area: image;
max-width: 160px;
}
.llms-switch {
grid-area: switch;
input.llms-toggle-round:checked + label {
border-color: $color-brand-blue;
background-color: $color-brand-blue;
}
}
}
}
.llms-setup-progress {
display: flex;
margin: 20px 0;
li {
border-bottom: 4px solid $color-brand-blue;
display: inline-block;
font-size: 14px;
padding-bottom: 10px;
position: relative;
text-align: center;
flex: 1;
a {
color: $color-brand-blue;
text-decoration: none;
}
&:after {
background: $color-brand-blue;
bottom: 0;
content: '';
border: 4px solid $color-brand-blue;
border-radius: 100%;
height: 4px;
position: absolute;
left: 50%;
margin-left: -6px;
margin-bottom: -8px;
width: 4px;
}
&.current {
font-weight: 700;
&:after {
background: #fff;
}
}
&.current ~ li {
border-bottom-color: #ccc;
&:after {
background: #ccc;
border-color: #ccc;
}
a {
color: #bbb;
}
}
}
}
.llms-setup-wrapper {
// Calendar icon for custom date fields.
[type="text"].llms-datepicker {
background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 448 512' fill='%23ccc'%3E%3Cpath d='M152 24c0-13.3-10.7-24-24-24s-24 10.7-24 24v40H64C28.7 64 0 92.7 0 128v320c0 35.3 28.7 64 64 64h320c35.3 0 64-28.7 64-64V128c0-35.3-28.7-64-64-64h-40V24c0-13.3-10.7-24-24-24s-24 10.7-24 24v40H152V24zM48 192h352v256c0 8.8-7.2 16-16 16H64c-8.8 0-16-7.2-16-16V192z'/%3E%3C/svg%3E");
background-repeat: no-repeat;
background-position: right 8px center;
background-size: 16px 16px;
padding-right: 40px;
}
}
@media only screen and ( max-width: 782px ) {
ul.llms-importable-courses {
li.llms-importable-course {
label {
grid-template-areas:
"image switch"
"title title"
"description description";
grid-template-columns: 3fr auto;
}
}
}
}
================================================
FILE: assets/scss/admin.scss
================================================
//
// Main Admin CSS File
//
@import "_includes/vars";
@import "_includes/vars-brand-colors";
@import "_includes/extends";
@import "_includes/buttons";
@import "_includes/mixins";
@import "_includes/tooltip";
// wp menu item
@import "admin/_wp-menu";
// grid layout for breakpoints
@import "admin/partials/grid";
// forms
@import "admin/modules/forms";
// voucher
@import "admin/modules/voucher";
// widgets
@import "admin/modules/widgets";
// icons
@import "admin/modules/icons";
// icons
@import "admin/modules/mb-tabs";
// icons
@import "admin/modules/top-modal";
@import "admin/modules/merge-codes";
// Base (mobile)
@import "admin/breakpoints/base";
// Larger mobile devices
@media only screen and (min-width: 481px) {
@import "admin/breakpoints/481up";
}
// Tablets and smaller laptops
@media only screen and (min-width: 768px) {
@import "admin/breakpoints/768up";
}
// Desktops
@media only screen and (min-width: 1030px) {
@import "admin/breakpoints/1030up";
}
// Larger Monitors and TVs
@media only screen and (min-width: 1240px) {
@import "admin/breakpoints/1240up";
}
@import "admin/main";
@import "admin/llms-table";
@import "admin/modules/llms-order-note";
// metabox related
@import "admin/metaboxes/llms-metabox";
@import "admin/metaboxes/metabox-instructors";
@import "admin/metaboxes/metabox-orders";
@import "admin/metaboxes/metabox-engagements-type";
@import "admin/metaboxes/metabox-product";
@import "admin/metaboxes/metabox-students";
@import "admin/metaboxes/metabox-field-repeater";
@import "admin/metaboxes/builder-launcher";
@import "admin/media-protection";
@import "admin/post-tables/llms_orders";
@import "admin/post-tables/post-tables";
@import "admin/tabs";
@import "admin/fonts";
@import "admin/reporting";
@import "admin/settings";
@import "admin/dashboard";
@import "admin/dashboard-widget";
@import "admin/resources";
@import "admin/quiz-attempt-review";
@import "_includes/llms-form-field";
@import "_includes/vendor/_font-awesome";
================================================
FILE: assets/scss/builder.scss
================================================
@import "_includes/vars";
@import "_includes/vars-brand-colors";
@import "_includes/extends";
@import "_includes/mixins";
@import "admin/course-builder";
================================================
FILE: assets/scss/certificates.scss
================================================
/**
* Reset.
*/
body {
background-color: #fff;
background-image: none;
margin: 0 auto;
}
.header, .footer,
.wrap-header, .wrap-footer,
.site-header, .site-footer,
.nav-primary, .primary-nav {
display: none;
}
.llms-certificate-container {
margin: 40px auto 0;
}
/**
* Legacy Template.
*/
.llms-certificate-container:not(.cert-template-v2) {
padding: 0;
overflow: hidden;
.certificate-background {
position: relative;
z-index: 1;
width: 100%;
display: block;
}
.llms_certificate,
.llms_my_certificate {
margin: 80px;
position: relative;
z-index: 2;
}
h1:first-child {
text-align: center;
}
}
/**
* V2 Template
*/
.llms-certificate-wrapper {
margin: 0 auto;
}
.llms-certificate-container.cert-template-v2 {
width: 100%;
height: 100%;
background-size: 100% 100% !important;
box-sizing: border-box;
.wp-block-columns .wp-block-column > * {
margin-top: 0 !important;
margin-bottom: 0 !important;
}
}
/**
* Certificate Actions Footer.
*/
.llms-print-certificate {
margin-top: 40px;
margin-bottom: 40px;
text-align: center;
form {
display: inline;
}
}
@media print {
html, body {
print-color-adjust: exact !important;
height: 100%;
overflow: hidden;
}
@page { size: auto; }
.no-print {
display: none;
}
// Make everything on the page invisible.
body * {
visibility: hidden !important;
background: #fff none;
}
.site, .site-content {
overflow: visible;
}
// Remove all headers, menus and footers.
header, aside, nav, footer {
display: none !important;
}
// Make sure a .container parent doesn't shift the certificate see: https://github.com/gocodebox/lifterlms/issues/1163.
.single-llms_my_certificate .container,
.single-llms_certificate .container {
width: 100%;
}
// Make only the certificate container and its children visible.
.llms-certificate-container,
.llms-certificate-container * {
visibility: visible !important;
background: transparent none;
}
// Position certificate absolutely and center horizontally.
.llms-certificate-container:not(.cert-template-v2) {
position: absolute;
top: 0;
left: 0;
right: 0;
margin: 0 auto;
background: #fff none;
}
.llms-certificate-container.cert-template-v2 {
margin: 0 auto !important;
print-color-adjust: exact !important;
transform: scale( 0.95 ); // Don't ram the edge of the paper.
}
}
================================================
FILE: assets/scss/editor.scss
================================================
.llms-block-empty,
.llms-block-error {
padding: 1em;
border: 1px solid #e0e0e0;
font-size: 16px;
}
.llms-block-empty {
font-style: italic;
}
.wp-block .llms-button-primary {
text-decoration: none;
}
.llms-navigation-link-settings .components-panel__row > .components-base-control {
width: 100%;
}
.llms-block-icon {
transform: scale(0.75);
}
.llms-loop-item {
.llms-video-wrapper {
aspect-ratio: 16/9;
position: relative;
iframe {
width: 100%;
height: 100%;
position: absolute;
left: 0;
top: 0;
object-fit: cover;
}
}
}
================================================
FILE: assets/scss/frontend/_checkout.scss
================================================
.llms-checkout-wrapper {
.llms-person-login-form-wrapper {
margin-bottom: 40px;
}
form.llms-login {
display: none;
}
.llms-form-heading {
margin: 0 0 20px;
}
}
.llms-checkout {
position: relative;
}
.llms-checkout-cols-2 {
@extend %clearfix;
&.llms-col-2 {
section {
background-color: $color-white;
border: 1px solid $color-lightgrey;
border-radius: $radius-medium;
padding: 20px;
.llms-form-heading {
padding: 0;
}
}
}
@media all and (min-width: 800px) {
.llms-checkout-col {
float: left;
&.llms-col-1 {
margin-right: 20px;
width: calc( 58% - 20px );
}
&.llms-col-2 {
margin-left: 20px;
width: calc( 42% - 20px );
button {
width: 100%;
}
}
}
}
}
.llms-checkout-section {
margin-bottom: 40px;
position: relative;
}
.llms-checkout-section-content {
&.llms-form-fields {
margin: 0px;
}
.llms-label {
font-weight: 400;
}
.llms-order-summary {
list-style-type: none;
margin: 0;
padding: 0;
li {
list-style-type: none;
margin: 0 0 15px 0;
}
:not(.llms-label) {
font-weight: 700;
}
li.llms-pricing {
&.on-sale,
&.has-coupon {
.price-regular { text-decoration: line-through; }
}
}
}
.llms-coupon-wrapper {
border-top: 1px solid $color-border;
margin-top: 20px;
padding-top: 20px;
.llms-coupon-entry {
display: none;
margin-top: 20px;
}
}
}
.llms-form-field.llms-payment-gateway-option {
align-items: center;
display: flex;
gap: 8px;
label + span.llms-description {
display: inline-block;
margin-left: 5px;
}
.llms-description {
a {
border: none;
box-shadow: none;
text-decoration: none;
}
img {
display: inline;
max-height: 22px;
vertical-align: middle;
}
}
}
.llms-checkout-wrapper ul.llms-payment-gateways {
margin: 5px 0 0;
padding: 0;
}
ul.llms-payment-gateways {
list-style-type: none;
li:last-child:after {
border-bottom: 1px solid $color-border;
content: '';
display: block;
margin: 20px 0;
}
.llms-payment-gateway {
margin-bottom: 30px;
list-style-type: none;
&:last-child {
margin-bottom: none;
}
&.is-selected {
.llms-payment-gateway-option label {
font-weight: 700;
}
.llms-gateway-fields {
display: block;
.llms-notice {
margin-left: 10px;
margin-right: 10px;
}
}
}
.llms-form-field {
padding-bottom: 0;
}
}
.llms-gateway-description {
margin-left: 40px;
}
.llms-gateway-fields {
display: none;
margin: 5px 0 20px;
}
.llms-payment-gateway-error {
padding: 0 10px;
}
}
.llms-checkout-confirm {
margin: 0;
}
.llms-payment-method {
margin: 10px 10px 0;
}
.llms-gateway-description {
p {
font-size: 14px;
font-style: italic;
margin: 0;
}
}
================================================
FILE: assets/scss/frontend/_course.scss
================================================
.llms-meta-info {
margin: 40px 0;
.llms-meta-title {
margin: 0;
}
.llms-meta {
p {
margin-bottom: 0;
}
span {
font-weight: 700;
}
}
}
.llms-course-progress {
margin: 40px auto;
max-width: 480px;
text-align: center;
}
================================================
FILE: assets/scss/frontend/_focus-mode.scss
================================================
//
// Focus Mode
//
$focus-header-height: 60px;
$focus-sidebar-width: 350px;
$focus-sidebar-collapsed-width: 48px;
$admin-bar-height: 32px;
$admin-bar-height-mobile: 46px;
.llms-focus-mode {
margin: 0;
padding: 0;
background-color: #f9f9f9;
overflow: hidden;
.llms-focus-mode-wrapper {
display: flex;
flex-direction: column;
height: 100dvh;
overflow: hidden;
}
// -- Header: fixed to top, full width --
.llms-focus-mode-header {
display: flex;
justify-content: space-between;
align-items: center;
gap: 20px;
background-color: #fff;
border-bottom: 1px solid #e5e5e5;
padding: 0 20px;
height: $focus-header-height;
min-height: $focus-header-height;
box-sizing: border-box;
flex-shrink: 0;
z-index: 20;
.llms-focus-mode-header-left {
display: flex;
align-items: center;
flex-shrink: 0;
white-space: nowrap;
> .clear {
display: none;
}
}
.llms-focus-mode-header-center {
display: flex;
align-items: center;
justify-content: center;
flex: 1;
min-width: 0;
}
.llms-progress {
width: 100%;
max-width: 300px;
.llms-progress-bar {
width: 100%;
min-width: 20px;
}
}
.llms-focus-mode-header-nav {
display: flex;
align-items: center;
gap: 8px;
flex-shrink: 0;
}
}
.llms-focus-mode-nav-btn {
display: inline-flex;
align-items: center;
gap: 6px;
padding: 6px 14px;
border: 1px solid #e5e5e5;
border-radius: 6px;
background: #fafafa;
color: #1d2327;
text-decoration: none;
font-size: 0.8125rem;
font-weight: 500;
line-height: 1;
white-space: nowrap;
transition: background-color 0.15s ease, border-color 0.15s ease;
&:hover {
background: #f0f0f0;
border-color: #ccc;
color: #1d2327;
}
.llms-focus-mode-nav-icon {
width: 12px;
height: 12px;
fill: currentColor;
flex-shrink: 0;
}
.llms-focus-mode-nav-label {
@media (max-width: 768px) {
display: none;
}
}
@media (max-width: 768px) {
padding: 6px 8px;
}
&.llms-lesson-locked {
cursor: not-allowed;
position: relative;
color: #a7aaad;
border-color: #e5e5e5;
background: #f9f9f9;
.llms-tooltip {
top: auto;
bottom: auto;
left: auto;
right: 0;
transform: none;
white-space: normal;
min-width: 200px;
max-width: 200px;
&.show {
top: auto;
bottom: -112px;
}
&:after {
bottom: auto;
top: -8px;
left: auto;
right: 12px;
transform: none;
border-top: 0;
border-bottom: 8px solid #2a2a2a;
}
}
}
}
.llms-focus-mode-back-link {
text-decoration: none;
color: #0073aa;
font-weight: 500;
&:hover {
color: #005177;
}
}
// -- Body: sidebar + content side by side below header --
.llms-focus-mode-body {
display: flex;
flex: 1;
overflow: hidden;
height: calc(100dvh - #{$focus-header-height});
}
// -- Sidebar: fixed width, split into fixed header + scrollable list --
.llms-focus-mode-sidebar {
position: relative;
width: $focus-sidebar-width;
min-width: $focus-sidebar-width;
flex-shrink: 0;
background-color: #fff;
border-right: 1px solid #e5e5e5;
display: flex;
flex-direction: column;
overflow: visible;
.llms-focus-mode-sidebar-header {
padding: 15px 20px;
margin: 0;
font-size: 1rem;
font-weight: 600;
color: #333;
border-bottom: 1px solid #e5e5e5;
flex-shrink: 0;
h3 {
margin: 0;
font-size: inherit;
font-weight: inherit;
color: inherit;
}
}
.llms-focus-mode-sidebar-content {
flex: 1;
overflow-y: auto;
padding: 20px;
.llms-widget-syllabus:not(.llms-widget-syllabus--collapsible) {
.section-title {
font-weight: normal;
margin: 20px 0 10px;
}
.llms-section:first-child {
.section-title {
margin-top: 10px;
}
}
}
.llms-lesson-locked {
cursor: not-allowed;
}
}
}
// -- Sidebar toggle button (expanded state: floating pill on sidebar edge) --
.llms-focus-mode-sidebar-toggle {
position: absolute;
top: 20px;
right: -14px;
z-index: 11;
display: flex;
align-items: center;
justify-content: center;
width: 28px;
height: 28px;
padding: 0;
border: 1px solid #e5e5e5;
border-radius: 8px;
background: #fff;
box-shadow: 2px 0 4px rgba(0, 0, 0, 0.08);
cursor: pointer;
color: #666;
line-height: 1;
transition: background-color 0.15s ease, color 0.15s ease, box-shadow 0.15s ease;
&:hover {
color: #1d2327;
background: #f0f0f0;
box-shadow: 2px 0 6px rgba(0, 0, 0, 0.12);
}
svg {
width: 14px;
height: 14px;
fill: currentColor;
}
.llms-chevron-left {
display: block;
}
.llms-chevron-right {
display: none;
}
}
// -- Main wrapper: content + footer in a column that fills remaining space --
.llms-focus-mode-main {
flex: 1;
min-width: 0;
display: flex;
flex-direction: column;
overflow: hidden;
}
// -- Content: scrollable lesson area --
.llms-focus-mode-content {
flex: 1;
min-width: 0;
overflow-y: auto;
padding: 40px;
box-sizing: border-box;
@media (max-width: 768px) {
padding: 20px;
}
.llms-focus-mode-title {
margin: 0 0 30px;
font-size: 1.8rem;
font-weight: 700;
color: #1d2327;
}
.llms-lesson-content {
max-width: 100%;
img {
max-width: 100%;
height: auto;
}
}
}
// -- Footer: lesson action buttons pinned to bottom of content area --
.llms-focus-mode-footer {
flex-shrink: 0;
border-top: 1px solid #e5e5e5;
background: #fff;
box-sizing: border-box;
.clear {
display: none;
}
.llms-lesson-button-wrapper {
display: flex;
align-items: center;
justify-content: center;
gap: 10px;
margin: 0;
padding: 20px 10px;
.llms-form-field {
padding-top: 0;
padding-bottom: 0;
margin: 0;
}
}
&:not(.llms-focus-mode-footer--mobile) {
@media (max-width: 768px) {
display: none;
}
}
&.llms-focus-mode-footer--mobile {
display: none;
@media (max-width: 768px) {
display: block;
position: sticky;
bottom: 0;
z-index: 10;
}
}
}
// =============================================
// Sidebar collapsed state
// =============================================
&.llms-sidebar-collapsed {
.llms-focus-mode-sidebar {
width: $focus-sidebar-collapsed-width;
min-width: $focus-sidebar-collapsed-width;
overflow: hidden;
.llms-focus-mode-sidebar-header,
.llms-focus-mode-sidebar-content {
display: none;
}
.llms-focus-mode-sidebar-toggle {
position: static;
width: 100%;
height: 100%;
border: none;
border-radius: 0;
background: #fafafa;
box-shadow: none;
right: auto;
svg {
width: 18px;
height: 18px;
}
.llms-chevron-left {
display: none;
}
.llms-chevron-right {
display: block;
}
}
}
}
// =============================================
// Sidebar position: right
// =============================================
&.llms-focus-mode-sidebar-right {
.llms-focus-mode-body {
flex-direction: row-reverse;
}
.llms-focus-mode-sidebar {
border-right: 0;
border-left: 1px solid #e5e5e5;
}
.llms-focus-mode-sidebar-toggle {
right: auto;
left: -14px;
box-shadow: -2px 0 4px rgba(0, 0, 0, 0.08);
&:hover {
box-shadow: -2px 0 6px rgba(0, 0, 0, 0.12);
}
.llms-chevron-left {
display: none;
}
.llms-chevron-right {
display: block;
}
}
&.llms-sidebar-collapsed .llms-focus-mode-sidebar {
border-left: 0;
.llms-focus-mode-sidebar-toggle {
left: auto;
box-shadow: none;
.llms-chevron-left {
display: block;
}
.llms-chevron-right {
display: none;
}
}
}
}
// =============================================
// Content width variants
// =============================================
@each $width in 768, 960, 1180, 1600 {
&.llms-focus-mode-width-#{$width} .llms-focus-mode-content {
.llms-focus-mode-title,
.llms-lesson-content {
max-width: #{$width}px;
margin-left: auto;
margin-right: auto;
}
}
}
// =============================================
// Mobile: sidebar stacks below content
// =============================================
@media (max-width: 768px) {
.llms-focus-mode-body {
flex-direction: column;
overflow-y: auto;
}
.llms-focus-mode-main {
flex: none;
overflow-y: visible;
order: 1;
}
.llms-focus-mode-sidebar {
width: 100%;
min-width: 100%;
border-right: 0;
border-top: 1px solid #e5e5e5;
overflow: hidden;
order: 2;
.llms-focus-mode-sidebar-content {
overflow-y: visible;
}
}
.llms-focus-mode-sidebar-toggle {
display: none;
}
// Override collapsed state so the sidebar is always visible on mobile.
&.llms-sidebar-collapsed .llms-focus-mode-sidebar {
width: 100%;
min-width: 100%;
.llms-focus-mode-sidebar-header,
.llms-focus-mode-sidebar-content {
display: block;
}
}
// Sidebar-right doesn't need reversed direction on mobile.
&.llms-focus-mode-sidebar-right {
.llms-focus-mode-body {
flex-direction: column;
}
.llms-focus-mode-sidebar {
border-left: 0;
border-top: 1px solid #e5e5e5;
}
}
}
// Fix position of the Notes button.
.llms-note-button.position-fixed__top, .llms-note-wrapper {
top: 68px;
}
@media screen and (max-width: 782px) {
.llms-note-button.position-fixed__bottom {
bottom: 86px;
}
}
}
.admin-bar.llms-focus-mode {
.llms-focus-mode-wrapper {
display: flex;
flex-direction: column;
height: calc( 100dvh - $admin-bar-height );
overflow: hidden;
}
.llms-note-button.position-fixed__top, .llms-note-wrapper {
top: 100px;
}
@media screen and (max-width: 782px) {
.llms-note-button.position-fixed__top, .llms-note-wrapper {
top: 112px;
}
.llms-focus-mode-wrapper {
height: calc( 100dvh - $admin-bar-height-mobile );
}
}
}
================================================
FILE: assets/scss/frontend/_llms-access-plans.scss
================================================
.llms-access-plans {
@extend %clearfix;
@media all and (min-width: 600px) {
$cols: 1;
@while $cols <= 5 {
&.cols-#{$cols} .llms-access-plan {
width: calc( 100% / $cols );
}
$cols: $cols + 1;
}
}
}
.llms-free-enroll-form {
margin-bottom: 0;
}
.llms-access-plan {
box-sizing: border-box;
float: left;
text-align: center;
width: 100%;
.llms-access-plan-content,
.llms-access-plan-footer {
background: #f1f1f1;
}
&.featured {
.llms-access-plan-featured {
background: $color-brand-blue;
border-top-left-radius: $radius-small;
border-top-right-radius: $radius-small;
}
.llms-access-plan-content {
border-radius: 0;
}
.llms-access-plan-title {
border-top-left-radius: 0;
border-top-right-radius: 0;
}
.llms-access-plan-footer,
.llms-access-plan-content {
border-left: 3px solid $color-brand-blue;
border-right: 3px solid $color-brand-blue;
}
.llms-access-plan-footer {
border-bottom-color: $color-brand-blue;
}
}
&.on-sale {
.price-regular {
text-decoration: line-through;
.lifterlms-price {
font-weight: 400;
}
}
}
.stamp {
background: $color-brand-blue;
border-radius: $radius-small;
color: $color-white;
display: inline-block;
font-size: 14px;
font-style: normal;
font-weight: bold;
line-height: 1;
padding: 5px 8px 4px;
}
}
.llms-access-plan-featured {
color: #fff;
font-size: 14px;
font-weight: 700;
letter-spacing: 1px;
margin: 0 2px 0 2px;
padding: 5px 0 0;
}
.llms-access-plan-content {
border-top-right-radius: $radius-small;
border-top-left-radius: $radius-small;
margin: 0 2px 0;
overflow: hidden;
.llms-access-plan-pricing {
color: $color-black;
padding: 20px 0 0;
}
.llms-form-fields {
padding: 10px;
}
}
.llms-access-plan-title {
background: $color-brand-blue;
color: $color-white;
margin: 0;
padding: 10px 15px;
}
.llms-access-plan-pricing {
.llms-price-currency-symbol {
font-size: 14px;
vertical-align: top;
}
}
.llms-access-plan-price {
.lifterlms-price {
font-weight: 700;
}
&.sale {
padding: 5px 0;
border-top: 1px solid #d0d0d0;
border-bottom: 1px solid #d0d0d0;
}
}
.llms-access-plan-trial,
.llms-access-plan-schedule,
.llms-access-plan-sale-end,
.llms-access-plan-expiration {
font-size: 16px;
}
.llms-access-plan-description {
color: $color-black;
font-size: 16px;
padding: 10px 10px 0;
ul {
margin: 0;
li {
border-bottom: 1px solid #d0d0d0;
list-style-type: none;
&:last-child {
border-bottom: none;
}
}
}
div, img, p, ul, li {
&:last-child { margin-bottom: 0; }
}
}
.llms-access-plan-restrictions {
margin-top: 20px;
.stamp {
vertical-align: baseline;
}
ul {
margin: 5px 0 0 0;
padding: 0;
li {
font-size: 14px;
list-style-type: none;
margin: 0;
padding: 0;
}
}
a {
color: $color-orange;
&:hover {
color: $color-brand-orange-dark;
}
}
}
.llms-access-plan-footer {
border-bottom: 3px solid #f1f1f1;
border-bottom-left-radius: $radius-small;
border-bottom-right-radius: $radius-small;
padding: 15px;
margin: 0 2px 2px 2px;
.button {
display: inline-block;
}
.llms-access-plan-pricing {
padding: 0 0 10px;
}
}
.webui-popover-content .llms-members-only-restrictions {
text-align: center;
ul,ol,li,p {
margin: 0;
padding: 0;
}
ul,ol,li {
list-style-type: none;
}
li {
padding: 8px 0;
border-top: 1px solid #3b3b3b;
&:first-child {
border-top: none;
}
a {
display: block;
}
}
}
================================================
FILE: assets/scss/frontend/_llms-achievements-certs.scss
================================================
ul.llms-achievements-loop,
.lifterlms ul.llms-achievements-loop,
ul.llms-certificates-loop,
.lifterlms ul.llms-certificates-loop {
@include clearfix();
list-style-type: none;
margin: 0 -10px;
padding: 0;
li.llms-achievement-loop-item,
li.llms-certificate-loop-item {
box-sizing: border-box;
display: block;
float: left;
list-style-type: none;
margin: 0;
padding: 10px;
width: 100%;
}
@media all and (min-width: 600px) {
$cols: 1;
@while $cols <= 5 {
&.loop-cols-#{$cols} li.llms-achievement-loop-item,
&.loop-cols-#{$cols} li.llms-certificate-loop-item {
width: calc( 100% / $cols );
}
$cols: $cols + 1;
}
}
}
.llms-achievement,
.llms-certificate {
background: $color-white;
border: none;
border-radius: $radius-medium;
color: $color-black;
display: block;
padding: 20px 0;
text-decoration: none;
width: 100%;
&:hover {
background: #eaeaea;
}
.llms-achievement-img {
display: block;
margin: 0 auto;
max-width: 80%;
}
.llms-achievement-title {
color: $color-black;
font-size: 16px;
margin: 0;
padding: 10px;
text-align: center;
}
.llms-certificate-title {
color: $color-black;
font-size: 16px;
margin: 0;
padding: 0 0 10px;
}
.llms-achievement-info,
.llms-achievement-date {
display: none;
}
.llms-achievement-content {
padding: 20px;
&:empty {
padding: 0;
}
*:last-child {
margin-bottom: 0;
}
}
}
.llms-certificate {
border: 4px double $color-border;
padding: 20px 10px;
background: $color-white;
text-align: center;
&:hover {
background: $color-white;
border-color: #eaeaea;
}
}
.llms-achievement-modal {
.llms-achievement {
background: #fff;
}
.llms-achievement-info {
display: block;
}
.llms-achievement-title {
display: none;
}
}
================================================
FILE: assets/scss/frontend/_llms-author.scss
================================================
.llms-author {
.name {
margin-left: 5px;
}
.label {
margin-left: 5px;
}
.avatar {
border-radius: 50%;
}
.bio {
margin-top: 5px;
}
}
.llms-instructor-info {
margin: 40px 0;
.llms-meta-title {
margin: 0;
}
.llms-instructors {
.llms-col {
&:first-child .llms-author {
margin-left: 0;
}
&:last-child .llms-author {
margin-right: 0;
}
}
.llms-author {
background: $color-white;
border: 1px solid $color-border;
border-top: 4px solid $color-blue;
border-bottom-right-radius: $radius-small;
border-bottom-left-radius: $radius-small;
color: $color-black;
text-align: center;
margin: 45px 0 0;
padding: 0 20px 20px;
.avatar {
background: $color-brand-blue;
border: 4px solid $color-blue;
display: block;
margin: -35px auto 10px;
}
.llms-author-info {
display: block;
// margin: 0 0 5px;
&.name {
font-weight: 700;
}
&.label {
font-size: 85%;
}
&.bio {
font-size: 90%;
margin-bottom: 0;
}
}
}
}
}
================================================
FILE: assets/scss/frontend/_llms-notifications.scss
================================================
.llms-notification {
@include clearfix();
background: $color-white;
box-shadow: 0 1px 2px -2px #333, 0 1px 1px -1px #333;
border-top: 4px solid $color-blue;
color: $color-black;
opacity: 0;
padding: 12px;
position: fixed;
right: -800px;
top: 24px;
transition:
opacity 0.4s ease-in-out,
right 0.4s ease-in-out,
;
visibility: hidden;
width: auto;
z-index: 9999999;
&.visible {
left: 12px;
opacity: 1;
right: 12px;
transition:
opacity 0.4s ease-in-out,
right 0.4s ease-in-out,
top 0.1s ease-in-out,
background 0.2s ease-in-out,
transform 0.2s ease-in-out
;
visibility: visible;
&:hover {
.llms-notification-dismiss {
opacity: 1;
}
}
}
.llms-notification-content {
align-items: center;
display: flex;
}
.llms-notification-main {
align-self: flex-start;
flex: 4;
order: 2;
}
.llms-notification-title {
color: $color-black;
font-size: 18px;
margin: 0;
}
.llms-notification-body {
font-size: 14px;
line-height: 1.4;
p, li {
font-size: inherit;
}
p {
margin-bottom: 8px;
img {
max-width: 100%;
}
}
.llms-mini-cert {
background: #f6f6f6;
border: 1px solid #d0d0d0;
box-shadow: inset 0 0 0 3px #fefefe, inset 0 0 0 4px #dedede;
padding: 16px 16px 24px;
margin-top: 12px;
.llms-mini-cert-title {
font-size: 16px;
font-weight: 700;
margin: 12px auto;
text-align: center;
}
.llms-mini-cert--body {
width: 100%;
> div {
&:nth-child(1) { width:65%; }
&:nth-child(2) { width:35%; }
&:nth-child(3) { width:85%; }
&:nth-child(4) { width:75%; margin-top: 18px; }
&:nth-child(5) { width:70%; }
&:nth-child(6) { margin-left: 12px; margin-bottom:-24px; } // Dot.
&:nth-child(7) { width:65%; margin-right: 12px; }
}
}
.llms-mini-cert--mock-line {
border-radius: 2px;
height: 8px;
background: #b0b0b0;
background-image: linear-gradient( to right, #b0b0b0 0%, #a0a0a0 20%, #b0b0b0 40%, #b0b0b0 100% );
background-repeat: no-repeat;
margin: 4px auto;
}
.llms-mini-cert--mock-dot {
background: #b0b0b0;
border-radius: 50%;
display: inline-block;
content: '';
height: 24px;
width: 24px;
}
p { margin-bottom: 0; }
}
}
.llms-notification-aside {
align-self: flex-start;
flex: 1;
margin-right: 12px;
order: 1;
}
.llms-notification-icon {
display: block;
max-width: 64px;
}
.llms-notification-footer {
border-top: 1px solid #e5e5e5;
font-size: 12px;
margin-top: 12px;
padding: 6px 6px 0;
text-align: right;
a {
color: $color-black;
}
}
.llms-notification-dismiss {
color: $color-danger;
cursor: pointer;
font-size: 22px;
position: absolute;
right: 10px;
top: 8px;
transition: opacity 0.4s ease-in-out;
}
}
.llms-sd-notification-center {
.llms-notification-list,
.llms-notification-list-item {
list-style-type: none;
margin: 0;
padding: 0;
}
.llms-notification-list-item {
&:hover .llms-notification {
background: #fcfcfc;
}
}
.llms-notification {
opacity: 1;
border-top: 1px solid #e5e5e5;
left: auto;
padding: 24px;
position: relative;
right: auto;
top: auto;
visibility: visible;
width: auto;
.llms-notification-aside {
max-width: 64px;
}
.llms-notification-footer {
border: none;
padding: 0;
text-align: left;
}
.llms-progress {
display: none !important;
}
.llms-notification-date {
color: #515151;
float: left;
margin-right: 6px;
}
.llms-mini-cert {
margin: 0 auto;
max-width: 380px;
}
}
}
@media all and (min-width: 480px) {
.llms-notification {
right: -800px;
width: 360px;
&.visible {
left: auto;
right: 24px;
}
.llms-notification-dismiss {
opacity: 0;
}
}
}
================================================
FILE: assets/scss/frontend/_llms-outline-collapse.scss
================================================
.llms-widget-syllabus--collapsible {
.llms-section {
.section-header {
cursor: pointer;
}
&.llms-section--opened {
.llms-collapse-caret {
.fa-caret-right { display: none; }
}
}
&.llms-section--closed {
.llms-collapse-caret {
.fa-caret-down { display: none; }
}
.llms-lesson {
display: none;
}
}
}
.llms-syllabus-footer {
text-align: left;
}
}
================================================
FILE: assets/scss/frontend/_llms-pagination.scss
================================================
.llms-pagination {
ul {
list-style-type: none;
margin: 40px 0;
padding: 0;
@extend %cf;
li {
float: left;
a {
border-bottom: 0;
text-decoration: none;
}
.page-numbers {
padding: 0.5em;
text-decoration: underline;
&.current {
text-decoration: none;
}
}
}
}
}
================================================
FILE: assets/scss/frontend/_llms-progress.scss
================================================
/* progress bar */
.llms-progress {
clear: both;
display: flex;
flex-direction: row-reverse;
position: relative;
height: 1em;
width: 100%;
margin: 15px 0;
}
.llms-progress .llms-progress-bar {
background-color: $color-border;
position: relative;
height: .4em;
top: .3em;
width: 100%;
}
.llms-progress .progress-bar-complete {
background-color: $color-brand-pink;
height: 100%;
}
.progress__indicator {
float: right;
text-align: right;
height: 1em;
line-height: 1em;
margin-left: 5px;
white-space: nowrap;
}
================================================
FILE: assets/scss/frontend/_llms-quizzes.scss
================================================
.single-llms_quiz {
#llms-quiz-wrapper {
@import "../_includes/quiz-result-question-list";
}
.llms-return {
margin-bottom: 10px;
}
.llms-quiz-results {
@include clearfix();
.llms-donut {
&.passing {
color: $color-success;
svg path {
stroke: $color-success;
}
}
&.pending {
color: #555;
svg path {
stroke: #555;
}
}
&.failing {
color: $color-danger;
svg path {
stroke: $color-danger;
}
}
}
.llms-quiz-results-aside,
.llms-quiz-results-main,
.llms-quiz-results-history {
margin-bottom: 20px;
}
@media all and (min-width: 600px) {
.llms-quiz-results-aside {
float: left;
width: 220px;
+ .llms-quiz-results-main {
float: right;
width: calc( 100% - 300px );
+ .llms-quiz-results-history {
float: right;
width: calc( 100% - 300px );
}
}
}
.llms-quiz-results-history {
clear: right;
}
}
}
ul.llms-quiz-meta-info {
list-style-type: none;
margin: 0;
padding: 0;
li {
list-style-type: none;
margin: 10px 0 0;
padding: 0
}
}
ul.llms-quiz-meta-info {
margin-bottom: 10px;
}
.llms-quiz-buttons {
margin-top: 10px;
text-align: left;
form { display: inline-block; }
}
}
.llms-quiz-question-wrapper {
min-height: 140px;
position: relative;
.llms-quiz-loading {
bottom: 20px;
left: 0;
position: absolute;
right: 0;
text-align: center;
z-index: 1;
}
.llms-question-image {
img {
height: auto;
max-width: 100%;
}
}
}
.llms-quiz-ui {
position: relative;
.llms-quiz-header {
align-items: center;
display: flex;
margin: 0 0 40px;
}
.llms-progress {
background-color: $color-border;
flex-direction: row;
height: 8px;
margin: 0;
overflow: hidden;
.progress-bar-complete {
transition: width 0.3s ease-in;
width: 0;
}
}
.llms-error {
@include clearfix();
background: rgba( $color-red, .15 );
border: 1px solid $color-red;
border-radius: $radius-small;
margin: 20px 0;
padding: 15px;
a {
color: $color-red;
float: right;
font-size: 22px;
line-height: 1;
text-decoration: none;
}
}
.llms-quiz-counter {
display: none;
color: #6a6a6a;
float: right;
font-size: 18px;
.llms-sep {
margin: 0 5px;
}
}
.llms-quiz-nav {
margin-top: 20px;
button {
margin: 0 10px 0 0;
}
}
}
// single question wrapper
.llms-question-wrapper {
.llms-question-text {
font-size: 30px;
font-weight: 400;
margin-bottom: 15px;
}
.llms-question-choices {
border: none;
&.type--picture {
display: grid;
grid-template-columns: auto auto auto;
gap: 20px;
}
list-style-type: none;
margin: 0;
padding: 0;
.llms-choice {
border-bottom: 1px solid #e8e8e8;
margin: 0;
padding: 0;
position: relative;
&:last-child {
border-bottom: none;
}
label {
display: block;
margin: 0;
padding: 10px 20px;
position: relative;
}
input {
opacity: 0;
+ label {
display: inline-block;
cursor: pointer;
width: calc( 100% - 90px );
.llms-choice-text {
line-height: 1.6;
vertical-align: middle;
font-size: 18px;
font-weight: 400;
margin: 5px 0 0 0;
display: inline-block;
}
&:before {
content: attr(data-marker);
position: absolute;
background: $color-white;
color: $color-black;
display: flex;
left: -32px;
width: 40px;
font-size: 20px;
font-weight: inherit;
text-align: center;
height: 40px;
align-items: center;
justify-content: center;
transition: all 0.2s ease;
}
}
&[type="checkbox"] {
+ label:before {
border-radius: 4px;
}
}
&[type="radio"] {
+ label:before {
border-radius: 50%;
}
}
&:checked {
+ label:before {
background: $color-brand-pink;
color: #fff;
}
}
&:focus {
+ label:before {
box-shadow: 0 0px 8px $color-brand-pink;
}
}
&:not(:checked) {
+ label.hovered:before {
box-shadow: 0 0px 8px $color-brand-pink;
}
}
}
&.type--picture {
border-bottom: none;
label {
display: inline-block;
padding: 0;
height: auto;
&:before {
left: auto;
right: 10px;
bottom: 10px;
}
}
.llms-choice-image {
margin: 2px;
padding: 20px;
transition: background 0.4s ease;
img {
display: block;
height: auto;
width: 100%;
}
}
input:checked {
+ label .llms-choice-image {
background: #efefef
}
}
}
.llms-marker {
background: $color-white;
color: $color-black;
display: inline-block;
font-size: 20px;
height: 40px;
line-height: 40px;
margin-right: 10px;
text-align: center;
transition: all 0.2s ease;
vertical-align: middle;
width: 40px;
.fa {
display: none;
}
&.type--lister,
&.type--checkbox { border-radius: 4px; }
&.type--radio { border-radius: 50%; }
}
}
}
}
.llms-quiz-timer {
background: #fff;
border: 1px solid $color-green;
border-radius: 4px;
color: $color-green;
float: right;
font-size: 18px;
line-height: 1;
margin-left: 20px;
padding: 8px 12px;
position: relative;
white-space: nowrap;
z-index: 1;
&.color-half {
border-color: $color-orange;
color: $color-orange
}
&.color-empty {
border-color: $color-danger;
color: $color-danger
}
.llms-tiles {
display: inline-block;
margin-left: 5px;
}
}
// /* My Quizzes */
// .llms-quiz-results {
// @extend %cf;
// font-family: "Open Sans",Verdana,Geneva,sans-serif,sans-serif;
// position: relative;
// }
// .llms-quiz-results > h3 {
// background-color: #f5f5f5;
// padding: 4px;
// }
// .llms-quiz-result-details {
// float: left;
// ul {
// list-style-type: none;
// float: left;
// li {
// list-style-type: none;
// font-size: 20px;
// }
// }
// }
// .llms-attempts {
// font-weight: bold;
// }
// .llms-pass-perc {
// font-weight: bold;
// }
// .llms-content-block {
// margin: 6px 0;
// }
// .llms-question-wrapper {
// margin: 40px 0 20px 0;
// }
// .llms-question-count {
// margin-bottom: 20px;
// }
================================================
FILE: assets/scss/frontend/_llms-table.scss
================================================
.llms-table {
border: 1px solid $color-border;
border-spacing: 0;
width: 100%;
thead {
th,td {
font-weight: 700;
}
}
tbody {
tr:nth-child( odd ) {
td, th {
background: #f9f9f9;
}
}
tr:last-child {
border-bottom-width: 0;
}
}
tfoot {
tr {
background: #f9f9f9;
.llms-pagination .page-numbers {
margin: 0;
}
.llms-table-sort {
text-align: right;
form, select, input, button {
margin: 0;
}
}
}
}
th {
font-weight: 700;
}
th, td {
border-bottom: 1px solid $color-border;
padding: 15px 20px;
// launchpad compat...
&:first-child { padding-left: 12px; }
&:last-child { padding-right: 12px; }
}
}
// launchpad compat...
#page .llms-table tfoot label {
display: inline;
}
#page .llms-table tfoot select {
height: auto;
}
================================================
FILE: assets/scss/frontend/_loop.scss
================================================
.llms-loop-list {
display: grid;
// Default, the cols-X classes below should override.
grid-template-columns: repeat(3,minmax(0, 1fr));
gap: 20px;
.llms-loop-item {
list-style: none;
margin: 0;
padding: 0;
}
@media (max-width: 768px) {
grid-template-columns: repeat(1, 1fr);
}
list-style: none;
margin: 0 -10px;
padding: 0;
@media all and (min-width: 600px) {
$cols: 1;
@while $cols <= 6 {
&.cols-#{$cols} {
grid-template-columns: repeat($cols, minmax(0, 1fr));
}
$cols: $cols + 1;
}
}
}
.llms-loop-item {
list-style: none;
margin: 10px;
padding: 0;
background: $color-white;
border: 1px solid $color-border;
border-radius: $radius-small;
}
.llms-loop-item-content {
overflow: hidden;
padding-bottom: 15px;
margin: 0;
height: auto;
iframe {
max-width: 100%;
}
.llms-loop-link {
color: $color-black;
display: block;
text-decoration: none;
&:visited {
color: $color-black;
}
}
.llms-featured-image {
display: block;
max-width: 100%;
}
.llms-loop-title {
color: $color-black;
margin: 15px 0;
&:hover {
color: $color-brand-blue;
}
}
.llms-meta,
.llms-author,
.llms-loop-title,
.llms-featured-pricing
{
padding: 0 15px;
}
.llms-meta,
.llms-author,
.llms-featured-pricing
{
color: $color-cinder;
display: block;
font-size: 14px;
margin-bottom: 10px;
&:last-child {
margin-bottom: 0;
}
}
.llms-author {
align-items: center;
display: flex;
gap: 5px;
}
.llms-featured-img-wrap {
overflow: hidden;
}
p {
margin-bottom: 0;
}
.llms-progress {
margin: 0;
height: .4em;
.progress__indicator {
display: none;
}
.llms-progress-bar {
background-color: #f6f6f6;
right: 0;
top: 0;
}
}
}
// .llms-membership-list .memberships {
// border-top: 1px solid #f6f6f6;
// width: 100%;
// display: inline-block;
// text-align: center;
// list-style: none;
// clear: both;
// margin: 0;
// padding: 0;
// }
// .llms-course-list {
// .llms-membership-link {
// @extend %llms-element;
// display: block
// }
// .llms-membership-footer {
// border-top: 3px solid $color-white;
// margin: 15px -15px 0;
// padding: 15px 15px 0;
// text-align: center;
// }
// }
// .llms-membership-list .memberships li {
// width: 300px;
// margin: 15px;
// list-style: none;
// vertical-align: top;
// display: inline-block;
// text-align: left;
// }
// .llms-membership-list .memberships li.first {
// margin-left: 0;
// }
// .llms-membership-list .memberships li.last {
// margin-right: 15px;
// }
// .llms-membership-list .memberships li .llms-title {
// display: block;
// font-weight: 700;
// margin-bottom: .5em;
// font-size: 18px;
// text-decoration: none;
// line-height: 30px;
// }
// .llms-membership-list .memberships li .llms-price {
// display: block;
// font-weight: 700;
// // margin-bottom: .5em;
// // font-size: 24px;
// text-decoration: none;
// line-height: 30px;
// }
// .llms-course-list {
// //margin: 30px 0;
// padding: 30px;
// //background: #FFF;
// // border-radius: 2px;
// display: inline-block;
// width: 100%;
// box-sizing: border-box;
// .llms-course-link {
// @extend %llms-element;
// display: block
// }
// .llms-course-footer {
// border-top: 3px solid $color-white;
// margin: 15px -15px 0;
// padding: 15px 15px 0;
// text-align: center;
// }
// .llms-progress {
// margin-top: 0;
// // .progress-bar {
// // background-color: $color-white;
// // }
// }
// }
// .llms-course-list .courses {
// //border-top: 1px solid #f6f6f6;
// width: 100%;
// display: inline-block;
// text-align: center;
// list-style: none;
// clear: both;
// margin: 0;
// padding: 0;
// }
// .llms-course-list .courses li {
// width: 300px;
// padding-top: 0; // twentyfifteen compat
// margin: 15px;
// list-style: none;
// vertical-align: top;
// display: inline-block;
// text-align: left;
// }
// @media screen and (max-width: $break-small) {
// .llms-course-list {
// padding: 30px 10px;
// .courses li {
// width: auto;
// }
// }
// }
// // .llms-course-list .courses li.first {
// // margin-left: 0;
// // }
// .llms-course-list .courses li.last {
// margin-right: 15px;
// }
// .llms-course-list .courses li .llms-title {
// display: block;
// font-weight: 700;
// margin-bottom: .5em;
// font-size: 18px;
// text-decoration: none;
// line-height: 30px;
// }
// .llms-course-list .courses li .llms-price {
// display: block;
// font-weight: 700;
// // margin-bottom: .5em;
// // font-size: 24px;
// text-decoration: none;
// line-height: 30px;
// }
// .courses a.llms-course-link:hover {
// text-decoration: none;
// }
================================================
FILE: assets/scss/frontend/_main.scss
================================================
.llms-membership-image {
display: block;
margin: 0 auto;
}
.llms-course-image {
display: block;
margin: 0 auto;
max-width: 100%;
}
.llms-featured-image {
display: block;
margin: 0 auto;
}
.llms-image-thumb {
width: 150px;
}
// Responsive Videos.
.llms-video-wrapper {
.center-video {
height: auto;
max-width: 100%;
overflow: hidden;
position: relative;
padding-top: 56.25%;
text-align: center;
& > .wp-video,
.fluid-width-video-wrapper,
iframe, object, embed {
height: 100%;
left: 0;
position: absolute;
top: 0;
width: 100%;
}
& > .wp-video {
width: 100% !important;
}
.fluid-width-video-wrapper {
padding-top: 0 !important;
}
}
}
.clear {
clear: both;
width: 100%;
}
.llms-featured-image {
text-align: center;
}
#main-content .llms-payment-options p {
margin: 0;
font-size: 16px;
}
.llms-option {
display: block;
position: relative;
margin: 20px 0;
padding-left:40px;
font-size: 16px;
label {
cursor: pointer;
position: static;
}
}
.llms-option:first-child {
margin-top:0;
}
.llms-option:last-child {
margin-bottom:0;
}
#main-content .llms-option:last-child {
margin-bottom:0;
}
.llms-option input[type="radio"] {
display: block;
position: absolute;
top:3px;
left:0;
z-index: 0;
}
.llms-option input[type="radio"] {
display: inline-block;
}
.llms-option input[type="radio"] + label span.llms-radio {
display: none;
}
.llms-option input[type="radio"] + label span.llms-radio {
appearance: none;
z-index: 20;
position: absolute;
top: 0;
left: -2px;
display: inline-block;
width: 24px;
height: 24px;
border-radius: 50%;
cursor: pointer;
vertical-align: middle;
box-shadow: hsla(0,0%,100%,.15) 0 1px 1px, inset hsla(0,0%,0%,.5) 0 0 0 1px;
background: #efefef;
background-image: radial-gradient(ellipse at center, $color-red 0%,$color-red 40%,#efefef 45%);
background-repeat: no-repeat;
transition: background-position .15s cubic-bezier(.8, 0, 1, 1);
}
.llms-option input[type="radio"]:checked + label span.llms-radio {
transition: background-position .2s .15s cubic-bezier(0, 0, .2, 1);
}
.llms-option input[type="radio"] + label span.llms-radio {
background-position: -24px 0;
}
.llms-option input[type="radio"]:checked + label span.llms-radio {
background-position: 0 0;
}
.llms-option input[type="submit"] {
border:none;
background:$color-red;
color:#fff;
font-size:20px;
padding:10px 0;
border-radius:3px;
cursor:pointer;
width:100%;
}
.llms-styled-text {
padding: 14px 0;
}
.llms-notice-box {
border-radius: 3px;
z-index: 10;
margin: 10px 0;
padding: 15px 20px;
//background: #fffef4;
border: 1px solid #ccc;
list-style-type: none;
width: 100%;
overflow: auto;
input[type="text"] {
height: auto;
}
.col-1-1 {
width: 100%;
input[type=text] {
width: 100%;
}
}
.col-1-2 {
width: 50%;
float: left;
@media screen and (max-width: $break-medium) {
width: 100%;
}
}
.col-1-3 {
width: 33%;
float: left;
margin-right: 10px;
}
.col-1-4 {
width: 25%;
float: left;
margin-right: 10px;
@media screen and (max-width: $break-medium) {
width: 100%;
}
}
.col-1-6 {
width: 16.6%;
float: left;
margin-right: 10px;
}
.col-1-8 {
width: 11%;
float: right;
}
.llms-pad-right {
padding-right: 10px;
@media screen and (max-width: $break-medium) {
padding-right: 0;
}
}
}
input[type="text"].cc_cvv,
#cc_cvv {
margin-right: 0;
width: 23%;
float: right;
}
.llms-clear-box {
border-radius: 3px;
z-index: 10;
margin: 10px 0;
padding: 15px 20px;
list-style-type: none;
width: 100%;
overflow: auto;
}
.llms-price-label {
font-weight: normal;
}
.llms-final-price {
font-weight: bold;
float: right;
}
.llms-center-content {
text-align: center;
}
.llms-input-text {
background-color: #fff;
border: 1px solid #ddd;
color: #333;
font-size: 18px;
font-weight: 300;
padding: 16px;
width: 100%;
}
.llms-price {
margin-bottom: 0;
font-weight: bold;
}
.llms-price-loop {
margin-bottom: 0;
font-weight: bold;
}
// hentry overrides
.courses .entry {
padding: 0
}
.list-view .site-content .llms-course-list .hentry, .list-view .site-content .llms-membership-list .hentry {
border-top: 0;
padding-top: 0;
}
.llms-content {
width: 100%;
}
.llms-lesson-button-wrapper {
width: 100%;
display: block;
clear: both;
text-align: center;
}
.llms-template-wrapper {
width: 100%;
display: block;
clear: both;
}
.llms-button-wrapper {
width: 100%;
display: block;
clear: both;
text-align: center;
}
//custom select box
.llms-styled-select {
border: 1px solid #ccc;
box-sizing: border-box;
border-radius: 3px;
overflow: hidden;
position: relative;
}
.llms-styled-select, .llms-styled-select select {
width: 100%;
}
select:focus { outline: none; }
.llms-styled-select select {
height: 34px;
padding: 5px 0 5px 5px;
background: transparent;
border: none;
-webkit-appearance: none;
font-size: 16px;
color: #444444;
}
@-moz-document url-prefix(){
.--ms-styled-select select { width: 110%; }
}
.llms-styled-select .fa-sort-desc {
position: absolute;
top: 0;
right: 12px;
font-size: 24px;
color: #ccc;
}
select::-ms-expand { display: none; }
_:-o-prefocus, .selector {
.llms-styled-select { background: none; }
}
.llms-form-item-wrapper {
margin-bottom: 1em;
}
/* Circle Graph */
.llms-progress-circle {
position: relative;
width: 200px;
height: 200px;
float: left;
}
.llms-progress-circle-count {
top: 27%;
position: absolute;
width: 94%;
text-align: center;
color: #666;
font-size:44px;
}
.llms-progress-circle svg {
position: absolute;
width: 200px;
height: 200px;
}
.llms-progress-circle circle {
fill: transparent;
}
svg .llms-background-circle {
fill: transparent;
stroke-width: 10px;
stroke: #f1f2f1;
stroke-dasharray: 430;
}
svg .llms-animated-circle {
fill: transparent;
stroke-width: 10px;
stroke: #e5554e;
stroke-dasharray: 430;
stroke-dashoffset: 430 - 20
}
.llms-widget-syllabus {
.llms-lesson.current-lesson .lesson-title {
font-weight: 700;
}
.section-header {
display: flex;
gap: 5px;
.llms-collapse-caret {
text-align: left;
width: 14px;
}
}
.llms-lesson-complete, .lesson-complete-placeholder {
font-size: 18px;
margin-right: 5px;
color: #ccc;
&.done {
color: $color-brand-blue;
}
}.section-title {
font-weight: bold;
}.lesson-title {
a {
text-decoration: underline;
}
&.done {
a {
color: $color-darkgrey;
text-decoration: line-through;
}
}
}
ul {
list-style-type: none;
margin: 0;
padding: 0;
li {
list-style-type: none;
margin: 0 0 10px 0;
ul {
margin: 0 0 15px 0;
li {
align-items: flex-start;
display: flex;
margin: 0 0 10px 0;
padding: 0;
}
}
}
}
}
.llms-remove-coupon {
float: right;
}
/*.llms-lesson-link-locked, .llms-lesson-link-locked:hover {
background: #f1f1f1;
display: block;
color: #a6a6a6;
min-height: 85px;
padding: 15px;
text-decoration: none;
position: relative;
}*/
.llms-lesson-preview.is-complete .llms-lesson-link-locked {
padding-left: 75px;
}
.llms-lesson-tooltip { display: none;
position:absolute;
color: #000000;
background-color: #c0c0c0;
padding:.25em;
border-radius: 2px;
z-index: 100;
top:0;
left:50%;
text-align: center;
-webkit-transform: translateX(-50%) translateY(-100%);
transform: translateX(-50%) translateY(-100%);
}
/* arrows - :after */
.llms-lesson-tooltip:after {
content: "";
width: 0;
height: 0;
border-top: 8px solid #c0c0c0;
border-left: 8px solid transparent;
border-right: 8px solid transparent;
position:absolute;
bottom:-8px;
left:50%;
transform: translateX(-50%);
}
.llms-lesson-tooltip.active {
display: inline-block;
}
// Favorites.
.llms-favorite-wrapper {
cursor: pointer;
.fa-heart {
color: #EF476F;
}
button {
background: none;
border: none;
cursor: pointer;
padding: 0;
}
button:focus {
outline: 2px dashed #333;
outline-offset: 2px;
}
}
.llms-has-favorite .llms-parent-course-link {
display: inline-block;
margin-bottom: 20px;
+ .llms-favorite-wrapper {
float: right;
margin: 0;
}
}
.llms-syllabus-wrapper .llms-has-favorite {
text-align: left;
.llms-favorite-wrapper {
display: inline-block;
}
}
================================================
FILE: assets/scss/frontend/_notices.scss
================================================
.llms-notice {
background: rgba( $color-brand-blue, .3 );
border-color: $color-brand-blue;
border-style: solid;
border-width: 1px;
border-radius: $radius-small;
padding: 15px;
margin-bottom: 40px;
a {
color: inherit;
}
p, ul {
&:last-child { margin-bottom: 0; }
}
li {
list-style-type: none;
}
&.llms-debug {
background: rgba( #cacaca, .3 );
border-color: #cacaca;
}
&.llms-error {
background: rgba( $color-red, .15 );
border-color: $color-red;
}
&.llms-success {
background: rgba( $color-green, .15 );
border-color: $color-green;
}
}
// this helps genesis and numerous other themes out a bit
// by being slightly more specific
.entry-content .llms-notice {
margin: 0 0 40px;
li {
list-style-type: none;
}
}
================================================
FILE: assets/scss/frontend/_reviews.scss
================================================
.llms_review {
margin: 20px 0px;
padding: 10px;
h5 {
font-size: 17px;
margin: 3px 0px;
}
h6 {
font-size: 13px;
}
p {
font-size: 15px;
}
}
.review_box {
[type=text] {
margin: 10px 0px
}
.review_error {
color: red;
display: none;
}
+ .thank_you_box {
display: none;
}
}
================================================
FILE: assets/scss/frontend/_student-dashboard.scss
================================================
.llms-student-dashboard {
.llms-sd-nav select {
display: none;
@media all and ( max-width: 600px ) {
display: block;
margin-bottom: 30px;
width: 100%;
}
}
.llms-sd-title {
align-items: center;
display: flex;
gap: 15px;
margin: 40px 0 20px 0;
small {
font-size: 18px;
+ a {
text-decoration: none;
}
}
}
.llms-sd-items { // ul
list-style-type: none;
margin: 0 0 25px 0;
padding: 0;
}
.llms-sd-item { // li
display: inline-block;
list-style-type: none;
margin: 5px 0;
padding: 0;
&:last-child {
.llms-sep {
display: none;
}
}
.llms-sep {
color: $color-darkgrey;
margin: 0 5px;
}
}
.llms-sd-section {
h2 {
margin: 0 0 15px 0;
}
.llms-sd-section-title {
margin: 0;
padding: 0;
}
margin-bottom: 40px;
.llms-sd-section-title:first-child {
margin: 0 0 10px 0;
}
.llms-sd-section-footer {
margin-top: 10px;
a.llms-button-secondary {
display: inline-block;
}
}
.llms-certificates-loop {
margin: 0 0 0 -10px;
}
.llms-certificate {
padding: 20px 0;
}
}
.orders-table {
border: 1px solid $color-border;
border-spacing: 0;
width: 100%;
margin: 10px 0;
thead {
display: none;
th,td {
font-weight: 700;
}
@media all and ( min-width: 600px ) {
display: table-header-group;
}
}
tbody {
tr:nth-child( odd ) {
td, th {
background: #f9f9f9;
}
}
tr:last-child {
border-bottom-width: 0;
}
}
tfoot {
tr {
background: #f9f9f9;
}
th, td {
padding: 10px;
text-align: right;
&:last-child { border-bottom-width: 0; }
}
}
th {
font-weight: 700;
}
th, td {
border-color: $color-border;
border-style: solid;
border-width: 0;
display: block;
padding: 15px 20px;
text-align: center;
.llms-button-primary {
display: inline-block;
}
&:last-child {
border-bottom-width: 1px;
}
&:before {
content: attr( data-label );
}
@media all and ( min-width: 600px ) {
border-bottom-width: 1px;
display: table-cell;
text-align: left;
&:first-child { width: 220px; }
&:before { display: none; }
}
}
@media all and ( min-width: 600px ) {
&.transactions th:first-child {width: auto; }
}
}
@include order_status_badges();
.order-title {
.llms-status {
font-size: 18px;
}
}
.llms-person-form-wrapper {
.llms-change-password { display: none; }
}
.order-primary, .order-secondary {
width: 100%;
}
.order-secondary {
.llms-form-field {
padding: 10px 0;
}
}
.llms-switch-payment-source {
.llms-notice,
.entry-content .llms-notice {
margin-left: 10px;
margin-right: 10px;
}
}
.llms-switch-payment-source-main {
border: none;
display: none;
margin: 0;
ul.llms-payment-gateways {
padding: 10px 15px 0;
margin: 0;
}
.llms-payment-method,
ul.llms-order-summary {
padding: 0 25px 10px;
margin: 0;
list-style-type: none;
li { list-style-type: none; }
}
}
.llms-featured-pricing {
display: none;
}
/**
* Dashboard Home
*/
&.dashboard {
.llms-sd-section {
border: 1px solid $color-border;
border-radius: $radius-small;
padding: 20px;
margin-bottom: 40px;
}
}
.llms-loop-list {
margin: 20px 0;
}
}
.logged-in {
.llms-sd-layout-columns {
align-items: start;
@media all and ( min-width: 600px ) {
display: grid;
grid-gap: 25px;
grid-template-areas: "nav header" "nav tab";
grid-template-columns: 200px 1fr;
grid-template-rows: auto 1fr;
&:has(> .llms-notice) {
grid-template-areas: "nav header" "nav notice" "nav tab";
grid-template-rows: auto auto 1fr;
}
}
.llms-notice {
grid-area: notice;
}
.llms-sd-nav {
grid-area: nav;
.llms-sd-items {
display: none;
@media all and ( min-width: 600px ) {
display: block;
.llms-sd-item {
display: block;
float: none;
a {
display: block;
padding: 10px 0;
}
.llms-sep {
display: none;
}
}
}
}
}
.llms-sd-header {
grid-area: header;
}
.llms-sd-tab {
grid-area: tab;
}
}
}
// My Grades course list
.llms-sd-grades {
.llms-table {
.llms-progress {
display: block;
margin: 0;
.llms-progress-bar {
top: 0;
height: 1.4em;
}
.progress__indicator {
font-size: 1em;
position: relative;
right: 0.4em;
top: 0.2em;
z-index: 1;
}
}
}
}
// grades table for a single course
.llms-table.llms-single-course-grades {
tbody {
tr:first-child td, tr:first-child th {
background-color: #eaeaea;
}
}
th {
font-weight: 400;
text-align: left;
}
td {
.llms-donut {
display: inline-block;
vertical-align: middle;
}
.llms-status {
margin-right: 4px;
}
.llms-donut + .llms-status {
margin-left: 4px;
}
}
th.llms-section_title {
font-size: 110%;
font-weight: 700;
}
td.llms-lesson_title {
max-width: 40%;
}
td.llms-associated_quiz {
.llms-donut {
display: inline-block;
margin-right: 5px;
vertical-align: middle;
}
}
td.llms-lesson_title {
a[href="#"] {
pointer-events: none;
}
a[href^="#"] {
color: inherit;
position: relative;
.llms-tooltip {
max-width: 380px;
width: 380px;
&.show {
top: -54px;
}
}
}
}
}
.llms-sd-widgets {
display: flex;
.llms-sd-widget {
background: $color-white;
border: 1px solid $color-border;
border-bottom-right-radius: $radius-small;
border-bottom-left-radius: $radius-small;
flex: 1;
margin: 10px 10px 20px;
padding: 0 0 20px;
&:first-child {
margin-left: 0;
}
&:last-child {
margin-right: 0;
}
.llms-sd-widget-title {
background: $color-brand-blue;
color: #fff;
font-size: 18px;
line-height: 1;
margin: 0 0 20px;
padding: 10px;
}
.llms-sd-widget-empty {
font-size: 14px;
font-style: italic;
opacity: 0.5;
text-align: center;
}
.llms-donut {
margin: 0 auto;
}
.llms-sd-date {
opacity: 0.8;
text-align: center;
font-size: 22px;
line-height: 1.1;
span {
display: block;
&.day {
font-size: 52px;
}
&.diff {
font-size: 12px;
font-style: italic;
margin-top: 8px;
opacity: 0.75;
}
}
}
.llms-achievement {
background: transparent;
margin: 0 auto;
max-width: 120px;
.llms-achievement-title {
display: none;
}
}
}
}
.redeem-voucher {
.form-row {
label {
display: block;
font-weight: 700;
}
input[type="text"] {
background-color: $color-white;
background-clip: padding-box;
border: 1px solid $color-grey;
border-radius: $radius-small;
box-sizing: border-box;
font-size: 16px;
line-height: 1;
padding: 8px 12px;
transition: border-color 0.15s ease-in-out, box-shadow 0.15s ease-in-out;
}
}
}
.llms-sd-pagination {
margin-top: 24px;
@include clearfix;
.llms-button-secondary {
display: inline-block;
&.prev { float: left; }
&.next { float: right; }
}
}
.llms-sd-notification-center {
background: $color-white;
border: 1px solid $color-border;
border-radius: $radius-small;
padding: 20px;
.llms-notification-list-item {
.llms-notification {
z-index: 1;
&:hover {
background-color: inherit;
}
}
}
}
================================================
FILE: assets/scss/frontend/_syllabus.scss
================================================
.llms-syllabus-wrapper {
margin: 20px 0;
text-align: left;
.llms-section-title {
margin: 40px 0 10px;
+ .llms-lesson-preview {
border-top: 1px solid $color-border;
}
}
}
.llms-lesson-preview {
border-right: 1px solid $color-border;
border-bottom: 1px solid $color-border;
border-left: 1px solid $color-border;
display: block;
margin: 0;
max-width: 100%;
position: relative;
section {
background: $color-white;
}
&.current-lesson {
.llms-lesson-title {
font-weight: 400;
}
}
.llms-lesson-link {
color: $color-black;
display: block;
padding: 15px;
text-decoration: none;
transition: background-color 0.3s ease;
&:hover {
background: $el-background-hover;
}
&:visited {
color: #212121;
}
.llms-lesson-preview-row {
display: flex;
flex-direction: row-reverse;
}
}
.llms-lesson-locked {
background: #EFEFEF;
color: $color-darkgrey;
.llms-lesson-link {
color: $color-darkgrey;
}
&:hover {
background: $color-border;
}
}
.llms-lesson-thumbnail {
margin-bottom: 15px;
img {
display: block;
height: auto;
width: 100%;
}
}
.llms-lesson-title {
font-weight: 700;
margin: 0 auto 5px;
&:last-child {
margin-bottom: 0;
}
}
.llms-lesson-excerpt {
margin-top: 05px;
p {
margin: 0 0 10px 0;
padding: 0;
&:last-of-type {
margin: 0;
}
}
}
.llms-lesson-meta {
display: flex;
padding: 5px 15px;
font-size: 14px;
div.llms-favorite-wrapper + span.llms-lesson-has-quiz {
margin-left: 10px;
}
div.llms-favorite-wrapper + span.llms-lesson-has-assignment {
margin-left: 10px;
}
span.llms-lesson-has-quiz + span.llms-lesson-has-assignment {
margin-left: 10px;
}
}
.llms-main {
flex-grow: 1;
}
.llms-extra {
min-width: 50px;
text-align: right;
}
.llms-lesson-counter,
.llms-free-lesson-svg,
.llms-lesson-complete,
.llms-lesson-complete-placeholder {
display: block;
}
&.is-free,
&.is-complete {
.llms-lesson-complete {
color: $color-brand-blue;
}
}
&.is-complete {
.llms-lesson-title:not(.llms-student-dashboard .llms-lesson-title):not(.llms-course-navigation .llms-lesson-title) {
text-decoration: line-through;
}
}
.llms-icon-free {
background: $color-brand-blue;
border-radius: $radius-small;
color: $color-white;
display: inline-block;
font-size: 14px;
font-weight: bold;
line-height: 1;
padding: 5px 8px 4px;
white-space: nowrap;
}
&.is-incomplete {
.llms-lesson-complete {
color: #cacaca;
}
}
.llms-lesson-counter {
font-size: 16px;
margin-bottom: 5px;
}
.llms-free-lesson-svg {
fill: currentColor;
height: 23px;
width: 50px;
}
}
.llms-course-navigation {
display: flex;
gap: 20px;
.llms-prev-lesson,
.llms-next-lesson,
.llms-back-to-course {
flex: 1;
}
.llms-prev-lesson {
& + .llms-back-to-course {
text-align: right;
}
}
.llms-next-lesson {
.llms-lesson-preview {
.llms-lesson-link {
text-align: right;
}
}
}
.llms-lesson-preview {
border: 1px solid $color-border;
}
.llms-lesson-link {
display: block;
}
}
================================================
FILE: assets/scss/frontend/_tooltip.scss
================================================
.llms-tooltip {
background: #2a2a2a;
border-radius: 4px;
color: #fff;
font-size: 14px;
line-height: 1.2;
opacity: 0;
top: -20px;
padding: 8px 12px;
left: 50%;
position: absolute;
pointer-events: none;
transform: translateX( -50% );
transition: opacity .2s ease, top .2s ease;
max-width: 320px;
&.show {
top: -28px;
opacity: 1;
}
&:after {
bottom: -8px;
border-top: 8px solid #2a2a2a;
border-left: 8px solid transparent;
border-right: 8px solid transparent;
content: '';
height: 0;
left: 50%;
position: absolute;
transform: translateX( -50% );
width: 0;
}
}
.webui-popover-title {
font-size: initial;
font-weight: initial;
line-height: initial;
}
.webui-popover-inverse {
.webui-popover-inner .close {
color: #fff;
opacity: 0.6;
text-shadow: none;
&:hover {
opacity: 0.8;
}
}
.webui-popover-content a {
color: #fff;
text-decoration: underline;
&:hover {
text-decoration: none;
}
}
}
================================================
FILE: assets/scss/frontend/_voucher.scss
================================================
.voucher-expand {
display: none;
}
================================================
FILE: assets/scss/lifterlms.scss
================================================
//
// Main Frontend CSS File
//
@import "_includes/vars";
@import "_includes/extends";
@import "_includes/grid";
@import "_includes/mixins";
@import "_includes/buttons";
@import "_includes/llms-donut";
@import "_includes/tooltip";
@import "frontend/main";
@import "frontend/loop";
@import "frontend/course";
@import "frontend/syllabus";
@import "frontend/llms-progress";
@import "frontend/llms-author";
@import "frontend/reviews";
@import "frontend/notices";
@import "frontend/llms-achievements-certs";
@import "frontend/llms-notifications";
@import "frontend/llms-pagination";
@import "frontend/tooltip";
@import "frontend/llms-quizzes";
@import "frontend/voucher";
@import "frontend/llms-access-plans";
@import "frontend/checkout";
@import "_includes/llms-form-field";
@import "frontend/llms-outline-collapse";
@import "frontend/student-dashboard";
@import "frontend/llms-table";
@import "_includes/vendor/_font-awesome";
================================================
FILE: assets/scss/llms-focus-mode.scss
================================================
@import "frontend/focus-mode";
================================================
FILE: assets/vendor/a11y-dialog/LICENSE
================================================
The MIT License (MIT)
Copyright (c) 2024 Kitty Giraudel
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
================================================
FILE: assets/vendor/datetimepicker/jquery.datetimepicker.full.js
================================================
/*!
* @copyright Copyright © Kartik Visweswaran, Krajee.com, 2014 - 2016
* @version 1.3.4
*
* Date formatter utility library that allows formatting date/time variables or Date objects using PHP DateTime format.
* @see http://php.net/manual/en/function.date.php
*
* For more JQuery plugins visit http://plugins.krajee.com
* For more Yii related demos visit http://demos.krajee.com
*/var DateFormatter;!function(){"use strict";var t,e,r,n,a,u,i;u=864e5,i=3600,t=function(t,e){return"string"==typeof t&&"string"==typeof e&&t.toLowerCase()===e.toLowerCase()},e=function(t,r,n){var a=n||"0",u=t.toString();return u.length<r?e(a+u,r):u},r=function(t){var e,n;for(t=t||{},e=1;e<arguments.length;e++)if(n=arguments[e])for(var a in n)n.hasOwnProperty(a)&&("object"==typeof n[a]?r(t[a],n[a]):t[a]=n[a]);return t},n=function(t,e){for(var r=0;r<e.length;r++)if(e[r].toLowerCase()===t.toLowerCase())return r;return-1},a={dateSettings:{days:["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],daysShort:["Sun","Mon","Tue","Wed","Thu","Fri","Sat"],months:["January","February","March","April","May","June","July","August","September","October","November","December"],monthsShort:["Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],meridiem:["AM","PM"],ordinal:function(t){var e=t%10,r={1:"st",2:"nd",3:"rd"};return 1!==Math.floor(t%100/10)&&r[e]?r[e]:"th"}},separators:/[ \-+\/\.T:@]/g,validParts:/[dDjlNSwzWFmMntLoYyaABgGhHisueTIOPZcrU]/g,intParts:/[djwNzmnyYhHgGis]/g,tzParts:/\b(?:[PMCEA][SDP]T|(?:Pacific|Mountain|Central|Eastern|Atlantic) (?:Standard|Daylight|Prevailing) Time|(?:GMT|UTC)(?:[-+]\d{4})?)\b/g,tzClip:/[^-+\dA-Z]/g},DateFormatter=function(t){var e=this,n=r(a,t);e.dateSettings=n.dateSettings,e.separators=n.separators,e.validParts=n.validParts,e.intParts=n.intParts,e.tzParts=n.tzParts,e.tzClip=n.tzClip},DateFormatter.prototype={constructor:DateFormatter,getMonth:function(t){var e,r=this;return e=n(t,r.dateSettings.monthsShort)+1,0===e&&(e=n(t,r.dateSettings.months)+1),e},parseDate:function(e,r){var n,a,u,i,s,o,c,f,l,h,d=this,g=!1,m=!1,p=d.dateSettings,y={date:null,year:null,month:null,day:null,hour:0,min:0,sec:0};if(!e)return null;if(e instanceof Date)return e;if("U"===r)return u=parseInt(e),u?new Date(1e3*u):e;switch(typeof e){case"number":return new Date(e);case"string":break;default:return null}if(n=r.match(d.validParts),!n||0===n.length)throw new Error("Invalid date format definition.");for(a=e.replace(d.separators,"\x00").split("\x00"),u=0;u<a.length;u++)switch(i=a[u],s=parseInt(i),n[u]){case"y":case"Y":if(!s)return null;l=i.length,y.year=2===l?parseInt((70>s?"20":"19")+i):s,g=!0;break;case"m":case"n":case"M":case"F":if(isNaN(s)){if(o=d.getMonth(i),!(o>0))return null;y.month=o}else{if(!(s>=1&&12>=s))return null;y.month=s}g=!0;break;case"d":case"j":if(!(s>=1&&31>=s))return null;y.day=s,g=!0;break;case"g":case"h":if(c=n.indexOf("a")>-1?n.indexOf("a"):n.indexOf("A")>-1?n.indexOf("A"):-1,h=a[c],c>-1)f=t(h,p.meridiem[0])?0:t(h,p.meridiem[1])?12:-1,s>=1&&12>=s&&f>-1?y.hour=s+f-1:s>=0&&23>=s&&(y.hour=s);else{if(!(s>=0&&23>=s))return null;y.hour=s}m=!0;break;case"G":case"H":if(!(s>=0&&23>=s))return null;y.hour=s,m=!0;break;case"i":if(!(s>=0&&59>=s))return null;y.min=s,m=!0;break;case"s":if(!(s>=0&&59>=s))return null;y.sec=s,m=!0}if(g===!0&&y.year&&y.month&&y.day)y.date=new Date(y.year,y.month-1,y.day,y.hour,y.min,y.sec,0);else{if(m!==!0)return null;y.date=new Date(0,0,0,y.hour,y.min,y.sec,0)}return y.date},guessDate:function(t,e){if("string"!=typeof t)return t;var r,n,a,u,i,s,o=this,c=t.replace(o.separators,"\x00").split("\x00"),f=/^[djmn]/g,l=e.match(o.validParts),h=new Date,d=0;if(!f.test(l[0]))return t;for(a=0;a<c.length;a++){if(d=2,i=c[a],s=parseInt(i.substr(0,2)),isNaN(s))return null;switch(a){case 0:"m"===l[0]||"n"===l[0]?h.setMonth(s-1):h.setDate(s);break;case 1:"m"===l[0]||"n"===l[0]?h.setDate(s):h.setMonth(s-1);break;case 2:if(n=h.getFullYear(),r=i.length,d=4>r?r:4,n=parseInt(4>r?n.toString().substr(0,4-r)+i:i.substr(0,4)),!n)return null;h.setFullYear(n);break;case 3:h.setHours(s);break;case 4:h.setMinutes(s);break;case 5:h.setSeconds(s)}u=i.substr(d),u.length>0&&c.splice(a+1,0,u)}return h},parseFormat:function(t,r){var n,a=this,s=a.dateSettings,o=/\\?(.?)/gi,c=function(t,e){return n[t]?n[t]():e};return n={d:function(){return e(n.j(),2)},D:function(){return s.daysShort[n.w()]},j:function(){return r.getDate()},l:function(){return s.days[n.w()]},N:function(){return n.w()||7},w:function(){return r.getDay()},z:function(){var t=new Date(n.Y(),n.n()-1,n.j()),e=new Date(n.Y(),0,1);return Math.round((t-e)/u)},W:function(){var t=new Date(n.Y(),n.n()-1,n.j()-n.N()+3),r=new Date(t.getFullYear(),0,4);return e(1+Math.round((t-r)/u/7),2)},F:function(){return s.months[r.getMonth()]},m:function(){return e(n.n(),2)},M:function(){return s.monthsShort[r.getMonth()]},n:function(){return r.getMonth()+1},t:function(){return new Date(n.Y(),n.n(),0).getDate()},L:function(){var t=n.Y();return t%4===0&&t%100!==0||t%400===0?1:0},o:function(){var t=n.n(),e=n.W(),r=n.Y();return r+(12===t&&9>e?1:1===t&&e>9?-1:0)},Y:function(){return r.getFullYear()},y:function(){return n.Y().toString().slice(-2)},a:function(){return n.A().toLowerCase()},A:function(){var t=n.G()<12?0:1;return s.meridiem[t]},B:function(){var t=r.getUTCHours()*i,n=60*r.getUTCMinutes(),a=r.getUTCSeconds();return e(Math.floor((t+n+a+i)/86.4)%1e3,3)},g:function(){return n.G()%12||12},G:function(){return r.getHours()},h:function(){return e(n.g(),2)},H:function(){return e(n.G(),2)},i:function(){return e(r.getMinutes(),2)},s:function(){return e(r.getSeconds(),2)},u:function(){return e(1e3*r.getMilliseconds(),6)},e:function(){var t=/\((.*)\)/.exec(String(r))[1];return t||"Coordinated Universal Time"},I:function(){var t=new Date(n.Y(),0),e=Date.UTC(n.Y(),0),r=new Date(n.Y(),6),a=Date.UTC(n.Y(),6);return t-e!==r-a?1:0},O:function(){var t=r.getTimezoneOffset(),n=Math.abs(t);return(t>0?"-":"+")+e(100*Math.floor(n/60)+n%60,4)},P:function(){var t=n.O();return t.substr(0,3)+":"+t.substr(3,2)},T:function(){var t=(String(r).match(a.tzParts)||[""]).pop().replace(a.tzClip,"");return t||"UTC"},Z:function(){return 60*-r.getTimezoneOffset()},c:function(){return"Y-m-d\\TH:i:sP".replace(o,c)},r:function(){return"D, d M Y H:i:s O".replace(o,c)},U:function(){return r.getTime()/1e3||0}},c(t,t)},formatDate:function(t,e){var r,n,a,u,i,s=this,o="",c="\\";if("string"==typeof t&&(t=s.parseDate(t,e),!t))return null;if(t instanceof Date){for(a=e.length,r=0;a>r;r++)i=e.charAt(r),"S"!==i&&i!==c&&(r>0&&e.charAt(r-1)===c?o+=i:(u=s.parseFormat(i,t),r!==a-1&&s.intParts.test(i)&&"S"===e.charAt(r+1)&&(n=parseInt(u)||0,u+=s.dateSettings.ordinal(n)),o+=u));return o}return""}}}();
/**
* @preserve jQuery DateTimePicker
* @homepage http://xdsoft.net/jqplugins/datetimepicker/
* @author Chupurnov Valeriy (<chupurnov@gmail.com>)
*/
/**
* @param {jQuery} $
*/
var datetimepickerFactory = function ($) {
'use strict';
var default_options = {
i18n: {
ar: { // Arabic
months: [
"كانون الثاني", "شباط", "آذار", "نيسان", "مايو", "حزيران", "تموز", "آب", "أيلول", "تشرين الأول", "تشرين الثاني", "كانون الأول"
],
dayOfWeekShort: [
"ن", "ث", "ع", "خ", "ج", "س", "ح"
],
dayOfWeek: ["الأحد", "الاثنين", "الثلاثاء", "الأربعاء", "الخميس", "الجمعة", "السبت", "الأحد"]
},
ro: { // Romanian
months: [
"Ianuarie", "Februarie", "Martie", "Aprilie", "Mai", "Iunie", "Iulie", "August", "Septembrie", "Octombrie", "Noiembrie", "Decembrie"
],
dayOfWeekShort: [
"Du", "Lu", "Ma", "Mi", "Jo", "Vi", "Sâ"
],
dayOfWeek: ["Duminică", "Luni", "Marţi", "Miercuri", "Joi", "Vineri", "Sâmbătă"]
},
id: { // Indonesian
months: [
"Januari", "Februari", "Maret", "April", "Mei", "Juni", "Juli", "Agustus", "September", "Oktober", "November", "Desember"
],
dayOfWeekShort: [
"Min", "Sen", "Sel", "Rab", "Kam", "Jum", "Sab"
],
dayOfWeek: ["Minggu", "Senin", "Selasa", "Rabu", "Kamis", "Jumat", "Sabtu"]
},
is: { // Icelandic
months: [
"Janúar", "Febrúar", "Mars", "Apríl", "Maí", "Júní", "Júlí", "Ágúst", "September", "Október", "Nóvember", "Desember"
],
dayOfWeekShort: [
"Sun", "Mán", "Þrið", "Mið", "Fim", "Fös", "Lau"
],
dayOfWeek: ["Sunnudagur", "Mánudagur", "Þriðjudagur", "Miðvikudagur", "Fimmtudagur", "Föstudagur", "Laugardagur"]
},
bg: { // Bulgarian
months: [
"Януари", "Февруари", "Март", "Април", "Май", "Юни", "Юли", "Август", "Септември", "Октомври", "Ноември", "Декември"
],
dayOfWeekShort: [
"Нд", "Пн", "Вт", "Ср", "Чт", "Пт", "Сб"
],
dayOfWeek: ["Неделя", "Понеделник", "Вторник", "Сряда", "Четвъртък", "Петък", "Събота"]
},
fa: { // Persian/Farsi
months: [
'فروردین', 'اردیبهشت', 'خرداد', 'تیر', 'مرداد', 'شهریور', 'مهر', 'آبان', 'آذر', 'دی', 'بهمن', 'اسفند'
],
dayOfWeekShort: [
'یکشنبه', 'دوشنبه', 'سه شنبه', 'چهارشنبه', 'پنجشنبه', 'جمعه', 'شنبه'
],
dayOfWeek: ["یکشنبه", "دوشنبه", "سهشنبه", "چهارشنبه", "پنجشنبه", "جمعه", "شنبه", "یکشنبه"]
},
ru: { // Russian
months: [
'Январь', 'Февраль', 'Март', 'Апрель', 'Май', 'Июнь', 'Июль', 'Август', 'Сентябрь', 'Октябрь', 'Ноябрь', 'Декабрь'
],
dayOfWeekShort: [
"Вс", "Пн", "Вт", "Ср", "Чт", "Пт", "Сб"
],
dayOfWeek: ["Воскресенье", "Понедельник", "Вторник", "Среда", "Четверг", "Пятница", "Суббота"]
},
uk: { // Ukrainian
months: [
'Січень', 'Лютий', 'Березень', 'Квітень', 'Травень', 'Червень', 'Липень', 'Серпень', 'Вересень', 'Жовтень', 'Листопад', 'Грудень'
],
dayOfWeekShort: [
"Ндл", "Пнд", "Втр", "Срд", "Чтв", "Птн", "Сбт"
],
dayOfWeek: ["Неділя", "Понеділок", "Вівторок", "Середа", "Четвер", "П'ятниця", "Субота"]
},
en: { // English
months: [
"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"
],
dayOfWeekShort: [
"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
],
dayOfWeek: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
},
el: { // Ελληνικά
months: [
"Ιανουάριος", "Φεβρουάριος", "Μάρτιος", "Απρίλιος", "Μάιος", "Ιούνιος", "Ιούλιος", "Αύγουστος", "Σεπτέμβριος", "Οκτώβριος", "Νοέμβριος", "Δεκέμβριος"
],
dayOfWeekShort: [
"Κυρ", "Δευ", "Τρι", "Τετ", "Πεμ", "Παρ", "Σαβ"
],
dayOfWeek: ["Κυριακή", "Δευτέρα", "Τρίτη", "Τετάρτη", "Πέμπτη", "Παρασκευή", "Σάββατο"]
},
de: { // German
months: [
'Januar', 'Februar', 'März', 'April', 'Mai', 'Juni', 'Juli', 'August', 'September', 'Oktober', 'November', 'Dezember'
],
dayOfWeekShort: [
"So", "Mo", "Di", "Mi", "Do", "Fr", "Sa"
],
dayOfWeek: ["Sonntag", "Montag", "Dienstag", "Mittwoch", "Donnerstag", "Freitag", "Samstag"]
},
nl: { // Dutch
months: [
"januari", "februari", "maart", "april", "mei", "juni", "juli", "augustus", "september", "oktober", "november", "december"
],
dayOfWeekShort: [
"zo", "ma", "di", "wo", "do", "vr", "za"
],
dayOfWeek: ["zondag", "maandag", "dinsdag", "woensdag", "donderdag", "vrijdag", "zaterdag"]
},
tr: { // Turkish
months: [
"Ocak", "Şubat", "Mart", "Nisan", "Mayıs", "Haziran", "Temmuz", "Ağustos", "Eylül", "Ekim", "Kasım", "Aralık"
],
dayOfWeekShort: [
"Paz", "Pts", "Sal", "Çar", "Per", "Cum", "Cts"
],
dayOfWeek: ["Pazar", "Pazartesi", "Salı", "Çarşamba", "Perşembe", "Cuma", "Cumartesi"]
},
fr: { //French
months: [
"Janvier", "Février", "Mars", "Avril", "Mai", "Juin", "Juillet", "Août", "Septembre", "Octobre", "Novembre", "Décembre"
],
dayOfWeekShort: [
"Dim", "Lun", "Mar", "Mer", "Jeu", "Ven", "Sam"
],
dayOfWeek: ["dimanche", "lundi", "mardi", "mercredi", "jeudi", "vendredi", "samedi"]
},
es: { // Spanish
months: [
"Enero", "Febrero", "Marzo", "Abril", "Mayo", "Junio", "Julio", "Agosto", "Septiembre", "Octubre", "Noviembre", "Diciembre"
],
dayOfWeekShort: [
"Dom", "Lun", "Mar", "Mié", "Jue", "Vie", "Sáb"
],
dayOfWeek: ["Domingo", "Lunes", "Martes", "Miércoles", "Jueves", "Viernes", "Sábado"]
},
th: { // Thai
months: [
'มกราคม', 'กุมภาพันธ์', 'มีนาคม', 'เมษายน', 'พฤษภาคม', 'มิถุนายน', 'กรกฎาคม', 'สิงหาคม', 'กันยายน', 'ตุลาคม', 'พฤศจิกายน', 'ธันวาคม'
],
dayOfWeekShort: [
'อา.', 'จ.', 'อ.', 'พ.', 'พฤ.', 'ศ.', 'ส.'
],
dayOfWeek: ["อาทิตย์", "จันทร์", "อังคาร", "พุธ", "พฤหัส", "ศุกร์", "เสาร์", "อาทิตย์"]
},
pl: { // Polish
months: [
"styczeń", "luty", "marzec", "kwiecień", "maj", "czerwiec", "lipiec", "sierpień", "wrzesień", "październik", "listopad", "grudzień"
],
dayOfWeekShort: [
"nd", "pn", "wt", "śr", "cz", "pt", "sb"
],
dayOfWeek: ["niedziela", "poniedziałek", "wtorek", "środa", "czwartek", "piątek", "sobota"]
},
pt: { // Portuguese
months: [
"Janeiro", "Fevereiro", "Março", "Abril", "Maio", "Junho", "Julho", "Agosto", "Setembro", "Outubro", "Novembro", "Dezembro"
],
dayOfWeekShort: [
"Dom", "Seg", "Ter", "Qua", "Qui", "Sex", "Sab"
],
dayOfWeek: ["Domingo", "Segunda", "Terça", "Quarta", "Quinta", "Sexta", "Sábado"]
},
ch: { // Simplified Chinese
months: [
"一月", "二月", "三月", "四月", "五月", "六月", "七月", "八月", "九月", "十月", "十一月", "十二月"
],
dayOfWeekShort: [
"日", "一", "二", "三", "四", "五", "六"
]
},
se: { // Swedish
months: [
"Januari", "Februari", "Mars", "April", "Maj", "Juni", "Juli", "Augusti", "September", "Oktober", "November", "December"
],
dayOfWeekShort: [
"Sön", "Mån", "Tis", "Ons", "Tor", "Fre", "Lör"
]
},
km: { // Khmer (ភាសាខ្មែរ)
months: [
"មករា", "កុម្ភៈ", "មិនា", "មេសា", "ឧសភា", "មិថុនា", "កក្កដា", "សីហា", "កញ្ញា", "តុលា", "វិច្ឆិកា", "ធ្នូ"
],
dayOfWeekShort: ["អាទិ", "ច័ន្ទ", "អង្គារ", "ពុធ", "ព្រហ", "សុក្រ", "សៅរ៍"],
dayOfWeek: ["អាទិត្យ", "ច័ន្ទ", "អង្គារ", "ពុធ", "ព្រហស្បតិ៍", "សុក្រ", "សៅរ៍"]
},
kr: { // Korean
months: [
"1월", "2월", "3월", "4월", "5월", "6월", "7월", "8월", "9월", "10월", "11월", "12월"
],
dayOfWeekShort: [
"일", "월", "화", "수", "목", "금", "토"
],
dayOfWeek: ["일요일", "월요일", "화요일", "수요일", "목요일", "금요일", "토요일"]
},
it: { // Italian
months: [
"Gennaio", "Febbraio", "Marzo", "Aprile", "Maggio", "Giugno", "Luglio", "Agosto", "Settembre", "Ottobre", "Novembre", "Dicembre"
],
dayOfWeekShort: [
"Dom", "Lun", "Mar", "Mer", "Gio", "Ven", "Sab"
],
dayOfWeek: ["Domenica", "Lunedì", "Martedì", "Mercoledì", "Giovedì", "Venerdì", "Sabato"]
},
da: { // Dansk
months: [
"Januar", "Februar", "Marts", "April", "Maj", "Juni", "Juli", "August", "September", "Oktober", "November", "December"
],
dayOfWeekShort: [
"Søn", "Man", "Tir", "Ons", "Tor", "Fre", "Lør"
],
dayOfWeek: ["søndag", "mandag", "tirsdag", "onsdag", "torsdag", "fredag", "lørdag"]
},
no: { // Norwegian
months: [
"Januar", "Februar", "Mars", "April", "Mai", "Juni", "Juli", "August", "September", "Oktober", "November", "Desember"
],
dayOfWeekShort: [
"Søn", "Man", "Tir", "Ons", "Tor", "Fre", "Lør"
],
dayOfWeek: ['Søndag', 'Mandag', 'Tirsdag', 'Onsdag', 'Torsdag', 'Fredag', 'Lørdag']
},
ja: { // Japanese
months: [
"1月", "2月", "3月", "4月", "5月", "6月", "7月", "8月", "9月", "10月", "11月", "12月"
],
dayOfWeekShort: [
"日", "月", "火", "水", "木", "金", "土"
],
dayOfWeek: ["日曜", "月曜", "火曜", "水曜", "木曜", "金曜", "土曜"]
},
vi: { // Vietnamese
months: [
"Tháng 1", "Tháng 2", "Tháng 3", "Tháng 4", "Tháng 5", "Tháng 6", "Tháng 7", "Tháng 8", "Tháng 9", "Tháng 10", "Tháng 11", "Tháng 12"
],
dayOfWeekShort: [
"CN", "T2", "T3", "T4", "T5", "T6", "T7"
],
dayOfWeek: ["Chủ nhật", "Thứ hai", "Thứ ba", "Thứ tư", "Thứ năm", "Thứ sáu", "Thứ bảy"]
},
sl: { // Slovenščina
months: [
"Januar", "Februar", "Marec", "April", "Maj", "Junij", "Julij", "Avgust", "September", "Oktober", "November", "December"
],
dayOfWeekShort: [
"Ned", "Pon", "Tor", "Sre", "Čet", "Pet", "Sob"
],
dayOfWeek: ["Nedelja", "Ponedeljek", "Torek", "Sreda", "Četrtek", "Petek", "Sobota"]
},
cs: { // Čeština
months: [
"Leden", "Únor", "Březen", "Duben", "Květen", "Červen", "Červenec", "Srpen", "Září", "Říjen", "Listopad", "Prosinec"
],
dayOfWeekShort: [
"Ne", "Po", "Út", "St", "Čt", "Pá", "So"
]
},
hu: { // Hungarian
months: [
"Január", "Február", "Március", "Április", "Május", "Június", "Július", "Augusztus", "Szeptember", "Október", "November", "December"
],
dayOfWeekShort: [
"Va", "Hé", "Ke", "Sze", "Cs", "Pé", "Szo"
],
dayOfWeek: ["vasárnap", "hétfő", "kedd", "szerda", "csütörtök", "péntek", "szombat"]
},
az: { //Azerbaijanian (Azeri)
months: [
"Yanvar", "Fevral", "Mart", "Aprel", "May", "Iyun", "Iyul", "Avqust", "Sentyabr", "Oktyabr", "Noyabr", "Dekabr"
],
dayOfWeekShort: [
"B", "Be", "Ça", "Ç", "Ca", "C", "Ş"
],
dayOfWeek: ["Bazar", "Bazar ertəsi", "Çərşənbə axşamı", "Çərşənbə", "Cümə axşamı", "Cümə", "Şənbə"]
},
bs: { //Bosanski
months: [
"Januar", "Februar", "Mart", "April", "Maj", "Jun", "Jul", "Avgust", "Septembar", "Oktobar", "Novembar", "Decembar"
],
dayOfWeekShort: [
"Ned", "Pon", "Uto", "Sri", "Čet", "Pet", "Sub"
],
dayOfWeek: ["Nedjelja","Ponedjeljak", "Utorak", "Srijeda", "Četvrtak", "Petak", "Subota"]
},
ca: { //Català
months: [
"Gener", "Febrer", "Març", "Abril", "Maig", "Juny", "Juliol", "Agost", "Setembre", "Octubre", "Novembre", "Desembre"
],
dayOfWeekShort: [
"Dg", "Dl", "Dt", "Dc", "Dj", "Dv", "Ds"
],
dayOfWeek: ["Diumenge", "Dilluns", "Dimarts", "Dimecres", "Dijous", "Divendres", "Dissabte"]
},
'en-GB': { //English (British)
months: [
"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"
],
dayOfWeekShort: [
"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"
],
dayOfWeek: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
},
et: { //"Eesti"
months: [
"Jaanuar", "Veebruar", "Märts", "Aprill", "Mai", "Juuni", "Juuli", "August", "September", "Oktoober", "November", "Detsember"
],
dayOfWeekShort: [
"P", "E", "T", "K", "N", "R", "L"
],
dayOfWeek: ["Pühapäev", "Esmaspäev", "Teisipäev", "Kolmapäev", "Neljapäev", "Reede", "Laupäev"]
},
eu: { //Euskara
months: [
"Urtarrila", "Otsaila", "Martxoa", "Apirila", "Maiatza", "Ekaina", "Uztaila", "Abuztua", "Iraila", "Urria", "Azaroa", "Abendua"
],
dayOfWeekShort: [
"Ig.", "Al.", "Ar.", "Az.", "Og.", "Or.", "La."
],
dayOfWeek: ['Igandea', 'Astelehena', 'Asteartea', 'Asteazkena', 'Osteguna', 'Ostirala', 'Larunbata']
},
fi: { //Finnish (Suomi)
months: [
"Tammikuu", "Helmikuu", "Maaliskuu", "Huhtikuu", "Toukokuu", "Kesäkuu", "Heinäkuu", "Elokuu", "Syyskuu", "Lokakuu", "Marraskuu", "Joulukuu"
],
dayOfWeekShort: [
"Su", "Ma", "Ti", "Ke", "To", "Pe", "La"
],
dayOfWeek: ["sunnuntai", "maanantai", "tiistai", "keskiviikko", "torstai", "perjantai", "lauantai"]
},
gl: { //Galego
months: [
"Xan", "Feb", "Maz", "Abr", "Mai", "Xun", "Xul", "Ago", "Set", "Out", "Nov", "Dec"
],
dayOfWeekShort: [
"Dom", "Lun", "Mar", "Mer", "Xov", "Ven", "Sab"
],
dayOfWeek: ["Domingo", "Luns", "Martes", "Mércores", "Xoves", "Venres", "Sábado"]
},
hr: { //Hrvatski
months: [
"Siječanj", "Veljača", "Ožujak", "Travanj", "Svibanj", "Lipanj", "Srpanj", "Kolovoz", "Rujan", "Listopad", "Studeni", "Prosinac"
],
dayOfWeekShort: [
"Ned", "Pon", "Uto", "Sri", "Čet", "Pet", "Sub"
],
dayOfWeek: ["Nedjelja", "Ponedjeljak", "Utorak", "Srijeda", "Četvrtak", "Petak", "Subota"]
},
ko: { //Korean (한국어)
months: [
"1월", "2월", "3월", "4월", "5월", "6월", "7월", "8월", "9월", "10월", "11월", "12월"
],
dayOfWeekShort: [
"일", "월", "화", "수", "목", "금", "토"
],
dayOfWeek: ["일요일", "월요일", "화요일", "수요일", "목요일", "금요일", "토요일"]
},
lt: { //Lithuanian (lietuvių)
months: [
"Sausio", "Vasario", "Kovo", "Balandžio", "Gegužės", "Birželio", "Liepos", "Rugpjūčio", "Rugsėjo", "Spalio", "Lapkričio", "Gruodžio"
],
dayOfWeekShort: [
"Sek", "Pir", "Ant", "Tre", "Ket", "Pen", "Šeš"
],
dayOfWeek: ["Sekmadienis", "Pirmadienis", "Antradienis", "Trečiadienis", "Ketvirtadienis", "Penktadienis", "Šeštadienis"]
},
lv: { //Latvian (Latviešu)
months: [
"Janvāris", "Februāris", "Marts", "Aprīlis ", "Maijs", "Jūnijs", "Jūlijs", "Augusts", "Septembris", "Oktobris", "Novembris", "Decembris"
],
dayOfWeekShort: [
"Sv", "Pr", "Ot", "Tr", "Ct", "Pk", "St"
],
dayOfWeek: ["Svētdiena", "Pirmdiena", "Otrdiena", "Trešdiena", "Ceturtdiena", "Piektdiena", "Sestdiena"]
},
mk: { //Macedonian (Македонски)
months: [
"јануари", "февруари", "март", "април", "мај", "јуни", "јули", "август", "септември", "октомври", "ноември", "декември"
],
dayOfWeekShort: [
"нед", "пон", "вто", "сре", "чет", "пет", "саб"
],
dayOfWeek: ["Недела", "Понеделник", "Вторник", "Среда", "Четврток", "Петок", "Сабота"]
},
mn: { //Mongolian (Монгол)
months: [
"1-р сар", "2-р сар", "3-р сар", "4-р сар", "5-р сар", "6-р сар", "7-р сар", "8-р сар", "9-р сар", "10-р сар", "11-р сар", "12-р сар"
],
dayOfWeekShort: [
"Дав", "Мяг", "Лха", "Пүр", "Бсн", "Бям", "Ням"
],
dayOfWeek: ["Даваа", "Мягмар", "Лхагва", "Пүрэв", "Баасан", "Бямба", "Ням"]
},
'pt-BR': { //Português(Brasil)
months: [
"Janeiro", "Fevereiro", "Março", "Abril", "Maio", "Junho", "Julho", "Agosto", "Setembro", "Outubro", "Novembro", "Dezembro"
],
dayOfWeekShort: [
"Dom", "Seg", "Ter", "Qua", "Qui", "Sex", "Sáb"
],
dayOfWeek: ["Domingo", "Segunda", "Terça", "Quarta", "Quinta", "Sexta", "Sábado"]
},
sk: { //Slovenčina
months: [
"Január", "Február", "Marec", "Apríl", "Máj", "Jún", "Júl", "August", "September", "Október", "November", "December"
],
dayOfWeekShort: [
"Ne", "Po", "Ut", "St", "Št", "Pi", "So"
],
dayOfWeek: ["Nedeľa", "Pondelok", "Utorok", "Streda", "Štvrtok", "Piatok", "Sobota"]
},
sq: { //Albanian (Shqip)
months: [
"Janar", "Shkurt", "Mars", "Prill", "Maj", "Qershor", "Korrik", "Gusht", "Shtator", "Tetor", "Nëntor", "Dhjetor"
],
dayOfWeekShort: [
"Die", "Hën", "Mar", "Mër", "Enj", "Pre", "Shtu"
],
dayOfWeek: ["E Diel", "E Hënë", "E Martē", "E Mërkurë", "E Enjte", "E Premte", "E Shtunë"]
},
'sr-YU': { //Serbian (Srpski)
months: [
"Januar", "Februar", "Mart", "April", "Maj", "Jun", "Jul", "Avgust", "Septembar", "Oktobar", "Novembar", "Decembar"
],
dayOfWeekShort: [
"Ned", "Pon", "Uto", "Sre", "čet", "Pet", "Sub"
],
dayOfWeek: ["Nedelja","Ponedeljak", "Utorak", "Sreda", "Četvrtak", "Petak", "Subota"]
},
sr: { //Serbian Cyrillic (Српски)
months: [
"јануар", "фебруар", "март", "април", "мај", "јун", "јул", "август", "септембар", "октобар", "новембар", "децембар"
],
dayOfWeekShort: [
"нед", "пон", "уто", "сре", "чет", "пет", "суб"
],
dayOfWeek: ["Недеља","Понедељак", "Уторак", "Среда", "Четвртак", "Петак", "Субота"]
},
sv: { //Svenska
months: [
"Januari", "Februari", "Mars", "April", "Maj", "Juni", "Juli", "Augusti", "September", "Oktober", "November", "December"
],
dayOfWeekShort: [
"Sön", "Mån", "Tis", "Ons", "Tor", "Fre", "Lör"
],
dayOfWeek: ["Söndag", "Måndag", "Tisdag", "Onsdag", "Torsdag", "Fredag", "Lördag"]
},
'zh-TW': { //Traditional Chinese (繁體中文)
months: [
"一月", "二月", "三月", "四月", "五月", "六月", "七月", "八月", "九月", "十月", "十一月", "十二月"
],
dayOfWeekShort: [
"日", "一", "二", "三", "四", "五", "六"
],
dayOfWeek: ["星期日", "星期一", "星期二", "星期三", "星期四", "星期五", "星期六"]
},
zh: { //Simplified Chinese (简体中文)
months: [
"一月", "二月", "三月", "四月", "五月", "六月", "七月", "八月", "九月", "十月", "十一月", "十二月"
],
dayOfWeekShort: [
"日", "一", "二", "三", "四", "五", "六"
],
dayOfWeek: ["星期日", "星期一", "星期二", "星期三", "星期四", "星期五", "星期六"]
},
ug:{ // Uyghur(ئۇيغۇرچە)
months: [
"1-ئاي","2-ئاي","3-ئاي","4-ئاي","5-ئاي","6-ئاي","7-ئاي","8-ئاي","9-ئاي","10-ئاي","11-ئاي","12-ئاي"
],
dayOfWeek: [
"يەكشەنبە", "دۈشەنبە","سەيشەنبە","چارشەنبە","پەيشەنبە","جۈمە","شەنبە"
]
},
he: { //Hebrew (עברית)
months: [
'ינואר', 'פברואר', 'מרץ', 'אפריל', 'מאי', 'יוני', 'יולי', 'אוגוסט', 'ספטמבר', 'אוקטובר', 'נובמבר', 'דצמבר'
],
dayOfWeekShort: [
'א\'', 'ב\'', 'ג\'', 'ד\'', 'ה\'', 'ו\'', 'שבת'
],
dayOfWeek: ["ראשון", "שני", "שלישי", "רביעי", "חמישי", "שישי", "שבת", "ראשון"]
},
hy: { // Armenian
months: [
"Հունվար", "Փետրվար", "Մարտ", "Ապրիլ", "Մայիս", "Հունիս", "Հուլիս", "Օգոստոս", "Սեպտեմբեր", "Հոկտեմբեր", "Նոյեմբեր", "Դեկտեմբեր"
],
dayOfWeekShort: [
"Կի", "Երկ", "Երք", "Չոր", "Հնգ", "Ուրբ", "Շբթ"
],
dayOfWeek: ["Կիրակի", "Երկուշաբթի", "Երեքշաբթի", "Չորեքշաբթի", "Հինգշաբթի", "Ուրբաթ", "Շաբաթ"]
},
kg: { // Kyrgyz
months: [
'Үчтүн айы', 'Бирдин айы', 'Жалган Куран', 'Чын Куран', 'Бугу', 'Кулжа', 'Теке', 'Баш Оона', 'Аяк Оона', 'Тогуздун айы', 'Жетинин айы', 'Бештин айы'
],
dayOfWeekShort: [
"Жек", "Дүй", "Шей", "Шар", "Бей", "Жум", "Ише"
],
dayOfWeek: [
"Жекшемб", "Дүйшөмб", "Шейшемб", "Шаршемб", "Бейшемби", "Жума", "Ишенб"
]
},
rm: { // Romansh
months: [
"Schaner", "Favrer", "Mars", "Avrigl", "Matg", "Zercladur", "Fanadur", "Avust", "Settember", "October", "November", "December"
],
dayOfWeekShort: [
"Du", "Gli", "Ma", "Me", "Gie", "Ve", "So"
],
dayOfWeek: [
"Dumengia", "Glindesdi", "Mardi", "Mesemna", "Gievgia", "Venderdi", "Sonda"
]
},
ka: { // Georgian
months: [
'იანვარი', 'თებერვალი', 'მარტი', 'აპრილი', 'მაისი', 'ივნისი', 'ივლისი', 'აგვისტო', 'სექტემბერი', 'ოქტომბერი', 'ნოემბერი', 'დეკემბერი'
],
dayOfWeekShort: [
"კვ", "ორშ", "სამშ", "ოთხ", "ხუთ", "პარ", "შაბ"
],
dayOfWeek: ["კვირა", "ორშაბათი", "სამშაბათი", "ოთხშაბათი", "ხუთშაბათი", "პარასკევი", "შაბათი"]
}
},
ownerDocument: document,
contentWindow: window,
value: '',
rtl: false,
format: 'Y/m/d H:i',
formatTime: 'H:i',
formatDate: 'Y/m/d',
startDate: false, // new Date(), '1986/12/08', '-1970/01/05','-1970/01/05',
step: 60,
monthChangeSpinner: true,
closeOnDateSelect: false,
closeOnTimeSelect: true,
closeOnWithoutClick: true,
closeOnInputClick: true,
openOnFocus: true,
timepicker: true,
datepicker: true,
weeks: false,
defaultTime: false, // use formatTime format (ex. '10:00' for formatTime: 'H:i')
defaultDate: false, // use formatDate format (ex new Date() or '1986/12/08' or '-1970/01/05' or '-1970/01/05')
minDate: false,
maxDate: false,
minTime: false,
maxTime: false,
minDateTime: false,
disabledMinTime: false,
disabledMaxTime: false,
allowTimes: [],
opened: false,
initTime: true,
inline: false,
theme: '',
touchMovedThreshold: 5,
onSelectDate: function () {},
onSelectTime: function () {},
onChangeMonth: function () {},
onGetWeekOfYear: function () {},
onChangeYear: function () {},
onChangeDateTime: function () {},
onShow: function () {},
onClose: function () {},
onGenerate: function () {},
withoutCopyright: true,
inverseButton: false,
hours12: false,
next: 'xdsoft_next',
prev : 'xdsoft_prev',
dayOfWeekStart: 0,
parentID: 'body',
timeHeightInTimePicker: 25,
timepickerScrollbar: true,
todayButton: true,
prevButton: true,
nextButton: true,
defaultSelect: true,
scrollMonth: true,
scrollTime: true,
scrollInput: true,
lazyInit: false,
mask: false,
validateOnBlur: true,
allowBlank: true,
yearStart: 1950,
yearEnd: 2050,
monthStart: 0,
monthEnd: 11,
style: '',
id: '',
fixed: false,
roundTime: 'round', // ceil, floor
className: '',
weekends: [],
highlightedDates: [],
highlightedPeriods: [],
allowDates : [],
allowDateRe : null,
disabledDates : [],
disabledWeekDays: [],
yearOffset: 0,
beforeShowDay: null,
enterLikeTab: true,
showApplyButton: false
};
var dateHelper = null,
defaultDateHelper = null,
globalLocaleDefault = 'en',
globalLocale = 'en';
var dateFormatterOptionsDefault = {
meridiem: ['AM', 'PM']
};
var initDateFormatter = function(){
var locale = default_options.i18n[globalLocale],
opts = {
days: locale.dayOfWeek,
daysShort: locale.dayOfWeekShort,
months: locale.months,
monthsShort: $.map(locale.months, function(n){ return n.substring(0, 3) })
};
if (typeof DateFormatter === 'function') {
dateHelper = defaultDateHelper = new DateFormatter({
dateSettings: $.extend({}, dateFormatterOptionsDefault, opts)
});
}
};
var dateFormatters = {
moment: {
default_options:{
format: 'YYYY/MM/DD HH:mm',
formatDate: 'YYYY/MM/DD',
formatTime: 'HH:mm',
},
formatter: {
parseDate: function (date, format) {
if(isFormatStandard(format)){
return defaultDateHelper.parseDate(date, format);
}
var d = moment(date, format);
return d.isValid() ? d.toDate() : false;
},
formatDate: function (date, format) {
if(isFormatStandard(format)){
return defaultDateHelper.formatDate(date, format);
}
return moment(date).format(format);
},
formatMask: function(format){
return format
.replace(/Y{4}/g, '9999')
.replace(/Y{2}/g, '99')
.replace(/M{2}/g, '19')
.replace(/D{2}/g, '39')
.replace(/H{2}/g, '29')
.replace(/m{2}/g, '59')
.replace(/s{2}/g, '59');
},
}
}
}
// for locale settings
$.datetimepicker = {
setLocale: function(locale){
var newLocale = default_options.i18n[locale] ? locale : globalLocaleDefault;
if (globalLocale !== newLocale) {
globalLocale = newLocale;
// reinit date formatter
initDateFormatter();
}
},
setDateFormatter: function(dateFormatter) {
if(typeof dateFormatter === 'string' && dateFormatters.hasOwnProperty(dateFormatter)){
var df = dateFormatters[dateFormatter];
$.extend(default_options, df.default_options);
dateHelper = df.formatter;
}
else {
dateHelper = dateFormatter;
}
},
};
var standardFormats = {
RFC_2822: 'D, d M Y H:i:s O',
ATOM: 'Y-m-d\TH:i:sP',
ISO_8601: 'Y-m-d\TH:i:sO',
RFC_822: 'D, d M y H:i:s O',
RFC_850: 'l, d-M-y H:i:s T',
RFC_1036: 'D, d M y H:i:s O',
RFC_1123: 'D, d M Y H:i:s O',
RSS: 'D, d M Y H:i:s O',
W3C: 'Y-m-d\TH:i:sP'
}
var isFormatStandard = function(format){
return Object.values(standardFormats).indexOf(format) === -1 ? false : true;
}
$.extend($.datetimepicker, standardFormats);
// first init date formatter
initDateFormatter();
// fix for ie8
if (!window.getComputedStyle) {
window.getComputedStyle = function (el) {
this.el = el;
this.getPropertyValue = function (prop) {
var re = /(-([a-z]))/g;
if (prop === 'float') {
prop = 'styleFloat';
}
if (re.test(prop)) {
prop = prop.replace(re, function (a, b, c) {
return c.toUpperCase();
});
}
return el.currentStyle[prop] || null;
};
return this;
};
}
if (!Array.prototype.indexOf) {
Array.prototype.indexOf = function (obj, start) {
var i, j;
for (i = (start || 0), j = this.length; i < j; i += 1) {
if (this[i] === obj) { return i; }
}
return -1;
};
}
Date.prototype.countDaysInMonth = function () {
return new Date(this.getFullYear(), this.getMonth() + 1, 0).getDate();
};
$.fn.xdsoftScroller = function (options, percent) {
return this.each(function () {
var timeboxparent = $(this),
pointerEventToXY = function (e) {
var out = {x: 0, y: 0},
touch;
if (e.type === 'touchstart' || e.type === 'touchmove' || e.type === 'touchend' || e.type === 'touchcancel') {
touch = e.originalEvent.touches[0] || e.originalEvent.changedTouches[0];
out.x = touch.clientX;
out.y = touch.clientY;
} else if (e.type === 'mousedown' || e.type === 'mouseup' || e.type === 'mousemove' || e.type === 'mouseover' || e.type === 'mouseout' || e.type === 'mouseenter' || e.type === 'mouseleave') {
out.x = e.clientX;
out.y = e.clientY;
}
return out;
},
timebox,
parentHeight,
height,
scrollbar,
scroller,
maximumOffset = 100,
start = false,
startY = 0,
startTop = 0,
h1 = 0,
touchStart = false,
startTopScroll = 0,
calcOffset = function () {};
if (percent === 'hide') {
timeboxparent.find('.xdsoft_scrollbar').hide();
return;
}
if (!$(this).hasClass('xdsoft_scroller_box')) {
timebox = timeboxparent.children().eq(0);
parentHeight = timeboxparent[0].clientHeight;
height = timebox[0].offsetHeight;
scrollbar = $('<div class="xdsoft_scrollbar"></div>');
scroller = $('<div class="xdsoft_scroller"></div>');
scrollbar.append(scroller);
timeboxparent.addClass('xdsoft_scroller_box').append(scrollbar);
calcOffset = function calcOffset(event) {
var offset = pointerEventToXY(event).y - startY + startTopScroll;
if (offset < 0) {
offset = 0;
}
if (offset + scroller[0].offsetHeight > h1) {
offset = h1 - scroller[0].offsetHeight;
}
timeboxparent.trigger('scroll_element.xdsoft_scroller', [maximumOffset ? offset / maximumOffset : 0]);
};
scroller
.on('touchstart.xdsoft_scroller mousedown.xdsoft_scroller', function (event) {
if (!parentHeight) {
timeboxparent.trigger('resize_scroll.xdsoft_scroller', [percent]);
}
startY = pointerEventToXY(event).y;
startTopScroll = parseInt(scroller.css('margin-top'), 10);
h1 = scrollbar[0].offsetHeight;
if (event.type === 'mousedown' || event.type === 'touchstart') {
if (options.ownerDocument) {
$(options.ownerDocument.body).addClass('xdsoft_noselect');
}
$([options.ownerDocument.body, options.contentWindow]).on('touchend mouseup.xdsoft_scroller', function arguments_callee() {
$([options.ownerDocument.body, options.contentWindow]).off('touchend mouseup.xdsoft_scroller', arguments_callee)
.off('mousemove.xdsoft_scroller', calcOffset)
.removeClass('xdsoft_noselect');
});
$(options.ownerDocument.body).on('mousemove.xdsoft_scroller', calcOffset);
} else {
touchStart = true;
event.stopPropagation();
event.preventDefault();
}
})
.on('touchmove', function (event) {
if (touchStart) {
event.preventDefault();
calcOffset(event);
}
})
.on('touchend touchcancel', function () {
touchStart = false;
startTopScroll = 0;
});
timeboxparent
.on('scroll_element.xdsoft_scroller', function (event, percentage) {
if (!parentHeight) {
timeboxparent.trigger('resize_scroll.xdsoft_scroller', [percentage, true]);
}
percentage = percentage > 1 ? 1 : (percentage < 0 || isNaN(percentage)) ? 0 : percentage;
scroller.css('margin-top', maximumOffset * percentage);
setTimeout(function () {
timebox.css('marginTop', -parseInt((timebox[0].offsetHeight - parentHeight) * percentage, 10));
}, 10);
})
.on('resize_scroll.xdsoft_scroller', function (event, percentage, noTriggerScroll) {
var percent, sh;
parentHeight = timeboxparent[0].clientHeight;
height = timebox[0].offsetHeight;
percent = parentHeight / height;
sh = percent * scrollbar[0].offsetHeight;
if (percent > 1) {
scroller.hide();
} else {
scroller.show();
scroller.css('height', parseInt(sh > 10 ? sh : 10, 10));
maximumOffset = scrollbar[0].offsetHeight - scroller[0].offsetHeight;
if (noTriggerScroll !== true) {
timeboxparent.trigger('scroll_element.xdsoft_scroller', [percentage || Math.abs(parseInt(timebox.css('marginTop'), 10)) / (height - parentHeight)]);
}
}
});
timeboxparent.on('mousewheel', function (event) {
var top = Math.abs(parseInt(timebox.css('marginTop'), 10));
top = top - (event.deltaY * 20);
if (top < 0) {
top = 0;
}
timeboxparent.trigger('scroll_element.xdsoft_scroller', [top / (height - parentHeight)]);
event.stopPropagation();
return false;
});
timeboxparent.on('touchstart', function (event) {
start = pointerEventToXY(event);
startTop = Math.abs(parseInt(timebox.css('marginTop'), 10));
});
timeboxparent.on('touchmove', function (event) {
if (start) {
event.preventDefault();
var coord = pointerEventToXY(event);
timeboxparent.trigger('scroll_element.xdsoft_scroller', [(startTop - (coord.y - start.y)) / (height - parentHeight)]);
}
});
timeboxparent.on('touchend touchcancel', function () {
start = false;
startTop = 0;
});
}
timeboxparent.trigger('resize_scroll.xdsoft_scroller', [percent]);
});
};
$.fn.datetimepicker = function (opt, opt2) {
var result = this,
KEY0 = 48,
KEY9 = 57,
_KEY0 = 96,
_KEY9 = 105,
CTRLKEY = 17,
DEL = 46,
ENTER = 13,
ESC = 27,
BACKSPACE = 8,
ARROWLEFT = 37,
ARROWUP = 38,
ARROWRIGHT = 39,
ARROWDOWN = 40,
TAB = 9,
F5 = 116,
AKEY = 65,
CKEY = 67,
VKEY = 86,
ZKEY = 90,
YKEY = 89,
ctrlDown = false,
options = ($.isPlainObject(opt) || !opt) ? $.extend(true, {}, default_options, opt) : $.extend(true, {}, default_options),
lazyInitTimer = 0,
createDateTimePicker,
destroyDateTimePicker,
lazyInit = function (input) {
input
.on('open.xdsoft focusin.xdsoft mousedown.xdsoft touchstart', function initOnActionCallback() {
if (input.is(':disabled') || input.data('xdsoft_datetimepicker')) {
return;
}
clearTimeout(lazyInitTimer);
lazyInitTimer = setTimeout(function () {
if (!input.data('xdsoft_datetimepicker')) {
createDateTimePicker(input);
}
input
.off('open.xdsoft focusin.xdsoft mousedown.xdsoft touchstart', initOnActionCallback)
.trigger('open.xdsoft');
}, 100);
});
};
createDateTimePicker = function (input) {
var datetimepicker = $('<div class="xdsoft_datetimepicker xdsoft_noselect"></div>'),
xdsoft_copyright = $('<div class="xdsoft_copyright"><a target="_blank" href="http://xdsoft.net/jqplugins/datetimepicker/">xdsoft.net</a></div>'),
datepicker = $('<div class="xdsoft_datepicker active"></div>'),
month_picker = $('<div class="xdsoft_monthpicker"><button type="button" class="xdsoft_prev"></button><button type="button" class="xdsoft_today_button"></button>' +
'<div class="xdsoft_label xdsoft_month"><span></span><i></i></div>' +
'<div class="xdsoft_label xdsoft_year"><span></span><i></i></div>' +
'<button type="button" class="xdsoft_next"></button></div>'),
calendar = $('<div class="xdsoft_calendar"></div>'),
timepicker = $('<div class="xdsoft_timepicker active"><button type="button" class="xdsoft_prev"></button><div class="xdsoft_time_box"></div><button type="button" class="xdsoft_next"></button></div>'),
timeboxparent = timepicker.find('.xdsoft_time_box').eq(0),
timebox = $('<div class="xdsoft_time_variant"></div>'),
applyButton = $('<button type="button" class="xdsoft_save_selected blue-gradient-button">Save Selected</button>'),
monthselect = $('<div class="xdsoft_select xdsoft_monthselect"><div></div></div>'),
yearselect = $('<div class="xdsoft_select xdsoft_yearselect"><div></div></div>'),
triggerAfterOpen = false,
XDSoft_datetime,
xchangeTimer,
timerclick,
current_time_index,
setPos,
timer = 0,
_xdsoft_datetime,
forEachAncestorOf;
if (options.id) {
datetimepicker.attr('id', options.id);
}
if (options.style) {
datetimepicker.attr('style', options.style);
}
if (options.weeks) {
datetimepicker.addClass('xdsoft_showweeks');
}
if (options.rtl) {
datetimepicker.addClass('xdsoft_rtl');
}
datetimepicker.addClass('xdsoft_' + options.theme);
datetimepicker.addClass(options.className);
month_picker
.find('.xdsoft_month span')
.after(monthselect);
month_picker
.find('.xdsoft_year span')
.after(yearselect);
month_picker
.find('.xdsoft_month,.xdsoft_year')
.on('touchstart mousedown.xdsoft', function (event) {
var select = $(this).find('.xdsoft_select').eq(0),
val = 0,
top = 0,
visible = select.is(':visible'),
items,
i;
month_picker
.find('.xdsoft_select')
.hide();
if (_xdsoft_datetime.currentTime) {
val = _xdsoft_datetime.currentTime[$(this).hasClass('xdsoft_month') ? 'getMonth' : 'getFullYear']();
}
select[visible ? 'hide' : 'show']();
for (items = select.find('div.xdsoft_option'), i = 0; i < items.length; i += 1) {
if (items.eq(i).data('value') === val) {
break;
} else {
top += items[0].offsetHeight;
}
}
select.xdsoftScroller(options, top / (select.children()[0].offsetHeight - (select[0].clientHeight)));
event.stopPropagation();
return false;
});
var handleTouchMoved = function (event) {
this.touchStartPosition = this.touchStartPosition || event.originalEvent.touches[0]
var touchPosition = event.originalEvent.touches[0]
var xMovement = Math.abs(this.touchStartPosition.clientX - touchPosition.clientX)
var yMovement = Math.abs(this.touchStartPosition.clientY - touchPosition.clientY)
var distance = Math.sqrt(xMovement * xMovement + yMovement * yMovement)
if(distance > options.touchMovedThreshold) {
this.touchMoved = true;
}
}
month_picker
.find('.xdsoft_select')
.xdsoftScroller(options)
.on('touchstart mousedown.xdsoft', function (event) {
this.touchMoved = false;
this.touchStartPosition = event.originalEvent.touches[0]
event.stopPropagation();
event.preventDefault();
})
.on('touchmove', '.xdsoft_option', handleTouchMoved)
.on('touchend mousedown.xdsoft', '.xdsoft_option', function () {
if (!this.touchMoved) {
if (_xdsoft_datetime.currentTime === undefined || _xdsoft_datetime.currentTime === null) {
_xdsoft_datetime.currentTime = _xdsoft_datetime.now();
}
var year = _xdsoft_datetime.currentTime.getFullYear();
if (_xdsoft_datetime && _xdsoft_datetime.currentTime) {
_xdsoft_datetime.currentTime[$(this).parent().parent().hasClass('xdsoft_monthselect') ? 'setMonth' : 'setFullYear']($(this).data('value'));
}
$(this).parent().parent().hide();
datetimepicker.trigger('xchange.xdsoft');
if (options.onChangeMonth && $.isFunction(options.onChangeMonth)) {
options.onChangeMonth.call(datetimepicker, _xdsoft_datetime.currentTime, datetimepicker.data('input'));
}
if (year !== _xdsoft_datetime.currentTime.getFullYear() && $.isFunction(options.onChangeYear)) {
options.onChangeYear.call(datetimepicker, _xdsoft_datetime.currentTime, datetimepicker.data('input'));
}
}
});
datetimepicker.getValue = function () {
return _xdsoft_datetime.getCurrentTime();
};
datetimepicker.setOptions = function (_options) {
var highlightedDates = {};
options = $.extend(true, {}, options, _options);
if (_options.allowTimes && $.isArray(_options.allowTimes) && _options.allowTimes.length) {
options.allowTimes = $.extend(true, [], _options.allowTimes);
}
if (_options.weekends && $.isArray(_options.weekends) && _options.weekends.length) {
options.weekends = $.extend(true, [], _options.weekends);
}
if (_options.allowDates && $.isArray(_options.allowDates) && _options.allowDates.length) {
options.allowDates = $.extend(true, [], _options.allowDates);
}
if (_options.allowDateRe && Object.prototype.toString.call(_options.allowDateRe)==="[object String]") {
options.allowDateRe = new RegExp(_options.allowDateRe);
}
if (_options.highlightedDates && $.isArray(_options.highlightedDates) && _options.highlightedDates.length) {
$.each(_options.highlightedDates, function (index, value) {
var splitData = $.map(value.split(','), $.trim),
exDesc,
hDate = new HighlightedDate(dateHelper.parseDate(splitData[0], options.formatDate), splitData[1], splitData[2]), // date, desc, style
keyDate = dateHelper.formatDate(hDate.date, options.formatDate);
if (highlightedDates[keyDate] !== undefined) {
exDesc = highlightedDates[keyDate].desc;
if (exDesc && exDesc.length && hDate.desc && hDate.desc.length) {
highlightedDates[keyDate].desc = exDesc + "\n" + hDate.desc;
}
} else {
highlightedDates[keyDate] = hDate;
}
});
options.highlightedDates = $.extend(true, [], highlightedDates);
}
if (_options.highlightedPeriods && $.isArray(_options.highlightedPeriods) && _options.highlightedPeriods.length) {
highlightedDates = $.extend(true, [], options.highlightedDates);
$.each(_options.highlightedPeriods, function (index, value) {
var dateTest, // start date
dateEnd,
desc,
hDate,
keyDate,
exDesc,
style;
if ($.isArray(value)) {
dateTest = value[0];
dateEnd = value[1];
desc = value[2];
style = value[3];
}
else {
var splitData = $.map(value.split(','), $.trim);
dateTest = dateHelper.parseDate(splitData[0], options.formatDate);
dateEnd = dateHelper.parseDate(splitData[1], options.formatDate);
desc = splitData[2];
style = splitData[3];
}
while (dateTest <= dateEnd) {
hDate = new HighlightedDate(dateTest, desc, style);
keyDate = dateHelper.formatDate(dateTest, options.formatDate);
dateTest.setDate(dateTest.getDate() + 1);
if (highlightedDates[keyDate] !== undefined) {
exDesc = highlightedDates[keyDate].desc;
if (exDesc && exDesc.length && hDate.desc && hDate.desc.length) {
highlightedDates[keyDate].desc = exDesc + "\n" + hDate.desc;
}
} else {
highlightedDates[keyDate] = hDate;
}
}
});
options.highlightedDates = $.extend(true, [], highlightedDates);
}
if (_options.disabledDates && $.isArray(_options.disabledDates) && _options.disabledDates.length) {
options.disabledDates = $.extend(true, [], _options.disabledDates);
}
if (_options.disabledWeekDays && $.isArray(_options.disabledWeekDays) && _options.disabledWeekDays.length) {
options.disabledWeekDays = $.extend(true, [], _options.disabledWeekDays);
}
if ((options.open || options.opened) && (!options.inline)) {
input.trigger('open.xdsoft');
}
if (options.inline) {
triggerAfterOpen = true;
datetimepicker.addClass('xdsoft_inline');
input.after(datetimepicker).hide();
}
if (options.inverseButton) {
options.next = 'xdsoft_prev';
options.prev = 'xdsoft_next';
}
if (options.datepicker) {
datepicker.addClass('active');
} else {
datepicker.removeClass('active');
}
if (options.timepicker) {
timepicker.addClass('active');
} else {
timepicker.removeClass('active');
}
if (options.value) {
_xdsoft_datetime.setCurrentTime(options.value);
if (input && input.val) {
input.val(_xdsoft_datetime.str);
}
}
if (isNaN(options.dayOfWeekStart)) {
options.dayOfWeekStart = 0;
} else {
options.dayOfWeekStart = parseInt(options.dayOfWeekStart, 10) % 7;
}
if (!options.timepickerScrollbar) {
timeboxparent.xdsoftScroller(options, 'hide');
}
if (options.minDate && /^[\+\-](.*)$/.test(options.minDate)) {
options.minDate = dateHelper.formatDate(_xdsoft_datetime.strToDateTime(options.minDate), options.formatDate);
}
if (options.maxDate && /^[\+\-](.*)$/.test(options.maxDate)) {
options.maxDate = dateHelper.formatDate(_xdsoft_datetime.strToDateTime(options.maxDate), options.formatDate);
}
if (options.minDateTime && /^\+(.*)$/.test(options.minDateTime)) {
options.minDateTime = _xdsoft_datetime.strToDateTime(options.minDateTime).dateFormat(options.formatDate);
}
applyButton.toggle(options.showApplyButton);
month_picker
.find('.xdsoft_today_button')
.css('visibility', !options.todayButton ? 'hidden' : 'visible');
month_picker
.find('.' + options.prev)
.css('visibility', !options.prevButton ? 'hidden' : 'visible');
month_picker
.find('.' + options.next)
.css('visibility', !options.nextButton ? 'hidden' : 'visible');
setMask(options);
if (options.validateOnBlur) {
input
.off('blur.xdsoft')
.on('blur.xdsoft', function () {
if (options.allowBlank && (!$.trim($(this).val()).length ||
(typeof options.mask === "string" && $.trim($(this).val()) === options.mask.replace(/[0-9]/g, '_')))) {
$(this).val(null);
datetimepicker.data('xdsoft_datetime').empty();
} else {
var d = dateHelper.parseDate($(this).val(), options.format);
if (d) { // parseDate() may skip some invalid parts like date or time, so make it clear for user: show parsed date/time
$(this).val(dateHelper.formatDate(d, options.format));
} else {
var splittedHours = +([$(this).val()[0], $(this).val()[1]].join('')),
splittedMinutes = +([$(this).val()[2], $(this).val()[3]].join(''));
// parse the numbers as 0312 => 03:12
if (!options.datepicker && options.timepicker && splittedHours >= 0 && splittedHours < 24 && splittedMinutes >= 0 && splittedMinutes < 60) {
$(this).val([splittedHours, splittedMinutes].map(function (item) {
return item > 9 ? item : '0' + item;
}).join(':'));
} else {
$(this).val(dateHelper.formatDate(_xdsoft_datetime.now(), options.format));
}
}
datetimepicker.data('xdsoft_datetime').setCurrentTime($(this).val());
}
datetimepicker.trigger('changedatetime.xdsoft');
datetimepicker.trigger('close.xdsoft');
});
}
options.dayOfWeekStartPrev = (options.dayOfWeekStart === 0) ? 6 : options.dayOfWeekStart - 1;
datetimepicker
.trigger('xchange.xdsoft')
.trigger('afterOpen.xdsoft');
};
datetimepicker
.data('options', options)
.on('touchstart mousedown.xdsoft', function (event) {
event.stopPropagation();
event.preventDefault();
yearselect.hide();
monthselect.hide();
return false;
});
//scroll_element = timepicker.find('.xdsoft_time_box');
timeboxparent.append(timebox);
timeboxparent.xdsoftScroller(options);
datetimepicker.on('afterOpen.xdsoft', function () {
timeboxparent.xdsoftScroller(options);
});
datetimepicker
.append(datepicker)
.append(timepicker);
if (options.withoutCopyright !== true) {
datetimepicker
.append(xdsoft_copyright);
}
datepicker
.append(month_picker)
.append(calendar)
.append(applyButton);
$(options.parentID)
.append(datetimepicker);
XDSoft_datetime = function () {
var _this = this;
_this.now = function (norecursion) {
var d = new Date(),
date,
time;
if (!norecursion && options.defaultDate) {
date = _this.strToDateTime(options.defaultDate);
d.setFullYear(date.getFullYear());
d.setMonth(date.getMonth());
d.setDate(date.getDate());
}
d.setFullYear(d.getFullYear());
if (!norecursion && options.defaultTime) {
time = _this.strtotime(options.defaultTime);
d.setHours(time.getHours());
d.setMinutes(time.getMinutes());
d.setSeconds(time.getSeconds());
d.setMilliseconds(time.getMilliseconds());
}
return d;
};
_this.isValidDate = function (d) {
if (Object.prototype.toString.call(d) !== "[object Date]") {
return false;
}
return !isNaN(d.getTime());
};
_this.setCurrentTime = function (dTime, requireValidDate) {
if (typeof dTime === 'string') {
_this.currentTime = _this.strToDateTime(dTime);
}
else if (_this.isValidDate(dTime)) {
_this.currentTime = dTime;
}
else if (!dTime && !requireValidDate && options.allowBlank && !options.inline) {
_this.currentTime = null;
}
else {
_this.currentTime = _this.now();
}
datetimepicker.trigger('xchange.xdsoft');
};
_this.empty = function () {
_this.currentTime = null;
};
_this.getCurrentTime = function () {
return _this.currentTime;
};
_this.nextMonth = function () {
if (_this.currentTime === undefined || _this.currentTime === null) {
_this.currentTime = _this.now();
}
var month = _this.currentTime.getMonth() + 1,
year;
if (month === 12) {
_this.currentTime.setFullYear(_this.currentTime.getFullYear() + 1);
month = 0;
}
year = _this.currentTime.getFullYear();
_this.currentTime.setDate(
Math.min(
new Date(_this.currentTime.getFullYear(), month + 1, 0).getDate(),
_this.currentTime.getDate()
)
);
_this.currentTime.setMonth(month);
if (options.onChangeMonth && $.isFunction(options.onChangeMonth)) {
options.onChangeMonth.call(datetimepicker, _xdsoft_datetime.currentTime, datetimepicker.data('input'));
}
if (year !== _this.currentTime.getFullYear() && $.isFunction(options.onChangeYear)) {
options.onChangeYear.call(datetimepicker, _xdsoft_datetime.currentTime, datetimepicker.data('input'));
}
datetimepicker.trigger('xchange.xdsoft');
return month;
};
_this.prevMonth = function () {
if (_this.currentTime === undefined || _this.currentTime === null) {
_this.currentTime = _this.now();
}
var month = _this.currentTime.getMonth() - 1;
if (month === -1) {
_this.currentTime.setFullYear(_this.currentTime.getFullYear() - 1);
month = 11;
}
_this.currentTime.setDate(
Math.min(
new Date(_this.currentTime.getFullYear(), month + 1, 0).getDate(),
_this.currentTime.getDate()
)
);
_this.currentTime.setMonth(month);
if (options.onChangeMonth && $.isFunction(options.onChangeMonth)) {
options.onChangeMonth.call(datetimepicker, _xdsoft_datetime.currentTime, datetimepicker.data('input'));
}
datetimepicker.trigger('xchange.xdsoft');
return month;
};
_this.getWeekOfYear = function (datetime) {
if (options.onGetWeekOfYear && $.isFunction(options.onGetWeekOfYear)) {
var week = options.onGetWeekOfYear.call(datetimepicker, datetime);
if (typeof week !== 'undefined') {
return week;
}
}
var onejan = new Date(datetime.getFullYear(), 0, 1);
//First week of the year is th one with the first Thursday according to ISO8601
if (onejan.getDay() !== 4) {
onejan.setMonth(0, 1 + ((4 - onejan.getDay()+ 7) % 7));
}
return Math.ceil((((datetime - onejan) / 86400000) + onejan.getDay() + 1) / 7);
};
_this.strToDateTime = function (sDateTime) {
var tmpDate = [], timeOffset, currentTime;
if (sDateTime && sDateTime instanceof Date && _this.isValidDate(sDateTime)) {
return sDateTime;
}
tmpDate = /^([+-]{1})(.*)$/.exec(sDateTime);
if (tmpDate) {
tmpDate[2] = dateHelper.parseDate(tmpDate[2], options.formatDate);
}
if (tmpDate && tmpDate[2]) {
timeOffset = tmpDate[2].getTime() - (tmpDate[2].getTimezoneOffset()) * 60000;
currentTime = new Date((_this.now(true)).getTime() + parseInt(tmpDate[1] + '1', 10) * timeOffset);
} else {
currentTime = sDateTime ? dateHelper.parseDate(sDateTime, options.format) : _this.now();
}
if (!_this.isValidDate(currentTime)) {
currentTime = _this.now();
}
return currentTime;
};
_this.strToDate = function (sDate) {
if (sDate && sDate instanceof Date && _this.isValidDate(sDate)) {
return sDate;
}
var currentTime = sDate ? dateHelper.parseDate(sDate, options.formatDate) : _this.now(true);
if (!_this.isValidDate(currentTime)) {
currentTime = _this.now(true);
}
return currentTime;
};
_this.strtotime = function (sTime) {
if (sTime && sTime instanceof Date && _this.isValidDate(sTime)) {
return sTime;
}
var currentTime = sTime ? dateHelper.parseDate(sTime, options.formatTime) : _this.now(true);
if (!_this.isValidDate(currentTime)) {
currentTime = _this.now(true);
}
return currentTime;
};
_this.str = function () {
var format = options.format;
if (options.yearOffset) {
format = format.replace('Y', _this.currentTime.getFullYear() + options.yearOffset);
format = format.replace('y', String(_this.currentTime.getFullYear() + options.yearOffset).substring(2, 4));
}
return dateHelper.formatDate(_this.currentTime, format);
};
_this.currentTime = this.now();
};
_xdsoft_datetime = new XDSoft_datetime();
applyButton.on('touchend click', function (e) {//pathbrite
e.preventDefault();
datetimepicker.data('changed', true);
_xdsoft_datetime.setCurrentTime(getCurrentValue());
input.val(_xdsoft_datetime.str());
datetimepicker.trigger('close.xdsoft');
});
month_picker
.find('.xdsoft_today_button')
.on('touchend mousedown.xdsoft', function () {
datetimepicker.data('changed', true);
_xdsoft_datetime.setCurrentTime(0, true);
datetimepicker.trigger('afterOpen.xdsoft');
}).on('dblclick.xdsoft', function () {
var currentDate = _xdsoft_datetime.getCurrentTime(), minDate, maxDate;
currentDate = new Date(currentDate.getFullYear(), currentDate.getMonth(), currentDate.getDate());
minDate = _xdsoft_datetime.strToDate(options.minDate);
minDate = new Date(minDate.getFullYear(), minDate.getMonth(), minDate.getDate());
if (currentDate < minDate) {
return;
}
maxDate = _xdsoft_datetime.strToDate(options.maxDate);
maxDate = new Date(maxDate.getFullYear(), maxDate.getMonth(), maxDate.getDate());
if (currentDate > maxDate) {
return;
}
input.val(_xdsoft_datetime.str());
input.trigger('change');
datetimepicker.trigger('close.xdsoft');
});
month_picker
.find('.xdsoft_prev,.xdsoft_next')
.on('touchend mousedown.xdsoft', function () {
var $this = $(this),
timer = 0,
stop = false;
(function arguments_callee1(v) {
if ($this.hasClass(options.next)) {
_xdsoft_datetime.nextMonth();
} else if ($this.hasClass(options.prev)) {
_xdsoft_datetime.prevMonth();
}
if (options.monthChangeSpinner) {
if (!stop) {
timer = setTimeout(arguments_callee1, v || 100);
}
}
}(500));
$([options.ownerDocument.body, options.contentWindow]).on('touchend mouseup.xdsoft', function arguments_callee2() {
clearTimeout(timer);
stop = true;
$([options.ownerDocument.body, options.contentWindow]).off('touchend mouseup.xdsoft', arguments_callee2);
});
});
timepicker
.find('.xdsoft_prev,.xdsoft_next')
.on('touchend mousedown.xdsoft', function () {
var $this = $(this),
timer = 0,
stop = false,
period = 110;
(function arguments_callee4(v) {
var pheight = timeboxparent[0].clientHeight,
height = timebox[0].offsetHeight,
top = Math.abs(parseInt(timebox.css('marginTop'), 10));
if ($this.hasClass(options.next) && (height - pheight) - options.timeHeightInTimePicker >= top) {
timebox.css('marginTop', '-' + (top + options.timeHeightInTimePicker) + 'px');
} else if ($this.hasClass(options.prev) && top - options.timeHeightInTimePicker >= 0) {
timebox.css('marginTop', '-' + (top - options.timeHeightInTimePicker) + 'px');
}
/**
* Fixed bug:
* When using css3 transition, it will cause a bug that you cannot scroll the timepicker list.
* The reason is that the transition-duration time, if you set it to 0, all things fine, otherwise, this
* would cause a bug when you use jquery.css method.
* Let's say: * { transition: all .5s ease; }
* jquery timebox.css('marginTop') will return the original value which is before you clicking the next/prev button,
* meanwhile the timebox[0].style.marginTop will return the right value which is after you clicking the
* next/prev button.
*
* What we should do:
* Replace timebox.css('marginTop') with timebox[0].style.marginTop.
*/
timeboxparent.trigger('scroll_element.xdsoft_scroller', [Math.abs(parseInt(timebox[0].style.marginTop, 10) / (height - pheight))]);
period = (period > 10) ? 10 : period - 10;
if (!stop) {
timer = setTimeout(arguments_callee4, v || period);
}
}(500));
$([options.ownerDocument.body, options.contentWindow]).on('touchend mouseup.xdsoft', function arguments_callee5() {
clearTimeout(timer);
stop = true;
$([options.ownerDocument.body, options.contentWindow])
.off('touchend mouseup.xdsoft', arguments_callee5);
});
});
xchangeTimer = 0;
// base handler - generating a calendar and timepicker
datetimepicker
.on('xchange.xdsoft', function (event) {
clearTimeout(xchangeTimer);
xchangeTimer = setTimeout(function () {
if (_xdsoft_datetime.currentTime === undefined || _xdsoft_datetime.currentTime === null) {
_xdsoft_datetime.currentTime = _xdsoft_datetime.now();
}
var table = '',
start = new Date(_xdsoft_datetime.currentTime.getFullYear(), _xdsoft_datetime.currentTime.getMonth(), 1, 12, 0, 0),
i = 0,
j,
today = _xdsoft_datetime.now(),
maxDate = false,
minDate = false,
minDateTime = false,
hDate,
day,
d,
y,
m,
w,
classes = [],
customDateSettings,
newRow = true,
time = '',
h,
line_time,
description;
while (start.getDay() !== options.dayOfWeekStart) {
start.setDate(start.getDate() - 1);
}
table += '<table><thead><tr>';
if (options.weeks) {
table += '<th></th>';
}
for (j = 0; j < 7; j += 1) {
table += '<th>' + options.i18n[globalLocale].dayOfWeekShort[(j + options.dayOfWeekStart) % 7] + '</th>';
}
table += '</tr></thead>';
table += '<tbody>';
if (options.maxDate !== false) {
maxDate = _xdsoft_datetime.strToDate(options.maxDate);
maxDate = new Date(maxDate.getFullYear(), maxDate.getMonth(), maxDate.getDate(), 23, 59, 59, 999);
}
if (options.minDate !== false) {
minDate = _xdsoft_datetime.strToDate(options.minDate);
minDate = new Date(minDate.getFullYear(), minDate.getMonth(), minDate.getDate());
}
if (options.minDateTime !== false) {
minDateTime = _xdsoft_datetime.strToDate(options.minDateTime);
minDateTime = new Date(minDateTime.getFullYear(), minDateTime.getMonth(), minDateTime.getDate(), minDateTime.getHours(), minDateTime.getMinutes(), minDateTime.getSeconds());
}
while (i < _xdsoft_datetime.currentTime.countDaysInMonth() || start.getDay() !== options.dayOfWeekStart || _xdsoft_datetime.currentTime.getMonth() === start.getMonth()) {
classes = [];
i += 1;
day = start.getDay();
d = start.getDate();
y = start.getFullYear();
m = start.getMonth();
w = _xdsoft_datetime.getWeekOfYear(start);
description = '';
classes.push('xdsoft_date');
if (options.beforeShowDay && $.isFunction(options.beforeShowDay.call)) {
customDateSettings = options.beforeShowDay.call(datetimepicker, start);
} else {
customDateSettings = null;
}
if(options.allowDateRe && Object.prototype.toString.call(options.allowDateRe) === "[object RegExp]"){
if(!options.allowDateRe.test(dateHelper.formatDate(start, options.formatDate))){
classes.push('xdsoft_disabled');
}
}
if(options.allowDates && options.allowDates.length>0){
if(options.allowDates.indexOf(dateHelper.formatDate(start, options.formatDate)) === -1){
classes.push('xdsoft_disabled');
}
}
if ((maxDate !== false && start > maxDate) || (minDateTime !== false && start < minDateTime) || (minDate !== false && start < minDate) || (customDateSettings && customDateSettings[0] === false)) {
classes.push('xdsoft_disabled');
}
if (options.disabledDates.indexOf(dateHelper.formatDate(start, options.formatDate)) !== -1) {
classes.push('xdsoft_disabled');
}
if (options.disabledWeekDays.indexOf(day) !== -1) {
classes.push('xdsoft_disabled');
}
if (input.is('[disabled]')) {
classes.push('xdsoft_disabled');
}
if (customDateSettings && customDateSettings[1] !== "") {
classes.push(customDateSettings[1]);
}
if (_xdsoft_datetime.currentTime.getMonth() !== m) {
classes.push('xdsoft_other_month');
}
if ((options.defaultSelect || datetimepicker.data('changed')) && dateHelper.formatDate(_xdsoft_datetime.currentTime, options.formatDate) === dateHelper.formatDate(start, options.formatDate)) {
classes.push('xdsoft_current');
}
if (dateHelper.formatDate(today, options.formatDate) === dateHelper.formatDate(start, options.formatDate)) {
classes.push('xdsoft_today');
}
if (start.getDay() === 0 || start.getDay() === 6 || options.weekends.indexOf(dateHelper.formatDate(start, options.formatDate)) !== -1) {
classes.push('xdsoft_weekend');
}
if (options.highlightedDates[dateHelper.formatDate(start, options.formatDate)] !== undefined) {
hDate = options.highlightedDates[dateHelper.formatDate(start, options.formatDate)];
classes.push(hDate.style === undefined ? 'xdsoft_highlighted_default' : hDate.style);
description = hDate.desc === undefined ? '' : hDate.desc;
}
if (options.beforeShowDay && $.isFunction(options.beforeShowDay)) {
classes.push(options.beforeShowDay(start));
}
if (newRow) {
table += '<tr>';
newRow = false;
if (options.weeks) {
table += '<th>' + w + '</th>';
}
}
table += '<td data-date="' + d + '" data-month="' + m + '" data-year="' + y + '"' + ' class="xdsoft_date xdsoft_day_of_week' + start.getDay() + ' ' + classes.join(' ') + '" title="' + description + '">' +
'<div>' + d + '</div>' +
'</td>';
if (start.getDay() === options.dayOfWeekStartPrev) {
table += '</tr>';
newRow = true;
}
start.setDate(d + 1);
}
table += '</tbody></table>';
calendar.html(table);
month_picker.find('.xdsoft_label span').eq(0).text(options.i18n[globalLocale].months[_xdsoft_datetime.currentTime.getMonth()]);
month_picker.find('.xdsoft_label span').eq(1).text(_xdsoft_datetime.currentTime.getFullYear() + options.yearOffset);
// generate timebox
time = '';
h = '';
m = '';
line_time = function line_time(h, m) {
var now = _xdsoft_datetime.now(), optionDateTime, current_time,
isALlowTimesInit = options.allowTimes && $.isArray(options.allowTimes) && options.allowTimes.length;
now.setHours(h);
h = parseInt(now.getHours(), 10);
now.setMinutes(m);
m = parseInt(now.getMinutes(), 10);
optionDateTime = new Date(_xdsoft_datetime.currentTime);
optionDateTime.setHours(h);
optionDateTime.setMinutes(m);
classes = [];
if ((options.minDateTime !== false && options.minDateTime > optionDateTime) || (options.maxTime !== false && _xdsoft_datetime.strtotime(options.maxTime).getTime() < now.getTime()) || (options.minTime !== false && _xdsoft_datetime.strtotime(options.minTime).getTime() > now.getTime())) {
classes.push('xdsoft_disabled');
} else if ((options.minDateTime !== false && options.minDateTime > optionDateTime) || ((options.disabledMinTime !== false && now.getTime() > _xdsoft_datetime.strtotime(options.disabledMinTime).getTime()) && (options.disabledMaxTime !== false && now.getTime() < _xdsoft_datetime.strtotime(options.disabledMaxTime).getTime()))) {
classes.push('xdsoft_disabled');
} else if (input.is('[disabled]')) {
classes.push('xdsoft_disabled');
}
current_time = new Date(_xdsoft_datetime.currentTime);
current_time.setHours(parseInt(_xdsoft_datetime.currentTime.getHours(), 10));
if (!isALlowTimesInit) {
current_time.setMinutes(Math[options.roundTime](_xdsoft_datetime.currentTime.getMinutes() / options.step) * options.step);
}
if ((options.initTime || options.defaultSelect || datetimepicker.data('changed')) && current_time.getHours() === parseInt(h, 10) && ((!isALlowTimesInit && options.step > 59) || current_time.getMinutes() === parseInt(m, 10))) {
if (options.defaultSelect || datetimepicker.data('changed')) {
classes.push('xdsoft_current');
} else if (options.initTime) {
classes.push('xdsoft_init_time');
}
}
if (parseInt(today.getHours(), 10) === parseInt(h, 10) && parseInt(today.getMinutes(), 10) === parseInt(m, 10)) {
classes.push('xdsoft_today');
}
time += '<div class="xdsoft_time ' + classes.join(' ') + '" data-hour="' + h + '" data-minute="' + m + '">' + dateHelper.formatDate(now, options.formatTime) + '</div>';
};
if (!options.allowTimes || !$.isArray(options.allowTimes) || !options.allowTimes.length) {
for (i = 0, j = 0; i < (options.hours12 ? 12 : 24); i += 1) {
for (j = 0; j < 60; j += options.step) {
h = (i < 10 ? '0' : '') + i;
m = (j < 10 ? '0' : '') + j;
line_time(h, m);
}
}
} else {
for (i = 0; i < options.allowTimes.length; i += 1) {
h = _xdsoft_datetime.strtotime(options.allowTimes[i]).getHours();
m = _xdsoft_datetime.strtotime(options.allowTimes[i]).getMinutes();
line_time(h, m);
}
}
timebox.html(time);
opt = '';
for (i = parseInt(options.yearStart, 10); i <= parseInt(options.yearEnd, 10); i += 1) {
opt += '<div class="xdsoft_option ' + (_xdsoft_datetime.currentTime.getFullYear() === i ? 'xdsoft_current' : '') + '" data-value="' + i + '">' + (i + options.yearOffset) + '</div>';
}
yearselect.children().eq(0)
.html(opt);
for (i = parseInt(options.monthStart, 10), opt = ''; i <= parseInt(options.monthEnd, 10); i += 1) {
opt += '<div class="xdsoft_option ' + (_xdsoft_datetime.currentTime.getMonth() === i ? 'xdsoft_current' : '') + '" data-value="' + i + '">' + options.i18n[globalLocale].months[i] + '</div>';
}
monthselect.children().eq(0).html(opt);
$(datetimepicker)
.trigger('generate.xdsoft');
}, 10);
event.stopPropagation();
})
.on('afterOpen.xdsoft', function () {
if (options.timepicker) {
var classType, pheight, height, top;
if (timebox.find('.xdsoft_current').length) {
classType = '.xdsoft_current';
} else if (timebox.find('.xdsoft_init_time').length) {
classType = '.xdsoft_init_time';
}
if (classType) {
pheight = timeboxparent[0].clientHeight;
height = timebox[0].offsetHeight;
top = timebox.find(classType).index() * options.timeHeightInTimePicker + 1;
if ((height - pheight) < top) {
top = height - pheight;
}
timeboxparent.trigger('scroll_element.xdsoft_scroller', [parseInt(top, 10) / (height - pheight)]);
} else {
timeboxparent.trigger('scroll_element.xdsoft_scroller', [0]);
}
}
});
timerclick = 0;
calendar
.on('touchend click.xdsoft', 'td', function (xdevent) {
xdevent.stopPropagation(); // Prevents closing of Pop-ups, Modals and Flyouts in Bootstrap
timerclick += 1;
var $this = $(this),
currentTime = _xdsoft_datetime.currentTime;
if (currentTime === undefined || currentTime === null) {
_xdsoft_datetime.currentTime = _xdsoft_datetime.now();
currentTime = _xdsoft_datetime.currentTime;
}
if ($this.hasClass('xdsoft_disabled')) {
return false;
}
currentTime.setDate(1);
currentTime.setFullYear($this.data('year'));
currentTime.setMonth($this.data('month'));
currentTime.setDate($this.data('date'));
datetimepicker.trigger('select.xdsoft', [currentTime]);
input.val(_xdsoft_datetime.str());
if (options.onSelectDate && $.isFunction(options.onSelectDate)) {
options.onSelectDate.call(datetimepicker, _xdsoft_datetime.currentTime, datetimepicker.data('input'), xdevent);
}
datetimepicker.data('changed', true);
datetimepicker.trigger('xchange.xdsoft');
datetimepicker.trigger('changedatetime.xdsoft');
if ((timerclick > 1 || (options.closeOnDateSelect === true || (options.closeOnDateSelect === false && !options.timepicker))) && !options.inline) {
datetimepicker.trigger('close.xdsoft');
}
setTimeout(function () {
timerclick = 0;
}, 200);
});
timebox
.on('touchstart', 'div', function (xdevent) {
this.touchMoved = false;
})
.on('touchmove', 'div', handleTouchMoved)
.on('touchend click.xdsoft', 'div', function (xdevent) {
if (!this.touchMoved) {
xdevent.stopPropagation();
var $this = $(this),
currentTime = _xdsoft_datetime.currentTime;
if (currentTime === undefined || currentTime === null) {
_xdsoft_datetime.currentTime = _xdsoft_datetime.now();
currentTime = _xdsoft_datetime.currentTime;
}
if ($this.hasClass('xdsoft_disabled')) {
return false;
}
currentTime.setHours($this.data('hour'));
currentTime.setMinutes($this.data('minute'));
datetimepicker.trigger('select.xdsoft', [currentTime]);
datetimepicker.data('input').val(_xdsoft_datetime.str());
if (options.onSelectTime && $.isFunction(options.onSelectTime)) {
options.onSelectTime.call(datetimepicker, _xdsoft_datetime.currentTime, datetimepicker.data('input'), xdevent);
}
datetimepicker.data('changed', true);
datetimepicker.trigger('xchange.xdsoft');
datetimepicker.trigger('changedatetime.xdsoft');
if (options.inline !== true && options.closeOnTimeSelect === true) {
datetimepicker.trigger('close.xdsoft');
}
}
});
datepicker
.on('mousewheel.xdsoft', function (event) {
if (!options.scrollMonth) {
return true;
}
if (event.deltaY < 0) {
_xdsoft_datetime.nextMonth();
} else {
_xdsoft_datetime.prevMonth();
}
return false;
});
input
.on('mousewheel.xdsoft', function (event) {
if (!options.scrollInput) {
return true;
}
if (!options.datepicker && options.timepicker) {
current_time_index = timebox.find('.xdsoft_current').length ? timebox.find('.xdsoft_current').eq(0).index() : 0;
if (current_time_index + event.deltaY >= 0 && current_time_index + event.deltaY < timebox.children().length) {
current_time_index += event.deltaY;
}
if (timebox.children().eq(current_time_index).length) {
timebox.children().eq(current_time_index).trigger('mousedown');
}
return false;
}
if (options.datepicker && !options.timepicker) {
datepicker.trigger(event, [event.deltaY, event.deltaX, event.deltaY]);
if (input.val) {
input.val(_xdsoft_datetime.str());
}
datetimepicker.trigger('changedatetime.xdsoft');
return false;
}
});
datetimepicker
.on('changedatetime.xdsoft', function (event) {
if (options.onChangeDateTime && $.isFunction(options.onChangeDateTime)) {
var $input = datetimepicker.data('input');
options.onChangeDateTime.call(datetimepicker, _xdsoft_datetime.currentTime, $input, event);
delete options.value;
$input.trigger('change');
}
})
.on('generate.xdsoft', function () {
if (options.onGenerate && $.isFunction(options.onGenerate)) {
options.onGenerate.call(datetimepicker, _xdsoft_datetime.currentTime, datetimepicker.data('input'));
}
if (triggerAfterOpen) {
datetimepicker.trigger('afterOpen.xdsoft');
triggerAfterOpen = false;
}
})
.on('click.xdsoft', function (xdevent) {
xdevent.stopPropagation();
});
current_time_index = 0;
/**
* Runs the callback for each of the specified node's ancestors.
*
* Return FALSE from the callback to stop ascending.
*
* @param {DOMNode} node
* @param {Function} callback
* @returns {undefined}
*/
forEachAncestorOf = function (node, callback) {
do {
node = node.parentNode;
if (!node || callback(node) === false) {
break;
}
} while (node.nodeName !== 'HTML');
};
/**
* Sets the position of the picker.
*
* @returns {undefined}
*/
setPos = function () {
var dateInputOffset,
dateInputElem,
verticalPosition,
left,
position,
datetimepickerElem,
dateInputHasFixedAncestor,
$dateInput,
windowWidth,
verticalAnchorEdge,
datetimepickerCss,
windowHeight,
windowScrollTop;
$dateInput = datetimepicker.data('input');
dateInputOffset = $dateInput.offset();
dateInputElem = $dateInput[0];
verticalAnchorEdge = 'top';
verticalPosition = (dateInputOffset.top + dateInputElem.offsetHeight) - 1;
left = dateInputOffset.left;
position = "absolute";
windowWidth = $(options.contentWindow).width();
windowHeight = $(options.contentWindow).height();
windowScrollTop = $(options.contentWindow).scrollTop();
if ((options.ownerDocument.documentElement.clientWidth - dateInputOffset.left) < datepicker.parent().outerWidth(true)) {
var diff = datepicker.parent().outerWidth(true) - dateInputElem.offsetWidth;
left = left - diff;
}
if ($dateInput.parent().css('direction') === 'rtl') {
left -= (datetimepicker.outerWidth() - $dateInput.outerWidth());
}
if (options.fixed) {
verticalPosition -= windowScrollTop;
left -= $(options.contentWindow).scrollLeft();
position = "fixed";
} else {
dateInputHasFixedAncestor = false;
forEachAncestorOf(dateInputElem, function (ancestorNode) {
if (ancestorNode === null) {
return false;
}
if (options.contentWindow.getComputedStyle(ancestorNode).getPropertyValue('position') === 'fixed') {
dateInputHasFixedAncestor = true;
return false;
}
});
if (dateInputHasFixedAncestor) {
position = 'fixed';
//If the picker won't fit entirely within the viewport then display it above the date input.
if (verticalPosition + datetimepicker.outerHeight() > windowHeight + windowScrollTop) {
verticalAnchorEdge = 'bottom';
verticalPosition = (windowHeight + windowScrollTop) - dateInputOffset.top;
} else {
verticalPosition -= windowScrollTop;
}
} else {
if (verticalPosition + datetimepicker[0].offsetHeight > windowHeight + windowScrollTop) {
verticalPosition = dateInputOffset.top - datetimepicker[0].offsetHeight + 1;
}
}
if (verticalPosition < 0) {
verticalPosition = 0;
}
if (left + dateInputElem.offsetWidth > windowWidth) {
left = windowWidth - dateInputElem.offsetWidth;
}
}
datetimepickerElem = datetimepicker[0];
forEachAncestorOf(datetimepickerElem, function (ancestorNode) {
var ancestorNodePosition;
ancestorNodePosition = options.contentWindow.getComputedStyle(ancestorNode).getPropertyValue('position');
if (ancestorNodePosition === 'relative' && windowWidth >= ancestorNode.offsetWidth) {
left = left - ((windowWidth - ancestorNode.offsetWidth) / 2);
return false;
}
});
datetimepickerCss = {
position: position,
left: left,
top: '', //Initialize to prevent previous values interfering with new ones.
bottom: '' //Initialize to prevent previous values interfering with new ones.
};
datetimepickerCss[verticalAnchorEdge] = verticalPosition;
datetimepicker.css(datetimepickerCss);
};
datetimepicker
.on('open.xdsoft', function (event) {
var onShow = true;
if (options.onShow && $.isFunction(options.onShow)) {
onShow = options.onShow.call(datetimepicker, _xdsoft_datetime.currentTime, datetimepicker.data('input'), event);
}
if (onShow !== false) {
datetimepicker.show();
setPos();
$(options.contentWindow)
.off('resize.xdsoft', setPos)
.on('resize.xdsoft', setPos);
if (options.closeOnWithoutClick) {
$([options.ownerDocument.body, options.contentWindow]).on('touchstart mousedown.xdsoft', function arguments_callee6() {
datetimepicker.trigger('close.xdsoft');
$([options.ownerDocument.body, options.contentWindow]).off('touchstart mousedown.xdsoft', arguments_callee6);
});
}
}
})
.on('close.xdsoft', function (event) {
var onClose = true;
month_picker
.find('.xdsoft_month,.xdsoft_year')
.find('.xdsoft_select')
.hide();
if (options.onClose && $.isFunction(options.onClose)) {
onClose = options.onClose.call(datetimepicker, _xdsoft_datetime.currentTime, datetimepicker.data('input'), event);
}
if (onClose !== false && !options.opened && !options.inline) {
datetimepicker.hide();
}
event.stopPropagation();
})
.on('toggle.xdsoft', function () {
if (datetimepicker.is(':visible')) {
datetimepicker.trigger('close.xdsoft');
} else {
datetimepicker.trigger('open.xdsoft');
}
})
.data('input', input);
timer = 0;
datetimepicker.data('xdsoft_datetime', _xdsoft_datetime);
datetimepicker.setOptions(options);
function getCurrentValue() {
var ct = false, time;
if (options.startDate) {
ct = _xdsoft_datetime.strToDate(options.startDate);
} else {
ct = options.value || ((input && input.val && input.val()) ? input.val() : '');
if (ct) {
ct = _xdsoft_datetime.strToDateTime(ct);
if (options.yearOffset) {
ct = new Date(ct.getFullYear() - options.yearOffset, ct.getMonth(), ct.getDate(), ct.getHours(), ct.getMinutes(), ct.getSeconds(), ct.getMilliseconds());
}
} else if (options.defaultDate) {
ct = _xdsoft_datetime.strToDateTime(options.defaultDate);
if (options.defaultTime) {
time = _xdsoft_datetime.strtotime(options.defaultTime);
ct.setHours(time.getHours());
ct.setMinutes(time.getMinutes());
}
}
}
if (ct && _xdsoft_datetime.isValidDate(ct)) {
datetimepicker.data('changed', true);
} else {
ct = '';
}
return ct || 0;
}
function setMask(options) {
var isValidValue = function (mask, value) {
var reg = mask
.replace(/([\[\]\/\{\}\(\)\-\.\+]{1})/g, '\\$1')
.replace(/_/g, '{digit+}')
.replace(/([0-9]{1})/g, '{digit$1}')
.replace(/\{digit([0-9]{1})\}/g, '[0-$1_]{1}')
.replace(/\{digit[\+]\}/g, '[0-9_]{1}');
return (new RegExp(reg)).test(value);
},
getCaretPos = function (input) {
try {
if (options.ownerDocument.selection && options.ownerDocument.selection.createRange) {
var range = options.ownerDocument.selection.createRange();
return range.getBookmark().charCodeAt(2) - 2;
}
if (input.setSelectionRange) {
return input.selectionStart;
}
} catch (e) {
return 0;
}
},
setCaretPos = function (node, pos) {
node = (typeof node === "string" || node instanceof String) ? options.ownerDocument.getElementById(node) : node;
if (!node) {
return false;
}
if (node.createTextRange) {
var textRange = node.createTextRange();
textRange.collapse(true);
textRange.moveEnd('character', pos);
textRange.moveStart('character', pos);
textRange.select();
return true;
}
if (node.setSelectionRange) {
node.setSelectionRange(pos, pos);
return true;
}
return false;
};
if(options.mask) {
input.off('keydown.xdsoft');
}
if (options.mask === true) {
if (dateHelper.formatMask) {
options.mask = dateHelper.formatMask(options.format)
} else {
options.mask = options.format
.replace(/Y/g, '9999')
.replace(/F/g, '9999')
.replace(/m/g, '19')
.replace(/d/g, '39')
.replace(/H/g, '29')
.replace(/i/g, '59')
.replace(/s/g, '59');
}
}
if ($.type(options.mask) === 'string') {
if (!isValidValue(options.mask, input.val())) {
input.val(options.mask.replace(/[0-9]/g, '_'));
setCaretPos(input[0], 0);
}
input.on('paste.xdsoft', function (event) {
// couple options here
// 1. return false - tell them they can't paste
// 2. insert over current characters - minimal validation
// 3. full fledged parsing and validation
// let's go option 2 for now
// fires multiple times for some reason
// https://stackoverflow.com/a/30496488/1366033
var clipboardData = event.clipboardData || event.originalEvent.clipboardData || window.clipboardData,
pastedData = clipboardData.getData('text'),
val = this.value,
pos = this.selectionStart
var valueBeforeCursor = val.substr(0, pos);
var valueAfterPaste = val.substr(pos + pastedData.length);
val = valueBeforeCursor + pastedData + valueAfterPaste;
pos += pastedData.length;
if (isValidValue(options.mask, val)) {
this.value = val;
setCaretPos(this, pos);
} else if ($.trim(val) === '') {
this.value = options.mask.replace(/[0-9]/g, '_');
} else {
input.trigger('error_input.xdsoft');
}
event.preventDefault();
return false;
});
input.on('keydown.xdsoft', function (event) {
var val = this.value,
key = event.which,
pos = this.selectionStart,
selEnd = this.selectionEnd,
hasSel = pos !== selEnd,
digit;
// only alow these characters
if (((key >= KEY0 && key <= KEY9) ||
(key >= _KEY0 && key <= _KEY9)) ||
(key === BACKSPACE || key === DEL)) {
// get char to insert which is new character or placeholder ('_')
digit = (key === BACKSPACE || key === DEL) ? '_' :
String.fromCharCode((_KEY0 <= key && key <= _KEY9) ? key - KEY0 : key);
// we're deleting something, we're not at the start, and have normal cursor, move back one
// if we have a selection length, cursor actually sits behind deletable char, not in front
if (key === BACKSPACE && pos && !hasSel) {
pos -= 1;
}
// don't stop on a separator, continue whatever direction you were going
// value char - keep incrementing position while on separator char and we still have room
// del char - keep decrementing position while on separator char and we still have room
while (true) {
var maskValueAtCurPos = options.mask.substr(pos, 1);
var posShorterThanMaskLength = pos < options.mask.length;
var posGreaterThanZero = pos > 0;
var notNumberOrPlaceholder = /[^0-9_]/;
var curPosOnSep = notNumberOrPlaceholder.test(maskValueAtCurPos);
var continueMovingPosition = curPosOnSep && posShorterThanMaskLength && posGreaterThanZero
// if we hit a real char, stay where we are
if (!continueMovingPosition) break;
// hitting backspace in a selection, you can possibly go back any further - go forward
pos += (key === BACKSPACE && !hasSel) ? -1 : 1;
}
if (hasSel) {
// pos might have moved so re-calc length
var selLength = selEnd - pos
// if we have a selection length we will wipe out entire selection and replace with default template for that range
var defaultBlank = options.mask.replace(/[0-9]/g, '_');
var defaultBlankSelectionReplacement = defaultBlank.substr(pos, selLength);
var selReplacementRemainder = defaultBlankSelectionReplacement.substr(1) // might be empty
var valueBeforeSel = val.substr(0, pos);
var insertChars = digit + selReplacementRemainder;
var charsAfterSelection = val.substr(pos + selLength);
val = valueBeforeSel + insertChars + charsAfterSelection
} else {
var valueBeforeCursor = val.substr(0, pos);
var insertChar = digit;
var valueAfterNextChar = val.substr(pos + 1);
val = valueBeforeCursor + insertChar + valueAfterNextChar
}
if ($.trim(val) === '') {
// if empty, set to default
val = defaultBlank
} else {
// if at the last character don't need to do anything
if (pos === options.mask.length) {
event.preventDefault();
return false;
}
}
// resume cursor location
pos += (key === BACKSPACE) ? 0 : 1;
// don't stop on a separator, continue whatever direction you were going
while (/[^0-9_]/.test(options.mask.substr(pos, 1)) && pos < options.mask.length && pos > 0) {
pos += (key === BACKSPACE) ? 0 : 1;
}
if (isValidValue(options.mask, val)) {
this.value = val;
setCaretPos(this, pos);
} else if ($.trim(val) === '') {
this.value = options.mask.replace(/[0-9]/g, '_');
} else {
input.trigger('error_input.xdsoft');
}
} else {
if (([AKEY, CKEY, VKEY, ZKEY, YKEY].indexOf(key) !== -1 && ctrlDown) || [ESC, ARROWUP, ARROWDOWN, ARROWLEFT, ARROWRIGHT, F5, CTRLKEY, TAB, ENTER].indexOf(key) !== -1) {
return true;
}
}
event.preventDefault();
return false;
});
}
}
_xdsoft_datetime.setCurrentTime(getCurrentValue());
input
.data('xdsoft_datetimepicker', datetimepicker)
.on('open.xdsoft focusin.xdsoft mousedown.xdsoft touchstart', function () {
if (input.is(':disabled') || (input.data('xdsoft_datetimepicker').is(':visible') && options.closeOnInputClick)) {
return;
}
if (!options.openOnFocus) {
return;
}
clearTimeout(timer);
timer = setTimeout(function () {
if (input.is(':disabled')) {
return;
}
triggerAfterOpen = true;
_xdsoft_datetime.setCurrentTime(getCurrentValue(), true);
if(options.mask) {
setMask(options);
}
datetimepicker.trigger('open.xdsoft');
}, 100);
})
.on('keydown.xdsoft', function (event) {
var elementSelector,
key = event.which;
if ([ENTER].indexOf(key) !== -1 && options.enterLikeTab) {
elementSelector = $("input:visible,textarea:visible,button:visible,a:visible");
datetimepicker.trigger('close.xdsoft');
elementSelector.eq(elementSelector.index(this) + 1).focus();
return false;
}
if ([TAB].indexOf(key) !== -1) {
datetimepicker.trigger('close.xdsoft');
return true;
}
})
.on('blur.xdsoft', function () {
datetimepicker.trigger('close.xdsoft');
});
};
destroyDateTimePicker = function (input) {
var datetimepicker = input.data('xdsoft_datetimepicker');
if (datetimepicker) {
datetimepicker.data('xdsoft_datetime', null);
datetimepicker.remove();
input
.data('xdsoft_datetimepicker', null)
.off('.xdsoft');
$(options.contentWindow).off('resize.xdsoft');
$([options.contentWindow, options.ownerDocument.body]).off('mousedown.xdsoft touchstart');
if (input.unmousewheel) {
input.unmousewheel();
}
}
};
$(options.ownerDocument)
.off('keydown.xdsoftctrl keyup.xdsoftctrl')
.on('keydown.xdsoftctrl', function (e) {
if (e.keyCode === CTRLKEY) {
ctrlDown = true;
}
})
.on('keyup.xdsoftctrl', function (e) {
if (e.keyCode === CTRLKEY) {
ctrlDown = false;
}
});
this.each(function () {
var datetimepicker = $(this).data('xdsoft_datetimepicker'), $input;
if (datetimepicker) {
if ($.type(opt) === 'string') {
switch (opt) {
case 'show':
$(this).select().focus();
datetimepicker.trigger('open.xdsoft');
break;
case 'hide':
datetimepicker.trigger('close.xdsoft');
break;
case 'toggle':
datetimepicker.trigger('toggle.xdsoft');
break;
case 'destroy':
destroyDateTimePicker($(this));
break;
case 'reset':
this.value = this.defaultValue;
if (!this.value || !datetimepicker.data('xdsoft_datetime').isValidDate(dateHelper.parseDate(this.value, options.format))) {
datetimepicker.data('changed', false);
}
datetimepicker.data('xdsoft_datetime').setCurrentTime(this.value);
break;
case 'validate':
$input = datetimepicker.data('input');
$input.trigger('blur.xdsoft');
break;
default:
if (datetimepicker[opt] && $.isFunction(datetimepicker[opt])) {
result = datetimepicker[opt](opt2);
}
}
} else {
datetimepicker
.setOptions(opt);
}
return 0;
}
if ($.type(opt) !== 'string') {
if (!options.lazyInit || options.open || options.inline) {
createDateTimePicker($(this));
} else {
lazyInit($(this));
}
}
});
return result;
};
$.fn.datetimepicker.defaults = default_options;
function HighlightedDate(date, desc, style) {
"use strict";
this.date = date;
this.desc = desc;
this.style = style;
}
};
;(function (factory) {
if ( typeof define === 'function' && define.amd ) {
// AMD. Register as an anonymous module.
define(['jquery', 'jquery-mousewheel'], factory);
} else if (typeof exports === 'object') {
// Node/CommonJS style for Browserify
module.exports = factory(require('jquery'));;
} else {
// Browser globals
factory(jQuery);
}
}(datetimepickerFactory));
/*!
* jQuery Mousewheel 3.1.13
*
* Copyright jQuery Foundation and other contributors
* Released under the MIT license
* http://jquery.org/license
*/
(function (factory) {
if ( typeof define === 'function' && define.amd ) {
// AMD. Register as an anonymous module.
define(['jquery'], factory);
} else if (typeof exports === 'object') {
// Node/CommonJS style for Browserify
module.exports = factory;
} else {
// Browser globals
factory(jQuery);
}
}(function ($) {
var toFix = ['wheel', 'mousewheel', 'DOMMouseScroll', 'MozMousePixelScroll'],
toBind = ( 'onwheel' in document || document.documentMode >= 9 ) ?
['wheel'] : ['mousewheel', 'DomMouseScroll', 'MozMousePixelScroll'],
slice = Array.prototype.slice,
nullLowestDeltaTimeout, lowestDelta;
if ( $.event.fixHooks ) {
for ( var i = toFix.length; i; ) {
$.event.fixHooks[ toFix[--i] ] = $.event.mouseHooks;
}
}
var special = $.event.special.mousewheel = {
version: '3.1.12',
setup: function() {
if ( this.addEventListener ) {
for ( var i = toBind.length; i; ) {
this.addEventListener( toBind[--i], handler, false );
}
} else {
this.onmousewheel = handler;
}
// Store the line height and page height for this particular element
$.data(this, 'mousewheel-line-height', special.getLineHeight(this));
$.data(this, 'mousewheel-page-height', special.getPageHeight(this));
},
teardown: function() {
if ( this.removeEventListener ) {
for ( var i = toBind.length; i; ) {
this.removeEventListener( toBind[--i], handler, false );
}
} else {
this.onmousewheel = null;
}
// Clean up the data we added to the element
$.removeData(this, 'mousewheel-line-height');
$.removeData(this, 'mousewheel-page-height');
},
getLineHeight: function(elem) {
var $elem = $(elem),
$parent = $elem['offsetParent' in $.fn ? 'offsetParent' : 'parent']();
if (!$parent.length) {
$parent = $('body');
}
return parseInt($parent.css('fontSize'), 10) || parseInt($elem.css('fontSize'), 10) || 16;
},
getPageHeight: function(elem) {
return $(elem).height();
},
settings: {
adjustOldDeltas: true, // see shouldAdjustOldDeltas() below
normalizeOffset: true // calls getBoundingClientRect for each event
}
};
$.fn.extend({
mousewheel: function(fn) {
return fn ? this.bind('mousewheel', fn) : this.trigger('mousewheel');
},
unmousewheel: function(fn) {
return this.unbind('mousewheel', fn);
}
});
function handler(event) {
var orgEvent = event || window.event,
args = slice.call(arguments, 1),
delta = 0,
deltaX = 0,
deltaY = 0,
absDelta = 0,
offsetX = 0,
offsetY = 0;
event = $.event.fix(orgEvent);
event.type = 'mousewheel';
// Old school scrollwheel delta
if ( 'detail' in orgEvent ) { deltaY = orgEvent.detail * -1; }
if ( 'wheelDelta' in orgEvent ) { deltaY = orgEvent.wheelDelta; }
if ( 'wheelDeltaY' in orgEvent ) { deltaY = orgEvent.wheelDeltaY; }
if ( 'wheelDeltaX' in orgEvent ) { deltaX = orgEvent.wheelDeltaX * -1; }
// Firefox < 17 horizontal scrolling related to DOMMouseScroll event
if ( 'axis' in orgEvent && orgEvent.axis === orgEvent.HORIZONTAL_AXIS ) {
deltaX = deltaY * -1;
deltaY = 0;
}
// Set delta to be deltaY or deltaX if deltaY is 0 for backwards compatabilitiy
delta = deltaY === 0 ? deltaX : deltaY;
// New school wheel delta (wheel event)
if ( 'deltaY' in orgEvent ) {
deltaY = orgEvent.deltaY * -1;
delta = deltaY;
}
if ( 'deltaX' in orgEvent ) {
deltaX = orgEvent.deltaX;
if ( deltaY === 0 ) { delta = deltaX * -1; }
}
// No change actually happened, no reason to go any further
if ( deltaY === 0 && deltaX === 0 ) { return; }
// Need to convert lines and pages to pixels if we aren't already in pixels
// There are three delta modes:
// * deltaMode 0 is by pixels, nothing to do
// * deltaMode 1 is by lines
// * deltaMode 2 is by pages
if ( orgEvent.deltaMode === 1 ) {
var lineHeight = $.data(this, 'mousewheel-line-height');
delta *= lineHeight;
deltaY *= lineHeight;
deltaX *= lineHeight;
} else if ( orgEvent.deltaMode === 2 ) {
var pageHeight = $.data(this, 'mousewheel-page-height');
delta *= pageHeight;
deltaY *= pageHeight;
deltaX *= pageHeight;
}
// Store lowest absolute delta to normalize the delta values
absDelta = Math.max( Math.abs(deltaY), Math.abs(deltaX) );
if ( !lowestDelta || absDelta < lowestDelta ) {
lowestDelta = absDelta;
// Adjust older deltas if necessary
if ( shouldAdjustOldDeltas(orgEvent, absDelta) ) {
lowestDelta /= 40;
}
}
// Adjust older deltas if necessary
if ( shouldAdjustOldDeltas(orgEvent, absDelta) ) {
// Divide all the things by 40!
delta /= 40;
deltaX /= 40;
deltaY /= 40;
}
// Get a whole, normalized value for the deltas
delta = Math[ delta >= 1 ? 'floor' : 'ceil' ](delta / lowestDelta);
deltaX = Math[ deltaX >= 1 ? 'floor' : 'ceil' ](deltaX / lowestDelta);
deltaY = Math[ deltaY >= 1 ? 'floor' : 'ceil' ](deltaY / lowestDelta);
// Normalise offsetX and offsetY properties
if ( special.settings.normalizeOffset && this.getBoundingClientRect ) {
var boundingRect = this.getBoundingClientRect();
offsetX = event.clientX - boundingRect.left;
offsetY = event.clientY - boundingRect.top;
}
// Add information to the event object
event.deltaX = deltaX;
event.deltaY = deltaY;
event.deltaFactor = lowestDelta;
event.offsetX = offsetX;
event.offsetY = offsetY;
// Go ahead and set deltaMode to 0 since we converted to pixels
// Although this is a little odd since we overwrite the deltaX/Y
// properties with normalized deltas.
event.deltaMode = 0;
// Add event and delta to the front of the arguments
args.unshift(event, delta, deltaX, deltaY);
// Clearout lowestDelta after sometime to better
// handle multiple device types that give different
// a different lowestDelta
// Ex: trackpad = 3 and mouse wheel = 120
if (nullLowestDeltaTimeout) { clearTimeout(nullLowestDeltaTimeout); }
nullLowestDeltaTimeout = setTimeout(nullLowestDelta, 200);
return ($.event.dispatch || $.event.handle).apply(this, args);
}
function nullLowestDelta() {
lowestDelta = null;
}
function shouldAdjustOldDeltas(orgEvent, absDelta) {
// If this is an older event and the delta is divisable by 120,
// then we are assuming that the browser is treating this as an
// older mouse wheel event and that we should divide the deltas
// by 40 to try and get a more usable deltaFactor.
// Side note, this actually impacts the reported scroll distance
// in older browsers and can cause scrolling to be slower than native.
// Turn this off by setting $.event.special.mousewheel.settings.adjustOldDeltas to false.
return special.settings.adjustOldDeltas && orgEvent.type === 'mousewheel' && absDelta % 120 === 0;
}
}));
================================================
FILE: assets/vendor/izimodal/iziModal.css
================================================
/*
* iziModal | v1.5.1
* http://izimodal.marcelodolce.com
* by Marcelo Dolce.
* slight modifications made for better WP theme compat
*/
.iziModal {
display: none;
position: fixed;
top: 0;
bottom: 0;
left: 0;
right: 0;
margin: auto;
background: #FFF;
box-shadow: 0 0 8px rgba(0,0,0,.3);
transition: margin-top 0.3s ease, height 0.3s ease;
transform: translateZ(0);
}
.iziModal *{
-webkit-font-smoothing: antialiased;
}
.iziModal::after{
content: '';
width: 100%;
height: 0px;
opacity: 0;
position: absolute;
left: 0;
bottom: 0;
z-index: 1;
background: -moz-linear-gradient(top, rgba(0,0,0,0) 0%, rgba(0,0,0,0.35) 100%);
background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,rgba(0,0,0,0)), color-stop(100%,rgba(0,0,0,0.35)));
background: -webkit-linear-gradient(top, rgba(0,0,0,0) 0%,rgba(0,0,0,0.35) 100%);
background: -o-linear-gradient(top, rgba(0,0,0,0) 0%,rgba(0,0,0,0.35) 100%);
background: -ms-linear-gradient(top, rgba(0,0,0,0) 0%,rgba(0,0,0,0.35) 100%);
background: linear-gradient(to bottom, rgba(0,0,0,0) 0%,rgba(0,0,0,0.35) 100%);
filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#00000000', endColorstr='#59000000',GradientType=0 );
transition: height 0.3s ease-in-out, opacity 0.3s ease-in-out;
pointer-events: none;
}
.iziModal.hasShadow::after{
height: 30px;
opacity: 1;
}
.iziModal .iziModal-progressbar{
position: absolute;
left: 0;
top: 0px;
width: 100%;
z-index: 1;
}
.iziModal .iziModal-progressbar > div{
height: 2px;
width: 100%;
}
.iziModal .iziModal-header {
background: #88A0B9;
padding: 14px 18px 15px 18px;
box-shadow: inset 0 -10px 15px -12px rgba(0, 0, 0, 0.3), 0 0 0px #555;
overflow: hidden;
position: relative;
z-index: 10;
}
.iziModal .iziModal-header-icon{
font-size: 40px;
color: rgba(255, 255, 255, 0.5);
padding: 0 15px 0 0;
margin: 0;
float: left;
}
.iziModal .iziModal-header-title {
color: #FFF;
font-size: 18px;
font-weight: 600;
line-height: 1.3;
}
.iziModal .iziModal-header-subtitle {
color: rgba(255, 255, 255, 0.6);
font-size: 12px;
line-height: 1.45;
}
.iziModal .iziModal-header-title, .iziModal .iziModal-header-subtitle{
display: block;
margin: 0;
padding: 0;
/*font-family*/: 'Lato', Arial;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
text-align: left;
}
.iziModal .iziModal-header-buttons {
position: absolute;
top: 50%;
right: 10px;
margin: -17px 0 0 0;
}
.iziModal .iziModal-button{
display: block;
float: right;
z-index: 2;
outline: none;
height: 34px;
width: 34px;
border: 0;
padding: 0;
margin: 0;
opacity: 0.3;
border-radius: 50%;
transition: transform 0.5s cubic-bezier(.16,.81,.32,1), opacity 0.5s ease;
background-size: 67% !important;
-webkit-tap-highlight-color: rgba(0,0,0,0);
-webkit-tap-highlight-color: transparent; /* For some Androids */
}
.iziModal .iziModal-button-close{
background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAsCAYAAAAehFoBAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyhpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTMyIDc5LjE1OTI4NCwgMjAxNi8wNC8xOS0xMzoxMzo0MCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIDIwMTUuNSAoV2luZG93cykiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6ODZCQkIzQ0I0RTg0MTFFNjlBODI4QTFBRTRBMkFCMDQiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6ODZCQkIzQ0M0RTg0MTFFNjlBODI4QTFBRTRBMkFCMDQiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDo4NkJCQjNDOTRFODQxMUU2OUE4MjhBMUFFNEEyQUIwNCIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDo4NkJCQjNDQTRFODQxMUU2OUE4MjhBMUFFNEEyQUIwNCIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PsgTJLcAAALJSURBVHja3JnLS1VBHMfvQ7g9dBXRRrwEFRciAhMi1JRW1aIHVEIYEkW0iVpUhOD/ICK6cFMgSbUpC6VFkQa9NtpjkauriRY9Noa3pHT8/mIODMM5Or85o87pC5/NPf5mvmc8M7+Z36SFEKkY2gj2gUawF2wHW8A6+fwv+A6KYAQMg+dg2rbDtKXhGnAaHJIms4zYz9J4HxgAf1g9k2EGteAhWBBuNApaQNrUg6nRTaAbzIuV0RCocWW4DoyJlVcJXI5ruFk2tJqi/2TWxvA5sXbqA2Ucw01i7dVjargazAo/dE33p6/DlAheg50pP0SJpwG8CH7IaH/Q5pFZUhnoArkwwwVwJeWfdoMLYYZvqG+yTGo9CerAoIWBT+A4qAdPDWOugwo1NVcxJtpFZRLkwH3GJCqCghJfxVjnz1JMMMKnwAbGRAg0B5rAA4O4CblZ+qj8tkBjZthvSzDCtFIMM0ZpQhslk5Eej4jpZ/T7G+ygwG1ghrk+jjNMFy1eMPJzpOAzlou6iWmXZkm91EBHjEwUZXoQTDk2SxqhRh7HTJ9hpstB3rFZ0ldq6J2DnB9m2rXZfxOPlrX1DrJRXiaBXSHPaMHvB0cd9JPLpBImMvzLQTuUFA6A9yHPfoIjhsllOc1l5N4grtmDWgYrl5+JTUZcSjNkeMyxWdpA3ZN72IJj01OJTByJS82J2/wQVxmB5y1HK8x0JWMf/kzdD98FJcY5S51gdwyTQl6eUAraspo27PeWXgy8afim0+CELAwOWHyH9EkdkyWwJ4Yxk6BCP+bTm48anutWW5dAp34IpbW03UOzb0FPVEHbx0LKfvAyqpAyKw97JU8Mt6pml6rAJ6oY6Eu5NfvfF7QTeWWQyEsZr6694lwsNoPD8mKRo29gCNwGj7gXi7aGA1EBcY+8vq0GW8FmJb3Pgx9gEnwAr8Ab8MW2w0UBBgAVyyyaohV7ewAAAABJRU5ErkJggg==') no-repeat 50% 50%;
}
.iziModal .iziModal-button-fullscreen{
background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAsCAYAAAAehFoBAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyhpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTMyIDc5LjE1OTI4NCwgMjAxNi8wNC8xOS0xMzoxMzo0MCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIDIwMTUuNSAoV2luZG93cykiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6RTBBOUI4RUM0RTg0MTFFNjk0NTY4NUNFRkZFNEFEQzIiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6RTBBOUI4RUQ0RTg0MTFFNjk0NTY4NUNFRkZFNEFEQzIiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDpFMEE5QjhFQTRFODQxMUU2OTQ1Njg1Q0VGRkU0QURDMiIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDpFMEE5QjhFQjRFODQxMUU2OTQ1Njg1Q0VGRkU0QURDMiIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PrQO6gAAAANmSURBVHjazJlbSBRRGMd3x92i0ForRRMiKiUoX4ouiFlJkRVBDxW9GJERwUasvdRT9FD00osRQtAFqegGBUHRBY0uaCVKEkSRpVR0tSwrQtp1+p/4Bk7D7M45M/Ot/uGHu+Psmf+c+eY753wnbJpmyIfGgvmgiv6WgkKQBwzwE3wBr0AnuAta6ZgnhT0aFuY2ghoyGdH4bS+4Dc6CZjCkdWVhWIPF4JoZnB6CDToeVE8sBidNPt0E5UEZrgG9Jr8GwHa/huMgaWZXDSDsxfBuc/jUBAwdw3Fz+NWoang5SJkjQwm7P3seLqQEX2LLfgfBdZcMORMcBqNDwekPqASP0uXhpjR3Ok0x/fUw9HIHGGVdw5DuRtzJpgxDsJui2qOWmuaAOuuLbHivz4YLwLgQj/aAXNmwuItlHhtbA7pAG5jEZHgKWCcbrhUTIY+NPQVjqFFObbYMi/hc6aOhl2AJ9TKnFoIyYXgemKEzJQXVVkyR3oFVzKZFuqw2qHdyFPKhrHPgMoWC3fRjRtNVVg+7SR5IiqmXxUt60cG0CK/vTIZniZVCmcKJF0C3ZNjKBqvJ9Hrwm46tsN1EkCoRQ/M3fBjvs6GrYAvdwHEfGcd1qBaGkwoxrKI+xjz83yJ0iLFHApd46X4xX+M+WECh4lepCNUIcpnMijrEWtAvTRHrbOd8FZNG8uA2Nf0hpmwtjBPwpQ5T0GPS/+tBAZhIq+b3Lu09EyHRwRgO+0C+7dhWcII+PwCf6Sk/Aa9d2vtn+A7nyASugJiD6YSDQcOlvVbxiCaAN8xrs3sgprBiac/QhlhnzjUo6JuZM0UlDS5FPtoQIdNlPYJTWUihFaDex+9Pg6T1KHJAJ2NI7ASllA28hEQ/KJIXoSlwgKlnh+jFe+GjLtwIPtjfyktUt+UaUZWqvw7H3oJD1peI7eQdoF1xWa+zQikHH13OmwqmOxxP0EiZtgK/DRwNuIcHwSeXc2K01WAPhbhKBb5hBNTVbskVH7fqpZGhbJUNtYF83fqwQSXPbOsGjb6etwx2gcEsmT3iFAZeNmUqaMeHSz2qu0k6W15Rqsx3B2i0D+xXGAHTFrRVlEeFuVoqH+ku6VNUbDkPzlAtg30nVK66i8rRIjAbTKaSQVQyN0DD6nOqcLZQld9TLfmvAAMAeMcvp3eCFqQAAAAASUVORK5CYII=') no-repeat 50% 50%;
}
.iziModal.isFullscreen .iziModal-button-fullscreen{
background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAsCAYAAAAehFoBAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyhpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTMyIDc5LjE1OTI4NCwgMjAxNi8wNC8xOS0xMzoxMzo0MCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIDIwMTUuNSAoV2luZG93cykiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6MkFFRTU5NDA0RTg1MTFFNjk0NEZFQzBGMkVBMDYyRDkiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6MkFFRTU5NDE0RTg1MTFFNjk0NEZFQzBGMkVBMDYyRDkiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDoyQUVFNTkzRTRFODUxMUU2OTQ0RkVDMEYyRUEwNjJEOSIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDoyQUVFNTkzRjRFODUxMUU2OTQ0RkVDMEYyRUEwNjJEOSIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PuDFfX8AAANASURBVHjazJlZSBVRGMfHcWlB0xZM68GKukQLYaGkmEUR2EsvRfQS+BSJPUQE+lTR8hqIZY8hFS0ERVCRoW3gpUApghYpszLTVnCB3O70/+K7MAwzc78Z58z4hx8XzpzvzJ+Zc+d85ztphmFoU9BsUAoq+XcFyAc5QAfD4BfoBp3gCWjnNl9K82mYzO0FVWwyw0NsD3gIroBWkPB0ZzLsgc3grhGcnoE9XjxIOxaCC4Y6tYC1QRmuAj2Geg2CA1M1XAsmjHDVANL8GK4zolMz0L0YrjWiV5PU8HYw6TBIf8imD6UynA96HYKPg3mgMUTDY6DUzXCzQ+AxSz+r6QEQZz4HbLoDZNkZrnAIoOlRZjN1Gk3XS0zty/gTFaRq7Ay3uAR8BcU2ps/z9QJTWw74HrDhTyDbbHg9SKQI+sb9rKa3mV8ZmAt+KJjP1TS+zinFPkqEUqQdBeAOKLa0UwIzpqlXtcYpIKWIO4RBZPoRKNfC10YQI8MlYLkwaAB8ABsiMDwDbKU8dgtIFwRMgJ3guRadKpNPWBMa7tOi1WoyHJPuTsC4oN+IQsOLM3gPJlEWqOE/neMGBqwDeYoMz6G8c0I4h6eFyHBC8A2eVoaH8JutaPwuUA/+uvSht1sHKgTjTWZwjUCVYdrK3xT0iwkND+lc5FClUQ9fINHCRYY7FBrWPSz5Er2lAR9H9P+hpfYGl64OCmPadQ7ojcDwOJetysBMQX/6mrWS4d+cIoYtMnAEnBT2fwVeJufYxZBMFoKFlrajQtOX/uczvEtIB50Kdgn1lt3JGdANltjsXE64jPMnuQ1LPuFJcFrBE11gzQXAUnAPFNk86esO4zSBfmu5lVa9toCf8DC4Ba6C22DEdO01KDLdP5fLr1Z94X2ibV1ilWVQ1XrDpvPAU4c+u1KVqvaHXI7q43ltp3PSYmDDNCgGPrCUD1wN6y5lqzAUN89baX1Y55Jn2LrPRUffRwaHwWhIZs/aTQM/hzLlDp+coPRReprk5cgrkyvz7wM0+hOcAvOlPvwcLNIp526ux1H5aJbHeFpVX4Br4LLXWoffk9CkVnLlaBNYAxaBXJBpMjfIy+o7EAdtfIyb8HPDfwIMAM1WPs8F9tcxAAAAAElFTkSuQmCC') no-repeat 50% 50%;
}
.iziModal .iziModal-button-close:hover{
transform: rotate(180deg);
}
.iziModal .iziModal-button:hover{
opacity: 0.8;
}
.iziModal .iziModal-header.iziModal-noSubtitle{
height: auto;
padding: 10px 15px 12px 15px;
}
.iziModal .iziModal-header.iziModal-noSubtitle .iziModal-header-icon{
font-size: 23px;
padding-right: 13px;
}
.iziModal .iziModal-header.iziModal-noSubtitle .iziModal-header-title{
font-size: 15px;
margin: 3px 0 0 0;
font-weight: 400;
}
.iziModal .iziModal-header.iziModal-noSubtitle .iziModal-header-buttons{
right: 6px;
margin: -16px 0 0 0;
}
.iziModal .iziModal-header.iziModal-noSubtitle .iziModal-button{
height: 30px;
width: 30px;
}
/* RTL */
.iziModal-rtl {
direction: rtl;
}
.iziModal-rtl .iziModal-header {
padding: 14px 18px 15px 40px;
}
.iziModal-rtl .iziModal-header-icon {
float: right;
padding: 0 0 0 15px;
}
.iziModal-rtl .iziModal-header-buttons{
right: initial;
left: 10px;
}
.iziModal-rtl .iziModal-button{
float: left;
}
.iziModal-rtl .iziModal-header-title, .iziModal-rtl .iziModal-header-subtitle{
text-align: right;
/*font-family*/: Tahoma, 'Lato', Arial;
font-weight: 500;
}
.iziModal-rtl .iziModal-header.iziModal-noSubtitle {
padding: 10px 15px 12px 40px;
}
.iziModal-rtl .iziModal-header.iziModal-noSubtitle .iziModal-header-icon {
padding: 0 0 0 13px;
}
/* LIGHT THEME */
.iziModal.iziModal-light .iziModal-header-icon{
color: rgba(0, 0, 0, 0.5);
}
.iziModal.iziModal-light .iziModal-header-title{
color: #000;
}
.iziModal.iziModal-light .iziModal-header-subtitle{
color: rgba(0, 0, 0, 0.6);
}
.iziModal.iziModal-light .iziModal-button-close{
background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAsCAYAAAAehFoBAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA4JpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTM4IDc5LjE1OTgyNCwgMjAxNi8wOS8xNC0wMTowOTowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDoyQTU1RUZDNzRFODQxMUU2ODAxOEUwQzg0QjBDQjI3OSIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDo1NEM4MTU1MEI4QUExMUU2QjNGOEVBMjg4OTRBRTg2NyIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDo0RTNFNENDMkI4QUExMUU2QjNGOEVBMjg4OTRBRTg2NyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ0MgMjAxNyAoTWFjaW50b3NoKSI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjZjYzMwMmE1LWFlMjEtNDI3ZS1hMmE4LTJlYjhlMmZlY2E3NSIgc3RSZWY6ZG9jdW1lbnRJRD0iYWRvYmU6ZG9jaWQ6cGhvdG9zaG9wOjdmYmU3NGE3LTAxMDUtMTE3YS1hYmM3LWEzNWNkOWU1Yzc4NyIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/Po24QssAAANtSURBVHja3JlJaBRBFIa7ZxyTSXADHUkikuAawZNLEOOGGrwJQYko8R4RBQ+OICoqghJQUVwPYjzFY0QUBQU1kogoKO6CG0pcIwbiNibj/8JraNvu6Xo9NTOtP3xzSKe6/65+Ve9VlWlkp2IwGUwFE0E5GA4G8/U+0APegWfgHrgPuq0bpNNp0QPNgEYngHlgGpuMCNp2s+kr4BYM/8ql4WqwHEzP4mXteg7awOW0YlerPnQIaARLNBl1ikLlBDw/1WF4ClgHKozc6idogekz2RheANbaBlE+dB4chfF+qeHF3LOF0FWwF6b7nBe8RvecApolzQVr3C64GR4H1huFV51pmvV+hikRbABFRji0GqarMxluAGON8CgKmmA65mZ4DFhqhE9VPP//ZXgZiCmm1t1gI6XWAAY+gF0gCe4qtqlHL8fthkeBWsXGreA6eMgPviEw+x5sBZ3gAdjPCcNPI8Fsu+FawUCzz40psEfRNJndBl7b/pZmVLTQMkzJo0bQSys43iWm3cxS+DUJOmoSwqKCRmEZWKkYv6RSMBPc5lqXRGm0A1Q6XiaT2aSwo8jrK/qZwZlFIlXTusxa6iXDddTdARpnMj2ek9AWjWYH7h/lubcs4A28THdyAdOl0ezAmKNBNyLLiT0Btjti9zuHg06zpJKIprohwXNypcu1OIdGjYbnxCLGPyYy/EPDfejzbwYvXK59AzuFGdFLKTL8WYNZ59RVzGESJCNm0teI40E6zNIA2wSaA2REP32iaW0omKXRbJKTUVyYEVV0J8oxvEiQmiUZrFSz6XNkuJe3nBKCelaSbjOZrhLsd1BInYxweSeJq9YA6dYtuZCBI4JZ6jGW/W+sebhd0DAaMIO5mTYFW1+X6GeQ7TO3W0WyQj3cw0ulBg4nSUbcAY7zPVYp7ip95FXOH29Hb35AOPjypWMIh7PORSjFZVsIzdKW7AWvfYnTVNWHyCytHw+jd1Nehqks3KepvtChUzD7yGvE2/cduqxldQF1EWZb/PbWLF3jAVgo0WrlkN+c6hSd+rzlaSuaR7O0oX0wyIa2pVAdGaj0HCUVOqIq4dVwrg5lmmG2w+8f/9tjL6foYHE+Gy8Xtv3CPUpf7WauDxadKuIwoeNbOmoYDYbZ0ns/1wxUC7ykigs8sS/LpEe3vwUYALiKDDDSgEiSAAAAAElFTkSuQmCC') no-repeat 50% 50%;
}
.iziModal.iziModal-light .iziModal-button-fullscreen{
background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAsCAYAAAAehFoBAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA4JpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTM4IDc5LjE1OTgyNCwgMjAxNi8wOS8xNC0wMTowOTowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDpEQTg1NTA2NTRFODQxMUU2OTQ0N0VERjY2Q0M5ODYwRCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDo0RTNFNENCQkI4QUExMUU2QjNGOEVBMjg4OTRBRTg2NyIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDo0RTNFNENCQUI4QUExMUU2QjNGOEVBMjg4OTRBRTg2NyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ0MgMjAxNyAoTWFjaW50b3NoKSI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjFlNTQwYzczLTVhZmEtNDJlYi04YzJlLWMwMzFlYmFiYmIyNiIgc3RSZWY6ZG9jdW1lbnRJRD0iYWRvYmU6ZG9jaWQ6cGhvdG9zaG9wOmVkYmRiMzM1LTAxMDUtMTE3YS1hYmM3LWEzNWNkOWU1Yzc4NyIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PvIicdUAAAOvSURBVHjaxJlZbA1hFMe/qaItUUsspakg1laJ7UUisQuRvvTFA15sQSRCLBFrQryhHqxNHxEPtaQ8CCUkIrVVRbVBJdZYSrXVonr9/3pGxnTunZk78/X+k1+aO+1899/vnnvO+c4YKpi6ghEgW34OBD1BKjBAM6gH78Fz8BhUyrW/ikQivt7QiNMozU0DE8RkJx/3fgCPwA1QHvHp2K/hHJAPJqpwVA2K4flW2IZ7gyVgptKjh6AQxl+GYZi7uRr0U3rVBIpg+nIQwwvACpCkOk4XwYlosR3LMGN1qUqMroGDTqaNGDu7SiVWl+D3iP2i00c9HqxUidd8wzDy3HY4HRwCfWzXz4L7Lm+QKfHeOUTTLWAzdro6muH1YIbDjculWrmpUEM2YYXcCNMt9pAYE8WsWYLdlAxaNYTGMDDHKYYXBVy4B0jTFM/5iOcUc1fM/2JcnItNAYtBNzGtQ33BVHDV3OHpARqhV6CLLKpTs8yQYHxOCrDQO7AV1Gg2PBJhMYiGh4MMnx1eLkixXKsFuzSbZrrMpeGxHnqFFtvrTWCbhILd9AuNpnPMHXaTtZD0kl1mRdwSxXSjJsNZfONjcmqIJR5p3lp6Y+sXrAzsBz/lNXvmtZYMFKbqafi0pKQgKpOSPhmsC5BxXEs1Fz4fUr/7TWMe/q9bC2s3tJs1Df/Q/B5PwAZwJYS1WpPlo0zRZJZziL2gQU7I1GyHL7QSD26taVOytI26DpinxKypApvpk+C6dHlMnXskbUbT1yTpN3WJHWB327UCS3hUoc+tA/VyxP/ost5rGq7QWZnAdoe0eZgnYweDbgmgkoafgk8aTfNgsMNmmqfhC+Czj3V4T3mSBH255kxB0ztd4tNNDJkas2CUdkAKHQ3yAtxfijj/bdb7Cumyhmoyexzcs6Qwv2qUbPKvJDOtnNFklrF3R5qneA2XYHe/2A+ht1Xb3FZXRY1XTAjFTgtxJ45qKtWDpZK1g6dhIQuvBzjcy8FgQ6y8Nw+sCdnwL1Dn8jdMe6m2a+3ma9ESNUdOC1VixSH3bnPiYyraswnO0fqDIQkyW8WmCWab7b+I9TCF3+x0j2e+MPUA7LPGrVfD1F3VNsrPVR0zhS8BB5x21muzYa1Sy1Tb4y4d4qOwIi9Pk/wcj1gV50p5zQjJKAsJH8KcY4vpdYrjV0w9HMxxHjfKNpfwdMyRNuAmyy2M1vq5OegBNFMmR9lSHDizSLPMJGjuO2BZfSOtLKvpMylUvh/d/hFgAOH4+ibxGTZuAAAAAElFTkSuQmCC') no-repeat 50% 50%;
}
.iziModal.iziModal-light.isFullscreen .iziModal-button-fullscreen{
background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAsCAYAAAAehFoBAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA3BpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTM4IDc5LjE1OTgyNCwgMjAxNi8wOS8xNC0wMTowOTowMSAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDoyRUUxMkYxODRFODUxMUU2Qjc3RDk0MUUzMzJDRjBEOCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDo0RTNFNENCRkI4QUExMUU2QjNGOEVBMjg4OTRBRTg2NyIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDo0RTNFNENCRUI4QUExMUU2QjNGOEVBMjg4OTRBRTg2NyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ0MgMjAxNyAoTWFjaW50b3NoKSI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOjgzM2MwOWZiLWJjOTEtNGVlZS05MDM1LTRkMmU2ZmE1ZjBmMiIgc3RSZWY6ZG9jdW1lbnRJRD0ieG1wLmRpZDoyRUUxMkYxODRFODUxMUU2Qjc3RDk0MUUzMzJDRjBEOCIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/Pv1Q9Z8AAAOXSURBVHjaxJlLbA1RGMfPjIs+EvoIRYt4FVUl2EkkRTxKUqQbG0SEho2FjUQ8YtEICbEgTdFYeK1KaGvVeoUltyStt0UlNE17aWhV2+v/9X5XJpMzc8/0zpn5kl+aO3Nm7r/fnPu9xhDp2URQDJbw3xkgB2QCAwyAPvANfARvQDsfG7V4PO7pC40xCiVxa8AKFjnOw7VdoA08BtG4R8VeBZeCKrBS+GPvQAM0P/NbcB7YBdYJPfYKXIXwL34IJm8eBFOFXusH9RDdnI7gLWA/MEVwdh/UOe1tN8G0V3eLcKwFXJCJNl08G5ZYsrWgWnZCJng5OOBwo1iAoisMw6hMJXgyOOywVW7xj+9BgKL3QHSxm+C9IF9y4U2GMlStRPQP8Jbp9lFwhJwE0RHrgaSV8N6xG238l7Zjtfx3K58/Bd7zsWngIqdnP2we2ACa7B7e6RL6joK5EtHNfL7b5u1Bn7dGFbycYRVM/8WyFJnuJK+z2iVwzFrMcF1h+Cx4ClhtFVyu8CW54ITE01EwFMAPcH1SMJWIqxQvItE1YHEIsXkhtkUhCV4ApiteFOPadn4IgseDMooSSxVrhWFwmkvCsKw06WGhKLhHhGuzSHChh9pZ5cc1oFFwfoTTsWrWqQCvXdZQEpkDsjUJziSv3Qu43k3LTA1BXqvRY/4DMjTd/yu4niJVm9wslCjcb4QE/9Qo+Al44baAmgpKCIqC+01OBLrsr8/de8zkiYwuUxWSq7iuM8JhantIqfYItkOepKBysnbycIfPXYKqURL6DhaBCQrrKcZHTa5loyEIJgHXwG3F9TQV+pxMGK0BiaTHn2OLEjcURbdi7XBSMO3jTxoEjtg+7wDnhG3spSD6F3hk7Tjoxnc0CJ5k+5wFCrhplYl2mmI24nyvvWumAE9z2zIfBW8WifnxIHc2yb6xiHtEoms0/hlGtpAPHCkgNDjFyZngPN88COvkPpEe+XGHbFcD7z53C+ybwKEAo0UPZ8QCybkmiL3sNvkheygSI08RYOSQiaUhd52sUpIZLWwJsYqkkdcZeHfIS66nc9XcZQRpNBY7C7F9Yy1OtonErDgSgNhGcEXmWa/VFA1O9onE6y4dRqGtXuVtkpf2iDy8EVR6GLykMnrsNFC867QF0hH8v3MVicFcuYdKy56uqQx4SukWQj3NOtJtQIt4ckSvbmdziMqy7HcS9xv0cn/Xwdn0A1drnl/d/hNgAGQa6Lgarp6BAAAAAElFTkSuQmCC') no-repeat 50% 50%;
}
.iziModal .iziModal-loader{
background: #FFF url(data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNDQiIGhlaWdodD0iNDQiIHZpZXdCb3g9IjAgMCA0NCA0NCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiBzdHJva2U9IiM5OTkiPiAgICA8ZyBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiIHN0cm9rZS13aWR0aD0iMiI+ICAgICAgICA8Y2lyY2xlIGN4PSIyMiIgY3k9IjIyIiByPSIxIj4gICAgICAgICAgICA8YW5pbWF0ZSBhdHRyaWJ1dGVOYW1lPSJyIiAgICAgICAgICAgICAgICBiZWdpbj0iMHMiIGR1cj0iMS40cyIgICAgICAgICAgICAgICAgdmFsdWVzPSIxOyAyMCIgICAgICAgICAgICAgICAgY2FsY01vZGU9InNwbGluZSIgICAgICAgICAgICAgICAga2V5VGltZXM9IjA7IDEiICAgICAgICAgICAgICAgIGtleVNwbGluZXM9IjAuMTY1LCAwLjg0LCAwLjQ0LCAxIiAgICAgICAgICAgICAgICByZXBlYXRDb3VudD0iaW5kZWZpbml0ZSIgLz4gICAgICAgICAgICA8YW5pbWF0ZSBhdHRyaWJ1dGVOYW1lPSJzdHJva2Utb3BhY2l0eSIgICAgICAgICAgICAgICAgYmVnaW49IjBzIiBkdXI9IjEuNHMiICAgICAgICAgICAgICAgIHZhbHVlcz0iMTsgMCIgICAgICAgICAgICAgICAgY2FsY01vZGU9InNwbGluZSIgICAgICAgICAgICAgICAga2V5VGltZXM9IjA7IDEiICAgICAgICAgICAgICAgIGtleVNwbGluZXM9IjAuMywgMC42MSwgMC4zNTUsIDEiICAgICAgICAgICAgICAgIHJlcGVhdENvdW50PSJpbmRlZmluaXRlIiAvPiAgICAgICAgPC9jaXJjbGU+ICAgICAgICA8Y2lyY2xlIGN4PSIyMiIgY3k9IjIyIiByPSIxIj4gICAgICAgICAgICA8YW5pbWF0ZSBhdHRyaWJ1dGVOYW1lPSJyIiAgICAgICAgICAgICAgICBiZWdpbj0iLTAuOXMiIGR1cj0iMS40cyIgICAgICAgICAgICAgICAgdmFsdWVzPSIxOyAyMCIgICAgICAgICAgICAgICAgY2FsY01vZGU9InNwbGluZSIgICAgICAgICAgICAgICAga2V5VGltZXM9IjA7IDEiICAgICAgICAgICAgICAgIGtleVNwbGluZXM9IjAuMTY1LCAwLjg0LCAwLjQ0LCAxIiAgICAgICAgICAgICAgICByZXBlYXRDb3VudD0iaW5kZWZpbml0ZSIgLz4gICAgICAgICAgICA8YW5pbWF0ZSBhdHRyaWJ1dGVOYW1lPSJzdHJva2Utb3BhY2l0eSIgICAgICAgICAgICAgICAgYmVnaW49Ii0wLjlzIiBkdXI9IjEuNHMiICAgICAgICAgICAgICAgIHZhbHVlcz0iMTsgMCIgICAgICAgICAgICAgICAgY2FsY01vZGU9InNwbGluZSIgICAgICAgICAgICAgICAga2V5VGltZXM9IjA7IDEiICAgICAgICAgICAgICAgIGtleVNwbGluZXM9IjAuMywgMC42MSwgMC4zNTUsIDEiICAgICAgICAgICAgICAgIHJlcGVhdENvdW50PSJpbmRlZmluaXRlIiAvPiAgICAgICAgPC9jaXJjbGU+ICAgIDwvZz48L3N2Zz4=) no-repeat 50% 50%;
position: absolute;
left: 0;
right: 0;
top: 0;
bottom: 0;
z-index: 9;
}
.iziModal .iziModal-content-loader{
background: url(data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iNDQiIGhlaWdodD0iNDQiIHZpZXdCb3g9IjAgMCA0NCA0NCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiBzdHJva2U9IiM5OTkiPiAgICA8ZyBmaWxsPSJub25lIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiIHN0cm9rZS13aWR0aD0iMiI+ICAgICAgICA8Y2lyY2xlIGN4PSIyMiIgY3k9IjIyIiByPSIxIj4gICAgICAgICAgICA8YW5pbWF0ZSBhdHRyaWJ1dGVOYW1lPSJyIiAgICAgICAgICAgICAgICBiZWdpbj0iMHMiIGR1cj0iMS40cyIgICAgICAgICAgICAgICAgdmFsdWVzPSIxOyAyMCIgICAgICAgICAgICAgICAgY2FsY01vZGU9InNwbGluZSIgICAgICAgICAgICAgICAga2V5VGltZXM9IjA7IDEiICAgICAgICAgICAgICAgIGtleVNwbGluZXM9IjAuMTY1LCAwLjg0LCAwLjQ0LCAxIiAgICAgICAgICAgICAgICByZXBlYXRDb3VudD0iaW5kZWZpbml0ZSIgLz4gICAgICAgICAgICA8YW5pbWF0ZSBhdHRyaWJ1dGVOYW1lPSJzdHJva2Utb3BhY2l0eSIgICAgICAgICAgICAgICAgYmVnaW49IjBzIiBkdXI9IjEuNHMiICAgICAgICAgICAgICAgIHZhbHVlcz0iMTsgMCIgICAgICAgICAgICAgICAgY2FsY01vZGU9InNwbGluZSIgICAgICAgICAgICAgICAga2V5VGltZXM9IjA7IDEiICAgICAgICAgICAgICAgIGtleVNwbGluZXM9IjAuMywgMC42MSwgMC4zNTUsIDEiICAgICAgICAgICAgICAgIHJlcGVhdENvdW50PSJpbmRlZmluaXRlIiAvPiAgICAgICAgPC9jaXJjbGU+ICAgICAgICA8Y2lyY2xlIGN4PSIyMiIgY3k9IjIyIiByPSIxIj4gICAgICAgICAgICA8YW5pbWF0ZSBhdHRyaWJ1dGVOYW1lPSJyIiAgICAgICAgICAgICAgICBiZWdpbj0iLTAuOXMiIGR1cj0iMS40cyIgICAgICAgICAgICAgICAgdmFsdWVzPSIxOyAyMCIgICAgICAgICAgICAgICAgY2FsY01vZGU9InNwbGluZSIgICAgICAgICAgICAgICAga2V5VGltZXM9IjA7IDEiICAgICAgICAgICAgICAgIGtleVNwbGluZXM9IjAuMTY1LCAwLjg0LCAwLjQ0LCAxIiAgICAgICAgICAgICAgICByZXBlYXRDb3VudD0iaW5kZWZpbml0ZSIgLz4gICAgICAgICAgICA8YW5pbWF0ZSBhdHRyaWJ1dGVOYW1lPSJzdHJva2Utb3BhY2l0eSIgICAgICAgICAgICAgICAgYmVnaW49Ii0wLjlzIiBkdXI9IjEuNHMiICAgICAgICAgICAgICAgIHZhbHVlcz0iMTsgMCIgICAgICAgICAgICAgICAgY2FsY01vZGU9InNwbGluZSIgICAgICAgICAgICAgICAga2V5VGltZXM9IjA7IDEiICAgICAgICAgICAgICAgIGtleVNwbGluZXM9IjAuMywgMC42MSwgMC4zNTUsIDEiICAgICAgICAgICAgICAgIHJlcGVhdENvdW50PSJpbmRlZmluaXRlIiAvPiAgICAgICAgPC9jaXJjbGU+ICAgIDwvZz48L3N2Zz4=) no-repeat 50% 50%;
}
.iziModal .iziModal-content:before,
.iziModal .iziModal-content:after { content:''; display:table }
.iziModal .iziModal-content:after { clear:both }
.iziModal .iziModal-content{
zoom:1;
width: 100%;
-webkit-overflow-scrolling: touch;
/*overflow-y: scroll;*/
}
.iziModal .iziModal-wrap{
width: 100%;
position: relative;
-webkit-overflow-scrolling: touch;
overflow-scrolling: touch;
}
.iziModal .iziModal-iframe{
border: 0;
margin: 0 0 -6px 0;
width: 100%;
transition: height 0.3s ease;
}
.iziModal-overlay{
display: block;
position: fixed;
top: 0;
left: 0;
height: 100%;
width: 100%;
}
.iziModal-navigate{
position: fixed;
left: 0;
right: 0;
top: 0;
bottom: 0;
pointer-events: none;
}
.iziModal-navigate-caption{
position: absolute;
left: 10px;
top: 10px;
color: white;
line-height: 16px;
font-size: 9px;
/*font-family*/: 'Lato', Arial;
letter-spacing: 0.1em;
text-indent: 0;
text-align: center;
width: 70px;
padding: 5px 0;
text-transform: uppercase;
display: none;
}
.iziModal-navigate-caption::before, .iziModal-navigate-caption::after {
position: absolute;
top: 2px;
width: 20px;
height: 20px;
text-align: center;
line-height: 14px;
font-size: 12px;
content: '';
background-size: 100% !important;
}
.iziModal-navigate-caption:before{
left: 0;
background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAoCAYAAACFFRgXAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAA4ZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8+IDx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTMyIDc5LjE1OTI4NCwgMjAxNi8wNC8xOS0xMzoxMzo0MCAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIgeG1sbnM6eG1wTU09Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9tbS8iIHhtbG5zOnN0UmVmPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VSZWYjIiB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iIHhtcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD0ieG1wLmRpZDoyNmFjNjAyMy04OWU0LWE0NDAtYmMxMy1kOTA5MTQ3MmYzYjAiIHhtcE1NOkRvY3VtZW50SUQ9InhtcC5kaWQ6NDREQ0YwRjA1MzQzMTFFNkE5NUNDRDkyQzEwMzM5RTMiIHhtcE1NOkluc3RhbmNlSUQ9InhtcC5paWQ6NDREQ0YwRUY1MzQzMTFFNkE5NUNDRDkyQzEwMzM5RTMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIDIwMTUuNSAoV2luZG93cykiPiA8eG1wTU06RGVyaXZlZEZyb20gc3RSZWY6aW5zdGFuY2VJRD0ieG1wLmlpZDpmNmM0Nzk3Ni1mNzE3LTk5NDAtYTgyYS1mNTdjNmNiYmU0NWMiIHN0UmVmOmRvY3VtZW50SUQ9ImFkb2JlOmRvY2lkOnBob3Rvc2hvcDowZGVmYTEyZC01MzM0LTExZTYtYWRkYi04Y2NmYjI5ZTAxNjYiLz4gPC9yZGY6RGVzY3JpcHRpb24+IDwvcmRmOlJERj4gPC94OnhtcG1ldGE+IDw/eHBhY2tldCBlbmQ9InIiPz7oo0ptAAACWklEQVR42uyZTWsTYRSFZybxo4kWk5g2NC5qTAU3Kq30A9udi1oXolV/hWuhv6R/Q6utioi4LbbVFHemamlRU0OCEk0wZjwXzwtDoBDopHMHcuFJMplZnLm5ue+589qu61qeOApyYAjEgG0FEyLqN/gKiqBuTtgewWlwCZw056xgwwirgU3wxSv4NJgCUV5YBRXQDEhsBJwCSSauBVZFdJRlIJk9Av7wbj577jDIOENtRmPVwcsw6KfAAvikRKzEDlhnhuU/lRPBWaa9wsxqC6ndPX7OiOA4D8qW3vjO9z7H0w3+KhZstNmOFbLoCQ6DYGmL+bAInmGfLFC4asFXwRJIgB+goVmw+I7HXO+/gevGnGgUPEGxktkSmAMbWmt4HDwBKS6XN1jDKrvEFYoVK7oLroE3h93Woh1eNwqWafJ/gQV65vM+ail34mc6EZwBK2CAx8fAIjjeBYMzDT4cVHCEXtRbRvEu/Nr9HCIOnGGp15vgEec9KYn74B0nAT/CZnv86FcNvwK3wENwAjwAs2Bbs5d4CW5zir0AXvv8p+tKH34B5lkW4h2egRHtbu05uMMHHWfB0zC4NRF5l09kzvE4rd2tyUJyjy4tz7akZqXbL8QETbJ/FsMgWOJtb6brCQ5YsBsC8Uab63DVkkgqFpzie93h8OhScFah2LTHi5ccWroaLd5l6//+hpYQoWP05LKqFs2WQYbTsNxAi+5fxpWmdfh7HS7XhwSzG+H3a2JnvZsyktmLbdOFhpDMvrf4sN1u2/aK0cwMcmYLcturweceW+CnOfFPgAEA8uWFFylBJYoAAAAASUVORK5CYII=') no-repeat 50% 50%;
}
.iziModal-navigate-caption:after{
right: 0;
background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAoCAYAAACFFRgXAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAZdEVYdFNvZnR3YXJlAEFkb2JlIEltYWdlUmVhZHlxyWU8AAADhmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4gPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS42LWMxMzIgNzkuMTU5Mjg0LCAyMDE2LzA0LzE5LTEzOjEzOjQwICAgICAgICAiPiA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPiA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIiB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyIgeG1wTU06T3JpZ2luYWxEb2N1bWVudElEPSJ4bXAuZGlkOjI2YWM2MDIzLTg5ZTQtYTQ0MC1iYzEzLWQ5MDkxNDcyZjNiMCIgeG1wTU06RG9jdW1lbnRJRD0ieG1wLmRpZDo0NERDRjBGMDUzNDMxMUU2QTk1Q0NEOTJDMTAzMzlFMyIgeG1wTU06SW5zdGFuY2VJRD0ieG1wLmlpZDo0NERDRjBFRjUzNDMxMUU2QTk1Q0NEOTJDMTAzMzlFMyIgeG1wOkNyZWF0b3JUb29sPSJBZG9iZSBQaG90b3Nob3AgQ0MgMjAxNS41IChXaW5kb3dzKSI+IDx4bXBNTTpEZXJpdmVkRnJvbSBzdFJlZjppbnN0YW5jZUlEPSJ4bXAuaWlkOmY2YzQ3OTc2LWY3MTctOTk0MC1hODJhLWY1N2M2Y2JiZTQ1YyIgc3RSZWY6ZG9jdW1lbnRJRD0iYWRvYmU6ZG9jaWQ6cGhvdG9zaG9wOjBkZWZhMTJkLTUzMzQtMTFlNi1hZGRiLThjY2ZiMjllMDE2NiIvPiA8L3JkZjpEZXNjcmlwdGlvbj4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gPD94cGFja2V0IGVuZD0iciI/PuijSm0AAAKbSURBVFhH7ZnJj0xRGEerzFoIMTaCZmOIedhaiJj55yz8DaYdNhIJEUMQbCTG3rQ02hDSiEY553XdTpHS3nv96taV9ElO6lVt6peb7933fffVG41GrYW5uBaX4EysYzcw1Fd8hc/wM2a0Bl6Nm3BW9i0dDPsQX/olBF6FO72AH/gG3+N3jL3KBpqGC3ERTsGfeAsHDTyHi71oCXzBe/gaU2A5bscZOIxXTb8OLQNX9i6mElYsg/voqruwfQb2BhODWgqpMYDv0NLsNXC4yd42P1PEwNJj4HBTWdipErLVDfxfMRm408QMvBu3jV6WJ1Zg9/rbeBOP+UNZYgX+iE/Rp+lpPIKliBXYB9IhtPNy3z/T/F6YmDXsChvyBc7Gs3gACxEzsDzBg9iPPXgO92NuYgeWx2h3+AhtaM7jPsyF7aV37XR8gNZYO/pwKY51+xPkG27Fk2joT3gCr2A7NuJ6HMkTeAPadlp3VeMChF7G0P6X3dmfjAXOUxIj6LZkv1ylNuStDZejkL+PS96ScFzRqnDAtI5PoTefvbg7iNNOOwqVRCfYghdxBbpHH8Y7+DcKlUTV7MLLaNghPIrjhf2N2IF34AVcjE44hrXHyE3MwE6/loEzpEcIlqKjeyFiBe7FS+he/gENewMLEyuwXdo8dGWP43UsRazA9g7uDNbwNX8oS8watlsz+ISIGbgSJgN3GgOHlnFq8zNFQraGgT1iFc9iUyU0XsMGHhy9zh6XbvCp4ZuBBWglDBj4OdqLeu0+uRJTwMZ+Dbp/e21P3m97yWe2snsw1LTHmz5C/9lQdwhfGbiq89GwvrrwUT4UAouhN6MzloTRpVuEYI5O9urZYXtrYPGQw2OlZegM163QhrJMfWVgyTq0Qq32C/N7uPz9OknWAAAAAElFTkSuQmCC') no-repeat 50% 50%;
}
.iziModal-navigate > button{
position: fixed;
bottom: 0;
top: 0;
border:0;
height: 100%;
width: 84px;
background-color: transparent !important;
background-size: 100% !important;
cursor: pointer;
padding: 0;
opacity: 0.2;
transition: opacity 0.3s ease;
pointer-events: all;
margin: 0;
outline: none;
}
.iziModal-navigate > button:hover{
background-color: transparent !important;
opacity: 1;
}
.iziModal-navigate-prev{
left: 50%;
background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAALwAAAC8CAYAAADCScSrAAAACXBIWXMAAAsTAAALEwEAmpwYAAA5sGlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4KPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS42LWMxMzIgNzkuMTU5Mjg0LCAyMDE2LzA0LzE5LTEzOjEzOjQwICAgICAgICAiPgogICA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPgogICAgICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgICAgICAgICB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIKICAgICAgICAgICAgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZVJlZiMiCiAgICAgICAgICAgIHhtbG5zOnN0RXZ0PSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvc1R5cGUvUmVzb3VyY2VFdmVudCMiCiAgICAgICAgICAgIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyIKICAgICAgICAgICAgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIgogICAgICAgICAgICB4bWxuczpwaG90b3Nob3A9Imh0dHA6Ly9ucy5hZG9iZS5jb20vcGhvdG9zaG9wLzEuMC8iCiAgICAgICAgICAgIHhtbG5zOnRpZmY9Imh0dHA6Ly9ucy5hZG9iZS5jb20vdGlmZi8xLjAvIgogICAgICAgICAgICB4bWxuczpleGlmPSJodHRwOi8vbnMuYWRvYmUuY29tL2V4aWYvMS4wLyI+CiAgICAgICAgIDx4bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ+eG1wLmRpZDo2NDkyYzcxMy05ZDM0LTZlNGQtYmUwNi1hMDMyY2Q4NDVjNGU8L3htcE1NOk9yaWdpbmFsRG9jdW1lbnRJRD4KICAgICAgICAgPHhtcE1NOkRvY3VtZW50SUQ+eG1wLmRpZDo1QjIzMUMxODU3RjcxMUU2ODUzRkRBRjE5RDhDQjZBRDwveG1wTU06RG9jdW1lbnRJRD4KICAgICAgICAgPHhtcE1NOkluc3RhbmNlSUQ+eG1wLmlpZDpjZmMwNzVmNC1kODA3LWI0NDMtYWIwYS02YWVhZjRjMDgxZWE8L3htcE1NOkluc3RhbmNlSUQ+CiAgICAgICAgIDx4bXBNTTpEZXJpdmVkRnJvbSByZGY6cGFyc2VUeXBlPSJSZXNvdXJjZSI+CiAgICAgICAgICAgIDxzdFJlZjppbnN0YW5jZUlEPnhtcC5paWQ6NjQ5MmM3MTMtOWQzNC02ZTRkLWJlMDYtYTAzMmNkODQ1YzRlPC9zdFJlZjppbnN0YW5jZUlEPgogICAgICAgICAgICA8c3RSZWY6ZG9jdW1lbnRJRD54bXAuZGlkOjY0OTJjNzEzLTlkMzQtNmU0ZC1iZTA2LWEwMzJjZDg0NWM0ZTwvc3RSZWY6ZG9jdW1lbnRJRD4KICAgICAgICAgPC94bXBNTTpEZXJpdmVkRnJvbT4KICAgICAgICAgPHhtcE1NOkhpc3Rvcnk+CiAgICAgICAgICAgIDxyZGY6U2VxPgogICAgICAgICAgICAgICA8cmRmOmxpIHJkZjpwYXJzZVR5cGU9IlJlc291cmNlIj4KICAgICAgICAgICAgICAgICAgPHN0RXZ0OmFjdGlvbj5zYXZlZDwvc3RFdnQ6YWN0aW9uPgogICAgICAgICAgICAgICAgICA8c3RFdnQ6aW5zdGFuY2VJRD54bXAuaWlkOmNmYzA3NWY0LWQ4MDctYjQ0My1hYjBhLTZhZWFmNGMwODFlYTwvc3RFdnQ6aW5zdGFuY2VJRD4KICAgICAgICAgICAgICAgICAgPHN0RXZ0OndoZW4+MjAxNi0wOC0wMVQxMTo1ODowNC0wMzowMDwvc3RFdnQ6d2hlbj4KICAgICAgICAgICAgICAgICAgPHN0RXZ0OnNvZnR3YXJlQWdlbnQ+QWRvYmUgUGhvdG9zaG9wIENDIDIwMTUuNSAoV2luZG93cyk8L3N0RXZ0OnNvZnR3YXJlQWdlbnQ+CiAgICAgICAgICAgICAgICAgIDxzdEV2dDpjaGFuZ2VkPi88L3N0RXZ0OmNoYW5nZWQ+CiAgICAgICAgICAgICAgIDwvcmRmOmxpPgogICAgICAgICAgICA8L3JkZjpTZXE+CiAgICAgICAgIDwveG1wTU06SGlzdG9yeT4KICAgICAgICAgPHhtcDpDcmVhdG9yVG9vbD5BZG9iZSBQaG90b3Nob3AgQ0MgMjAxNS41IChXaW5kb3dzKTwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8eG1wOkNyZWF0ZURhdGU+MjAxNi0wOC0wMVQwOTo0MDo1Ni0wMzowMDwveG1wOkNyZWF0ZURhdGU+CiAgICAgICAgIDx4bXA6TW9kaWZ5RGF0ZT4yMDE2LTA4LTAxVDExOjU4OjA0LTAzOjAwPC94bXA6TW9kaWZ5RGF0ZT4KICAgICAgICAgPHhtcDpNZXRhZGF0YURhdGU+MjAxNi0wOC0wMVQxMTo1ODowNC0wMzowMDwveG1wOk1ldGFkYXRhRGF0ZT4KICAgICAgICAgPGRjOmZvcm1hdD5pbWFnZS9wbmc8L2RjOmZvcm1hdD4KICAgICAgICAgPHBob3Rvc2hvcDpDb2xvck1vZGU+MzwvcGhvdG9zaG9wOkNvbG9yTW9kZT4KICAgICAgICAgPHRpZmY6T3JpZW50YXRpb24+MTwvdGlmZjpPcmllbnRhdGlvbj4KICAgICAgICAgPHRpZmY6WFJlc29sdXRpb24+NzIwMDAwLzEwMDAwPC90aWZmOlhSZXNvbHV0aW9uPgogICAgICAgICA8dGlmZjpZUmVzb2x1dGlvbj43MjAwMDAvMTAwMDA8L3RpZmY6WVJlc29sdXRpb24+CiAgICAgICAgIDx0aWZmOlJlc29sdXRpb25Vbml0PjI8L3RpZmY6UmVzb2x1dGlvblVuaXQ+CiAgICAgICAgIDxleGlmOkNvbG9yU3BhY2U+NjU1MzU8L2V4aWY6Q29sb3JTcGFjZT4KICAgICAgICAgPGV4aWY6UGl4ZWxYRGltZW5zaW9uPjE4ODwvZXhpZjpQaXhlbFhEaW1lbnNpb24+CiAgICAgICAgIDxleGlmOlBpeGVsWURpbWVuc2lvbj4xODg8L2V4aWY6UGl4ZWxZRGltZW5zaW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAKPD94cGFja2V0IGVuZD0idyI/PvAvv7QAAAAgY0hSTQAAeiUAAICDAAD5/wAAgOkAAHUwAADqYAAAOpgAABdvkl/FRgAAAmdJREFUeNrs1LsJQkEQhtH/mtmBgQ8QA7tQK1e7MBBBMbADwzUZEyuQveeDCXbD4TBDay3SWJpYgYCXgJeAl4CXgJeAl4CXgJeAl4CXgJeAF/AS8BLwEvAS8BLwEvAS8BLwEvAS8BLwAl4CXgJeAl4CXv/WJskpyQJ4jQH7Mcmu0C+BV+/Y5/VeF/oV8Ood+7dpDfDqHvsrySHJBXjBDrxgB16wAy/YgRfswAt24AU78IIdeMEOPOywAw+7gIcdeMEOvGAHXrADL9iBF+zAC3bgBTvwsMMOPOwCHnYBD7uAhx14wQ68YAdesAMv2IEX7MDDDjvwsAt42AU87AIedgEPu4CHXcDDDrxgB16wAw877MDDDjvwsAt42AU87AIedgEPu4CHXcDDLuBhB16wAw877MDDLuBhF/CwC3jYBTzsAh52AQ+7gIddwEtjB3+tS/78+Z/V5d9iATz0Ah56AQ+9gIdewEMv4KEX8NALeOgFPPQCHnoBDz3wgh54QQ889NADDz30wEMv4KEX8NALeOgFPPQCHnoBD72Ahx54QQ+8oAde0AMv6IEX9MBDDz3w0EMPPPQCHnoBD72Ah17AQw+8FUAPvKAHXtADL+iBF/TAC3rgBT3wgh546KEHHnrogYdewEMv4KEHXtADL+iBF/TAC3rgBT3wgh54QQ+8oAde0AMv6IGHHnrgoU/yrgFe3aO/JdknuQOv3tGfC/tjjEsYWmsoyIWXgJeAl4CXgJeAl4CXgJeAl4CXgJeAF/AS8BLwEvAS8BLwEvAS8BLwEvAS8BLwAl4CXgJeAl4CXvqnPgAAAP//AwCEcoCBRabYzAAAAABJRU5ErkJggg==') no-repeat 50% 50%;
}
.iziModal-navigate-next{
right: 50%;
background: url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAALwAAAC8CAYAAADCScSrAAAACXBIWXMAAB3SAAAd0gEUasEwAAA7pGlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4KPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iQWRvYmUgWE1QIENvcmUgNS42LWMxMzIgNzkuMTU5Mjg0LCAyMDE2LzA0LzE5LTEzOjEzOjQwICAgICAgICAiPgogICA8cmRmOlJERiB4bWxuczpyZGY9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMiPgogICAgICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgICAgICAgICB4bWxuczp4bXA9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC8iCiAgICAgICAgICAgIHhtbG5zOmRjPSJodHRwOi8vcHVybC5vcmcvZGMvZWxlbWVudHMvMS4xLyIKICAgICAgICAgICAgeG1sbnM6cGhvdG9zaG9wPSJodHRwOi8vbnMuYWRvYmUuY29tL3Bob3Rvc2hvcC8xLjAvIgogICAgICAgICAgICB4bWxuczp4bXBNTT0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIKICAgICAgICAgICAgeG1sbnM6c3RFdnQ9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZUV2ZW50IyIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iCiAgICAgICAgICAgIHhtbG5zOmV4aWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20vZXhpZi8xLjAvIj4KICAgICAgICAgPHhtcDpDcmVhdG9yVG9vbD5BZG9iZSBQaG90b3Nob3AgQ0MgMjAxNS41IChXaW5kb3dzKTwveG1wOkNyZWF0b3JUb29sPgogICAgICAgICA8eG1wOkNyZWF0ZURhdGU+MjAxNi0wOC0wMVQwOTo0MDoxNC0wMzowMDwveG1wOkNyZWF0ZURhdGU+CiAgICAgICAgIDx4bXA6TW9kaWZ5RGF0ZT4yMDE2LTA4LTAxVDExOjU4OjEyLTAzOjAwPC94bXA6TW9kaWZ5RGF0ZT4KICAgICAgICAgPHhtcDpNZXRhZGF0YURhdGU+MjAxNi0wOC0wMVQxMTo1ODoxMi0wMzowMDwveG1wOk1ldGFkYXRhRGF0ZT4KICAgICAgICAgPGRjOmZvcm1hdD5pbWFnZS9wbmc8L2RjOmZvcm1hdD4KICAgICAgICAgPHBob3Rvc2hvcDpDb2xvck1vZGU+MzwvcGhvdG9zaG9wOkNvbG9yTW9kZT4KICAgICAgICAgPHhtcE1NOkluc3RhbmNlSUQ+eG1wLmlpZDphZjljN2Q2MC00MTg2LWE3NGQtYTBiMS1mMGU5ODUwYzg2ZGY8L3htcE1NOkluc3RhbmNlSUQ+CiAgICAgICAgIDx4bXBNTTpEb2N1bWVudElEPnhtcC5kaWQ6NjQ5MmM3MTMtOWQzNC02ZTRkLWJlMDYtYTAzMmNkODQ1YzRlPC94bXBNTTpEb2N1bWVudElEPgogICAgICAgICA8eG1wTU06T3JpZ2luYWxEb2N1bWVudElEPnhtcC5kaWQ6NjQ5MmM3MTMtOWQzNC02ZTRkLWJlMDYtYTAzMmNkODQ1YzRlPC94bXBNTTpPcmlnaW5hbERvY3VtZW50SUQ+CiAgICAgICAgIDx4bXBNTTpIaXN0b3J5PgogICAgICAgICAgICA8cmRmOlNlcT4KICAgICAgICAgICAgICAgPHJkZjpsaSByZGY6cGFyc2VUeXBlPSJSZXNvdXJjZSI+CiAgICAgICAgICAgICAgICAgIDxzdEV2dDphY3Rpb24+Y3JlYXRlZDwvc3RFdnQ6YWN0aW9uPgogICAgICAgICAgICAgICAgICA8c3RFdnQ6aW5zdGFuY2VJRD54bXAuaWlkOjY0OTJjNzEzLTlkMzQtNmU0ZC1iZTA2LWEwMzJjZDg0NWM0ZTwvc3RFdnQ6aW5zdGFuY2VJRD4KICAgICAgICAgICAgICAgICAgPHN0RXZ0OndoZW4+MjAxNi0wOC0wMVQwOTo0MDoxNC0wMzowMDwvc3RFdnQ6d2hlbj4KICAgICAgICAgICAgICAgICAgPHN0RXZ0OnNvZnR3YXJlQWdlbnQ+QWRvYmUgUGhvdG9zaG9wIENDIDIwMTUuNSAoV2luZG93cyk8L3N0RXZ0OnNvZnR3YXJlQWdlbnQ+CiAgICAgICAgICAgICAgIDwvcmRmOmxpPgogICAgICAgICAgICAgICA8cmRmOmxpIHJkZjpwYXJzZVR5cGU9IlJlc291cmNlIj4KICAgICAgICAgICAgICAgICAgPHN0RXZ0OmFjdGlvbj5zYXZlZDwvc3RFdnQ6YWN0aW9uPgogICAgICAgICAgICAgICAgICA8c3RFdnQ6aW5zdGFuY2VJRD54bXAuaWlkOjAxNjJjMmE3LWZmMjYtYzE0ZC05Yjg4LTc2MGM2NzAxYjYzNzwvc3RFdnQ6aW5zdGFuY2VJRD4KICAgICAgICAgICAgICAgICAgPHN0RXZ0OndoZW4+MjAxNi0wOC0wMVQxMTo1MTowNy0wMzowMDwvc3RFdnQ6d2hlbj4KICAgICAgICAgICAgICAgICAgPHN0RXZ0OnNvZnR3YXJlQWdlbnQ+QWRvYmUgUGhvdG9zaG9wIENDIDIwMTUuNSAoV2luZG93cyk8L3N0RXZ0OnNvZnR3YXJlQWdlbnQ+CiAgICAgICAgICAgICAgICAgIDxzdEV2dDpjaGFuZ2VkPi88L3N0RXZ0OmNoYW5nZWQ+CiAgICAgICAgICAgICAgIDwvcmRmOmxpPgogICAgICAgICAgICAgICA8cmRmOmxpIHJkZjpwYXJzZVR5cGU9IlJlc291cmNlIj4KICAgICAgICAgICAgICAgICAgPHN0RXZ0OmFjdGlvbj5zYXZlZDwvc3RFdnQ6YWN0aW9uPgogICAgICAgICAgICAgICAgICA8c3RFdnQ6aW5zdGFuY2VJRD54bXAuaWlkOmFmOWM3ZDYwLTQxODYtYTc0ZC1hMGIxLWYwZTk4NTBjODZkZjwvc3RFdnQ6aW5zdGFuY2VJRD4KICAgICAgICAgICAgICAgICAgPHN0RXZ0OndoZW4+MjAxNi0wOC0wMVQxMTo1ODoxMi0wMzowMDwvc3RFdnQ6d2hlbj4KICAgICAgICAgICAgICAgICAgPHN0RXZ0OnNvZnR3YXJlQWdlbnQ+QWRvYmUgUGhvdG9zaG9wIENDIDIwMTUuNSAoV2luZG93cyk8L3N0RXZ0OnNvZnR3YXJlQWdlbnQ+CiAgICAgICAgICAgICAgICAgIDxzdEV2dDpjaGFuZ2VkPi88L3N0RXZ0OmNoYW5nZWQ+CiAgICAgICAgICAgICAgIDwvcmRmOmxpPgogICAgICAgICAgICA8L3JkZjpTZXE+CiAgICAgICAgIDwveG1wTU06SGlzdG9yeT4KICAgICAgICAgPHRpZmY6T3JpZW50YXRpb24+MTwvdGlmZjpPcmllbnRhdGlvbj4KICAgICAgICAgPHRpZmY6WFJlc29sdXRpb24+MTkzOTAzNi8xMDAwMDwvdGlmZjpYUmVzb2x1dGlvbj4KICAgICAgICAgPHRpZmY6WVJlc29sdXRpb24+MTkzOTAzNi8xMDAwMDwvdGlmZjpZUmVzb2x1dGlvbj4KICAgICAgICAgPHRpZmY6UmVzb2x1dGlvblVuaXQ+MjwvdGlmZjpSZXNvbHV0aW9uVW5pdD4KICAgICAgICAgPGV4aWY6Q29sb3JTcGFjZT42NTUzNTwvZXhpZjpDb2xvclNwYWNlPgogICAgICAgICA8ZXhpZjpQaXhlbFhEaW1lbnNpb24+MTg4PC9leGlmOlBpeGVsWERpbWVuc2lvbj4KICAgICAgICAgPGV4aWY6UGl4ZWxZRGltZW5zaW9uPjE4ODwvZXhpZjpQaXhlbFlEaW1lbnNpb24+CiAgICAgIDwvcmRmOkRlc2NyaXB0aW9uPgogICA8L3JkZjpSREY+CjwveDp4bXBtZXRhPgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgIAo8P3hwYWNrZXQgZW5kPSJ3Ij8+nbt1mgAAACBjSFJNAAB6JQAAgIMAAPn/AACA6QAAdTAAAOpgAAA6mAAAF2+SX8VGAAACQklEQVR42uzSsQ3CQAAEQTdiOyGg/wrciJ0QUMYSECEKAP3PSdvAaZZqkWbJCQJeAl4CXgJeAl4CXgJeAl4CXgJeAl4CXsBLwEvAS8BLwEvAS8BLwEvAS8BLwEvAC3gJeAl4CXgJ+D9vrY7qBgLwo7dVZ+89oAd+5Pbq6nPQAz9s9+rZ96AHHnoBD72Ah17AQy/goRfw0At46AU89AIeegEPvYCHHnhBD7ygBx566IGHHnrgoRfw0At46AU89AIeegEPvYCHXsBDL+ChB17QAy/ogRf0wAt64KGHHnjooQceegEPvYCHXsBDL+ChF/DQAy/ogRf0wAt64AU98IIeeEEPvKAHXtADDz30wEPvI+ChF/DQAy/ogRf0wAt64AU98IIeeEEPvKAHXtADL+iBF/TAC3rgoZ8ePRDAAy/YgRfswAt24AU78IIdeMEOvGAHXrADL9iBhx124GEX8LADL9iBF+zAC3bgBTvwgh14wQ68YAcedtiBh13Awy7gYRfwsAMv2IEX7MALduAFO/CCHXjYYQcedgEPu4CHXcDDLuBhF/CwA+8E2IEX7MALduAFO/Cwww487AIedgEPu4CHXcDDLuBhF/CwC3jYgRfswMMOO/CwC3jYBTzsAh52AQ+7gIddwMMu4GEX8LBravB7dcEO/Ext1Qk78DO1VgfswEvAS8BLwEvAS8BLwEvAS8BLwEvAS8ALeAl4CXgJeAl4CXgJeAl4CXgJeAl4CXgBLwEvAS8BLwEvAS/9shcAAAD//wMAtAygvJrkwJUAAAAASUVORK5CYII=') no-repeat 50% 50%;
}
.iziModal.isAttachedTop .iziModal-header{
border-top-left-radius: 0;
border-top-right-radius: 0;
}
.iziModal.isAttachedTop{
margin-top: 0 !important;
margin-bottom: auto !important;
border-top-left-radius: 0 !important;
border-top-right-radius: 0 !important;
}
.iziModal.isAttachedBottom{
margin-top: auto !important;
margin-bottom: 0 !important;
border-bottom-left-radius: 0 !important;
border-bottom-right-radius: 0 !important;
}
.iziModal.isFullscreen{
max-width: 100% !important;
margin: 0 !important;
height: 100% !important;
border-radius: 0 !important;
}
.iziModal.isAttached{
border-radius: 0 !important;
}
.iziModal.hasScroll .iziModal-wrap{
overflow-y: auto;
overflow-x: hidden;
}
html.iziModal-isOverflow{
overflow: hidden;
}
html.iziModal-isOverflow body, html.iziModal-isAttached body{
overflow-y: scroll;
position: relative;
}
html.iziModal-isAttached{
overflow: hidden;
}
/* SCROLL */
.iziModal ::-webkit-scrollbar {
overflow: visible;
height: 7px;
width: 7px;
}
.iziModal ::-webkit-scrollbar-thumb {
background-color: rgba(0,0,0,.2);
background-clip: padding-box;
border: solid transparent;
border-width: 0px;
min-height: 28px;
padding: 100px 0 0;
box-shadow: inset 1px 1px 0 rgba(0,0,0,.1),inset 0 -1px 0 rgba(0,0,0,.07);
}
.iziModal ::-webkit-scrollbar-thumb:active {
background-color: rgba(0,0,0,.4);
}
.iziModal ::-webkit-scrollbar-button {
height: 0;
width: 0;
}
.iziModal ::-webkit-scrollbar-track {
background-clip: padding-box;
border: solid transparent;
border-width: 0 0 0 2px;
}
/* MODAL ANIMATIONS */
.iziModal.transitionIn .iziModal-header{
-webkit-animation: iziM-slideDown 0.7s cubic-bezier(0.7,0,0.3,1);
-moz-animation: iziM-slideDown 0.7s cubic-bezier(0.7,0,0.3,1);
animation: iziM-slideDown 0.7s cubic-bezier(0.7,0,0.3,1);
}
.iziModal.transitionIn .iziModal-header .iziModal-header-icon {
-webkit-animation: iziM-revealIn 1s cubic-bezier(.16,.81,.32,1) both;
-moz-animation: iziM-revealIn 1s cubic-bezier(.16,.81,.32,1) both;
animation: iziM-revealIn 1s cubic-bezier(.16,.81,.32,1) both;
}
.iziModal.transitionIn .iziModal-header .iziModal-header-title, .iziModal.transitionIn .iziModal-header .iziModal-header-subtitle {
-webkit-animation: iziM-slideIn 1s cubic-bezier(.16,.81,.32,1) both;
-moz-animation: iziM-slideIn 1s cubic-bezier(.16,.81,.32,1) both;
animation: iziM-slideIn 1s cubic-bezier(.16,.81,.32,1) both;
}
.iziModal.transitionIn .iziModal-header .iziModal-button{
-webkit-animation: iziM-revealIn 1.2s cubic-bezier(0.7,0,0.3,1);
-moz-animation: iziM-revealIn 1.2s cubic-bezier(0.7,0,0.3,1);
animation: iziM-revealIn 1.2s cubic-bezier(0.7,0,0.3,1);
}
.iziModal.transitionIn .iziModal-iframe, .iziModal.transitionIn .iziModal-wrap{
-webkit-animation: iziM-fadeIn 1.3s;
-moz-animation: iziM-fadeIn 1.3s;
animation: iziM-fadeIn 1.3s;
}
.iziModal.transitionIn .iziModal-header {
-webkit-animation-delay: 0.0s;
-moz-animation: 0.0s;
animation-delay: 0.0s;
}
.iziModal.transitionIn .iziModal-header .iziModal-header-icon,
.iziModal.transitionIn .iziModal-header .iziModal-header-title {
-webkit-animation-delay: 0.4s;
-moz-animation: 0.4s;
animation-delay: 0.4s;
}
.iziModal.transitionIn .iziModal-header .iziModal-header-subtitle {
-webkit-animation-delay: 0.5s;
-moz-animation: 0.5s;
animation-delay: 0.5s;
}
.iziModal.transitionOut .iziModal-header, .iziModal.transitionOut .iziModal-header *{
transition: none !important;
}
/* ANIMATIONS */
.iziModal.fadeOut, .iziModal-overlay.fadeOut, .iziModal-navigate.fadeOut, .iziModal .fadeOut{
-webkit-animation: iziM-fadeOut 0.5s;
-moz-animation: iziM-fadeOut 0.5s;
animation: iziM-fadeOut 0.5s;
animation-fill-mode: forwards;
}
.iziModal.fadeIn, .iziModal-overlay.fadeIn, .iziModal-navigate.fadeIn, .iziModal .fadeIn {
-webkit-animation: iziM-fadeIn 0.5s;
-moz-animation: iziM-fadeIn 0.5s;
animation: iziM-fadeIn 0.5s;
}
.iziModal.comingIn, .iziModal-overlay.comingIn {
-webkit-animation: iziM-comingIn 0.5s ease;
-moz-animation: iziM-comingIn 0.5s ease;
animation: iziM-comingIn 0.5s ease;
}
.iziModal.comingOut, .iziModal-overlay.comingOut {
-webkit-animation: iziM-comingOut 0.5s cubic-bezier(.16,.81,.32,1);
-moz-animation: iziM-comingOut 0.5s cubic-bezier(.16,.81,.32,1);
animation: iziM-comingOut 0.5s cubic-bezier(.16,.81,.32,1);
animation-fill-mode: forwards;
}
.iziModal.bounceInDown, .iziModal-overlay.bounceInDown {
-webkit-animation: iziM-bounceInDown 0.7s ease;
animation: iziM-bounceInDown 0.7s ease;
}
.iziModal.bounceOutDown, .iziModal-overlay.bounceOutDown {
-webkit-animation: iziM-bounceOutDown 0.7s ease;
animation: iziM-bounceOutDown 0.7s ease;
}
.iziModal.bounceInUp, .iziModal-overlay.bounceInUp {
-webkit-animation: iziM-bounceInUp 0.7s ease;
animation: iziM-bounceInUp 0.7s ease;
}
.iziModal.bounceOutUp, .iziModal-overlay.bounceOutUp {
-webkit-animation: iziM-bounceOutUp 0.7s ease;
animation: iziM-bounceOutUp 0.7s ease;
}
.iziModal.fadeInDown, .iziModal-overlay.fadeInDown {
-webkit-animation: iziM-fadeInDown 0.7s cubic-bezier(.16,.81,.32,1);
animation: iziM-fadeInDown 0.7s cubic-bezier(.16,.81,.32,1);
}
.iziModal.fadeOutDown, .iziModal-overlay.fadeOutDown {
-webkit-animation: iziM-fadeOutDown 0.5s ease;
animation: iziM-fadeOutDown 0.5s ease;
}
.iziModal.fadeInUp, .iziModal-overlay.fadeInUp {
-webkit-animation: iziM-fadeInUp 0.7s cubic-bezier(.16,.81,.32,1);
animation: iziM-fadeInUp 0.7s cubic-bezier(.16,.81,.32,1);
}
.iziModal.fadeOutUp, .iziModal-overlay.fadeOutUp {
-webkit-animation: iziM-fadeOutUp 0.5s ease;
animation: iziM-fadeOutUp 0.5s ease;
}
.iziModal.fadeInLeft, .iziModal-overlay.fadeInLeft {
-webkit-animation: iziM-fadeInLeft 0.7s cubic-bezier(.16,.81,.32,1);
animation: iziM-fadeInLeft 0.7s cubic-bezier(.16,.81,.32,1);
}
.iziModal.fadeOutLeft, .iziModal-overlay.fadeOutLeft {
-webkit-animation: iziM-fadeOutLeft 0.5s ease;
animation: iziM-fadeOutLeft 0.5s ease;
}
.iziModal.fadeInRight, .iziModal-overlay.fadeInRight {
-webkit-animation: iziM-fadeInRight 0.7s cubic-bezier(.16,.81,.32,1);
animation: iziM-fadeInRight 0.7s cubic-bezier(.16,.81,.32,1);
}
.iziModal.fadeOutRight, .iziModal-overlay.fadeOutRight {
-webkit-animation: iziM-fadeOutRight 0.5s ease;
animation: iziM-fadeOutRight 0.5s ease;
}
.iziModal.flipInX, .iziModal-overlay.flipInX {
-webkit-animation: iziM-flipInX 0.7s ease;
animation: iziM-flipInX 0.7s ease;
}
.iziModal.flipOutX, .iziModal-overlay.flipOutX {
-webkit-animation: iziM-flipOutX 0.7s ease;
animation: iziM-flipOutX 0.7s ease;
}
@-webkit-keyframes iziM-comingIn {
0% {
opacity: 0;
transform: scale(0.9) translateY(-20px) perspective( 600px ) rotateX( 10deg );
}
100% {
opacity: 1;
transform: scale(1) translateY(0) perspective( 600px ) rotateX( 0 );
}
}
@-moz-keyframes iziM-comingIn {
0% {
opacity: 0;
transform: scale(0.9) translateY(-20px) perspective( 600px ) rotateX( 10deg );
}
100% {
opacity: 1;
transform: scale(1) translateY(0) perspective( 600px ) rotateX( 0 );
}
}
@keyframes iziM-comingIn {
0% {
opacity: 0;
/*transform: translateY(-20px) perspective( 600px ) rotateX( 10deg );*/
transform: scale(0.9) translateY(-20px) perspective( 600px ) rotateX( 10deg );
}
100% {
opacity: 1;
/*transform: scale(1) translateY(0) perspective( 600px ) rotateX( 0 ); */
transform: scale(1) translateY(0) perspective( 600px ) rotateX( 0 );
}
}
@-webkit-keyframes iziM-comingOut {
0% {
opacity: 1;
transform: scale(1);
}
100% {
opacity: 0;
transform: scale(0.9);
}
}
@-moz-keyframes iziM-comingOut {
0% {
opacity: 1;
transform: scale(1);
}
100% {
opacity: 0;
transform: scale(0.9);
}
}
@keyframes iziM-comingOut {
0% {
opacity: 1;
transform: scale(1);
}
100% {
opacity: 0;
transform: scale(0.9);
}
}
@-webkit-keyframes iziM-fadeOut {
0% {opacity: 1;}
100% {opacity: 0;}
}
@-moz-keyframes iziM-fadeOut {
0% {opacity: 1;}
100% {opacity: 0;}
}
@keyframes iziM-fadeOut {
0% {opacity: 1;}
100% {opacity: 0;}
}
@-webkit-keyframes iziM-fadeIn {
0% {opacity: 0;}
100% {opacity: 1;}
}
@-moz-keyframes iziM-fadeIn {
0% {opacity: 0;}
100% {opacity: 1;}
}
@keyframes iziM-fadeIn {
0% {opacity: 0;}
100% {opacity: 1;}
}
@-webkit-keyframes iziM-slideIn {
0% {
opacity: 0;
-webkit-transform: translateX(50px);
}
100% {
opacity: 1;
-webkit-transform: translateX(0);
}
}
@-moz-keyframes iziM-slideIn {
0% {
opacity: 0;
-moz-transform: translateX(50px);
}
100% {
opacity: 1;
-moz-transform: translateX(0);
}
}
@keyframes iziM-slideIn {
0% {
opacity: 0;
transform: translateX(50px);
}
100% {
opacity: 1;
transform: translateX(0);
}
}
@-webkit-keyframes iziM-slideDown {
0% { opacity: 0; -webkit-transform: scale(1,0) translateY(-40px); -webkit-transform-origin: center top; }
}
@-moz-keyframes iziM-slideDown {
0% { opacity: 0; -moz-transform: scale(1,0) translateY(-40px); -moz-transform-origin: center top; }
}
@keyframes iziM-slideDown {
0% { opacity: 0; transform: scale(1,0) translateY(-40px); transform-origin: center top; }
}
@-webkit-keyframes iziM-revealIn {
0% { opacity: 0; -webkit-transform: scale3d(0.3,0.3,1); }
}
@-moz-keyframes iziM-revealIn {
0% { opacity: 0; -moz-transform: scale3d(0.3,0.3,1); }
}
@keyframes iziM-revealIn {
0% { opacity: 0; transform: scale3d(0.3,0.3,1); }
}
@-webkit-keyframes iziM-bounceInDown {
from, 60%, 75%, 90%, to {
-webkit-animation-timing-function: cubic-bezier(0.215, 0.610, 0.355, 1.000);
animation-timing-function: cubic-bezier(0.215, 0.610, 0.355, 1.000);
}
0% {
opacity: 0;
-webkit-transform: translate3d(0, -1000px, 0);
transform: translate3d(0, -1000px, 0);
}
60% {
opacity: 1;
-webkit-transform: translate3d(0, 25px, 0);
transform: translate3d(0, 25px, 0);
}
75% {
-webkit-transform: translate3d(0, -10px, 0);
transform: translate3d(0, -10px, 0);
}
90% {
-webkit-transform: translate3d(0, 5px, 0);
transform: translate3d(0, 5px, 0);
}
to {
-webkit-transform: none;
transform: none;
}
}
@keyframes iziM-bounceInDown {
from, 60%, 75%, 90%, to {
-webkit-animation-timing-function: cubic-bezier(0.215, 0.610, 0.355, 1.000);
animation-timing-function: cubic-bezier(0.215, 0.610, 0.355, 1.000);
}
0% {
opacity: 0;
-webkit-transform: translate3d(0, -1000px, 0);
transform: translate3d(0, -1000px, 0);
}
60% {
opacity: 1;
-webkit-transform: translate3d(0, 25px, 0);
transform: translate3d(0, 25px, 0);
}
75% {
-webkit-transform: translate3d(0, -10px, 0);
transform: translate3d(0, -10px, 0);
}
90% {
-webkit-transform: translate3d(0, 5px, 0);
transform: translate3d(0, 5px, 0);
}
to {
-webkit-transform: none;
transform: none;
}
}
@-webkit-keyframes iziM-bounceOutDown {
20% {
-webkit-transform: translate3d(0, 10px, 0);
transform: translate3d(0, 10px, 0);
}
40%, 45% {
opacity: 1;
-webkit-transform: translate3d(0, -20px, 0);
transform: translate3d(0, -20px, 0);
}
to {
opacity: 0;
-webkit-transform: translate3d(0, 1000px, 0);
transform: translate3d(0, 1000px, 0);
}
}
@keyframes iziM-bounceOutDown {
20% {
-webkit-transform: translate3d(0, 10px, 0);
transform: translate3d(0, 10px, 0);
}
40%, 45% {
opacity: 1;
-webkit-transform: translate3d(0, -20px, 0);
transform: translate3d(0, -20px, 0);
}
to {
opacity: 0;
-webkit-transform: translate3d(0, 1000px, 0);
transform: translate3d(0, 1000px, 0);
}
}
@-webkit-keyframes iziM-bounceInUp {
from, 60%, 75%, 90%, to {
-webkit-animation-timing-function: cubic-bezier(0.215, 0.610, 0.355, 1.000);
animation-timing-function: cubic-bezier(0.215, 0.610, 0.355, 1.000);
}
from {
opacity: 0;
-webkit-transform: translate3d(0, 1000px, 0);
transform: translate3d(0, 1000px, 0);
}
60% {
opacity: 1;
-webkit-transform: translate3d(0, -20px, 0);
transform: translate3d(0, -20px, 0);
}
75% {
-webkit-transform: translate3d(0, 10px, 0);
transform: translate3d(0, 10px, 0);
}
90% {
-webkit-transform: translate3d(0, -5px, 0);
transform: translate3d(0, -5px, 0);
}
to {
-webkit-transform: translate3d(0, 0, 0);
transform: translate3d(0, 0, 0);
}
}
@keyframes iziM-bounceInUp {
from, 60%, 75%, 90%, to {
-webkit-animation-timing-function: cubic-bezier(0.215, 0.610, 0.355, 1.000);
animation-timing-function: cubic-bezier(0.215, 0.610, 0.355, 1.000);
}
from {
opacity: 0;
-webkit-transform: translate3d(0, 1000px, 0);
transform: translate3d(0, 1000px, 0);
}
60% {
opacity: 1;
-webkit-transform: translate3d(0, -20px, 0);
transform: translate3d(0, -20px, 0);
}
75% {
-webkit-transform: translate3d(0, 10px, 0);
transform: translate3d(0, 10px, 0);
}
90% {
-webkit-transform: translate3d(0, -5px, 0);
transform: translate3d(0, -5px, 0);
}
to {
-webkit-transform: translate3d(0, 0, 0);
transform: translate3d(0, 0, 0);
}
}
@-webkit-keyframes iziM-bounceOutUp {
20% {
-webkit-transform: translate3d(0, -10px, 0);
transform: translate3d(0, -10px, 0);
}
40%, 45% {
opacity: 1;
-webkit-transform: translate3d(0, 20px, 0);
transform: translate3d(0, 20px, 0);
}
to {
opacity: 0;
-webkit-transform: translate3d(0, -2000px, 0);
transform: translate3d(0, -2000px, 0);
}
}
@keyframes iziM-bounceOutUp {
20% {
-webkit-transform: translate3d(0, -10px, 0);
transform: translate3d(0, -10px, 0);
}
40%, 45% {
opacity: 1;
-webkit-transform: translate3d(0, 20px, 0);
transform: translate3d(0, 20px, 0);
}
to {
opacity: 0;
-webkit-transform: translate3d(0, -1000px, 0);
transform: translate3d(0, -1000px, 0);
}
}
@-webkit-keyframes iziM-fadeInDown {
from {
opacity: 0;
-webkit-transform: translate3d(0, -100px, 0);
transform: translate3d(0, -100px, 0);
}
to {
opacity: 1;
-webkit-transform: none;
transform: none;
}
}
@keyframes iziM-fadeInDown {
from {
opacity: 0;
-webkit-transform: translate3d(0, -100px, 0);
transform: translate3d(0, -100px, 0);
}
to {
opacity: 1;
-webkit-transform: none;
transform: none;
}
}
@-webkit-keyframes iziM-fadeOutDown {
from {
opacity: 1;
}
to {
opacity: 0;
-webkit-transform: translate3d(0, 100px, 0);
transform: translate3d(0, 100px, 0);
}
}
@keyframes iziM-fadeOutDown {
from {
opacity: 1;
}
to {
opacity: 0;
-webkit-transform: translate3d(0, 100px, 0);
transform: translate3d(0, 100px, 0);
}
}
@-webkit-keyframes iziM-fadeInUp {
from {
opacity: 0;
-webkit-transform: translate3d(0, 100px, 0);
transform: translate3d(0, 100px, 0);
}
to {
opacity: 1;
-webkit-transform: none;
transform: none;
}
}
@keyframes iziM-fadeInUp {
from {
opacity: 0;
-webkit-transform: translate3d(0, 100px, 0);
transform: translate3d(0, 100px, 0);
}
to {
opacity: 1;
-webkit-transform: none;
transform: none;
}
}
@-webkit-keyframes iziM-fadeOutUp {
from {
opacity: 1;
}
to {
opacity: 0;
-webkit-transform: translate3d(0, -100px, 0);
transform: translate3d(0, -100px, 0);
}
}
@keyframes iziM-fadeOutUp {
from {
opacity: 1;
}
to {
opacity: 0;
-webkit-transform: translate3d(0, -100px, 0);
transform: translate3d(0, -100px, 0);
}
}
@-webkit-keyframes iziM-fadeInLeft {
from {
opacity: 0;
-webkit-transform: translate3d(-200px, 0, 0);
transform: translate3d(-200px, 0, 0);
}
to {
opacity: 1;
-webkit-transform: none;
transform: none;
}
}
@keyframes iziM-fadeInLeft {
from {
opacity: 0;
-webkit-transform: translate3d(-200px, 0, 0);
transform: translate3d(-200px, 0, 0);
}
to {
opacity: 1;
-webkit-transform: none;
transform: none;
}
}
@-webkit-keyframes iziM-fadeOutLeft {
from {
opacity: 1;
}
to {
opacity: 0;
-webkit-transform: translate3d(-200px, 0, 0);
transform: translate3d(-200px, 0, 0);
}
}
@keyframes iziM-fadeOutLeft {
from {
opacity: 1;
}
to {
opacity: 0;
-webkit-transform: translate3d(-200px, 0, 0);
transform: translate3d(-200px, 0, 0);
}
}
@-webkit-keyframes iziM-fadeInRight {
from {
opacity: 0;
-webkit-transform: translate3d(200px, 0, 0);
transform: translate3d(200px, 0, 0);
}
to {
opacity: 1;
-webkit-transform: none;
transform: none;
}
}
@keyframes iziM-fadeInRight {
from {
opacity: 0;
-webkit-transform: translate3d(200px, 0, 0);
transform: translate3d(200px, 0, 0);
}
to {
opacity: 1;
-webkit-transform: none;
transform: none;
}
}
@-webkit-keyframes iziM-fadeOutRight {
from {
opacity: 1;
}
to {
opacity: 0;
-webkit-transform: translate3d(200px, 0, 0);
transform: translate3d(200px, 0, 0);
}
}
@keyframes iziM-fadeOutRight {
from {
opacity: 1;
}
to {
opacity: 0;
-webkit-transform: translate3d(200px, 0, 0);
transform: translate3d(200px, 0, 0);
}
}
@-webkit-keyframes iziM-flipInX {
0% {
-webkit-transform: perspective(400px) rotateX(60deg);
opacity: 0;
}
40% {
-webkit-transform: perspective(400px) rotateX(-10deg);
}
70% {
-webkit-transform: perspective(400px) rotateX(10deg);
}
100% {
-webkit-transform: perspective(400px) rotateX(0deg);
opacity: 1;
}
}
@keyframes iziM-flipInX {
0% {
transform: perspective(400px) rotateX(60deg);
opacity: 0;
}
40% {
transform: perspective(400px) rotateX(-10deg);
}
70% {
transform: perspective(400px) rotateX(10deg);
}
100% {
transform: perspective(400px) rotateX(0deg);
opacity: 1;
}
}
@-webkit-keyframes iziM-flipOutX {
from {
-webkit-transform: perspective(400px);
transform: perspective(400px);
}
30% {
-webkit-transform: perspective(400px) rotate3d(1, 0, 0, -20deg);
transform: perspective(400px) rotate3d(1, 0, 0, -20deg);
opacity: 1;
}
to {
-webkit-transform: perspective(400px) rotate3d(1, 0, 0, 40deg);
transform: perspective(400px) rotate3d(1, 0, 0, 40deg);
opacity: 0;
}
}
@keyframes iziM-flipOutX {
from {
-webkit-transform: perspective(400px);
transform: perspective(400px);
}
30% {
-webkit-transform: perspective(400px) rotate3d(1, 0, 0, -20deg);
transform: perspective(400px) rotate3d(1, 0, 0, -20deg);
opacity: 1;
}
to {
-webkit-transform: perspective(400px) rotate3d(1, 0, 0, 40deg);
transform: perspective(400px) rotate3d(1, 0, 0, 40deg);
opacity: 0;
}
}
================================================
FILE: assets/vendor/izimodal/iziModal.js
================================================
/*
* iziModal | v1.5.1
* http://izimodal.marcelodolce.com
* by Marcelo Dolce.
*/
(function (factory) {
if (typeof define === 'function' && define.amd) {
define(['jquery'], factory);
} else if (typeof module === 'object' && module.exports) {
module.exports = function( root, jQuery ) {
if ( jQuery === undefined ) {
if ( typeof window !== 'undefined' ) {
jQuery = require('jquery');
}
else {
jQuery = require('jquery')(root);
}
}
factory(jQuery);
return jQuery;
};
} else {
factory(jQuery);
}
}(function ($) {
var $window = $(window),
$document = $(document),
PLUGIN_NAME = 'iziModal',
STATES = {
CLOSING: 'closing',
CLOSED: 'closed',
OPENING: 'opening',
OPENED: 'opened',
DESTROYED: 'destroyed'
};
function whichAnimationEvent(){
var t,
el = document.createElement("fakeelement"),
animations = {
"animation" : "animationend",
"OAnimation" : "oAnimationEnd",
"MozAnimation" : "animationend",
"WebkitAnimation": "webkitAnimationEnd"
};
for (t in animations){
if (el.style[t] !== undefined){
return animations[t];
}
}
}
function isIE(version) {
if(version === 9){
return navigator.appVersion.indexOf("MSIE 9.") !== -1;
} else {
userAgent = navigator.userAgent;
return userAgent.indexOf("MSIE ") > -1 || userAgent.indexOf("Trident/") > -1;
}
}
function clearValue(value){
var separators = /%|px|em|cm|vh|vw/;
return parseInt(String(value).split(separators)[0]);
}
var animationEvent = whichAnimationEvent(),
isMobile = (/Mobi/.test(navigator.userAgent)) ? true : false;
window.$iziModal = {};
window.$iziModal.autoOpen = 0;
window.$iziModal.history = false;
var iziModal = function (element, options) {
this.init(element, options);
};
iziModal.prototype = {
constructor: iziModal,
init: function (element, options) {
var that = this;
this.$element = $(element);
if(this.$element[0].id !== undefined && this.$element[0].id !== ''){
this.id = this.$element[0].id;
} else {
this.id = PLUGIN_NAME+Math.floor((Math.random() * 10000000) + 1);
this.$element.attr('id', this.id);
}
this.classes = ( this.$element.attr('class') !== undefined ) ? this.$element.attr('class') : '';
this.content = this.$element.html();
this.state = STATES.CLOSED;
this.options = options;
this.width = 0;
this.timer = null;
this.timerTimeout = null;
this.progressBar = null;
this.isPaused = false;
this.isFullscreen = false;
this.headerHeight = 0;
this.modalHeight = 0;
this.$overlay = $('<div class="'+PLUGIN_NAME+'-overlay" style="background-color:'+options.overlayColor+'"></div>');
this.$navigate = $('<div class="'+PLUGIN_NAME+'-navigate"><div class="'+PLUGIN_NAME+'-navigate-caption">Use</div><button class="'+PLUGIN_NAME+'-navigate-prev"></button><button class="'+PLUGIN_NAME+'-navigate-next"></button></div>');
this.group = {
name: this.$element.attr('data-'+PLUGIN_NAME+'-group'),
index: null,
ids: []
};
this.$element.attr('aria-hidden', 'true');
this.$element.attr('aria-labelledby', this.id);
this.$element.attr('role', 'dialog');
if( !this.$element.hasClass('iziModal') ){
this.$element.addClass('iziModal');
}
if(this.group.name === undefined && options.group !== ""){
this.group.name = options.group;
this.$element.attr('data-'+PLUGIN_NAME+'-group', options.group);
}
if(this.options.loop === true){
this.$element.attr('data-'+PLUGIN_NAME+'-loop', true);
}
$.each( this.options , function(index, val) {
var attr = that.$element.attr('data-'+PLUGIN_NAME+'-'+index);
try {
if(typeof attr !== typeof undefined){
if(attr === "" || attr == "true"){
options[index] = true;
} else if (attr == "false") {
options[index] = false;
} else if (typeof val == 'function') {
options[index] = new Function(attr);
} else {
options[index] = attr;
}
}
} catch(exc){}
});
if(options.appendTo !== false){
this.$element.appendTo(options.appendTo);
}
if (options.iframe === true) {
this.$element.html('<div class="'+PLUGIN_NAME+'-wrap"><div class="'+PLUGIN_NAME+'-content"><iframe class="'+PLUGIN_NAME+'-iframe"></iframe>' + this.content + "</div></div>");
if (options.iframeHeight !== null) {
this.$element.find('.'+PLUGIN_NAME+'-iframe').css('height', options.iframeHeight);
}
} else {
this.$element.html('<div class="'+PLUGIN_NAME+'-wrap"><div class="'+PLUGIN_NAME+'-content">' + this.content + '</div></div>');
}
if (this.options.background !== null) {
this.$element.css('background', this.options.background);
}
this.$wrap = this.$element.find('.'+PLUGIN_NAME+'-wrap');
if(options.zindex !== null && !isNaN(parseInt(options.zindex)) ){
this.$element.css('z-index', options.zindex);
this.$navigate.css('z-index', options.zindex-1);
this.$overlay.css('z-index', options.zindex-2);
}
if(options.radius !== ""){
this.$element.css('border-radius', options.radius);
}
if(options.padding !== ""){
this.$element.find('.'+PLUGIN_NAME+'-content').css('padding', options.padding);
}
if(options.theme !== ""){
if(options.theme === "light"){
this.$element.addClass(PLUGIN_NAME+'-light');
} else {
this.$element.addClass(options.theme);
}
}
if(options.rtl === true) {
this.$element.addClass(PLUGIN_NAME+'-rtl');
}
if(options.openFullscreen === true){
this.isFullscreen = true;
this.$element.addClass('isFullscreen');
}
this.createHeader();
this.recalcWidth();
this.recalcVerticalPos();
if (that.options.afterRender && ( typeof(that.options.afterRender) === "function" || typeof(that.options.afterRender) === "object" ) ) {
that.options.afterRender(that);
}
},
createHeader: function(){
this.$header = $('<div class="'+PLUGIN_NAME+'-header"><h2 class="'+PLUGIN_NAME+'-header-title">' + this.options.title + '</h2><p class="'+PLUGIN_NAME+'-header-subtitle">' + this.options.subtitle + '</p><div class="'+PLUGIN_NAME+'-header-buttons"></div></div>');
if (this.options.closeButton === true) {
this.$header.find('.'+PLUGIN_NAME+'-header-buttons').append('<a href="javascript:void(0)" class="'+PLUGIN_NAME+'-button '+PLUGIN_NAME+'-button-close" data-'+PLUGIN_NAME+'-close></a>');
}
if (this.options.fullscreen === true) {
this.$header.find('.'+PLUGIN_NAME+'-header-buttons').append('<a href="javascript:void(0)" class="'+PLUGIN_NAME+'-button '+PLUGIN_NAME+'-button-fullscreen" data-'+PLUGIN_NAME+'-fullscreen></a>');
}
if (this.options.timeoutProgressbar === true && !isNaN(parseInt(this.options.timeout)) && this.options.timeout !== false && this.options.timeout !== 0) {
this.$header.prepend('<div class="'+PLUGIN_NAME+'-progressbar"><div style="background-color:'+this.options.timeoutProgressbarColor+'"></div></div>');
}
if (this.options.subtitle === '') {
this.$header.addClass(PLUGIN_NAME+'-noSubtitle');
}
if (this.options.title !== "") {
if (this.options.headerColor !== null) {
if(this.options.borderBottom === true){
this.$element.css('border-bottom', '3px solid ' + this.options.headerColor + '');
}
this.$header.css('background', this.options.headerColor);
}
if (this.options.icon !== null || this.options.iconText !== null){
this.$header.prepend('<i class="'+PLUGIN_NAME+'-header-icon"></i>');
if (this.options.icon !== null) {
this.$header.find('.'+PLUGIN_NAME+'-header-icon').addClass(this.options.icon).css('color', this.options.iconColor);
}
if (this.options.iconText !== null){
this.$header.find('.'+PLUGIN_NAME+'-header-icon').html(this.options.iconText);
}
}
this.$element.css('overflow', 'hidden').prepend(this.$header);
}
},
setGroup: function(groupName){
var that = this,
group = this.group.name || groupName;
this.group.ids = [];
if( groupName !== undefined && groupName !== this.group.name){
group = groupName;
this.group.name = group;
this.$element.attr('data-'+PLUGIN_NAME+'-group', group);
}
if(group !== undefined && group !== ""){
var count = 0;
$.each( $('.'+PLUGIN_NAME+'[data-'+PLUGIN_NAME+'-group='+group+']') , function(index, val) {
that.group.ids.push($(this)[0].id);
if(that.id == $(this)[0].id){
that.group.index = count;
}
count++;
});
}
},
toggle: function () {
if(this.state == STATES.OPENED){
this.close();
}
if(this.state == STATES.CLOSED){
this.open();
}
},
open: function (param) {
var that = this;
$.each( $('.'+PLUGIN_NAME) , function(index, modal) {
if( $(modal).data().iziModal !== undefined ){
var state = $(modal).iziModal('getState');
if(state == 'opened' || state == 'opening'){
$(modal).iziModal('close');
}
}
});
(function urlHash(){
if(that.options.history){
var oldTitle = document.title;
document.title = oldTitle + " - " + that.options.title;
document.location.hash = that.id;
document.title = oldTitle;
//history.pushState({}, that.options.title, "#"+that.id);
window.$iziModal.history = true;
} else {
window.$iziModal.history = false;
}
})();
function opened(){
// console.info('[ '+PLUGIN_NAME+' | '+that.id+' ] Opened.');
that.state = STATES.OPENED;
that.$element.trigger(STATES.OPENED);
if (that.options.onOpened && ( typeof(that.options.onOpened) === "function" || typeof(that.options.onOpened) === "object" ) ) {
that.options.onOpened(that);
}
}
function bindEvents(){
// Close when button pressed
that.$element.off('click', '[data-'+PLUGIN_NAME+'-close]').on('click', '[data-'+PLUGIN_NAME+'-close]', function (e) {
e.preventDefault();
var transition = $(e.currentTarget).attr('data-'+PLUGIN_NAME+'-transitionOut');
if(transition !== undefined){
that.close({transition:transition});
} else {
that.close();
}
});
// Expand when button pressed
that.$element.off('click', '[data-'+PLUGIN_NAME+'-fullscreen]').on('click', '[data-'+PLUGIN_NAME+'-fullscreen]', function (e) {
e.preventDefault();
if(that.isFullscreen === true){
that.isFullscreen = false;
that.$element.removeClass('isFullscreen');
} else {
that.isFullscreen = true;
that.$element.addClass('isFullscreen');
}
if (that.options.onFullscreen && typeof(that.options.onFullscreen) === "function") {
that.options.onFullscreen(that);
}
that.$element.trigger('fullscreen', that);
});
// Next modal
that.$navigate.off('click', '.'+PLUGIN_NAME+'-navigate-next').on('click', '.'+PLUGIN_NAME+'-navigate-next', function (e) {
that.next(e);
});
that.$element.off('click', '[data-'+PLUGIN_NAME+'-next]').on('click', '[data-'+PLUGIN_NAME+'-next]', function (e) {
that.next(e);
});
// Previous modal
that.$navigate.off('click', '.'+PLUGIN_NAME+'-navigate-prev').on('click', '.'+PLUGIN_NAME+'-navigate-prev', function (e) {
that.prev(e);
});
that.$element.off('click', '[data-'+PLUGIN_NAME+'-prev]').on('click', '[data-'+PLUGIN_NAME+'-prev]', function (e) {
that.prev(e);
});
}
if(this.state == STATES.CLOSED){
bindEvents();
this.setGroup();
this.state = STATES.OPENING;
this.$element.trigger(STATES.OPENING);
this.$element.attr('aria-hidden', 'false');
// console.info('[ '+PLUGIN_NAME+' | '+this.id+' ] Opening...');
if(this.options.iframe === true){
this.$element.find('.'+PLUGIN_NAME+'-content').addClass(PLUGIN_NAME+'-content-loader');
this.$element.find('.'+PLUGIN_NAME+'-iframe').on('load', function(){
$(this).parent().removeClass(PLUGIN_NAME+'-content-loader');
});
var href = null;
try {
href = $(param.currentTarget).attr('href') !== "" ? $(param.currentTarget).attr('href') : null;
} catch(e) {
// console.warn(e);
}
if( (this.options.iframeURL !== null) && (href === null || href === undefined)){
href = this.options.iframeURL;
}
if(href === null || href === undefined){
throw new Error("Failed to find iframe URL");
}
this.$element.find('.'+PLUGIN_NAME+'-iframe').attr('src', href);
}
if (this.options.bodyOverflow || isMobile){
$('html').addClass(PLUGIN_NAME+'-isOverflow');
if(isMobile){
$('body').css('overflow', 'hidden');
}
}
if (this.options.onOpening && typeof(this.options.onOpening) === "function") {
this.options.onOpening(this);
}
(function open(){
if(that.group.ids.length > 1 ){
that.$navigate.appendTo('body');
that.$navigate.addClass('fadeIn');
if(that.options.navigateCaption === true){
that.$navigate.find('.'+PLUGIN_NAME+'-navigate-caption').show();
}
var modalWidth = that.$element.outerWidth();
if(that.options.navigateArrows !== false){
if (that.options.navigateArrows === 'closeScreenEdge'){
that.$navigate.find('.'+PLUGIN_NAME+'-navigate-prev').css('left', 0).show();
that.$navigate.find('.'+PLUGIN_NAME+'-navigate-next').css('right', 0).show();
} else {
that.$navigate.find('.'+PLUGIN_NAME+'-navigate-prev').css('margin-left', -((modalWidth/2)+84)).show();
that.$navigate.find('.'+PLUGIN_NAME+'-navigate-next').css('margin-right', -((modalWidth/2)+84)).show();
}
} else {
that.$navigate.find('.'+PLUGIN_NAME+'-navigate-prev').hide();
that.$navigate.find('.'+PLUGIN_NAME+'-navigate-next').hide();
}
var loop;
if(that.group.index === 0){
loop = $('.'+PLUGIN_NAME+'[data-'+PLUGIN_NAME+'-group="'+that.group.name+'"][data-'+PLUGIN_NAME+'-loop]').length;
if(loop === 0 && that.options.loop === false)
that.$navigate.find('.'+PLUGIN_NAME+'-navigate-prev').hide();
}
if(that.group.index+1 === that.group.ids.length){
loop = $('.'+PLUGIN_NAME+'[data-'+PLUGIN_NAME+'-group="'+that.group.name+'"][data-'+PLUGIN_NAME+'-loop]').length;
if(loop === 0 && that.options.loop === false)
that.$navigate.find('.'+PLUGIN_NAME+'-navigate-next').hide();
}
}
if(that.options.overlay === true) {
if(that.options.appendToOverlay === false){
that.$overlay.appendTo('body');
} else {
that.$overlay.appendTo( that.options.appendToOverlay );
}
}
if (that.options.transitionInOverlay) {
that.$overlay.addClass(that.options.transitionInOverlay);
}
var transitionIn = that.options.transitionIn;
if( typeof param == 'object' ){
if(param.transition !== undefined || param.transitionIn !== undefined){
transitionIn = param.transition || param.transitionIn;
}
}
if (transitionIn !== '' && animationEvent !== undefined) {
that.$element.addClass("transitionIn "+transitionIn).show();
that.$wrap.one(animationEvent, function () {
that.$element.removeClass(transitionIn + " transitionIn");
that.$overlay.removeClass(that.options.transitionInOverlay);
that.$navigate.removeClass('fadeIn');
opened();
});
} else {
that.$element.show();
opened();
}
if(that.options.pauseOnHover === true && that.options.pauseOnHover === true && that.options.timeout !== false && !isNaN(parseInt(that.options.timeout)) && that.options.timeout !== false && that.options.timeout !== 0){
that.$element.off('mouseenter').on('mouseenter', function(event) {
event.preventDefault();
that.isPaused = true;
});
that.$element.off('mouseleave').on('mouseleave', function(event) {
event.preventDefault();
that.isPaused = false;
});
}
})();
if (this.options.timeout !== false && !isNaN(parseInt(this.options.timeout)) && this.options.timeout !== false && this.options.timeout !== 0) {
if (this.options.timeoutProgressbar === true) {
this.progressBar = {
hideEta: null,
maxHideTime: null,
currentTime: new Date().getTime(),
el: this.$element.find('.'+PLUGIN_NAME+'-progressbar > div'),
updateProgress: function()
{
if(!that.isPaused){
that.progressBar.currentTime = that.progressBar.currentTime+10;
var percentage = ((that.progressBar.hideEta - (that.progressBar.currentTime)) / that.progressBar.maxHideTime) * 100;
that.progressBar.el.width(percentage + '%');
if(percentage < 0){
that.close();
}
}
}
};
if (this.options.timeout > 0) {
this.progressBar.maxHideTime = parseFloat(this.options.timeout);
this.progressBar.hideEta = new Date().getTime() + this.progressBar.maxHideTime;
this.timerTimeout = setInterval(this.progressBar.updateProgress, 10);
}
} else {
this.timerTimeout = setTimeout(function(){
that.close();
}, that.options.timeout);
}
}
// Close on overlay click
if (this.options.overlayClose && !this.$element.hasClass(this.options.transitionOut)) {
this.$overlay.click(function () {
that.close();
});
}
if (this.options.focusInput){
this.$element.find(':input:not(button):enabled:visible:first').focus(); // Focus on the first field
}
(function updateTimer(){
that.recalcLayout();
that.timer = setTimeout(updateTimer, 300);
})();
// Close when the Escape key is pressed
$document.on('keydown.'+PLUGIN_NAME, function (e) {
if (that.options.closeOnEscape && e.keyCode === 27) {
that.close();
}
});
}
},
close: function (param) {
var that = this;
function closed(){
// console.info('[ '+PLUGIN_NAME+' | '+that.id+' ] Closed.');
that.state = STATES.CLOSED;
that.$element.trigger(STATES.CLOSED);
if (that.options.iframe === true) {
that.$element.find('.'+PLUGIN_NAME+'-iframe').attr('src', "");
}
if (that.options.bodyOverflow || isMobile){
$('html').removeClass(PLUGIN_NAME+'-isOverflow');
if(isMobile){
$('body').css('overflow','auto');
}
}
if (that.options.onClosed && typeof(that.options.onClosed) === "function") {
that.options.onClosed(that);
}
if(that.options.restoreDefaultContent === true){
that.$element.find('.'+PLUGIN_NAME+'-content').html( that.content );
}
if( $('.'+PLUGIN_NAME+':visible').length === 0 ){
$('html').removeClass(PLUGIN_NAME+'-isAttached');
}
}
if(this.state == STATES.OPENED || this.state == STATES.OPENING){
$document.off('keydown.'+PLUGIN_NAME);
this.state = STATES.CLOSING;
this.$element.trigger(STATES.CLOSING);
this.$element.attr('aria-hidden', 'true');
// console.info('[ '+PLUGIN_NAME+' | '+this.id+' ] Closing...');
clearTimeout(this.timer);
clearTimeout(this.timerTimeout);
if (that.options.onClosing && typeof(that.options.onClosing) === "function") {
that.options.onClosing(this);
}
var transitionOut = this.options.transitionOut;
if( typeof param == 'object' ){
if(param.transition !== undefined || param.transitionOut !== undefined){
transitionOut = param.transition || param.transitionOut;
}
}
if( (transitionOut === false || transitionOut === '' ) || animationEvent === undefined){
this.$element.hide();
this.$overlay.remove();
this.$navigate.remove();
closed();
} else {
this.$element.attr('class', [
this.classes,
PLUGIN_NAME,
transitionOut,
this.options.theme == 'light' ? PLUGIN_NAME+'-light' : this.options.theme,
this.isFullscreen === true ? 'isFullscreen' : '',
this.options.rtl ? PLUGIN_NAME+'-rtl' : ''
].join(' '));
this.$overlay.attr('class', PLUGIN_NAME + "-overlay " + this.options.transitionOutOverlay);
if(that.options.navigateArrows !== false){
this.$navigate.attr('class', PLUGIN_NAME + "-navigate fadeOut");
}
this.$element.one(animationEvent, function () {
if( that.$element.hasClass(transitionOut) ){
that.$element.removeClass(transitionOut + " transitionOut").hide();
}
that.$overlay.removeClass(that.options.transitionOutOverlay).remove();
that.$navigate.removeClass('fadeOut').remove();
closed();
});
}
}
},
next: function (e){
var that = this;
var transitionIn = 'fadeInRight';
var transitionOut = 'fadeOutLeft';
var modal = $('.'+PLUGIN_NAME+':visible');
var modals = {};
modals.out = this;
if(e !== undefined && typeof e !== 'object'){
e.preventDefault();
modal = $(e.currentTarget);
transitionIn = modal.attr('data-'+PLUGIN_NAME+'-transitionIn');
transitionOut = modal.attr('data-'+PLUGIN_NAME+'-transitionOut');
} else if(e !== undefined){
if(e.transitionIn !== undefined){
transitionIn = e.transitionIn;
}
if(e.transitionOut !== undefined){
transitionOut = e.transitionOut;
}
}
this.close({transition:transitionOut});
setTimeout(function(){
var loop = $('.'+PLUGIN_NAME+'[data-'+PLUGIN_NAME+'-group="'+that.group.name+'"][data-'+PLUGIN_NAME+'-loop]').length;
for (var i = that.group.index+1; i <= that.group.ids.length; i++) {
try {
modals.in = $("#"+that.group.ids[i]).data().iziModal;
} catch(log) {
// console.info('[ '+PLUGIN_NAME+' ] No next modal.');
}
if(typeof modals.in !== 'undefined'){
$("#"+that.group.ids[i]).iziModal('open', { transition: transitionIn });
break;
} else {
if(i == that.group.ids.length && loop > 0 || that.options.loop === true){
for (var index = 0; index <= that.group.ids.length; index++) {
modals.in = $("#"+that.group.ids[index]).data().iziModal;
if(typeof modals.in !== 'undefined'){
$("#"+that.group.ids[index]).iziModal('open', { transition: transitionIn });
break;
}
}
}
}
}
}, 200);
$(document).trigger( PLUGIN_NAME + "-group-change", modals );
},
prev: function (e){
var that = this;
var transitionIn = 'fadeInLeft';
var transitionOut = 'fadeOutRight';
var modal = $('.'+PLUGIN_NAME+':visible');
var modals = {};
modals.out = this;
if(e !== undefined && typeof e !== 'object'){
e.preventDefault();
modal = $(e.currentTarget);
transitionIn = modal.attr('data-'+PLUGIN_NAME+'-transitionIn');
transitionOut = modal.attr('data-'+PLUGIN_NAME+'-transitionOut');
} else if(e !== undefined){
if(e.transitionIn !== undefined){
transitionIn = e.transitionIn;
}
if(e.transitionOut !== undefined){
transitionOut = e.transitionOut;
}
}
this.close({transition:transitionOut});
setTimeout(function(){
var loop = $('.'+PLUGIN_NAME+'[data-'+PLUGIN_NAME+'-group="'+that.group.name+'"][data-'+PLUGIN_NAME+'-loop]').length;
for (var i = that.group.index; i >= 0; i--) {
try {
modals.in = $("#"+that.group.ids[i-1]).data().iziModal;
} catch(log) {
// console.info('[ '+PLUGIN_NAME+' ] No previous modal.');
}
if(typeof modals.in !== 'undefined'){
$("#"+that.group.ids[i-1]).iziModal('open', { transition: transitionIn });
break;
} else {
if(i === 0 && loop > 0 || that.options.loop === true){
for (var index = that.group.ids.length-1; index >= 0; index--) {
modals.in = $("#"+that.group.ids[index]).data().iziModal;
if(typeof modals.in !== 'undefined'){
$("#"+that.group.ids[index]).iziModal('open', { transition: transitionIn });
break;
}
}
}
}
}
}, 200);
$(document).trigger( PLUGIN_NAME + "-group-change", modals );
},
destroy: function () {
var e = $.Event('destroy');
this.$element.trigger(e);
$document.off('keydown.'+PLUGIN_NAME);
clearTimeout(this.timer);
clearTimeout(this.timerTimeout);
if (this.options.iframe === true) {
this.$element.find('.'+PLUGIN_NAME+'-iframe').remove();
}
this.$element.html(this.$element.find('.'+PLUGIN_NAME+'-content').html());
this.$element.off('click', '[data-'+PLUGIN_NAME+'-close]');
this.$element.off('click', '[data-'+PLUGIN_NAME+'-fullscreen]');
this.$element
.off('.'+PLUGIN_NAME)
.removeData(PLUGIN_NAME)
.attr('style', '');
this.$overlay.remove();
this.$navigate.remove();
this.$element.trigger(STATES.DESTROYED);
this.$element = null;
},
getState: function(){
return this.state;
},
getGroup: function(){
return this.group;
},
setWidth: function(width){
this.options.width = width;
this.recalcWidth();
var modalWidth = this.$element.outerWidth();
if(this.options.navigateArrows === true || this.options.navigateArrows == 'closeToModal'){
this.$navigate.find('.'+PLUGIN_NAME+'-navigate-prev').css('margin-left', -((modalWidth/2)+84)).show();
this.$navigate.find('.'+PLUGIN_NAME+'-navigate-next').css('margin-right', -((modalWidth/2)+84)).show();
}
},
setTop: function(top){
this.options.top = top;
this.recalcVerticalPos(false);
},
setBottom: function(bottom){
this.options.bottom = bottom;
this.recalcVerticalPos(false);
},
setHeader: function(status){
if(status){
this.$element.find('.'+PLUGIN_NAME+'-header').show();
} else {
this.headerHeight = 0;
this.$element.find('.'+PLUGIN_NAME+'-header').hide();
}
},
setTitle: function(title){
this.options.title = title;
if(this.headerHeight === 0){
this.createHeader();
}
if( this.$header.find('.'+PLUGIN_NAME+'-header-title').length === 0 ){
this.$header.append('<h2 class="'+PLUGIN_NAME+'-header-title"></h2>');
}
this.$header.find('.'+PLUGIN_NAME+'-header-title').html(title);
},
setSubtitle: function(subtitle){
if(subtitle === ''){
this.$header.find('.'+PLUGIN_NAME+'-header-subtitle').remove();
this.$header.addClass(PLUGIN_NAME+'-noSubtitle');
} else {
if( this.$header.find('.'+PLUGIN_NAME+'-header-subtitle').length === 0 ){
this.$header.append('<p class="'+PLUGIN_NAME+'-header-subtitle"></p>');
}
this.$header.removeClass(PLUGIN_NAME+'-noSubtitle');
}
this.$header.find('.'+PLUGIN_NAME+'-header-subtitle').html(subtitle);
this.options.subtitle = subtitle;
},
setIcon: function(icon){
if( this.$header.find('.'+PLUGIN_NAME+'-header-icon').length === 0 ){
this.$header.prepend('<i class="'+PLUGIN_NAME+'-header-icon"></i>');
}
this.$header.find('.'+PLUGIN_NAME+'-header-icon').attr('class', PLUGIN_NAME+'-header-icon ' + icon);
this.options.icon = icon;
},
setIconText: function(iconText){
this.$header.find('.'+PLUGIN_NAME+'-header-icon').html(iconText);
this.options.iconText = iconText;
},
setHeaderColor: function(headerColor){
if(this.options.borderBottom === true){
this.$element.css('border-bottom', '3px solid ' + headerColor + '');
}
this.$header.css('background', headerColor);
this.options.headerColor = headerColor;
},
setBackground: function(background){
if(background === false){
this.options.background = null;
this.$element.css('background', '');
} else{
this.$element.css('background', background);
this.options.background = background;
}
},
setZindex: function(zIndex){
if (!isNaN(parseInt(this.options.zindex))) {
this.options.zindex = zIndex;
this.$element.css('z-index', zIndex);
this.$navigate.css('z-index', zIndex-1);
this.$overlay.css('z-index', zIndex-2);
}
},
setFullscreen: function(value){
if(value){
this.isFullscreen = true;
this.$element.addClass('isFullscreen');
} else {
this.isFullscreen = false;
this.$element.removeClass('isFullscreen');
}
},
setContent: function(content){
if( typeof content == "object" ){
var replace = content.default || false;
if(replace === true){
this.content = content.content;
}
content = content.content;
}
if (this.options.iframe === false) {
this.$element.find('.'+PLUGIN_NAME+'-content').html(content);
}
},
setTransitionIn: function(transition){
this.options.transitionIn = transition;
},
setTransitionOut: function(transition){
this.options.transitionOut = transition;
},
resetContent: function(){
this.$element.find('.'+PLUGIN_NAME+'-content').html(this.content);
},
startLoading: function(){
if( !this.$element.find('.'+PLUGIN_NAME+'-loader').length ){
this.$element.append('<div class="'+PLUGIN_NAME+'-loader fadeIn"></div>');
}
this.$element.find('.'+PLUGIN_NAME+'-loader').css({
top: this.headerHeight,
borderRadius: this.options.radius
});
},
stopLoading: function(){
var $loader = this.$element.find('.'+PLUGIN_NAME+'-loader');
if( !$loader.length ){
this.$element.prepend('<div class="'+PLUGIN_NAME+'-loader fadeIn"></div>');
$loader = this.$element.find('.'+PLUGIN_NAME+'-loader').css('border-radius', this.options.radius);
}
$loader.removeClass('fadeIn').addClass('fadeOut');
setTimeout(function(){
$loader.remove();
},600);
},
recalcWidth: function(){
var that = this;
this.$element.css('max-width', this.options.width);
if(isIE()){
var modalWidth = that.options.width;
if(modalWidth.toString().split("%").length > 1){
modalWidth = that.$element.outerWidth();
}
that.$element.css({
left: '50%',
marginLeft: -(modalWidth/2)
});
}
},
recalcVerticalPos: function(first){
if(this.options.top !== null && this.options.top !== false){
this.$element.css('margin-top', this.options.top);
if(this.options.top === 0){
this.$element.css({
borderTopRightRadius: 0,
borderTopLeftRadius: 0
});
}
} else {
if(first === false){
this.$element.css({
marginTop: '',
borderRadius: this.options.radius
});
}
}
if (this.options.bottom !== null && this.options.bottom !== false){
this.$element.css('margin-bottom', this.options.bottom);
if(this.options.bottom === 0){
this.$element.css({
borderBottomRightRadius: 0,
borderBottomLeftRadius: 0
});
}
} else {
if(first === false){
this.$element.css({
marginBottom: '',
borderRadius: this.options.radius
});
}
}
},
recalcLayout: function(){
var that = this,
windowHeight = $window.height(),
modalHeight = this.$element.outerHeight(),
modalWidth = this.$element.outerWidth(),
contentHeight = this.$element.find('.'+PLUGIN_NAME+'-content')[0].scrollHeight,
outerHeight = contentHeight + this.headerHeight,
wrapperHeight = this.$element.innerHeight() - this.headerHeight,
modalMargin = parseInt(-((this.$element.innerHeight() + 1) / 2)) + 'px',
scrollTop = this.$wrap.scrollTop(),
borderSize = 0;
if(isIE()){
if( modalWidth >= $window.width() || this.isFullscreen === true ){
this.$element.css({
left: '0',
marginLeft: ''
});
} else {
this.$element.css({
left: '50%',
marginLeft: -(modalWidth/2)
});
}
}
if(this.options.borderBottom === true && this.options.title !== ""){
borderSize = 3;
}
if(this.$element.find('.'+PLUGIN_NAME+'-header').length && this.$element.find('.'+PLUGIN_NAME+'-header').is(':visible') ){
this.headerHeight = parseInt(this.$element.find('.'+PLUGIN_NAME+'-header').innerHeight());
this.$element.css('overflow', 'hidden');
} else {
this.headerHeight = 0;
this.$element.css('overflow', '');
}
if(this.$element.find('.'+PLUGIN_NAME+'-loader').length){
this.$element.find('.'+PLUGIN_NAME+'-loader').css('top', this.headerHeight);
}
if(modalHeight !== this.modalHeight){
this.modalHeight = modalHeight;
if (this.options.onResize && typeof(this.options.onResize) === "function") {
this.options.onResize(this);
}
}
if(this.state == STATES.OPENED || this.state == STATES.OPENING){
if (this.options.iframe === true) {
// If the height of the window is smaller than the modal with iframe
if(windowHeight < (this.options.iframeHeight + this.headerHeight+borderSize) || this.isFullscreen === true){
this.$element.find('.'+PLUGIN_NAME+'-iframe').css( 'height', windowHeight - (this.headerHeight+borderSize));
} else {
this.$element.find('.'+PLUGIN_NAME+'-iframe').css( 'height', this.options.iframeHeight);
}
}
if(modalHeight == windowHeight){
this.$element.addClass('isAttached');
} else {
this.$element.removeClass('isAttached');
}
if(this.isFullscreen === false && this.$element.width() >= $window.width() ){
this.$element.find('.'+PLUGIN_NAME+'-button-fullscreen').hide();
} else {
this.$element.find('.'+PLUGIN_NAME+'-button-fullscreen').show();
}
this.recalcButtons();
if(this.isFullscreen === false){
windowHeight = windowHeight - (clearValue(this.options.top) || 0) - (clearValue(this.options.bottom) || 0);
}
// If the modal is larger than the height of the window..
if (outerHeight > windowHeight) {
if(this.options.top > 0 && this.options.bottom === null && contentHeight < $window.height()){
this.$element.addClass('isAttachedBottom');
}
if(this.options.bottom > 0 && this.options.top === null && contentHeight < $window.height()){
this.$element.addClass('isAttachedTop');
}
$('html').addClass(PLUGIN_NAME+'-isAttached');
this.$element.css( 'height', windowHeight );
} else {
this.$element.css('height', contentHeight + (this.headerHeight+borderSize));
this.$element.removeClass('isAttachedTop isAttachedBottom');
$('html').removeClass(PLUGIN_NAME+'-isAttached');
}
(function applyScroll(){
if(contentHeight > wrapperHeight && outerHeight > windowHeight){
that.$element.addClass('hasScroll');
that.$wrap.css('height', modalHeight - (that.headerHeight+borderSize));
} else {
that.$element.removeClass('hasScroll');
that.$wrap.css('height', 'auto');
}
})();
(function applyShadow(){
if (wrapperHeight + scrollTop < (contentHeight - 30)) {
that.$element.addClass('hasShadow');
} else {
that.$element.removeClass('hasShadow');
}
})();
}
},
recalcButtons: function(){
var widthButtons = this.$header.find('.'+PLUGIN_NAME+'-header-buttons').innerWidth()+10;
if(this.options.rtl === true){
this.$header.css('padding-left', widthButtons);
} else {
this.$header.css('padding-right', widthButtons);
}
}
};
$window.off('load.'+PLUGIN_NAME).on('load.'+PLUGIN_NAME, function(e) {
var modalHash = document.location.hash;
if(window.$iziModal.autoOpen === 0 && !$('.'+PLUGIN_NAME).is(":visible")){
try {
var data = $(modalHash).data();
if(typeof data !== 'undefined'){
if(data.iziModal.options.autoOpen !== false){
$(modalHash).iziModal("open");
}
}
} catch(exc) { /* console.warn(exc); */ }
}
});
$window.off('hashchange.'+PLUGIN_NAME).on('hashchange.'+PLUGIN_NAME, function(e) {
var modalHash = document.location.hash;
var data = $(modalHash).data();
if(modalHash !== ""){
try {
if(typeof data !== 'undefined' && $(modalHash).iziModal('getState') !== 'opening'){
setTimeout(function(){
$(modalHash).iziModal("open");
},200);
}
} catch(exc) { /* console.warn(exc); */ }
} else {
if(window.$iziModal.history){
$.each( $('.'+PLUGIN_NAME) , function(index, modal) {
if( $(modal).data().iziModal !== undefined ){
var state = $(modal).iziModal('getState');
if(state == 'opened' || state == 'opening'){
$(modal).iziModal('close');
}
}
});
}
}
});
$document.off('click', '[data-'+PLUGIN_NAME+'-open]').on('click', '[data-'+PLUGIN_NAME+'-open]', function(e) {
e.preventDefault();
var modal = $('.'+PLUGIN_NAME+':visible');
var openModal = $(e.currentTarget).attr('data-'+PLUGIN_NAME+'-open');
var transitionIn = $(e.currentTarget).attr('data-'+PLUGIN_NAME+'-transitionIn');
var transitionOut = $(e.currentTarget).attr('data-'+PLUGIN_NAME+'-transitionOut');
if(transitionOut !== undefined){
modal.iziModal('close', {
transition: transitionOut
});
} else {
modal.iziModal('close');
}
setTimeout(function(){
if(transitionIn !== undefined){
$(openModal).iziModal('open', {
transition: transitionIn
});
} else {
$(openModal).iziModal('open');
}
}, 200);
});
$document.off('keyup.'+PLUGIN_NAME).on('keyup.'+PLUGIN_NAME, function(event) {
if( $('.'+PLUGIN_NAME+':visible').length ){
var modal = $('.'+PLUGIN_NAME+':visible')[0].id,
group = $("#"+modal).iziModal('getGroup'),
e = event || window.event,
target = e.target || e.srcElement,
modals = {};
if(modal !== undefined && group.name !== undefined && !e.ctrlKey && !e.metaKey && !e.altKey && target.tagName.toUpperCase() !== 'INPUT' && target.tagName.toUpperCase() != 'TEXTAREA'){ //&& $(e.target).is('body')
if(e.keyCode === 37) { // left
$("#"+modal).iziModal('prev', e);
}
else if(e.keyCode === 39 ) { // right
$("#"+modal).iziModal('next', e);
}
}
}
});
$.fn[PLUGIN_NAME] = function(option, args) {
if( !$(this).length && typeof option == "object"){
var newEL = {
$el: document.createElement("div"),
id: this.selector.split('#'),
class: this.selector.split('.')
};
if(newEL.id.length > 1){
try{
newEL.$el = document.createElement(id[0]);
} catch(exc){ }
newEL.$el.id = this.selector.split('#')[1].trim();
} else if(newEL.class.length > 1){
try{
newEL.$el = document.createElement(newEL.class[0]);
} catch(exc){ }
for (var x=1; x<newEL.class.length; x++) {
newEL.$el.classList.add(newEL.class[x].trim());
}
}
document.body.appendChild(newEL.$el);
this.push($(this.selector));
}
var objs = this;
for (var i=0; i<objs.length; i++) {
var $this = $(objs[i]);
var data = $this.data(PLUGIN_NAME);
var options = $.extend({}, $.fn[PLUGIN_NAME].defaults, $this.data(), typeof option == 'object' && option);
if (!data && (!option || typeof option == 'object')){
$this.data(PLUGIN_NAME, (data = new iziModal($this, options)));
}
else if (typeof option == 'string' && typeof data != 'undefined'){
return data[option].apply(data, [].concat(args));
}
if (options.autoOpen){ // Automatically open the modal if autoOpen setted true or ms
if( !isNaN(parseInt(options.autoOpen)) ){
setTimeout(function(){
data.open();
}, options.autoOpen);
} else if(options.autoOpen === true ) {
data.open();
}
window.$iziModal.autoOpen++;
}
}
return this;
};
$.fn[PLUGIN_NAME].defaults = {
title: '',
subtitle: '',
headerColor: '#88A0B9',
background: null,
theme: '', // light
icon: null,
iconText: null,
iconColor: '',
rtl: false,
width: 600,
top: null,
bottom: null,
borderBottom: true,
padding: 0,
radius: 3,
zindex: 999,
iframe: false,
iframeHeight: 400,
iframeURL: null,
focusInput: true,
group: '',
loop: false,
navigateCaption: true,
navigateArrows: true, // Boolean, 'closeToModal', 'closeScreenEdge'
history: false,
restoreDefaultContent: false,
autoOpen: 0, // Boolean, Number
bodyOverflow: false,
fullscreen: false,
openFullscreen: false,
closeOnEscape: true,
closeButton: true,
appendTo: 'body', // or false
appendToOverlay: 'body', // or false
overlay: true,
overlayClose: true,
overlayColor: 'rgba(0, 0, 0, 0.4)',
timeout: false,
timeoutProgressbar: false,
pauseOnHover: false,
timeoutProgressbarColor: 'rgba(255,255,255,0.5)',
transitionIn: 'comingIn', // comingIn, bounceInDown, bounceInUp, fadeInDown, fadeInUp, fadeInLeft, fadeInRight, flipInX
transitionOut: 'comingOut', // comingOut, bounceOutDown, bounceOutUp, fadeOutDown, fadeOutUp, , fadeOutLeft, fadeOutRight, flipOutX
transitionInOverlay: 'fadeIn',
transitionOutOverlay: 'fadeOut',
onFullscreen: function(){},
onResize: function(){},
onOpening: function(){},
onOpened: function(){},
onClosing: function(){},
onClosed: function(){},
afterRender: function(){}
};
$.fn[PLUGIN_NAME].Constructor = iziModal;
return $.fn.iziModal;
}));
================================================
FILE: assets/vendor/jquery-ui-flick/jquery-ui-flick.css
================================================
/*! jQuery UI - v1.11.2 - 2014-10-16
* https://code.jquery.com/ui/1.11.2/themes/flick/jquery-ui.css
* Includes: core.css, accordion.css, autocomplete.css, button.css, datepicker.css, dialog.css, draggable.css, menu.css, progressbar.css, resizable.css, selectable.css, selectmenu.css, slider.css, sortable.css, spinner.css, tabs.css, tooltip.css, theme.css
* To view and modify this theme, visit http://jqueryui.com/themeroller/?ffDefault=Helvetica%2CArial%2Csans-serif&fwDefault=bold&fsDefault=1.1em&cornerRadius=2px&bgColorHeader=dddddd&bgTextureHeader=highlight_soft&bgImgOpacityHeader=50&borderColorHeader=dddddd&fcHeader=444444&iconColorHeader=0073ea&bgColorContent=ffffff&bgTextureContent=flat&bgImgOpacityContent=75&borderColorContent=dddddd&fcContent=444444&iconColorContent=ff0084&bgColorDefault=f6f6f6&bgTextureDefault=highlight_soft&bgImgOpacityDefault=100&borderColorDefault=dddddd&fcDefault=0073ea&iconColorDefault=666666&bgColorHover=0073ea&bgTextureHover=highlight_soft&bgImgOpacityHover=25&borderColorHover=0073ea&fcHover=ffffff&iconColorHover=ffffff&bgColorActive=ffffff&bgTextureActive=glass&bgImgOpacityActive=65&borderColorActive=dddddd&fcActive=ff0084&iconColorActive=454545&bgColorHighlight=ffffff&bgTextureHighlight=flat&bgImgOpacityHighlight=55&borderColorHighlight=cccccc&fcHighlight=444444&iconColorHighlight=0073ea&bgColorError=ffffff&bgTextureError=flat&bgImgOpacityError=55&borderColorError=ff0084&fcError=222222&iconColorError=ff0084&bgColorOverlay=eeeeee&bgTextureOverlay=flat&bgImgOpacityOverlay=0&opacityOverlay=80&bgColorShadow=aaaaaa&bgTextureShadow=flat&bgImgOpacityShadow=0&opacityShadow=60&thicknessShadow=4px&offsetTopShadow=-4px&offsetLeftShadow=-4px&cornerRadiusShadow=0px
* Copyright 2014 jQuery Foundation and other contributors; Licensed MIT */
/* Layout helpers
----------------------------------*/
.ui-helper-hidden {
display: none;
}
.ui-helper-hidden-accessible {
border: 0;
clip: rect(0 0 0 0);
height: 1px;
margin: -1px;
overflow: hidden;
padding: 0;
position: absolute;
width: 1px;
}
.ui-helper-reset {
margin: 0;
padding: 0;
border: 0;
outline: 0;
line-height: 1.3;
text-decoration: none;
font-size: 100%;
list-style: none;
}
.ui-helper-clearfix:before,
.ui-helper-clearfix:after {
content: "";
display: table;
border-collapse: collapse;
}
.ui-helper-clearfix:after {
clear: both;
}
.ui-helper-clearfix {
min-height: 0; /* support: IE7 */
}
.ui-helper-zfix {
width: 100%;
height: 100%;
top: 0;
left: 0;
position: absolute;
opacity: 0;
filter:Alpha(Opacity=0); /* support: IE8 */
}
.ui-front {
z-index: 100;
}
/* Interaction Cues
----------------------------------*/
.ui-state-disabled {
cursor: default !important;
}
/* Icons
----------------------------------*/
/* states and images */
.ui-icon {
display: block;
text-indent: -99999px;
overflow: hidden;
background-repeat: no-repeat;
}
/* Misc visuals
----------------------------------*/
/* Overlays */
.ui-widget-overlay {
position: fixed;
top: 0;
left: 0;
width: 100%;
height: 100%;
}
.ui-accordion .ui-accordion-header {
display: block;
cursor: pointer;
position: relative;
margin: 2px 0 0 0;
padding: .5em .5em .5em .7em;
min-height: 0; /* support: IE7 */
font-size: 100%;
}
.ui-accordion .ui-accordion-icons {
padding-left: 2.2em;
}
.ui-accordion .ui-accordion-icons .ui-accordion-icons {
padding-left: 2.2em;
}
.ui-accordion .ui-accordion-header .ui-accordion-header-icon {
position: absolute;
left: .5em;
top: 50%;
margin-top: -8px;
}
.ui-accordion .ui-accordion-content {
padding: 1em 2.2em;
border-top: 0;
overflow: auto;
}
.ui-autocomplete {
position: absolute;
top: 0;
left: 0;
cursor: default;
}
.ui-button {
display: inline-block;
position: relative;
padding: 0;
line-height: normal;
margin-right: .1em;
cursor: pointer;
vertical-align: middle;
text-align: center;
overflow: visible; /* removes extra width in IE */
}
.ui-button,
.ui-button:link,
.ui-button:visited,
.ui-button:hover,
.ui-button:active {
text-decoration: none;
}
/* to make room for the icon, a width needs to be set here */
.ui-button-icon-only {
width: 2.2em;
}
/* button elements seem to need a little more width */
button.ui-button-icon-only {
width: 2.4em;
}
.ui-button-icons-only {
width: 3.4em;
}
button.ui-button-icons-only {
width: 3.7em;
}
/* button text element */
.ui-button .ui-button-text {
display: block;
line-height: normal;
}
.ui-button-text-only .ui-button-text {
padding: .4em 1em;
}
.ui-button-icon-only .ui-button-text,
.ui-button-icons-only .ui-button-text {
padding: .4em;
text-indent: -9999999px;
}
.ui-button-text-icon-primary .ui-button-text,
.ui-button-text-icons .ui-button-text {
padding: .4em 1em .4em 2.1em;
}
.ui-button-text-icon-secondary .ui-button-text,
.ui-button-text-icons .ui-button-text {
padding: .4em 2.1em .4em 1em;
}
.ui-button-text-icons .ui-button-text {
padding-left: 2.1em;
padding-right: 2.1em;
}
/* no icon support for input elements, provide padding by default */
input.ui-button {
padding: .4em 1em;
}
/* button icon element(s) */
.ui-button-icon-only .ui-icon,
.ui-button-text-icon-primary .ui-icon,
.ui-button-text-icon-secondary .ui-icon,
.ui-button-text-icons .ui-icon,
.ui-button-icons-only .ui-icon {
position: absolute;
top: 50%;
margin-top: -8px;
}
.ui-button-icon-only .ui-icon {
left: 50%;
margin-left: -8px;
}
.ui-button-text-icon-primary .ui-button-icon-primary,
.ui-button-text-icons .ui-button-icon-primary,
.ui-button-icons-only .ui-button-icon-primary {
left: .5em;
}
.ui-button-text-icon-secondary .ui-button-icon-secondary,
.ui-button-text-icons .ui-button-icon-secondary,
.ui-button-icons-only .ui-button-icon-secondary {
right: .5em;
}
/* button sets */
.ui-buttonset {
margin-right: 7px;
}
.ui-buttonset .ui-button {
margin-left: 0;
margin-right: -.3em;
}
/* workarounds */
/* reset extra padding in Firefox, see h5bp.com/l */
input.ui-button::-moz-focus-inner,
button.ui-button::-moz-focus-inner {
border: 0;
padding: 0;
}
.ui-datepicker {
width: 17em;
padding: .2em .2em 0;
display: none;
}
.ui-datepicker .ui-datepicker-header {
position: relative;
padding: .2em 0;
}
.ui-datepicker .ui-datepicker-prev,
.ui-datepicker .ui-datepicker-next {
position: absolute;
top: 2px;
width: 1.8em;
height: 1.8em;
}
.ui-datepicker .ui-datepicker-prev-hover,
.ui-datepicker .ui-datepicker-next-hover {
top: 1px;
}
.ui-datepicker .ui-datepicker-prev {
left: 2px;
}
.ui-datepicker .ui-datepicker-next {
right: 2px;
}
.ui-datepicker .ui-datepicker-prev-hover {
left: 1px;
}
.ui-datepicker .ui-datepicker-next-hover {
right: 1px;
}
.ui-datepicker .ui-datepicker-prev span,
.ui-datepicker .ui-datepicker-next span {
display: block;
position: absolute;
left: 50%;
margin-left: -8px;
top: 50%;
margin-top: -8px;
}
.ui-datepicker .ui-datepicker-title {
margin: 0 2.3em;
line-height: 1.8em;
text-align: center;
}
.ui-datepicker .ui-datepicker-title select {
font-size: 1em;
margin: 1px 0;
}
.ui-datepicker select.ui-datepicker-month,
.ui-datepicker select.ui-datepicker-year {
width: 45%;
}
.ui-datepicker table {
width: 100%;
font-size: .9em;
border-collapse: collapse;
margin: 0 0 .4em;
}
.ui-datepicker th {
padding: .7em .3em;
text-align: center;
font-weight: bold;
border: 0;
}
.ui-datepicker td {
border: 0;
padding: 1px;
}
.ui-datepicker td span,
.ui-datepicker td a {
display: block;
padding: .2em;
text-align: right;
text-decoration: none;
}
.ui-datepicker .ui-datepicker-buttonpane {
background-image: none;
margin: .7em 0 0 0;
padding: 0 .2em;
border-left: 0;
border-right: 0;
border-bottom: 0;
}
.ui-datepicker .ui-datepicker-buttonpane button {
float: right;
margin: .5em .2em .4em;
cursor: pointer;
padding: .2em .6em .3em .6em;
width: auto;
overflow: visible;
}
.ui-datepicker .ui-datepicker-buttonpane button.ui-datepicker-current {
float: left;
}
/* with multiple calendars */
.ui-datepicker.ui-datepicker-multi {
width: auto;
}
.ui-datepicker-multi .ui-datepicker-group {
float: left;
}
.ui-datepicker-multi .ui-datepicker-group table {
width: 95%;
margin: 0 auto .4em;
}
.ui-datepicker-multi-2 .ui-datepicker-group {
width: 50%;
}
.ui-datepicker-multi-3 .ui-datepicker-group {
width: 33.3%;
}
.ui-datepicker-multi-4 .ui-datepicker-group {
width: 25%;
}
.ui-datepicker-multi .ui-datepicker-group-last .ui-datepicker-header,
.ui-datepicker-multi .ui-datepicker-group-middle .ui-datepicker-header {
border-left-width: 0;
}
.ui-datepicker-multi .ui-datepicker-buttonpane {
clear: left;
}
.ui-datepicker-row-break {
clear: both;
width: 100%;
font-size: 0;
}
/* RTL support */
.ui-datepicker-rtl {
direction: rtl;
}
.ui-datepicker-rtl .ui-datepicker-prev {
right: 2px;
left: auto;
}
.ui-datepicker-rtl .ui-datepicker-next {
left: 2px;
right: auto;
}
.ui-datepicker-rtl .ui-datepicker-prev:hover {
right: 1px;
left: auto;
}
.ui-datepicker-rtl .ui-datepicker-next:hover {
left: 1px;
right: auto;
}
.ui-datepicker-rtl .ui-datepicker-buttonpane {
clear: right;
}
.ui-datepicker-rtl .ui-datepicker-buttonpane button {
float: left;
}
.ui-datepicker-rtl .ui-datepicker-buttonpane button.ui-datepicker-current,
.ui-datepicker-rtl .ui-datepicker-group {
float: right;
}
.ui-datepicker-rtl .ui-datepicker-group-last .ui-datepicker-header,
.ui-datepicker-rtl .ui-datepicker-group-middle .ui-datepicker-header {
border-right-width: 0;
border-left-width: 1px;
}
.ui-dialog {
overflow: hidden;
position: absolute;
top: 0;
left: 0;
padding: .2em;
outline: 0;
}
.ui-dialog .ui-dialog-titlebar {
padding: .4em 1em;
position: relative;
}
.ui-dialog .ui-dialog-title {
float: left;
margin: .1em 0;
white-space: nowrap;
width: 90%;
overflow: hidden;
text-overflow: ellipsis;
}
.ui-dialog .ui-dialog-titlebar-close {
position: absolute;
right: .3em;
top: 50%;
width: 20px;
margin: -10px 0 0 0;
padding: 1px;
height: 20px;
}
.ui-dialog .ui-dialog-content {
position: relative;
border: 0;
padding: .5em 1em;
background: none;
overflow: auto;
}
.ui-dialog .ui-dialog-buttonpane {
text-align: left;
border-width: 1px 0 0 0;
background-image: none;
margin-top: .5em;
padding: .3em 1em .5em .4em;
}
.ui-dialog .ui-dialog-buttonpane .ui-dialog-buttonset {
float: right;
}
.ui-dialog .ui-dialog-buttonpane button {
margin: .5em .4em .5em 0;
cursor: pointer;
}
.ui-dialog .ui-resizable-se {
width: 12px;
height: 12px;
right: -5px;
bottom: -5px;
background-position: 16px 16px;
}
.ui-draggable .ui-dialog-titlebar {
cursor: move;
}
.ui-draggable-handle {
-ms-touch-action: none;
touch-action: none;
}
.ui-menu {
list-style: none;
padding: 0;
margin: 0;
display: block;
outline: none;
}
.ui-menu .ui-menu {
position: absolute;
}
.ui-menu .ui-menu-item {
position: relative;
margin: 0;
padding: 3px 1em 3px .4em;
cursor: pointer;
min-height: 0; /* support: IE7 */
/* support: IE10, see #8844 */
list-style-image: url("data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7");
}
.ui-menu .ui-menu-divider {
margin: 5px 0;
height: 0;
font-size: 0;
line-height: 0;
border-width: 1px 0 0 0;
}
.ui-menu .ui-state-focus,
.ui-menu .ui-state-active {
margin: -1px;
}
/* icon support */
.ui-menu-icons {
position: relative;
}
.ui-menu-icons .ui-menu-item {
padding-left: 2em;
}
/* left-aligned */
.ui-menu .ui-icon {
position: absolute;
top: 0;
bottom: 0;
left: .2em;
margin: auto 0;
}
/* right-aligned */
.ui-menu .ui-menu-icon {
left: auto;
right: 0;
}
.ui-progressbar {
height: 2em;
text-align: left;
overflow: hidden;
}
.ui-progressbar .ui-progressbar-value {
margin: -1px;
height: 100%;
}
.ui-progressbar .ui-progressbar-overlay {
background: url("data:image/gif;base64,R0lGODlhKAAoAIABAAAAAP///yH/C05FVFNDQVBFMi4wAwEAAAAh+QQJAQABACwAAAAAKAAoAAACkYwNqXrdC52DS06a7MFZI+4FHBCKoDeWKXqymPqGqxvJrXZbMx7Ttc+w9XgU2FB3lOyQRWET2IFGiU9m1frDVpxZZc6bfHwv4c1YXP6k1Vdy292Fb6UkuvFtXpvWSzA+HycXJHUXiGYIiMg2R6W459gnWGfHNdjIqDWVqemH2ekpObkpOlppWUqZiqr6edqqWQAAIfkECQEAAQAsAAAAACgAKAAAApSMgZnGfaqcg1E2uuzDmmHUBR8Qil95hiPKqWn3aqtLsS18y7G1SzNeowWBENtQd+T1JktP05nzPTdJZlR6vUxNWWjV+vUWhWNkWFwxl9VpZRedYcflIOLafaa28XdsH/ynlcc1uPVDZxQIR0K25+cICCmoqCe5mGhZOfeYSUh5yJcJyrkZWWpaR8doJ2o4NYq62lAAACH5BAkBAAEALAAAAAAoACgAAAKVDI4Yy22ZnINRNqosw0Bv7i1gyHUkFj7oSaWlu3ovC8GxNso5fluz3qLVhBVeT/Lz7ZTHyxL5dDalQWPVOsQWtRnuwXaFTj9jVVh8pma9JjZ4zYSj5ZOyma7uuolffh+IR5aW97cHuBUXKGKXlKjn+DiHWMcYJah4N0lYCMlJOXipGRr5qdgoSTrqWSq6WFl2ypoaUAAAIfkECQEAAQAsAAAAACgAKAAAApaEb6HLgd/iO7FNWtcFWe+ufODGjRfoiJ2akShbueb0wtI50zm02pbvwfWEMWBQ1zKGlLIhskiEPm9R6vRXxV4ZzWT2yHOGpWMyorblKlNp8HmHEb/lCXjcW7bmtXP8Xt229OVWR1fod2eWqNfHuMjXCPkIGNileOiImVmCOEmoSfn3yXlJWmoHGhqp6ilYuWYpmTqKUgAAIfkECQEAAQAsAAAAACgAKAAAApiEH6kb58biQ3FNWtMFWW3eNVcojuFGfqnZqSebuS06w5V80/X02pKe8zFwP6EFWOT1lDFk8rGERh1TTNOocQ61Hm4Xm2VexUHpzjymViHrFbiELsefVrn6XKfnt2Q9G/+Xdie499XHd2g4h7ioOGhXGJboGAnXSBnoBwKYyfioubZJ2Hn0RuRZaflZOil56Zp6iioKSXpUAAAh+QQJAQABACwAAAAAKAAoAAACkoQRqRvnxuI7kU1a1UU5bd5tnSeOZXhmn5lWK3qNTWvRdQxP8qvaC+/yaYQzXO7BMvaUEmJRd3TsiMAgswmNYrSgZdYrTX6tSHGZO73ezuAw2uxuQ+BbeZfMxsexY35+/Qe4J1inV0g4x3WHuMhIl2jXOKT2Q+VU5fgoSUI52VfZyfkJGkha6jmY+aaYdirq+lQAACH5BAkBAAEALAAAAAAoACgAAAKWBIKpYe0L3YNKToqswUlvznigd4wiR4KhZrKt9Upqip61i9E3vMvxRdHlbEFiEXfk9YARYxOZZD6VQ2pUunBmtRXo1Lf8hMVVcNl8JafV38aM2/Fu5V16Bn63r6xt97j09+MXSFi4BniGFae3hzbH9+hYBzkpuUh5aZmHuanZOZgIuvbGiNeomCnaxxap2upaCZsq+1kAACH5BAkBAAEALAAAAAAoACgAAAKXjI8By5zf4kOxTVrXNVlv1X0d8IGZGKLnNpYtm8Lr9cqVeuOSvfOW79D9aDHizNhDJidFZhNydEahOaDH6nomtJjp1tutKoNWkvA6JqfRVLHU/QUfau9l2x7G54d1fl995xcIGAdXqMfBNadoYrhH+Mg2KBlpVpbluCiXmMnZ2Sh4GBqJ+ckIOqqJ6LmKSllZmsoq6wpQAAAh+QQJAQABACwAAAAAKAAoAAAClYx/oLvoxuJDkU1a1YUZbJ59nSd2ZXhWqbRa2/gF8Gu2DY3iqs7yrq+xBYEkYvFSM8aSSObE+ZgRl1BHFZNr7pRCavZ5BW2142hY3AN/zWtsmf12p9XxxFl2lpLn1rseztfXZjdIWIf2s5dItwjYKBgo9yg5pHgzJXTEeGlZuenpyPmpGQoKOWkYmSpaSnqKileI2FAAACH5BAkBAAEALAAAAAAoACgAAAKVjB+gu+jG4kORTVrVhRlsnn2dJ3ZleFaptFrb+CXmO9OozeL5VfP99HvAWhpiUdcwkpBH3825AwYdU8xTqlLGhtCosArKMpvfa1mMRae9VvWZfeB2XfPkeLmm18lUcBj+p5dnN8jXZ3YIGEhYuOUn45aoCDkp16hl5IjYJvjWKcnoGQpqyPlpOhr3aElaqrq56Bq7VAAAOw==");
height: 100%;
filter: alpha(opacity=25); /* support: IE8 */
opacity: 0.25;
}
.ui-progressbar-indeterminate .ui-progressbar-value {
background-image: none;
}
.ui-resizable {
position: relative;
}
.ui-resizable-handle {
position: absolute;
font-size: 0.1px;
display: block;
-ms-touch-action: none;
touch-action: none;
}
.ui-resizable-disabled .ui-resizable-handle,
.ui-resizable-autohide .ui-resizable-handle {
display: none;
}
.ui-resizable-n {
cursor: n-resize;
height: 7px;
width: 100%;
top: -5px;
left: 0;
}
.ui-resizable-s {
cursor: s-resize;
height: 7px;
width: 100%;
bottom: -5px;
left: 0;
}
.ui-resizable-e {
cursor: e-resize;
width: 7px;
right: -5px;
top: 0;
height: 100%;
}
.ui-resizable-w {
cursor: w-resize;
width: 7px;
left: -5px;
top: 0;
height: 100%;
}
.ui-resizable-se {
cursor: se-resize;
width: 12px;
height: 12px;
right: 1px;
bottom: 1px;
}
.ui-resizable-sw {
cursor: sw-resize;
width: 9px;
height: 9px;
left: -5px;
bottom: -5px;
}
.ui-resizable-nw {
cursor: nw-resize;
width: 9px;
height: 9px;
left: -5px;
top: -5px;
}
.ui-resizable-ne {
cursor: ne-resize;
width: 9px;
height: 9px;
right: -5px;
top: -5px;
}
.ui-selectable {
-ms-touch-action: none;
touch-action: none;
}
.ui-selectable-helper {
position: absolute;
z-index: 100;
border: 1px dotted black;
}
.ui-selectmenu-menu {
padding: 0;
margin: 0;
position: absolute;
top: 0;
left: 0;
display: none;
}
.ui-selectmenu-menu .ui-menu {
overflow: auto;
/* Support: IE7 */
overflow-x: hidden;
padding-bottom: 1px;
}
.ui-selectmenu-menu .ui-menu .ui-selectmenu-optgroup {
font-size: 1em;
font-weight: bold;
line-height: 1.5;
padding: 2px 0.4em;
margin: 0.5em 0 0 0;
height: auto;
border: 0;
}
.ui-selectmenu-open {
display: block;
}
.ui-selectmenu-button {
display: inline-block;
overflow: hidden;
position: relative;
text-decoration: none;
cursor: pointer;
}
.ui-selectmenu-button span.ui-icon {
right: 0.5em;
left: auto;
margin-top: -8px;
position: absolute;
top: 50%;
}
.ui-selectmenu-button span.ui-selectmenu-text {
text-align: left;
padding: 0.4em 2.1em 0.4em 1em;
display: block;
line-height: 1.4;
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap;
}
.ui-slider {
position: relative;
text-align: left;
}
.ui-slider .ui-slider-handle {
position: absolute;
z-index: 2;
width: 1.2em;
height: 1.2em;
cursor: default;
-ms-touch-action: none;
touch-action: none;
}
.ui-slider .ui-slider-range {
position: absolute;
z-index: 1;
font-size: .7em;
display: block;
border: 0;
background-position: 0 0;
}
/* support: IE8 - See #6727 */
.ui-slider.ui-state-disabled .ui-slider-handle,
.ui-slider.ui-state-disabled .ui-slider-range {
filter: inherit;
}
.ui-slider-horizontal {
height: .8em;
}
.ui-slider-horizontal .ui-slider-handle {
top: -.3em;
margin-left: -.6em;
}
.ui-slider-horizontal .ui-slider-range {
top: 0;
height: 100%;
}
.ui-slider-horizontal .ui-slider-range-min {
left: 0;
}
.ui-slider-horizontal .ui-slider-range-max {
right: 0;
}
.ui-slider-vertical {
width: .8em;
height: 100px;
}
.ui-slider-vertical .ui-slider-handle {
left: -.3em;
margin-left: 0;
margin-bottom: -.6em;
}
.ui-slider-vertical .ui-slider-range {
left: 0;
width: 100%;
}
.ui-slider-vertical .ui-slider-range-min {
bottom: 0;
}
.ui-slider-vertical .ui-slider-range-max {
top: 0;
}
.ui-sortable-handle {
-ms-touch-action: none;
touch-action: none;
}
.ui-spinner {
position: relative;
display: inline-block;
overflow: hidden;
padding: 0;
vertical-align: middle;
}
.ui-spinner-input {
border: none;
background: none;
color: inherit;
padding: 0;
margin: .2em 0;
vertical-align: middle;
margin-left: .4em;
margin-right: 22px;
}
.ui-spinner-button {
width: 16px;
height: 50%;
font-size: .5em;
padding: 0;
margin: 0;
text-align: center;
position: absolute;
cursor: default;
display: block;
overflow: hidden;
right: 0;
}
/* more specificity required here to override default borders */
.ui-spinner a.ui-spinner-button {
border-top: none;
border-bottom: none;
border-right: none;
}
/* vertically center icon */
.ui-spinner .ui-icon {
position: absolute;
margin-top: -8px;
top: 50%;
left: 0;
}
.ui-spinner-up {
top: 0;
}
.ui-spinner-down {
bottom: 0;
}
/* TR overrides */
.ui-spinner .ui-icon-triangle-1-s {
/* need to fix icons sprite */
background-position: -65px -16px;
}
.ui-tabs {
position: relative;/* position: relative prevents IE scroll bug (element with position: relative inside container with overflow: auto appear as "fixed") */
padding: .2em;
}
.ui-tabs .ui-tabs-nav {
margin: 0;
padding: .2em .2em 0;
}
.ui-tabs .ui-tabs-nav li {
list-style: none;
float: left;
position: relative;
top: 0;
margin: 1px .2em 0 0;
border-bottom-width: 0;
padding: 0;
white-space: nowrap;
}
.ui-tabs .ui-tabs-nav .ui-tabs-anchor {
float: left;
padding: .5em 1em;
text-decoration: none;
}
.ui-tabs .ui-tabs-nav li.ui-tabs-active {
margin-bottom: -1px;
padding-bottom: 1px;
}
.ui-tabs .ui-tabs-nav li.ui-tabs-active .ui-tabs-anchor,
.ui-tabs .ui-tabs-nav li.ui-state-disabled .ui-tabs-anchor,
.ui-tabs .ui-tabs-nav li.ui-tabs-loading .ui-tabs-anchor {
cursor: text;
}
.ui-tabs-collapsible .ui-tabs-nav li.ui-tabs-active .ui-tabs-anchor {
cursor: pointer;
}
.ui-tabs .ui-tabs-panel {
display: block;
border-width: 0;
padding: 1em 1.4em;
background: none;
}
.ui-tooltip {
padding: 8px;
position: absolute;
z-index: 9999;
max-width: 300px;
-webkit-box-shadow: 0 0 5px #aaa;
box-shadow: 0 0 5px #aaa;
}
body .ui-tooltip {
border-width: 2px;
}
/* Component containers
----------------------------------*/
.ui-widget {
font-family: Helvetica,Arial,sans-serif;
font-size: 1.1em;
}
.ui-widget .ui-widget {
font-size: 1em;
}
.ui-widget input,
.ui-widget select,
.ui-widget textarea,
.ui-widget button {
font-family: Helvetica,Arial,sans-serif;
font-size: 1em;
}
.ui-widget-content {
border: 1px solid #dddddd;
background: #ffffff url("images/ui-bg_flat_75_ffffff_40x100.png") 50% 50% repeat-x;
color: #444444;
}
.ui-widget-content a {
color: #444444;
}
.ui-widget-header {
border: 1px solid #dddddd;
background: #dddddd url("images/ui-bg_highlight-soft_50_dddddd_1x100.png") 50% 50% repeat-x;
color: #444444;
font-weight: bold;
}
.ui-widget-header a {
color: #444444;
}
/* Interaction states
----------------------------------*/
.ui-state-default,
.ui-widget-content .ui-state-default,
.ui-widget-header .ui-state-default {
border: 1px solid #dddddd;
background: #f6f6f6 url("images/ui-bg_highlight-soft_100_f6f6f6_1x100.png") 50% 50% repeat-x;
font-weight: bold;
color: #0073ea;
}
.ui-state-default a,
.ui-state-default a:link,
.ui-state-default a:visited {
color: #0073ea;
text-decoration: none;
}
.ui-state-hover,
.ui-widget-content .ui-state-hover,
.ui-widget-header .ui-state-hover,
.ui-state-focus,
.ui-widget-content .ui-state-focus,
.ui-widget-header .ui-state-focus {
border: 1px solid #0073ea;
background: #0073ea url("images/ui-bg_highlight-soft_25_0073ea_1x100.png") 50% 50% repeat-x;
font-weight: bold;
color: #ffffff;
}
.ui-state-hover a,
.ui-state-hover a:hover,
.ui-state-hover a:link,
.ui-state-hover a:visited,
.ui-state-focus a,
.ui-state-focus a:hover,
.ui-state-focus a:link,
.ui-state-focus a:visited {
color: #ffffff;
text-decoration: none;
}
.ui-state-active,
.ui-widget-content .ui-state-active,
.ui-widget-header .ui-state-active {
border: 1px solid #dddddd;
background: #ffffff url("images/ui-bg_glass_65_ffffff_1x400.png") 50% 50% repeat-x;
font-weight: bold;
color: #ff0084;
}
.ui-state-active a,
.ui-state-active a:link,
.ui-state-active a:visited {
color: #ff0084;
text-decoration: none;
}
/* Interaction Cues
----------------------------------*/
.ui-state-highlight,
.ui-widget-content .ui-state-highlight,
.ui-widget-header .ui-state-highlight {
border: 1px solid #cccccc;
background: #ffffff url("images/ui-bg_flat_55_ffffff_40x100.png") 50% 50% repeat-x;
color: #444444;
}
.ui-state-highlight a,
.ui-widget-content .ui-state-highlight a,
.ui-widget-header .ui-state-highlight a {
color: #444444;
}
.ui-state-error,
.ui-widget-content .ui-state-error,
.ui-widget-header .ui-state-error {
border: 1px solid #ff0084;
background: #ffffff url("images/ui-bg_flat_55_ffffff_40x100.png") 50% 50% repeat-x;
color: #222222;
}
.ui-state-error a,
.ui-widget-content .ui-state-error a,
.ui-widget-header .ui-state-error a {
color: #222222;
}
.ui-state-error-text,
.ui-widget-content .ui-state-error-text,
.ui-widget-header .ui-state-error-text {
color: #222222;
}
.ui-priority-primary,
.ui-widget-content .ui-priority-primary,
.ui-widget-header .ui-priority-primary {
font-weight: bold;
}
.ui-priority-secondary,
.ui-widget-content .ui-priority-secondary,
.ui-widget-header .ui-priority-secondary {
opacity: .7;
filter:Alpha(Opacity=70); /* support: IE8 */
font-weight: normal;
}
.ui-state-disabled,
.ui-widget-content .ui-state-disabled,
.ui-widget-header .ui-state-disabled {
opacity: .35;
filter:Alpha(Opacity=35); /* support: IE8 */
background-image: none;
}
.ui-state-disabled .ui-icon {
filter:Alpha(Opacity=35); /* support: IE8 - See #6059 */
}
/* Icons
----------------------------------*/
/* states and images */
.ui-icon {
width: 16px;
height: 16px;
}
.ui-icon,
.ui-widget-content .ui-icon {
background-image: url("images/ui-icons_ff0084_256x240.png");
}
.ui-widget-header .ui-icon {
background-image: url("images/ui-icons_0073ea_256x240.png");
}
.ui-state-default .ui-icon {
background-image: url("images/ui-icons_666666_256x240.png");
}
.ui-state-hover .ui-icon,
.ui-state-focus .ui-icon {
background-image: url("images/ui-icons_ffffff_256x240.png");
}
.ui-state-active .ui-icon {
background-image: url("images/ui-icons_454545_256x240.png");
}
.ui-state-highlight .ui-icon {
background-image: url("images/ui-icons_0073ea_256x240.png");
}
.ui-state-error .ui-icon,
.ui-state-error-text .ui-icon {
background-image: url("images/ui-icons_ff0084_256x240.png");
}
/* positioning */
.ui-icon-blank { background-position: 16px 16px; }
.ui-icon-carat-1-n { background-position: 0 0; }
.ui-icon-carat-1-ne { background-position: -16px 0; }
.ui-icon-carat-1-e { background-position: -32px 0; }
.ui-icon-carat-1-se { background-position: -48px 0; }
.ui-icon-carat-1-s { background-position: -64px 0; }
.ui-icon-carat-1-sw { background-position: -80px 0; }
.ui-icon-carat-1-w { background-position: -96px 0; }
.ui-icon-carat-1-nw { background-position: -112px 0; }
.ui-icon-carat-2-n-s { background-position: -128px 0; }
.ui-icon-carat-2-e-w { background-position: -144px 0; }
.ui-icon-triangle-1-n { background-position: 0 -16px; }
.ui-icon-triangle-1-ne { background-position: -16px -16px; }
.ui-icon-triangle-1-e { background-position: -32px -16px; }
.ui-icon-triangle-1-se { background-position: -48px -16px; }
.ui-icon-triangle-1-s { background-position: -64px -16px; }
.ui-icon-triangle-1-sw { background-position: -80px -16px; }
.ui-icon-triangle-1-w { background-position: -96px -16px; }
.ui-icon-triangle-1-nw { background-position: -112px -16px; }
.ui-icon-triangle-2-n-s { background-position: -128px -16px; }
.ui-icon-triangle-2-e-w { background-position: -144px -16px; }
.ui-icon-arrow-1-n { background-position: 0 -32px; }
.ui-icon-arrow-1-ne { background-position: -16px -32px; }
.ui-icon-arrow-1-e { background-position: -32px -32px; }
.ui-icon-arrow-1-se { background-position: -48px -32px; }
.ui-icon-arrow-1-s { background-position: -64px -32px; }
.ui-icon-arrow-1-sw { background-position: -80px -32px; }
.ui-icon-arrow-1-w { background-position: -96px -32px; }
.ui-icon-arrow-1-nw { background-position: -112px -32px; }
.ui-icon-arrow-2-n-s { background-position: -128px -32px; }
.ui-icon-arrow-2-ne-sw { background-position: -144px -32px; }
.ui-icon-arrow-2-e-w { background-position: -160px -32px; }
.ui-icon-arrow-2-se-nw { background-position: -176px -32px; }
.ui-icon-arrowstop-1-n { background-position: -192px -32px; }
.ui-icon-arrowstop-1-e { background-position: -208px -32px; }
.ui-icon-arrowstop-1-s { background-position: -224px -32px; }
.ui-icon-arrowstop-1-w { background-position: -240px -32px; }
.ui-icon-arrowthick-1-n { background-position: 0 -48px; }
.ui-icon-arrowthick-1-ne { background-position: -16px -48px; }
.ui-icon-arrowthick-1-e { background-position: -32px -48px; }
.ui-icon-arrowthick-1-se { background-position: -48px -48px; }
.ui-icon-arrowthick-1-s { background-position: -64px -48px; }
.ui-icon-arrowthick-1-sw { background-position: -80px -48px; }
.ui-icon-arrowthick-1-w { background-position: -96px -48px; }
.ui-icon-arrowthick-1-nw { background-position: -112px -48px; }
.ui-icon-arrowthick-2-n-s { background-position: -128px -48px; }
.ui-icon-arrowthick-2-ne-sw { background-position: -144px -48px; }
.ui-icon-arrowthick-2-e-w { background-position: -160px -48px; }
.ui-icon-arrowthick-2-se-nw { background-position: -176px -48px; }
.ui-icon-arrowthickstop-1-n { background-position: -192px -48px; }
.ui-icon-arrowthickstop-1-e { background-position: -208px -48px; }
.ui-icon-arrowthickstop-1-s { background-position: -224px -48px; }
.ui-icon-arrowthickstop-1-w { background-position: -240px -48px; }
.ui-icon-arrowreturnthick-1-w { background-position: 0 -64px; }
.ui-icon-arrowreturnthick-1-n { background-position: -16px -64px; }
.ui-icon-arrowreturnthick-1-e { background-position: -32px -64px; }
.ui-icon-arrowreturnthick-1-s { background-position: -48px -64px; }
.ui-icon-arrowreturn-1-w { background-position: -64px -64px; }
.ui-icon-arrowreturn-1-n { background-position: -80px -64px; }
.ui-icon-arrowreturn-1-e { background-position: -96px -64px; }
.ui-icon-arrowreturn-1-s { background-position: -112px -64px; }
.ui-icon-arrowrefresh-1-w { background-position: -128px -64px; }
.ui-icon-arrowrefresh-1-n { background-position: -144px -64px; }
.ui-icon-arrowrefresh-1-e { background-position: -160px -64px; }
.ui-icon-arrowrefresh-1-s { background-position: -176px -64px; }
.ui-icon-arrow-4 { background-position: 0 -80px; }
.ui-icon-arrow-4-diag { background-position: -16px -80px; }
.ui-icon-extlink { background-position: -32px -80px; }
.ui-icon-newwin { background-position: -48px -80px; }
.ui-icon-refresh { background-position: -64px -80px; }
.ui-icon-shuffle { background-position: -80px -80px; }
.ui-icon-transfer-e-w { background-position: -96px -80px; }
.ui-icon-transferthick-e-w { background-position: -112px -80px; }
.ui-icon-folder-collapsed { background-position: 0 -96px; }
.ui-icon-folder-open { background-position: -16px -96px; }
.ui-icon-document { background-position: -32px -96px; }
.ui-icon-document-b { background-position: -48px -96px; }
.ui-icon-note { background-position: -64px -96px; }
.ui-icon-mail-closed { background-position: -80px -96px; }
.ui-icon-mail-open { background-position: -96px -96px; }
.ui-icon-suitcase { background-position: -112px -96px; }
.ui-icon-comment { background-position: -128px -96px; }
.ui-icon-person { background-position: -144px -96px; }
.ui-icon-print { background-position: -160px -96px; }
.ui-icon-trash { background-position: -176px -96px; }
.ui-icon-locked { background-position: -192px -96px; }
.ui-icon-unlocked { background-position: -208px -96px; }
.ui-icon-bookmark { background-position: -224px -96px; }
.ui-icon-tag { background-position: -240px -96px; }
.ui-icon-home { background-position: 0 -112px; }
.ui-icon-flag { background-position: -16px -112px; }
.ui-icon-calendar { background-position: -32px -112px; }
.ui-icon-cart { background-position: -48px -112px; }
.ui-icon-pencil { background-position: -64px -112px; }
.ui-icon-clock { background-position: -80px -112px; }
.ui-icon-disk { background-position: -96px -112px; }
.ui-icon-calculator { background-position: -112px -112px; }
.ui-icon-zoomin { background-position: -128px -112px; }
.ui-icon-zoomout { background-position: -144px -112px; }
.ui-icon-search { background-position: -160px -112px; }
.ui-icon-wrench { background-position: -176px -112px; }
.ui-icon-gear { background-position: -192px -112px; }
.ui-icon-heart { background-position: -208px -112px; }
.ui-icon-star { background-position: -224px -112px; }
.ui-icon-link { background-position: -240px -112px; }
.ui-icon-cancel { background-position: 0 -128px; }
.ui-icon-plus { background-position: -16px -128px; }
.ui-icon-plusthick { background-position: -32px -128px; }
.ui-icon-minus { background-position: -48px -128px; }
.ui-icon-minusthick { background-position: -64px -128px; }
.ui-icon-close { background-position: -80px -128px; }
.ui-icon-closethick { background-position: -96px -128px; }
.ui-icon-key { background-position: -112px -128px; }
.ui-icon-lightbulb { background-position: -128px -128px; }
.ui-icon-scissors { background-position: -144px -128px; }
.ui-icon-clipboard { background-position: -160px -128px; }
.ui-icon-copy { background-position: -176px -128px; }
.ui-icon-contact { background-position: -192px -128px; }
.ui-icon-image { background-position: -208px -128px; }
.ui-icon-video { background-position: -224px -128px; }
.ui-icon-script { background-position: -240px -128px; }
.ui-icon-alert { background-position: 0 -144px; }
.ui-icon-info { background-position: -16px -144px; }
.ui-icon-notice { background-position: -32px -144px; }
.ui-icon-help { background-position: -48px -144px; }
.ui-icon-check { background-position: -64px -144px; }
.ui-icon-bullet { background-position: -80px -144px; }
.ui-icon-radio-on { background-position: -96px -144px; }
.ui-icon-radio-off { background-position: -112px -144px; }
.ui-icon-pin-w { background-position: -128px -144px; }
.ui-icon-pin-s { background-position: -144px -144px; }
.ui-icon-play { background-position: 0 -160px; }
.ui-icon-pause { background-position: -16px -160px; }
.ui-icon-seek-next { background-position: -32px -160px; }
.ui-icon-seek-prev { background-position: -48px -160px; }
.ui-icon-seek-end { background-position: -64px -160px; }
.ui-icon-seek-start { background-position: -80px -160px; }
/* ui-icon-seek-first is deprecated, use ui-icon-seek-start instead */
.ui-icon-seek-first { background-position: -80px -160px; }
.ui-icon-stop { background-position: -96px -160px; }
.ui-icon-eject { background-position: -112px -160px; }
.ui-icon-volume-off { background-position: -128px -160px; }
.ui-icon-volume-on { background-position: -144px -160px; }
.ui-icon-power { background-position: 0 -176px; }
.ui-icon-signal-diag { background-position: -16px -176px; }
.ui-icon-signal { background-position: -32px -176px; }
.ui-icon-battery-0 { background-position: -48px -176px; }
.ui-icon-battery-1 { background-position: -64px -176px; }
.ui-icon-battery-2 { background-position: -80px -176px; }
.ui-icon-battery-3 { background-position: -96px -176px; }
.ui-icon-circle-plus { background-position: 0 -192px; }
.ui-icon-circle-minus { background-position: -16px -192px; }
.ui-icon-circle-close { background-position: -32px -192px; }
.ui-icon-circle-triangle-e { background-position: -48px -192px; }
.ui-icon-circle-triangle-s { background-position: -64px -192px; }
.ui-icon-circle-triangle-w { background-position: -80px -192px; }
.ui-icon-circle-triangle-n { background-position: -96px -192px; }
.ui-icon-circle-arrow-e { background-position: -112px -192px; }
.ui-icon-circle-arrow-s { background-position: -128px -192px; }
.ui-icon-circle-arrow-w { background-position: -144px -192px; }
.ui-icon-circle-arrow-n { background-position: -160px -192px; }
.ui-icon-circle-zoomin { background-position: -176px -192px; }
.ui-icon-circle-zoomout { background-position: -192px -192px; }
.ui-icon-circle-check { background-position: -208px -192px; }
.ui-icon-circlesmall-plus { background-position: 0 -208px; }
.ui-icon-circlesmall-minus { background-position: -16px -208px; }
.ui-icon-circlesmall-close { background-position: -32px -208px; }
.ui-icon-squaresmall-plus { background-position: -48px -208px; }
.ui-icon-squaresmall-minus { background-position: -64px -208px; }
.ui-icon-squaresmall-close { background-position: -80px -208px; }
.ui-icon-grip-dotted-vertical { background-position: 0 -224px; }
.ui-icon-grip-dotted-horizontal { background-position: -16px -224px; }
.ui-icon-grip-solid-vertical { background-position: -32px -224px; }
.ui-icon-grip-solid-horizontal { background-position: -48px -224px; }
.ui-icon-gripsmall-diagonal-se { background-position: -64px -224px; }
.ui-icon-grip-diagonal-se { background-position: -80px -224px; }
/* Misc visuals
----------------------------------*/
/* Corner radius */
.ui-corner-all,
.ui-corner-top,
.ui-corner-left,
.ui-corner-tl {
border-top-left-radius: 2px;
}
.ui-corner-all,
.ui-corner-top,
.ui-corner-right,
.ui-corner-tr {
border-top-right-radius: 2px;
}
.ui-corner-all,
.ui-corner-bottom,
.ui-corner-left,
.ui-corner-bl {
border-bottom-left-radius: 2px;
}
.ui-corner-all,
.ui-corner-bottom,
.ui-corner-right,
.ui-corner-br {
border-bottom-right-radius: 2px;
}
/* Overlays */
.ui-widget-overlay {
background: #eeeeee url("images/ui-bg_flat_0_eeeeee_40x100.png") 50% 50% repeat-x;
opacity: .8;
filter: Alpha(Opacity=80); /* support: IE8 */
}
.ui-widget-shadow {
margin: -4px 0 0 -4px;
padding: 4px;
background: #aaaaaa url("images/ui-bg_flat_0_aaaaaa_40x100.png") 50% 50% repeat-x;
opacity: .6;
filter: Alpha(Opacity=60); /* support: IE8 */
border-radius: 0px;
}
================================================
FILE: assets/vendor/quill/quill.bubble.css
================================================
/*!
* Quill Editor v1.3.5
* https://quilljs.com/
* Copyright (c) 2014, Jason Chen
* Copyright (c) 2013, salesforce.com
*/
.ql-container {
box-sizing: border-box;
font-family: Helvetica, Arial, sans-serif;
font-size: 13px;
height: 100%;
margin: 0px;
position: relative;
}
.ql-container.ql-disabled .ql-tooltip {
visibility: hidden;
}
.ql-container.ql-disabled .ql-editor ul[data-checked] > li::before {
pointer-events: none;
}
.ql-clipboard {
left: -100000px;
height: 1px;
overflow-y: hidden;
position: absolute;
top: 50%;
}
.ql-clipboard p {
margin: 0;
padding: 0;
}
.ql-editor {
box-sizing: border-box;
line-height: 1.42;
height: 100%;
outline: none;
overflow-y: auto;
padding: 12px 15px;
tab-size: 4;
-moz-tab-size: 4;
text-align: left;
white-space: pre-wrap;
word-wrap: break-word;
}
.ql-editor > * {
cursor: text;
}
.ql-editor p,
.ql-editor ol,
.ql-editor ul,
.ql-editor pre,
.ql-editor blockquote,
.ql-editor h1,
.ql-editor h2,
.ql-editor h3,
.ql-editor h4,
.ql-editor h5,
.ql-editor h6 {
margin: 0;
padding: 0;
counter-reset: list-1 list-2 list-3 list-4 list-5 list-6 list-7 list-8 list-9;
}
.ql-editor ol,
.ql-editor ul {
padding-left: 1.5em;
}
.ql-editor ol > li,
.ql-editor ul > li {
list-style-type: none;
}
.ql-editor ul > li::before {
content: '\2022';
}
.ql-editor ul[data-checked=true],
.ql-editor ul[data-checked=false] {
pointer-events: none;
}
.ql-editor ul[data-checked=true] > li *,
.ql-editor ul[data-checked=false] > li * {
pointer-events: all;
}
.ql-editor ul[data-checked=true] > li::before,
.ql-editor ul[data-checked=false] > li::before {
color: #777;
cursor: pointer;
pointer-events: all;
}
.ql-editor ul[data-checked=true] > li::before {
content: '\2611';
}
.ql-editor ul[data-checked=false] > li::before {
content: '\2610';
}
.ql-editor li::before {
display: inline-block;
white-space: nowrap;
width: 1.2em;
}
.ql-editor li:not(.ql-direction-rtl)::before {
margin-left: -1.5em;
margin-right: 0.3em;
text-align: right;
}
.ql-editor li.ql-direction-rtl::before {
margin-left: 0.3em;
margin-right: -1.5em;
}
.ql-editor ol li:not(.ql-direction-rtl),
.ql-editor ul li:not(.ql-direction-rtl) {
padding-left: 1.5em;
}
.ql-editor ol li.ql-direction-rtl,
.ql-editor ul li.ql-direction-rtl {
padding-right: 1.5em;
}
.ql-editor ol li {
counter-reset: list-1 list-2 list-3 list-4 list-5 list-6 list-7 list-8 list-9;
counter-increment: list-0;
}
.ql-editor ol li:before {
content: counter(list-0, decimal) '. ';
}
.ql-editor ol li.ql-indent-1 {
counter-increment: list-1;
}
.ql-editor ol li.ql-indent-1:before {
content: counter(list-1, lower-alpha) '. ';
}
.ql-editor ol li.ql-indent-1 {
counter-reset: list-2 list-3 list-4 list-5 list-6 list-7 list-8 list-9;
}
.ql-editor ol li.ql-indent-2 {
counter-increment: list-2;
}
.ql-editor ol li.ql-indent-2:before {
content: counter(list-2, lower-roman) '. ';
}
.ql-editor ol li.ql-indent-2 {
counter-reset: list-3 list-4 list-5 list-6 list-7 list-8 list-9;
}
.ql-editor ol li.ql-indent-3 {
counter-increment: list-3;
}
.ql-editor ol li.ql-indent-3:before {
content: counter(list-3, decimal) '. ';
}
.ql-editor ol li.ql-indent-3 {
counter-reset: list-4 list-5 list-6 list-7 list-8 list-9;
}
.ql-editor ol li.ql-indent-4 {
counter-increment: list-4;
}
.ql-editor ol li.ql-indent-4:before {
content: counter(list-4, lower-alpha) '. ';
}
.ql-editor ol li.ql-indent-4 {
counter-reset: list-5 list-6 list-7 list-8 list-9;
}
.ql-editor ol li.ql-indent-5 {
counter-increment: list-5;
}
.ql-editor ol li.ql-indent-5:before {
content: counter(list-5, lower-roman) '. ';
}
.ql-editor ol li.ql-indent-5 {
counter-reset: list-6 list-7 list-8 list-9;
}
.ql-editor ol li.ql-indent-6 {
counter-increment: list-6;
}
.ql-editor ol li.ql-indent-6:before {
content: counter(list-6, decimal) '. ';
}
.ql-editor ol li.ql-indent-6 {
counter-reset: list-7 list-8 list-9;
}
.ql-editor ol li.ql-indent-7 {
counter-increment: list-7;
}
.ql-editor ol li.ql-indent-7:before {
content: counter(list-7, lower-alpha) '. ';
}
.ql-editor ol li.ql-indent-7 {
counter-reset: list-8 list-9;
}
.ql-editor ol li.ql-indent-8 {
counter-increment: list-8;
}
.ql-editor ol li.ql-indent-8:before {
content: counter(list-8, lower-roman) '. ';
}
.ql-editor ol li.ql-indent-8 {
counter-reset: list-9;
}
.ql-editor ol li.ql-indent-9 {
counter-increment: list-9;
}
.ql-editor ol li.ql-indent-9:before {
content: counter(list-9, decimal) '. ';
}
.ql-editor .ql-indent-1:not(.ql-direction-rtl) {
padding-left: 3em;
}
.ql-editor li.ql-indent-1:not(.ql-direction-rtl) {
padding-left: 4.5em;
}
.ql-editor .ql-indent-1.ql-direction-rtl.ql-align-right {
padding-right: 3em;
}
.ql-editor li.ql-indent-1.ql-direction-rtl.ql-align-right {
padding-right: 4.5em;
}
.ql-editor .ql-indent-2:not(.ql-direction-rtl) {
padding-left: 6em;
}
.ql-editor li.ql-indent-2:not(.ql-direction-rtl) {
padding-left: 7.5em;
}
.ql-editor .ql-indent-2.ql-direction-rtl.ql-align-right {
padding-right: 6em;
}
.ql-editor li.ql-indent-2.ql-direction-rtl.ql-align-right {
padding-right: 7.5em;
}
.ql-editor .ql-indent-3:not(.ql-direction-rtl) {
padding-left: 9em;
}
.ql-editor li.ql-indent-3:not(.ql-direction-rtl) {
padding-left: 10.5em;
}
.ql-editor .ql-indent-3.ql-direction-rtl.ql-align-right {
padding-right: 9em;
}
.ql-editor li.ql-indent-3.ql-direction-rtl.ql-align-right {
padding-right: 10.5em;
}
.ql-editor .ql-indent-4:not(.ql-direction-rtl) {
padding-left: 12em;
}
.ql-editor li.ql-indent-4:not(.ql-direction-rtl) {
padding-left: 13.5em;
}
.ql-editor .ql-indent-4.ql-direction-rtl.ql-align-right {
padding-right: 12em;
}
.ql-editor li.ql-indent-4.ql-direction-rtl.ql-align-right {
padding-right: 13.5em;
}
.ql-editor .ql-indent-5:not(.ql-direction-rtl) {
padding-left: 15em;
}
.ql-editor li.ql-indent-5:not(.ql-direction-rtl) {
padding-left: 16.5em;
}
.ql-editor .ql-indent-5.ql-direction-rtl.ql-align-right {
padding-right: 15em;
}
.ql-editor li.ql-indent-5.ql-direction-rtl.ql-align-right {
padding-right: 16.5em;
}
.ql-editor .ql-indent-6:not(.ql-direction-rtl) {
padding-left: 18em;
}
.ql-editor li.ql-indent-6:not(.ql-direction-rtl) {
padding-left: 19.5em;
}
.ql-editor .ql-indent-6.ql-direction-rtl.ql-align-right {
padding-right: 18em;
}
.ql-editor li.ql-indent-6.ql-direction-rtl.ql-align-right {
padding-right: 19.5em;
}
.ql-editor .ql-indent-7:not(.ql-direction-rtl) {
padding-left: 21em;
}
.ql-editor li.ql-indent-7:not(.ql-direction-rtl) {
padding-left: 22.5em;
}
.ql-editor .ql-indent-7.ql-direction-rtl.ql-align-right {
padding-right: 21em;
}
.ql-editor li.ql-indent-7.ql-direction-rtl.ql-align-right {
padding-right: 22.5em;
}
.ql-editor .ql-indent-8:not(.ql-direction-rtl) {
padding-left: 24em;
}
.ql-editor li.ql-indent-8:not(.ql-direction-rtl) {
padding-left: 25.5em;
}
.ql-editor .ql-indent-8.ql-direction-rtl.ql-align-right {
padding-right: 24em;
}
.ql-editor li.ql-indent-8.ql-direction-rtl.ql-align-right {
padding-right: 25.5em;
}
.ql-editor .ql-indent-9:not(.ql-direction-rtl) {
padding-left: 27em;
}
.ql-editor li.ql-indent-9:not(.ql-direction-rtl) {
padding-left: 28.5em;
}
.ql-editor .ql-indent-9.ql-direction-rtl.ql-align-right {
padding-right: 27em;
}
.ql-editor li.ql-indent-9.ql-direction-rtl.ql-align-right {
padding-right: 28.5em;
}
.ql-editor .ql-video {
display: block;
max-width: 100%;
}
.ql-editor .ql-video.ql-align-center {
margin: 0 auto;
}
.ql-editor .ql-video.ql-align-right {
margin: 0 0 0 auto;
}
.ql-editor .ql-bg-black {
background-color: #000;
}
.ql-editor .ql-bg-red {
background-color: #e60000;
}
.ql-editor .ql-bg-orange {
background-color: #f90;
}
.ql-editor .ql-bg-yellow {
background-color: #ff0;
}
.ql-editor .ql-bg-green {
background-color: #008a00;
}
.ql-editor .ql-bg-blue {
background-color: #06c;
}
.ql-editor .ql-bg-purple {
background-color: #93f;
}
.ql-editor .ql-color-white {
color: #fff;
}
.ql-editor .ql-color-red {
color: #e60000;
}
.ql-editor .ql-color-orange {
color: #f90;
}
.ql-editor .ql-color-yellow {
color: #ff0;
}
.ql-editor .ql-color-green {
color: #008a00;
}
.ql-editor .ql-color-blue {
color: #06c;
}
.ql-editor .ql-color-purple {
color: #93f;
}
.ql-editor .ql-font-serif {
font-family: Georgia, Times New Roman, serif;
}
.ql-editor .ql-font-monospace {
font-family: Monaco, Courier New, monospace;
}
.ql-editor .ql-size-small {
font-size: 0.75em;
}
.ql-editor .ql-size-large {
font-size: 1.5em;
}
.ql-editor .ql-size-huge {
font-size: 2.5em;
}
.ql-editor .ql-direction-rtl {
direction: rtl;
text-align: inherit;
}
.ql-editor .ql-align-center {
text-align: center;
}
.ql-editor .ql-align-justify {
text-align: justify;
}
.ql-editor .ql-align-right {
text-align: right;
}
.ql-editor.ql-blank::before {
color: rgba(0,0,0,0.6);
content: attr(data-placeholder);
font-style: italic;
left: 15px;
pointer-events: none;
position: absolute;
right: 15px;
}
.ql-bubble.ql-toolbar:after,
.ql-bubble .ql-toolbar:after {
clear: both;
content: '';
display: table;
}
.ql-bubble.ql-toolbar button,
.ql-bubble .ql-toolbar button {
background: none;
border: none;
cursor: pointer;
display: inline-block;
float: left;
height: 24px;
padding: 3px 5px;
width: 28px;
}
.ql-bubble.ql-toolbar button svg,
.ql-bubble .ql-toolbar button svg {
float: left;
height: 100%;
}
.ql-bubble.ql-toolbar button:active:hover,
.ql-bubble .ql-toolbar button:active:hover {
outline: none;
}
.ql-bubble.ql-toolbar input.ql-image[type=file],
.ql-bubble .ql-toolbar input.ql-image[type=file] {
display: none;
}
.ql-bubble.ql-toolbar button:hover,
.ql-bubble .ql-toolbar button:hover,
.ql-bubble.ql-toolbar button:focus,
.ql-bubble .ql-toolbar button:focus,
.ql-bubble.ql-toolbar button.ql-active,
.ql-bubble .ql-toolbar button.ql-active,
.ql-bubble.ql-toolbar .ql-picker-label:hover,
.ql-bubble .ql-toolbar .ql-picker-label:hover,
.ql-bubble.ql-toolbar .ql-picker-label.ql-active,
.ql-bubble .ql-toolbar .ql-picker-label.ql-active,
.ql-bubble.ql-toolbar .ql-picker-item:hover,
.ql-bubble .ql-toolbar .ql-picker-item:hover,
.ql-bubble.ql-toolbar .ql-picker-item.ql-selected,
.ql-bubble .ql-toolbar .ql-picker-item.ql-selected {
color: #fff;
}
.ql-bubble.ql-toolbar button:hover .ql-fill,
.ql-bubble .ql-toolbar button:hover .ql-fill,
.ql-bubble.ql-toolbar button:focus .ql-fill,
.ql-bubble .ql-toolbar button:focus .ql-fill,
.ql-bubble.ql-toolbar button.ql-active .ql-fill,
.ql-bubble .ql-toolbar button.ql-active .ql-fill,
.ql-bubble.ql-toolbar .ql-picker-label:hover .ql-fill,
.ql-bubble .ql-toolbar .ql-picker-label:hover .ql-fill,
.ql-bubble.ql-toolbar .ql-picker-label.ql-active .ql-fill,
.ql-bubble .ql-toolbar .ql-picker-label.ql-active .ql-fill,
.ql-bubble.ql-toolbar .ql-picker-item:hover .ql-fill,
.ql-bubble .ql-toolbar .ql-picker-item:hover .ql-fill,
.ql-bubble.ql-toolbar .ql-picker-item.ql-selected .ql-fill,
.ql-bubble .ql-toolbar .ql-picker-item.ql-selected .ql-fill,
.ql-bubble.ql-toolbar button:hover .ql-stroke.ql-fill,
.ql-bubble .ql-toolbar button:hover .ql-stroke.ql-fill,
.ql-bubble.ql-toolbar button:focus .ql-stroke.ql-fill,
.ql-bubble .ql-toolbar button:focus .ql-stroke.ql-fill,
.ql-bubble.ql-toolbar button.ql-active .ql-stroke.ql-fill,
.ql-bubble .ql-toolbar button.ql-active .ql-stroke.ql-fill,
.ql-bubble.ql-toolbar .ql-picker-label:hover .ql-stroke.ql-fill,
.ql-bubble .ql-toolbar .ql-picker-label:hover .ql-stroke.ql-fill,
.ql-bubble.ql-toolbar .ql-picker-label.ql-active .ql-stroke.ql-fill,
.ql-bubble .ql-toolbar .ql-picker-label.ql-active .ql-stroke.ql-fill,
.ql-bubble.ql-toolbar .ql-picker-item:hover .ql-stroke.ql-fill,
.ql-bubble .ql-toolbar .ql-picker-item:hover .ql-stroke.ql-fill,
.ql-bubble.ql-toolbar .ql-picker-item.ql-selected .ql-stroke.ql-fill,
.ql-bubble .ql-toolbar .ql-picker-item.ql-selected .ql-stroke.ql-fill {
fill: #fff;
}
.ql-bubble.ql-toolbar button:hover .ql-stroke,
.ql-bubble .ql-toolbar button:hover .ql-stroke,
.ql-bubble.ql-toolbar button:focus .ql-stroke,
.ql-bubble .ql-toolbar button:focus .ql-stroke,
.ql-bubble.ql-toolbar button.ql-active .ql-stroke,
.ql-bubble .ql-toolbar button.ql-active .ql-stroke,
.ql-bubble.ql-toolbar .ql-picker-label:hover .ql-stroke,
.ql-bubble .ql-toolbar .ql-picker-label:hover .ql-stroke,
.ql-bubble.ql-toolbar .ql-picker-label.ql-active .ql-stroke,
.ql-bubble .ql-toolbar .ql-picker-label.ql-active .ql-stroke,
.ql-bubble.ql-toolbar .ql-picker-item:hover .ql-stroke,
.ql-bubble .ql-toolbar .ql-picker-item:hover .ql-stroke,
.ql-bubble.ql-toolbar .ql-picker-item.ql-selected .ql-stroke,
.ql-bubble .ql-toolbar .ql-picker-item.ql-selected .ql-stroke,
.ql-bubble.ql-toolbar button:hover .ql-stroke-miter,
.ql-bubble .ql-toolbar button:hover .ql-stroke-miter,
.ql-bubble.ql-toolbar button:focus .ql-stroke-miter,
.ql-bubble .ql-toolbar button:focus .ql-stroke-miter,
.ql-bubble.ql-toolbar button.ql-active .ql-stroke-miter,
.ql-bubble .ql-toolbar button.ql-active .ql-stroke-miter,
.ql-bubble.ql-toolbar .ql-picker-label:hover .ql-stroke-miter,
.ql-bubble .ql-toolbar .ql-picker-label:hover .ql-stroke-miter,
.ql-bubble.ql-toolbar .ql-picker-label.ql-active .ql-stroke-miter,
.ql-bubble .ql-toolbar .ql-picker-label.ql-active .ql-stroke-miter,
.ql-bubble.ql-toolbar .ql-picker-item:hover .ql-stroke-miter,
.ql-bubble .ql-toolbar .ql-picker-item:hover .ql-stroke-miter,
.ql-bubble.ql-toolbar .ql-picker-item.ql-selected .ql-stroke-miter,
.ql-bubble .ql-toolbar .ql-picker-item.ql-selected .ql-stroke-miter {
stroke: #fff;
}
@media (pointer: coarse) {
.ql-bubble.ql-toolbar button:hover:not(.ql-active),
.ql-bubble .ql-toolbar button:hover:not(.ql-active) {
color: #ccc;
}
.ql-bubble.ql-toolbar button:hover:not(.ql-active) .ql-fill,
.ql-bubble .ql-toolbar button:hover:not(.ql-active) .ql-fill,
.ql-bubble.ql-toolbar button:hover:not(.ql-active) .ql-stroke.ql-fill,
.ql-bubble .ql-toolbar button:hover:not(.ql-active) .ql-stroke.ql-fill {
fill: #ccc;
}
.ql-bubble.ql-toolbar button:hover:not(.ql-active) .ql-stroke,
.ql-bubble .ql-toolbar button:hover:not(.ql-active) .ql-stroke,
.ql-bubble.ql-toolbar button:hover:not(.ql-active) .ql-stroke-miter,
.ql-bubble .ql-toolbar button:hover:not(.ql-active) .ql-stroke-miter {
stroke: #ccc;
}
}
.ql-bubble {
box-sizing: border-box;
}
.ql-bubble * {
box-sizing: border-box;
}
.ql-bubble .ql-hidden {
display: none;
}
.ql-bubble .ql-out-bottom,
.ql-bubble .ql-out-top {
visibility: hidden;
}
.ql-bubble .ql-tooltip {
position: absolute;
transform: translateY(10px);
}
.ql-bubble .ql-tooltip a {
cursor: pointer;
text-decoration: none;
}
.ql-bubble .ql-tooltip.ql-flip {
transform: translateY(-10px);
}
.ql-bubble .ql-formats {
display: inline-block;
vertical-align: middle;
}
.ql-bubble .ql-formats:after {
clear: both;
content: '';
display: table;
}
.ql-bubble .ql-stroke {
fill: none;
stroke: #ccc;
stroke-linecap: round;
stroke-linejoin: round;
stroke-width: 2;
}
.ql-bubble .ql-stroke-miter {
fill: none;
stroke: #ccc;
stroke-miterlimit: 10;
stroke-width: 2;
}
.ql-bubble .ql-fill,
.ql-bubble .ql-stroke.ql-fill {
fill: #ccc;
}
.ql-bubble .ql-empty {
fill: none;
}
.ql-bubble .ql-even {
fill-rule: evenodd;
}
.ql-bubble .ql-thin,
.ql-bubble .ql-stroke.ql-thin {
stroke-width: 1;
}
.ql-bubble .ql-transparent {
opacity: 0.4;
}
.ql-bubble .ql-direction svg:last-child {
display: none;
}
.ql-bubble .ql-direction.ql-active svg:last-child {
display: inline;
}
.ql-bubble .ql-direction.ql-active svg:first-child {
display: none;
}
.ql-bubble .ql-editor h1 {
font-size: 2em;
}
.ql-bubble .ql-editor h2 {
font-size: 1.5em;
}
.ql-bubble .ql-editor h3 {
font-size: 1.17em;
}
.ql-bubble .ql-editor h4 {
font-size: 1em;
}
.ql-bubble .ql-editor h5 {
font-size: 0.83em;
}
.ql-bubble .ql-editor h6 {
font-size: 0.67em;
}
.ql-bubble .ql-editor a {
text-decoration: underline;
}
.ql-bubble .ql-editor blockquote {
border-left: 4px solid #ccc;
margin-bottom: 5px;
margin-top: 5px;
padding-left: 16px;
}
.ql-bubble .ql-editor code,
.ql-bubble .ql-editor pre {
background-color: #f0f0f0;
border-radius: 3px;
}
.ql-bubble .ql-editor pre {
white-space: pre-wrap;
margin-bottom: 5px;
margin-top: 5px;
padding: 5px 10px;
}
.ql-bubble .ql-editor code {
font-size: 85%;
padding: 2px 4px;
}
.ql-bubble .ql-editor pre.ql-syntax {
background-color: #23241f;
color: #f8f8f2;
overflow: visible;
}
.ql-bubble .ql-editor img {
max-width: 100%;
}
.ql-bubble .ql-picker {
color: #ccc;
display: inline-block;
float: left;
font-size: 14px;
font-weight: 500;
height: 24px;
position: relative;
vertical-align: middle;
}
.ql-bubble .ql-picker-label {
cursor: pointer;
display: inline-block;
height: 100%;
padding-left: 8px;
padding-right: 2px;
position: relative;
width: 100%;
}
.ql-bubble .ql-picker-label::before {
display: inline-block;
line-height: 22px;
}
.ql-bubble .ql-picker-options {
background-color: #444;
display: none;
min-width: 100%;
padding: 4px 8px;
position: absolute;
white-space: nowrap;
}
.ql-bubble .ql-picker-options .ql-picker-item {
cursor: pointer;
display: block;
padding-bottom: 5px;
padding-top: 5px;
}
.ql-bubble .ql-picker.ql-expanded .ql-picker-label {
color: #777;
z-index: 2;
}
.ql-bubble .ql-picker.ql-expanded .ql-picker-label .ql-fill {
fill: #777;
}
.ql-bubble .ql-picker.ql-expanded .ql-picker-label .ql-stroke {
stroke: #777;
}
.ql-bubble .ql-picker.ql-expanded .ql-picker-options {
display: block;
margin-top: -1px;
top: 100%;
z-index: 1;
}
.ql-bubble .ql-color-picker,
.ql-bubble .ql-icon-picker {
width: 28px;
}
.ql-bubble .ql-color-picker .ql-picker-label,
.ql-bubble .ql-icon-picker .ql-picker-label {
padding: 2px 4px;
}
.ql-bubble .ql-color-picker .ql-picker-label svg,
.ql-bubble .ql-icon-picker .ql-picker-label svg {
right: 4px;
}
.ql-bubble .ql-icon-picker .ql-picker-options {
padding: 4px 0px;
}
.ql-bubble .ql-icon-picker .ql-picker-item {
height: 24px;
width: 24px;
padding: 2px 4px;
}
.ql-bubble .ql-color-picker .ql-picker-options {
padding: 3px 5px;
width: 152px;
}
.ql-bubble .ql-color-picker .ql-picker-item {
border: 1px solid transparent;
float: left;
height: 16px;
margin: 2px;
padding: 0px;
width: 16px;
}
.ql-bubble .ql-picker:not(.ql-color-picker):not(.ql-icon-picker) svg {
position: absolute;
margin-top: -9px;
right: 0;
top: 50%;
width: 18px;
}
.ql-bubble .ql-picker.ql-header .ql-picker-label[data-label]:not([data-label=''])::before,
.ql-bubble .ql-picker.ql-font .ql-picker-label[data-label]:not([data-label=''])::before,
.ql-bubble .ql-picker.ql-size .ql-picker-label[data-label]:not([data-label=''])::before,
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-label]:not([data-label=''])::before,
.ql-bubble .ql-picker.ql-font .ql-picker-item[data-label]:not([data-label=''])::before,
.ql-bubble .ql-picker.ql-size .ql-picker-item[data-label]:not([data-label=''])::before {
content: attr(data-label);
}
.ql-bubble .ql-picker.ql-header {
width: 98px;
}
.ql-bubble .ql-picker.ql-header .ql-picker-label::before,
.ql-bubble .ql-picker.ql-header .ql-picker-item::before {
content: 'Normal';
}
.ql-bubble .ql-picker.ql-header .ql-picker-label[data-value="1"]::before,
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="1"]::before {
content: 'Heading 1';
}
.ql-bubble .ql-picker.ql-header .ql-picker-label[data-value="2"]::before,
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="2"]::before {
content: 'Heading 2';
}
.ql-bubble .ql-picker.ql-header .ql-picker-label[data-value="3"]::before,
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="3"]::before {
content: 'Heading 3';
}
.ql-bubble .ql-picker.ql-header .ql-picker-label[data-value="4"]::before,
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="4"]::before {
content: 'Heading 4';
}
.ql-bubble .ql-picker.ql-header .ql-picker-label[data-value="5"]::before,
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="5"]::before {
content: 'Heading 5';
}
.ql-bubble .ql-picker.ql-header .ql-picker-label[data-value="6"]::before,
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="6"]::before {
content: 'Heading 6';
}
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="1"]::before {
font-size: 2em;
}
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="2"]::before {
font-size: 1.5em;
}
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="3"]::before {
font-size: 1.17em;
}
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="4"]::before {
font-size: 1em;
}
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="5"]::before {
font-size: 0.83em;
}
.ql-bubble .ql-picker.ql-header .ql-picker-item[data-value="6"]::before {
font-size: 0.67em;
}
.ql-bubble .ql-picker.ql-font {
width: 108px;
}
.ql-bubble .ql-picker.ql-font .ql-picker-label::before,
.ql-bubble .ql-picker.ql-font .ql-picker-item::before {
content: 'Sans Serif';
}
.ql-bubble .ql-picker.ql-font .ql-picker-label[data-value=serif]::before,
.ql-bubble .ql-picker.ql-font .ql-picker-item[data-value=serif]::before {
content: 'Serif';
}
.ql-bubble .ql-picker.ql-font .ql-picker-label[data-value=monospace]::before,
.ql-bubble .ql-picker.ql-font .ql-picker-item[data-value=monospace]::before {
content: 'Monospace';
}
.ql-bubble .ql-picker.ql-font .ql-picker-item[data-value=serif]::before {
font-family: Georgia, Times New Roman, serif;
}
.ql-bubble .ql-picker.ql-font .ql-picker-item[data-value=monospace]::before {
font-family: Monaco, Courier New, monospace;
}
.ql-bubble .ql-picker.ql-size {
width: 98px;
}
.ql-bubble .ql-picker.ql-size .ql-picker-label::before,
.ql-bubble .ql-picker.ql-size .ql-picker-item::before {
content: 'Normal';
}
.ql-bubble .ql-picker.ql-size .ql-picker-label[data-value=small]::before,
.ql-bubble .ql-picker.ql-size .ql-picker-item[data-value=small]::before {
content: 'Small';
}
.ql-bubble .ql-picker.ql-size .ql-picker-label[data-value=large]::before,
.ql-bubble .ql-picker.ql-size .ql-picker-item[data-value=large]::before {
content: 'Large';
}
.ql-bubble .ql-picker.ql-size .ql-picker-label[data-value=huge]::before,
.ql-bubble .ql-picker.ql-size .ql-picker-item[data-value=huge]::before {
content: 'Huge';
}
.ql-bubble .ql-picker.ql-size .ql-picker-item[data-value=small]::before {
font-size: 10px;
}
.ql-bubble .ql-picker.ql-size .ql-picker-item[data-value=large]::before {
font-size: 18px;
}
.ql-bubble .ql-picker.ql-size .ql-picker-item[data-value=huge]::before {
font-size: 32px;
}
.ql-bubble .ql-color-picker.ql-background .ql-picker-item {
background-color: #fff;
}
.ql-bubble .ql-color-picker.ql-color .ql-picker-item {
background-color: #000;
}
.ql-bubble .ql-toolbar .ql-formats {
margin: 8px 12px 8px 0px;
}
.ql-bubble .ql-toolbar .ql-formats:first-child {
margin-left: 12px;
}
.ql-bubble .ql-color-picker svg {
margin: 1px;
}
.ql-bubble .ql-color-picker .ql-picker-item.ql-selected,
.ql-bubble .ql-color-picker .ql-picker-item:hover {
border-color: #fff;
}
.ql-bubble .ql-tooltip {
background-color: #444;
border-radius: 25px;
color: #fff;
}
.ql-bubble .ql-tooltip-arrow {
border-left: 6px solid transparent;
border-right: 6px solid transparent;
content: " ";
display: block;
left: 50%;
margin-left: -6px;
position: absolute;
}
.ql-bubble .ql-tooltip:not(.ql-flip) .ql-tooltip-arrow {
border-bottom: 6px solid #444;
top: -6px;
}
.ql-bubble .ql-tooltip.ql-flip .ql-tooltip-arrow {
border-top: 6px solid #444;
bottom: -6px;
}
.ql-bubble .ql-tooltip.ql-editing .ql-tooltip-editor {
display: block;
}
.ql-bubble .ql-tooltip.ql-editing .ql-formats {
visibility: hidden;
}
.ql-bubble .ql-tooltip-editor {
display: none;
}
.ql-bubble .ql-tooltip-editor input[type=text] {
background: transparent;
border: none;
color: #fff;
font-size: 13px;
height: 100%;
outline: none;
padding: 10px 20px;
position: absolute;
width: 100%;
}
.ql-bubble .ql-tooltip-editor a {
top: 10px;
position: absolute;
right: 20px;
}
.ql-bubble .ql-tooltip-editor a:before {
color: #ccc;
content: "\D7";
font-size: 16px;
font-weight: bold;
}
.ql-container.ql-bubble:not(.ql-disabled) a {
position: relative;
white-space: nowrap;
}
.ql-container.ql-bubble:not(.ql-disabled) a::before {
background-color: #444;
border-radius: 15px;
top: -5px;
font-size: 12px;
color: #fff;
content: attr(href);
font-weight: normal;
overflow: hidden;
padding: 5px 15px;
text-decoration: none;
z-index: 1;
}
.ql-container.ql-bubble:not(.ql-disabled) a::after {
border-top: 6px solid #444;
border-left: 6px solid transparent;
border-right: 6px solid transparent;
top: 0;
content: " ";
height: 0;
width: 0;
}
.ql-container.ql-bubble:not(.ql-disabled) a::before,
.ql-container.ql-bubble:not(.ql-disabled) a::after {
left: 0;
margin-left: 50%;
position: absolute;
transform: translate(-50%, -100%);
transition: visibility 0s ease 200ms;
visibility: hidden;
}
.ql-container.ql-bubble:not(.ql-disabled) a:hover::before,
.ql-container.ql-bubble:not(.ql-disabled) a:hover::after {
visibility: visible;
}
================================================
FILE: assets/vendor/quill/quill.js
================================================
/*! For license information please see quill.js.LICENSE.txt */
!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.Quill=e():t.Quill=e()}(self,(function(){return function(){var t={9698:function(t,e,n){"use strict";n.d(e,{Ay:function(){return c},Ji:function(){return d},mG:function(){return h},zo:function(){return u}});var r=n(6003),i=n(5232),s=n.n(i),o=n(3036),l=n(4850),a=n(5508);class c extends r.BlockBlot{cache={};delta(){return null==this.cache.delta&&(this.cache.delta=h(this)),this.cache.delta}deleteAt(t,e){super.deleteAt(t,e),this.cache={}}formatAt(t,e,n,i){e<=0||(this.scroll.query(n,r.Scope.BLOCK)?t+e===this.length()&&this.format(n,i):super.formatAt(t,Math.min(e,this.length()-t-1),n,i),this.cache={})}insertAt(t,e,n){if(null!=n)return super.insertAt(t,e,n),void(this.cache={});if(0===e.length)return;const r=e.split("\n"),i=r.shift();i.length>0&&(t<this.length()-1||null==this.children.tail?super.insertAt(Math.min(t,this.length()-1),i):this.children.tail.insertAt(this.children.tail.length(),i),this.cache={});let s=this;r.reduce(((t,e)=>(s=s.split(t,!0),s.insertAt(0,e),e.length)),t+i.length)}insertBefore(t,e){const{head:n}=this.children;super.insertBefore(t,e),n instanceof o.A&&n.remove(),this.cache={}}length(){return null==this.cache.length&&(this.cache.length=super.length()+1),this.cache.length}moveChildren(t,e){super.moveChildren(t,e),this.cache={}}optimize(t){super.optimize(t),this.cache={}}path(t){return super.path(t,!0)}removeChild(t){super.removeChild(t),this.cache={}}split(t){let e=arguments.length>1&&void 0!==arguments[1]&&arguments[1];if(e&&(0===t||t>=this.length()-1)){const e=this.clone();return 0===t?(this.parent.insertBefore(e,this),this):(this.parent.insertBefore(e,this.next),e)}const n=super.split(t,e);return this.cache={},n}}c.blotName="block",c.tagName="P",c.defaultChild=o.A,c.allowedChildren=[o.A,l.A,r.EmbedBlot,a.A];class u extends r.EmbedBlot{attach(){super.attach(),this.attributes=new r.AttributorStore(this.domNode)}delta(){return(new(s())).insert(this.value(),{...this.formats(),...this.attributes.values()})}format(t,e){const n=this.scroll.query(t,r.Scope.BLOCK_ATTRIBUTE);null!=n&&this.attributes.attribute(n,e)}formatAt(t,e,n,r){this.format(n,r)}insertAt(t,e,n){if(null!=n)return void super.insertAt(t,e,n);const r=e.split("\n"),i=r.pop(),s=r.map((t=>{const e=this.scroll.create(c.blotName);return e.insertAt(0,t),e})),o=this.split(t);s.forEach((t=>{this.parent.insertBefore(t,o)})),i&&this.parent.insertBefore(this.scroll.create("text",i),o)}}function h(t){let e=!(arguments.length>1&&void 0!==arguments[1])||arguments[1];return t.descendants(r.LeafBlot).reduce(((t,n)=>0===n.length()?t:t.insert(n.value(),d(n,{},e))),new(s())).insert("\n",d(t))}function d(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=!(arguments.length>2&&void 0!==arguments[2])||arguments[2];return null==t?e:("formats"in t&&"function"==typeof t.formats&&(e={...e,...t.formats()},n&&delete e["code-token"]),null==t.parent||"scroll"===t.parent.statics.blotName||t.parent.statics.scope!==t.statics.scope?e:d(t.parent,e,n))}u.scope=r.Scope.BLOCK_BLOT},3036:function(t,e,n){"use strict";var r=n(6003);class i extends r.EmbedBlot{static value(){}optimize(){(this.prev||this.next)&&this.remove()}length(){return 0}value(){return""}}i.blotName="break",i.tagName="BR",e.A=i},580:function(t,e,n){"use strict";var r=n(6003);class i extends r.ContainerBlot{}e.A=i},4541:function(t,e,n){"use strict";var r=n(6003),i=n(5508);class s extends r.EmbedBlot{static blotName="cursor";static className="ql-cursor";static tagName="span";static CONTENTS="\ufeff";static value(){}constructor(t,e,n){super(t,e),this.selection=n,this.textNode=document.createTextNode(s.CONTENTS),this.domNode.appendChild(this.textNode),this.savedLength=0}detach(){null!=this.parent&&this.parent.removeChild(this)}format(t,e){if(0!==this.savedLength)return void super.format(t,e);let n=this,i=0;for(;null!=n&&n.statics.scope!==r.Scope.BLOCK_BLOT;)i+=n.offset(n.parent),n=n.parent;null!=n&&(this.savedLength=s.CONTENTS.length,n.optimize(),n.formatAt(i,s.CONTENTS.length,t,e),this.savedLength=0)}index(t,e){return t===this.textNode?0:super.index(t,e)}length(){return this.savedLength}position(){return[this.textNode,this.textNode.data.length]}remove(){super.remove(),this.parent=null}restore(){if(this.selection.composing||null==this.parent)return null;const t=this.selection.getNativeRange();for(;null!=this.domNode.lastChild&&this.domNode.lastChild!==this.textNode;)this.domNode.parentNode.insertBefore(this.domNode.lastChild,this.domNode);const e=this.prev instanceof i.A?this.prev:null,n=e?e.length():0,r=this.next instanceof i.A?this.next:null,o=r?r.text:"",{textNode:l}=this,a=l.data.split(s.CONTENTS).join("");let c;if(l.data=s.CONTENTS,e)c=e,(a||r)&&(e.insertAt(e.length(),a+o),r&&r.remove());else if(r)c=r,r.insertAt(0,a);else{const t=document.createTextNode(a);c=this.scroll.create(t),this.parent.insertBefore(c,this)}if(this.remove(),t){const i=(t,i)=>e&&t===e.domNode?i:t===l?n+i-1:r&&t===r.domNode?n+a.length+i:null,s=i(t.start.node,t.start.offset),o=i(t.end.node,t.end.offset);if(null!==s&&null!==o)return{startNode:c.domNode,startOffset:s,endNode:c.domNode,endOffset:o}}return null}update(t,e){if(t.some((t=>"characterData"===t.type&&t.target===this.textNode))){const t=this.restore();t&&(e.range=t)}}optimize(t){super.optimize(t);let{parent:e}=this;for(;e;){if("A"===e.domNode.tagName){this.savedLength=s.CONTENTS.length,e.isolate(this.offset(e),this.length()).unwrap(),this.savedLength=0;break}e=e.parent}}value(){return""}}e.A=s},746:function(t,e,n){"use strict";var r=n(6003),i=n(5508);const s="\ufeff";class o extends r.EmbedBlot{constructor(t,e){super(t,e),this.contentNode=document.createElement("span"),this.contentNode.setAttribute("contenteditable","false"),Array.from(this.domNode.childNodes).forEach((t=>{this.contentNode.appendChild(t)})),this.leftGuard=document.createTextNode(s),this.rightGuard=document.createTextNode(s),this.domNode.appendChild(this.leftGuard),this.domNode.appendChild(this.contentNode),this.domNode.appendChild(this.rightGuard)}index(t,e){return t===this.leftGuard?0:t===this.rightGuard?1:super.index(t,e)}restore(t){let e,n=null;const r=t.data.split(s).join("");if(t===this.leftGuard)if(this.prev instanceof i.A){const t=this.prev.length();this.prev.insertAt(t,r),n={startNode:this.prev.domNode,startOffset:t+r.length}}else e=document.createTextNode(r),this.parent.insertBefore(this.scroll.create(e),this),n={startNode:e,startOffset:r.length};else t===this.rightGuard&&(this.next instanceof i.A?(this.next.insertAt(0,r),n={startNode:this.next.domNode,startOffset:r.length}):(e=document.createTextNode(r),this.parent.insertBefore(this.scroll.create(e),this.next),n={startNode:e,startOffset:r.length}));return t.data=s,n}update(t,e){t.forEach((t=>{if("characterData"===t.type&&(t.target===this.leftGuard||t.target===this.rightGuard)){const n=this.restore(t.target);n&&(e.range=n)}}))}}e.A=o},4850:function(t,e,n){"use strict";var r=n(6003),i=n(3036),s=n(5508);class o extends r.InlineBlot{static allowedChildren=[o,i.A,r.EmbedBlot,s.A];static order=["cursor","inline","link","underline","strike","italic","bold","script","code"];static compare(t,e){const n=o.order.indexOf(t),r=o.order.indexOf(e);return n>=0||r>=0?n-r:t===e?0:t<e?-1:1}formatAt(t,e,n,i){if(o.compare(this.statics.blotName,n)<0&&this.scroll.query(n,r.Scope.BLOT)){const r=this.isolate(t,e);i&&r.wrap(n,i)}else super.formatAt(t,e,n,i)}optimize(t){if(super.optimize(t),this.parent instanceof o&&o.compare(this.statics.blotName,this.parent.statics.blotName)>0){const t=this.parent.isolate(this.offset(),this.length());this.moveChildren(t),t.wrap(this)}}}e.A=o},5508:function(t,e,n){"use strict";n.d(e,{A:function(){return i},X:function(){return s}});var r=n(6003);class i extends r.TextBlot{}function s(t){return t.replace(/[&<>"']/g,(t=>({"&":"&","<":"<",">":">",'"':""","'":"'"}[t])))}},3729:function(t,e,n){"use strict";n.d(e,{default:function(){return R}});var r=n(6142),i=n(9698),s=n(3036),o=n(580),l=n(4541),a=n(746),c=n(4850),u=n(6003),h=n(5232),d=n.n(h),f=n(5374);function p(t){return t instanceof i.Ay||t instanceof i.zo}function g(t){return"function"==typeof t.updateContent}class m extends u.ScrollBlot{static blotName="scroll";static className="ql-editor";static tagName="DIV";static defaultChild=i.Ay;static allowedChildren=[i.Ay,i.zo,o.A];constructor(t,e,n){let{emitter:r}=n;super(t,e),this.emitter=r,this.batch=!1,this.optimize(),this.enable(),this.domNode.addEventListener("dragstart",(t=>this.handleDragStart(t)))}batchStart(){Array.isArray(this.batch)||(this.batch=[])}batchEnd(){if(!this.batch)return;const t=this.batch;this.batch=!1,this.update(t)}emitMount(t){this.emitter.emit(f.A.events.SCROLL_BLOT_MOUNT,t)}emitUnmount(t){this.emitter.emit(f.A.events.SCROLL_BLOT_UNMOUNT,t)}emitEmbedUpdate(t,e){this.emitter.emit(f.A.events.SCROLL_EMBED_UPDATE,t,e)}deleteAt(t,e){const[n,r]=this.line(t),[o]=this.line(t+e);if(super.deleteAt(t,e),null!=o&&n!==o&&r>0){if(n instanceof i.zo||o instanceof i.zo)return void this.optimize();const t=o.children.head instanceof s.A?null:o.children.head;n.moveChildren(o,t),n.remove()}this.optimize()}enable(){let t=!(arguments.length>0&&void 0!==arguments[0])||arguments[0];this.domNode.setAttribute("contenteditable",t?"true":"false")}formatAt(t,e,n,r){super.formatAt(t,e,n,r),this.optimize()}insertAt(t,e,n){if(t>=this.length())if(null==n||null==this.scroll.query(e,u.Scope.BLOCK)){const t=this.scroll.create(this.statics.defaultChild.blotName);this.appendChild(t),null==n&&e.endsWith("\n")?t.insertAt(0,e.slice(0,-1),n):t.insertAt(0,e,n)}else{const t=this.scroll.create(e,n);this.appendChild(t)}else super.insertAt(t,e,n);this.optimize()}insertBefore(t,e){if(t.statics.scope===u.Scope.INLINE_BLOT){const n=this.scroll.create(this.statics.defaultChild.blotName);n.appendChild(t),super.insertBefore(n,e)}else super.insertBefore(t,e)}insertContents(t,e){const n=this.deltaToRenderBlocks(e.concat((new(d())).insert("\n"))),r=n.pop();if(null==r)return;this.batchStart();const s=n.shift();if(s){const e="block"===s.type&&(0===s.delta.length()||!this.descendant(i.zo,t)[0]&&t<this.length()),n="block"===s.type?s.delta:(new(d())).insert({[s.key]:s.value});b(this,t,n);const r="block"===s.type?1:0,o=t+n.length()+r;e&&this.insertAt(o-1,"\n");const l=(0,i.Ji)(this.line(t)[0]),a=h.AttributeMap.diff(l,s.attributes)||{};Object.keys(a).forEach((t=>{this.formatAt(o-1,1,t,a[t])})),t=o}let[o,l]=this.children.find(t);n.length&&(o&&(o=o.split(l),l=0),n.forEach((t=>{if("block"===t.type)b(this.createBlock(t.attributes,o||void 0),0,t.delta);else{const e=this.create(t.key,t.value);this.insertBefore(e,o||void 0),Object.keys(t.attributes).forEach((n=>{e.format(n,t.attributes[n])}))}}))),"block"===r.type&&r.delta.length()&&b(this,o?o.offset(o.scroll)+l:this.length(),r.delta),this.batchEnd(),this.optimize()}isEnabled(){return"true"===this.domNode.getAttribute("contenteditable")}leaf(t){const e=this.path(t).pop();if(!e)return[null,-1];const[n,r]=e;return n instanceof u.LeafBlot?[n,r]:[null,-1]}line(t){return t===this.length()?this.line(t-1):this.descendant(p,t)}lines(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:Number.MAX_VALUE;const n=(t,e,r)=>{let i=[],s=r;return t.children.forEachAt(e,r,((t,e,r)=>{p(t)?i.push(t):t instanceof u.ContainerBlot&&(i=i.concat(n(t,e,s))),s-=r})),i};return n(this,t,e)}optimize(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:[],e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};this.batch||(super.optimize(t,e),t.length>0&&this.emitter.emit(f.A.events.SCROLL_OPTIMIZE,t,e))}path(t){return super.path(t).slice(1)}remove(){}update(t){if(this.batch)return void(Array.isArray(t)&&(this.batch=this.batch.concat(t)));let e=f.A.sources.USER;"string"==typeof t&&(e=t),Array.isArray(t)||(t=this.observer.takeRecords()),(t=t.filter((t=>{let{target:e}=t;const n=this.find(e,!0);return n&&!g(n)}))).length>0&&this.emitter.emit(f.A.events.SCROLL_BEFORE_UPDATE,e,t),super.update(t.concat([])),t.length>0&&this.emitter.emit(f.A.events.SCROLL_UPDATE,e,t)}updateEmbedAt(t,e,n){const[r]=this.descendant((t=>t instanceof i.zo),t);r&&r.statics.blotName===e&&g(r)&&r.updateContent(n)}handleDragStart(t){t.preventDefault()}deltaToRenderBlocks(t){const e=[];let n=new(d());return t.forEach((t=>{const r=t?.insert;if(r)if("string"==typeof r){const i=r.split("\n");i.slice(0,-1).forEach((r=>{n.insert(r,t.attributes),e.push({type:"block",delta:n,attributes:t.attributes??{}}),n=new(d())}));const s=i[i.length-1];s&&n.insert(s,t.attributes)}else{const i=Object.keys(r)[0];if(!i)return;this.query(i,u.Scope.INLINE)?n.push(t):(n.length()&&e.push({type:"block",delta:n,attributes:{}}),n=new(d()),e.push({type:"blockEmbed",key:i,value:r[i],attributes:t.attributes??{}}))}})),n.length()&&e.push({type:"block",delta:n,attributes:{}}),e}createBlock(t,e){let n;const r={};Object.entries(t).forEach((t=>{let[e,i]=t;null!=this.query(e,u.Scope.BLOCK&u.Scope.BLOT)?n=e:r[e]=i}));const i=this.create(n||this.statics.defaultChild.blotName,n?t[n]:void 0);this.insertBefore(i,e||void 0);const s=i.length();return Object.entries(r).forEach((t=>{let[e,n]=t;i.formatAt(0,s,e,n)})),i}}function b(t,e,n){n.reduce(((e,n)=>{const r=h.Op.length(n);let s=n.attributes||{};if(null!=n.insert)if("string"==typeof n.insert){const r=n.insert;t.insertAt(e,r);const[o]=t.descendant(u.LeafBlot,e),l=(0,i.Ji)(o);s=h.AttributeMap.diff(l,s)||{}}else if("object"==typeof n.insert){const r=Object.keys(n.insert)[0];if(null==r)return e;if(t.insertAt(e,r,n.insert[r]),null!=t.scroll.query(r,u.Scope.INLINE)){const[n]=t.descendant(u.LeafBlot,e),r=(0,i.Ji)(n);s=h.AttributeMap.diff(r,s)||{}}}return Object.keys(s).forEach((n=>{t.formatAt(e,r,n,s[n])})),e+r}),e)}var y=m,v=n(5508),A=n(584),x=n(4266);class N extends x.A{static DEFAULTS={delay:1e3,maxStack:100,userOnly:!1};lastRecorded=0;ignoreChange=!1;stack={undo:[],redo:[]};currentRange=null;constructor(t,e){super(t,e),this.quill.on(r.Ay.events.EDITOR_CHANGE,((t,e,n,i)=>{t===r.Ay.events.SELECTION_CHANGE?e&&i!==r.Ay.sources.SILENT&&(this.currentRange=e):t===r.Ay.events.TEXT_CHANGE&&(this.ignoreChange||(this.options.userOnly&&i!==r.Ay.sources.USER?this.transform(e):this.record(e,n)),this.currentRange=w(this.currentRange,e))})),this.quill.keyboard.addBinding({key:"z",shortKey:!0},this.undo.bind(this)),this.quill.keyboard.addBinding({key:["z","Z"],shortKey:!0,shiftKey:!0},this.redo.bind(this)),/Win/i.test(navigator.platform)&&this.quill.keyboard.addBinding({key:"y",shortKey:!0},this.redo.bind(this)),this.quill.root.addEventListener("beforeinput",(t=>{"historyUndo"===t.inputType?(this.undo(),t.preventDefault()):"historyRedo"===t.inputType&&(this.redo(),t.preventDefault())}))}change(t,e){if(0===this.stack[t].length)return;const n=this.stack[t].pop();if(!n)return;const i=this.quill.getContents(),s=n.delta.invert(i);this.stack[e].push({delta:s,range:w(n.range,s)}),this.lastRecorded=0,this.ignoreChange=!0,this.quill.updateContents(n.delta,r.Ay.sources.USER),this.ignoreChange=!1,this.restoreSelection(n)}clear(){this.stack={undo:[],redo:[]}}cutoff(){this.lastRecorded=0}record(t,e){if(0===t.ops.length)return;this.stack.redo=[];let n=t.invert(e),r=this.currentRange;const i=Date.now();if(this.lastRecorded+this.options.delay>i&&this.stack.undo.length>0){const t=this.stack.undo.pop();t&&(n=n.compose(t.delta),r=t.range)}else this.lastRecorded=i;0!==n.length()&&(this.stack.undo.push({delta:n,range:r}),this.stack.undo.length>this.options.maxStack&&this.stack.undo.shift())}redo(){this.change("redo","undo")}transform(t){E(this.stack.undo,t),E(this.stack.redo,t)}undo(){this.change("undo","redo")}restoreSelection(t){if(t.range)this.quill.setSelection(t.range,r.Ay.sources.USER);else{const e=function(t,e){const n=e.reduce(((t,e)=>t+(e.delete||0)),0);let r=e.length()-n;return function(t,e){const n=e.ops[e.ops.length-1];return null!=n&&(null!=n.insert?"string"==typeof n.insert&&n.insert.endsWith("\n"):null!=n.attributes&&Object.keys(n.attributes).some((e=>null!=t.query(e,u.Scope.BLOCK))))}(t,e)&&(r-=1),r}(this.quill.scroll,t.delta);this.quill.setSelection(e,r.Ay.sources.USER)}}}function E(t,e){let n=e;for(let e=t.length-1;e>=0;e-=1){const r=t[e];t[e]={delta:n.transform(r.delta,!0),range:r.range&&w(r.range,n)},n=r.delta.transform(n),0===t[e].delta.length()&&t.splice(e,1)}}function w(t,e){if(!t)return t;const n=e.transformPosition(t.index);return{index:n,length:e.transformPosition(t.index+t.length)-n}}var q=n(8123);class k extends x.A{constructor(t,e){super(t,e),t.root.addEventListener("drop",(e=>{e.preventDefault();let n=null;if(document.caretRangeFromPoint)n=document.caretRangeFromPoint(e.clientX,e.clientY);else if(document.caretPositionFromPoint){const t=document.caretPositionFromPoint(e.clientX,e.clientY);n=document.createRange(),n.setStart(t.offsetNode,t.offset),n.setEnd(t.offsetNode,t.offset)}const r=n&&t.selection.normalizeNative(n);if(r){const n=t.selection.normalizedToRange(r);e.dataTransfer?.files&&this.upload(n,e.dataTransfer.files)}}))}upload(t,e){const n=[];Array.from(e).forEach((t=>{t&&this.options.mimetypes?.includes(t.type)&&n.push(t)})),n.length>0&&this.options.handler.call(this,t,n)}}k.DEFAULTS={mimetypes:["image/png","image/jpeg"],handler(t,e){if(!this.quill.scroll.query("image"))return;const n=e.map((t=>new Promise((e=>{const n=new FileReader;n.onload=()=>{e(n.result)},n.readAsDataURL(t)}))));Promise.all(n).then((e=>{const n=e.reduce(((t,e)=>t.insert({image:e})),(new(d())).retain(t.index).delete(t.length));this.quill.updateContents(n,f.A.sources.USER),this.quill.setSelection(t.index+e.length,f.A.sources.SILENT)}))}};var _=k;const L=["insertText","insertReplacementText"];class S extends x.A{constructor(t,e){super(t,e),t.root.addEventListener("beforeinput",(t=>{this.handleBeforeInput(t)})),/Android/i.test(navigator.userAgent)||t.on(r.Ay.events.COMPOSITION_BEFORE_START,(()=>{this.handleCompositionStart()}))}deleteRange(t){(0,q.Xo)({range:t,quill:this.quill})}replaceText(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"";if(0===t.length)return!1;if(e){const n=this.quill.getFormat(t.index,1);this.deleteRange(t),this.quill.updateContents((new(d())).retain(t.index).insert(e,n),r.Ay.sources.USER)}else this.deleteRange(t);return this.quill.setSelection(t.index+e.length,0,r.Ay.sources.SILENT),!0}handleBeforeInput(t){if(this.quill.composition.isComposing||t.defaultPrevented||!L.includes(t.inputType))return;const e=t.getTargetRanges?t.getTargetRanges()[0]:null;if(!e||!0===e.collapsed)return;const n=function(t){return"string"==typeof t.data?t.data:t.dataTransfer?.types.includes("text/plain")?t.dataTransfer.getData("text/plain"):null}(t);if(null==n)return;const r=this.quill.selection.normalizeNative(e),i=r?this.quill.selection.normalizedToRange(r):null;i&&this.replaceText(i,n)&&t.preventDefault()}handleCompositionStart(){const t=this.quill.getSelection();t&&this.replaceText(t)}}var O=S;const T=/Mac/i.test(navigator.platform);class j extends x.A{isListening=!1;selectionChangeDeadline=0;constructor(t,e){super(t,e),this.handleArrowKeys(),this.handleNavigationShortcuts()}handleArrowKeys(){this.quill.keyboard.addBinding({key:["ArrowLeft","ArrowRight"],offset:0,shiftKey:null,handler(t,e){let{line:n,event:i}=e;if(!(n instanceof u.ParentBlot&&n.uiNode))return!0;const s="rtl"===getComputedStyle(n.domNode).direction;return!!(s&&"ArrowRight"!==i.key||!s&&"ArrowLeft"!==i.key)||(this.quill.setSelection(t.index-1,t.length+(i.shiftKey?1:0),r.Ay.sources.USER),!1)}})}handleNavigationShortcuts(){this.quill.root.addEventListener("keydown",(t=>{!t.defaultPrevented&&(t=>"ArrowLeft"===t.key||"ArrowRight"===t.key||"ArrowUp"===t.key||"ArrowDown"===t.key||"Home"===t.key||!(!T||"a"!==t.key||!0!==t.ctrlKey))(t)&&this.ensureListeningToSelectionChange()}))}ensureListeningToSelectionChange(){this.selectionChangeDeadline=Date.now()+100,this.isListening||(this.isListening=!0,document.addEventListener("selectionchange",(()=>{this.isListening=!1,Date.now()<=this.selectionChangeDeadline&&this.handleSelectionChange()}),{once:!0}))}handleSelectionChange(){const t=document.getSelection();if(!t)return;const e=t.getRangeAt(0);if(!0!==e.collapsed||0!==e.startOffset)return;const n=this.quill.scroll.find(e.startContainer);if(!(n instanceof u.ParentBlot&&n.uiNode))return;const r=document.createRange();r.setStartAfter(n.uiNode),r.setEndAfter(n.uiNode),t.removeAllRanges(),t.addRange(r)}}var C=j;r.Ay.register({"blots/block":i.Ay,"blots/block/embed":i.zo,"blots/break":s.A,"blots/container":o.A,"blots/cursor":l.A,"blots/embed":a.A,"blots/inline":c.A,"blots/scroll":y,"blots/text":v.A,"modules/clipboard":A.Ay,"modules/history":N,"modules/keyboard":q.Ay,"modules/uploader":_,"modules/input":O,"modules/uiNode":C});var R=r.Ay},5374:function(t,e,n){"use strict";n.d(e,{A:function(){return o}});var r=n(8920),i=n(7356);const s=(0,n(6078).A)("quill:events");["selectionchange","mousedown","mouseup","click"].forEach((t=>{document.addEventListener(t,(function(){for(var t=arguments.length,e=new Array(t),n=0;n<t;n++)e[n]=arguments[n];Array.from(document.querySelectorAll(".ql-container")).forEach((t=>{const n=i.A.get(t);n&&n.emitter&&n.emitter.handleDOM(...e)}))}))}));var o=class extends r{static events={EDITOR_CHANGE:"editor-change",SCROLL_BEFORE_UPDATE:"scroll-before-update",SCROLL_BLOT_MOUNT:"scroll-blot-mount",SCROLL_BLOT_UNMOUNT:"scroll-blot-unmount",SCROLL_OPTIMIZE:"scroll-optimize",SCROLL_UPDATE:"scroll-update",SCROLL_EMBED_UPDATE:"scroll-embed-update",SELECTION_CHANGE:"selection-change",TEXT_CHANGE:"text-change",COMPOSITION_BEFORE_START:"composition-before-start",COMPOSITION_START:"composition-start",COMPOSITION_BEFORE_END:"composition-before-end",COMPOSITION_END:"composition-end"};static sources={API:"api",SILENT:"silent",USER:"user"};constructor(){super(),this.domListeners={},this.on("error",s.error)}emit(){for(var t=arguments.length,e=new Array(t),n=0;n<t;n++)e[n]=arguments[n];return s.log.call(s,...e),super.emit(...e)}handleDOM(t){for(var e=arguments.length,n=new Array(e>1?e-1:0),r=1;r<e;r++)n[r-1]=arguments[r];(this.domListeners[t.type]||[]).forEach((e=>{let{node:r,handler:i}=e;(t.target===r||r.contains(t.target))&&i(t,...n)}))}listenDOM(t,e,n){this.domListeners[t]||(this.domListeners[t]=[]),this.domListeners[t].push({node:e,handler:n})}}},7356:function(t,e){"use strict";e.A=new WeakMap},6078:function(t,e){"use strict";const n=["error","warn","log","info"];let r="warn";function i(t){if(r&&n.indexOf(t)<=n.indexOf(r)){for(var e=arguments.length,i=new Array(e>1?e-1:0),s=1;s<e;s++)i[s-1]=arguments[s];console[t](...i)}}function s(t){return n.reduce(((e,n)=>(e[n]=i.bind(console,n,t),e)),{})}s.level=t=>{r=t},i.level=s.level,e.A=s},4266:function(t,e){"use strict";e.A=class{static DEFAULTS={};constructor(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};this.quill=t,this.options=e}}},6142:function(t,e,n){"use strict";n.d(e,{Ay:function(){return I}});var r=n(8347),i=n(6003),s=n(5232),o=n.n(s),l=n(3707),a=n(5123),c=n(9698),u=n(3036),h=n(4541),d=n(5508),f=n(8298);const p=/^[ -~]*$/;function g(t,e,n){if(0===t.length){const[t]=y(n.pop());return e<=0?`</li></${t}>`:`</li></${t}>${g([],e-1,n)}`}const[{child:r,offset:i,length:s,indent:o,type:l},...a]=t,[c,u]=y(l);if(o>e)return n.push(l),o===e+1?`<${c}><li${u}>${m(r,i,s)}${g(a,o,n)}`:`<${c}><li>${g(t,e+1,n)}`;const h=n[n.length-1];if(o===e&&l===h)return`</li><li${u}>${m(r,i,s)}${g(a,o,n)}`;const[d]=y(n.pop());return`</li></${d}>${g(t,e-1,n)}`}function m(t,e,n){let r=arguments.length>3&&void 0!==arguments[3]&&arguments[3];if("html"in t&&"function"==typeof t.html)return t.html(e,n);if(t instanceof d.A)return(0,d.X)(t.value().slice(e,e+n));if(t instanceof i.ParentBlot){if("list-container"===t.statics.blotName){const r=[];return t.children.forEachAt(e,n,((t,e,n)=>{const i="formats"in t&&"function"==typeof t.formats?t.formats():{};r.push({child:t,offset:e,length:n,indent:i.indent||0,type:i.list})})),g(r,-1,[])}const i=[];if(t.children.forEachAt(e,n,((t,e,n)=>{i.push(m(t,e,n))})),r||"list"===t.statics.blotName)return i.join("");const{outerHTML:s,innerHTML:o}=t.domNode,[l,a]=s.split(`>${o}<`);return"<table"===l?`<table style="border: 1px solid #000;">${i.join("")}<${a}`:`${l}>${i.join("")}<${a}`}return t.domNode instanceof Element?t.domNode.outerHTML:""}function b(t,e){return Object.keys(e).reduce(((n,r)=>{if(null==t[r])return n;const i=e[r];return i===t[r]?n[r]=i:Array.isArray(i)?i.indexOf(t[r])<0?n[r]=i.concat([t[r]]):n[r]=i:n[r]=[i,t[r]],n}),{})}function y(t){const e="ordered"===t?"ol":"ul";switch(t){case"checked":return[e,' data-list="checked"'];case"unchecked":return[e,' data-list="unchecked"'];default:return[e,""]}}function v(t){return t.reduce(((t,e)=>{if("string"==typeof e.insert){const n=e.insert.replace(/\r\n/g,"\n").replace(/\r/g,"\n");return t.insert(n,e.attributes)}return t.push(e)}),new(o()))}function A(t,e){let{index:n,length:r}=t;return new f.Q(n+e,r)}var x=class{constructor(t){this.scroll=t,this.delta=this.getDelta()}applyDelta(t){this.scroll.update();let e=this.scroll.length();this.scroll.batchStart();const n=v(t),l=new(o());return function(t){const e=[];return t.forEach((t=>{"string"==typeof t.insert?t.insert.split("\n").forEach(((n,r)=>{r&&e.push({insert:"\n",attributes:t.attributes}),n&&e.push({insert:n,attributes:t.attributes})})):e.push(t)})),e}(n.ops.slice()).reduce(((t,n)=>{const o=s.Op.length(n);let a=n.attributes||{},u=!1,h=!1;if(null!=n.insert){if(l.retain(o),"string"==typeof n.insert){const o=n.insert;h=!o.endsWith("\n")&&(e<=t||!!this.scroll.descendant(c.zo,t)[0]),this.scroll.insertAt(t,o);const[l,u]=this.scroll.line(t);let d=(0,r.A)({},(0,c.Ji)(l));if(l instanceof c.Ay){const[t]=l.descendant(i.LeafBlot,u);t&&(d=(0,r.A)(d,(0,c.Ji)(t)))}a=s.AttributeMap.diff(d,a)||{}}else if("object"==typeof n.insert){const o=Object.keys(n.insert)[0];if(null==o)return t;const l=null!=this.scroll.query(o,i.Scope.INLINE);if(l)(e<=t||this.scroll.descendant(c.zo,t)[0])&&(h=!0);else if(t>0){const[e,n]=this.scroll.descendant(i.LeafBlot,t-1);e instanceof d.A?"\n"!==e.value()[n]&&(u=!0):e instanceof i.EmbedBlot&&e.statics.scope===i.Scope.INLINE_BLOT&&(u=!0)}if(this.scroll.insertAt(t,o,n.insert[o]),l){const[e]=this.scroll.descendant(i.LeafBlot,t);if(e){const t=(0,r.A)({},(0,c.Ji)(e));a=s.AttributeMap.diff(t,a)||{}}}}e+=o}else if(l.push(n),null!==n.retain&&"object"==typeof n.retain){const e=Object.keys(n.retain)[0];if(null==e)return t;this.scroll.updateEmbedAt(t,e,n.retain[e])}Object.keys(a).forEach((e=>{this.scroll.formatAt(t,o,e,a[e])}));const f=u?1:0,p=h?1:0;return e+=f+p,l.retain(f),l.delete(p),t+o+f+p}),0),l.reduce(((t,e)=>"number"==typeof e.delete?(this.scroll.deleteAt(t,e.delete),t):t+s.Op.length(e)),0),this.scroll.batchEnd(),this.scroll.optimize(),this.update(n)}deleteText(t,e){return this.scroll.deleteAt(t,e),this.update((new(o())).retain(t).delete(e))}formatLine(t,e){let n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{};this.scroll.update(),Object.keys(n).forEach((r=>{this.scroll.lines(t,Math.max(e,1)).forEach((t=>{t.format(r,n[r])}))})),this.scroll.optimize();const r=(new(o())).retain(t).retain(e,(0,l.A)(n));return this.update(r)}formatText(t,e){let n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{};Object.keys(n).forEach((r=>{this.scroll.formatAt(t,e,r,n[r])}));const r=(new(o())).retain(t).retain(e,(0,l.A)(n));return this.update(r)}getContents(t,e){return this.delta.slice(t,t+e)}getDelta(){return this.scroll.lines().reduce(((t,e)=>t.concat(e.delta())),new(o()))}getFormat(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0,n=[],r=[];0===e?this.scroll.path(t).forEach((t=>{const[e]=t;e instanceof c.Ay?n.push(e):e instanceof i.LeafBlot&&r.push(e)})):(n=this.scroll.lines(t,e),r=this.scroll.descendants(i.LeafBlot,t,e));const[s,o]=[n,r].map((t=>{const e=t.shift();if(null==e)return{};let n=(0,c.Ji)(e);for(;Object.keys(n).length>0;){const e=t.shift();if(null==e)return n;n=b((0,c.Ji)(e),n)}return n}));return{...s,...o}}getHTML(t,e){const[n,r]=this.scroll.line(t);if(n){const i=n.length();return n.length()>=r+e&&(0!==r||e!==i)?m(n,r,e,!0):m(this.scroll,t,e,!0)}return""}getText(t,e){return this.getContents(t,e).filter((t=>"string"==typeof t.insert)).map((t=>t.insert)).join("")}insertContents(t,e){const n=v(e),r=(new(o())).retain(t).concat(n);return this.scroll.insertContents(t,n),this.update(r)}insertEmbed(t,e,n){return this.scroll.insertAt(t,e,n),this.update((new(o())).retain(t).insert({[e]:n}))}insertText(t,e){let n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{};return e=e.replace(/\r\n/g,"\n").replace(/\r/g,"\n"),this.scroll.insertAt(t,e),Object.keys(n).forEach((r=>{this.scroll.formatAt(t,e.length,r,n[r])})),this.update((new(o())).retain(t).insert(e,(0,l.A)(n)))}isBlank(){if(0===this.scroll.children.length)return!0;if(this.scroll.children.length>1)return!1;const t=this.scroll.children.head;if(t?.statics.blotName!==c.Ay.blotName)return!1;const e=t;return!(e.children.length>1)&&e.children.head instanceof u.A}removeFormat(t,e){const n=this.getText(t,e),[r,i]=this.scroll.line(t+e);let s=0,l=new(o());null!=r&&(s=r.length()-i,l=r.delta().slice(i,i+s-1).insert("\n"));const a=this.getContents(t,e+s).diff((new(o())).insert(n).concat(l)),c=(new(o())).retain(t).concat(a);return this.applyDelta(c)}update(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:[],n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:void 0;const r=this.delta;if(1===e.length&&"characterData"===e[0].type&&e[0].target.data.match(p)&&this.scroll.find(e[0].target)){const i=this.scroll.find(e[0].target),s=(0,c.Ji)(i),l=i.offset(this.scroll),a=e[0].oldValue.replace(h.A.CONTENTS,""),u=(new(o())).insert(a),d=(new(o())).insert(i.value()),f=n&&{oldRange:A(n.oldRange,-l),newRange:A(n.newRange,-l)};t=(new(o())).retain(l).concat(u.diff(d,f)).reduce(((t,e)=>e.insert?t.insert(e.insert,s):t.push(e)),new(o())),this.delta=r.compose(t)}else this.delta=this.getDelta(),t&&(0,a.A)(r.compose(t),this.delta)||(t=r.diff(this.delta,n));return t}},N=n(5374),E=n(7356),w=n(6078),q=n(4266),k=n(746),_=class{isComposing=!1;constructor(t,e){this.scroll=t,this.emitter=e,this.setupListeners()}setupListeners(){this.scroll.domNode.addEventListener("compositionstart",(t=>{this.isComposing||this.handleCompositionStart(t)})),this.scroll.domNode.addEventListener("compositionend",(t=>{this.isComposing&&queueMicrotask((()=>{this.handleCompositionEnd(t)}))}))}handleCompositionStart(t){const e=t.target instanceof Node?this.scroll.find(t.target,!0):null;!e||e instanceof k.A||(this.emitter.emit(N.A.events.COMPOSITION_BEFORE_START,t),this.scroll.batchStart(),this.emitter.emit(N.A.events.COMPOSITION_START,t),this.isComposing=!0)}handleCompositionEnd(t){this.emitter.emit(N.A.events.COMPOSITION_BEFORE_END,t),this.scroll.batchEnd(),this.emitter.emit(N.A.events.COMPOSITION_END,t),this.isComposing=!1}},L=n(9609);const S=t=>{const e=t.getBoundingClientRect(),n="offsetWidth"in t&&Math.abs(e.width)/t.offsetWidth||1,r="offsetHeight"in t&&Math.abs(e.height)/t.offsetHeight||1;return{top:e.top,right:e.left+t.clientWidth*n,bottom:e.top+t.clientHeight*r,left:e.left}},O=t=>{const e=parseInt(t,10);return Number.isNaN(e)?0:e},T=(t,e,n,r,i,s)=>t<n&&e>r?0:t<n?-(n-t+i):e>r?e-t>r-n?t+i-n:e-r+s:0;const j=["block","break","cursor","inline","scroll","text"];const C=(0,w.A)("quill"),R=new i.Registry;i.ParentBlot.uiClass="ql-ui";class I{static DEFAULTS={bounds:null,modules:{clipboard:!0,keyboard:!0,history:!0,uploader:!0},placeholder:"",readOnly:!1,registry:R,theme:"default"};static events=N.A.events;static sources=N.A.sources;static version="2.0.2";static imports={delta:o(),parchment:i,"core/module":q.A,"core/theme":L.A};static debug(t){!0===t&&(t="log"),w.A.level(t)}static find(t){let e=arguments.length>1&&void 0!==arguments[1]&&arguments[1];return E.A.get(t)||R.find(t,e)}static import(t){return null==this.imports[t]&&C.error(`Cannot import ${t}. Are you sure it was registered?`),this.imports[t]}static register(){if("string"!=typeof(arguments.length<=0?void 0:arguments[0])){const t=arguments.length<=0?void 0:arguments[0],e=!!(arguments.length<=1?void 0:arguments[1]),n="attrName"in t?t.attrName:t.blotName;"string"==typeof n?this.register(`formats/${n}`,t,e):Object.keys(t).forEach((n=>{this.register(n,t[n],e)}))}else{const t=arguments.length<=0?void 0:arguments[0],e=arguments.length<=1?void 0:arguments[1],n=!!(arguments.length<=2?void 0:arguments[2]);null==this.imports[t]||n||C.warn(`Overwriting ${t} with`,e),this.imports[t]=e,(t.startsWith("blots/")||t.startsWith("formats/"))&&e&&"boolean"!=typeof e&&"abstract"!==e.blotName&&R.register(e),"function"==typeof e.register&&e.register(R)}}constructor(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};if(this.options=function(t,e){const n=B(t);if(!n)throw new Error("Invalid Quill container");const s=!e.theme||e.theme===I.DEFAULTS.theme?L.A:I.import(`themes/${e.theme}`);if(!s)throw new Error(`Invalid theme ${e.theme}. Did you register it?`);const{modules:o,...l}=I.DEFAULTS,{modules:a,...c}=s.DEFAULTS;let u=M(e.modules);null!=u&&u.toolbar&&u.toolbar.constructor!==Object&&(u={...u,toolbar:{container:u.toolbar}});const h=(0,r.A)({},M(o),M(a),u),d={...l,...U(c),...U(e)};let f=e.registry;return f?e.formats&&C.warn('Ignoring "formats" option because "registry" is specified'):f=e.formats?((t,e,n)=>{const r=new i.Registry;return j.forEach((t=>{const n=e.query(t);n&&r.register(n)})),t.forEach((t=>{let i=e.query(t);i||n.error(`Cannot register "${t}" specified in "formats" config. Are you sure it was registered?`);let s=0;for(;i;)if(r.register(i),i="blotName"in i?i.requiredContainer??null:null,s+=1,s>100){n.error(`Cycle detected in registering blot requiredContainer: "${t}"`);break}})),r})(e.formats,d.registry,C):d.registry,{...d,registry:f,container:n,theme:s,modules:Object.entries(h).reduce(((t,e)=>{let[n,i]=e;if(!i)return t;const s=I.import(`modules/${n}`);return null==s?(C.error(`Cannot load ${n} module. Are you sure you registered it?`),t):{...t,[n]:(0,r.A)({},s.DEFAULTS||{},i)}}),{}),bounds:B(d.bounds)}}(t,e),this.container=this.options.container,null==this.container)return void C.error("Invalid Quill container",t);this.options.debug&&I.debug(this.options.debug);const n=this.container.innerHTML.trim();this.container.classList.add("ql-container"),this.container.innerHTML="",E.A.set(this.container,this),this.root=this.addContainer("ql-editor"),this.root.classList.add("ql-blank"),this.emitter=new N.A;const s=i.ScrollBlot.blotName,l=this.options.registry.query(s);if(!l||!("blotName"in l))throw new Error(`Cannot initialize Quill without "${s}" blot`);if(this.scroll=new l(this.options.registry,this.root,{emitter:this.emitter}),this.editor=new x(this.scroll),this.selection=new f.A(this.scroll,this.emitter),this.composition=new _(this.scroll,this.emitter),this.theme=new this.options.theme(this,this.options),this.keyboard=this.theme.addModule("keyboard"),this.clipboard=this.theme.addModule("clipboard"),this.history=this.theme.addModule("history"),this.uploader=this.theme.addModule("uploader"),this.theme.addModule("input"),this.theme.addModule("uiNode"),this.theme.init(),this.emitter.on(N.A.events.EDITOR_CHANGE,(t=>{t===N.A.events.TEXT_CHANGE&&this.root.classList.toggle("ql-blank",this.editor.isBlank())})),this.emitter.on(N.A.events.SCROLL_UPDATE,((t,e)=>{const n=this.selection.lastRange,[r]=this.selection.getRange(),i=n&&r?{oldRange:n,newRange:r}:void 0;D.call(this,(()=>this.editor.update(null,e,i)),t)})),this.emitter.on(N.A.events.SCROLL_EMBED_UPDATE,((t,e)=>{const n=this.selection.lastRange,[r]=this.selection.getRange(),i=n&&r?{oldRange:n,newRange:r}:void 0;D.call(this,(()=>{const n=(new(o())).retain(t.offset(this)).retain({[t.statics.blotName]:e});return this.editor.update(n,[],i)}),I.sources.USER)})),n){const t=this.clipboard.convert({html:`${n}<p><br></p>`,text:"\n"});this.setContents(t)}this.history.clear(),this.options.placeholder&&this.root.setAttribute("data-placeholder",this.options.placeholder),this.options.readOnly&&this.disable(),this.allowReadOnlyEdits=!1}addContainer(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:null;if("string"==typeof t){const e=t;(t=document.createElement("div")).classList.add(e)}return this.container.insertBefore(t,e),t}blur(){this.selection.setRange(null)}deleteText(t,e,n){return[t,e,,n]=P(t,e,n),D.call(this,(()=>this.editor.deleteText(t,e)),n,t,-1*e)}disable(){this.enable(!1)}editReadOnly(t){this.allowReadOnlyEdits=!0;const e=t();return this.allowReadOnlyEdits=!1,e}enable(){let t=!(arguments.length>0&&void 0!==arguments[0])||arguments[0];this.scroll.enable(t),this.container.classList.toggle("ql-disabled",!t)}focus(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};this.selection.focus(),t.preventScroll||this.scrollSelectionIntoView()}format(t,e){let n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:N.A.sources.API;return D.call(this,(()=>{const n=this.getSelection(!0);let r=new(o());if(null==n)return r;if(this.scroll.query(t,i.Scope.BLOCK))r=this.editor.formatLine(n.index,n.length,{[t]:e});else{if(0===n.length)return this.selection.format(t,e),r;r=this.editor.formatText(n.index,n.length,{[t]:e})}return this.setSelection(n,N.A.sources.SILENT),r}),n)}formatLine(t,e,n,r,i){let s;return[t,e,s,i]=P(t,e,n,r,i),D.call(this,(()=>this.editor.formatLine(t,e,s)),i,t,0)}formatText(t,e,n,r,i){let s;return[t,e,s,i]=P(t,e,n,r,i),D.call(this,(()=>this.editor.formatText(t,e,s)),i,t,0)}getBounds(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0,n=null;if(n="number"==typeof t?this.selection.getBounds(t,e):this.selection.getBounds(t.index,t.length),!n)return null;const r=this.container.getBoundingClientRect();return{bottom:n.bottom-r.top,height:n.height,left:n.left-r.left,right:n.right-r.left,top:n.top-r.top,width:n.width}}getContents(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:this.getLength()-t;return[t,e]=P(t,e),this.editor.getContents(t,e)}getFormat(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:this.getSelection(!0),e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;return"number"==typeof t?this.editor.getFormat(t,e):this.editor.getFormat(t.index,t.length)}getIndex(t){return t.offset(this.scroll)}getLength(){return this.scroll.length()}getLeaf(t){return this.scroll.leaf(t)}getLine(t){return this.scroll.line(t)}getLines(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:Number.MAX_VALUE;return"number"!=typeof t?this.scroll.lines(t.index,t.length):this.scroll.lines(t,e)}getModule(t){return this.theme.modules[t]}getSelection(){return arguments.length>0&&void 0!==arguments[0]&&arguments[0]&&this.focus(),this.update(),this.selection.getRange()[0]}getSemanticHTML(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,e=arguments.length>1?arguments[1]:void 0;return"number"==typeof t&&(e=e??this.getLength()-t),[t,e]=P(t,e),this.editor.getHTML(t,e)}getText(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:0,e=arguments.length>1?arguments[1]:void 0;return"number"==typeof t&&(e=e??this.getLength()-t),[t,e]=P(t,e),this.editor.getText(t,e)}hasFocus(){return this.selection.hasFocus()}insertEmbed(t,e,n){let r=arguments.length>3&&void 0!==arguments[3]?arguments[3]:I.sources.API;return D.call(this,(()=>this.editor.insertEmbed(t,e,n)),r,t)}insertText(t,e,n,r,i){let s;return[t,,s,i]=P(t,0,n,r,i),D.call(this,(()=>this.editor.insertText(t,e,s)),i,t,e.length)}isEnabled(){return this.scroll.isEnabled()}off(){return this.emitter.off(...arguments)}on(){return this.emitter.on(...arguments)}once(){return this.emitter.once(...arguments)}removeFormat(t,e,n){return[t,e,,n]=P(t,e,n),D.call(this,(()=>this.editor.removeFormat(t,e)),n,t)}scrollRectIntoView(t){((t,e)=>{const n=t.ownerDocument;let r=e,i=t;for(;i;){const t=i===n.body,e=t?{top:0,right:window.visualViewport?.width??n.documentElement.clientWidth,bottom:window.visualViewport?.height??n.documentElement.clientHeight,left:0}:S(i),o=getComputedStyle(i),l=T(r.left,r.right,e.left,e.right,O(o.scrollPaddingLeft),O(o.scrollPaddingRight)),a=T(r.top,r.bottom,e.top,e.bottom,O(o.scrollPaddingTop),O(o.scrollPaddingBottom));if(l||a)if(t)n.defaultView?.scrollBy(l,a);else{const{scrollLeft:t,scrollTop:e}=i;a&&(i.scrollTop+=a),l&&(i.scrollLeft+=l);const n=i.scrollLeft-t,s=i.scrollTop-e;r={left:r.left-n,top:r.top-s,right:r.right-n,bottom:r.bottom-s}}i=t||"fixed"===o.position?null:(s=i).parentElement||s.getRootNode().host||null}var s})(this.root,t)}scrollIntoView(){console.warn("Quill#scrollIntoView() has been deprecated and will be removed in the near future. Please use Quill#scrollSelectionIntoView() instead."),this.scrollSelectionIntoView()}scrollSelectionIntoView(){const t=this.selection.lastRange,e=t&&this.selection.getBounds(t.index,t.length);e&&this.scrollRectIntoView(e)}setContents(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:N.A.sources.API;return D.call(this,(()=>{t=new(o())(t);const e=this.getLength(),n=this.editor.deleteText(0,e),r=this.editor.insertContents(0,t),i=this.editor.deleteText(this.getLength()-1,1);return n.compose(r).compose(i)}),e)}setSelection(t,e,n){null==t?this.selection.setRange(null,e||I.sources.API):([t,e,,n]=P(t,e,n),this.selection.setRange(new f.Q(Math.max(0,t),e),n),n!==N.A.sources.SILENT&&this.scrollSelectionIntoView())}setText(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:N.A.sources.API;const n=(new(o())).insert(t);return this.setContents(n,e)}update(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:N.A.sources.USER;const e=this.scroll.update(t);return this.selection.update(t),e}updateContents(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:N.A.sources.API;return D.call(this,(()=>(t=new(o())(t),this.editor.applyDelta(t))),e,!0)}}function B(t){return"string"==typeof t?document.querySelector(t):t}function M(t){return Object.entries(t??{}).reduce(((t,e)=>{let[n,r]=e;return{...t,[n]:!0===r?{}:r}}),{})}function U(t){return Object.fromEntries(Object.entries(t).filter((t=>void 0!==t[1])))}function D(t,e,n,r){if(!this.isEnabled()&&e===N.A.sources.USER&&!this.allowReadOnlyEdits)return new(o());let i=null==n?null:this.getSelection();const s=this.editor.delta,l=t();if(null!=i&&(!0===n&&(n=i.index),null==r?i=z(i,l,e):0!==r&&(i=z(i,n,r,e)),this.setSelection(i,N.A.sources.SILENT)),l.length()>0){const t=[N.A.events.TEXT_CHANGE,l,s,e];this.emitter.emit(N.A.events.EDITOR_CHANGE,...t),e!==N.A.sources.SILENT&&this.emitter.emit(...t)}return l}function P(t,e,n,r,i){let s={};return"number"==typeof t.index&&"number"==typeof t.length?"number"!=typeof e?(i=r,r=n,n=e,e=t.length,t=t.index):(e=t.length,t=t.index):"number"!=typeof e&&(i=r,r=n,n=e,e=0),"object"==typeof n?(s=n,i=r):"string"==typeof n&&(null!=r?s[n]=r:i=n),[t,e,s,i=i||N.A.sources.API]}function z(t,e,n,r){const i="number"==typeof n?n:0;if(null==t)return null;let s,o;return e&&"function"==typeof e.transformPosition?[s,o]=[t.index,t.index+t.length].map((t=>e.transformPosition(t,r!==N.A.sources.USER))):[s,o]=[t.index,t.index+t.length].map((t=>t<e||t===e&&r===N.A.sources.USER?t:i>=0?t+i:Math.max(e,t+i))),new f.Q(s,o-s)}},8298:function(t,e,n){"use strict";n.d(e,{Q:function(){return a}});var r=n(6003),i=n(5123),s=n(3707),o=n(5374);const l=(0,n(6078).A)("quill:selection");class a{constructor(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;this.index=t,this.length=e}}function c(t,e){try{e.parentNode}catch(t){return!1}return t.contains(e)}e.A=class{constructor(t,e){this.emitter=e,this.scroll=t,this.composing=!1,this.mouseDown=!1,this.root=this.scroll.domNode,this.cursor=this.scroll.create("cursor",this),this.savedRange=new a(0,0),this.lastRange=this.savedRange,this.lastNative=null,this.handleComposition(),this.handleDragging(),this.emitter.listenDOM("selectionchange",document,(()=>{this.mouseDown||this.composing||setTimeout(this.update.bind(this,o.A.sources.USER),1)})),this.emitter.on(o.A.events.SCROLL_BEFORE_UPDATE,(()=>{if(!this.hasFocus())return;const t=this.getNativeRange();null!=t&&t.start.node!==this.cursor.textNode&&this.emitter.once(o.A.events.SCROLL_UPDATE,((e,n)=>{try{this.root.contains(t.start.node)&&this.root.contains(t.end.node)&&this.setNativeRange(t.start.node,t.start.offset,t.end.node,t.end.offset);const r=n.some((t=>"characterData"===t.type||"childList"===t.type||"attributes"===t.type&&t.target===this.root));this.update(r?o.A.sources.SILENT:e)}catch(t){}}))})),this.emitter.on(o.A.events.SCROLL_OPTIMIZE,((t,e)=>{if(e.range){const{startNode:t,startOffset:n,endNode:r,endOffset:i}=e.range;this.setNativeRange(t,n,r,i),this.update(o.A.sources.SILENT)}})),this.update(o.A.sources.SILENT)}handleComposition(){this.emitter.on(o.A.events.COMPOSITION_BEFORE_START,(()=>{this.composing=!0})),this.emitter.on(o.A.events.COMPOSITION_END,(()=>{if(this.composing=!1,this.cursor.parent){const t=this.cursor.restore();if(!t)return;setTimeout((()=>{this.setNativeRange(t.startNode,t.startOffset,t.endNode,t.endOffset)}),1)}}))}handleDragging(){this.emitter.listenDOM("mousedown",document.body,(()=>{this.mouseDown=!0})),this.emitter.listenDOM("mouseup",document.body,(()=>{this.mouseDown=!1,this.update(o.A.sources.USER)}))}focus(){this.hasFocus()||(this.root.focus({preventScroll:!0}),this.setRange(this.savedRange))}format(t,e){this.scroll.update();const n=this.getNativeRange();if(null!=n&&n.native.collapsed&&!this.scroll.query(t,r.Scope.BLOCK)){if(n.start.node!==this.cursor.textNode){const t=this.scroll.find(n.start.node,!1);if(null==t)return;if(t instanceof r.LeafBlot){const e=t.split(n.start.offset);t.parent.insertBefore(this.cursor,e)}else t.insertBefore(this.cursor,n.start.node);this.cursor.attach()}this.cursor.format(t,e),this.scroll.optimize(),this.setNativeRange(this.cursor.textNode,this.cursor.textNode.data.length),this.update()}}getBounds(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:0;const n=this.scroll.length();let r;t=Math.min(t,n-1),e=Math.min(t+e,n-1)-t;let[i,s]=this.scroll.leaf(t);if(null==i)return null;if(e>0&&s===i.length()){const[e]=this.scroll.leaf(t+1);if(e){const[n]=this.scroll.line(t),[r]=this.scroll.line(t+1);n===r&&(i=e,s=0)}}[r,s]=i.position(s,!0);const o=document.createRange();if(e>0)return o.setStart(r,s),[i,s]=this.scroll.leaf(t+e),null==i?null:([r,s]=i.position(s,!0),o.setEnd(r,s),o.getBoundingClientRect());let l,a="left";if(r instanceof Text){if(!r.data.length)return null;s<r.data.length?(o.setStart(r,s),o.setEnd(r,s+1)):(o.setStart(r,s-1),o.setEnd(r,s),a="right"),l=o.getBoundingClientRect()}else{if(!(i.domNode instanceof Element))return null;l=i.domNode.getBoundingClientRect(),s>0&&(a="right")}return{bottom:l.top+l.height,height:l.height,left:l[a],right:l[a],top:l.top,width:0}}getNativeRange(){const t=document.getSelection();if(null==t||t.rangeCount<=0)return null;const e=t.getRangeAt(0);if(null==e)return null;const n=this.normalizeNative(e);return l.info("getNativeRange",n),n}getRange(){const t=this.scroll.domNode;if("isConnected"in t&&!t.isConnected)return[null,null];const e=this.getNativeRange();return null==e?[null,null]:[this.normalizedToRange(e),e]}hasFocus(){return document.activeElement===this.root||null!=document.activeElement&&c(this.root,document.activeElement)}normalizedToRange(t){const e=[[t.start.node,t.start.offset]];t.native.collapsed||e.push([t.end.node,t.end.offset]);const n=e.map((t=>{const[e,n]=t,i=this.scroll.find(e,!0),s=i.offset(this.scroll);return 0===n?s:i instanceof r.LeafBlot?s+i.index(e,n):s+i.length()})),i=Math.min(Math.max(...n),this.scroll.length()-1),s=Math.min(i,...n);return new a(s,i-s)}normalizeNative(t){if(!c(this.root,t.startContainer)||!t.collapsed&&!c(this.root,t.endContainer))return null;const e={start:{node:t.startContainer,offset:t.startOffset},end:{node:t.endContainer,offset:t.endOffset},native:t};return[e.start,e.end].forEach((t=>{let{node:e,offset:n}=t;for(;!(e instanceof Text)&&e.childNodes.length>0;)if(e.childNodes.length>n)e=e.childNodes[n],n=0;else{if(e.childNodes.length!==n)break;e=e.lastChild,n=e instanceof Text?e.data.length:e.childNodes.length>0?e.childNodes.length:e.childNodes.length+1}t.node=e,t.offset=n})),e}rangeToNative(t){const e=this.scroll.length(),n=(t,n)=>{t=Math.min(e-1,t);const[r,i]=this.scroll.leaf(t);return r?r.position(i,n):[null,-1]};return[...n(t.index,!1),...n(t.index+t.length,!0)]}setNativeRange(t,e){let n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:t,r=arguments.length>3&&void 0!==arguments[3]?arguments[3]:e,i=arguments.length>4&&void 0!==arguments[4]&&arguments[4];if(l.info("setNativeRange",t,e,n,r),null!=t&&(null==this.root.parentNode||null==t.parentNode||null==n.parentNode))return;const s=document.getSelection();if(null!=s)if(null!=t){this.hasFocus()||this.root.focus({preventScroll:!0});const{native:o}=this.getNativeRange()||{};if(null==o||i||t!==o.startContainer||e!==o.startOffset||n!==o.endContainer||r!==o.endOffset){t instanceof Element&&"BR"===t.tagName&&(e=Array.from(t.parentNode.childNodes).indexOf(t),t=t.parentNode),n instanceof Element&&"BR"===n.tagName&&(r=Array.from(n.parentNode.childNodes).indexOf(n),n=n.parentNode);const i=document.createRange();i.setStart(t,e),i.setEnd(n,r),s.removeAllRanges(),s.addRange(i)}}else s.removeAllRanges(),this.root.blur()}setRange(t){let e=arguments.length>1&&void 0!==arguments[1]&&arguments[1],n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:o.A.sources.API;if("string"==typeof e&&(n=e,e=!1),l.info("setRange",t),null!=t){const n=this.rangeToNative(t);this.setNativeRange(...n,e)}else this.setNativeRange(null);this.update(n)}update(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:o.A.sources.USER;const e=this.lastRange,[n,r]=this.getRange();if(this.lastRange=n,this.lastNative=r,null!=this.lastRange&&(this.savedRange=this.lastRange),!(0,i.A)(e,this.lastRange)){if(!this.composing&&null!=r&&r.native.collapsed&&r.start.node!==this.cursor.textNode){const t=this.cursor.restore();t&&this.setNativeRange(t.startNode,t.startOffset,t.endNode,t.endOffset)}const n=[o.A.events.SELECTION_CHANGE,(0,s.A)(this.lastRange),(0,s.A)(e),t];this.emitter.emit(o.A.events.EDITOR_CHANGE,...n),t!==o.A.sources.SILENT&&this.emitter.emit(...n)}}}},9609:function(t,e){"use strict";class n{static DEFAULTS={modules:{}};static themes={default:n};modules={};constructor(t,e){this.quill=t,this.options=e}init(){Object.keys(this.options.modules).forEach((t=>{null==this.modules[t]&&this.addModule(t)}))}addModule(t){const e=this.quill.constructor.import(`modules/${t}`);return this.modules[t]=new e(this.quill,this.options.modules[t]||{}),this.modules[t]}}e.A=n},8276:function(t,e,n){"use strict";n.d(e,{Hu:function(){return l},gS:function(){return s},qh:function(){return o}});var r=n(6003);const i={scope:r.Scope.BLOCK,whitelist:["right","center","justify"]},s=new r.Attributor("align","align",i),o=new r.ClassAttributor("align","ql-align",i),l=new r.StyleAttributor("align","text-align",i)},9541:function(t,e,n){"use strict";n.d(e,{l:function(){return s},s:function(){return o}});var r=n(6003),i=n(8638);const s=new r.ClassAttributor("background","ql-bg",{scope:r.Scope.INLINE}),o=new i.a2("background","background-color",{scope:r.Scope.INLINE})},9404:function(t,e,n){"use strict";n.d(e,{Ay:function(){return h},Cy:function(){return d},EJ:function(){return u}});var r=n(9698),i=n(3036),s=n(4541),o=n(4850),l=n(5508),a=n(580),c=n(6142);class u extends a.A{static create(t){const e=super.create(t);return e.setAttribute("spellcheck","false"),e}code(t,e){return this.children.map((t=>t.length()<=1?"":t.domNode.innerText)).join("\n").slice(t,t+e)}html(t,e){return`<pre>\n${(0,l.X)(this.code(t,e))}\n</pre>`}}class h extends r.Ay{static TAB=" ";static register(){c.Ay.register(u)}}class d extends o.A{}d.blotName="code",d.tagName="CODE",h.blotName="code-block",h.className="ql-code-block",h.tagName="DIV",u.blotName="code-block-container",u.className="ql-code-block-container",u.tagName="DIV",u.allowedChildren=[h],h.allowedChildren=[l.A,i.A,s.A],h.requiredContainer=u},8638:function(t,e,n){"use strict";n.d(e,{JM:function(){return o},a2:function(){return i},g3:function(){return s}});var r=n(6003);class i extends r.StyleAttributor{value(t){let e=super.value(t);return e.startsWith("rgb(")?(e=e.replace(/^[^\d]+/,"").replace(/[^\d]+$/,""),`#${e.split(",").map((t=>`00${parseInt(t,10).toString(16)}`.slice(-2))).join("")}`):e}}const s=new r.ClassAttributor("color","ql-color",{scope:r.Scope.INLINE}),o=new i("color","color",{scope:r.Scope.INLINE})},7912:function(t,e,n){"use strict";n.d(e,{Mc:function(){return s},VL:function(){return l},sY:function(){return o}});var r=n(6003);const i={scope:r.Scope.BLOCK,whitelist:["rtl"]},s=new r.Attributor("direction","dir",i),o=new r.ClassAttributor("direction","ql-direction",i),l=new r.StyleAttributor("direction","direction",i)},6772:function(t,e,n){"use strict";n.d(e,{q:function(){return s},z:function(){return l}});var r=n(6003);const i={scope:r.Scope.INLINE,whitelist:["serif","monospace"]},s=new r.ClassAttributor("font","ql-font",i);class o extends r.StyleAttributor{value(t){return super.value(t).replace(/["']/g,"")}}const l=new o("font","font-family",i)},664:function(t,e,n){"use strict";n.d(e,{U:function(){return i},r:function(){return s}});var r=n(6003);const i=new r.ClassAttributor("size","ql-size",{scope:r.Scope.INLINE,whitelist:["small","large","huge"]}),s=new r.StyleAttributor("size","font-size",{scope:r.Scope.INLINE,whitelist:["10px","18px","32px"]})},584:function(t,e,n){"use strict";n.d(e,{Ay:function(){return S},hV:function(){return I}});var r=n(6003),i=n(5232),s=n.n(i),o=n(9698),l=n(6078),a=n(4266),c=n(6142),u=n(8276),h=n(9541),d=n(9404),f=n(8638),p=n(7912),g=n(6772),m=n(664),b=n(8123);const y=/font-weight:\s*normal/,v=["P","OL","UL"],A=t=>t&&v.includes(t.tagName),x=/\bmso-list:[^;]*ignore/i,N=/\bmso-list:[^;]*\bl(\d+)/i,E=/\bmso-list:[^;]*\blevel(\d+)/i,w=[function(t){"urn:schemas-microsoft-com:office:word"===t.documentElement.getAttribute("xmlns:w")&&(t=>{const e=Array.from(t.querySelectorAll("[style*=mso-list]")),n=[],r=[];e.forEach((t=>{(t.getAttribute("style")||"").match(x)?n.push(t):r.push(t)})),n.forEach((t=>t.parentNode?.removeChild(t)));const i=t.documentElement.innerHTML,s=r.map((t=>((t,e)=>{const n=t.getAttribute("style"),r=n?.match(N);if(!r)return null;const i=Number(r[1]),s=n?.match(E),o=s?Number(s[1]):1,l=new RegExp(`@list l${i}:level${o}\\s*\\{[^\\}]*mso-level-number-format:\\s*([\\w-]+)`,"i"),a=e.match(l);return{id:i,indent:o,type:a&&"bullet"===a[1]?"bullet":"ordered",element:t}})(t,i))).filter((t=>t));for(;s.length;){const t=[];let e=s.shift();for(;e;)t.push(e),e=s.length&&s[0]?.element===e.element.nextElementSibling&&s[0].id===e.id?s.shift():null;const n=document.createElement("ul");t.forEach((t=>{const e=document.createElement("li");e.setAttribute("data-list",t.type),t.indent>1&&e.setAttribute("class","ql-indent-"+(t.indent-1)),e.innerHTML=t.element.innerHTML,n.appendChild(e)}));const r=t[0]?.element,{parentNode:i}=r??{};r&&i?.replaceChild(n,r),t.slice(1).forEach((t=>{let{element:e}=t;i?.removeChild(e)}))}})(t)},function(t){t.querySelector('[id^="docs-internal-guid-"]')&&((t=>{Array.from(t.querySelectorAll('b[style*="font-weight"]')).filter((t=>t.getAttribute("style")?.match(y))).forEach((e=>{const n=t.createDocumentFragment();n.append(...e.childNodes),e.parentNode?.replaceChild(n,e)}))})(t),(t=>{Array.from(t.querySelectorAll("br")).filter((t=>A(t.previousElementSibling)&&A(t.nextElementSibling))).forEach((t=>{t.parentNode?.removeChild(t)}))})(t))}];const q=(0,l.A)("quill:clipboard"),k=[[Node.TEXT_NODE,function(t,e,n){let r=t.data;if("O:P"===t.parentElement?.tagName)return e.insert(r.trim());if(!R(t)){if(0===r.trim().length&&r.includes("\n")&&!function(t,e){return t.previousElementSibling&&t.nextElementSibling&&!j(t.previousElementSibling,e)&&!j(t.nextElementSibling,e)}(t,n))return e;const i=(t,e)=>{const n=e.replace(/[^\u00a0]/g,"");return n.length<1&&t?" ":n};r=r.replace(/\r\n/g," ").replace(/\n/g," "),r=r.replace(/\s\s+/g,i.bind(i,!0)),(null==t.previousSibling&&null!=t.parentElement&&j(t.parentElement,n)||t.previousSibling instanceof Element&&j(t.previousSibling,n))&&(r=r.replace(/^\s+/,i.bind(i,!1))),(null==t.nextSibling&&null!=t.parentElement&&j(t.parentElement,n)||t.nextSibling instanceof Element&&j(t.nextSibling,n))&&(r=r.replace(/\s+$/,i.bind(i,!1)))}return e.insert(r)}],[Node.TEXT_NODE,M],["br",function(t,e){return T(e,"\n")||e.insert("\n"),e}],[Node.ELEMENT_NODE,M],[Node.ELEMENT_NODE,function(t,e,n){const i=n.query(t);if(null==i)return e;if(i.prototype instanceof r.EmbedBlot){const e={},r=i.value(t);if(null!=r)return e[i.blotName]=r,(new(s())).insert(e,i.formats(t,n))}else if(i.prototype instanceof r.BlockBlot&&!T(e,"\n")&&e.insert("\n"),"blotName"in i&&"formats"in i&&"function"==typeof i.formats)return O(e,i.blotName,i.formats(t,n),n);return e}],[Node.ELEMENT_NODE,function(t,e,n){const i=r.Attributor.keys(t),s=r.ClassAttributor.keys(t),o=r.StyleAttributor.keys(t),l={};return i.concat(s).concat(o).forEach((e=>{let i=n.query(e,r.Scope.ATTRIBUTE);null!=i&&(l[i.attrName]=i.value(t),l[i.attrName])||(i=_[e],null==i||i.attrName!==e&&i.keyName!==e||(l[i.attrName]=i.value(t)||void 0),i=L[e],null==i||i.attrName!==e&&i.keyName!==e||(i=L[e],l[i.attrName]=i.value(t)||void 0))})),Object.entries(l).reduce(((t,e)=>{let[r,i]=e;return O(t,r,i,n)}),e)}],[Node.ELEMENT_NODE,function(t,e,n){const r={},i=t.style||{};return"italic"===i.fontStyle&&(r.italic=!0),"underline"===i.textDecoration&&(r.underline=!0),"line-through"===i.textDecoration&&(r.strike=!0),(i.fontWeight?.startsWith("bold")||parseInt(i.fontWeight,10)>=700)&&(r.bold=!0),e=Object.entries(r).reduce(((t,e)=>{let[r,i]=e;return O(t,r,i,n)}),e),parseFloat(i.textIndent||0)>0?(new(s())).insert("\t").concat(e):e}],["li",function(t,e,n){const r=n.query(t);if(null==r||"list"!==r.blotName||!T(e,"\n"))return e;let i=-1,o=t.parentNode;for(;null!=o;)["OL","UL"].includes(o.tagName)&&(i+=1),o=o.parentNode;return i<=0?e:e.reduce(((t,e)=>e.insert?e.attributes&&"number"==typeof e.attributes.indent?t.push(e):t.insert(e.insert,{indent:i,...e.attributes||{}}):t),new(s()))}],["ol, ul",function(t,e,n){const r=t;let i="OL"===r.tagName?"ordered":"bullet";const s=r.getAttribute("data-checked");return s&&(i="true"===s?"checked":"unchecked"),O(e,"list",i,n)}],["pre",function(t,e,n){const r=n.query("code-block");return O(e,"code-block",!r||!("formats"in r)||"function"!=typeof r.formats||r.formats(t,n),n)}],["tr",function(t,e,n){const r="TABLE"===t.parentElement?.tagName?t.parentElement:t.parentElement?.parentElement;return null!=r?O(e,"table",Array.from(r.querySelectorAll("tr")).indexOf(t)+1,n):e}],["b",B("bold")],["i",B("italic")],["strike",B("strike")],["style",function(){return new(s())}]],_=[u.gS,p.Mc].reduce(((t,e)=>(t[e.keyName]=e,t)),{}),L=[u.Hu,h.s,f.JM,p.VL,g.z,m.r].reduce(((t,e)=>(t[e.keyName]=e,t)),{});class S extends a.A{static DEFAULTS={matchers:[]};constructor(t,e){super(t,e),this.quill.root.addEventListener("copy",(t=>this.onCaptureCopy(t,!1))),this.quill.root.addEventListener("cut",(t=>this.onCaptureCopy(t,!0))),this.quill.root.addEventListener("paste",this.onCapturePaste.bind(this)),this.matchers=[],k.concat(this.options.matchers??[]).forEach((t=>{let[e,n]=t;this.addMatcher(e,n)}))}addMatcher(t,e){this.matchers.push([t,e])}convert(t){let{html:e,text:n}=t,r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};if(r[d.Ay.blotName])return(new(s())).insert(n||"",{[d.Ay.blotName]:r[d.Ay.blotName]});if(!e)return(new(s())).insert(n||"",r);const i=this.convertHTML(e);return T(i,"\n")&&(null==i.ops[i.ops.length-1].attributes||r.table)?i.compose((new(s())).retain(i.length()-1).delete(1)):i}normalizeHTML(t){(t=>{t.documentElement&&w.forEach((e=>{e(t)}))})(t)}convertHTML(t){const e=(new DOMParser).parseFromString(t,"text/html");this.normalizeHTML(e);const n=e.body,r=new WeakMap,[i,s]=this.prepareMatching(n,r);return I(this.quill.scroll,n,i,s,r)}dangerouslyPasteHTML(t,e){let n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:c.Ay.sources.API;if("string"==typeof t){const n=this.convert({html:t,text:""});this.quill.setContents(n,e),this.quill.setSelection(0,c.Ay.sources.SILENT)}else{const r=this.convert({html:e,text:""});this.quill.updateContents((new(s())).retain(t).concat(r),n),this.quill.setSelection(t+r.length(),c.Ay.sources.SILENT)}}onCaptureCopy(t){let e=arguments.length>1&&void 0!==arguments[1]&&arguments[1];if(t.defaultPrevented)return;t.preventDefault();const[n]=this.quill.selection.getRange();if(null==n)return;const{html:r,text:i}=this.onCopy(n,e);t.clipboardData?.setData("text/plain",i),t.clipboardData?.setData("text/html",r),e&&(0,b.Xo)({range:n,quill:this.quill})}normalizeURIList(t){return t.split(/\r?\n/).filter((t=>"#"!==t[0])).join("\n")}onCapturePaste(t){if(t.defaultPrevented||!this.quill.isEnabled())return;t.preventDefault();const e=this.quill.getSelection(!0);if(null==e)return;const n=t.clipboardData?.getData("text/html");let r=t.clipboardData?.getData("text/plain");if(!n&&!r){const e=t.clipboardData?.getData("text/uri-list");e&&(r=this.normalizeURIList(e))}const i=Array.from(t.clipboardData?.files||[]);if(!n&&i.length>0)this.quill.uploader.upload(e,i);else{if(n&&i.length>0){const t=(new DOMParser).parseFromString(n,"text/html");if(1===t.body.childElementCount&&"IMG"===t.body.firstElementChild?.tagName)return void this.quill.uploader.upload(e,i)}this.onPaste(e,{html:n,text:r})}}onCopy(t){const e=this.quill.getText(t);return{html:this.quill.getSemanticHTML(t),text:e}}onPaste(t,e){let{text:n,html:r}=e;const i=this.quill.getFormat(t.index),o=this.convert({text:n,html:r},i);q.log("onPaste",o,{text:n,html:r});const l=(new(s())).retain(t.index).delete(t.length).concat(o);this.quill.updateContents(l,c.Ay.sources.USER),this.quill.setSelection(l.length()-t.length,c.Ay.sources.SILENT),this.quill.scrollSelectionIntoView()}prepareMatching(t,e){const n=[],r=[];return this.matchers.forEach((i=>{const[s,o]=i;switch(s){case Node.TEXT_NODE:r.push(o);break;case Node.ELEMENT_NODE:n.push(o);break;default:Array.from(t.querySelectorAll(s)).forEach((t=>{if(e.has(t)){const n=e.get(t);n?.push(o)}else e.set(t,[o])}))}})),[n,r]}}function O(t,e,n,r){return r.query(e)?t.reduce(((t,r)=>{if(!r.insert)return t;if(r.attributes&&r.attributes[e])return t.push(r);const i=n?{[e]:n}:{};return t.insert(r.insert,{...i,...r.attributes})}),new(s())):t}function T(t,e){let n="";for(let r=t.ops.length-1;r>=0&&n.length<e.length;--r){const e=t.ops[r];if("string"!=typeof e.insert)break;n=e.insert+n}return n.slice(-1*e.length)===e}function j(t,e){if(!(t instanceof Element))return!1;const n=e.query(t);return!(n&&n.prototype instanceof r.EmbedBlot)&&["address","article","blockquote","canvas","dd","div","dl","dt","fieldset","figcaption","figure","footer","form","h1","h2","h3","h4","h5","h6","header","iframe","li","main","nav","ol","output","p","pre","section","table","td","tr","ul","video"].includes(t.tagName.toLowerCase())}const C=new WeakMap;function R(t){return null!=t&&(C.has(t)||("PRE"===t.tagName?C.set(t,!0):C.set(t,R(t.parentNode))),C.get(t))}function I(t,e,n,r,i){return e.nodeType===e.TEXT_NODE?r.reduce(((n,r)=>r(e,n,t)),new(s())):e.nodeType===e.ELEMENT_NODE?Array.from(e.childNodes||[]).reduce(((s,o)=>{let l=I(t,o,n,r,i);return o.nodeType===e.ELEMENT_NODE&&(l=n.reduce(((e,n)=>n(o,e,t)),l),l=(i.get(o)||[]).reduce(((e,n)=>n(o,e,t)),l)),s.concat(l)}),new(s())):new(s())}function B(t){return(e,n,r)=>O(n,t,!0,r)}function M(t,e,n){if(!T(e,"\n")){if(j(t,n)&&(t.childNodes.length>0||t instanceof HTMLParagraphElement))return e.insert("\n");if(e.length()>0&&t.nextSibling){let r=t.nextSibling;for(;null!=r;){if(j(r,n))return e.insert("\n");const t=n.query(r);if(t&&t.prototype instanceof o.zo)return e.insert("\n");r=r.firstChild}}}return e}},8123:function(t,e,n){"use strict";n.d(e,{Ay:function(){return f},Xo:function(){return v}});var r=n(5123),i=n(3707),s=n(5232),o=n.n(s),l=n(6003),a=n(6142),c=n(6078),u=n(4266);const h=(0,c.A)("quill:keyboard"),d=/Mac/i.test(navigator.platform)?"metaKey":"ctrlKey";class f extends u.A{static match(t,e){return!["altKey","ctrlKey","metaKey","shiftKey"].some((n=>!!e[n]!==t[n]&&null!==e[n]))&&(e.key===t.key||e.key===t.which)}constructor(t,e){super(t,e),this.bindings={},Object.keys(this.options.bindings).forEach((t=>{this.options.bindings[t]&&this.addBinding(this.options.bindings[t])})),this.addBinding({key:"Enter",shiftKey:null},this.handleEnter),this.addBinding({key:"Enter",metaKey:null,ctrlKey:null,altKey:null},(()=>{})),/Firefox/i.test(navigator.userAgent)?(this.addBinding({key:"Backspace"},{collapsed:!0},this.handleBackspace),this.addBinding({key:"Delete"},{collapsed:!0},this.handleDelete)):(this.addBinding({key:"Backspace"},{collapsed:!0,prefix:/^.?$/},this.handleBackspace),this.addBinding({key:"Delete"},{collapsed:!0,suffix:/^.?$/},this.handleDelete)),this.addBinding({key:"Backspace"},{collapsed:!1},this.handleDeleteRange),this.addBinding({key:"Delete"},{collapsed:!1},this.handleDeleteRange),this.addBinding({key:"Backspace",altKey:null,ctrlKey:null,metaKey:null,shiftKey:null},{collapsed:!0,offset:0},this.handleBackspace),this.listen()}addBinding(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{},n=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{};const r=function(t){if("string"==typeof t||"number"==typeof t)t={key:t};else{if("object"!=typeof t)return null;t=(0,i.A)(t)}return t.shortKey&&(t[d]=t.shortKey,delete t.shortKey),t}(t);null!=r?("function"==typeof e&&(e={handler:e}),"function"==typeof n&&(n={handler:n}),(Array.isArray(r.key)?r.key:[r.key]).forEach((t=>{const i={...r,key:t,...e,...n};this.bindings[i.key]=this.bindings[i.key]||[],this.bindings[i.key].push(i)}))):h.warn("Attempted to add invalid keyboard binding",r)}listen(){this.quill.root.addEventListener("keydown",(t=>{if(t.defaultPrevented||t.isComposing)return;if(229===t.keyCode&&("Enter"===t.key||"Backspace"===t.key))return;const e=(this.bindings[t.key]||[]).concat(this.bindings[t.which]||[]).filter((e=>f.match(t,e)));if(0===e.length)return;const n=a.Ay.find(t.target,!0);if(n&&n.scroll!==this.quill.scroll)return;const i=this.quill.getSelection();if(null==i||!this.quill.hasFocus())return;const[s,o]=this.quill.getLine(i.index),[c,u]=this.quill.getLeaf(i.index),[h,d]=0===i.length?[c,u]:this.quill.getLeaf(i.index+i.length),p=c instanceof l.TextBlot?c.value().slice(0,u):"",g=h instanceof l.TextBlot?h.value().slice(d):"",m={collapsed:0===i.length,empty:0===i.length&&s.length()<=1,format:this.quill.getFormat(i),line:s,offset:o,prefix:p,suffix:g,event:t};e.some((t=>{if(null!=t.collapsed&&t.collapsed!==m.collapsed)return!1;if(null!=t.empty&&t.empty!==m.empty)return!1;if(null!=t.offset&&t.offset!==m.offset)return!1;if(Array.isArray(t.format)){if(t.format.every((t=>null==m.format[t])))return!1}else if("object"==typeof t.format&&!Object.keys(t.format).every((e=>!0===t.format[e]?null!=m.format[e]:!1===t.format[e]?null==m.format[e]:(0,r.A)(t.format[e],m.format[e]))))return!1;return!(null!=t.prefix&&!t.prefix.test(m.prefix)||null!=t.suffix&&!t.suffix.test(m.suffix)||!0===t.handler.call(this,i,m,t))}))&&t.preventDefault()}))}handleBackspace(t,e){const n=/[\uD800-\uDBFF][\uDC00-\uDFFF]$/.test(e.prefix)?2:1;if(0===t.index||this.quill.getLength()<=1)return;let r={};const[i]=this.quill.getLine(t.index);let l=(new(o())).retain(t.index-n).delete(n);if(0===e.offset){const[e]=this.quill.getLine(t.index-1);if(e&&!("block"===e.statics.blotName&&e.length()<=1)){const e=i.formats(),n=this.quill.getFormat(t.index-1,1);if(r=s.AttributeMap.diff(e,n)||{},Object.keys(r).length>0){const e=(new(o())).retain(t.index+i.length()-2).retain(1,r);l=l.compose(e)}}}this.quill.updateContents(l,a.Ay.sources.USER),this.quill.focus()}handleDelete(t,e){const n=/^[\uD800-\uDBFF][\uDC00-\uDFFF]/.test(e.suffix)?2:1;if(t.index>=this.quill.getLength()-n)return;let r={};const[i]=this.quill.getLine(t.index);let l=(new(o())).retain(t.index).delete(n);if(e.offset>=i.length()-1){const[e]=this.quill.getLine(t.index+1);if(e){const n=i.formats(),o=this.quill.getFormat(t.index,1);r=s.AttributeMap.diff(n,o)||{},Object.keys(r).length>0&&(l=l.retain(e.length()-1).retain(1,r))}}this.quill.updateContents(l,a.Ay.sources.USER),this.quill.focus()}handleDeleteRange(t){v({range:t,quill:this.quill}),this.quill.focus()}handleEnter(t,e){const n=Object.keys(e.format).reduce(((t,n)=>(this.quill.scroll.query(n,l.Scope.BLOCK)&&!Array.isArray(e.format[n])&&(t[n]=e.format[n]),t)),{}),r=(new(o())).retain(t.index).delete(t.length).insert("\n",n);this.quill.updateContents(r,a.Ay.sources.USER),this.quill.setSelection(t.index+1,a.Ay.sources.SILENT),this.quill.focus()}}const p={bindings:{bold:b("bold"),italic:b("italic"),underline:b("underline"),indent:{key:"Tab",format:["blockquote","indent","list"],handler(t,e){return!(!e.collapsed||0===e.offset)||(this.quill.format("indent","+1",a.Ay.sources.USER),!1)}},outdent:{key:"Tab",shiftKey:!0,format:["blockquote","indent","list"],handler(t,e){return!(!e.collapsed||0===e.offset)||(this.quill.format("indent","-1",a.Ay.sources.USER),!1)}},"outdent backspace":{key:"Backspace",collapsed:!0,shiftKey:null,metaKey:null,ctrlKey:null,altKey:null,format:["indent","list"],offset:0,handler(t,e){null!=e.format.indent?this.quill.format("indent","-1",a.Ay.sources.USER):null!=e.format.list&&this.quill.format("list",!1,a.Ay.sources.USER)}},"indent code-block":g(!0),"outdent code-block":g(!1),"remove tab":{key:"Tab",shiftKey:!0,collapsed:!0,prefix:/\t$/,handler(t){this.quill.deleteText(t.index-1,1,a.Ay.sources.USER)}},tab:{key:"Tab",handler(t,e){if(e.format.table)return!0;this.quill.history.cutoff();const n=(new(o())).retain(t.index).delete(t.length).insert("\t");return this.quill.updateContents(n,a.Ay.sources.USER),this.quill.history.cutoff(),this.quill.setSelection(t.index+1,a.Ay.sources.SILENT),!1}},"blockquote empty enter":{key:"Enter",collapsed:!0,format:["blockquote"],empty:!0,handler(){this.quill.format("blockquote",!1,a.Ay.sources.USER)}},"list empty enter":{key:"Enter",collapsed:!0,format:["list"],empty:!0,handler(t,e){const n={list:!1};e.format.indent&&(n.indent=!1),this.quill.formatLine(t.index,t.length,n,a.Ay.sources.USER)}},"checklist enter":{key:"Enter",collapsed:!0,format:{list:"checked"},handler(t){const[e,n]=this.quill.getLine(t.index),r={...e.formats(),list:"checked"},i=(new(o())).retain(t.index).insert("\n",r).retain(e.length()-n-1).retain(1,{list:"unchecked"});this.quill.updateContents(i,a.Ay.sources.USER),this.quill.setSelection(t.index+1,a.Ay.sources.SILENT),this.quill.scrollSelectionIntoView()}},"header enter":{key:"Enter",collapsed:!0,format:["header"],suffix:/^$/,handler(t,e){const[n,r]=this.quill.getLine(t.index),i=(new(o())).retain(t.index).insert("\n",e.format).retain(n.length()-r-1).retain(1,{header:null});this.quill.updateContents(i,a.Ay.sources.USER),this.quill.setSelection(t.index+1,a.Ay.sources.SILENT),this.quill.scrollSelectionIntoView()}},"table backspace":{key:"Backspace",format:["table"],collapsed:!0,offset:0,handler(){}},"table delete":{key:"Delete",format:["table"],collapsed:!0,suffix:/^$/,handler(){}},"table enter":{key:"Enter",shiftKey:null,format:["table"],handler(t){const e=this.quill.getModule("table");if(e){const[n,r,i,s]=e.getTable(t),l=function(t,e,n,r){return null==e.prev&&null==e.next?null==n.prev&&null==n.next?0===r?-1:1:null==n.prev?-1:1:null==e.prev?-1:null==e.next?1:null}(0,r,i,s);if(null==l)return;let c=n.offset();if(l<0){const e=(new(o())).retain(c).insert("\n");this.quill.updateContents(e,a.Ay.sources.USER),this.quill.setSelection(t.index+1,t.length,a.Ay.sources.SILENT)}else if(l>0){c+=n.length();const t=(new(o())).retain(c).insert("\n");this.quill.updateContents(t,a.Ay.sources.USER),this.quill.setSelection(c,a.Ay.sources.USER)}}}},"table tab":{key:"Tab",shiftKey:null,format:["table"],handler(t,e){const{event:n,line:r}=e,i=r.offset(this.quill.scroll);n.shiftKey?this.quill.setSelection(i-1,a.Ay.sources.USER):this.quill.setSelection(i+r.length(),a.Ay.sources.USER)}},"list autofill":{key:" ",shiftKey:null,collapsed:!0,format:{"code-block":!1,blockquote:!1,table:!1},prefix:/^\s*?(\d+\.|-|\*|\[ ?\]|\[x\])$/,handler(t,e){if(null==this.quill.scroll.query("list"))return!0;const{length:n}=e.prefix,[r,i]=this.quill.getLine(t.index);if(i>n)return!0;let s;switch(e.prefix.trim()){case"[]":case"[ ]":s="unchecked";break;case"[x]":s="checked";break;case"-":case"*":s="bullet";break;default:s="ordered"}this.quill.insertText(t.index," ",a.Ay.sources.USER),this.quill.history.cutoff();const l=(new(o())).retain(t.index-i).delete(n+1).retain(r.length()-2-i).retain(1,{list:s});return this.quill.updateContents(l,a.Ay.sources.USER),this.quill.history.cutoff(),this.quill.setSelection(t.index-n,a.Ay.sources.SILENT),!1}},"code exit":{key:"Enter",collapsed:!0,format:["code-block"],prefix:/^$/,suffix:/^\s*$/,handler(t){const[e,n]=this.quill.getLine(t.index);let r=2,i=e;for(;null!=i&&i.length()<=1&&i.formats()["code-block"];)if(i=i.prev,r-=1,r<=0){const r=(new(o())).retain(t.index+e.length()-n-2).retain(1,{"code-block":null}).delete(1);return this.quill.updateContents(r,a.Ay.sources.USER),this.quill.setSelection(t.index-1,a.Ay.sources.SILENT),!1}return!0}},"embed left":m("ArrowLeft",!1),"embed left shift":m("ArrowLeft",!0),"embed right":m("ArrowRight",!1),"embed right shift":m("ArrowRight",!0),"table down":y(!1),"table up":y(!0)}};function g(t){return{key:"Tab",shiftKey:!t,format:{"code-block":!0},handler(e,n){let{event:r}=n;const i=this.quill.scroll.query("code-block"),{TAB:s}=i;if(0===e.length&&!r.shiftKey)return this.quill.insertText(e.index,s,a.Ay.sources.USER),void this.quill.setSelection(e.index+s.length,a.Ay.sources.SILENT);const o=0===e.length?this.quill.getLines(e.index,1):this.quill.getLines(e);let{index:l,length:c}=e;o.forEach(((e,n)=>{t?(e.insertAt(0,s),0===n?l+=s.length:c+=s.length):e.domNode.textContent.startsWith(s)&&(e.deleteAt(0,s.length),0===n?l-=s.length:c-=s.length)})),this.quill.update(a.Ay.sources.USER),this.quill.setSelection(l,c,a.Ay.sources.SILENT)}}}function m(t,e){return{key:t,shiftKey:e,altKey:null,["ArrowLeft"===t?"prefix":"suffix"]:/^$/,handler(n){let{index:r}=n;"ArrowRight"===t&&(r+=n.length+1);const[i]=this.quill.getLeaf(r);return!(i instanceof l.EmbedBlot&&("ArrowLeft"===t?e?this.quill.setSelection(n.index-1,n.length+1,a.Ay.sources.USER):this.quill.setSelection(n.index-1,a.Ay.sources.USER):e?this.quill.setSelection(n.index,n.length+1,a.Ay.sources.USER):this.quill.setSelection(n.index+n.length+1,a.Ay.sources.USER),1))}}}function b(t){return{key:t[0],shortKey:!0,handler(e,n){this.quill.format(t,!n.format[t],a.Ay.sources.USER)}}}function y(t){return{key:t?"ArrowUp":"ArrowDown",collapsed:!0,format:["table"],handler(e,n){const r=t?"prev":"next",i=n.line,s=i.parent[r];if(null!=s){if("table-row"===s.statics.blotName){let t=s.children.head,e=i;for(;null!=e.prev;)e=e.prev,t=t.next;const r=t.offset(this.quill.scroll)+Math.min(n.offset,t.length()-1);this.quill.setSelection(r,0,a.Ay.sources.USER)}}else{const e=i.table()[r];null!=e&&(t?this.quill.setSelection(e.offset(this.quill.scroll)+e.length()-1,0,a.Ay.sources.USER):this.quill.setSelection(e.offset(this.quill.scroll),0,a.Ay.sources.USER))}return!1}}}function v(t){let{quill:e,range:n}=t;const r=e.getLines(n);let i={};if(r.length>1){const t=r[0].formats(),e=r[r.length-1].formats();i=s.AttributeMap.diff(e,t)||{}}e.deleteText(n,a.Ay.sources.USER),Object.keys(i).length>0&&e.formatLine(n.index,1,i,a.Ay.sources.USER),e.setSelection(n.index,a.Ay.sources.SILENT)}f.DEFAULTS=p},8920:function(t){"use strict";var e=Object.prototype.hasOwnProperty,n="~";function r(){}function i(t,e,n){this.fn=t,this.context=e,this.once=n||!1}function s(t,e,r,s,o){if("function"!=typeof r)throw new TypeError("The listener must be a function");var l=new i(r,s||t,o),a=n?n+e:e;return t._events[a]?t._events[a].fn?t._events[a]=[t._events[a],l]:t._events[a].push(l):(t._events[a]=l,t._eventsCount++),t}function o(t,e){0==--t._eventsCount?t._events=new r:delete t._events[e]}function l(){this._events=new r,this._eventsCount=0}Object.create&&(r.prototype=Object.create(null),(new r).__proto__||(n=!1)),l.prototype.eventNames=function(){var t,r,i=[];if(0===this._eventsCount)return i;for(r in t=this._events)e.call(t,r)&&i.push(n?r.slice(1):r);return Object.getOwnPropertySymbols?i.concat(Object.getOwnPropertySymbols(t)):i},l.prototype.listeners=function(t){var e=n?n+t:t,r=this._events[e];if(!r)return[];if(r.fn)return[r.fn];for(var i=0,s=r.length,o=new Array(s);i<s;i++)o[i]=r[i].fn;return o},l.prototype.listenerCount=function(t){var e=n?n+t:t,r=this._events[e];return r?r.fn?1:r.length:0},l.prototype.emit=function(t,e,r,i,s,o){var l=n?n+t:t;if(!this._events[l])return!1;var a,c,u=this._events[l],h=arguments.length;if(u.fn){switch(u.once&&this.removeListener(t,u.fn,void 0,!0),h){case 1:return u.fn.call(u.context),!0;case 2:return u.fn.call(u.context,e),!0;case 3:return u.fn.call(u.context,e,r),!0;case 4:return u.fn.call(u.context,e,r,i),!0;case 5:return u.fn.call(u.context,e,r,i,s),!0;case 6:return u.fn.call(u.context,e,r,i,s,o),!0}for(c=1,a=new Array(h-1);c<h;c++)a[c-1]=arguments[c];u.fn.apply(u.context,a)}else{var d,f=u.length;for(c=0;c<f;c++)switch(u[c].once&&this.removeListener(t,u[c].fn,void 0,!0),h){case 1:u[c].fn.call(u[c].context);break;case 2:u[c].fn.call(u[c].context,e);break;case 3:u[c].fn.call(u[c].context,e,r);break;case 4:u[c].fn.call(u[c].context,e,r,i);break;default:if(!a)for(d=1,a=new Array(h-1);d<h;d++)a[d-1]=arguments[d];u[c].fn.apply(u[c].context,a)}}return!0},l.prototype.on=function(t,e,n){return s(this,t,e,n,!1)},l.prototype.once=function(t,e,n){return s(this,t,e,n,!0)},l.prototype.removeListener=function(t,e,r,i){var s=n?n+t:t;if(!this._events[s])return this;if(!e)return o(this,s),this;var l=this._events[s];if(l.fn)l.fn!==e||i&&!l.once||r&&l.context!==r||o(this,s);else{for(var a=0,c=[],u=l.length;a<u;a++)(l[a].fn!==e||i&&!l[a].once||r&&l[a].context!==r)&&c.push(l[a]);c.length?this._events[s]=1===c.length?c[0]:c:o(this,s)}return this},l.prototype.removeAllListeners=function(t){var e;return t?(e=n?n+t:t,this._events[e]&&o(this,e)):(this._events=new r,this._eventsCount=0),this},l.prototype.off=l.prototype.removeListener,l.prototype.addListener=l.prototype.on,l.prefixed=n,l.EventEmitter=l,t.exports=l},5090:function(t){var e=-1,n=1,r=0;function i(t,g,m,b,y){if(t===g)return t?[[r,t]]:[];if(null!=m){var A=function(t,e,n){var r="number"==typeof n?{index:n,length:0}:n.oldRange,i="number"==typeof n?null:n.newRange,s=t.length,o=e.length;if(0===r.length&&(null===i||0===i.length)){var l=r.index,a=t.slice(0,l),c=t.slice(l),u=i?i.index:null,h=l+o-s;if((null===u||u===h)&&!(h<0||h>o)){var d=e.slice(0,h);if((g=e.slice(h))===c){var f=Math.min(l,h);if((b=a.slice(0,f))===(A=d.slice(0,f)))return v(b,a.slice(f),d.slice(f),c)}}if(null===u||u===l){var p=l,g=(d=e.slice(0,p),e.slice(p));if(d===a){var m=Math.min(s-p,o-p);if((y=c.slice(c.length-m))===(x=g.slice(g.length-m)))return v(a,c.slice(0,c.length-m),g.slice(0,g.length-m),y)}}}if(r.length>0&&i&&0===i.length){var b=t.slice(0,r.index),y=t.slice(r.index+r.length);if(!(o<(f=b.length)+(m=y.length))){var A=e.slice(0,f),x=e.slice(o-m);if(b===A&&y===x)return v(b,t.slice(f,s-m),e.slice(f,o-m),y)}}return null}(t,g,m);if(A)return A}var x=o(t,g),N=t.substring(0,x);x=a(t=t.substring(x),g=g.substring(x));var E=t.substring(t.length-x),w=function(t,l){var c;if(!t)return[[n,l]];if(!l)return[[e,t]];var u=t.length>l.length?t:l,h=t.length>l.length?l:t,d=u.indexOf(h);if(-1!==d)return c=[[n,u.substring(0,d)],[r,h],[n,u.substring(d+h.length)]],t.length>l.length&&(c[0][0]=c[2][0]=e),c;if(1===h.length)return[[e,t],[n,l]];var f=function(t,e){var n=t.length>e.length?t:e,r=t.length>e.length?e:t;if(n.length<4||2*r.length<n.length)return null;function i(t,e,n){for(var r,i,s,l,c=t.substring(n,n+Math.floor(t.length/4)),u=-1,h="";-1!==(u=e.indexOf(c,u+1));){var d=o(t.substring(n),e.substring(u)),f=a(t.substring(0,n),e.substring(0,u));h.length<f+d&&(h=e.substring(u-f,u)+e.substring(u,u+d),r=t.substring(0,n-f),i=t.substring(n+d),s=e.substring(0,u-f),l=e.substring(u+d))}return 2*h.length>=t.length?[r,i,s,l,h]:null}var s,l,c,u,h,d=i(n,r,Math.ceil(n.length/4)),f=i(n,r,Math.ceil(n.length/2));return d||f?(s=f?d&&d[4].length>f[4].length?d:f:d,t.length>e.length?(l=s[0],c=s[1],u=s[2],h=s[3]):(u=s[0],h=s[1],l=s[2],c=s[3]),[l,c,u,h,s[4]]):null}(t,l);if(f){var p=f[0],g=f[1],m=f[2],b=f[3],y=f[4],v=i(p,m),A=i(g,b);return v.concat([[r,y]],A)}return function(t,r){for(var i=t.length,o=r.length,l=Math.ceil((i+o)/2),a=l,c=2*l,u=new Array(c),h=new Array(c),d=0;d<c;d++)u[d]=-1,h[d]=-1;u[a+1]=0,h[a+1]=0;for(var f=i-o,p=f%2!=0,g=0,m=0,b=0,y=0,v=0;v<l;v++){for(var A=-v+g;A<=v-m;A+=2){for(var x=a+A,N=(_=A===-v||A!==v&&u[x-1]<u[x+1]?u[x+1]:u[x-1]+1)-A;_<i&&N<o&&t.charAt(_)===r.charAt(N);)_++,N++;if(u[x]=_,_>i)m+=2;else if(N>o)g+=2;else if(p&&(q=a+f-A)>=0&&q<c&&-1!==h[q]&&_>=(w=i-h[q]))return s(t,r,_,N)}for(var E=-v+b;E<=v-y;E+=2){for(var w,q=a+E,k=(w=E===-v||E!==v&&h[q-1]<h[q+1]?h[q+1]:h[q-1]+1)-E;w<i&&k<o&&t.charAt(i-w-1)===r.charAt(o-k-1);)w++,k++;if(h[q]=w,w>i)y+=2;else if(k>o)b+=2;else if(!p){var _;if((x=a+f-E)>=0&&x<c&&-1!==u[x])if(N=a+(_=u[x])-x,_>=(w=i-w))return s(t,r,_,N)}}}return[[e,t],[n,r]]}(t,l)}(t=t.substring(0,t.length-x),g=g.substring(0,g.length-x));return N&&w.unshift([r,N]),E&&w.push([r,E]),p(w,y),b&&function(t){for(var i=!1,s=[],o=0,g=null,m=0,b=0,y=0,v=0,A=0;m<t.length;)t[m][0]==r?(s[o++]=m,b=v,y=A,v=0,A=0,g=t[m][1]):(t[m][0]==n?v+=t[m][1].length:A+=t[m][1].length,g&&g.length<=Math.max(b,y)&&g.length<=Math.max(v,A)&&(t.splice(s[o-1],0,[e,g]),t[s[o-1]+1][0]=n,o--,m=--o>0?s[o-1]:-1,b=0,y=0,v=0,A=0,g=null,i=!0)),m++;for(i&&p(t),function(t){function e(t,e){if(!t||!e)return 6;var n=t.charAt(t.length-1),r=e.charAt(0),i=n.match(c),s=r.match(c),o=i&&n.match(u),l=s&&r.match(u),a=o&&n.match(h),p=l&&r.match(h),g=a&&t.match(d),m=p&&e.match(f);return g||m?5:a||p?4:i&&!o&&l?3:o||l?2:i||s?1:0}for(var n=1;n<t.length-1;){if(t[n-1][0]==r&&t[n+1][0]==r){var i=t[n-1][1],s=t[n][1],o=t[n+1][1],l=a(i,s);if(l){var p=s.substring(s.length-l);i=i.substring(0,i.length-l),s=p+s.substring(0,s.length-l),o=p+o}for(var g=i,m=s,b=o,y=e(i,s)+e(s,o);s.charAt(0)===o.charAt(0);){i+=s.charAt(0),s=s.substring(1)+o.charAt(0),o=o.substring(1);var v=e(i,s)+e(s,o);v>=y&&(y=v,g=i,m=s,b=o)}t[n-1][1]!=g&&(g?t[n-1][1]=g:(t.splice(n-1,1),n--),t[n][1]=m,b?t[n+1][1]=b:(t.splice(n+1,1),n--))}n++}}(t),m=1;m<t.length;){if(t[m-1][0]==e&&t[m][0]==n){var x=t[m-1][1],N=t[m][1],E=l(x,N),w=l(N,x);E>=w?(E>=x.length/2||E>=N.length/2)&&(t.splice(m,0,[r,N.substring(0,E)]),t[m-1][1]=x.substring(0,x.length-E),t[m+1][1]=N.substring(E),m++):(w>=x.length/2||w>=N.length/2)&&(t.splice(m,0,[r,x.substring(0,w)]),t[m-1][0]=n,t[m-1][1]=N.substring(0,N.length-w),t[m+1][0]=e,t[m+1][1]=x.substring(w),m++),m++}m++}}(w),w}function s(t,e,n,r){var s=t.substring(0,n),o=e.substring(0,r),l=t.substring(n),a=e.substring(r),c=i(s,o),u=i(l,a);return c.concat(u)}function o(t,e){if(!t||!e||t.charAt(0)!==e.charAt(0))return 0;for(var n=0,r=Math.min(t.length,e.length),i=r,s=0;n<i;)t.substring(s,i)==e.substring(s,i)?s=n=i:r=i,i=Math.floor((r-n)/2+n);return g(t.charCodeAt(i-1))&&i--,i}function l(t,e){var n=t.length,r=e.length;if(0==n||0==r)return 0;n>r?t=t.substring(n-r):n<r&&(e=e.substring(0,n));var i=Math.min(n,r);if(t==e)return i;for(var s=0,o=1;;){var l=t.substring(i-o),a=e.indexOf(l);if(-1==a)return s;o+=a,0!=a&&t.substring(i-o)!=e.substring(0,o)||(s=o,o++)}}function a(t,e){if(!t||!e||t.slice(-1)!==e.slice(-1))return 0;for(var n=0,r=Math.min(t.length,e.length),i=r,s=0;n<i;)t.substring(t.length-i,t.length-s)==e.substring(e.length-i,e.length-s)?s=n=i:r=i,i=Math.floor((r-n)/2+n);return m(t.charCodeAt(t.length-i))&&i--,i}var c=/[^a-zA-Z0-9]/,u=/\s/,h=/[\r\n]/,d=/\n\r?\n$/,f=/^\r?\n\r?\n/;function p(t,i){t.push([r,""]);for(var s,l=0,c=0,u=0,h="",d="";l<t.length;)if(l<t.length-1&&!t[l][1])t.splice(l,1);else switch(t[l][0]){case n:u++,d+=t[l][1],l++;break;case e:c++,h+=t[l][1],l++;break;case r:var f=l-u-c-1;if(i){if(f>=0&&y(t[f][1])){var g=t[f][1].slice(-1);if(t[f][1]=t[f][1].slice(0,-1),h=g+h,d=g+d,!t[f][1]){t.splice(f,1),l--;var m=f-1;t[m]&&t[m][0]===n&&(u++,d=t[m][1]+d,m--),t[m]&&t[m][0]===e&&(c++,h=t[m][1]+h,m--),f=m}}b(t[l][1])&&(g=t[l][1].charAt(0),t[l][1]=t[l][1].slice(1),h+=g,d+=g)}if(l<t.length-1&&!t[l][1]){t.splice(l,1);break}if(h.length>0||d.length>0){h.length>0&&d.length>0&&(0!==(s=o(d,h))&&(f>=0?t[f][1]+=d.substring(0,s):(t.splice(0,0,[r,d.substring(0,s)]),l++),d=d.substring(s),h=h.substring(s)),0!==(s=a(d,h))&&(t[l][1]=d.substring(d.length-s)+t[l][1],d=d.substring(0,d.length-s),h=h.substring(0,h.length-s)));var v=u+c;0===h.length&&0===d.length?(t.splice(l-v,v),l-=v):0===h.length?(t.splice(l-v,v,[n,d]),l=l-v+1):0===d.length?(t.splice(l-v,v,[e,h]),l=l-v+1):(t.splice(l-v,v,[e,h],[n,d]),l=l-v+2)}0!==l&&t[l-1][0]===r?(t[l-1][1]+=t[l][1],t.splice(l,1)):l++,u=0,c=0,h="",d=""}""===t[t.length-1][1]&&t.pop();var A=!1;for(l=1;l<t.length-1;)t[l-1][0]===r&&t[l+1][0]===r&&(t[l][1].substring(t[l][1].length-t[l-1][1].length)===t[l-1][1]?(t[l][1]=t[l-1][1]+t[l][1].substring(0,t[l][1].length-t[l-1][1].length),t[l+1][1]=t[l-1][1]+t[l+1][1],t.splice(l-1,1),A=!0):t[l][1].substring(0,t[l+1][1].length)==t[l+1][1]&&(t[l-1][1]+=t[l+1][1],t[l][1]=t[l][1].substring(t[l+1][1].length)+t[l+1][1],t.splice(l+1,1),A=!0)),l++;A&&p(t,i)}function g(t){return t>=55296&&t<=56319}function m(t){return t>=56320&&t<=57343}function b(t){return m(t.charCodeAt(0))}function y(t){return g(t.charCodeAt(t.length-1))}function v(t,i,s,o){return y(t)||b(o)?null:function(t){for(var e=[],n=0;n<t.length;n++)t[n][1].length>0&&e.push(t[n]);return e}([[r,t],[e,i],[n,s],[r,o]])}function A(t,e,n,r){return i(t,e,n,r,!0)}A.INSERT=n,A.DELETE=e,A.EQUAL=r,t.exports=A},9629:function(t,e,n){t=n.nmd(t);var r="__lodash_hash_undefined__",i=9007199254740991,s="[object Arguments]",o="[object Boolean]",l="[object Date]",a="[object Function]",c="[object GeneratorFunction]",u="[object Map]",h="[object Number]",d="[object Object]",f="[object Promise]",p="[object RegExp]",g="[object Set]",m="[object String]",b="[object Symbol]",y="[object WeakMap]",v="[object ArrayBuffer]",A="[object DataView]",x="[object Float32Array]",N="[object Float64Array]",E="[object Int8Array]",w="[object Int16Array]",q="[object Int32Array]",k="[object Uint8Array]",_="[object Uint8ClampedArray]",L="[object Uint16Array]",S="[object Uint32Array]",O=/\w*$/,T=/^\[object .+?Constructor\]$/,j=/^(?:0|[1-9]\d*)$/,C={};C[s]=C["[object Array]"]=C[v]=C[A]=C[o]=C[l]=C[x]=C[N]=C[E]=C[w]=C[q]=C[u]=C[h]=C[d]=C[p]=C[g]=C[m]=C[b]=C[k]=C[_]=C[L]=C[S]=!0,C["[object Error]"]=C[a]=C[y]=!1;var R="object"==typeof n.g&&n.g&&n.g.Object===Object&&n.g,I="object"==typeof self&&self&&self.Object===Object&&self,B=R||I||Function("return this")(),M=e&&!e.nodeType&&e,U=M&&t&&!t.nodeType&&t,D=U&&U.exports===M;function P(t,e){return t.set(e[0],e[1]),t}function z(t,e){return t.add(e),t}function F(t,e,n,r){var i=-1,s=t?t.length:0;for(r&&s&&(n=t[++i]);++i<s;)n=e(n,t[i],i,t);return n}function H(t){var e=!1;if(null!=t&&"function"!=typeof t.toString)try{e=!!(t+"")}catch(t){}return e}function $(t){var e=-1,n=Array(t.size);return t.forEach((function(t,r){n[++e]=[r,t]})),n}function V(t,e){return function(n){return t(e(n))}}function K(t){var e=-1,n=Array(t.size);return t.forEach((function(t){n[++e]=t})),n}var W,Z=Array.prototype,G=Function.prototype,X=Object.prototype,Q=B["__core-js_shared__"],J=(W=/[^.]+$/.exec(Q&&Q.keys&&Q.keys.IE_PROTO||""))?"Symbol(src)_1."+W:"",Y=G.toString,tt=X.hasOwnProperty,et=X.toString,nt=RegExp("^"+Y.call(tt).replace(/[\\^$.*+?()[\]{}|]/g,"\\$&").replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g,"$1.*?")+"$"),rt=D?B.Buffer:void 0,it=B.Symbol,st=B.Uint8Array,ot=V(Object.getPrototypeOf,Object),lt=Object.create,at=X.propertyIsEnumerable,ct=Z.splice,ut=Object.getOwnPropertySymbols,ht=rt?rt.isBuffer:void 0,dt=V(Object.keys,Object),ft=Bt(B,"DataView"),pt=Bt(B,"Map"),gt=Bt(B,"Promise"),mt=Bt(B,"Set"),bt=Bt(B,"WeakMap"),yt=Bt(Object,"create"),vt=zt(ft),At=zt(pt),xt=zt(gt),Nt=zt(mt),Et=zt(bt),wt=it?it.prototype:void 0,qt=wt?wt.valueOf:void 0;function kt(t){var e=-1,n=t?t.length:0;for(this.clear();++e<n;){var r=t[e];this.set(r[0],r[1])}}function _t(t){var e=-1,n=t?t.length:0;for(this.clear();++e<n;){var r=t[e];this.set(r[0],r[1])}}function Lt(t){var e=-1,n=t?t.length:0;for(this.clear();++e<n;){var r=t[e];this.set(r[0],r[1])}}function St(t){this.__data__=new _t(t)}function Ot(t,e,n){var r=t[e];tt.call(t,e)&&Ft(r,n)&&(void 0!==n||e in t)||(t[e]=n)}function Tt(t,e){for(var n=t.length;n--;)if(Ft(t[n][0],e))return n;return-1}function jt(t,e,n,r,i,f,y){var T;if(r&&(T=f?r(t,i,f,y):r(t)),void 0!==T)return T;if(!Wt(t))return t;var j=Ht(t);if(j){if(T=function(t){var e=t.length,n=t.constructor(e);return e&&"string"==typeof t[0]&&tt.call(t,"index")&&(n.index=t.index,n.input=t.input),n}(t),!e)return function(t,e){var n=-1,r=t.length;for(e||(e=Array(r));++n<r;)e[n]=t[n];return e}(t,T)}else{var R=Ut(t),I=R==a||R==c;if(Vt(t))return function(t,e){if(e)return t.slice();var n=new t.constructor(t.length);return t.copy(n),n}(t,e);if(R==d||R==s||I&&!f){if(H(t))return f?t:{};if(T=function(t){return"function"!=typeof t.constructor||Pt(t)?{}:Wt(e=ot(t))?lt(e):{};var e}(I?{}:t),!e)return function(t,e){return Rt(t,Mt(t),e)}(t,function(t,e){return t&&Rt(e,Zt(e),t)}(T,t))}else{if(!C[R])return f?t:{};T=function(t,e,n,r){var i,s=t.constructor;switch(e){case v:return Ct(t);case o:case l:return new s(+t);case A:return function(t,e){var n=e?Ct(t.buffer):t.buffer;return new t.constructor(n,t.byteOffset,t.byteLength)}(t,r);case x:case N:case E:case w:case q:case k:case _:case L:case S:return function(t,e){var n=e?Ct(t.buffer):t.buffer;return new t.constructor(n,t.byteOffset,t.length)}(t,r);case u:return function(t,e,n){return F(e?n($(t),!0):$(t),P,new t.constructor)}(t,r,n);case h:case m:return new s(t);case p:return function(t){var e=new t.constructor(t.source,O.exec(t));return e.lastIndex=t.lastIndex,e}(t);case g:return function(t,e,n){return F(e?n(K(t),!0):K(t),z,new t.constructor)}(t,r,n);case b:return i=t,qt?Object(qt.call(i)):{}}}(t,R,jt,e)}}y||(y=new St);var B=y.get(t);if(B)return B;if(y.set(t,T),!j)var M=n?function(t){return function(t,e,n){var r=e(t);return Ht(t)?r:function(t,e){for(var n=-1,r=e.length,i=t.length;++n<r;)t[i+n]=e[n];return t}(r,n(t))}(t,Zt,Mt)}(t):Zt(t);return function(t,e){for(var n=-1,r=t?t.length:0;++n<r&&!1!==e(t[n],n););}(M||t,(function(i,s){M&&(i=t[s=i]),Ot(T,s,jt(i,e,n,r,s,t,y))})),T}function Ct(t){var e=new t.constructor(t.byteLength);return new st(e).set(new st(t)),e}function Rt(t,e,n,r){n||(n={});for(var i=-1,s=e.length;++i<s;){var o=e[i],l=r?r(n[o],t[o],o,n,t):void 0;Ot(n,o,void 0===l?t[o]:l)}return n}function It(t,e){var n,r,i=t.__data__;return("string"==(r=typeof(n=e))||"number"==r||"symbol"==r||"boolean"==r?"__proto__"!==n:null===n)?i["string"==typeof e?"string":"hash"]:i.map}function Bt(t,e){var n=function(t,e){return null==t?void 0:t[e]}(t,e);return function(t){return!(!Wt(t)||(e=t,J&&J in e))&&(Kt(t)||H(t)?nt:T).test(zt(t));var e}(n)?n:void 0}kt.prototype.clear=function(){this.__data__=yt?yt(null):{}},kt.prototype.delete=function(t){return this.has(t)&&delete this.__data__[t]},kt.prototype.get=function(t){var e=this.__data__;if(yt){var n=e[t];return n===r?void 0:n}return tt.call(e,t)?e[t]:void 0},kt.prototype.has=function(t){var e=this.__data__;return yt?void 0!==e[t]:tt.call(e,t)},kt.prototype.set=function(t,e){return this.__data__[t]=yt&&void 0===e?r:e,this},_t.prototype.clear=function(){this.__data__=[]},_t.prototype.delete=function(t){var e=this.__data__,n=Tt(e,t);return!(n<0||(n==e.length-1?e.pop():ct.call(e,n,1),0))},_t.prototype.get=function(t){var e=this.__data__,n=Tt(e,t);return n<0?void 0:e[n][1]},_t.prototype.has=function(t){return Tt(this.__data__,t)>-1},_t.prototype.set=function(t,e){var n=this.__data__,r=Tt(n,t);return r<0?n.push([t,e]):n[r][1]=e,this},Lt.prototype.clear=function(){this.__data__={hash:new kt,map:new(pt||_t),string:new kt}},Lt.prototype.delete=function(t){return It(this,t).delete(t)},Lt.prototype.get=function(t){return It(this,t).get(t)},Lt.prototype.has=function(t){return It(this,t).has(t)},Lt.prototype.set=function(t,e){return It(this,t).set(t,e),this},St.prototype.clear=function(){this.__data__=new _t},St.prototype.delete=function(t){return this.__data__.delete(t)},St.prototype.get=function(t){return this.__data__.get(t)},St.prototype.has=function(t){return this.__data__.has(t)},St.prototype.set=function(t,e){var n=this.__data__;if(n instanceof _t){var r=n.__data__;if(!pt||r.length<199)return r.push([t,e]),this;n=this.__data__=new Lt(r)}return n.set(t,e),this};var Mt=ut?V(ut,Object):function(){return[]},Ut=function(t){return et.call(t)};function Dt(t,e){return!!(e=null==e?i:e)&&("number"==typeof t||j.test(t))&&t>-1&&t%1==0&&t<e}function Pt(t){var e=t&&t.constructor;return t===("function"==typeof e&&e.prototype||X)}function zt(t){if(null!=t){try{return Y.call(t)}catch(t){}try{return t+""}catch(t){}}return""}function Ft(t,e){return t===e||t!=t&&e!=e}(ft&&Ut(new ft(new ArrayBuffer(1)))!=A||pt&&Ut(new pt)!=u||gt&&Ut(gt.resolve())!=f||mt&&Ut(new mt)!=g||bt&&Ut(new bt)!=y)&&(Ut=function(t){var e=et.call(t),n=e==d?t.constructor:void 0,r=n?zt(n):void 0;if(r)switch(r){case vt:return A;case At:return u;case xt:return f;case Nt:return g;case Et:return y}return e});var Ht=Array.isArray;function $t(t){return null!=t&&function(t){return"number"==typeof t&&t>-1&&t%1==0&&t<=i}(t.length)&&!Kt(t)}var Vt=ht||function(){return!1};function Kt(t){var e=Wt(t)?et.call(t):"";return e==a||e==c}function Wt(t){var e=typeof t;return!!t&&("object"==e||"function"==e)}function Zt(t){return $t(t)?function(t,e){var n=Ht(t)||function(t){return function(t){return function(t){return!!t&&"object"==typeof t}(t)&&$t(t)}(t)&&tt.call(t,"callee")&&(!at.call(t,"callee")||et.call(t)==s)}(t)?function(t,e){for(var n=-1,r=Array(t);++n<t;)r[n]=e(n);return r}(t.length,String):[],r=n.length,i=!!r;for(var o in t)!e&&!tt.call(t,o)||i&&("length"==o||Dt(o,r))||n.push(o);return n}(t):function(t){if(!Pt(t))return dt(t);var e=[];for(var n in Object(t))tt.call(t,n)&&"constructor"!=n&&e.push(n);return e}(t)}t.exports=function(t){return jt(t,!0,!0)}},4162:function(t,e,n){t=n.nmd(t);var r="__lodash_hash_undefined__",i=1,s=2,o=9007199254740991,l="[object Arguments]",a="[object Array]",c="[object AsyncFunction]",u="[object Boolean]",h="[object Date]",d="[object Error]",f="[object Function]",p="[object GeneratorFunction]",g="[object Map]",m="[object Number]",b="[object Null]",y="[object Object]",v="[object Promise]",A="[object Proxy]",x="[object RegExp]",N="[object Set]",E="[object String]",w="[object Undefined]",q="[object WeakMap]",k="[object ArrayBuffer]",_="[object DataView]",L=/^\[object .+?Constructor\]$/,S=/^(?:0|[1-9]\d*)$/,O={};O["[object Float32Array]"]=O["[object Float64Array]"]=O["[object Int8Array]"]=O["[object Int16Array]"]=O["[object Int32Array]"]=O["[object Uint8Array]"]=O["[object Uint8ClampedArray]"]=O["[object Uint16Array]"]=O["[object Uint32Array]"]=!0,O[l]=O[a]=O[k]=O[u]=O[_]=O[h]=O[d]=O[f]=O[g]=O[m]=O[y]=O[x]=O[N]=O[E]=O[q]=!1;var T="object"==typeof n.g&&n.g&&n.g.Object===Object&&n.g,j="object"==typeof self&&self&&self.Object===Object&&self,C=T||j||Function("return this")(),R=e&&!e.nodeType&&e,I=R&&t&&!t.nodeType&&t,B=I&&I.exports===R,M=B&&T.process,U=function(){try{return M&&M.binding&&M.binding("util")}catch(t){}}(),D=U&&U.isTypedArray;function P(t,e){for(var n=-1,r=null==t?0:t.length;++n<r;)if(e(t[n],n,t))return!0;return!1}function z(t){var e=-1,n=Array(t.size);return t.forEach((function(t,r){n[++e]=[r,t]})),n}function F(t){var e=-1,n=Array(t.size);return t.forEach((function(t){n[++e]=t})),n}var H,$,V,K=Array.prototype,W=Function.prototype,Z=Object.prototype,G=C["__core-js_shared__"],X=W.toString,Q=Z.hasOwnProperty,J=(H=/[^.]+$/.exec(G&&G.keys&&G.keys.IE_PROTO||""))?"Symbol(src)_1."+H:"",Y=Z.toString,tt=RegExp("^"+X.call(Q).replace(/[\\^$.*+?()[\]{}|]/g,"\\$&").replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g,"$1.*?")+"$"),et=B?C.Buffer:void 0,nt=C.Symbol,rt=C.Uint8Array,it=Z.propertyIsEnumerable,st=K.splice,ot=nt?nt.toStringTag:void 0,lt=Object.getOwnPropertySymbols,at=et?et.isBuffer:void 0,ct=($=Object.keys,V=Object,function(t){return $(V(t))}),ut=It(C,"DataView"),ht=It(C,"Map"),dt=It(C,"Promise"),ft=It(C,"Set"),pt=It(C,"WeakMap"),gt=It(Object,"create"),mt=Dt(ut),bt=Dt(ht),yt=Dt(dt),vt=Dt(ft),At=Dt(pt),xt=nt?nt.prototype:void 0,Nt=xt?xt.valueOf:void 0;function Et(t){var e=-1,n=null==t?0:t.length;for(this.clear();++e<n;){var r=t[e];this.set(r[0],r[1])}}function wt(t){var e=-1,n=null==t?0:t.length;for(this.clear();++e<n;){var r=t[e];this.set(r[0],r[1])}}function qt(t){var e=-1,n=null==t?0:t.length;for(this.clear();++e<n;){var r=t[e];this.set(r[0],r[1])}}function kt(t){var e=-1,n=null==t?0:t.length;for(this.__data__=new qt;++e<n;)this.add(t[e])}function _t(t){var e=this.__data__=new wt(t);this.size=e.size}function Lt(t,e){for(var n=t.length;n--;)if(Pt(t[n][0],e))return n;return-1}function St(t){return null==t?void 0===t?w:b:ot&&ot in Object(t)?function(t){var e=Q.call(t,ot),n=t[ot];try{t[ot]=void 0;var r=!0}catch(t){}var i=Y.call(t);return r&&(e?t[ot]=n:delete t[ot]),i}(t):function(t){return Y.call(t)}(t)}function Ot(t){return Wt(t)&&St(t)==l}function Tt(t,e,n,r,o){return t===e||(null==t||null==e||!Wt(t)&&!Wt(e)?t!=t&&e!=e:function(t,e,n,r,o,c){var f=Ft(t),p=Ft(e),b=f?a:Mt(t),v=p?a:Mt(e),A=(b=b==l?y:b)==y,w=(v=v==l?y:v)==y,q=b==v;if(q&&Ht(t)){if(!Ht(e))return!1;f=!0,A=!1}if(q&&!A)return c||(c=new _t),f||Zt(t)?jt(t,e,n,r,o,c):function(t,e,n,r,o,l,a){switch(n){case _:if(t.byteLength!=e.byteLength||t.byteOffset!=e.byteOffset)return!1;t=t.buffer,e=e.buffer;case k:return!(t.byteLength!=e.byteLength||!l(new rt(t),new rt(e)));case u:case h:case m:return Pt(+t,+e);case d:return t.name==e.name&&t.message==e.message;case x:case E:return t==e+"";case g:var c=z;case N:var f=r&i;if(c||(c=F),t.size!=e.size&&!f)return!1;var p=a.get(t);if(p)return p==e;r|=s,a.set(t,e);var b=jt(c(t),c(e),r,o,l,a);return a.delete(t),b;case"[object Symbol]":if(Nt)return Nt.call(t)==Nt.call(e)}return!1}(t,e,b,n,r,o,c);if(!(n&i)){var L=A&&Q.call(t,"__wrapped__"),S=w&&Q.call(e,"__wrapped__");if(L||S){var O=L?t.value():t,T=S?e.value():e;return c||(c=new _t),o(O,T,n,r,c)}}return!!q&&(c||(c=new _t),function(t,e,n,r,s,o){var l=n&i,a=Ct(t),c=a.length;if(c!=Ct(e).length&&!l)return!1;for(var u=c;u--;){var h=a[u];if(!(l?h in e:Q.call(e,h)))return!1}var d=o.get(t);if(d&&o.get(e))return d==e;var f=!0;o.set(t,e),o.set(e,t);for(var p=l;++u<c;){var g=t[h=a[u]],m=e[h];if(r)var b=l?r(m,g,h,e,t,o):r(g,m,h,t,e,o);if(!(void 0===b?g===m||s(g,m,n,r,o):b)){f=!1;break}p||(p="constructor"==h)}if(f&&!p){var y=t.constructor,v=e.constructor;y==v||!("constructor"in t)||!("constructor"in e)||"function"==typeof y&&y instanceof y&&"function"==typeof v&&v instanceof v||(f=!1)}return o.delete(t),o.delete(e),f}(t,e,n,r,o,c))}(t,e,n,r,Tt,o))}function jt(t,e,n,r,o,l){var a=n&i,c=t.length,u=e.length;if(c!=u&&!(a&&u>c))return!1;var h=l.get(t);if(h&&l.get(e))return h==e;var d=-1,f=!0,p=n&s?new kt:void 0;for(l.set(t,e),l.set(e,t);++d<c;){var g=t[d],m=e[d];if(r)var b=a?r(m,g,d,e,t,l):r(g,m,d,t,e,l);if(void 0!==b){if(b)continue;f=!1;break}if(p){if(!P(e,(function(t,e){if(i=e,!p.has(i)&&(g===t||o(g,t,n,r,l)))return p.push(e);var i}))){f=!1;break}}else if(g!==m&&!o(g,m,n,r,l)){f=!1;break}}return l.delete(t),l.delete(e),f}function Ct(t){return function(t,e,n){var r=e(t);return Ft(t)?r:function(t,e){for(var n=-1,r=e.length,i=t.length;++n<r;)t[i+n]=e[n];return t}(r,n(t))}(t,Gt,Bt)}function Rt(t,e){var n,r,i=t.__data__;return("string"==(r=typeof(n=e))||"number"==r||"symbol"==r||"boolean"==r?"__proto__"!==n:null===n)?i["string"==typeof e?"string":"hash"]:i.map}function It(t,e){var n=function(t,e){return null==t?void 0:t[e]}(t,e);return function(t){return!(!Kt(t)||function(t){return!!J&&J in t}(t))&&($t(t)?tt:L).test(Dt(t))}(n)?n:void 0}Et.prototype.clear=function(){this.__data__=gt?gt(null):{},this.size=0},Et.prototype.delete=function(t){var e=this.has(t)&&delete this.__data__[t];return this.size-=e?1:0,e},Et.prototype.get=function(t){var e=this.__data__;if(gt){var n=e[t];return n===r?void 0:n}return Q.call(e,t)?e[t]:void 0},Et.prototype.has=function(t){var e=this.__data__;return gt?void 0!==e[t]:Q.call(e,t)},Et.prototype.set=function(t,e){var n=this.__data__;return this.size+=this.has(t)?0:1,n[t]=gt&&void 0===e?r:e,this},wt.prototype.clear=function(){this.__data__=[],this.size=0},wt.prototype.delete=function(t){var e=this.__data__,n=Lt(e,t);return!(n<0||(n==e.length-1?e.pop():st.call(e,n,1),--this.size,0))},wt.prototype.get=function(t){var e=this.__data__,n=Lt(e,t);return n<0?void 0:e[n][1]},wt.prototype.has=function(t){return Lt(this.__data__,t)>-1},wt.prototype.set=function(t,e){var n=this.__data__,r=Lt(n,t);return r<0?(++this.size,n.push([t,e])):n[r][1]=e,this},qt.prototype.clear=function(){this.size=0,this.__data__={hash:new Et,map:new(ht||wt),string:new Et}},qt.prototype.delete=function(t){var e=Rt(this,t).delete(t);return this.size-=e?1:0,e},qt.prototype.get=function(t){return Rt(this,t).get(t)},qt.prototype.has=function(t){return Rt(this,t).has(t)},qt.prototype.set=function(t,e){var n=Rt(this,t),r=n.size;return n.set(t,e),this.size+=n.size==r?0:1,this},kt.prototype.add=kt.prototype.push=function(t){return this.__data__.set(t,r),this},kt.prototype.has=function(t){return this.__data__.has(t)},_t.prototype.clear=function(){this.__data__=new wt,this.size=0},_t.prototype.delete=function(t){var e=this.__data__,n=e.delete(t);return this.size=e.size,n},_t.prototype.get=function(t){return this.__data__.get(t)},_t.prototype.has=function(t){return this.__data__.has(t)},_t.prototype.set=function(t,e){var n=this.__data__;if(n instanceof wt){var r=n.__data__;if(!ht||r.length<199)return r.push([t,e]),this.size=++n.size,this;n=this.__data__=new qt(r)}return n.set(t,e),this.size=n.size,this};var Bt=lt?function(t){return null==t?[]:(t=Object(t),function(e,n){for(var r=-1,i=null==e?0:e.length,s=0,o=[];++r<i;){var l=e[r];a=l,it.call(t,a)&&(o[s++]=l)}var a;return o}(lt(t)))}:function(){return[]},Mt=St;function Ut(t,e){return!!(e=null==e?o:e)&&("number"==typeof t||S.test(t))&&t>-1&&t%1==0&&t<e}function Dt(t){if(null!=t){try{return X.call(t)}catch(t){}try{return t+""}catch(t){}}return""}function Pt(t,e){return t===e||t!=t&&e!=e}(ut&&Mt(new ut(new ArrayBuffer(1)))!=_||ht&&Mt(new ht)!=g||dt&&Mt(dt.resolve())!=v||ft&&Mt(new ft)!=N||pt&&Mt(new pt)!=q)&&(Mt=function(t){var e=St(t),n=e==y?t.constructor:void 0,r=n?Dt(n):"";if(r)switch(r){case mt:return _;case bt:return g;case yt:return v;case vt:return N;case At:return q}return e});var zt=Ot(function(){return arguments}())?Ot:function(t){return Wt(t)&&Q.call(t,"callee")&&!it.call(t,"callee")},Ft=Array.isArray,Ht=at||function(){return!1};function $t(t){if(!Kt(t))return!1;var e=St(t);return e==f||e==p||e==c||e==A}function Vt(t){return"number"==typeof t&&t>-1&&t%1==0&&t<=o}function Kt(t){var e=typeof t;return null!=t&&("object"==e||"function"==e)}function Wt(t){return null!=t&&"object"==typeof t}var Zt=D?function(t){return function(e){return t(e)}}(D):function(t){return Wt(t)&&Vt(t.length)&&!!O[St(t)]};function Gt(t){return null!=(e=t)&&Vt(e.length)&&!$t(e)?function(t,e){var n=Ft(t),r=!n&&zt(t),i=!n&&!r&&Ht(t),s=!n&&!r&&!i&&Zt(t),o=n||r||i||s,l=o?function(t,e){for(var n=-1,r=Array(t);++n<t;)r[n]=e(n);return r}(t.length,String):[],a=l.length;for(var c in t)!e&&!Q.call(t,c)||o&&("length"==c||i&&("offset"==c||"parent"==c)||s&&("buffer"==c||"byteLength"==c||"byteOffset"==c)||Ut(c,a))||l.push(c);return l}(t):function(t){if(n=(e=t)&&e.constructor,e!==("function"==typeof n&&n.prototype||Z))return ct(t);var e,n,r=[];for(var i in Object(t))Q.call(t,i)&&"constructor"!=i&&r.push(i);return r}(t);var e}t.exports=function(t,e){return Tt(t,e)}},1270:function(t,e,n){"use strict";Object.defineProperty(e,"__esModule",{value:!0});const r=n(9629),i=n(4162);var s;!function(t){t.compose=function(t={},e={},n=!1){"object"!=typeof t&&(t={}),"object"!=typeof e&&(e={});let i=r(e);n||(i=Object.keys(i).reduce(((t,e)=>(null!=i[e]&&(t[e]=i[e]),t)),{}));for(const n in t)void 0!==t[n]&&void 0===e[n]&&(i[n]=t[n]);return Object.keys(i).length>0?i:void 0},t.diff=function(t={},e={}){"object"!=typeof t&&(t={}),"object"!=typeof e&&(e={});const n=Object.keys(t).concat(Object.keys(e)).reduce(((n,r)=>(i(t[r],e[r])||(n[r]=void 0===e[r]?null:e[r]),n)),{});return Object.keys(n).length>0?n:void 0},t.invert=function(t={},e={}){t=t||{};const n=Object.keys(e).reduce(((n,r)=>(e[r]!==t[r]&&void 0!==t[r]&&(n[r]=e[r]),n)),{});return Object.keys(t).reduce(((n,r)=>(t[r]!==e[r]&&void 0===e[r]&&(n[r]=null),n)),n)},t.transform=function(t,e,n=!1){if("object"!=typeof t)return e;if("object"!=typeof e)return;if(!n)return e;const r=Object.keys(e).reduce(((n,r)=>(void 0===t[r]&&(n[r]=e[r]),n)),{});return Object.keys(r).length>0?r:void 0}}(s||(s={})),e.default=s},5232:function(t,e,n){"use strict";Object.defineProperty(e,"__esModule",{value:!0}),e.AttributeMap=e.OpIterator=e.Op=void 0;const r=n(5090),i=n(9629),s=n(4162),o=n(1270);e.AttributeMap=o.default;const l=n(4123);e.Op=l.default;const a=n(7033);e.OpIterator=a.default;const c=String.fromCharCode(0),u=(t,e)=>{if("object"!=typeof t||null===t)throw new Error("cannot retain a "+typeof t);if("object"!=typeof e||null===e)throw new Error("cannot retain a "+typeof e);const n=Object.keys(t)[0];if(!n||n!==Object.keys(e)[0])throw new Error(`embed types not matched: ${n} != ${Object.keys(e)[0]}`);return[n,t[n],e[n]]};class h{constructor(t){Array.isArray(t)?this.ops=t:null!=t&&Array.isArray(t.ops)?this.ops=t.ops:this.ops=[]}static registerEmbed(t,e){this.handlers[t]=e}static unregisterEmbed(t){delete this.handlers[t]}static getHandler(t){const e=this.handlers[t];if(!e)throw new Error(`no handlers for embed type "${t}"`);return e}insert(t,e){const n={};return"string"==typeof t&&0===t.length?this:(n.insert=t,null!=e&&"object"==typeof e&&Object.keys(e).length>0&&(n.attributes=e),this.push(n))}delete(t){return t<=0?this:this.push({delete:t})}retain(t,e){if("number"==typeof t&&t<=0)return this;const n={retain:t};return null!=e&&"object"==typeof e&&Object.keys(e).length>0&&(n.attributes=e),this.push(n)}push(t){let e=this.ops.length,n=this.ops[e-1];if(t=i(t),"object"==typeof n){if("number"==typeof t.delete&&"number"==typeof n.delete)return this.ops[e-1]={delete:n.delete+t.delete},this;if("number"==typeof n.delete&&null!=t.insert&&(e-=1,n=this.ops[e-1],"object"!=typeof n))return this.ops.unshift(t),this;if(s(t.attributes,n.attributes)){if("string"==typeof t.insert&&"string"==typeof n.insert)return this.ops[e-1]={insert:n.insert+t.insert},"object"==typeof t.attributes&&(this.ops[e-1].attributes=t.attributes),this;if("number"==typeof t.retain&&"number"==typeof n.retain)return this.ops[e-1]={retain:n.retain+t.retain},"object"==typeof t.attributes&&(this.ops[e-1].attributes=t.attributes),this}}return e===this.ops.length?this.ops.push(t):this.ops.splice(e,0,t),this}chop(){const t=this.ops[this.ops.length-1];return t&&"number"==typeof t.retain&&!t.attributes&&this.ops.pop(),this}filter(t){return this.ops.filter(t)}forEach(t){this.ops.forEach(t)}map(t){return this.ops.map(t)}partition(t){const e=[],n=[];return this.forEach((r=>{(t(r)?e:n).push(r)})),[e,n]}reduce(t,e){return this.ops.reduce(t,e)}changeLength(){return this.reduce(((t,e)=>e.insert?t+l.default.length(e):e.delete?t-e.delete:t),0)}length(){return this.reduce(((t,e)=>t+l.default.length(e)),0)}slice(t=0,e=1/0){const n=[],r=new a.default(this.ops);let i=0;for(;i<e&&r.hasNext();){let s;i<t?s=r.next(t-i):(s=r.next(e-i),n.push(s)),i+=l.default.length(s)}return new h(n)}compose(t){const e=new a.default(this.ops),n=new a.default(t.ops),r=[],i=n.peek();if(null!=i&&"number"==typeof i.retain&&null==i.attributes){let t=i.retain;for(;"insert"===e.peekType()&&e.peekLength()<=t;)t-=e.peekLength(),r.push(e.next());i.retain-t>0&&n.next(i.retain-t)}const l=new h(r);for(;e.hasNext()||n.hasNext();)if("insert"===n.peekType())l.push(n.next());else if("delete"===e.peekType())l.push(e.next());else{const t=Math.min(e.peekLength(),n.peekLength()),r=e.next(t),i=n.next(t);if(i.retain){const a={};if("number"==typeof r.retain)a.retain="number"==typeof i.retain?t:i.retain;else if("number"==typeof i.retain)null==r.retain?a.insert=r.insert:a.retain=r.retain;else{const t=null==r.retain?"insert":"retain",[e,n,s]=u(r[t],i.retain),o=h.getHandler(e);a[t]={[e]:o.compose(n,s,"retain"===t)}}const c=o.default.compose(r.attributes,i.attributes,"number"==typeof r.retain);if(c&&(a.attributes=c),l.push(a),!n.hasNext()&&s(l.ops[l.ops.length-1],a)){const t=new h(e.rest());return l.concat(t).chop()}}else"number"==typeof i.delete&&("number"==typeof r.retain||"object"==typeof r.retain&&null!==r.retain)&&l.push(i)}return l.chop()}concat(t){const e=new h(this.ops.slice());return t.ops.length>0&&(e.push(t.ops[0]),e.ops=e.ops.concat(t.ops.slice(1))),e}diff(t,e){if(this.ops===t.ops)return new h;const n=[this,t].map((e=>e.map((n=>{if(null!=n.insert)return"string"==typeof n.insert?n.insert:c;throw new Error("diff() called "+(e===t?"on":"with")+" non-document")})).join(""))),i=new h,l=r(n[0],n[1],e,!0),u=new a.default(this.ops),d=new a.default(t.ops);return l.forEach((t=>{let e=t[1].length;for(;e>0;){let n=0;switch(t[0]){case r.INSERT:n=Math.min(d.peekLength(),e),i.push(d.next(n));break;case r.DELETE:n=Math.min(e,u.peekLength()),u.next(n),i.delete(n);break;case r.EQUAL:n=Math.min(u.peekLength(),d.peekLength(),e);const t=u.next(n),l=d.next(n);s(t.insert,l.insert)?i.retain(n,o.default.diff(t.attributes,l.attributes)):i.push(l).delete(n)}e-=n}})),i.chop()}eachLine(t,e="\n"){const n=new a.default(this.ops);let r=new h,i=0;for(;n.hasNext();){if("insert"!==n.peekType())return;const s=n.peek(),o=l.default.length(s)-n.peekLength(),a="string"==typeof s.insert?s.insert.indexOf(e,o)-o:-1;if(a<0)r.push(n.next());else if(a>0)r.push(n.next(a));else{if(!1===t(r,n.next(1).attributes||{},i))return;i+=1,r=new h}}r.length()>0&&t(r,{},i)}invert(t){const e=new h;return this.reduce(((n,r)=>{if(r.insert)e.delete(l.default.length(r));else{if("number"==typeof r.retain&&null==r.attributes)return e.retain(r.retain),n+r.retain;if(r.delete||"number"==typeof r.retain){const i=r.delete||r.retain;return t.slice(n,n+i).forEach((t=>{r.delete?e.push(t):r.retain&&r.attributes&&e.retain(l.default.length(t),o.default.invert(r.attributes,t.attributes))})),n+i}if("object"==typeof r.retain&&null!==r.retain){const i=t.slice(n,n+1),s=new a.default(i.ops).next(),[l,c,d]=u(r.retain,s.insert),f=h.getHandler(l);return e.retain({[l]:f.invert(c,d)},o.default.invert(r.attributes,s.attributes)),n+1}}return n}),0),e.chop()}transform(t,e=!1){if(e=!!e,"number"==typeof t)return this.transformPosition(t,e);const n=t,r=new a.default(this.ops),i=new a.default(n.ops),s=new h;for(;r.hasNext()||i.hasNext();)if("insert"!==r.peekType()||!e&&"insert"===i.peekType())if("insert"===i.peekType())s.push(i.next());else{const t=Math.min(r.peekLength(),i.peekLength()),n=r.next(t),l=i.next(t);if(n.delete)continue;if(l.delete)s.push(l);else{const r=n.retain,i=l.retain;let a="object"==typeof i&&null!==i?i:t;if("object"==typeof r&&null!==r&&"object"==typeof i&&null!==i){const t=Object.keys(r)[0];if(t===Object.keys(i)[0]){const n=h.getHandler(t);n&&(a={[t]:n.transform(r[t],i[t],e)})}}s.retain(a,o.default.transform(n.attributes,l.attributes,e))}}else s.retain(l.default.length(r.next()));return s.chop()}transformPosition(t,e=!1){e=!!e;const n=new a.default(this.ops);let r=0;for(;n.hasNext()&&r<=t;){const i=n.peekLength(),s=n.peekType();n.next(),"delete"!==s?("insert"===s&&(r<t||!e)&&(t+=i),r+=i):t-=Math.min(i,t-r)}return t}}h.Op=l.default,h.OpIterator=a.default,h.AttributeMap=o.default,h.handlers={},e.default=h,t.exports=h,t.exports.default=h},4123:function(t,e){"use strict";var n;Object.defineProperty(e,"__esModule",{value:!0}),function(t){t.length=function(t){return"number"==typeof t.delete?t.delete:"number"==typeof t.retain?t.retain:"object"==typeof t.retain&&null!==t.retain?1:"string"==typeof t.insert?t.insert.length:1}}(n||(n={})),e.default=n},7033:function(t,e,n){"use strict";Object.defineProperty(e,"__esModule",{value:!0});const r=n(4123);e.default=class{constructor(t){this.ops=t,this.index=0,this.offset=0}hasNext(){return this.peekLength()<1/0}next(t){t||(t=1/0);const e=this.ops[this.index];if(e){const n=this.offset,i=r.default.length(e);if(t>=i-n?(t=i-n,this.index+=1,this.offset=0):this.offset+=t,"number"==typeof e.delete)return{delete:t};{const r={};return e.attributes&&(r.attributes=e.attributes),"number"==typeof e.retain?r.retain=t:"object"==typeof e.retain&&null!==e.retain?r.retain=e.retain:"string"==typeof e.insert?r.insert=e.insert.substr(n,t):r.insert=e.insert,r}}return{retain:1/0}}peek(){return this.ops[this.index]}peekLength(){return this.ops[this.index]?r.default.length(this.ops[this.index])-this.offset:1/0}peekType(){const t=this.ops[this.index];return t?"number"==typeof t.delete?"delete":"number"==typeof t.retain||"object"==typeof t.retain&&null!==t.retain?"retain":"insert":"retain"}rest(){if(this.hasNext()){if(0===this.offset)return this.ops.slice(this.index);{const t=this.offset,e=this.index,n=this.next(),r=this.ops.slice(this.index);return this.offset=t,this.index=e,[n].concat(r)}}return[]}}},8820:function(t,e,n){"use strict";n.d(e,{A:function(){return l}});var r=n(8138),i=function(t,e){for(var n=t.length;n--;)if((0,r.A)(t[n][0],e))return n;return-1},s=Array.prototype.splice;function o(t){var e=-1,n=null==t?0:t.length;for(this.clear();++e<n;){var r=t[e];this.set(r[0],r[1])}}o.prototype.clear=function(){this.__data__=[],this.size=0},o.prototype.delete=function(t){var e=this.__data__,n=i(e,t);return!(n<0||(n==e.length-1?e.pop():s.call(e,n,1),--this.size,0))},o.prototype.get=function(t){var e=this.__data__,n=i(e,t);return n<0?void 0:e[n][1]},o.prototype.has=function(t){return i(this.__data__,t)>-1},o.prototype.set=function(t,e){var n=this.__data__,r=i(n,t);return r<0?(++this.size,n.push([t,e])):n[r][1]=e,this};var l=o},2461:function(t,e,n){"use strict";var r=n(2281),i=n(5507),s=(0,r.A)(i.A,"Map");e.A=s},3558:function(t,e,n){"use strict";n.d(e,{A:function(){return d}});var r=(0,n(2281).A)(Object,"create"),i=Object.prototype.hasOwnProperty,s=Object.prototype.hasOwnProperty;function o(t){var e=-1,n=null==t?0:t.length;for(this.clear();++e<n;){var r=t[e];this.set(r[0],r[1])}}o.prototype.clear=function(){this.__data__=r?r(null):{},this.size=0},o.prototype.delete=function(t){var e=this.has(t)&&delete this.__data__[t];return this.size-=e?1:0,e},o.prototype.get=function(t){var e=this.__data__;if(r){var n=e[t];return"__lodash_hash_undefined__"===n?void 0:n}return i.call(e,t)?e[t]:void 0},o.prototype.has=function(t){var e=this.__data__;return r?void 0!==e[t]:s.call(e,t)},o.prototype.set=function(t,e){var n=this.__data__;return this.size+=this.has(t)?0:1,n[t]=r&&void 0===e?"__lodash_hash_undefined__":e,this};var l=o,a=n(8820),c=n(2461),u=function(t,e){var n,r,i=t.__data__;return("string"==(r=typeof(n=e))||"number"==r||"symbol"==r||"boolean"==r?"__proto__"!==n:null===n)?i["string"==typeof e?"string":"hash"]:i.map};function h(t){var e=-1,n=null==t?0:t.length;for(this.clear();++e<n;){var r=t[e];this.set(r[0],r[1])}}h.prototype.clear=function(){this.size=0,this.__data__={hash:new l,map:new(c.A||a.A),string:new l}},h.prototype.delete=function(t){var e=u(this,t).delete(t);return this.size-=e?1:0,e},h.prototype.get=function(t){return u(this,t).get(t)},h.prototype.has=function(t){return u(this,t).has(t)},h.prototype.set=function(t,e){var n=u(this,t),r=n.size;return n.set(t,e),this.size+=n.size==r?0:1,this};var d=h},2673:function(t,e,n){"use strict";n.d(e,{A:function(){return l}});var r=n(8820),i=n(2461),s=n(3558);function o(t){var e=this.__data__=new r.A(t);this.size=e.size}o.prototype.clear=function(){this.__data__=new r.A,this.size=0},o.prototype.delete=function(t){var e=this.__data__,n=e.delete(t);return this.size=e.size,n},o.prototype.get=function(t){return this.__data__.get(t)},o.prototype.has=function(t){return this.__data__.has(t)},o.prototype.set=function(t,e){var n=this.__data__;if(n instanceof r.A){var o=n.__data__;if(!i.A||o.length<199)return o.push([t,e]),this.size=++n.size,this;n=this.__data__=new s.A(o)}return n.set(t,e),this.size=n.size,this};var l=o},439:function(t,e,n){"use strict";var r=n(5507).A.Symbol;e.A=r},7218:function(t,e,n){"use strict";var r=n(5507).A.Uint8Array;e.A=r},6753:function(t,e,n){"use strict";n.d(e,{A:function(){return c}});var r=n(8412),i=n(723),s=n(776),o=n(3767),l=n(5755),a=Object.prototype.hasOwnProperty,c=function(t,e){var n=(0,i.A)(t),c=!n&&(0,r.A)(t),u=!n&&!c&&(0,s.A)(t),h=!n&&!c&&!u&&(0,l.A)(t),d=n||c||u||h,f=d?function(t,e){for(var n=-1,r=Array(t);++n<t;)r[n]=e(n);return r}(t.length,String):[],p=f.length;for(var g in t)!e&&!a.call(t,g)||d&&("length"==g||u&&("offset"==g||"parent"==g)||h&&("buffer"==g||"byteLength"==g||"byteOffset"==g)||(0,o.A)(g,p))||f.push(g);return f}},802:function(t,e){"use strict";e.A=function(t,e){for(var n=-1,r=e.length,i=t.length;++n<r;)t[i+n]=e[n];return t}},6437:function(t,e,n){"use strict";var r=n(6770),i=n(8138),s=Object.prototype.hasOwnProperty;e.A=function(t,e,n){var o=t[e];s.call(t,e)&&(0,i.A)(o,n)&&(void 0!==n||e in t)||(0,r.A)(t,e,n)}},6770:function(t,e,n){"use strict";var r=n(7889);e.A=function(t,e,n){"__proto__"==e&&r.A?(0,r.A)(t,e,{configurable:!0,enumerable:!0,value:n,writable:!0}):t[e]=n}},1381:function(t,e,n){"use strict";var r=n(802),i=n(723);e.A=function(t,e,n){var s=e(t);return(0,i.A)(t)?s:(0,r.A)(s,n(t))}},2159:function(t,e,n){"use strict";n.d(e,{A:function(){return u}});var r=n(439),i=Object.prototype,s=i.hasOwnProperty,o=i.toString,l=r.A?r.A.toStringTag:void 0,a=Object.prototype.toString,c=r.A?r.A.toStringTag:void 0,u=function(t){return null==t?void 0===t?"[object Undefined]":"[object Null]":c&&c in Object(t)?function(t){var e=s.call(t,l),n=t[l];try{t[l]=void 0;var r=!0}catch(t){}var i=o.call(t);return r&&(e?t[l]=n:delete t[l]),i}(t):function(t){return a.call(t)}(t)}},5771:function(t,e){"use strict";e.A=function(t){return function(e){return t(e)}}},2899:function(t,e,n){"use strict";var r=n(7218);e.A=function(t){var e=new t.constructor(t.byteLength);return new r.A(e).set(new r.A(t)),e}},3812:function(t,e,n){"use strict";var r=n(5507),i="object"==typeof exports&&exports&&!exports.nodeType&&exports,s=i&&"object"==typeof module&&module&&!module.nodeType&&module,o=s&&s.exports===i?r.A.Buffer:void 0,l=o?o.allocUnsafe:void 0;e.A=function(t,e){if(e)return t.slice();var n=t.length,r=l?l(n):new t.constructor(n);return t.copy(r),r}},1827:function(t,e,n){"use strict";var r=n(2899);e.A=function(t,e){var n=e?(0,r.A)(t.buffer):t.buffer;return new t.constructor(n,t.byteOffset,t.length)}},4405:function(t,e){"use strict";e.A=function(t,e){var n=-1,r=t.length;for(e||(e=Array(r));++n<r;)e[n]=t[n];return e}},9601:function(t,e,n){"use strict";var r=n(6437),i=n(6770);e.A=function(t,e,n,s){var o=!n;n||(n={});for(var l=-1,a=e.length;++l<a;){var c=e[l],u=s?s(n[c],t[c],c,n,t):void 0;void 0===u&&(u=t[c]),o?(0,i.A)(n,c,u):(0,r.A)(n,c,u)}return n}},7889:function(t,e,n){"use strict";var r=n(2281),i=function(){try{var t=(0,r.A)(Object,"defineProperty");return t({},"",{}),t}catch(t){}}();e.A=i},9646:function(t,e){"use strict";var n="object"==typeof global&&global&&global.Object===Object&&global;e.A=n},2816:function(t,e,n){"use strict";var r=n(1381),i=n(9844),s=n(3169);e.A=function(t){return(0,r.A)(t,s.A,i.A)}},2281:function(t,e,n){"use strict";n.d(e,{A:function(){return m}});var r,i=n(7572),s=n(5507).A["__core-js_shared__"],o=(r=/[^.]+$/.exec(s&&s.keys&&s.keys.IE_PROTO||""))?"Symbol(src)_1."+r:"",l=n(659),a=n(1543),c=/^\[object .+?Constructor\]$/,u=Function.prototype,h=Object.prototype,d=u.toString,f=h.hasOwnProperty,p=RegExp("^"+d.call(f).replace(/[\\^$.*+?()[\]{}|]/g,"\\$&").replace(/hasOwnProperty|(function).*?(?=\\\()| for .+?(?=\\\])/g,"$1.*?")+"$"),g=function(t){return!(!(0,l.A)(t)||(e=t,o&&o in e))&&((0,i.A)(t)?p:c).test((0,a.A)(t));var e},m=function(t,e){var n=function(t,e){return null==t?void 0:t[e]}(t,e);return g(n)?n:void 0}},8769:function(t,e,n){"use strict";var r=(0,n(2217).A)(Object.getPrototypeOf,Object);e.A=r},9844:function(t,e,n){"use strict";n.d(e,{A:function(){return o}});var r=n(6935),i=Object.prototype.propertyIsEnumerable,s=Object.getOwnPropertySymbols,o=s?function(t){return null==t?[]:(t=Object(t),function(t,e){for(var n=-1,r=null==t?0:t.length,i=0,s=[];++n<r;){var o=t[n];e(o,n,t)&&(s[i++]=o)}return s}(s(t),(function(e){return i.call(t,e)})))}:r.A},7995:function(t,e,n){"use strict";n.d(e,{A:function(){return E}});var r=n(2281),i=n(5507),s=(0,r.A)(i.A,"DataView"),o=n(2461),l=(0,r.A)(i.A,"Promise"),a=(0,r.A)(i.A,"Set"),c=(0,r.A)(i.A,"WeakMap"),u=n(2159),h=n(1543),d="[object Map]",f="[object Promise]",p="[object Set]",g="[object WeakMap]",m="[object DataView]",b=(0,h.A)(s),y=(0,h.A)(o.A),v=(0,h.A)(l),A=(0,h.A)(a),x=(0,h.A)(c),N=u.A;(s&&N(new s(new ArrayBuffer(1)))!=m||o.A&&N(new o.A)!=d||l&&N(l.resolve())!=f||a&&N(new a)!=p||c&&N(new c)!=g)&&(N=function(t){var e=(0,u.A)(t),n="[object Object]"==e?t.constructor:void 0,r=n?(0,h.A)(n):"";if(r)switch(r){case b:return m;case y:return d;case v:return f;case A:return p;case x:return g}return e});var E=N},1683:function(t,e,n){"use strict";n.d(e,{A:function(){return a}});var r=n(659),i=Object.create,s=function(){function t(){}return function(e){if(!(0,r.A)(e))return{};if(i)return i(e);t.prototype=e;var n=new t;return t.prototype=void 0,n}}(),o=n(8769),l=n(501),a=function(t){return"function"!=typeof t.constructor||(0,l.A)(t)?{}:s((0,o.A)(t))}},3767:function(t,e){"use strict";var n=/^(?:0|[1-9]\d*)$/;e.A=function(t,e){var r=typeof t;return!!(e=null==e?9007199254740991:e)&&("number"==r||"symbol"!=r&&n.test(t))&&t>-1&&t%1==0&&t<e}},501:function(t,e){"use strict";var n=Object.prototype;e.A=function(t){var e=t&&t.constructor;return t===("function"==typeof e&&e.prototype||n)}},8795:function(t,e,n){"use strict";var r=n(9646),i="object"==typeof exports&&exports&&!exports.nodeType&&exports,s=i&&"object"==typeof module&&module&&!module.nodeType&&module,o=s&&s.exports===i&&r.A.process,l=function(){try{return s&&s.require&&s.require("util").types||o&&o.binding&&o.binding("util")}catch(t){}}();e.A=l},2217:function(t,e){"use strict";e.A=function(t,e){return function(n){return t(e(n))}}},5507:function(t,e,n){"use strict";var r=n(9646),i="object"==typeof self&&self&&self.Object===Object&&self,s=r.A||i||Function("return this")();e.A=s},1543:function(t,e){"use strict";var n=Function.prototype.toString;e.A=function(t){if(null!=t){try{return n.call(t)}catch(t){}try{return t+""}catch(t){}}return""}},3707:function(t,e,n){"use strict";n.d(e,{A:function(){return H}});var r=n(2673),i=n(6437),s=n(9601),o=n(3169),l=n(2624),a=n(3812),c=n(4405),u=n(9844),h=n(802),d=n(8769),f=n(6935),p=Object.getOwnPropertySymbols?function(t){for(var e=[];t;)(0,h.A)(e,(0,u.A)(t)),t=(0,d.A)(t);return e}:f.A,g=n(2816),m=n(1381),b=function(t){return(0,m.A)(t,l.A,p)},y=n(7995),v=Object.prototype.hasOwnProperty,A=n(2899),x=/\w*$/,N=n(439),E=N.A?N.A.prototype:void 0,w=E?E.valueOf:void 0,q=n(1827),k=function(t,e,n){var r,i,s,o=t.constructor;switch(e){case"[object ArrayBuffer]":return(0,A.A)(t);case"[object Boolean]":case"[object Date]":return new o(+t);case"[object DataView]":return function(t,e){var n=e?(0,A.A)(t.buffer):t.buffer;return new t.constructor(n,t.byteOffset,t.byteLength)}(t,n);case"[object Float32Array]":case"[object Float64Array]":case"[object Int8Array]":case"[object Int16Array]":case"[object Int32Array]":case"[object Uint8Array]":case"[object Uint8ClampedArray]":case"[object Uint16Array]":case"[object Uint32Array]":return(0,q.A)(t,n);case"[object Map]":case"[object Set]":return new o;case"[object Number]":case"[object String]":return new o(t);case"[object RegExp]":return(s=new(i=t).constructor(i.source,x.exec(i))).lastIndex=i.lastIndex,s;case"[object Symbol]":return r=t,w?Object(w.call(r)):{}}},_=n(1683),L=n(723),S=n(776),O=n(7948),T=n(5771),j=n(8795),C=j.A&&j.A.isMap,R=C?(0,T.A)(C):function(t){return(0,O.A)(t)&&"[object Map]"==(0,y.A)(t)},I=n(659),B=j.A&&j.A.isSet,M=B?(0,T.A)(B):function(t){return(0,O.A)(t)&&"[object Set]"==(0,y.A)(t)},U="[object Arguments]",D="[object Function]",P="[object Object]",z={};z[U]=z["[object Array]"]=z["[object ArrayBuffer]"]=z["[object DataView]"]=z["[object Boolean]"]=z["[object Date]"]=z["[object Float32Array]"]=z["[object Float64Array]"]=z["[object Int8Array]"]=z["[object Int16Array]"]=z["[object Int32Array]"]=z["[object Map]"]=z["[object Number]"]=z[P]=z["[object RegExp]"]=z["[object Set]"]=z["[object String]"]=z["[object Symbol]"]=z["[object Uint8Array]"]=z["[object Uint8ClampedArray]"]=z["[object Uint16Array]"]=z["[object Uint32Array]"]=!0,z["[object Error]"]=z[D]=z["[object WeakMap]"]=!1;var F=function t(e,n,h,d,f,m){var A,x=1&n,N=2&n,E=4&n;if(h&&(A=f?h(e,d,f,m):h(e)),void 0!==A)return A;if(!(0,I.A)(e))return e;var w=(0,L.A)(e);if(w){if(A=function(t){var e=t.length,n=new t.constructor(e);return e&&"string"==typeof t[0]&&v.call(t,"index")&&(n.index=t.index,n.input=t.input),n}(e),!x)return(0,c.A)(e,A)}else{var q=(0,y.A)(e),O=q==D||"[object GeneratorFunction]"==q;if((0,S.A)(e))return(0,a.A)(e,x);if(q==P||q==U||O&&!f){if(A=N||O?{}:(0,_.A)(e),!x)return N?function(t,e){return(0,s.A)(t,p(t),e)}(e,function(t,e){return t&&(0,s.A)(e,(0,l.A)(e),t)}(A,e)):function(t,e){return(0,s.A)(t,(0,u.A)(t),e)}(e,function(t,e){return t&&(0,s.A)(e,(0,o.A)(e),t)}(A,e))}else{if(!z[q])return f?e:{};A=k(e,q,x)}}m||(m=new r.A);var T=m.get(e);if(T)return T;m.set(e,A),M(e)?e.forEach((function(r){A.add(t(r,n,h,r,e,m))})):R(e)&&e.forEach((function(r,i){A.set(i,t(r,n,h,i,e,m))}));var j=E?N?b:g.A:N?l.A:o.A,C=w?void 0:j(e);return function(t,e){for(var n=-1,r=null==t?0:t.length;++n<r&&!1!==e(t[n],n,t););}(C||e,(function(r,s){C&&(r=e[s=r]),(0,i.A)(A,s,t(r,n,h,s,e,m))})),A},H=function(t){return F(t,5)}},8138:function(t,e){"use strict";e.A=function(t,e){return t===e||t!=t&&e!=e}},8412:function(t,e,n){"use strict";n.d(e,{A:function(){return u}});var r=n(2159),i=n(7948),s=function(t){return(0,i.A)(t)&&"[object Arguments]"==(0,r.A)(t)},o=Object.prototype,l=o.hasOwnProperty,a=o.propertyIsEnumerable,c=s(function(){return arguments}())?s:function(t){return(0,i.A)(t)&&l.call(t,"callee")&&!a.call(t,"callee")},u=c},723:function(t,e){"use strict";var n=Array.isArray;e.A=n},3628:function(t,e,n){"use strict";var r=n(7572),i=n(1628);e.A=function(t){return null!=t&&(0,i.A)(t.length)&&!(0,r.A)(t)}},776:function(t,e,n){"use strict";n.d(e,{A:function(){return l}});var r=n(5507),i="object"==typeof exports&&exports&&!exports.nodeType&&exports,s=i&&"object"==typeof module&&module&&!module.nodeType&&module,o=s&&s.exports===i?r.A.Buffer:void 0,l=(o?o.isBuffer:void 0)||function(){return!1}},5123:function(t,e,n){"use strict";n.d(e,{A:function(){return S}});var r=n(2673),i=n(3558);function s(t){var e=-1,n=null==t?0:t.length;for(this.__data__=new i.A;++e<n;)this.add(t[e])}s.prototype.add=s.prototype.push=function(t){return this.__data__.set(t,"__lodash_hash_undefined__"),this},s.prototype.has=function(t){return this.__data__.has(t)};var o=s,l=function(t,e){for(var n=-1,r=null==t?0:t.length;++n<r;)if(e(t[n],n,t))return!0;return!1},a=function(t,e,n,r,i,s){var a=1&n,c=t.length,u=e.length;if(c!=u&&!(a&&u>c))return!1;var h=s.get(t),d=s.get(e);if(h&&d)return h==e&&d==t;var f=-1,p=!0,g=2&n?new o:void 0;for(s.set(t,e),s.set(e,t);++f<c;){var m=t[f],b=e[f];if(r)var y=a?r(b,m,f,e,t,s):r(m,b,f,t,e,s);if(void 0!==y){if(y)continue;p=!1;break}if(g){if(!l(e,(function(t,e){if(o=e,!g.has(o)&&(m===t||i(m,t,n,r,s)))return g.push(e);var o}))){p=!1;break}}else if(m!==b&&!i(m,b,n,r,s)){p=!1;break}}return s.delete(t),s.delete(e),p},c=n(439),u=n(7218),h=n(8138),d=function(t){var e=-1,n=Array(t.size);return t.forEach((function(t,r){n[++e]=[r,t]})),n},f=function(t){var e=-1,n=Array(t.size);return t.forEach((function(t){n[++e]=t})),n},p=c.A?c.A.prototype:void 0,g=p?p.valueOf:void 0,m=n(2816),b=Object.prototype.hasOwnProperty,y=n(7995),v=n(723),A=n(776),x=n(5755),N="[object Arguments]",E="[object Array]",w="[object Object]",q=Object.prototype.hasOwnProperty,k=function(t,e,n,i,s,o){var l=(0,v.A)(t),c=(0,v.A)(e),p=l?E:(0,y.A)(t),k=c?E:(0,y.A)(e),_=(p=p==N?w:p)==w,L=(k=k==N?w:k)==w,S=p==k;if(S&&(0,A.A)(t)){if(!(0,A.A)(e))return!1;l=!0,_=!1}if(S&&!_)return o||(o=new r.A),l||(0,x.A)(t)?a(t,e,n,i,s,o):function(t,e,n,r,i,s,o){switch(n){case"[object DataView]":if(t.byteLength!=e.byteLength||t.byteOffset!=e.byteOffset)return!1;t=t.buffer,e=e.buffer;case"[object ArrayBuffer]":return!(t.byteLength!=e.byteLength||!s(new u.A(t),new u.A(e)));case"[object Boolean]":case"[object Date]":case"[object Number]":return(0,h.A)(+t,+e);case"[object Error]":return t.name==e.name&&t.message==e.message;case"[object RegExp]":case"[object String]":return t==e+"";case"[object Map]":var l=d;case"[object Set]":var c=1&r;if(l||(l=f),t.size!=e.size&&!c)return!1;var p=o.get(t);if(p)return p==e;r|=2,o.set(t,e);var m=a(l(t),l(e),r,i,s,o);return o.delete(t),m;case"[object Symbol]":if(g)return g.call(t)==g.call(e)}return!1}(t,e,p,n,i,s,o);if(!(1&n)){var O=_&&q.call(t,"__wrapped__"),T=L&&q.call(e,"__wrapped__");if(O||T){var j=O?t.value():t,C=T?e.value():e;return o||(o=new r.A),s(j,C,n,i,o)}}return!!S&&(o||(o=new r.A),function(t,e,n,r,i,s){var o=1&n,l=(0,m.A)(t),a=l.length;if(a!=(0,m.A)(e).length&&!o)return!1;for(var c=a;c--;){var u=l[c];if(!(o?u in e:b.call(e,u)))return!1}var h=s.get(t),d=s.get(e);if(h&&d)return h==e&&d==t;var f=!0;s.set(t,e),s.set(e,t);for(var p=o;++c<a;){var g=t[u=l[c]],y=e[u];if(r)var v=o?r(y,g,u,e,t,s):r(g,y,u,t,e,s);if(!(void 0===v?g===y||i(g,y,n,r,s):v)){f=!1;break}p||(p="constructor"==u)}if(f&&!p){var A=t.constructor,x=e.constructor;A==x||!("constructor"in t)||!("constructor"in e)||"function"==typeof A&&A instanceof A&&"function"==typeof x&&x instanceof x||(f=!1)}return s.delete(t),s.delete(e),f}(t,e,n,i,s,o))},_=n(7948),L=function t(e,n,r,i,s){return e===n||(null==e||null==n||!(0,_.A)(e)&&!(0,_.A)(n)?e!=e&&n!=n:k(e,n,r,i,t,s))},S=function(t,e){return L(t,e)}},7572:function(t,e,n){"use strict";var r=n(2159),i=n(659);e.A=function(t){if(!(0,i.A)(t))return!1;var e=(0,r.A)(t);return"[object Function]"==e||"[object GeneratorFunction]"==e||"[object AsyncFunction]"==e||"[object Proxy]"==e}},1628:function(t,e){"use strict";e.A=function(t){return"number"==typeof t&&t>-1&&t%1==0&&t<=9007199254740991}},659:function(t,e){"use strict";e.A=function(t){var e=typeof t;return null!=t&&("object"==e||"function"==e)}},7948:function(t,e){"use strict";e.A=function(t){return null!=t&&"object"==typeof t}},5755:function(t,e,n){"use strict";n.d(e,{A:function(){return u}});var r=n(2159),i=n(1628),s=n(7948),o={};o["[object Float32Array]"]=o["[object Float64Array]"]=o["[object Int8Array]"]=o["[object Int16Array]"]=o["[object Int32Array]"]=o["[object Uint8Array]"]=o["[object Uint8ClampedArray]"]=o["[object Uint16Array]"]=o["[object Uint32Array]"]=!0,o["[object Arguments]"]=o["[object Array]"]=o["[object ArrayBuffer]"]=o["[object Boolean]"]=o["[object DataView]"]=o["[object Date]"]=o["[object Error]"]=o["[object Function]"]=o["[object Map]"]=o["[object Number]"]=o["[object Object]"]=o["[object RegExp]"]=o["[object Set]"]=o["[object String]"]=o["[object WeakMap]"]=!1;var l=n(5771),a=n(8795),c=a.A&&a.A.isTypedArray,u=c?(0,l.A)(c):function(t){return(0,s.A)(t)&&(0,i.A)(t.length)&&!!o[(0,r.A)(t)]}},3169:function(t,e,n){"use strict";n.d(e,{A:function(){return a}});var r=n(6753),i=n(501),s=(0,n(2217).A)(Object.keys,Object),o=Object.prototype.hasOwnProperty,l=n(3628),a=function(t){return(0,l.A)(t)?(0,r.A)(t):function(t){if(!(0,i.A)(t))return s(t);var e=[];for(var n in Object(t))o.call(t,n)&&"constructor"!=n&&e.push(n);return e}(t)}},2624:function(t,e,n){"use strict";n.d(e,{A:function(){return c}});var r=n(6753),i=n(659),s=n(501),o=Object.prototype.hasOwnProperty,l=function(t){if(!(0,i.A)(t))return function(t){var e=[];if(null!=t)for(var n in Object(t))e.push(n);return e}(t);var e=(0,s.A)(t),n=[];for(var r in t)("constructor"!=r||!e&&o.call(t,r))&&n.push(r);return n},a=n(3628),c=function(t){return(0,a.A)(t)?(0,r.A)(t,!0):l(t)}},8347:function(t,e,n){"use strict";n.d(e,{A:function(){return $}});var r,i,s,o,l=n(2673),a=n(6770),c=n(8138),u=function(t,e,n){(void 0!==n&&!(0,c.A)(t[e],n)||void 0===n&&!(e in t))&&(0,a.A)(t,e,n)},h=function(t,e,n){for(var r=-1,i=Object(t),s=n(t),o=s.length;o--;){var l=s[++r];if(!1===e(i[l],l,i))break}return t},d=n(3812),f=n(1827),p=n(4405),g=n(1683),m=n(8412),b=n(723),y=n(3628),v=n(7948),A=n(776),x=n(7572),N=n(659),E=n(2159),w=n(8769),q=Function.prototype,k=Object.prototype,_=q.toString,L=k.hasOwnProperty,S=_.call(Object),O=n(5755),T=function(t,e){if(("constructor"!==e||"function"!=typeof t[e])&&"__proto__"!=e)return t[e]},j=n(9601),C=n(2624),R=function(t,e,n,r,i,s,o){var l,a=T(t,n),c=T(e,n),h=o.get(c);if(h)u(t,n,h);else{var q=s?s(a,c,n+"",t,e,o):void 0,k=void 0===q;if(k){var R=(0,b.A)(c),I=!R&&(0,A.A)(c),B=!R&&!I&&(0,O.A)(c);q=c,R||I||B?(0,b.A)(a)?q=a:(l=a,(0,v.A)(l)&&(0,y.A)(l)?q=(0,p.A)(a):I?(k=!1,q=(0,d.A)(c,!0)):B?(k=!1,q=(0,f.A)(c,!0)):q=[]):function(t){if(!(0,v.A)(t)||"[object Object]"!=(0,E.A)(t))return!1;var e=(0,w.A)(t);if(null===e)return!0;var n=L.call(e,"constructor")&&e.constructor;return"function"==typeof n&&n instanceof n&&_.call(n)==S}(c)||(0,m.A)(c)?(q=a,(0,m.A)(a)?q=function(t){return(0,j.A)(t,(0,C.A)(t))}(a):(0,N.A)(a)&&!(0,x.A)(a)||(q=(0,g.A)(c))):k=!1}k&&(o.set(c,q),i(q,c,r,s,o),o.delete(c)),u(t,n,q)}},I=function t(e,n,r,i,s){e!==n&&h(n,(function(o,a){if(s||(s=new l.A),(0,N.A)(o))R(e,n,a,r,t,i,s);else{var c=i?i(T(e,a),o,a+"",e,n,s):void 0;void 0===c&&(c=o),u(e,a,c)}}),C.A)},B=function(t){return t},M=Math.max,U=n(7889),D=U.A?function(t,e){return(0,U.A)(t,"toString",{configurable:!0,enumerable:!1,value:(n=e,function(){return n}),writable:!0});var n}:B,P=Date.now,z=(r=D,i=0,s=0,function(){var t=P(),e=16-(t-s);if(s=t,e>0){if(++i>=800)return arguments[0]}else i=0;return r.apply(void 0,arguments)}),F=function(t,e){return z(function(t,e,n){return e=M(void 0===e?t.length-1:e,0),function(){for(var r=arguments,i=-1,s=M(r.length-e,0),o=Array(s);++i<s;)o[i]=r[e+i];i=-1;for(var l=Array(e+1);++i<e;)l[i]=r[i];return l[e]=n(o),function(t,e,n){switch(n.length){case 0:return t.call(e);case 1:return t.call(e,n[0]);case 2:return t.call(e,n[0],n[1]);case 3:return t.call(e,n[0],n[1],n[2])}return t.apply(e,n)}(t,this,l)}}(t,e,B),t+"")},H=n(3767),$=(o=function(t,e,n){I(t,e,n)},F((function(t,e){var n=-1,r=e.length,i=r>1?e[r-1]:void 0,s=r>2?e[2]:void 0;for(i=o.length>3&&"function"==typeof i?(r--,i):void 0,s&&function(t,e,n){if(!(0,N.A)(n))return!1;var r=typeof e;return!!("number"==r?(0,y.A)(n)&&(0,H.A)(e,n.length):"string"==r&&e in n)&&(0,c.A)(n[e],t)}(e[0],e[1],s)&&(i=r<3?void 0:i,r=1),t=Object(t);++n<r;){var l=e[n];l&&o(t,l,n)}return t})))},6935:function(t,e){"use strict";e.A=function(){return[]}},6003:function(t,e,n){"use strict";n.r(e),n.d(e,{Attributor:function(){return i},AttributorStore:function(){return d},BlockBlot:function(){return w},ClassAttributor:function(){return c},ContainerBlot:function(){return k},EmbedBlot:function(){return _},InlineBlot:function(){return N},LeafBlot:function(){return m},ParentBlot:function(){return A},Registry:function(){return l},Scope:function(){return r},ScrollBlot:function(){return O},StyleAttributor:function(){return h},TextBlot:function(){return j}});var r=(t=>(t[t.TYPE=3]="TYPE",t[t.LEVEL=12]="LEVEL",t[t.ATTRIBUTE=13]="ATTRIBUTE",t[t.BLOT=14]="BLOT",t[t.INLINE=7]="INLINE",t[t.BLOCK=11]="BLOCK",t[t.BLOCK_BLOT=10]="BLOCK_BLOT",t[t.INLINE_BLOT=6]="INLINE_BLOT",t[t.BLOCK_ATTRIBUTE=9]="BLOCK_ATTRIBUTE",t[t.INLINE_ATTRIBUTE=5]="INLINE_ATTRIBUTE",t[t.ANY=15]="ANY",t))(r||{});class i{constructor(t,e,n={}){this.attrName=t,this.keyName=e;const i=r.TYPE&r.ATTRIBUTE;this.scope=null!=n.scope?n.scope&r.LEVEL|i:r.ATTRIBUTE,null!=n.whitelist&&(this.whitelist=n.whitelist)}static keys(t){return Array.from(t.attributes).map((t=>t.name))}add(t,e){return!!this.canAdd(t,e)&&(t.setAttribute(this.keyName,e),!0)}canAdd(t,e){return null==this.whitelist||("string"==typeof e?this.whitelist.indexOf(e.replace(/["']/g,""))>-1:this.whitelist.indexOf(e)>-1)}remove(t){t.removeAttribute(this.keyName)}value(t){const e=t.getAttribute(this.keyName);return this.canAdd(t,e)&&e?e:""}}class s extends Error{constructor(t){super(t="[Parchment] "+t),this.message=t,this.name=this.constructor.name}}const o=class t{constructor(){this.attributes={},this.classes={},this.tags={},this.types={}}static find(t,e=!1){if(null==t)return null;if(this.blots.has(t))return this.blots.get(t)||null;if(e){let n=null;try{n=t.parentNode}catch{return null}return this.find(n,e)}return null}create(e,n,r){const i=this.query(n);if(null==i)throw new s(`Unable to create ${n} blot`);const o=i,l=n instanceof Node||n.nodeType===Node.TEXT_NODE?n:o.create(r),a=new o(e,l,r);return t.blots.set(a.domNode,a),a}find(e,n=!1){return t.find(e,n)}query(t,e=r.ANY){let n;return"string"==typeof t?n=this.types[t]||this.attributes[t]:t instanceof Text||t.nodeType===Node.TEXT_NODE?n=this.types.text:"number"==typeof t?t&r.LEVEL&r.BLOCK?n=this.types.block:t&r.LEVEL&r.INLINE&&(n=this.types.inline):t instanceof Element&&((t.getAttribute("class")||"").split(/\s+/).some((t=>(n=this.classes[t],!!n))),n=n||this.tags[t.tagName]),null==n?null:"scope"in n&&e&r.LEVEL&n.scope&&e&r.TYPE&n.scope?n:null}register(...t){return t.map((t=>{const e="blotName"in t,n="attrName"in t;if(!e&&!n)throw new s("Invalid definition");if(e&&"abstract"===t.blotName)throw new s("Cannot register abstract class");const r=e?t.blotName:n?t.attrName:void 0;return this.types[r]=t,n?"string"==typeof t.keyName&&(this.attributes[t.keyName]=t):e&&(t.className&&(this.classes[t.className]=t),t.tagName&&(Array.isArray(t.tagName)?t.tagName=t.tagName.map((t=>t.toUpperCase())):t.tagName=t.tagName.toUpperCase(),(Array.isArray(t.tagName)?t.tagName:[t.tagName]).forEach((e=>{(null==this.tags[e]||null==t.className)&&(this.tags[e]=t)})))),t}))}};o.blots=new WeakMap;let l=o;function a(t,e){return(t.getAttribute("class")||"").split(/\s+/).filter((t=>0===t.indexOf(`${e}-`)))}const c=class extends i{static keys(t){return(t.getAttribute("class")||"").split(/\s+/).map((t=>t.split("-").slice(0,-1).join("-")))}add(t,e){return!!this.canAdd(t,e)&&(this.remove(t),t.classList.add(`${this.keyName}-${e}`),!0)}remove(t){a(t,this.keyName).forEach((e=>{t.classList.remove(e)})),0===t.classList.length&&t.removeAttribute("class")}value(t){const e=(a(t,this.keyName)[0]||"").slice(this.keyName.length+1);return this.canAdd(t,e)?e:""}};function u(t){const e=t.split("-"),n=e.slice(1).map((t=>t[0].toUpperCase()+t.slice(1))).join("");return e[0]+n}const h=class extends i{static keys(t){return(t.getAttribute("style")||"").split(";").map((t=>t.split(":")[0].trim()))}add(t,e){return!!this.canAdd(t,e)&&(t.style[u(this.keyName)]=e,!0)}remove(t){t.style[u(this.keyName)]="",t.getAttribute("style")||t.removeAttribute("style")}value(t){const e=t.style[u(this.keyName)];return this.canAdd(t,e)?e:""}},d=class{constructor(t){this.attributes={},this.domNode=t,this.build()}attribute(t,e){e?t.add(this.domNode,e)&&(null!=t.value(this.domNode)?this.attributes[t.attrName]=t:delete this.attributes[t.attrName]):(t.remove(this.domNode),delete this.attributes[t.attrName])}build(){this.attributes={};const t=l.find(this.domNode);if(null==t)return;const e=i.keys(this.domNode),n=c.keys(this.domNode),s=h.keys(this.domNode);e.concat(n).concat(s).forEach((e=>{const n=t.scroll.query(e,r.ATTRIBUTE);n instanceof i&&(this.attributes[n.attrName]=n)}))}copy(t){Object.keys(this.attributes).forEach((e=>{const n=this.attributes[e].value(this.domNode);t.format(e,n)}))}move(t){this.copy(t),Object.keys(this.attributes).forEach((t=>{this.attributes[t].remove(this.domNode)})),this.attributes={}}values(){return Object.keys(this.attributes).reduce(((t,e)=>(t[e]=this.attributes[e].value(this.domNode),t)),{})}},f=class{constructor(t,e){this.scroll=t,this.domNode=e,l.blots.set(e,this),this.prev=null,this.next=null}static create(t){if(null==this.tagName)throw new s("Blot definition missing tagName");let e,n;return Array.isArray(this.tagName)?("string"==typeof t?(n=t.toUpperCase(),parseInt(n,10).toString()===n&&(n=parseInt(n,10))):"number"==typeof t&&(n=t),e="number"==typeof n?document.createElement(this.tagName[n-1]):n&&this.tagName.indexOf(n)>-1?document.createElement(n):document.createElement(this.tagName[0])):e=document.createElement(this.tagName),this.className&&e.classList.add(this.className),e}get statics(){return this.constructor}attach(){}clone(){const t=this.domNode.cloneNode(!1);return this.scroll.create(t)}detach(){null!=this.parent&&this.parent.removeChild(this),l.blots.delete(this.domNode)}deleteAt(t,e){this.isolate(t,e).remove()}formatAt(t,e,n,i){const s=this.isolate(t,e);if(null!=this.scroll.query(n,r.BLOT)&&i)s.wrap(n,i);else if(null!=this.scroll.query(n,r.ATTRIBUTE)){const t=this.scroll.create(this.statics.scope);s.wrap(t),t.format(n,i)}}insertAt(t,e,n){const r=null==n?this.scroll.create("text",e):this.scroll.create(e,n),i=this.split(t);this.parent.insertBefore(r,i||void 0)}isolate(t,e){const n=this.split(t);if(null==n)throw new Error("Attempt to isolate at end");return n.split(e),n}length(){return 1}offset(t=this.parent){return null==this.parent||this===t?0:this.parent.children.offset(this)+this.parent.offset(t)}optimize(t){this.statics.requiredContainer&&!(this.parent instanceof this.statics.requiredContainer)&&this.wrap(this.statics.requiredContainer.blotName)}remove(){null!=this.domNode.parentNode&&this.domNode.parentNode.removeChild(this.domNode),this.detach()}replaceWith(t,e){const n="string"==typeof t?this.scroll.create(t,e):t;return null!=this.parent&&(this.parent.insertBefore(n,this.next||void 0),this.remove()),n}split(t,e){return 0===t?this:this.next}update(t,e){}wrap(t,e){const n="string"==typeof t?this.scroll.create(t,e):t;if(null!=this.parent&&this.parent.insertBefore(n,this.next||void 0),"function"!=typeof n.appendChild)throw new s(`Cannot wrap ${t}`);return n.appendChild(this),n}};f.blotName="abstract";let p=f;const g=class extends p{static value(t){return!0}index(t,e){return this.domNode===t||this.domNode.compareDocumentPosition(t)&Node.DOCUMENT_POSITION_CONTAINED_BY?Math.min(e,1):-1}position(t,e){let n=Array.from(this.parent.domNode.childNodes).indexOf(this.domNode);return t>0&&(n+=1),[this.parent.domNode,n]}value(){return{[this.statics.blotName]:this.statics.value(this.domNode)||!0}}};g.scope=r.INLINE_BLOT;const m=g;class b{constructor(){this.head=null,this.tail=null,this.length=0}append(...t){if(this.insertBefore(t[0],null),t.length>1){const e=t.slice(1);this.append(...e)}}at(t){const e=this.iterator();let n=e();for(;n&&t>0;)t-=1,n=e();return n}contains(t){const e=this.iterator();let n=e();for(;n;){if(n===t)return!0;n=e()}return!1}indexOf(t){const e=this.iterator();let n=e(),r=0;for(;n;){if(n===t)return r;r+=1,n=e()}return-1}insertBefore(t,e){null!=t&&(this.remove(t),t.next=e,null!=e?(t.prev=e.prev,null!=e.prev&&(e.prev.next=t),e.prev=t,e===this.head&&(this.head=t)):null!=this.tail?(this.tail.next=t,t.prev=this.tail,this.tail=t):(t.prev=null,this.head=this.tail=t),this.length+=1)}offset(t){let e=0,n=this.head;for(;null!=n;){if(n===t)return e;e+=n.length(),n=n.next}return-1}remove(t){this.contains(t)&&(null!=t.prev&&(t.prev.next=t.next),null!=t.next&&(t.next.prev=t.prev),t===this.head&&(this.head=t.next),t===this.tail&&(this.tail=t.prev),this.length-=1)}iterator(t=this.head){return()=>{const e=t;return null!=t&&(t=t.next),e}}find(t,e=!1){const n=this.iterator();let r=n();for(;r;){const i=r.length();if(t<i||e&&t===i&&(null==r.next||0!==r.next.length()))return[r,t];t-=i,r=n()}return[null,0]}forEach(t){const e=this.iterator();let n=e();for(;n;)t(n),n=e()}forEachAt(t,e,n){if(e<=0)return;const[r,i]=this.find(t);let s=t-i;const o=this.iterator(r);let l=o();for(;l&&s<t+e;){const r=l.length();t>s?n(l,t-s,Math.min(e,s+r-t)):n(l,0,Math.min(r,t+e-s)),s+=r,l=o()}}map(t){return this.reduce(((e,n)=>(e.push(t(n)),e)),[])}reduce(t,e){const n=this.iterator();let r=n();for(;r;)e=t(e,r),r=n();return e}}function y(t,e){const n=e.find(t);if(n)return n;try{return e.create(t)}catch{const n=e.create(r.INLINE);return Array.from(t.childNodes).forEach((t=>{n.domNode.appendChild(t)})),t.parentNode&&t.parentNode.replaceChild(n.domNode,t),n.attach(),n}}const v=class t extends p{constructor(t,e){super(t,e),this.uiNode=null,this.build()}appendChild(t){this.insertBefore(t)}attach(){super.attach(),this.children.forEach((t=>{t.attach()}))}attachUI(e){null!=this.uiNode&&this.uiNode.remove(),this.uiNode=e,t.uiClass&&this.uiNode.classList.add(t.uiClass),this.uiNode.setAttribute("contenteditable","false"),this.domNode.insertBefore(this.uiNode,this.domNode.firstChild)}build(){this.children=new b,Array.from(this.domNode.childNodes).filter((t=>t!==this.uiNode)).reverse().forEach((t=>{try{const e=y(t,this.scroll);this.insertBefore(e,this.children.head||void 0)}catch(t){if(t instanceof s)return;throw t}}))}deleteAt(t,e){if(0===t&&e===this.length())return this.remove();this.children.forEachAt(t,e,((t,e,n)=>{t.deleteAt(e,n)}))}descendant(e,n=0){const[r,i]=this.children.find(n);return null==e.blotName&&e(r)||null!=e.blotName&&r instanceof e?[r,i]:r instanceof t?r.descendant(e,i):[null,-1]}descendants(e,n=0,r=Number.MAX_VALUE){let i=[],s=r;return this.children.forEachAt(n,r,((n,r,o)=>{(null==e.blotName&&e(n)||null!=e.blotName&&n instanceof e)&&i.push(n),n instanceof t&&(i=i.concat(n.descendants(e,r,s))),s-=o})),i}detach(){this.children.forEach((t=>{t.detach()})),super.detach()}enforceAllowedChildren(){let e=!1;this.children.forEach((n=>{e||this.statics.allowedChildren.some((t=>n instanceof t))||(n.statics.scope===r.BLOCK_BLOT?(null!=n.next&&this.splitAfter(n),null!=n.prev&&this.splitAfter(n.prev),n.parent.unwrap(),e=!0):n instanceof t?n.unwrap():n.remove())}))}formatAt(t,e,n,r){this.children.forEachAt(t,e,((t,e,i)=>{t.formatAt(e,i,n,r)}))}insertAt(t,e,n){const[r,i]=this.children.find(t);if(r)r.insertAt(i,e,n);else{const t=null==n?this.scroll.create("text",e):this.scroll.create(e,n);this.appendChild(t)}}insertBefore(t,e){null!=t.parent&&t.parent.children.remove(t);let n=null;this.children.insertBefore(t,e||null),t.parent=this,null!=e&&(n=e.domNode),(this.domNode.parentNode!==t.domNode||this.domNode.nextSibling!==n)&&this.domNode.insertBefore(t.domNode,n),t.attach()}length(){return this.children.reduce(((t,e)=>t+e.length()),0)}moveChildren(t,e){this.children.forEach((n=>{t.insertBefore(n,e)}))}optimize(t){if(super.optimize(t),this.enforceAllowedChildren(),null!=this.uiNode&&this.uiNode!==this.domNode.firstChild&&this.domNode.insertBefore(this.uiNode,this.domNode.firstChild),0===this.children.length)if(null!=this.statics.defaultChild){const t=this.scroll.create(this.statics.defaultChild.blotName);this.appendChild(t)}else this.remove()}path(e,n=!1){const[r,i]=this.children.find(e,n),s=[[this,e]];return r instanceof t?s.concat(r.path(i,n)):(null!=r&&s.push([r,i]),s)}removeChild(t){this.children.remove(t)}replaceWith(e,n){const r="string"==typeof e?this.scroll.create(e,n):e;return r instanceof t&&this.moveChildren(r),super.replaceWith(r)}split(t,e=!1){if(!e){if(0===t)return this;if(t===this.length())return this.next}const n=this.clone();return this.parent&&this.parent.insertBefore(n,this.next||void 0),this.children.forEachAt(t,this.length(),((t,r,i)=>{const s=t.split(r,e);null!=s&&n.appendChild(s)})),n}splitAfter(t){const e=this.clone();for(;null!=t.next;)e.appendChild(t.next);return this.parent&&this.parent.insertBefore(e,this.next||void 0),e}unwrap(){this.parent&&this.moveChildren(this.parent,this.next||void 0),this.remove()}update(t,e){const n=[],r=[];t.forEach((t=>{t.target===this.domNode&&"childList"===t.type&&(n.push(...t.addedNodes),r.push(...t.removedNodes))})),r.forEach((t=>{if(null!=t.parentNode&&"IFRAME"!==t.tagName&&document.body.compareDocumentPosition(t)&Node.DOCUMENT_POSITION_CONTAINED_BY)return;const e=this.scroll.find(t);null!=e&&(null==e.domNode.parentNode||e.domNode.parentNode===this.domNode)&&e.detach()})),n.filter((t=>t.parentNode===this.domNode&&t!==this.uiNode)).sort(((t,e)=>t===e?0:t.compareDocumentPosition(e)&Node.DOCUMENT_POSITION_FOLLOWING?1:-1)).forEach((t=>{let e=null;null!=t.nextSibling&&(e=this.scroll.find(t.nextSibling));const n=y(t,this.scroll);(n.next!==e||null==n.next)&&(null!=n.parent&&n.parent.removeChild(this),this.insertBefore(n,e||void 0))})),this.enforceAllowedChildren()}};v.uiClass="";const A=v,x=class t extends A{static create(t){return super.create(t)}static formats(e,n){const r=n.query(t.blotName);if(null==r||e.tagName!==r.tagName){if("string"==typeof this.tagName)return!0;if(Array.isArray(this.tagName))return e.tagName.toLowerCase()}}constructor(t,e){super(t,e),this.attributes=new d(this.domNode)}format(e,n){if(e!==this.statics.blotName||n){const t=this.scroll.query(e,r.INLINE);if(null==t)return;t instanceof i?this.attributes.attribute(t,n):n&&(e!==this.statics.blotName||this.formats()[e]!==n)&&this.replaceWith(e,n)}else this.children.forEach((e=>{e instanceof t||(e=e.wrap(t.blotName,!0)),this.attributes.copy(e)})),this.unwrap()}formats(){const t=this.attributes.values(),e=this.statics.formats(this.domNode,this.scroll);return null!=e&&(t[this.statics.blotName]=e),t}formatAt(t,e,n,i){null!=this.formats()[n]||this.scroll.query(n,r.ATTRIBUTE)?this.isolate(t,e).format(n,i):super.formatAt(t,e,n,i)}optimize(e){super.optimize(e);const n=this.formats();if(0===Object.keys(n).length)return this.unwrap();const r=this.next;r instanceof t&&r.prev===this&&function(t,e){if(Object.keys(t).length!==Object.keys(e).length)return!1;for(const n in t)if(t[n]!==e[n])return!1;return!0}(n,r.formats())&&(r.moveChildren(this),r.remove())}replaceWith(t,e){const n=super.replaceWith(t,e);return this.attributes.copy(n),n}update(t,e){super.update(t,e),t.some((t=>t.target===this.domNode&&"attributes"===t.type))&&this.attributes.build()}wrap(e,n){const r=super.wrap(e,n);return r instanceof t&&this.attributes.move(r),r}};x.allowedChildren=[x,m],x.blotName="inline",x.scope=r.INLINE_BLOT,x.tagName="SPAN";const N=x,E=class t extends A{static create(t){return super.create(t)}static formats(e,n){const r=n.query(t.blotName);if(null==r||e.tagName!==r.tagName){if("string"==typeof this.tagName)return!0;if(Array.isArray(this.tagName))return e.tagName.toLowerCase()}}constructor(t,e){super(t,e),this.attributes=new d(this.domNode)}format(e,n){const s=this.scroll.query(e,r.BLOCK);null!=s&&(s instanceof i?this.attributes.attribute(s,n):e!==this.statics.blotName||n?n&&(e!==this.statics.blotName||this.formats()[e]!==n)&&this.replaceWith(e,n):this.replaceWith(t.blotName))}formats(){const t=this.attributes.values(),e=this.statics.formats(this.domNode,this.scroll);return null!=e&&(t[this.statics.blotName]=e),t}formatAt(t,e,n,i){null!=this.scroll.query(n,r.BLOCK)?this.format(n,i):super.formatAt(t,e,n,i)}insertAt(t,e,n){if(null==n||null!=this.scroll.query(e,r.INLINE))super.insertAt(t,e,n);else{const r=this.split(t);if(null==r)throw new Error("Attempt to insertAt after block boundaries");{const t=this.scroll.create(e,n);r.parent.insertBefore(t,r)}}}replaceWith(t,e){const n=super.replaceWith(t,e);return this.attributes.copy(n),n}update(t,e){super.update(t,e),t.some((t=>t.target===this.domNode&&"attributes"===t.type))&&this.attributes.build()}};E.blotName="block",E.scope=r.BLOCK_BLOT,E.tagName="P",E.allowedChildren=[N,E,m];const w=E,q=class extends A{checkMerge(){return null!==this.next&&this.next.statics.blotName===this.statics.blotName}deleteAt(t,e){super.deleteAt(t,e),this.enforceAllowedChildren()}formatAt(t,e,n,r){super.formatAt(t,e,n,r),this.enforceAllowedChildren()}insertAt(t,e,n){super.insertAt(t,e,n),this.enforceAllowedChildren()}optimize(t){super.optimize(t),this.children.length>0&&null!=this.next&&this.checkMerge()&&(this.next.moveChildren(this),this.next.remove())}};q.blotName="container",q.scope=r.BLOCK_BLOT;const k=q,_=class extends m{static formats(t,e){}format(t,e){super.formatAt(0,this.length(),t,e)}formatAt(t,e,n,r){0===t&&e===this.length()?this.format(n,r):super.formatAt(t,e,n,r)}formats(){return this.statics.formats(this.domNode,this.scroll)}},L={attributes:!0,characterData:!0,characterDataOldValue:!0,childList:!0,subtree:!0},S=class extends A{constructor(t,e){super(null,e),this.registry=t,this.scroll=this,this.build(),this.observer=new MutationObserver((t=>{this.update(t)})),this.observer.observe(this.domNode,L),this.attach()}create(t,e){return this.registry.create(this,t,e)}find(t,e=!1){const n=this.registry.find(t,e);return n?n.scroll===this?n:e?this.find(n.scroll.domNode.parentNode,!0):null:null}query(t,e=r.ANY){return this.registry.query(t,e)}register(...t){return this.registry.register(...t)}build(){null!=this.scroll&&super.build()}detach(){super.detach(),this.observer.disconnect()}deleteAt(t,e){this.update(),0===t&&e===this.length()?this.children.forEach((t=>{t.remove()})):super.deleteAt(t,e)}formatAt(t,e,n,r){this.update(),super.formatAt(t,e,n,r)}insertAt(t,e,n){this.update(),super.insertAt(t,e,n)}optimize(t=[],e={}){super.optimize(e);const n=e.mutationsMap||new WeakMap;let r=Array.from(this.observer.takeRecords());for(;r.length>0;)t.push(r.pop());const i=(t,e=!0)=>{null==t||t===this||null!=t.domNode.parentNode&&(n.has(t.domNode)||n.set(t.domNode,[]),e&&i(t.parent))},s=t=>{n.has(t.domNode)&&(t instanceof A&&t.children.forEach(s),n.delete(t.domNode),t.optimize(e))};let o=t;for(let e=0;o.length>0;e+=1){if(e>=100)throw new Error("[Parchment] Maximum optimize iterations reached");for(o.forEach((t=>{const e=this.find(t.target,!0);null!=e&&(e.domNode===t.target&&("childList"===t.type?(i(this.find(t.previousSibling,!1)),Array.from(t.addedNodes).forEach((t=>{const e=this.find(t,!1);i(e,!1),e instanceof A&&e.children.forEach((t=>{i(t,!1)}))}))):"attributes"===t.type&&i(e.prev)),i(e))})),this.children.forEach(s),o=Array.from(this.observer.takeRecords()),r=o.slice();r.length>0;)t.push(r.pop())}}update(t,e={}){t=t||this.observer.takeRecords();const n=new WeakMap;t.map((t=>{const e=this.find(t.target,!0);return null==e?null:n.has(e.domNode)?(n.get(e.domNode).push(t),null):(n.set(e.domNode,[t]),e)})).forEach((t=>{null!=t&&t!==this&&n.has(t.domNode)&&t.update(n.get(t.domNode)||[],e)})),e.mutationsMap=n,n.has(this.domNode)&&super.update(n.get(this.domNode),e),this.optimize(t,e)}};S.blotName="scroll",S.defaultChild=w,S.allowedChildren=[w,k],S.scope=r.BLOCK_BLOT,S.tagName="DIV";const O=S,T=class t extends m{static create(t){return document.createTextNode(t)}static value(t){return t.data}constructor(t,e){super(t,e),this.text=this.statics.value(this.domNode)}deleteAt(t,e){this.domNode.data=this.text=this.text.slice(0,t)+this.text.slice(t+e)}index(t,e){return this.domNode===t?e:-1}insertAt(t,e,n){null==n?(this.text=this.text.slice(0,t)+e+this.text.slice(t),this.domNode.data=this.text):super.insertAt(t,e,n)}length(){return this.text.length}optimize(e){super.optimize(e),this.text=this.statics.value(this.domNode),0===this.text.length?this.remove():this.next instanceof t&&this.next.prev===this&&(this.insertAt(this.length(),this.next.value()),this.next.remove())}position(t,e=!1){return[this.domNode,t]}split(t,e=!1){if(!e){if(0===t)return this;if(t===this.length())return this.next}const n=this.scroll.create(this.domNode.splitText(t));return this.parent.insertBefore(n,this.next||void 0),this.text=this.statics.value(this.domNode),n}update(t,e){t.some((t=>"characterData"===t.type&&t.target===this.domNode))&&(this.text=this.statics.value(this.domNode))}value(){return this.text}};T.blotName="text",T.scope=r.INLINE_BLOT;const j=T}},e={};function n(r){var i=e[r];if(void 0!==i)return i.exports;var s=e[r]={id:r,loaded:!1,exports:{}};return t[r](s,s.exports,n),s.loaded=!0,s.exports}n.n=function(t){var e=t&&t.__esModule?function(){return t.default}:function(){return t};return n.d(e,{a:e}),e},n.d=function(t,e){for(var r in e)n.o(e,r)&&!n.o(t,r)&&Object.defineProperty(t,r,{enumerable:!0,get:e[r]})},n.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(t){if("object"==typeof window)return window}}(),n.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},n.r=function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})},n.nmd=function(t){return t.paths=[],t.children||(t.children=[]),t};var r={};return function(){"use strict";n.d(r,{default:function(){return It}});var t=n(3729),e=n(8276),i=n(7912),s=n(6003);class o extends s.ClassAttributor{add(t,e){let n=0;if("+1"===e||"-1"===e){const r=this.value(t)||0;n="+1"===e?r+1:r-1}else"number"==typeof e&&(n=e);return 0===n?(this.remove(t),!0):super.add(t,n.toString())}canAdd(t,e){return super.canAdd(t,e)||super.canAdd(t,parseInt(e,10))}value(t){return parseInt(super.value(t),10)||void 0}}var l=new o("indent","ql-indent",{scope:s.Scope.BLOCK,whitelist:[1,2,3,4,5,6,7,8]}),a=n(9698);class c extends a.Ay{static blotName="blockquote";static tagName="blockquote"}var u=c;class h extends a.Ay{static blotName="header";static tagName=["H1","H2","H3","H4","H5","H6"];static formats(t){return this.tagName.indexOf(t.tagName)+1}}var d=h,f=n(580),p=n(6142);class g extends f.A{}g.blotName="list-container",g.tagName="OL";class m extends a.Ay{static create(t){const e=super.create();return e.setAttribute("data-list",t),e}static formats(t){return t.getAttribute("data-list")||void 0}static register(){p.Ay.register(g)}constructor(t,e){super(t,e);const n=e.ownerDocument.createElement("span"),r=n=>{if(!t.isEnabled())return;const r=this.statics.formats(e,t);"checked"===r?(this.format("list","unchecked"),n.preventDefault()):"unchecked"===r&&(this.format("list","checked"),n.preventDefault())};n.addEventListener("mousedown",r),n.addEventListener("touchstart",r),this.attachUI(n)}format(t,e){t===this.statics.blotName&&e?this.domNode.setAttribute("data-list",e):super.format(t,e)}}m.blotName="list",m.tagName="LI",g.allowedChildren=[m],m.requiredContainer=g;var b=n(9541),y=n(8638),v=n(6772),A=n(664),x=n(4850);class N extends x.A{static blotName="bold";static tagName=["STRONG","B"];static create(){return super.create()}static formats(){return!0}optimize(t){super.optimize(t),this.domNode.tagName!==this.statics.tagName[0]&&this.replaceWith(this.statics.blotName)}}var E=N;class w extends x.A{static blotName="link";static tagName="A";static SANITIZED_URL="about:blank";static PROTOCOL_WHITELIST=["http","https","mailto","tel","sms"];static create(t){const e=super.create(t);return e.setAttribute("href",this.sanitize(t)),e.setAttribute("rel","noopener noreferrer"),e.setAttribute("target","_blank"),e}static formats(t){return t.getAttribute("href")}static sanitize(t){return q(t,this.PROTOCOL_WHITELIST)?t:this.SANITIZED_URL}format(t,e){t===this.statics.blotName&&e?this.domNode.setAttribute("href",this.constructor.sanitize(e)):super.format(t,e)}}function q(t,e){const n=document.createElement("a");n.href=t;const r=n.href.slice(0,n.href.indexOf(":"));return e.indexOf(r)>-1}class k extends x.A{static blotName="script";static tagName=["SUB","SUP"];static create(t){return"super"===t?document.createElement("sup"):"sub"===t?document.createElement("sub"):super.create(t)}static formats(t){return"SUB"===t.tagName?"sub":"SUP"===t.tagName?"super":void 0}}var _=k;class L extends x.A{static blotName="underline";static tagName="U"}var S=L,O=n(746);class T extends O.A{static blotName="formula";static className="ql-formula";static tagName="SPAN";static create(t){if(null==window.katex)throw new Error("Formula module requires KaTeX.");const e=super.create(t);return"string"==typeof t&&(window.katex.render(t,e,{throwOnError:!1,errorColor:"#f00"}),e.setAttribute("data-value",t)),e}static value(t){return t.getAttribute("data-value")}html(){const{formula:t}=this.value();return`<span>${t}</span>`}}var j=T;const C=["alt","height","width"];class R extends s.EmbedBlot{static blotName="image";static tagName="IMG";static create(t){const e=super.create(t);return"string"==typeof t&&e.setAttribute("src",this.sanitize(t)),e}static formats(t){return C.reduce(((e,n)=>(t.hasAttribute(n)&&(e[n]=t.getAttribute(n)),e)),{})}static match(t){return/\.(jpe?g|gif|png)$/.test(t)||/^data:image\/.+;base64/.test(t)}static sanitize(t){return q(t,["http","https","data"])?t:"//:0"}static value(t){return t.getAttribute("src")}format(t,e){C.indexOf(t)>-1?e?this.domNode.setAttribute(t,e):this.domNode.removeAttribute(t):super.format(t,e)}}var I=R;const B=["height","width"];class M extends a.zo{static blotName="video";static className="ql-video";static tagName="IFRAME";static create(t){const e=super.create(t);return e.setAttribute("frameborder","0"),e.setAttribute("allowfullscreen","true"),e.setAttribute("src",this.sanitize(t)),e}static formats(t){return B.reduce(((e,n)=>(t.hasAttribute(n)&&(e[n]=t.getAttribute(n)),e)),{})}static sanitize(t){return w.sanitize(t)}static value(t){return t.getAttribute("src")}format(t,e){B.indexOf(t)>-1?e?this.domNode.setAttribute(t,e):this.domNode.removeAttribute(t):super.format(t,e)}html(){const{video:t}=this.value();return`<a href="${t}">${t}</a>`}}var U=M,D=n(9404),P=n(5232),z=n.n(P),F=n(4266),H=n(3036),$=n(4541),V=n(5508),K=n(584);const W=new s.ClassAttributor("code-token","hljs",{scope:s.Scope.INLINE});class Z extends x.A{static formats(t,e){for(;null!=t&&t!==e.domNode;){if(t.classList&&t.classList.contains(D.Ay.className))return super.formats(t,e);t=t.parentNode}}constructor(t,e,n){super(t,e,n),W.add(this.domNode,n)}format(t,e){t!==Z.blotName?super.format(t,e):e?W.add(this.domNode,e):(W.remove(this.domNode),this.domNode.classList.remove(this.statics.className))}optimize(){super.optimize(...arguments),W.value(this.domNode)||this.unwrap()}}Z.blotName="code-token",Z.className="ql-token";class G extends D.Ay{static create(t){const e=super.create(t);return"string"==typeof t&&e.setAttribute("data-language",t),e}static formats(t){return t.getAttribute("data-language")||"plain"}static register(){}format(t,e){t===this.statics.blotName&&e?this.domNode.setAttribute("data-language",e):super.format(t,e)}replaceWith(t,e){return this.formatAt(0,this.length(),Z.blotName,!1),super.replaceWith(t,e)}}class X extends D.EJ{attach(){super.attach(),this.forceNext=!1,this.scroll.emitMount(this)}format(t,e){t===G.blotName&&(this.forceNext=!0,this.children.forEach((n=>{n.format(t,e)})))}formatAt(t,e,n,r){n===G.blotName&&(this.forceNext=!0),super.formatAt(t,e,n,r)}highlight(t){let e=arguments.length>1&&void 0!==arguments[1]&&arguments[1];if(null==this.children.head)return;const n=`${Array.from(this.domNode.childNodes).filter((t=>t!==this.uiNode)).map((t=>t.textContent)).join("\n")}\n`,r=G.formats(this.children.head.domNode);if(e||this.forceNext||this.cachedText!==n){if(n.trim().length>0||null==this.cachedText){const e=this.children.reduce(((t,e)=>t.concat((0,a.mG)(e,!1))),new(z())),i=t(n,r);e.diff(i).reduce(((t,e)=>{let{retain:n,attributes:r}=e;return n?(r&&Object.keys(r).forEach((e=>{[G.blotName,Z.blotName].includes(e)&&this.formatAt(t,n,e,r[e])})),t+n):t}),0)}this.cachedText=n,this.forceNext=!1}}html(t,e){const[n]=this.children.find(t);return`<pre data-language="${n?G.formats(n.domNode):"plain"}">\n${(0,V.X)(this.code(t,e))}\n</pre>`}optimize(t){if(super.optimize(t),null!=this.parent&&null!=this.children.head&&null!=this.uiNode){const t=G.formats(this.children.head.domNode);t!==this.uiNode.value&&(this.uiNode.value=t)}}}X.allowedChildren=[G],G.requiredContainer=X,G.allowedChildren=[Z,$.A,V.A,H.A];class Q extends F.A{static register(){p.Ay.register(Z,!0),p.Ay.register(G,!0),p.Ay.register(X,!0)}constructor(t,e){if(super(t,e),null==this.options.hljs)throw new Error("Syntax module requires highlight.js. Please include the library on the page before Quill.");this.languages=this.options.languages.reduce(((t,e)=>{let{key:n}=e;return t[n]=!0,t}),{}),this.highlightBlot=this.highlightBlot.bind(this),this.initListener(),this.initTimer()}initListener(){this.quill.on(p.Ay.events.SCROLL_BLOT_MOUNT,(t=>{if(!(t instanceof X))return;const e=this.quill.root.ownerDocument.createElement("select");this.options.languages.forEach((t=>{let{key:n,label:r}=t;const i=e.ownerDocument.createElement("option");i.textContent=r,i.setAttribute("value",n),e.appendChild(i)})),e.addEventListener("change",(()=>{t.format(G.blotName,e.value),this.quill.root.focus(),this.highlight(t,!0)})),null==t.uiNode&&(t.attachUI(e),t.children.head&&(e.value=G.formats(t.children.head.domNode)))}))}initTimer(){let t=null;this.quill.on(p.Ay.events.SCROLL_OPTIMIZE,(()=>{t&&clearTimeout(t),t=setTimeout((()=>{this.highlight(),t=null}),this.options.interval)}))}highlight(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:null,e=arguments.length>1&&void 0!==arguments[1]&&arguments[1];if(this.quill.selection.composing)return;this.quill.update(p.Ay.sources.USER);const n=this.quill.getSelection();(null==t?this.quill.scroll.descendants(X):[t]).forEach((t=>{t.highlight(this.highlightBlot,e)})),this.quill.update(p.Ay.sources.SILENT),null!=n&&this.quill.setSelection(n,p.Ay.sources.SILENT)}highlightBlot(t){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:"plain";if(e=this.languages[e]?e:"plain","plain"===e)return(0,V.X)(t).split("\n").reduce(((t,n,r)=>(0!==r&&t.insert("\n",{[D.Ay.blotName]:e}),t.insert(n))),new(z()));const n=this.quill.root.ownerDocument.createElement("div");return n.classList.add(D.Ay.className),n.innerHTML=((t,e,n)=>{if("string"==typeof t.versionString){const r=t.versionString.split(".")[0];if(parseInt(r,10)>=11)return t.highlight(n,{language:e}).value}return t.highlight(e,n).value})(this.options.hljs,e,t),(0,K.hV)(this.quill.scroll,n,[(t,e)=>{const n=W.value(t);return n?e.compose((new(z())).retain(e.length(),{[Z.blotName]:n})):e}],[(t,n)=>t.data.split("\n").reduce(((t,n,r)=>(0!==r&&t.insert("\n",{[D.Ay.blotName]:e}),t.insert(n))),n)],new WeakMap)}}Q.DEFAULTS={hljs:window.hljs,interval:1e3,languages:[{key:"plain",label:"Plain"},{key:"bash",label:"Bash"},{key:"cpp",label:"C++"},{key:"cs",label:"C#"},{key:"css",label:"CSS"},{key:"diff",label:"Diff"},{key:"xml",label:"HTML/XML"},{key:"java",label:"Java"},{key:"javascript",label:"JavaScript"},{key:"markdown",label:"Markdown"},{key:"php",label:"PHP"},{key:"python",label:"Python"},{key:"ruby",label:"Ruby"},{key:"sql",label:"SQL"}]};class J extends a.Ay{static blotName="table";static tagName="TD";static create(t){const e=super.create();return t?e.setAttribute("data-row",t):e.setAttribute("data-row",nt()),e}static formats(t){if(t.hasAttribute("data-row"))return t.getAttribute("data-row")}cellOffset(){return this.parent?this.parent.children.indexOf(this):-1}format(t,e){t===J.blotName&&e?this.domNode.setAttribute("data-row",e):super.format(t,e)}row(){return this.parent}rowOffset(){return this.row()?this.row().rowOffset():-1}table(){return this.row()&&this.row().table()}}class Y extends f.A{static blotName="table-row";static tagName="TR";checkMerge(){if(super.checkMerge()&&null!=this.next.children.head){const t=this.children.head.formats(),e=this.children.tail.formats(),n=this.next.children.head.formats(),r=this.next.children.tail.formats();return t.table===e.table&&t.table===n.table&&t.table===r.table}return!1}optimize(t){super.optimize(t),this.children.forEach((t=>{if(null==t.next)return;const e=t.formats(),n=t.next.formats();if(e.table!==n.table){const e=this.splitAfter(t);e&&e.optimize(),this.prev&&this.prev.optimize()}}))}rowOffset(){return this.parent?this.parent.children.indexOf(this):-1}table(){return this.parent&&this.parent.parent}}class tt extends f.A{static blotName="table-body";static tagName="TBODY"}class et extends f.A{static blotName="table-container";static tagName="TABLE";balanceCells(){const t=this.descendants(Y),e=t.reduce(((t,e)=>Math.max(e.children.length,t)),0);t.forEach((t=>{new Array(e-t.children.length).fill(0).forEach((()=>{let e;null!=t.children.head&&(e=J.formats(t.children.head.domNode));const n=this.scroll.create(J.blotName,e);t.appendChild(n),n.optimize()}))}))}cells(t){return this.rows().map((e=>e.children.at(t)))}deleteColumn(t){const[e]=this.descendant(tt);null!=e&&null!=e.children.head&&e.children.forEach((e=>{const n=e.children.at(t);null!=n&&n.remove()}))}insertColumn(t){const[e]=this.descendant(tt);null!=e&&null!=e.children.head&&e.children.forEach((e=>{const n=e.children.at(t),r=J.formats(e.children.head.domNode),i=this.scroll.create(J.blotName,r);e.insertBefore(i,n)}))}insertRow(t){const[e]=this.descendant(tt);if(null==e||null==e.children.head)return;const n=nt(),r=this.scroll.create(Y.blotName);e.children.head.children.forEach((()=>{const t=this.scroll.create(J.blotName,n);r.appendChild(t)}));const i=e.children.at(t);e.insertBefore(r,i)}rows(){const t=this.children.head;return null==t?[]:t.children.map((t=>t))}}function nt(){return`row-${Math.random().toString(36).slice(2,6)}`}et.allowedChildren=[tt],tt.requiredContainer=et,tt.allowedChildren=[Y],Y.requiredContainer=tt,Y.allowedChildren=[J],J.requiredContainer=Y;class rt extends F.A{static register(){p.Ay.register(J),p.Ay.register(Y),p.Ay.register(tt),p.Ay.register(et)}constructor(){super(...arguments),this.listenBalanceCells()}balanceTables(){this.quill.scroll.descendants(et).forEach((t=>{t.balanceCells()}))}deleteColumn(){const[t,,e]=this.getTable();null!=e&&(t.deleteColumn(e.cellOffset()),this.quill.update(p.Ay.sources.USER))}deleteRow(){const[,t]=this.getTable();null!=t&&(t.remove(),this.quill.update(p.Ay.sources.USER))}deleteTable(){const[t]=this.getTable();if(null==t)return;const e=t.offset();t.remove(),this.quill.update(p.Ay.sources.USER),this.quill.setSelection(e,p.Ay.sources.SILENT)}getTable(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:this.quill.getSelection();if(null==t)return[null,null,null,-1];const[e,n]=this.quill.getLine(t.index);if(null==e||e.statics.blotName!==J.blotName)return[null,null,null,-1];const r=e.parent;return[r.parent.parent,r,e,n]}insertColumn(t){const e=this.quill.getSelection();if(!e)return;const[n,r,i]=this.getTable(e);if(null==i)return;const s=i.cellOffset();n.insertColumn(s+t),this.quill.update(p.Ay.sources.USER);let o=r.rowOffset();0===t&&(o+=1),this.quill.setSelection(e.index+o,e.length,p.Ay.sources.SILENT)}insertColumnLeft(){this.insertColumn(0)}insertColumnRight(){this.insertColumn(1)}insertRow(t){const e=this.quill.getSelection();if(!e)return;const[n,r,i]=this.getTable(e);if(null==i)return;const s=r.rowOffset();n.insertRow(s+t),this.quill.update(p.Ay.sources.USER),t>0?this.quill.setSelection(e,p.Ay.sources.SILENT):this.quill.setSelection(e.index+r.children.length,e.length,p.Ay.sources.SILENT)}insertRowAbove(){this.insertRow(0)}insertRowBelow(){this.insertRow(1)}insertTable(t,e){const n=this.quill.getSelection();if(null==n)return;const r=new Array(t).fill(0).reduce((t=>{const n=new Array(e).fill("\n").join("");return t.insert(n,{table:nt()})}),(new(z())).retain(n.index));this.quill.updateContents(r,p.Ay.sources.USER),this.quill.setSelection(n.index,p.Ay.sources.SILENT),this.balanceTables()}listenBalanceCells(){this.quill.on(p.Ay.events.SCROLL_OPTIMIZE,(t=>{t.some((t=>!!["TD","TR","TBODY","TABLE"].includes(t.target.tagName)&&(this.quill.once(p.Ay.events.TEXT_CHANGE,((t,e,n)=>{n===p.Ay.sources.USER&&this.balanceTables()})),!0)))}))}}var it=rt;const st=(0,n(6078).A)("quill:toolbar");class ot extends F.A{constructor(t,e){if(super(t,e),Array.isArray(this.options.container)){const e=document.createElement("div");e.setAttribute("role","toolbar"),function(t,e){Array.isArray(e[0])||(e=[e]),e.forEach((e=>{const n=document.createElement("span");n.classList.add("ql-formats"),e.forEach((t=>{if("string"==typeof t)lt(n,t);else{const e=Object.keys(t)[0],r=t[e];Array.isArray(r)?function(t,e,n){const r=document.createElement("select");r.classList.add(`ql-${e}`),n.forEach((t=>{const e=document.createElement("option");!1!==t?e.setAttribute("value",String(t)):e.setAttribute("selected","selected"),r.appendChild(e)})),t.appendChild(r)}(n,e,r):lt(n,e,r)}})),t.appendChild(n)}))}(e,this.options.container),t.container?.parentNode?.insertBefore(e,t.container),this.container=e}else"string"==typeof this.options.container?this.container=document.querySelector(this.options.container):this.container=this.options.container;this.container instanceof HTMLElement?(this.container.classList.add("ql-toolbar"),this.controls=[],this.handlers={},this.options.handlers&&Object.keys(this.options.handlers).forEach((t=>{const e=this.options.handlers?.[t];e&&this.addHandler(t,e)})),Array.from(this.container.querySelectorAll("button, select")).forEach((t=>{this.attach(t)})),this.quill.on(p.Ay.events.EDITOR_CHANGE,(()=>{const[t]=this.quill.selection.getRange();this.update(t)}))):st.error("Container required for toolbar",this.options)}addHandler(t,e){this.handlers[t]=e}attach(t){let e=Array.from(t.classList).find((t=>0===t.indexOf("ql-")));if(!e)return;if(e=e.slice(3),"BUTTON"===t.tagName&&t.setAttribute("type","button"),null==this.handlers[e]&&null==this.quill.scroll.query(e))return void st.warn("ignoring attaching to nonexistent format",e,t);const n="SELECT"===t.tagName?"change":"click";t.addEventListener(n,(n=>{let r;if("SELECT"===t.tagName){if(t.selectedIndex<0)return;const e=t.options[t.selectedIndex];r=!e.hasAttribute("selected")&&(e.value||!1)}else r=!t.classList.contains("ql-active")&&(t.value||!t.hasAttribute("value")),n.preventDefault();this.quill.focus();const[i]=this.quill.selection.getRange();if(null!=this.handlers[e])this.handlers[e].call(this,r);else if(this.quill.scroll.query(e).prototype instanceof s.EmbedBlot){if(r=prompt(`Enter ${e}`),!r)return;this.quill.updateContents((new(z())).retain(i.index).delete(i.length).insert({[e]:r}),p.Ay.sources.USER)}else this.quill.format(e,r,p.Ay.sources.USER);this.update(i)})),this.controls.push([e,t])}update(t){const e=null==t?{}:this.quill.getFormat(t);this.controls.forEach((n=>{const[r,i]=n;if("SELECT"===i.tagName){let n=null;if(null==t)n=null;else if(null==e[r])n=i.querySelector("option[selected]");else if(!Array.isArray(e[r])){let t=e[r];"string"==typeof t&&(t=t.replace(/"/g,'\\"')),n=i.querySelector(`option[value="${t}"]`)}null==n?(i.value="",i.selectedIndex=-1):n.selected=!0}else if(null==t)i.classList.remove("ql-active"),i.setAttribute("aria-pressed","false");else if(i.hasAttribute("value")){const t=e[r],n=t===i.getAttribute("value")||null!=t&&t.toString()===i.getAttribute("value")||null==t&&!i.getAttribute("value");i.classList.toggle("ql-active",n),i.setAttribute("aria-pressed",n.toString())}else{const t=null!=e[r];i.classList.toggle("ql-active",t),i.setAttribute("aria-pressed",t.toString())}}))}}function lt(t,e,n){const r=document.createElement("button");r.setAttribute("type","button"),r.classList.add(`ql-${e}`),r.setAttribute("aria-pressed","false"),null!=n?(r.value=n,r.setAttribute("aria-label",`${e}: ${n}`)):r.setAttribute("aria-label",e),t.appendChild(r)}ot.DEFAULTS={},ot.DEFAULTS={container:null,handlers:{clean(){const t=this.quill.getSelection();if(null!=t)if(0===t.length){const t=this.quill.getFormat();Object.keys(t).forEach((t=>{null!=this.quill.scroll.query(t,s.Scope.INLINE)&&this.quill.format(t,!1,p.Ay.sources.USER)}))}else this.quill.removeFormat(t.index,t.length,p.Ay.sources.USER)},direction(t){const{align:e}=this.quill.getFormat();"rtl"===t&&null==e?this.quill.format("align","right",p.Ay.sources.USER):t||"right"!==e||this.quill.format("align",!1,p.Ay.sources.USER),this.quill.format("direction",t,p.Ay.sources.USER)},indent(t){const e=this.quill.getSelection(),n=this.quill.getFormat(e),r=parseInt(n.indent||0,10);if("+1"===t||"-1"===t){let e="+1"===t?1:-1;"rtl"===n.direction&&(e*=-1),this.quill.format("indent",r+e,p.Ay.sources.USER)}},link(t){!0===t&&(t=prompt("Enter link URL:")),this.quill.format("link",t,p.Ay.sources.USER)},list(t){const e=this.quill.getSelection(),n=this.quill.getFormat(e);"check"===t?"checked"===n.list||"unchecked"===n.list?this.quill.format("list",!1,p.Ay.sources.USER):this.quill.format("list","unchecked",p.Ay.sources.USER):this.quill.format("list",t,p.Ay.sources.USER)}}};const at='<svg viewbox="0 0 18 18"><polyline class="ql-even ql-stroke" points="5 7 3 9 5 11"/><polyline class="ql-even ql-stroke" points="13 7 15 9 13 11"/><line class="ql-stroke" x1="10" x2="8" y1="5" y2="13"/></svg>';var ct={align:{"":'<svg viewbox="0 0 18 18"><line class="ql-stroke" x1="3" x2="15" y1="9" y2="9"/><line class="ql-stroke" x1="3" x2="13" y1="14" y2="14"/><line class="ql-stroke" x1="3" x2="9" y1="4" y2="4"/></svg>',center:'<svg viewbox="0 0 18 18"><line class="ql-stroke" x1="15" x2="3" y1="9" y2="9"/><line class="ql-stroke" x1="14" x2="4" y1="14" y2="14"/><line class="ql-stroke" x1="12" x2="6" y1="4" y2="4"/></svg>',right:'<svg viewbox="0 0 18 18"><line class="ql-stroke" x1="15" x2="3" y1="9" y2="9"/><line class="ql-stroke" x1="15" x2="5" y1="14" y2="14"/><line class="ql-stroke" x1="15" x2="9" y1="4" y2="4"/></svg>',justify:'<svg viewbox="0 0 18 18"><line class="ql-stroke" x1="15" x2="3" y1="9" y2="9"/><line class="ql-stroke" x1="15" x2="3" y1="14" y2="14"/><line class="ql-stroke" x1="15" x2="3" y1="4" y2="4"/></svg>'},background:'<svg viewbox="0 0 18 18"><g class="ql-fill ql-color-label"><polygon points="6 6.868 6 6 5 6 5 7 5.942 7 6 6.868"/><rect height="1" width="1" x="4" y="4"/><polygon points="6.817 5 6 5 6 6 6.38 6 6.817 5"/><rect height="1" width="1" x="2" y="6"/><rect height="1" width="1" x="3" y="5"/><rect height="1" width="1" x="4" y="7"/><polygon points="4 11.439 4 11 3 11 3 12 3.755 12 4 11.439"/><rect height="1" width="1" x="2" y="12"/><rect height="1" width="1" x="2" y="9"/><rect height="1" width="1" x="2" y="15"/><polygon points="4.63 10 4 10 4 11 4.192 11 4.63 10"/><rect height="1" width="1" x="3" y="8"/><path d="M10.832,4.2L11,4.582V4H10.708A1.948,1.948,0,0,1,10.832,4.2Z"/><path d="M7,4.582L7.168,4.2A1.929,1.929,0,0,1,7.292,4H7V4.582Z"/><path d="M8,13H7.683l-0.351.8a1.933,1.933,0,0,1-.124.2H8V13Z"/><rect height="1" width="1" x="12" y="2"/><rect height="1" width="1" x="11" y="3"/><path d="M9,3H8V3.282A1.985,1.985,0,0,1,9,3Z"/><rect height="1" width="1" x="2" y="3"/><rect height="1" width="1" x="6" y="2"/><rect height="1" width="1" x="3" y="2"/><rect height="1" width="1" x="5" y="3"/><rect height="1" width="1" x="9" y="2"/><rect height="1" width="1" x="15" y="14"/><polygon points="13.447 10.174 13.469 10.225 13.472 10.232 13.808 11 14 11 14 10 13.37 10 13.447 10.174"/><rect height="1" width="1" x="13" y="7"/><rect height="1" width="1" x="15" y="5"/><rect height="1" width="1" x="14" y="6"/><rect height="1" width="1" x="15" y="8"/><rect height="1" width="1" x="14" y="9"/><path d="M3.775,14H3v1H4V14.314A1.97,1.97,0,0,1,3.775,14Z"/><rect height="1" width="1" x="14" y="3"/><polygon points="12 6.868 12 6 11.62 6 12 6.868"/><rect height="1" width="1" x="15" y="2"/><rect height="1" width="1" x="12" y="5"/><rect height="1" width="1" x="13" y="4"/><polygon points="12.933 9 13 9 13 8 12.495 8 12.933 9"/><rect height="1" width="1" x="9" y="14"/><rect height="1" width="1" x="8" y="15"/><path d="M6,14.926V15H7V14.316A1.993,1.993,0,0,1,6,14.926Z"/><rect height="1" width="1" x="5" y="15"/><path d="M10.668,13.8L10.317,13H10v1h0.792A1.947,1.947,0,0,1,10.668,13.8Z"/><rect height="1" width="1" x="11" y="15"/><path d="M14.332,12.2a1.99,1.99,0,0,1,.166.8H15V12H14.245Z"/><rect height="1" width="1" x="14" y="15"/><rect height="1" width="1" x="15" y="11"/></g><polyline class="ql-stroke" points="5.5 13 9 5 12.5 13"/><line class="ql-stroke" x1="11.63" x2="6.38" y1="11" y2="11"/></svg>',blockquote:'<svg viewbox="0 0 18 18"><rect class="ql-fill ql-stroke" height="3" width="3" x="4" y="5"/><rect class="ql-fill ql-stroke" height="3" width="3" x="11" y="5"/><path class="ql-even ql-fill ql-stroke" d="M7,8c0,4.031-3,5-3,5"/><path class="ql-even ql-fill ql-stroke" d="M14,8c0,4.031-3,5-3,5"/></svg>',bold:'<svg viewbox="0 0 18 18"><path class="ql-stroke" d="M5,4H9.5A2.5,2.5,0,0,1,12,6.5v0A2.5,2.5,0,0,1,9.5,9H5A0,0,0,0,1,5,9V4A0,0,0,0,1,5,4Z"/><path class="ql-stroke" d="M5,9h5.5A2.5,2.5,0,0,1,13,11.5v0A2.5,2.5,0,0,1,10.5,14H5a0,0,0,0,1,0,0V9A0,0,0,0,1,5,9Z"/></svg>',clean:'<svg class="" viewbox="0 0 18 18"><line class="ql-stroke" x1="5" x2="13" y1="3" y2="3"/><line class="ql-stroke" x1="6" x2="9.35" y1="12" y2="3"/><line class="ql-stroke" x1="11" x2="15" y1="11" y2="15"/><line class="ql-stroke" x1="15" x2="11" y1="11" y2="15"/><rect class="ql-fill" height="1" rx="0.5" ry="0.5" width="7" x="2" y="14"/></svg>',code:at,"code-block":at,color:'<svg viewbox="0 0 18 18"><line class="ql-color-label ql-stroke ql-transparent" x1="3" x2="15" y1="15" y2="15"/><polyline class="ql-stroke" points="5.5 11 9 3 12.5 11"/><line class="ql-stroke" x1="11.63" x2="6.38" y1="9" y2="9"/></svg>',direction:{"":'<svg viewbox="0 0 18 18"><polygon class="ql-stroke ql-fill" points="3 11 5 9 3 7 3 11"/><line class="ql-stroke ql-fill" x1="15" x2="11" y1="4" y2="4"/><path class="ql-fill" d="M11,3a3,3,0,0,0,0,6h1V3H11Z"/><rect class="ql-fill" height="11" width="1" x="11" y="4"/><rect class="ql-fill" height="11" width="1" x="13" y="4"/></svg>',rtl:'<svg viewbox="0 0 18 18"><polygon class="ql-stroke ql-fill" points="15 12 13 10 15 8 15 12"/><line class="ql-stroke ql-fill" x1="9" x2="5" y1="4" y2="4"/><path class="ql-fill" d="M5,3A3,3,0,0,0,5,9H6V3H5Z"/><rect class="ql-fill" height="11" width="1" x="5" y="4"/><rect class="ql-fill" height="11" width="1" x="7" y="4"/></svg>'},formula:'<svg viewbox="0 0 18 18"><path class="ql-fill" d="M11.759,2.482a2.561,2.561,0,0,0-3.53.607A7.656,7.656,0,0,0,6.8,6.2C6.109,9.188,5.275,14.677,4.15,14.927a1.545,1.545,0,0,0-1.3-.933A0.922,0.922,0,0,0,2,15.036S1.954,16,4.119,16s3.091-2.691,3.7-5.553c0.177-.826.36-1.726,0.554-2.6L8.775,6.2c0.381-1.421.807-2.521,1.306-2.676a1.014,1.014,0,0,0,1.02.56A0.966,0.966,0,0,0,11.759,2.482Z"/><rect class="ql-fill" height="1.6" rx="0.8" ry="0.8" width="5" x="5.15" y="6.2"/><path class="ql-fill" d="M13.663,12.027a1.662,1.662,0,0,1,.266-0.276q0.193,0.069.456,0.138a2.1,2.1,0,0,0,.535.069,1.075,1.075,0,0,0,.767-0.3,1.044,1.044,0,0,0,.314-0.8,0.84,0.84,0,0,0-.238-0.619,0.8,0.8,0,0,0-.594-0.239,1.154,1.154,0,0,0-.781.3,4.607,4.607,0,0,0-.781,1q-0.091.15-.218,0.346l-0.246.38c-0.068-.288-0.137-0.582-0.212-0.885-0.459-1.847-2.494-.984-2.941-0.8-0.482.2-.353,0.647-0.094,0.529a0.869,0.869,0,0,1,1.281.585c0.217,0.751.377,1.436,0.527,2.038a5.688,5.688,0,0,1-.362.467,2.69,2.69,0,0,1-.264.271q-0.221-.08-0.471-0.147a2.029,2.029,0,0,0-.522-0.066,1.079,1.079,0,0,0-.768.3A1.058,1.058,0,0,0,9,15.131a0.82,0.82,0,0,0,.832.852,1.134,1.134,0,0,0,.787-0.3,5.11,5.11,0,0,0,.776-0.993q0.141-.219.215-0.34c0.046-.076.122-0.194,0.223-0.346a2.786,2.786,0,0,0,.918,1.726,2.582,2.582,0,0,0,2.376-.185c0.317-.181.212-0.565,0-0.494A0.807,0.807,0,0,1,14.176,15a5.159,5.159,0,0,1-.913-2.446l0,0Q13.487,12.24,13.663,12.027Z"/></svg>',header:{1:'<svg viewBox="0 0 18 18"><path class="ql-fill" d="M10,4V14a1,1,0,0,1-2,0V10H3v4a1,1,0,0,1-2,0V4A1,1,0,0,1,3,4V8H8V4a1,1,0,0,1,2,0Zm6.06787,9.209H14.98975V7.59863a.54085.54085,0,0,0-.605-.60547h-.62744a1.01119,1.01119,0,0,0-.748.29688L11.645,8.56641a.5435.5435,0,0,0-.022.8584l.28613.30762a.53861.53861,0,0,0,.84717.0332l.09912-.08789a1.2137,1.2137,0,0,0,.2417-.35254h.02246s-.01123.30859-.01123.60547V13.209H12.041a.54085.54085,0,0,0-.605.60547v.43945a.54085.54085,0,0,0,.605.60547h4.02686a.54085.54085,0,0,0,.605-.60547v-.43945A.54085.54085,0,0,0,16.06787,13.209Z"/></svg>',2:'<svg viewBox="0 0 18 18"><path class="ql-fill" d="M16.73975,13.81445v.43945a.54085.54085,0,0,1-.605.60547H11.855a.58392.58392,0,0,1-.64893-.60547V14.0127c0-2.90527,3.39941-3.42187,3.39941-4.55469a.77675.77675,0,0,0-.84717-.78125,1.17684,1.17684,0,0,0-.83594.38477c-.2749.26367-.561.374-.85791.13184l-.4292-.34082c-.30811-.24219-.38525-.51758-.1543-.81445a2.97155,2.97155,0,0,1,2.45361-1.17676,2.45393,2.45393,0,0,1,2.68408,2.40918c0,2.45312-3.1792,2.92676-3.27832,3.93848h2.79443A.54085.54085,0,0,1,16.73975,13.81445ZM9,3A.99974.99974,0,0,0,8,4V8H3V4A1,1,0,0,0,1,4V14a1,1,0,0,0,2,0V10H8v4a1,1,0,0,0,2,0V4A.99974.99974,0,0,0,9,3Z"/></svg>',3:'<svg viewBox="0 0 18 18"><path class="ql-fill" d="M16.65186,12.30664a2.6742,2.6742,0,0,1-2.915,2.68457,3.96592,3.96592,0,0,1-2.25537-.6709.56007.56007,0,0,1-.13232-.83594L11.64648,13c.209-.34082.48389-.36328.82471-.1543a2.32654,2.32654,0,0,0,1.12256.33008c.71484,0,1.12207-.35156,1.12207-.78125,0-.61523-.61621-.86816-1.46338-.86816H13.2085a.65159.65159,0,0,1-.68213-.41895l-.05518-.10937a.67114.67114,0,0,1,.14307-.78125l.71533-.86914a8.55289,8.55289,0,0,1,.68213-.7373V8.58887a3.93913,3.93913,0,0,1-.748.05469H11.9873a.54085.54085,0,0,1-.605-.60547V7.59863a.54085.54085,0,0,1,.605-.60547h3.75146a.53773.53773,0,0,1,.60547.59375v.17676a1.03723,1.03723,0,0,1-.27539.748L14.74854,10.0293A2.31132,2.31132,0,0,1,16.65186,12.30664ZM9,3A.99974.99974,0,0,0,8,4V8H3V4A1,1,0,0,0,1,4V14a1,1,0,0,0,2,0V10H8v4a1,1,0,0,0,2,0V4A.99974.99974,0,0,0,9,3Z"/></svg>',4:'<svg viewBox="0 0 18 18"><path class="ql-fill" d="M10,4V14a1,1,0,0,1-2,0V10H3v4a1,1,0,0,1-2,0V4A1,1,0,0,1,3,4V8H8V4a1,1,0,0,1,2,0Zm7.05371,7.96582v.38477c0,.39648-.165.60547-.46191.60547h-.47314v1.29785a.54085.54085,0,0,1-.605.60547h-.69336a.54085.54085,0,0,1-.605-.60547V12.95605H11.333a.5412.5412,0,0,1-.60547-.60547v-.15332a1.199,1.199,0,0,1,.22021-.748l2.56348-4.05957a.7819.7819,0,0,1,.72607-.39648h1.27637a.54085.54085,0,0,1,.605.60547v3.7627h.33008A.54055.54055,0,0,1,17.05371,11.96582ZM14.28125,8.7207h-.022a4.18969,4.18969,0,0,1-.38525.81348l-1.188,1.80469v.02246h1.5293V9.60059A7.04058,7.04058,0,0,1,14.28125,8.7207Z"/></svg>',5:'<svg viewBox="0 0 18 18"><path class="ql-fill" d="M16.74023,12.18555a2.75131,2.75131,0,0,1-2.91553,2.80566,3.908,3.908,0,0,1-2.25537-.68164.54809.54809,0,0,1-.13184-.8252L11.73438,13c.209-.34082.48389-.36328.8252-.1543a2.23757,2.23757,0,0,0,1.1001.33008,1.01827,1.01827,0,0,0,1.1001-.96777c0-.61621-.53906-.97949-1.25439-.97949a2.15554,2.15554,0,0,0-.64893.09961,1.15209,1.15209,0,0,1-.814.01074l-.12109-.04395a.64116.64116,0,0,1-.45117-.71484l.231-3.00391a.56666.56666,0,0,1,.62744-.583H15.541a.54085.54085,0,0,1,.605.60547v.43945a.54085.54085,0,0,1-.605.60547H13.41748l-.04395.72559a1.29306,1.29306,0,0,1-.04395.30859h.022a2.39776,2.39776,0,0,1,.57227-.07715A2.53266,2.53266,0,0,1,16.74023,12.18555ZM9,3A.99974.99974,0,0,0,8,4V8H3V4A1,1,0,0,0,1,4V14a1,1,0,0,0,2,0V10H8v4a1,1,0,0,0,2,0V4A.99974.99974,0,0,0,9,3Z"/></svg>',6:'<svg viewBox="0 0 18 18"><path class="ql-fill" d="M14.51758,9.64453a1.85627,1.85627,0,0,0-1.24316.38477H13.252a1.73532,1.73532,0,0,1,1.72754-1.4082,2.66491,2.66491,0,0,1,.5498.06641c.35254.05469.57227.01074.70508-.40723l.16406-.5166a.53393.53393,0,0,0-.373-.75977,4.83723,4.83723,0,0,0-1.17773-.14258c-2.43164,0-3.7627,2.17773-3.7627,4.43359,0,2.47559,1.60645,3.69629,3.19043,3.69629A2.70585,2.70585,0,0,0,16.96,12.19727,2.43861,2.43861,0,0,0,14.51758,9.64453Zm-.23047,3.58691c-.67187,0-1.22168-.81445-1.22168-1.45215,0-.47363.30762-.583.72559-.583.96875,0,1.27734.59375,1.27734,1.12207A.82182.82182,0,0,1,14.28711,13.23145ZM10,4V14a1,1,0,0,1-2,0V10H3v4a1,1,0,0,1-2,0V4A1,1,0,0,1,3,4V8H8V4a1,1,0,0,1,2,0Z"/></svg>'},italic:'<svg viewbox="0 0 18 18"><line class="ql-stroke" x1="7" x2="13" y1="4" y2="4"/><line class="ql-stroke" x1="5" x2="11" y1="14" y2="14"/><line class="ql-stroke" x1="8" x2="10" y1="14" y2="4"/></svg>',image:'<svg viewbox="0 0 18 18"><rect class="ql-stroke" height="10" width="12" x="3" y="4"/><circle class="ql-fill" cx="6" cy="7" r="1"/><polyline class="ql-even ql-fill" points="5 12 5 11 7 9 8 10 11 7 13 9 13 12 5 12"/></svg>',indent:{"+1":'<svg viewbox="0 0 18 18"><line class="ql-stroke" x1="3" x2="15" y1="14" y2="14"/><line class="ql-stroke" x1="3" x2="15" y1="4" y2="4"/><line class="ql-stroke" x1="9" x2="15" y1="9" y2="9"/><polyline class="ql-fill ql-stroke" points="3 7 3 11 5 9 3 7"/></svg>',"-1":'<svg viewbox="0 0 18 18"><line class="ql-stroke" x1="3" x2="15" y1="14" y2="14"/><line class="ql-stroke" x1="3" x2="15" y1="4" y2="4"/><line class="ql-stroke" x1="9" x2="15" y1="9" y2="9"/><polyline class="ql-stroke" points="5 7 5 11 3 9 5 7"/></svg>'},link:'<svg viewbox="0 0 18 18"><line class="ql-stroke" x1="7" x2="11" y1="7" y2="11"/><path class="ql-even ql-stroke" d="M8.9,4.577a3.476,3.476,0,0,1,.36,4.679A3.476,3.476,0,0,1,4.577,8.9C3.185,7.5,2.035,6.4,4.217,4.217S7.5,3.185,8.9,4.577Z"/><path class="ql-even ql-stroke" d="M13.423,9.1a3.476,3.476,0,0,0-4.679-.36,3.476,3.476,0,0,0,.36,4.679c1.392,1.392,2.5,2.542,4.679.36S14.815,10.5,13.423,9.1Z"/></svg>',list:{bullet:'<svg viewbox="0 0 18 18"><line class="ql-stroke" x1="6" x2="15" y1="4" y2="4"/><line class="ql-stroke" x1="6" x2="15" y1="9" y2="9"/><line class="ql-stroke" x1="6" x2="15" y1="14" y2="14"/><line class="ql-stroke" x1="3" x2="3" y1="4" y2="4"/><line class="ql-stroke" x1="3" x2="3" y1="9" y2="9"/><line class="ql-stroke" x1="3" x2="3" y1="14" y2="14"/></svg>',check:'<svg class="" viewbox="0 0 18 18"><line class="ql-stroke" x1="9" x2="15" y1="4" y2="4"/><polyline class="ql-stroke" points="3 4 4 5 6 3"/><line class="ql-stroke" x1="9" x2="15" y1="14" y2="14"/><polyline class="ql-stroke" points="3 14 4 15 6 13"/><line class="ql-stroke" x1="9" x2="15" y1="9" y2="9"/><polyline class="ql-stroke" points="3 9 4 10 6 8"/></svg>',ordered:'<svg viewbox="0 0 18 18"><line class="ql-stroke" x1="7" x2="15" y1="4" y2="4"/><line class="ql-stroke" x1="7" x2="15" y1="9" y2="9"/><line class="ql-stroke" x1="7" x2="15" y1="14" y2="14"/><line class="ql-stroke ql-thin" x1="2.5" x2="4.5" y1="5.5" y2="5.5"/><path class="ql-fill" d="M3.5,6A0.5,0.5,0,0,1,3,5.5V3.085l-0.276.138A0.5,0.5,0,0,1,2.053,3c-0.124-.247-0.023-0.324.224-0.447l1-.5A0.5,0.5,0,0,1,4,2.5v3A0.5,0.5,0,0,1,3.5,6Z"/><path class="ql-stroke ql-thin" d="M4.5,10.5h-2c0-.234,1.85-1.076,1.85-2.234A0.959,0.959,0,0,0,2.5,8.156"/><path class="ql-stroke ql-thin" d="M2.5,14.846a0.959,0.959,0,0,0,1.85-.109A0.7,0.7,0,0,0,3.75,14a0.688,0.688,0,0,0,.6-0.736,0.959,0.959,0,0,0-1.85-.109"/></svg>'},script:{sub:'<svg viewbox="0 0 18 18"><path class="ql-fill" d="M15.5,15H13.861a3.858,3.858,0,0,0,1.914-2.975,1.8,1.8,0,0,0-1.6-1.751A1.921,1.921,0,0,0,12.021,11.7a0.50013,0.50013,0,1,0,.957.291h0a0.914,0.914,0,0,1,1.053-.725,0.81,0.81,0,0,1,.744.762c0,1.076-1.16971,1.86982-1.93971,2.43082A1.45639,1.45639,0,0,0,12,15.5a0.5,0.5,0,0,0,.5.5h3A0.5,0.5,0,0,0,15.5,15Z"/><path class="ql-fill" d="M9.65,5.241a1,1,0,0,0-1.409.108L6,7.964,3.759,5.349A1,1,0,0,0,2.192,6.59178Q2.21541,6.6213,2.241,6.649L4.684,9.5,2.241,12.35A1,1,0,0,0,3.71,13.70722q0.02557-.02768.049-0.05722L6,11.036,8.241,13.65a1,1,0,1,0,1.567-1.24277Q9.78459,12.3777,9.759,12.35L7.316,9.5,9.759,6.651A1,1,0,0,0,9.65,5.241Z"/></svg>',super:'<svg viewbox="0 0 18 18"><path class="ql-fill" d="M15.5,7H13.861a4.015,4.015,0,0,0,1.914-2.975,1.8,1.8,0,0,0-1.6-1.751A1.922,1.922,0,0,0,12.021,3.7a0.5,0.5,0,1,0,.957.291,0.917,0.917,0,0,1,1.053-.725,0.81,0.81,0,0,1,.744.762c0,1.077-1.164,1.925-1.934,2.486A1.423,1.423,0,0,0,12,7.5a0.5,0.5,0,0,0,.5.5h3A0.5,0.5,0,0,0,15.5,7Z"/><path class="ql-fill" d="M9.651,5.241a1,1,0,0,0-1.41.108L6,7.964,3.759,5.349a1,1,0,1,0-1.519,1.3L4.683,9.5,2.241,12.35a1,1,0,1,0,1.519,1.3L6,11.036,8.241,13.65a1,1,0,0,0,1.519-1.3L7.317,9.5,9.759,6.651A1,1,0,0,0,9.651,5.241Z"/></svg>'},strike:'<svg viewbox="0 0 18 18"><line class="ql-stroke ql-thin" x1="15.5" x2="2.5" y1="8.5" y2="9.5"/><path class="ql-fill" d="M9.007,8C6.542,7.791,6,7.519,6,6.5,6,5.792,7.283,5,9,5c1.571,0,2.765.679,2.969,1.309a1,1,0,0,0,1.9-.617C13.356,4.106,11.354,3,9,3,6.2,3,4,4.538,4,6.5a3.2,3.2,0,0,0,.5,1.843Z"/><path class="ql-fill" d="M8.984,10C11.457,10.208,12,10.479,12,11.5c0,0.708-1.283,1.5-3,1.5-1.571,0-2.765-.679-2.969-1.309a1,1,0,1,0-1.9.617C4.644,13.894,6.646,15,9,15c2.8,0,5-1.538,5-3.5a3.2,3.2,0,0,0-.5-1.843Z"/></svg>',table:'<svg viewbox="0 0 18 18"><rect class="ql-stroke" height="12" width="12" x="3" y="3"/><rect class="ql-fill" height="2" width="3" x="5" y="5"/><rect class="ql-fill" height="2" width="4" x="9" y="5"/><g class="ql-fill ql-transparent"><rect height="2" width="3" x="5" y="8"/><rect height="2" width="4" x="9" y="8"/><rect height="2" width="3" x="5" y="11"/><rect height="2" width="4" x="9" y="11"/></g></svg>',underline:'<svg viewbox="0 0 18 18"><path class="ql-stroke" d="M5,3V9a4.012,4.012,0,0,0,4,4H9a4.012,4.012,0,0,0,4-4V3"/><rect class="ql-fill" height="1" rx="0.5" ry="0.5" width="12" x="3" y="15"/></svg>',video:'<svg viewbox="0 0 18 18"><rect class="ql-stroke" height="12" width="12" x="3" y="3"/><rect class="ql-fill" height="12" width="1" x="5" y="3"/><rect class="ql-fill" height="12" width="1" x="12" y="3"/><rect class="ql-fill" height="2" width="8" x="5" y="8"/><rect class="ql-fill" height="1" width="3" x="3" y="5"/><rect class="ql-fill" height="1" width="3" x="3" y="7"/><rect class="ql-fill" height="1" width="3" x="3" y="10"/><rect class="ql-fill" height="1" width="3" x="3" y="12"/><rect class="ql-fill" height="1" width="3" x="12" y="5"/><rect class="ql-fill" height="1" width="3" x="12" y="7"/><rect class="ql-fill" height="1" width="3" x="12" y="10"/><rect class="ql-fill" height="1" width="3" x="12" y="12"/></svg>'};let ut=0;function ht(t,e){t.setAttribute(e,`${!("true"===t.getAttribute(e))}`)}var dt=class{constructor(t){this.select=t,this.container=document.createElement("span"),this.buildPicker(),this.select.style.display="none",this.select.parentNode.insertBefore(this.container,this.select),this.label.addEventListener("mousedown",(()=>{this.togglePicker()})),this.label.addEventListener("keydown",(t=>{switch(t.key){case"Enter":this.togglePicker();break;case"Escape":this.escape(),t.preventDefault()}})),this.select.addEventListener("change",this.update.bind(this))}togglePicker(){this.container.classList.toggle("ql-expanded"),ht(this.label,"aria-expanded"),ht(this.options,"aria-hidden")}buildItem(t){const e=document.createElement("span");e.tabIndex="0",e.setAttribute("role","button"),e.classList.add("ql-picker-item");const n=t.getAttribute("value");return n&&e.setAttribute("data-value",n),t.textContent&&e.setAttribute("data-label",t.textContent),e.addEventListener("click",(()=>{this.selectItem(e,!0)})),e.addEventListener("keydown",(t=>{switch(t.key){case"Enter":this.selectItem(e,!0),t.preventDefault();break;case"Escape":this.escape(),t.preventDefault()}})),e}buildLabel(){const t=document.createElement("span");return t.classList.add("ql-picker-label"),t.innerHTML='<svg viewbox="0 0 18 18"><polygon class="ql-stroke" points="7 11 9 13 11 11 7 11"/><polygon class="ql-stroke" points="7 7 9 5 11 7 7 7"/></svg>',t.tabIndex="0",t.setAttribute("role","button"),t.setAttribute("aria-expanded","false"),this.container.appendChild(t),t}buildOptions(){const t=document.createElement("span");t.classList.add("ql-picker-options"),t.setAttribute("aria-hidden","true"),t.tabIndex="-1",t.id=`ql-picker-options-${ut}`,ut+=1,this.label.setAttribute("aria-controls",t.id),this.options=t,Array.from(this.select.options).forEach((e=>{const n=this.buildItem(e);t.appendChild(n),!0===e.selected&&this.selectItem(n)})),this.container.appendChild(t)}buildPicker(){Array.from(this.select.attributes).forEach((t=>{this.container.setAttribute(t.name,t.value)})),this.container.classList.add("ql-picker"),this.label=this.buildLabel(),this.buildOptions()}escape(){this.close(),setTimeout((()=>this.label.focus()),1)}close(){this.container.classList.remove("ql-expanded"),this.label.setAttribute("aria-expanded","false"),this.options.setAttribute("aria-hidden","true")}selectItem(t){let e=arguments.length>1&&void 0!==arguments[1]&&arguments[1];const n=this.container.querySelector(".ql-selected");t!==n&&(null!=n&&n.classList.remove("ql-selected"),null!=t&&(t.classList.add("ql-selected"),this.select.selectedIndex=Array.from(t.parentNode.children).indexOf(t),t.hasAttribute("data-value")?this.label.setAttribute("data-value",t.getAttribute("data-value")):this.label.removeAttribute("data-value"),t.hasAttribute("data-label")?this.label.setAttribute("data-label",t.getAttribute("data-label")):this.label.removeAttribute("data-label"),e&&(this.select.dispatchEvent(new Event("change")),this.close())))}update(){let t;if(this.select.selectedIndex>-1){const e=this.container.querySelector(".ql-picker-options").children[this.select.selectedIndex];t=this.select.options[this.select.selectedIndex],this.selectItem(e)}else this.selectItem(null);const e=null!=t&&t!==this.select.querySelector("option[selected]");this.label.classList.toggle("ql-active",e)}},ft=class extends dt{constructor(t,e){super(t),this.label.innerHTML=e,this.container.classList.add("ql-color-picker"),Array.from(this.container.querySelectorAll(".ql-picker-item")).slice(0,7).forEach((t=>{t.classList.add("ql-primary")}))}buildItem(t){const e=super.buildItem(t);return e.style.backgroundColor=t.getAttribute("value")||"",e}selectItem(t,e){super.selectItem(t,e);const n=this.label.querySelector(".ql-color-label"),r=t&&t.getAttribute("data-value")||"";n&&("line"===n.tagName?n.style.stroke=r:n.style.fill=r)}},pt=class extends dt{constructor(t,e){super(t),this.container.classList.add("ql-icon-picker"),Array.from(this.container.querySelectorAll(".ql-picker-item")).forEach((t=>{t.innerHTML=e[t.getAttribute("data-value")||""]})),this.defaultItem=this.container.querySelector(".ql-selected"),this.selectItem(this.defaultItem)}selectItem(t,e){super.selectItem(t,e);const n=t||this.defaultItem;if(null!=n){if(this.label.innerHTML===n.innerHTML)return;this.label.innerHTML=n.innerHTML}}},gt=class{constructor(t,e){this.quill=t,this.boundsContainer=e||document.body,this.root=t.addContainer("ql-tooltip"),this.root.innerHTML=this.constructor.TEMPLATE,(t=>{const{overflowY:e}=getComputedStyle(t,null);return"visible"!==e&&"clip"!==e})(this.quill.root)&&this.quill.root.addEventListener("scroll",(()=>{this.root.style.marginTop=-1*this.quill.root.scrollTop+"px"})),this.hide()}hide(){this.root.classList.add("ql-hidden")}position(t){const e=t.left+t.width/2-this.root.offsetWidth/2,n=t.bottom+this.quill.root.scrollTop;this.root.style.left=`${e}px`,this.root.style.top=`${n}px`,this.root.classList.remove("ql-flip");const r=this.boundsContainer.getBoundingClientRect(),i=this.root.getBoundingClientRect();let s=0;if(i.right>r.right&&(s=r.right-i.right,this.root.style.left=`${e+s}px`),i.left<r.left&&(s=r.left-i.left,this.root.style.left=`${e+s}px`),i.bottom>r.bottom){const e=i.bottom-i.top,r=t.bottom-t.top+e;this.root.style.top=n-r+"px",this.root.classList.add("ql-flip")}return s}show(){this.root.classList.remove("ql-editing"),this.root.classList.remove("ql-hidden")}},mt=n(8347),bt=n(5374),yt=n(9609);const vt=[!1,"center","right","justify"],At=["#000000","#e60000","#ff9900","#ffff00","#008a00","#0066cc","#9933ff","#ffffff","#facccc","#ffebcc","#ffffcc","#cce8cc","#cce0f5","#ebd6ff","#bbbbbb","#f06666","#ffc266","#ffff66","#66b966","#66a3e0","#c285ff","#888888","#a10000","#b26b00","#b2b200","#006100","#0047b2","#6b24b2","#444444","#5c0000","#663d00","#666600","#003700","#002966","#3d1466"],xt=[!1,"serif","monospace"],Nt=["1","2","3",!1],Et=["small",!1,"large","huge"];class wt extends yt.A{constructor(t,e){super(t,e);const n=e=>{document.body.contains(t.root)?(null==this.tooltip||this.tooltip.root.contains(e.target)||document.activeElement===this.tooltip.textbox||this.quill.hasFocus()||this.tooltip.hide(),null!=this.pickers&&this.pickers.forEach((t=>{t.container.contains(e.target)||t.close()}))):document.body.removeEventListener("click",n)};t.emitter.listenDOM("click",document.body,n)}addModule(t){const e=super.addModule(t);return"toolbar"===t&&this.extendToolbar(e),e}buildButtons(t,e){Array.from(t).forEach((t=>{(t.getAttribute("class")||"").split(/\s+/).forEach((n=>{if(n.startsWith("ql-")&&(n=n.slice(3),null!=e[n]))if("direction"===n)t.innerHTML=e[n][""]+e[n].rtl;else if("string"==typeof e[n])t.innerHTML=e[n];else{const r=t.value||"";null!=r&&e[n][r]&&(t.innerHTML=e[n][r])}}))}))}buildPickers(t,e){this.pickers=Array.from(t).map((t=>{if(t.classList.contains("ql-align")&&(null==t.querySelector("option")&&kt(t,vt),"object"==typeof e.align))return new pt(t,e.align);if(t.classList.contains("ql-background")||t.classList.contains("ql-color")){const n=t.classList.contains("ql-background")?"background":"color";return null==t.querySelector("option")&&kt(t,At,"background"===n?"#ffffff":"#000000"),new ft(t,e[n])}return null==t.querySelector("option")&&(t.classList.contains("ql-font")?kt(t,xt):t.classList.contains("ql-header")?kt(t,Nt):t.classList.contains("ql-size")&&kt(t,Et)),new dt(t)})),this.quill.on(bt.A.events.EDITOR_CHANGE,(()=>{this.pickers.forEach((t=>{t.update()}))}))}}wt.DEFAULTS=(0,mt.A)({},yt.A.DEFAULTS,{modules:{toolbar:{handlers:{formula(){this.quill.theme.tooltip.edit("formula")},image(){let t=this.container.querySelector("input.ql-image[type=file]");null==t&&(t=document.createElement("input"),t.setAttribute("type","file"),t.setAttribute("accept",this.quill.uploader.options.mimetypes.join(", ")),t.classList.add("ql-image"),t.addEventListener("change",(()=>{const e=this.quill.getSelection(!0);this.quill.uploader.upload(e,t.files),t.value=""})),this.container.appendChild(t)),t.click()},video(){this.quill.theme.tooltip.edit("video")}}}}});class qt extends gt{constructor(t,e){super(t,e),this.textbox=this.root.querySelector('input[type="text"]'),this.listen()}listen(){this.textbox.addEventListener("keydown",(t=>{"Enter"===t.key?(this.save(),t.preventDefault()):"Escape"===t.key&&(this.cancel(),t.preventDefault())}))}cancel(){this.hide(),this.restoreFocus()}edit(){let t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"link",e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:null;if(this.root.classList.remove("ql-hidden"),this.root.classList.add("ql-editing"),null==this.textbox)return;null!=e?this.textbox.value=e:t!==this.root.getAttribute("data-mode")&&(this.textbox.value="");const n=this.quill.getBounds(this.quill.selection.savedRange);null!=n&&this.position(n),this.textbox.select(),this.textbox.setAttribute("placeholder",this.textbox.getAttribute(`data-${t}`)||""),this.root.setAttribute("data-mode",t)}restoreFocus(){this.quill.focus({preventScroll:!0})}save(){let{value:t}=this.textbox;switch(this.root.getAttribute("data-mode")){case"link":{const{scrollTop:e}=this.quill.root;this.linkRange?(this.quill.formatText(this.linkRange,"link",t,bt.A.sources.USER),delete this.linkRange):(this.restoreFocus(),this.quill.format("link",t,bt.A.sources.USER)),this.quill.root.scrollTop=e;break}case"video":t=function(t){let e=t.match(/^(?:(https?):\/\/)?(?:(?:www|m)\.)?youtube\.com\/watch.*v=([a-zA-Z0-9_-]+)/)||t.match(/^(?:(https?):\/\/)?(?:(?:www|m)\.)?youtu\.be\/([a-zA-Z0-9_-]+)/);return e?`${e[1]||"https"}://www.youtube.com/embed/${e[2]}?showinfo=0`:(e=t.match(/^(?:(https?):\/\/)?(?:www\.)?vimeo\.com\/(\d+)/))?`${e[1]||"https"}://player.vimeo.com/video/${e[2]}/`:t}(t);case"formula":{if(!t)break;const e=this.quill.getSelection(!0);if(null!=e){const n=e.index+e.length;this.quill.insertEmbed(n,this.root.getAttribute("data-mode"),t,bt.A.sources.USER),"formula"===this.root.getAttribute("data-mode")&&this.quill.insertText(n+1," ",bt.A.sources.USER),this.quill.setSelection(n+2,bt.A.sources.USER)}break}}this.textbox.value="",this.hide()}}function kt(t,e){let n=arguments.length>2&&void 0!==arguments[2]&&arguments[2];e.forEach((e=>{const r=document.createElement("option");e===n?r.setAttribute("selected","selected"):r.setAttribute("value",String(e)),t.appendChild(r)}))}var _t=n(8298);const Lt=[["bold","italic","link"],[{header:1},{header:2},"blockquote"]];class St extends qt{static TEMPLATE=['<span class="ql-tooltip-arrow"></span>','<div class="ql-tooltip-editor">','<input type="text" data-formula="e=mc^2" data-link="https://quilljs.com" data-video="Embed URL">','<a class="ql-close"></a>',"</div>"].join("");constructor(t,e){super(t,e),this.quill.on(bt.A.events.EDITOR_CHANGE,((t,e,n,r)=>{if(t===bt.A.events.SELECTION_CHANGE)if(null!=e&&e.length>0&&r===bt.A.sources.USER){this.show(),this.root.style.left="0px",this.root.style.width="",this.root.style.width=`${this.root.offsetWidth}px`;const t=this.quill.getLines(e.index,e.length);if(1===t.length){const t=this.quill.getBounds(e);null!=t&&this.position(t)}else{const n=t[t.length-1],r=this.quill.getIndex(n),i=Math.min(n.length()-1,e.index+e.length-r),s=this.quill.getBounds(new _t.Q(r,i));null!=s&&this.position(s)}}else document.activeElement!==this.textbox&&this.quill.hasFocus()&&this.hide()}))}listen(){super.listen(),this.root.querySelector(".ql-close").addEventListener("click",(()=>{this.root.classList.remove("ql-editing")})),this.quill.on(bt.A.events.SCROLL_OPTIMIZE,(()=>{setTimeout((()=>{if(this.root.classList.contains("ql-hidden"))return;const t=this.quill.getSelection();if(null!=t){const e=this.quill.getBounds(t);null!=e&&this.position(e)}}),1)}))}cancel(){this.show()}position(t){const e=super.position(t),n=this.root.querySelector(".ql-tooltip-arrow");return n.style.marginLeft="",0!==e&&(n.style.marginLeft=-1*e-n.offsetWidth/2+"px"),e}}class Ot extends wt{constructor(t,e){null!=e.modules.toolbar&&null==e.modules.toolbar.container&&(e.modules.toolbar.container=Lt),super(t,e),this.quill.container.classList.add("ql-bubble")}extendToolbar(t){this.tooltip=new St(this.quill,this.options.bounds),null!=t.container&&(this.tooltip.root.appendChild(t.container),this.buildButtons(t.container.querySelectorAll("button"),ct),this.buildPickers(t.container.querySelectorAll("select"),ct))}}Ot.DEFAULTS=(0,mt.A)({},wt.DEFAULTS,{modules:{toolbar:{handlers:{link(t){t?this.quill.theme.tooltip.edit():this.quill.format("link",!1,p.Ay.sources.USER)}}}}});const Tt=[[{header:["1","2","3",!1]}],["bold","italic","underline","link"],[{list:"ordered"},{list:"bullet"}],["clean"]];class jt extends qt{static TEMPLATE=['<a class="ql-preview" rel="noopener noreferrer" target="_blank" href="about:blank"></a>','<input type="text" data-formula="e=mc^2" data-link="https://quilljs.com" data-video="Embed URL">','<a class="ql-action"></a>','<a class="ql-remove"></a>'].join("");preview=this.root.querySelector("a.ql-preview");listen(){super.listen(),this.root.querySelector("a.ql-action").addEventListener("click",(t=>{this.root.classList.contains("ql-editing")?this.save():this.edit("link",this.preview.textContent),t.preventDefault()})),this.root.querySelector("a.ql-remove").addEventListener("click",(t=>{if(null!=this.linkRange){const t=this.linkRange;this.restoreFocus(),this.quill.formatText(t,"link",!1,bt.A.sources.USER),delete this.linkRange}t.preventDefault(),this.hide()})),this.quill.on(bt.A.events.SELECTION_CHANGE,((t,e,n)=>{if(null!=t){if(0===t.length&&n===bt.A.sources.USER){const[e,n]=this.quill.scroll.descendant(w,t.index);if(null!=e){this.linkRange=new _t.Q(t.index-n,e.length());const r=w.formats(e.domNode);this.preview.textContent=r,this.preview.setAttribute("href",r),this.show();const i=this.quill.getBounds(this.linkRange);return void(null!=i&&this.position(i))}}else delete this.linkRange;this.hide()}}))}show(){super.show(),this.root.removeAttribute("data-mode")}}class Ct extends wt{constructor(t,e){null!=e.modules.toolbar&&null==e.modules.toolbar.container&&(e.modules.toolbar.container=Tt),super(t,e),this.quill.container.classList.add("ql-snow")}extendToolbar(t){null!=t.container&&(t.container.classList.add("ql-snow"),this.buildButtons(t.container.querySelectorAll("button"),ct),this.buildPickers(t.container.querySelectorAll("select"),ct),this.tooltip=new jt(this.quill,this.options.bounds),t.container.querySelector(".ql-link")&&this.quill.keyboard.addBinding({key:"k",shortKey:!0},((e,n)=>{t.handlers.link.call(t,!n.format.link)})))}}Ct.DEFAULTS=(0,mt.A)({},wt.DEFAULTS,{modules:{toolbar:{handlers:{link(t){if(t){const t=this.quill.getSelection();if(null==t||0===t.length)return;let e=this.quill.getText(t);/^\S+@\S+\.\S+$/.test(e)&&0!==e.indexOf("mailto:")&&(e=`mailto:${e}`);const{tooltip:n}=this.quill.theme;n.edit("link",e)}else this.quill.format("link",!1,p.Ay.sources.USER)}}}}});var Rt=Ct;t.default.register({"attributors/attribute/direction":i.Mc,"attributors/class/align":e.qh,"attributors/class/background":b.l,"attributors/class/color":y.g3,"attributors/class/direction":i.sY,"attributors/class/font":v.q,"attributors/class/size":A.U,"attributors/style/align":e.Hu,"attributors/style/background":b.s,"attributors/style/color":y.JM,"attributors/style/direction":i.VL,"attributors/style/font":v.z,"attributors/style/size":A.r},!0),t.default.register({"formats/align":e.qh,"formats/direction":i.sY,"formats/indent":l,"formats/background":b.s,"formats/color":y.JM,"formats/font":v.q,"formats/size":A.U,"formats/blockquote":u,"formats/code-block":D.Ay,"formats/header":d,"formats/list":m,"formats/bold":E,"formats/code":D.Cy,"formats/italic":class extends E{static blotName="italic";static tagName=["EM","I"]},"formats/link":w,"formats/script":_,"formats/strike":class extends E{static blotName="strike";static tagName=["S","STRIKE"]},"formats/underline":S,"formats/formula":j,"formats/image":I,"formats/video":U,"modules/syntax":Q,"modules/table":it,"modules/toolbar":ot,"themes/bubble":Ot,"themes/snow":Rt,"ui/icons":ct,"ui/picker":dt,"ui/icon-picker":pt,"ui/color-picker":ft,"ui/tooltip":gt},!0);var It=t.default}(),r.default}()}));
//# sourceMappingURL=quill.js.map
================================================
FILE: assets/vendor/quill/quill.js.LICENSE.txt
================================================
Copyright (c) 2017-2024, Slab
Copyright (c) 2014, Jason Chen
Copyright (c) 2013, salesforce.com
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
================================================
FILE: assets/vendor/quill/quill.module.wordcount.js
================================================
console.warn( 'Direct loading of this file is deprecated and it will be removed in the next major release of LifterLMS!' );
console.warn( 'Instead, enqueue the registered script `llms-quill-wordcount`' );
!function(){var n={54:function(n){n.exports=(()=>{"use strict";var n={314:(n,t,e)=>{e.r(t),e.d(t,{default:()=>a,wordsCount:()=>u,wordsSplit:()=>l,wordsDetect:()=>i});var r=[",","，",".","。",":","：",";","；","[","]","【","]","】","{","｛","}","｝","(","（",")","）","<","《",">","》","$","￥","!","！","?","？","~","～","'","’",'"',"“","”","*","/","\\","&","%","@","#","^","、","、","、","、"],o={words:[],count:0},i=function(n){var t=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};if(!n)return o;var e=String(n);if(""===e.trim())return o;var i=t.punctuationAsBreaker?" ":"",u=t.disableDefaultPunctuation?[]:r,l=t.punctuation||[];u.concat(l).forEach((function(n){var t=new RegExp("\\"+n,"g");e=e.replace(t,i)})),e=(e=(e=(e=e.replace(/[\uFF00-\uFFEF\u2000-\u206F]/g,"")).replace(/\s+/," ")).split(" ")).filter((function(n){return n.trim()}));var a=new RegExp("(\\d+)|[a-zA-ZÀ-ÿĀ-ſƀ-ɏɐ-ʯḀ-ỿЀ-ӿԀ-ԯഀ-ൿ]+|[⺀-⼀- -〿㇀-㇯㈀-㋿㌀-㏿㐀-㿿䀀-䶿一-俿倀-忿怀-濿瀀-翿耀-迿退-鿿豈--ゟ゠-ヿㇰ-ㇿ㆐-㆟ᄀ-ᇿ-ꥠ-가-꿿뀀-뿿쀀-쿿퀀-ힰ-]","g"),c=[];return e.forEach((function(n){var t,e=[];do{(t=a.exec(n))&&e.push(t[0])}while(t);0===e.length?c.push(n):c=c.concat(e)})),{words:c,count:c.length}},u=function(n){return i(n,arguments.length>1&&void 0!==arguments[1]?arguments[1]:{}).count},l=function(n){return i(n,arguments.length>1&&void 0!==arguments[1]?arguments[1]:{}).words};const a=u}},t={};function e(r){if(t[r])return t[r].exports;var o=t[r]={exports:{}};return n[r](o,o.exports,e),o.exports}return e.d=(n,t)=>{for(var r in t)e.o(t,r)&&!e.o(n,r)&&Object.defineProperty(n,r,{enumerable:!0,get:t[r]})},e.o=(n,t)=>Object.prototype.hasOwnProperty.call(n,t),e.r=n=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(n,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(n,"__esModule",{value:!0})},e(314)})()}},t={};function e(r){var o=t[r];if(void 0!==o)return o.exports;var i=t[r]={exports:{}};return n[r].call(i.exports,i,i.exports,e),i.exports}e.n=function(n){var t=n&&n.__esModule?function(){return n.default}:function(){return n};return e.d(t,{a:t}),t},e.d=function(n,t){for(var r in t)e.o(t,r)&&!e.o(n,r)&&Object.defineProperty(n,r,{enumerable:!0,get:t[r]})},e.o=function(n,t){return Object.prototype.hasOwnProperty.call(n,t)},function(){"use strict";var n=e(54),t=e.n(n);function r(n){return(new Intl.NumberFormat).format(n)}function o(n,t,e){const o=document.createElement("i");return o.className=`ql-wordcount-${n}`,o.style.opacity="0.5",o.style.marginRight="10px",o.innerHTML=`${t}: ${r(e)}`,o}function i(n){const{l10n:t,min:e,max:r}=n,i=document.createElement("div");return i.className="ql-wordcount ql-toolbar ql-snow",i.style.marginTop="-1px",i.style.fontSize="85%",e&&i.appendChild(o("min",t.min,e)),r&&i.appendChild(o("max",t.max,r)),i}function u(n,t){const{min:e,max:r,colorWarning:o,colorError:i}=t;let u="initial";return e&&n<e||r&&n>r?u=i:r&&n>=.9*r&&(u=o),u}function l(){let n=arguments.length>0&&void 0!==arguments[0]?arguments[0]:{};return n={min:null,max:null,colorWarning:"#ff922b",colorError:"#e5554e",onChange:(n,t,e)=>{},l10n:{},...n},n.l10n={singular:"word",plural:"words",min:"Minimum",max:"Maximum",...n.l10n},n}function a(n){let e=arguments.length>1&&void 0!==arguments[1]?arguments[1]:{};e=l(e);const o=i(e),a=document.createElement("span");a.className="ql-wordcount-counter",a.style.float="right",o.appendChild(a);const c=()=>{const o=t()(n.getText());a.style.color=u(o,e);const i=1===o?e.l10n.singular:e.l10n.plural;a.innerHTML=r(o)+" "+i,e.onChange(n,e,o)};c(),n.container.parentNode.insertBefore(o,n.container.nextSibling),n.on("text-change",c)}!function(){const{Quill:n}=window;void 0!==n&&n.register("modules/wordcount",a)}()}()}();
================================================
FILE: assets/vendor/select2/css/select2.css
================================================
.select2-container {
box-sizing: border-box;
display: inline-block;
margin: 0;
position: relative;
vertical-align: middle; }
.select2-container .select2-selection--single {
box-sizing: border-box;
cursor: pointer;
display: block;
height: 28px;
user-select: none;
-webkit-user-select: none; }
.select2-container .select2-selection--single .select2-selection__rendered {
display: block;
padding-left: 8px;
padding-right: 20px;
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap; }
.select2-container .select2-selection--single .select2-selection__clear {
position: relative; }
.select2-container[dir="rtl"] .select2-selection--single .select2-selection__rendered {
padding-right: 8px;
padding-left: 20px; }
.select2-container .select2-selection--multiple {
box-sizing: border-box;
cursor: pointer;
display: block;
min-height: 32px;
user-select: none;
-webkit-user-select: none; }
.select2-container .select2-selection--multiple .select2-selection__rendered {
display: inline-block;
overflow: hidden;
padding-left: 8px;
text-overflow: ellipsis;
white-space: nowrap; }
.select2-container .select2-search--inline {
float: left; }
.select2-container .select2-search--inline .select2-search__field {
box-sizing: border-box;
border: none;
font-size: 100%;
margin-top: 5px;
padding: 0; }
.select2-container .select2-search--inline .select2-search__field::-webkit-search-cancel-button {
-webkit-appearance: none; }
.select2-dropdown {
background-color: white;
border: 1px solid #aaa;
border-radius: 4px;
box-sizing: border-box;
display: block;
position: absolute;
left: -100000px;
width: 100%;
z-index: 1051; }
.select2-results {
display: block; }
.select2-results__options {
list-style: none;
margin: 0;
padding: 0; }
.select2-results__option {
padding: 6px;
user-select: none;
-webkit-user-select: none; }
.select2-results__option[aria-selected] {
cursor: pointer; }
.select2-container--open .select2-dropdown {
left: 0; }
.select2-container--open .select2-dropdown--above {
border-bottom: none;
border-bottom-left-radius: 0;
border-bottom-right-radius: 0; }
.select2-container--open .select2-dropdown--below {
border-top: none;
border-top-left-radius: 0;
border-top-right-radius: 0; }
.select2-search--dropdown {
display: block;
padding: 4px; }
.select2-search--dropdown .select2-search__field {
padding: 4px;
width: 100%;
box-sizing: border-box; }
.select2-search--dropdown .select2-search__field::-webkit-search-cancel-button {
-webkit-appearance: none; }
.select2-search--dropdown.select2-search--hide {
display: none; }
.select2-close-mask {
border: 0;
margin: 0;
padding: 0;
display: block;
position: fixed;
left: 0;
top: 0;
min-height: 100%;
min-width: 100%;
height: auto;
width: auto;
opacity: 0;
z-index: 99;
background-color: #fff;
filter: alpha(opacity=0); }
.select2-hidden-accessible {
border: 0 !important;
clip: rect(0 0 0 0) !important;
-webkit-clip-path: inset(50%) !important;
clip-path: inset(50%) !important;
height: 1px !important;
overflow: hidden !important;
padding: 0 !important;
position: absolute !important;
width: 1px !important;
white-space: nowrap !important; }
.select2-container--default .select2-selection--single {
background-color: #fff;
border: 1px solid #aaa;
border-radius: 4px; }
.select2-container--default .select2-selection--single .select2-selection__rendered {
color: #444;
line-height: 28px; }
.select2-container--default .select2-selection--single .select2-selection__clear {
cursor: pointer;
float: right;
font-weight: bold; }
.select2-container--default .select2-selection--single .select2-selection__placeholder {
color: #999; }
.select2-container--default .select2-selection--single .select2-selection__arrow {
height: 26px;
position: absolute;
top: 1px;
right: 1px;
width: 20px; }
.select2-container--default .select2-selection--single .select2-selection__arrow b {
border-color: #888 transparent transparent transparent;
border-style: solid;
border-width: 5px 4px 0 4px;
height: 0;
left: 50%;
margin-left: -4px;
margin-top: -2px;
position: absolute;
top: 50%;
width: 0; }
.select2-container--default[dir="rtl"] .select2-selection--single .select2-selection__clear {
float: left; }
.select2-container--default[dir="rtl"] .select2-selection--single .select2-selection__arrow {
left: 1px;
right: auto; }
.select2-container--default.select2-container--disabled .select2-selection--single {
background-color: #eee;
cursor: default; }
.select2-container--default.select2-container--disabled .select2-selection--single .select2-selection__clear {
display: none; }
.select2-container--default.select2-container--open .select2-selection--single .select2-selection__arrow b {
border-color: transparent transparent #888 transparent;
border-width: 0 4px 5px 4px; }
.select2-container--default .select2-selection--multiple {
background-color: white;
border: 1px solid #aaa;
border-radius: 4px;
cursor: text; }
.select2-container--default .select2-selection--multiple .select2-selection__rendered {
box-sizing: border-box;
list-style: none;
margin: 0;
padding: 0 5px;
width: 100%; }
.select2-container--default .select2-selection--multiple .select2-selection__rendered li {
list-style: none; }
.select2-container--default .select2-selection--multiple .select2-selection__clear {
cursor: pointer;
float: right;
font-weight: bold;
margin-top: 5px;
margin-right: 10px;
padding: 1px; }
.select2-container--default .select2-selection--multiple .select2-selection__choice {
background-color: #e4e4e4;
border: 1px solid #aaa;
border-radius: 4px;
cursor: default;
float: left;
margin-right: 5px;
margin-top: 5px;
padding: 0 5px; }
.select2-container--default .select2-selection--multiple .select2-selection__choice__remove {
color: #999;
cursor: pointer;
display: inline-block;
font-weight: bold;
margin-right: 2px; }
.select2-container--default .select2-selection--multiple .select2-selection__choice__remove:hover {
color: #333; }
.select2-container--default[dir="rtl"] .select2-selection--multiple .select2-selection__choice, .select2-container--default[dir="rtl"] .select2-selection--multiple .select2-search--inline {
float: right; }
.select2-container--default[dir="rtl"] .select2-selection--multiple .select2-selection__choice {
margin-left: 5px;
margin-right: auto; }
.select2-container--default[dir="rtl"] .select2-selection--multiple .select2-selection__choice__remove {
margin-left: 2px;
margin-right: auto; }
.select2-container--default.select2-container--focus .select2-selection--multiple {
border: solid black 1px;
outline: 0; }
.select2-container--default.select2-container--disabled .select2-selection--multiple {
background-color: #eee;
cursor: default; }
.select2-container--default.select2-container--disabled .select2-selection__choice__remove {
display: none; }
.select2-container--default.select2-container--open.select2-container--above .select2-selection--single, .select2-container--default.select2-container--open.select2-container--above .select2-selection--multiple {
border-top-left-radius: 0;
border-top-right-radius: 0; }
.select2-container--default.select2-container--open.select2-container--below .select2-selection--single, .select2-container--default.select2-container--open.select2-container--below .select2-selection--multiple {
border-bottom-left-radius: 0;
border-bottom-right-radius: 0; }
.select2-container--default .select2-search--dropdown .select2-search__field {
border: 1px solid #aaa; }
.select2-container--default .select2-search--inline .select2-search__field {
background: transparent;
border: none;
outline: 0;
box-shadow: none;
-webkit-appearance: textfield; }
.select2-container--default .select2-results > .select2-results__options {
max-height: 200px;
overflow-y: auto; }
.select2-container--default .select2-results__option[role=group] {
padding: 0; }
.select2-container--default .select2-results__option[aria-disabled=true] {
color: #999; }
.select2-container--default .select2-results__option[aria-selected=true] {
background-color: #ddd; }
.select2-container--default .select2-results__option .select2-results__option {
padding-left: 1em; }
.select2-container--default .select2-results__option .select2-results__option .select2-results__group {
padding-left: 0; }
.select2-container--default .select2-results__option .select2-results__option .select2-results__option {
margin-left: -1em;
padding-left: 2em; }
.select2-container--default .select2-results__option .select2-results__option .select2-results__option .select2-results__option {
margin-left: -2em;
padding-left: 3em; }
.select2-container--default .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option {
margin-left: -3em;
padding-left: 4em; }
.select2-container--default .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option {
margin-left: -4em;
padding-left: 5em; }
.select2-container--default .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option .select2-results__option {
margin-left: -5em;
padding-left: 6em; }
.select2-container--default .select2-results__option--highlighted[aria-selected] {
background-color: #5897fb;
color: white; }
.select2-container--default .select2-results__group {
cursor: default;
display: block;
padding: 6px; }
.select2-container--classic .select2-selection--single {
background-color: #f7f7f7;
border: 1px solid #aaa;
border-radius: 4px;
outline: 0;
background-image: -webkit-linear-gradient(top, white 50%, #eeeeee 100%);
background-image: -o-linear-gradient(top, white 50%, #eeeeee 100%);
background-image: linear-gradient(to bottom, white 50%, #eeeeee 100%);
background-repeat: repeat-x;
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFFFFFFF', endColorstr='#FFEEEEEE', GradientType=0); }
.select2-container--classic .select2-selection--single:focus {
border: 1px solid #5897fb; }
.select2-container--classic .select2-selection--single .select2-selection__rendered {
color: #444;
line-height: 28px; }
.select2-container--classic .select2-selection--single .select2-selection__clear {
cursor: pointer;
float: right;
font-weight: bold;
margin-right: 10px; }
.select2-container--classic .select2-selection--single .select2-selection__placeholder {
color: #999; }
.select2-container--classic .select2-selection--single .select2-selection__arrow {
background-color: #ddd;
border: none;
border-left: 1px solid #aaa;
border-top-right-radius: 4px;
border-bottom-right-radius: 4px;
height: 26px;
position: absolute;
top: 1px;
right: 1px;
width: 20px;
background-image: -webkit-linear-gradient(top, #eeeeee 50%, #cccccc 100%);
background-image: -o-linear-gradient(top, #eeeeee 50%, #cccccc 100%);
background-image: linear-gradient(to bottom, #eeeeee 50%, #cccccc 100%);
background-repeat: repeat-x;
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFEEEEEE', endColorstr='#FFCCCCCC', GradientType=0); }
.select2-container--classic .select2-selection--single .select2-selection__arrow b {
border-color: #888 transparent transparent transparent;
border-style: solid;
border-width: 5px 4px 0 4px;
height: 0;
left: 50%;
margin-left: -4px;
margin-top: -2px;
position: absolute;
top: 50%;
width: 0; }
.select2-container--classic[dir="rtl"] .select2-selection--single .select2-selection__clear {
float: left; }
.select2-container--classic[dir="rtl"] .select2-selection--single .select2-selection__arrow {
border: none;
border-right: 1px solid #aaa;
border-radius: 0;
border-top-left-radius: 4px;
border-bottom-left-radius: 4px;
left: 1px;
right: auto; }
.select2-container--classic.select2-container--open .select2-selection--single {
border: 1px solid #5897fb; }
.select2-container--classic.select2-container--open .select2-selection--single .select2-selection__arrow {
background: transparent;
border: none; }
.select2-container--classic.select2-container--open .select2-selection--single .select2-selection__arrow b {
border-color: transparent transparent #888 transparent;
border-width: 0 4px 5px 4px; }
.select2-container--classic.select2-container--open.select2-container--above .select2-selection--single {
border-top: none;
border-top-left-radius: 0;
border-top-right-radius: 0;
background-image: -webkit-linear-gradient(top, white 0%, #eeeeee 50%);
background-image: -o-linear-gradient(top, white 0%, #eeeeee 50%);
background-image: linear-gradient(to bottom, white 0%, #eeeeee 50%);
background-repeat: repeat-x;
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFFFFFFF', endColorstr='#FFEEEEEE', GradientType=0); }
.select2-container--classic.select2-container--open.select2-container--below .select2-selection--single {
border-bottom: none;
border-bottom-left-radius: 0;
border-bottom-right-radius: 0;
background-image: -webkit-linear-gradient(top, #eeeeee 50%, white 100%);
background-image: -o-linear-gradient(top, #eeeeee 50%, white 100%);
background-image: linear-gradient(to bottom, #eeeeee 50%, white 100%);
background-repeat: repeat-x;
filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#FFEEEEEE', endColorstr='#FFFFFFFF', GradientType=0); }
.select2-container--classic .select2-selection--multiple {
background-color: white;
border: 1px solid #aaa;
border-radius: 4px;
cursor: text;
outline: 0; }
.select2-container--classic .select2-selection--multiple:focus {
border: 1px solid #5897fb; }
.select2-container--classic .select2-selection--multiple .select2-selection__rendered {
list-style: none;
margin: 0;
padding: 0 5px; }
.select2-container--classic .select2-selection--multiple .select2-selection__clear {
display: none; }
.select2-container--classic .select2-selection--multiple .select2-selection__choice {
background-color: #e4e4e4;
border: 1px solid #aaa;
border-radius: 4px;
cursor: default;
float: left;
margin-right: 5px;
margin-top: 5px;
padding: 0 5px; }
.select2-container--classic .select2-selection--multiple .select2-selection__choice__remove {
color: #888;
cursor: pointer;
display: inline-block;
font-weight: bold;
margin-right: 2px; }
.select2-container--classic .select2-selection--multiple .select2-selection__choice__remove:hover {
color: #555; }
.select2-container--classic[dir="rtl"] .select2-selection--multiple .select2-selection__choice {
float: right;
margin-left: 5px;
margin-right: auto; }
.select2-container--classic[dir="rtl"] .select2-selection--multiple .select2-selection__choice__remove {
margin-left: 2px;
margin-right: auto; }
.select2-container--classic.select2-container--open .select2-selection--multiple {
border: 1px solid #5897fb; }
.select2-container--classic.select2-container--open.select2-container--above .select2-selection--multiple {
border-top: none;
border-top-left-radius: 0;
border-top-right-radius: 0; }
.select2-container--classic.select2-container--open.select2-container--below .select2-selection--multiple {
border-bottom: none;
border-bottom-left-radius: 0;
border-bottom-right-radius: 0; }
.select2-container--classic .select2-search--dropdown .select2-search__field {
border: 1px solid #aaa;
outline: 0; }
.select2-container--classic .select2-search--inline .select2-search__field {
outline: 0;
box-shadow: none; }
.select2-container--classic .select2-dropdown {
background-color: white;
border: 1px solid transparent; }
.select2-container--classic .select2-dropdown--above {
border-bottom: none; }
.select2-container--classic .select2-dropdown--below {
border-top: none; }
.select2-container--classic .select2-results > .select2-results__options {
max-height: 200px;
overflow-y: auto; }
.select2-container--classic .select2-results__option[role=group] {
padding: 0; }
.select2-container--classic .select2-results__option[aria-disabled=true] {
color: grey; }
.select2-container--classic .select2-results__option--highlighted[aria-selected] {
background-color: #3875d7;
color: white; }
.select2-container--classic .select2-results__group {
cursor: default;
display: block;
padding: 6px; }
.select2-container--classic.select2-container--open .select2-dropdown {
border-color: #5897fb; }
================================================
FILE: assets/vendor/select2/js/select2.js
================================================
/*!
* Select2 4.0.13
* https://select2.github.io
*
* Released under the MIT license
* https://github.com/select2/select2/blob/master/LICENSE.md
*/
;(function (factory) {
// customized for LifterLMS
// http://stackoverflow.com/a/36815607/400568
var existingVersion = jQuery.fn.select2 || null;
if (existingVersion) {
delete jQuery.fn.select2;
}
// end customization
if (typeof define === 'function' && define.amd) {
// AMD. Register as an anonymous module.
define(['jquery'], factory);
} else if (typeof module === 'object' && module.exports) {
// Node/CommonJS
module.exports = function (root, jQuery) {
if (jQuery === undefined) {
// require('jQuery') returns a factory that requires window to
// build a jQuery instance, we normalize how we use modules
// that require this pattern but the window provided is a noop
// if it's defined (how jquery works)
if (typeof window !== 'undefined') {
jQuery = require('jquery');
}
else {
jQuery = require('jquery')(root);
}
}
factory(jQuery);
return jQuery;
};
} else {
// Browser globals
factory(jQuery);
}
// customized for LifterLMS
// http://stackoverflow.com/a/36815607/400568
jQuery.fn.llmsSelect2 = jQuery.fn.select2;
if (existingVersion) {
delete jQuery.fn.select2;
jQuery.fn.select2 = existingVersion;
}
// end customization
} (function (jQuery) {
// This is needed so we can catch the AMD loader configuration and use it
// The inner file should be wrapped (by `banner.start.js`) in a function that
// returns the AMD loader references.
var S2 =(function () {
// Restore the Select2 AMD loader so it can be used
// Needed mostly in the language files, where the loader is not inserted
if (jQuery && jQuery.fn && jQuery.fn.select2 && jQuery.fn.select2.amd) {
var S2 = jQuery.fn.select2.amd;
}
var S2;(function () { if (!S2 || !S2.requirejs) {
if (!S2) { S2 = {}; } else { require = S2; }
/**
* @license almond 0.3.3 Copyright jQuery Foundation and other contributors.
* Released under MIT license, http://github.com/requirejs/almond/LICENSE
*/
//Going sloppy to avoid 'use strict' string cost, but strict practices should
//be followed.
/*global setTimeout: false */
var requirejs, require, define;
(function (undef) {
var main, req, makeMap, handlers,
defined = {},
waiting = {},
config = {},
defining = {},
hasOwn = Object.prototype.hasOwnProperty,
aps = [].slice,
jsSuffixRegExp = /\.js$/;
function hasProp(obj, prop) {
return hasOwn.call(obj, prop);
}
/**
* Given a relative module name, like ./something, normalize it to
* a real name that can be mapped to a path.
* @param {String} name the relative name
* @param {String} baseName a real name that the name arg is relative
* to.
* @returns {String} normalized name
*/
function normalize(name, baseName) {
var nameParts, nameSegment, mapValue, foundMap, lastIndex,
foundI, foundStarMap, starI, i, j, part, normalizedBaseParts,
baseParts = baseName && baseName.split("/"),
map = config.map,
starMap = (map && map['*']) || {};
//Adjust any relative paths.
if (name) {
name = name.split('/');
lastIndex = name.length - 1;
// If wanting node ID compatibility, strip .js from end
// of IDs. Have to do this here, and not in nameToUrl
// because node allows either .js or non .js to map
// to same file.
if (config.nodeIdCompat && jsSuffixRegExp.test(name[lastIndex])) {
name[lastIndex] = name[lastIndex].replace(jsSuffixRegExp, '');
}
// Starts with a '.' so need the baseName
if (name[0].charAt(0) === '.' && baseParts) {
//Convert baseName to array, and lop off the last part,
//so that . matches that 'directory' and not name of the baseName's
//module. For instance, baseName of 'one/two/three', maps to
//'one/two/three.js', but we want the directory, 'one/two' for
//this normalization.
normalizedBaseParts = baseParts.slice(0, baseParts.length - 1);
name = normalizedBaseParts.concat(name);
}
//start trimDots
for (i = 0; i < name.length; i++) {
part = name[i];
if (part === '.') {
name.splice(i, 1);
i -= 1;
} else if (part === '..') {
// If at the start, or previous value is still ..,
// keep them so that when converted to a path it may
// still work when converted to a path, even though
// as an ID it is less than ideal. In larger point
// releases, may be better to just kick out an error.
if (i === 0 || (i === 1 && name[2] === '..') || name[i - 1] === '..') {
continue;
} else if (i > 0) {
name.splice(i - 1, 2);
i -= 2;
}
}
}
//end trimDots
name = name.join('/');
}
//Apply map config if available.
if ((baseParts || starMap) && map) {
nameParts = name.split('/');
for (i = nameParts.length; i > 0; i -= 1) {
nameSegment = nameParts.slice(0, i).join("/");
if (baseParts) {
//Find the longest baseName segment match in the config.
//So, do joins on the biggest to smallest lengths of baseParts.
for (j = baseParts.length; j > 0; j -= 1) {
mapValue = map[baseParts.slice(0, j).join('/')];
//baseName segment has config, find if it has one for
//this name.
if (mapValue) {
mapValue = mapValue[nameSegment];
if (mapValue) {
//Match, update name to the new value.
foundMap = mapValue;
foundI = i;
break;
}
}
}
}
if (foundMap) {
break;
}
//Check for a star map match, but just hold on to it,
//if there is a shorter segment match later in a matching
//config, then favor over this star map.
if (!foundStarMap && starMap && starMap[nameSegment]) {
foundStarMap = starMap[nameSegment];
starI = i;
}
}
if (!foundMap && foundStarMap) {
foundMap = foundStarMap;
foundI = starI;
}
if (foundMap) {
nameParts.splice(0, foundI, foundMap);
name = nameParts.join('/');
}
}
return name;
}
function makeRequire(relName, forceSync) {
return function () {
//A version of a require function that passes a moduleName
//value for items that may need to
//look up paths relative to the moduleName
var args = aps.call(arguments, 0);
//If first arg is not require('string'), and there is only
//one arg, it is the array form without a callback. Insert
//a null so that the following concat is correct.
if (typeof args[0] !== 'string' && args.length === 1) {
args.push(null);
}
return req.apply(undef, args.concat([relName, forceSync]));
};
}
function makeNormalize(relName) {
return function (name) {
return normalize(name, relName);
};
}
function makeLoad(depName) {
return function (value) {
defined[depName] = value;
};
}
function callDep(name) {
if (hasProp(waiting, name)) {
var args = waiting[name];
delete waiting[name];
defining[name] = true;
main.apply(undef, args);
}
if (!hasProp(defined, name) && !hasProp(defining, name)) {
throw new Error('No ' + name);
}
return defined[name];
}
//Turns a plugin!resource to [plugin, resource]
//with the plugin being undefined if the name
//did not have a plugin prefix.
function splitPrefix(name) {
var prefix,
index = name ? name.indexOf('!') : -1;
if (index > -1) {
prefix = name.substring(0, index);
name = name.substring(index + 1, name.length);
}
return [prefix, name];
}
//Creates a parts array for a relName where first part is plugin ID,
//second part is resource ID. Assumes relName has already been normalized.
function makeRelParts(relName) {
return relName ? splitPrefix(relName) : [];
}
/**
* Makes a name map, normalizing the name, and using a plugin
* for normalization if necessary. Grabs a ref to plugin
* too, as an optimization.
*/
makeMap = function (name, relParts) {
var plugin,
parts = splitPrefix(name),
prefix = parts[0],
relResourceName = relParts[1];
name = parts[1];
if (prefix) {
prefix = normalize(prefix, relResourceName);
plugin = callDep(prefix);
}
//Normalize according
if (prefix) {
if (plugin && plugin.normalize) {
name = plugin.normalize(name, makeNormalize(relResourceName));
} else {
name = normalize(name, relResourceName);
}
} else {
name = normalize(name, relResourceName);
parts = splitPrefix(name);
prefix = parts[0];
name = parts[1];
if (prefix) {
plugin = callDep(prefix);
}
}
//Using ridiculous property names for space reasons
return {
f: prefix ? prefix + '!' + name : name, //fullName
n: name,
pr: prefix,
p: plugin
};
};
function makeConfig(name) {
return function () {
return (config && config.config && config.config[name]) || {};
};
}
handlers = {
require: function (name) {
return makeRequire(name);
},
exports: function (name) {
var e = defined[name];
if (typeof e !== 'undefined') {
return e;
} else {
return (defined[name] = {});
}
},
module: function (name) {
return {
id: name,
uri: '',
exports: defined[name],
config: makeConfig(name)
};
}
};
main = function (name, deps, callback, relName) {
var cjsModule, depName, ret, map, i, relParts,
args = [],
callbackType = typeof callback,
usingExports;
//Use name if no relName
relName = relName || name;
relParts = makeRelParts(relName);
//Call the callback to define the module, if necessary.
if (callbackType === 'undefined' || callbackType === 'function') {
//Pull out the defined dependencies and pass the ordered
//values to the callback.
//Default to [require, exports, module] if no deps
deps = !deps.length && callback.length ? ['require', 'exports', 'module'] : deps;
for (i = 0; i < deps.length; i += 1) {
map = makeMap(deps[i], relParts);
depName = map.f;
//Fast path CommonJS standard dependencies.
if (depName === "require") {
args[i] = handlers.require(name);
} else if (depName === "exports") {
//CommonJS module spec 1.1
args[i] = handlers.exports(name);
usingExports = true;
} else if (depName === "module") {
//CommonJS module spec 1.1
cjsModule = args[i] = handlers.module(name);
} else if (hasProp(defined, depName) ||
hasProp(waiting, depName) ||
hasProp(defining, depName)) {
args[i] = callDep(depName);
} else if (map.p) {
map.p.load(map.n, makeRequire(relName, true), makeLoad(depName), {});
args[i] = defined[depName];
} else {
throw new Error(name + ' missing ' + depName);
}
}
ret = callback ? callback.apply(defined[name], args) : undefined;
if (name) {
//If setting exports via "module" is in play,
//favor that over return value and exports. After that,
//favor a non-undefined return value over exports use.
if (cjsModule && cjsModule.exports !== undef &&
cjsModule.exports !== defined[name]) {
defined[name] = cjsModule.exports;
} else if (ret !== undef || !usingExports) {
//Use the return value from the function.
defined[name] = ret;
}
}
} else if (name) {
//May just be an object definition for the module. Only
//worry about defining if have a module name.
defined[name] = callback;
}
};
requirejs = require = req = function (deps, callback, relName, forceSync, alt) {
if (typeof deps === "string") {
if (handlers[deps]) {
//callback in this case is really relName
return handlers[deps](callback);
}
//Just return the module wanted. In this scenario, the
//deps arg is the module name, and second arg (if passed)
//is just the relName.
//Normalize module name, if it contains . or ..
return callDep(makeMap(deps, makeRelParts(callback)).f);
} else if (!deps.splice) {
//deps is a config object, not an array.
config = deps;
if (config.deps) {
req(config.deps, config.callback);
}
if (!callback) {
return;
}
if (callback.splice) {
//callback is an array, which means it is a dependency list.
//Adjust args if there are dependencies
deps = callback;
callback = relName;
relName = null;
} else {
deps = undef;
}
}
//Support require(['a'])
callback = callback || function () {};
//If relName is a function, it is an errback handler,
//so remove it.
if (typeof relName === 'function') {
relName = forceSync;
forceSync = alt;
}
//Simulate async callback;
if (forceSync) {
main(undef, deps, callback, relName);
} else {
//Using a non-zero value because of concern for what old browsers
//do, and latest browsers "upgrade" to 4 if lower value is used:
//http://www.whatwg.org/specs/web-apps/current-work/multipage/timers.html#dom-windowtimers-settimeout:
//If want a value immediately, use require('id') instead -- something
//that works in almond on the global level, but not guaranteed and
//unlikely to work in other AMD implementations.
setTimeout(function () {
main(undef, deps, callback, relName);
}, 4);
}
return req;
};
/**
* Just drops the config on the floor, but returns req in case
* the config return value is used.
*/
req.config = function (cfg) {
return req(cfg);
};
/**
* Expose module registry for debugging and tooling
*/
requirejs._defined = defined;
define = function (name, deps, callback) {
if (typeof name !== 'string') {
throw new Error('See almond README: incorrect module build, no module name');
}
//This module may not have dependencies
if (!deps.splice) {
//deps is not an array, so probably means
//an object literal or factory function for
//the value. Adjust args.
callback = deps;
deps = [];
}
if (!hasProp(defined, name) && !hasProp(waiting, name)) {
waiting[name] = [name, deps, callback];
}
};
define.amd = {
jQuery: true
};
}());
S2.requirejs = requirejs;S2.require = require;S2.define = define;
}
}());
S2.define("almond", function(){});
/* global jQuery:false, $:false */
S2.define('jquery',[],function () {
var _$ = jQuery || $;
if (_$ == null && console && console.error) {
console.error(
'Select2: An instance of jQuery or a jQuery-compatible library was not ' +
'found. Make sure that you are including jQuery before Select2 on your ' +
'web page.'
);
}
return _$;
});
S2.define('select2/utils',[
'jquery'
], function ($) {
var Utils = {};
Utils.Extend = function (ChildClass, SuperClass) {
var __hasProp = {}.hasOwnProperty;
function BaseConstructor () {
this.constructor = ChildClass;
}
for (var key in SuperClass) {
if (__hasProp.call(SuperClass, key)) {
ChildClass[key] = SuperClass[key];
}
}
BaseConstructor.prototype = SuperClass.prototype;
ChildClass.prototype = new BaseConstructor();
ChildClass.__super__ = SuperClass.prototype;
return ChildClass;
};
function getMethods (theClass) {
var proto = theClass.prototype;
var methods = [];
for (var methodName in proto) {
var m = proto[methodName];
if (typeof m !== 'function') {
continue;
}
if (methodName === 'constructor') {
continue;
}
methods.push(methodName);
}
return methods;
}
Utils.Decorate = function (SuperClass, DecoratorClass) {
var decoratedMethods = getMethods(DecoratorClass);
var superMethods = getMethods(SuperClass);
function DecoratedClass () {
var unshift = Array.prototype.unshift;
var argCount = DecoratorClass.prototype.constructor.length;
var calledConstructor = SuperClass.prototype.constructor;
if (argCount > 0) {
unshift.call(arguments, SuperClass.prototype.constructor);
calledConstructor = DecoratorClass.prototype.constructor;
}
calledConstructor.apply(this, arguments);
}
DecoratorClass.displayName = SuperClass.displayName;
function ctr () {
this.constructor = DecoratedClass;
}
DecoratedClass.prototype = new ctr();
for (var m = 0; m < superMethods.length; m++) {
var superMethod = superMethods[m];
DecoratedClass.prototype[superMethod] =
SuperClass.prototype[superMethod];
}
var calledMethod = function (methodName) {
// Stub out the original method if it's not decorating an actual method
var originalMethod = function () {};
if (methodName in DecoratedClass.prototype) {
originalMethod = DecoratedClass.prototype[methodName];
}
var decoratedMethod = DecoratorClass.prototype[methodName];
return function () {
var unshift = Array.prototype.unshift;
unshift.call(arguments, originalMethod);
return decoratedMethod.apply(this, arguments);
};
};
for (var d = 0; d < decoratedMethods.length; d++) {
var decoratedMethod = decoratedMethods[d];
DecoratedClass.prototype[decoratedMethod] = calledMethod(decoratedMethod);
}
return DecoratedClass;
};
var Observable = function () {
this.listeners = {};
};
Observable.prototype.on = function (event, callback) {
this.listeners = this.listeners || {};
if (event in this.listeners) {
this.listeners[event].push(callback);
} else {
this.listeners[event] = [callback];
}
};
Observable.prototype.trigger = function (event) {
var slice = Array.prototype.slice;
var params = slice.call(arguments, 1);
this.listeners = this.listeners || {};
// Params should always come in as an array
if (params == null) {
params = [];
}
// If there are no arguments to the event, use a temporary object
if (params.length === 0) {
params.push({});
}
// Set the `_type` of the first object to the event
params[0]._type = event;
if (event in this.listeners) {
this.invoke(this.listeners[event], slice.call(arguments, 1));
}
if ('*' in this.listeners) {
this.invoke(this.listeners['*'], arguments);
}
};
Observable.prototype.invoke = function (listeners, params) {
for (var i = 0, len = listeners.length; i < len; i++) {
listeners[i].apply(this, params);
}
};
Utils.Observable = Observable;
Utils.generateChars = function (length) {
var chars = '';
for (var i = 0; i < length; i++) {
var randomChar = Math.floor(Math.random() * 36);
chars += randomChar.toString(36);
}
return chars;
};
Utils.bind = function (func, context) {
return function () {
func.apply(context, arguments);
};
};
Utils._convertData = function (data) {
for (var originalKey in data) {
var keys = originalKey.split('-');
var dataLevel = data;
if (keys.length === 1) {
continue;
}
for (var k = 0; k < keys.length; k++) {
var key = keys[k];
// Lowercase the first letter
// By default, dash-separated becomes camelCase
key = key.substring(0, 1).toLowerCase() + key.substring(1);
if (!(key in dataLevel)) {
dataLevel[key] = {};
}
if (k == keys.length - 1) {
dataLevel[key] = data[originalKey];
}
dataLevel = dataLevel[key];
}
delete data[originalKey];
}
return data;
};
Utils.hasScroll = function (index, el) {
// Adapted from the function created by @ShadowScripter
// and adapted by @BillBarry on the Stack Exchange Code Review website.
// The original code can be found at
// http://codereview.stackexchange.com/q/13338
// and was designed to be used with the Sizzle selector engine.
var $el = $(el);
var overflowX = el.style.overflowX;
var overflowY = el.style.overflowY;
//Check both x and y declarations
if (overflowX === overflowY &&
(overflowY === 'hidden' || overflowY === 'visible')) {
return false;
}
if (overflowX === 'scroll' || overflowY === 'scroll') {
return true;
}
return ($el.innerHeight() < el.scrollHeight ||
$el.innerWidth() < el.scrollWidth);
};
Utils.escapeMarkup = function (markup) {
var replaceMap = {
'\\': '\',
'&': '&',
'<': '<',
'>': '>',
'"': '"',
'\'': ''',
'/': '/'
};
// Do not try to escape the markup if it's not a string
if (typeof markup !== 'string') {
return markup;
}
return String(markup).replace(/[&<>"'\/\\]/g, function (match) {
return replaceMap[match];
});
};
// Append an array of jQuery nodes to a given element.
Utils.appendMany = function ($element, $nodes) {
// jQuery 1.7.x does not support $.fn.append() with an array
// Fall back to a jQuery object collection using $.fn.add()
if ($.fn.jquery.substr(0, 3) === '1.7') {
var $jqNodes = $();
$.map($nodes, function (node) {
$jqNodes = $jqNodes.add(node);
});
$nodes = $jqNodes;
}
$element.append($nodes);
};
// Cache objects in Utils.__cache instead of $.data (see #4346)
Utils.__cache = {};
var id = 0;
Utils.GetUniqueElementId = function (element) {
// Get a unique element Id. If element has no id,
// creates a new unique number, stores it in the id
// attribute and returns the new id.
// If an id already exists, it simply returns it.
var select2Id = element.getAttribute('data-select2-id');
if (select2Id == null) {
// If element has id, use it.
if (element.id) {
select2Id = element.id;
element.setAttribute('data-select2-id', select2Id);
} else {
element.setAttribute('data-select2-id', ++id);
select2Id = id.toString();
}
}
return select2Id;
};
Utils.StoreData = function (element, name, value) {
// Stores an item in the cache for a specified element.
// name is the cache key.
var id = Utils.GetUniqueElementId(element);
if (!Utils.__cache[id]) {
Utils.__cache[id] = {};
}
Utils.__cache[id][name] = value;
};
Utils.GetData = function (element, name) {
// Retrieves a value from the cache by its key (name)
// name is optional. If no name specified, return
// all cache items for the specified element.
// and for a specified element.
var id = Utils.GetUniqueElementId(element);
if (name) {
if (Utils.__cache[id]) {
if (Utils.__cache[id][name] != null) {
return Utils.__cache[id][name];
}
return $(element).data(name); // Fallback to HTML5 data attribs.
}
return $(element).data(name); // Fallback to HTML5 data attribs.
} else {
return Utils.__cache[id];
}
};
Utils.RemoveData = function (element) {
// Removes all cached items for a specified element.
var id = Utils.GetUniqueElementId(element);
if (Utils.__cache[id] != null) {
delete Utils.__cache[id];
}
element.removeAttribute('data-select2-id');
};
return Utils;
});
S2.define('select2/results',[
'jquery',
'./utils'
], function ($, Utils) {
function Results ($element, options, dataAdapter) {
this.$element = $element;
this.data = dataAdapter;
this.options = options;
Results.__super__.constructor.call(this);
}
Utils.Extend(Results, Utils.Observable);
Results.prototype.render = function () {
var $results = $(
'<ul class="select2-results__options" role="listbox"></ul>'
);
if (this.options.get('multiple')) {
$results.attr('aria-multiselectable', 'true');
}
this.$results = $results;
return $results;
};
Results.prototype.clear = function () {
this.$results.empty();
};
Results.prototype.displayMessage = function (params) {
var escapeMarkup = this.options.get('escapeMarkup');
this.clear();
this.hideLoading();
var $message = $(
'<li role="alert" aria-live="assertive"' +
' class="select2-results__option"></li>'
);
var message = this.options.get('translations').get(params.message);
$message.append(
escapeMarkup(
message(params.args)
)
);
$message[0].className += ' select2-results__message';
this.$results.append($message);
};
Results.prototype.hideMessages = function () {
this.$results.find('.select2-results__message').remove();
};
Results.prototype.append = function (data) {
this.hideLoading();
var $options = [];
if (data.results == null || data.results.length === 0) {
if (this.$results.children().length === 0) {
this.trigger('results:message', {
message: 'noResults'
});
}
return;
}
data.results = this.sort(data.results);
for (var d = 0; d < data.results.length; d++) {
var item = data.results[d];
var $option = this.option(item);
$options.push($option);
}
this.$results.append($options);
};
Results.prototype.position = function ($results, $dropdown) {
var $resultsContainer = $dropdown.find('.select2-results');
$resultsContainer.append($results);
};
Results.prototype.sort = function (data) {
var sorter = this.options.get('sorter');
return sorter(data);
};
Results.prototype.highlightFirstItem = function () {
var $options = this.$results
.find('.select2-results__option[aria-selected]');
var $selected = $options.filter('[aria-selected=true]');
// Check if there are any selected options
if ($selected.length > 0) {
// If there are selected options, highlight the first
$selected.first().trigger('mouseenter');
} else {
// If there are no selected options, highlight the first option
// in the dropdown
$options.first().trigger('mouseenter');
}
this.ensureHighlightVisible();
};
Results.prototype.setClasses = function () {
var self = this;
this.data.current(function (selected) {
var selectedIds = $.map(selected, function (s) {
return s.id.toString();
});
var $options = self.$results
.find('.select2-results__option[aria-selected]');
$options.each(function () {
var $option = $(this);
var item = Utils.GetData(this, 'data');
// id needs to be converted to a string when comparing
var id = '' + item.id;
if ((item.element != null && item.element.selected) ||
(item.element == null && $.inArray(id, selectedIds) > -1)) {
$option.attr('aria-selected', 'true');
} else {
$option.attr('aria-selected', 'false');
}
});
});
};
Results.prototype.showLoading = function (params) {
this.hideLoading();
var loadingMore = this.options.get('translations').get('searching');
var loading = {
disabled: true,
loading: true,
text: loadingMore(params)
};
var $loading = this.option(loading);
$loading.className += ' loading-results';
this.$results.prepend($loading);
};
Results.prototype.hideLoading = function () {
this.$results.find('.loading-results').remove();
};
Results.prototype.option = function (data) {
var option = document.createElement('li');
option.className = 'select2-results__option';
var attrs = {
'role': 'option',
'aria-selected': 'false'
};
var matches = window.Element.prototype.matches ||
window.Element.prototype.msMatchesSelector ||
window.Element.prototype.webkitMatchesSelector;
if ((data.element != null && matches.call(data.element, ':disabled')) ||
(data.element == null && data.disabled)) {
delete attrs['aria-selected'];
attrs['aria-disabled'] = 'true';
}
if (data.id == null) {
delete attrs['aria-selected'];
}
if (data._resultId != null) {
option.id = data._resultId;
}
if (data.title) {
option.title = data.title;
}
if (data.children) {
attrs.role = 'group';
attrs['aria-label'] = data.text;
delete attrs['aria-selected'];
}
for (var attr in attrs) {
var val = attrs[attr];
option.setAttribute(attr, val);
}
if (data.children) {
var $option = $(option);
var label = document.createElement('strong');
label.className = 'select2-results__group';
var $label = $(label);
this.template(data, label);
var $children = [];
for (var c = 0; c < data.children.length; c++) {
var child = data.children[c];
var $child = this.option(child);
$children.push($child);
}
var $childrenContainer = $('<ul></ul>', {
'class': 'select2-results__options select2-results__options--nested'
});
$childrenContainer.append($children);
$option.append(label);
$option.append($childrenContainer);
} else {
this.template(data, option);
}
Utils.StoreData(option, 'data', data);
return option;
};
Results.prototype.bind = function (container, $container) {
var self = this;
var id = container.id + '-results';
this.$results.attr('id', id);
container.on('results:all', function (params) {
self.clear();
self.append(params.data);
if (container.isOpen()) {
self.setClasses();
self.highlightFirstItem();
}
});
container.on('results:append', function (params) {
self.append(params.data);
if (container.isOpen()) {
self.setClasses();
}
});
container.on('query', function (params) {
self.hideMessages();
self.showLoading(params);
});
container.on('select', function () {
if (!container.isOpen()) {
return;
}
self.setClasses();
if (self.options.get('scrollAfterSelect')) {
self.highlightFirstItem();
}
});
container.on('unselect', function () {
if (!container.isOpen()) {
return;
}
self.setClasses();
if (self.options.get('scrollAfterSelect')) {
self.highlightFirstItem();
}
});
container.on('open', function () {
// When the dropdown is open, aria-expended="true"
self.$results.attr('aria-expanded', 'true');
self.$results.attr('aria-hidden', 'false');
self.setClasses();
self.ensureHighlightVisible();
});
container.on('close', function () {
// When the dropdown is closed, aria-expended="false"
self.$results.attr('aria-expanded', 'false');
self.$results.attr('aria-hidden', 'true');
self.$results.removeAttr('aria-activedescendant');
});
container.on('results:toggle', function () {
var $highlighted = self.getHighlightedResults();
if ($highlighted.length === 0) {
return;
}
$highlighted.trigger('mouseup');
});
container.on('results:select', function () {
var $highlighted = self.getHighlightedResults();
if ($highlighted.length === 0) {
return;
}
var data = Utils.GetData($highlighted[0], 'data');
if ($highlighted.attr('aria-selected') == 'true') {
self.trigger('close', {});
} else {
self.trigger('select', {
data: data
});
}
});
container.on('results:previous', function () {
var $highlighted = self.getHighlightedResults();
var $options = self.$results.find('[aria-selected]');
var currentIndex = $options.index($highlighted);
// If we are already at the top, don't move further
// If no options, currentIndex will be -1
if (currentIndex <= 0) {
return;
}
var nextIndex = currentIndex - 1;
// If none are highlighted, highlight the first
if ($highlighted.length === 0) {
nextIndex = 0;
}
var $next = $options.eq(nextIndex);
$next.trigger('mouseenter');
var currentOffset = self.$results.offset().top;
var nextTop = $next.offset().top;
var nextOffset = self.$results.scrollTop() + (nextTop - currentOffset);
if (nextIndex === 0) {
self.$results.scrollTop(0);
} else if (nextTop - currentOffset < 0) {
self.$results.scrollTop(nextOffset);
}
});
container.on('results:next', function () {
var $highlighted = self.getHighlightedResults();
var $options = self.$results.find('[aria-selected]');
var currentIndex = $options.index($highlighted);
var nextIndex = currentIndex + 1;
// If we are at the last option, stay there
if (nextIndex >= $options.length) {
return;
}
var $next = $options.eq(nextIndex);
$next.trigger('mouseenter');
var currentOffset = self.$results.offset().top +
self.$results.outerHeight(false);
var nextBottom = $next.offset().top + $next.outerHeight(false);
var nextOffset = self.$results.scrollTop() + nextBottom - currentOffset;
if (nextIndex === 0) {
self.$results.scrollTop(0);
} else if (nextBottom > currentOffset) {
self.$results.scrollTop(nextOffset);
}
});
container.on('results:focus', function (params) {
params.element.addClass('select2-results__option--highlighted');
});
container.on('results:message', function (params) {
self.displayMessage(params);
});
if ($.fn.mousewheel) {
this.$results.on('mousewheel', function (e) {
var top = self.$results.scrollTop();
var bottom = self.$results.get(0).scrollHeight - top + e.deltaY;
var isAtTop = e.deltaY > 0 && top - e.deltaY <= 0;
var isAtBottom = e.deltaY < 0 && bottom <= self.$results.height();
if (isAtTop) {
self.$results.scrollTop(0);
e.preventDefault();
e.stopPropagation();
} else if (isAtBottom) {
self.$results.scrollTop(
self.$results.get(0).scrollHeight - self.$results.height()
);
e.preventDefault();
e.stopPropagation();
}
});
}
this.$results.on('mouseup', '.select2-results__option[aria-selected]',
function (evt) {
var $this = $(this);
var data = Utils.GetData(this, 'data');
if ($this.attr('aria-selected') === 'true') {
if (self.options.get('multiple')) {
self.trigger('unselect', {
originalEvent: evt,
data: data
});
} else {
self.trigger('close', {});
}
return;
}
self.trigger('select', {
originalEvent: evt,
data: data
});
});
this.$results.on('mouseenter', '.select2-results__option[aria-selected]',
function (evt) {
var data = Utils.GetData(this, 'data');
self.getHighlightedResults()
.removeClass('select2-results__option--highlighted');
self.trigger('results:focus', {
data: data,
element: $(this)
});
});
};
Results.prototype.getHighlightedResults = function () {
var $highlighted = this.$results
.find('.select2-results__option--highlighted');
return $highlighted;
};
Results.prototype.destroy = function () {
this.$results.remove();
};
Results.prototype.ensureHighlightVisible = function () {
var $highlighted = this.getHighlightedResults();
if ($highlighted.length === 0) {
return;
}
var $options = this.$results.find('[aria-selected]');
var currentIndex = $options.index($highlighted);
var currentOffset = this.$results.offset().top;
var nextTop = $highlighted.offset().top;
var nextOffset = this.$results.scrollTop() + (nextTop - currentOffset);
var offsetDelta = nextTop - currentOffset;
nextOffset -= $highlighted.outerHeight(false) * 2;
if (currentIndex <= 2) {
this.$results.scrollTop(0);
} else if (offsetDelta > this.$results.outerHeight() || offsetDelta < 0) {
this.$results.scrollTop(nextOffset);
}
};
Results.prototype.template = function (result, container) {
var template = this.options.get('templateResult');
var escapeMarkup = this.options.get('escapeMarkup');
var content = template(result, container);
if (content == null) {
container.style.display = 'none';
} else if (typeof content === 'string') {
container.innerHTML = escapeMarkup(content);
} else {
$(container).append(content);
}
};
return Results;
});
S2.define('select2/keys',[
], function () {
var KEYS = {
BACKSPACE: 8,
TAB: 9,
ENTER: 13,
SHIFT: 16,
CTRL: 17,
ALT: 18,
ESC: 27,
SPACE: 32,
PAGE_UP: 33,
PAGE_DOWN: 34,
END: 35,
HOME: 36,
LEFT: 37,
UP: 38,
RIGHT: 39,
DOWN: 40,
DELETE: 46
};
return KEYS;
});
S2.define('select2/selection/base',[
'jquery',
'../utils',
'../keys'
], function ($, Utils, KEYS) {
function BaseSelection ($element, options) {
this.$element = $element;
this.options = options;
BaseSelection.__super__.constructor.call(this);
}
Utils.Extend(BaseSelection, Utils.Observable);
BaseSelection.prototype.render = function () {
var $selection = $(
'<span class="select2-selection" role="combobox" ' +
' aria-haspopup="true" aria-expanded="false">' +
'</span>'
);
this._tabindex = 0;
if (Utils.GetData(this.$element[0], 'old-tabindex') != null) {
this._tabindex = Utils.GetData(this.$element[0], 'old-tabindex');
} else if (this.$element.attr('tabindex') != null) {
this._tabindex = this.$element.attr('tabindex');
}
$selection.attr('title', this.$element.attr('title'));
$selection.attr('tabindex', this._tabindex);
$selection.attr('aria-disabled', 'false');
this.$selection = $selection;
return $selection;
};
BaseSelection.prototype.bind = function (container, $container) {
var self = this;
var resultsId = container.id + '-results';
this.container = container;
this.$selection.on('focus', function (evt) {
self.trigger('focus', evt);
});
this.$selection.on('blur', function (evt) {
self._handleBlur(evt);
});
this.$selection.on('keydown', function (evt) {
self.trigger('keypress', evt);
if (evt.which === KEYS.SPACE) {
evt.preventDefault();
}
});
container.on('results:focus', function (params) {
self.$selection.attr('aria-activedescendant', params.data._resultId);
});
container.on('selection:update', function (params) {
self.update(params.data);
});
container.on('open', function () {
// When the dropdown is open, aria-expanded="true"
self.$selection.attr('aria-expanded', 'true');
self.$selection.attr('aria-owns', resultsId);
self._attachCloseHandler(container);
});
container.on('close', function () {
// When the dropdown is closed, aria-expanded="false"
self.$selection.attr('aria-expanded', 'false');
self.$selection.removeAttr('aria-activedescendant');
self.$selection.removeAttr('aria-owns');
self.$selection.trigger('focus');
self._detachCloseHandler(container);
});
container.on('enable', function () {
self.$selection.attr('tabindex', self._tabindex);
self.$selection.attr('aria-disabled', 'false');
});
container.on('disable', function () {
self.$selection.attr('tabindex', '-1');
self.$selection.attr('aria-disabled', 'true');
});
};
BaseSelection.prototype._handleBlur = function (evt) {
var self = this;
// This needs to be delayed as the active element is the body when the tab
// key is pressed, possibly along with others.
window.setTimeout(function () {
// Don't trigger `blur` if the focus is still in the selection
if (
(document.activeElement == self.$selection[0]) ||
($.contains(self.$selection[0], document.activeElement))
) {
return;
}
self.trigger('blur', evt);
}, 1);
};
BaseSelection.prototype._attachCloseHandler = function (container) {
$(document.body).on('mousedown.select2.' + container.id, function (e) {
var $target = $(e.target);
var $select = $target.closest('.select2');
var $all = $('.select2.select2-container--open');
$all.each(function () {
if (this == $select[0]) {
return;
}
var $element = Utils.GetData(this, 'element');
$element.select2('close');
});
});
};
BaseSelection.prototype._detachCloseHandler = function (container) {
$(document.body).off('mousedown.select2.' + container.id);
};
BaseSelection.prototype.position = function ($selection, $container) {
var $selectionContainer = $container.find('.selection');
$selectionContainer.append($selection);
};
BaseSelection.prototype.destroy = function () {
this._detachCloseHandler(this.container);
};
BaseSelection.prototype.update = function (data) {
throw new Error('The `update` method must be defined in child classes.');
};
/**
* Helper method to abstract the "enabled" (not "disabled") state of this
* object.
*
* @return {true} if the instance is not disabled.
* @return {false} if the instance is disabled.
*/
BaseSelection.prototype.isEnabled = function () {
return !this.isDisabled();
};
/**
* Helper method to abstract the "disabled" state of this object.
*
* @return {true} if the disabled option is true.
* @return {false} if the disabled option is false.
*/
BaseSelection.prototype.isDisabled = function () {
return this.options.get('disabled');
};
return BaseSelection;
});
S2.define('select2/selection/single',[
'jquery',
'./base',
'../utils',
'../keys'
], function ($, BaseSelection, Utils, KEYS) {
function SingleSelection () {
SingleSelection.__super__.constructor.apply(this, arguments);
}
Utils.Extend(SingleSelection, BaseSelection);
SingleSelection.prototype.render = function () {
var $selection = SingleSelection.__super__.render.call(this);
$selection.addClass('select2-selection--single');
$selection.html(
'<span class="select2-selection__rendered"></span>' +
'<span class="select2-selection__arrow" role="presentation">' +
'<b role="presentation"></b>' +
'</span>'
);
return $selection;
};
SingleSelection.prototype.bind = function (container, $container) {
var self = this;
SingleSelection.__super__.bind.apply(this, arguments);
var id = container.id + '-container';
this.$selection.find('.select2-selection__rendered')
.attr('id', id)
.attr('role', 'textbox')
.attr('aria-readonly', 'true');
this.$selection.attr('aria-labelledby', id);
this.$selection.on('mousedown', function (evt) {
// Only respond to left clicks
if (evt.which !== 1) {
return;
}
self.trigger('toggle', {
originalEvent: evt
});
});
this.$selection.on('focus', function (evt) {
// User focuses on the container
});
this.$selection.on('blur', function (evt) {
// User exits the container
});
container.on('focus', function (evt) {
if (!container.isOpen()) {
self.$selection.trigger('focus');
}
});
};
SingleSelection.prototype.clear = function () {
var $rendered = this.$selection.find('.select2-selection__rendered');
$rendered.empty();
$rendered.removeAttr('title'); // clear tooltip on empty
};
SingleSelection.prototype.display = function (data, container) {
var template = this.options.get('templateSelection');
var escapeMarkup = this.options.get('escapeMarkup');
return escapeMarkup(template(data, container));
};
SingleSelection.prototype.selectionContainer = function () {
return $('<span></span>');
};
SingleSelection.prototype.update = function (data) {
if (data.length === 0) {
this.clear();
return;
}
var selection = data[0];
var $rendered = this.$selection.find('.select2-selection__rendered');
var formatted = this.display(selection, $rendered);
$rendered.empty().append(formatted);
var title = selection.title || selection.text;
if (title) {
$rendered.attr('title', title);
} else {
$rendered.removeAttr('title');
}
};
return SingleSelection;
});
S2.define('select2/selection/multiple',[
'jquery',
'./base',
'../utils'
], function ($, BaseSelection, Utils) {
function MultipleSelection ($element, options) {
MultipleSelection.__super__.constructor.apply(this, arguments);
}
Utils.Extend(MultipleSelection, BaseSelection);
MultipleSelection.prototype.render = function () {
var $selection = MultipleSelection.__super__.render.call(this);
$selection.addClass('select2-selection--multiple');
$selection.html(
'<ul class="select2-selection__rendered"></ul>'
);
return $selection;
};
MultipleSelection.prototype.bind = function (container, $container) {
var self = this;
MultipleSelection.__super__.bind.apply(this, arguments);
this.$selection.on('click', function (evt) {
self.trigger('toggle', {
originalEvent: evt
});
});
this.$selection.on(
'click',
'.select2-selection__choice__remove',
function (evt) {
// Ignore the event if it is disabled
if (self.isDisabled()) {
return;
}
var $remove = $(this);
var $selection = $remove.parent();
var data = Utils.GetData($selection[0], 'data');
self.trigger('unselect', {
originalEvent: evt,
data: data
});
}
);
};
MultipleSelection.prototype.clear = function () {
var $rendered = this.$selection.find('.select2-selection__rendered');
$rendered.empty();
$rendered.removeAttr('title');
};
MultipleSelection.prototype.display = function (data, container) {
var template = this.options.get('templateSelection');
var escapeMarkup = this.options.get('escapeMarkup');
return escapeMarkup(template(data, container));
};
MultipleSelection.prototype.selectionContainer = function () {
var $container = $(
'<li class="select2-selection__choice">' +
'<span class="select2-selection__choice__remove" role="presentation">' +
'×' +
'</span>' +
'</li>'
);
return $container;
};
MultipleSelection.prototype.update = function (data) {
this.clear();
if (data.length === 0) {
return;
}
var $selections = [];
for (var d = 0; d < data.length; d++) {
var selection = data[d];
var $selection = this.selectionContainer();
var formatted = this.display(selection, $selection);
$selection.append(formatted);
var title = selection.title || selection.text;
if (title) {
$selection.attr('title', title);
}
Utils.StoreData($selection[0], 'data', selection);
$selections.push($selection);
}
var $rendered = this.$selection.find('.select2-selection__rendered');
Utils.appendMany($rendered, $selections);
};
return MultipleSelection;
});
S2.define('select2/selection/placeholder',[
'../utils'
], function (Utils) {
function Placeholder (decorated, $element, options) {
this.placeholder = this.normalizePlaceholder(options.get('placeholder'));
decorated.call(this, $element, options);
}
Placeholder.prototype.normalizePlaceholder = function (_, placeholder) {
if (typeof placeholder === 'string') {
placeholder = {
id: '',
text: placeholder
};
}
return placeholder;
};
Placeholder.prototype.createPlaceholder = function (decorated, placeholder) {
var $placeholder = this.selectionContainer();
$placeholder.html(this.display(placeholder));
$placeholder.addClass('select2-selection__placeholder')
.removeClass('select2-selection__choice');
return $placeholder;
};
Placeholder.prototype.update = function (decorated, data) {
var singlePlaceholder = (
data.length == 1 && data[0].id != this.placeholder.id
);
var multipleSelections = data.length > 1;
if (multipleSelections || singlePlaceholder) {
return decorated.call(this, data);
}
this.clear();
var $placeholder = this.createPlaceholder(this.placeholder);
this.$selection.find('.select2-selection__rendered').append($placeholder);
};
return Placeholder;
});
S2.define('select2/selection/allowClear',[
'jquery',
'../keys',
'../utils'
], function ($, KEYS, Utils) {
function AllowClear () { }
AllowClear.prototype.bind = function (decorated, container, $container) {
var self = this;
decorated.call(this, container, $container);
if (this.placeholder == null) {
if (this.options.get('debug') && window.console && console.error) {
console.error(
'Select2: The `allowClear` option should be used in combination ' +
'with the `placeholder` option.'
);
}
}
this.$selection.on('mousedown', '.select2-selection__clear',
function (evt) {
self._handleClear(evt);
});
container.on('keypress', function (evt) {
self._handleKeyboardClear(evt, container);
});
};
AllowClear.prototype._handleClear = function (_, evt) {
// Ignore the event if it is disabled
if (this.isDisabled()) {
return;
}
var $clear = this.$selection.find('.select2-selection__clear');
// Ignore the event if nothing has been selected
if ($clear.length === 0) {
return;
}
evt.stopPropagation();
var data = Utils.GetData($clear[0], 'data');
var previousVal = this.$element.val();
this.$element.val(this.placeholder.id);
var unselectData = {
data: data
};
this.trigger('clear', unselectData);
if (unselectData.prevented) {
this.$element.val(previousVal);
return;
}
for (var d = 0; d < data.length; d++) {
unselectData = {
data: data[d]
};
// Trigger the `unselect` event, so people can prevent it from being
// cleared.
this.trigger('unselect', unselectData);
// If the event was prevented, don't clear it out.
if (unselectData.prevented) {
this.$element.val(previousVal);
return;
}
}
this.$element.trigger('input').trigger('change');
this.trigger('toggle', {});
};
AllowClear.prototype._handleKeyboardClear = function (_, evt, container) {
if (container.isOpen()) {
return;
}
if (evt.which == KEYS.DELETE || evt.which == KEYS.BACKSPACE) {
this._handleClear(evt);
}
};
AllowClear.prototype.update = function (decorated, data) {
decorated.call(this, data);
if (this.$selection.find('.select2-selection__placeholder').length > 0 ||
data.length === 0) {
return;
}
var removeAll = this.options.get('translations').get('removeAllItems');
var $remove = $(
'<span class="select2-selection__clear" title="' + removeAll() +'">' +
'×' +
'</span>'
);
Utils.StoreData($remove[0], 'data', data);
this.$selection.find('.select2-selection__rendered').prepend($remove);
};
return AllowClear;
});
S2.define('select2/selection/search',[
'jquery',
'../utils',
'../keys'
], function ($, Utils, KEYS) {
function Search (decorated, $element, options) {
decorated.call(this, $element, options);
}
Search.prototype.render = function (decorated) {
var $search = $(
'<li class="select2-search select2-search--inline">' +
'<input class="select2-search__field" type="search" tabindex="-1"' +
' autocomplete="off" autocorrect="off" autocapitalize="none"' +
' spellcheck="false" role="searchbox" aria-autocomplete="list" />' +
'</li>'
);
this.$searchContainer = $search;
this.$search = $search.find('input');
var $rendered = decorated.call(this);
this._transferTabIndex();
return $rendered;
};
Search.prototype.bind = function (decorated, container, $container) {
var self = this;
var resultsId = container.id + '-results';
decorated.call(this, container, $container);
container.on('open', function () {
self.$search.attr('aria-controls', resultsId);
self.$search.trigger('focus');
});
container.on('close', function () {
self.$search.val('');
self.$search.removeAttr('aria-controls');
self.$search.removeAttr('aria-activedescendant');
self.$search.trigger('focus');
});
container.on('enable', function () {
self.$search.prop('disabled', false);
self._transferTabIndex();
});
container.on('disable', function () {
self.$search.prop('disabled', true);
});
container.on('focus', function (evt) {
self.$search.trigger('focus');
});
container.on('results:focus', function (params) {
if (params.data._resultId) {
self.$search.attr('aria-activedescendant', params.data._resultId);
} else {
self.$search.removeAttr('aria-activedescendant');
}
});
this.$selection.on('focusin', '.select2-search--inline', function (evt) {
self.trigger('focus', evt);
});
this.$selection.on('focusout', '.select2-search--inline', function (evt) {
self._handleBlur(evt);
});
this.$selection.on('keydown', '.select2-search--inline', function (evt) {
evt.stopPropagation();
self.trigger('keypress', evt);
self._keyUpPrevented = evt.isDefaultPrevented();
var key = evt.which;
if (key === KEYS.BACKSPACE && self.$search.val() === '') {
var $previousChoice = self.$searchContainer
.prev('.select2-selection__choice');
if ($previousChoice.length > 0) {
var item = Utils.GetData($previousChoice[0], 'data');
self.searchRemoveChoice(item);
evt.preventDefault();
}
}
});
this.$selection.on('click', '.select2-search--inline', function (evt) {
if (self.$search.val()) {
evt.stopPropagation();
}
});
// Try to detect the IE version should the `documentMode` property that
// is stored on the document. This is only implemented in IE and is
// slightly cleaner than doing a user agent check.
// This property is not available in Edge, but Edge also doesn't have
// this bug.
var msie = document.documentMode;
var disableInputEvents = msie && msie <= 11;
// Workaround for browsers which do not support the `input` event
// This will prevent double-triggering of events for browsers which support
// both the `keyup` and `input` events.
this.$selection.on(
'input.searchcheck',
'.select2-search--inline',
function (evt) {
// IE will trigger the `input` event when a placeholder is used on a
// search box. To get around this issue, we are forced to ignore all
// `input` events in IE and keep using `keyup`.
if (disableInputEvents) {
self.$selection.off('input.search input.searchcheck');
return;
}
// Unbind the duplicated `keyup` event
self.$selection.off('keyup.search');
}
);
this.$selection.on(
'keyup.search input.search',
'.select2-search--inline',
function (evt) {
// IE will trigger the `input` event when a placeholder is used on a
// search box. To get around this issue, we are forced to ignore all
// `input` events in IE and keep using `keyup`.
if (disableInputEvents && evt.type === 'input') {
self.$selection.off('input.search input.searchcheck');
return;
}
var key = evt.which;
// We can freely ignore events from modifier keys
if (key == KEYS.SHIFT || key == KEYS.CTRL || key == KEYS.ALT) {
return;
}
// Tabbing will be handled during the `keydown` phase
if (key == KEYS.TAB) {
return;
}
self.handleSearch(evt);
}
);
};
/**
* This method will transfer the tabindex attribute from the rendered
* selection to the search box. This allows for the search box to be used as
* the primary focus instead of the selection container.
*
* @private
*/
Search.prototype._transferTabIndex = function (decorated) {
this.$search.attr('tabindex', this.$selection.attr('tabindex'));
this.$selection.attr('tabindex', '-1');
};
Search.prototype.createPlaceholder = function (decorated, placeholder) {
this.$search.attr('placeholder', placeholder.text);
};
Search.prototype.update = function (decorated, data) {
var searchHadFocus = this.$search[0] == document.activeElement;
this.$search.attr('placeholder', '');
decorated.call(this, data);
this.$selection.find('.select2-selection__rendered')
.append(this.$searchContainer);
this.resizeSearch();
if (searchHadFocus) {
this.$search.trigger('focus');
}
};
Search.prototype.handleSearch = function () {
this.resizeSearch();
if (!this._keyUpPrevented) {
var input = this.$search.val();
this.trigger('query', {
term: input
});
}
this._keyUpPrevented = false;
};
Search.prototype.searchRemoveChoice = function (decorated, item) {
this.trigger('unselect', {
data: item
});
this.$search.val(item.text);
this.handleSearch();
};
Search.prototype.resizeSearch = function () {
this.$search.css('width', '25px');
var width = '';
if (this.$search.attr('placeholder') !== '') {
width = this.$selection.find('.select2-selection__rendered').width();
} else {
var minimumWidth = this.$search.val().length + 1;
width = (minimumWidth * 0.75) + 'em';
}
this.$search.css('width', width);
};
return Search;
});
S2.define('select2/selection/eventRelay',[
'jquery'
], function ($) {
function EventRelay () { }
EventRelay.prototype.bind = function (decorated, container, $container) {
var self = this;
var relayEvents = [
'open', 'opening',
'close', 'closing',
'select', 'selecting',
'unselect', 'unselecting',
'clear', 'clearing'
];
var preventableEvents = [
'opening', 'closing', 'selecting', 'unselecting', 'clearing'
];
decorated.call(this, container, $container);
container.on('*', function (name, params) {
// Ignore events that should not be relayed
if ($.inArray(name, relayEvents) === -1) {
return;
}
// The parameters should always be an object
params = params || {};
// Generate the jQuery event for the Select2 event
var evt = $.Event('select2:' + name, {
params: params
});
self.$element.trigger(evt);
// Only handle preventable events if it was one
if ($.inArray(name, preventableEvents) === -1) {
return;
}
params.prevented = evt.isDefaultPrevented();
});
};
return EventRelay;
});
S2.define('select2/translation',[
'jquery',
'require'
], function ($, require) {
function Translation (dict) {
this.dict = dict || {};
}
Translation.prototype.all = function () {
return this.dict;
};
Translation.prototype.get = function (key) {
return this.dict[key];
};
Translation.prototype.extend = function (translation) {
this.dict = $.extend({}, translation.all(), this.dict);
};
// Static functions
Translation._cache = {};
Translation.loadPath = function (path) {
if (!(path in Translation._cache)) {
var translations = require(path);
Translation._cache[path] = translations;
}
return new Translation(Translation._cache[path]);
};
return Translation;
});
S2.define('select2/diacritics',[
], function () {
var diacritics = {
'\u24B6': 'A',
'\uFF21': 'A',
'\u00C0': 'A',
'\u00C1': 'A',
'\u00C2': 'A',
'\u1EA6': 'A',
'\u1EA4': 'A',
'\u1EAA': 'A',
'\u1EA8': 'A',
'\u00C3': 'A',
'\u0100': 'A',
'\u0102': 'A',
'\u1EB0': 'A',
'\u1EAE': 'A',
'\u1EB4': 'A',
'\u1EB2': 'A',
'\u0226': 'A',
'\u01E0': 'A',
'\u00C4': 'A',
'\u01DE': 'A',
'\u1EA2': 'A',
'\u00C5': 'A',
'\u01FA': 'A',
'\u01CD': 'A',
'\u0200': 'A',
'\u0202': 'A',
'\u1EA0': 'A',
'\u1EAC': 'A',
'\u1EB6': 'A',
'\u1E00': 'A',
'\u0104': 'A',
'\u023A': 'A',
'\u2C6F': 'A',
'\uA732': 'AA',
'\u00C6': 'AE',
'\u01FC': 'AE',
'\u01E2': 'AE',
'\uA734': 'AO',
'\uA736': 'AU',
'\uA738': 'AV',
'\uA73A': 'AV',
'\uA73C': 'AY',
'\u24B7': 'B',
'\uFF22': 'B',
'\u1E02': 'B',
'\u1E04': 'B',
'\u1E06': 'B',
'\u0243': 'B',
'\u0182': 'B',
'\u0181': 'B',
'\u24B8': 'C',
'\uFF23': 'C',
'\u0106': 'C',
'\u0108': 'C',
'\u010A': 'C',
'\u010C': 'C',
'\u00C7': 'C',
'\u1E08': 'C',
'\u0187': 'C',
'\u023B': 'C',
'\uA73E': 'C',
'\u24B9': 'D',
'\uFF24': 'D',
'\u1E0A': 'D',
'\u010E': 'D',
'\u1E0C': 'D',
'\u1E10': 'D',
'\u1E12': 'D',
'\u1E0E': 'D',
'\u0110': 'D',
'\u018B': 'D',
'\u018A': 'D',
'\u0189': 'D',
'\uA779': 'D',
'\u01F1': 'DZ',
'\u01C4': 'DZ',
'\u01F2': 'Dz',
'\u01C5': 'Dz',
'\u24BA': 'E',
'\uFF25': 'E',
'\u00C8': 'E',
'\u00C9': 'E',
'\u00CA': 'E',
'\u1EC0': 'E',
'\u1EBE': 'E',
'\u1EC4': 'E',
'\u1EC2': 'E',
'\u1EBC': 'E',
'\u0112': 'E',
'\u1E14': 'E',
'\u1E16': 'E',
'\u0114': 'E',
'\u0116': 'E',
'\u00CB': 'E',
'\u1EBA': 'E',
'\u011A': 'E',
'\u0204': 'E',
'\u0206': 'E',
'\u1EB8': 'E',
'\u1EC6': 'E',
'\u0228': 'E',
'\u1E1C': 'E',
'\u0118': 'E',
'\u1E18': 'E',
'\u1E1A': 'E',
'\u0190': 'E',
'\u018E': 'E',
'\u24BB': 'F',
'\uFF26': 'F',
'\u1E1E': 'F',
'\u0191': 'F',
'\uA77B': 'F',
'\u24BC': 'G',
'\uFF27': 'G',
'\u01F4': 'G',
'\u011C': 'G',
'\u1E20': 'G',
'\u011E': 'G',
'\u0120': 'G',
'\u01E6': 'G',
'\u0122': 'G',
'\u01E4': 'G',
'\u0193': 'G',
'\uA7A0': 'G',
'\uA77D': 'G',
'\uA77E': 'G',
'\u24BD': 'H',
'\uFF28': 'H',
'\u0124': 'H',
'\u1E22': 'H',
'\u1E26': 'H',
'\u021E': 'H',
'\u1E24': 'H',
'\u1E28': 'H',
'\u1E2A': 'H',
'\u0126': 'H',
'\u2C67': 'H',
'\u2C75': 'H',
'\uA78D': 'H',
'\u24BE': 'I',
'\uFF29': 'I',
'\u00CC': 'I',
'\u00CD': 'I',
'\u00CE': 'I',
'\u0128': 'I',
'\u012A': 'I',
'\u012C': 'I',
'\u0130': 'I',
'\u00CF': 'I',
'\u1E2E': 'I',
'\u1EC8': 'I',
'\u01CF': 'I',
'\u0208': 'I',
'\u020A': 'I',
'\u1ECA': 'I',
'\u012E': 'I',
'\u1E2C': 'I',
'\u0197': 'I',
'\u24BF': 'J',
'\uFF2A': 'J',
'\u0134': 'J',
'\u0248': 'J',
'\u24C0': 'K',
'\uFF2B': 'K',
'\u1E30': 'K',
'\u01E8': 'K',
'\u1E32': 'K',
'\u0136': 'K',
'\u1E34': 'K',
'\u0198': 'K',
'\u2C69': 'K',
'\uA740': 'K',
'\uA742': 'K',
'\uA744': 'K',
'\uA7A2': 'K',
'\u24C1': 'L',
'\uFF2C': 'L',
'\u013F': 'L',
'\u0139': 'L',
'\u013D': 'L',
'\u1E36': 'L',
'\u1E38': 'L',
'\u013B': 'L',
'\u1E3C': 'L',
'\u1E3A': 'L',
'\u0141': 'L',
'\u023D': 'L',
'\u2C62': 'L',
'\u2C60': 'L',
'\uA748': 'L',
'\uA746': 'L',
'\uA780': 'L',
'\u01C7': 'LJ',
'\u01C8': 'Lj',
'\u24C2': 'M',
'\uFF2D': 'M',
'\u1E3E': 'M',
'\u1E40': 'M',
'\u1E42': 'M',
'\u2C6E': 'M',
'\u019C': 'M',
'\u24C3': 'N',
'\uFF2E': 'N',
'\u01F8': 'N',
'\u0143': 'N',
'\u00D1': 'N',
'\u1E44': 'N',
'\u0147': 'N',
'\u1E46': 'N',
'\u0145': 'N',
'\u1E4A': 'N',
'\u1E48': 'N',
'\u0220': 'N',
'\u019D': 'N',
'\uA790': 'N',
'\uA7A4': 'N',
'\u01CA': 'NJ',
'\u01CB': 'Nj',
'\u24C4': 'O',
'\uFF2F': 'O',
'\u00D2': 'O',
'\u00D3': 'O',
'\u00D4': 'O',
'\u1ED2': 'O',
'\u1ED0': 'O',
'\u1ED6': 'O',
'\u1ED4': 'O',
'\u00D5': 'O',
'\u1E4C': 'O',
'\u022C': 'O',
'\u1E4E': 'O',
'\u014C': 'O',
'\u1E50': 'O',
'\u1E52': 'O',
'\u014E': 'O',
'\u022E': 'O',
'\u0230': 'O',
'\u00D6': 'O',
'\u022A': 'O',
'\u1ECE': 'O',
'\u0150': 'O',
'\u01D1': 'O',
'\u020C': 'O',
'\u020E': 'O',
'\u01A0': 'O',
'\u1EDC': 'O',
'\u1EDA': 'O',
'\u1EE0': 'O',
'\u1EDE': 'O',
'\u1EE2': 'O',
'\u1ECC': 'O',
'\u1ED8': 'O',
'\u01EA': 'O',
'\u01EC': 'O',
'\u00D8': 'O',
'\u01FE': 'O',
'\u0186': 'O',
'\u019F': 'O',
'\uA74A': 'O',
'\uA74C': 'O',
'\u0152': 'OE',
'\u01A2': 'OI',
'\uA74E': 'OO',
'\u0222': 'OU',
'\u24C5': 'P',
'\uFF30': 'P',
'\u1E54': 'P',
'\u1E56': 'P',
'\u01A4': 'P',
'\u2C63': 'P',
'\uA750': 'P',
'\uA752': 'P',
'\uA754': 'P',
'\u24C6': 'Q',
'\uFF31': 'Q',
'\uA756': 'Q',
'\uA758': 'Q',
'\u024A': 'Q',
'\u24C7': 'R',
'\uFF32': 'R',
'\u0154': 'R',
'\u1E58': 'R',
'\u0158': 'R',
'\u0210': 'R',
'\u0212': 'R',
'\u1E5A': 'R',
'\u1E5C': 'R',
'\u0156': 'R',
'\u1E5E': 'R',
'\u024C': 'R',
'\u2C64': 'R',
'\uA75A': 'R',
'\uA7A6': 'R',
'\uA782': 'R',
'\u24C8': 'S',
'\uFF33': 'S',
'\u1E9E': 'S',
'\u015A': 'S',
'\u1E64': 'S',
'\u015C': 'S',
'\u1E60': 'S',
'\u0160': 'S',
'\u1E66': 'S',
'\u1E62': 'S',
'\u1E68': 'S',
'\u0218': 'S',
'\u015E': 'S',
'\u2C7E': 'S',
'\uA7A8': 'S',
'\uA784': 'S',
'\u24C9': 'T',
'\uFF34': 'T',
'\u1E6A': 'T',
'\u0164': 'T',
'\u1E6C': 'T',
'\u021A': 'T',
'\u0162': 'T',
'\u1E70': 'T',
'\u1E6E': 'T',
'\u0166': 'T',
'\u01AC': 'T',
'\u01AE': 'T',
'\u023E': 'T',
'\uA786': 'T',
'\uA728': 'TZ',
'\u24CA': 'U',
'\uFF35': 'U',
'\u00D9': 'U',
'\u00DA': 'U',
'\u00DB': 'U',
'\u0168': 'U',
'\u1E78': 'U',
'\u016A': 'U',
'\u1E7A': 'U',
'\u016C': 'U',
'\u00DC': 'U',
'\u01DB': 'U',
'\u01D7': 'U',
'\u01D5': 'U',
'\u01D9': 'U',
'\u1EE6': 'U',
'\u016E': 'U',
'\u0170': 'U',
'\u01D3': 'U',
'\u0214': 'U',
'\u0216': 'U',
'\u01AF': 'U',
'\u1EEA': 'U',
'\u1EE8': 'U',
'\u1EEE': 'U',
'\u1EEC': 'U',
'\u1EF0': 'U',
'\u1EE4': 'U',
'\u1E72': 'U',
'\u0172': 'U',
'\u1E76': 'U',
'\u1E74': 'U',
'\u0244': 'U',
'\u24CB': 'V',
'\uFF36': 'V',
'\u1E7C': 'V',
'\u1E7E': 'V',
'\u01B2': 'V',
'\uA75E': 'V',
'\u0245': 'V',
'\uA760': 'VY',
'\u24CC': 'W',
'\uFF37': 'W',
'\u1E80': 'W',
'\u1E82': 'W',
'\u0174': 'W',
'\u1E86': 'W',
'\u1E84': 'W',
'\u1E88': 'W',
'\u2C72': 'W',
'\u24CD': 'X',
'\uFF38': 'X',
'\u1E8A': 'X',
'\u1E8C': 'X',
'\u24CE': 'Y',
'\uFF39': 'Y',
'\u1EF2': 'Y',
'\u00DD': 'Y',
'\u0176': 'Y',
'\u1EF8': 'Y',
'\u0232': 'Y',
'\u1E8E': 'Y',
'\u0178': 'Y',
'\u1EF6': 'Y',
'\u1EF4': 'Y',
'\u01B3': 'Y',
'\u024E': 'Y',
'\u1EFE': 'Y',
'\u24CF': 'Z',
'\uFF3A': 'Z',
'\u0179': 'Z',
'\u1E90': 'Z',
'\u017B': 'Z',
'\u017D': 'Z',
'\u1E92': 'Z',
'\u1E94': 'Z',
'\u01B5': 'Z',
'\u0224': 'Z',
'\u2C7F': 'Z',
'\u2C6B': 'Z',
'\uA762': 'Z',
'\u24D0': 'a',
'\uFF41': 'a',
'\u1E9A': 'a',
'\u00E0': 'a',
'\u00E1': 'a',
'\u00E2': 'a',
'\u1EA7': 'a',
'\u1EA5': 'a',
'\u1EAB': 'a',
'\u1EA9': 'a',
'\u00E3': 'a',
'\u0101': 'a',
'\u0103': 'a',
'\u1EB1': 'a',
'\u1EAF': 'a',
'\u1EB5': 'a',
'\u1EB3': 'a',
'\u0227': 'a',
'\u01E1': 'a',
'\u00E4': 'a',
'\u01DF': 'a',
'\u1EA3': 'a',
'\u00E5': 'a',
'\u01FB': 'a',
'\u01CE': 'a',
'\u0201': 'a',
'\u0203': 'a',
'\u1EA1': 'a',
'\u1EAD': 'a',
'\u1EB7': 'a',
'\u1E01': 'a',
'\u0105': 'a',
'\u2C65': 'a',
'\u0250': 'a',
'\uA733': 'aa',
'\u00E6': 'ae',
'\u01FD': 'ae',
'\u01E3': 'ae',
'\uA735': 'ao',
'\uA737': 'au',
'\uA739': 'av',
'\uA73B': 'av',
'\uA73D': 'ay',
'\u24D1': 'b',
'\uFF42': 'b',
'\u1E03': 'b',
'\u1E05': 'b',
'\u1E07': 'b',
'\u0180': 'b',
'\u0183': 'b',
'\u0253': 'b',
'\u24D2': 'c',
'\uFF43': 'c',
'\u0107': 'c',
'\u0109': 'c',
'\u010B': 'c',
'\u010D': 'c',
'\u00E7': 'c',
'\u1E09': 'c',
'\u0188': 'c',
'\u023C': 'c',
'\uA73F': 'c',
'\u2184': 'c',
'\u24D3': 'd',
'\uFF44': 'd',
'\u1E0B': 'd',
'\u010F': 'd',
'\u1E0D': 'd',
'\u1E11': 'd',
'\u1E13': 'd',
'\u1E0F': 'd',
'\u0111': 'd',
'\u018C': 'd',
'\u0256': 'd',
'\u0257': 'd',
'\uA77A': 'd',
'\u01F3': 'dz',
'\u01C6': 'dz',
'\u24D4': 'e',
'\uFF45': 'e',
'\u00E8': 'e',
'\u00E9': 'e',
'\u00EA': 'e',
'\u1EC1': 'e',
'\u1EBF': 'e',
'\u1EC5': 'e',
'\u1EC3': 'e',
'\u1EBD': 'e',
'\u0113': 'e',
'\u1E15': 'e',
'\u1E17': 'e',
'\u0115': 'e',
'\u0117': 'e',
'\u00EB': 'e',
'\u1EBB': 'e',
'\u011B': 'e',
'\u0205': 'e',
'\u0207': 'e',
'\u1EB9': 'e',
'\u1EC7': 'e',
'\u0229': 'e',
'\u1E1D': 'e',
'\u0119': 'e',
'\u1E19': 'e',
'\u1E1B': 'e',
'\u0247': 'e',
'\u025B': 'e',
'\u01DD': 'e',
'\u24D5': 'f',
'\uFF46': 'f',
'\u1E1F': 'f',
'\u0192': 'f',
'\uA77C': 'f',
'\u24D6': 'g',
'\uFF47': 'g',
'\u01F5': 'g',
'\u011D': 'g',
'\u1E21': 'g',
'\u011F': 'g',
'\u0121': 'g',
'\u01E7': 'g',
'\u0123': 'g',
'\u01E5': 'g',
'\u0260': 'g',
'\uA7A1': 'g',
'\u1D79': 'g',
'\uA77F': 'g',
'\u24D7': 'h',
'\uFF48': 'h',
'\u0125': 'h',
'\u1E23': 'h',
'\u1E27': 'h',
'\u021F': 'h',
'\u1E25': 'h',
'\u1E29': 'h',
'\u1E2B': 'h',
'\u1E96': 'h',
'\u0127': 'h',
'\u2C68': 'h',
'\u2C76': 'h',
'\u0265': 'h',
'\u0195': 'hv',
'\u24D8': 'i',
'\uFF49': 'i',
'\u00EC': 'i',
'\u00ED': 'i',
'\u00EE': 'i',
'\u0129': 'i',
'\u012B': 'i',
'\u012D': 'i',
'\u00EF': 'i',
'\u1E2F': 'i',
'\u1EC9': 'i',
'\u01D0': 'i',
'\u0209': 'i',
'\u020B': 'i',
'\u1ECB': 'i',
'\u012F': 'i',
'\u1E2D': 'i',
'\u0268': 'i',
'\u0131': 'i',
'\u24D9': 'j',
'\uFF4A': 'j',
'\u0135': 'j',
'\u01F0': 'j',
'\u0249': 'j',
'\u24DA': 'k',
'\uFF4B': 'k',
'\u1E31': 'k',
'\u01E9': 'k',
'\u1E33': 'k',
'\u0137': 'k',
'\u1E35': 'k',
'\u0199': 'k',
'\u2C6A': 'k',
'\uA741': 'k',
'\uA743': 'k',
'\uA745': 'k',
'\uA7A3': 'k',
'\u24DB': 'l',
'\uFF4C': 'l',
'\u0140': 'l',
'\u013A': 'l',
'\u013E': 'l',
'\u1E37': 'l',
'\u1E39': 'l',
'\u013C': 'l',
'\u1E3D': 'l',
'\u1E3B': 'l',
'\u017F': 'l',
'\u0142': 'l',
'\u019A': 'l',
'\u026B': 'l',
'\u2C61': 'l',
'\uA749': 'l',
'\uA781': 'l',
'\uA747': 'l',
'\u01C9': 'lj',
'\u24DC': 'm',
'\uFF4D': 'm',
'\u1E3F': 'm',
'\u1E41': 'm',
'\u1E43': 'm',
'\u0271': 'm',
'\u026F': 'm',
'\u24DD': 'n',
'\uFF4E': 'n',
'\u01F9': 'n',
'\u0144': 'n',
'\u00F1': 'n',
'\u1E45': 'n',
'\u0148': 'n',
'\u1E47': 'n',
'\u0146': 'n',
'\u1E4B': 'n',
'\u1E49': 'n',
'\u019E': 'n',
'\u0272': 'n',
'\u0149': 'n',
'\uA791': 'n',
'\uA7A5': 'n',
'\u01CC': 'nj',
'\u24DE': 'o',
'\uFF4F': 'o',
'\u00F2': 'o',
'\u00F3': 'o',
'\u00F4': 'o',
'\u1ED3': 'o',
'\u1ED1': 'o',
'\u1ED7': 'o',
'\u1ED5': 'o',
'\u00F5': 'o',
'\u1E4D': 'o',
'\u022D': 'o',
'\u1E4F': 'o',
'\u014D': 'o',
'\u1E51': 'o',
'\u1E53': 'o',
'\u014F': 'o',
'\u022F': 'o',
'\u0231': 'o',
'\u00F6': 'o',
'\u022B': 'o',
'\u1ECF': 'o',
'\u0151': 'o',
'\u01D2': 'o',
'\u020D': 'o',
'\u020F': 'o',
'\u01A1': 'o',
'\u1EDD': 'o',
'\u1EDB': 'o',
'\u1EE1': 'o',
'\u1EDF': 'o',
'\u1EE3': 'o',
'\u1ECD': 'o',
'\u1ED9': 'o',
'\u01EB': 'o',
'\u01ED': 'o',
'\u00F8': 'o',
'\u01FF': 'o',
'\u0254': 'o',
'\uA74B': 'o',
'\uA74D': 'o',
'\u0275': 'o',
'\u0153': 'oe',
'\u01A3': 'oi',
'\u0223': 'ou',
'\uA74F': 'oo',
'\u24DF': 'p',
'\uFF50': 'p',
'\u1E55': 'p',
'\u1E57': 'p',
'\u01A5': 'p',
'\u1D7D': 'p',
'\uA751': 'p',
'\uA753': 'p',
'\uA755': 'p',
'\u24E0': 'q',
'\uFF51': 'q',
'\u024B': 'q',
'\uA757': 'q',
'\uA759': 'q',
'\u24E1': 'r',
'\uFF52': 'r',
'\u0155': 'r',
'\u1E59': 'r',
'\u0159': 'r',
'\u0211': 'r',
'\u0213': 'r',
'\u1E5B': 'r',
'\u1E5D': 'r',
'\u0157': 'r',
'\u1E5F': 'r',
'\u024D': 'r',
'\u027D': 'r',
'\uA75B': 'r',
'\uA7A7': 'r',
'\uA783': 'r',
'\u24E2': 's',
'\uFF53': 's',
'\u00DF': 's',
'\u015B': 's',
'\u1E65': 's',
'\u015D': 's',
'\u1E61': 's',
'\u0161': 's',
'\u1E67': 's',
'\u1E63': 's',
'\u1E69': 's',
'\u0219': 's',
'\u015F': 's',
'\u023F': 's',
'\uA7A9': 's',
'\uA785': 's',
'\u1E9B': 's',
'\u24E3': 't',
'\uFF54': 't',
'\u1E6B': 't',
'\u1E97': 't',
'\u0165': 't',
'\u1E6D': 't',
'\u021B': 't',
'\u0163': 't',
'\u1E71': 't',
'\u1E6F': 't',
'\u0167': 't',
'\u01AD': 't',
'\u0288': 't',
'\u2C66': 't',
'\uA787': 't',
'\uA729': 'tz',
'\u24E4': 'u',
'\uFF55': 'u',
'\u00F9': 'u',
'\u00FA': 'u',
'\u00FB': 'u',
'\u0169': 'u',
'\u1E79': 'u',
'\u016B': 'u',
'\u1E7B': 'u',
'\u016D': 'u',
'\u00FC': 'u',
'\u01DC': 'u',
'\u01D8': 'u',
'\u01D6': 'u',
'\u01DA': 'u',
'\u1EE7': 'u',
'\u016F': 'u',
'\u0171': 'u',
'\u01D4': 'u',
'\u0215': 'u',
'\u0217': 'u',
'\u01B0': 'u',
'\u1EEB': 'u',
'\u1EE9': 'u',
'\u1EEF': 'u',
'\u1EED': 'u',
'\u1EF1': 'u',
'\u1EE5': 'u',
'\u1E73': 'u',
'\u0173': 'u',
'\u1E77': 'u',
'\u1E75': 'u',
'\u0289': 'u',
'\u24E5': 'v',
'\uFF56': 'v',
'\u1E7D': 'v',
'\u1E7F': 'v',
'\u028B': 'v',
'\uA75F': 'v',
'\u028C': 'v',
'\uA761': 'vy',
'\u24E6': 'w',
'\uFF57': 'w',
'\u1E81': 'w',
'\u1E83': 'w',
'\u0175': 'w',
'\u1E87': 'w',
'\u1E85': 'w',
'\u1E98': 'w',
'\u1E89': 'w',
'\u2C73': 'w',
'\u24E7': 'x',
'\uFF58': 'x',
'\u1E8B': 'x',
'\u1E8D': 'x',
'\u24E8': 'y',
'\uFF59': 'y',
'\u1EF3': 'y',
'\u00FD': 'y',
'\u0177': 'y',
'\u1EF9': 'y',
'\u0233': 'y',
'\u1E8F': 'y',
'\u00FF': 'y',
'\u1EF7': 'y',
'\u1E99': 'y',
'\u1EF5': 'y',
'\u01B4': 'y',
'\u024F': 'y',
'\u1EFF': 'y',
'\u24E9': 'z',
'\uFF5A': 'z',
'\u017A': 'z',
'\u1E91': 'z',
'\u017C': 'z',
'\u017E': 'z',
'\u1E93': 'z',
'\u1E95': 'z',
'\u01B6': 'z',
'\u0225': 'z',
'\u0240': 'z',
'\u2C6C': 'z',
'\uA763': 'z',
'\u0386': '\u0391',
'\u0388': '\u0395',
'\u0389': '\u0397',
'\u038A': '\u0399',
'\u03AA': '\u0399',
'\u038C': '\u039F',
'\u038E': '\u03A5',
'\u03AB': '\u03A5',
'\u038F': '\u03A9',
'\u03AC': '\u03B1',
'\u03AD': '\u03B5',
'\u03AE': '\u03B7',
'\u03AF': '\u03B9',
'\u03CA': '\u03B9',
'\u0390': '\u03B9',
'\u03CC': '\u03BF',
'\u03CD': '\u03C5',
'\u03CB': '\u03C5',
'\u03B0': '\u03C5',
'\u03CE': '\u03C9',
'\u03C2': '\u03C3',
'\u2019': '\''
};
return diacritics;
});
S2.define('select2/data/base',[
'../utils'
], function (Utils) {
function BaseAdapter ($element, options) {
BaseAdapter.__super__.constructor.call(this);
}
Utils.Extend(BaseAdapter, Utils.Observable);
BaseAdapter.prototype.current = function (callback) {
throw new Error('The `current` method must be defined in child classes.');
};
BaseAdapter.prototype.query = function (params, callback) {
throw new Error('The `query` method must be defined in child classes.');
};
BaseAdapter.prototype.bind = function (container, $container) {
// Can be implemented in subclasses
};
BaseAdapter.prototype.destroy = function () {
// Can be implemented in subclasses
};
BaseAdapter.prototype.generateResultId = function (container, data) {
var id = container.id + '-result-';
id += Utils.generateChars(4);
if (data.id != null) {
id += '-' + data.id.toString();
} else {
id += '-' + Utils.generateChars(4);
}
return id;
};
return BaseAdapter;
});
S2.define('select2/data/select',[
'./base',
'../utils',
'jquery'
], function (BaseAdapter, Utils, $) {
function SelectAdapter ($element, options) {
this.$element = $element;
this.options = options;
SelectAdapter.__super__.constructor.call(this);
}
Utils.Extend(SelectAdapter, BaseAdapter);
SelectAdapter.prototype.current = function (callback) {
var data = [];
var self = this;
this.$element.find(':selected').each(function () {
var $option = $(this);
var option = self.item($option);
data.push(option);
});
callback(data);
};
SelectAdapter.prototype.select = function (data) {
var self = this;
data.selected = true;
// If data.element is a DOM node, use it instead
if ($(data.element).is('option')) {
data.element.selected = true;
this.$element.trigger('input').trigger('change');
return;
}
if (this.$element.prop('multiple')) {
this.current(function (currentData) {
var val = [];
data = [data];
data.push.apply(data, currentData);
for (var d = 0; d < data.length; d++) {
var id = data[d].id;
if ($.inArray(id, val) === -1) {
val.push(id);
}
}
self.$element.val(val);
self.$element.trigger('input').trigger('change');
});
} else {
var val = data.id;
this.$element.val(val);
this.$element.trigger('input').trigger('change');
}
};
SelectAdapter.prototype.unselect = function (data) {
var self = this;
if (!this.$element.prop('multiple')) {
return;
}
data.selected = false;
if ($(data.element).is('option')) {
data.element.selected = false;
this.$element.trigger('input').trigger('change');
return;
}
this.current(function (currentData) {
var val = [];
for (var d = 0; d < currentData.length; d++) {
var id = currentData[d].id;
if (id !== data.id && $.inArray(id, val) === -1) {
val.push(id);
}
}
self.$element.val(val);
self.$element.trigger('input').trigger('change');
});
};
SelectAdapter.prototype.bind = function (container, $container) {
var self = this;
this.container = container;
container.on('select', function (params) {
self.select(params.data);
});
container.on('unselect', function (params) {
self.unselect(params.data);
});
};
SelectAdapter.prototype.destroy = function () {
// Remove anything added to child elements
this.$element.find('*').each(function () {
// Remove any custom data set by Select2
Utils.RemoveData(this);
});
};
SelectAdapter.prototype.query = function (params, callback) {
var data = [];
var self = this;
var $options = this.$element.children();
$options.each(function () {
var $option = $(this);
if (!$option.is('option') && !$option.is('optgroup')) {
return;
}
var option = self.item($option);
var matches = self.matches(params, option);
if (matches !== null) {
data.push(matches);
}
});
callback({
results: data
});
};
SelectAdapter.prototype.addOptions = function ($options) {
Utils.appendMany(this.$element, $options);
};
SelectAdapter.prototype.option = function (data) {
var option;
if (data.children) {
option = document.createElement('optgroup');
option.label = data.text;
} else {
option = document.createElement('option');
if (option.textContent !== undefined) {
option.textContent = data.text;
} else {
option.innerText = data.text;
}
}
if (data.id !== undefined) {
option.value = data.id;
}
if (data.disabled) {
option.disabled = true;
}
if (data.selected) {
option.selected = true;
}
if (data.title) {
option.title = data.title;
}
var $option = $(option);
var normalizedData = this._normalizeItem(data);
normalizedData.element = option;
// Override the option's data with the combined data
Utils.StoreData(option, 'data', normalizedData);
return $option;
};
SelectAdapter.prototype.item = function ($option) {
var data = {};
data = Utils.GetData($option[0], 'data');
if (data != null) {
return data;
}
if ($option.is('option')) {
data = {
id: $option.val(),
text: $option.text(),
disabled: $option.prop('disabled'),
selected: $option.prop('selected'),
title: $option.prop('title')
};
} else if ($option.is('optgroup')) {
data = {
text: $option.prop('label'),
children: [],
title: $option.prop('title')
};
var $children = $option.children('option');
var children = [];
for (var c = 0; c < $children.length; c++) {
var $child = $($children[c]);
var child = this.item($child);
children.push(child);
}
data.children = children;
}
data = this._normalizeItem(data);
data.element = $option[0];
Utils.StoreData($option[0], 'data', data);
return data;
};
SelectAdapter.prototype._normalizeItem = function (item) {
if (item !== Object(item)) {
item = {
id: item,
text: item
};
}
item = $.extend({}, {
text: ''
}, item);
var defaults = {
selected: false,
disabled: false
};
if (item.id != null) {
item.id = item.id.toString();
}
if (item.text != null) {
item.text = item.text.toString();
}
if (item._resultId == null && item.id && this.container != null) {
item._resultId = this.generateResultId(this.container, item);
}
return $.extend({}, defaults, item);
};
SelectAdapter.prototype.matches = function (params, data) {
var matcher = this.options.get('matcher');
return matcher(params, data);
};
return SelectAdapter;
});
S2.define('select2/data/array',[
'./select',
'../utils',
'jquery'
], function (SelectAdapter, Utils, $) {
function ArrayAdapter ($element, options) {
this._dataToConvert = options.get('data') || [];
ArrayAdapter.__super__.constructor.call(this, $element, options);
}
Utils.Extend(ArrayAdapter, SelectAdapter);
ArrayAdapter.prototype.bind = function (container, $container) {
ArrayAdapter.__super__.bind.call(this, container, $container);
this.addOptions(this.convertToOptions(this._dataToConvert));
};
ArrayAdapter.prototype.select = function (data) {
var $option = this.$element.find('option').filter(function (i, elm) {
return elm.value == data.id.toString();
});
if ($option.length === 0) {
$option = this.option(data);
this.addOptions($option);
}
ArrayAdapter.__super__.select.call(this, data);
};
ArrayAdapter.prototype.convertToOptions = function (data) {
var self = this;
var $existing = this.$element.find('option');
var existingIds = $existing.map(function () {
return self.item($(this)).id;
}).get();
var $options = [];
// Filter out all items except for the one passed in the argument
function onlyItem (item) {
return function () {
return $(this).val() == item.id;
};
}
for (var d = 0; d < data.length; d++) {
var item = this._normalizeItem(data[d]);
// Skip items which were pre-loaded, only merge the data
if ($.inArray(item.id, existingIds) >= 0) {
var $existingOption = $existing.filter(onlyItem(item));
var existingData = this.item($existingOption);
var newData = $.extend(true, {}, item, existingData);
var $newOption = this.option(newData);
$existingOption.replaceWith($newOption);
continue;
}
var $option = this.option(item);
if (item.children) {
var $children = this.convertToOptions(item.children);
Utils.appendMany($option, $children);
}
$options.push($option);
}
return $options;
};
return ArrayAdapter;
});
S2.define('select2/data/ajax',[
'./array',
'../utils',
'jquery'
], function (ArrayAdapter, Utils, $) {
function AjaxAdapter ($element, options) {
this.ajaxOptions = this._applyDefaults(options.get('ajax'));
if (this.ajaxOptions.processResults != null) {
this.processResults = this.ajaxOptions.processResults;
}
AjaxAdapter.__super__.constructor.call(this, $element, options);
}
Utils.Extend(AjaxAdapter, ArrayAdapter);
AjaxAdapter.prototype._applyDefaults = function (options) {
var defaults = {
data: function (params) {
return $.extend({}, params, {
q: params.term
});
},
transport: function (params, success, failure) {
var $request = $.ajax(params);
$request.then(success);
$request.fail(failure);
return $request;
}
};
return $.extend({}, defaults, options, true);
};
AjaxAdapter.prototype.processResults = function (results) {
return results;
};
AjaxAdapter.prototype.query = function (params, callback) {
var matches = [];
var self = this;
if (this._request != null) {
// JSONP requests cannot always be aborted
if ($.isFunction(this._request.abort)) {
this._request.abort();
}
this._request = null;
}
var options = $.extend({
type: 'GET'
}, this.ajaxOptions);
if (typeof options.url === 'function') {
options.url = options.url.call(this.$element, params);
}
if (typeof options.data === 'function') {
options.data = options.data.call(this.$element, params);
}
function request () {
var $request = options.transport(options, function (data) {
var results = self.processResults(data, params);
if (self.options.get('debug') && window.console && console.error) {
// Check to make sure that the response included a `results` key.
if (!results || !results.results || !$.isArray(results.results)) {
console.error(
'Select2: The AJAX results did not return an array in the ' +
'`results` key of the response.'
);
}
}
callback(results);
}, function () {
// Attempt to detect if a request was aborted
// Only works if the transport exposes a status property
if ('status' in $request &&
($request.status === 0 || $request.status === '0')) {
return;
}
self.trigger('results:message', {
message: 'errorLoading'
});
});
self._request = $request;
}
if (this.ajaxOptions.delay && params.term != null) {
if (this._queryTimeout) {
window.clearTimeout(this._queryTimeout);
}
this._queryTimeout = window.setTimeout(request, this.ajaxOptions.delay);
} else {
request();
}
};
return AjaxAdapter;
});
S2.define('select2/data/tags',[
'jquery'
], function ($) {
function Tags (decorated, $element, options) {
var tags = options.get('tags');
var createTag = options.get('createTag');
if (createTag !== undefined) {
this.createTag = createTag;
}
var insertTag = options.get('insertTag');
if (insertTag !== undefined) {
this.insertTag = insertTag;
}
decorated.call(this, $element, options);
if ($.isArray(tags)) {
for (var t = 0; t < tags.length; t++) {
var tag = tags[t];
var item = this._normalizeItem(tag);
var $option = this.option(item);
this.$element.append($option);
}
}
}
Tags.prototype.query = function (decorated, params, callback) {
var self = this;
this._removeOldTags();
if (params.term == null || params.page != null) {
decorated.call(this, params, callback);
return;
}
function wrapper (obj, child) {
var data = obj.results;
for (var i = 0; i < data.length; i++) {
var option = data[i];
var checkChildren = (
option.children != null &&
!wrapper({
results: option.children
}, true)
);
var optionText = (option.text || '').toUpperCase();
var paramsTerm = (params.term || '').toUpperCase();
var checkText = optionText === paramsTerm;
if (checkText || checkChildren) {
if (child) {
return false;
}
obj.data = data;
callback(obj);
return;
}
}
if (child) {
return true;
}
var tag = self.createTag(params);
if (tag != null) {
var $option = self.option(tag);
$option.attr('data-select2-tag', true);
self.addOptions([$option]);
self.insertTag(data, tag);
}
obj.results = data;
callback(obj);
}
decorated.call(this, params, wrapper);
};
Tags.prototype.createTag = function (decorated, params) {
var term = $.trim(params.term);
if (term === '') {
return null;
}
return {
id: term,
text: term
};
};
Tags.prototype.insertTag = function (_, data, tag) {
data.unshift(tag);
};
Tags.prototype._removeOldTags = function (_) {
var $options = this.$element.find('option[data-select2-tag]');
$options.each(function () {
if (this.selected) {
return;
}
$(this).remove();
});
};
return Tags;
});
S2.define('select2/data/tokenizer',[
'jquery'
], function ($) {
function Tokenizer (decorated, $element, options) {
var tokenizer = options.get('tokenizer');
if (tokenizer !== undefined) {
this.tokenizer = tokenizer;
}
decorated.call(this, $element, options);
}
Tokenizer.prototype.bind = function (decorated, container, $container) {
decorated.call(this, container, $container);
this.$search = container.dropdown.$search || container.selection.$search ||
$container.find('.select2-search__field');
};
Tokenizer.prototype.query = function (decorated, params, callback) {
var self = this;
function createAndSelect (data) {
// Normalize the data object so we can use it for checks
var item = self._normalizeItem(data);
// Check if the data object already exists as a tag
// Select it if it doesn't
var $existingOptions = self.$element.find('option').filter(function () {
return $(this).val() === item.id;
});
// If an existing option wasn't found for it, create the option
if (!$existingOptions.length) {
var $option = self.option(item);
$option.attr('data-select2-tag', true);
self._removeOldTags();
self.addOptions([$option]);
}
// Select the item, now that we know there is an option for it
select(item);
}
function select (data) {
self.trigger('select', {
data: data
});
}
params.term = params.term || '';
var tokenData = this.tokenizer(params, this.options, createAndSelect);
if (tokenData.term !== params.term) {
// Replace the search term if we have the search box
if (this.$search.length) {
this.$search.val(tokenData.term);
this.$search.trigger('focus');
}
params.term = tokenData.term;
}
decorated.call(this, params, callback);
};
Tokenizer.prototype.tokenizer = function (_, params, options, callback) {
var separators = options.get('tokenSeparators') || [];
var term = params.term;
var i = 0;
var createTag = this.createTag || function (params) {
return {
id: params.term,
text: params.term
};
};
while (i < term.length) {
var termChar = term[i];
if ($.inArray(termChar, separators) === -1) {
i++;
continue;
}
var part = term.substr(0, i);
var partParams = $.extend({}, params, {
term: part
});
var data = createTag(partParams);
if (data == null) {
i++;
continue;
}
callback(data);
// Reset the term to not include the tokenized portion
term = term.substr(i + 1) || '';
i = 0;
}
return {
term: term
};
};
return Tokenizer;
});
S2.define('select2/data/minimumInputLength',[
], function () {
function MinimumInputLength (decorated, $e, options) {
this.minimumInputLength = options.get('minimumInputLength');
decorated.call(this, $e, options);
}
MinimumInputLength.prototype.query = function (decorated, params, callback) {
params.term = params.term || '';
if (params.term.length < this.minimumInputLength) {
this.trigger('results:message', {
message: 'inputTooShort',
args: {
minimum: this.minimumInputLength,
input: params.term,
params: params
}
});
return;
}
decorated.call(this, params, callback);
};
return MinimumInputLength;
});
S2.define('select2/data/maximumInputLength',[
], function () {
function MaximumInputLength (decorated, $e, options) {
this.maximumInputLength = options.get('maximumInputLength');
decorated.call(this, $e, options);
}
MaximumInputLength.prototype.query = function (decorated, params, callback) {
params.term = params.term || '';
if (this.maximumInputLength > 0 &&
params.term.length > this.maximumInputLength) {
this.trigger('results:message', {
message: 'inputTooLong',
args: {
maximum: this.maximumInputLength,
input: params.term,
params: params
}
});
return;
}
decorated.call(this, params, callback);
};
return MaximumInputLength;
});
S2.define('select2/data/maximumSelectionLength',[
], function (){
function MaximumSelectionLength (decorated, $e, options) {
this.maximumSelectionLength = options.get('maximumSelectionLength');
decorated.call(this, $e, options);
}
MaximumSelectionLength.prototype.bind =
function (decorated, container, $container) {
var self = this;
decorated.call(this, container, $container);
container.on('select', function () {
self._checkIfMaximumSelected();
});
};
MaximumSelectionLength.prototype.query =
function (decorated, params, callback) {
var self = this;
this._checkIfMaximumSelected(function () {
decorated.call(self, params, callback);
});
};
MaximumSelectionLength.prototype._checkIfMaximumSelected =
function (_, successCallback) {
var self = this;
this.current(function (currentData) {
var count = currentData != null ? currentData.length : 0;
if (self.maximumSelectionLength > 0 &&
count >= self.maximumSelectionLength) {
self.trigger('results:message', {
message: 'maximumSelected',
args: {
maximum: self.maximumSelectionLength
}
});
return;
}
if (successCallback) {
successCallback();
}
});
};
return MaximumSelectionLength;
});
S2.define('select2/dropdown',[
'jquery',
'./utils'
], function ($, Utils) {
function Dropdown ($element, options) {
this.$element = $element;
this.options = options;
Dropdown.__super__.constructor.call(this);
}
Utils.Extend(Dropdown, Utils.Observable);
Dropdown.prototype.render = function () {
var $dropdown = $(
'<span class="select2-dropdown">' +
'<span class="select2-results"></span>' +
'</span>'
);
$dropdown.attr('dir', this.options.get('dir'));
this.$dropdown = $dropdown;
return $dropdown;
};
Dropdown.prototype.bind = function () {
// Should be implemented in subclasses
};
Dropdown.prototype.position = function ($dropdown, $container) {
// Should be implemented in subclasses
};
Dropdown.prototype.destroy = function () {
// Remove the dropdown from the DOM
this.$dropdown.remove();
};
return Dropdown;
});
S2.define('select2/dropdown/search',[
'jquery',
'../utils'
], function ($, Utils) {
function Search () { }
Search.prototype.render = function (decorated) {
var $rendered = decorated.call(this);
var $search = $(
'<span class="select2-search select2-search--dropdown">' +
'<input class="select2-search__field" type="search" tabindex="-1"' +
' autocomplete="off" autocorrect="off" autocapitalize="none"' +
' spellcheck="false" role="searchbox" aria-autocomplete="list" />' +
'</span>'
);
this.$searchContainer = $search;
this.$search = $search.find('input');
$rendered.prepend($search);
return $rendered;
};
Search.prototype.bind = function (decorated, container, $container) {
var self = this;
var resultsId = container.id + '-results';
decorated.call(this, container, $container);
this.$search.on('keydown', function (evt) {
self.trigger('keypress', evt);
self._keyUpPrevented = evt.isDefaultPrevented();
});
// Workaround for browsers which do not support the `input` event
// This will prevent double-triggering of events for browsers which support
// both the `keyup` and `input` events.
this.$search.on('input', function (evt) {
// Unbind the duplicated `keyup` event
$(this).off('keyup');
});
this.$search.on('keyup input', function (evt) {
self.handleSearch(evt);
});
container.on('open', function () {
self.$search.attr('tabindex', 0);
self.$search.attr('aria-controls', resultsId);
self.$search.trigger('focus');
window.setTimeout(function () {
self.$search.trigger('focus');
}, 0);
});
container.on('close', function () {
self.$search.attr('tabindex', -1);
self.$search.removeAttr('aria-controls');
self.$search.removeAttr('aria-activedescendant');
self.$search.val('');
self.$search.trigger('blur');
});
container.on('focus', function () {
if (!container.isOpen()) {
self.$search.trigger('focus');
}
});
container.on('results:all', function (params) {
if (params.query.term == null || params.query.term === '') {
var showSearch = self.showSearch(params);
if (showSearch) {
self.$searchContainer.removeClass('select2-search--hide');
} else {
self.$searchContainer.addClass('select2-search--hide');
}
}
});
container.on('results:focus', function (params) {
if (params.data._resultId) {
self.$search.attr('aria-activedescendant', params.data._resultId);
} else {
self.$search.removeAttr('aria-activedescendant');
}
});
};
Search.prototype.handleSearch = function (evt) {
if (!this._keyUpPrevented) {
var input = this.$search.val();
this.trigger('query', {
term: input
});
}
this._keyUpPrevented = false;
};
Search.prototype.showSearch = function (_, params) {
return true;
};
return Search;
});
S2.define('select2/dropdown/hidePlaceholder',[
], function () {
function HidePlaceholder (decorated, $element, options, dataAdapter) {
this.placeholder = this.normalizePlaceholder(options.get('placeholder'));
decorated.call(this, $element, options, dataAdapter);
}
HidePlaceholder.prototype.append = function (decorated, data) {
data.results = this.removePlaceholder(data.results);
decorated.call(this, data);
};
HidePlaceholder.prototype.normalizePlaceholder = function (_, placeholder) {
if (typeof placeholder === 'string') {
placeholder = {
id: '',
text: placeholder
};
}
return placeholder;
};
HidePlaceholder.prototype.removePlaceholder = function (_, data) {
var modifiedData = data.slice(0);
for (var d = data.length - 1; d >= 0; d--) {
var item = data[d];
if (this.placeholder.id === item.id) {
modifiedData.splice(d, 1);
}
}
return modifiedData;
};
return HidePlaceholder;
});
S2.define('select2/dropdown/infiniteScroll',[
'jquery'
], function ($) {
function InfiniteScroll (decorated, $element, options, dataAdapter) {
this.lastParams = {};
decorated.call(this, $element, options, dataAdapter);
this.$loadingMore = this.createLoadingMore();
this.loading = false;
}
InfiniteScroll.prototype.append = function (decorated, data) {
this.$loadingMore.remove();
this.loading = false;
decorated.call(this, data);
if (this.showLoadingMore(data)) {
this.$results.append(this.$loadingMore);
this.loadMoreIfNeeded();
}
};
InfiniteScroll.prototype.bind = function (decorated, container, $container) {
var self = this;
decorated.call(this, container, $container);
container.on('query', function (params) {
self.lastParams = params;
self.loading = true;
});
container.on('query:append', function (params) {
self.lastParams = params;
self.loading = true;
});
this.$results.on('scroll', this.loadMoreIfNeeded.bind(this));
};
InfiniteScroll.prototype.loadMoreIfNeeded = function () {
var isLoadMoreVisible = $.contains(
document.documentElement,
this.$loadingMore[0]
);
if (this.loading || !isLoadMoreVisible) {
return;
}
var currentOffset = this.$results.offset().top +
this.$results.outerHeight(false);
var loadingMoreOffset = this.$loadingMore.offset().top +
this.$loadingMore.outerHeight(false);
if (currentOffset + 50 >= loadingMoreOffset) {
this.loadMore();
}
};
InfiniteScroll.prototype.loadMore = function () {
this.loading = true;
var params = $.extend({}, {page: 1}, this.lastParams);
params.page++;
this.trigger('query:append', params);
};
InfiniteScroll.prototype.showLoadingMore = function (_, data) {
return data.pagination && data.pagination.more;
};
InfiniteScroll.prototype.createLoadingMore = function () {
var $option = $(
'<li ' +
'class="select2-results__option select2-results__option--load-more"' +
'role="option" aria-disabled="true"></li>'
);
var message = this.options.get('translations').get('loadingMore');
$option.html(message(this.lastParams));
return $option;
};
return InfiniteScroll;
});
S2.define('select2/dropdown/attachBody',[
'jquery',
'../utils'
], function ($, Utils) {
function AttachBody (decorated, $element, options) {
this.$dropdownParent = $(options.get('dropdownParent') || document.body);
decorated.call(this, $element, options);
}
AttachBody.prototype.bind = function (decorated, container, $container) {
var self = this;
decorated.call(this, container, $container);
container.on('open', function () {
self._showDropdown();
self._attachPositioningHandler(container);
// Must bind after the results handlers to ensure correct sizing
self._bindContainerResultHandlers(container);
});
container.on('close', function () {
self._hideDropdown();
self._detachPositioningHandler(container);
});
this.$dropdownContainer.on('mousedown', function (evt) {
evt.stopPropagation();
});
};
AttachBody.prototype.destroy = function (decorated) {
decorated.call(this);
this.$dropdownContainer.remove();
};
AttachBody.prototype.position = function (decorated, $dropdown, $container) {
// Clone all of the container classes
$dropdown.attr('class', $container.attr('class'));
$dropdown.removeClass('select2');
$dropdown.addClass('select2-container--open');
$dropdown.css({
position: 'absolute',
top: -999999
});
this.$container = $container;
};
AttachBody.prototype.render = function (decorated) {
var $container = $('<span></span>');
var $dropdown = decorated.call(this);
$container.append($dropdown);
this.$dropdownContainer = $container;
return $container;
};
AttachBody.prototype._hideDropdown = function (decorated) {
this.$dropdownContainer.detach();
};
AttachBody.prototype._bindContainerResultHandlers =
function (decorated, container) {
// These should only be bound once
if (this._containerResultsHandlersBound) {
return;
}
var self = this;
container.on('results:all', function () {
self._positionDropdown();
self._resizeDropdown();
});
container.on('results:append', function () {
self._positionDropdown();
self._resizeDropdown();
});
container.on('results:message', function () {
self._positionDropdown();
self._resizeDropdown();
});
container.on('select', function () {
self._positionDropdown();
self._resizeDropdown();
});
container.on('unselect', function () {
self._positionDropdown();
self._resizeDropdown();
});
this._containerResultsHandlersBound = true;
};
AttachBody.prototype._attachPositioningHandler =
function (decorated, container) {
var self = this;
var scrollEvent = 'scroll.select2.' + container.id;
var resizeEvent = 'resize.select2.' + container.id;
var orientationEvent = 'orientationchange.select2.' + container.id;
var $watchers = this.$container.parents().filter(Utils.hasScroll);
$watchers.each(function () {
Utils.StoreData(this, 'select2-scroll-position', {
x: $(this).scrollLeft(),
y: $(this).scrollTop()
});
});
$watchers.on(scrollEvent, function (ev) {
var position = Utils.GetData(this, 'select2-scroll-position');
$(this).scrollTop(position.y);
});
$(window).on(scrollEvent + ' ' + resizeEvent + ' ' + orientationEvent,
function (e) {
self._positionDropdown();
self._resizeDropdown();
});
};
AttachBody.prototype._detachPositioningHandler =
function (decorated, container) {
var scrollEvent = 'scroll.select2.' + container.id;
var resizeEvent = 'resize.select2.' + container.id;
var orientationEvent = 'orientationchange.select2.' + container.id;
var $watchers = this.$container.parents().filter(Utils.hasScroll);
$watchers.off(scrollEvent);
$(window).off(scrollEvent + ' ' + resizeEvent + ' ' + orientationEvent);
};
AttachBody.prototype._positionDropdown = function () {
var $window = $(window);
var isCurrentlyAbove = this.$dropdown.hasClass('select2-dropdown--above');
var isCurrentlyBelow = this.$dropdown.hasClass('select2-dropdown--below');
var newDirection = null;
var offset = this.$container.offset();
offset.bottom = offset.top + this.$container.outerHeight(false);
var container = {
height: this.$container.outerHeight(false)
};
container.top = offset.top;
container.bottom = offset.top + container.height;
var dropdown = {
height: this.$dropdown.outerHeight(false)
};
var viewport = {
top: $window.scrollTop(),
bottom: $window.scrollTop() + $window.height()
};
var enoughRoomAbove = viewport.top < (offset.top - dropdown.height);
var enoughRoomBelow = viewport.bottom > (offset.bottom + dropdown.height);
var css = {
left: offset.left,
top: container.bottom
};
// Determine what the parent element is to use for calculating the offset
var $offsetParent = this.$dropdownParent;
// For statically positioned elements, we need to get the element
// that is determining the offset
if ($offsetParent.css('position') === 'static') {
$offsetParent = $offsetParent.offsetParent();
}
var parentOffset = {
top: 0,
left: 0
};
if (
$.contains(document.body, $offsetParent[0]) ||
$offsetParent[0].isConnected
) {
parentOffset = $offsetParent.offset();
}
css.top -= parentOffset.top;
css.left -= parentOffset.left;
if (!isCurrentlyAbove && !isCurrentlyBelow) {
newDirection = 'below';
}
if (!enoughRoomBelow && enoughRoomAbove && !isCurrentlyAbove) {
newDirection = 'above';
} else if (!enoughRoomAbove && enoughRoomBelow && isCurrentlyAbove) {
newDirection = 'below';
}
if (newDirection == 'above' ||
(isCurrentlyAbove && newDirection !== 'below')) {
css.top = container.top - parentOffset.top - dropdown.height;
}
if (newDirection != null) {
this.$dropdown
.removeClass('select2-dropdown--below select2-dropdown--above')
.addClass('select2-dropdown--' + newDirection);
this.$container
.removeClass('select2-container--below select2-container--above')
.addClass('select2-container--' + newDirection);
}
this.$dropdownContainer.css(css);
};
AttachBody.prototype._resizeDropdown = function () {
var css = {
width: this.$container.outerWidth(false) + 'px'
};
if (this.options.get('dropdownAutoWidth')) {
css.minWidth = css.width;
css.position = 'relative';
css.width = 'auto';
}
this.$dropdown.css(css);
};
AttachBody.prototype._showDropdown = function (decorated) {
this.$dropdownContainer.appendTo(this.$dropdownParent);
this._positionDropdown();
this._resizeDropdown();
};
return AttachBody;
});
S2.define('select2/dropdown/minimumResultsForSearch',[
], function () {
function countResults (data) {
var count = 0;
for (var d = 0; d < data.length; d++) {
var item = data[d];
if (item.children) {
count += countResults(item.children);
} else {
count++;
}
}
return count;
}
function MinimumResultsForSearch (decorated, $element, options, dataAdapter) {
this.minimumResultsForSearch = options.get('minimumResultsForSearch');
if (this.minimumResultsForSearch < 0) {
this.minimumResultsForSearch = Infinity;
}
decorated.call(this, $element, options, dataAdapter);
}
MinimumResultsForSearch.prototype.showSearch = function (decorated, params) {
if (countResults(params.data.results) < this.minimumResultsForSearch) {
return false;
}
return decorated.call(this, params);
};
return MinimumResultsForSearch;
});
S2.define('select2/dropdown/selectOnClose',[
'../utils'
], function (Utils) {
function SelectOnClose () { }
SelectOnClose.prototype.bind = function (decorated, container, $container) {
var self = this;
decorated.call(this, container, $container);
container.on('close', function (params) {
self._handleSelectOnClose(params);
});
};
SelectOnClose.prototype._handleSelectOnClose = function (_, params) {
if (params && params.originalSelect2Event != null) {
var event = params.originalSelect2Event;
// Don't select an item if the close event was triggered from a select or
// unselect event
if (event._type === 'select' || event._type === 'unselect') {
return;
}
}
var $highlightedResults = this.getHighlightedResults();
// Only select highlighted results
if ($highlightedResults.length < 1) {
return;
}
var data = Utils.GetData($highlightedResults[0], 'data');
// Don't re-select already selected resulte
if (
(data.element != null && data.element.selected) ||
(data.element == null && data.selected)
) {
return;
}
this.trigger('select', {
data: data
});
};
return SelectOnClose;
});
S2.define('select2/dropdown/closeOnSelect',[
], function () {
function CloseOnSelect () { }
CloseOnSelect.prototype.bind = function (decorated, container, $container) {
var self = this;
decorated.call(this, container, $container);
container.on('select', function (evt) {
self._selectTriggered(evt);
});
container.on('unselect', function (evt) {
self._selectTriggered(evt);
});
};
CloseOnSelect.prototype._selectTriggered = function (_, evt) {
var originalEvent = evt.originalEvent;
// Don't close if the control key is being held
if (originalEvent && (originalEvent.ctrlKey || originalEvent.metaKey)) {
return;
}
this.trigger('close', {
originalEvent: originalEvent,
originalSelect2Event: evt
});
};
return CloseOnSelect;
});
S2.define('select2/i18n/en',[],function () {
// English
return {
errorLoading: function () {
return 'The results could not be loaded.';
},
inputTooLong: function (args) {
var overChars = args.input.length - args.maximum;
var message = 'Please delete ' + overChars + ' character';
if (overChars != 1) {
message += 's';
}
return message;
},
inputTooShort: function (args) {
var remainingChars = args.minimum - args.input.length;
var message = 'Please enter ' + remainingChars + ' or more characters';
return message;
},
loadingMore: function () {
return 'Loading more results…';
},
maximumSelected: function (args) {
var message = 'You can only select ' + args.maximum + ' item';
if (args.maximum != 1) {
message += 's';
}
return message;
},
noResults: function () {
return 'No results found';
},
searching: function () {
return 'Searching…';
},
removeAllItems: function () {
return 'Remove all items';
}
};
});
S2.define('select2/defaults',[
'jquery',
'require',
'./results',
'./selection/single',
'./selection/multiple',
'./selection/placeholder',
'./selection/allowClear',
'./selection/search',
'./selection/eventRelay',
'./utils',
'./translation',
'./diacritics',
'./data/select',
'./data/array',
'./data/ajax',
'./data/tags',
'./data/tokenizer',
'./data/minimumInputLength',
'./data/maximumInputLength',
'./data/maximumSelectionLength',
'./dropdown',
'./dropdown/search',
'./dropdown/hidePlaceholder',
'./dropdown/infiniteScroll',
'./dropdown/attachBody',
'./dropdown/minimumResultsForSearch',
'./dropdown/selectOnClose',
'./dropdown/closeOnSelect',
'./i18n/en'
], function ($, require,
ResultsList,
SingleSelection, MultipleSelection, Placeholder, AllowClear,
SelectionSearch, EventRelay,
Utils, Translation, DIACRITICS,
SelectData, ArrayData, AjaxData, Tags, Tokenizer,
MinimumInputLength, MaximumInputLength, MaximumSelectionLength,
Dropdown, DropdownSearch, HidePlaceholder, InfiniteScroll,
AttachBody, MinimumResultsForSearch, SelectOnClose, CloseOnSelect,
EnglishTranslation) {
function Defaults () {
this.reset();
}
Defaults.prototype.apply = function (options) {
options = $.extend(true, {}, this.defaults, options);
if (options.dataAdapter == null) {
if (options.ajax != null) {
options.dataAdapter = AjaxData;
} else if (options.data != null) {
options.dataAdapter = ArrayData;
} else {
options.dataAdapter = SelectData;
}
if (options.minimumInputLength > 0) {
options.dataAdapter = Utils.Decorate(
options.dataAdapter,
MinimumInputLength
);
}
if (options.maximumInputLength > 0) {
options.dataAdapter = Utils.Decorate(
options.dataAdapter,
MaximumInputLength
);
}
if (options.maximumSelectionLength > 0) {
options.dataAdapter = Utils.Decorate(
options.dataAdapter,
MaximumSelectionLength
);
}
if (options.tags) {
options.dataAdapter = Utils.Decorate(options.dataAdapter, Tags);
}
if (options.tokenSeparators != null || options.tokenizer != null) {
options.dataAdapter = Utils.Decorate(
options.dataAdapter,
Tokenizer
);
}
if (options.query != null) {
var Query = require(options.amdBase + 'compat/query');
options.dataAdapter = Utils.Decorate(
options.dataAdapter,
Query
);
}
if (options.initSelection != null) {
var InitSelection = require(options.amdBase + 'compat/initSelection');
options.dataAdapter = Utils.Decorate(
options.dataAdapter,
InitSelection
);
}
}
if (options.resultsAdapter == null) {
options.resultsAdapter = ResultsList;
if (options.ajax != null) {
options.resultsAdapter = Utils.Decorate(
options.resultsAdapter,
InfiniteScroll
);
}
if (options.placeholder != null) {
options.resultsAdapter = Utils.Decorate(
options.resultsAdapter,
HidePlaceholder
);
}
if (options.selectOnClose) {
options.resultsAdapter = Utils.Decorate(
options.resultsAdapter,
SelectOnClose
);
}
}
if (options.dropdownAdapter == null) {
if (options.multiple) {
options.dropdownAdapter = Dropdown;
} else {
var SearchableDropdown = Utils.Decorate(Dropdown, DropdownSearch);
options.dropdownAdapter = SearchableDropdown;
}
if (options.minimumResultsForSearch !== 0) {
options.dropdownAdapter = Utils.Decorate(
options.dropdownAdapter,
MinimumResultsForSearch
);
}
if (options.closeOnSelect) {
options.dropdownAdapter = Utils.Decorate(
options.dropdownAdapter,
CloseOnSelect
);
}
if (
options.dropdownCssClass != null ||
options.dropdownCss != null ||
options.adaptDropdownCssClass != null
) {
var DropdownCSS = require(options.amdBase + 'compat/dropdownCss');
options.dropdownAdapter = Utils.Decorate(
options.dropdownAdapter,
DropdownCSS
);
}
options.dropdownAdapter = Utils.Decorate(
options.dropdownAdapter,
AttachBody
);
}
if (options.selectionAdapter == null) {
if (options.multiple) {
options.selectionAdapter = MultipleSelection;
} else {
options.selectionAdapter = SingleSelection;
}
// Add the placeholder mixin if a placeholder was specified
if (options.placeholder != null) {
options.selectionAdapter = Utils.Decorate(
options.selectionAdapter,
Placeholder
);
}
if (options.allowClear) {
options.selectionAdapter = Utils.Decorate(
options.selectionAdapter,
AllowClear
);
}
if (options.multiple) {
options.selectionAdapter = Utils.Decorate(
options.selectionAdapter,
SelectionSearch
);
}
if (
options.containerCssClass != null ||
options.containerCss != null ||
options.adaptContainerCssClass != null
) {
var ContainerCSS = require(options.amdBase + 'compat/containerCss');
options.selectionAdapter = Utils.Decorate(
options.selectionAdapter,
ContainerCSS
);
}
options.selectionAdapter = Utils.Decorate(
options.selectionAdapter,
EventRelay
);
}
// If the defaults were not previously applied from an element, it is
// possible for the language option to have not been resolved
options.language = this._resolveLanguage(options.language);
// Always fall back to English since it will always be complete
options.language.push('en');
var uniqueLanguages = [];
for (var l = 0; l < options.language.length; l++) {
var language = options.language[l];
if (uniqueLanguages.indexOf(language) === -1) {
uniqueLanguages.push(language);
}
}
options.language = uniqueLanguages;
options.translations = this._processTranslations(
options.language,
options.debug
);
return options;
};
Defaults.prototype.reset = function () {
function stripDiacritics (text) {
// Used 'uni range + named function' from http://jsperf.com/diacritics/18
function match(a) {
return DIACRITICS[a] || a;
}
return text.replace(/[^\u0000-\u007E]/g, match);
}
function matcher (params, data) {
// Always return the object if there is nothing to compare
if ($.trim(params.term) === '') {
return data;
}
// Do a recursive check for options with children
if (data.children && data.children.length > 0) {
// Clone the data object if there are children
// This is required as we modify the object to remove any non-matches
var match = $.extend(true, {}, data);
// Check each child of the option
for (var c = data.children.length - 1; c >= 0; c--) {
var child = data.children[c];
var matches = matcher(params, child);
// If there wasn't a match, remove the object in the array
if (matches == null) {
match.children.splice(c, 1);
}
}
// If any children matched, return the new object
if (match.children.length > 0) {
return match;
}
// If there were no matching children, check just the plain object
return matcher(params, match);
}
var original = stripDiacritics(data.text).toUpperCase();
var term = stripDiacritics(params.term).toUpperCase();
// Check if the text contains the term
if (original.indexOf(term) > -1) {
return data;
}
// If it doesn't contain the term, don't return anything
return null;
}
this.defaults = {
amdBase: './',
amdLanguageBase: './i18n/',
closeOnSelect: true,
debug: false,
dropdownAutoWidth: false,
escapeMarkup: Utils.escapeMarkup,
language: {},
matcher: matcher,
minimumInputLength: 0,
maximumInputLength: 0,
maximumSelectionLength: 0,
minimumResultsForSearch: 0,
selectOnClose: false,
scrollAfterSelect: false,
sorter: function (data) {
return data;
},
templateResult: function (result) {
return result.text;
},
templateSelection: function (selection) {
return selection.text;
},
theme: 'default',
width: 'resolve'
};
};
Defaults.prototype.applyFromElement = function (options, $element) {
var optionLanguage = options.language;
var defaultLanguage = this.defaults.language;
var elementLanguage = $element.prop('lang');
var parentLanguage = $element.closest('[lang]').prop('lang');
var languages = Array.prototype.concat.call(
this._resolveLanguage(elementLanguage),
this._resolveLanguage(optionLanguage),
this._resolveLanguage(defaultLanguage),
this._resolveLanguage(parentLanguage)
);
options.language = languages;
return options;
};
Defaults.prototype._resolveLanguage = function (language) {
if (!language) {
return [];
}
if ($.isEmptyObject(language)) {
return [];
}
if ($.isPlainObject(language)) {
return [language];
}
var languages;
if (!$.isArray(language)) {
languages = [language];
} else {
languages = language;
}
var resolvedLanguages = [];
for (var l = 0; l < languages.length; l++) {
resolvedLanguages.push(languages[l]);
if (typeof languages[l] === 'string' && languages[l].indexOf('-') > 0) {
// Extract the region information if it is included
var languageParts = languages[l].split('-');
var baseLanguage = languageParts[0];
resolvedLanguages.push(baseLanguage);
}
}
return resolvedLanguages;
};
Defaults.prototype._processTranslations = function (languages, debug) {
var translations = new Translation();
for (var l = 0; l < languages.length; l++) {
var languageData = new Translation();
var language = languages[l];
if (typeof language === 'string') {
try {
// Try to load it with the original name
languageData = Translation.loadPath(language);
} catch (e) {
try {
// If we couldn't load it, check if it wasn't the full path
language = this.defaults.amdLanguageBase + language;
languageData = Translation.loadPath(language);
} catch (ex) {
// The translation could not be loaded at all. Sometimes this is
// because of a configuration problem, other times this can be
// because of how Select2 helps load all possible translation files
if (debug && window.console && console.warn) {
console.warn(
'Select2: The language file for "' + language + '" could ' +
'not be automatically loaded. A fallback will be used instead.'
);
}
}
}
} else if ($.isPlainObject(language)) {
languageData = new Translation(language);
} else {
languageData = language;
}
translations.extend(languageData);
}
return translations;
};
Defaults.prototype.set = function (key, value) {
var camelKey = $.camelCase(key);
var data = {};
data[camelKey] = value;
var convertedData = Utils._convertData(data);
$.extend(true, this.defaults, convertedData);
};
var defaults = new Defaults();
return defaults;
});
S2.define('select2/options',[
'require',
'jquery',
'./defaults',
'./utils'
], function (require, $, Defaults, Utils) {
function Options (options, $element) {
this.options = options;
if ($element != null) {
this.fromElement($element);
}
if ($element != null) {
this.options = Defaults.applyFromElement(this.options, $element);
}
this.options = Defaults.apply(this.options);
if ($element && $element.is('input')) {
var InputCompat = require(this.get('amdBase') + 'compat/inputData');
this.options.dataAdapter = Utils.Decorate(
this.options.dataAdapter,
InputCompat
);
}
}
Options.prototype.fromElement = function ($e) {
var excludedData = ['select2'];
if (this.options.multiple == null) {
this.options.multiple = $e.prop('multiple');
}
if (this.options.disabled == null) {
this.options.disabled = $e.prop('disabled');
}
if (this.options.dir == null) {
if ($e.prop('dir')) {
this.options.dir = $e.prop('dir');
} else if ($e.closest('[dir]').prop('dir')) {
this.options.dir = $e.closest('[dir]').prop('dir');
} else {
this.options.dir = 'ltr';
}
}
$e.prop('disabled', this.options.disabled);
$e.prop('multiple', this.options.multiple);
if (Utils.GetData($e[0], 'select2Tags')) {
if (this.options.debug && window.console && console.warn) {
console.warn(
'Select2: The `data-select2-tags` attribute has been changed to ' +
'use the `data-data` and `data-tags="true"` attributes and will be ' +
'removed in future versions of Select2.'
);
}
Utils.StoreData($e[0], 'data', Utils.GetData($e[0], 'select2Tags'));
Utils.StoreData($e[0], 'tags', true);
}
if (Utils.GetData($e[0], 'ajaxUrl')) {
if (this.options.debug && window.console && console.warn) {
console.warn(
'Select2: The `data-ajax-url` attribute has been changed to ' +
'`data-ajax--url` and support for the old attribute will be removed' +
' in future versions of Select2.'
);
}
$e.attr('ajax--url', Utils.GetData($e[0], 'ajaxUrl'));
Utils.StoreData($e[0], 'ajax-Url', Utils.GetData($e[0], 'ajaxUrl'));
}
var dataset = {};
function upperCaseLetter(_, letter) {
return letter.toUpperCase();
}
// Pre-load all of the attributes which are prefixed with `data-`
for (var attr = 0; attr < $e[0].attributes.length; attr++) {
var attributeName = $e[0].attributes[attr].name;
var prefix = 'data-';
if (attributeName.substr(0, prefix.length) == prefix) {
// Get the contents of the attribute after `data-`
var dataName = attributeName.substring(prefix.length);
// Get the data contents from the consistent source
// This is more than likely the jQuery data helper
var dataValue = Utils.GetData($e[0], dataName);
// camelCase the attribute name to match the spec
var camelDataName = dataName.replace(/-([a-z])/g, upperCaseLetter);
// Store the data attribute contents into the dataset since
dataset[camelDataName] = dataValue;
}
}
// Prefer the element's `dataset` attribute if it exists
// jQuery 1.x does not correctly handle data attributes with multiple dashes
if ($.fn.jquery && $.fn.jquery.substr(0, 2) == '1.' && $e[0].dataset) {
dataset = $.extend(true, {}, $e[0].dataset, dataset);
}
// Prefer our internal data cache if it exists
var data = $.extend(true, {}, Utils.GetData($e[0]), dataset);
data = Utils._convertData(data);
for (var key in data) {
if ($.inArray(key, excludedData) > -1) {
continue;
}
if ($.isPlainObject(this.options[key])) {
$.extend(this.options[key], data[key]);
} else {
this.options[key] = data[key];
}
}
return this;
};
Options.prototype.get = function (key) {
return this.options[key];
};
Options.prototype.set = function (key, val) {
this.options[key] = val;
};
return Options;
});
S2.define('select2/core',[
'jquery',
'./options',
'./utils',
'./keys'
], function ($, Options, Utils, KEYS) {
var Select2 = function ($element, options) {
if (Utils.GetData($element[0], 'select2') != null) {
Utils.GetData($element[0], 'select2').destroy();
}
this.$element = $element;
this.id = this._generateId($element);
options = options || {};
this.options = new Options(options, $element);
Select2.__super__.constructor.call(this);
// Set up the tabindex
var tabindex = $element.attr('tabindex') || 0;
Utils.StoreData($element[0], 'old-tabindex', tabindex);
$element.attr('tabindex', '-1');
// Set up containers and adapters
var DataAdapter = this.options.get('dataAdapter');
this.dataAdapter = new DataAdapter($element, this.options);
var $container = this.render();
this._placeContainer($container);
var SelectionAdapter = this.options.get('selectionAdapter');
this.selection = new SelectionAdapter($element, this.options);
this.$selection = this.selection.render();
this.selection.position(this.$selection, $container);
var DropdownAdapter = this.options.get('dropdownAdapter');
this.dropdown = new DropdownAdapter($element, this.options);
this.$dropdown = this.dropdown.render();
this.dropdown.position(this.$dropdown, $container);
var ResultsAdapter = this.options.get('resultsAdapter');
this.results = new ResultsAdapter($element, this.options, this.dataAdapter);
this.$results = this.results.render();
this.results.position(this.$results, this.$dropdown);
// Bind events
var self = this;
// Bind the container to all of the adapters
this._bindAdapters();
// Register any DOM event handlers
this._registerDomEvents();
// Register any internal event handlers
this._registerDataEvents();
this._registerSelectionEvents();
this._registerDropdownEvents();
this._registerResultsEvents();
this._registerEvents();
// Set the initial state
this.dataAdapter.current(function (initialData) {
self.trigger('selection:update', {
data: initialData
});
});
// Hide the original select
$element.addClass('select2-hidden-accessible');
$element.attr('aria-hidden', 'true');
// Synchronize any monitored attributes
this._syncAttributes();
Utils.StoreData($element[0], 'select2', this);
// Ensure backwards compatibility with $element.data('select2').
$element.data('select2', this);
};
Utils.Extend(Select2, Utils.Observable);
Select2.prototype._generateId = function ($element) {
var id = '';
if ($element.attr('id') != null) {
id = $element.attr('id');
} else if ($element.attr('name') != null) {
id = $element.attr('name') + '-' + Utils.generateChars(2);
} else {
id = Utils.generateChars(4);
}
id = id.replace(/(:|\.|\[|\]|,)/g, '');
id = 'select2-' + id;
return id;
};
Select2.prototype._placeContainer = function ($container) {
$container.insertAfter(this.$element);
var width = this._resolveWidth(this.$element, this.options.get('width'));
if (width != null) {
$container.css('width', width);
}
};
Select2.prototype._resolveWidth = function ($element, method) {
var WIDTH = /^width:(([-+]?([0-9]*\.)?[0-9]+)(px|em|ex|%|in|cm|mm|pt|pc))/i;
if (method == 'resolve') {
var styleWidth = this._resolveWidth($element, 'style');
if (styleWidth != null) {
return styleWidth;
}
return this._resolveWidth($element, 'element');
}
if (method == 'element') {
var elementWidth = $element.outerWidth(false);
if (elementWidth <= 0) {
return 'auto';
}
return elementWidth + 'px';
}
if (method == 'style') {
var style = $element.attr('style');
if (typeof(style) !== 'string') {
return null;
}
var attrs = style.split(';');
for (var i = 0, l = attrs.length; i < l; i = i + 1) {
var attr = attrs[i].replace(/\s/g, '');
var matches = attr.match(WIDTH);
if (matches !== null && matches.length >= 1) {
return matches[1];
}
}
return null;
}
if (method == 'computedstyle') {
var computedStyle = window.getComputedStyle($element[0]);
return computedStyle.width;
}
return method;
};
Select2.prototype._bindAdapters = function () {
this.dataAdapter.bind(this, this.$container);
this.selection.bind(this, this.$container);
this.dropdown.bind(this, this.$container);
this.results.bind(this, this.$container);
};
Select2.prototype._registerDomEvents = function () {
var self = this;
this.$element.on('change.select2', function () {
self.dataAdapter.current(function (data) {
self.trigger('selection:update', {
data: data
});
});
});
this.$element.on('focus.select2', function (evt) {
self.trigger('focus', evt);
});
this._syncA = Utils.bind(this._syncAttributes, this);
this._syncS = Utils.bind(this._syncSubtree, this);
if (this.$element[0].attachEvent) {
this.$element[0].attachEvent('onpropertychange', this._syncA);
}
var observer = window.MutationObserver ||
window.WebKitMutationObserver ||
window.MozMutationObserver
;
if (observer != null) {
this._observer = new observer(function (mutations) {
self._syncA();
self._syncS(null, mutations);
});
this._observer.observe(this.$element[0], {
attributes: true,
childList: true,
subtree: false
});
} else if (this.$element[0].addEventListener) {
this.$element[0].addEventListener(
'DOMAttrModified',
self._syncA,
false
);
this.$element[0].addEventListener(
'DOMNodeInserted',
self._syncS,
false
);
this.$element[0].addEventListener(
'DOMNodeRemoved',
self._syncS,
false
);
}
};
Select2.prototype._registerDataEvents = function () {
var self = this;
this.dataAdapter.on('*', function (name, params) {
self.trigger(name, params);
});
};
Select2.prototype._registerSelectionEvents = function () {
var self = this;
var nonRelayEvents = ['toggle', 'focus'];
this.selection.on('toggle', function () {
self.toggleDropdown();
});
this.selection.on('focus', function (params) {
self.focus(params);
});
this.selection.on('*', function (name, params) {
if ($.inArray(name, nonRelayEvents) !== -1) {
return;
}
self.trigger(name, params);
});
};
Select2.prototype._registerDropdownEvents = function () {
var self = this;
this.dropdown.on('*', function (name, params) {
self.trigger(name, params);
});
};
Select2.prototype._registerResultsEvents = function () {
var self = this;
this.results.on('*', function (name, params) {
self.trigger(name, params);
});
};
Select2.prototype._registerEvents = function () {
var self = this;
this.on('open', function () {
self.$container.addClass('select2-container--open');
});
this.on('close', function () {
self.$container.removeClass('select2-container--open');
});
this.on('enable', function () {
self.$container.removeClass('select2-container--disabled');
});
this.on('disable', function () {
self.$container.addClass('select2-container--disabled');
});
this.on('blur', function () {
self.$container.removeClass('select2-container--focus');
});
this.on('query', function (params) {
if (!self.isOpen()) {
self.trigger('open', {});
}
this.dataAdapter.query(params, function (data) {
self.trigger('results:all', {
data: data,
query: params
});
});
});
this.on('query:append', function (params) {
this.dataAdapter.query(params, function (data) {
self.trigger('results:append', {
data: data,
query: params
});
});
});
this.on('keypress', function (evt) {
var key = evt.which;
if (self.isOpen()) {
if (key === KEYS.ESC || key === KEYS.TAB ||
(key === KEYS.UP && evt.altKey)) {
self.close(evt);
evt.preventDefault();
} else if (key === KEYS.ENTER) {
self.trigger('results:select', {});
evt.preventDefault();
} else if ((key === KEYS.SPACE && evt.ctrlKey)) {
self.trigger('results:toggle', {});
evt.preventDefault();
} else if (key === KEYS.UP) {
self.trigger('results:previous', {});
evt.preventDefault();
} else if (key === KEYS.DOWN) {
self.trigger('results:next', {});
evt.preventDefault();
}
} else {
if (key === KEYS.ENTER || key === KEYS.SPACE ||
(key === KEYS.DOWN && evt.altKey)) {
self.open();
evt.preventDefault();
}
}
});
};
Select2.prototype._syncAttributes = function () {
this.options.set('disabled', this.$element.prop('disabled'));
if (this.isDisabled()) {
if (this.isOpen()) {
this.close();
}
this.trigger('disable', {});
} else {
this.trigger('enable', {});
}
};
Select2.prototype._isChangeMutation = function (evt, mutations) {
var changed = false;
var self = this;
// Ignore any mutation events raised for elements that aren't options or
// optgroups. This handles the case when the select element is destroyed
if (
evt && evt.target && (
evt.target.nodeName !== 'OPTION' && evt.target.nodeName !== 'OPTGROUP'
)
) {
return;
}
if (!mutations) {
// If mutation events aren't supported, then we can only assume that the
// change affected the selections
changed = true;
} else if (mutations.addedNodes && mutations.addedNodes.length > 0) {
for (var n = 0; n < mutations.addedNodes.length; n++) {
var node = mutations.addedNodes[n];
if (node.selected) {
changed = true;
}
}
} else if (mutations.removedNodes && mutations.removedNodes.length > 0) {
changed = true;
} else if ($.isArray(mutations)) {
$.each(mutations, function(evt, mutation) {
if (self._isChangeMutation(evt, mutation)) {
// We've found a change mutation.
// Let's escape from the loop and continue
changed = true;
return false;
}
});
}
return changed;
};
Select2.prototype._syncSubtree = function (evt, mutations) {
var changed = this._isChangeMutation(evt, mutations);
var self = this;
// Only re-pull the data if we think there is a change
if (changed) {
this.dataAdapter.current(function (currentData) {
self.trigger('selection:update', {
data: currentData
});
});
}
};
/**
* Override the trigger method to automatically trigger pre-events when
* there are events that can be prevented.
*/
Select2.prototype.trigger = function (name, args) {
var actualTrigger = Select2.__super__.trigger;
var preTriggerMap = {
'open': 'opening',
'close': 'closing',
'select': 'selecting',
'unselect': 'unselecting',
'clear': 'clearing'
};
if (args === undefined) {
args = {};
}
if (name in preTriggerMap) {
var preTriggerName = preTriggerMap[name];
var preTriggerArgs = {
prevented: false,
name: name,
args: args
};
actualTrigger.call(this, preTriggerName, preTriggerArgs);
if (preTriggerArgs.prevented) {
args.prevented = true;
return;
}
}
actualTrigger.call(this, name, args);
};
Select2.prototype.toggleDropdown = function () {
if (this.isDisabled()) {
return;
}
if (this.isOpen()) {
this.close();
} else {
this.open();
}
};
Select2.prototype.open = function () {
if (this.isOpen()) {
return;
}
if (this.isDisabled()) {
return;
}
this.trigger('query', {});
};
Select2.prototype.close = function (evt) {
if (!this.isOpen()) {
return;
}
this.trigger('close', { originalEvent : evt });
};
/**
* Helper method to abstract the "enabled" (not "disabled") state of this
* object.
*
* @return {true} if the instance is not disabled.
* @return {false} if the instance is disabled.
*/
Select2.prototype.isEnabled = function () {
return !this.isDisabled();
};
/**
* Helper method to abstract the "disabled" state of this object.
*
* @return {true} if the disabled option is true.
* @return {false} if the disabled option is false.
*/
Select2.prototype.isDisabled = function () {
return this.options.get('disabled');
};
Select2.prototype.isOpen = function () {
return this.$container.hasClass('select2-container--open');
};
Select2.prototype.hasFocus = function () {
return this.$container.hasClass('select2-container--focus');
};
Select2.prototype.focus = function (data) {
// No need to re-trigger focus events if we are already focused
if (this.hasFocus()) {
return;
}
this.$container.addClass('select2-container--focus');
this.trigger('focus', {});
};
Select2.prototype.enable = function (args) {
if (this.options.get('debug') && window.console && console.warn) {
console.warn(
'Select2: The `select2("enable")` method has been deprecated and will' +
' be removed in later Select2 versions. Use $element.prop("disabled")' +
' instead.'
);
}
if (args == null || args.length === 0) {
args = [true];
}
var disabled = !args[0];
this.$element.prop('disabled', disabled);
};
Select2.prototype.data = function () {
if (this.options.get('debug') &&
arguments.length > 0 && window.console && console.warn) {
console.warn(
'Select2: Data can no longer be set using `select2("data")`. You ' +
'should consider setting the value instead using `$element.val()`.'
);
}
var data = [];
this.dataAdapter.current(function (currentData) {
data = currentData;
});
return data;
};
Select2.prototype.val = function (args) {
if (this.options.get('debug') && window.console && console.warn) {
console.warn(
'Select2: The `select2("val")` method has been deprecated and will be' +
' removed in later Select2 versions. Use $element.val() instead.'
);
}
if (args == null || args.length === 0) {
return this.$element.val();
}
var newVal = args[0];
if ($.isArray(newVal)) {
newVal = $.map(newVal, function (obj) {
return obj.toString();
});
}
this.$element.val(newVal).trigger('input').trigger('change');
};
Select2.prototype.destroy = function () {
this.$container.remove();
if (this.$element[0].detachEvent) {
this.$element[0].detachEvent('onpropertychange', this._syncA);
}
if (this._observer != null) {
this._observer.disconnect();
this._observer = null;
} else if (this.$element[0].removeEventListener) {
this.$element[0]
.removeEventListener('DOMAttrModified', this._syncA, false);
this.$element[0]
.removeEventListener('DOMNodeInserted', this._syncS, false);
this.$element[0]
.removeEventListener('DOMNodeRemoved', this._syncS, false);
}
this._syncA = null;
this._syncS = null;
this.$element.off('.select2');
this.$element.attr('tabindex',
Utils.GetData(this.$element[0], 'old-tabindex'));
this.$element.removeClass('select2-hidden-accessible');
this.$element.attr('aria-hidden', 'false');
Utils.RemoveData(this.$element[0]);
this.$element.removeData('select2');
this.dataAdapter.destroy();
this.selection.destroy();
this.dropdown.destroy();
this.results.destroy();
this.dataAdapter = null;
this.selection = null;
this.dropdown = null;
this.results = null;
};
Select2.prototype.render = function () {
var $container = $(
'<span class="select2 select2-container">' +
'<span class="selection"></span>' +
'<span class="dropdown-wrapper" aria-hidden="true"></span>' +
'</span>'
);
$container.attr('dir', this.options.get('dir'));
this.$container = $container;
this.$container.addClass('select2-container--' + this.options.get('theme'));
Utils.StoreData($container[0], 'element', this.$element);
return $container;
};
return Select2;
});
S2.define('select2/compat/utils',[
'jquery'
], function ($) {
function syncCssClasses ($dest, $src, adapter) {
var classes, replacements = [], adapted;
classes = $.trim($dest.attr('class'));
if (classes) {
classes = '' + classes; // for IE which returns object
$(classes.split(/\s+/)).each(function () {
// Save all Select2 classes
if (this.indexOf('select2-') === 0) {
replacements.push(this);
}
});
}
classes = $.trim($src.attr('class'));
if (classes) {
classes = '' + classes; // for IE which returns object
$(classes.split(/\s+/)).each(function () {
// Only adapt non-Select2 classes
if (this.indexOf('select2-') !== 0) {
adapted = adapter(this);
if (adapted != null) {
replacements.push(adapted);
}
}
});
}
$dest.attr('class', replacements.join(' '));
}
return {
syncCssClasses: syncCssClasses
};
});
S2.define('select2/compat/containerCss',[
'jquery',
'./utils'
], function ($, CompatUtils) {
// No-op CSS adapter that discards all classes by default
function _containerAdapter (clazz) {
return null;
}
function ContainerCSS () { }
ContainerCSS.prototype.render = function (decorated) {
var $container = decorated.call(this);
var containerCssClass = this.options.get('containerCssClass') || '';
if ($.isFunction(containerCssClass)) {
containerCssClass = containerCssClass(this.$element);
}
var containerCssAdapter = this.options.get('adaptContainerCssClass');
containerCssAdapter = containerCssAdapter || _containerAdapter;
if (containerCssClass.indexOf(':all:') !== -1) {
containerCssClass = containerCssClass.replace(':all:', '');
var _cssAdapter = containerCssAdapter;
containerCssAdapter = function (clazz) {
var adapted = _cssAdapter(clazz);
if (adapted != null) {
// Append the old one along with the adapted one
return adapted + ' ' + clazz;
}
return clazz;
};
}
var containerCss = this.options.get('containerCss') || {};
if ($.isFunction(containerCss)) {
containerCss = containerCss(this.$element);
}
CompatUtils.syncCssClasses($container, this.$element, containerCssAdapter);
$container.css(containerCss);
$container.addClass(containerCssClass);
return $container;
};
return ContainerCSS;
});
S2.define('select2/compat/dropdownCss',[
'jquery',
'./utils'
], function ($, CompatUtils) {
// No-op CSS adapter that discards all classes by default
function _dropdownAdapter (clazz) {
return null;
}
function DropdownCSS () { }
DropdownCSS.prototype.render = function (decorated) {
var $dropdown = decorated.call(this);
var dropdownCssClass = this.options.get('dropdownCssClass') || '';
if ($.isFunction(dropdownCssClass)) {
dropdownCssClass = dropdownCssClass(this.$element);
}
var dropdownCssAdapter = this.options.get('adaptDropdownCssClass');
dropdownCssAdapter = dropdownCssAdapter || _dropdownAdapter;
if (dropdownCssClass.indexOf(':all:') !== -1) {
dropdownCssClass = dropdownCssClass.replace(':all:', '');
var _cssAdapter = dropdownCssAdapter;
dropdownCssAdapter = function (clazz) {
var adapted = _cssAdapter(clazz);
if (adapted != null) {
// Append the old one along with the adapted one
return adapted + ' ' + clazz;
}
return clazz;
};
}
var dropdownCss = this.options.get('dropdownCss') || {};
if ($.isFunction(dropdownCss)) {
dropdownCss = dropdownCss(this.$element);
}
CompatUtils.syncCssClasses($dropdown, this.$element, dropdownCssAdapter);
$dropdown.css(dropdownCss);
$dropdown.addClass(dropdownCssClass);
return $dropdown;
};
return DropdownCSS;
});
S2.define('select2/compat/initSelection',[
'jquery'
], function ($) {
function InitSelection (decorated, $element, options) {
if (options.get('debug') && window.console && console.warn) {
console.warn(
'Select2: The `initSelection` option has been deprecated in favor' +
' of a custom data adapter that overrides the `current` method. ' +
'This method is now called multiple times instead of a single ' +
'time when the instance is initialized. Support will be removed ' +
'for the `initSelection` option in future versions of Select2'
);
}
this.initSelection = options.get('initSelection');
this._isInitialized = false;
decorated.call(this, $element, options);
}
InitSelection.prototype.current = function (decorated, callback) {
var self = this;
if (this._isInitialized) {
decorated.call(this, callback);
return;
}
this.initSelection.call(null, this.$element, function (data) {
self._isInitialized = true;
if (!$.isArray(data)) {
data = [data];
}
callback(data);
});
};
return InitSelection;
});
S2.define('select2/compat/inputData',[
'jquery',
'../utils'
], function ($, Utils) {
function InputData (decorated, $element, options) {
this._currentData = [];
this._valueSeparator = options.get('valueSeparator') || ',';
if ($element.prop('type') === 'hidden') {
if (options.get('debug') && console && console.warn) {
console.warn(
'Select2: Using a hidden input with Select2 is no longer ' +
'supported and may stop working in the future. It is recommended ' +
'to use a `<select>` element instead.'
);
}
}
decorated.call(this, $element, options);
}
InputData.prototype.current = function (_, callback) {
function getSelected (data, selectedIds) {
var selected = [];
if (data.selected || $.inArray(data.id, selectedIds) !== -1) {
data.selected = true;
selected.push(data);
} else {
data.selected = false;
}
if (data.children) {
selected.push.apply(selected, getSelected(data.children, selectedIds));
}
return selected;
}
var selected = [];
for (var d = 0; d < this._currentData.length; d++) {
var data = this._currentData[d];
selected.push.apply(
selected,
getSelected(
data,
this.$element.val().split(
this._valueSeparator
)
)
);
}
callback(selected);
};
InputData.prototype.select = function (_, data) {
if (!this.options.get('multiple')) {
this.current(function (allData) {
$.map(allData, function (data) {
data.selected = false;
});
});
this.$element.val(data.id);
this.$element.trigger('input').trigger('change');
} else {
var value = this.$element.val();
value += this._valueSeparator + data.id;
this.$element.val(value);
this.$element.trigger('input').trigger('change');
}
};
InputData.prototype.unselect = function (_, data) {
var self = this;
data.selected = false;
this.current(function (allData) {
var values = [];
for (var d = 0; d < allData.length; d++) {
var item = allData[d];
if (data.id == item.id) {
continue;
}
values.push(item.id);
}
self.$element.val(values.join(self._valueSeparator));
self.$element.trigger('input').trigger('change');
});
};
InputData.prototype.query = function (_, params, callback) {
var results = [];
for (var d = 0; d < this._currentData.length; d++) {
var data = this._currentData[d];
var matches = this.matches(params, data);
if (matches !== null) {
results.push(matches);
}
}
callback({
results: results
});
};
InputData.prototype.addOptions = function (_, $options) {
var options = $.map($options, function ($option) {
return Utils.GetData($option[0], 'data');
});
this._currentData.push.apply(this._currentData, options);
};
return InputData;
});
S2.define('select2/compat/matcher',[
'jquery'
], function ($) {
function oldMatcher (matcher) {
function wrappedMatcher (params, data) {
var match = $.extend(true, {}, data);
if (params.term == null || $.trim(params.term) === '') {
return match;
}
if (data.children) {
for (var c = data.children.length - 1; c >= 0; c--) {
var child = data.children[c];
// Check if the child object matches
// The old matcher returned a boolean true or false
var doesMatch = matcher(params.term, child.text, child);
// If the child didn't match, pop it off
if (!doesMatch) {
match.children.splice(c, 1);
}
}
if (match.children.length > 0) {
return match;
}
}
if (matcher(params.term, data.text, data)) {
return match;
}
return null;
}
return wrappedMatcher;
}
return oldMatcher;
});
S2.define('select2/compat/query',[
], function () {
function Query (decorated, $element, options) {
if (options.get('debug') && window.console && console.warn) {
console.warn(
'Select2: The `query` option has been deprecated in favor of a ' +
'custom data adapter that overrides the `query` method. Support ' +
'will be removed for the `query` option in future versions of ' +
'Select2.'
);
}
decorated.call(this, $element, options);
}
Query.prototype.query = function (_, params, callback) {
params.callback = callback;
var query = this.options.get('query');
query.call(null, params);
};
return Query;
});
S2.define('select2/dropdown/attachContainer',[
], function () {
function AttachContainer (decorated, $element, options) {
decorated.call(this, $element, options);
}
AttachContainer.prototype.position =
function (decorated, $dropdown, $container) {
var $dropdownContainer = $container.find('.dropdown-wrapper');
$dropdownContainer.append($dropdown);
$dropdown.addClass('select2-dropdown--below');
$container.addClass('select2-container--below');
};
return AttachContainer;
});
S2.define('select2/dropdown/stopPropagation',[
], function () {
function StopPropagation () { }
StopPropagation.prototype.bind = function (decorated, container, $container) {
decorated.call(this, container, $container);
var stoppedEvents = [
'blur',
'change',
'click',
'dblclick',
'focus',
'focusin',
'focusout',
'input',
'keydown',
'keyup',
'keypress',
'mousedown',
'mouseenter',
'mouseleave',
'mousemove',
'mouseover',
'mouseup',
'search',
'touchend',
'touchstart'
];
this.$dropdown.on(stoppedEvents.join(' '), function (evt) {
evt.stopPropagation();
});
};
return StopPropagation;
});
S2.define('select2/selection/stopPropagation',[
], function () {
function StopPropagation () { }
StopPropagation.prototype.bind = function (decorated, container, $container) {
decorated.call(this, container, $container);
var stoppedEvents = [
'blur',
'change',
'click',
'dblclick',
'focus',
'focusin',
'focusout',
'input',
'keydown',
'keyup',
'keypress',
'mousedown',
'mouseenter',
'mouseleave',
'mousemove',
'mouseover',
'mouseup',
'search',
'touchend',
'touchstart'
];
this.$selection.on(stoppedEvents.join(' '), function (evt) {
evt.stopPropagation();
});
};
return StopPropagation;
});
/*!
* jQuery Mousewheel 3.1.13
*
* Copyright jQuery Foundation and other contributors
* Released under the MIT license
* http://jquery.org/license
*/
(function (factory) {
if ( typeof S2.define === 'function' && S2.define.amd ) {
// AMD. Register as an anonymous module.
S2.define('jquery-mousewheel',['jquery'], factory);
} else if (typeof exports === 'object') {
// Node/CommonJS style for Browserify
module.exports = factory;
} else {
// Browser globals
factory(jQuery);
}
}(function ($) {
var toFix = ['wheel', 'mousewheel', 'DOMMouseScroll', 'MozMousePixelScroll'],
toBind = ( 'onwheel' in document || document.documentMode >= 9 ) ?
['wheel'] : ['mousewheel', 'DomMouseScroll', 'MozMousePixelScroll'],
slice = Array.prototype.slice,
nullLowestDeltaTimeout, lowestDelta;
if ( $.event.fixHooks ) {
for ( var i = toFix.length; i; ) {
$.event.fixHooks[ toFix[--i] ] = $.event.mouseHooks;
}
}
var special = $.event.special.mousewheel = {
version: '3.1.12',
setup: function() {
if ( this.addEventListener ) {
for ( var i = toBind.length; i; ) {
this.addEventListener( toBind[--i], handler, false );
}
} else {
this.onmousewheel = handler;
}
// Store the line height and page height for this particular element
$.data(this, 'mousewheel-line-height', special.getLineHeight(this));
$.data(this, 'mousewheel-page-height', special.getPageHeight(this));
},
teardown: function() {
if ( this.removeEventListener ) {
for ( var i = toBind.length; i; ) {
this.removeEventListener( toBind[--i], handler, false );
}
} else {
this.onmousewheel = null;
}
// Clean up the data we added to the element
$.removeData(this, 'mousewheel-line-height');
$.removeData(this, 'mousewheel-page-height');
},
getLineHeight: function(elem) {
var $elem = $(elem),
$parent = $elem['offsetParent' in $.fn ? 'offsetParent' : 'parent']();
if (!$parent.length) {
$parent = $('body');
}
return parseInt($parent.css('fontSize'), 10) || parseInt($elem.css('fontSize'), 10) || 16;
},
getPageHeight: function(elem) {
return $(elem).height();
},
settings: {
adjustOldDeltas: true, // see shouldAdjustOldDeltas() below
normalizeOffset: true // calls getBoundingClientRect for each event
}
};
$.fn.extend({
mousewheel: function(fn) {
return fn ? this.bind('mousewheel', fn) : this.trigger('mousewheel');
},
unmousewheel: function(fn) {
return this.unbind('mousewheel', fn);
}
});
function handler(event) {
var orgEvent = event || window.event,
args = slice.call(arguments, 1),
delta = 0,
deltaX = 0,
deltaY = 0,
absDelta = 0,
offsetX = 0,
offsetY = 0;
event = $.event.fix(orgEvent);
event.type = 'mousewheel';
// Old school scrollwheel delta
if ( 'detail' in orgEvent ) { deltaY = orgEvent.detail * -1; }
if ( 'wheelDelta' in orgEvent ) { deltaY = orgEvent.wheelDelta; }
if ( 'wheelDeltaY' in orgEvent ) { deltaY = orgEvent.wheelDeltaY; }
if ( 'wheelDeltaX' in orgEvent ) { deltaX = orgEvent.wheelDeltaX * -1; }
// Firefox < 17 horizontal scrolling related to DOMMouseScroll event
if ( 'axis' in orgEvent && orgEvent.axis === orgEvent.HORIZONTAL_AXIS ) {
deltaX = deltaY * -1;
deltaY = 0;
}
// Set delta to be deltaY or deltaX if deltaY is 0 for backwards compatabilitiy
delta = deltaY === 0 ? deltaX : deltaY;
// New school wheel delta (wheel event)
if ( 'deltaY' in orgEvent ) {
deltaY = orgEvent.deltaY * -1;
delta = deltaY;
}
if ( 'deltaX' in orgEvent ) {
deltaX = orgEvent.deltaX;
if ( deltaY === 0 ) { delta = deltaX * -1; }
}
// No change actually happened, no reason to go any further
if ( deltaY === 0 && deltaX === 0 ) { return; }
// Need to convert lines and pages to pixels if we aren't already in pixels
// There are three delta modes:
// * deltaMode 0 is by pixels, nothing to do
// * deltaMode 1 is by lines
// * deltaMode 2 is by pages
if ( orgEvent.deltaMode === 1 ) {
var lineHeight = $.data(this, 'mousewheel-line-height');
delta *= lineHeight;
deltaY *= lineHeight;
deltaX *= lineHeight;
} else if ( orgEvent.deltaMode === 2 ) {
var pageHeight = $.data(this, 'mousewheel-page-height');
delta *= pageHeight;
deltaY *= pageHeight;
deltaX *= pageHeight;
}
// Store lowest absolute delta to normalize the delta values
absDelta = Math.max( Math.abs(deltaY), Math.abs(deltaX) );
if ( !lowestDelta || absDelta < lowestDelta ) {
lowestDelta = absDelta;
// Adjust older deltas if necessary
if ( shouldAdjustOldDeltas(orgEvent, absDelta) ) {
lowestDelta /= 40;
}
}
// Adjust older deltas if necessary
if ( shouldAdjustOldDeltas(orgEvent, absDelta) ) {
// Divide all the things by 40!
delta /= 40;
deltaX /= 40;
deltaY /= 40;
}
// Get a whole, normalized value for the deltas
delta = Math[ delta >= 1 ? 'floor' : 'ceil' ](delta / lowestDelta);
deltaX = Math[ deltaX >= 1 ? 'floor' : 'ceil' ](deltaX / lowestDelta);
deltaY = Math[ deltaY >= 1 ? 'floor' : 'ceil' ](deltaY / lowestDelta);
// Normalise offsetX and offsetY properties
if ( special.settings.normalizeOffset && this.getBoundingClientRect ) {
var boundingRect = this.getBoundingClientRect();
offsetX = event.clientX - boundingRect.left;
offsetY = event.clientY - boundingRect.top;
}
// Add information to the event object
event.deltaX = deltaX;
event.deltaY = deltaY;
event.deltaFactor = lowestDelta;
event.offsetX = offsetX;
event.offsetY = offsetY;
// Go ahead and set deltaMode to 0 since we converted to pixels
// Although this is a little odd since we overwrite the deltaX/Y
// properties with normalized deltas.
event.deltaMode = 0;
// Add event and delta to the front of the arguments
args.unshift(event, delta, deltaX, deltaY);
// Clearout lowestDelta after sometime to better
// handle multiple device types that give different
// a different lowestDelta
// Ex: trackpad = 3 and mouse wheel = 120
if (nullLowestDeltaTimeout) { clearTimeout(nullLowestDeltaTimeout); }
nullLowestDeltaTimeout = setTimeout(nullLowestDelta, 200);
return ($.event.dispatch || $.event.handle).apply(this, args);
}
function nullLowestDelta() {
lowestDelta = null;
}
function shouldAdjustOldDeltas(orgEvent, absDelta) {
// If this is an older event and the delta is divisable by 120,
// then we are assuming that the browser is treating this as an
// older mouse wheel event and that we should divide the deltas
// by 40 to try and get a more usable deltaFactor.
// Side note, this actually impacts the reported scroll distance
// in older browsers and can cause scrolling to be slower than native.
// Turn this off by setting $.event.special.mousewheel.settings.adjustOldDeltas to false.
return special.settings.adjustOldDeltas && orgEvent.type === 'mousewheel' && absDelta % 120 === 0;
}
}));
S2.define('jquery.select2',[
'jquery',
'jquery-mousewheel',
'./select2/core',
'./select2/defaults',
'./select2/utils'
], function ($, _, Select2, Defaults, Utils) {
if ($.fn.select2 == null) {
// All methods that should return the element
var thisMethods = ['open', 'close', 'destroy'];
$.fn.select2 = function (options) {
options = options || {};
if (typeof options === 'object') {
this.each(function () {
var instanceOptions = $.extend(true, {}, options);
var instance = new Select2($(this), instanceOptions);
});
return this;
} else if (typeof options === 'string') {
var ret;
var args = Array.prototype.slice.call(arguments, 1);
this.each(function () {
var instance = Utils.GetData(this, 'select2');
if (instance == null && window.console && console.error) {
console.error(
'The select2(\'' + options + '\') method was called on an ' +
'element that is not using Select2.'
);
}
ret = instance[options].apply(instance, args);
});
// Check if we should be returning `this`
if ($.inArray(options, thisMethods) > -1) {
return this;
}
return ret;
} else {
throw new Error('Invalid arguments for Select2: ' + options);
}
};
}
if ($.fn.select2.defaults == null) {
$.fn.select2.defaults = Defaults;
}
return Select2;
});
// Return the AMD loader configuration so it can be used outside of this file
return {
define: S2.define,
require: S2.require
};
}());
// Autoload the jQuery bindings
// We know that all of the modules exist above this, so we're safe
var select2 = S2.require('jquery.select2');
// Hold the AMD module references on the jQuery function that was just loaded
// This allows Select2 to use the internal loader outside of this file, such
// as in the language files.
jQuery.fn.select2.amd = S2;
// Return the Select2 instance for anyone who is importing it.
return select2;
}));
================================================
FILE: assets/vendor/webui-popover/jquery.webui-popover.css
================================================
/*
* webui popover plugin - v1.2.15
* A lightWeight popover plugin with jquery ,enchance the popover plugin of bootstrap with some awesome new features. It works well with bootstrap ,but bootstrap is not necessary!
* https://github.com/sandywalker/webui-popover
*
* Made by Sandy Duan
* Under MIT License
*/
.webui-popover-content {
display: none;
}
.webui-popover-rtl {
direction: rtl;
text-align: right;
}
/* webui popover */
.webui-popover {
position: absolute;
top: 0;
left: 0;
z-index: 9999;
display: none;
min-width: 50px;
min-height: 32px;
padding: 1px;
text-align: left;
white-space: normal;
background-color: #ffffff;
background-clip: padding-box;
border: 1px solid #cccccc;
border: 1px solid rgba(0, 0, 0, 0.2);
border-radius: 6px;
-webkit-box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2);
box-shadow: 0 5px 10px rgba(0, 0, 0, 0.2);
}
.webui-popover.top,
.webui-popover.top-left,
.webui-popover.top-right {
margin-top: -10px;
}
.webui-popover.right,
.webui-popover.right-top,
.webui-popover.right-bottom {
margin-left: 10px;
}
.webui-popover.bottom,
.webui-popover.bottom-left,
.webui-popover.bottom-right {
margin-top: 10px;
}
.webui-popover.left,
.webui-popover.left-top,
.webui-popover.left-bottom {
margin-left: -10px;
}
.webui-popover.pop {
-webkit-transform: scale(0.8);
-o-transform: scale(0.8);
transform: scale(0.8);
-webkit-transition: transform 0.15s cubic-bezier(0.3, 0, 0, 1.5);
-o-transition: transform 0.15s cubic-bezier(0.3, 0, 0, 1.5);
transition: transform 0.15s cubic-bezier(0.3, 0, 0, 1.5);
opacity: 0;
filter: alpha(opacity=0);
}
.webui-popover.pop-out {
-webkit-transition-property: "opacity,transform";
-o-transition-property: "opacity,transform";
transition-property: "opacity,transform";
-webkit-transition: 0.15s linear;
-o-transition: 0.15s linear;
transition: 0.15s linear;
opacity: 0;
filter: alpha(opacity=0);
}
.webui-popover.fade,
.webui-popover.fade-out {
-webkit-transition: opacity 0.15s linear;
-o-transition: opacity 0.15s linear;
transition: opacity 0.15s linear;
opacity: 0;
filter: alpha(opacity=0);
}
.webui-popover.out {
opacity: 0;
filter: alpha(opacity=0);
}
.webui-popover.in {
-webkit-transform: none;
-o-transform: none;
transform: none;
opacity: 1;
filter: alpha(opacity=100);
}
.webui-popover .webui-popover-content {
padding: 9px 14px;
overflow: auto;
display: block;
}
.webui-popover .webui-popover-content > div:first-child {
width: 99%;
}
.webui-popover-inner .close {
font-family: arial;
margin: 8px 10px 0 0;
float: right;
font-size: 16px;
font-weight: bold;
line-height: 16px;
color: #000000;
text-shadow: 0 1px 0 #fff;
opacity: 0.2;
filter: alpha(opacity=20);
text-decoration: none;
}
.webui-popover-inner .close:hover,
.webui-popover-inner .close:focus {
opacity: 0.5;
filter: alpha(opacity=50);
}
.webui-popover-inner .close:after {
content: "\00D7";
width: 0.8em;
height: 0.8em;
padding: 4px;
position: relative;
}
.webui-popover-title {
padding: 8px 14px;
margin: 0;
font-size: 14px;
font-weight: bold;
line-height: 18px;
background-color: #ffffff;
border-bottom: 1px solid #f2f2f2;
border-radius: 5px 5px 0 0;
}
.webui-popover-content {
padding: 9px 14px;
overflow: auto;
display: none;
}
.webui-popover-inverse {
background-color: #333333;
color: #eeeeee;
}
.webui-popover-inverse .webui-popover-title {
background: #333333;
border-bottom: 1px solid #3b3b3b;
color: #eeeeee;
}
.webui-no-padding .webui-popover-content {
padding: 0;
}
.webui-no-padding .list-group-item {
border-right: none;
border-left: none;
}
.webui-no-padding .list-group-item:first-child {
border-top: 0;
}
.webui-no-padding .list-group-item:last-child {
border-bottom: 0;
}
.webui-popover > .webui-arrow,
.webui-popover > .webui-arrow:after {
position: absolute;
display: block;
width: 0;
height: 0;
border-color: transparent;
border-style: solid;
}
.webui-popover > .webui-arrow {
border-width: 11px;
}
.webui-popover > .webui-arrow:after {
border-width: 10px;
content: "";
}
.webui-popover.top > .webui-arrow,
.webui-popover.top-right > .webui-arrow,
.webui-popover.top-left > .webui-arrow {
bottom: -11px;
left: 50%;
margin-left: -11px;
border-top-color: #999999;
border-top-color: rgba(0, 0, 0, 0.25);
border-bottom-width: 0;
}
.webui-popover.top > .webui-arrow:after,
.webui-popover.top-right > .webui-arrow:after,
.webui-popover.top-left > .webui-arrow:after {
content: " ";
bottom: 1px;
margin-left: -10px;
border-top-color: #ffffff;
border-bottom-width: 0;
}
.webui-popover.right > .webui-arrow,
.webui-popover.right-top > .webui-arrow,
.webui-popover.right-bottom > .webui-arrow {
top: 50%;
left: -11px;
margin-top: -11px;
border-left-width: 0;
border-right-color: #999999;
border-right-color: rgba(0, 0, 0, 0.25);
}
.webui-popover.right > .webui-arrow:after,
.webui-popover.right-top > .webui-arrow:after,
.webui-popover.right-bottom > .webui-arrow:after {
content: " ";
left: 1px;
bottom: -10px;
border-left-width: 0;
border-right-color: #ffffff;
}
.webui-popover.bottom > .webui-arrow,
.webui-popover.bottom-right > .webui-arrow,
.webui-popover.bottom-left > .webui-arrow {
top: -11px;
left: 50%;
margin-left: -11px;
border-bottom-color: #999999;
border-bottom-color: rgba(0, 0, 0, 0.25);
border-top-width: 0;
}
.webui-popover.bottom > .webui-arrow:after,
.webui-popover.bottom-right > .webui-arrow:after,
.webui-popover.bottom-left > .webui-arrow:after {
content: " ";
top: 1px;
margin-left: -10px;
border-bottom-color: #ffffff;
border-top-width: 0;
}
.webui-popover.left > .webui-arrow,
.webui-popover.left-top > .webui-arrow,
.webui-popover.left-bottom > .webui-arrow {
top: 50%;
right: -11px;
margin-top: -11px;
border-right-width: 0;
border-left-color: #999999;
border-left-color: rgba(0, 0, 0, 0.25);
}
.webui-popover.left > .webui-arrow:after,
.webui-popover.left-top > .webui-arrow:after,
.webui-popover.left-bottom > .webui-arrow:after {
content: " ";
right: 1px;
border-right-width: 0;
border-left-color: #ffffff;
bottom: -10px;
}
.webui-popover-inverse.top > .webui-arrow,
.webui-popover-inverse.top-left > .webui-arrow,
.webui-popover-inverse.top-right > .webui-arrow,
.webui-popover-inverse.top > .webui-arrow:after,
.webui-popover-inverse.top-left > .webui-arrow:after,
.webui-popover-inverse.top-right > .webui-arrow:after {
border-top-color: #333333;
}
.webui-popover-inverse.right > .webui-arrow,
.webui-popover-inverse.right-top > .webui-arrow,
.webui-popover-inverse.right-bottom > .webui-arrow,
.webui-popover-inverse.right > .webui-arrow:after,
.webui-popover-inverse.right-top > .webui-arrow:after,
.webui-popover-inverse.right-bottom > .webui-arrow:after {
border-right-color: #333333;
}
.webui-popover-inverse.bottom > .webui-arrow,
.webui-popover-inverse.bottom-left > .webui-arrow,
.webui-popover-inverse.bottom-right > .webui-arrow,
.webui-popover-inverse.bottom > .webui-arrow:after,
.webui-popover-inverse.bottom-left > .webui-arrow:after,
.webui-popover-inverse.bottom-right > .webui-arrow:after {
border-bottom-color: #333333;
}
.webui-popover-inverse.left > .webui-arrow,
.webui-popover-inverse.left-top > .webui-arrow,
.webui-popover-inverse.left-bottom > .webui-arrow,
.webui-popover-inverse.left > .webui-arrow:after,
.webui-popover-inverse.left-top > .webui-arrow:after,
.webui-popover-inverse.left-bottom > .webui-arrow:after {
border-left-color: #333333;
}
.webui-popover i.icon-refresh:before {
content: "";
}
.webui-popover i.icon-refresh {
display: block;
width: 30px;
height: 30px;
font-size: 20px;
top: 50%;
left: 50%;
position: absolute;
margin-left: -15px;
margin-right: -15px;
background: url(../img/loading.gif) no-repeat;
}
@-webkit-keyframes rotate {
100% {
-webkit-transform: rotate(360deg);
}
}
@keyframes rotate {
100% {
transform: rotate(360deg);
}
}
.webui-popover-backdrop {
background-color: rgba(0, 0, 0, 0.65);
width: 100%;
height: 100%;
position: fixed;
top: 0;
left: 0;
z-index: 9998;
}
.webui-popover .dropdown-menu {
display: block;
position: relative;
top: 0;
border: none;
box-shadow: none;
float: none;
}
================================================
FILE: assets/vendor/webui-popover/jquery.webui-popover.js
================================================
/*
* webui popover plugin - v1.2.15
* A lightWeight popover plugin with jquery ,enchance the popover plugin of bootstrap with some awesome new features. It works well with bootstrap ,but bootstrap is not necessary!
* https://github.com/sandywalker/webui-popover
*
* Made by Sandy Duan
* Under MIT License
*/
(function(window, document, undefined) {
'use strict';
(function(factory) {
if (typeof define === 'function' && define.amd) {
// Register as an anonymous AMD module.
define(['jquery'], factory);
} else if (typeof exports === 'object') {
// Node/CommonJS
module.exports = factory(require('jquery'));
} else {
// Browser globals
factory(window.jQuery);
}
}(function($) {
var closeLabel = 'Close';
if ( 'undefined' !== typeof LLMS && 'undefined' !== typeof LLMS.l10n && 'undefined' !== typeof LLMS.l10n.translate ) {
closeLabel = LLMS.l10n.translate( 'Close' );
}
// Create the defaults once
var pluginName = 'webuiPopover';
var pluginClass = 'webui-popover';
var pluginType = 'webui.popover';
var defaults = {
placement: 'auto',
container: null,
width: 'auto',
height: 'auto',
trigger: 'click', //hover,click,sticky,manual
style: '',
selector: false, // jQuery selector, if a selector is provided, popover objects will be delegated to the specified.
delay: {
show: null,
hide: 300
},
async: {
type: 'GET',
before: null, //function(that, xhr){}
success: null, //function(that, xhr){}
error: null //function(that, xhr, data){}
},
cache: true,
multi: false,
arrow: true,
title: '',
content: '',
closeable: false,
padding: true,
url: '',
type: 'html',
direction: '', // ltr,rtl
animation: null,
template: '<div class="webui-popover">' +
'<div class="webui-arrow"></div>' +
'<div class="webui-popover-inner">' +
'<a href="#" aria-label="' + closeLabel + '" class="close"></a>' +
'<h3 class="webui-popover-title"></h3>' +
'<div class="webui-popover-content"><i class="icon-refresh"></i> <p> </p></div>' +
'</div>' +
'</div>',
backdrop: false,
dismissible: true,
onShow: null,
onHide: null,
abortXHR: true,
autoHide: false,
offsetTop: 0,
offsetLeft: 0,
iframeOptions: {
frameborder: '0',
allowtransparency: 'true',
id: '',
name: '',
scrolling: '',
onload: '',
height: '',
width: ''
},
hideEmpty: false
};
var rtlClass = pluginClass + '-rtl';
var _srcElements = [];
var backdrop = $('<div class="webui-popover-backdrop"></div>');
var _globalIdSeed = 0;
var _isBodyEventHandled = false;
var _offsetOut = -2000; // the value offset out of the screen
var $document = $(document);
var toNumber = function(numeric, fallback) {
return isNaN(numeric) ? (fallback || 0) : Number(numeric);
};
var getPopFromElement = function($element) {
return $element.data('plugin_' + pluginName);
};
var hideAllPop = function() {
var pop = null;
for (var i = 0; i < _srcElements.length; i++) {
pop = getPopFromElement(_srcElements[i]);
if (pop) {
pop.hide(true);
}
}
$document.trigger('hiddenAll.' + pluginType);
};
var hideOtherPops = function(currentPop) {
var pop = null;
for (var i = 0; i < _srcElements.length; i++) {
pop = getPopFromElement(_srcElements[i]);
if (pop && pop.id !== currentPop.id) {
pop.hide(true);
}
}
$document.trigger('hiddenAll.' + pluginType);
};
var isMobile = ('ontouchstart' in document.documentElement) && (/Mobi/.test(navigator.userAgent));
var pointerEventToXY = function(e) {
var out = {
x: 0,
y: 0
};
if (e.type === 'touchstart' || e.type === 'touchmove' || e.type === 'touchend' || e.type === 'touchcancel') {
var touch = e.originalEvent.touches[0] || e.originalEvent.changedTouches[0];
out.x = touch.pageX;
out.y = touch.pageY;
} else if (e.type === 'mousedown' || e.type === 'mouseup' || e.type === 'click') {
out.x = e.pageX;
out.y = e.pageY;
}
return out;
};
// The actual plugin constructor
function WebuiPopover(element, options) {
this.$element = $(element);
if (options) {
if ($.type(options.delay) === 'string' || $.type(options.delay) === 'number') {
options.delay = {
show: options.delay,
hide: options.delay
}; // bc break fix
}
}
this.options = $.extend({}, defaults, options);
this._defaults = defaults;
this._name = pluginName;
this._targetclick = false;
this.init();
_srcElements.push(this.$element);
return this;
}
WebuiPopover.prototype = {
//init webui popover
init: function() {
if (this.$element[0] instanceof document.constructor && !this.options.selector) {
throw new Error('`selector` option must be specified when initializing ' + this.type + ' on the window.document object!');
}
if (this.getTrigger() !== 'manual') {
//init the event handlers
if (this.getTrigger() === 'click' || isMobile) {
this.$element.off('click touchend', this.options.selector).on('click touchend', this.options.selector, $.proxy(this.toggle, this));
} else if (this.getTrigger() === 'hover') {
this.$element
.off('mouseenter mouseleave click', this.options.selector)
.on('mouseenter', this.options.selector, $.proxy(this.mouseenterHandler, this))
.on('mouseleave', this.options.selector, $.proxy(this.mouseleaveHandler, this));
}
}
this._poped = false;
this._inited = true;
this._opened = false;
this._idSeed = _globalIdSeed;
this.id = pluginName + this._idSeed;
// normalize container
this.options.container = $(this.options.container || document.body).first();
if (this.options.backdrop) {
backdrop.appendTo(this.options.container).hide();
}
_globalIdSeed++;
if (this.getTrigger() === 'sticky') {
this.show();
}
if (this.options.selector) {
this._options = $.extend({}, this.options, {
selector: ''
});
}
},
/* api methods and actions */
destroy: function() {
var index = -1;
for (var i = 0; i < _srcElements.length; i++) {
if (_srcElements[i] === this.$element) {
index = i;
break;
}
}
_srcElements.splice(index, 1);
this.hide();
this.$element.data('plugin_' + pluginName, null);
if (this.getTrigger() === 'click') {
this.$element.off('click');
} else if (this.getTrigger() === 'hover') {
this.$element.off('mouseenter mouseleave');
}
if (this.$target) {
this.$target.remove();
}
},
getDelegateOptions: function() {
var options = {};
this._options && $.each(this._options, function(key, value) {
if (defaults[key] !== value) {
options[key] = value;
}
});
return options;
},
/*
param: force boolean value, if value is true then force hide the popover
param: event dom event,
*/
hide: function(force, event) {
if (!force && this.getTrigger() === 'sticky') {
return;
}
if (!this._opened) {
return;
}
if (event) {
event.preventDefault();
event.stopPropagation();
}
if (this.xhr && this.options.abortXHR === true) {
this.xhr.abort();
this.xhr = null;
}
var e = $.Event('hide.' + pluginType);
this.$element.trigger(e, [this.$target]);
if (this.$target) {
this.$target.removeClass('in').addClass(this.getHideAnimation());
var that = this;
setTimeout(function() {
that.$target.hide();
if (!that.getCache()) {
that.$target.remove();
}
}, that.getHideDelay());
}
if (this.options.backdrop) {
backdrop.hide();
}
this._opened = false;
this.$element.trigger('hidden.' + pluginType, [this.$target]);
if (this.options.onHide) {
this.options.onHide(this.$target);
}
},
resetAutoHide: function() {
var that = this;
var autoHide = that.getAutoHide();
if (autoHide) {
if (that.autoHideHandler) {
clearTimeout(that.autoHideHandler);
}
that.autoHideHandler = setTimeout(function() {
that.hide();
}, autoHide);
}
},
delegate: function(eventTarget) {
var self = $(eventTarget).data('plugin_' + pluginName);
if (!self) {
self = new WebuiPopover(eventTarget, this.getDelegateOptions());
$(eventTarget).data('plugin_' + pluginName, self);
}
return self;
},
toggle: function(e) {
var self = this;
if (e) {
e.preventDefault();
e.stopPropagation();
if (this.options.selector) {
self = this.delegate(e.currentTarget);
}
}
self[self.getTarget().hasClass('in') ? 'hide' : 'show']();
},
hideAll: function() {
hideAllPop();
},
hideOthers: function() {
hideOtherPops(this);
},
/*core method ,show popover */
show: function() {
if (this._opened) {
return;
}
//removeAllTargets();
var
$target = this.getTarget().removeClass().addClass(pluginClass).addClass(this._customTargetClass);
if (!this.options.multi) {
this.hideOthers();
}
// use cache by default, if not cache setted , reInit the contents
if (!this.getCache() || !this._poped || this.content === '') {
this.content = '';
this.setTitle(this.getTitle());
if (!this.options.closeable) {
$target.find('.close').off('click').remove();
}
if (!this.isAsync()) {
this.setContent(this.getContent());
} else {
this.setContentASync(this.options.content);
}
if (this.canEmptyHide() && this.content === '') {
return;
}
$target.show();
}
this.displayContent();
if (this.options.onShow) {
this.options.onShow($target);
}
this.bindBodyEvents();
if (this.options.backdrop) {
backdrop.show();
}
this._opened = true;
this.resetAutoHide();
},
displayContent: function() {
var
//element postion
elementPos = this.getElementPosition(),
//target postion
$target = this.getTarget().removeClass().addClass(pluginClass).addClass(this._customTargetClass),
//target content
$targetContent = this.getContentElement(),
//target Width
targetWidth = $target[0].offsetWidth,
//target Height
targetHeight = $target[0].offsetHeight,
//placement
placement = 'bottom',
e = $.Event('show.' + pluginType);
if (this.canEmptyHide()) {
var content = $targetContent.children().html();
if (content !== null && content.trim().length === 0) {
return;
}
}
//if (this.hasContent()){
this.$element.trigger(e, [$target]);
//}
// support width as data attribute
var optWidth = this.$element.data('width') || this.options.width;
if (optWidth === '') {
optWidth = this._defaults.width;
}
if (optWidth !== 'auto') {
$target.width(optWidth);
}
// support height as data attribute
var optHeight = this.$element.data('height') || this.options.height;
if (optHeight === '') {
optHeight = this._defaults.height;
}
if (optHeight !== 'auto') {
$targetContent.height(optHeight);
}
if (this.options.style) {
this.$target.addClass(pluginClass + '-' + this.options.style);
}
//check rtl
if (this.options.direction === 'rtl' && !$targetContent.hasClass(rtlClass)) {
$targetContent.addClass(rtlClass);
}
//init the popover and insert into the document body
if (!this.options.arrow) {
$target.find('.webui-arrow').remove();
}
$target.detach().css({
top: _offsetOut,
left: _offsetOut,
display: 'block'
});
if (this.getAnimation()) {
$target.addClass(this.getAnimation());
}
$target.appendTo(this.options.container);
placement = this.getPlacement(elementPos);
//This line is just for compatible with knockout custom binding
this.$element.trigger('added.' + pluginType);
this.initTargetEvents();
if (!this.options.padding) {
if (this.options.height !== 'auto') {
$targetContent.css('height', $targetContent.outerHeight());
}
this.$target.addClass('webui-no-padding');
}
targetWidth = $target[0].offsetWidth;
targetHeight = $target[0].offsetHeight;
var postionInfo = this.getTargetPositin(elementPos, placement, targetWidth, targetHeight);
this.$target.css(postionInfo.position).addClass(placement).addClass('in');
if (this.options.type === 'iframe') {
var $iframe = $target.find('iframe');
var iframeWidth = $target.width();
var iframeHeight = $iframe.parent().height();
if (this.options.iframeOptions.width !== '' && this.options.iframeOptions.width !== 'auto') {
iframeWidth = this.options.iframeOptions.width;
}
if (this.options.iframeOptions.height !== '' && this.options.iframeOptions.height !== 'auto') {
iframeHeight = this.options.iframeOptions.height;
}
$iframe.width(iframeWidth).height(iframeHeight);
}
if (!this.options.arrow) {
this.$target.css({
'margin': 0
});
}
if (this.options.arrow) {
var $arrow = this.$target.find('.webui-arrow');
$arrow.removeAttr('style');
//prevent arrow change by content size
if (placement === 'left' || placement === 'right') {
$arrow.css({
top: this.$target.height() / 2
});
} else if (placement === 'top' || placement === 'bottom') {
$arrow.css({
left: this.$target.width() / 2
});
}
if (postionInfo.arrowOffset) {
//hide the arrow if offset is negative
if (postionInfo.arrowOffset.left === -1 || postionInfo.arrowOffset.top === -1) {
$arrow.hide();
} else {
$arrow.css(postionInfo.arrowOffset);
}
}
}
this._poped = true;
this.$element.trigger('shown.' + pluginType, [this.$target]);
},
isTargetLoaded: function() {
return this.getTarget().find('i.glyphicon-refresh').length === 0;
},
/*getter setters */
getTriggerElement: function() {
return this.$element;
},
getTarget: function() {
if (!this.$target) {
var id = pluginName + this._idSeed;
this.$target = $(this.options.template)
.attr('id', id);
this._customTargetClass = this.$target.attr('class') !== pluginClass ? this.$target.attr('class') : null;
this.getTriggerElement().attr('data-target', id);
}
if (!this.$target.data('trigger-element')) {
this.$target.data('trigger-element', this.getTriggerElement());
}
return this.$target;
},
removeTarget: function() {
this.$target.remove();
this.$target = null;
this.$contentElement = null;
},
getTitleElement: function() {
return this.getTarget().find('.' + pluginClass + '-title');
},
getContentElement: function() {
if (!this.$contentElement) {
this.$contentElement = this.getTarget().find('.' + pluginClass + '-content');
}
return this.$contentElement;
},
getTitle: function() {
return this.$element.attr('data-title') || this.options.title || this.$element.attr('title');
},
getUrl: function() {
return this.$element.attr('data-url') || this.options.url;
},
getAutoHide: function() {
return this.$element.attr('data-auto-hide') || this.options.autoHide;
},
getOffsetTop: function() {
return toNumber(this.$element.attr('data-offset-top')) || this.options.offsetTop;
},
getOffsetLeft: function() {
return toNumber(this.$element.attr('data-offset-left')) || this.options.offsetLeft;
},
getCache: function() {
var dataAttr = this.$element.attr('data-cache');
if (typeof(dataAttr) !== 'undefined') {
switch (dataAttr.toLowerCase()) {
case 'true':
case 'yes':
case '1':
return true;
case 'false':
case 'no':
case '0':
return false;
}
}
return this.options.cache;
},
getTrigger: function() {
return this.$element.attr('data-trigger') || this.options.trigger;
},
getDelayShow: function() {
var dataAttr = this.$element.attr('data-delay-show');
if (typeof(dataAttr) !== 'undefined') {
return dataAttr;
}
return this.options.delay.show === 0 ? 0 : this.options.delay.show || 100;
},
getHideDelay: function() {
var dataAttr = this.$element.attr('data-delay-hide');
if (typeof(dataAttr) !== 'undefined') {
return dataAttr;
}
return this.options.delay.hide === 0 ? 0 : this.options.delay.hide || 100;
},
getAnimation: function() {
var dataAttr = this.$element.attr('data-animation');
return dataAttr || this.options.animation;
},
getHideAnimation: function() {
var ani = this.getAnimation();
return ani ? ani + '-out' : 'out';
},
setTitle: function(title) {
var $titleEl = this.getTitleElement();
if (title) {
//check rtl
if (this.options.direction === 'rtl' && !$titleEl.hasClass(rtlClass)) {
$titleEl.addClass(rtlClass);
}
$titleEl.html(title);
} else {
$titleEl.remove();
}
},
hasContent: function() {
return this.getContent();
},
canEmptyHide: function() {
return this.options.hideEmpty && this.options.type === 'html';
},
getIframe: function() {
var $iframe = $('<iframe></iframe>').attr('src', this.getUrl());
var self = this;
$.each(this._defaults.iframeOptions, function(opt) {
if (typeof self.options.iframeOptions[opt] !== 'undefined') {
$iframe.attr(opt, self.options.iframeOptions[opt]);
}
});
return $iframe;
},
getContent: function() {
if (this.getUrl()) {
switch (this.options.type) {
case 'iframe':
this.content = this.getIframe();
break;
case 'html':
try {
this.content = $(this.getUrl());
if (!this.content.is(':visible')) {
this.content.show();
}
} catch (error) {
throw new Error('Unable to get popover content. Invalid selector specified.');
}
break;
}
} else if (!this.content) {
var content = '';
if ($.isFunction(this.options.content)) {
content = this.options.content.apply(this.$element[0], [this]);
} else {
content = this.options.content;
}
this.content = this.$element.attr('data-content') || content;
if (!this.content) {
var $next = this.$element.next();
if ($next && $next.hasClass(pluginClass + '-content')) {
this.content = $next;
}
}
}
return this.content;
},
setContent: function(content) {
var $target = this.getTarget();
var $ct = this.getContentElement();
if (typeof content === 'string') {
$ct.html(content);
} else if (content instanceof $) {
$ct.html('');
//Don't want to clone too many times.
if (!this.options.cache) {
content.clone(true, true).removeClass(pluginClass + '-content').appendTo($ct);
} else {
content.removeClass(pluginClass + '-content').appendTo($ct);
}
}
this.$target = $target;
},
isAsync: function() {
return this.options.type === 'async';
},
setContentASync: function(content) {
var that = this;
if (this.xhr) {
return;
}
this.xhr = $.ajax({
url: this.getUrl(),
type: this.options.async.type,
cache: this.getCache(),
beforeSend: function(xhr) {
if (that.options.async.before) {
that.options.async.before(that, xhr);
}
},
success: function(data) {
that.bindBodyEvents();
if (content && $.isFunction(content)) {
that.content = content.apply(that.$element[0], [data]);
} else {
that.content = data;
}
that.setContent(that.content);
var $targetContent = that.getContentElement();
$targetContent.removeAttr('style');
that.displayContent();
if (that.options.async.success) {
that.options.async.success(that, data);
}
},
complete: function() {
that.xhr = null;
},
error: function(xhr, data) {
if (that.options.async.error) {
that.options.async.error(that, xhr, data);
}
}
});
},
bindBodyEvents: function() {
if (_isBodyEventHandled) {
return;
}
if (this.options.dismissible && this.getTrigger() === 'click') {
$document.off('keyup.webui-popover').on('keyup.webui-popover', $.proxy(this.escapeHandler, this));
$document.off('click.webui-popover touchend.webui-popover')
.on('click.webui-popover touchend.webui-popover', $.proxy(this.bodyClickHandler, this));
} else if (this.getTrigger() === 'hover') {
$document.off('touchend.webui-popover')
.on('touchend.webui-popover', $.proxy(this.bodyClickHandler, this));
}
},
/* event handlers */
mouseenterHandler: function(e) {
var self = this;
if (e && this.options.selector) {
self = this.delegate(e.currentTarget);
}
if (self._timeout) {
clearTimeout(self._timeout);
}
self._enterTimeout = setTimeout(function() {
if (!self.getTarget().is(':visible')) {
self.show();
}
}, this.getDelayShow());
},
mouseleaveHandler: function() {
var self = this;
clearTimeout(self._enterTimeout);
//key point, set the _timeout then use clearTimeout when mouse leave
self._timeout = setTimeout(function() {
self.hide();
}, this.getHideDelay());
},
escapeHandler: function(e) {
if (e.keyCode === 27) {
this.hideAll();
}
},
bodyClickHandler: function(e) {
_isBodyEventHandled = true;
var canHide = true;
for (var i = 0; i < _srcElements.length; i++) {
var pop = getPopFromElement(_srcElements[i]);
if (pop && pop._opened) {
var offset = pop.getTarget().offset();
var popX1 = offset.left;
var popY1 = offset.top;
var popX2 = offset.left + pop.getTarget().width();
var popY2 = offset.top + pop.getTarget().height();
var pt = pointerEventToXY(e);
var inPop = pt.x >= popX1 && pt.x <= popX2 && pt.y >= popY1 && pt.y <= popY2;
if (inPop) {
canHide = false;
break;
}
}
}
if (canHide) {
hideAllPop();
}
},
/*
targetClickHandler: function() {
this._targetclick = true;
},
*/
//reset and init the target events;
initTargetEvents: function() {
if (this.getTrigger() === 'hover') {
this.$target
.off('mouseenter mouseleave')
.on('mouseenter', $.proxy(this.mouseenterHandler, this))
.on('mouseleave', $.proxy(this.mouseleaveHandler, this));
}
this.$target.find('.close').off('click').on('click', $.proxy(this.hide, this, true));
//this.$target.off('click.webui-popover').on('click.webui-popover', $.proxy(this.targetClickHandler, this));
},
/* utils methods */
//caculate placement of the popover
getPlacement: function(pos) {
var
placement,
container = this.options.container,
clientWidth = container.innerWidth(),
clientHeight = container.innerHeight(),
scrollTop = container.scrollTop(),
scrollLeft = container.scrollLeft(),
pageX = Math.max(0, pos.left - scrollLeft),
pageY = Math.max(0, pos.top - scrollTop);
//arrowSize = 20;
//if placement equals auto，caculate the placement by element information;
if (typeof(this.options.placement) === 'function') {
placement = this.options.placement.call(this, this.getTarget()[0], this.$element[0]);
} else {
placement = this.$element.data('placement') || this.options.placement;
}
var isH = placement === 'horizontal';
var isV = placement === 'vertical';
var detect = placement === 'auto' || isH || isV;
if (detect) {
if (pageX < clientWidth / 3) {
if (pageY < clientHeight / 3) {
placement = isH ? 'right-bottom' : 'bottom-right';
} else if (pageY < clientHeight * 2 / 3) {
if (isV) {
placement = pageY <= clientHeight / 2 ? 'bottom-right' : 'top-right';
} else {
placement = 'right';
}
} else {
placement = isH ? 'right-top' : 'top-right';
}
//placement= pageY>targetHeight+arrowSize?'top-right':'bottom-right';
} else if (pageX < clientWidth * 2 / 3) {
if (pageY < clientHeight / 3) {
if (isH) {
placement = pageX <= clientWidth / 2 ? 'right-bottom' : 'left-bottom';
} else {
placement = 'bottom';
}
} else if (pageY < clientHeight * 2 / 3) {
if (isH) {
placement = pageX <= clientWidth / 2 ? 'right' : 'left';
} else {
placement = pageY <= clientHeight / 2 ? 'bottom' : 'top';
}
} else {
if (isH) {
placement = pageX <= clientWidth / 2 ? 'right-top' : 'left-top';
} else {
placement = 'top';
}
}
} else {
//placement = pageY>targetHeight+arrowSize?'top-left':'bottom-left';
if (pageY < clientHeight / 3) {
placement = isH ? 'left-bottom' : 'bottom-left';
} else if (pageY < clientHeight * 2 / 3) {
if (isV) {
placement = pageY <= clientHeight / 2 ? 'bottom-left' : 'top-left';
} else {
placement = 'left';
}
} else {
placement = isH ? 'left-top' : 'top-left';
}
}
} else if (placement === 'auto-top') {
if (pageX < clientWidth / 3) {
placement = 'top-right';
} else if (pageX < clientWidth * 2 / 3) {
placement = 'top';
} else {
placement = 'top-left';
}
} else if (placement === 'auto-bottom') {
if (pageX < clientWidth / 3) {
placement = 'bottom-right';
} else if (pageX < clientWidth * 2 / 3) {
placement = 'bottom';
} else {
placement = 'bottom-left';
}
} else if (placement === 'auto-left') {
if (pageY < clientHeight / 3) {
placement = 'left-top';
} else if (pageY < clientHeight * 2 / 3) {
placement = 'left';
} else {
placement = 'left-bottom';
}
} else if (placement === 'auto-right') {
if (pageY < clientHeight / 3) {
placement = 'right-bottom';
} else if (pageY < clientHeight * 2 / 3) {
placement = 'right';
} else {
placement = 'right-top';
}
}
return placement;
},
getElementPosition: function() {
// If the container is the body or normal conatiner, just use $element.offset()
var elRect = this.$element[0].getBoundingClientRect();
var container = this.options.container;
var cssPos = container.css('position');
if (container.is(document.body) || cssPos === 'static') {
return $.extend({}, this.$element.offset(), {
width: this.$element[0].offsetWidth || elRect.width,
height: this.$element[0].offsetHeight || elRect.height
});
// Else fixed container need recalculate the position
} else if (cssPos === 'fixed') {
var containerRect = container[0].getBoundingClientRect();
return {
top: elRect.top - containerRect.top + container.scrollTop(),
left: elRect.left - containerRect.left + container.scrollLeft(),
width: elRect.width,
height: elRect.height
};
} else if (cssPos === 'relative') {
return {
top: this.$element.offset().top - container.offset().top,
left: this.$element.offset().left - container.offset().left,
width: this.$element[0].offsetWidth || elRect.width,
height: this.$element[0].offsetHeight || elRect.height
};
}
},
getTargetPositin: function(elementPos, placement, targetWidth, targetHeight) {
var pos = elementPos,
container = this.options.container,
//clientWidth = container.innerWidth(),
//clientHeight = container.innerHeight(),
elementW = this.$element.outerWidth(),
elementH = this.$element.outerHeight(),
scrollTop = document.documentElement.scrollTop + container.scrollTop(),
scrollLeft = document.documentElement.scrollLeft + container.scrollLeft(),
position = {},
arrowOffset = null,
arrowSize = this.options.arrow ? 20 : 0,
padding = 10,
fixedW = elementW < arrowSize + padding ? arrowSize : 0,
fixedH = elementH < arrowSize + padding ? arrowSize : 0,
refix = 0,
pageH = document.documentElement.clientHeight + scrollTop,
pageW = document.documentElement.clientWidth + scrollLeft;
var validLeft = pos.left + pos.width / 2 - fixedW > 0;
var validRight = pos.left + pos.width / 2 + fixedW < pageW;
var validTop = pos.top + pos.height / 2 - fixedH > 0;
var validBottom = pos.top + pos.height / 2 + fixedH < pageH;
switch (placement) {
case 'bottom':
position = {
top: pos.top + pos.height,
left: pos.left + pos.width / 2 - targetWidth / 2
};
break;
case 'top':
position = {
top: pos.top - targetHeight,
left: pos.left + pos.width / 2 - targetWidth / 2
};
break;
case 'left':
position = {
top: pos.top + pos.height / 2 - targetHeight / 2,
left: pos.left - targetWidth
};
break;
case 'right':
position = {
top: pos.top + pos.height / 2 - targetHeight / 2,
left: pos.left + pos.width
};
break;
case 'top-right':
position = {
top: pos.top - targetHeight,
left: validLeft ? pos.left - fixedW : padding
};
arrowOffset = {
left: validLeft ? Math.min(elementW, targetWidth) / 2 + fixedW : _offsetOut
};
break;
case 'top-left':
refix = validRight ? fixedW : -padding;
position = {
top: pos.top - targetHeight,
left: pos.left - targetWidth + pos.width + refix
};
arrowOffset = {
left: validRight ? targetWidth - Math.min(elementW, targetWidth) / 2 - fixedW : _offsetOut
};
break;
case 'bottom-right':
position = {
top: pos.top + pos.height,
left: validLeft ? pos.left - fixedW : padding
};
arrowOffset = {
left: validLeft ? Math.min(elementW, targetWidth) / 2 + fixedW : _offsetOut
};
break;
case 'bottom-left':
refix = validRight ? fixedW : -padding;
position = {
top: pos.top + pos.height,
left: pos.left - targetWidth + pos.width + refix
};
arrowOffset = {
left: validRight ? targetWidth - Math.min(elementW, targetWidth) / 2 - fixedW : _offsetOut
};
break;
case 'right-top':
refix = validBottom ? fixedH : -padding;
position = {
top: pos.top - targetHeight + pos.height + refix,
left: pos.left + pos.width
};
arrowOffset = {
top: validBottom ? targetHeight - Math.min(elementH, targetHeight) / 2 - fixedH : _offsetOut
};
break;
case 'right-bottom':
position = {
top: validTop ? pos.top - fixedH : padding,
left: pos.left + pos.width
};
arrowOffset = {
top: validTop ? Math.min(elementH, targetHeight) / 2 + fixedH : _offsetOut
};
break;
case 'left-top':
refix = validBottom ? fixedH : -padding;
position = {
top: pos.top - targetHeight + pos.height + refix,
left: pos.left - targetWidth
};
arrowOffset = {
top: validBottom ? targetHeight - Math.min(elementH, targetHeight) / 2 - fixedH : _offsetOut
};
break;
case 'left-bottom':
position = {
top: validTop ? pos.top - fixedH : padding,
left: pos.left - targetWidth
};
arrowOffset = {
top: validTop ? Math.min(elementH, targetHeight) / 2 + fixedH : _offsetOut
};
break;
}
position.top += this.getOffsetTop();
position.left += this.getOffsetLeft();
return {
position: position,
arrowOffset: arrowOffset
};
}
};
$.fn[pluginName] = function(options, noInit) {
var results = [];
var $result = this.each(function() {
var webuiPopover = $.data(this, 'plugin_' + pluginName);
if (!webuiPopover) {
if (!options) {
webuiPopover = new WebuiPopover(this, null);
} else if (typeof options === 'string') {
if (options !== 'destroy') {
if (!noInit) {
webuiPopover = new WebuiPopover(this, null);
results.push(webuiPopover[options]());
}
}
} else if (typeof options === 'object') {
webuiPopover = new WebuiPopover(this, options);
}
$.data(this, 'plugin_' + pluginName, webuiPopover);
} else {
if (options === 'destroy') {
webuiPopover.destroy();
} else if (typeof options === 'string') {
results.push(webuiPopover[options]());
}
}
});
return (results.length) ? results : $result;
};
//Global object exposes to window.
var webuiPopovers = (function() {
var _hideAll = function() {
hideAllPop();
};
var _create = function(selector, options) {
options = options || {};
$(selector).webuiPopover(options);
};
var _isCreated = function(selector) {
var created = true;
$(selector).each(function(item) {
created = created && $(item).data('plugin_' + pluginName) !== undefined;
});
return created;
};
var _show = function(selector, options) {
if (options) {
$(selector).webuiPopover(options).webuiPopover('show');
} else {
$(selector).webuiPopover('show');
}
};
var _hide = function(selector) {
$(selector).webuiPopover('hide');
};
var _updateContent = function(selector, content) {
var pop = $(selector).data('plugin_' + pluginName);
if (pop) {
var cache = pop.getCache();
pop.options.cache = false;
pop.options.content = content;
if (pop._opened) {
pop._opened = false;
pop.show();
} else {
if (pop.isAsync()) {
pop.setContentASync(content);
} else {
pop.setContent(content);
}
}
pop.options.cache = cache;
}
};
return {
show: _show,
hide: _hide,
create: _create,
isCreated: _isCreated,
hideAll: _hideAll,
updateContent: _updateContent
};
})();
window.WebuiPopovers = webuiPopovers;
}));
})(window, document);
================================================
FILE: babel.config.js
================================================
/**
* Babel config
*
* @package LifterLMS/Dev/Scripts
*
* @since Unknown
* @version 6.0.0
*/
const
presets = [ '@wordpress/default' ],
plugins = [ '@babel/plugin-proposal-class-properties' ];
module.exports = { plugins, presets };
================================================
FILE: class-lifterlms.php
================================================
<?php
/**
* Main LifterLMS class
*
* @package LifterLMS/Main
*
* @since 1.0.0
* @version 7.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Main LifterLMS Class
*
* @since 1.0.0
* @since 3.32.0 Update action-scheduler to latest version; load staging class on the admin panel.
* @since 3.34.0 Include the LLMS_Admin_Users_Table class.
* @since 3.36.0 Added events classes and methods.
* @since 3.36.1 Include SendWP Connector.
* @since 3.37.0 Move theme support methods to LLMS_Theme_Support.
* @since 3.38.1 Include LLMS_Mime_Type_Extractor class.
* @since 4.0.0 Update session management.
* Remove deprecated class files and variables.
* Move includes (file loading) into the LLMS_Loader class.
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
*/
final class LifterLMS {
use LLMS_Trait_Singleton;
/**
* LifterLMS Plugin Version.
*
* @var string
*/
public $version = '10.0.0';
/**
* LLMS_Assets instance
*
* @var LLMS_Assets
*/
public $assets = null;
/**
* LLMS_Query instance
*
* @var LLMS_Query
*/
public $query = null;
/**
* Session instance
*
* @var LLMS_Session
*/
public $session = null;
/**
* LifterLMS Constructor.
*
* @since 1.0.0
* @since 3.21.1 Unknown
* @since 4.0.0 Load `$this->session` at `plugins_loaded` in favor of during class construction.
* Remove deprecated `__autoload()` & initialize new file loader class.
* @since 4.13.0 Check site duplicate status on `admin_init`.
* @since 5.3.0 Move the loading of the LifterLMS autoloader to the main `lifterlms.php` file.
* @since 6.1.0 Automatically load payment gateways.
* @since 6.4.0 Moved registration of `LLMS_Shortcodes::init()` with the 'init' hook to `LLMS_Shortcodes::__construct()`.
* @since 7.6.0 Lood locale textdomain on `init` instead of immediately
*
* @return void
*/
private function __construct() {
$this->define_constants();
$this->init_assets();
$this->query = new LLMS_Query();
// Hooks.
add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), array( $this, 'add_action_links' ), 10, 1 );
add_action( 'init', array( $this, 'localize' ), 0 );
add_action( 'init', array( $this, 'init' ), 0 );
add_action( 'init', array( $this, 'integrations' ), 1 );
add_action( 'init', array( $this, 'processors' ), 5 );
add_action( 'init', array( $this, 'events' ), 5 );
add_action( 'init', array( $this, 'init_session' ), 6 ); // After table installation which happens at init 5.
add_action( 'init', array( $this, 'payment_gateways' ) );
add_action( 'init', array( $this, 'include_template_functions' ) );
add_action( 'admin_init', array( 'LLMS_Site', 'check_status' ) );
// Tracking.
if ( defined( 'DOING_CRON' ) && DOING_CRON && 'yes' === get_option( 'llms_allow_tracking', 'no' ) ) {
LLMS_Tracker::init();
}
/**
* Action fired after LifterLMS is fully loaded.
*
* @since Unknown
*/
do_action( 'lifterlms_loaded' );
}
/**
* Define LifterLMS Constants
*
* @since 1.0.0
* @since 3.17.8 Added `LLMS_PLUGIN_URL` && `LLMS_ASSETS_SUFFIX`.
* @since 4.0.0 Moved definitions of `LLMS_PLUGIN_FILE` and `LLMS_PLUGIN_DIR` to the main `lifterlms.php` file.
* Use `llms_maybe_define_constant()` to reduce code complexity.
* @since 7.2.0 Added `LLMS_ASSETS_VERSION` constant.
* @since 7.7.0 Added `LLMS_ALLOWED_HTML_PRICES` constant.
*
* @return void
*/
private function define_constants() {
llms_maybe_define_constant( 'LLMS_VERSION', $this->version );
llms_maybe_define_constant( 'LLMS_TEMPLATE_PATH', $this->template_path() );
llms_maybe_define_constant( 'LLMS_PLUGIN_URL', plugin_dir_url( LLMS_PLUGIN_FILE ) );
$upload_dir = wp_upload_dir();
llms_maybe_define_constant( 'LLMS_LOG_DIR', $upload_dir['basedir'] . '/llms-logs/' );
llms_maybe_define_constant( 'LLMS_TMP_DIR', $upload_dir['basedir'] . '/llms-tmp/' );
// If we're loading in debug mode.
$script_debug = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG;
$wp_debug = defined( 'WP_DEBUG' ) && WP_DEBUG;
// If debugging, load the unminified version otherwise load minified.
if ( ! defined( 'LLMS_ASSETS_SUFFIX' ) ) {
define( 'LLMS_ASSETS_SUFFIX', $script_debug ? '' : '.min' );
}
// If debugging, use time for asset version otherwise use plugin version.
if ( ! defined( 'LLMS_ASSETS_VERSION' ) ) {
define( 'LLMS_ASSETS_VERSION', ( $script_debug || $wp_debug ) ? time() : $this->version );
}
$allowed_atts = array(
'label' => true,
'align' => true,
'checked' => true,
'border' => true,
'decoding' => true,
'disabled' => true,
'required' => true,
'allowfullscreen' => true,
'allow' => true,
'frameborder' => true,
'class' => true,
'type' => true,
'id' => true,
'dir' => true,
'lang' => true,
'style' => true,
'xml:lang' => true,
'src' => true,
'alt' => true,
'href' => true,
'rel' => true,
'rev' => true,
'onclick' => true,
'target' => true,
'novalidate' => true,
'value' => true,
'name' => true,
'tabindex' => true,
'action' => true,
'method' => true,
'for' => true,
'width' => true,
'height' => true,
'data-*' => true,
'aria-label' => true,
'aria-live' => true,
'aria-hidden' => true,
'aria-*' => true,
'title' => true,
'placeholder' => true,
'readonly' => true,
'rows' => true,
'cols' => true,
'minlength' => true,
'maxlength' => true,
'pattern' => true,
'enctype' => true,
'role' => true,
'selected' => true,
'srcset' => true,
'accept' => true,
'accept-charset' => true,
'accesskey' => true,
'autocomplete' => true,
'autofocus' => true,
'colspan' => true,
'contenteditable' => true,
'contextmenu' => true,
'controls' => true,
'coords' => true,
'datetime' => true,
'dirname' => true,
'download' => true,
'draggable' => true,
'dropzone' => true,
'form' => true,
'formaction' => true,
'formenctype' => true,
'formmethod' => true,
'formnovalidate' => true,
'formtarget' => true,
'headers' => true,
'hidden' => true,
'high' => true,
'hreflang' => true,
'http-equiv' => true,
'ismap' => true,
'list' => true,
'loop' => true,
'low' => true,
'max' => true,
'media' => true,
'min' => true,
'multiple' => true,
'muted' => true,
'open' => true,
'optimum' => true,
'poster' => true,
'preload' => true,
'reversed' => true,
'rowspan' => true,
'scope' => true,
'shape' => true,
'size' => true,
'span' => true,
'spellcheck' => true,
'srcdoc' => true,
'srclang' => true,
'start' => true,
'step' => true,
'translate' => true,
'usemap' => true,
'wrap' => true,
'ping' => true,
'referrerpolicy' => true,
'sandbox' => true,
'sizes' => true,
);
// For use in escaping and sanitizing.
llms_maybe_define_constant(
'LLMS_ALLOWED_HTML_PRICES',
array(
'div' => $allowed_atts,
'span' => $allowed_atts,
'strong' => $allowed_atts,
'sup' => $allowed_atts,
'sub' => $allowed_atts,
'del' => $allowed_atts,
'ins' => $allowed_atts,
'em' => $allowed_atts,
'bdi' => $allowed_atts,
's' => $allowed_atts,
'u' => $allowed_atts,
)
);
// Defining ourselves rather than relying on wp_kses_allowed_html( 'post' ) because it could be filtered.
$allowed_post_fields = array(
'address' => array(),
'a' => array(
'href' => true,
'rel' => true,
'rev' => true,
'name' => true,
'target' => true,
'download' => array(
'valueless' => 'y',
),
),
'abbr' => array(),
'acronym' => array(),
'area' => array(
'alt' => true,
'coords' => true,
'href' => true,
'nohref' => true,
'shape' => true,
'target' => true,
),
'article' => array(
'align' => true,
),
'aside' => array(
'align' => true,
),
'audio' => array(
'autoplay' => true,
'controls' => true,
'loop' => true,
'muted' => true,
'preload' => true,
'src' => true,
),
'b' => array(),
'bdo' => array(),
'big' => array(),
'blockquote' => array(
'cite' => true,
),
'br' => array(),
'button' => array(
'disabled' => true,
'name' => true,
'type' => true,
'value' => true,
),
'caption' => array(
'align' => true,
),
'cite' => array(),
'code' => array(),
'col' => array(
'align' => true,
'char' => true,
'charoff' => true,
'span' => true,
'valign' => true,
'width' => true,
),
'colgroup' => array(
'align' => true,
'char' => true,
'charoff' => true,
'span' => true,
'valign' => true,
'width' => true,
),
'del' => array(
'datetime' => true,
),
'dd' => array(),
'dfn' => array(),
'details' => array(
'align' => true,
'open' => true,
),
'div' => array(
'align' => true,
),
'dl' => array(),
'dt' => array(),
'em' => array(),
'fieldset' => array(),
'figure' => array(
'align' => true,
),
'figcaption' => array(
'align' => true,
),
'font' => array(
'color' => true,
'face' => true,
'size' => true,
),
'footer' => array(
'align' => true,
),
'h1' => array(
'align' => true,
),
'h2' => array(
'align' => true,
),
'h3' => array(
'align' => true,
),
'h4' => array(
'align' => true,
),
'h5' => array(
'align' => true,
),
'h6' => array(
'align' => true,
),
'header' => array(
'align' => true,
),
'hgroup' => array(
'align' => true,
),
'hr' => array(
'align' => true,
'noshade' => true,
'size' => true,
'width' => true,
),
'i' => array(),
'img' => array(
'alt' => true,
'align' => true,
'border' => true,
'height' => true,
'hspace' => true,
'loading' => true,
'longdesc' => true,
'vspace' => true,
'src' => true,
'usemap' => true,
'width' => true,
),
'ins' => array(
'datetime' => true,
'cite' => true,
),
'kbd' => array(),
'label' => array(
'for' => true,
),
'legend' => array(
'align' => true,
),
'li' => array(
'align' => true,
'value' => true,
),
'main' => array(
'align' => true,
),
'map' => array(
'name' => true,
),
'mark' => array(),
'menu' => array(
'type' => true,
),
'nav' => array(
'align' => true,
),
'object' => array(
'data' => array(
'required' => true,
'value_callback' => '_wp_kses_allow_pdf_objects',
),
'type' => array(
'required' => true,
'values' => array( 'application/pdf' ),
),
),
'p' => array(
'align' => true,
),
'pre' => array(
'width' => true,
),
'q' => array(
'cite' => true,
),
'rb' => array(),
'rp' => array(),
'rt' => array(),
'rtc' => array(),
'ruby' => array(),
's' => array(),
'samp' => array(),
'span' => array(
'align' => true,
),
'section' => array(
'align' => true,
),
'small' => array(),
'strike' => array(),
'strong' => array(),
'sub' => array(),
'summary' => array(
'align' => true,
),
'sup' => array(),
'table' => array(
'align' => true,
'bgcolor' => true,
'border' => true,
'cellpadding' => true,
'cellspacing' => true,
'rules' => true,
'summary' => true,
'width' => true,
),
'tbody' => array(
'align' => true,
'char' => true,
'charoff' => true,
'valign' => true,
),
'td' => array(
'abbr' => true,
'align' => true,
'axis' => true,
'bgcolor' => true,
'char' => true,
'charoff' => true,
'colspan' => true,
'headers' => true,
'height' => true,
'nowrap' => true,
'rowspan' => true,
'scope' => true,
'valign' => true,
'width' => true,
),
'textarea' => array(
'cols' => true,
'rows' => true,
'disabled' => true,
'name' => true,
'readonly' => true,
),
'tfoot' => array(
'align' => true,
'char' => true,
'charoff' => true,
'valign' => true,
),
'th' => array(
'abbr' => true,
'align' => true,
'axis' => true,
'bgcolor' => true,
'char' => true,
'charoff' => true,
'colspan' => true,
'headers' => true,
'height' => true,
'nowrap' => true,
'rowspan' => true,
'scope' => true,
'valign' => true,
'width' => true,
),
'thead' => array(
'align' => true,
'char' => true,
'charoff' => true,
'valign' => true,
),
'title' => array(),
'tr' => array(
'align' => true,
'bgcolor' => true,
'char' => true,
'charoff' => true,
'valign' => true,
),
'track' => array(
'default' => true,
'kind' => true,
'label' => true,
'src' => true,
'srclang' => true,
),
'tt' => array(),
'u' => array(),
'ul' => array(
'type' => true,
),
'ol' => array(
'start' => true,
'type' => true,
'reversed' => true,
),
'var' => array(),
'video' => array(
'autoplay' => true,
'controls' => true,
'height' => true,
'loop' => true,
'muted' => true,
'playsinline' => true,
'poster' => true,
'preload' => true,
'src' => true,
'width' => true,
),
);
foreach ( $allowed_post_fields as $field => $attributes ) {
if ( ! is_array( $attributes ) ) {
continue;
}
$allowed_post_fields[ $field ] = array_merge( $attributes, $allowed_atts );
}
llms_maybe_define_constant(
'LLMS_ALLOWED_HTML_FORM_FIELDS',
array_merge(
$allowed_post_fields,
array(
'bdi' => $allowed_atts,
'iframe' => $allowed_atts,
'form' => $allowed_atts,
'input' => $allowed_atts,
'select' => $allowed_atts,
'option' => $allowed_atts,
'checkbox' => $allowed_atts,
'radio' => $allowed_atts,
'optgroup' => $allowed_atts,
'datalist' => $allowed_atts,
'output' => $allowed_atts,
'progress' => $allowed_atts,
'meter' => $allowed_atts,
'source' => $allowed_atts,
)
)
);
llms_maybe_define_constant( 'LLMS_CONFIRMATION_FIELDS', array( 'email_address_confirm', 'password_confirm' ) );
}
/**
* Load Hooks
*
* @since Unknown
*
* @return void
*/
public function include_template_functions() {
include_once 'includes/llms.template.functions.php';
}
/**
* Init LifterLMS when WordPress Initialises.
*
* @since 1.0.0
* @since 3.21.1 Unknown.
* @since 4.0.0 Don't initialize removed `LLMS_Person()` class.
* @since 4.12.0 Check site staging/duplicate status & trigger associated actions.
* @since 4.13.0 Remove site staging/duplicate check and run only on `admin_init`.
* @since 5.8.0 Initialize block templates.
* @since 7.7.0 Initialize Elementor migration.
*
* @return void
*/
public function init() {
do_action( 'before_lifterlms_init' );
$this->block_templates();
$this->engagements();
$this->notifications();
( new LLMS_Media_Protector() )->register_callbacks();
include_once 'includes/class-llms-elementor-migrate.php';
include_once 'includes/class-llms-bricks.php';
include_once 'includes/class-llms-beaver-builder.php';
include_once 'includes/class-llms-beaver-builder-migrate.php';
do_action( 'lifterlms_init' );
}
/**
* Initialize the core asset handler class.
*
* @since 4.4.0
*
* @return LLMS_Assets
*/
private function init_assets() {
$this->assets = new LLMS_Assets( 'llms-core' );
$this->assets->define( 'scripts', require LLMS_PLUGIN_DIR . 'includes/assets/llms-assets-scripts.php' );
$this->assets->define( 'styles', require LLMS_PLUGIN_DIR . 'includes/assets/llms-assets-styles.php' );
return $this->assets;
}
/**
* Initializes an LLMS_Session() into the $session variable
*
* @since 4.0.0
*
* @return LLMS_Session
*/
public function init_session() {
if ( is_null( $this->session ) ) {
$this->session = new LLMS_Session();
}
return $this->session;
}
/**
* Get the plugin url.
*
* @return string
*/
public function plugin_url() {
return untrailingslashit( plugins_url( '/', __FILE__ ) );
}
/**
* Get the plugin path.
*
* @return string
*/
public function plugin_path() {
return untrailingslashit( plugin_dir_path( __FILE__ ) );
}
/**
* Get the template path.
*
* @return string
*/
public function template_path() {
return apply_filters( 'llms_template_path', 'lifterlms/' );
}
/**
* Retrieve the LLMS_Emails singleton.
*
* @since Unknown
*
* @return LLMS_Emails
*/
public function mailer() {
return LLMS_Emails::instance();
}
/**
* Retrieve the LLMS_Achievements singleton.
*
* @since Unknown
*
* @return LLMS_Achievements
*/
public function achievements() {
return LLMS_Achievements::instance();
}
/**
* Retrieve the LLMS_Certificates singleton.
*
* @since Unknown
*
* @return LLMS_Certificates
*/
public function certificates() {
return LLMS_Certificates::instance();
}
/**
* Retrieve the LLMS_Engagements singleton.
*
* @since Unknown
*
* @return LLMS_Engagements
*/
public function engagements() {
return LLMS_Engagements::instance();
}
/**
* Block templates instance.
*
* @since 5.8.0
*
* @return LLMS_Block_Templates
*/
public function block_templates() {
return LLMS_Block_Templates::instance();
}
/**
* Events instance.
*
* @since 3.36.0
*
* @return LLMS_Events
*/
public function events() {
return LLMS_Events::instance();
}
/**
* Grading instance
*
* @since 3.24.0
*
* @return LLMS_Grades
*/
public function grades() {
return LLMS_Grades::instance();
}
/**
* Get integrations
*
* @return LLMS_Integrations instance
*/
public function integrations() {
return LLMS_Integrations::instance();
}
/**
* Retrieve an instance of the notifications class
*
* @return LLMS_Notifications
* @since 3.8.0
* @version 3.8.0
*/
public function notifications() {
return LLMS_Notifications::instance();
}
/**
* Get payment gateways.
*
* @return LLMS_Payment_Gateways
*/
public function payment_gateways() {
return LLMS_Payment_Gateways::instance();
}
/**
* Load all background processors.
*
* @since 3.15.0
*
* @return LLMS_Processors
*/
public function processors() {
return LLMS_Processors::instance();
}
/**
* Add plugin settings Action Links
*
* @since Unknown
*
* @param string[] $links Existing action links.
* @return string[]
*/
public function add_action_links( $links ) {
$lifter_links = array(
'<a href="' . admin_url( 'admin.php?page=llms-settings' ) . '">' . __( 'Settings', 'lifterlms' ) . '</a>',
);
if ( 3 === count( $links ) ) {
return $links;
}
return array_merge( $links, $lifter_links );
}
/**
* Localize the plugin
*
* Language files can be found in the following locations (The first loaded file takes priority):
*
* 1. wp-content/languages/lifterlms/lifterlms-{LOCALE}.mo
*
* This is recommended "safe" location where custom language files can be stored. A file
* stored in this directory will never be automatically overwritten.
*
* 2. wp-content/languages/plugins/lifterlms-{LOCALE}.mo
*
* This is the default directory where WordPress will download language files from the
* WordPress GlotPress server during updates. If you store a custom language file in this
* directory it will be overwritten during updates.
*
* 3. wp-content/plugins/lifterlms/languages/lifterlms-{LOCALE}.mo
*
* This is the the LifterLMS plugin directory. A language file stored in this directory will
* be removed from the server during a LifterLMS plugin update.
*
* @since Unknown
* @since 4.9.0 Use `llms_load_textdomain()`.
*
* @return void
*/
public function localize() {
llms_load_textdomain( 'lifterlms' );
}
}
================================================
FILE: composer.json
================================================
{
"name": "gocodebox/lifterlms",
"description": "LifterLMS, the #1 WordPress LMS solution, makes it easy to create, sell, and protect engaging online courses.",
"keywords": [
"WordPress",
"LMS"
],
"homepage": "https://lifterlms.com",
"license": "GPL-3.0+",
"authors": [
{
"name": "LifterLMS",
"email": "help@lifterlms.com",
"homepage": "https://lifterlms.com"
}
],
"type": "wordpress-plugin",
"support": {
"forum": "https://wordpress.org/support/plugin/lifterlms",
"issues": "https://github.com/gocodebox/lifterlms/issues",
"source": "https://github.com/gocodebox/lifterlms"
},
"autoload": {
"psr-4": {
"LLMS\\": "includes"
}
},
"require": {
"php": ">=7.4",
"composer/installers": "~1.9.0",
"deliciousbrains/wp-background-processing": "1.0.2",
"lifterlms/lifterlms-blocks": "2.7.2",
"lifterlms/lifterlms-cli": "0.0.5",
"lifterlms/lifterlms-helper": "3.5.9",
"lifterlms/lifterlms-rest": "1.0.5",
"woocommerce/action-scheduler": "3.5.4",
"gocodebox/banner-notifications": "1.1.1"
},
"require-dev": {
"lifterlms/lifterlms-tests": "^4.4",
"lifterlms/lifterlms-cs": "dev-trunk"
},
"archive": {
"exclude": [
".*",
"*.lock",
"*.xml",
"*.xml.dist",
"*.config.js",
"CHANGELOG.md",
"composer.json",
"docker-compose.yml",
"lerna.json",
"package.json",
"package-lock.json",
"README.md",
"/assets/scss",
"_private",
"dist",
"docs",
"gulpfile.js",
"node_modules",
"packages",
"src",
"tests",
"tmp",
"wordpress",
"!/vendor",
"!/libraries",
"/libraries/README.md",
"/libraries/**/composer.*",
"/libraries/**/i18n",
"/libraries/banner-notifications/.github",
"/libraries/banner-notifications/.gitignore",
"/libraries/banner-notifications/phpunit.xml",
"/libraries/banner-notifications/.editorconfig",
"/libraries/banner-notifications/tests",
"/vendor/bin",
"/vendor/**/**/composer.*",
"/vendor/**/**/*.md",
"/vendor/**/**/.*",
"/vendor/composer/installers",
"/vendor/composer/lifters",
"!/assets/maps/js/vendor",
"!/assets/vendor",
"!/assets/js/vendor",
"!/assets/js/builder/vendor"
]
},
"scripts": {
"check-cs": "\"vendor/bin/phpcs\" --colors",
"check-cs-errors": "\"vendor/bin/phpcs\" --colors --error-severity=1 --warning-severity=6",
"config-cs": [
"\"vendor/bin/phpcs\" --config-set default_standard 'LifterLMS Core'",
"\"vendor/bin/phpcs\" --config-set ignore_warnings_on_exit 1"
],
"env": "\"vendor/bin/llms-env\"",
"env:setup": "./tests/bin/setup-e2e.sh",
"fix-cs": "\"vendor/bin/phpcbf\"",
"post-install-cmd": "@post-update-install-cmd",
"post-update-cmd": "@post-update-install-cmd",
"post-update-install-cmd": [
"@config-cs",
"rm -rf ./wp-content/",
"rm composer.lock"
],
"tests-remove": "\"vendor/bin/llms-tests\" teardown ${TESTS_DB_NAME:-llms_tests} ${TESTS_DB_USER:-root} \"${TESTS_DB_PASS:-password}\" ${TESTS_DB_HOST:-127.0.0.1}",
"tests-install": "\"vendor/bin/llms-tests\" install ${TESTS_DB_NAME:-llms_tests} ${TESTS_DB_USER:-root} \"${TESTS_DB_PASS:-password}\" ${TESTS_DB_HOST:-127.0.0.1} ${WP_VERSION:-latest} false \"${WP_TESTS_VERSION:-false}\"",
"tests-reinstall": [
"@tests-remove",
"@tests-install"
],
"tests": [
"Composer\\Config::disableProcessTimeout",
"\"vendor/bin/phpunit\""
],
"tests-run": [
"Composer\\Config::disableProcessTimeout",
"\"vendor/bin/phpunit\""
],
"install-php8": "composer install --ignore-platform-reqs"
},
"extra": {
"installer-paths": {
"libraries/{$name}": [
"lifterlms/lifterlms-blocks",
"lifterlms/lifterlms-cli",
"lifterlms/lifterlms-helper",
"lifterlms/lifterlms-rest",
"gocodebox/banner-notifications"
],
"vendor/{$vendor}/{$name}": [
"type:wordpress-plugin"
]
}
},
"config": {
"allow-plugins": {
"dealerdirect/phpcodesniffer-composer-installer": true,
"composer/installers": true
}
},
"minimum-stability": "dev"
}
================================================
FILE: docker-compose.yml
================================================
version: '3.1'
services:
wordpress:
volumes:
- ./:/var/www/html/wp-content/plugins/lifterlms:rw
================================================
FILE: docs/block-development.md
================================================
# Block Development
Below are the steps for creating and registering a new block for LifterLMS.
Please note that before beginning you will need to have Node and NPM installed on your machine. Please see [https://github.com/gocodebox/lifterlms/blob/trunk/docs/installing.md](https://github.com/gocodebox/lifterlms/blob/trunk/docs/installing.md) for installation details.
#### Table of Contents
- [1. Create block files](#1-create-block-files)
- [2. Add block JSON data](#2-add-block-json-data)
- [3. Adding Block JS](#3-adding-block-js)
- [4. Compiling blocks](#4-compiling-blocks)
- [5. Register with PHP](#5-register-with-php)
- [6. Block design guidelines](#6-block-design-guidelines)
### 1. Create block files
Create a new folder in the `src/blocks` directory for your block. E.g. `/src/blocks/example-block/`. Then, add a `block.json` file and an `index.jsx` file to the new folder.
The block directory structure should now look like this:
```shell
.
└── project/
├── src/
│ └── blocks/
│ └── block/
│ ├── block.json
│ ├── index.jsx
│ └── index.scss # optional.
├── package.json
└── webpack.congif.js
```
### 2. Add block JSON data
Next, add block information to the `block.json` file. Below is an example of a block.json file. Note that the category should be `lifterlms` to match the other LifterLMS blocks:
```json
{
"$schema": "https://schemas.wp.org/trunk/block.json",
"apiVersion": 2,
"name": "llms/example-block",
"title": "Example",
"category": "llms-blocks",
"description": "Block description",
"textdomain": "lifterlms",
"attributes": {},
"supports": {},
"editorScript": "file:./index.js"
}
```
### 3. Adding Block JS
Next, add the block’s JavaScript to the `index.jsx` file. We use the JSX file extension to indicate that the file contains JSX code.
Below is an example of how to register a new block and access the block.json data to set the block’s name and attributes:
```jsx
import { registerBlockType } from '@wordpress/blocks';
import blockJson from './block.json';
registerBlockType( blockJson, {
edit: ( props ) => {
return <p>{ props.name }</p>;
},
save: ( props ) => {
return <p>{ props.name }</p>;
},
} );
```
*Note that while it is common practise to separate the `edit` and `save` functions into separate files, this is not necessary unless the code becomes too complex to manage in a single file. We prefer to keep the code in a single file where possible.*
### 4. Compiling blocks
To compile the block, open the Terminal and run the following NPM script from the plugin root directory. This will compile all blocks to the main `/blocks/` directory:
`npm run build:blocks`
### 5. Register with PHP
The last step is to register the block with PHP. This should be added to a PHP file or class where it makes sense. For example, shortcode blocks are registered in the `/includes/shortcodes/class.llms.shortcodes.blocks.php` file. Below is an example of how to register a block with PHP and allow WordPress to handle the loading of scripts and styles:
```php
add_action( 'init', 'llms_register_example_block' );
/**
* Register the example block.
*
* @since 1.0.0
*
* @return void
*/
function llms_register_example_block() {
register_block_type( LLMS_PLUGIN_DIR . 'blocks/example-block' );
}
```
### 6. Block design guidelines
Blocks should be designed to be as simple as possible.
#### Icons
Blocks should use FontAwesome icons. The complete list of icons can be found at [https://fontawesome.com/icons](https://fontawesome.com/icons). SVG icons need to be converted to React components and added to blocks with the `registerBlockType` function:
```jsx
import { registerBlockType } from '@wordpress/blocks';
import { SVG, Path } from '@wordpress/primitives';
const Icon = () => (
<SVG xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512">
<Path
d="M592 416H48c-26.5 0-48-21.5-48-48V144c0-26.5 21.5-48 48-48h544c26.5 0 48 21.5 48 48v224c0 26.5-21.5 48-48 48z"
/>
</SVG>
);
registerBlockType( blockJson, {
icon: Icon,
edit: Edit
} );
```
#### Colors
Blocks use the default core admin color palette. This ensures that hover and active states are consistent with other blocks.
## Shortcodes
For blocks with Server Side Rendering functionality, a shortcode should also be registered to support users who are not using the block editor. The shortcode should follow LifterLMS shortcode naming conventions and be registered in the `/includes/shortcodes/` directory and extend the `LLMS_Shortcode` class.
Shortcode blocks can use the `llms_shortcode_blocks` filter provided by the `LLMS_Shortcode_Block` class to handle the block registration and rendering. Below is an example of how to register a block with the class from within a LifterLMS add-on plugin:
```php
add_filter( 'llms_shortcode_blocks', register_blocks( array $config ): array {
$config['group-list'] = array(
'render' => array( 'LLMS_Groups_Shortcode_Group_List', 'output' ),
'path' => LLMS_GROUPS_PLUGIN_DIR . 'assets/blocks/group-list',
);
return $config;
} );
```
================================================
FILE: docs/coding-standards.md
================================================
LifterLMS Coding Standards
==========================
The purpose of the LifterLMS Coding Standards is to create a baseline for collaboration and review within the open source LifterLMS codebase, project, and community.
The WordPress community has developed coding standards and documented them in the [WordPress codex](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/). Wherever possible, the LifterLMS Coding Standards aim to obey these coding standards.
## Naming Conventions
### camelCase should not be used.
LifterLMS avoids `camelCase` for class names, class methods, functions, and variables. Words should instead be separated by underscores.
### Class Names
Class names should use capitalized words separated by underscores.
LifterLMS core class names should be prefixed with `LLMS_`.
```php
class LLMS_Student extends LLMS_Abstract_User_Data { [...] }
class LLMS_Data { [...] }
```
LifterLMS add-on class names should be prefixed with `LLMS_` as well as an additional add-on prefix.
```php
class LLMS_AQ_Question_Types { [...] }
class LLMS_SL_Story extends LLMS_Abstract_Database_Store { [...] }
```
### Trait Names
Trait names should use capitalized words separated by underscores.
LifterLMS core trait names should be prefixed with `LLMS_Trait`.
```php
trait LLMS_Trait_Singleton { [...] }
```
### Constants
Constants should be in all upper-case with underscores separating words.
LifterLMS core constants should be prefixed with `LLMS_`.
```php
define( 'LLMS_PLUGIN_FILE', __FILE__ );
```
LifterLMS add-on class names should be prefixed with `LLMS_` as well as an additional add-on prefix.
```php
define( 'LLMS_FORMIDABLE_FORMS_PLUGIN_FILE', __FILE__ );
```
### File names
Files should be named descriptively using lower case letters. Hyphens should be used to separate words.
```
my-plugin-file.php
```
Class file names should be based on the class name with `class-` prepended and the underscores in the class name replaced with hyphens, for example `LLMS_Data` becomes:
```
class-llms-data.php
```
Files containing model classes should prepend `model-` instead of `class-`. For example the `LLMS_Student` model class becomes:
```
model-llms-student.php
```
Trait file names should be based on the trait name with underscores replaced by hyphens and the file stored in the
`includes/traits` directory. For example `LLMS_Trait_Singleton` becomes:
```
includes/traits/llms-trait-singleton.php
```
### Functions & Variables
Lowercase letters should be used for function names and variables. Separate words with underscores.
LifterLMS core functions should be prepended with the prefix `llms_`.
```php
llms_current_time( $type, $gmt = 0 ) { [...] }
```
LifterLMS add-on function names should be prefixed with `llms_` as well as an additional add-on prefix.
```php
llms_ck_consent_form_field() { [...] }
```
### Hooks: Actions & Filters
Lowercase letters should be used for hook names. Separate words with underscores.
LifterLMS core hooks should be prepended with the prefix `llms_`.
```php
do_action( 'llms_user_enrolled_in_course', [...] );
apply_filters( 'llms_get_enrollment_status', [...] );
```
LifterLMS add-on hook names should be prefixed with `llms_` as well as an additional add-on prefix.
```php
do_action( 'llms_pa_post_created_from_automation', [...] );
apply_filters( 'llms_sl_story_can_user_manage', [...] );
```
When actions are set to run before and after items (templates, as an example) it is acceptable to use additional prefixes `before_` and `after_` prior to the `llms_` prefix.
There are a number of legacy hooks which use the prefix `lifterlms_` instead of `llms_`. These are retained for backwards compatibility but should not be used as an example of an acceptable naming convention for new code.
### CSS Classes and IDs
Class names and IDs should be lowercase and prefixed with `llms-`.
Words should be separated with hyphens (AKA "kebab case").
```html
<div class="llms-element-name" id="llms-element-id"></div>
```
### Form Element `name` attributes
The `name` attribute of HTML form elements should be prefixed with `llms_`.
Lowercase letters should be used and words should be separated by underscores.
```html
<form>
<input name="llms_text_field" type="text">
</form>
```
================================================
FILE: docs/contributing.md
================================================
Contributor Guidelines
----------------------
See contributing guidelines at https://github.com/gocodebox/lifterlms/blob/trunk/.github/CONTRIBUTING.md
================================================
FILE: docs/documentation-standards.md
================================================
LifterLMS Inline Documentation Standards
========================================
The LifterLMS documentation standard is heavily inspired by the [WordPress core's documentation standards][wp-core-docs]. We have made customizations to these standards in areas where it aids our core team's development and release workflows. By using the WordPress core documentation standard as a starting point any contributor already familiar with the WordPress core should be able to quickly add inline documentation to LifterLMS without the need to study our standards at length.
## What should be documented
The following elements should be documented using formatted documentation blocks (DocBlocks):
+ Functions
+ Classes
+ Class methods
+ Class members (including properties and constants)
+ Requires and includes
+ Hooks (actions and filters)
+ File headers
## DocBlock Formatting Guidelines
Inline documentation in the LifterLMS code base is automatically parsed and output to the code reference [developer.lifterlms.com][llms-dev]. Adhering to these guidelines is essential to ensure optimum readability via the code reference.
### Spacing
DocBlocks should directly precede the element (hook, function, method, class, etc...). There should not be any opening/closing tags, white space, or anything else between the DocBlock and the declarations. This will ensure the parser can correctly associate the DocBlock with it's element.
### Summary
A short piece of text, usually one line, providing the basic function of the associated element. A good summary concisely describes what the element does and should not attempt to describe why the element exists.
HTML may not be used in the summary. For example, if the function outputs an `<img>` tag, the summary should read ```Outputs an image tag.``` instead of ```Outputs an `<img>` tag.```.
### Description
An optional longer piece of text providing more details on the associated element’s function.
HTML may not be used in the summary but markdown can be used to format a complicated description.
**1. Lists**
Use a hyphen (`-`) to create an unordered list, with a blank line before and after.
```
* Description which includes an unordered list:
*
* - This is item 1.
* - This is item 2.
* - This is item 3.
*
* The description continues on ...
```
Use numbers to create an ordered list, with a blank line before and after.
```
* Description which includes an ordered list:
*
* 1. This is item 1.
* 2. This is item 2.
* 3. This is item 3.
*
* The description continues on ...
```
**2. Code Samples**
A code sample may be created by indenting every line of the code by 4 spaces, with a blank line before and after. Blank lines in code samples also need to be indented by four spaces. Note that examples added in this way will be output in `<pre>` tags and are not syntax-highlighted in the code reference.
```
* Description including a code sample:
*
* $status = array(
* 'draft' => __( 'Draft' ),
* 'pending' => __( 'Pending Review' ),
* 'private' => __( 'Private' ),
* 'publish' => __( 'Published' )
* );
*
* The description continues on ...
```
**3. Links**
A link in the form of a URL, such as related GitHub issue or other documentation, should be added in the appropriate place in the DocBlock using the `@link` tag.
```
* Description text.
*
* @link https://github.com/gocodebox/lifterlms/issues/1234567890
```
### Changelogs
Whenever any code is changed within an element, a `@since`, `@version`, or `@deprecated` tag should be added to the element to document the change(s) which have been made.
No HTML should be used in the descriptions for these tags, though limited Markdown can be used as necessary, such as for adding backticks around variables, e.g. `$variable`.
All descriptions for any of these tags should be a full sentence ending with a full stop (a period, for example).
#### Changes Warranting a Changelog Entry
Most code changes warrant a changelog entry to be recorded for the element but there are some exceptions.
+ **Classes**: Any breaking changes, deprecations, or the introduction of new class elements (elements which do not have their own changelog, such as class properties) require an accompanying `@since` tag entry. Changes to a class method should be recorded on the method's changelog, not on the class changelog.
+ **Functions and class methods**: Any change made requires an accompanying `@since` tag entry
Changes which do not affect the functionality or execution of the element *should not* be recorded on the element's changelog. For example, a coding standards change such as alignment or spacing should not be recorded.
#### Recording the Version Number
Versions should be expressed in the 3-digit `x.x.x` style.
```
* @since 3.29.0
```
When any change has been made to the element an additional `@since` tag can be added with a short description of the changes which were made.
```
* @since 3.3.0
* @since 3.5.0 Added optional 3rd argument.
```
#### Deprecations
When an element is marked for deprecation this should be recorded at the end of the changelog with an `@deprecated` tag.
A short description may be added to provide additional information about the deprecation. If a replacement function has been added in it's place, note as much with an `@see` tag.
```
* @since 3.3.0
* @since 3.5.0 Added optional 3rd argument.
* @deprecated 3.10.0 Use `llms_new_function_name()` instead.
*
* @see llms_new_function_name()
```
When adding documentation on an existing element which does not yet have a changelog (common in code added prior to the creation and enforcement of these standards) if it is impossible to determine when the element was added the version may be expressed with `Unknown` instead of the `x.x.x` version number.
#### File Headers
Whenever an element within a file is updated, the `@version` tag in the header should be updated to the current version of the codebase.
#### Tag alignment and order
All changelog tags, `@since`, `@version`, and `@deprecated` should be grouped together with a space before the first `@since` tag and after the last tag in the group.
```
* @since 3.3.0
* @since 3.5.0 Changelog entry description.
* @deprecated 3.10.0 Use `llms_new_function_name()` instead.
```
When multiple lines are required for a single entry, subsequent lines should be indented to match the starting point of the description.
```
* @since 3.3.0
* @since 3.5.0 Changelog entry description.
A second entry aligned to with the first entry.
```
Multiple logs with version numbers of differing lengths should not be aligned to one another.
```
* @since 3.3.0
* @since 3.25.0 Changelog entry description.
* @since 4.0.0 This entry should not be aligned with the 3.25.0 entry above it.
```
#### Using Placeholders
When contributing code we recommend using the placeholder `[version]` in favor of trying to guess what version the element will be released with.
Our release workflow automatically replaces with `@since`, `@version`, and `@deprecated` followed by `[version]` with the actual version of the release being packaged.
For a new element:
```
* @since [version]
```
When updating an existing element:
```
* @since 3.5.0
* @since [version] Updated element.
```
### Additional Tags
#### 1. Parameters and Returns
Functions and methods should define all parameter arguments and returns with the `@param` and `@return` tags.
No HTML should be used in the descriptions for these tags, though limited Markdown can be used as necessary, such as for adding backticks around variables, e.g. `$variable`.
All descriptions for any of these tags should be a full sentence ending with a full stop (a period, for example).
```
* @param string $var1 Description of the argument.
* @param bool $var2 Description of the argument.
* @return string
*/
function my_function( $var1, $var2 = false ) {
...
return $var1;
}
```
Parameters that are arrays should be documented using WordPress’ flavor of hash notation style, each array value beginning with the `@type` tag, and and describing the value as follows:
```
* @type type $key Description. Default 'value'. Accepts 'value', 'value'.
* (aligned with Description, if wraps to a new line)
```
A full array parameter would look like this:
```
* @param array $args {
* Optional. An array of arguments.
*
* @type type $key Description. Default 'value'. Accepts 'value', 'value'.
* (aligned with Description, if wraps to a new line)
* @type type $key Description.
* }
```
#### 2. Types
Variables, constants, and class members should use the `@var` tag to describe the member's type.
```
* @var string
*/
public $var = 'text';
```
#### 3. Relations and References
Use `@see` to perform automatic links to other areas of the codebase. For example `{@see 'is_lifterlms'}` to link to the filter `is_lifterlms`.
#### 4. Thrown Exceptions
A function or method which throws an exception should document the thrown exception using an `@throws` tag.
When present, the `@throws` tag should be added to the end of the docblock below the `@return` tag. An empty line should separate the `@return` and `@throws` tag.
```
* @return string
*
* @throws Exception A description of the raised exception.
*/
```
## DocBlock Examples
### Functions and Class Methods
Functions and class methods should be formatted as follows:
+ Summary
+ Description (optional)
+ Changelog
+ Links and References (where appropriate)
+ Parameters
+ Return
```
/**
* Summary.
*
* Description.
*
* @since x.x.x
* @since x.x.x Description of function/method changes.
*
* @see Function/method/class relied on
* @link URL
*
* @param type $var Description.
* @param type $var Optional. Description. Default.
* @return type Description.
*/
```
### Classes
Class DocBlocks should be formatted as follows:
+ Summary
+ Description (Optional)
+ Links and References (as an example use `@see` to reference a super class when documenting a sub class)
+ Changelog
```
/**
* Summary.
*
* Description.
*
* @see Super_Class
*
* @since x.x.x
* @since x.x.x Description of class changes.
*/
```
### Class Members
Class properties and constants should be formatted as follows:
+ Summary
+ Changelog
+ Type
```
/**
* Summary.
*
* @since x.x.x
* @since x.x.x Description of member changes.
* @var type Optional description.
*/
```
### Hooks (Actions and Filters)
Both action and filter hooks should be documented on the line immediately preceding the call to `do_action()` or `do_action_ref_array()`, `apply_filters()`, or `apply_filters_ref_array()`, and formatted as follows:
+ Summary
+ Description (Optional)
+ Changelog
+ Parameters
Note that `@return` is not used for hook documentation, because action hooks return nothing, and filter hooks always return their first parameter.
```
/**
* Summary.
*
* Description.
*
* @since x.x.x
* @since x.x.x Description of hook changes.
*
* @param type $var Description.
* @param array $args {
* Short description about this hash.
*
* @type type $var Description.
* @type type $var Description.
* }
* @param type $var Description.
*/
```
### File Headers
The file header DocBlock is used to give an overview of what is contained in the file and should be formatted as follows:
+ Summary
+ Description (optional)
+ Links and references
+ Package
+ Changelog
```
/**
* Summary (no period for file headers)
*
* Description. (use period)
*
* @link URL
*
* @package LifterLMS/SecondaryPackage/TertiaryPackage
*
* @since x.x.x
* @since x.x.x Description of file changes.
* @version x.x.x
*/
```
[llms-dev]: https://developer.lifterlms.com/reference/
[wp-core-docs]: https://developer.wordpress.org/coding-standards/inline-documentation-standards/
================================================
FILE: docs/e2e-tests-real.md
================================================
Running E2E (End to End) Tests Against a Real Website
=====================================================
_The core E2E test suite is primarily designed to be run locally against managed Docker containers. However, it is possible to run the test suite against any WordPress website with a publicly accessible URL by following this guide._
_To run tests locally against managed Docker containers, see the [E2E Testing README](../tests/e2e/README.md)._
**NOTE: This is an experimental process! Proceed with caution. We are developing this process for internal use and thought it might be useful to some other folks.**
**Another note: This process will import courses, create fake users, and add other data to your website and there is no cleanup proccess. If you choose to use this against a live production site that means that the database will have a bunch of fake test data added to it. So don't run this against a real production website. Use a staging website instead!**
## Prerequisites
+ Ability to use a terminal
+ git
+ node.js
+ npm
## Setup your local environment
+ Install the LifterLMS repo: `git clone https://github.com/gocodebox/lifterlms`
+ Move into the cloned directory: `cd liferlms`
+ Install node packages: `npm ci`
+ Create a new file in the created directory named `.llmsenv`.
+ Use your favorite text editor to edit the file and add the following to the file (replacing the example data with your site's information):
```
WP_BASE_URL=https://yourwebsiteurl.tld
WP_USERNAME=adminusername
WP_PASSWORD=adminpassword
```
**This will store a password in a PLAIN TEXT which we know is wrong. Our internal use case uses this process with temporary sites which are regularly destroyed so the danger is acceptable to our use case. If you decide to use this process on a real website with real user information you have been warned that storing your production site's WP admin password in a plain text file in order to use this process is a bad idea. We recommend instead using environment variables to pass your password to the script later and removing the WP_PASSWORD from the `.llmsenv` file.**
+ Save the file
## Setup your production site
+ Install and activate the LifterLMS plugin on your site
## Run the tests
There are two ways to run the E2E tests:
### Headless mode
Runs the tests and shows you the results.
If errors are encountered, a screenshot of the page will be taken and saved in the `tmp/e2e-screenshots/` directory so you can see what the page looked like when things went sour.
Error logs will be output in your terminal to review.
Run headless tests by executing `npm run tests` in your terminal.
### Interactive mode
Launches an automated Chromium browser and runs the tests in "slow motion" so you can watch as the tests run.
No screenshots are takeng in interactive mode.
Error logs are output to the terminal for review.
Run interactive tests by executing `npm run tests:dev` in your terminal.
### Using environment variables
If you don't want to store you admin password in a plaintext file you can define the WP_PASSWORD variable at runtime `WP_PASSWORD=yourpassword npm run tests`
================================================
FILE: docs/installing.md
================================================
Installing for Development
==========================
## Requirements
In order to build and develop LifterLMS locally, you'll need the following:
+ PHP
+ MySQL / MariaDB
+ [Composer](https://getcomposer.org/download/)
+ [Node.js](https://nodejs.org/en/download/)
+ [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
## Building LifterLMS
### 1. Clone source from GitHub
```sh
$ git clone https://github.com/gocodebox/lifterlms
$ cd lifterlms
```
If you're planning to contribute code, you should fork this repository and clone your fork instead and switch to the dev branch before continuing the install.
```sh
$ git checkout dev
```
### 2. Install composer dependencies:
```sh
$ composer install
```
### 3. Install npm dependencies:
```sh
$ npm install --global gulp
$ npm install
```
### 4. Build static assets
```sh
$ npm run build
```
The `lifterlms` directory is now an installable plugin that can be moved into your local server's `wp-content/plugins` directory.
## Running PHPCS
When contributing you should ensure your contributions follow our [coding](./coding-standards.md) and [documentation](./documentation-standards.md) standards.
To check for errors and warnings in your code, run PHPCS:
```sh
$ composer run check-cs
```
To check for errors only:
```sh
$ composer run check-cs-errors
```
These reports may include issues that can be automatically fixed using PHPCBF:
```sh
$ composer run fix-cs
```
## Running Test Suites
New code should also strive to be covered by automated tests.
LifterLMS has unit and integration tests via phpunit and End-to-End tests via Jest and Puppeteer.
For guides on running and contributing tests, see the relevant guides:
+ [phpunit](../tests/phpunit/README.md)
+ [e2e](../tests/e2e/README.md)
================================================
FILE: gulpfile.js/index.js
================================================
/**
* Main Gulp File
*
* Requires all task files
*/
var gulp = require('gulp');
// All custom tasks.
require( './tasks/hacky-clean' );
require( './tasks/js-additional' );
require( './tasks/js-builder' );
// All tasks from lib-tasks.
require( 'lifterlms-lib-tasks' )( gulp );
================================================
FILE: gulpfile.js/tasks/hacky-clean.js
================================================
const gulp = require( 'gulp' ),
{ unlinkSync } = require( 'fs' ),
filesToRemove = [
'assets/css/dancing-script-rtl.css',
'assets/css/imperial-script-rtl.css',
'assets/css/pirata-one-rtl.css',
'assets/css/unifraktur-maguntia-rtl.css',
];
/**
* A hacky clean script that deletes RTL css files generated by the legacy styles-rtl tasks.
*
* The deleted files are webfont definition files which we don't need RTL stylesheets for.
*/
gulp.task( 'hacky-clean', function( cb ) {
filesToRemove.forEach( file => {
unlinkSync( file );
} );
return cb();
} );
================================================
FILE: gulpfile.js/tasks/js-additional.js
================================================
var gulp = require( 'gulp' )
, header = require( 'gulp-header' )
, include = require( 'gulp-include' )
, maps = require( 'gulp-sourcemaps' )
, pump = require( 'pump' )
, rename = require( 'gulp-rename' )
, uglify = require( 'gulp-uglify' )
, gulpignore = require( 'gulp-ignore' )
, path = require( 'path' )
;
gulp.task( 'js-additional', function( cb ) {
var notice = [
'/****************************************************************',
' *',
' * Contributor\'s Notice',
' * ',
' * This is a compiled file and should not be edited directly!',
' * The uncompiled script is located in the "assets/private" directory',
' * ',
' ****************************************************************/',
'',
'',
];
pump( [
gulp.src( 'assets/js/private/**/*.js' ),
include(),
maps.init(),
header( notice.join( '\n' ) ),
maps.write('../maps/js', { destPath: 'assets/js' } ),
gulp.dest( 'assets/js' ),
// Don't pass maps any further.
gulpignore.exclude( file => '.js' !== path.extname( file.basename ) ),
uglify(),
rename( {
suffix: '.min',
} ),
maps.write('../maps/js', { destPath: 'assets/js' } ),
gulp.dest( 'assets/js' )
],
cb
);
} );
================================================
FILE: gulpfile.js/tasks/js-builder.js
================================================
/**
* -----------------------------------------------------------
* js-builder
* -----------------------------------------------------------
* Compile Admin builder Javascript
*/
var gulp = require( 'gulp' )
, requirejsOptimize = require( 'gulp-requirejs-optimize' )
, rename = require( 'gulp-rename' )
, sourcemaps = require( 'gulp-sourcemaps' )
;
gulp.task( 'js-builder', function( cb ) {
gulp.src( 'assets/js/builder/main.js' )
// unminified
.pipe( sourcemaps.init() )
.pipe( requirejsOptimize( function( file ) {
return {
name: 'vendor/almond',
optimize: 'none',
wrap: {
start: "(function($){",
end: "}(jQuery));"
},
baseUrl: 'assets/js/builder/',
include: [ 'main' ],
preserveLicenseComments: false
};
} ).on( 'error', ( err ) => console.log( err ) ) )
.pipe( rename( 'llms-builder.js' ) )
.pipe( sourcemaps.write( '../maps/js', { destPath: 'assets/js' } ) )
.pipe( gulp.dest( 'assets/js/' ) )
// minified
.pipe( sourcemaps.init() )
.pipe( requirejsOptimize( function( file ) {
return {
name: 'vendor/almond',
optimize: 'uglify2',
wrap: {
start: "(function($){",
end: "}(jQuery));"
},
baseUrl: 'assets/js/builder/',
include: [ 'main' ],
preserveLicenseComments: false
};
} ).on( 'error', ( err ) => console.log( err ) ) )
.pipe( rename( 'llms-builder.min.js' ) )
.pipe( sourcemaps.write( '../maps/js', { destPath: 'assets/js' } ) )
.pipe( gulp.dest( 'assets/js/' ) );
cb();
});
================================================
FILE: includes/abstracts/abstract.llms.admin.metabox.php
================================================
<?php
/**
* Admin Metabox Abstract.
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.0.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin metabox abstract class.
*
* @since 3.0.0
* @since 3.35.0 Sanitize and verify nonce when saving metabox data.
* @since 3.36.0 Allow quotes to be saved without being encoded for some special fields that store a shortcode.
* @since 3.36.1 Improve `save()` method.
* @since 3.37.12 Simplify `save()` by moving logic to sanitize and update posted data to `save_field()`.
* Add field sanitize option "no_encode_quotes" which functions like previous "shortcode" but is more semantically accurate.
* @since 3.37.19 Bail if the global `$post` is empty, before registering our meta boxes.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*/
abstract class LLMS_Admin_Metabox {
/**
* Metabox ID.
*
* Define this in extending class's $this->configure() method.
*
* @var string
*/
public $id;
/**
* Post Types this metabox should be added to.
*
* Can be a string of a single post type or an indexed array of multiple post types.
* Define this in extending class's $this->configure() method.
*
* @var array
*/
public $screens = array();
/**
* Title of the metabox.
*
* Define this in extending class's $this->configure() method.
*
* @var string
*/
public $title;
/**
* Capability to check in order to display the metabox to the user.
*
* @var string
*/
public $capability = 'edit_post';
/**
* Optional context to register the metabox with.
*
* Accepts anything that can be passed to WP core add_meta_box() function: 'normal', 'side', 'advanced'.
*
* Define this in extending class's $this->configure() method.
*
* @var string
*/
public $context = 'normal';
/**
* Optional priority for the metabox.
*
* Accepts anything that can be passed to WP core add_meta_box() function: 'default', 'high', 'low'.
*
* Define this in extending class's $this->configure() method.
*
* @var string
*/
public $priority = 'default';
/**
* Array of callback arguments passed to `add_meta_box()`.
*
* @var null
*/
public $callback_args = null;
/**
* Instance of WP_Post for the current post.
*
* @var WP_Post
*/
public $post;
/**
* Meta Key Prefix for all elements in the metabox.
*
* @var string
*/
public $prefix = '_llms_';
/**
* Array of error messages to be displayed after an update attempt.
*
* @var string[]|WP_Error[]
*/
private $errors = array();
/**
* Option keyname where error options are stored.
*
* @var string
*/
protected $error_opt_key = '';
/**
* HTML for the Metabox Content.
*
* Content handled by $this->process_fields().
*
* @var string
*/
private $content = '';
/**
* HTML for the Metabox Navigation.
*
* Content handled by $this->process_fields().
*
* @var string
*/
private $navigation = '';
/**
* The number of tabs registered to the metabox.
*
* This will be calculated automatically.
*
* Navigation will not display unless there's 2 or more tabs.
*
* @var integer
*/
private $total_tabs = 0;
/**
* Metabox Version Number.
*
* @var integer
*/
private $version = 1;
/**
* Used to prevent save action from running
* multiple times on a single load.
*
* @since 7.5.0
* @var bool
*/
private $_saved;
/**
* Constructor.
*
* Configure the metabox and automatically add required actions.
*
* @since 3.0.0
* @since 3.37.12 Use `$this->error_opt_key()` in favor of hardcoded option name.
*
* @return void
*/
public function __construct() {
// Allow child classes to configure variables.
$this->configure();
// Set the error option key.
$this->error_opt_key = sprintf( 'lifterlms_metabox_errors%s', $this->id );
// Register the metabox.
add_action( 'add_meta_boxes', array( $this, 'register' ) );
// Register save actions for applicable screens (post types).
foreach ( $this->get_screens() as $screen ) {
add_action( 'save_post_' . $screen, array( $this, 'save_actions' ), 10, 1 );
}
// Display errors.
add_action( 'admin_notices', array( $this, 'output_errors' ) );
// Save errors.
add_action( 'shutdown', array( $this, 'save_errors' ) );
}
/**
* Add an Error Message.
*
* @since 3.0.0
* @since 3.8.0 Unknown.
*
* @param string|WP_Error $error Error message text.
* @return void
*/
public function add_error( $error ) {
$this->errors[] = $error;
}
/**
* This function allows extending classes to configure required class properties.
*
* Properties $id, $title, and $screens should be configured in this function.
*
* @since 3.0.0
*
* @return void
*/
abstract public function configure();
/**
* Retrieve stored metabox errors.
*
* @since 3.37.12
*
* @return string[]|WP_Error[]
*/
public function get_errors() {
return get_option( $this->error_opt_key, array() );
}
/**
* This function is where extending classes can configure all the fields within the metabox.
*
* The function must return an array which can be consumed by the "output" function.
*
* @return array
*/
abstract public function get_fields();
/**
* Normalizes $this->screens to ensure it's an array.
*
* @since 3.0.0
* @since 3.37.12 Remove unnecessary `else` condition.
*
* @return array
*/
private function get_screens() {
if ( is_string( $this->screens ) ) {
return array( $this->screens );
}
return $this->screens;
}
/**
* Determine if any errors have been added to the metabox.
*
* @since Unknown
*
* @return boolean
*/
public function has_errors() {
return count( $this->errors ) ? true : false;
}
/**
* Generate and output the HTML for the metabox.
*
* @since Unknown
*
* @return void
*/
public function output() {
// Setup html for nav and content.
$this->process_fields();
// output the html.
echo '<div class="llms-mb-container">';
// only show tabbed navigation when there's more than 1 tab.
if ( $this->total_tabs > 1 ) {
echo '<nav class="llms-nav-tab-wrapper llms-nav-style-tabs"><ul class="tabs llms-nav-items">' . wp_kses_post( $this->navigation ) . '</ul></nav>';
}
do_action( 'llms_metabox_before_content', $this->id );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Already escaped via process_fields().
echo $this->content;
do_action( 'llms_metabox_after_content', $this->id );
echo '</div>';
wp_nonce_field( 'lifterlms_save_data', 'lifterlms_meta_nonce' );
}
/**
* Display the messages as a WP Admin Notice.
*
* @since 3.0.0
* @since 3.37.12 Load errors using `$this->get_errors()` instead of `get_option()`.
* @since 6.0.0 Handle WP_Error objects.
*
* @return void
*/
public function output_errors() {
$errors = $this->get_errors();
if ( empty( $errors ) ) {
return;
}
foreach ( $errors as $error ) {
if ( is_wp_error( $error ) ) {
$error = $error->get_error_message();
}
echo '<div id="lifterlms_errors" class="error"><p>' . wp_kses_post( $error ) . '</p></div>';
}
delete_option( $this->error_opt_key );
}
/**
* Process fields to setup navigation and content with minimal PHP loops.
*
* Called by `$this->output()` before actually outputting html.
*
* @since 3.0.0
* @since 3.16.14 Unknown.
* @since 6.0.0 Move single field processing logic to a specific method {@see LLMS_Admin_Metabox::process_field()}.
*
* @return void
*/
private function process_fields() {
// Create a filter-safe ID that conforms to WordPress coding standards for hooks.
$id = str_replace( '-', '_', $this->id );
/**
* Customize metabox fields prior to field processing.
*
* The dynamic portion of this filter, `$id`, corresponds to the classes `$id` property with
* dashes (`-`) replaced with underscores (`_`). If the class id is "my-metabox" the filter would be
* "llms_metabox_fields_my_metabox".
*
* @since Unknown
*
* @param array $fields Array of metabox fields.
*/
$fields = apply_filters( "llms_metabox_fields_{$id}", $this->get_fields() );
$this->total_tabs = count( $fields );
foreach ( $fields as $i => $tab ) {
++$i;
$current = 1 === $i ? ' llms-active' : '';
$this->navigation .= '<li class="llms-nav-item tab-link ' . esc_attr( $current ) . '" data-tab="' . $this->id . '-tab-' . esc_attr( $i ) . '"><span class="llms-nav-link">' . wp_kses_post( $tab['title'] ) . '</span></li>';
$this->content .= '<div id="' . $this->id . '-tab-' . $i . '" class="tab-content' . esc_attr( $current ) . '"><ul>';
foreach ( $tab['fields'] as $field ) {
$this->content .= $this->process_field( $field );
}
$this->content .= '</ul></div>';
}
}
/**
* Process single field.
*
* @since 6.0.0
*
* @param array $field Metabox field.
* @return string
*/
protected function process_field( $field ) {
$name = ucfirst(
strtr(
preg_replace_callback(
'/(\w+)/',
function ( $m ) {
return ucfirst( $m[1] );
},
$field['type']
),
'-',
'_'
)
);
$field_class_name = str_replace( '{TOKEN}', $name, 'LLMS_Metabox_{TOKEN}_Field' );
$field_class = new $field_class_name( $field );
ob_start();
$field_class->Output();
$field_html = ob_get_clean();
unset( $field_class );
return $field_html;
}
/**
* Register the Metabox using WP Functions.
*
* This is called automatically by constructor.
*
* Utilizes class properties for registration.
*
* @since 3.0.0
* @since 3.13.0 Unknown.
* @since 3.37.19 Early bail if the global `$post` is empty.
* @since 6.0.0 Pass callback arguments to `add_meta_box()`.
*
* @return void
*/
public function register() {
global $post;
if ( empty( $post ) ) {
return;
}
$this->post = $post;
if ( current_user_can( $this->capability, $this->post->ID ) ) {
add_meta_box(
$this->id,
$this->title,
array( $this, 'output' ),
$this->get_screens(),
$this->context,
$this->priority,
is_callable( $this->callback_args ) ? ( $this->callback_args )() : $this->callback_args
);
}
}
/**
* Save field data.
*
* Loops through fields and saves the data to postmeta.
*
* Called by $this->save_actions().
*
* This function is dumb. If the fields need to output error messages or do validation override
* this method and create a custom save method to accommodate the validations or conditions.
*
* @since 3.0.0
* @since 3.14.1 Unknown.
* @since 3.35.0 Added nonce verification before processing data; only access `$_POST` data via `llms_filter_input()`.
* @since 3.36.0 Allow quotes when sanitizing some special fields that store a shortcode.
* @since 3.36.1 Check metabox capability during saves.
* Return an `int` depending on return condition.
* Automatically add `FILTER_REQUIRE_ARRAY` flag when sanitizing a `multi` field.
* @since 3.37.12 Move field sanitization and updates to the `save_field()` method.
* @since 6.0.0 Allow skipping the saving of a field.
*
* @param int $post_id WP Post ID of the post being saved.
* @return int `-1` When no user or user is missing required capabilities or when there's no or invalid nonce.
* `0` during inline saves or ajax requests or when no fields are found for the metabox.
* `1` if fields were found. This doesn't mean there weren't errors during saving.
*/
protected function save( $post_id ) {
if ( ! isset( $_REQUEST['lifterlms_meta_nonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_meta_nonce'] ) ), 'lifterlms_save_data' ) || ! current_user_can( $this->capability, $post_id ) ) {
return -1;
}
// Return early during quick saves and ajax requests.
if ( ( isset( $_POST['action'] ) && 'inline-save' === $_POST['action'] ) || llms_is_ajax() ) {
return 0;
}
// Get all defined fields.
$id = str_replace( '-', '_', $this->id );
$fields = apply_filters( "llms_metabox_fields_{$id}", $this->get_fields() );
if ( ! is_array( $fields ) ) {
return 0;
}
// Loop through the fields.
foreach ( $fields as $group => $data ) {
// Find the fields in each tab.
if ( isset( $data['fields'] ) && is_array( $data['fields'] ) ) {
// Loop through the fields.
foreach ( $data['fields'] as $field ) {
// Don't save things that don't have an ID or that are set to be skipped.
if ( isset( $field['id'] ) && empty( $field['skip_save'] ) ) {
$this->save_field( $post_id, $field );
}
}
}
}
return 1;
}
/**
* Save a metabox field.
*
* @since 3.37.12
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 6.0.0 Move the DB saving in another method.
*
* @param int $post_id WP_Post ID.
* @param array $field Metabox field array.
* @return boolean
*/
protected function save_field( $post_id, $field ) {
$val = '';
if ( isset( $field['handler'] ) && method_exists( $this, 'handler_' . $field['handler'] ) ) {
return $this->{'handler_' . $field['handler']}( $post_id, $field, $_POST );
}
if ( ! isset( $_POST[ $field['id'] ] ) ) {
return $this->save_field_db( $post_id, $field['id'], $val );
}
if ( 'basic-editor' === $field['type'] ) {
$val = wp_kses( $_POST[ $field['id'] ], LLMS_ALLOWED_HTML_PRICES );
return $this->save_field_db( $post_id, $field['id'], $val );
}
$flags = array();
if ( isset( $field['sanitize'] ) && in_array( $field['sanitize'], array( 'shortcode', 'no_encode_quotes' ), true ) ) {
$flags[] = FILTER_FLAG_NO_ENCODE_QUOTES;
} elseif ( ! empty( $field['multi'] ) ) {
$flags[] = FILTER_REQUIRE_ARRAY;
}
$val = llms_filter_input_sanitize_string( INPUT_POST, $field['id'], $flags );
return $this->save_field_db( $post_id, $field['id'], $val );
}
protected function handler_instructors_mb_store( $post_id, $field, $request ) {
if ( ! llms_current_user_can_edit_product( $post_id ) ) {
return false;
}
$post = llms_get_post( $post_id );
$instructors = array();
// TODO: This is assuming only one repeater on the page. Make the repeater use unique field names instead based on the ID.
// We're going in order of the request array to get the order of the instructors, vs. going 1, 2, 3 for ID.
foreach ( $request as $key => $val ) {
// Check if key is in the format llms_id_{number}.
if ( ! preg_match( '/^_llms_id_[0-9]+$/', $key ) ) {
continue;
}
$key_id = str_replace( '_llms_id_', '', $key );
$instructor = array(
'id' => absint( $request[ '_llms_id_' . $key_id ] ),
'label' => $request[ '_llms_label_' . $key_id ],
'visibility' => $request[ '_llms_visibility_' . $key_id ],
);
$instructors[] = $instructor;
}
$post->set_instructors( $instructors );
return true;
}
/**
* Save field in the db.
*
* Expects an already sanitized value.
*
* @param int $post_id The WP Post ID.
* @param int $field_id The field identifier.
* @param mixed $val Value to save.
* @return bool
*/
protected function save_field_db( $post_id, $field_id, $val ) {
return update_post_meta( $post_id, $field_id, $val ) ? true : false;
}
/**
* Allows extending classes to perform additional save methods before the default save.
*
* Called before `$this->save()` during `$this->save_actions()`.
*
* @since 3.0.0
*
* @param int $post_id WP Post ID of the post being saved.
* @return void
*/
protected function save_before( $post_id ) {}
/**
* Allows extending classes to perform additional save methods after the default save.
*
* Called after `$this->save()` during `$this->save_actions()`.
*
* @since 3.0.0
*
* @param int $post_id WP Post ID of the post being saved.
* @return void
*/
protected function save_after( $post_id ) {}
/**
* Perform Save Actions.
*
* Triggers actions for before and after save and calls the save method which actually saves metadata.
*
* This is called automatically on save_post_{$post_type} for all screens defined in `$this->screens`.
*
* @since 3.0.0
*
* @param int $post_id WP Post ID of the post being saved.
* @return void
*/
public function save_actions( $post_id ) {
// Prevent save action from running multiple times on a single load.
if ( isset( $this->_saved ) ) {
return;
}
$this->post = get_post( $post_id );
$this->_saved = true;
do_action( 'llms_metabox_before_save_' . $this->id, $post_id, $this );
$this->save_before( $post_id );
$this->save( $post_id );
$this->save_after( $post_id );
do_action( 'llms_metabox_after_save_' . $this->id, $post_id, $this );
}
/**
* Save messages to the database.
*
* @since 3.0.0
* @since 3.37.12 Use `$this->error_opt_key()` in favor of hardcoded option name.
* Only save errors if errors have been added.
*
* @return void
*/
public function save_errors() {
if ( $this->has_errors() ) {
update_option( $this->error_opt_key, $this->errors );
}
}
}
================================================
FILE: includes/abstracts/abstract.llms.admin.table.php
================================================
<?php
/**
* Admin Table Abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.2.0
* @version 7.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Table abstract class.
*
* @since 3.2.0
* @since 3.34.0 Added get_table_classes().
* @since 3.37.7 Fix PHP 7.4 deprecation notice.
*/
abstract class LLMS_Admin_Table extends LLMS_Abstract_Exportable_Admin_Table {
/**
* Unique ID for the Table.
*
* @var string
*/
protected $id = '';
/**
* When pagination is enabled, the current page.
*
* @var integer
*/
protected $current_page = 1;
/**
* Value of the field being filtered by.
*
* @var string Only applicable if $filterby is set.
*/
protected $filter = '';
/**
* Field results are filtered by.
*
* @var string
*/
protected $filterby = '';
/**
* Is the Table Exportable?
*
* @var bool
*/
protected $is_exportable = false;
/**
* When pagination enabled, determines if this is the last page of results.
*
* @var bool
*/
protected $is_last_page = true;
/**
* If true, tfoot will add ajax pagination links.
*
* @var bool
*/
protected $is_paginated = false;
/**
* Determine if the table is filterable.
*
* @var bool
*/
protected $is_filterable = false;
/**
* If true will be a table with a larger font size.
*
* @var bool
*/
protected $is_large = false;
/**
* Determine of the table is searchable.
*
* @var bool
*/
protected $is_searchable = false;
/**
* If true, tbody will be zebra striped.
*
* @var bool
*/
protected $is_zebra = true;
/**
* If an integer supplied, used to jump to last page.
*
* @var int
*/
protected $max_pages = null;
/**
* Results sort order.
*
* @var string 'ASC' or 'DESC'.
* Only applicable of $orderby is not set.
*/
protected $order = '';
/**
* Field results are sorted by.
*
* @var string
*/
protected $orderby = '';
/**
* Number of records to display per page.
*
* @var int
*/
protected $per_page = -1;
/**
* The search query submitted for a searchable table.
*
* @var string
*/
protected $search = '';
/**
* Table Data.
*
* @var array Array of objects or arrays.
* Each item represents as row in the table's body, each item is a cell.
*/
protected $tbody_data = array();
/**
* Table Title Displayed on Screen.
*
* @var string
*/
protected $title = '';
/**
* Retrieve data for a cell.
*
* @since 3.2.0
*
* @param string $key The column ID/key.
* @param mixed $data Object/array of data that the function can use to extract the data.
* @return mixed
*/
abstract protected function get_data( $key, $data );
/**
* Execute a query to retrieve results from the table.
*
* @since 3.2.0
*
* @param array $args Array of query args.
* @return mixed
*/
abstract public function get_results( $args = array() );
/**
* Define the structure of arguments used to pass to the get_results method.
*
* @since 2.3.0
*
* @return array
*/
abstract public function set_args();
/**
* Define the structure of the table.
*
* @since 3.2.0
*
* @return array
*/
abstract protected function set_columns();
/**
* Constructor.
*
* @since 3.2.0
*
* @return void
*/
public function __construct() {
$this->title = $this->set_title();
$this->register_hooks();
}
/**
* Ensure that a valid array of data is passed to a query.
*
* Used by AJAX methods to clean unnecessary parameters before passing the request data
* to the get_results function.
*
* @since 3.2.0
*
* @param array $args Array of arguments
* @return array
*/
protected function clean_args( $args = array() ) {
$allowed = array_keys( $this->get_args() );
foreach ( $args as $key => $val ) {
if ( ! in_array( $key, $allowed ) ) {
unset( $args[ $key ] );
}
}
return $args;
}
/**
* Ensures that all data requested by $this->get_data is filterable
* before being output on screen / in the export file.
*
* @since 3.2.0
* @since 3.17.6 Unknown.
*
* @param mixed $value Value to be displayed.
* @param string $key Column key/ID.
* @param mixed $data Original data object/array.
* @param string $context Display context [display|export].
* @return mixed
*/
protected function filter_get_data( $value, $key, $data, $context = 'display' ) {
/**
* Filters the table data.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the table.
*
* @since 3.2.0
*
* @param mixed $value Value to be displayed.
* @param string $key Column key/ID.
* @param mixed $data Original data object/array.
* @param string $context Display context [display|export].
* @param LLMS_Admin_Table $table_object Instance of the class extending `LLMS_Admin_Table`.
*/
return apply_filters( "llms_table_get_data_{$this->id}", $value, $key, $data, $context, $this );
}
/**
* Retrieve the arguments defined in `set_args`.
*
* @since 3.2.0
* @since 3.15.0 Fix filter name.
*
* @return array
*/
public function get_args() {
$default = array(
'page' => $this->get_current_page(),
'order' => $this->get_order(),
'orderby' => $this->get_orderby(),
);
if ( $this->is_filterable ) {
$default['filter'] = $this->get_filter();
$default['filterby'] = $this->get_filterby();
}
if ( $this->is_searchable ) {
$default['search'] = $this->get_search();
}
$args = wp_parse_args( $this->set_args(), $default );
/**
* Filters the arguments used to build the query.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the table.
*
* @since 3.15.0
*
* @param array $args Arguments to build the query whose results will populate the table.
*/
return apply_filters( "llms_table_get_args_{$this->id}", $args );
}
/**
* Retrieve the array of columns defined by set_columns.
* @since 3.2.0
* @since 3.24.0 Unknown.
*
* @param string $context Display context [display|export].
* @return array
*/
public function get_columns( $context = 'display' ) {
/**
* Filters the array of table columns.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the table.
*
* @since 3.2.0
*
* @param array $columns The array of table columns.
* @param string $context Display context [display|export].
*/
$cols = apply_filters( "llms_table_get_{$this->id}_columns", $this->set_columns(), $context );
if ( $this->is_exportable ) {
foreach ( $cols as $id => $data ) {
if ( ! $this->is_col_visible( $data, $context ) ) {
unset( $cols[ $id ] );
}
}
}
return $cols;
}
/**
* Get the current page.
*
* @since 3.2.0
*
* @return int
*/
public function get_current_page() {
return $this->current_page;
}
/**
* Get `$this->empty_msg` string.
*
* @since 3.2.0
* @since 3.15.0 Fix filter name.
*
* @return string
*/
public function get_empty_message() {
/**
* Filters the message displayed when the table is empty.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the table.
*
* @since 3.15.0
*
* @param string $columns The message displayed when the table is empty.
*/
return apply_filters( "llms_table_get_{$this->id}_empty_message", $this->set_empty_message() );
}
/**
* Get the text for the default/placeholder for a filterable column.
*
* @since 3.4.0
* @since 3.15.0 Fix filter name.
* @since 7.3.0 Fixed typo in function name (`is_strinp` => `is_string` ).
*
* @param string $column_id The ID of the column.
* @return string
*/
public function get_filter_placeholder( $column_id, $column_data ) {
$placeholder = __( 'Any', 'lifterlms' );
if ( is_array( $column_data ) && isset( $column_data['title'] ) ) {
/* translators: %s: Column title. */
$placeholder = sprintf( __( 'Any %s', 'lifterlms' ), $column_data['title'] );
} elseif ( is_string( $column_data ) ) {
/* translators: %s: Column title. */
$placeholder = sprintf( __( 'Any %s', 'lifterlms' ), $column_data );
}
/**
* Filters the placeholder string for a filterable column.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the table.
*
* @since 3.15.0
*
* @param string $placeholder Placeholder string.
* @param string $column_id The ID of the column.
*/
return apply_filters( "llms_table_get_{$this->id}_filter_placeholder", $placeholder, $column_id );
}
/**
* Get the current filter.
*
* @since 3.4.0
*
* @return string
*/
public function get_filter() {
return $this->filter;
}
/**
* Get the current field results are filtered by.
*
* @since 3.4.0
*
* @return string
*/
public function get_filterby() {
return $this->filterby;
}
/**
* Retrieve a modified classname that can be passed via AJAX for new queries.
*
* @since 3.2.0
*
* @return string
*/
public function get_handler() {
return str_replace( 'LLMS_Table_', '', get_class( $this ) );
}
/**
* Retrieve the max number of pages for the table.
*
* @since 3.15.0
*
* @return int
*/
public function get_max_pages() {
return $this->max_pages;
}
/**
* Get the current sort order.
*
* @since 3.2.0
*
* @return string
*/
public function get_order() {
return $this->order;
}
/**
* Get the current field results are ordered by.
*
* @since 3.2.0
*
* @return string
*/
public function get_orderby() {
return $this->orderby;
}
/**
* Get the current number of results to display per page.
*
* @since 3.28.0
*
* @return int
*/
public function get_per_page() {
return $this->per_page;
}
/**
* Gets the opposite of the current order.
*
* Used to determine what order should be displayed when resorting.
*
* @since 3.2.0
*
* @return string
*/
protected function get_new_order( $orderby = '' ) {
// Current order matches submitted order, return opposite.
if ( $this->orderby === $orderby ) {
return ( 'ASC' === $this->order ) ? 'DESC' : 'ASC';
} else {
return 'ASC';
}
}
/**
* Retrieves the current search query.
*
* @since 3.2.0
*
* @return string
*/
public function get_search() {
return esc_attr( trim( $this->search ) );
}
/**
* Returns an array of CSS class names to use on this table.
*
* @since 3.34.0
*
* @return array
*/
protected function get_table_classes() {
$classes = array(
'llms-table',
'llms-gb-table',
'llms-gb-table-' . $this->id,
);
if ( $this->is_zebra ) {
$classes[] = 'zebra';
}
if ( $this->is_large ) {
$classes[] = 'size-large';
}
/**
* Filters the CSS classes to use on the table.
*
* @since 3.34.0
*
* @param array $classes CSS class names.
* @param array $table_id Id property of this table object.
*/
return apply_filters( 'llms_table_get_table_classes', $classes, $this->id );
}
/**
* Get HTML for the filters displayed in the head of the table.
*
* @since 3.4.0
*
* @return string
* @deprecated 7.7.0 Use output_table_filters_html() instead.
*/
public function get_table_filters_html() {
ob_start();
$this->output_table_filters_html();
return ob_get_clean();
}
/**
* Output HTML for the filters displayed in the head of the table.
*
* @since 7.7.0
*
* @return string
*/
public function output_table_filters_html() {
?>
<div class="llms-table-filters">
<?php foreach ( $this->get_columns() as $id => $data ) : ?>
<?php if ( is_array( $data ) && isset( $data['filterable'] ) && is_array( $data['filterable'] ) ) : ?>
<div class="llms-table-filter-wrap">
<select class="llms-select2 llms-table-filter" id="<?php echo esc_attr( sprintf( '%1$s-%2$s-filter', $this->id, $id ) ); ?>" name="<?php echo esc_attr( $id ); ?>">
<option value="<?php echo esc_attr( $this->get_filter() ); ?>"><?php echo esc_html( $this->get_filter_placeholder( $id, $data ) ); ?></option>
<?php foreach ( $data['filterable'] as $val => $name ) : ?>
<option value="<?php echo esc_attr( $val ); ?>"><?php echo esc_html( $name ); ?></option>
<?php endforeach; ?>
</select>
</div>
<?php endif; ?>
<?php endforeach; ?>
</div>
<?php
}
/**
* Return the HTML for the entire table.
*
* @since 3.2.0
* @since 3.17.8 Unknown.
* @since 3.37.7 Use correct argument order for implode to fix php 7.4 deprecation.
* @since 7.8.0 Added button for clearing resumable attempts.
*
* @return string
* @deprecated 7.7.0 Use output_table_html() instead.
*/
public function get_table_html() {
ob_start();
$this->output_table_html();
return ob_get_clean();
}
/**
* Output the HTML for the entire table.
*
* @since 7.7.0
*
* @return void
*/
public function output_table_html() {
$classes = $this->get_table_classes();
?>
<div class="llms-table-wrap">
<header class="llms-table-header">
<?php $this->output_table_title_html(); ?>
<?php if ( $this->is_searchable ) : ?>
<?php $this->output_table_search_form_html(); ?>
<?php endif; ?>
<?php if ( $this->is_filterable ) : ?>
<?php $this->output_table_filters_html(); ?>
<?php endif; ?>
</header>
<table
class="<?php echo esc_attr( implode( ' ', $classes ) ); ?>"
data-args='<?php echo esc_attr( wp_json_encode( $this->get_args() ) ); ?>'
data-handler="<?php echo esc_attr( $this->get_handler() ); ?>"
id="llms-gb-table-<?php echo esc_attr( $this->id ); ?>"
>
<?php $this->output_thead_html(); ?>
<?php $this->output_tbody_html(); ?>
<?php $this->output_tfoot_html(); ?>
</table>
</div>
<?php
}
/**
* Get the HTML of the search form for a searchable table.
*
* @since 3.2.0
*
* @return string
* @deprecated 7.7.0 Use output_table_search_form_html() instead.
*/
public function get_table_search_form_html() {
ob_start();
$this->output_table_search_form_html();
return ob_get_clean();
}
/**
* Output the HTML of the search form for a searchable table.
*
* @since 3.2.0
*
* @return string
*/
public function output_table_search_form_html() {
?>
<div class="llms-table-search">
<input class="regular-text" id="<?php echo esc_attr( $this->id ); ?>-search-input" placeholder="<?php echo esc_attr( $this->get_table_search_form_placeholder() ); ?>" type="text">
</div>
<?php
}
/**
* Get the Text to be used as the placeholder in a searchable tables search input.
*
* @since 3.2.0
* @since 3.15.0 Fix filter name.
*
* @return string
*/
public function get_table_search_form_placeholder() {
/**
* Filters the text to be used as the placeholder in a searchable tables search input.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the table.
*
* @since 3.15.0
*
* @param string $text Text to be used as the placeholder in a searchable tables search input.
*/
return apply_filters( "llms_table_get_{$this->id}_search_placeholder", __( 'Search', 'lifterlms' ) );
}
/**
* Get the HTML for the table's title.
*
* @since 3.2.0
* @since 3.15.0 Unknown.
*
* @return string
* @deprecated 7.7.0 Use output_table_title_html() instead.
*/
public function get_table_title_html() {
ob_start();
$this->output_table_title_html();
return ob_get_clean();
}
/**
* Output the HTML for the table's title.
*
* @since 7.7.0
*
* @return void
*/
public function output_table_title_html() {
$title = $this->get_title();
if ( $title ) {
echo '<h2 class="llms-table-title">' . esc_html( $title ) . '</h2>';
}
}
/**
* Get `$this->tbody_data` array.
* @since 3.2.0
* @since 3.15.0 Fix filter name.
*
* @return array
*/
public function get_tbody_data() {
/**
* Filters the array of tbody data.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the table.
*
* @since 3.15.0
*
* @param array $tbody_data Array of data that will be used to create the table body.
*/
return apply_filters( "llms_table_get_{$this->id}_tbody_data", $this->tbody_data );
}
/**
* Get a tbody element for the table.
*
* @since 3.2.0
*
* @return string
* @deprecated 7.7.0 Use output_tbody_html() instead.
*/
public function get_tbody_html() {
ob_start();
$this->output_tbody_html();
return ob_get_clean();
}
/**
* Output a tbody element for the table.
*
* @since 7.7.0
*
* @return void
*/
public function output_tbody_html() {
$data = $this->get_tbody_data();
?>
<tbody>
<?php if ( $data ) : ?>
<?php foreach ( $data as $row ) : ?>
<?php $this->output_tr_html( $row ); ?>
<?php endforeach; ?>
<?php else : ?>
<tr><td class="llms-gb-table-empty" colspan="<?php echo esc_attr( $this->get_columns_count() ); ?>"><p><?php echo esc_html( $this->get_empty_message() ); ?></p></td></tr>
<?php endif; ?>
</tbody>
<?php
}
/**
* Get a tfoot element for the table.
*
* @since 3.2.0
* @since 3.28.0 Unknown.
*
* @return string
* @deprecated 7.7.0 Use output_tfoot_html() instead.
*/
public function get_tfoot_html() {
ob_start();
$this->output_tfoot_html();
return ob_get_clean();
}
/**
* Output a tfoot element for the table.
*
* @since 7.7.0
*
* @return void
*/
public function output_tfoot_html() {
?>
<tfoot>
<tr>
<th colspan="<?php echo esc_attr( $this->get_columns_count() ); ?>">
<?php if ( $this->has_resumable_attempts() ) : ?>
<div class="llms-clear-resumable-attempts">
<form action="" method="POST">
<button class="llms-button-primary small" name="llms_quiz_resumable_attempt_action" type="submit" value="llms_clear_resumable_attempts">
<i class="fa fa-trash-o" aria-hidden="true"></i>
<?php echo esc_html( __( 'Clear resumable attempts', 'lifterlms' ) ); ?>
</button>
<input type="hidden" name="llms_quiz_id" value="<?php echo esc_attr( $this->quiz_id ); ?>">
<?php wp_nonce_field( 'llms_quiz_attempt_actions', '_llms_quiz_attempt_nonce' ); ?>
</form>
</div>
<?php endif; ?>
<?php if ( $this->is_exportable ) : ?>
<div class="llms-table-export">
<button class="llms-button-primary small" name="llms-table-export">
<span class="dashicons dashicons-download"></span> <?php esc_html_e( 'Export', 'lifterlms' ); ?>
</button>
<?php $this->output_progress_bar_html( 0 ); ?>
<em><small class="llms-table-export-msg"></small></em>
</div>
<?php endif; ?>
<?php if ( $this->is_paginated ) : ?>
<div class="llms-table-pagination">
<?php if ( $this->max_pages ) : ?>
<span class="llms-table-page-count">
<?php
/* translators: %1$d: Current page, %2$d: Total page count. */
echo esc_html( sprintf( esc_html_x( '%1$d of %2$d', 'pagination', 'lifterlms' ), $this->current_page, $this->max_pages ) );
?>
</span>
<?php endif; ?>
<?php if ( 1 !== $this->get_current_page() ) : ?>
<?php if ( $this->max_pages ) : ?>
<button class="llms-button-primary small" data-page="1" name="llms-table-paging"><span class="dashicons dashicons-arrow-left-alt"></span> <?php esc_html_e( 'First', 'lifterlms' ); ?></button>
<?php endif; ?>
<button class="llms-button-primary small" data-page="<?php echo esc_attr( $this->current_page - 1 ); ?>" name="llms-table-paging"><span class="dashicons dashicons-arrow-left-alt2"></span> <?php esc_html_e( 'Back', 'lifterlms' ); ?></button>
<?php endif; ?>
<?php if ( ! $this->is_last_page ) : ?>
<button class="llms-button-primary small" data-page="<?php echo esc_attr( $this->current_page + 1 ); ?>" name="llms-table-paging"><?php esc_html_e( 'Next', 'lifterlms' ); ?> <span class="dashicons dashicons-arrow-right-alt2"></span></button>
<?php if ( $this->max_pages ) : ?>
<button class="llms-button-primary small" data-page="<?php echo esc_attr( $this->max_pages ); ?>" name="llms-table-paging"><?php esc_html_e( 'Last', 'lifterlms' ); ?> <span class="dashicons dashicons-arrow-right-alt"></span></button>
<?php endif; ?>
<?php endif; ?>
</div>
<?php endif; ?>
</th>
</tr>
</tfoot>
<?php
}
/**
* Check if any quiz has resumable attempts.
*
* @since 7.8.0
*
* @return bool
*/
public function has_resumable_attempts() {
if ( 'quizzes' === llms_filter_input( INPUT_GET, 'tab' ) && 'attempts' === llms_filter_input( INPUT_GET, 'stab' ) ) {
$admin_quiz_attempts = new LLMS_Controller_Admin_Quiz_Attempts();
$quizzes = $admin_quiz_attempts->get_resumable_attempts( $this->quiz_id );
return ! empty( $quizzes );
}
return false;
}
/**
* Get a thead element for the table.
*
* @since 3.2.0
*
* @return string
* @deprecated 7.7.0 Use output_thead_html() instead.
*/
public function get_thead_html() {
ob_start();
$this->output_thead_html();
return ob_get_clean();
}
/**
* Output the thead element for the table.
*
* @since 7.7.0
*
* @return void
*/
public function output_thead_html() {
?>
<thead>
<tr>
<?php foreach ( $this->get_columns() as $id => $data ) : ?>
<th class="<?php echo esc_attr( $id ); ?>">
<?php if ( is_array( $data ) ) : ?>
<?php if ( isset( $data['sortable'] ) && $data['sortable'] ) : ?>
<a class="llms-sortable<?php echo ( $this->get_orderby() === $id ) ? ' active' : ''; ?>" data-order="<?php echo esc_attr( $this->get_new_order( $id ) ); ?>" data-orderby="<?php echo esc_attr( $id ); ?>" href="#llms-gb-table-resort">
<?php echo esc_html( $data['title'] ); ?>
<span class="dashicons dashicons-arrow-up asc"></span>
<span class="dashicons dashicons-arrow-down desc"></span>
</a>
<?php else : ?>
<?php echo esc_html( $data['title'] ); ?>
<?php endif; ?>
<?php else : ?>
<?php echo esc_html( $data ); ?>
<?php endif; ?>
</th>
<?php endforeach; ?>
</tr>
</thead>
<?php
}
/**
* Get a CSS class list (as a string) for each TR.
*
* @since 3.24.0
*
* @param mixed $row Object/array of data that the function can use to extract the data.
* @return string
*/
protected function get_tr_classes( $row ) {
/**
* Filters the CSS class of a table row.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the table.
*
* @since 3.24.0
*
* @param string $class CSS class list (as a string) for a given TR.
* @param mixed $row Object/array of data that the function can use to extract the data.
*/
return apply_filters( "llms_table_get_{$this->id}_tr_classes", 'llms-table-tr', $row );
}
/**
* Get the HTML for a single row in the body of the table.
*
* @since 3.2.0
* @since 3.21.0 Fix action hooks names.
*
* @param mixed $row Array/object of data describing a single row in the table.
* @return string
* @deprecated 7.7.0 Use output_tr_html() instead.
*/
public function get_tr_html( $row ) {
ob_start();
$this->output_tr_html( $row );
return ob_get_clean();
}
/**
* Output the HTML for a single row in the body of the table.
*
* @since 7.7.0
*
* @param mixed $row Array/object of data describing a single row in the table.
* @return void
*/
public function output_tr_html( $row ) {
/**
* Fired before a table `<tr>`.
*
* @since 3.21.0
*
* @param string $row Array/object of data describing a single row in the table.
* @param LLMS_Admin_Table $table_object Instance of the class extending `LLMS_Admin_Table`.
*/
do_action( 'llms_table_before_tr', $row, $this );
?>
<tr class="<?php echo esc_attr( $this->get_tr_classes( $row ) ); ?>">
<?php foreach ( $this->get_columns() as $id => $title ) : ?>
<td class="<?php echo esc_attr( $id ); ?>">
<?php echo $this->get_data( $id, $row ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
</td>
<?php endforeach; ?>
</tr>
<?php
/**
* Fired after a table `<tr>`.
*
* @since 3.21.0
*
* @param string $row Array/object of data describing a single row in the table.
* @param LLMS_Admin_Table $table_object Instance of the class extending `LLMS_Admin_Table`.
*/
do_action( 'llms_table_after_tr', $row, $this );
}
/**
* Get the total number of columns in the table.
*
* Useful for creating full width tds via colspan.
*
* @since 3.2.0
*
* @return int
*/
public function get_columns_count() {
return count( $this->get_columns() );
}
/**
* Get the HTML to output a progress bar within a td.
*
* Improve ugly tables with a small visual flourish.
* Useful when displaying a percentage within a table!
* Bonus if the table sorts by that percentage column.
*
* @since 3.4.1
*
* @param float $percentage The percentage to be displayed.
* @param string $text Text to display over the progress bar, defaults to $percentage.
* @return string
* @deprecated 7.7.0 Use output_progress_bar_html() instead.
*/
public function get_progress_bar_html( $percentage, $text = '' ) {
ob_start();
$this->output_progress_bar_html( $percentage, $text );
return ob_get_clean();
}
/**
* Output the HTML to output a progress bar within a td.
*
* Improve ugly tables with a small visual flourish.
* Useful when displaying a percentage within a table!
* Bonus if the table sorts by that percentage column.
*
* @since 7.7.0
*
* @param float $percentage The percentage to be displayed.
* @param string $text Text to display over the progress bar, defaults to $percentage.
* @return void
*/
public function output_progress_bar_html( $percentage, $text = '' ) {
$text = $text ? $text : $percentage . '%';
?>
<div class="llms-table-progress">
<div class="llms-table-progress-bar"><div class="llms-table-progress-inner" style="width:<?php echo esc_attr( $percentage ); ?>%"></div></div>
<span class="llms-table-progress-text"><?php echo esc_html( $text ); ?></span>
</div>
<?php
}
/**
* Get the HTML for a WP Post Link.
*
* @since 3.2.0
*
* @param int $post_id WP Post ID.
* @param string $text Optional text to display within the anchor, if none supplied $post_id if used.
* @return string
*/
public function get_post_link( $post_id, $text = '' ) {
if ( ! $text ) {
$text = $post_id;
}
return '<a href="' . esc_url( get_edit_post_link( $post_id ) ) . '">' . $text . '</a>';
}
/**
* Get the title of the table.
*
* @since 3.15.0
*
* @return string
*/
public function get_title() {
/**
* Filters the table title.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the table.
*
* @since 3.15.0
*
* @param string $title The title of the table.
*/
return apply_filters( "llms_table_get_{$this->id}_table_title", $this->title );
}
/**
* Get the HTML for a WP User Link.
*
* @since 3.17.2
*
* @param int $user_id WP User ID.
* @param string $text Optional text to display within the anchor, if none supplied $user_id if used.
* @return string
*/
public function get_user_link( $user_id, $text = '' ) {
if ( ! $text ) {
$text = $user_id;
}
return '<a href="' . esc_url( get_edit_user_link( $user_id ) ) . '">' . $text . '</a>';
}
/**
* Determine if a column is visible based on the current context.
*
* @since 3.15.0
*
* @param array $data Array of a single column's data from `set_columns()`.
* @param string $context Context [display|export].
* @return bool
*/
private function is_col_visible( $data, $context = 'display' ) {
// Display if 'export_only' does not exist or it does exist and is false.
if ( 'display' === $context ) {
return ( ! isset( $data['export_only'] ) || ! $data['export_only'] );
// Display if exportable is set and is true.
} elseif ( 'export' === $context ) {
return ( isset( $data['exportable'] ) && $data['exportable'] );
}
return true;
}
/**
* Return protected is_last_page var.
*
* @since 3.15.0
*
* @return bool
*/
public function is_last_page() {
return $this->is_last_page;
}
/**
* Allow custom hooks to be registered for use within the class.
*
* @since 3.2.0
*
* @return void
*/
protected function register_hooks() {}
/**
* Setter.
*
* @since 2.3.0
*
* @param string $key Variable name.
* @param mixed $val Variable data.
* @return void
*/
public function set( $key, $val ) {
$this->$key = $val;
}
/**
* Empty message displayed when no results are found.
*
* @since 3.2.0
* @since 3.15.0 Fix filter name.
*
* @return string
*/
protected function set_empty_message() {
/**
* Filters the default message displayed when the table is empty.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the table.
*
* @since 3.15.0
*
* @param string $columns The default message displayed when the table is empty.
*/
return apply_filters( 'llms_table_default_empty_message', __( 'No results were found.', 'lifterlms' ) );
}
/**
* Stub used to set the title during table construction.
*
* @since 3.28.0
*
* @return string
*/
protected function set_title() {
return '';
}
}
================================================
FILE: includes/abstracts/abstract.llms.analytics.widget.php
================================================
<?php
/**
* Analytics Widget Abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.0.0
* @version 7.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Analytics Widget abstract class.
*
* @since 3.0.0
* @since 3.30.3 Define undefined properties.
* @since 3.33.1 In `set_order_data_query()` always set $order_clause variable to avoid PHP notices.
* @since 3.35.0 Sanitize input data from reporting filters.
* @since 3.36.3 Avoid warnings on using wpdb::prepare without placeholders.
* @since 4.0.0 Remove previously deprecated class properties: `$date_end`, `$date_start`, & `$date_end`.
*/
abstract class LLMS_Analytics_Widget {
/**
* @var array
* @since 3.0.0
*/
public $chart_data;
/**
* @var bool
* @since 3.0.0
*/
public $charts = false;
/**
* @var string
* @since 3.0.0
*/
public $message = '';
/**
* One of the wpdb constants: OBJECT, OBJECT_K, ARRAY_A, or ARRAY_N
*
* @var string
* @since 3.0.0
*/
protected $output_type;
/**
* @var string
* @since 3.0.0
*/
protected $prepared_query;
/**
* @var string
* @since 3.0.0
*/
protected $query;
/**
* @var string
* @since 3.0.0
*/
protected $query_function;
/**
* @var array
* @since 1.0.0
*/
protected $query_vars;
/**
* @var int
* @since 3.0.0
*/
public $response;
/**
* @var array
* @since 1.0.0
*/
public $results = array();
/**
* @var bool
* @since 3.0.0
*/
public $success = false;
abstract protected function format_response();
abstract protected function set_query();
protected function get_chart_data() {
return array(
'type' => 'count',
'header' => array(
'id' => '',
'label' => '',
'type' => 'string',
),
);
}
public function __construct() {}
/**
* Retrieve posted dates.
*
* @since 3.0.0
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return string[]|string
*/
protected function get_posted_dates() {
$dates = llms_filter_input_sanitize_string( INPUT_POST, 'dates', array( FILTER_REQUIRE_ARRAY ) );
return $dates ? $dates : '';
}
protected function get_posted_courses() {
$courses = llms_filter_input( INPUT_POST, 'courses', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY );
return $courses ? $courses : array();
}
protected function get_posted_memberships() {
$memberships = llms_filter_input( INPUT_POST, 'memberships', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY );
return $memberships ? $memberships : array();
}
protected function get_posted_posts() {
return array_merge( $this->get_posted_courses(), $this->get_posted_memberships() );
}
protected function get_posted_students() {
$students = llms_filter_input( INPUT_POST, 'students', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY );
return $students ? $students : array();
}
protected function get_prepared_query() {
return $this->prepared_query;
}
protected function get_query() {
return $this->query;
}
protected function get_query_vars() {
return $this->query_vars;
}
protected function get_results() {
return $this->results;
}
protected function format_date( $date, $type ) {
switch ( $type ) {
case 'start':
$date .= ' 00:00:00';
break;
case 'end':
/**
* Return 00:00:00 on the next day after this date, using PHP datetime functions to avoid issues with daylight savings time or leap years.
*
* 23:59:59 is not a safe way to capture the end of day in newer versions of MySQL, if the transaction happened at (say) 23:59:59.999.
*/
$end_date = new DateTime( $date );
$end_date->modify( '+1 day' );
$date = $end_date->format( 'Y-m-d' ) . ' 00:00:00';
break;
}
return $date;
}
protected function is_error() {
return ( $this->success ) ? false : true;
}
protected function set_order_data_query( $args = array() ) {
extract(
wp_parse_args(
$args,
array(
'select' => array( '*' ),
'date_range' => true, // whether or not to add a "where" for the posted date range.
'date_field' => 'post_date',
'query_function' => 'get_results', // query function to pass to $wpdb->query().
'output_type' => OBJECT,
'joins' => array(), // array of JOIN statements.
'statuses' => array(), // array of order statuses to query.
'wheres' => array(), // array of "WHERE" statements.
'order' => 'ASC',
'orderby' => '',
)
)
);
$this->query_function = $query_function;
$this->query_vars = array();
$this->output_type = $output_type;
global $wpdb;
// setup student join & where clauses.
$students = $this->get_posted_students();
$students_join = '';
$students_where = '';
if ( $students ) {
$students_join = "JOIN {$wpdb->postmeta} AS m1 ON orders.ID = m1.post_id";
$students_where .= "AND m1.meta_key = '_llms_user_id'";
$students_where .= ' AND m1.meta_value IN ( ' . implode( ', ', $students ) . ' )';
}
// setup post (product) joins & where clauses.
$posts = $this->get_posted_posts();
$products_join = '';
$products_where = '';
if ( $posts ) {
$products_join = "JOIN {$wpdb->postmeta} AS m2 ON orders.ID = m2.post_id";
$products_where .= "AND m2.meta_key = '_llms_product_id'";
$products_where .= ' AND m2.meta_value IN ( ' . implode( ', ', $posts ) . ' )';
}
$order_dates = '';
if ( $date_range ) {
$dates = $this->get_posted_dates();
$order_dates = "AND orders.{$date_field} >= CAST( %s as DATETIME ) AND orders.{$date_field} < CAST( %s as DATETIME )";
$this->query_vars[] = $this->format_date( $dates['start'], 'start' );
$this->query_vars[] = $this->format_date( $dates['end'], 'end' );
}
// setup post status conditions in the where clause.
$post_statuses = '';
if ( $statuses ) {
$post_statuses .= ' AND ( ';
foreach ( $statuses as $i => $status ) {
if ( $i > 0 ) {
$post_statuses .= ' OR ';
}
$post_statuses .= 'post_status = %s';
$this->query_vars[] = $status;
}
$post_statuses .= ' )';
}
// setup the select clause.
$select_clause = '';
foreach ( $select as $i => $s ) {
if ( $i > 0 ) {
$select_clause .= ', ';
}
$select_clause .= $s;
}
$joins_clause = '';
foreach ( $joins as $join ) {
$joins_clause .= $join . "\r\n";
}
$wheres_clause = '';
foreach ( $wheres as $where ) {
$wheres_clause .= $where . "\r\n";
}
$order_clause = '';
if ( $order && $orderby ) {
$order_clause = 'ORDER BY ' . $orderby . ' ' . $order;
}
$this->query = "SELECT {$select_clause}
FROM {$wpdb->posts} AS orders
{$students_join}
{$products_join}
{$joins_clause}
WHERE orders.post_type = 'llms_order'
{$order_dates}
{$post_statuses}
{$students_where}
{$products_where}
{$wheres_clause}
{$order_clause}
;";
}
/**
* Perform the query.
*
* @since unknown.
* @since 3.36.3 Avoid warnings on using wpdb::prepare without placeholders.
*/
protected function query() {
global $wpdb;
// Roughly avoid warnings on using wpdb::prepare without placeholders.
// The following strpos simple check is the same wpdb::prepare() does to check the correct usage.
if ( strpos( $this->query, '%' ) === false || empty( $this->query_vars ) ) {
$query = $this->query;
} else {
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- It is prepared.
$query = $wpdb->prepare( $this->query, $this->query_vars );
// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared
}
// no output options.
if ( in_array( $this->query_function, array( 'get_var', 'get_col' ), true ) ) {
$this->results = $wpdb->{$this->query_function}( $query );
} else {
$this->results = $wpdb->{$this->query_function}( $query, $this->output_type );
}
$this->prepared_query = trim( str_replace( array( "\r", "\n", "\t", ' ' ), ' ', $wpdb->last_query ) );
if ( ! $wpdb->last_error ) {
$this->success = true;
$this->message = 'success';
} else {
$this->message = $wpdb->last_error;
}
}
/**
* Whether or not the current widget can be processed/displayed.
*
* @since 7.3.0
*
* @return true|WP_Error True if the widget can be processed, `WP_Error` otherwise.
*/
protected function _can_be_processed() { // phpcs:ignore -- PSR2.Methods.MethodDeclaration.Underscore.
$can_be_processed = true;
if ( ! current_user_can( 'view_others_lifterlms_reports' ) ) {
$can_be_processed = new WP_Error(
WP_Http::FORBIDDEN, // 403.
esc_html__( 'You are not authorized to access the requested widget', 'lifterlms' )
);
}
return $can_be_processed;
}
/**
* Whether or not the current widget can be processed/displayed.
*
* @since 7.3.0
*
* @return true|WP_Error
*/
public function can_be_processed() {
$widget_name = str_replace(
array( 'llms_analytics_', '_widget' ),
'',
strtolower( get_class( $this ) )
);
/**
* Whether or not the current widget can be processed/displayed.
*
* @param true|WP_Error True if the widget can be processed, `WP_Error` otherwise.
* @param string The widget name.
* @param LLMS_Analytics_Widget The instance extending `LLMS_Analytics_Widget`.
*/
return apply_filters(
'llms_can_analytics_widget_be_processed',
$this->_can_be_processed(),
$widget_name,
$this
);
}
/**
* Output widget.
*
* @since 3.0.0
* @since 7.3.0 Use `wp_json_encode` in place of the deprecated `json_encode`.
*
* @return void
*/
public function output() {
$this->set_query();
$this->query();
$this->response = $this->format_response();
if ( $this->charts ) {
$this->chart_data = $this->get_chart_data();
}
header( 'Content-Type: application/json' );
echo wp_json_encode( $this );
wp_die();
}
}
================================================
FILE: includes/abstracts/abstract.llms.database.query.php
================================================
<?php
/**
* Database Query Abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.8.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Database Query abstract class.
*
* @since 3.8.0
* @since 3.30.3 `is_last_page()` method returns `true` when no results are found.
* @since 3.34.0 Sanitizes sort parameters.
*/
abstract class LLMS_Database_Query extends LLMS_Abstract_Query {
/**
* Identify the extending query.
*
* @var string
*/
protected $id = 'database';
/**
* SQL query used to count total found results.
*
* Set by subclasses in prepare_query() from the same clause
* variables (FROM, JOIN, WHERE) used for the main query.
*
* @since 10.0.0
*
* @var string
*/
protected $count_query = '';
/**
* Retrieve query argument default values.
*
* @since 6.0.0
*
* @return array
*/
protected function default_arguments() {
return wp_parse_args(
array(
'per_page' => 25,
'sort' => array(
'id' => 'ASC',
),
),
parent::default_arguments()
);
}
/**
* Escape and add quotes to a string, useful for array mapping when building queries.
*
* @since 3.8.0
* @since 6.0.0 Use {@see llms_esc_and_quote_str()}.
*
* @param mixed $input Input data.
* @return string
*/
public function escape_and_quote_string( $input ) {
return llms_esc_and_quote_str( $input );
}
/**
* Retrieve default arguments for the query.
*
* @since 3.8.0
* @since 4.5.1 Added new default arg `no_found_rows` set to false.
* @since 6.0.0 Call parent method.
*
* @todo This should be removed in favor of the parent method only when the
* `llms_db_query_get_default_args` hook is removed.
*
* @return array
*/
protected function get_default_args() {
if ( $this->get( 'suppress_filters' ) ) {
return $this->default_arguments();
}
// Get them from the parent with the new replacement filter.
$args = parent::get_default_args();
/**
* Filters the query default args.
*
* @since 3.8.0
* @deprecated 6.0.0 Filter `llms_db_query_get_default_args` is deprecated in favor of `llms_{$this->id}_query_get_default_args`.
*
* @param array $args Array of default arguments to set up the query with.
*/
return apply_filters_deprecated( 'llms_db_query_get_default_args', array( $args ), '6.0.0', "llms_{$this->id}_query_get_default_args" );
}
/**
* Get a string used as filter names unique to the extending query.
*
* @since 3.8.0
*
* @todo Deprecate.
*
* @param string $filter Filter name.
* @return string
*/
protected function get_filter( $filter ) {
return 'llms_' . $this->id . '_query_' . $filter;
}
/**
* Get the number of results to skip for the query based on the current page and per_page vars.
*
* @since 3.8.0
*
* @return int
*/
protected function get_skip() {
return absint( ( $this->get( 'page' ) - 1 ) * $this->get( 'per_page' ) );
}
/**
* Performs the SQL query.
*
* @since 6.0.0
*
* @return array An integer-keyed array of row objects.
*/
protected function perform_query() {
global $wpdb;
return $wpdb->get_results( $this->query ); // phpcs:ignore: WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.NotPrepared
}
/**
* Set variables related to total number of results and pages possible with supplied arguments.
*
* @since 3.8.0
* @since 4.5.1 Bail early if the query arg `no_found_rows` is true, b/c no reason to calculate anything.
* @deprecated 6.0.0 `LLMS_Database_Query::set_found_results()` is deprecated.
*
* @return void
*/
protected function set_found_results() {
_deprecated_function( 'LLMS_Database_Query::set_found_results()', '6.0.0' );
// If no results, or found rows not required, bail early b/c no reason to calculate anything.
if ( ! $this->number_results || $this->get( 'no_found_rows' ) ) {
return;
}
$this->found_results = $this->found_results();
$this->max_pages = absint( ceil( $this->found_results / $this->get( 'per_page' ) ) );
}
/**
* Retrieve the total number of found results for the given query.
*
* Uses a separate COUNT(*) query built from the same SQL clauses as the
* main query, set by subclasses in prepare_query().
*
* @since 6.0.0
* @since 10.0.0 Replaced FOUND_ROWS() with $this->count_query.
*
* @return int
*/
protected function found_results() {
global $wpdb;
if ( empty( $this->count_query ) ) {
return 0;
}
return (int) $wpdb->get_var( $this->count_query ); // db call ok; no-cache ok.
}
/**
* Retrieve the prepared SQL for the SELECT clause.
*
* @since 4.5.1
* @since 10.0.0 Removed SQL_CALC_FOUND_ROWS; found results are now counted via a separate query.
*
* @param string $select_columns Optional. Columns to select. Default '*'.
* @return string
*/
protected function sql_select_columns( $select_columns = '*' ) {
if ( $this->get( 'suppress_filters' ) ) {
return $select_columns;
}
/**
* Filters the query SELECT columns.
*
* The dynamic part of the filter `$this->id` identifies the extending query.
*
* @since 4.5.1
*
* @param string $select_columns Columns to select.
* @param LLMS_Database_Query $db_query Instance of LLMS_Database_Query.
*/
return apply_filters( "llms_{$this->id}_query_select_columns", $select_columns, $this );
}
/**
* Retrieve the prepared SQL for the LIMIT clause.
*
* @since 3.16.0
* @since 4.5.1 Drop use of `$this->get_filter('limit')` in favor of `"llms_{$this->id}_query_limit"`.
* @since 10.0.0 Returns empty string for count_only queries.
*
* @return string
*/
protected function sql_limit() {
if ( $this->get( 'count_only' ) ) {
return '';
}
global $wpdb;
$sql = $wpdb->prepare( 'LIMIT %d, %d', $this->get_skip(), $this->get( 'per_page' ) );
/**
* Filters the query LIMIT clause.
*
* The dynamic part of the filter `$this->id` identifies the extending query.
*
* @since 3.16.0
*
* @param string $sql The LIMIT clause of the query.
* @param LLMS_Database_Query $db_query The LLMS_Database_Query instance.
*/
return apply_filters( "llms_{$this->id}_query_limit", $sql, $this );
}
/**
* Retrieve the prepared SQL for the ORDER BY clause.
*
* @since 3.8.0
* @since 3.34.0 Returns an empty string if no sort fields are available.
* @since 4.5.1 Drop use of `$this->get_filter('orderby')` in favor of `"llms_{$this->id}_query_orderby"`.
*
* @return string
*/
protected function sql_orderby() {
$sql = '';
// No point in ordering if we're just counting.
if ( $this->get( 'count_only' ) ) {
return $sql;
}
$sort = $this->get( 'sort' );
if ( $sort ) {
$sql = 'ORDER BY';
$comma = false;
foreach ( $sort as $orderby => $order ) {
$pre = ( $comma ) ? ', ' : ' ';
$sql .= $pre . sanitize_sql_orderby( "{$orderby} {$order}" );
$comma = true;
}
}
if ( $this->get( 'suppress_filters' ) ) {
return $sql;
}
/**
* Filters the query ORDER BY clause.
*
* The dynamic part of the filter `$this->id` identifies the extending query.
*
* @since 3.8.0
*
* @param string $sql The ORDER BY clause of the query.
* @param LLMS_Database_Query $db_query The LLMS_Database_Query instance.
*/
return apply_filters( "llms_{$this->id}_query_orderby", $sql, $this );
}
/**
* Execute a query.
*
* Overrides the parent to detect if a filter re-added SQL_CALC_FOUND_ROWS
* to the query, and falls back to FOUND_ROWS() if so.
*
* Also warns when a subclass does not set $this->count_query, which means
* get_found_results() and get_max_pages() will return 0.
*
* @since 10.0.0
*
* @return void
*/
public function query() {
parent::query();
$has_sql_calc = ! $this->get( 'suppress_filters' ) &&
is_string( $this->query ) &&
str_contains( $this->query, 'SQL_CALC_FOUND_ROWS' );
if ( $has_sql_calc ) {
_deprecated_argument(
"llms_{$this->id}_query_prepare_query",
'[version]',
'SQL_CALC_FOUND_ROWS should no longer be added via filters. Results are now counted with a separate COUNT query.'
);
global $wpdb;
$this->found_results = (int) $wpdb->get_var( 'SELECT FOUND_ROWS()' ); // db call ok; no-cache ok.
$this->max_pages = absint( ceil( $this->found_results / $this->get( 'per_page' ) ) );
}
if (
$this->number_results &&
! $this->get( 'no_found_rows' ) &&
! $this->get( 'count_only' ) &&
empty( $this->count_query ) &&
! $has_sql_calc
) {
_doing_it_wrong(
get_class( $this ) . '::prepare_query',
sprintf(
/* translators: %s: The query subclass name. */
'Subclasses of LLMS_Database_Query should set $this->count_query in prepare_query() when no_found_rows is not true. %s does not set count_query, so get_found_results() and get_max_pages() will return 0.',
get_class( $this )
),
'[version]'
);
}
}
/**
* Gets information about properties that used to be public and have been replaced with public getters.
*
* Used by `__get()` and `__set()` and will be removed when these are properly removed in the next
* major release.
*
* @since 6.0.0
*
* @return array
*/
private function legacy_public_props() {
return array(
// Property => $0 = alternative prop or method, $1 = has replacement.
'found_results' => array( 'get_found_results', true ),
'max_pages' => array( 'get_max_pages', true ),
'number_results' => array( 'get_number_results', true ),
'query_vars' => array( 'query_vars', false ),
'results' => array( 'get_results', true ),
);
}
/**
* Throws a deprecation message when a formerly public property is accessed directly.
*
* @since 6.0.0
*
* @param string $prop Property name.
* @return void
*/
private function public_prop_deprecation( $prop ) {
$legacy_props = $this->legacy_public_props();
list( $val, $has_replacement ) = $legacy_props[ $prop ];
$class = get_called_class();
$is_method = method_exists( $this, $val );
$suffix = $is_method ? '()' : '';
_deprecated_function( esc_html( "Public access to property {$class}::{$prop}" ), '6.0.0', $has_replacement ? esc_html( "{$class}::{$val}{$suffix}" ) : '' );
}
/**
* Preserve backwards compat for read access to formerly public and removed class properties.
*
* @since 6.0.0
*
* @param string $key Property key name.
* @return mixed
*/
public function __get( $key ) {
// Handle formerly public properties.
$legacy_props = $this->legacy_public_props();
if ( array_key_exists( $key, $legacy_props ) ) {
$this->public_prop_deprecation( $key );
$val = $legacy_props[ $key ][0];
return method_exists( $this, $val ) ? $this->$val() : $this->$val;
} elseif ( 'sql' === $key ) {
$class = get_called_class();
_deprecated_function( esc_html( "Property {$class}::sql" ), '6.0.0', esc_html( "{$class}::get_query()" ) );
return $this->query;
}
}
/**
* Preserve backwards compat for write access to formerly public and removed class properties.
*
* @since 6.0.0
*
* @param string $key Property name.
* @param mixed $val Property value.
* @return void
*/
public function __set( $key, $val ) {
$legacy_props = $this->legacy_public_props();
if ( array_key_exists( $key, $legacy_props ) ) {
$this->public_prop_deprecation( $key );
$this->$key = $val;
} elseif ( 'sql' === $key ) {
$class = get_called_class();
_deprecated_function( esc_html( "Property {$class}::sql" ), '6.0.0', esc_html( "{$class}::query" ) );
$this->query = $val;
}
}
/**
* Handle backwards compatibility for the misspelled (and removed) method `preprare_query()`.
*
* @since 6.0.0
*
* @param string $name Method name.
* @param array $args Arguments passed to the method.
* @return void|string
*/
public function __call( $name, $args ) {
if ( 'preprare_query' === $name ) {
$class = get_called_class();
_deprecated_function( esc_html( "{$class}::preprare_query()" ), '6.0.0', esc_html( "{$class}::prepare_query()" ) );
return $this->prepare_query();
}
}
/**
* Prepare the query.
*
* Should return the query which will be used by `query()`.
*
* This *should* be an abstract method but is defined here for backwards compatibility
* to preserve the previous method, `preprare_query()` (notice the misspelling).
*
* Once the `preprare_query()` method is fully removed in the next major release this
* method can be removed in favor of the abstract from the parent class.
*
* @since 6.0.0
*
* @return mixed
*/
protected function prepare_query() {
if ( method_exists( $this, 'preprare_query' ) ) {
$class = get_called_class();
_deprecated_function( esc_html( "{$class}::preprare_query()" ), '6.0.0', esc_html( "{$class}::prepare_query()" ) );
return $this->preprare_query();
} else {
_doing_it_wrong(
__METHOD__,
/* translators: %s: Method name. */
esc_html( sprintf( __( "Method '%s' not implemented. Must be overridden in subclass.", 'lifterlms' ), __METHOD__ ) ),
'6.0.0'
);
}
}
}
================================================
FILE: includes/abstracts/abstract.llms.payment.gateway.php
================================================
<?php
/**
* LifterLMS Payment Gateways Abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Payment Gateways abstract class
*
* @since 3.0.0
* @since 4.0.0 Removed deprecated completed transaction message parameter output.
* @since 5.3.0 Extend LLMS_Abstract_Options_Data for improved options interactions.
*/
abstract class LLMS_Payment_Gateway extends LLMS_Abstract_Options_Data {
/**
* Optional gateway description for the admin panel
*
* @var string
*/
public $admin_description = '';
/**
* Fields the gateway uses on the admin panel when displaying/editing an order
*
* @var array
*/
public $admin_order_fields = array(
'customer' => false,
'subscription' => false,
'source' => false,
);
/**
* Optional gateway title for the admin panel
*
* @var string
*/
public $admin_title = '';
/**
* Optional gateway description for the frontend
*
* @var string
*/
public $description = '';
/**
* Order to display the gateway in on the frontend
*
* @var integer
*/
public $display_order = 1;
/**
* Is the gateway enabled for payment processing?
*
* @var string
*/
public $enabled = 'no';
/**
* Optional icon displayed on the frontend
*
* @var string
*/
public $icon = '';
/**
* ID of the Payment Gateway, used internally
*
* @var string
*/
public $id;
/**
* Logging status
*
* @var string
*/
public $logging_enabled = '';
/**
* Option name prefix.
*
* @var string
*/
protected $option_prefix = 'llms_gateway_';
/**
* Array of supported gateway features.
*
* @var array
*/
public $supports = array(
'checkout_fields' => false,
'cc_save' => false,
'refunds' => false,
'single_payments' => false,
'recurring_payments' => false,
'recurring_retry' => false,
'test_mode' => false,
'modify_recurring_payments' => null,
);
/**
* Description of the gateway's test mode (if supported)
*
* @var string
*/
public $test_mode_description = '';
/**
* Is test mode enabled?
*
* Can be modified by user on settings page if gateway supports "test_mode".
*
* @var string
*/
public $test_mode_enabled = 'no';
/**
* Title of the gateway's test mode (if supported)
*
* @var string
*/
public $test_mode_title = '';
/**
* Gateway title for the frontend
*
* @var string
*/
public $title = '';
/**
* Strings to mask when writing debug logs.
*
* @var string[]
*/
protected $secure_strings = array();
/**
* Option's data version
*
* @var integer
*/
protected $version = 2;
/**
* Adds a string to the gateway's list of secure strings.
*
* @since 7.0.0
*
* @param string $string The string to add.
* @return void
*/
public function add_secure_string( $string ) {
$this->secure_strings[] = (string) $string;
}
/**
* This should be called by the gateway after verifying the transaction was completed successfully
*
* @since 3.0.0
* @since 3.30.0 Added access plan and query string checkout redirect settings.
* @since 3.34.3 Use `llms_redirect_and_exit()` instead of `wp_redirect()` and `exit()`.
* @since 3.37.18 Allow redirection to external domains by disabling "safe" redirects.
*
* @param LLMS_Order $order Instance of an LLMS_Order object.
* @param null $deprecated Deprecated.
* @return void
*/
public function complete_transaction( $order, $deprecated = null ) {
$this->log( $this->get_admin_title() . ' `complete_transaction()` started', $order );
$redirect = $this->get_complete_transaction_redirect_url( $order );
$this->log( $this->get_admin_title() . ' `complete_transaction()` finished', $redirect, $order );
// Ensure notification processors get dispatched since shutdown wont be called.
do_action( 'llms_dispatch_notification_processors' );
// Execute a redirect.
llms_redirect_and_exit(
$redirect,
array(
'safe' => false,
)
);
}
/**
* This should be called by AJAX-powered gateways after verifying that a transaction was completed successfully.
*
* @since 7.0.0
*
* @param LLMS_Order $order The order being processed.
* @param array $data Data to add to the default success return array.
* @return array {
* An array of return data. The actual return array may include additional data from the payment gateway.
*
* @type string $redirect The complete transaction redirect URL.
* @type string $status The status code, always 'SUCCESS'.
* }
*/
public function complete_transaction_ajax( $order, $data = array() ) {
$data = wp_parse_args(
$data,
array(
'redirect' => $this->get_complete_transaction_redirect_url( $order ),
'status' => 'SUCCESS',
)
);
// Ensure notification processors get dispatched since shutdown won't be called.
do_action( 'llms_dispatch_notification_processors' );
return $data;
}
/**
* Whether the payment details are entered on an external payment page, or entered inline with the checkout form.
*
* @since 9.0.0
*
* @return bool
*/
public function is_external_payment_entry() {
return false;
}
/**
* Confirms a Payment.
*
* Called by {@see LLMS_Controller_Orders::confirm_pending_order} on confirm form submission.
*
* Some validation is performed before passing to this function, gateways should do further validation
* on their own.
*
* This stub is not necessary to implement if the gateway doesn't have a payment confirmation step.
*
* For gateways which implement AJAX order processing, this function should return either a WP_Error or
* a success array from {@see LLMS_Payment_Gateway::complete_transaction_ajax()}.
*
* For gateways which implement synchronous order processing through form submission, this function should
* not return and should instead perform a redirect and / or output notices using {@see llms_add_notice()}.
*
* @since 3.0.0
*
* @param LLMS_Order $order Instance of the order being processed.
* @return void|WP_Error|array
*/
public function confirm_pending_order( $order ) {}
/**
* Get admin description for the gateway
*
* @since 3.0.0
*
* @return string
*/
public function get_admin_description() {
/**
* Filters a payment gateway's admin description.
*
* @since 3.0.0
*
* @param string $admin_description The admin description.
* @param string $gateway_id The payment gateway ID.
*/
return apply_filters( 'llms_get_gateway_admin_description', $this->admin_description, $this->id );
}
/**
* Get the admin title for the gateway
*
* @since 3.0.0
*
* @return string
*/
public function get_admin_title() {
/**
* Filters a payment gateway's admin title.
*
* @since 3.0.0
*
* @param string $admin_title The admin title.
* @param string $gateway_id The payment gateway ID.
*/
return apply_filters( 'llms_get_gateway_admin_title', $this->admin_title, $this->id );
}
/**
* Get data about the fields displayed on the admin panel when viewing an order
*
* @since 3.10.0
*
* @return array[]
*/
public function get_admin_order_fields() {
$fields = array(
'customer' => array(
'label' => __( 'Customer ID', 'lifterlms' ),
'enabled' => $this->admin_order_fields['customer'],
'name' => 'gateway_customer_id',
),
'source' => array(
'label' => __( 'Source ID', 'lifterlms' ),
'enabled' => $this->admin_order_fields['source'],
'name' => 'gateway_source_id',
),
'subscription' => array(
'label' => __( 'Subscription ID', 'lifterlms' ),
'enabled' => $this->admin_order_fields['subscription'],
'name' => 'gateway_subscription_id',
),
);
/**
* Filters a payment gateway's admin title.
*
* @since 3.10.0
*
* @param array[] $fields Array of admin order fields.
* @param string $gateway_id The payment gateway ID.
*/
return apply_filters( 'llms_get_gateway_admin_order_fields', $fields, $this->id );
}
/**
* Get default gateway admin settings fields
*
* @since 3.0.0
* @since 3.29.0 Unknown.
*
* @return array[]
*/
public function get_admin_settings_fields() {
$fields = array();
$fields[] = array(
'type' => 'custom-html',
'value' => '
<h1>' . $this->get_admin_title() . '</h1>
<p>' . $this->get_admin_description() . '</p>
',
);
$fields[] = array(
'autoload' => true,
'id' => $this->get_option_name( 'enabled' ),
/* translators: %s: Payment gateway title. */
'desc' => sprintf( _x( 'Enable %s', 'Payment gateway title', 'lifterlms' ), $this->get_admin_title() ),
'desc_tooltip' => __( 'Checking this box will allow users to use this payment gateway.', 'lifterlms' ),
'default' => $this->get_enabled(),
'title' => __( 'Enable / Disable', 'lifterlms' ),
'type' => 'checkbox',
);
$fields[] = array(
'id' => $this->get_option_name( 'title' ),
'desc' => '<br>' . __( 'The title the user sees during checkout.', 'lifterlms' ),
'default' => $this->get_title(),
'title' => __( 'Title', 'lifterlms' ),
'type' => 'text',
);
$fields[] = array(
'id' => $this->get_option_name( 'description' ),
'desc' => '<br>' . __( 'The description the user sees during checkout.', 'lifterlms' ),
'default' => $this->get_description(),
'title' => __( 'Description', 'lifterlms' ),
'type' => 'text',
);
if ( $this->supports( 'test_mode' ) ) {
$fields[] = array(
'id' => $this->get_option_name( 'test_mode_enabled' ),
/* translators: %s: Payment gateway test mode title. */
'desc' => sprintf( _x( 'Enable %s', 'Payment gateway test mode title', 'lifterlms' ), $this->get_test_mode_title() ),
'desc_tooltip' => $this->get_test_mode_description(),
'default' => $this->get_test_mode_enabled(),
'title' => $this->get_test_mode_title(),
'type' => 'checkbox',
);
}
$fields[] = array(
'id' => $this->get_option_name( 'logging_enabled' ),
'desc' => __( 'Enable debug logging', 'lifterlms' ),
/* Translators: %s: Debug log location. */
'desc_tooltip' => sprintf( __( 'When enabled, debugging information will be logged to "%s"', 'lifterlms' ), llms_get_log_path( $this->get_id() ) ),
'title' => __( 'Debug Log', 'lifterlms' ),
'type' => 'checkbox',
);
/**
* Filters the gateway's settings fields displayed on the admin panel
*
* @since 3.0.0
*
* @param array[] $fields Array of settings fields.
* @param string $gateway_id The payment gateway ID.
*/
return apply_filters( 'llms_get_gateway_settings_fields', $fields, $this->id );
}
/**
* Get API mode
*
* If test is not supported will return "live".
*
* @since 3.0.0
*
* @return string
*/
public function get_api_mode() {
if ( $this->supports( 'test_mode' ) && $this->is_test_mode_enabled() ) {
return 'test';
}
return 'live';
}
/**
* Calculates the url to redirect to on transaction completion.
*
* @since 3.30.0
* @since 7.0.0 Retrieve the redirect URL from the INPUT_POST if not passed via INPUT_GET.
*
* @param LLMS_Order $order The order object.
* @return string
*/
protected function get_complete_transaction_redirect_url( $order ) {
// Get the redirect parameter from INPUT_GET.
$redirect = urldecode( llms_filter_input( INPUT_GET, 'redirect', FILTER_VALIDATE_URL ) ?? '' );
// Get the redirect parameter from INPUT_POST if not INPUT_GET redirect pased.
$redirect = $redirect ? $redirect : llms_filter_input( INPUT_POST, 'redirect', FILTER_VALIDATE_URL );
// Redirect to the product's permalink, if no redirect found yet.
$redirect = $redirect ? $redirect : get_permalink( $order->get( 'product_id' ) );
// Fallback to the account page if we don't have a url for some reason.
$redirect = $redirect ? $redirect : get_permalink( llms_get_page_id( 'myaccount' ) );
// Add order key to the url.
$redirect = add_query_arg(
array(
'order-complete' => $order->get( 'order_key' ),
),
esc_url( $redirect )
);
// Redirection url on free checkout form.
$quick_enroll_form = llms_filter_input( INPUT_POST, 'form' );
$free_checkout_redirect = llms_filter_input( INPUT_POST, 'free_checkout_redirect', FILTER_VALIDATE_URL );
if ( get_current_user_id() && ( 'free_enroll' === $quick_enroll_form ) && $free_checkout_redirect ) {
$redirect = $free_checkout_redirect;
}
/**
* Filters the redirect on order completion.
*
* @since 3.8.0
*
* @param string $redirect The URL to redirect user to.
* @param LLMS_Order $order The order object.
*/
return esc_url( apply_filters( 'lifterlms_completed_transaction_redirect', $redirect, $order ) );
}
/**
* Gateways can override this to return a URL to a customer permalink on the gateway's website
*
* If this is not defined, it will just return the supplied ID.
*
* @since 3.0.0
*
* @param string $customer_id Gateway's customer ID.
* @param string $api_mode Link to either the live or test site for the gateway, where applicable.
* @return string
*/
public function get_customer_url( $customer_id, $api_mode = 'live' ) {
return $customer_id;
}
/**
* Get the frontend description setting
*
* @since 3.0.0
*
* @return string
*/
public function get_description() {
return $this->get_option( 'description' );
}
/**
* Get the display order setting
*
* @since 3.0.0
*
* @return int
*/
public function get_display_order() {
return absint( $this->get_option( 'display_order' ) );
}
/**
* Get the value of the enabled setting
*
* @since 3.0.0
*
* @return string
*/
public function get_enabled() {
return $this->get_option( 'enabled' );
}
/**
* Get fields displayed on the checkout form
*
* Gateways should define this function if the gateway supports fields.
*
* @since 3.0.0
*
* @return string
*/
public function get_fields() {
/**
* Filters the HTML of the gateway's checkout fields
*
* @since 3.0.0
*
* @param string $fields Fields HTML string.
* @param string $gateway_id The payment gateway's ID.
*/
return apply_filters( 'llms_get_gateway_fields', '', $this->id );
}
/**
* Get the icon displayed on the checkout form
*
* @since 3.0.0
*
* @return string
*/
public function get_icon() {
/**
* Filters the HTML of the gateway's checkout icon
*
* @since 3.0.0
*
* @param string $icon Icon HTML string.
* @param string $gateway_id The payment gateway's ID.
*/
return apply_filters( 'llms_get_gateway_icon', $this->icon, $this->id );
}
/**
* Get the gateway's ID
*
* @since 3.0.0
*
* @return string
*/
public function get_id() {
return $this->id;
}
/**
* Retrieve an HTML link to a customer, subscription, or source URL
*
* If no URL provided returns the item value as string.
*
* @since 3.10.0
*
* @param string $item_key The key of the item to retrieve a URL for.
* @param string $item_value The value of the item to retrieve.
* @param string $api_mode The current api mode to retrieve the URL for.
* @return string
*/
public function get_item_link( $item_key, $item_value, $api_mode = 'live' ) {
switch ( $item_key ) {
case 'customer':
$url = $this->get_customer_url( $item_value, $api_mode );
break;
case 'subscription':
$url = $this->get_subscription_url( $item_value, $api_mode );
break;
case 'source':
$url = $this->get_source_url( $item_value, $api_mode );
break;
default:
$url = $item_value;
}
if ( false === filter_var( $url, FILTER_VALIDATE_URL ) ) {
return $item_value;
}
return sprintf( '<a href="%1$s" target="_blank">%2$s</a>', $url, $item_value );
}
/**
* Get the value of the logging setting
*
* @since 3.0.0
* @since 7.0.0 Added the force filter, `llms_gateway_{$this->id}_logging_enabled`.
*
* @return string
*/
public function get_logging_enabled() {
/**
* Enables forcing the logging status for the gateway on or off.
*
* The dynamic portion of this hook, `{$this->id}`, refers to the gateway's ID.
*
* @since 7.0.0
*
* @param null|bool $forced The forced status. If `null`, the default status derived from the gateway options will be used.
*/
$forced = apply_filters( "llms_gateway_{$this->id}_logging_enabled", null );
if ( ! is_null( $forced ) ) {
return $forced ? 'yes' : 'no';
}
return $this->get_option( 'logging_enabled' );
}
/**
* Adds the gateway's registered secured strings to the default list of site-wide secure strings.
*
* This is the callback for the `llms_secure_strings` filter (called via `llms_log()`).
*
* @since 6.4.0
* @since 7.0.0 Load strings from `retrieve_secure_strings()`.
*
* @param string[] $strings Array of secure strings.
* @param string $handle The log handle.
* @return string[]
*/
public function get_secure_strings( $strings, $handle ) {
// Don't add our strings to other log files.
if ( $this->id !== $handle ) {
return $strings;
}
return array_merge( $strings, $this->retrieve_secure_strings() );
}
/**
* Gateways can override this to return a URL to a source permalink on the gateway's website
*
* If this is not defined, it will just return the supplied ID.
*
* @since 3.0.0
*
* @param string $source_id Gateway's source ID.
* @param string $api_mode Link to either the live or test site for the gateway, where applicable.
* @return string
*/
public function get_source_url( $source_id, $api_mode = 'live' ) {
return $source_id;
}
/**
* Gateways can override this to return a URL to a subscription permalink on the gateway's website
*
* If this is not defined, it will just return the supplied ID.
*
* @since 3.0.0
*
* @param string $subscription_id Gateway's subscription ID.
* @param string $api_mode Link to either the live or test site for the gateway, where applicable.
* @return string
*/
public function get_subscription_url( $subscription_id, $api_mode = 'live' ) {
return $subscription_id;
}
/**
* Get an array of features the gateway supports.
*
* @since 3.0.0
* @since 7.0.0 Handle `modify_recurring_payments` depending on `recurring_payments`.
*
* @return array
*/
public function get_supported_features() {
if ( ! isset( $this->supports['modify_recurring_payments'] ) || is_null( $this->supports['modify_recurring_payments'] ) ) {
$this->supports['modify_recurring_payments'] = $this->supports['recurring_payments'] ?? false;
}
/**
* Filters the gateway's supported features array
*
* @since 3.0.0
*
* @param array $supports Array of feature support.
* @param string $gateway_id The payment gateway's ID.
*/
return apply_filters( 'llms_get_gateway_supported_features', $this->supports, $this->id );
}
/**
* Get the description of test mode displayed on the admin panel
*
* @since 3.0.0
*
* @return string
*/
public function get_test_mode_description() {
return $this->test_mode_description;
}
/**
* Get value of the test mode enabled setting
*
* @since 3.0.0
*
* @return string
*/
public function get_test_mode_enabled() {
return $this->get_option( 'test_mode_enabled' );
}
/**
* Get the title of test mode displayed on the admin panel
*
* @since 3.0.0
*
* @return string
*/
public function get_test_mode_title() {
return $this->test_mode_title;
}
/**
* Get gateway title setting
*
* @since 3.0.0
*
* @return string
*/
public function get_title() {
return $this->get_option( 'title' );
}
/**
* Gateways can override this to return a URL to a transaction permalink on the gateway's website
*
* If this is not defined, it will just return the supplied ID.
*
* @since 3.0.0
*
* @param string $transaction_id Gateway's transaction ID.
* @param string $api_mode Link to either the live or test site for the gateway, where applicable.
*
* @return string
*/
public function get_transaction_url( $transaction_id, $api_mode = 'live' ) {
return $transaction_id;
}
/**
* Called when the Update Payment Method form is submitted from a single order view on the student dashboard
*
* Gateways should do whatever the gateway needs to do to validate the new payment method and save it to the order
* so that future payments on the order will use this new source.
*
* This should be an abstract function but experience has taught me that no one will upgrade follow our instructions
* and they'll end up with 500 errors and debug mode disabled and send me giant frustrated question marks.
*
* @since 3.10.0
*
* @param LLMS_Order $order Order object.
* @param array $form_data Additional data passed from the submitted form (EG $_POST).
*
* @return null
*/
public function handle_payment_source_switch( $order, $form_data = array() ) {
return llms_add_notice(
sprintf(
/* translators: %s: the title of the payment gateway. */
esc_html__( 'The selected payment gateway "%s" does not support payment method switching.', 'lifterlms' ),
$this->get_title()
),
'error'
);
}
/**
* Handle a Pending Order
*
* Called by LLMS_Controller_Orders->create_pending_order() on checkout form submission.
*
* All data will be validated before it's passed to this function.
*
* @since 3.0.0
*
* @param LLMS_Order $order The order being processed.
* @param LLMS_Access_Plan $plan Access plan the order is built from.
* @param LLMS_Student $person The purchasing customer.
* @param LLMS_Coupon|false $coupon Coupon used during order processing or `false` if none supplied.
* @return void
*/
abstract public function handle_pending_order( $order, $plan, $person, $coupon = false );
/**
* Called by scheduled actions to charge an order for a scheduled recurring transaction
*
* This function must be defined by gateways which support recurring transactions.
*
* @since 3.0.0
*
* @param LLMS_Order $order The order being processed.
* @return mixed
*/
public function handle_recurring_transaction( $order ) {}
/**
* Determine if the gateway is the default gateway
*
* This will be the FIRST gateway in the gateways that are enabled.
*
* @since 3.0.0
* @since 5.3.0 Use `llms()` in favor of deprecated `LLMS()`.
*
* @return boolean
*/
public function is_default_gateway() {
return ( $this->get_id() === llms()->payment_gateways()->get_default_gateway() );
}
/**
* Determine if the gateway is enabled according to admin settings checkbox
*
* @since 3.0.0
*
* @return boolean
*/
public function is_enabled() {
return ( 'yes' === $this->get_enabled() ) ? true : false;
}
/**
* Determine if test mode is enabled
*
* Returns false if gateway doesn't support test mode.
*
* @since 3.0.0
*
* @return boolean
*/
public function is_test_mode_enabled() {
return ( 'yes' === $this->get_test_mode_enabled() ) ? true : false;
}
/**
* Log messages if logging is enabled
*
* @since 3.0.0
* @since 6.4.0 Load the gateway's `secure_option` settings into `llms_secure_strings` hook when logging.
*
* @return void
*/
public function log() {
if ( ! llms_parse_bool( $this->get_logging_enabled() ) ) {
return;
}
add_filter( 'llms_secure_strings', array( $this, 'get_secure_strings' ), 10, 2 );
foreach ( func_get_args() as $data ) {
llms_log( $data, $this->get_id() );
}
remove_filter( 'llms_secure_strings', array( $this, 'get_secure_strings' ), 10, 2 );
}
/**
* Get the value of an option from the database & fallback to default value if none found
*
* Optionally attempts to retrieve a secure key first, if secure key is provided.
*
* The behavior of this function differs slightly from the parent method in that the second argument
* in this method allows lookup of the secure key value.
*
* Default options are autoloaded via the get_option_default_value() method.
*
* @since 3.0.0
* @since 3.29.0 Added secure option lookup via option second parameter.
*
* @param string $key option Option name / key, eg: "title".
* @param string $secure_key Secure option name / key, eg: "TITLE".
* @return mixed
*/
public function get_option( $key, $secure_key = false ) {
if ( $secure_key ) {
$secure_val = llms_get_secure_option( $secure_key );
if ( false !== $secure_val ) {
return $secure_val; // Intentionally not filtered here.
}
}
$val = parent::get_option( $key );
/**
* Filters the value of a gateway option
*
* The dynamic portion of the hook, `{$key}`, refers to the unprefixed
* option name.
*
* @since Unknown
*
* @param mixed $val Option value.
* @param string $gateway_id Payment gateway ID.
*/
return apply_filters( "llms_get_gateway_{$key}", $val, $this->id );
}
/**
* Option default value autoloader
*
* This is a callback function for the WP core filter `default_option_{$option}`.
*
* @since 5.3.0
*
* @param mixed $default_value The default value. If no value is passed to `get_option()`, this will be an empty string.
* Otherwise it will be the default value passed to the method.
* @param string $full_option_name The full (prefixed) option name.
* @param bool $passed_default_value Whether or not a default value was passed to `get_option()`.
* @return mixed The default option value.
*/
public function get_option_default_value( $default_value, $full_option_name, $passed_default_value ) {
$unprefixed = str_replace( $this->get_option_prefix(), '', $full_option_name );
return isset( $this->$unprefixed ) ? $this->$unprefixed : '';
}
/**
* Retrieve a prefix for options
*
* Appends the gateway's ID to the default option prefix, eg: "llms_gateway_manual_".
*
* @since 5.3.0
*
* @return string
*/
protected function get_option_prefix() {
return parent::get_option_prefix() . $this->id . '_';
}
/**
* Called when refunding via a Gateway
*
* This function must be defined by gateways which support refunds.
*
* This function is called by LLMS_Transaction->process_refund().
*
* @since 3.0.0
*
* @param LLMS_Transaction $transaction The transaction being refunded.
* @param float $amount Amount to refund.
* @param string $note Optional refund note to pass to the gateway.
* @return mixed
*/
public function process_refund( $transaction, $amount = 0, $note = '' ) {}
/**
* Retrieves a list of "secure" strings which should be anonymized if they're found within debug logs.
*
* This method will load the values of any gateway options with a `secure_option` declaration. Additional
* strings can be added to the list using the `llms_get_gateway_secure_strings` filter or via the
* gateway's `add_secure_string()` method.
*
* @since 7.0.0
*
* @return string[]
*/
public function retrieve_secure_strings() {
$gateway_strings = $this->secure_strings;
foreach ( $this->get_admin_settings_fields() as $field ) {
if ( empty( $field['id'] ) || empty( $field['secure_option'] ) ) {
continue;
}
$string = llms_get_secure_option( $field['secure_option'], '', $field['id'] );
if ( empty( $string ) ) {
continue;
}
$gateway_strings[] = $string;
}
/**
* Filters the list of the gateway's secure strings.
*
* @since 6.4.0
*
* @param string[] $gateway_strings List of secure strings for the payment gateway.
* @param string $id The gateway ID.
*/
$gateway_strings = apply_filters( 'llms_get_gateway_secure_strings', $gateway_strings, $this->id );
return array_values( array_unique( $gateway_strings ) );
}
/**
* Determine if a feature is supported by the gateway.
*
* Looks at the $this->supports and ensures the submitted feature exists and is true.
*
* @since 3.0.0
* @since 7.0.0 Added `$order` param, to be used when the feature also depends on an order property.
*
* @param string $feature Name of the supported feature.
* @param LLMS_Order $order Instance of an LLMS_Order.
* @return boolean
*/
public function supports( $feature, $order = null ) {
$supports = $this->get_supported_features();
if ( isset( $supports[ $feature ] ) && $supports[ $feature ] ) {
return true;
}
return false;
}
/**
* Determine if an access plan can be processed by the gateway.
*
* @since 7.5.0
*
* @param LLMS_Access_Plan $plan Instance of an LLMS_Access_Plan.
* @param LLMS_Order $order Instance of an LLMS_Order. Used to check whether a payment can be switched using this gateway.
* In that case, in fact, we have to rely on the access plan information contained in the order
* at the moment of its creation.
* @return boolean
*/
public function can_process_access_plan( $plan, $order = null ) {
/**
* Filters whether or not a gateway can process a specific access plan.
*
* @since 7.5.0
*
* @param bool $can_process_plan Whether or not the gateway can process a specific access plan.
* @param LLMS_Access_Plan $plan Access plan object.
* @param LLMS_Order $plan Order object.
* @param string $id The gateway ID.
*/
return apply_filters( 'llms_can_gateway_process_access_plan', $plan || $order, $plan, $order, $this->id );
}
}
================================================
FILE: includes/abstracts/abstract.llms.post.model.php
================================================
<?php
/**
* LLMS_Post_Model abstract class file
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.0.0
* @version 7.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Post_Model abstract class.
*
* Defines base methods and properties for programmatically interfacing with LifterLMS Custom Post Types.
*
* @property string $author ID of post author.
* @property string $content The post's content.
* @property string $date The post's local publication time.
* @property-read string $db_post_type Name of the post type as stored in the database
* This will be prefixed (where applicable)
* ie: "llms_order" for the "llms_order" post type
* @property string $excerpt The post's excerpt.
* @property-read int $id Post ID.
* @property int $menu_order A field used for ordering posts.
* @property-read string $meta_prefix A prefix to add to all meta properties
* Child classes can redefine this
* @property-read string $model_post_type Define this in extending classes
* Allows models to use unprefixed post type names for filters and more
* ie: "order" for the "llms_order" post type
* @property string $modified The post's local modified time.
* @property string $name The post's slug.
* @property int $parent WP_Post ID of the post's parent post.
* @property-read WP_Post $post Instance of WP_Post
* @property string $status The post's status.
* @property string $title The post's title.
* @property string $type The post's type, like post or page.
*
* @since 3.0.0
* @since 3.30.0 Improve handling of custom field data to `toArrayCustom()`.
* @since 3.30.2 Add filter to allow 3rd parties to prevent a field from being added to the custom field array.
* @since 3.30.3 Use `wp_slash()` when creating new posts.
* @since 3.31.0 Treat `post_excerpt` fields as HTML instead of plain text.
* @since 3.34.0 Add parameter to the `get()` method in order to get raw properties.
* @since 3.34.0 Add `comment_status`, `ping_status`, `date_gmt`, `modified_gmt`, `menu_order`, 'post_password` as gettable\settable post properties.
* @since 3.34.0 Add `set_bulk()` method that will allow to update an object at once given an array of properties.
* @since 3.34.0 Refresh the whole $post property with the just updated instance of WP_Post after updating it.
* @since 3.36.1 In `set_bulk()` method, use WP_Error::$errors in place of WP_Error::has_errors() to support WordPress version prior to 5.1.
*/
abstract class LLMS_Post_Model implements JsonSerializable {
/**
* Name of the post type as stored in the database
* This will be prefixed (where applicable)
* ie: "llms_order" for the "llms_order" post type
*
* @var string
* @since 3.0.0
*/
protected $db_post_type;
/**
* WP Post ID
*
* @var int
* @since 3.0.0
*/
protected $id;
/**
* Define this in extending classes
*
* Allows models to use unprefixed post type names for filters and more
* ie: "order" for the "llms_order" post type.
*
* @var string
* @since 3.0.0
*/
protected $model_post_type;
/**
* A prefix to add to all meta properties
*
* Child classes can redefine this.
*
* @var string
* @since 3.0.0
*/
protected $meta_prefix = '_llms_';
/**
* Instance of WP_Post
*
* @var WP_Post
* @since 3.0.0
*/
protected $post;
/**
* Array of meta properties and their property type
*
* @var array
* @since 3.3.0
*/
protected $properties = array();
/**
* Array of default property values
*
* In the form of key => default value.
*
* @var array
* @since 3.24.0
*/
protected $property_defaults = array();
/**
* Constructor
*
* Setup ID and related post property.
*
* @since 3.0.0
* @since 3.13.0 Unknown.
*
* @param string|int|LLMS_Post_Model|WP_Post $model 'new', WP post id, instance of an extending class, instance of WP_Post.
* @param array $args Args to create the post, only applies when $model is 'new'.
* @return void
*/
public function __construct( $model, $args = array() ) {
if ( 'new' === $model ) {
$model = $this->create( $args );
if ( ! is_wp_error( $model ) ) {
$created = true;
}
} else {
$created = false;
}
if ( empty( $model ) || is_wp_error( $model ) ) {
return;
}
if ( is_numeric( $model ) ) {
$this->id = absint( $model );
$this->post = get_post( $this->id );
} elseif ( is_subclass_of( $model, 'LLMS_Post_Model' ) ) {
$this->id = absint( $model->id );
$this->post = $model->post;
} elseif ( $model instanceof WP_Post && isset( $model->ID ) ) {
$this->id = absint( $model->ID );
$this->post = $model;
}
if ( $created ) {
$this->after_create();
}
}
/**
* Magic Getter
*
* @since 3.0.0
*
* @param string $key Key to retrieve.
* @return mixed
*/
public function __get( $key ) {
return $this->___get( $key );
}
/**
* Magic Isset
*
* @since 3.0.0
*
* @param string $key Check if a key exists in the database.
* @return boolean
*/
public function __isset( $key ) {
return metadata_exists( 'post', $this->id, $this->meta_prefix . $key );
}
/**
* Magic Setter
*
* @since 3.0.0
*
* @param string $key Key of the property.
* @param mixed $val Value to set the property with.
* @return void
*/
public function __set( $key, $val ) {
$this->$key = $val;
}
/**
* Allow extending classes to add custom meta properties to the object
*
* @since 3.16.0
*
* @param array $props Key val array of prop key => prop type (see $this->properties).
*/
protected function add_properties( $props = array() ) {
$this->properties = array_merge( $this->properties, $props );
}
/**
* Modify allowed post tags for wp_kses for this post
*
* @since 3.19.2
*
* @return void
*/
protected function allowed_post_tags_set() {
global $allowedposttags;
$allowedposttags['iframe'] = array(
'allowfullscreen' => true,
'frameborder' => true,
'height' => true,
'src' => true,
'width' => true,
'style' => true,
);
}
/**
* Remove modified allowed post tags for wp_kses for this post
*
* @since 3.19.2
*
* @return void
*/
protected function allowed_post_tags_unset() {
global $allowedposttags;
unset( $allowedposttags['iframe'] );
}
/**
* Wrapper for $this-get() which allows translation of the database value before outputting on screen
*
* Extending classes should define this and translate any possible strings
* with a switch statement or something.
* This will return the untranslated string if a translation isn't defined.
*
* @since 3.0.0
*
* @param string $key Key to retrieve.
* @return string
*/
public function translate( $key ) {
$val = $this->get( $key );
// ******* example *******
// switch( $key ) {
// case 'example_key':
// if ( 'example-val' === $val ) {
// return translate( 'Example Key', 'lifterlms' );
// }
// break;
// default:
// return $val;
// }
// ******* example *******
return $val;
}
/**
* Wrapper for the $this->translate() that echos the result rather than returning it
*
* @since 3.0.0
*
* @param string $key Key to translate.
* @return void
*/
public function _e( $key ) { // phpcs:ignore -- This is to mimic localization functions.
echo esc_html( $this->translate( $key ) );
}
/**
* Called immediately after creating / inserting a new post into the database
*
* This stub can be overwritten by child classes.
*
* @since 3.0.0
*
* @return void
*/
protected function after_create() {}
/**
* Create a new post of the Instantiated Model
*
* This can be called by instantiating an instance with "new"
* as the value passed to the constructor.
*
* @since 3.0.0
* @since 3.30.3 Use `wp_slash()` for the post title.
*
* @param string $title Title to create the post with.
* @return int WP Post ID of the new Post on success or 0 on error.
*/
private function create( $title = '' ) {
return wp_insert_post(
wp_slash(
/**
* Filters the creation arguments used to create a new post.
*
* The return array is passed through {@see wp_slash} and ultimately
* passed directly to {@see wp_insert_post}.
*
* The dynamic portion of this hook, `{$this->model_post_type}`, refers to the post
* model's `$model_post_type` property.
*
* @since 3.0.0
*
* @param array $creation_args An array of arguments passed.
*/
apply_filters(
"llms_new_{$this->model_post_type}",
$this->get_creation_args( $title )
)
),
true
);
}
/**
* Clones the Post if the post is cloneable
*
* @since 3.3.0
* @since 4.7.0 Use `LLMS_Generator::get_generated_content()` in favor of deprecated `LLMS_Generator::get_generated_posts()`.
*
* @return WP_Error|int|null WP_Error, WP Post ID of the clone (new) post, or null if post is not cloneable.
*/
public function clone_post() {
// If post type doesn't support cloning, don't proceed.
if ( ! $this->is_cloneable() ) {
return null;
}
$this->allowed_post_tags_set();
$generator = new LLMS_Generator( $this->toArray() );
$generator->set_generator( 'LifterLMS/Single' . ucwords( $this->model_post_type ) . 'Cloner' );
if ( ! $generator->is_error() ) {
$generator->generate();
}
$this->allowed_post_tags_unset();
$generated = $generator->get_generated_content();
if ( isset( $generated[ $this->db_post_type ] ) ) {
return $generated[ $this->db_post_type ][0];
}
return new WP_Error( 'generator-error', __( 'An unknown error occurred during post cloning. Please try again.', 'lifterlms' ) );
}
/**
* Trigger an export download of the given post type
*
* @since 3.3.0
* @since 3.19.2 Unknown.
* @since 4.8.0 Made sure extra data are added to the posts model array representation during export.
*
* @return void
*/
public function export() {
// If post type doesn't support exporting don't proceed.
if ( ! $this->is_exportable() ) {
return;
}
$title = str_replace( ' ', '-', $this->get( 'title' ) );
$title = preg_replace( '/[^a-zA-Z0-9-]/', '', $title );
/**
* Filters the export file name
*
* @since Unknown
*
* @param string $title The exported file name. Doesn't include the extension.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
$filename = apply_filters( 'llms_post_model_export_filename', $title . '_' . current_time( 'Ymd' ), $this );
header( 'Content-type: application/json' );
header( 'Content-Disposition: attachment; filename="' . $filename . '.json"' );
header( 'Pragma: no-cache' );
header( 'Expires: 0' );
$this->allowed_post_tags_set();
add_filter( 'llms_post_model_to_array_add_extras', '__return_true', 99 );
$arr = $this->toArray();
remove_filter( 'llms_post_model_to_array_add_extras', '__return_true', 99 );
$arr['_generator'] = 'LifterLMS/Single' . ucwords( $this->model_post_type ) . 'Exporter';
$arr['_source'] = get_site_url();
$arr['_version'] = llms()->version;
ksort( $arr );
echo json_encode( $arr );
$this->allowed_post_tags_unset();
die();
}
/**
* Private getter.
*
* @since 3.34.0
* @since 4.10.0 Add `post_name` as a property to skip scrubbing and add a filter on the list of properties to skip scrubbing.
* @since 5.1.2 Pass second parameter to the `get_the_excerpt` filter hook (the WP_Post object), introduced in WordPress 4.5.0.
*
* @param string $key The property key.
* @param boolean $raw Optional. Whether or not we need to get the raw value. Default false.
* @return mixed
*/
private function ___get( $key, $raw = false ) {
// Force numeric id and prevent filtering on the id.
if ( 'id' === $key ) {
return absint( $this->$key );
} elseif ( in_array( $key, array_keys( $this->get_post_properties() ) ) ) {
$post_key = 'post_' . $key;
// Ensure post is set globally for filters below.
global $post;
$temp = $post;
$post = $this->post;
switch ( $key ) {
case 'content':
$val = $raw ? $this->post->$post_key : llms_content( $this->post->$post_key );
break;
case 'excerpt':
/* This is a WordPress filter. */
$val = $raw ? $this->post->$post_key : apply_filters( 'get_the_excerpt', $this->post->$post_key, $this->post );
break;
case 'ping_status':
case 'comment_status':
case 'menu_order':
$val = $this->post->$key;
break;
case 'title':
/* This is a WordPress filter. */
$val = $raw ? $this->post->$post_key : apply_filters( 'the_title', $this->post->$post_key, $this->get( 'id' ) );
break;
default:
$val = $this->post->$post_key;
}
// Return the original global.
$post = $temp;
} elseif ( ! in_array( $key, $this->get_unsettable_properties() ) ) {
if ( metadata_exists( 'post', $this->id, $this->meta_prefix . $key ) ) {
$val = get_post_meta( $this->id, $this->meta_prefix . $key, true );
} else {
$val = $this->get_default_value( $key );
}
} else {
return $this->$key;
}
// If we found a value, apply default llms get filter and return the value.
if ( isset( $val ) ) {
/**
* Filters the list of properties which should be excluded from scrubbing during a property read.
*
* The dynamic portion of this hook, `{$this->model_post_type}`, refers to the post's model type,
* for example "course" for an `LLMS_Course`, "membership" for an `LLMS_Membership`, etc...
*
* @since 4.10.0
*
* @param string[] $props An array of property keys to be excluded from scrubbing.
* @param LLMS_Post_Model $this Instance of the post object.
*/
$exclude = apply_filters( "llms_get_{$this->model_post_type}_no_scrub_props", array( 'content', 'name' ), $this );
if ( ! $raw && ! in_array( $key, $exclude, true ) ) {
$val = $this->scrub( $key, $val );
}
/**
* Filters the property value
*
* The first dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
* The second dynamic part of this hook, `$key`, refers to the property name.
*
* @since Unknown
*
* @param mixed $val The property value.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
return apply_filters( "llms_get_{$this->model_post_type}_{$key}", $val, $this );
}
// Shouldn't ever get here.
return false;
}
/**
* Getter
*
* @since 3.0.0
*
* @param string $key The property key.
* @param boolean $raw Optional. Whether or not we need to get the raw value. Default is `false`.
* @return mixed
*/
public function get( $key, $raw = false ) {
if ( $raw ) {
return $this->___get( $key, $raw );
}
return $this->$key;
}
/**
* Getter for array values
*
* Ensures that even empty values return an array.
*
* @since 3.0.0 Unknown.
*
* @param string $key Property key.
* @return array
*/
public function get_array( $key ) {
$val = $this->get( $key );
if ( ! is_array( $val ) ) {
$val = array( $val );
}
return $val;
}
/**
* Getter for date strings with optional date format conversion
*
* If no format is supplied, the default format available via $this->get_date_format() will be used.
*
* @since 3.0.0
*
* @param string $key Property key.
* @param string $format Any valid date format that can be passed to date().
* @return string
*/
public function get_date( $key, $format = null ) {
$format = ( ! $format ) ? $this->get_date_format() : $format;
$raw = $this->get( $key );
// Only convert the date if we actually have something stored, otherwise we'll return the current date, which we probably aren't expecting.
$date = $raw ? date_i18n( $format, strtotime( $raw ) ) : '';
/**
* Filters the date(s)
*
* The first dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
* The second dynamic part of this hook, `$key`, refers to the date property name.
*
* @since 3.0.0
*
* @param string $date The formatted date.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
return apply_filters( "llms_get_{$this->model_post_type}_{$key}_date", $date, $this );
}
/**
* Retrieve the default date format for the post model
*
* This *can* be overridden by child classes if the post type requires a different default date format.
*
* If no format is supplied by the child class, the default WP date & time formats available
* via General Settings will be combined and used.
*
* @since 3.0.0
*
* @return string
*/
protected function get_date_format() {
$format = get_option( 'date_format' ) . ' ' . get_option( 'time_format' );
/**
* Filters the date format
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
*
* @since 3.0.0
*
* @param string $format The date format.
*/
return apply_filters( "llms_get_{$this->model_post_type}_date_format", $format );
}
/**
* Get the default value of a property
*
* If defaults don't exist returns an empty string in accordance with the return of get_post_meta() when no metadata exists.
*
* @since 3.24.0
*
* @param string $key Property key/name.
* @return mixed
*/
public function get_default_value( $key ) {
$defaults = $this->get_property_defaults();
return isset( $defaults[ $key ] ) ? $defaults[ $key ] : '';
}
/**
* Retrieve URL for an image associated with the post
*
* Currently, only retrieves the featured image if the post type supports it.
* In the future, this will allow retrieval of custom post images as well.
*
* @since 3.3.0
* @since 3.8.0 Unknown.
*
* @param string|array $size Registered image size or a numeric array with width/height.
* @param string $key Currently unused but here for forward compatibility if
* additional custom images are added
* @return string Empty string if no image or not supported.
*/
public function get_image( $size = 'full', $key = '' ) {
if ( 'thumbnail' === $key && post_type_supports( $this->db_post_type, 'thumbnail' ) ) {
$url = get_the_post_thumbnail_url( $this->get( 'id' ), $size );
} else {
$id = $this->get( $key );
if ( is_numeric( $id ) ) {
$src = wp_get_attachment_image_src( $id, $size );
if ( $src ) {
$url = $src[0];
}
}
}
return ! empty( $url ) ? $url : '';
}
/**
* Retrieve the Post's post type data object
*
* @since 3.0.0
*
* @return WP_Post_Type|null
*/
public function get_post_type_data() {
return get_post_type_object( $this->get( 'type' ) );
}
/**
* Retrieve a label from the post type data object's labels object
*
* @since 3.0.0
* @since 3.8.0 Unknown.
*
* @param string $label Key for the label.
* @return string
*/
public function get_post_type_label( $label = 'singular_name' ) {
$obj = $this->get_post_type_data();
if ( property_exists( $obj, 'labels' ) && property_exists( $obj->labels, $label ) ) {
return $obj->labels->$label;
}
return '';
}
/**
* Getter for price strings with optional formatting options
*
* @since 3.0.0
* @since 3.7.0 Unknown.
* @since 4.8.0 Use strict type comparison where possible.
*
* @param string $key Property key.
* @param array $price_args Optional. Array of arguments that can be passed to llms_price(). Default is empty array.
* @param string $format Optional. Format conversion method [html|raw|float]. Default is 'html'.
* @return mixed
*/
public function get_price( $key, $price_args = array(), $format = 'html' ) {
$price = $this->get( $key );
// Handle empty or unset values gracefully.
if ( '' === $price ) {
$price = 0;
}
/**
* Filter the price before formatting the price for display.
*
* @since 7.8.0
*/
$price = apply_filters( "llms_{$this->model_post_type}_get_price_before_formatting", $price, $key, $price_args, $this );
if ( 'html' === $format || 'raw' === $format ) {
$price = llms_price( $price, $price_args );
if ( 'raw' === $format ) {
$price = wp_strip_all_tags( $price );
}
} elseif ( 'float' === $format ) {
$price = floatval( number_format( $price, get_lifterlms_decimals(), '.', '' ) );
} else {
/**
* Allows applying custom formatting to price(s).
*
* This is only fired when the `get_price()`'s `$format` passed param is not one of html|raw|float.
*
* @since Unknown
*
* The first dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
* The second dynamic part of this hook, `$key`, refers to the price property name.
* The third dynamic part of this hook, `$format`, refers to the custom format conversion method.
*/
$price = apply_filters( "llms_get_{$this->model_post_type}_{$key}_{$format}", $price, $key, $price_args, $format, $this );
}
/**
* Filters the price(s)
*
* The first dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
* The second dynamic part of this hook, `$key`, refers to the price property name.
*
* @since Unknown
*
* @param string $price The maybe formatted price.
* @param string $key The price property name.
* @param array $price_args Array of arguments that can be passed to llms_price().
* @param string $format Format conversion method.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
return apply_filters( "llms_get_{$this->model_post_type}_{$key}_price", $price, $key, $price_args, $format, $this );
}
/**
* Retrieve the default values for properties
*
* @since 3.24.0
*
* @return array
*/
public function get_property_defaults() {
/**
* Filters the defaults properties.
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
*
* @since 3.24.0
*
* @param array $property_defaults Array of default property values.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
return apply_filters( "llms_get_{$this->model_post_type}_property_defaults", $this->property_defaults, $this );
}
/**
* An array of default arguments to pass to $this->create() when creating a new post
*
* This *should* be overridden by child classes.
*
* @since 3.0.0
* @since 3.18.0 Unknown.
*
* @param array $args Args of data to be passed to wp_insert_post.
* @return array
*/
protected function get_creation_args( $args = null ) {
// Allow nothing to be passed in.
if ( empty( $args ) ) {
$args = array();
}
// Backwards compat to original 3.0.0 format when just a title was passed in.
if ( is_string( $args ) ) {
$args = array(
'post_title' => $args,
);
}
$args = wp_parse_args(
$args,
array(
'comment_status' => 'closed',
'ping_status' => 'closed',
'post_author' => get_current_user_id(),
'post_content' => '',
'post_excerpt' => '',
'post_status' => 'draft',
'post_title' => '',
'post_type' => $this->get( 'db_post_type' ),
)
);
/**
* Filters the llms post creation args
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
*
* @since 3.24.0
*
* @param array $args Array of default creation args to be passed to `wp_insert_post()`.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
return apply_filters( "llms_{$this->model_post_type}_get_creation_args", $args, $this );
}
/**
* Get media embeds.
*
* @since 3.17.0
* @since 3.17.5 Unknown.
* @since 7.7.0 Added function to get provider support.
*
* @param string $type Optional. Embed type [video|audio]. Default is 'video'.
* @param string $prop Optional. Postmeta property name. Default is empty string.
* If not supplied it will default to {$type}_embed.
* @return string
*/
protected function get_embed( $type = 'video', $prop = '' ) {
$ret = '';
$prop = $prop ? $prop : $type . '_embed';
$url = $this->get( $prop );
if ( trim( $url ) && wp_parse_url( $url ) ) {
$this->get_provider_support( $url );
$ret = wp_oembed_get( sanitize_url( $url ) );
if ( ! $ret ) {
$ret = apply_filters( 'llms_embed_shortcode_output', do_shortcode( sprintf( '[%1$s src="%2$s"]', $type, $url ) ), $type, $this );
}
}
/**
* Filters the embed html
*
* The first dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
* The second dynamic portion of this hook, `$type`, refers to the embed type [video|audio].
*
* @since Unknown
*
* @param array $embed The embed html.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
* @param string $type Embed type [video|audio].
* @param string $prop Postmeta property name.
*/
return apply_filters( "llms_{$this->model_post_type}_{$type}", $ret, $this, $type, $prop );
}
/**
* Get a property's data type for scrubbing
*
* Used by $this->scrub() to determine how to scrub the property.
*
* @since 3.3.0
*
* @param string $key Property key.
* @return string
*/
protected function get_property_type( $key ) {
$props = $this->get_properties();
// Check against the properties array.
if ( in_array( $key, array_keys( $props ) ) ) {
$type = $props[ $key ];
} else {
$type = 'text';
}
return $type;
}
/**
* Retrieve an array of post properties
*
* These properties need to be get/set with alternate methods.
*
* @since 3.0.0
* @since 3.31.0 Treat excerpts as HTML instead of plain text.
* @since 3.34.0 Add date and modified dates GMT version, comment and ping status, post password and menu_order.
*
* @return array
*/
protected function get_post_properties() {
/**
* Filters the properties of the model that are properties of WP_Post.
*
* @since Unknown
*
* @param array $post_properties Associative array of the type $post_property_name => type.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
return apply_filters(
'llms_post_model_get_post_properties',
array(
'author' => 'absint',
'content' => 'html',
'date' => 'text',
'date_gmt' => 'text',
'excerpt' => 'html',
'password' => 'text',
'parent' => 'absint',
'menu_order' => 'absint',
'modified' => 'text',
'modified_gmt' => 'text',
'name' => 'text',
'status' => 'text',
'title' => 'text',
'type' => 'text',
'comment_status' => 'text',
'ping_status' => 'text',
),
$this
);
}
/**
* Retrieve an array of properties defined by the model
*
* @since 3.3.0
* @since 3.16.0 Unknown.
*
* @return array
*/
public function get_properties() {
$props = array_merge( $this->get_post_properties(), $this->properties );
/**
* Filters the llms post properties
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
*
* @since Unknown
*
* @param array $properties Array of properties defined by the model
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
return apply_filters( "llms_get_{$this->model_post_type}_properties", $props, $this );
}
/**
* Get the properties that will be used to generate the array representation of the model.
*
* @since 5.4.1
*
* @return string[] Array of property keys to be used by {@see toArray}.
*/
protected function get_to_array_properties() {
$all_props = array_keys( $this->get_properties() );
/**
* Filters the properties which will excluded form the array representation of the model
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
*
* @since Unknown
*
* @param string[] $excluded Array of property names.
* @param string[] $all_props The full property list without the applied exclusions.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
$excluded = apply_filters(
"llms_get_{$this->model_post_type}_excluded_to_array_properties",
$this->get_to_array_excluded_properties(),
$all_props,
$this
);
$props = array_diff(
$all_props,
$excluded
);
/**
* Filters the properties which will populate the array representation of the model.
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
*
* @since Unknown
*
* @param string[] $props Array of property names.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
return apply_filters(
"llms_get_{$this->model_post_type}_to_array_properties",
$props,
$this
);
}
/**
* Get the properties that will be explicitly excluded from the array representation of the model.
*
* This stub can be overloaded by an extending class and the property list is filterable via the
* {@see llms_get_{$this->model_post_type}_excluded_to_array_properties} filter.
*
* @since 5.4.1
*
* @return string[]
*/
protected function get_to_array_excluded_properties() {
return array();
}
/**
* Retrieve the registered Label of the post's current status
*
* @since 3.0.0
*
* @return string
*/
public function get_status_name() {
$obj = get_post_status_object( $this->get( 'status' ) );
/**
* Filters the registered label of the post's current status.
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
*
* @since 3.0.0
*
* @param string $label The registered label of the post's current status.
*/
return apply_filters( "llms_get_{$this->model_post_type}_status_name", $obj->label );
}
/**
* Get an array of terms for a given taxonomy for the post
*
* @since 3.8.0
*
* @param string $tax Taxonomy name.
* @param boolean $single Return only one term as an int, useful for taxes which
* Can only have one term (eg: visibilities and difficulties and such)
* @return mixed When single a single term object or null.
* When not single an array of term objects.
*/
public function get_terms( $tax, $single = false ) {
$terms = get_the_terms( $this->get( 'id' ), $tax );
if ( $single ) {
return $terms ? $terms[0] : null;
}
return $terms ? $terms : array();
}
/**
* Array of properties which *cannot* be set
*
* If a child class adds any properties which should not be settable
* the class should override this property and add their custom
* properties to the array.
*
* @since 3.0.0
*
* @return array
*/
protected function get_unsettable_properties() {
/**
* Filters the properties of the model that *cannot* be set
*
* @since Unknown
*
* @param array $unsettable_properties Array of property names.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
return apply_filters(
'llms_post_model_get_unsettable_properties',
array(
'db_post_type',
'id',
'meta_prefix',
'model_post_type',
'post',
),
$this
);
}
/**
* Determine if the associated post is exportable
*
* @since 3.3.0
*
* @return boolean
*/
public function is_cloneable() {
return post_type_supports( $this->db_post_type, 'llms-clone-post' );
}
/**
* Determine if the associated post is exportable
*
* @since 3.3.0
*
* @return boolean
*/
public function is_exportable() {
return post_type_supports( $this->db_post_type, 'llms-export-post' );
}
/**
* Format the object for json serialization
*
* Encodes the results of $this->toArray().
*
* @todo The `mixed` return type declared by the parent method, which should be defined here as well,
* is not available until PHP 8.0. Once support is dropped for 7.4 we can add the return type declaration
* and remove the `#[ReturnTypeWillChange]` attribute. This *must* happen before the release of PHP 9.0.
*
* @since 3.3.0
*
* @return array
*/
#[ReturnTypeWillChange]
public function jsonSerialize() {
/**
* Filters the properties of the model that *cannot* be set
*
* @since 3.3.0
*
* @param array $model Array representation of the LLMS_Post_Model object.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
return apply_filters( 'llms_post_model_json_serialize', $this->toArray(), $this );
}
/**
* Scrub field according to it's type
*
* This is automatically called by set() method before anything is actually set.
*
* @since 3.0.0
* @since 3.16.0 Unknown.
*
* @param string $key Property key.
* @param mixed $val Property value.
* @return mixed
*/
protected function scrub( $key, $val ) {
/**
* Filters the property type being scrubbed.
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
*
* @since Unknown
*
* @param string $type The property type.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
$type = apply_filters( "llms_get_{$this->model_post_type}_property_type", $this->get_property_type( $key ), $this );
/**
* Filters the scrubbed property.
*
* The first dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
* The second dynamic part of this hook, `$key`, refers to the property name.
*
* @since Unknown
*
* @param mixed $scrubbed The scrubbed property value.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
* @param string $key The property name.
* @param mixed $val The original property value.
*/
return apply_filters( "llms_scrub_{$this->model_post_type}_field_{$key}", $this->scrub_field( $val, $type ), $this, $key, $val );
}
/**
* Scrub fields according to datatype
*
* @since 3.0.0
* @since 3.19.2 Unknown.
* @since 5.9.0 Use `wp_strip_all_tags()` in favor of `strip_tags()`.
* Only strip tags from string values.
* Coerce `null` html input to an empty string.
*
* @param mixed $val Property value to scrub.
* @param string $type Data type.
* @return mixed
*/
protected function scrub_field( $val, $type ) {
if ( is_string( $val ) && 'html' !== $type ) {
$val = wp_strip_all_tags( $val );
}
switch ( $type ) {
case 'absint':
$val = absint( $val );
break;
case 'array':
if ( '' === $val ) {
$val = array();
}
$val = (array) $val;
break;
case 'bool':
case 'boolean':
$val = boolval( $val );
break;
case 'float':
$val = floatval( $val );
break;
case 'html':
$this->allowed_post_tags_set();
$val = wp_kses_post( $val ?? '' );
$this->allowed_post_tags_unset();
break;
case 'int':
$val = intval( $val );
break;
case 'yesno':
$val = 'yes' === $val ? 'yes' : 'no';
break;
case 'url':
$val = sanitize_url( $val );
break;
case 'text':
case 'string':
default:
$val = sanitize_text_field( $val );
}
return $val;
}
/**
* Setter.
*
* @since 3.0.0
* @since 3.30.3 Use `wp_slash()` when setting properties.
* @since 3.34.0 Turned to be only a wrapper for the set_bulk() method.
* @since 6.5.0 Introduced `$allow_same_meta_value` param.
*
* @param string|array $key_or_array Key of the property or an associative array of key/val pairs.
* @param mixed $val Value to set the property with.
* This parameter will be ignored when the first parameter is an associative array of key/val pairs.
* @param boolean $allow_same_meta_value Whether or not updating a meta with the same value as stored in the db is allowed.
* @return boolean true on success, false on error or if the submitted value is the same as what's in the database and `$allow_same_meta_value` is `false`.
*/
public function set( $key_or_array, $val = '', $allow_same_meta_value = false ) {
$model_array = $key_or_array;
if ( ! is_array( $key_or_array ) ) {
$model_array = array(
$key_or_array => $val,
);
}
return $this->set_bulk( $model_array, false, $allow_same_meta_value );
}
/**
* Bulk setter.
*
* @since 3.34.0
* @since 3.36.1 Use WP_Error::$errors in place of WP_Error::has_errors() to support WordPress version prior to 5.1.
* @since 5.3.1 Fix quote slashing when the user is not an admin.
* @since 6.5.0 Introduced `$allow_same_meta_value` param.
* Code reorganization.
*
* @param array $model_array Associative array of key/val pairs.
* @param array $wp_error Whether or not return a WP_Error.
* @param boolean $allow_same_meta_value Whether or not updating a meta with the same value as stored in the db is allowed.
* @return boolean|WP_Error True on success. If the param $wp_error is set to false this will be false on error or if there was nothing to update.
* Otherwise, this will be a WP_Error object collecting all the errors encountered along the way.
*/
public function set_bulk( $model_array, $wp_error = false, $allow_same_meta_value = false ) {
if ( empty( $model_array ) ) {
return $wp_error ? new WP_Error( 'empty_data', __( 'Empty data', 'lifterlms' ) ) : false;
}
$llms_post = $this->parse_properties_to_set( $model_array );
if ( empty( $llms_post ) ) {
return $wp_error ? new WP_Error( 'invalid_data', __( 'Invalid data', 'lifterlms' ) ) : false;
}
$update_post_properties = $this->update_post_properties( $llms_post['post'] );
$update_meta_properties = $this->update_meta_properties( $llms_post['meta'], $allow_same_meta_value );
$error = is_wp_error( $update_post_properties ) ? $update_post_properties : new WP_Error();
if ( is_wp_error( $update_meta_properties ) ) {
foreach ( $update_meta_properties->get_error_messages( 'invalid_meta' ) as $message ) {
$error->add( 'invalid_meta', $message );
}
}
if ( ! empty( $error->has_errors() ) ) {
return $wp_error ? $error : false;
}
return true;
}
/**
* Parse the LifterLMS post properties to set.
*
* Logic moved from `set_bulk()` method.
*
* @since 6.5.0
*
* @param array $model_array Associative array of key/val pairs.
* @return array|bool Returns `false` if nothing to set or an array that contains all the post properties and all the metas to set.
*/
private function parse_properties_to_set( $model_array ) {
$llms_post = array(
'post' => array(),
'meta' => array(),
);
$post_properties = array_keys( $this->get_post_properties() );
$unsettable_properties = $this->get_unsettable_properties();
foreach ( $model_array as $key => $val ) {
// Sanitize the post properties keys by removing the 'post_' prefix.
if ( 'post_' === substr( $key, 0, 5 ) ) {
$_key = substr( $key, 5 );
if ( in_array( $_key, $post_properties, true ) ) {
$key = $_key;
}
}
$val = $this->scrub( $key, $val );
/**
* WordPress Post properties to be updated using the wp_insert_post() function.
*
* The 'edit_date' must be passed to the wp_update_post() function in order
* to allow 'drafty' posts' creation date to be modified.
*/
if ( in_array( $key, $post_properties, true ) || 'edit_date' === $key ) {
$type = 'post';
$llms_post_key = "post_{$key}";
switch ( $key ) {
case 'content':
/** This is a WordPress core filter. {@see kses_init_filters()}*/
$val = stripslashes( apply_filters( 'content_save_pre', addslashes( $val ) ) );
break;
case 'excerpt':
/** This is a WordPress core filter. {@see kses_init_filters()}*/
$val = stripslashes( apply_filters( 'excerpt_save_pre', addslashes( $val ) ) );
break;
case 'edit_date':
case 'ping_status':
case 'comment_status':
case 'menu_order':
$llms_post_key = $key;
break;
case 'title':
/** This is a WordPress core filter. {@see kses_init_filters()}*/
$val = stripslashes( apply_filters( 'title_save_pre', addslashes( $val ) ) );
break;
}
} elseif ( ! in_array( $key, $unsettable_properties, true ) ) {
$type = 'meta';
$llms_post_key = $key;
} else {
continue;
}
/**
* Filters the property value prior to be set.
*
* The first dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
* The second dynamic part of this hook, `$key`, refers to the property name.
*
* @since Unknown
*
* @param mixed $val The property value.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
$llms_post[ $type ][ $llms_post_key ] = apply_filters( "llms_set_{$this->model_post_type}_{$key}", $val, $this );
}
return empty( $llms_post['post'] ) && empty( $llms_post['meta'] ) ? false : $llms_post;
}
/**
* Update post properties.
*
* Logic moved from `set_bulk()` method.
*
* @since 6.5.0
*
* @param array $post_properties Array of post properties to set.
* @return void|WP_Error
*/
private function update_post_properties( $post_properties ) {
if ( empty( $post_properties ) ) {
return;
}
$args = array_merge(
$post_properties,
array(
'ID' => $this->get( 'id' ),
)
);
$update_post = wp_update_post( wp_slash( $args ), true );
if ( is_wp_error( $update_post ) ) {
return $update_post;
}
// Update this post.
$this->post = get_post( $this->get( 'id' ) );
}
/**
* Update post meta properties.
*
* Logic moved from `set_bulk()` method.
*
* @param array $post_meta_properties Array of post meta properties to set.
* @param boolean $allow_same_meta_value Whether or not updating a meta with the same value as stored in the db is allowed.
* By default `update_post_meta` doesn't allow that.
* @return void|WP_Error
*/
private function update_meta_properties( $post_meta_properties, $allow_same_meta_value ) {
if ( empty( $post_meta_properties ) ) {
return;
}
$error = new WP_Error();
foreach ( $post_meta_properties as $key => $val ) {
if ( $allow_same_meta_value ) {
/**
* Do pretty much(*) the same check for a duplicate value as in `update_metadata()`
* to avoid `update_post_meta()` returning false.
* {@see WP_REST_Meta_Fields::update_meta_value()}.
*
* If the new value to be set equals the old one don't update it.
*
* (*) This is not exactly the same check you can find in `update_metadata()` as that
* account for multiple meta values for the same key, while we don't.
*/
$old_value = get_post_meta( $this->id, $this->meta_prefix . $key, true );
if ( $this->is_meta_value_same_as_stored_value( $key, $old_value, $val ) ) {
continue;
}
}
$u = update_post_meta( $this->id, $this->meta_prefix . $key, wp_slash( $val ) );
if ( ! ( is_numeric( $u ) || true === $u ) ) {
/* translators: %s: Meta key. */
$error->add( 'invalid_meta', sprintf( __( 'Cannot insert/update the %s meta', 'lifterlms' ), $key ) );
}
}
if ( $error->has_errors() ) {
return $error;
}
}
/**
* Checks if the user provided value is equivalent to a stored value for the given meta key.
*
* {@see WP_REST_Meta_Fields::is_meta_value_same_as_stored_value()}.
*
* @param string $key The un-prefixed meta key being checked.
* @param mixed $stored_value The currently stored value retrieved from get_metadata().
* @param mixed $new_value The new value.
* @return bool
*/
private function is_meta_value_same_as_stored_value( $key, $stored_value, $new_value ) {
$sanitized = sanitize_meta( $this->meta_prefix . $key, $new_value, 'post', $this->db_post_type );
// The return value of get_metadata will always be a string for scalar types.
$scalar_types = array(
'string',
'text',
'absint',
'yesno',
'html',
'float',
'int',
'bool',
'boolean',
);
if ( in_array( $this->get_property_type( $key ), $scalar_types, true ) ) {
$sanitized = (string) $sanitized;
}
return $sanitized === $stored_value;
}
/**
* Update terms for the post for a given taxonomy
*
* @since 3.8.0
*
* @param array $terms Array of terms (name or ids).
* @param string $tax The name of the tax.
* @param boolean $append Optional. If true, will append the terms, false will replace existing terms. Default is `false`.
* @return bool
*/
public function set_terms( $terms, $tax, $append = false ) {
$set = wp_set_object_terms( $this->get( 'id' ), $terms, $tax, $append );
// wp_set_object_terms has 3 options when unsuccessful and only 1 for success
// an array of terms when successful, let's keep it simple...
return is_array( $set );
}
/**
* Coverts the object to an associative array
*
* Any property returned by $this->get_properties() will be retrieved
* via $this->get() and added to the array.
*
* Extending classes can add additional properties to the array
* by overriding $this->toArrayAfter().
*
* This function is also utilized to serialize the object to JSON.
*
* @since 3.3.0
* @since 3.17.0 Unknown.
* @since 4.7.0 Add exporting of extra data (images and blocks).
* @since 4.8.0 Exclude extra data by default. Added `llms_post_model_to_array_add_extras` filter.
* @since 5.4.1 Load properties to be used to generate the array from the new `get_to_array_properties()` method.
*
* @return array
*/
public function toArray() {
$arr = array(
'id' => $this->get( 'id' ),
);
foreach ( $this->get_to_array_properties() as $prop ) {
if ( in_array( $prop, array( 'content', 'excerpt', 'title' ), true ) ) {
$post_prop = "post_{$prop}";
$arr[ $prop ] = $this->post->$post_prop;
} else {
$arr[ $prop ] = $this->get( $prop );
}
}
// Add the featured image if the post type supports it.
if ( post_type_supports( $this->db_post_type, 'thumbnail' ) ) {
$arr['featured_image'] = $this->get_image( 'full', 'thumbnail' );
}
// Expand instructors if instructors are supported.
if ( ! empty( $arr['instructors'] ) && method_exists( $this, 'instructors' ) ) {
foreach ( $arr['instructors'] as &$data ) {
$instructor = llms_get_instructor( $data['id'] );
if ( $instructor ) {
$data = array_merge( $data, $instructor->toArray() );
}
}
} elseif ( ! empty( $arr['author'] ) ) {
$instructor = llms_get_instructor( $arr['author'] );
if ( $instructor ) {
$arr['author'] = $instructor->toArray();
}
}
/**
* Filter whether or not "extra" content should be included in the post array
*
* `__return_true` (with priority 99) is used to force the filter on during exports.
*
* @since 4.8.0
*
* @param boolean $include Whether or not to include extra data. Default is `false`, except on during exports.
* @param LLMS_Post_Model $model Post model instance.
*/
$add_array_extra = apply_filters( 'llms_post_model_to_array_add_extras', false, $this );
/**
* Filter whether or not "extra" content should be included in the post array
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
*
* @since 4.7.0
*
* @param boolean $include Whether or not to include extra data.
* @param LLMS_Post_Model $model Post model instance.
*/
$add_array_extra = apply_filters( "llms_{$this->model_post_type}_to_array_add_extras", $add_array_extra, $this );
if ( $add_array_extra ) {
$arr = $this->to_array_extra( $arr );
}
// Add custom fields.
$arr = $this->toArrayCustom( $arr );
// Allow extending classes to add properties easily without overriding the class.
$arr = $this->toArrayAfter( $arr );
$cpt_data = $this->get_post_type_data();
if ( $cpt_data->public ) {
$arr['permalink'] = get_permalink( $this->get( 'id' ) );
}
ksort( $arr ); // Because i'm anal...
/**
* Filter the final post array created when converting the object to an array
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
*
* @since 4.7.0
*
* @param array $arr Associative array of the model.
* @param LLMS_Post_Model $model Post model instance.
*/
return apply_filters( "llms_{$this->model_post_type}_to_array", $arr, $this );
}
/**
* Enqueues provider scripts for the URL.
*
* @since 7.7.0
*
* @param string $url URL to check.
* @return null If no provider is found.
*/
public function get_provider_support( $url ) {
$host = wp_parse_url( $url, PHP_URL_HOST );
// VideoPress Provider.
if ( is_plugin_active( 'jetpack-videopress/jetpack-videopress.php' ) ) {
if ( strpos( $host, 'videopress.com' ) !== false || strpos( $host, 'video.wordpress.com' ) !== false ) {
wp_enqueue_script( 'videopress-token-bridge', plugins_url() . '/jetpack-videopress/jetpack_vendor/automattic/jetpack-videopress/src/../build/lib/token-bridge.js', array(), llms()->version, true );
wp_localize_script( 'videopress-token-bridge', 'videopressAjax', array() );
}
}
return null;
}
/**
* Called before data is sorted and returned by $this->toArray()
*
* Extending classes should override this data if custom data should
* be added when object is converted to an array or json.
*
* @since 3.3.0
*
* @param array $arr Array of data to be serialized.
* @return array
*/
protected function toArrayAfter( $arr ) {
return $arr;
}
/**
* Add "extra" data to the post array during export/serialization
*
* This method adds two arrays of data, "blocks" and "images".
*
* The "blocks" array is an array of reusable blocks used in the post's content. During
* an import these blocks will be imported into the site.
*
* The "images" array is an array of image element source URLs found in the post's content. During
* an import these images will be imported into the new site via media sideloading.
*
* @since 4.7.0
*
* @param array $arr Post array from `toArray()`.
* @return array[]
*/
protected function to_array_extra( $arr ) {
$arr['_extras'] = array(
'blocks' => empty( $arr['content'] ) ? array() : $this->to_array_extra_blocks( $arr['content'] ),
'images' => empty( $arr['content'] ) ? array() : $this->to_array_extra_images( $arr['content'] ),
);
return $arr;
}
/**
* Add reusable blocks found in the post's content to the post's array
*
* @since 4.7.0
*
* @param string $content Raw `post_content` string.
* @return array[] {
* Array of reusable block information arrays. The array key is the WP_Post ID of the reusable block.
*
* @type string $title Reusable block title.
* @type string $content Reusable block content.
* }
*/
protected function to_array_extra_blocks( $content ) {
$blocks = array();
foreach ( parse_blocks( $content ) as $block ) {
if ( 'core/block' !== $block['blockName'] ) {
continue;
}
$post = get_post( $block['attrs']['ref'] );
if ( ! $post ) {
continue;
}
$blocks[ $post->ID ] = array(
'title' => $post->post_title,
'content' => $post->post_content,
);
}
return $blocks;
}
/**
* Add images found in the post's content to the post's array
*
* @since 4.7.0
*
* @param string $content Raw `post_content` string.
* @return string[] Array of image source URLs.
*/
protected function to_array_extra_images( $content ) {
$images = array();
$dom = llms_get_dom_document( $content );
if ( is_wp_error( $dom ) ) {
return $images;
}
$site_url = get_site_url();
foreach ( $dom->getElementsByTagName( 'img' ) as $img ) {
$src = $img->getAttribute( 'src' );
// Only include images stored in this site's media library.
if ( 0 !== strpos( $src, $site_url ) ) {
continue;
}
$images[] = $src;
}
return array_values( array_unique( $images ) );
}
/**
* Called by toArray to add custom fields via get_post_meta()
*
* Removes all custom props registered to the $this->properties automatically.
* Also removes some fields used by the WordPress core that don't hold necessary data.
* Extending classes may override this class to exclude, extend, or modify the custom fields for a post type.
*
* @since 3.16.11
* @since 3.30.0 Use `maybe_unserialize()` to ensure array data is accessible as an array.
* @since 3.30.2 Add filter to allow 3rd parties to prevent a field from being added to the custom field array.
*
* @param array $arr Existing post array.
* @return array
*/
protected function toArrayCustom( $arr ) {
// Build an array of keys that are registered or can be excluded as a custom field.
$props = array_keys( $this->get_properties() );
foreach ( $props as &$prop ) {
$prop = $this->meta_prefix . $prop;
}
$props[] = '_edit_lock';
$props[] = '_edit_last';
// Get all meta data.
$custom = array();
foreach ( get_post_meta( $this->get( 'id' ) ) as $key => $vals ) {
// Skip registered fields or fields 3rd parties want to skip.
/**
* Filters whether the custom field should be excluded in the array representation of the post model
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to the model's post type. For example "course",
* "lesson", "membership", etc...
*
* @since 3.30.2
*
* @param boolean $exclude Whether the custom field should be excluded. Default is `false`.
* @param string $key The custom field name.
* @param LLMS_Post_Model $llms_post The LLMS_Post_Model instance.
*/
if ( in_array( $key, $props, true ) || apply_filters( "llms_{$this->model_post_type}_skip_custom_field", false, $key, $this ) ) {
continue;
}
// Add it.
$custom[ $key ] = array_map( 'maybe_unserialize', $vals );
}
// Add the compiled custom array.
$arr['custom'] = $custom;
return $arr;
}
}
================================================
FILE: includes/abstracts/abstract.llms.shortcode.course.element.php
================================================
<?php
/**
* Common Shortcode for course element templates
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.6.0
* @version 3.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Common Shortcode for course element templates abstract class
*
* @since 3.6.0
*/
abstract class LLMS_Shortcode_Course_Element extends LLMS_Shortcode {
/**
* Call the template function for the course element
*
* @return void
* @since 3.6.0
* @version 3.6.0
*/
abstract protected function template_function();
/**
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output()
*
* @return array
* @since 3.6.0
* @version 3.6.0
*/
protected function get_default_attributes() {
return array(
'course_id' => get_the_ID(),
);
}
/**
* Retrieve the actual content of the shortcode
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter
*
* @return string
* @since 3.6.0
* @version 3.6.0
*/
protected function get_output() {
// Get a reference to the current page where the shortcode is displayed.
global $post;
$current_post = $post;
$course = get_post( $this->get_attribute( 'course_id' ) );
// We don't have a post object to proceed with.
if ( ! $course ) {
return '';
}
if ( 'course' !== $course->post_type ) {
// Get the parent.
$parent = llms_get_post_parent_course( $course );
// Post type doesn't have a parent so we can't display a syllabus.
if ( ! $parent ) {
return '';
}
// We have a course.
$course = $parent->post;
}
ob_start();
// Hack the global so our syllabus template works.
if ( $course->ID != $current_post->ID ) {
$post = $course;
}
$this->template_function();
// Restore the global.
if ( $course->ID != $current_post->ID ) {
$post = $current_post;
}
return ob_get_clean();
}
}
================================================
FILE: includes/abstracts/abstract.llms.shortcode.php
================================================
<?php
/**
* Base Shortcode
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.4.3
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode Abstract.
*
* @since 3.4.3
*/
abstract class LLMS_Shortcode {
/**
* Shortcode tag
*
* @var string
*/
public $tag = '';
/**
* Retrieve the actual content of the shortcode
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter
*
* @return string
* @since 3.4.3
* @version 3.4.3
*/
abstract protected function get_output();
/**
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output()
*
* @return array
* @since 3.4.3
* @version 3.4.3
*/
protected function get_default_attributes() {
return array();
}
/**
* Retrieves a string used for default content which is used if no content is supplied
*
* @return string
* @since 3.4.3
* @version 3.4.3
*/
protected function get_default_content() {
return '';
}
/**
* Holds singletons for extending classes
*
* @var array
*/
private static $_instances = array();
private $attributes = array();
private $content = '';
/**
* Get the singleton instance for the extending class
*
* @return obj
* @since 3.4.3
* @version 3.4.3
*/
public static function instance() {
$class = get_called_class();
if ( ! isset( self::$_instances[ $class ] ) ) {
self::$_instances[ $class ] = new $class();
}
return self::$_instances[ $class ];
}
/**
* Private constructor
*
* @since 3.4.3
*/
private function __construct() {
add_shortcode( $this->tag, array( $this, 'output' ) );
}
/**
* Allow shortcodes to enqueue scripts only when the shortcode is used
* Enqueues a registered script IF that script isn't already enqueued
*
* @param string $handle script handle
* @return void
* @since 3.4.3
* @version 3.4.3
*/
protected function enqueue_script( $handle ) {
if ( wp_script_is( $handle, 'registered' ) && ! wp_script_is( $handle, 'enqueued' ) ) {
wp_enqueue_script( $handle );
}
}
/**
* Get the array of attributes
*
* @return array
* @since 3.4.3
* @version 3.5.1
*/
public function get_attributes() {
return apply_filters( $this->get_filter( 'get_attributes' ), $this->attributes, $this );
}
/**
* Get a specific attribute from the attributes array
*
* @param string $key attribute key to retrieve
* @param string $default if no attribute is set, this value will be used
* @return mixed
* @since 3.4.3
* @version 3.5.1
*/
public function get_attribute( $key, $default = '' ) {
$attributes = $this->get_attributes();
if ( isset( $attributes[ $key ] ) ) {
return $attributes[ $key ];
}
return $default;
}
/**
* Retrieve the content of the shortcode
*
* @return string
* @since 3.4.3
* @version 3.5.1
*/
public function get_content() {
return apply_filters( $this->get_filter( 'get_content' ), $this->content, $this );
}
/**
* Retrieve a string that can be used for apply_filters()
* Ensures that all shortcode related filters follow the same naming convention
*
* @param string $filter filter name / suffix
* @return string
* @since 3.4.3
* @version 3.4.3
*/
protected function get_filter( $filter ) {
return $this->tag . '_' . $filter;
}
/**
* Output the actual content of the shortcode
* This is the callback function used by add_shortcode
* and can also be used programmatically, used in some widgets
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter
*
* @since 3.4.3
* @since 3.5.1 Unknown.
* @since 5.0.0 Merge attributes in a separate method.
*
* @param array $atts user submitted shortcode attributes
* @param string $content user submitted content
* @return string
*/
public function output( $atts = array(), $content = '' ) {
$this->attributes = $this->set_attributes( $atts );
if ( ! $content ) {
$content = apply_filters( $this->get_filter( 'get_default_content' ), $this->get_default_content(), $this );
}
$this->content = $content;
return apply_filters( $this->get_filter( 'output' ), $this->get_output(), $this );
}
/**
* Merge user attributes with default attributes.
*
* @since 5.0.0
*
* @param array $atts User-submitted shortcode attributes.
*
* @return array
*/
protected function set_attributes( $atts = array() ) {
return shortcode_atts(
apply_filters( $this->get_filter( 'get_default_attributes' ), $this->get_default_attributes(), $this ),
$atts,
$this->tag
);
}
}
================================================
FILE: includes/abstracts/abstract.llms.update.php
================================================
================================================
FILE: includes/abstracts/index.php
================================================
<?php // quiet.
================================================
FILE: includes/abstracts/llms-abstract-admin-tool.php
================================================
<?php
/**
* Base for tools listed on the LifterLMS -> Status -> Tools & Utilities screen
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.37.19
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Abstract_Admin_Tool
*
* @since 3.37.19
*/
abstract class LLMS_Abstract_Admin_Tool {
/**
* Tool ID
*
* @var string
*/
protected $id = '';
/**
* Tool Priority
*
* Passed to the `llms_status_tools` filter when registering the tool.
*
* @var integer
*/
protected $priority = 10;
/**
* Process the tool.
*
* This method should do whatever the tool actually does.
*
* By the time this tool is called a nonce and the user's capabilities have already been checked.
*
* @since 3.37.19
*
* @return mixed
*/
abstract protected function handle();
/**
* Retrieve a description of the tool
*
* This is displayed on the right side of the tool's list before the button.
*
* @since 3.37.19
*
* @return string
*/
abstract protected function get_description();
/**
* Retrieve the tool's label
*
* The label is the tool's title. It's displayed in the left column on the tool's list.
*
* @since 3.37.19
*
* @return string
*/
abstract protected function get_label();
/**
* Retrieve the tool's button text
*
* @since 3.37.19
*
* @return string
*/
abstract protected function get_text();
/**
* Static constructor.
*
* @since 3.37.19
*
* @return void
*/
public function __construct() {
add_action( 'llms_status_tool', array( $this, 'maybe_handle' ) );
add_filter( 'llms_status_tools', array( $this, 'register' ), $this->priority );
}
/**
* Processes the tool if the submitted tool matches the tool's ID.
*
* @since 3.37.19
* @since 5.0.0 Add before and after action hooks.
*
* @param string tool_id ID of the submitted tool.
* @return mixed|false
*/
public function maybe_handle( $tool_id ) {
if ( $this->should_load() && $this->id === $tool_id ) {
/**
* Action run prior to running an admin tool's main `handle()` method.
*
* The dynamic portion of this hook `{$tool_id}` refers to the unique ID
* of the admin tool.
*
* @since 5.0.0
*
* @param object $tool_class Instance of the extending tool class.
*/
do_action( "llms_before_handle_tool_{$tool_id}", $this );
$handled = $this->handle();
/**
* Action run prior to running an admin tool's main `handle()` method.
*
* The dynamic portion of this hook `{$tool_id}` refers to the unique ID
* of the admin tool.
*
* @since 5.0.0
*
* @param object $tool_class Instance of the extending tool class.
*/
do_action( "llms_after_handle_tool_{$tool_id}", $this );
return $handled;
}
return false;
}
/**
* Register the tool.
*
* @since 3.37.19
*
* @see llms_status_tools (filter)
*
* @param array[] $tools Array of tool definitions.
* @return array[]
*/
public function register( $tools ) {
if ( ! $this->should_load() ) {
return $tools;
}
$tools[ $this->id ] = array(
'description' => $this->get_description(),
'label' => $this->get_label(),
'text' => $this->get_text(),
);
return $tools;
}
/**
* Conditionally load the tool
*
* This stub can be overridden by the tool to provide custom logic to determine
* whether or not the tool should be loaded and registered.
*
* @since 3.37.19
*
* @return boolean Return `true` to load the tool and `false` to not load it.
*/
protected function should_load() {
return true;
}
}
================================================
FILE: includes/abstracts/llms-abstract-admin-wizard.php
================================================
<?php
/**
* Display a Wizard
*
* @package LifterLMS/Abstracts/Classes
*
* @since 7.4.0
* @version 7.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Display a Wizard class.
*
* @since 7.4.0
*/
abstract class LLMS_Abstract_Admin_Wizard {
/**
* Wizard ID.
*
* @since 7.4.0
* @var string
*/
protected string $id;
/**
* Views directory.
*
* @since 7.4.0
* @var string
*/
protected string $views_dir;
/**
* Steps.
*
* @since 7.4.0
* @var array
*/
protected array $steps;
/**
* Page title.
*
* @since 7.4.0
* @var string
*/
protected string $title;
/**
* Error message.
*
* @since 7.4.0
* @var WP_Error|null
*/
public ?WP_Error $error = null;
/**
* Add hooks.
*
* @since 7.4.0
* @return void
*/
protected function add_hooks(): void {
/**
* Whether the LifterLMS Wizard is enabled.
*
* This filter may be used to entirely disable the setup wizard.
*
* The dynamic portion of this filter, `{$this->id}`, refers to the wizard type. E.g. "setup".
*
* @since 7.4.0
*
* @param bool $enabled Whether the wizard is enabled.
*/
if ( ! apply_filters( "llms_enable_{$this->id}_wizard", true ) ) {
return;
}
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue' ) );
add_action( 'admin_menu', array( $this, 'admin_menu' ) );
add_action( 'admin_init', array( $this, 'save' ) );
add_filter( 'llms_admin_show_header', array( $this, 'hide_admin_header' ), 10, 3 );
}
/**
* Hide the admin header on the wizard pages.
*
* @since 7.4.0
*
* @param bool $show Whether to show the admin header.
* @param WP_Screen $screen Current admin screen.
* @param string $page Current admin page.
* @return bool
*/
public function hide_admin_header( bool $show, WP_Screen $screen, string $page ): bool {
if ( "llms-{$this->id}" === $page ) {
$show = false;
}
return $show;
}
/**
* Register wizard setup page.
*
* @since 7.4.0
*
* @return string|bool The hook suffix of the setup wizard page ("admin_page_llms-setup"), or `false` if the user does not have the capability required.
*/
public function admin_menu() {
/**
* Filter the WP User capability required to access and run the setup wizard.
*
* The dynamic portion of this filter, `{$this->id}`, refers to the wizard type. E.g. "setup".
*
* @since 7.4.0
*
* @param string $cap Required user capability. Default value is `install_plugins`.
*/
$cap = apply_filters( "llms_{$this->id}_wizard_access", 'install_plugins' );
$hook = add_dashboard_page(
$this->title,
'',
$cap,
'llms-' . $this->id,
array( $this, 'output' )
);
update_option( 'lifterlms_first_time_' . $this->id, 'yes' );
return $hook;
}
/**
* Enqueue static assets for the setup wizard screens.
*
* @since 7.4.0
*
* @return bool
*/
public function enqueue(): bool {
if ( ! isset( $_GET['page'] ) || 'llms-' . $this->id !== $_GET['page'] ) {
return false;
}
return llms()->assets->enqueue_script( 'llms-admin-wizard' ) && llms()->assets->enqueue_style( 'llms-admin-wizard' );
}
/**
* Retrieve the redirect URL at the conclusion of the wizard.
*
* @since 7.4.0
*
* @param int[] $course_ids WP_Post IDs of the course(s) generated during the import.
* @return string
*/
abstract protected function get_completed_url( array $course_ids ): string;
/**
* Retrieve the current step and default to the intro.
*
* @since 7.4.0
*
* @return string
*/
public function get_current_step(): string {
$step_keys = array_keys( $this->get_steps() );
$step = llms_filter_input_sanitize_string( INPUT_GET, 'step' );
return $step ?? $step_keys[0] ?? '';
}
/**
* Get slug if next step.
*
* @since 7.4.0
*
* @param string|bool $step Step to use as current.
* @return string|bool
*/
public function get_next_step( string $step = null ) {
$step = $step ?? $this->get_current_step();
$keys = array_keys( $this->get_steps() );
$i = array_search( $step, $keys, true );
// Next step doesn't exist or the next step would be greater than the index of the last step.
if ( false === $i || $i + 1 >= count( $keys ) ) {
return false;
}
return $keys[ ++$i ] ?? false;
}
/**
* Get slug if prev step.
*
* @since 7.4.0
*
* @param string|bool $step Step to use as current.
* @return string|bool
*/
public function get_prev_step( string $step = null ) {
$step = $step ?? $this->get_current_step();
$keys = array_keys( $this->get_steps() );
$i = array_search( $step, $keys, true );
if ( false === $i || $i - 1 < 0 ) {
return false;
}
return $keys[ $i - 1 ] ?? false;
}
/**
* Get the text to display on the "save" buttons.
*
* @since 7.4.0
*
* @param string $step Step to get text for.
* @return string The translated text.
*/
private function get_save_text( string $step ): string {
/**
* Filter the Save button text for a given step in the setup wizard.
*
* The first dynamic portion of this hook, `$this->id`, refers to the type of wizard being displayed.
*
* The second dynamic portion of this hook, `$step`, refers to the slug of the current step.
*
* @since 7.4.0
*
* @param string $text Button text string.
*/
$text = apply_filters(
"llms_{$this->id}_wizard_get_{$step}_save_text",
$this->get_steps()[ $step ]['save'] ?? __( 'Save & Continue', 'lifterlms' )
);
return esc_html( $text );
}
/**
* Get the text to display on the "skip" buttons.
*
* @since 7.4.0
*
* @param string $step Step to get text for.
* @return string Translated text.
*/
private function get_skip_text( string $step ): string {
/**
* Filter the skip button text for a given step in the setup wizard.
*
* The first dynamic portion of this hook, `$this->id`, refers to the type of wizard being displayed.
*
* The second dynamic portion of this hook, `$step`, refers to the slug of the current step.
*
* @since 7.4.0
*
* @param string $text Button text string.
*/
$text = apply_filters(
"llms_{$this->id}_wizard_get_{$step}_skip_text",
$this->get_steps()[ $step ]['skip'] ?? __( 'Skip this step', 'lifterlms' )
);
return esc_html( $text );
}
/**
* Get the URL to a step.
*
* @since 7.4.0
*
* @param string $step Step slug.
* @return string
*/
protected function get_step_url( string $step ): string {
$args = array(
'page' => 'llms-' . $this->id,
'step' => $step,
);
return add_query_arg( $args, admin_url() );
}
/**
* Get an array of step slugs => titles.
*
* @since 7.4.0
*
* @return array
*/
public function get_steps(): array {
/**
* Filter the steps included in the setup wizard.
*
* The dynamic portion of this hook, `$this->id`, refers to the type of wizard being displayed.
*
* @since 7.4.0
*
* @param string[] $steps Array of setup wizard steps. The array key is the slug/id of the step and the array value
* is the step's title displayed in the wizard's navigation.
*/
return apply_filters( "llms_{$this->id}_wizard_steps", $this->steps );
}
/**
* Output the HTML content of the setup page.
*
* @since 7.4.0
*
* @return void
*/
public function output(): void {
$views_dir = trailingslashit( esc_attr( $this->views_dir ) );
$step_html = '';
$steps = $this->get_steps();
$current = $this->get_current_step() ?? 'intro';
$prev = $this->get_prev_step();
$next = $this->get_next_step();
$transient = $this->get_transient();
if ( in_array( $current, array_keys( $steps ), true ) ) {
ob_start();
include $views_dir . 'step-' . $current . '.php';
$step_html = ob_get_clean();
}
/**
* Filter the HTML of a step within the setup wizard.
*
* The first dynamic portion of this hook, `$this->id`, refers to the type of wizard being displayed.
*
* The second dynamic portion of this hook, `$current`, refers to the slug of the current step.
*
* This filter can be used to output the HTML for a custom step in the setup wizard.
*
* @since 7.4.0
*
* @param string $step_html HTML of the step.
* @param LLMS_Admin_Setup_Wizard $wizard Setup wizard class instance.
*/
$step_html = apply_filters( "llms_{$this->id}_wizard_{$current}_html", $step_html, $this );
include $views_dir . 'main.php';
}
/**
* Handle saving data during setup.
*
* @since 7.4.0
*
* @throws Exception If the current user does not have permission to save data.
*
* @return null|WP_Error
*/
public function save(): ?WP_Error {
$nonce = "llms_{$this->id}_nonce";
$action = "llms_{$this->id}_save";
if ( ! isset( $_POST[ $nonce ] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST[ $nonce ] ) ), $action ) || ! current_user_can( 'manage_lifterlms' ) ) {
return null;
}
$response = new WP_Error( "llms-{$this->id}-save-invalid", esc_html__( 'There was an error saving your data, please try again.', 'lifterlms' ) );
$step = llms_filter_input( INPUT_POST, $action );
if ( method_exists( $this, 'save_' . $step ) ) {
$response = $this->{"save_{$step}"}();
}
if ( is_wp_error( $response ) ) {
$this->error = $response;
return $response;
}
if ( ! is_array( $response ) ) {
$response = array( $response );
}
$url = ( 'finish' === $step ) ? $this->get_completed_url( $response ) : $this->get_step_url( $this->get_next_step() );
llms_redirect_and_exit( $url );
return null;
}
/**
* Returns wizard transient if set.
*
* @since 7.4.0
*
* @return array
*/
protected function get_transient(): array {
return array();
}
}
================================================
FILE: includes/abstracts/llms-abstract-controller-user-engagements.php
================================================
<?php
/**
* LLMS_Abstract_Controller_User_Engagements class
*
* @package LifterLMS/Abstracts/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Base class that handles awarded user engagements (achievements and certificates).
*
* @since 6.0.0
*/
abstract class LLMS_Abstract_Controller_User_Engagements {
use LLMS_Trait_User_Engagement_Type;
/**
* A text type for a sync operation error message when the user can not edit an awarded engagement.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_AWARDED_ENGAGEMENT_INSUFFICIENT_PERMISSIONS = 0;
/**
* A text type for a sync operation error message about an awarded engagement not having a valid engagement template.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_AWARDED_ENGAGEMENT_INVALID_TEMPLATE = 1;
/**
* A text type for a sync operation error message about the user not being able to edit awarded engagements.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_AWARDED_ENGAGEMENTS_INSUFFICIENT_PERMISSIONS = 2;
/**
* A text type for a sync operation error message about an invalid nonce.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_AWARDED_ENGAGEMENTS_INVALID_NONCE = 3;
/**
* A text type for a sync operation error message about a missing awarded engagement ID.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_MISSING_AWARDED_ENGAGEMENT_ID = 4;
/**
* A text type for a sync operation error message about a missing engagement template ID.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_MISSING_ENGAGEMENT_TEMPLATE_ID = 5;
/**
* Constructor.
*
* @since 6.0.0
*
* @return void
*/
public function __construct() {
add_action( 'init', array( $this, 'maybe_handle_awarded_engagement_sync_actions' ) );
}
/**
* Delete an awarded user engagement.
*
* @since 3.18.0
* @since 6.0.0 Permanently delete user engagement via wp_delete_post().
* Refactored from LLMS_Controller_Achievements::delete() and LLMS_Controller_Certificates::delete().
*
* @param int $post_id WP Post ID of the awarded engagement.
* @return void
*/
protected function delete( $post_id ) {
// Only allow LLMS admins to delete. is_admin() check also makes sure call is made from the dashboard.
if ( ! is_admin() || ! current_user_can( 'manage_lifterlms' ) ) {
return;
}
$post = get_post( $post_id );
if ( ! $post || ! in_array( $post->post_type, array( 'llms_my_achievement', 'llms_my_certificate' ), true ) ) {
return;
}
wp_delete_post( $post_id, true );
}
/**
* Returns a translated text of the given type.
*
* @since 6.0.0
*
* @param int $text_type One of the LLMS_Abstract_Controller_User_Engagements::TEXT_ constants.
* @param array $variables Optional variables that are used in sprintf().
* @return string
*/
protected function get_text( $text_type, $variables = array() ) {
return __( 'Invalid text type.', 'lifterlms' );
}
/**
* Handle awarded engagement sync actions.
*
* Errors are added to {@see LLMS_Admin_Metabox::add_error()} to be displayed as an admin notice
* and also returned for unit tests.
*
* If the sync is successful, the {@see llms_redirect_and_exit()} function is called and this method does not return.
*
* @since 6.0.0
*
* @return null|WP_Error
*/
public function maybe_handle_awarded_engagement_sync_actions() {
// Validate action.
// Invalid actions return a WP_Error for testing purposes and are not displayed to the user.
$actions = array(
'sync_one' => "sync_awarded_{$this->engagement_type}",
'sync_many' => "sync_awarded_{$this->engagement_type}s",
);
$action = llms_filter_input( INPUT_GET, 'action' );
if ( ! $action ) {
return new WP_Error(
"llms-sync-awarded-{$this->engagement_type}s-missing-action",
__( 'Sorry, you have not provided any actions.', 'lifterlms' )
);
} elseif ( ! in_array( $action, $actions, true ) ) {
return new WP_Error(
"llms-sync-awarded-{$this->engagement_type}s-invalid-action",
__( "You're trying to perform an invalid action.", 'lifterlms' )
);
}
// Verify nonce.
$nonce_field = "_llms_{$this->engagement_type}_sync_actions_nonce";
if ( ! isset( $_REQUEST[ $nonce_field ] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST[ $nonce_field ] ) ), "llms-{$this->engagement_type}-sync-actions" ) ) {
$result = new WP_Error(
"llms-sync-awarded-{$this->engagement_type}s-invalid-nonce",
$this->get_text( self::TEXT_SYNC_AWARDED_ENGAGEMENTS_INVALID_NONCE )
);
( new LLMS_Meta_Box_Award_Engagement_Submit() )->add_error( $result );
return $result;
}
$engagement_id = llms_filter_input( INPUT_GET, 'post', FILTER_SANITIZE_NUMBER_INT );
$is_syncing_one = $action === $actions['sync_one'];
if ( empty( $engagement_id ) ) {
if ( $is_syncing_one ) {
$code = "llms-sync-missing-awarded-{$this->engagement_type}-id";
$message = $this->get_text( self::TEXT_SYNC_MISSING_AWARDED_ENGAGEMENT_ID );
} else {
$code = "llms-sync-missing-{$this->engagement_type}-template-id";
$message = $this->get_text( self::TEXT_SYNC_MISSING_ENGAGEMENT_TEMPLATE_ID );
}
$result = new WP_Error( $code, $message );
} elseif ( $is_syncing_one ) {
$result = $this->sync_awarded_engagement( $engagement_id );
} else {
$result = $this->sync_awarded_engagements( $engagement_id );
}
if ( is_wp_error( $result ) ) {
( new LLMS_Meta_Box_Award_Engagement_Submit() )->add_error( $result );
}
return $result;
}
/**
* Sync an awarded engagement with its template.
*
* If the sync is successful, the {@see llms_redirect_and_exit()} function is called and this method does not return.
*
* @since 6.0.0
*
* @param int $engagement_id Awarded engagement id.
* @return void|WP_Error
*/
private function sync_awarded_engagement( $engagement_id ) {
if ( ! current_user_can( 'edit_post', $engagement_id ) ) {
$variables = compact( 'engagement_id' );
return new WP_Error(
"llms-sync-awarded-{$this->engagement_type}-insufficient-permissions",
$this->get_text( self::TEXT_SYNC_AWARDED_ENGAGEMENT_INSUFFICIENT_PERMISSIONS, $variables ),
$variables
);
}
$sync = $this->get_user_engagement( $engagement_id, true )->sync();
if ( ! $sync ) {
$variables = compact( 'engagement_id' );
return new WP_Error(
"llms-sync-awarded-{$this->engagement_type}-invalid-template",
$this->get_text( self::TEXT_SYNC_AWARDED_ENGAGEMENT_INVALID_TEMPLATE, $variables ),
$variables
);
}
$redirect_url = get_edit_post_link( $engagement_id, 'raw' );
$redirect_url = add_query_arg( 'message', 1, $redirect_url );
llms_redirect_and_exit( $redirect_url );
}
/**
* Sync all the awarded engagements with their template.
*
* If the preflight checks are successful, the {@see llms_redirect_and_exit()} function is called after the sync is
* triggered and this method does not return.
*
* @since 6.0.0
*
* @param int $user_engagement_template_id User engagement template ID.
* @return void|WP_Error
*/
private function sync_awarded_engagements( $user_engagement_template_id ) {
if ( ! current_user_can( get_post_type_object( "llms_my_{$this->engagement_type}" )->cap->edit_posts ) ) {
return new WP_Error(
"llms-sync-awarded-{$this->engagement_type}s-insufficient-permissions",
$this->get_text( self::TEXT_SYNC_AWARDED_ENGAGEMENTS_INSUFFICIENT_PERMISSIONS )
);
}
/**
* Fires an action to trigger the bulk sync of awarded engagements.
*
* The dynamic portion of this hook, `{$this->engagement_type}`, refers to the type of awarded engagement,
* either "achievement" or "certificate".
*
* @since 6.0.0
*
* @see LLMS_Processor_Certificate_Sync.
*
* @param int $user_engagement_template_id The user engagement template post ID.
*/
do_action( "llms_do_awarded_{$this->engagement_type}s_bulk_sync", $user_engagement_template_id );
if ( empty( $_SERVER['HTTP_REFERER'] ) ) {
llms_redirect_and_exit( get_edit_post_link( $user_engagement_template_id, 'raw' ) );
} else {
llms_redirect_and_exit( sanitize_text_field( wp_unslash( $_SERVER['HTTP_REFERER'] ) ) );
}
}
}
================================================
FILE: includes/abstracts/llms-abstract-email-provider.php
================================================
<?php
/**
* Base class used by email delivery provider "connector" classes
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.40.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Abstract_Email_Provider
*
* @since 3.40.0
* @since 6.0.0 Removed the deprecated `LLMS_Abstract_Email_Provider::output_css()` method.
*/
abstract class LLMS_Abstract_Email_Provider {
/**
* Connector's ID.
*
* @var string
*/
protected $id = '';
/**
* Array of supported providers.
*
* @var array
*/
protected $providers = array(
'mailhawk',
'sendwp',
);
/**
* Configures the response returned when `do_remote_install()` is successful.
*
* @since 3.40.0
*
* @return array
*/
abstract protected function do_remote_install_success();
/**
* Retrieve the settings area HTML for the connect button
*
* @since 3.40.0
*
* @return string
*/
abstract protected function get_connect_setting();
/**
* Retrieve description text to be used in the settings area.
*
* @since 3.40.0
*
* @return string
*/
abstract protected function get_description();
/**
* Retrieve the connector's name / title.
*
* @since 3.40.0
*
* @return string
*/
abstract protected function get_title();
/**
* Determines if connector plugin is connected for sending.
*
* @since 3.40.0
*
* @return boolean
*/
abstract protected function is_connected();
/**
* Determines if connector plugin is installed
*
* @since 3.40.0
*
* @return boolean
*/
abstract protected function is_installed();
/**
* Constructor.
*
* @since 3.40.0
*
* @return void
*/
public function __construct() {
/**
* Filter the available email providers
*
* @since 3.40.0
*
* @param string[] $this->providers List of email provider ids.
*/
$this->providers = apply_filters( 'llms_email_delivery_providers', $this->providers );
/**
* Dynamically adjust the priority.
*
* A "connected" provider will always load first, ensuring
* that it can disable the other providers.
*
* When no providers are connected, they'll all load at 10
* and display in alphabetical order as a result of the order
* the files are included.
*/
$priority = $this->is_connected() ? 5 : 10;
add_action( 'admin_init', array( $this, 'init' ), $priority );
}
/**
* Initialize the Connector
*
* @since 3.40.0
*
* @return void
*/
public function init() {
// Disable other email delivery services if the current connector is already connected.
if ( $this->is_connected() ) {
$this->disable_other_providers();
}
/**
* Disable the Connector class and settings
*
* The dynamic portion of this filter, `{$this->id}`, refers
* to the id of the email provider. See `$this->providers` for a list of supported providers.
*
* @since 3.40.0
*
* @param bool $disabled Whether or not this class is disabled.
*/
if ( apply_filters( "llms_disable_{$this->id}", false ) ) {
return;
}
add_filter( 'llms_email_delivery_services', array( $this, 'add_settings' ) );
add_action( 'wp_ajax_llms_' . $this->id . '_remote_install', array( $this, 'ajax_callback_remote_install' ) );
add_action( 'wp_ajax_llms_' . $this->id . '_remote_install_verify', array( $this, 'ajax_callback_remote_install_verify' ) );
add_action( 'admin_print_footer_scripts', array( $this, 'output_js' ) );
}
/**
* Determines if the plugin is already installed and activates it if it is
*
* @since 3.40.0
*
* @return boolean|WP_Error `true` when plugin is installed and successfully activated.
* `WP_Error` when plugin is installed and there was an error activating it.
* `false` when plugin is not installed.
*/
protected function activate_already_installed_plugin() {
$is_plugin_installed = false;
foreach ( get_plugins() as $path => $details ) {
if ( false === strpos( $path, '/' . $this->id . '.php' ) ) {
continue;
}
$is_plugin_installed = true;
$activate = activate_plugin( $path );
if ( is_wp_error( $activate ) ) {
return $activate;
}
break;
}
return $is_plugin_installed;
}
/**
* Add Settings.
*
* @since 3.40.0
*
* @param array $settings Existing settings.
* @return array
*/
public function add_settings( $settings ) {
// Short circuit if missing authorization.
if ( ! current_user_can( 'install_plugins' ) ) {
return $settings;
}
$new_settings = array(
array(
'id' => $this->id . '_title',
'type' => 'subtitle',
'title' => $this->get_title(),
'desc' => $this->is_connected() ? '' : $this->get_description(),
),
array(
'id' => $this->id . '_connect',
'type' => 'custom-html',
'value' => $this->get_connect_setting(),
),
);
return array_merge( $settings, $new_settings );
}
/**
* Ajax callback for installing the connector's plugin.
*
* @since 3.40.0
*
* @return void
*/
public function ajax_callback_remote_install() {
$ret = $this->do_remote_install();
ob_clean();
wp_send_json( $ret, ! empty( $ret['status'] ) ? $ret['status'] : 200 );
}
/**
* Ajax callback called after doing the initial install, so the plugin is loaded and available.
*
* @since 8.0.0
*
* @return void
*/
public function ajax_callback_remote_install_verify() {
$ret = $this->do_remote_install_verify();
ob_clean();
wp_send_json( $ret, ! empty( $ret['status'] ) ? $ret['status'] : 200 );
}
/**
* Determines if the current user can perform the remote installation.
*
* @since 3.40.0
*
* @return true|array
*/
protected function can_remote_install() {
$nonce_field = '_llms_' . $this->id . '_nonce';
if ( ! isset( $_REQUEST[ $nonce_field ] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST[ $nonce_field ] ) ), 'llms-' . $this->id . '-install' ) ) {
return array(
'code' => 'llms_' . $this->id . '_install_nonce_failure',
'message' => esc_html__( 'Security check failed.', 'lifterlms' ),
'status' => 401,
);
} elseif ( ! current_user_can( 'install_plugins' ) ) {
return array(
'code' => 'llms_' . $this->id . '_install_unauthorized',
'message' => esc_html__( 'You do not have permission to perform this action.', 'lifterlms' ),
'status' => 403,
);
}
return true;
}
/**
* Automatically disables other providers when the current provider is connected.
*
* @since 3.40.0
*
* @return void.
*/
protected function disable_other_providers() {
$disable = array_diff( $this->providers, array( $this->id ) );
foreach ( $disable as $id ) {
add_filter( 'llms_disable_' . $id, '__return_true' );
}
}
/**
* Validate installation request and perform the plugin install or return errors.
*
* @since 3.40.0
*
* @return array
*/
protected function do_remote_install() {
$can_install = $this->can_remote_install();
if ( true !== $can_install ) {
return $can_install;
}
$install = $this->install();
if ( is_wp_error( $install ) ) {
return array(
'code' => $install->get_error_code(),
'message' => $install->get_error_message(),
'status' => 400,
);
}
return array( 'success' => true );
}
/**
* Verify the remote install, and then perform the post-install response. Otherwise the plugin isn't available yet.
*
* @return array
*/
protected function do_remote_install_verify() {
$ret = $this->do_remote_install();
if ( is_wp_error( $ret ) ) {
return $ret;
}
if ( ! $this->is_installed() ) {
return array(
'code' => 'llms_' . $this->id . '_not_found',
/* translators: %s: title of the email delivery plugin. */
'message' => sprintf( __( '%s plugin not found. Please try again.', 'lifterlms' ), $this->get_title() ),
'status' => 400,
);
}
return $this->do_remote_install_success();
}
/**
* Install the plugin via the WP plugin installer.
*
* @since 3.40.0
*
* @return boolean|WP_Error Error object or `true` when successful.
*/
protected function install() {
// Check if the plugin already exists and activate it if it is.
$ret = $this->activate_already_installed_plugin();
// Plugin doesn't exist, install it.
if ( false === $ret ) {
$ret = $this->install_plugin();
}
return $ret;
}
/**
* Install the plugin via the WP Plugin Repo.
*
* @since 3.40.0
*
* @return boolean|WP_Error `true` on success, error object otherwise.
*/
protected function install_plugin() {
include_once ABSPATH . 'wp-admin/includes/plugin-install.php';
include_once ABSPATH . 'wp-admin/includes/file.php';
include_once ABSPATH . 'wp-admin/includes/class-wp-upgrader.php';
// Use the WordPress Plugins API to get the plugin download link.
$api = plugins_api(
'plugin_information',
array(
'slug' => $this->id,
)
);
if ( is_wp_error( $api ) ) {
return $api;
}
// Use the AJAX upgrader skin to quietly install the plugin.
$upgrader = new Plugin_Upgrader( new WP_Ajax_Upgrader_Skin() );
$install = $upgrader->install( $api->download_link );
if ( is_wp_error( $install ) ) {
return $install;
}
$activate = activate_plugin( $upgrader->plugin_info() );
if ( is_wp_error( $activate ) ) {
return $activate;
}
return true;
}
/**
* Determine if inline scripts and styles should be output.
*
* @since 3.40.0
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return bool
*/
protected function should_output_inline() {
// Short circuit if unauthorized.
if ( ! current_user_can( 'install_plugins' ) ) {
return false;
}
$screen = get_current_screen();
return ( 'lifterlms_page_llms-settings' === $screen->id && 'engagements' === llms_filter_input( INPUT_GET, 'tab' ) && ! $this->is_connected() );
}
}
================================================
FILE: includes/abstracts/llms-abstract-generator-posts.php
================================================
<?php
/**
* Generate LMS Content from export files or raw arrays of data.
*
* @package LifterLMS/Abstracts/Classes
*
* @since 4.7.0
* @version 7.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Abstract_Generator_Posts class.
*
* Many methods in this class were moved from `LLMS_Generator`. The move has been
* noted on these methods and their preexisting changelogs have been preserved.
*
* @since 4.7.0
* @since 6.0.0 Removed the deprecated `LLMS_Abstract_Generator_Posts::increment()` method.
*/
abstract class LLMS_Abstract_Generator_Posts {
/**
* Exception code: WP_Post creation error
*
* @var int
*/
const ERROR_CREATE_POST = 1000;
/**
* Exception code: WP_Term creation error
*
* @var int
*/
const ERROR_CREATE_TERM = 1001;
/**
* Exception code: WP_User creation error
*
* @var int
*/
const ERROR_CREATE_USER = 1002;
/**
* Exception code: Requested LLMS_Post_Model subclass does not exist.
*
* @var int
*/
const ERROR_INVALID_POST = 1100;
/**
* Default post status when status isn't set in $raw for a given post
*
* @var string
*/
private $default_post_status = 'draft';
/**
* Array of images that have been sideloaded during generation
*
* Each array key will be the original source URL and the array value will be the new
* attachment post ID of the image that has been sideloaded into the current site.
*
* This array is checked prior to sideloading an image to ensure that if the same image is
* used multiple times throughout an import, the image is only sideloaded a single time.
*
* @var array
*/
protected $images = array();
/**
* Array of reusable blocks that have been imported during generation
*
* Each array key will be the original block ID and the array value will be the new
* block ID.
*
* This array is checked prior to importing a reusable block to ensure that if the same
* block is used multiple times throughout an import, it will only be imported once.
*
* @var array
*/
protected $reusable_blocks = array();
/**
* Associate raw tempids with actual created ids
*
* @var array
*/
protected $tempids = array();
/**
* Construct a new generator instance with data
*
* @since 4.7.0
*
* @return void
*/
public function __construct() {
// Load deps.
$this->load_dependencies();
}
/**
* Add custom data to a post based on the 'custom' array
*
* @since 3.16.11
* @since 3.28.3 Add extra slashes around JSON strings.
* @since 3.30.2 Skip JSON evaluation for non-string values; make publicly accessible.
* @since 4.7.0 Moved from `LLMS_Generator`.
*
* @param int $post_id WP Post ID.
* @param array $raw Raw data.
* @return void
*/
public function add_custom_values( $post_id, $raw ) {
// No custom data, return early.
if ( empty( $raw['custom'] ) ) {
return;
}
foreach ( $raw['custom'] as $custom_key => $custom_vals ) {
foreach ( $custom_vals as $val ) {
$this->add_custom_value( $post_id, $custom_key, $val );
}
}
}
/**
* Add a "custom" post meta data for a given post
*
* Automatically slashes JSON data when supplied.
*
* Automatically unserializes serialized data so `add_post_meta()` can re-serialize.
*
* @since 4.7.0
*
* @param int $post_id WP_Post ID.
* @param string $key Meta key.
* @param mixed $val Meta value.
* @return void
*/
protected function add_custom_value( $post_id, $key, $val ) {
// If $val is a JSON string, add slashes before saving.
if ( is_string( $val ) && null !== json_decode( $val, true ) ) {
$val = wp_slash( $val );
}
add_post_meta( $post_id, $key, maybe_unserialize( $val ) );
}
/**
* Generate a new LLMS_Post_Model.
*
* @since 4.7.0
* @since 4.7.1 Set the post's excerpt during the initial insert instead of during metadata updates after creation.
* @since 7.3.0 Skip adding the `generated_from_id` meta from the original post: this is the case when cloning a cloned post.
* Also skip creating revisions.
*
* @param string $type The LLMS_Post_Model post type type. For example "course" for an `LLMS_Course` or `membership` for `LLMS_Membership`.
* @param array $raw Array of raw, used to create the post.
* @param int $author_id Fallback author ID, used when now author data can be found in `$raw`.
* @return LLMS_Post_Model
*
* @throws Exception When the class identified by `$type` is not found or when an error is encountered during post creation.
*/
protected function create_post( $type, $raw = array(), $author_id = null ) {
$class_name = sprintf( 'LLMS_%s', implode( '_', array_map( 'ucfirst', explode( '_', $type ) ) ) );
if ( ! class_exists( $class_name ) ) {
/* translators: %s: Name of class. */
throw new Exception( esc_html( sprintf( __( 'The class "%s" does not exist.', 'lifterlms' ), $class_name ) ), intval( self::ERROR_INVALID_POST ) );
}
// Don't create useless revision on "cloning".
add_filter( 'wp_revisions_to_keep', '__return_zero', 999 );
// Insert the object.
$post = new $class_name(
'new',
/**
* Filter the data used to generate a new post.
*
* @since 7.4.0
*
* @param array $new_post_data New post data array.
* @param array $raw Original raw post data array.
*/
apply_filters(
'llms_generator_new_post_data',
array(
'post_author' => $this->get_author_id_from_raw( $raw, $author_id ),
'post_content' => isset( $raw['content'] ) ? $raw['content'] : '',
'post_date' => isset( $raw['date'] ) ? $this->format_date( $raw['date'] ) : null,
'post_excerpt' => isset( $raw['excerpt'] ) ? $raw['excerpt'] : '',
'post_modified' => isset( $raw['modified'] ) ? $this->format_date( $raw['modified'] ) : null,
'post_status' => isset( $raw['status'] ) ? $raw['status'] : $this->get_default_post_status(),
'post_title' => $raw['title'],
),
$raw
)
);
if ( ! $post->get( 'id' ) ) {
// Translators: %s = post type name.
throw new Exception( esc_html( sprintf( __( 'Error creating the %s post object.', 'lifterlms' ), $type ) ), intval( self::ERROR_CREATE_POST ) );
}
// Store the temp id if it exists.
$this->store_temp_id( $raw, $post );
// Don't set these values again.
unset( $raw['id'], $raw['author'], $raw['content'], $raw['date'], $raw['excerpt'], $raw['modified'], $raw['name'], $raw['status'], $raw['title'] );
/**
* Skip adding the `generated_from_id` meta from the original post:
* this is the case when cloning a cloned post.
*/
unset( $raw['custom'][ $post->get( 'meta_prefix' ) . 'generated_from_id' ] );
$this->set_metadata( $post, $raw );
$this->set_featured_image( $raw, $post->get( 'id' ) );
$this->add_custom_values( $post->get( 'id' ), $raw );
$this->sideload_images( $post, $raw );
$this->handle_reusable_blocks( $post, $raw );
// Remove revision prevention.
remove_filter( 'wp_revisions_to_keep', '__return_zero', 999 );
return $post;
}
/**
* Creates a reusable block
*
* @since 4.7.0
*
* @param int $block_id WP_Post ID of the block being imported. This will be the ID as found on the original site.
* @param array $block {
* Array of block data.
*
* @type string $title Title of the reusable block.
* @type string $content Content of the reusable block.
* }
* @return bool|int The WP_Post ID of the new block on success or `false` on error.
*/
protected function create_reusable_block( $block_id, $block ) {
$block_id = absint( $block_id );
// Check if the block was previously imported.
$id = empty( $this->reusable_blocks[ $block_id ] ) ? false : $this->reusable_blocks[ $block_id ];
if ( ! $id ) {
// If the block already exists, don't create it again.
$existing = get_post( $block_id );
if ( $existing && 'wp_block' === $existing->post_type && $block['title'] === $existing->post_title && $block['content'] === $existing->post_content ) {
return false;
}
$id = $this->insert_resuable_block( $block_id, $block );
}
// Don't return 0 if `wp_insert_post()` fails.
return $id ? $id : false;
}
/**
* Create a new WP_User from raw data
*
* @since 4.7.0
*
* @param array $raw Raw data.
* @return int|WP_Error WP_User ID on success or error on failure.
*/
protected function create_user( $raw ) {
/**
* Filter the default role used to create a new user during generator imports
*
* This role is used a role isn't supplied in the raw data.
*
* @since 4.7.0
*
* @param string $role WP_User role. Default role is 'administrator'.
* @param array $raw Original raw author data.
*/
$raw['role'] = empty( $raw['role'] ) ? apply_filters( 'llms_generator_new_user_default_role', 'administrator', $raw ) : $raw['role'];
$data = array(
'role' => $raw['role'],
'user_email' => $raw['email'],
'user_login' => LLMS_Person_Handler::generate_username( $raw['email'] ),
'user_pass' => wp_generate_password(),
);
if ( isset( $raw['first_name'] ) && isset( $raw['last_name'] ) ) {
$data['display_name'] = $raw['first_name'] . ' ' . $raw['last_name'];
$data['first_name'] = $raw['first_name'];
$data['last_name'] = $raw['last_name'];
}
if ( isset( $raw['description'] ) ) {
$data['description'] = $raw['description'];
}
/**
* Filter user data used to create a new user during generator imports
*
* @since Unknown
*
* @param array $data Prepared user data to be passed to `wp_insert_user()`.
* @param array $raw Original raw author data.
*/
$data = apply_filters( 'llms_generator_new_author_data', $data, $raw );
$author_id = wp_insert_user( $data );
if ( ! is_wp_error( $author_id ) ) {
/**
* Action fired after creation of a new user during generation
*
* @since 4.7.0
*
* @param int $author_id WP_User ID.
* @param array $data User creation data passed to `wp_insert_user()`.
* @param array $raw Original raw author data.
*/
do_action( 'llms_generator_new_user', $author_id, $data, $raw );
}
return $author_id;
}
/**
* Ensure raw dates are correctly formatted to create a post date
*
* Falls back to current date if no date is supplied.
*
* @since 3.3.0
* @since 3.30.2 Made publicly accessible.
* @since 4.7.0 Use `llms_current_time()` in favor of `current_time()`.
*
* @param string $raw_date Raw date from raw object.
* @return string
*/
public function format_date( $raw_date = null ) {
if ( ! $raw_date ) {
return llms_current_time( 'mysql' );
}
return date( 'Y-m-d H:i:s', strtotime( $raw_date ) );
}
/**
* Accepts raw author data and locates an existing author by email or id or creates one
*
* @since 3.3.0
* @since 4.3.3 Use strict string comparator.
* @since 4.7.0 Moved from `LLMS_Generator` and made `protected` instead of `private`.
*
* @param array $raw Author data.
* If id and email are provided will use id only if it matches the email for user matching that id in the database.
* If no id found, attempts to locate by email.
* If no author found and email provided, creates new user using email.
* Falls back to current user id.
* First_name, last_name, and description can be optionally provided.
* When provided will be used only when creating a new user.
* @return int WP_User ID
*
* @throws Exception When an error is encountered creating a new user.
*/
protected function get_author_id( $raw ) {
$author_id = 0;
// If raw is missing an ID and Email, use current user id.
if ( ! isset( $raw['id'] ) && ! isset( $raw['email'] ) ) {
$author_id = get_current_user_id();
} else {
// If id is set, check if the id matches a user in the DB.
if ( isset( $raw['id'] ) && is_numeric( $raw['id'] ) ) {
$user = get_user_by( 'ID', $raw['id'] );
// User exists.
if ( $user ) {
// We have a raw email.
if ( isset( $raw['email'] ) ) {
// Raw email matches found user's email.
if ( $user->user_email === $raw['email'] ) {
$author_id = $user->ID;
}
} else {
$author_id = $user->ID;
}
}
}
if ( ! $author_id ) {
if ( isset( $raw['email'] ) ) {
// See if we have a user that matches by email.
$user = get_user_by( 'email', $raw['email'] );
// User exists, use this user.
if ( $user ) {
$author_id = $user->ID;
}
}
}
// No author id, create a new one using the email.
if ( ! $author_id && isset( $raw['email'] ) ) {
$author_id = $this->create_user( $raw );
if ( is_wp_error( $author_id ) ) {
throw new Exception( esc_html( $author_id->get_error_message() ), intval( self::ERROR_CREATE_USER ) );
}
}
}
/**
* Filter the author ID prior to it being used for the generation of new posts
*
* @since 4.7.0
*
* @param int $author_id WP_User ID of the author.
* @param array $raw Original raw author data.
*/
return apply_filters( 'llms_generator_get_author_id', $author_id, $raw );
}
/**
* Receives a raw array of course, plan, section, lesson, etc data and gets an author id
*
* Falls back to optionally supplied fallback id.
* Falls back to current user id.
*
* @since 3.3.0
* @since 3.30.2 Made publicly accessible.
* @since 4.7.0 Moved from `LLMS_Generators`.
*
* @param array $raw Raw data.
* @param int $fallback_author_id Optional. WP User ID. Default is `null`.
* If not supplied, if no author is set, the current user ID will be used.
* @return int|WP_Error
*/
public function get_author_id_from_raw( $raw, $fallback_author_id = null ) {
// If author is set, get the author id.
if ( isset( $raw['author'] ) ) {
$author_id = $this->get_author_id( $raw['author'] );
}
// Fallback to current user.
if ( empty( $author_id ) ) {
$author_id = ! empty( $fallback_author_id ) ? $fallback_author_id : get_current_user_id();
}
return $author_id;
}
/**
* Retrieve the default post status for the generated set of posts
*
* @since 3.7.3
* @since 3.30.2 Made publicly accessible.
* @since 4.7.0 Moved from `LLMS_Generators`.
*
* @return string
*/
public function get_default_post_status() {
/**
* Filter the default status used for generating posts
*
* @since 3.7.3
*
* @param string $post_status The default post status.
* @param LLMS_Generator $generator Generator instance.
*/
return apply_filters( 'llms_generator_default_post_status', $this->default_post_status, $this );
}
/**
* Get a WP Term ID for a term by taxonomy and term name
*
* Attempts to find a given term by name first to prevent duplicates during imports.
*
* @since 3.3.0
* @since 4.7.0 Moved from `LLMS_Generator` and updated method access from `private` to `protected`.
* Throws an exception in favor of returning `null` when an error is encountered.
*
* @param string $term_name Term name.
* @param string $tax Taxonomy slug.
* @return int The created WP_Term `term_id`.
*
* @throws Exception When an error is encountered during taxonomy term creation.
*/
protected function get_term_id( $term_name, $tax ) {
$term = get_term_by( 'name', $term_name, $tax, ARRAY_A );
// Not found, create it.
if ( ! $term ) {
$term = wp_insert_term( $term_name, $tax );
if ( is_wp_error( $term ) ) {
/* translators: %s: name of term. */
throw new Exception( esc_html( sprintf( __( 'Error creating new term "%s".', 'lifterlms' ), $term_name ) ), intval( self::ERROR_CREATE_TERM ) );
}
/**
* Triggered when a new term is generated during an import
*
* @since 4.7.0
*
* @param array $term Term information array from `wp_insert_term()`.
* @param string $tax Taxonomy name.
*/
do_action( 'llms_generator_new_term', $term, $tax );
}
return $term['term_id'];
}
/**
* Handle importing of reusable blocks stored in post content
*
* @since 4.7.0
*
* @param LLMS_Post_Model $post Instance of a post model.
* @param array $raw Array of raw data.
* @return null|bool Returns `null` when importing is disabled, `false` when there are no blocks to import, and `true` on success.
*/
protected function handle_reusable_blocks( $post, $raw ) {
// Importing blocks is disabled.
if ( ! $this->is_reusable_block_importing_enabled() ) {
return null;
}
// No blocks to import.
if ( empty( $raw['_extras']['blocks'] ) ) {
return false;
}
$find = array();
$replace = array();
foreach ( $raw['_extras']['blocks'] as $block_id => $block ) {
$new_id = $this->create_reusable_block( $block_id, $block );
if ( ! is_wp_error( $new_id ) && is_numeric( $new_id ) ) {
$find[] = sprintf( '<!-- wp:block {"ref":%d}', absint( $block_id ) );
$replace[] = sprintf( '<!-- wp:block {"ref":%d}', $new_id );
}
}
if ( $find && $replace ) {
$args = array(
'ID' => $post->get( 'id' ),
'post_content' => str_replace( $find, $replace, $post->get( 'content', true ) ),
);
return wp_update_post( $args ) ? true : false;
}
return false;
}
/**
* Insert a reusable block into the database
*
* @since 4.7.0
*
* @param int $block_id WP_Post ID of the block being imported. This will be the ID as found on the original site.
* @param array $block {
* Array of block data.
*
* @type string $title Title of the reusable block.
* @type string $content Content of the reusable block.
* }
* @return int WP_Post ID on success or `0 on error.
*/
protected function insert_resuable_block( $block_id, $block ) {
$id = wp_insert_post(
array(
'post_content' => $block['content'],
'post_title' => $block['title'],
'post_type' => 'wp_block',
'post_status' => 'publish',
)
);
if ( $id ) {
$this->reusable_blocks[ $block_id ] = $id;
/**
* Triggered when a new reusable block is created during an import
*
* @since 4.7.0
*
* @param int $id WP_Post ID of the block.
* @param array $block Array of block information from the import.
*/
do_action( 'llms_generator_new_reusable_block', $id, $block );
}
return $id;
}
/**
* Determines if image sideloading is enabled for the generator
*
* @since 4.7.0
*
* @return boolean If `true`, sideloading is enabled, otherwise sideloading is disabled.
*/
public function is_image_sideloading_enabled() {
/**
* Filter the status of image sideloading for the generator.
*
* @since 4.7.0
*
* @param boolean $enabled Whether or not sideloading is enabled.
* @param LLMS_Generator $generator Generator instance.
*/
return apply_filters( 'llms_generator_is_image_sideloading_enabled', true, $this );
}
/**
* Determines if reusable block importing is enabled generator
*
* @since 4.7.0
*
* @return boolean If `true`, importing is enabled, otherwise importing is disabled.
*/
public function is_reusable_block_importing_enabled() {
/**
* Filter the status of reusable block importing for the generator.
*
* @since 4.7.0
*
* @param boolean $enabled Whether or not block importing is enabled.
* @param LLMS_Generator $generator Generator instance.
*/
return apply_filters( 'llms_generator_is_reusable_block_importing_enabled', true, $this );
}
/**
* Load additional generator classes and other dependencies
*
* @since 4.7.0
*
* @return void
*/
protected function load_dependencies() {
// For featured image creation via `media_sideload_image()`.
require_once ABSPATH . 'wp-admin/includes/media.php';
require_once ABSPATH . 'wp-admin/includes/file.php';
require_once ABSPATH . 'wp-admin/includes/image.php';
}
/**
* Saves an image (from URL) to the media library and sets it as the featured image for a given post
*
* @since 3.3.0
* @since 4.7.0 Moved from `LLMS_Generator` and made `protected` instead of `private`.
* Add a return instead of `void`; Don't import if sideloading is disabled; Use `$this->sideload_image()` sideloading.
*
* @param string $url_or_raw Array of raw data or URL to an image.
* @param int $post_id WP Post ID.
* @return null|false|int Returns `null` if sideloading is disabled, WP Post ID of the attachment on success, `false` on error.
*/
protected function set_featured_image( $url_or_raw, $post_id ) {
// Sideloading is disabled.
if ( ! $this->is_image_sideloading_enabled() ) {
return null;
}
$image_url = ( is_array( $url_or_raw ) && ! empty( $url_or_raw['featured_image'] ) ) ? $url_or_raw['featured_image'] : $url_or_raw;
if ( $image_url && is_string( $image_url ) ) {
$id = $this->sideload_image( $post_id, $image_url, 'id' );
if ( ! is_wp_error( $id ) ) {
set_post_thumbnail( $post_id, $id );
return $id;
}
}
return false;
}
/**
* Configure the default post status for generated posts at runtime
*
* @since 3.7.3
*
* @param string $status Any valid WP Post Status.
* @return void
*/
public function set_default_post_status( $status ) {
$this->default_post_status = $status;
}
/**
* Set all metadata for a given post object
*
* This method will only set metadata for registered LLMS_Post_Model properties.
*
* @since 4.7.0
*
* @param LLMS_Post_Model $post An LLMS post object.
* @param array $raw Array of raw data.
* @return void
*/
protected function set_metadata( $post, $raw ) {
// Set all metadata.
foreach ( array_keys( $post->get_properties() ) as $key ) {
if ( isset( $raw[ $key ] ) ) {
$post->set( $key, $raw[ $key ] );
}
}
}
/**
* Sideload an image from a url
*
* @since 4.7.0
*
* @link https://developer.wordpress.org/reference/hooks/http_request_host_is_external/ If exporting from a local site and importing into another local site, images *will not* be side loaded as a result of this condition in the WP Core
*
* @param int $post_id WP_Post ID of the post where the image will be attached.
* @param string $url The image's URL.
* @return string|int|WP_Error Returns a WP_Error on failure, the image's new URL when `$return` is "src", otherwise returns the image's attachment ID.
*/
protected function sideload_image( $post_id, $url, $return = 'src' ) {
// Check if the image was previously sideloaded.
$id = empty( $this->images[ $url ] ) ? false : $this->images[ $url ];
// Image was not previously sideloaded.
if ( ! $id ) {
$id = media_sideload_image( $url, $post_id, null, 'id' );
if ( is_wp_error( $id ) ) {
return $id;
}
// Store the ID for future usage.
$this->images[ $url ] = $id;
}
return 'src' === $return ? wp_get_attachment_url( $id ) : $id;
}
/**
* Sideload images found in a given post
*
* This attempts to sideload the `src` attribute of every <img> element
* found in the `post_content` of the supplied post.
*
* @since 4.7.0
*
* @param LLMS_Post_Model $post Post object.
* @param array $raw Array of raw data.
* @return null|boolean Returns `true` on success, `false` if there were no images to update, or `null` if sideloading is disabled.
*/
protected function sideload_images( $post, $raw ) {
// Sideloading is disabled.
if ( ! $this->is_image_sideloading_enabled() ) {
return null;
}
// No images to sideload.
if ( empty( $raw['_extras']['images'] ) ) {
return false;
}
/**
* List of hostnames from which sideloading is explicitly disabled
*
* If the source url of an image is from a host in this list, the image will not be sideloaded
* during generation.
*
* By default the current site is included in the blocklist ensuring that images aren't
* sideloaded into the same site.
*
* @since 4.7.0
*
* @param string[] $blocked_hosts Array of hostnames.
*/
$blocked_hosts = apply_filters(
'llms_generator_sideload_hosts_blocklist',
array(
wp_parse_url( get_site_url(), PHP_URL_HOST ),
)
);
$post_id = $post->get( 'id' );
$find = array();
$replace = array();
foreach ( $raw['_extras']['images'] as $src ) {
// Don't sideload images from blocked hosts.
if ( in_array( wp_parse_url( $src, PHP_URL_HOST ), $blocked_hosts, true ) ) {
continue;
}
$new_src = $this->sideload_image( $post_id, $src );
if ( ! is_wp_error( $new_src ) ) {
$find[] = $src;
$replace[] = $new_src;
}
}
if ( $find && $replace ) {
$content = str_replace( $find, $replace, $post->get( 'content', true ) );
return $post->set( 'content', $content );
}
return false;
}
/**
* Accepts a raw object, finds the raw id and stores it
*
* @since 3.3.0
*
* @param array $raw Array of raw data.
* @param LLMS_Post_Model $obj The LLMS Post Object generated from the raw data.
* @return int|false Raw id when present or `false` if no raw id was found.
*/
protected function store_temp_id( $raw, $obj ) {
if ( empty( $raw['id'] ) ) {
return false;
}
// Ensure the object post type array exists.
if ( ! isset( $this->tempids[ $obj->get( 'type' ) ] ) ) {
$this->tempids[ $obj->get( 'type' ) ] = array();
}
// Store the id on the meta table.
$obj->set( 'generated_from_id', $raw['id'] );
// Store it in the object for prereq handling later.
$this->tempids[ $obj->get( 'type' ) ][ $raw['id'] ] = $obj->get( 'id' );
return $raw['id'];
}
}
================================================
FILE: includes/abstracts/llms-abstract-meta-box-user-engagement-sync.php
================================================
<?php
/**
* LLMS_Abstract_Meta_Box_User_Engagement_Sync class
*
* @package LifterLMS/Abstracts/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Base meta box class for syncing between awarded engagements (certificates or achievements) and templates.
*
* @since 6.0.0
*/
abstract class LLMS_Abstract_Meta_Box_User_Engagement_Sync extends LLMS_Admin_Metabox {
use LLMS_Trait_User_Engagement_Type;
/**
* A text type for a sync alert about many awarded engagements being synced to the current engagement template.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_ALERT_MANY_AWARDED_ENGAGEMENTS = 0;
/**
* A text type for a sync alert about one awarded engagement being synced to the current engagement template.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_ALERT_ONE_AWARDED_ENGAGEMENT = 1;
/**
* A text type for a sync alert about this awarded engagement being synced to its engagement template.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_ALERT_THIS_AWARDED_ENGAGEMENT = 2;
/**
* A text type for a sync description about many awarded engagements being synced to the current engagement template.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_DESCRIPTION_MANY_AWARDED_ENGAGEMENTS = 3;
/**
* A text type for a sync description about one awarded engagement being synced to the current engagement template.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_DESCRIPTION_ONE_AWARDED_ENGAGEMENT = 4;
/**
* A text type for a sync description about this awarded engagement being synced to its engagement template.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_DESCRIPTION_THIS_AWARDED_ENGAGEMENT = 5;
/**
* A text type for the content of a "sync awarded engagements" meta box when there are no awarded engagements to sync with.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_ENGAGEMENT_TEMPLATE_NO_AWARDED_ENGAGEMENTS = 6;
/**
* A text type for the title of a "sync awarded engagement" meta box.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_TITLE_AWARDED_ENGAGEMENT = 7;
/**
* A text type for the title of a "sync awarded engagements" meta box.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_TITLE_AWARDED_ENGAGEMENTS = 8;
/**
* The context to register the meta box with.
*
* Accepts anything that can be passed to WP core add_meta_box() function: 'normal', 'side', 'advanced'.
*
* @var string
*/
public $context = 'side';
/**
* If true, we are syncing all awarded engagements with their template,
* else we are syncing a single awarded engagement with its template.
*
* @since 6.0.0
*
* @var bool
*/
protected $is_current_post_a_template;
/**
* The post type of an awarded engagement, e.g. 'llms_my_achievement' or 'llms_my_certificate'.
*
* @since 6.0.0
*
* @var string
*/
protected $post_type_awarded;
/**
* The post type of an engagement template, e.g. 'llms_achievement' or 'llms_certificate'.
*
* @since 6.0.0
*
* @var string
*/
protected $post_type_template;
/**
* Configure the meta box settings.
*
* @since 6.0.0 Refactored from LLMS_Meta_Box_Award_Certificate_Sync::configure() and
* LLMS_Meta_Box_Certificate_Template_Sync::configure().
*
* @return void
*/
public function configure() {
// Try to load the post being edited.
if ( is_null( $this->post ) ) {
$this->post = get_post( llms_filter_input( INPUT_GET, 'post', FILTER_SANITIZE_NUMBER_INT ) );
}
// There is no need to configure this meta box if we're not editing an engagement template or awarded engagement.
if (
is_null( $this->post ) ||
! in_array( $this->post->post_type, array( $this->post_type_awarded, $this->post_type_template ), true )
) {
return;
}
$this->id = "{$this->engagement_type}_sync";
if ( $this->post->post_type === $this->post_type_template ) {
$this->is_current_post_a_template = true;
$this->title = $this->get_text( self::TEXT_SYNC_TITLE_AWARDED_ENGAGEMENTS );
} else {
$this->is_current_post_a_template = false;
$this->title = $this->get_text( self::TEXT_SYNC_TITLE_AWARDED_ENGAGEMENT );
}
}
/**
* Not used because our meta box doesn't use the standard fields API.
*
* @since 6.0.0 Refactored from LLMS_Meta_Box_Award_Certificate_Sync::get_fields() and
* LLMS_Meta_Box_Certificate_Template_Sync::get_fields().
*
* @return array
*/
public function get_fields() {
return array();
}
/**
* Returns the sync alert and sync description texts for the sync action button, or an empty array if the sync
* button should not be displayed.
*
* @since 6.0.0
*
* @return array
*/
private function get_sync_action_texts() {
if ( $this->is_current_post_a_template ) {
$awarded_number = $this->count_awarded_engagements( $this->post->ID );
if ( ! $awarded_number ) {
return array();
}
$variables = compact( 'awarded_number' );
if ( $awarded_number > 1 ) {
$sync_alert = $this->get_text( self::TEXT_SYNC_ALERT_MANY_AWARDED_ENGAGEMENTS, $variables );
$sync_description = $this->get_text( self::TEXT_SYNC_DESCRIPTION_MANY_AWARDED_ENGAGEMENTS, $variables );
} else {
$sync_alert = $this->get_text( self::TEXT_SYNC_ALERT_ONE_AWARDED_ENGAGEMENT, $variables );
$sync_description = $this->get_text( self::TEXT_SYNC_DESCRIPTION_ONE_AWARDED_ENGAGEMENT, $variables );
}
} else {
$awarded_model = $this->get_user_engagement( $this->post->ID, true );
$template_id = $awarded_model ? $awarded_model->get( 'parent' ) : false;
if ( empty( $template_id ) || ! $this->get_user_engagement( $template_id, false ) ) {
return array();
}
$sync_alert = $this->get_text( self::TEXT_SYNC_ALERT_THIS_AWARDED_ENGAGEMENT );
$sync_description = $this->get_text(
self::TEXT_SYNC_DESCRIPTION_THIS_AWARDED_ENGAGEMENT,
array( 'template_id' => $template_id )
);
}
return compact( 'sync_alert', 'sync_description' );
}
/**
* Returns a translated text of the given type.
*
* @since 6.0.0
*
* @param int $text_type One of the LLMS_Abstract_Meta_Box_User_Engagement_Sync::TEXT_ constants.
* @param array $variables Optional variables that are used in sprintf().
* @return string
*/
protected function get_text( $text_type, $variables = array() ) {
return __( 'Invalid text type.', 'lifterlms' );
}
/**
* Function to field WP::output() method call.
*
* @see LLMS_Admin_Metabox::register()
* @see do_meta_boxes()
*
* @since 6.0.0 Refactored from LLMS_Meta_Box_Award_Certificate_Sync::output() and
* LLMS_Meta_Box_Certificate_Template_Sync::output().
*
* @return void
*/
public function output() {
$sync_action = $this->sync_action();
// Output the HTML.
echo '<div class="llms-mb-container">';
do_action( 'llms_metabox_before_content', $this->id );
echo wp_kses( $sync_action, LLMS_ALLOWED_HTML_FORM_FIELDS );
do_action( 'llms_metabox_after_content', $this->id );
echo '</div>';
}
/**
* Returns the sync action description and button HTML for a meta box on an engagement template or an awarded engagement.
*
* @since 6.0.0
*
* @return string
*/
private function sync_action() {
$texts = $this->get_sync_action_texts();
if ( empty( $texts ) ) {
return $this->get_text( self::TEXT_SYNC_ENGAGEMENT_TEMPLATE_NO_AWARDED_ENGAGEMENTS );
}
$base_url = remove_query_arg( 'action' ); // Current URL without 'action' arg.
$sync_url = add_query_arg(
'action',
"sync_awarded_{$this->engagement_type}" . ( $this->is_current_post_a_template ? 's' : '' ),
wp_nonce_url(
$base_url,
"llms-{$this->engagement_type}-sync-actions",
"_llms_{$this->engagement_type}_sync_actions_nonce"
)
);
$sync_alert = str_replace( "'", "\'", $texts['sync_alert'] );
$button_label = __( 'Sync', 'lifterlms' );
ob_start();
?>
<p><?php echo wp_kses_post( $texts['sync_description'] ); ?></p>
<p style="text-align: right; margin: 1em 0;">
<a href="<?php echo esc_url( $sync_url ); ?>" class="llms-button-primary sync-action full small" onclick="return confirm('<?php echo esc_js( $sync_alert ); ?>')" style="box-sizing:border-box;"><?php echo wp_kses_post( $button_label ); ?></a>
</p>
<?php
return ob_get_clean();
}
}
================================================
FILE: includes/abstracts/llms-abstract-posts-query.php
================================================
<?php
/**
* LLMS_Abstract_Posts_Query class file.
*
* @package LifterLMS/Abstracts/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Abstract WP_Posts query class.
*
* This class is meant to perform custom queries that ultimately
* get passed into a `WP_Query`, ideally for a specific post type
* or list of post types.
*
* @since 6.0.0
*
* Valid query arguments
*
* {@see LLMS_Abstract_Query} for inherited query arguments.
*
* @param string $fields WP_Post fields to return for each result. Accepts "all", "ids", or "id=>parent". Default: "all".
* @param string[]|string $status Limit results by WP_Post `$post_status`. Default: "publish".
* @param string[] $post_types Limit results to the specified post type(s).
*/
abstract class LLMS_Abstract_Posts_Query extends LLMS_Abstract_Query {
/**
* Defines fields that can be sorted on via ORDER BY.
*
* @var string[]
*/
protected $allowed_sort_fields = array(
'ID',
'author',
'title',
'name',
'type',
'date',
'modified',
'parent',
'menu_order',
);
/**
* Specify the post types allowed to be queried by this class
*
* This array should be a list of one or more post type names.
*
* @var string[]
*/
protected $allowed_post_types = array();
/**
* The WP_Query instance.
*
* @var null
*/
protected $wp_query = null;
/**
* Set result counts and pagination properties.
*
* @since 6.0.0
*
* @return void
*/
protected function count_results() {
$this->number_results = $this->wp_query->post_count;
$this->found_results = $this->found_results();
$this->max_pages = (int) $this->wp_query->max_num_pages;
}
/**
* Retrieve query argument default values.
*
* @since 6.0.0
*
* @return array
*/
protected function default_arguments() {
return wp_parse_args(
array(
'fields' => 'all',
'status' => 'publish',
'post_types' => $this->allowed_post_types,
'sort' => array(
'date' => 'DESC',
'ID' => 'DESC',
),
),
parent::default_arguments()
);
}
/**
* Retrieve total found results for the query.
*
* @since 6.0.0
*
* @return int
*/
protected function found_results() {
return $this->wp_query->found_posts;
}
/**
* Map input arguments to WP_Query arguments.
*
* @since 6.0.0
*
* @return array
*/
protected function get_arg_map() {
return array(
'page' => 'paged',
'per_page' => 'posts_per_page',
'post_types' => 'post_type',
'search' => 's',
'sort' => 'orderby',
'status' => 'post_status',
);
}
/**
* Retrieve the WP_Query object for the query.
*
* @since 6.0.0
*
* @return WP_Query
*/
public function get_wp_query() {
return $this->wp_query;
}
/**
* Performs the query.
*
* @since 6.0.0
*
* @return WP_Post[]|int[] Array of results corresponding to the value specified in the `$fields` query argument.
*/
protected function perform_query() {
$this->wp_query = new WP_Query( $this->query );
return $this->wp_query->posts;
}
/**
* Prepare the query.
*
* Should return the query which will be used by `query()`.
*
* @since 6.0.0
*
* @return mixed
*/
protected function prepare_query() {
$map = $this->get_arg_map();
$args = array();
foreach ( $this->query_vars as $var => $val ) {
$var = array_key_exists( $var, $map ) ? $map[ $var ] : $var;
$args[ $var ] = $val;
}
return $args;
}
/**
* Sets a query variable.
*
* Overrides parent method to ensure only allowed post types can be queried.
*
* @since 6.0.0
*
* @param string $key Variable key.
* @param mixed $val Variable value.
* @return void
*/
public function set( $key, $val ) {
if ( 'post_types' === $key ) {
$val = $this->sanitize_post_types( $val );
}
parent::set( $key, $val );
}
/**
* Sanitize the `post_types` query argument.
*
* Any post types not explicitly included in the `$allowed_post_types` list are
* removed from the input.
*
* @since 6.0.0
*
* @param string[] $val Array of post types to query.
* @return string[] Cleaned array.
*/
protected function sanitize_post_types( $val ) {
if ( ! is_array( $val ) ) {
return array();
}
foreach ( $val as $index => $post_type ) {
if ( ! in_array( $post_type, $this->allowed_post_types, true ) ) {
unset( $val[ $index ] );
}
}
return array_values( $val );
}
}
================================================
FILE: includes/abstracts/llms-abstract-processor-user-engagement-sync.php
================================================
<?php
/**
* LLMS_Abstract_Processor_User_Engagement_Sync class
*
* @package LifterLMS/Abstracts/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Base processor class for syncing awarded engagements (certificates or achievements) to their engagement template.
*
* @since 6.0.0
*/
abstract class LLMS_Abstract_Processor_User_Engagement_Sync extends LLMS_Abstract_Processor {
use LLMS_Trait_User_Engagement_Type;
/**
* A text type for an admin notice that the sync of awarded engagements to an engagement template is already scheduled.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_NOTICE_ALREADY_SCHEDULED = 0;
/**
* A text type for an admin notice that the sync of awarded engagements to an engagement template is complete.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_NOTICE_AWARDED_ENGAGEMENTS_COMPLETE = 1;
/**
* A text type for an admin notice that there are no awarded engagements to sync the template with.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_NOTICE_NO_AWARDED_ENGAGEMENTS = 2;
/**
* A text type for an admin notice that the sync of awarded engagements to an engagement template is scheduled.
*
* @since 6.0.0
*
* @var int
*/
protected const TEXT_SYNC_NOTICE_SCHEDULED = 3;
/**
* Clear notices.
*
* @since 6.0.0
*
* @param int $engagement_template_id WP Post ID of the user engagement template.
* @return void
*/
private function clear_notices( $engagement_template_id ) {
$notices = array(
'awarded-%1$ss-sync-%2$d-scheduled',
'awarded-%1$ss-sync-%2$d-already-scheduled',
'awarded-%1$ss-sync-%2$d-done',
);
foreach ( $notices as $notice ) {
LLMS_Admin_Notices::delete_notice(
sprintf( $notice, $this->engagement_type, $engagement_template_id )
);
}
}
/**
* Action triggered to sync all the awarded engagements that need to be updated.
*
* @since 6.0.0
*
* @param int $engagement_template_id WP Post ID of the engagement template.
* @return void
*/
public function dispatch_sync( $engagement_template_id ) {
$this->log(
sprintf(
'awarded %1$ss bulk sync dispatched for the %1$s template %2$s (#%3$d)',
$this->engagement_type,
get_the_title( $engagement_template_id ),
$engagement_template_id
)
);
/**
* Filter the query arguments used when retrieving the awarded engagements to sync.
*
* The dynamic portion of the hook name,
* {@see LLMS_Abstract_Processor_User_Engagement_Sync::$engagement_type `$this->engagement_type`},
* refers to the engagement type, either 'achievement' or 'certificate'.
*
* @since 6.0.0
*
* @param array $args Query arguments passed to LLMS_Awards_Query.
*/
$args = apply_filters(
"llms_processor_sync_awarded_{$this->engagement_type}s_query_args",
array(
'templates' => $engagement_template_id,
'per_page' => 20,
'page' => 1,
'status' => array(
'publish',
'future',
),
'type' => $this->engagement_type,
)
);
$query = new LLMS_Awards_Query( $args );
if ( ! $query->get_found_results() ) {
return;
}
while ( $args['page'] <= $query->get_max_pages() ) {
$this->push_to_queue(
array(
'query_args' => $args,
)
);
$args['page'] ++;
}
// Save queue and dispatch the process.
$this->save()->dispatch();
}
/**
* Returns a translated text of the given type.
*
* @since 6.0.0
*
* @param int $text_type One of the LLMS_Abstract_Processor_User_Engagement_Sync::TEXT_ constants.
* @param array $variables Optional variables that are used in sprintf().
* @return string
*/
protected function get_text( $text_type, $variables = array() ) {
return __( 'Invalid text type.', 'lifterlms' );
}
/**
* Initializer.
*
* @since 6.0.0
*
* @return void
*/
protected function init() {
// For the cron.
add_action( $this->schedule_hook, array( $this, 'dispatch_sync' ), 10, 1 );
// For LifterLMS actions which trigger bulk enrollment.
$this->actions = array(
"llms_do_awarded_{$this->engagement_type}s_bulk_sync" => array(
'arguments' => 1,
/** @see LLMS_Abstract_Processor_User_Engagement_Sync::schedule_sync() */
'callback' => 'schedule_sync',
'priority' => 10,
),
);
}
/**
* Perform actions when the process is completed.
*
* @since 6.0.0
*
* @param array $args Array of processing data.
* @return void
*/
private function process_completed( $args ) {
$this->log(
sprintf(
'awarded %1$s bulk sync completed for the %1$s template %2$s (#%3$d)',
$this->engagement_type,
get_the_title( $args['query_args']['templates'] ),
$args['query_args']['templates']
)
);
$this->clear_notices( $args['query_args']['templates'] );
LLMS_Admin_Notices::add_notice(
sprintf( 'awarded-%1$ss-sync-%2$d-done', $this->engagement_type, $args['query_args']['templates'] ),
$this->get_text(
self::TEXT_SYNC_NOTICE_AWARDED_ENGAGEMENTS_COMPLETE,
array( 'engagement_template_id' => $args['query_args']['templates'] )
),
array(
'dismissible' => true,
'dismiss_for_days' => 0,
'type' => 'success',
)
);
}
/**
* Schedule sync.
*
* This will schedule an event that will setup the queue of items for the background process.
*
* @since 6.0.0
*
* @param int $engagement_template_id WP Post ID of the user engagement template.
* @return void
*/
public function schedule_sync( $engagement_template_id ) {
$this->log(
sprintf(
'awarded %1$ss bulk sync for the %1$s template %2$s (#%3$d)',
$this->engagement_type,
get_the_title( $engagement_template_id ),
$engagement_template_id
)
);
$this->clear_notices( $engagement_template_id );
$args = array( $engagement_template_id );
$awarded_count = $this->count_awarded_engagements( $engagement_template_id );
if ( 0 === $awarded_count ) {
$log_message = 'no awarded %1$ss to bulk sync with the %1$s template %2$s (#%3$d)';
$notice_message = $this->get_text( self::TEXT_SYNC_NOTICE_NO_AWARDED_ENGAGEMENTS, compact( 'engagement_template_id' ) );
$notice_id = 'awarded-%1$ss-sync-%2$d-no-awarded';
$notice_type = 'error';
} elseif ( wp_next_scheduled( $this->schedule_hook, $args ) ) {
$log_message = 'awarded %1$ss bulk sync already scheduled for the %1$s template %2$s (#%3$d)';
$notice_message = $this->get_text( self::TEXT_SYNC_NOTICE_ALREADY_SCHEDULED, compact( 'engagement_template_id' ) );
$notice_id = 'awarded-%1$ss-sync-%2$d-already-scheduled';
$notice_type = 'warning';
} else {
wp_schedule_single_event( time(), $this->schedule_hook, $args );
$log_message = 'awarded %1$ss bulk sync scheduled for the %1$s template %2$s (#%3$d)';
$notice_message = $this->get_text( self::TEXT_SYNC_NOTICE_SCHEDULED, compact( 'engagement_template_id' ) );
$notice_id = 'awarded-%1$ss-sync-%2$d-scheduled';
$notice_type = 'info';
}
$this->log(
sprintf(
$log_message,
$this->engagement_type,
get_the_title( $engagement_template_id ),
$engagement_template_id
)
);
LLMS_Admin_Notices::add_notice(
sprintf( $notice_id, $this->engagement_type, $engagement_template_id ),
$notice_message,
array(
'dismissible' => true,
'dismiss_for_days' => 0,
'type' => $notice_type,
)
);
}
/**
* Sync awarded engagements.
*
* @since 6.0.0
*
* @param LLMS_Abstract_User_Engagement[] $engagements Array of awarded engagements to sync.
* @param int $template_id Engagement template ID.
* @return void
*/
private function sync_awarded_engagements( $engagements, $template_id ) {
$success_log_message = 'awarded %1$s %2$s (#%3$d) successfully synced with template %4$s (#%5$d)';
$error_log_message = 'an error occurred while trying to sync awarded %1$s %2$s (#%3$d) from template %4$s (#%5$d)';
foreach ( $engagements as $awarded_engagement ) {
$this->log(
sprintf(
$awarded_engagement->sync() ? $success_log_message : $error_log_message,
$this->engagement_type,
$awarded_engagement->get( 'title', true ),
$awarded_engagement->get( 'id' ),
get_the_title( $template_id ),
$template_id
)
);
}
}
/**
* Execute sync for each item in the queue until all awarded engagements are synced.
*
* @since 6.0.0
*
* @param array $args Array of processing data.
* @return boolean `true` to keep the item in the queue and process again.
* `false` to remove the item from the queue.
*/
public function task( $args ) {
$this->log(
sprintf(
'awarded %1$ss bulk sync task started for the %1$s template %2$s (#%3$d) - chunk %4$d',
$this->engagement_type,
get_the_title( $args['query_args']['templates'] ),
$args['query_args']['templates'],
$args['query_args']['page']
)
);
// Ensure the item has all the data we need to process it.
if ( empty( $args['query_args']['templates'] ) ) {
return false;
}
$query = new LLMS_Awards_Query( $args['query_args'] );
if ( $query->has_results() ) {
$this->sync_awarded_engagements( $query->get_awards(), $args['query_args']['templates'] );
}
if ( $query->is_last_page() ) {
$this->process_completed( $args );
}
return false;
}
}
================================================
FILE: includes/abstracts/llms-abstract-query.php
================================================
<?php
/**
* LLMS_Abstract_Query class file.
*
* @package LifterLMS/Abstracts/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Database Query abstract class.
*
* @since 6.0.0
*
* Query Arguments
*
* @param int $page Results page number. Default: `1`.
* @param int $per_page Number of results to retrieve per page. Default: `10`.
* @param int $search Text search term or query. Default: `''`.
* @param int $sort Result order and orderby. Default: `array()`.
* @param int $suppress_filters Whether or not to allow filter hooks to run. Default: `false`.
* @param int $no_found_rows Whether or not to disable the total number of found results for the query. Default: `false`.
*/
abstract class LLMS_Abstract_Query {
/**
* Identify the extending query.
*
* @var string
*/
protected $id = '';
/**
* Defines fields that can be sorted on via ORDER BY.
*
* If this is not defined by extending classes, the sort data
* will not be validated.
*
* @var string[]|null
*/
protected $allowed_sort_fields = array();
/**
* Combined arguments prior to sanitization.
*
* This is the final resulting arguments used to generate the query,
* the result of the default arguments merged into the submitted arguments.
*
* @var array
*/
protected $arguments = array();
/**
* Default arguments before merging with original.
*
* @var array
*/
protected $arguments_default = array();
/**
* Original arguments before merging with defaults.
*
* @var array
*/
protected $arguments_original = array();
/**
* Total number of results matching query parameters.
*
* @var integer
*/
protected $found_results = 0;
/**
* Maximum number of pages of results based off per_page & found_results.
*
* @var integer
*/
protected $max_pages = 0;
/**
* Number of results on the current page.
*
* @var integer
*/
protected $number_results = 0;
/**
* The final query used to retrieve results.
*
* For a raw database query, this is the SQL passed to `$wpdb->get_results()`. For a WP_Posts query
* this is the array of query arguments passed into the `WP_Query`. Other extending queries
* may used this as they see fit.
*
* @var mixed
*/
protected $query = array();
/**
* The parsed and sanitized arguments ultimately used by the query.
*
* @var array
*/
protected $query_vars = array();
/**
* Array of results retrieved by the query.
*
* @var array
*/
protected $results = array();
/**
* Constructor.
*
* @since 6.0.0
*
* @param array $args Query arguments. When not provided the default arguments will be used.
* @return void
*/
public function __construct( $args = array() ) {
$this->arguments_original = $args;
$this->arguments_default = $this->get_default_args();
$this->setup_args();
$this->query();
}
/**
* Set result counts and pagination properties.
*
* @since 6.0.0
*
* @return void
*/
protected function count_results() {
$this->number_results = count( (array) $this->results );
// If we have results and found rounds isn't disabled.
if ( $this->number_results && ! $this->get( 'no_found_rows' ) ) {
$this->found_results = $this->found_results();
$this->max_pages = absint( ceil( $this->found_results / $this->get( 'per_page' ) ) );
}
}
/**
* Determines the default arguments for the query.
*
* Extending classes can override or extend this method to customize the default query
* arguments for the query.
*
* @since 6.0.0
*
* @return array
*/
protected function default_arguments() {
return array(
'page' => 1,
'per_page' => 10,
'search' => '',
'sort' => array(),
'suppress_filters' => false,
'no_found_rows' => false,
'count_only' => false,
);
}
/**
* Determines the total number of found results for the given query and returns it.
*
* @since 6.0.0
*
* @return int
*/
abstract protected function found_results();
/**
* Retrieve a query variable with an optional fallback value when the value is not set.
*
* @since 3.8.0
* @since 6.0.0 Moved from `LLMS_Database_Query` and updated to use the null coalesce operator.
*
* @param string $key Variable key.
* @param mixed $default Default value.
* @return mixed
*/
public function get( $key, $default = '' ) {
return $this->query_vars[ $key ] ?? $default;
}
/**
* Get the final combined arguments used to generate the query.
*
* Retrieves the value of the protected `$arguments` variable.
*
* @since 6.0.0
*
* @return array
*/
public function get_arguments() {
return $this->arguments;
}
/**
* Get the default arguments used for the query.
*
* Retrieves the value of the protected `$arguments_default` variable.
*
* @since 6.0.0
*
* @return array
*/
public function get_arguments_default() {
return $this->arguments_default;
}
/**
* Get the original, uncleaned, arguments submitted to the query.
*
* Retrieves the value of the protected `$arguments_original` variable.
*
* @since 6.0.0
*
* @return array
*/
public function get_arguments_original() {
return $this->arguments_original;
}
/**
* Get the query.
*
* Retrieves the value of the protected `$query` variable.
*
* @since 6.0.0
*
* @return mixed
*/
public function get_query() {
return $this->query;
}
/**
* Retrieve a list of fields that are allowed to be used for result sorting.
*
* @since 6.0.0
*
* @return string[]
*/
protected function get_allowed_sort_fields() {
$allowed_fields = $this->allowed_sort_fields;
if ( $this->get( 'suppress_filters' ) ) {
return $allowed_fields;
}
/**
* Filters the allowed sort fields.
*
* The dynamic portion of this hook, `$this->id`, refers to ID of the extending
* query class.
*
* @since 6.0.0
*
* @param array $allowed_fields Default arguments.
*/
return apply_filters( "llms_{$this->id}_query_allowed_sort_fields", $allowed_fields );
}
/**
* Retrieve default arguments for the query.
*
* @since 3.8.0
* @since 4.5.1 Added new default arg `no_found_rows` set to false.
* @since 6.0.0 Moved from `LLMS_Database_Query` abstract.
*
* @return array
*/
protected function get_default_args() {
if ( $this->get( 'suppress_filters' ) ) {
return $this->default_arguments();
}
/**
* Filters the query default args.
* The dynamic part of the filter `$this->id` identifies the extending query.
*
* @since 3.8.0
*
* @param array $args Array of default arguments to set up the query with.
*/
return apply_filters( "llms_{$this->id}_query_get_default_args", $this->default_arguments() );
}
/**
* Get the total results found for the query.
*
* If the query was instantiated with `$no_found_rows=true` this will always
* return `0`.
*
* Retrieves the value of the protected property `$found_results`.
*
* @since 6.0.0
*
* @return int
*/
public function get_found_results() {
return $this->found_results;
}
/**
* Get the total number of pages available for the given query.
*
* If the query was instantiated with `$no_found_rows=true` this will always
* return `0`.
*
* Retrieves the value of the protected property `$max_pages`.
*
* @since 6.0.0
*
* @return int
*/
public function get_max_pages() {
return $this->max_pages;
}
/**
* Get the number of results on the current page.
*
* Retrieves the value of the protected property `$number_results`.
*
* @since 6.0.0
*
* @return int
*/
public function get_number_results() {
return $this->number_results;
}
/**
* Retrieve an array of results for the given query.
*
* @since 3.8.0
* @since 4.5.1 Drop use of `this->get_filter('get_results')` in favor of `"llms_{$this->id}_query_get_results"`.
* @since 6.0.0 Moved from `LLMS_Database_Query` abstract.
*
* @return array
*/
public function get_results() {
if ( $this->get( 'suppress_filters' ) ) {
return $this->results;
}
/**
* Filters the query results.
*
* The dynamic part of the filter `$this->id` identifies the extending query.
*
* @since 3.8.0
*
* @param array $results Array of results retrieved by the query.
*/
return apply_filters( "llms_{$this->id}_query_get_results", $this->results );
}
/**
* Determine if the query has at least one result.
*
* @since 3.16.0
* @since 6.0.0 Moved from `LLMS_Database_Query` abstract.
*
* @return bool
*/
public function has_results() {
return $this->number_results > 0;
}
/**
* Determine if we're on the first page of results.
*
* @since 3.8.0
* @since 3.14.0 Unknown.
* @since 6.0.0 Moved from `LLMS_Database_Query` abstract.
*
* @return boolean
*/
public function is_first_page() {
return 1 === absint( $this->get( 'page' ) );
}
/**
* Determine if we're on the last page of results.
*
* @since 3.8.0
* @since 3.30.3 Return true if there are no results.
* @since 6.0.0 Moved from `LLMS_Database_Query` abstract.
*
* @return boolean
*/
public function is_last_page() {
return ! $this->has_results() || ( absint( $this->get( 'page' ) ) === $this->max_pages );
}
/**
* Parse arguments needed for the query.
*
* @since 3.8.0
*
* @return void
*/
abstract protected function parse_args();
/**
* Perform the query and return the results.
*
* @since 6.0.0
*
* @return array
*/
abstract protected function perform_query();
/**
* Prepare the query.
*
* Should return the query which will be used by `query()`.
*
* @since 6.0.0
*
* @return mixed
*/
abstract protected function prepare_query();
/**
* Execute a query.
*
* @since 3.8.0
* @since 4.5.1 Drop use of `$this->get_filter('prepare_query')` in favor of `"llms_{$this->id}_query_prepare_query"`.
* @since 6.0.0 Moved from `LLMS_Database_Query` abstract.
*
* @return void
*/
public function query() {
$this->query = $this->prepare_query();
if ( ! $this->get( 'suppress_filters' ) ) {
/**
* Filters the query SQL.
*
* The dynamic part of the filter `$this->id` identifies the extending query.
*
* @since 3.8.0
*
* @param string $sql The SQL query.
* @param LLMS_Database_Query $db_query The LLMS_Database_Query instance.
*/
$this->query = apply_filters( "llms_{$this->id}_query_prepare_query", $this->query, $this );
}
$this->results = $this->perform_query();
$this->count_results();
}
/**
* Sanitize input to ensure an array of absolute integers.
*
* @since 3.15.0
* @since 3.24.0 Unknown.
* @since 6.0.0 Moved from `LLMS_Database_Query` abstract.
*
* @param string|int|array $ids String/Int or array of strings/ints.
* @return array
*/
protected function sanitize_id_array( $ids = array() ) {
if ( empty( $ids ) ) {
return array();
}
// Allow numeric strings & ints to be passed instead of an array.
$ids = ! is_array( $ids ) ? array( $ids ) : $ids;
// Force positive ints.
$ids = array_map( 'absint', $ids );
// Remove empty values.
return array_values( array_filter( $ids ) );
}
/**
* Removes any invalid sort fields before preparing a query.
*
* @since 3.34.0
* @since 6.0.0 Moved from `LLMS_Database_Query`.
* Use `get_allowed_sort_fields()`.
*
* @return void
*/
protected function sanitize_sort( $sort ) {
$allowed_fields = $this->get_allowed_sort_fields();
if ( empty( $allowed_fields ) ) {
return $sort;
}
foreach ( (array) $sort as $orderby => $order ) {
if ( ! in_array( $orderby, $allowed_fields, true ) || ! in_array( $order, array( 'ASC', 'DESC' ), true ) ) {
unset( $sort[ $orderby ] );
}
}
return $sort;
}
/**
* Sets a query variable.
*
* @since 3.8.0
* @since 6.0.0 Moved from `LLMS_Database_Query` abstract.
*
* @param string $key Variable key.
* @param mixed $val Variable value.
* @return void
*/
public function set( $key, $val ) {
$this->query_vars[ $key ] = $val;
}
/**
* Setup arguments prior to a query.
*
* @since 3.8.0
* @since 3.34.0 Sanitizes sort parameters.
* @since 4.5.1 Added filter `"llms_{$this->id}_query_parse_args"`.
* @since 6.0.0 Moved from `LLMS_Database_Query` abstract.
*
* @return void
*/
protected function setup_args() {
$this->arguments = wp_parse_args( $this->arguments_original, $this->arguments_default );
$this->parse_args();
if ( ! $this->get( 'suppress_filters' ) ) {
/**
* Filters the parsed query arguments.
*
* The dynamic part of the filter `$this->id` identifies the extending query.
*
* @since 4.5.1
*
* @param array $ars The query parse arguments.
* @param LLMS_Database_Query $db_query The LLMS_Database_Query instance.
* @param array $original_args Original arguments before merging with defaults.
* @param array $default_args Default arguments before merging with original.
*/
$this->arguments = apply_filters( "llms_{$this->id}_query_parse_args", $this->arguments, $this, $this->arguments_original, $this->arguments_default );
}
foreach ( $this->arguments as $arg => $val ) {
$val = 'sort' === $arg ? $this->sanitize_sort( $this->arguments['sort'] ) : $val;
$this->set( $arg, $val );
}
}
public function get_count_only_result() {
$results = $this->get_results();
if ( ! is_array( $results ) || ! count( $results ) || ! isset( $results[0] ) || ! property_exists(
$results[0],
'total'
) ) {
/* Translators: %s - name of class. */
error_log(
sprintf(
__( '[LifterLMS] Found results with count_only has no result rows in %s.', 'lifterlms' ),
get_class( $this )
)
);
return 0;
}
return intval( $results[0]->total );
}
}
================================================
FILE: includes/abstracts/llms-abstract-session-data.php
================================================
<?php
/**
* Base session data class
*
* @package LifterLMS/Abstracts/Classes
*
* @since 4.0.0
* @version 4.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Abstract_Session
*
* @since 4.0.0
*/
abstract class LLMS_Abstract_Session_Data {
/**
* Session data
*
* @var array
*/
protected $data = array();
/**
* Session ID
*
* The session ID is the logged-in user ID
* or a unique ID for an anonymous user.
*
* @var string
*/
protected $id = '';
/**
* Determines if there's session data to be saved.
*
* If `true` no data needs to be saved, if `false` data
* needs to be saved.
*
* @var boolean
*/
protected $is_clean = true;
/**
* Generate a session key for the current user/visitor.
*
* A logged-in user will use their WP_User ID while logged-out
* users will be assigned a random string.
*
* @since 4.0.0
*
* @return string
*/
protected function generate_id() {
// Use the current user id if the user is logged in.
if ( is_user_logged_in() ) {
return strval( get_current_user_id() );
}
// Generate a random id.
require_once ABSPATH . 'wp-includes/class-phpass.php';
$hasher = new PasswordHash( 8, false );
return md5( $hasher->get_random_bytes( 32 ) );
}
/**
* Retrieve session ID.
*
* @since 1.0.0
* @since 4.0.0 Moved from `LLMS_Sessions`, automatically generates an ID if it doesn't exist.
*
* @return string Session ID.
*/
public function get_id() {
if ( empty( $this->id ) ) {
$this->id = $this->generate_id();
}
return $this->id;
}
/**
* Retrieve a session variable.
*
* @since 1.0.0
* @since 3.37.7 Added the `$default` parameter that represents the default value
* to return if the session variable requested doesn't exist.
* @since 4.0.0 Moved from `LLMS_Session`.
*
* @param string $key The key of the session variable.
* @param mixed $default Optional. The default value to return if no session variable is found with the provided key. Default `false`.
* @return mixed
*/
public function get( $key, $default = false ) {
$key = sanitize_key( $key );
return isset( $this->data[ $key ] ) ? maybe_unserialize( $this->data[ $key ] ) : $default;
}
/**
* Set a session variable.
*
* @since 1.0.0
* @since 4.0.0 Moved from `LLMS_Session`.
*
* @param string $key The key of the session variable.
* @param mixed $value The value of the session variable.
* @return mixed
*/
public function set( $key, $value ) {
/**
* Using `isset()` allows us to explicitly save a value of `false`
* since the `get()` method will return the default value `false` making it look
* as if the value hasn't changed (when it actually has).
*/
if ( ! isset( $this->$key ) || $value !== $this->get( $key ) ) {
$this->data[ sanitize_key( $key ) ] = maybe_serialize( $value );
$this->is_clean = false;
}
return $this->get( $key );
}
/**
* Magic get
*
* @since 1.0.0
* @since 4.0.0 Moved from `LLMS_Session`.
*
* @param string $key The key of the session variable.
* @return mixed
*/
public function __get( $key ) {
return $this->get( $key );
}
/**
* Magic set
*
* @since 1.0.0
* @since 4.0.0 Moved from `LLMS_Session`.
*
* @param string $key The key of the session variable.
* @param string $value The value of the session variable.
* @return void
*/
public function __set( $key, $value ) {
$this->set( $key, $value );
}
/**
* Magic isset
*
* @since 1.0.0
* @since 4.0.0 Use `sanitize_key()` (like other methods in this class) instead of `sanitize_title()`.
*
* @param string $key The key of the session variable.
* @return bool
*/
public function __isset( $key ) {
return isset( $this->data[ sanitize_key( $key ) ] );
}
/**
* Magic unset
*
* @since 1.0.0
* @since 4.0.0 Use `sanitize_key()` when removing session var.
*
* @param string $key The key of the session variable.
* @return void
*/
public function __unset( $key ) {
if ( isset( $this->$key ) ) {
unset( $this->data[ sanitize_key( $key ) ] );
$this->is_clean = false;
}
}
}
================================================
FILE: includes/abstracts/llms-abstract-session-database-handler.php
================================================
<?php
/**
* Base session data class
*
* @package LifterLMS/Abstracts/Classes
*
* @since 4.0.0
* @version 4.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Abstract_Session
*
* @since 4.0.0
*/
abstract class LLMS_Abstract_Session_Database_Handler extends LLMS_Abstract_Session_Data {
/**
* Cache group name, used for WP caching functions
*
* @var string
*/
protected $cache_group = 'llms_session_id';
/**
* Delete all sessions from the database
*
* This method is the callback function for the `llms_delete_expired_session_data` cron event, which
* deletes expired sessions hourly.
*
* This method is also used by the admin tool to remove *all* sessions on demand.
*
* @since 4.0.0
*
* @param boolean $expired_only If `true`, only delete expired sessions, otherwise deletes all events.
* @return int
*/
public function clean( $expired_only = true ) {
global $wpdb;
$query = "DELETE FROM {$wpdb->prefix}lifterlms_sessions";
if ( $expired_only ) {
$query .= $wpdb->prepare( ' WHERE expires < %d', time() );
}
LLMS_Cache_Helper::invalidate_group( $this->cache_group );
return $wpdb->query( $query ); // phpcs:ignore: WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching, WordPress.DB.PreparedSQL.NotPrepared
}
/**
* Delete a session from the database
*
* @since 4.0.0
*
* @param string $id Session key.
* @return boolean
*/
public function delete( $id ) {
wp_cache_delete( $this->get_cache_key( $id ), $this->cache_group );
global $wpdb;
return (bool) $wpdb->delete( // phpcs:ignore: WordPress.DB.DirectDatabaseQuery.DirectQuery
$wpdb->prefix . 'lifterlms_sessions',
array(
'session_key' => $id,
)
);
}
/**
* Retrieve a prefixed cache key
*
* @since 4.0.0
*
* @param string $key Unprefixed cache key.
* @return string
*/
protected function get_cache_key( $key ) {
return LLMS_Cache_Helper::get_prefix( $this->cache_group ) . $key;
}
/**
* Save the session to the database
*
* @since 4.0.0
*
* @param int $expires Timestamp of the session expiration.
* @return boolean
*/
public function save( $expires ) {
// Only save if we have data to save.
if ( $this->is_clean ) {
return false;
}
global $wpdb;
$save = $wpdb->query( // phpcs:ignore: WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
$wpdb->prepare(
"INSERT INTO {$wpdb->prefix}lifterlms_sessions ( `session_key`, `data`, `expires` ) VALUES ( %s, %s, %d )
ON DUPLICATE KEY UPDATE `data` = VALUES ( `data` ), `expires` = VALUES ( `expires` )",
$this->get_id(),
maybe_serialize( $this->data ),
$expires
)
);
wp_cache_set( $this->get_cache_key( $this->get_id() ), $this->data, $this->cache_group, $expires - time() );
$this->is_clean = true;
return (bool) $save;
}
/**
* Retrieve session data from the database
*
* @since 4.0.0
*
* @param string $key Session key.
* @param array $default Default value used when no data exists.
* @return string|array
*/
public function read( $key, $default = array() ) {
$cache_key = $this->get_cache_key( $key );
$data = wp_cache_get( $cache_key, $this->cache_group );
if ( false === $data ) {
global $wpdb;
$data = $wpdb->get_var( $wpdb->prepare( "SELECT `data` FROM {$wpdb->prefix}lifterlms_sessions WHERE `session_key` = %s", $key ) ); // phpcs:ignore: WordPress.DB.DirectDatabaseQuery.DirectQuery
if ( is_null( $data ) ) {
$data = $default;
}
$duration = $this->expires - time();
if ( 0 < $duration ) {
wp_cache_set( $cache_key, $data, $this->cache_group, $duration );
}
}
return maybe_unserialize( $data );
}
}
================================================
FILE: includes/abstracts/llms-abstract-user-engagement.php
================================================
<?php
/**
* LLMS_Abstract_User_Engagement class
*
* @package LifterLMS/Abstracts/Classes
*
* @since 6.0.0
* @version 6.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Base model class for awarded engagements (certificates and achievements).
*
* @since 6.0.0
*/
abstract class LLMS_Abstract_User_Engagement extends LLMS_Post_Model {
use LLMS_Trait_User_Engagement_Type;
/**
* Constructor.
*
* @since 6.0.0
*
* @param string|int|LLMS_Post_Model|WP_Post $model 'new', WP post id, instance of an extending class, instance of WP_Post.
* @param array $args Args to create the post, only applies when $model is 'new'.
* @return void
*/
public function __construct( $model, $args = array() ) {
$this->engagement_type = $this->model_post_type;
parent::__construct( $model, $args );
}
/**
* Called immediately after creating / inserting a new post into the database
*
* @since 6.0.0
*
* @return void
*/
protected function after_create() {
$this->sync( 'create' );
}
/**
* Delete the engagement
*
* @since 3.18.0
* @since 6.0.0 Migrated from LLMS_User_Certificate and LLMS_User_Achievement.
*
* @return void
*/
public function delete() {
/**
* Action fired immediately prior to the deletion of a user's awarded engagement.
*
* The dynamic portion of the hook name, `$this->model_post_type`,
* refers to the engagement type, either "achievement" or "certificate".
*
* @since 3.18.0
* @since 6.0.0 Migrated from LLMS_User_Certificate and LLMS_User_Achievement.
*
* @param LLMS_Abstract_User_Engagement $User_Engagement Achievement or certificate class object.
*/
do_action( "llms_before_delete_{$this->model_post_type}", $this );
global $wpdb;
$id = $this->get( 'id' );
$wpdb->delete( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
"{$wpdb->prefix}lifterlms_user_postmeta",
array(
'user_id' => $this->get_user_id(),
'meta_key' => $this->get_user_post_meta_key(), // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'meta_value' => $id, // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value
),
array( '%d', '%s', '%d' )
);
wp_delete_post( $id, true );
/**
* Action fired immediately after the deletion of a user's awarded engagement.
*
* The dynamic portion of the hook name, `$this->model_post_type`,
* refers to the engagement type, either "achievement" or "certificate".
*
* @since 3.18.0
* @since 6.0.0 Migrated from LLMS_User_Certificate and LLMS_User_Achievement.
*
* @param LLMS_Abstract_User_Engagement $User_Engagement Achievement or certificate class object.
*/
do_action( "llms_delete_{$this->model_post_type}", $this );
}
/**
* Retrieve the date the achievement was earned (created)
*
* @since 3.14.0
* @since 6.0.0 Migrated from LLMS_User_Certificate and LLMS_User_Achievement.
*
* @param string $format Date format string.
* @return string
*/
public function get_earned_date( $format = null ) {
$format = $format ? $format : get_option( 'date_format' );
return $this->get_date( 'date', $format );
}
/**
* Get the WP Post ID of the post which triggered the earning of the certificate
*
* This would be a lesson, course, section, track, etc...
*
* @since 3.8.0
* @since 4.5.0 Force return to an integer.
* @since 6.0.0 Migrated from LLMS_User_Certificate and LLMS_User_Achievement.
*
* @return int
*/
public function get_related_post_id() {
$meta = $this->get_user_postmeta();
return isset( $meta->post_id ) ? absint( $meta->post_id ) : $this->get( 'related' );
}
/**
* Retrieve the user ID of the user who earned the certificate
*
* @since 3.8.0
* @since 3.9.0 Unknown.
* @since 4.5.0 Force return to an integer.
* @since 6.0.0 Migrated from LLMS_User_Certificate and LLMS_User_Achievement.
*
* @return int
*/
public function get_user_id() {
$meta = $this->get_user_postmeta();
return isset( $meta->user_id ) ? absint( $meta->user_id ) : $this->get( 'author' );
}
/**
* Retrieve user postmeta data for the achievement or certificate.
*
* @since 3.8.0
* @since 6.0.0 Migrated from LLMS_User_Certificate and LLMS_User_Achievement.
*
* @return stdClass
*/
public function get_user_postmeta() {
global $wpdb;
return $wpdb->get_row( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
$wpdb->prepare(
"SELECT user_id, post_id FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_value = %d AND meta_key = %s",
$this->get( 'id' ),
$this->get_user_post_meta_key()
)
);
}
/**
* Retrieve the user postmeta key recorded when the engagement is earned.
*
* @since 6.0.0
*
* @return string
*/
protected function get_user_post_meta_key() {
return sprintf( '_%s_earned', $this->model_post_type );
}
/**
* Determines if the achievement or certificate has been awarded.
*
* @since 6.0.0
*
* @return boolean
*/
public function is_awarded() {
if ( 'publish' !== $this->get( 'status' ) ) {
return false;
}
return (bool) $this->get( 'awarded' );
}
/**
* Allow child classes to merge the post content based on content from the template.
*
* @since 6.0.0
* @since 6.4.0 Added optional `$content` and `$load_reusable_blocks` parameters.
*
* @param string $content Optionally use the given content instead of `$this->content`.
* @param bool $load_reusable_blocks Optionally replace reusable blocks with their actual blocks.
* @return string
*/
public function merge_content( $content = null, $load_reusable_blocks = false ) {
if ( is_null( $content ) ) {
$content = $this->get( 'content', true );
}
if ( $load_reusable_blocks ) {
$blocks = parse_blocks( $content );
$blocks = LLMS_Forms::instance()->load_reusable_blocks( $blocks );
$content = serialize_blocks( $blocks );
}
return $content;
}
/**
* Update the awarded engagement by regenerating it from its template.
*
* @since 6.0.0
* @since 6.4.0 Added replacement of references to reusable blocks with their actual blocks.
*
* @param string $context Sync context. Either "update" for an update to an existing awarded engagement
* or "create" when the awarded engagement is being created.
* @return boolean Returns false if the parent doesn't exist, otherwise returns true.
*/
public function sync( $context = 'update' ) {
$template_id = $this->get( 'parent' );
$template = $this->get_user_engagement( $template_id, false );
if ( ! $template ) {
return false;
}
$this->set( 'title', get_post_meta( $template_id, "_llms_{$this->model_post_type}_title", true ) );
if ( get_post_thumbnail_id( $template_id ) !== get_post_thumbnail_id( $this->get( 'post' ) ) &&
! set_post_thumbnail( $this->get( 'post' ), get_post_thumbnail_id( $template_id ) )
) {
delete_post_thumbnail( $this->get( 'post' ) );
}
// Copy the content with optional merge codes, shortcodes, and optional block editor layout meta properties
// from the template to this awarded engagement.
$content = $template->get( 'content', true );
$this->set( 'content', $this->merge_content( $content, true ) );
$this->sync_meta( $template );
/**
* Action run after an awarded engagement is synchronized with its template.
*
* The dynamic portion of the hook name, `$this->model_post_type`,
* refers to the engagement type, either "achievement" or "certificate".
*
* @since 6.0.0
*
* @param LLMS_Abstract_User_Engagement $engagement Awarded engagement object.
* @param LLMS_Abstract_User_Engagement $template Engagement template object.
* @param string $context The context within which the synchronization is run.
* Either "create" or "update".
*/
do_action( "llms_{$this->model_post_type}_synchronized", $this, $template, $context );
return true;
}
/**
* This is a stub that allows extending classes to sync additional data from the template during a sync operation.
*
* @since 6.0.0
*
* @param LLMS_Abstract_User_Engagement $template
* @return void
*/
protected function sync_meta( $template ) {
}
}
================================================
FILE: includes/abstracts/llms.abstract.api.handler.php
================================================
<?php
/**
* 3rd Party API request handler abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.11.2
* @version 4.21.3
*/
defined( 'ABSPATH' ) || exit;
/**
* 3rd Party API request handler abstract class
*
* @since 3.11.2
* @since 3.30.1 self::set_request_body() may respond with `null` in order to send a request with no `body`.
*/
abstract class LLMS_Abstract_API_Handler {
/**
* Determines if an empty response body should be interpreted as an error
*
* @var bool
*/
protected $allow_empty_response = false;
/**
* Default request method
*
* @var string
*/
protected $default_request_method = 'POST';
/**
* Determine if the request should be made as JSON
*
* @var bool
*/
protected $is_json = true;
/**
* Request timeout in seconds
*
* @var integer
*/
protected $request_timeout = 60;
private $result = null;
private $error_message = null;
private $error_object = null;
private $error_type = null;
/**
* Construct an API call, parameters are passed to private `call()` function
*
* @param stirng $resource url endpoint or resource to make a request to
* @param array $data array of data to pass in the body of the request
* @param string $method method of request (POST, GET, DELETE, PUT, etc...)
* @return void
* @since 3.11.2
* @version 3.11.2
*/
public function __construct( $resource, $data, $method = null ) {
$this->call( $resource, $data, $method );
}
/**
* Execute an API request.
*
* @since 3.11.2
* @since 3.30.1 self::set_request_body() may respond with `null` in order to send a request with no `body`
* @since 4.21.3 Use `wp_json_encode()` in favor of `json_encode()`.
* Updated the API connection error message.
*
* @param string $resource url endpoint or resource to make a request to.
* @param array $data array of data to pass in the body of the request.
* @param string $method method of request (POST, GET, DELETE, PUT, etc...).
* @return null
*/
private function call( $resource, $data, $method = null ) {
$method = is_null( $method ) ? $this->default_request_method : $method;
// setup headers.
$content_type = $this->is_json ? 'application/json; charset=utf-8' : 'application/x-www-form-urlencoded';
$headers = $this->set_request_headers(
array(
'content-type' => $content_type,
),
$resource,
$method
);
$args = array(
'headers' => $headers,
'method' => $method,
'timeout' => $this->request_timeout,
'user-agent' => $this->set_user_agent( 'LifterLMS ' . LLMS_VERSION, $resource, $method ),
);
// setup body.
$body = $this->set_request_body( $data, $method, $resource );
// if "null" if passed to body, don't send a body at all.
if ( ! is_null( $body ) ) {
$args['body'] = $this->is_json && $body ? wp_json_encode( $body ) : $body;
}
// Attempt to call the API.
$response = wp_safe_remote_request(
$this->set_request_url( $resource, $method ),
$args
);
// Connection error.
if ( is_wp_error( $response ) ) {
return $this->set_error( __( 'There was a problem connecting to the external API.', 'lifterlms' ), 'api_connection', $response );
}
// Empty body.
if ( ! $this->allow_empty_response && empty( $response['body'] ) ) {
return $this->set_error( __( 'Empty Response.', 'lifterlms' ), 'empty_response', $response );
}
$this->parse_response( $response );
}
/**
* Retrieve the private "error_message" variable
*
* @return string
* @since 3.11.2
* @version 3.11.2
*/
public function get_error_message() {
return $this->error_message;
}
/**
* Get the private "error_object" variable
*
* @return mixed
* @since 3.11.2
* @version 3.11.2
*/
public function get_error_object() {
return $this->error_object;
}
/**
* Retrieve the private "error_type" variable
*
* @return string
* @since 3.11.2
* @version 3.11.2
*/
public function get_error_type() {
return $this->error_type;
}
/**
* Retrieve the private "result" variable
*
* @return mixed
* @since 3.11.2
* @version 3.11.2
*/
public function get_result() {
return $this->result;
}
/**
* Determine if the response is an error
*
* @return boolean
* @since 3.11.2
* @version 3.11.2
*/
public function is_error() {
return is_wp_error( $this->get_result() );
}
/**
* Parse the body of the response and set a success/error
*
* @param array $response response data
* @return array
* @since 3.11.2
* @version 3.11.2
*/
abstract protected function parse_response( $response );
/**
* Set an Error
* Sets all error variables and sets the result as a WP_Error so the result can always be tested with `is_wp_error()`
*
* @param string $message error message
* @param string $type error code or type
* @param object $obj full error object or api response
* @return void
* @since 3.11.2
* @version 3.11.2
*/
protected function set_error( $message, $type, $obj ) {
$this->result = new WP_Error( $type, $message, $obj );
$this->error_type = $type;
$this->error_message = $message;
$this->error_object = $obj;
}
/**
* Set the result
*
* @param mixed $result result data
* @since 3.11.2
* @version 3.11.2
*/
protected function set_result( $result ) {
$this->result = $result;
}
/**
* Set request body
*
* @param array $data request body
* @param string $method request method
* @param string $resource requested resource
* @return array
* @since 3.11.2
* @version 3.11.2
*/
abstract protected function set_request_body( $data, $method, $resource );
/**
* Set request headers
*
* @param array $headers default request headers
* @param string $resource request resource
* @param string $method request method
* @return array
* @since 3.11.2
* @version 3.11.2
*/
protected function set_request_headers( $headers, $resource, $method ) {
return $headers;
}
/**
* Set the request URL
*
* @param string $resource requested resource
* @param string $method request method
* @return string
* @since 3.11.2
* @version 3.11.2
*/
abstract protected function set_request_url( $resource, $method );
/**
* Set the request User Agent
* Can be overridden by extending classes when necessary
*
* @param string $user_agent default user agent (LifterLMS {$version})
* @param string $resource requested resource
* @param string $method request method
* @return string
* @since 3.22.0
* @version 3.22.0
*/
protected function set_user_agent( $user_agent, $resource, $method ) {
return $user_agent;
}
}
================================================
FILE: includes/abstracts/llms.abstract.database.store.php
================================================
<?php
/**
* WPDB database interactions
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.14.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* WPDB database interactions abstract class
*
* @since 3.14.0
* @since 3.33.0 setup() method returns self instead of void.
* @since 3.34.0 to_array() method returns value of the primary key instead of the format.
* @since 3.36.0 Prevent undefined index error when attempting to retrieve an unset value from an unsaved object.
* Hydrate before returning an array via the `to_array()` method.
* @since 4.3.0 Add deprecated hook calls to preserve backwards compatibility for extending classes which have no `$type` property declaration.
* Updated the `$type` property to have a default placeholder value.
*/
abstract class LLMS_Abstract_Database_Store {
/**
* The Database ID of the record
*
* @var int
*/
protected $id = null;
/**
* Object properties
*
* @var array
*/
private $data = array();
/**
* Column name of the record's "created" date
*
* This can be set to an empty string if the extending
* class does not utilize or require created date storage.
*
* @var string
*/
protected $date_created = 'created';
/**
* Column name of the record's "updated" date
*
* This can be set to an empty string if the extending
* class does not utilize or require updated date storage.
*
* @var string
*/
protected $date_updated = 'updated';
/**
* Array of table column name => format
*
* @var array
*/
protected $columns = array();
/**
* Primary Key column name => format
*
* @var array
*/
protected $primary_key = array(
'id' => '%d',
);
/**
* Database Table Name
*
* @var string
*/
protected $table = '';
/**
* Database Table Prefix
*
* @var string
*/
protected $table_prefix = 'lifterlms_';
/**
* The record type
*
* Used for filters/actions.
*
* This is a placeholder which should be redefined in any extending classes.
*
* @var string
*/
protected $type = '_db_record_';
/**
* Constructor
*
* @since 3.14.0
* @since 3.21.0 Unknown.
*
* @return void
*/
public function __construct() {
if ( ! $this->id ) {
// If created dates supported, add current time to the data on construction.
if ( $this->date_created ) {
$this->set( $this->date_created, llms_current_time( 'mysql' ), false );
}
if ( $this->date_updated ) {
$this->set( $this->date_updated, llms_current_time( 'mysql' ), false );
}
}
}
/**
* Get object data
*
* @since 3.14.0
*
* @param string $key Key to retrieve.
* @return mixed
*/
public function __get( $key ) {
return $this->data[ $key ];
}
/**
* Determine if the item exists in the database
*
* @since 3.14.7
* @since 3.15.0 Unknown.
*
* @return boolean
*/
public function exists() {
if ( $this->primary_key ) {
return $this->read( $this->get_primary_key() ) ? true : false;
}
return false;
}
/**
* Get object data
*
* @since 3.14.0
* @since 3.16.0 Unknown.
* @since 3.36.0 Prevent undefined index error when attempting to retrieve an unset value from an unsaved object.
*
* @param string $key Key to retrieve.
* @param boolean $cache If true, save data to to the object for future gets.
* @return mixed
*/
public function get( $key, $cache = true ) {
$key_exists = isset( $this->data[ $key ] );
if ( ! $key_exists && $this->id ) {
$res = $this->read( $key )[ $key ];
if ( $cache ) {
$this->set( $key, $res );
}
return $res;
}
return $key_exists ? $this->$key : null;
}
/**
* Set object data
*
* @since 3.14.0
*
* @param string $key Column name.
* @param mixed $val Column value.
* @return void
*/
public function __set( $key, $val ) {
$this->data[ $key ] = $val;
}
/**
* General setter
*
* @since 3.14.0
* @since 3.21.0 Unknown.
*
* @param string $key Column name.
* @param mixed $val Column value.
* @param boolean $save If true, immediately persists to database.
* @return LLMS_Abstract_Database_Store Instance of the current object, useful for chaining.
*/
public function set( $key, $val, $save = false ) {
$this->$key = $val;
if ( $save ) {
$update = array(
$key => $val,
);
// If update date supported, add an updated date.
if ( $this->date_updated ) {
$update[ $this->date_updated ] = llms_current_time( 'mysql' );
}
$this->update( $update );
}
return $this;
}
/**
* Setup an object with an array of data
*
* @since 3.14.0
* @since 3.33.0 Return self for chaining instead of void.
*
* @param array $data key => val
* @return LLMS_Abstract_Database_Store Instance of the current object, useful for chaining.
*/
public function setup( $data ) {
foreach ( $data as $key => $val ) {
$this->set( $key, $val, false );
}
return $this;
}
/**
* Create the item in the database
*
* @since 3.14.0
* @since 3.24.0 Unknown.
* @since 4.3.0 Added deprecated hook call to `llms__created` action to preserve backwards compatibility.
* @since 6.0.0 Removed deprecated `llms__created` action hook.
*
* @return int|false Record ID on success, false on error or when there's nothing to save.
*/
private function create() {
if ( ! $this->data ) {
return false;
}
global $wpdb;
$format = array_map( array( $this, 'get_column_format' ), array_keys( $this->data ) );
$res = $wpdb->insert( $this->get_table(), $this->data, $format ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
if ( 1 === $res ) {
$this->id = $wpdb->insert_id;
/**
* Fires when a new database record is created.
*
* The dynamic portion of this hook, `$this->type`, refers to the record type.
*
* @since Unknown.
*
* @param int $id Record ID.
* @param LLMS_Abstract_Database_Store $obj Instance of the record object.
*/
do_action( "llms_{$this->type}_created", $this->id, $this );
return $this->id;
}
return false;
}
/**
* Delete the object from the database
*
* @since 3.14.0
* @since 3.24.0 Unknown.
* @since 4.3.0 Added deprecated hook call to `llms__deleted` action to preserve backwards compatibility.
* @since 6.0.0 Removed deprecated `llms__deleted` action hook.
*
* @return boolean `true` on success, `false` otherwise.
*/
public function delete() {
if ( ! $this->id ) {
return false;
}
$id = $this->id;
global $wpdb;
$where = array_combine( array_keys( $this->primary_key ), array( $this->id ) );
$res = $wpdb->delete( $this->get_table(), $where, array_values( $this->primary_key ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
if ( $res ) {
$this->id = null;
$this->data = array();
/**
* Fires when a new database record is created.
*
* The dynamic portion of this hook, `$this->type`, refers to the record type.
*
* @since Unknown.
*
* @param int $id Record ID.
* @param LLMS_Abstract_Database_Store $obj Instance of the record object.
*/
do_action( "llms_{$this->type}_deleted", $id, $this );
return true;
}
return false;
}
/**
* Read object data from the database
*
* @since 3.14.0
*
* @param string[]|string $keys Key name (or array of keys) to retrieve from the database.
* @return array|false Returns a key=>val array of data or `false` when record not found.
*/
private function read( $keys ) {
global $wpdb;
if ( is_array( $keys ) ) {
$keys = implode( ', ', $keys );
}
$res = $wpdb->get_row( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
$wpdb->prepare( "SELECT {$keys} FROM {$this->get_table()} WHERE {$this->get_primary_key()} = %d", $this->id ), // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- This query is safe.
ARRAY_A
);
return ! $res ? false : $res;
}
/**
* Update object data in the database
*
* @since 3.14.0
* @since 3.24.0 Unknown.
* @since 4.3.0 Added deprecated hook call to `llms__updated` action to preserve backwards compatibility.
* @since 6.0.0 Removed deprecated `llms__updated` action hook.
*
* @param array $data Data to update as key=>val.
* @return boolean
*/
private function update( $data ) {
global $wpdb;
$format = array_map( array( $this, 'get_column_format' ), array_keys( $data ) );
$where = array_combine( array_keys( $this->primary_key ), array( $this->id ) );
$res = $wpdb->update( $this->get_table(), $data, $where, $format, array_values( $this->primary_key ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
if ( $res ) {
/**
* Fires when a new database record is updated.
*
* The dynamic portion of this hook, `$this->type`, refers to the record type.
*
* @since Unknown.
*
* @param int $id Record ID.
* @param LLMS_Abstract_Database_Store $obj Instance of the record object.
*/
do_action( "llms_{$this->type}_updated", $this->id, $this );
return true;
}
return false;
}
/**
* Load the whole object from the database
*
* @since 3.14.0
*
* @return LLMS_Abstract_Database_Store instance of the current object, useful for chaining.
*/
protected function hydrate() {
if ( $this->id ) {
$res = $this->read( array_keys( $this->columns ) );
if ( $res ) {
$this->data = array_merge( $this->data, $res );
}
}
return $this;
}
/**
* Save object to the database
*
* Creates it if doesn't already exist, updates if it does.
*
* @since 3.14.0
* @since 3.24.0 Unknown.
*
* @return boolean
*/
public function save() {
if ( ! $this->id ) {
$id = $this->create();
if ( $id ) {
return true;
}
return false;
} else {
return $this->update( $this->data );
}
}
/**
* Retrieve the format for a column
*
* @since 3.14.0
*
* @param string $key Column name.
* @return string
*/
private function get_column_format( $key ) {
if ( isset( $this->columns[ $key ] ) ) {
return $this->columns[ $key ];
}
return '%s';
}
/**
* Retrieve the primary key column name
*
* @since 3.15.0
*
* @return string
*/
protected function get_primary_key() {
$primary_key = array_keys( $this->primary_key );
return preg_replace( '/[^a-zA-Z0-9_]/', '', $primary_key[0] );
}
/**
* Get the ID of the object
*
* @since 3.14.0
*
* @return int
*/
public function get_id() {
return $this->id;
}
/**
* Get the table Name
*
* @since 3.14.0
*
* @return string
*/
private function get_table() {
global $wpdb;
return $wpdb->prefix . $this->table_prefix . $this->table;
}
/**
* Retrieve object as an array
*
* @since 3.14.0
* @since 3.34.0 Return the item ID instead of item format as the value of the primary key.
* @since 3.36.0 Hydrate before returning the array.
*
* @return array
*/
public function to_array() {
$this->hydrate();
return array_merge( array_combine( array_keys( $this->primary_key ), array( $this->id ) ), $this->data );
}
}
================================================
FILE: includes/abstracts/llms.abstract.exportable.admin.table.php
================================================
<?php
/**
* Admin Table Export Functions
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.28.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Exportable admin table abstract class
*
* @since 3.28.0
* @since 3.30.3 Explicitly define undefined properties.
* @since 3.37.15 Ensure filenames of generated export files are for supported filetypes.
* @since 4.0.0 Removed previously deprecated method `LLMS_Admin_Table::queue_export()`.
*/
abstract class LLMS_Abstract_Exportable_Admin_Table {
/**
* The current page.
*
* @var int
*/
protected $current_page;
/**
* Unique ID for the table
*
* @var string
*/
protected $id;
/**
* Is the Table Exportable?
*
* @var boolean
*/
protected $is_exportable = true;
/**
* Export download nonce action.
*
* @var string
*/
public const EXPORT_NONCE_ACTION = 'llms_export_table';
/**
* Generate an export file for the current table.
*
* @since 3.28.0
* @since 3.28.1 Unknown.
* @since 3.37.15 "Sanitize" submitted filename.
*
* @param array $args Arguments to pass get_results().
* @param string $filename Filename of the existing file, if omitted creates a new file, if passed, will continue adding to existing file.
* @param string $type Export file type for forward compatibility. Currently only accepts 'csv'.
* @return WP_Error|array
*/
public function generate_export_file( $args = array(), $filename = null, $type = 'csv' ) {
// We only support CSVs and don't allow fakers.
if ( ! empty( $filename ) && pathinfo( $filename, PATHINFO_EXTENSION ) !== $type ) {
return false;
}
// Always force page 1 regardless of what is requested. Pagination is handled below.
$args['page'] = 1;
/**
* Customize the number of records per page when generating an export file.
*
* @since 3.28.0
*
* @param int $per_page Number of records per page.
*/
$args['per_page'] = apply_filters( 'llms_table_generate_export_file_per_page_boost', 250 );
$filename = $filename ? $filename : $this->get_export_file_name() . '.' . $type;
$file_path = LLMS_TMP_DIR . $filename;
$option_name = 'llms_gen_export_' . basename( $filename, '.' . $type );
$args = get_option( $option_name, $args );
$handle = @fopen( $file_path, 'a+' ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged -- Yea but we handle the error alright I think.
if ( ! $handle ) {
return new WP_Error( 'file_error', __( 'Unable to generate export file, could not open file for writing.', 'lifterlms' ) );
}
/**
* Customize the delimiter used when generating CSV export files.
*
* @since 3.28.0
*
* @param int $delim Delimiter.
* @param LLMS_Abstract_Exportable_Admin_Table $table Instance of the table.
* @param array $args Array of arguments.
*/
$delim = apply_filters( 'llms_table_generate_export_file_delimiter', ',', $this, $args );
foreach ( $this->get_export( $args ) as $row ) {
fputcsv( $handle, $row, $delim );
}
if ( ! $this->is_last_page() ) {
$args['page'] = $this->get_current_page() + 1;
update_option( $option_name, $args );
$progress = round( ( $this->get_current_page() / $this->get_max_pages() ) * 100, 2 );
} else {
delete_option( $option_name );
$progress = 100;
}
return array(
'filename' => $filename,
'progress' => $progress,
'url' => $this->get_export_file_url( $file_path ),
);
}
/**
* Gets data prepared for an export
*
* @since 3.15.0
* @since 3.15.1 Unknown.
*
* @param array $args Query arguments to be passed to get_results().
* @return array
*/
public function get_export( $args = array() ) {
$this->get_results( $args );
$export = array();
if ( 1 === $this->current_page ) {
$export[] = $this->get_export_header();
}
foreach ( $this->get_tbody_data() as $row ) {
$row_data = array();
foreach ( array_keys( $this->get_columns( 'export' ) ) as $row_key ) {
$row_data[ $row_key ] = html_entity_decode( $this->get_export_data( $row_key, $row ) );
}
$export[] = $row_data;
}
return $export;
}
/**
* Retrieve data for a cell in an export file
* Should be overridden in extending classes
*
* @since 3.15.0
*
* @param string $key The column id / key.
* @param mixed $data Object / array of data that the function can use to extract the data.
* @return mixed
*/
public function get_export_data( $key, $data ) {
return trim( wp_strip_all_tags( $this->get_data( $key, $data ) ) );
}
/**
* Retrieve the download URL to an export file
*
* @since 3.28.0
* @since 3.28.1 Unknown.
* @since 7.5.0 Add nonce to export file url.
*
* @param string $file_path Full path to a download file.
* @return string
*/
protected function get_export_file_url( $file_path ) {
return add_query_arg(
array(
'llms-dl-export' => basename( $file_path ),
'llms_dl_export_nonce' => wp_create_nonce( self::EXPORT_NONCE_ACTION ),
),
admin_url( 'admin.php' )
);
}
/**
* Retrieve the header row for generating an export file
*
* @since 3.15.0
* @since 3.17.3 Fixed SYLK warning generated when importing into Excel.
*
* @return array
*/
public function get_export_header() {
$cols = wp_list_pluck( $this->get_columns( 'export' ), 'title' );
/**
* If the first column is "ID" force it to lowercase
* to prevent Excel from attempting to interpret the .csv as SYLK
*
* @see https://github.com/gocodebox/lifterlms/issues/397
*/
foreach ( $cols as &$title ) {
if ( 'id' === strtolower( $title ) ) {
$title = strtolower( $title );
}
break;
}
/**
* Customize the export file header columns.
*
* The dynamic portion of this hook `$this->id` refers to the ID of the table.
*
* @since 3.15.0
*
* @param string[] $cols Array of file headers.
*/
return apply_filters( "llms_table_get_{$this->id}_export_header", $cols );
}
/**
* Retrieves the file name for an export file.
*
* @since 3.15.0
* @since 3.28.0 Unknown.
* @since 7.0.1 Fixed issue encountered when special characters are present in the table's title.
*
* @param array $args Optional arguments passed from table to csv processor.
* @return string
*/
public function get_export_file_name( $args = array() ) {
$parts = array(
sanitize_file_name( strtolower( $this->get_export_title( $args ) ) ),
_x( 'export', 'Used in export filenames', 'lifterlms' ),
llms_current_time( 'Y-m-d' ),
wp_generate_password( 8, false, false ),
);
$filename = implode( '_', $parts );
/**
* Filters the file name for an export file.
*
* The dynamic portion of this hook, `$this->id`, refers to the table's
* `$id` property.
*
* @since Unknown
* @since 7.0.1 Added the `$parts` and `$table` parameters.
*
* @param string $filename The generated filename.
* @param string[] $parts An array of strings that makeup the generated filename
* when joined with the underscore separator character.
* @param LLMS_Abstract_Exportable_Admin_Table $table Instance of the table object.
*/
return apply_filters(
"llms_table_get_{$this->id}_export_file_name",
$filename,
$parts,
$this
);
}
/**
* Get a lock key unique to the table & user for locking the table during export generation
*
* @since 3.15.0
*
* @return string
*/
public function get_export_lock_key() {
return sprintf( '%1$s:%2$d', $this->id, get_current_user_id() );
}
/**
* Allow customization of the title for export files
*
* @since 3.15.0
* @since 3.28.0 Unknown.
*
* @param array $args Optional arguments passed from table to csv processor.
* @return string
*/
public function get_export_title( $args = array() ) {
return apply_filters( 'llms_table_get_' . $this->id . '_export_title', $this->get_title(), $args );
}
/**
* Retrieves the table's title.
*
* This method must be overwritten by extending classes.
*
* @since 7.0.1
*
* @return string
*/
public function get_title() {
_doing_it_wrong(
__METHOD__,
esc_html(
sprintf(
// Translators: %s = the name of the method.
__( "Method '%s' must be overridden.", 'lifterlms' ),
__METHOD__
)
),
'[version]'
);
return $this->id;
}
/**
* Determine if the table is currently locked due to export generation.
*
* @since 3.28.0
*
* @return bool
*/
public function is_export_locked() {
return llms()->processors()->get( 'table_to_csv' )->is_table_locked( $this->get_export_lock_key() );
}
}
================================================
FILE: includes/abstracts/llms.abstract.integration.php
================================================
<?php
/**
* LifterLMS Integration Abstract
*
* @package LifterLMS/Abstracts
*
* @since 3.0.0
* @version 4.21.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Integration abstract class
*
* @since 3.0.0
*/
abstract class LLMS_Abstract_Integration extends LLMS_Abstract_Options_Data {
/**
* Integration ID
*
* Defined by extending class as a variable.
*
* @var string
*/
public $id = '';
/**
* Integration Title
*
* Should be defined by extending class in configure() function (so it can be translated).
*
* @var string
*/
public $title = '';
/**
* Integration Description
*
* Should be defined by extending class in configure() function (so it can be translated).
*
* @var string
*/
public $description = '';
/**
* Integration Missing Dependencies Description
*
* Should be defined by extending class in configure() function (so it can be translated).
*
* Displays on the settings screen when `$this->is_installed()` is `false` to help users
* identify what requirements are missing.
*
* @var string
*/
public $description_missing = '';
/**
* Reference to the integration plugin's main plugin file basename
*
* In the `configure()` method call `plugin_basename()` on the main plugin file.
*
* @var string
*/
protected $plugin_basename = '';
/**
* Integration Priority
*
* Determines the order of the settings on the Integrations settings table.
*
* Built-in core integrations fire at 5.
*
* @var integer
*/
protected $priority = 20;
/**
* Constructor
*
* @since 3.8.0
* @since 3.18.2 Unknown.
*
* @return void
*/
public function __construct() {
$this->configure();
add_filter( 'lifterlms_integrations_settings_' . $this->id, array( $this, 'add_settings' ), $this->priority, 1 );
/**
* Trigger an action when the integration is initialized.
*
* The dynamic portion of this hook, `{$this->id}`, refers to the integration's unique ID.
*
* @since 4.21.0
*
* @param object $instance Class instance of the class extending the `LLMS_Abstract_Integration` abstract.
*/
do_action( "llms_integration_{$this->id}_init", $this );
if ( ! empty( $this->plugin_basename ) ) {
add_action( "plugin_action_links_{$this->plugin_basename}", array( $this, 'plugin_action_links' ), 100, 4 );
}
}
/**
* Configure the integration
*
* Set required class properties and so on.
*
* @since 3.8.0
*
* @return void
*/
abstract protected function configure();
/**
* Merge the default abstract settings with the actual integration settings
*
* Automatically called via filter upon construction.
*
* @since 3.17.8
*
* @param array $settings Existing settings from other integrations.
* @return array
*/
public function add_settings( $settings ) {
return array_merge( $settings, $this->get_settings() );
}
/**
* Get additional settings specific to the integration
*
* Extending classes should override this with the settings
* specific to the integration.
*
* @since 3.8.0
*
* @return array
*/
protected function get_integration_settings() {
return array();
}
/**
* Retrieve the integration priority property.
*
* @since 3.33.1
*
* @return int
*/
public function get_priority() {
return $this->priority;
}
/**
* Retrieve an array of integration related settings
*
* @since 3.8.0
* @since 3.21.1 Automatically output the `$description_missing` message when requirements are not met.
* @since 4.21.0 Add an 'id' to the missing description HTML setting.
*
* @return array
*/
protected function get_settings() {
$settings = array();
$settings[] = array(
'type' => 'sectionstart',
'id' => 'llms_integration_' . $this->id . '_start',
);
$settings[] = array(
'desc' => $this->description,
'id' => 'llms_integration_' . $this->id . '_title',
'title' => $this->title,
'type' => 'title',
);
$settings[] = array(
'desc' => __( 'Check to enable this integration.', 'lifterlms' ),
'default' => 'no',
'id' => $this->get_option_name( 'enabled' ),
'type' => 'checkbox',
'title' => __( 'Enable / Disable', 'lifterlms' ),
);
if ( ! $this->is_installed() && ! empty( $this->description_missing ) ) {
$settings[] = array(
'id' => 'llms_integration_' . $this->id . '_missing_requirements_desc',
'type' => 'custom-html',
'value' => '<em>' . $this->description_missing . '</em>',
);
}
$settings = array_merge( $settings, $this->get_integration_settings() );
$settings[] = array(
'type' => 'sectionend',
'id' => 'llms_integration_' . $this->id . '_end',
);
/**
* Filters the integration's settings
*
* The dynamic portion of this hook, `{$this->id}`, refers to the integration's ID.
*
* @since 3.8.0
*
* @param array[] $settings Array of settings arrays.
* @param object $instance Class instance of the class extending the `LLMS_Abstract_Integration` abstract.
*/
return apply_filters( "llms_integration_{$this->id}_get_settings", $settings, $this );
}
/**
* Retrieve the option name prefix.
*
* @since 3.8.0
*
* @return string
*/
protected function get_option_prefix() {
return $this->option_prefix . 'integration_' . $this->id . '_';
}
/**
* Autoload default option values from values defined in the integration settings array
*
* This will only run when extending integration classes define a version property greater than 1.
*
* This is a callback function for the WP core filter `default_option_{$option}`.
*
* @since 4.21.0
*
* @param mixed $default_value The default value. If no value is passed to `get_option()`, this will be an empty string.
* Otherwise it will be the default value passed to the method.
* @param string $full_option_name The full (prefixed) option name.
* @param bool $passed_default_value Whether or not a default value was passed to `get_option()`.
* @return mixed The default option value.
*/
public function get_option_default_value( $default_value, $full_option_name, $passed_default_value ) {
// If a default value is explicitly passed, use it.
if ( $passed_default_value ) {
return $default_value;
}
foreach ( $this->get_settings() as $setting ) {
if ( ! empty( $setting['id'] ) && $full_option_name === $setting['id'] ) {
return isset( $setting['default'] ) ? $setting['default'] : $default_value;
}
}
return $default_value;
}
/**
* Determine if the integration is enabled via the checkbox on the admin panel
* and the necessary plugin (if any) is installed and activated
*
* @since 3.0.0
* @since 3.17.8 Unknown.
*
* @return boolean
*/
public function is_available() {
return ( $this->is_installed() && $this->is_enabled() );
}
/**
* Determine if the integration had been enabled via checkbox
*
* @since 3.0.0
* @since 3.8.0 Unknown.
*
* @return boolean
*/
public function is_enabled() {
return ( 'yes' === $this->get_option( 'enabled', 'no' ) );
}
/**
* Determine if required dependencies are installed.
*
* Extending classes should override this to perform dependency checks.
*
* @since 3.0.0
* @since 3.8.0 Unknown.
*
* @return boolean
*/
public function is_installed() {
return true;
}
/**
* Add plugin settings Action Links
*
* @since 3.37.9
* @since 4.21.0 Don't check `$context`. If the plugin isn't active this won't run anyway so it's a useless check.
*
* @param string[] $links Existing action links.
* @param string $file Path to the plugin file, relative to the plugin directory.
* @param array $data Plugin data.
* @param string $context Plugin's content (eg: active, invactive, etc...).
* @return string[]
*/
public function plugin_action_links( $links, $file, $data, $context ) {
$url = add_query_arg(
array(
'page' => 'llms-settings',
'tab' => 'integrations',
'section' => $this->id,
),
admin_url( 'admin.php' )
);
$links[] = '<a href="' . esc_url( $url ) . '">' . _x( 'Settings', 'Link text for integration plugin settings', 'lifterlms' ) . '</a>';
return $links;
}
}
================================================
FILE: includes/abstracts/llms.abstract.notification.controller.php
================================================
<?php
/**
* Notification Controller Abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.8.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller abstract class
*
* @since 3.8.0
* @since 3.30.3 Explicitly define undefined properties & fixed typo in output string.
*/
abstract class LLMS_Abstract_Notification_Controller extends LLMS_Abstract_Options_Data implements LLMS_Interface_Notification_Controller {
/**
* Trigger Identifier
*
* @var string
*/
public $id;
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 1;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array();
/**
* Priority used when adding action hook
*
* @var integer
*/
protected $action_priority = 15;
/**
* If true, will automatically dupcheck before sending
*
* @var boolean
*/
protected $auto_dupcheck = false;
/**
* Course associated with the notification
*
* @var LLMS_Course
* @since 3.8.0
*/
public $course;
/**
* WP Post ID associated with the triggering action
*
* @var null
*/
protected $post_id = null;
/**
* WP Post ID of the post which triggered the achievement to be awarded
*
* @var int
* @since 3.8.0
*/
public $related_post_id;
/**
* Array of subscriptions for the notification
*
* @var array
*/
protected $subscriptions = array();
/**
* Array of supported notification types
*
* @var array
*/
protected $supported_types = array();
/**
* Determines if test notifications can be sent
*
* @var bool
*/
protected $testable = array(
'basic' => false,
'email' => false,
);
/**
* WP User ID associated with the triggering action
*
* @var null
*/
protected $user_id = null;
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @since 3.8.0
*
* @param string $subscriber Subscriber type string.
* @return int|false
*/
abstract protected function get_subscriber( $subscriber );
/**
* Get the translatable title for the notification
*
* Used on settings screens.
*
* @since 3.8.0
*
* @return string
*/
abstract public function get_title();
/**
* Setup the subscriber options for the notification
*
* @since 3.8.0
*
* @param string $type Notification type id.
* @return array
*/
abstract protected function set_subscriber_options( $type );
/**
* Holds singletons for extending classes
*
* @var LLMS_Abstract_Notification_Controller[]
*/
private static $_instances = array();
/**
* Get the singleton instance for the extending class
*
* @since 3.8.0
*
* @return LLMS_Abstract_Notification_Controller
*/
public static function instance() {
$class = get_called_class();
if ( ! isset( self::$_instances[ $class ] ) ) {
self::$_instances[ $class ] = new $class();
}
return self::$_instances[ $class ];
}
/**
* Constructor
*
* @since 3.8.0
*
* @return void
*/
private function __construct() {
$this->add_actions();
}
/**
* Add an action to trigger the notification to send
*
* @since 3.8.0
*
* @return void
*/
protected function add_actions() {
foreach ( $this->action_hooks as $hook ) {
add_action( $hook, array( $this, 'action_callback' ), $this->action_accepted_args, $this->action_priority );
}
}
/**
* Add custom subscriptions
*
* @since Unknown.
*
* @return void
*/
private function add_custom_subscriptions( $type ) {
$option = $this->get_option( $type . '_custom_subscribers' );
$subscribers = explode( ',', $option );
foreach ( $subscribers as $subscriber ) {
$subscriber = trim( $subscriber );
if ( $subscriber ) {
$this->subscribe( $subscriber, $type );
}
}
}
/**
* Adds subscribers before sending a notifications
*
* @since 3.8.0
* @since 5.2.0 Added parameter to only send notifications of specific types.
*
* @param null|string[] $filter_types Optional. Array of notification types to be sent. Default is `null`.
* When not provided (`null`) all the types.
* @return void
*/
private function add_subscriptions( $filter_types = null ) {
foreach ( array_keys( $this->get_supported_types() ) as $type ) {
if ( ! is_null( $filter_types ) && ! in_array( $type, $filter_types, true ) ) {
continue;
}
foreach ( $this->get_subscribers_settings( $type ) as $subscriber_key => $enabled ) {
if ( 'no' === $enabled ) {
continue;
} elseif ( 'custom' === $subscriber_key ) {
$this->add_custom_subscriptions( $type );
}
$subscriber = $this->get_subscriber( $subscriber_key );
if ( $subscriber ) {
$this->subscribe( $subscriber, $type );
}
}
}
}
/**
* Get a fake instance of a view, used for managing options & customization on the admin panel
*
* @since 3.8.0
*
* @param string $type Optional. Notification type. Default is 'basic'.
* @param int $subscriber Optional. Subscriber id. When not provided the current user id will be used.
* @param int $user_id Optional. User id. When not provided the current user id will be used.
* @param int $post_id Optional. Post id. When not provided the post_id (`$this->post_id`) associated with the notification will be used.
* @return LLMS_Abstract_Notification_View|false
*/
public function get_mock_view( $type = 'basic', $subscriber = null, $user_id = null, $post_id = null ) {
$notification = new LLMS_Notification();
$notification->set( 'type', $type );
$notification->set( 'subscriber', $subscriber ? $subscriber : get_current_user_id() );
$notification->set( 'user_id', $user_id ? $user_id : get_current_user_id() );
$notification->set( 'post_id', $post_id );
$notification->set( 'trigger_id', $this->id );
return llms()->notifications()->get_view( $notification );
}
/**
* Retrieve a prefix for options related to the notification
*
* This overrides the LLMS_Abstract_Options_Data method.
*
* @since 3.8.0
*
* @return string
*/
protected function get_option_prefix() {
return sprintf( '%1$snotification_%2$s_', $this->option_prefix, $this->id );
}
/**
* Retrieve get an array of subscriber options for the current notification by type
*
* @since 3.8.0
*
* @param string $type Notification type [basic|email].
* @return array
*/
public function get_subscriber_options( $type ) {
/**
* Filters the subscriber options
*
* The dynamic portion of this filter, `$this->id`, refers to the notification trigger identifier.
*
* @param array An array of subscriber options for this notification.
* @param string The notification type [basic|email].
* @param LLMS_Abstract_Notification_Controller The notification controller instance.
*/
return apply_filters( "llms_notification_{$this->id}_subscriber_options", $this->set_subscriber_options( $type ), $type, $this );
}
/**
* Get an array of saved subscriber settings prefilled with defaults for the current notification
*
* @since 3.8.0
*
* @param string $type Notification type [basic|email].
* @return array
*/
public function get_subscribers_settings( $type ) {
$defaults = wp_list_pluck( $this->get_subscriber_options( $type ), 'enabled', 'id' );
return $this->get_option( $type . '_subscribers', $defaults );
}
/**
* Get an array of prebuilt subscriber option settings for common subscriptions
*
* @since 3.8.0
* @since 3.30.3 Fixed typo in default description string.
*
* @param string $id Id of the subscriber type.
* @param string $enabled Optional. Whether or not the subscription should be enabled by default [yes|no]. Default is 'yes'.
* @return array
*/
public function get_subscriber_option_array( $id, $enabled = 'yes' ) {
$defaults = array(
'author' => array(
'title' => __( 'Author', 'lifterlms' ),
),
'student' => array(
'title' => __( 'Student', 'lifterlms' ),
),
'lesson_author' => array(
'title' => __( 'Lesson Author', 'lifterlms' ),
),
'course_author' => array(
'title' => __( 'Course Author', 'lifterlms' ),
),
'custom' => array(
'description' => __( 'Enter additional email addresses which will receive this notification. Separate multiple addresses with commas.', 'lifterlms' ),
'title' => __( 'Additional Recipients', 'lifterlms' ),
),
);
if ( isset( $defaults[ $id ] ) ) {
$arr = $defaults[ $id ];
$arr['id'] = $id;
$arr['enabled'] = $enabled;
return $arr;
}
}
/**
* Get a subscriptions array for a specific subscriber
*
* @since 3.8.0
*
* @param mixed $subscriber WP User ID, email address, etc...
* @return array
*/
public function get_subscriber_subscriptions( $subscriber ) {
$subscriptions = $this->get_subscriptions();
return isset( $subscriptions[ $subscriber ] ) ? $subscriptions[ $subscriber ] : array();
}
/**
* Retrieve subscribers
*
* @since 3.8.0
*
* @return array
*/
public function get_subscriptions() {
return $this->subscriptions;
}
/**
* Get an array of supported notification types
*
* @since 3.8.0
*
* @return array
*/
public function get_supported_types() {
/**
* Filters the supported notification types
*
* The dynamic portion of this filter, `$this->id`, refers to the notification trigger identifier.
*
* @param string[] An array of supported types for the notification.
* @param string The notification type [basic|email].
* @param LLMS_Abstract_Notification_Controller The notification controller instance.
*/
return apply_filters( "llms_notification_{$this->id}_supported_types", $this->set_supported_types(), $this );
}
/**
* Get an array of additional options to be added to the notification view in the admin panel
*
* @since 5.2.0
*
* @param string $type Type of the notification.
* @return array
*/
public function get_additional_options( $type ) {
/**
* Filters the notification additional options
*
* The dynamic portion of this filter, `$this->id`, refers to the notification trigger identifier.
*
* @param array An array of additional options for the notification.
* @param LLMS_Abstract_Notification_Controller The notification controller instance.
* @param string The notification type [basic|email].
*/
return apply_filters( "llms_notification_{$this->id}_additional_options", $this->set_additional_options( $type ), $this, $type );
}
/**
* Get an array of LifterLMS Admin Page settings to send test notifications
*
* @since 3.24.0
*
* @param string $type Notification type [basic|email].
* @return array
*/
public function get_test_settings( $type ) {
return array();
}
/**
* Determine if the notification is a potential duplicate.
*
* @since 3.11.0
* @since 6.0.0 Fixed how the protected {@see LLMS_Notifications_Query::$found_results} property is accessed.
* @since 7.1.0 Improve the query performance by fetching only one result.
*
* @param string $type Notification type id.
* @param mixed $subscriber WP User ID for the subscriber, email address, phone number, etc...
* @return boolean
*/
public function has_subscriber_received( $type, $subscriber ) {
$query = new LLMS_Notifications_Query(
array(
'post_id' => $this->post_id,
'subscriber' => $subscriber,
'types' => $type,
'trigger_id' => $this->id,
'user_id' => $this->user_id,
'per_page' => 1,
'no_found_rows' => true,
)
);
return $query->has_results();
}
/**
* Determine if the notification type support tests
*
* @since 3.24.0
*
* @param string $type Notification type [email|basic].
* @return bool
*/
public function is_testable( $type ) {
if ( empty( $this->testable[ $type ] ) ) {
return false;
}
return true;
}
/**
* Send all the subscriptions
*
* @since 3.8.0
* @since 3.11.0 Unknown.
* @since 5.2.0 Added parameter to only send notifications of specific types.
*
* @param bool $force Optional. If true, will force a send even if duplicates. Default is `false`.
* Only applies to controllers that flag $this->auto_dupcheck to true.
* @param null|string[] $filter_types Optional. Array of notification types to be sent. Default is `null`.
* When not provided (`null`) all the types.
* @return void
*/
public function send( $force = false, $filter_types = null ) {
$this->add_subscriptions( $filter_types );
foreach ( $this->get_subscriptions() as $subscriber => $types ) {
foreach ( $types as $type ) {
/**
* Filter to determine if a notification should be sent to a subscriber.
*
* @since 9.0.0
*/
if ( ! apply_filters( 'llms_send_notification_to_subscriber', true, $this, $subscriber, $type, $this->post_id ) ) {
continue;
}
$this->send_one( $type, $subscriber, $force );
}
}
/**
* Cleanup subscriptions so if the notification
* is triggered again we don't have incorrect subscribers
* on the next trigger.
* This happens when receipts are triggered in bulk by action scheduler.
*/
$this->unset_subscriptions();
}
/**
* Send a notification for a subscriber
*
* @since 3.8.0
* @since 3.24.0 Unknown.
*
* @param string $type Notification type id.
* @param mixed $subscriber WP User ID for the subscriber, email address, phone number, etc...
* @param bool $force Optional. If true, will force a send even if duplicates. Default is `false`.
* Only applies to controllers that flag $this->auto_dupcheck to true.
* @return int|false
*/
protected function send_one( $type, $subscriber, $force = false ) {
/**
* If autodupcheck is set
* and the send function doesn't override the dupcheck
* and the subscriber has already received the notification
* skip it.
*/
if ( $this->auto_dupcheck && ! $force && $this->has_subscriber_received( $type, $subscriber ) ) {
// phpcs:ignore -- commented out code
// llms_log( sprintf( 'Skipped %1$s to subscriber "%2$s" bc of dupcheck', $type, $subscriber ), 'notifications' );
return false;
}
$notification = new LLMS_Notification();
$id = $notification->create(
array(
'post_id' => $this->post_id,
'subscriber' => $subscriber,
'type' => $type,
'trigger_id' => $this->id,
'user_id' => $this->user_id,
)
);
// If successful, push to the processor where processing is supported.
if ( $id ) {
$processor = llms()->notifications()->get_processor( $type );
if ( $processor ) {
$processor->log( sprintf( 'Queuing %1$s notification ID #%2$d', $type, $id ) );
$processor->push_to_queue( $id );
llms()->notifications()->schedule_processing( $type );
}
}
return $id;
}
/**
* Send a test notification to the currently logged in users
*
* Extending classes should redefine this in order to properly setup the controller with post_id and user_id data.
* @since 3.24.0
*
* @param string $type Notification type [basic|email]
* @param array $data Optional. Array of test notification data as specified by $this->get_test_data(). Defalt is empty array.
* @return int|false
*/
public function send_test( $type, $data = array() ) {
return $this->send_one( $type, get_current_user_id(), true );
}
/**
* Determine what types are supported
*
* @since 3.8.0
*
* Extending classes can override this function in order to add or remove support.
* 3rd parties should add support via filter on $this->get_supported_types().
*
* @return array Associative array, keys are the ID/db type, values should be translated display types.
*/
protected function set_supported_types() {
return array(
'basic' => __( 'Popup', 'lifterlms' ),
'email' => __( 'Email', 'lifterlms' ),
);
}
/**
* Set additional options to be added to the notification view in the admin panel
*
* @since 5.2.0
*
* @param string $type Type of the notification.
* @return array
*/
protected function set_additional_options( $type ) {
return array();
}
/**
* Subscribe a user to a notification type
*
* @since 3.8.0
* @since 5.2.0 Use strict type comparison.
*
* @param mixed $subscriber WP User ID, email address, etc...
* @param string $type Identifier for a subscription type eg: basic.
* @return void
*/
public function subscribe( $subscriber, $type ) {
// Prevent unsupported types from being subscribed.
if ( ! $this->supports( $type ) ) {
return;
}
$subscriptions = $this->get_subscriber_subscriptions( $subscriber );
if ( ! in_array( $type, $subscriptions, true ) ) {
array_push( $subscriptions, $type );
}
$this->subscriptions[ $subscriber ] = $subscriptions;
}
/**
* Determine if a given notification type is supported
*
* @since 3.8.0
* @since 5.2.0 Use strict type comparison.
*
* @param string $type Notification type id.
* @return boolean
*/
public function supports( $type ) {
return in_array( $type, array_keys( $this->get_supported_types() ), true );
}
/**
* Reset the subscriptions array
*
* @since 3.8.0
*
* @return void
*/
public function unset_subscriptions() {
$this->subscriptions = array();
}
}
================================================
FILE: includes/abstracts/llms.abstract.notification.processor.php
================================================
<?php
/**
* LifterLMS Notification Background Processor Abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.8.0
* @version 6.10.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Notification Background Processor abstract class
*
* @since 3.8.0
* @since 3.38.0 Modified return of `dispatch()` override to return the return value of the parent method.
*/
abstract class LLMS_Abstract_Notification_Processor extends WP_Background_Process {
/**
* Enables event logging
*
* @var boolean
*/
private $enable_logging = true;
/**
* Constructor
*
* @since 3.8.0
* @version 3.8.0
*/
public function __construct() {
parent::__construct();
if ( ! defined( 'LLMS_NOTIFICATIONS_LOGGING' ) ) {
define( 'LLMS_NOTIFICATIONS_LOGGING', true );
}
$this->enable_logging = ( defined( 'LLMS_NOTIFICATIONS_LOGGING' ) && LLMS_NOTIFICATIONS_LOGGING );
}
/**
* Called when queue is emptied and action is complete
*
* @return void
* @since 3.8.0
* @version 3.8.0
*/
protected function complete() {
$this->log( sprintf( 'Processing for %s finished', $this->action ) );
parent::complete();
}
/**
* Starts the queue.
*
* @since 3.8.0
* @since 3.38.0 Added return from parent method.
* @since 6.10.1 Fixed malformed sprintf when logging dispatch errors.
*
* @return array|WP_Error Response from `wp_remote_post()`.
*/
public function dispatch() {
$this->log(
sprintf(
'Dispatching %s',
$this->action
)
);
$dispatched = parent::dispatch();
if ( is_wp_error( $dispatched ) ) {
$this->log(
sprintf(
'Unable to dispatch %1$s: %2$s',
$this->action,
$dispatched->get_error_message()
)
);
}
return $dispatched;
}
/**
* Handle cron healthcheck
*
* Restart the background process if not already running
* and data exists in the queue.
*
* Overridden to enable the "force" option to work, replaces "exit" with "return"
* so that we can redirect and manually call the cronjob
*
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function handle_cron_healthcheck() {
if ( $this->is_process_running() ) {
// Background process already running.
return;
}
if ( $this->is_queue_empty() ) {
// No data to process.
$this->clear_scheduled_event();
return;
}
$this->handle();
}
/**
* Returns true if the processor is running
*
* @return boolean
* @since 3.8.0
* @version 3.8.0
*/
public function is_processing() {
return ( false === $this->is_queue_empty() );
}
/**
* Log event data to an update file when logging enabled
*
* @param mixed $data data to log
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function log( $data ) {
if ( $this->enable_logging ) {
llms_log( $data, 'notifications' );
}
}
}
================================================
FILE: includes/abstracts/llms.abstract.notification.view.php
================================================
<?php
/**
* Notification View Abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.8.0
* @version 6.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Abstract_Notification_View class.
*
* @since 3.8.0
* @since 3.30.3 Explicitly define undefined properties.
* @since 3.31.0 Add filter on `$basic_options` class property.
* @since 3.37.19 Introduced the method `get_object()`. It'll allow extending classes
* defining the way the object associated to the notification should be retrieved.
* Use `in_array` with strict comparison where possible.
*/
abstract class LLMS_Abstract_Notification_View extends LLMS_Abstract_Options_Data {
/**
* Settings for basic notifications
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification
* before automatically dismissing it.
*/
'auto_dismiss' => 0,
/**
* Enables manual dismissal of notifications.
*/
'dismissible' => false,
);
/**
* @var string
* @since 3.8.0
*/
public $id;
/**
* Instance of the LLMS_Post_Model for the triggering post
*
* @var LLMS_Post_Model
*/
protected $post;
/**
* Supported fields for notification types
*
* @var array
*/
protected $supported_fields = array();
/**
* Notification Trigger ID
*
* @var int
*/
public $trigger_id;
/**
* Instance of the current LLMS_Notification
*
* @var LLMS_Notification
*/
protected $notification;
/**
* Instance of LLMS_Student for the subscriber
*
* @var LLMS_Student
*/
protected $subscriber;
/**
* Instance of an LLMS_Student for the triggering user
*
* @var LLMS_Student
*/
protected $user;
/**
* Merge codes.
*
* @var string[]
*/
protected $merge_codes;
/**
* Replace merge codes with actual values
*
* @since 3.8.0
*
* @param string $code The merge code to get merged data for.
* @return string
*/
abstract protected function set_merge_data( $code );
/**
* Setup body content for output
*
* @since 3.8.0
*
* @return string
*/
abstract protected function set_body();
/**
* Setup footer content for output
*
* @since 3.8.0
*
* @return string
*/
abstract protected function set_footer();
/**
* Setup notification icon for output
*
* @since 3.8.0
*
* @return string
*/
abstract protected function set_icon();
/**
* Setup merge codes that can be used with the notification
*
* @since 3.8.0
*
* @return array
*/
abstract protected function set_merge_codes();
/**
* Setup notification subject line for output
*
* @since 3.8.0
*
* @return string
*/
abstract protected function set_subject();
/**
* Setup notification title for output
*
* On an email the title acts as the "heading" element.
*
* @since 3.8.0
*
* @return string
*/
abstract protected function set_title();
/**
* Constructor
*
* @since 3.8.0
* @since 3.31.0 Add filter on `$basic_options` class class property.
* @since 3.37.19 Moved the retrieval of the associated llms post into a protected method.
* @since 5.0.0 Force [llms-user] shortocde to the user ID of the user who triggered the notification.
*
* @param mixed $notification Notification id, instance of LLMS_Notification
* or an object containing at least an 'id'.
* @return void
*/
public function __construct( $notification ) {
if ( is_numeric( $notification ) ) {
$this->id = $notification;
$this->notification = new LLMS_Notification( $notification );
} elseif ( is_a( $notification, 'LLMS_Notification' ) ) {
$this->id = $notification->get( 'id' );
$this->notification = $notification;
} elseif ( is_object( $notification ) && isset( $notification->id ) ) {
$this->id = $notification->id;
$this->notification = new LLMS_Notification( $notification->id );
}
$this->subscriber = new LLMS_Student( $this->notification->get( 'subscriber' ) );
$this->user = new LLMS_Student( $this->notification->get( 'user_id' ) );
$this->post = $this->get_object();
$this->basic_options = apply_filters( $this->get_filter( 'basic_options' ), $this->basic_options, $this );
add_filter( 'llms_user_info_shortcode_user_id', array( $this, 'set_shortcode_user' ) );
}
/**
* Destructor
*
* @since 5.0.0
*
* @return void
*/
public function __destruct() {
remove_filter( 'llms_user_info_shortcode_user_id', array( $this, 'set_shortcode_user' ) );
}
/**
* Set the user ID used by [llms-user] to the user triggering the notification.
*
* @since 5.0.0
*
* @param int $uid WP_User ID of the current user.
* @return int
*/
public function set_shortcode_user( $uid ) {
return $this->user->get( 'id' );
}
/**
* Get the object associated to the notification
*
* @since 3.37.19
*
* @return object
*/
protected function get_object() {
return llms_get_post( $this->notification->get( 'post_id' ), 'post' );
}
/**
* Get the html for a basic notification
*
* @since 3.8.0
*
* @return string
*/
private function get_basic_html() {
// Setup html classes.
$classes = array(
'llms-notification',
);
// Setup html attributes.
$attributes = array(
'id' => $this->id,
'trigger' => $this->trigger_id,
'type' => $this->notification->get( 'type' ),
);
if ( $this->basic_options['dismissible'] ) {
$classes[] = 'is-dismissible';
}
if ( $this->basic_options['auto_dismiss'] ) {
$classes[] = 'auto-dismiss';
$attributes['auto-dismiss'] = $this->basic_options['auto_dismiss'];
}
$atts = '';
foreach ( $attributes as $att => $val ) {
$atts .= sprintf( ' data-%1$s="%2$s"', $att, $val );
}
// Get variables.
$title = $this->get_title();
$icon = ( 'yes' === $this->get_option( 'icon_hide', 'no' ) ) ? '' : $this->get_icon_src();
$body = $this->get_body();
$footer = $this->get_footer();
ob_start();
llms_get_template(
'notifications/basic.php',
array(
'atts' => $atts,
'attributes' => $attributes,
'body' => $body,
'classes' => implode( ' ', $classes ),
'date' => $this->get_date_display( 5 ),
'dismissible' => $this->basic_options['dismissible'],
'footer' => $footer,
'icon' => $icon,
'id' => $this->id,
'status' => $this->notification->get( 'status' ),
'title' => $title,
)
);
$html = trim( preg_replace( '/\s+/S', ' ', ob_get_clean() ) );
return apply_filters( $this->get_filter( 'get_basic_html' ), $html, $this );
}
/**
* Retrieve the body for the notification
*
* @since 3.8.0
*
* @return string
*/
public function get_body( $merge = true ) {
$body = $this->get_option( 'body', apply_filters( $this->get_filter( 'set_body' ), $this->set_body(), $this ) );
if ( $merge ) {
$body = $this->get_merged_string( $body );
}
return apply_filters( $this->get_filter( 'get_body' ), wpautop( $body ), $this );
}
/**
* Retrieve a formatted date
*
* @since 3.8.0
*
* @param string $date Created or updated.
* @param string $format Valid PHP date format, defaults to WP date format options.
* @return string
*/
public function get_date( $date = 'created', $format = null ) {
if ( ! $format ) {
$format = get_option( 'date_format' ) . ' ' . get_option( 'time_format' );
}
return date_i18n( $format, strtotime( $this->notification->get( $date ) ) );
}
/**
* Get relative or absolute date
*
* Returns relative if relative date is less than $max_days
* otherwise returns the absolute date.
*
* @since 3.8.0
*
* @param int $max_days Max age of notification to display relative date for.
* @return string
*/
public function get_date_display( $max_days = 5 ) {
$now = current_time( 'timestamp' );
$created = $this->get_date( 'created', 'U' );
if ( ( $now - $created ) <= ( $max_days * DAY_IN_SECONDS ) ) {
/* translators: %s: Relative date display. */
return sprintf( _x( 'About %s ago', 'relative date display', 'lifterlms' ), $this->get_date_relative( 'created' ) );
}
return $this->get_date( 'created' );
}
/**
* Retrieve a date relative to the current time
*
* @since 3.8.0
*
* @param string $date Created or updated.
* @return string
*/
public function get_date_relative( $date = 'created' ) {
return llms_get_date_diff( current_time( 'timestamp' ), $this->get_date( $date, 'U' ), 1 );
}
/**
* Get the html for an email notification
*
* @since 3.28.2 Unknown.
*
* @return string
* @since 3.8.0
*/
private function get_email_html() {
return apply_filters( $this->get_filter( 'get_email_html' ), $this->get_body(), $this );
}
/**
* Get a filter hook string prefixed for the current view
*
* @since 3.8.0
*
* @param string $hook Hook name.
* @return string
*/
protected function get_filter( $hook ) {
return 'llms_notification_view' . $this->trigger_id . '_' . $hook;
}
/**
* Get an array of field-related options to be add to the notifications view config page on the admin panel
*
* @since 3.8.0
*
* @param string $type Type of the field.
* @return array
*/
public function get_field_options( $type ) {
$options = array();
if ( $this->has_field_support( $type, 'subject' ) ) {
$options[] = array(
'after_html' => llms_merge_code_button( '#' . $this->get_option_name( 'subject' ), false, $this->get_merge_codes() ),
'id' => $this->get_option_name( 'subject' ),
'title' => __( 'Subject', 'lifterlms' ),
'type' => 'text',
'value' => $this->get_subject( false ),
);
}
if ( $this->has_field_support( $type, 'title' ) ) {
$options[] = array(
'after_html' => llms_merge_code_button( '#' . $this->get_option_name( 'title' ), false, $this->get_merge_codes() ),
'id' => $this->get_option_name( 'title' ),
'title' => ( 'email' === $type ) ? __( 'Heading', 'lifterlms' ) : __( 'Title', 'lifterlms' ),
'type' => 'text',
'value' => $this->get_title( false ),
);
}
if ( $this->has_field_support( $type, 'body' ) ) {
$options[] = array(
'editor_settings' => array(
'teeny' => true,
),
'id' => $this->get_option_name( 'body' ),
'title' => __( 'Body', 'lifterlms' ),
'type' => 'wpeditor',
'value' => $this->get_body( false ),
);
}
if ( $this->has_field_support( $type, 'icon' ) ) {
$options[] = array(
'id' => $this->get_option_name( 'icon' ),
'image_size' => 'llms_notification_icon',
'title' => __( 'Icon', 'lifterlms' ),
'type' => 'image',
'value' => $this->get_icon(),
);
$options[] = array(
'default' => 'no',
'description' => __( 'When checked the icon will not be displayed when showing this notification.', 'lifterlms' ),
'id' => $this->get_option_name( 'icon_hide' ),
'title' => __( 'Disable Icon', 'lifterlms' ),
'type' => 'checkbox',
);
}
return apply_filters( $this->get_filter( 'get_field_options' ), $options, $this );
}
/**
* Retrieve the footer for the notification
*
* @since 3.8.0
*
* @return string
*/
public function get_footer() {
return apply_filters( $this->get_filter( 'get_footer' ), $this->set_footer(), $this );
}
/**
* Retrieve the full HTML to be output for the notification type
*
* @since 3.8.0
* @since 4.16.0 Pass `null` to the 3rd-party filter.
*
* @return string|WP_Error If the notification type is not supported, returns an error.
*/
public function get_html() {
$type = $this->notification->get( 'type' );
switch ( $type ) {
case 'email':
$html = $this->get_email_html();
break;
case 'basic':
$html = $this->get_basic_html();
break;
// 3rd party/custom types.
default:
$html = apply_filters( $this->get_filter( 'get_' . $type . '_html' ), null, $this );
}
return apply_filters( $this->get_filter( 'get_html' ), $html, $this );
}
/**
* Retrieve the icon id for the notification
*
* Returns an attachment id for the image.
*
* @since 3.8.0
*
* @return mixed
*/
public function get_icon() {
$icon = $this->get_option( 'icon', apply_filters( $this->get_filter( 'set_icon' ), $this->set_icon(), $this ) );
return apply_filters( $this->get_filter( 'get_icon' ), $icon, $this );
}
/**
* Retrieve a default icon for the notification based on the notification type
*
* @since 3.8.0
* @since 3.10.0 Unknown.
* @since 3.37.19 Use `in_array` with strict comparison.
*
* @param string $type Type of icon [positive|negative].
* @return string
*/
public function get_icon_default( $type ) {
if ( ! in_array( $type, array( 'negative', 'positive', 'warning' ), true ) ) {
$ret = '';
} else {
$ret = llms()->plugin_url() . '/assets/images/notifications/icon-' . $type . '.png';
}
return apply_filters( 'llms_notification_get_icon_default', $ret, $type, $this );
}
/**
* Retrieve the icon src for the notification
*
* @since 3.8.0
*
* @return string
*/
public function get_icon_src() {
$src = '';
$val = $this->get_icon();
if ( is_numeric( $val ) ) {
$src = wp_get_attachment_image_src( $val, 'llms_notification_icon' );
if ( is_array( $src ) ) {
$src = $src[0];
}
} else {
$src = $val;
}
return apply_filters( $this->get_filter( 'get_icon_src' ), $src, $this );
}
/**
* Get available merge codes for the current notification.
*
* @since 3.8.0
* @since 3.11.0 Unknown.
* @since 6.4.0 Cache merge codes.
*
* @return array
*/
public function get_merge_codes() {
if ( ! isset( $this->merge_codes ) ) {
$codes = array_merge( $this->get_merge_code_defaults(), $this->set_merge_codes() );
asort( $codes );
$this->merge_codes = $codes;
}
return apply_filters( $this->get_filter( 'get_merge_codes' ), $this->merge_codes, $this );
}
/**
* Get default merge codes available to all notifications of a given type
*
* @since 3.11.0
*
* @return array
*/
protected function get_merge_code_defaults() {
switch ( $this->notification->get( 'type' ) ) {
case 'email':
$codes = array(
'{{DIVIDER}}' => __( 'Divider Line', 'lifterlms' ),
);
break;
default:
$codes = array();
}
return $codes;
}
/**
* Merge a string.
*
* @since 3.8.0
* @since 3.37.19 Use `in_array` with strict comparison.
* @since 6.4.0 Only populate effectively used merged data.
*
* @param string $string An unmerged string.
* @return string
*/
private function get_merged_string( $string ) {
// Only merge if there are codes in the string.
if ( false !== strpos( $string, '{{' ) ) {
$merge_code_defaults = $this->get_merge_code_defaults();
foreach ( $this->get_used_merge_codes( $string ) as $code ) {
// Set defaults.
if ( array_key_exists( $code, $merge_code_defaults ) ) {
$func = 'set_merge_data_default';
// Set customs with extended class func.
} else {
$func = 'set_merge_data';
}
$string = str_replace( $code, $this->$func( $code ), $string );
}
}
return apply_filters( $this->get_filter( 'get_merged_string' ), $this->sentence_case( $string ), $this );
}
/**
* Retrieve merge codes used in a given string.
*
* @since 6.4.0
*
* @param string $string Text string whereto look for merge codes.
* @return array Returns a list of merge codes actually used in the passed string.
*/
private function get_used_merge_codes( $string ) {
return array_keys(
array_filter(
$this->get_merge_codes(),
function ( $code ) use ( $string ) {
return false !== strpos( $string, $code );
},
ARRAY_FILTER_USE_KEY
)
);
}
/**
* Access the protected notification object
*
* @since 3.18.2
*
* @return LLMS_Notification
*/
public function get_notification() {
return $this->notification;
}
/**
* Retrieve a prefix for options related to the notification
*
* This overrides the LLMS_Abstract_Options_Data method.
*
* @since 3.8.0
*
* @return string
*/
protected function get_option_prefix() {
return sprintf( '%1$snotification_%2$s_%3$s_', $this->option_prefix, $this->trigger_id, $this->notification->get( 'type' ) );
}
/**
* Retrieve the subject for the notification (if supported)
*
* @since 3.8.0
*
* @return string
*/
public function get_subject( $merge = true ) {
$subject = $this->get_option( 'subject', apply_filters( $this->get_filter( 'set_subject' ), $this->set_subject(), $this ) );
if ( $merge ) {
$subject = $this->get_merged_string( $subject );
}
return apply_filters( $this->get_filter( 'get_subject' ), $subject, $this );
}
/**
* Get supported fields and allow filtering for 3rd parties
*
* @since 3.8.0
*
* @return array
*/
public function get_supported_fields() {
return apply_filters( $this->get_filter( 'get_supported_fields' ), $this->set_supported_fields(), $this );
}
/**
* Retrieve the title for the notification
*
* @since 3.8.0
*
* @return string
*/
public function get_title( $merge = true ) {
$title = $this->get_option( 'title', apply_filters( $this->get_filter( 'set_title' ), $this->set_title(), $this ) );
if ( $merge ) {
$title = $this->get_merged_string( $title );
}
return apply_filters( $this->get_filter( 'get_title' ), $title, $this );
}
/**
* Determine if the current view supports a field by ID
*
* @since 3.8.0
*
* @param string $type Notification type [email|basic].
* @param string $field Field id.
* @return bool
*/
protected function has_field_support( $type, $field ) {
$fields = $this->get_supported_fields();
if ( ! isset( $fields[ $type ] ) ) {
return false;
}
$type_fields = $fields[ $type ];
if ( ! isset( $type_fields[ $field ] ) ) {
return false;
}
return $type_fields[ $field ];
}
/**
* Determine if the notification subscriber is the user who triggered the notification
*
* @since 3.8.0
*
* @return bool
*/
protected function is_for_self() {
return ( $this->subscriber->get_id() === $this->user->get_id() );
}
/**
* Convert a string to sentence case
*
* Useful for handling lowercased merged data like "you" which may appear at the beginning or middle of a sentence.
*
* @since 3.8.0
* @since 3.24.0 Unknown.
*
* @param string $string A string.
* @return string
*/
private function sentence_case( $string ) {
$sentences = preg_split( '/(\.|\?|\!)(\s|$)+/', $string, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE );
$new_string = '';
foreach ( $sentences as $sentence ) {
$new_string .= strlen( $sentence ) === 1 ? $sentence . ' ' : ucfirst( trim( $sentence ) );
}
return trim( $new_string );
}
/**
* Replace default merge codes with actual values
*
* @since 3.11.0
*
* @param string $code The merge code to get merged data for.
* @return string
*/
protected function set_merge_data_default( $code ) {
$mailer = llms()->mailer();
switch ( $code ) {
case '{{DIVIDER}}':
$code = $mailer->get_divider_html();
break;
}
return $code;
}
/**
* Define field support for the view
*
* Extending classes can override this
* 3rd parties should filter $this->get_supported_fields().
*
* @since 3.8.0
*
* @return array
*/
protected function set_supported_fields() {
return array(
'basic' => array(
'body' => true,
'title' => true,
'icon' => true,
),
'email' => array(
'body' => true,
'subject' => true,
'title' => true,
),
);
}
}
================================================
FILE: includes/abstracts/llms.abstract.notification.view.quiz.completion.php
================================================
<?php
/**
* Shared Notification View for quiz completions abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.24.0
* @version 7.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Shared Notification View for quiz completions abstract class
*
* @since 3.24.0
* @since 4.0.0 Remove usage of deprecated class `LLMS_Quiz_Legacy`.
*/
abstract class LLMS_Abstract_Notification_View_Quiz_Completion extends LLMS_Abstract_Notification_View {
/**
* Settings for basic notifications
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification
* before automatically dismissing it
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications
*/
'dismissible' => true,
);
/**
* Setup body for email notification
*
* @since 3.24.0
* @since 5.2.0 Build the table with mailer helper.
*
* @return string
*/
protected function set_body_email() {
$mailer = llms()->mailer();
$btn_style = $mailer->get_button_style();
$rows = array(
'STUDENT_NAME' => __( 'Student', 'lifterlms' ),
'QUIZ_TITLE' => __( 'Quiz', 'lifterlms' ),
'LESSON_TITLE' => __( 'Lesson', 'lifterlms' ),
'COURSE_TITLE' => __( 'Course', 'lifterlms' ),
'GRADE' => __( 'Grade', 'lifterlms' ),
'STATUS' => __( 'Status', 'lifterlms' ),
);
ob_start();
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Output is escaped by the mailer.
echo $mailer->get_table_html( $rows );
?>
<p><a href="{{REVIEW_URL}}" style="<?php echo esc_attr( $btn_style ); ?>"><?php esc_html_e( 'View the quiz attempt and leave remarks', 'lifterlms' ); ?></a></p>
<p><small><?php esc_html_e( 'Trouble clicking? Copy and paste this URL into your browser:', 'lifterlms' ); ?><br><a href="{{REVIEW_URL}}">{{REVIEW_URL}}</a></small></p>
<?php
return ob_get_clean();
}
/**
* Setup footer content for output
*
* @since 3.24.0
*
* @return string
*/
protected function set_footer() {
return '';
}
/**
* Setup merge codes that can be used with the notification
*
* @since 3.24.0
*
* @return array
*/
protected function set_merge_codes() {
return array(
'{{COURSE_PROGRESS}}' => __( 'Course Progress Bar', 'lifterlms' ),
'{{COURSE_TITLE}}' => __( 'Course Title', 'lifterlms' ),
'{{GRADE}}' => __( 'Grade', 'lifterlms' ),
'{{GRADE_BAR}}' => __( 'Grade Bar', 'lifterlms' ),
'{{LESSON_TITLE}}' => __( 'Lesson Title', 'lifterlms' ),
'{{QUIZ_TITLE}}' => __( 'Quiz Title', 'lifterlms' ),
'{{REVIEW_URL}}' => __( 'Review URL', 'lifterlms' ),
'{{STATUS}}' => __( 'Quiz Status', 'lifterlms' ),
'{{STUDENT_NAME}}' => __( 'Student Name', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values.
*
* @since 3.24.0
* @since 4.0.0 Remove usage of deprecated class `LLMS_Quiz_Legacy`.
* @since 7.8.0 Don't try to round nulls.
*
* @param string $code The merge code to get merged data for.
* @return string
*/
protected function set_merge_data( $code ) {
$quiz_id = $this->notification->get( 'post_id' );
$attempt = $this->user->quizzes()->get_last_completed_attempt( $quiz_id );
if ( ! $attempt ) {
return '';
}
$lesson = llms_get_post( $attempt->get( 'lesson_id' ) );
if ( ! $lesson ) {
return '';
}
switch ( $code ) {
case '{{COURSE_TITLE}}':
$course = $lesson->get_course();
if ( $course ) {
$code = $course->get( 'title' );
} else {
$code = '';
}
break;
case '{{GRADE}}':
$code = round( $attempt->get( 'grade' ) ?? 0, 2 ) . '%';
break;
case '{{GRADE_BAR}}':
$code = lifterlms_course_progress_bar( $attempt->get( 'grade' ), false, false, false );
break;
case '{{LESSON_TITLE}}':
$code = $lesson->get( 'title' );
break;
case '{{QUIZ_TITLE}}':
$code = get_the_title( $quiz_id );
break;
case '{{REVIEW_URL}}':
$code = add_query_arg(
array(
'tab' => 'quizzes',
'stab' => 'attempts',
'quiz_id' => $attempt->get( 'quiz_id' ),
'attempt_id' => $attempt->get( 'id' ),
),
admin_url( 'admin.php?page=llms-reporting' )
);
break;
case '{{STATUS}}':
$code = $attempt->l10n( 'status' );
break;
case '{{STUDENT_NAME}}':
$code = $this->is_for_self() ? __( 'you', 'lifterlms' ) : $this->user->get_name();
break;
}
return $code;
}
}
================================================
FILE: includes/abstracts/llms.abstract.options.data.php
================================================
<?php
/**
* LifterLMS Options Table Data Store abstract class
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.8.0
* @version 4.21.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Options Table Data Store abstract
*
* @since 3.8.0
*/
abstract class LLMS_Abstract_Options_Data {
/**
* Option name prefix.
*
* @var string
*/
protected $option_prefix = 'llms_';
/**
* Options data abstract version
*
* This is used to determine the behavior of the `get_option()` method.
*
* Concrete classes should use version 2 in order to use the new (future default)
* behavior of the method.
*
* @var int
*/
protected $version = 1;
/**
* Retrieve the value of an option from the database
*
* @since 3.8.0
* @since 4.21.0 Changed the behavior of the function when the concrete class defines `$this->version` greater than 1.
*
* @param string $name Option name (unprefixed).
* @param mixed $default Default value to use if no option is found.
* @return mixed The option value.
*/
public function get_option( $name, $default = false ) {
$full_name = $this->get_option_name( $name );
// If the class is version 1, use the old method.
if ( 1 === $this->version ) {
// If only one argument is passed switch the default to the old argument default (an empty string).
$default = 1 === func_num_args() ? '' : $default;
return $this->get_option_deprecated( $full_name, $default );
}
add_filter( "default_option_{$full_name}", array( $this, 'get_option_default_value' ), 10, 3 );
// Call this way so that the `$passed_default_value` of the filter is accurate based on the number of arguments actually passed.
$args = func_num_args() > 1 ? array( $full_name, $default ) : array( $full_name );
$val = get_option( ...$args );
remove_filter( "default_option_{$full_name}", array( $this, 'get_option_default_value' ), 10, 3 );
return $val;
}
/**
* Retrieve the value of an option from the database
*
* This is the "old" (to be deprecated) version of the function.
*
* We will transition extending classes little by little to use the new behavior and deprecate this once
* all classes are fully transitioned.
*
* @since 4.21.0
*
* @param string $name Full (prefixed) option name.
* @param mixed $default Default value to use if no option is found.
* @return mixed The option value.
*/
private function get_option_deprecated( $name, $default = '' ) {
$val = get_option( $name, '' );
if ( '' === $val ) {
return $default;
}
return $val;
}
/**
* Option default value autoloader
*
* By default, this method does nothing but extending classes can implement an autoloader to pull
* default values from other sources.
*
* This is a callback function for the WP core filter `default_option_{$option}`.
*
* @since 4.21.0
*
* @param mixed $default_value The default value. If no value is passed to `get_option()`, this will be an empty string.
* Otherwise it will be the default value passed to the method.
* @param string $full_option_name The full (prefixed) option name.
* @param bool $passed_default_value Whether or not a default value was passed to `get_option()`.
* @return mixed The default option value.
*/
public function get_option_default_value( $default_value, $full_option_name, $passed_default_value ) {
return $default_value;
}
/**
* Retrieve a prefix for options
*
* @since 3.8.0
*
* @return string
*/
protected function get_option_prefix() {
return $this->option_prefix;
}
/**
* Retrieve a prefixed option name from the database
* Prefix automatically adds a trigger and type to the option name
* in addition to llms_notification
*
* @since 3.8.0
*
* @param string $name Option name (unprefixed).
* @return string
*/
public function get_option_name( $name ) {
return $this->get_option_prefix() . $name;
}
/**
* Set the value of an option
*
* @since 3.17.8
*
* @param string $name Option name (unprefixed).
* @param mixed $value Option value.
* @return bool Returns `true` if option value has changed and `false` if no update or the update failed.
*/
public function set_option( $name, $value ) {
return update_option( $this->get_option_name( $name ), $value );
}
}
================================================
FILE: includes/abstracts/llms.abstract.post.data.php
================================================
<?php
/**
* Defines base methods and properties for querying data about LifterLMS Custom Post Types
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.31.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS Post Data abstract class
*
* @since 3.31.0
*/
abstract class LLMS_Abstract_Post_Data {
/**
* LLMS Post instance.
*
* @since 3.31.0
* @var LLMS_Post_Model
*/
protected $post;
/**
* LLMS Post ID.
*
* @since 3.31.0
* @var int
*/
protected $post_id;
/**
* @since 3.31.0
* @var array
*/
protected $dates = array();
/**
* Constructor.
*
* @since 3.31.0
*
* @param int $post_id WP Post ID of the LLMS Post.
*/
public function __construct( $post_id ) {
$this->post_id = $post_id;
$this->post = llms_get_post( $this->post_id );
}
/**
* Retrieve the instance of the LLMS_Post_Model.
*
* @since 3.31.0
*
* @return LLMS_Post_Model The instance of the LLMS_Post_Model.
*/
public function get_post() {
return $this->post;
}
/**
* Retrieve the LLMS_Post_Model ID.
*
* @since 3.31.0
*
* @return int The LLMS_Post_Model ID.
*/
public function get_post_id() {
return $this->post_id;
}
/**
* Allow dates and timestamps to be passed into various data functions.
*
* @since 3.31.0
*
* @param mixed $date A date string or timestamp.
* @return int The Unix timestamp of the given date.
*/
protected function strtotime( $date ) {
if ( ! is_numeric( $date ) ) {
$date = date( 'U', strtotime( $date ) );
}
return $date;
}
/**
* Retrieve a start or end date based on the period.
*
* @since 3.31.0
*
* @param string $period Period [current|previous].
* @param string $date The date type [start|end].
* @return string The start or end date in the format 'Y-m-d H:i:s'.
*/
protected function get_date( $period, $date ) {
return date( 'Y-m-d H:i:s', $this->dates[ $period ][ $date ] );
}
/**
* Retrieves the selected period from `$_GET` and validates it.
*
* If there is no period set or it's set to an invalid period, defaults to "today".
*
* @since 5.9.0
*
* @return string
*/
public function parse_period() {
$periods = LLMS_Admin_Reporting::get_period_filters();
$period = llms_filter_input( INPUT_GET, 'period' );
if ( ! $period || ! array_key_exists( $period, $periods ) ) {
$period = 'today';
}
return $period;
}
/**
* Set the dates passed on a date range period
*
* @since 3.31.0
*
* @param string $period Date range period.
* @return void
*/
public function set_period( $period = 'today' ) {
$now = current_time( 'timestamp' );
switch ( $period ) {
case 'all_time':
$curr_start = 0;
$curr_end = $now;
$prev_start = 0;
$prev_end = $now;
break;
case 'last_year':
$curr_start = strtotime( 'first day of january last year', $now );
$curr_end = strtotime( 'last day of december last year', $now );
$prev_start = strtotime( 'first day of january last year', $curr_start );
$prev_end = strtotime( 'last day of december last year', $curr_start );
break;
case 'year':
$curr_start = strtotime( 'first day of january this year', $now );
$curr_end = strtotime( 'last day of december this year', $now );
$prev_start = strtotime( 'first day of january last year', $now );
$prev_end = strtotime( 'last day of december last year', $now );
break;
case 'last_month':
$curr_start = strtotime( 'first day of previous month', $now );
$curr_end = strtotime( 'last day of previous month', $now );
$prev_start = strtotime( 'first day of previous month', $curr_start );
$prev_end = strtotime( 'last day of previous month', $curr_start );
break;
case 'month':
$curr_start = strtotime( 'first day of this month', $now );
$curr_end = strtotime( 'last day of this month', $now );
$prev_start = strtotime( 'first day of previous month', $now );
$prev_end = strtotime( 'last day of previous month', $now );
break;
case 'last_week':
$curr_start = strtotime( 'monday this week', $now - WEEK_IN_SECONDS );
$curr_end = $now;
$prev_start = strtotime( 'monday previous week', $curr_start - WEEK_IN_SECONDS );
$prev_end = $curr_start - DAY_IN_SECONDS;
break;
case 'week':
$curr_start = strtotime( 'monday this week', $now );
$curr_end = $now;
$prev_start = strtotime( 'monday previous week', $now );
$prev_end = $curr_start - DAY_IN_SECONDS;
break;
case 'yesterday':
$curr_start = $now - DAY_IN_SECONDS;
$curr_end = $curr_start;
$prev_start = $curr_start - DAY_IN_SECONDS;
$prev_end = $prev_start;
break;
case 'today':
default:
$curr_start = $now;
$curr_end = $now;
$prev_start = $now - DAY_IN_SECONDS;
$prev_end = $prev_start;
}// End switch().
$this->dates = array(
'current' => array(
'start' => strtotime( 'midnight', $curr_start ),
'end' => strtotime( 'tomorrow', $curr_end ) - 1,
),
'previous' => array(
'start' => strtotime( 'midnight', $prev_start ),
'end' => strtotime( 'tomorrow', $prev_end ) - 1,
),
);
}
/**
* Retrieve recent LLMS_User_Postmeta for the quiz
*
* @since 3.31.0
*
* @param array $args {
* Optional. An array of arguments to feed the LLMS_Query_User_Postmeta with.
*
* @type int $per_page The number of posts to query for. Default 10.
* @type array|string $types Array of strings for the type of events to fetch, or a string to fetch them all. Default 'all'.
* @see LLMS_Query_User_Postmeta::parse_args()
* }
* @return array Array of LLMS_User_Postmetas.
*/
public function recent_events( $args = array() ) {
$query_args = wp_parse_args(
$args,
array(
'per_page' => 10,
'types' => 'all',
)
);
$query_args['post_id'] = $this->post_id;
$query_args['no_found_rows'] = true;
$query = new LLMS_Query_User_Postmeta( $query_args );
return $query->get_metas();
}
}
================================================
FILE: includes/abstracts/llms.abstract.privacy.php
================================================
<?php
/**
* LifterLMS Privacy Export / Eraser Abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.18.0
* @version 3.18.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Privacy Export / Eraser abstract class.
*
* Thanks WooCommerce.
*
* @since 3.18.0
*/
abstract class LLMS_Abstract_Privacy {
/**
* Plugin name.
*
* @var string
*/
public $name;
/**
* Registered erasers.
*
* @var array
*/
protected $erasers = array();
/**
* Registered exporters.
*
* @var array
*/
protected $exporters = array();
/**
* Constructor.
*
* @since 3.18.0
*
* @param string $name Plugin name.
* @return void
*/
public function __construct( $name = '' ) {
$this->name = $name;
$this->add_hooks();
}
/**
* Add filters for the registered exporters & erasers.
*
* @since 3.18.0
*
* @return void
*/
protected function add_hooks() {
add_action( 'admin_init', array( $this, 'add_privacy_message' ) );
add_filter( 'wp_privacy_personal_data_erasers', array( $this, 'register_erasers' ) );
add_filter( 'wp_privacy_personal_data_exporters', array( $this, 'register_exporters' ), 5 );
}
/**
* Add privacy message sample content.
*
* @since 3.18.0
*
* @return void
*/
public function add_privacy_message() {
if ( function_exists( 'wp_add_privacy_policy_content' ) ) {
$content = $this->get_privacy_message();
if ( $content ) {
wp_add_privacy_policy_content( $this->name, $this->get_privacy_message() );
}
}
}
/**
* Get the privacy message sample content.
*
* This stub can be overloaded.
*
* @since 3.18.0
*
* @return string
*/
public function get_privacy_message() {
return '';
}
/**
* Retrieve an instance of an LLMS_Student from email address.
*
* @since 3.18.0
*
* @param string $email Email address.
* @return false|LLMS_Student
*/
protected static function get_student_by_email( $email ) {
$user = get_user_by( 'email', $email );
if ( is_a( $user, 'WP_User' ) ) {
return llms_get_student( $user );
}
return false;
}
/**
* Add all registered erasers to the array of existing erasers.
*
* @filter wp_privacy_personal_data_erasers
*
* @since 3.18.0
*
* @param array $erasers Existing erasers.
* @return array
*/
public function register_erasers( $erasers = array() ) {
foreach ( $this->erasers as $id => $eraser ) {
$erasers[ $id ] = $eraser;
}
return $erasers;
}
/**
* Add all registered erasers to the array of existing exporters.
*
* @filter wp_privacy_personal_data_exporters
*
* @since 3.18.0
*
* @param array $exporters Existing exporters.
* @return array
*/
public function register_exporters( $exporters = array() ) {
foreach ( $this->exporters as $id => $exporter ) {
$exporters[ $id ] = $exporter;
}
return $exporters;
}
/**
* Register an eraser.
*
* @since 3.18.0
*
* @param string $id Eraser ID.
* @param string $name Human-readable eraser name.
* @param mixed $callback Callback function (callable).
* @return array
*/
public function add_eraser( $id, $name, $callback ) {
$this->erasers[ $id ] = array(
'eraser_friendly_name' => $name,
'callback' => $callback,
);
return $this->erasers;
}
/**
* Register an exporter.
*
* @since 3.18.0
*
* @param string $id Exporter ID.
* @param string $name Human-readable exporter name.
* @param callable $callback Callback function.
* @return array
*/
public function add_exporter( $id, $name, $callback ) {
$this->exporters[ $id ] = array(
'exporter_friendly_name' => $name,
'callback' => $callback,
);
return $this->exporters;
}
}
================================================
FILE: includes/abstracts/llms.abstract.processor.php
================================================
<?php
/**
* Background Processor abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.15.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Background Processor abstract class
*
* @since 3.15.0
*/
abstract class LLMS_Abstract_Processor extends WP_Background_Process {
/**
* Prefix
*
* @var string
*/
protected $prefix = 'llms';
/**
* Unique identifier for the processor
*
* @var string
*/
protected $id;
/**
* Initializer
*
* Acts as a constructor that extending processors should implement
* at the very least should populate the $this->actions array.
*
* @since 3.15.0
*
* @return void
*/
abstract protected function init();
/**
* Array of actions that should be watched to trigger
* the process(es)
*
* @var array
*/
protected $actions = array();
/**
* Constructor
*
* @since 3.15.0
*
* @return void
*/
public function __construct() {
$this->action .= '_' . $this->id;
parent::__construct();
// Setup.
$this->init();
// Add trigger actions.
$this->add_actions();
}
/**
* Add actions defined in $this->actions
*
* @since 3.15.0
*
* @return void
*/
public function add_actions() {
foreach ( $this->get_actions() as $action => $data ) {
$data = wp_parse_args(
$data,
array(
'arguments' => 1,
'priority' => 10,
)
);
add_action( $action, array( $this, $data['callback'] ), $data['priority'], $data['arguments'] );
}
}
/**
* Disable a processor
*
* Useful when bulk enrolling into a membership (for example)
* so we don't trigger course data calculations a few hundred times.
*
* @since 3.15.0
*
* @return void
*/
public function disable() {
remove_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) );
foreach ( $this->get_actions() as $action => $data ) {
$data = wp_parse_args(
$data,
array(
'arguments' => 1,
'priority' => 10,
)
);
remove_action( $action, array( $this, $data['callback'] ), $data['priority'], $data['arguments'] );
}
}
/**
* Dispatch
*
* Overrides the parent method to reset the (saved) `$data` property and
* prevent duplicate data being pushed into future batches.
*
* @since 4.21.0
*
* @return array|WP_Error Result of wp_remote_post()
*/
public function dispatch() {
// Perform the parent method.
$ret = parent::dispatch();
/**
* Empty the (saved) data to prevent duplicate data in future batches.
*
* @link https://github.com/gocodebox/lifterlms/issues/1602
*/
$this->data = array();
return $ret;
}
/**
* Retrieve a filtered array of actions to be added by $this->add_actions
*
* @since 3.15.0
*
* @return array
*/
private function get_actions() {
return apply_filters( 'llms_data_processor_' . $this->id . '_actions', $this->actions, $this );
}
/**
* Retrieve data for the current processor that can be used
* in future processes
*
* @since 3.15.0
*
* @param string $key If set, return a specific piece of data rather than the whole array.
* @param string $default When returning a specific piece of data, allows a default value to be passed.
* @return array|mixed
*/
public function get_data( $key = null, $default = '' ) {
// Get the array of processor data.
$all_data = get_option( 'llms_processor_data', array() );
// Get data for current processor.
$data = isset( $all_data[ $this->id ] ) ? $all_data[ $this->id ] : array();
// Get a specific piece of data.
if ( $key ) {
return isset( $data[ $key ] ) ? $data[ $key ] : $default;
}
// Return all the data.
return $data;
}
/**
* Returns the edit post link for a post.
*
* This is based on the WordPress {@see get_edit_post_link()} function, but does not check if the user can
* edit the post or if the post's post type has an edit link defined.
*
* When the background processor is running, the current user ID is 0. This prevents {@see current_user_can()}
* from ever returning true and also causes the post's post type edit link to be set to an empty string in
* {@see WP_Post_Type::set_props()}.
*
* This method is useful when the processor has completed and creates an admin notice that contains an edit post link.
*
* @since 6.0.0
*
* @param int|WP_Post $id Optional. Post ID or post object. Default is the global `$post`.
* @param string $context Optional. How to output the '&' character. Default '&'.
* @return string|null The edit post link for the given post. Null if the post type does not exist
* or does not allow an editing UI.
*/
protected function get_edit_post_link( $id = 0, $context = 'display' ) {
$post = get_post( $id );
if ( ! $post ) {
return null;
}
$post_type_object = get_post_type_object( $post->post_type );
if ( ! $post_type_object ) {
return null;
}
if ( 'revision' === $post->post_type ) {
$action = '';
} elseif ( 'display' === $context ) {
$action = '&action=edit';
} else {
$action = '&action=edit';
}
$link = admin_url( sprintf( 'post.php?post=%d%s', $post->ID, $action ) );
/**
* Filters the post edit link.
*
* This is identical to the `get_edit_post_link` filter hook in {@see get_edit_post_link()}.
*
* @since 6.0.0
*
* @param string $link The edit link.
* @param int $post_id Post ID.
* @param string $context The link context. If set to 'display' then ampersands are encoded.
*/
return apply_filters( 'get_edit_post_link', $link, $post->ID, $context );
}
/**
* Log data to the processors log when processors debugging is enabled
*
* @since 3.15.0
*
* @param mixed $data Data to log.
* @return void
*/
protected function log( $data ) {
if ( defined( 'LLMS_PROCESSORS_DEBUG' ) && LLMS_PROCESSORS_DEBUG ) {
llms_log( $data, 'processors' );
}
}
/**
* Persist data to the database related to the processor
*
* @since 3.15.0
*
* @param array $data Data to save.
* @return void
*/
private function save_data( $data ) {
// Merge the current data with all processor data.
$all_data = wp_parse_args(
array(
$this->id => $data,
),
get_option( 'llms_processor_data', array() )
);
// Save it.
update_option( 'llms_processor_data', $all_data );
}
/**
* Update data to the database related to the processor
*
* @since 3.15.0
*
* @param string $key Key name.
* @param mixed $value Value.
* @return void
*/
public function set_data( $key, $value ) {
// Get the array of processor data.
$data = $this->get_data();
$data[ $key ] = $value;
$this->save_data( $data );
}
/**
* Delete a piece of data from the database by key
*
* @since 3.15.0
*
* @param string $key Key name to remove.
* @return void
*/
public function unset_data( $key ) {
$data = $this->get_data();
if ( isset( $data[ $key ] ) ) {
unset( $data[ $key ] );
}
$this->save_data( $data );
}
}
================================================
FILE: includes/abstracts/llms.abstract.user.data.php
================================================
<?php
/**
* LifterLMS User Data Abstract
*
* @package LifterLMS/Abstracts/Classes
*
* @since 3.9.0
* @version 4.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS User Data Abstract class
*
* @since 3.9.0
* @since 3.17.0 Unknown.
* @since 3.34.0 Allow `user_url` to be retrieved by `get()`.
* @since 4.2.0 The `get_id()` always returns an int.
*/
abstract class LLMS_Abstract_User_Data {
/**
* Student's WordPress User ID
*
* @var int
*/
protected $id;
/**
* User postmeta key prefix
*
* @var string
*/
protected $meta_prefix = 'llms_';
/**
* Instance of the WP_User
*
* @var obj
*/
protected $user;
/**
* Constructor.
*
* By default, the current user is loaded if no `$user` is supplied. This behavior can be disabled by providing `$autoload = false`.
*
* @since 2.2.3
* @since 3.9.0 Unknown.
* @since 7.0.0 Added `$autoload` parameter.
*
* @param int|null|WP_User|LLMS_Abstract_User_Data $user A `WP_User` ID, instance of a `WP_User`, or instance of any class extending this class.
* @param boolean $autoload If `true` and `$user` input is empty, the user will be loaded from `get_current_user_id()`.
* If `$user` is not empty then this parameter has no impact.
* @return void
*/
public function __construct( $user = null, $autoload = true ) {
$user = ( $user || $autoload ) ? $this->get_user_id( $user ) : false;
if ( false !== $user ) {
$this->id = $user;
$this->user = get_user_by( 'ID', $user );
}
}
/**
* Magic Getter for User Data
*
* Mapped directly to the WP_User class.
*
* @since 3.0.0
* @since 3.10.1 Unknown.
* @since 3.34.0 Allow `user_url` to be retrieved.
*
* @param string $key key of the property to get a value for
* @return mixed
*/
public function __get( $key ) {
// Array of items we should *not* add the $this->meta_prefix to.
$unprefixed = apply_filters(
'llms_student_unprefixed_metas',
array(
'description',
'display_name',
'first_name',
'last_name',
'nickname',
'user_login',
'user_nicename',
'user_email',
'user_registered',
'user_url',
),
$this
);
/**
* Add the meta prefix to things that aren't in the above array
* only if the meta prefix isn't already there
* this means that the following will output the same data
* $this->get( 'llms_billing_address_1')
* $this->get( 'billing_address_1')
*/
if ( false === strpos( $key, $this->meta_prefix ) && ! in_array( $key, $unprefixed ) ) {
$key = $this->meta_prefix . $key;
}
if ( ! $this->exists() ) {
return '';
}
return apply_filters( 'llms_get_student_meta_' . $key, $this->user->get( $key ), $this );
}
/**
* Retrieve an item from the cache
*
* @param string $key cache key
* @return false|mixed false on failure
* @since 3.17.0
* @version 3.17.0
*/
protected function cache_get( $key ) {
return wp_cache_get( $key, $this->get_cache_group() );
}
/**
* Delete an item from the cache
*
* @param string $key cache key
* @return bool
* @since 3.17.0
* @version 3.17.0
*/
protected function cache_delete( $key ) {
return wp_cache_delete( $key, $this->get_cache_group() );
}
/**
* Add an item to the cache cache
*
* @param string $key cache key
* @param mixed $val value to cache
* @return boolean
* @since 3.17.0
* @version 3.17.0
*/
protected function cache_set( $key, $val ) {
return wp_cache_set( $key, $val, $this->get_cache_group() );
}
/**
* Determine if the user exists
*
* @return boolean
* @since 3.9.0
* @version 3.9.0
*/
public function exists() {
return ( $this->user && $this->user->exists() );
}
/**
* Allows direct access to WP_User object for retrieving user data from the user or usermeta tables
*
* @since 3.0.0
* @version 3.0.0
* @param string $key key of the property to get a value for
* @return mixed
*/
public function get( $key ) {
return $this->$key;
}
/**
* Retrieve the group name used by cache functions
*
* @return string
* @since 3.17.0
* @version 3.17.0
*/
protected function get_cache_group() {
return sprintf( 'llms_user_%d', $this->get( 'id' ) );
}
/**
* Retrieve the user id
*
* @since 3.9.0
* @since 4.2.0 Always return an absolute integer.
*
* @return int
*/
public function get_id() {
return absint( $this->id );
}
/**
* Allow extending classes to access the main student class
*
* @return LLMS_Student|false
* @since 3.9.0
* @version 3.9.0
*/
protected function get_student() {
return llms_get_student( $this->get_id() );
}
/**
* Retrieve the instance of the WP User for the student
*
* @return WP_User
* @since 3.9.0
* @version 3.9.0
*/
public function get_user() {
return $this->user;
}
/**
* Retrieve the User ID based on object
*
* @param mixed $user WP_User ID, instance of WP_User, or instance of any student class extending this class
* @return mixed int if a user id can be found, otherwise false
* @since 3.9.0
* @version 3.9.0
*/
protected function get_user_id( $user ) {
if ( ! $user && get_current_user_id() ) {
return get_current_user_id();
} elseif ( is_numeric( $user ) ) {
return $user;
} elseif ( is_a( $user, 'WP_User' ) && isset( $user->ID ) ) {
return $user->ID;
} elseif ( $user instanceof LLMS_Abstract_User_Data ) {
return $user->get_id();
}
return false;
}
/**
* Update a meta property for the user
*
* @param string $key meta key
* @param mixed $value meta value
* @param boolean $prefix include the meta prefix when setting
* passing false will allow 3rd parties to update fields with a custom prefix
* @since 3.2.0
* @version 3.2.0
*/
public function set( $key, $value, $prefix = true ) {
$key = $prefix ? $this->meta_prefix . $key : $key;
update_user_meta( $this->get_id(), $key, $value );
}
}
================================================
FILE: includes/achievements/class.llms.achievement.user.php
================================================
<?php
/**
* User Achievement class, inherits methods from LLMS_Achievement
*
* Generates achievements for users.
*
* @package LifterLMS/Classes/Achievements
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Achievement_User class
*
* @since 1.0.0
* @since 3.17.4 Unknown.
* @since 3.24.0 Unknown.
* @since 3.30.3 Explicitly define undefined properties.
* @deprecated 6.0.0 Class `LLMS_Achievement_User` is deprecated with no direct replacement.
*/
class LLMS_Achievement_User extends LLMS_Achievement {
/**
* @var string|false
* @since 1.0.0
*/
public $account_link;
/**
* @var string
* @since 1.0.0
*/
public $recipient;
/**
* partial path and file name of HTML template
*
* @var string
* @since 1.0.0
*/
public $template_html;
/**
* user meta fields
*
* @var array
* @since 1.0.0
*/
public $user = array();
/**
* @var WP_User|false
* @since 1.0.0
*/
public $user_data;
/**
* @var string
* @since 1.0.0
*/
public $user_email;
/**
* @var string
* @since 1.0.0
*/
public $user_firstname;
/**
* @var string
* @since 1.0.0
*/
public $user_lastname;
/**
* @var string
* @since 1.0.0
*/
public $user_login;
/**
* @var string
* @since 1.0.0
*/
public $user_pass;
/**
* Alert when deprecated methods are used.
*
* This class as well as core classes extending it have been deprecated. All public and protected methods
* have been changed to private and will be made accessible through this magic method which also emits a
* deprecation warning.
*
* This public method has been intentionally marked as private to denote it's temporary lifespan. It will be
* removed alongside this class in the next major release.
*
* @since 6.0.0
*
* @access private
*
* @param string $name Name of the method being called.
* @param array $args Arguments provided to the method.
* @return void
*/
public function __call( $name, $args ) {
_deprecated_function( __CLASS__ . '::' . esc_html( $name ), '6.0.0' );
if ( method_exists( $this, $name ) ) {
$this->$name( ...$args );
}
}
/**
* Constructor
*/
public function __construct() {
parent::__construct();
}
/**
* Check if the user has already earned this achievement used to prevent duplicates
*
* @since 3.4.1
* @since 3.17.4 Unknown.
* @deprecated 6.0.0 `LLMS_Achievement_User::has_user_earned()` is deprecated with no replacement.
*
* @return boolean
*/
private function has_user_earned() {
global $wpdb;
$count = (int) $wpdb->get_var(
$wpdb->prepare(
"
SELECT COUNT( pm.meta_id )
FROM {$wpdb->postmeta} AS pm
JOIN {$wpdb->prefix}lifterlms_user_postmeta AS upm ON pm.post_id = upm.meta_value
WHERE pm.meta_key = '_llms_achievement_template'
AND pm.meta_value = %d
AND upm.meta_key = '_achievement_earned'
AND upm.user_id = %d
AND upm.post_id = %d
LIMIT 1
;",
array( $this->achievement_template_id, $this->userid, $this->lesson_id )
)
);
/**
* @filter llms_achievement_has_user_earned
* Allow 3rd parties to override default dupcheck functionality for achievements
*/
return apply_filters( 'llms_achievement_has_user_earned', ( $count >= 1 ), $this );
}
/**
* Initializes all of the variables needed to create the achievement post.
*
* @since 1.0.0
* @since 3.24.0 Unknown.
* @deprecated 6.0.0 `LLMS_Achievement_User::init()` is deprecated with no replacement.
*
* @param int $id Id of post.
* @param int $person_id Id of user.
* @param int $lesson_id Id of associated lesson.
* @return void
*/
private function init( $id, $person_id, $lesson_id ) {
global $wpdb;
$content = get_post( $id );
$meta = get_post_meta( $content->ID );
$this->achievement_template_id = $id;
$this->lesson_id = $lesson_id;
$this->title = $content->post_title;
$this->achievement_title = $meta['_llms_achievement_title'][0];
$this->content = ( ! empty( $content->post_content ) ) ? $content->post_content : $meta['_llms_achievement_content'][0];
$this->image = $meta['_llms_achievement_image'][0];
$this->userid = $person_id;
$this->user = get_user_meta( $person_id );
$this->user_data = get_userdata( $person_id );
$this->user_firstname = ( '' != $this->user['first_name'][0] ? $this->user['first_name'][0] : $this->user['nickname'][0] );
$this->user_lastname = ( '' != $this->user['last_name'][0] ? $this->user['last_name'][0] : '' );
$this->user_email = $this->user_data->data->user_email;
$this->template_html = 'achievements/template.php';
$this->account_link = get_permalink( llms_get_page_id( 'myaccount' ) );
}
/**
* Creates new instance of WP_User and calls parent method create
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Achievement_User::trigger()` is deprecated with no replacement.
*
* @param int $user_id ID of user.
* @param int $id ID of post.
* @param int $lesson_id ID of associated lesson.
* @return void
*/
private function trigger( $user_id, $id, $lesson_id ) {
$this->init( $id, $user_id, $lesson_id );
// Only award achievement if the user hasn't already earned it.
if ( $this->has_user_earned() ) {
return;
}
if ( $user_id ) {
$this->object = new WP_User( $user_id );
$this->user_login = stripslashes( $this->object->user_login );
$this->user_email = stripslashes( $this->object->user_email );
$this->recipient = $this->user_email;
}
if ( ! $this->is_enabled() ) {
return;
}
$this->create( $this->get_content() );
}
/**
* Gets post content and replaces merge fields with user meta-data
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Achievement_User::get_content_html()` is deprecated with no replacement.
*
* @return string
*/
private function get_content_html() {
$this->find = array(
'{site_title}',
'{user_login}',
'{site_url}',
'{first_name}',
'{last_name}',
'{email_address}',
'{current_date}',
);
$this->replace = array(
$this->get_blogname(),
$this->user_login,
$this->account_link,
$this->user_firstname,
$this->user_lastname,
$this->user_email,
date( 'M d, Y', strtotime( current_time( 'mysql' ) ) ),
);
$content = $this->format_string( $this->content );
ob_start();
llms_get_template(
$this->template_html,
array(
'content' => $this->content,
'title' => $this->format_string( $this->title ),
'image' => $this->image,
)
);
return ob_get_clean();
}
}
return new LLMS_Achievement_User();
================================================
FILE: includes/achievements/index.php
================================================
<?php // quiet.
================================================
FILE: includes/admin/class-llms-admin-events-promo.php
================================================
<?php
/**
* Lightweight Events add-on promotion in the LifterLMS core admin.
*
* Shows an "Events" tab in Course Options and Membership meta boxes
* with a CTA to install the Events add-on when it is not active.
*
* Also adds an "Events" link in Course Builder lesson settings.
*
* @package LifterLMS/Admin/Classes
*
* @since 7.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Events_Promo class.
*
* @since 7.8.0
*/
class LLMS_Admin_Events_Promo {
/**
* Constructor.
*
* @since 7.8.0
*/
public function __construct() {
// Only show promo if the events plugin is not active.
if ( class_exists( 'LLMS_Events_Plugin' ) ) {
return;
}
add_filter( 'llms_metabox_fields_lifterlms_course_options', array( $this, 'add_course_promo_tab' ) );
add_filter( 'llms_metabox_fields_lifterlms_membership', array( $this, 'add_membership_promo_tab' ) );
add_filter( 'llms_metabox_fields_lifterlms_lesson', array( $this, 'add_lesson_promo_tab' ) );
}
/**
* Add an Events promo tab to Course Options.
*
* @since 7.8.0
*
* @param array $tabs Existing tabs.
* @return array
*/
public function add_course_promo_tab( $tabs ) {
$tabs[] = array(
'title' => __( 'Events', 'lifterlms' ),
'fields' => array(
array(
'id' => '_llms_events_promo',
'type' => 'custom-html',
'label' => '',
'value' => $this->get_promo_html(),
),
),
);
return $tabs;
}
/**
* Add an Events promo tab to Membership.
*
* @since 7.8.0
*
* @param array $tabs Existing tabs.
* @return array
*/
public function add_membership_promo_tab( $tabs ) {
$tabs[] = array(
'title' => __( 'Events', 'lifterlms' ),
'fields' => array(
array(
'id' => '_llms_events_promo',
'type' => 'custom-html',
'label' => '',
'value' => $this->get_promo_html(),
),
),
);
return $tabs;
}
/**
* Add an Events promo tab to Lesson Settings.
*
* @since 7.8.0
*
* @param array $tabs Existing tabs.
* @return array
*/
public function add_lesson_promo_tab( $tabs ) {
$tabs[] = array(
'title' => __( 'Events', 'lifterlms' ),
'fields' => array(
array(
'id' => '_llms_events_promo',
'type' => 'custom-html',
'label' => '',
'value' => $this->get_promo_html(),
),
),
);
return $tabs;
}
/**
* Get the promo HTML.
*
* @since 7.8.0
*
* @return string
*/
private function get_promo_html() {
$html = '<div class="llms-metabox" style="padding:20px;text-align:center;">';
$html .= '<div class="dashicons dashicons-calendar-alt" style="color:#2271b1;margin-bottom:12px;"></div>';
$html .= '<h3>' . esc_html__( 'Schedule Events for Your Students', 'lifterlms' ) . '</h3>';
$html .= '<p>' . esc_html__( 'Add live events, webinars, and in-person sessions to your courses and memberships. Students can subscribe to calendar feeds and never miss an event.', 'lifterlms' ) . '</p>';
$html .= '<a href="https://lifterlms.com/product/lifterlms-events/?utm_source=LifterLMS%20Plugin&utm_medium=Course%20Editor&utm_campaign=Events%20Promo" target="_blank" class="llms-button-primary">';
$html .= esc_html__( 'Get LifterLMS Events', 'lifterlms' );
$html .= '</a>';
$html .= '</div>';
return $html;
}
}
new LLMS_Admin_Events_Promo();
================================================
FILE: includes/admin/class-llms-admin-export-download.php
================================================
<?php
/**
* Serves Export CSVs on the admin panel
*
* @package LifterLMS/Admin/Classes
*
* @since 3.28.1
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Export_Download class
*
* @since 3.28.1
*/
class LLMS_Admin_Export_Download {
/**
* Constructor.
*
* @since 3.28.1
* @version 3.28.1
*/
public function __construct() {
add_action( 'admin_init', array( $this, 'maybe_serve_export' ) );
}
/**
* Serve an export file as a download.
*
* @since 3.28.1
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 7.5.0 Check nonce and only consider the basename of the file to be downloaded.
*
* @return void
*/
public function maybe_serve_export() {
$export = llms_filter_input( INPUT_GET, 'llms-dl-export', FILTER_SANITIZE_FULL_SPECIAL_CHARS );
if ( ! $export ) {
return;
}
// Verify nonce.
if ( ! isset( $_REQUEST['llms_dl_export_nonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['llms_dl_export_nonce'] ) ), LLMS_Abstract_Exportable_Admin_Table::EXPORT_NONCE_ACTION ) ) {
wp_die( esc_html__( 'Cheatin’ huh?', 'lifterlms' ) );
}
// Only allow people who can view reports view exports.
if ( ! current_user_can( 'view_others_lifterlms_reports' ) && ! current_user_can( 'view_lifterlms_reports' ) ) {
wp_die( esc_html__( 'Cheatin’ huh?', 'lifterlms' ) );
}
$path = LLMS_TMP_DIR . basename( $export );
if ( ! file_exists( $path ) ) {
wp_die( esc_html__( 'Cheatin’ huh?', 'lifterlms' ) );
}
$info = pathinfo( $path );
if ( 'csv' !== $info['extension'] ) {
wp_die( esc_html__( 'Cheatin’ huh?', 'lifterlms' ) );
}
header( 'Content-Type: text/csv' );
header( 'Content-Disposition: attachment; filename="' . $export . '"' );
$file = file_get_contents( $path );
unlink( $path );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo $file;
exit;
}
}
return new LLMS_Admin_Export_Download();
================================================
FILE: includes/admin/class-llms-admin-header.php
================================================
<?php
/**
* LLMS_Admin_Header class file
*
* @package LifterLMS/Admin/Classes
*
* @since 7.1.0
* @version 7.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Header UI.
*
* @since 7.1.0
*/
class LLMS_Admin_Header {
/**
* Constructor.
*
* @since 7.1.0
*
* @return void
*/
public function __construct() {
add_action( 'in_admin_header', array( $this, 'admin_header' ) );
}
/**
* Show admin header banner on LifterLMS admin screens.
*
* @since 7.1.0
* @since 7.1.2 Making the LifterLMS logo link to the LifterLMS.com site.
* @since 7.1.3 Using strpos instead of str_starts_with for compatibility.
* @since 7.4.0 Added `llms_admin_show_header` filter and move wizard check.
*
* @return void
*/
public function admin_header() {
// Assume we should not show our header.
$show_header = false;
// Get the current screen and determine if we should show the header.
$current_screen = get_current_screen();
// Show header on our custom post types in admin, but not on the block editor.
if (
isset( $current_screen->post_type ) &&
in_array( $current_screen->post_type, array( 'course', 'lesson', 'llms_review', 'llms_membership', 'llms_engagement', 'llms_order', 'llms_coupon', 'llms_voucher', 'llms_form', 'llms_achievement', 'llms_my_achievement', 'llms_certificate', 'llms_my_certificate', 'llms_email' ), true ) &&
false === $current_screen->is_block_editor
) {
$show_header = true;
}
// Get the current page if available.
$page = (string) llms_filter_input( INPUT_GET, 'page' );
// Show header on our settings pages.
if (
( strpos( $page, 'llms-' ) === 0 ) ||
( ! empty( $current_screen->id ) && strpos( $current_screen->id, 'lifterlms' ) === 0 )
) {
$show_header = true;
}
// Don't show header on the Course Builder.
if ( isset( $current_screen->base ) && 'admin_page_llms-course-builder' === $current_screen->base ) {
$show_header = false;
}
/**
* Allow developers to filter the show header value.
*
* @since 7.4.0
*
* @param bool $show_header Whether to show the header.
* @param WP_Screen $current_screen The current screen object.
* @param string $page The current page if available.
*/
$show_header = apply_filters( 'llms_admin_show_header', $show_header, $current_screen, $page );
// Conditionally show our header.
if ( ! empty( $show_header ) ) { ?>
<header class="llms-header">
<div class="llms-inside-wrap">
<a href="https://lifterlms.com/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Admin%20Header&utm_content=LifterLMS%20Logo" target="_blank"><img class="lifterlms-logo" src="<?php echo esc_url( llms()->plugin_url() ); ?>/assets/images/lifterlms-logo-black.png" alt="<?php esc_attr_e( 'LifterLMS Logo', 'lifterlms' ); ?>"></a>
<div class="llms-meta">
<div class="llms-meta-left">
<span class="llms-version"><?php echo esc_html( sprintf( __( 'Version: %s', 'lifterlms' ), llms()->version ) ); ?></span>
</div>
<div class="llms-meta-right">
<?php
// Show a license link in header if we aren't on the Add-ons screen.
$screen = get_current_screen();
if ( 'lifterlms_page_llms-add-ons' !== $screen->id ) {
?>
<span class="llms-license">
<?php
// Get active keys for this site.
$my_keys = llms_helper_options()->get_license_keys();
if ( empty( $my_keys ) ) {
$license_class = 'llms-license-none';
$license_label = __( 'No License', 'lifterlms' );
} else {
$license_class = 'llms-license-active';
$license_label = __( 'My License Keys', 'lifterlms' );
}
?>
<a class="<?php echo esc_attr( $license_class ); ?>" href="<?php echo esc_url( admin_url( 'admin.php?page=llms-add-ons' ) ); ?>"><?php echo esc_html( $license_label ); ?></a>
</span>
<?php
}
?>
<span class="llms-support">
<a href="https://lifterlms.com/my-account/my-tickets/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Admin%20Header&utm_content=LifterLMS%20Support" target="_blank"><?php esc_html_e( 'Get Support', 'lifterlms' ); ?></a>
</span>
</div>
</div>
</div>
</header>
<?php
}
}
}
return new LLMS_Admin_Header();
================================================
FILE: includes/admin/class-llms-admin-media-protection-attachment-settings.php
================================================
<?php
/**
* LifterLMS Admin Media Protection Attachment Settings.
*
* @package LifterLMS/Classes/Admin
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
class LLMS_Admin_Media_Protection_Attachment_Settings {
public function __construct() {
add_filter( 'attachment_fields_to_edit', array( $this, 'attachment_fields_to_edit' ), 10, 2 );
add_filter( 'attachment_fields_to_save', array( $this, 'attachment_fields_to_save' ), 10, 2 );
}
/**
* Add the media protection settings to the attachment edit screen
*
* @param array $form_fields Array of form fields
* @param object $post WP_Post object
* @return array
*/
public function attachment_fields_to_edit( $form_fields, $post ) {
$selected_product_html = $protection_warning_html = '';
$selected_product_id = get_post_meta( $post->ID, '_llms_media_protection_product_id', true );
if ( $selected_product_id && ( $selected_product = get_post( $selected_product_id ) ) ) {
$selected_product_html = sprintf( '<option value="%d" selected="selected">%s</option>', $selected_product->ID, $selected_product->post_title );
}
$protector = new LLMS_Media_Protector();
if ( ! $protector->is_media_protected( $post->ID ) ) {
// translators: %s is a link to the LifterLMS documentation.
$protection_warning_html = '<div class="llms-media-protection-warning">' . sprintf( __( 'This media is not protected. If you select a product here, the media will be moved to the protected uploads directory and existing links to the media will no longer work. %1$sLearn More%2$s', 'lifterlms' ), '<a target="_blank" href="https://lifterlms.com/docs/how-protected-media-files-work/?utm_source=LifterLMS%20Plugin&utm_medium=Media&utm_campaign=Backend%20Help%20Page">', '</a>' ) . '</div>';
}
$form_fields['llms_media_protection_post'] = array(
'label' => __( 'LifterLMS Media Protection:', 'lifterlms' ),
'input' => 'html',
// TODO: Add selected course/membership to the select2 dropdown if known for this attachment post.
'html' => "$protection_warning_html<select id='attachments-" . $post->ID . "-llms_media_protection_post' class='llms-posts-select2' data-no-view-button='true' data-allow_clear='false' data-post-type='course,llms_membership' name='attachments[" . $post->ID . "][llms_media_protection_post]'>$selected_product_html</select>",
'helps' => $protector->is_media_protected( $post->ID ) ? sprintf( __( 'Access is restricted to the selected course/membership. %1$sLearn More%2$s', 'lifterlms' ), '<a target="_blank" href="https://lifterlms.com/docs/how-protected-media-files-work/?utm_source=LifterLMS%20Plugin&utm_medium=Media&utm_campaign=Backend%20Help%20Page">', '</a>' ) : '',
);
/**
* Filter the LifterLMS media protection attachment field.
*
* @since 10.0.0
*
* @param array $field Attachment field definition.
* @param WP_Post $post Attachment post object.
* @param LLMS_Media_Protector $protector Media protector instance.
*/
$form_fields['llms_media_protection_post'] = apply_filters( 'llms_media_protection_attachment_field', $form_fields['llms_media_protection_post'], $post, $protector );
return $form_fields;
}
/**
* Save the media protection settings
*
* @param array $post Array of post data
* @param array $attachment Array of attachment data
* @return array
*/
public function attachment_fields_to_save( $post, $attachment ) {
if ( ! empty( $attachment['llms_media_protection_post'] ) ) {
if ( $this->move_attachment_to_protected_dir( $post['ID'] ) ) {
update_post_meta( $post['ID'], '_llms_media_protection_product_id', absint( $attachment['llms_media_protection_post'] ) );
}
}
return $post;
}
/**
* Move an existing media attachment over to the protected folder.
*
* @param $attachment_id
* @since 9.0.0
*
* @return bool
*/
function move_attachment_to_protected_dir( $attachment_id ) {
// Get attachment metadata.
$metadata = wp_get_attachment_metadata( $attachment_id );
$file = get_attached_file( $attachment_id );
// Get the protected upload directory.
$protector = new LLMS_Media_Protector();
// We could check that the file is in the protected folder, but currently there's no "unprotect" method.
if ( $protector->is_media_protected( $attachment_id ) ) {
return false;
}
$protected_dir = $protector->get_upload_basedir();
global $wp_filesystem;
if ( empty( $wp_filesystem ) ) {
require_once ABSPATH . '/wp-admin/includes/file.php';
WP_Filesystem();
}
$new_file = str_replace( wp_upload_dir()['basedir'], wp_upload_dir()['basedir'] . untrailingslashit( $protected_dir ), $file );
if ( ! $wp_filesystem->is_dir( dirname( $new_file ) ) ) {
wp_mkdir_p( dirname( $new_file ) );
}
if ( $wp_filesystem->move( $file, $new_file ) ) {
// Move thumbnails if they exist.
if ( ! empty( $metadata['sizes'] ) ) {
$base_dir = dirname( $file );
$new_base_dir = dirname( $new_file );
// Multiple registered sizes can share the same physical file.
$moved_files = array();
foreach ( $metadata['sizes'] as $size => $size_info ) {
if ( in_array( $size_info['file'], $moved_files, true ) ) {
continue;
}
$old_thumb = $base_dir . '/' . $size_info['file'];
$new_thumb = $new_base_dir . '/' . $size_info['file'];
if ( ! $wp_filesystem->exists( $old_thumb ) ) {
error_log( 'Registered metadata thumbnail file does not exist. Skipping. ' . $old_thumb );
continue;
}
if ( ! $wp_filesystem->move( $old_thumb, $new_thumb ) ) {
error_log( 'Unable to move protected file. Thumbnail moving failed: ' . $old_thumb . ' to ' . $new_thumb );
// Move the file back along with any thumbnails we already moved.
$wp_filesystem->move( $new_file, $file );
foreach ( $moved_files as $moved_file ) {
$old_thumb = $base_dir . '/' . $moved_file;
$new_thumb = $new_base_dir . '/' . $moved_file;
if ( $wp_filesystem->exists( $new_thumb ) ) {
$wp_filesystem->move( $new_thumb, $old_thumb );
}
}
return false;
}
$moved_files[] = $size_info['file'];
}
}
// Update attachment location in database.
update_attached_file( $attachment_id, $new_file );
// This only exists with images it seems.
if ( array_key_exists( 'file', $metadata ) ) {
$metadata['file'] = ltrim( $protected_dir, '/' ) . $metadata['file'];
wp_update_attachment_metadata( $attachment_id, $metadata );
}
$protector->add_authorization_meta_to_media_post( $attachment_id );
return true;
}
error_log( 'Unable to move protected file, check permissions on the protected directory or existing file with the same name: ' . $file );
return false;
}
}
new LLMS_Admin_Media_Protection_Attachment_Settings();
================================================
FILE: includes/admin/class-llms-admin-permalinks.php
================================================
<?php
/**
* LLMS_Admin_Header class file
*
* @package LifterLMS/Admin/Classes
*
* @since 7.6.0
* @version 7.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Permalink settings class
*/
class LLMS_Admin_Permalinks {
/**
* Permalink settings.
*
* @var array
*/
private $permalinks = array();
/**
* Constructor.
*
* @since 7.6.0
*
* @return void
*/
public function __construct() {
add_action( 'current_screen', array( $this, 'load_on_permalinks_screen' ) );
}
/**
* Ensure we're on the permalinks screen.
*
* @since 7.6.0
*
* @return void
*/
public function load_on_permalinks_screen() {
$screen = get_current_screen();
if ( $screen && 'options-permalink' === $screen->id ) {
$this->settings_init();
$this->settings_save();
}
}
/**
* Show the available permalink settings
*/
public function settings_init() {
add_settings_section( 'lifterlms-permalink', __( 'LifterLMS Permalinks', 'lifterlms' ), array( $this, 'settings' ), 'permalink' );
$this->permalinks = llms_get_permalink_structure();
}
public function settings() {
?>
<p><?php esc_html_e( 'LifterLMS uses custom post types and taxonomies to organize your courses and memberships. You can customize the URLs for these items here.', 'lifterlms' ); ?></p>
<?php
$course_catalog_id = llms_get_page_id( 'courses' );
if ( $course_catalog_id && get_post( $course_catalog_id ) ) {
?>
<p>
<?php echo esc_html__( 'Note: The Courses Catalog is currently set to a static page.', 'lifterlms' ); ?>
<a href="<?php echo esc_url( get_edit_post_link( $course_catalog_id ) ); ?>">
<?php echo esc_html__( 'You can edit the page slug to change its location.', 'lifterlms' ); ?>
</a>
</p>
<?php
}
$memberships_catalog_id = llms_get_page_id( 'memberships' );
if ( $memberships_catalog_id && get_post( $memberships_catalog_id ) ) {
?>
<p>
<?php echo esc_html__( 'Note: The Memberships Catalog is currently set to a static page.', 'lifterlms' ); ?>
<a href="<?php echo esc_url( get_edit_post_link( $memberships_catalog_id ) ); ?>">
<?php echo esc_html__( 'You can edit the page slug to change its location.', 'lifterlms' ); ?>
</a>
</p>
<?php
}
?>
<table class="form-table" role="presentation">
<tbody>
<tr>
<th>
<label for="course_base">
<?php esc_html_e( 'Course Post Type', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_course_base" id="course_base" type="text" value="<?php echo esc_attr( $this->permalinks['course_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<?php if ( ! $course_catalog_id || ! get_post( $course_catalog_id ) ) : ?>
<tr>
<th>
<label for="courses_base">
<?php esc_html_e( 'Course Archive base', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_courses_base" id="courses_base" type="text" value="<?php echo esc_attr( $this->permalinks['courses_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<?php endif; ?>
<?php if ( ! $memberships_catalog_id || ! get_post( $memberships_catalog_id ) ) : ?>
<tr>
<th>
<label for="memberships_base">
<?php esc_html_e( 'Memberships Archive base', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_memberships_base" id="memberships_base" type="text" value="<?php echo esc_attr( $this->permalinks['memberships_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<?php endif; ?>
<tr>
<th>
<label for="lesson_base">
<?php esc_html_e( 'Lesson Post Type', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_lesson_base" id="lesson_base" type="text" value="<?php echo esc_attr( $this->permalinks['lesson_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<tr>
<th>
<label for="quiz_base">
<?php esc_html_e( 'Quiz Post Type', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_quiz_base" id="quiz_base" type="text" value="<?php echo esc_attr( $this->permalinks['quiz_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<tr>
<th>
<label for="certificate_template_base">
<?php esc_html_e( 'Certificate Template Post Type', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_certificate_template_base" id="certificate_template_base" type="text" value="<?php echo esc_attr( $this->permalinks['certificate_template_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<tr>
<th>
<label for="certificate_base">
<?php esc_html_e( 'Earned Certificate Post Type', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_certificate_base" id="certificate_base" type="text" value="<?php echo esc_attr( $this->permalinks['certificate_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<tr>
<th>
<label for="course_category_base">
<?php esc_html_e( 'Course Category base', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_course_category_base" id="course_category_base" type="text" value="<?php echo esc_attr( $this->permalinks['course_category_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<tr>
<th>
<label for="course_tag_base">
<?php esc_html_e( 'Course Tag base', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_course_tag_base" id="course_tag_base" type="text" value="<?php echo esc_attr( $this->permalinks['course_tag_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<tr>
<th>
<label for="course_track_base">
<?php esc_html_e( 'Course Track base', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_course_track_base" id="course_track_base" type="text" value="<?php echo esc_attr( $this->permalinks['course_track_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<tr>
<th>
<label for="course_difficulty_base">
<?php esc_html_e( 'Course Difficulty base', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_course_difficulty_base" id="course_difficulty_base" type="text" value="<?php echo esc_attr( $this->permalinks['course_difficulty_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<tr>
<th>
<label for="membership_category_base">
<?php esc_html_e( 'Membership Category base', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_membership_category_base" id="membership_category_base" type="text" value="<?php echo esc_attr( $this->permalinks['membership_category_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<tr>
<th>
<label for="membership_tag_base">
<?php esc_html_e( 'Membership Tag base', 'lifterlms' ); ?>
</label>
</th>
<td>
<input name="llms_membership_tag_base" id="membership_tag_base" type="text" value="<?php echo esc_attr( $this->permalinks['membership_tag_base'] ); ?>" class="regular-text code" required>
</td>
</tr>
<?php do_action( 'llms_permalink_setting_fields' ); ?>
</tbody>
</table>
<?php wp_nonce_field( 'llms-permalinks', 'llms-permalinks-nonce' ); ?>
<?php
}
/**
* Save the permalink settings
*/
public function settings_save() {
if ( ! is_admin() ) {
return;
}
if ( ! current_user_can( 'manage_options' ) ) {
return;
}
if ( isset( $_POST['llms-permalinks-nonce'] ) && wp_verify_nonce( sanitize_key( $_POST['llms-permalinks-nonce'] ), 'llms-permalinks' ) ) {
llms_switch_to_site_locale();
$permalinks = llms_get_permalink_structure();
$permalinks['course_base'] = isset( $_POST['llms_course_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_course_base'] ) ) : $permalinks['course_base'];
$permalinks['courses_base'] = isset( $_POST['llms_courses_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_courses_base'] ) ) : $permalinks['courses_base'];
$permalinks['memberships_base'] = isset( $_POST['llms_memberships_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_memberships_base'] ) ) : $permalinks['memberships_base'];
$permalinks['lesson_base'] = isset( $_POST['llms_lesson_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_lesson_base'] ) ) : $permalinks['lesson_base'];
$permalinks['quiz_base'] = isset( $_POST['llms_quiz_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_quiz_base'] ) ) : $permalinks['quiz_base'];
$permalinks['certificate_template_base'] = isset( $_POST['llms_certificate_template_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_certificate_template_base'] ) ) : $permalinks['certificate_template_base'];
$permalinks['certificate_base'] = isset( $_POST['llms_certificate_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_certificate_base'] ) ) : $permalinks['certificate_base'];
$permalinks['course_category_base'] = isset( $_POST['llms_course_category_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_course_category_base'] ) ) : $permalinks['course_category_base'];
$permalinks['course_tag_base'] = isset( $_POST['llms_course_tag_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_course_tag_base'] ) ) : $permalinks['course_tag_base'];
$permalinks['course_track_base'] = isset( $_POST['llms_course_track_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_course_track_base'] ) ) : $permalinks['course_track_base'];
$permalinks['course_difficulty_base'] = isset( $_POST['llms_course_difficulty_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_course_difficulty_base'] ) ) : $permalinks['course_difficulty_base'];
$permalinks['membership_category_base'] = isset( $_POST['llms_membership_category_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_membership_category_base'] ) ) : $permalinks['membership_category_base'];
$permalinks['membership_tag_base'] = isset( $_POST['llms_membership_tag_base'] ) ? sanitize_text_field( wp_unslash( $_POST['llms_membership_tag_base'] ) ) : $permalinks['membership_tag_base'];
llms_set_permalink_structure( $permalinks );
llms_restore_locale();
}
}
}
return new LLMS_Admin_Permalinks();
================================================
FILE: includes/admin/class-llms-admin-plugins.php
================================================
<?php
/**
* LLMS_Admin_Plugins class
*
* @package LifterLMS/Admin/Classes
*
* @since 7.5.1
* @version 7.5.1
*/
defined( 'ABSPATH' ) || exit;
/**
* Modifications to the plugins page.
*
* @since 7.5.1
*/
class LLMS_Admin_Plugins {
/**
* Constructor
*
* @since 7.5.1
*
* @return void
*/
public function __construct() {
add_filter( 'plugin_action_links_' . plugin_basename( LLMS_PLUGIN_DIR . '/lifterlms.php' ), array( $this, 'plugin_action_links' ) );
add_filter( 'plugin_row_meta', array( $this, 'plugin_row_meta' ), 10, 2 );
}
/**
* Add links to the plugins page.
*/
public function plugin_action_links( $links ) {
$new_links = array(
'dashboard' => '<a href="' . esc_url( admin_url( 'admin.php?page=llms-dashboard' ) ) . '">' . __( 'Dashboard', 'lifterlms' ) . '</a>',
'settings' => '<a href="' . esc_url( admin_url( 'admin.php?page=llms-settings' ) ) . '">' . __( 'Settings', 'lifterlms' ) . '</a>',
);
$links = array_merge( $new_links, $links );
return $links;
}
/**
* Add links to plugin description.
*/
public function plugin_row_meta( $links, $file ) {
if ( plugin_basename( LLMS_PLUGIN_DIR . '/lifterlms.php' ) === $file ) {
$row_meta = array(
'docs' => '<a href="' . esc_url( 'https://lifterlms.com/docs/?utm_source=LifterLMS%20Plugin&utm_medium=Plugins%20Screen&utm_campaign=Plugin%20to%20Sale&utm_content=Documentation' ) . '" aria-label="' . esc_attr__( 'Docs', 'lifterlms' ) . '" target="_blank">' . esc_html__( 'Documentation', 'lifterlms' ) . '</a>',
'support' => '<a href="' . esc_url( 'https://lifterlms.com/my-account/my-tickets/?utm_source=LifterLMS%20Plugin&utm_medium=Plugins%20Screen&utm_campaign=Plugin%20to%20Sale&utm_content=Support' ) . '" aria-label="' . esc_attr__( 'Support', 'lifterlms' ) . '" target="_blank">' . esc_html__( 'Support', 'lifterlms' ) . '</a>',
'pricing' => '<a href="' . esc_url( 'https://lifterlms.com/pricing/?utm_source=LifterLMS%20Plugin&utm_medium=Plugins%20Screen&utm_campaign=Plugin%20to%20Sale&utm_content=Premium%20Plans' ) . '" aria-label="' . esc_attr__( 'Premium Plans', 'lifterlms' ) . '" target="_blank">' . esc_html__( 'Premium Plans', 'lifterlms' ) . '</a>',
);
$links = array_merge( $links, $row_meta );
}
return $links;
}
}
return new LLMS_Admin_Plugins();
================================================
FILE: includes/admin/class-llms-admin-profile.php
================================================
<?php
/**
* Handle extra profile fields for users in admin
*
* @package LifterLMS/Admin/Classes
*
* @since [verson]
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Handle extra profile fields for users in admin
*
* Applies to edit-user.php & profile.php.
*
* @since 5.0.0
*/
class LLMS_Admin_Profile {
/**
* Array of user profile fields
*
* @var array
*/
private $fields;
/**
* Submission errors
*
* @var null|WP_Error
*/
private $errors;
/**
* Constructor
*
* @since 5.0.0
*
* @return void
*/
public function __construct() {
add_action( 'show_user_profile', array( $this, 'add_user_meta_fields' ) );
add_action( 'edit_user_profile', array( $this, 'add_user_meta_fields' ) );
add_action( 'personal_options_update', array( $this, 'save_user_meta_fields' ) );
add_action( 'edit_user_profile_update', array( $this, 'save_user_meta_fields' ) );
// Allow errors to be output.
add_action( 'user_profile_update_errors', array( $this, 'add_errors' ) );
}
/**
* Add user meta fields to the profile screens
*
* @since 5.0.0
*
* @param WP_User $user Instance of WP_User for the user being updated.
* @return bool `true` if fields were added, `false` otherwise.
*/
public function add_user_meta_fields( $user ) {
if ( ! $this->current_user_can_edit_admin_custom_fields() ) {
return false;
}
$fields = $this->get_fields();
if ( empty( $fields ) ) {
return false;
}
/**
* Enqueue select2 scripts and styles.
*/
wp_enqueue_script( 'llms-metaboxes' );
wp_enqueue_script( 'llms-select2' );
llms()->assets->enqueue_style( 'llms-select2-styles' );
wp_add_inline_script(
'llms',
"window.llms.address_info = '" . wp_json_encode( llms_get_countries_address_info() ) . "';"
);
include_once LLMS_PLUGIN_DIR . 'includes/admin/views/user-edit-fields.php';
return true;
}
/**
* Maybe save user meta fields
*
* @since 5.0.0
*
* @param int $user_id WP_User ID for the user being updated.
* @return void
*/
public function save_user_meta_fields( $user_id ) {
if ( ! $this->current_user_can_edit_admin_custom_fields() ) {
return;
}
$fields = $this->get_fields();
$posted_data = array();
foreach ( $this->fields as $field ) {
if ( in_array( $field['name'], LLMS_CONFIRMATION_FIELDS, true ) ) {
continue;
}
//phpcs:disable WordPress.Security.NonceVerification.Missing -- nonce is verified prior to reaching this method.
if ( isset( $_POST[ $field['name'] ] ) &&
isset( $field['data_store_key'] ) &&
$field['data_store'] && 'usermeta' === $field['data_store'] ) {
//phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized, WordPress.Security.ValidatedSanitizedInput.MissingUnslash -- sanitization and unslashing happens in `LLMS_Form_Handler::instance()->submit_form_fields()` below.
$posted_data[ $field['name'] ] = $_POST[ $field['name'] ];
}
//phpcs:disable WordPress.Security.NonceVerification.Missing
}
if ( empty( $posted_data ) ) {
return;
}
$posted_data['user_id'] = $user_id;
$submit = LLMS_Form_Handler::instance()->submit_fields( $posted_data, 'admin-profile', $fields, 'update' );
if ( isset( $_POST['llms_allow_unlimited_quiz_time'] ) && 'yes' === $_POST['llms_allow_unlimited_quiz_time'] ) {
update_user_option( $user_id, 'llms_allow_unlimited_quiz_time', 'yes' );
} else {
update_user_option( $user_id, 'llms_allow_unlimited_quiz_time', 'no' );
}
if ( is_wp_error( $submit ) ) {
$this->errors = $submit;
}
}
/**
* Maybe print validation errors
*
* @since 5.0.0
*
* @param WP_Error $errors Instance of WP_Error, passed by reference.
* @return void
*/
public function add_errors( &$errors ) {
if ( is_wp_error( $this->errors ) && $this->errors->has_errors() ) {
$this->merge_llms_fields_errors( $errors );
}
}
/**
* Check whether the current user can edit users custom fields
*
* @since 5.0.0
*
* @return boolean
*/
private function current_user_can_edit_admin_custom_fields() {
return current_user_can( 'manage_lifterlms' ) && current_user_can( 'edit_users' );
}
/**
* Merge llms fields errors into the passed WP_Error
*
* @since 5.0.0
* @todo Remove the fallback when minimum required WP version will be 5.6+.
*
* @param WP_Error $errors Instance of WP_Error, passed by reference.
* @return void
*/
private function merge_llms_fields_errors( &$errors ) {
foreach ( $this->errors->get_error_codes() as $code ) {
foreach ( $this->errors->get_error_messages( $code ) as $error_message ) {
$errors->add(
$code,
sprintf(
// Translators: %1$s = Opening strong tag; %2$s = Closing strong tag; %3$s = The error message.
esc_html__( '%1$sError%2$s: %3$s', 'lifterlms' ),
'<strong>',
'</strong>',
$error_message
)
);
}
// `WP_Error::get_all_error_data()` has been introduced in WP 5.6.0.
$error_data = method_exists( $this->errors, 'get_all_error_data' ) ?
$this->errors->get_all_error_data( $code ) : $this->errors->get_error_data( $code );
foreach ( $error_data as $data ) {
$errors->add_data( $data, $code );
}
}
}
/**
* Get fields to be added in the profile screen
*
* @since 5.0.0
*
* @return array
*/
private function get_fields() {
if ( ! isset( $this->fields ) ) {
$this->fields = $this->prepare_fields();
}
return $this->fields;
}
/**
* Setup fields to be added to the profile screen
*
* @since 5.0.0
*
* @return array
*/
private function prepare_fields() {
$fields = llms_get_user_information_fields();
$prepared = array();
/**
* Filters the list of user information fields which are excluded from the admin profile.
*
* By default WP core fields are excluded as they are automatically rendered on the screen
* by the WP core.
*
* @since 5.0.0
*
* @param string[] $fields A list of field ids to be excluded.
*/
$excluded = apply_filters(
'llms_admin_profile_excluded_fields',
array_merge(
array(
'user_login',
'email_address',
'password',
'first_name',
'last_name',
'display_name',
),
LLMS_CONFIRMATION_FIELDS
)
);
foreach ( $fields as $field ) {
// Skip excluded fields.
if ( in_array( $field['name'], $excluded, true ) ) {
continue;
}
// For display purposes.
$field['columns'] = 6;
// Handle weird exception.
$field['label'] = ( 'llms_billing_address_2' === $field['name'] ) ? __( 'Address line 2', 'lifterlms' ) : $field['label'];
$prepared[] = $field;
}
/**
* Fields to be added in the profile screen
*
* @since 5.0.0
*
* @param array[] $fields Array of fields.
*/
return apply_filters( 'llms_admin_profile_fields', $prepared );
}
}
return new LLMS_Admin_Profile();
================================================
FILE: includes/admin/class-llms-admin-review.php
================================================
<?php
/**
* LLMS_Admin_Review class file
*
* @package LifterLMS/Admin/Classes
*
* @since 3.24.0
* @version 7.1.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin review request.
*
* Handles UI updates to the admin panel which request users to rate & review the
* LifterLMS plugin on WordPress.org.
*
* Please say nice things about us.
*
* @since 3.24.0
*/
class LLMS_Admin_Review {
/**
* Constructor
*
* @since 3.24.0
*
* @return void
*/
public function __construct() {
add_filter( 'admin_footer_text', array( $this, 'admin_footer' ), 1 );
add_action( 'admin_notices', array( $this, 'maybe_show_notice' ) );
add_action( 'wp_ajax_llms_review_dismiss', array( $this, 'dismiss' ) );
}
/**
* On LifterLMS admin screens replace the default footer text with a review request.
*
* @since 3.24.0
* @since 7.1.0 Show footer on our custom post types in admin, but not on the block editor.
* @since 7.1.3 Using strpos instead of str_starts_with for compatibility.
*
* @param string $text Default footer text.
* @return string
*/
public function admin_footer( $text ) {
global $current_screen;
// Show footer on our custom post types in admin, but not on the block editor.
if (
isset( $current_screen->post_type ) &&
in_array( $current_screen->post_type, array( 'course', 'lesson', 'llms_review', 'llms_membership', 'llms_engagement', 'llms_order', 'llms_coupon', 'llms_voucher', 'llms_form', 'llms_achievement', 'llms_my_achievement', 'llms_certificate', 'llms_my_certificate', 'llms_email' ), true ) &&
false === $current_screen->is_block_editor
) {
$show_footer = true;
}
// Show footer on our settings pages.
// phpcs:disable WordPress.Security.NonceVerification.Recommended -- No nonce verification needed here
// phpcs:disable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- No sanitization needed here, we're not gonna use this value other than for checks
// phpcs:disable WordPress.Security.ValidatedSanitizedInput.MissingUnslash -- No unslash needed here, we're not gonna use this value other than for checks
if (
( ! empty( $_GET['page'] ) && strpos( $_GET['page'], 'llms-' ) === 0 ) ||
( ! empty( $current_screen->id ) && strpos( $current_screen->id, 'lifterlms' ) === 0 )
) {
$show_footer = true;
}
// phpcs:enable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
// phpcs:enable WordPress.Security.ValidatedSanitizedInput.MissingUnslash
// Exclude the wizard.
if ( ! empty( $_GET['page'] ) && 'llms-setup' === $_GET['page'] ) {
$show_footer = false;
}
// phpcs:enable WordPress.Security.NonceVerification.Recommended
// Don't show footer on the Course Builder.
if ( isset( $current_screen->base ) && 'admin_page_llms-course-builder' === $current_screen->base ) {
$show_footer = false;
}
// Conditionally filter footer text with our content.
if ( ! empty( $show_footer ) ) {
$url = 'https://wordpress.org/support/plugin/lifterlms/reviews/#new-post';
$text = sprintf(
wp_kses(
/* Translators: %1$s = LifterLMS plugin name; %2$s = WP.org review link; %3$s = WP.org review link. */
__( 'Please rate %1$s <a class="llms-rating-stars" href="%2$s" target="_blank" rel="noopener noreferrer">★★★★★</a> on <a href="%3$s" target="_blank" rel="noopener">WordPress.org</a> to help us spread the word. Thank you from the LifterLMS team!', 'lifterlms' ),
array(
'a' => array(
'class' => array(),
'href' => array(),
'target' => array(),
'rel' => array(),
),
)
),
'<strong>LifterLMS</strong>',
$url,
$url
);
}
return $text;
}
/**
* AJAX callback for dismissing the notice
*
* @since 3.24.0
* @since 4.14.0 Only users with `manager_lifterlms` caps can dismiss and added nonce verification.
* Use `llms_filter_input()` in favor of `filter_input()`.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public function dismiss() {
if ( ! current_user_can( 'manage_lifterlms' ) || ! isset( $_REQUEST['nonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['nonce'] ) ), 'llms-admin-review-request-dismiss' ) ) {
wp_die();
}
$success = llms_parse_bool( llms_filter_input( INPUT_POST, 'success' ) );
update_option(
'llms_review',
array(
'time' => time(),
'dismissed' => true,
'success' => $success ? 'yes' : 'no',
)
);
wp_die();
}
/**
* Determine if the notice should be displayed and display it
*
* @since 3.24.0
* @since 4.14.0 Only show to users with `manage_lifterlms` instead of only admins.
*
* @return null|false|void Returns `null` when there are permission issues, `false` when the notification is not set to be
* displayed, and has no return when the notice is successfully displayed.
*/
public function maybe_show_notice() {
// Only show review request to admins.
if ( ! current_user_can( 'manage_lifterlms' ) ) {
return null;
}
// Verify that we can do a check for reviews.
$review = get_option( 'llms_review' );
$time = time();
$enrollments = 0;
// No review info stored, create a stub.
if ( ! $review ) {
update_option(
'llms_review',
array(
'time' => $time,
'dismissed' => false,
)
);
return false;
}
// Review has not been dismissed and LifterLMS has been installed at least a week.
if ( ( isset( $review['dismissed'] ) && ! $review['dismissed'] ) && isset( $review['time'] ) && ( $review['time'] + WEEK_IN_SECONDS <= $time ) ) {
// Show if the enrollments threshold is reached.
global $wpdb;
$enrollments = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_key = '_status' AND meta_value = 'enrolled'" ); // no-cache ok.
}
// Only load if we have 30 or more enrollments.
// This will be 0 if the review time/dismissed check above fails.
if ( $enrollments < 30 ) {
return false;
}
$enrollments = self::round_down( $enrollments );
include 'views/notices/review-request.php';
}
/**
* Round a number down to a big-ish round number
*
* @since 3.24.0
* @since 4.14.0 Numbers less than 10 are not rounded & numbers less than 100 are rounded to the nearest 10.
*
* @param int $number Input number.
* @return int
*/
public static function round_down( $number ) {
if ( $number < 10 ) {
return $number;
}
if ( $number < 100 ) {
$number = floor( $number / 10 ) * 10;
} elseif ( $number < 1000 ) {
$number = floor( $number / 100 ) * 100;
} elseif ( $number < 10000 ) {
$number = floor( $number / 1000 ) * 1000;
} else {
$number = 10000;
}
return $number;
}
}
return new LLMS_Admin_Review();
================================================
FILE: includes/admin/class-llms-admin-users-table.php
================================================
<?php
/**
* Manage WP Admin users table
*
* @package LifterLMS/Admin/Classes
*
* @since 3.34.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Users_Table class
*
* @since 3.34.0
* @since 4.0.0 Add custom user table columns and action links.
* @since 6.0.0 Removed the deprecated `LLMS_Admin_Users_Table::load_dependencies()` method.
*/
class LLMS_Admin_Users_Table {
/**
* Date/time format used to format last login timestamps
*
* This "caches" the data on the instance so that multiple requests
* to get_option() / wp_cache_get() don't need to be made when outputting
* a user table view.
*
* @var string
*/
protected $login_date_format = '';
/**
* Constructor.
*
* @since 3.34.0
* @since 4.0.0 Add custom user table columns and action links.
* @since 4.7.0 Remove `load_dependencies()` method hook.
*
* @return void
*/
public function __construct() {
add_filter( 'manage_users_columns', array( $this, 'add_cols' ) );
add_filter( 'manage_users_custom_column', array( $this, 'output_col' ), 10, 3 );
add_filter( 'users_list_table_query_args', array( $this, 'modify_query_args' ) );
add_filter( 'views_users', array( $this, 'modify_views' ) );
add_filter( 'user_row_actions', array( $this, 'add_actions' ), 20, 2 );
}
/**
* Add custom actions links
*
* Outputs a "Reports" action link seen when hovering over a user in the table.
*
* @since 4.0.0
*
* @param string[] $actions Array of existing action links.
* @param WP_User $user User object.
* @return string[]
*/
public function add_actions( $actions, $user ) {
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'student_id' => $user->ID,
)
);
$actions['llms-reporting'] = '<a href="' . esc_url( $url ) . '">' . __( 'Reports', 'lifterlms' ) . '</a>';
return $actions;
}
/**
* Add Custom Columns to the Admin Users Table Screen
*
* @param array $columns key=>val array of existing columns
*
* @return array $columns updated columns
*/
public function add_cols( $columns ) {
$columns['llms-last-login'] = __( 'Last Login', 'lifterlms' );
$columns['llms-enrollments'] = __( 'Enrollments', 'lifterlms' );
return $columns;
}
/**
* Retrieve the date/time format used to display a user's last login.
*
* @since 4.0.0
*
* @return string
*/
protected function get_login_column_date_format() {
if ( ! $this->login_date_format ) {
$this->login_date_format = get_option( 'date_format', 'Y-m-d' ) . ' ' . get_option( 'time_format', ' h:i:s a' );
}
return $this->login_date_format;
}
/**
* Retrieves the output for the "enrollments" column.
*
* @since 4.0.0
*
* @param LLMS_Student $student Student object.
* @return string
*/
protected function get_enrollments_column_output( $student ) {
$info = array();
$types = array(
'courses' => __( 'Courses', 'lifterlms' ),
'memberships' => __( 'Memberships', 'lifterlms' ),
);
foreach ( $types as $type => $name ) {
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'stab' => $type,
'student_id' => $student->get_id(),
)
);
$query = call_user_func( array( $student, 'get_' . $type ), array( 'limit' => 1 ) );
$info[] = sprintf( '%1$s: <a href="%2$s">%3$d</a>', $name, esc_url( $url ), $query['found'] );
}
return implode( '<br>', $info );
}
/**
* Modify the query arguments of the users table query.
*
* If the current user is an instructor and no `role` argument is provided will limit the query to users
* with the `instructors_assistant` and `instructor` roles.
*
* @since 3.34.0
*
* @param array $args Array of arguments to be passed to a WP_User_Query.
* @return array
*/
public function modify_query_args( $args ) {
if ( LLMS_User_Permissions::is_current_user_instructor() && empty( $args['role'] ) ) {
$args['role__in'] = array( 'instructors_assistant', 'instructor' );
}
return $args;
}
/**
* Modify the list of role "view" filter links at the top of the user table.
*
* An instructor can only manage instructors and instructor's assistants so we'll remove these links from the list
* and additionally modify the count on the "All" filter to reflect the total number of users who are visible
* to the current instructor.
*
* @since 3.34.0
*
* @param array $views Associative array of views where the key is the role name and the value is the HTML for the view link.
* @return array
*/
public function modify_views( $views ) {
if ( LLMS_User_Permissions::is_current_user_instructor() ) {
$users = count_users();
// Allow the instructor to see roles they're allowed to edit.
$all_roles = LLMS_User_Permissions::get_editable_roles();
$roles = array_merge( array( 'all', 'instructor' ), $all_roles['instructor'] );
$all = 0;
foreach ( array_keys( $views ) as $view ) {
if ( ! in_array( $view, $roles, true ) ) {
// Unset any views they're not allowed to edit.
unset( $views[ $view ] );
} elseif ( ! empty( $users['avail_roles'][ $view ] ) ) {
// Add roles they're allowed to view to the new all count.
$all += $users['avail_roles'][ $view ];
}
}
// Replace the count on the "All" link with our updated count.
$format = '<span class="count">(%s)</span>';
$views['all'] = str_replace( sprintf( $format, $users['total_users'] ), sprintf( $format, $all ), $views['all'] );
}
return $views;
}
/**
* Register custom columns
*
* @since 4.0.0
*
* @param string $output Column output value to display (defaults to empty).
* @param string $col_name Column name/id.
* @param int $user_id WP_User ID.
* @return string
*/
public function output_col( $output, $col_name, $user_id ) {
switch ( $col_name ) {
case 'llms-enrollments':
$student = llms_get_student( $user_id );
if ( $student ) {
$output = $this->get_enrollments_column_output( $student );
}
break;
case 'llms-last-login':
$last = get_user_meta( $user_id, 'llms_last_login', true );
$last = is_numeric( $last ) ? $last : strtotime( $last );
$output = $last ? date_i18n( $this->get_login_column_date_format(), $last ) : __( 'Never', 'lifterlms' );
break;
}
return $output;
}
}
return new LLMS_Admin_Users_Table();
================================================
FILE: includes/admin/class-llms-export-api.php
================================================
<?php
/**
* Manage imports from lifterlms.com export API
*
* @package LifterLMS/Admin/Classes
*
* @since 4.8.0
* @version 4.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Export API Class
*
* @since 4.8.0
*/
class LLMS_Export_API {
/**
* Make an GET request to the exports API
*
* @since 4.8.0
*
* @param array $args Array of query string arguments formatted as an associative array.
* @return array|WP_Error
*/
protected static function call_api( $args ) {
/**
* Filter the url used to make requests to the LifterLMS.com "exports" api.
*
* @since 4.8.0
*
* @param string $url API request url.
*/
$base_url = apply_filters(
'llms_export_api_url',
'https://academy.lifterlms.com/wp-json/llms-academy/v1/exports'
);
$req = wp_safe_remote_get(
add_query_arg( $args, $base_url ),
array(
'timeout' => 15,
)
);
$body = json_decode( wp_remote_retrieve_body( $req ), true );
if ( 200 === wp_remote_retrieve_response_code( $req ) ) {
return $body;
}
// If there's a body it's a json encoded error object, otherwise it's already an error object.
return $body && ! empty( $body['code'] ) ? new WP_Error( $body['code'], $body['message'], $body['data'] ) : $req;
}
/**
* Retrieve an import array by export IDs.
*
* @since 4.8.0
*
* @param int[] $ids Array of export IDs.
* @return array|WP_Error
*/
public static function get( $ids ) {
$ids = implode( ',', array_map( 'absint', $ids ) );
return self::call_api( compact( 'ids' ) );
}
/**
* Retrieve a list of available exports
*
* @since 4.8.0
*
* @param int $page Results page.
* @param int $per_page Results per page.
* @return array[]|WP_Error
*/
public static function list( $page = 1, $per_page = 10 ) {
return self::call_api( compact( 'page', 'per_page' ) );
}
}
================================================
FILE: includes/admin/class-llms-mailhawk.php
================================================
<?php
/**
* MailHawk Connect
*
* @package LifterLMS/Admin/Classes
*
* @since 3.40.0
* @version 3.40.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_MailHawk class
*
* @since 3.40.0
*/
class LLMS_MailHawk extends LLMS_Abstract_Email_Provider {
/**
* LifterLMS MailHawk Partner ID.
*
* @var int
*/
const PARTNER_ID = 3;
/**
* Connector's ID.
*
* @var string
*/
protected $id = 'mailhawk';
/**
* Configures the response returned when `do_remote_install()` is successful.
*
* @since 3.40.0
*
* @return array
*/
protected function do_remote_install_success() {
return array(
'partner_id' => self::PARTNER_ID,
'register_url' => esc_url( trailingslashit( MAILHAWK_LICENSE_SERVER_URL ) ),
'client_state' => esc_html( \MailHawk\Keys::instance()->state() ),
'redirect_uri' => esc_url( \MailHawk\mailhawk_admin_page() ),
);
}
/**
* Retrieve the settings area HTML for the connect button
*
* @since 3.40.0
*
* @return string
*/
protected function get_connect_setting() {
if ( $this->is_connected() ) {
$ret = array(
__( 'Your site is connected to MailHawk.', 'lifterlms' ),
);
$settings_url = esc_url( admin_url( '/tools.php?page=mailhawk' ) );
if ( function_exists( '\MailHawk\mailhawk_is_suspended' ) && ! \MailHawk\mailhawk_is_suspended() ) {
$ret[] = sprintf(
// Translators: %1$s = Opening anchor tag to WP MailHawk Settings; Opening anchor tag to MailHawk.io account page; %2$s = Closing anchor tag.
__( '%1$sView settings%3$s or %2$smanage your account%3$s.', 'lifterlms' ),
'<a href="' . $settings_url . '">',
'<a href="https://mailhawk.io/account/" target="_blank" rel="noopener noreferrer">',
'</a>'
);
} else {
$ret[] = sprintf(
// Translators: %1$s = Opening anchor tag; %2$s = Closing anchor tag.
'<em>' . __( 'Email sending is currently disabled. %1$sVisit MailHawk Settings%2$s to enable sending.', 'lifterlms' ) . '</em>',
'<a href="' . $settings_url . '">',
'</a>'
);
}
return '<p>' . implode( ' ', $ret ) . '</p>';
}
return sprintf( '<button type="button" class="llms-button-outline" id="llms-mailhawk-connect"><span class="dashicons dashicons-email-alt"></span> %s</button>', __( 'Connect MailHawk', 'lifterlms' ) );
}
/**
* Retrieve description text to be used in the settings area.
*
* @since 3.40.0
*
* @return string
*/
protected function get_description() {
return sprintf(
// Translators: %s = Anchor tag html linking to MailHawk.io.
__( 'Never worry about sending email again. %s takes care of everything for you starting for a small monthly fee.', 'lifterlms' ),
'<a href="https://lifterlikes.com/mailhawk" target="_blank">' . $this->get_title() . '</a>'
);
}
/**
* Retrieve the connector's name / title.
*
* @since 3.40.0
*
* @return string
*/
protected function get_title() {
return __( 'MailHawk', 'lifterlms' );
}
/**
* Determines if MailHawk is installed and connected for sending.
*
* @since 3.40.0
*
* @return boolean
*/
protected function is_connected() {
return ( function_exists( '\MailHawk\mailhawk_is_connected' ) && \MailHawk\mailhawk_is_connected() );
}
/**
* Determines if connector plugin is installed
*
* @since 3.40.0
*
* @return boolean
*/
protected function is_installed() {
return function_exists( '\MailHawk\mailhawk_admin_page' );
}
/**
* Output some quick and dirty inline JS.
*
* @since 3.40.0
*
* @return void
*/
public function output_js( $additional_js = '' ) {
if ( ! $this->should_output_inline() ) {
return;
}
?>
<script>
jQuery( '#llms-mailhawk-connect' ).on( 'click', function( e ) {
e.preventDefault();
LLMS.Spinner.start( jQuery( this ), 'small' );
var data = {
action: 'llms_mailhawk_remote_install',
_llms_mailhawk_nonce: '<?php echo esc_js( wp_create_nonce( 'llms-mailhawk-install' ) ); ?>',
};
window.llms.emailConnectors.remoteInstall( jQuery( this ), data, function( res ) {
window.llms.emailConnectors.registerClient( res.register_url, {
'mailhawk_plugin_signup': 'yes',
'state': res.client_state,
'redirect_uri': res.redirect_uri,
'partner_id': res.partner_id
} );
} );
} );
</script>
<?php
}
}
return new LLMS_MailHawk();
================================================
FILE: includes/admin/class-llms-sendwp.php
================================================
<?php
/**
* SendWP Connect
*
* @package LifterLMS/Admin/Classes
*
* @since 3.36.1
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_SendWP class
*
* @since 3.36.1
* @since 3.37.0 Sanitize URLs, clean up jQuery references, add loading feedback when connector button is clicked.
* @since 3.37.3 Modify the ID used to determine where to splice in SendWP Options.
* @since 3.40.0 Refactor to utilize `LLMS_Abstract_Email_Provider`.
* @since 6.0.0 Removed `LLMS_SendWP::do_remote_install()` in favor of `LLMS_Abstract_Email_Provider::do_remote_install()`.
*/
class LLMS_SendWP extends LLMS_Abstract_Email_Provider {
/**
* LifterLMS SendWP Partner ID.
*
* @var int
*/
const PARTNER_ID = 2007;
/**
* Connector's ID.
*
* @var string
*/
protected $id = 'sendwp';
/**
* Configures the response returned when `do_remote_install()` is successful.
*
* @since 3.40.0
*
* @return array
*/
protected function do_remote_install_success() {
return array(
'partner_id' => self::PARTNER_ID,
'register_url' => esc_url( sendwp_get_server_url() . '_/signup' ),
'client_name' => esc_url( sendwp_get_client_name() ),
'client_secret' => esc_url( sendwp_get_client_secret() ),
'client_redirect' => esc_url( sendwp_get_client_redirect() ),
);
}
/**
* Retrieve description text to be used in the settings area.
*
* @since 3.40.0
*
* @return string
*/
protected function get_description() {
return sprintf(
// Translators: %s = Anchor tag html linking to SendWP.com.
__( '%s makes WordPress email delivery as simple as a few clicks so you can relax, knowing your important emails are being delivered on time.', 'lifterlms' ),
'<a href="https://lifterlikes.com/sendwp" target="_blank" rel="noopener noreferrer">' . $this->get_title() . '</a>'
);
}
/**
* Retrieve the connector's name / title.
*
* @since 3.40.0
*
* @return string
*/
protected function get_title() {
return __( 'SendWP', 'lifterlms' );
}
/**
* Determine if SendWP is installed and connected for sending.
*
* @since 3.40.0
*
* @return boolean
*/
protected function is_connected() {
return ( function_exists( 'sendwp_client_connected' ) && sendwp_client_connected() );
}
/**
* Determines if connector plugin is installed
*
* @since 3.40.0
*
* @return boolean
*/
protected function is_installed() {
return function_exists( 'sendwp_get_server_url' );
}
/**
* Get the "Connect" Setting field html.
*
* @since 3.36.1
* @since 3.40.0 Abstract methods used to determine if SendWP is connected.
* @since 5.3.2 Update the URL for managing an account.
*
* @return string
*/
protected function get_connect_setting() {
if ( $this->is_connected() ) {
$ret = array(
__( 'Your site is connected to SendWP.', 'lifterlms' ),
);
if ( function_exists( 'sendwp_forwarding_enabled' ) && sendwp_forwarding_enabled() ) {
$ret[] = sprintf(
// Translators: %1$s = Opening anchor tag; %2$s = Closing anchor tag.
__( '%1$sManage your account%2$s.', 'lifterlms' ),
'<a href="https://app.sendwp.com/dashboard" target="_blank" rel="noopener noreferrer">',
'</a>'
);
} else {
$ret[] = sprintf(
// Translators: %1$s = Opening anchor tag; %2$s = Closing anchor tag.
'<em>' . __( 'Email sending is currently disabled. %1$sVisit the SendWP Settings%2$s to enable sending..', 'lifterlms' ) . '</em>',
'<a href="' . admin_url( '/tools.php?page=sendwp' ) . '">',
'</a>'
);
}
return '<p>' . implode( ' ', $ret ) . '</p>';
}
return '<button class="llms-button-outline" id="llms-sendwp-connect"><i class="fa fa-paper-plane-o" aria-hidden="true"></i> Connect SendWP</button>';
}
/**
* Output some quick and dirty inline JS.
*
* @since 3.36.1
* @since 3.37.0 Add nonce and replace references to `$` with `jQuery`.
* @since 3.40.0 Refactored to utilize `window.llms.emailConnectors`.
*
* @return void
*/
public function output_js() {
if ( ! $this->should_output_inline() ) {
return;
}
?>
<script>
jQuery( '#llms-sendwp-connect' ).on( 'click', function( e ) {
e.preventDefault();
LLMS.Spinner.start( jQuery( this ), 'small' );
var data = {
action: 'llms_sendwp_remote_install',
_llms_sendwp_nonce: '<?php echo esc_js( wp_create_nonce( 'llms-sendwp-install' ) ); ?>',
};
window.llms.emailConnectors.remoteInstall( jQuery( this ), data, function( res ) {
window.llms.emailConnectors.registerClient( res.register_url, {
client_name: res.client_name,
client_secret: res.client_secret,
client_redirect: res.client_redirect,
partner_id: res.partner_id,
} );
} );
} );
</script>
<?php
}
}
return new LLMS_SendWP();
================================================
FILE: includes/admin/class.llms.admin.addons.php
================================================
<?php
/**
* LifterLMS Add-On browser
*
* This is where the adds are, if you don't like it that's okay but i don't want to hear your complaints!
*
* @package LifterLMS/Admin/Classes
*
* @since 3.5.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_AddOns class
*
* @since 3.5.0
* @since 3.30.3 Explicitly define undefined properties.
* @since 3.35.0 Sanitize input data.
*/
class LLMS_Admin_AddOns {
/**
* Data from `llms_get_add_ons()`.
*
* @var array
* @since 3.5.0
*/
public $data = array();
/**
* Retrieves the current section from the query string.
*
* @since 3.5.0
* @since 3.22.0 Unknown.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return string
*/
private function get_current_section() {
$section = 'all';
if ( isset( $_GET['page'] ) && 'llms-dashboard' === $_GET['page'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
$section = 'featured';
} elseif ( isset( $_GET['section'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
$section = llms_filter_input_sanitize_string( INPUT_GET, 'section' );
}
return apply_filters( 'llms_admin_add_ons_get_current_section', $section );
}
/**
* Retrieve addon data for the current section (tab) based off query string variables
*
* @return array
* @since 3.5.0
* @version 3.22.0
*/
private function get_current_section_content() {
$sec = $this->get_current_section();
$content = apply_filters( 'llms_admin_add_ons_get_current_section_default_content', array(), $sec );
if ( ! $content ) {
if ( 'all' === $sec ) {
$content = $this->get_all();
} elseif ( 'featured' === $sec ) {
$content = $this->get_features();
} else {
$content = $this->get_products_for_cat( $sec );
}
}
return apply_filters( 'llms_admin_add_ons_get_current_section_content', $content, $sec );
}
/**
* Retrieve remote json data.
*
* @since 3.5.0
* @since 3.22.2 Unknown.
* @since 7.1.0 Use strict comparisons for `in_array()`.
*
* @return array|WP_Error
*/
private function get_data() {
$this->data = llms_get_add_ons();
if ( ! is_wp_error( $this->data ) ) {
foreach ( $this->data['items'] as $key => $addon ) {
// Exclude the core plugin and helper plugin.
if ( in_array( $addon['id'], array( 'lifterlms-com-lifterlms', 'lifterlms-com-lifterlms-helper' ), true ) ) {
unset( $this->data['items'][ $key ] );
}
// Exclude uncategorized Add-ons.
if ( array_key_exists( 'uncategorized', $addon['categories'] ) ) {
unset( $this->data['items'][ $key ] );
}
}
}
return $this->data;
}
/**
* Retrieve a list of addons for use on the All section
*
* @return array
* @since 7.5.0
* @version 7.5.0
*/
private function get_all() {
$all = array();
$addons = $this->data['items'];
foreach ( $addons as $addon ) {
// Exclude third-party Addons from the All section.
if ( in_array( 'third-party', array_keys( $addon['categories'] ), true ) ) {
continue;
}
$all[] = $addon;
}
return $all;
}
/**
* Retrieve a list of 'featured' addons for use on the general settings screen
* Excludes already available products from current site's activations
*
* @return array
* @since 3.22.0
* @version 3.22.0
*/
private function get_features() {
$features = array();
// Addons to exclude.
// Helper will filter this based on existing activations.
$exclude = apply_filters( 'llms_admin_addon_features_exclude_ids', array() );
$cats = array(
'e-commerce',
'bundles',
'resources',
'courses',
'courses',
);
foreach ( $cats as $cat ) {
$addon = $this->get_product_from_cat( $cat, $exclude );
if ( $addon ) {
$features[] = $addon;
$exclude[] = $addon['id'];
}
if ( 3 === count( $features ) ) {
return $features;
}
}
return $features;
}
/**
* Get a random product from a category that doesn't exist in the list of excluded product ids.
*
* @since 3.22.0
* @since 7.1.0 Use strict comparisons for `in_array()`.
*
* @param string $cat Category slug.
* @param array $excludes List of product ids to exclude.
* @return array|false
*/
public function get_product_from_cat( $cat, $excludes ) {
$addons = $this->get_products_for_cat( $cat, true );
shuffle( $addons );
foreach ( $addons as $addon ) {
if ( in_array( 'third-party', array_keys( $addon['categories'] ), true ) ) {
continue;
}
if ( ! in_array( $addon['id'], $excludes, true ) ) {
return $addon;
}
}
return false;
}
/**
* Retrieve products for a specific category.
*
* @since 3.22.0
* @since 7.1.0 Use strict comparisons for `in_array()`.
*
* @param string $cat Category slug.
* @return array
*/
private function get_products_for_cat( $cat, $include_bundles = true ) {
$products = array();
foreach ( $this->data['items'] as $item ) {
$cats = array_keys( $item['categories'] );
// Exclude bundles if bundles are not being included or requested.
if ( 'bundles' !== $cat && ! $include_bundles && in_array( 'bundles', $cats, true ) ) {
continue;
}
if ( in_array( $cat, $cats, true ) ) {
$products[] = $item;
}
}
return $products;
}
/**
* Handle form submissions for managing license keys
*
* @return void
* @since 3.22.0
* @version 3.22.0
*/
public function handle_actions() {
// Activate & deactivate addons.
if ( isset( $_REQUEST['_llms_manage_addon_nonce'] ) && wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_llms_manage_addon_nonce'] ) ), 'llms_manage_addon' ) ) {
$this->handle_manage_addons();
LLMS_Admin_Notices::output_notices();
}
}
/**
* Handle activation and deactivation of addons
*
* @since 3.22.0
* @since 3.35.0 Sanitize input data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
private function handle_manage_addons() {
// phpcs:disable WordPress.Security.NonceVerification.Missing -- nonce is verified in $this->handle_actions() method.
$actions = apply_filters(
'llms_admin_add_ons_manage_actions',
array(
'activate',
'deactivate',
)
);
$errors = array();
$success = array();
foreach ( $actions as $action ) {
if ( empty( $_POST[ 'llms_' . $action ] ) ) {
continue;
}
foreach ( llms_filter_input( INPUT_POST, 'llms_' . $action, FILTER_DEFAULT, FILTER_REQUIRE_ARRAY ) as $id ) {
$addon = llms_get_add_on( $id );
if ( ! method_exists( $addon, $action ) ) {
continue;
}
$ret = call_user_func( array( $addon, $action ) );
if ( is_wp_error( $ret ) ) {
LLMS_Admin_Notices::flash_notice( $ret->get_error_message(), 'error' );
} else {
LLMS_Admin_Notices::flash_notice( $ret );
}
}
}
// phpcs:enable WordPress.Security.NonceVerification.Missing
}
/**
* Output HTML for the current screen
*
* @since 3.5.0
* @since 3.28.0 Unknown.
* @since 4.10.1 Use `hr.wp-header-end` in favor of a second (hidden) <h1> to "catch" admin notices.
*
* @return void
*/
public function output() {
if ( is_wp_error( $this->get_data() ) ) {
esc_html_e( 'There was an error retrieving add-ons. Please try again.', 'lifterlms' );
return;
}
?>
<div class="wrap lifterlms lifterlms-settings lifterlms-addons">
<div class="llms-subheader">
<h1><?php esc_html_e( 'LifterLMS Add-Ons, Courses, and Resources', 'lifterlms' ); ?></h1>
<?php do_action( 'llms_addons_page_after_title' ); ?>
</div>
<div class="llms-inside-wrap">
<?php $this->output_navigation(); ?>
<hr class="wp-header-end">
<form action="" method="POST">
<?php $this->output_content(); ?>
<?php wp_nonce_field( 'llms_manage_addon', '_llms_manage_addon_nonce' ); ?>
<div class="llms-addons-bulk-actions" id="llms-addons-bulk-actions">
<a class="llms-bulk-close" href="#">
<span class="screen-reader-text"><?php esc_html_e( 'Close', 'lifterlms' ); ?></span>
<i class="fa fa-times-circle" aria-hidden="true"></i>
</a>
<div class="llms-bulk-desc update">
<i class="fa fa-cloud-download" aria-hidden="true"></i>
<?php esc_html_e( 'Update', 'lifterlms' ); ?> <span></span>
</div>
<div class="llms-bulk-desc install">
<i class="fa fa-cloud-download" aria-hidden="true"></i>
<?php esc_html_e( 'Install', 'lifterlms' ); ?> <span></span>
</div>
<div class="llms-bulk-desc activate">
<i class="fa fa-plug" aria-hidden="true"></i>
<?php esc_html_e( 'Activate', 'lifterlms' ); ?> <span></span>
</div>
<div class="llms-bulk-desc deactivate">
<i class="fa fa-plug" aria-hidden="true"></i>
<?php esc_html_e( 'Deactivate', 'lifterlms' ); ?> <span></span>
</div>
<button class="llms-button-primary" name="llms_bulk_actions_submit" value="" type="submit"><?php esc_html_e( 'Apply', 'lifterlms' ); ?></button>
</div>
</form>
</div>
</div>
<?php
}
/**
* Output HTML for a single addon
*
* @param array $addon associative array of add-on data
* @return void
* @since 3.5.0
* @version 3.22.0
*/
private function output_addon( $addon ) {
$current_tab = $this->get_current_section();
include 'views/addons/addon-item.php';
}
/**
* Output the addon list for the current section
*
* @return void
* @since 3.5.0
* @version 3.22.0
*/
private function output_content() {
?>
<ul class="llms-addons-wrap section--<?php echo esc_attr( $this->get_current_section() ); ?>">
<?php do_action( 'lifterlms_before_addons' ); ?>
<?php
foreach ( $this->get_current_section_content() as $addon ) {
$addon = llms_get_add_on( $addon );
$this->output_addon( $addon );
}
?>
<?php do_action( 'lifterlms_after_addons' ); ?>
</ul>
<?php
}
/**
* Outputs most popular resources
* used on general settings screen
*
* @return void
* @since 3.7.6
* @version 3.7.6
*/
public function output_for_settings() {
if ( is_wp_error( $this->get_data() ) ) {
esc_html_e( 'There was an error retrieving add-ons. Please try again.', 'lifterlms' );
return;
}
$this->output_content();
}
/**
* Output the navigation bar
*
* @return void
* @since 3.5.0
* @version 3.22.0
*/
private function output_navigation() {
$curr_section = $this->get_current_section();
?>
<nav class="llms-nav-tab-wrapper llms-nav-secondary">
<ul class="llms-nav-items">
<?php do_action( 'lifterlms_before_addons_nav', $curr_section ); ?>
<?php
foreach ( $this->data['categories'] as $name => $title ) :
$name = sanitize_title( $name );
$title = sanitize_text_field( $title );
$active = ( $this->get_current_section() === $name ) ? ' llms-active' : '';
?>
<li class="llms-nav-item<?php echo esc_attr( $active ); ?>"><a class="llms-nav-link" href="<?php echo esc_url( admin_url( 'admin.php?page=llms-add-ons§ion=' . $name ) ); ?>"><?php echo esc_html( $title ); ?></a></li>
<?php endforeach; ?>
<li class="llms-nav-item<?php echo ( 'all' === $curr_section ) ? ' llms-active' : ''; ?>"><a class="llms-nav-link" href="<?php echo esc_url( admin_url( 'admin.php?page=llms-add-ons§ion=all' ) ); ?>"><?php esc_html_e( 'All', 'lifterlms' ); ?></a></li>
<?php do_action( 'lifterlms_after_addons_nav', $curr_section ); ?>
</ul>
</nav>
<?php
}
}
================================================
FILE: includes/admin/class.llms.admin.assets.php
================================================
<?php
/**
* LLMS_Admin_Assets class
*
* @package LifterLMS/Admin/Classes
*
* @since 1.0.0
* @version 7.4.1
*/
defined( 'ABSPATH' ) || exit;
/**
* Register and enqueue admin assets.
*
* @since 1.0.0
*/
class LLMS_Admin_Assets {
/**
* Constructor
*
* @since 1.0.0
* @since 3.17.5 Unknown.
* @since 6.0.0 Add hooks for admin inline footer scripts, inline header styles, and block editor assets.
*
* @return void
*/
public function __construct() {
add_action( 'admin_enqueue_scripts', array( $this, 'admin_styles' ) );
add_action( 'admin_enqueue_scripts', array( $this, 'admin_scripts' ) );
add_action( 'wp_enqueue_media', array( $this, 'admin_media' ) );
add_action( 'admin_print_styles', array( $this, 'admin_print_styles' ) );
add_action( 'admin_print_scripts', array( $this, 'admin_print_scripts' ) );
add_action( 'admin_print_footer_scripts', array( $this, 'admin_print_footer_scripts' ) );
add_action( 'enqueue_block_editor_assets', array( $this, 'block_editor_assets' ) );
add_action( 'elementor/editor/before_enqueue_scripts', array( $this, 'elementor_editor_assets' ) );
}
/**
* Output inline scripts in the admin footer.
*
* @since 6.0.0
*
* @return void
*/
public function admin_print_footer_scripts() {
llms()->assets->output_inline( 'footer' );
}
/**
* Output inline styles in the header.
*
* @since 6.0.0
*
* @return void
*/
public function admin_print_styles() {
llms()->assets->output_inline( 'style' );
}
/**
* Enqueue assets for the block editor.
*
* @since 6.0.0
*
* @return void
*/
public function block_editor_assets() {
$screen = get_current_screen();
if ( $screen && $screen->is_block_editor && in_array( $screen->post_type, array( 'llms_certificate', 'llms_my_certificate' ), true ) ) {
$this->block_editor_assets_for_certificates();
}
if ( $screen && $screen->is_block_editor && current_user_can( 'edit_courses' ) ) {
llms()->assets->enqueue_script( 'llms-admin-media-protection-block-protect' );
}
}
public function elementor_editor_assets() {
if ( isset( $_REQUEST['post'] ) && is_numeric( $_REQUEST['post'] ) && 'course' === get_post_type( intval( $_REQUEST['post'] ) ) ) {
llms()->assets->enqueue_script( 'llms-admin-elementor-editor' );
wp_localize_script( 'llms-admin-elementor-editor', 'llms_elementor', array( 'builder_url' => admin_url( 'admin.php?page=llms-course-builder&course_id=' . intval( $_REQUEST['post'] ) ) ) );
}
}
/**
* Enqueue block editor assets for certificate post types.
*
* @since 6.0.0
* @since 6.5.0 Use `wp_slash()` after `wp_json_encode()` to prevent issues encountered when strings contain single quotes.
*
* @return void
*/
private function block_editor_assets_for_certificates() {
llms()->assets->enqueue_script( 'llms-admin-certificate-editor' );
$settings = array(
'default_image' => llms()->certificates()->get_default_image( get_the_ID() ),
'sizes' => llms_get_certificate_sizes(),
'orientations' => llms_get_certificate_orientations(),
'units' => llms_get_certificate_units(),
'colors' => array(
array(
'name' => __( 'White', 'lifterlms' ),
'slug' => 'white',
'color' => '#ffffff',
),
array(
'name' => __( 'White Smoke', 'lifterlms' ),
'slug' => 'white-smoke',
'color' => '#f5f5f5',
),
array(
'name' => __( 'Ivory', 'lifterlms' ),
'slug' => 'ivory',
'color' => '#fffff0',
),
),
'merge_codes' => llms_get_certificate_merge_codes(),
);
llms()->assets->enqueue_inline(
'llms-admin-certificate-settings',
"window.llms = window.llms || {};window.llms.certificates=JSON.parse( '" . wp_slash( wp_json_encode( $settings ) ) . "' );",
'footer'
);
global $wp_version;
$supports_fonts = version_compare( $wp_version, '5.9-src', '>=' );
$fonts = $supports_fonts ? llms_get_certificate_fonts() : new stdClass();
$styles = '';
foreach ( $fonts as $id => $data ) {
if ( ! empty( $data['href'] ) ) {
wp_enqueue_style( 'llms-font-' . $id, $data['href'], array(), LLMS_VERSION );
}
$css = $data['fontFamily'];
$styles .= ".editor-styles-wrapper .has-{$id}-font-family { font-family: {$css} !important }\n";
}
llms()->assets->enqueue_inline(
'llms-admin-certificate-styles',
$styles,
'style'
);
}
/**
* Determine if the current screen should load LifterLMS assets
*
* @since 3.7.0
* @since 3.19.4 Unknown.
*
* @return bool
*/
public function is_llms_page() {
$screen = get_current_screen();
$id = str_replace( 'edit-', '', $screen->id );
if ( false !== strpos( $id, 'lifterlms' ) ) {
return true;
} elseif ( false !== strpos( $id, 'llms' ) ) {
return true;
} elseif ( in_array( $id, array( 'course', 'lesson' ), true ) ) {
return true;
} elseif ( ! empty( $screen->post_type ) && post_type_supports( $screen->post_type, 'llms-membership-restrictions' ) ) {
return true;
} elseif ( in_array( $screen->id, array( 'users' ), true ) ) {
return true;
} elseif ( 'attachment' === $id || 'upload' === $id ) {
return true;
}
return false;
}
/**
* Enqueue stylesheets
*
* @since 1.0.0
* @since 3.29.0 Unknown.
* @since 3.35.0 Explicitly set asset versions.
* @since 5.0.0 Use `LLMS_Assets` for registration/enqueue of styles.
* @since 5.5.0 Use `LLMS_Assets` for the enqueue of `llms-addons`.
* @since 7.2.0 Use `LLMS_ASSETS_VERSION` for asset versions.
*
* @return void
*/
public function admin_styles() {
wp_enqueue_style( 'llms-admin-styles', LLMS_PLUGIN_URL . 'assets/css/admin' . LLMS_ASSETS_SUFFIX . '.css', array(), LLMS_ASSETS_VERSION );
wp_style_add_data( 'llms-admin-styles', 'rtl', 'replace' );
wp_style_add_data( 'llms-admin-styles', 'suffix', LLMS_ASSETS_SUFFIX );
if ( ! $this->is_llms_page() ) {
return;
}
llms()->assets->enqueue_style( 'llms-select2-styles' );
$screen = get_current_screen();
if ( 'lifterlms_page_llms-add-ons' === $screen->id || 'lifterlms_page_llms-dashboard' === $screen->id ) {
llms()->assets->enqueue_style( 'llms-admin-add-ons' );
}
}
/**
* Enqueue scripts.
*
* @since 1.0.0
* @since 3.22.0 Unknown.
* @since 3.35.0 Explicitly set asset versions.
* @since 3.35.1 Don't reference external scripts & styles.
* @since 4.3.3 Move logic for reporting/analytics scripts to `maybe_enqueue_reporting()`.
* @since 4.4.0 Enqueue the main `llms` script.
* @since 5.0.0 Clean up duplicate references to llms-select2 and register the script using `LLMS_Assets`.
* Remove topModal vendor dependency.
* Add `llms-admin-forms` on the forms post table screen.
* @since 5.5.0 Use `LLMS_Assets` for the enqueue of `llms-admin-add-ons`.
* @since 6.0.0 Enqueue certificate and achievement related js in `llms_my_certificate`, `llms_my_achievement` post types as well.
* @since 7.1.0 Enqueue `postbox` script on the new dashboard page.
* @since 7.2.0 Use `LLMS_ASSETS_VERSION` for asset versions.
* Enqueue reporting scripts on dashboard page.
* @since 7.4.1 Enqueue `postbox` script on the new resources page.
*
* @return void
*/
public function admin_scripts() {
global $post_type, $post;
$screen = get_current_screen();
if ( 'widgets' === $screen->id ) {
wp_enqueue_script( 'llms-widget-syllabus', LLMS_PLUGIN_URL . 'assets/js/llms-widget-syllabus' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
}
llms()->assets->register_script( 'llms-select2' );
wp_register_script( 'llms-metaboxes', LLMS_PLUGIN_URL . 'assets/js/llms-metaboxes' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery', 'jquery-ui-datepicker', 'llms-admin-scripts', 'llms-select2' ), LLMS_ASSETS_VERSION, true );
if ( ( post_type_exists( $screen->id ) && post_type_supports( $screen->id, 'llms-membership-restrictions' ) ) || 'dashboard_page_llms-setup' === $screen->id ) {
wp_enqueue_script( 'llms-metaboxes' );
}
$tables = apply_filters(
'llms_load_table_resources_pages',
array(
'course',
'lifterlms_page_llms-reporting',
'llms_membership',
)
);
if ( in_array( $screen->id, $tables, true ) ) {
wp_register_script( 'llms-admin-tables', LLMS_PLUGIN_URL . 'assets/js/llms-admin-tables' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
wp_enqueue_script( 'llms-admin-tables' );
}
wp_register_script( 'llms', LLMS_PLUGIN_URL . 'assets/js/llms' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
wp_register_script( 'llms-admin-scripts', LLMS_PLUGIN_URL . 'assets/js/llms-admin' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery', 'llms', 'llms-select2' ), LLMS_ASSETS_VERSION, true );
wp_register_script( 'llms-admin-media-protection-attachment-settings', LLMS_PLUGIN_URL . 'assets/js/llms-admin-media-protection-attachment-settings' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery', 'media-views', 'wp-i18n', 'llms-admin-scripts' ), LLMS_ASSETS_VERSION, true );
if ( $this->is_llms_page() ) {
llms()->assets->enqueue_script( 'llms' );
wp_enqueue_script( 'jquery-ui-datepicker' );
wp_enqueue_script( 'jquery-ui-sortable' );
wp_enqueue_script( 'llms-admin-scripts' );
wp_register_style( 'jquery-ui-flick', LLMS_PLUGIN_URL . 'assets/vendor/jquery-ui-flick/jquery-ui-flick' . LLMS_ASSETS_SUFFIX . '.css', array(), '1.11.2' );
wp_enqueue_style( 'jquery-ui-flick' );
wp_enqueue_script( 'llms-ajax', LLMS_PLUGIN_URL . 'assets/js/llms-ajax' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
wp_enqueue_media();
if ( 'course' === $post_type ) {
wp_enqueue_script( 'llms-metabox-fields', LLMS_PLUGIN_URL . 'assets/js/llms-metabox-fields' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
if ( ! use_block_editor_for_post_type( 'course' ) && $post ) {
wp_enqueue_script( 'llms-launch-course-button', LLMS_PLUGIN_URL . 'assets/js/llms-launch-course-button' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
wp_localize_script( 'llms-launch-course-button', 'llms_launch_course', array( 'builder_url' => admin_url( 'admin.php?page=llms-course-builder&course_id=' . intval( $post->ID ) ) ) );
}
}
if ( 'course' === $post_type || 'llms_membership' === $post_type ) {
self::register_quill();
self::register_a11y_dialog();
wp_enqueue_script( 'llms-metabox-students', LLMS_PLUGIN_URL . 'assets/js/llms-metabox-students' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery', 'llms-select2' ), LLMS_ASSETS_VERSION, true );
wp_enqueue_script( 'llms-metabox-product', LLMS_PLUGIN_URL . 'assets/js/llms-metabox-product' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery', 'llms', 'llms-a11y-dialog' ), LLMS_ASSETS_VERSION, true );
wp_enqueue_script( 'llms-metabox-instructors', LLMS_PLUGIN_URL . 'assets/js/llms-metabox-instructors' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery', 'llms' ), LLMS_ASSETS_VERSION, true );
wp_enqueue_script( 'llms-metabox-options', LLMS_PLUGIN_URL . 'assets/js/llms-metabox-options' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery', 'llms', 'llms-quill' ), LLMS_ASSETS_VERSION, true );
wp_enqueue_style( 'llms-quill-bubble' );
}
if ( 'lesson' === $post_type ) {
wp_enqueue_script( 'llms-metabox-fields', LLMS_PLUGIN_URL . 'assets/js/llms-metabox-fields' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
}
if ( in_array( $post_type, array( 'llms_certificate', 'llms_my_certificate' ), true ) ) {
wp_enqueue_script( 'llms-metabox-certificate', LLMS_PLUGIN_URL . 'assets/js/llms-metabox-certificate' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
}
if ( in_array( $post_type, array( 'llms_achievement', 'llms_my_achievement' ), true ) ) {
wp_enqueue_script( 'llms-metabox-achievement', LLMS_PLUGIN_URL . 'assets/js/llms-metabox-achievement' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
}
if ( 'llms_membership' === $post_type ) {
wp_enqueue_script( 'llms-metabox-fields', LLMS_PLUGIN_URL . 'assets/js/llms-metabox-fields' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
}
if ( 'llms_voucher' === $post_type ) {
wp_enqueue_script( 'llms-metabox-voucher', LLMS_PLUGIN_URL . 'assets/js/llms-metabox-voucher' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
}
$this->maybe_enqueue_reporting( $screen );
wp_enqueue_script( 'llms' );
wp_enqueue_script( 'llms-metaboxes' );
// Load forms advert/compat script.
if ( 'edit-llms_form' === $screen->id ) {
llms()->assets->enqueue_script( 'llms-admin-forms' );
}
}
if ( 'dashboard' === $screen->base ) {
$this->maybe_enqueue_reporting( $screen );
}
if ( 'lifterlms_page_llms-settings' === $screen->id ) {
wp_enqueue_media();
wp_enqueue_script( 'llms-admin-settings', LLMS_PLUGIN_URL . 'assets/js/llms-admin-settings' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery', 'jquery-ui-sortable' ), LLMS_ASSETS_VERSION, true );
} elseif ( 'admin_page_llms-course-builder' === $screen->id ) {
self::register_quill();
wp_enqueue_editor();
wp_enqueue_style( 'llms-builder-styles', LLMS_PLUGIN_URL . 'assets/css/builder' . LLMS_ASSETS_SUFFIX . '.css', array( 'llms-quill-bubble' ), LLMS_ASSETS_VERSION, 'screen' );
wp_style_add_data( 'llms-builder-styles', 'rtl', 'replace' );
wp_style_add_data( 'llms-builder-styles', 'suffix', LLMS_ASSETS_SUFFIX );
wp_enqueue_style( 'webui-popover', LLMS_PLUGIN_URL . 'assets/vendor/webui-popover/jquery.webui-popover' . LLMS_ASSETS_SUFFIX . '.css', array(), '1.2.15' );
wp_style_add_data( 'webui-popover', 'suffix', LLMS_ASSETS_SUFFIX );
wp_enqueue_script( 'webui-popover', LLMS_PLUGIN_URL . 'assets/vendor/webui-popover/jquery.webui-popover' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), LLMS_ASSETS_VERSION, true );
wp_enqueue_style( 'llms-datetimepicker', LLMS_PLUGIN_URL . 'assets/vendor/datetimepicker/jquery.datetimepicker.min.css', array(), '1.3.4' );
wp_enqueue_script( 'llms-datetimepicker', LLMS_PLUGIN_URL . 'assets/vendor/datetimepicker/jquery.datetimepicker.full' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), '1.3.4', true );
if ( apply_filters( 'llms_builder_use_heartbeat', true ) ) {
wp_enqueue_script( 'heartbeat' );
}
wp_enqueue_script( 'llms-builder', LLMS_PLUGIN_URL . 'assets/js/llms-builder' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery', 'jquery-ui-sortable', 'jquery-ui-draggable', 'backbone', 'underscore', 'post', 'llms-quill' ), LLMS_ASSETS_VERSION, true );
} elseif ( 'lifterlms_page_llms-add-ons' === $screen->id ) {
llms()->assets->enqueue_script( 'llms-addons' );
} elseif ( in_array( $screen->id, array( 'lifterlms_page_llms-dashboard', 'lifterlms_page_llms-resources' ), true ) ) {
wp_enqueue_script( 'postbox' );
}
if (
'edit-llms_my_certificate' === $screen->id ||
(
'lifterlms_page_llms-reporting' === $screen->id &&
'students' === llms_filter_input( INPUT_GET, 'tab' ) &&
'certificates' === llms_filter_input( INPUT_GET, 'stab' )
)
) {
llms()->assets->enqueue_script( 'llms-admin-award-certificate' );
wp_enqueue_style( 'wp-editor' );
}
}
/**
* Register the media protection scripts when the media is enqueued.
*
* @since 9.0.6
*
* @return void
*/
public function admin_media() {
if ( ! is_admin() ) {
return;
}
wp_enqueue_script( 'llms-admin-media-protection-attachment-settings' );
}
/**
* Initialize the "llms" object for other scripts to hook into
*
* @since 1.0.0
* @since 3.7.5 Unknown.
* @since 4.4.0 Add `ajax_nonce`.
* @since 4.5.1 Add an analytics localization object.
* @since 5.0.0 Output Form location information as a window variable for block editor utilization.
* @since 5.9.0 Use `wp_slash()` after `wp_json_encode()` to prevent issues encountered when strings contain single quotes.
* @since 7.1.1 Add `home_url`.
*
* @return void
*/
public function admin_print_scripts() {
$screen = get_current_screen();
global $post;
$postdata = array();
if ( ! empty( $post ) ) {
$postdata = array(
'id' => $post->ID,
'post_type' => $post->post_type,
);
}
echo '
<script type="text/javascript">
window.llms = window.llms || {};
window.llms.ajax_nonce = "' . esc_attr( wp_create_nonce( LLMS_AJAX::NONCE ) ) . '";
window.llms.admin_url = "' . esc_url( admin_url() ) . '";
window.llms.home_url = "' . esc_url( home_url() ) . '";
window.llms.post = ' . wp_json_encode( $postdata ) . ';
window.llms.analytics = ' . wp_json_encode( $this->get_analytics_options() ) . ';
</script>
';
echo '<script type="text/javascript">window.LLMS = window.LLMS || {};</script>';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- get_js_strings returns json_encoded strings.
echo '<script type="text/javascript">window.LLMS.l10n = window.LLMS.l10n || {}; window.LLMS.l10n.strings = ' . wp_json_encode( LLMS_L10n::get_js_strings( false ) ) . ';</script>';
$forms = LLMS_Forms::instance()->get_post_type();
if ( $forms === $screen->id ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Output is escaped in `wp_slash()`.and wp_json_encode()
echo "<script>window.llms.formLocations = JSON.parse( '" . wp_slash( wp_json_encode( LLMS_Forms::instance()->get_locations() ) ) . "' );</script>";
}
if ( ! empty( $screen->is_block_editor ) || 'customize' === $screen->base ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Output is escaped in `wp_slash()`.and wp_json_encode()
echo "<script>window.llms.userInfoFields = JSON.parse( '" . wp_slash( wp_json_encode( llms_get_user_information_fields_for_editor() ) ) . "' );</script>";
}
}
/**
* Retrieve an array of options used to localize the `llms.analytics` JS instance.
*
* @since 4.5.1
*
* @return array
*/
protected function get_analytics_options() {
/**
* Create a number format string readable by google charts
*
* Replacing `9.9` with `9,9` and `0,0` with `0.0` to prevent loading errors encountered
* as a result of the chart pattern not allowing usage of a comma for the decimal separator.
*
* @see https://stackoverflow.com/a/18204679/400568
*/
$currency_format = str_replace( array( '9.9', '0,0', '9' ), array( '9,9', '0.0', '#' ), llms_price_raw( 9990.00 ) );
/**
* Customize Javascript localization options passed to the `llms.analytics` JS instance.
*
* @since 4.5.1
*
* @param array $opts Associative array of option data.
*/
return apply_filters( 'llms_get_analytics_js_options', compact( 'currency_format' ) );
}
/**
* Register and enqueue scripts used on and related-to reporting and analytics
*
* @since 4.3.3
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 7.2.0 Load on dashboard screen.
* Use `LLMS_ASSETS_VERSION` for asset versions.
*
* @param WP_Sreen $screen Screen object from WP `get_current_screen()`.
* @return void
*/
protected function maybe_enqueue_reporting( $screen ) {
if ( in_array( $screen->base, array( 'lifterlms_page_llms-reporting', 'lifterlms_page_llms-dashboard', 'dashboard' ), true ) ) {
$current_tab = llms_filter_input( INPUT_GET, 'tab' );
wp_register_script( 'llms-google-charts', LLMS_PLUGIN_URL . 'assets/js/vendor/gcharts-loader.min.js', array(), '2019-09-04', false );
wp_register_script( 'llms-analytics', LLMS_PLUGIN_URL . 'assets/js/llms-analytics' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery', 'llms', 'llms-admin-scripts', 'llms-google-charts' ), LLMS_ASSETS_VERSION, true );
// Dashboard page where we have analytics widgets.
if ( in_array( $screen->base, array( 'lifterlms_page_llms-dashboard', 'dashboard' ), true ) ) {
wp_enqueue_script( 'llms-analytics' );
} elseif ( 'lifterlms_page_llms-reporting' === $screen->base ) {
if ( in_array( $current_tab, array( 'enrollments', 'sales' ), true ) ) {
wp_enqueue_script( 'llms-analytics' );
} elseif ( 'quizzes' === $current_tab && 'attempts' === llms_filter_input( INPUT_GET, 'stab' ) ) {
wp_enqueue_script( 'llms-quiz-attempt-review', LLMS_PLUGIN_URL . 'assets/js/llms-quiz-attempt-review' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery', 'llms' ), LLMS_ASSETS_VERSION, true );
}
}
}
}
/**
* Register Quill CSS & JS
*
* @since 3.16.0
* @since 3.17.8 Unknown.
* @since 6.10.0 Load modules using `llms()->assets`.
*
* @return void
*/
public static function register_quill( $modules = array() ) {
if ( ! wp_script_is( 'llms-quill', 'registered' ) ) {
wp_register_script( 'llms-quill', LLMS_PLUGIN_URL . 'assets/vendor/quill/quill' . LLMS_ASSETS_SUFFIX . '.js', array(), '2.0.2', true );
wp_register_style( 'llms-quill-bubble', LLMS_PLUGIN_URL . 'assets/vendor/quill/quill.bubble' . LLMS_ASSETS_SUFFIX . '.css', array(), '1.3.5', 'screen' );
}
foreach ( $modules as $module ) {
llms()->assets->register_script( "llms-quill-{$module}" );
}
}
/**
* Register the accessible dialog JS
*
* @since 8.0.0
*
* @return void
*/
public static function register_a11y_dialog() {
if ( ! wp_script_is( 'llms-a11y-dialog', 'registered' ) ) {
wp_register_script( 'llms-a11y-dialog', LLMS_PLUGIN_URL . 'assets/vendor/a11y-dialog/a11y-dialog.min.js', array(), '8.1.1', true );
}
}
}
return new LLMS_Admin_Assets();
================================================
FILE: includes/admin/class.llms.admin.builder.php
================================================
<?php
/**
* LifterLMS Admin Course Builder
*
* @package LifterLMS/Admin/Classes
*
* @since 3.13.0
* @version 7.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Builder class
*
* @since 3.13.0
* @since 3.30.0 Fixed issues related to custom field sanitization.
* @since 3.37.11 Made method `get_existing_posts_where()` static.
* @since 3.37.12 Refactored the `process_trash()` method.
* Added new filter, `llms_builder_{$post_type}_force_delete` to allow control of how post type deletion is handled
* when deleted via the builder.
* @since 3.38.0 Improve backwards compatibility handling for the `llms_get_quiz_theme_settings` filter.
* @since 3.38.2 On quiz saving, made sure that a question as a type set, otherwise set it by default to `'choice'`.
*/
class LLMS_Admin_Builder {
/**
* Search term string used by `get_existing_posts_where()` when querying for existing posts to clone/add to a course.
*
* @var string
*/
private static $search_term = '';
/**
* Add menu items to the WP Admin Bar to allow quiz returns to the dashboard from the course builder
*
* @since 3.16.7
* @since 3.24.0 Unknown.
*
* @param WP_Admin_Bar $wp_admin_bar Instance of WP_Admin_Bar
* @return void
*/
public static function admin_bar_menu( $wp_admin_bar ) {
// Partially lifted from `wp_admin_bar_site_menu()` in wp-includes/admin-bar.php.
if ( current_user_can( 'read' ) ) {
$wp_admin_bar->add_menu(
array(
'parent' => 'site-name',
'id' => 'dashboard',
'title' => __( 'Dashboard', 'lifterlms' ),
'href' => admin_url(),
)
);
$wp_admin_bar->add_menu(
array(
'parent' => 'site-name',
'id' => 'llms-courses',
'title' => __( 'Courses', 'lifterlms' ),
'href' => admin_url( 'edit.php?post_type=course' ),
)
);
wp_admin_bar_appearance_menu( $wp_admin_bar );
}
}
/**
* Retrieve the current user's builder autosave preferences
*
* Defaults to enabled for users who have never configured a setting value.
*
* @since 4.14.0
*
* @return string Either "yes" or "no".
*/
protected static function get_autosave_status() {
$autosave = get_user_option( 'llms_builder_autosave' );
$autosave = empty( $autosave ) ? 'no' : $autosave;
/**
* Gets the status of autosave for the builder
*
* This can be configured on a per-user basis in the user's profile screen on the WP Admin Panel.
*
* @since 4.14.0
*
* @param string $autosave Status of autosave for the current user. Either "yes" or "no".
*/
return apply_filters( 'llms_builder_autosave_enabled', $autosave );
}
/**
* Retrieve custom field schemas
*
* @since 3.17.0
* @since 3.17.6 Add backwards compatibility for the deprecated `llms_get_quiz_theme_settings` filter.
* @since 3.38.0 Only run backwards compatibility for `llms_get_quiz_theme_settings` when the filter is being used.
*
* @return array
*/
private static function get_custom_schemas() {
$quiz_fields = array();
/**
* Handle old quiz layout compatibility API:
* Translate the old filter into the new one for quizzes.
*/
if ( get_theme_support( 'lifterlms-quizzes' ) && has_filter( 'llms_get_quiz_theme_settings' ) ) {
$theme = wp_get_theme();
$old = llms_get_quiz_theme_setting( 'layout' );
$field = array(
'attribute' => $old['id'],
'id' => $old['id'],
'label' => $old['name'],
'type' => ( 'select' === $old['type'] ) ? 'select' : 'radio',
'options' => $old['options'],
);
if ( isset( $old['id_prefix'] ) ) {
$field['attribute_prefix'] = $old['id_prefix'];
}
$quiz_fields[ sprintf( '%s_backwards_theme_group', $theme->get_stylesheet() ) ] = array(
// Translators: %s = Theme name.
'title' => sprintf( __( '%s Theme Settings', 'lifterlms' ), $theme->get( 'Name' ) ),
'toggleable' => true,
'fields' => array( array( $field ) ),
);
}
/**
* Add custom fields to the LifterLMS Builder.
*
* @since 3.17.0
*
* @link https://lifterlms.com/docs/course-builder-custom-fields-for-developers
*
* @param array[] $fields Array of post types containing arrays of custom field data.
*/
return apply_filters(
'llms_builder_register_custom_fields',
array(
'lesson' => array(),
'quiz' => $quiz_fields,
)
);
}
/**
* Retrieve a list of lessons the current user is allowed to clone/attach
*
* Used for ajax searching to add existing lessons.
*
* @since 3.14.8
* @since 3.16.12 Unknown.
* @since 5.8.0 Allow LMS managers to get all lessons. {@link https://github.com/gocodebox/lifterlms/issues/1849}.
* Removed unused `$course_id` parameter.
*
* @param string $post_type Optional. Search specific post type(s). By default searches for all post types.
* @param string $search_term Optional. Search term (searches post_title). Default is empty string.
* @param int $page Optional. Used when paginating search results. Default is `1`.
* @return array
*/
private static function get_existing_posts( $post_type = '', $search_term = '', $page = 1 ) {
$args = array(
'order' => 'ASC',
'orderby' => 'post_title',
'paged' => $page,
'post_status' => array( 'publish', 'draft', 'pending' ),
'posts_per_page' => 10,
);
if ( $post_type ) {
$args['post_type'] = $post_type;
}
if ( ! current_user_can( 'manage_lifterlms' ) ) {
$instructor = llms_get_instructor();
$parents = $instructor->get( 'parent_instructors' );
if ( ! $parents ) {
$parents = array();
}
$args['author__in'] = array_unique(
array_merge(
array( get_current_user_id() ),
$instructor->get_assistants(),
$parents
)
);
}
self::$search_term = $search_term;
add_filter( 'posts_where', array( __CLASS__, 'get_existing_posts_where' ), 10, 2 );
$query = new WP_Query( $args );
remove_filter( 'posts_where', array( __CLASS__, 'get_existing_posts_where' ), 10, 2 );
$posts = array();
if ( $query->have_posts() ) {
foreach ( $query->posts as $post ) {
$post = llms_get_post( $post );
$parents = array();
if ( method_exists( $post, 'is_orphan' ) && $post->is_orphan() ) {
$action = 'attach';
} else {
$action = 'clone';
$course_id = false;
$lesson_id = false;
if ( 'lesson' === $post->get( 'type' ) ) {
$course_id = $post->get( 'parent_course' );
} elseif ( 'llms_quiz' === $post->get( 'type' ) ) {
$lesson_id = $post->get( 'lesson_id' );
$course = $post->get_course();
if ( $course ) {
$course_id = $course->get( 'id' );
}
}
if ( $lesson_id ) {
// Translators: %1$s = Lesson title; %2$d = Lesson id.
$parents['lesson'] = sprintf( __( 'Lesson: %1$s (#%2$d)', 'lifterlms' ), '<em>' . get_the_title( $lesson_id ) . '</em>', $lesson_id );
}
if ( $course_id ) {
// Translators: %1$s = Course title; %2$d - Course id.
$parents['course'] = sprintf( __( 'Course: %1$s (#%2$d)', 'lifterlms' ), '<em>' . get_the_title( $course_id ) . '</em>', $course_id );
}
}
$posts[] = array(
'action' => $action,
'data' => $post,
'id' => $post->get( 'id' ),
'parents' => $parents,
'text' => sprintf( '%1$s (#%2$d)', $post->get( 'title' ), $post->get( 'id' ) ),
);
}
}
$ret = array(
'results' => $posts,
'pagination' => array(
'more' => ( $page < $query->max_num_pages ),
),
);
return $ret;
}
/**
* Search lessons by search term during existing lesson lookups
*
* @since 3.14.8
* @since 3.16.12 Unknown.
* @since 3.37.11 Made method static.
*
* @param string $where Existing sql where clause.
* @param WP_QUery $wp_query Query object.
* @return string
*/
public static function get_existing_posts_where( $where, $wp_query ) {
if ( self::$search_term ) {
global $wpdb;
$where .= ' AND ' . $wpdb->posts . '.post_title LIKE "%' . esc_sql( $wpdb->esc_like( self::$search_term ) ) . '%"';
}
return $where;
}
/**
* Retrieve the HTML of a JS template
*
* @since 3.16.0
*
* @param string $template Template file slug.
* @return string
*/
private static function get_template( $template, $vars = array() ) {
ob_start();
extract( $vars );
include 'views/builder/' . $template . '.php';
return ob_get_clean();
}
/**
* A terrible Rest API for the course builder
*
* @since 3.13.0
* @since 3.19.2 Unknown.
* @since 4.16.0 Remove all filters/actions applied to the title/content when handling the ajax_save by deafault.
* This is specially to prevent plugin conflicts, see https://github.com/gocodebox/lifterlms/issues/1530.
* @since 4.17.0 Remove `remove_all_*` hooks added in version 4.16.0.
*
* @param array $request $_REQUEST
* @return array
*/
public static function handle_ajax( $request ) {
if ( ! $request['course_id'] || ! current_user_can( 'edit_course', $request['course_id'] ) ) {
return array();
}
switch ( $request['action_type'] ) {
case 'ajax_save':
if ( isset( $request['llms_builder'] ) ) {
$request['llms_builder'] = stripslashes( $request['llms_builder'] );
wp_send_json( self::heartbeat_received( array(), $request ) );
}
break;
case 'get_permalink':
$id = isset( $request['id'] ) ? absint( $request['id'] ) : false;
if ( ! $id ) {
return array();
}
$title = isset( $request['title'] ) ? sanitize_title( $request['title'] ) : null;
$slug = isset( $request['slug'] ) ? sanitize_title( $request['slug'] ) : null;
$link = get_sample_permalink( $id, $title, $slug );
wp_send_json(
array(
'slug' => $link[1],
'permalink' => str_replace( '%pagename%', $link[1], $link[0] ),
)
);
break;
case 'lazy_load':
$ret = array();
if ( isset( $request['load_id'] ) ) {
$post = llms_get_post( absint( $request['load_id'] ) );
$ret = $post->toArray();
}
wp_send_json( $ret );
break;
case 'search':
$page = isset( $request['page'] ) ? $request['page'] : 1;
$term = isset( $request['term'] ) ? sanitize_text_field( $request['term'] ) : '';
$post_type = '';
if ( isset( $request['post_type'] ) ) {
if ( is_array( $request['post_type'] ) ) {
$post_type = array_map( 'sanitize_text_field', $request['post_type'] );
} else {
$post_type = sanitize_text_field( $request['post_type'] );
}
}
wp_send_json( self::get_existing_posts( $post_type, $term, $page ) );
break;
}
return array();
}
/**
* Do post locking stuff on the builder
*
* Locking the course edit main screen will lock the builder and vice versa... probably need to find a way
* to fix that but for now this'll work just fine and if you're unhappy about it, well, sorry...
*
* @since 3.13.0
*
* @param int $course_id WP Post ID.
* @return void
*/
private static function handle_post_locking( $course_id ) {
if ( ! wp_check_post_lock( $course_id ) ) {
$active_post_lock = wp_set_post_lock( $course_id );
}
?><input type="hidden" id="post_ID" value="<?php echo absint( $course_id ); ?>">
<?php
if ( ! empty( $active_post_lock ) ) {
?>
<input type="hidden" id="active_post_lock" value="<?php echo esc_attr( implode( ':', $active_post_lock ) ); ?>" />
<?php
}
add_filter( 'get_edit_post_link', array( __CLASS__, 'modify_take_over_link' ), 10, 3 );
add_action( 'admin_footer', '_admin_notice_post_locked' );
}
/**
* Handle AJAX Heartbeat received calls
*
* All builder data is sent through the heartbeat.
* @since 3.16.0
* @since 3.24.2 Unknown.
*
* @param array $res Response data.
* @param array $data Data from the heartbeat api.
* Builder data will be in the "llms_builder" array.
* @return array
*/
public static function heartbeat_received( $res, $data ) {
// Exit if there's no builder data in the heartbeat data.
if ( empty( $data['llms_builder'] ) ) {
return $res;
}
// Isolate builder data & ensure slashes aren't removed.
$data = $data['llms_builder'];
// Escape slashes.
$data = json_decode( $data, true );
// Setup our return.
$ret = array(
'status' => 'success',
'message' => esc_html__( 'Success', 'lifterlms' ),
);
// Need a numeric ID for a course post type!
if ( empty( $data['id'] ) || ! is_numeric( $data['id'] ) || 'course' !== get_post_type( $data['id'] ) ) {
$ret['status'] = 'error';
$ret['message'] = esc_html__( 'Error: Invalid or missing course ID.', 'lifterlms' );
} elseif ( ! current_user_can( 'edit_course', $data['id'] ) ) {
$ret['status'] = 'error';
$ret['message'] = esc_html__( 'Error: You do not have permission to edit this course.', 'lifterlms' );
} else {
if ( ! empty( $data['detach'] ) && is_array( $data['detach'] ) ) {
$ret['detach'] = self::process_detachments( $data );
}
if ( current_user_can( 'delete_course', $data['id'] ) ) {
if ( ! empty( $data['trash'] ) && is_array( $data['trash'] ) ) {
$ret['trash'] = self::process_trash( $data );
}
}
if ( ! empty( $data['updates'] ) && is_array( $data['updates'] ) ) {
$ret['updates']['sections'] = self::process_updates( $data );
}
}
// Unescape slashes after saved.
// This ensures that updates are recognized as successful during Sync comparisons.
// phpcs:ignore -- commented out code
// $ret = json_decode( str_replace( '\\\\', '\\', json_encode( $ret ) ), true );
// Return our data.
$res['llms_builder'] = $ret;
return $res;
}
/**
* Determine if an ID submitted via heartbeat data is a temporary id.
*
* If so the object must be created rather than updated
*
* @since 3.16.0
* @since 3.17.0
*
* @param string $id An ID string.
* @return bool
*/
public static function is_temp_id( $id ) {
return ( ! is_numeric( $id ) && 0 === strpos( $id, 'temp_' ) );
}
/**
* Modify the "Take Over" link on the post locked modal to send users to the builder when taking over a course
*
* @since 3.13.0
*
* @param string $link Default post edit link.
* @param int $post_id WP Post ID of the course.
* @param string $context Display context.
* @return string
*/
public static function modify_take_over_link( $link, $post_id, $context ) {
return add_query_arg(
array(
'page' => 'llms-course-builder',
'course_id' => $post_id,
),
admin_url( 'admin.php' )
);
}
/**
* Output the page content
*
* @since 3.13.0
* @since 3.19.2 Unknown.
* @since 4.14.0 Added builder autosave preference defaults.
* @since 7.2.0 Added video explainer template.
* @since 7.6.0 Removed video explainer template.
*
* @return void
*/
public static function output() {
global $post;
$course_id = isset( $_GET['course_id'] ) ? absint( $_GET['course_id'] ) : null;
if ( ! $course_id || ( $course_id && 'course' !== get_post_type( $course_id ) ) ) {
esc_html_e( 'Invalid course ID', 'lifterlms' );
return;
}
$post = get_post( $course_id );
if ( ! current_user_can( 'edit_course', $course_id ) ) {
esc_html_e( 'You cannot edit this course!', 'lifterlms' );
return;
}
if ( 'auto-draft' === $post->post_status ) {
wp_update_post(
array(
'ID' => $course_id,
'post_status' => 'draft',
'post_title' => __( 'New Course', 'lifterlms' ),
)
);
$post = get_post( $course_id );
}
$course = llms_get_post( $post );
remove_all_actions( 'the_title' );
remove_all_actions( 'the_content' );
global $llms_builder_lazy_load;
$llms_builder_lazy_load = true;
?>
<div class="wrap lifterlms llms-builder">
<?php do_action( 'llms_before_builder', $course_id ); ?>
<div class="llms-builder-main" id="llms-builder-main"></div>
<aside class="llms-builder-sidebar" id="llms-builder-sidebar"></aside>
<?php
$templates = array(
'assignment',
'course',
'editor',
'elements',
'lesson',
'lesson-settings',
'quiz',
'question',
'question-choice',
'question-type',
'section',
'settings-fields',
'sidebar',
'utilities',
);
foreach ( $templates as $template ) {
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped
echo self::get_template(
$template,
array(
'course_id' => $course_id,
)
);
// phpcs:enable
}
?>
<script>window.llms_builder =
<?php
echo json_encode(
/**
* Filters the settings passed to the builder.
*
* @since 7.2.0
*
* @param array $settings Associative array of settings passed to the LifterLMS course builder.
*/
apply_filters(
'llms_builder_settings',
array(
'autosave' => self::get_autosave_status(),
'admin_url' => admin_url(),
'course' => $course->toArray(),
'debug' => array(
'enabled' => ( defined( 'LLMS_BUILDER_DEBUG' ) && LLMS_BUILDER_DEBUG ),
),
'questions' => array_values( llms_get_question_types() ),
'schemas' => self::get_custom_schemas(),
'sync' => apply_filters(
/**
* Filters the sync builder settings.
*
* @since 3.16.0
*
* @param array $settings Associative array of settings passed to the LifterLMS course builder used for the sync.
*/
'llms_builder_sync_settings',
array(
'check_interval_ms' => ( 'yes' === self::get_autosave_status() ? 10000 : 1000 ),
)
),
'enable_video_explainer' => true,
'home_url' => home_url(),
)
)
);
?>
</script>
<?php do_action( 'llms_after_builder', $course_id ); ?>
</div>
<?php
$llms_builder_lazy_load = false;
self::handle_post_locking( $course_id );
}
/**
* Process lesson detachments from the heartbeat data
*
* @since 3.16.0
* @since 3.27.0 Unknown.
*
* @param array $data Array of lesson ids.
* @return array
*/
private static function process_detachments( $data ) {
$ret = array();
foreach ( $data['detach'] as $id ) {
$res = array(
// Translators: %s = Item id.
'error' => sprintf( esc_html__( 'Unable to detach "%s". Invalid ID.', 'lifterlms' ), $id ),
'id' => $id,
);
$type = get_post_type( $id );
$post_types = apply_filters( 'llms_builder_detachable_post_types', array( 'lesson', 'llms_question', 'llms_quiz' ) );
if ( ! is_numeric( $id ) || ! in_array( $type, $post_types ) ) {
array_push( $ret, $res );
continue;
}
$post = llms_get_post( $id );
if ( ! is_a( $post, 'LLMS_Post_Model' ) ) {
array_push( $ret, $res );
continue;
}
if ( 'lesson' === $type ) {
$post->set( 'parent_course', '' );
$post->set( 'parent_section', '' );
} elseif ( 'llms_question' === $type ) {
$post->set( 'parent_id', '' );
} elseif ( 'llms_quiz' === $type ) {
$parent = $post->get_lesson();
if ( $parent ) {
$parent->set( 'quiz_enabled', 'no' );
$parent->set( 'quiz', '' );
$post->set( 'lesson_id', 0 );
}
}
do_action( 'llms_builder_detach_' . $type, $post );
unset( $res['error'] );
array_push( $ret, $res );
}
return $ret;
}
/**
* Delete/trash elements from heartbeat data
*
* @since 3.16.0
* @since 3.17.1 Unknown.
* @since 3.37.12 Refactored method to reduce method complexity.
*
* @param array $data Array of ids to trash/delete.
* @return array[] Array of arrays containing information about the deleted items.
*/
private static function process_trash( $data ) {
$ret = array();
foreach ( $data['trash'] as $id ) {
$ret[] = self::process_trash_item( $id );
}
return $ret;
}
/**
* Trash (or delete) a single item
*
* @since 3.37.12
*
* @param mixed $id Item id. Usually a WP_Post ID but can also be custom ID strings.
* @return array Associative array containing information about the trashed item.
* On success returns an array with an `id` key corresponding to the item's id.
* On failure returns the `id` as well as an `error` key which is a string describing the error.
*/
private static function process_trash_item( $id ) {
// Default response.
$res = array(
// Translators: %s = Item id.
'error' => sprintf( esc_html__( 'Unable to delete "%s". Invalid ID.', 'lifterlms' ), $id ),
'id' => $id,
);
/**
* Custom or 3rd party items can perform custom deletion actions using this filter.
*
* Return an associative array containing at least the `$id` to cease execution and have
* the custom item returned via the `process_trash()` method.
*
* A successful deletion return should be: `array( 'id' => $id )`.
*
* A failure should contain an error message in a second array member:
* `array( 'id' => $id, 'error' => esc_html__( 'My error message', 'my-domain' ) )`.
*
* @since Unknown.
*
* @param null|array $trash_response Denotes the trash response. See description above for details.
* @param array $res The initial default error response which can be modified for your needs and then returned.
* @param mixed $id The ID of the course element. Usually a WP_Post id.
*/
$custom = apply_filters( 'llms_builder_trash_custom_item', null, $res, $id );
if ( $custom ) {
return $custom;
}
// Determine the element's post type.
$type = is_numeric( $id ) ? get_post_type( $id ) : false;
if ( $type ) {
$status = self::process_trash_item_post_type( $id, $type );
} else {
$status = self::process_trash_item_non_post_type( $id );
}
// Error deleting.
if ( is_wp_error( $status ) ) {
$res['error'] = $status->get_error_message();
} elseif ( true === $status ) {
// Success.
unset( $res['error'] );
}
return $res;
}
/**
* Delete non-post type elements
*
* Currently handles deletion of question choices. In the future additional non-post type elements
* may be handled by this method.
*
* @since 3.37.12
*
* @param string $id Custom item ID. This should be a question choice id in the format of "{$question_id}:{$choice_id}".
* @return null|true|WP_Error `null` when the $id cannot be parsed into a question choice id.
* `true` on success.
* `WP_Error` when an error is encountered.
*/
private static function process_trash_item_non_post_type( $id ) {
// Can't process.
if ( false === strpos( $id, ':' ) ) {
return null;
}
$split = explode( ':', $id );
$question = llms_get_post( $split[0] );
// Not a question choice.
if ( ! $question || ! is_a( $question, 'LLMS_Question' ) ) {
return null;
}
// Error.
if ( ! $question->delete_choice( $split[1] ) ) {
// Translators: %s = Question choice ID.
return new WP_Error( 'llms_builder_trash_custom_item', sprintf( esc_html__( 'Error deleting the question choice "%s"', 'lifterlms' ), $id ) );
}
// Success.
return true;
}
/**
* Delete / Trash a post type
*
* @since 3.37.12
*
* @param int $id WP_Post ID.
* @param string $post_type Post type name.
* @return boolean|WP_Error `true` when successfully deleted or trashed.
* `WP_Error` for unsupported post types or when a deletion error is encountered.
*/
private static function process_trash_item_post_type( $id, $post_type ) {
// Used for errors.
$obj = get_post_type_object( $post_type );
/**
* Filter course elements that can be deleted or trashed via the course builder.
*
* Note that the use of "trash" in the filter name is not semantically correct as this filter does not guarantee
* that the element will be sent to the trash. Use the filter `llms_builder_trash_{$post_type}_force_delete` to
* determine if the element is sent to the trash or deleted immediately.
*
* @since Unknown
* @since 3.37.12 The "question_choice" item was removed from the default list and is being handled as a "custom item".
*
* @param string[] $post_types Array of post type names.
*/
$post_types = apply_filters( 'llms_builder_trashable_post_types', array( 'lesson', 'llms_quiz', 'llms_question', 'section' ) );
if ( ! in_array( $post_type, $post_types, true ) ) {
// Translators: %s = Post type name.
return new WP_Error( 'llms_builder_trash_unsupported_post_type', sprintf( esc_html__( '%s cannot be deleted via the Course Builder.', 'lifterlms' ), $obj->labels->name ) );
}
// Default force value: these post types are force deleted and others are moved to the trash.
$force = in_array( $post_type, array( 'section', 'llms_question', 'llms_quiz' ), true );
/**
* Determine whether or not a post type should be moved to the trash or deleted when trashed via the Course Builder.
*
* The dynamic portion of this hook, `$post_type`, refers to the post type name of the post that's being trashed.
*
* By default all post types are moved to trash except for `section`, `llms_question`, and `llms_quiz` post types.
*
* @since 3.37.12
*
* @param boolean $force If `true` the post is deleted, if `false` it will be moved to the trash.
* @param int $id WP_Post ID of the post being trashed.
*/
$force = apply_filters( "llms_builder_{$post_type}_force_delete", $force, $id );
// Delete or trash the post.
$res = $force ? wp_delete_post( $id, true ) : wp_trash_post( $id );
if ( ! $res ) {
// Translators: %1$s = Post type singular name; %2$d = Post id.
return new WP_Error( 'llms_builder_trash_post_type', sprintf( esc_html__( 'Error deleting the %1$s "%2$d".', 'lifterlms' ), $obj->labels->singular_name, $id ) );
}
return true;
}
/**
* Process all the update data from the heartbeat
*
* @since 3.16.0
*
* @param array $data Array of course updates (all the way down the tree).
* @return array
*/
private static function process_updates( $data ) {
$ret = array();
if ( ! empty( $data['updates']['sections'] ) && is_array( $data['updates']['sections'] ) ) {
foreach ( $data['updates']['sections'] as $section_data ) {
if ( ! isset( $section_data['id'] ) ) {
continue;
}
$ret[] = self::update_section( $section_data, $data['id'] );
}
}
return $ret;
}
/**
* Handle updating custom schema data
*
* @since 3.17.0
* @since 3.30.0 Fixed typo preventing fields specifying a custom callback from working.
* @since 3.30.0 Array fields will run field values through `sanitize_text_field()` instead of requiring a custom sanitization callback.
*
* @param string $type Model type (lesson, quiz, etc...).
* @param LLMS_Post_Model $post LLMS_Post_Model object for the model being updated.
* @param array $post_data Assoc array of raw data to update the model with.
* @return void
*/
public static function update_custom_schemas( $type, $post, $post_data ) {
$schemas = self::get_custom_schemas();
if ( empty( $schemas[ $type ] ) ) {
return;
}
$groups = $schemas[ $type ];
foreach ( $groups as $name => $group ) {
// Allow 3rd parties to manage their own custom save methods.
if ( apply_filters( 'llms_builder_update_custom_fields_group_' . $name, false, $post, $post_data, $groups ) ) {
continue;
}
foreach ( $group['fields'] as $fields ) {
foreach ( $fields as $field ) {
$keys = array( $field['attribute'] );
if ( isset( $field['switch_attribute'] ) ) {
$keys[] = $field['switch_attribute'];
}
foreach ( $keys as $attr ) {
if ( isset( $post_data[ $attr ] ) ) {
if ( isset( $field['sanitize_callback'] ) ) {
$val = call_user_func( $field['sanitize_callback'], $post_data[ $attr ] );
} elseif ( is_array( $post_data[ $attr ] ) ) {
$val = array_map( 'sanitize_text_field', $post_data[ $attr ] );
} else {
$val = sanitize_text_field( $post_data[ $attr ] );
}
$attr = isset( $field['attribute_prefix'] ) ? $field['attribute_prefix'] . $attr : $attr;
update_post_meta( $post_data['id'], $attr, $val );
}
}
}
}
}
}
/**
* Update lesson from heartbeat data.
*
* @since 3.16.0
* @since 5.1.3 Made sure a lesson moved in a just created section is correctly assigned to it.
* @since 7.3.0 Skip revision creation when creating a brand new lesson.
*
* @param array $lessons Lesson data from heartbeat.
* @param LLMS_Section $section instance of the parent LLMS_Section.
* @return array
*/
private static function update_lessons( $lessons, $section ) {
$ret = array();
foreach ( $lessons as $lesson_data ) {
if ( ! isset( $lesson_data['id'] ) ) {
continue;
}
$res = array_merge(
$lesson_data,
array(
'orig_id' => $lesson_data['id'],
)
);
// Create a new lesson.
if ( self::is_temp_id( $lesson_data['id'] ) ) {
$lesson = new LLMS_Lesson(
'new',
array(
'post_title' => isset( $lesson_data['title'] ) ? $lesson_data['title'] : __( 'New Lesson', 'lifterlms' ),
)
);
$created = true;
} else {
$lesson = llms_get_post( $lesson_data['id'] );
$created = false;
}
if ( empty( $lesson ) || ! is_a( $lesson, 'LLMS_Lesson' ) ) {
// Translators: %s = Lesson post id.
$res['error'] = sprintf( esc_html__( 'Unable to update lesson "%s". Invalid lesson ID.', 'lifterlms' ), $lesson_data['id'] );
} else {
// Don't create useless revision on "creating".
add_filter( 'wp_revisions_to_keep', '__return_zero', 999 );
/**
* If the parent section was just created the lesson will have a temp id
* replace it with the newly created section's real ID.
*/
if ( ! isset( $lesson_data['parent_section'] ) || self::is_temp_id( $lesson_data['parent_section'] ) ) {
$lesson_data['parent_section'] = $section->get( 'id' );
}
// Return the real ID (important when creating a new lesson).
$res['id'] = $lesson->get( 'id' );
$properties = array_merge(
array_keys( $lesson->get_properties() ),
array(
'content',
'title',
)
);
$skip_props = apply_filters( 'llms_builder_update_lesson_skip_props', array( 'quiz' ) );
// Don't overwrite content if the content editor doesn't display.
if ( ! $created && '' !== $lesson->get( 'content' ) && ! llms_parse_bool( $lesson->get( 'content_added_in_builder' ) ) ) {
$skip_props[] = 'content';
}
if ( '' === $lesson->get( 'content' ) && isset( $lesson_data['content'] ) && '' !== $lesson_data['content']
&& ! isset( $lesson_data['content_added_in_builder'] ) ) {
// We're adding content via the builder for the first time; add a flag saying so.
$lesson_data['content_added_in_builder'] = 'yes';
}
// Update all updatable properties.
foreach ( $properties as $prop ) {
if ( isset( $lesson_data[ $prop ] ) && ! in_array( $prop, $skip_props, true ) ) {
$lesson->set( $prop, $lesson_data[ $prop ] );
}
}
// Update all custom fields.
self::update_custom_schemas( 'lesson', $lesson, $lesson_data );
// During clone's we want to ensure custom field data comes with the lesson.
if ( $created && isset( $lesson_data['custom'] ) ) {
foreach ( $lesson_data['custom'] as $custom_key => $custom_vals ) {
foreach ( $custom_vals as $val ) {
add_post_meta( $lesson->get( 'id' ), $custom_key, maybe_unserialize( $val ) );
}
}
}
// Ensure slug gets updated when changing title from default "New Lesson".
if ( isset( $lesson_data['title'] ) && ! $lesson->has_modified_slug() ) {
$lesson->set( 'name', sanitize_title( $lesson_data['title'] ) );
}
// Include permalink, slug, and editor type in the response so the builder can update the model.
$res['permalink'] = get_permalink( $lesson->get( 'id' ) );
$res['name'] = $lesson->get( 'name' );
$res['content_added_in_builder'] = $lesson->get( 'content_added_in_builder' );
// Remove revision prevention.
remove_filter( 'wp_revisions_to_keep', '__return_zero', 999 );
if ( ! empty( $lesson_data['quiz'] ) && is_array( $lesson_data['quiz'] ) ) {
$res['quiz'] = self::update_quiz( $lesson_data['quiz'], $lesson );
}
}
// Allow 3rd parties to update custom data.
$res = apply_filters( 'llms_builder_update_lesson', $res, $lesson_data, $lesson, $created );
array_push( $ret, $res );
}
return $ret;
}
/**
* Update quiz questions from heartbeat data
*
* @since 3.16.0
* @since 3.16.11 Unknown.
* @since 3.38.2 Make sure that a question as a type set, otherwise set it by default to `'choice'`.
*
* @param array $questions Question data array.
* @param LLMS_Quiz|LLMS_Question $parent Instance of an LLMS_Quiz or LLMS_Question (group).
* @return array
*/
private static function update_questions( $questions, $parent ) {
$res = array();
foreach ( $questions as $q_data ) {
$ret = array_merge(
$q_data,
array(
'orig_id' => $q_data['id'],
)
);
// Remove temp id if we have one so we'll create a new question.
if ( self::is_temp_id( $q_data['id'] ) ) {
unset( $q_data['id'] );
}
// Remove choices because we'll add them individually after creation.
$choices = ( isset( $q_data['choices'] ) && is_array( $q_data['choices'] ) ) ? $q_data['choices'] : false;
unset( $q_data['choices'] );
// Remove child questions if it's a question group.
$questions = ( isset( $q_data['questions'] ) && is_array( $q_data['questions'] ) ) ? $q_data['questions'] : false;
unset( $q_data['questions'] );
$question_id = $parent->questions()->update_question( $q_data );
if ( ! $question_id ) {
// Translators: %s = Question post id.
$ret['error'] = sprintf( esc_html__( 'Unable to update question "%s". Invalid question ID.', 'lifterlms' ), $q_data['id'] );
} else {
$ret['id'] = $question_id;
$question = $parent->questions()->get_question( $question_id );
/**
* When saving a question, make sure that it has a question type set
* otherwise set it by default to `'choice'`.
*/
if ( ! $question->get( 'question_type', true ) ) {
$question->set( 'question_type', 'choice' );
}
if ( $choices ) {
$ret['choices'] = array();
foreach ( $choices as $c_data ) {
$choice_res = array_merge(
$c_data,
array(
'orig_id' => $c_data['id'],
)
);
unset( $c_data['question_id'] );
// Remove the temp ID so that we create it if it's new.
if ( self::is_temp_id( $c_data['id'] ) ) {
unset( $c_data['id'] );
}
$choice_id = $question->update_choice( $c_data );
if ( ! $choice_id ) {
// Translators: %s = Question choice ID.
$choice_res['error'] = sprintf( esc_html__( 'Unable to update choice "%s". Invalid choice ID.', 'lifterlms' ), $c_data['id'] );
} else {
$choice_res['id'] = $choice_id;
if ( isset( $c_data['choice']['id'] ) ) {
// The quiz IDs are needed for later verification of access by the protected media filters.
$quiz_ids = get_post_meta( $c_data['choice']['id'], '_llms_quiz_id', true );
if ( ! is_array( $quiz_ids ) ) {
$quiz_ids = array();
}
$quiz_id = $parent->get( 'parent_id' ) ? $parent->get( 'parent_id' ) : $parent->get( 'id' );
if ( ! in_array( $quiz_id, $quiz_ids ) ) {
$quiz_ids[] = $quiz_id;
}
update_post_meta( $c_data['choice']['id'], '_llms_quiz_id', $quiz_ids );
}
}
array_push( $ret['choices'], $choice_res );
}
} elseif ( $questions ) {
$ret['questions'] = self::update_questions( $questions, $question );
}
}
array_push( $res, $ret );
}
return $res;
}
/**
* Update quizzes during heartbeats
*
* @since 3.16.0
* @since 3.17.6 Unknown.
*
* @param array $quiz_data Array of quiz updates.
* @param LLMS_Lesson $lesson Instance of the parent LLMS_Lesson.
* @return array
*/
private static function update_quiz( $quiz_data, $lesson ) {
$res = array_merge(
$quiz_data,
array(
'orig_id' => $quiz_data['id'],
)
);
// Create a quiz.
if ( self::is_temp_id( $quiz_data['id'] ) ) {
$quiz = new LLMS_Quiz(
'new',
array(
'post_title' => isset( $quiz_data['title'] ) ? $quiz_data['title'] : __( 'New Quiz', 'lifterlms' ),
)
);
// Update existing quiz.
} else {
$quiz = llms_get_post( $quiz_data['id'] );
}
$lesson->set( 'quiz', $quiz->get( 'id' ) );
$lesson->set( 'quiz_enabled', 'yes' );
// We don't have a proper quiz to work with...
if ( empty( $quiz ) || ! is_a( $quiz, 'LLMS_Quiz' ) ) {
// Translators: %s = Quiz post id.
$res['error'] = sprintf( esc_html__( 'Unable to update quiz "%s". Invalid quiz ID.', 'lifterlms' ), $quiz_data['id'] );
} else {
// Return the real ID (important when creating a new quiz).
$res['id'] = $quiz->get( 'id' );
/**
* If the parent lesson was just created the lesson will have a temp id
* replace it with the newly created lessons's real ID.
*/
if ( ! isset( $quiz_data['lesson_id'] ) || self::is_temp_id( $quiz_data['lesson_id'] ) ) {
$quiz_data['lesson_id'] = $lesson->get( 'id' );
}
$properties = array_merge(
array_keys( $quiz->get_properties() ),
array(
// phpcs:ignore -- commented out code
// 'content',
'status',
'title',
)
);
// Update all updatable properties.
foreach ( $properties as $prop ) {
if ( isset( $quiz_data[ $prop ] ) ) {
$quiz->set( $prop, $quiz_data[ $prop ] );
}
}
// Include permalink and slug in the response so the builder can update the model.
$res['permalink'] = get_permalink( $quiz->get( 'id' ) );
$res['name'] = $quiz->get( 'name' );
if ( isset( $quiz_data['questions'] ) && is_array( $quiz_data['questions'] ) ) {
$res['questions'] = self::update_questions( $quiz_data['questions'], $quiz );
}
// Update all custom fields.
self::update_custom_schemas( 'quiz', $quiz, $quiz_data );
}
return $res;
}
/**
* Update a section with data from the heartbeat
*
* @since 3.16.0
* @since 3.16.11 Unknown.
*
* @param array $section_data Array of section data.
* @param LLMS_Course $course_id Instance of the parent LLMS_Course.
* @return array
*/
private static function update_section( $section_data, $course_id ) {
$res = array_merge(
$section_data,
array(
'orig_id' => $section_data['id'],
)
);
// Create a new section.
if ( self::is_temp_id( $section_data['id'] ) ) {
$section = new LLMS_Section( 'new' );
$section->set( 'parent_course', $course_id );
// Update existing section.
} else {
$section = llms_get_post( $section_data['id'] );
}
// We don't have a proper section to work with...
if ( empty( $section ) || ! is_a( $section, 'LLMS_Section' ) ) {
// Translators: %s = Section post id.
$res['error'] = sprintf( esc_html__( 'Unable to update section "%s". Invalid section ID.', 'lifterlms' ), $section_data['id'] );
} else {
// Return the real ID (important when creating a new section).
$res['id'] = $section->get( 'id' );
// Run through all possible updated fields.
foreach ( array( 'order', 'title' ) as $key ) {
// Update those that were sent through.
if ( isset( $section_data[ $key ] ) ) {
$section->set( $key, $section_data[ $key ] );
}
}
if ( isset( $section_data['lessons'] ) && is_array( $section_data['lessons'] ) ) {
$res['lessons'] = self::update_lessons( $section_data['lessons'], $section );
}
}
return $res;
}
}
================================================
FILE: includes/admin/class.llms.admin.dashboard-widget.php
================================================
<?php
/**
* Admin Dashboard Widget
*
* @package LifterLMS/Admin/Classes
*
* @since 7.2.0
* @version 7.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Dashboard Widget class.
*
* @since 7.2.0
*/
class LLMS_Admin_Dashboard_Widget {
/**
* Constructor.
*
* @since 7.2.0
*
* @return void
*/
public function __construct() {
add_action( 'wp_dashboard_setup', array( $this, 'add_dashboard_widget' ) );
}
/**
* Add the dashboard widget.
*
* @since 7.2.0
* @since 7.3.0 Add dashboard widget only if the current user can `manage_lifterlms`.
*
* @return void
*/
public function add_dashboard_widget() {
if ( ! current_user_can( 'manage_lifterlms' ) ) {
return;
}
wp_add_dashboard_widget(
'llms_dashboard_widget',
'LifterLMS ' . __( 'Quick Links', 'lifterlms' ),
array( $this, 'output' )
);
}
/**
* Output the dashboard widget.
*
* @since 7.2.0
*
* @return void
*/
public function output() {
?>
<div class="llms-dashboard-widget-wrap">
<h3><?php esc_html_e( 'Activity this week:', 'lifterlms' ); ?></h3>
<a class="llms-button-primary" href="<?php echo esc_url( admin_url( 'post-new.php?post_type=course' ) ); ?>">
<i class="fa fa-graduation-cap" aria-hidden="true"></i>
<?php esc_html_e( 'Create a New Course', 'lifterlms' ); ?>
</a>
</div>
<div class="activity-block">
<?php echo $this->get_widgets(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in template file. ?>
</div>
<div class="activity-block">
<h3><?php esc_html_e( 'LifterLMS News & Podcasts', 'lifterlms' ); ?></h3>
</div>
<ul class="llms-dashboard-widget-feed">
<?php foreach ( $this->get_feed() as $item ) : ?>
<li>
<a href="<?php echo esc_url( $item->get_permalink() ); ?>" target="_blank" rel="noopener">
<?php echo esc_html( $item->get_title() ); ?>
</a>
<span class="llms-dashboard-widget-feed-date">
<?php echo esc_html( date_i18n( get_option( 'date_format' ), $item->get_date( 'U' ) ) ); ?>
|
<?php echo strpos( $item->get_permalink(), '//podcast' ) !== false ? esc_html__( 'Podcast', 'lifterlms' ) : esc_html__( 'Blog', 'lifterlms' ); ?>
</span>
</li>
<?php endforeach; ?>
</ul>
<ul class="subsubsub">
<li>
<a href="https://lifterlms.com/blog/" target="_blank" rel="noopener" aria-label="<?php esc_attr_e( 'Opens in a new tab', 'lifterlms' ); ?>">
<?php esc_html_e( 'View all blog posts', 'lifterlms' ); ?>
<span aria-hidden="true" class="dashicons dashicons-external"></span>
</a>
|
</li>
<li>
<a href="https://podcast.lifterlms.com/" target="_blank" rel="noopener" aria-label="<?php esc_attr_e( 'Opens in a new tab', 'lifterlms' ); ?>">
<?php esc_html_e( 'View all podcasts', 'lifterlms' ); ?>
<span aria-hidden="true" class="dashicons dashicons-external"></span>
</a>
|
</li>
<li>
<a href="https://lifterlms.com/help/" target="_blank" rel="noopener" aria-label="<?php esc_attr_e( 'Opens in a new tab', 'lifterlms' ); ?>">
<?php esc_html_e( 'Get support', 'lifterlms' ); ?>
<span aria-hidden="true" class="dashicons dashicons-external"></span>
</a>
</li>
</ul>
<?php
}
/**
* Get the widget HTML.
*
* @since 7.2.0
*
* @return string
*/
private function get_widgets(): string {
return llms_get_template(
'admin/reporting/tabs/widgets.php',
array(
'json' => wp_json_encode(
array(
'current_tab' => 'settings',
'current_range' => 'last-7-days',
'current_students' => array(),
'current_courses' => array(),
'current_memberships' => array(),
'dates' => array(
'start' => date( 'Y-m-d', strtotime( '-1 week' ) ),
'end' => current_time( 'Y-m-d' ),
),
)
),
'widget_data' => array( self::get_dashboard_widget_data() ),
)
) ?? '';
}
/**
* Get blog and podcast feed.
*
* @since 7.2.0
*
* @return array
*/
private function get_feed(): array {
$blog = fetch_feed( 'https://lifterlms.com/feed' );
$podcast = fetch_feed( 'https://podcast.lifterlms.com/feed/' );
if ( ! is_wp_error( $blog ) ) {
$blog_max = $blog->get_item_quantity( 3 );
$blog_items = $blog->get_items( 0, $blog_max );
}
if ( ! is_wp_error( $podcast ) ) {
$podcast_max = $podcast->get_item_quantity( 3 );
$podcast_items = $podcast->get_items( 0, $podcast_max );
}
$merged = array_merge(
$blog_items ?? array(),
$podcast_items ?? array()
);
usort(
$merged,
function ( $a, $b ) {
return $b->get_date( 'U' ) - $a->get_date( 'U' );
}
);
return array_slice( $merged, 0, 5 );
}
/**
* Get dashboard widget data.
*
* @since 7.3.0
*
* @return array $widget_data Array of data that will feed the dashboard widget.
*/
public static function get_dashboard_widget_data() {
return apply_filters(
/**
* Filters the dashboard widget data.
*
* @since 7.3.0
*
* @param array $widget_data Array of data that will feed the dashboard widget.
*/
'llms_dashboard_widget_data',
array(
'enrollments' => array(
'title' => __( 'Enrollments', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Number of total enrollments during the selected period', 'lifterlms' ),
'link' => admin_url( 'admin.php?page=llms-reporting&tab=enrollments' ),
),
'registrations' => array(
'title' => __( 'Registrations', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Number of total user registrations during the selected period', 'lifterlms' ),
'link' => admin_url( 'admin.php?page=llms-reporting&tab=students' ),
),
'sold' => array(
'title' => __( 'Net Sales', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Total of all successful transactions during this period', 'lifterlms' ),
'link' => admin_url( 'admin.php?page=llms-reporting&tab=sales' ),
),
'lessoncompletions' => array(
'title' => __( 'Lessons Completed', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Number of total lessons completed during the selected period', 'lifterlms' ),
'link' => admin_url( 'admin.php?page=llms-reporting&tab=courses' ),
),
)
);
}
}
return new LLMS_Admin_Dashboard_Widget();
================================================
FILE: includes/admin/class.llms.admin.dashboard.php
================================================
<?php
/**
* Admin Dashboard Screen
*
* @package LifterLMS/Admin/Classes
*
* @since 7.1.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Dashboard Screen class.
*
* @since 7.1.0
*/
class LLMS_Admin_Dashboard {
/**
* Retrieve an instance of the WP_Screen for the dashboard screen.
*
* @since 7.1.0
*
* @return WP_Screen|boolean Returns a `WP_Screen` object when on the dashboard screen, otherwise returns `false`.
*/
public static function get_screen() {
$screen = get_current_screen();
if ( $screen instanceof WP_Screen && 'lifterlms_page_llms-dashboard' === $screen->id ) {
return $screen;
}
return false;
}
/**
* Register Dashboard's meta boxes.
*
* @since 7.1.0
*
* @return void
*/
public static function register_meta_boxes() {
add_meta_box(
'llms_dashboard_quick_links',
__( 'Quick Links', 'lifterlms' ),
array( __CLASS__, 'meta_box' ),
'toplevel_page_llms-dashboard',
'normal',
'default',
array( 'view' => 'quick-links' )
);
add_meta_box(
'llms_dashboard_addons',
__( 'Most Popular Add-ons, Courses, and Resources', 'lifterlms' ),
array( __CLASS__, 'meta_box' ),
'toplevel_page_llms-dashboard',
'normal',
'default',
array( 'view' => 'addons' )
);
add_meta_box(
'llms_dashboard_blog',
__( 'LifterLMS Blog', 'lifterlms' ),
array( __CLASS__, 'meta_box' ),
'toplevel_page_llms-dashboard',
'side',
'default',
array( 'view' => 'blog' )
);
add_meta_box(
'llms_dashboard_podcast',
__( 'LifterLMS Podcast', 'lifterlms' ),
array( __CLASS__, 'meta_box' ),
'toplevel_page_llms-dashboard',
'side',
'default',
array( 'view' => 'podcast' )
);
/**
* Fired after adding the meta boxes on the LifterLMS admin dashboard page.
*
* Third parties can hook here to remove LifterLMS core meta boxes.
*
* @since 7.1.0
*/
do_action( 'llms_dashboard_meta_boxes_added' );
}
/**
* Prints the dashboard's meta box html.
*
* @since 7.1.0
*
* @param mixed $data_object Often this is the object that's the focus of the current screen,
* for example a `WP_Post` or `WP_Comment` object.
* @param array $box Meta Box configuration array.
* @return void
*/
public static function meta_box( $data_object, $box ) {
if ( isset( $box['args']['view'] ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in template files.
echo self::get_view( $box['args']['view'] );
}
}
/**
* Handle HTML output on the screen.
*
* @since 7.1.0
*
* @return void
*/
public static function output() {
include 'views/dashboard.php';
}
/**
* Retrieves the HTML of a view from the views/dashboard directory.
*
* @since 7.1.0
*
* @param string $file The file basename of the view to retrieve.
* @return string The HTML content of the view.
*/
private static function get_view( $file ) {
ob_start();
include 'views/dashboard/' . $file . '.php';
return ob_get_clean();
}
}
================================================
FILE: includes/admin/class.llms.admin.import.php
================================================
<?php
/**
* Admin Import Screen and form submission handling
*
* @package LifterLMS/Admin/Classes
*
* @since 3.3.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Import Screen and form submission handling class
*
* @since 3.3.0
* @since 3.30.1 Explicitly include template functions during imports.
* @since 3.35.0 Initialize at `admin_init` instead of `init`.
* Import template from the admin views directory instead of the frontend templates directory.
* Improve error handling.
* @since 3.36.3 Fixed a typo where "$generator" was spelled "$generater".
* @since 3.37.3 Don't unslash uploaded file `tmp_name`.
* @since 6.0.0 Removed the deprecated `LLMS_Admin_Import::localize_stat()` method.
*/
class LLMS_Admin_Import {
/**
* Constructor
*
* @since 3.3.0
* @since 3.35.0 Initialize at `admin_init` instead of `init`.
* @since 4.8.0 Added hooks handling cloud imports and outputting WP help tabs.
*
* @return void
*/
public function __construct() {
add_action( 'admin_init', array( $this, 'cloud_import' ) );
add_action( 'admin_init', array( $this, 'upload_import' ) );
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue' ) );
add_action( 'current_screen', array( $this, 'add_help_tabs' ) );
}
/**
* Add WP_Screen help tabs
*
* @since 4.8.0
*
* @return WP_Screen|boolean Returns the WP_Screen on success or false if called outside of the intended screen context.
*/
public function add_help_tabs() {
$screen = $this->get_screen();
if ( ! $screen ) {
return false;
}
$screen->add_help_tab(
array(
'id' => 'llms_import_overview',
'title' => __( 'Overview', 'lifterlms' ),
'content' => $this->get_view( 'help-tab-overview' ),
)
);
$screen->set_help_sidebar( $this->get_view( 'help-sidebar' ) );
return $screen;
}
/**
* Handle form submission of a cloud import file
*
* @since 4.8.0
*
* @return WP_Error|boolean Returns `false` for nonce or user permission errors, `true` on success, or an error object.
*/
public function cloud_import() {
if ( ! isset( $_REQUEST['llms_cloud_importer_nonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['llms_cloud_importer_nonce'] ) ), 'llms-cloud-importer' ) || ! current_user_can( 'manage_lifterlms' ) ) {
return false;
}
$course_id = llms_filter_input( INPUT_POST, 'llms_cloud_import_course_id', FILTER_SANITIZE_NUMBER_INT );
if ( ! $course_id ) {
return $this->show_error( new WP_Error( 'llms-cloud-import-missing-id', __( 'Error: Missing course ID.', 'lifterlms' ) ) );
}
$res = LLMS_Export_API::get( array( $course_id ) );
if ( is_wp_error( $res ) ) {
return $this->show_error( $res );
}
return $this->handle_generation( $res );
}
/**
* Enqueue static assets used on the screen
*
* @since 4.8.0
*
* @return null|boolean Returns `null` when called outside of the intended screen context, `true` on success, or `false` on error.
*/
public function enqueue() {
if ( ! $this->get_screen() ) {
return null;
}
return llms()->assets->enqueue_style( 'llms-admin-importer' );
}
/**
* Convert an array of generated content IDs to a list of anchor tags to edit the generated content
*
* @since 4.7.0
*
* @param int[] $ids Array of object IDs. Either WP_Post IDs or WP_User IDs.
* @param string $type Object's type. Either "post" or "user".
* @return string A comma-separated list of HTML anchor tags.
*/
protected function get_generated_content_list( $ids, $type ) {
$list = array();
foreach ( $ids as $id ) {
if ( 'post' === $type ) {
$link = get_edit_post_link( $id );
$text = get_the_title( $id );
} elseif ( 'user' === $type ) {
$link = get_edit_user_link( $id );
$text = get_user_by( 'ID', $id )->display_name;
}
$list[] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( $link ), $text );
}
return implode( ', ', $list );
}
/**
* Retrieve an instance of the WP_Screen for the import screen
*
* @since 4.8.0
*
* @return WP_Screen|boolean Returns a `WP_Screen` object when on the import screen, otherwise returns `false`.
*/
protected function get_screen() {
$screen = get_current_screen();
if ( $screen instanceof WP_Screen && 'lifterlms_page_llms-import' === $screen->id ) {
return $screen;
}
return false;
}
/**
* Retrieves the HTML of a view from the views/import directory.
*
* @since 4.8.0
*
* @param string $file The file basename of the view to retrieve.
* @return string The HTML content of the view.
*/
protected function get_view( $file ) {
ob_start();
include 'views/import/' . $file . '.php';
return ob_get_clean();
}
/**
* Retrieves a "Success" message providing information about the imported content.
*
* @since 4.7.0
*
* @param LLMS_Generator $generator Generator instance.
* @return string
*/
protected function get_success_message( $generator ) {
$msg = '<strong>' . __( 'Import Successful!', 'lifterlms' ) . '</strong><br>';
$msg .= '<ul>';
$generated = $generator->get_generated_content();
if ( ! empty( $generated['course'] ) ) {
// Translators: %s = comma-separated list of anchors to the imported courses.
$msg .= '<li>' . sprintf( __( 'Imported courses: %s', 'lifterlms' ), $this->get_generated_content_list( $generated['course'], 'post' ) ) . '</li>';
}
if ( ! empty( $generated['user'] ) ) {
// Translators: %s = comma-separated list of anchors to the imported users.
$msg .= '<li>' . sprintf( __( 'Imported users: %s', 'lifterlms' ), $this->get_generated_content_list( $generated['user'], 'user' ) ) . '</li>';
}
$msg .= '</ul>';
return $msg;
}
/**
* Instantiate and generate raw data via LLMS_Generator
*
* @since 4.8.0
*
* @param string|array $raw A JSON string or array or raw data which can be parsed by an LLMS_Generator instance.
* @return WP_Error|boolean On success, returns true or an error object on failure.
*/
protected function handle_generation( $raw ) {
$generator = new LLMS_Generator( $raw );
if ( is_wp_error( $generator->set_generator() ) ) {
return $this->show_error( $generator->error );
}
$generator->generate();
if ( $generator->is_error() ) {
return $this->show_error( $generator->error );
}
LLMS_Admin_Notices::flash_notice( $this->get_success_message( $generator ), 'success' );
return true;
}
/**
* Handle HTML output on the screen
*
* @since 3.3.0
* @since 3.35.0 Import template from the admin views directory instead of the frontend templates directory.
* @since 4.7.0 Moved logic for generating success message into its own method.
*
* @return void
*/
public static function output() {
include 'views/import.php';
}
/**
* Output an admin notice from a WP_Error object
*
* @since 4.8.0
*
* @param WP_Error $error WP_Error object.
* @return WP_Error Returns the same error passed into the object.
*/
protected function show_error( $error ) {
LLMS_Admin_Notices::flash_notice( $error->get_error_message(), 'error' );
return $error;
}
/**
* Handle form submission
*
* @since 3.3.0
* @since 3.30.1 Explicitly include template functions.
* @since 3.35.0 Validate nonce and user permissions before processing import data.
* Moved statistic localization into its own function.
* Updated return signature.
* @since 3.36.3 Fixed a typo where "$generator" was spelled "$generater".
* @since 3.37.3 Don't unslash uploaded file `tmp_name`.
* @since 4.8.0 Use helper methods `show_error()` and `handle_generation()`.
*
* @return boolean|WP_Error false for nonce or permission errors, WP_Error when an error is encountered, true on success.
*/
public function upload_import() {
if ( ! isset( $_REQUEST['llms_importer_nonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['llms_importer_nonce'] ) ), 'llms-importer' ) || ! current_user_can( 'manage_lifterlms' ) || empty( $_FILES['llms_import'] ) ) {
return false;
}
// Fixes an issue where hooks are loaded in an unexpected order causing template functions required to parse an import aren't available.
llms()->include_template_functions();
// phpcs:disable WordPress.Security.ValidatedSanitizedInput.MissingUnslash
// phpcs:disable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
$validate = $this->validate_upload( $_FILES['llms_import'] );
// File upload error.
if ( is_wp_error( $validate ) ) {
return $this->show_error( $validate );
}
$raw = ! empty( $_FILES['llms_import']['tmp_name'] ) ? file_get_contents( sanitize_text_field( $_FILES['llms_import']['tmp_name'] ) ) : array(); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
// phpcs:enable WordPress.Security.ValidatedSanitizedInput.MissingUnslash
// phpcs:enable WordPress.Security.ValidatedSanitizedInput.InputNotSanitizedr
return $this->handle_generation( $raw );
}
/**
* Validate the uploaded file
*
* @since 3.3.0
* @since 3.35.0 Fix undefined variable error.
*
* @link https://www.php.net/manual/en/features.file-upload.errors.php
*
* @param array $file array of file data.
* @return WP_Error|true
*/
private function validate_upload( $file ) {
if ( ! empty( $file['error'] ) ) {
switch ( $file['error'] ) {
case UPLOAD_ERR_INI_SIZE:
$msg = __( 'The uploaded file exceeds the upload_max_filesize directive in php.ini.', 'lifterlms' );
break;
case UPLOAD_ERR_FORM_SIZE:
$msg = __( 'The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form.', 'lifterlms' );
break;
case UPLOAD_ERR_PARTIAL:
$msg = __( 'The uploaded file was only partially uploaded.', 'lifterlms' );
break;
case UPLOAD_ERR_NO_FILE:
$msg = __( 'No file was uploaded.', 'lifterlms' );
break;
case UPLOAD_ERR_NO_TMP_DIR:
$msg = __( 'Missing a temporary folder.', 'lifterlms' );
break;
case UPLOAD_ERR_CANT_WRITE:
$msg = __( 'Failed to write file to disk.', 'lifterlms' );
break;
case UPLOAD_ERR_EXTENSION:
$msg = __( 'File upload stopped by extension.', 'lifterlms' );
break;
default:
$msg = __( 'Unknown upload error.', 'lifterlms' );
}
} else {
$info = pathinfo( $file['name'] );
if ( 'json' !== strtolower( $info['extension'] ) ) {
$msg = __( 'Only valid JSON files can be imported.', 'lifterlms' );
}
}
if ( ! empty( $msg ) ) {
return new WP_Error( 'llms_import_file_error', $msg );
}
return true;
}
}
return new LLMS_Admin_Import();
================================================
FILE: includes/admin/class.llms.admin.menus.php
================================================
<?php
/**
* Admin Menu Items.
*
* @package LifterLMS/Admin/Classes
*
* @since 1.0.0
* @version 7.4.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Menus class
*
* @since 1.0.0
* @since 3.19.0 Added action scheduler posts table.
* @since 3.35.0 Sanitize input data.
* @since 3.37.19 Load tools on the status page.
* @since 3.35.0 Sanitize input data.
* @since 5.0.0 Add custom LifterLMS submenu item sorting.
*/
class LLMS_Admin_Menus {
/**
* Constructor
*
* @since 1.0.0
* @since 3.19.0 Add action scheduler posts table.
*
* @return void
*/
public function __construct() {
add_action( 'admin_init', array( $this, 'status_page_actions' ) );
add_action( 'admin_init', array( $this, 'builder_page_actions' ) );
add_action( 'load-admin_page_llms-course-builder', array( $this, 'builder_title' ) );
add_filter( 'custom_menu_order', array( $this, 'submenu_order' ) );
add_action( 'admin_menu', array( $this, 'display_admin_menu' ) );
add_action( 'admin_menu', array( $this, 'display_admin_menu_late' ), 7777 );
// Shame shame shame.
add_action( 'admin_menu', array( $this, 'instructor_menu_hack' ) );
add_filter( 'action_scheduler_post_type_args', array( $this, 'action_scheduler_menu' ) );
}
/**
* If WP_DEBUG is not enabled, expose the schedule-action post type management via direct link
*
* EG: site.com/wp-admin/edit.php?post_type=scheduled-action
*
* @since 3.19.0
*
* @param array $args Default custom post type arguments.
* @return array
*/
public function action_scheduler_menu( $args ) {
// If WP_DEBUG is enabled the menu item will already be displayed under "tools.php".
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
return $args;
}
// Otherwise we'll add a hidden menu accessible via direct link only.
return array_merge(
$args,
array(
'show_ui' => true,
'show_in_menu' => '',
'show_in_admin_bar' => false,
)
);
}
/**
* Remove the default menu page from the submenu.
*
* @since 1.0.0
* @since 3.2.0 Unknown.
* @since 5.0.0 Adds custom sorting for LifterLMS submenu items.
* @since 7.1.0 Added `llms-dashboard` to the order array in first position.
*
* @param bool $flag Flag from core filter (always false).
* @return bool
*/
public function submenu_order( $flag ) {
global $submenu;
if ( isset( $submenu['lifterlms'] ) ) {
// Our desired order.
$order = array( 'llms-dashboard', 'llms-settings', 'llms-reporting', 'edit.php?post_type=llms_form' );
// Temporary array to hold our submenu items.
$new_submenu = array();
// Any items not defined in the $order array will be added at the end of the new array.
$num_items = count( $submenu['lifterlms'] );
foreach ( $submenu['lifterlms'] as $item ) {
// Locate the desired order.
$key = array_search( $item[2], $order, true );
// Not found, increment the number of items to add it to the end of the array in its original order.
if ( false === $key ) {
$key = ++$num_items;
}
// Add the item to the new submenu.
$new_submenu[ $key ] = $item;
}
// Sort.
ksort( $new_submenu );
// Remove the keys so the new array doesn't skip any numbers.
$submenu['lifterlms'] = array_values( $new_submenu );
}
return $flag;
}
/**
* Handle init actions on the course builder page
*
* Used for post-locking redirects when taking over from another user
* on the course builder page.
*
* @since 3.13.0
* @since 3.16.7 Unknown.
* @since 9.2.3 Add capability check before setting post lock.
*
* @return void
*/
public function builder_page_actions() {
if ( ! isset( $_GET['page'] ) || 'llms-course-builder' !== $_GET['page'] ) {
return;
}
if ( ! empty( $_GET['get-post-lock'] ) && ! empty( $_GET['course_id'] ) ) {
$post_id = absint( $_GET['course_id'] );
check_admin_referer( 'lock-post_' . $post_id );
if ( ! current_user_can( 'edit_post', $post_id ) ) {
wp_die( esc_html__( 'You are not authorized to edit this course.', 'lifterlms' ) );
}
wp_set_post_lock( $post_id );
wp_safe_redirect(
add_query_arg(
array(
'page' => 'llms-course-builder',
'course_id' => $post_id,
),
admin_url( 'admin.php' )
)
);
exit();
}
add_action( 'admin_bar_menu', array( 'LLMS_Admin_Builder', 'admin_bar_menu' ), 100, 1 );
}
/**
* Set the global $title variable for the builder
*
* Prevents the <title> in the admin head being partially empty on builder screen.
*
* @since 3.14.9
*
* @return void
*/
public function builder_title() {
global $title;
$title = __( 'Course Builder', 'lifterlms' );
}
/**
* Admin Menu.
*
* @since 1.0.0
* @since 3.13.0 Unknown.
* @since 5.3.1 Use encoded SVG LifterLMS icon so that WordPress can "paint" it.
* submenu page in place of NULL.
* @since 7.1.0 Added the 'Dashboard' submenu page.
* @since 7.4.1 Added the 'Resources' submenu page.
*
* @return void
*/
public function display_admin_menu() {
global $menu;
$menu[51] = array( '', 'read', 'llms-separator', '', 'wp-menu-separator' );
$icon_url = 'data:image/svg+xml;base64,' . base64_encode( file_get_contents( LLMS_PLUGIN_DIR . 'assets/images/lifterlms-icon-grey.svg' ) ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents, WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
add_menu_page( 'lifterlms', 'LifterLMS', 'read', 'lifterlms', '__return_empty_string', $icon_url, 51 );
add_submenu_page( 'lifterlms', __( 'LifterLMS Dashboard', 'lifterlms' ), __( 'Dashboard', 'lifterlms' ), 'manage_lifterlms', 'llms-dashboard', array( $this, 'dashboard_page_init' ) );
add_submenu_page( 'lifterlms', __( 'LifterLMS Settings', 'lifterlms' ), __( 'Settings', 'lifterlms' ), 'manage_lifterlms', 'llms-settings', array( $this, 'settings_page_init' ) );
add_submenu_page( 'lifterlms', __( 'LifterLMS Reporting', 'lifterlms' ), __( 'Reporting', 'lifterlms' ), 'view_lifterlms_reports', 'llms-reporting', array( $this, 'reporting_page_init' ) );
add_submenu_page( 'lifterlms', __( 'LifterLMS Import', 'lifterlms' ), __( 'Import', 'lifterlms' ), 'manage_lifterlms', 'llms-import', array( $this, 'import_page_init' ) );
add_submenu_page( 'lifterlms', __( 'LifterLMS Status', 'lifterlms' ), __( 'Status', 'lifterlms' ), 'manage_lifterlms', 'llms-status', array( $this, 'status_page_init' ) );
add_submenu_page( 'lifterlms', __( 'LifterLMS Resources', 'lifterlms' ), __( 'Resources', 'lifterlms' ), 'manage_lifterlms', 'llms-resources', array( $this, 'resources_page_init' ) );
// Passing '' to register the page without actually adding a menu item.
add_submenu_page( '', __( 'LifterLMS Course Builder', 'lifterlms' ), __( 'Course Builder', 'lifterlms' ), 'edit_courses', 'llms-course-builder', array( $this, 'builder_init' ) );
}
/**
* Add items to the admin menu with a later priority
*
* @since 3.5.0
* @since 3.22.0 Unknown.
*
* @return void
*/
public function display_admin_menu_late() {
/**
* Disable the display and output of LifterLMS Add-ons screen.
*
* @since Unknown
*
* @param boolean $display Whether or not to display the screen. Defaults to `false` which shows the screen.
*/
if ( apply_filters( 'lifterlms_disable_addons_screen', false ) ) {
return;
}
add_submenu_page( 'lifterlms', __( 'LifterLMS Add-ons, Courses, and Resources', 'lifterlms' ), __( 'Add-ons & more', 'lifterlms' ), 'manage_lifterlms', 'llms-add-ons', array( $this, 'add_ons_page_init' ) );
}
/**
* Output the add-ons screen.
*
* @since 3.5.0
* @since 3.22.0 Unknown.
* @since 6.0.0 Removed loading the LLMS_Admin_AddOns class file that is now handled by the autoloader.
*
* @return void
*/
public function add_ons_page_init() {
$view = new LLMS_Admin_AddOns();
$view->handle_actions();
$view->output();
}
/**
* Output the HTML for the Course Builder
*
* @since 3.13.0
* @since 3.16.0 Unknown.
* @since 6.0.0 Removed loading the LLMS_Admin_Builder class file that is now handled by the autoloader.
*
* @return void
*/
public function builder_init() {
LLMS_Admin_Builder::output();
}
/**
* Outputs the LifterLMS Importer Screen HTML
*
* @since 3.3.0
*
* @return void
*/
public function import_page_init() {
LLMS_Admin_Import::output();
}
/**
* Removes edit.php from the admin menu for instructors/asst instructors
*
* Note: The post screen is still technically accessible.
*
* Posts will need to be submitted for review as the instructors only actually have
* the capability of a contributor with regards to posts
* but this hack will allow instructors to publish new lessons, quizzes, & questions.
*
* @since 3.13.0
* @since 7.0.1 Added filterable early return allowing 3rd parties to modify
* the user roles affected by this hack.
*
* @link https://core.trac.wordpress.org/ticket/22895
* @link https://core.trac.wordpress.org/ticket/16808
*
* @return void
*/
public function instructor_menu_hack() {
/**
* Filters the WP_User roles should receive the instructor admin menu hack.
*
* If you wish to provide explicit access to the `post` post type, to the
* instrutor or instructor's assistant role, the role will need to be
* removed from this array so they can access to the post type edit.php
* screen.
*
* @see LLMS_Admin_Menus::instructor_menu_hack
*
* @since 7.0.1
*
* @param string[] $roles The list of WP_User roles which need the hack.
*/
$roles = apply_filters( 'llms_instructor_menu_hack_roles', array( 'instructor', 'instructors_assistant' ) );
$user = wp_get_current_user();
if ( array_intersect( $roles, $user->roles ) ) {
remove_menu_page( 'edit.php' );
}
}
/**
* Output the HTML for admin dashboard screen.
*
* @since 7.1.0
*
* @return void
*/
public function dashboard_page_init() {
LLMS_Admin_Dashboard::register_meta_boxes();
LLMS_Admin_Dashboard::output();
}
/**
* Output the HTML for admin settings screens
*
* @since Unknown
* @since 6.0.0 Removed loading the LLMS_Admin_Settings class file that is now handled by the autoloader.
*
* @return void
*/
public function settings_page_init() {
LLMS_Admin_Settings::output();
}
/**
* Output the HTML for the reporting screens
*
* @since 3.2.0
* @since 3.13.0 Unknown.
* @since 3.35.0 Sanitize input data.
* @since 4.7.0 Removed inclusion of `LLMS_Admin_Reporting` which is now loaded automatically.
*
* @return void
*/
public function reporting_page_init() {
if ( isset( $_GET['student_id'] ) && ! llms_current_user_can( 'view_lifterlms_reports', llms_filter_input( INPUT_GET, 'student_id', FILTER_SANITIZE_NUMBER_INT ) ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
wp_die( esc_html__( 'You do not have permission to access this content.', 'lifterlms' ) );
}
$reporting = new LLMS_Admin_Reporting();
$reporting->output();
}
/**
* Include files used on the Status page.
*
* @since 3.37.19
* @since 4.12.0 Added `llms_load_admin_tools` action.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
protected function status_page_includes() {
// Tools.
foreach ( glob( LLMS_PLUGIN_DIR . 'includes/admin/tools/class-llms-admin-tool-*.php' ) as $tool_path ) {
require_once $tool_path;
}
/**
* Action which can be used by 3rd parties to load custom admin page tools.
*
* @since 4.12.0
*/
do_action( 'llms_load_admin_tools' );
}
/**
* Handle form submission actions on the status pages
*
* @since 3.11.2
* @since 3.37.19 Load tools-related files.
*
* @return void
*/
public function status_page_actions() {
$this->status_page_includes();
LLMS_Admin_Page_Status::handle_actions();
}
/**
* Output the HTML for the Status Pages
*
* @since Unknown
* @since 3.11.2 Unknown.
* @since 3.37.19 Load tools-related files.
*
* @return void
*/
public function status_page_init() {
$this->status_page_includes();
LLMS_Admin_Page_Status::output();
}
/**
* Output the HTML for admin resources screen.
*
* @since 7.4.1
*
* @return void
*/
public function resources_page_init() {
LLMS_Admin_Resources::register_meta_boxes();
LLMS_Admin_Resources::output();
}
}
return new LLMS_Admin_Menus();
================================================
FILE: includes/admin/class.llms.admin.notices.core.php
================================================
<?php
/**
* Manage core admin notices
*
* @package LifterLMS/Admin/Classes
*
* @since 3.0.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Manage core admin notices class.
*
* @since 3.0.0
* @since 6.0.0 Removed the deprecated `LLMS_Admin_Notices_Core::check_staging()` method.
*/
class LLMS_Admin_Notices_Core {
/**
* Init.
*
* @since 3.0.0
* @since 3.14.8 Add handler for removing dismissed notices.
* @since 7.1.0 Do not add a callback to remove sidebar notice on `switch_theme` anymore.
*
* @return void
*/
public static function init() {
add_action( 'admin_head', array( __CLASS__, 'maybe_hide_notices' ), 1 );
add_action( 'current_screen', array( __CLASS__, 'maybe_hide_notices' ), 999 );
add_action( 'current_screen', array( __CLASS__, 'add_init_actions' ) );
}
/**
* Add actions on different hooks depending on the current screen.
*
* Adds later for LLMS Settings screens to accommodate for settings that are updated later in the load cycle.
*
* @since 3.0.0
* @since 4.12.0 Remove hook for deprecated `check_staging()` notice.
* @since 7.1.0 Do not add a callback to show the missing sidebar support anymore.
* @since 7.7.0 Add notice for media protection on certain hosting servers.
*
* @return void
*/
public static function add_init_actions() {
$screen = get_current_screen();
if ( ! empty( $screen->base ) && 'lifterlms_page_llms-settings' === $screen->base ) {
$action = 'lifterlms_settings_notices';
$priority = 5;
} else {
$action = 'current_screen';
$priority = 77;
}
add_action( $action, array( __CLASS__, 'gateways' ), $priority );
add_action( $action, array( __CLASS__, 'media_protection' ), $priority );
add_action( $action, array( __CLASS__, 'beaver_builder' ), $priority );
}
public static function beaver_builder() {
$id = 'beaver-builder-lab';
if ( class_exists( 'LifterLMS_Labs' ) && llms_parse_bool( get_option( 'llms_lab_beaver-builder_enabled' ) ) && current_user_can( 'manage_lifterlms' ) ) {
$html = sprintf(
__( 'Improved Beaver Builder support is now included in core! To use it, %1$sdisable the Beaver Builder lab%2$s.', 'lifterlms' ),
'<a href="' . admin_url( 'admin.php?page=llms-labs' ) . '">',
'</a>',
);
LLMS_Admin_Notices::add_notice(
$id,
$html,
array(
'type' => 'warning',
'dismiss_for_days' => 730, // @TODO: there should be a "forever" setting here.
'remindable' => false,
)
);
} elseif ( LLMS_Admin_Notices::has_notice( $id ) ) {
LLMS_Admin_Notices::delete_notice( $id );
}
}
/**
* Check for gateways and output gateway notice
*
* @since 3.0.0
* @since 3.13.0 Unknown.
* @since 4.5.0 Dismiss notice for 2 years instead of 7 days.
*
* @return void
*/
public static function gateways() {
$id = 'no-gateways';
if ( ! apply_filters( 'llms_admin_notice_no_payment_gateways', llms()->payment_gateways()->has_gateways( true ) ) ) {
$html = __( 'No LifterLMS Payment Gateways are currently enabled. Students will only be able to enroll in courses or memberships with free access plans.', 'lifterlms' ) . '<br><br>';
$html .= sprintf(
__( 'For starters you can configure manual payments on the %1$sCheckout Settings tab%2$s. Be sure to check out all the available %3$sLifterLMS Payment Gateways%4$s and install one later so that you can start selling your courses and memberships.', 'lifterlms' ),
'<a href="' . add_query_arg(
array(
'page' => 'llms-settings',
'tab' => 'checkout',
),
admin_url( 'admin.php' )
) . '">',
'</a>',
'<a href="https://lifterlms.com/product-category/plugins/payment-gateways/" target="_blank">',
'</a>'
);
LLMS_Admin_Notices::add_notice(
$id,
$html,
array(
'type' => 'warning',
'dismiss_for_days' => 730, // @TODO: there should be a "forever" setting here.
'remindable' => true,
)
);
} elseif ( LLMS_Admin_Notices::has_notice( $id ) ) {
LLMS_Admin_Notices::delete_notice( $id );
}
}
/**
* Check for Nginx and output a notice about media protection.
*
* @since 7.7.0
*
* @return void
*/
public static function media_protection() {
$id = 'using-nginx';
if (
apply_filters(
'llms_admin_notice_using_nginx',
( ! empty( $GLOBALS['is_nginx'] && $GLOBALS['is_nginx'] ) )
||
( function_exists( 'is_wpe' ) && is_wpe() )
) ) {
$html = sprintf(
/* translators: 1. opening link tag; 2. closing link tag */
__( 'For the best protection for your media files, you should use this doc to add this %1$sNGINX redirect rule%2$s.', 'lifterlms' ),
'<a href="https://lifterlms.com/docs/protected-media-files-on-nginx/" target="_blank">',
'</a>'
);
$html .= '<br><br>' . __( 'If you have already reviewed these instructions you may dismiss this notice.', 'lifterlms' );
LLMS_Admin_Notices::add_notice(
$id,
$html,
array(
'type' => 'warning',
'dismiss_for_days' => 10000,
'remindable' => true,
)
);
} elseif ( LLMS_Admin_Notices::has_notice( $id ) ) {
LLMS_Admin_Notices::delete_notice( $id );
}
}
/**
* Don't display notices on specific pages
*
* @since 3.14.8
* @since 3.16.14 Unknown.
*
* @return void
*/
public static function maybe_hide_notices() {
$screen = get_current_screen();
if ( $screen && 'admin_page_llms-course-builder' === $screen->id ) {
remove_all_actions( 'admin_notices' ); // 3rd party notices.
remove_action( 'admin_print_styles', array( 'LLMS_Admin_Notices', 'output_notices' ) ); // Notices output by LifterLMS.
}
}
/**
* Check theme support for LifterLMS Sidebars.
*
* @since 3.0.0
* @since 3.7.4 Unknown.
* @since 4.5.0 Use strict comparison for `in_array()`.
* @deprecated 7.1.0
*
* @return void
*/
public static function sidebar_support() {
_deprecated_function( __METHOD__, '7.1.0' );
$theme = wp_get_theme();
$id = 'sidebars';
if ( ! current_theme_supports( 'lifterlms-sidebars' ) && ! in_array( $theme->get_template(), llms_get_core_supported_themes(), true ) ) {
$msg = sprintf(
__( '<strong>The current theme, %1$s, does not declare support for LifterLMS Sidebars.</strong> Course and Lesson sidebars may not work as expected. Please see our %2$sintegration guide%3$s or check out our %4$sLaunchPad%5$s theme which is designed specifically for use with LifterLMS.', 'lifterlms' ),
$theme->get( 'Name' ),
'<a href="https://lifterlms.com/docs/lifterlms-sidebar-support/?utm_source=notice&utm_medium=product&utm_content=sidebarsupport&utm_campaign=lifterlmsplugin" target="_blank">',
'</a>',
'<a href="https://lifterlms.com/product/launchpad/?utm_source=notice&utm_medium=product&utm_content=launchpad&utm_campaign=lifterlmsplugin" target="_blank">',
'</a>'
);
LLMS_Admin_Notices::add_notice(
$id,
$msg,
array(
'dismissible' => true,
'dismiss_for_days' => 730, // @TODO: there should be a "forever" setting here.
'remindable' => false,
'type' => 'warning',
)
);
} elseif ( LLMS_Admin_Notices::has_notice( $id ) ) {
LLMS_Admin_Notices::delete_notice( $id );
}
}
/**
* Removes the current sidebar notice (if present) and clears notice delay transients.
*
* Called when theme is switched.
*
* @since 3.14.7
* @deprecated 7.1.0
*
* @return void
*/
public static function clear_sidebar_notice() {
_deprecated_function( __METHOD__, '7.1.0' );
if ( LLMS_Admin_Notices::has_notice( 'sidebars' ) ) {
LLMS_Admin_Notices::delete_notice( 'sidebars' );
} else {
delete_transient( 'llms_admin_notice_sidebars_delay' );
}
}
}
LLMS_Admin_Notices_Core::init();
================================================
FILE: includes/admin/class.llms.admin.notices.php
================================================
<?php
/**
* LLMS_Admin_Notices class file.
*
* @package LifterLMS/Admin/Classes
*
* @since 3.0.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Admin Notices.
*
* @since 3.0.0
*/
class LLMS_Admin_Notices {
/**
* Array of messages to display.
*
* @var array
*/
private static $notices = array();
/**
* Array of messages already displayed in the current request.
*
* @var array
*/
private static $printed_notices = array();
/**
* Static constructor
*
* @since 3.0.0
* @since 4.13.0 Populate the `self::$notices` using `self::load_notices()`.
*
* @return void
*/
public static function init() {
self::$notices = self::load_notices();
add_action( 'wp_loaded', array( __CLASS__, 'hide_notices' ) );
add_action( 'current_screen', array( __CLASS__, 'add_output_actions' ) );
add_action( 'shutdown', array( __CLASS__, 'save_notices' ) );
}
/**
* Add output notice actions depending on the current screen.
*
* Notices are added later for LifterLMS settings screens to accommodate
* settings that are updated later in the load cycle.
*
* @since 3.0.0
* @since 5.9.0 Output notices at `admin_notices` in favor of `admin_print_styles`.
*
* @return void
*/
public static function add_output_actions() {
$screen = get_current_screen();
if ( ! empty( $screen->base ) && 'lifterlms_page_llms-settings' === $screen->base ) {
add_action( 'lifterlms_settings_notices', array( __CLASS__, 'output_notices' ) );
} else {
add_action( 'admin_notices', array( __CLASS__, 'output_notices' ) );
}
}
/**
* Add a notice
*
* Saves options to the database to be output later
*
* @since 3.0.0
* @since 3.3.0 Added "flash" option.
*
* @param string $notice_id Unique id of the notice.
* @param string $html_or_options Html content of the notice for short notices that don't need a template
* or an array of options, html of the notice will be in a template
* passed as the "template" param of this array.
* @param array $options Array of options, when passing html directly via $html_or_options.
* Notice options should be passed in this array.
* @return void
*/
public static function add_notice( $notice_id, $html_or_options = '', $options = array() ) {
// Don't add the notice if we've already dismissed or delayed it.
if ( get_transient( 'llms_admin_notice_' . $notice_id . '_delay' ) ||
( is_numeric( get_option( 'llms_admin_notice_' . $notice_id . '_delay' ) ) &&
time() < get_option( 'llms_admin_notice_' . $notice_id . '_delay' )
) ) {
return;
}
if ( is_array( $html_or_options ) ) {
$options = $html_or_options;
} else {
$options['html'] = $html_or_options;
}
$options = wp_parse_args(
$options,
array(
'dismissible' => true,
'dismiss_for_days' => 7,
'flash' => false, // If true, will delete the notice after displaying it.
'html' => '',
'remind_in_days' => 7,
'remindable' => false,
'type' => 'info', // Info, warning, success, error.
'template' => false, // Template name, eg "admin/notices/notice.php".
'template_path' => '', // Allow override of default llms()->template_path().
'default_path' => '', // Allow override of default path llms()->plugin_path() . '/templates/'. An addon may add a notice and pass it's own path in here.
)
);
self::$notices = array_unique( array_merge( self::get_notices(), array( $notice_id ) ) );
update_option( 'llms_admin_notice_' . $notice_id, $options );
}
/**
* Delete a notice by id
*
* @since 3.0.0
* @since 3.4.3 Unknown.
*
* @param string $notice_id Unique id of the notice.
* @param string $trigger Deletion action/trigger, accepts 'delete' (default), 'hide', or 'remind'.
* @return void
*/
public static function delete_notice( $notice_id, $trigger = 'delete' ) {
self::$notices = array_diff( self::get_notices(), array( $notice_id ) );
$notice = self::get_notice( $notice_id );
delete_option( 'llms_admin_notice_' . $notice_id );
if ( $notice ) {
$delay = 0;
if ( 'remind' === $trigger && $notice['remindable'] ) {
$delay = isset( $notice['remind_in_days'] ) ? $notice['remind_in_days'] : 0;
}
if ( 'hide' === $trigger && $notice['dismissible'] ) {
$delay = isset( $notice['dismiss_for_days'] ) ? $notice['dismiss_for_days'] : 7;
}
if ( $delay ) {
update_option( 'llms_admin_notice_' . $notice_id . '_delay', time() + ( DAY_IN_SECONDS * $delay ) );
}
/**
* Hook run when a notice is dismissed.
*
* The dynamic portion of this hook `{$trigger}` refers to the deletion trigger, either 'delete',
* 'hide', or 'remind'.
*
* The dynamic portion of this hook, `{$notice_id}` refers to the ID of the notice being dismissed.
*
* @since 4.10.0
*/
do_action( "lifterlms_{$trigger}_{$notice_id}_notice" );
}
}
/**
* Flash a notice on screen, isn't saved and is automatically deleted after being displayed
*
* @since 3.3.0
*
* @param string $message Message text / html to display onscreen.
* @param string $type Notice type [info|warning|success|error].
* @return void
*/
public static function flash_notice( $message, $type = 'info' ) {
$id = 'llms-flash-notice-';
$i = 0;
// Increment the notice id so we can flash multiple notices on screen in one load if necessary.
while ( self::has_notice( $id . $i ) ) {
++$i;
}
$id = $id . $i;
self::add_notice(
$id,
$message,
array(
'dismissible' => false,
'flash' => true,
'type' => $type,
)
);
}
/**
* Get notice details array from the DB
*
* @since 3.0.0
* @since 4.13.0 When the notice cannot be found, return an empty array in favor of an empty string.
*
* @param string $notice_id Notice id.
* @return array
*/
public static function get_notice( $notice_id ) {
return get_option( 'llms_admin_notice_' . $notice_id, array() );
}
/**
* Get notices
*
* @since 3.0.0
*
* @return array
*/
public static function get_notices() {
return self::$notices;
}
/**
* Determine if a notice is already set
*
* @since 3.0.0
* @since 4.10.0 Use a strict comparison.
*
* @param string $notice_id Id of the notice.
* @return boolean
*/
public static function has_notice( $notice_id ) {
return in_array( $notice_id, self::get_notices(), true );
}
/**
* Called when "Dismiss X" or "Remind Me" is clicked on a notice
*
* Validates request and deletes the notice.
*
* @since 3.0.0
* @since 3.35.0 Unslash input data.
* @since 5.2.0 Remove notice and notice query string vars and redirect after clearing.
*
* @return void
*/
public static function hide_notices() {
if ( ( isset( $_GET['llms-hide-notice'] ) || isset( $_GET['llms-remind-notice'] ) ) && isset( $_GET['_llms_notice_nonce'] ) ) {
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_GET['_llms_notice_nonce'] ) ), 'llms_hide_notices_nonce' ) ) {
wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'lifterlms' ) );
}
if ( ! current_user_can( 'manage_options' ) ) {
wp_die( esc_html__( 'Cheatin’ huh?', 'lifterlms' ) );
}
if ( isset( $_GET['llms-hide-notice'] ) ) {
$notice = sanitize_text_field( wp_unslash( $_GET['llms-hide-notice'] ) );
$action = 'hide';
} elseif ( isset( $_GET['llms-remind-notice'] ) ) {
$notice = sanitize_text_field( wp_unslash( $_GET['llms-remind-notice'] ) );
$action = 'remind';
}
self::delete_notice( $notice, $action );
llms_redirect_and_exit( remove_query_arg( array( 'llms-hide-notice', 'llms-remind-notice', '_llms_notice_nonce' ) ) );
}
}
/**
* Loads stored notice IDs from the database
*
* Handles potentially malformed data by ensuring that only an array of strings
* can be loaded.
*
* @since 4.13.0
*
* @return string[]
*/
protected static function load_notices() {
$notices = get_option( 'llms_admin_notices', array() );
if ( ! is_array( $notices ) ) {
$notices = array( $notices );
}
// Remove empty and non-string values.
return array_filter(
$notices,
function ( $notice ) {
return ( ! empty( $notice ) && is_string( $notice ) );
}
);
}
/**
* Output a single notice by ID
*
* @since 3.0.0
* @since 3.7.4 Unknown.
* @since 5.2.0 Ensure `template_path` and `default_path` are properly passed to `llms_get_template()`.
* @since 5.3.1 Delete empty notices and do not display them.
*
* @param string $notice_id Notice id.
* @return void
*/
public static function output_notice( $notice_id ) {
if ( current_user_can( 'manage_options' ) ) {
$notice = self::get_notice( $notice_id );
// Don't output those rogue empty notices I can't find.
// @todo find the source.
if ( empty( $notice ) || ( empty( $notice['template'] ) && empty( $notice['html'] ) ) ) {
self::delete_notice( $notice_id );
return;
}
?>
<div class="notice notice-<?php echo esc_attr( $notice['type'] ); ?> llms-admin-notice" id="llms-notice<?php echo esc_attr( $notice_id ); ?>" style="position:relative;">
<div class="llms-admin-notice-icon"></div>
<div class="llms-admin-notice-content">
<?php if ( $notice['dismissible'] ) : ?>
<a class="notice-dismiss" href="<?php echo esc_url( wp_nonce_url( add_query_arg( 'llms-hide-notice', $notice_id ), 'llms_hide_notices_nonce', '_llms_notice_nonce' ) ); ?>">
<span class="screen-reader-text"><?php esc_html_e( 'Dismiss', 'lifterlms' ); ?></span>
</a>
<?php endif; ?>
<?php if ( ! empty( $notice['template'] ) ) : ?>
<?php llms_get_template( $notice['template'], array(), $notice['template_path'], $notice['default_path'] ); ?>
<?php elseif ( ! empty( $notice['html'] ) ) : ?>
<?php echo wpautop( wp_kses_post( $notice['html'] ) ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Already using wp_kses_post() ?>
<?php endif; ?>
<?php if ( $notice['remindable'] ) : ?>
<p style="text-align:right;"><a class="button" href="<?php echo esc_url( wp_nonce_url( add_query_arg( 'llms-remind-notice', $notice_id ), 'llms_hide_notices_nonce', '_llms_notice_nonce' ) ); ?>"><?php esc_html_e( 'Remind me later', 'lifterlms' ); ?></a></p>
<?php endif; ?>
</div>
</div>
<?php
if ( isset( $notice['flash'] ) && $notice['flash'] ) {
self::delete_notice( $notice_id, 'delete' );
}
}
}
public static function output_global_notices() {
if ( ! current_user_can( 'manage_options' ) ) {
return;
}
global $lifterlms_banner_notifications;
// Default to showing notification banners.
$show_notifications = true;
// Hide notifications if the user has disabled them.
if ( $lifterlms_banner_notifications->get_max_notification_priority() < 1 ) {
$show_notifications = false;
}
if ( $show_notifications ) :
?>
<div id="lifterlms-notifications" style="position:relative;">
</div>
<?php
// To debug a specific notification.
if ( ! empty( $_REQUEST['lifterlms_notification'] ) ) {
$specific_notification = '&lifterlms_notification=' . intval( $_REQUEST['lifterlms_notification'] );
} else {
$specific_notification = '';
}
?>
<script>
jQuery(document).ready( function() {
jQuery.get('<?php echo esc_url_raw( admin_url( 'admin-ajax.php?action=lifterlms_notifications' . $specific_notification ) ); ?>', function(data) {
if ( data && data != 'NULL' )
jQuery( '#lifterlms-notifications' ).html( data );
});
});
</script>
<?php
endif;
}
/**
* Output all saved notices.
*
* @since 3.0.0
* @since 7.1.0 Made sure to print the notices only once.
*
* @return void
*/
public static function output_notices() {
$notices_to_print = array_diff( self::get_notices(), self::$printed_notices );
foreach ( $notices_to_print as $notice_id ) {
self::output_notice( $notice_id );
self::$printed_notices[] = $notice_id;
}
self::output_global_notices();
}
/**
* Save notices in the database
*
* @since 3.0.0
*
* @return void
*/
public static function save_notices() {
update_option( 'llms_admin_notices', self::get_notices() );
}
}
LLMS_Admin_Notices::init();
================================================
FILE: includes/admin/class.llms.admin.page.status.php
================================================
<?php
/**
* Admin Status Pages
*
* @package LifterLMS/Admin/Classes
*
* @since 3.11.2
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Page_Status class
*
* @since 3.11.2
* @since 3.32.0 Add "Scheduled Actions" tab.
* @since 3.33.1 Read log files using `llms_filter_input`.
* @since 3.33.2 Fix undefined index when viewing log files.
* @since 3.35.0 Sanitize input data.
* @since 3.37.14 Added the WP Core `debug.log` file as log that's viewable via the log viewer.
* @since 4.0.0 The `clear-sessions` tool has been moved to `LLMS_Admin_Tool_Clear_Sessions`.
*/
class LLMS_Admin_Page_Status {
/**
* Register "unclassed" core tools
*
* @since 4.13.0
*
* @param array[] $tools List of tool definitions.
* @return array[]
*/
public static function add_core_tools( $tools ) {
return array_merge(
$tools,
array(
'reset-tracking' => array(
'description' => __( 'If you opted into LifterLMS Tracking and no longer wish to participate, you may opt out here.', 'lifterlms' ),
'label' => __( 'Reset Tracking Settings', 'lifterlms' ),
'text' => __( 'Reset Tracking Settings', 'lifterlms' ),
),
'clear-cache' => array(
'description' => __( 'Clears the cached data displayed on various reporting screens. This does not affect actual student progress, it only clears cached progress data. This data will be regenerated the next time it is accessed.', 'lifterlms' ),
'label' => __( 'Student Progress Cache', 'lifterlms' ),
'text' => __( 'Clear cache', 'lifterlms' ),
),
'setup-wizard' => array(
'description' => __( 'If you want to run the LifterLMS Setup Wizard again or skipped it and want to return now, click below.', 'lifterlms' ),
'label' => __( 'Setup Wizard', 'lifterlms' ),
'text' => __( 'Return to Setup Wizard', 'lifterlms' ),
),
)
);
}
/**
* Handle tools actions
*
* @since 3.11.2
* @since 3.35.0 Sanitize input data.
* @since 3.37.14 Verify user capabilities when doing a tool action.
* Use `llms_redirect_and_exit()` in favor of `wp_safe_redirect()`.
* @since 4.0.0 The `clear-sessions` tool has been moved to `LLMS_Admin_Tool_Clear_Sessions`.
* @since 4.13.0 The `automatic-payments` tool has been moved to `LLMS_Admin_Tool_Reset_Automatic_Payments`.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
private static function do_tool() {
if ( ! isset( $_REQUEST['_wpnonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_wpnonce'] ) ), 'llms_tool' ) || ! current_user_can( 'manage_lifterlms' ) ) {
wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'lifterlms' ) );
}
$tool = llms_filter_input_sanitize_string( INPUT_POST, 'llms_tool' );
/**
* Custom and 3rd party tools can use this action to perform the tool's action
*
* @since Unknown
*
* @see llms_status_tools For the filter used to register tools.
*
* @param string $tool Tool name or ID.
*/
do_action( 'llms_status_tool', $tool );
switch ( $tool ) {
case 'clear-cache':
global $wpdb;
$wpdb->query( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
"DELETE FROM {$wpdb->usermeta} WHERE meta_key = 'llms_overall_progress' or meta_key = 'llms_overall_grade';"
);
break;
case 'reset-tracking':
update_option( 'llms_allow_tracking', 'no' );
break;
case 'setup-wizard':
llms_redirect_and_exit( esc_url_raw( admin_url( 'admin.php?page=llms-setup' ) ) );
break;
}
}
/**
* Handle form / link actions on the status pages
*
* @since 3.11.2
*
* @return void
*/
public static function handle_actions() {
if ( ! empty( $_REQUEST['llms_delete_log'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonces are verified elsewhere.
self::remove_log_file();
} elseif ( ! empty( $_REQUEST['llms_tool'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- Nonces are verified elsewhere.
self::do_tool();
}
}
/**
* Retrieve the URL to the status page
*
* @since 3.11.2
*
* @param string $tab Optionally add a tab.
* @return string
*/
public static function get_url( $tab = null ) {
$args = array(
'page' => 'llms-status',
);
if ( $tab ) {
$args['tab'] = $tab;
}
return add_query_arg( $args, admin_url( 'admin.php' ) );
}
/**
* Retrieve an array of log files
*
* @since 3.11.2
* @since 3.37.14 Add the WP debug.log file to the array if `WP_DEBUG_LOG` is enabled.
*
* @return array[] Associative array of log files. The array key is the file "slug" and the value is the file's absolute path.
*/
private static function get_logs() {
$result = array();
// Retrieve all the files in our log directory.
$files = @scandir( LLMS_LOG_DIR ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged -- It's okay though.
if ( ! empty( $files ) ) {
foreach ( $files as $key => $value ) {
// Ignore directory dots, directories, and non .log files.
if ( in_array( $value, array( '.', '..' ), true ) || is_dir( $value ) || ! strstr( $value, '.log' ) ) {
continue;
}
$result[ sanitize_title( $value ) ] = LLMS_LOG_DIR . $value;
}
}
// Add the site's debug.log or native error log file if it exists.
$err_path = ini_get( 'error_log' );
if ( $err_path ) {
$result['debug-log'] = $err_path;
}
return $result;
}
/**
* Output the system report
*
* @since 2.1.0
* @since 3.32.0 Add "Scheduled Actions" tab output.
* @since 3.35.0 Sanitize input data.
* @since 3.37.14 Use strict comparators.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
public static function output() {
$tabs = apply_filters(
'llms_admin_page_status_tabs',
array(
'report' => __( 'System Report', 'lifterlms' ),
'tools' => __( 'Tools & Utilities', 'lifterlms' ),
'logs' => __( 'Logs', 'lifterlms' ),
'action-scheduler' => __( 'Scheduled Actions', 'lifterlms' ),
)
);
$current_tab = empty( $_GET['tab'] ) ? 'report' : llms_filter_input_sanitize_string( INPUT_GET, 'tab' ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- We're not processing the form data.
?>
<div class="wrap lifterlms llms-status llms-status--<?php echo esc_attr( $current_tab ); ?>">
<nav class="llms-nav-tab-wrapper llms-nav-secondary">
<ul class="llms-nav-items">
<?php
foreach ( $tabs as $name => $label ) :
$active = ( $current_tab === $name ) ? ' llms-active' : '';
?>
<li class="llms-nav-item<?php echo esc_attr( $active ); ?>"><a class="llms-nav-link" href="<?php echo esc_url( self::get_url( $name ) ); ?>"><?php echo esc_html( $label ); ?></a></li>
<?php endforeach; ?>
</ul>
</nav>
<h1 style="display:none;"></h1>
<?php
do_action( 'llms_before_admin_page_status', $current_tab );
switch ( $current_tab ) {
case 'action-scheduler':
ActionScheduler_AdminView::instance()->render_admin_ui();
break;
case 'logs':
self::output_logs_content();
break;
case 'report':
LLMS_Admin_System_Report::output();
break;
case 'tools':
self::output_tools_content();
break;
}
do_action( 'llms_after_admin_page_status', $current_tab );
?>
</div>
<?php
}
/**
* Delete a log file
*
* @since 3.11.2
* @since 3.35.0 Sanitize input data.
* @since 3.37.14 Added user capability check.
*
* @return void
*/
private static function remove_log_file() {
if ( ! isset( $_REQUEST['_wpnonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_wpnonce'] ) ), 'delete_log' ) || ! current_user_can( 'manage_lifterlms' ) ) {
wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'lifterlms' ) );
}
if ( ! empty( $_REQUEST['llms_delete_log'] ) ) {
$logs = self::get_logs();
$handle = sanitize_title( wp_unslash( $_REQUEST['llms_delete_log'] ) );
$log = isset( $logs[ $handle ] ) ? $logs[ $handle ] : false;
if ( $log && is_file( $log ) && is_writable( $log ) ) {
unlink( $log );
llms_redirect_and_exit( esc_url_raw( self::get_url( 'logs' ) ) );
}
}
}
/**
* Output the HTML for the Logs tab
*
* @since 3.11.2
* @since 3.33.1 Use `llms_filter_input` to read current log file.
* @since 3.33.2 Fix undefined variable notice.
* @since 3.37.14 Moved HTML output to the view file located at includes/admin/views/status/view-log.php.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
private static function output_logs_content() {
$logs = self::get_logs();
$date_format = get_option( 'date_format' ) . ' ' . get_option( 'time_format' );
$log_file = llms_filter_input_sanitize_string( INPUT_POST, 'llms_log_file' );
$current = $log_file ? sanitize_title( $log_file ) : null;
if ( $logs && ! $current ) {
$log_keys = array_keys( $logs );
$current = array_shift( $log_keys );
}
if ( $logs ) {
// Nonce URL to delete a log file.
$delete_url = 'debug-log' === $current ? '' : wp_nonce_url(
add_query_arg(
array(
'llms_delete_log' => $current,
),
self::get_url( 'logs' )
),
'delete_log'
);
include_once 'views/status/view-log.php';
} else {
echo '<div class="llms-log-viewer">' . esc_html__( 'There are currently no logs to view.', 'lifterlms' ) . '</div>';
}
}
/**
* Output the HTML for the tools tab
*
* @since 3.11.2
* @since 4.0.0 The `clear-sessions` tool has been moved to `LLMS_Admin_Tool_Clear_Sessions`.
* @since 4.13.0 Move "unclassed" core actions to be added to the `llms_status_tools` filter at priority 5 via `LLMS_Admin_Page_Status::add_core_tools()`.
*
* @return void
*/
private static function output_tools_content() {
// Load unclassed core tools at priority 5 to "preserve" their original order before we started classing tools.
add_filter( 'llms_status_tools', array( __CLASS__, 'add_core_tools' ), 5 );
/**
* Register tools with the LifterLMS core
*
* When registering a custom tool you should additionally have an action triggered for the tool using the action
* `llms_status_tool` which will be called to process or handle the action.
*
* @since Unknown
*
* @see llms_status_tool For the action called to handle a tool.
*
* @param array[] $tools {
* Associative array of status tool definitions.
*
* The array key is a unique "id" for the tool and the array value should be an associative array
* as described below:
*
* @type string $description Description of what the tool does.
* @type string $label The title of the tool.
* @type string $text The text displayed on the tool's button.
* }
*/
$tools = apply_filters( 'llms_status_tools', array() );
?>
<form action="<?php echo esc_url( self::get_url( 'tools' ) ); ?>" method="POST">
<div class="llms-setting-group top">
<p class="llms-label"><?php esc_html_e( 'Tools & Utilities', 'lifterlms' ); ?></p>
<table class="llms-table text-left zebra">
<?php foreach ( $tools as $slug => $data ) : ?>
<tr>
<th><?php echo esc_html( $data['label'] ); ?></th>
<td>
<p><?php echo wp_kses_post( $data['description'] ); ?></p>
<button class="llms-button-secondary small" name="llms_tool" type="submit" value="<?php echo esc_attr( $slug ); ?>"><?php echo esc_html( $data['text'] ); ?></button>
</td>
</tr>
<?php endforeach; ?>
</table>
<?php wp_nonce_field( 'llms_tool' ); ?>
</div>
</form>
<?php
}
}
================================================
FILE: includes/admin/class.llms.admin.post-types.php
================================================
<?php
/**
* LLMS_Admin_Post_Types class.
*
* @package LifterLMS/Admin/Classes
*
* @since Unknown
* @version 6.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Post Types.
*
* Sets up post type custom messages and includes base metabox class.
*
* @since Unknown.
* @since 6.0.0 Removed LLMS_Admin_Post_Types::meta_metabox_init() in favor of autoloading.
*/
class LLMS_Admin_Post_Types {
/**
* Constructor
*
* Adds functions to actions and sets filter on post_updated_messages.
*
* @since Unknown
* @since 6.0.0 Disable the block editor for legacy certificates.
*
* @return void
*/
public function __construct() {
add_action( 'use_block_editor_for_post', array( $this, 'use_block_editor_for_post' ), 20, 2 );
add_action( 'admin_init', array( $this, 'include_post_type_metabox_class' ) );
add_filter( 'post_updated_messages', array( $this, 'llms_post_updated_messages' ) );
}
/**
* Admin Menu
*
* Includes base metabox class
*
* @return void
*/
public function include_post_type_metabox_class() {
include 'post-types/class.llms.meta.boxes.php';
}
/**
* Disables the block editor for legacy certificates.
*
* @since 6.0.0
*
* @param boolean $use_block_editor Whether or not to use the block editor.
* @param WP_Post $post Post object.
* @return boolean
*/
public function use_block_editor_for_post( $use_block_editor, $post ) {
$cert = llms_get_certificate( $post, true );
if ( $cert && 1 === $cert->get_template_version() ) {
$use_block_editor = false;
}
return $use_block_editor;
}
/**
* Initializes core for metaboxes.
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Admin_Post_Types::meta_metabox_init()` is deprecated with no replacement.
*
* @return void
*/
public function meta_metabox_init() {
llms_deprecated_function( __METHOD__, '6.0.0' );
include_once 'llms.class.admin.metabox.php';
}
/**
* Customize post type messages.
*
* @since Unknown.
* @since 3.35.0 Fix l10n calls.
* @since 4.7.0 Added `publicly_queryable` check for permalink and preview.
* @since 6.0.0 Handle `llms_my_certificate` and `llms_my_achievement` post types.
* @since 6.7.0 Fixed too few arguments passed to sprintf, when building restore from revision message.
*
* @return array $messages Post updated messages.
*/
public function llms_post_updated_messages( $messages ) {
global $post;
$llms_post_types = array(
'course',
'section',
'lesson',
'llms_order',
'llms_email',
'llms_email',
'llms_certificate',
'llms_my_certificate',
'llms_achievement',
'llms_my_achievement',
'llms_engagement',
'llms_quiz',
'llms_question',
'llms_coupon',
);
foreach ( $llms_post_types as $type ) {
$obj = get_post_type_object( $type );
$name = $obj->labels->singular_name;
$permalink_html = '';
$preview_link_html = '';
if ( $obj->publicly_queryable ) {
$permalink = get_permalink( $post->ID );
$preview_link = add_query_arg( 'preview', 'true', $permalink );
$link_format = ' <a href="%1$s">%2$s</a>.';
$permalink_html = sprintf( $link_format, $permalink, sprintf( __( 'View %s', 'lifterlms' ), $name ) );
$preview_link_html = sprintf( $link_format, $permalink, sprintf( __( 'Preview %s', 'lifterlms' ), $name ) );
}
$messages[ $type ] = array(
0 => '',
1 => sprintf( __( '%s updated.', 'lifterlms' ), $name ) . $permalink_html,
2 => __( 'Custom field updated.', 'lifterlms' ),
3 => __( 'Custom field deleted.', 'lifterlms' ),
4 => sprintf( __( '%s updated.', 'lifterlms' ), $name ),
5 => isset( $_GET['revision'] ) ? // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- No need to verify the nonce here.
sprintf(
__( '%1$s restored to revision from %2$s.', 'lifterlms' ),
$name,
wp_post_revision_title( llms_filter_input( INPUT_GET, 'revision', FILTER_SANITIZE_NUMBER_INT ), false )
)
:
false,
6 => sprintf( __( '%s published.', 'lifterlms' ), $name ) . $permalink_html,
7 => sprintf( __( '%s saved.', 'lifterlms' ), $name ),
8 => sprintf( __( '%s submitted.', 'lifterlms' ), $name ) . $preview_link_html,
9 => sprintf(
__( '%1$s scheduled for: <strong>%2$s</strong>.', 'lifterlms' ),
$name,
date_i18n( __( 'M j, Y @ G:i', 'lifterlms' ), strtotime( $post->post_date ) )
) . $preview_link_html,
10 => sprintf( __( '%1$s draft updated.', 'lifterlms' ), $name ) . $preview_link_html,
);
}
return $messages;
}
}
return new LLMS_Admin_Post_Types();
================================================
FILE: includes/admin/class.llms.admin.resources.php
================================================
<?php
/**
* Admin Resources Screen
*
* @package LifterLMS/Admin/Classes
*
* @since 7.4.1
* @version 7.4.1
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Resources Screen class.
*
* @since 7.4.1
*/
class LLMS_Admin_Resources {
/**
* Retrieve an instance of the WP_Screen for the resources screen.
*
* @since 7.4.1
*
* @return WP_Screen|boolean Returns a `WP_Screen` object when on the resources screen, otherwise returns `false`.
*/
public static function get_screen() {
$screen = get_current_screen();
if ( $screen instanceof WP_Screen && 'lifterlms_page_llms-resources' === $screen->id ) {
return $screen;
}
return false;
}
/**
* Register Resource's meta boxes.
*
* @since 7.4.1
*
* @return void
*/
public static function register_meta_boxes() {
add_meta_box(
'llms_dashboard_welcome_video',
__( 'Welcome to LifterLMS', 'lifterlms' ),
array( __CLASS__, 'meta_box' ),
'toplevel_page_llms-resources',
'normal',
'default',
array( 'view' => 'welcome-video' )
);
add_meta_box(
'llms_dashboard_resource_links',
__( 'Resource Links', 'lifterlms' ),
array( __CLASS__, 'meta_box' ),
'toplevel_page_llms-resources',
'normal',
'default',
array( 'view' => 'resource-links' )
);
add_meta_box(
'llms_dashboard_getting_started',
__( 'Getting Started', 'lifterlms' ),
array( __CLASS__, 'meta_box' ),
'toplevel_page_llms-resources',
'side',
'default',
array( 'view' => 'getting-started' )
);
/**
* Fired after adding the meta boxes on the LifterLMS admin resources page.
*
* Third parties can hook here to remove LifterLMS core meta boxes.
*
* @since 7.4.1
*/
do_action( 'llms_resources_meta_boxes_added' );
}
/**
* Prints the resource's meta box html.
*
* @since 7.4.1
*
* @param mixed $data_object Often this is the object that's the focus of the current screen,
* for example a `WP_Post` or `WP_Comment` object.
* @param array $box Meta Box configuration array.
* @return void
*/
public static function meta_box( $data_object, $box ) {
if ( isset( $box['args']['view'] ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Output is escaped in the view file.
echo self::get_view( $box['args']['view'] );
}
}
/**
* Handle HTML output on the screen.
*
* @since 7.4.1
*
* @return void
*/
public static function output() {
include 'views/resources.php';
}
/**
* Retrieves the HTML of a view from the views/dashboard directory.
*
* @since 7.4.1
*
* @param string $file The file basename of the view to retrieve.
* @return string The HTML content of the view.
*/
private static function get_view( $file ) {
ob_start();
include 'views/resources/' . $file . '.php';
return ob_get_clean();
}
}
================================================
FILE: includes/admin/class.llms.admin.reviews.php
================================================
<?php
/**
* Admin Reviews
*
* @package LifterLMS/Admin/Classes
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Reviews class
*
* This class handles the admin side of the reviews.
* It is responsible for creating the meta box on the course
* page (and in the future the membership page).
*
* @since Unknown
*/
class LLMS_Admin_Reviews {
public static $prefix = '_';
/**
* The constructor for the class. It adds the methods here to the appropriate
* actions. The actions are for:
* 1) Creating the custom column set in the llms_review post screen
* 2) Making a column sortable
* 3) Adding content to the column
* 4) Outputting the content.
* 5) Adding the meta boxes to the course page
* 6) Handling the saving of the data
*
* @return void
*/
public function __construct() {
add_action( 'manage_llms_review_posts_columns', array( $this, 'init' ) );
add_action( 'manage_edit-llms_review_sortable_columns', array( $this, 'make_columns_sortable' ) );
add_action( 'manage_llms_review_posts_custom_column', array( $this, 'generate_column_data' ), 10, 2 );
add_filter( 'llms_metabox_fields_lifterlms_course_options', array( $this, 'add_review_meta_boxes' ) );
add_action( 'save_post', array( $this, 'save_review_meta_boxes' ) );
}
/**
* This function generates the custom column set. It takes in
* the array of standard columns, then modifies that set to
* contain the needed fields.
*
* @param array $columns The array of standard WP columns
*
* @return array The updated array of columns.
*/
public function init( $columns ) {
unset( $columns['date'] );
unset( $columns['comments'] );
$columns['title'] = __( 'Review Title', 'lifterlms' );
$columns['course'] = __( 'Course Reviewed', 'lifterlms' );
$columns['author'] = __( 'Review Author', 'lifterlms' );
$columns['date'] = __( 'Review Date', 'lifterlms' );
return $columns;
}
/**
* This function makes the 'Course' column sortable
*
* @param array $columns Array of sortable columns
* @return array Updated column array.
*/
public function make_columns_sortable( $columns ) {
$columns['course'] = 'course';
return $columns;
}
/**
* This function entered the information into the course section
* of the llms_review post page. It takes the column that is being
* worked on, as well as the comment ID, then echoes the content
* required.
*
* @param string $column Type of column being worked on
* @param int $post_id ID of comment
*
* @return void
*/
public function generate_column_data( $column, $post_id ) {
switch ( $column ) {
case 'course':
echo ( wp_get_post_parent_id( $post_id ) != 0 ) ? esc_html( get_the_title( wp_get_post_parent_id( $post_id ) ) ) : '';
break;
}
}
/**
* This function builds the additional content that is added
* to the course meta box. It builds the additional fields and
* then returns the updated array of fields
*
* @param array $content Array of meta fields
*
* @return array Updated array of meta fields
*/
public function add_review_meta_boxes( $content ) {
/**
* This array is what holds the updated fields.
* It is created in such a way so that a plugin
* can latch onto it to extend the review functionality
*
* @var array
*/
$fields = array(
array(
'type' => 'checkbox',
'label' => __( 'Enable Reviews', 'lifterlms' ),
'desc' => __( 'Select to enable reviews.', 'lifterlms' ),
'id' => self::$prefix . 'llms_reviews_enabled',
'class' => '',
'value' => '1',
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'group' => '',
),
array(
'type' => 'checkbox',
'label' => __( 'Display Reviews', 'lifterlms' ),
'desc' => __( 'Select to display reviews on the page.', 'lifterlms' ),
'id' => self::$prefix . 'llms_display_reviews',
'class' => 'llms-num-reviews-top',
'value' => '1',
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'group' => 'llms-num-reviews-top',
),
array(
'type' => 'number',
'min' => '0',
'label' => __( 'Number of Reviews', 'lifterlms' ),
'desc' => __( 'Number of reviews to display on the page.', 'lifterlms' ),
'id' => self::$prefix . 'llms_num_reviews',
'class' => 'input-full',
'value' => '',
'desc_class' => 'd-all',
'group' => 'bottom llms-num-reviews-bottom',
),
array(
'type' => 'checkbox',
'label' => __( 'Prevent Multiple Reviews', 'lifterlms' ),
'desc' => __( 'Select to prevent a user from submitting more than one review.', 'lifterlms' ),
'id' => self::$prefix . 'llms_multiple_reviews_disabled',
'class' => '',
'value' => '1',
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'group' => '',
),
);
if ( has_filter( 'llms_review_fields' ) ) {
$fields = apply_filters( 'llms_review_fields', $fields );
}
$metaboxtab = array(
'title' => __( 'Reviews', 'lifterlms' ),
'fields' => $fields,
);
array_push( $content, $metaboxtab );
return $content;
}
/**
* Save metabox fields.
*
* @since Unknown
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public function save_review_meta_boxes() {
$post_id = llms_filter_input( INPUT_POST, 'post_ID', FILTER_SANITIZE_NUMBER_INT );
if ( ! $post_id ) {
return;
}
$post_type = get_post_type( $post_id );
if ( 'course' !== $post_type ) {
return;
}
// phpcs:disable WordPress.Security.NonceVerification.Missing -- Nonce verified by core before triggering hook.
$enabled = ( isset( $_POST['_llms_reviews_enabled'] ) ) ? llms_filter_input_sanitize_string( INPUT_POST, '_llms_reviews_enabled' ) : '';
$display = ( isset( $_POST['_llms_display_reviews'] ) ) ? llms_filter_input_sanitize_string( INPUT_POST, '_llms_display_reviews' ) : '';
$num = ( isset( $_POST['_llms_num_reviews'] ) ) ? llms_filter_input_sanitize_string( INPUT_POST, '_llms_num_reviews' ) : 0;
$multiple = ( isset( $_POST['_llms_multiple_reviews_disabled'] ) ) ? llms_filter_input_sanitize_string( INPUT_POST, '_llms_multiple_reviews_disabled' ) : '';
update_post_meta( $post_id, '_llms_reviews_enabled', $enabled );
update_post_meta( $post_id, '_llms_display_reviews', $display );
update_post_meta( $post_id, '_llms_num_reviews', $num );
update_post_meta( $post_id, '_llms_multiple_reviews_disabled', $multiple );
// phpcs:enable WordPress.Security.NonceVerification.Missing
}
}
return new LLMS_Admin_Reviews();
================================================
FILE: includes/admin/class.llms.admin.settings.php
================================================
<?php
/**
* Admin Settings and fields
*
* @package LifterLMS/Admin/Classes
*
* @since 1.0.0
* @version 7.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin settings and fields class
*
* @since 1.0.0
* @since 3.29.0 Unknown.
* @since 3.34.4 Add "keyval" field for displaying custom html next to a setting key.
* @since 3.35.0 Sanitize input data.
* @since 3.35.1 Fix saving issue.
* @since 3.35.2 Don't strip tags on editor and textarea fields that allow HTML.
* @since 3.37.9 Add option for fields to show an asterisk for required fields.
* @since 4.2.0 Use dashicons for tooltip icon display.
*/
class LLMS_Admin_Settings {
/**
* Settings array
*
* @var array
*/
private static $settings = array();
/**
* Errors array
*
* @var array
*/
private static $errors = array();
/**
* Messages array
*
* @var array
*/
private static $messages = array();
/**
* Instantiates setting page objects, if not already done, and returns them.
*
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return LLMS_Settings_Page[] self::$settings
*/
public static function get_settings_tabs() {
if ( empty( self::$settings ) ) {
$settings = array();
$settings[] = include 'settings/class.llms.settings.general.php';
$settings[] = include 'settings/class.llms.settings.courses.php';
$settings[] = include 'settings/class.llms.settings.memberships.php';
$settings[] = include 'settings/class.llms.settings.security.php';
$settings[] = include 'settings/class.llms.settings.accounts.php';
$settings[] = include 'settings/class.llms.settings.checkout.php';
$settings[] = include 'settings/class.llms.settings.engagements.php';
$settings[] = include 'settings/class.llms.settings.notifications.php';
$settings[] = include 'settings/class.llms.settings.integrations.php';
/**
* Allow 3rd parties to add or remove setting pages.
*
* @since 1.0.0
*
* @param LLMS_Settings_Page[] $settings Setting page objects.
*/
self::$settings = apply_filters( 'lifterlms_get_settings_pages', $settings );
}
return self::$settings;
}
/**
* Save method. Saves all fields on current tab
*
* @return void
*/
public static function save() {
global $current_tab;
if ( isset( $_POST['_wpnonce'] ) && ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['_wpnonce'] ) ), 'lifterlms-settings' ) ) {
die( esc_html__( 'Whoa! something went wrong there!. Please refresh the page and retry.', 'lifterlms' ) );
}
do_action( 'lifterlms_settings_save_' . $current_tab );
do_action( 'lifterlms_update_options_' . $current_tab );
do_action( 'lifterlms_update_options' );
self::set_message( __( 'Your settings have been saved.', 'lifterlms' ) );
do_action( 'lifterlms_settings_saved' );
do_action( 'lifterlms_settings_saved_' . $current_tab );
}
/**
* set message to messages array
*
* @param string $message
* @return void
*/
public static function set_message( $message ) {
self::$messages[] = $message;
}
/**
* set message to messages array
*
* @param string $message
* @return void
*/
public static function set_error( $message ) {
self::$errors[] = $message;
}
/**
* display messages in settings
*
* @return void
*/
public static function display_messages_html() {
if ( count( self::$errors ) > 0 ) {
foreach ( self::$errors as $error ) {
echo '<div class="error"><p><strong>' . wp_kses_post( $error ) . '</strong></p></div>';
}
} elseif ( count( self::$messages ) > 0 ) {
foreach ( self::$messages as $message ) {
echo '<div class="updated"><p><strong>' . wp_kses_post( $message ) . '</strong></p></div>';
}
}
}
/**
* Settings Page output tabs
*
* @since 1.0.0
* @since 3.29.0 Unknown.
* @since 3.35.0 Sanitize `$_GET` data.
* @since 3.35.1 Fix issue causing data to be saved on every page load.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public static function output() {
global $current_tab;
do_action( 'lifterlms_settings_start' );
self::get_settings_tabs();
// phpcs:ignore WordPress.Security.NonceVerification.Recommended -- nonce is checked in self::save().
$current_tab = empty( $_GET['tab'] ) ? 'general' : llms_filter_input_sanitize_string( INPUT_GET, 'tab' );
// phpcs:disable WordPress.Security.NonceVerification.Missing -- nonce is checked in self::save().
if ( ! empty( $_POST ) ) {
self::save();
}
// phpcs:enable WordPress.Security.NonceVerification.Missing.
$err = llms_filter_input_sanitize_string( INPUT_GET, 'llms_error' );
if ( $err ) {
self::set_error( $err );
}
$msg = llms_filter_input_sanitize_string( INPUT_GET, 'llms_message' );
if ( $msg ) {
self::set_message( $msg );
}
self::display_messages_html();
$tabs = apply_filters( 'lifterlms_settings_tabs_array', array() );
include 'views/settings.php';
}
/**
* Output fields for settings tabs. Dynamically generates fields.
*
* Needs to be refactored! Sets up all of the fields..gross...
*
* @return void
*/
public static function output_fields( $settings ) {
foreach ( $settings as $field ) {
// Skip item if no field type is set.
if ( ! isset( $field['type'] ) ) {
continue; }
// Output the field.
self::output_field( $field );
}
}
/**
* Output fields
*
* @since Unknown.
* @since 3.29.0 Unknown.
* @since 3.34.4 Add "keyval" field for displaying custom html next to a setting key.
* @since 3.37.9 Add option for fields to show an asterisk for required fields.
* @since 5.0.2 Pass any option value sanitized as a "slug" through `urldecode()` prior to displaying it.
* @since 7.0.0 Add `$after_html` to all field types.
*
* @param array $field {
* Array of field settings.
*
* @type string $id The setting ID. Used as the from element's `name` and `id` attributes and
* automatically correspond to an option key using the WP options API.
* @type string $type The field type. Accepts: 'title', 'table', 'subtitle', 'desc', 'custom-html',
* 'custom-html-no-wrap', 'sectionstart', 'sectionend', 'button', 'hidden', 'keyval',
* 'text', 'email', 'number', 'password', 'textarea', 'wpeditor', 'select', 'multiselect',
* 'radio', 'checkbox', 'image', 'single_select_page', 'single_select_membership'.
* @type string $title The title / name of the option as displayed to the user.
* @type string $name For "button" fields only: used as HTML `name` attribute. If not supplied the default
* value "save" will be used. For other field types used as a fallback for `$title` if
* no value is supplied.
* @type string $class A space-separated list of CSS class names to apply the setting form element (the
* `<input>`, `<select>` etc...).
* @type string $css An inline CSS style string.
* @type string $default The default value of the setting.
* @type string $desc The setting's description.
* @type bool $desc_tooltip If `true`, displays `$desc` in a hoverable tooltip.
* @type string $value The value of the setting. If supplied this will override the automatic setting retrieval
* using `get_option( $id, $default )`.
* @type array $custom_attributes An associative array of custom HTML attributes to be added to the form element (the
* `<input>`, `<select>` etc...).
* @type bool $disabled If `true` adds the `llms-disabled-field` class to the settings field wrapper.
* @type bool $required If `true`, text, email, number, and password fields will require user input.
* @type string $secure_option The name of settings secure option equivalent. If specified, the fields value will be
* automatically removed from the database and the value will be masked when displayed on
* on screen. See {@see llms_get_secure_option()} for more information.
* @type string $sanitize Automatically apply the specified sanitization to the value before storing and outputting
* the stored value. Supported filters:
* + "slug": Uses `sanitize_title()` on the value when storing and `urldecode()` when displaying.
* @type string $after_html Additional HTML to add after the field's form element.
* @type array $editor_settings Used with "wpeditor" field type only. An array of options to pass to `wp_editor()` as the `$settings` argument.
* @type array $options For "select", "multiselect", and "radio" fields, an array of key/value pairs where the
* key is the setting value stored in database and the value is the setting label displayed
* on screen.
* }
* @return void
*/
public static function output_field( $field ) {
// Set missing values with defaults.
$field = self::set_field_defaults( $field );
// Setup custom attributes.
$custom_attributes = self::format_field_custom_attributes( $field['custom_attributes'] ?? array() );
// Setup field description and tooltip.
extract( self::set_field_descriptions( $field ) );
$description .= ' ' . $field['after_html'];
// Get the field value.
$option_value = isset( $field['value'] ) ? $field['value'] : self::get_option( $field['id'], $field['default'] );
// Setup the disabled CSS class.
$disabled_class = ( isset( $field['disabled'] ) && true === $field['disabled'] ) ? 'llms-disabled-field' : '';
// Switch based on type.
switch ( $field['type'] ) {
// Section Titles.
case 'title':
if ( ! empty( $field['title'] ) ) {
echo '<p class="llms-label">' . esc_html( $field['title'] ) . '</p>';
}
if ( ! empty( $field['desc'] ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in wp_kses_post()
echo '<p class="llms-description">' . wpautop( wptexturize( wp_kses_post( $field['desc'] ) ) ) . '</p>';
}
echo '<table class="form-table">' . "\n\n";
if ( ! empty( $field['id'] ) ) {
do_action( 'lifterlms_settings_' . sanitize_title( $field['id'] ) );
}
break;
case 'table':
echo '<tr valign="top" class="' . esc_attr( $disabled_class ) . '"><td>';
$field['table']->get_results();
$field['table']->output_table_html();
echo '</td></tr>';
break;
case 'subtitle':
if ( ! empty( $field['title'] ) ) {
echo '<tr valign="top" class="' . esc_attr( $disabled_class ) . '"><td colspan="2">
<h3 class="llms-subtitle">' . esc_html( $field['title'] ) . '</h3>';
if ( ! empty( $field['desc'] ) ) {
echo '<p>' . wp_kses_post( $field['desc'] ) . '</p>';
}
echo '</tr></td>';
}
break;
case 'desc':
if ( ! empty( $field['desc'] ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in wp_kses_post()
echo '<th colspan="2" style="font-weight: normal;">' . wpautop( wptexturize( wp_kses_post( $field['desc'] ) ) ) . '</th>';
}
break;
case 'custom-html':
if ( ! empty( $field['value'] ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in value / template file..
echo '<tr valign="top" class="' . esc_attr( $disabled_class ) . '"><td colspan="2">' . $field['value'] . '</tr></td>';
}
break;
case 'custom-html-no-wrap':
if ( ! empty( $field['value'] ) ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in value / template file..
echo $field['value'];
}
break;
case 'sectionstart':
if ( ! empty( $field['id'] ) ) {
do_action( 'lifterlms_settings_' . sanitize_title( $field['id'] ) . '_before' );
echo '<div class="llms-setting-group ' . esc_attr( $field['class'] ) . '">';
do_action( 'lifterlms_settings_' . sanitize_title( $field['id'] ) . '_start' );
}
break;
case 'sectionend':
if ( ! empty( $field['id'] ) ) {
do_action( 'lifterlms_settings_' . sanitize_title( $field['id'] ) . '_end' );
}
echo '</table>';
echo '</div>';
if ( ! empty( $field['id'] ) ) {
do_action( 'lifterlms_settings_' . sanitize_title( $field['id'] ) . '_after' );
}
break;
case 'button':
$name = isset( $field['name'] ) ? $field['name'] : 'save';
echo '<tr valign="top" class="' . esc_attr( $disabled_class ) . '"><th><label for="' . esc_attr( $field['id'] ) . '">' . esc_html( $field['title'] ) . '</label>';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- $tooltip escaped in set_field_descriptions().
echo $tooltip;
echo '</th>';
echo '<td class="forminp forminp-' . esc_attr( sanitize_title( $field['type'] ) ) . '">';
echo '<div id="llms-form-wrapper">';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- $description escaped in set_field_descriptions().
echo $description . '<br><br>';
echo '<input name="' . esc_attr( $name ) . '" class="llms-button-primary" type="submit" value="' . esc_attr( $field['value'] ) . '" />';
echo '</div>';
echo '</td></tr>';
// phpcs:ignore -- commented out code
// get_submit_button( 'Filter Results', 'primary', 'llms_search', true, array( 'id' => 'llms_analytics_search' ) );
break;
case 'hidden':
echo '<th></th>';
echo '<td><input type="hidden"
name="' . esc_attr( $field['id'] ) . '"
id="' . esc_attr( $field['id'] ) . '"
value="' . esc_attr( $field['value'] ) . '">';
break;
case 'keyval':
?><tr valign="top">
<th>
<label for="<?php echo esc_attr( $field['id'] ); ?>"><?php echo esc_html( $field['title'] ); ?></label>
<?php echo $tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in set_field_descriptions(). ?>
</th>
<td class="forminp forminp-<?php echo esc_attr( sanitize_title( $field['type'] ) ); ?>">
<div id="<?php echo esc_attr( $field['id'] ); ?>"><?php echo wp_kses_post( $field['value'] ); ?></div>
</td>
</tr>
<?php
break;
case 'text':
case 'email':
case 'number':
case 'password':
$type = $field['type'];
$class = '';
$required = ! empty( $field['required'] );
$secure_val = isset( $field['secure_option'] ) ? llms_get_secure_option( $field['secure_option'], false ) : false;
$option_value = ( false !== $secure_val ) ? str_repeat( '*', strlen( $secure_val ) ) : $option_value;
// Ensure slugs with non-latin characters are not displayed as urlencoded strings.
if ( ! empty( $field['sanitize'] ) && 'slug' === $field['sanitize'] ) {
$option_value = urldecode( $option_value );
}
?>
<tr valign="top" class="<?php echo esc_attr( $disabled_class ); ?>">
<th>
<label for="<?php echo esc_attr( $field['id'] ); ?>">
<?php echo esc_html( $field['title'] ); ?>
<?php echo $required ? '<span class="llms-required">*</span>' : ''; ?>
</label>
<?php echo $tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in set_field_descriptions(). ?>
</th>
<td class="forminp forminp-<?php echo esc_attr( sanitize_title( $field['type'] ) ); ?>">
<input
name="<?php echo esc_attr( $field['id'] ); ?>"
id="<?php echo esc_attr( $field['id'] ); ?>"
type="<?php echo esc_attr( $type ); ?>"
style="<?php echo esc_attr( $field['css'] ); ?>"
value="<?php echo esc_attr( $option_value ); ?>"
class="<?php echo esc_attr( $field['class'] ); ?>"
<?php echo $secure_val ? 'disabled="disabled"' : ''; ?>
<?php echo implode( ' ', $custom_attributes ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in format_field_custom_attributes. ?>
<?php echo $required ? 'required="required"' : ''; ?>
/> <?php echo wp_kses_post( $description ); ?>
</td>
</tr>
<?php
break;
// Textarea.
case 'textarea':
?>
<tr valign="top" class="<?php echo esc_attr( $disabled_class ); ?>">
<th>
<label for="<?php echo esc_attr( $field['id'] ); ?>"><?php echo esc_html( $field['title'] ); ?></label>
<?php echo $tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in set_field_descriptions. ?>
</th>
<td class="forminp forminp-<?php echo esc_attr( sanitize_title( $field['type'] ) ); ?>">
<textarea
name="<?php echo esc_attr( $field['id'] ); ?>"
id="<?php echo esc_attr( $field['id'] ); ?>"
style="<?php echo esc_attr( $field['css'] ); ?>"
class="<?php echo esc_attr( $field['class'] ); ?>"
<?php echo implode( ' ', $custom_attributes ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in format_field_custom_attributes. ?>
><?php echo esc_textarea( $option_value ); ?></textarea>
<?php echo wp_kses_post( $description ); ?>
</td>
</tr>
<?php
break;
case 'wpeditor':
$editor_settings = isset( $field['editor_settings'] ) ? $field['editor_settings'] : array();
?>
<tr valign="top" class="<?php echo esc_attr( $disabled_class ); ?>">
<th>
<label for="<?php echo esc_attr( $field['id'] ); ?>"><?php echo esc_html( $field['title'] ); ?></label>
<?php echo $tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in set_field_descriptions. ?>
</th>
<td class="forminp forminp-<?php echo esc_attr( sanitize_title( $field['type'] ) ); ?>">
<?php wp_editor( $option_value, $field['id'], $editor_settings ); ?>
<?php echo wp_kses_post( $description ); ?>
</td>
</tr>
<?php
break;
// Select boxes.
case 'select':
case 'multiselect':
$field_name = esc_attr( $field['id'] );
if ( 'multiselect' === $field['type'] ) {
$field_name .= '[]';
}
?>
<tr valign="top" class="<?php echo esc_attr( $disabled_class ); ?>">
<th>
<label for="<?php echo esc_attr( $field['id'] ); ?>"><?php echo esc_html( $field['title'] ); ?></label>
<?php echo $tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in set_field_descriptions. ?>
</th>
<td class="forminp forminp-<?php echo esc_attr( sanitize_title( $field['type'] ) ); ?>">
<select
name="<?php echo esc_attr( $field_name ); ?>"
id="<?php echo esc_attr( $field['id'] ); ?>"
style="<?php echo esc_attr( $field['css'] ); ?>"
class="<?php echo esc_attr( $field['class'] ); ?>"
<?php echo implode( ' ', $custom_attributes ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in format_field_custom_attributes. ?>
<?php
if ( 'multiselect' === $field['type'] ) {
echo 'multiple="multiple"'; }
?>
>
<?php
foreach ( $field['options'] as $key => $val ) {
// Convert an array from llms_make_select2_post_array().
if ( is_array( $val ) ) {
$key = $val['key'];
$val = $val['title'];
}
?>
<option value="<?php echo esc_attr( $key ); ?>"
<?php
if ( is_array( $option_value ) ) {
selected( in_array( $key, $option_value ), true );
} else {
selected( $option_value, $key );
}
?>
><?php echo wp_kses_post( $val ); ?></option>
<?php
}
?>
</select>
<?php echo wp_kses_post( $description ); ?>
</td>
</tr>
<?php
break;
// Radio inputs.
case 'radio':
?>
<tr valign="top" class="<?php echo esc_attr( $disabled_class ); ?>">
<th>
<label for="<?php echo esc_attr( $field['id'] ); ?>"><?php echo esc_html( $field['title'] ); ?></label>
<?php echo $tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in set_field_descriptions. ?>
</th>
<td class="forminp forminp-<?php echo esc_attr( sanitize_title( $field['type'] ) ); ?>">
<fieldset>
<?php echo wp_kses_post( $description ); ?>
<ul>
<?php
foreach ( $field['options'] as $key => $val ) {
?>
<li>
<label><input
name="<?php echo esc_attr( $field['id'] ); ?>"
value="<?php echo esc_attr( $key ); ?>"
type="radio"
style="<?php echo esc_attr( $field['css'] ); ?>"
class="<?php echo esc_attr( $field['class'] ); ?>"
<?php echo implode( ' ', $custom_attributes ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in format_field_custom_attributes. ?>
<?php checked( $key, $option_value ); ?>
/> <?php echo esc_html( $val ); ?></label>
</li>
<?php
}
?>
</ul>
</fieldset>
</td>
</tr>
<?php
break;
// Checkbox input.
case 'checkbox':
$visbility_class = array();
if ( ! isset( $field['hide_if_checked'] ) ) {
$field['hide_if_checked'] = false;
}
if ( ! isset( $field['show_if_checked'] ) ) {
$field['show_if_checked'] = false;
}
if ( 'yes' === $field['hide_if_checked'] || 'yes' === $field['show_if_checked'] ) {
$visbility_class[] = 'hidden_option';
}
if ( 'option' === $field['hide_if_checked'] ) {
$visbility_class[] = 'hide_options_if_checked';
}
if ( 'option' === $field['show_if_checked'] ) {
$visbility_class[] = 'show_options_if_checked';
}
if ( ! isset( $field['checkboxgroup'] ) || 'start' === $field['checkboxgroup'] ) {
?>
<tr valign="top" class="<?php echo esc_attr( implode( ' ', $visbility_class ) ); ?> <?php echo esc_attr( $disabled_class ); ?>">
<th><?php echo esc_html( $field['title'] ); ?></th>
<td class="forminp forminp-checkbox">
<fieldset>
<?php
} else {
?>
<fieldset class="<?php echo esc_attr( implode( ' ', $visbility_class ) ); ?>">
<?php
}
if ( ! empty( $field['title'] ) ) {
?>
<legend class="screen-reader-text"><span><?php echo esc_html( $field['title'] ); ?></span></legend>
<?php
}
?>
<label for="<?php echo esc_attr( $field['id'] ); ?>">
<input
name="<?php echo esc_attr( $field['id'] ); ?>"
id="<?php echo esc_attr( $field['id'] ); ?>"
type="checkbox"
value="1"
<?php checked( $option_value, 'yes' ); ?>
<?php echo implode( ' ', $custom_attributes ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in format_field_custom_attributes. ?>
/> <?php echo wp_kses_post( $description ); ?>
</label> <?php echo $tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in set_field_descriptions. ?>
<?php
if ( ! isset( $field['checkboxgroup'] ) || 'end' === $field['checkboxgroup'] ) {
?>
</fieldset>
</td>
</tr>
<?php
} else {
?>
</fieldset>
<?php
}
break;
case 'image':
$type = $field['type'];
$class = '';
if ( $option_value ) {
// Media lib object ID.
if ( is_numeric( $option_value ) ) {
$size = isset( $field['image_size'] ) ? $field['image_size'] : 'medium';
$attachment = wp_get_attachment_image_src( $option_value, $size );
$src = $attachment[0];
} else {
// Raw img src.
$src = $option_value;
}
} else {
$src = '';
}
?>
<tr valign="top" class="<?php echo esc_attr( $disabled_class ); ?>">
<th>
<label for="<?php echo esc_attr( $field['id'] ); ?>"><?php echo esc_html( $field['title'] ); ?></label>
<?php echo $tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in set_field_descriptions. ?>
</th>
<td class="forminp forminp-<?php echo esc_attr( sanitize_title( $field['type'] ) ); ?>">
<img class="llms-image-field-preview" src="<?php echo esc_url( $src ); ?>">
<button class="llms-button-secondary llms-image-field-upload" data-id="<?php echo esc_attr( $field['id'] ); ?>" type="button">
<span class="dashicons dashicons-admin-media"></span>
<?php esc_html_e( 'Upload', 'lifterlms' ); ?>
</button>
<button class="llms-button-danger llms-image-field-remove<?php echo ( ! $src ) ? ' hidden' : ''; ?>" data-id="<?php echo esc_attr( $field['id'] ); ?>" type="button">
<span class="dashicons dashicons-no"></span>
</button>
<input
name="<?php echo esc_attr( $field['id'] ); ?>"
id="<?php echo esc_attr( $field['id'] ); ?>"
type="hidden"
style="<?php echo esc_attr( $field['css'] ); ?>"
value="<?php echo esc_attr( $option_value ); ?>"
class="<?php echo esc_attr( $field['class'] ); ?>"
<?php echo implode( ' ', $custom_attributes ); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in format_field_custom_attributes. ?>
/> <?php echo wp_kses_post( $description ); ?>
</td>
</tr>
<?php
break;
// Single page selects.
case 'single_select_page':
$args = array(
'name' => $field['id'],
'id' => $field['id'],
'sort_column' => 'menu_order',
'sort_order' => 'ASC',
'show_option_none' => ' ',
'class' => $field['class'],
'echo' => false,
'selected' => absint( self::get_option( $field['id'] ) ),
);
if ( isset( $field['args'] ) ) {
$args = wp_parse_args( $field['args'], $args );
}
?>
<tr valign="top" class="single_select_page">
<th><?php echo esc_html( $field['title'] ); ?> <?php echo $tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in set_field_descriptions. ?></th>
<td class="forminp">
<?php
// PHPCS ignore reason: This is a dropdown and the output is escaped in wp_dropdown_pages.
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo str_replace( ' id=', " data-placeholder='" . esc_html__( 'Select a page…', 'lifterlms' ) . "' style='" . esc_attr( $field['css'] ) . "' class='" . esc_attr( $field['class'] ) . "' id=", wp_dropdown_pages( $args ) );
?>
<?php echo wp_kses_post( $description ); ?>
</td>
</tr>
<?php
break;
// Single page selects.
case 'single_select_membership':
$args = array(
'posts_per_page' => -1,
'post_type' => 'llms_membership',
'nopaging' => true,
'post_status' => 'publish',
'class' => $field['class'],
'selected' => absint( self::get_option( $field['id'] ) ),
);
$posts = get_posts( $args );
if ( isset( $field['args'] ) ) {
$args = wp_parse_args( $field['args'], $args );
}
?>
<tr valign="top" class="single_select_membership">
<th><?php echo esc_html( $field['title'] ); ?> <?php echo $tooltip; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in set_field_descriptions. ?></th>
<td class="forminp">
<select class="<?php echo esc_attr( $args['class'] ); ?>" style="<?php echo esc_attr( $field['css'] ); ?>" name="lifterlms_membership_required" id="lifterlms_membership_required">
<option value=""> <?php esc_html_e( 'None', 'lifterlms' ); ?></option>
<?php
foreach ( $posts as $post ) :
setup_postdata( $post );
if ( $args['selected'] === $post->ID ) {
$selected = 'selected';
} else {
$selected = '';
}
?>
<option value="<?php echo esc_attr( $post->ID ); ?>" <?php echo esc_attr( $selected ); ?> ><?php echo esc_html( $post->post_title ); ?></option>
<?php endforeach; ?>
</select>
</td>
</tr>
<?php
break;
// Default: run an action.
default:
do_action( 'lifterlms_admin_field_' . $field['type'], $field, $option_value, $description, $tooltip, $custom_attributes );
break;
}
}
/**
* Add and set default values for a field when looping
*
* @since 1.4.5
* @since 7.0.0 Use `wp_parse_args()` to simplify method logic & add `after_html` default.
*
* @param array $field Associative array of field data, {@see LLMS_Admin_Settings::output_field()} for a full description.
* @return array
*/
public static function set_field_defaults( $field = array() ) {
$field = wp_parse_args(
$field,
array(
'id' => '',
'title' => $field['name'] ?? '',
'class' => '',
'css' => '',
'default' => '',
'desc' => '',
'desc_tooltip' => '',
'after_html' => '',
)
);
return $field;
}
/**
* Setup a field's tooltip and description based on supplied values
*
* @since 1.4.5
* @since 3.24.0 Unknown.
* @since 4.2.0 Use a dashicon in place of image for tooltip icon.
*
* @param array $field Associative array of field data.
* @return array {
* Associative array containing field description and tooltip HTML.
*
* @type string $description Description element HTML.
* @type string $tooltip Tooltip element HTML.
* }
*/
public static function set_field_descriptions( $field = array() ) {
$description = '';
$tooltip = '';
if ( true === $field['desc_tooltip'] ) {
$description = '';
$tooltip = $field['desc'];
} elseif ( ! empty( $field['desc_tooltip'] ) ) {
$description = $field['desc'];
$tooltip = $field['desc_tooltip'];
} elseif ( ! empty( $field['desc'] ) ) {
$description = $field['desc'];
$tooltip = '';
}
if ( $description && in_array( $field['type'], array( 'radio' ), true ) ) {
$description = '<p style="margin-top:0">' . wp_kses_post( $description ) . '</p>';
} elseif ( $description && in_array( $field['type'], array( 'checkbox' ), true ) ) {
$description = wp_kses_post( $description );
} elseif ( $description ) {
$description = '<p class="description">' . wp_kses_post( $description ) . '</p>';
}
if ( $tooltip && in_array( $field['type'], array( 'checkbox' ), true ) ) {
$tooltip = '<p class="description">' . $tooltip . '</p>';
} elseif ( $tooltip ) {
$position = isset( $field['tooltip_position'] ) ? $field['tooltip_position'] : 'top-right';
$tooltip = '<span class="llms-help-tooltip tip--' . esc_attr( $position ) . '" data-tip="' . esc_attr( $tooltip ) . '"><span class="dashicons dashicons-editor-help"></span></span>';
}
return compact( 'description', 'tooltip' );
}
/**
* Formats an associative array of custom field attributes as an array of HTML strings
*
* @param array $attributes associative array of attributes
* @return array
*
* @since 1.4.5
*/
public static function format_field_custom_attributes( $attributes = array() ) {
// Custom attribute handling.
$custom_attributes = array();
foreach ( $attributes as $attribute => $attribute_value ) {
$custom_attributes[] = esc_attr( $attribute ) . '="' . esc_attr( $attribute_value ) . '"';
}
return $custom_attributes;
}
/**
* Get a setting from the settings API.
*
* @since Unknown
* @since 3.7.5 Unknown
*
* @param string $option_name Option name.
* @param mixed $default Optional default value.
* @return string
*/
public static function get_option( $option_name, $default = '' ) {
// Array value.
if ( strstr( $option_name, '[' ) ) {
parse_str( $option_name, $option_array );
// Option name is first key.
$option_name = current( array_keys( $option_array ) );
// Get value.
$option_values = get_option( $option_name, '' );
$key = key( $option_array[ $option_name ] );
if ( isset( $option_values[ $key ] ) ) {
$option_value = $option_values[ $key ];
} else {
$option_value = null;
}
} else {
$option_value = get_option( $option_name, null );
}
if ( is_array( $option_value ) ) {
$option_value = stripslashes_deep( $option_value );
} elseif ( ! is_null( $option_value ) ) {
$option_value = stripslashes( $option_value );
}
return null === $option_value ? $default : $option_value;
}
/**
* Save admin fields.
*
* Loops through a LifterLMS settings field options array and saves the values via `update_option()`.
*
* @since 1.0.0
* @since 3.29.0 Unknown.
* @since 3.35.0 Sanitize `$_POST` data.
* @since 3.35.2 Don't strip tags on editor and textarea fields that allow HTML.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 7.0.0 Add handling for array fields for standard input types.
* Account for the `maxlength` input text and textarea attribute.
*
* @param array $settings Opens array to output
* @return boolean
*/
public static function save_fields( $settings ) {
// phpcs:disable WordPress.Security.NonceVerification.Missing -- nonce is checked in self::save().
if ( empty( $_POST ) ) {
return false;
}
// Options to update will be stored here.
$update_options = array();
// Loop options and get values to save.
foreach ( $settings as $field ) {
if ( ! isset( $field['id'] ) ) {
continue;
}
$type = isset( $field['type'] ) ? sanitize_title( $field['type'] ) : '';
// Remove secure options from the database.
if ( isset( $field['secure_option'] ) && llms_get_secure_option( $field['secure_option'] ) ) {
delete_option( $field['id'] );
continue;
}
// Get the option name.
$option_value = null;
// Determines if the option value is an array.
$is_array_option = false !== strpos( $field['id'], '[' );
switch ( $type ) {
case 'checkbox':
if ( $is_array_option ) {
$option_value = self::get_array_field_posted_value( $field['id'] ) ? 'yes' : 'no';
} elseif ( isset( $_POST[ $field['id'] ] ) ) {
$option_value = 'yes';
} else {
$option_value = 'no';
}
break;
case 'textarea':
case 'wpeditor':
if ( isset( $_POST[ $field['id'] ] ) ) {
$option_value = wp_kses_post( trim( llms_filter_input( INPUT_POST, $field['id'], FILTER_DEFAULT ) ) );
} else {
$option_value = '';
}
break;
case 'password':
case 'text':
case 'email':
case 'number':
case 'select':
case 'single_select_page':
case 'single_select_membership':
case 'radio':
case 'hidden':
case 'image':
if ( $is_array_option ) {
$option_value = self::get_array_field_posted_value( $field['id'] );
} elseif ( isset( $_POST[ $field['id'] ] ) ) {
$option_value = llms_filter_input_sanitize_string( INPUT_POST, $field['id'] );
} else {
$option_value = '';
}
if ( isset( $field['sanitize'] ) && 'slug' === $field['sanitize'] ) {
$option_value = sanitize_title( $option_value );
}
break;
case 'multiselect':
if ( isset( $_POST[ $field['id'] ] ) ) {
$option_value = llms_filter_input_sanitize_string( INPUT_POST, $field['id'], array( FILTER_REQUIRE_ARRAY ) );
} else {
$option_value = '';
}
break;
default:
/**
* Action run for external field types.
*
* @since Unknown
* @deprecated 7.0.0 Use `llms_update_option_{$type}` filter hook instead.
*
* @param type $arg Description.
*/
do_action_deprecated( "lifterlms_update_option_{$type}", array( $field ), '7.0.0' );
}
// Special treatment for the 'maxlength' attribute.
if ( in_array( $type, array( 'text', 'textarea' ), true ) && isset( $field['custom_attributes']['maxlength'] ) ) {
$option_value = llms_trim_string( $option_value, (int) $field['custom_attributes']['maxlength'], '' );
}
/**
* Filters the value of a settings field after it has been parsed and sanitized
* and before it is saved to the database.
*
* The dynamic portion of this hook, `{$type}` refers to the setting field type:
* email, text, checkbox, etc...
*
* @since 7.0.0
*
* @param string|null $option_value The sanitized option value or `null`.
* @param array $field The settings field array.
*/
$option_value = apply_filters( "llms_update_option_{$type}", $option_value, $field );
if ( ! is_null( $option_value ) ) {
if ( $is_array_option ) {
parse_str( $field['id'], $option_array );
// Option name is first key.
$option_name = current( array_keys( $option_array ) );
// Get old option value.
if ( ! isset( $update_options[ $option_name ] ) ) {
$update_options[ $option_name ] = get_option( $option_name, array() );
}
if ( ! is_array( $update_options[ $option_name ] ) ) {
$update_options[ $option_name ] = array();
}
// Set keys and value.
$key = key( $option_array[ $option_name ] );
$update_options[ $option_name ][ $key ] = $option_value;
} else {
$update_options[ $field['id'] ] = $option_value;
}
}
/**
* Action run prior to the update of a LifterLMS setting field option.
*
* An update isn't guaranteed after this action if the method's logic can't
* find a valid posted valued to persist to the database.
*
* @since Unknown
*
* @param array $field The admin setting field array to be updated.
*/
do_action( 'lifterlms_update_option', $field );
}
// Now save the options.
foreach ( $update_options as $name => $value ) {
update_option( $name, $value );
}
// phpcs:enable WordPress.Security.NonceVerification.Missing
return true;
}
/**
* Retrieves the posted value for an array type setting field.
*
* @since 7.0.0
*
* @param string $id The field ID, eg: "my_setting[field_one]".
* @return string Returns the (sanitized) posted value or an empty string if it wasn't posted.
*/
private static function get_array_field_posted_value( $id ) {
parse_str( $id, $parsed_id );
$opt_id = key( $parsed_id );
$opt_key = key( $parsed_id[ $opt_id ] );
$posted = llms_filter_input_sanitize_string( INPUT_POST, $opt_id, array( FILTER_REQUIRE_ARRAY ) );
return $posted[ $opt_key ] ?? '';
}
}
================================================
FILE: includes/admin/class.llms.admin.setup.wizard.php
================================================
<?php
/**
* Display a Setup Wizard
*
* @package LifterLMS/Admin/Classes
*
* @since 3.0.0
* @version 7.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Display a Setup Wizard class.
*
* @since 3.0.0
* @since 3.30.3 Fixed spelling error.
* @since 3.35.0 Sanitize input data.
* @since 3.37.14 Ensure redirect to the imported course when a course is imported at setup completion.
* @since 4.4.4 Method `LLMS_Admin_Setup_Wizard::scripts()` & `LLMS_Admin_Setup_Wizard::output_step_html()` are deprecated with no replacements.
* @since 4.8.0 Removed private class property "generated_course_id".
* @since 6.0.0 Removed deprecated items.
* - `LLMS_Admin_Setup_Wizard::generator_course_status()` method
* - `LLMS_Admin_Setup_Wizard::output_step_html()` method
* - `LLMS_Admin_Setup_Wizard::scripts()` method
* - `LLMS_Admin_Setup_Wizard::watch_course_generation()` method
* @since 7.4.0 Abstracted: {@see LLMS_Abstract_Admin_Wizard}.
*/
class LLMS_Admin_Setup_Wizard extends LLMS_Abstract_Admin_Wizard {
/**
* Configure wizard.
*
* @since 3.0.0
* @since 4.4.4 Remove output of inline scripts.
* @since 7.4.0
*
* @return void
*/
public function __construct() {
$this->id = 'setup';
$this->views_dir = LLMS_PLUGIN_DIR . 'includes/admin/views/setup-wizard/';
$this->title = esc_html__( 'LifterLMS Setup Wizard', 'lifterlms' );
$this->steps = array(
'intro' => array(
'title' => esc_html__( 'Welcome!', 'lifterlms' ),
'save' => esc_html__( 'Save & Continue', 'lifterlms' ),
'skip' => esc_html__( 'Skip this step', 'lifterlms' ),
),
'pages' => array(
'title' => esc_html__( 'Page Setup', 'lifterlms' ),
'save' => esc_html__( 'Save & Continue', 'lifterlms' ),
'skip' => esc_html__( 'Skip this step', 'lifterlms' ),
),
'payments' => array(
'title' => esc_html__( 'Payments', 'lifterlms' ),
'save' => esc_html__( 'Save & Continue', 'lifterlms' ),
'skip' => esc_html__( 'Skip this step', 'lifterlms' ),
),
'coupon' => array(
'title' => esc_html__( 'Coupon', 'lifterlms' ),
'save' => esc_html__( 'Allow', 'lifterlms' ),
'skip' => esc_html__( 'No thanks', 'lifterlms' ),
),
'finish' => array(
'title' => esc_html__( 'Finish!', 'lifterlms' ),
'save' => esc_html__( 'Import Courses', 'lifterlms' ),
'skip' => esc_html__( 'Skip this step', 'lifterlms' ),
),
);
$this->add_hooks();
// Add HTML around importable courses on last step.
add_action( 'llms_before_importable_course', array( $this, 'output_before_importable_course' ) );
add_action( 'llms_after_importable_course', array( $this, 'output_after_importable_course' ) );
// Hide action buttons on importable courses during last step.
add_filter( 'llms_importable_course_show_action', '__return_false' );
// Enqueue importer styles.
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_importer' ) );
}
/**
* Enqueue importer styles.
*
* @since 7.4.0
*
* @return bool
*/
public function enqueue_importer(): bool {
if ( 'finish' === $this->get_current_step() ) {
return llms()->assets->enqueue_style( 'llms-admin-importer' );
}
return false;
}
/**
* Output HTML prior to each importable course
*
* Adds an opening label wrapper and adds HTML data to turn the element into a toggleable form element.
*
* @since 4.8.0
*
* @param array $course Importable course data array.
* @return void
*/
public function output_before_importable_course( array $course ): void {
$id = absint( $course['id'] ?? null );
?>
<label>
<div class="llms-switch">
<input class="llms-toggle llms-toggle-round" id="llms-setup-import-course-<?php echo esc_attr( $id ); ?>" name="llms_setup_course_import_ids[]" value="<?php echo esc_attr( $id ); ?>" type="checkbox">
<label for="llms-setup-import-course-<?php echo esc_attr( $id ); ?>"><span class="screen-reader-text"><?php esc_attr_e( 'Toggle to import course', 'lifterlms' ); ?>
</label>
</div>
<?php
}
/**
* Output HTML after to each importable course
*
* Closes the label element opened in `output_before_importable_course()`.
*
* @since 4.8.0
*
* @param array $course Importable course data array.
* @return void
*/
public function output_after_importable_course( array $course ): void {
echo '</label>';
}
/**
* Retrieve the redirect URL to use after an import is complete at the conclusion of the wizard.
*
* If a single course is imported, redirects to that course's edit page, otherwise redirects
* to the course post table list sorted by created date with the most recent courses first.
*
* @since 7.4.0
*
* @param int[] $course_ids WP_Post IDs of the course(s) generated during the import.
* @return string
*/
protected function get_completed_url( array $course_ids ): string {
$count = count( $course_ids );
if ( 1 === $count ) {
return get_edit_post_link( $course_ids[0], 'not-display' ) ?? '';
}
return admin_url( 'edit.php?post_type=course&orderby=date&order=desc' );
}
/**
* Save the "Coupon" step
*
* @since 4.8.0
*
* @return WP_Error|boolean Returns `true` on success otherwise returns a WP_Error.
*/
protected function save_coupon() {
update_option( 'llms_allow_tracking', 'yes' );
$req = LLMS_Tracker::send_data( true );
$ret = new WP_Error( 'llms-setup-coupon-save-unknown', esc_html__( 'There was an error saving your data, please try again.', 'lifterlms' ) );
if ( is_wp_error( $req ) ) {
$ret = $req;
} elseif ( empty( $req['success'] ) && isset( $req['message'] ) ) {
$ret = new WP_Error( 'llms-setup-coupon-save-tracking-api', $req['message'] );
} elseif ( ! empty( $req['success'] ) && true === $req['success'] ) {
$ret = true;
}
return $ret;
}
/**
* Save the "Pages" creation step
*
* @since 4.8.0
*
* @return WP_Error|boolean Returns `true` on success otherwise returns a WP_Error.
*/
protected function save_pages() {
return LLMS_Install::create_pages() ? true : new WP_Error( 'llms-setup-pages-save', esc_html__( 'There was an error saving your data, please try again.', 'lifterlms' ) );
}
/**
* Save the "Payments" step.
*
* @since 4.8.0
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return bool Always returns true.
*/
protected function save_payments(): bool {
// phpcs:disable WordPress.Security.NonceVerification.Missing -- nonce is verified in `save()`.
$country = isset( $_POST['country'] ) ? llms_filter_input_sanitize_string( INPUT_POST, 'country' ) : get_lifterlms_country();
update_option( 'lifterlms_country', $country );
$currency = isset( $_POST['currency'] ) ? llms_filter_input_sanitize_string( INPUT_POST, 'currency' ) : get_lifterlms_currency();
update_option( 'lifterlms_currency', $currency );
$manual = isset( $_POST['manual_payments'] ) ? llms_filter_input_sanitize_string( INPUT_POST, 'manual_payments' ) : 'no';
update_option( 'llms_gateway_manual_enabled', $manual );
// phpcs:enable WordPress.Security.NonceVerification.Missing
return true;
}
/**
* Save the "Finish" step.
*
* @since 4.8.0
*
* @return WP_Error|int[]|bool Returns an array of generated WP_Post IDs on success, `false` when no import IDs are posted, otherwise returns a WP_Error.
*/
protected function save_finish() {
$ids = (array) llms_filter_input( INPUT_POST, 'llms_setup_course_import_ids', FILTER_DEFAULT, FILTER_FORCE_ARRAY );
$ids = array_filter( array_map( 'absint', $ids ) );
if ( ! $ids ) {
return false;
}
$res = LLMS_Export_API::get( $ids );
if ( is_wp_error( $res ) ) {
return $res;
}
$gen = new LLMS_Generator( $res );
$gen->set_generator();
$gen->generate();
if ( $gen->is_error() ) {
return $gen->get_results();
}
return $gen->get_generated_courses();
}
}
function llms_load_admin_setup_wizard() {
return new LLMS_Admin_Setup_Wizard();
}
add_action( 'init', 'llms_load_admin_setup_wizard' );
================================================
FILE: includes/admin/class.llms.admin.system-report.php
================================================
<?php
/**
* Admin System Report
*
* @package LifterLMS/Admin/Classes
*
* @since 2.1.0
* @version 7.1.1
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin System Report Class.
*
* @since 2.1.0
*/
class LLMS_Admin_System_Report {
/**
* Output the system report
*
* @since 2.1.0
* @since 3.0.0 Unknown.
*
* @return void
*/
public static function output() {
echo '<div class="wrap lifterlms">';
self::output_copy_box();
foreach ( LLMS_Data::get_data( 'system_report' ) as $key => $data ) {
if ( is_array( $data ) ) {
self::output_section( $key, $data );
}
}
echo '</div>';
}
/**
* Output the copy for support box.
*
* @since 2.1.0
* @since 3.11.2 Unknown.
* @since 7.1.0 Style and HTML structure update.
* @since 7.1.1 Use the right CSS selector to target the elements to include into the system's report copy.
*
* @return void
*/
public static function output_copy_box() {
?>
<div class="llms-setting-group top">
<p class="llms-label"><?php esc_html_e( 'Support', 'lifterlms' ); ?></p>
<div id="llms-debug-report">
<textarea style="display:none;width: 100%" rows="12" readonly="readonly"></textarea>
<p class="submit">
<button id="copy-for-support" class="llms-button-primary"><?php esc_html_e( 'Copy for Support', 'lifterlms' ); ?></button>
<a class="llms-button-secondary" href="https://lifterlms.com/my-account/my-tickets/?utm_source=LifterLMS%20Plugin&utm_medium=System%20Report&utm_campaign=Get%20Help&utm_content=button001" target="_blank"><?php esc_html_e( 'Get Help', 'lifterlms' ); ?></a>
</p>
</div>
</div>
<script>
jQuery( document ).ready( function( $ ) {
var $textarea = $( '#llms-debug-report textarea' );
$( '.llms-setting-group' ).each( function( index, element ) {
var title = $( this ).find( '.llms-label' ).text();
title = title + '\n' + '-------------------------------------------';
var val = $( this ).find( 'li' ).text().replace(/ /g, '').replace(/\t/g, '').replace(/\n\n/g, '\n');
$textarea.val( $textarea.val() + title + '\n' + val + '\n\n' );
} );
$( '#copy-for-support' ).on( 'click', function() {
$textarea.show().select();
try {
if ( ! document.execCommand( 'copy' ) ) {
throw 'Not allowed.';
}
} catch( e ) {
alert( 'copy the text below' );
}
} );
$textarea.on( 'click', function() {
$( this ).select();
} );
});
</script>
<?php
}
/**
* Output a section of data in the system report
*
* @since 3.0.0
* @since 3.11.2 Unknown.
* @since 4.13.0 Don't strip underscores when outputting the constant keys.
* @since 7.1.0 Style and HTML structure update.
*
* @param string $section_title Title / key of the section.
* @param arry $data Array of data for the section.
* @return void
*/
public static function output_section( $section_title, $data ) {
if ( 'plugins' === $section_title ) {
$data = $data['active'];
}
?>
<div class="llms-setting-group">
<p class="llms-label"><?php echo esc_html( self::title( $section_title ) ); ?></p>
<div class="llms-list">
<ul>
<?php foreach ( $data as $key => $val ) : ?>
<li><p>
<?php if ( 'plugins' === $section_title ) : ?>
<?php self::plugin_item( $val ); ?>
<?php elseif ( 'template_overrides' === $section_title ) : ?>
<?php self::template_item( $val ); ?>
<?php else : ?>
<?php echo 'constants' === $section_title ? esc_html( $key ) : esc_html( self::title( $key ) ); ?>: <strong><?php echo esc_html( self::value( $val ) ); ?></strong>
<?php endif; ?>
</p></li>
<?php endforeach; ?>
</ul>
</div>
</div>
<?php
}
/**
* Output data related to an active plugin in the system report
*
* @since 3.0.0
*
* @param array $data Array of plugin data.
* @return void
*/
private static function plugin_item( $data ) {
?>
<a href="<?php echo esc_url( $data['PluginURI'] ); ?>"><?php echo esc_html( $data['Name'] ); ?></a>: <strong><?php echo esc_html( $data['Version'] ); ?></strong>
<?php
}
/**
* Output data related to an overridden template system report
*
* @param array $data Array of template data.
* @return void
* @since 3.11.2
* @version 3.11.2
*/
private static function template_item( $data ) {
echo '<strong>' . esc_html( $data['template'] ) . ' (ver: ' . esc_html( $data['core_version'] ) . ')</strong>: ';
echo '<code>' . esc_html( $data['location'] ) . '</code> (ver: ' . esc_html( $data['version'] ) . ')';
}
/**
* Return the title for an item in the system report.
*
* @since 3.0.0
* @since 7.1.0 Fixed misspelled WordPress.
* @since 7.7.0 Return the title.
*
* @param string $key Title.
* @return string
*/
private static function title( $key ) {
$key = ucwords( str_replace( '_', ' ', $key ) );
// Fix for capital P.
if ( 'Wordpress' === $key ) { // phpcs:ignore
$key = 'WordPress';
}
return $key;
}
/**
* Return the value of an item in the system report
*
* @since 3.0.0
* @since 7.7.0 Return the value.
*
* @param string $val Value.
* @return string
*/
private static function value( $val ) {
return $val;
}
}
================================================
FILE: includes/admin/class.llms.admin.user.custom.fields.php
================================================
<?php
/**
* LLMS_Admin_User_Custom_Fields class file
*
* @package LifterLMS/Admin/Classes
*
* @since 2.7.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Add custom user fields to user admin panel screens
*
* Applies to edit-user.php, user-new.php, & profile.php.
*
* @since 2.7.0
* @since 3.35.0 Sanitize input data.
* @since 3.37.15 Fix error encountered when errors encountered validating custom fields.
*/
class LLMS_Admin_User_Custom_Fields {
private $fields = array();
/**
* Constructor
*
* @since 2.7.0
* @since 3.13.0 Unknown.
* @since 4.14.0 Add personal options hook.
* @since 5.0.0 Custom fields (legacy), are now printed with priority 11 instead of 10.
* @return void
*/
public function __construct() {
// Output custom fields on edit screens.
$field_actions = array(
'show_user_profile',
'edit_user_profile',
'user_new_form',
);
foreach ( $field_actions as $action ) {
add_action( $action, array( $this, 'output_custom_fields' ), 11, 1 );
add_action( $action, array( $this, 'output_instructors_assistant_fields' ), 10, 1 );
}
// Allow errors to be output before saving field data.
// Save the data if no errors are encountered.
add_action( 'user_profile_update_errors', array( $this, 'add_errors' ), 10, 3 );
// Save data when a new user is created.
add_action( 'edit_user_created_user', array( $this, 'save' ) );
// Add personal options.
add_action( 'personal_options', array( $this, 'output_personal_options' ) );
}
/**
* Validate custom fields
*
* During updates will save data, creation is saved during a different action.
*
* @since 2.7.0
* @since 3.13.0 Unknown.
* @since 3.37.15 Correctly pass `$user` to `$this->save()`.
*
* @param obj $errors Instance of WP_Error, passed by reference.
* @param bool $update `true` if updating a profile, `false` if a new user.
* @param WP_User $user Instance of WP_User for the user being updated.
* @return void
*/
public function add_errors( &$errors, $update, $user ) {
$this->get_fields();
$error = $this->validate_fields( $user );
if ( $error ) {
$errors->add( '', $error, '' );
if ( $update ) {
$this->save( $user );
}
// Don't save.
remove_action( 'edit_user_created_user', array( $this, 'save' ) );
return;
}
// If updating, save here since there's no other save specific admin action (that I could find).
if ( $update ) {
$this->save( $user );
}
}
/**
* Retrieve an associative array of custom fields and custom field data
*
* @since 2.7.0
* @since 3.13.0 Unknown.
* @since 5.0.0 Removed LLMS core fields and deprecate the filter usage.
*
* @return array
*/
public function get_fields() {
$this->fields = apply_filters_deprecated(
'lifterlms_get_user_custom_fields',
array(
array(),
),
'5.0.0',
'llms_admin_profile_fields'
);
return $this->fields;
}
/**
* Load usermeta data into the array of fields retrieved from $this->get_fields
*
* Meta data is added to the array under the key "value" for each field.
*
* If no data is found for a particular field the value is still added as an empty string.
*
* @since 2.7.0
*
* @param WP_User|int $user Instance of WP_User or WP User ID
* @return array
*/
public function get_fields_with_data( $user ) {
if ( is_numeric( $user ) ) {
$user = new WP_User( $user );
}
$this->get_fields();
foreach ( $this->fields as $field => $data ) {
$this->fields[ $field ]['value'] = apply_filters( 'lifterlms_get_user_custom_field_value_' . $field, $user->get( $field ), $user, $field );
}
return $this->fields;
}
/**
* Output custom field data fields as HTML inputs
*
* @since 2.7.0
* @since 3.24.0 Unknown.
* @since 5.0.0 Do not include user-edit template if no fields to show.
*
* @param WP_User|int $user Instance of WP_User or WP User ID.
* @return void
*/
public function output_custom_fields( $user ) {
if ( is_numeric( $user ) || is_a( $user, 'WP_User' ) ) {
$this->get_fields_with_data( $user );
} else {
$this->get_fields();
}
if ( empty( $this->fields ) ) {
return;
}
llms_get_template(
'admin/user-edit.php',
array(
'section_title' => __( 'LifterLMS Profile (legacy fields)', 'lifterlms' ),
'fields' => $this->fields,
)
);
}
/**
* Output personal option fields
*
* Currently adds a single option row for controlling auto-save behavior on the course builder.
*
* @since 4.14.0
*
* @param WP_User $user Viewed user object.
* @return void
*/
public function output_personal_options( $user ) {
if ( ! user_can( $user, 'edit_courses' ) ) {
return;
}
$autosave = get_user_option( 'llms_builder_autosave', $user->ID );
$autosave = empty( $autosave ) ? 'no' : $autosave;
?>
<tr class="llms-builder-autosave llms-builder-autosave-wrap">
<th scope="row"><?php esc_html_e( 'Course Builder Autosave', 'lifterlms' ); ?></th>
<td>
<label for="llms_builder_autosave">
<input name="llms_builder_autosave" type="checkbox" id="llms_builder_autosave" value="yes"<?php checked( 'yes', $autosave ); ?>>
<?php esc_html_e( 'Automatically save changes when using the course builder', 'lifterlms' ); ?>
</label><br>
</td>
</tr>
<?php
}
/**
* Add instructor parent fields for use when creating instructor's assistants
*
* @since 3.13.0
* @since 3.23.0 Unknown.
* @since 3.37.15 Use strict comparisons.
*
* @param WP_User|int $user Instance of WP_User or WP User ID
* @return void
*/
public function output_instructors_assistant_fields( $user ) {
if ( is_numeric( $user ) || is_a( $user, 'WP_User' ) ) {
$instructor = llms_get_instructor( $user );
$selected = $instructor->get( 'parent_instructors' );
if ( empty( $selected ) && ! is_array( $selected ) ) {
$selected = array();
}
} else {
$selected = array( get_current_user_id() );
}
$selected = array_map( 'absint', $selected );
// Only let admins & lms managers select the parent for an instructor's assistant.
if ( current_user_can( 'manage_lifterlms' ) ) {
$users = get_users(
array(
'role__in' => array( 'administrator', 'lms_manager', 'instructor' ),
)
);
?>
<table class="form-table" id="llms-parent-instructors-table" style="display:none;">
<tr class="form-field">
<th scope="row"><label for="llms-parent-instructors"><?php esc_html_e( 'Parent Instructor(s)', 'lifterlms' ); ?></label></th>
<td>
<select class="regular-text" id="llms-parent-instructors" name="llms_parent_instructors[]" multiple="multiple">
<?php foreach ( $users as $user ) : ?>
<option value="<?php echo esc_attr( $user->ID ); ?>"<?php selected( in_array( $user->ID, $selected, true ) ); ?>>
<?php echo esc_html( $user->display_name ); ?>
</option>
<?php endforeach; ?>
</select>
</td>
</tr>
</table>
<?php
add_action( 'admin_print_footer_scripts', array( $this, 'output_instructors_assistant_scripts' ) );
} elseif ( 'add-new-user' === $user ) {
/**
* This will be the case for Instructors only:
*
* Show a hidden field with the current user's info
*
* When saving it will only save if the created user's role is instructor's assistant.
*/
echo '<input type="hidden" name="llms_parent_instructors[]" value="' . esc_attr( get_current_user_id() ) . '">';
}
}
/**
* Output JS to handle user interaction with the instructor's parent field
*
* Display custom field ONLY when creating/editing an instructor's assistant.
*
* @since 3.13.0
*
* @return void
*/
public function output_instructors_assistant_scripts() {
?>
<script>
( function( $ ) {
var $role = $( '#role' ),
$parent = $( '#llms-parent-instructors-table' );
$role.closest( '.form-table' ).after( $parent );
$role.on( 'change', function() {
if ( 'instructors_assistant' === $( this ).val() ) {
$parent.show();
} else {
$parent.hide();
}
} ).trigger( 'change' );
} )( jQuery );
</script>
<?php
}
/**
* Save custom field data for a user
*
* @since 3.13.0
* @since 3.35.0 Sanitize input data.
* @since 3.37.15 Use strict comparisons.
* @since 4.14.0 Save builder autosave personal options.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param WP_User|int|obj $user User object or id.
* @return void
*/
public function save( $user ) {
if ( is_numeric( $user ) ) {
// Numeric ID is passed in during creations.
$user = new WP_User( $user );
$action = 'create';
} elseif ( isset( $user->ID ) ) {
// An object that's not a WP_User gets passed in during updates.
$user = new WP_User( $user->ID );
$action = 'update';
}
// Saves custom fields.
foreach ( $this->fields as $field => $data ) {
$value = apply_filters( 'lifterlms_save_custom_user_field_' . $field, llms_filter_input_sanitize_string( INPUT_POST, $field ), $user, $field );
update_user_meta( $user->ID, $field, $value );
}
// Save instructor assistant's parent instructor.
if ( in_array( 'instructors_assistant', $user->roles, true ) && ! empty( $_POST['llms_parent_instructors'] ) ) { // phpcs:disable WordPress.Security.NonceVerification.Missing
$instructor = llms_get_instructor( $user );
$instructor->add_parent( llms_filter_input( INPUT_POST, 'llms_parent_instructors', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY ) );
}
// Save personal options.
if ( user_can( $user, 'edit_courses' ) && 'create' !== $action ) {
$autosave = empty( $_POST['llms_builder_autosave'] ) ? 'no' : 'yes';
update_user_meta( $user->ID, 'llms_builder_autosave', $autosave );
}
}
/**
* Validate custom fields
*
* By default only checks for valid as core fields don't have any special validation.
*
* If adding custom fields, hook into the action run after required validation
* to add special validation rules for your field.
*
* @since 2.7.0
*
* @param WP_User|int $user Instance of WP_User or WP User ID.
* @return string|bool `false` if no validation errors or the error message (as a sttring) if validation errors occurred.
*/
public function validate_fields( $user ) {
// Ensure there's no missing required fields.
foreach ( $this->fields as $field => $data ) {
// Return an error message for empty required fields.
if ( empty( $_POST[ $field ] ) && $data['required'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
return sprintf( __( 'Required field "%s" is missing.', 'lifterlms' ), $data['label'] );
} else {
/**
* Run custom validation against the field
*
* If filter function returns a truthy, validation will stop, fields will not be saved,
* and an error message will be displayed on screen.
*
* This should return `false` or a string which will be used as the error message.
*
* @since 2.7.0
*
* @param boolean $error_message The error message when validation issues are encountered. Return `false` when no validation issues.
* @param string $field Field id.
* @param WP_User|int $user Instance of WP_User or WP User ID.
*/
$error_msg = apply_filters( "lifterlms_validate_custom_user_field_{$field}", false, $field, $user );
if ( $error_msg ) {
return $error_msg;
}
}
}
return false;
}
}
return new LLMS_Admin_User_Custom_Fields();
================================================
FILE: includes/admin/class.llms.student.bulk.enroll.php
================================================
<?php
/**
* Bulk Enrollment
*
* @package LifterLMS/Admin/Classes
*
* @since 3.20.0
* @version 9.2.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Bulk Enrollment class
*
* @since 3.20.0
* @since 3.30.3 Explicitly define class properties.
* @since 9.2.3 Added CSRF protection via nonce verification on bulk enrollment.
*/
class LLMS_Student_Bulk_Enroll {
/**
* Admin notices
*
* @var string[]
* @since 3.19.4
*/
public $admin_notices = array();
/**
* Product (Course/Membership) ID
*
* @var int
*/
public $product_id = 0;
/**
* Product Post Title
*
* @var string
*/
public $product_title = '';
/**
* User IDs
*
* @var int
*/
public $user_ids = array();
/**
* Constructor
*
* @since 3.20.0
* @version 3.20.0
*/
public function __construct() {
// Hook into extra ui on users table to display product selection.
add_action( 'manage_users_extra_tablenav', array( $this, 'display_product_selection_for_bulk_users' ) );
// Hook into users table screen to process bulk enrollment.
add_action( 'admin_head-users.php', array( $this, 'maybe_enroll_users_in_product' ) );
// Display enrollment results as notices.
add_action( 'admin_notices', array( $this, 'display_notices' ) );
}
/**
* Displays ui for selecting product to bulk enroll users into
*
* @since 3.20.0
* @since 9.2.3 Added nonce field for CSRF protection.
*
* @param string $which Whether this is the 'top' or 'bottom' tablenav.
* @return void
*/
public function display_product_selection_for_bulk_users( $which ) {
if ( ! current_user_can( 'manage_lifterlms' ) ) {
return;
}
// The attributes need to be different for top and bottom of the table.
$id = 'bottom' === $which ? 'llms_bulk_enroll_product2' : 'llms_bulk_enroll_product';
$submit = 'bottom' === $which ? 'llms_bulk_enroll2' : 'llms_bulk_enroll';
?>
<div class="alignleft actions">
<label class="screen-reader-text" for="_llms_bulk_enroll_product">
<?php esc_html_e( 'Choose Course/Membership', 'lifterlms' ); ?>
</label>
<select id="<?php echo esc_attr( $id ); ?>" class="llms-posts-select2 llms-bulk-enroll-product" data-post-type="llms_membership,course" name="<?php echo esc_attr( $id ); ?>" style="min-width:200px;max-width:auto;">
</select>
<input type="submit" name="<?php echo esc_attr( $submit ); ?>" id="<?php echo esc_attr( $submit ); ?>" class="button" value="<?php esc_attr_e( 'Enroll', 'lifterlms' ); ?>">
<?php if ( 'top' === $which ) : ?>
<?php wp_nonce_field( 'llms_bulk_enroll', '_llms_bulk_enroll_nonce', false ); ?>
<?php endif; ?>
</div>
<?php
}
/**
* Conditionally enrolls multiple users into a product
*
* @since 3.20.0
* @since 9.2.3 Added nonce verification for CSRF protection.
*
* @return void
*/
public function maybe_enroll_users_in_product() {
// Verify bulk enrollment request.
$do_bulk_enroll = $this->_bottom_else_top( 'llms_bulk_enroll' );
// Bail if this is not a bulk enrollment request.
if ( empty( $do_bulk_enroll ) ) {
return;
}
check_admin_referer( 'llms_bulk_enroll', '_llms_bulk_enroll_nonce' );
// Get the product (course/membership) to enroll users in.
$this->product_id = $this->_bottom_else_top( 'llms_bulk_enroll_product', FILTER_VALIDATE_INT );
if ( empty( $this->product_id ) ) {
$message = __( 'Please select a Course or Membership to enroll users into!', 'lifterlms' );
$this->generate_notice( 'error', $message );
return;
}
if ( ! current_user_can( 'enroll', $this->product_id ) ) {
$message = __( 'You do not have permission to enroll users into this course or membership.', 'lifterlms' );
$this->generate_notice( 'error', $message );
return;
}
// Get the product title for notices.
$this->product_title = get_the_title( $this->product_id );
// Get all the user ids to enroll.
$this->user_ids = filter_input( INPUT_GET, 'users', FILTER_DEFAULT, FILTER_REQUIRE_ARRAY );
if ( empty( $this->user_ids ) ) {
$message = sprintf( __( 'Please select users to enroll into <em>%s</em>.', 'lifterlms' ), $this->product_title );
$this->generate_notice( 'error', $message );
return;
}
$this->enroll_users_in_product();
}
/**
* Retrieves submitted inputs
*
* @param string $param The input key
* @param mixed $validation Validation filter constant
* @return mixed The submitted input value
* @since 3.20.0
* @version 3.20.0
*/
private function _bottom_else_top( $param, $validation = FILTER_DEFAULT ) {
$return_val = false;
// Get the value of the input displayed at the bottom of users table.
$bottom_value = filter_input( INPUT_GET, $param . '2', $validation );
// Get the value of input displayed at the top of users table.
$top_value = filter_input( INPUT_GET, $param, $validation );
// Prefer top over bottom, just like WordPress does.
if ( ! empty( $bottom_value ) ) {
$return_val = $bottom_value;
}
if ( ! empty( $top_value ) ) {
$return_val = $top_value;
}
return $return_val;
}
/**
* Enrolls multiple users into a product
*
* @since 3.20.0
* @version 3.20.0
*/
private function enroll_users_in_product() {
// Get user information from user ids.
$users = $this->get_users( $this->user_ids );
// Bail if for some reason, no users are found (because they were deleted in the bg?).
if ( empty( $users ) ) {
$message = sprintf( __( 'No such users found. Cannot enroll into <em>%s</em>.', 'lifterlms' ), $this->product_title );
$this->generate_notice( 'error', $message );
return;
}
// Create manual enrollment trigger.
$trigger = 'admin_' . get_current_user_id();
foreach ( $users as $user ) {
$this->enroll( $user, $trigger );
}
}
/**
* Get user details from user IDs
* @param array $user_ids WP user IDs
* @return array User details
* @since 3.20.0
* @version 3.21.0
*/
private function get_users( $user_ids ) {
// Prepare query arguments.
$user_query_args = array(
'include' => $user_ids,
// We need display names for notices.
'fields' => array( 'ID', 'display_name' ),
);
$user_query = new WP_User_Query( $user_query_args );
$results = $user_query->get_results();
return empty( $results ) ? false : $results;
}
/**
* Enrolls a user into the selected product
*
* @param WP_User $user User object
* @param string $trigger Enrollment trigger string
* @since 3.20.0
* @version 3.20.0
*/
private function enroll( $user, $trigger ) {
// Enroll into LifterLMS product.
$enrolled = llms_enroll_student( $user->ID, $this->product_id, $trigger );
// Figure out notice type based on enrollment success.
$type = ( ! $enrolled ) ? 'error' : 'success';
// Figure out notice message string based on notice type.
$success_fail_string = ( ! $enrolled ) ? __( 'Failed to enroll <em>%1$1s</em> into <em>%2$2s</em>.', 'lifterlms' ) : __( 'Successfully enrolled <em>%1$1s</em> into <em>%2$2s</em>.', 'lifterlms' );
// Get formatted message with username and product title.
$message = sprintf( $success_fail_string, $user->display_name, $this->product_title );
// Generate a notice for display.
$this->generate_notice( $type, $message );
}
/**
* Generates admin notice markup
*
* @param string $type Type of notice 'error' or 'success'
* @param string $message Notice message
* @since 3.20.0
* @version 3.20.0
*/
public function generate_notice( $type, $message ) {
ob_start();
?>
<div class="notice notice-<?php echo esc_attr( $type ); ?> is-dismissible">
<p><?php echo wp_kses_post( $message ); ?></p>
</div>
<?php
$notice = ob_get_clean();
$this->admin_notices[] = $notice;
}
/**
* Displays all generated notices
*
* @return void
* @since 3.20.0
* @version 3.20.0
*/
public function display_notices() {
if ( empty( $this->admin_notices ) ) {
return;
}
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Notices are escaped in generate_notice().
echo implode( "\n", $this->admin_notices );
}
}
return new LLMS_Student_Bulk_Enroll();
================================================
FILE: includes/admin/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/llms.functions.admin.php
================================================
<?php
/**
* Core functions used exclusively on the admin panel
*
* @package LifterLMS/Admin/Functions
*
* @since 3.0.0
* @version 7.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Create a Page & save it's id as an option.
*
* @since 3.0.0
* @since 3.7.5 Unknown.
* @since 7.3.0 Strip all tags from the page title, slash the page data prior to inserting the page in the db via `wp_insert_post`.
* Prefer strict type comparison when using `in_array()`.
*
* @param string $slug Page slug.
* @param string $title Page title.
* @param string $content Page content
* @param string $option Option name.
* @return int Page id.
*/
function llms_create_page( $slug, $title = '', $content = '', $option = '' ) {
$option_val = get_option( $option );
// See if there's a valid page already stored for the option we're trying to create.
if ( $option_val && is_numeric( $option_val ) ) {
$page_object = get_post( $option_val );
if ( $page_object && 'page' === $page_object->post_type &&
! in_array( $page_object->post_status, array( 'pending', 'trash', 'future', 'auto-draft' ), true ) ) {
return $page_object->ID;
}
}
global $wpdb;
// Search for an existing page with the specified page content like a shortcode.
if ( strlen( $content ) > 0 ) {
$page_id = $wpdb->get_var(
$wpdb->prepare(
"SELECT ID FROM $wpdb->posts WHERE post_type='page' AND post_status NOT IN ( 'pending', 'trash', 'future', 'auto-draft' ) AND post_content LIKE %s LIMIT 1;",
"%{$content}%"
)
);// no-cache ok.
} else {
$page_id = $wpdb->get_var(
$wpdb->prepare(
"SELECT ID FROM $wpdb->posts WHERE post_type='page' AND post_status NOT IN ( 'pending', 'trash', 'future', 'auto-draft' ) AND post_name = %s LIMIT 1;",
$slug
)
);// no-cache ok.
}
/**
* Filters the ID of the page to be created.
*
* @since 3.0.0
*
* @param int $page_id The WP_Post ID of the page.
* @param string $slug The page slug.
* @param string $content THe content of the page.
*/
$page_id = apply_filters( 'llms_create_page_id', $page_id, $slug, $content );
if ( $page_id ) {
if ( $option ) {
update_option( $option, $page_id );
}
return $page_id;
}
// Look in the trashed page by content.
if ( strlen( $content ) > 0 ) {
$trashed_id = $wpdb->get_var(
$wpdb->prepare(
"SELECT ID FROM $wpdb->posts WHERE post_type='page' AND post_status = 'trash' AND post_content LIKE %s LIMIT 1;",
"%{$content}%"
)
);// no-cache ok.
} else {
$trashed_id = $wpdb->get_var(
$wpdb->prepare(
"SELECT ID FROM $wpdb->posts WHERE post_type='page' AND post_status = 'trash' AND post_name = %s LIMIT 1;",
$slug
)
);// no-cache ok.
}
// If we find it in the trash move it out of the trash.
if ( $trashed_id ) {
$page_id = $trashed_id;
$page_data = array(
'ID' => $page_id,
'post_status' => 'publish',
);
wp_update_post( $page_data );
} else {
$page_data = array(
'post_status' => 'publish',
'post_type' => 'page',
'post_author' => get_current_user_id() ? get_current_user_id() : 1,
'post_name' => $slug,
'post_title' => wp_strip_all_tags( $title ),
'post_content' => $content,
'comment_status' => 'closed',
);
$page_id = wp_insert_post(
wp_slash(
/**
* Filters the page data passed to create a page.
*
* The output of this filter will be slashed via `wp_slash` prior
* to being passed to `wp_insert_post` to prevent slashes from
* being stripped from the page title.
*
* @since 3.0.0
*
* @param array $page_data Array of page data.
*/
apply_filters( 'llms_create_page', $page_data )
)
);
}
if ( $option ) {
update_option( $option, $page_id );
}
return $page_id;
}
/**
* Retrieve available products from the LifterLMS.com API
*
* @since 3.22.0
*
* @return array {
* Array of LifterLMS add-on data from the LifterLMS.com products api.
*
* @type array $categories Associative array of add-on category information, mapping ID to Title.
* @type array[] $items List of add-ons definition arrays.
* }
*/
function llms_get_add_ons( $use_cache = true ) {
$data = $use_cache ? get_transient( 'llms_products_api_result' ) : false;
if ( false === $data ) {
$req = new LLMS_Dot_Com_API( '/products', array(), 'GET' );
$data = $req->get_result();
if ( $req->is_error() ) {
return $data;
}
set_transient( 'llms_products_api_result', $data, DAY_IN_SECONDS );
}
return $data;
}
/**
* Instantiate a new LLMS_Add_On object
*
* @since 3.22.0
*
* @param string|array $addon Add-on data array or a string (such as an ID or update file path) used to lookup the addon.
* @param string $lookup_key If $addon is a string, this determines how to lookup the addon from the available list of addons.
* @return LLMS_Add_On|LLMS_Helper_Add_On
*/
function llms_get_add_on( $addon = array(), $lookup_key = 'id' ) {
if ( class_exists( 'LLMS_Helper_Add_On' ) ) {
return new LLMS_Helper_Add_On( $addon, $lookup_key );
}
return new LLMS_Add_On( $addon, $lookup_key );
}
/**
* Retrieves HTML for a Dashicon wrapped in an anchor.
*
* A utility for adding links to external documentation.
*
* @since 7.0.0
*
* @param string $url The URL of the anchor tag.
* @param array $args {
* An array of optional configuration options.
*
* @type integer $size The size of the icon. Default 18.
* @type string $title The title attribute of the anchor tag. Default: "More information".
* @type string $icon The Dashicon icon to use, {@see @link https://developer.wordpress.org/resource/dashicons/}. Default: "external".
* }
* @return string
*/
function llms_get_dashicon_link( $url, $args = array() ) {
$args = wp_parse_args(
$args,
array(
'size' => 18,
'title' => esc_attr__( 'More information', 'lifterlms' ),
'icon' => 'external',
)
);
$dashicon = sprintf(
'<span class="dashicons dashicons-%1$s" style="font-size:%2$dpx;width:%2$dpx;height:%2$dpx"></span>',
esc_attr( $args['icon'] ),
$args['size']
);
return sprintf(
'<a href="%1$s" style="text-decoration:none;" target="_blank" rel="noreferrer" title="%2$s">%3$s</a>',
esc_url( $url ),
esc_attr( $args['title'] ),
$dashicon
);
}
/**
* Get an array of available course/membership sales page options
*
* @return array
* @since 3.23.0
* @version 3.23.0
*/
function llms_get_sales_page_types() {
return apply_filters(
'llms_sales_page_types',
array(
'none' => __( 'Display default course content', 'lifterlms' ),
'content' => __( 'Show custom content', 'lifterlms' ),
'page' => __( 'Redirect to WordPress Page', 'lifterlms' ),
'url' => __( 'Redirect to custom URL', 'lifterlms' ),
)
);
}
/**
* Get an array of available course/membership checkout redirection options
*
* @since 3.30.0
* @version 3.30.0
*
* @param string $product_type The product type, Course or Membership
* @return array
*/
function llms_get_checkout_redirection_types( $product_type = '' ) {
$product_type = empty( $product_type ) ? __( 'Course/Membership', 'lifterlms' ) : $product_type;
return apply_filters(
'llms_checkout_redirection_types',
array(
'self' => sprintf( __( '(Default) Return to %s', 'lifterlms' ), $product_type ),
'page' => __( 'Redirect to a WordPress Page', 'lifterlms' ),
'url' => __( 'Redirect to a custom URL', 'lifterlms' ),
)
);
}
/**
* Add a "merge code" button that to auto-add merge codes to email & etc...
*
* @since 3.1.0
* @since 3.17.4 Unknown.
* @since 6.0.0 Move HTML into view file: `includes/admin/views/merge-code-editor-button.php`.
* Move certificate merge code list to `llms_get_certificate_merge_codes()`.
*
* @param string $target Target to add the merge code to. Accepts the ID of a tinymce editor or a DOM ID (#element-id).
* @param boolean $echo If `true`, echos the HTML output.
* @param array $codes Optional array of custom codes to pass in, otherwise the codes are determined
* what is available for the post type.
* @return string Returns the HTML for the merge code button.
*/
function llms_merge_code_button( $target = 'content', $echo = true, $codes = array() ) {
$screen = get_current_screen();
if ( ! $codes && $screen && isset( $screen->post_type ) ) {
switch ( $screen->post_type ) {
case 'llms_certificate':
$codes = llms_get_certificate_merge_codes();
break;
case 'llms_email':
$codes = array(
'{site_title}' => __( 'Website Title', 'lifterlms' ),
'{site_url}' => __( 'Website URL', 'lifterlms' ),
'{email_address}' => __( 'Student Email Address', 'lifterlms' ),
'{user_login}' => __( 'Student Username', 'lifterlms' ),
'{first_name}' => __( 'Student First Name', 'lifterlms' ),
'{last_name}' => __( 'Student Last Name', 'lifterlms' ),
'{current_date}' => __( 'Current Date', 'lifterlms' ),
);
break;
default:
$codes = array();
}
}
/**
* Filters the list of available merge codes in the specified context.
*
* @since Unknown
*
* @param array[] $codes Associative array of merge codes where the array key is the merge code and the array value is a name / description of the merge code.
* @param WP_Screen|null $screen The screen object from `get_current_screen().
* @param string $target Target to add the merge code to. Accepts the ID of a tinymce editor or a DOM ID (#element-id).
*/
$codes = apply_filters( 'llms_merge_codes_for_button', $codes, $screen, $target );
$html = '';
if ( $codes ) {
ob_start();
include LLMS_PLUGIN_DIR . 'includes/admin/views/merge-code-button.php';
$html = ob_get_clean();
}
if ( $echo ) {
// PHPCS ignore reason: Escaped in the view file.
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo $html;
}
return $html;
}
/**
* Retrieve the precision for round function for floating values.
*
* @since 7.1.3
*
* @return int
*/
function llms_get_floats_rounding_precision() {
// Used `static` to store precision value so `apply_filters()` run only once per request.
static $precision = null;
if ( is_null( $precision ) ) {
/**
* Filters the precision for round function for floating values.
*
* @since 7.1.3
*
* @param int $precision Precision for round function for floating values.
*/
$precision = apply_filters( 'lifterlms_floats_rounding_precision', 2 );
}
return $precision;
}
================================================
FILE: includes/admin/post-types/class.llms.meta.boxes.php
================================================
<?php
/**
* Admin base Metabox.
*
* @package LifterLMS/Admin/PostTypes/Classes
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Meta_Boxes class
*
* Sets up base metabox functionality and global save.
*
* @since 1.0.0
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
*/
class LLMS_Admin_Meta_Boxes {
/**
* Array of collected errors.
*
* @access public
* @var string
*/
private static $errors = array();
/**
* Constructor.
*
* @since 1.0.0
* @since 3.16.0 Unknown.
* @since 6.0.0 Instantiate award engagement submit meta box.
* Instantiate meta boxes to sync awarded certificates and achievements with their templates.
*
* @return void
*/
public function __construct() {
// Achievements.
new LLMS_Meta_Box_Achievement();
new LLMS_Meta_Box_Achievement_Sync();
// Certs.
new LLMS_Meta_Box_Certificate();
new LLMS_Meta_Box_Certificate_Sync();
// Emails.
new LLMS_Meta_Box_Email_Settings();
// Engagements.
new LLMS_Meta_Box_Engagement();
// Award Engagements.
new LLMS_Meta_Box_Award_Engagement_Submit();
// Membership restriction metabox.
new LLMS_Meta_Box_Access();
// Courses.
new LLMS_Meta_Box_Course_Options();
// Memberships.
new LLMS_Meta_Box_Membership();
// Courses & memberships.
require_once 'meta-boxes/class.llms.meta.box.course.builder.php';
require_once 'meta-boxes/class.llms.meta.box.visibility.php';
new LLMS_Meta_Box_Product();
new LLMS_Meta_Box_Students();
// Lessons.
require_once 'meta-boxes/class.llms.meta.box.lesson.php';
// Coupons.
new LLMS_Meta_Box_Coupon();
// Orders.
new LLMS_Meta_Box_Order_Submit();
new LLMS_Meta_Box_Order_Details();
new LLMS_Meta_Box_Order_Transactions();
new LLMS_Meta_Box_Order_Enrollment();
new LLMS_Meta_Box_Order_Notes();
// Vouchers.
new LLMS_Meta_Box_Voucher();
add_action( 'add_meta_boxes', array( $this, 'hide_meta_boxes' ), 10 );
add_action( 'add_meta_boxes', array( $this, 'refresh_meta_boxes' ), 10 );
add_action( 'add_meta_boxes', array( $this, 'get_meta_boxes' ), 10 );
add_action( 'save_post', array( $this, 'save_meta_boxes' ), 10, 2 );
add_action( 'lifterlms_process_llms_voucher_meta', 'LLMS_Meta_Box_Voucher_Export::export', 10, 2 );
// Error handling.
add_action( 'admin_notices', array( $this, 'display_errors' ) );
add_action( 'shutdown', array( $this, 'set_errors' ) );
// Modify the title placeholder text for achievement and certificate templates.
add_filter( 'enter_title_here', array( $this, 'maybe_modify_title_placeholder' ), 10, 2 );
// Add default image information for achievement and certificate templates.
add_filter( 'admin_post_thumbnail_html', array( $this, 'maybe_modify_post_thumbnail_html' ), 10, 3 );
}
/**
* Add error messages from metaboxes
*
* @param string $text
*/
public static function add_error( $text ) {
self::$errors[] = $text;
}
/**
* Save messages to the database
*/
public function set_errors() {
update_option( 'lifterlms_errors', self::$errors );
}
/**
* Display the messages in the error dialog box
*/
public function display_errors() {
$errors = get_option( 'lifterlms_errors' );
if ( empty( $errors ) ) {
return;
}
$errors = maybe_unserialize( $errors );
echo '<div id="lifterlms_errors" class="error"><p>';
foreach ( $errors as $error ) {
echo esc_html( $error );
}
echo '</p></div>';
delete_option( 'lifterlms_errors' );
}
/**
* Add Metaboxes
*
* @return void
* @since 1.0.0
* @version 3.16.0
*/
public function get_meta_boxes() {
add_action( 'media_buttons', 'llms_merge_code_button' );
/**
* @todo Transition to new style metaboxes.
*/
add_meta_box( 'lifterlms-voucher-export', __( 'Export CSV', 'lifterlms' ), 'LLMS_Meta_Box_Voucher_Export::output', 'llms_voucher', 'side', 'default' );
}
/**
* Remove Metaboxes
*
* @return void
* @since 3.4.0
* @version 3.13.0
*/
public function hide_meta_boxes() {
// Remove some defaults from orders.
remove_meta_box( 'commentstatusdiv', 'llms_order', 'normal' );
remove_meta_box( 'commentsdiv', 'llms_order', 'normal' );
remove_meta_box( 'slugdiv', 'llms_order', 'normal' );
// Remove the default submit box in favor of our custom box.
remove_meta_box( 'submitdiv', 'llms_order', 'side' );
// Remove some defaults from the course.
remove_meta_box( 'postexcerpt', 'course', 'normal' );
remove_meta_box( 'tagsdiv-course_difficulty', 'course', 'side' );
}
/**
* Modifies the featured image metabox for achievement and certificate templates.
*
* Displays the default image, text denoting that the default image is being used,
* and a link to the settings page where the default image can be changed.
*
* This additional content is only displayed when there's no featured image set
* for the template.
*
* @since 6.0.0
*
* @param string $content Default metabox HTML.
* @param int $post_id WP_Post ID of the post being edited.
* @param int $image_id Attachment ID for the saved featured image.
* @return string
*/
public function maybe_modify_post_thumbnail_html( $content, $post_id, $image_id ) {
$post_types = array(
'llms_achievement',
'llms_my_achievement',
'llms_certificate',
'llms_my_certificate',
);
$post_type = get_post_type( $post_id );
if ( ! $image_id && in_array( $post_type, $post_types, true ) ) {
$add_content = '';
$class = str_replace( array( 'llms_', 'my_' ), '', $post_type ) . 's';
$image_id = llms()->$class()->get_default_image_id();
$alt = $image_id ? get_post_meta( $image_id, '_wp_attachment_image_alt', true ) : __( 'Default image', 'lifterlms' );
$add_content = '<p><img alt="' . trim( wp_strip_all_tags( $alt ) ) . '" src="' . esc_url( llms()->$class()->get_default_image( $post_id ) ) . '" /></p>';
$settings_url = admin_url( 'admin.php?page=llms-settings&tab=engagements' );
$add_content .= '<p class="howto">' . __( 'Using the global default.', 'lifterlms' ) . ' <a href="' . esc_url( $settings_url ) . '">' . __( 'Edit', 'lifterlms' ) . '</a></p>';
$content = $add_content . $content;
}
return $content;
}
/**
* Modifies the placeholder text for the post title field.
*
* This is used to denote that the achievement and certificate template title fields
* are for internal use only to help avoid confusion as to why there are two separate
* titles.
*
* @since 6.0.0
*
* @param string $placeholder Default placeholder text.
* @param WP_Post $post Post object.
* @return string
*/
public function maybe_modify_title_placeholder( $placeholder, $post ) {
$post_types = array(
'llms_achievement',
'llms_certificate',
);
if ( in_array( $post->post_type, $post_types, true ) ) {
$placeholder = sprintf(
'%1$s (%2$s)',
$placeholder,
_x( 'for internal use only', 'added achievement and certificate template post title placeholder', 'lifterlms' )
);
}
return $placeholder;
}
/**
* Updates global $post variable
*
* @return void
*/
public function refresh_meta_boxes() {
global $post;
}
/**
* Validates post and metabox data before saving.
*
* @since Unknown
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
*
* @param int $post_id WP Post ID.
* @param WP_Post $post Post object.
* @return bool
*/
public function validate_post( $post_id, $post ) {
if ( ! current_user_can( 'edit_post', $post_id ) ) {
return false;
} elseif ( empty( $post_id ) || empty( $post ) ) {
return false;
} elseif ( defined( 'DOING_AUTOSAVE' ) || is_int( wp_is_post_revision( $post ) ) || is_int( wp_is_post_autosave( $post ) ) ) {
return false;
} elseif ( ! isset( $_REQUEST['lifterlms_meta_nonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_meta_nonce'] ) ), 'lifterlms_save_data' ) ) {
return false;
} elseif ( empty( $_POST['post_ID'] ) || $_POST['post_ID'] != $post_id ) {
return false;
}
return true;
}
/**
* Check whether the post is a LifterLMS post type.
*
* @since unknown
* @since 6.0.0 Added 'llms_my_achievement' and 'llms_my_certificate'.
*
* @param WP_Post $post WP_Post instance.
* @return boolean
*/
public function is_llms_post_type( $post ) {
$post_types = array(
'course',
'section',
'lesson',
'llms_order',
'llms_email',
'llms_certificate',
'llms_my_certificate',
'llms_achievement',
'llms_my_achievement',
'llms_engagement',
'llms_membership',
'llms_quiz',
'llms_question',
'llms_coupon',
'llms_voucher',
);
/**
* Filters the post type names that are secific of LifterLMS.
*
* Used to determine whether or not fire actions of the type "lifterlms_process_{$post->post_type}_meta" on save.
*
* @since 6.0.0
*
* @param string[] $post_types Array of post type names.
* @param WP_Post $post WP_Post instance.
*/
$post_types = apply_filters( 'llms_metaboxes_llms_post_types', $post_types, $post );
if ( in_array( $post->post_type, $post_types, true ) ) {
return true;
}
}
/**
* Global Metabox Save
*
* @return void
* @param $post, $post_id
*/
public function save_meta_boxes( $post_id, $post ) {
if ( self::validate_post( $post_id, $post ) ) {
if ( self::is_llms_post_type( $post ) ) {
do_action( 'lifterlms_process_' . $post->post_type . '_meta', $post_id, $post );
}
}
}
}
new LLMS_Admin_Meta_Boxes();
================================================
FILE: includes/admin/post-types/class.llms.post.tables.php
================================================
<?php
/**
* Post Table management for LifterLMS custom post types
*
* @package LifterLMS/Admin/PostTypes/Classes
*
* @since 3.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Post_Tables class.
*
* @since 3.0.0
* @since 3.13.0 Unknown.
* @since 3.33.1 Use `llms_filter_input`
* @since 3.33.1 Use specific caps (`edit_course`) instead of generic caps (`edit_post`) for exporting and cloning courses.
*/
class LLMS_Admin_Post_Tables {
/**
* Constructor
*
* @since 3.0.0
*/
public function __construct() {
// Load all post table classes.
foreach ( glob( LLMS_PLUGIN_DIR . '/includes/admin/post-types/post-tables/*.php' ) as $filename ) {
include_once $filename;
}
add_filter( 'post_row_actions', array( $this, 'add_links' ), 777, 2 );
add_action( 'admin_init', array( $this, 'handle_link_actions' ) );
}
/**
* Adds clone links to post types which support lifterlms post cloning
*
* @since 3.3.0
* @since 3.13.0 Unknown.
* @since 3.33.1 Use `edit_course` instead of `edit_post` when checking capabilities.
*
* @param array $actions Existing actions.
* @param WP_Post $post Post object.
* @return string[]
*/
public function add_links( $actions, $post ) {
if ( current_user_can( 'edit_course', $post->ID ) && post_type_supports( $post->post_type, 'llms-clone-post' ) ) {
$url = add_query_arg(
array(
'post_type' => $post->post_type,
'action' => 'llms-clone-post',
'post' => $post->ID,
),
admin_url( 'edit.php' )
);
$actions['llms-clone'] = '<a href="' . esc_url( wp_nonce_url( $url, 'llms_clone_post', 'llms_clone_post_nonce' ) ) . '">' . __( 'Clone', 'lifterlms' ) . '</a>';
}
if ( current_user_can( 'edit_course', $post->ID ) && post_type_supports( $post->post_type, 'llms-export-post' ) ) {
$url = add_query_arg(
array(
'post_type' => $post->post_type,
'action' => 'llms-export-post',
'post' => $post->ID,
),
admin_url( 'edit.php' )
);
$actions['llms-export'] = '<a href="' . esc_url( $url ) . '">' . __( 'Export', 'lifterlms' ) . '</a>';
}
if ( current_user_can( 'edit_course', $post->ID ) && post_type_supports( $post->post_type, 'llms-detach-post' ) ) {
$url = add_query_arg(
array(
'post_type' => $post->post_type,
'action' => 'llms-detach-post',
'post' => $post->ID,
),
admin_url( 'edit.php' )
);
$actions['llms-detach'] = '<a href="' . esc_url( wp_nonce_url( $url, 'llms_detach_post', 'llms_detach_post_nonce' ) ) . '">' . __( 'Detach', 'lifterlms' ) . '</a>';
}
return $actions;
}
/**
* Handle events for our custom postrow actions
*
* @since 3.3.0
* @since 3.33.1 Use `llms_filter_input` to access `$_GET` and `$_POST` data.
* @since 3.33.1 Use `edit_course` cap instead of `edit_post` cap.
* @since 7.5.1 Adding nonce to course clone links
*
* @return void
*/
public function handle_link_actions() {
$action = llms_filter_input( INPUT_GET, 'action' );
// Bail early if request doesn't concern us.
if ( empty( $action ) ) {
return;
}
// Bail early if it isn't a clone/ export request.
if ( 'llms-clone-post' !== $action && 'llms-export-post' !== $action && 'llms-detach-post' !== $action ) {
return;
}
$post_id = llms_filter_input( INPUT_GET, 'post' );
// Bail if there's no post ID.
if ( empty( $post_id ) ) {
wp_die( esc_html__( 'Missing post ID.', 'lifterlms' ) );
}
$post = get_post( $post_id );
// Bail if post ID is invalid.
if ( ! $post ) {
wp_die( esc_html__( 'Invalid post ID.', 'lifterlms' ) );
}
// Bail if the action isn't supported on post type.
if ( ! post_type_supports( $post->post_type, $action ) ) {
wp_die( esc_html__( 'Action cannot be executed on the current post.', 'lifterlms' ) );
}
// Bail if user doesn't have permissions.
if ( ! current_user_can( 'edit_course', $post->ID ) ) {
wp_die( esc_html__( 'You are not authorized to perform this action on the current post.', 'lifterlms' ) );
}
$post = llms_get_post( $post );
// Run export or clone action as needed.
switch ( $action ) {
case 'llms-export-post':
$post->export();
break;
case 'llms-detach-post':
if ( ! isset( $_GET['llms_detach_post_nonce'] ) || ! wp_verify_nonce( sanitize_key( $_GET['llms_detach_post_nonce'] ), 'llms_detach_post' ) ) {
wp_die( esc_html__( 'You are not authorized to perform this action on the current post.', 'lifterlms' ) );
}
$r = delete_post_meta( $post->id, '_llms_parent_section' ) && delete_post_meta( $post->id, '_llms_parent_course' );
if ( ! $r ) {
LLMS_Admin_Notices::flash_notice( esc_html__( 'There was an error detaching the post.', 'lifterlms' ), 'error' );
}
wp_safe_redirect( admin_url( 'edit.php?post_type=' . $post->get( 'type' ) ) );
exit;
case 'llms-clone-post':
if ( ! isset( $_GET['llms_clone_post_nonce'] ) || ! wp_verify_nonce( sanitize_key( $_GET['llms_clone_post_nonce'] ), 'llms_clone_post' ) ) {
wp_die( esc_html__( 'You are not authorized to perform this action on the current post.', 'lifterlms' ) );
}
$r = $post->clone_post();
if ( is_wp_error( $r ) ) {
LLMS_Admin_Notices::flash_notice( $r->get_error_message(), 'error' );
}
wp_safe_redirect( admin_url( 'edit.php?post_type=' . $post->get( 'type' ) ) );
exit;
}
}
/**
* Get the HTML for a post type select2 filter
*
* @since 3.12.0
* @since 6.0.0 Don't display a dynamic view post button.
*
* @param string $name Name of the select element.
* @param string $post_type Post type to search by.
* @param int[] $selected Array of POST IDs to use for the pre-selected options on page load.
* @return string
*/
public static function get_post_type_filter_html( $name, $post_type = 'course', $selected = array() ) {
$id = sprintf( 'filter-by-llms-post-%s', $post_type );
$obj = get_post_type_object( $post_type );
// Translators: %s = the singular post type name.
$label = sprintf( __( 'Filter by %s', 'lifterlms' ), $obj->labels->singular_name );
ob_start();
?>
<span class="llms-post-table-post-filter">
<label for="<?php echo esc_attr( $id ); ?>" class="screen-reader-text">
<?php echo esc_html( $label ); ?>
</label>
<select
class="llms-select2-post"
data-allow_clear="true"
data-no-view-button="true"
data-placeholder="<?php echo esc_attr( $label ); ?>"
data-post-type="<?php echo esc_attr( $post_type ); ?>"
name="<?php echo esc_attr( $name ); ?>"
id="<?php echo esc_attr( $id ); ?>"
>
<?php if ( $selected ) : ?>
<?php foreach ( llms_make_select2_post_array( $selected ) as $data ) : ?>
<option value="<?php echo esc_attr( $data['key'] ); ?>"><?php echo esc_html( $data['title'] ); ?></option>
<?php endforeach; ?>
<?php endif; ?>
</select>
</span>
<?php
return ob_get_clean();
}
}
return new LLMS_Admin_Post_Tables();
================================================
FILE: includes/admin/post-types/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/post-types/meta-boxes/class-llms-meta-box-achievement-sync.php
================================================
<?php
/**
* LLMS_Meta_Box_Achievement_Sync class
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Meta box to sync between awarded achievements and achievement templates.
*
* @since 6.0.0
*/
class LLMS_Meta_Box_Achievement_Sync extends LLMS_Abstract_Meta_Box_User_Engagement_Sync {
/**
* Type of user engagement.
*
* @since 6.0.0
*
* @var string
*/
protected $engagement_type = 'achievement';
/**
* The post type of an awarded engagement.
*
* @since 6.0.0
*
* @var string
*/
protected $post_type_awarded = 'llms_my_achievement';
/**
* The post type of an engagement template.
*
* @since 6.0.0
*
* @var string
*/
protected $post_type_template = 'llms_achievement';
/**
* Post types that this meta box should be added to.
*
* @since 6.0.0
*
* @var string[]
*/
public $screens = array(
'llms_achievement', // Template.
'llms_my_achievement', // Awarded.
);
/**
* Returns a translated text of the given type.
*
* @since 6.0.0
*
* @param int $text_type One of the LLMS_Abstract_Meta_Box_User_Engagement_Sync::TEXT_ constants.
* @param array $variables Optional variables that are used in sprintf().
* @return string
*/
protected function get_text( $text_type, $variables = array() ) {
switch ( $text_type ) {
case self::TEXT_SYNC_ALERT_MANY_AWARDED_ENGAGEMENTS:
return sprintf(
/* translators: %1$d: number of awarded achievements */
__(
'This action will replace the current title, content, background etc. of %1$d awarded achievements with the ones from this achievement template. Are you sure you want to proceed?',
'lifterlms'
),
( $variables['awarded_number'] ?? 0 )
);
case self::TEXT_SYNC_ALERT_ONE_AWARDED_ENGAGEMENT:
return sprintf(
/* translators: %1$d: number of awarded achievements */
__(
'This action will replace the current title, content, background etc. of %1$d awarded achievement with the ones from this achievement template. Are you sure you want to proceed?',
'lifterlms'
),
( $variables['awarded_number'] ?? 0 )
);
case self::TEXT_SYNC_ALERT_THIS_AWARDED_ENGAGEMENT:
return __(
'This action will replace the current title, content, background etc. of this awarded achievement with the ones from the achievement template. Are you sure you want to proceed?',
'lifterlms'
);
case self::TEXT_SYNC_DESCRIPTION_MANY_AWARDED_ENGAGEMENTS:
return sprintf(
/* translators: %1$d: number of awarded achievements */
__( 'Sync %1$d awarded achievements with this achievement template.', 'lifterlms' ),
( $variables['awarded_number'] ?? 0 )
);
case self::TEXT_SYNC_DESCRIPTION_ONE_AWARDED_ENGAGEMENT:
return sprintf(
/* translators: %1$d: number of awarded achievements */
__( 'Sync %1$d awarded achievement with this achievement template.', 'lifterlms' ),
( $variables['awarded_number'] ?? 0 )
);
case self::TEXT_SYNC_DESCRIPTION_THIS_AWARDED_ENGAGEMENT:
return sprintf(
/* translators: %1$s: link to edit the achievement template, %2$s: closing anchor tag */
__( 'Sync this awarded achievement with its %1$sachievement template%2$s.', 'lifterlms' ),
'<a href="' . get_edit_post_link( ( $variables['template_id'] ?? 0 ) ) . '" target="_blank">',
'</a>'
);
case self::TEXT_SYNC_ENGAGEMENT_TEMPLATE_NO_AWARDED_ENGAGEMENTS:
return __( 'This achievement template has no awarded achievements to sync.', 'lifterlms' );
case self::TEXT_SYNC_TITLE_AWARDED_ENGAGEMENT:
return __( 'Sync Awarded Achievement', 'lifterlms' );
case self::TEXT_SYNC_TITLE_AWARDED_ENGAGEMENTS:
return __( 'Sync Awarded Achievements', 'lifterlms' );
default:
return parent::get_text( $text_type );
}
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class-llms-meta-box-certificate-sync.php
================================================
<?php
/**
* LLMS_Meta_Box_Certificate_Sync class
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Meta box to sync between awarded certificates and certificate templates.
*
* @since 6.0.0
*/
class LLMS_Meta_Box_Certificate_Sync extends LLMS_Abstract_Meta_Box_User_Engagement_Sync {
/**
* Type of user engagement.
*
* @since 6.0.0
*
* @var string
*/
protected $engagement_type = 'certificate';
/**
* The post type of an awarded engagement.
*
* @since 6.0.0
*
* @var string
*/
protected $post_type_awarded = 'llms_my_certificate';
/**
* The post type of an engagement template.
*
* @since 6.0.0
*
* @var string
*/
protected $post_type_template = 'llms_certificate';
/**
* Post types that this meta box should be added to.
*
* @since 6.0.0
*
* @var string[]
*/
public $screens = array(
'llms_certificate', // Template.
'llms_my_certificate', // Awarded.
);
/**
* Returns a translated text of the given type.
*
* @since 6.0.0
*
* @param int $text_type One of the LLMS_Abstract_Meta_Box_User_Engagement_Sync::TEXT_ constants.
* @param array $variables Optional variables that are used in sprintf().
* @return string
*/
protected function get_text( $text_type, $variables = array() ) {
switch ( $text_type ) {
case self::TEXT_SYNC_ALERT_MANY_AWARDED_ENGAGEMENTS:
return sprintf(
/* translators: %1$d: number of awarded certificates */
__(
'This action will replace the current title, content, background etc. of %1$d awarded certificates with the ones from this certificate template. Are you sure you want to proceed?',
'lifterlms'
),
( $variables['awarded_number'] ?? 0 )
);
case self::TEXT_SYNC_ALERT_ONE_AWARDED_ENGAGEMENT:
return sprintf(
/* translators: %1$d: number of awarded certificates */
__(
'This action will replace the current title, content, background etc. of %1$d awarded certificate with the ones from this certificate template. Are you sure you want to proceed?',
'lifterlms'
),
( $variables['awarded_number'] ?? 0 )
);
case self::TEXT_SYNC_ALERT_THIS_AWARDED_ENGAGEMENT:
return __(
'This action will replace the current title, content, background etc. of this awarded certificate with the ones from the certificate template. Are you sure you want to proceed?',
'lifterlms'
);
case self::TEXT_SYNC_DESCRIPTION_MANY_AWARDED_ENGAGEMENTS:
return sprintf(
/* translators: %1$d: number of awarded certificates */
__( 'Sync %1$d awarded certificates with this certificate template.', 'lifterlms' ),
( $variables['awarded_number'] ?? 0 )
);
case self::TEXT_SYNC_DESCRIPTION_ONE_AWARDED_ENGAGEMENT:
return sprintf(
/* translators: %1$d: number of awarded certificates */
__( 'Sync %1$d awarded certificate with this certificate template.', 'lifterlms' ),
( $variables['awarded_number'] ?? 0 )
);
case self::TEXT_SYNC_DESCRIPTION_THIS_AWARDED_ENGAGEMENT:
return sprintf(
/* translators: %1$s: link to edit the certificate template, %2$s: closing anchor tag */
__( 'Sync this awarded certificate with its %1$scertificate template%2$s.', 'lifterlms' ),
'<a href="' . get_edit_post_link( ( $variables['template_id'] ?? 0 ) ) . '" target="_blank">',
'</a>'
);
case self::TEXT_SYNC_ENGAGEMENT_TEMPLATE_NO_AWARDED_ENGAGEMENTS:
return __( 'This certificate template has no awarded certificates to sync.', 'lifterlms' );
case self::TEXT_SYNC_TITLE_AWARDED_ENGAGEMENT:
return __( 'Sync Awarded certificate', 'lifterlms' );
case self::TEXT_SYNC_TITLE_AWARDED_ENGAGEMENTS:
return __( 'Sync Awarded certificates', 'lifterlms' );
default:
return parent::get_text( $text_type );
}
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.access.php
================================================
<?php
/**
* Membership Access Restrictions meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 1.0.0
* @version 3.36.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Meta_Box_Access class
*
* @since 1.0.0
* @since 3.0.0 Updated for 3.0.0 compatibility.
*/
class LLMS_Meta_Box_Access extends LLMS_Admin_Metabox {
/**
* Configure the metabox
*
* @since 3.0.0
*
* @return void
*/
public function configure() {
$this->id = 'lifterlms-membership-access';
$this->title = __( 'Membership Access', 'lifterlms' );
$this->screens = $this->get_screens();
$this->context = 'side';
}
/**
* Define metabox fields
*
* @since 3.0.0
*
* @return array
*/
public function get_fields() {
$post_type = get_post_type_object( $this->post->post_type );
$restrictions = get_post_meta( $this->post->ID, $this->prefix . 'restricted_levels', true );
if ( ! $restrictions ) {
$restrictions = array();
}
return array(
array(
'title' => __( 'Membership Access', 'lifterlms' ),
'fields' => array(
array(
'controls' => '#' . $this->prefix . 'restricted_levels',
'desc_class' => 'd-1of2 t-1of2 m-1of2',
'id' => $this->prefix . 'is_restricted',
'label' => sprintf( _x( 'Restrict this %s', 'apply membership restriction to post type', 'lifterlms' ), $post_type->labels->singular_name ),
'type' => 'checkbox',
'value' => 'yes',
),
array(
'class' => 'input-full llms-select2-post',
'data_attributes' => array(
'post-type' => 'llms_membership',
),
'desc' => sprintf( __( 'Visitors must belong to one of these memberships to access this %s', 'lifterlms' ), strtolower( $post_type->labels->singular_name ) ),
'id' => $this->prefix . 'restricted_levels',
'label' => __( 'Memberships', 'lifterlms' ),
'multi' => true,
'type' => 'select',
'value' => llms_make_select2_post_array( $restrictions ),
),
),
),
);
}
/**
* Determine the screens where the metabox should be rendered.
*
* This is determined by finding all public post types and checking if they support
* the 'llms-membership-restrictions' feature.
*
* @since 3.0.0
*
* @return array
*/
public function get_screens() {
$screens = array();
// Check against all public post types.
$post_types = get_post_types(
array(
'public' => true,
),
'names',
'and'
);
foreach ( $post_types as $post_type ) {
// check if the post type supports membership restrictions.
if ( post_type_supports( $post_type, 'llms-membership-restrictions' ) ) {
$screens[] = $post_type;
}
}
return $screens;
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.achievement.php
================================================
<?php
/**
* LLMS_Meta_Box_Achievement class file.
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Achievements meta box class.
*
* Generates the main metabox for the `llms_achievement` and `llms_my_achievement` post types.
*
* @since 1.0.0
*/
class LLMS_Meta_Box_Achievement extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings.
*
* @since 3.0.0
* @since 6.0.0 Added support for the `llms_my_achievement` post type.
*
* @return void
*/
public function configure() {
$this->id = 'lifterlms-achievement';
$this->title = __( 'Achievement Settings', 'lifterlms' );
$this->screens = array(
'llms_achievement',
'llms_my_achievement',
);
$this->priority = 'high';
}
/**
* Builds array of metabox options.
*
* Array is called in output method to display options.
* Appropriate fields are generated based on type.
*
* @since 3.0.0
* @since 3.37.12 Allow some fields to store values with quotes.
* @since 6.0.0 Removed the deprecated achievement background image meta field.
* Made the title field conditional based on viewed post type.
*
* @return array
*/
public function get_fields() {
$fields = array();
if ( 'llms_achievement' === $this->post->post_type ) {
$fields[] = array(
'label' => __( 'Achievement Title', 'lifterlms' ),
'desc' => __( 'The name of the achievement which will be shown to users', 'lifterlms' ),
'id' => $this->prefix . 'achievement_title',
'type' => 'text',
'class' => 'input-full',
'sanitize' => 'no_encode_quotes',
);
}
$fields[] = array(
'label' => __( 'Achievement Content', 'lifterlms' ),
'desc' => __( 'An optional short description of the achievement which will be shown to users', 'lifterlms' ),
'id' => $this->prefix . 'achievement_content',
'type' => 'textarea_w_tags',
'sanitize' => 'no_encode_quotes',
'cols' => 80,
'rows' => 8,
'meta' => $this->post->post_content,
);
return array(
array(
'title' => __( 'General', 'lifterlms' ),
'fields' => $fields,
),
);
}
/**
* Save field in the db.
*
* Expects an already sanitized value.
*
* Stores the `achievement_content` field as `post_content` in favor of storing it in the postmeta table.
*
* @since 6.0.0
*
* @param int $post_id The WP Post ID.
* @param int $field_id The field identifier.
* @param mixed $val Value to save.
* @return bool
*/
protected function save_field_db( $post_id, $field_id, $val ) {
// Save to the post content field.
if ( $this->prefix . 'achievement_content' === $field_id && $this->post->ID === $post_id ) {
return wp_update_post(
array(
'ID' => $post_id,
'post_content' => $val,
)
) ? true : false;
}
return parent::save_field_db( $post_id, $field_id, $val );
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.award.engagement.submit.php
================================================
<?php
/**
* Award engagement submit meta box.
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Award engagement submit meta box class.
*
* @since 6.0.0
*/
class LLMS_Meta_Box_Award_Engagement_Submit extends LLMS_Admin_Metabox {
/**
* ID of the student who earned (is about to earn) the engagement.
*
* @since 6.0.0
*
* @var int
*/
private $student_id;
/**
* Allowed post types.
*
* @since 6.0.0
*
* @var string[]
*/
private $post_types = array(
'llms_my_achievement' => array(
'model' => 'LLMS_User_Achievement',
'reporting_stab' => 'achievements',
),
'llms_my_certificate' => array(
'model' => 'LLMS_User_Certificate',
'reporting_stab' => 'certificates',
),
);
/**
* Configure the metabox settings.
*
* @since 6.0.0
*
* @return void
*/
public function configure() {
$this->id = 'submitdiv'; // Overrides the WordPress core one.
$this->title = __( 'Award', 'lifterlms' );
$this->screens = array_keys( $this->post_types );
$this->context = 'side';
$this->priority = 'high';
$this->callback_args = function () {
return 'llms_my_certificate' === get_post_type() ?
array(
'__back_compat_meta_box' => true,
)
:
array();
};
}
/**
* Not used because our metabox doesn't use the standard fields api.
*
* @since 6.0.0
*
* @return array
*/
public function get_fields() {
return array();
}
/**
* Function to field WP::output() method call.
*
* @since 6.0.0
*
* @return void
*/
public function output() {
global $action;
add_action( 'admin_print_footer_scripts', array( __CLASS__, 'metabox_scripts' ), PHP_INT_MAX );
$engagement = $this->post;
$engagement_id = (int) $this->post->ID;
$engagement_type_object = get_post_type_object( $this->post->post_type );
$can_publish = current_user_can( $engagement_type_object->cap->publish_posts );
$fields = $this->student_fields();
include LLMS_PLUGIN_DIR . 'includes/admin/views/metaboxes/view-award-engagement-submit.php';
}
/**
* Student fields.
*
* @since 6.0.0
*
* @return string
*/
private function student_fields() {
$fields = '';
// Creating.
if ( 'add' === get_current_screen()->action ) {
$fields = $this->student_fields_on_creation();
}
$fields .= $this->student_information();
return $fields;
}
/**
* Student fields on creation html.
*
* @since 6.0.0
*
* @return string
*/
private function student_fields_on_creation() {
$student_id = $this->current_student_id( true );
// The `post_author_override` is the same used in WP core for the author selector.
$field_id = 'post_author_override';
$field = array(
'id' => $field_id,
'type' => 'hidden',
'value' => $student_id,
'skip_save' => true,
'required' => true,
);
if ( empty( $student_id ) ) {
$field = array(
'allow_null' => false,
'class' => 'llms-select2-student',
'data_attributes' => array(
'allow_clear' => false,
'placeholder' => esc_attr__( 'Select a Student', 'lifterlms' ),
),
'id' => $field_id,
'label' => ' ' . esc_html__( 'Select a Student', 'lifterlms' ),
'type' => 'select',
'skip_save' => true,
'required' => true,
);
}
return $this->process_field( $field );
}
/**
* Current student information html.
*
* @since 6.0.0
*
* @return string
*/
private function student_information() {
$post_type = get_post_type( $this->post->ID );
$student_id = $this->current_student_id();
$student = $student_id ? llms_get_student( $student_id ) : $student_id;
// Bail if no student.
if ( empty( $student ) ) {
return '';
}
$first = $student->get( 'first_name' );
$last = $student->get( 'last_name' );
if ( ! $first || ! $last ) {
$name = $student->get( 'display_name' );
} else {
$name = $last . ', ' . $first;
}
$url = add_query_arg(
array(
'page' => 'llms-reporting',
'tab' => 'students',
'student_id' => $student_id,
'stab' => $this->post_types[ $post_type ]['reporting_stab'],
),
admin_url( 'admin.php' )
);
return sprintf(
'<li class="llms-mb-list student-info"> <b>%1$s:</b> <span>%2$s</span></li>',
esc_html__( 'Student', 'lifterlms' ),
sprintf(
'<a href="%1$s" target="_blank">%2$s <%3$s></a>',
esc_url( $url ),
esc_html( $name ),
esc_html( $student->get( 'user_email' ) )
)
);
}
/**
* Retrieve the current student id.
*
* @since 6.0.0
*
* @param null|bool $creating Whether or not we're awarding an engagement.
* If not provided, it'll be dynamically retrieved if the current screen's action is 'add'.
* See WordPress' `get_current_screen()`.
* @return int
*/
private function current_student_id( $creating = null ) {
if ( isset( $this->student_id ) ) {
return $this->student_id;
}
$creating = $creating ?? ( 'add' === get_current_screen()->action );
$post_type = get_post_type( $this->post->ID );
// If creating, take into account passed GET variable.
$student = $creating && ! empty( $_GET['sid'] ) ? llms_filter_input( INPUT_GET, 'sid', FILTER_SANITIZE_NUMBER_INT ) : 0; // phpcs:ignore WordPress.Security.NonceVerification.Recommended -- no need to verify the nonce here.
// If not creating, retrieve the earned engagement user id.
$student = ! $creating ? ( new $this->post_types[ $post_type ]['model']( $this->post->ID ) )->get_user_id() : $student;
$this->student_id = $student;
return $this->student_id;
}
/**
* Metabox specific scripts.
*
* @since 6.0.0
*
* @return void
*/
public static function metabox_scripts() {
?>
<script>
document.addEventListener(
"DOMContentLoaded",
() => {
// Localization.
const __ = window.wp.i18n.__,
_i18n = {
'Publish on:' : __( 'Award on:', 'lifterlms' ),
'Publish' : __( 'Award', 'lifterlms' ),
'Published' : __( 'Awarded', 'lifterlms' ),
'Published on:': __( 'Awarded on:', 'lifterlms' ),
};
window.wp.hooks.addFilter(
'i18n.gettext',
'llms.awardEngagement.submitbox',
( translation, text ) => {
return text in _i18n ? _i18n[text] : translation;
}
);
}
);
</script>
<?php
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.certificate.php
================================================
<?php
/**
* Certificates meta box.
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Certificate template meta box class.
*
* @since 1.0.0
* @since 3.37.12 Allow the certificate title field to store text with quotes.
*/
class LLMS_Meta_Box_Certificate extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings.
*
* @since 3.0.0
* @since 6.0.0 Renamed from "Certificate Settings" to "Settings".
* Moved to the side context with default priority.
*
* @return void
*/
public function configure() {
$this->id = 'lifterlms-certificate';
$this->title = __( 'Settings', 'lifterlms' );
$this->screens = array(
'llms_certificate',
);
$this->priority = 'default';
$this->context = 'side';
$this->callback_args = array(
'__back_compat_meta_box' => true,
);
}
/**
* Builds array of metabox options.
*
* Array is called in output method to display options.
* Appropriate fields are generated based on type.
*
* @since 1.0.0
* @since 3.17.4 Unknown.
* @since 3.37.12 Allow the certificate title field to store text with quotes.
* @since 6.0.0 Remove the background image option (in favor of featured image metabox).
* Expose the "Next Sequential ID" option.
*
* @return array Array of metabox fields.
*/
public function get_fields() {
$next_id = llms_get_certificate_sequential_id( $this->post->ID );
$fields = array(
array(
'label' => __( 'Certificate Title', 'lifterlms' ),
'id' => $this->prefix . 'certificate_title',
'type' => 'text',
'class' => 'input-full',
'desc_class' => 'd-all',
'sanitize' => 'no_encode_quotes',
),
array(
'label' => __( 'Next Sequential ID', 'lifterlms' ),
'id' => $this->prefix . 'sequential_id',
'type' => 'number',
'class' => 'input-full',
'desc_class' => 'd-all',
'value' => $next_id,
'min' => $next_id,
'step' => 1,
),
);
return array(
array(
'title' => __( 'General', 'lifterlms' ),
'fields' => $fields,
),
);
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.coupon.php
================================================
<?php
/**
* Coupon meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 1.0.0
* @version 6.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Coupon meta box class
*
* @since 1.0.0
* @since 3.32.0 Coupons can now be restricted also to a draft or scheduled Course/Membership.
* @since 3.35.0 Sanitize `$_POST` data and verify nonce.
* @since 3.37.19 Localize strings that were missing translation functions.
*/
class LLMS_Meta_Box_Coupon extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings
*
* @return void
* @since 3.0.0
*/
public function configure() {
$this->id = 'lifterlms-coupon';
$this->title = __( 'Coupon Settings', 'lifterlms' );
$this->screens = array(
'llms_coupon',
);
$this->priority = 'high';
}
/**
* This function is where extending classes can configure all the fields within the metabox.
* The function must return an array which can be consumed by the "output" function.
*
* @since 3.0.0
* @since 3.32.0 Coupons can now be restricted also to a draft or scheduled Course/Membership
* via the `<select />` data attribute 'post-statuses' (data-post-status).
* @since 3.37.19 Localize strings that were missing translation functions.
* @since 6.9.0 Add step definitions for discount amount and trial discount amount to allow float values to be used.
*
* @return array
*/
public function get_fields() {
$courses = array();
$memberships = array();
if ( isset( $this->post ) ) {
$c = new LLMS_Coupon( $this->post );
foreach ( $c->get_array( 'coupon_courses' ) as $course_id ) {
$courses[] = array(
'key' => $course_id,
'title' => get_the_title( $course_id ) . ' (' . __( 'ID#', 'lifterlms' ) . ' ' . $course_id . ')',
);
}
foreach ( $c->get_array( 'coupon_membership' ) as $membership_id ) {
$memberships[] = array(
'key' => $membership_id,
'title' => get_the_title( $membership_id ) . ' (' . __( 'ID#', 'lifterlms' ) . ' ' . $membership_id . ')',
);
}
} else {
$c = false;
}
return array(
array(
'title' => __( 'General', 'lifterlms' ),
'fields' => array(
array(
'allow_null' => false,
'class' => 'llms-select2',
'data_attributes' => array(
'minimum-results-for-search' => 5,
),
'desc' => __( 'Select a dollar or percentage discount.', 'lifterlms' ),
'desc_class' => 'd-all',
'id' => $this->prefix . 'discount_type',
'label' => __( 'Discount Type', 'lifterlms' ),
'type' => 'select',
'value' => array(
array(
'key' => 'percent',
'title' => __( 'Percentage Discount', 'lifterlms' ),
),
array(
'key' => 'dollar',
'title' => sprintf( __( '%s Discount', 'lifterlms' ), get_lifterlms_currency_symbol() ),
),
),
),
array(
'type' => 'select',
'label' => __( 'Access Plan Types', 'lifterlms' ),
'desc' => __( 'Select which type of access plans this coupon can be used with.', 'lifterlms' ),
'id' => $this->prefix . 'plan_type',
'class' => 'llms-select2',
'value' => array(
array(
'key' => 'any',
'title' => __( 'Any Access Plan', 'lifterlms' ),
),
array(
'key' => 'one-time',
'title' => __( 'Only One-time Payment Access Plans', 'lifterlms' ),
),
array(
'key' => 'recurring',
'title' => sprintf( __( 'Only Recurring Access Plans', 'lifterlms' ), get_lifterlms_currency_symbol() ),
),
),
'desc_class' => 'd-all',
'allow_null' => false,
'data_attributes' => array(
'minimum-results-for-search' => 5,
),
),
array(
'type' => 'number',
'label' => __( 'Discount Amount', 'lifterlms' ),
'desc' => sprintf( __( 'The amount to be subtracted from the "Price" of an applicable access plan. Do not include symbols such as %1$s.', 'lifterlms' ), get_lifterlms_currency_symbol() ),
'id' => $this->prefix . 'coupon_amount',
'class' => 'code input-full',
'desc_class' => 'd-all',
'required' => true,
'step' => '0.01',
),
array(
'type' => 'checkbox',
'label' => __( 'Enable Trial Pricing Discount', 'lifterlms' ),
'desc' => __( 'When checked, the coupon can apply a discount to the "Trial Price" of an access plan.', 'lifterlms' ),
'id' => $this->prefix . 'enable_trial_discount',
'value' => 'yes',
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'controls' => '#' . $this->prefix . 'trial_amount',
),
array(
'type' => 'number',
'label' => __( 'Trial Discount Amount', 'lifterlms' ),
'desc' => sprintf( __( 'The amount to be subtracted from the "Trial Price" of an applicable access plan. Do not include symbols such as %1$s.', 'lifterlms' ), get_lifterlms_currency_symbol() ),
'id' => $this->prefix . 'trial_amount',
'class' => 'code input-full',
'desc_class' => 'd-all',
'group' => '',
'value' => '',
'step' => '0.01',
),
),
),
array(
'title' => __( 'Restrictions', 'lifterlms' ),
'fields' => array(
array(
'type' => 'select',
'label' => __( 'Courses', 'lifterlms' ),
'desc' => __( 'Limit coupon to the following courses.', 'lifterlms' ),
'id' => $this->prefix . 'coupon_courses',
'class' => 'input-full llms-select2-post',
'value' => $courses,
'multi' => true,
'selected' => $c ? $c->get_array( 'coupon_courses' ) : array(),
'data_attributes' => array(
'post-type' => 'course',
'post-statuses' => 'publish,draft,future',
),
),
array(
'type' => 'select',
'label' => __( 'Membership', 'lifterlms' ),
'desc' => __( 'Limit coupon to the following memberships.', 'lifterlms' ),
'id' => $this->prefix . 'coupon_membership',
'class' => 'input-full llms-select2-post',
'value' => $memberships,
'multi' => true,
'selected' => $c ? $c->get_array( 'coupon_membership' ) : array(),
'data_attributes' => array(
'post-type' => 'llms_membership',
'post-statuses' => 'publish,draft,future',
),
),
array(
'type' => 'date',
'label' => __( 'Coupon Expiration Date', 'lifterlms' ),
'desc' => __( 'Coupon will no longer be usable after this date. Leave blank for no expiration.', 'lifterlms' ),
'id' => $this->prefix . 'expiration_date',
'class' => 'llms-datepicker input-full',
'value' => '',
'desc_class' => 'd-all',
'group' => '',
),
array(
'type' => 'number',
'label' => __( 'Usage Limit', 'lifterlms' ),
'desc' => __( 'The amount of times this coupon can be used. Leave empty or enter 0 for unlimited uses.', 'lifterlms' ),
'id' => $this->prefix . 'usage_limit',
'class' => 'code input-full',
'desc_class' => 'd-all',
'group' => '',
'value' => '',
),
),
),
array(
'title' => __( 'Description', 'lifterlms' ),
'fields' => array(
array(
'type' => 'textarea',
'label' => __( 'Description', 'lifterlms' ),
'desc' => __( 'Optional description for internal notes. This is never displayed to your students.', 'lifterlms' ),
'id' => $this->prefix . 'description',
'desc_class' => 'd-all',
'group' => '',
'value' => '',
'required' => false,
),
),
),
);
}
/**
* Save all metadata
*
* @since 3.0.0
* @since 3.35.0 Sanitize `$_POST` data and verify nonce.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id WP Post ID.
* @return void
*/
protected function save( $post_id ) {
if ( ! isset( $_REQUEST['lifterlms_meta_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_meta_nonce'] ) ), 'lifterlms_save_data' ) ) {
return;
}
$coupon = new LLMS_Coupon( $post_id );
// Dupcheck the title.
$exists = llms_find_coupon( $coupon->get( 'title' ), $post_id );
if ( $exists ) {
$this->add_error( __( 'Coupon code already exists. Customers will use the most recently created coupon with this code.', 'lifterlms' ) );
}
// Trial validation.
$trial_discount = llms_filter_input_sanitize_string( INPUT_POST, $this->prefix . 'enable_trial_discount' );
$trial_amount = llms_filter_input( INPUT_POST, $this->prefix . 'trial_amount', FILTER_SANITIZE_NUMBER_INT );
if ( ! $trial_discount ) {
$trial_discount = 'no';
} elseif ( 'yes' === $trial_discount && empty( $trial_amount ) ) {
$this->add_error( __( 'A Trial Discount Amount was not supplied. Trial Pricing Discount has automatically been disabled. Please re-enable Trial Pricing Discount and enter a Trial Discount Amount, then save this coupon again.', 'lifterlms' ) );
$trial_discount = 'no';
}
$coupon->set( 'enable_trial_discount', $trial_discount );
$coupon->set( 'trial_amount', $trial_amount );
$courses = llms_filter_input( INPUT_POST, $this->prefix . 'coupon_courses', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY );
if ( empty( $courses ) ) {
$courses = array();
}
$coupon->set( 'coupon_courses', $courses );
$memberships = llms_filter_input( INPUT_POST, $this->prefix . 'coupon_membership', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY );
if ( empty( $memberships ) ) {
$memberships = array();
}
$coupon->set( 'coupon_membership', $memberships );
// Save all the fields.
$fields = array(
'coupon_amount',
'usage_limit',
'discount_type',
'description',
'expiration_date',
'plan_type',
);
foreach ( $fields as $field ) {
if ( isset( $_POST[ $this->prefix . $field ] ) ) {
$coupon->set( $field, llms_filter_input_sanitize_string( INPUT_POST, $this->prefix . $field ) );
}
}
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.course.builder.php
================================================
<?php
/**
* Course Builder meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 3.13.0
* @version 3.30.1
*/
defined( 'ABSPATH' ) || exit;
/**
* Meta box for the "Course Builder" launcher/browser
*
* @since 3.13.0
* @since 3.30.1 Add `llms-mb-container` CSS class to container element in the `output()` method.
*/
class LLMS_Metabox_Course_Builder extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings
*
* @return void
* @since 3.13.0
* @version 3.13.0
*/
public function configure() {
$this->id = 'course_builder';
$this->title = __( 'Course Builder', 'lifterlms' );
$this->screens = array(
'course',
'lesson',
);
$this->context = 'side';
$this->capability = 'edit_course';
}
/**
* Get a URL to the course builder with an optional hash to a lesson/quiz/assignment
*
* @param int $course_id WP Post ID of a course.
* @param string $hash Hash of the lesson & tab info (lesson:{$lesson_id}:tab).
* @return string
* @since 3.27.0
* @version 3.27.0
*/
public function get_builder_url( $course_id, $hash = null ) {
$url = add_query_arg(
array(
'page' => 'llms-course-builder',
'course_id' => $course_id,
),
admin_url( 'admin.php' )
);
if ( $hash ) {
$url = $url . '#' . $hash;
}
return $url;
}
/**
* This metabox has no options
*
* @return array
* @since 3.13.0
* @version 3.13.0
*/
public function get_fields() {
return array();
}
/**
* Get the HTML for a title, optionally as an anchor
*
* @param string $title title to display
* @param boolean $url url to link to
* @return string
* @since 3.13.0
* @version 3.27.0
*/
public function get_title_html( $title, $url = false ) {
if ( $url ) {
$title = sprintf( '<a href="%1$s">%2$s</a>', esc_url( $url ), $title );
}
return $title;
}
/**
* Override the output method to output a button
*
* @since 3.13.0
* @since 3.30.1 Add `llms-mb-container` CSS class to container element.
*
* @return void
*/
public function output() {
$post_id = $this->post->ID;
$lesson = false;
$section = false;
if ( 'lesson' === $this->post->post_type ) {
$course = llms_get_post_parent_course( $post_id );
if ( ! $course ) {
esc_html_e( 'This lesson is not attached to a course.', 'lifterlms' );
return;
}
$course_id = $course->get( 'id' );
$lesson = llms_get_post( $this->post );
$section = $lesson->get_parent_section() ? llms_get_post( $lesson->get_parent_section() ) : false;
} else {
$course = llms_get_post( $post_id );
}
?>
<div class="llms-builder-launcher llms-mb-container">
<?php if ( $lesson && $section ) : ?>
<p><strong><?php printf( esc_html__( 'Course: %s', 'lifterlms' ), wp_kses_post( $this->get_title_html( $course->get( 'title' ), get_edit_post_link( $course->get( 'id' ) ) ) ) ); ?></strong></p>
<?php $this->output_section( $section, 'previous' ); ?>
<?php $this->output_section( $section, 'current' ); ?>
<?php $this->output_section( $section, 'next' ); ?>
<?php endif; ?>
<a class="llms-button-primary full" href="<?php echo esc_url( $this->get_builder_url( $course->get( 'id' ) ) ); ?>"><?php esc_html_e( 'Launch Course Builder', 'lifterlms' ); ?></a>
</div>
<?php
}
/**
* HTML helper to output info for a section
*
* @param obj $section LLMS_Section object
* @param string $which positioning [current|previous|next]
* @return void
* @since 3.13.0
* @version 3.28.0
*/
private function output_section( $section, $which ) {
$url = false;
if ( 'previous' === $which ) {
$section = $section->get_previous();
} elseif ( 'next' === $which ) {
$section = $section->get_next();
}
if ( ! $section ) {
return;
}
if ( 'previous' === $which || 'next' === $which ) {
$lessons = $section->get_lessons( 'ids' );
if ( $lessons ) {
$url = get_edit_post_link( $lessons[0] );
}
}
?>
<p><strong><?php printf( esc_html__( 'Section %1$d: %2$s', 'lifterlms' ), esc_html( $section->get( 'order' ) ), wp_kses_post( $this->get_title_html( $section->get( 'title' ), $url ) ) ); ?></strong></p>
<?php if ( 'current' === $which ) : ?>
<ol>
<?php
foreach ( $section->get_lessons() as $lesson ) :
$hash = 'lesson:' . $lesson->get( 'id' );
?>
<li>
<?php if ( $this->post->ID !== $lesson->get( 'id' ) ) : ?>
<?php echo wp_kses_post( $this->get_title_html( $lesson->get( 'title' ), get_edit_post_link( $lesson->get( 'id' ) ) ) ); ?>
<?php else : ?>
<?php echo wp_kses_post( $lesson->get( 'title' ) ); ?>
<?php endif; ?>
<a class="tip--top-left" href="<?php echo esc_url( $this->get_builder_url( $lesson->get( 'parent_course' ), $hash ) ); ?>" data-tip="<?php esc_attr_e( 'Edit lesson in builder', 'lifterlms' ); ?>"><i class="fa fa-cog"></i></a>
<?php
if ( $lesson->has_quiz() ) :
$quiz = $lesson->get_quiz();
?>
<br>
<?php printf( '<span class="tip--top-right" data-tip="%1$s"><i class="fa fa-question-circle"></i></span> %2$s', esc_attr__( 'Quiz', 'lifterlms' ), wp_kses_post( $this->get_title_html( $quiz->get( 'title' ), $this->get_builder_url( $lesson->get( 'parent_course' ), $hash . ':quiz' ) ) ) ); ?>
<?php endif; ?>
<?php do_action( 'llms_builder_mb_after_lesson', $lesson, $this ); ?>
</li>
<?php endforeach; ?>
</ol>
<?php
endif;
}
}
return new LLMS_Metabox_Course_Builder();
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.course.options.php
================================================
<?php
/**
* Course Options meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 1.0.0
* @version 7.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Meta_Box_Course_Options class.
*
* Course Options meta box.
*
* @since 1.0.0
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
* @since 3.36.0 Allow some fields to store values with quotes.
*/
class LLMS_Meta_Box_Course_Options extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings
*
* @return void
* @since 3.0.0
*/
public function configure() {
$this->id = 'lifterlms-course-options';
$this->title = __( 'Course Options', 'lifterlms' );
$this->screens = 'course';
$this->priority = 'high';
}
/**
* Setup fields.
*
* @since 1.0.0
* @since 3.36.0 Allow some fields to store values with quotes.
* @since 7.1.3 Fixed condition for unsetting fields when using Gutenberg.
* Replaced outdated URLs to WordPress' documentation about the list of sites you can embed from.
* @since 7.1.4 Fixed issue that prevented the correct saving of the course length when using the block editor.
* @since 7.2.0 Add function exists check for `llms_blocks_is_post_migrated`.
*
* @return array
*/
public function get_fields() {
global $post;
$course = new LLMS_Course( $this->post );
$course_tracks_options = get_terms( 'course_track', 'hide_empty=0' );
$course_tracks = array();
foreach ( (array) $course_tracks_options as $term ) {
$course_tracks[] = array(
'key' => $term->term_id,
'title' => $term->name,
);
}
// Setup course difficulty select options.
$difficulty_terms = get_terms( 'course_difficulty', 'hide_empty=0' );
$difficulty_options = array();
foreach ( $difficulty_terms as $term ) {
$difficulty_options[] = array(
'key' => $term->slug,
'title' => $term->name,
);
}
$sales_page_content_type = 'none';
if ( $post && 'auto-draft' !== $post->post_status && $post->post_excerpt ) {
$sales_page_content_type = 'content';
}
$instructor_defaults = llms_get_instructors_defaults();
$fields = array(
array(
'title' => __( 'Sales Page', 'lifterlms' ),
'fields' => array(
array(
'allow_null' => false,
'class' => 'llms-select2',
'desc' => __( 'Customize the content displayed to visitors and students who are not enrolled in the course.', 'lifterlms' ),
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'default' => $sales_page_content_type,
'id' => $this->prefix . 'sales_page_content_type',
'is_controller' => true,
'label' => __( 'Sales Page Content', 'lifterlms' ),
'type' => 'select',
'value' => llms_get_sales_page_types(),
),
array(
'controller' => '#' . $this->prefix . 'sales_page_content_type',
'controller_value' => 'content',
'desc' => __( 'This content will only be shown to visitors who are not enrolled in this course.', 'lifterlms' ),
'id' => '',
'label' => __( 'Sales Page Custom Content', 'lifterlms' ),
'type' => 'post-excerpt',
),
array(
'controller' => '#' . $this->prefix . 'sales_page_content_type',
'controller_value' => 'page',
'data_attributes' => array(
'post-type' => 'page',
'placeholder' => __( 'Select a page', 'lifterlms' ),
),
'class' => 'llms-select2-post',
'id' => $this->prefix . 'sales_page_content_page_id',
'type' => 'select',
'label' => __( 'Select a Page', 'lifterlms' ),
'value' => $course->get( 'sales_page_content_page_id' ) ? llms_make_select2_post_array( array( $course->get( 'sales_page_content_page_id' ) ) ) : array(),
),
array(
'controller' => '#' . $this->prefix . 'sales_page_content_type',
'controller_value' => 'url',
'type' => 'text',
'label' => __( 'Sales Page Redirect URL', 'lifterlms' ),
'id' => $this->prefix . 'sales_page_content_url',
'class' => 'input-full',
'value' => '',
'desc_class' => 'd-all',
'group' => 'top',
),
),
),
array(
'title' => __( 'General', 'lifterlms' ),
'fields' => array(
array(
'type' => 'text',
'label' => __( 'Course Length', 'lifterlms' ),
'desc' => __( 'Enter a description of the estimated length. IE: 3 days', 'lifterlms' ),
'id' => $this->prefix . 'length',
'class' => 'input-full',
'value' => '',
'desc_class' => 'd-all',
'group' => 'top',
),
array(
'class' => 'llms-select2',
'id' => $this->prefix . 'post_course_difficulty',
'desc' => sprintf( __( 'Choose a course difficulty level. New difficulties can be added via %1$sCourses -> Difficulties%2$s.', 'lifterlms' ), '<a href="' . admin_url( 'edit-tags.php?taxonomy=course_difficulty&post_type=course' ) . '">', '</a>' ),
'desc_class' => 'd-all',
'group' => 'bottom',
'label' => __( 'Course Difficulty Category', 'lifterlms' ),
'selected' => $course->get_difficulty( 'slug' ),
'type' => 'select',
'value' => $difficulty_options,
),
array(
'allow_null' => false,
'class' => 'llms-select2',
'id' => $this->prefix . 'focus_mode',
'desc' => __( 'Enable or disable Focus Mode for lessons in this course.', 'lifterlms' ),
'desc_class' => 'd-all',
'group' => 'bottom',
'is_controller' => true,
'label' => __( 'Focus Mode', 'lifterlms' ),
'selected' => $course->get( 'focus_mode' ) ? $course->get( 'focus_mode' ) : 'inherit',
'type' => 'select',
'value' => array(
array(
'key' => 'inherit',
'title' => sprintf(
/* translators: %s: current global setting label */
__( 'Inherit Global Setting (%s)', 'lifterlms' ),
'yes' === get_option( 'lifterlms_enable_focus_mode', 'no' )
? __( 'Enabled', 'lifterlms' )
: __( 'Disabled', 'lifterlms' )
),
),
array(
'key' => 'enable',
'title' => __( 'Enable', 'lifterlms' ),
),
array(
'key' => 'disable',
'title' => __( 'Disable', 'lifterlms' ),
),
),
),
array(
'allow_null' => false,
'class' => 'llms-select2',
'controller' => '#' . $this->prefix . 'focus_mode',
'controller_value' => 'enable,inherit',
'id' => $this->prefix . 'focus_mode_content_width',
'desc' => __( 'Set the maximum width of the lesson content area in focus mode.', 'lifterlms' ),
'desc_class' => 'd-all',
'group' => 'bottom',
'label' => __( 'Focus Mode Content Width', 'lifterlms' ),
'selected' => $course->get( 'focus_mode_content_width' ) ? $course->get( 'focus_mode_content_width' ) : 'inherit',
'type' => 'select',
'value' => llms_get_focus_mode_content_width_options( true ),
),
array(
'allow_null' => false,
'class' => 'llms-select2',
'controller' => '#' . $this->prefix . 'focus_mode',
'controller_value' => 'enable,inherit',
'id' => $this->prefix . 'focus_mode_sidebar_position',
'desc' => __( 'Choose which side the course syllabus sidebar appears on.', 'lifterlms' ),
'desc_class' => 'd-all',
'group' => 'bottom',
'label' => __( 'Focus Mode Sidebar Position', 'lifterlms' ),
'selected' => $course->get( 'focus_mode_sidebar_position' ) ? $course->get( 'focus_mode_sidebar_position' ) : 'inherit',
'type' => 'select',
'value' => llms_get_focus_mode_sidebar_position_options( true ),
),
array(
'type' => 'text',
'label' => __( 'Featured Video', 'lifterlms' ),
'desc' => sprintf( __( 'Paste the url for a Wistia, Vimeo or Youtube video or a hosted video file. For a full list of supported providers see %s.', 'lifterlms' ), '<a href="https://wordpress.org/documentation/article/embeds/#list-of-sites-you-can-embed-from" target="_blank">WordPress oEmbeds</a>' ),
'id' => $this->prefix . 'video_embed',
'class' => 'code input-full',
),
array(
'desc' => __( 'When enabled, the featured video will be displayed on the course tile in addition to the course page.', 'lifterlms' ),
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'id' => $this->prefix . 'tile_featured_video',
'label' => __( 'Display Featured Video on Course Tile', 'lifterlms' ),
'type' => 'checkbox',
'value' => 'yes',
),
array(
'type' => 'text',
'label' => __( 'Featured Audio', 'lifterlms' ),
'desc' => sprintf( __( 'Paste the url for a SoundCloud or Spotify song or a hosted audio file. For a full list of supported providers see %s.', 'lifterlms' ), '<a href="https://wordpress.org/documentation/article/embeds/#list-of-sites-you-can-embed-from" target="_blank">WordPress oEmbeds</a>' ),
'id' => $this->prefix . 'audio_embed',
'class' => 'code input-full',
),
array(
'type' => 'basic-editor',
'label' => __( 'Featured Pricing Information', 'lifterlms' ),
'desc' => __( 'Enter information on pricing for this course, to be displayed on the catalog page.', 'lifterlms' ),
'id' => $this->prefix . 'featured_pricing',
'class' => 'code input-full',
'value' => 'test',
),
array(
'label' => __( 'Course Completion Page', 'lifterlms' ),
'class' => 'llms-select2-post',
'data_attributes' => array(
'allow-clear' => true,
'post-type' => 'page',
'placeholder' => get_option( 'lifterlms_course_completion_page_id', '' ) ?
sprintf( __( 'Global setting (%s)', 'lifterlms' ), get_the_title( get_option( 'lifterlms_course_completion_page_id' ) ) ) :
__( 'Global setting (none)', 'lifterlms' ),
),
'desc' => sprintf( __( 'This page will be shown to students when they complete the course. %1$sMore Information%2$s', 'lifterlms' ), '<a href="https://lifterlms.com/docs/course-completion-page/" target="_blank">', '</a>' ),
'id' => $this->prefix . 'completion_page_id',
'value' => llms_make_select2_post_array( array( $course->get( 'completion_page_id' ) ) ),
'type' => 'select',
),
),
),
array(
'title' => __( 'Restrictions', 'lifterlms' ),
'fields' => array(
array(
'class' => 'input-full',
'default' => __( 'You must enroll in this course to access course content.', 'lifterlms' ),
'desc' => __( 'This message will be displayed when non-enrolled visitors attempt to access course content directly without enrolling first', 'lifterlms' ),
'id' => $this->prefix . 'content_restricted_message',
'label' => __( 'Content Restricted Message', 'lifterlms' ),
'type' => 'text',
),
array(
'type' => 'checkbox',
'label' => __( 'Enable Enrollment Period', 'lifterlms' ),
'desc' => __( 'Set registration start and end dates for this course', 'lifterlms' ),
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'id' => $this->prefix . 'enrollment_period',
'is_controller' => true,
'value' => 'yes',
),
array(
'class' => 'llms-datepicker input-full',
'controller' => '#' . $this->prefix . 'enrollment_period',
'controller_value' => 'yes',
'desc' => __( 'Registration opens on this date.', 'lifterlms' ),
'desc_class' => 'd-all',
'id' => $this->prefix . 'enrollment_start_date',
'label' => __( 'Enrollment Start Date', 'lifterlms' ),
'type' => 'date',
),
array(
'class' => 'llms-datepicker input-full',
'controller' => '#' . $this->prefix . 'enrollment_period',
'controller_value' => 'yes',
'desc' => __( 'Registration closes on this date.', 'lifterlms' ),
'desc_class' => 'd-all',
'id' => $this->prefix . 'enrollment_end_date',
'label' => __( 'Enrollment End Date', 'lifterlms' ),
'type' => 'date',
),
array(
'class' => 'input-full',
'controller' => '#' . $this->prefix . 'enrollment_period',
'controller_value' => 'yes',
'default' => sprintf( __( 'Enrollment in this course opens on [lifterlms_course_info id="%d" key="enrollment_start_date"].', 'lifterlms' ), $this->post->ID ),
'desc' => sprintf( __( 'This message will be displayed to non-enrolled visitors before the Enrollment Start Date. You may use shortcodes like [lifterlms_course_info id="%d" key="enrollment_start_date"] in this message.', 'lifterlms' ), $this->post->ID ),
'id' => $this->prefix . 'enrollment_opens_message',
'label' => __( 'Enrollment Opens Message', 'lifterlms' ),
'type' => 'text',
'sanitize' => 'shortcode',
),
array(
'class' => 'input-full',
'controller' => '#' . $this->prefix . 'enrollment_period',
'controller_value' => 'yes',
'default' => sprintf( __( 'Enrollment in this course closed on [lifterlms_course_info id="%d" key="enrollment_end_date"].', 'lifterlms' ), $this->post->ID ),
'desc' => sprintf( __( 'This message will be displayed to non-enrolled visitors once the Enrollment End Date has passed. You may use shortcodes like [lifterlms_course_info id="%d" key="enrollment_end_date"] in this message.', 'lifterlms' ), $this->post->ID ),
'id' => $this->prefix . 'enrollment_closed_message',
'label' => __( 'Enrollment Closed Message', 'lifterlms' ),
'type' => 'text',
'sanitize' => 'shortcode',
),
array(
'type' => 'checkbox',
'label' => __( 'Enable Course Time Period', 'lifterlms' ),
'desc' => __( 'Set start and end dates for this course. Content can only be viewed and completed within the selected range.', 'lifterlms' ),
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'id' => $this->prefix . 'time_period',
'is_controller' => true,
'value' => 'yes',
),
array(
'class' => 'llms-datepicker input-full',
'controller' => '#' . $this->prefix . 'time_period',
'controller_value' => 'yes',
'desc_class' => 'd-all',
'id' => $this->prefix . 'start_date',
'label' => __( 'Course Start Date', 'lifterlms' ),
'type' => 'date',
),
array(
'class' => 'llms-datepicker input-full',
'controller' => '#' . $this->prefix . 'time_period',
'controller_value' => 'yes',
'desc_class' => 'd-all',
'id' => $this->prefix . 'end_date',
'label' => __( 'Course End Date', 'lifterlms' ),
'type' => 'date',
),
array(
'class' => 'input-full',
'controller' => '#' . $this->prefix . 'time_period',
'controller_value' => 'yes',
'default' => sprintf( __( 'This course opens on [lifterlms_course_info id="%d" key="start_date"].', 'lifterlms' ), $this->post->ID ),
'desc' => sprintf( __( 'This message will be displayed to non-enrolled visitors before the Course Start Date. You may use shortcodes like [lifterlms_course_info id="%d" key="start_date"] in this message.', 'lifterlms' ), $this->post->ID ),
'id' => $this->prefix . 'course_opens_message',
'label' => __( 'Course Opens Message', 'lifterlms' ),
'type' => 'text',
'sanitize' => 'shortcode',
),
array(
'class' => 'input-full',
'controller' => '#' . $this->prefix . 'time_period',
'controller_value' => 'yes',
'default' => sprintf( __( 'This course closed on [lifterlms_course_info id="%d" key="end_date"].', 'lifterlms' ), $this->post->ID ),
'desc' => sprintf( __( 'This message will be displayed to non-enrolled visitors once the Course End Date has passed. You may use shortcodes like [lifterlms_course_info id="%d" key="end_date"] in this message.', 'lifterlms' ), $this->post->ID ),
'id' => $this->prefix . 'course_closed_message',
'label' => __( 'Course Closed Message', 'lifterlms' ),
'type' => 'text',
'sanitize' => 'shortcode',
),
array(
'is_controller' => true,
'type' => 'checkbox',
'label' => __( 'Enable Prerequisite', 'lifterlms' ),
'desc' => __( 'Enable to choose a prerequisite course or course track', 'lifterlms' ),
'id' => $this->prefix . 'has_prerequisite',
'class' => '',
'value' => 'yes',
'desc_class' => 'd-3of4 t-3of4 m-1of2',
),
array(
'controller' => '#' . $this->prefix . 'has_prerequisite',
'controller_value' => 'yes',
'data_attributes' => array(
'post-type' => 'course',
'allow-clear' => true,
'placeholder' => __( 'Select a course', 'lifterlms' ),
),
'class' => 'llms-select2-post',
'desc' => __( 'Select a prerequisite course. Students must have completed the selected course before they can view or complete content in this course.', 'lifterlms' ),
'id' => $this->prefix . 'prerequisite',
'type' => 'select',
'label' => __( 'Choose Prerequisite Course', 'lifterlms' ),
'value' => llms_make_select2_post_array( array( $course->get( 'prerequisite' ) ) ),
),
array(
'class' => 'llms-select2',
'controller' => '#' . $this->prefix . 'has_prerequisite',
'controller_value' => 'yes',
'desc' => __( 'Select the prerequisite course track. Students must have completed the select track before they can view or complete content in this course.', 'lifterlms' ),
'desc_class' => 'd-all',
'id' => $this->prefix . 'prerequisite_track',
'type' => 'select',
'label' => __( 'Choose Prerequisite Course Track', 'lifterlms' ),
'value' => $course_tracks,
),
array(
'type' => 'checkbox',
'label' => __( 'Enable Lesson Drip', 'lifterlms' ),
'desc' => __( 'Set global drip restrictions so lesson content becomes available at an interval you define for the course.', 'lifterlms' ),
'id' => $this->prefix . 'lesson_drip',
'is_controller' => true,
'value' => 'yes',
'class' => '',
'desc_class' => 'd-3of4 t-3of4 m-1of2',
),
array(
'class' => 'llms-select2',
'controller' => '#' . $this->prefix . 'lesson_drip',
'controller_value' => 'yes',
'is_controller' => true,
'type' => 'select',
'id' => $this->prefix . 'drip_method',
'label' => __( 'Drip Method', 'lifterlms' ),
'value' => array(
array(
'key' => 'start',
'title' => __( 'After course start or enrollment', 'lifterlms' ),
),
),
),
array(
'controller' => '#' . $this->prefix . 'lesson_drip',
'controller_value' => 'yes',
'class' => 'input-full',
'id' => $this->prefix . 'ignore_lessons',
'label' => __( 'Number of lessons to make immediately available on course start', 'lifterlms' ),
'type' => 'number',
'step' => 1,
'min' => 1,
),
array(
'controller' => '#' . $this->prefix . 'lesson_drip',
'controller_value' => 'yes',
'class' => 'input-full',
'id' => $this->prefix . 'days_before_available',
'label' => __( 'Delay (in days) ', 'lifterlms' ),
'type' => 'number',
'step' => 1,
'min' => 1,
),
array(
'is_controller' => true,
'type' => 'checkbox',
'label' => __( 'Enable Course Capacity', 'lifterlms' ),
'desc' => __( 'Limit the number of users that can enroll in this course.', 'lifterlms' ),
'id' => $this->prefix . 'enable_capacity',
'class' => '',
'value' => 'yes',
'desc_class' => 'd-3of4 t-3of4 m-1of2',
),
array(
'class' => 'input-full',
'controller' => '#' . $this->prefix . 'enable_capacity',
'controller_value' => 'yes',
'desc_class' => 'd-all',
'id' => $this->prefix . 'capacity',
'type' => 'number',
'label' => __( 'Course Capacity', 'lifterlms' ),
),
array(
'class' => 'input-full',
'controller' => '#' . $this->prefix . 'enable_capacity',
'controller_value' => 'yes',
'default' => __( 'Enrollment has closed because the maximum number of allowed students has been reached.', 'lifterlms' ),
'desc' => __( 'This message will be displayed to non-enrolled visitors once the Course Capacity has been reached. ', 'lifterlms' ),
'id' => $this->prefix . 'capacity_message',
'label' => __( 'Capacity Reached Message', 'lifterlms' ),
'type' => 'text',
),
),
),
array(
'title' => __( 'Instructors', 'lifterlms' ),
'fields' => array(
array(
'button' => array(
'text' => __( 'Add Instructor', 'lifterlms' ),
),
'handler' => 'instructors_mb_store',
'header' => array(
'default' => __( 'New Instructor', 'lifterlms' ),
),
'id' => $this->prefix . 'instructors_data',
'label' => '',
'type' => 'repeater',
'fields' => array(
array(
'allow_null' => false,
'data_attributes' => array(
'placeholder' => esc_attr__( 'Select an Instructor', 'lifterlms' ),
'roles' => 'administrator,lms_manager,instructor,instructors_assistant',
),
'class' => 'llms-select2-student',
'group' => 'd-2of3',
'id' => $this->prefix . 'id',
'type' => 'select',
'label' => __( 'Instructor', 'lifterlms' ),
),
array(
'group' => 'd-1of6',
'class' => 'input-full',
'default' => $instructor_defaults['label'],
'id' => $this->prefix . 'label',
'type' => 'text',
'label' => __( 'Label', 'lifterlms' ),
),
array(
'allow_null' => false,
'class' => 'llms-select2',
'default' => $instructor_defaults['visibility'],
'group' => 'd-1of6',
'id' => $this->prefix . 'visibility',
'type' => 'select',
'label' => __( 'Visibility', 'lifterlms' ),
'value' => array(
'visible' => esc_html__( 'Visible', 'lifterlms' ),
'hidden' => esc_html__( 'Hidden', 'lifterlms' ),
),
),
),
),
),
),
);
$current_screen = get_current_screen();
$is_gutenberg = is_object( $current_screen ) && method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor();
/**
* Remove length and difficulty fields if
* - the course is a new post and the editor is Gutenberg.
* or
* - the course is migrated to blocks used in the Gutenberg editor.
*/
if (
( $is_gutenberg && 'auto-draft' === get_post_status( $this->post->ID ) ) ||
function_exists( 'llms_blocks_is_post_migrated' ) && llms_blocks_is_post_migrated( $this->post->ID )
) {
unset( $fields[1]['fields'][1] ); // difficulty.
}
return $fields;
}
/**
* Update course difficulty on save
*
* @since 3.0.0
* @since 3.26.3 Only save when using the classic editor.
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id WP Post ID of the course
* @return void
*/
protected function save_before( $post_id ) {
if ( ! isset( $_REQUEST['lifterlms_meta_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_meta_nonce'] ) ), 'lifterlms_save_data' ) ) {
return;
}
if ( ! function_exists( 'register_block_type' ) || ! llms_blocks_is_post_migrated( $this->post->ID ) ) {
wp_set_object_terms( $post_id, llms_filter_input_sanitize_string( INPUT_POST, '_llms_post_course_difficulty' ), 'course_difficulty', false );
unset( $_POST['_llms_post_course_difficulty'] ); // Don't save this to the postmeta table.
}
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.course.short.description.php
================================================
<?php
/**
* Course Short Description meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since unknown
* @version unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* Course Short Description meta box class
*
* Overrides WP short description.
*
* @since unknown
*/
class LLMS_Meta_Box_Course_Short_Description {
/**
* outputs tinymce
*
* @return mixed (wp_editor)
* @param string $post
*/
public static function output( $post ) {
$settings = array(
'textarea_name' => 'excerpt',
'quicktags' => array(
'buttons' => 'em,strong,link',
),
'tinymce' => array(
'theme_advanced_buttons1' => 'bold,italic,strikethrough,separator,bullist,numlist,separator,blockquote,separator,justifyleft,justifycenter,justifyright,separator,link,unlink,separator,undo,redo,separator',
'theme_advanced_buttons2' => '',
),
'editor_css' => '<style>#wp-excerpt-editor-container .wp-editor-area{height:175px; width:100%;}</style>',
);
wp_editor( htmlspecialchars_decode( $post->post_excerpt ), 'excerpt', apply_filters( 'lifterlms_course_short_description_editor_settings', $settings ) );
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.email.settings.php
================================================
<?php
/**
* Certificate Options meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 1.0.0
* @version 3.37.12
*/
defined( 'ABSPATH' ) || exit;
/**
* Meta box Certificate Options class.
*
* Displays email settings meta box. Only displays on email post.
*
* @since 1.0.0
* @since 3.1.0 Unknown.
* @since 3.1.4 Unknown.
* @since 3.37.12 Allow some fields to store values with quotes.
*/
class LLMS_Meta_Box_Email_Settings extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings.
*
* @since 3.0.0
* @since 3.1.4 Unknown.
*
* @return void
*/
public function configure() {
$this->id = 'lifterlms-email';
$this->title = __( 'Email Settings', 'lifterlms' );
$this->screens = array(
'llms_email',
);
$this->priority = 'high';
}
/**
* Builds array of metabox options.
*
* Array is called in output method to display options.
* Appropriate fields are generated based on type.
*
* @since 3.0.0
* @since 3.1.0 Unknown.
* @since 3.37.12 Allow some fields to store values with quotes.
*
* @return array Array of metabox fields.
*/
public function get_fields() {
$email_merge = array(
'{student_email}' => __( 'Student Email', 'lifterlms' ),
'{admin_email}' => __( 'Admin Email', 'lifterlms' ),
);
return array(
array(
'title' => 'Settings',
'fields' => array(
array(
'type' => 'text',
'label' => __( 'Email Subject', 'lifterlms' ),
'desc' => __( 'This will be used for the subject line of your email.', 'lifterlms' ) . llms_merge_code_button( '#' . $this->prefix . 'email_subject', false ),
'id' => $this->prefix . 'email_subject',
'class' => 'code input-full',
'value' => '',
'desc_class' => 'd-all',
'group' => 'top',
'sanitize' => 'no_encode_quotes',
),
array(
'type' => 'text',
'label' => __( 'Email Heading', 'lifterlms' ),
'desc' => __( 'This is the heading for your email. It will display above the content.', 'lifterlms' ),
'id' => $this->prefix . 'email_heading',
'class' => 'code input-full',
'value' => '',
'desc_class' => 'd-all',
'group' => 'bottom',
'sanitize' => 'no_encode_quotes',
),
array(
'type' => 'text',
'label' => __( 'Email To:', 'lifterlms' ),
'desc' => __( 'Separate multiple address with a comma.', 'lifterlms' ) . llms_merge_code_button( '#' . $this->prefix . 'email_to', false, $email_merge ),
'default' => '{student_email}',
'id' => $this->prefix . 'email_to',
'class' => 'code input-full',
'required' => true,
'value' => '',
'desc_class' => 'd-all',
),
array(
'type' => 'text',
'label' => __( 'Email CC:', 'lifterlms' ),
'desc' => __( 'Separate multiple address with a comma.', 'lifterlms' ) . llms_merge_code_button( '#' . $this->prefix . 'email_cc', false, $email_merge ),
'id' => $this->prefix . 'email_cc',
'class' => 'code input-full',
'value' => '',
'desc_class' => 'd-all',
),
array(
'type' => 'text',
'label' => __( 'Email BCC:', 'lifterlms' ),
'desc' => __( 'Separate multiple address with a comma.', 'lifterlms' ) . llms_merge_code_button( '#' . $this->prefix . 'email_bcc', false, $email_merge ),
'id' => $this->prefix . 'email_bcc',
'class' => 'code input-full',
'value' => '',
'desc_class' => 'd-all',
),
),
),
);
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.engagement.php
================================================
<?php
/**
* Engagements meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 1.0.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Engagements meta box class
*
* @since 1.0.0
* @since 3.35.0 Verify nonce and access $_POST data via `llms_filter_input()`.
*/
class LLMS_Meta_Box_Engagement extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings
*
* @return void
* @since 3.1.0
* @version 3.1.0
*/
public function configure() {
$this->id = 'lifterlms-engagement';
$this->title = __( 'Engagement Options', 'lifterlms' );
$this->screens = array(
'llms_engagement',
);
$this->priority = 'high';
}
/**
* Return an empty array because the metabox fields here are completely custom
*
* @return array
* @since 1.0.0
* @version 3.11.0
*/
public function get_fields() {
$triggers = llms_get_engagement_triggers();
$types = llms_get_engagement_types();
$fields = array();
$fields[] = array(
'allow_null' => false,
'class' => 'llms-select2',
'desc' => __( 'This engagement will be triggered when a student completes the selected action', 'lifterlms' ),
'id' => $this->prefix . 'trigger_type',
'is_controller' => true,
'type' => 'select',
'label' => __( 'Triggering Event', 'lifterlms' ),
'value' => $triggers,
);
$trigger_post_fields = array(
'course' => array(
'controller_value' => array(
'course_completed',
'course_enrollment',
'course_purchased',
),
'id' => '_faux_engagement_trigger_post_course',
'label' => __( 'Select a Course', 'lifterlms' ),
'placeholder' => __( 'Any Course', 'lifterlms' ),
),
'lesson' => array(
'controller_value' => array( 'lesson_completed' ),
'id' => '_faux_engagement_trigger_post_lesson',
'label' => __( 'Select a Lesson', 'lifterlms' ),
'placeholder' => __( 'Any Lesson', 'lifterlms' ),
),
'llms_access_plan' => array(
'controller_value' => array(
'access_plan_purchased',
),
'id' => '_faux_engagement_trigger_post_access_plan',
'label' => __( 'Select an Access Plan', 'lifterlms' ),
'placeholder' => __( 'Any Access Plan', 'lifterlms' ),
),
'llms_membership' => array(
'controller_value' => array(
'membership_enrollment',
'membership_purchased',
),
'id' => '_faux_engagement_trigger_post_membership',
'label' => __( 'Select a Membership', 'lifterlms' ),
'placeholder' => __( 'Any Membership', 'lifterlms' ),
),
'llms_quiz' => array(
'controller_value' => array(
'quiz_completed',
'quiz_passed',
'quiz_failed',
),
'id' => '_faux_engagement_trigger_post_quiz',
'label' => __( 'Select a Quiz', 'lifterlms' ),
'placeholder' => __( 'Any Quiz', 'lifterlms' ),
),
'section' => array(
'controller_value' => array( 'section_completed' ),
'id' => '_faux_engagement_trigger_post_section',
'label' => __( 'Select a Section', 'lifterlms' ),
'placeholder' => __( 'Any Section', 'lifterlms' ),
),
);
foreach ( $trigger_post_fields as $post_type => $data ) {
$data['controller_value'] = apply_filters( 'llms_engagement_controller_values_' . $post_type, $data['controller_value'] );
$trigger_post_val = get_post_meta( $this->post->ID, $this->prefix . 'engagement_trigger_post', true );
if ( 'any' === $trigger_post_val || empty( $trigger_post_val ) ) {
$val = array();
} elseif ( in_array( get_post_meta( $this->post->ID, $this->prefix . 'trigger_type', true ), $data['controller_value'] ) ) {
$val = llms_make_select2_post_array( array( $trigger_post_val ) );
} else {
$val = array();
}
$placeholder = isset( $data['placeholder'] ) ? $data['placeholder'] : $data['label'];
$fields[] = array(
'allow_null' => false,
'class' => 'llms-select2-post',
'controller' => '#' . $this->prefix . 'trigger_type',
'controller_value' => implode( ',', $data['controller_value'] ),
'data_attributes' => array(
'allow_clear' => true,
'placeholder' => $placeholder,
'post-type' => $post_type,
),
'desc' => __( 'Leave blank to apply to all.', 'lifterlms' ),
'id' => $data['id'],
'label' => $data['label'],
'type' => 'select',
'value' => $val,
);
}
$track_options = array();
$tracks = get_terms(
'course_track',
array(
'hide_empty' => '0',
)
);
foreach ( $tracks as $track ) {
$track_options[] = array(
'key' => $track->term_id,
'title' => $track->name . ' (ID# ' . $track->term_id . ')',
);
}
$track_selected = get_post_meta( $this->post->ID, $this->prefix . 'engagement_trigger_post', true );
if ( 'any' === $track_selected ) {
$track_selected = '';
}
$fields[] = array(
'allow_null' => true,
'class' => 'llms-select2',
'controller' => '#' . $this->prefix . 'trigger_type',
'controller_value' => implode( ',', apply_filters( 'llms_engagement_controller_values_track', array( 'course_track_completed' ) ) ),
'data_attributes' => array(
'allow_clear' => true,
'placeholder' => __( 'Any Course Track', 'lifterlms' ),
),
'id' => '_faux_engagement_trigger_post_track',
'label' => __( 'Select a Course Track', 'lifterlms' ),
'type' => 'select',
'selected' => $track_selected,
'value' => $track_options,
);
$fields[] = array(
'allow_null' => false,
'class' => 'llms-select2',
'desc' => __( 'Determines the type of engagement', 'lifterlms' ),
'id' => $this->prefix . 'engagement_type',
'is_controller' => true,
'label' => __( 'Engagement Type', 'lifterlms' ),
'type' => 'select',
'value' => $types,
);
$type = get_post_meta( $this->post->ID, $this->prefix . 'engagement_type', true );
$default = ( ! $type ) ? 'llms_achievement' : 'llms_' . $type;
$fields[] = array(
'allow_null' => false,
'class' => 'llms-select2-post',
'data_attributes' => array(
'allow_clear' => true,
'placeholder' => __( 'Select an Engagement', 'lifterlms' ),
'post-type' => $default,
'edit-button' => true,
),
'id' => $this->prefix . 'engagement',
'label' => __( 'Select an Engagement', 'lifterlms' ),
'type' => 'select',
'value' => llms_make_select2_post_array( array( get_post_meta( $this->post->ID, $this->prefix . 'engagement', true ) ) ),
);
$fields[] = array(
'class' => 'input-full',
'default' => 0,
'desc' => __( 'Enter the number of days to wait before triggering this engagement. Enter 0 or leave blank to trigger immediately.', 'lifterlms' ),
'id' => $this->prefix . 'engagement_delay',
'label' => __( 'Engagement Delay', 'lifterlms' ),
'min' => 0,
'type' => 'number',
);
return array(
array(
'title' => __( 'Engagement Settings', 'lifterlms' ),
'fields' => $fields,
),
);
}
/**
* Custom save method.
*
* Ensures that the faux fields are not saved to the postmeta table.
*
* @since 3.1.0
* @since 3.11.0 Unknown.
* @since 3.35.0 Verify nonce and access $_POST data via `llms_filter_input()`.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id WP Post ID of the engagement.
* @return void
*/
public function save( $post_id ) {
if ( ! isset( $_REQUEST['lifterlms_meta_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_meta_nonce'] ) ), 'lifterlms_save_data' ) ) {
return;
}
// Get all defined fields.
$fields = $this->get_fields();
if ( ! is_array( $fields ) ) {
return;
}
// Loop through the fields.
foreach ( $fields as $group => $data ) {
// Find the fields in each tab.
if ( isset( $data['fields'] ) && is_array( $data['fields'] ) ) {
// Loop through the fields.
foreach ( $data['fields'] as $field ) {
// Don't save things that don't have an ID.
if ( isset( $field['id'] ) ) {
// Skip our faux fields.
if ( 0 === strpos( $field['id'], '_faux_engagement_trigger_post_' ) ) {
continue;
}
// Get the posted value.
if ( isset( $_POST[ $field['id'] ] ) ) {
$val = llms_filter_input_sanitize_string( INPUT_POST, $field['id'] );
} elseif ( ! isset( $_POST[ $field['id'] ] ) ) {
$val = '';
}
// Update the value if we have one.
if ( isset( $val ) ) {
update_post_meta( $post_id, $field['id'], $val );
}
unset( $val );
}
}
}
}
// Locate and store the trigger post id.
$type = llms_filter_input( INPUT_POST, $this->prefix . 'trigger_type' );
switch ( $type ) {
case 'access_plan_purchased':
$var = 'access_plan';
break;
case 'course_completed':
case 'course_purchased':
case 'course_enrollment':
$var = 'course';
break;
case 'lesson_completed':
$var = 'lesson';
break;
case 'membership_purchased':
case 'membership_enrollment':
$var = 'membership';
break;
case 'quiz_completed':
case 'quiz_passed':
case 'quiz_failed':
$var = 'quiz';
break;
case 'section_completed':
$var = 'section';
break;
case 'course_track_completed':
$var = 'track';
break;
default:
$var = false;
}
if ( $var ) {
$val = llms_filter_input_sanitize_string( INPUT_POST, '_faux_engagement_trigger_post_' . $var );
// An empty trigger post means "any" — store explicitly so the intent is clear.
if ( empty( $val ) ) {
$val = 'any';
}
} else {
$val = '';
}
update_post_meta( $post_id, $this->prefix . 'engagement_trigger_post', $val );
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.lesson.php
================================================
<?php
/**
* Lesson Settings meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 1.0.0
* @version 7.1.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Lesson Settings meta box class
*
* @since 1.0.0
* @since 3.30.3 Fixed spelling errors.
* @since 3.36.2 'start' drip method made avialble only if the parent course has a start date set.
*/
class LLMS_Meta_Box_Lesson extends LLMS_Admin_Metabox {
/**
* This function allows extending classes to configure required class properties
* $this->id, $this->title, and $this->screens should be configured in this function
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
public function configure() {
$this->id = 'lifterlms-lesson';
$this->title = __( 'Lesson Settings', 'lifterlms' );
$this->screens = array(
'lesson',
);
$this->priority = 'high';
}
/**
* This function is where extending classes can configure all the fields within the metabox.
*
* The function must return an array which can be consumed by the "output" function.
*
* @since 3.0.0
* @since 3.30.3 Fixed spelling errors.
* @since 3.36.2 'start' drip method made available only if the parent course has a start date set.
* @since 7.1.3 Replace outdated URLs to WordPress' documentation about the list of sites you can embed from.
*
* @return array
*/
public function get_fields() {
$lesson = llms_get_post( $this->post );
$methods = array(
'date' => __( 'On a specific date', 'lifterlms' ),
'enrollment' => __( 'After course enrollment', 'lifterlms' ),
'start' => __( 'After course start date', 'lifterlms' ),
);
$section = $lesson->get_section();
// Tf the lesson isn't first, add previous completion method.
if ( 1 !== $lesson->get( 'order' ) || ( $section && 1 !== $section->get( 'order' ) ) ) {
$methods['prerequisite'] = __( 'After prerequisite completion', 'lifterlms' );
}
// If the parent course has no start date set, unset the 'start' drip method.
$course = $lesson->get_course();
if ( ! $course || ! $course->get_date( 'start_date' ) ) {
unset( $methods['start'] );
}
$fields = array(
array(
'title' => __( 'General', 'lifterlms' ),
'fields' => array(
array(
'class' => 'code input-full',
'desc' => sprintf( __( 'Paste the url for a Wistia, Vimeo or Youtube video or a hosted video file. For a full list of supported providers see %s.', 'lifterlms' ), '<a href="https://wordpress.org/documentation/article/embeds/#list-of-sites-you-can-embed-from" target="_blank">WordPress oEmbeds</a>' ),
'desc_class' => 'd-all',
'id' => $this->prefix . 'video_embed',
'label' => __( 'Video Embed Url', 'lifterlms' ),
'type' => 'text',
),
array(
'class' => 'code input-full',
'desc' => sprintf( __( 'Paste the url for a SoundCloud or Spotify song or a hosted audio file. For a full list of supported providers see %s.', 'lifterlms' ), '<a href="https://wordpress.org/documentation/article/embeds/#list-of-sites-you-can-embed-from" target="_blank">WordPress oEmbeds</a>' ),
'desc_class' => 'd-all',
'id' => $this->prefix . 'audio_embed',
'type' => 'text',
'label' => __( 'Audio Embed Url', 'lifterlms' ),
),
array(
'class' => '',
'desc' => __( 'Checking this box will allow guests to view the content of this lesson without registering or signing up for the course.', 'lifterlms' ),
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'id' => $this->prefix . 'free_lesson',
'is_controller' => true,
'label' => __( 'Free Lesson', 'lifterlms' ),
'type' => 'checkbox',
'value' => 'yes',
),
),
),
array(
'title' => __( 'Prerequisites', 'lifterlms' ),
'fields' => array(
array(
'class' => '',
'controls' => '#' . $this->prefix . 'prerequisite',
'desc' => __( 'Enable to choose a prerequisite Lesson', 'lifterlms' ),
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'id' => $this->prefix . 'has_prerequisite',
'label' => __( 'Enable Prerequisite', 'lifterlms' ),
'type' => 'checkbox',
'value' => 'yes',
),
array(
'class' => 'llms-select2-post',
'data_attributes' => array(
'allow-clear' => true,
'placeholder' => __( 'Select a Prerequisite Lesson', 'lifterlms' ),
'post-type' => 'lesson',
),
'desc' => __( 'Select the prerequisite lesson', 'lifterlms' ),
'desc_class' => 'd-all',
'id' => $this->prefix . 'prerequisite',
'label' => __( 'Choose Prerequisite', 'lifterlms' ),
'type' => 'select',
'value' => llms_make_select2_post_array( array( get_post_meta( $this->post->ID, $this->prefix . 'prerequisite', true ) ) ),
),
),
),
'drip' => array(
'title' => __( 'Drip Settings', 'lifterlms' ),
'fields' => array(
array(
'type' => 'custom-html',
'id' => $this->prefix . 'drip_course_settings_info',
'value' => $this->get_drip_course_settings_info_html( $course ),
),
),
),
array(
'title' => __( 'Quiz', 'lifterlms' ),
'fields' => array(
array(
'controller' => '#' . $this->prefix . 'free_lesson',
'controller_value' => 'false',
'desc' => __( 'Checking this box will require students to get a passing score on the above quiz to complete the lesson.', 'lifterlms' ),
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'id' => $this->prefix . 'require_passing_grade',
'label' => __( 'Require Passing Grade', 'lifterlms' ),
'type' => 'checkbox',
'value' => 'yes',
),
),
),
);
if ( ! $course || 'yes' !== $course->get( 'lesson_drip' ) || ! $course->get( 'drip_method' ) ) {
$fields['drip']['fields'][] = array(
'class' => 'llms-select2',
'desc_class' => 'd-all',
'id' => $this->prefix . 'drip_method',
'is_controller' => true,
'label' => __( 'Method', 'lifterlms' ),
'type' => 'select',
'value' => $methods,
);
$fields['drip']['fields'][] = array(
'controller' => '#' . $this->prefix . 'drip_method',
'controller_value' => 'lesson,enrollment,start,prerequisite',
'class' => 'input-full',
'id' => $this->prefix . 'days_before_available',
'label' => __( 'Delay (in days) ', 'lifterlms' ),
'type' => 'number',
'step' => 1,
'min' => 0,
);
$fields['drip']['fields'][] = array(
'controller' => '#' . $this->prefix . 'drip_method',
'controller_value' => 'date',
'class' => 'llms-datepicker',
'date_format' => 'yy-mm-dd',
'id' => $this->prefix . 'date_available',
'label' => __( 'Date Available', 'lifterlms' ),
'type' => 'date',
);
$fields['drip']['fields'][] = array(
'controller' => '#' . $this->prefix . 'drip_method',
'controller_value' => 'date',
'class' => '',
'desc' => __( 'Optionally enter a time when the lesson should become available. If no time supplied, lesson will be available at 12:00 AM. Format must be HH:MM AM', 'lifterlms' ),
'id' => $this->prefix . 'time_available',
'label' => __( 'Time Available', 'lifterlms' ),
'type' => 'text',
);
}
return $fields;
}
/**
* Helpful messaging depending on whether the course for this lesson has drip settings enabled or not.
*
* @since 7.6.0
*
* @param LLMS_Course $course Course object.
* @return string
*/
public function get_drip_course_settings_info_html( $course ) {
if ( ! $course ) {
return '';
}
$output = 'yes' === $course->get( 'lesson_drip' ) && $course->get( 'drip_method' ) ?
esc_html__( 'Drip settings are currently set at the course level, under the Restrictions settings tab. If you would like to set individual drip settings for each lesson, you must disable the course level drip settings first.', 'lifterlms' )
:
esc_html__( 'Drip settings can be set at the course level to release course content at a specified interval, in the Restrictions settings tab.', 'lifterlms' );
$output .= ' <a href="' . esc_url( admin_url( 'post.php?post=' . $course->get( 'id' ) . '&action=edit#lifterlms-course-options' ) ) . '">' . esc_html__( 'Edit Course', 'lifterlms' ) . '</a>';
return $output;
}
}
new LLMS_Meta_Box_Lesson();
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.membership.php
================================================
<?php
/**
* Membership Settings meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 1.0.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Membership Settings meta box class
*
* @since 1.0.0
* @since 3.30.3 Fixed spelling errors; removed duplicate array keys.
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
* @since 3.36.0 Allow some fields to store values with quotes.
* @since 3.36.3 In the `save() method Added logic to correctly sanitize fields of type
* 'multi' (array) and 'shortcode' (preventing quotes encode).
* Also align the method return type to the parent `save()` method.
*/
class LLMS_Meta_Box_Membership extends LLMS_Admin_Metabox {
/**
* This function allows extending classes to configure required class properties
* $this->id, $this->title, and $this->screens should be configured in this function.
*
* @return void
* @since 3.0.0
*/
public function configure() {
$this->id = 'lifterlms-membership';
$this->title = __( 'Membership Settings', 'lifterlms' );
$this->screens = array(
'llms_membership',
);
$this->priority = 'high';
}
/**
* Get array of data to pass to the auto enrollment courses table.
*
* @since 3.0.0
* @since 3.30.0 Removed sorting by title.
* @since 3.30.3 Fixed spelling errors.
*
* @param obj $membership instance of LLMS_Membership for the current post.
* @return array
*/
private function get_content_table( $membership ) {
$data = array();
$data[] = array(
'',
'<br>' . __( 'No automatic enrollment courses found. Add a course below.', 'lifterlms' ) . '<br><br>',
'',
);
foreach ( $membership->get_auto_enroll_courses() as $course_id ) {
$course = new LLMS_Course( $course_id );
$title = $course->get( 'title' );
$data[] = array(
'<span class="dashicons dashicons-menu llms-drag-handle ui-sortable-handle"></span>',
'<a href="' . get_edit_post_link( $course->get( 'id' ) ) . '">' . $title . ' (ID#' . $course_id . ')</a>',
'<a class="llms-button-danger small" data-id="' . $course_id . '" href="#llms-course-remove" style="float:right;">' . __( 'Remove course', 'lifterlms' ) . '</a>
<a class="llms-button-secondary small" data-id="' . $course_id . '" href="#llms-course-bulk-enroll" style="float:right;margin-right:5px;">' . __( 'Enroll All Members', 'lifterlms' ) . '</a>',
);
}
return apply_filters( 'llms_membership_get_content_table_data', $data, $membership );
}
/**
* This function is where extending classes can configure all the fields within the metabox.
* The function must return an array which can be consumed by the "output" function.
*
* @since 3.0.0
* @since 3.30.0 Removed empty field settings. Modified settings to accommodate sortable auto-enrollment table.
* @since 3.30.3 Removed duplicate array keys.
* @since 3.36.0 Allow some fields to store values with quotes.
*
* @return array
*/
public function get_fields() {
global $post;
$membership = new LLMS_Membership( $this->post );
$redirect_options = array();
$redirect_page_id = $membership->get( 'redirect_page_id' );
if ( $redirect_page_id ) {
$redirect_options[] = array(
'key' => $redirect_page_id,
'title' => get_the_title( $redirect_page_id ) . '(ID#' . $redirect_page_id . ')',
);
}
$sales_page_content_type = 'none';
if ( $post && 'auto-draft' !== $post->post_status && $post->post_excerpt ) {
$sales_page_content_type = 'content';
}
$instructor_defaults = llms_get_instructors_defaults();
return array(
array(
'title' => __( 'Sales Page', 'lifterlms' ),
'fields' => array(
array(
'allow_null' => false,
'class' => 'llms-select2',
'desc' => __( 'Customize the content displayed to visitors and students who are not enrolled in the membership.', 'lifterlms' ),
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'default' => $sales_page_content_type,
'id' => $this->prefix . 'sales_page_content_type',
'is_controller' => true,
'label' => __( 'Sales Page Content', 'lifterlms' ),
'type' => 'select',
'value' => llms_get_sales_page_types(),
),
array(
'controller' => '#' . $this->prefix . 'sales_page_content_type',
'controller_value' => 'content',
'desc' => __( 'This content will only be shown to visitors who are not enrolled in this membership.', 'lifterlms' ),
'id' => '',
'label' => __( 'Sales Page Custom Content', 'lifterlms' ),
'type' => 'post-excerpt',
),
array(
'controller' => '#' . $this->prefix . 'sales_page_content_type',
'controller_value' => 'page',
'data_attributes' => array(
'post-type' => 'page',
'placeholder' => __( 'Select a page', 'lifterlms' ),
),
'class' => 'llms-select2-post',
'id' => $this->prefix . 'sales_page_content_page_id',
'type' => 'select',
'label' => __( 'Select a Page', 'lifterlms' ),
'value' => $membership->get( 'sales_page_content_page_id' ) ? llms_make_select2_post_array( array( $membership->get( 'sales_page_content_page_id' ) ) ) : array(),
),
array(
'controller' => '#' . $this->prefix . 'sales_page_content_type',
'controller_value' => 'url',
'type' => 'text',
'label' => __( 'Sales Page Redirect URL', 'lifterlms' ),
'id' => $this->prefix . 'sales_page_content_url',
'class' => 'input-full',
'value' => '',
'desc_class' => 'd-all',
'group' => 'top',
),
),
),
array(
'title' => __( 'General', 'lifterlms' ),
'fields' => array(
array(
'type' => 'text',
'label' => __( 'Featured Video', 'lifterlms' ),
'desc' => sprintf( __( 'Paste the url for a Wistia, Vimeo or Youtube video or a hosted video file. For a full list of supported providers see %s.', 'lifterlms' ), '<a href="https://wordpress.org/documentation/article/embeds/#list-of-sites-you-can-embed-from" target="_blank">WordPress oEmbeds</a>' ),
'id' => $this->prefix . 'video_embed',
'class' => 'code input-full',
),
array(
'desc' => __( 'When enabled, the featured video will be displayed on the membership tile in addition to the membership page.', 'lifterlms' ),
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'id' => $this->prefix . 'tile_featured_video',
'label' => __( 'Display Featured Video on Membership Tile', 'lifterlms' ),
'type' => 'checkbox',
'value' => 'yes',
),
array(
'type' => 'text',
'label' => __( 'Featured Audio', 'lifterlms' ),
'desc' => sprintf( __( 'Paste the url for a SoundCloud or Spotify song or a hosted audio file. For a full list of supported providers see %s.', 'lifterlms' ), '<a href="https://wordpress.org/documentation/article/embeds/#list-of-sites-you-can-embed-from" target="_blank">WordPress oEmbeds</a>' ),
'id' => $this->prefix . 'audio_embed',
'class' => 'code input-full',
),
array(
'type' => 'basic-editor',
'label' => __( 'Featured Pricing Information', 'lifterlms' ),
'desc' => __( 'Enter information on pricing for this membership, to be displayed on the catalog page.', 'lifterlms' ),
'id' => $this->prefix . 'featured_pricing',
'class' => 'code input-full',
'value' => 'test',
),
),
),
array(
'title' => __( 'Restrictions', 'lifterlms' ),
'fields' => array(
array(
'allow_null' => false,
'class' => '',
'desc' => __( 'When a non-member attempts to access content restricted to this membership', 'lifterlms' ),
'id' => $this->prefix . 'restriction_redirect_type',
'is_controller' => true,
'type' => 'select',
'label' => __( 'Restricted Access Redirect', 'lifterlms' ),
'value' => array(
array(
'key' => 'none',
'title' => __( 'Stay on page', 'lifterlms' ),
),
array(
'key' => 'membership',
'title' => __( 'Redirect to this membership page', 'lifterlms' ),
),
array(
'key' => 'page',
'title' => __( 'Redirect to a WordPress page', 'lifterlms' ),
),
array(
'key' => 'custom',
'title' => __( 'Redirect to a Custom URL', 'lifterlms' ),
),
),
),
array(
'class' => 'llms-select2-post',
'controller' => '#' . $this->prefix . 'restriction_redirect_type',
'controller_value' => 'page',
'data_attributes' => array(
'post-type' => 'page',
),
'id' => $this->prefix . 'redirect_page_id',
'label' => __( 'Select a WordPress Page', 'lifterlms' ),
'type' => 'select',
'value' => $redirect_options,
),
array(
'class' => '',
'controller' => '#' . $this->prefix . 'restriction_redirect_type',
'controller_value' => 'custom',
'id' => $this->prefix . 'redirect_custom_url',
'label' => __( 'Enter a Custom URL', 'lifterlms' ),
'type' => 'text',
'value' => 'test',
),
array(
'class' => '',
'controls' => '#' . $this->prefix . 'restriction_notice',
'default' => 'yes',
'desc' => __( 'Check this box to output a message after redirecting. If no redirect is selected this message will replace the normal content that would be displayed.', 'lifterlms' ),
'desc_class' => 'd-3of4 t-3of4 m-1of2',
'id' => $this->prefix . 'restriction_add_notice',
'label' => __( 'Display a Message', 'lifterlms' ),
'type' => 'checkbox',
'value' => 'yes',
),
array(
'class' => 'full-width',
'desc' => sprintf( __( 'Shortcodes like %s can be used in this message', 'lifterlms' ), '[lifterlms_membership_link id="' . $this->post->ID . '"]' ),
'default' => sprintf( __( 'You must belong to the %s membership to access this content.', 'lifterlms' ), '[lifterlms_membership_link id="' . $this->post->ID . '"]' ),
'id' => $this->prefix . 'restriction_notice',
'label' => __( 'Restricted Content Notice', 'lifterlms' ),
'type' => 'text',
'sanitize' => 'shortcode',
),
),
),
array(
'title' => __( 'Instructors', 'lifterlms' ),
'fields' => array(
array(
'button' => array(
'text' => __( 'Add Instructor', 'lifterlms' ),
),
'handler' => 'instructors_mb_store',
'header' => array(
'default' => __( 'New Instructor', 'lifterlms' ),
),
'id' => $this->prefix . 'instructors_data',
'label' => '',
'type' => 'repeater',
'fields' => array(
array(
'allow_null' => false,
'data_attributes' => array(
'placeholder' => esc_attr__( 'Select an Instructor', 'lifterlms' ),
'roles' => 'administrator,lms_manager,instructor,instructors_assistant',
),
'class' => 'llms-select2-student',
'group' => 'd-2of3',
'id' => $this->prefix . 'id',
'type' => 'select',
'label' => __( 'Instructor', 'lifterlms' ),
),
array(
'group' => 'd-1of6',
'class' => 'input-full',
'default' => $instructor_defaults['label'],
'id' => $this->prefix . 'label',
'type' => 'text',
'label' => __( 'Label', 'lifterlms' ),
),
array(
'allow_null' => false,
'class' => 'llms-select2',
'default' => $instructor_defaults['visibility'],
'group' => 'd-1of6',
'id' => $this->prefix . 'visibility',
'type' => 'select',
'label' => __( 'Visibility', 'lifterlms' ),
'value' => array(
'visible' => esc_html__( 'Visible', 'lifterlms' ),
'hidden' => esc_html__( 'Hidden', 'lifterlms' ),
),
),
),
),
),
),
array(
'title' => __( 'Auto Enrollment', 'lifterlms' ),
'fields' => array(
array(
'label' => __( 'Automatic Enrollment', 'lifterlms' ),
'desc' => sprintf( __( 'When a student joins this membership they will be automatically enrolled in these courses. Click %1$shere%2$s for more information.', 'lifterlms' ), '<a href="https://lifterlms.com/docs/membership-auto-enrollment/" target="_blank">', '</a>' ),
'id' => $this->prefix . 'content_table',
'titles' => array( '', __( 'Course Name', 'lifterlms' ), '' ),
'type' => 'table',
'table_data' => $this->get_content_table( $membership ),
),
array(
'class' => 'llms-select2-post',
'data_attributes' => array(
'placeholder' => __( 'Select course(s)', 'lifterlms' ),
'post-type' => 'course',
'no-view-button' => true,
),
'id' => $this->prefix . 'auto_enroll',
'label' => __( 'Add Course(s)', 'lifterlms' ),
'type' => 'select',
'value' => array(),
),
),
),
);
}
/**
* Save field data.
*
* @since 3.0.0
* @since 3.30.0 Autoenroll courses saved via AJAX and removed from this method.
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
* @since 3.36.3 Added logic to correctly sanitize fields of type 'multi' (array)
* and 'shortcode' (preventing quotes encode).
* Also align the return type to the parent `save()` method.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @see LLMS_Admin_Metabox::save_actions()
*
* @param int $post_id WP_Post ID of the post being saved.
* @return int `-1` When no user or user is missing required capabilities or when there's no or invalid nonce.
* `0` during inline saves or ajax requests or when no fields are found for the metabox.
* `1` if fields were found. This doesn't mean there weren't errors during saving.
*/
public function save( $post_id ) {
if ( ! isset( $_REQUEST['lifterlms_meta_nonce'] ) ) {
return -1;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_meta_nonce'] ) ), 'lifterlms_save_data' ) ) {
return -1;
}
// Return early during quick saves and ajax requests.
if ( isset( $_POST['action'] ) && 'inline-save' === $_POST['action'] ) {
return 0;
} elseif ( llms_is_ajax() ) {
return 0;
}
$membership = new LLMS_Membership( $post_id );
if ( ! isset( $_POST[ $this->prefix . 'restriction_add_notice' ] ) ) {
$_POST[ $this->prefix . 'restriction_add_notice' ] = 'no';
}
// Get all defined fields.
$fields = $this->get_fields();
// save all the fields.
$save_fields = array(
$this->prefix . 'restriction_redirect_type',
$this->prefix . 'redirect_page_id',
$this->prefix . 'redirect_custom_url',
$this->prefix . 'restriction_add_notice',
$this->prefix . 'restriction_notice',
$this->prefix . 'sales_page_content_page_id',
$this->prefix . 'sales_page_content_type',
$this->prefix . 'sales_page_content_url',
$this->prefix . 'featured_pricing',
$this->prefix . 'video_embed',
$this->prefix . 'audio_embed',
$this->prefix . 'tile_featured_video',
$this->prefix . 'instructors_data',
);
if ( ! is_array( $fields ) ) {
return 0;
}
$to_return = 0;
// Loop through the fields.
foreach ( $fields as $group => $data ) {
// Find the fields in each tab.
if ( isset( $data['fields'] ) && is_array( $data['fields'] ) ) {
// loop through the fields.
foreach ( $data['fields'] as $field ) {
// don't save things that don't have an ID or that are not listed in $save_fields.
if ( isset( $field['id'] ) && in_array( $field['id'], $save_fields, true ) ) {
if ( isset( $field['handler'] ) ) {
$this->save_field( $post_id, $field );
$to_return = 1;
continue;
}
if ( isset( $field['sanitize'] ) && 'shortcode' === $field['sanitize'] ) {
$val = llms_filter_input_sanitize_string( INPUT_POST, $field['id'], array( FILTER_FLAG_NO_ENCODE_QUOTES ) );
} elseif ( isset( $field['multi'] ) && $field['multi'] ) {
$val = llms_filter_input_sanitize_string( INPUT_POST, $field['id'], array( FILTER_REQUIRE_ARRAY ) );
} elseif ( $field['type'] === 'basic-editor' ) {
$val = wp_kses( $_POST[ $field['id'] ], LLMS_ALLOWED_HTML_PRICES );
} else {
$val = llms_filter_input_sanitize_string( INPUT_POST, $field['id'] );
}
$membership->set( substr( $field['id'], strlen( $this->prefix ) ), $val );
$to_return = 1;
}
}
}
}
return $to_return;
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.order.details.php
================================================
<?php
/**
* LLMS_Meta_Box_Order_Details class
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 3.0.0
* @version 7.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Order Details meta box
*
* @since 3.0.0
*/
class LLMS_Meta_Box_Order_Details extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings
*
* @since 3.0.0
*
* @return void
*/
public function configure() {
$this->id = 'lifterlms-order-details';
$this->title = __( 'Order Details', 'lifterlms' );
$this->screens = array(
'llms_order',
);
$this->context = 'normal';
$this->priority = 'high';
}
/**
* Not used because our metabox doesn't use the standard fields api
*
* @since 3.0.0
*
* @return array
*/
public function get_fields() {
return array();
}
/**
* Output metabox content
*
* @since 1.0.0
* @since 3.0.0 Unknown.
* @since 5.3.0 Use llms() in favor of deprecated LLMS().
*
* @return void
*/
public function output() {
$order = llms_get_post( $this->post );
if ( ! $order || ! is_a( $order, 'LLMS_Order' ) ) {
return;
}
$gateway = $order->get_gateway();
// Setup a list of gateways that this order can be switched to.
$gateway_feature = $order->is_recurring() ? 'recurring_payments' : 'single_payments';
$switchable_gateways = array();
$switchable_gateway_fields = array();
foreach ( llms()->payment_gateways()->get_supporting_gateways( $gateway_feature ) as $id => $gateway_obj ) {
$switchable_gateways[ $id ] = $gateway_obj->get_admin_title();
$switchable_gateway_fields[ $id ] = $gateway_obj->get_admin_order_fields();
}
include LLMS_PLUGIN_DIR . 'includes/admin/views/metaboxes/view-order-details.php';
}
/**
* Save method
*
* @since 3.0.0
* @since 3.10.0 Unknown.
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
* @since 5.3.0 Update return value from void to int (for testing conditions) and include update remaining payment data when necessary.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id Post ID of the Order.
* @return int Returns `-1` on invalid or missing nonce, `0` when an order cannot be found, and
* `1` otherwise.
*/
public function save( $post_id ) {
if ( ! isset( $_REQUEST['lifterlms_meta_nonce'] ) ) {
return -1;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_meta_nonce'] ) ), 'lifterlms_save_data' ) ) {
return -1;
}
$order = llms_get_post( $post_id );
if ( ! $order || ! is_a( $order, 'LLMS_Order' ) ) {
return 0;
}
if ( ! current_user_can( 'edit_post', $post_id ) ) {
return -1;
}
$fields = array(
'payment_gateway',
'gateway_customer_id',
'gateway_subscription_id',
'gateway_source_id',
);
foreach ( $fields as $key ) {
if ( isset( $_POST[ $key ] ) ) {
$order->set( $key, llms_filter_input_sanitize_string( INPUT_POST, $key ) );
}
}
// Only allow editing the total (for the next recurrence) if this is a recurring order.
if ( $order->is_recurring() && isset( $_POST['total'] ) && is_numeric( $_POST['total'] ) ) {
$total = floatval( $_POST['total'] );
$order->set( 'total', $total );
$order->add_note( sprintf( __( 'Order total for future payments updated to %s.', 'lifterlms' ), $order->get_price( 'total' ) ) );
}
$this->save_remaining_payments( $order );
return 1;
}
/**
* Save remaining payment date for expiring recurring orders
*
* @since 5.3.0
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 7.0.0 Return `-1` if the recurring payment cannot be modified (the gateway doesn't support this feature).
*
* @param LLMS_Order $order Order object
* @return int Returns `-1` when there's for invalid order types, `0` when there's no changes to save, and
* `1` when remaining payment data is updated.
*/
protected function save_remaining_payments( $order ) {
// If it's not a payment plan or cannot modify recurring payment, don't proceed.
if ( ! $order->has_plan_expiration() || ! $order->supports_modify_recurring_payments() ) {
return -1;
}
$payments = (int) llms_filter_input( INPUT_POST, '_llms_remaining_payments', FILTER_SANITIZE_NUMBER_INT );
$remaining = $order->get_remaining_payments();
// Nothing to save.
if ( $payments < 1 || $payments === $remaining ) {
return 0;
}
// Determine how to adjust the billing length.
$adjustment = $payments - $remaining;
$original = $order->get( 'billing_length' );
$new_length = max( $order->get( 'billing_length' ) + $adjustment, 1 );
$period = $order->get( 'billing_period' );
// Update the payment plan.
$order->set( 'billing_length', $new_length );
// Record that the payment plan has been modified.
$order->add_note(
sprintf(
// Translators: %1$d is the original billing length; %2$s is the billing period (adjusted for pluralization against the original billing length); %3$d is the new billing length; %4$s is the billing period (adjusted for pluralization against the new billing length).
__( 'The billing length of the order has been modified from %1$d %2$s to %3$d %4$s.', 'lifterlms' ),
$original,
llms_get_time_period_l10n( $period, $original ),
$new_length,
llms_get_time_period_l10n( $period, $new_length )
)
);
// Store a use note if one was entered.
$note = llms_filter_input_sanitize_string( INPUT_POST, '_llms_remaining_note' );
if ( $note ) {
$order->add_note( wp_strip_all_tags( $note ), true );
}
// Restart scheduled payments.
if ( ! $order->has_scheduled_payment() ) {
$order->maybe_schedule_payment();
}
return 1;
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.order.enrollment.php
================================================
<?php
/**
* Meta box for Student Enrollment Information via the Order interface
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 3.0.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Meta_Box_Order_Enrollment class
*
* @since 3.0.0
* @since 3.33.0 Added the logic to handle the Enrollment 'deleted' status on save.
* @since 4.2.0 In ` save_delete_enrollment()` removed order cancellation instruction, moved elsewhere as reaction to the enrollment deletion.
* @see `LLMS_Controller_Orders->on_deleted_enrollment()` in `includes\controllers\class.llms.controller.orders.php`.
* Also, add order note about the enrollment deletion only if it actually occurred.
*/
class LLMS_Meta_Box_Order_Enrollment extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings
*
* @since 3.0.0
*
* @return void
*/
public function configure() {
$this->id = 'lifterlms-order-enrollment-status';
$this->title = __( 'Student Enrollment', 'lifterlms' );
$this->screens = array(
'llms_order',
);
$this->context = 'side';
$this->priority = 'default';
}
/**
* Not used because our metabox doesn't use the standard fields api
*
* @since 3.0.0
*
* @return array
*/
public function get_fields() {
return array();
}
/**
* Function to field WP::output() method call
*
* Passes output instruction to parent.
*
* @since 3.0.0
* @since 3.33.0 Added 'Delete Enrollment' button.
*
* @return null
*/
public function output() {
$order = llms_get_post( $this->post );
if ( llms_parse_bool( $order->get( 'anonymized' ) ) ) {
esc_html_e( 'Cannot manage enrollment status for anonymized orders.', 'lifterlms' );
return;
}
$student_id = $order->get( 'user_id' );
if ( ! $student_id ) {// No user id, nothing to show.
return;
}
$student = llms_get_student( $student_id );
// No student, show a message.
if ( empty( $student ) ) {
esc_html_e( "The student who placed the order doesn't exist anymore.", 'lifterlms' );
return;
}
$current_status = $student->get_enrollment_status( $order->get( 'product_id' ) );
$select = '<select name="llms_student_new_enrollment_status">';
$select .= '<option value="">-- ' . esc_html__( 'Select', 'lifterlms' ) . ' --</option>';
foreach ( llms_get_enrollment_statuses() as $val => $name ) {
$select .= '<option value="' . esc_attr( $val ) . '"' . selected( $val, strtolower( $current_status ), false ) . '>' . esc_html( $name ) . '</option>';
}
$select .= '</select>';
echo '<p>';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped above.
printf( esc_html_x( 'Status: %s', 'enrollment status', 'lifterlms' ), $select );
echo '</p>';
echo '<p>';
printf( esc_html_x( 'Enrolled: %s', 'enrollment trigger', 'lifterlms' ), esc_html( $student->get_enrollment_date( $order->get( 'product_id' ), 'enrolled', 'm/d/Y h:i:s A' ) ) );
echo '</p>';
echo '<p>';
printf( esc_html_x( 'Updated: %s', 'enrollment trigger', 'lifterlms' ), esc_html( $student->get_enrollment_date( $order->get( 'product_id' ), 'updated', 'm/d/Y h:i:s A' ) ) );
echo '</p>';
echo '<p>';
printf( esc_html_x( 'Trigger: %s', 'enrollment trigger', 'lifterlms' ), esc_html( $student->get_enrollment_trigger( $order->get( 'product_id' ) ) ) );
echo '</p>';
echo '<input name="llms_student_old_enrollment_status" type="hidden" value="' . esc_attr( $current_status ) . '">';
echo '<input name="llms_update_enrollment_status" type="submit" class="llms-button-secondary small" value="' . esc_html__( 'Update Status', 'lifterlms' ) . '"> ';
if ( $current_status && 'enrolled' !== $current_status ) {
echo '<input name="llms_delete_enrollment_status" type="submit" class="llms-button-danger small" value="' . esc_html__( 'Delete Enrollment', 'lifterlms' ) . '">';
}
}
/**
* Save method
*
* @since 3.0.0
* @since 3.33.0 Added the logic to handle the Enrollment 'deleted' status.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id Post ID of the Order.
* @return void
*/
public function save( $post_id ) {
$update = llms_filter_input( INPUT_POST, 'llms_update_enrollment_status' );
if ( ! empty( $update ) ) {
$this->save_update_enrollment( $post_id );
}
$delete = llms_filter_input( INPUT_POST, 'llms_delete_enrollment_status' );
if ( ! empty( $delete ) ) {
$this->save_delete_enrollment( $post_id );
}
}
/**
* Delete enrollment data based on posted values.
*
* @since 3.33.0
* @since 4.2.0 Removed order cancellation instruction, moved elsewhere as reaction to the enrollment deletion.
* @see `LLMS_Controller_Orders->on_deleted_enrollment()` in `includes\controllers\class.llms.controller.orders.php`.
* Also, add order note about the enrollment deletion only if it actually occurred.
*
* @param int $post_id WP_Post ID of the order.
* @return void
*/
private function save_delete_enrollment( $post_id ) {
$order = llms_get_post( $post_id );
/**
* Completely remove any enrollment records related to the given product & order.
* Also note that, by design, at this stage the student has already been unenrolled,
* as the delete button is only available when the enrollment status is NOT 'enrolled'.
*/
if ( 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 );
}
}
/**
* Update enrollment data based on posted values.
*
* @since 3.33.0
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id WP_Post ID of the order.
* @return void
*/
private function save_update_enrollment( $post_id ) {
$old_status = llms_filter_input_sanitize_string( INPUT_POST, 'llms_student_old_enrollment_status' );
$new_status = llms_filter_input_sanitize_string( INPUT_POST, 'llms_student_new_enrollment_status' );
if ( ! $new_status || $old_status === $new_status ) {
return;
}
$order = llms_get_post( $post_id );
if ( 'enrolled' === $new_status ) {
llms_enroll_student( $order->get( 'user_id' ), $order->get( 'product_id' ), 'order_' . $order->get( 'id' ) );
} else {
llms_unenroll_student( $order->get( 'user_id' ), $order->get( 'product_id' ), $new_status, 'any' );
}
$new_status_name = llms_get_enrollment_status_name( $new_status );
if ( ! $old_status ) {
$note = sprintf( __( 'Student enrollment status changed to %s.', 'lifterlms' ), $new_status_name );
} else {
// Translators: %1$s = old enrollment status; %2$s = new enrollment status.
$note = sprintf( __( 'Student enrollment status changed from %1$s to %2$s', 'lifterlms' ), llms_get_enrollment_status_name( $old_status ), $new_status_name );
}
$order->add_note( $note, true );
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.order.notes.php
================================================
<?php
/**
* Meta boxes for order notes
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 3.0.0
* @version 3.35.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Meta boxes for orders notes class
*
* @since 3.0.0
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
*/
class LLMS_Meta_Box_Order_Notes extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings
*
* @since 3.0.0
*
* @return void
*/
public function configure() {
$this->id = 'lifterlms-order-notes';
$this->title = __( 'Order Notes', 'lifterlms' );
$this->screens = array(
'llms_order',
);
$this->context = 'side';
$this->priority = 'default';
}
/**
* Not used because our metabox doesn't use the standard fields api
*
* @return array
*
* @since 3.0.0
*/
public function get_fields() {
return array();
}
/**
* Function to field WP::output() method call
* Passes output instruction to parent
*
* @since 3.0.0
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
*
* @return void
*/
public function output() {
$order = new LLMS_Order( $this->post );
$curr_page = isset( $_GET['notes-page'] ) ? absint( wp_unslash( $_GET['notes-page'] ) ) : 1;
$per_page = 10;
$edit_link = get_edit_post_link( $this->post->ID );
$notes = $order->get_notes( $per_page, $curr_page );
$next_page = ( count( $notes ) == $per_page ) ? count( $order->get_notes( $per_page, $curr_page + 1 ) ) : 0;
$prev_url = ( $curr_page > 1 ) ? add_query_arg( 'notes-page', $curr_page - 1, $edit_link ) . '#' . $this->id : false;
$next_url = ( $next_page ) ? add_query_arg( 'notes-page', $curr_page + 1, $edit_link ) . '#' . $this->id : false;
if ( $notes ) {
echo '<ul class="llms-order-notes">';
foreach ( $notes as $note ) {
?>
<li class="llms-order-note" id="llms-order-note-<?php echo esc_attr( $note->comment_ID ); ?>">
<div class="llms-order-note-content"><?php echo wp_kses_post( wpautop( get_comment_text( $note->comment_ID ) ) ); ?></div>
<div class="llms-order-note-meta">
<?php printf( esc_html_x( 'by %s', 'order note author', 'lifterlms' ), esc_html( get_comment_author( $note->comment_ID ) ) ); ?>
<?php printf( esc_html_x( 'on %s', 'order note date', 'lifterlms' ), esc_html( get_comment_date( 'M j, Y h:i a', $note->comment_ID ) ) ); ?>
</div>
</li>
<?php
}
echo '</ul>';
if ( ! empty( $prev_url ) || ! empty( $next_url ) ) {
echo '<hr>';
}
if ( ! empty( $prev_url ) ) {
echo '<a class="button" href="' . esc_url( $prev_url ) . '">' . sprintf( esc_html__( '%s Newer', 'lifterlms' ), '«' ) . '</a> ';
}
if ( ! empty( $next_url ) ) {
echo '<a class="button" href="' . esc_url( $next_url ) . '">' . sprintf( esc_html__( 'Older %s', 'lifterlms' ), '»' ) . '</a>';
}
} else {
esc_html_e( 'No order notes found.', 'lifterlms' );
}// End if().
}
/**
* Save method
* Does nothing because there's no editable data in this metabox
*
* @since 3.0.0
*
* @param int $post_id Post ID of the Order.
* @return void
*/
public function save( $post_id ) {}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.order.submit.php
================================================
<?php
/**
* Order update/submit box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 1.0.0
* @version 7.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Meta_Box_Order_Submit class
*
* @since 1.0.0
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
* @since 3.36.0 Date fields require array when sanitized.
*/
class LLMS_Meta_Box_Order_Submit extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
public function configure() {
$this->id = 'lifterlms-order-submit';
$this->title = __( 'Order Information', 'lifterlms' );
$this->screens = array(
'llms_order',
);
$this->context = 'side';
$this->priority = 'high';
}
/**
* Retrieve json to be used by the llms-editable date fields
*
* @param int $time timestamp
* @return string
* @since 3.10.0
* @version 3.19.0
*/
public function get_editable_date_json( $time ) {
return json_encode(
array(
'date' => date_i18n( 'Y-m-d', $time ),
'hour' => date_i18n( 'H', $time ),
'minute' => date_i18n( 'i', $time ),
)
);
}
/**
* Not used because our metabox doesn't use the standard fields api
*
* @since 3.0.0
*
* @return array
*/
public function get_fields() {
return array();
}
/**
* Function to field WP::output() method call
* Passes output instruction to parent
*
* @since 3.0.0
* @since 3.19.0 Unknown.
*
* @return string|null
*/
public function output() {
$order = new LLMS_Order( $this->post );
if ( $order->is_legacy() ) {
return esc_html_e( 'The status of a Legacy order cannot be changed.', 'lifterlms' );
}
include LLMS_PLUGIN_DIR . 'includes/admin/views/metaboxes/view-order-submit.php';
wp_nonce_field( 'lifterlms_save_data', 'lifterlms_meta_nonce' );
}
/**
* Save action, update order status
*
* @since 3.0.0
* @since 3.19.0 Unknown.
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
* @since 3.36.0 Date fields require array when sanitized.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 7.0.0 Do not save recurring payments related dates if order's gateway do not support recurring payments modification.
* @since 10.0.0 Add order note when access expiration date is changed.
*
* @param int $post_id WP Post ID of the Order
* @return null
*/
public function save( $post_id ) {
if ( ! isset( $_REQUEST['lifterlms_meta_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_meta_nonce'] ) ), 'lifterlms_save_data' ) ) {
return;
}
$order = llms_get_post( $post_id );
if ( isset( $_POST['_llms_order_status'] ) ) {
$new_status = llms_filter_input_sanitize_string( INPUT_POST, '_llms_order_status' );
$old_status = $order->get( 'status' );
if ( $old_status !== $new_status ) {
// Update the status.
$order->set( 'status', $new_status );
}
}
$editable_dates = array(
'_llms_date_access_expires',
);
// Save recurring payments related dates if order's gateway supports recurring payments modification.
if ( $order->supports_modify_recurring_payments() ) {
/**
* Order is important -- if both trial and next payment are updated
* they should be saved in that order since next payment date
* is automatically recalculated by trial end date update.
*/
array_push( $editable_dates, '_llms_date_trial_end', '_llms_date_next_payment' );
}
foreach ( $editable_dates as $id => $key ) {
if ( isset( $_POST[ $key ] ) ) {
// The array of date, hour, minute that was submitted.
$dates = llms_filter_input_sanitize_string( INPUT_POST, $key, array( FILTER_REQUIRE_ARRAY ) );
// Format the array of data as a datetime string.
$new_date = $dates['date'] . ' ' . sprintf( '%02d', $dates['hour'] ) . ':' . sprintf( '%02d', $dates['minute'] );
// Get the existing saved date without seconds (in the same format as $new_date).
$saved_date = date_i18n( 'Y-m-d H:i', strtotime( get_post_meta( $post_id, $key, true ) ) );
// If the dates are not equal, update the date.
if ( $new_date !== $saved_date ) {
$date_key = str_replace( '_llms_date_', '', $key );
$order->set_date( $date_key, $new_date . ':00' );
if ( 'access_expires' === $date_key ) {
$old_date_display = $saved_date
? date_i18n( get_option( 'date_format' ) . ' ' . get_option( 'time_format' ), strtotime( $saved_date ) )
: __( 'none', 'lifterlms' );
$new_date_display = date_i18n( get_option( 'date_format' ) . ' ' . get_option( 'time_format' ), strtotime( $new_date ) );
// Translators: %1$s = old access expiration date; %2$s = new access expiration date.
$note = sprintf( __( 'Access expiration date changed from %1$s to %2$s', 'lifterlms' ), $old_date_display, $new_date_display );
$order->add_note( $note, true );
}
}
}
}
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.order.transactions.php
================================================
<?php
/**
* Order transactions metabox
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 3.0.0
* @version 3.35.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Meta_Box_Order_Transactions class
*
* @since 3.0.0
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
*/
class LLMS_Meta_Box_Order_Transactions extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
public function configure() {
$this->id = 'lifterlms-order-transactions';
$this->title = __( 'Transactions', 'lifterlms' );
$this->screens = array(
'llms_order',
);
$this->context = 'normal';
$this->priority = 'high';
}
/**
* Not used because our metabox doesn't use the standard fields api
*
* @since 3.0.0
*
* @return array
*/
public function get_fields() {
return array();
}
/**
* Function to field WP::output() method call
* Passes output instruction to parent
*
* @since 3.0.0
* @since 3.35.0 Sanitize `$_GET` data.
*
* @return void
*/
public function output() {
$order = new LLMS_Order( $this->post );
$curr_page = isset( $_GET['txns-page'] ) ? absint( wp_unslash( $_GET['txns-page'] ) ) : 1;
// Allow users to see all if they really want to.
$per_page = isset( $_GET['txns-count'] ) ? absint( wp_unslash( $_GET['txns-count'] ) ) : 20;
$transactions = $order->get_transactions(
array(
'per_page' => $per_page,
'paged' => $curr_page,
)
);
$edit_link = get_edit_post_link( $this->post->ID );
$prev_url = ( $transactions['page'] > 1 ) ? add_query_arg( 'txns-page', $curr_page - 1, $edit_link ) . '#' . $this->id : false;
$next_url = ( $transactions['page'] < $transactions['pages'] ) ? add_query_arg( 'txns-page', $curr_page + 1, $edit_link ) . '#' . $this->id : false;
$all_url = ( $next_url || $prev_url ) ? add_query_arg( 'txns-count', -1, $edit_link ) . '#' . $this->id : false;
llms_get_template(
'admin/post-types/order-transactions.php',
array(
'all_url' => $all_url,
'next_url' => $next_url,
'prev_url' => $prev_url,
'transactions' => $transactions,
)
);
}
/**
* Resend a receipt for a transaction
*
* @param int $post_id WP Post ID of the current order
* @return void
* @since 3.8.0
* @version 3.8.0
*/
private function resend_receipt( $post_id ) {
$txn_id = llms_filter_input( INPUT_POST, 'llms_resend_receipt', FILTER_SANITIZE_NUMBER_INT );
if ( ! $txn_id ) {
return;
}
do_action( 'lifterlms_resend_transaction_receipt', llms_get_post( $txn_id ) );
}
/**
* Save method, processes refunds / records manual txns
*
* @since 3.0.0
* @since 3.8.0 Unknown
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id Post ID of the Order.
* @return void
*/
public function save( $post_id ) {
if ( ! isset( $_REQUEST['lifterlms_meta_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_meta_nonce'] ) ), 'lifterlms_save_data' ) ) {
return;
}
$actions = array(
'llms_process_refund' => 'save_refund',
'llms_record_txn' => 'save_transaction',
'llms_resend_receipt' => 'resend_receipt',
);
foreach ( $actions as $action => $method ) {
$action = llms_filter_input( INPUT_POST, $action );
if ( $action ) {
$this->$method( $post_id );
break;
}
}
}
/**
* Save method, processes refunds
*
* @since 3.0.0
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id Post ID of the Order.
* @return null
*/
private function save_refund( $post_id ) {
// phpcs:disable WordPress.Security.NonceVerification.Missing -- Nonce is verified in the save() method of this class.
$txn_id = llms_filter_input( INPUT_POST, 'llms_refund_txn_id', FILTER_SANITIZE_NUMBER_INT );
$amount = llms_filter_input_sanitize_string( INPUT_POST, 'llms_refund_amount' );
if ( empty( $txn_id ) ) {
return $this->add_error( __( 'Refund Error: Missing a transaction ID', 'lifterlms' ) );
} elseif ( empty( $amount ) ) {
return $this->add_error( __( 'Refund Error: Missing or invalid refund amount', 'lifterlms' ) );
}
$txn = new LLMS_Transaction( $txn_id );
$refund = $txn->process_refund(
$amount,
llms_filter_input_sanitize_string( INPUT_POST, 'llms_refund_note' ),
llms_filter_input_sanitize_string( INPUT_POST, 'llms_process_refund' )
);
if ( is_wp_error( $refund ) ) {
$this->add_error( sprintf( _x( 'Refund Error: %s', 'admin error message', 'lifterlms' ), $refund->get_error_message() ) );
}
// phpcs:enable WordPress.Security.NonceVerification.Missing
}
/**
* Save method, records manual transactions
*
* @since 3.0.0
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id Post ID of the Order.
* @return null
*/
private function save_transaction( $post_id ) {
// phpcs:disable WordPress.Security.NonceVerification.Missing -- Nonce is verified in the save() method of this class.
if ( empty( $_POST['llms_txn_amount'] ) ) {
return $this->add_error( __( 'Refund Error: Missing or invalid payment amount', 'lifterlms' ) );
}
$order = new LLMS_Order( $post_id );
$txn = $order->record_transaction(
array(
'amount' => llms_filter_input_sanitize_string( INPUT_POST, 'llms_txn_amount' ),
'source_description' => llms_filter_input_sanitize_string( INPUT_POST, 'llms_txn_source' ),
'transaction_id' => llms_filter_input_sanitize_string( INPUT_POST, 'llms_txn_id' ),
'status' => 'llms-txn-succeeded',
'payment_gateway' => 'manual',
'payment_type' => 'single',
)
);
if ( ! empty( $_POST['llms_txn_note'] ) ) {
$order->add_note( llms_filter_input_sanitize_string( INPUT_POST, 'llms_txn_note' ), true );
}
if ( is_wp_error( $txn ) ) {
$this->add_error( sprintf( _x( 'Refund Error: %s', 'admin error message', 'lifterlms' ), $refund->get_error_message() ) );
}
// phpcs:enable WordPress.Security.NonceVerification.Missing
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.product.php
================================================
<?php
/**
* Access Plan meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 1.0.0
* @version 3.30.3
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Meta_Box_Product class
*
* @since 1.0.0
* @since 3.30.0 Added checkout redirect settings
* @since 3.30.3 Adjusted localization priority to 9.
*/
class LLMS_Meta_Box_Product extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings
*
* @since 3.0.0
* @since 3.30.3 Adjusted localization priority to 9.
*
* @return void
*/
public function configure() {
$this->id = 'lifterlms-product';
$this->title = __( 'Access Plans', 'lifterlms' );
$this->screens = array(
'course',
'llms_membership',
);
$this->priority = 'high';
// Output PHP variables for JS access.
add_action( 'admin_print_footer_scripts', array( $this, 'localize_js' ), 9 );
}
/**
* Return an empty array because the metabox fields here are completely custom
*
* @return array
* @since 3.0.0
*/
public function get_fields() {
return array();
}
/**
* Pass settings to JS
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
public function localize_js() {
$p = new LLMS_Product( $this->post );
$limit = $p->get_access_plan_limit();
echo '<script>' . esc_js( 'window.llms = window.llms || {}; window.llms.product = { access_plan_limit: ' . $limit . ' };' ) . '</script>';
}
/**
* Filter the available buttons in the Plan Description editors
*
* @param array $buttons array of default buttons
* @param string $id editor id
* @return array
* @since 3.0.0
* @version 3.0.0
*/
public function mce_buttons( $buttons, $id ) {
if ( strpos( $id, '_llms_plans_content' ) !== false ) {
$buttons = array(
'bold',
'italic',
'underline',
'blockquote',
'strikethrough',
'bullist',
'numlist',
'alignleft',
'aligncenter',
'alignright',
'undo',
'redo',
);
}
return $buttons;
}
/**
* Output metabox content
* Overwrites abstract because of the requirements of the UI
*
* @return void
* @since 3.0.0
* @version 3.29.0
*/
public function output() {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in get_html().
echo $this->get_html();
}
/**
* Retrieve the HTML for the metabox
*
* @return string
* @since 3.29.0
* @since 3.30.0 Added checkout redirect settings.
* @version 3.30.0
*/
public function get_html() {
ob_start();
$product = new LLMS_Product( $this->post );
add_filter( 'teeny_mce_buttons', array( $this, 'mce_buttons' ), 10, 2 );
$course = ( 'course' === $product->get( 'type' ) ) ? new LLMS_Course( $product->post ) : false;
// get available checkout redirection types.
$product_type = ( ! $course ) ? __( 'Membership', 'lifterlms' ) : __( 'Course', 'lifterlms' );
$checkout_redirection_types = llms_get_checkout_redirection_types( $product_type );
include LLMS_PLUGIN_DIR . 'includes/admin/views/access-plans/metabox.php';
remove_filter( 'teeny_mce_buttons', array( $this, 'mce_buttons' ), 10, 2 );
return apply_filters( 'llms_metabox_product_output', ob_get_clean(), $this );
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.students.php
================================================
<?php
/**
* Students meta box for Courses & Memberships
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 3.0.0
* @version 3.13.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Meta_Box_Students class
*
* Add & remove students.
*
* @since 3.0.0
* @version 3.13.0
*/
class LLMS_Meta_Box_Students extends LLMS_Admin_Metabox {
/**
* Capability to check in order to display the metabox to the user
*
* @var string
* @since 3.13.0
*/
public $capability = 'view_lifterlms_reports';
/**
* Configure the metabox settings
*
* @return void
* @since 3.0.0
*/
public function configure() {
$this->id = 'lifterlms-students';
$this->title = __( 'Student Management', 'lifterlms' );
$this->screens = array(
'course',
'llms_membership',
);
$this->priority = 'default';
}
/**
* Unused with our custom metabox output
*
* @since 3.0.0
*
* @return array
*/
public function get_fields() {
return array();
}
/**
* Custom metabox output function
*
* @return void
* @since 3.0.0
* @version 3.4.0
*/
public function output() {
$screen = get_current_screen();
if ( 'add' === $screen->action ) {
esc_html_e( 'You must publish this post before you can manage students.', 'lifterlms' );
} else {
global $post;
llms_get_template(
'admin/post-types/students.php',
array(
'post_id' => $post->ID,
)
);
}
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.visibility.php
================================================
<?php
/**
* Product Visibility Settings meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since 3.6.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Meta_Box_Visibility class
*
* Adds radios to the publishing misc. actions box for courses and memberships.
*
* @since 3.6.0
* @since 3.35.0 Sanitize `$_POST` data and add nonce verification.
*/
class LLMS_Meta_Box_Visibility {
/**
* Constructor
*
* @since 3.6.0
*/
public function __construct() {
add_action( 'post_submitbox_misc_actions', array( $this, 'output' ) );
add_action( 'save_post_course', array( $this, 'save' ), 10, 1 );
add_action( 'save_post_llms_membership', array( $this, 'save' ), 10, 1 );
}
/**
* Output HTML for the settings
*
* @since 3.6.0
* @since 3.35.0 Add nonce verification.
*
* @return void
*/
public function output() {
global $post;
if ( ! in_array( $post->post_type, array( 'course', 'llms_membership' ) ) ) {
return;
}
$product = new LLMS_Product( $post );
$visibility = $product->get_catalog_visibility();
$options = llms_get_product_visibility_options();
$name = isset( $options[ $visibility ] ) ? $options[ $visibility ] : $visibility;
?>
<div class="misc-pub-section" id="llms-catalog-visibility">
<span style="color:#82878c;" class="dashicons dashicons-welcome-view-site"></span>
<?php esc_html_e( 'Catalog visibility:', 'lifterlms' ); ?> <strong id="llms-catalog-visibility-display"><?php echo esc_html( $name ); ?></strong>
<a href="#llms-catalog-visibility" class="llms-edit-catalog-visibility hide-if-no-js"><?php esc_html_e( 'Edit', 'lifterlms' ); ?></a>
<div id="llms-catalog-visibility-select" class="hide-if-js">
<p><?php printf( esc_html__( 'Choose the visibility of the %s in your catalog. It will always be available directly.', 'lifterlms' ), esc_html( $product->get_post_type_label() ) ); ?></p>
<?php foreach ( $options as $name => $label ) : ?>
<input data-label="<?php echo esc_attr( $label ); ?>" id="_llms_visibility_<?php echo esc_attr( $name ); ?>" name="_llms_visibility" type="radio" value="<?php echo esc_attr( $name ); ?>" <?php checked( $visibility, $name ); ?> />
<label for="_llms_visibility_<?php echo esc_attr( $name ); ?>" class="selectit"><?php echo esc_attr( $label ); ?></label><br>
<?php endforeach; ?>
<p>
<a href="#llms-catalog-visibility" class="llms-save-catalog-visibility hide-if-no-js button"><?php esc_html_e( 'OK', 'lifterlms' ); ?></a>
<a href="#llms-catalog-visibility" class="llms-cancel-catalog-visibility hide-if-no-js"><?php esc_html_e( 'Cancel', 'lifterlms' ); ?></a>
</p>
<?php wp_nonce_field( 'llms-catalog-visibility-nonce', 'llms_catalog_visibility_nonce' ); ?>
</div>
</div>
<?php
}
/**
* Save the settings
*
* @since 3.6.0
* @since 3.35.0 Sanitize `$_POST` data and verify nonce.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id WP Post ID.
* @return void
*/
public function save( $post_id ) {
if ( ! isset( $_REQUEST['llms_catalog_visibility_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['llms_catalog_visibility_nonce'] ) ), 'llms-catalog-visibility-nonce' ) ) {
return;
}
$visibility = llms_filter_input_sanitize_string( INPUT_POST, '_llms_visibility' );
if ( ! $visibility ) {
return;
}
$product = new LLMS_Product( $post_id );
$product->set_catalog_visibility( $visibility );
}
}
return new LLMS_Meta_Box_Visibility();
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.voucher.export.php
================================================
<?php
/**
* Meta box Voucher Export
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since Unknown
* @version 3.30.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Meta box Voucher Export class
*
* @since Unknown
* @since 3.30.3 Fixed typo in export content-disposition header.
* @since 3.35.0 Sanitize $_POST data, fix issue preventing emails from being properly sent.
*/
class LLMS_Meta_Box_Voucher_Export {
public static $prefix = '_';
public function __construct() {}
/**
* Function to field WP::output() method call
* Passes output instruction to parent
*
* @param object $post WP global post object
* @return void
* @since ??
* @version 3.24.0
*/
public static function output( $post ) {
global $post;
if ( 'publish' !== $post->post_status ) {
esc_html_e( 'You need to publish this post before you can generate a CSV.', 'lifterlms' );
return;
}
?>
<div class="llms-voucher-export-wrapper" id="llms-form-wrapper">
<div class="llms-voucher-export-type">
<input type="radio" name="llms_voucher_export_type" id="vouchers_only_type" value="vouchers">
<label for="vouchers_only_type"><strong><?php esc_html_e( 'Vouchers only', 'lifterlms' ); ?></strong></label>
<p><?php esc_html_e( 'Generates a CSV of voucher codes, uses, and remaining uses.', 'lifterlms' ); ?></p>
</div>
<div class="llms-voucher-export-type">
<input type="radio" name="llms_voucher_export_type" id="redeemed_codes_type" value="redeemed">
<label for="redeemed_codes_type"><strong><?php esc_html_e( 'Redeemed codes', 'lifterlms' ); ?></strong></label>
<p><?php esc_html_e( 'Generated a CSV of student emails, redemption date, and used code.', 'lifterlms' ); ?></p>
</div>
<div class="llms-voucher-email-wrapper">
<input type="checkbox" name="llms_voucher_export_send_email" id="llms_voucher_export_send_email"
value="true">
<label for="llms_voucher_export_send_email"><?php esc_html_e( 'Email CSV', 'lifterlms' ); ?></label>
<input type="text" placeholder="Email" name="llms_voucher_export_email">
<p><?php esc_html_e( 'Send to multiple emails by separating emails addresses with commas.', 'lifterlms' ); ?></p>
</div>
<button type="submit" name="llms_generate_export" value="generate" class="button-primary"><?php esc_html_e( 'Generate Export', 'lifterlms' ); ?></button>
<?php wp_nonce_field( 'lifterlms_csv_export_data', 'lifterlms_export_nonce' ); ?>
<div class="clear"></div>
</div>
<?php
}
/**
* Export vouchers.
*
* @since Unknown.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return [type] [description]
*/
public static function export() {
if ( empty( llms_filter_input( INPUT_POST, 'llms_generate_export' ) ) || ! isset( $_REQUEST['lifterlms_export_nonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_export_nonce'] ) ), 'lifterlms_csv_export_data' ) ) {
return false;
}
$type = llms_filter_input( INPUT_POST, 'llms_voucher_export_type' );
if ( ! empty( $type ) ) {
if ( 'vouchers' === $type || 'redeemed' === $type ) {
// Export CSV.
$csv = array();
$file_name = '';
global $post;
$voucher = new LLMS_Voucher( $post->ID );
switch ( $type ) {
case 'vouchers':
$voucher = new LLMS_Voucher( $post->ID );
$codes = $voucher->get_voucher_codes( 'ARRAY_A' );
if ( ! $codes ) {
/**
* @todo error handling here
*/
return;
}
foreach ( $codes as $k => $v ) {
unset( $codes[ $k ]['id'] );
unset( $codes[ $k ]['voucher_id'] );
$codes[ $k ]['count'] = $codes[ $k ]['redemption_count'];
$codes[ $k ]['used'] = $codes[ $k ]['used'];
$codes[ $k ]['created'] = $codes[ $k ]['created_at'];
$codes[ $k ]['updated'] = $codes[ $k ]['updated_at'];
unset( $codes[ $k ]['redemption_count'] );
unset( $codes[ $k ]['created_at'] );
unset( $codes[ $k ]['updated_at'] );
unset( $codes[ $k ]['is_deleted'] );
}
$csv = self::array_to_csv( $codes );
$file_name = 'vouchers.csv';
break;
case 'redeemed':
$redeemed_codes = $voucher->get_redeemed_codes( 'ARRAY_A' );
if ( ! $redeemed_codes ) {
/**
* @todo error handling here
*/
return;
}
foreach ( $redeemed_codes as $k => $v ) {
unset( $redeemed_codes[ $k ]['id'] );
unset( $redeemed_codes[ $k ]['code_id'] );
unset( $redeemed_codes[ $k ]['voucher_id'] );
unset( $redeemed_codes[ $k ]['redemption_count'] );
unset( $redeemed_codes[ $k ]['user_id'] );
}
$csv = self::array_to_csv( $redeemed_codes );
$file_name = 'redeemed_codes.csv';
break;
}
$send_email = llms_parse_bool( llms_filter_input( INPUT_POST, 'llms_voucher_export_send_email' ) );
if ( $send_email ) {
// Send email.
$email_text = trim( llms_filter_input_sanitize_string( INPUT_POST, 'llms_voucher_export_email' ) );
if ( ! empty( $email_text ) ) {
$emails = array_filter( array_map( 'is_email', array_map( 'trim', explode( ',', $email_text ) ) ) );
if ( ! empty( $emails ) ) {
$voucher = new LLMS_Voucher( $post->ID );
self::send_email( $csv, $emails, $voucher->get_voucher_title() );
}
}
return false;
}
self::download_csv( $csv, $file_name );
}// End if().
}// End if().
}
public static function array_to_csv( $data, $delimiter = ',', $enclosure = '"' ) {
$handle = fopen( 'php://temp', 'r+' );
$contents = '';
$names = array();
foreach ( $data[0] as $name => $item ) {
$names[] = $name;
}
fputcsv( $handle, $names, $delimiter, $enclosure );
foreach ( $data as $line ) {
fputcsv( $handle, $line, $delimiter, $enclosure );
}
rewind( $handle );
while ( ! feof( $handle ) ) {
$contents .= fread( $handle, 8192 );
}
fclose( $handle );
return $contents;
}
/**
* Serve the CSV as an attachment to be downloaded.
*
* @since Unknown
* @since 3.30.3 Fixed typo in export content-disposition header.
*
* @param string $csv CSV content string.
* @param string $name Filename.
* @return void
*/
public static function download_csv( $csv, $name ) {
header( 'Content-Type: application/csv' );
header( 'Content-Disposition: attachment; filename="' . $name . '";' );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- CSV output.
echo $csv;
exit;
}
public static function send_email( $csv, $emails, $title ) {
$subject = 'Your LifterLMS Voucher Export';
$message = 'Please find the attached voucher csv export for ' . $title . '.';
// Create temp file.
$temp = tempnam( '/tmp', 'vouchers' );
// Write CSV.
$handle = fopen( $temp, 'w' );
fwrite( $handle, $csv );
// Prepare filename.
$temp_data = stream_get_meta_data( $handle );
$temp_filename = $temp_data['uri'];
$new_filename = substr_replace( $temp_filename, '', 13 ) . '.csv';
rename( $temp_filename, $new_filename );
// Send email/s.
$mail = wp_mail( $emails, $subject, $message, '', $new_filename );
// And remove it.
fclose( $handle );
unlink( $new_filename );
return $mail;
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/class.llms.meta.box.voucher.php
================================================
<?php
/**
* Vouchers meta box
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Classes
*
* @since Unknown
* @version 7.1.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Vouchers Meta box class
*
* @since Unknown
* @since 3.32.0 Vouchers can now be restricted also to a draft or scheduled Course/Membership.
* @since 3.35.0 Sanitize `$_POST` data; add placeholder text.
* @since 3.36.0 Remove superfluous code.
* @since 4.0.0 Remove usage of `LLMS_Svg`.
* @since 7.1.3 Added `esc_attr()` and `esc_html()` for HTML attributes and HTML.
*/
class LLMS_Meta_Box_Voucher extends LLMS_Admin_Metabox {
/**
* Configure the metabox settings
*
* @since 3.0.0
*
* @return void
*/
public function configure() {
$this->id = 'lifterlms-voucher';
$this->title = __( 'Voucher Settings', 'lifterlms' );
$this->screens = array(
'llms_voucher',
);
$this->priority = 'high';
}
/**
* Builds array of metabox options.
*
* Array is called in output method to display options.
* Appropriate fields are generated based on type.
*
* @since 3.0.0
* @since 3.32.0 Vouchers can now be restricted also to a draft or scheduled Course/Membership
* @since 3.35.0 Add relevant placeholders on the course/membership select fields.
*
* @return array
*/
public function get_fields() {
$voucher = new LLMS_Voucher( $this->post->ID );
$selected_couses = $voucher->get_products( 'course' );
$selected_memberships = $voucher->get_products( 'llms_membership' );
return array(
array(
'title' => __( 'General', 'lifterlms' ),
'fields' => array(
array(
'data_attributes' => array(
'post-type' => 'course',
'post-statuses' => 'publish,draft,future',
'placeholder' => __( 'Courses', 'lifterlms' ),
),
'type' => 'select',
'label' => __( 'Courses', 'lifterlms' ),
'id' => $this->prefix . 'voucher_courses',
'class' => 'input-full llms-select2-post',
'selected' => $selected_couses,
'value' => llms_make_select2_post_array( $selected_couses ),
'multi' => true,
),
array(
'data_attributes' => array(
'post-type' => 'llms_membership',
'post-statuses' => 'publish,draft,future',
'placeholder' => __( 'Memberships', 'lifterlms' ),
),
'type' => 'select',
'label' => __( 'Membership', 'lifterlms' ),
'id' => $this->prefix . 'voucher_membership',
'class' => 'input-full llms-select2-post',
'selected' => $selected_memberships,
'value' => llms_make_select2_post_array( $selected_memberships ),
'multi' => true,
),
array(
'type' => 'custom-html',
'label' => __( 'Codes', 'lifterlms' ),
'id' => '',
'class' => '',
'value' => self::codes_section_html(),
),
),
),
array(
'title' => __( 'Redemptions', 'lifterlms' ),
'fields' => array(
array(
'type' => 'custom-html',
'label' => __( 'Redemptions', 'lifterlms' ),
'id' => '',
'class' => '',
'value' => self::redemption_section_html(),
),
),
),
);
}
/**
* Retrieve the HTML for the codes area.
*
* @since Unknown
* @since 4.0.0 Replace SVG delete icon with a dashicon.
* @since 7.1.3 Added `esc_attr()` for HTML attributes.
*
* @return string
*/
private function codes_section_html() {
global $post;
$voucher = new LLMS_Voucher( $post->ID );
$codes = $voucher->get_voucher_codes();
ob_start(); ?>
<div class="llms-voucher-codes-wrapper" id="llms-form-wrapper">
<table>
<thead>
<tr>
<th></th>
<th>Code</th>
<th>Uses</th>
<th>Actions</th>
</tr>
</thead>
<script>var delete_icon = '<span class="dashicons dashicons-no"></span><span class="screen-reader-text"><?php echo esc_js( __( 'Delete', 'lifterlms' ) ); ?></span>';</script>
<tbody id="llms_voucher_tbody">
<?php
if ( ! empty( $codes ) ) :
foreach ( $codes as $code ) :
?>
<tr>
<td></td>
<td>
<input type="text" maxlength="20" placeholder="Code" value="<?php echo esc_attr( $code->code ); ?>" name="llms_voucher_code[]">
<input type="hidden" name="llms_voucher_code_id[]" value="<?php echo esc_attr( $code->id ); ?>">
</td>
<td>
<span><?php echo esc_html( $code->used ); ?> / </span><input type="number" min="1" value="<?php echo esc_attr( $code->redemption_count ); ?>" placeholder="Uses" class="llms-voucher-uses" name="llms_voucher_uses[]">
</td>
<td>
<a href="#" data-id="<?php echo esc_attr( $code->id ); ?>" class="llms-voucher-delete">
<span class="dashicons dashicons-no"></span><span class="screen-reader-text"><?php echo esc_html__( 'Delete', 'lifterlms' ); ?></span>
</a>
</td>
</tr>
<?php
endforeach;
endif;
?>
</tbody>
</table>
<div class="llms-voucher-add-codes">
<p>Add <input type="number" max="50" placeholder="#" id="llms_voucher_add_quantity"> new code(s) with <input
type="number" placeholder="#" id="llms_voucher_add_uses"> use(s) per code
<button id="llms_voucher_add_codes" class="button-primary">Add</button>
</p>
</div>
<input type="hidden" name="delete_ids" id="delete_ids">
</div>
<?php
return ob_get_clean();
}
/**
* Retrieve the HTML for the redemption area.
*
* @since Unknown
* @since 7.1.3 Added `esc_html()` for HTML output.
*
* @return string
*/
private function redemption_section_html() {
global $post;
$pid = $post->ID;
$voucher = new LLMS_Voucher( $pid );
$redeemed_codes = $voucher->get_redeemed_codes();
ob_start();
?>
<div class="llms-voucher-redemption-wrapper">
<table>
<thead>
<tr>
<th>Name</th>
<th>Email</th>
<th>Redemption Date</th>
<th>Code</th>
</tr>
</thead>
<tbody>
<?php
if ( ! empty( $redeemed_codes ) ) :
foreach ( $redeemed_codes as $redeemed_code ) :
$user = get_user_by( 'id', $redeemed_code->user_id );
?>
<tr>
<td><?php echo esc_html( $user->data->display_name ); ?></td>
<td><?php echo esc_html( $user->data->user_email ); ?></td>
<td><?php echo esc_html( $redeemed_code->redemption_date ); ?></td>
<td><?php echo esc_html( $redeemed_code->code ); ?></td>
</tr>
<?php
endforeach;
endif;
?>
</tbody>
</table>
</div>
<?php
return ob_get_clean();
}
/**
* Save method
*
* Cleans variables and saves using `update_post_meta()`.
*
* @version 3.0.0
* @version 3.35.0 Sanitize `$_POST` data with `llms_filter_input()`.
* @version 3.36.0 Remove superfluous code.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id [id of post object]
* @return boolean|null
*/
public function save( $post_id ) {
if ( ! empty( llms_filter_input( INPUT_POST, 'llms_generate_export' ) ) || ! isset( $_REQUEST['lifterlms_meta_nonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_meta_nonce'] ) ), 'lifterlms_save_data' ) ) {
return false;
}
// Codes save.
$codes = array();
$llms_codes = llms_filter_input_sanitize_string( INPUT_POST, 'llms_voucher_code', array( FILTER_REQUIRE_ARRAY ) );
$llms_uses = llms_filter_input( INPUT_POST, 'llms_voucher_uses', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY );
$llms_voucher_code_id = llms_filter_input( INPUT_POST, 'llms_voucher_code_id', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY );
$voucher = new LLMS_Voucher( $post_id );
if ( isset( $llms_codes ) && ! empty( $llms_codes ) && isset( $llms_uses ) && ! empty( $llms_uses ) ) {
foreach ( $llms_codes as $k => $code ) {
if ( isset( $code ) && ! empty( $code ) && isset( $llms_uses[ $k ] ) && ! empty( $llms_uses[ $k ] ) ) {
if ( isset( $llms_voucher_code_id[ $k ] ) ) {
$data = array(
'code' => $code,
'redemption_count' => intval( $llms_uses[ $k ] ),
);
if ( intval( $llms_voucher_code_id[ $k ] ) ) {
$data['id'] = intval( $llms_voucher_code_id[ $k ] );
}
$codes[] = $data;
}
}
}
}
if ( ! empty( $codes ) ) {
foreach ( $codes as $code ) {
if ( isset( $code['id'] ) ) {
$voucher->update_voucher_code( $code );
} else {
$voucher->save_voucher_code( $code );
}
}
}
// Courses and membership save.
$products = array();
foreach ( array( 'courses', 'membership' ) as $type ) {
$list = llms_filter_input( INPUT_POST, '_llms_voucher_' . $type, FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY );
foreach ( (array) $list as $item ) {
$products[] = absint( $item );
}
}
// Remove old products.
$voucher->delete_products();
// Save new ones.
if ( ! empty( $products ) ) {
foreach ( $products as $item ) {
$voucher->save_product( $item );
}
}
// Set old codes as deleted.
$ids = llms_filter_input( INPUT_POST, 'delete_ids' );
if ( $ids ) {
$delete_ids = array_map( 'absint', explode( ',', $ids ) );
if ( ! empty( $delete_ids ) ) {
foreach ( $delete_ids as $id ) {
$voucher->delete_voucher_code( $id );
}
}
}
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.basic.editor.php
================================================
<?php
/**
* Meta box Field: Basic Editor
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since 8.0.0
*/
defined( 'ABSPATH' ) || exit;
class LLMS_Metabox_Basic_Editor_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @return void
*/
public function output() {
parent::output(); ?>
<div
data-name="<?php echo esc_attr( $this->field['id'] ); ?>"
class="llms-editable-title llms-basic-editor llms-input-formatting"
data-attribute="title"
<?php if ( array_key_exists( 'placeholder', $this->field ) && $this->field['placeholder'] ) : ?>
data-placeholder="<?php echo esc_attr( $this->field['placeholder'] ); ?>"
<?php endif; ?>
><?php echo wp_kses( $this->meta, LLMS_ALLOWED_HTML_PRICES ); ?></div>
<input type="hidden" name="<?php echo esc_attr( $this->field['id'] ); ?>" value="<?php echo esc_attr( $this->meta ); ?>" />
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.button.php
================================================
<?php
/**
* Meta box Field: Button
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Button_Field class
*
* @since Unknown
*/
class LLMS_Metabox_Button_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @param array $_field Array containing information about field
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @return void
*/
public function output() {
global $post;
parent::output(); ?>
<button
id="<?php echo esc_attr( $this->field['id'] ); ?>"
class="<?php echo esc_attr( $this->field['class'] ); ?>"
>
<?php echo esc_attr( $this->field['value'] ); ?>
</button>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.checkbox.php
================================================
<?php
/**
* Meta box Field: Checkbox
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version 4.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Checkbox_Field class
*
* @since Unknown
* @since 4.0.0 Remove reliance on `LLMS_Svg` class.
*/
class LLMS_Metabox_Checkbox_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @since Unknown
*
* @param array $_field Array containing information about field
* @return void
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @since Unknown
* @since 4.0.0 Remove reliance on `LLMS_Svg` class, refactor to closely match appearance of WP core block editor toggles.
*
* @return void
*/
public function output() {
global $post;
parent::output(); ?>
<div class="llms-switch d-1of4 t-1of4 m-1of2">
<input
<?php if ( isset( $this->field['controls'] ) ) : ?>
data-controls="<?php echo esc_attr( $this->field['controls'] ); ?>"
<?php endif; ?>
<?php if ( isset( $this->field['is_controller'] ) ) : ?>
data-is-controller="true"
<?php endif; ?>
name="<?php echo esc_attr( $this->field['id'] ); ?>"
id="<?php echo esc_attr( $this->field['id'] ); ?>"
class="llms-toggle llms-toggle-round"
type="checkbox"
value="<?php echo esc_attr( $this->field['value'] ); ?>"
<?php echo ( $this->field['value'] === $this->meta ) ? 'checked' : ''; ?>
/>
<label for="<?php echo esc_attr( $this->field['id'] ); ?>"></label>
</div>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.color.php
================================================
<?php
/**
* Meta box Field: Color picker
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Color_Field class
*
* @since Unknown
*/
class LLMS_Metabox_Color_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @param array $_field Array containing information about field
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @return void
*/
public function output() {
global $post;
parent::output();
if ( ! $this->meta ) {
$this->meta = $this->field['value'];
}
?>
<input class="color-picker" type="text" name="<?php echo esc_attr( $this->field['id'] ); ?>" id="<?php echo esc_attr( $this->field['id'] ); ?>" value="<?php echo esc_attr( $this->meta ); ?>" data-default-color="<?php echo esc_attr( $this->field['value'] ); ?>"/>
<br /><span class="description"><?php echo wp_kses_post( $this->field['desc'] ); ?></span>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.custom.html.php
================================================
<?php
/**
* Meta box Field: Custom HTML
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Custom_Html_Field class
*
* @since Unknown
*/
class LLMS_Metabox_Custom_Html_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @param array $_field Array containing information about field
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @return void
*/
public function output() {
global $post;
parent::output();
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in the field value.
echo $this->field['value'];
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.date.php
================================================
<?php
/**
* Meta box Field: Date Picker Field
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version 3.11.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Date_Field class
*
* Pass in 'llms-datepicker' for the class for the field to automatically use jQuery datepicker.
*
* @since Unknown
*/
class LLMS_Metabox_Date_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @param array $_field Array containing information about field
* @since ??
* @version 3.11.0
*/
public function __construct( $_field ) {
$_field = wp_parse_args(
$_field,
array(
'date_format' => 'mm/dd/yy', // jQuery datepicker formats (http://api.jqueryui.com/datepicker/#utility-formatDate).
'date_max' => '',
'date_min' => '',
'date_displayformat' => $this->php_to_jquery_date_format( get_option( 'date_format' ) ),
)
);
$this->field = $_field;
}
function php_to_jquery_date_format( $php_format ) {
$replacements = array(
// Day
'd' => 'dd',
'D' => 'D',
'j' => 'd',
'l' => 'DD',
// Month
'm' => 'mm',
'n' => 'm',
'M' => 'M',
'F' => 'MM',
// Year
'Y' => 'yy',
'y' => 'y',
);
return strtr( $php_format, $replacements );
}
function jquery_date_to_php_format( $js_format ) {
// Mapping of jQuery UI Datepicker tokens to PHP date format tokens
$replacements = array(
// Year tokens
'yy' => 'Y', // 4-digit year
'y' => 'y', // 2-digit year
// Month tokens
'mm' => 'm', // Month with leading zero
'm' => 'n', // Month without leading zero
'MM' => 'F', // Full month name
'M' => 'M', // Short month name
// Day tokens
'dd' => 'd', // Day with leading zero
'd' => 'j', // Day without leading zero
'DD' => 'l', // Full day name
'D' => 'D', // Short day name
);
// Sort keys descending by length to avoid partial replacements.
uksort(
$replacements,
function ( $a, $b ) {
return strlen( $b ) - strlen( $a );
}
);
return strtr( $js_format, $replacements );
}
/**
* Construct data attributes for the field
* sets up jQuery datepicker
*
* @return [type] [description]
* @since 3.11.0
* @version 3.11.0
*/
public function get_data_attrs() {
$attrs = array(
'date_format' => 'data-format',
'date_max' => 'data-max-date',
'date_min' => 'data-min-date',
);
$data_attrs = '';
foreach ( $attrs as $key => $attr ) {
$val = ! empty( $this->field[ $key ] ) ? $this->field[ $key ] : null;
if ( $val ) {
$data_attrs .= sprintf( '%1$s="%2$s"', $attr, $val );
}
}
return $data_attrs;
}
/**
* outputs the Html for the given field
*
* @since ??
* @version 3.11.0
*
* @return void
*/
public function output() {
global $post;
parent::output(); ?>
<?php
// Convert the meta value into display format.
$js_display_date = $this->meta;
if ( ! empty( $this->meta ) ) {
$meta_date = DateTime::createFromFormat( $this->jquery_date_to_php_format( $this->field['date_format'] ), $this->meta );
if ( ! $meta_date ) {
error_log( sprintf( 'Meta value %s for field %s is not in the expected format %s', $this->meta, $this->field['id'], $this->field['date_format'] ) );
}
if ( $meta_date ) {
$js_display_date = $meta_date->format( $this->jquery_date_to_php_format( $this->field['date_displayformat'] ) );
}
}
?>
<input type="hidden"
id="<?php echo esc_attr( $this->field['id'] ); ?>_alt_datefield"
name="<?php echo esc_attr( $this->field['id'] ); ?>"
value="<?php echo ! empty( $this->meta ) ? esc_attr( $this->meta ) : ''; ?>"
<?php if ( isset( $this->field['required'] ) && $this->field['required'] ) : ?>
required="required"
<?php endif; ?>
/>
<input type="text"
name="<?php echo esc_attr( $this->field['id'] ); ?>_datepicker"
id="<?php echo esc_attr( $this->field['id'] ); ?>"
class="<?php echo esc_attr( $this->field['class'] ); ?>"
value="<?php echo ! empty( $this->meta ) ? esc_attr( $js_display_date ) : ''; ?>"
size="30"
<?php if ( isset( $this->field['required'] ) && $this->field['required'] ) : ?>
required="required"
<?php endif; ?>
<?php if ( isset( $this->field['placeholder'] ) ) : ?>
placeholder="<?php echo esc_attr( $this->field['placeholder'] ); ?>"
<?php endif; ?>
data-format="<?php echo esc_attr( $this->field['date_displayformat'] ); ?>"
data-alt-format="<?php echo esc_attr( $this->field['date_format'] ); ?>"
<?php if ( ! empty( $this->field['date_max'] ) ) : ?>
data-max-date="<?php echo esc_attr( $this->field['date_max'] ); ?>"
<?php endif; ?>
<?php if ( ! empty( $this->field['date_min'] ) ) : ?>
data-min-date="<?php echo esc_attr( $this->field['date_min'] ); ?>"
<?php endif; ?>
data-alt-field="#<?php echo esc_attr( $this->field['id'] ); ?>_alt_datefield"
/>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.editor.php
================================================
<?php
/**
* WP Editor meta box field
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version 3.30.3
*/
defined( 'ABSPATH' ) || exit;
/**
* WP Editor meta box field class
*
* @since Unknown
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Metabox_Editor_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Array of editor arguments.
*
* @see _WP_Editors::parse_settings()
* @var array
* @since 3.11.0
*/
public $settings;
/**
* Class constructor
*
* @param array $_field Array containing information about field
*/
public function __construct( $_field ) {
$this->field = $_field;
$this->settings = isset( $this->field['settings'] ) ? $this->field['settings'] : array();
}
/**
* outputs the Html for the given field
*
* @return void
*/
public function output() {
global $post;
parent::output();
wp_editor( $this->meta, $this->field['id'], $this->settings );
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.fields.php
================================================
<?php
/**
* Abstract Metabox_Field.
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since unknown
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Metabox_Field parent class.
*
* Contains base code for each of the Metabox Fields.
*
* @since unknown
* @since 3.24.0 Unknown.
*/
abstract class LLMS_Metabox_Field {
/**
* Global array used in class instance to store field information.
*
* @var array
*/
public $field;
/**
* Global variable to contain meta information about $field.
*
* @var object
*/
public $meta;
/**
* Outputs the head for each of the field types.
*
* @todo All the unset variables here should be defaulted somewhere else probably.
*
* @since unknown
* @since 3.11.0 Unknown.
* @since 6.0.0 Do not print empty labels; do not print the description block if both 'desc' and 'label' are empty.
* Avoid retrieving the meta from the db if passed.
* @return void
*/
public function output() {
global $post;
if ( isset( $this->field['meta'] ) ) {
$this->meta = $this->field['meta'];
} elseif ( ( ! metadata_exists( 'post', $post->ID, $this->field['id'] ) || 'auto-draft' === $post->post_status ) && ! empty( $this->field['default'] ) ) {
$this->meta = $this->field['default'];
} else {
$this->meta = self::get_post_meta( $post->ID, $this->field['id'] );
}
if ( ! isset( $this->field['group'] ) ) {
$this->field['group'] = '';
}
if ( ! isset( $this->field['desc_class'] ) ) {
$this->field['desc_class'] = '';
}
if ( ! isset( $this->field['desc'] ) ) {
$this->field['desc'] = '';
}
$wrapper_classes = array( 'llms-mb-list' );
$wrapper_classes[] = $this->field['id'];
$wrapper_classes[] = $this->field['type'];
$wrapper_classes = array_merge( $wrapper_classes, explode( ' ', $this->field['group'] ) );
?>
<li
class="<?php echo esc_attr( implode( ' ', $wrapper_classes ) ); ?>"
<?php
echo isset( $this->field['controller'] ) ? ' data-controller="' . esc_attr( $this->field['controller'] ) . '"' : '';
echo isset( $this->field['controller_value'] ) ? ' data-controller-value="' . esc_attr( $this->field['controller_value'] ) . '"' : '';
?>
>
<?php if ( ! empty( $this->field['desc'] ) || ! empty( $this->field['label'] ) ) : ?>
<div class="description <?php echo esc_attr( $this->field['desc_class'] ); ?>">
<?php if ( ! empty( $this->field['label'] ) ) : ?>
<label for="<?php echo esc_attr( $this->field['id'] ); ?>"><?php echo esc_html( $this->field['label'] ); ?></label>
<?php endif; ?>
<?php echo wp_kses_post( $this->field['desc'] ); ?>
<?php
if ( isset( $this->field['required'] ) && $this->field['required'] ) :
?>
<em>(required)</em><?php endif; ?>
</div>
<?php
endif;
}
/**
* Outputs the tail for each of the field types.
*
* @since unknown.
*
* @return void
*/
public function close_output() {
echo '<div class="clear"></div></li>';
}
/**
* Set the default meta value of a field.
*
* @since 1.0.0
* @since 3.24.0 Unknown.
*
* @param int $post_id WP Post ID.
* @param string $field_id ID/name of the field.
* @return mixed
*/
public static function get_post_meta( $post_id, $field_id ) {
if ( '_post_course_difficulty' === $field_id ) {
$difficulties = wp_get_object_terms( $post_id, 'course_difficulty' );
if ( $difficulties ) {
return $difficulties[0]->slug;
}
} else {
return get_post_meta( $post_id, $field_id, true );
}
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.hidden.php
================================================
<?php
/**
* Meta box Field: Hidden.
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Hidden_Field class.
*
* @since Unknown
*/
class LLMS_Metabox_Hidden_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor.
*
* @param array $_field Array containing information about field
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* Outputs the Html for the given field.
*
* @return void
*/
public function output() {
parent::output(); ?>
<input
name="<?php echo esc_attr( $this->field['id'] ); ?>"
id="<?php echo esc_attr( $this->field['id'] ); ?>"
<?php if ( isset( $this->field['required'] ) && $this->field['required'] ) : ?>
required="required"
<?php endif; ?>
type="hidden"
value="<?php echo esc_attr( $this->field['value'] ); ?>"
>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.image.php
================================================
<?php
/**
* Meta box field: Image meta box field
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since ??
* @version 3.24.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Image meta box field class
*
* @since ??
* @since 3.24.0 Unknown.
*/
class LLMS_Metabox_Image_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @param array $_field Array containing information about field
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @return void
* @since ??
* @version 3.24.0
*/
public function output() {
global $post;
parent::output();
if ( 'achievement_meta_box' === $this->field['section'] ) {
$image = apply_filters( 'lifterlms_placeholder_img_src', llms()->plugin_url() . '/assets/images/optional_achievement.png' ); ?>
<img id="<?php echo esc_attr( $this->field['id'] ); ?>" class="llms_achievement_default_image" style="display:none" src="<?php echo esc_url( $image ); ?>">
<?php
$imgclass = 'llms_achievement_image';
} else {
$image = apply_filters( 'lifterlms_placeholder_img_src', llms()->plugin_url() . '/assets/images/optional_certificate.png' );
?>
<img id="<?php echo esc_attr( $this->field['id'] ); ?>" class="llms_certificate_default_image" style="display:none" src="<?php echo esc_url( $image ); ?>">
<?php
$imgclass = 'llms_certificate_image';
} // End if().
if ( is_numeric( $this->meta ) ) {
$image = wp_get_attachment_image_src( $this->meta, 'medium' );
$image = $image[0];
}
?>
<img src="<?php echo esc_url( $image ); ?>" id="<?php echo esc_attr( $this->field['id'] ); ?>" class="<?php echo esc_attr( $imgclass ); ?>" /><br />
<input name="<?php echo esc_attr( $this->field['id'] ); ?>" id="<?php echo esc_attr( $this->field['id'] ); ?>" type="hidden" class="upload_<?php echo esc_attr( $this->field['class'] ); ?>_image" type="text" size="36" name="ad_image" value="<?php echo esc_attr( $this->meta ); ?>" />
<input id="<?php echo esc_attr( $this->field['id'] ); ?>" class="button <?php echo esc_attr( $this->field['class'] ); ?>_image_button" type="button" value="Upload Image" />
<small> <a href="#" id="<?php echo esc_attr( $this->field['id'] ); ?>" class="llms_<?php echo esc_attr( $this->field['class'] ); ?>_clear_image_button">Remove Image</a></small>
<br /><span class="description"><?php echo wp_kses_post( $this->field['desc'] ); ?></span>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.number.php
================================================
<?php
/**
* Meta box Field: Number
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Number_Field class
*
* @since Unknown
*/
class LLMS_Metabox_Number_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @return void
* @since 1.0.0
* @version 3.16.0
*/
public function output() {
global $post;
parent::output();
// Clear an invalid value, usually from a clone or import.
if (
is_numeric( $this->meta ) &&
isset( $this->field['min'] ) &&
is_numeric( $this->field['min'] ) &&
$this->field['min'] > 0 &&
$this->meta < $this->field['min'] ) {
$this->meta = '';
}
?>
<input type="number"
<?php if ( isset( $this->field['min'] ) ) : ?>
min="<?php echo esc_attr( $this->field['min'] ); ?>"
<?php endif; ?>
<?php if ( isset( $this->field['max'] ) ) : ?>
max="<?php echo esc_attr( $this->field['max'] ); ?>"
<?php endif; ?>
name="<?php echo esc_attr( $this->field['id'] ); ?>"
id="<?php echo esc_attr( $this->field['id'] ); ?>"
class="<?php echo esc_attr( $this->field['class'] ); ?>"
value="<?php echo esc_attr( $this->meta ); ?>"
size="30"
<?php if ( isset( $this->field['step'] ) ) : ?>
step="<?php echo esc_attr( $this->field['step'] ); ?>"
<?php endif; ?>
<?php if ( isset( $this->field['required'] ) && $this->field['required'] ) : ?>
required="required"
<?php endif; ?>
/>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.post.content.php
================================================
<?php
/**
* Meta box Field: Content editor
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Post_Content_Field class
*
* @since Unknown
*/
class LLMS_Metabox_Post_Content_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @param array $_field Array containing information about field
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @return void
*/
public function output() {
global $post;
parent::output();
$settings = array(
'textarea_name' => 'content',
'quicktags' => array(
'buttons' => 'em,strong,link',
),
'tinymce' => array(
'theme_advanced_buttons1' => 'bold,italic,strikethrough,separator,bullist,numlist,separator,blockquote,separator,justifyleft,justifycenter,justifyright,separator,link,unlink,separator,undo,redo,separator',
'theme_advanced_buttons2' => '',
),
'editor_css' => '<style>#wp-content-editor-container .wp-editor-area{height:300px; width:100%;}</style>',
'drag_drop_upload' => true,
);
wp_editor( htmlspecialchars_decode( $post->post_content ), 'content', apply_filters( 'lifterlms_course_full_description_editor_settings', $settings ) );
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.post.excerpt.php
================================================
<?php
/**
* Meta box Field: Post Excerpt
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Post_Excerpt_Field class
*
* @since Unknown
*/
class LLMS_Metabox_Post_Excerpt_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @param array $_field Array containing information about field
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @return void
*/
public function output() {
global $post;
parent::output();
$settings = array(
'textarea_name' => 'excerpt',
'quicktags' => array(
'buttons' => 'em,strong,link',
),
'tinymce' => array(
'theme_advanced_buttons1' => 'bold,italic,strikethrough,separator,bullist,numlist,separator,blockquote,separator,justifyleft,justifycenter,justifyright,separator,link,unlink,separator,undo,redo,separator',
'theme_advanced_buttons2' => '',
),
'editor_class' => 'llms-post-editor',
'editor_css' => '<style>#excerpt_ifr{height:300px}#wp-excerpt-editor-container .wp-editor-area{height:300px; width:100%;}</style>',
'drag_drop_upload' => true,
);
wp_editor( htmlspecialchars_decode( $post->post_excerpt ), 'excerpt', apply_filters( 'lifterlms_course_short_description_editor_settings', $settings ) );
echo '<div class="clear"></div>';
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.repeater.php
================================================
<?php
/**
* Meta box Field: Repeater
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since 3.11.0
* @version 3.17.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Meta box Repeater Field class
*
* @since 3.11.0
* @version 3.17.3
*/
class LLMS_Metabox_Repeater_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @param array $_field Array containing information about field
* @since 3.11.0
* @version 3.11.0
*/
public function __construct( $_field ) {
$button_defaults = array(
'classes' => '', // Array or space separated string.
'icon' => 'dashicons-plus', // dashicon classname or HTML/String.
'id' => $_field['id'] . '-add-new',
'style' => 'primary',
'text' => __( 'Add New', 'lifterlms' ),
);
if ( empty( $_field['button'] ) ) {
$_field['button'] = $button_defaults;
} else {
$_field['button'] = wp_parse_args( $_field['button'], $button_defaults );
}
$this->field = $_field;
}
/**
* Retrieve the HTML for the repeater add more button
*
* @return string
* @since 3.11.0
* @version 3.11.0
*/
private function output_button() {
$btn = $this->field['button'];
// Setup class list.
$classes = explode( ' ', $btn['classes'] );
$classes[] = sprintf( 'llms-button-%s', $btn['style'] );
$classes[] = 'llms-repeater-new-btn';
$classes = implode( ' ', $classes );
// Setup icon.
if ( $btn['icon'] && 0 === strpos( $btn['icon'], 'dashicons-' ) ) {
$icon = '<span class="dashicons ' . $btn['icon'] . '"></span> ';
} else {
$icon = $btn['icon'];
}
?>
<button class="<?php echo esc_attr( $classes ); ?>" type="button"><?php echo wp_kses_post( $icon ) . esc_html( $btn['text'] ); ?></button>
<?php
}
private function output_row( $index ) {
?>
<div class="llms-collapsible llms-repeater-row" data-row-order="<?php echo esc_attr( $index ); ?>">
<header class="llms-collapsible-header">
<div class="d-2of3">
<h3 class="llms-repeater-title"><?php echo esc_html( $this->field['header']['default'] ); ?></h3>
</div>
<div class="d-1of3 d-right">
<span class="dashicons dashicons-arrow-down"></span>
<span class="dashicons dashicons-arrow-up"></span>
<span class="dashicons dashicons-menu llms-drag-handle"></span>
<span class="dashicons dashicons-no llms-repeater-remove"></span>
</div>
</header>
<section class="llms-collapsible-body">
<ul class="llms-mb-repeater-fields">
<?php foreach ( $this->field['fields'] as $field ) : ?>
<?php $this->output_sub_field( $field, $index ); ?>
<?php endforeach; ?>
</ul>
</section>
</div>
<?php
}
/**
* Get repeater sub field html output
*
* @return string
* @since 3.11.0
* @version 3.17.3
*/
private function output_sub_field( $field, $index ) {
$field['id'] .= '_' . $index;
if ( isset( $field['controller'] ) ) {
$field['controller'] .= '_' . $index;
}
$name = ucfirst(
strtr(
preg_replace_callback(
'/(\w+)/',
function ( $m ) {
return ucfirst( $m[1] );
},
$field['type']
),
'-',
'_'
)
);
$field_class_name = str_replace( '{TOKEN}', $name, 'LLMS_Metabox_{TOKEN}_Field' );
$field_class = new $field_class_name( $field );
$field_class->output();
}
/**
* Outputs the Html for the given field
*
* @return void
* @since 3.11.0
* @version 3.11.0
*/
public function output() {
global $post;
parent::output();
?>
<div class="llms-repeater-model" id="<?php echo esc_attr( $this->field['id'] ); ?>-model" style="display:none;">
<?php $this->output_row( 'model' ); ?>
</div>
<div class="llms-collapsible-group llms-repeater-rows"></div>
<footer class="llms-mb-repeater-footer">
<?php $this->output_button(); ?>
</footer>
<input class="llms-repeater-field-handler" type="hidden" value="<?php echo esc_attr( $this->field['handler'] ); ?>">
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.search.php
================================================
<?php
/**
* Meta box Field: Search
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Search_Field
*
* @since Unknown
*/
class LLMS_Metabox_Search_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @param array $_field Array containing information about field
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @return void
*/
public function output() {
global $post;
parent::output(); ?>
<select
id="<?php echo esc_attr( $this->field['id'] ); ?>"
name="<?php echo esc_attr( $this->field['id'] ); ?>"
class="<?php echo esc_attr( $this->field['class'] ); ?>"
>
</select>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.select.php
================================================
<?php
/**
* Meta box field: Select.
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Select_Field class.
*
* @since Unknown
*/
class LLMS_Metabox_Select_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor.
*
* @param array $_field Array containing information about field.
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* Outputs the Html for the given field.
*
* @since 1.0.0
* @since 3.1.0 Allow regular key=>val arrays to be passed.
* @since 6.0.0 Added required attribute when required :D.
*
* @return void
*/
public function output() {
global $post;
parent::output();
$name = $this->field['id'];
$allow_null = ( isset( $this->field['allow_null'] ) ) ? $this->field['allow_null'] : true;
if ( array_key_exists( 'multi', $this->field ) ) {
$name .= '[]';
}
$selected = $this->meta;
if ( array_key_exists( 'selected', $this->field ) ) {
$selected = $this->field['selected'];
}
$attrs = isset( $this->field['data_attributes'] ) ? $this->field['data_attributes'] : array();
?>
<select
<?php echo isset( $this->field['is_controller'] ) ? 'data-is-controller="true"' : ''; ?>
id="<?php echo esc_attr( $this->field['id'] ); ?>"
name="<?php echo esc_attr( $name ); ?>"
<?php if ( ! empty( $this->field['required'] ) && ! $allow_null ) : ?>
required="required"
<?php endif; ?>
class="<?php echo esc_attr( $this->field['class'] ); ?>"
<?php if ( array_key_exists( 'multi', $this->field ) && $this->field['multi'] ) : ?>
multiple="multiple"
<?php endif; ?>
<?php
foreach ( $attrs as $attr => $attr_val ) {
echo ' data-' . esc_attr( $attr ) . '="' . esc_attr( $attr_val ) . '"'; }
?>
>
<?php if ( $allow_null ) : ?>
<option value="">None</option>
<?php endif; ?>
<?php if ( isset( $this->field['value'] ) ) : ?>
<?php
foreach ( $this->field['value'] as $key => $option ) :
$is_selected = false;
if ( is_array( $selected ) ) {
if ( in_array( $option['key'], $selected ) ) {
$is_selected = true;
}
} elseif ( isset( $option['key'] ) && $option['key'] == $selected ) {
$is_selected = true;
} elseif ( $key === $selected ) {
$is_selected = true;
}
?>
<option value="<?php echo isset( $option['key'] ) ? esc_attr( $option['key'] ) : esc_attr( $key ); ?>"<?php echo ( $is_selected ? ' selected="selected"' : '' ); ?>><?php echo isset( $option['title'] ) ? esc_html( $option['title'] ) : esc_html( $option ); ?></option>
<?php endforeach; ?>
<?php endif; ?>
</select>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.table.php
================================================
<?php
/**
* Meta box Field: Table
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Table_Field class
*
* @since Unknown
*/
class LLMS_Metabox_Table_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @param array $_field Array containing information about field
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @return void
*/
public function output() {
global $post;
parent::output(); ?>
<table class="llms-table zebra text-left">
<thead>
<?php foreach ( $this->field['titles'] as $title ) : ?>
<th><?php echo wp_kses_post( $title ); ?></th>
<?php endforeach; ?>
</thead>
<tbody>
<?php if ( $this->field['table_data'] ) : ?>
<?php foreach ( $this->field['table_data'] as $row ) : ?>
<tr>
<?php foreach ( $row as $column ) : ?>
<td><?php echo wp_kses_post( $column ); ?></td>
<?php endforeach; ?>
</tr>
<?php endforeach; ?>
<?php elseif ( $this->field['empty_message'] ) : ?>
<tr>
<td colspan="<?php count( $this->field['titles'] ); ?>">
<?php echo wp_kses_post( $this->field['empty_message'] ); ?>
</td>
</tr>
<?php endif; ?>
</tbody>
</table>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.text.php
================================================
<?php
/**
* Meta box Field: Text
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version 3.36.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Text_Field class
*
* @since Unknown
* @since 3.36.0 When outputting the field's value convert quotes (double and single) HTML entities back to characters.
*/
class LLMS_Metabox_Text_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @since 3.36.0 Convert quotes (double and single) HTML entities back to characters.
* @return void
*/
public function output() {
global $post;
parent::output(); ?>
<input type="text"
name="<?php echo esc_attr( $this->field['id'] ); ?>"
id="<?php echo esc_attr( $this->field['id'] ); ?>"
<?php if ( array_key_exists( 'required', $this->field ) && $this->field['required'] ) : ?>
required="required"
<?php endif; ?>
class="<?php echo esc_attr( $this->field['class'] ); ?>"
value="<?php echo esc_attr( $this->meta ); ?>"
size="30"
<?php if ( isset( $this->field['required'] ) && $this->field['required'] ) : ?>
required="required"
<?php endif; ?>
/>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.php
================================================
<?php
/**
* Meta box Field: Textarea
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Textarea_Field class
*
* @since Unknown
*/
class LLMS_Metabox_Textarea_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor
*
* @param array $_field Array containing information about field
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* outputs the Html for the given field
*
* @return void
*/
public function output() {
global $post;
parent::output(); ?>
<textarea name="<?php echo esc_attr( $this->field['id'] ); ?>" id="<?php echo esc_attr( $this->field['id'] ); ?>" cols="60" rows="4"
<?php
if ( isset( $this->field['required'] ) && $this->field['required'] ) :
?>
required="required"<?php endif; ?>><?php echo esc_textarea( $this->meta ); ?></textarea>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.tags.php
================================================
<?php
/**
* Meta box Field: Textarea with Tags.
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Classes
*
* @since Unknown
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Metabox_Textarea_W_Tags_Field class.
*
* @since Unknown
*/
class LLMS_Metabox_Textarea_W_Tags_Field extends LLMS_Metabox_Field implements Meta_Box_Field_Interface {
/**
* Class constructor.
*
* @since Unknown
*
* @param array $_field Array containing information about field.
* @return void
*/
public function __construct( $_field ) {
$this->field = $_field;
}
/**
* Outputs the Html for the given field.
*
* @since Unknown
* @since 6.0.0 Allow displaying a custom value.
* Added options for defining textarea rows and columns.
*
* @return void
*/
public function output() {
parent::output();
$cols = $this->field['cols'] ?? 60;
$rows = $this->field['rows'] ?? 4;
?>
<textarea
name="<?php echo esc_attr( $this->field['id'] ); ?>"
id="<?php echo esc_attr( $this->field['id'] ); ?>"
cols="<?php echo esc_attr( $cols ); ?>"
rows="<?php echo esc_attr( $rows ); ?>"
><?php echo ! empty( $this->field['value'] ) ? esc_textarea( $this->field['value'] ) : esc_textarea( $this->meta ); ?></textarea>
<?php
parent::close_output();
}
}
================================================
FILE: includes/admin/post-types/meta-boxes/fields/llms.interface.meta.box.field.php
================================================
<?php
/**
* Meta box Field interface
*
* @package LifterLMS/Admin/PostTypes/MetaBoxes/Fields/Interfaces
*
* @since unknown
* @version unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* Meta_Box_Field_Interface interface
*
* @since Unknown
*/
interface Meta_Box_Field_Interface {
public function output();
}
================================================
FILE: includes/admin/post-types/meta-boxes/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/post-types/post-tables/class-llms-admin-post-table-achievements.php
================================================
<?php
/**
* LLMS_Admin_Post_Table_Achievement class
*
* @package LifterLMS/Admin/PostTypes/PostTables/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
// TODO: remove this when the new loader will be implemented.
require_once LLMS_PLUGIN_DIR . '/includes/traits/llms-trait-award-templates-post-list-table.php';
/**
* Customize display of the achievement post table.
*
* @since 6.0.0
*/
class LLMS_Admin_Post_Table_Achievements {
use LLMS_Trait_Award_Templates_Post_List_Table;
use LLMS_Trait_User_Engagement_Type;
/**
* Constructor
*
* @since 6.0.0
*
* @return void
*/
public function __construct() {
$this->engagement_type = 'achievement';
$this->award_template_row_actions(); // defined in LLMS_Trait_Award_Templates_Post_List_Table.
}
}
return new LLMS_Admin_Post_Table_Achievements();
================================================
FILE: includes/admin/post-types/post-tables/class-llms-admin-post-table-awards.php
================================================
<?php
/**
* LLMS_Admin_Post_Table_Awards class
*
* @package LifterLMS/Admin/PostTypes/PostTables/Classes
*
* @since 6.0.0
* @version 6.10.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Post table customizations for awarded achievements and certificates.
*
* @since 6.0.0
*/
class LLMS_Admin_Post_Table_Awards {
/**
* Array of supported post types.
*
* @var string[]
*/
private $post_types = array(
'llms_my_achievement',
'llms_my_certificate',
);
/**
* Query string variable used when filtering by the post's parent.
*
* @var string
*/
public const TEMPLATE_FILTER_QUERY_VAR = 'llms_filter_template';
/**
* Constructor
*
* @since 6.0.0
*
* @return void
*/
public function __construct() {
add_filter( 'post_row_actions', array( $this, 'row_actions' ), 1, 2 );
add_filter( 'post_date_column_status', array( $this, 'date_col_status' ), 10, 3 );
foreach ( $this->post_types as $post_type ) {
add_filter( "manage_{$post_type}_posts_columns", array( $this, 'add_cols' ), 10, 1 );
add_action( "manage_{$post_type}_posts_custom_column", array( $this, 'manage_cols' ), 10, 2 );
add_filter( "bulk_actions-edit-{$post_type}", array( $this, 'bulk_actions' ) );
add_filter( "views_edit-{$post_type}", array( $this, 'modify_views' ) );
}
add_filter( 'parse_query', array( $this, 'parse_query' ), 10, 1 );
add_action( 'restrict_manage_posts', array( $this, 'add_filters' ), 10, 2 );
}
/**
* Add post table columns.
*
* @since 6.0.0
*
* @param array $cols Array of post table columns.
* @return array
*/
public function add_cols( $cols ) {
$cols = llms_assoc_array_insert( $cols, 'title', 'user', __( 'User', 'lifterlms' ) );
$cols = llms_assoc_array_insert( $cols, 'user', 'template', __( 'Template', 'lifterlms' ) );
return $cols;
}
/**
* Add filters to the top of the post table
*
* @since 6.0.0
*
* @param string $post_type Post Type of the current posts table.
* @param string $which Positioning of the filters, either "top" or "bottom".
* @return void
*/
public function add_filters( $post_type, $which ) {
if ( 'top' !== $which || ! $this->is_post_type( $post_type ) ) {
return;
}
$template_post_type = str_replace( 'my_', '', $post_type );
$selected = (int) llms_filter_input( INPUT_GET, self::TEMPLATE_FILTER_QUERY_VAR, FILTER_SANITIZE_NUMBER_INT );
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Output is escaped in the function.
echo LLMS_Admin_Post_Tables::get_post_type_filter_html( self::TEMPLATE_FILTER_QUERY_VAR, $template_post_type, $selected );
}
/**
* Manage bulk actions.
*
* Changes the language for "Move to trash" to "Delete permanently" since the post type doesn't support trash.
*
* @since 6.0.0
*
* @param array $actions Array of bulk actions.
* @return array
*/
public function bulk_actions( $actions ) {
if ( ! empty( $actions['trash'] ) ) {
$actions['trash'] = __( 'Delete Permanently', 'lifterlms' );
}
return $actions;
}
/**
* Modify the post status language.
*
* Displays "Awarded" in favor of "Published".
*
* @since 6.0.0
*
* @param string $text Default status text.
* @param WP_Post $post Post object.
* @param string $column_name Column name/id. Hardcoded to `date` in the WP core but
* passing and checking it anyway in case that changes at
* some point.
* @return string
*/
public function date_col_status( $text, $post, $column_name ) {
if ( 'date' === $column_name && $this->is_post_type( $post->post_type ) && 'publish' === $post->post_status ) {
return __( 'Awarded', 'lifterlms' );
}
return $text;
}
/**
* Retrieves the post object given the current screen.
*
* @since 6.0.0
* @since 6.4.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 6.10.0 When no INPUT_GET `post_type` variable set, retrieve the post_type from the `$id` (WP_Post ID) parameter.
*
* @param int $id WP_Post ID.
* @param boolean $template Whether or not a template is being requested.
* @return LLMS_User_Achievement|LLMS_User_Certificate|boolean Returns the object or `false` for invalid post types.
*/
private function get_object( $id, $template = false ) {
$post_type = llms_filter_input( INPUT_GET, 'post_type' );
$post_type = $post_type ? $post_type : get_post_type( $id );
if ( 'llms_my_achievement' === $post_type ) {
return new LLMS_User_Achievement( $id );
} elseif ( 'llms_my_certificate' === $post_type ) {
return llms_get_certificate( $id, $template );
}
return false;
}
/**
* Determines if the specified post type is one of the post types affected by this class.
*
* @since 6.0.0
*
* @param string $post_type A post type to test.
* @return boolean
*/
private function is_post_type( $post_type ) {
return in_array( $post_type, $this->post_types, true );
}
/**
* Manage content of awarded certificate columns.
*
* @since 6.0.0
*
* @param string $column Column key/name.
* @param int $post_id WP Post ID of the llms_my_certificate for the row.
* @return void
*/
public function manage_cols( $column, $post_id ) {
if ( 'template' === $column ) {
$this->manage_cols_template( $post_id );
} elseif ( 'user' === $column ) {
$this->manage_cols_user( $post_id );
}
}
/**
* Output the content for a template column.
*
* @since 6.0.0
*
* @param int $post_id WP_Post ID for the row.
* @return void
*/
private function manage_cols_template( $post_id ) {
$obj = $this->get_object( $post_id );
$parent_id = $obj->get( 'parent' );
$parent = $parent_id ? $this->get_object( $parent_id, true ) : false;
if ( $parent ) {
printf(
'<a href="%1$s">%2$s</a>',
esc_url( get_edit_post_link( $parent_id ) ),
_draft_or_post_title( $parent_id ) // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Output is escaped in the function.
);
} else {
echo '—';
}
}
/**
* Output the content for a user column.
*
* @since 6.0.0
*
* @param int $post_id WP_Post ID for the row.
* @return void
*/
private function manage_cols_user( $post_id ) {
$obj = $this->get_object( $post_id );
$uid = $obj->get_user_id();
$user = $uid ? llms_get_student( $uid ) : false;
if ( $user ) {
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'student_id' => $uid,
)
);
printf(
'<a href="%1$s">%2$s</a>',
esc_url( $url ),
esc_html( $user->get_name() )
);
} else {
echo '—';
}
}
/**
* Removes the trash link for the post table.
*
* We intend these post types to be permanently deleted but due to issues with how the block editor handles
* moving a post to the trash we cannot disable the trash for these post types. Instead, we allow items to be
* moved into the trash and we're hiding the trash link. Items will be deleted automatically via the WP core's
* cron and we've updated "Move to trash" language to "Delete permanently". Users will be able to navigate
* to the trash page and restore from the trash if they can know/guess the link, and that's okay. I guess.
*
* @since 6.0.0
*
* @link https://github.com/WordPress/gutenberg/issues/13024
*
* @param array $views Array of table views.
* @return array
*/
public function modify_views( $views ) {
unset( $views['trash'] );
return $views;
}
/**
* Modify the main WP Query.
*
* @since 6.0.0
*
* @param WP_Query $query The WordPress Query.
* @return WP_Query
*/
public function parse_query( $query ) {
// Only modify admin & main query.
if ( ! ( is_admin() && $query->is_main_query() ) ) {
return $query;
}
// Don't proceed if it's not our post type.
if ( ! isset( $query->query['post_type'] ) || ! $this->is_post_type( $query->query['post_type'] ) ) {
return $query;
}
$template_id = (int) llms_filter_input( INPUT_GET, self::TEMPLATE_FILTER_QUERY_VAR, FILTER_SANITIZE_NUMBER_INT );
// Don't proceed if no template is being filtered.
if ( ! $template_id ) {
return $query;
}
$query->set( 'post_parent', $template_id );
return $query;
}
/**
* Modify post row actions.
*
* @since 6.0.0
* @since 6.10.0 Added missing textdomain for the 'Move {post_title} to the Trash' string.
*
* @param array $actions Existing actions.
* @param WP_Post $post Post object.
* @return array
*/
public function row_actions( $actions, $post ) {
if ( $this->is_post_type( $post->post_type ) && ! empty( $actions['trash'] ) ) {
$actions['trash'] = sprintf(
'<a href="%s" class="submitdelete" aria-label="%s">%s</a>',
get_delete_post_link( $post->ID ),
// Translators: %s: Post title.
esc_attr( sprintf( __( 'Move “%s” to the Trash', 'lifterlms' ), _draft_or_post_title( $post ) ) ),
__( 'Delete Permanently', 'lifterlms' )
);
}
return $actions;
}
}
return new LLMS_Admin_Post_Table_Awards();
================================================
FILE: includes/admin/post-types/post-tables/class-llms-admin-post-table-certificates.php
================================================
<?php
/**
* LLMS_Admin_Post_Table_Certificates class
*
* @package LifterLMS/Admin/PostTypes/PostTables/Classes
*
* @since 6.0.0
* @version 6.2.0
*/
defined( 'ABSPATH' ) || exit;
// TODO: remove this when the new loader will be implemented.
require_once LLMS_PLUGIN_DIR . '/includes/traits/llms-trait-award-templates-post-list-table.php';
/**
* Customize display of the certificate post tables.
*
* @since 6.0.0
*/
class LLMS_Admin_Post_Table_Certificates {
use LLMS_Trait_Award_Templates_Post_List_Table;
use LLMS_Trait_User_Engagement_Type;
/**
* Query string variable used to identify the migration action.
*
* @var string
*/
const MIGRATE_ACTION = 'llms-migrate-legacy-certificate';
/**
* Constructor
*
* @since 6.0.0
*
* @return void
*/
public function __construct() {
$this->engagement_type = 'certificate';
$this->award_template_row_actions(); // defined in LLMS_Trait_Award_Templates_Post_List_Table.
if ( ! llms_is_block_editor_supported_for_certificates() ) {
return;
}
$post_types = array( 'llms_certificate', 'llms_my_certificate' );
if ( in_array( llms_filter_input( INPUT_GET, 'post_type' ), $post_types, true ) ) {
add_filter( 'display_post_states', array( $this, 'add_states' ), 20, 2 );
add_filter( 'post_row_actions', array( $this, 'add_actions' ), 20, 2 );
}
if ( 1 === (int) llms_filter_input( INPUT_GET, self::MIGRATE_ACTION, FILTER_SANITIZE_NUMBER_INT ) ) {
add_filter( 'llms_certificate_template_version', array( $this, 'upgrade_template' ), 10 );
}
add_filter( 'manage_llms_my_certificate_posts_columns', array( $this, 'mod_cols' ), 10, 1 );
}
/**
* Add post row actions.
*
* @since 6.0.0
*
* @param array $actions Array of post row actions.
* @param WP_Post $post Post object for the row.
* @return array
*/
public function add_actions( $actions, $post ) {
$cert = llms_get_certificate( $post, true );
if ( 1 === $cert->get_template_version() ) {
$url = esc_url( add_query_arg( self::MIGRATE_ACTION, 1, get_edit_post_link( $post ) ) );
$actions[ self::MIGRATE_ACTION ] = '<a href="' . $url . '">' . __( 'Migrate legacy certificate', 'lifterlms' ) . '</a>';
}
return $actions;
}
/**
* Add state information denoting the usage of the legacy template.
*
* @since 6.0.0
* @since 6.2.0 Made sure to only process certificates.
*
* @param string[] $states Array of post states.
* @param WP_Post $post Post object.
* @return string[]
*/
public function add_states( $states, $post ) {
$cert = llms_get_certificate( $post, true );
if ( $cert && 1 === $cert->get_template_version() ) {
$states['llms-legacy-template'] = __( 'Legacy', 'lifterlms' );
}
return $states;
}
/**
* Modify the columns list for the `llms_my_certificate` post type.
*
* @since 6.0.0
*
* @param array $cols Array of columns.
* @return array
*/
public function mod_cols( $cols ) {
unset( $cols['author'] );
return $cols;
}
/**
* Callback function for `llms_certificate_template_version` forcing an upgrade to version 2.
*
* @since 6.0.0
*
* @param integer $version Current template version.
* @return integer
*/
public function upgrade_template( $version ) {
return 2;
}
}
return new LLMS_Admin_Post_Table_Certificates();
================================================
FILE: includes/admin/post-types/post-tables/class-llms-admin-post-table-forms.php
================================================
<?php
/**
* Add, Customize, and Manage LifterLMS Forms Post Table Columns
*
* @package LifterLMS/Admin/PostTypes/PostTables/Classes
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Post_Table_Forms
*
* @since 5.0.0
*/
class LLMS_Admin_Post_Table_Forms {
/**
* Constructor
*
* @since 5.0.0
*
* @return void
*/
public function __construct() {
add_filter( 'manage_llms_form_posts_columns', array( $this, 'add_columns' ), 10, 1 );
add_filter( 'bulk_actions-edit-llms_form', array( $this, 'manage_bulk_actions' ), 10, 1 );
add_filter( 'post_row_actions', array( $this, 'manage_post_row_actions' ), 10, 2 );
add_action( 'manage_llms_form_posts_custom_column', array( $this, 'manage_columns' ), 10, 2 );
add_action( 'pre_get_posts', array( 'LLMS_Admin_Post_Table_Forms', 'pre_get_posts' ) );
}
/**
* Add Custom Columns
*
* @since 5.0.0
*
* @param array $columns Array of default columns.
* @return array
*/
public function add_columns( $columns ) {
if ( apply_filters( 'llms_forms_disable_post_table_cb', true ) ) {
unset( $columns['cb'] );
}
return llms_assoc_array_insert( $columns, 'title', 'location', __( 'Location', 'lifterlms' ) );
}
/**
* Manage available bulk actions.
*
* @since 5.0.0
*
* @param array $actions Array of actions.
* @return array
*/
public function manage_bulk_actions( $actions ) {
unset( $actions['edit'] );
return $actions;
}
/**
* Manage content of custom columns
*
* @since 5.0.0
*
* @param string $column Table column name.
* @param int $post_id WP Post ID of the form for the current row.
* @return void
*/
public function manage_columns( $column, $post_id ) {
if ( 'location' === $column ) {
$locs = LLMS_Forms::instance()->get_locations();
$loc = get_post_meta( $post_id, '_llms_form_location', true );
if ( isset( $locs[ $loc ] ) ) {
printf( '<strong>%1$s</strong><br><em>%2$s</em>', esc_html( $locs[ $loc ]['name'] ), esc_html( $locs[ $loc ]['description'] ) );
} else {
echo esc_html( $loc );
}
}
}
/**
* Manage available bulk actions.
*
* @since 5.0.0
* @since 6.4.0 Use `LLMS_Forms::is_a_core_form()` to determine whether a form is a core form and cannot be deleted.
*
* @param array $actions Array of actions.
* @return array
*/
public function manage_post_row_actions( $actions, $post ) {
if ( 'llms_form' !== $post->post_type ) {
return $actions;
}
// Core forms cannot be deleted.
if ( LLMS_Forms::instance()->is_a_core_form( $post ) ) {
unset( $actions['trash'] );
}
unset( $actions['inline hide-if-no-js'] );
$link = get_permalink( $post );
if ( $link ) {
$label = sprintf( __( 'View "%s"', 'lifterlms' ), $post->post_title );
$actions['view'] = sprintf( '<a href="%1$s" rel="bookmark" aria-label="%2$s">%3$s</a>', esc_url( $link ), esc_attr( $label ), esc_html__( 'View', 'lifterlms' ) );
}
return $actions;
}
/**
* Ensure only core forms are displayed in the forms list.
*
* @since 5.0.0
*
* @param WP_Query $query Query object.
* @return void
*/
public static function pre_get_posts( $query ) {
if ( ! function_exists( 'get_current_screen' ) ) {
return;
}
$screen = get_current_screen();
if ( ! $screen || 'edit-llms_form' !== $screen->id || ! $query->is_main_query() ) {
return;
}
$query->set( 'meta_key', '_llms_form_is_core' );
$query->set( 'meta_value', 'yes' );
}
}
return new LLMS_Admin_Post_Table_Forms();
================================================
FILE: includes/admin/post-types/post-tables/class.llms.admin.post.table.coupons.php
================================================
<?php
/**
* Add, Customize, and Manage LifterLMS Coupon Post Table Columns
*
* @package LifterLMS/Admin/PostTypes/PostTables/Classes
*
* @since 3.0.0
* @version 3.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Post_Table_Coupons class
*
* @since 3.0.0
*/
class LLMS_Admin_Post_Table_Coupons {
/**
* Constructor
*
* @return void
*
* @since 3.0.0
*/
public function __construct() {
add_filter( 'manage_llms_coupon_posts_columns', array( $this, 'add_columns' ), 10, 1 );
add_action( 'manage_llms_coupon_posts_custom_column', array( $this, 'manage_columns' ), 10, 2 );
}
/**
* Add Custom Coupon Columns
*
* @param array $columns array of default columns
* @return array
* @since 3.0.0
*/
public function add_columns( $columns ) {
$columns = array(
'cb' => '<input type="checkbox" />',
'title' => __( 'Code', 'lifterlms' ),
'amount' => __( 'Coupon Amount', 'lifterlms' ),
'desc' => __( 'Description', 'lifterlms' ),
'usage' => __( 'Usage / Limit', 'lifterlms' ),
'expiry' => __( 'Expiration Date', 'lifterlms' ),
);
return $columns;
}
/**
* Manage content of custom coupon columns
*
* @param string $column column key/name
* @param int $post_id WP Post ID of the coupon for the row
* @return void
*/
public function manage_columns( $column, $post_id ) {
global $post;
$c = new LLMS_Coupon( $post );
switch ( $column ) {
case 'amount':
esc_html_e( 'Discount: ', 'lifterlms' );
echo wp_kses( $c->get_formatted_amount(), LLMS_ALLOWED_HTML_PRICES );
echo '<br>';
if ( $c->has_trial_discount() ) {
esc_html_e( 'Trial Discount: ', 'lifterlms' );
echo wp_kses( $c->get_formatted_amount( 'trial_amount' ), LLMS_ALLOWED_HTML_PRICES );
echo '<br>';
}
break;
case 'desc':
echo esc_html( $c->get( 'description' ) );
break;
case 'usage':
echo esc_html( $c->get_uses() );
echo ' / ';
echo ( $c->get( 'usage_limit' ) ) ? esc_html( $c->get( 'usage_limit' ) ) : '∞';
break;
case 'expiry':
echo $c->get( 'expiration_date' ) ? esc_html( $c->get_date( 'expiration_date', 'F d, Y' ) ) : '–';
break;
}
}
}
return new LLMS_Admin_Post_Table_Coupons();
================================================
FILE: includes/admin/post-types/post-tables/class.llms.admin.post.table.courses.php
================================================
<?php
/**
* Add, Customize, and Manage LifterLMS Course Post Table Columns
*
* @package LifterLMS/Admin/PostTypes/PostTables/Classes
*
* @since 3.3.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Post_Table_Courses class
*
* @since 3.3.0
* @since 3.24.0 Unknown.
*/
class LLMS_Admin_Post_Table_Courses {
/**
* Constructor.
*
* @since 3.3.0
* @since 3.13.0 Unknown.
* @since 7.1.0 Added new custom columns.
*
* @return void
*/
public function __construct() {
add_filter( 'post_row_actions', array( $this, 'add_links' ), 1, 2 );
add_filter( 'manage_course_posts_columns', array( $this, 'add_columns' ), 10, 1 );
add_action( 'manage_course_posts_custom_column', array( $this, 'manage_columns' ), 10, 2 );
add_filter( 'bulk_actions-edit-course', array( $this, 'register_bulk_actions' ) );
add_filter( 'handle_bulk_actions-edit-course', array( $this, 'handle_bulk_actions' ), 10, 3 );
}
/**
* Add course builder edit link
*
* @param array $actions existing actions
* @param obj $post WP_Post object
* @since 3.13.0
* @version 3.13.1
*/
public function add_links( $actions, $post ) {
if ( 'course' === $post->post_type && current_user_can( 'edit_course', $post->ID ) ) {
$url = add_query_arg(
array(
'page' => 'llms-course-builder',
'course_id' => $post->ID,
),
admin_url( 'admin.php' )
);
$actions = array_merge(
array(
'llms-builder' => '<a href="' . esc_url( $url ) . '">' . __( 'Builder', 'lifterlms' ) . '</a>',
),
$actions
);
}
return $actions;
}
/**
* Exports courses from the Bulk Actions menu on the courses post table
*
* @param string $redirect_to url to redirect to upon export completion (not used)
* @param string $doaction action name called
* @param array $post_ids selected post ids
* @return null
* @since 3.3.0
* @version 3.24.0
*/
public function handle_bulk_actions( $redirect_to, $doaction, $post_ids ) {
// Ensure it's our custom action.
if ( 'llms_export' !== $doaction ) {
return $redirect_to;
}
$data = array(
'_generator' => 'LifterLMS/BulkCourseExporter',
'_source' => get_site_url(),
'_version' => llms()->version,
'courses' => array(),
);
foreach ( $post_ids as $post_id ) {
$c = new LLMS_Course( $post_id );
$data['courses'][] = $c->toArray();
}
$title = str_replace( ' ', '-', __( 'courses export', 'lifterlms' ) );
$title = preg_replace( '/[^a-zA-Z0-9-]/', '', $title );
$filename = apply_filters( 'llms_bulk_export_courses_filename', $title . '_' . current_time( 'Ymd' ), $this );
header( 'Content-type: application/json' );
header( 'Content-Disposition: attachment; filename="' . $filename . '.json"' );
header( 'Pragma: no-cache' );
header( 'Expires: 0' );
echo json_encode( $data );
die;
}
/**
* Register bulk actions
*
* @since 3.3.0
*
* @param array $actions Existing bulk actions.
* @return string[]
*/
public function register_bulk_actions( $actions ) {
$actions['llms_export'] = __( 'Export', 'lifterlms' );
return $actions;
}
/**
* Add custom course columns.
*
* @since 7.1.0
*
* @param array $columns Array of default columns.
* @return array
*/
public function add_columns( $columns ) {
// Add a new column for Lessons.
$new_columns = array();
$new_columns['lessons'] = __( 'Lessons', 'lifterlms' );
// Insert column into third position in existing columns array.
$columns = array_merge( array_slice( $columns, 0, 3 ), $new_columns, array_slice( $columns, 3 ) );
return $columns;
}
/**
* Manage content of custom course columns.
*
* @since 7.1.0
*
* @param string $column Column key/name.
* @param int $post_id WP Post ID of the course for the row.
* @return void
*/
public function manage_columns( $column, $post_id ) {
if ( 'lessons' !== $column ) {
return $column;
}
// Get a count of lessons in the course.
$course = llms_get_post( $post_id );
$lesson_count = $course->get_lessons_count();
if ( ! $lesson_count ) {
echo '–';
return;
}
// Build the URL to link to lesson post type filtered for course ID.
$url = add_query_arg(
array(
'post_status' => 'all',
'post_type' => 'lesson',
'llms_filter_course_id' => $post_id,
),
admin_url( 'edit.php' )
);
// Translators: %d = Number of lessons in the specified course.
$label = sprintf( _n( '%d Lesson', '%d Lessons', $lesson_count, 'lifterlms' ), $lesson_count );
echo '<a href="' . esc_url( $url ) . '">' . esc_html( $label ) . '</a>';
}
}
return new LLMS_Admin_Post_Table_Courses();
================================================
FILE: includes/admin/post-types/post-tables/class.llms.admin.post.table.engagements.php
================================================
<?php
/**
* Add, Customize, and Manage LifterLMS Engagement Post Table Columns
*
* @package LifterLMS/Admin/PostTypes/PostTables/Classes
*
* @since 3.1.0
* @version 3.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Post_Table_Engagements class
*
* @since 3.1.0
* @since 3.7.0 Unknown.
*/
class LLMS_Admin_Post_Table_Engagements {
/**
* Constructor
*
* @return void
* @since 3.1.0
* @version 3.1.0
*/
public function __construct() {
add_filter( 'manage_llms_engagement_posts_columns', array( $this, 'add_columns' ), 10, 1 );
add_action( 'manage_llms_engagement_posts_custom_column', array( $this, 'manage_columns' ), 10, 2 );
}
/**
* Add Custom Coupon Columns
*
* @param array $columns array of default columns
* @return array
* @since 3.1.0
* @version 3.1.0
*/
public function add_columns( $columns ) {
$date = $columns['date'];
unset( $columns['date'] );
$columns['trigger'] = __( 'Trigger', 'lifterlms' );
$columns['type'] = __( 'Type', 'lifterlms' );
$columns['delay'] = __( 'Delay', 'lifterlms' );
$columns['date'] = $date;
return $columns;
}
/**
* Manage content of custom coupon columns
*
* @param string $column column key/name
* @param int $post_id WP Post ID of the coupon for the row
* @return void
* @since 3.1.0
* @version 3.7.0
*/
public function manage_columns( $column, $post_id ) {
switch ( $column ) {
case 'trigger':
$triggers = llms_get_engagement_triggers();
$trigger = get_post_meta( $post_id, '_llms_trigger_type', true );
echo isset( $triggers[ $trigger ] ) ? esc_html( $triggers[ $trigger ] ) : esc_html( $trigger );
$tid = get_post_meta( $post_id, '_llms_engagement_trigger_post', true );
if ( $tid && 'any' !== $tid ) {
echo '<br>';
if ( 'course_track_completed' === $trigger ) {
$term = get_term( $tid, 'course_track' );
$title = $term->name;
$link = get_edit_term_link( $tid, 'course_track', 'course' );
} else {
$title = get_the_title( $tid );
$link = get_edit_post_link( $tid );
}
printf( '<a href="%s">%s (ID# %d)</a>', esc_url( $link ), esc_html( $title ), esc_html( $tid ) );
} elseif ( 'any' === $tid ) {
echo '<br><em>' . esc_html__( 'Any', 'lifterlms' ) . '</em>';
}
break;
case 'type':
$types = llms_get_engagement_types();
$type = get_post_meta( $post_id, '_llms_engagement_type', true );
echo isset( $types[ $type ] ) ? esc_html( $types[ $type ] ) : esc_html( $type );
$eid = get_post_meta( $post_id, '_llms_engagement', true );
if ( $eid ) {
echo '<br>';
printf( '<a href="%s">%s (ID# %d)</a>', esc_url( get_edit_post_link( $eid ) ), esc_html( get_the_title( $eid ) ), esc_html( $eid ) );
}
break;
case 'delay':
$delay = get_post_meta( $post_id, '_llms_engagement_delay', true );
if ( $delay ) {
printf( esc_html__( '%d days', 'lifterlms' ), esc_html( $delay ) );
} else {
echo '–';
}
break;
}
}
}
return new LLMS_Admin_Post_Table_Engagements();
================================================
FILE: includes/admin/post-types/post-tables/class.llms.admin.post.table.instructors.php
================================================
<?php
/**
* Post table stuff for courses and memberships who have custom "instructor" stuff * which replaces "Author"
*
* @package LifterLMS/Admin/PostTypes/PostTables/Classes
*
* @since 3.13.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Post_Table_Instructors class
*
* @since 3.13.0
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
*/
class LLMS_Admin_Post_Table_Instructors {
private $post_types = array(
'course',
'llms_membership',
);
/**
* Constructor
*
* @return void
* @since 3.3.0
* @version 3.13.0
*/
public function __construct() {
foreach ( $this->post_types as $post_type ) {
add_filter( 'manage_' . $post_type . '_posts_columns', array( $this, 'add_columns' ), 10, 1 );
add_action( 'manage_' . $post_type . '_posts_custom_column', array( $this, 'manage_columns' ), 10, 2 );
add_filter( 'views_edit-' . $post_type, array( $this, 'get_views' ), 777, 1 );
}
add_action( 'pre_get_posts', array( $this, 'pre_get_posts' ) );
}
/**
* Add Custom Columns
*
* @param array $columns array of default columns
* @return array
* @since 3.13.0
* @version 3.13.0
*/
public function add_columns( $columns ) {
$offset = array_search( 'title', array_keys( $columns ) );
$add = array(
'llms-instructors' => __( 'Instructors', 'lifterlms' ),
);
return array_slice( $columns, 0, $offset + 1 ) + $add + array_slice( $columns, $offset );
}
/**
* Create a string that can be used in a LIKE query for finding a student's id in the llms_instructors
* meta field on the usermeta table
*
* @param int $user_id WP User ID
* @return string
* @since 3.13.0
* @version 3.13.0
*/
private function get_serialized_id( $user_id ) {
$val = serialize(
array(
'id' => absint( $user_id ),
)
);
return str_replace( array( 'a:1:{', '}' ), '', $val );
}
/**
* Ensure that the "Mine" view quick link at the top of the table displays the correct number
* Most of this is based on WordPress core functions found in wp-admin/includes/class-wp-posts-list-table.php
*
* @since 3.13.0
* @since 3.24.0 Unknown.
* @since 3.35.0 Verify nonces and sanitize `$_POST` data.
* @since 4.5.1 Use `$_GET` data instead of `$_POST`.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param array $views array of view link HTML string
* @return array
*/
public function get_views( $views ) {
$post_type = llms_filter_input_sanitize_string( INPUT_GET, 'post_type' );
$current_user_id = get_current_user_id();
$exclude_states = get_post_stati(
array(
'show_in_admin_all_list' => false,
)
);
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared -- Statuses are sanitized.
$count = intval(
$wpdb->get_var(
$wpdb->prepare(
"
SELECT COUNT( 1 )
FROM $wpdb->posts AS p
JOIN $wpdb->postmeta AS m
ON p.ID = m.post_id
AND m.meta_key = '_llms_instructors'
AND m.meta_value LIKE %s
WHERE p.post_type = %s
AND p.post_status NOT IN ( '" . implode( "','", $exclude_states ) . "' )
",
'%' . $this->get_serialized_id( $current_user_id ) . '%',
$post_type
)
)
);
// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared
$label = sprintf(
_nx(
'Mine <span class="count">(%s)</span>',
'Mine <span class="count">(%s)</span>',
$count,
'posts',
'lifterlms'
),
number_format_i18n( $count )
);
$url = add_query_arg(
array(
'post_type' => $post_type,
'author' => $current_user_id,
),
'edit.php'
);
$class = '';
if ( isset( $_GET['author'] ) && ( $_GET['author'] == $current_user_id ) ) {
$class = 'class="current"';
}
/**
* If mine doesn't already exist in views, we need to add it after "All" manually
* to preserve the user experience.
*/
if ( ! isset( $views['mine'] ) ) {
$offset = array_search( 'all', array_keys( $views ) );
$add = array(
'mine' => '',
);
$views = array_slice( $views, 0, $offset + 1 ) + $add + array_slice( $views, $offset + 1 );
}
$views['mine'] = sprintf( '<a href="%1$s"%2$s>%3$s</a>', esc_url( $url ), $class, $label );
return $views;
}
/**
* Manage content of custom columns
*
* @param string $column column key/name
* @param int $post_id WP Post ID of the coupon for the row
* @return void
* @since 3.13.0
* @version 3.23.0
*/
public function manage_columns( $column, $post_id ) {
$post = llms_get_post( $post_id );
switch ( $column ) {
case 'llms-instructors':
$instructors = $post->get_instructors();
$htmls = array();
foreach ( $instructors as $user ) {
$url = add_query_arg(
array(
'post_type' => $post->get( 'type' ),
'author' => $user['id'],
),
'edit.php'
);
$instructor = llms_get_instructor( $user['id'] );
if ( $instructor ) {
$htmls[] = sprintf( '<a href="%1$s">%2$s</a>', esc_url( $url ), esc_html( $instructor->get( 'display_name' ) ) );
}
}
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped before being put in array.
echo implode( ', ', $htmls );
break;
}
}
/**
* Handle course & membership queries for searching by llms_instructors rather than author
*
* @param obj $query WP_Query
* @return void
* @since 3.13.0
* @version 3.13.0
*/
public function pre_get_posts( $query ) {
if ( ! is_admin() ) {
return;
}
if ( ! $query->is_main_query() ) {
return;
}
// Don't run duplicates.
if ( $query->get( 'llms_instructor_query' ) ) {
return;
}
// phpcs:ignore -- commented out code
// var_dump( $query->query_vars );
if ( isset( $query->query_vars['post_type'] ) && in_array( $query->query_vars['post_type'], $this->post_types ) && ! empty( $query->query_vars['author'] ) ) {
// Get the query or a default to work with.
$meta_query = $query->get( 'meta_query' );
if ( ! $meta_query ) {
$meta_query = array();
}
/**
* Set an and relation for our filters
* if other filters already exist, we'll ensure we obey them as well this way.
*/
$meta_query['relation'] = 'AND';
$meta_query[] = array(
'compare' => 'LIKE',
'key' => '_llms_instructors',
'value' => $this->get_serialized_id( $query->query_vars['author'] ),
);
$query->set( 'meta_query', $meta_query );
$query->set( 'llms_instructor_query', true );
$query->set( 'author', '' );
}
}
}
return new LLMS_Admin_Post_Table_Instructors();
================================================
FILE: includes/admin/post-types/post-tables/class.llms.admin.post.table.lessons.php
================================================
<?php
/**
* Add, Customize, and Manage LifterLMS Lesson posts table Columns
*
* @package LifterLMS/Admin/PostTypes/PostTables/Classes
*
* @since 3.2.3
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Post_Table_Lessons class
*
* @since 3.2.3
* @since 3.24.0 Unknown.
*/
class LLMS_Admin_Post_Table_Lessons {
/**
* Constructor.
*
* @since 3.2.3
* @since 3.12.0 Unknown.
* @since 7.1.0 Added links to the course builder.
*
* @return void
*/
public function __construct() {
add_filter( 'post_row_actions', array( $this, 'add_links' ), 1, 2 );
add_filter( 'manage_lesson_posts_columns', array( $this, 'add_columns' ), 10, 1 );
add_action( 'manage_lesson_posts_custom_column', array( $this, 'manage_columns' ), 10, 2 );
add_action( 'restrict_manage_posts', array( $this, 'add_filters' ), 10, 2 );
add_filter( 'parse_query', array( $this, 'parse_query_filters' ), 10, 1 );
}
/**
* Add course builder edit link.
*
* @since 7.1.0
*
* @param array $actions Existing actions.
* @param WP_Post $post Lesson's WP_Post object.
* @return array
*/
public function add_links( $actions, $post ) {
if ( 'lesson' === $post->post_type && current_user_can( 'edit_lesson', $post->ID ) ) {
$lesson = llms_get_post( $post->ID );
if ( ! $lesson ) {
return $actions;
}
$course = $lesson->get( 'parent_course' );
$url = add_query_arg(
array(
'page' => 'llms-course-builder',
'course_id' => $course,
),
admin_url( 'admin.php' )
);
$url .= sprintf( '#lesson:%d', $post->ID );
$actions = array_merge(
array(
'llms-builder' => '<a href="' . esc_url( $url ) . '">' . __( 'Builder', 'lifterlms' ) . '</a>',
),
$actions
);
}
return $actions;
}
/**
* Add custom lesson columns.
*
* @since 3.2.3
* @since 3.12.0 Unknown.
* @since 7.1.0 Quiz column added.
*
* @param array $columns Array of default columns.
* @return array
*/
public function add_columns( $columns ) {
$columns = array(
'cb' => '<input type="checkbox" />',
'title' => __( 'Lesson Title', 'lifterlms' ),
'course' => __( 'Course', 'lifterlms' ),
'section' => __( 'Section', 'lifterlms' ),
'prereq' => __( 'Prerequisite', 'lifterlms' ),
'quiz' => __( 'Quiz', 'lifterlms' ),
'author' => __( 'Author', 'lifterlms' ),
'date' => __( 'Date', 'lifterlms' ),
);
return $columns;
}
/**
* Add filters to the top of the post table
*
* @since 3.12.0
*
* @param string $post_type Post Type of the current posts table.
* @param string $which Positioning of the filters [top|bottom].
* @return void
*/
public function add_filters( $post_type, $which ) {
// Only for the correct post type & position.
if ( 'lesson' !== $post_type || 'top' !== $which ) {
return;
}
$selected = isset( $_GET['llms_filter_course_id'] ) ? absint( $_GET['llms_filter_course_id'] ) : false;
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Output is escaped in the function.
echo LLMS_Admin_Post_Tables::get_post_type_filter_html( 'llms_filter_course_id', 'course', $selected );
}
/**
* Manage content of custom lesson columns.
*
* @since 3.2.3
* @since 3.24.0 Unknown.
* @since 5.7.0 Replaced the call to the deprecated `LLMS_Lesson::get_parent_course()` method with `LLMS_Lesson::get( 'parent_course' )`.
* @since 7.1.0 Implemented content for the quiz column.
*
* @param string $column Column key/name.
* @param int $post_id WP Post ID of the lesson for the row.
* @return void
*/
public function manage_columns( $column, $post_id ) {
$lesson = llms_get_post( $post_id );
if ( ! $lesson ) {
return;
}
switch ( $column ) {
case 'course':
$course = $lesson->get( 'parent_course' );
$edit_link = get_edit_post_link( $course );
if ( ! empty( $course ) && get_post( $course ) ) {
printf( '<a href="%1$s">%2$s</a>', esc_url( $edit_link ), esc_html( get_the_title( $course ) ) );
}
break;
case 'section':
$section = $lesson->get_parent_section();
if ( ! empty( $section ) ) {
echo esc_html( get_the_title( $section ) );
}
break;
case 'prereq':
if ( $lesson->has_prerequisite() ) {
$prereq = $lesson->get( 'prerequisite' );
$edit_link = get_edit_post_link( $prereq );
if ( $prereq ) {
printf( '<a href="%1$s">%2$s</a>', esc_url( $edit_link ), esc_html( get_the_title( $prereq ) ) );
} else {
echo '–';
}
} else {
echo '–';
}
break;
case 'quiz':
$course = $lesson->get( 'parent_course' );
$url = add_query_arg(
array(
'page' => 'llms-course-builder',
'course_id' => $course,
),
admin_url( 'admin.php' )
);
$url .= sprintf( '#lesson:%d:quiz', $post_id );
if ( $lesson->has_quiz() ) {
$label = __( 'Edit Quiz', 'lifterlms' );
} else {
$label = __( 'Add Quiz', 'lifterlms' );
}
echo '<a href="' . esc_url( $url ) . '">' . esc_html( $label ) . '</a>';
break;
}
}
/**
* Modify the main WP Query
*
* @since 3.12.0
* @since 4.5.1 Bail early if the query has no `post_type` property set.
*
* @param WP_Query $query The WordPress Query.
* @return WP_Query
*/
public function parse_query_filters( $query ) {
// Only modify admin & main query.
if ( ! ( is_admin() && $query->is_main_query() ) ) {
return $query;
}
// Don't proceed if it's not our post type.
if ( ! isset( $query->query['post_type'] ) || 'lesson' !== $query->query['post_type'] ) {
return $query;
}
// If none of our custom filters are set, don't proceed.
if ( ! isset( $_REQUEST['llms_filter_course_id'] ) ) {
return $query;
}
// Get the query or a default to work with.
$meta_query = $query->get( 'meta_query' );
if ( ! $meta_query ) {
$meta_query = array();
}
/**
* Set an and relation for our filters
* if other filters already exist, we'll ensure we obey them as well this way.
*/
$meta_query['relation'] = 'AND';
$meta_query[] = array(
'compare' => '=',
'key' => '_llms_parent_course',
'value' => absint( $_REQUEST['llms_filter_course_id'] ),
);
$query->set( 'meta_query', $meta_query );
return $query;
}
}
return new LLMS_Admin_Post_Table_Lessons();
================================================
FILE: includes/admin/post-types/post-tables/class.llms.admin.post.table.orders.php
================================================
<?php
/**
* Add, Customize, and Manage LifterLMS Order Post Type Post Table Columns.
*
* @package LifterLMS/Admin/PostTypes/PostTables/Classes
*
* @since 3.0.0
* @version 7.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Post_Table_Orders class.
*
* @since 3.0.0
*/
class LLMS_Admin_Post_Table_Orders {
/**
* Constructor.
*
* @since 3.0.0
* @since 3.24.3 Unknown.
*
* @return void
*/
public function __construct() {
add_action( 'load-edit.php', array( $this, 'edit_load' ) );
add_filter( 'manage_llms_order_posts_columns', array( $this, 'add_columns' ), 10, 1 );
add_action( 'manage_llms_order_posts_custom_column', array( $this, 'manage_columns' ), 10, 2 );
add_filter( 'manage_edit-llms_order_sortable_columns', array( $this, 'sortable_columns' ) );
add_filter( 'pre_get_posts', array( $this, 'modify_admin_search' ), 10, 1 );
add_filter( 'post_row_actions', array( $this, 'modify_actions' ), 10, 2 );
}
/**
* Order post. Appends custom columns to post grid.
*
* @since 3.0.0
* @since 3.24.0 Unknown.
*
* @param array $columns Array of columns.
* @return array
*/
public function add_columns( $columns ) {
$columns = array(
'cb' => '<input type="checkbox" />',
'order' => __( 'Order', 'lifterlms' ),
'payment_status' => __( 'Payment Status', 'lifterlms' ),
'access_status' => __( 'Access Status', 'lifterlms' ),
'product' => __( 'Product', 'lifterlms' ),
'revenue' => __( 'Revenue', 'lifterlms' ),
'type' => __( 'Order Type', 'lifterlms' ),
'order_date' => __( 'Date', 'lifterlms' ),
);
return $columns;
}
/**
* Order post: Queries data based on column name.
*
* @since 3.0.0
* @since 3.19.0 Unknown.
* @since 5.4.0 Inform about deleted products.
* @since 7.0.0 Treat the case when the order has no WordPress user associated yet.
*
* @param string $column Custom column name.
* @param int $post_id ID of the individual post.
* @return void
*/
public function manage_columns( $column, $post_id ) {
global $post;
$order = new LLMS_Order( $post_id );
switch ( $column ) {
case 'order':
echo '<a href="' . esc_url( admin_url( 'post.php?post=' . $post_id . '&action=edit' ) ) . '">';
printf( esc_html_x( '#%d', 'order number display', 'lifterlms' ), esc_html( $post_id ) );
echo '</a> ';
esc_html_e( 'by', 'lifterlms' );
echo ' ';
if ( llms_parse_bool( $order->get( 'anonymized' ) ) || empty( llms_get_student( $order->get( 'user_id' ) ) ) ) {
echo esc_html( $order->get_customer_name() );
} else {
$edit_user_link = $order->get( 'user_id' ) ? get_edit_user_link( $order->get( 'user_id' ) ) : '';
echo ! $edit_user_link ? esc_html( $order->get_customer_name() ) . '<br>' : '<a href="' . esc_url( $edit_user_link ) . '">' . esc_html( $order->get_customer_name() ) . '</a><br>';
echo '<a href="' . esc_url( 'mailto:' . $order->get( 'billing_email' ) ) . '">' . esc_html( $order->get( 'billing_email' ) ) . '</a>';
}
break;
case 'payment_status':
$status = $order->get( 'status' );
echo '<span class="llms-status llms-size--large ' . esc_attr( $status ) . ' ">' . esc_html( llms_get_order_status_name( $status ) ) . '</span>';
break;
case 'access_status':
$date = $order->get_access_expiration_date( 'F j, Y' );
$ts = strtotime( $date );
// Timestamp will be false if date is not a date.
if ( $ts ) {
if ( $ts < current_time( 'timestamp' ) ) {
echo esc_html_x( 'Expired:', 'access plan expiration', 'lifterlms' );
} else {
echo esc_html_x( 'Expires:', 'access plan expiration', 'lifterlms' );
}
echo ' ' . esc_html( $date );
} else {
echo esc_html( $date );
}
break;
case 'product':
if ( llms_get_post( $order->get( 'product_id' ) ) ) {
echo '<a href="' . esc_url( get_edit_post_link( $order->get( 'product_id' ) ) ) . '">' . esc_html( $order->get( 'product_title' ) ) . '</a>';
} else {
echo esc_html__( '[DELETED]', 'lifterlms' ) . ' ' . esc_html( $order->get( 'product_title' ) );
}
echo ' (' . esc_html( ucfirst( $order->get( 'product_type' ) ) ) . ')';
break;
case 'revenue':
$grosse = $order->get_revenue( 'grosse' );
$net = $order->get_revenue( 'net' );
if ( $grosse !== $net ) {
echo '<del>' . wp_kses( llms_price( $grosse ), LLMS_ALLOWED_HTML_PRICES ) . '</del> ';
}
echo wp_kses( llms_price( $net ), LLMS_ALLOWED_HTML_PRICES );
break;
case 'type':
if ( $order->is_recurring() ) {
esc_html_e( 'Recurring', 'lifterlms' );
} else {
esc_html_e( 'One-time', 'lifterlms' );
}
break;
case 'order_date':
echo esc_html( $order->get_date( 'date' ) );
break;
}// End switch().
}
/**
* Order post: Creates array of columns that will be sortable.
*
* @since 3.0.0
*
* @param array $columns Array of sortable columns.
* @return array
*/
public function sortable_columns( $columns ) {
$columns['order'] = 'order';
$columns['product'] = 'product';
$columns['order_date'] = 'order_date';
return $columns;
}
/**
* Order post: Adds custom sortable columns to WP request.
*
* @since 3.0.0
*
* @return void
*/
public function edit_load() {
add_filter( 'request', array( $this, 'llms_sort_orders' ) );
}
/**
* Order post: Applies custom query variables for sorting custom columns.
*
* @since 3.0.0
*
* @param array $vars Fost query args.
* @return array
*/
public function llms_sort_orders( $vars ) {
if ( isset( $vars['post_type'] ) && 'llms_order' == $vars['post_type'] ) {
if ( isset( $vars['orderby'] ) && 'order' == $vars['orderby'] ) {
$vars = array_merge(
$vars,
array(
'orderby' => 'ID',
)
);
} elseif ( isset( $vars['orderby'] ) && 'product' == $vars['orderby'] ) {
$vars = array_merge(
$vars,
array(
'meta_key' => '_llms_product_title',
'orderby' => 'meta_value',
)
);
} elseif ( isset( $vars['orderby'] ) && 'order_date' == $vars['orderby'] ) {
$vars = array_merge(
$vars,
array(
'orderby' => 'date',
)
);
}
}
return $vars;
}
/**
* Modify the actions for the orders.
*
* @since 3.0.0
*
* @param array $actions Existing actions.
* @param WP_Post $post Post object.
* @return string[]
*/
public function modify_actions( $actions, $post ) {
if ( 'llms_order' !== $post->post_type ) {
return $actions;
}
unset( $actions['inline hide-if-no-js'] );
return $actions;
}
/**
* Modify the search query for various post types before retrieving posts.
*
* @since 2.5.0
* @since 3.24.3 Unknown
* @since 3.35.0 Sanitize $_GET data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param WP_Query $query Query object.
* @return WP_Query
*/
public function modify_admin_search( $query ) {
// On the admin posts order table.
// Allow searching of custom fields.
if ( is_admin() && ! empty( $query->query_vars['s'] ) && isset( $query->query_vars['post_type'] ) && 'llms_order' === $query->query_vars['post_type'] ) {
// What we are searching for.
$term = $query->query_vars['s'];
// We have to kill this value so that the query actually works.
$query->query_vars['s'] = '';
// Add a filter back in so we don't have 'Search results for ""' on the top of the screen.
// @note we're not super proud of this incredible piece of duct tape.
add_filter(
'get_search_query',
function ( $q ) {
if ( '' === $q ) {
return llms_filter_input_sanitize_string( INPUT_GET, 's' );
}
}
);
if ( is_numeric( $term ) ) {
$query->query_vars['p'] = trim( intval( $term ) );
return $query;
}
// Search wp_users.
$user_query = new WP_User_Query(
array(
'search' => '*' . esc_attr( $term ) . '*',
'search_columns' => array( 'user_login', 'user_url', 'user_email', 'user_nicename', 'display_name' ),
'fields' => 'ID',
)
);
// Search wp_usermeta for First and Last names.
$user_query2 = new WP_User_Query(
array(
'fields' => 'ID',
'meta_query' => array(
'relation' => 'OR',
array(
'key' => 'first_name',
'value' => $term,
'compare' => 'LIKE',
),
array(
'key' => 'last_name',
'value' => $term,
'compare' => 'LIKE',
),
),
)
);
$results = wp_parse_id_list( array_merge( (array) $user_query->get_results(), (array) $user_query2->get_results() ) );
// Add metaquery for the user id.
$meta_query = array(
'relation' => 'OR',
array(
'key' => '_llms_user_id',
'value' => $results,
'compare' => 'IN',
),
);
// Set the query.
$query->set( 'meta_query', $meta_query );
}
return $query;
}
}
return new LLMS_Admin_Post_Table_Orders();
================================================
FILE: includes/admin/post-types/post-tables/class.llms.admin.post.table.pages.php
================================================
<?php
/**
* Customize display of the "Page" post tables
*
* @package LifterLMS/Admin/PostTypes/PostTables/Classes
*
* @since 3.0.0
* @version 3.7.5
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Post_Table_Pages class
*
* @since 3.0.0
* @since 3.7.5 Unknown.
*/
class LLMS_Admin_Post_Table_Pages {
public $pages = array();
/**
* Constructor
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
public function __construct() {
if ( isset( $_GET['post_type'] ) && 'page' === $_GET['post_type'] ) {
add_action( 'init', array( $this, 'populate_pages' ) );
add_filter( 'display_post_states', array( $this, 'post_states' ), 10, 2 );
}
}
public function populate_pages() {
$pages = array(
'checkout' => __( 'LifterLMS Checkout', 'lifterlms' ),
'courses' => __( 'LifterLMS Course Catalog', 'lifterlms' ),
'memberships' => __( 'LifterLMS Memberships Catalog', 'lifterlms' ),
'myaccount' => __( 'LifterLMS Student Dashboard', 'lifterlms' ),
);
foreach ( $pages as $key => $name ) {
$id = llms_get_page_id( $key );
if ( $id ) {
$this->pages[ $id ] = $name;
}
}
}
/**
* Add state information to pages that are set as LifterLMD pages
*
* @param array $states array of post states
* @param obj $post WP_Post object
* @return array
* @since 3.0.0
* @version 3.0.0
*/
public function post_states( $states, $post ) {
if ( isset( $this->pages[ $post->ID ] ) ) {
$states[] = $this->pages[ $post->ID ];
}
return $states;
}
}
return new LLMS_Admin_Post_Table_Pages();
================================================
FILE: includes/admin/post-types/post-tables/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/post-types/tables/class.llms.table.student.management.php
================================================
<?php
/**
* Student Management table on Courses and Memberships
*
* @package LifterLMS/Admin/PostTypes/Tables/Classes
*
* @since 3.4.0
* @version {version}
*/
defined( 'ABSPATH' ) || exit;
/**
* Student Management table on Courses and Memberships class
*
* @since 3.4.0
* @since 3.33.0 Added table action button to delete a cancelled enrollment.
* @since 3.33.0 Added popover tooltip to the table action button icons via llms tooltip data attribute api.
*/
class LLMS_Table_StudentManagement extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'student-management';
/**
* Value of the field being filtered by
* Only applicable if $filterby is set
*
* @var string
*/
protected $filter = 'any';
/**
* Field results are filtered by
*
* @var string
*/
protected $filterby = 'status';
/**
* Determine if the table is filterable
*
* @var boolean
*/
protected $is_filterable = true;
/**
* If true, tfoot will add ajax pagination links
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Determine of the table is searchable
*
* @var boolean
*/
protected $is_searchable = true;
/**
* Results sort order
* 'ASC' or 'DESC'
* Only applicable of $orderby is not set
*
* @var string
*/
protected $order = 'ASC';
/**
* Field results are sorted by
*
* @var string
*/
protected $orderby = 'name';
/**
* Post ID for the current table
*
* @var int
*/
protected $post_id = null;
/**
* Retrieve data for the columns
*
* @since 3.4.0
* @since 3.33.0 Added action button to delete a cancelled enrollment.
* @since 3.33.0 Added icon popover tooltip via llms tooltip data attribute api.
*
* @param string $key The column id / key.
* @param LLMS_Student $student Student object.
* @return mixed
*/
public function get_data( $key, $student ) {
$value = '';
switch ( $key ) {
case 'actions':
if ( $student->is_enrolled( $this->post_id ) ) {
$trigger = $student->get_enrollment_trigger( $this->post_id );
if ( false !== strpos( $trigger, 'order_' ) ) {
$value = '<a class="llms-action-icon tip--top-left" href="' . get_edit_post_link( $student->get_enrollment_trigger_id( $this->post_id ) ) . '" target="_blank" data-tip="' . __( 'Visit the triggering order to manage this student\'s enrollment', 'lifterlms' ) . '"><span class="dashicons dashicons-external"></span></a>';
} else {
if ( current_user_can( 'unenroll' ) ) {
$value = '<a class="llms-action-icon llms-remove-student tip--top-left" data-id="' . $student->get_id() . '" href="#llms-student-remove" data-tip="' . __( 'Cancel Enrollment', 'lifterlms' ) . '"><span class="dashicons dashicons-no"></span></a>';
}
}
} else {
if ( current_user_can( 'enroll' ) ) {
$value = '<a class="llms-action-icon llms-add-student tip--top-left" data-id="' . $student->get_id() . '" href="#llms-student-add" data-tip="' . __( 'Reactivate Enrollment', 'lifterlms' ) . '"><span class="dashicons dashicons-update"></span></a>';
}
if ( current_user_can( 'unenroll' ) ) {
$value .= '<a class="llms-action-icon danger llms-delete-enrollment tip--top-left" data-id="' . $student->get_id() . '" href="#llms-student-delete-enrollment" data-tip="' . __( 'Delete Enrollment', 'lifterlms' ) . '"><span class="dashicons dashicons-trash"></span></a>';
}
}
break;
case 'enrolled':
$value = $student->get_enrollment_date( $this->post_id, 'updated' );
break;
case 'grade':
$value = $student->get_grade( $this->post_id );
break;
case 'id':
$id = $student->get_id();
if ( current_user_can( 'edit_users', $id ) ) {
$value = '<a href="' . esc_url( get_edit_user_link( $id ) ) . '">' . $id . '</a>';
} else {
$value = $id;
}
break;
case 'last_lesson':
$lid = $student->get_last_completed_lesson( $this->post_id );
if ( $lid ) {
$value = $this->get_post_link( $lid, llms_trim_string( get_the_title( $lid ), 30 ) );
} else {
$value = '–';
}
break;
case 'name':
$first = $student->get( 'first_name' );
$last = $student->get( 'last_name' );
if ( ! $first || ! $last ) {
$value = $student->get( 'display_name' );
} else {
$value = $last . ', ' . $first;
}
$url = add_query_arg(
array(
'page' => 'llms-reporting',
'tab' => 'students',
'student_id' => $student->get_id(),
),
admin_url( 'admin.php' )
);
$value = '<a href="' . esc_url( $url ) . '">' . $value . '</a>';
break;
case 'progress':
$value = $student->get_progress( $this->post_id ) . '%';
break;
case 'status':
$value = llms_get_enrollment_status_name( $student->get_enrollment_status( $this->post_id ) );
break;
case 'trigger':
$trigger = $student->get_enrollment_trigger( $this->post_id );
if ( $trigger && false !== strpos( $trigger, 'order_' ) ) {
$tid = $student->get_enrollment_trigger_id( $this->post_id );
$value = $this->get_post_link( $tid, sprintf( __( 'Order #%d', 'lifterlms' ), $tid ) );
} elseif ( $trigger && false !== strpos( $trigger, 'admin_' ) ) {
$tid = $student->get_enrollment_trigger_id( $this->post_id );
$admin = llms_get_student( $tid );
$admin_name = $admin ? $admin->get_name() : __( '[Deleted]', 'lifterlms' );
$value = $this->get_user_link( $tid, sprintf( __( 'Admin: %1$s (#%2$d)', 'lifterlms' ), $admin_name, $tid ) );
} else {
$value = $trigger;
}
break;
default:
$value = $key;
}// End switch().
return $this->filter_get_data( $value, $key, $student );
}
/**
* Retrieve a list of IDs for all the users enrollments
*
* @param obj $student instance of LLMS_Student
* @return array array of course ids
* @since 3.4.0
* @version 3.4.0
*/
private function get_enrollments( $student ) {
$r = array();
$page = 1;
$skip = 0;
while ( true ) {
$courses = $student->get_courses(
array(
'limit' => 5000,
'skip' => 5000 * ( $page - 1 ),
)
);
$r = array_merge( $courses['results'] );
if ( ! $courses['more'] ) {
break;
} else {
$page++;
}
}
return $r;
}
/**
* Get the Text to be used as the placeholder in a searchable tables search input
*
* @return string
* @since 3.4.0
* @version 3.4.0
*/
public function get_table_search_form_placeholder() {
return apply_filters( 'llms_gradebook_get_' . $this->id . '_search_placeholder', __( 'Search students by name or email...', 'lifterlms' ) );
}
/**
* Execute a query to retrieve results from the table
*
* @since 3.4.0
* @since 6.0.0 Don't access `LLMS_Student_Query` properties directly.
*
* @param array $args Array of query args.
* @return void
*/
public function get_results( $args = array() ) {
$this->title = __( 'Manage Existing Enrollments', 'lifterlms' );
if ( ! $args ) {
$args = $this->get_args();
}
$args = $this->clean_args( $args );
$this->post_id = $args['post_id'];
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$this->filter = isset( $args['filter'] ) ? $args['filter'] : $this->get_filter();
$this->filterby = isset( $args['filterby'] ) ? $args['filterby'] : $this->get_filterby();
$this->order = isset( $args['order'] ) ? $args['order'] : $this->get_order();
$this->orderby = isset( $args['orderby'] ) ? $args['orderby'] : $this->get_orderby();
$sort = array();
switch ( $this->get_orderby() ) {
case 'enrolled':
$sort = array(
'date' => $this->get_order(),
'last_name' => 'ASC',
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
case 'id':
$sort = array(
'id' => $this->get_order(),
);
break;
case 'name':
$sort = array(
'last_name' => $this->get_order(),
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
case 'status':
$sort = array(
'status' => $this->get_order(),
'last_name' => 'ASC',
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
}
$query_args = array(
'page' => $this->get_current_page(),
'post_id' => $args['post_id'],
'per_page' => apply_filters( 'llms_' . $this->id . '_table_students_per_page', 20 ),
'sort' => $sort,
);
if ( 'status' === $this->get_filterby() && 'any' !== $this->get_filter() ) {
$query_args['statuses'] = array( $this->get_filter() );
}
if ( isset( $args['search'] ) ) {
$this->search = $args['search'];
$query_args['search'] = $this->get_search();
}
$query = new LLMS_Student_Query( $query_args );
$this->max_pages = $query->get_max_pages();
$this->is_last_page = $query->is_last_page();
$this->tbody_data = $query->get_students();
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @return array
* @since 3.4.0
* @version 3.4.0
*/
public function set_args() {
if ( ! $this->post_id ) {
global $post;
$this->post_id = ! empty( $post->ID ) ? $post->ID : null;
}
return array(
'post_id' => $this->post_id,
);
}
/**
* Define the structure of the table
*
* @return array
* @since 3.4.0
* @version 3.4.0
*/
public function set_columns() {
$cols = array(
'id' => array(
'sortable' => true,
'title' => __( 'ID', 'lifterlms' ),
),
'name' => array(
'sortable' => true,
'title' => __( 'Name', 'lifterlms' ),
),
'status' => array(
'filterable' => llms_get_enrollment_statuses(),
'sortable' => true,
'title' => __( 'Status', 'lifterlms' ),
),
'enrolled' => array(
'sortable' => true,
'title' => __( 'Enrollment Updated', 'lifterlms' ),
),
'progress' => array(
'sortable' => false,
'title' => __( 'Progress', 'lifterlms' ),
),
'grade' => array(
'sortable' => false,
'title' => __( 'Grade', 'lifterlms' ),
),
'last_lesson' => array(
'sortable' => false,
'title' => __( 'Last Lesson', 'lifterlms' ),
),
'trigger' => array(
'sortable' => false,
'title' => __( 'Enrollment Trigger', 'lifterlms' ),
),
'actions' => array(
'sortable' => false,
'title' => ' ',
),
);
$args = $this->get_args();
if ( 'llms_membership' === get_post_type( $args['post_id'] ) ) {
unset( $cols['grade'] );
unset( $cols['progress'] );
unset( $cols['last_lesson'] );
}
return $cols;
}
}
================================================
FILE: includes/admin/post-types/tables/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/reporting/class.llms.admin.reporting.php
================================================
<?php
/**
* Admin Reporting Base Class
*
* @package LifterLMS/Admin/Reporting/Classes
*
* @since 3.2.0
* @version 7.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Reporting Base class.
*
* @since 3.2.0
* @since 3.31.0 Fix redundant `if` statement in the `output_widget` method.
* @since 3.32.0 Added Memberships tab.
* @since 3.32.0 The `output_event()` method now outputs the student's avatar whent in 'membership' context.
* @since 3.35.0 Sanitize input data.
* @since 3.36.3 Fixed sanitization for input data array.
*/
class LLMS_Admin_Reporting {
/**
* Constructor.
*
* @since 3.2.0
*/
public function __construct() {
self::includes();
}
/**
* Get array of course IDs selected according to applied filters.
*
* @since 3.2.0
* @since 3.35.0 Sanitize input data.
* @since 3.36.3 Fixed sanitization for input data array.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return array
*/
public static function get_current_courses() {
$r = isset( $_GET['course_ids'] ) ? llms_filter_input( INPUT_GET, 'course_ids', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY ) : array();
if ( '' === $r ) {
$r = array();
}
if ( is_string( $r ) ) {
$r = array_map( 'absint', explode( ',', $r ) );
}
return $r;
}
/**
* Get array of membership IDs selected according to applied filters.
*
* @since 3.2.0
* @since 3.35.0 Sanitize input data.
* @since 3.36.3 Fixed sanitization for input data array.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return array
*/
public static function get_current_memberships() {
$r = isset( $_GET['membership_ids'] ) ? llms_filter_input( INPUT_GET, 'membership_ids', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY ) : array();
if ( '' === $r ) {
$r = array();
}
if ( is_string( $r ) ) {
$r = array_map( 'absint', explode( ',', $r ) );
}
return $r;
}
/**
* Get the currently selected date range filter.
*
* @since 3.2.0
* @since 3.35.0 Sanitize input data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return string
*/
public static function get_current_range() {
return ( isset( $_GET['range'] ) ) ? llms_filter_input_sanitize_string( INPUT_GET, 'range' ) : 'last-7-days';
}
/**
* Get array of student IDs according to current filters.
*
* @since 3.2.0
* @since 3.35.0 Sanitize input data.
* @since 3.36.3 Fixed sanitization for input data array.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return array
*/
public static function get_current_students() {
$r = isset( $_GET['student_ids'] ) ? llms_filter_input( INPUT_GET, 'student_ids', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY ) : array();
if ( '' === $r ) {
$r = array();
}
if ( is_string( $r ) ) {
$r = array_map( 'absint', explode( ',', $r ) );
}
return $r;
}
/**
* Retrieve the current reporting tab.
*
* @since 3.2.0
* @since 3.35.0 Sanitize input data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return string
*/
public static function get_current_tab() {
return isset( $_GET['tab'] ) ? llms_filter_input_sanitize_string( INPUT_GET, 'tab' ) : 'students';
}
/**
* Get the current end date according to filters.
*
* @since 3.2.0
* @since 3.35.0 Sanitize input data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return string
*/
public static function get_date_end() {
return ( isset( $_GET['date_end'] ) ) ? llms_filter_input_sanitize_string( INPUT_GET, 'date_end' ) : '';
}
/**
* Get the current start date according to filters.
*
* @since 3.2.0
* @since 3.35.0 Sanitize input data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return string
*/
public static function get_date_start() {
return ( isset( $_GET['date_start'] ) ) ? llms_filter_input_sanitize_string( INPUT_GET, 'date_start' ) : '';
}
/**
* Get dates via the current date string.
*
* @since 3.2.0
*
* @param string $range Date range string.
* @return array
*/
public static function get_dates( $range ) {
$now = current_time( 'timestamp' );
$dates = array(
'start' => '',
'end' => date( 'Y-m-d', $now ),
);
switch ( $range ) {
case 'this-year':
$dates['start'] = date( 'Y', $now ) . '-01-01';
break;
case 'last-month':
$dates['start'] = date( 'Y-m-d', strtotime( 'first day of last month', $now ) );
$dates['end'] = date( 'Y-m-d', strtotime( 'last day of last month', $now ) );
break;
case 'this-month':
$dates['start'] = date( 'Y-m', $now ) . '-01';
break;
case 'last-7-days':
$dates['start'] = date( 'Y-m-d', strtotime( '-7 days', $now ) );
break;
case 'custom':
$dates['start'] = self::get_date_start();
$dates['end'] = self::get_date_end();
break;
}
return $dates;
}
/**
* Returns an admin URL with the given arguments added as query variables.
*
* @since 3.2.0
*
* @param array $args Arguments to add to the query string.
* @return string
*/
public static function get_current_tab_url( $args = array() ) {
$args = wp_parse_args(
$args,
array(
'page' => 'llms-reporting',
'tab' => self::get_current_tab(),
)
);
return add_query_arg( $args, admin_url( 'admin.php' ) );
}
/**
* Retrieves arguments for {@see LifterLMS_Admin_Reporting::output_widget}.
*
* Merges the supplied arguments with the default args.
*
* @since 6.11.0
*
* @param array $args Widget settings and data, {@see LifterLMS_Adming_Reporting::output_widget}.
* @return array Merged arguments.
*/
private static function get_output_widget_args( $args = array() ) {
return wp_parse_args(
$args,
array(
'id' => '',
'text' => '',
'data' => '',
'data_compare' => '',
'data_type' => 'numeric', // Enum: numeric, monetary, text, percentage, or date.
'icon' => '',
'impact' => 'positive', // Enum: positive or negative.
'cols' => 'd-1of2',
)
);
}
/**
* Retrieve an array of period filters used by self::output_widget_range_filter().
*
* @since 3.16.0
*
* @return array
*/
public static function get_period_filters() {
return array(
'today' => esc_attr__( 'Today', 'lifterlms' ),
'yesterday' => esc_attr__( 'Yesterday', 'lifterlms' ),
'week' => esc_attr__( 'This Week', 'lifterlms' ),
'last_week' => esc_attr__( 'Last Week', 'lifterlms' ),
'month' => esc_attr__( 'This Month', 'lifterlms' ),
'last_month' => esc_attr__( 'Last Month', 'lifterlms' ),
'year' => esc_attr__( 'This Year', 'lifterlms' ),
'last_year' => esc_attr__( 'Last Year', 'lifterlms' ),
'all_time' => esc_attr__( 'All Time', 'lifterlms' ),
);
}
/**
* Get the full URL to a sub-tab within a reporting screen.
*
* @since 3.2.0
* @since 3.32.0 Added Memberships tab.
* @since 3.35.0 Sanitize input data.
*
* @param string $stab Slug of the sub-tab.
* @return string
*/
public static function get_stab_url( $stab ) {
$args = array(
'page' => 'llms-reporting',
'tab' => self::get_current_tab(),
'stab' => $stab,
);
switch ( self::get_current_tab() ) {
case 'memberships':
$args['membership_id'] = llms_filter_input( INPUT_GET, 'membership_id', FILTER_SANITIZE_NUMBER_INT );
break;
case 'courses':
$args['course_id'] = llms_filter_input( INPUT_GET, 'course_id', FILTER_SANITIZE_NUMBER_INT );
break;
case 'students':
$args['student_id'] = llms_filter_input( INPUT_GET, 'student_id', FILTER_SANITIZE_NUMBER_INT );
break;
case 'quizzes':
$args['quiz_id'] = llms_filter_input( INPUT_GET, 'quiz_id', FILTER_SANITIZE_NUMBER_INT );
break;
}
return add_query_arg( $args, admin_url( 'admin.php' ) );
}
/**
* Get an array of tabs to output in the main reporting menu.
*
* @since 3.2.0
* @since 3.32.0 Added Memberships tab.
*
* @return array
*/
private function get_tabs() {
$tabs = array(
'students' => __( 'Students', 'lifterlms' ),
'courses' => __( 'Courses', 'lifterlms' ),
'memberships' => __( 'Memberships', 'lifterlms' ),
'quizzes' => __( 'Quizzes', 'lifterlms' ),
'sales' => __( 'Sales', 'lifterlms' ),
'enrollments' => __( 'Enrollments', 'lifterlms' ),
);
foreach ( $tabs as $slug => $tab ) {
if ( ! current_user_can( $this->get_tab_cap( $slug ) ) ) {
unset( $tabs[ $slug ] );
}
}
return apply_filters( 'lifterlms_reporting_tabs', $tabs );
}
/**
* Get the WP capability required to access a reporting tab.
*
* Defaults to 'view_lifterlms_reports'. Most reports implement additional permissions within the view.
* Sales & Enrollments tab requires 'view_others_lifterlms_reports' b/c they don't add any additional filters
* within the view.
*
* @since 3.19.4
* @since 7.3.0 Use `in_array()` with strict type comparison.
*
* @param string $tab ID/slug of the tab.
* @return string
*/
private function get_tab_cap( $tab = null ) {
$tab = is_null( $tab ) ? self::get_current_tab() : $tab;
$cap = 'view_lifterlms_reports';
if ( in_array( $tab, array( 'sales', 'enrollments' ), true ) ) {
$cap = 'view_others_lifterlms_reports';
}
/**
* Filters the WP capability required to access a reporting tab.
*
* @since 3.19.4
* @since 7.3.0 Added the `$tab` parameter.
*
* @param string $cap The required WP capability.
* @param string|null $tab ID/slug of the tab.
*/
return apply_filters( 'lifterlms_reporting_tab_cap', $cap, $tab );
}
/**
* Retrieve an array of data to pass to the reporting page template.
*
* @since 3.2.0
*
* @return array
*/
private function get_template_data() {
return array(
'current_tab' => self::get_current_tab(),
'tabs' => $this->get_tabs(),
);
}
/**
* Include all required classes & files for the Reporting screens.
*
* @since 3.2.0
* @since 3.16.0 Unknown.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
public static function includes() {
// Include tab classes.
foreach ( glob( LLMS_PLUGIN_DIR . '/includes/admin/reporting/tabs/*.php' ) as $filename ) {
include_once $filename;
}
}
/**
* Output the reporting screen HTML.
*
* @since 3.2.0
* @since 3.19.4 Unknown.
*
* @return void
*/
public function output() {
if ( ! current_user_can( $this->get_tab_cap() ) ) {
wp_die( esc_html__( 'You don\'t have permission to do that', 'lifterlms' ) );
}
llms_get_template( 'admin/reporting/reporting.php', $this->get_template_data() );
}
/**
* Output the HTML for a postmeta event in the recent events sidebar of various reporting screens.
*
* @since 3.15.0
* @since 3.32.0 Outputs the student's avatar when in 'membership' context.
*
* @param LLMS_User_Postmeta $event Instance of an LLMS_User_Postmeta item.
* @param string $context Optional. Display context [course|student|quiz|membership]. Default 'course'.
* @return void
*/
public static function output_event( $event, $context = 'course' ) {
$student = $event->get_student();
if ( ! $student ) {
return;
}
$url = $event->get_link( $context );
?>
<div class="llms-reporting-event <?php echo esc_attr( $event->get( 'meta_key' ) ); ?> <?php echo esc_attr( $event->get( 'meta_value' ) ); ?>">
<?php if ( $url ) : ?>
<a href="<?php echo esc_url( $url ); ?>">
<?php endif; ?>
<?php if ( 'course' === $context || 'membership' === $context || 'quiz' === $context ) : ?>
<?php echo wp_kses_post( $student->get_avatar( 24 ) ); ?>
<?php endif; ?>
<?php echo wp_kses_post( $event->get_description( $context ) ); ?>
<time datetime="<?php echo esc_attr( $event->get( 'updated_date' ) ); ?>"><?php echo esc_attr( llms_get_date_diff( current_time( 'timestamp' ), $event->get( 'updated_date' ), 1 ) ); ?></time>
<?php if ( $url ) : ?>
</a>
<?php endif; ?>
</div>
<?php
}
/**
* Outputs the HTML for a reporting widget.
*
* @since 3.15.0
* @since 3.31.0 Remove redundant `if` statement.
* @since 6.11.0 Moved HTML into a view file.
* Fixed division by zero error encountered during data comparisons when `$data` is `0`.
* Added a check to ensure only numeric, monetary, or percentage data types will generate comparison data.
* @since 7.3.0 Better rounding of float values of percentage data types.
*
* @param array $args {
* Array of widget options and data to be displayed.
*
* @type string $id Required. A unique identifier for the widget.
* @type string $text A short description of the widget's data.
* @type int|string|float $data The value of the data to display.
* @type int|string|float $data_compare Additional data to compare $data against.
* @type string $data_type The type of data. Used to format displayed data. Accepts "numeric",
* "monetary", "text", "percentage", or "date".
* @type string $icon An optional Font Awesome icon used to help visually identify the widget.
* If supplied, should be supplied without the `fa-` icon prefix.
* @type string $impact The type of impact the data has, either "positive" or "negative". This
* is used when displaying comparisons to determine if the change was a positive
* change or negative change. For example: student enrollments has a positive
* impact while quiz failures has a negative impact. An increase in enrollments
* will be displayed in green while a decrease will be displayed in red. An
* increase in quiz failures will be displayed in red while a decrease will be
* displayed in green.
* @type string $cols Grid class widget width ID. See: assets/scss/admin/partials/_grid.scss.
* }
* @return void
*/
public static function output_widget( $args = array() ) {
$args = self::get_output_widget_args( $args );
// Only these data types can make comparisons.
$can_compare = in_array( $args['data_type'], array( 'numeric', 'monetary', 'percentage' ), true );
// Adds a percentage symbol after data.
$data_after = 'percentage' === $args['data_type'] && is_numeric( $args['data'] ) ? '<sup>%</sup>' : '';
$change = false;
$compare_operator = '';
$compare_class = '';
$compare_title = '';
$floating_precision = llms_get_floats_rounding_precision();
if ( $can_compare && $args['data_compare'] && floatval( $args['data'] ) ) {
$change = round( ( $args['data'] - $args['data_compare'] ) / $args['data'] * 100, $floating_precision );
$compare_operator = ( $change <= 0 ) ? '' : '+';
$compare_title = sprintf(
// Translators: %s = The value of the data from the previous data set.
esc_attr__( 'Previously %s', 'lifterlms' ),
round( $args['data_compare'], $floating_precision ) . wp_strip_all_tags( $data_after )
);
$compare_class = ( $change <= 0 ) ? 'negative' : 'positive';
if ( 'negative' === $args['impact'] ) {
$compare_class = ( $change <= 0 ) ? 'positive' : 'negative';
}
}
if ( is_numeric( $args['data'] ?? '' ) ) {
if ( 'percentage' === $args['data_type'] ) {
$args['data'] = round( $args['data'], $floating_precision );
} elseif ( 'monetary' === $args['data_type'] ) {
$args['data'] = llms_price( $args['data'] );
$args['data_compare'] = llms_price_raw( $args['data_compare'] );
}
}
$args['id'] = esc_attr( $args['id'] );
include LLMS_PLUGIN_DIR . 'includes/admin/views/reporting/widget.php';
}
/**
* Output a range filter select.
*
* Used by overview data tabs
*
* @since 3.16.0
*
* @param string $selected_period Currently selected period.
* @param string $tab Current tab name.
* @param array $args Additional args to be passed when form is submitted.
* @return void
*/
public static function output_widget_range_filter( $selected_period, $tab, $args = array() ) {
?>
<div class="llms-reporting-tab-filter">
<form action="<?php echo esc_url( admin_url( 'admin.php' ) ); ?>" method="GET">
<select class="llms-select2" name="period" onchange="this.form.submit();">
<?php foreach ( self::get_period_filters() as $val => $text ) : ?>
<option value="<?php echo esc_attr( $val ); ?>"<?php selected( $val, $selected_period ); ?>><?php echo esc_html( $text ); ?></option>
<?php endforeach; ?>
</select>
<input type="hidden" name="page" value="llms-reporting">
<input type="hidden" name="tab" value="<?php echo esc_attr( $tab ); ?>">
<?php foreach ( $args as $key => $val ) : ?>
<input type="hidden" name="<?php echo esc_attr( $key ); ?>" value="<?php echo esc_attr( $val ); ?>">
<?php endforeach; ?>
</form>
</div>
<?php
}
}
================================================
FILE: includes/admin/reporting/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/reporting/tables/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/reporting/tables/llms.table.achievements.php
================================================
<?php
/**
* LLMS_Table_Achievements class file
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.2.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Display the student achievements reporting table.
*
* @since 3.2.0
* @since 6.0.0 Allow pagination.
*/
class LLMS_Table_Achievements extends LLMS_Admin_Table {
use LLMS_Trait_Earned_Engagement_Reporting_Table;
/**
* Unique ID for the Table.
*
* @var string
*/
protected $id = 'achievements';
/**
* Instance of LLMS_Student.
*
* @var null
*/
protected $student = null;
/**
* If true, tfoot will add ajax pagination links.
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Get HTML for buttons in the actions cell of the table.
*
* @since 3.18.0
* @since 6.0.0 Show a button to edit earned achievements.
*
* @param int $achievement_id WP Post ID of the achievement post.
* @return void
*/
private function get_actions_html( $achievement_id ) {
ob_start();
?>
<?php if ( get_edit_post_link( $achievement_id ) ) : ?>
<a class="llms-button-secondary small" href="<?php echo esc_url( get_edit_post_link( $achievement_id ) ); ?>">
<?php esc_html_e( 'Edit', 'lifterlms' ); ?>
<i class="fa fa-pencil" aria-hidden="true"></i>
</a>
<?php endif; ?>
<form action="" method="POST" style="display:inline;">
<button type="submit" class="llms-button-danger small" id="llms_delete_achievement" name="llms_delete_achievement">
<?php esc_html_e( 'Delete', 'lifterlms' ); ?>
<i class="fa fa-trash" aria-hidden="true"></i>
</button>
<input type="hidden" name="achievement_id" value="<?php echo absint( $achievement_id ); ?>">
<?php wp_nonce_field( 'llms-achievement-actions', '_llms_achievement_actions_nonce' ); ?>
</form>
<script>document.getElementById( 'llms_delete_achievement' ).onclick = function( e ) {
return window.confirm( '<?php esc_attr_e( 'Are you sure you want to delete this achievement? This action cannot be undone!', 'lifterlms' ); ?>' );
};</script>
<?php
return ob_get_clean();
}
/**
* Retrieve data for the columns.
*
* @since 3.2.0
* @since 3.18.0 Unknown.
* @since 6.0.0 Retrieve earned date using the LLMS_User_Achievement model.
*
* @param string $key The column id / key.
* @param LLMS_User_Achievement $achievement Object of achievement data.
* @return mixed
*/
public function get_data( $key, $achievement ) {
// Handle old object being passed in.
if ( ! is_a( $achievement, 'LLMS_User_Achievement' ) && property_exists( $achievement, 'achievement_id' ) ) {
$achievement = new LLMS_User_Achievement( $achievement->certificate_id );
}
switch ( $key ) {
case 'actions':
$value = $this->get_actions_html( $achievement->get( 'id' ) );
break;
case 'related':
if ( $achievement->get( 'related' ) && 'llms_achievement' !== get_post_type( $achievement->get( 'related' ) ) ) {
if ( is_numeric( $achievement->get( 'related' ) ) ) {
$value = $this->get_post_link( $achievement->get( 'related' ), get_the_title( $achievement->get( 'related' ) ) );
} else {
$value = $achievement->get( 'related' );
}
} else {
$value = '–';
}
break;
case 'earned':
$value = $achievement->get_earned_date();
$value = 'future' === $achievement->get( 'status' ) ? $value . ' ' . __( '(scheduled)', 'lifterlms' ) : $value;
break;
case 'id':
$value = $achievement->get( 'id' );
break;
case 'image':
$src = $achievement->get_image( array( 32, 32 ) );
$value = '<img src="' . esc_url( $src ) . '" alt="' . $achievement->get( 'title' ) . '" width="32" height="32">';
break;
case 'template_id':
// Prior to 3.2 this data wasn't recorded.
$template = $achievement->get( 'parent' );
if ( $template ) {
$value = $this->get_post_link( $template );
} else {
$value = '–';
}
break;
case 'name':
$value = $achievement->get( 'title' );
break;
default:
$value = $key;
}
// Pass the "legacy" object to the filter.
$backwards_compat_obj = array(
'post_id' => $achievement->get( 'related' ),
'achievement_id' => $achievement->get( 'id' ),
'earned_date' => $achievement->get_earned_date(),
);
return $this->filter_get_data( $value, $key, (object) $backwards_compat_obj );
}
/**
* Get table results.
*
* @since Unknown
* @since 6.0.0 Don't use deprecated signature for retrieving achievements.
* Paginate results.
*
* @param array $args Table query arguments.
* @return void
*/
public function get_results( $args = array() ) {
$args = $this->clean_args( $args );
$student_id = is_numeric( $args['student'] ) ? absint( $args['student'] ) : ( $args['student'] ? $args['student']->get_id() : 0 );
if ( $student_id && ! current_user_can( 'view_others_lifterlms_reports' ) && ! llms_current_user_can( 'view_lifterlms_reports', $student_id ) ) {
return;
}
if ( is_numeric( $args['student'] ) ) {
$args['student'] = new LLMS_Student( $args['student'] );
}
$this->student = $args['student'];
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$query = $this->student->get_achievements(
array(
'per_page' => 10,
'status' => array( 'publish', 'future' ),
'paged' => $this->current_page,
'sort' => array(
'date' => 'ASC',
'ID' => 'ASC',
),
)
);
$this->max_pages = $query->get_max_pages();
if ( $this->max_pages > $this->current_page ) {
$this->is_last_page = false;
}
$this->tbody_data = $query->get_awards();
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @since 2.3.0
* @since 3.35.0 Get student ID more reliably.
*
* @return array
*/
public function set_args() {
$student = false;
if ( ! empty( $this->student ) ) {
$student = $this->student->get_id();
} elseif ( ! empty( $_GET['student_id'] ) ) {
$student = llms_filter_input( INPUT_GET, 'student_id', FILTER_SANITIZE_NUMBER_INT );
}
return array(
'student' => $student,
);
}
/**
* Define the structure of the table
*
* @return array
* @since 3.2.0
* @version 3.18.0
*/
protected function set_columns() {
return array(
'id' => __( 'ID', 'lifterlms' ),
'template_id' => __( 'Template ID', 'lifterlms' ),
'name' => __( 'Achievement Title', 'lifterlms' ),
'image' => __( 'Image', 'lifterlms' ),
'earned' => __( 'Earned Date', 'lifterlms' ),
'related' => __( 'Related Post', 'lifterlms' ),
'actions' => '',
);
}
/**
* Empty message displayed when no results are found
*
* @return string
* @since 3.2.0
* @version 3.2.0
*/
protected function set_empty_message() {
return __( 'This student has not yet earned any achievements.', 'lifterlms' );
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.certificates.php
================================================
<?php
/**
* Admin Student Certificates Table
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.2.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Table_Student_Certificates class.
*
* @since 3.2.0
* @since 3.35.0 Get student ID more reliably.
* @since 6.0.0 Allow pagination.
*/
class LLMS_Table_Student_Certificates extends LLMS_Admin_Table {
use LLMS_Trait_Earned_Engagement_Reporting_Table;
/**
* Unique ID for the Table.
*
* @var string
*/
protected $id = 'certificates';
/**
* Instance of LLMS_Student.
*
* @var null
*/
protected $student = null;
/**
* If true, tfoot will add ajax pagination links.
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Get HTML for buttons in the actions cell of the table.
*
* @since 3.18.0
* @since 6.0.0 Show a button to edit earned certificates.
*
* @param int $certificate_id WP Post ID of the llms_my_certificate
* @return void
*/
private function get_actions_html( $certificate_id ) {
ob_start();
?>
<a class="llms-button-secondary small" href="<?php echo esc_url( get_permalink( $certificate_id ) ); ?>" target="_blank">
<?php esc_html_e( 'View', 'lifterlms' ); ?>
<i class="fa fa-external-link" aria-hidden="true"></i>
</a>
<?php if ( get_edit_post_link( $certificate_id ) ) : ?>
<a class="llms-button-secondary small" href="<?php echo esc_url( get_edit_post_link( $certificate_id ) ); ?>">
<?php esc_html_e( 'Edit', 'lifterlms' ); ?>
<i class="fa fa-pencil" aria-hidden="true"></i>
</a>
<?php endif; ?>
<form action="" method="POST" style="display:inline;">
<button type="submit" class="llms-button-secondary small" name="llms_generate_cert">
<?php esc_html_e( 'Download', 'lifterlms' ); ?>
<i class="fa fa-cloud-download" aria-hidden="true"></i>
</button>
<button type="submit" class="llms-button-danger small" id="llms_delete_cert" name="llms_delete_cert">
<?php esc_html_e( 'Delete', 'lifterlms' ); ?>
<i class="fa fa-trash" aria-hidden="true"></i>
</button>
<input type="hidden" name="certificate_id" value="<?php echo absint( $certificate_id ); ?>">
<?php wp_nonce_field( 'llms-cert-actions', '_llms_cert_actions_nonce' ); ?>
</form>
<script>document.getElementById( 'llms_delete_cert' ).onclick = function( e ) {
return window.confirm( '<?php esc_attr_e( 'Are you sure you want to delete this certificate? This action cannot be undone!', 'lifterlms' ); ?>' );
};</script>
<?php
return ob_get_clean();
}
/**
* Retrieve data for the columns.
*
* @since 3.2.0
* @since 3.18.0 Unknown.
* @since 6.0.0 Retrieve date using the LLMS_User_Certificate model.
*
* @param string $key The column id / key.
* @param LLMS_User_Certificate $certificate Object of certificate data.
* @return mixed
*/
public function get_data( $key, $certificate ) {
// Handle old object being passed in.
if ( ! is_a( $certificate, 'LLMS_User_Certificate' ) && property_exists( $certificate, 'certificate_id' ) ) {
$certificate = llms_get_certificate( $certificate->certificate_id );
}
switch ( $key ) {
case 'actions':
$value = $this->get_actions_html( $certificate->get( 'id' ) );
break;
case 'related':
$related = $certificate->get( 'related' );
if ( $related && 'llms_certificate' !== get_post_type( $related ) ) {
if ( is_numeric( $related ) ) {
$value = $this->get_post_link( $related, get_the_title( $related ) );
} else {
$value = $related;
}
} else {
$value = '–';
}
break;
case 'earned':
$value = $certificate->get_earned_date();
$value = 'future' === get_post_status( $certificate->get( 'id' ) ) ? $value . ' ' . __( '(scheduled)', 'lifterlms' ) : $value;
break;
case 'id':
$value = $certificate->get( 'id' );
break;
case 'name':
$value = $certificate->get( 'title' );
break;
case 'template_id':
$template = $certificate->get( 'parent' );
if ( $template ) {
$value = $this->get_post_link( $template );
} else {
$value = '–';
}
break;
default:
$value = $key;
}
// Pass the "legacy" object to the filter.
$backwards_compat_obj = array(
'post_id' => $certificate->get( 'related' ),
'certificate_id' => $certificate->get( 'id' ),
'earned_date' => $certificate->get_earned_date(),
);
return $this->filter_get_data( $value, $key, $backwards_compat_obj );
}
/**
* Get table results.
*
* @since Unknown
* @since 6.0.0 Paginate results.
*
* @param array $args
* @return void
*/
public function get_results( $args = array() ) {
$args = $this->clean_args( $args );
$student_id = is_numeric( $args['student'] ) ? absint( $args['student'] ) : ( $args['student'] ? $args['student']->get_id() : 0 );
if ( $student_id && ! current_user_can( 'view_others_lifterlms_reports' ) && ! llms_current_user_can( 'view_lifterlms_reports', $student_id ) ) {
return;
}
if ( is_numeric( $args['student'] ) ) {
$args['student'] = new LLMS_Student( $args['student'] );
}
$this->student = $args['student'];
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$query = $this->student->get_certificates(
array(
'per_page' => 10,
'status' => array( 'publish', 'future' ),
'paged' => $this->current_page,
'sort' => array(
'date' => 'ASC',
'ID' => 'ASC',
),
)
);
$this->max_pages = $query->get_max_pages();
if ( $this->max_pages > $this->current_page ) {
$this->is_last_page = false;
}
$this->tbody_data = $query->get_awards();
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @since 2.3.0
* @since 3.35.0 Get student ID more reliably.
*
* @return array
*/
public function set_args() {
$student = false;
if ( ! empty( $this->student ) ) {
$student = $this->student->get_id();
} elseif ( ! empty( $_GET['student_id'] ) ) {
$student = llms_filter_input( INPUT_GET, 'student_id', FILTER_SANITIZE_NUMBER_INT );
}
return array(
'student' => $student,
);
}
/**
* Define the structure of the table
*
* @return array
* @since 3.2.0
* @version 3.18.0
*/
protected function set_columns() {
return array(
'id' => __( 'ID', 'lifterlms' ),
'template_id' => __( 'Template ID', 'lifterlms' ),
'name' => __( 'Certificate Title', 'lifterlms' ),
'earned' => __( 'Earned Date', 'lifterlms' ),
'related' => __( 'Related Post', 'lifterlms' ),
'actions' => '',
);
}
/**
* Empty message displayed when no results are found
*
* @return string
* @since 3.2.0
* @version 3.2.0
*/
protected function set_empty_message() {
return __( 'This student has not yet earned any certificates.', 'lifterlms' );
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.course.students.php
================================================
<?php
/**
* Display students enrolled in a given course on the course students subtab
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.2.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Table_Course_Students class
*
* @since 3.15.0
* @version 3.17.6
*/
class LLMS_Table_Course_Students extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'course-students';
/**
* Value of the field being filtered by
* Only applicable if $filterby is set
*
* @var string
*/
protected $filter = 'any';
/**
* Field results are filtered by
*
* @var string
*/
protected $filterby = 'status';
/**
* Is the Table Exportable?
*
* @var boolean
*/
protected $is_exportable = true;
/**
* Determine if the table is filterable
*
* @var boolean
*/
protected $is_filterable = true;
/**
* If true, tfoot will add ajax pagination links
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Determine of the table is searchable
*
* @var boolean
*/
protected $is_searchable = true;
/**
* Results sort order
* 'ASC' or 'DESC'
* Only applicable of $orderby is not set
*
* @var string
*/
protected $order = 'ASC';
/**
* Field results are sorted by
*
* @var string
*/
protected $orderby = 'name';
/**
* Post ID for the current table
*
* @var int
*/
public $course_id = null;
/**
* Retrieve data for the columns
*
* @since 3.15.0
* @since 3.17.2 Unknown.
*
* @param string $key The column id / key.
* @param LLMS_Student $student Student object.
* @return mixed
*/
public function get_data( $key, $student ) {
$value = '';
switch ( $key ) {
case 'completed':
$date = $student->get_completion_date( $this->course_id );
$value = $date ? $date : '—';
break;
case 'enrolled':
$value = $student->get_enrollment_date( $this->course_id, 'updated' );
break;
case 'grade':
$value = $student->get_grade( $this->course_id );
if ( is_numeric( $value ) ) {
$value .= '%';
}
break;
case 'id':
$id = $student->get_id();
if ( current_user_can( 'edit_users', $id ) ) {
$value = '<a href="' . esc_url( get_edit_user_link( $id ) ) . '">' . $id . '</a>';
} else {
$value = $id;
}
break;
case 'last_lesson':
$lid = $student->get_last_completed_lesson( $this->course_id );
if ( $lid ) {
$value = $this->get_post_link( $lid, llms_trim_string( get_the_title( $lid ), 30 ) );
} else {
$value = '–';
}
break;
case 'name':
$first = $student->get( 'first_name' );
$last = $student->get( 'last_name' );
if ( ! $first || ! $last ) {
$value = $student->get( 'display_name' );
} else {
$value = $last . ', ' . $first;
}
$url = add_query_arg(
array(
'page' => 'llms-reporting',
'tab' => 'students',
'student_id' => $student->get_id(),
'stab' => 'courses',
'course_id' => $this->course_id,
),
admin_url( 'admin.php' )
);
$value = '<a href="' . esc_url( $url ) . '">' . $value . '</a>';
break;
case 'progress':
$value = $this->get_progress_bar_html( $student->get_progress( $this->course_id ) );
break;
case 'status':
$value = llms_get_enrollment_status_name( $student->get_enrollment_status( $this->course_id ) );
break;
default:
$value = $key;
}// End switch().
return $this->filter_get_data( $value, $key, $student );
}
/**
* Retrieve data for a cell in an export file
* Should be overridden in extending classes
*
* @param string $key the column id / key
* @param obj $student Instance of the LLMS_Student
* @return mixed
* @since 3.15.0
* @version 3.15.0
*/
public function get_export_data( $key, $student ) {
switch ( $key ) {
case 'id':
$value = $student->get_id();
break;
case 'email':
$value = $student->get( 'user_email' );
break;
case 'name_first':
$value = $student->get( 'first_name' );
break;
case 'name_last':
$value = $student->get( 'last_name' );
break;
case 'progress':
$value = $student->get_progress( $this->course_id ) . '%';
break;
default:
$value = $this->get_data( $key, $student );
}// End switch().
return $this->filter_get_data( $value, $key, $student, 'export' );
}
/**
* Get a lock key unique to the table & user for locking the table during export generation
*
* @return string
* @since 3.15.0
* @version 3.15.0
*/
public function get_export_lock_key() {
$args = $this->get_args();
return sprintf( '%1$s:%2$d:%3$d', $this->id, get_current_user_id(), $args['course_id'] );
}
/**
* Allow customization of the title for export files
*
* @param array $args optional arguments passed from table to csv processor
* @return string
* @since 3.15.0
* @version 3.15.0
*/
public function get_export_title( $args = array() ) {
$title = $this->get_title();
if ( isset( $args['course_id'] ) ) {
$title = get_the_title( $args['course_id'] ) . ' ' . $title;
}
return apply_filters( 'llms_table_get_' . $this->id . '_export_title', $title );
}
/**
* Get the Text to be used as the placeholder in a searchable tables search input
*
* @return string
* @since 3.15.0
* @version 3.15.0
*/
public function get_table_search_form_placeholder() {
return apply_filters( 'llms_reporting_get_' . $this->id . '_search_placeholder', __( 'Search students by name or email...', 'lifterlms' ) );
}
/**
* Execute a query to retrieve results from the table.
*
* @since 3.15.0
* @since 5.10.0 Add ability to sort by completion date.
* @since 6.0.0 Don't access `LLMS_Student_Query` properties directly.
* @since 9.2.3 Added object-level authorization check on the course.
*
* @param array $args Array of query args.
* @return void
*/
public function get_results( $args = array() ) {
$this->title = __( 'Students', 'lifterlms' );
if ( ! $args ) {
$args = $this->get_args();
}
$args = $this->clean_args( $args );
if ( ! current_user_can( 'view_others_lifterlms_reports' ) && ! current_user_can( 'edit_post', absint( $args['course_id'] ) ) ) {
return;
}
$this->course_id = $args['course_id'];
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$this->filter = isset( $args['filter'] ) ? $args['filter'] : $this->get_filter();
$this->filterby = isset( $args['filterby'] ) ? $args['filterby'] : $this->get_filterby();
$this->order = isset( $args['order'] ) ? $args['order'] : $this->get_order();
$this->orderby = isset( $args['orderby'] ) ? $args['orderby'] : $this->get_orderby();
$sort = array();
switch ( $this->get_orderby() ) {
case 'completed':
$sort = array(
'completed' => $this->get_order(),
'last_name' => 'ASC',
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
case 'enrolled':
$sort = array(
'date' => $this->get_order(),
'last_name' => 'ASC',
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
case 'id':
$sort = array(
'id' => $this->get_order(),
);
break;
case 'name':
$sort = array(
'last_name' => $this->get_order(),
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
case 'status':
$sort = array(
'status' => $this->get_order(),
'last_name' => 'ASC',
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
}
$query_args = array(
'page' => $this->get_current_page(),
'post_id' => $args['course_id'],
'per_page' => apply_filters( 'llms_' . $this->id . '_table_students_per_page', 25 ),
'sort' => $sort,
);
if ( 'status' === $this->get_filterby() && 'any' !== $this->get_filter() ) {
$query_args['statuses'] = array( $this->get_filter() );
}
if ( isset( $args['search'] ) ) {
$this->search = $args['search'];
$query_args['search'] = $this->get_search();
}
$query = new LLMS_Student_Query( $query_args );
$this->max_pages = $query->get_max_pages();
$this->is_last_page = $query->is_last_page();
$this->tbody_data = $query->get_students();
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @return array
* @since 3.15.0
* @version 3.15.0
*/
public function set_args() {
if ( ! $this->course_id ) {
$this->course_id = ! empty( $_GET['course_id'] ) ? absint( $_GET['course_id'] ) : null;
}
return array(
'course_id' => $this->course_id,
);
}
/**
* Define the structure of the table
*
* @return array
* @since 3.15.0
* @version 3.16.11
*/
public function set_columns() {
$cols = array(
'id' => array(
'exportable' => true,
'sortable' => true,
'title' => __( 'ID', 'lifterlms' ),
),
'name' => array(
'sortable' => true,
'title' => __( 'Name', 'lifterlms' ),
),
'name_last' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Last Name', 'lifterlms' ),
),
'name_first' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'First Name', 'lifterlms' ),
),
'email' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Email', 'lifterlms' ),
),
'status' => array(
'exportable' => true,
'filterable' => llms_get_enrollment_statuses(),
'sortable' => true,
'title' => __( 'Status', 'lifterlms' ),
),
'enrolled' => array(
'exportable' => true,
'sortable' => true,
'title' => __( 'Enrollment Updated', 'lifterlms' ),
),
'completed' => array(
'exportable' => true,
'sortable' => true,
'title' => __( 'Completed', 'lifterlms' ),
),
'progress' => array(
'exportable' => true,
'sortable' => false,
'title' => __( 'Progress', 'lifterlms' ),
),
'grade' => array(
'exportable' => true,
'sortable' => false,
'title' => __( 'Grade', 'lifterlms' ),
),
'last_lesson' => array(
'sortable' => false,
'title' => __( 'Last Lesson', 'lifterlms' ),
),
);
return $cols;
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.courses.php
================================================
<?php
/**
* Courses Reporting Table
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.15.0
* @version 3.16.14
*/
defined( 'ABSPATH' ) || exit;
/**
* Courses Reporting Table class
*
* @since 3.15.0
* @version 3.16.14
*/
class LLMS_Table_Courses extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'courses';
/**
* Value of the field being filtered by
* Only applicable if $filterby is set
*
* @var string
*/
protected $filter = 'any';
/**
* Field results are filtered by
*
* @var string
*/
protected $filterby = 'instructor';
/**
* Is the Table Exportable?
*
* @var boolean
*/
protected $is_exportable = true;
/**
* Determine if the table is filterable
*
* @var boolean
*/
protected $is_filterable = true;
/**
* If true, tfoot will add ajax pagination links
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Determine of the table is searchable
*
* @var boolean
*/
protected $is_searchable = true;
/**
* Results sort order
* 'ASC' or 'DESC'
* Only applicable of $orderby is not set
*
* @var string
*/
protected $order = 'ASC';
/**
* Field results are sorted by
*
* @var string
*/
protected $orderby = 'title';
/**
* Retrieve data for a cell
*
* @param string $key the column id / key
* @param mixed $data object / array of data that the function can use to extract the data
* @return mixed
* @since 3.15.0
* @version 3.15.0
*/
protected function get_data( $key, $data ) {
$course = llms_get_post( $data );
switch ( $key ) {
case 'grade':
$value = $course->get( 'average_grade' ) . '%';
break;
case 'id':
$value = $this->get_post_link( $course->get( 'id' ) );
break;
case 'instructors':
$data = array();
foreach ( $course->get_instructors() as $info ) {
$instructor = llms_get_instructor( $info['id'] );
if ( $instructor ) {
$data[] = sprintf( '%1$s (%2$s)', $instructor->get( 'display_name' ), $info['label'] );
}
}
$value = implode( ', ', $data );
break;
case 'progress':
$value = $this->get_progress_bar_html( $course->get( 'average_progress' ) );
break;
case 'students':
$value = number_format_i18n( $course->get_student_count(), 0 );
break;
case 'title':
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'tab' => 'courses',
'course_id' => $course->get( 'id' ),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . $course->get( 'title' ) . '</a>';
break;
default:
$value = $key;
}// End switch().
return $value;
}
/**
* Retrieve a list of Instructors to be used for Filtering
*
* @return array
* @since 3.15.0
* @version 3.15.0
*/
private function get_instructor_filters() {
$query = get_users(
array(
'fields' => array( 'ID', 'display_name' ),
'meta_key' => 'last_name',
'orderby' => 'meta_value',
'role__in' => array( 'administrator', 'lms_manager', 'instructor', 'instructors_assistant' ),
)
);
$instructors = wp_list_pluck( $query, 'display_name', 'ID' );
return $instructors;
}
/**
* Execute a query to retrieve results from the table
*
* @param array $args array of query args
* @return void
* @since 3.15.0
* @version 3.16.14
*/
public function get_results( $args = array() ) {
$this->title = __( 'Courses', 'lifterlms' );
$args = $this->clean_args( $args );
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$per = apply_filters( 'llms_reporting_' . $this->id . '_per_page', 25 );
$this->order = isset( $args['order'] ) ? $args['order'] : $this->order;
$this->orderby = isset( $args['orderby'] ) ? $args['orderby'] : $this->orderby;
$this->filter = isset( $args['filter'] ) ? $args['filter'] : $this->get_filter();
$this->filterby = isset( $args['filterby'] ) ? $args['filterby'] : $this->get_filterby();
$query_args = array(
'order' => $this->order,
'orderby' => $this->orderby,
'paged' => $this->current_page,
'post_status' => array( 'publish', 'private' ),
'post_type' => 'course',
'posts_per_page' => $per,
);
if ( 'any' !== $this->filter ) {
$serialized_id = serialize(
array(
'id' => absint( $this->filter ),
)
);
$serialized_id = str_replace( array( 'a:1:{', '}' ), '', $serialized_id );
$query_args['meta_query'] = array(
array(
'compare' => 'LIKE',
'key' => '_llms_instructors',
'value' => $serialized_id,
),
);
}
if ( 'progress' === $this->orderby ) {
$query_args['meta_key'] = '_llms_average_progress';
$query_args['orderby'] = 'meta_value_num';
} elseif ( 'grade' === $this->orderby ) {
$query_args['meta_key'] = '_llms_average_progress';
$query_args['orderby'] = 'meta_value_num';
}
if ( isset( $args['search'] ) ) {
$query_args['s'] = sanitize_text_field( $args['search'] );
}
// If you can view others reports, make a regular query.
if ( current_user_can( 'view_others_lifterlms_reports' ) ) {
$query = new WP_Query( $query_args );
// User can only see their own reports, get a list of their students.
} elseif ( current_user_can( 'view_lifterlms_reports' ) ) {
$instructor = llms_get_instructor();
if ( ! $instructor ) {
return;
}
$query = $instructor->get_courses( $query_args, 'query' );
} else {
return;
}
$this->max_pages = $query->max_num_pages;
if ( $this->max_pages > $this->current_page ) {
$this->is_last_page = false;
}
$this->tbody_data = $query->posts;
}
/**
* Get the Text to be used as the placeholder in a searchable tables search input
*
* @return string
* @since 3.2.0
* @version 3.2.0
*/
public function get_table_search_form_placeholder() {
return apply_filters( 'llms_table_get_' . $this->id . '_search_placeholder', __( 'Search courses...', 'lifterlms' ) );
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @return array
* @since 3.15.0
* @version 3.15.0
*/
public function set_args() {
return array();
}
/**
* Define the structure of the table
*
* @return array
* @since 3.15.0
* @version 3.15.0
*/
protected function set_columns() {
return array(
'id' => array(
'exportable' => true,
'title' => __( 'ID', 'lifterlms' ),
'sortable' => true,
),
'title' => array(
'exportable' => true,
'title' => __( 'Title', 'lifterlms' ),
'sortable' => true,
),
'instructors' => array(
'exportable' => true,
'filterable' => current_user_can( 'view_others_lifterlms_reports' ) ? $this->get_instructor_filters() : false,
'title' => __( 'Instructors', 'lifterlms' ),
),
'students' => array(
'exportable' => true,
'title' => __( 'Students', 'lifterlms' ),
),
'progress' => array(
'exportable' => true,
'title' => __( 'Average Progress', 'lifterlms' ),
'sortable' => true,
),
'grade' => array(
'exportable' => true,
'title' => __( 'Average Grade', 'lifterlms' ),
'sortable' => true,
),
);
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.membership.students.php
================================================
<?php
/**
* Display students enrolled in a given membership on the membership students subtab
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.32.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Table_Membership_Students class
*
* @since 3.32.0
*/
class LLMS_Table_Membership_Students extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @since 3.32.0
*
* @var string
*/
protected $id = 'membership-students';
/**
* Value of the field being filtered by
* Only applicable if $filterby is set.
*
* @since 3.32.0
*
* @var string
*/
protected $filter = 'any';
/**
* Field results are filtered by.
*
* @since 3.32.0
*
* @var string
*/
protected $filterby = 'status';
/**
* Is the Table Exportable?
*
* @since 3.32.0
*
* @var boolean
*/
protected $is_exportable = true;
/**
*
* @since 3.32.0
*
* Determine if the table is filterable.
* @var boolean
*/
protected $is_filterable = true;
/**
* If true, tfoot will add ajax pagination links.
*
* @since 3.32.0
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Determine of the table is searchable.
*
* @since 3.32.0
*
* @var boolean
*/
protected $is_searchable = true;
/**
* Results sort order 'ASC' or 'DESC'.
* Only applicable of $orderby is not set.
*
* @since 3.32.0
*
* @var string
*/
protected $order = 'ASC';
/**
* Field results are sorted by.
*
* @since 3.32.0
*
* @var string
*/
protected $orderby = 'name';
/**
* Post ID for the current table.
*
* @since 3.32.0
*
* @var int
*/
public $membership_id = null;
/**
* Retrieve data for the columns
*
* @since 3.32.0
*
* @param string $key The column id / key.
* @param LLMS_Student $student Student object.
* @return mixed
*/
public function get_data( $key, $student ) {
$value = '';
switch ( $key ) {
case 'enrolled':
$value = $student->get_enrollment_date( $this->membership_id, 'updated' );
break;
case 'id':
$id = $student->get_id();
if ( current_user_can( 'edit_users', $id ) ) {
$value = '<a href="' . esc_url( get_edit_user_link( $id ) ) . '">' . $id . '</a>';
} else {
$value = $id;
}
break;
case 'name':
$first = $student->get( 'first_name' );
$last = $student->get( 'last_name' );
if ( ! $first || ! $last ) {
$value = $student->get( 'display_name' );
} else {
$value = $last . ', ' . $first;
}
$url = add_query_arg(
array(
'page' => 'llms-reporting',
'tab' => 'students',
'student_id' => $student->get_id(),
'stab' => 'memberships',
'membership_id' => $this->membership_id,
),
admin_url( 'admin.php' )
);
$value = '<a href="' . esc_url( $url ) . '">' . $value . '</a>';
break;
case 'status':
$value = llms_get_enrollment_status_name( $student->get_enrollment_status( $this->membership_id ) );
break;
default:
$value = $key;
}// End switch().
return $this->filter_get_data( $value, $key, $student );
}
/**
* Retrieve data for a cell in an export file.
* Should be overridden in extending classes.
*
* @since 3.32.0
*
* @param string $key The column id / key.
* @param obj $student Instance of the LLMS_Student.
* @return mixed
*/
public function get_export_data( $key, $student ) {
switch ( $key ) {
case 'id':
$value = $student->get_id();
break;
case 'email':
$value = $student->get( 'user_email' );
break;
case 'name_first':
$value = $student->get( 'first_name' );
break;
case 'name_last':
$value = $student->get( 'last_name' );
break;
default:
$value = $this->get_data( $key, $student );
}// End switch().
return $this->filter_get_data( $value, $key, $student, 'export' );
}
/**
* Get a lock key unique to the table & user for locking the table during export generation.
*
* @since 3.32.0
*
* @return string
*/
public function get_export_lock_key() {
$args = $this->get_args();
return sprintf( '%1$s:%2$d:%3$d', $this->id, get_current_user_id(), $args['membership_id'] );
}
/**
* Allow customization of the title for export files.
*
* @since 3.32.0
*
* @param array $args Optional. Array of arguments passed from table to csv processor. Default empty array.
* @return string
*/
public function get_export_title( $args = array() ) {
$title = $this->get_title();
if ( isset( $args['membership_id'] ) ) {
$title = get_the_title( $args['membership_id'] ) . ' ' . $title;
}
return apply_filters( 'llms_table_get_' . $this->id . '_export_title', $title );
}
/**
* Get the Text to be used as the placeholder in a searchable tables search input.
*
* @since 3.32.0
*
* @return string
*/
public function get_table_search_form_placeholder() {
return apply_filters( 'llms_reporting_get_' . $this->id . '_search_placeholder', __( 'Search students by name or email...', 'lifterlms' ) );
}
/**
* Execute a query to retrieve results from the table.
*
* @since 3.32.0
* @since 6.0.0 Don't access `LLMS_Student_Query` properties directly.
* @since 9.2.3 Added object-level authorization check on the membership.
*
* @param array $args Optional. Array of query args. Default empty array.
* @return void
*/
public function get_results( $args = array() ) {
$this->title = __( 'Students', 'lifterlms' );
if ( ! $args ) {
$args = $this->get_args();
}
$args = $this->clean_args( $args );
if ( ! current_user_can( 'view_others_lifterlms_reports' ) && ! current_user_can( 'edit_post', absint( $args['membership_id'] ) ) ) {
return;
}
$this->membership_id = $args['membership_id'];
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$this->filter = isset( $args['filter'] ) ? $args['filter'] : $this->get_filter();
$this->filterby = isset( $args['filterby'] ) ? $args['filterby'] : $this->get_filterby();
$this->order = isset( $args['order'] ) ? $args['order'] : $this->get_order();
$this->orderby = isset( $args['orderby'] ) ? $args['orderby'] : $this->get_orderby();
$sort = array();
switch ( $this->get_orderby() ) {
case 'enrolled':
$sort = array(
'date' => $this->get_order(),
'last_name' => 'ASC',
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
case 'id':
$sort = array(
'id' => $this->get_order(),
);
break;
case 'name':
$sort = array(
'last_name' => $this->get_order(),
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
case 'status':
$sort = array(
'status' => $this->get_order(),
'last_name' => 'ASC',
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
}
$query_args = array(
'page' => $this->get_current_page(),
'post_id' => $args['membership_id'],
'per_page' => apply_filters( 'llms_' . $this->id . '_table_students_per_page', 25 ),
'sort' => $sort,
);
if ( 'status' === $this->get_filterby() && 'any' !== $this->get_filter() ) {
$query_args['statuses'] = array( $this->get_filter() );
}
if ( isset( $args['search'] ) ) {
$this->search = $args['search'];
$query_args['search'] = $this->get_search();
}
$query = new LLMS_Student_Query( $query_args );
$this->max_pages = $query->get_max_pages();
$this->is_last_page = $query->is_last_page();
$this->tbody_data = $query->get_students();
}
/**
* Define the structure of arguments used to pass to the get_results method.
*
* @since 3.32.0
*
* @return array
*/
public function set_args() {
if ( ! $this->membership_id ) {
$this->membership_id = ! empty( $_GET['membership_id'] ) ? absint( $_GET['membership_id'] ) : null;
}
return array(
'membership_id' => $this->membership_id,
);
}
/**
* Define the structure of the table
*
* @since 3.32.0
*
* @return array
*/
public function set_columns() {
$cols = array(
'id' => array(
'exportable' => true,
'sortable' => true,
'title' => __( 'ID', 'lifterlms' ),
),
'name' => array(
'sortable' => true,
'title' => __( 'Name', 'lifterlms' ),
),
'name_last' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Last Name', 'lifterlms' ),
),
'name_first' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'First Name', 'lifterlms' ),
),
'email' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Email', 'lifterlms' ),
),
'status' => array(
'exportable' => true,
'filterable' => llms_get_enrollment_statuses(),
'sortable' => true,
'title' => __( 'Status', 'lifterlms' ),
),
'enrolled' => array(
'exportable' => true,
'sortable' => true,
'title' => __( 'Enrollment Updated', 'lifterlms' ),
),
);
return $cols;
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.memberships.php
================================================
<?php
/**
* Memberships Reporting Table
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.32.0
* @version 3.32.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Memberships Reporting Table class
*
* @since 3.32.0
*/
class LLMS_Table_Memberships extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @since 3.32.0
*
* @var string
*/
protected $id = 'memberships';
/**
* Value of the field being filtered by.
* Only applicable if $filterby is set.
*
* @since 3.32.0
*
* @var string
*/
protected $filter = 'any';
/**
* Field results are filtered by.
*
* @since 3.32.0
*
* @var string
*/
protected $filterby = 'instructor';
/**
* Is the Table Exportable?
*
* @since 3.32.0
*
* @var boolean
*/
protected $is_exportable = true;
/**
* Determine if the table is filterable.
*
* @since 3.32.0
*
* @var boolean
*/
protected $is_filterable = true;
/**
* If true, tfoot will add ajax pagination links.
*
* @since 3.32.0
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Determine of the table is searchable
*
* @since 3.32.0
*
* @var boolean
*/
protected $is_searchable = true;
/**
* Results sort order 'ASC' or 'DESC'.
* Only applicable of $orderby is not set.
*
* @since 3.32.0
*
* @var string
*/
protected $order = 'ASC';
/**
* Field results are sorted by.
*
* @since 3.32.0
*
* @var string
*/
protected $orderby = 'title';
/**
* Retrieve data for a cell.
*
* @since 3.32.0
*
* @param string $key The column id / key.
* @param mixed $data Object / array of data that the function can use to extract the data.
* @return mixed
*/
protected function get_data( $key, $data ) {
$membership = llms_get_post( $data );
switch ( $key ) {
case 'id':
$value = $this->get_post_link( $membership->get( 'id' ) );
break;
case 'instructors':
$data = array();
foreach ( $membership->get_instructors() as $info ) {
$instructor = llms_get_instructor( $info['id'] );
if ( $instructor ) {
$data[] = sprintf( '%1$s (%2$s)', $instructor->get( 'display_name' ), $info['label'] );
}
}
$value = implode( ', ', $data );
break;
case 'students':
$value = number_format_i18n( $membership->get_student_count(), 0 );
break;
case 'title':
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'tab' => 'memberships',
'membership_id' => $membership->get( 'id' ),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . $membership->get( 'title' ) . '</a>';
break;
default:
$value = $key;
}// End switch().
return $value;
}
/**
* Retrieve a list of Instructors to be used for Filtering.
*
* @since 3.32.0
*
* @return array
*/
private function get_instructor_filters() {
$query = get_users(
array(
'fields' => array( 'ID', 'display_name' ),
'meta_key' => 'last_name',
'orderby' => 'meta_value',
'role__in' => array( 'administrator', 'lms_manager', 'instructor', 'instructors_assistant' ),
)
);
$instructors = wp_list_pluck( $query, 'display_name', 'ID' );
return $instructors;
}
/**
* Execute a query to retrieve results from the table.
*
* @since 3.32.0
*
* @param array $args Optional. Array of query args. Default empty array.
* @return void
*/
public function get_results( $args = array() ) {
$this->title = __( 'Memberships', 'lifterlms' );
$args = $this->clean_args( $args );
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$per = apply_filters( 'llms_reporting_' . $this->id . '_per_page', 25 );
$this->order = isset( $args['order'] ) ? $args['order'] : $this->order;
$this->orderby = isset( $args['orderby'] ) ? $args['orderby'] : $this->orderby;
$this->filter = isset( $args['filter'] ) ? $args['filter'] : $this->get_filter();
$this->filterby = isset( $args['filterby'] ) ? $args['filterby'] : $this->get_filterby();
$query_args = array(
'order' => $this->order,
'orderby' => $this->orderby,
'paged' => $this->current_page,
'post_status' => array( 'publish', 'private' ),
'post_type' => 'llms_membership',
'posts_per_page' => $per,
);
if ( 'any' !== $this->filter ) {
$serialized_id = serialize(
array(
'id' => absint( $this->filter ),
)
);
$serialized_id = str_replace( array( 'a:1:{', '}' ), '', $serialized_id );
$query_args['meta_query'] = array(
array(
'compare' => 'LIKE',
'key' => '_llms_instructors',
'value' => $serialized_id,
),
);
}
if ( isset( $args['search'] ) ) {
$query_args['s'] = sanitize_text_field( $args['search'] );
}
// If you can view others reports, make a regular query.
if ( current_user_can( 'view_others_lifterlms_reports' ) ) {
$query = new WP_Query( $query_args );
// User can only see their own reports, get a list of their students.
} elseif ( current_user_can( 'view_lifterlms_reports' ) ) {
$instructor = llms_get_instructor();
if ( ! $instructor ) {
return;
}
$query = $instructor->get_memberships( $query_args, 'query' );
} else {
return;
}
$this->max_pages = $query->max_num_pages;
if ( $this->max_pages > $this->current_page ) {
$this->is_last_page = false;
}
$this->tbody_data = $query->posts;
}
/**
* Get the Text to be used as the placeholder in a searchable tables search input.
*
* @since 3.32.0
*
* @return string
*/
public function get_table_search_form_placeholder() {
return apply_filters( 'llms_table_get_' . $this->id . '_search_placeholder', __( 'Search memberships...', 'lifterlms' ) );
}
/**
* Define the structure of arguments used to pass to the get_results method.
*
* @since 3.32.0
*
* @return array
*/
public function set_args() {
return array();
}
/**
* Define the structure of the table.
*
* @since 3.32.0
*
* @return array
*/
protected function set_columns() {
return array(
'id' => array(
'exportable' => true,
'title' => __( 'ID', 'lifterlms' ),
'sortable' => true,
),
'title' => array(
'exportable' => true,
'title' => __( 'Title', 'lifterlms' ),
'sortable' => true,
),
'instructors' => array(
'exportable' => true,
'filterable' => current_user_can( 'view_others_lifterlms_reports' ) ? $this->get_instructor_filters() : false,
'title' => __( 'Instructors', 'lifterlms' ),
),
'students' => array(
'exportable' => true,
'title' => __( 'Students', 'lifterlms' ),
),
);
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.quiz.attempts.php
================================================
<?php
/**
* Quizzes Reporting Table
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.16.0
* @version 7.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Table_Quiz_Attempts class.
*
* @since 3.16.0
* @since 3.30.3 Fixed undefined variable notice in the `set_args()` method.
*/
class LLMS_Table_Quiz_Attempts extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'quiz_attempts';
/**
* Value of the field being filtered by
* Only applicable if $filterby is set
*
* @var string
*/
protected $filter = 'any';
/**
* Field results are filtered by
*
* @var string
*/
protected $filterby = 'grade';
/**
* Is the Table Exportable?
*
* @var boolean
*/
protected $is_exportable = false;
/**
* Determine if the table is filterable
*
* @var boolean
*/
protected $is_filterable = true;
/**
* If true, tfoot will add ajax pagination links
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Determine of the table is searchable
*
* @var boolean
*/
protected $is_searchable = true;
/**
* Results sort order
* 'ASC' or 'DESC'
* Only applicable of $orderby is not set
*
* @var string
*/
protected $order = 'DESC';
/**
* Field results are sorted by
*
* @var string
*/
protected $orderby = 'id';
/**
* WP Post ID of the displayed quiz
*
* @var null
*/
protected $quiz_id = null;
/**
* Retrieve data for a cell.
*
* @since 3.16.0
* @since 3.26.3 Unknown.
* @since 7.8.0 Added information about whether the attempt can be resumed.
*
* @param string $key The column id / key.
* @param LLMS_Quiz_Attempt $attempt LLMS_Quiz_Attempt obj.
* @return mixed
*/
protected function get_data( $key, $attempt ) {
switch ( $key ) {
case 'student':
$value = '–';
$student = $attempt->get_student();
if ( $student ) {
$value = $student->get_name();
}
break;
case 'attempt':
$value = '#' . $attempt->get( $key );
break;
case 'grade':
$value = $attempt->get( $key ) ? $attempt->get( $key ) . '%' : '0%';
$additional = $attempt->l10n( 'status' );
if ( $attempt->can_be_resumed() && $attempt->is_last_attempt() ) {
$additional .= ' - ' . esc_html__( 'Can be resumed', 'lifterlms' );
}
$value .= ' (' . $additional . ')';
break;
case 'start_date':
case 'end_date':
$value = '–';
$date = $attempt->get( $key );
if ( $date ) {
$value = date_i18n( get_option( 'date_format' ) . ' ' . get_option( 'time_format' ), strtotime( $date ) );
}
break;
case 'id':
$value = sprintf( '%2$d (%1$s)', $attempt->get_key(), $attempt->get( 'id' ) );
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'tab' => 'quizzes',
'stab' => 'attempts',
'quiz_id' => $attempt->get( 'quiz_id' ),
'attempt_id' => $attempt->get( 'id' ),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . $value . '</a>';
break;
default:
$value = $key;
}// End switch().
return $value;
}
/**
* Retrieve a list of Instructors to be used for Filtering
*
* @return array
* @since 3.16.0
* @version 3.16.0
*/
private function get_instructor_filters() {
$query = get_users(
array(
'fields' => array( 'ID', 'display_name' ),
'meta_key' => 'last_name',
'orderby' => 'meta_value',
'role__in' => array( 'administrator', 'lms_manager', 'instructor', 'instructors_assistant' ),
)
);
$instructors = wp_list_pluck( $query, 'display_name', 'ID' );
return $instructors;
}
/**
* Execute a query to retrieve results from the table
*
* @since 3.16.0
* @since 3.25.0 Unknown.
* @since 6.0.0 Don't access `LLMS_Query_Quiz_Attempt` properties directly.
*
* @param array $args Array of query args.
* @return void
*/
public function get_results( $args = array() ) {
$this->title = __( 'Quiz Attempts', 'lifterlms' );
$args = $this->clean_args( $args );
$this->quiz_id = $args['quiz_id'];
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$per = apply_filters( 'llms_reporting_' . $this->id . '_per_page', 25 );
$this->order = isset( $args['order'] ) ? $args['order'] : $this->order;
$this->orderby = isset( $args['orderby'] ) ? $args['orderby'] : $this->orderby;
$this->filter = isset( $args['filter'] ) ? $args['filter'] : $this->get_filter();
$this->filterby = isset( $args['filterby'] ) ? $args['filterby'] : $this->get_filterby();
$query_args = array(
'sort' => array(
$this->orderby => $this->order,
),
'page' => $this->current_page,
'per_page' => $per,
'quiz_id' => $args['quiz_id'],
'student_id' => isset( $args['student_id'] ) ? $args['student_id'] : null,
);
// Add search functionality
if ( isset( $args['search'] ) && ! empty( $args['search'] ) ) {
$query_args['search'] = sanitize_text_field( $args['search'] );
}
if ( 'any' !== $this->filter ) {
$query_args['status'] = $this->filter;
}
if ( current_user_can( 'view_others_lifterlms_reports' ) || ( current_user_can( 'view_lifterlms_reports' ) && current_user_can( 'edit_post', $args['quiz_id'] ) ) ) {
$query = new LLMS_Query_Quiz_Attempt( $query_args );
} else {
return;
}
$this->max_pages = $query->get_max_pages();
$this->is_last_page = $query->is_last_page();
$this->tbody_data = $query->get_attempts();
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @since 3.16.0
* @version 3.30.3 Fallback to `null` when `$_GET` param is not set.
*
* @return array
*/
public function set_args() {
return array(
'quiz_id' => ! empty( $this->quiz_id ) ? $this->quiz_id : ( isset( $_GET['quiz_id'] ) ? absint( $_GET['quiz_id'] ) : null ),
'student_id' => 0,
);
}
/**
* Define the structure of the table
*
* @return array
* @since 3.16.0
* @version 3.19.2
*/
protected function set_columns() {
$cols = array(
'id' => array(
'exportable' => true,
'title' => __( 'ID', 'lifterlms' ),
'sortable' => true,
),
'attempt' => array(
'exportable' => true,
'title' => __( 'Attempt #', 'lifterlms' ),
'sortable' => true,
),
'student' => array(
'exportable' => true,
'title' => __( 'Student', 'lifterlms' ),
'sortable' => false,
),
'grade' => array(
'filterable' => llms_get_quiz_attempt_statuses(),
'exportable' => true,
'title' => __( 'Grade', 'lifterlms' ),
'sortable' => true,
),
'start_date' => array(
'exportable' => true,
'title' => __( 'Start Date', 'lifterlms' ),
'sortable' => true,
),
'end_date' => array(
'exportable' => true,
'title' => __( 'End Date', 'lifterlms' ),
'sortable' => true,
),
);
return $cols;
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.quiz.non.attempts.php
================================================
<?php
/**
* Quiz Non-Attempts Reporting Table
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 9.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Table_Quiz_Non_Attempts class.
*
* Displays students enrolled in courses containing a quiz but who have not attempted the quiz.
*
* @since 9.1.0
*/
class LLMS_Table_Quiz_Non_Attempts extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'quiz_non_attempts';
/**
* Value of the field being filtered by
* Only applicable if $filterby is set
*
* @var string
*/
protected $filter = 'any';
/**
* Field results are filtered by
*
* @var string
*/
protected $filterby = 'status';
/**
* Is the Table Exportable?
*
* @var boolean
*/
protected $is_exportable = true;
/**
* Determine if the table is filterable
*
* @var boolean
*/
protected $is_filterable = true;
/**
* If true, tfoot will add ajax pagination links
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Determine of the table is searchable
*
* @var boolean
*/
protected $is_searchable = true;
/**
* Results sort order
* 'ASC' or 'DESC'
* Only applicable of $orderby is not set
*
* @var string
*/
protected $order = 'ASC';
/**
* Field results are sorted by
*
* @var string
*/
protected $orderby = 'name';
/**
* WP Post ID of the displayed quiz
*
* @var null
*/
protected $quiz_id = null;
/**
* Retrieve data for a cell.
*
* @since 9.1.0
*
* @param string $key The column id / key.
* @param LLMS_Student $student LLMS_Student obj.
* @return mixed
*/
protected function get_data( $key, $student ) {
switch ( $key ) {
case 'id':
$id = $student->get_id();
if ( current_user_can( 'edit_users', $id ) ) {
$value = '<a href="' . esc_url( get_edit_user_link( $id ) ) . '">' . $id . '</a>';
} else {
$value = $id;
}
break;
case 'name':
$first = $student->get( 'first_name' );
$last = $student->get( 'last_name' );
if ( ! $first || ! $last ) {
$value = $student->get( 'display_name' );
} else {
$value = $last . ', ' . $first;
}
$id = $student->get_id();
if ( current_user_can( 'edit_users', $id ) ) {
$value = '<a href="' . esc_url( get_edit_user_link( $id ) ) . '">' . $value . '</a>';
}
break;
case 'email':
$value = $student->get( 'user_email' );
break;
case 'enrolled_courses':
$quiz = llms_get_post( $this->quiz_id );
$course = $quiz ? $quiz->get_course() : false;
if ( $course ) {
$enrollment_date = $student->get_enrollment_date( $course->get( 'id' ) );
$value = $enrollment_date ? $enrollment_date : '—';
} else {
$value = '—';
}
break;
case 'status':
$quiz = llms_get_post( $this->quiz_id );
$course = $quiz ? $quiz->get_course() : false;
if ( $course ) {
$status = $student->get_enrollment_status( $course->get( 'id' ) );
$value = ucfirst( $status );
} else {
$value = '—';
}
break;
default:
$value = $key;
}// End switch().
return $value;
}
/**
* Execute a query to retrieve results from the table.
*
* @since 9.1.0
*
* @param array $args Array of query args.
* @return void
*/
public function get_results( $args = array() ) {
$this->title = __( 'Students Without Quiz Attempts', 'lifterlms' );
$args = $this->clean_args( $args );
$this->quiz_id = $args['quiz_id'];
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$per = apply_filters( 'llms_reporting_' . $this->id . '_per_page', 25 );
$order = isset( $args['order'] ) ? $args['order'] : $this->order;
$this->order = in_array( $order, array( 'ASC', 'DESC' ), true ) ? $order : 'ASC';
$this->orderby = isset( $args['orderby'] ) ? $args['orderby'] : $this->orderby;
$this->filter = isset( $args['filter'] ) ? $args['filter'] : $this->get_filter();
$this->filterby = isset( $args['filterby'] ) ? $args['filterby'] : $this->get_filterby();
if ( ! ( current_user_can( 'view_others_lifterlms_reports' ) || ( current_user_can( 'view_lifterlms_reports' ) && current_user_can( 'edit_post', $args['quiz_id'] ) ) ) ) {
return;
}
$quiz = llms_get_post( $this->quiz_id );
if ( ! $quiz ) {
return;
}
$course = $quiz->get_course();
if ( ! $course ) {
return;
}
// Use a single optimized database query.
global $wpdb;
$search_sql = '';
if ( isset( $args['search'] ) && ! empty( $args['search'] ) ) {
$search_term = sanitize_text_field( $args['search'] );
$search_sql = $wpdb->prepare(
'AND (
u.user_login LIKE %s
OR u.user_email LIKE %s
OR u.display_name LIKE %s
OR m_first.meta_value LIKE %s
OR m_last.meta_value LIKE %s
)',
'%' . $search_term . '%',
'%' . $search_term . '%',
'%' . $search_term . '%',
'%' . $search_term . '%',
'%' . $search_term . '%'
);
}
if ( 'any' !== $this->filter ) {
$status_sql = $wpdb->prepare( 'AND upm.meta_value = %s', $this->filter );
} else {
$status_sql = "AND upm.meta_value IN ('enrolled', 'expired', 'cancelled')";
}
switch ( $this->orderby ) {
case 'name':
$order_sql = 'ORDER BY m_last.meta_value ' . $this->order . ', m_first.meta_value ' . $this->order;
break;
case 'id':
$order_sql = 'ORDER BY u.ID ' . $this->order;
break;
case 'email':
$order_sql = 'ORDER BY u.user_email ' . $this->order;
break;
default:
$order_sql = 'ORDER BY u.display_name ' . $this->order;
}
$offset = ( $this->current_page - 1 ) * $per;
$from_joins_where = "FROM {$wpdb->users} u
INNER JOIN {$wpdb->prefix}lifterlms_user_postmeta upm
ON u.ID = upm.user_id
AND upm.post_id = %d
AND upm.meta_key = '_status'
{$status_sql}
LEFT JOIN {$wpdb->usermeta} m_first
ON u.ID = m_first.user_id
AND m_first.meta_key = 'first_name'
LEFT JOIN {$wpdb->usermeta} m_last
ON u.ID = m_last.user_id
AND m_last.meta_key = 'last_name'
LEFT JOIN {$wpdb->prefix}lifterlms_quiz_attempts qa
ON u.ID = qa.student_id
AND qa.quiz_id = %d
WHERE upm.updated_date = (
SELECT MAX(upm2.updated_date)
FROM {$wpdb->prefix}lifterlms_user_postmeta upm2
WHERE upm2.user_id = u.ID
AND upm2.post_id = %d
AND upm2.meta_key = '_status'
)
AND qa.id IS NULL
{$search_sql}";
$prepare_args = array(
$course->get( 'id' ),
$this->quiz_id,
$course->get( 'id' ),
);
$total_results = $wpdb->get_var(
$wpdb->prepare(
"SELECT COUNT(DISTINCT u.ID) {$from_joins_where}",
$prepare_args
)
); // db call ok; no-cache ok.
$results = $wpdb->get_results(
$wpdb->prepare(
"SELECT DISTINCT
u.ID as user_id,
u.user_email,
u.display_name,
u.user_registered,
m_first.meta_value as first_name,
m_last.meta_value as last_name,
upm.meta_value as enrollment_status,
upm.updated_date as enrollment_date
{$from_joins_where}
{$order_sql}
LIMIT %d, %d",
array_merge( $prepare_args, array( $offset, $per ) )
)
);
$this->max_pages = ceil( $total_results / $per );
$this->is_last_page = ( $this->current_page >= $this->max_pages );
$this->tbody_data = array();
if ( ! empty( $results ) ) {
foreach ( $results as $result ) {
$this->tbody_data[] = llms_get_student( $result->user_id );
}
}
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @since 9.1.0
*
* @return array
*/
public function set_args() {
return array(
'quiz_id' => ! empty( $this->quiz_id ) ? $this->quiz_id : ( isset( $_GET['quiz_id'] ) ? absint( $_GET['quiz_id'] ) : null ),
);
}
/**
* Define the structure of the table
*
* @return array
* @since 9.1.0
*/
protected function set_columns() {
$cols = array(
'id' => array(
'exportable' => true,
'title' => __( 'ID', 'lifterlms' ),
'sortable' => true,
),
'name' => array(
'exportable' => true,
'title' => __( 'Name', 'lifterlms' ),
'sortable' => true,
),
'email' => array(
'exportable' => true,
'title' => __( 'Email', 'lifterlms' ),
'sortable' => true,
),
'enrolled_courses' => array(
'exportable' => true,
'title' => __( 'Enrollment Date', 'lifterlms' ),
'sortable' => false,
),
'status' => array(
'filterable' => array(
'enrolled' => __( 'Enrolled', 'lifterlms' ),
'expired' => __( 'Expired', 'lifterlms' ),
'cancelled' => __( 'Cancelled', 'lifterlms' ),
),
'exportable' => true,
'title' => __( 'Status', 'lifterlms' ),
'sortable' => false,
),
);
return $cols;
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.quizzes.php
================================================
<?php
/**
* Quizzes Reporting Table
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.16.0
* @version 7.1.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Quizzes Reporting Table class
*
* @since 3.16.0
* @since 3.36.1 Fixed an issue that allow instructors, who can only see their own reports,
* to see all the quizzes when they had no courses or courses with no lessons.
* @since 3.37.8 Allow orphaned quizzes to be deleted.
* Output quiz IDs as plain text (no link) when they cannot be edited and link to the quiz within the course builder when they can.
* @since 3.37.12 Fixed the 'actions' column name.
* @since 4.2.0 Added deep checks on whether the quiz is associated to a lesson.
*/
class LLMS_Table_Quizzes extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'quizzes';
/**
* Value of the field being filtered by
* Only applicable if $filterby is set
*
* @var string
*/
protected $filter = 'any';
/**
* Field results are filtered by
*
* @var string
*/
protected $filterby = 'instructor';
/**
* Is the Table Exportable?
*
* @var boolean
*/
protected $is_exportable = true;
/**
* Determine if the table is filterable
*
* @var boolean
*/
protected $is_filterable = true;
/**
* If true, tfoot will add ajax pagination links
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Determine of the table is searchable
*
* @var boolean
*/
protected $is_searchable = true;
/**
* Results sort order
* 'ASC' or 'DESC'.
* Only applicable of $orderby is not set.
*
* @var string
*/
protected $order = 'ASC';
/**
* Field results are sorted by
*
* @var string
*/
protected $orderby = 'title';
/**
* Get HTML for buttons in the actions cell of the table
*
* @since 3.37.8
* @since 4.2.0 Added a deep check on whether the quiz is associated to a lesson.
* @since 6.0.0 Don't access `LLMS_Query_Quiz_Attempt` properties directly.
*
* @param LLMS_Quiz $quiz Quiz object.
* @return string
*/
private function get_actions_html( $quiz ) {
if ( ! $quiz->is_orphan( true ) && $quiz->get_course() ) {
return '';
}
// If there are quiz attempts for the quiz let the admin know they're going to delete the attempts also.
$query = new LLMS_Query_Quiz_Attempt(
array(
'quiz_id' => $quiz->get( 'id' ),
'per_page' => 1,
)
);
$msg = $query->has_results() ? __( 'Are you sure you want to delete this quiz and all associated student attempts?', 'lifterlms' ) : __( 'Are you sure you want to delete this quiz?', 'lifterlms' );
$msg .= ' ' . __( 'This action cannot be undone!', 'lifterlms' );
ob_start();
?>
<form action="" method="POST" style="display:inline;">
<button type="submit" class="llms-button-danger small" id="llms-del-quiz-<?php echo esc_attr( $quiz->get( 'id' ) ); ?>" name="llms_del_quiz" value="<?php echo esc_attr( $quiz->get( 'id' ) ); ?>">
<?php esc_html_e( 'Delete', 'lifterlms' ); ?>
<i class="fa fa-trash" aria-hidden="true"></i>
</button>
<input type="hidden" name="_llms_quiz_actions_nonce" value="<?php echo esc_attr( wp_create_nonce( 'llms-quiz-actions' ) ); ?>">
</form>
<script>document.getElementById( 'llms-del-quiz-<?php echo esc_attr( $quiz->get( 'id' ) ); ?>' ).onclick = function( e ) {
return window.confirm( '<?php echo esc_attr( $msg ); ?>' );
};</script>
<?php
return ob_get_clean();
}
/**
* Retrieve data for a cell
*
* @since 3.16.0
* @since 3.24.0 Unknown.
* @since 3.37.8 Add actions column that allows deletion of orphaned quizzes.
* ID column displays as plain text if the quiz is not editable and directs to the quiz within the course builder when it is.
* @since 4.2.0 Added a deep check on whether the quiz is associated to a lesson.
* @since 6.0.0 Don't access `LLMS_Query_Quiz_Attempt` properties directly.
* @since 7.1.3 Added `round()` method for 'average' column values with precision from `llms_get_floats_rounding_precision()` helper.
*
* @param string $key The column id / key.
* @param mixed $data Object / array of data that the function can use to extract the data.
* @return mixed
*/
protected function get_data( $key, $data ) {
$quiz = llms_get_post( $data );
switch ( $key ) {
case 'actions':
$value = $this->get_actions_html( $quiz );
break;
case 'attempts':
$query = new LLMS_Query_Quiz_Attempt(
array(
'quiz_id' => $quiz->get( 'id' ),
'count_only' => true,
)
);
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'tab' => 'quizzes',
'stab' => 'attempts',
'quiz_id' => $quiz->get( 'id' ),
)
);
$value = '<a href="' . $url . '">' . $query->get_count_only_result() . '</a>';
break;
case 'average':
$grade = 0;
$query = new LLMS_Query_Quiz_Attempt(
array(
'quiz_id' => $quiz->get( 'id' ),
'per_page' => 1000,
)
);
$attempts = $query->get_number_results();
if ( ! $attempts ) {
$value = 0;
} else {
foreach ( $query->get_attempts() as $attempt ) {
$grade += $attempt->get( 'grade' );
}
$value = round( $grade / $attempts, llms_get_floats_rounding_precision() ) . '%';
}
break;
case 'course':
$value = '—';
$course = $quiz->get_course();
if ( $course ) {
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'tab' => 'courses',
'course_id' => $course->get( 'id' ),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . $course->get( 'title' ) . '</a>';
}
break;
case 'id':
$id = $quiz->get( 'id' );
$value = $id;
$course = $quiz->get_course();
if ( ! $quiz->is_orphan( true ) && $course ) {
$url = add_query_arg(
array(
'page' => 'llms-course-builder',
'course_id' => $course->get( 'id' ),
),
admin_url( 'admin.php' )
);
$url .= sprintf( '#lesson:%d:quiz', $quiz->get( 'lesson_id' ) );
$value = '<a href="' . esc_url( $url ) . '">' . $id . '</a>';
}
break;
case 'lesson':
$value = '—';
$lesson = $quiz->get_lesson();
if ( $lesson ) {
$value = $lesson->get( 'title' );
}
break;
case 'title':
$value = $quiz->get( 'title' );
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'tab' => 'quizzes',
'quiz_id' => $quiz->get( 'id' ),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . $quiz->get( 'title' ) . '</a>';
break;
default:
$value = $key;
}
return $this->filter_get_data( $value, $key, $data );
}
/**
* Retrieve a list of Instructors to be used for Filtering
*
* @since 3.16.0
*
* @return array
*/
private function get_instructor_filters() {
$query = get_users(
array(
'fields' => array( 'ID', 'display_name' ),
'meta_key' => 'last_name', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'orderby' => 'meta_value',
'role__in' => array( 'administrator', 'lms_manager', 'instructor', 'instructors_assistant' ),
)
);
$instructors = wp_list_pluck( $query, 'display_name', 'ID' );
return $instructors;
}
/**
* Execute a query to retrieve results from the table
*
* @since 3.16.0
* @since 3.36.1 Fixed an issue that allow instructors, who can only see their own reports,
* to see all the quizzes when they had no courses or courses with no lessons.
*
* @param array $args Array of query args.
* @return void
*/
public function get_results( $args = array() ) {
$this->title = __( 'Quizzes', 'lifterlms' );
$args = $this->clean_args( $args );
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$per = apply_filters( 'llms_reporting_' . $this->id . '_per_page', 25 );
$this->order = isset( $args['order'] ) ? $args['order'] : $this->order;
$this->orderby = isset( $args['orderby'] ) ? $args['orderby'] : $this->orderby;
$this->filter = isset( $args['filter'] ) ? $args['filter'] : $this->get_filter();
$this->filterby = isset( $args['filterby'] ) ? $args['filterby'] : $this->get_filterby();
$query_args = array(
'order' => $this->order,
'orderby' => $this->orderby,
'paged' => $this->current_page,
'post_status' => 'publish',
'post_type' => 'llms_quiz',
'posts_per_page' => $per,
);
if ( isset( $args['search'] ) ) {
$query_args['s'] = sanitize_text_field( $args['search'] );
}
// if you can view others reports, make a regular query.
if ( current_user_can( 'view_others_lifterlms_reports' ) ) {
$query = new WP_Query( $query_args );
// user can only see their own reports, get a list of their students.
} elseif ( current_user_can( 'view_lifterlms_reports' ) ) {
$instructor = llms_get_instructor();
if ( ! $instructor ) {
return;
}
$lessons = array();
$courses = $instructor->get_courses(
array(
'posts_per_page' => -1,
)
);
foreach ( $courses as $course ) {
$lessons = array_merge( $lessons, $course->get_lessons( 'ids' ) );
}
if ( empty( $lessons ) ) {
return;
}
$query_args['meta_query'] = array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
array(
'compare' => 'IN',
'key' => '_llms_lesson_id',
'value' => $lessons,
),
);
$query = new WP_Query( $query_args );
} else {
return;
}
$this->max_pages = $query->max_num_pages;
if ( $this->max_pages > $this->current_page ) {
$this->is_last_page = false;
}
$this->tbody_data = $query->posts;
}
/**
* Get the Text to be used as the placeholder in a searchable tables search input
*
* @since 3.16.0
*
* @return string
*/
public function get_table_search_form_placeholder() {
/**
* Filter the placeholder used in the search input on the quizzes reporting table.
*
* @since 3.16.0
*
* @param string $placeholder The placeholder string.
*/
return apply_filters( 'llms_table_get_quizzes_search_placeholder', __( 'Search quizzes...', 'lifterlms' ) );
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @since 3.16.0
*
* @return array
*/
public function set_args() {
return array();
}
/**
* Define the structure of the table
*
* @since 3.16.0
* @since 3.16.10 Unknown.
* @since 3.37.8 Added the 'actions' column.
* @since 3.37.12 Fixed the 'actions' column name.
*
* @return array
*/
protected function set_columns() {
return array(
'id' => array(
'exportable' => true,
'title' => __( 'ID', 'lifterlms' ),
'sortable' => true,
),
'title' => array(
'exportable' => true,
'title' => __( 'Title', 'lifterlms' ),
'sortable' => true,
),
'course' => array(
'exportable' => true,
'title' => __( 'Course', 'lifterlms' ),
'sortable' => false,
),
'lesson' => array(
'exportable' => true,
'title' => __( 'Lesson', 'lifterlms' ),
'sortable' => false,
),
'attempts' => array(
'exportable' => true,
'title' => __( 'Total Attempts', 'lifterlms' ),
'sortable' => false,
),
'average' => array(
'exportable' => true,
'title' => __( 'Average Grade', 'lifterlms' ),
'sortable' => false,
),
'actions' => array(
'exportable' => false,
'title' => __( 'Actions', 'lifterlms' ),
'sortable' => false,
),
);
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.student.course.php
================================================
<?php
/**
* Individual Student's Course Table
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.2.0
* @version 3.35.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Table_Student_Course class
*
* @since 3.2.0
* @since 3.21.0 Unknown.
* @since 3.35.0 Get student ID more reliably.
*/
class LLMS_Table_Student_Course extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'student-course';
/**
* Stores the current section while building the table
* used by $this->output_section_row_html() to determine
* if a new section header needs to be output
*
* @var int
*/
private $current_section = null;
/**
* If true, tfoot will add ajax pagination links
*
* @var boolean
*/
protected $is_paginated = false;
/**
* Results sort order
* 'ASC' or 'DESC'
* Only applicable of $orderby is not set
*
* @var string
*/
protected $order = 'ASC';
/**
* Field results are sorted by
*
* @var string
*/
protected $orderby = 'name';
/**
* Instance of LLMS_Student
*
* @var null
*/
public $student = null;
/**
* Get the HTML for the actions column on the table
*
* @param obj $lesson LLMS_Lesson..
* @return string
* @since 3.29.0
* @version 10.0.0
*/
private function get_actions_html( $lesson ) {
$html = '';
// Evaluate against the student's progress, not the current (admin) user's.
// is_quiz_enabled() requires publish status, so unpublished quizzes are ignored.
$show_button = true;
if ( $lesson->is_quiz_enabled() ) {
$attempt = $this->student->quizzes()->get_best_attempt( $lesson->get( 'quiz' ) );
$passing_required = llms_parse_bool( $lesson->get( 'require_passing_grade' ) );
if ( ! $attempt || ( $passing_required && ! $attempt->is_passing() ) ) {
$show_button = false;
}
}
/**
* Filters whether the lesson action (mark complete/incomplete) button
* should display in the admin student course reporting table.
*
* @since 10.0.0
*
* @param bool $show_button Whether to show the button.
* @param LLMS_Lesson $lesson Lesson instance.
* @param LLMS_Student $student Student being reported on.
*/
$show_button = apply_filters( 'llms_admin_report_show_lesson_action_button', $show_button, $lesson, $this->student );
if ( $show_button ) {
if ( $this->student->is_complete( $lesson->get( 'id' ) ) ) {
$action = 'incomplete';
$icon = 'exclamation-triangle';
$text = __( 'Mark Incomplete', 'lifterlms' );
} else {
$action = 'complete';
$icon = 'check';
$text = __( 'Mark Complete', 'lifterlms' );
}
$html = '
<form action="" method="POST">
<input name="student_id" type="hidden" value="' . $this->student->get( 'id' ) . '">
<input name="lesson_id" type="hidden" value="' . $lesson->get( 'id' ) . '">
<button class="llms-button-secondary square small tip--bottom-left" data-tip="' . esc_attr( $text ) . '" name="llms-lesson-action" type="submit" value="' . $action . '">
<i class="fa fa-' . $icon . '" aria-hidden="true"></i>
</button>
' . wp_nonce_field( 'llms-admin-lesson-progression', 'llms-admin-progression-nonce', false, false ) . '
</form>
';
}
return $html;
}
/**
* Retrieve data for the columns
*
* @param string $key the column id / key
* @param int $lesson Instance of an LLMS_Lesson
* @return mixed
* @since 3.2.0
* @version 3.29.0
*/
public function get_data( $key, $lesson ) {
switch ( $key ) {
case 'actions':
$value = $this->get_actions_html( $lesson );
break;
case 'completed':
$date = $this->student->get_completion_date( $lesson->get( 'id' ) );
$value = $date ? $date : '–';
break;
case 'grade':
$grade = $this->student->get_grade( $lesson->get( 'id' ) );
$value = is_numeric( $grade ) ? $grade . '%' : $grade;
break;
case 'id':
$value = $this->get_post_link( $lesson->get( 'id' ) );
break;
case 'name':
$value = $lesson->get( 'title' );
break;
case 'quiz':
$q = $lesson->get( 'quiz' );
if ( $q ) {
$url = esc_url(
add_query_arg(
array(
'quiz_id' => $q,
'lesson_id' => $lesson->get( 'id' ),
)
)
);
$value = '<a href="' . $url . '">' . get_the_title( $q ) . '</a>';
} else {
$value = '–';
}
break;
default:
$value = $key;
}// End switch.
return $this->filter_get_data( $value, $key, $lesson );
}
/**
* Execute a query to retrieve results from the table
*
* @param array $args array of query args
* @return void
* @since 3.2.0
* @version 3.2.0
*/
public function get_results( $args = array() ) {
$student_id = is_numeric( $args['student'] ) ? absint( $args['student'] ) : ( $args['student'] ? $args['student']->get_id() : 0 );
if ( $student_id && ! current_user_can( 'view_others_lifterlms_reports' ) && ! llms_current_user_can( 'view_lifterlms_reports', $student_id ) ) {
return;
}
$course = new LLMS_Course( absint( $args['course_id'] ) );
if ( is_numeric( $args['student'] ) ) {
$args['student'] = new LLMS_Student( $args['student'] );
}
$this->student = $args['student'];
$this->tbody_data = $course->get_lessons();
}
/**
* Output a section title row for each course Section
*
* @param obj $lesson the current lesson instance
* @return void
* @since 3.2.0
* @version 3.21.0
*/
public function output_section_row_html( $lesson ) {
if ( $lesson instanceof LLMS_Lesson ) {
$sid = $lesson->get_parent_section();
if ( $this->current_section !== $sid ) {
echo '<tr><td class="id">' . esc_html( $sid ) . '</td><td class="section-title" colspan="' . esc_attr( $this->get_columns_count() - 1 ) . '">' . esc_html( sprintf( _x( 'Section: %s', 'section title', 'lifterlms' ), get_the_title( $sid ) ) ) . '</td></tr>';
$this->current_section = $sid;
}
}
}
/**
* Allow custom hooks to be registered for use within the class
*
* @return void
* @since 3.2.0
* @version 3.21.0
*/
protected function register_hooks() {
add_action( 'llms_table_before_tr', array( $this, 'output_section_row_html' ), 10, 1 );
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @since 2.3.0
* @since 3.35.0 Get student ID more reliably.
*
* @return array
*/
public function set_args() {
$student = false;
if ( ! empty( $this->student ) ) {
$student = $this->student->get_id();
} elseif ( ! empty( $_GET['student_id'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
$student = llms_filter_input( INPUT_GET, 'student_id', FILTER_SANITIZE_NUMBER_INT );
}
return array(
'page' => $this->get_current_page(),
'student' => $student,
);
}
/**
* Define the structure of the table
*
* @return array
* @since 3.2.0
* @version 3.29.0
*/
public function set_columns() {
return array(
'id' => array(
'title' => __( 'ID', 'lifterlms' ),
),
'name' => array(
'title' => __( 'Name', 'lifterlms' ),
),
'quiz' => array(
'title' => __( 'Quiz', 'lifterlms' ),
),
'grade' => array(
'title' => __( 'Grade', 'lifterlms' ),
),
'completed' => array(
'title' => __( 'Completed', 'lifterlms' ),
),
'actions' => array(
'exportable' => false,
'title' => __( 'Actions', 'lifterlms' ),
),
);
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.student.courses.php
================================================
<?php
/**
* Individual Student's Courses Table
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.2.0
* @version 3.13.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Table_Student_Courses class
*
* @since 3.2.0
* @since 3.13.0 Unknown.
*/
class LLMS_Table_Student_Courses extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'student-courses';
/**
* If true, tfoot will add ajax pagination links
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Results sort order
* 'ASC' or 'DESC'
* Only applicable of $orderby is not set
*
* @var string
*/
protected $order = 'ASC';
/**
* Field results are sorted by
*
* @var string
*/
protected $orderby = 'name';
/**
* Instance of LLMS_Student
*
* @var null
*/
protected $student = null;
/**
* Retrieve data for the columns
*
* @param string $key the column id / key
* @param int $course_id ID of the course
* @return mixed
* @since 3.2.0
* @version 3.13.0
*/
public function get_data( $key, $course_id ) {
$course = new LLMS_Course( $course_id );
switch ( $key ) {
case 'progress':
$value = $this->student->get_progress( $course->get( 'id' ), 'course' ) . '%';
break;
case 'completed':
$date = $this->student->get_completion_date( $course->get( 'id' ) );
$value = $date ? $date : '–';
break;
case 'grade':
$grade = $this->student->get_grade( $course->get( 'id' ) );
$value = is_numeric( $grade ) ? $grade . '%' : $grade;
break;
case 'id':
$value = $course->get( 'id' );
if ( current_user_can( 'edit_post', $value ) ) {
$value = $this->get_post_link( $value );
}
break;
case 'name':
$id = $course->get( 'id' );
if ( current_user_can( 'edit_post', $id ) ) {
$url = esc_url(
add_query_arg(
array(
'course_id' => $course->get( 'id' ),
'page' => 'llms-reporting',
'stab' => 'courses',
'student_id' => $this->student->get_id(),
),
admin_url( 'admin.php' )
)
);
$value = '<a href="' . $url . '">' . $course->get( 'title' ) . '</a>';
} else {
$value = $course->get( 'title' );
}
break;
case 'status':
$value = llms_get_enrollment_status_name( $this->student->get_enrollment_status( $course->get( 'id' ) ) );
break;
case 'updated':
$value = $this->student->get_enrollment_date( $course->get( 'id' ), 'updated' );
break;
default:
$value = $key;
}// End switch().
return $this->filter_get_data( $value, $key, $course_id );
}
/**
* Execute a query to retrieve results from the table
*
* @since 3.2.0
* @since 9.2.3 Added object-level authorization check on the student.
*
* @param array $args Array of query args.
* @return void
*/
public function get_results( $args = array() ) {
$args = $this->clean_args( $args );
$student_id = is_numeric( $args['student'] ) ? absint( $args['student'] ) : ( $args['student'] ? $args['student']->get_id() : 0 );
if ( $student_id && ! current_user_can( 'view_others_lifterlms_reports' ) && ! llms_current_user_can( 'view_lifterlms_reports', $student_id ) ) {
return;
}
if ( is_numeric( $args['student'] ) ) {
$args['student'] = new LLMS_Student( $args['student'] );
}
$this->student = $args['student'];
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$per = apply_filters( 'llms_gradebook_' . $this->id . '_per_page', 20 );
$order = ! empty( $args['order'] ) ? $args['order'] : 'ASC';
$order = in_array( $order, array( 'ASC', 'DESC' ) ) ? $order : 'ASC';
if ( isset( $args['order'] ) ) {
$this->order = $order;
}
if ( isset( $args['orderby'] ) ) {
$this->orderby = $args['orderby'];
}
switch ( $this->orderby ) {
case 'updated':
$orderby = 'upm.updated_date';
break;
case 'name':
default:
$orderby = 'p.post_title';
}
$courses = $this->student->get_courses(
array(
'limit' => $per,
'skip' => ( $this->current_page - 1 ) * $per,
'orderby' => $orderby,
'order' => $order,
)
);
if ( $courses['more'] ) {
$this->is_last_page = false;
}
$this->tbody_data = $courses['results'];
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @since 2.3.0
* @since 3.35.0 Sanitize `$_GET` data.
*
* @return array
*/
public function set_args() {
$student = false;
if ( ! empty( $this->student ) ) {
$student = $this->student->get_id();
} elseif ( ! empty( $_GET['student_id'] ) ) {
$student = llms_filter_input( INPUT_GET, 'student_id', FILTER_SANITIZE_NUMBER_INT );
}
return array(
'page' => $this->get_current_page(),
'student' => $student,
);
}
/**
* Define the structure of the table
*
* @return array
* @since 3.2.0
* @version 3.2.0
*/
public function set_columns() {
return array(
'id' => array(
'title' => __( 'ID', 'lifterlms' ),
),
'name' => array(
'title' => __( 'Name', 'lifterlms' ),
'sortable' => true,
),
'status' => array(
'title' => __( 'Status', 'lifterlms' ),
),
'grade' => array(
'title' => __( 'Grade', 'lifterlms' ),
),
'progress' => array(
'title' => __( 'Progress', 'lifterlms' ),
),
'updated' => array(
'title' => __( 'Updated', 'lifterlms' ),
'sortable' => true,
),
'completed' => array(
'title' => __( 'Completed', 'lifterlms' ),
),
);
}
/**
* Empty message displayed when no results are found
*
* @return string
* @since 3.2.0
* @version 3.2.0
*/
protected function set_empty_message() {
return __( 'This student is not enrolled in any courses.', 'lifterlms' );
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.student.memberships.php
================================================
<?php
/**
* Individual Student's Memberships Table
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.2.0
* @version 3.7.5
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Table_Student_Memberships
*
* @since 3.2.0
* @since 3.7.5 Unknown.
* @since 3.35.0 Get student ID more reliably.
*/
class LLMS_Table_Student_Memberships extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'student-memberships';
/**
* Instance of LLMS_Student
*
* @var null
*/
protected $student = null;
/**
* Retrieve data for the columns
*
* @param string $key the column id / key
* @param int $membership_id ID of the membership
* @return mixed
* @since 3.2.0
* @version 3.7.5
*/
public function get_data( $key, $membership_id ) {
switch ( $key ) {
case 'id':
$value = $this->get_post_link( $membership_id );
break;
case 'name':
$value = get_the_title( $membership_id );
break;
case 'status':
$value = llms_get_enrollment_status_name( $this->student->get_enrollment_status( $membership_id ) );
break;
case 'enrolled':
$value = $this->student->get_enrollment_date( $membership_id, 'enrolled' );
break;
default:
$value = $key;
}
return $this->filter_get_data( $value, $key, $membership_id );
}
/**
* Execute a query to retrieve results from the table
*
* @param array $args array of query args
* @return void
* @since 3.2.0
* @version 3.2.0
*/
public function get_results( $args = array() ) {
$args = $this->clean_args( $args );
$student_id = is_numeric( $args['student'] ) ? absint( $args['student'] ) : ( $args['student'] ? $args['student']->get_id() : 0 );
if ( $student_id && ! current_user_can( 'view_others_lifterlms_reports' ) && ! llms_current_user_can( 'view_lifterlms_reports', $student_id ) ) {
return;
}
if ( is_numeric( $args['student'] ) ) {
$args['student'] = new LLMS_Student( $args['student'] );
}
$this->student = $args['student'];
$this->tbody_data = $this->student->get_membership_levels();
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @since 2.3.0
* @since 3.35.0 Get student ID more reliably.
*
* @return array
*/
public function set_args() {
$student = false;
if ( ! empty( $this->student ) ) {
$student = $this->student->get_id();
} elseif ( ! empty( $_GET['student_id'] ) ) {
$student = llms_filter_input( INPUT_GET, 'student_id', FILTER_SANITIZE_NUMBER_INT );
}
return array(
'student' => $student,
);
}
/**
* Define the structure of the table
*
* @return array
* @since 3.2.0
* @version 3.2.0
*/
public function set_columns() {
return array(
'id' => array(
'title' => __( 'ID', 'lifterlms' ),
),
'name' => array(
'title' => __( 'Name', 'lifterlms' ),
),
'status' => array(
'title' => __( 'Status', 'lifterlms' ),
),
'enrolled' => array(
'title' => __( 'Enrolled', 'lifterlms' ),
),
);
}
/**
* Empty message displayed when no results are found
*
* @return string
* @since 3.2.0
* @version 3.2.0
*/
protected function set_empty_message() {
return __( 'This student is not enrolled in any memberships.', 'lifterlms' );
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.student.quiz.attempts.php
================================================
<?php
/**
* Student Quiz Attempts Reporting Table
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 9.1.0
* @version 9.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Table_Student_Quiz_Attempts class.
*
* Displays all quiz attempts for a specific student across all courses.
*
* @since 9.1.0
*/
class LLMS_Table_Student_Quiz_Attempts extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'student_quiz_attempts';
/**
* Value of the field being filtered by
* Only applicable if $filterby is set
*
* @var string
*/
protected $filter = 'any';
/**
* Field results are filtered by
*
* @var string
*/
protected $filterby = 'grade';
/**
* Is the Table Exportable?
*
* @var boolean
*/
protected $is_exportable = true;
/**
* Determine if the table is filterable
*
* @var boolean
*/
protected $is_filterable = true;
/**
* If true, tfoot will add ajax pagination links
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Determine of the table is searchable
*
* @var boolean
*/
protected $is_searchable = true;
/**
* Results sort order
* 'ASC' or 'DESC'
* Only applicable of $orderby is not set
*
* @var string
*/
protected $order = 'DESC';
/**
* Field results are sorted by
*
* @var string
*/
protected $orderby = 'id';
/**
* Student ID for the displayed student
*
* @var null
*/
protected $student_id = null;
/**
* Retrieve data for a cell.
*
* @since 9.1.0
*
* @param string $key The column id / key.
* @param LLMS_Quiz_Attempt $attempt LLMS_Quiz_Attempt obj.
* @return mixed
*/
protected function get_data( $key, $attempt ) {
switch ( $key ) {
case 'quiz':
$quiz = $attempt->get_quiz();
if ( $quiz ) {
$value = $quiz->get( 'title' );
// Add link to quiz attempts if user has permission
if ( current_user_can( 'edit_post', $quiz->get( 'id' ) ) ) {
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'tab' => 'quizzes',
'stab' => 'attempts',
'quiz_id' => $quiz->get( 'id' ),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . esc_html( $value ) . '</a>';
}
} else {
$value = __( '[Deleted Quiz]', 'lifterlms' );
}
break;
case 'course':
$value = '—';
$quiz = $attempt->get_quiz();
if ( $quiz ) {
$course = $quiz->get_course();
if ( $course ) {
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'tab' => 'courses',
'stab' => 'overview',
'course_id' => $course->get( 'id' ),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . esc_html( $course->get( 'title' ) ) . '</a>';
}
}
break;
case 'lesson':
$quiz = $attempt->get_quiz();
if ( $quiz ) {
$lesson = $quiz->get_lesson();
if ( $lesson ) {
$value = $lesson->get( 'title' );
} else {
$value = __( '[Deleted Lesson]', 'lifterlms' );
}
} else {
$value = '–';
}
break;
case 'attempt':
$value = '#' . $attempt->get( $key );
break;
case 'grade':
$value = $attempt->get( $key ) ? $attempt->get( $key ) . '%' : '0%';
$additional = $attempt->l10n( 'status' );
if ( $attempt->can_be_resumed() && $attempt->is_last_attempt() ) {
$additional .= ' - ' . esc_html__( 'Can be resumed', 'lifterlms' );
}
$value .= ' (' . $additional . ')';
break;
case 'start_date':
case 'end_date':
$value = '–';
$date = $attempt->get( $key );
if ( $date ) {
$value = date_i18n( get_option( 'date_format' ) . ' ' . get_option( 'time_format' ), strtotime( $date ) );
}
break;
case 'id':
$value = sprintf( '%2$d (%1$s)', $attempt->get_key(), $attempt->get( 'id' ) );
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'tab' => 'quizzes',
'stab' => 'attempts',
'quiz_id' => $attempt->get( 'quiz_id' ),
'attempt_id' => $attempt->get( 'id' ),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . $value . '</a>';
break;
default:
$value = $key;
}// End switch().
return $value;
}
/**
* Execute a query to retrieve results from the table
*
* @since 9.1.0
*
* @param array $args Array of query args.
* @return void
*/
public function get_results( $args = array() ) {
$this->title = __( 'Quiz Attempts', 'lifterlms' );
$args = $this->clean_args( $args );
$this->student_id = $args['student_id'];
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$per = apply_filters( 'llms_reporting_' . $this->id . '_per_page', 25 );
$this->order = isset( $args['order'] ) ? $args['order'] : $this->order;
$this->orderby = isset( $args['orderby'] ) ? $args['orderby'] : $this->orderby;
$this->filter = isset( $args['filter'] ) ? $args['filter'] : $this->get_filter();
$this->filterby = isset( $args['filterby'] ) ? $args['filterby'] : $this->get_filterby();
$query_args = array(
'sort' => array(
$this->orderby => $this->order,
),
'page' => $this->current_page,
'per_page' => $per,
'student_id' => $this->student_id,
);
// Add search functionality
if ( isset( $args['search'] ) && ! empty( $args['search'] ) ) {
$query_args['search'] = $args['search'];
}
if ( 'any' !== $this->filter ) {
$query_args['status'] = $this->filter;
}
// Check permissions
if ( ! current_user_can( 'view_others_lifterlms_reports' ) && ! llms_current_user_can( 'view_lifterlms_reports', $this->student_id ) ) {
return;
}
$query = new LLMS_Query_Quiz_Attempt( $query_args );
$this->max_pages = $query->get_max_pages();
$this->is_last_page = $query->is_last_page();
$this->tbody_data = $query->get_attempts();
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @since 9.1.0
*
* @return array
*/
public function set_args() {
return array(
'student_id' => ! empty( $this->student_id ) ? $this->student_id : ( isset( $_GET['student_id'] ) ? absint( $_GET['student_id'] ) : null ),
);
}
/**
* Define the structure of the table
*
* @return array
* @since 9.1.0
*/
protected function set_columns() {
$cols = array(
'id' => array(
'exportable' => true,
'title' => __( 'ID', 'lifterlms' ),
'sortable' => true,
),
'quiz' => array(
'exportable' => true,
'title' => __( 'Quiz', 'lifterlms' ),
'sortable' => false,
),
'course' => array(
'exportable' => true,
'title' => __( 'Course', 'lifterlms' ),
'sortable' => false,
),
'lesson' => array(
'exportable' => true,
'title' => __( 'Lesson', 'lifterlms' ),
'sortable' => false,
),
'attempt' => array(
'exportable' => true,
'title' => __( 'Attempt #', 'lifterlms' ),
'sortable' => true,
),
'grade' => array(
'filterable' => llms_get_quiz_attempt_statuses(),
'exportable' => true,
'title' => __( 'Grade', 'lifterlms' ),
'sortable' => true,
),
'start_date' => array(
'exportable' => true,
'title' => __( 'Start Date', 'lifterlms' ),
'sortable' => true,
),
'end_date' => array(
'exportable' => true,
'title' => __( 'End Date', 'lifterlms' ),
'sortable' => true,
),
);
return $cols;
}
}
================================================
FILE: includes/admin/reporting/tables/llms.table.students.php
================================================
<?php
/**
* Students Reporting Table
*
* @package LifterLMS/Admin/Reporting/Tables/Classes
*
* @since 3.2.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Table_Students class
*
* @since 3.2.0
* @since 3.28.0 Unknown.
* @since 3.31.0 Allow filtering the table by Course or Membership
* @since 3.36.0 Add "Last Seen" column.
* @since 3.36.1 Fixed "Last Seen" column displaying wrong date when the student last login date was saved as timestamp.
* @since 3.37.2 The post filter on the students table now limits post results based on instructor access.
*/
class LLMS_Table_Students extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'students';
/**
* Value of the field being filtered by
*
* Only applicable if $filterby is set.
*
* @since 3.31.0
* @var string
*/
protected $filter = '';
/**
* Field results are filtered by
*
* @since 3.31.0
* @var string
*/
protected $filterby = 'course_membership';
/**
* Is the Table Exportable?
*
* @var boolean
*/
protected $is_exportable = true;
/**
* Determine if the table is filterable
*
* @since 3.31.0
* @var boolean
*/
protected $is_filterable = true;
/**
* If true, tfoot will add ajax pagination links
*
* @var boolean
*/
protected $is_paginated = true;
/**
* Determine of the table is searchable
*
* @var boolean
*/
protected $is_searchable = true;
/**
* Results sort order
*
* 'ASC' or 'DESC'
* Only applicable of $orderby is not set.
*
* @var string
*/
protected $order = 'ASC';
/**
* Field results are sorted by
*
* @var string
*/
protected $orderby = 'name';
/**
* Number of records to display per page
*
* @var int
*/
protected $per_page = 25;
/**
* Retrieve data for the columns
*
* @since 3.2.0
* @since 3.15.0 Unknown.
* @since 3.36.0 Added "Last Seen" column.
* @since 3.36.1 Fixed "Last Seen" column displaying wrong date when the student last login date was saved as timestamp.
* @since 4.7.0 Speed up the query used to retrieve the last seen column by avoiding the found rows calculation.
* @since 6.0.0 Don't access `LLMS_Events_Query` properties directly
* Use `LLMS_Student::get_awards_count()` for retrieving the number of earned achievements and certificates.
*
* @param string $key The column id / key.
* @param LLMS_Student $student Instance of the LLMS_Student.
* @return mixed
*/
public function get_data( $key, $student ) {
switch ( $key ) {
case 'achievements':
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'stab' => 'achievements',
'student_id' => $student->get_id(),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . $student->get_awards_count( 'achievement' ) . '</a>';
break;
case 'certificates':
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'stab' => 'certificates',
'student_id' => $student->get_id(),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . $student->get_awards_count( 'certificate' ) . '</a>';
break;
case 'completions':
$courses = $student->get_completed_courses();
$value = count( $courses['results'] );
break;
case 'enrollments':
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'stab' => 'courses',
'student_id' => $student->get_id(),
)
);
$enrollments = $student->get_courses(
array(
'limit' => 1,
)
);
$value = '<a href="' . esc_url( $url ) . '">' . $enrollments['found'] . '</a>';
break;
case 'id':
$id = $student->get_id();
if ( current_user_can( 'list_users' ) ) {
$value = '<a href="' . esc_url( get_edit_user_link( $id ) ) . '">' . $id . '</a>';
} else {
$value = $id;
}
break;
case 'last_seen':
$query = new LLMS_Events_Query(
array(
'actor' => $student->get_id(),
'per_page' => 1,
'sort' => array(
'date' => 'DESC',
),
'no_found_rows' => true,
)
);
if ( $query->has_results() ) {
$events = $query->get_events();
$last = array_shift( $events );
$value = $last->get( 'date' );
} else {
$value = $student->get( 'last_login' );
}
$value = $value ? date_i18n( get_option( 'date_format' ), is_numeric( $value ) ? $value : strtotime( $value ) ) : '–';
break;
case 'memberships':
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'stab' => 'memberships',
'student_id' => $student->get_id(),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . count( $student->get_membership_levels() ) . '</a>';
break;
case 'name':
$first = $student->get( 'first_name' );
$last = $student->get( 'last_name' );
if ( ! $first || ! $last ) {
$value = $student->get( 'display_name' );
} else {
$value = $last . ', ' . $first;
}
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'student_id' => $student->get_id(),
)
);
$value = '<a href="' . esc_url( $url ) . '">' . $value . '</a>';
break;
case 'overall_grade':
$value = $student->get_overall_grade( true );
if ( is_numeric( $value ) ) {
$value .= '%';
}
break;
case 'overall_progress':
$value = $this->get_progress_bar_html( $student->get_overall_progress( true ) );
break;
case 'registered':
$value = $student->get_registration_date();
break;
default:
$value = $key;
}
return $this->filter_get_data( $value, $key, $student );
}
/**
* Retrieve data for a cell in an export file
*
* Should be overridden in extending classes.
*
* @since 3.15.0
* @since 3.26.1 Unknown.
*
* @param string $key The column id / key.
* @param LLMS_Student $student Instance of the LLMS_Student.
* @return mixed
*/
public function get_export_data( $key, $student ) {
switch ( $key ) {
case 'id':
$value = $student->get_id();
break;
case 'courses_cancelled':
case 'courses_enrolled':
case 'courses_expired':
$status = explode( '_', $key );
$status = array_pop( $status );
$courses = $student->get_courses(
array(
'status' => $status,
)
);
$titles = array();
foreach ( $courses['results'] as $id ) {
$titles[] = get_the_title( $id );
}
$value = implode( ', ', $titles );
break;
case 'email':
$value = $student->get( 'user_email' );
break;
case 'memberships_cancelled':
case 'memberships_enrolled':
case 'memberships_expired':
$status = explode( '_', $key );
$status = array_pop( $status );
$memberships = $student->get_memberships(
array(
'status' => $status,
)
);
$titles = array();
foreach ( $memberships['results'] as $id ) {
$titles[] = get_the_title( $id );
}
$value = implode( ', ', $titles );
break;
case 'name_first':
$value = $student->get( 'first_name' );
break;
case 'name_last':
$value = $student->get( 'last_name' );
break;
case 'overall_grade':
$value = $student->get_overall_grade( false );
if ( is_numeric( $value ) ) {
$value .= '%';
}
break;
case 'overall_progress':
$value = $student->get_overall_progress( false ) . '%';
break;
case 'billing_address_1':
case 'billing_address_2':
case 'billing_city':
case 'billing_state':
case 'billing_zip':
case 'billing_country':
case 'phone':
$value = $student->get( $key );
break;
default:
$value = $this->get_data( $key, $student );
}
return $this->filter_get_data( $value, $key, $student, 'export' );
}
/**
* Get the Text to be used as the placeholder in a searchable tables search input
*
* @since 3.2.0
* @since 3.15.0 Unknown.
*
* @return string
*/
public function get_table_search_form_placeholder() {
return apply_filters( 'llms_table_get_' . $this->id . '_search_placeholder', __( 'Search students by name or email...', 'lifterlms' ) );
}
public function output_table_title_html() {
parent::output_table_title_html();
?>
<form id="llms-clear-student-progress-cache" action="<?php echo esc_url( LLMS_Admin_Page_Status::get_url( 'tools' ) ); ?>" method="POST">
<button class="button button-secondary" id="llms-clear-reporting-cache" name="llms_tool" type="submit" value="clear-cache"><?php echo esc_html__( 'Clear Reporting Cache', 'lifterlms' ); ?></button>
<?php wp_nonce_field( 'llms_tool' ); ?>
<label for="llms-clear-reporting-cache">
<span class="screen-reader-text"><?php echo esc_html__( 'Click to refresh the data and display the most current reporting information', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php echo esc_html__( 'Click to refresh the data and display the most current reporting information', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
</form>
<?php
}
/**
* Get HTML for the filters displayed in the head of the table
*
* This overrides the LLMS_Admin_Table method.
*
* @since 3.31.0
* @since 3.37.2 Unknown.
*
* @return string
*/
public function output_table_filters_html() {
$select_id = sprintf( '%1$s-%2$s-filter', $this->id, 'course-membership' );
$instructor_id = null;
// Limit Course/Membership results based on instructor access.
if ( ! current_user_can( 'view_others_lifterlms_reports' ) && current_user_can( 'view_lifterlms_reports' ) ) {
$instructor = llms_get_instructor();
if ( $instructor ) {
$instructor_id = $instructor->get( 'id' );
}
}
?>
<div class="llms-table-filters">
<div class="llms-table-filter-wrap">
<label class="screen-reader-text" for="<?php echo esc_attr( $select_id ); ?>">
<?php esc_html_e( 'Choose Course/Membership', 'lifterlms' ); ?>
</label>
<select
data-post-type="llms_membership,course"
class="llms-posts-select2 llms-table-filter"
id="<?php echo esc_attr( $select_id ); ?>"
name="course_membership"
style="min-width:200px;max-width:500px;"
<?php if ( $instructor_id ) : ?>
data-instructor-id="<?php echo esc_attr( $instructor_id ); ?>"
<?php endif; ?>
></select>
</div>
</div>
<?php
}
/**
* Retrieve an array of query arguments to pass to the LLMS_Student_Query
*
* @since 3.28.0
* @since 3.31.0 Added logic to setup the query args in order to allow the filtering by Course or Membership.
*
* @return array
*/
private function get_query_args() {
$query_args = array(
'page' => $this->get_current_page(),
'post_id' => array(),
'per_page' => $this->get_per_page(),
'sort' => $this->get_sort(),
);
if ( 'status' === $this->get_filterby() && 'any' !== $this->get_filter() ) {
$query_args['statuses'] = array( $this->get_filter() );
} elseif ( 'course_membership' === $this->get_filterby() && '' !== $this->get_filter() ) {
$query_args['post_id'] = absint( $this->get_filter() );
$query_args['statuses'] = 'enrolled';
}
if ( $this->get_search() ) {
$query_args['search'] = $this->get_search();
}
return $query_args;
}
/**
* Execute a query to retrieve results from the table
*
* @since 3.2.0
* @since 3.28.0 Unknown.
* @since 6.0.0 Don't access `LLMS_Student_Query` properties directly.
*
* @param array $args Array of query args.
* @return void
*/
public function get_results( $args = array() ) {
// Current user can't access this report.
if ( ! current_user_can( 'view_others_lifterlms_reports' ) && ! current_user_can( 'view_lifterlms_reports' ) ) {
return;
}
$this->parse_args( $args );
$query_args = $this->get_query_args();
if ( current_user_can( 'view_others_lifterlms_reports' ) ) {
$query = new LLMS_Student_Query( $query_args );
} elseif ( current_user_can( 'view_lifterlms_reports' ) ) {
$instructor = llms_get_instructor();
if ( ! $instructor ) {
return;
}
$query = $instructor->get_students( $query_args );
}
$this->max_pages = $query->get_max_pages();
$this->is_last_page = $query->is_last_page();
$this->tbody_data = $query->get_students();
}
/**
* Setup the array of sort arguments to pass to the LLMS_Student_Query for the table
*
* @since 3.28.0
*
* @return array
*/
private function get_sort() {
$sort = array();
switch ( $this->get_orderby() ) {
case 'id':
$sort = array(
'id' => $this->get_order(),
);
break;
case 'name':
$sort = array(
'last_name' => $this->get_order(),
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
case 'overall_grade':
$sort = array(
'overall_grade' => $this->get_order(),
'last_name' => 'ASC',
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
case 'overall_progress':
$sort = array(
'overall_progress' => $this->get_order(),
'last_name' => 'ASC',
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
case 'registered':
$sort = array(
'registered' => $this->get_order(),
'last_name' => 'ASC',
'first_name' => 'ASC',
'id' => 'ASC',
);
break;
}
return $sort;
}
/**
* Parse arguments passed to get_results() method & setup table class variables.
*
* @since 3.28.0
* @since 3.31.0 Added logic to parse 'filterby' and 'filter' args when this table is filterable.
*
* @param array $args Array of arguments.
* @return void
*/
protected function parse_args( $args = array() ) {
if ( ! $args ) {
$args = $this->get_args();
}
$args = $this->clean_args( $args );
if ( isset( $args['page'] ) ) {
$this->current_page = absint( $args['page'] );
}
$this->order = isset( $args['order'] ) ? $args['order'] : $this->get_order();
$this->orderby = isset( $args['orderby'] ) ? $args['orderby'] : $this->get_orderby();
$this->per_page = isset( $args['per_page'] ) ? $args['per_page'] : $this->get_per_page();
if ( $this->is_filterable ) {
$this->filterby = isset( $args['filterby'] ) ? $args['filterby'] : $this->get_filterby();
$this->filter = isset( $args['filter'] ) ? $args['filter'] : $this->get_filter();
}
if ( isset( $args['search'] ) ) {
$this->search = $args['search'];
}
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @since 2.3.0
* @since 3.28.0 Unknown.
*
* @return array
*/
public function set_args() {
return array(
'per_page' => apply_filters( 'llms_table_' . $this->id . '_per_page', $this->per_page ),
);
}
/**
* Define the structure of the table
*
* @since 3.2.0
* @since 3.15.0 Unknown.
* @since 3.36.0 Add "Last Seen" column.
*
* @return array
*/
public function set_columns() {
return array(
'id' => array(
'exportable' => true,
'sortable' => true,
'title' => __( 'ID', 'lifterlms' ),
),
'email' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Email', 'lifterlms' ),
),
'name' => array(
'sortable' => true,
'title' => __( 'Name', 'lifterlms' ),
),
'name_last' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Last Name', 'lifterlms' ),
),
'name_first' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'First Name', 'lifterlms' ),
),
'registered' => array(
'exportable' => true,
'sortable' => true,
'title' => __( 'Registration Date', 'lifterlms' ),
),
'last_seen' => array(
'exportable' => true,
'sortable' => false,
'title' => __( 'Last Seen', 'lifterlms' ),
),
'overall_progress' => array(
'exportable' => true,
'sortable' => true,
'title' => __( 'Progress', 'lifterlms' ),
),
'overall_grade' => array(
'exportable' => true,
'sortable' => true,
'title' => __( 'Grade', 'lifterlms' ),
),
'enrollments' => array(
'sortable' => false,
'title' => __( 'Enrollments', 'lifterlms' ),
),
'completions' => array(
'sortable' => false,
'title' => __( 'Completions', 'lifterlms' ),
),
'certificates' => array(
'sortable' => false,
'title' => __( 'Certificates', 'lifterlms' ),
),
'achievements' => array(
'sortable' => false,
'title' => __( 'Achievements', 'lifterlms' ),
),
'memberships' => array(
'sortable' => false,
'title' => __( 'Memberships', 'lifterlms' ),
),
'billing_address_1' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Billing Address 1', 'lifterlms' ),
),
'billing_address_2' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Billing Address 2', 'lifterlms' ),
),
'billing_city' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Billing City', 'lifterlms' ),
),
'billing_state' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Billing State', 'lifterlms' ),
),
'billing_zip' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Billing Zip', 'lifterlms' ),
),
'billing_country' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Billing Country', 'lifterlms' ),
),
'phone' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Phone', 'lifterlms' ),
),
'courses_enrolled' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Courses (Enrolled)', 'lifterlms' ),
),
'courses_cancelled' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Courses (Cancelled)', 'lifterlms' ),
),
'courses_expired' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Courses (Expired)', 'lifterlms' ),
),
'memberships_enrolled' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Memberships (Enrolled)', 'lifterlms' ),
),
'memberships_cancelled' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Memberships (Cancelled)', 'lifterlms' ),
),
'memberships_expired' => array(
'exportable' => true,
'export_only' => true,
'title' => __( 'Memberships (Expired)', 'lifterlms' ),
),
);
}
/**
* Set the table's title.
*
* @since 3.28.0
*
* @return string
*/
protected function set_title() {
return __( 'Students', 'lifterlms' );
}
}
================================================
FILE: includes/admin/reporting/tabs/class.llms.admin.reporting.tab.courses.php
================================================
<?php
/**
* Courses Tab on Reporting Screen
*
* @package LifterLMS/Admin/Reporting/Tabs/Classes
*
* @since 3.15.0
* @version 3.35.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Reporting_Tab_Courses
*
* @since 3.15.0
* @since 3.35.0 Sanitize input data.
*/
class LLMS_Admin_Reporting_Tab_Courses {
/**
* Constructor
*
* @return void
* @since 3.15.0
*/
public function __construct() {
add_action( 'llms_reporting_content_courses', array( $this, 'output' ) );
add_action( 'llms_reporting_course_tab_breadcrumbs', array( $this, 'breadcrumbs' ) );
}
/**
* Add breadcrumb links to the tab depending on current view
*
* @return void
* @since 3.2.0
* @version 3.2.0
*/
public function breadcrumbs() {
$links = array();
// Single student.
if ( isset( $_GET['course_id'] ) ) {
$course = llms_get_post( absint( $_GET['course_id'] ) );
$links[ LLMS_Admin_Reporting::get_stab_url( 'overview' ) ] = $course->get( 'title' );
}
foreach ( $links as $url => $title ) {
echo '<a href="' . esc_url( $url ) . '">' . esc_html( $title ) . '</a>';
}
}
/**
* Output tab content
*
* @since 3.15.0
* @since 3.35.0 Sanitize input data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public function output() {
// Single course.
if ( isset( $_GET['course_id'] ) ) {
if ( ! current_user_can( 'edit_post', llms_filter_input( INPUT_GET, 'course_id', FILTER_SANITIZE_NUMBER_INT ) ) ) {
wp_die( esc_html__( 'You do not have permission to access this content.', 'lifterlms' ) );
}
$tabs = apply_filters(
'llms_reporting_tab_course_tabs',
array(
'overview' => __( 'Overview', 'lifterlms' ),
'students' => __( 'Students', 'lifterlms' ),
)
);
llms_get_template(
'admin/reporting/tabs/courses/course.php',
array(
'current_tab' => isset( $_GET['stab'] ) ? esc_attr( llms_filter_input_sanitize_string( INPUT_GET, 'stab' ) ) : 'overview',
'tabs' => $tabs,
'course' => llms_get_post( intval( $_GET['course_id'] ) ),
)
);
} else {
$table = new LLMS_Table_Courses();
$table->get_results();
$table->output_table_html();
}
}
}
return new LLMS_Admin_Reporting_Tab_Courses();
================================================
FILE: includes/admin/reporting/tabs/class.llms.admin.reporting.tab.enrollments.php
================================================
<?php
/**
* Enrollments Tab on Reporting Screen
*
* @package LifterLMS/Admin/Reporting/Tabs/Classes
*
* @since 3.2.0
* @version 3.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Reporting_Tab_Enrollments class
*
* @since 3.2.0
* @since 3.5.0 Unknown.
*/
class LLMS_Admin_Reporting_Tab_Enrollments {
/**
* Constructor
*
* @since 3.2.0
* @version 3.2.0
*/
public function __construct() {
add_action( 'llms_reporting_after_nav', array( $this, 'output_filters' ), 10, 1 );
add_action( 'llms_reporting_content_enrollments', array( $this, 'output' ) );
}
public static function get_filter_data() {
$data = array();
$data['current_tab'] = LLMS_Admin_Reporting::get_current_tab();
$data['current_range'] = LLMS_Admin_Reporting::get_current_range();
$data['current_students'] = LLMS_Admin_Reporting::get_current_students();
$data['current_courses'] = LLMS_Admin_Reporting::get_current_courses();
$data['current_memberships'] = LLMS_Admin_Reporting::get_current_memberships();
$data['dates'] = LLMS_Admin_Reporting::get_dates( $data['current_range'] );
$data['date_start'] = $data['dates']['start'];
$data['date_end'] = $data['dates']['end'];
return $data;
}
/**
* Get an array of ajax widgets to load on page load
*
* @return array
* @since 3.2.0
* @version 3.5.0
*/
public function get_widget_data() {
return apply_filters(
'llms_reporting_tab_enrollments_widgets',
array(
array(
'registrations' => array(
'title' => __( 'Registrations', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Number of total user registrations during the selected period', 'lifterlms' ),
),
'enrollments' => array(
'title' => __( 'Enrollments', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Number of total enrollments during the selected period', 'lifterlms' ),
),
'coursecompletions' => array(
'title' => __( 'Courses Completed', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Number of total courses completed during the selected period', 'lifterlms' ),
),
'lessoncompletions' => array(
'title' => __( 'Lessons Completed', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Number of total lessons completed during the selected period', 'lifterlms' ),
),
),
)
);
}
/**
* Output the template for the sales tab
*
* @return void
* @since 3.2.0
* @version 3.2.0
*/
public function output() {
llms_get_template(
'admin/reporting/tabs/widgets.php',
array(
'json' => json_encode( self::get_filter_data() ),
'widget_data' => $this->get_widget_data(),
)
);
}
/**
* Output filters navigation
*
* @return void
* @since 3.2.0
* @version 3.2.0
*/
public function output_filters( $tab ) {
if ( 'enrollments' === $tab ) {
llms_get_template( 'admin/reporting/nav-filters.php', self::get_filter_data() );
}
}
}
return new LLMS_Admin_Reporting_Tab_Enrollments();
================================================
FILE: includes/admin/reporting/tabs/class.llms.admin.reporting.tab.memberships.php
================================================
<?php
/**
* Memberships Tab on Reporting Screen
*
* @package LifterLMS/Admin/Reporting/Tabs/Classes
*
* @since 3.32.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Memberships Tab on Reporting Screen class
*
* @since 3.32.0
* @since 3.35.0 Sanitize input data.
*/
class LLMS_Admin_Reporting_Tab_Memberships {
/**
* Constructor.
*
* @since 3.32.0
*
* @return void
*/
public function __construct() {
add_action( 'llms_reporting_content_memberships', array( $this, 'output' ) );
add_action( 'llms_reporting_membership_tab_breadcrumbs', array( $this, 'breadcrumbs' ) );
}
/**
* Add breadcrumb links to the tab depending on current view.
*
* @since 3.32.0
*
* @return void
*/
public function breadcrumbs() {
$links = array();
// Single student.
if ( isset( $_GET['membership_id'] ) ) {
$membership = llms_get_post( absint( $_GET['membership_id'] ) );
$links[ LLMS_Admin_Reporting::get_stab_url( 'overview' ) ] = $membership->get( 'title' );
}
foreach ( $links as $url => $title ) {
echo '<a href="' . esc_url( $url ) . '">' . esc_html( $title ) . '</a>';
}
}
/**
* Output tab content.
*
* @since 3.32.0
* @since 3.35.0 Sanitize input data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public function output() {
// Single membership.
if ( isset( $_GET['membership_id'] ) ) {
if ( ! current_user_can( 'edit_post', llms_filter_input( INPUT_GET, 'membership_id', FILTER_SANITIZE_NUMBER_INT ) ) ) {
wp_die( esc_html__( 'You do not have permission to access this content.', 'lifterlms' ) );
}
$tabs = apply_filters(
'llms_reporting_tab_membership_tabs',
array(
'overview' => __( 'Overview', 'lifterlms' ),
'students' => __( 'Students', 'lifterlms' ),
)
);
llms_get_template(
'admin/reporting/tabs/memberships/membership.php',
array(
'current_tab' => isset( $_GET['stab'] ) ? esc_attr( llms_filter_input_sanitize_string( INPUT_GET, 'stab' ) ) : 'overview',
'tabs' => $tabs,
'membership' => llms_get_post( intval( $_GET['membership_id'] ) ),
)
);
} else {
$table = new LLMS_Table_Memberships();
$table->get_results();
$table->output_table_html();
}
}
}
return new LLMS_Admin_Reporting_Tab_Memberships();
================================================
FILE: includes/admin/reporting/tabs/class.llms.admin.reporting.tab.quizzes.php
================================================
<?php
/**
* Quizzes Tab on Reporting Screen
*
* @package LifterLMS/Admin/Reporting/Tabs/Classes
*
* @since 3.16.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Reporting_Tab_Quizzes
*
* @since 3.16.0
* @since 3.35.0 Sanitize input data.
*/
class LLMS_Admin_Reporting_Tab_Quizzes {
/**
* Constructor
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
public function __construct() {
add_action( 'llms_reporting_content_quizzes', array( $this, 'output' ) );
add_action( 'llms_reporting_quiz_tab_breadcrumbs', array( $this, 'breadcrumbs' ) );
}
/**
* Add breadcrumb links to the tab depending on current view
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
public function breadcrumbs() {
$links = array();
// Single quiz.
if ( isset( $_GET['quiz_id'] ) ) {
$quiz = llms_get_post( absint( $_GET['quiz_id'] ) );
$links[ LLMS_Admin_Reporting::get_stab_url( 'overview' ) ] = $quiz->get( 'title' );
}
if ( isset( $_GET['attempt_id'] ) ) {
$attempt = new LLMS_Quiz_Attempt( absint( $_GET['attempt_id'] ) );
$links[ LLMS_Admin_Reporting::get_stab_url( 'attempts' ) ] = $attempt->get_title();
}
foreach ( $links as $url => $title ) {
echo '<a href="' . esc_url( $url ) . '">' . esc_html( $title ) . '</a>';
}
}
/**
* Output tab content
*
* @since 3.16.0
* @since 3.35.0 Sanitize input data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public function output() {
// Single quiz.
if ( isset( $_GET['quiz_id'] ) ) {
if ( ! current_user_can( 'edit_post', llms_filter_input( INPUT_GET, 'quiz_id', FILTER_SANITIZE_NUMBER_INT ) ) ) {
wp_die( esc_html__( 'You do not have permission to access this content.', 'lifterlms' ) );
}
$tabs = apply_filters(
'llms_reporting_tab_quiz_tabs',
array(
'overview' => __( 'Overview', 'lifterlms' ),
'attempts' => __( 'Attempts', 'lifterlms' ),
'non-attempts' => __( 'Students Without Attempts', 'lifterlms' ),
)
);
llms_get_template(
'admin/reporting/tabs/quizzes/quiz.php',
array(
'current_tab' => isset( $_GET['stab'] ) ? esc_attr( llms_filter_input_sanitize_string( INPUT_GET, 'stab' ) ) : 'overview',
'tabs' => $tabs,
'quiz' => llms_get_post( intval( $_GET['quiz_id'] ) ),
)
);
// Quiz table.
} else {
$table = new LLMS_Table_Quizzes();
$table->get_results();
$table->output_table_html();
}
}
}
return new LLMS_Admin_Reporting_Tab_Quizzes();
================================================
FILE: includes/admin/reporting/tabs/class.llms.admin.reporting.tab.sales.php
================================================
<?php
/**
* Sales Tab on Reporting Screen
*
* @package LifterLMS/Admin/Reporting/Tabs/Classes
*
* @since 3.2.0
* @version 3.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Reporting_Tab_Sales class
*
* @since 3.2.0
*/
class LLMS_Admin_Reporting_Tab_Sales {
/**
* Constructor
*
* @since 3.2.0
* @version 3.2.0
*/
public function __construct() {
add_action( 'llms_reporting_after_nav', array( $this, 'output_filters' ), 10, 1 );
add_action( 'llms_reporting_content_sales', array( $this, 'output' ) );
}
public static function get_filter_data() {
$data = array();
$data['current_tab'] = LLMS_Admin_Reporting::get_current_tab();
$data['current_range'] = LLMS_Admin_Reporting::get_current_range();
$data['current_students'] = LLMS_Admin_Reporting::get_current_students();
$data['current_courses'] = LLMS_Admin_Reporting::get_current_courses();
$data['current_memberships'] = LLMS_Admin_Reporting::get_current_memberships();
$data['dates'] = LLMS_Admin_Reporting::get_dates( $data['current_range'] );
$data['date_start'] = $data['dates']['start'];
$data['date_end'] = $data['dates']['end'];
return $data;
}
/**
* Get an array of ajax widgets to load on page load
*
* @return array
* @since 3.2.0
* @version 3.2.0
*/
public function get_widget_data() {
return apply_filters(
'llms_reporting_tab_sales_widgets',
array(
array(
'sales' => array(
'title' => __( '# of New Sales', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Number of new non-refunded orders placed within this period', 'lifterlms' ),
),
'sold' => array(
'title' => __( 'Net Revenue', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Total of all successful transactions during this period', 'lifterlms' ),
),
'refunds' => array(
'title' => __( '# of Refunds', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Number of orders refunded during this period', 'lifterlms' ),
),
'refunded' => array(
'title' => __( 'Amount Refunded', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Total of all transactions refunded during this period', 'lifterlms' ),
),
),
array(
'coupons' => array(
'title' => __( '# of Coupons Used', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Number of orders completed using coupons during this period', 'lifterlms' ),
),
'discounts' => array(
'title' => __( 'Amount of Coupons', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Total amount of coupons used during this period', 'lifterlms' ),
),
'transactions' => array(
'title' => __( '# of Transactions', 'lifterlms' ),
'cols' => '1-4',
'content' => __( 'loading...', 'lifterlms' ),
'info' => __( 'Number of transactions within this period', 'lifterlms' ),
),
),
)
);
}
/**
* Output the template for the sales tab
*
* @return void
* @since 3.2.0
* @version 3.2.0
*/
public function output() {
llms_get_template(
'admin/reporting/tabs/widgets.php',
array(
'json' => json_encode( self::get_filter_data() ),
'widget_data' => $this->get_widget_data(),
)
);
}
/**
* Output filters navigation
*
* @return void
* @since 3.2.0
* @version 3.2.0
*/
public function output_filters( $tab ) {
if ( 'sales' === $tab ) {
llms_get_template( 'admin/reporting/nav-filters.php', self::get_filter_data() );
}
}
}
return new LLMS_Admin_Reporting_Tab_Sales();
================================================
FILE: includes/admin/reporting/tabs/class.llms.admin.reporting.tab.students.php
================================================
<?php
/**
* LLMS_Admin_Reporting_Tab_Students class file
*
* @package LifterLMS/Admin/Reporting/Tabs/Classes
*
* @since 3.2.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Students Tab on Reporting Screen
*
* @since 3.2.0
*/
class LLMS_Admin_Reporting_Tab_Students {
/**
* Constructor
*
* @since 3.2.0
*
* @return void
*/
public function __construct() {
add_action( 'llms_reporting_content_students', array( $this, 'output' ) );
add_action( 'llms_reporting_student_tab_breadcrumbs', array( $this, 'breadcrumbs' ) );
}
/**
* Add breadcrumb links to the tab depending on current view
*
* @since 3.2.0
* @since 3.35.0 Sanitize input data.
*
* @return void
*/
public function breadcrumbs() {
$links = array();
// Single student.
if ( isset( $_GET['student_id'] ) ) {
$student = new LLMS_Student( absint( $_GET['student_id'] ) );
$links[ LLMS_Admin_Reporting::get_stab_url( 'information' ) ] = $student->get_name();
if ( isset( $_GET['stab'] ) && 'courses' === $_GET['stab'] ) {
$links[ LLMS_Admin_Reporting::get_stab_url( 'courses' ) ] = __( 'All Courses', 'lifterlms' );
if ( isset( $_GET['course_id'] ) ) {
$course_id = llms_filter_input( INPUT_GET, 'course_id', FILTER_SANITIZE_NUMBER_INT );
$student_id = llms_filter_input( INPUT_GET, 'student_id', FILTER_SANITIZE_NUMBER_INT );
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'stab' => 'courses',
'student_id' => $student_id,
'course_id' => $course_id,
)
);
$links[ $url ] = get_the_title( $course_id );
if ( isset( $_GET['quiz_id'] ) ) {
$quiz_id = llms_filter_input( INPUT_GET, 'quiz_id', FILTER_SANITIZE_NUMBER_INT );
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'stab' => 'courses',
'student_id' => $student_id,
'course_id' => $course_id,
'quiz_id' => $quiz_id,
)
);
$links[ $url ] = get_the_title( $quiz_id );
}
}
}
}
foreach ( $links as $url => $title ) {
echo '<a href="' . esc_url( $url ) . '">' . esc_html( $title ) . '</a>';
}
}
/**
* Output HTML for the current view within the students tab
*
* @since 3.2.0
* @since 4.20.0 Added a report permission check and a user existence check.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public function output() {
// Single student.
if ( isset( $_GET['student_id'] ) ) {
$student_id = llms_filter_input( INPUT_GET, 'student_id', FILTER_SANITIZE_NUMBER_INT );
if ( ! llms_current_user_can( 'view_lifterlms_reports', $student_id ) ) {
wp_die( esc_html__( "You do not have permission to access this student's reports", 'lifterlms' ) );
}
$student = llms_get_student( $student_id );
if ( ! $student ) {
wp_die( esc_html__( "This student doesn't exist.", 'lifterlms' ) );
}
$tabs = apply_filters(
'llms_reporting_tab_student_tabs',
array(
'information' => __( 'Information', 'lifterlms' ),
'courses' => __( 'Courses', 'lifterlms' ),
'memberships' => __( 'Memberships', 'lifterlms' ),
'achievements' => __( 'Achievements', 'lifterlms' ),
'certificates' => __( 'Certificates', 'lifterlms' ),
'quiz_attempts' => __( 'Quiz Attempts', 'lifterlms' ),
)
);
llms_get_template(
'admin/reporting/tabs/students/student.php',
array(
'current_tab' => isset( $_GET['stab'] ) ? esc_attr( llms_filter_input_sanitize_string( INPUT_GET, 'stab' ) ) : 'information',
'tabs' => $tabs,
'student' => $student,
)
);
} else {
llms_get_template( 'admin/reporting/tabs/students/students.php' );
}
}
}
return new LLMS_Admin_Reporting_Tab_Students();
================================================
FILE: includes/admin/reporting/tabs/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.ajax.php
================================================
<?php
/**
* Register WordPress AJAX methods for Analytics Widgets
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
* @version 7.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Analytics_Widget_Ajax class
*
* @since 3.0.0
* @since 3.35.0 Sanitize `$_REQUEST` data.
*/
class LLMS_Analytics_Widget_Ajax {
/**
* Constructor.
*
* @since 3.0.0
* @since 3.16.8 Unknown.
* @since 3.35.0 Sanitize `$_REQUEST` data.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
* @since 7.3.0 Ajax calls are now handled by `LLMS_Analytics_Widget_Ajax::handle()` method.
*
* @return void
*/
public function __construct() {
// Only proceed if we're doing ajax.
if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || ! isset( $_REQUEST['action'] ) ) {
return;
}
$methods = array(
// Sales.
'coupons',
'discounts',
'refunded',
'refunds',
'revenue',
'sales',
'sold',
// Enrollments.
'enrollments',
'registrations',
'lessoncompletions',
'coursecompletions',
);
$method = str_replace( 'llms_widget_', '', sanitize_text_field( wp_unslash( $_REQUEST['action'] ) ) );
$file = LLMS_PLUGIN_DIR . 'includes/admin/reporting/widgets/class.llms.analytics.widget.' . $method . '.php';
if ( file_exists( $file ) ) {
add_action( 'wp_ajax_llms_widget_' . $method, array( __CLASS__, 'handle' ) );
}
}
/**
* Handles the AJAX request.
*
* @since 7.3.0
*
* @return void
*/
public static function handle() {
// Make sure we are getting a valid AJAX request.
check_ajax_referer( LLMS_Ajax::NONCE );
$method = str_replace(
'llms_widget_',
'',
sanitize_text_field( wp_unslash( $_REQUEST['action'] ?? '' ) )
);
$class = 'LLMS_Analytics_' . ucwords( $method ) . '_Widget';
if ( ! class_exists( $class ) ) {
return;
}
$widget = new $class();
$can_be_processed = $widget->can_be_processed();
if ( is_wp_error( $can_be_processed ) ) {
wp_send_json_error( $can_be_processed );
wp_die();
}
$widget->output();
}
}
return new LLMS_Analytics_Widget_Ajax();
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.coupons.php
================================================
<?php
/**
* Coupons analytics widget
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
* @version 3.18.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Coupons analytics widget class
*
* Locates number of active / completed orders from a given date range
* by a given group of students.
*
* @since 3.0.0
* @since 3.18.0 Unknown.
*/
class LLMS_Analytics_Coupons_Widget extends LLMS_Analytics_Widget {
public $charts = true;
/**
* Retrieve data for chart
*
* @return array
* @since 3.0.0
* @version 3.0.0
*/
protected function get_chart_data() {
return array(
'type' => 'count',
'header' => array(
'id' => 'coupons',
'label' => __( '# of Coupons Used', 'lifterlms' ),
'type' => 'number',
),
);
}
/**
* Setup the query
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
public function set_query() {
global $wpdb;
$this->set_order_data_query(
array(
'query_function' => 'get_results',
'select' => array(
'orders.post_date AS date',
),
'joins' => array(
"JOIN {$wpdb->postmeta} AS coupons ON orders.ID = coupons.post_id",
),
'statuses' => array(
'llms-active',
'llms-completed',
),
'wheres' => array(
" AND coupons.meta_key = '_llms_coupon_used'",
" AND coupons.meta_value = 'yes'",
),
)
);
}
/**
* Format the response
*
* @return int
* @since 3.0.0
* @version 3.18.0
*/
protected function format_response() {
if ( ! $this->is_error() ) {
return count( $this->get_results() );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.coursecompletions.php
================================================
<?php
/**
* Course Completions analytics widget
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.5.0
* @version 3.5.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Course Completions analytics widget class
*
* @since 3.5.0
* @version 3.5.3
*/
class LLMS_Analytics_Coursecompletions_Widget extends LLMS_Analytics_Widget {
public $charts = true;
protected function get_chart_data() {
return array(
'type' => 'count', // Type of field.
'header' => array(
'id' => 'coursecompletions',
'label' => __( '# of Courses Completed', 'lifterlms' ),
'type' => 'number',
),
);
}
public function set_query() {
global $wpdb;
$dates = $this->get_posted_dates();
$student_ids = '';
$students = $this->get_posted_students();
if ( $students ) {
$student_ids .= 'AND user_id IN ( ' . implode( ', ', $students ) . ' )';
}
$lesson_ids = '';
$products = $this->get_posted_posts();
if ( $products ) {
$lesson_ids .= 'AND post_id IN ( ' . implode( ', ', $products ) . ' )';
}
$this->query_function = 'get_results';
$this->output_type = OBJECT;
$this->query = "SELECT updated_date AS date
FROM {$wpdb->prefix}lifterlms_user_postmeta AS upm
JOIN {$wpdb->posts} AS p ON p.ID = upm.post_id
WHERE
upm.meta_key = '_is_complete'
AND p.post_type = 'course'
AND upm.meta_value = 'yes'
AND upm.updated_date >= CAST( %s as DATETIME )
AND upm.updated_date < CAST( %s as DATETIME )
{$student_ids}
{$lesson_ids}
;";
$this->query_vars = array(
$this->format_date( $dates['start'], 'start' ),
$this->format_date( $dates['end'], 'end' ),
);
}
protected function format_response() {
if ( ! $this->is_error() ) {
return count( $this->get_results() );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.discounts.php
================================================
<?php
/**
* Total amount of coupon discount savings
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
* @version 3.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Analytics_Discounts_Widget class
*
* Totals all coupon discounts applied to orders in the given filters.
*
* @since 3.0.0
*/
class LLMS_Analytics_Discounts_Widget extends LLMS_Analytics_Widget {
public function set_query() {
global $wpdb;
$this->set_order_data_query(
array(
'query_function' => 'get_var',
'select' => array(
'SUM( cp_val.meta_value )',
),
'joins' => array(
"JOIN {$wpdb->postmeta} AS cp ON orders.ID = cp.post_id",
"JOIN {$wpdb->postmeta} AS cp_val ON orders.ID = cp_val.post_id",
),
'statuses' => array(
'llms-active',
'llms-completed',
),
'wheres' => array(
" AND cp.meta_key = '_llms_coupon_used'",
" AND cp.meta_value = 'yes'",
" AND cp_val.meta_key = '_llms_coupon_value'",
),
)
);
}
protected function format_response() {
if ( ! $this->is_error() ) {
return llms_price_raw( floatval( $this->get_results() ) );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.enrollments.php
================================================
<?php
/**
* Enrollments analytics widget
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
* @version 3.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Analytics_Enrollments_Widget class
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
*/
class LLMS_Analytics_Enrollments_Widget extends LLMS_Analytics_Widget {
public $charts = true;
protected function get_chart_data() {
return array(
'type' => 'count', // Type of field.
'header' => array(
'id' => 'enrollments',
'label' => __( '# of Enrollments', 'lifterlms' ),
'type' => 'number',
),
);
}
public function set_query() {
global $wpdb;
$dates = $this->get_posted_dates();
$student_ids = '';
$students = $this->get_posted_students();
if ( $students ) {
$student_ids .= 'AND user_id IN ( ' . implode( ', ', $students ) . ' )';
}
$product_ids = '';
$products = $this->get_posted_posts();
if ( $products ) {
$product_ids .= 'AND post_id IN ( ' . implode( ', ', $products ) . ' )';
}
$this->query_function = 'get_results';
$this->output_type = OBJECT;
$this->query = "SELECT updated_date AS date
FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE
meta_key = '_status'
AND ( meta_value = 'Enrolled' OR meta_value = 'enrolled' )
AND updated_date >= CAST( %s as DATETIME )
AND updated_date < CAST( %s as DATETIME )
{$student_ids}
{$product_ids}
;";
$this->query_vars = array(
$this->format_date( $dates['start'], 'start' ),
$this->format_date( $dates['end'], 'end' ),
);
}
protected function format_response() {
if ( ! $this->is_error() ) {
return count( $this->get_results() );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.lessoncompletions.php
================================================
<?php
/**
* Lesson Completions analytics widget
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.5.0
* @version 3.5.3
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Analytics_Lessoncompletions_Widget class
*
* @since 3.5.0
* @since 3.5.3 Unknown.
*/
class LLMS_Analytics_Lessoncompletions_Widget extends LLMS_Analytics_Widget {
public $charts = true;
protected function get_chart_data() {
return array(
'type' => 'count', // Type of field.
'header' => array(
'id' => 'lessoncompletions',
'label' => __( '# of Lessons Completed', 'lifterlms' ),
'type' => 'number',
),
);
}
/**
* Retrieve an array of lesson ids for all the products in the current filter
*
* @param array $products array of product ids
* @return array
* @since 3.5.0
* @version 3.5.0
*/
private function get_lesson_ids( $products ) {
$lessons = array();
// Loop through all products.
foreach ( $products as $product ) {
// Ignore the memberships.
if ( 'llms_membership' === get_post_type( $product ) ) {
continue;
}
// Get the course.
$course = llms_get_post( $product );
$lessons = array_merge( $course->get_lessons( 'ids' ) );
}
return $lessons;
}
public function set_query() {
global $wpdb;
$dates = $this->get_posted_dates();
$student_ids = '';
$students = $this->get_posted_students();
if ( $students ) {
$student_ids .= 'AND user_id IN ( ' . implode( ', ', $students ) . ' )';
}
$lesson_ids = '';
$products = $this->get_posted_posts();
if ( $products ) {
$lesson_ids .= 'AND post_id IN ( ' . implode( ', ', $this->get_lesson_ids( $products ) ) . ' )';
}
$this->query_function = 'get_results';
$this->output_type = OBJECT;
$this->query = "SELECT updated_date AS date
FROM {$wpdb->prefix}lifterlms_user_postmeta AS upm
JOIN {$wpdb->posts} AS p ON p.ID = upm.post_id
WHERE
upm.meta_key = '_is_complete'
AND p.post_type = 'lesson'
AND upm.meta_value = 'yes'
AND upm.updated_date >= CAST( %s as DATETIME )
AND upm.updated_date < CAST( %s as DATETIME )
{$student_ids}
{$lesson_ids}
;";
$this->query_vars = array(
$this->format_date( $dates['start'], 'start' ),
$this->format_date( $dates['end'], 'end' ),
);
}
protected function format_response() {
if ( ! $this->is_error() ) {
return count( $this->get_results() );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.refunded.php
================================================
<?php
/**
* Refunded Amount Widget
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
* @version 3.36.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Refunded Amount Widget class
*
* Retrieves the total amount of all refunded transactions
* according to active filters.
*
* @since 3.0.0
* @since 3.36.3 In `format_response()` method avoid running `wp_list_pluck()` on non arrays.
*/
class LLMS_Analytics_Refunded_Widget extends LLMS_Analytics_Widget {
public $charts = true;
protected function get_chart_data() {
return array(
'type' => 'amount', // Type of field.
'key' => 'amount', // Key of result field to add when counting.
'header' => array(
'id' => 'refunded',
'label' => __( 'Amount Refunded', 'lifterlms' ),
'type' => 'number',
),
);
}
public function set_query() {
global $wpdb;
$txn_meta_join = '';
$txn_meta_where = '';
// create an "IN" clause that can be used for later in WHERE clauses.
if ( $this->get_posted_students() || $this->get_posted_posts() ) {
// get an array of order based on posted students & products.
$this->set_order_data_query(
array(
'date_range' => false,
'query_function' => 'get_col',
'select' => array(
'orders.ID',
),
)
);
$this->query();
$order_ids = $this->get_results();
if ( $order_ids ) {
$txn_meta_join = "JOIN {$wpdb->postmeta} AS txn_meta ON txn_meta.post_id = txns.ID";
$txn_meta_where .= " AND txn_meta.meta_key = '_llms_order_id'";
$txn_meta_where .= ' AND txn_meta.meta_value IN ( ' . implode( ', ', $order_ids ) . ' )';
} else {
$this->query_function = 'get_var';
$this->query = 'SELECT 0';
return;
}
}
// date range will be used to get transactions between given dates.
$dates = $this->get_posted_dates();
$this->query_vars = array(
$this->format_date( $dates['start'], 'start' ),
$this->format_date( $dates['end'], 'end' ),
);
$this->query_function = 'get_results';
$this->output_type = OBJECT;
$this->query = "SELECT
txns.post_modified AS date
, refund.meta_value AS amount
FROM {$wpdb->posts} AS txns
{$txn_meta_join}
JOIN {$wpdb->postmeta} AS refund ON refund.post_id = txns.ID
WHERE
( txns.post_status = 'llms-txn-succeeded' OR txns.post_status = 'llms-txn-refunded' )
AND txns.post_type = 'llms_transaction'
AND txns.post_modified >= CAST( %s as DATETIME )
AND txns.post_modified < CAST( %s as DATETIME )
AND refund.meta_key = '_llms_refund_amount'
{$txn_meta_where}
ORDER BY txns.post_modified ASC
;";
}
/**
* Format response.
*
* @since unknown
* @since 3.36.3 Avoid running `wp_list_pluck()` on non arrays.
*/
protected function format_response() {
if ( ! $this->is_error() ) {
$results = $this->get_results();
return llms_price_raw( floatval( is_array( $results ) ? array_sum( wp_list_pluck( $results, 'amount' ) ) : $results ) );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.refunds.php
================================================
<?php
/**
* Refunds analytics widget
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
* @version 3.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Refunds analytics widget class
*
* Locates number of refunded orders from a given date range
* by a given group of students.
*
* Uses "post_modified" rather than "post_date" for date query.
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
* @version 3.0.0
*/
class LLMS_Analytics_Refunds_Widget extends LLMS_Analytics_Widget {
public $charts = true;
protected function get_chart_data() {
return array(
'type' => 'count',
'header' => array(
'id' => 'refunds',
'label' => __( '# of Refunds', 'lifterlms' ),
'type' => 'number',
),
);
}
public function set_query() {
$this->set_order_data_query(
array(
'date_field' => 'post_modified',
'query_function' => 'get_results',
'select' => array(
'orders.post_modified AS date',
),
'statuses' => array(
'llms-refunded',
),
)
);
}
protected function format_response() {
if ( ! $this->is_error() ) {
return count( $this->get_results() );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.registrations.php
================================================
<?php
/**
* Registrations analytics widget
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.5.0
* @version 3.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Registrations analytics widget class
*
* @since 3.5.0
*/
class LLMS_Analytics_Registrations_Widget extends LLMS_Analytics_Widget {
public $charts = true;
protected function get_chart_data() {
return array(
'type' => 'count', // Type of field.
'header' => array(
'id' => 'registrations',
'label' => __( '# of Registrations', 'lifterlms' ),
'type' => 'number',
),
);
}
public function set_query() {
global $wpdb;
$dates = $this->get_posted_dates();
$student_ids = '';
$students = $this->get_posted_students();
if ( $students ) {
$student_ids .= 'AND ID IN ( ' . implode( ', ', $students ) . ' )';
}
$this->query_function = 'get_results';
$this->output_type = OBJECT;
$this->query = "SELECT user_registered AS date
FROM {$wpdb->users}
WHERE
user_registered >= CAST( %s as DATETIME )
AND user_registered < CAST( %s as DATETIME )
{$student_ids}
;";
$this->query_vars = array(
$this->format_date( $dates['start'], 'start' ),
$this->format_date( $dates['end'], 'end' ),
);
}
protected function format_response() {
if ( ! $this->is_error() ) {
return count( $this->get_results() );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.revenue.php
================================================
<?php
/**
* Revenue widget
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
* @version 3.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Analytics_Revenue_Widget class
*
* Retrieves the total amount of all succeeded transactions
* according to active filters.
*
* @since 3.0.0
*/
class LLMS_Analytics_Revenue_Widget extends LLMS_Analytics_Widget {
public function set_query() {
global $wpdb;
$txn_meta_join = '';
$txn_meta_where = '';
// Create an "IN" clause that can be used for later in WHERE clauses.
if ( $this->get_posted_students() || $this->get_posted_posts() ) {
// Get an array of order based on posted students & products.
$this->set_order_data_query(
array(
'date_range' => false,
'query_function' => 'get_col',
'select' => array(
'orders.ID',
),
'statuses' => array(
'llms-active',
'llms-completed',
'llms-refunded',
),
)
);
$this->query();
$order_ids = $this->get_results();
if ( $order_ids ) {
$txn_meta_join = "JOIN {$wpdb->postmeta} AS txn_meta ON txn_meta.post_id = txns.ID";
$txn_meta_where .= " AND txn_meta.meta_key = '_llms_order_id'";
$txn_meta_where .= ' AND txn_meta.meta_value IN ( ' . implode( ', ', $order_ids ) . ' )';
} else {
$this->query_function = 'get_var';
$this->query = 'SELECT 0';
return;
}
}
// Date range will be used to get transactions between given dates.
$dates = $this->get_posted_dates();
$this->query_vars = array(
$this->format_date( $dates['start'], 'start' ),
$this->format_date( $dates['end'], 'end' ),
);
$this->query_function = 'get_var';
$this->query = "SELECT
(
IFNULL( SUM( (
SELECT price.meta_value
FROM {$wpdb->postmeta} AS price
WHERE
price.meta_key = '_llms_amount'
AND price.post_id IN( txns.ID )
) ), 0 ) - IFNULL( SUM((
SELECT refund.meta_value
FROM {$wpdb->postmeta} AS refund
WHERE
refund.meta_key = '_llms_refund_amount'
AND refund.post_id IN( txns.ID )
) ), 0 )
) AS revenue
FROM {$wpdb->posts} AS txns
{$txn_meta_join}
WHERE
( txns.post_status = 'llms-txn-succeeded' OR txns.post_status = 'llms-txn-refunded' )
AND txns.post_type = 'llms_transaction'
AND txns.post_date >= CAST( %s as DATETIME )
AND txns.post_date < CAST( %s as DATETIME )
{$txn_meta_where}
;";
}
protected function format_response() {
if ( ! $this->is_error() ) {
return llms_price_raw( floatval( $this->get_results() ) );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.sales.php
================================================
<?php
/**
* Sales analytics widget
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
* @version 3.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Analytics_Sales_Widget class
*
* Locates number of active / completed orders from a given date range
* by a given group of students.
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
*/
class LLMS_Analytics_Sales_Widget extends LLMS_Analytics_Widget {
public $charts = true;
protected function get_chart_data() {
return array(
'type' => 'count',
'header' => array(
'id' => 'sales',
'label' => __( '# of New Sales', 'lifterlms' ),
'type' => 'number',
),
);
}
public function set_query() {
$this->set_order_data_query(
array(
'query_function' => 'get_results',
'select' => array(
'orders.post_date AS date',
),
'statuses' => array(
'llms-active',
'llms-completed',
'llms-on-hold',
'llms-pending-cancel',
'llms-cancelled',
'llms-expired',
),
)
);
}
protected function format_response() {
if ( ! $this->is_error() ) {
return count( $this->get_results() );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.sold.php
================================================
<?php
/**
* Sold Amount Widget
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 3.0.0
* @version 3.36.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Sold Amount Widget class
*
* Retrieves the total amount of all successful transactions
* according to active filters.
*
* @since 3.0.0
* @since 3.30.3 Explicitly define class properties.
* @since 3.36.3 In `format_response()` method avoid running `wp_list_pluck()` on non arrays.
*/
class LLMS_Analytics_Sold_Widget extends LLMS_Analytics_Widget {
public $charts = true;
/**
* temporary order ids
*
* @var array
* @since 3.0.0
*/
public $temp = array();
/**
* temporary query
*
* @since 3.0.0
* @var array
*/
public $temp_q = array();
protected function get_chart_data() {
return array(
'type' => 'amount', // Type of field.
'key' => 'amount', // Key of result field to add when counting.
'header' => array(
'id' => 'sold',
'label' => __( 'Net Revenue', 'lifterlms' ),
'type' => 'number',
),
);
}
public function set_query() {
global $wpdb;
$txn_meta_join = '';
$txn_meta_where = '';
// Create an "IN" clause that can be used for later in WHERE clauses.
if ( $this->get_posted_students() || $this->get_posted_posts() ) {
// Get an array of order based on posted students & products.
$this->set_order_data_query(
array(
'date_range' => false,
'query_function' => 'get_col',
'select' => array(
'orders.ID',
),
)
);
$this->query();
$order_ids = $this->get_results();
$this->temp_q = $wpdb->last_query;
$this->temp = $order_ids;
if ( $order_ids ) {
$txn_meta_join = "JOIN {$wpdb->postmeta} AS txn_meta ON txn_meta.post_id = txns.ID";
$txn_meta_where .= " AND txn_meta.meta_key = '_llms_order_id'";
$txn_meta_where .= ' AND txn_meta.meta_value IN ( ' . implode( ', ', $order_ids ) . ' )';
} else {
$this->query_function = 'get_var';
$this->query = 'SELECT 0';
return;
}
}
// Date range will be used to get transactions between given dates.
$dates = $this->get_posted_dates();
$this->query_vars = array(
$this->format_date( $dates['start'], 'start' ),
$this->format_date( $dates['end'], 'end' ),
);
$this->query_function = 'get_results';
$this->output_type = OBJECT;
$this->query = "SELECT txns.post_date AS date,
(sales.meta_value - COALESCE(refunds.meta_value, 0)) AS amount
FROM {$wpdb->posts} AS txns
{$txn_meta_join}
JOIN {$wpdb->postmeta} AS sales ON sales.post_id = txns.ID AND sales.meta_key = '_llms_amount'
LEFT JOIN {$wpdb->postmeta} AS refunds ON refunds.post_id = txns.ID AND refunds.meta_key = '_llms_refund_amount'
WHERE
( txns.post_status = 'llms-txn-succeeded' OR txns.post_status = 'llms-txn-refunded' )
AND txns.post_type = 'llms_transaction'
AND txns.post_date >= CAST( %s as DATETIME )
AND txns.post_date < CAST( %s as DATETIME )
{$txn_meta_where}
ORDER BY txns.post_date ASC
;";
}
/**
* Format response.
*
* @since unknown
* @since 3.36.3 Avoid running `wp_list_pluck()` on non arrays.
* @since 8.0.3 Using aggregate sum of net sales rather than summing up the txn records.
*/
protected function format_response() {
if ( ! $this->is_error() ) {
$results = $this->get_results();
return llms_price_raw( floatval( is_array( $results ) ? array_sum( wp_list_pluck( $results, 'amount' ) ) : $results ) );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/class.llms.analytics.widget.transactions.php
================================================
<?php
/**
* Transaction Count Widget
*
* @package LifterLMS/Admin/Reporting/Widgets/Classes
*
* @since 8.0.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Transaction Count Widget class
*
* Locates number of transactions from a given date range
* by a given group of students.
*/
class LLMS_Analytics_Transactions_Widget extends LLMS_Analytics_Widget {
public $charts = true;
/**
* temporary order ids
*
* @var array
* @since 3.0.0
*/
public $temp = array();
/**
* temporary query
*
* @since 3.0.0
* @var array
*/
public $temp_q = array();
protected function get_chart_data() {
return array(
'type' => 'count',
'header' => array(
'id' => 'sold',
'label' => __( '# of Transactions', 'lifterlms' ),
'type' => 'number',
),
);
}
public function set_query() {
global $wpdb;
$txn_meta_join = '';
$txn_meta_where = '';
// Create an "IN" clause that can be used for later in WHERE clauses.
if ( $this->get_posted_students() || $this->get_posted_posts() ) {
// Get an array of order based on posted students & products.
$this->set_order_data_query(
array(
'date_range' => false,
'query_function' => 'get_col',
'select' => array(
'orders.ID',
),
)
);
$this->query();
$order_ids = $this->get_results();
$this->temp_q = $wpdb->last_query;
$this->temp = $order_ids;
if ( $order_ids ) {
$txn_meta_join = "JOIN {$wpdb->postmeta} AS txn_meta ON txn_meta.post_id = txns.ID";
$txn_meta_where .= " AND txn_meta.meta_key = '_llms_order_id'";
$txn_meta_where .= ' AND txn_meta.meta_value IN ( ' . implode( ', ', array_map( 'absint', $order_ids ) ) . ' )';
} else {
$this->query_function = 'get_var';
$this->query = 'SELECT 0';
return;
}
}
// Date range will be used to get transactions between given dates.
$dates = $this->get_posted_dates();
$this->query_vars = array(
$this->format_date( $dates['start'], 'start' ),
$this->format_date( $dates['end'], 'end' ),
);
$this->query_function = 'get_results';
$this->output_type = OBJECT;
$this->query = "SELECT
txns.post_date as date
FROM {$wpdb->posts} AS txns
{$txn_meta_join}
WHERE
( txns.post_status = 'llms-txn-succeeded' OR txns.post_status = 'llms-txn-refunded' )
AND txns.post_type = 'llms_transaction'
AND txns.post_date >= CAST( %s as DATETIME )
AND txns.post_date < CAST( %s as DATETIME )
{$txn_meta_where}
ORDER BY txns.post_modified ASC
;";
}
protected function format_response() {
if ( ! $this->is_error() ) {
return count( $this->get_results() );
}
}
}
================================================
FILE: includes/admin/reporting/widgets/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/settings/class.llms.settings.accounts.php
================================================
<?php
/**
* Admin Settings Page, Accounts Tab
*
* @package LifterLMS/Admin/Settings/Classes
*
* @since 1.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Settings Page, Accounts Tab class
*
* @since 1.0.0
* @since 3.30.3 Fixed spelling errors.
* @since 3.37.3 Renamed setting field IDs to be unique.
* Removed redundant functions defined in the `LLMS_Settings_Page` class.
* Removed constructor and added `get_label()` method to be compatible with changes in `LLMS_Settings_Page`.
* @since 3.37.4 Revert $id to "account".
*/
class LLMS_Settings_Accounts extends LLMS_Settings_Page {
/**
* Settings identifier
*
* @var string
*/
public $id = 'account';
/**
* Should permalinks be flushed on save?
*
* @var boolean
*/
protected $flush = true;
/**
* Get settings array
*
* @since 1.0.0
* @since 3.30.3 Fixed spelling errors.
* @since 3.37.3 Renamed duplicate field id for section close (`user_info_field_options` to `user_info_field_options_end`)
* @since 5.0.0 Removed field display settings.
* Reorganized open registration setting.
* Renamed "User Information Options" to "User Privacy Options".
* @since 5.6.0 Added options to disable concurrent logins.
* @since 7.5.0 Added settings for favorites endpoint.
*
* @return array
*/
public function get_settings() {
$account_settings = array(
array(
'class' => 'top',
'id' => 'course_account_options',
'type' => 'sectionstart',
),
array(
'id' => 'account_page_options_start',
'title' => __( 'Student Dashboard', 'lifterlms' ),
'type' => 'title',
),
array(
'title' => __( 'Dashboard Page', 'lifterlms' ),
'desc' => __( 'Page where students can view and manage their current enrollments, earned certificates and achievements, account information, and purchase history.', 'lifterlms' ) . ' ' . sprintf( __( 'Requires the %1$s[lifterlms_my_account]%2$s shortcode or the "My Account" block.', 'lifterlms' ), '<code>', '</code>' ),
'id' => 'lifterlms_myaccount_page_id',
'default' => '',
'desc_tip' => true,
'class' => 'llms-select2-post',
'type' => 'select',
'custom_attributes' => array(
'data-post-type' => 'page',
'data-placeholder' => __( 'Select a page', 'lifterlms' ),
),
'options' => llms_make_select2_post_array( get_option( 'lifterlms_myaccount_page_id', '' ) ),
),
array(
'title' => __( 'Courses Sorting', 'lifterlms' ),
'default' => 'order,ASC',
'desc' => __( 'Determines the order of the courses in-progress listed on the student dashboard.', 'lifterlms' ),
'id' => 'lifterlms_myaccount_courses_in_progress_sorting',
'type' => 'select',
'options' => array(
'title,ASC' => __( 'Course Title (A to Z)', 'lifterlms' ),
'title,DESC' => __( 'Course Title (Z to A)', 'lifterlms' ),
'date,DESC' => __( 'Enrollment Date (Most Recent to Least Recent)', 'lifterlms' ),
'order,ASC' => __( 'Order (Low to High)', 'lifterlms' ),
'order,DESC' => __( 'Order (High to Low)', 'lifterlms' ),
),
),
array(
'default' => 'no',
'desc' => sprintf(
// Translators: %1$s = opening anchor tag; %2$s = closing anchor tag.
__( 'Enable new user registration on the Student Dashboard. %1$sLearn More%2$s.', 'lifterlms' ),
'<a href="https://lifterlms.com/docs/open-registration/" target="_blank">',
'</a>'
),
'id' => 'lifterlms_enable_myaccount_registration',
'title' => __( 'Open Registration', 'lifterlms' ),
'type' => 'checkbox',
),
array(
'default' => 'no',
'desc' => __( 'Only allow the most recent login for each user account.', 'lifterlms' ),
'id' => 'lifterlms_prevent_concurrent_logins',
'title' => __( 'Prevent concurrent logins', 'lifterlms' ),
'type' => 'checkbox',
'custom_attributes' => array(
'class' => 'llms-conditional-controller',
'data-controls' => '#lifterlms_prevent_concurrent_logins_roles',
),
),
array(
'class' => 'llms-select2',
'default' => array( 'student' ),
'desc' => __( 'Prevent concurrent logins for users with the selected user roles.', 'lifterlms' ),
'id' => 'lifterlms_prevent_concurrent_logins_roles',
'options' => LLMS_Roles::get_all_role_names(),
'title' => '',
'type' => 'multiselect',
'custom_attributes' => array(
'data-placeholder' => __( 'Select user roles', 'lifterlms' ),
),
),
array(
'id' => 'course_account_options_end',
'type' => 'sectionend',
),
array(
'class' => 'top',
'id' => 'course_account_endpoint_options_start',
'type' => 'sectionstart',
),
array(
'id' => 'account_page_endpoint_options_title',
'title' => __( 'Student Dashboard Endpoints', 'lifterlms' ),
'desc' => __( 'Each endpoint allows students to view more information or manage parts of their account. Each endpoint should be unique, URL-safe, and can be left blank to disable the endpoint completely.', 'lifterlms' ),
'type' => 'title',
),
array(
'title' => __( 'View Grades', 'lifterlms' ),
'desc' => __( 'Student grade and progress reporting', 'lifterlms' ),
'id' => 'lifterlms_myaccount_grades_endpoint',
'type' => 'text',
'default' => 'my-grades',
'sanitize' => 'slug',
),
array(
'title' => __( 'View Courses', 'lifterlms' ),
'desc' => __( 'List of all the student\'s courses', 'lifterlms' ),
'id' => 'lifterlms_myaccount_courses_endpoint',
'type' => 'text',
'default' => 'my-courses',
'sanitize' => 'slug',
),
array(
'title' => __( 'View Memberships', 'lifterlms' ),
'desc' => __( 'List of all the student\'s memberships', 'lifterlms' ),
'id' => 'lifterlms_myaccount_memberships_endpoint',
'type' => 'text',
'default' => 'my-memberships',
'sanitize' => 'slug',
),
array(
'title' => __( 'View Achievements', 'lifterlms' ),
'desc' => __( 'List of all the student\'s achievements', 'lifterlms' ),
'id' => 'lifterlms_myaccount_achievements_endpoint',
'type' => 'text',
'default' => 'my-achievements',
'sanitize' => 'slug',
),
array(
'title' => __( 'View Certificates', 'lifterlms' ),
'desc' => __( 'List of all the student\'s certificates', 'lifterlms' ),
'id' => 'lifterlms_myaccount_certificates_endpoint',
'type' => 'text',
'default' => 'my-certificates',
'sanitize' => 'slug',
),
array(
'title' => __( 'Notifications', 'lifterlms' ),
'desc' => __( 'View Notifications and adjust notification settings', 'lifterlms' ),
'id' => 'lifterlms_myaccount_notifications_endpoint',
'type' => 'text',
'default' => 'notifications',
'sanitize' => 'slug',
),
array(
'title' => __( 'Edit Account', 'lifterlms' ),
'desc' => __( 'Edit Account page', 'lifterlms' ),
'id' => 'lifterlms_myaccount_edit_account_endpoint',
'type' => 'text',
'default' => 'edit-account',
'sanitize' => 'slug',
),
array(
'title' => __( 'Lost Password', 'lifterlms' ),
'desc' => __( 'Lost Password page', 'lifterlms' ),
'id' => 'lifterlms_myaccount_lost_password_endpoint',
'type' => 'text',
'default' => 'lost-password',
'sanitize' => 'slug',
),
array(
'title' => __( 'Redeem Vouchers', 'lifterlms' ),
'desc' => __( 'Redeem vouchers page', 'lifterlms' ),
'id' => 'lifterlms_myaccount_redeem_vouchers_endpoint',
'type' => 'text',
'default' => 'redeem-voucher',
'sanitize' => 'slug',
),
array(
'title' => __( 'Orders History', 'lifterlms' ),
'desc' => __( 'Students can review order history on this page', 'lifterlms' ),
'id' => 'lifterlms_myaccount_orders_endpoint',
'type' => 'text',
'default' => 'orders',
'sanitize' => 'slug',
),
array(
'id' => 'course_account_endpoint_options_end',
'type' => 'sectionend',
),
// Start user info fields options.
array(
'id' => 'user_info_field_options',
'type' => 'sectionstart',
),
array(
'title' => __( 'User Information & Privacy Options', 'lifterlms' ),
'type' => 'title',
'id' => 'user_info_field_options_title',
),
array(
'title' => __( 'User Information Field Settings', 'lifterlms' ),
'type' => 'subtitle',
'desc' => __( 'Since version 5.0, all user information fields are customized using the form editor.', 'lifterlms' ),
),
array(
'type' => 'custom-html',
'value' => '<p><a class="button-primary" href="' . admin_url( 'edit.php?post_type=llms_form' ) . '">' . __( 'Edit Forms', 'lifterlms' ) . '</a></p>',
),
array(
'title' => __( 'Terms and Conditions', 'lifterlms' ),
'type' => 'subtitle',
),
array(
'autoload' => false,
'default' => 'no',
'id' => 'lifterlms_registration_require_agree_to_terms',
'desc' => __( 'When enabled users must agree to your site\'s Terms and Conditions to register for an account.', 'lifterlms' ),
'title' => __( 'Enable / Disable', 'lifterlms' ),
'type' => 'checkbox',
'custom_attributes' => array(
'class' => 'llms-conditional-controller',
'data-controls' => '#lifterlms_terms_page_id,#llms_terms_notice',
),
),
array(
'autoload' => false,
'desc' => __( 'Select a page where your site\'s Terms and Conditions are described.', 'lifterlms' ),
'id' => 'lifterlms_terms_page_id',
'default' => '',
'desc_tip' => true,
'class' => 'llms-select2-post',
'title' => __( 'Terms and Conditions Page', 'lifterlms' ),
'type' => 'select',
'custom_attributes' => array(
'data-post-type' => 'page',
'data-placeholder' => __( 'Select a page', 'lifterlms' ),
),
'options' => llms_make_select2_post_array( get_option( 'lifterlms_terms_page_id', '' ) ),
),
array(
'autoload' => false,
'default' => llms_get_terms_notice(),
'id' => 'llms_terms_notice',
'desc' => __( 'Customize the text used to display the Terms and Conditions checkbox that students must accept.', 'lifterlms' ),
'title' => __( 'Terms and Conditions Notice', 'lifterlms' ),
'type' => 'textarea',
'value' => llms_get_terms_notice(),
),
array(
'title' => __( 'Privacy Policy', 'lifterlms' ),
'type' => 'subtitle',
),
array(
'autoload' => false,
'desc' => sprintf(
__( 'Select a page where your site\'s Privacy Policy is described. See %1$sWordPress Privacy Settings%2$s for more information', 'lifterlms' ),
'<a href="' . esc_url( admin_url( 'privacy.php' ) ) . '">',
'</a>'
),
'id' => 'wp_page_for_privacy_policy',
'class' => 'llms-select2-post',
'title' => __( 'Privacy Policy Page', 'lifterlms' ),
'type' => 'select',
'custom_attributes' => array(
'data-post-type' => 'page',
'data-placeholder' => __( 'Select a page', 'lifterlms' ),
),
'options' => llms_make_select2_post_array( get_option( 'wp_page_for_privacy_policy' ) ),
),
array(
'autoload' => false,
'default' => llms_get_privacy_notice(),
'id' => 'llms_privacy_notice',
'desc' => __( 'Optionally display a privacy policy notice during registration and checkout.', 'lifterlms' ),
'title' => __( 'Privacy Policy Notice', 'lifterlms' ),
'type' => 'textarea',
),
array(
'title' => __( 'Account Erasure Requests', 'lifterlms' ),
/* Translators: %$1s = opening anchor to account erasure screen; %2$s closing anchor */
'desc' => sprintf( __( 'Customize data retention during %1$saccount erasure requests%2$s.', 'lifterlms' ), '<a href="' . esc_url( admin_url( 'tools.php?page=remove_personal_data' ) ) . '">', '</a>' ),
'type' => 'subtitle',
),
array(
'autoload' => false,
'default' => 'no',
'id' => 'llms_erasure_request_removes_order_data',
'desc' => __( 'When enabled orders will be anonymized during a personal data erasure.', 'lifterlms' ),
'title' => __( 'Remove Order Data', 'lifterlms' ),
'type' => 'checkbox',
),
array(
'autoload' => false,
'default' => 'no',
'id' => 'llms_erasure_request_removes_lms_data',
'desc' => __( 'When enabled all student data related to course and membership activities will be removed.', 'lifterlms' ),
'title' => __( 'Remove Student LMS Data', 'lifterlms' ),
'type' => 'checkbox',
),
array(
'id' => 'user_info_field_options_end',
'type' => 'sectionend',
),
);
if ( llms_is_favorites_enabled() ) {
array_splice(
$account_settings,
15,
0,
array(
array(
'title' => __( 'View Favorites', 'lifterlms' ),
'desc' => __( 'List of all the student\'s favorites', 'lifterlms' ),
'id' => 'lifterlms_myaccount_favorites_endpoint',
'type' => 'text',
'default' => 'my-favorites',
'sanitize' => 'slug',
),
)
);
}
/**
* Filters the account settings.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the settings page.
*
* @since Unknown
*
* @param array $account_settings The account page settings.
*/
return apply_filters( "lifterlms_{$this->id}_settings", $account_settings );
}
/**
* Retrieve the page label.
*
* @since 3.37.3
*
* @return string
*/
protected function set_label() {
return __( 'Accounts', 'lifterlms' );
}
}
return new LLMS_Settings_Accounts();
================================================
FILE: includes/admin/settings/class.llms.settings.checkout.php
================================================
<?php
/**
* Admin Settings Page, Checkout Tab
*
* @package LifterLMS/Admin/Settings/Classes
*
* @since 3.0.0
* @version 3.35.1
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Settings Page, Checkout Tab class
*
* @since 3.0.0
* @since 3.30.3 Fixed spelling errors.
* @since 3.35.1 Verify nonce when saving.
*/
class LLMS_Settings_Checkout extends LLMS_Settings_Page {
/**
* Allow settings page to determine if a rewrite flush is required
*
* @var boolean
* @since 3.0.4
* @version 3.10.0
*/
protected $flush = true;
/**
* Constructor
* executes settings tab actions
*
* @since 3.0.4
* @version 3.17.5
*/
public function __construct() {
$this->id = 'checkout';
$this->label = __( 'Checkout', 'lifterlms' );
add_filter( 'lifterlms_settings_tabs_array', array( $this, 'add_settings_page' ), 20 );
add_action( 'lifterlms_sections_' . $this->id, array( $this, 'output_sections_nav' ) );
add_action( 'lifterlms_settings_' . $this->id, array( $this, 'output' ) );
add_action( 'lifterlms_settings_save_' . $this->id, array( $this, 'save' ) );
}
/**
* Get HTML for the payment gateways table
*
* @return string
* @since 3.17.5
* @version 3.17.5
*/
public function get_gateway_table_html() {
$gateways = llms()->payment_gateways()->get_payment_gateways();
usort( $gateways, array( $this, 'sort_gateways' ) );
ob_start();
?>
<table class="llms-table zebra text-left size-large llms-gateway-table">
<thead>
<tr>
<th class="sort"></th>
<th><?php esc_html_e( 'Gateway', 'lifterlms' ); ?></th>
<th><?php esc_html_e( 'Gateway ID', 'lifterlms' ); ?></th>
<th><?php esc_html_e( 'Enabled', 'lifterlms' ); ?></th>
</tr>
</thead>
<tbody>
<?php foreach ( $gateways as $gateway ) : ?>
<tr>
<td class="sort">
<i class="fa fa-bars llms-action-icon" aria-hidden="true"></i>
<input type="hidden" name="<?php echo esc_attr( $gateway->get_option_name( 'display_order' ) ); ?>" value="<?php echo esc_attr( $gateway->get_display_order() ); ?>">
</td>
<td><a href="<?php echo esc_url( admin_url( 'admin.php?page=llms-settings&tab=' . $this->id . '§ion=' . $gateway->get_id() ) ); ?>"><?php echo esc_html( $gateway->get_admin_title() ); ?></a></td>
<td><?php echo esc_html( $gateway->get_id() ); ?></td>
<td class="status">
<?php if ( $gateway->is_enabled() ) : ?>
<span class="tip--bottom-right" data-tip="<?php esc_attr_e( 'Enabled', 'lifterlms' ); ?>">
<span class="screen-reader-text"><?php esc_html_e( 'Enabled', 'lifterlms' ); ?></span>
<i class="fa fa-check-circle" aria-hidden="true"></i>
</span>
<?php else : ?>
–
<?php endif; ?>
</td>
</tr>
<?php endforeach; ?>
</tbody>
</table>
<?php
return ob_get_clean();
}
/**
* Get the page sections
*
* @return array
* @since 3.17.5
* @version 3.17.5
*/
public function get_sections() {
$sections = array();
$gateways = llms()->payment_gateways()->get_payment_gateways();
foreach ( $gateways as $id => $gateway ) {
$sections[ $id ] = $gateway->get_admin_title();
}
asort( $sections );
$sections = array_merge(
array(
'main' => __( 'Checkout Settings', 'lifterlms' ),
),
$sections
);
return apply_filters( 'llms_checkout_settings_sections', $sections );
}
/**
* Get settings array
*
* @return array
* @since 3.0.4
* @version 3.17.5
*/
public function get_settings() {
$curr_section = $this->get_current_section();
if ( 'main' === $curr_section ) {
return apply_filters( 'lifterlms_checkout_settings', $this->get_settings_default() );
}
return apply_filters( 'lifterlms_gateway_settings_' . $curr_section, $this->get_settings_gateway( $curr_section ) );
}
/**
* Retrieve the default checkout settings for the main section
*
* @since 3.17.5
* @since 3.30.3 Fixed spelling errors.
*
* @return array
*/
private function get_settings_default() {
$currency_code_options = get_lifterlms_currencies();
foreach ( $currency_code_options as $code => $name ) {
$currency_code_options[ $code ] = $name . ' (' . get_lifterlms_currency_symbol( $code ) . ')';
}
$country_options = get_lifterlms_countries();
foreach ( $country_options as $code => $name ) {
$country_options[ $code ] = $name . ' (' . $code . ')';
}
return array(
array(
'type' => 'sectionstart',
'id' => 'checkout_settings_gateways_list_start',
),
array(
'title' => __( 'Payment Gateways', 'lifterlms' ),
'desc' => sprintf( __( 'Gateways allow you to accept payments on your site. %1$1sLearn More%2$2s', 'lifterlms' ), '<a href="https://lifterlms.com/docs/what-payment-gateways-can-i-use-with-lifterlms/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page">', '</a>' ),
'type' => 'title',
'id' => 'checkout_settings_gateways_list_title',
),
array(
'value' => $this->get_gateway_table_html(),
'type' => 'custom-html',
),
array(
'type' => 'sectionend',
'id' => 'checkout_settings_gateways_list_end',
),
array(
'class' => 'top',
'id' => 'course_archive_options',
'type' => 'sectionstart',
),
array(
'id' => 'course_options',
'title' => __( 'Checkout Settings', 'lifterlms' ),
'type' => 'title',
),
array(
'title' => __( 'Checkout Page', 'lifterlms' ),
'desc' => __( 'Page used for displaying the checkout form.', 'lifterlms' ) . ' ' . sprintf( __( 'Requires the %1$s[lifterlms_checkout]%2$s shortcode or the "Checkout" block.', 'lifterlms' ), '<code>', '</code>' ),
'id' => 'lifterlms_checkout_page_id',
'type' => 'select',
'default' => '',
'class' => 'llms-select2-post',
'custom_attributes' => array(
'data-post-type' => 'page',
),
'options' => llms_make_select2_post_array( get_option( 'lifterlms_checkout_page_id', '' ) ),
),
array(
'title' => __( 'Confirm Payment', 'lifterlms' ),
'desc' => __( 'Payment confirmation endpoint slug', 'lifterlms' ),
'id' => 'lifterlms_myaccount_confirm_payment_endpoint',
'type' => 'text',
'default' => 'confirm-payment',
'desc_tip' => true,
'sanitize' => 'slug',
),
array(
'title' => __( 'Force SSL', 'lifterlms' ),
'desc' => __( 'Force secure checkout via SSL (https) on the checkout page(s).', 'lifterlms' ) .
'<p class="description">' . sprintf( __( 'Requires an SSL certificate. %1$sLearn More%2$s', 'lifterlms' ), '<a href="https://lifterlms.com/docs/ssl-and-https/" target="_blank">', '</a>' ) . '</p>',
'id' => 'lifterlms_checkout_force_ssl',
'type' => 'checkbox',
'default' => 'no',
),
array(
'default' => 'yes',
'desc' => __( 'Enable automatic retry of failed recurring payments.', 'lifterlms' ) .
'<p class="description">' . sprintf( esc_html__( 'Recover lost revenue from temporarily declined payment methods. %1$sLearn More%2$s', 'lifterlms' ), '<a href="https://lifterlms.com/docs/automatic-retry-failed-payments/" target="_blank">', '</a>' ) . '</p>',
'id' => 'lifterlms_recurring_payment_retry',
'title' => __( 'Retry Failed Payments', 'lifterlms' ),
'type' => 'checkbox',
),
array(
'type' => 'sectionend',
'id' => 'course_archive_options',
),
array(
'type' => 'sectionstart',
'id' => 'general_options',
),
array(
'title' => __( 'Currency Options', 'lifterlms' ),
'type' => 'title',
'desc' => __( 'The following options affect how prices are displayed on the frontend.', 'lifterlms' ),
'id' => 'pricing_options',
),
array(
'class' => 'llms-select2',
'title' => __( 'Country', 'lifterlms' ),
'desc' => __( 'Select the country LifterLMS should use as the default during transactions and registrations.', 'lifterlms' ),
'id' => 'lifterlms_country',
'default' => 'US',
'type' => 'select',
'desc_tip' => false,
'options' => $country_options,
),
array(
'class' => 'llms-select2',
'title' => __( 'Currency', 'lifterlms' ),
'desc' => __( 'Select the currency LifterLMS should use to display prices and process transactions.', 'lifterlms' ),
'id' => 'lifterlms_currency',
'default' => 'USD',
'type' => 'select',
'desc_tip' => false,
'options' => $currency_code_options,
),
array(
'title' => __( 'Currency Position', 'lifterlms' ),
'desc' => __( 'Customize the position and formatting of the currency symbol for displayed prices.', 'lifterlms' ),
'id' => 'lifterlms_currency_position',
'default' => 'left',
'type' => 'select',
'options' => array(
'left' => 'Left (' . sprintf( '%1$s%2$s', get_lifterlms_currency_symbol(), 99.99 ) . ')',
'right' => 'Right (' . sprintf( '%2$s%1$s', get_lifterlms_currency_symbol(), 99.99 ) . ')',
'left_space' => 'Left with Space (' . sprintf( '%1$s %2$s', get_lifterlms_currency_symbol(), 99.99 ) . ')',
'right_space' => 'Right with Space (' . sprintf( '%2$s %1$s', get_lifterlms_currency_symbol(), 99.99 ) . ')',
),
),
array(
'title' => __( 'Thousand Separator', 'lifterlms' ),
'class' => 'tiny',
'desc' => __( 'Choose the character to display as the thousand\'s place separator for displayed prices.', 'lifterlms' ),
'id' => 'lifterlms_thousand_separator',
'type' => 'text',
'default' => ',',
),
array(
'title' => __( 'Decimal Separator', 'lifterlms' ),
'class' => 'tiny',
'desc' => __( 'Choose the character to display as the decimal separator for displayed prices.', 'lifterlms' ),
'id' => 'lifterlms_decimal_separator',
'type' => 'text',
'default' => '.',
),
array(
'title' => __( 'Decimal Places', 'lifterlms' ),
'class' => 'tiny',
'desc' => __( 'Customize the number of decimal places for prices.', 'lifterlms' ),
'id' => 'lifterlms_decimals',
'type' => 'number',
'default' => '2',
),
array(
'title' => __( 'Hide Zero Decimals', 'lifterlms' ),
'desc' => __( 'Automatically remove zero decimals from the end of displayed prices.', 'lifterlms' ),
'id' => 'lifterlms_trim_zero_decimals',
'default' => 'no',
'type' => 'checkbox',
),
array(
'type' => 'sectionend',
'id' => 'general_options',
),
);
}
/**
* Retrieve settings for a gateway section
*
* @param string $curr_section gateway ID string
* @return array
* @since 3.17.5
* @version 3.17.5
*/
private function get_settings_gateway( $curr_section ) {
$settings = array();
$settings[] = array(
'type' => 'sectionstart',
'id' => 'start_gateway_settings_' . $curr_section,
'class' => 'top',
);
$gateway = llms()->payment_gateways()->get_gateway_by_id( $curr_section );
if ( ! $gateway ) {
$settings[] = array(
'title' => __( 'Payment Gateway Settings', 'lifterlms' ),
'type' => 'title',
'id' => 'title_gateway_settings_' . $curr_section,
);
$settings[] = array(
'title' => sprintf( __( 'Error: "%s" is not a valid payment gateway', 'lifterlms' ), $curr_section ),
'type' => 'subtitle',
'id' => 'title_gateway_settings_' . $curr_section,
);
} else {
$settings[] = array(
'title' => sprintf( __( '%s Payment Gateway Settings', 'lifterlms' ), $gateway->get_admin_title() ),
'type' => 'title',
'id' => 'title_gateway_settings_' . $curr_section,
);
$settings = array_merge( $settings, $gateway->get_admin_settings_fields() );
}
$settings[] = array(
'type' => 'sectionend',
'id' => 'end_gateway_settings_' . $curr_section,
);
return $settings;
}
/**
* Override default save method to save the display order of payment gateways
*
* @since 3.17.5
* @since 3.35.1 Verify nonce.
*
* @return void
*/
public function save() {
if ( ! isset( $_REQUEST['_wpnonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_wpnonce'] ) ), 'lifterlms-settings' ) ) {
return;
}
// Save all custom fields.
parent::save();
// Save display order of gateways.
foreach ( llms()->payment_gateways()->get_payment_gateways() as $id => $gateway ) {
$option = $gateway->get_option_name( 'display_order' );
if ( isset( $_POST[ $option ] ) ) {
update_option( $option, absint( $_POST[ $option ] ) );
}
}
}
/**
* usort function used to ensure gateways are sorted by display order on the gateways table
*
* @param obj $gateway_a Payment Gateway instance
* @param obj $gateway_b Payment Gateway instance
* @return int
* @since 3.17.5
* @version 3.17.5
*/
public function sort_gateways( $gateway_a, $gateway_b ) {
$a_order = $gateway_a->get_display_order();
$b_order = $gateway_b->get_display_order();
if ( $a_order == $b_order ) {
return 0;
}
return $a_order < $b_order ? -1 : 1;
}
}
return new LLMS_Settings_Checkout();
================================================
FILE: includes/admin/settings/class.llms.settings.courses.php
================================================
<?php
/**
* Admin Settings Page "Courses" Tab
*
* @package LifterLMS/Admin/Settings/Classes
*
* @since 3.5.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Settings Page "Courses" Tab class
*
* @since 3.5.0
*/
class LLMS_Settings_Courses extends LLMS_Settings_Page {
/**
* Constructor
*
* Executes settings tab actions.
*
* @since 3.5.0
*
* @return void
*/
public function __construct() {
$this->id = 'courses';
$this->label = __( 'Courses', 'lifterlms' );
add_filter( 'lifterlms_settings_tabs_array', array( $this, 'add_settings_page' ), 20 );
add_action( 'lifterlms_settings_' . $this->id, array( $this, 'output' ) );
add_action( 'lifterlms_settings_save_' . $this->id, array( $this, 'save' ) );
}
/**
* Get settings array.
*
* @since 3.5.0
* @since 7.5.0 Added settings for enabling/disabling favorites.
*
* @return array
*/
public function get_settings() {
/**
* Filter the course settings.
*
* @since 3.5.0
*
* @param array $course_settings THe course Settings.
*/
$course = apply_filters(
'lifterlms_course_settings',
array(
array(
'class' => 'top',
'id' => 'course_general_options',
'type' => 'sectionstart',
),
array(
'id' => 'course_general_options_title',
'title' => __( 'Course Settings', 'lifterlms' ),
'type' => 'title',
),
array(
'desc' => __( 'Enabling this setting allows students to mark a lesson as "incomplete" after they have completed a lesson.', 'lifterlms' ),
'default' => 'no',
'id' => 'lifterlms_retake_lessons',
'title' => __( 'Retake Lessons', 'lifterlms' ),
'type' => 'checkbox',
),
array(
'desc' => __( 'Enabling this setting will display lessons in a distraction-free focus mode.', 'lifterlms' ),
'default' => 'no',
'id' => 'lifterlms_enable_focus_mode',
'title' => __( 'Focus Mode', 'lifterlms' ),
'type' => 'checkbox',
),
array(
'default' => '960',
'desc' => __( 'Set the maximum width of the lesson content area in focus mode.', 'lifterlms' ),
'id' => 'lifterlms_focus_mode_content_width',
'options' => array(
'full' => __( 'Full Width', 'lifterlms' ),
'1600' => __( 'Extra Wide (1600px)', 'lifterlms' ),
'1180' => __( 'Wide (1180px)', 'lifterlms' ),
'960' => __( 'Default (960px)', 'lifterlms' ),
'768' => __( 'Narrow (768px)', 'lifterlms' ),
),
'title' => __( 'Focus Mode Content Width', 'lifterlms' ),
'type' => 'select',
),
array(
'default' => 'left',
'desc' => __( 'Choose which side the course syllabus sidebar appears on.', 'lifterlms' ),
'id' => 'lifterlms_focus_mode_sidebar_position',
'options' => array(
'left' => __( 'Left', 'lifterlms' ),
'right' => __( 'Right', 'lifterlms' ),
),
'title' => __( 'Focus Mode Sidebar Position', 'lifterlms' ),
'type' => 'select',
),
array(
'title' => __( 'Lesson Favorites', 'lifterlms' ),
'desc' => __( 'Enabling this setting allows students to mark a lesson as "favorite".', 'lifterlms' ),
'id' => 'lifterlms_favorites',
'default' => 'yes',
'type' => 'checkbox',
),
array(
'class' => 'llms-select2-post',
'custom_attributes' => array(
'data-allow-clear' => true,
'data-post-type' => 'page',
'data-placeholder' => __( 'Select a page', 'lifterlms' ),
),
'desc' => sprintf( __( 'This page will be shown to students when they complete the course. %1$sMore Information%2$s', 'lifterlms' ), '<a href="https://lifterlms.com/docs/course-completion-page/" target="_blank">', '</a>' ),
'id' => 'lifterlms_course_completion_page_id',
'options' => llms_make_select2_post_array( get_option( 'lifterlms_course_completion_page_id', '' ) ),
'title' => __( 'Course Completion', 'lifterlms' ),
'type' => 'select',
),
array(
'type' => 'sectionend',
'id' => 'course_general_options',
),
array(
'class' => 'top',
'id' => 'course_archive_options',
'type' => 'sectionstart',
),
array(
'id' => 'course_options',
'title' => __( 'Course Catalog Settings', 'lifterlms' ),
'type' => 'title',
),
array(
'class' => 'llms-select2-post',
'custom_attributes' => array(
'data-allow-clear' => true,
'data-post-type' => 'page',
'data-placeholder' => __( 'Select a page', 'lifterlms' ),
),
'desc' => sprintf( __( 'This page is where your visitors will find a list of all your available courses. %1$sMore Information%2$s', 'lifterlms' ), '<a href="https://lifterlms.com/docs/course-catalog/" target="_blank">', '</a>' ),
'id' => 'lifterlms_shop_page_id',
'options' => llms_make_select2_post_array( get_option( 'lifterlms_shop_page_id', '' ) ),
'title' => __( 'Course Catalog', 'lifterlms' ),
'type' => 'select',
),
array(
'default' => 9,
'desc' => __( 'To show all courses on one page, enter -1.', 'lifterlms' ),
'id' => 'lifterlms_shop_courses_per_page',
'title' => __( 'Courses per page', 'lifterlms' ),
'type' => 'number',
),
array(
'default' => 'menu_order',
'desc' => __( 'Determines the display order for courses on the courses page.', 'lifterlms' ),
'id' => 'lifterlms_shop_ordering',
'options' => array(
'menu_order,ASC' => __( 'Order (Low to High)', 'lifterlms' ),
'menu_order,DESC' => __( 'Order (High to Low)', 'lifterlms' ),
'title,ASC' => __( 'Title (A - Z)', 'lifterlms' ),
'title,DESC' => __( 'Title (Z - A)', 'lifterlms' ),
'date,DESC' => __( 'Most Recent', 'lifterlms' ),
),
'title' => __( 'Catalog Sorting', 'lifterlms' ),
'type' => 'select',
),
array(
'type' => 'sectionend',
'id' => 'course_archive_options',
),
)
);
/**
* Ensure deprecated filter sticks around for a while
*
* @todo deprecate this filter
*/
$deprecated = apply_filters( 'lifterlms_catalog_settings', array() );
return array_merge( $course, $deprecated );
}
/**
* Save settings
*
* @since 3.5.0
*
* @return void
*/
public function save() {
$settings = $this->get_settings();
LLMS_Admin_Settings::save_fields( $settings );
}
/**
* Output settings on screen
*
* @since 3.5.0
*
* @return void
*/
public function output() {
$settings = $this->get_settings();
LLMS_Admin_Settings::output_fields( $settings );
add_action( 'shutdown', array( $this, 'flush_rewrite_rules' ) );
}
}
return new LLMS_Settings_Courses();
================================================
FILE: includes/admin/settings/class.llms.settings.engagements.php
================================================
<?php
/**
* Admin Settings Page: Engagements
*
* @package LifterLMS/Admin/Settings/Classes
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Settings_Engagements class
*
* @since 1.0.0
* @since 3.8.0 Unknown.
* @since 3.37.3 Renamed setting field IDs to be unique.
* Removed redundant functions defined in the `LLMS_Settings_Page` class.
* Removed constructor and added `get_label()` method to be compatible with changes in `LLMS_Settings_Page`.
* @since 3.40.0 Add a section that displays conditionally for email delivery provider connections.
*/
class LLMS_Settings_Engagements extends LLMS_Settings_Page {
/**
* Settings identifier
*
* @var string
*/
public $id = 'engagements';
/**
* Constructor.
*
* @since 6.0.0
*
* @return void
*/
public function __construct() {
parent::__construct();
add_action( "lifterlms_settings_{$this->id}", array( $this, 'output_js' ) );
}
/**
* Retrieve the page label.
*
* @since 3.37.3
*
* @return string
*/
protected function set_label() {
return __( 'Engagements', 'lifterlms' );
}
/**
* Get settings array
*
* @since 1.0.0
* @since 3.8.0 Unknown.
* @since 3.37.3 Refactor to pull each settings group from its own method.
* @since 3.40.0 Include an email delivery section.
* @since 6.0.0 Include achievements section.
*
* @return array
*/
public function get_settings() {
/**
* Modify LifterLMS Admin Settings on the "Engagements" tab,
*
* @since 1.0.0
*
* @param array[] $settings Array of settings fields arrays.
*/
return apply_filters(
'lifterlms_engagements_settings',
array_merge(
$this->get_settings_group_email(),
$this->get_settings_group_email_delivery(),
$this->get_settings_group_achievements(),
$this->get_settings_group_certs()
)
);
}
/**
* Retrieve fields for the achievements settings group.
*
* @since 6.0.0
*
* @return array[]
*/
protected function get_settings_group_achievements() {
return $this->generate_settings_group(
'achievement_options',
__( 'Achievement Settings', 'lifterlms' ),
'',
array(
array(
'title' => __( 'Placeholder Image', 'lifterlms' ),
'desc' => $this->get_award_image_desc( __( 'achievement', 'lifterlms' ) ),
'id' => 'lifterlms_achievement_default_img',
'type' => 'image',
'value' => llms()->achievements()->get_default_image( 0 ),
'autoload' => false,
),
)
);
}
/**
* Retrieve fields for the certificates settings group.
*
* @since 3.37.3
* @since 6.0.0 Add background image options.
* Only load legacy certificate options when the legacy option is enabled.
*
* @return array[]
*/
protected function get_settings_group_certs() {
$certificate_sizes = llms_get_certificate_sizes();
$settings = array(
array(
'title' => __( 'Placeholder Background Image', 'lifterlms' ),
'desc' => $this->get_award_image_desc( __( 'certificate', 'lifterlms' ) ),
'id' => 'lifterlms_certificate_default_img',
'type' => 'image',
'value' => llms()->certificates()->get_default_image( 0 ),
'autoload' => false,
),
array(
'title' => __( 'Default Size', 'lifterlms' ),
'desc' => __( 'The default size used when creating new certificates.', 'lifterlms' ),
'id' => 'lifterlms_certificate_default_size',
'type' => 'select',
'options' => $this->get_certificate_size_opts(),
'default' => 'LETTER',
'autoload' => false,
),
array(
'title' => __( 'User Defined Certificate Size', 'lifterlms' ),
'desc' => __( 'Use these settings to customize the User Defined Certificate size.', 'lifterlms' ),
'id' => 'cert_user_defined_size_settings',
'type' => 'subtitle',
),
array(
'title' => __( 'Width', 'lifterlms' ),
'id' => 'lifterlms_certificate_default_user_defined_width',
'type' => 'number',
'default' => $certificate_sizes['USER_DEFINED']['width'],
'autoload' => false,
'custom_attributes' => array(
'step' => '0.01',
),
),
array(
'title' => __( 'Height', 'lifterlms' ),
'id' => 'lifterlms_certificate_default_user_defined_height',
'type' => 'number',
'default' => $certificate_sizes['USER_DEFINED']['height'],
'autoload' => false,
'custom_attributes' => array(
'step' => '0.01',
),
),
array(
'title' => __( 'Unit', 'lifterlms' ),
'id' => 'lifterlms_certificate_default_user_defined_unit',
'type' => 'select',
'options' => $this->get_certificate_units_opts(),
'default' => $certificate_sizes['USER_DEFINED']['unit'],
'autoload' => false,
),
);
if ( $this->has_legacy_certificates() ) {
$settings = array_merge(
$settings,
array(
array(
'title' => __( 'Legacy Certificate Background Image Settings', 'lifterlms' ),
'type' => 'subtitle',
'desc' => __( 'Use these settings to determine the dimensions of legacy certificate background images created using the classic editor. These settings have no effect on certificates created using the block editor. After changing these settings, you may need to <a href="http://wordpress.org/extend/plugins/regenerate-thumbnails/" target="_blank">regenerate your thumbnails</a>.', 'lifterlms' ),
'id' => 'cert_bg_image_settings',
),
array(
'title' => __( 'Image Width', 'lifterlms' ),
'desc' => __( 'in pixels', 'lifterlms' ),
'id' => 'lifterlms_certificate_bg_img_width',
'default' => '800',
'type' => 'number',
'autoload' => false,
),
array(
'title' => __( 'Image Height', 'lifterlms' ),
'id' => 'lifterlms_certificate_bg_img_height',
'desc' => __( 'in pixels', 'lifterlms' ),
'default' => '616',
'type' => 'number',
'autoload' => false,
),
array(
'title' => __( 'Legacy compatibility', 'lifterlms' ),
'desc' => __( 'Use legacy certificate image sizes.', 'lifterlms' ) .
'<br><em>' . __( 'Enabling this will override the above dimension settings and set the image dimensions to match the dimensions of the uploaded image.', 'lifterlms' ) . '</em>',
'id' => 'lifterlms_certificate_legacy_image_size',
'default' => 'no',
'type' => 'checkbox',
'autoload' => false,
),
)
);
}
return $this->generate_settings_group(
'certificates_options',
__( 'Certificate Settings', 'lifterlms' ),
'',
$settings
);
}
/**
* Retrieve fields for the email settings group.
*
* @since 3.37.3
*
* @return array[]
*/
protected function get_settings_group_email() {
return $this->generate_settings_group(
'email_options',
__( 'Email Settings', 'lifterlms' ),
__( 'Settings for all emails sent by LifterLMS. Notification and engagement emails will adhere to these settings.', 'lifterlms' ),
array(
array(
'title' => __( 'Sender Name', 'lifterlms' ),
'desc' => __( 'Name to be displayed in From field.', 'lifterlms' ),
'id' => 'lifterlms_email_from_name',
'type' => 'text',
'default' => esc_attr( get_bloginfo( 'title' ) ),
),
array(
'title' => __( 'Sender Email', 'lifterlms' ),
'desc' => __( 'Email Address displayed in the From field.', 'lifterlms' ),
'id' => 'lifterlms_email_from_address',
'type' => 'email',
'default' => get_option( 'admin_email' ),
),
array(
'title' => __( 'Header Image', 'lifterlms' ),
'id' => 'lifterlms_email_header_image',
'type' => 'image',
'default' => '',
'autoload' => false,
),
array(
'title' => __( 'Email Footer Text', 'lifterlms' ),
'desc' => __( 'Text you would like displayed in the footer of all emails.', 'lifterlms' ),
'id' => 'lifterlms_email_footer_text',
'type' => 'textarea',
'default' => '',
),
)
);
}
/**
* Retrieve email delivery partner settings groups.
*
* @since 3.40.0
*
* @return array
*/
protected function get_settings_group_email_delivery() {
/**
* Filter settings for available email delivery services.
*
* @since 3.40.0
*
* @param array[] $settings Array of settings arrays.
*/
$services = apply_filters( 'llms_email_delivery_services', array() );
// If there's no services respond with an empty array so we don't output the whole section.
if ( ! $services ) {
return array();
}
// Output the a section.
return $this->generate_settings_group(
'email_delivery',
__( 'Email Delivery', 'lifterlms' ),
'',
$services
);
}
/**
* Retrieves the options array for the `lifterlms_certificate_default_size` option.
*
* @since 6.0.0
*
* @return array
*/
private function get_certificate_size_opts() {
$units = llms_get_certificate_units();
$sizes = array();
foreach ( llms_get_certificate_sizes() as $size_id => $data ) {
$unit = $units[ $data['unit'] ] ?? '';
$sizes[ $size_id ] = sprintf(
'%1$s (%2$s%4$s x %3$s%4$s)',
$data['name'],
$data['width'],
$data['height'],
$unit['symbol'] ?? ''
);
}
return $sizes;
}
/**
* Retrieves the options array for the `lifterlms_certificate_default_user_defined_units` option.
*
* @since 6.0.0
*
* @return array
*/
private function get_certificate_units_opts() {
$units = llms_get_certificate_units();
$opts = array();
foreach ( $units as $unit => $data ) {
$opts[ $unit ] = sprintf(
'%1$s (%2$s)',
$unit,
$data['name']
);
}
return $opts;
}
/**
* Retrieves the award image setting description HTML.
*
* @since 6.0.0
*
* @param string $post_type Translated post type name.
* @return string
*/
private function get_award_image_desc( $post_type ) {
$desc = sprintf(
__( 'A default image used for any %1$s template or award which does not specify an image. Changing this setting will affect all existing templates and awards which do not specify their own image.', 'lifterlms' ),
$post_type
);
return '<p class="description">' . $desc . '</p>';
}
/**
* Determines if legacy certificate options should be displayed.
*
* The option used to determine if there are certificates is set during a migration to version from versions
* earlier than 6.0.0. During the migration if at least one certificate template is migrated, the option
* is set and the legacy options will be displayed.
*
* Even after all certificates have been individually migrated the option will still be set and should be
* deleted via the db, set to 'no' via the options.php screen or disabled by returning `false` from the short
* circuit filter {@see llms_has_legacy_certificates}.
*
* @since 6.0.0
*
* @return boolean
*/
private function has_legacy_certificates() {
/**
* Short-circuits the legacy certificates check preventing a database call.
*
* This can be used to force-enable or force-disable legacy certificate settings regardless
* of the value found in the database option.
*
* @since 6.0.0
*
* @param boolean $has_legacy_certificates Return `true` to force legacy certificate settings on
* and `false` to force them off.
*/
$pre = apply_filters( 'llms_has_legacy_certificates', null );
if ( ! is_null( $pre ) ) {
return $pre;
}
return llms_parse_bool( get_option( 'llms_has_certificates_with_legacy_default_image', 'no' ) );
}
/**
* Outputs inline Javascript utilized on the engagements settings tab.
*
* @since 6.0.0
*
* @return void
*/
public function output_js() {
?>
<script>(function(){
const fields = {
height: document.getElementById( 'lifterlms_certificate_default_user_defined_height' ),
width: document.getElementById( 'lifterlms_certificate_default_user_defined_width' ),
unit: document.getElementById( 'lifterlms_certificate_default_user_defined_unit' ),
};
/**
* Updates the USER_DEFINED <option> text when the values of the custom inputs change.
*
* @since 6.0.0
*
* @return {void}
*/
function updateOptionText() {
const opt = document.getElementById( 'lifterlms_certificate_default_size' ).querySelector( 'option[value="USER_DEFINED"]' ),
newStr = fields.width.value + fields.unit.value + ' x ' + fields.height.value + fields.unit.value;
if ( opt ) {
opt.textContent = opt.textContent.replace( / \(.*\)/, ' (' + newStr + ')' );
}
}
// When any of the fields change, update the value of the option.
Object.values( fields ).map( function( el ) {
el.addEventListener( 'change', updateOptionText );
} );
})();</script>
<?php
}
}
return new LLMS_Settings_Engagements();
================================================
FILE: includes/admin/settings/class.llms.settings.general.php
================================================
<?php
/**
* Admin Settings Page, General Tab.
*
* @package LifterLMS/Admin/Settings/Classes
*
* @since 1.0.0
* @version 5.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Settings Page, General Tab class
*
* @since 1.0.0
* @since 3.22.0 Unknown.
*/
class LLMS_Settings_General extends LLMS_Settings_Page {
/**
* Constructor
*
* Executes settings tab actions.
*
* @since 1.0.0
*
* @return void
*/
public function __construct() {
$this->id = 'general';
$this->label = __( 'General', 'lifterlms' );
add_filter( 'lifterlms_settings_tabs_array', array( $this, 'add_settings_page' ), 20 );
add_action( 'lifterlms_settings_' . $this->id, array( $this, 'output' ) );
add_action( 'lifterlms_settings_save_' . $this->id, array( $this, 'save' ) );
}
/**
* Get settings array.
*
* @since 1.0.0
* @since 3.13.0 Unknown.
* @since 5.6.0 use LLMS_Roles::get_all_role_names() to retrieve the list of roles who can bypass enrollments.
* Add content protection setting.
*
* @return array
*/
public function get_settings() {
$settings = array();
$settings[] = array(
'id' => 'section_features',
'type' => 'sectionstart',
'class' => 'top',
);
$settings[] = array(
'id' => 'features',
'title' => __( 'Features', 'lifterlms' ),
'type' => 'title',
);
$settings[] = array(
'type' => 'custom-html',
'value' => sprintf(
__( 'Automatic Recurring Payments: <strong>%s</strong>', 'lifterlms' ),
LLMS_Site::get_feature( 'recurring_payments' ) ? __( 'Enabled', 'lifterlms' ) : __( 'Disabled', 'lifterlms' )
),
);
$settings[] = array(
'id' => 'section_features',
'type' => 'sectionend',
);
$settings[] = array(
'id' => 'section_tools',
'type' => 'sectionstart',
);
$settings[] = array(
'id' => 'general_settings',
'title' => __( 'General Settings', 'lifterlms' ),
'type' => 'title',
);
$settings[] = array(
'class' => 'llms-select2',
'custom_attributes' => array(
'data-placeholder' => __( 'Select user roles', 'lifterlms' ),
),
'default' => array( 'administrator', 'lms_manager', 'instructor', 'instructors_assistant' ),
'desc' => __( 'Users with the selected roles will bypass enrollment, drip, and prerequisite restrictions for courses and memberships.', 'lifterlms' ),
'id' => 'llms_grant_site_access',
'options' => array_filter(
LLMS_Roles::get_all_role_names(),
function ( $role ) {
return 'student' !== $role;
},
ARRAY_FILTER_USE_KEY
),
'title' => __( 'Unrestricted Preview Access', 'lifterlms' ),
'type' => 'multiselect',
);
$settings[] = array(
'title' => __( 'Content Protection', 'lifterlms' ),
'desc' => __( 'Prevent users from copying website content and downloading images.', 'lifterlms' ) . '<br><br>' . __( 'Users with Unrestricted Preview Access will not be affected by this setting.', 'lifterlms' ),
'id' => 'lifterlms_content_protection',
'default' => 'no',
'type' => 'checkbox',
);
$settings[] = array(
'title' => __( 'Frequency of Saving Tracked Events', 'lifterlms' ),
'default' => 'minimum',
'desc' => __( 'Specifies how often tracked events are sent to the server. "Minimum" sends only when local storage is almost full (fewer network calls). "Always" sends each event immediately (higher accuracy, more server load).', 'lifterlms' ),
'id' => 'lifterlms_tracked_event_saving_frequency',
'type' => 'select',
'options' => array(
'minimum' => __( 'Minimum', 'lifterlms' ),
'always' => __( 'Always', 'lifterlms' ),
),
);
$settings[] = array(
'id' => 'general_settings',
'type' => 'sectionend',
);
return apply_filters( 'lifterlms_general_settings', $settings );
}
/**
* save settings to the database
*
* @return void
*/
public function save() {
$settings = $this->get_settings();
LLMS_Admin_Settings::save_fields( $settings );
}
}
return new LLMS_Settings_General();
================================================
FILE: includes/admin/settings/class.llms.settings.integrations.php
================================================
<?php
/**
* Admin Settings Page, Integrations Tab
*
* @package LifterLMS/Admin/Settings/Classes
*
* @since 1.0.0
* @version 3.18.2
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Settings Page, Integrations Tab class
*
* @package LifterLMS/Admin/Settings/Classes
*
* @since 1.0.0
* @since 3.18.2 Unknown.
*/
class LLMS_Settings_Integrations extends LLMS_Settings_Page {
/**
* Constructor
* executes settings tab actions
*
* @since 1.0.0
* @version 3.18.2
*/
public function __construct() {
$this->id = 'integrations';
$this->label = __( 'Integrations', 'lifterlms' );
add_filter( 'lifterlms_settings_tabs_array', array( $this, 'add_settings_page' ), 20 );
add_action( 'lifterlms_sections_' . $this->id, array( $this, 'output_sections_nav' ) );
add_action( 'lifterlms_settings_' . $this->id, array( $this, 'output' ) );
add_action( 'lifterlms_settings_save_' . $this->id, array( $this, 'save' ) );
}
/**
* Get default settings array for the main integrations tab
*
* @return array
* @since 3.18.2
* @version 3.18.2
*/
private function get_default_settings() {
$settings = array(
array(
'type' => 'sectionstart',
'id' => 'checkout_settings_integrations_list_start',
),
array(
'title' => __( 'Integrations', 'lifterlms' ),
'type' => 'title',
'id' => 'checkout_settings_integrations_list_title',
),
array(
'value' => $this->get_table_html(),
'type' => 'custom-html',
),
array(
'type' => 'sectionend',
'id' => 'checkout_settings_integrations_list_end',
),
);
return apply_filters( 'llms_integrations_settings_default', $settings );
}
/**
* Get the page sections
*
* @return array
* @since 3.18.2
* @version 3.18.2
*/
public function get_sections() {
$sections = array();
$integrations = llms()->integrations()->get_integrations();
foreach ( $integrations as $int ) {
$sections[ $int->id ] = trim( str_replace( 'LifterLMS', '', $int->title ) );
}
$sections = array_merge(
array(
'main' => __( 'Integrations', 'lifterlms' ),
),
$sections
);
return apply_filters( 'llms_integration_settings_sections', $sections );
}
/**
* Get settings array
*
* @return array
* @since 1.0.0
* @version 3.18.2
*/
public function get_settings() {
$curr_section = $this->get_current_section();
if ( 'main' === $curr_section ) {
return apply_filters( 'lifterlms_integrations_settings', $this->get_default_settings() );
}
return apply_filters( 'lifterlms_integrations_settings_' . $curr_section, array() );
}
/**
* Get HTML for the integrations table
*
* @return string
* @since 3.18.2
* @version 3.18.2
*/
private function get_table_html() {
$integrations = llms()->integrations()->get_integrations();
ob_start();
?>
<table class="llms-table zebra text-left size-large llms-integrations-table">
<thead>
<tr>
<th><?php esc_html_e( 'Integration', 'lifterlms' ); ?></th>
<th><?php esc_html_e( 'Integration ID', 'lifterlms' ); ?></th>
<th><?php esc_html_e( 'Installed', 'lifterlms' ); ?></th>
<th><?php esc_html_e( 'Enabled', 'lifterlms' ); ?></th>
</tr>
</thead>
<tbody>
<?php
foreach ( $integrations as $integration ) :
if ( ! is_subclass_of( $integration, 'LLMS_Abstract_Integration' ) ) {
continue;
}
?>
<tr>
<td><a href="<?php echo esc_url( admin_url( 'admin.php?page=llms-settings&tab=' . $this->id . '§ion=' . $integration->id ) ); ?>"><?php echo esc_html( $integration->title ); ?></a></td>
<td><?php echo esc_html( $integration->id ); ?></td>
<td class="status available">
<?php if ( $integration->is_installed() ) : ?>
<span class="tip--bottom-right" data-tip="<?php esc_attr_e( 'Installed', 'lifterlms' ); ?>">
<span class="screen-reader-text"><?php esc_html_e( 'Installed', 'lifterlms' ); ?></span>
<i class="fa fa-check-circle" aria-hidden="true"></i>
</span>
<?php else : ?>
–
<?php endif; ?>
</td>
<td class="status enabled">
<?php if ( $integration->is_enabled() ) : ?>
<span class="tip--bottom-right" data-tip="<?php esc_attr_e( 'Enabled', 'lifterlms' ); ?>">
<span class="screen-reader-text"><?php esc_html_e( 'Enabled', 'lifterlms' ); ?></span>
<i class="fa fa-check-circle" aria-hidden="true"></i>
</span>
<?php else : ?>
–
<?php endif; ?>
</td>
</tr>
<?php endforeach; ?>
</tbody>
</table>
<?php
return ob_get_clean();
}
}
return new LLMS_Settings_Integrations();
================================================
FILE: includes/admin/settings/class.llms.settings.memberships.php
================================================
<?php
/**
* Admin Settings Page "Memberships" Tab
*
* @package LifterLMS/Admin/Settings/Classes
*
* @since 3.5.0
* @version 3.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Settings Page "Memberships" Tab class
*
* @since 3.5.0
*/
class LLMS_Settings_Memberships extends LLMS_Settings_Page {
/**
* Constructor
*
* Executes settings tab actions.
*
* @since 3.5.0
*
* @return void
*/
public function __construct() {
$this->id = 'memberships';
$this->label = __( 'Memberships', 'lifterlms' );
add_filter( 'lifterlms_settings_tabs_array', array( $this, 'add_settings_page' ), 20 );
add_action( 'lifterlms_settings_' . $this->id, array( $this, 'output' ) );
add_action( 'lifterlms_settings_save_' . $this->id, array( $this, 'save' ) );
}
/**
* Get settings array
*
* @return array
* @since 3.5.0
* @version 3.5.0
*/
public function get_settings() {
return apply_filters(
'lifterlms_membership_settings',
array(
array(
'class' => 'top',
'id' => 'membership_general_options',
'type' => 'sectionstart',
),
array(
'id' => 'membership_general_options_title',
'title' => __( 'Membership Settings', 'lifterlms' ),
'type' => 'title',
),
array(
'class' => 'llms-select2-post',
'custom_attributes' => array(
'data-allow-clear' => true,
'data-post-type' => 'llms_membership',
'data-placeholder' => __( 'Select a membership', 'lifterlms' ),
),
'default' => '',
'desc' => __( 'Only allow access to site to users with a specific membership level. Users will be able to view and purchase membership level.', 'lifterlms' ),
'id' => 'lifterlms_membership_required',
'options' => llms_make_select2_post_array( get_option( 'lifterlms_membership_required', '' ) ),
'title' => __( 'Restrict site by membership level', 'lifterlms' ),
'type' => 'select',
),
array(
'id' => 'membership_general_options',
'type' => 'sectionend',
),
array(
'class' => 'top',
'id' => 'membership_catalog_options',
'type' => 'sectionstart',
),
array(
'id' => 'membership_catalog_options_title',
'title' => __( 'Memberships Catalog', 'lifterlms' ),
'type' => 'title',
),
array(
'class' => 'llms-select2-post',
'custom_attributes' => array(
'data-allow-clear' => true,
'data-post-type' => 'page',
'data-placeholder' => __( 'Select a page', 'lifterlms' ),
),
'default' => '',
'desc' => __( 'This page is where your visitors will find a list of all your available memberships.', 'lifterlms' ),
'id' => 'lifterlms_memberships_page_id',
'options' => llms_make_select2_post_array( get_option( 'lifterlms_memberships_page_id', '' ) ),
'title' => __( 'Memberships Page', 'lifterlms' ),
'type' => 'select',
),
array(
'title' => __( 'Memberships per page', 'lifterlms' ),
'desc' => __( 'To show all memberships on one page, enter -1', 'lifterlms' ),
'id' => 'lifterlms_memberships_per_page',
'type' => 'number',
'default' => 9,
'css' => 'min-width:200px;',
),
array(
'default' => 'menu_order',
'desc' => __( 'Determines the display order for items on the memberships page.', 'lifterlms' ),
'id' => 'lifterlms_memberships_ordering',
'options' => array(
'menu_order,ASC' => __( 'Order (Low to High)', 'lifterlms' ),
'menu_order,DESC' => __( 'Order (High to Low)', 'lifterlms' ),
'title,ASC' => __( 'Title (A - Z)', 'lifterlms' ),
'title,DESC' => __( 'Title (Z - A)', 'lifterlms' ),
'date,DESC' => __( 'Most Recent', 'lifterlms' ),
),
'title' => __( 'Memberships Sorting', 'lifterlms' ),
'type' => 'select',
),
array(
'id' => 'membership_catalog_options',
'type' => 'sectionend',
),
)
);
}
/**
* save settings to the database
*
* @since 3.5.0
*
* @return void
*/
public function save() {
$settings = $this->get_settings();
LLMS_Admin_Settings::save_fields( $settings );
}
/**
* Output settings
*
* @since 3.5.0
*
* @return void
*/
public function output() {
$settings = $this->get_settings();
LLMS_Admin_Settings::output_fields( $settings );
}
}
return new LLMS_Settings_Memberships();
================================================
FILE: includes/admin/settings/class.llms.settings.notifications.php
================================================
<?php
/**
* Admin Settings: Notifications Tab
*
* @package LifterLMS/Admin/Settings/Classes
*
* @since 3.8.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Settings_Notifications class
*
* Admin Settings: Notifications Tab.
*
* @since 3.8.0
* @since 3.30.3 Explicitly define class properties; fix typo in title element id.
* @since 3.35.0 Sanitize input data.
*/
class LLMS_Settings_Notifications extends LLMS_Settings_Page {
/**
* @var LLMS_Abstract_Notification_View
*
* @since 3.8.0
*/
public $view;
/**
* Constructor.
*
* @since 3.8.0
* @since 3.24.0 Unknown.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
public function __construct() {
$this->id = 'notifications';
$this->label = __( 'Notifications', 'lifterlms' );
add_filter( 'lifterlms_settings_tabs_array', array( $this, 'add_settings_page' ), 20 );
add_action( 'lifterlms_settings_' . $this->id, array( $this, 'output' ) );
add_action( 'lifterlms_settings_save_' . $this->id, array( $this, 'before_save' ), 5 );
add_action( 'lifterlms_settings_save_' . $this->id, array( $this, 'save' ) );
add_action( 'lifterlms_settings_save_' . $this->id, array( $this, 'after_save' ), 15 );
add_filter( 'llms_settings_' . $this->id . '_has_save_button', array( $this, 'maybe_disable_save' ) );
}
/**
* Get a breadcrumb custom html for use on notification settings screens (not on the table)
*
* @since 3.8.0
*
* @param string $current_title The title of the current notification.
* @return array
*/
private function get_breadcrumbs( $current_title ) {
return array(
'id' => 'notification_options_breadcrumbs',
'type' => 'custom-html',
'value' => '<a href="' . esc_url( admin_url( 'admin.php?page=llms-settings&tab=notifications' ) ) . '">' . __( 'All Notifications', 'lifterlms' ) . '</a> <small>></small> <strong>' . $current_title . '</strong>',
);
}
/**
* Get settings specific to the current notification type
*
* @since 3.8.0
* @since 3.24.0 Unknown.
* @since 5.2.0 Merge controller additional options.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param LLMS_Abstract_Notification_Controller $controller Instance of an LLMS_Abstract_Notification_Controller extending class.
* @return array
*/
private function get_notification_settings( $controller ) {
$settings = array();
// Setup vars.
$type = llms_filter_input_sanitize_string( INPUT_GET, 'type' );
$types = $controller->get_supported_types();
$title = $controller->get_title() . ' (' . $types[ $type ] . ')';
$view = $controller->get_mock_view( $type );
// So the merge code button can use it.
$this->view = $view;
// Output the merge code button for the WYSIWYG editor.
add_action( 'media_buttons', array( $this, 'merge_code_button' ) );
// Add a breadcrumb on the top of the page.
$settings[] = $this->get_breadcrumbs( $title );
// Add field options for the view.
$settings = array_merge( $settings, $view->get_field_options( $type ) );
$subscribers = $controller->get_subscriber_options( $type );
foreach ( $subscribers as $i => $data ) {
$sub_settings = array(
'default' => $data['enabled'],
'desc' => $data['title'],
'id' => sprintf( '%1$s[%2$s]', $controller->get_option_name( $type . '_subscribers' ), $data['id'] ),
'type' => 'checkbox',
);
if ( 0 === $i ) {
$sub_settings['title'] = __( 'Subscribers', 'lifterlms' );
$sub_settings['checkboxgroup'] = 'start';
} elseif ( count( $subscribers ) - 1 === $i ) {
$sub_settings['checkboxgroup'] = 'end';
} else {
$sub_settings['checkboxgroup'] = 'middle';
}
$settings[] = $sub_settings;
if ( 'custom' === $data['id'] ) {
$settings[] = array(
'desc' => $data['description'],
'id' => $controller->get_option_name( $type . '_custom_subscribers' ),
'type' => 'text',
);
}
}
// Add additional controller options.
$settings = array_merge( $settings, $controller->get_additional_options( $type ) );
if ( $controller->is_testable( $type ) ) {
foreach ( $controller->get_test_settings( $type ) as $setting ) {
$setting['id'] = 'llms_notification_test_data[' . $setting['id'] . ']';
$settings[] = $setting;
}
}
return apply_filters( 'llms_notification_settings_' . $controller->id . '_' . $type, $settings, $controller, $view );
}
/**
* Get settings array
*
* @since 3.8.0
* @since 3.30.3 Fixed typo in title id.
*
* @return array
*/
public function get_settings() {
$settings = array();
$settings[] = array(
'class' => 'top',
'id' => 'notification_options',
'type' => 'sectionstart',
);
$settings[] = array(
'title' => __( 'Notification Settings', 'lifterlms' ),
'type' => 'title',
'id' => 'notification_options_title',
);
if ( isset( $_GET['notification'] ) ) {
$controller = llms()->notifications()->get_controller( llms_filter_input_sanitize_string( INPUT_GET, 'notification' ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
if ( $controller ) {
$settings = array_merge( $settings, $this->get_notification_settings( $controller ) );
} else {
$settings[] = array(
'id' => 'notification_options_invalid_error',
'type' => 'custom-html',
'value' => __( 'Invalid notification', 'lifterlms' ),
);
}
} else {
$settings[] = array(
'id' => 'llms_notifications_table',
'table' => new LLMS_Table_NotificationSettings(),
'type' => 'table',
);
}
$settings[] = array(
'id' => 'notification_options',
'type' => 'sectionend',
);
return apply_filters( 'lifterlms_notifications_settings', $settings );
}
/**
* Disable save button on the main notification tab (list)
*
* @since 3.24.0
*
* @param bool $bool Default display value (true).
* @return boolean
*/
public function maybe_disable_save( $bool ) {
return ( isset( $_GET['notification'] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
}
/**
* Output a merge code button in the WYSIWYG editor
*
* @since 3.8.0
*
* @return void
*/
public function merge_code_button() {
llms_merge_code_button( $this->view->get_option_name( 'body' ), true, $this->view->get_merge_codes() );
}
/**
* Remove test data from $_POST so that it wont be saved to the DB
*
* @since 3.24.0
* @since 3.35.0 Verify nonce & Sanitize input data.
*
* @return void
*/
public function before_save() {
if ( ! isset( $_REQUEST['_wpnonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_wpnonce'] ) ), 'lifterlms-settings' ) ) {
return;
}
if ( isset( $_POST['llms_notification_test_data'] ) ) {
$_POST['llms_notification_test_data_temp'] = wp_unslash( $_POST['llms_notification_test_data'] ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
unset( $_POST['llms_notification_test_data'] );
}
}
/**
* Send a test notification after notification data is saved
*
* @since 3.24.0
* @since 3.35.0 Verify nonce & Sanitize input data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public function after_save() {
if ( ! isset( $_REQUEST['_wpnonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_wpnonce'] ) ), 'lifterlms-settings' ) ) {
return;
}
if ( isset( $_GET['notification'] ) && isset( $_GET['type'] ) && isset( $_POST['llms_notification_test_data_temp'] ) ) {
if ( ! empty( $_POST['llms_notification_test_data_temp'] ) ) {
$controller = llms()->notifications()->get_controller( llms_filter_input_sanitize_string( INPUT_GET, 'notification' ) );
$controller->send_test(
llms_filter_input_sanitize_string( INPUT_GET, 'type' ),
wp_unslash( $_POST['llms_notification_test_data_temp'] ) // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
);
}
}
}
}
return new LLMS_Settings_Notifications();
================================================
FILE: includes/admin/settings/class.llms.settings.page.php
================================================
<?php
/**
* Admin Settings Page Base
*
* @package LifterLMS/Admin/Settings/Classes
*
* @since 1.0.0
* @version 3.37.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Settings Page Base class
*
* @since 1.0.0
* @since 3.30.3 Explicitly define class properties.
* @since 3.35.0 Unslash input data.
* @since 3.37.3 Add a constructor which registers the settings page and automatically saves and outputs settings content.
* Add public method stub `get_label()` which is used to automatically set the `$label` property on class initialization.
* Add utility method to generate a group of settings.
*/
class LLMS_Settings_Page {
/**
* Allow settings page to determine if a rewrite flush is required
*
* @var boolean
*/
protected $flush = false;
/**
* Settings identifier
*
* @var string
*/
public $id = '';
/**
* Settings page label / title.
*
* @var string
*/
public $label = '';
/**
* Tab priority
*
* Determines the order of the page when registered with the core settings array.
*
* @var int
*/
public $tab_priority = 20;
/**
* Constructor.
*
* @since 3.37.3
*
* @return void
*/
public function __construct() {
$this->label = $this->set_label();
add_filter( 'lifterlms_settings_tabs_array', array( $this, 'add_settings_page' ), $this->tab_priority );
if ( $this->id ) {
add_action( 'lifterlms_settings_' . $this->id, array( $this, 'output' ) );
add_action( 'lifterlms_settings_save_' . $this->id, array( $this, 'save' ) );
}
}
/**
* Add the settings page
*
* @since 1.0.0
*
* @return array
*/
public function add_settings_page( $pages ) {
$pages[ $this->id ] = $this->label;
return $pages;
}
/**
* Flushes rewrite rules when necessary
*
* @since 3.0.4
*
* @return void
*/
public function flush_rewrite_rules() {
// Add the updated endpoints.
$query = new LLMS_Query();
$query->add_endpoints();
// Flush rewrite rules.
flush_rewrite_rules();
}
/**
* Retrieve current section from URL var
*
* @since 3.17.5
* @since 3.35.0 Unslash input data.
*
* @return string
*/
protected function get_current_section() {
return isset( $_GET['section'] ) ? sanitize_text_field( wp_unslash( $_GET['section'] ) ) : 'main';
}
/**
* Retrieve the page label.
*
* Extending classes should override this to return a translated string used as the page's title.
*
* @since 3.37.3
*
* @return string
*/
protected function set_label() {
return $this->id;
}
/**
* Generates a group of settings.
*
* @since 3.37.3
*
* @param string $id Group ID. Used to create IDs for the start, end, and title fields.
* @param string $title Title of the group (should be translatable).
* @param string $title_desc (Optional) title field description text.
* @param array[] $settings Array of settings field arrays.
* @return array[]
*/
protected function generate_settings_group( $id, $title, $title_desc = '', $settings = array() ) {
$start = array(
array(
'type' => 'sectionstart',
'id' => $id,
),
array(
'type' => 'title',
'id' => sprintf( '%s_title', $id ),
'title' => $title,
'desc' => $title_desc,
),
);
$end = array(
array(
'type' => 'sectionend',
'id' => sprintf( '%s_end', $id ),
),
);
return array_merge( $start, $settings, $end );
}
/**
* Get the page sections (stub)
*
* When overriding, this should return an associative array where the key is the
* section id and the value is the (translated) section title. The "default" tab
* should always use the id "main".
*
* @since 1.0.0
* @since 3.17.5 Return an array instead of void.
*
* @return array
*/
public function get_sections() {
return array();
}
/**
* Retrieve the page's settings (stub)
*
* @since 3.17.5
*
* @return array
*/
public function get_settings() {
return array();
}
/**
* Output the settings fields
*
* @since 1.0.0
* @since 3.17.5 Unknown.
*
* @return void
*/
public function output() {
LLMS_Admin_Settings::output_fields( $this->get_settings() );
}
/**
* Output settings sections as tabs and set post href
*
* @since 3.17.5
*
* @return void
*/
public function output_sections_nav() {
$sections = $this->get_sections();
if ( empty( $sections ) ) {
return;
}
$curr = $this->get_current_section();
?>
<nav class="llms-nav-tab-wrapper llms-nav-text">
<ul class="llms-nav-items">
<?php foreach ( $sections as $key => $title ) : ?>
<li class="llms-nav-item<?php echo ( $key === $curr ) ? ' llms-active' : ''; ?>">
<a class="llms-nav-link" href="<?php echo esc_url( admin_url( 'admin.php?page=llms-settings&tab=' . $this->id . '§ion=' . $key ) ); ?>"><?php echo esc_html( $title ); ?></a>
</li>
<?php endforeach; ?>
</ul>
</nav>
<?php
}
/**
* Save the settings field values
*
* @since 1.0.0
* @since 3.17.5 Unknown.
*
* @return void
*/
public function save() {
LLMS_Admin_Settings::save_fields( $this->get_settings() );
if ( $this->flush ) {
add_action( 'shutdown', array( $this, 'flush_rewrite_rules' ) );
}
}
}
================================================
FILE: includes/admin/settings/class.llms.settings.security.php
================================================
<?php
/**
* Admin Settings Page, Security Tab
*
* @package LifterLMS/Admin/Settings/Classes
*
* @since 9.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin Settings Page, Security Tab class
*
* @since 9.0.0
*/
class LLMS_Settings_Security extends LLMS_Settings_Page {
/**
* Settings identifier
*
* @var string
*/
public $id = 'security';
/**
* Get settings array
*
* @since 9.0.0
*
* @return array
*/
public function get_settings() {
$account_settings = array(
array(
'class' => 'top',
'id' => 'course_account_options',
'type' => 'sectionstart',
),
array(
'title' => __( 'Website Security & Spam Prevention', 'lifterlms' ),
'type' => 'title',
'id' => 'security_and_spam_options_title',
),
array(
'autoload' => false,
'default' => '',
'id' => 'lifterlms_captcha',
'desc' => __( 'Choose a captcha service to require at checkout.', 'lifterlms' ),
'title' => __( 'Captcha', 'lifterlms' ),
'type' => 'select',
'options' => array(
'' => __( 'None', 'lifterlms' ),
'recaptcha' => __( 'reCAPTCHA', 'lifterlms' ),
'turnstile' => __( 'Turnstile', 'lifterlms' ),
),
'class' => 'llms-conditional-controller',
'custom_attributes' => array(
'data-controls-recaptcha' => '#lifterlms_recaptcha_site_key,#lifterlms_recaptcha_secret_key,#lifterlms_recaptcha_min_score',
'data-controls-turnstile' => '#lifterlms_turnstile_site_key,#lifterlms_turnstile_secret_key',
),
),
array(
'autoload' => false,
'default' => '',
'id' => 'lifterlms_recaptcha_site_key',
'desc' => 'Requires reCAPTCHA v3 keys. <a href="https://lifterlms.com/docs/recaptcha" target="_blank">Learn More</a>.',
'title' => __( 'reCAPTCHA v3 Site Key', 'lifterlms' ),
'type' => 'text',
),
array(
'autoload' => false,
'default' => '',
'id' => 'lifterlms_recaptcha_secret_key',
'desc' => '',
'title' => __( 'reCAPTCHA v3 Secret Key', 'lifterlms' ),
'type' => 'text',
),
array(
'autoload' => false,
'default' => '5',
'id' => 'lifterlms_recaptcha_min_score',
'desc' => 'The minimum score required for reCAPTCHA validation, from 1-10. Google recommends 5 as a default. <a href="https://lifterlms.com/docs/recaptcha" target="_blank">Learn More</a>.',
'title' => __( 'reCAPTCHA Minimum Score', 'lifterlms' ),
'type' => 'number',
'custom_attributes' => array(
'min' => '1',
'max' => '10',
),
),
array(
'autoload' => false,
'default' => '',
'id' => 'lifterlms_turnstile_site_key',
'desc' => 'Requires Cloudflare Turnstile keys. <a href="https://lifterlms.com/docs/turnstile" target="_blank">Learn More</a>.',
'title' => __( 'Turnstile Site Key', 'lifterlms' ),
'type' => 'text',
),
array(
'autoload' => false,
'default' => '',
'id' => 'lifterlms_turnstile_secret_key',
'desc' => '',
'title' => __( 'Turnstile Secret Key', 'lifterlms' ),
'type' => 'text',
),
array(
'autoload' => false,
'default' => 'yes',
'id' => 'lifterlms_spam_protection',
'desc' => __( 'Block IPs from checkout if there are more than 10 failures within 15 minutes.', 'lifterlms' ),
'title' => __( 'Spam Protection', 'lifterlms' ),
'type' => 'checkbox',
),
);
if ( LLMS_Akismet::instance()->is_available() ) {
$account_settings[] = array(
'autoload' => false,
'default' => 'no',
'id' => 'lifterlms_akismet_enabled',
'desc' => __( 'Enable Akismet spam protection.', 'lifterlms' ),
'title' => __( 'Akismet Spam Protection', 'lifterlms' ),
'type' => 'checkbox',
);
}
$account_settings[] =
array(
'id' => 'security_and_spam_options_end',
'type' => 'sectionend',
);
/**
* Filters the account settings.
*
* The dynamic portion of this filter `{$this->id}` refers to the unique ID for the settings page.
*
* @since 9.0.0
*
* @param array $account_settings The account page settings.
*/
return apply_filters( "lifterlms_{$this->id}_settings", $account_settings );
}
/**
* Retrieve the page label.
*
* @since 9.0.0
*
* @return string
*/
protected function set_label() {
return __( 'Security', 'lifterlms' );
}
}
return new LLMS_Settings_Security();
================================================
FILE: includes/admin/settings/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/settings/tables/class.llms.table.notification.settings.php
================================================
<?php
/**
* Student Management table on Courses and Memberships
*
* @package LifterLMS/Admin/Settings/Tables/Classes
*
* @since 3.8.0
* @version 3.10.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Table_NotificationSettings class
*
* Student Management table on Courses and Memberships.
*
* @since 3.8.0
* @since 3.10.0 Unknown.
*/
class LLMS_Table_NotificationSettings extends LLMS_Admin_Table {
/**
* Unique ID for the Table
*
* @var string
*/
protected $id = 'notifications';
/**
* If true will be a table with a larger font size
*
* @var bool
*/
protected $is_large = true;
/**
* Retrieve data for the columns
*
* @since 3.8.0
*
* @param string $key The column id / key.
* @param array $data Table data array.
* @return mixed
*/
public function get_data( $key, $data ) {
switch ( $key ) {
case 'configure':
$links = array();
foreach ( $data['configure'] as $type => $name ) {
$url = esc_url(
add_query_arg(
array(
'notification' => $data['id'],
'type' => $type,
)
)
);
$links[] = '<a href="' . $url . '">' . $name . '</a>';
}
$value = implode( ', ', $links );
break;
default:
$value = $data[ $key ];
}
return $this->filter_get_data( $value, $key, $data );
}
/**
* Execute a query to retrieve results from the table
*
* @param array $args array of query args
* @return void
* @since 3.8.0
* @version 3.10.0
*/
public function get_results( $args = array() ) {
$rows = array();
foreach ( llms()->notifications()->get_controllers() as $controller ) {
$rows[] = array(
'id' => $controller->id,
'notification' => $controller->get_title(),
'configure' => $controller->get_supported_types(),
);
}
usort( $rows, array( $this, 'sort_rows' ) );
$this->tbody_data = $rows;
}
/**
* Define the structure of arguments used to pass to the get_results method
*
* @return array
* @since 3.8.0
* @version 3.8.0
*/
public function set_args() {
return array();
}
/**
* Define the structure of the table
*
* @return array
* @since 3.8.0
* @version 3.8.0
*/
public function set_columns() {
$cols = array(
'notification' => __( 'Notification', 'lifterlms' ),
'configure' => __( 'Configure', 'lifterlms' ),
);
return $cols;
}
/**
* Sorting function to display all loaded notifications in alphabetical order
*
* @param array $row_a first row to compare
* @param array $row_b second row to compare
* @return int
* @since 3.10.0
* @version 3.10.0
*/
public function sort_rows( $row_a, $row_b ) {
return strcmp( $row_a['notification'], $row_b['notification'] );
}
}
================================================
FILE: includes/admin/settings/tables/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/admin/tools/class-llms-admin-tool-batch-eraser.php
================================================
<?php
/**
* Admin tool to delete pending batches created by a background processor
*
* @package LifterLMS/Admin/Tools/Classes
*
* @since 3.37.19
* @version 3.37.19
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Tool_Batch_Eraser
*
* @since 3.37.19
*/
class LLMS_Admin_Tool_Batch_Eraser extends LLMS_Abstract_Admin_Tool {
/**
* Tool ID.
*
* @var string
*/
protected $id = 'batch-eraser';
/**
* Retrieve a description of the tool
*
* This is displayed on the right side of the tool's list before the button.
*
* @since 3.37.19
*
* @return string
*/
protected function get_description() {
$count = $this->get_pending_batches();
$desc = __( 'Deletes pending batches generated by LifterLMS background processors.', 'lifterlms' );
$desc .= ' ';
// Translators: %d = the number of pending batches.
$desc .= sprintf(
_n(
'There is currently %d pending batch that will be deleted.',
'There are currently %d pending batches that will be deleted.',
$count,
'lifterlms'
),
$count
);
return $desc;
}
/**
* Retrieve the tool's label
*
* The label is the tool's title. It's displayed in the left column on the tool's list.
*
* @since 3.37.19
*
* @return string
*/
protected function get_label() {
return __( 'Delete processor batches', 'lifterlms' );
}
/**
* Retrieve the tool's button text
*
* @since 3.37.19
*
* @return string
*/
protected function get_text() {
return __( 'Delete batches', 'lifterlms' );
}
/**
* Retrieve the number of pending batches.
*
* @since 3.37.19
*
* @return int
*/
protected function get_pending_batches() {
$count = wp_cache_get( $this->id, 'llms_tool_data' );
if ( false === $count ) {
global $wpdb;
$count = absint( $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->options} WHERE option_name LIKE '%llms_%_batch_%';" ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
wp_cache_set( $this->id, $count, 'llms_tool_data' );
}
return $count;
}
/**
* Process the tool.
*
* This method should do whatever the tool actually does.
*
* By the time this tool is called a nonce and the user's capabilities have already been checked.
*
* @since 3.37.19
*
* @return mixed
*/
protected function handle() {
global $wpdb;
$res = $wpdb->query( "DELETE FROM {$wpdb->options} WHERE option_name LIKE '%llms_%_batch_%';" ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
wp_cache_delete( $this->id, 'llms_tool_data' );
return $res > 0;
}
/**
* Conditionally load the tool
*
* This tool should only load if there's batches in the database.
*
* @since 3.37.19
*
* @return boolean Return `true` to load the tool and `false` to not load it.
*/
protected function should_load() {
return $this->get_pending_batches() > 0;
}
}
return new LLMS_Admin_Tool_Batch_Eraser();
================================================
FILE: includes/admin/tools/class-llms-admin-tool-clear-sessions.php
================================================
<?php
/**
* Admin tool to delete pending batches created by a background processor
*
* @package LifterLMS/Admin/Tools/Classes
*
* @since 4.0.0
* @version 4.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Tool_Clear_Sessions
*
* @since 4.0.0
*/
class LLMS_Admin_Tool_Clear_Sessions extends LLMS_Abstract_Admin_Tool {
/**
* Tool ID.
*
* @var string
*/
protected $id = 'clear-sessions';
/**
* Retrieve a description of the tool
*
* This is displayed on the right side of the tool's list before the button.
*
* @since 4.0.0
*
* @return string
*/
protected function get_description() {
return __( 'LifterLMS user sessions store temporary data related to error messages and order information during payment processing. Stale sessions are automatically deleted. This tool can be used to delete all existing user sessions.', 'lifterlms' );
}
/**
* Retrieve the tool's label
*
* The label is the tool's title. It's displayed in the left column on the tool's list.
*
* @since 4.0.0
*
* @return string
*/
protected function get_label() {
return __( 'User Sessions', 'lifterlms' );
}
/**
* Retrieve the tool's button text
*
* @since 4.0.0
*
* @return string
*/
protected function get_text() {
return __( 'Clear All User Sessions', 'lifterlms' );
}
/**
* Process the tool.
*
* This method should do whatever the tool actually does.
*
* By the time this tool is called a nonce and the user's capabilities have already been checked.
*
* @since 4.0.0
*
* @return mixed
*/
protected function handle() {
do_action( 'llms_delete_expired_session_data', false );
return true;
}
}
return new LLMS_Admin_Tool_Clear_Sessions();
================================================
FILE: includes/admin/tools/class-llms-admin-tool-course-data-lock-eraser.php
================================================
<?php
/**
* Admin tool to delete locked created by the Course Data background processor.
*
* @package LifterLMS/Admin/Tools/Classes
*
* @since 9.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Tool_Course_Data_Lock_Eraser
*
* @since 9.0.0
*/
class LLMS_Admin_Tool_Course_Data_Lock_Eraser extends LLMS_Abstract_Admin_Tool {
/**
* Tool ID.
*
* @var string
*/
protected $id = 'course-data-eraser';
/**
* Retrieve a description of the tool.
*
* This is displayed on the right side of the tool's list before the button.
*
* @since 9.0.0
*
* @return string
*/
protected function get_description() {
$count = $this->get_locked_courses();
$desc = __( 'Deletes locks generated by LifterLMS course data background processor.', 'lifterlms' );
$desc .= ' ';
// Translators: %d = the number of pending batches.
$desc .= sprintf(
_n(
'There is currently %d lock that will be deleted.',
'There are currently %d locks that will be deleted.',
$count,
'lifterlms'
),
$count
);
return $desc;
}
/**
* Retrieve the tool's label
*
* The label is the tool's title. It's displayed in the left column on the tool's list.
*
* @since 9.0.0
*
* @return string
*/
protected function get_label() {
return __( 'Delete course data locks', 'lifterlms' );
}
/**
* Retrieve the tool's button text
*
* @since 9.0.0
*
* @return string
*/
protected function get_text() {
return __( 'Delete locks', 'lifterlms' );
}
/**
* Retrieve the number of course data locks.
*
* @since 9.0.0
*
* @return int
*/
protected function get_locked_courses() {
$count = wp_cache_get( $this->id, 'llms_tool_data' );
if ( false === $count ) {
global $wpdb;
$count = absint( $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->postmeta} WHERE meta_key = '_llms_temp_calc_data_lock';" ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
wp_cache_set( $this->id, $count, 'llms_tool_data' );
}
return $count;
}
/**
* Process the tool.
*
* This method should do whatever the tool actually does.
*
* By the time this tool is called a nonce and the user's capabilities have already been checked.
*
* @since 9.0.0
*
* @return bool
*/
protected function handle() {
$res = delete_post_meta_by_key( '_llms_temp_calc_data_lock' );
wp_cache_delete( $this->id, 'llms_tool_data' );
return $res;
}
/**
* Conditionally load the tool.
*
* This tool should only load if there's locks in the database.
*
* @since 9.0.0
*
* @return boolean Return `true` to load the tool and `false` to not load it.
*/
protected function should_load() {
return $this->get_locked_courses() > 0;
}
}
return new LLMS_Admin_Tool_Course_Data_Lock_Eraser();
================================================
FILE: includes/admin/tools/class-llms-admin-tool-install-forms.php
================================================
<?php
/**
* LLMS_Admin_Tool_Install_Forms class file
*
* @package LifterLMS/Admin/Tools/Classes
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin tool to reinstall / revert user information forms to their default states
*
* @since 5.0.0
*/
class LLMS_Admin_Tool_Install_Forms extends LLMS_Abstract_Admin_Tool {
/**
* Tool ID.
*
* @var string
*/
protected $id = 'install-forms';
/**
* Retrieve a description of the tool
*
* This is displayed on the right side of the tool's list before the button.
*
* @since 5.0.0
*
* @return string
*/
protected function get_description() {
return __( 'Restores LifterLMS user information forms and reusable field blocks to their default versions. Caution: any existing form and field customizations will be lost!', 'lifterlms' );
}
/**
* Retrieve the tool's label
*
* The label is the tool's title. It's displayed in the left column on the tool's list.
*
* @since 5.0.0
*
* @return string
*/
protected function get_label() {
return __( 'Reinstall User Forms', 'lifterlms' );
}
/**
* Retrieve the tool's button text
*
* @since 5.0.0
*
* @return string
*/
protected function get_text() {
return __( 'Reinstall Forms', 'lifterlms' );
}
/**
* Retrieves a list of core reusable blocks ordered by their field ID.
*
* @since 5.0.0
*
* @return int[] List of the WP_Post IDs.
*/
public function get_reusable_blocks() {
$query = new WP_Query(
array(
'posts_per_page' => -1,
'no_found_rows' => true,
'post_type' => 'wp_block',
'meta_key' => '_llms_field_id',
'meta_compare' => 'EXISTS',
'orderby' => 'meta_value',
)
);
return wp_list_pluck( $query->posts, 'ID' );
}
/**
* Process the tool.
*
* Deletes all core reusable blocks and then recreates the core forms,
* which additionally recreates the core reusable blocks.
*
* @since 5.0.0
*
* @return boolean
*/
protected function handle() {
// Retrieve original reusable blocks.
$original_blocks = $this->get_reusable_blocks();
// Delete them all.
foreach ( $original_blocks as $id ) {
wp_delete_post( $id, true );
}
// Recreate the forms (and the blocks).
LLMS_Forms::instance()->install( true );
return true;
}
}
return new LLMS_Admin_Tool_Install_Forms();
================================================
FILE: includes/admin/tools/class-llms-admin-tool-limited-billing-order-locator.php
================================================
<?php
/**
* LLMS_Admin_Tool_Limited_Billing_Order_Locator class.
*
* @package LifterLMS/Admin/Tools/Classes
*
* @since 5.3.0
* @version 5.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin tool which generates a report of limited billing orders affected by order end changes.
*
* @since 5.3.0
*
* @link https://github.com/gocodebox/lifterlms/pull/1744
*/
class LLMS_Admin_Tool_Limited_Billing_Order_Locator extends LLMS_Abstract_Admin_Tool {
/**
* Tool ID.
*
* @var string
*/
protected $id = 'limited-billing-order-locator';
/**
* Query the database for orders that may be affected by the change.
*
* @since 5.3.0
* @since 5.4.0 Retrieve orders ordered by their unique ID (DESC) instead of the default `date_created`.
*
* @return array[] Returns an array of arrays where each array represents a line in the generated CSV file.
*/
protected function generate_csv() {
$csv = array();
$orders = new WP_Query(
array(
'post_type' => 'llms_order',
'post_status' => array( 'llms-active', 'llms-on-hold' ),
'posts_per_page' => -1,
'orderby' => 'ID',
'meta_query' => array(
array(
'key' => '_llms_billing_length',
'value' => 1,
'compare' => '>=',
),
array(
'key' => '_llms_date_billing_end',
'compare' => 'EXISTS',
),
),
)
);
foreach ( $orders->posts as $order ) {
$order = llms_get_post( $order );
if ( ! $order || ! is_a( $order, 'LLMS_Order' ) ) {
continue;
}
$csv[] = $this->get_order_csv( $order );
}
return array_filter( $csv );
}
/**
* Create a csv "file" via output buffering and return it as a string.
*
* @since 5.3.0
*
* @return string
*/
protected function get_csv_file() {
$csv = $this->get_csv();
// Add header row.
array_unshift(
$csv,
array(
'Order ID',
'Expected Payments',
'Total Payments',
'Successful Payments',
'Refunded Payments',
'Edit Link',
)
);
// Create the CSV file.
ob_start();
$fh = fopen( 'php://output', 'w' );
foreach ( $csv as $line ) {
fputcsv( $fh, $line );
}
fclose( $fh ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fclose
return ob_get_clean();
}
/**
* Retrieve a description of the tool.
*
* This is displayed on the right side of the tool's list before the button.
*
* @since 5.3.0
*
* @return string
*/
protected function get_description() {
$count = count( $this->get_csv() );
$desc = sprintf(
// Translators: %1$s = opening anchor link to documentation; %2$s = closing anchor link.
__( 'The method used to determine when a limited-billing recurring order has completed its payment plan changed during version 5.3.0. This tool provides a report of orders which may been affected by this change. %1$sRead more%2$s about this change.', 'lifterlms' ),
'<a href="https://lifterlms.com/docs/payment-plan-orders-530/" target="_blank">',
'</a>'
);
$desc .= ' ';
// Translators: %d = the number of pending batches.
$desc .= sprintf(
_n(
'There is %d order that should be reviewed.',
'There are %d orders that should be reviewed.',
$count,
'lifterlms'
),
$count
);
return $desc;
}
/**
* Retrieve the tool's label.
*
* The label is the tool's title. It's displayed in the left column on the tool's list.
*
* @since 5.3.0
*
* @return string
*/
protected function get_label() {
return __( 'Limited Billing Orders', 'lifterlms' );
}
/**
* Retrieves an array representing a line in generated CSV for the given order.
*
* An order is considered to be affected by the change if either of the following conditions are true:
*
* + Any number of refunds exist for the order. Since we are now counting refunds towards the billing limit
* an active order with any number of refunds should be reviewed by the admin.
*
* + The plan is marked as "ended" and the total number of successful payments is not equal to the billing length.
* In this scenario admins will likely want to add additional payments and start the order again.
*
* @since 5.3.0
*
* @param LLMS_Order $order The order object.
* @return array Array of information on the order to be stored in the generated CSV or an empty array of the order
* was not affected by the change.
*/
protected function get_order_csv( $order ) {
$refunds = $this->get_txn_count_by_status( $order, 'llms-txn-refunded' );
$successes = $this->get_txn_count_by_status( $order, 'llms-txn-succeeded' );
$total = $refunds + $successes;
$ended = llms_parse_bool( $order->get( 'plan_ended' ) );
$expected = $order->get( 'billing_length' );
if ( $refunds >= 1 || ( $ended && $total !== $expected ) ) {
$id = $order->get( 'id' );
$link = get_edit_post_link( $id, 'raw' );
return array( $id, $expected, $total, $successes, $refunds, $link );
}
return array();
}
/**
* Helper to get the number of transactions on an order for a given status.
*
* @since 5.3.0
*
* @param LLMS_Order $order The order object.
* @param string $status Transaction post status to query by.
* @return int Number of transactions for the requested status.
*/
protected function get_txn_count_by_status( $order, $status ) {
$txns = $order->get_transactions(
array(
'per_page' => 1,
'status' => array( $status ),
'type' => array( 'recurring', 'single' ), // If a manual payment is recorded it's counted a single payment and that should count.
)
);
return $txns['total'];
}
/**
* Retrieve the tool's button text.
*
* @since 5.3.0
*
* @return string
*/
protected function get_text() {
return __( 'Download CSV', 'lifterlms' );
}
/**
* Retrieve a list of orders.
*
* @since 5.3.0
*
* @return int[]
*/
protected function get_csv() {
$csv = wp_cache_get( $this->id, 'llms_tool_data' );
if ( ! $csv ) {
$csv = $this->generate_csv();
wp_cache_set( $this->id, $csv, 'llms_tool_data' );
}
return $csv;
}
/**
* Generate the CSV file an serve it as a downloadable attachment.
*
* @since 5.3.0
*
* @return void
*/
protected function handle() {
$file = $this->get_csv_file();
if ( ! headers_sent() ) { // This makes the method testable via phpunit.
header( 'Content-Type: text/csv' );
header( 'Content-Disposition: attachment; filename=orders.csv' );
header( 'Content-Length: ' . strlen( $file ) );
nocache_headers();
}
llms_exit( $file );
}
/**
* Conditionally load the tool.
*
* This tool should only load if there are orders that can be handled by the tool.
*
* @since 5.3.0
*
* @return boolean Return `true` to load the tool and `false` to not load it.
*/
protected function should_load() {
return count( $this->get_csv() ) > 0;
}
}
return new LLMS_Admin_Tool_Limited_Billing_Order_Locator();
================================================
FILE: includes/admin/tools/class-llms-admin-tool-recurring-payment-rescheduler.php
================================================
<?php
/**
* Admin tool used to automatically reschedule recurring orders missing a pending scheduled payment action
*
* @package LifterLMS/Admin/Tools/Classes
*
* @since 4.6.0
* @version 4.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Tool_Recurring_Payment_Rescheduler class
*
* @since 4.6.0
*/
class LLMS_Admin_Tool_Recurring_Payment_Rescheduler extends LLMS_Abstract_Admin_Tool {
/**
* Tool ID.
*
* @var string
*/
protected $id = 'recurring-payment-rescheduler';
/**
* Retrieve a description of the tool
*
* This is displayed on the right side of the tool's list before the button.
*
* @since 4.6.0
* @since 4.7.0 Modified language and use count from `FOUND_ROWS()`.
*
* @return string
*/
protected function get_description() {
$orders = $this->get_orders();
$count = wp_cache_get( sprintf( '%s-total-results', $this->id ), 'llms_tool_data' );
$desc = __( 'Check active recurring orders to ensure their recurring payment action is properly scheduled for the next payment. If a recurring payment is due and not scheduled it will be rescheduled.', 'lifterlms' );
$desc .= ' ';
// Translators: %d = the number of pending batches.
$desc .= sprintf(
_n(
'There is %d order that will be checked.',
'There are %d orders that will be checked in batches of 50.',
$count,
'lifterlms'
),
$count
);
return $desc;
}
/**
* Retrieve the tool's label
*
* The label is the tool's title. It's displayed in the left column on the tool's list.
*
* @since 4.6.0
*
* @return string
*/
protected function get_label() {
return __( 'Reschedule Recurring Payments', 'lifterlms' );
}
/**
* Retrieve the tool's button text
*
* @since 4.6.0
*
* @return string
*/
protected function get_text() {
return __( 'Reschedule Payments', 'lifterlms' );
}
/**
* Retrieve a list of orders
*
* @since 4.6.0
*
* @return int[]
*/
protected function get_orders() {
$orders = wp_cache_get( $this->id, 'llms_tool_data' );
if ( ! $orders ) {
$orders = wp_list_pluck( $this->query_orders(), 'ID' );
wp_cache_set( $this->id, $orders, 'llms_tool_data' );
}
return $orders;
}
/**
* Schedules payments and expiration for an order
*
* Retrieves orders from the `get_orders()` method and schedules a recurring payment
* and expiration action based on its existing calculated order data.
*
* @since 4.6.0
* @since 4.7.0 Set `plan_ended` metadata for orders with an ended plan and don't attempt to process them.
*
* @return int[] Returns an array of WP_Post IDs for orders successfully rescheduled by the method.
*/
protected function handle() {
$orders = array();
foreach ( $this->get_orders() as $id ) {
$order = llms_get_post( $id );
$next = $order->get_next_payment_due_date();
if ( is_wp_error( $next ) && 'plan-ended' === $next->get_error_code() ) {
$order->set( 'plan_ended', 'yes' );
continue;
}
$order->maybe_schedule_payment( false );
$order->maybe_schedule_expiration();
if ( $order->get_next_scheduled_action_time( 'llms_charge_recurring_payment' ) ) {
$orders[] = $id;
}
}
wp_cache_delete( $this->id, 'llms_tool_data' );
wp_cache_delete( sprintf( '%s-total-results', $this->id ), 'llms_tool_data' );
return $orders;
}
/**
* Perform a DB query for orders to be handled by the tool
*
* @since 4.6.0
* @since 4.7.0 Added `SQL_CALC_FOUND_ROWS` and improved query to exclude results with a completed payment plan.
* @since 10.0.0 Replaced SQL_CALC_FOUND_ROWS with a separate COUNT(*) query.
*
* @return object[]
*/
protected function query_orders() {
global $wpdb;
$from_joins_where = "FROM {$wpdb->posts} AS p
LEFT JOIN {$wpdb->postmeta} AS m
ON p.ID = m.post_ID
AND m.meta_key = '_llms_plan_ended'
LEFT JOIN {$wpdb->prefix}actionscheduler_actions AS a
ON a.args = CONCAT( '{\"order_id\":', p.ID, '}' )
AND a.hook = 'llms_charge_recurring_payment'
AND a.status = 'pending'
WHERE 1
AND p.post_type = 'llms_order'
AND p.post_status = 'llms-active'
AND a.action_id IS NULL
AND m.meta_value IS NULL";
$total = $wpdb->get_var( "SELECT COUNT(*) {$from_joins_where}" ); // no-cache ok.
wp_cache_set( sprintf( '%s-total-results', $this->id ), $total, 'llms_tool_data' );
$orders = $wpdb->get_results(
"SELECT p.ID
{$from_joins_where}
ORDER BY p.ID ASC
LIMIT 50
;"
); // no-cache ok -- Caching implemented in `get_orders()`.
return $orders;
}
/**
* Conditionally load the tool
*
* This tool should only load if there are orders that can be handled by the tool.
*
* @since 4.6.0
*
* @return boolean Return `true` to load the tool and `false` to not load it.
*/
protected function should_load() {
return count( $this->get_orders() ) > 0;
}
}
return new LLMS_Admin_Tool_Recurring_Payment_Rescheduler();
================================================
FILE: includes/admin/tools/class-llms-admin-tool-reset-automatic-payments.php
================================================
<?php
/**
* Admin tool to reset the status of the recurring payments site feature
*
* @package LifterLMS/Admin/Tools/Classes
*
* @since 4.13.0
* @version 4.13.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Admin_Tool_Reset_Automatic_Payments
*
* @since 4.13.0
*/
class LLMS_Admin_Tool_Reset_Automatic_Payments extends LLMS_Abstract_Admin_Tool {
/**
* Tool ID.
*
* @var string
*/
protected $id = 'automatic-payments';
/**
* Tool Load Priority
*
* To preserve the "original" tool order, load this before unclassed core tools.
*
* @var integer
*/
protected $priority = 4;
/**
* Retrieve a description of the tool
*
* This is displayed on the right side of the tool's list before the button.
*
* @since 4.13.0
*
* @return string
*/
protected function get_description() {
return __( 'Allows you to choose to enable or disable automatic recurring payments which may be disabled on a staging site.', 'lifterlms' );
}
/**
* Retrieve the tool's label
*
* The label is the tool's title. It's displayed in the left column on the tool's list.
*
* @since 4.13.0
*
* @return string
*/
protected function get_label() {
return __( 'Reset Automatic Payments Status', 'lifterlms' );
}
/**
* Retrieve the tool's button text
*
* @since 4.13.0
*
* @return string
*/
protected function get_text() {
return __( 'Reset Automatic Payments Status', 'lifterlms' );
}
/**
* Process the tool.
*
* This method should do whatever the tool actually does.
*
* By the time this tool is called a nonce and the user's capabilities have already been checked.
*
* @since 4.13.0
*
* @return void
*/
protected function handle() {
LLMS_Site::clear_lock_url();
update_option( 'llms_site_url_ignore', 'no' );
LLMS_Site::check_status();
llms_redirect_and_exit( esc_url_raw( admin_url( 'admin.php?page=llms-status&tab=tools' ) ) );
}
/**
* Conditionally load the tool
*
* This tool should only load if the recurring payments site feature constant and the site clone status
* constant are both NOT set.
*
* @since 4.13.0
*
* @return boolean Return `true` to load the tool and `false` to not load it.
*/
protected function should_load() {
return ! defined( 'LLMS_SITE_FEATURE_RECURRING_PAYMENTS' ) && ! defined( 'LLMS_SITE_IS_CLONE' );
}
}
return new LLMS_Admin_Tool_Reset_Automatic_Payments();
================================================
FILE: includes/admin/tools/class-llms-admin-tool-wipe-legacy-account-options.php
================================================
<?php
/**
* LLMS_Admin_Tool_Wipe_Legacy_Account_Options
*
* @package LifterLMS/Admin/Tools/Classes
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Admin tool to wipe legacy account options
*
* @since 5.0.0
*/
class LLMS_Admin_Tool_Wipe_Legacy_Account_Options extends LLMS_Abstract_Admin_Tool {
/**
* Tool ID
*
* @var string
*/
protected $id = 'wipe-legacy-account-options';
/**
* Skip cache when checking if should load
*
* @var boolean
*/
private $skip_cache = false;
/**
* Retrieve a description of the tool
*
* This is displayed on the right side of the tool's list before the button.
*
* @since 5.0.0
*
* @return string
*/
protected function get_description() {
return __( 'Removes all options used to control the visibility of user information fields prior to version 5.0. Since version 5.0 these options are only used when restoring forms to their original default values.', 'lifterlms' );
}
/**
* Retrieve the tool's label
*
* The label is the tool's title. It's displayed in the left column on the tool's list.
*
* @since 5.0.0
*
* @return string
*/
protected function get_label() {
return __( 'Delete Legacy User Information Options', 'lifterlms' );
}
/**
* Retrieve the tool's button text
*
* @since 5.0.0
*
* @return string
*/
protected function get_text() {
return __( 'Delete Legacy Options', 'lifterlms' );
}
/**
* Process the tool.
*
* Deletes all core reusable blocks and then recreates the core forms,
* which additionally recreates the core reusable blocks.
*
* @since 5.0.0
*
* @return boolean
*/
protected function handle() {
$options_to_wipe = array(
'lifterlms_registration_generate_username',
'lifterlms_registration_password_strength',
'lifterlms_registration_password_min_strength',
'lifterlms_user_info_field_names_checkout_visibility',
'lifterlms_user_info_field_address_checkout_visibility',
'lifterlms_user_info_field_phone_checkout_visibility',
'lifterlms_user_info_field_email_confirmation_checkout_visibility',
'lifterlms_user_info_field_names_registration_visibility',
'lifterlms_user_info_field_address_registration_visibility',
'lifterlms_user_info_field_phone_registration_visibility',
'lifterlms_user_info_field_email_confirmation_registration_visibility',
'lifterlms_voucher_field_registration_visibility',
'lifterlms_user_info_field_names_account_visibility',
'lifterlms_user_info_field_address_account_visibility',
'lifterlms_user_info_field_phone_account_visibility',
'lifterlms_user_info_field_email_confirmation_account_visibility',
);
global $wpdb;
$sql = "
DELETE FROM {$wpdb->options}
WHERE option_name IN (" . implode( ', ', array_fill( 0, count( $options_to_wipe ), '%s' ) ) . ')';
$wpdb->query(
$wpdb->prepare(
$sql, // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
$options_to_wipe
)
); // db call ok; no-cache ok.
$this->skip_cache = true;
return true;
}
/**
* Conditionally load the tool
*
* This tool should only load if there are legacy options (we only check 'lifterlms_registration_generate_username').
*
* @since 5.0.0
*
* @return boolean Return `true` to load the tool and `false` to not load it.
*/
protected function should_load() {
if ( $this->skip_cache ) {
global $wpdb;
return ! empty(
$wpdb->get_var(
"SELECT COUNT(*) FROM {$wpdb->options}
WHERE option_name='lifterlms_registration_generate_username'"
)
); // no-cache ok.
}
return ( 'not-set' !== get_option( 'lifterlms_registration_generate_username', 'not-set' ) );
}
}
return new LLMS_Admin_Tool_Wipe_Legacy_Account_Options();
================================================
FILE: includes/admin/tools/index.php
================================================
<?php // Quiet.
================================================
FILE: includes/admin/views/access-plans/access-plan-dialog.php
================================================
<div
id="llms-access-plan-dialog"
class="llms-dialog-container"
aria-labelledby="llms-access-plan-dialog-title"
aria-hidden="true"
>
<!-- 2. The dialog overlay -->
<div class="llms-dialog-overlay" data-a11y-dialog-hide></div>
<!-- 3. The actual dialog -->
<div class="llms-dialog-content" role="document">
<button class="llms-dialog-close" type="button" data-a11y-dialog-hide aria-label="<?php echo esc_html( __( 'Close', 'lifterlms' ) ); ?>">
×
</button>
<h1 id="llms-access-plan-dialog-title"><?php echo esc_html( __( 'What type of Access Plan do you want to create?', 'lifterlms' ) ); ?></h1>
<div class="llms-access-plan-templates">
<button class="template" data-template="free">
<strong><?php echo esc_html( __( 'Free', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Free access that never expires.', 'lifterlms' ) ); ?></span>
</button>
<button class="template" data-template="monthly">
<strong><?php echo esc_html( __( 'Monthly', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Charge a recurring monthly subscription that never ends.', 'lifterlms' ) ); ?></span>
</button>
<button class="template" data-template="annual">
<strong><?php echo esc_html( __( 'Annual', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Charge a recurring annual subscription that never ends.', 'lifterlms' ) ); ?></span>
</button>
<button class="template" data-template="one-time">
<strong><?php echo esc_html( __( 'One Time', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Charge a one-time payment for a fixed period.', 'lifterlms' ) ); ?></span>
</button>
<button class="template" data-template="lifetime">
<strong><?php echo esc_html( __( 'Lifetime', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Charge a one-time payment that never expires.', 'lifterlms' ) ); ?></span>
</button>
<button class="template" data-template="paid-trial">
<strong><?php echo esc_html( __( 'Paid Trial', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Charge a fee for trial access and capture recurring payment info with a future monthly subscription that will start in 1 week.', 'lifterlms' ) ); ?></span>
</button>
<button class="template" data-template="hidden-access">
<strong><?php echo esc_html( __( 'Hidden Access', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Grant free access without making this plan publicly available.', 'lifterlms' ) ); ?></span>
</button>
<button class="template" data-template="sale">
<strong><?php echo esc_html( __( 'Sale', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Discount a one-time payment for lifetime access.', 'lifterlms' ) ); ?></span>
</button>
<button class="template" data-template="presell">
<strong><?php echo esc_html( __( 'Pre-sale', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Offer lifetime access for a one-time payment with a future start date.', 'lifterlms' ) ); ?></span>
</button>
<?php
/**
* Action hook fired after access plan's dialog box pre-sale option.
*
* @since 8.0.0
*/
do_action( 'llms_access_plan_dialog_after_pre_sale' );
?>
<?php if ( apply_filters( 'llms_access_plan_dialog_show_gifts_addon_option', true ) ) : ?>
<a target="_blank" href="https://lifterlms.com/product/lifterlms-gifts/?utm_source=LifterLMS%20Plugin&utm_medium=Access%20Plans&utm_campaign=Plugin%20to%20Sale">
<span class="add-on"><?php echo esc_html( __( 'Add-on', 'lifterlms' ) ); ?></span>
<strong><?php echo esc_html( __( 'Gift Purchases', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Allow a buyer to purchase a voucher to gift access to someone else.', 'lifterlms' ) ); ?></span>
</a>
<?php endif; ?>
<?php if ( apply_filters( 'llms_access_plan_dialog_show_group_addon_option', true ) ) : ?>
<a target="_blank" href="https://lifterlms.com/product/groups/?utm_source=LifterLMS%20Plugin&utm_medium=Access%20Plans&utm_campaign=Plugin%20to%20Sale">
<span class="add-on"><?php echo esc_html( __( 'Add-on', 'lifterlms' ) ); ?></span>
<strong><?php echo esc_html( __( 'Group Access', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Allow a buyer to purchase lifetime access for a group of people.', 'lifterlms' ) ); ?></span>
</a>
<?php endif; ?>
<button class="template" data-template="advanced">
<strong><?php echo esc_html( __( 'Advanced', 'lifterlms' ) ); ?></strong>
<span><?php echo esc_html( __( 'Show all settings to create an access plan from scratch.', 'lifterlms' ) ); ?></span>
</button>
</div>
</div>
</div>
================================================
FILE: includes/admin/views/access-plans/access-plan.php
================================================
<?php
/**
* Individual Access Plan as displayed within the "Product Options" metabox.
*
* @package LifterLMS/Admin/Views
*
* @since 3.0.0
* @since 3.30.0 Added checkout redirect settings.
* @since 3.31.0 Change sale_price input from text to number to ensure min value validation is properly enforced by browsers.
* @since 3.37.18 Don't localize the price "step" html attribute.
* @since 4.14.0 Get the access plan's raw content to display it in the wp_editor.
* @since 7.3.0 Added another icon for possible issues with the access plan configuration.
* @version 7.3.0
*
* @var LLMS_Course $course LLMS_Course.
* @var array $checkout_redirection_types Checkout redirect setting options.
* @var LLMS_Access_Plan $plan LLMS_Access_Plan.
*/
defined( 'ABSPATH' ) || exit;
// Create a "step" attribute for price fields according to LLMS settings.
$price_step = number_format( 0.01, get_lifterlms_decimals() );
if ( ! isset( $plan ) ) {
$id = 'llms-new-access-plan-model';
$plan = false;
$order = 777;
} else {
$id = 'llms-access-plan-' . $plan->get( 'id' );
$order = $plan->get( 'menu_order' );
$visibility = $plan->get_visibility();
$frequency = $plan->get( 'frequency' );
$period = $plan->get( 'period' );
$access_expiration = $plan->get( 'access_expiration' );
$access_period = $plan->get( 'access_period' );
$trial_offer = $plan->get( 'trial_offer' );
$on_sale = $plan->get( 'on_sale' );
$availability = $plan->get( 'availability' );
$checkout_redirect_url = $plan->get( 'checkout_redirect_url' );
$checkout_url = apply_filters( 'llms_admin_plan_display_checkout_url', $plan->get_checkout_url( false ), $plan );
if ( $checkout_url && false === strpos( $checkout_url, home_url() ) ) {
$checkout_url = home_url( $checkout_url );
}
}
?>
<div class="llms-metabox-section d-all llms-collapsible llms-access-plan" id="<?php echo esc_attr( $id ); ?>"<?php echo $plan ? 'data-id="' . esc_attr( $plan->get( 'id' ) ) . '"' : ''; ?>>
<header class="llms-collapsible-header">
<div class="d-2of3">
<span class="fa fa-bars llms-drag-handle"></span>
<h3>
<?php if ( $plan ) : ?>
<span class="llms-plan-title" data-default="<?php esc_attr_e( 'Unnamed Access Plan', 'lifterlms' ); ?>"><?php echo esc_html( $plan->get( 'title' ) ); ?></span>
<small>(<?php printf( esc_html_x( 'ID# %s', 'Product Access Plan ID', 'lifterlms' ), esc_html( $plan->get( 'id' ) ) ); ?>)</small>
<?php else : ?>
<span class="llms-plan-title" data-default="<?php esc_attr_e( 'New Access Plan', 'lifterlms' ); ?>"><?php esc_html_e( 'New Access Plan', 'lifterlms' ); ?></span>
<?php endif; ?>
</h3>
</div>
<div class="d-1of3 d-right">
<span class="tip--top-left" data-tip="<?php esc_attr_e( 'This access plan requires attention for possible misconfigurations', 'lifterlms' ); ?>">
<span class="dashicons dashicons-warning medium-danger"></span>
</span>
<span class="tip--top-left" data-tip="<?php esc_attr_e( 'Errors were found during access plan validation', 'lifterlms' ); ?>">
<span class="dashicons dashicons-warning"></span>
</span>
<?php if ( $plan ) : ?>
<a target="_blank" href="<?php echo esc_url( $checkout_url ); ?>"><span class="dashicons dashicons-admin-links llms-plan-purchase-link"></span></a>
<?php endif; ?>
<span class="dashicons dashicons-trash llms-plan-delete"></span>
<span class="dashicons dashicons-arrow-down"></span>
<span class="dashicons dashicons-arrow-up"></span>
</div>
</header>
<section class="llms-collapsible-body">
<?php
/**
* Action hook fired before access plan's meta box row two
*
* @since Unknown
*
* @param LLMS_Access_Plan $plan LLMS_Access_Plan.
* @param integer $id Access Plan ID.
* @param integer $order The order of the access plan.
*/
do_action( 'llms_access_plan_mb_before_body', $plan, $id, $order );
?>
<h4><?php esc_html_e( 'General Plan Information', 'lifterlms' ); ?></h4>
<?php
if ( $plan && ! $checkout_url ) :
?>
<div>
<div class="d-all">
<div class="notice notice-error inline llms-admin-notice llms-notice">
<div class="llms-admin-notice-content">
<?php
echo wp_kses_post(
sprintf(
/* translators: %1$s - Open anchor tag to the checkout settings page, %2$s - Closing of anchor tag. */
__( 'Your site does not have a checkout page configured. Configure a Checkout Page in the %1$sCheckout Settings%2$s.', 'lifterlms' ),
'<a href="' . esc_url( admin_url( 'admin.php?page=llms-settings&tab=checkout' ) ) . '">',
'</a>'
)
);
?>
</div>
</div>
</div>
</div>
<?php endif; ?>
<?php if ( $plan && $checkout_url ) : ?>
<p class="llms-plan-link"><?php printf( esc_html__( 'Direct to Checkout Purchase Link: %s', 'lifterlms' ), '<code>' . esc_url( $checkout_url ) . '</code>' ); ?></p>
<?php endif; ?>
<div class="llms-plan-row-1">
<div class="llms-metabox-field d-1of2">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][title]">
<?php esc_html_e( 'Plan Title', 'lifterlms' ); ?>
<span class="llms-required">*<span class="screen-reader-text"> <?php esc_html_e( 'required', 'lifterlms' ); ?></span></span>
<span class="screen-reader-text"><?php esc_html_e( 'The title of the access plan, displayed to users at the top of the plan.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'The title of the access plan, displayed to users at the top of the plan.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][title]" class="llms-plan-title" name="_llms_plans[<?php echo esc_attr( $order ); ?>][title]" required="required" type="text"<?php echo ( $plan ? ' value="' . esc_attr( $plan->get( 'title' ) ) . '"' : ' disabled="disabled"' ); ?>>
</div>
<div class="llms-metabox-field d-1of4">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][enroll_text]">
<?php esc_html_e( 'Enroll Button Text', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'The text displayed on the enrollment button for this access plan.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'The text displayed on the enrollment button for this access plan.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][enroll_text]" name="_llms_plans[<?php echo esc_attr( $order ); ?>][enroll_text]" type="text"<?php echo ( $plan ) ? ' value="' . esc_attr( $plan->get( 'enroll_text' ) ) . '"' : ' value="' . esc_attr__( 'Enroll Now', 'lifterlms' ) . '" disabled="disabled"'; ?>>
</div>
<div class="llms-metabox-field d-1of4">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][visibility]">
<?php esc_html_e( 'Visibility', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Set whether this access plan is visible, hidden, or featured in the pricing table.', 'lifterlms' ); ?></span>
<span class="tip--top-left" data-tip="<?php esc_attr_e( 'Set whether this access plan is visible, hidden, or featured in the pricing table.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][visibility]" name="_llms_plans[<?php echo esc_attr( $order ); ?>][visibility]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<?php foreach ( llms_get_access_plan_visibility_options() as $val => $name ) : ?>
<option value="<?php echo esc_attr( $val ); ?>"<?php selected( $val, ( $plan ) ? $visibility : null ); ?>><?php echo esc_attr( $name ); ?></option>
<?php endforeach; ?>
</select>
</div>
<div class="clear"></div>
</div>
<?php
/**
* Action hook fired after access plan's meta box row two
*
* @since Unknown
*
* @param LLMS_Access_Plan $plan LLMS_Access_Plan.
* @param integer $id Access Plan ID.
* @param integer $order The order of the access plan.
*/
do_action( 'llms_access_plan_mb_after_row_one', $plan, $id, $order );
?>
<div class="llms-plan-row-2">
<div class="llms-metabox-field d-all">
<label for="_llms_plans_content_<?php echo esc_attr( $id ); ?>">
<?php esc_html_e( 'Plan Description', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Description text of the access plan shown on the pricing table. Bullet points of top plan benefits are often used here. ', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Description text of the access plan shown on the pricing table. Bullet points of top plan benefits are often used here. ', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<?php
wp_editor(
htmlspecialchars_decode( $plan ? $plan->get( 'content', true ) : '' ),
'_llms_plans_content_' . $id,
/**
* Filters the access plan editor settings
*
* @since Unknown
*
* @param array $settings See _WP_Editors::parse_settings() for description.
*/
apply_filters(
'llms_access_plan_editor_settings',
array(
'drag_drop_upload' => true,
'editor_height' => 60,
'media_buttons' => false,
'teeny' => true,
'textarea_name' => '_llms_plans[' . $order . '][content]',
'quicktags' => array(
'buttons' => 'strong,em,del,ul,ol,li,close',
),
)
)
);
?>
</div>
<div class="clear"></div>
</div>
<?php
/**
* Action hook fired after access plan's meta box row two
*
* @since Unknown
*
* @param LLMS_Access_Plan $plan LLMS_Access_Plan.
* @param integer $id Access Plan ID.
* @param integer $order The order of the access plan.
*/
do_action( 'llms_access_plan_mb_after_row_two', $plan, $id, $order );
?>
<h4><?php esc_html_e( 'Plan Pricing', 'lifterlms' ); ?></h4>
<div class="llms-plan-row-3">
<div class="llms-metabox-field d-1of4">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][is_free]">
<?php esc_html_e( 'Plan Type', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Specify if the plan is free or paid.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Specify if the plan is free or paid.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][is_free]" data-controller-id="llms-is-free" name="_llms_plans[<?php echo esc_attr( $order ); ?>][is_free]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="no"<?php selected( 'no', $plan ? $plan->get( 'is_free' ) : true ); ?>><?php esc_html_e( 'Paid', 'lifterlms' ); ?></option>
<option value="yes"<?php selected( 'yes', $plan ? $plan->get( 'is_free' ) : '' ); ?>><?php esc_html_e( 'Free', 'lifterlms' ); ?></option>
</select>
</div>
<div data-controller="llms-is-free" data-value-is="no">
<div class="llms-metabox-field d-1of6">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][price]">
<?php esc_html_e( 'Price', 'lifterlms' ); ?>
<span class="llms-required">*<span class="screen-reader-text"><?php esc_html_e( 'required', 'lifterlms' ); ?></span></span>
<span class="screen-reader-text"><?php esc_html_e( 'Set the pricing for this access plan.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Set the pricing for this access plan.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input
id="_llms_plans[<?php echo esc_attr( $order ); ?>][price]"
class="llms-plan-price" name="_llms_plans[<?php echo esc_attr( $order ); ?>][price]"
placeholder="<?php echo esc_attr( wp_strip_all_tags( llms_price( 1000 ) ) ); ?>"
<?php if ( apply_filters( 'llms_access_plan_price_required', true, $plan ) ) : ?>
min="<?php echo esc_attr( $price_step ); ?>"
required="required"
<?php endif; ?>
step="<?php echo esc_attr( $price_step ); ?>"
type="number"<?php echo ( $plan ? ' value="' . esc_attr( $plan->get( 'price' ) ) . '"' : ' disabled="disabled"' ); ?>
>
</div>
<div class="llms-metabox-field d-1of4">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][frequency]">
<?php esc_html_e( 'Frequency', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Choose how often the payment is charged: one-time or recurring.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Choose how often the payment is charged: one-time or recurring.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][frequency]" data-controller-id="llms-plan-frequency" name="_llms_plans[<?php echo esc_attr( $order ); ?>][frequency]"<?php echo ( $plan ? '' : ' disabled="disabled"' ); ?>>
<option value="0"<?php selected( '0', ( $plan ) ? $frequency : null ); ?>><?php esc_html_e( 'one-time payment', 'lifterlms' ); ?></option>
<option value="1"<?php selected( '1', ( $plan ) ? $frequency : null ); ?>><?php esc_html_e( 'every', 'lifterlms' ); ?></option>
<option value="2"<?php selected( '2', ( $plan ) ? $frequency : null ); ?>><?php esc_html_e( 'every 2nd', 'lifterlms' ); ?></option>
<option value="3"<?php selected( '3', ( $plan ) ? $frequency : null ); ?>><?php esc_html_e( 'every 3rd', 'lifterlms' ); ?></option>
<option value="4"<?php selected( '4', ( $plan ) ? $frequency : null ); ?>><?php esc_html_e( 'every 4th', 'lifterlms' ); ?></option>
<option value="5"<?php selected( '5', ( $plan ) ? $frequency : null ); ?>><?php esc_html_e( 'every 5th', 'lifterlms' ); ?></option>
<option value="6"<?php selected( '6', ( $plan ) ? $frequency : null ); ?>><?php esc_html_e( 'every 6th', 'lifterlms' ); ?></option>
</select>
</div>
<?php // Recurring plan options. ?>
<div data-controller="llms-plan-frequency" data-value-is-not="0">
<div class="llms-metabox-field d-1of6">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][period]">
<?php esc_html_e( 'Plan Period', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Define the billing cycle period for the recurring plan.', 'lifterlms' ); ?></span>
<span class="tip--top-left" data-tip="<?php esc_attr_e( 'Define the billing cycle period for the recurring plan.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][period]" data-controller-id="llms-plan-period" name="_llms_plans[<?php echo esc_attr( $order ); ?>][period]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="year"<?php selected( 'year', ( $plan && 0 != $frequency ) ? $period : null ); ?>><?php esc_html_e( 'year', 'lifterlms' ); ?></option>
<option value="month"<?php selected( 'month', ( $plan && 0 != $frequency ) ? $period : null ); ?>><?php esc_html_e( 'month', 'lifterlms' ); ?></option>
<option value="week"<?php selected( 'week', ( $plan && 0 != $frequency ) ? $period : null ); ?>><?php esc_html_e( 'week', 'lifterlms' ); ?></option>
<option value="day"<?php selected( 'day', ( $plan && 0 != $frequency ) ? $period : null ); ?>><?php esc_html_e( 'day', 'lifterlms' ); ?></option>
</select>
</div>
<div class="llms-metabox-field d-1of6">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][length]">
<?php esc_html_e( 'Plan Length', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Specify the duration of the plan period.', 'lifterlms' ); ?></span>
<span class="tip--top-left" data-tip="<?php esc_attr_e( 'Specify the duration of the plan period.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][length]" data-controller="llms-plan-period" data-value-is="year" name="_llms_plans[<?php echo esc_attr( $order ); ?>][length]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="0"<?php selected( 0, ( $plan && 'year' === $period ) ? $plan->get( 'length' ) : '' ); ?>><?php esc_html_e( 'for all time', 'lifterlms' ); ?></option>
<?php $i = 1; while ( $i <= 6 ) : ?>
<option value="<?php echo esc_attr( $i ); ?>"<?php selected( $i, ( $plan && 'year' === $period ) ? $plan->get( 'length' ) : '' ); ?>><?php printf( esc_html( _n( 'for %s year', 'for %s years', $i, 'lifterlms' ) ), esc_html( $i ) ); ?></option>
<?php
++$i;
endwhile;
?>
</select>
<select data-controller="llms-plan-period" data-value-is="month" name="_llms_plans[<?php echo esc_attr( $order ); ?>][length]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="0"<?php selected( 0, ( $plan && 'month' === $period ) ? $plan->get( 'length' ) : '' ); ?>><?php esc_html_e( 'for all time', 'lifterlms' ); ?></option>
<?php $i = 1; while ( $i <= 24 ) : ?>
<option value="<?php echo esc_attr( $i ); ?>"<?php selected( $i, ( $plan && 'month' === $period ) ? $plan->get( 'length' ) : '' ); ?>><?php printf( esc_html( _n( 'for %s month', 'for %s months', $i, 'lifterlms' ) ), esc_html( $i ) ); ?></option>
<?php
++$i;
endwhile;
?>
</select>
<select data-controller="llms-plan-period" data-value-is="week" name="_llms_plans[<?php echo esc_attr( $order ); ?>][length]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="0"<?php selected( 0, ( $plan && 'week' === $period ) ? $plan->get( 'length' ) : '' ); ?>><?php esc_html_e( 'for all time', 'lifterlms' ); ?></option>
<?php $i = 1; while ( $i <= 52 ) : ?>
<option value="<?php echo esc_attr( $i ); ?>"<?php selected( $i, ( $plan && 'week' === $period ) ? $plan->get( 'length' ) : '' ); ?>><?php printf( esc_html( _n( 'for %s week', 'for %s weeks', $i, 'lifterlms' ) ), esc_html( $i ) ); ?></option>
<?php
++$i;
endwhile;
?>
</select>
<select data-controller="llms-plan-period" data-value-is="day" name="_llms_plans[<?php echo esc_attr( $order ); ?>][length]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="0"<?php selected( 0, ( $plan && 'day' === $period ) ? $plan->get( 'length' ) : '' ); ?>><?php esc_html_e( 'for all time', 'lifterlms' ); ?></option>
<?php $i = 1; while ( $i <= 90 ) : ?>
<option value="<?php echo esc_attr( $i ); ?>"<?php selected( $i, ( $plan && 'day' === $period ) ? $plan->get( 'length' ) : '' ); ?>><?php printf( esc_html( _n( 'for %s day', 'for %s days', $i, 'lifterlms' ) ), esc_html( $i ) ); ?></option>
<?php
++$i;
endwhile;
?>
</select>
</div>
</div>
</div>
<?php
// If only the manual gateway is enabled, show a notice and link to our Ecommerce Add-ons.
$active_gateways = llms()->payment_gateways()->get_enabled_payment_gateways();
if ( 1 === count( $active_gateways ) && array_key_exists( 'manual', $active_gateways ) ) :
?>
<div data-controller="llms-is-free" data-value-is="no">
<div class="d-all">
<div class="notice notice-warning inline llms-admin-notice llms-payment-gateway-warning">
<div class="llms-admin-notice-content">
<?php
$allowed_ecommerce_add_ons_html = array(
'a' => array(
'href' => array(),
'target' => array(),
'title' => array(),
'rel' => array(),
),
'em' => array(),
);
printf(
wp_kses(
/* translators: %s: URL to the LifterLMS Ecommerce Add-ons page */
__( 'Your site is not set up to process payments. Check out the <a href="%s" target="_blank">Ecommerce Add-ons for LifterLMS</a> to enable live payments via credit card, PayPal, and more.', 'lifterlms' ),
$allowed_ecommerce_add_ons_html
),
'https://lifterlms.com/product-category/e-commerce/?utm_source=LifterLMS%20Plugin&utm_medium=Access%20Plans&utm_campaign=Plugin%20to%20Sale'
);
?>
<a href="
<?php
echo esc_url(
add_query_arg(
array(
'page' => 'llms-settings',
'tab' => 'checkout',
),
admin_url( 'admin.php' )
)
);
?>
"><?php esc_html_e( 'View Payment Gateway Settings', 'lifterlms' ); ?>
</a>
</div>
</div>
</div>
</div>
<?php
endif;
?>
<div class="clear"></div>
</div>
<?php
/**
* Action hook fired after access plan's meta box row three
*
* @since Unknown
*
* @param LLMS_Access_Plan $plan LLMS_Access_Plan.
* @param integer $id Access Plan ID.
* @param integer $order The order of the access plan.
*/
do_action( 'llms_access_plan_mb_after_row_three', $plan, $id, $order );
?>
<div class="llms-plan-row-4" data-controller="llms-plan-frequency" data-value-is-not="0">
<div class="llms-metabox-field d-1of4">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_offer]">
<?php esc_html_e( 'Trial Offer', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Enable or disable a free or paid trial period for this plan.', 'lifterlms' ); ?></span>
<span class="tip--top-left" data-tip="<?php esc_attr_e( 'Enable or disable a free or paid trial period for this plan.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_offer]" data-controller-id="llms-trial-offer" name="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_offer]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="no"<?php selected( 'no', $plan ? $trial_offer : '' ); ?>><?php esc_html_e( 'No trial offer', 'lifterlms' ); ?></option>
<option value="yes"<?php selected( 'yes', $plan ? $trial_offer : '' ); ?>><?php esc_html_e( 'Enable trial', 'lifterlms' ); ?></option>
</select>
</div>
<div class="llms-metabox-field d-1of6" data-controller="llms-trial-offer" data-value-is="yes">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_price]">
<?php esc_html_e( 'Trial Price', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Set the price for the trial period of this plan.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Set the price for the trial period of this plan.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_price]" name="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_price]" min="0" placeholder="<?php echo esc_attr( wp_strip_all_tags( llms_price( 1000 ) ) ); ?>" required="required" step="<?php echo esc_attr( $price_step ); ?>" type="text"<?php echo ( $plan ) ? ' value="' . esc_attr( $plan->get( 'trial_price' ) ) . '"' : ' disabled="disabled"'; ?>>
</div>
<div class="llms-metabox-field d-1of4" data-controller="llms-trial-offer" data-value-is="yes">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_length]">
<?php esc_html_e( 'Trial Length', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Specify the length of the trial period.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Specify the length of the trial period.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_length]" name="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_length]" min="1" placeholder="1" required="required" type="text"<?php echo ( $plan ) ? ' value="' . esc_attr( $plan->get( 'trial_length' ) ) . '"' : ' value="1" disabled="disabled"'; ?>>
</div>
<div class="llms-metabox-field d-1of4" data-controller="llms-trial-offer" data-value-is="yes">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_period]">
<?php esc_html_e( 'Trial Period', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Define the time length for the trial period (days, weeks, months, years).', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Define the time length for the trial period (days, weeks, months, years).', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_period]" name="_llms_plans[<?php echo esc_attr( $order ); ?>][trial_period]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="year"<?php selected( 'year', ( $plan && 'yes' === $trial_offer ) ? $plan->get( 'trial_period' ) : '' ); ?>><?php esc_html_e( 'year(s)', 'lifterlms' ); ?></option>
<option value="month"<?php selected( 'month', ( $plan && 'yes' === $trial_offer ) ? $plan->get( 'trial_period' ) : '' ); ?>><?php esc_html_e( 'month(s)', 'lifterlms' ); ?></option>
<option value="week"<?php selected( 'week', ( $plan && 'yes' === $trial_offer ) ? $plan->get( 'trial_period' ) : '' ); ?>><?php esc_html_e( 'week(s)', 'lifterlms' ); ?></option>
<option value="day"<?php selected( 'day', ( $plan && 'yes' === $trial_offer ) ? $plan->get( 'trial_period' ) : '' ); ?>><?php esc_html_e( 'day(s)', 'lifterlms' ); ?></option>
</select>
</div>
<div class="clear"></div>
</div>
<?php
/**
* Action hook fired after access plan's meta box row four
*
* @since Unknown
*
* @param LLMS_Access_Plan $plan LLMS_Access_Plan.
* @param integer $id Access Plan ID.
* @param integer $order The order of the access plan.
*/
do_action( 'llms_access_plan_mb_after_row_four', $plan, $id, $order );
?>
<div class="llms-plan-row-5" data-controller="llms-is-free" data-value-is="no">
<div class="llms-metabox-field d-1of4">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][on_sale]">
<?php esc_html_e( 'Sale Pricing', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Indicate if the plan has a sale.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Indicate if the plan has a sale.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][on_sale]" data-controller-id="llms-on-sale" name="_llms_plans[<?php echo esc_attr( $order ); ?>][on_sale]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="no"<?php selected( 'no', $plan ? $on_sale : '' ); ?>><?php esc_html_e( 'Not on sale', 'lifterlms' ); ?></option>
<option value="yes"<?php selected( 'yes', $plan ? $on_sale : '' ); ?>><?php esc_html_e( 'On Sale', 'lifterlms' ); ?></option>
</select>
</div>
<div class="llms-metabox-field d-1of6" data-controller="llms-on-sale" data-value-is="yes">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][sale_price]">
<?php esc_html_e( 'Sale Price', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Set the discounted price for the sale period.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Set the discounted price for the sale period.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][sale_price]" name="_llms_plans[<?php echo esc_attr( $order ); ?>][sale_price]" min="0" placeholder="<?php echo esc_attr( wp_strip_all_tags( llms_price( 1000 ) ) ); ?>" required="required" step="<?php echo esc_attr( $price_step ); ?>" type="number"<?php echo ( $plan && 'yes' === $on_sale ) ? ' value="' . esc_attr( $plan->get( 'sale_price' ) ) . '"' : ' disabled="disabled"'; ?>>
</div>
<div class="llms-metabox-field d-1of4" data-controller="llms-on-sale" data-value-is="yes">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][sale_start]">
<?php esc_html_e( 'Sale Start Date', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Specify when the sale period starts. ', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Specify when the sale period starts. ', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][sale_start]" class="llms-access-plan-datepicker" name="_llms_plans[<?php echo esc_attr( $order ); ?>][sale_start]" placeholder="MM/DD/YYYY" type="text"<?php echo ( $plan && 'yes' === $on_sale ) ? ' value="' . esc_attr( $plan->get_date( 'sale_start', 'm/d/Y' ) ) . '"' : ' disabled="disabled"'; ?>>
</div>
<div class="llms-metabox-field d-1of4" data-controller="llms-on-sale" data-value-is="yes">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][sale_end]">
<?php esc_html_e( 'Sale End Date', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Specify when the sale period ends.', 'lifterlms' ); ?></span>
<span class="tip--top-left" data-tip="<?php esc_attr_e( 'Specify when the sale period ends.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][sale_end]" class="llms-access-plan-datepicker" name="_llms_plans[<?php echo esc_attr( $order ); ?>][sale_end]" placeholder="MM/DD/YYYY" type="text"<?php echo ( $plan && 'yes' === $on_sale ) ? ' value="' . esc_attr( $plan->get_date( 'sale_end', 'm/d/Y' ) ) . '"' : ' disabled="disabled"'; ?>>
</div>
<div class="clear"></div>
</div>
<?php
/**
* Action hook fired after access plan's meta box row five
*
* @since Unknown
*
* @param LLMS_Access_Plan $plan LLMS_Access_Plan.
* @param integer $id Access Plan ID.
* @param integer $order The order of the access plan.
*/
do_action( 'llms_access_plan_mb_after_row_five', $plan, $id, $order );
?>
<?php
// Do we have any memberships to restrict this plan to?
$memberships_count = wp_count_posts( 'llms_membership' );
if ( $course && $memberships_count->publish > 0 ) :
/**
* Filter to show/hide the Membership Settings for an Access Plan for a course.
*
* @param boolean $show_membership_settings Show membership settings for access plans.
* @param LLMS_Access_Plan $plan LLMS_Access_Plan.
* @param integer $id Access Plan ID.
*/
if ( apply_filters( 'llms_show_membership_settings_for_access_plans', true, $plan, $id ) ) :
?>
<h4><?php esc_html_e( 'Membership Settings', 'lifterlms' ); ?></h4>
<div class="llms-plan-row-6">
<div class="llms-metabox-field d-1of3">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][availability]">
<?php esc_html_e( 'Plan Availability', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Choose who can purchase this plan: anyone or members only.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Choose who can purchase this plan: anyone or members only.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select data-controller-id="llms-availability" name="_llms_plans[<?php echo esc_attr( $order ); ?>][availability]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="open"<?php selected( 'open', $plan ? $availability : '' ); ?>><?php esc_html_e( 'Anyone', 'lifterlms' ); ?></option>
<option value="members"<?php selected( 'members', $plan ? $availability : '' ); ?>><?php esc_html_e( 'Members only', 'lifterlms' ); ?></option>
</select>
</div>
<div class="llms-metabox-field d-1of2" data-controller="llms-availability" data-value-is="members">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][availability_restrictions][]">
<?php esc_html_e( 'Memberships', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Select the memberships required to access this plan.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Select the memberships required to access this plan.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][availability_restrictions][]" class="llms-availability-restrictions" data-post-type="llms_membership" multiple="multiple" name="_llms_plans[<?php echo esc_attr( $order ); ?>][availability_restrictions][]" required="required" style="width:100%; height: 25px;" <?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<?php if ( $plan ) : ?>
<?php foreach ( $plan->get_array( 'availability_restrictions' ) as $membership_id ) : ?>
<option value="<?php echo esc_attr( $membership_id ); ?>" selected="selected"><?php echo esc_html( get_the_title( $membership_id ) ); ?> (<?php printf( esc_html__( 'ID# %d', 'lifterlms' ), esc_html( $membership_id ) ); ?>)</option>
<?php endforeach; ?>
<?php endif; ?>
</select>
</div>
<div class="clear"></div>
</div>
<?php
endif;
endif;
?>
<h4><?php esc_html_e( 'Expiration Settings', 'lifterlms' ); ?></h4>
<div class="llms-plan-row-6">
<div class="llms-metabox-field d-1of4">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][access_expiration]">
<?php esc_html_e( 'Access Expiration', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Define if and when the access to the plan expires.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Define if and when the access to the plan expires.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][access_expiration]" data-controller-id="llms-access-expiration" name="_llms_plans[<?php echo esc_attr( $order ); ?>][access_expiration]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="lifetime"<?php selected( 'lifetime', $plan ? $access_expiration : '' ); ?>><?php esc_html_e( 'Lifetime Access', 'lifterlms' ); ?></option>
<option value="limited-period"<?php selected( 'limited-period', $plan ? $access_expiration : '' ); ?>><?php esc_html_e( 'Expires after', 'lifterlms' ); ?></option>
<option value="limited-date"<?php selected( 'limited-date', $plan ? $access_expiration : '' ); ?>><?php esc_html_e( 'Expires on', 'lifterlms' ); ?></option>
</select>
</div>
<div class="llms-metabox-field d-1of6" data-controller="llms-access-expiration" data-value-is="limited-date">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][access_expires]">
<?php esc_html_e( 'Expiration Date', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Specify the exact date when the access from this plan expires.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Specify the exact date when the access from this plan expires.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][access_expires]" class="llms-access-plan-datepicker" name="_llms_plans[<?php echo esc_attr( $order ); ?>][access_expires]" placeholder="MM/DD/YYYY" required="required" type="text"<?php echo ( $plan && 'limited-date' === $access_expiration ) ? ' value="' . esc_attr( $plan->get_date( 'access_expires', 'm/d/Y' ) ) . '"' : ' value="' . esc_attr( date_i18n( 'm/d/y', current_time( 'timestamp' ) ) ) . '" disabled="disabled"'; ?>>
</div>
<div class="llms-metabox-field d-1of6" data-controller="llms-access-expiration" data-value-is="limited-period">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][access_length]">
<?php esc_html_e( 'Access Length', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Set the length of the access period for limited-duration plans.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Set the length of the access period for limited-duration plans.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][access_length]" name="_llms_plans[<?php echo esc_attr( $order ); ?>][access_length]" min="1" placeholder="1" required="required" type="number"<?php echo ( $plan ) ? ' value="' . esc_attr( $plan->get( 'access_length' ) ) . '"' : ' value="1" disabled="disabled"'; ?>>
</div>
<div class="llms-metabox-field d-1of4" data-controller="llms-access-expiration" data-value-is="limited-period">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][access_period]">
<?php esc_html_e( 'Access Period', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Define the time unit for the access period (days, weeks, months, years).', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Define the time unit for the access period (days, weeks, months, years).', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][access_period]" name="_llms_plans[<?php echo esc_attr( $order ); ?>][access_period]"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<option value="year"<?php selected( 'year', ( $plan && 'limited-period' === $access_expiration ) ? $access_period : '' ); ?>><?php esc_html_e( 'year(s)', 'lifterlms' ); ?></option>
<option value="month"<?php selected( 'month', ( $plan && 'limited-period' === $access_expiration ) ? $access_period : '' ); ?>><?php esc_html_e( 'month(s)', 'lifterlms' ); ?></option>
<option value="week"<?php selected( 'week', ( $plan && 'limited-period' === $access_expiration ) ? $access_period : '' ); ?>><?php esc_html_e( 'week(s)', 'lifterlms' ); ?></option>
<option value="day"<?php selected( 'day', ( $plan && 'limited-period' === $access_expiration ) ? $access_period : '' ); ?>><?php esc_html_e( 'day(s)', 'lifterlms' ); ?></option>
</select>
</div>
<div class="clear"></div>
</div>
<?php
/**
* Action hook fired after access plan's meta box row six
*
* @since Unknown
*
* @param LLMS_Access_Plan $plan LLMS_Access_Plan.
* @param integer $id Access Plan ID.
* @param integer $order The order of the access plan.
*/
do_action( 'llms_access_plan_mb_after_row_six', $plan, $id, $order );
?>
<h4 class="llms-redirection-settings"><?php esc_html_e( 'Redirection Settings', 'lifterlms' ); ?></h4>
<div class="llms-plan-row-7 llms-redirection-settings">
<div class="llms-metabox-field d-all" data-controller="llms-availability" data-value-is="members">
<label>
<?php esc_html_e( 'Override Membership Redirects', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Enable this to override membership redirects with the settings below.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Enable this to override membership redirects with the settings below.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_forced]">
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_forced]" name="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_forced]" type="checkbox" value="yes"<?php checked( 'yes', $plan ? $plan->get( 'checkout_redirect_forced' ) : 'no' ); ?>>
<?php esc_html_e( 'Any redirection set up on the Membership Access Plans will be overridden by the following settings.', 'lifterlms' ); ?>
</label>
</div>
<div class="llms-checkout-redirect-settings">
<div class="llms-metabox-field d-1of2">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_type]">
<?php esc_html_e( 'Checkout Redirect', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Choose where users are redirected after checkout.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Choose where users are redirected after checkout.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_type]" class="llms-checkout-redirect-type" data-controller-id="llms-checkout-redirect-type" name="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_type]" required="required" style="width:100%; height: 25px;"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<?php $saved_checkout_redirect_type = 'self'; ?>
<?php if ( $plan ) : ?>
<?php
$saved_checkout_redirect_type = ! empty( $plan->get( 'checkout_redirect_type' ) ) ? $plan->get( 'checkout_redirect_type' ) : 'self';
?>
<?php endif; ?>
<?php foreach ( $checkout_redirection_types as $checkout_redirection_type => $checkout_redirection_label ) : ?>
<option value="<?php echo esc_attr( $checkout_redirection_type ); ?>"<?php selected( $checkout_redirection_type, $saved_checkout_redirect_type ); ?>><?php echo esc_html( $checkout_redirection_label ); ?></option>
<?php endforeach; ?>
</select>
</div>
<div class="llms-metabox-field d-1of2" data-controller="llms-checkout-redirect-type" data-value-is="page">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_page]">
<?php esc_html_e( 'Select a Page', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Select a page to redirect users to after checkout.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Select a page to redirect users to after checkout.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<select id="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_page]" class="llms-checkout-redirect-page" name="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_page]" data-post-type="page" style="width:100%; height: 25px;"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<?php if ( $plan ) : ?>
<?php $llms_checkout_redirect_page = $plan->get( 'checkout_redirect_page' ); ?>
<?php if ( ! empty( $llms_checkout_redirect_page ) ) : ?>
<option value="<?php echo esc_attr( $llms_checkout_redirect_page ); ?>" selected="selected"><?php echo esc_html( get_the_title( $llms_checkout_redirect_page ) ); ?> ( #<?php echo esc_html( $llms_checkout_redirect_page ); ?>)</option>
<?php endif; ?>
<?php endif; ?>
</select>
</div>
<div class="llms-metabox-field d-1of2" data-controller="llms-checkout-redirect-type" data-value-is="url">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_url]">
<?php esc_html_e( 'Enter a URL', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Enter a specific URL to redirect users to after checkout.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Enter a specific URL to redirect users to after checkout.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_url]" type="text" class="llms-checkout-redirect-url" name="_llms_plans[<?php echo esc_attr( $order ); ?>][checkout_redirect_url]"<?php echo ( $plan ) ? ' value="' . esc_attr( $plan->get( 'checkout_redirect_url' ) ) . '"' : ' disabled="disabled"'; ?> value="<?php echo ( $plan ) ? esc_attr( $plan->get( 'checkout_redirect_url' ) ) : ''; ?>" />
</div>
</div>
<div class="clear"></div>
</div>
<?php if ( llms_parse_bool( get_option( 'llms_access_plans_allow_skus', 'no' ) ) ) : ?>
<h4><?php esc_html_e( 'Advanced Access Plan Settings', 'lifterlms' ); ?></h4>
<div class="llms-plan-row-8">
<div class="llms-metabox-field d-1of4">
<label for="_llms_plans[<?php echo esc_attr( $order ); ?>][sku]">
<?php esc_html_e( 'Plan SKU', 'lifterlms' ); ?>
<span class="screen-reader-text"><?php esc_html_e( 'Set a unique SKU for this access plan for inventory tracking.', 'lifterlms' ); ?></span>
<span class="tip--top-right" data-tip="<?php esc_attr_e( 'Set a unique SKU for this access plan for inventory tracking.', 'lifterlms' ); ?>">
<i class="fa fa-question-circle"></i>
</span>
</label>
<input id="_llms_plans[<?php echo esc_attr( $order ); ?>][sku]" name="_llms_plans[<?php echo esc_attr( $order ); ?>][sku]" type="text"<?php echo ( $plan ? ' value="' . esc_attr( $plan->get( 'sku' ) ) . '"' : ' disabled="disabled"' ); ?>>
</div>
<div class="clear"></div>
</div>
<?php endif; ?>
<div class="clear"></div>
<input class="plan-order" name="_llms_plans[<?php echo esc_attr( $order ); ?>][menu_order]" type="hidden" value="<?php echo ( $plan ) ? esc_attr( $plan->get( 'menu_order' ) ) : esc_attr( $order ); ?>"<?php echo ( $plan ) ? '' : ' disabled="disabled"'; ?>>
<input name="_llms_plans[<?php echo esc_attr( $order ); ?>][id]" type="hidden"<?php echo ( $plan ) ? ' value="' . esc_attr( $plan->get( 'id' ) ) . '"' : ' disabled="disabled"'; ?>>
<?php
/**
* Action hook fired after access plan's meta box body
*
* @since Unknown
*
* @param LLMS_Access_Plan $plan LLMS_Access_Plan.
* @param integer $id Access Plan ID.
* @param integer $order The order of the access plan.
*/
do_action( 'llms_access_plan_mb_after_body', $plan, $id, $order );
?>
</section>
</div>
================================================
FILE: includes/admin/views/access-plans/index.php
================================================
<?php
// quiet.
================================================
FILE: includes/admin/views/access-plans/metabox.php
================================================
<?php
/**
* Product Options Admin Metabox HTML
*
* @package LifterLMS/Admin/Views
*
* @since 3.0.0
* @since 6.0.0 Fix closing tag inside the `llms-no-plans-msg` div element.
* @version 6.0.0
*
* @var LLMS_Course $course
* @var array $checkout_redirection_types checkout redirect setting options.
* @var LLMS_Product $product
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="llms-metabox" id="llms-product-options-access-plans">
<p>
<?php
$access_plan_allowed_html = array(
'a' => array(
'href' => array(),
'target' => array(),
),
);
// Translators: %1$s = Link to access plans documentation; %2$s = The singular label of the custom post type.
printf( wp_kses( __( '<a target="_blank" href="%1$s">Access plans</a> define the payment options and access time-periods available for this %2$s.', 'lifterlms' ), $access_plan_allowed_html ), esc_url( 'https://lifterlms.com/docs/what-is-an-access-plan/' ), esc_html( strtolower( $product->get_post_type_label( 'singular_name' ) ) ) );
?>
</p>
<section class="llms-collapsible-group llms-access-plans" id="llms-access-plans">
<div class="llms-no-plans-msg">
<div class="notice notice-warning inline"><p><?php printf( esc_html__( 'No access plans exist for your %s, click "Add New" to get started.', 'lifterlms' ), esc_html( strtolower( $product->get_post_type_label( 'singular_name' ) ) ) ); ?></p></div>
</div>
<?php foreach ( $product->get_access_plans( false, false ) as $plan ) : ?>
<?php include 'access-plan.php'; ?>
<?php endforeach; ?>
</section>
<div class="llms-plans-actions">
<div class="d-all">
<button class="llms-button-secondary small" id="llms-new-access-plan" type="button">
<span class="fa fa-plus"></span>
<?php esc_html_e( 'Add New Plan', 'lifterlms' ); ?>
</button>
</div>
<div class="clear"></div>
<div class="d-all d-right">
<button class="llms-button-primary" id="llms-save-access-plans" type="button"><?php esc_html_e( 'Save All Plans', 'lifterlms' ); ?></button>
</div>
</div>
<?php
// unset $plan so it's not used for the model.
unset( $plan );
// model of an access plan we'll clone when clicking the "add" button.
require 'access-plan.php';
?>
<?php if ( apply_filters( 'llms_show_access_plan_dialog', true ) ) : ?>
<?php include 'access-plan-dialog.php'; ?>
<?php endif; ?>
</div>
================================================
FILE: includes/admin/views/addons/addon-item.php
================================================
<?php
/**
* Single Add-on Item View.
* Used on Add-Ons browser screen.
*
* @since 3.22.0
* @since 7.5.0 Image URLs to use the local addon image directory with a fallback remote image and showing only LifterLMS author logo.
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
?>
<li class="llms-add-on-item type--<?php echo esc_attr( $addon->get( 'type' ) ); ?>" id="<?php echo esc_attr( $addon->get( 'id' ) ); ?>">
<div class="llms-add-on">
<a class="llms-add-on-link" href="<?php echo esc_url( $addon->get_permalink() ); ?>" target="_blank">
<header>
<img alt="<?php echo esc_attr( $addon->get( 'title' ) ); ?> Banner" src="<?php echo esc_url( $addon->get_image() ); ?>">
<h4><?php echo esc_html( $addon->get( 'title' ) ); ?></h4>
</header>
<section>
<p><?php echo wp_kses_post( llms_trim_string( $addon->get( 'description' ), 180 ) ); ?></p>
<ul>
<?php if ( $addon->get( 'author' )['name'] ) : ?>
<li>
<span>
<?php
// Translators: %s = Author Name.
printf( esc_html__( 'Author: %s', 'lifterlms' ), esc_html( $addon->get( 'author' )['name'] ) );
?>
</span>
<?php if ( 'LifterLMS' === $addon->get( 'author' )['name'] && $addon->get( 'author' )['image'] ) : ?>
<img src="<?php echo esc_url( $addon->get_image( 'author' ) ); ?>" alt="<?php echo esc_attr( $addon->get( 'author' )['name'] ); ?> logo">
<?php endif; ?>
</li>
<?php endif; ?>
<?php if ( $addon->is_installable() ) : ?>
<li>
<?php
// Translators: %s = Current Version Number.
printf( esc_html__( 'Version: %s', 'lifterlms' ), $addon->is_installed() ? esc_html( $addon->get_installed_version() ) : esc_html( $addon->get_latest_version() ) );
?>
</li>
<?php if ( $addon->is_installed() && $addon->has_available_update() ) : ?>
<li><strong>
<?php
// Translators: %s = Available Version Number.
printf( esc_html__( 'Update Available: %s', 'lifterlms' ), esc_html( $addon->get_latest_version() ) );
?>
</strong></li>
<?php endif; ?>
<?php endif; ?>
</ul>
</section>
</a>
<footer class="llms-actions">
<?php do_action( 'llms_add_ons_single_item_before_actions', $addon, $current_tab ); ?>
<?php if ( in_array( $addon->get_type(), array( 'external', 'support' ), true ) || ( 'bundle' === $addon->get_type() && ! $addon->is_licensed() ) || ( $addon->is_installable() && ! $addon->is_installed() ) ) : ?>
<a href="<?php echo esc_url( $addon->get_permalink() ); ?>" class="llms-status-icon external status--<?php echo esc_attr( $addon->get_license_status() ); ?>" target="_blank">
<i class="fa fa-info-circle hide-on-hover" aria-hidden="true"></i>
<i class="fa fa-external-link show-on-hover" aria-hidden="true"></i>
<span class="llms-status-text"><?php esc_html_e( 'Learn more', 'lifterlms' ); ?></span>
</a>
<?php
else :
$url = $addon->is_licensed() ? 'https://lifterlms.com/my-account' : $addon->get_permalink();
?>
<a href="<?php echo esc_url( $url ); ?>" class="llms-status-icon status--<?php echo esc_attr( $addon->get_license_status() ); ?>" target="_blank">
<i class="fa fa-key hide-on-hover" aria-hidden="true"></i>
<i class="fa fa-external-link show-on-hover" aria-hidden="true"></i>
<span class="llms-status-text"><?php echo wp_kses_post( $addon->get_license_status( true ) ); ?></span>
</a>
<?php endif; ?>
<?php do_action( 'llms_add_ons_single_item_actions', $addon, $current_tab ); ?>
<?php if ( 'featured' !== $current_tab ) : ?>
<?php if ( $addon->is_installable() && $addon->is_installed() ) : ?>
<?php if ( $addon->is_active() ) : ?>
<?php if ( 'theme' !== $addon->get_type() ) : ?>
<label class="llms-status-icon status--<?php echo esc_attr( $addon->get_status() ); ?>" for="<?php echo esc_attr( sprintf( '%s-deactivate', $addon->get( 'id' ) ) ); ?>">
<input class="llms-bulk-check" data-action="deactivate" name="llms_deactivate[]" id="<?php echo esc_attr( sprintf( '%s-deactivate', $addon->get( 'id' ) ) ); ?>" type="checkbox" value="<?php echo esc_attr( $addon->get( 'id' ) ); ?>">
<i class="fa fa-check-square-o" aria-hidden="true"></i>
<i class="fa fa-plug" aria-hidden="true"></i>
<span class="llms-status-text"><?php esc_html_e( 'Deactivate', 'lifterlms' ); ?></span>
</label>
<?php endif; ?>
<?php else : ?>
<label class="llms-status-icon status--<?php echo esc_attr( $addon->get_status() ); ?>" for="<?php echo esc_attr( sprintf( '%s-activate', $addon->get( 'id' ) ) ); ?>">
<input class="llms-bulk-check" data-action="activate" name="llms_activate[]" id="<?php echo esc_attr( sprintf( '%s-activate', $addon->get( 'id' ) ) ); ?>" type="checkbox" value="<?php echo esc_attr( $addon->get( 'id' ) ); ?>">
<i class="fa fa-check-square-o" aria-hidden="true"></i>
<i class="fa fa-plug" aria-hidden="true"></i>
<span class="llms-status-text"><?php esc_html_e( 'Activate', 'lifterlms' ); ?></span>
</label>
<?php endif; ?>
<?php endif; ?>
<?php endif; ?>
<?php do_action( 'llms_add_ons_single_item_after_actions', $addon, $current_tab ); ?>
</footer>
</div>
</li>
================================================
FILE: includes/admin/views/addons/index.php
================================================
<?php // Quiet.
================================================
FILE: includes/admin/views/builder/assignment.php
================================================
<?php
/**
* Assignment template
*
* @since 3.17.0
* @version 3.17.0
*/
?>
<script type="text/html" id="tmpl-llms-assignment-template">
<# if ( _.isEmpty( data ) ) { #>
<div class="llms-quiz-empty">
<p><?php esc_html_e( 'There\'s no assignment associated with this lesson.', 'lifterlms' ); ?></p>
<button class="llms-element-button" id="llms-new-assignment" type="button">
<?php esc_html_e( 'Create New Assignment', 'lifterlms' ); ?>
<i class="fa fa-file" aria-hidden="true"></i>
</button>
<br>
<button class="llms-element-button" id="llms-existing-assignment" type="button">
<?php esc_html_e( 'Add Existing Assignment', 'lifterlms' ); ?>
<i class="fa fa-file-text" aria-hidden="true"></i>
</button>
</div>
<# } else { #>
<?php do_action( 'llms_builder_assignment_settings' ); ?>
<# } #>
</script>
================================================
FILE: includes/admin/views/builder/course.php
================================================
<?php
/**
* Builder main course view
*
* @since 3.16.0
* @version 3.17.8
*/
?>
<script type="text/html" id="tmpl-llms-course-template">
<header class="llms-builder-header llms-course-header">
<h1 class="llms-headline">
<span data-original-content="{{{ data.get( 'title' ) }}}" data-required="required" type="text">{{{ data.get( 'title' ) }}}</span>
</h1>
<div class="llms-action-icons static">
<# if ( data.get_edit_post_link() ) { #>
<a class="llms-button-secondary small" href="{{{ data.get_edit_post_link() }}}">
<i class="fa fa-pencil-square-o" aria-hidden="true"></i>
<?php esc_html_e( 'Edit Course Page', 'lifterlms' ); ?>
</a>
<# } #>
<a class="llms-button-secondary small" href="{{{ data.get( 'permalink' ) }}}">
<i class="fa fa-external-link"></i>
<?php esc_html_e( 'View Course', 'lifterlms' ); ?>
</a>
</div>
</header>
<section class="llms-outline" id="llms-outline">
<div class="llms-builder-tutorial" id="llms-builder-tutorial"></div>
<ul class="llms-sections" id="llms-sections"></ul>
<button class="llms-button-secondary small new-section">
<span class="fa fa-file"></span> <?php esc_html_e( 'Add New Section', 'lifterlms' ); ?>
</button>
</section>
</script>
================================================
FILE: includes/admin/views/builder/editor.php
================================================
<?php
/**
* Builder sidebar model editor view
*
* @since 3.16.0
* @version 3.17.0
*/
?>
<script type="text/html" id="tmpl-llms-editor-template">
<nav class="llms-editor-nav">
<ul class="llms-editor-menu">
<li class="llms-editor-menu-item<# if ( 'lesson' === data.state ) { print( ' active' ); } #>">
<a href="#llms-editor-lesson" data-view="lesson"><?php esc_html_e( 'Lesson', 'lifterlms' ); ?></a>
</li>
<li class="llms-editor-menu-item<# if ( 'assignment' === data.state ) { print( ' active' ); } #>">
<a href="#llms-editor-assignment" data-view="assignment"><?php esc_html_e( 'Assignment', 'lifterlms' ); ?></a>
</li>
<li class="llms-editor-menu-item<# if ( 'quiz' === data.state ) { print( ' active' ); } #>">
<a href="#llms-editor-quiz" data-view="quiz"><?php esc_html_e( 'Quiz', 'lifterlms' ); ?></a>
</li>
<li class="llms-editor-menu-item right">
<a href="#llms-editor-close">
<span class="screen-reader-text"><?php esc_html_e( 'Close', 'lifterlms' ); ?></span>
<i class="fa fa-close" aria-hidden="true"></i>
</a>
</li>
</ul>
</nav>
<section id="llms-editor-lesson" class="llms-editor-tab tab--lesson<# if ( 'lesson' === data.state ) { print( ' active' ); } #>"></section>
<section id="llms-editor-quiz" class="llms-editor-tab tab--quiz<# if ( 'quiz' === data.state ) { print( ' active' ); } #>"></section>
<section id="llms-editor-assignment" class="llms-editor-tab tab--assignment<# if ( 'assignment' === data.state ) { print( ' active' ); } #>"></section>
</script>
================================================
FILE: includes/admin/views/builder/elements.php
================================================
<?php
/**
* Builder sidebar course elements list
*
* @since 3.16.0
* @version 3.16.0
*/
?>
<script type="text/html" id="tmpl-llms-elements-template">
<h2 class="llms-sidebar-headline"><?php esc_html_e( 'Build Your Course', 'lifterlms' ); ?></h2>
<p class="llms-sidebar-description">
<?php
/* translators: %s: link to course builder tutorial */
echo wp_kses(
sprintf(
__( 'Drag or click on the different course elements below to build your course syllabus. <a href="%s" target="_blank">Visit the course builder tutorial here</a>.', 'lifterlms' ),
'https://lifterlms.com/docs/using-course-builder/'
),
array(
'a' => array(
'href' => array(),
'target' => array(),
),
)
);
?>
</p>
<ul class="llms-elements-list llms-add-items">
<li>
<button class="llms-element-button" id="llms-new-section">
<span class="fa fa-puzzle-piece"></span>
<span class="llms-element-button-text"><?php esc_html_e( 'Add New Section', 'lifterlms' ); ?></span>
</button>
</li>
<li>
<button class="llms-element-button" id="llms-new-lesson">
<span class="fa fa-file"></span>
<span class="llms-element-button-text"><?php esc_html_e( 'Add New Lesson', 'lifterlms' ); ?></span>
</button>
</li>
<li>
<button class="llms-element-button" id="llms-existing-lesson">
<span class="fa fa-file-text"></span>
<span class="llms-element-button-text"><?php esc_html_e( 'Add Existing Lesson', 'lifterlms' ); ?></span>
</button>
</li>
</ul>
</script>
================================================
FILE: includes/admin/views/builder/index.php
================================================
<?php // Shhh.
================================================
FILE: includes/admin/views/builder/lesson-settings.php
================================================
<?php
/**
* Builder lesson settings template
*
* @since 3.17.0
* @version 3.17.2
*/
?>
<script type="text/html" id="tmpl-llms-lesson-settings-template">
<header class="llms-model-header" id="llms-lesson-header">
<h3 class="llms-headline llms-model-title">
<?php esc_html_e( 'Title', 'lifterlms' ); ?>: <span class="llms-input llms-editable-title" contenteditable="true" data-attribute="title" data-original-content="{{{ data.get( 'title' ) }}}" data-required="required">{{{ data.get( 'title' ) }}}</span>
</h3>
<label class="llms-switch llms-model-status">
<span class="llms-label"><?php esc_html_e( 'Published', 'lifterlms' ); ?></span>
<input data-off="draft" data-on="publish" name="status" type="checkbox"<# if ( 'publish' === data.get( 'status' ) ) { print( ' checked' ) } #>>
<div class="llms-switch-slider"></div>
</label>
<div class="llms-action-icons">
<# if ( ! data.has_temp_id() ) { #>
<a class="llms-action-icon tip--bottom-left" data-tip="<?php esc_attr_e( 'Open WordPress lesson editor', 'lifterlms' ); ?>" href="{{{ data.get_edit_post_link() }}}" target="_blank">
<i class="fa fa-wordpress" aria-hidden="true"></i>
<span class="screen-reader-text"><?php esc_html_e( 'Open WordPress lesson editor', 'lifterlms' ); ?></span>
</a>
<a class="llms-action-icon danger tip--bottom-left" data-tip="<?php esc_attr_e( 'Detach Lesson', 'lifterlms' ); ?>" href="#llms-detach-model">
<i class="fa fa-chain-broken" aria-hidden="true"></i>
<span class="screen-reader-text"><?php esc_html_e( 'Detach Lesson', 'lifterlms' ); ?></span>
</a>
<# } #>
<a class="llms-action-icon danger tip--bottom-left" data-tip="<?php esc_attr_e( 'Delete Lesson', 'lifterlms' ); ?>" href="#llms-trash-model" tabindex="-1">
<i class="fa fa-trash" aria-hidden="true"></i>
<span class="screen-reader-text"><?php esc_html_e( 'Delete Lesson', 'lifterlms' ); ?></span>
</a>
</div>
</header>
<div id="llms-lesson-settings-fields"></div>
</script>
================================================
FILE: includes/admin/views/builder/lesson.php
================================================
<?php
/**
* Builder lesson model view
*
* @since 3.16.0
* @since 3.30.3 Fixed spelling errors.
* @since 7.2.0 Added lesson id.
* @version 7.2.0
*/
?>
<script type="text/html" id="tmpl-llms-lesson-template">
<span class="llms-drag-utility drag-lesson"></span>
<header class="llms-builder-header">
<h3 class="llms-headline">
<span>{{{ data.get( 'title' ) }}}</span>
</h3>
<div class="llms-action-icons">
<div class="llms-action-icons-left">
<span class="llms-item-id"><?php esc_html_e( 'ID:', 'lifterlms' ); ?> {{{ data.get( 'id' ) }}}</span>
<# if ( data.get_edit_post_link() ) { #>
<a class="llms-action-icon tip--top-right" data-tip="<?php esc_attr_e( 'Open WordPress lesson editor', 'lifterlms' ); ?>" href="{{{ data.get_edit_post_link() }}}" target="_blank">
<span class="fa fa-pencil-square-o"></span>
<?php esc_html_e( 'Edit', 'lifterlms' ); ?>
</a>
<# } #>
<# if ( ! data.has_temp_id() ) { #>
<a class="llms-action-icon tip--top-right" data-tip="<?php esc_attr_e( 'View lesson', 'lifterlms' ); ?>" href="{{{ data.get_view_post_link() }}}" target="_blank">
<span class="fa fa-external-link"></span>
<?php esc_html_e( 'View', 'lifterlms' ); ?>
</a>
<# } #>
<# if ( ! data.has_temp_id() ) { #>
<button class="llms-action-icon llms-detach-model detach--lesson danger tip--top-right" data-tip="<?php esc_attr_e( 'Detach lesson', 'lifterlms' ); ?>">
<span class="fa fa-chain-broken"></span>
<?php esc_html_e( 'Detach', 'lifterlms' ); ?>
</button>
<# } #>
<?php if ( current_user_can( 'delete_course', $course_id ) ) : ?>
<button class="llms-action-icon llms-trash-model trash--lesson danger tip--top-right" data-tip="<?php esc_attr_e( 'Trash lesson', 'lifterlms' ); ?>">
<span class="fa fa-trash"></span>
<?php esc_html_e( 'Trash', 'lifterlms' ); ?>
</button>
<?php endif; ?>
</div>
<div class="llms-action-icons-right">
<button id="llms-section-change" class="llms-action-icon section-prev tip--top-right" data-tip="<?php esc_attr_e( 'Move to previous section', 'lifterlms' ); ?>" aria-label="<?php esc_attr_e( 'Move to previous section', 'lifterlms' ); ?>">
<span class="fa fa-arrow-circle-o-up"></span>
</button>
<button id="llms-section-change" class="llms-action-icon section-next tip--top-right" data-tip="<?php esc_attr_e( 'Move to next section', 'lifterlms' ); ?>" aria-label="<?php esc_attr_e( 'Move to next section', 'lifterlms' ); ?>">
<span class="fa fa-arrow-circle-o-down"></span>
</button>
<button id="llms-shift" class="llms-action-icon shift-up--lesson tip--top-right" data-tip="<?php esc_attr_e( 'Shift up', 'lifterlms' ); ?>" aria-label="<?php esc_attr_e( 'Shift up', 'lifterlms' ); ?>">
<span class="fa fa-chevron-up"></span>
</button>
<button id="llms-shift" class="llms-action-icon shift-down--lesson tip--top-right" data-tip="<?php esc_attr_e( 'Shift down', 'lifterlms' ); ?>" aria-label="<?php esc_attr_e( 'Shift down', 'lifterlms' ); ?>">
<span class="fa fa-chevron-down"></span>
</button>
</div>
</div>
</header>
<ul class="llms-info-list">
<?php
$icons = array(
'settings' => array(
'action' => 'edit-lesson',
'active_condition' => 'true',
'tip' => '',
'tip_active' => esc_attr__( 'Edit lesson settings', 'lifterlms' ),
'icon' => '',
'icon_active' => '<i class="fa fa-cog"></i>' . esc_html__( 'Settings', 'lifterlms' ),
),
'assignment' => array(
'action' => 'edit-assignment',
'active_condition' => "'yes' === data.get( 'assignment_enabled' )",
'tip' => esc_attr__( 'Add an assignment', 'lifterlms' ),
'tip_active' => sprintf( esc_attr__( 'Edit assignment: %s', 'lifterlms' ), "{{{ _.isEmpty( data.get( 'assignment' ) ) ? '' : data.get( 'assignment' ).get( 'title' ) }}}" ),
'icon' => '<i class="fa fa-check-square-o"></i> ' . esc_html__( 'Add assignment', 'lifterlms' ),
'icon_active' => '<i class="fa fa-check-square-o"></i>' . esc_html__( 'Edit assignment', 'lifterlms' ),
),
'quiz' => array(
'action' => 'edit-quiz',
'active_condition' => "'yes' === data.get( 'quiz_enabled' )",
'tip' => esc_attr__( 'Add a quiz', 'lifterlms' ),
'tip_active' => sprintf( esc_attr__( 'Edit quiz: %s', 'lifterlms' ), "{{{ ( 'yes' === data.get( 'quiz_enabled' ) ) ? data.get( 'quiz' ).get( 'title' ) : '' }}}" ),
'icon' => '<i class="fa fa-question-circle"></i> ' . esc_html__( 'Add quiz', 'lifterlms' ),
'icon_active' => '<i class="fa fa-question-circle"></i>' . esc_html__( 'Edit quiz', 'lifterlms' ),
),
'video' => array(
'action' => 'edit-lesson',
'active_condition' => "data.get( 'video_embed' )",
'tip' => esc_attr__( 'No video', 'lifterlms' ),
'tip_active' => esc_attr__( 'Has video', 'lifterlms' ),
'icon' => '',
'icon_active' => '<i class="fa fa-play-circle"></i>' . esc_html__( 'Video', 'lifterlms' ),
),
'audio' => array(
'action' => false,
'active_condition' => "data.get( 'audio_embed' )",
'tip' => esc_attr__( 'No audio', 'lifterlms' ),
'tip_active' => esc_attr__( 'Has audio', 'lifterlms' ),
'icon' => '',
'icon_active' => '<i class="fa fa-volume-up"></i>' . esc_html__( 'Audio', 'lifterlms' ),
),
'free' => array(
'action' => 'edit-lesson',
'active_condition' => "'yes' === data.get( 'free_lesson' )",
'tip' => esc_attr__( 'Enrolled students only', 'lifterlms' ),
'tip_active' => esc_attr__( 'Free lesson', 'lifterlms' ),
'icon' => '',
'icon_active' => '<i class="fa fa-unlock"></i>' . esc_html__( 'Free lesson', 'lifterlms' ),
),
'prereq' => array(
'action' => 'edit-lesson',
'active_condition' => "'yes' === data.get( 'has_prerequisite' )",
'tip' => esc_attr__( 'No prerequisite', 'lifterlms' ),
'tip_active' => esc_attr__( 'Prerequisite enabled', 'lifterlms' ),
'icon' => '',
'icon_active' => '<i class="fa fa-link"></i>' . esc_html__( 'Prerequisite enabled', 'lifterlms' ),
),
'drip_method' => array(
'action' => 'edit-lesson',
'active_condition' => "data.get( 'drip_method' )",
'tip' => esc_attr__( 'Drip disabled', 'lifterlms' ),
'tip_active' => esc_attr__( 'Drip enabled', 'lifterlms' ),
'icon' => '',
'icon_active' => '<i class="fa fa-calendar"></i>' . esc_html__( 'Drip enabled', 'lifterlms' ),
),
);
// phpcs:disable WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped above.
foreach ( $icons as $icon ) :
?>
<?php // Hide the whole icon area if there is no icon set, and the active condition is not met. ?>
<?php if ( ! $icon['icon'] ) : ?>
<# if ( <?php echo $icon['active_condition']; ?> ) { #>
<?php endif; ?>
<li class="llms-info-item tip--top-right<# if ( <?php echo $icon['active_condition']; ?> ) { print( ' active') } #>"
data-tip="<?php echo $icon['tip']; ?>"
data-tip-active="<?php echo $icon['tip_active']; ?>">
<?php if ( $icon['action'] ) : ?>
<?php printf( '<button class="llms-action-icon %1$s" id="#llms-action--%1$s">', $icon['action'] ); ?>
<?php endif; ?>
<# if ( <?php echo $icon['active_condition']; ?> ) { #>
<?php echo $icon['icon_active']; ?>
<# } else { #>
<?php echo $icon['icon']; ?>
<# } #>
<?php if ( $icon['action'] ) : ?>
</button>
<?php endif; ?>
</li>
<?php if ( ! $icon['icon'] ) : ?>
<# } #>
<?php endif; ?>
<?php endforeach; ?>
<?php // phpcs:enable WordPress.XSS.EscapeOutput.OutputNotEscaped ?>
</ul>
</script>
================================================
FILE: includes/admin/views/builder/question-choice.php
================================================
<?php
/**
* Builder question view
*
* @since 3.16.0
* @version 3.17.8
*/
?>
<script type="text/html" id="tmpl-llms-question-choice-template">
<label class="llms-choice-id">
<# if ( data.is_selectable() ) { #>
<input name="correct" type="checkbox"<# if ( data.get( 'correct' ) ) { print( ' checked="checked"' ) ;} #>>
<# } #>
<span class="llms-marker<# if ( data.is_selectable() ) { print ( ' selectable' ) }#>">
<b>{{{ data.get( 'marker' ) }}}</b>
<i class="fa fa-check" aria-hidden="true"></i>
</span>
</label>
<# if ( 'text' === data.get( 'choice_type' ) ) { #>
<div class="llms-input-wrapper">
<span class="llms-input llms-editable-title" contenteditable="true" data-attribute="choice" data-formatting="b,i,u,em,strong" data-original-content="{{{ data.get( 'choice' ) }}}" data-placeholder="<?php esc_attr_e( 'Enter a choice...', 'lifterlms' ); ?>">{{{ data.get( 'choice' ) }}}</span>
</div>
<# } else if ( 'image' === data.get( 'choice_type' ) ) { #>
<div class="llms-editable-image">
<# if ( data.get( 'choice' ).get( 'src' ) ) { #>
<div class="llms-image">
<a class="llms-action-icon danger tip--top-left" data-attribute="choice" data-tip="<?php esc_attr_e( 'Remove image', 'lifterlms' ); ?>" href="#llms-remove-image">
<i class="fa fa-times-circle" aria-hidden="true"></i>
<span class="screen-reader-text"><?php esc_html_e( 'Remove image', 'lifterlms' ); ?></span>
</a>
<img alt="<?php esc_attr_e( 'image preview', 'lifterlms' ); ?>" src="{{{ data.get( 'choice' ).get( 'src' ) }}}">
</div>
<# } else { #>
<button class="llms-element-button small llms-add-image" data-attribute="choice" data-image-size="full">
<span class="fa fa-picture-o"></span> <?php esc_html_e( 'Add Image', 'lifterlms' ); ?>
</button>
<# } #>
</div>
<# } #>
<div class="llms-action-icons">
<a class="llms-action-icon circle tip--top-left" data-tip="<?php esc_attr_e( 'Add Choice', 'lifterlms' ); ?>" href="#llms-add-choice" tabindex="-1">
<i class="fa fa-plus" aria-hidden="true"></i>
<span class="screen-reader-text"><?php esc_html_e( 'Add Choice', 'lifterlms' ); ?></span>
</a>
<a class="llms-action-icon circle danger tip--top-left" data-tip="<?php esc_attr_e( 'Delete Choice', 'lifterlms' ); ?>" href="#llms-del-choice" tabindex="-1">
<i class="fa fa-minus" aria-hidden="true"></i>
<span class="screen-reader-text"><?php esc_html_e( 'Delete Choice', 'lifterlms' ); ?></span>
</a>
</div>
</script>
================================================
FILE: includes/admin/views/builder/question-type.php
================================================
<?php
/**
* Builder quiz type template
*
* @since 3.16.0
* @version 3.27.0
*/
?>
<script type="text/html" id="tmpl-llms-question-type-template">
<# if ( data.get( 'upgrade' ) ) { #>
<a class="llms-type-unavailable tip--top-right" href="{{{ data.get( 'upgrade' ) }}}" data-tip="<?php esc_attr_e( 'Install the LifterLMS Advanced Quizzes add-on to enable this question type', 'lifterlms' ); ?>" target="_blank">
<# } #>
<button class="llms-element-button small llms-add-question" data-id="{{{ data.get( 'id' ) }}}" id="llms-add-question--{{{ data.get( 'id' ) }}}">
<i class="fa fa-{{{ data.get( 'icon' ) }}}" aria-hidden="true"></i> {{{ data.get( 'name' ) }}}
</button>
<# if ( data.get( 'upgrade' ) ) { #>
</a>
<# } #>
</script>
================================================
FILE: includes/admin/views/builder/question.php
================================================
<?php
/**
* Builder question view.
*
* @since 3.16.0
* @since 3.27.0 Unknown.
* @since 7.4.0 Escaped strings in labels.
* @version 7.4.0
*/
?>
<script type="text/html" id="tmpl-llms-question-template">
<header class="llms-builder-header">
<span class="llms-data-stamp {{{ data.get( 'question_type' ).get( 'id' ) }}} tip--top-right" data-tip="{{{ data.get_qid() }}} – {{{ data.get( 'question_type' ).get( 'name' ) }}}">
<i class="fa fa-{{{ data.get( 'question_type' ).get( 'icon' ) }}}" aria-hidden="true"></i>
<small>{{{ data.get_qid() }}}</small>
</span>
<h3 class="llms-headline llms-input-wrapper">
<div class="llms-editable-title llms-input-formatting" data-attribute="title" data-formatting="bold,italic,underline" data-placeholder="{{{ data.get( 'question_type' ).get( 'placeholder' ) }}}">{{{ data.get( 'title' ) }}}</div>
</h3>
<div class="llms-action-icons">
<# if ( ! data.get( '_expanded' ) ) { #>
<a class="llms-action-icon expand--question tip--top-right" data-tip="<?php esc_attr_e( 'Expand question', 'lifterlms' ); ?>" href="#llms-expand" tabindex="-1">
<i class="fa fa-plus-circle" aria-hidden="true"></i>
</a>
<# } else { #>
<a class="llms-action-icon collapse--question tip--top-right" data-tip="<?php esc_attr_e( 'Collapse question', 'lifterlms' ); ?>" href="#llms-collapse" tabindex="-1">
<i class="fa fa-minus-circle" aria-hidden="true"></i>
</a>
<# } #>
<a class="llms-action-icon clone--question tip--top-right" data-tip="<?php esc_attr_e( 'Clone question', 'lifterlms' ); ?>" href="#llms-clone" tabindex="-1">
<i class="fa fa-clone" aria-hidden="true"></i>
</a>
<# if ( ! data.has_temp_id() ) { #>
<a class="llms-action-icon detach--question danger tip--top-right" data-tip="<?php esc_attr_e( 'Detach question', 'lifterlms' ); ?>" href="#llms-detach-model">
<span class="fa fa-chain-broken"></span>
</a>
<# } #>
<a class="llms-action-icon danger delete--question tip--top-right" data-tip="<?php esc_attr_e( 'Delete question', 'lifterlms' ); ?>" href="#llms-trash" tabindex="-1">
<i class="fa fa-trash" aria-hidden="true"></i>
</a>
</div>
<div class="llms-question-points llms-editable-number tip--top-left" data-tip="{{{ data.get_points_percentage() }}}">
<input class="llms-input two-digits" min="0" max="99" name="question_points" type="number" value="{{{ data.get( 'points' ) }}}" tabindex="-1"<# if ( ! data.get( 'question_type' ).get( 'points' ) ) { print( ' disabled'); }#>><small><?php esc_html_e( 'points', 'lifterlms' ); ?></small>
</div>
</header>
<section class="llms-question-body <# if ( data.get( '_expanded' ) ) { print( ' active' ); }#>">
<div class="llms-question-features">
<?php do_action( 'llms_builder_question_before_features' ); ?>
<div class="llms-settings-row">
<# if ( data.get( 'question_type' ).get( 'description' ) ) { #>
<div class="llms-editable-toggle-group">
<label class="llms-switch">
<span class="llms-label"><?php esc_html_e( 'Description', 'lifterlms' ); ?></span>
<input type="checkbox" name="description_enabled"<# if ( 'yes' === data.get( 'description_enabled' ) ) { print( ' checked' ) } #>>
<div class="llms-switch-slider"></div>
</label>
<# if ( 'yes' === data.get( 'description_enabled' ) ) { #>
<div class="llms-editable-editor">
<textarea data-attribute="content" id="question-desc--{{{ data.get( 'id' ) }}}">{{{ data.get( 'content' ) }}}</textarea>
</div>
<# } #>
</div>
<# if ( 'yes' === data.get( 'description_enabled' ) ) { #>
<div class="llms-breaker"></div>
<# } #>
<# } #>
<# if ( data.get( 'question_type' ).get( 'image' ) ) { #>
<div class="llms-editable-toggle-group">
<label class="llms-switch">
<span class="llms-label"><?php esc_html_e( 'Image', 'lifterlms' ); ?></span>
<input type="checkbox" name="image.enabled"<# if ( 'yes' === data.get( 'image' ).get( 'enabled' ) ) { print( ' checked' ) } #>>
<div class="llms-switch-slider"></div>
</label>
<# if ( 'yes' === data.get( 'image' ).get( 'enabled' ) ) { #>
<div class="llms-editable-image">
<# if ( data.get( 'image' ).get( 'src' ) ) { #>
<div class="llms-image">
<a class="llms-action-icon danger tip--top-left" data-attribute="image" data-tip="<?php esc_attr_e( 'Remove image', 'lifterlms' ); ?>" href="#llms-remove-image">
<i class="fa fa-times-circle" aria-hidden="true"></i>
<span class="screen-reader-text"><?php esc_html_e( 'Remove image', 'lifterlms' ); ?></span>
</a>
<img alt="<?php esc_attr_e( 'image preview', 'lifterlms' ); ?>" src="{{{ data.get( 'image' ).get( 'src' ) }}}">
</div>
<# } else { #>
<button class="llms-element-button small llms-add-image" data-attribute="image" data-image-size="full">
<span class="fa fa-picture-o"></span> <?php esc_html_e( 'Add Image', 'lifterlms' ); ?>
</button>
<# } #>
</div>
<# } #>
</div>
<# } #>
<# if ( data.get( 'question_type' ).get( 'video' ) ) { #>
<div class="llms-editable-toggle-group">
<label class="llms-switch">
<span class="llms-label"><?php esc_html_e( 'Video', 'lifterlms' ); ?></span>
<input type="checkbox" name="video_enabled"<# if ( 'yes' === data.get( 'video_enabled' ) ) { print( ' checked' ) } #>>
<div class="llms-switch-slider"></div>
</label>
<# if ( 'yes' === data.get( 'video_enabled' ) ) { #>
<div class="llms-editable-video tip--top-right" data-tip="<?php esc_attr_e( 'Use YouTube, Vimeo, or Wistia video URLS.', 'lifterlms' ); ?>">
<input class="llms-input standard" data-attribute="video_src" data-original-content="{{{ data.get( 'video_src' ) }}}" placeholder="<?php esc_attr_e( 'https://', 'lifterlms' ); ?>" data-type="video" name="video_src" value="{{{ data.get( 'video_src' ) }}}">
</div>
<# } #>
</div>
<# } #>
</div>
<?php do_action( 'llms_builder_question_after_features' ); ?>
</div>
<# if ( data.get( 'question_type' ).get( 'choices' ) ) { #>
<div class="llms-question-choices-wrapper">
<header class="llms-question-choices-list-header">
<span class="llms-label"><?php esc_html_e( 'Choices', 'lifterlms' ); ?></span>
<# if ( data.get( 'question_type' ).get_multi_choices() && data.get( 'question_type' ).get_choice_selectable() ) { #>
<label class="llms-switch">
<span class="llms-label"><?php esc_html_e( 'Multiple Correct Choices', 'lifterlms' ); ?></span>
<input type="checkbox" name="multi_choices"<# if ( 'yes' === data.get( 'multi_choices' ) ) { print( ' checked' ) } #>>
<div class="llms-switch-slider"></div>
</label>
<# } #>
</header>
<ul class="llms-question-choices<# if ( 'yes' === data.get( 'multi_choices' ) ) { print( ' multi-choices' ) } #>"></ul>
</div>
<# } else if ( 'group' === data.get( 'question_type' ).get( 'id' ) ) { #>
<ul class="llms-quiz-questions" data-empty-msg="<?php esc_attr_e( 'Drag a question here to add it to the group.', 'lifterlms' ); ?>"></ul>
<# } #>
<div class="llms-question-features">
<# if ( data.get( 'question_type' ).get( 'clarifications' ) ) { #>
<div class="llms-settings-row">
<div class="llms-editable-toggle-group">
<label class="llms-switch">
<span class="llms-label"><?php esc_html_e( 'Result Clarifications', 'lifterlms' ); ?></span>
<input type="checkbox" name="clarifications_enabled"<# if ( 'yes' === data.get( 'clarifications_enabled' ) ) { print( ' checked' ) } #>>
<div class="llms-switch-slider"></div>
</label>
<# if ( 'yes' === data.get( 'clarifications_enabled' ) ) { #>
<div class="llms-editable-editor">
<textarea data-attribute="clarifications" id="question-clarifications--{{{ data.get( 'id' ) }}}">{{{ data.get( 'clarifications' ) }}}</textarea>
</div>
<# } #>
</div>
</div>
<# } #>
</div>
</section>
</script>
================================================
FILE: includes/admin/views/builder/quiz.php
================================================
<?php
/**
* Builder quiz model view
*
* @since 3.16.0
* @version 3.17.6
*/
?>
<script type="text/html" id="tmpl-llms-quiz-template">
<# if ( _.isEmpty( data ) ) { #>
<div class="llms-quiz-empty">
<p><?php esc_html_e( 'There\'s no quiz associated with this lesson.', 'lifterlms' ); ?></p>
<button class="llms-element-button" id="llms-new-quiz" type="button">
<?php esc_html_e( 'Create New Quiz', 'lifterlms' ); ?>
<i class="fa fa-file" aria-hidden="true"></i>
</button>
<br>
<button class="llms-element-button" id="llms-existing-quiz" type="button">
<?php esc_html_e( 'Add Existing Quiz', 'lifterlms' ); ?>
<i class="fa fa-file-text" aria-hidden="true"></i>
</button>
</div>
<# } else { #>
<header class="llms-model-header" id="llms-lesson-header">
<h3 class="llms-headline llms-model-title">
<?php esc_html_e( 'Title', 'lifterlms' ); ?>: <span class="llms-input llms-editable-title" contenteditable="true" data-attribute="title" data-original-content="{{{ data.get( 'title' ) }}}" data-required="required">{{{ data.get( 'title' ) }}}</span>
</h3>
<div class="llms-headline llms-quiz-points">
<?php esc_html_e( 'Total Points', 'lifterlms' ); ?>: <strong id="llms-quiz-total-points">{{{ data.get( '_points' ) }}}</strong>
</div>
<label class="llms-switch llms-model-status">
<span class="llms-label"><?php esc_html_e( 'Published', 'lifterlms' ); ?></span>
<input data-off="draft" data-on="publish" name="status" type="checkbox"<# if ( 'publish' === data.get( 'status' ) ) { print( ' checked' ) } #>>
<div class="llms-switch-slider"></div>
</label>
<div class="llms-action-icons">
<# if ( ! data.has_temp_id() ) { #>
<a class="llms-action-icon danger tip--bottom-left" data-tip="<?php esc_attr_e( 'Detach Quiz', 'lifterlms' ); ?>" href="#llms-detach-model">
<i class="fa fa-chain-broken" aria-hidden="true"></i>
<span class="screen-reader-text"><?php esc_html_e( 'Detach Quiz', 'lifterlms' ); ?></span>
</a>
<# } #>
<a class="llms-action-icon danger tip--bottom-left" data-tip="<?php esc_html_e( 'Delete Quiz', 'lifterlms' ); ?>" href="#llms-trash-model" tabindex="-1">
<i class="fa fa-trash" aria-hidden="true"></i>
<span class="screen-reader-text"><?php esc_html_e( 'Delete Quiz', 'lifterlms' ); ?></span>
</a>
</div>
</header>
<?php do_action( 'llms_builder_quiz_before_settings' ); ?>
<div id="llms-quiz-settings-fields"></div>
<?php do_action( 'llms_builder_quiz_after_settings' ); ?>
<ul class="llms-quiz-questions" data-empty-msg="<?php esc_attr_e( 'Click "Add Question" below to start building your quiz!', 'lifterlms' ); ?>" id="llms-quiz-questions"></ul>
<footer class="llms-quiz-footer">
<button class="llms-element-button secondary small right bulk-toggle" data-action="collapse" id="llms-question-collapse-all">
<?php esc_html_e( 'Collapse All', 'lifterlms' ); ?>
<i class="fa fa-minus-circle"></i>
</button>
<button class="llms-element-button secondary small right bulk-toggle" data-action="expand" id="llms-question-expand-all">
<?php esc_html_e( 'Expand All', 'lifterlms' ); ?>
<i class="fa fa-plus-circle"></i>
</button>
<button class="llms-element-button small right llms-show-question-bank" id="llms-show-question-bank">
<?php esc_html_e( 'Add Question', 'lifterlms' ); ?>
<i class="fa fa-plus-circle" aria-hidden="true"></i>
</button>
</footer>
<div class="llms-quiz-tools" id="llms-quiz-tools">
<ul class="llms-question-bank" id="llms-question-bank"></ul>
</div>
<# } #>
</script>
================================================
FILE: includes/admin/views/builder/section.php
================================================
<?php
/**
* Builder section model
*
* @since 3.16.0
* @version 3.17.2
*/
?>
<script type="text/html" id="tmpl-llms-section-template">
<span class="llms-drag-utility drag-section"></span>
<header class="llms-builder-header">
<h2 class="llms-headline">
<span class="llms-input" contenteditable="true" data-attribute="title" data-original-content="{{{ data.title }}}" data-required="required">{{{ data.title }}}</span>
</h2>
<div class="llms-action-icons">
<div class="llms-action-icons-left">
<?php if ( current_user_can( 'delete_course', $course_id ) ) : ?>
<button class="llms-action-icon llms-trash-model trash--section danger tip--top-right" data-tip="<?php esc_attr_e( 'Delete section', 'lifterlms' ); ?>">
<span class="fa fa-trash"></span>
<span class="screen-reader-text"><?php esc_html_e( 'Delete section', 'lifterlms' ); ?></span>
</button>
<?php endif; ?>
</div>
<div class="llms-action-icons-right">
<button class="llms-action-icon shift-up--section tip--top-right" data-tip="<?php esc_attr_e( 'Shift up', 'lifterlms' ); ?>" aria-label="<?php esc_attr_e( 'Shift up', 'lifterlms' ); ?>">
<span class="fa fa-chevron-up"></span>
</button>
<button class="llms-action-icon shift-down--section tip--top-right" data-tip="<?php esc_attr_e( 'Shift down', 'lifterlms' ); ?>" aria-label="<?php esc_attr_e( 'Shift down', 'lifterlms' ); ?>">
<span class="fa fa-chevron-down"></span>
</button>
<# if ( ! data._expanded ) { #>
<button class="llms-action-icon expand tip--top-right" data-tip="<?php esc_attr_e( 'Expand section', 'lifterlms' ); ?>" aria-label="<?php esc_attr_e( 'Expand section', 'lifterlms' ); ?>">
<span class="fa fa-caret-down"></span>
</button>
<# } #>
<# if ( data._expanded ) { #>
<button class="llms-action-icon collapse tip--top-right" data-tip="<?php esc_attr_e( 'Collapse section', 'lifterlms' ); ?>" aria-label="<?php esc_attr_e( 'Collapse section', 'lifterlms' ); ?>">
<span class="fa fa-caret-up"></span>
</button>
<# } #>
</div>
</div>
</header>
<ul class="llms-lessons<# if ( data._expanded ) { #> expanded<# } #>" id="llms-lessons-{{{ data.id }}}"></ul>
<# if ( data._expanded ) { #>
<div class="llms-builder-footer">
<button class="llms-button-secondary small new-lesson">
<span class="fa fa-file"></span> <?php esc_html_e( 'Add New Lesson', 'lifterlms' ); ?>
</button>
</div>
<# } #>
</script>
================================================
FILE: includes/admin/views/builder/settings-fields.php
================================================
<?php
/**
* Model Field Settings Template.
*
* @since 3.17.0
* @since 3.24.0 Unknown.
* @since 7.4.0 Added support for `upsell` field type and multiple input fields.
* @version 7.4.0
*/
defined( 'ABSPATH' ) || exit;
?>
<script type="text/html" id="tmpl-llms-settings-fields-template">
<# _.each( data.get_groups(), function( group_data, group_id ) { #>
<section class="llms-model-settings active settings-group--{{{ group_id }}}{{ data.is_group_hidden( group_id ) ? ' hidden' : '' }}" id="llms-{{{ data.model.get( 'type' ) }}}-settings-group--{{{ group_id }}}">
<# if ( group_data.title ) { #>
<header class="llms-settings-group-header">
<h4 class="llms-settings-group-title">{{{ group_data.title }}}</h4>
<# if ( group_data.toggleable ) { #>
<a class="llms-action-icon llms-settings-group-toggle" href="#llms-group-toggle">
<i class="fa fa-caret-up" aria-hidden="true"></i>
<i class="fa fa-caret-down" aria-hidden="true"></i>
</a>
<# } #>
</header>
<# } #>
<div class="llms-settings-group-body">
<# _.each( group_data.fields, function( row, row_index ) { #>
<div class="llms-settings-row">
<# _.each( row, function( orig_field, field_index ) { #>
<#
var field = data.setup_field( orig_field, field_index );
if ( ! field ) { return; }
#>
<div class="llms-settings-field settings-field--{{{ field.type }}}<# if ( field.label_after ) { #> has-label-after<# } #>" id="llms-model-settings-field--{{{ field.id }}}">
<# if ( data.has_switch( field.type ) ) { #>
<div class="llms-editable-select{{{ field.classes }}}" >
<label class="llms-switch">
<span class="llms-label">
{{{ field.label }}}
<# if ( field.tip ) { #>
<span class="tip--{{{ field.tip_position }}}" data-tip="{{{ field.tip }}}"><i class="fa fa-question-circle"></i></span>
<# } #>
</span>
<input data-on="{{{ field.switch_on }}}" data-off="{{{ field.switch_off }}}" data-rerender="{{{ data.should_rerender_on_toggle( field.type ) }}}" name="{{{ data.get_switch_attribute( field ) }}}" type="checkbox"{{{ _.checked( field.switch_on, data.model.get( data.get_switch_attribute( field ) ) ) }}}>
<div class="llms-switch-slider"></div>
</label>
</div>
<# } else if ( field.label ) { #>
<span class="llms-label">
{{{ field.label }}}
<# if ( field.tip ) { #>
<span class="tip--{{{ field.tip_position }}}" data-tip="{{{ field.tip }}}"><i class="fa fa-question-circle"></i></span>
<# } #>
</span>
<# } #>
<# if ( 'permalink' === field.type ) { #>
<a target="_blank" href="{{{ data.model.get( 'permalink' ) }}}">{{{ data.model.get( 'permalink' ) }}}</a>
<input class="llms-input permalink" data-attribute="name" data-original-content="{{{ data.model.get( 'name' ) }}}" data-type="permalink" name="name" type="text" value="{{{ data.model.get( 'name' ) }}}">
<a class="llms-action-icon" href="#llms-edit-slug"><i class="fa fa-pencil" aria-hidden="true"></i></a>
<# } else if ( 'page_builder_notice' === field.type ) { #>
<p>
<?php
esc_html_e( "This lesson's content was created outside of the Course Builder.", 'lifterlms' );
?>
<a href="{{{ data.model.get_edit_post_link() }}}" target="_blank"><?php esc_html_e( 'Edit in WordPress', 'lifterlms' ); ?></a>
</p>
<# } else if ( 'upsell' === field.type ) { #>
<a target="_blank" href="{{{ field.url }}}">
<span class="llms-disabled">{{{ field.text }}}</span>
</a>
<# } else if ( 'select' === field.type || ( 'switch-select' === field.type && data.is_switch_condition_met( field ) ) ) { #>
<div class="llms-editable-select{{{ field.classes }}}" >
<select name="{{{ field.attribute }}}"{{{ field.multiple ? ' multiple' : '' }}}>{{{ data.render_select_options( field.options, field.attribute ) }}}</select>
</div>
<# } else if ( 'radio' === field.type || ( 'switch-radio' === field.type && data.is_switch_condition_met( field ) ) ) { #>
<div class="llms-editable-radio{{{ field.classes }}}">
<# _.each( field.options, function( label, val ) { #>
<label for="{{{ field.id }}}_{{{ val }}}" class="llms-radio">
<input id="{{{ field.id }}}_{{{ val }}}" name="{{{ field.attribute }}}" type="radio" value="{{{ val }}}"{{{ _.checked( val, data.model.get( field.attribute ) ) }}}>
{{{ label }}}
</label>
<# } ); #>
</div>
<# } else if ( data.is_editor_field( field.type ) ) { #>
<# if ( -1 === field.type.indexOf( 'switch-' ) || ( -1 !== field.type.indexOf( 'switch-' ) && data.is_switch_condition_met( field ) ) ) { #>
<div class="llms-editable-editor{{{ field.classes }}}">
<textarea data-attribute="{{{ field.attribute }}}" id="{{{ field.id }}}">{{{ data.model.get( field.attribute ) }}}</textarea>
</div>
<# } #>
<# } else if ( data.is_default_field( field.type ) ) { #>
<# const field_inputs = field.inputs?.length ? field.inputs : [ field ]; #>
<# if ( -1 === field.type.indexOf( 'switch-' ) || ( -1 !== field.type.indexOf( 'switch-' ) && data.is_switch_condition_met( field ) ) ) { #>
<div class="llms-editable-input{{{ field.classes }}}">
<# field_inputs.forEach( input => { #>
<div class="llms-input-wrapper">
<# if ( field_inputs.length > 1 && input.label ) { #>
<span class="label">{{{ input.label }}}</span>
<# } #>
<input
class="llms-input standard"
data-attribute="{{{ input.attribute }}}"
data-original-content="{{{ data.model.get( input.attribute ) }}}"
<# if ( 'datepicker' === input.type ) { #>
<# if ( input.datepicker ) { #> data-date-datepicker="{{{ input.datepicker }}}" <# } #>
<# if ( input.timepicker ) { #> data-date-timepicker="{{{ input.timepicker }}}" <# } #>
<# if ( input.date_format ) { #> data-date-format="{{{ input.date_format }}}" <# } #>
<# } #>
<# if ( input.hasOwnProperty( 'min' ) ) { #> min="{{{ input.min }}}" <# } #>
<# if ( input.hasOwnProperty( 'max' ) ) { #> max="{{{ input.max }}}" <# } #>
name="{{{ input.attribute }}}"
<# if ( input.placeholder ) { #> placeholder="{{{ input.placeholder }}}" <# } #>
type="{{{ input.input_type }}}"
value="{{{ data.model.get( input.attribute ) }}}"
>
<# if ( input.input_description ) { #>
<small class="llms-description">{{{ input.input_description }}}</small>
<# } #>
</div>
<# } ); #>
</div>
<# } #>
<# } #>
<# if ( field.label_after ) { #>
<span class="llms-label llms-label--after">{{{ field.label_after }}}</span>
<# } #>
<# if ( field.detail ) { #>
<div class="llms-detail">{{{ field.detail }}}</div>
<# } #>
</div>
<# } ); #>
</div>
<# } ); #>
</div>
</section>
<# } ); #>
</script>
================================================
FILE: includes/admin/views/builder/sidebar.php
================================================
<?php
/**
* Builder sidebar view template
*
* @since 3.16.0
* @since 7.2.0 Added video explainer wrapper element.
* @version 7.2.0
*/
?>
<script type="text/html" id="tmpl-llms-sidebar-template">
<div class="llms-elements" id="llms-elements"></div>
<div class="llms-utilities" id="llms-utilities"></div>
<div class="llms-video-explainer" id="llms-video-explainer">
<span class="llms-video-explainer-trigger">
<a href="https://lifterlms.com/docs/using-course-builder/" target="_blank">
<img
src="<?php echo esc_url( plugin_dir_url( LLMS_PLUGIN_FILE ) . 'assets/images/course-builder-video-thumbnail.jpg' ); ?>"
alt="<?php esc_attr_e( 'How to Build Your Course Outline with the LifterLMS Course Builder', 'lifterlms' ); ?>"
/>
</a>
</span>
</div>
<div class="llms-editor" id="llms-editor"></div>
<footer class="llms-builder-save">
<button class="llms-button-primary llms-save" data-status="saved" id="llms-save-button" disabled="disabled">
<i></i><!-- placeholder for LLMS.Spinner -->
<span class="llms-status-indicator status--saved"><?php esc_html_e( 'Saved', 'lifterlms' ); ?></span>
<span class="llms-status-indicator status--unsaved"><?php esc_html_e( 'Save changes', 'lifterlms' ); ?></span>
<span class="llms-status-indicator status--saving"><?php esc_html_e( 'Saving changes...', 'lifterlms' ); ?></span>
<span class="llms-status-indicator status--error"><?php esc_html_e( 'Error saving changes...', 'lifterlms' ); ?></span>
</button>
<button class="llms-button-secondary llms-exit" id="llms-exit-button"><?php esc_html_e( 'Exit', 'lifterlms' ); ?></button>
</footer class="llms-builder-save">
</script>
================================================
FILE: includes/admin/views/builder/utilities.php
================================================
<?php
/**
* Builder utilities list view
*
* @since 3.16.0
* @version 3.16.0
*/
?>
<script type="text/html" id="tmpl-llms-utilities-template">
<ul class="llms-utilities-list">
<li>
<button id="llms-expand-all" class="llms-utility bulk-toggle" data-action="expand">
<span class="fa fa-caret-down"></span>
<?php esc_html_e( 'Expand Sections', 'lifterlms' ); ?>
</button>
</li>
<li>
<button id="llms-collapse-all" class="llms-utility bulk-toggle" href="#llms-bulk-toggle" data-action="collapse">
<span class="fa fa-caret-up"></span>
<?php esc_html_e( 'Collapse Sections', 'lifterlms' ); ?>
</button>
</li>
</ul>
</script>
================================================
FILE: includes/admin/views/dashboard/addons.php
================================================
<?php
/**
* Add-ons meta box HTML.
*
* @package LifterLMS/Admin/Views/Dashboard
*
* @since 7.1.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
$view = new LLMS_Admin_AddOns();
$view->output_for_settings();
?>
<p>
<a
class="llms-button-primary"
href="<?php echo esc_url( admin_url( 'admin.php?page=llms-add-ons' ) ); ?>"><?php esc_html_e( 'View Add-ons & more', 'lifterlms' ); ?></a>
</p>
================================================
FILE: includes/admin/views/dashboard/blog.php
================================================
<?php
/**
* Blog meta box HTML.
*
* @package LifterLMS/Admin/Views/Dashboard
*
* @since 7.1.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
// Get RSS Feed(s).
require_once ABSPATH . WPINC . '/feed.php';
// Get a SimplePie feed object from the specified feed source.
$rss = fetch_feed( 'https://lifterlms.com/feed' );
$maxitems = 0;
if ( ! is_wp_error( $rss ) ) : // Checks that the object is created correctly.
// Figure out how many total items there are, but limit it to 3.
$maxitems = $rss->get_item_quantity( 3 );
// Build an array of all the items, starting with element 0 (first element).
$rss_items = $rss->get_items( 0, $maxitems );
endif;
?>
<ul>
<?php if ( 0 === $maxitems ) : ?>
<li><?php esc_html_e( 'No news found.', 'lifterlms' ); ?></li>
<?php else : ?>
<?php // Loop through each feed item and display each item as a hyperlink. ?>
<?php foreach ( $rss_items as $item ) : ?>
<li>
<a
href="<?php echo esc_url( $item->get_permalink() ); ?>"
title="<?php printf( esc_attr__( 'Posted %s', 'lifterlms' ), esc_attr( date_i18n( get_option( 'date_format' ), $item->get_date( 'U' ) ) ) ); ?>"
target="_blank"
rel="noopener"><?php echo esc_html( $item->get_title() ); ?></a>
<?php echo esc_html( date_i18n( get_option( 'date_format' ), $item->get_date( 'U' ) ) ); ?>
</li>
<?php endforeach; ?>
<?php endif; ?>
</ul>
<p>
<a
class="llms-button-secondary small"
href="https://lifterlms.com/blog/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=LifterLMS%20Blog"
target="_blank"
rel="noopener"><i class="fa fa-external-link" aria-hidden="true"></i> <?php esc_html_e( 'View More', 'lifterlms' ); ?></a>
</p>
================================================
FILE: includes/admin/views/dashboard/index.php
================================================
<?php // Quiet.
================================================
FILE: includes/admin/views/dashboard/podcast.php
================================================
<?php
/**
* Podcast meta box HTML.
*
* @package LifterLMS/Admin/Views/Dashboard
*
* @since 7.1.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
// Get RSS Feed(s).
require_once ABSPATH . WPINC . '/feed.php';
// Get a SimplePie feed object from the specified feed source.
$rss = fetch_feed( 'https://podcast.lifterlms.com/feed/' );
$maxitems = 0;
if ( ! is_wp_error( $rss ) ) : // Checks that the object is created correctly.
// Figure out how many total items there are, but limit it to 3.
$maxitems = $rss->get_item_quantity( 3 );
// Build an array of all the items, starting with element 0 (first element).
$rss_items = $rss->get_items( 0, $maxitems );
endif;
?>
<ul>
<?php if ( 0 === $maxitems ) : ?>
<li><?php esc_html_e( 'No news found.', 'lifterlms' ); ?></li>
<?php else : ?>
<?php // Loop through each feed item and display each item as a hyperlink. ?>
<?php foreach ( $rss_items as $item ) : ?>
<li>
<a
href="<?php echo esc_url( $item->get_permalink() ); ?>"
title="<?php printf( esc_attr__( 'Posted %s', 'lifterlms' ), esc_attr( date_i18n( get_option( 'date_format' ), $item->get_date( 'U' ) ) ) ); ?>"
target="_blank"
rel="noopener"><?php echo esc_html( $item->get_title() ); ?></a>
<?php echo esc_html( date_i18n( get_option( 'date_format' ), $item->get_date( 'U' ) ) ); ?>
</li>
<?php endforeach; ?>
<?php endif; ?>
</ul>
<p>
<a
class="llms-button-secondary small"
href="https://lifterlms.com/blog/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=LifterLMS%20Podcast"
target="_blank"
rel="noopener"><i class="fa fa-external-link" aria-hidden="true"></i> <?php esc_html_e( 'View More', 'lifterlms' ); ?></a>
</p>
================================================
FILE: includes/admin/views/dashboard/quick-links.php
================================================
<?php
/**
* Quick links meta box HTML.
*
* @package LifterLMS/Admin/Views/Dashboard
*
* @since 7.1.0
* @since 7.3.0 Added `llms_dashboard_checklist` filter.
* @version 7.3.0
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="llms-quick-links">
<div class="llms-list">
<h3><?php esc_html_e( 'Build LMS Content', 'lifterlms' ); ?></h3>
<ul>
<li><a href="<?php echo esc_url( admin_url( 'post-new.php?post_type=llms_membership' ) ); ?>"><?php esc_html_e( 'Add a New Membership', 'lifterlms' ); ?></a></li>
<li><a href="<?php echo esc_url( admin_url( 'post-new.php?post_type=llms_engagement' ) ); ?>"><?php esc_html_e( 'Create an Engagement', 'lifterlms' ); ?></a></li>
</ul>
<a class="llms-button-primary" href="<?php echo esc_url( admin_url( 'post-new.php?post_type=course' ) ); ?>"><i class="fa fa-graduation-cap" aria-hidden="true"></i> <?php esc_html_e( 'Create a New Course', 'lifterlms' ); ?></a>
</div>
<div class="llms-list">
<h3><?php esc_html_e( 'Access Reports', 'lifterlms' ); ?></h3>
<ul>
<li><a href="<?php echo esc_url( admin_url( 'edit.php?post_type=llms_order' ) ); ?>"><?php esc_html_e( 'View Orders', 'lifterlms' ); ?></a></li>
<li><a href="<?php echo esc_url( admin_url( 'admin.php?page=llms-reporting&tab=students' ) ); ?>"><?php esc_html_e( 'View Students', 'lifterlms' ); ?></a></li>
</ul>
<a class="llms-button-secondary" href="<?php echo esc_url( admin_url( 'admin.php?page=llms-reporting&tab=sales' ) ); ?>"><i class="fa fa-line-chart" aria-hidden="true"></i> <?php esc_html_e( 'View Sales Report', 'lifterlms' ); ?></a>
</div>
<div class="llms-list">
<h3><?php esc_html_e( 'Your Launch Checklist', 'lifterlms' ); ?></h3>
<?php
// Count access plans across the whole LMS.
$ap_check = false;
$ap_query = new WP_Query(
array(
'post_type' => 'llms_access_plan',
'posts_per_page' => 1,
'post_status' => 'any', // Retrieves any status except for 'inherit', 'trash' and 'auto-draft'.
'no_found_rows' => true,
'update_post_meta_cache' => false,
'update_post_term_cache' => false,
)
);
// If more than 1 access plan, they are "set up".
if ( $ap_query->post_count >= 1 ) {
$ap_check = true;
}
// Count enrollments across the whole LMS.
global $wpdb;
$enrollments_check = false;
$enrollments = $wpdb->get_var( "SELECT COUNT(*) FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_key = '_status' AND meta_value = 'enrolled'" ); // no-cache ok.
// If more than 10 enrollments, they are "set up".
if ( $enrollments >= 10 ) {
$enrollments_check = true;
}
// Add checklist items to an array so we can filter.
$checklist = array();
if ( $ap_check ) {
$checklist['access_plan'] = '<i class="fa fa-check"></i> ' . esc_html__( 'Create Access Plan', 'lifterlms' );
} else {
$checklist['access_plan'] = '<i class="fa fa-times"></i> <a href="https://lifterlms.com/docs/what-is-an-access-plan/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=Create%20Access%20Plan" target="_blank" rel="noopener">' . esc_html__( 'Create Access Plan', 'lifterlms' ) . '</a>';
}
if ( $enrollments_check ) {
$checklist['enrollments'] = '<i class="fa fa-check"></i> ' . esc_html__( 'Get 10 Enrollments', 'lifterlms' );
} else {
$checklist['enrollments'] = '<i class="fa fa-times"></i> <a href="https://academy.lifterlms.com/course/enroll/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=Get%2010%20Enrollments" target="_blank" rel="noopener">' . esc_html__( 'Get 10 Enrollments', 'lifterlms' ) . '</a>';
}
/**
* Filters the dashboard quick links checklist.
*
* @since 7.3.0
*
* @param array $checklist Dashboard quick links checklist.
*/
$checklist = apply_filters( 'llms_dashboard_checklist', $checklist );
?>
<ul class="llms-checklist">
<?php
foreach ( $checklist as $item ) {
echo '<li>' . wp_kses_post( $item ) . '</li>';
}
?>
</ul>
<a class="llms-button-action" href="<?php echo esc_url( admin_url( 'admin.php?page=llms-add-ons' ) ); ?>"><i class="fa fa-plug" aria-hidden="true"></i> <?php esc_html_e( 'Add Advanced Features', 'lifterlms' ); ?></a>
</div>
</div>
<hr />
<div class="llms-help-links">
<div class="llms-list">
<h3><span class="dashicons dashicons-admin-users"></span> <?php esc_html_e( 'Sales', 'lifterlms' ); ?></h3>
<ul>
<li><a href="https://lifterlms.com/pricing/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=LifterLMS%20Pricing" target="_blank" rel="noopener"><?php esc_html_e( 'Pricing', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/store/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=LifterLMS%20Add-ons" target="_blank" rel="noopener"><?php esc_html_e( 'Add-Ons', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/presales-contact/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=LifterLMS%20Presales%20Contact" target="_blank" rel="noopener"><?php esc_html_e( 'Contact Sales', 'lifterlms' ); ?></a></li>
</ul>
</div>
<div class="llms-list">
<h3><span class="dashicons dashicons-editor-help"></span> <?php esc_html_e( 'Support', 'lifterlms' ); ?></h3>
<ul>
<li><a href="https://lifterlms.com/docs/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=LifterLMS%20Documentation" target="_blank" rel="noopener"><?php esc_html_e( 'Documentation', 'lifterlms' ); ?></a></li>
<li><a href="https://wordpress.org/support/plugin/lifterlms/" target="_blank" rel="noopener"><?php esc_html_e( 'WordPress.org Support', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/my-account/my-tickets/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=LifterLMS%20Support" target="_blank" rel="noopener"><?php esc_html_e( 'Premium Support', 'lifterlms' ); ?></a></li>
</ul>
</div>
<div class="llms-list">
<h3><span class="dashicons dashicons-lightbulb"></span> <?php esc_html_e( 'Learn', 'lifterlms' ); ?></h3>
<ul>
<li><a href="https://academy.lifterlms.com/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=LifterLMS%20Academy" target="_blank" rel="noopener"><?php esc_html_e( 'Academy', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/community-events/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=LifterLMS%20Events" target="_blank" rel="noopener"><?php esc_html_e( 'Events', 'lifterlms' ); ?></a></li>
<li><a href="https://developer.lifterlms.com/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=LifterLMS%20Developers" target="_blank" rel="noopener"><?php esc_html_e( 'Developers', 'lifterlms' ); ?></a></li>
</ul>
</div>
<div class="llms-list">
<h3><span class="dashicons dashicons-admin-site"></span> <?php esc_html_e( 'Content', 'lifterlms' ); ?></h3>
<ul>
<li><a href="https://lifterlms.com/blog/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=LifterLMS%20Blog" target="_blank" rel="noopener"><?php esc_html_e( 'Blog', 'lifterlms' ); ?></a></li>
<li><a href="https://podcast.lifterlms.com/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Dashboard%20Screen&utm_content=Podcast" target="_blank" rel="noopener"><?php esc_html_e( 'Podcast', 'lifterlms' ); ?></a></li>
<li><a href="https://www.youtube.com/lifterlms" target="_blank" rel="noopener"><?php esc_html_e( 'YouTube', 'lifterlms' ); ?></a></li>
</ul>
</div>
</div>
================================================
FILE: includes/admin/views/dashboard.php
================================================
<?php
/**
* Dashboard Page HTML.
*
* @package LifterLMS/Admin/Views
*
* @since 7.1.0
* @since 7.3.0 Leverage new `LLMS_Admin_Dashboard_Widget::get_dashboard_widget_data()` method.
* @version 7.3.0
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="wrap lifterlms lifterlms-settings llms-dashboard">
<div class="llms-subheader">
<h1><?php esc_html_e( 'LifterLMS Dashboard', 'lifterlms' ); ?></h1>
</div>
<div class="llms-inside-wrap">
<hr class="wp-header-end">
<div class="llms-dashboard-activity">
<h2><?php printf( esc_html__( 'Recent Activity: %1$1s to %2$2s', 'lifterlms' ), esc_html( date( get_option( 'date_format' ), current_time( 'timestamp' ) - WEEK_IN_SECONDS ) ), esc_html( date( get_option( 'date_format' ), current_time( 'timestamp' ) ) ) ); ?></h2>
<?php echo '<style type="text/css">#llms-charts-wrapper{display:none;}</style>'; ?>
<?php
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in template.
echo llms_get_template(
'admin/reporting/tabs/widgets.php',
array(
'json' => wp_json_encode(
array(
'current_tab' => 'settings',
'current_range' => 'last-7-days',
'current_students' => array(),
'current_courses' => array(),
'current_memberships' => array(),
'dates' => array(
'start' => date( 'Y-m-d', current_time( 'timestamp' ) - WEEK_IN_SECONDS ),
'end' => current_time( 'Y-m-d' ),
),
)
),
'widget_data' => array( LLMS_Admin_Dashboard_Widget::get_dashboard_widget_data() ),
)
);
?>
</div> <!-- end llms-dashboard-activity -->
<form id="llms-dashboard-form" method="post" action="admin-post.php">
<div id="poststuff">
<div id="post-body" class="metabox-holder columns-2">
<div id="postbox-container-1" class="postbox-container">
<?php do_meta_boxes( 'toplevel_page_llms-dashboard', 'side', '' ); ?>
</div>
<div id="postbox-container-2" class="postbox-container">
<?php do_meta_boxes( 'toplevel_page_llms-dashboard', 'normal', '' ); ?>
</div>
<br class="clear">
</div> <!-- end dashboard-widgets -->
<?php wp_nonce_field( 'closedpostboxes', 'closedpostboxesnonce', false ); ?>
<?php wp_nonce_field( 'meta-box-order', 'meta-box-order-nonce', false ); ?>
</div> <!-- end dashboard-widgets-wrap -->
</form>
<script type="text/javascript">
//<![CDATA[
jQuery(document).ready( function($) {
// close postboxes that should be closed
$('.if-js-closed').removeClass('if-js-closed').addClass('closed');
// postboxes setup
postboxes.add_postbox_toggles('toplevel_page_llms-dashboard');
});
//]]>
</script>
</div>
</div> <!-- end .wrap.llms-dashboard -->
================================================
FILE: includes/admin/views/import/help-sidebar.php
================================================
<?php
/**
* "Overview" Help Tab on the Admin Import screen
*
* @package LifterLMS/Admin/Views/Import
*
* @since 4.8.0
* @version 4.8.0
*/
defined( 'ABSPATH' ) || exit;
?>
<p><strong><?php esc_html_e( 'For more information:', 'lifterlms' ); ?></strong></p>
<p><a href="https://lifterlms.com/docs/importing-lifterlms-courses?utm_source=helptab&utm_medium=product&utm_content=importdocs&utm_campaign=lifterlmsplugin" target="_blank">
<?php esc_html_e( 'Import Documentation', 'lifterlms' ); ?></a></p>
================================================
FILE: includes/admin/views/import/help-tab-overview.php
================================================
<?php
/**
* "Overview" Help Tab on the Admin Import screen
*
* @package LifterLMS/Admin/Views/Import
*
* @since 4.8.0
* @version 4.8.0
*/
defined( 'ABSPATH' ) || exit;
?>
<h4><?php esc_html_e( 'Importing into LifterLMS', 'lifterlms' ); ?></h4>
<p><?php esc_html_e( 'Importing allows you to copy courses from one LifterLMS site to another.', 'lifterlms' ); ?></p>
<p><?php esc_html_e( 'You can upload <code>.json</code> files exported from another LifterLMS site using the "Upload" button.', 'lifterlms' ); ?></p>
<p><?php esc_html_e( 'The courses listed below are samples and templates you can import into your site directly from LifterLMS.com. When importing these courses the content (including images) will be downloaded from LifterLMS.com and imported into your site.', 'lifterlms' ); ?></p>
================================================
FILE: includes/admin/views/import/index.php
================================================
<?php // Quiet.
================================================
FILE: includes/admin/views/import.php
================================================
<?php
/**
* Import & Export LLMS Content
*
* @since 3.3.0
* @version 4.8.0
*/
defined( 'ABSPATH' ) || exit;
$courses = LLMS_Export_API::list();
?>
<div class="wrap lifterlms lifterlms-settings llms-import-export">
<div class="llms-inside-wrap">
<div class="llms-setting-group top">
<div class="llms-label">
<?php esc_html_e( 'Import Courses', 'lifterlms' ); ?>
<button class="llms-button-primary small" role="button"><?php esc_html_e( 'Upload', 'lifterlms' ); ?></button>
</div>
<hr class="wp-header-end">
<div class="llms-widget" style="display: none;" id="llms-import-uploader">
<form action="" enctype="multipart/form-data" method="POST">
<table class="form-table">
<tr>
<th><label for="llms-import-file"><?php esc_html_e( 'Import Course(s)', 'lifterlms' ); ?></label></th>
<td>
<p><?php esc_html_e( 'Upload export files generated by LifterLMS. Must be a ".json" file.', 'lifterlms' ); ?></p>
<div class="llms-import-file-wrap">
<input accept="application/json" name="llms_import" id="llms-import-file" type="file">
<button class="button" id="llms-import-file-submit" type="submit"><?php esc_html_e( 'Import', 'lifterlms' ); ?></button>
</div>
</td>
</tr>
<?php
/**
* Fires after core importer(s) on the "Import screen".
*
* Allows 3rd parties to add their own importers to the table.
*
* @since 3.3.0
*/
do_action( 'lifterlms_importer_tr' );
?>
</table>
<?php wp_nonce_field( 'llms-importer', 'llms_importer_nonce' ); ?>
</form>
</div>
<p>
<?php
// Translators: %s = anchor link HTML to LifterLMS.com.
printf( esc_html__( 'Download and import courses, templates, and more from %s.', 'lifterlms' ), '<a href="https://lifterlms.com" target="_blank">LifterLMS.com</a>' );
?>
<button class="llms-cloud-import-help button-link" type="button" title="<?php esc_attr_e( 'Help', 'lifterlms' ); ?>">
<span class="screen-reader-text"><?php esc_html_e( 'Help', 'lifterlms' ); ?></span>
<span class="dashicons dashicons-editor-help"></span>
</button>
</p>
<form action="" method="POST">
<?php require LLMS_PLUGIN_DIR . 'includes/admin/views/importable-courses.php'; ?>
<?php wp_nonce_field( 'llms-cloud-importer', 'llms_cloud_importer_nonce' ); ?>
</form>
</div>
</div>
</div>
<script>
( function() {
document.querySelector( '.llms-button-primary' ).addEventListener( 'click', function() {
const el = document.getElementById( 'llms-import-uploader' );
el.style.display = 'none' === el.style.display ? 'block' : 'none';
} );
document.querySelector( '.llms-cloud-import-help' ).addEventListener( 'click', function( e ) {
document.getElementById( 'contextual-help-link' ).click();
} );
} )();
</script>
================================================
FILE: includes/admin/views/importable-course.php
================================================
<?php
/**
* Display a single importable course
*
* @package LifterLMS/Admin/Views
*
* @since 4.8.0
* @version 4.8.0
*
* @property array $course A hash of importable course data.
*/
defined( 'ABSPATH' ) || exit;
/**
* Filters whether or not an action button should be displayed for an importable course.
*
* @since 4.8.0
*
* @param boolean $show_button Whether or not to show the button.
* @param array $course Hash of the importable course data.
*/
$show_button = apply_filters( 'llms_importable_course_show_action', true, $course );
?>
<li class="llms-importable-course<?php echo $show_button ? ' has-action-button' : ''; ?>">
<?php
/**
* Action run prior to the output of an importable course item
*
* @since 4.8.0
*
* @param array $course Hash of the importable course data.
*/
do_action( 'llms_before_importable_course', $course );
?>
<img alt="<?php printf( esc_attr__( '%s featured image', 'lifterlms' ), esc_attr( $course['title'] ) ); ?>" src="<?php echo esc_url( $course['image'] ); ?>">
<h3><?php echo esc_html( $course['title'] ); ?></h3>
<p><?php echo esc_html( $course['description'] ); ?></p>
<?php
/**
* Action run after the output of an importable course item
*
* This runs after the item's content but before the item's action button.
*
* @since 4.8.0
*
* @param array $course Hash of the importable course data.
*/
do_action( 'llms_after_importable_course', $course );
?>
<?php if ( $show_button ) : ?>
<p><button class="llms-button-secondary" name="llms_cloud_import_course_id" type="submit" value="<?php echo absint( $course['id'] ); ?>"><?php esc_html_e( 'Download & Import', 'lifterlms' ); ?></button></p>
<?php endif; ?>
</li>
================================================
FILE: includes/admin/views/importable-courses.php
================================================
<?php
/**
* List importable courses
*
* @package LifterLMS/Admin/Views
*
* @since 4.8.0
* @version 4.8.0
*
* @property array[] $courses List of importable course data.
*/
defined( 'ABSPATH' ) || exit;
?>
<?php if ( is_wp_error( $courses ) ) : ?>
<p class="llms-error">
<?php
// Translators: %s = Text of the HTTP Request error message.
printf( esc_html__( 'There was an error loading importable courses. Please reload the page to try again. [%s]', 'lifterlms' ), wp_kses_post( $courses->get_error_message() ) );
?>
</p>
<?php else : ?>
<ul class="llms-importable-courses">
<?php
/**
* Action run prior to the output of an importable course list
*
* @since 4.8.0
*
* @param array[] $courses List of importable course data.
*/
do_action( 'llms_before_importable_courses', $courses );
foreach ( $courses as $course ) {
include LLMS_PLUGIN_DIR . 'includes/admin/views/importable-course.php';
}
/**
* Action run after the output of an importable course list
*
* @since 4.8.0
*
* @param array[] $courses List of importable course data.
*/
do_action( 'llms_after_importable_courses', $courses );
?>
</ul>
<?php endif; ?>
================================================
FILE: includes/admin/views/index.php
================================================
<?php // Shhhh.
================================================
FILE: includes/admin/views/merge-code-button.php
================================================
<?php
/**
* Display an MCE editor merge code button (and drop down).
*
* @package LifterLMS/Admin/Views
*
* @since 6.0.0
* @version 6.0.0
*
* @see llms_merge_code_button()
*
* @param array[] $codes Associative array of merge codes where the array key is the merge code and the array value is a name / description of the merge code.
* @param WP_Screen|null $screen The screen object from `get_current_screen().
* @param string $target Target to add the merge code to. Accepts the ID of a tinymce editor or a DOM ID (#element-id).
*/
defined( 'ABSPATH' ) || exit;
$svg = file_get_contents( LLMS_PLUGIN_DIR . '/assets/images/lifterlms-icon-grey.svg' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
?>
<div class="llms-merge-code-wrapper">
<button class="button llms-merge-code-button" type="button">
<?php echo $svg; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
<?php esc_html_e( 'Merge Codes', 'lifterlms' ); ?>
</button>
<div class="llms-merge-codes" data-target="<?php echo esc_attr( $target ); ?>">
<ul>
<?php foreach ( $codes as $code => $desc ) : ?>
<li data-code="<?php echo esc_attr( $code ); ?>"><?php echo wp_kses_post( $desc ); ?></li>
<?php endforeach; ?>
</ul>
</div>
</div><!-- .llms-merge-code-wrapper -->
================================================
FILE: includes/admin/views/metaboxes/index.php
================================================
<?php // Quiet you.
================================================
FILE: includes/admin/views/metaboxes/view-award-engagement-submit.php
================================================
<?php
/**
* Award Engagements submit meta box.
*
* Heavily based on WordPress `post_submit_meta_box()`.
*
* @package LifterLMS/Admin/Views/Metaboxes
*
* @since 6.0.0
* @version 6.0.0
*
* @property WP_Post $engagement WP_Post instance of the engagement.
* @property int $engagement_id WP_Post ID of the engagement.
* @property string $action The action being performed.
* @property bool $can_publish Whether the current user can publish the engagement.
* @property string $fields Meta box fields such as student information ones.
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="submitbox llms-award-engagement-submitbox" id="submitpost">
<div id="minor-publishing">
<?php // Hidden submit button early on so that the browser chooses the right button when form is submitted with Return key. ?>
<div style="display:none;">
<?php submit_button( __( 'Save', 'lifterlms' ), '', 'save' ); ?>
</div>
<div class="clear"></div>
<div id="misc-publishing-actions">
<div class="misc-pub-section misc-pub-post-status">
<?php esc_html_e( 'Status:', 'lifterlms' ); ?>
<span id="post-status-display">
<?php
switch ( $engagement->post_status ) {
case 'publish':
esc_html_e( 'Awarded', 'lifterlms' );
break;
case 'future':
esc_html_e( 'Scheduled', 'lifterlms' );
break;
case 'draft':
case 'auto-draft':
esc_html_e( 'Draft', 'lifterlms' );
break;
}
?>
</span>
<?php if ( 'publish' === $engagement->post_status || $can_publish ) : /* Select needed because the core js takes the current status from this, when changing the publishing time */ ?>
<div id="post-status-select" class="hidden">
<select name="post_status" id="post_status">
<?php if ( 'publish' === $engagement->post_status ) : ?>
<option<?php selected( $engagement->post_status, 'publish' ); ?> value='publish'><?php esc_html_e( 'Awarded', 'lifterlms' ); ?></option>
<?php elseif ( 'future' === $engagement->post_status ) : ?>
<option<?php selected( $engagement->post_status, 'future' ); ?> value='future'><?php esc_html_e( 'Scheduled', 'lifterlms' ); ?></option>
<?php else : ?>
<option<?php selected( $engagement->post_status, 'auto-draft' ); ?> value='draft'><?php esc_html_e( 'Draft', 'lifterlms' ); ?></option>
<?php endif; ?>
</select>
</div>
<?php endif; ?>
</div>
</div>
<?php
/* translators: Award box date string. 1: Date, 2: Time. See https://www.php.net/manual/datetime.format.php */
$date_string = __( '%1$s at %2$s', 'lifterlms' );
/* translators: Award box date format, see https://www.php.net/manual/datetime.format.php */
$date_format = _x( 'M j, Y', 'award box date format', 'lifterlms' );
/* translators: Award box time format, see https://www.php.net/manual/datetime.format.php */
$time_format = _x( 'H:i', 'award box time format', 'lifterlms' );
if ( 0 !== $engagement_id ) {
if ( 'future' === $engagement->post_status ) { // Scheduled for awarding at a future date.
/* translators: Engagement date information. %s: Date on which the engagement is currently scheduled to be awarded. */
$stamp = __( 'Scheduled for: %s', 'lifterlms' );
} elseif ( 'publish' === $engagement->post_status ) { // Already awarded.
/* translators: Post date information. %s: Date on which the engagement was awarded. */
$stamp = __( 'Awarded on: %s', 'lifterlms' );
} elseif ( '0000-00-00 00:00:00' === $engagement->post_date_gmt ) { // Draft, 1 or more saves, no date specified.
$stamp = __( 'Award <b>immediately</b>', 'lifterlms' );
} elseif ( llms_current_time( 'U', true ) < strtotime( $engagement->post_date_gmt . ' +0000' ) ) { // Draft, 1 or more saves, future date specified.
/* translators: Post date information. %s: Date on which the post is to be awarded. */
$stamp = __( 'Schedule for: %s', 'lifterlms' );
} else { // Draft, 1 or more saves, date specified.
/* translators: Post date information. %s: Date on which the post is to be awarded. */
$stamp = __( 'Award on: %s', 'lifterlms' );
}
$date = sprintf(
$date_string,
date_i18n( $date_format, strtotime( $engagement->post_date ) ),
date_i18n( $time_format, strtotime( $engagement->post_date ) )
);
} else { // Draft (no saves, and thus no date specified).
$stamp = __( 'Award <b>immediately</b>', 'lifterlms' );
$date = sprintf(
$date_string,
date_i18n( $date_format, strtotime( llms_current_time( 'mysql' ) ) ),
date_i18n( $time_format, strtotime( llms_current_time( 'mysql' ) ) )
);
}
if ( $can_publish ) : // Contributors don't get to choose the date of awarding.
?>
<div class="misc-pub-section curtime misc-pub-curtime">
<span id="timestamp">
<?php echo wp_kses_post( sprintf( $stamp, '<b>' . $date . '</b>' ) ); ?>
</span>
<a href="#edit_timestamp" class="edit-timestamp hide-if-no-js" role="button">
<span aria-hidden="true"><?php esc_html_e( 'Edit', 'lifterlms' ); ?></span>
<span class="screen-reader-text"><?php esc_html_e( 'Edit date and time', 'lifterlms' ); ?></span>
</a>
<fieldset id="timestampdiv" class="hide-if-js">
<legend class="screen-reader-text"><?php esc_html_e( 'Date and time', 'lifterlms' ); ?></legend>
<?php touch_time( ( 'edit' === $action ), 1 ); ?>
</fieldset>
</div>
<?php
endif;
?>
<div class="clear"></div>
</div>
<ul id="misc-fields" class="misc-pub-section" style="margin-top:0">
<?php
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo $fields;
?>
</ul>
<div id="major-publishing-actions">
<div id="delete-action">
<?php
if ( current_user_can( 'delete_post', $engagement_id ) ) {
$delete_text = __( 'Delete permanently', 'lifterlms' );
?>
<a class="submitdelete deletion" href="<?php echo get_delete_post_link( $engagement_id, '', true ); ?>"><?php echo esc_html( $delete_text ); ?></a>
<?php
}
?>
</div>
<div id="publishing-action">
<span class="spinner"></span>
<?php
if ( ! in_array( $engagement->post_status, array( 'publish', 'future' ), true ) || 0 === $engagement_id ) {
if ( $can_publish ) :
if ( ! empty( $engagement->post_date_gmt ) && llms_current_time( 'U', true ) < strtotime( $engagement->post_date_gmt . ' +0000' ) ) :
?>
<input name="original_publish" type="hidden" id="original_publish" value="<?php echo esc_attr_x( 'Schedule', 'post action/button label', 'lifterlms' ); ?>" />
<?php submit_button( _x( 'Schedule', 'post action/button label', 'lifterlms' ), 'primary large', 'publish', false ); ?>
<?php
else :
?>
<input name="original_publish" type="hidden" id="original_publish" value="<?php esc_attr_e( 'Award', 'lifterlms' ); ?>" />
<?php submit_button( __( 'Award', 'lifterlms' ), 'primary large', 'publish', false ); ?>
<?php
endif;
endif;
} else {
?>
<input name="original_publish" type="hidden" id="original_publish" value="<?php esc_attr_e( 'Update', 'lifterlms' ); ?>" />
<?php submit_button( __( 'Update', 'lifterlms' ), 'primary large', 'save', false, array( 'id' => 'publish' ) ); ?>
<?php
}
?>
</div>
<div class="clear"></div>
</div>
</div>
================================================
FILE: includes/admin/views/metaboxes/view-order-details.php
================================================
<?php
/**
* Order Details metabox for Order on Admin Panel
*
* @package LifterLMS/Admin/Views
*
* @since 5.3.0
* @since 5.4.0 Inform about deleted products.
* @since 6.1.0 Add validation to the remaining payments input.
* Allow the number of remaining payments to be `0` for already-completed payment plans.
* @version 7.0.0
*
* @property LLMS_Order $order Order object.
* @property LLMS_Payment_Gateway $gateway Instance of the order's payment gateway.
* @property array $switchable_gateways List of gateways that the order can be switched to.
* @property array $switchable_gateway_fields List of admin fields for the available switchable gateways.
*/
defined( 'ABSPATH' ) || exit;
$supports_modify_recurring_payments = $order->supports_modify_recurring_payments();
?>
<div class="llms-metabox">
<?php if ( 'test' === $order->get( 'gateway_api_mode' ) ) : ?>
<h6 class="llms-transaction-test-mode"><?php esc_html_e( 'This order was processed in the gateway\'s testing mode', 'lifterlms' ); ?></h6>
<?php endif; ?>
<?php do_action( 'lifterlms_before_order_meta_box', $order ); ?>
<h2><?php echo esc_html( sprintf( __( 'Order #%s', 'lifterlms' ), $order->get( 'id' ) ) ); ?></h2>
<h3><?php echo esc_html( sprintf( __( 'Processed by %s', 'lifterlms' ), is_wp_error( $gateway ) ? $order->get( 'payment_gateway' ) : $gateway->get_admin_title() ) ); ?></h3>
<?php do_action( 'lifterlms_order_meta_box_after_header', $order ); ?>
<div class="llms-metabox-section d-1of3">
<?php
/**
* THIS ACTION HOOK TO BE DEPRECATED!
*/
do_action( 'lifterlms_order_meta_box_after_order_information', $order );
?>
<?php do_action( 'lifterlms_order_meta_box_before_plan_information', $order ); ?>
<?php if ( $order->get( 'plan_id' ) ) : ?>
<h4><?php esc_html_e( 'Access Plan Information', 'lifterlms' ); ?></h4>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Name:', 'lifterlms' ); ?></label>
<?php echo esc_html( $order->get( 'plan_title' ) ); ?>
<small>(#<?php echo esc_html( $order->get( 'plan_id' ) ); ?>)</small>
</div>
<?php if ( llms_parse_bool( get_option( 'llms_access_plans_allow_skus', 'no' ) ) ) : ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'SKU:', 'lifterlms' ); ?></label>
<?php echo esc_html( $order->get( 'plan_sku' ) ); ?>
</div>
<?php endif; ?>
<?php endif; ?>
<?php do_action( 'lifterlms_order_meta_box_after_plan_information', $order ); ?>
<?php do_action( 'lifterlms_order_meta_box_before_product_information', $order ); ?>
<h4><?php esc_html_e( 'Product Information', 'lifterlms' ); ?></h4>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Name:', 'lifterlms' ); ?></label>
<?php if ( llms_get_post( $order->get( 'product_id' ) ) ) : ?>
<a href="<?php echo esc_url( get_edit_post_link( $order->get( 'product_id' ) ) ); ?>"><?php echo esc_html( $order->get( 'product_title' ) ); ?></a>
<?php else : ?>
<?php echo esc_html__( '[DELETED]', 'lifterlms' ) . ' ' . esc_html( $order->get( 'product_title' ) ); ?>
<?php endif; ?>
<small>(<?php echo esc_html( ucfirst( $order->get( 'product_type' ) ) ); ?>)</small>
</div>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'SKU:', 'lifterlms' ); ?></label>
<?php echo esc_html( $order->get( 'product_sku' ) ); ?>
</div>
<?php do_action( 'lifterlms_order_meta_box_after_product_information', $order ); ?>
</div>
<?php do_action( 'lifterlms_order_meta_box_before_payment_information', $order ); ?>
<div class="llms-metabox-section d-1of3">
<?php if ( $order->has_trial() ) : ?>
<h4><?php esc_html_e( 'Trial Information', 'lifterlms' ); ?></h4>
<?php if ( $order->has_coupon() && $order->get( 'coupon_amount_trial' ) ) : ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Original Total:', 'lifterlms' ); ?></label>
<?php echo wp_kses( $order->get_price( 'trial_original_total' ), LLMS_ALLOWED_HTML_PRICES ); ?>
</div>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Coupon Discount:', 'lifterlms' ); ?></label>
<?php echo wp_kses( $order->get_coupon_amount( 'trial' ), LLMS_ALLOWED_HTML_PRICES ); ?>
(<?php echo wp_kses( llms_price( $order->get_price( 'coupon_value_trial', array(), 'float' ) * - 1 ), LLMS_ALLOWED_HTML_PRICES ); ?>)
[<a href="<?php echo esc_url( get_edit_post_link( $order->get( 'coupon_id' ) ) ); ?>"><?php echo esc_html( $order->get( 'coupon_code' ) ); ?></a>]
</div>
<?php endif; ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Total:', 'lifterlms' ); ?></label>
<?php echo wp_kses( $order->get_price( 'trial_total' ), LLMS_ALLOWED_HTML_PRICES ); ?>
<?php echo esc_html( sprintf( _n( 'for %1$d %2$s', 'for %1$d %2$ss', $order->get( 'trial_length' ), 'lifterlms' ), $order->get( 'trial_length' ), $order->get( 'trial_period' ) ) ); ?>
</div>
<?php endif; ?>
<h4>
<?php esc_html_e( 'Payment Information', 'lifterlms' ); ?>
<?php if ( $order->is_recurring() ) : ?>
<button class="llms-editable" title="<?php esc_attr_e( 'Edit payment information', 'lifterlms' ); ?>">
<span class="dashicons dashicons-edit"></span>
<span class="screen-reader-text"><?php esc_html_e( 'Edit payment information', 'lifterlms' ); ?></span>
</button>
<?php endif; ?>
</h4>
<?php if ( $order->has_discount() ) : ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Original Total:', 'lifterlms' ); ?></label>
<?php echo wp_kses( $order->get_price( 'original_total' ), LLMS_ALLOWED_HTML_PRICES ); ?>
</div>
<?php if ( $order->has_sale() ) : ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Sale Discount:', 'lifterlms' ); ?></label>
<?php echo wp_kses( $order->get_price( 'sale_price' ), LLMS_ALLOWED_HTML_PRICES ); ?>
(<?php echo wp_kses( llms_price( $order->get_price( 'sale_value', array(), 'float' ) * -1 ), LLMS_ALLOWED_HTML_PRICES ); ?>)
</div>
<?php endif; ?>
<?php if ( $order->has_coupon() ) : ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Coupon Discount:', 'lifterlms' ); ?></label>
<?php echo wp_kses( $order->get_coupon_amount( 'regular' ), LLMS_ALLOWED_HTML_PRICES ); ?>
(<?php echo wp_kses( llms_price( $order->get_price( 'coupon_value', array(), 'float' ) * - 1 ), LLMS_ALLOWED_HTML_PRICES ); ?>)
[<a href="<?php echo esc_url( get_edit_post_link( $order->get( 'coupon_id' ) ) ); ?>"><?php echo esc_html( $order->get( 'coupon_code' ) ); ?></a>]
</div>
<?php endif; ?>
<?php endif; ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Total:', 'lifterlms' ); ?></label>
<?php if ( $order->is_recurring() ) : ?>
<div class="" data-llms-editable="total" data-llms-editable-required="yes" data-llms-editable-type="price" data-llms-editable-value="<?php echo esc_attr( $order->get( 'total' ) ); ?>">
<?php endif; ?>
<?php echo wp_kses( $order->get_price( 'total' ), LLMS_ALLOWED_HTML_PRICES ); ?>
<?php if ( $order->is_recurring() ) : ?>
</div>
<?php endif; ?>
<?php if ( $order->is_recurring() ) : ?>
<?php
//phpcs:disable WordPress.WP.I18n.MissingSingularPlaceholder -- We don't output the number so it's throwing an error but it's not broken.
echo esc_html(
sprintf(
// Translators: %1$d = The order billing period; %2$s = The order billing frequency.
_n( 'Every %2$s', 'Every %1$d %2$ss', $order->get( 'billing_frequency' ), 'lifterlms' ), // phpcs:ignore: WordPress.WP.I18n.MismatchedPlaceholders
$order->get( 'billing_frequency' ),
$order->get( 'billing_period' )
)
);
//phpcs:enable WordPress.WP.I18n.MissingSingularPlaceholder
?>
<?php if ( $order->get( 'billing_length' ) > 0 ) : ?>
<?php echo esc_html( sprintf( _n( 'for %1$d %2$s', 'for %1$d %2$ss', $order->get( 'billing_length' ), 'lifterlms' ), $order->get( 'billing_length' ), $order->get( 'billing_period' ) ) ); ?>
<?php endif; ?>
<?php else : ?>
<?php esc_html_e( 'One-time', 'lifterlms' ); ?>
<?php endif; ?>
</div>
<?php
if ( $order->has_plan_expiration() ) :
$remaining = $order->get_remaining_payments();
$remaining_input_min_val = 0 === $remaining ? 0 : 1;
?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Remaining Payments:', 'lifterlms' ); ?></label>
<span id="llms-remaining-payments-view"><?php echo esc_html( $remaining ); ?></span>
<?php if ( $supports_modify_recurring_payments ) : ?>
<?php add_thickbox(); ?>
<div id="llms-remaining-edit">
<div class="llms-remaining-edit--content">
<h4><?php esc_html_e( 'Modify Remaining Payments', 'lifterlms' ); ?></h4>
<label>
<span><?php esc_html_e( 'Remaining payments', 'lifterlms' ); ?></span>
<input type="number" id="llms-num-remaining-payments" value="<?php echo esc_attr( $remaining ); ?>" min="<?php echo esc_attr( $remaining_input_min_val ); ?>" step="1">
</label>
<label>
<span><?php esc_html_e( 'Order Note', 'lifterlms' ); ?></span>
<textarea id="llms-remaining-payments-note" rows="3"></textarea>
<em><?php esc_html_e( 'For internal use only, not visible to the customer.', 'lifterlms' ); ?></em>
</label>
<button id="llms-save-remaining-payments" class="button button-primary button-large"><?php esc_html_e( 'Save', 'lifterlms' ); ?></button>
<script>
(function(){
document.getElementById( 'llms-save-remaining-payments' ).addEventListener( 'click', function() {
var remainingEl = document.getElementById( 'llms-num-remaining-payments' ),
errEl = document.getElementById( 'llms-remaining-payments-err' ),
remaining = remainingEl.value,
note = document.getElementById( 'llms-remaining-payments-note' ).value;
if ( errEl ) {
errEl.remove();
}
if ( ! remainingEl.checkValidity() ) {
remainingEl.insertAdjacentHTML( 'afterend', '<em id="llms-remaining-payments-err" class="llms-error">' + remainingEl.validationMessage + '</em>' );
return;
}
tb_remove();
document.querySelector( 'input[name="_llms_remaining_payments"]' ).value = remaining;
document.querySelector( 'input[name="_llms_remaining_note"]' ).value = note;
document.getElementById( 'llms-remaining-payments-view' ).innerHTML = remaining;
} );
})();
</script>
</div>
</div>
<a href="#TB_inline?&width=300&height=400&inlineId=llms-remaining-edit" class="thickbox llms-metabox-icon">
<span class="dashicons dashicons-edit" role="img" aria-label="<?php esc_attr_e( 'Add additional payments', 'lifterlms' ); ?>"></span>
</a>
<input type="hidden" name="_llms_remaining_payments" value="<?php echo esc_attr( $remaining ); ?>">
<input type="hidden" name="_llms_remaining_note">
<?php endif; ?>
</div>
<?php endif; ?>
<?php do_action( 'lifterlms_order_meta_box_after_payment_information', $order ); ?>
</div>
<?php do_action( 'lifterlms_order_meta_box_before_customer_information', $order ); ?>
<div class="llms-metabox-section d-1of3">
<h4><?php esc_html_e( 'Customer Information', 'lifterlms' ); ?></h4>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Buyer Name:', 'lifterlms' ); ?></label>
<?php if ( llms_parse_bool( $order->get( 'anonymized' ) ) || empty( llms_get_student( $order->get( 'user_id' ) ) ) ) : ?>
<?php echo esc_html( $order->get_customer_name() ); ?>
<?php else : ?>
<?php
$edit_user_link = $order->get( 'user_id' ) ? get_edit_user_link( $order->get( 'user_id' ) ) : '';
echo ! $edit_user_link ? esc_html( $order->get_customer_name() ) . '<br>' : '<a href="' . esc_url( $edit_user_link ) . '">' . esc_html( $order->get_customer_name() ) . '</a>';
?>
<?php endif; ?>
</div>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Buyer Email:', 'lifterlms' ); ?></label>
<a href="<?php echo esc_url( 'mailto:' . $order->get( 'billing_email' ) ); ?>"><?php echo esc_html( $order->get( 'billing_email' ) ); ?></a>
</div>
<?php if ( $order->get( 'billing_address_1' ) ) : ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Buyer Address:', 'lifterlms' ); ?></label>
<?php echo esc_html( $order->get( 'billing_address_1' ) ); ?><br>
<?php if ( isset( $order->billing_address_2 ) ) : ?>
<?php echo esc_html( $order->get( 'billing_address_2' ) ); ?><br>
<?php endif; ?>
<?php echo esc_html( $order->get( 'billing_city' ) ); ?>,
<?php echo esc_html( $order->get( 'billing_state' ) ); ?>,
<?php echo esc_html( $order->get( 'billing_zip' ) ); ?><br>
<?php echo esc_html( llms_get_country_name( $order->get( 'billing_country' ) ) ); ?>
</div>
<?php endif; ?>
<?php if ( $order->get( 'billing_phone' ) ) : ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Buyer Phone:', 'lifterlms' ); ?></label>
<?php echo esc_html( $order->get( 'billing_phone' ) ); ?>
</div>
<?php endif; ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Buyer IP Address:', 'lifterlms' ); ?></label>
<?php echo esc_html( $order->get( 'user_ip_address' ) ); ?>
</div>
<?php do_action( 'lifterlms_order_meta_box_after_customer_information', $order ); ?>
</div>
<div class="clear"></div>
<?php do_action( 'lifterlms_order_meta_box_before_gateway_information', $order ); ?>
<?php if ( $gateway ) : ?>
<div class="llms-metabox-section d-all">
<h4>
<?php esc_html_e( 'Gateway Information', 'lifterlms' ); ?>
<button class="llms-editable" title="<?php esc_attr_e( 'Edit gateway information', 'lifterlms' ); ?>">
<span class="dashicons dashicons-edit"></span>
<span class="screen-reader-text"><?php esc_html_e( 'Edit gateway information', 'lifterlms' ); ?></span>
</button>
</h4>
<div class="llms-metabox-field d-1of4" data-gateway-fields='<?php echo wp_json_encode( $switchable_gateway_fields ); ?>' data-llms-editable="payment_gateway" data-llms-editable-options='<?php echo wp_json_encode( $switchable_gateways ); ?>' data-llms-editable-type="select" data-llms-editable-value="<?php echo esc_attr( $order->get( 'payment_gateway' ) ); ?>">
<label><?php esc_html_e( 'Name:', 'lifterlms' ); ?></label>
<?php echo is_wp_error( $gateway ) ? esc_html( $order->get( 'payment_gateway' ) ) : esc_html( $gateway->get_admin_title() ); ?>
</div>
<?php if ( ! is_wp_error( $gateway ) ) : ?>
<?php foreach ( $gateway->get_admin_order_fields() as $field => $data ) : ?>
<div class="llms-metabox-field d-1of4"<?php echo ! $data['enabled'] ? ' style="display:none;"' : ' '; ?>data-llms-editable="<?php echo esc_attr( $data['name'] ); ?>" data-llms-editable-required="yes" data-llms-editable-type="text" data-llms-editable-value="<?php echo esc_attr( $order->get( $data['name'] ) ); ?>">
<label><?php echo esc_html( $data['label'] ); ?></label>
<?php echo wp_kses_post( $gateway->get_item_link( $field, $order->get( $data['name'] ), $order->get( 'gateway_api_mode' ) ) ); ?>
</div>
<?php endforeach; ?>
<?php endif; ?>
<?php do_action( 'lifterlms_order_meta_box_after_gateway_information', $order ); ?>
</div>
<?php endif; ?>
<?php do_action( 'lifterlms_after_order_meta_box', $order ); ?>
</div>
================================================
FILE: includes/admin/views/metaboxes/view-order-submit.php
================================================
<?php
/**
* View for the LLMS_Meta_Box_Order_Submit metabox.
*
* @since 3.19.0
* @since 5.4.0 The order status dropdown is now limited to a subset of possible status.
* @version 7.0.0
*
* @property LLMS_Meta_Box_Order_Submit $this LLMS_Meta_Box_Order_Submit instance.
* @property LLMS_Order $order LLMS_Order instance.
*/
defined( 'ABSPATH' ) || exit;
$current_status = $order->get( 'status' );
$date_format = get_option( 'date_format' ) . ' ' . get_option( 'time_format' );
$statuses = llms_get_possible_order_statuses( $order );
$supports_modify_recurring_payments = $order->supports_modify_recurring_payments();
?>
<div class="llms-metabox">
<div class="llms-metabox-section d-all no-top-margin">
<div class="llms-metabox-field">
<label for="_llms_order_status"><?php esc_html_e( 'Update Order Status:', 'lifterlms' ); ?></label>
<select id="_llms_order_status" name="_llms_order_status">
<?php foreach ( $statuses as $key => $val ) : ?>
<option value="<?php echo esc_attr( $key ); ?>"<?php selected( $key, $current_status ); ?>><?php echo esc_html( $val ); ?></option>
<?php endforeach; ?>
</select>
</div>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Order Date', 'lifterlms' ); ?>:</label>
<?php echo esc_html( $order->get_date( 'date', $date_format ) ); ?>
</div>
<?php if ( $order->is_recurring() ) : ?>
<?php $next_time = $order->get_next_payment_due_date( 'U' ); ?>
<?php if ( $order->has_trial() ) : ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Trial End Date', 'lifterlms' ); ?>:</label>
<?php if ( $supports_modify_recurring_payments ) : ?>
<span
id="llms-editable-trial-end-date"
data-llms-editable="_llms_date_trial_end"
data-llms-editable-date-format="yy-mm-dd"
data-llms-editable-date-min="<?php echo esc_attr( $order->get_date( 'date', 'Y-m-d' ) ); ?>"
data-llms-editable-type="datetime"
data-llms-editable-value='<?php echo esc_attr( $this->get_editable_date_json( $order->get_trial_end_date( 'U' ) ) ); ?>'><?php echo esc_html( $order->get_trial_end_date( $date_format ) ); ?></span>
<?php if ( ! $order->has_trial_ended() ) : ?>
<a class="llms-editable" data-fields="#llms-editable-trial-end-date" href="#"><span class="dashicons dashicons-edit"></span></a>
<?php endif; ?>
<?php else : ?>
<span id="llms-trial-end-date"><?php echo esc_html( $order->get_trial_end_date( $date_format ) ); ?></span>
<?php endif; ?>
</div>
<?php endif; ?>
<?php if ( $order->is_recurring() && 'llms-pending-cancel' !== $current_status ) : ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Next Payment Date', 'lifterlms' ); ?>:</label>
<?php if ( is_wp_error( $next_time ) ) : ?>
<?php echo wp_kses_post( $next_time->get_error_message() ); ?>
<?php elseif ( $supports_modify_recurring_payments ) : ?>
<span
id="llms-editable-next-payment-date"
data-llms-editable="_llms_date_next_payment"
data-llms-editable-date-format="yy-mm-dd"
data-llms-editable-date-min="<?php echo esc_attr( current_time( 'Y-m-d' ) ); ?>"
data-llms-editable-type="datetime"
data-llms-editable-value='<?php echo esc_attr( $this->get_editable_date_json( $next_time ) ); ?>'><?php echo esc_html( date_i18n( $date_format, $next_time ) ); ?></span>
<a class="llms-editable" data-fields="#llms-editable-next-payment-date" href="#"><span class="dashicons dashicons-edit"></span></a>
<?php else : ?>
<span id="llms-next-payment-date"><?php echo esc_html( date_i18n( $date_format, $next_time ) ); ?></span>
<?php endif; ?>
</div>
<?php endif; ?>
<?php endif; ?>
<?php if ( llms_is_user_enrolled( $order->get( 'user_id' ), $order->get( 'product_id' ) ) ) : ?>
<?php $expire_time = $order->get_access_expiration_date( 'U' ); ?>
<div class="llms-metabox-field">
<label><?php esc_html_e( 'Access Expiration', 'lifterlms' ); ?>:</label>
<?php if ( ! is_numeric( $expire_time ) ) : ?>
<?php echo esc_html( $expire_time ); ?>
<?php else : ?>
<span
id="llms-editable-access-expires-date"
data-llms-editable="_llms_date_access_expires"
data-llms-editable-date-format="yy-mm-dd"
data-llms-editable-date-min="<?php echo esc_attr( current_time( 'Y-m-d' ) ); ?>"
data-llms-editable-type="datetime"
data-llms-editable-value='<?php echo esc_attr( $this->get_editable_date_json( $expire_time ) ); ?>'><?php echo esc_html( date_i18n( $date_format, $expire_time ) ); ?></span>
<a class="llms-editable" data-fields="#llms-editable-access-expires-date" href="#"><span class="dashicons dashicons-edit"></span></a>
<?php endif; ?>
</div>
<?php endif; ?>
<div class="clear"></div>
<div class="llms-metabox-field" style="text-align: right;">
<input name="save" type="submit" class="button button-primary button-large" id="publish" value="<?php esc_attr_e( 'Update Order', 'lifterlms' ); ?>">
</div>
</div>
</div>
================================================
FILE: includes/admin/views/notices/db-update.php
================================================
<?php
/**
* Pending database update notice.
*
* @package LifterLMS/Admin/Views/Notices
*
* @since 5.2.0
* @version 5.2.0
*/
defined( 'ABSPATH' ) || exit;
$base_url = ! empty( $_SERVER['REQUEST_URI'] ) ? esc_url_raw( wp_unslash( $_SERVER['REQUEST_URI'] ) ) : admin_url();
$url = wp_nonce_url( $base_url, 'do_db_updates', 'llms-db-update' );
?>
<p><strong><?php esc_html_e( 'The LifterLMS database needs to be updated to the latest version.', 'lifterlms' ); ?></strong></p>
<p><?php esc_html_e( "The update will only take a few minutes and it will run in the background. A notice like this will let you know when it's finished.", 'lifterlms' ); ?></p>
<p><?php printf( esc_html__( 'See the %1$sdatabase update log%2$s for a complete list of changes scheduled for each upgrade.', 'lifterlms' ), '<a href="https://lifterlms.com/docs/lifterlms-database-updates/" target="_blank">', '</a>' ); ?></p>
<p><a class="button-primary" id="llms-start-updater" href="<?php echo esc_url( $url ); ?>"><?php esc_html_e( 'Run the Updater', 'lifterlms' ); ?></a></p>
<script>
( function() {
document.getElementById( 'llms-start-updater' ).onclick = function( e ) {
var confirm = window.confirm( '<?php echo esc_js( __( 'We strongly recommended that you backup your database before proceeding. Are you sure you wish to run the updater now?', 'lifterlms' ) ); ?>' );
if ( ! confirm ) {
e.preventDefault();
}
};
} )();
</script>
================================================
FILE: includes/admin/views/notices/index.php
================================================
<?php // shhh.
================================================
FILE: includes/admin/views/notices/review-request.php
================================================
<?php
/**
* Review Request
*
* We're needy. Please tell us you like us, it means a lot.
*
* @package LifterLMS/Admin/Views
*
* @since 3.24.0
* @since 4.14.0 Added nonce to AJAX request.
* @version 4.14.0
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="notice notice-info is-dismissible llms-admin-notice llms-review-notice">
<div class="llms-admin-notice-icon"></div>
<div class="llms-admin-notice-content">
<?php // Translators: %s = number of active students. ?>
<p><?php printf( esc_html__( 'Hey there, we noticed you have more than %s active students on your site - that’s really awesome!', 'lifterlms' ), esc_html( number_format_i18n( $enrollments ) ) ); ?></p>
<p><?php esc_html_e( 'Could you please do us a BIG favor and give LifterLMS a 5-star rating on WordPress to help us grow?', 'lifterlms' ); ?></p>
<p>– <?php esc_html_e( 'Chris Badgett, CEO of LifterLMS', 'lifterlms' ); ?></p>
<p>
<a href="https://wordpress.org/support/plugin/lifterlms/reviews/#new-post" class="llms-button-primary small llms-review-notice-dismiss llms-review-notice-out" target="_blank" rel="noopener noreferrer"><?php esc_html_e( 'Ok, you deserve it', 'lifterlms' ); ?></a>
<button class="llms-button-secondary small llms-review-notice-dismiss"><?php esc_html_e( 'Nope, maybe later', 'lifterlms' ); ?></button>
<button class="llms-button-secondary small llms-review-notice-dismiss"><?php esc_html_e( 'I already did', 'lifterlms' ); ?></button>
</p>
</div>
</div>
<script>
jQuery( document ).ready( function ( $ ) {
$( document ).on( 'click', '.llms-review-notice-dismiss, .llms-review-notice .notice-dismiss', function ( event ) {
var success = 'yes';
if ( ! $( this ).hasClass( 'llms-review-notice-out' ) ) {
event.preventDefault();
success = 'no';
}
$.post( ajaxurl, {
action: 'llms_review_dismiss',
success: success,
nonce: '<?php echo esc_js( wp_create_nonce( 'llms-admin-review-request-dismiss' ) ); ?>',
} );
$( '.llms-review-notice' ).remove();
} );
} );
</script>
================================================
FILE: includes/admin/views/reporting/index.php
================================================
<?php // Shhhh.
================================================
FILE: includes/admin/views/reporting/widget.php
================================================
<?php
/**
* Reporting widget view.
*
* @package LifterLMS/Admin/Views/Reporting
*
* @since 6.11.0
*
* @var array $args Input arguments provided to {@see LLMS_Admin_Reporting::output_widget}.
* @var string $data_after Additional HTML to render inside the data display element.
* @var string $compare_class A CSS class name added to the compare element's class list.
* @var string $compare_operator The operator to display before the changed data value.
* @var string $compare_title A description of the previous data when displaying comparison data.
* @var bool|float $change The percent-change value when displaying comparisons or `false` when a comparison
* should not be displayed.
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="<?php echo esc_attr( $args['cols'] ); ?>">
<div class="llms-reporting-widget <?php echo esc_attr( $args['id'] ); ?>" id="<?php echo esc_attr( $args['id'] ); ?>">
<?php if ( $args['icon'] ) : ?>
<i class="fa fa-<?php echo esc_attr( $args['icon'] ); ?>" aria-hidden="true"></i>
<?php endif; ?>
<div class="llms-reporting-widget-data">
<strong><?php echo wp_kses_post( $args['data'] . $data_after ); ?></strong>
<?php if ( $change ) : ?>
<small class="compare tooltip <?php echo esc_attr( $compare_class ); ?>" title="<?php echo esc_attr( $compare_title ); ?>">
<?php echo wp_kses_post( $compare_operator . $change ); ?>%
</small>
<?php endif; ?>
</div>
<small><?php echo wp_kses_post( $args['text'] ); ?></small>
</div>
</div>
================================================
FILE: includes/admin/views/resources/getting-started.php
================================================
<?php
/**
* Getting Started links meta box HTML.
*
* @package LifterLMS/Admin/Views/Resources
*
* @since 7.4.1
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="llms-getting-started-links">
<div class="llms-list">
<ul>
<li><a href="https://lifterlms.com/docs/how-do-i-add-my-license-key-to-lifterlms/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'How to Activate Your License Key', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/how-to-create-a-course-with-lifterlms/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'How to Create a Course', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/what-is-an-access-plan/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'How to Set Up an Access Plans', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/getting-started-with-creating-memberships/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'How to Create a Membership', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/doc-category/features/engagements/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'How to Create Certificates and Engagements', 'lifterlms' ); ?></a></li>
</ul>
<a class="llms-button-primary" href="https://lifterlms.com/start-in-style/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'All Getting Started Resources', 'lifterlms' ); ?></a>
</div>
</div>
================================================
FILE: includes/admin/views/resources/index.php
================================================
<?php // Quiet.
================================================
FILE: includes/admin/views/resources/resource-links.php
================================================
<?php
/**
* Resource links meta box HTML.
*
* @package LifterLMS/Admin/Views/Resources
*
* @since 7.4.1
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="llms-resource-links">
<div class="llms-list">
<h3><span class="dashicons dashicons-admin-post"></span> <?php esc_html_e( 'Key Documentation', 'lifterlms' ); ?></h3>
<ul>
<li><a href="https://lifterlms.com/docs/shortcodes/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Shortcodes', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/what-payment-gateways-can-i-use-with-lifterlms/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'LifterLMS Payment Gateways', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/order-management/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Managing Orders', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/getting-started-with-lifterlms-and-woocommerce/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Integrating WooCommerce', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/membership-auto-enrollment/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Selling Bundled Courses', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/use-drip-content-lifterlms-lessons/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Dripping Content', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/use-lifterlms-language-english/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Translating LifterLMS', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/changes-to-the-wordpress-admin-for-lifterlms-5-0/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Editing Registration Forms', 'lifterlms' ); ?></a></li>
</ul>
<a class="llms-button-secondary" href="https://lifterlms.com/docs/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Knowledge Base', 'lifterlms' ); ?></a>
</div>
<div class="llms-list">
<h3><span class="dashicons dashicons-editor-code"></span> <?php esc_html_e( 'For Developers', 'lifterlms' ); ?></h3>
<ul>
<li><a href="https://make.lifterlms.com/category/release-notes/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Changelogs', 'lifterlms' ); ?></a></li>
<li><a href="https://developer.lifterlms.com/reference/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Code Reference', 'lifterlms' ); ?></a></li>
<li><a href="https://developer.lifterlms.com/rest-api/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'REST API', 'lifterlms' ); ?></a></li>
<li><a href="https://developer.lifterlms.com/cli/commands?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'LLMS-CLI', 'lifterlms' ); ?></a></li>
<li><a href="https://github.com/gocodebox/lifterlms-cs?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Coding Standards', 'lifterlms' ); ?></a></li>
<li><a href="https://github.com/gocodebox/lifterlms?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Github', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/contributing-to-lifterlms/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Contribute', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/slack/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Developer Slack Community', 'lifterlms' ); ?></a></li>
</ul>
<a class="llms-button-secondary" href="https://developer.lifterlms.com/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Developer Resources', 'lifterlms' ); ?></a>
</div>
<div class="llms-list">
<h3><span class="dashicons dashicons-hammer"></span> <?php esc_html_e( 'Common Hang-ups', 'lifterlms' ); ?></h3>
<ul>
<li><a href="https://lifterlms.com/docs/using-the-lifterlms-my-account-page-as-the-wordpress-front-page/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Student Dashboard as Front Page', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/caching-issues-faqs/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Caching Conflicts', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/why-do-i-get-a-notice-saying-my-license-key-is-no-longer-valid-and-was-deactivated/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'License Key Deactivated', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/a-guide-to-understanding-and-fixing-email-issues-in-lifterlms/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Emails Not Sending', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/docs/rerun-lifterlms-setup-wizard/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Rerun Set Up Wizard', 'lifterlms' ); ?></a></li>
</ul>
<a class="llms-button-action" href="https://lifterlms.com/my-account/my-tickets/new/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Contact Support', 'lifterlms' ); ?></a>
</div>
</div>
<hr />
<div class="llms-resource-links">
<div class="llms-list">
<h3><span class="dashicons dashicons-welcome-learn-more"></span> <?php esc_html_e( 'Courses & Case Studies', 'lifterlms' ); ?></h3>
<ul>
<li><a href="https://academy.lifterlms.com/course/how-to-build-a-learning-management-system-with-lifterlms/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'LifterLMS Quickstart Course', 'lifterlms' ); ?></a></li>
<li><a href="https://academy.lifterlms.com/course/the-complete-wordpress-for-beginners-masterclass/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'WordPress 101', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/success/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'LifterLMS Case Studies', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/lifterlms-webinars/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'LifterLMS Webinars', 'lifterlms' ); ?></a></li>
</ul>
</div>
<div class="llms-list">
<h3><span class="dashicons dashicons-heart"></span> <?php esc_html_e( 'Community Resources', 'lifterlms' ); ?></h3>
<ul>
<li><a href="https://lifterlms.com/community-events/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Virtual Events', 'lifterlms' ); ?></a></li>
<li><a href="https://www.facebook.com/lifterlms/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Facebook Group', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/experts/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'Experts for Hire', 'lifterlms' ); ?></a></li>
<li><a href="https://wordpress.org/support/plugin/lifterlms/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'WordPress Forums', 'lifterlms' ); ?></a></li>
</ul>
</div>
<div class="llms-list">
<h3><span class="dashicons dashicons-plugins-checked"></span> <?php esc_html_e( 'Third Party Stuff', 'lifterlms' ); ?></h3>
<ul>
<li><a href="https://lifterlms.com/recommended-resources/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page#third-party-lifterlms-add-ons" target="_blank" rel="noopener"><?php esc_html_e( 'Third Party Add-ons', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/recommended-resources/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page#forms-plugins" target="_blank" rel="noopener"><?php esc_html_e( 'Form Plugins', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/recommended-resources/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page#email-marketing-crm" target="_blank" rel="noopener"><?php esc_html_e( 'Email Marketing', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/recommended-resources/?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page#backups-and-security" target="_blank" rel="noopener"><?php esc_html_e( 'Backups and Security', 'lifterlms' ); ?></a></li>
<li><a href="https://lifterlms.com/recommended-resources?utm_source=LifterLMS%20Plugin&utm_medium=Resource%20Screen&utm_campaign=Backend%20Help%20Page" target="_blank" rel="noopener"><?php esc_html_e( 'More Recommendations', 'lifterlms' ); ?></a></li>
</ul>
</div>
</div>
================================================
FILE: includes/admin/views/resources/welcome-video.php
================================================
<?php
/**
* Welcome video meta box HTML.
*
* @package LifterLMS/Admin/Views/Resources
*
* @since 7.4.1
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="llms-welcome-video">
<p><?php esc_html_e( 'Thank you for choosing LifterLMS! This page is your command center, where you can find all of the basic information you need to start building your courses. Use the links on this page to quickly access support or any additional documentation you may need along the way.', 'lifterlms' ); ?></p>
<div class="llms-welcome-video-container">
<iframe width="762" height="428" src="https://www.youtube.com/embed/SWJKl4hs99g" title="How to Build an LMS Website - Getting Started with LifterLMS" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
</div>
</div>
================================================
FILE: includes/admin/views/resources.php
================================================
<?php
/**
* Resources Page HTML.
*
* @package LifterLMS/Admin/Views
*
* @since 7.4.1
* @version 7.4.1
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="wrap lifterlms lifterlms-settings llms-resources">
<div class="llms-subheader">
<h1><?php esc_html_e( 'LifterLMS Resources', 'lifterlms' ); ?></h1>
</div>
<div class="llms-inside-wrap">
<hr class="wp-header-end">
<form id="llms-resources-form" method="post" action="admin-post.php">
<div id="poststuff">
<div id="post-body" class="metabox-holder columns-2">
<div id="postbox-container-1" class="postbox-container">
<?php do_meta_boxes( 'toplevel_page_llms-resources', 'side', '' ); ?>
</div>
<div id="postbox-container-2" class="postbox-container">
<?php do_meta_boxes( 'toplevel_page_llms-resources', 'normal', '' ); ?>
</div>
<br class="clear">
</div> <!-- end metabox-holder -->
<?php wp_nonce_field( 'closedpostboxes', 'closedpostboxesnonce', false ); ?>
<?php wp_nonce_field( 'meta-box-order', 'meta-box-order-nonce', false ); ?>
</div> <!-- end poststuff -->
</form>
<script type="text/javascript">
//<![CDATA[
jQuery(document).ready( function($) {
// close postboxes that should be closed
$('.if-js-closed').removeClass('if-js-closed').addClass('closed');
// postboxes setup
postboxes.add_postbox_toggles('toplevel_page_llms-resources');
});
//]]>
</script>
</div>
</div> <!-- end .wrap.llms-resources -->
================================================
FILE: includes/admin/views/settings.php
================================================
<?php
/**
* Admin Settings Page HTML
*
* @since 1.0.0
* @version 3.29.0
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="wrap lifterlms lifterlms-settings">
<form action="" method="POST" id="mainform" enctype="multipart/form-data">
<div class="llms-subheader">
<h1><?php esc_html_e( 'Settings', 'lifterlms' ); ?></h1>
<?php if ( apply_filters( 'llms_settings_' . $current_tab . '_has_save_button', true ) ) : ?>
<div class="llms-save">
<?php do_action( 'llms_before_admin_settings_save_button', $current_tab ); ?>
<input name="save" class="llms-button-primary" type="submit" value="<?php echo esc_attr( apply_filters( 'llms_admin_settings_submit_button_text', __( 'Save Changes', 'lifterlms' ), $current_tab ) ); ?>" />
<?php wp_nonce_field( 'lifterlms-settings' ); ?>
<?php do_action( 'llms_after_admin_settings_save_button', $current_tab ); ?>
</div>
<?php endif; ?>
</div>
<nav class="llms-nav-tab-wrapper llms-nav-secondary">
<div class="llms-inside-wrap">
<?php do_action( 'lifterlms_before_settings_tabs' ); ?>
<ul class="llms-nav-items">
<?php
foreach ( $tabs as $name => $label ) :
$active = ( $current_tab === $name ) ? ' llms-active' : '';
?>
<li class="llms-nav-item<?php echo esc_attr( $active ); ?>"><a class="llms-nav-link" href="<?php echo esc_url( admin_url( 'admin.php?page=llms-settings&tab=' . $name ) ); ?>"><?php echo wp_kses_post( $label ); ?></a></li>
<?php endforeach; ?>
</ul>
<?php do_action( 'lifterlms_after_settings_tabs' ); ?>
</div>
</nav>
<div class="llms-inside-wrap">
<hr class="wp-header-end">
<h1 class="screen-reader-text"><?php echo esc_html( $tabs[ $current_tab ] ); ?></h1>
<?php do_action( 'lifterlms_settings_notices' ); ?>
<?php
do_action( 'lifterlms_sections_' . $current_tab );
do_action( 'lifterlms_settings_' . $current_tab );
do_action( 'lifterlms_settings_tabs_' . $current_tab );
?>
</div>
</form>
</div>
================================================
FILE: includes/admin/views/setup-wizard/index.php
================================================
<?php // Be quiet.
================================================
FILE: includes/admin/views/setup-wizard/main.php
================================================
<?php
/**
* Setup Wizard main view
*
* @package LifterLMS/Views/Admin/SetupWizard
*
* @since 4.4.4
* @since 4.8.0 Unknown.
* @since 7.4.0 Escape output.
* @version 7.4.0
*
* @property string[] $steps Array of setup wizard steps.
* @property string $current Slug of the current step.
* @property string|boolean $prev Slug of the previous step or `false` if no previous step found.
* @property string|boolean $next Slug of the next step or `false` if no next step found.
* @property string $step_html HTML content for the current step.
* @property LLMS_Admin_Setup_Wizard $this Setup wizard class instance.
*/
defined( 'ABSPATH' ) || exit;
?>
<div id="llms-setup-wizard">
<div class="llms-setup-wrapper">
<h1 id="llms-logo">
<a href="https://lifterlms.com/" target="_blank">
<img src="<?php echo esc_url( llms()->plugin_url() . '/assets/images/lifterlms-logo-black.png' ); ?>" alt="LifterLMS">
</a>
</h1>
<ul class="llms-setup-progress">
<?php foreach ( $steps as $slug => $step ) : ?>
<li<?php echo ( $slug === $current ) ? ' class="current"' : ''; ?>>
<a href="<?php echo esc_url( $this->get_step_url( $slug ) ); ?>"><?php echo esc_html( $step['title'] ?? '' ); ?></a>
</li>
<?php endforeach; ?>
</ul>
<div class="llms-setup-content">
<form action="" method="POST">
<?php
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in template files.
echo $step_html;
?>
<?php if ( is_wp_error( $this->error ) ) : ?>
<p class="error"><?php echo esc_html( $this->error->get_error_message() ); ?></p>
<?php endif; ?>
<p class="llms-setup-actions">
<?php if ( 'intro' === $current ) : ?>
<a href="<?php echo esc_url( admin_url() ); ?>" class="llms-button-secondary large"><?php esc_html_e( 'Skip setup', 'lifterlms' ); ?></a>
<a href="<?php echo esc_url( admin_url() . '?page=llms-setup&step=' . $this->get_next_step() ); ?>" class="llms-button-primary large"><?php esc_html_e( 'Get Started Now', 'lifterlms' ); ?></a>
<?php else : ?>
<a class="llms-exit-setup" data-confirm="<?php esc_attr_e( 'The site setup is incomplete! Are you sure you wish to exit?', 'lifterlms' ); ?>" href="<?php echo esc_url( admin_url( 'admin.php?page=llms-settings' ) ); ?>"><?php esc_html_e( 'Exit Setup', 'lifterlms' ); ?></a>
<?php if ( $next ) : ?>
<a href="<?php echo esc_url( $this->get_step_url( $next ) ); ?>" class="llms-button-secondary large">
<?php echo esc_html( $this->get_skip_text( $current ) ); ?>
</a>
<?php endif; ?>
<?php if ( 'finish' === $current ) : ?>
<a href="<?php echo esc_url( admin_url( 'post-new.php?post_type=course' ) ); ?>" class="llms-button-secondary large">
<?php esc_html_e( 'Start from Scratch', 'lifterlms' ); ?>
</a>
<?php endif; ?>
<button class="llms-button-primary large" type="submit" id="llms-setup-submit">
<?php echo esc_html( $this->get_save_text( $current ) ); ?>
</button>
<input id="llms-setup-current-step" name="llms_setup_save" type="hidden" value="<?php echo esc_attr( $current ); ?>">
<?php wp_nonce_field( 'llms_setup_save', 'llms_setup_nonce' ); ?>
<?php endif; ?>
</p>
</form>
</div>
</div>
</div>
<?php
================================================
FILE: includes/admin/views/setup-wizard/step-coupon.php
================================================
<?php
/**
* Setup Wizard step: Coupon
*
* @package LifterLMS/Views/Admin/SetupWizard
*
* @since 4.4.4
* @since 4.8.0 Unknown.
* @since 7.4.0 Escape output.
* @version 7.4.0
*
* @property LLMS_Admin_Setup_Wizard $this Setup wizard class instance.
*/
defined( 'ABSPATH' ) || exit;
?>
<h1><?php esc_html_e( 'Help Improve LifterLMS & Get a Coupon', 'lifterlms' ); ?></h1>
<p><?php esc_html_e( 'By allowing us to collect non-sensitive usage information and diagnostic data, you\'ll be providing us with information we can use to make the future of LifterLMS stronger and more powerful with every update!', 'lifterlms' ); ?></p>
<p><?php esc_html_e( 'Click "Allow" to and we\'ll send you a coupon immediately.', 'lifterlms' ); ?></p>
<p><a href="https://lifterlms.com/usage-tracking/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Wizard&utm_content=LifterLMS%20Usage%20Tracking" target="_blank"><?php esc_html_e( 'Find out more information', 'lifterlms' ); ?></a>.</p>
================================================
FILE: includes/admin/views/setup-wizard/step-finish.php
================================================
<?php
/**
* Setup Wizard step: Finish
*
* @package LifterLMS/Views/Admin/SetupWizard
*
* @since 4.4.4
* @since 4.8.0 Unknown.
* @since 7.4.0 Escape output.
* @version 7.4.0
*
* @property LLMS_Admin_Setup_Wizard $this Setup wizard class instance.
*/
defined( 'ABSPATH' ) || exit;
$courses = LLMS_Export_API::list( 1, 3 );
?>
<h1><?php esc_html_e( 'Setup Complete!', 'lifterlms' ); ?></h1>
<p><?php esc_html_e( 'Here\'s some resources to help you get familiar with LifterLMS:', 'lifterlms' ); ?></p>
<ul>
<li><span class="dashicons dashicons-format-video"></span> <a href="https://demo.lifterlms.com/course/how-to-build-a-learning-management-system-with-lifterlms/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Wizard&utm_content=LifterLMS%Video%20Tutorials" target="_blank"><?php esc_html_e( 'Watch the LifterLMS video tutorials', 'lifterlms' ); ?></a></li>
<li><span class="dashicons dashicons-admin-page"></span> <a href="https://lifterlms.com/docs/getting-started-guide-with-lifterlms-resources/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Wizard&utm_content=LifterLMS%Getting%20Started" target="_blank"><?php esc_html_e( 'Read the LifterLMS Getting Started Guide', 'lifterlms' ); ?></a></li>
</ul>
<br>
<?php if ( is_array( $courses ) && ! empty( $courses ) ) : ?>
<?php
// If there was an error fetching courses, the array might be details of the request vs. a WP_Error object.
foreach ( $courses as $course ) {
if ( ! is_array( $course ) || ! isset( $course['id'], $course['description'], $course['image'], $course['title'] ) ) {
$courses = new WP_Error( 'llms_invalid_course_data', __( 'There was an error loading importable courses. Please reload the page to try again.', 'lifterlms' ) );
break;
}
}
?>
<h1><?php esc_html_e( 'Import Sample Courses and Templates!', 'lifterlms' ); ?></h1>
<p><?php esc_html_e( 'Accelerate your progress by installing a quick LifterLMS training course and useful course templates.', 'lifterlms' ); ?></p>
<?php require LLMS_PLUGIN_DIR . 'includes/admin/views/importable-courses.php'; ?>
<div class="llms-importing-msgs">
<p class="llms-importing-msg single">
<?php
printf(
// Translators: %s = anchor link to LifterLMS.com.
esc_html__( 'The selected course will be downloaded and imported into this site from %s.', 'lifterlms' ),
'<a href="https://lifterlms.com/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Wizard&utm_content=LifterLMS%20Home" target="_blank">LifterLMS.com</a>'
);
?>
</p>
<p class="llms-importing-msg multiple">
<?php
printf(
// Translators: %1$s = The number of selected courses; %2$s = anchor link to LifterLMS.com.
esc_html__( 'The %1$s selected courses will be downloaded and imported into this site from %2$s.', 'lifterlms' ),
'<span id="llms-importing-number">2</span>',
'<a href="https://lifterlms.com/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Wizard&utm_content=LifterLMS%20Home" target="_blank">LifterLMS.com</a>'
);
?>
</p>
</div>
<?php endif; ?>
================================================
FILE: includes/admin/views/setup-wizard/step-intro.php
================================================
<?php
/**
* Setup Wizard step: Welcome
*
* @package LifterLMS/Views/Admin/SetupWizard
*
* @since 4.4.4
* @since 4.8.0 Unknown.
* @since 7.4.0 Escape output.
* @version 7.4.0
*
* @property LLMS_Admin_Setup_Wizard $this Setup wizard class instance.
*/
defined( 'ABSPATH' ) || exit;
?>
<h1><?php esc_html_e( 'Welcome to LifterLMS!', 'lifterlms' ); ?></h1>
<p><?php esc_html_e( 'Thanks for choosing LifterLMS to power your online courses! This short setup wizard will guide you through the basic settings and configure LifterLMS so you can get started creating courses faster!', 'lifterlms' ); ?></p>
<p><?php esc_html_e( 'It will only take a few minutes and it is completely optional. If you don\'t have the time now, come back later.', 'lifterlms' ); ?></p>
<?php
================================================
FILE: includes/admin/views/setup-wizard/step-pages.php
================================================
<?php
/**
* Setup Wizard step: Page Setup
*
* @since 4.4.4
* @since 7.3.0 Using the `LLMS_Install::get_pages()` method now.
* @since 7.4.0 Escape remaining strings.
* @version 7.4.0
*
* @property LLMS_Admin_Setup_Wizard $this Setup wizard class instance.
*/
defined( 'ABSPATH' ) || exit;
?>
<h1><?php esc_html_e( 'Page Setup', 'lifterlms' ); ?></h1>
<p><?php esc_html_e( 'LifterLMS has a few essential pages. The following will be created automatically if they don\'t already exist.', 'lifterlms' ); ?>
<table>
<?php
$pages = LLMS_Install::get_pages();
foreach ( $pages as $page ) {
// Skip pages that don't have all the info we want to show.
if ( empty( $page['docs_url'] ) || empty( $page['description'] ) || empty( $page['wizard_title'] ) ) {
continue;
}
?>
<tr>
<td><a href="<?php echo esc_url( $page['docs_url'] ); ?>" target="_blank"><?php echo esc_html( $page['wizard_title'] ); ?></a></td>
<td><p><?php echo esc_html( $page['description'] ); ?></p></td>
</tr>
<?php
}
?>
</table>
<p>
<?php
printf(
/* Translators: 1: Link to the Pages screen in the WordPress admin 2: Closing link tag 3: Link to the Appearance > Menus screen in the WordPress admin 4: Closing link tag. */
esc_html__( 'After setup, you can manage these pages from the admin dashboard on the %1$sPages screen%2$s and you can control which pages display on your menu(s) via %3$sAppearance > Menus%4$s.', 'lifterlms' ),
'<a href="' . esc_url( admin_url( 'edit.php?post_type=page' ) ) . '" target="_blank">',
'</a>',
'<a href="' . esc_url( admin_url( 'nav-menus.php' ) ) . '" target="_blank">',
'</a>'
);
?>
</p>
================================================
FILE: includes/admin/views/setup-wizard/step-payments.php
================================================
<?php
/**
* Setup Wizard step: Payments
*
* @package LifterLMS/Views/Admin/SetupWizard
*
* @since 4.4.4
* @since 4.8.0 Unknown.
* @since 7.4.0 Escape output.
* @version 7.4.0
*
* @property LLMS_Admin_Setup_Wizard $this Setup wizard class instance.
*/
defined( 'ABSPATH' ) || exit;
$country = get_lifterlms_country();
$currency = get_lifterlms_currency();
$payments = get_option( 'llms_gateway_manual_enabled', 'no' );
?>
<h1><?php esc_html_e( 'Payments', 'lifterlms' ); ?></h1>
<table>
<tr>
<td colspan="2">
<p><label for="llms_country"><?php esc_html_e( 'Which country should be used as the default for student registrations?', 'lifterlms' ); ?></label></p>
<p>
<select id="llms_country" name="country" class="llms-select2">
<?php foreach ( get_lifterlms_countries() as $code => $name ) : ?>
<option value="<?php echo esc_attr( $code ); ?>"<?php selected( $code, $country ); ?>>
<?php echo esc_html( $name . ' (' . $code . ')' ); ?>
</option>
<?php endforeach; ?>
</select>
</p>
</td>
</tr>
<tr>
<td colspan="2">
<p><label for="llms_currency"><?php esc_html_e( 'Which currency should be used for payment processing?', 'lifterlms' ); ?></label></p>
<p>
<select id="llms_currency" name="currency" class="llms-select2">
<?php foreach ( get_lifterlms_currencies() as $code => $name ) : ?>
<option value="<?php echo esc_attr( $code ); ?>"<?php selected( $code, $currency ); ?>><?php echo esc_html( $name ); ?> (<?php echo esc_html( get_lifterlms_currency_symbol( $code ) ); ?>)</option>
<?php endforeach; ?>
</select>
<i><?php printf( esc_html__( 'If your currency is not listed you can %1$sadd it later%2$s.', 'lifterlms' ), '<a href="https://lifterlms.com/docs/how-can-i-add-my-currency-to-lifterlms/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Wizard&utm_content=LifterLMS%20Add%20Currency" target="_blank">', '</a>' ); ?></i>
</p>
</td>
</tr>
<tr>
<td colspan="2">
<p><?php printf( esc_html__( 'With LifterLMS you can accept both online and offline payments. Be sure to install a %1$spayment gateway%2$s to accept online payments.', 'lifterlms' ), '<a href="https://lifterlms.com/product-category/plugins/payment-gateways/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Wizard&utm_content=LifterLMS%20Payment%20Add-ons" target="_blank">', '</a>' ); ?></p>
<p><label for="llms_manual"><input id="llms_manual" name="manual_payments" type="checkbox" value="yes"<?php checked( 'yes', $payments ); ?>> <?php esc_html_e( 'Enable Offline Payments', 'lifterlms' ); ?></label></p>
<p><?php echo esc_html__( 'Payment gateways may be configured under Settings in the "Checkout" tab.', 'lifterlms' ); ?></p>
</td>
</tr>
</table>
================================================
FILE: includes/admin/views/status/index.php
================================================
<?php // be quiet.
================================================
FILE: includes/admin/views/status/view-log.php
================================================
<?php
/**
* Log file viewer
*
* Used on the LifterLMS Admin Status Logs tab to output a single log file.
*
* @package LifterLMS/Admin/Views
*
* @since 3.37.14
* @version 3.37.14
*
* @property array[] $logs Associative array of log files. The array key is the file "slug" and the value is the file's absolute path.
* @property string $current Slug of the current log file.
* @property string $delete_url Nonce url to delete the log file (if the log is deletable).
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="llms-setting-group top">
<p class="llms-label"><?php esc_html_e( 'View and Manage Logs', 'lifterlms' ); ?></p>
<form action="<?php echo esc_url( LLMS_Admin_Page_Status::get_url( 'logs' ) ); ?>" method="POST">
<select name="llms_log_file">
<?php foreach ( $logs as $name => $file ) : ?>
<option value="<?php echo esc_attr( $name ); ?>" <?php selected( $current, $name ); ?>>
<?php echo esc_html( basename( $file ) ); ?>
(<?php echo esc_html( date_i18n( $date_format, filemtime( $file ) ) ); ?>)
</option>
<?php endforeach; ?>
</select>
<button class="llms-button-secondary small" type="submit"><?php esc_html_e( 'View Log', 'lifterlms' ); ?></button>
</form>
<hr />
<h2>
<?php
printf(
// Translators: %s = File name of the log.
esc_html__( 'Viewing: %s', 'lifterlms' ),
esc_html(
basename(
$logs[ $current ]
)
)
);
?>
<?php if ( $delete_url ) : ?>
<a class="llms-button-danger small" href="<?php echo esc_url( $delete_url ); ?>"><?php esc_html_e( 'Delete', 'lifterlms' ); ?></a>
<?php endif; ?>
</h2>
<div class="llms-log-viewer">
<pre><?php echo esc_html( file_get_contents( $logs[ $current ] ) ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents -- Not a remote URL. ?></pre>
</div>
</div>
================================================
FILE: includes/admin/views/user-edit-fields.php
================================================
<?php
/**
* Display LifterLMS Profile fields in admin user screen
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
if ( empty( $fields ) ) {
return;
}
?>
<div id="llms-profile-fields">
<h2><?php esc_html_e( 'LifterLMS Profile', 'lifterlms' ); ?></h2>
<?php array_map( 'llms_form_field', $fields, array_fill( 0, count( $fields ), true ), array_fill( 0, count( $fields ), $user ) ); ?>
<?php
$allow_unlimited = get_user_option( 'llms_allow_unlimited_quiz_time', is_numeric( $user ) ? $user : $user->ID );
$allow_unlimited = empty( $allow_unlimited ) ? 'no' : $allow_unlimited;
?>
<div class="llms-allow-unlimited-quiz-time llms-allow-unlimited-quiz-time-wrap">
<label for="llms_allow_unlimited_quiz_time">
<input name="llms_allow_unlimited_quiz_time" type="checkbox" id="llms_allow_unlimited_quiz_time" value="yes"<?php checked( 'yes', $allow_unlimited ); ?>>
<?php esc_html_e( 'Allow unlimited quiz time for quizzes that have a time limit set', 'lifterlms' ); ?>
</label>
</div>
</div>
================================================
FILE: includes/assets/index.php
================================================
<?php // Quiet.
================================================
FILE: includes/assets/llms-assets-scripts.php
================================================
<?php
/**
* The main LifterLMS Script Asset Definition list
*
* This file returns an array of script asset definition arrays.
*
* The array key of each definition is the asset's "handle" which
* is used by both LifterLMS and WordPress to identify the asset
* during registration and enqueue.
*
* The remaining items in each definition are optional and will be
* automatically populated with default values. See `LLMS_Assets::get_defaults()`
* for information on the default values of the asset.
*
* See `LLMS_Assets::get()` for full documentation on the properties
* of an asset definition.
*
* @package LifterLMS/Assets
*
* @since 4.4.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Scripts assets list.
*
* @since 4.4.0
* @since 4.8.0 Added llms-admin-setup.
* @since 5.0.0 Added llms-select2.
* @since 5.5.0 Added llms-addons.
* @since 6.0.0 Added llms-admin-certificate-editor.
* @since 6.10.0 Added llms-quill-wordcount.
* @since 7.0.0 Added llms-spinner.
* @since 7.4.0 Renamed llms-admin-setup to llms-admin-wizard.
* @since 7.5.0 Added llms-favorites.
*/
return array(
// Core.
'llms' => array(
'dependencies' => array( 'jquery', 'wp-i18n' ),
),
'llms-form-checkout' => array(
'dependencies' => array( 'jquery' ),
),
'llms-notifications' => array(
'dependencies' => array( 'jquery' ),
),
'llms-quiz' => array(
'dependencies' => array( 'jquery', 'llms', 'wp-mediaelement' ),
),
'llms-favorites' => array(
'dependencies' => array( 'jquery', 'llms' ),
),
// Admin.
'llms-addons' => array(
'asset_file' => true,
'file_name' => 'llms-admin-addons',
'suffix' => '',
),
'llms-admin-award-certificate' => array(
'asset_file' => true,
'suffix' => '',
),
'llms-admin-wizard' => array(
'dependencies' => array( 'jquery' ),
),
'llms-admin-forms' => array(
'dependencies' => array( 'wp-i18n' ),
),
'llms-admin-certificate-editor' => array(
'asset_file' => true,
'suffix' => '',
),
'llms-admin-media-protection-block-protect' => array(
'asset_file' => true,
'suffix' => '',
),
'llms-admin-elementor-editor' => array(
'asset_file' => true,
'suffix' => '',
),
// Modules.
'llms-components' => array(
'asset_file' => true,
'suffix' => '',
),
'llms-icons' => array(
'asset_file' => true,
'suffix' => '',
),
'llms-spinner' => array(
/**
* This script is automatically included in the `llms` script file.
*
* If your JS already defines `llms` as a dependency and you wish to use the `llms-spinner` it's recommended
* you don't also define this as a dependency as it will cause an superfluous HTTP request.
*/
'asset_file' => true,
'suffix' => '',
),
'llms-utils' => array(
'asset_file' => true,
'suffix' => '',
),
// Quill Modules.
'llms-quill-wordcount' => array(
'asset_file' => true,
'suffix' => '',
'dependencies' => array( 'llms-quill' ),
),
// Vendor.
'llms-iziModal' => array(
'file_name' => 'iziModal',
'path' => 'assets/vendor/izimodal',
'version' => '1.5.1',
),
'llms-jquery-matchheight' => array(
'file_name' => 'jquery.matchHeight',
'path' => 'assets/js/vendor/',
'suffix' => '',
'version' => '0.7.0',
'dependencies' => array( 'jquery' ),
),
'llms-select2' => array(
'file_name' => 'select2',
'path' => 'assets/vendor/select2/js',
'version' => '4.0.13',
'dependencies' => array( 'jquery' ),
),
'webui-popover' => array(
'file_name' => 'jquery.webui-popover',
'path' => 'assets/vendor/webui-popover',
'version' => '1.2.15',
'dependencies' => array( 'jquery' ),
),
);
================================================
FILE: includes/assets/llms-assets-styles.php
================================================
<?php
/**
* The main LifterLMS Stylesheet Asset Definition list
*
* This file returns an array of stylesheet asset definition arrays.
*
* The array key of each definition is the asset's "handle" which
* is used by both LifterLMS and WordPress to identify the asset
* during registration and enqueue.
*
* The remaining items in each definition are optional and will be
* automatically populated with default values. See `LLMS_Assets::get_defaults()`
* for information on the default values of the asset.
*
* See `LLMS_Assets::get()` for full documentation on the properties
* of an asset definition.
*
* @package LifterLMS/Assets
*
* @since 4.4.0
* @version 7.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Stylesheets assets list
*
* @since 4.4.0
* @since 4.4.4 Added llms-admin-setup.
* @since 4.8.0 Added llms-admin-importer.
* @since 5.0.0 Added llms-select2.
* @since 5.5.0 Added llms-admin-add-ons.
* @since 7.4.0 Renamed llms-admin-setup to llms-admin-wizard.
*/
return array(
// Core.
'lifterlms-styles' => array(
'file_name' => 'lifterlms',
),
'certificates' => array(),
// Admin.
'llms-admin-add-ons' => array(
'file_name' => 'llms-admin-addons',
'suffix' => '',
),
'llms-admin-wizard' => array(
'file_name' => 'admin-wizard',
),
'llms-admin-importer' => array(
'file_name' => 'admin-importer',
),
// Vendor.
'llms-iziModal' => array(
'file_name' => 'iziModal',
'path' => 'assets/vendor/izimodal',
'version' => '1.5.1',
'rtl' => false,
),
'llms-select2-styles' => array(
'file_name' => 'select2',
'path' => 'assets/vendor/select2/css',
'version' => '4.0.13',
'rtl' => false,
),
'webui-popover' => array(
'file_name' => 'jquery.webui-popover',
'path' => 'assets/vendor/webui-popover',
'version' => '1.2.15',
'rtl' => false,
),
);
================================================
FILE: includes/beaver-builder/index.php
================================================
<?php // shhhhh.
================================================
FILE: includes/beaver-builder/modules/course-author/class.llms.lab.course.author.module.php
================================================
<?php
/**
* LifterLMS Course Author Module
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseAuthor/Classes
*
* @since 1.3.0
* @version 1.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Course Author Module class.
*
* @since 1.3.0
*/
class LLMS_Lab_Course_Author_Module extends FLBUilderModule {
/**
* Constructor.
*
* @since 1.3.0
* @since 1.7.0 Escape strings.
*
* @return void
*/
public function __construct() {
parent::__construct(
array(
'name' => esc_html__( 'Course Author', 'lifterlms' ),
'description' => esc_html__( 'Displays the name, author, and bio for the author of a course.', 'lifterlms' ),
'category' => esc_html__( 'LifterLMS Modules', 'lifterlms' ),
'dir' => LLMS_BB_MODULES_DIR . 'course-author/',
'url' => LLMS_BB_MODULES_URL . 'course-author/',
'editor_export' => false,
'enabled' => true,
)
);
}
}
FLBuilder::register_module(
'LLMS_Lab_Course_Author_Module',
array(
'general' => array(
'title' => esc_html__( 'General', 'lifterlms' ),
'sections' => array(
'general' => array(
'title' => esc_html__( 'General', 'lifterlms' ),
'fields' => array(
'llms_course_id' => array(
'type' => 'suggest',
'action' => 'fl_as_posts',
'data' => 'course',
'limit' => 1,
'label' => esc_html__( 'Course', 'lifterlms' ),
'help' => esc_html__( 'Select the course to display the author from. Leave blank for the current course.', 'lifterlms' ),
'preview' => array(
'type' => 'none',
),
),
'llms_avatar_size' => array(
'default' => 48,
'type' => 'unit',
'label' => esc_html__( 'Avatar Size', 'lifterlms' ),
'description' => 'px',
'preview' => array(
'type' => 'none',
),
),
'llms_show_bio' => array(
'type' => 'select',
'label' => esc_html__( 'Display Author Bio', 'lifterlms' ),
'options' => array(
'no' => esc_html__( 'No', 'lifterlms' ),
'yes' => esc_html__( 'Yes', 'lifterlms' ),
),
'preview' => array(
'type' => 'none',
),
),
),
),
),
),
)
);
================================================
FILE: includes/beaver-builder/modules/course-author/includes/frontend.php
================================================
<?php
/**
* LifterLMS Course Author Module HTML.
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseAuthor/Templates
*
* @since 1.3.0
* @since 1.7.0 Escaped attributes.
* @version 1.7.0
*
* @param $settings obj Beaver Builder module settings instance.
*/
defined( 'ABSPATH' ) || exit;
$course_id = ! empty( $settings->llms_course_id ) ? $settings->llms_course_id : get_the_ID();
?>
<div class="llms-lab-course-author">
[lifterlms_course_author avatar_size="<?php echo esc_attr( $settings->llms_avatar_size ); ?>" bio="<?php echo esc_attr( $settings->llms_show_bio ); ?>" course_id="<?php echo esc_attr( $course_id ); ?>"]
</div>
================================================
FILE: includes/beaver-builder/modules/course-author/includes/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/course-author/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/course-continue-button/class.llms.lab.course.continue.button.module.php
================================================
<?php
/**
* LifterLMS Course Continue Button Module
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseContinueButton/Classes
*
* @since 1.3.0
* @version 1.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Course Continue Button Module class.
*
* @since 1.3.0
*/
class LLMS_Lab_Course_Continue_Button_Module extends FLBUilderModule {
/**
* Constructor.
*
* @since 1.3.0
* @since 1.7.0 Escape strings.
*
* @return void
*/
public function __construct() {
parent::__construct(
array(
'name' => esc_html__( 'Course Continue Button', 'lifterlms' ),
'description' => esc_html__( 'Displays a course progress bar for the current course.', 'lifterlms' ),
'category' => esc_html__( 'LifterLMS Modules', 'lifterlms' ),
'dir' => LLMS_BB_MODULES_DIR . 'course-continue-button/',
'url' => LLMS_BB_MODULES_URL . 'course-continue-button/',
'editor_export' => false,
'enabled' => true,
)
);
add_filter( 'llms_course_continue_button_next_lesson', array( $this, 'force_display' ) );
}
/**
* Force display.
*
* @since 1.7.0
*
* @param int $lesson_id WP_Post ID of the lesson.
* @return int
*/
public function force_display( $lesson_id ) {
if ( ! $lesson_id && FLBuilderModel::is_builder_active() ) {
return get_the_ID();
}
return $lesson_id;
}
}
FLBuilder::register_module(
'LLMS_Lab_Course_Continue_Button_Module',
array(
'general' => array(
'title' => esc_html__( 'General', 'lifterlms' ),
'sections' => array(
'general' => array(
'title' => esc_html__( 'General', 'lifterlms' ),
'fields' => array(
'llms_course_id' => array(
'type' => 'suggest',
'action' => 'fl_as_posts',
'data' => 'course',
'limit' => 1,
'label' => esc_html__( 'Course', 'lifterlms' ),
'help' => esc_html__( 'Select the course to display a continue button for. Leave blank for the current course.', 'lifterlms' ),
'preview' => array(
'type' => 'none',
),
),
),
),
),
),
)
);
================================================
FILE: includes/beaver-builder/modules/course-continue-button/includes/frontend.php
================================================
<?php
/**
* LifterLMS Course Continue Button Module HTML.
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseContinueButton/Templates
*
* @since 1.3.0
* @since 1.7.0 Escaped attributes.
* @version 1.7.0
*
* @param $settings obj Beaver Builder module settings instance.
*/
defined( 'ABSPATH' ) || exit;
$course_id = ! empty( $settings->llms_course_id ) ? $settings->llms_course_id : get_the_ID();
?>
<div class="llms-lab-course-continue-button">
[lifterlms_course_continue_button course_id="<?php echo esc_attr( $course_id ); ?>"]
</div>
================================================
FILE: includes/beaver-builder/modules/course-continue-button/includes/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/course-continue-button/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/course-instructors/class.llms.lab.course.instructors.module.php
================================================
<?php
/**
* LifterLMS Course Instructors Module
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseContinueButton/Classes
*
* @since 8.0.0
*/
defined( 'ABSPATH' ) || exit;
class LLMS_Lab_Course_Instructors_Module extends FLBUilderModule {
/**
* Constructor.
*
* @since 1.3.0
* @since 1.7.0 Escape strings.
*
* @return void
*/
public function __construct() {
parent::__construct(
array(
'name' => esc_html__( 'Course Instructors', 'lifterlms' ),
'description' => esc_html__( 'Displays instructors for the current course.', 'lifterlms' ),
'category' => esc_html__( 'LifterLMS Modules', 'lifterlms' ),
'dir' => LLMS_BB_MODULES_DIR . 'course-instructors/',
'url' => LLMS_BB_MODULES_URL . 'course-instructors/',
'editor_export' => false,
'enabled' => true,
)
);
}
}
FLBuilder::register_module( 'LLMS_Lab_Course_Instructors_Module', array() );
================================================
FILE: includes/beaver-builder/modules/course-instructors/includes/frontend.php
================================================
<?php
/**
* LifterLMS Course Continue Button Module HTML.
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseContinueButton/Templates
*
* @since 1.3.0
* @since 1.7.0 Escaped attributes.
* @version 1.7.0
*
* @param $settings obj Beaver Builder module settings instance.
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="llms-lab-course-instructors">
[lifterlms_course_instructors]
</div>
================================================
FILE: includes/beaver-builder/modules/course-instructors/includes/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/course-instructors/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/course-meta-info/class.llms.lab.course.meta.info.module.php
================================================
<?php
/**
* LifterLMS Course Meta Info Module Module
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseMetaInfo/Classes
*
* @since 1.3.0
* @version 1.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLifterLMS Course Meta Info Module class.
*
* @since 1.3.0
*/
class LLMS_Lab_Course_Meta_Info_Module extends FLBUilderModule {
/**
* Constructor.
*
* @since 1.3.0
* @since 1.7.0 Escape strings.
*
* @return void
*/
public function __construct() {
parent::__construct(
array(
'name' => esc_html__( 'Course Information', 'lifterlms' ),
'description' => esc_html__( 'Displays course information: length, difficulty, tracks, categories, and tags.', 'lifterlms' ),
'category' => esc_html__( 'LifterLMS Modules', 'lifterlms' ),
'dir' => LLMS_BB_MODULES_DIR . 'course-meta-info/',
'url' => LLMS_BB_MODULES_URL . 'course-meta-info/',
'editor_export' => false,
'enabled' => true,
)
);
}
}
FLBuilder::register_module(
'LLMS_Lab_Course_Meta_Info_Module',
array(
'general' => array(
'title' => esc_html__( 'General', 'lifterlms' ),
'sections' => array(
'general' => array(
'title' => esc_html__( 'General', 'lifterlms' ),
'fields' => array(
'llms_course_id' => array(
'type' => 'suggest',
'action' => 'fl_as_posts',
'data' => 'course',
'limit' => 1,
'label' => esc_html__( 'Course', 'lifterlms' ),
'help' => esc_html__( 'Select the course to display the course information from. Leave blank for the current course.', 'lifterlms' ),
'preview' => array(
'type' => 'none',
),
),
),
),
),
),
)
);
================================================
FILE: includes/beaver-builder/modules/course-meta-info/includes/frontend.php
================================================
<?php
/**
* LifterLMS Course Meta Info Module HTML.
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseMetaInfo/Templates
*
* @since 1.3.0
* @since 1.7.0 Escaped attributes.
* @version 1.7.0
*
* @param $settings obj Beaver Builder module settings instance.
*/
defined( 'ABSPATH' ) || exit;
$course_id = ! empty( $settings->llms_course_id ) ? $settings->llms_course_id : get_the_ID();
?>
<div class="llms-lab-course-meta-info">
[lifterlms_course_meta_info course_id="<?php echo esc_attr( $course_id ); ?>"]
</div>
================================================
FILE: includes/beaver-builder/modules/course-meta-info/includes/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/course-meta-info/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/course-progress-bar/class.llms.lab.course.progress.bar.module.php
================================================
<?php
/**
* LifterLMS Course Progress Bar Module
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseProgressBar/Classes
*
* @since 1.3.0
* @version 1.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Course Progress Module class.
*
* @since 1.3.0
*/
class LLMS_Lab_Course_Progress_Bar_Module extends FLBUilderModule {
/**
* Constructor.
*
* @since 1.3.0
* @since 1.7.0 Escape strings.
*
* @return void
*/
public function __construct() {
parent::__construct(
array(
'name' => esc_html__( 'Course Progress Bar', 'lifterlms' ),
'description' => esc_html__( 'Displays a course progress bar for the current course.', 'lifterlms' ),
'category' => esc_html__( 'LifterLMS Modules', 'lifterlms' ),
'dir' => LLMS_BB_MODULES_DIR . 'course-progress-bar/',
'url' => LLMS_BB_MODULES_URL . 'course-progress-bar/',
'editor_export' => false,
'enabled' => true,
)
);
}
}
FLBuilder::register_module( 'LLMS_Lab_Course_Progress_Bar_Module', array() );
================================================
FILE: includes/beaver-builder/modules/course-progress-bar/includes/frontend.php
================================================
<?php
/**
* LifterLMS Course Progress Bar Module HTML.
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseProgressBar/Templates
*
* @since 1.3.0
* @since 1.7.0 Escaped attributes.
* @version 1.7.0
*
* @param $settings obj Beaver Builder module settings instance.
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="llms-lab-course-progress-bar">
[lifterlms_course_progress]
</div>
================================================
FILE: includes/beaver-builder/modules/course-progress-bar/includes/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/course-progress-bar/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/course-syllabus/class.llms.lab.course.syllabus.module.php
================================================
<?php
/**
* LifterLMS Course Syllabus Module
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseSyllabus/Classes
*
* @since 1.3.0
* @version 1.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Course Syllabus Module class.
*
* @since 1.3.0
*/
class LLMS_Lab_Course_Syllabus_Module extends FLBUilderModule {
/**
* Constructor.
*
* @since 1.3.0
* @since 1.7.0 Escape strings.
*
* @return void
*/
public function __construct() {
parent::__construct(
array(
'name' => esc_html__( 'Course Syllabus', 'lifterlms' ),
'description' => esc_html__( 'Displays a course syllabus current course.', 'lifterlms' ),
'category' => esc_html__( 'LifterLMS Modules', 'lifterlms' ),
'dir' => LLMS_BB_MODULES_DIR . 'course-syllabus/',
'url' => LLMS_BB_MODULES_URL . 'course-syllabus/',
'editor_export' => false,
'enabled' => true,
)
);
}
}
FLBuilder::register_module( 'LLMS_Lab_Course_Syllabus_Module', array() );
================================================
FILE: includes/beaver-builder/modules/course-syllabus/includes/frontend.php
================================================
<?php
/**
* LifterLMS Course Syllabus Module HTML.
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/CourseSyllabus/Templates
*
* @since 1.3.0
* @since 1.7.0 Escaped attributes.
* @version 1.7.0
*
* @param $settings obj Beaver Builder module settings instance.
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="llms-lab-course-syllabus">
[lifterlms_course_syllabus]
</div>
================================================
FILE: includes/beaver-builder/modules/course-syllabus/includes/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/course-syllabus/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/lesson-mark-complete/class.llms.lab.lesson.mark.complete.module.php
================================================
<?php
/**
* LifterLMS Lesson Mark Complete Module
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/LessonMarkComplete/Classes
*
* @since 1.3.0
* @version 1.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Lesson Mark Complete Module class.
*
* @since 1.3.0
*/
class LLMS_Lab_Lesson_Mark_Complete_Module extends FLBUilderModule {
/**
* Constructor.
*
* @since 1.3.0
* @since 1.7.0 Escape strings.
*
* @return void
*/
public function __construct() {
parent::__construct(
array(
'name' => esc_html__( 'Lesson Mark Complete Button', 'lifterlms' ),
'description' => esc_html__( 'Displays the mark complete / incomplete button(s) for a lesson', 'lifterlms' ),
'category' => esc_html__( 'LifterLMS Modules', 'lifterlms' ),
'dir' => LLMS_BB_MODULES_DIR . 'lesson-mark-complete/',
'url' => LLMS_BB_MODULES_URL . 'lesson-mark-complete/',
'editor_export' => false,
'enabled' => true,
)
);
}
}
FLBuilder::register_module( 'LLMS_Lab_Lesson_Mark_Complete_Module', array() );
================================================
FILE: includes/beaver-builder/modules/lesson-mark-complete/includes/frontend.php
================================================
<?php
/**
* LifterLMS Lesson Mark Complete Module HTML.
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/LessonMarkComplete/Templates
*
* @since 1.3.0
* @since 1.7.0 Escaped strings.
* @version 1.7.0
*
* @param $settings obj Beaver Builder module settings instance.
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="llms-lab-lesson-mark-complete">
<?php if ( FLBuilderModel::is_builder_active() ) : ?>
<div class="clear"></div>
<div class="llms-lesson-button-wrapper">
<?php
llms_form_field(
array(
'columns' => 12,
'classes' => 'llms-button-primary auto button',
'id' => 'llms_mark_complete',
'value' => apply_filters( 'lifterlms_mark_lesson_complete_button_text', esc_html__( 'Mark Complete', 'lifterlms' ), llms_get_post( get_the_ID() ) ),
'last_column' => true,
'name' => 'mark_complete',
'required' => false,
'type' => 'submit',
)
);
?>
</div>
<?php else : ?>
[lifterlms_lesson_mark_complete]
<?php endif; ?>
</div>
================================================
FILE: includes/beaver-builder/modules/lesson-mark-complete/includes/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/lesson-mark-complete/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/membership-instructors/class.llms.lab.membership.instructors.module.php
================================================
<?php
/**
* LifterLMS Membership Instructors Module
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/MembershipInstructors/Classes
*
* @since 8.0.0
*/
defined( 'ABSPATH' ) || exit;
class LLMS_Lab_Membership_Instructors_Module extends FLBUilderModule {
public function __construct() {
parent::__construct(
array(
'name' => esc_html__( 'Membership Instructors', 'lifterlms' ),
'description' => esc_html__( 'Displays instructors for the current membership.', 'lifterlms' ),
'category' => esc_html__( 'LifterLMS Modules', 'lifterlms' ),
'dir' => LLMS_BB_MODULES_DIR . 'membership-instructors/',
'url' => LLMS_BB_MODULES_URL . 'membership-instructors/',
'editor_export' => false,
'enabled' => true,
)
);
}
}
FLBuilder::register_module( 'LLMS_Lab_Membership_Instructors_Module', array() );
================================================
FILE: includes/beaver-builder/modules/membership-instructors/includes/frontend.php
================================================
<?php
/**
* LifterLMS Membership Instructors HTML.
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/MembershipInstructors/Templates
*
* @since 8.0.0
*
* @param $settings obj Beaver Builder module settings instance.
*/
defined( 'ABSPATH' ) || exit;
?>
<div class="llms-lab-membership-instructors">
[lifterlms_membership_instructors]
</div>
================================================
FILE: includes/beaver-builder/modules/membership-instructors/includes/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/membership-instructors/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/pricing-table/class.llms.lab.pricing.table.module.php
================================================
<?php
/**
* LifterLMS Course/Membership Pricing Table Module HTML
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/PricingTable/Classes
*
* @since 1.3.0
* @version 1.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Course/Membership Pricing Table Module HTML class.
*
* @since 1.3.0
*/
class LLMS_Lab_Pricing_Table_Module extends FLBUilderModule {
/**
* Constructor.
*
* @since 1.3.0
* @since 1.7.0 Escape strings.
*
* @return void
*/
public function __construct() {
parent::__construct(
array(
'name' => esc_html__( 'Pricing Table', 'lifterlms' ),
'description' => esc_html__( 'LifterLMS Course / Membership Pricing Table', 'lifterlms' ),
'category' => esc_html__( 'LifterLMS Modules', 'lifterlms' ),
'dir' => LLMS_BB_MODULES_DIR . 'pricing-table/',
'url' => LLMS_BB_MODULES_URL . 'pricing-table/',
'editor_export' => false,
'enabled' => true,
)
);
// Ensure pricing tables always display when used within a BB module.
add_action( 'llms_lab_bb_before_pricing_table', array( $this, 'add_force_show_table_filter' ) );
add_action( 'lifterlms_after_access_plans', array( $this, 'remove_force_show_table_filter' ) );
// Ensure pricing tables always display when the frontend builder is active.
add_filter( 'llms_product_pricing_table_enrollment_status', array( $this, 'show_table' ) );
}
/**
* Force display of pricing tables within BB modules.
*
* @since 1.3.0
*
* @return void
*/
public function add_force_show_table_filter() {
add_filter( 'llms_product_pricing_table_enrollment_status', '__return_false' );
}
/**
* Remove force display after pricing tables within BB modules.
*
* @since 1.3.0
*
* @return void
*/
public function remove_force_show_table_filter() {
remove_filter( 'llms_product_pricing_table_enrollment_status', '__return_false' );
}
/**
* Get the product ID to be used based of BB module settings.
*
* @since 1.3.0
* @since 1.3.0 Use strict comparison for `in_array`.
*
* @param obj $settings BB node settings object.
* @return int|false
*/
public function get_product_id( $settings ) {
$type = $settings->llms_product_type;
if ( ! $type ) {
$id = get_the_ID();
} elseif ( 'course' === $type || 'membership' === $type ) {
$key = sprintf( 'llms_%s_id', $type );
$id = $settings->$key;
}
if ( in_array( get_post_type( $id ), array( 'lesson', 'llms_quiz' ), true ) ) {
$course = llms_get_post_parent_course( $id );
$id = $course->get( 'id' );
}
// If the current id isn't a course or membership don't proceed.
if ( ! in_array( get_post_type( $id ), array( 'course', 'llms_membership' ), true ) ) {
return false;
}
return $id;
}
/**
* Always show the pricing table when the builder is active.
*
* @since 1.3.0
*
* @param bool $enrollment Enrollment status of the current user.
* @return bool
*/
public function show_table( $enrollment ) {
if ( FLBuilderModel::is_builder_active() ) {
return false;
}
return $enrollment;
}
}
FLBuilder::register_module(
'LLMS_Lab_Pricing_Table_Module',
array(
'general' => array(
'title' => esc_html__( 'General', 'lifterlms' ),
'sections' => array(
'general' => array(
'title' => esc_html__( 'General', 'lifterlms' ),
'fields' => array(
'llms_product_type' => array(
'type' => 'select',
'label' => esc_html__( 'Product Type', 'lifterlms' ),
'options' => array(
'' => esc_html__( 'Current Course or Membership', 'lifterlms' ),
'course' => esc_html__( 'Course', 'lifterlms' ),
'membership' => esc_html__( 'Memebership', 'lifterlms' ),
),
'toggle' => array(
'course' => array(
'fields' => array( 'llms_course_id' ),
),
'membership' => array(
'fields' => array( 'llms_membership_id' ),
),
),
'preview' => array(
'type' => 'none',
),
),
'llms_course_id' => array(
'type' => 'suggest',
'action' => 'fl_as_posts',
'data' => 'course',
'limit' => 1,
'label' => esc_html__( 'Course', 'lifterlms' ),
'help' => esc_html__( 'Choose which course to display a pricing table for.', 'lifterlms' ),
'preview' => array(
'type' => 'none',
),
),
'llms_membership_id' => array(
'type' => 'suggest',
'action' => 'fl_as_posts',
'data' => 'llms_membership',
'limit' => 1,
'label' => esc_html__( 'Membership', 'lifterlms' ),
'help' => esc_html__( 'Choose which membership to display a pricing table for.', 'lifterlms' ),
'preview' => array(
'type' => 'none',
),
),
),
),
),
),
)
);
================================================
FILE: includes/beaver-builder/modules/pricing-table/includes/frontend.php
================================================
<?php
/**
* LifterLMS Course/Membership Pricing Table Module HTML.
*
* @package LifterLMS_Labs/Labs/BeaverBuilder/Modules/PricingTable/Templates
*
* @since 1.3.0
* @since 1.7.0 Escaped attributes.
* @version 1.7.0
*
* @param $settings obj Beaver Builder module settings instance.
*/
defined( 'ABSPATH' ) || exit;
$product_id = $module->get_product_id( $settings );
if ( ! $product_id ) {
return;
}
?>
<div class="llms-lab-pricing-table">
<?php do_action( 'llms_lab_bb_before_pricing_table', $product_id ); ?>
[lifterlms_pricing_table product="<?php echo esc_attr( $product_id ); ?>"]
<?php do_action( 'llms_lab_bb_after_pricing_table', $product_id ); ?>
</div>
================================================
FILE: includes/beaver-builder/modules/pricing-table/includes/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/pricing-table/index.php
================================================
<?php // silence.
================================================
FILE: includes/beaver-builder/modules/pricing-table/js/frontend.js
================================================
LLMS.Pricing_Tables.init();
================================================
FILE: includes/beaver-builder/templates/index.php
================================================
<?php // quiet.
================================================
FILE: includes/bricks/class-llms-bricks-element-course-author.php
================================================
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* LifterLMS Course Author class.
*
* @since 8.0.3
*/
class LLMS_Bricks_Element_Course_Author extends \Bricks\Element {
public $block = 'llms/course-author';
public $category = 'lifterlms';
public $name = 'llms-course-author';
public $icon = 'llms-bricks-icon llms-bricks-icon-course-author';
public $css_selector = '.llms-course-author-wrapper';
public $scripts = array();
public function get_label() {
return esc_html__( 'Course Author', 'lifterlms' );
}
public function set_control_groups() {
}
public function set_controls() {
$this->controls['avatar_size'] = array(
'tab' => 'content',
'label' => esc_html__( 'Avatar size', 'lifterlms' ),
'type' => 'slider',
'units' => array(
'px' => array(
'min' => 1,
'max' => 300,
'step' => 1,
),
),
'default' => 48,
'description' => esc_html__( 'The size of the avatar in pixels.', 'lifterlms' ),
);
$this->controls['bio'] = array(
'tab' => 'content',
'label' => esc_html__( 'Display Bio', 'lifterlms' ),
'type' => 'checkbox',
'inline' => false,
'small' => true,
'default' => true, // Default: false
);
$courses_posts = get_posts(
array(
'post_type' => 'course',
'posts_per_page' => -1, // Retrieve all posts
'post_status' => 'publish', // Only published posts
)
);
$courses = array(
'inherit' => __( 'Inherit from current course', 'lifterlms' ),
);
foreach ( $courses_posts as $course ) {
$courses[ $course->ID ] = $course->post_title;
}
$this->controls['course_id'] = array(
'tab' => 'content',
'label' => esc_html__( 'Course', 'lifterlms' ),
'type' => 'select',
'options' => $courses,
'inline' => false,
'clearable' => false,
'pasteStyles' => false,
'default' => 'inherit',
);
}
public function enqueue_scripts() {
}
public function convert_block_to_element_settings( $block, $attributes ) {
$element_settings = array(
'avatar_size' => isset( $attributes['avatar_size'] ) ? intval( $attributes['avatar_size'] ) : 48,
'bio' => ( isset( $attributes['bio'] ) && 'no' === $attributes['bio'] ) ? false : true,
'course_id' => isset( $attributes['course_id'] ) ? intval( $attributes['course_id'] ) : 'inherit',
);
return $element_settings;
}
public function render() {
$root_classes[] = 'llms-course-author-wrapper';
$this->set_attribute( '_root', 'class', $root_classes );
$avatar_size = isset( $this->settings['avatar_size'] ) && $this->settings['avatar_size'] ? intval( $this->settings['avatar_size'] ) : 48;
$bio = isset( $this->settings['bio'] ) && $this->settings['bio'] ? '' : 'no';
$course_id = isset( $this->settings['course_id'] ) && is_numeric( $this->settings['course_id'] ) ? intval( $this->settings['course_id'] ) : '';
echo "<div {$this->render_attributes( '_root' )}>"; // Element root attributes
echo do_shortcode( '[lifterlms_course_author avatar_size="' . esc_attr( $avatar_size ) . '" bio="' . esc_attr( $bio ) . '" course_id="' . $course_id . '"]' );
echo '</div>';
}
}
================================================
FILE: includes/bricks/class-llms-bricks-element-course-continue.php
================================================
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* LifterLMS Bricks Course Progress with Continue Button class.
*
* @since 8.0.3
*/
class LLMS_Bricks_Element_Course_Continue extends \Bricks\Element {
public $block = 'llms/course-continue';
public $category = 'lifterlms';
public $name = 'llms-course-continue';
public $icon = 'llms-bricks-icon llms-bricks-icon-course-continue';
public $css_selector = '.llms-course-continue';
public $scripts = array();
public function get_label() {
return esc_html__( 'Course Progress with Continue Button', 'lifterlms' );
}
public function set_control_groups() {
}
public function set_controls() {
$courses_posts = get_posts(
array(
'post_type' => 'course',
'posts_per_page' => -1, // Retrieve all posts
'post_status' => 'publish', // Only published posts
)
);
$courses = array(
'inherit' => __( 'Inherit from current course', 'lifterlms' ),
);
foreach ( $courses_posts as $course ) {
$courses[ $course->ID ] = $course->post_title;
}
$this->controls['course_id'] = array(
'tab' => 'content',
'label' => esc_html__( 'Course', 'lifterlms' ),
'type' => 'select',
'options' => $courses,
'inline' => false,
'clearable' => false,
'pasteStyles' => false,
'default' => 'inherit',
);
}
public function enqueue_scripts() {
}
public function convert_block_to_element_settings( $block, $attributes ) {
$element_settings = array(
'course_id' => isset( $attributes['course_id'] ) ? intval( $attributes['course_id'] ) : 'inherit',
);
return $element_settings;
}
public function render() {
$root_classes[] = 'llms-course-meta-info';
$this->set_attribute( '_root', 'class', $root_classes );
$course_id = isset( $this->settings['course_id'] ) && is_numeric( $this->settings['course_id'] ) ? intval( $this->settings['course_id'] ) : '';
echo "<div {$this->render_attributes( '_root' )}>"; // Element root attributes
echo do_shortcode( '[lifterlms_course_continue course_id="' . $course_id . '"]' );
echo '</div>';
}
}
================================================
FILE: includes/bricks/class-llms-bricks-element-course-information.php
================================================
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* LifterLMS Bricks Course Information class.
*
* @since 8.0.3
*/
class LLMS_Bricks_Element_Course_Information extends \Bricks\Element {
public $block = 'llms/course-information';
public $category = 'lifterlms';
public $name = 'llms-course-information';
public $icon = 'llms-bricks-icon llms-bricks-icon-course-information';
public $css_selector = '.llms-course-information-wrapper';
public $scripts = array();
public function get_label() {
return esc_html__( 'Course Information', 'lifterlms' );
}
public function set_control_groups() {
}
public function set_controls() {
// Convert to nested elements.
$this->controls['title'] = array(
'tab' => 'content',
'label' => esc_html__( 'Title', 'lifterlms' ),
'type' => 'text',
'default' => esc_html__( 'Course Information', 'lifterlms' ),
);
$this->controls['title_size'] = array(
'tab' => 'content',
// 'group' => 'settings',
'label' => esc_html__( 'Title Headline Size', 'lifterlms' ),
'type' => 'select',
'options' => array(
'h1' => esc_html__( 'h1', 'lifterlms' ),
'h2' => esc_html__( 'h2', 'lifterlms' ),
'h3' => esc_html__( 'h3', 'lifterlms' ),
'h4' => esc_html__( 'h4', 'lifterlms' ),
'h5' => esc_html__( 'h5', 'lifterlms' ),
'h6' => esc_html__( 'h6', 'lifterlms' ),
),
'inline' => true,
'clearable' => false,
'pasteStyles' => false,
'default' => 'h2',
);
}
public function enqueue_scripts() {
}
public function convert_block_to_element_settings( $block, $attributes ) {
$element_settings = array(
'title' => isset( $attributes['title'] ) ? $attributes['title'] : __( 'Course Information', 'lifterlms' ),
'title_size' => isset( $attributes['title_size'] ) ? $attributes['title_size'] : 'h2',
);
return $element_settings;
}
public function render() {
$root_classes[] = 'llms-course-information-wrapper';
$this->set_attribute( '_root', 'class', $root_classes );
$title = $this->settings['title'] ? $this->settings['title'] : __( 'Course Information', 'lifterlms' );
$title_size = $this->settings['title_size'] ? $this->settings['title_size'] : 'h2';
echo "<div {$this->render_attributes( '_root' )}>"; // Element root attributes
echo wp_kses_post( "<{$title_size} class='llms-meta-title'>{$title}</{$title_size}>" );
echo do_shortcode( '[lifterlms_course_meta_info]' );
echo '</div>';
}
}
================================================
FILE: includes/bricks/class-llms-bricks-element-course-meta-info.php
================================================
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* LifterLMS Bricks Course Meta Info class.
*
* @since 8.0.3
*/
class LLMS_Bricks_Element_Course_Meta_Info extends \Bricks\Element {
public $block = 'llms/course-meta-info';
public $category = 'lifterlms';
public $name = 'llms-course-meta-info';
public $icon = 'llms-bricks-icon llms-bricks-icon-course-meta-info';
public $css_selector = '.llms-course-meta-info';
public $scripts = array();
public function get_label() {
return esc_html__( 'Course Meta Information', 'lifterlms' );
}
public function set_control_groups() {
}
public function set_controls() {
$courses_posts = get_posts(
array(
'post_type' => 'course',
'posts_per_page' => -1, // Retrieve all posts
'post_status' => 'publish', // Only published posts
)
);
$courses = array(
'inherit' => __( 'Inherit from current course', 'lifterlms' ),
);
foreach ( $courses_posts as $course ) {
$courses[ $course->ID ] = $course->post_title;
}
$this->controls['course_id'] = array(
'tab' => 'content',
'label' => esc_html__( 'Course', 'lifterlms' ),
'type' => 'select',
'options' => $courses,
'inline' => false,
'clearable' => false,
'pasteStyles' => false,
'default' => 'inherit',
);
}
public function enqueue_scripts() {
}
public function convert_block_to_element_settings( $block, $attributes ) {
$element_settings = array(
'course_id' => isset( $attributes['course_id'] ) ? intval( $attributes['course_id'] ) : 'inherit',
);
return $element_settings;
}
public function render() {
$root_classes[] = 'llms-course-meta-info';
$this->set_attribute( '_root', 'class', $root_classes );
$course_id = isset( $this->settings['course_id'] ) && is_numeric( $this->settings['course_id'] ) ? intval( $this->settings['course_id'] ) : '';
echo "<div {$this->render_attributes( '_root' )}>"; // Element root attributes
echo do_shortcode( '[lifterlms_course_meta_info course_id="' . $course_id . '"]' );
echo '</div>';
}
}
================================================
FILE: includes/bricks/class-llms-bricks-element-course-progress.php
================================================
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* LifterLMS Bricks Course Progress class.
*
* @since 8.0.3
*/
class LLMS_Bricks_Element_Course_Progress extends \Bricks\Element {
public $block = 'llms/course-progress';
public $category = 'lifterlms';
public $name = 'llms-course-progress';
public $icon = 'llms-bricks-icon llms-bricks-icon-course-progress';
public $css_selector = '.llms-course-progress-wrapper';
public $scripts = array();
public function get_label() {
return esc_html__( 'Course Progress', 'lifterlms' );
}
public function set_control_groups() {
}
public function set_controls() {
}
public function enqueue_scripts() {
}
public function convert_block_to_element_settings( $block, $attributes ) {
// Need to return an array of something for it to be converted.
return array( 'setting' => true );
}
public function render() {
$root_classes[] = 'llms-course-progress-wrapper';
$this->set_attribute( '_root', 'class', $root_classes );
echo "<div {$this->render_attributes( '_root' )}>"; // Element root attributes
echo do_shortcode( '[lifterlms_course_progress]' );
echo '</div>';
}
}
================================================
FILE: includes/bricks/class-llms-bricks-element-course-syllabus.php
================================================
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* LifterLMS Bricks Course Syllabus class.
*
* @since 8.0.3
*/
class LLMS_Bricks_Element_Course_Syllabus extends \Bricks\Element {
public $block = 'llms/course-syllabus';
public $category = 'lifterlms';
public $name = 'llms-course-syllabus';
public $icon = 'llms-bricks-icon llms-bricks-icon-course-syllabus';
public $css_selector = '.llms-course-syllabus';
public $scripts = array();
public function get_label() {
return esc_html__( 'Course Syllabus', 'lifterlms' );
}
public function set_control_groups() {
}
public function set_controls() {
$courses_posts = get_posts(
array(
'post_type' => 'course',
'posts_per_page' => -1, // Retrieve all posts
'post_status' => 'publish', // Only published posts
)
);
$courses = array(
'inherit' => __( 'Inherit from current course', 'lifterlms' ),
);
foreach ( $courses_posts as $course ) {
$courses[ $course->ID ] = $course->post_title;
}
$this->controls['course_id'] = array(
'tab' => 'content',
'label' => esc_html__( 'Course', 'lifterlms' ),
'type' => 'select',
'options' => $courses,
'inline' => false,
'clearable' => false,
'pasteStyles' => false,
'default' => 'inherit',
);
}
public function enqueue_scripts() {
}
public function convert_block_to_element_settings( $block, $attributes ) {
$element_settings = array(
'course_id' => isset( $attributes['course_id'] ) ? intval( $attributes['course_id'] ) : 'inherit',
);
return $element_settings;
}
public function render() {
$root_classes[] = 'llms-course-syllabus';
$this->set_attribute( '_root', 'class', $root_classes );
$course_id = isset( $this->settings['course_id'] ) && is_numeric( $this->settings['course_id'] ) ? intval( $this->settings['course_id'] ) : '';
echo "<div {$this->render_attributes( '_root' )}>"; // Element root attributes
echo do_shortcode( '[lifterlms_course_syllabus course_id="' . $course_id . '"]' );
echo '</div>';
}
}
================================================
FILE: includes/bricks/class-llms-bricks-element-instructors.php
================================================
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* LifterLMS Bricks Instructors class.
*
* @since 8.0.3
*/
class LLMS_Bricks_Element_Instructors extends \Bricks\Element {
public $block = 'llms/instructors';
public $category = 'lifterlms';
public $name = 'llms-instructors';
public $icon = 'llms-bricks-icon llms-bricks-icon-instructors';
public $css_selector = '.llms-instructors';
public $scripts = array();
public function get_label() {
return esc_html__( 'Instructors', 'lifterlms' );
}
public function set_control_groups() {
}
public function set_controls() {
}
public function enqueue_scripts() {
}
public function convert_block_to_element_settings( $block, $attributes ) {
// Need to return an array of something for it to be converted.
return array( 'setting' => true );
}
public function render() {
$root_classes[] = 'llms-instructors';
$this->set_attribute( '_root', 'class', $root_classes );
echo "<div {$this->render_attributes( '_root' )}>"; // Element root attributes
if ( 'llms_membership' === get_post_type() ) {
echo do_shortcode( '[lifterlms_membership_instructors]' );
} else {
echo do_shortcode( '[lifterlms_course_instructors]' );
}
echo '</div>';
}
}
================================================
FILE: includes/bricks/class-llms-bricks-element-lesson-progression.php
================================================
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* LifterLMS Bricks Lesson Progression class.
*
* @since 8.0.3
*/
class LLMS_Bricks_Element_Lesson_Progression extends \Bricks\Element {
public $block = 'llms/lesson-progression';
public $category = 'lifterlms';
public $name = 'llms-lesson-progression';
public $icon = 'llms-bricks-icon llms-bricks-icon-lesson-progression';
public $css_selector = '.llms-lesson-progression-wrapper';
public $scripts = array();
public function get_label() {
return esc_html__( 'Lesson Progression (Mark Complete)', 'lifterlms' );
}
public function set_control_groups() {
}
public function set_controls() {
}
public function enqueue_scripts() {
}
public function convert_block_to_element_settings( $block, $attributes ) {
// Need to return an array of something for it to be converted.
return array( 'setting' => true );
}
public function render() {
$root_classes[] = 'llms-lesson-progression-wrapper';
$this->set_attribute( '_root', 'class', $root_classes );
echo "<div {$this->render_attributes( '_root' )}>"; // Element root attributes
echo do_shortcode( '[lifterlms_lesson_mark_complete]' );
echo '</div>';
}
}
================================================
FILE: includes/bricks/class-llms-bricks-element-pricing-table.php
================================================
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
/**
* LifterLMS Bricks Pricing Table class.
*
* @since 8.0.3
*/
class LLMS_Bricks_Element_Pricing_Table extends \Bricks\Element {
public $block = 'llms/pricing-table';
public $category = 'lifterlms';
public $name = 'llms-pricing-table';
public $icon = 'llms-bricks-icon llms-bricks-icon-pricing-table';
public $css_selector = '.llms-pricing-table-wrapper';
public $scripts = array();
public function get_label() {
return esc_html__( 'LifterLMS Pricing Table', 'lifterlms' );
}
public function set_control_groups() {
}
public function set_controls() {
}
public function enqueue_scripts() {
}
public function convert_block_to_element_settings( $block, $attributes ) {
// TODO: Visibility settings.
// Need to return an array of something for it to be converted.
return array( 'setting' => true );
}
public function render() {
$root_classes[] = 'llms-pricing-table-wrapper';
$this->set_attribute( '_root', 'class', $root_classes );
echo "<div {$this->render_attributes( '_root' )}>"; // Element root attributes
echo do_shortcode( '[lifterlms_pricing_table]' );
echo '</div>';
}
}
================================================
FILE: includes/certificates/class.llms.certificate.user.php
================================================
<?php
/**
* Certificate
*
* @package LifterLMS/Classes/Certificates
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Certificate class
*
* Generates certificate post for user, triggered from engagement.
*
* @since 1.0.0
* @since 3.30.3 Explicitly define class properties.
* @deprecated 6.0.0 Class `LLMS_Certificate_User` is deprecated with no direct replacement.
*/
class LLMS_Certificate_User extends LLMS_Certificate {
/**
* @var string|false
* @since 1.0.0
*/
public $account_link;
/**
* @var string
* @since 1.0.0
*/
public $email_content;
/**
* @var string
* @since 1.0.0
*/
public $recipient;
/**
* partial path and file name of HTML template
*
* @var string
* @since 1.0.0
*/
public $template_html;
/**
* @var array
* @since 1.0.0
*/
public $user = array();
/**
* @var WP_User|false
* @since 1.0.0
*/
public $user_data;
/**
* @var string
* @since 1.0.0
*/
public $user_email;
/**
* @var string
* @since 1.0.0
*/
public $user_firstname;
/**
* @var string
* @since 1.0.0
*/
public $user_lastname;
/**
* @var string
* @since 1.0.0
*/
public $user_login;
/**
* @var string
* @since 1.0.0
*/
public $user_pass;
/**
* Alert when deprecated methods are used.
*
* This class as well as core classes extending it have been deprecated. All public and protected methods
* have been changed to private and will be made accessible through this magic method which also emits a
* deprecation warning.
*
* This public method has been intentionally marked as private to denote it's temporary lifespan. It will be
* removed alongside this class in the next major release.
*
* @since 6.0.0
*
* @access private
*
* @param string $name Name of the method being called.
* @param array $args Arguments provided to the method.
* @return void
*/
public function __call( $name, $args ) {
_deprecated_function( __CLASS__ . '::' . esc_html( $name ), '6.0.0' );
if ( method_exists( $this, $name ) ) {
$this->$name( ...$args );
}
}
/**
* Check if the user has already earned this achievement used to prevent duplicates
*
* @since 3.4.1
* @since 3.17.4 Unknown.
*
* @return boolean
*/
private function has_user_earned() {
global $wpdb;
$count = (int) $wpdb->get_var(
$wpdb->prepare(
"
SELECT COUNT( pm.meta_id )
FROM {$wpdb->postmeta} AS pm
JOIN {$wpdb->prefix}lifterlms_user_postmeta AS upm ON pm.post_id = upm.meta_value
WHERE pm.meta_key = '_llms_certificate_template'
AND pm.meta_value = %d
AND upm.meta_key = '_certificate_earned'
AND upm.user_id = %d
AND upm.post_id = %d
LIMIT 1
;",
array( $this->certificate_template_id, $this->userid, $this->lesson_id )
)
);
/**
* Deprecated.
*
* @since Unknown.
* @deprecated 6.0.0 Filter `llms_certificate_has_user_earned` is deprecated in favor of `llms_earned_certificate_dupcheck`.
*
* @param boolean $has_earned Whether or not the certificate has been earned.
* @param LLMS_Certificate_User $user_cert The user certificate object.
*/
return apply_filters_deprecated( 'llms_certificate_has_user_earned', array( ( $count >= 1 ), $this ), 'llms_earned_certificate_dupcheck' );
}
/**
* Sets up data needed to generate certificate.
*
* @since Unknown
* @since 3.24.0 Unknown.
* @deprecated 6.0.0 `LLMS_Certificate_User::init()` is deprecated with no replacement.
*
* @param int $email_id ID of Certificate.
* @param int $person_id ID of the user receiving the certificate.
* @param int $lesson_id ID of associated lesson.
* @return void
*/
private function init( $email_id, $person_id, $lesson_id ) {
global $wpdb;
$email_content = get_post( $email_id );
$email_meta = get_post_meta( $email_content->ID );
$this->certificate_template_id = $email_id;
$this->lesson_id = $lesson_id;
$this->title = $email_content->post_title;
$this->certificate_title = $email_meta['_llms_certificate_title'][0] ?? $email_content->post_title;
$this->content = $email_content->post_content;
$this->image = $email_meta['_llms_certificate_image'][0] ?? '';
$this->userid = $person_id;
$this->user = get_user_meta( $person_id );
$this->user_data = get_userdata( $person_id );
$this->user_firstname = ( '' != $this->user['first_name'][0] ? $this->user['first_name'][0] : $this->user['nickname'][0] );
$this->user_lastname = ( '' != $this->user['last_name'][0] ? $this->user['last_name'][0] : '' );
$this->user_email = $this->user_data->data->user_email;
$this->template_html = 'certificates/template.php';
$this->email_content = $email_content->post_content;
$this->account_link = get_permalink( llms_get_page_id( 'myaccount' ) );
$this->user_login = $this->user_data->user_login;
}
/**
* Award the cert to a user.
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Certificate_User::trigger()` is deprecated with no replacement.
*
* @param int $user_id ID of the user receiving the certificate.
* @param int $email_id ID of the certificate.
* @param int $lesson_id ID of the associated lesson.
*
* @return void
*/
private function trigger( $user_id, $email_id, $lesson_id ) {
$this->init( $email_id, $user_id, $lesson_id );
// Only award cert if the user hasn't already earned it.
if ( $this->has_user_earned() ) {
return;
}
if ( $user_id ) {
$this->object = new WP_User( $user_id );
$this->user_email = stripslashes( $this->object->user_email );
$this->recipient = $this->user_email;
}
if ( ! $this->is_enabled() ) {
return; }
$this->create( $this->get_content() );
}
/**
* get_content_html function.
*
* @since 1.0.0
* @since 3.17.4 Unknown.
* @since 5.0.0 Merge the [llms-user] (and others) shortcode.
* @deprecated 6.0.0 `LLMS_Certificate_User::get_content_html()` is deprecated with no replacement.
*
* @return string
*/
private function get_content_html() {
add_filter( 'llms_user_info_shortcode_user_id', array( $this, 'set_shortcode_user' ) );
$codes = apply_filters(
'llms_certificate_merge_codes',
array(
'{site_title}' => $this->get_blogname(),
'{user_login}' => $this->user_login,
'{site_url}' => $this->account_link,
'{first_name}' => $this->user_firstname,
'{last_name}' => $this->user_lastname,
'{email_address}' => $this->user_email,
'{student_id}' => $this->userid,
'{current_date}' => date_i18n( get_option( 'date_format' ), current_time( 'timestamp' ) ),
),
$this
);
$this->find = array_keys( $codes );
$this->replace = array_values( $codes );
$content = $this->format_string( $this->content );
// In certain circumstances shortcodes won't be registered yet.
LLMS_Shortcodes::init();
ob_start();
llms_get_template(
$this->template_html,
array(
'email_message' => do_shortcode( $content ),
'title' => $this->title,
'image' => $this->image,
)
);
remove_filter( 'llms_user_info_shortcode_user_id', array( $this, 'set_shortcode_user' ) );
return ob_get_clean();
}
/**
* Set the user ID used by [llms-user] to the user earning the certificate.
*
* @since 5.0.0
* @deprecated 6.0.0 `LLMS_Certificate_User::set_shortcode_user()` is deprecated with no replacement.
*
* @param int $uid WP_User ID of the current user.
* @return int
*/
private function set_shortcode_user( $uid ) {
return $this->userid;
}
}
return new LLMS_Certificate_User();
================================================
FILE: includes/certificates/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/class-llms-assets.php
================================================
<?php
/**
* Methods for static asset registration and enqueueing
*
* These methods require assets to be "defined" in a structured format.
*
* A defined asset is then enqueued or registered with the WordPress core using this derivative
* API that requires only script handles.
*
* This API also aims to reduce redundancy in asset registrations by allowing "partial" definitions
* which are filled with default values. For example, every asset in LifterLMS shares the same base
* plugin url. Using this API we define that URL one time, instead of defining it over and over for
* each individual asset.
*
* @package LifterLMS/Classes
*
* @since 4.4.0
* @version 7.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Assets Class
*
* @since 4.4.0
* @since 4.9.0 Added new default values related to script localization.
* @since 5.5.0 Added new script default for `asset_file`.
*/
class LLMS_Assets {
/**
* An ID used to identify the originating package (plugin or theme) of the asset handler instance.
*
* @var string
*/
protected $package_id = '';
/**
* Determines if SCRIPT_DEBUG is enabled.
*
* @var boolean
*/
protected $debugging_assets = false;
/**
* List of default asset definitions.
*
* @since 7.2.0 Use `LLMS_ASSETS_VERSION` for default asset version.
*
* @var array[]
*/
protected $defaults = array(
// Base defaults shared by all asset types.
'base' => array(
'base_file' => LLMS_PLUGIN_FILE,
'base_url' => LLMS_PLUGIN_URL,
'suffix' => LLMS_ASSETS_SUFFIX,
'dependencies' => array(),
'version' => LLMS_ASSETS_VERSION,
),
// Script specific defaults.
'script' => array(
'path' => 'assets/js',
'extension' => '.js',
'in_footer' => true,
'translate' => false,
'asset_file' => false,
),
// Stylesheet specific defaults.
'style' => array(
'path' => 'assets/css',
'extension' => '.css',
'media' => 'all',
'rtl' => true,
),
);
protected $inline = array();
/**
* List of defined scripts.
*
* The full list of core script definitions can be found at includes/assets/llms-assets-scripts.php
*
* @var array[]
*/
protected $scripts = array();
/**
* List of defined stylesheets.
*
* The full list of core stylesheet definitions can be found at includes/assets/llms-assets-styles.php
*
* @var array[]
*/
protected $styles = array();
/**
* Constructor
*
* @since 4.4.0
* @since 4.9.0 Replace defaults instead of merging them.
*
* @param string $package_id An ID used to identify the originating package (plugin or theme) of the asset handler instance.
* @param array[] $defaults Array of asset definitions values. Accepts a partial list of values that is merged with the default defaults.
*/
public function __construct( $package_id, $defaults = array() ) {
$this->package_id = $package_id;
$this->defaults = array_replace_recursive( $this->defaults, $defaults );
/**
* Filter asset debug mode.
*
* Asset debug mode is used only to help debug inline assets although the asset suffix is also controlled by the same
* WP Core constants.g
*
* @since 4.4.0
*
* @param bool $debugging Whether or not debugging is enabled. Returns `true` when `SCRIPT_DEBUG` is on, and `false` otherwise.
* @param string $package_id An ID used to identify the originating plugin or theme that defined the asset.
*/
$this->debugging_assets = apply_filters( 'llms_assets_debug', ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ), $this->package_id );
}
/**
* Define a list of assets by type so they can be enqueued or registered later.
*
* If an asset is already defined, redefining it will overwrite the previous definition.
*
* @since 4.4.0
*
* @param string $type Asset type. Accepts 'scripts' or 'styles'.
* @param array[] $assets List of assets to define. The array key is the asset's handle. Each array value is an array of asset definitions.
* @return array[] Returns the updated list of defined assets.
*/
public function define( $type, $assets ) {
if ( ! in_array( $type, array( 'scripts', 'styles' ), true ) ) {
return false;
}
foreach ( $assets as $handle => $definition ) {
$this->{$type}[ $handle ] = $definition;
}
return $this->$type;
}
/**
* Enqueue an inline script or style
*
* @since 4.4.0
*
* @param string $handle Inline asset ID.
* @param string $asset The inline script or CSS rule. This should *not* be wrapped in <script> or <style> tags.
* @param string $location Output location of the inline asset. Accepts "style" (for stylesheets in the headr), "header" (for
* scripts in the header), or "footer" (for scripts in the footer).
* @param int|float $priority Output priority of the inline asset.
* @return float Returns the priority of the enqueued script
*/
public function enqueue_inline( $handle, $asset, $location, $priority = 10 ) {
// If script already exists, remove it and re-enqueue.
if ( $this->is_inline_enqueued( $handle ) ) {
unset( $this->inline[ $handle ] );
}
$priority = $this->get_inline_priority( $priority, $this->get_definitions_inline( $location ) );
$this->inline[ $handle ] = compact( 'handle', 'asset', 'location', 'priority' );
return $priority;
}
/**
* Enqueue (and maybe register) a defined script
*
* If the script has not yet been registered, it will be automatically registered.
*
* The script *must* be defined in one of the following places:
*
* + The script definition list found at includes/assets/llms-assets-scripts.php
* + Added to the definitions list via the `LLMS_Assets::define()` method.
* + Added to the definition list via the `llms_get_script_asset_definitions` filter
* + Added "just in time" via the `llms_get_script_asset` filter.
*
* If the script is *not defined* this function will return `false` because registration
* will fail.
*
* @since 4.4.0
*
* @param string $handle The script's handle.
* @return boolean
*/
public function enqueue_script( $handle ) {
// Script was not registered and registration failed.
if ( ! wp_script_is( $handle, 'registered' ) && ! $this->register_script( $handle ) ) {
return false;
}
wp_enqueue_script( $handle );
return wp_script_is( $handle, 'enqueued' );
}
/**
* Enqueue (and maybe register) a defined stylesheet
*
* If the stylesheet has not yet been registered, it will be automatically registered.
*
* The stylesheet *must* be defined in one of the following places:
*
* + The stylesheet definition list found at includes/assets/llms-assets-styles.php
* + Added to the definitions list via the `LLMS_Assets::define()` method.
* + Added to the definition list via the `llms_get_style_asset_definitions` filter
* + Added "just in time" via the `llms_get_style_asset` filter.
*
* If the stylesheet is *not defined* this function will return `false` because registration
* will fail.
*
* @since 4.4.0
*
* @param string $handle The stylesheets's handle.
* @return boolean
*/
public function enqueue_style( $handle ) {
// Style was not registered and registration failed.
if ( ! wp_style_is( $handle, 'registered' ) && ! $this->register_style( $handle ) ) {
return false;
}
wp_enqueue_style( $handle );
return wp_style_is( $handle, 'enqueued' );
}
/**
* Retrieve an asset definition by type and handle
*
* Locates the asset by type and handle and merges a potentially impartial asset definition
* with default values from the `get_defaults()` method.
*
* @since 4.4.0
* @since 4.4.1 Replace truthy check with an strict check against `false` to ensure assets defined with an empty array signifying all default values should be used.
* @since 5.5.0 Load dependency and version info from an asset.php file when `$asset_file` is `true`.
*
* @param string $type The asset type. Accepts either "script" or "style".
* @param string $handle The asset handle.
* @return array|false {
* An asset definition array or `false` if an asset definition could not be located.
*
* @type string $file_name The file name of the asset. Excludes the path, suffix, and extension, eg: 'llms' for 'llms.js'. Defaults to the asset's handle.
* @type string $base_url The base URL used to locate the asset on the server. Defaults to `LLMS_PLUGIN_URL`.
* @type string $path The relative path to the asset within the plugin directory. Defaults to `assets/js` for scripts and `assets/css` for styles.
* @type string $extension The filename extension for the asset. Defaults to `.js` for scripts and `.css` for styles.
* @type string $suffix The file suffix for the asset, for example `.min` for minified files. Defaults to `LLMS_ASSETS_SUFFIX`.
* @type string[] $dependencies An array of asset handles the asset depends on. These assets do not necessarily need to be assets defined by LifterLMS, for example WP Core scripts, such as `jquery`, can be used.
* @type string $version The asset version. Defaults to `LLMS_ASSETS_VERSION`.
* @type string $package_id An ID used to identify the originating plugin or theme that defined the asset.
* @type boolean $in_footer (For `script` assets only) Whether or not the script should be output in the footer. Defaults to `true`.
* @type boolean $translate (For `script` assets only) Whether or not script translations should be set. Defaults to `false`.
* @type boolean $asset_file (For `script` assets only) Whether or not the script has an asset file (generated via the @wordpress/dependency-extraction-webpack-plugin).
* @type boolean $rtl (For `style` assets only) Whether or not to automatically add RTL style data for the stylesheet. Defaults to `true`.
* @type boolean $media (For `style` assets only) The stylesheet's media type. Defaults to `all`.
* }
*/
protected function get( $type, $handle ) {
$list = $this->get_definitions( $type );
$asset = isset( $list[ $handle ] ) ? $list[ $handle ] : false;
/**
* Filter static asset data prior to preparing the definition
*
* The definition is "prepared" by merging its data with the default data and preparing its src.
*
* The dynamic portion of this filter, `{$type}`, refers to the asset type. Either "script" or "style".
*
* @since 4.4.0
*
* @param array|false $asset Array of asset data or `false` if the asset has not been defined with LifterLMS.
* @param string $handle The asset handle.
* @param string $package_id An ID used to identify the originating plugin or theme that defined the asset.
*/
$asset = apply_filters( "llms_get_{$type}_asset_before_prep", $asset, $handle, $this->package_id );
if ( false !== $asset && is_array( $asset ) ) {
$asset = wp_parse_args( $asset, $this->get_defaults( $type ) );
$asset['handle'] = $handle;
$asset['package_id'] = $this->package_id;
$asset['file_name'] = ! empty( $asset['file_name'] ) ? $asset['file_name'] : $handle;
$asset['src'] = ! empty( $asset['src'] ) ? $asset['src'] : implode(
'',
array(
trailingslashit( $asset['base_url'] ),
trailingslashit( $asset['path'] ),
$asset['file_name'],
$asset['suffix'],
$asset['extension'],
)
);
$asset = $this->merge_asset_file( $asset );
}
/**
* Filter static asset data prior to enqueueing or registering it with the WordPress core
*
* The dynamic portion of this filter, `{$type}`, refers to the asset type. Either "script" or "style".
*
* @since 4.4.0
*
* @param array|false $asset Array of asset data or `false` if the asset has not been defined with LifterLMS.
* @param string $handle The asset handle.
*/
return apply_filters( "llms_get_{$type}_asset", $asset, $handle );
}
/**
* Retrieves an array of definition values based on asset type.
*
* @since 4.4.0
*
* @param string $type The asset type. Accepts either "script" or "style".
* @return array
*/
protected function get_defaults( $type ) {
$type_defaults = isset( $this->defaults[ $type ] ) ? $this->defaults[ $type ] : array();
$defaults = array_merge( $this->defaults['base'], $type_defaults );
/**
* Filter the default values used to register or enqueue an asset
*
* The dynamic portion of this filter, `{$type}`, refers to the asset type. Either "script" or "style".
*
* @since 4.4.0
*
* @param array $defaults Default definition values.
* @param string $package_id An ID used to identify the originating plugin or theme that defined the asset.
*/
return apply_filters( "llms_get_{$type}_asset_defaults", $defaults, $this->package_id );
}
/**
* Retrieve the asset definition list for a given asset type.
*
* @since 4.4.0
*
* @param string $type The asset type. Accepts either "script" or "style".
* @return array[]
*/
protected function get_definitions( $type ) {
switch ( $type ) {
case 'script':
$list = $this->scripts;
break;
case 'style':
$list = $this->styles;
break;
default:
$list = array();
}
/**
* Filter the definition list of static assets for the given type
*
* The dynamic portion of this filter, `{$type}`, refers to the asset type. Either "script" or "style".
*
* @since 4.4.0
*
* @param array[] $list The definition list.
* @param string $package_id An ID used to identify the originating plugin or theme that defined the asset.
*/
return apply_filters( "llms_get_{$type}_asset_definitions", $list, $this->package_id );
}
/**
* Retrieve a list of inline asset definitions by location.
*
* @since 4.4.0
*
* @param string $location Location of scripts to output. Accepts "style", "header", or "footer".
* Inline header styles are output using "style".
* Inline scripts are output using either "header" or "footer", output in their respective locations.
* @return array[]
*/
protected function get_definitions_inline( $location ) {
$assets = array();
foreach ( $this->inline as $handle => $definition ) {
if ( $location === $definition['location'] ) {
$assets[ $handle ] = $definition;
}
}
// Sort by priority.
uasort(
$assets,
function ( $a, $b ) {
if ( $a['priority'] === $b['priority'] ) {
return 0;
}
return $a['priority'] < $b['priority'] ? -1 : 1;
}
);
return $assets;
}
/**
* Auto-increment inline asset priority to prevent duplicates.
*
* This ensures that inline assets are always enqueued with a unique priority for their requested
* location.
*
* @since 4.4.0
* @since 7.0.0 When increasing priorities, round to the nearest two decimals.
*
* @param float $priority Requested enqueue priority.
* @param array $inline_assets List of existing inline assets for the requested location.
* @return float
*/
protected function get_inline_priority( $priority, $inline_assets = array() ) {
$priority = floatval( $priority );
if ( $inline_assets ) {
$priorities = wp_list_pluck( $inline_assets, 'priority' );
while ( in_array( $priority, $priorities, true ) ) {
$priority = round( $priority + 0.01, 2 );
}
}
return $priority;
}
/**
* Determines if an inline asset is enqueued
*
* @since 4.4.0
*
* @param string $handle Inline asset handle.
* @return boolean
*/
public function is_inline_enqueued( $handle ) {
return in_array( $handle, array_keys( $this->inline ), true );
}
/**
* Retrieve dependency and version info from a script asset's asset.php file
*
* Loads the asset.php file (generated via the @wordpress/dependency-extraction-webpack-plugin) and merges it
* into an existing asset array.
*
* @since 5.5.0
*
* @param array $asset An asset definition array.
* @return array
*/
protected function merge_asset_file( $asset ) {
if ( empty( $asset['asset_file'] ) ) {
return $asset;
}
$asset_file_path = plugin_dir_path( $asset['base_file'] ) . trailingslashit( $asset['path'] ) . $asset['file_name'] . '.asset.php';
if ( file_exists( $asset_file_path ) ) {
$info = include $asset_file_path;
$asset['dependencies'] = array_merge( $asset['dependencies'], $info['dependencies'] );
$asset['version'] = $info['version'];
}
return $asset;
}
/**
* Output inline scripts
*
* @since 4.4.0
*
* @param string $location Location of scripts to output. Accepts "style", "header", or "footer".
* Inline header styles are output using "style".
* Inline scripts are output using either "header" or "footer", output in their respective locations.
* @return void
*/
public function output_inline( $location ) {
$defs = self::get_definitions_inline( $location );
if ( $defs ) {
$assets = array();
foreach ( $defs as $def ) {
$assets[] = $this->prepare_inline_asset_for_output( $def, $location );
}
$open = 'style' === $location ? '<style id="llms-inline-styles" type="text/css">' : sprintf( '<script id="llms-inline-%s-scripts" type="text/javascript">', $location );
$close = 'style' === $location ? '</style>' : '</script>';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo $open . implode( '', $assets ) . $close;
}
}
/**
* Prepares an inline asset definition for being output.
*
* When `$this->debugging_assets` is `true` this will add line breaks between each inline asset
* and output the asset's handle as a comment before the asset's script/style so that the
* inline assets can be quickly located and reviewed in the generated source of the page.
*
* @since 4.4.0
*
* @param array $asset The inline asset definition array.
* @param string $location The location of the asset. Accepts "header", "footer", or "style".
* @return string
*/
protected function prepare_inline_asset_for_output( $asset, $location ) {
$before = '';
$after = '';
// Output inline asset handles and add line breaks when debugging.
if ( $this->debugging_assets ) {
// Setup the comment template.
$before = 'style' === $location ? '/* %s. */' : '// %s.';
// Add line breaks.
$before .= "\n";
$after = "\n";
}
return sprintf( $before, $asset['handle'] ) . $asset['asset'] . $after;
}
/**
* Registers a defined script with WordPress
*
* The script *must* be defined in one of the following places:
*
* + The script definition list found at includes/assets/llms-assets-scripts.php
* + Added to the definition list via the `llms_get_script_asset_definitions` filter
* + Added "just in time" via the `llms_get_script_asset` filter.
*
* If the script is *not defined* this function will return `false`.
*
* @since 4.4.0
* @since 4.9.0 Automatically set script translations when `translate=true`.
* @since 5.5.0 Automatically register all of the asset's dependencies.
*
* @param string $handle The script's handle.
* @return boolean
*/
public function register_script( $handle ) {
$script = $this->get( 'script', $handle );
if ( $script ) {
array_map( array( $this, 'register_script' ), $script['dependencies'] );
$reg = wp_register_script( $handle, $script['src'], $script['dependencies'], $script['version'], $script['in_footer'] );
if ( $reg && $script['translate'] ) {
$this->set_script_translations( $script );
}
return $reg;
}
return false;
}
/**
* Register a defined stylesheet
*
* If the stylesheet has not yet been registered, it will be automatically registered.
*
* The stylesheet *must* be defined in one of the following places:
*
* + The stylesheet definition list found at includes/assets/llms-assets-styles.php
* + Added to the definition list via the `llms_get_style_asset_definitions` filter
* + Added "just in time" via the `llms_get_style_asset` filter.
*
* If the stylesheet is *not defined* this function will return `false`.
*
* This method will also automatically add RTL style data unless explicitly told not to do so.
*
* The RTL stylesheet should have the same name (and suffix) with `-rtl` included prior to the suffix, for example
* `llms.css` (or `llms.min.css`) would add the RTL stylesheet `llms-rtl.css` (or `llms-rtl.min.css`).
*
* @since 4.4.0
* @since 5.5.0 Automatically register all of the asset's dependencies.
*
* @param string $handle The stylesheets's handle.
* @return boolean
*/
public function register_style( $handle ) {
$style = $this->get( 'style', $handle );
if ( $style ) {
array_map( array( $this, 'register_style' ), $style['dependencies'] );
$reg = wp_register_style( $handle, $style['src'], $style['dependencies'], $style['version'], $style['media'] );
if ( $reg && $style['rtl'] ) {
wp_style_add_data( $handle, 'rtl', 'replace' );
wp_style_add_data( $handle, 'suffix', $style['suffix'] );
}
return $reg;
}
return false;
}
/**
* Load JSON format localization files for a registered script
*
* This method mimics the behavior of PO/MO pot files loaded for PHP localization.
*
* Language files can be found in the following locations (The first loaded file takes priority):
*
* 1. wp-content/languages/{$textdomain}/{$textdomain}-{$locale}-{$file_md5_hash}.json
*
* This is recommended "safe" location where custom language files can be stored. A file
* stored in this directory will never be automatically overwritten.
*
* 2. wp-content/languages/plugins/{$textdomain}-{$locale}-{$file_md5_hash}.json
*
* This is the default directory where WordPress will download language files from the
* WordPress GlotPress server during updates. If you store a custom language file in this
* directory it will be overwritten during updates.
*
* 3. wp-content/plugins/{$textdomain}/languages/{$textdomain}-{$locale}-{$file_md5_hash}.json
*
* This is the the LifterLMS plugin directory. A language file stored in this directory will
* be removed from the server during a LifterLMS plugin update.
*
* @since 4.9.0
*
* @param array $script An asset definition array from the return of `LLMS_Assets::get()`.
* @return void
*/
protected function set_script_translations( $script ) {
$plugin_data = get_plugin_data( $script['base_file'], false, false );
$domain = $plugin_data['TextDomain'];
// Possible directories where the language files may be found.
$dirs = array(
llms_l10n_get_safe_directory(),
WP_LANG_DIR . '/plugins', // Default language directory.
trailingslashit( plugin_dir_path( $script['base_file'] ) ) . untrailingslashit( ltrim( $plugin_data['DomainPath'], '/' ) ), // Language directory within the plugin.
);
foreach ( $dirs as $dir ) {
wp_set_script_translations( $script['handle'], $domain, $dir );
}
}
}
================================================
FILE: includes/class-llms-awards-query.php
================================================
<?php
/**
* LLMS_Awards_Query class file.
*
* @package LifterLMS/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Query awarded achievements and engagements.
*
* @since 6.0.0
*
* Valid query arguments
*
* {@see LLMS_Abstract_Query} and {@see LLMS_Abstract_Posts_Query} for inherited query arguments.
*
* @param int|int[] $users Include awards for the specified WP_User(s) by WP_User ID.
* @param int|int[] $users__exclude Exclude awards for the specified WP_User(s) by WP_User ID.
* @param int|int[] $related_posts Include awards related to the specified WP_Post(s) by WP_Post ID.
* @param int|int[] $related_posts__exclude Exclude awards related to the specified WP_Post(s) by WP_Post ID.
* @param int|int[] $engagements Include awards created from the specified `llms_engagement` post(s) by WP_Post ID.
* @param int|int[] $engagements__exclude Exclude awards created from the specified `llms_engagement` post(s) by WP_Post ID.
* @param string $type Award type, accepts "any", "achievement" or "certificate".
* @param int|int[] $templates Include awards created from the specified `llms_achievement` or `llms_certificate` template post(s) by WP_Post ID.
* @param int|int[] $templates__exclude Exclude awards created from the specified `llms_achievement` or `llms_certificate` template post(s) by WP_Post ID.
* @param boolean $manual_only Include only awards created manually. If specified the `$related_posts`, `$related_posts__exclude`, `$engagements`, `$engagements__exclude`, `$templates`, and `$templates__exclude` arguments will be ignored.
*/
class LLMS_Awards_Query extends LLMS_Abstract_Posts_Query {
/**
* Identify the extending query.
*
* @var string
*/
protected $id = 'awards';
/**
* Specify the post types allowed to be queried by this class.
*
* @var string[]
*/
protected $allowed_post_types = array(
'llms_my_achievement',
'llms_my_certificate',
);
/**
* Defines fields that can be sorted on via ORDER BY.
*
* @var string[]
*/
protected $allowed_sort_fields = array(
'date',
'ID',
'user',
);
/**
* Retrieve query argument default values.
*
* @since 6.0.0
*
* @return array
*/
protected function default_arguments() {
return wp_parse_args(
array(
'sort' => array(
'date' => 'DESC',
'ID' => 'DESC',
),
'users' => array(),
'users__exclude' => array(),
'related_posts' => array(),
'related_posts__exclude' => array(),
'engagements' => array(),
'engagements__exclude' => array(),
'templates' => array(),
'templates__exclude' => array(),
'type' => 'any',
'manual_only' => false,
),
parent::default_arguments()
);
}
/**
* Map input arguments to WP_Query arguments.
*
* @since 6.0.0
*
* @return array
*/
protected function get_arg_map() {
$map = parent::get_arg_map();
return array_merge(
$map,
array(
'users' => 'author__in',
'users__exclude' => 'author__not_in',
'templates' => 'post_parent__in',
'templates__exclude' => 'post_parent__not_in',
)
);
}
/**
* Retrieve an array of award objects for the given result set returned by the query.
*
* @since 6.0.0
*
* @return array Array of LLMS_User_Achievement and/or LLMS_User_Certificate objects.
*/
public function get_awards() {
$awards = array_filter( array_map( array( $this, 'get_object' ), $this->get_results() ) );
if ( $this->get( 'suppress_filters' ) ) {
return $awards;
}
/**
* Filters the query results array.
*
* @since 6.0.0
*
* @param array $awards Array of LLMS_User_Achievement and/or LLMS_User_Certificate objects.
* @param LLMS_Awards_Query $query Instance of the query class.
*/
return apply_filters( 'llms_awards_query_get_awards', $awards, $this );
}
/**
* Retrieve the object for a given result.
*
* @since 6.0.0
*
* @param int|WP_Post $post Post object or ID.
* @return LLMS_User_Achievement|LLMS_User_Certificate|null Returns the award object or `null` for unexpected post types.
*/
protected function get_object( $post ) {
$post_type = get_post_type( $post );
if ( 'llms_my_achievement' === $post_type ) {
return new LLMS_User_Achievement( $post );
} elseif ( 'llms_my_certificate' === $post_type ) {
return llms_get_certificate( $post );
}
return null;
}
/**
* Parse arguments needed for the query.
*
* @since 6.0.0
*
* @return void
*/
protected function parse_args() {
$int_arrays = array(
'users',
'users__exclude',
'related_posts',
'related_posts__exclude',
'engagements',
'engagements__exclude',
'templates',
'templates__exclude',
);
foreach ( $int_arrays as $key ) {
$this->arguments[ $key ] = $this->sanitize_id_array( $this->arguments[ $key ] );
}
$this->arguments['manual_only'] = llms_parse_bool( $this->arguments['manual_only'] );
$this->arguments['page'] = absint( $this->arguments['page'] );
$this->arguments['per_page'] = intval( $this->arguments['per_page'] );
$this->arguments['no_found_rows'] = llms_parse_bool( $this->arguments['no_found_rows'] );
}
/**
* Retrieve the post type(s) based on the `$type` input.
*
* @since 6.0.0
*
* @return string[]
*/
protected function post_types() {
$type = $this->get( 'type' );
$types = array();
if ( 'any' === $type ) {
$types = $this->allowed_post_types;
} elseif ( 'achievement' === $type ) {
$types = array( 'llms_my_achievement' );
} elseif ( 'certificate' === $type ) {
$types = array( 'llms_my_certificate' );
}
return $types;
}
/**
* Prepares the `meta_query` ultimately passed to the WP_Query.
*
* @since 6.0.0
*
* @return array An array of meta query arrays.
*/
private function prepare_meta_query() {
// If a query for manual awards we skip all other relationships and return early.
if ( $this->get( 'manual_only' ) ) {
return array(
'relation' => 'OR',
// Meta doesn't exist.
array(
'key' => '_llms_engagement',
'compare' => 'NOT EXISTS',
),
// Or it's "empty".
array(
'key' => '_llms_engagement',
'value' => array( '', '0', 0 ),
'compare' => 'IN',
),
);
}
return $this->prepare_meta_query_for_relationships();
}
/**
* Retrieve meta query parts for related posts, engagements, and templates.
*
* @since 6.0.0
*
* @return array An array of meta query arrays.
*/
private function prepare_meta_query_for_relationships() {
$meta_query = array();
$relations = array(
'related_posts' => '_llms_related',
'engagements' => '_llms_engagement',
);
foreach ( $relations as $arg => $meta_key ) {
// Include.
if ( ! empty( $this->get( $arg ) ) ) {
$meta_query[] = array(
'key' => $meta_key,
'value' => $this->sanitize_id_array( $this->get( $arg ) ),
'compare' => 'IN',
);
}
// Exclude.
$exclude_arg = $arg . '__exclude';
if ( ! empty( $this->get( $exclude_arg ) ) ) {
$meta_query[] = array(
'relation' => 'OR',
array(
'key' => $meta_key,
'value' => $this->sanitize_id_array( $this->get( $exclude_arg ) ),
'compare' => 'NOT IN',
),
// Ensure posts that don't have the metadata set will be returned.
array(
'key' => $meta_key,
'compare' => 'NOT EXISTS',
),
);
}
}
return $meta_query;
}
/**
* Prepare the WP_Query arguments for the awards query.
*
* @since 6.0.0
*
* @return array Array of arguments suitable to pass to a WP_Query.
*/
protected function prepare_query() {
// Remove any extra arguments not found in the map.
$args = array_intersect_key(
parent::prepare_query(),
array_flip( $this->get_arg_map() )
);
// Add post type(s).
$args['post_type'] = $this->post_types();
// Add meta query.
$args['meta_query'] = $this->prepare_meta_query();
// Remove empty arrays.
return array_filter(
$args,
function( $val ) {
return ! is_array( $val ) || ! empty( $val );
}
);
}
}
================================================
FILE: includes/class-llms-beaver-builder-migrate.php
================================================
<?php
/**
* Handle post migration to the Beaver Builder modules.
*
* @package LifterLMS/Classes
*
* @since 8.0.0
*/
defined( 'ABSPATH' ) || exit;
class LLMS_Beaver_Builder_Migrate {
public function __construct() {
add_action( 'wp', array( $this, 'maybe_migrate_post' ) );
add_action( 'wp', array( $this, 'remove_template_hooks' ) );
add_action( 'fl_builder_after_save_layout', array( $this, 'maybe_update_migration_status' ), 10, 2 );
}
/**
* Migrate posts created prior to the elementor updates to have default LifterLMS widgets.
*
* @since 8.0.0
*
* @return void
*/
public function maybe_migrate_post() {
global $post;
if ( ! class_exists( 'FLBuilderModel' ) || ! method_exists( 'FLBuilderModel', 'is_builder_active' ) || ! FLBuilderModel::is_builder_active() ) {
return;
}
if ( ! $post ) {
return;
}
if ( ! $this->is_migratable_post_type( $post->ID ) ) {
return;
}
if ( ! $this->should_migrate_post( $post->ID ) ) {
return;
}
$this->add_template_to_post();
}
protected function is_migratable_post_type( $post_id ) {
return in_array( get_post_type( $post_id ), array( 'course', 'lesson', 'llms_membership' ) );
}
public function add_template_to_post() {
// Get the existing layout data.
$data = FLBuilderModel::get_layout_data();
if ( ! $data ) {
return;
}
$path = LLMS_PLUGIN_DIR . 'includes/beaver-builder/templates/default-' . get_post_type() . '-template.dat';
if ( ! file_exists( $path ) ) {
return;
}
$templates = maybe_unserialize( file_get_contents( $path ) );
$template = $templates['layout'][0];
// TODO : Check if the data already has the template inserted.
// Get the next top-level position.
$position = FLBuilderModel::next_node_position( 'row' );
// Adjust the position of template nodes.
foreach ( $template->nodes as $node_id => $node ) {
if ( ! $node->parent ) {
$template->nodes[ $node_id ]->position += $position;
}
}
// Merge the template nodes with the existing nodes.
$data = array_merge( $data, $template->nodes );
FLBuilderModel::update_layout_data( $data );
}
/**
* Removes core template action hooks from posts which have been migrated to beaver builder widgets.
*
* @since 8.0.0
*
* @return void
*/
public function remove_template_hooks() {
if ( ! function_exists( 'llms_is_beaver_builder_post' ) ||
! llms_is_beaver_builder_post() ||
( get_the_ID() && ! llms_parse_bool( get_post_meta( get_the_ID(), '_llms_beaver_builder_migrated', true ) ) ) ) {
if ( ! $this->is_migratable_post_type( get_the_ID() ) ) {
return;
}
// Remove the bottom actions if the builder is currently active to avoid confusion with uneditable pieces.
if ( ! class_exists( 'FLBuilderModel' ) || ! method_exists( 'FLBuilderModel', 'is_builder_active' ) || ! FLBuilderModel::is_builder_active() ) {
return;
}
}
switch ( get_post_type() ) {
case 'course':
$this->remove_course_template_hooks();
break;
case 'lesson':
$this->remove_lesson_template_hooks();
break;
case 'llms_membership':
$this->remove_membership_template_hooks();
break;
}
}
/**
* Remove membership template hooks.
*
* @since 8.0.0
*/
public function remove_membership_template_hooks() {
remove_action( 'lifterlms_single_membership_after_summary', 'lifterlms_template_pricing_table', 10 );
}
/**
* Remove lesson template hooks.
*
* @since 8.0.0
*/
public function remove_lesson_template_hooks() {
remove_action( 'lifterlms_single_lesson_after_summary', 'lifterlms_template_complete_lesson_link', 10 );
}
/**
* Remove course template hooks.
*
* @since 8.0.0
*
* @return void
*/
public function remove_course_template_hooks() {
// TODO: Refactor this so it's not duplicated between Elementor and Beaver Builder.
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_meta_wrapper_start', 5 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_length', 10 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_difficulty', 20 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_tracks', 25 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_categories', 30 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_tags', 35 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_meta_wrapper_end', 50 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_progress', 60 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_syllabus', 90 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_course_author', 40 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_pricing_table', 60 );
}
/**
* Determine if a post should be migrated.
*
* @since 8.0.0
*
* @param int $post_id WP_Post ID.
* @return bool
*/
public function should_migrate_post( $post_id ) {
$ret = ! llms_parse_bool( get_post_meta( $post_id, '_llms_beaver_builder_migrated', true ) );
/**
* Filters whether or not a post should be migrated
*
* @since 8.0.0
*
* @param bool $migrate Whether or not a post should be migrated.
* @param int $post_id WP_Post ID.
*/
return apply_filters( 'llms_beaver_builder_should_migrate_post', $ret, $post_id );
}
/**
* Update post meta data to signal status of the editor migration.
*
* @since 8.0.0
*
* @param int $post_id WP_Post ID.
* @param bool $publish Whether or not the post is being published.
* @return void
*/
public function maybe_update_migration_status( $post_id, $publish ) {
if ( ! $publish ) {
return;
}
if ( ! $this->is_migratable_post_type( $post_id ) ) {
return;
}
if ( llms_parse_bool( get_post_meta( $post_id, '_llms_beaver_builder_migrated', true ) ) ) {
return;
}
update_post_meta( $post_id, '_llms_beaver_builder_migrated', 'yes' );
}
}
return new LLMS_Beaver_Builder_Migrate();
================================================
FILE: includes/class-llms-beaver-builder.php
================================================
<?php
/**
* BeaverBuilder Integration
*
* Lets you do all them sweet BeaverBuilder things to Courses, Lessons, and Memberships.
*
* @package LifterLMS/Classes
*
* @since 8.0.0
*/
defined( 'ABSPATH' ) || exit;
define( 'LLMS_BB_MODULES_DIR', plugin_dir_path( __FILE__ ) . 'beaver-builder/modules/' );
define( 'LLMS_BB_MODULES_URL', plugins_url( '/', __FILE__ ) . 'beaver-builder/modules/' );
class LLMS_Beaver_Builder {
use LLMS_Trait_Singleton;
public function __construct() {
$this->init();
}
public function is_available() {
return class_exists( 'FLBuilder' );
}
protected function init() {
// Break early if the LifterLMS Labs is installed and enabled.
if ( class_exists( 'LifterLMS_Labs' ) && llms_parse_bool( get_option( 'llms_lab_beaver-builder_enabled' ) ) ) {
return;
}
if ( ! class_exists( 'FLBuilder' ) || ! class_exists( 'FLBuilderModel' ) || ! class_exists( 'FLBUilderModule' ) ) {
return;
}
// Prevent uneditable llms post types from being enabled for page building.
add_filter( 'fl_builder_admin_settings_post_types', array( $this, 'remove_uneditable_post_types' ) );
// Add migrateable post types to the builder by default.
add_filter( 'fl_builder_post_types', array( $this, 'enable_post_types_by_default' ) );
add_action( 'wp', array( $this, 'load_modules' ), 1 );
add_action( 'init', array( $this, 'load_templates' ) );
add_filter( 'fl_builder_register_module', array( $this, 'register_module' ), 10, 2 );
add_filter( 'llms_page_restricted', array( $this, 'mod_page_restrictions' ), 999, 2 );
add_filter( 'fl_builder_register_settings_form', array( $this, 'add_visibility_settings' ), 999, 2 );
add_filter( 'fl_builder_is_node_visible', array( $this, 'is_node_visible' ), 10, 2 );
// Hide editors when builder is enabled for a post.
add_filter( 'llms_metabox_fields_lifterlms_course_options', array( $this, 'mod_metabox_fields' ) );
add_filter( 'llms_metabox_fields_lifterlms_membership', array( $this, 'mod_metabox_fields' ) );
add_filter( 'fl_builder_upgrade_url', array( $this, 'upgrade_url' ) );
// LifterLMS Private Areas.
add_action( 'llms_pa_before_do_area_content', array( $this, 'llms_pa_before_content' ) );
add_action( 'llms_pa_after_do_area_content', array( $this, 'llms_pa_after_content' ) );
}
public function enable_post_types_by_default( $types ) {
$types[] = 'course';
$types[] = 'lesson';
$types[] = 'llms_membership';
return $types;
}
/**
* Add LLMS post types to the enabled builder post types.
*
* Stub function called during install.
*
* @since 8.0.0
*
* @return void
*/
public function install() {
if ( ! $this->is_available() ) {
return;
}
$existing = get_option( '_fl_builder_post_types', array( 'page' ) );
$types = array_unique( array_merge( $existing, array( 'course', 'lesson', 'llms_membership' ) ) );
update_option( '_fl_builder_post_types', $types );
}
/**
* This function should return array of settings fields.
*
* @since 1.3.0
*
* @return array
*/
protected function settings() {
return array();
}
/**
* Add custom visibility settings for enrollments to the BB "Visibility" section.
*
* @since 1.5.0
* @since 1.5.3 Fixed localization textdomain.
* @since 1.7.0 Escaped strings.
*
* @param array $form Settings form array.
* @param string $id ID of the row/module/col/etc.
* @return array
*/
public function add_visibility_settings( $form, $id ) {
$options = array(
'llms_enrolled' => esc_html__( 'Enrolled Students', 'lifterlms' ),
'llms_not_enrolled' => esc_html__( 'Non-Enrolled Students and Visitors', 'lifterlms' ),
);
$toggle = array(
'llms_enrolled' => array(
'fields' => array( 'llms_enrollment_type' ),
),
'llms_not_enrolled' => array(
'fields' => array( 'llms_enrollment_type' ),
),
);
$fields = array(
'llms_enrollment_type' => array(
'type' => 'select',
'label' => esc_html__( 'In', 'lifterlms' ),
'options' => array(
'' => esc_html__( 'Current Course or Membership', 'lifterlms' ),
'any' => esc_html__( 'Any Course(s) or Membership(s)', 'lifterlms' ),
'specific' => esc_html__( 'Specific Course(s) and/or Membership(s)', 'lifterlms' ),
),
'toggle' => array(
'specific' => array(
'fields' => array( 'llms_enrollment_match', 'llms_course_ids', 'llms_membership_ids' ),
),
),
'help' => esc_html__( 'Select how to check the enrollment status of the current student.', 'lifterlms' ),
'preview' => array(
'type' => 'none',
),
),
'llms_enrollment_match' => array(
'type' => 'select',
'label' => esc_html__( 'Match', 'lifterlms' ),
'options' => array(
'' => esc_html__( 'Any of the following', 'lifterlms' ),
'all' => esc_html__( 'All of the following', 'lifterlms' ),
),
'help' => esc_html__( 'Select how to check the enrollment status of the current student.', 'lifterlms' ),
'preview' => array(
'type' => 'none',
),
),
'llms_course_ids' => array(
'type' => 'suggest',
'action' => 'fl_as_posts',
'data' => 'course',
'label' => esc_html__( 'Courses', 'lifterlms' ),
'help' => esc_html__( 'Choose which course(s) the student must be enrolled (or not enrolled) in to view this element.', 'lifterlms' ),
'preview' => array(
'type' => 'none',
),
),
'llms_membership_ids' => array(
'type' => 'suggest',
'action' => 'fl_as_posts',
'data' => 'llms_membership',
'label' => esc_html__( 'Memberships', 'lifterlms' ),
'help' => esc_html__( 'Choose which membership(s) the student must be enrolled (or not enrolled) in to view this element.', 'lifterlms' ),
'preview' => array(
'type' => 'none',
),
),
);
// Rows.
if (
isset( $form['tabs'] ) &&
isset( $form['tabs']['advanced'] ) &&
isset( $form['tabs']['advanced']['sections'] ) &&
isset( $form['tabs']['advanced']['sections']['visibility'] )
) {
$form['tabs']['advanced']['sections']['visibility']['fields']['visibility_display']['options'] = array_merge( $form['tabs']['advanced']['sections']['visibility']['fields']['visibility_display']['options'], $options );
$form['tabs']['advanced']['sections']['visibility']['fields']['visibility_display']['toggle'] = array_merge( $form['tabs']['advanced']['sections']['visibility']['fields']['visibility_display']['toggle'], $toggle );
$form['tabs']['advanced']['sections']['visibility']['fields'] = array_merge( $form['tabs']['advanced']['sections']['visibility']['fields'], $fields );
// Modules.
} elseif (
isset( $form['sections'] ) &&
isset( $form['sections']['visibility'] )
) {
$form['sections']['visibility']['fields']['visibility_display']['options'] = array_merge( $form['sections']['visibility']['fields']['visibility_display']['options'], $options );
$form['sections']['visibility']['fields']['visibility_display']['toggle'] = array_merge( $form['sections']['visibility']['fields']['visibility_display']['toggle'], $toggle );
$form['sections']['visibility']['fields'] = array_merge( $form['sections']['visibility']['fields'], $fields );
}
return $form;
}
/**
* Create a single array of course & membership IDs from a BB node settings object.
*
* @since 1.3.0
*
* @param obj $settings BB Node Settings.
* @return array
*/
private function get_related_posts_from_settings( $settings ) {
$post_ids = array();
foreach ( array( 'llms_course_ids', 'llms_membership_ids' ) as $key ) {
if ( ! empty( $settings->$key ) ) {
$ids = explode( ',', $settings->$key );
$post_ids = array_merge( $post_ids, $ids );
}
}
return $post_ids;
}
/**
* Determine if a node is visible based on llms enrollments status visibility settings.
*
* @since 1.3.0
* @since 1.5.0 Unknown.
* @since 1.5.3 Fixed visibility conditional logic for `'specific'` enrollment type.
* @since 1.7.0 Use `in_array()` strict comparisons.
*
* @param bool $visible Default visibility.
* @param obj $node BB node object.
* @return boolean
*/
public function is_node_visible( $visible, $node ) {
if ( isset( $node->settings ) && isset( $node->settings->visibility_display ) && false !== strpos( $node->settings->visibility_display, 'llms_' ) ) {
$status = $node->settings->visibility_display;
$uid = get_current_user_id();
$type = ! empty( $node->settings->llms_enrollment_type ) ? $node->settings->llms_enrollment_type : null;
llms_log( $type );
if ( ! $type || 'any' === $type ) {
// No type means current course/membership.
if ( ! $type ) {
$current_id = get_the_ID();
// Cascade up for lessons & quizzes.
if ( in_array( get_post_type( $current_id ), array( 'lesson', 'llms_quiz' ), true ) ) {
$course = llms_get_post_parent_course( $current_id );
$current_id = $course->get( 'id' );
}
// If the current id isn't a course or membership don't proceed.
if ( ! in_array( get_post_type( $current_id ), array( 'course', 'llms_membership' ), true ) ) {
return $visibility;
}
// Get the enrollment status.
$enrollment_status = llms_is_user_enrolled( $uid, $current_id );
} elseif ( 'any' === $type ) { // Check if they're enrolled/not enrolled in anything.
$enrollment_status = $this->is_student_enrolled_in_one_thing( $uid );
}
if ( 'llms_enrolled' === $status ) {
return $enrollment_status;
} elseif ( 'llms_not_enrolled' === $status ) {
return ( ! $enrollment_status );
}
} elseif ( 'specific' === $type ) { // Check if they're enrolled / not enrolled in the specific courses/memberships.
$match = $node->settings->llms_enrollment_match ? $node->settings->llms_enrollment_match : 'any';
$ids = $this->get_related_posts_from_settings( $node->settings );
if ( empty( $ids ) ) {
return true;
}
if ( 'llms_enrolled' === $status ) {
if ( ! $uid ) {
return false;
}
return llms_is_user_enrolled( $uid, $ids, $match );
} elseif ( 'llms_not_enrolled' === $status ) {
if ( ! $uid ) {
return true;
}
return ! llms_is_user_enrolled( $uid, $ids, $match );
}
}
}
return $visible;
}
/**
* Detemine if a student is enrolled in at least one course or membership.
*
* @since 1.3.0
*
* @param int $uid WP_User ID.
* @return boolean
*/
private function is_student_enrolled_in_one_thing( $uid ) {
if ( ! $uid ) {
return false;
}
$student = llms_get_student( $uid );
if ( ! $student->exists() ) {
return false;
}
$courses = $student->get_courses(
array(
'limit' => 1,
'status' => 'enrolled',
)
);
if ( $courses['results'] ) {
return true;
}
$memberships = $student->get_membership_levels();
if ( $memberships ) {
return true;
}
return false;
}
/**
* Replace the BB filter after we've rendered our content.
*
* @since 1.3.1
*
* @return void
*/
public function llms_pa_after_content() {
add_filter( 'the_content', 'FLBuilder::render_content' );
}
/**
* BB will replace PA Post content with course/membership pagebuilder content
* so remove the filter and replace when we're done with our output.
*
* @since 1.3.1
*
* @return void
*/
public function llms_pa_before_content() {
remove_filter( 'the_content', 'FLBuilder::render_content' );
}
/**
* Loads LifterLMS modules.
*
* @since 1.3.0
*
* @return void
*/
public function load_modules() {
if ( ! class_exists( 'FLBUilderModule' ) ) {
return;
}
if ( file_exists( LLMS_BB_MODULES_DIR ) ) {
foreach ( glob( LLMS_BB_MODULES_DIR . '**/*.php', GLOB_NOSORT ) as $file ) {
require_once $file;
}
}
}
/**
* Filter out LifterLMS modules if it's not the right post type.
*
* @param $enabled
* @param $instance
*
* @return bool
*/
public function register_module( $enabled, $instance ) {
$post_type = get_post_type();
if ( 'course' !== $post_type && in_array( $instance->slug, array( 'class.llms.lab.course.instructors.module', 'class.llms.lab.course.syllabus.module', 'class.llms.lab.course.progress.bar.module' ) ) ) {
return false;
}
if ( 'llms_membership' !== $post_type && in_array( $instance->slug, array( 'class.llms.lab.membership.instructors.module' ) ) ) {
return false;
}
if ( 'lesson' !== $post_type && in_array( $instance->slug, array( 'class.llms.lab.lesson.mark.complete.module' ) ) ) {
return false;
}
return $enabled;
}
/**
* Load LifterLMS layout templates.
*
* @since 1.3.0
*
* @return void
*/
public function load_templates() {
if ( ! class_exists( 'FLBuilderModel' ) ) {
return;
}
FLBuilderModel::register_templates( LLMS_PLUGIN_DIR . 'includes/beaver-builder/templates/course-template.dat' );
}
/**
* Modify LifterLMS metabox Fields to show the page builder is active.
*
* @since 1.3.0
* @since 1.5.2 Unknown.
* @since 1.7.0 Use strict comparison for `in_array`.
*
* @param array $fields Metabox fields.
* @return array
*/
public function mod_metabox_fields( $fields ) {
global $post;
$post_types = array( 'course', 'lesson', 'llms_membership' );
if ( in_array( $post->post_type, $post_types, true ) && FLBuilderModel::is_builder_enabled() ) {
unset( $fields[0]['fields'][0]['value']['content'] );
}
return $fields;
}
/**
* Bypass restriction checks for courses and memberships when the builder is active.
*
* Allows the builder to use custom LifterLMS visibility settings when a student is not enrolled.
*
* @since 1.3.0
* @since 1.7.0 Use `in_array` with strict comparison.
*
* @param array $results Restriction results data.
* @param int $post_id Current post id.
* @return array
*/
public function mod_page_restrictions( $results, $post_id ) {
if (
FLBuilderModel::is_builder_enabled() &&
$results['is_restricted'] &&
in_array( get_post_type( $post_id ), array( 'course', 'llms_membership' ), true )
) {
$results['is_restricted'] = false;
$results['reason'] = 'bb-lab';
}
return $results;
}
/**
* Prevent page building of LifterLMS Post Types that can't actually be pagebuilt despite what the settings may assume.
*
* @since 1.5.0
* @since 1.7.0 Removed unset parameters for `llms_certificate` and `llms_my_certificate` from the filter.
*
* @param array $post_types Post type objects as an array.
* @return array
*/
public function remove_uneditable_post_types( $post_types ) {
unset( $post_types['llms_quiz'] );
unset( $post_types['llms_question'] );
return $post_types;
}
/**
* Upgrade url.
*
* @since 1.3.0
*
* @param string $url Default upgrade url.
* @return string
*/
public function upgrade_url( $url ) {
return 'https://www.wpbeaverbuilder.com/?fla=968';
}
}
return new LLMS_Beaver_Builder();
================================================
FILE: includes/class-llms-block-library.php
================================================
<?php
/**
* LLMS_Block_Library class file.
*
* @package LifterLMS/Classes
*
* @since 6.0.0
* @version 6.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Load the LifterLMS block library.
*
* @since 6.0.0
*/
class LLMS_Block_Library {
/**
* Constructor.
*
* @since 6.0.0
*
* @return void
*/
public function __construct() {
add_action( 'init', array( $this, 'register' ) );
add_filter( 'block_editor_settings_all', array( $this, 'modify_editor_settings' ), 100, 2 );
}
/**
* Retrieves a list of blocks to register.
*
* @since 6.0.0
*
* @return string[] A list of directory paths that can individually be passed to `register_block_type()`.
*/
private function get_blocks() {
$blocks = array();
if ( llms_is_block_editor_supported_for_certificates() ) {
$blocks['certificate-title'] = array(
'path' => null,
'post_types' => array(
'llms_certificate',
'llms_my_certificate',
),
);
}
// Add default path to all blocks.
foreach ( $blocks as $id => &$block ) {
$block['path'] = is_null( $block['path'] ) ? LLMS_PLUGIN_DIR . 'blocks/' . $id : $block['path'];
}
return $blocks;
}
/**
* Loads custom fonts for the llms/certificate-title block.
*
* @since 6.0.0
*
* @param array $settings Editor settings.
* @param WP_Block_Editor_Context $context Current block editor context.
* @return array
*/
public function modify_editor_settings( $settings, $context ) {
// Only load fonts when in post editor context for a certificate post type.
if ( ! empty( $context->post ) && in_array( $context->post->post_type, array( 'llms_certificate', 'llms_my_certificate' ), true ) ) {
$theme_fonts = $settings['__experimentalFeatures']['typography']['fontFamilies']['theme'] ?? array();
$fonts = llms_get_certificate_fonts();
$custom_fonts = array_map(
function( $slug, $font_data ) {
unset( $font_data['href'] );
$font_data['slug'] = $slug;
return $font_data;
},
array_keys( $fonts ),
$fonts
);
_wp_array_set(
$settings,
array(
'__experimentalFeatures',
'blocks',
'llms/certificate-title',
'typography',
'fontFamilies',
'custom',
),
array_merge( $theme_fonts, array_filter( $custom_fonts ) )
);
}
return $settings;
}
/**
* Register all blocks in the LifterLMS block library.
*
* @since 6.0.0
*
* @return void
*/
public function register() {
foreach ( $this->get_blocks() as $id => $block ) {
if ( $this->should_register( $id, $block ) ) {
register_block_type( $block['path'] );
}
}
}
/**
* Determines whether or not the block should be registered.
*
* There's no "good" way to register a block only for a specific post type(s) or context (such
* as the post editor only and not the widgets editor).
*
* This method uses the `$pagenow` global and query string variables to interpret the current
* screen context and register the block only in the intended context.
*
* This creates issues if the block list is retrieve via the REST API. But we can't avoid this
* given the current APIs. Especially since the WP core throw's a notice on the widgets screen
* if a block is registered with a script that relies on `wp-editor` as a dependency.
*
* See related issue links below.
*
* @since 6.0.0
* @since 6.4.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @link https://github.com/WordPress/gutenberg/issues/28517
* @link https://github.com/WordPress/gutenberg/issues/12931
*
* @param string $id The block's id (without the `llms/` prefix).
* @param array $block Array of block data.
* @return boolean
*/
private function should_register( $id, $block ) {
// Prevent errors if the block is already registered.
$registry = WP_Block_Type_Registry::get_instance();
if ( $registry->is_registered( 'llms/' . $id ) ) {
return false;
}
// Ensure the block is only registered in the correct context.
global $pagenow;
$post_type = null;
if ( 'post.php' === $pagenow ) {
$id = llms_filter_input( INPUT_GET, 'post', FILTER_SANITIZE_NUMBER_INT );
$post_type = $id ? get_post_type( $id ) : $post_type;
} elseif ( 'post-new.php' === $pagenow ) {
$post_type = llms_filter_input( INPUT_GET, 'post_type' );
$post_type = $post_type ? $post_type : 'post'; // If `$_GET` is not set it's because it's a basic post.
}
if ( ! is_null( $post_type ) && in_array( $post_type, $block['post_types'], true ) ) {
return true;
}
return false;
}
}
return new LLMS_Block_Library();
================================================
FILE: includes/class-llms-block-templates.php
================================================
<?php
/**
* LLMS_Block_Templates class file
*
* @package LifterLMS/Classes
*
* @since 5.8.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Handles the block templates.
*
* @since 5.8.0
*/
class LLMS_Block_Templates {
use LLMS_Trait_Singleton;
/**
* Directory name of the block templates.
*
* @var string
*/
const LLMS_BLOCK_TEMPLATES_DIRECTORY_NAME = 'block-templates';
/**
* Block Template namespace.
*
* This is used to save templates to the DB which are stored against this value in the wp_terms table.
*
* @var string
*/
const LLMS_BLOCK_TEMPLATES_NAMESPACE = 'lifterlms/lifterlms';
/**
* Block Template slug prefix.
*
* @var string
*/
const LLMS_BLOCK_TEMPLATES_PREFIX = 'llms_';
/**
* Block templates configuration.
*
* @var array
*/
private $block_templates_config;
/**
* Private Constructor.
*
* @since 5.8.0
*
* @return void
*/
private function __construct() {
$this->configure_block_templates();
add_filter( 'get_block_templates', array( $this, 'add_llms_block_templates' ), 10, 3 );
add_filter( 'pre_get_block_file_template', array( $this, 'maybe_return_blocks_template' ), 10, 3 );
add_action( 'admin_enqueue_scripts', array( $this, 'localize_blocks' ), 9999 );
}
/**
* Configure block templates.
*
* @since 5.8.0
*
* @return void
*/
public function configure_block_templates() {
$block_templates_config = array(
llms()->plugin_path() . '/templates/' . self::LLMS_BLOCK_TEMPLATES_DIRECTORY_NAME => array(
'slug_prefix' => self::LLMS_BLOCK_TEMPLATES_PREFIX,
'namespace' => self::LLMS_BLOCK_TEMPLATES_NAMESPACE,
'blocks_dir' => self::LLMS_BLOCK_TEMPLATES_DIRECTORY_NAME, // Relative to the plugin's templates directory.
'admin_blocks_l10n' => $this->block_editor_l10n(),
'template_titles' => $this->template_titles(),
),
);
/**
* Filters the block templates configuration.
*
* @since 5.8.0
*
* @param array $block_templates_config Block templates configuration array.
*/
$this->block_templates_config = apply_filters( 'llms_block_templates_config', $block_templates_config );
}
/**
* This function checks if there's a blocks template to return to pre_get_posts short-circuiting the query in Gutenberg.
*
* Ultimately it resolves either a saved blocks template from the
* database or a template file in `lifterlms/templates/block-templates/`.
* Without this it won't be possible to save llms templates customizations in the DB.
*
* @since 5.8.0
*
* @param WP_Block_Template|null $template Return a block template object to short-circuit the default query,
* or null to allow WP to run its normal queries.
* @param string $id Template unique identifier (example: theme_slug//template_slug).
* @param array $template_type wp_template or wp_template_part.
* @return mixed|WP_Block_Template|WP_Error
*/
public function maybe_return_blocks_template( $template, $id, $template_type ) {
// Bail if 'get_block_template' (introduced in WP 5.9.) doesn't exist, or the requested template is not a 'wp_template' type.
if ( ! function_exists( 'get_block_template' ) || 'wp_template' !== $template_type ) {
return $template;
}
$template_name_parts = explode( '//', $id );
if ( count( $template_name_parts ) < 2 ) {
return $template;
}
list( , $slug ) = $template_name_parts;
// Remove the filter at this point because if we don't then this function will infinite loop.
remove_filter( 'pre_get_block_file_template', array( $this, 'maybe_return_blocks_template' ), 10, 3 );
// Check if the theme has a saved version of this template before falling back to the llms one.
$maybe_template = get_block_template( $id, $template_type );
if ( null !== $maybe_template ) {
add_filter( 'pre_get_block_file_template', array( $this, 'maybe_return_blocks_template' ), 10, 3 );
return $maybe_template;
}
// Theme-based template didn't exist, try switching the theme to lifterlms and try again. This function has
// been unhooked so won't run again.
add_filter( 'get_block_file_template', array( $this, 'get_single_block_template' ), 10, 3 );
$maybe_template = get_block_template( $id, $template_type );
// Re-hook this function, it was only unhooked to stop recursion.
add_filter( 'pre_get_block_file_template', array( $this, 'maybe_return_blocks_template' ), 10, 3 );
remove_filter( 'get_block_file_template', array( $this, 'get_single_block_template' ), 10, 3 );
if ( null !== $maybe_template ) {
return $maybe_template;
}
// At this point we haven't had any luck finding a template. Give up and let Gutenberg take control again.
return $template;
}
/**
* Runs on the get_block_template hook.
*
* If a template is already found and passed to this function, then return it and don't run.
* If a template is *not* passed, try to look for one that matches the ID in the database, if that's not found defer
* to Blocks templates files. Priority goes: DB-Theme, DB-Blocks, Filesystem-Theme, Filesystem-Blocks.
*
* @since 5.8.0
*
* @param WP_Block_Template $template The found block template.
* @param string $id Template unique identifier (example: theme_slug//template_slug).
* @param array $template_type wp_template or wp_template_part.
*
* @return mixed|null
*/
public function get_single_block_template( $template, $id, $template_type ) {
// The template was already found before the filter runs, or the requested template is not a 'wp_template' type, just return it immediately.
if ( null !== $template || 'wp_template' !== $template_type ) {
return $template;
}
$template_name_parts = explode( '//', $id );
if ( count( $template_name_parts ) < 2 ) {
return $template;
}
list( , $slug ) = $template_name_parts;
// Get available llms templates from the filesystem.
$available_templates = $this->block_templates( array( $slug ), '', true );
// If this blocks template doesn't exist then we should just skip the function and let Gutenberg handle it.
if ( ! in_array( $slug, wp_list_pluck( $available_templates, 'slug' ), true ) ) {
return $template;
}
$template = ( is_array( $available_templates ) && count( $available_templates ) > 0 ) ?
$available_templates[0] : $template;
return $template;
}
/**
* Gets the templates.
*
* @since 5.8.0
* @since 5.9.0 Filter template slugs array before checking if it's empty.
*
* @param array $slugs An array of slugs to retrieve templates for.
* @param string $post_type Post Type.
* @param bool $fs_only Retrieve templates from the filesystem ony.
* @return WP_Block_Template[] Templates.
*/
private function block_templates( $slugs = array(), $post_type = '', $fs_only = false ) {
// Get paths where to look for block templates.
$block_templates_paths = $this->block_templates_paths();
// Get all the slugs.
$template_slugs = array_map( array( $this, 'generate_template_slug_from_path' ), $block_templates_paths );
// If specific slugs are required, filter them only.
$template_slugs = empty( array_filter( $slugs ) ) ? $template_slugs : array_intersect( $slugs, $template_slugs );
if ( empty( $template_slugs ) ) {
return array();
}
$templates = $fs_only
?
$this->block_templates_from_fs( $block_templates_paths, $template_slugs )
:
array_merge(
$this->block_templates_from_db( $template_slugs ),
$this->block_templates_from_fs( $block_templates_paths, $template_slugs )
);
// DB wins over fs, exclude not allowed post types.
$templates = array_values(
array_filter(
$templates,
function( $template, $key ) use ( $templates, $post_type ) {
return ( ! ( $post_type && isset( $template->post_types ) && ! in_array( $post_type, $template->post_types, true ) ) ) &&
array_search( $template->slug, array_unique( wp_list_pluck( $templates, 'slug' ) ), true ) === $key;
},
ARRAY_FILTER_USE_BOTH
)
);
return $templates;
}
/**
* Get block templates from the file system.
*
* @since 5.8.0
*
* @param string[] $block_templates_paths Array of block templates paths to look for templates.
* @param string[] $slugs Arrray of template slugs to be retrieved.
* @return void
*/
private function block_templates_from_fs( $block_templates_paths, $slugs = array() ) {
$templates = array();
foreach ( $block_templates_paths as $template_file ) {
$template_slug = $this->generate_template_slug_from_path( $template_file );
if ( ! empty( $slugs ) && ! in_array( $template_slug, $slugs, true ) ) {
continue;
}
$templates[] = $this->build_template_result_from_file( $template_file, $template_slug );
}
return $templates;
}
/**
* Gets the templates saved in the database.
*
* @since 5.8.0
*
* @param array $slugs An array of slugs to retrieve templates for.
* @return int[]|WP_Post[] An array of found templates.
*/
private function block_templates_from_db( $slugs = array() ) {
$query_args = array(
'post_status' => array( 'auto-draft', 'draft', 'publish' ),
'post_type' => 'wp_template',
'posts_per_page' => -1,
'no_found_rows' => true,
'tax_query' => array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query
array(
'taxonomy' => 'wp_theme',
'field' => 'name',
'terms' => array_merge(
array( get_stylesheet(), get_template() ),
array_column( $this->block_templates_config, 'namespace' )
),
),
),
);
if ( is_array( $slugs ) && count( $slugs ) > 0 ) {
$query_args['post_name__in'] = $slugs;
}
/**
* Filters the query arguments to retrieve the templates saved in the db.
*
* @since 5.8.0
*
* @param array $query_args WQ_Query argiments to retrieve the templates saved in the db.
*/
$query_args = apply_filters( 'llms_block_templates_from_db_query_args', $query_args );
$templates = ( new WP_Query( $query_args ) )->posts;
return array_map(
function( $template ) {
return $this->build_template_result_from_post( $template );
},
$templates
);
}
/**
* Retrieve the block templates directory paths.
*
* @since 5.8.0
*
* @return string[]
*/
private function block_templates_paths() {
$block_template_paths = array();
$block_templates_base_paths = array_keys( $this->block_templates_config );
foreach ( $block_templates_base_paths as $block_template_base_path ) {
$block_template_paths = array_merge(
_get_block_templates_paths( $block_template_base_path ),
$block_template_paths
);
}
return $block_template_paths;
}
/**
* Build a wp template from file.
*
* @since 5.8.0
* @since 5.9.0 Allow template directory override when the block template comes from an add-on.
* @since 7.5.0 Use `traverse_and_serialize_blocks` in place of deprecated (since wp 6.4.0) `_inject_theme_attribute_in_block_template_content`
*
* @param string $template_file Template file path.
* @param string $template_slug Template slug.
* @return WP_Block_Template
*/
private function build_template_result_from_file( $template_file, $template_slug = '' ) {
$template_slug = empty( $template_slug ) ? $this->generate_template_slug_from_path( $template_file ) : $template_slug;
$namespace = $this->generate_template_namespace_from_path( $template_file ); // Looks like 'lifterlms/lifterlms' or 'lifterlms-groups/lifterlms-groups', etc.
$template_file = $this->get_maybe_overridden_block_template_file_path( $template_file );
// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
$template_content = file_get_contents( $template_file );
// Is the template from the theme/child-theme.
$theme = false !== strpos( $template_file, get_template_directory() ) ? get_template() : get_stylesheet();
$theme = false !== strpos( $template_file, get_stylesheet_directory() ) ? $theme : false;
$template = new WP_Block_Template();
$template->id = $theme ? $theme . '//' . $template_slug : $namespace . '//' . $template_slug;
$template->theme = $theme ? $theme : $namespace;
$template->content = function_exists( 'traverse_and_serialize_blocks' ) ?
traverse_and_serialize_blocks( parse_blocks( $template_content ), '_inject_theme_attribute_in_template_part_block' ) :
_inject_theme_attribute_in_block_template_content( $template_content );
$template->source = $theme ? 'theme' : 'plugin'; // Plugin was agreed as a valid source value despite existing inline docs at the time of creating: https://github.com/WordPress/gutenberg/issues/36597#issuecomment-976232909.
$template->slug = $template_slug;
$template->type = 'wp_template';
$template->title = $this->convert_slug_to_title( $template_slug );
$template->status = 'publish';
$template->has_theme_file = true;
$template->origin = $theme ? 'theme' : 'plugin';
$template->is_custom = false; // Templates loaded from the filesystem aren't custom, ones that have been edited and loaded from the DB are.
$template->post_types = array(); // Don't appear in any Edit Post template selector dropdown.
return $template;
}
/**
* Build a unified template object based on a WP_Post object.
*
* @since 5.8.0
*
* @param WP_Post $post Template post.
* @return WP_Block_Template|WP_Error Template.
*/
private function build_template_result_from_post( $post ) {
$terms = get_the_terms( $post, 'wp_theme' );
if ( is_wp_error( $terms ) ) {
return $terms;
}
if ( ! $terms ) {
return new \WP_Error( 'template_missing_theme', __( 'No theme is defined for this template.', 'lifterlms' ) );
}
$theme = $terms[0]->name;
$template = new WP_Block_Template();
$template->wp_id = $post->ID;
$template->id = $theme . '//' . $post->post_name;
$template->theme = $theme;
$template->content = $post->post_content;
$template->slug = $post->post_name;
$template->source = 'custom';
$template->type = $post->post_type;
$template->description = $post->post_excerpt;
$template->title = $post->post_title;
$template->status = $post->post_status;
$template->has_theme_file = true;
$template->is_custom = false;
$template->post_types = array(); // Don't appear in any Edit Post template selector dropdown.
/**
* Set the 'plugin' origin
* if it doesn't come from from the current theme (or its parent).
*/
if ( ! in_array( $theme, array( get_template(), get_stylesheet() ), true ) ) {
$template->origin = 'plugin';
}
return $template;
}
/**
* Retrieve the actual template file path, maybe overridden in the theme.
*
* @since 5.9.0
*
* @param string $template_file The template's path.
* @return string
*/
private function get_maybe_overridden_block_template_file_path( $template_file ) {
$template_path_info = pathinfo( $template_file );
$template_file_name = $template_path_info['filename'];
$template_blocks_dir = untrailingslashit( $this->generate_template_blocks_dir_from_path( $template_file ) ); // Looks like 'block-templates'.
/**
* Does this come from LifterLMS or from an add-on? In the latter case use the absolute path.
*
* $template_path_info['dirname'] looks like 'ABSPATH/wp-content/plugins/lifterlms/templates/block-templates' or
* 'ABSPATH/wp-content/plugins/lifterlms-groups/templates/block-templates' for an add-on.
*/
return false !== strpos( $template_path_info['dirname'], trailingslashit( llms()->plugin_path() ) )
?
llms_template_file_path(
$template_blocks_dir . '/' . $template_file_name . '.html'
)
:
llms_template_file_path(
$template_blocks_dir . '/' . $template_file_name . '.html', // Looks like 'block-templates/single-llms_group.html'.
substr( $template_path_info['dirname'], 0, -1 * strlen( $template_blocks_dir ) ), // Looks like 'ABSPATH/wp-content/plugins/lifterlms-groups/templates/'.
true
);
}
/**
* Convert the template paths into a slug.
*
* @since 5.8.0
* @since 5.9.0 Return empty string if the passed path is not in the configuration.
* @since 5.10.0 Use '/' in favor of DIRECTORY_SEPARATOR to avoid issues on Windows.
* @since 7.2.0 Retrieve the slug by using `basename()` which also fixes issues on Windows filesystems.
*
* @param string $path The template's path.
* @return string
*/
private function generate_template_slug_from_path( $path ) {
$prefix = $this->block_template_config_property_from_path( $path, 'slug_prefix' );
return $prefix . basename( $path, '.html' );
}
/**
* Generate the template namespace from the template path.
*
* @since 5.8.0
*
* @param string $path The template's path.
* @return string
*/
private function generate_template_namespace_from_path( $path ) {
return $this->block_template_config_property_from_path( $path, 'namespace' );
}
/**
* Generate the template slug prefix from the template path.
*
* @since 5.8.0
* @since 5.9.0 Fix property name.
*
* @param string $path The template's path.
* @return string
*/
private function generate_template_prefix_from_path( $path ) {
return $this->block_template_config_property_from_path( $path, 'slug_prefix' );
}
/**
* Generate the block template directory (relative to the templates direcotry) from the template path.
*
* @since 5.9.0
*
* @param string $path The template's path.
* @return string
*/
private function generate_template_blocks_dir_from_path( $path ) {
return $this->block_template_config_property_from_path( $path, 'blocks_dir' );
}
/**
* Retrieve a template config property from path.
*
* @since 5.8.0
* @since 5.9.0 Return an empty string if requesting a non existing property.
* Also removed unused var `$dirname`.
*
* @param string $path The template's path.
* @param string $property The template's config property to retrieve.
* @return string
*/
private function block_template_config_property_from_path( $path, $property ) {
$prop_value = '';
foreach ( $this->block_templates_config as $block_templates_base_path => $config ) {
if ( false !== strpos( $path, $block_templates_base_path ) ) {
$prop_value = $config[ $property ] ?? $prop_value;
break;
}
}
return $prop_value;
}
/**
* Converts template slugs into readable titles.
*
* @since 5.8.0
*
* @param string $template_slug The templates slug (e.g. single-product).
* @return string Human friendly title converted from the slug.
*/
private function convert_slug_to_title( $template_slug ) {
$template_titles = array_merge( ...array_column( $this->block_templates_config, 'template_titles' ) );
return array_key_exists( $template_slug, $template_titles ) ?
$template_titles[ $template_slug ]
:
// Replace all hyphens and underscores with spaces.
ucwords( preg_replace( '/[\-_]/', ' ', $template_slug ) );
}
/**
* Add lifterlms blocks templates.
*
* @since 5.8.0
* @since 6.0.0 Use `llms_is_block_theme()` in favor of `wp_is_block_theme()`.
*
* @param WP_Block_Template[] $query_result Array of found block templates.
* @param array $query {
* Optional. Arguments to retrieve templates.
*
* @type array $slug__in List of slugs to include.
* @type int $wp_id Post ID of customized template.
* }
* @param array $template_type wp_template or wp_template_part.
* @return WP_Block_Template[] Templates.
*/
public function add_llms_block_templates( $query_result, $query, $template_type = 'wp_template' ) {
// Bail it's not a block theme, or is being retrieved a non wp_template type requested.
if ( ! llms_is_block_theme() || 'wp_template' !== $template_type ) {
return $query_result;
}
$post_type = $query['post_type'] ?? '';
$slugs = $query['slug__in'] ?? array();
// Retrieve templates.
$templates = $this->block_templates( $slugs, $post_type );
/**
* Remove theme override templates who have a customization in the db from $query_result:
* those template blocks will be already retrieved by our LLMS_Block_Templates::block_templates_from_db().
*/
$query_result = array_values(
array_filter(
$query_result,
function( $template ) use ( $templates ) {
$slugs = wp_list_pluck( $templates, 'slug' );
return ( ! in_array( $template->slug, $slugs, true ) );
}
)
);
return array_merge( $query_result, $templates );
}
/**
* Returns an associative array of template titles.
*
* Keys are template slugs.
* Values are template titles in a human readable form.
*
* @since 5.8.0
*
* @return array
*/
private function template_titles() {
$template_titles = array(
self::LLMS_BLOCK_TEMPLATES_PREFIX . 'archive-course' => esc_html__( 'Course Catalog', 'lifterlms' ),
self::LLMS_BLOCK_TEMPLATES_PREFIX . 'archive-llms_membership' => esc_html__( 'Membership Catalog', 'lifterlms' ),
self::LLMS_BLOCK_TEMPLATES_PREFIX . 'single-certificate' => esc_html__( 'Single Certificate', 'lifterlms' ),
self::LLMS_BLOCK_TEMPLATES_PREFIX . 'single-no-access' => esc_html__( 'Single Access Restricted', 'lifterlms' ),
self::LLMS_BLOCK_TEMPLATES_PREFIX . 'taxonomy-course_cat' => esc_html__( 'Taxonomy Course Category', 'lifterlms' ),
self::LLMS_BLOCK_TEMPLATES_PREFIX . 'taxonomy-course_difficulty' => esc_html__( 'Taxonomy Course Difficulty', 'lifterlms' ),
self::LLMS_BLOCK_TEMPLATES_PREFIX . 'taxonomy-course_tag' => esc_html__( 'Taxonomy Course Tag', 'lifterlms' ),
self::LLMS_BLOCK_TEMPLATES_PREFIX . 'taxonomy-course_track' => esc_html__( 'Taxonomy Course Track', 'lifterlms' ),
self::LLMS_BLOCK_TEMPLATES_PREFIX . 'taxonomy-membership_cat' => esc_html__( 'Taxonomy Membership Category', 'lifterlms' ),
self::LLMS_BLOCK_TEMPLATES_PREFIX . 'taxonomy-membership_tag' => esc_html__( 'Taxonomy Membership Tag', 'lifterlms' ),
);
/**
* Filters the block template titles.
*
* @since 5.8.0
*
* @param array $template_titles {
* Associative array of template titles.
*
* @type string $slug The template slug.
* @type string $title The template readable titles.
* }
*/
return apply_filters( 'lifterlms_block_templates_titles', $template_titles );
}
/**
* Block Templates admin js strings.
*
* @since 5.8.0
*
* @return string[]
*/
private function block_editor_l10n() {
return array(
'archive-course' => esc_html__( 'LifterLMS Course Catalog Template', 'lifterlms' ),
'archive-llms_membership' => esc_html__( 'LifterLMS Membership Catalog Template', 'lifterlms' ),
'single-certificate' => esc_html__( 'LifterLMS Certificate Template', 'lifterlms' ),
'single-no-access' => esc_html__( 'LifterLMS Single Template Access Restricted', 'lifterlms' ),
'taxonomy-course_cat' => esc_html__( 'LifterLMS Course Category Taxonomy Template', 'lifterlms' ),
'taxonomy-course_difficulty' => esc_html__( 'LifterLMS Course Difficulty Taxonomy Template', 'lifterlms' ),
'taxonomy-course_tag' => esc_html__( 'LifterLMS Course Tag Taxonomy Template', 'lifterlms' ),
'taxonomy-course_track' => esc_html__( 'LifterLMS Course Track Taxonomy Template', 'lifterlms' ),
'taxonomy-membership_cat' => esc_html__( 'LifterLMS Membership Tag Taxonomy Template', 'lifterlms' ),
'taxonomy-membership_tag' => esc_html__( 'LifterLMS Membership Tag Taxonomy Template', 'lifterlms' ),
);
}
/**
* Localize block templates.
*
* @since 5.8.0
* @since 5.9.0 Retuns the `wp_localize_script()` return value.
*
* @return bool
*/
public function localize_blocks() {
return wp_localize_script(
'llms-blocks-editor',
'llmsBlockTemplatesL10n',
array_merge( ...array_column( $this->block_templates_config, 'admin_blocks_l10n' ) )
);
}
}
================================================
FILE: includes/class-llms-bricks.php
================================================
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
class LLMS_Bricks {
use LLMS_Trait_Singleton;
public function __construct() {
$this->init();
}
public function is_available() {
return class_exists( '\Bricks\Elements' ) && function_exists( 'bricks_is_builder' );
}
protected function init() {
if ( ! $this->is_available() ) {
return;
}
add_action( 'init', array( $this, 'register_elements' ), 11 );
add_action( 'init', array( $this, 'add_builder_css' ), 11 );
add_filter( 'bricks/builder/i18n', array( $this, 'i18n' ) );
}
public function register_elements() {
$element_files = glob( LLMS_PLUGIN_DIR . 'includes/bricks/class-llms-bricks-element-*.php' );
foreach ( $element_files as $file ) {
\Bricks\Elements::register_element( $file );
}
}
public function add_builder_css() {
if ( ! bricks_is_builder() ) {
return;
}
wp_enqueue_style( 'llms-bricks-editor', LLMS_PLUGIN_URL . 'assets/css/bricks-editor.css', array(), filemtime( LLMS_PLUGIN_DIR . 'assets/css/bricks-editor.css' ) );
}
public function i18n( $i18n ) {
$i18n['lifterlms'] = esc_html__( 'LifterLMS', 'lifterlms' );
return $i18n;
}
}
return new LLMS_Bricks();
================================================
FILE: includes/class-llms-course-completion-page.php
================================================
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
class LLMS_Course_Completion_Page {
use LLMS_Trait_Singleton;
public function __construct() {
$this->init();
}
protected function init() {
// Add it as the last action to ensure other handlers of course completion happen first.
add_action( 'lifterlms_course_completed', array( $this, 'maybe_redirect_to_course_completion_page' ), 9999, 2 );
}
public function maybe_redirect_to_course_completion_page( $student_id, $related_post_id ) {
if ( is_admin() || $student_id !== get_current_user_id() ) {
return;
}
$course = new LLMS_Course( $related_post_id );
if ( ! $course ) {
return;
}
if ( $course->get( 'completion_page_id' ) ) {
wp_safe_redirect( get_permalink( $course->get( 'completion_page_id' ) ) );
exit();
}
if ( get_option( 'lifterlms_course_completion_page_id', '' ) ) {
wp_safe_redirect( get_permalink( get_option( 'lifterlms_course_completion_page_id' ) ) );
exit();
}
}
}
return new LLMS_Course_Completion_Page();
================================================
FILE: includes/class-llms-db-ugrader.php
================================================
<?php
/**
* LLMS_DB_Upgrader class file
*
* @package LifterLMS/Classes
*
* @since 5.2.0
* @version 5.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Manage database updates and migrations
*
* @since 5.2.0
*/
class LLMS_DB_Upgrader {
/**
* DB Version that's being upgraded from.
*
* @var string
*/
protected $db_version = '';
/**
* Instance of the bg updater class
*
* @var LLMS_Background_Updater
*/
protected $updater = null;
/**
* Update list
*
* @var array
*/
protected $updates = array();
/**
* Constructor
*
* @since 5.2.0
*
* @see includes/schemas/llms-db-updates.php For an example updates schema.
*
* @param string $db_version The DB version that is being upgraded from.
* @param null|array[] $updates A list of database updates conforming to the database updates schema
* or null to load the LifterLMS core schema.
*/
public function __construct( $db_version, $updates = null ) {
if ( ! LLMS_Install::$background_updater ) {
LLMS_Install::init_background_updater();
}
$this->updater = LLMS_Install::$background_updater;
// Background updates may trigger a notice during a cron and notices might not be available.
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.notices.php';
if ( is_null( $updates ) ) {
$updates = require LLMS_PLUGIN_DIR . 'includes/schemas/llms-db-updates.php';
}
$this->db_version = $db_version;
$this->updates = $updates;
}
/**
* Determine if an auto-update is possible from the specified DB version
*
* Auto updating is possible as long as none of the required updates are marked as "manual".
*
* @since 5.2.0
*
* @return boolean Returns `true` when an auto-update is possible and `false` if manual updating
* is required.
*/
public function can_auto_update() {
$autoupdate = true;
foreach ( $this->get_required_updates( $this->db_version ) as $update ) {
// If we find a manual update we cannot auto-update.
if ( 'manual' === $update['type'] ) {
$autoupdate = false;
break;
}
}
/**
* Filters the list of database updates.
*
* @since 5.2.0
*
* @param boolean $autoupdate Whether or not an automatic update can be run.
* @param string $db_version The specified DB that's being upgraded from.
* @param LLMS_DB_Upgrader $upgrader Instance of the database upgrader.
*/
return apply_filters( 'llms_can_auto_update_db', $autoupdate, $this->db_version, $this );
}
/**
* Retrieve the callback's prefix string based on the schema's namespace declaration.
*
* If `$info['namespace']` is empty, no prefix will be added.
* If `$info['namespace']` is `true`, the namespace is assumed to be `LLMS\Updates`.
* If `$info['namespace']` is a string, that string will be used.
*
* If a namespace is found, `\Version_X_X_X` will automatically be appended to the namespace. The
* string `X_X_X` is the database version for the upgrade substituting underscores for dots.
*
* @since 5.6.0
*
* @param array $info Upgrade schema array.
* @param string $version Version string for the upgrade.
* @return string
*/
protected function get_callback_prefix( $info, $version ) {
if ( ! empty( $info['namespace'] ) ) {
$ver = explode( '-', $version ); // Drop prerelease data.
$ver = str_replace( '.', '_', $ver[0] );
$ns = true === $info['namespace'] ? 'LLMS\Updates' : $info['namespace'];
return sprintf( '%1$s\\Version_%2$s\\', $ns, $ver );
}
return '';
}
/**
* Enqueue and dispatch required updates
*
* Adds callbacks for all required updates to the LLMS_Background_Updater and dispatches
* the updater in the background.
*
* If the update group cannot be auto-updated the following admin notices will be included:
* + The "update started" notice will be immediately displayed/added.
* + The "update complete" notice will be added to the end of the queue (and then displayed when the update is complete).
*
* @since 5.2.0
* @since 5.6.0 Add namespace prefix to qualifying callback functions.
*
* @return void
*/
public function enqueue_updates() {
$queued = false;
foreach ( $this->get_required_updates() as $version => $info ) {
$prefix = $this->get_callback_prefix( $info, $version );
foreach ( $info['updates'] as $callback ) {
$callback = $prefix . $callback;
$this->updater->log( sprintf( 'Queuing %s - %s', $version, $callback ) );
$this->updater->push_to_queue( $callback );
$queued = true;
}
}
// No updates to add, return early.
if ( ! $queued ) {
return;
}
// Show a start and complete notice for manual updates.
if ( ! $this->can_auto_update() ) {
$this->show_notice_started();
$this->updater->push_to_queue( array( $this, 'show_notice_complete' ) );
}
$this->updater->save();
add_action( 'shutdown', array( 'LLMS_Install', 'dispatch_db_updates' ) );
}
/**
* Retrieves the updates list
*
* @since 5.2.0
*
* @return array
*/
public function get_updates() {
/**
* Filters the list of database updates.
*
* @since 5.2.0
*
* @param array $updates List of updates to be run.
* @param LLMS_DB_Upgrader $upgrader Instance of the database upgrader.
*/
return apply_filters( 'llms_db_updates_list', $this->updates, $this );
}
/**
* Retrieve a filtered list of updates as required by the specified DB version
*
* All updates greater than the specified version will be returned.
*
* @since 5.2.0
*
* @return array[]
*/
public function get_required_updates() {
$db_version = $this->db_version;
return array_filter(
$this->get_updates(),
function ( $update_version ) use ( $db_version ) {
return version_compare( $db_version, $update_version, '<' );
},
ARRAY_FILTER_USE_KEY
);
}
/**
* Determine whether or not there are required updates for a specified DB version.
*
* @since 5.2.0
*
* @return boolean Returns `true` if there are updates to run, otherwise returns `false`.
*/
public function has_required_updates() {
$required = $this->get_required_updates( $this->db_version );
return ! empty( $required );
}
/**
* Show the db upgrade admin notice.
*
* Users can click this notice to start the database upgrade(s).
*
* @since 5.2.0
*
* @return void
*/
protected function show_notice_pending() {
$notice_id = 'bg-db-update';
if ( LLMS_Admin_Notices::has_notice( $notice_id ) ) {
LLMS_Admin_Notices::delete_notice( $notice_id );
}
LLMS_Admin_Notices::add_notice(
$notice_id,
array(
'dismissible' => false,
'template' => 'db-update.php',
'default_path' => LLMS_PLUGIN_DIR . 'includes/admin/views/notices/',
)
);
}
/**
* Show a notice when a manual update is started.
*
* @since 5.2.0
*
* @return void
*/
protected function show_notice_started() {
LLMS_Admin_Notices::add_notice(
'bg-db-update-started',
__( 'Your database is being upgraded in the background. Feel free to leave this page. A notice like this will appear when the update is complete.', 'lifterlms' ),
array(
'dismissible' => true,
'dismiss_for_days' => 0,
)
);
}
/**
* Show a notice when the update is complete
*
* This will also delete the started notice. When short updates run quickly the started and completed notice
* may show up on the same page load which is confusing to look at it. If we just started and it's already done
* when the next page loads we only need to see that update is complete.
*
* @since 5.2.0
*
* @return void
*/
public function show_notice_complete() {
// If the update started notice exists, delete it to avoid confusing UX when the update finishes before the page loads.
if ( LLMS_Admin_Notices::has_notice( 'bg-db-update-started' ) ) {
LLMS_Admin_Notices::delete_notice( 'bg-db-update-started' );
}
LLMS_Admin_Notices::add_notice(
'bg-db-update-complete',
__( 'The LifterLMS database update is complete.', 'lifterlms' ),
array(
'dismissible' => true,
'dismiss_for_days' => 0,
)
);
}
/**
* Start the update
*
* If autoupdating is possible, will enqueue and dispatch the bg updater. Otherwise
* it will show the update pending notice which will prompt an admin to manually
* start the update.
*
* @since 5.2.0
*
* @return boolean Returns `false` if there are no updates to run and `true` otherwise.
*/
public function update() {
if ( ! $this->has_required_updates() ) {
return false;
}
// Auto update if it can.
if ( $this->can_auto_update() ) {
$this->enqueue_updates();
} else {
$this->show_notice_pending();
}
return true;
}
}
================================================
FILE: includes/class-llms-dom-document.php
================================================
<?php
/**
* A convenient wrapper for the DOMDocument Class
*
* @package LifterLMS/Classes
*
* @since 4.13.0
* @version 4.13.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_DOM_Document Class
*
* @since 4.13.0
*/
class LLMS_DOM_Document {
/**
* Stores the load method name
*
* @var string
*/
private $load_method = 'load_with_mb_convert_encoding';
/**
* Stores the HTML string to load
*
* @var string
*/
private $source;
/**
* Stores the DOMDocument instance
*
* @var DOMDocument
*/
private $dom;
/**
* Stores loading errors
*
* @var null|WP_Error
*/
private $error;
/**
* This forces DOMDocument to convert non-utf8 characters into HTML entities and without relying on `mb_convert_encoding()`.
*
* @var string
*/
private $utf8_fixer = '<meta id="llms-get-dom-doc-utf-fixer" http-equiv="Content-Type" content="text/html; charset=utf-8">';
/**
* Constructor
*
* @since 4.13.0
*
* @param string $source An HTML string, either a full HTML document or a partial string.
* @return void
*/
public function __construct( $source ) {
if ( ! class_exists( 'DOMDocument' ) ) {
$this->error = new WP_Error( 'llms-dom-document-missing', __( 'DOMDocument not available.', 'lifterlms' ) );
return;
}
/**
* Filters the convert encoding method to be used when loading the source in the DOMDocument
*
* @param boolean $use_mb_convert_encoding Whether or not the convert encoding method should be used when loading the source in the DOMDocument.
* Default is `true`. Requires `mbstring` PHP extension.
*/
$use_mb_convert_encoding = apply_filters( 'llms_dom_document_use_mb_convert_encoding', true );
if ( ! ( $use_mb_convert_encoding && function_exists( 'mb_convert_encoding' ) ) ) {
$this->load_method = 'load_with_meta_utf_fixer';
}
$this->source = $source;
$this->dom = new DOMDocument();
}
/**
* Load the HTML string in the DOMDocument
*
* This function suppresses PHP warnings that would be thrown by DOMDocument when
* loading a partial string or an HTML string with errors.
*
* @since 4.13.0
*
* @return boolean|WP_Error Returns `true` if the source is loaded fine.
* Or an error object when DOMDocument isn't available or an error is encountered during loading.
*/
public function load() {
if ( is_wp_error( $this->error ) && $this->error->has_errors() ) {
return $this->error;
}
// Don't throw or log warnings.
$libxml_state = libxml_use_internal_errors( true );
$this->{$this->load_method}();
// Clear and restore errors.
libxml_clear_errors();
libxml_use_internal_errors( $libxml_state );
return is_wp_error( $this->error ) && $this->error->has_errors() ? $this->error : true;
}
/**
* Returns the DOMDocument
*
* @since 4.13.0
*
* @return DOMDocument Returns an instance of DOMDocument.
*/
public function dom() {
return $this->dom;
}
/**
* Load the HTML string in the DOMDocument using mb_encode_numericentity
*
* @since 4.13.0
* @since 9.2.2 Use `mb_encode_numericentity()` instead of deprecated `mb_convert_encoding()` with 'HTML-ENTITIES'.
*
* @return void
*/
private function load_with_mb_convert_encoding() {
$html = mb_encode_numericentity( $this->source, array( 0x80, 0x10FFFF, 0, 0x1FFFFF ), 'UTF-8' );
if ( ! $this->dom->loadHTML( $html ) ) {
$this->error = new WP_Error( 'llms-dom-document-error', __( 'DOMDocument XML Error encountered.', 'lifterlms' ), libxml_get_errors() );
}
}
/**
* Load the HTML string in the DOMDocument using the meta ut8 fixer
*
* @since 4.13.0
*
* @return void
*/
private function load_with_meta_utf_fixer() {
if ( ! $this->dom->loadHTML( $this->utf8_fixer . $this->source ) ) {
$this->error = new WP_Error( 'llms-dom-document-error', __( 'DOMDocument XML Error encountered.', 'lifterlms' ), libxml_get_errors() );
return;
}
// Remove the fixer meta element, if it's not removed it creates invalid HTML5 Markup.
$meta = $this->dom->getElementById( 'llms-get-dom-doc-utf-fixer' );
if ( $meta ) {
$meta->parentNode->removeChild( $meta ); // phpcs:ignore: WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
}
}
}
================================================
FILE: includes/class-llms-elementor-migrate.php
================================================
<?php
/**
* Handle post migration to the Elementor widgets.
*
* @package LifterLMS/Classes
*
* @since 7.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Handle post migration to the new Elementor widgets.
*
* @since 7.7.0
*/
class LLMS_Elementor_Migrate {
/**
* Constructor.
*
* @since 7.7.0
*/
public function __construct() {
add_action( 'current_screen', array( $this, 'migrate_post' ) );
add_action( 'wp', array( $this, 'remove_template_hooks' ) );
}
/**
* Retrieve the elementor data template.
*
* @since 7.7.0
*
* @return array
*/
public function get_elementor_data_template() {
$content = array();
$content[] = array(
'id' => uniqid(),
'elType' => 'container',
'settings' => array(),
'elements' => array(
array(
'id' => uniqid(),
'elType' => 'widget',
'settings' => array(
'content_width' => 'full',
'html' => '<h2>' . esc_attr__( 'Course Information', 'lifterlms' ) . '</h2>',
),
'elements' => array(),
'widgetType' => 'html',
),
),
'isInner' => false,
);
$content[] = array(
'id' => uniqid(),
'elType' => 'container',
'settings' => array(),
'elements' => array(
array(
'id' => uniqid(),
'elType' => 'widget',
'settings' => array(),
'elements' => array(),
'widgetType' => 'llms_course_meta_information_widget',
),
),
'isInner' => false,
);
$content[] = array(
'id' => uniqid(),
'elType' => 'container',
'settings' => array(),
'elements' => array(
array(
'id' => uniqid(),
'elType' => 'widget',
'settings' => array(),
'elements' => array(),
'widgetType' => 'llms_course_instructors_widget',
),
),
'isInner' => false,
);
$content[] = array(
'id' => uniqid(),
'elType' => 'container',
'settings' => array(),
'elements' => array(
array(
'id' => uniqid(),
'elType' => 'widget',
'settings' => array(),
'elements' => array(),
'widgetType' => 'llms_pricing_table_widget',
),
),
'isInner' => false,
);
$content[] = array(
'id' => uniqid(),
'elType' => 'container',
'settings' => array(),
'elements' => array(
array(
'id' => uniqid(),
'elType' => 'widget',
'settings' => array(),
'elements' => array(),
'widgetType' => 'llms_course_progress_widget',
),
),
'isInner' => false,
);
$content[] = array(
'id' => uniqid(),
'elType' => 'container',
'settings' => array(),
'elements' => array(
array(
'id' => uniqid(),
'elType' => 'widget',
'settings' => array(),
'elements' => array(),
'widgetType' => 'llms_course_continue_button_widget',
),
),
'isInner' => false,
);
$content[] = array(
'id' => uniqid(),
'elType' => 'container',
'settings' => array(),
'elements' => array(
array(
'id' => uniqid(),
'elType' => 'widget',
'settings' => array(),
'elements' => array(),
'widgetType' => 'llms_course_syllabus_widget',
),
),
'isInner' => false,
);
return $content;
}
/**
* Migrate posts created prior to the elementor updates to have default LifterLMS widgets.
*
* @since 7.7.0
*
* @return void
*/
public function migrate_post() {
global $pagenow;
if ( 'post.php' !== $pagenow ) {
return;
}
if ( ! current_user_can( 'edit_posts' ) ) {
return;
}
$post_id = llms_filter_input( INPUT_GET, 'post', FILTER_SANITIZE_NUMBER_INT );
$post = $post_id ? get_post( $post_id ) : false;
if ( ! $post || ! isset( $_REQUEST['action'] ) || 'elementor' !== $_REQUEST['action'] || ! $this->should_migrate_post( $post_id ) || 'course' !== get_post_type( $post_id ) ) {
return;
}
$this->ensure_elementor_data_present( $post_id );
$this->add_template_to_post( $post_id );
}
public function add_template_to_post( $post_id ) {
$content = get_post_meta( $post_id, '_elementor_data', true );
if ( ! $content ) {
return;
}
$decoded_content = json_decode( $content, true );
if ( ! is_array( $decoded_content ) ) {
return;
}
$decoded_content = array_merge( $decoded_content, $this->get_elementor_data_template() );
$this->update_elementor_data( $post_id, $decoded_content );
$this->update_migration_status( $post_id );
}
/**
* Removes core template action hooks from posts which have been migrated to elementor widgets.
*
* @since 7.7.0
*
* @return void
*/
public function remove_template_hooks() {
if ( ! function_exists( 'llms_is_elementor_post' ) ||
! llms_is_elementor_post() ||
( get_the_ID() && ! llms_parse_bool( get_post_meta( get_the_ID(), '_llms_elementor_migrated', true ) ) ) ) {
return;
}
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_meta_wrapper_start', 5 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_length', 10 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_difficulty', 20 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_tracks', 25 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_categories', 30 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_tags', 35 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_meta_wrapper_end', 50 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_progress', 60 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_syllabus', 90 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_course_author', 40 );
remove_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_pricing_table', 60 );
}
/**
* Determine if a post should be migrated.
*
* @since 7.7.0
*
* @param int $post_id WP_Post ID.
* @return bool
*/
public function should_migrate_post( $post_id ) {
$ret = ! llms_parse_bool( get_post_meta( $post_id, '_llms_elementor_migrated', true ) );
/**
* Filters whether or not a post should be migrated
*
* @since 7.7.0
*
* @param bool $migrate Whether or not a post should be migrated.
* @param int $post_id WP_Post ID.
*/
return apply_filters( 'llms_elementor_should_migrate_post', $ret, $post_id );
}
/**
* Update post meta data to signal status of the editor migration.
*
* @since 7.7.0
*
* @param int $post_id WP_Post ID.
* @param string $status Yes or no.
* @return void
*/
public function update_migration_status( $post_id, $status = 'yes' ) {
update_post_meta( $post_id, '_llms_elementor_migrated', $status );
}
private function ensure_elementor_data_present( $post_id ): void {
$content = json_decode( get_post_meta( $post_id, '_elementor_data', true ) );
if ( ! is_array( $content ) && ( $post = get_post( $post_id ) ) ) {
$content = array();
$content[] = array(
'id' => uniqid(),
'elType' => 'container',
'settings' => array(),
'elements' => array(
array(
'id' => uniqid(),
'elType' => 'widget',
'settings' => array(
'editor' => $post->post_content,
),
'elements' => array(),
'widgetType' => 'text-editor',
),
),
'isInner' => false,
);
$this->update_elementor_data( $post_id, $content );
}
}
private function update_elementor_data( $post_id, $content ): void {
// The trim and wp json encode are important. It doesn't seem to work with just json_encode, for example.
update_post_meta( $post_id, '_elementor_data', trim( wp_slash( wp_json_encode( $content ) ), '"' ) );
}
}
global $llms_elementor_migrate;
$llms_elementor_migrate = new LLMS_Elementor_Migrate();
return $llms_elementor_migrate;
================================================
FILE: includes/class-llms-engagement-handler.php
================================================
<?php
/**
* LLMS_Engagement_Handler class file.
*
* @package LifterLMS/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Validate and generate or send engagement posts.
*
* Handles validation, dupchecking, and etc...
*
* For certificates and achievements the earned ("_my_") post type is created.
*
* For emails, the email is triggered and sending recorded in the user postmeta table.
*
* @since 6.0.0
*/
class LLMS_Engagement_Handler {
/**
* Create a new earned achievement or certificate.
*
* This method is called by handler callback functions run when engagements are triggered.
*
* Before arriving here the input data ($user_id, $template_id, etc...) has already been validated to ensure
* that it exists and the engagement can be processed using this data.
*
* @since 6.0.0
*
* @param string $type The engagement type, either "achievement" or "certificate".
* @param int $user_id WP_User ID of the student earning the engagement.
* @param int $template_id WP_Post ID of the template post (llms_achievement or llms_certificate).
* @param string $related_id WP_Post ID of the triggering related post (course, lesson, etc...) or an empty string for user registration.
* @param null|int $engagement_id WP_Post ID of the engagement post used to configure the trigger. A `null` value maybe be passed for legacy
* delayed engagements which were created without an engagement ID or when manually awarding via the admin UI.
* @return boolean|WP_Error[] $can_process An array of WP_Errors or true if the engagement can be processed.
*/
private static function can_process( $type, $user_id, $template_id, $related_id = '', $engagement_id = null ) {
/**
* Skip engagement processing checks and force engagements to process.
*
* This filter is used internally to skip running checks for immediate engagements which cannot
* suffer from the issues that these checks seek to avoid.
*
* @since 6.0.0
*
* @param boolean $skip_checks Whether or not to skip checks.
* @param string $type The engagement type, either "achievement" or "certificate".
* @param int $user_id WP_User ID of the student earning the engagement.
* @param int $template_id WP_Post ID of the template post (llms_achievement or llms_certificate).
* @param string $related_id WP_Post ID of the triggering related post (course, lesson, etc...) or an empty string for user registration.
* @param null|int $engagement_id WP_Post ID of the engagement post used to configure the trigger. A `null` value maybe be passed for legacy
* delayed engagements which were created without an engagement ID or when manually awarding via the admin UI.
* }
*/
$skip_checks = apply_filters( 'llms_skip_engagement_processing_checks', false, $type, $user_id, $template_id, $related_id, $engagement_id );
if ( $skip_checks ) {
return true;
}
$checks = array();
// User must exist.
$user_check = get_userdata( $user_id ) ? true : new WP_Error( 'llms-engagement-check-user--not-found', sprintf( __( 'User "%d" not found.', 'lifterlms' ), $user_id ) );
$checks[] = $user_check;
// Template must be published and of the expected post type.
$checks[] = self::check_post( $template_id, "llms_{$type}" );
// Check related post (if one is passed).
if ( ! empty( $related_id ) ) {
$check_related = self::check_post( $related_id );
$checks[] = $check_related;
// Check post enrollment if the check passed and there's no user issues.
if ( ! is_wp_error( $check_related ) && ! is_wp_error( $user_check ) ) {
$checks[] = self::check_post_enrollment( $related_id, $user_id );
}
}
// Ensure we have an argument to check, engagements created prior to v6.0.0 will not have this argument.
if ( ! empty( $engagement_id ) ) {
$checks[] = self::check_post( $engagement_id, 'llms_engagement' );
}
// Find all the failed checks.
$errors = array_values( array_filter( $checks, 'is_wp_error' ) );
/**
* Filters whether or not an engagement should be processed immediately prior to it being sent or awarded.
*
* The dynamic portion of this hook, `{$type}` refers to the type of engagement being processed, either "email",
* "certificate", or "achievement".
*
* @since 6.0.0
*
* @param boolean|WP_Error[] $can_process An array of WP_Errors or true if the engagement can be processed.
* @param int $user_id WP_User ID of the student earning the engagement.
* @param int $template_id WP_Post ID of the template post (llms_achievement or llms_certificate).
* @param string $related_id WP_Post ID of the triggering related post (course, lesson, etc...) or an empty string for user registration.
* @param null|int $engagement_id WP_Post ID of the engagement post used to configure the trigger. A `null` value maybe be passed for legacy
* delayed engagements which were created without an engagement ID or when manually awarding via the admin UI.
* }
*/
return apply_filters( "llms_proccess_{$type}_engagement", count( $errors ) ? $errors : true, $user_id, $template_id, $related_id, $engagement_id );
}
/**
* Apply deprecated creation filters based on the engagement type.
*
* @since 6.0.0
*
* @param array $args Array of creation arguments.
* @param string $type The engagement type, accepts "achievement" or "certificate".
* @return array
*/
private static function do_deprecated_creation_filters( $args, $type ) {
$hooks = array(
'achievement' => array( 'lifterlms_new_achievement', 'llms_achievement_get_creation_args' ),
'certificate' => array( 'lifterlms_new_page', 'llms_certificate_get_creation_args' ),
);
$hook = $hooks[ $type ] ?? null;
if ( ! $hook ) {
return $args;
}
return apply_filters_deprecated( $hook[0], array( $args ), '6.0.0', $hook[1] );
}
/**
* Handles deprecated filters which have additional parameters from now deprecated classes.
*
* If there are no callbacks attached to the deprecated hook the original $args is returned and no
* warnings will be emitted.
*
* This instantiates an initialized instance of the deprecated class and passes it with the original filtered
* argument through `apply_filters_deprecated`. This results in several deprecation warnings being emitted
* but ensures that these filters can continue to work in a backwards compatible manner.
*
* This method is a public method but it is intentionally marked as private to denote its temporary lifespan. It will
* be removed alongside the deprecated filters it calls as it will no longer be necessary when the deprecated
* hooks are fully removed. As such, this method is considered private for the purposes of semantic versioning and
* will removed in the next major release without being officially deprecated.
*
* @since 6.0.0
*
* @access private
*
* @param mixed $args The filtered argument (not an array of arguments).
* @param array $init_args {
* An array of arguments used to initialize the old object.
*
* @type int $0 WP_Post ID of the template post, either an `llms_certificate` or `llms_achievement`.
* @type int $1 WP_User ID of the user.
* @type int|string $2 WP_Post ID of the related post or an empty string during user registration.
* }
* @param string $type The engagement type, either "achievement" or "certificate".
* @param string $deprecated The deprecated filter to call.
* @param string $replacement The replacement hook.
* @return mixed
*/
public static function do_deprecated_filter( $args, $init_args, $type, $deprecated, $replacement ) {
if ( has_filter( $deprecated ) ) {
$old_class = sprintf( 'LLMS_%s_User', strtoupper( $type ) );
/**
* Retains deprecated functionality where an instance of LLMS_Certificate_User is passed as a parameter to the filter.
*
* Since there's no good way to recreate that functionality we'll handle it in this manner
* until `LLMS_Certificate_User` is removed.
*/
$old_obj = new $old_class();
$old_obj->init( ...$init_args );
$args = apply_filters_deprecated( $deprecated, array( $args, $old_obj ), '6.0.0', $replacement );
}
return $args;
}
/**
* Create a new earned achievement or certificate.
*
* This method is called by handler callback functions run when engagements are triggered.
*
* Before arriving here the input data ($user_id, $template_id, etc...) has already been validated to ensure
* that it exists and the engagement can be processed using this data.
*
* @since 6.0.0
*
* @param string $type The engagement type, either "achievement" or "certificate".
* @param int $user_id WP_User ID of the student earning the engagement.
* @param int $template_id WP_Post ID of the template post (llms_achievement or llms_certificate).
* @param string $related_id WP_Post ID of the triggering related post (course, lesson, etc...) or an empty string for user registration.
* @param null|int $engagement_id WP_Post ID of the engagement post used to configure the trigger. A `null` value maybe be passed for legacy
* delayed engagements which were created without an engagement ID or when manually awarding via the admin UI.
* @return WP_Error|LLMS_User_Certificate|LLMS_User_Achievement
*/
private static function create( $type, $user_id, $template_id, $related_id = '', $engagement_id = null ) {
$title = get_post_meta( $template_id, "_llms_{$type}_title", true );
$template = get_post( $template_id );
// Setup args, ultimately passed to `wp_insert_post()`.
$post_args = array(
'post_author' => $user_id,
'post_content' => $template->post_content,
'post_date' => llms_current_time( 'mysql' ),
'post_name' => 'certificate' === $type ? llms()->certificates()->get_unique_slug( $title ) : null,
'post_parent' => $template_id,
'post_status' => 'publish',
'post_title' => $title,
'meta_input' => array(
'_thumbnail_id' => self::get_image_id( $type, $template_id ),
'_llms_engagement' => $engagement_id,
'_llms_related' => $related_id,
),
);
// Do deprecated filters. No direct replacement added, instead use `LLMS_Post_Model` creation filters.
$post_args = self::do_deprecated_creation_filters( $post_args, $type );
$model_class = sprintf( 'LLMS_User_%s', ucwords( $type ) );
$generated = new $model_class( 'new', $post_args );
if ( ! $generated || ! $generated->get( 'id' ) ) {
return new WP_Error( 'llms-engagement-init--create', __( 'An error was encountered during post creation.', 'lifterlms' ), compact( 'user_id', 'template_id', 'related_id', 'engagement_id', 'post_args', 'type', 'model_class' ) );
}
// Reinstantiate the class so the merged post_content will be retrieved if accessed immediately.
return new $model_class( $generated->get( 'id' ) );
}
/**
* Runs post-creation actions when creating/awarding an achievement or certificate to a user.
*
* @param string $type The engagement type, either "achievement" or "certificate".
* @param int $user_id WP_User ID of the student who earned the engagement.
* @param int $generated_id WP_Post ID of the generated engagement post.
* @param string|int|null $related_id WP_Post ID of the related post triggering generation, an empty string (in the event of a user registration trigger) or null if not supplied.
* @param int|null $engagement_id WP_Post ID of the engagement post used to configure engagement triggering.
*
* @return void
*/
public static function create_actions( $type, $user_id, $generated_id, $related_id = '', $engagement_id = null ) {
// I think this should be removed but there's a lot of places where queries to _certificate_earned or _achievement_earned exist and it's the documented way of retrieving this data.
// Internally we should switch to stop relying on this and figure out a way to phase out the usage of the user postmeta data but for now I think we'll continue storing it.
llms_update_user_postmeta(
$user_id,
$related_id,
"_{$type}_earned",
$generated_id,
// The earned engagement must be unique if a `$related_id` is present, otherwise it must be not.
// Manual awarding have no `$related_id`, and if we force the uniquiness we will end up updating always the same earned engagement
// every time we manually award a new one for the same user.
(bool) $related_id
);
/**
* Action run after a student has successfully earned an engagement.
*
* The dynamic portion of this hook, `{$type}`, refers to the engagement type,
* either "achievement" or "certificate".
*
* @since 1.0.0
* @since 6.0.0 Added the `$engagement_id` parameter.
*
* @param int $user_id WP_User ID of the student who earned the engagement.
* @param int $generated_id WP_Post ID of the generated engagement post.
* @param string|int|null $related_id WP_Post ID of the related post triggering generation, an empty string (in the event of a user registration trigger) or null if not supplied.
* @param int|null $engagement_id WP_Post ID of the engagement post used to configure engagement triggering.
*/
do_action(
"llms_user_earned_{$type}",
$user_id,
$generated_id,
$related_id,
$engagement_id
);
}
/**
* Validates a post id submitted to an engagement handler callback function.
*
* This ensures the following is true:
* + The post must exist
* + It must be published
* + Optionally, it must match the specified post type.
*
* @since 6.0.0
*
* @param int $post_id WP_Post ID.
* @param string $post_type The expected post type.
* @return WP_Error|boolean Returns `true` if all checks pass, otherwise returns a `WP_Error`.
*/
public static function check_post( $post_id, $post_type = null ) {
$post = get_post( $post_id );
if ( ! $post ) {
// Translators: %d = the WP_Post ID.
return new WP_Error( 'llms-engagement-post--not-found', sprintf( __( 'Post "%d" not found.', 'lifterlms' ), $post_id ), compact( 'post_id' ) );
}
if ( 'publish' !== $post->post_status ) {
// Translators: %d = the WP_Post ID.
return new WP_Error( 'llms-engagement-post--status', sprintf( __( 'Post "%d" is not published.', 'lifterlms' ), $post_id ), compact( 'post' ) );
}
if ( $post_type && $post_type !== $post->post_type ) {
// Translators: %d = the WP_Post ID.
return new WP_Error( 'llms-engagement-post--type', sprintf( __( 'Post "%d" is not the expected post type.', 'lifterlms' ), $post_id ), compact( 'post' ) );
}
return true;
}
/**
* Check that the specified user is enrolled in the given post.
*
* This check will return true when running against non-enrollable post types.
*
* @since 6.0.0
*
* @param int $post_id WP_Post ID.
* @param int $user_id WP_User ID.
* @return WP_Error|boolean Returns `true` if the check passes, otherwise returns a `WP_Error`.
*/
private static function check_post_enrollment( $post_id, $user_id ) {
$type = get_post_type( $post_id );
$types = llms_get_enrollable_status_check_post_types();
// If the post type is an enrollable post type, check enrollment.
if ( in_array( $type, $types, true ) && ! llms_is_user_enrolled( $user_id, $post_id ) ) {
// Translators: %1$d = WP_User ID; %2$d = WP_Post ID.
return new WP_Error( 'llms-engagement-check-post--enrollment', sprintf( __( 'User "%1$d" is not enrolled in "%2$d".', 'lifterlms' ), $user_id, $post_id ), compact( 'post_id', 'user_id' ) );
}
return true;
}
/**
* Check if the engagement for the specified template and related post has already been earned / awarded to a given user.
*
* @since 6.0.0
*
* @param string $type Engagement type, either "certificate" or "achievement".
* @param int $user_id WP_User ID of the user earning the engagement.
* @param int $template_id WP_Post ID of the template post, either an `llms_certificate` or an `llms_achievement`.
* @param string $related_id WP_Post ID of the related post or an empty string during user registration.
* @param int $engagement_id WP_Post ID of the `llms_engagement` post type.
* @return WP_Error|boolean Returns `true` if the dupcheck passes otherwise returns an error object.
*/
private static function dupcheck( $type, $user_id, $template_id, $related_id = '', $engagement_id = null ) {
$student = llms_get_student( $user_id );
$query = new LLMS_Awards_Query(
array(
'type' => $type,
'users' => $user_id,
'templates' => $template_id,
'related_posts' => $related_id,
'fields' => 'ids',
'no_found_rows' => true,
'per_page' => 1,
)
);
$is_duplicate = self::do_deprecated_filter(
$query->has_results(),
array( $template_id, $user_id, $related_id ),
$type,
"llms_{$type}_has_user_earned",
"llms_earned_{$type}_dupcheck"
);
/**
* Filters whether or not the given user has already earned a certificate or achievement.
*
* The dynamic portion of this hook, `{$type}`, refers to the type of engagement, either
* "achievement" or "certificate".
*
* This filter should return `true` or a `WP_Error` to denote the certificate has already been earned and
* `false` to denote that it has not.
*
* If `true` is returned the default error message will be used.
*
* @since 6.0.0
*
* @param boolean $is_duplicate Whether or not the engagement has already been earned.
*/
$is_duplicate = apply_filters(
"llms_earned_{$type}_dupcheck",
$is_duplicate,
$user_id,
$template_id,
$related_id,
$engagement_id
);
if ( true === $is_duplicate ) {
$is_duplicate = new WP_Error(
'llms-engagement--is-duplicate',
// Translators: %s = the WP_User ID.
sprintf( __( 'User "%s" has already earned this engagement.', 'lifterlms' ), $user_id ),
compact( 'type', 'user_id', 'template_id', 'related_id', 'engagement_id' )
);
}
return is_wp_error( $is_duplicate ) ? $is_duplicate : true;
}
/**
* Retrieve the attachment id to use for the earned engagement thumbnail.
*
* Retrieves the template's featured image ID and validates and then falls back to the site's
* global default image option.
*
* If no global option is found, returns `0`. During front-end display, the hardcoded image will be used
* in the template if the earned engagement's thumbnail is set to a fasly.
*
* @since 6.0.0
*
* @param string $type Type of engagement, either "achievement" or "certificate".
* @param int $template_id WP_Post ID of the template post.
* @return int WP_Post ID of the attachment or `0` when none found.
*/
public static function get_image_id( $type, $template_id ) {
$img_id = get_post_meta( $template_id, '_thumbnail_id', true );
if ( $img_id && get_post( $img_id ) ) {
return absint( $img_id );
}
if ( 'achievement' === $type ) {
return llms()->achievements()->get_default_image_id();
}
if ( 'certificate' === $type ) {
return llms()->certificates()->get_default_image_id();
}
return 0;
}
/**
* Handle validation and creation of an earned achievement or certificate.
*
* @since 6.0.0
*
* @param string $type Type of engagement, either "achievement" or "certificate".
* @param array $args {
* Indexed array of arguments.
*
* @type int $0 WP_User ID.
* @type int $1 WP_Post ID of the achievement or certificate template post.
* @type int|string $2 WP_Post ID of the related post that triggered the award or an empty string.
* @type int $3 WP_Post ID of the engagement post.
* }
* @return WP_Error[]|LLMS_User_Achiemvent|LLMS_User_Certificate An array of errors or the earned engagement object
*/
private static function handle( $type, $args ) {
$can_process = self::can_process( $type, ...$args );
if ( true !== $can_process ) {
return $can_process;
}
$dupcheck = self::dupcheck( $type, ...$args );
if ( true !== $dupcheck ) {
return array( $dupcheck );
}
return self::create( $type, ...$args );
}
/**
* Award an achievement
*
* @since 6.0.0
*
* @param array $args {
* Indexed array of arguments.
*
* @type int $0 WP_User ID.
* @type int $1 WP_Post ID of the achievement template post.
* @type int|string $2 WP_Post ID of the related post that triggered the award or an empty string.
* @type int $3 WP_Post ID of the engagement post.
* }
* @return WP_Error[]|LLMS_User_Achievement Returns an array of error objects on failure or the generated achievement object on success.
*/
public static function handle_achievement( $args ) {
return self::handle( 'achievement', $args );
}
/**
* Award an certificate
*
* @since 6.0.0
*
* @param array $args {
* Indexed array of arguments.
*
* @type int $0 WP_User ID.
* @type int $1 WP_Post ID of the certificate template post.
* @type int|string $2 WP_Post ID of the related post that triggered the award or an empty string.
* @type int $3 WP_Post ID of the engagement post.
* }
* @return WP_Error[]|LLMS_User_Certificate Returns an array of error objects on failure or the generated certificate object on success.
*/
public static function handle_certificate( $args ) {
return self::handle( 'certificate', $args );
}
/**
* Send an email engagement
*
* This is called via do_action() by the 'maybe_trigger_engagement' function in this class.
*
* @since 2.3.0
* @since 3.8.0 Unknown.
* @since 4.4.1 Use postmeta helpers for dupcheck and postmeta insertion.
* Add a return value in favor of `void`.
* Log successes and failures to the `engagement-emails` log file instead of the main `llms` log.
* @since 4.4.3 Fixed different emails triggered by the same related post not sent because of a wrong duplicate check.
* Fixed dupcheck log message and error message which reversed the email and person order.
* @since 6.0.0 Moved from `LLMS_Engagements` class.
* Removed engagement debug logging.
* Ensure related post, email template, and engagement all exist and are published before processing.
*
* @param mixed[] $args {
* An array of arguments from the triggering hook.
*
* @type int $0 WP_User ID.
* @type int $1 WP_Post ID of the email.
* @type int|string $2 WP_Post ID of the related triggering post or an empty string for engagements with no related post.
* @type int $3 WP_Post ID of the engagement post.
* }
* @return bool|WP_Error[] Returns `true` on success and array of error objects when the email has failed or is prevented.
*/
public static function handle_email( $args ) {
$can_process = self::can_process( 'email', ...$args );
if ( true !== $can_process ) {
return $can_process;
}
list( $person_id, $email_id, $related_id ) = $args;
$meta_key = '_email_sent';
$msg = sprintf( __( 'Email #%1$d to user #%2$d triggered by %3$s', 'lifterlms' ), $email_id, $person_id, $related_id ? '#' . $related_id : 'N/A' );
if ( $related_id && absint( $email_id ) === absint( llms_get_user_postmeta( $person_id, $related_id, $meta_key ) ) ) {
// User has already received this email, don't send it again.
llms_log( $msg . ' ' . __( 'not sent because of dupcheck.', 'lifterlms' ), 'engagement-emails' );
return array( new WP_Error( 'llms_engagement_email_not_sent_dupcheck', $msg, $args ) );
}
// Setup the email.
$email = llms()->mailer()->get_email( 'engagement', compact( 'person_id', 'email_id', 'related_id' ) );
if ( $email && $email->send() ) {
if ( $related_id ) {
llms_update_user_postmeta( $person_id, $related_id, $meta_key, $email_id );
}
llms_log( $msg . ' ' . __( 'sent successfully.', 'lifterlms' ), 'engagement-emails' );
return true;
}
// Error sending email.
llms_log( $msg . ' ' . __( 'not sent due to email sending issues.', 'lifterlms' ), 'engagement-emails' );
return array( new WP_Error( 'llms_engagement_email_not_sent_error', $msg, $args ) );
}
}
================================================
FILE: includes/class-llms-events-core.php
================================================
<?php
/**
* Record events triggered by core/wp actions.
*
* @package LifterLMS/Classes
*
* @since 3.36.0
* @version 3.36.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Events_Core class
*
* @since 3.36.0
*/
class LLMS_Events_Core {
/**
* Constructor.
*
* @since 3.36.0
*
* @return void
*/
public function __construct() {
add_action( 'wp_login', array( $this, 'on_signon' ), 10, 2 );
add_action( 'clear_auth_cookie', array( $this, 'on_signout' ) );
}
/**
* Record account.signon event via `wp_login` hook.
*
* @since 3.36.0
*
* @param string $username WP_Users's user_login.
* @param WP_User $user User object.
* @return LLMS_Event
*/
public function on_signon( $username, $user ) {
return llms()->events()->record(
array(
'actor_id' => $user->ID,
'object_type' => 'user',
'object_id' => $user->ID,
'event_type' => 'account',
'event_action' => 'signon',
)
);
}
/**
* Record an account.signout event via `wp_logout()`
*
* @since 3.36.0
* @since 4.5.0 Return `false` without recording any event if no user was logged in.
*
* @return LLMS_Event|false The instance of the `LLMS_Event` recorded or `false` when no user was logged in.
*/
public function on_signout() {
$uid = get_current_user_id();
if ( ! $uid ) {
return false;
}
return llms()->events()->record(
array(
'actor_id' => $uid,
'object_type' => 'user',
'object_id' => $uid,
'event_type' => 'account',
'event_action' => 'signout',
)
);
}
}
return new LLMS_Events_Core();
================================================
FILE: includes/class-llms-events-query.php
================================================
<?php
/**
* Perform db queries for events
*
* @package LifterLMS/Classes
*
* @since 3.36.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Events_Query class
*
* @since 3.36.0
*/
class LLMS_Events_Query extends LLMS_Database_Query {
/**
* Identify the Query
*
* @var string
*/
protected $id = 'events';
/**
* Retrieve default arguments for a query
*
* @since 3.36.0
* @since 4.7.0 Drop usage of `this->get_filter( 'default_args' )` in favor of `'llms_events_query_default_args'`.
*
* @return array
*/
protected function get_default_args() {
$args = array(
'actor' => array(),
'actor_not_in' => array(),
'date_after' => '',
'date_before' => '',
'exclude' => array(),
'include' => array(),
'object_type' => '',
'object' => array(),
'object_not_in' => array(),
'event_type' => '',
'event_action' => '',
'sort' => array(
'date' => 'DESC',
),
);
$args = wp_parse_args( $args, parent::get_default_args() );
if ( $args['suppress_filters'] ) {
return $args;
}
/**
* Filters the events query default args
*
* @since 3.36.0
*
* @param array $args Array of default arguments to set up the query with.
* @param LLMS_Events_Query $events_query Instance of LLMS_Events_Query.
*/
return apply_filters( 'llms_events_query_default_args', $args, $this );
}
/**
* Retrieve an array of LLMS_Event objects for the given result set returned by the query
*
* @since 3.36.0
* @since 4.7.0 Drop usage of `$this->get_filter('get_events')` in favor of `'llms_events_query_get_events'`.
*
* @return array
*/
public function get_events() {
$events = array();
$results = $this->get_results();
if ( $results ) {
foreach ( $results as $result ) {
$events[] = new LLMS_Event( $result->id, true );
}
}
if ( $this->get( 'suppress_filters' ) ) {
return $events;
}
/**
* Filters the list of events
*
* @since 3.36.0
*
* @param LLMS_Event[] $events Array of LLMS_Event instances.
* @param LLMS_Events_Query $events_query Instance of LLMS_Events_Query.
*/
return apply_filters( 'llms_events_query_get_events', $events, $this );
}
/**
* Parses argument data
*
* @since 3.36.0
*
* @return void
*/
protected function parse_args() {
// Sanitize post & user ids.
foreach ( array( 'actor', 'actor_not_in', 'object', 'object_not_in', 'include', 'exclude' ) as $key ) {
$this->arguments[ $key ] = $this->sanitize_id_array( $this->arguments[ $key ] );
}
foreach ( array( 'date_before', 'date_after' ) as $key ) {
if ( ! empty( $this->arguments[ $key ] ) ) {
$date = $this->arguments[ $key ];
if ( ! is_numeric( $date ) ) {
$date = strtotime( $date );
}
$this->arguments[ $key ] = date( 'Y-m-d H:i:s', $date );
}
}
}
/**
* Prepare the SQL for the query.
*
* @since 3.36.0
* @since 4.7.0 Use `$this->sql_select_columns({columns})` to determine the columns to select.
* @since 6.0.0 Renamed from `preprare_query()`.
* @since 10.0.0 Build count_query from shared clauses instead of using SQL_CALC_FOUND_ROWS.
*
* @return string
*/
protected function prepare_query() {
global $wpdb;
$from = "FROM {$wpdb->prefix}lifterlms_events";
$where = $this->sql_where();
if ( ! $this->get( 'no_found_rows' ) ) {
$this->count_query = "SELECT COUNT(*) {$from} {$where}";
}
return "SELECT {$this->sql_select_columns( 'id' )}
{$from}
{$where}
{$this->sql_orderby()}
{$this->sql_limit()};";
}
/**
* SQL "where" clause for the query
*
* @since 3.36.0
* @since 4.7.0 Drop usage of `$this->get_filter('where')` in favor of `'llms_events_query_where'`.
*
* @return string
*/
protected function sql_where() {
global $wpdb;
$sql = 'WHERE 1';
// "IN" clauses for id fields.
$ids_include = array(
'actor' => 'actor_id',
'object' => 'object_id',
'include' => 'id',
);
foreach ( $ids_include as $query_key => $db_key ) {
$ids = $this->get( $query_key );
if ( $ids ) {
$prepared = implode( ',', $ids );
$sql .= " AND {$db_key} IN ({$prepared})";
}
}
// "NOT IN" clauses for id fields.
$ids_exclude = array(
'actor_not_in' => 'actor_id',
'object_not_in' => 'object_id',
'exclude' => 'id',
);
foreach ( $ids_exclude as $query_key => $db_key ) {
$ids = $this->get( $query_key );
if ( $ids ) {
$prepared = implode( ',', $ids );
$sql .= " AND {$db_key} NOT IN ({$prepared})";
}
}
// Matching fields.
$matching = array( 'object_type', 'event_type', 'event_action' );
foreach ( $matching as $key ) {
$val = $this->get( $key );
if ( $val ) {
$sql .= sprintf( " AND {$key} = '%s'", esc_sql( $val ) );
}
}
// Date fields.
$before = $this->get( 'date_before' );
if ( $before ) {
$sql .= $wpdb->prepare( ' AND date < %s', $before );
}
$after = $this->get( 'date_after' );
if ( $after ) {
$sql .= $wpdb->prepare( ' AND date > %s', $after );
}
if ( $this->get( 'suppress_filters' ) ) {
return $sql;
}
/**
* Filters the query WHERE clause
*
* @since 3.36.0
*
* @param string $sql The WHERE clause of the query.
* @param LLMS_Events_Query $events_query Instance of LLMS_Events_Query.
*/
return apply_filters( 'llms_events_query_where', $sql, $this );
}
}
================================================
FILE: includes/class-llms-events.php
================================================
<?php
/**
* LifterLMS Event management.
*
* @package LifterLMS/Classes
*
* @since 3.36.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Events class.
*
* @since 3.36.0
* @since 3.36.1 Improve performances when checking if an event is valid in `LLMS_Events->is_event_valid()`.
* Remove redundant check on `is_singular()` and `is_post_type_archive()` in `LLMS_Events->should_track_client_events()`.
* @since 3.37.14 Added `store_tracking_events()` method.
* Moved most of the `store_cookie()` method's logic into `store_tracking_events()`.
* @since 3.37.15 Excluded `page.*` events in order to keep the events table small.
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
* @since 6.0.0 Removed the deprecated `LLMS_Events::$_instance` property.
*/
class LLMS_Events {
use LLMS_Trait_Singleton;
/**
* List of registered event types.
*
* @var array
*/
protected $registered_events = array();
/**
* Private Constructor
*
* @since 3.36.0
* @since 4.5.0 Register events at `init` hook with priority 9 in place of 10.
*
* @return void
*/
private function __construct() {
add_action( 'init', array( $this, 'register_events' ), 9 );
add_action( 'init', array( $this, 'store_cookie' ) );
}
/**
* Retrieves an array of client settings used to initialize the JS Tracking instance on the frontend.
*
* @since 3.36.0
*
* @return array
*/
public function get_client_settings() {
$events = ! $this->should_track_client_events() ? array() : array_keys( array_filter( $this->get_registered_events() ) );
/**
* Filter client-side tracking settings
*
* @since 3.36.0
*
* @param array $settings {
* Hash of client-side settings.
*
* @type string $nonce Nonce used to verify client-side events.
* @type string[] $events Array of events that should be tracked.
* }
*/
return apply_filters(
'llms_events_get_client_settings',
array(
'nonce' => wp_create_nonce( 'llms-tracking' ),
'events' => $events,
'saving_frequency' => get_option( 'lifterlms_tracked_event_saving_frequency', 'minimum' ),
)
);
}
/**
* Retrieve an array of valid events.
*
* @since 3.36.0
*
* @return array Array key is the event name and array value is used to determine if the key is a client-side event.
*/
public function get_registered_events() {
return $this->registered_events;
}
/**
* Determine if the event string is registered and valid.
*
* @since 3.36.0
* @since 3.36.1 Use more performant `array_key_exists( $key, $array_assoc )` in place of `in_array( $key, array_keys( $array_assoc ), true )`.
*
* @param string $event Event string ({$event_type}.{$event_action}). EG: "account.signon".
* @return bool
*/
protected function is_event_valid( $event ) {
return array_key_exists( $event, $this->get_registered_events() );
}
/**
* Prepares partial events from client-side event data.
*
* @since 3.36.0
*
* @param array $raw_event Raw event from client-side data.
* @return array
*/
public function prepare_event( $raw_event = array() ) {
if ( ! isset( $raw_event['event'] ) ) {
// Translators: %s = Event field key.
return new WP_Error( 'llms_events_missing_event', sprintf( __( 'The event is missing the "%s" field.', 'lifterlms' ), 'event' ) );
}
$event = explode( '.', $raw_event['event'] );
$prepared = array(
'actor_id' => get_current_user_id(),
'event_type' => $event[0],
'event_action' => $event[1],
'meta' => isset( $raw_event['meta'] ) ? $raw_event['meta'] : array(),
);
// Convert timestamps to MYSQL date.
if ( isset( $raw_event['time'] ) && is_numeric( $raw_event['time'] ) ) {
$prepared['date'] = date( 'Y-m-d H:i:s', $raw_event['time'] );
}
if ( isset( $raw_event['url'] ) ) {
$id = url_to_postid( $raw_event['url'] );
if ( ! $id ) {
// Translators: %s = URL.
return new WP_Error( 'llms_events_invalid_url', sprintf( __( 'The URL "%s" cannot be mapped to a valid post object.', 'lifterlms' ), esc_url( $raw_event['url'] ) ) );
}
$prepared['object_id'] = $id;
$prepared['object_type'] = str_replace( 'llms_', '', get_post_type( $id ) );
} elseif ( isset( $raw_event['object_id'] ) && isset( $raw_event['object_type'] ) ) {
$prepared['object_id'] = $raw_event['object_id'];
$prepared['object_type'] = $raw_event['object_type'];
}
return $prepared;
}
/**
* Store an event in the database.
*
* @since 3.36.0
* @since 4.5.0 Fixed event session end not recorded on sign-out.
*
* @param array $args {
* Event data
*
* @type int $actor_id WP_User ID.
* @type string $object_type Type of object being acted upon (post,user,comment,etc...).
* @type int $object_id WP_Post ID, WP_User ID, WP_Comment ID, etc...
* @type string $event_type Type of event (account, page, course, etc...).
* @type string $event_action The event action or verb (signon,viewed,launched,etc...).
* }
* @return LLMS_Event|WP_Error
*/
public function record( $args = array() ) {
$err = new WP_Error();
foreach ( array( 'actor_id', 'object_type', 'object_id', 'event_type', 'event_action' ) as $key ) {
if ( ! in_array( $key, array_keys( $args ), true ) ) {
// Translators: %s = key name of the missing field.
$err->add( 'llms_event_record_missing_field', sprintf( __( 'Missing required field: "%s".', 'lifterlms' ), $key ) );
}
}
if ( $err->get_error_codes() ) {
return $err;
}
$event = sprintf( '%1$s.%2$s', $args['event_type'], $args['event_action'] );
if ( ! $this->is_event_valid( $event ) ) {
// Translators: %s = Submitted event string.
return new WP_Error( 'llms_event_record_invalid_event', sprintf( __( 'The event "%s" is invalid.', 'lifterlms' ), $event ) );
}
$args = $this->sanitize_raw_event( $args );
$meta = isset( $args['meta'] ) ? $args['meta'] : null;
unset( $args['meta'] );
if ( ! in_array( $event, array( 'session.start', 'session.end' ), true ) ) {
// Start a session if one isn't open.
$sessions = LLMS_Sessions::instance();
$user_id = 'account.signon' === $event && isset( $args['actor_id'] ) ? $args['actor_id'] : null;
if ( false === $sessions->get_current( $user_id ) ) {
$sessions->start( $user_id );
}
}
$llms_event = new LLMS_Event();
if ( ! $llms_event->setup( $args )->save() ) {
$err->add( 'llms_event_recored_unknown_error', __( 'An unknown error occurred during event creation.', 'lifterlms' ) );
return $err;
}
if ( $meta && ! empty( $meta ) ) {
$llms_event->set_metas( $meta, true );
}
// End the current session on signout.
if ( 'account.signout' === $event ) {
LLMS_Sessions::instance()->end_current();
}
return $llms_event;
}
/**
* Record multiple events.
*
* Events are recorded with an SQL transaction. If any errors are encountered the transaction is rolled back (not events are recorded).
*
* @since 3.36.0
*
* @param array[] $events Array of event hashes. See LLMS_Events::record() for hash description.
* @return LLMS_Event[]|WP_Error Array of recorded events on success or WP_Error on failure.
*/
public function record_many( $events = array() ) {
global $wpdb;
$wpdb->query( 'START TRANSACTION' );
$recorded = array();
$errors = array();
foreach ( $events as $event ) {
$stat = $this->record( $event );
if ( is_wp_error( $stat ) ) {
$stat->add_data( $event );
$errors[] = $stat;
} else {
$recorded[] = $stat;
}
}
if ( count( $errors ) ) {
$wpdb->query( 'ROLLBACK' );
return new WP_Error( 'llms_events_record_many_errors', __( 'There was one or more errors encountered while recording the events.', 'lifterlms' ), $errors );
}
$wpdb->query( 'COMMIT' );
return $recorded;
}
/**
* Register event types
*
* @since 3.36.0
* @since 3.37.15 Excluded `page.*` events in order to keep the events table small.
*
* @return void
*/
public function register_events() {
$events = array(
'account.signon' => false,
'account.signout' => false,
'session.start' => false,
'session.end' => false,
/*
'page.load' => true,
'page.exit' => true,
'page.focus' => true,
'page.blur' => true,
*/
);
/**
* Filter the list of registered events.
*
* Allows 3rd parties to register (or unregister) tracked events.
*
* @since 3.36.0
*
* @param array $events Array of events. Array key is the event name and array value is used to determine if the key is a client-side event.
*/
$this->registered_events = apply_filters( 'llms_get_registered_events', $events );
}
/**
* Recursively sanitize event data.
*
* @since 3.36.0
*
* @param array $raw Event information array.
* @return array
*/
protected function sanitize_raw_event( $raw ) {
$clean = array();
foreach ( $raw as $key => $val ) {
// This will recursively handle any metadata submitted.
if ( is_array( $val ) ) {
$val = $this->sanitize_raw_event( $val );
} elseif ( in_array( $key, array( 'actor_id', 'object_id' ), true ) ) {
// cast id fields to int.
$val = absint( $val );
} else {
// everything else is a text field.
$val = sanitize_text_field( $val );
}
// Sanitize the key. This will ensure no dirty keys are submitted in metadata.
$key = is_numeric( $key ) ? $key : sanitize_text_field( $key );
$clean[ $key ] = $val;
}
return $clean;
}
/**
* Determine if client side events from the current page should be tracked.
*
* @since 3.36.0
*
* @return boolean
*/
protected function should_track_client_events() {
$ret = false;
/**
* Filter the post types that should be tracked
*
* @since 3.36.0
* @since 3.36.1 Remove redundant check on `is_singular()` and `is_post_type_archive()`.
*
* @param string[]|string $post_types An array of post type names or a pre-defined setting as a string.
* "llms" uses all public LifterLMS and LifterLMS Add-on post types.
* "all" tracks everything.
*/
$post_types = apply_filters( 'llms_tracking_post_types', 'llms' );
if ( 'all' === $post_types ) {
$ret = true;
} elseif ( 'llms' === $post_types ) {
// Filter public post types to include LifterLMS public post types.
$post_types = array_keys( get_post_types( array( 'public' => true ) ) );
foreach ( $post_types as $key => $type ) {
if ( ! in_array( $type, array( 'course', 'lesson' ), true ) && 0 !== strpos( $type, 'llms_' ) ) {
unset( $post_types[ $key ] );
}
}
}
if ( ! is_array( $post_types ) ) {
$ret = false;
} elseif ( is_singular( $post_types ) ) {
$ret = true;
} elseif ( is_post_type_archive( $post_types ) ) {
$ret = true;
} elseif ( is_llms_account_page() || is_llms_checkout() ) {
$ret = true;
}
/**
* Filters whether or not the current page should track client-side events
*
* @since 3.36.0
*
* @param bool $ret Whether or not to track the current page.
* @param string[] $post_types Array of post types that should be tracked.
*/
return apply_filters( 'llms_tracking_should_track_client_events', $ret, $post_types );
}
/**
* Store event data saved in the tracking cookie.
*
* @since 3.36.0
* @since 3.37.14 Moved most of the logic into `store_tracking_events()` method.
* Bail if we're sending the tracking events via ajax.
* @since 4.3.1 Set a secure cookie when possible.
*
* @return void
*/
public function store_cookie() {
if ( wp_doing_ajax() && ! empty( $_POST['llms-tracking'] ) ) {// phpcs:ignore: WordPress.Security.NonceVerification.Missing -- Nonce verified in `$this->store_tracking_events()` method.
return;
}
// Bail if no `llms-tracking` cookie.
if ( empty( $_COOKIE['llms-tracking'] ) ) {
return;
}
$this->store_tracking_events( wp_unslash( $_COOKIE['llms-tracking'] ) ); // phpcs:ignore: WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Sanitized via $this->sanitize_raw_event().
// Cookie reset.
llms_setcookie( 'llms-tracking', '', time() - 60, COOKIEPATH ? COOKIEPATH : '/', COOKIE_DOMAIN, llms_is_site_https() && is_ssl() );
}
/**
* Store event data saved in the tracking cookie.
*
* @since 3.37.14
*
* @param string $tracking The `llms-tracking` data in JSON format.
* @return (boolean|WP_Error) Returns WP_Error when nonce verification fails or unauthenticated user, `true` otherwise.
*/
public function store_tracking_events( $tracking ) {
$tracking = json_decode( $tracking, true );
if ( ! empty( $tracking['nonce'] ) && wp_verify_nonce( $tracking['nonce'], 'llms-tracking' ) && get_current_user_id() ) {
if ( ! empty( $tracking['events'] ) && is_array( $tracking['events'] ) ) {
foreach ( $tracking['events'] as $event ) {
$event = $this->prepare_event( $event );
if ( ! is_wp_error( $event ) ) {
$this->record( $event );
}
}
}
} else {
return new WP_Error( 'llms_events_tracking_unauthorized', __( 'You\'re not allowed to store tracking events', 'lifterlms' ) );
}
return true;
}
}
================================================
FILE: includes/class-llms-generator-courses.php
================================================
<?php
/**
* Generate LMS Content from export files or raw arrays of data
*
* @package LifterLMS/Classes
*
* @since 4.7.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Generator_Courses class
*
* @since 4.7.0
*/
class LLMS_Generator_Courses extends LLMS_Abstract_Generator_Posts {
/**
* Exception code: Raw data missing required data.
*
* @var int
*/
const ERROR_GEN_MISSING_REQUIRED = 2000;
/**
* Exception code: Raw data in an invalid format.
*
* @var int
*/
const ERROR_GEN_INVALID_FORMAT = 2001;
/**
* Add taxonomy terms to a course
*
* @since 3.3.0
* @since 3.7.5 Unknown.
* @since 4.7.0 Moved from `LLMS_Generator` and made `protected` instead of `private`.
*
* @param obj $course_id WP_Post ID of a Course.
* @param array $raw_terms Array of raw term arrays.
* @return void
*/
protected function add_course_terms( $course_id, $raw_terms ) {
$taxes = array(
'course_cat' => 'categories',
'course_difficulty' => 'difficulty',
'course_tag' => 'tags',
'course_track' => 'tracks',
);
foreach ( $taxes as $tax => $key ) {
if ( ! empty( $raw_terms[ $key ] ) && is_array( $raw_terms[ $key ] ) ) {
// We can only have one difficulty at a time.
$append = ( 'difficulty' === $key ) ? false : true;
$terms = array();
// Find term id or create it.
foreach ( $raw_terms[ $key ] as $term_name ) {
if ( empty( $term_name ) ) {
continue;
}
$term_id = $this->get_term_id( $term_name, $tax );
if ( $term_id ) {
$terms[] = $term_id;
}
}
wp_set_post_terms( $course_id, $terms, $tax, $append );
}
}
}
/**
* Generator called when cloning a course
*
* @since 4.13.0
*
* @param array $raw Raw course data array.
* @return int|null WP_Post ID of the generated course or `null` on failure.
*/
public function clone_course( $raw ) {
return $this->generate_course( $this->setup_raw_for_clone( $raw ) );
}
/**
* Generator called when cloning a lesson
*
* @since 3.14.8
* @since 4.7.0 Moved from `LLMS_Generator` and made `public` instead of `private`.
* @since 4.13.0 Use `setup_raw_for_clone()` to normalize the
*
* @param array $raw Raw data array.
* @return int|WP_Error WP_Post ID of the created lesson on success and an error object on failure.
*/
public function clone_lesson( $raw ) {
return $this->create_lesson( $this->setup_raw_for_clone( $raw ), 0, '', '' );
}
/**
* Generator called for single course imports
*
* Converts the single course into a format that can be handled by the bulk courses generator
* and invokes that generator.
*
* @since 3.3.0
* @since 4.7.0 Moved from `LLMS_Generator` and made `public` instead of `private`.
* Returns an int on success.
* @param array $raw Raw data array.
* @return int|null WP_Post ID of the generated course or `null` on failure.
*/
public function generate_course( $raw ) {
$new_raw = array();
foreach ( array( '_generator', '_version', '_source' ) as $meta ) {
if ( isset( $raw[ $meta ] ) ) {
$new_raw[ $meta ] = $raw[ $meta ];
unset( $raw[ $meta ] );
}
}
$new_raw['courses'] = array( $raw );
$courses = $this->generate_courses( $new_raw );
return is_array( $courses ) ? $courses[0] : null;
}
/**
* Generator called for bulk course imports
*
* @since 3.3.0
* @since 4.7.0 Moved from `LLMS_Generator` to `LLMS_Abstract_Generator_Courses`.
* Updated method access from `private` to `public`.
* Throws an exception in favor of returning `null` when an error is encountered.
* Returns an array of generated course IDs on success.
*
* @param array $raw Raw data array.
* @return void
*
* @throws Exception When invalid `$raw` data is submitted.
*/
public function generate_courses( $raw ) {
if ( empty( $raw['courses'] ) ) {
throw new Exception( esc_attr__( 'Raw data is missing the required "courses" array.', 'lifterlms' ), intval( self::ERROR_GEN_MISSING_REQUIRED ) );
} elseif ( ! is_array( $raw['courses'] ) ) {
throw new Exception( esc_attr__( 'The raw "courses" item must be an array.', 'lifterlms' ), intval( self::ERROR_GEN_INVALID_FORMAT ) );
}
$courses = array();
foreach ( $raw['courses'] as $raw_course ) {
unset( $raw_course['_generator'], $raw_course['_version'] );
$courses[] = $this->create_course( $raw_course );
}
$this->handle_prerequisites();
return $courses;
}
/**
* Create a new access plan
*
* @since 3.3.0
* @since 3.7.3 Unknown.
* @since 4.3.3 Use an empty string in favor of `null` for an empty `post_content` field.
* @since 4.7.0 Sideload images attached to the post, use `create_post()` from abstract, add hooks.
*
* @param array $raw Raw Access Plan Data.
* @param int $course_id WP Post ID of a LLMS Course to assign the access plan to.
* @param int $fallback_author_id Optional. WP User ID to use for the access plan author if no author is supplied in the raw data. Default is `null`.
* When not supplied the fall back will be on the current user ID.
* @return int
*/
protected function create_access_plan( $raw, $course_id, $fallback_author_id = null ) {
/**
* Filter raw course import data prior to generation
*
* @since 4.7.0
*
* @param array $raw Raw course data array.
* @param LLMS_Generator $generator Generator instance.
*/
$raw = apply_filters( 'llms_generator_before_new_access_plan', $raw, $this );
// Force course relationship.
$raw['product_id'] = $course_id;
$plan = $this->create_post( 'access_plan', $raw, $fallback_author_id );
if ( ! $plan ) {
return null;
}
/**
* Action triggered immediately following generation of a new acess plan
*
* @since 4.7.0
*
* @param LLMS_Access_Plan $plan Generated access plan object.
* @param array $raw Original raw course data array.
* @param LLMS_Generator $generator Generator instance.
*/
do_action( 'llms_generator_new_access_plan', $plan, $raw, $this );
return $plan->get( 'id' );
}
/**
* Create a new course
*
* @since 3.3.0
* @since 3.30.2 Added hooks.
* @since 4.3.3 Use an empty string in favor of `null` for empty `post_content` and `post_excerpt` fields.
* @since 4.7.0 Import images and reusable blocks found in the post's content and use `create_post()` from abstract.
*
* @param array $raw Raw course data.
* @return int
*
* @throws Exception When an error is encountered during course creation.
*/
protected function create_course( $raw ) {
/**
* Filter raw course import data prior to generation
*
* @since 3.30.2
*
* @param array $raw Raw course data array.
* @param LLMS_Generator $generator Generator instance.
*/
$raw = apply_filters( 'llms_generator_before_new_course', $raw, $this );
// Create the course.
$course = $this->create_post( 'course', $raw, get_current_user_id() );
// Add terms to our course.
$terms = array();
if ( isset( $raw['difficulty'] ) ) {
$terms['difficulty'] = array( $raw['difficulty'] );
}
foreach ( array( 'categories', 'tags', 'tracks' ) as $tax ) {
if ( isset( $raw[ $tax ] ) ) {
$terms[ $tax ] = $raw[ $tax ];
}
}
$this->add_course_terms( $course->get( 'id' ), $terms );
// Create all access plans.
if ( isset( $raw['access_plans'] ) ) {
foreach ( $raw['access_plans'] as $plan ) {
$this->create_access_plan( $plan, $course->get( 'id' ), $course->get( 'author' ) );
}
}
// Create all sections.
if ( isset( $raw['sections'] ) ) {
foreach ( $raw['sections'] as $order => $section ) {
$this->create_section( $section, ++$order, $course->get( 'id' ), $course->get( 'author' ) );
}
}
/**
* Action triggered immediately following generation of a new course
*
* @since 3.30.2
*
* @param LLMS_Course $course Generated course object.
* @param array $raw Original raw course data array.
* @param LLMS_Generator $generator Generator instance.
*/
do_action( 'llms_generator_new_course', $course, $raw, $this );
return $course->get( 'id' );
}
/**
* Create a new lesson
*
* @since 3.3.0
* @since 3.30.2 Added hooks.
* @since 4.3.3 Use an empty string in favor of `null` for empty `post_content` and `post_excerpt` fields.
* @since 4.7.0 Import images and reusable blocks found in the post's content and use `create_post()` from abstract.
*
* @param array $raw Raw lesson data.
* @param int $order Lesson order within the section (starts at 1).
* @param int $section_id WP Post ID of the lesson's parent section.
* @param int $course_id WP Post ID of the lesson's parent course.
* @param int $fallback_author_id Optional. Author ID to use as a fallback if no raw author data supplied for the lesson. Default is `null`.
* When not supplied the fall back will be on the current user ID.
* @return int
*
* @throws Exception When an error is encountered during post creation.
*/
protected function create_lesson( $raw, $order, $section_id, $course_id, $fallback_author_id = null ) {
/**
* Filter raw lesson import data prior to generation
*
* @since 3.30.2
*
* @param array $raw Raw lesson data array.
* @param int $order Lesson order within the section (starts at 1).
* @param int $section_id WP Post ID of the lesson's parent section.
* @param int $course_id WP Post ID of the lesson's parent course.
* @param int $fallback_author_id Optional author ID to use as a fallback if no raw author data supplied for the lesson.
* @param LLMS_Generator $generator Generator instance.
*/
$raw = apply_filters( 'llms_generator_before_new_lesson', $raw, $order, $section_id, $course_id, $fallback_author_id, $this );
// Force some data.
$raw['parent_course'] = $course_id;
$raw['parent_section'] = $section_id;
$raw['order'] = $order;
$raw_quiz = ! empty( $raw['quiz'] ) ? $raw['quiz'] : false;
unset( $raw['quiz'] );
$lesson = $this->create_post( 'lesson', $raw, $fallback_author_id );
if ( $raw_quiz ) {
$raw_quiz['lesson_id'] = $lesson->get( 'id' );
$lesson->set( 'quiz', $this->create_quiz( $raw_quiz, $lesson->get( 'author' ) ) );
}
/**
* Action triggered immediately following generation of a new lesson
*
* @since 3.30.2
*
* @param LLMS_Lesson $lesson Generated lesson object.
* @param array $raw Original raw lesson data array.
* @param LLMS_Generator $generator Generator instance.
*/
do_action( 'llms_generator_new_lesson', $lesson, $raw, $this );
return $lesson->get( 'id' );
}
/**
* Creates a new quiz
* Creates all questions within the quiz as well
*
* @since 3.3.0
* @since 3.30.2 Added hooks.
* @since 4.3.3 Use an empty string in favor of `null` for an empty `post_content` field.
* @since 4.7.0 Sideload images attached to the post and use `create_post()` from abstract.
*
* @param array $raw Raw quiz data.
* @param int $fallback_author_id Optional. Author ID to use as a fallback if no raw author data supplied for the quiz. Default is `null`.
* When not supplied the fall back will be on the current user ID.
* @return int
*
* @throws Exception When an error is encountered during post creation.
*/
protected function create_quiz( $raw, $fallback_author_id = null ) {
/**
* Filter raw quiz import data prior to generation
*
* @since 3.30.2
*
* @param array $raw Raw quiz data array.
* @param int $fallback_author_id Optional author ID to use as a fallback if no raw author data supplied for the quiz.
* @param LLMS_Generator $generator Generator instance.
*/
$raw = apply_filters( 'llms_generator_before_new_quiz', $raw, $fallback_author_id, $this );
$quiz = $this->create_post( 'quiz', $raw, $fallback_author_id );
if ( isset( $raw['questions'] ) ) {
$manager = $quiz->questions();
foreach ( $raw['questions'] as $question ) {
$this->create_question( $question, $manager, $quiz->get( 'author' ) );
}
}
/**
* Action triggered immediately following generation of a new quiz
*
* @since 3.30.2
*
* @param LLMS_Quiz $quiz Generated quiz object.
* @param array $raw Original raw quiz data array.
* @param LLMS_Generator $generator Generator instance.
*/
do_action( 'llms_generator_new_quiz', $quiz, $raw, $this );
return $quiz->get( 'id' );
}
/**
* Creates a new question
*
* @since 3.3.0
* @since 3.30.2 Added hooks.
* @since 4.7.0 Attempt to sideload images found in the imported post's content and image choices.
*
* @param array $raw Raw question data.
* @param obj $manager Question manager instance.
* @param int $author_id Optional. Author ID to use as a fallback if no raw author data supplied for the question. Default is `null`.
* When not supplied the fall back will be on the current user ID.
* @return int
*
* @throws Exception When an error is encountered during course creation.
*/
protected function create_question( $raw, $manager, $author_id ) {
/**
* Filter raw question import data prior to generation
*
* @since 3.30.2
*
* @param array $raw Raw quiz data array.
* @param obj $manager Question manager instance.
* @param int $author_id Optional author ID to use as a fallback if no raw author data supplied for the question.
* @param LLMS_Generator $generator Generator instance.
*/
$raw = apply_filters( 'llms_generator_before_new_question', $raw, $manager, $author_id, $this );
unset( $raw['parent_id'] );
$question_id = $manager->create_question(
array_merge(
array(
'post_status' => 'publish',
'post_author' => $author_id,
),
$raw
)
);
if ( ! $question_id ) {
throw new Exception( esc_attr__( 'Error creating the question post object.', 'lifterlms' ), intval( self::ERROR_CREATE_POST ) );
}
$question = llms_get_post( $question_id );
$this->store_temp_id( $raw, $question );
if ( isset( $raw['choices'] ) ) {
foreach ( $raw['choices'] as $choice ) {
unset( $choice['question_id'] );
$question->create_choice( $this->maybe_sideload_choice_image( $choice, $question_id ) );
}
}
// Set all metadata.
foreach ( array_keys( $question->get_properties() ) as $key ) {
if ( isset( $raw[ $key ] ) ) {
$question->set( $key, $raw[ $key ] );
}
}
$this->sideload_images( $question, $raw );
/**
* Action triggered immediately following generation of a new question
*
* @since 3.30.2
*
* @param LLMS_Question $question Generated question object.
* @param array $raw Original raw question data array.
* @param obj $manager Question manager instance.
* @param LLMS_Generator $generator Generator instance.
*/
do_action( 'llms_generator_new_question', $question, $raw, $manager, $this );
return $question->get( 'id' );
}
/**
* Creates a new section
*
* Creates all lessons within the section data.
*
* @since 3.3.0
* @since 3.30.2 Added hooks.
* @since 4.7.0 Use `create_post()` from abstract.
*
* @param array $raw Raw section data.
* @param int $order Order within the course (starts at 1).
* @param int $course_id WP Post ID of the parent course.
* @param int $fallback_author_id Optional. Author ID to use as a fallback if no raw author data supplied for the section.
* When not supplied the fall back will be on the current user ID.
* @return int
*
* @throws Exception When an error is encountered during course creation.
*/
protected function create_section( $raw, $order, $course_id, $fallback_author_id = null ) {
/**
* Filter raw section import data prior to generation
*
* @since 3.30.2
*
* @param array $raw Raw quiz data array.
* @param int $order Order within the course (starts at 1).
* @param int $course_id WP Post ID of the parent course.
* @param int $fallback_author_id Optional author ID to use as a fallback if no raw author data supplied for the section.
* @param LLMS_Generator $generator Generator instance.
*/
$raw = apply_filters( 'llms_generator_before_new_section', $raw, $order, $course_id, $fallback_author_id, $this );
$raw['parent_course'] = $course_id;
$raw['order'] = $order;
$section = $this->create_post( 'section', $raw, $fallback_author_id );
if ( isset( $raw['lessons'] ) ) {
foreach ( $raw['lessons'] as $lesson_order => $lesson ) {
$this->create_lesson( $lesson, ++$lesson_order, $section->get( 'id' ), $course_id, $section->get( 'author' ) );
}
}
/**
* Action triggered immediately following generation of a new section
*
* @since 3.30.2
*
* @param LLMS_Section $section Generated section object.
* @param array $raw Original raw section data array.
* @param LLMS_Generator $generator Generator instance.
*/
do_action( 'llms_generator_new_section', $section, $raw, $this );
return $section->get( 'id' );
}
/**
* Updates course and lesson prerequisites
*
* If the prerequisite was included in the import, updates to the new imported version.
*
* If the prereq is not included but the source matches, leaves the prereq intact as long as the prereq exists.
*
* Otherwise removes prerequisite data from the new course / lesson.
*
* Removes prereq track associations if there's no source or source doesn't match
* or if the track doesn't exist.
*
* @since 3.3.0
* @since 3.24.0 Unknown.
*
* @return void
*/
protected function handle_prerequisites() {
foreach ( array( 'course', 'lesson' ) as $obj_type ) {
$ids = ! empty( $this->tempids[ $obj_type ] ) ? $this->tempids[ $obj_type ] : array();
// Courses have two kinds of prereqs.
$has_prereq_param = ( 'course' === $obj_type ) ? 'course' : null;
// Loop through all then created lessons.
foreach ( $ids as $old_id => $new_id ) {
// Instantiate the new instance of the object.
$obj = llms_get_post( $new_id );
// If this is a course and there isn't a source or the source doesn't match the current site.
// We should remove the track prerequisites.
if ( 'course' === $obj_type && ( ! isset( $raw['_source'] ) || get_site_url() !== $raw['_source'] ) ) {
// Remove prereq track settings.
if ( $obj->has_prerequisite( 'course_track' ) ) {
$obj->set( 'prerequisite_track', 0 );
if ( ! $obj->has_prerequisite( 'course' ) ) {
$obj->set( 'has_prerequisite', 'no' );
}
}
}
// If the object has a prereq.
if ( $obj->has_prerequisite( $has_prereq_param ) ) {
// Get the old preqeq's id.
$old_prereq = $obj->get( 'prerequisite' );
// If the old prereq is a key in the array of created objects.
// We can replace it with the new id.
if ( in_array( $old_prereq, array_keys( $ids ) ) ) {
$obj->set( 'prerequisite', $ids[ $old_prereq ] );
} elseif ( ! isset( $raw['_source'] ) || get_site_url() !== $raw['_source'] ) {
$obj->set( 'has_prerequisite', 'no' );
$obj->set( 'prerequisite', 0 );
} else {
$post = get_post( $old_prereq );
// Post doesn't exist or the post type doesn't match, get rid of it.
if ( ! $post || $obj_type !== $post->post_type ) {
$obj->set( 'has_prerequisite', 'no' );
$obj->set( 'prerequisite', 0 );
}
}
}
}
}
}
/**
* Determines if a raw question choice object contains image data that should be sideloaded
*
* @since 4.7.0
*
* @param array $choice Raw choice data array.
* @param int $question_id WP_Post ID of the parent question.
* @return array Choice data array.
*/
protected function maybe_sideload_choice_image( $choice, $question_id ) {
if ( empty( $choice['choice_type'] ) || 'image' !== $choice['choice_type'] || ! $this->is_image_sideloading_enabled() ) {
return $choice;
}
if ( ! isset( $choice['choice']['src'] ) ) {
return $choice;
}
$id = $this->sideload_image( $question_id, $choice['choice']['src'], 'id' );
if ( is_wp_error( $id ) ) {
return $choice;
}
$choice['choice']['id'] = $id;
$choice['choice']['src'] = wp_get_attachment_url( $id );
return $choice;
}
/**
* Modifies incoming raw data when creating a clone of a course or lesson
*
* When a clone is created, it will automatically have "(Clone)" appended to the existing title
* and will be created with the "Draft" status.
*
* @since 4.13.0
*
* @param array $raw Raw data array for the course or lesson.
* @return array
*/
protected function setup_raw_for_clone( $raw ) {
/**
* Filters the suffix appended to the WP_Post title of a duplicated post when cloning a course or lesson
*
* @since 4.13.0
*
* @param string $status The WP_Post status to use for the duplicate of the post. Default: "draft".
* @param array $raw Raw data array passed into the generator.
* @param LLMS_Generator $generator Generator instance.
*/
$raw['title'] .= apply_filters( 'llms_generator_cloned_post_title_suffix', sprintf( ' (%s)', __( 'Clone', 'lifterlms' ) ), $raw, $this );
/**
* Filters the WP_Post status used for the duplicated post when cloning a course or lesson
*
* @since 4.13.0
*
* @param string $status The WP_Post status to use for the duplicate of the post. Default: "draft".
* @param array $raw Raw data array passed into the generator.
* @param LLMS_Generator $generator Generator instance.
*/
$raw['status'] = apply_filters( 'llms_generator_cloned_post_status', 'draft', $raw, $this );
return $raw;
}
/**
* Set all metadata for a given post object.
*
* This method will only set metadata for registered LLMS_Post_Model properties.
*
* @since 7.1.0
*
* @param LLMS_Post_Model $post An LLMS post object.
* @param array $raw Array of raw data.
* @return void
*/
protected function set_metadata( $post, $raw ) {
$generated_from_id = $post->get( 'generated_from_id' );
if ( $generated_from_id ) {
$replace_id_props = array(
'course_closed_message',
'course_opens_message',
'enrollment_closed_message',
'enrollment_opens_message',
);
$find = '#(.*id=["\'])' . $generated_from_id . '(["\'].*)#';
$replace = '${1}' . $post->get( 'id' ) . '${2}';
/**
* Replace old post ID with new cloned post ID in course/enrollment
* message shortcodes.
*/
foreach ( $replace_id_props as $key ) {
if ( isset( $raw[ $key ] ) ) {
$raw[ $key ] = preg_replace( $find, $replace, $raw[ $key ] );
}
}
}
return parent::set_metadata( $post, $raw );
}
}
================================================
FILE: includes/class-llms-grades.php
================================================
<?php
/**
* Get & Set grades for gradable post types
*
* @package LifterLMS/Classes
*
* @since 3.24.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Grades
*
* @since 3.24.0
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
* @since 6.0.0 Removed the deprecated `LLMS_Grades::$_instance` property.
*/
class LLMS_Grades {
use LLMS_Trait_Singleton;
/**
* Determines the rounding precision used by grading functions
*
* @var int
*/
private $rounding_precision = 2;
/**
* Private constructor
*
* @since 3.24.0
* @version 3.24.0
*/
private function __construct() {
$this->rounding_precision = apply_filters( 'llms_grade_rounding_precision', $this->rounding_precision );
}
/**
* Calculates the grades for elements that have a list of children which are averaged / weighted to come up with the total grade
*
* @param array $children list of child objects
* @param LLMS_Student $student A LLMS_Student object.
* @return float|null
* @since 3.24.0
* @version 3.24.0
*/
private function calculate_grade_from_children( $children, $student ) {
$grade = null;
$grades = array();
// Loop through all the children and compile the overall grade & points data.
foreach ( $children as $child_id ) {
$child = llms_get_post( $child_id );
$grade = $this->get_grade( $child_id, $student, false );
// Non numeric grade (null) hasn't been taken yet or no gradable elements exist on the child.
if ( ! is_numeric( $grade ) ) {
continue;
}
$points = $child->get( 'points' );
// If no points assigned to the child, the grade doesn't count towards the overall grade.
if ( ! $points ) {
continue;
}
// Add the grade & points for further processing after we have all the data.
$grades[] = array(
'grade' => $grade,
'points' => $points,
);
}
// If we have at least one grade.
if ( count( $grades ) ) {
// Get the total available points for all children with a numeric grade & a points value.
$total_points = array_sum( wp_list_pluck( $grades, 'points' ) );
// If we don't have any points this element can't have an overall grade.
if ( $total_points ) {
// Sum up the adjusted grade.
$grade = 0;
foreach ( $grades as $data ) {
// Calculate the adjusted the grade.
// Grade multiplied by available points over total points.
$grade += $data['grade'] * ( $data['points'] / $total_points );
}
}
}
return $grade;
}
/**
* Calculate the grade for a course
*
* @param LLMS_Course $course A LLMS_Course object.
* @param LLMS_Student $student A LLMS_Student object.
* @return float|null
* @since 3.24.0
* @version 3.24.0
*/
private function calculate_course_grade( $course, $student ) {
return apply_filters(
'llms_calculate_course_grade',
$this->calculate_grade_from_children( $course->get_lessons( 'ids' ), $student ),
$course,
$student
);
}
/**
* Main grade calculation function
* Calculates the grade for a gradable post model
* DOES NOT CACHE RESULTS!
* See get_grade() for a function which uses caching
*
* @param LLMS_Post_Model $post A LLMS_Post_Model object.
* @param LLMS_Student $student A LLMS_Student object.
* @return float|null
* @since 3.24.0
* @version 3.24.0
*/
public function calculate_grade( $post, $student ) {
$grade = null;
$post_type = $post->get( 'type' );
switch ( $post_type ) {
case 'course':
/** @var LLMS_Course $post */
$grade = $this->calculate_course_grade( $post, $student );
break;
case 'lesson':
/** @var LLMS_Lesson $post */
$grade = $this->calculate_lesson_grade( $post, $student );
break;
case 'llms_quiz':
$attempt = $student->quizzes()->get_best_attempt( $post->get( 'id' ) );
if ( $attempt ) {
$grade = $attempt->get( 'grade' );
}
break;
// 3rd party / custom element grading.
default:
$grade = apply_filters( 'llms_calculate_' . $post_type . '_grade', $grade, $post, $student );
}
// Round numeric results.
if ( is_numeric( $grade ) ) {
$grade = $this->round( $grade );
}
return apply_filters( 'llms_calculate_grade', $grade, $post, $student );
}
/**
* Calculates the grade for a lesson
*
* @param LLMS_Lesson $lesson A LLMS_Lesson object.
* @param LLMS_Student $student A LLMS_Student object.
* @return float|null
* @since 3.24.0
* @version 3.24.0
*/
private function calculate_lesson_grade( $lesson, $student ) {
$grade = null;
if ( $lesson->is_quiz_enabled() ) {
$grade = $this->get_grade( $lesson->get( 'quiz' ), $student, false );
}
return apply_filters( 'llms_calculate_lesson_grade', $grade, $lesson, $student );
}
/**
* Main grade getter function
*
* Uses caching by default and can bypass cache when requested
*
* @since 3.24.0
* @since 4.4.4 Don't pass the `$use_cache` parameter to the `calculate_grade()` method.
*
* @param WP_Post|int $post_id An instance of WP_Post or a WP Post ID.
* @param LLMS_Student $student A LLMS_Student object.
* @param bool $use_cache when true, retrieves from cache if available
* @return float|null
*/
public function get_grade( $post_id, $student, $use_cache = true ) {
$post = llms_get_post( $post_id );
$student = llms_get_student( $student );
$grade = $use_cache ? $this->get_grade_from_cache( $post, $student ) : false;
// Grade not found in cache or we're not using the cache.
if ( false === $grade ) {
$grade = $this->calculate_grade( $post, $student );
// Store in the cache.
wp_cache_set(
sprintf( '%d_grade', $post->get( 'id' ) ),
$grade,
sprintf( 'student_%d', $student->get( 'id' ) )
);
}
return apply_filters( 'llms_get_grade', $grade, $post, $student );
}
/**
* Retrieve a grade from the wp_cache
*
* @param LLMS_Post_Model $post A LLMS_Post_Model object.
* @param LLMS_Student $student A LLMS_Student object.
* @return mixed grade as a float
* null if there's no grade for the post
* false if the grade wasn't found in the cache
* @since 3.24.0
* @version 3.24.0
*/
private function get_grade_from_cache( $post, $student ) {
return wp_cache_get(
sprintf( '%d_grade', $post->get( 'id' ) ),
sprintf( 'student_%d', $student->get( 'id' ) )
);
}
/**
* Round grades according to filterable rounding options set during construction
*
* @param float $grade Grade to round
* @return float
* @since 3.24.0
* @version 3.24.0
*/
public function round( $grade ) {
return round( $grade, $this->rounding_precision );
}
}
================================================
FILE: includes/class-llms-loader.php
================================================
<?php
/**
* LifterLMS file loader
*
* @package LifterLMS/Classes
*
* @since 4.0.0
* @version 7.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Loader.
*
* @since 4.0.0
* @since 5.3.0 Add traits to `autoload()`.
*/
class LLMS_Loader {
/**
* These classes do not conform to any of the LifterLMS class name or file name standards.
*
* @todo Rename these classes and/or add a namespace to them.
*
* @since 6.0.0
*
* @var string[] [ $lowercase_class_name => $path_relative_to_LLMS_PLUGIN_DIR ]
*/
private $non_standard_classes = array(
// Missing "_Abstract_" from class name.
'llms_admin_metabox' => 'includes/abstracts/abstract.llms.admin.metabox.php',
'llms_admin_table' => 'includes/abstracts/abstract.llms.admin.table.php',
'llms_analytics_widget' => 'includes/abstracts/abstract.llms.analytics.widget.php',
'llms_database_query' => 'includes/abstracts/abstract.llms.database.query.php',
'llms_payment_gateway' => 'includes/abstracts/abstract.llms.payment.gateway.php',
'llms_post_model' => 'includes/abstracts/abstract.llms.post.model.php',
'llms_shortcode_course_element' => 'includes/abstracts/abstract.llms.shortcode.course.element.php',
'llms_shortcode' => 'includes/abstracts/abstract.llms.shortcode.php',
// Missing "_Admin_" from class name.
'llms_export_api' => 'includes/admin/class-llms-export-api.php',
// Meta box fields.
'llms_metabox_field' => 'includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.fields.php',
'llms_metabox_textarea_w_tags_field' => 'includes/admin/post-types/meta-boxes/fields/llms.class.meta.box.textarea.tags.php',
'meta_box_field_interface' => 'includes/admin/post-types/meta-boxes/fields/llms.interface.meta.box.field.php',
// Missing "Model" from class name.
'llms_access_plan' => 'includes/models/model.llms.access.plan.php',
'llms_add_on' => 'includes/models/model.llms.add-on.php',
'llms_coupon' => 'includes/models/model.llms.coupon.php',
'llms_course' => 'includes/models/model.llms.course.php',
'llms_event' => 'includes/models/class-llms-event.php',
'llms_instructor' => 'includes/models/model.llms.instructor.php',
'llms_lesson' => 'includes/models/model.llms.lesson.php',
'llms_membership' => 'includes/models/model.llms.membership.php',
'llms_notification' => 'includes/models/model.llms.notification.php',
'llms_order' => 'includes/models/model.llms.order.php',
'llms_post_instructors' => 'includes/models/model.llms.post.instructors.php',
'llms_product' => 'includes/models/model.llms.product.php',
'llms_question_choice' => 'includes/models/model.llms.question.choice.php',
'llms_question' => 'includes/models/model.llms.question.php',
'llms_quiz_attempt' => 'includes/models/model.llms.quiz.attempt.php',
'llms_quiz_attempt_question' => 'includes/models/model.llms.quiz.attempt.question.php',
'llms_quiz' => 'includes/models/model.llms.quiz.php',
'llms_section' => 'includes/models/model.llms.section.php',
'llms_student' => 'includes/models/model.llms.student.php',
'llms_student_quizzes' => 'includes/models/model.llms.student.quizzes.php',
'llms_transaction' => 'includes/models/model.llms.transaction.php',
'llms_user_achievement' => 'includes/models/model.llms.user.achievement.php',
'llms_user_certificate' => 'includes/models/model.llms.user.certificate.php',
'llms_user_postmeta' => 'includes/models/model.llms.user.postmeta.php',
// Miscellaneous.
'llms_admin_reporting' => 'includes/admin/reporting/class.llms.admin.reporting.php',
'llms_admin_system_report' => 'includes/admin/class.llms.admin.system-report.php',
'llms_bbp_widget_course_forums_list' => 'includes/widgets/class.llms.bbp.widget.course.forums.list.php',
'llms_media_protection' => 'includes/class-llms-media-protection.php',
'llms_db_upgrader' => 'includes/class-llms-db-ugrader.php',
'llms_emails' => 'includes/class.llms.emails.php',
'llms_payment_gateway_manual' => 'includes/class.llms.gateway.manual.php',
'llms_settings_page' => 'includes/admin/settings/class.llms.settings.page.php',
'llms_table_notificationsettings' => 'includes/admin/settings/tables/class.llms.table.notification.settings.php',
'llms_table_student_certificates' => 'includes/admin/reporting/tables/llms.table.certificates.php',
'llms_table_studentmanagement' => 'includes/admin/post-types/tables/class.llms.table.student.management.php',
// Deprecated classes.
'llms_achievement_user' => 'includes/achievements/class.llms.achievement.user.php',
'llms_certificate_user' => 'includes/certificates/class.llms.certificate.user.php',
);
/**
* An array of paths and what the class name starts with.
*
* @since 6.0.0
*
* @var string[] [ $path_relative_to_LLMS_PLUGIN_DIR => $class_name_starts_with ]
*/
private $class_paths = array(
'includes/admin/tools/' => 'llms_admin_tool_',
'includes/admin/' => 'llms_admin_',
'includes/controllers/' => 'llms_controller_',
'includes/emails/' => 'llms_email',
'includes/forms/' => 'llms_form',
'includes/integrations/' => 'llms_integration_',
'includes/admin/post-types/meta-boxes/' => 'llms_meta_box_',
'includes/notifications/views/' => 'llms_notification_view_',
'includes/notifications/' => 'llms_notification',
'includes/privacy/' => 'llms_privacy',
'includes/processors/' => 'llms_processor',
'includes/shortcodes/' => 'llms_shortcode',
'includes/widgets/' => 'llms_widget',
'includes/' => 'llms_',
);
/**
* Constructor
*
* @since 4.0.0
*
* @return void
*/
public function __construct() {
spl_autoload_register( array( $this, 'autoload' ) );
$this->includes_libraries();
$this->includes();
if ( is_admin() ) {
$this->includes_admin();
} else {
$this->includes_frontend();
}
}
/**
* Auto-load LLMS classes.
*
* @todo Add a {@link https://www.php.net/manual/en/language.namespaces.php namespace} to every file to simplify autoloading.
*
* @since 1.0.0
* @since 3.15.0 Unknown.
* @since 4.0.0 Moved from `LifterLMS` class.
* @since 5.3.0 Add traits.
* @since 6.0.0 Increased the number of files that are autoloaded instead of manually loaded on every request.
* Return early if not a LifterLMS core class.
*
* @param string $class Class name being called.
* @return void
*/
public function autoload( $class ) {
$class = strtolower( $class );
if ( 0 !== strpos( $class, 'llms_' ) && 'lifterlms' !== $class && 'meta_box_field_interface' !== $class ) {
return;
}
$path = null;
$fileize = str_replace( '_', '-', $class );
$file = 'class-' . $fileize . '.php';
if ( array_key_exists( $class, $this->non_standard_classes ) ) {
$path = LLMS_PLUGIN_DIR . $this->non_standard_classes[ $class ];
$file = null;
} elseif ( 0 === strpos( $class, 'llms_abstract_' ) ) {
$path = LLMS_PLUGIN_DIR . 'includes/abstracts/';
$file = $fileize . '.php';
} elseif (
0 === strpos( $class, 'llms_analytics_' ) && false !== strrpos( $class, '_widget', - 7 )
) {
$path = LLMS_PLUGIN_DIR . 'includes/admin/reporting/widgets/';
$file = 'class.llms.analytics.widget.' . substr( $class, 15, - 7 ) . '.php';
} elseif ( 0 === strpos( $class, 'llms_interface_' ) ) {
$path = LLMS_PLUGIN_DIR . 'includes/interfaces/';
$file = $fileize . '.php';
} elseif (
0 === strpos( $class, 'llms_metabox_' ) && false !== strrpos( $class, '_field', - 6 )
) {
$path = LLMS_PLUGIN_DIR . 'includes/admin/post-types/meta-boxes/fields/';
$file = 'llms-class-meta-box-' . substr( $fileize, 13, - 6 ) . '.php';
} elseif ( 0 === strpos( $class, 'llms_table_' ) ) {
/** @todo Prefix file names with 'class-' */
$path = LLMS_PLUGIN_DIR . 'includes/admin/reporting/tables/';
$file = $fileize . '.php';
} elseif ( 0 === strpos( $class, 'llms_trait_' ) ) {
$path = LLMS_PLUGIN_DIR . 'includes/traits/';
$file = $fileize . '.php';
}
if ( is_null( $path ) ) {
foreach ( $this->class_paths as $class_path => $class_name_starts_with ) {
if ( 0 === strpos( $class, $class_name_starts_with ) ) {
$path = LLMS_PLUGIN_DIR . $class_path;
break;
}
}
}
if ( $path ) {
if ( is_readable( $path . $file ) ) {
require_once $path . $file;
return;
}
$file = str_replace( '-', '.', $file );
if ( is_readable( $path . $file ) ) {
require_once $path . $file;
return;
}
}
}
/**
* Includes that are included everywhere.
*
* @since 4.0.0
* @since 4.4.0 Include `LLMS_Assets` class.
* @since 4.12.0 Class `LLMS_Staging` always loaded instead of only loaded on admin panel.
* @since 4.13.0 Include `LLMS_DOM_Document` class.
* @since 5.0.0 Include `LLMS_Forms`, `LLMS_Form_Post_Type`, `LLMS_Form_Templates`, and `LLMS_Form_Handler`.
* @since 5.2.0 Include `LLMS_DB_Upgrader`.
* @since 5.6.0 Include `LLMS_Prevent_Concurrent_Logins`.
* @since 6.0.0 Included `LLMS_Block_Library`, `LLMS_Controller_Awards`, and `LLMS_Engagement_Handler`.
* Removed loading of class files that don't instantiate their class in favor of autoloading.
* @since 6.4.0 Included `LLMS_Shortcodes` before `LLMS_Controller_Orders`.
* @since 7.0.0 Include `LLMS_Controller_Checkout`.
* @since 7.2.0 Include `LLMS_Shortcodes_Blocks`.
*
* @return void
*/
public function includes() {
// Instantiate LLMS_Shortcodes before LLMS_Controller_Orders.
require_once LLMS_PLUGIN_DIR . 'includes/shortcodes/class.llms.shortcodes.php';
require_once LLMS_PLUGIN_DIR . 'includes/shortcodes/class.llms.shortcodes.blocks.php';
// Functions.
require_once LLMS_PLUGIN_DIR . 'includes/llms.functions.core.php';
// Classes.
require_once LLMS_PLUGIN_DIR . 'includes/class-llms-block-library.php';
require_once LLMS_PLUGIN_DIR . 'includes/class-llms-events-core.php';
require_once LLMS_PLUGIN_DIR . 'includes/class-llms-rest-fields.php';
require_once LLMS_PLUGIN_DIR . 'includes/class-llms-sessions.php';
require_once LLMS_PLUGIN_DIR . 'includes/class-llms-staging.php';
require_once LLMS_PLUGIN_DIR . 'includes/class-llms-prevent-concurrent-logins.php';
// Forms.
require_once LLMS_PLUGIN_DIR . 'includes/forms/class-llms-forms.php';
require_once LLMS_PLUGIN_DIR . 'includes/forms/class-llms-forms-admin-bar.php';
require_once LLMS_PLUGIN_DIR . 'includes/forms/class-llms-forms-classic-editor.php';
require_once LLMS_PLUGIN_DIR . 'includes/forms/class-llms-forms-data.php';
require_once LLMS_PLUGIN_DIR . 'includes/forms/class-llms-forms-dynamic-fields.php';
// Classes (files to be renamed).
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.assets.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.ajax.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.ajax.handler.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.cache.helper.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.comments.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.date.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.install.php';
include_once LLMS_PLUGIN_DIR . 'includes/class.llms.l10n.frontend.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.nav.menus.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.oembed.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.playnice.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.post.relationships.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.post-types.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.query.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.question.types.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.review.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.sidebars.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.student.dashboard.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.user.permissions.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.view.manager.php';
// Controllers.
require_once LLMS_PLUGIN_DIR . 'includes/controllers/class.llms.controller.achievements.php';
require_once LLMS_PLUGIN_DIR . 'includes/controllers/class-llms-controller-awards.php';
require_once LLMS_PLUGIN_DIR . 'includes/controllers/class.llms.controller.certificates.php';
require_once LLMS_PLUGIN_DIR . 'includes/controllers/class.llms.controller.lesson.progression.php';
require_once LLMS_PLUGIN_DIR . 'includes/controllers/class-llms-controller-checkout.php'; // Added out of alpha order to preserve action load order.
require_once LLMS_PLUGIN_DIR . 'includes/controllers/class.llms.controller.orders.php';
require_once LLMS_PLUGIN_DIR . 'includes/controllers/class.llms.controller.quizzes.php';
// Form controllers.
require_once LLMS_PLUGIN_DIR . 'includes/forms/controllers/class.llms.controller.account.php';
require_once LLMS_PLUGIN_DIR . 'includes/forms/controllers/class.llms.controller.login.php';
require_once LLMS_PLUGIN_DIR . 'includes/forms/controllers/class.llms.controller.registration.php';
// Hooks.
require_once LLMS_PLUGIN_DIR . 'includes/llms.template.hooks.php';
// Privacy components.
require_once LLMS_PLUGIN_DIR . 'includes/privacy/class-llms-privacy.php';
// Spam stuff.
require_once LLMS_PLUGIN_DIR . 'includes/llms.spam.functions.php';
require_once LLMS_PLUGIN_DIR . 'includes/spam/class-llms-captcha.php';
require_once LLMS_PLUGIN_DIR . 'includes/spam/class-llms-turnstile.php';
require_once LLMS_PLUGIN_DIR . 'includes/spam/class-llms-recaptcha.php';
require_once LLMS_PLUGIN_DIR . 'includes/spam/class-llms-akismet.php';
// Theme support.
require_once LLMS_PLUGIN_DIR . 'includes/theme-support/class-llms-theme-support.php';
// Widgets.
require_once LLMS_PLUGIN_DIR . 'includes/widgets/class.llms.widget.php';
require_once LLMS_PLUGIN_DIR . 'includes/widgets/class.llms.widgets.php';
// Elementor support.
require_once LLMS_PLUGIN_DIR . 'includes/elementor/class-llms-elementor-widgets.php';
require_once LLMS_PLUGIN_DIR . 'includes/class-llms-course-completion-page.php';
}
/**
* Includes that are required only on the admin panel
*
* @since 4.0.0
* @since 4.7.0 Always load `LLMS_Admin_Reporting`.
* @since 4.8.0 Add `LLMS_Export_API`.
* @since 4.12.0 Class `LLMS_Staging` always loaded instead of only loaded on admin panel.
* @since 5.0.0 Include `LLMS_Forms_Unsupported_Versions` class.
* @since 5.9.0 Drop usage of deprecated `FILTER_SANITIZE_STRING`.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
* @since 7.2.0 Include `LLMS_Admin_Dashboard_Wigdet` class.
*
* @return void
*/
public function includes_admin() {
// Functions.
require_once LLMS_PLUGIN_DIR . 'includes/admin/llms.functions.admin.php';
// Admin classes.
require_once LLMS_PLUGIN_DIR . 'includes/admin/class-llms-admin-header.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class-llms-admin-export-download.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class-llms-admin-plugins.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class-llms-admin-review.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class-llms-admin-users-table.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class-llms-sendwp.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class-llms-mailhawk.php';
require_once LLMS_PLUGIN_DIR . 'includes/forms/class-llms-forms-unsupported-versions.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class-llms-admin-permalinks.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class-llms-admin-media-protection-attachment-settings.php';
// Admin classes (files to be renamed).
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.dashboard.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.dashboard-widget.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.import.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.menus.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.notices.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.notices.core.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.post-types.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.reviews.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class-llms-admin-events-promo.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.user.custom.fields.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class-llms-admin-profile.php';
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.student.bulk.enroll.php';
// Post types.
require_once LLMS_PLUGIN_DIR . 'includes/admin/post-types/class.llms.post.tables.php';
// Controllers.
require_once LLMS_PLUGIN_DIR . 'includes/controllers/class.llms.controller.admin.quiz.attempts.php';
// Reporting.
require_once LLMS_PLUGIN_DIR . 'includes/admin/reporting/widgets/class.llms.analytics.widget.ajax.php';
// Load setup wizard conditionally.
if ( 'llms-setup' === llms_filter_input( INPUT_GET, 'page' ) ) {
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.setup.wizard.php';
}
}
/**
* Include libraries
*
* @since 4.0.0
* @since 4.9.0 Adds constants which can be used to identify when included libraries have been loaded.
* @since 5.0.0 Load core libraries from new location, add WP Background Processing lib, add LLMS Helper.
* @since 5.1.3 Add keys to the $libs array and pass them through a filter.
* @since 5.5.0 Add LLMS-CLI to the list of included libraries.
*
* @return void
*/
public function includes_libraries() {
$libs = array(
'blocks' => array(
'const' => 'LLMS_BLOCKS_LIB',
'test' => function_exists( 'has_blocks' ) && ! defined( 'LLMS_BLOCKS_VERSION' ),
'file' => LLMS_PLUGIN_DIR . 'libraries/lifterlms-blocks/lifterlms-blocks.php',
),
'cli' => array(
'const' => 'LLMS_CLI_LIB',
'test' => ! function_exists( 'llms_cli' ),
'file' => LLMS_PLUGIN_DIR . 'libraries/lifterlms-cli/lifterlms-cli.php',
),
'rest' => array(
'const' => 'LLMS_REST_API_LIB',
'test' => ! class_exists( 'LifterLMS_REST_API' ),
'file' => LLMS_PLUGIN_DIR . 'libraries/lifterlms-rest/lifterlms-rest.php',
),
'helper' => array(
'const' => 'LLMS_HELPER_LIB',
'test' => ! class_exists( 'LifterLMS_Helper' ),
'file' => LLMS_PLUGIN_DIR . 'libraries/lifterlms-helper/lifterlms-helper.php',
),
);
/**
* Filters the list of LifterLMS libraries to be loaded.
*
* @since 5.1.3
*
* @param array $libs {
* Array of library data. Each array key serves as a unique ID for the library.
*
* @type string $const Name of the constant used to identify if the library is loaded as a library.
* @type bool $test A test which is evaluated to determine if the library should be loaded. Returning `false` causes the library not to load.
* @type string $file Path to the main library file's location in the LifterLMS core plugin.
* }
*/
$libs = apply_filters( 'llms_included_libs', $libs );
foreach ( $libs as $lib ) {
if ( $lib['test'] ) {
define( $lib['const'], true );
require_once $lib['file'];
}
}
// Action Scheduler.
require_once LLMS_PLUGIN_DIR . 'vendor/woocommerce/action-scheduler/action-scheduler.php';
// WP Background Processing.
require_once LLMS_PLUGIN_DIR . 'vendor/deliciousbrains/wp-background-processing/wp-background-processing.php';
}
/**
* Includes that are required only on the frontend
*
* @since 4.0.0
* @since 5.0.0 Removed deprecated classes: LLMS_Frontend_Forms & LLMS_Frontend_Password.
*
* @return void
*/
public function includes_frontend() {
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.frontend.assets.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.https.php';
require_once LLMS_PLUGIN_DIR . 'includes/class.llms.template.loader.php';
}
}
return new LLMS_Loader();
================================================
FILE: includes/class-llms-media-protector.php
================================================
<?php
/**
* LLMS_Media_Protector class
*
* @package LifterLMS/Classes
*
* @since 7.7.0
* @version 7.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Media_Protector class.
*
* Allows uploaded media files to be protected from unauthorized downloading.
*
* WordPress uses the terms "media" and "attachment" interchangeably to describe uploaded files.
* When a file is uploaded to WordPress, a post is created with type = 'attachment' and the file name and path relative
* to the upload directory, normally `WP_CONTENT_DIR . '/uploads'`, is saved as '_wp_attached_file' metadata.
*
* Example of uploading a file:
*
* $protector = new LLMS_Media_Protector( '/social-learning' );
* $id = $protector->handle_upload( 'image', 0, 'llms_sl_authorize_media_view', $post_data );
*
* Example of protecting a file:
*
* add_filter( 'llms_sl_authorize_media_view', array( $this, 'authorize_media_view' ), 10, 3 );
*
* public function authorize_media_view( $is_authorized, $media_id, $url ) {
* $is_authorized = current_user_can( 'view_others_students' );
* return $is_authorized;
* }
*
* @since 7.7.0
*
* @todo Add handling of HTTP range requests. See {@see https://datatracker.ietf.org/doc/html/rfc7233} and
* {@see https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests}.
* @todo Add WordPress multi-site capability.
*/
class LLMS_Media_Protector {
/**
* The meta key used to specify the filter hook name that authorizes viewing of a media file.
*
* The key is protected by prefixing it with an underscore '_', which causes WordPress to not display it in
* a custom fields interface. {@see is_protected_meta()}.
*
* @since 7.7.0
*
* @var string
*/
public const AUTHORIZATION_FILTER_KEY = '_llms_media_authorization_filter';
/**
* Serve the media file by reading and outputting it with the readfile() function.
*
* This is the least efficient way to serve a file because it uses a PHP process instead of a HTTP server thread.
* For small files or a small number of protected files on a page, this may not be noticeable. However, the server's
* configuration may need to be changed to allow more PHP processes to run, which will use more memory.
*
* @since 7.7.0
*
* @var int
*/
public const SERVE_READ_FILE = 1;
/**
* Serve the media file by redirecting the HTTP client with a "Location" header.
*
* This is the least secure way to serve a file because an unprotected URL is given to the HTTP client.
* It is unlikely, yet possible, that the URL could then be used by an unauthorized user to view the file.
*
* @since 7.7.0
*
* @var int
*/
public const SERVE_REDIRECT = 2;
/**
* Serve the media file by sending an "X-Sendfile" style header and let the HTTP server serve the file.
*
* This is the most efficient and most secure way to serve a file. It requires one of the following HTTP servers.
* - {@see https://httpd.apache.org/ Apache httpd} with {@see https://tn123.org/mod_xsendfile/ mod_xsendfile}
* - {@see http://cherokee-project.com/doc/other_goodies.html Cherokee}
* - {@see https://redmine.lighttpd.net/projects/lighttpd/wiki/X-LIGHTTPD-send-file lighttpd}
* - {@see https://www.nginx.com/resources/wiki/start/topics/examples/x-accel/ NGINX}
*
* @since 7.7.0
*
* @var int
*/
public const SERVE_SEND_FILE = 3;
/**
* The name of the URL parameter for whether the media image should be treated as an icon.
*
* @since 7.7.0
*
* @var string
*/
public const URL_PARAMETER_ICON = 'llms_media_icon';
/**
* The name of the URL parameter for the media post ID.
*
* @since 7.7.0
*
* @var string
*/
public const URL_PARAMETER_ID = 'llms_media_id';
/**
* The name of the URL parameter for when the LifterLMS rewrite rule changes a URL that directly accesses the
* 'llms-uploads' directory into '/index.php?llms_protected_url=llms-uploads/PATH_TO_FILE'.
*
* @since 7.7.0
*
* @var string
*/
public const URL_PARAMETER_PROTECTED_URL = 'llms_protected_url';
/**
* The name of the URL parameter for the requested media image size.
*
* @since 7.7.0
*
* @var string
*/
public const URL_PARAMETER_SIZE = 'llms_media_image_size';
/**
* An optional path added to the base upload path.
*
* If it is not empty, it will have a leading slash and will not have a trailing slash.
* Normally, the full path is `WP_CONTENT_DIR . "/uploads/$base/$additional/$year/$month/$file_name"`.
*
* @since 7.7.0
*
* @var string
*/
protected $additional_upload_path = '';
/**
* A base path for uploaded LifterLMS files.
*
* If it is not empty, it will have a leading slash and will not have a trailing slash.
* Normally, the full path is `WP_CONTENT_DIR . "/uploads/$base/$additional/$year/$month/$file_name"`.
*
* @since 7.7.0
*
* @var string
*/
protected $base_upload_path = '';
/**
* Set up this class.
*
* @since 7.7.0
*
* @param string $additional_upload_path This path is added to the base upload path.
* @param string $base_upload_path This path is appended to the WordPress upload path, which defaults to
* `WP_CONTENT_DIR . '/uploads'` in {@see _wp_upload_dir()}.
* @return void
*/
public function __construct( $additional_upload_path = '', $base_upload_path = '/lifterlms' ) {
$this->set_base_upload_path( $base_upload_path );
$this->set_additional_upload_path( $additional_upload_path );
}
/**
* Adds query parameters to a protected media URL.
*
* Hooked to the {@see 'wp_get_attachment_image_src'} filter in {@see wp_get_attachment_image_src()}
* by {@see LLMS_Media_Protector::register_callbacks()}.
*
* @since 7.7.0
*
* @param array|false $image {
* Array of image data, or boolean false if no image is available.
*
* @type string $0 Image source URL.
* @type int $1 Image width in pixels.
* @type int $2 Image height in pixels.
* @type bool $3 Whether the image is a resized image.
* }
* @param int $media_id The post ID of the image.
* @param string|int[] $size Requested image size. Can be any registered image size name,
* or an array of width and height values in pixels (in that order).
* @param bool $icon Whether the image should be treated as an icon.
* @return array|false
*/
public function authorize_media_image_src( $image, $media_id, $size, $icon ) {
if ( ! is_numeric( $media_id ) || ! intval( $media_id ) ) {
// Nothing to verify.
return $image;
}
$is_authorized = $this->is_authorized_to_view( get_current_user_id(), $media_id );
if ( is_null( $is_authorized ) ) {
// The media file is not protected.
return $image;
} elseif ( false === $is_authorized ) {
// Return the same thing that wp_get_attachment_image_src would return if no image found.
return false;
}
$image[0] = add_query_arg(
array(
self::URL_PARAMETER_ID => $media_id,
self::URL_PARAMETER_SIZE => rawurlencode( is_array( $size ) ? wp_json_encode( $size ) : $size ),
self::URL_PARAMETER_ICON => $icon ? 1 : 0,
),
trailingslashit( home_url() )
);
return $image;
}
/**
* Returns the unchanged URL if the media file is not protected,
* else if the user is authorized, returns a URL that triggers {@see LLMS_Media_Protector::serve_file()} when requested,
* else returns a URL to a placeholder file.
*
* The result of this filter is cached for the duration of the current HTTP request.
*
* Hooked to the {@see 'wp_get_attachment_url'} filter in {@see wp_get_attachment_url()}
* by {@see LLMS_Media_Protector::register_callbacks()}.
*
* @since 7.7.0
*
* @param string $url URL for the given media file.
* @param int $media_id The post ID of the media file.
* @return string
*/
public function authorize_media_url( $url, $media_id ) {
$is_authorized = $this->is_authorized_to_view( get_current_user_id(), $media_id );
if ( true === $is_authorized ) {
$url = add_query_arg(
array( self::URL_PARAMETER_ID => $media_id ),
trailingslashit( home_url() )
);
} elseif ( false === $is_authorized ) {
$url = '';
}
// If $is_authorized is null, do not change $url because it is unprotected.
return $url;
}
/**
* Modify the media upload directory if this is a LifterLMS request.
*
* @param $params
*
* @return array
*/
public function change_media_upload_directory( $params ) {
if ( isset( $_REQUEST['llms'] ) && '1' === $_REQUEST['llms'] ) {
$params = $this->upload_dir( $params );
}
return $params;
}
/**
* Adds authorization meta after an attachment is added.
*
* @param $media_id
*
* @return void
*/
public function add_authorization_meta_after_attachment_added( $media_id ) {
$attachment = get_post( $media_id );
if ( $attachment && 'attachment' === $attachment->post_type && isset( $_REQUEST['llms'] ) && '1' === $_REQUEST['llms'] ) {
$this->add_authorization_meta_to_media_post( $media_id );
}
}
/**
* Returns a path path with a leading slash and without a trailing slash, or if the given path is empty, an empty string.
*
* @since 7.7.0
*
* @param string $path The path to be formatted.
* @return string An empty string or a path with a leading slash and without a trailing slash.
*/
protected function format_path( $path ) {
if ( '' === $path ) {
return $path;
}
// Add leading slash.
if ( strpos( $path, '/' ) !== 0 ) {
$path = '/' . $path;
}
// Strip trailing slash.
$path = untrailingslashit( $path );
return $path;
}
/**
* Returns the additional path that is added onto the base path.
*
* @since 7.7.0
*
* @return string
*/
public function get_additional_upload_path() {
return $this->additional_upload_path;
}
/**
* Returns the base upload path.
*
* @since 7.7.0
*
* @return string
*/
public function get_base_upload_path() {
return $this->base_upload_path;
}
/**
* Returns the absolute path to the media file in the upload directory.
*
* @since 7.7.0
*
* @param int $media_id The media post ID.
* @return string
*/
public function get_media_path( $media_id ) {
$upload_dir = wp_upload_dir();
$file_name = get_post_meta( $media_id, '_wp_attached_file', true );
return $upload_dir['basedir'] . DIRECTORY_SEPARATOR . $file_name;
}
/**
* Gets the size from the URL query parameter.
*
* @see wp_create_image_subsizes()
* @since 7.7.0
*
* @return string|int[]|null
*/
protected function get_size() {
$size = ( isset( $_GET[ self::URL_PARAMETER_SIZE ] ) ) ? sanitize_text_field( wp_unslash( $_GET[ self::URL_PARAMETER_SIZE ] ) ) : null;
if ( false === $size ) {
$size = null;
} elseif ( is_string( $size ) && '[' === $size[0] ) {
$size = json_decode( $size );
// Sanitize untrusted external input.
if ( isset( $size[0] ) ) {
$size[0] = (int) $size[0];
}
if ( isset( $size[1] ) ) {
$size[1] = (int) $size[1];
}
}
return $size;
}
/**
* Saves a file submitted from a POST request and creates an attachment post for it.
*
* @since 7.7.0
*
* @param string $file_id Index of the `$_FILES` array that the file was sent. Required.
* @param int $post_id The post ID of a post to attach the media item to. Required, but can
* be set to 0, creating a media item that has no relationship to a post.
* @param string $hook_name The name of the filter that will be applied by {@see LLMS_Media_Protector::is_authorized_to_view()}.
* @param array $post_data Optional. Set attachment elements that are sent to {@see wp_insert_post()}.
* The defaults are set in {@see media_handle_upload()}.
* @param array $overrides Optional. Override the {@see wp_handle_upload()} behavior.
* @return int|WP_Error Post ID of the media file or a WP_Error object on failure.
*/
public function handle_upload(
$file_id,
$post_id,
$hook_name,
$post_data = array(),
$overrides = array( 'test_form' => false )
) {
$post_data['meta_input'][ self::AUTHORIZATION_FILTER_KEY ] = $hook_name;
add_filter( 'upload_dir', array( $this, 'upload_dir' ), 10, 1 );
$media_id = media_handle_upload( $file_id, $post_id, $post_data, $overrides );
remove_filter( 'upload_dir', array( $this, 'upload_dir' ), 10 );
$this->add_authorization_meta_to_media_post( $media_id );
return $media_id;
}
/**
* See if the media is protected with an authorization filter.
*
* @param $media_id
*
* @return bool
*/
public function is_media_protected( $media_id ) {
return (bool) get_post_meta( $media_id, self::AUTHORIZATION_FILTER_KEY, true );
}
/**
* Returns true if the user is authorized to view the requested media file, false if not authorized,
* or null if the media file is not protected.
*
* Authorization is handled by the callback added to the filter hook name given to {@see LLMS_Media_Protector::handle_upload()}.
*
* @since 7.7.0
*
* @param int $user_id The user ID.
* @param int $media_id The post ID of the media file.
* @return bool|null
*/
public function is_authorized_to_view( $user_id, $media_id ): ?bool {
if ( ! is_numeric( $media_id ) || ! intval( $media_id ) ) {
return null;
}
$cache_key = 'llms-media-authorization-' . $media_id . '-' . $user_id;
$authorization = wp_cache_get( $cache_key, 'llms_media_authorization', false, $found );
if ( $found ) {
return ( ( $authorization === 'null' ) ? null : $authorization );
}
$authorization_filter = get_post_meta( $media_id, self::AUTHORIZATION_FILTER_KEY, true );
if ( ! $authorization_filter ) {
// We need to use string of 'null' since on some hosting like wordpress.com the value of null comes back as bool false.
wp_cache_add( $cache_key, 'null', 'llms_media_authorization' );
return null;
}
// The default is to allow WordPress super admins and LifterLMS managers to view all protected media files.
// @todo Consider allowing users with the some of the 'students' capabilities.
if ( is_super_admin( $user_id ) ) {
$is_authorized = true;
} else {
$user = wp_get_current_user();
$is_authorized = in_array( 'llms_manager', $user->roles, true ) || intval( get_post_field( 'post_author', $media_id ) ) === $user_id;
}
// Allow student to view if they have an incomplete attempt for a quiz this media is for.
if ( ! $is_authorized && llms_get_student() ) {
// Check if the student is enrolled in a course that has access to the media.
$authorized_product_id = get_post_meta( $media_id, '_llms_media_protection_product_id', true );
if ( $authorized_product_id && (
llms_get_student()->is_enrolled( $authorized_product_id ) ||
llms_current_user_can_edit_product( $authorized_product_id )
) ) {
$is_authorized = true;
}
if ( ! $is_authorized ) {
$authorized_quiz_ids = (array) get_post_meta( $media_id, '_llms_quiz_id', true );
if ( $authorized_quiz_ids ) {
$student_quizzes = llms_get_student()->quizzes()->get_all( $authorized_quiz_ids );
foreach ( $student_quizzes as $student_quiz_attempt ) {
$quiz_id = $student_quiz_attempt->get( 'quiz_id' );
if ( ! ( new LLMS_Quiz( $quiz_id ) )->is_open() ) {
continue;
}
if ( 'incomplete' === $student_quiz_attempt->get( 'status' ) ) {
$is_authorized = true;
break;
}
}
}
}
}
/**
* Allow the plugin that is protecting the file to authorize access to it.
*
* The default is to allow the user to view the file in case there is a not a callback for the authorization hook.
*
* @since 7.7.0
*
* @param bool|null $is_authorized True if the user is authorized to view the media file, false if not authorized,
* or null if the file is not protected.
* @param int $media_id The post ID of the media file.
* @param int $user_id The ID of the user wanting to view the media file.
*/
$is_authorized = apply_filters( $authorization_filter, $is_authorized, $media_id, $user_id );
// Sanitize value.
if ( ! is_bool( $is_authorized ) && ! is_null( $is_authorized ) ) {
$is_authorized = (bool) $is_authorized;
}
/**
* Determine how long the media authorization is valid for.
*
* @since 7.7.0
*
* @param int $cache_expiration Time in seconds to cache the authorization for this media file and user.
* @param int $media_id The post ID of the media file.
* @param int $user_id The ID of the user wanting to view the media file.
*/
$cache_expiration = apply_filters( 'llms_media_protection_cache_expiration_time', MINUTE_IN_SECONDS * 1, $media_id, $user_id );
wp_cache_add( $cache_key, $is_authorized, 'llms_media_authorization', $cache_expiration );
return $is_authorized;
}
/**
* Returns true if the current request has a different modification date or entity tag than the requested file.
*
* @since 7.7.0
*
* @param string $file_name The complete path and file name that the request is for.
* @param string $entity_tag {@see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag}.
* @return bool
*/
protected function is_requested_file_modified( $file_name, $entity_tag ): bool {
$is_modified = true;
$file_modified = filemtime( $file_name );
$if_modified_since = ( isset( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) ? sanitize_text_field( wp_unslash( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) : '';
if ( strtotime( $if_modified_since ) === $file_modified ) {
$is_modified = false;
}
$if_match = llms_filter_input( INPUT_SERVER, 'HTTP_IF_MATCH', FILTER_SANITIZE_URL );
if ( $if_match === $entity_tag ) {
$is_modified = false;
}
return $is_modified;
}
/**
* Changes the URLs for image attachments prepared for JavaScript.
*
* Hooked to the {@see 'wp_prepare_attachment_for_js'} filter in {@see wp_prepare_attachment_for_js()}
* by {@see LLMS_Media_Protector::register_callbacks()}.
*
* @since 7.7.0
*
* @param array $response Array of prepared attachment data.
* @param WP_Post $attachment Attachment object.
* @param array|false $meta Array of attachment meta data, or false if there is none.
* @return array
*/
public function prepare_attachment_for_js( $response, $attachment, $meta ) {
$is_authorized = $this->is_authorized_to_view( get_current_user_id(), $attachment->ID );
if ( is_null( $is_authorized ) || ! array_key_exists( 'sizes', $response ) ) {
return $response;
}
foreach ( $response['sizes'] as $size => &$size_meta ) {
$size_meta['url'] = add_query_arg(
array(
self::URL_PARAMETER_ID => $attachment->ID,
self::URL_PARAMETER_SIZE => $size,
),
trailingslashit( home_url() )
);
}
return $response;
}
/**
* Reads and outputs the file.
*
* This method sends the entire file and does not handle
* {@see https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests HTTP range requests}.
*
* @since 7.7.0
*
* @param string $file_name The file path and name.
* @return void
*/
protected function read_file( $file_name ): void {
// @todo What about the web server time limit?
set_time_limit( 0 );
// Tell the HTTP client that we do not handle HTTP range requests.
header( 'Accept-Ranges: none' );
// Turn off all output buffers to avoid running out of memory with large files.
// @see https://www.php.net/readfile#refsect1-function.readfile-notes.
wp_ob_end_flush_all();
$result = readfile( $file_name ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_readfile
if ( false === $result ) {
// Tell the HTTP client that something unspecific went wrong. readfile() outputs warnings to the PHP error log.
header( 'HTTP/1.1 500 Internal Server Error' );
}
}
/**
* Registers the callback functions for action and filter hooks that allow this class to protect uploaded media files.
*
* @since 7.7.0
*
* @return self
*/
public function register_callbacks() {
if (
// phpcs:disable WordPress.Security.NonceVerification.Recommended
array_key_exists( self::URL_PARAMETER_ID, $_GET ) ||
array_key_exists( self::URL_PARAMETER_PROTECTED_URL, $_GET )
// phpcs:enable WordPress.Security.NonceVerification.Recommended
) {
add_action( 'init', array( $this, 'serve_file' ), 10 );
} else {
add_filter( 'admin_init', array( $this, 'save_mod_rewrite_rules' ), 10, 1 );
add_filter( 'wp_prepare_attachment_for_js', array( $this, 'prepare_attachment_for_js' ), 99, 3 );
add_filter( 'wp_get_attachment_image_src', array( $this, 'authorize_media_image_src' ), 10, 4 );
add_filter( 'wp_get_attachment_url', array( $this, 'authorize_media_url' ), 10, 2 );
add_filter( 'upload_dir', array( $this, 'change_media_upload_directory' ), 10, 1 );
add_action( 'add_attachment', array( $this, 'add_authorization_meta_after_attachment_added' ), 10, 1 );
}
return $this;
}
/**
* Adds .htaccess and blank index.php/html files to the upload directory to protect the files from being listed.
*
* Hooked to the {@see 'flush_rewrite_rules_hard'} filter in {@see WP_Rewrite::flush_rules()}
* by {@see LLMS_Media_Protector::register_callbacks()}.
*
* @since 7.7.0
*/
public function save_mod_rewrite_rules() {
// TODO: Different for multi-site?
if ( false === get_transient( 'lifterlms_check_media_protection_files' ) ) {
global $wp_filesystem;
/** @var WP_Filesystem_Base $wp_filesystem */
/** Load files that define {@see WP_Filesystem()}, {@see media_handle_sideload()}, and many image functions. */
require_once ABSPATH . 'wp-admin/includes/file.php';
WP_Filesystem();
$uploads = wp_get_upload_dir();
$upload_path = $uploads['basedir'] . $this->get_base_upload_path();
$htaccess_file = $upload_path . '/.htaccess';
$upload_path_writeable = $wp_filesystem->is_writable( $upload_path );
$rules = "Options -Indexes\n";
$rules .= "deny from all\n";
if ( $upload_path_writeable && ! $wp_filesystem->exists( $htaccess_file ) ) {
$wp_filesystem->put_contents( $htaccess_file, $rules, 0644 );
} elseif ( $upload_path_writeable ) {
$contents = $wp_filesystem->get_contents( $htaccess_file );
if ( $contents !== $rules ) {
$wp_filesystem->put_contents( $htaccess_file, $rules, 0644 );
}
}
if ( $upload_path_writeable && ! $wp_filesystem->exists( $upload_path . '/index.php' ) ) {
$wp_filesystem->put_contents( $upload_path . '/index.php', '<?php' . PHP_EOL . '// Silence is golden.' );
}
if ( $upload_path_writeable && ! $wp_filesystem->exists( $upload_path . '/index.html' ) ) {
$wp_filesystem->put_contents( $upload_path . '/index.html', '' );
}
// Get the main directories in the root of the directory we're scanning.
$upload_root_dirs = glob( $upload_path . '/*', GLOB_ONLYDIR | GLOB_NOSORT | GLOB_MARK );
// Now get all the recursive directories.
$upload_sub_dirs = glob( $upload_path . '/*/**', GLOB_ONLYDIR | GLOB_NOSORT | GLOB_MARK );
// Merge the two arrays together, and avoid any possible duplicates.
foreach ( array_unique( array_merge( $upload_root_dirs, $upload_sub_dirs ) ) as $dir ) {
if ( ! wp_is_writable( $dir ) ) {
continue;
}
// Create index.php, if it doesn't exist.
if ( ! $wp_filesystem->exists( $dir . 'index.php' ) ) {
$wp_filesystem->put_contents( $dir . 'index.php', '<?php' . PHP_EOL . '// Silence is golden.' );
}
if ( ! $wp_filesystem->exists( $dir . 'index.html' ) ) {
$wp_filesystem->put_contents( $dir . 'index.html', '' );
}
}
set_transient( 'lifterlms_check_media_protection_files', true, DAY_IN_SECONDS );
}
}
/**
* Outputs an X-Sendfile or X-Accel-Redirect HTTP header which will instruct the HTTP server
* to send the file so that PHP doesn't have to.
*
* If none of the following HTTP servers are detected, {@see LLMS_Media_Protector::read_file()} is called.
* - {@see https://tn123.org/mod_xsendfile/ Apache mod_xsendfile}
* - {@see https://redmine.lighttpd.net/projects/lighttpd/wiki/Docs_ModCGI Lighttpd}
* - {@see https://www.nginx.com/resources/wiki/start/topics/examples/xsendfile/ NGINX}
* - {@see https://cherokee-project.com/doc/other_goodies.html#x-sendfile Cherokee}
*
* Add `$_SERVER['MOD_X_SENDFILE_ENABLED'] = '1';` in `wp-config.php` if web server auto-detection isn't working.
*
* IIS administrators may want to use {@see https://github.com/stakach/IIS-X-Sendfile-plugin}.
*
* @since 7.7.0
*
* @param string $file_name The file path and name.
* @param int $media_id The post ID of the media file. Not used in this implementation, but here for consistency
* with the other "serve" methods and may be useful in an overriding this method.
* @return void
*/
protected function send_file( $file_name, $media_id ) {
$server_software = ( isset( $_SERVER['SERVER_SOFTWARE'] ) ? sanitize_text_field( wp_unslash( $_SERVER['SERVER_SOFTWARE'] ) ) : '' );
if (
( array_key_exists( 'MOD_X_SENDFILE_ENABLED', $_SERVER ) && '1' === $_SERVER['MOD_X_SENDFILE_ENABLED'] ) ||
( function_exists( 'apache_get_modules' ) && in_array( 'mod_xsendfile', apache_get_modules(), true ) ) ||
stristr( $server_software, 'cherokee' ) ||
stristr( $server_software, 'lighttpd' )
) {
header( "X-Sendfile: $file_name" );
} elseif ( stristr( $server_software, 'nginx' ) ) {
/**
* @see https://www.nginx.com/resources/wiki/start/topics/examples/xsendfile/
* @see https://woocommerce.com/document/digital-downloadable-product-handling/#nginx-setting
*/
// NGINX requires a URI without the server's root path.
$wp_root = $this->find_wp_root();
if ( $wp_root ) {
$nginx_file_name = substr( $file_name, strlen( $this->find_wp_root() ) );
header( 'X-Accel-Redirect: ' . urlencode( $nginx_file_name ) );
} else {
$this->read_file( $file_name );
}
} else {
$this->read_file( $file_name );
}
}
protected function find_wp_root() {
$dir = dirname( WP_CONTENT_DIR );
while ( $dir ) {
if ( file_exists( $dir . '/wp-load.php' ) || file_exists( $dir . '/wp-config.php' ) ) {
return $dir;
}
$parent_dir = dirname( $dir );
if ( $parent_dir === $dir ) {
// We have reached the root directory
break;
}
$dir = $parent_dir;
}
return false; // Root directory not found
}
/**
* Send headers for the download.
*
* @since 7.7.0
*
* @param string $file_name The file path and name.
* @param int $media_id The post ID of the media file.
* @return void
*/
protected function send_headers( $file_name, $media_id ) {
$file_size = @filesize( $file_name ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
if ( ! $file_size ) {
return;
}
$media_file = get_post( $media_id );
$content_type = $media_file->post_mime_type;
header( "Content-Type: $content_type" );
header( "Content-Length: $file_size" );
header( 'X-Robots-Tag: noindex, nofollow', true );
}
/**
* Sends a header that redirects the HTTP client to the media file's URL.
*
* @since 7.7.0
*
* @param int $media_id The post ID of the media file.
* @param string|int[]|null $size A registered image size name, or an array of width and height values in pixels.
* @param bool|null $icon Whether the image should fall back to a mime type icon.
* @return void
*/
protected function send_redirect( $media_id, $size, $icon ): void {
if ( is_null( $size ) && is_null( $icon ) ) {
$url = wp_get_attachment_url( $media_id );
} else {
$url = wp_get_attachment_image_url( $media_id, $size, $icon );
}
header( "Location: $url" );
}
protected function strip_query_params( $file_name ) {
$parsed_url = wp_parse_url( $file_name );
$path = isset( $parsed_url['path'] ) ? $parsed_url['path'] : $file_name;
return $path;
}
/**
* Serves the requested media file to the HTTP client.
*
* This method calls the {@see llms_exit()} function and does not return.
*
* Hooked to the {@see 'init'} filter by {@see LLMS_Media_Protector::register_callbacks()}.
*
* @since 7.7.0
*
* @return void
* @throws LLMS_Unit_Test_Exception_Exit Thrown during unit testing instead of exiting.
*/
public function serve_file() {
$media_id = llms_filter_input( INPUT_GET, self::URL_PARAMETER_ID, FILTER_SANITIZE_NUMBER_INT );
// Handle a rewritten URL.
// e.g. `/wp-content/uploads/llms-uploads/2022/01/image.png` is changed by the LifterLMS mod_rewrite rule
// into `/index.php?llms-uploads=llms_protected_url/2022/01/image.png`.
if ( empty( $media_id ) ) {
$attached_file = llms_filter_input( INPUT_GET, self::URL_PARAMETER_PROTECTED_URL, FILTER_SANITIZE_URL );
/** Extract the optional size. {@see WP_Image_Editor::get_suffix()} and {@see WP_Image_Editor::generate_filename()} */
$result = preg_match( '/^(.+?)-(\d+x\d+)(.+)$/', $attached_file, $matches );
if ( $result ) {
$attached_file = $matches[1] . $matches[3];
$size = explode( 'x', $matches[2] );
$size = array_map( 'intval', $size );
}
$query = new WP_Query(
array(
'fields' => 'ids',
'meta_key' => '_wp_attached_file',
'meta_value' => $attached_file,
'post_status' => 'any',
'post_type' => 'attachment',
)
);
$media_id = reset( $query->posts );
}
// The auth filter meta needs to exist for the media file to be served by this method.
if ( ! get_post_meta( $media_id, self::AUTHORIZATION_FILTER_KEY, true ) ) {
header( 'HTTP/1.1 404 Not Found' );
llms_exit();
}
$media_file = get_post( $media_id );
// Validate that the attachment post exists.
if ( is_null( $media_file ) || 'attachment' !== $media_file->post_type ) {
header( 'HTTP/1.1 404 Not Found' );
llms_exit();
}
$file_name = $this->get_media_path( $media_id );
// Optionally, use an alternate image size.
if ( ! isset( $size ) ) {
$size = $this->get_size();
}
$icon = ( isset( $_GET[ self::URL_PARAMETER_ICON ] ) ? sanitize_text_field( wp_unslash( $_GET[ self::URL_PARAMETER_ICON ] ) ) : null );
if ( ! is_null( $size ) || $icon ) {
$image = wp_get_attachment_image_src( $media_id, $size, $icon );
$file_name = dirname( $file_name ) . '/' . basename( $image[0] );
}
$file_name = $this->strip_query_params( $file_name );
// Validate that the media file exists.
if ( false === file_exists( $file_name ) ) {
header( 'HTTP/1.1 404 Not Found' );
llms_exit();
}
// Is the user authorized to view the file?
$is_authorized = $this->is_authorized_to_view( get_current_user_id(), $media_id );
if ( false === $is_authorized ) {
status_header( 404 );
nocache_headers();
die( 'File not found.' );
}
// An HTTP client, but not a proxy, is allowed to cache the file, but must check with the server before reuse.
$entity_tag = '"' . md5_file( $file_name ) . '"';
if ( false === $this->is_requested_file_modified( $file_name, $entity_tag ) ) {
header( 'HTTP/1.1 304 Not Modified' );
llms_exit();
}
header( 'Cache-Control: private, no-cache' );
header( "Etag: $entity_tag" );
$serve_method = self::SERVE_SEND_FILE;
// If WPEngine, we need to use the slower read file method as send file does not work.
if ( function_exists( 'is_wpe' ) && is_wpe() ) {
$serve_method = self::SERVE_READ_FILE;
}
/**
* Determine how the media file should be served.
*
* @since 7.7.0
*
* @param string $serve_method One of the LLMS_Media_Protector::SERVE_X constants, {@see LLMS_Media_Protector::SERVE_SEND_FILE}.
* @param int $media_id The post ID of the media file.
* @param bool|null $is_authorized True if the user is authorized to view the requested media file,
* false if not authorized, or null if the media file is not protected.
*/
$serve_method = apply_filters( 'llms_media_serve_method', $serve_method, $media_id, $is_authorized );
// Don't use 'llms-uploads=' rewrite + send_redirect() at the same time. Otherwise there will be an infinite loop
// of HTTP requests for the file and HTTP responses with a '302 Found' redirect back to the same file.
if ( self::SERVE_REDIRECT === $serve_method && isset( $attached_file ) ) {
$serve_method = self::SERVE_READ_FILE;
}
switch ( $serve_method ) {
case self::SERVE_READ_FILE:
$this->send_headers( $file_name, $media_id );
$this->read_file( $file_name );
break;
case self::SERVE_SEND_FILE:
$this->send_headers( $file_name, $media_id );
$this->send_file( $file_name, $media_id );
break;
case self::SERVE_REDIRECT:
default:
$this->send_redirect( $media_id, $size, $icon );
break;
}
llms_exit();
}
/**
* Sanitizes and sets the additional upload path that is appended to the base upload path.
*
* @since 7.7.0
*
* @param string $additional_upload_path
* @return self
*/
public function set_additional_upload_path( $additional_upload_path ): self {
$this->additional_upload_path = $this->format_path( $additional_upload_path );
return $this;
}
/**
* Sanitizes and sets the base upload path relative to `WP_CONTENT_DIR . '/uploads'`.
*
* @since 7.7.0
*
* @param string $base_upload_path
* @return self
*/
public function set_base_upload_path( $base_upload_path ): self {
$this->base_upload_path = $this->format_path( $base_upload_path );
return $this;
}
public function get_upload_basedir() {
return trailingslashit( $this->base_upload_path . $this->additional_upload_path );
}
/**
* Filters the 'uploads' directory data.
*
* @since 7.7.0
*
* @param array $uploads {
* Array of information about the upload directory.
*
* @type string $path Base directory and subdirectory or full path to upload directory.
* @type string $url Base URL and subdirectory or absolute URL to upload directory.
* @type string $subdir Subdirectory if uploads use year/month folders option is on.
* @type string $basedir Path without subdirectory.
* @type string $baseurl URL path without subdirectory.
* @type string|false $error False or error message.
* }
* @return array
*/
public function upload_dir( $uploads ) {
$uploads['subdir'] = trailingslashit( $this->get_upload_basedir() ) . date( 'Y/m' );
$uploads['path'] = $uploads['basedir'] . $uploads['subdir'];
$uploads['url'] = $uploads['baseurl'] . $uploads['subdir'];
return $uploads;
}
/**
* Add authorization meta to the post.
*
* @param $post_id
* @param string $hook_name The name of the filter that will be applied by {@see LLMS_Media_Protector::is_authorized_to_view()}.
*
* @return void
*/
public function add_authorization_meta_to_media_post( $post_id, $hook_name = 'llms_attachment_is_access_allowed' ) {
if ( ! is_numeric( $post_id ) ) {
return;
}
update_post_meta( $post_id, self::AUTHORIZATION_FILTER_KEY, $hook_name );
}
}
================================================
FILE: includes/class-llms-mime-type-extractor.php
================================================
<?php
/**
* LifterLMS Mime Type Extractor
*
* @package LifterLMS/Classes
*
* @since 3.38.1
* @version 3.38.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Mime_Type_Extractor class
*
* @since 3.38.1
*/
class LLMS_Mime_Type_Extractor {
const DEFAULT_MIME_TYPE = 'application/octet-stream';
/**
* Mime Type List
*
* @var array
*/
private static $mime_type_list = array(
'zip' => 'application/zip',
'gz' => 'application/gzip',
'bz2' => 'application/x-bzip',
'tar' => 'application/x-tar',
'3gp' => 'video/3gpp',
'ai' => 'application/postscript',
'aif' => 'audio/x-aiff',
'aifc' => 'audio/x-aiff',
'aiff' => 'audio/x-aiff',
'asc' => 'text/plain',
'atom' => 'application/atom+xml',
'au' => 'audio/basic',
'avi' => 'video/x-msvideo',
'bcpio' => 'application/x-bcpio',
'bin' => 'application/octet-stream',
'bmp' => 'image/bmp',
'cdf' => 'application/x-netcdf',
'cgm' => 'image/cgm',
'class' => 'application/octet-stream',
'cpio' => 'application/x-cpio',
'cpt' => 'application/mac-compactpro',
'csh' => 'application/x-csh',
'css' => 'text/css',
'dcr' => 'application/x-director',
'dif' => 'video/x-dv',
'dir' => 'application/x-director',
'djv' => 'image/vnd.djvu',
'djvu' => 'image/vnd.djvu',
'dll' => 'application/octet-stream',
'dmg' => 'application/octet-stream',
'dms' => 'application/octet-stream',
'doc' => 'application/msword',
'dtd' => 'application/xml-dtd',
'dv' => 'video/x-dv',
'dvi' => 'application/x-dvi',
'dxr' => 'application/x-director',
'eps' => 'application/postscript',
'etx' => 'text/x-setext',
'exe' => 'application/octet-stream',
'ez' => 'application/andrew-inset',
'flv' => 'video/x-flv',
'gif' => 'image/gif',
'gram' => 'application/srgs',
'grxml' => 'application/srgs+xml',
'gtar' => 'application/x-gtar',
'hdf' => 'application/x-hdf',
'hqx' => 'application/mac-binhex40',
'htm' => 'text/html',
'html' => 'text/html',
'ice' => 'x-conference/x-cooltalk',
'ico' => 'image/x-icon',
'ics' => 'text/calendar',
'ief' => 'image/ief',
'ifb' => 'text/calendar',
'iges' => 'model/iges',
'igs' => 'model/iges',
'jnlp' => 'application/x-java-jnlp-file',
'jp2' => 'image/jp2',
'jpe' => 'image/jpeg',
'jpeg' => 'image/jpeg',
'jpg' => 'image/jpeg',
'js' => 'application/x-javascript',
'kar' => 'audio/midi',
'latex' => 'application/x-latex',
'lha' => 'application/octet-stream',
'lzh' => 'application/octet-stream',
'm3u' => 'audio/x-mpegurl',
'm4a' => 'audio/mp4a-latm',
'm4p' => 'audio/mp4a-latm',
'm4u' => 'video/vnd.mpegurl',
'm4v' => 'video/x-m4v',
'mac' => 'image/x-macpaint',
'man' => 'application/x-troff-man',
'mathml' => 'application/mathml+xml',
'me' => 'application/x-troff-me',
'mesh' => 'model/mesh',
'mid' => 'audio/midi',
'midi' => 'audio/midi',
'mif' => 'application/vnd.mif',
'mov' => 'video/quicktime',
'movie' => 'video/x-sgi-movie',
'mp2' => 'audio/mpeg',
'mp3' => 'audio/mpeg',
'mp4' => 'video/mp4',
'mpe' => 'video/mpeg',
'mpeg' => 'video/mpeg',
'mpg' => 'video/mpeg',
'mpga' => 'audio/mpeg',
'ms' => 'application/x-troff-ms',
'msh' => 'model/mesh',
'mxu' => 'video/vnd.mpegurl',
'nc' => 'application/x-netcdf',
'oda' => 'application/oda',
'ogg' => 'application/ogg',
'ogv' => 'video/ogv',
'pbm' => 'image/x-portable-bitmap',
'pct' => 'image/pict',
'pdb' => 'chemical/x-pdb',
'pdf' => 'application/pdf',
'pgm' => 'image/x-portable-graymap',
'pgn' => 'application/x-chess-pgn',
'pic' => 'image/pict',
'pict' => 'image/pict',
'png' => 'image/png',
'pnm' => 'image/x-portable-anymap',
'pnt' => 'image/x-macpaint',
'pntg' => 'image/x-macpaint',
'ppm' => 'image/x-portable-pixmap',
'ppt' => 'application/vnd.ms-powerpoint',
'ps' => 'application/postscript',
'qt' => 'video/quicktime',
'qti' => 'image/x-quicktime',
'qtif' => 'image/x-quicktime',
'ra' => 'audio/x-pn-realaudio',
'ram' => 'audio/x-pn-realaudio',
'ras' => 'image/x-cmu-raster',
'rdf' => 'application/rdf+xml',
'rgb' => 'image/x-rgb',
'rm' => 'application/vnd.rn-realmedia',
'roff' => 'application/x-troff',
'rtf' => 'text/rtf',
'rtx' => 'text/richtext',
'sgm' => 'text/sgml',
'sgml' => 'text/sgml',
'sh' => 'application/x-sh',
'shar' => 'application/x-shar',
'silo' => 'model/mesh',
'sit' => 'application/x-stuffit',
'skd' => 'application/x-koan',
'skm' => 'application/x-koan',
'skp' => 'application/x-koan',
'skt' => 'application/x-koan',
'smi' => 'application/smil',
'smil' => 'application/smil',
'snd' => 'audio/basic',
'so' => 'application/octet-stream',
'spl' => 'application/x-futuresplash',
'src' => 'application/x-wais-source',
'sv4cpio' => 'application/x-sv4cpio',
'sv4crc' => 'application/x-sv4crc',
'svg' => 'image/svg+xml',
'swf' => 'application/x-shockwave-flash',
't' => 'application/x-troff',
'tcl' => 'application/x-tcl',
'tex' => 'application/x-tex',
'texi' => 'application/x-texinfo',
'texinfo' => 'application/x-texinfo',
'tif' => 'image/tiff',
'tiff' => 'image/tiff',
'tr' => 'application/x-troff',
'tsv' => 'text/tab-separated-values',
'txt' => 'text/plain',
'ustar' => 'application/x-ustar',
'vcd' => 'application/x-cdlink',
'vrml' => 'model/vrml',
'vxml' => 'application/voicexml+xml',
'wav' => 'audio/x-wav',
'wbmp' => 'image/vnd.wap.wbmp',
'wbxml' => 'application/vnd.wap.wbxml',
'webm' => 'video/webm',
'wml' => 'text/vnd.wap.wml',
'wmlc' => 'application/vnd.wap.wmlc',
'wmls' => 'text/vnd.wap.wmlscript',
'wmlsc' => 'application/vnd.wap.wmlscriptc',
'wmv' => 'video/x-ms-wmv',
'wrl' => 'model/vrml',
'xbm' => 'image/x-xbitmap',
'xht' => 'application/xhtml+xml',
'xhtml' => 'application/xhtml+xml',
'xls' => 'application/vnd.ms-excel',
'xml' => 'application/xml',
'xpm' => 'image/x-xpixmap',
'xsl' => 'application/xml',
'xslt' => 'application/xslt+xml',
'xul' => 'application/vnd.mozilla.xul+xml',
'xwd' => 'image/x-xwindowdump',
'xyz' => 'chemical/x-xyz',
);
/**
* Retrieve the mime type from file path.
*
* @param string $file The file path string.
* @return string
*/
public static function from_file_path( $file ) {
if ( ! is_readable( $file ) || is_dir( $file ) || is_link( $file ) ) {
return self::DEFAULT_MIME_TYPE;
}
$mime_type = '';
$file_suffix = pathinfo( $file, PATHINFO_EXTENSION );
$suffix = strtolower( $file_suffix );
if ( isset( self::$mime_type_list[ $suffix ] ) ) {
$mime_type = self::$mime_type_list[ $suffix ];
}
if ( ! $mime_type && function_exists( 'finfo_file' ) ) {
$finfo = finfo_open( FILEINFO_MIME_TYPE );
$mime_type = finfo_file( $finfo, $file );
finfo_close( $finfo );
}
if ( ! $mime_type && function_exists( 'mime_content_type' ) ) {
$mime_type = mime_content_type( $file );
}
return $mime_type ? $mime_type : self::DEFAULT_MIME_TYPE;
}
}
================================================
FILE: includes/class-llms-order-generator.php
================================================
<?php
/**
* LLMS_Order_Generator class file.
*
* @package LifterLMS/Classes
*
* @since 7.0.0
* @version 7.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Validate and create LLMS_Order posts.
*
* @since 7.0.0
*/
class LLMS_Order_Generator {
/**
* Error code: invalid coupon code submitted.
*
* @var string
*/
const E_COUPON_INVALID = 'llms-order-gen-coupon-invalid';
/**
* Error code: coupon code not found.
*
* @var string
*/
const E_COUPON_NOT_FOUND = 'llms-order-gen-coupon-not-found';
/**
* Error code: issue encountered during order post creation.
*
* @var string
*/
const E_CREATE_ORDER = 'llms-order-gen-create-order';
/**
* Error code: payment gateway id not submitted.
*
* @var string
*/
const E_GATEWAY_REQUIRED = 'llms-order-gen-gateway-required';
/**
* Error code: missing or invalid order key during confirmation.
*
* @var string
*/
const E_ORDER_NOT_FOUND = 'llms-order-gen-order-not-found';
/**
* Error code: order cannot be confirmed.
*
* @var string
*/
const E_ORDER_NOT_CONFIRMABLE = 'llms-order-gen-order-not-confirmable';
/**
* Error code: required plan ID not submitted.
*
* @var string
*/
const E_PLAN_REQUIRED = 'llms-order-gen-plan-required';
/**
* Error code: access plan not found.
*
* @var string
*/
const E_PLAN_NOT_FOUND = 'llms-order-gen-plan-not-found';
/**
* Error code: site's terms not accepted.
*
* @var string
*/
const E_SITE_TERMS = 'llms-order-gen-site-terms';
/**
* Error code: user already enrolled.
*
* @var string
*/
const E_USER_ENROLLED = 'llms-order-gen-user-enrolled';
/**
* User Action: validate and then commit (register or update) the user.
*
* @var string
*/
const UA_COMMIT = 'commit';
/**
* User Action: perform user validation only.
*
* @var string
*/
const UA_VALIDATE = 'validate';
/**
* The coupon used to discount the order.
*
* Derived from `$this->data['llms_coupon_code']`.
*
* Will be empty until the coupon is validated.
*
* @var LLMS_Coupon|null
*/
protected $coupon = null;
/**
* Associative array of input data.
*
* Usually the $_POST superglobal.
*
* @var array
*/
protected $data = array();
/**
* The payment gateway used to process the order.
*
* Derived from `$this->data['llms_payment_gateway']` .
*
* Will be empty until the gateway is validated.
*
* @var LLMS_Payment_Gateway|null
*/
protected $gateway = null;
/**
* The access plan used to generate the order.
*
* Derived from `$this->data['llms_plan_id']`.
*
* Will be empty until the plan is validated.
*
* @var LLMS_Access_Plan|null
*/
protected $plan = null;
/**
* The order.
*
* Derived from `$this->data['llms_order_key']`.
*
* Will be empty until the order is validated.
*
* This is only used during confirmation of existing orders.
*
* @var LLMS_Order|null
*/
protected $order = null;
/**
* The student used to generate the order.
*
* Will be empty until the user is created / update following all validations.
*
* @var LLMS_Student|null
*/
protected $student = null;
/**
* Constructor.
*
* @since 7.0.0
*
* @param array $data {
* An associative array of input data used to generate the order, usually from $_POST.
*
* @type integer $llms_plan_id An LLMS_Access_Plan ID.
* @type string $llms_agree_to_terms A yes/no value determining whether or not the user has agreed to the site's terms.
* @type string $llms_payment_gateway The ID of the payment gateway used to process the order.
* @type string $llms_coupon_code Optional. The coupon code string being used.
* @type string $llms_order_key Optional. An `LLMS_Order` key used to modify an existing pending order rather than creating a new one.
* @type array ...$user_data All remaining data is passed to the user creation functions.
* }
* @return void
*/
public function __construct( $data ) {
$this->data = $data;
}
/**
* Confirms an existing pending order.
*
* @since 7.0.0
*
* @return WP_Error|array Returns an array of data from the payment gateway's `confirm_pending_order()` method on success.
*/
public function confirm() {
$validate = $this->validate( true );
if ( is_wp_error( $validate ) ) {
return $validate;
}
$gateway_confirm = $this->gateway->confirm_pending_order( $this->order );
if ( is_wp_error( $gateway_confirm ) ) {
return $gateway_confirm;
}
$user = $this->commit_user();
if ( is_wp_error( $user ) ) {
return $user;
}
// Save the user to the order.
$this->order->set_user_data( $this->get_user_data() );
if ( 'SUCCESS' === ( $gateway_confirm['status'] ?? null ) && ! empty( $gateway_confirm['transaction'] ) ) {
// Record the transaction.
$this->order->record_transaction( $gateway_confirm['transaction'] );
}
return $gateway_confirm;
}
/**
* Creates a new pending order.
*
* @since 7.0.0
*
* @return WP_Error|LLMS_Order
*/
protected function create() {
$order = new LLMS_Order( $this->get_order_id() );
// If there's no id we can't proceed, return an error.
if ( ! $order->get( 'id' ) ) {
return $this->error(
self::E_CREATE_ORDER,
__( 'There was an error creating your order, please try again.', 'lifterlms' )
);
}
$order->init( $this->get_user_data(), $this->plan, $this->gateway, $this->coupon );
return $order;
}
/**
* Registers or updates the user from the submitted data.
*
* @since 7.0.0
*
* @return integer|WP_Error Returns the `WP_User` ID on success or an error object.
*/
protected function commit_user() {
$args = array(
'plan' => $this->plan,
);
$user_id = get_current_user_id() ?
llms_update_user( $this->data, 'checkout', $args ) :
llms_register_user( $this->data, 'checkout', true, $args );
if ( ! is_wp_error( $user_id ) ) {
$this->student = llms_get_student( $user_id );
}
return $user_id;
}
/**
* Returns an error object.
*
* This method accepts an error code and message and passes them directly to `WP_Error` and
* adds all class variables to the error objects `$data` parameter.
*
* @since 7.0.0
*
* @param string $code Error code.
* @param string $message Error message.
* @param array $extra_data Additional data to pass to WP_Error's 3rd parameter.
* @return WP_Error
*/
protected function error( $code, $message, $extra_data = array() ) {
$data = get_class_vars( __CLASS__ );
foreach ( $data as $key => &$val ) {
$val = $this->{$key};
}
return new WP_Error( $code, $message, array_merge( $data, $extra_data ) );
}
/**
* Attempts to locate a user ID.
*
* Uses the logged in user's information and falls back to a lookup by email address if available.
*
* @since 7.0.0
*
* @param string|null $email An email address, if available.
* @return null|integer Returns the WP_User ID or null if not found.
*/
private function find_user_id( $email = null ) {
if ( is_user_logged_in() ) {
return get_current_user_id();
}
if ( $email ) {
$user = get_user_by( 'email', $email );
return $user ? $user->ID : null;
}
return null;
}
/**
* Generates an order.
*
* Uses data submitted during class construction and performs all necessary
* validations. If validations pass, creates the order.
*
* @since 7.0.0
*
* @param string $user_action The user action, accepts `LLMS_Order_Generator::UA_COMMIT` or `LLMS_Order_Generator::UA_VALIDATE`.
* @return WP_Error|LLMS_Order
*/
public function generate( $user_action = self::UA_COMMIT ) {
$validate = $this->validate();
if ( is_wp_error( $validate ) ) {
return $validate;
}
if ( self::UA_COMMIT === $user_action ) {
$user = $this->commit_user();
if ( is_wp_error( $user ) ) {
return $user;
}
}
return $this->create();
}
/**
* Retrieves the coupon object for the order.
*
* @since 7.0.0
*
* @return LLMS_Coupon|null
*/
public function get_coupon() {
return $this->coupon;
}
/**
* Retrieves the payment gateway instance for the order.
*
* @since 7.0.0
*
* @return LLMS_Payment_Gateway|null
*/
public function get_gateway() {
return $this->gateway;
}
/**
* Retrieves the order id to use for the order.
*
* Attempts to locate an existing pending order by order key if it was submitted,
* otherwise returns `new` which denotes a new order should be created.
*
* @since 7.0.0
*
* @return integer|string
*/
protected function get_order_id() {
$order_id = null;
$key = $this->data['llms_order_key'] ?? null;
$email = $this->data['email_address'] ?? null;
$plan_id = $this->data['llms_plan_id'] ?? null;
// Try to lookup using the order key if it was supplied.
if ( $key ) {
$order_id = $this->sanitize_retrieved_order_id( llms_get_order_by_key( $key, 'id' ) );
}
// Try to lookup by user ID.
if ( ! $order_id ) {
$user_id = $this->find_user_id( $email );
$order_id = $user_id ? $this->sanitize_retrieved_order_id( llms_locate_order_for_user_and_plan( $user_id, $plan_id ) ) : null;
}
// Lookup by email address.
if ( ! $order_id && $email ) {
$order_id = $this->sanitize_retrieved_order_id( llms_locate_order_for_email_and_plan( $email, $plan_id ) );
}
return $order_id ? $order_id : 'new';
}
/**
* Retrieves the access plan for the order.
*
* @since 7.0.0
*
* @return LLMS_Access_Plan|null
*/
public function get_plan() {
return $this->plan;
}
/**
* Retrieves the order object.
*
* @since 7.0.0
*
* @return LLMS_Order|null
*/
public function get_order() {
return $this->order;
}
/**
* Retrieves the student for the order.
*
* @since 7.0.0
*
* @return LLMS_Student|null
*/
public function get_student() {
return $this->student;
}
/**
* Retrieves an array of data representing the student.
*
* The resulting array is intended to be used for setting up the `LLMS_Order` post's
* user metadata, ideally passed to `LLMS_Order::init()`.
*
* @since 7.0.0
*
* @return array
*/
public function get_user_data() {
$map = array(
'billing_email' => 'email_address',
'billing_first_name' => 'first_name',
'billing_last_name' => 'last_name',
'billing_phone' => 'llms_phone',
);
$data = array(
'billing_email' => '',
'billing_first_name' => '',
'billing_last_name' => '',
'billing_address_1' => '',
'billing_address_2' => '',
'billing_city' => '',
'billing_state' => '',
'billing_zip' => '',
'billing_country' => '',
'billing_phone' => '',
);
foreach ( $data as $key => &$val ) {
$data_key = $map[ $key ] ?? "llms_{$key}";
$val = $this->data[ $data_key ] ?? '';
}
$data['user_id'] = $this->student ? $this->student->get( 'id' ) : '';
return $data;
}
/**
* Sanitizes the order_id retrieved by {@see LLMS_Order_Generator::get_order_id()} to ensure it can be resumed or confirmed during checkout.
*
* Only orders with the `llms-pending` status can be resumed or confirmed.
*
* @since 7.0.0
*
* @param null|int $order_id The order ID or `null` if the lookup didn't yield a result.
* @return int|null Returns the submitted order ID if it's valid or `null`.
*/
private function sanitize_retrieved_order_id( $order_id ) {
return $order_id && 'llms-pending' === get_post_status( $order_id ) ? $order_id : null;
}
/**
* Performs all required data validations necessary to create the order.
*
* @since 7.0.0
*
* @param boolean $validate_order Whether or not order data should be validated. This is `true` when running `confirm()` and `false` otherwise.
* @return boolean|WP_Error Returns `true` if all validations pass or an error object.
*/
protected function validate( $validate_order = false ) {
/**
* Allows 3rd party validation prior to generation of an order.
*
* This validation hook runs prior to all default validation.
*
* @since 7.0.0
*
* @param null|WP_Error $validation_error Halts checkout and returns the supplied error.
*/
$before_validation = apply_filters( 'llms_before_generate_order_validation', null );
if ( is_wp_error( $before_validation ) ) {
return $before_validation;
}
$validations = array(
'validate_plan',
'validate_coupon',
'validate_gateway',
'validate_terms',
'validate_user',
);
if ( $validate_order ) {
array_unshift( $validations, 'validate_order' );
}
foreach ( $validations as $func ) {
$res = $this->{$func}();
if ( is_wp_error( $res ) ) {
return $res;
}
}
/**
* Allows 3rd party validation prior to generation of an order.
*
* This validation hook runs after all default validation.
*
* @since 7.0.0
*
* @param boolean|WP_Error $validation_error Halts checkout and returns the supplied error.
*/
return apply_filters( 'llms_after_generate_order_validation', true );
}
/**
* Validates the coupon.
*
* @since 7.0.0
*
* @return boolean|WP_Error Returns `true` on success or an error object.
*/
protected function validate_coupon() {
// If a coupon is being used, validate it.
if ( ! empty( $this->data['llms_coupon_code'] ) ) {
$code = sanitize_text_field( $this->data['llms_coupon_code'] );
// Locate the coupon post ID.
$coupon_id = llms_find_coupon( $code );
if ( ! $coupon_id ) {
return $this->error(
self::E_COUPON_NOT_FOUND,
sprintf(
// Translators: %s = The user-submitted coupon code.
__( 'Coupon code "%s" not found.', 'lifterlms' ),
$code
)
);
}
// Validate the coupon for the current plan.
$coupon = llms_get_post( $coupon_id );
$valid = $coupon->is_valid( $this->plan->get( 'id' ) );
if ( is_wp_error( $valid ) ) {
return $this->error( self::E_COUPON_INVALID, $valid->get_error_message() );
}
$this->coupon = $coupon;
}
return true;
}
/**
* Validates the payment gateway.
*
* @since 7.0.0
*
* @return boolean|WP_Error Returns `true` on success or an error object.
*/
protected function validate_gateway() {
$coupon_id = $this->coupon ? $this->coupon->get( 'id' ) : null;
/**
* If payment is required, verify we have a gateway.
*
* For free plans the manual gateway is automatically used, whether or not it's enabled.
*/
if ( $this->plan->requires_payment( $coupon_id ) && empty( $this->data['llms_payment_gateway'] ) ) {
return $this->error( self::E_GATEWAY_REQUIRED, __( 'No payment method selected.', 'lifterlms' ) );
}
$gateway_id = $this->data['llms_payment_gateway'] ?? 'manual';
$is_valid = llms_can_gateway_be_used_for_plan( $gateway_id, $this->plan );
if ( is_wp_error( $is_valid ) ) {
return $is_valid;
}
$this->gateway = llms()->payment_gateways()->get_gateway_by_id( $gateway_id );
return true;
}
/**
* Validates the order.
*
* Ensures the submitted order key is valid and that the order can be confirmed.
*
* @since 7.0.0
*
* @return boolean|WP_Error Returns `true` on success or an error object.
*/
protected function validate_order() {
$order_id = $this->get_order_id();
if ( 'new' === $order_id || 'llms_order' !== get_post_type( $order_id ) ) {
return $this->error(
self::E_ORDER_NOT_FOUND,
__( 'Could not locate an order to confirm.', 'lifterlms' )
);
}
$order = llms_get_post( $order_id );
if ( ! $order->can_be_confirmed() ) {
return $this->error(
self::E_ORDER_NOT_CONFIRMABLE,
__( 'Could not locate an order to confirm.', 'lifterlms' )
);
}
$this->order = $order;
return true;
}
/**
* Validates the access plan.
*
* Ensures the access plan data was submitted and that it's a valid plan.
*
* @since 7.0.0
*
* @return boolean|WP_Error Returns `true` on success or an error object.
*/
protected function validate_plan() {
$plan_id = $this->data['llms_plan_id'] ?? null;
if ( ! $plan_id ) {
return $this->error( self::E_PLAN_REQUIRED, __( 'Missing access plan ID.', 'lifterlms' ) );
}
$plan = llms_get_post( $plan_id );
if ( ! $plan || 'llms_access_plan' !== $plan->get( 'type' ) ) {
return $this->error( self::E_PLAN_NOT_FOUND, __( 'Access plan not found.', 'lifterlms' ) );
}
$this->plan = $plan;
return true;
}
/**
* Validates the site's terms and conditions were submitted.
*
* @since 7.0.0
*
* @return boolean|WP_Error Returns `true` on success or an error object.
*/
protected function validate_terms() {
if ( llms_are_terms_and_conditions_required() && ! llms_parse_bool( $this->data['llms_agree_to_terms'] ?? 'no' ) ) {
return $this->error(
self::E_SITE_TERMS,
sprintf(
// Translators: %s = The title of the site's LifterLMS Terms and Conditions page.
__( 'You must agree to the %s.', 'lifterlms' ),
get_the_title( get_option( 'lifterlms_terms_page_id' ) )
)
);
}
return true;
}
/**
* Validates the submitted user data.
*
* @since 7.0.0
*
* @return boolean|WP_Error Returns `true` on success or an error object.
*/
protected function validate_user() {
$validate = llms_validate_user( $this->data );
if ( is_wp_error( $validate ) ) {
return $validate;
}
// If validation passes, determine if the user already exists and, if they do, validate their enrollment.
$email = $this->data['email_address'] ?? null;
$user = $email ? get_user_by( 'email', $email ) : false;
if ( $user && llms_is_user_enrolled( $user->ID, $this->plan->get( 'product_id' ) ) ) {
return $this->error(
self::E_USER_ENROLLED,
sprintf(
// Translators: %s = The title of the course or membership.
__( 'You already have access to %s.', 'lifterlms' ),
get_the_title( $this->plan->get( 'product_id' ) )
)
);
}
return true;
}
}
================================================
FILE: includes/class-llms-prevent-concurrent-logins.php
================================================
<?php
/**
* LLMS_Prevent_Concurrent_Logins class file
*
* @package LifterLMS/Classes
*
* @since 5.6.0
* @version 5.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Prevent_Concurrent_Logins class.
*
* @since 5.6.0
*/
class LLMS_Prevent_Concurrent_Logins {
use LLMS_Trait_Singleton;
/**
* Array of sessions for the current user.
*
* @var array
*/
private $user_sessions;
/**
* Current user ID.
*
* @var int
*/
private $user_id;
/**
* Private Constructor.
*
* @since 5.6.0
*
* @return void
*/
private function __construct() {
if ( llms_parse_bool( get_option( 'lifterlms_prevent_concurrent_logins', 'no' ) ) &&
! empty( get_option( 'lifterlms_prevent_concurrent_logins_roles', array( 'student' ) ) ) ) {
add_action( 'init', array( $this, 'init' ) );
add_action( 'init', array( $this, 'maybe_prevent_concurrent_logins' ) );
}
}
/**
* Initialize.
*
* @since 5.6.0
*
* @return void
*/
public function init() {
$this->user_id = get_current_user_id();
if ( empty( $this->user_id ) ) {
return;
}
$this->user_sessions = wp_get_all_sessions();
}
/**
* Maybe prevent current logins.
*
* @since 5.6.0
*
* @return bool `true` if concurrent login prevented, `false` otherwise.
*/
public function maybe_prevent_concurrent_logins() {
// No logged in user or current user has only one active session: nothing to do.
if ( empty( $this->user_sessions ) || count( $this->user_sessions ) < 2 ) {
return false;
}
/**
* Filters whether or not allowing a specific user to have concurrent sessions.
*
* @since 5.6.0
*
* @param bool $allow Whether or not the user should be allowed to have concurrent sessions.
* @param int $user_id WP_User ID of the current use.
*/
if ( (bool) apply_filters( 'llms_allow_user_concurrent_logins', false, $this->user_id ) ) {
return false;
}
// Current user doesn't have any restricted role: nothing to do.
if ( empty( array_intersect( get_userdata( $this->user_id )->roles, (array) get_option( 'lifterlms_prevent_concurrent_logins_roles', array( 'student' ) ) ) ) ) {
return false;
}
$this->destroy_all_sessions_but_newest();
return true;
}
/**
* Prevent login by destroying all the user's sessions but the newest.
*
* @since 5.6.0
*
* @return int 1 if the kept session is the current one, 0 otherwise.
*/
private function destroy_all_sessions_but_newest() {
$is_current_session_newest_session = $this->current_user_newest_session_login_time() === $this->current_user_current_session_login_time();
$is_current_session_newest_session
?
wp_destroy_other_sessions()
:
wp_destroy_current_session();
return (int) $is_current_session_newest_session;
}
/**
* Retrieve current session for the current user.
*
* @since 5.6.0
*
* @return int
*/
private function current_user_current_session_login_time() {
$sessions = WP_Session_Tokens::get_instance( $this->user_id );
return $sessions->get( wp_get_session_token() )['login'];
}
/**
* Retrieve newest session login time for the current user.
*
* The bigger the login time is the newest the session is.
*
* @since 5.6.0
*
* @return int
*/
private function current_user_newest_session_login_time() {
return max( array_column( $this->user_sessions, 'login' ) );
}
}
return LLMS_Prevent_Concurrent_Logins::instance();
================================================
FILE: includes/class-llms-rest-fields.php
================================================
<?php
/**
* LLMS_Rest_Fields class
*
* @package LifterLMS/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Registers REST fields used by LifterLMS objects.
*
* @since 6.0.0
*/
class LLMS_REST_Fields {
/**
* Constructor
*
* @since 6.0.0
*
* @return void
*/
public function __construct() {
add_action( 'rest_api_init', array( $this, 'register' ) );
add_filter( 'rest_prepare_llms_my_certificate', array( $this, 'remove_author_assign_link' ) );
}
/**
* Retrieves an array of data used to register fields for certificates.
*
* @since 6.0.0
*
* @return array
*/
private function get_fields_for_certificates() {
return array(
'size' => array(
'description' => __( 'Certificate size.', 'lifterlms' ),
'type' => 'string',
'enum' => array_merge(
array_keys( llms_get_certificate_sizes() ),
array( 'CUSTOM' )
),
),
'width' => array(
'description' => __( 'Certificate width.', 'lifterlms' ),
'type' => 'number',
),
'height' => array(
'description' => __( 'Certificate height.', 'lifterlms' ),
'type' => 'number',
),
'unit' => array(
'description' => __( 'Certificate sizing unit applied to the width and height properties.', 'lifterlms' ),
'type' => 'string',
'enum' => array_keys( llms_get_certificate_units() ),
),
'orientation' => array(
'description' => __( 'Certificate orientation.', 'lifterlms' ),
'type' => 'string',
'enum' => array_keys( llms_get_certificate_orientations() ),
),
'margins' => array(
'description' => __( 'Certificate margins.', 'lifterlms' ),
'type' => 'array',
'minItems' => 4,
'maxItems' => 4,
'items' => array(
'type' => 'number',
),
),
'background' => array(
'description' => __( 'Certificate background color.', 'lifterlms' ),
'type' => 'string',
),
);
}
/**
* Register the REST fields.
*
* @since 6.0.0
*
* @return void
*/
public function register() {
if ( llms_is_block_editor_supported_for_certificates() ) {
$this->register_fields_for_certificates();
$this->register_fields_for_certificate_awards();
$this->register_fields_for_certificate_templates();
$this->register_fields_for_attachments();
}
}
/**
* Register fields for attachments.
*
* @since 9.0.0
*
* @return void
*/
private function register_fields_for_attachments() {
register_rest_field(
'attachment',
'_llms_media_protection_product_id',
array(
'get_callback' => function ( $object ) {
return get_post_meta( $object['id'], '_llms_media_protection_product_id', true );
},
'update_callback' => function ( $value, $object ) {
$settings = new LLMS_Admin_Media_Protection_Attachment_Settings();
$protector = new LLMS_Media_Protector();
if ( $protector->is_media_protected( $object->ID ) ) {
update_post_meta( $object->ID, '_llms_media_protection_product_id', absint( $value ) );
return;
}
if ( $settings->move_attachment_to_protected_dir( $object->ID ) ) {
update_post_meta( $object->ID, '_llms_media_protection_product_id', absint( $value ) );
}
},
'schema' => array(
'description' => __( 'The ID of the product that protects this media.', 'lifterlms' ),
'type' => 'integer',
'context' => array( 'view', 'edit' ),
),
)
);
}
/**
* Register rest fields used for awarded certificates.
*
* @since 6.0.0
*
* @return void
*/
private function register_fields_for_certificate_awards() {
register_rest_field(
'llms_my_certificate',
'certificate_template',
array(
'schema' => array(
'description' => __( 'Certificate template ID.', 'lifterlms' ),
'type' => 'integer',
'arg_options' => array(
'validate_callback' => function ( $value ) {
return ! $value || 'llms_certificate' === get_post_type( $value );
},
),
),
'get_callback' => function ( $object ) {
return wp_get_post_parent_id( $object['id'] );
},
'update_callback' => function ( $value, $post ) {
$update = array(
'ID' => $post->ID,
'post_parent' => $value,
);
return wp_update_post( $update );
},
)
);
}
/**
* Register rest fields used for certificate templates.
*
* @since 6.0.0
*
* @return void
*/
private function register_fields_for_certificate_templates() {
register_rest_field(
'llms_certificate',
'certificate_title',
array(
'schema' => array(
'description' => __( 'Certificate title.', 'lifterlms' ),
'type' => 'string',
),
'get_callback' => function ( $object ) {
$cert = llms_get_certificate( $object['id'], true );
return $cert ? $cert->get( 'certificate_title' ) : null;
},
'update_callback' => function ( $value, $post ) {
$cert = llms_get_certificate( $post->ID, true );
return $cert ? $cert->set( 'certificate_title', $value ) : null;
},
)
);
register_rest_field(
'llms_certificate',
'certificate_sequential_id',
array(
'schema' => array(
'description' => __( 'Next sequential ID.', 'lifterlms' ),
'type' => 'integer',
'arg_options' => array(
'validate_callback' => function ( $value, $request ) {
return (int) $value >= llms_get_certificate_sequential_id( $request['id'] );
},
),
),
'get_callback' => function ( $object ) {
return llms_get_certificate_sequential_id( $object['id'] );
},
'update_callback' => function ( $value, $post ) {
$cert = llms_get_certificate( $post->ID, true );
return $cert ? $cert->set( 'sequential_id', $value ) : null;
},
)
);
}
/**
* Register fields for template and earned certificates.
*
* @since 6.0.0
*
* @return void
*/
private function register_fields_for_certificates() {
foreach ( $this->get_fields_for_certificates() as $key => $schema ) {
$schema['context'] = array( 'view', 'edit' );
register_rest_field(
array( 'llms_certificate', 'llms_my_certificate' ),
"certificate_{$key}",
array(
'schema' => $schema,
'get_callback' => function ( $object ) use ( $key ) {
$cert = llms_get_certificate( $object['id'], true );
$func = "get_{$key}";
return $cert ? $cert->$func() : null;
},
'update_callback' => function ( $value, $post ) use ( $key ) {
$cert = llms_get_certificate( $post->ID, true );
return $cert ? $cert->set( $key, $value ) : null;
},
)
);
}
}
/**
* Remove the author assign action link for llms_my_certificate REST responses.
*
* This is a hack put in place to prevent the default <PostAuthor> control component
* cannot be disabled in any other way I can find, the check in place on it determines
* if the control can be displayed based on the presence of this link in the REST response.
*
* Removing this probably isn't generally idea but I cannot conceive of any other way to handle this.
*
* @since 6.0.0
*
* @link https://github.com/WordPress/gutenberg/tree/trunk/packages/editor/src/components/post-author
*
* @param WP_REST_Response $res Rest response.
* @return WP_REST_Response
*/
public function remove_author_assign_link( $res ) {
$res->remove_link( 'https://api.w.org/action-assign-author' );
return $res;
}
}
return new LLMS_REST_Fields();
================================================
FILE: includes/class-llms-sessions.php
================================================
<?php
/**
* User event session management
*
* @package LifterLMS/Classes
*
* @since 3.36.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Sessions class.
*
* @since 3.36.0
* @since 3.37.2 Add filter `llms_sessions_end_idle_cron_recurrence` to allow customization of the recurrence of the idle session cleanup cronjob.
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
* @since 6.0.0 Removed the deprecated `LLMS_Sessions::$_instance` property.
*/
class LLMS_Sessions {
use LLMS_Trait_Singleton;
/**
* Current user id.
*
* @var null
*/
protected $user_id = null;
/**
* Private Constructor.
*
* @since 3.36.0
* @since 3.37.2 Add filter to the cleanup cronjob interval.
*
* @return void
*/
private function __construct() {
add_filter( 'cron_schedules', array( $this, 'add_cron_schedule' ) );
if ( ! wp_next_scheduled( 'llms_end_idle_sessions' ) ) {
/**
* Filter the recurrence interval at which LifterLMS closes idle sessions.
*
* @link https://developer.wordpress.org/reference/functions/wp_get_schedules/
*
* @since 3.37.2
*
* @param string $recurrence Cron job recurrence interval. Must be valid interval as retrieved from `wp_get_schedules()`. Default is "every_five_mins".
*/
$recurrence = apply_filters( 'llms_sessions_end_idle_cron_recurrence', 'every_five_mins' );
wp_schedule_event( time(), $recurrence, 'llms_end_idle_sessions' );
}
add_action( 'llms_end_idle_sessions', array( $this, 'end_idle_sessions' ) );
}
/**
* Add cron schedule for session end interval checks.
*
* @since 3.36.0
*
* @param array $schedules Array of cron schedules.
* @return array
*/
public function add_cron_schedule( $schedules ) {
// Adds every 5 minutes to the existing schedules.
$schedules['every_five_mins'] = array(
'interval' => MINUTE_IN_SECONDS * 5,
'display' => sprintf( __( 'Every %d Minutes', 'lifterlms' ), 5 ),
);
return $schedules;
}
/**
* End the 50 oldest idle sessions.
*
* @since 3.36.0
*
* @return void
*/
public function end_idle_sessions() {
foreach ( $this->get_open_sessions() as $i => $event ) {
if ( $this->is_session_idle( $event ) ) {
$this->end( $event );
}
}
}
/**
* End a session.
*
* @since 3.36.0
* @since 4.5.0 Delete open session entry from the `wp_lifterlms_events_open_sessions` table.
*
* @param LLMS_Event $start Event object for a session start.
* @return LLMS_Event|WP_Error
*/
protected function end( $start ) {
$end = llms()->events()->record(
array(
'actor_id' => $start->get( 'actor_id' ),
'object_type' => 'session',
'object_id' => $start->get( 'object_id' ),
'event_type' => 'session',
'event_action' => 'end',
)
);
if ( ! is_wp_error( $end ) ) {
global $wpdb;
$wpdb->query(
$wpdb->prepare(
"
DELETE FROM {$wpdb->prefix}lifterlms_events_open_sessions
WHERE `event_id` = %d
",
$start->get( 'id' )
)
); // db call ok; no-cache ok.
}
return $end;
}
/**
* Ends the currently active session for the logged in user.
*
* @since 3.36.0
*
* @return LLMS_Event|WP_Error|false
*/
public function end_current() {
$current = $this->get_current();
if ( ! $current ) {
return false;
}
return $this->end( $current );
}
/**
* Retrieve the current session start event record for a given user.
*
* @since 3.36.0
* @since 4.5.0 Added optional `$user_id` parameter.
*
* @param int $user_id Optional. WP_User ID of a student. Default `null`
* If not provided, or a falsy is provided, will fall back on the current user id.
* @return LLMS_Event|false
*/
public function get_current( $user_id = null ) {
$user_id = $user_id ? $user_id : get_current_user_id();
if ( ! $user_id ) {
return false;
}
$session = $this->get_last_session( $user_id );
if ( ! $session ) {
return false;
}
$session = new LLMS_Event( $session->id );
if ( ! $this->is_session_open( $session ) ) {
return false;
}
return $session;
}
/**
* Determine if a session is idle.
*
* A session is considered idle if it's open and no new events have been recorded
* in the last 30 minutes.
*
* @since 3.36.0
* @since 4.7.0 When retrieving the last event, instantiate the events query passing `no_found_rows` arg as `true`,
* to improve performance.
*
* @param LLMS_Event $start Event record for the start of the session.
* @return bool
*/
public function is_session_idle( $start ) {
// Session is closed so it can't be idle.
if ( ! $this->is_session_open( $start ) ) {
return false;
}
$now = llms_current_time( 'timestamp' );
/**
* Filter the time (in minutes) to allow a session to remain open before it's considered an "idle" session.
*
* @param int $minutes Number of minutes.
*/
$timeout = absint( apply_filters( 'llms_idle_session_timeout', 30 ) ) * MINUTE_IN_SECONDS;
// Session has started within the idle window, so it can't have expired yet.
if ( ( $now - strtotime( $start->get( 'date' ) ) ) < $timeout ) {
return false;
}
$events = $this->get_session_events(
$start,
array(
'per_page' => 1,
'sort' => array(
'date' => 'DESC',
),
'no_found_rows' => true,
)
);
// No events, the session is idle.
if ( ! $events ) {
return true;
}
$last_event = array_shift( $events );
return ( ( $now - strtotime( $last_event->get( 'date' ) ) ) > $timeout );
}
/**
* Determines if the given session is open (has not ended)
*
* @since 3.36.0
*
* @param LLMS_Event Event record for the start of the session.
* @return bool
*/
public function is_session_open( $start ) {
return is_null( $this->get_session_end( $start ) );
}
/**
* Retrieve the last session object for the current user.
*
* @since 3.36.0
* @since 4.5.0 Added optional `$user_id` parameter.
*
* @param int $user_id Optional. WP_User ID of a student. Default `null`
* If not provided, or a falsy is provided, will fall back on the current user id.
* @return obj|null
*/
protected function get_last_session( $user_id = null ) {
$user_id = $user_id ? $user_id : get_current_user_id();
global $wpdb;
return $wpdb->get_row(
$wpdb->prepare(
"SELECT *
FROM {$wpdb->prefix}lifterlms_events
WHERE actor_id = %d
AND object_type = 'session'
AND event_type = 'session'
AND event_action = 'start'
ORDER BY date DESC
LIMIT 1;",
$user_id
)
); // db call ok; no-cache ok.
}
/**
* Retrieve open sessions.
*
* @since 3.36.0
* @since 4.5.0 Retrieve open sessions from the `wp_lifterlms_events_open_sessions` table.
*
* @param int $limit Number of sessions to return.
* @param int $skip Number of sessions to skip.
* @return LLMS_Event[]
*/
protected function get_open_sessions( $limit = 50, $skip = 0 ) {
global $wpdb;
$sessions = $wpdb->get_col(
$wpdb->prepare(
"
SELECT event_id
FROM {$wpdb->prefix}lifterlms_events_open_sessions
ORDER BY event_id ASC
LIMIT %d, %d
",
$skip,
$limit
)
); // db call ok; no-cache ok.
$ret = array();
if ( count( $sessions ) ) {
foreach ( $sessions as $id ) {
$ret[] = new LLMS_Event( $id );
}
}
return $ret;
}
/**
* Retrieve an array of events which occurred during a session.
*
* @since 3.36.0
*
* @param LLMS_Event $start Event record for the session.start event.
* @param array $args Array of additional arguments to pass to the LLMS_Events_Query.
* @return LLMS_Event[]
*/
public function get_session_events( $start, $args = array() ) {
$end = $this->get_session_end( $start );
$args = wp_parse_args(
$args,
array(
'date_after' => $start->get( 'date' ),
'exclude' => array( $start->get( 'id' ) ),
'actor' => $start->get( 'actor_id' ),
'sort' => array(
'date' => 'ASC',
),
'per_page' => 10,
)
);
if ( $end ) {
$args['date_before'] = $end->get( 'date' );
$args['exclude'][] = $end->get( 'id' );
}
$args['no_found_rows'] = true;
$query = new LLMS_Events_Query( $args );
return $query->get_events();
}
/**
* Retrieve session end record for by session id.
*
* @since 3.36.0
*
* @param LLMS_Event $start Event record for the session.start event.
* @return LLMS_Event|end
*/
public function get_session_end( $start ) {
global $wpdb;
$end = $wpdb->get_var(
$wpdb->prepare(
"SELECT id
FROM {$wpdb->prefix}lifterlms_events
WHERE actor_id = %d
AND object_id = %d
AND object_type = 'session'
AND event_type = 'session'
AND event_action = 'end'
ORDER BY date DESC
LIMIT 1;",
$start->get( 'actor_id' ),
$start->get( 'object_id' )
)
); // db call ok; no-cache ok.
if ( ! $end ) {
return null;
}
return new LLMS_Event( $end );
}
/**
* Retrieve a new session ID.
*
* @since 3.36.0
* @since 4.5.0 Added optional `$user_id` parameter.
*
* @param int $user_id Optional. WP_User ID of a student. Default `null`
* If not provided, or a falsy is provided, will fall back on the current user id.
* @return int
*/
protected function get_new_id( $user_id = null ) {
$user_id = $user_id ? $user_id : get_current_user_id();
$last = $this->get_last_session( $user_id );
if ( ! $last ) {
return 1;
}
return ++$last->object_id;
}
/**
* Start a new session for the current user.
*
* @since 3.36.0
* @since 4.5.0 Create open session entry in the `wp_lifterlms_events_open_sessions` table.
* Added optional `$user_id` parameter.
*
* @param int $user_id Optional. WP_User ID of a student. Default `null`
* If not provided, or a falsy is provided, will fall back on the current user id.
* @return false|LLMS_Event|WP_Error
*/
public function start( $user_id = null ) {
$user_id = $user_id ? $user_id : get_current_user_id();
if ( ! $user_id ) {
return false;
}
$start = llms()->events()->record(
array(
'actor_id' => $user_id,
'object_type' => 'session',
'object_id' => $this->get_new_id( $user_id ),
'event_type' => 'session',
'event_action' => 'start',
)
);
if ( ! is_wp_error( $start ) ) {
global $wpdb;
$wpdb->query( // db call ok; no-cache ok.
$wpdb->prepare(
"
INSERT INTO {$wpdb->prefix}lifterlms_events_open_sessions ( `event_id` ) VALUES ( %d )
",
$start->get( 'id' )
)
);
}
return $start;
}
}
return LLMS_Sessions::instance();
================================================
FILE: includes/class-llms-staging.php
================================================
<?php
/**
* Handle warnings and notices when staging is enabled.
*
* @package LifterLMS/Classes
*
* @since 3.32.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Staging class.
*
* @since 3.32.0
*/
class LLMS_Staging {
/**
* Static Constructor.
*
* @since 3.32.0
* @since 4.12.0 Add hook on `llms_site_clone_detected` action.
* @since 4.13.0 Only add actions when recurring payments constant is not defined.
* If `LLMS_SITE_IS_CLONE` is defined & true, automatically disable recurring payments.
*
* @return void
*/
public static function init() {
if ( defined( 'LLMS_SITE_IS_CLONE' ) && LLMS_SITE_IS_CLONE ) {
llms_maybe_define_constant( 'LLMS_SITE_FEATURE_RECURRING_PAYMENTS', false );
}
if ( ! defined( 'LLMS_SITE_FEATURE_RECURRING_PAYMENTS' ) ) {
add_action( 'llms_site_clone_detected', array( __CLASS__, 'clone_detected' ) );
add_action( 'admin_init', array( __CLASS__, 'handle_staging_notice_actions' ) );
}
add_action( 'admin_menu', array( __CLASS__, 'menu_warning' ) );
}
/**
* Callback function to automatically disable site features when a clone is detected
*
* @since 4.12.0
* @since 4.13.0 Only disable payments for logged in users on the admin panel when not processing ajax requests.
*
* @return void
*/
public static function clone_detected() {
if ( is_admin() && current_user_can( 'manage_lifterlms' ) && ! wp_doing_ajax() ) {
self::notice();
LLMS_Site::update_feature( 'recurring_payments', false );
}
}
/**
* Retrieves the HTML for the "warning bubble" displayed in the admin menu when staging mode is active
*
* @since 4.12.0
*
* @return string
*/
protected static function get_menu_warning_bubble() {
return ' <span class="update-plugins">' . esc_html__( 'Staging', 'lifterlms' ) . '</span>';
}
/**
* Handle the action buttons present in the recurring payments staging notice.
*
* @since 3.32.0
* @since 3.35.0 Sanitize input data.
* @since 4.12.0 Use `llms_filter_input()` for retrieval of `$_GET` data.
* @since 5.9.0 Drop usage of deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public static function handle_staging_notice_actions() {
if ( ! isset( $_GET['llms-staging-status'] ) || ! isset( $_GET['_llms_staging_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_GET['_llms_staging_nonce'] ) ), 'llms_staging_status' ) || ! current_user_can( 'manage_options' ) ) {
wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'lifterlms' ) );
}
$action = llms_filter_input( INPUT_GET, 'llms-staging-status' );
if ( 'enable' === $action ) {
LLMS_Site::set_lock_url();
LLMS_Site::update_feature( 'recurring_payments', true );
} elseif ( 'disable' === $action ) {
LLMS_Site::clear_lock_url();
LLMS_Site::update_feature( 'recurring_payments', false );
update_option( 'llms_site_url_ignore', 'yes' );
}
LLMS_Admin_Notices::delete_notice( 'maybe-staging' );
if ( ! empty( $_SERVER['HTTP_REFERER'] ) ) {
llms_redirect_and_exit( sanitize_text_field( wp_unslash( $_SERVER['HTTP_REFERER'] ) ) );
}
}
/**
* Adds a "bubble" to the "Orders" menu item when recurring payments are disabled.
*
* @since 3.32.0
* @since 4.12.0 Moved HTML for the warning bubble into it's own method.
*
* @return void
*/
public static function menu_warning() {
if ( LLMS_Site::get_feature( 'recurring_payments' ) ) {
return;
}
global $menu;
foreach ( $menu as $index => $item ) {
if ( 'edit.php?post_type=llms_order' === $item[2] ) {
$menu[ $index ][0] .= self::get_menu_warning_bubble();
}
}
}
/**
* Output a notice informing the user the site was put into staging mode.
*
* @since 4.12.0
*
* @return void
*/
public static function notice() {
$id = 'maybe-staging';
if ( ! LLMS_Admin_Notices::has_notice( $id ) ) {
LLMS_Admin_Notices::add_notice(
$id,
array(
'type' => 'info',
'dismissible' => false,
'remindable' => false,
'template' => 'admin/notices/staging.php',
)
);
}
}
}
return LLMS_Staging::init();
================================================
FILE: includes/class.llms.achievement.php
================================================
<?php
/**
* Base Achievement Class
*
* Handles generating Achievement
*
* @package LifterLMS/Classes/Achievements
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Base Achievement Class
*
* @since 1.0.0
* @since 3.30.3 Explicitly define class properties.
* @deprecated 6.0.0 Class `LLMS_Achievement` is deprecated with no direct replacement.
*/
class LLMS_Achievement {
/**
* @var int
* @since 1.0.0
*/
public $achievement_template_id;
/**
* @var string
* @since 1.0.0
*/
public $achievement_title;
/**
* @var string
* @since 1.0.0
*/
public $content;
/**
* is the achievement enabled
*
* @var bool
* @since 1.0.0
*/
public $enabled;
/**
* @var array
* @since 1.0.0
*/
public $find = array();
/**
* @var string
* @since 1.0.0
*/
public $id;
/**
* image id
*
* @var int
* @since 1.0.0
*/
public $image;
/**
* @var int
* @since 1.0.0
*/
public $lesson_id;
/**
* @var WP_User
* @since 1.0.0
*/
public $object;
/**
* @var array
* @since 1.0.0
*/
public $replace = array();
/**
* post title
*
* @var string
* @since 1.0.0
*/
public $title;
/**
* @var int
* @since 1.0.0
*/
public $userid;
/**
* Alert when deprecated methods are used.
*
* This class as well as core classes extending it have been deprecated. All public and protected methods
* have been changed to private and will be made accessible through this magic method which also emits a
* deprecation warning.
*
* This public method has been intentionally marked as private to denote it's temporary lifespan. It will be
* removed alongside this class in the next major release.
*
* @since 6.0.0
*
* @access private
*
* @param string $name Name of the method being called.
* @param array $args Arguments provided to the method.
* @return void
*/
public function __call( $name, $args ) {
_deprecated_function( __CLASS__ . '::' . esc_html( $name ), '6.0.0' );
if ( method_exists( $this, $name ) ) {
$this->$name( ...$args );
}
}
/**
* Constructor.
*
* @since Unknown.
* @deprecated 6.0.0 `LLMS_Achievement::__construct()` is deprecated with no replacement.
*/
public function __construct() {
// Settings TODO Refactor: theses can come from the achievement post now.
$this->enabled = get_option( 'enabled' );
$this->find = array( '{blogname}', '{site_title}' );
$this->replace = array( $this->get_blogname(), $this->get_blogname() );
}
/**
* Checks if achievement is enabled
*
* @since Unknown
* @since 3.24.0 Unknown.
* @deprecated 6.0.0 `LLMS_Achievement::is_enabled()` is deprecated with no replacement.
*
* @return bool
*/
private function is_enabled() {
$enabled = 'yes' == $this->enabled ? true : false;
return true;
}
/**
* Get Blog name
*
* Used by achievement merge fields.
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Achievement::get_blogname()` is deprecated with no replacement.
*
* @return string
*/
private function get_blogname() {
return wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
}
/**
* Format String
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Achievement::format_string()` is deprecated with no replacement.
*
* @param string $string Un-formatted string.
* @return string Formatted string.
*/
private function format_string( $string ) {
return str_replace( $this->find, $this->replace, $string );
}
/**
* Queries Achievement title postmeta
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Achievement::get_title()` is deprecated with no replacement.
*
* @return string
*/
private function get_title() {
return apply_filters( '_llms_achievement_title' . $this->id, $this->title, $this->object );
}
/**
* Get the content of the Achievement
*
* @since 1.0.0
* @version 1.4.1
* @deprecated 6.0.0 `LLMS_Achievement::get_content()` is deprecated with no replacement.
*
* @return string Data needed to generate achievement.
*/
private function get_content() {
$achievement_content = $this->content;
return $achievement_content;
}
/**
* Generate HTML output of achievement.
*
* Converts merge fields to raw data sources and wraps content in HTML
* then saves new achievement post and updates user_postmeta table.
*
* @since 1.0.0
* @deprecated 6.0.0 `LLMS_Achievement::get_content_html()` is deprecated with no replacement.
*
* @return void
*/
private function get_content_html() {}
/**
* Create the achievement
*
* @since 1.0.0
* @since 3.8.0 Unknown
* @deprecated 6.0.0 `LLMS_Achievement::create()` is deprecated with no replacement.
*
* @param string $content Achievement body content.
* @return void
*/
private function create( $content ) {
global $wpdb;
$new_user_achievement = apply_filters(
'lifterlms_new_achievement',
array(
'post_type' => 'llms_my_achievement',
'post_title' => $this->title,
'post_content' => $content,
'post_status' => 'publish',
'post_author' => 1,
)
);
$new_user_achievement_id = wp_insert_post( $new_user_achievement, true );
update_post_meta( $new_user_achievement_id, '_llms_achievement_title', $this->achievement_title );
update_post_meta( $new_user_achievement_id, '_llms_achievement_image', $this->image );
update_post_meta( $new_user_achievement_id, '_llms_achievement_content', $this->content );
update_post_meta( $new_user_achievement_id, '_llms_achievement_template', $this->achievement_template_id );
$user_metadatas = array(
'_achievement_earned' => $new_user_achievement_id,
);
foreach ( $user_metadatas as $key => $value ) {
$update_user_postmeta = $wpdb->insert(
$wpdb->prefix . 'lifterlms_user_postmeta',
array(
'user_id' => $this->userid,
'post_id' => $this->lesson_id,
'meta_key' => $key,
'meta_value' => $value,
'updated_date' => current_time( 'mysql' ),
)
);
}
// This hook is documented in includes/class-llms-engagement-handler.php.
do_action( 'llms_user_earned_achievement', $this->userid, $new_user_achievement_id, $this->lesson_id );
}
}
================================================
FILE: includes/class.llms.achievements.php
================================================
<?php
/**
* Achievements Base Class
*
* @package LifterLMS/Classes/Achievements
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Main Achievements singleton
*
* @see llms()->achievements()
*
* @since 1.0.0
* @since 3.24.0 Unknown.
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
* @since 6.0.0 Changes:
* - Deprecated the unused public class property `LLMS_Achievements::$content` with no replacement.
* - Deprecated the `LLMS_Achievements::trigger_engagement()` method.
* Use the {@see LLMS_Engagement_Handler::handle_achievement()} method instead.
* - Removed the unused private `LLMS_Achievements::$_from_address` property.
* - Removed the unused private `LLMS_Achievements::$_from_name` property.
* - Removed the unused private `LLMS_Achievements::$_content_type` property.
* - Removed the deprecated `LLMS_Achievements::$_instance` property.
*/
class LLMS_Achievements {
use LLMS_Trait_Singleton,
LLMS_Trait_Award_Default_Images;
/**
* List of available achievement types.
*
* @var array
*/
public $achievements = array();
/**
* The ID for the award type.
*
* Used by {@see LLMS_Trait_Award_Default_Images}.
*
* @var string
*/
protected $award_type = 'achievement';
/**
* Deprecated.
*
* @deprecated 6.0.0 Unused public class property `LLMS_Achievements::$content` is deprecated with no replacement.
*
* @var null
*/
public $content;
/**
* Constructor.
*
* @since 1.0.0
* @since 3.24.0 Unknown.
*
* @return void
*/
private function __construct() {
$this->init();
}
/**
* Includes achievement class.
*
* @since 1.0.0
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
public function init() {
$this->achievements['LLMS_Achievement_User'] = include_once 'achievements/class.llms.achievement.user.php';
}
/**
* Get a list of achievement Achievement Template IDs for a given post.
*
* @since 3.24.0
* @since 5.3.3 Set the query limit to 500.
*
* @param array|int $post_ids Post IDs or single post ID to look for achievements by.
* @param bool $include_children If true, will include course children (sections, lessons, and quizzes).
* @return array
*/
public function get_achievements_by_post( $post_ids, $include_children = true ) {
if ( ! is_array( $post_ids ) ) {
$post_ids = array( $post_ids );
}
$original_post_ids = $post_ids;
if ( $include_children ) {
foreach ( $post_ids as $post_id ) {
if ( 'course' === get_post_type( $post_id ) ) {
$course = llms_get_post( $post_id );
$post_ids = array_merge(
$post_ids,
$course->get_sections( 'ids' ),
$course->get_lessons( 'ids' ),
$course->get_quizzes()
);
}
}
}
/**
* Filters the query args to retrieve the achievements by post.
*
* @since 5.3.3
*
* @param array $args The query args to retrieve the achievements by post.
* @param array|int $post_ids Post IDs or single post ID to look for achievements by.
* @param bool $include_children If true, will include course children (sections, lessons, and quizzes).
*/
$query_args = apply_filters(
'llms_achievements_by_post_query_args',
array(
'post_type' => 'llms_engagement',
'meta_query' => array(
array(
'key' => '_llms_engagement_type',
'value' => 'achievement',
),
array(
'compare' => 'IN',
'key' => '_llms_engagement_trigger_post',
'value' => $post_ids,
),
),
'posts_per_page' => 500,
),
$original_post_ids,
$include_children
);
$query = new WP_Query( $query_args );
$achievements = array();
foreach ( $query->posts as $engagement ) {
$achievements[] = get_post_meta( $engagement->ID, '_llms_engagement', true );
}
return $achievements;
}
/**
* Award an achievement to a user
*
* Calls trigger method passing arguments.
*
* @since 1.0.0
* @deprecated 6.0.0 `LLMS_Achievements::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement()`.
*
* @param int $person_id WP_User ID.
* @param int $achievement_id WP_Post ID of the achievement template.
* @param int $related_post_id WP_Post ID of the related post, for example a lesson id.
* @return void
*/
public function trigger_engagement( $person_id, $achievement_id, $related_post_id ) {
_deprecated_function( 'LLMS_Achievements::trigger_engagement()', '6.0.0', 'LLMS_Engagement_Handler::handle_achievements()' );
LLMS_Engagement_Handler::handle_achievement( array( $person_id, $achievement_id, $related_post_id, null ) );
}
}
================================================
FILE: includes/class.llms.ajax.handler.php
================================================
<?php
/**
* LifterLMS AJAX Event Handler.
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 7.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_AJAX_Handler class
*
* @since 1.0.0
* @since 3.0.0 Added `bulk_enroll_students()` handler.
* @since 3.2.0 Added `get_admin_table_data()` handler.
* @since 3.4.0 Unknown.
* @since 3.13.0 Added `instructors_mb_store()` handler.
* @since 3.15.0 Added `export_admin_table()` handler, and other unknown changes.
* @since 3.28.1 Unknown.
* @since 3.30.0 Added `llms_save_membership_autoenroll_courses` method.
* @since 3.30.3 Fixed spelling errors.
* @since 3.32.0 Update `select2_query_posts` to use llms_filter_input() and allows for querying posts by post status(es).
* @since 3.33.0 Update `update_student_enrollment` to handle enrollment deletion requests, make sure the input array param 'post_id' field is not empty.
* Also always return either a WP_Error on failure or a "success" array on requested action performed.
* @since 3.33.1 Update `llms_update_access_plans` to use `wp_unslash()` before inserting access plan data.
* @since 3.37.2 Update `select2_query_posts` to allow filtering posts by instructor.
* @since 3.37.14 Added `persist_tracking_events()` handler.
* Used strict comparison where needed.
* @since 3.37.15 Update `get_admin_table_data()` and `export_admin_table()` to verify user permissions before processing data.
* @since 3.39.0 Minor code readability updates to the `validate_coupon_code()` method.
* @since 5.7.0 Deprecated the `LLMS_AJAX_Handler::add_lesson_to_course()` method with no replacement.
* Deprecated the `LLMS_AJAX_Handler::create_lesson()` method with no replacement.
* Deprecated the `LLMS_AJAX_Handler::create_section()` method with no replacement.
*/
class LLMS_AJAX_Handler {
/**
* Queue all members of a membership to be enrolled into a specific course
*
* Triggered from the auto-enrollment tab of a membership.
*
* @since 3.4.0
* @since 3.15.0 Unknown.
*
* @param array $request Array of request data.
* @return array
*/
public static function bulk_enroll_membership_into_course( $request ) {
if ( ! current_user_can( 'manage_lifterlms' ) ) {
wp_die();
}
if ( empty( $request['post_id'] ) || empty( $request['course_id'] ) ) {
return new WP_Error( 400, __( 'Missing required parameters', 'lifterlms' ) );
}
do_action( 'llms_membership_do_bulk_course_enrollment', $request['post_id'], $request['course_id'] );
return array(
'message' => __( 'Members are being enrolled in the background. You may leave this page.', 'lifterlms' ),
);
}
/**
* Add or remove a student from a course or membership
*
* @since 3.0.0
* @since 3.4.0 Unknown.
*
* @param array $request $_REQUEST object.
* @return (void|WP_Error)
*/
public static function bulk_enroll_students( $request ) {
if ( ! current_user_can( 'manage_lifterlms' ) ) {
wp_die();
}
if ( empty( $request['post_id'] ) || empty( $request['student_ids'] ) || ! is_array( $request['student_ids'] ) ) {
return new WP_Error( 400, __( 'Missing required parameters', 'lifterlms' ) );
}
$post_id = intval( $request['post_id'] );
foreach ( $request['student_ids'] as $id ) {
llms_enroll_student( intval( $id ), $post_id, 'admin_' . get_current_user_id() );
}
}
/**
* Determines if voucher codes already exist.
*
* @since 5.9.0
*
* @return void
*/
public static function check_voucher_duplicate() {
if ( ! current_user_can( 'manage_lifterlms' ) ) {
wp_die();
}
$post_id = ! empty( $_REQUEST['postId'] ) ? absint( llms_filter_input( INPUT_POST, 'postId', FILTER_SANITIZE_NUMBER_INT ) ) : 0;
$codes = ! empty( $_REQUEST['codes'] ) ? llms_filter_input_sanitize_string( INPUT_POST, 'codes', array( FILTER_REQUIRE_ARRAY ) ) : array();
if ( ! $post_id || ! $codes ) {
return new WP_Error( 400, __( 'Missing required parameters', 'lifterlms' ) );
} elseif ( ! current_user_can( 'edit_post', $post_id ) ) {
return new WP_Error( 401, __( 'Missing required permissions to perform this action.', 'lifterlms' ) );
}
$codes = implode(
',',
array_map(
function ( $code ) {
return sprintf( "'%s'", esc_sql( $code ) );
},
array_filter( $codes )
)
);
global $wpdb;
$table = $wpdb->prefix . 'lifterlms_vouchers_codes';
$res = $wpdb->get_results(
$wpdb->prepare(
"SELECT code FROM $table WHERE code IN( $codes ) AND voucher_id != %d", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
array( $post_id )
),
ARRAY_A
);
wp_send_json(
array(
'success' => true,
'duplicates' => $res,
)
);
wp_die();
}
/**
* Move a Product Access Plan to the trash
*
* @since 3.0.0
*
* @param array $request $_REQUEST object.
* @return bool|WP_Error WP_Error on error, true if successful.
*/
public static function delete_access_plan( $request ) {
if ( empty( $request['plan_id'] ) ) {
wp_die();
}
$access_plan = llms_get_post( $request['plan_id'] );
if ( ! $access_plan->get( 'product_id' ) ) {
wp_die();
}
if ( ! llms_current_user_can_edit_product( $access_plan->get( 'product_id' ) ) ) {
wp_die();
}
if ( ! wp_trash_post( $request['plan_id'] ) ) {
$err = new WP_Error();
$err->add( 'error', __( 'There was a problem deleting your access plan, please try again.', 'lifterlms' ) );
return $err;
}
return true;
}
/**
* Retrieve a new instance of admin table class from a handler string.
*
* @since 3.37.15
* @since 4.7.0 Don't require `LLMS_Admin_Reporting`, it's loaded automatically.
*
* @param string $handler Unprefixed handler class string. For example "Students" or "Course_Students".
* @return object|false Instance of the admin table class or false if the class can't be found.
*/
protected static function get_admin_table_instance( $handler ) {
LLMS_Admin_Reporting::includes();
$handler = 'LLMS_Table_' . $handler;
if ( class_exists( $handler ) ) {
return new $handler();
}
return false;
}
/**
* Queue a table export event
*
* @since 3.15.0
* @since 3.28.1 Unknown.
* @since 3.37.15 Verify user permissions before processing request data.
*
* @param array $request Post data ($_REQUEST).
* @return array|bool
*/
public static function export_admin_table( $request ) {
if ( ! current_user_can( 'view_lifterlms_reports' ) || empty( $request['handler'] ) ) {
wp_die();
}
$table = self::get_admin_table_instance( $request['handler'] );
if ( ! $table ) {
wp_die();
}
$file = isset( $request['filename'] ) ? $request['filename'] : null;
return $table->generate_export_file( $request, $file );
}
/**
* Reload admin tables
*
* @since 3.2.0
* @since 3.37.15 Verify user permissions before processing request data.
* Use `wp_json_encode()` in favor of `json_encode()`.
*
* @param array $request Post data ($_REQUEST).
* @return array
*/
public static function get_admin_table_data( $request ) {
if ( ! current_user_can( 'view_lifterlms_reports' ) || empty( $request['handler'] ) ) {
return false;
}
$table = self::get_admin_table_instance( $request['handler'] );
if ( ! $table ) {
return false;
}
$table->get_results( $request );
return array(
'args' => wp_json_encode( $table->get_args() ),
'thead' => trim( $table->get_thead_html() ),
'tbody' => trim( $table->get_tbody_html() ),
'tfoot' => trim( $table->get_tfoot_html() ),
);
}
/**
* Store data for the instructors metabox
*
* @since 3.13.0
* @since 3.30.3 Fixed typos.
*
* @param array $request $_REQUEST object.
* @return array
*/
public static function instructors_mb_store( $request ) {
// validate required params.
if ( ! isset( $request['store_action'] ) ||
! isset( $request['post_id'] ) ) {
wp_die();
}
if ( ! llms_current_user_can_edit_product( $request['post_id'] ) ) {
wp_die();
}
$post = llms_get_post( $request['post_id'] );
switch ( $request['store_action'] ) {
case 'load':
$instructors = $post->get_instructors();
break;
case 'save':
$instructors = array();
foreach ( $request['rows'] as $instructor ) {
foreach ( $instructor as $key => $val ) {
$new_key = str_replace( array( 'llms', '_' ), '', $key );
$new_key = preg_replace( '/[0-9]+/', '', $new_key );
$instructor[ $new_key ] = $val;
unset( $instructor[ $key ] );
}
$instructors[] = $instructor;
}
$post->set_instructors( $instructors );
break;
}
$data = array();
foreach ( $instructors as $instructor ) {
$new_instructor = array();
foreach ( $instructor as $key => $val ) {
if ( 'id' === $key ) {
$val = llms_make_select2_student_array( array( $instructor['id'] ) );
}
$new_instructor[ '_llms_' . $key ] = $val;
}
$data[] = $new_instructor;
}
wp_send_json(
array(
'data' => $data,
'message' => 'success',
'success' => true,
)
);
}
/**
* Handle notification display & dismissal.
*
* @since 3.8.0
* @since 3.37.14 Use strict comparison.
* @since 7.1.0 Improve notifications query performance by not calculating unneeded found rows.
*
* @param array $request $_POST data.
* @return array
*/
public static function notifications_heartbeart( $request ) {
if ( ! is_user_logged_in() ) {
wp_die();
}
$ret = array(
'new' => array(),
);
if ( ! empty( $request['dismissals'] ) ) {
foreach ( $request['dismissals'] as $nid ) {
$noti = new LLMS_Notification( $nid );
if ( get_current_user_id() === absint( $noti->get( 'subscriber' ) ) ) {
$noti->set( 'status', 'read' );
}
}
}
// Get 5 most recent new notifications for the current user.
$query = new LLMS_Notifications_Query(
array(
'per_page' => 5,
'statuses' => 'new',
'types' => 'basic',
'subscriber' => get_current_user_id(),
'no_found_rows' => true,
)
);
$ret['new'] = $query->get_notifications();
return $ret;
}
/**
* Remove a course from the list of membership auto enrollment courses
*
* Called from "Auto Enrollment" tab of LLMS Membership Metaboxes.
*
* @since 3.0.0
*
* @param array $request $_POST data.
* @return (void|WP_Error)
*/
public static function membership_remove_auto_enroll_course( $request ) {
if ( ! current_user_can( 'manage_lifterlms' ) ) {
wp_die();
}
if ( empty( $request['post_id'] ) || empty( $request['course_id'] ) ) {
return new WP_Error( 'error', __( 'Missing required parameters.', 'lifterlms' ) );
}
$membership = new LLMS_Membership( $request['post_id'] );
if ( ! $membership->remove_auto_enroll_course( intval( $request['course_id'] ) ) ) {
return new WP_Error( 'error', __( 'There was an error removing the course, please try again.', 'lifterlms' ) );
}
}
/**
* Start a Quiz Attempt.
*
* @since 3.9.0
* @since 3.16.4 Unknown.
* @since 6.4.0 Make sure attempts limit was not reached.
* @since 7.8.0 Use `$attempt->get( 'status' )` instead of the not existing `$attempt->get_status()` method and added `can_be_resumed` param.
*
* @param array $request $_POST data.
* required:
* (string) attempt_key
* or
* (int) quiz_id
* (int) lesson_id.
* @return WP_Error|array WP_Error on error or array containing html template of the first question.
*/
public static function quiz_start( $request ) {
$err = new WP_Error();
$student = llms_get_student();
if ( ! $student ) {
$err->add( 400, __( 'You must be logged in to take quizzes.', 'lifterlms' ) );
return $err;
}
// Limit reached?
if ( isset( $request['quiz_id'] ) && ! ( new LLMS_Quiz( $request['quiz_id'] ) )->is_open() ) {
$err->add( 400, __( "You've reached the maximum number of attempts for this quiz.", 'lifterlms' ) );
return $err;
}
$attempt = false;
if ( ! empty( $request['attempt_key'] ) ) {
$attempt = $student->quizzes()->get_attempt_by_key( $request['attempt_key'] );
}
if ( ! $attempt || 'new' !== $attempt->get( 'status' ) ) {
if ( ! isset( $request['quiz_id'] ) || ! isset( $request['lesson_id'] ) ) {
$err->add( 400, __( 'There was an error starting the quiz. Please return to the lesson and begin again.', 'lifterlms' ) );
return $err;
}
// Mark the previous attempt as ended if it could be resumed but we're restarting instead.
$previous_attempt_key = ( new LLMS_Quiz( $request['quiz_id'] ) )->get_student_last_attempt_key();
if ( $previous_attempt_key ) {
$previous_attempt = $student->quizzes()->get_attempt_by_key( $previous_attempt_key );
if ( $previous_attempt && $previous_attempt->can_be_resumed() ) {
$previous_attempt->end();
}
}
$attempt = LLMS_Quiz_Attempt::init( absint( $request['quiz_id'] ), absint( $request['lesson_id'] ), $student->get( 'id' ) );
}
$question_id = $attempt->get_first_question();
if ( ! $question_id ) {
$err->add( 404, __( 'Unable to start quiz because the quiz does not contain any questions.', 'lifterlms' ) );
return $err;
}
$attempt->start();
$html = llms_get_template_ajax(
'content-single-question.php',
array(
'attempt' => $attempt,
'question' => llms_get_post( $question_id ),
)
);
$quiz = $attempt->get_quiz();
$limit = $quiz->has_time_limit() && ! $student->has_unlimited_quiz_time() ? $quiz->get( 'time_limit' ) : false;
return array(
'attempt_key' => $attempt->get_key(),
'html' => $html,
'time_limit' => $limit,
'question_id' => $question_id,
'total' => $attempt->get_count( 'questions' ),
'can_be_resumed' => $attempt->can_be_resumed(),
);
}
/**
* Resume a Quiz Attempt.
*
* @since 7.8.0
*
* @param array $request $_POST data.
* required:
* (string) attempt_key
* @return WP_Error|array WP_Error on error or array containing html template of the first question to be answered.
*/
public static function quiz_resume( $request ) {
$err = new WP_Error();
$student = llms_get_student();
if ( ! $student ) {
$err->add( 400, __( 'You must be logged in to take quizzes.', 'lifterlms' ) );
return $err;
}
if ( ! isset( $request['attempt_key'] ) ) {
$err->add( 400, __( 'Attempt key is required.', 'lifterlms' ) );
return $err;
}
$attempt = $student->quizzes()->get_attempt_by_key( $request['attempt_key'] );
if ( empty( $attempt ) ) {
$err->add( 404, __( 'The requested attempt could not be found.', 'lifterlms' ) );
return $err;
}
$quiz = $attempt->get_quiz();
if ( empty( $quiz ) ) {
$err->add( 400, __( 'No quiz found.', 'lifterlms' ) );
return $err;
}
if (
! $attempt->can_be_resumed() ||
! $attempt->is_last_attempt()
) {
$err->add(
400,
__(
'There was an error resuming the quiz. Please return to the lesson and begin again.',
'lifterlms'
)
);
return $err;
}
$question_ids = array_column( $attempt->get_questions(), 'id' );
if ( ! $question_ids ) {
$err->add(
404,
__( 'Unable to resume quiz because the quiz does not contain any questions.', 'lifterlms' )
);
return $err;
}
$question_id = $attempt->get( 'current_question_id' ) ? $attempt->get( 'current_question_id' ) : $attempt->get_next_question( null );
if ( ! $question_id ) {
return self::quiz_end( $request, $attempt );
}
$html = llms_get_template_ajax(
'content-single-question.php',
array(
'attempt' => $attempt,
'question' => llms_get_post( $question_id ),
)
);
return array(
'attempt_key' => $attempt->get_key(),
'html' => $html,
'question_id' => $question_id,
'total' => $attempt->get_count( 'questions' ),
'question_ids' => $question_ids,
'can_be_resumed' => $attempt->can_be_resumed(),
);
}
/**
* AJAX Quiz get question.
*
* @since 7.8.0
*
* @param array $request $_POST data.
* @return WP_Error|array
*/
public static function quiz_get_question( $request ) {
$err = new WP_Error();
$student = llms_get_student();
if ( ! $student ) {
$err->add( 400, __( 'You must be logged in to take quizzes.', 'lifterlms' ) );
return $err;
}
$required = array( 'attempt_key', 'question_id' );
foreach ( $required as $key ) {
if ( empty( $request[ $key ] ) ) {
$err->add( 400, __( 'Missing required parameters. Could not proceed.', 'lifterlms' ) );
return $err;
}
}
$attempt_key = sanitize_text_field( $request['attempt_key'] );
$question_id = absint( $request['question_id'] );
$student_quizzes = $student->quizzes();
$attempt = $student_quizzes->get_attempt_by_key( $attempt_key );
// Don't allow the question to be retrieved if the attempt is not open or can't be resumed.
if ( ! $attempt || ( ! $attempt->get_quiz()->is_open() && ( ! $attempt->get_quiz()->can_be_resumed() || ! $attempt->can_be_resumed() ) ) ) {
$err->add( 500, __( 'There was an error retrieving the question. Please return to the lesson and try again.', 'lifterlms' ) );
return $err;
}
$question_id = $attempt->get_question( $question_id );
if ( ! $question_id ) {
$err->add( 404, __( 'Cannot find the requested question id. Please return to the lesson and try again.', 'lifterlms' ) );
return $err;
}
$html = llms_get_template_ajax(
'content-single-question.php',
array(
'attempt' => $attempt,
'question' => llms_get_post( $question_id ),
)
);
return array(
'html' => $html,
'question_id' => $question_id,
);
}
/**
* AJAX Quiz answer question.
*
* @since 3.9.0
* @since 3.27.0 Unknown.
* @since 6.4.0 Make sure attempts limit was not reached.
*
* @param array $request $_POST data.
* @return WP_Error|string
*/
public static function quiz_answer_question( $request ) {
$err = new WP_Error();
$student = llms_get_student();
if ( ! $student ) {
$err->add( 400, __( 'You must be logged in to take quizzes.', 'lifterlms' ) );
return $err;
}
$required = array( 'attempt_key', 'question_id', 'question_type' );
foreach ( $required as $key ) {
if ( ! isset( $request[ $key ] ) ) {
$err->add( 400, __( 'Missing required parameters. Could not proceed.', 'lifterlms' ) );
return $err;
}
}
$attempt_key = sanitize_text_field( $request['attempt_key'] );
$question_id = absint( $request['question_id'] );
$answer = array_map( 'stripslashes_deep', isset( $request['answer'] ) ? $request['answer'] : array() );
$student_quizzes = $student->quizzes();
$attempt = $student_quizzes->get_attempt_by_key( $attempt_key );
if ( ! $attempt || 'incomplete' !== $attempt->get( 'status' ) || ( $attempt->get_quiz()->can_be_resumed() && ! $attempt->can_be_resumed() ) ) {
$err->add( 500, __( 'There was an error recording your answer. Please return to the lesson and begin again.', 'lifterlms' ) );
return $err;
}
/**
* Check limit not reached.
*
* First check whether the quiz is open (so to leverage the `llms_quiz_is_open` filter ),
* if not, check also for remaining attempts.
*
* At this point the current attempt has already been counted (maybe the last allowed),
* so we check that the remaining attempt is just greater than -1.
*/
$quiz_id = $attempt->get( 'quiz_id' );
if ( ! ( new LLMS_Quiz( $quiz_id ) )->is_open() &&
$student_quizzes->get_attempts_remaining_for_quiz( $quiz_id, true ) < 0 ) {
$err->add( 400, __( "You've reached the maximum number of attempts for this quiz.", 'lifterlms' ) );
return $err;
}
// record the answer.
$attempt->answer_question( $question_id, $answer );
if ( isset( $request['via_previous_question'] ) ) {
$attempt->set( 'current_question_id', $attempt->get_previous_question( $question_id ) );
$attempt->save();
return;
}
if ( isset( $request['via_exit_quiz'] ) ) {
$attempt->set( 'current_question_id', $question_id );
$attempt->save();
return;
}
// get the next question.
$question_id = $attempt->get_next_question( $question_id );
// return html for the next question.
if ( $question_id ) {
$attempt->set( 'current_question_id', absint( $question_id ) );
$attempt->save();
$html = llms_get_template_ajax(
'content-single-question.php',
array(
'attempt' => $attempt,
'question' => llms_get_post( $question_id ),
)
);
return array(
'html' => $html,
'question_id' => $question_id,
);
} else {
return self::quiz_end( $request, $attempt );
}
}
/**
* End a quiz attempt.
*
* @since 3.9.0
* @since 3.16.0 Unknown.
*
* @param array $request $_POST data.
* @param LLMS_Quiz_Attempt|null $attempt The quiz attempt.
* @return array
*/
public static function quiz_end( $request, $attempt = null ) {
$err = new WP_Error();
if ( ! $attempt ) {
$student = llms_get_student();
if ( ! $student ) {
$err->add( 400, __( 'You must be logged in to take quizzes.', 'lifterlms' ) );
return $err;
}
if ( ! isset( $request['attempt_key'] ) ) {
$err->add( 400, __( 'Missing required parameters. Could not proceed.', 'lifterlms' ) );
return $err;
}
$attempt = $student->quizzes()->get_attempt_by_key( sanitize_text_field( $request['attempt_key'] ) );
if ( ! $attempt ) {
$err->add( 404, __( 'The requested attempt could not be found.', 'lifterlms' ) );
return $err;
}
}
// Record the attempt's completion.
$attempt->end();
// Setup a redirect.
$url = add_query_arg(
array(
'attempt_key' => $attempt->get_key(),
),
get_permalink( $attempt->get( 'quiz_id' ) )
);
return array(
/**
* Filter the quiz redirect URL on completion.
*
* @since Unknown
*
* @param string $url The quiz redirect URL on completion.
* @param LLMS_Quiz_Attempt $attempt The quiz attempt.
*/
'redirect' => apply_filters( 'llms_quiz_complete_redirect', $url, $attempt ),
);
}
/**
* Remove a coupon from an order during checkout
*
* @since 3.0.0
*
* @param array $request $_POST data.
* @return array
*/
public static function remove_coupon_code( $request ) {
llms()->session->set( 'llms_coupon', false );
$plan = new LLMS_Access_Plan( $request['plan_id'] );
ob_start();
llms_get_template( 'checkout/form-coupon.php' );
$coupon_html = ob_get_clean();
ob_start();
llms_get_template(
'checkout/form-gateways.php',
array(
'coupon' => false,
'gateways' => llms()->payment_gateways()->get_enabled_payment_gateways(),
'selected_gateway' => llms()->payment_gateways()->get_default_gateway(),
'plan' => $plan,
)
);
$gateways_html = ob_get_clean();
ob_start();
llms_get_template(
'checkout/form-summary.php',
array(
'coupon' => false,
'plan' => $plan,
'product' => $plan->get_product(),
)
);
$summary_html = ob_get_clean();
return array(
'coupon_html' => $coupon_html,
'gateways_html' => $gateways_html,
'summary_html' => $summary_html,
);
}
/**
* Handle Select2 Search boxes for WordPress Posts by Post Type and Post Status.
*
* @since 3.0.0
* @since 3.32.0 Updated to use llms_filter_input().
* @since 3.32.0 Posts can be queried by post status(es) via the `$_POST['post_statuses']`.
* By default only the published posts will be queried.
* @since 3.37.2 Posts can be 'filtered' by instructor via the `$_POST['instructor_id']`.
* @since 5.5.0 Do not encode quotes when sanitizing search term.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public static function select2_query_posts() {
global $wpdb;
if ( ! is_user_logged_in() ) {
wp_die();
}
// Grab the search term if it exists.
$term = llms_filter_input_sanitize_string( INPUT_POST, 'term', array( FILTER_FLAG_NO_ENCODE_QUOTES ) );
// Get the page.
$page = llms_filter_input( INPUT_POST, 'page', FILTER_SANITIZE_NUMBER_INT );
// Get post type(s).
$post_type = sanitize_text_field( llms_filter_input_sanitize_string( INPUT_POST, 'post_type' ) );
$post_types_array = explode( ',', $post_type );
foreach ( $post_types_array as &$str ) {
$str = "'" . esc_sql( trim( $str ) ) . "'";
}
$post_types = implode( ',', $post_types_array );
// Get post status(es).
$post_statuses = llms_filter_input_sanitize_string( INPUT_POST, 'post_statuses' );
$post_statuses = empty( $post_statuses ) ? 'publish' : $post_statuses;
$post_statuses_array = explode( ',', $post_statuses );
foreach ( $post_statuses_array as &$str ) {
$str = "'" . esc_sql( trim( $str ) ) . "'";
}
$post_statuses = implode( ',', $post_statuses_array );
// Filter posts (llms posts) by instructor ID.
$instructor_id = llms_filter_input( INPUT_POST, 'instructor_id', FILTER_SANITIZE_NUMBER_INT );
if ( ! empty( $instructor_id ) ) {
$serialized_iid = serialize(
array(
'id' => absint( $instructor_id ),
)
);
$serialized_iid = str_replace( array( 'a:1:{', '}' ), '', $serialized_iid );
$join = $wpdb->prepare(
" JOIN $wpdb->postmeta AS m ON p.ID = m.post_id AND m.meta_key = '_llms_instructors' AND m.meta_value LIKE %s",
'%' . $wpdb->esc_like( $serialized_iid ) . '%'
);
} else {
$join = '';
}
$limit = 30;
$start = $limit * $page;
if ( $term ) {
$like = " AND post_title LIKE '%s'";
$vars = array( '%' . $term . '%', $start, $limit );
} else {
$like = '';
$vars = array( $start, $limit );
}
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$posts = $wpdb->get_results(
$wpdb->prepare(
"SELECT p.ID as ID, p.post_title as post_title, p.post_type as post_type
FROM $wpdb->posts as p
$join
WHERE p.post_type IN ( $post_types )
AND p.post_status IN ( $post_statuses )
$like
ORDER BY post_title
LIMIT %d, %d
",
$vars
) // phpcs:ignore -- The number of params is correct, $vars is an array of two elements.
);// no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$items = array();
$grouping = ( count( $post_types_array ) > 1 );
foreach ( $posts as $post ) {
if ( ! current_user_can( 'read_post', $post->ID ) ) {
continue;
}
$item = array(
'id' => $post->ID,
'name' => $post->post_title . ' (' . __( 'ID#', 'lifterlms' ) . ' ' . $post->ID . ')',
);
if ( $grouping ) {
// Setup an object for the optgroup if it's not already set up.
if ( ! isset( $items[ $post->post_type ] ) ) {
$obj = get_post_type_object( $post->post_type );
$items[ $post->post_type ] = array(
'label' => $obj->labels->name,
'items' => array(),
);
}
$items[ $post->post_type ]['items'][] = $item;
} else {
$items[] = $item;
}
}
echo json_encode(
array(
'items' => $items,
'more' => count( $items ) === $limit,
'success' => true,
)
);
wp_die();
}
/**
* Add or remove a student from a course or membership.
*
* @since 3.0.0
* @since 3.33.0 Handle the delete enrollment request and make sure the $request['post_id'] is not empty.
* Also always return either a WP_Error on failure or a "success" array on action performed.
* @since 3.37.14 Use strict comparison.
*
* @param array $request $_POST data.
* @return (WP_Error|array)
*/
public static function update_student_enrollment( $request ) {
if ( ! current_user_can( 'manage_lifterlms' ) ) {
wp_die();
}
if ( empty( $request['student_id'] ) || empty( $request['status'] ) || empty( $request['post_id'] ) ) {
return new WP_Error( 400, __( 'Missing required parameters', 'lifterlms' ) );
}
if ( ! in_array( $request['status'], array( 'add', 'remove', 'delete' ), true ) ) {
return new WP_Error( 400, __( 'Invalid status', 'lifterlms' ) );
}
$student_id = intval( $request['student_id'] );
$post_id = intval( $request['post_id'] );
switch ( $request['status'] ) {
case 'add':
$res = llms_enroll_student( $student_id, $post_id, 'admin_' . get_current_user_id() );
break;
case 'remove':
$res = llms_unenroll_student( $student_id, $post_id, 'cancelled', 'any' );
break;
case 'delete':
$res = llms_delete_student_enrollment( $student_id, $post_id, 'any' );
break;
}
if ( ! $res ) {
// Translators: %s = action add|remove|delete.
return new WP_Error( 400, sprintf( __( 'Action "%1$s" failed. Please try again', 'lifterlms' ), $request['status'] ) );
}
return array(
'success' => true,
);
}
/**
* Validate a Coupon via the Checkout Form
*
* @since 3.0.0
* @since 3.39.0 Minor changes to code for readability with no changes to function behavior.
* @since 4.21.1 Sanitize user-submitted coupon code before outputting in error messages.
*
* @param array $request $_POST data.
* @return array|WP_Error On success, returns an array containing HTML parts used to update the interface of the checkout screen.
* On error, returns an error object with details of the encountered error.
*/
public static function validate_coupon_code( $request ) {
$error = new WP_Error();
$request['code'] = ! empty( $request['code'] ) ? sanitize_text_field( $request['code'] ) : '';
if ( empty( $request['code'] ) ) {
$error->add( 'error', __( 'Please enter a coupon code.', 'lifterlms' ) );
} elseif ( empty( $request['plan_id'] ) ) {
$error->add( 'error', __( 'Please enter a plan ID.', 'lifterlms' ) );
} else {
$cid = llms_find_coupon( $request['code'] );
if ( ! $cid ) {
// Translators: %s = coupon code.
$error->add( 'error', sprintf( __( 'Coupon code "%s" not found.', 'lifterlms' ), $request['code'] ) );
} else {
$coupon = new LLMS_Coupon( $cid );
$valid = $coupon->is_valid( $request['plan_id'] );
if ( is_wp_error( $valid ) ) {
$error = $valid;
} else {
llms()->session->set(
'llms_coupon',
array(
'plan_id' => $request['plan_id'],
'coupon_id' => $coupon->get( 'id' ),
)
);
$plan = new LLMS_Access_Plan( $request['plan_id'] );
ob_start();
llms_get_template(
'checkout/form-coupon.php',
array(
'coupon' => $coupon,
)
);
$coupon_html = ob_get_clean();
ob_start();
llms_get_template(
'checkout/form-gateways.php',
array(
'coupon' => $coupon,
'gateways' => llms()->payment_gateways()->get_enabled_payment_gateways(),
'selected_gateway' => llms()->payment_gateways()->get_default_gateway(),
'plan' => $plan,
)
);
$gateways_html = ob_get_clean();
ob_start();
llms_get_template(
'checkout/form-summary.php',
array(
'coupon' => $coupon,
'plan' => $plan,
'product' => $plan->get_product(),
)
);
$summary_html = ob_get_clean();
return array(
'code' => $coupon->get( 'title' ),
'coupon_html' => $coupon_html,
'gateways_html' => $gateways_html,
'summary_html' => $summary_html,
);
}
}
}
return $error;
}
/**
* "API" for the Admin Builder.
*
* @since 3.13.0
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @param array $request $_POST data.
* @return array
*/
public static function llms_builder( $request ) {
return LLMS_Admin_Builder::handle_ajax( $request );
}
/**
* Save autoenroll courses list for a Membership
*
* @since 3.30.0
*
* @param array $request $_POST data.
* @return null|true
*/
public static function llms_save_membership_autoenroll_courses( $request ) {
// Missing required fields.
if ( empty( $request['post_id'] ) || ! isset( $request['courses'] ) ) {
wp_die();
}
if ( ! current_user_can( 'edit_membership', $request['post_id'] ) ) {
wp_die();
}
// Not a membership.
$membership = llms_get_post( $request['post_id'] );
if ( ! $membership || ! is_a( $membership, 'LLMS_Membership' ) ) {
wp_die();
}
$courses = array_map( 'absint', (array) $request['courses'] );
$membership->add_auto_enroll_courses( $courses, true );
return true;
}
/**
* AJAX handler for creating and updating access plans via the metabox on courses & memberships
*
* @since 3.29.0
* @since 3.33.1 Use `wp_unslash()` before inserting access plan data.
*
* @param array $request $_POST data.
* @return array
*/
public static function llms_update_access_plans( $request ) {
if ( empty( $request['plans'] ) || ! is_array( $request['plans'] ) || empty( $request['post_id'] ) ) {
wp_die();
}
if ( ! llms_current_user_can_edit_product( $request['post_id'] ) ) {
wp_die();
}
$metabox = new LLMS_Meta_Box_Product();
$post_id = absint( $request['post_id'] );
$metabox->post = get_post( $post_id );
$errors = array();
foreach ( $request['plans'] as $raw_plan_data ) {
if ( empty( $raw_plan_data ) ) {
continue;
}
$raw_plan_data = wp_unslash( $raw_plan_data );
// Ensure we can switch plans that used to be paid to free.
if ( isset( $raw_plan_data['is_free'] ) && llms_parse_bool( $raw_plan_data['is_free'] ) && ! isset( $raw_plan_data['price'] ) ) {
$raw_plan_data['price'] = 0;
}
// Ensure we can clear the memberships when they are cleared but "Members only" still selected.
if ( isset( $raw_plan_data['availability'] ) && 'members' === $raw_plan_data['availability'] &&
( ! isset( $raw_plan_data['availability_restrictions'] ) || ! $raw_plan_data['availability_restrictions'] ) ) {
$raw_plan_data['availability_restrictions'] = array();
$raw_plan_data['availability'] = 'open';
}
$raw_plan_data['product_id'] = $post_id;
// retained filter for backwards compat.
$raw_plan_data = apply_filters( 'llms_access_before_save_plan', $raw_plan_data, $metabox );
$plan = llms_insert_access_plan( $raw_plan_data );
if ( is_wp_error( $plan ) ) {
$errors[ $raw_plan_data['menu_order'] ] = $plan;
} else {
// retained hook for backwards compat.
do_action( 'llms_access_plan_saved', $plan, $raw_plan_data, $metabox );
}
}
return array(
'errors' => $errors,
'html' => $metabox->get_html(),
);
}
/**
* AJAX handler for persisting tracking events.
*
* @since 3.37.14
*
* @param array $request $_POST data.
* @return array|WP_Error
*/
public static function persist_tracking_events( $request ) {
if ( empty( $request['llms-tracking'] ) ) {
return new WP_Error( 'error', __( 'Missing tracking data.', 'lifterlms' ) );
}
$success = llms()->events()->store_tracking_events( wp_unslash( $request['llms-tracking'] ) );
if ( ! is_wp_error( $success ) ) {
$success = array(
'success' => true,
);
}
return $success;
}
}
new LLMS_AJAX_Handler();
================================================
FILE: includes/class.llms.ajax.php
================================================
<?php
/**
* AJAX Event Handler
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_AJAX
*
* @since 1.0.0
* @since 3.35.0 Unknown.
* @since 4.0.0 Removed previously deprecated ajax actions and related methods.
* @since 6.0.0 Removed deprecated items.
* - `LLMS_AJAX::check_voucher_duplicate()` method.
* - `LLMS_AJAX::get_ajax_data()` method.
* - `LLMS_AJAX::register_script()` method.
*/
class LLMS_AJAX {
/**
* Nonce validation argument
*
* @var string
*/
const NONCE = 'llms-ajax';
/**
* Hook into ajax events.
*
* @since 1.0.0
* @since 3.16.0 Unknown.
* @since 4.0.0 Stop registering previously deprecated actions.
* @since 5.9.0 Move `check_voucher_duplicate()` to `LLMS_AJAX_Handler`.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
* @since 7.5.0 Added `favorite_object` ajax event.
*
* @return void
*/
public function __construct() {
$ajax_events = array(
'query_quiz_questions' => false,
'favorite_object' => false,
);
foreach ( $ajax_events as $ajax_event => $nopriv ) {
add_action( 'wp_ajax_' . $ajax_event, array( $this, $ajax_event ) );
if ( $nopriv ) {
add_action( 'wp_ajax_nopriv_' . $ajax_event, array( $this, $ajax_event ) );
}
}
self::register();
add_filter( 'heartbeat_received', array( 'LLMS_Admin_Builder', 'heartbeat_received' ), 10, 2 );
}
/**
* Register the AJAX handler class with all the appropriate WordPress hooks.
*
* @since Unknown
* @since 4.4.0 Move `register_script()` to script enqueue hook in favor of `wp_loaded`.
* @since 6.0.0 Removed the `wp_enqueue_scripts` action callback to the deprecated `LLMS_AJAX::register_script()` method.
*
* @return void
*/
public function register() {
$handler = 'LLMS_AJAX';
$methods = get_class_methods( 'LLMS_AJAX_Handler' );
foreach ( $methods as $method ) {
add_action( 'wp_ajax_' . $method, array( $handler, 'handle' ) );
add_action( 'wp_ajax_nopriv_' . $method, array( $handler, 'handle' ) );
}
}
/**
* Handles the AJAX request for my plugin.
*
* @since Unknown
*
* @return void
*/
public static function handle() {
// Make sure we are getting a valid AJAX request.
check_ajax_referer( self::NONCE );
$request = $_REQUEST;
$response = call_user_func( 'LLMS_AJAX_Handler::' . $request['action'], $request );
if ( $response instanceof WP_Error ) {
self::send_error( $response );
}
wp_send_json_success( $response );
die();
}
public static function scrub_request( $request ) {
foreach ( $request as $key => $value ) {
if ( is_array( $value ) ) {
$request[ $key ] = self::scrub_request( $value );
} else {
$request[ $key ] = llms_clean( $value );
}
}
return $request;
}
/**
* Sends a JSON response with the details of the given error.
*
* @param WP_Error $error
*/
private static function send_error( $error ) {
wp_send_json(
array(
'code' => $error->get_error_code(),
'message' => $error->get_error_message(),
)
);
}
/**
* Retrieve Quiz Questions
*
* Used by Select2 AJAX functions to load paginated quiz questions
* Also allows querying by question title
*
* @since Unknown
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public function query_quiz_questions() {
// Grab the search term if it exists.
$term = array_key_exists( 'term', $_REQUEST ) ? llms_filter_input_sanitize_string( INPUT_POST, 'term' ) : '';
$page = array_key_exists( 'page', $_REQUEST ) ? llms_filter_input( INPUT_POST, 'page', FILTER_SANITIZE_NUMBER_INT ) : 0;
global $wpdb;
$limit = 30;
$start = $limit * $page;
if ( $term ) {
$like = " AND post_title LIKE '%s'";
$vars = array( '%' . $term . '%', $start, $limit );
} else {
$like = '';
$vars = array( $start, $limit );
}
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$questions = $wpdb->get_results(
$wpdb->prepare(
"SELECT ID, post_title
FROM $wpdb->posts
WHERE
post_type = 'llms_question'
AND post_status = 'publish'
$like
ORDER BY post_title
LIMIT %d, %d
",
$vars
)
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$r = array();
foreach ( $questions as $q ) {
$r[] = array(
'id' => $q->ID,
'name' => $q->post_title . ' (' . $q->ID . ')',
);
}
echo json_encode(
array(
'items' => $r,
'more' => count( $r ) === $limit,
'success' => true,
)
);
wp_die();
}
/**
* Add Favorite / Unfavorite postmeta for an object.
*
* @since 7.5.0
*
* @return void
*/
public function favorite_object() {
// Grab the data if it exists.
$user_action = llms_filter_input_sanitize_string( INPUT_POST, 'user_action' );
$object_id = llms_filter_input( INPUT_POST, 'object_id', FILTER_SANITIZE_NUMBER_INT );
$object_type = llms_filter_input_sanitize_string( INPUT_POST, 'object_type' );
$user_id = get_current_user_id();
$student = llms_get_student( $user_id );
if ( is_null( $object_id ) || ! $student ) {
return;
}
if ( 'favorite' === $user_action ) {
// You can never mark favorite a non-free lesson of a course you're not enrolled into.
if ( 'lesson' === $object_type ) {
$lesson = llms_get_post( $object_id );
$can_mark_favorite = $lesson && ( $student->is_enrolled( $object_id ) || $lesson->is_free() );
if ( ! $can_mark_favorite ) {
return;
}
}
llms_mark_favorite( $user_id, $object_id, $object_type );
} elseif ( 'unfavorite' === $user_action ) {
llms_mark_unfavorite( $user_id, $object_id, $object_type );
}
echo wp_json_encode(
array(
'total_favorites' => llms_get_object_total_favorites( $object_id ),
'success' => true,
)
);
wp_die();
}
}
new LLMS_AJAX();
================================================
FILE: includes/class.llms.background.updater.php
================================================
<?php
/**
* LLMS_Background_Updater
*
* @package LifterLMS/Classes
*
* @since 3.4.3
* @version 5.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Background database upgrader
*
* Process db updates in the background
*
* Replaces abstract updater and update classes from 3.4.2 and lower.
*
* @since 3.4.3
*/
class LLMS_Background_Updater extends WP_Background_Process {
/**
* Action name
*
* @var string
*/
protected $action = 'llms_bg_updater';
/**
* Enables event logging
*
* @var boolean
*/
private $enable_logging = true;
/**
* Constructor
*
* @since 3.4.3
*
* @return void
*/
public function __construct() {
parent::__construct();
if ( ! defined( 'LLMS_BG_UPDATE_LOG' ) ) {
define( 'LLMS_BG_UPDATE_LOG', true );
}
$this->enable_logging = ( defined( 'LLMS_BG_UPDATE_LOG' ) && LLMS_BG_UPDATE_LOG );
}
/**
* Called when queue is emptied and action is complete
*
* @since 3.4.3
*
* @return void
*/
protected function complete() {
$this->log( 'Update complete' );
LLMS_Install::update_db_version();
parent::complete();
}
/**
* Starts the queue
*
* @since 3.4.3
*
* @return void
*/
public function dispatch() {
$dispatched = parent::dispatch();
if ( is_wp_error( $dispatched ) ) {
$this->log( sprintf( 'Unable to dispatch updater: %s' ), $dispatched->get_error_message() );
}
}
/**
* Retrieve approximate progress of updates in the queue
*
* @since 3.4.3
* @since 3.16.10 Unknown.
*
* @return int
*/
public function get_progress() {
// If the queue is empty we've already finished.
if ( $this->is_queue_empty() ) {
return 0;
}
// Get the progress.
$batch = $this->get_batch();
$total = max( array_keys( $batch->data ) ) + 1;
$remaining = count( $batch->data );
if ( ! $total ) {
return 0;
}
return ceil( ( ( $total - $remaining ) / $total ) * 100 );
}
/**
* Handle cron healthcheck
*
* Restart the background process if not already running
* and data exists in the queue.
*
* Overridden to enable the "force" option to work, replaces "exit" with "return"
* so that we can redirect and manually call the cronjob
*
* @since 3.4.3
*
* @return void
*/
public function handle_cron_healthcheck() {
// Background process already running.
if ( $this->is_process_running() ) {
return;
}
// No data to process.
if ( $this->is_queue_empty() ) {
$this->clear_scheduled_event();
return;
}
$this->handle();
}
/**
* Returns true if the updater is running
*
* @since 3.4.3
*
* @return boolean
*/
public function is_updating() {
return ( false === $this->is_queue_empty() );
}
/**
* Log event data to an update file when logging enabled
*
* @since 3.4.3
*
* @param mixed $data Data to log.
* @return void
*/
public function log( $data ) {
if ( $this->enable_logging ) {
llms_log( $data, 'updater' );
}
}
/**
* Processes an item in the queue
*
* @since 3.4.3
* @since 3.16.10 Unknown.
* @since 5.2.0 Use `llms_get_callable_name()` to log callback.
*
* @param mixed $callback PHP callable (function name, callable array, etc...).
* @return mixed Returns `false` when the callback is complete (removes it from the queue).
* Returns $callback to leave it in the queue.
*/
protected function task( $callback ) {
require_once LLMS_PLUGIN_DIR . 'includes/functions/llms.functions.updates.php';
$callback_name = llms_get_callable_name( $callback );
if ( is_callable( $callback ) ) {
$this->log( sprintf( 'Running %s callback', $callback_name ) );
if ( call_user_func( $callback ) ) {
return $callback;
}
$this->log( sprintf( 'Finished %s callback', $callback_name ) );
} else {
$this->log( sprintf( 'Could not find %s callback', $callback_name ) );
}
return false;
}
/**
* Save queue
*
* Overwrites parent method to empty `$this->data` following a save.
*
* This ensures save() can be called multiple times without recording duplicates.
*
* @since 5.2.0
*
* @return LLMS_Background_Updater
*/
public function save() {
parent::save();
// Reset data to avoid duplicates if save() is called more than once.
$this->data = array();
return $this;
}
}
================================================
FILE: includes/class.llms.cache.helper.php
================================================
<?php
/**
* LifterLMS Caching Helper
*
* @package LifterLMS/Classes
*
* @since 3.15.0
* @version 6.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Cache_Helper
*
* @since 3.15.0
* @since 4.0.0 Add WP_Object_Cache API helper.
*/
class LLMS_Cache_Helper {
/**
* Constructor
*
* @since 3.15.0
*
* @return void
*/
public function __construct() {
add_action( 'wp', array( $this, 'maybe_no_cache' ) );
}
/**
* Sets a browser cookie that tells WP Engine to exclude a page from server caching.
*
* @see https://wpengine.com/support/cache/#Default_Cache_Exclusions
* @see https://wpengine.com/support/determining-wp-engine-environment/
*
* @since 6.6.0
*
* @param int|WP_Post $post Optional. Post ID or post object. Default is the global `$post`.
*
* @return void
*/
private function exclude_page_from_wpe_server_cache( $post = null ) {
if ( function_exists( 'is_wpe' ) && is_wpe() ) {
/*
* If "Settings -> Permalinks" is "Plain", i.e. the `permalink_structure` option is '',
* allow the entire site to be cached by WP Engine.
* Note: This will prevent users from being able to successfully use the "Lost your password?" feature.
*/
if ( isset( $GLOBALS['wp_rewrite'] ) && ! $GLOBALS['wp_rewrite']->using_permalinks() ) {
return;
}
$path = wp_parse_url( get_permalink( $post ), PHP_URL_PATH );
llms_setcookie( 'wordpress_wpe_no_cache', '1', 0, $path, COOKIE_DOMAIN, is_ssl(), true );
}
}
/**
* Retrieve a cache prefix that can be used with WP_Object_Cache methods
*
* Using a cache prefix allows simple invalidation of all items with the same
* prefix simply by updating the prefix.
*
* The "prefix" is microtime(), if we wish to invalidate all items in the prefix group
* we call the method again with `$invalidate=true` which updates the prefix to the current
* microtime(), thereby invalidating the entire cache group.
*
* @since 4.0.0
*
* @link https://core.trac.wordpress.org/ticket/4476#comment:10
*
* @param string $group Cache group name.
* @return string
*/
public static function get_prefix( $group ) {
$key = sprintf( 'llms_%s_cache_prefix', $group );
$prefix = wp_cache_get( $key, $group );
if ( false === $prefix ) {
$prefix = microtime();
wp_cache_set( $key, $prefix, $group );
}
return sprintf( 'llms_cache_%s_', $prefix );
}
/**
* Invalidate a cache group prefix.
*
* @since 4.0.0
*
* @link https://core.trac.wordpress.org/ticket/4476#comment:10
*
* @param string $group Cache group name.
* @return void
*/
public static function invalidate_group( $group ) {
wp_cache_set( sprintf( 'llms_%s_cache_prefix', $group ), microtime(), $group );
}
/**
* Define nocache constants and set nocache headers on specified pages
*
* This prevents caching for the Checkout & Student Dashboard pages.
*
* @since 3.15.0
* @since 6.4.0 Force no caching on quiz pages.
* Added 'no-store' to the default WordPress nocache headers.
* @since 6.6.0 Added WP Engine server-side cache exclusions.
*
* @return void
*/
public function maybe_no_cache() {
if ( ! is_blog_installed() ) {
return;
}
/**
* Filter the list of pages that LifterLMS will send nocache headers for.
*
* @since 3.15.0
*
* @param int[] $ids List of WP_Post IDs.
*/
$ids = apply_filters(
'llms_no_cache_page_ids',
array(
llms_get_page_id( 'checkout' ),
llms_get_page_id( 'myaccount' ),
)
);
/**
* Filter whether or not LifterLMS will send nocache headers.
*
* @since 6.4.0
*
* @param bool $no_cache Whether or not LifterLMS will send nocache headers.
*/
$do_not_cache = apply_filters( 'llms_no_cache', is_page( $ids ) || is_quiz() );
if ( $do_not_cache ) {
add_filter( 'nocache_headers', array( __CLASS__, 'additional_nocache_headers' ), 99 );
llms_maybe_define_constant( 'DONOTCACHEPAGE', true );
llms_maybe_define_constant( 'DONOTCACHEOBJECT', true );
llms_maybe_define_constant( 'DONOTCACHEDB', true );
nocache_headers();
$this->exclude_page_from_wpe_server_cache();
remove_filter( 'nocache_headers', array( __CLASS__, 'additional_nocache_headers' ), 99 );
}
}
/**
* Set additional nocache headers.
*
* @since 6.4.0
*
* @see wp_get_nocache_headers()
*
* @param array $headers {
* Header names and field values.
*
* @type string $Expires Expires header.
* @type string $Cache-Control Cache-Control header.
* }
* @return array
*/
public static function additional_nocache_headers( $headers ) {
// First tree are the default ones.
$nocache_headers_cache_control = array(
'no-cache',
'must-revalidate',
'max-age=0',
'no-store',
);
if ( ! empty( $headers['Cache-Control'] ) ) {
$original_headers_cache_control = array_map( 'trim', explode( ',', $headers['Cache-Control'] ) );
// Merge original headers with our nocache headers.
$nocache_headers_cache_control = array_merge( $nocache_headers_cache_control, $original_headers_cache_control );
// Avoid duplicates.
$nocache_headers_cache_control = array_unique( $nocache_headers_cache_control );
}
$headers['Cache-Control'] = implode( ', ', $nocache_headers_cache_control );
return $headers;
}
}
return new LLMS_Cache_Helper();
================================================
FILE: includes/class.llms.certificate.php
================================================
<?php
/**
* Base Certificate Class
*
* Handles generating certificates.
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Base Certificate Class
*
* @since 1.0.0
* @since 3.30.3 Explicitly define class properties.
* @since 4.0.0 Remove previously deprecated class property `$enabled`.
* @deprecated 6.0.0 Class `LLMS_Certificate` is deprecated with no direct replacement.
*/
class LLMS_Certificate {
/**
* @var int
* @since 1.0.0
*/
public $certificate_template_id;
/**
* post title
*
* @var string
* @since 1.0.0
*/
public $certificate_title;
/**
* @var string
* @since 1.0.0
*/
public $content;
/**
* @var string
* @since 1.0.0
*/
public $email_type;
/**
* @var array
* @since 1.0.0
*/
public $find = array();
/**
* @var string
* @since 1.0.0
*/
public $id;
/**
* image id
*
* @var int
* @since 1.0.0
*/
public $image;
/**
* @var int
* @since 1.0.0
*/
public $lesson_id;
/**
* @var WP_User
* @since 1.0.0
*/
public $object;
/**
* @var array
* @since 1.0.0
*/
public $replace = array();
/**
* @var bool
* @since 1.0.0
*/
public $sending;
/**
* post title
*
* @var string
* @since 1.0.0
*/
public $title;
/**
* @var int
* @since 1.0.0
*/
public $userid;
/**
* Alert when deprecated methods are used.
*
* This class as well as core classes extending it have been deprecated. All public and protected methods
* have been changed to private and will be made accessible through this magic method which also emits a
* deprecation warning.
*
* This public method has been intentionally marked as private to denote it's temporary lifespan. It will be
* removed alongside this class in the next major release.
*
* @since 6.0.0
*
* @access private
*
* @param string $name Name of the method being called.
* @param array $args Arguments provided to the method.
* @return void
*/
public function __call( $name, $args ) {
_deprecated_function( __CLASS__ . '::' . esc_html( $name ), '6.0.0' );
if ( method_exists( $this, $name ) ) {
$this->$name( ...$args );
}
}
/**
* Constructor.
*
* @since Unknown.
* @deprecated 6.0.0 `LLMS_Certificate::__construct()` is deprecated with no replacement.
*/
public function __construct() {
// Settings TODO Refactor: theses can come from the email post now.
$this->email_type = 'html';
$this->find = array( '{blogname}', '{site_title}' );
$this->replace = array( $this->get_blogname(), $this->get_blogname() );
}
/**
* Is Enabled
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Certificate::is_enabled()` is deprecated with no replacement.
*
* @return boolean
*/
private function is_enabled() {
return true;
}
/**
* Get Blog Name
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Certificate::get_blogname()` is deprecated with no replacement.
*
* @return string [blog name]
*/
private function get_blogname() {
return wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES );
}
/**
* Format String
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Certificate::format_string()` is deprecated with no replacement.
*
* @param string $string [Find and replace merge fields]
* @return string [formatted string]
*/
private function format_string( $string ) {
return str_replace( $this->find, $this->replace, $string );
}
/**
* Get Blog Title
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Certificate::get_title()` is deprecated with no replacement.
*
* @return string [Blog title]
*/
private function get_title() {
return apply_filters( '_llms_certificate_title' . $this->id, $this->title, $this->object );
}
/**
* Get Content
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Certificate::get_content()` is deprecated with no replacement.
*
* @return string [Post Content]
*/
private function get_content() {
$this->sending = true;
$email_content = $this->get_content_html();
return $email_content;
}
/**
* Get Content HTML
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Certificate::get_content_html()` is deprecated with no replacement.
*
* @return void
*/
private function get_content_html() {}
/**
* Create Certificate
*
* @since 1.0.0
* @since 3.8.0 Unknown.
* @deprecated 6.0.0 `LLMS_Certificate::get_title()` is deprecated with no replacement.
*
* @param string $content HTML formatted post content.
* @return void
*/
private function create( $content ) {
global $wpdb;
$new_user_certificate = apply_filters(
'lifterlms_new_page',
array(
'post_type' => 'llms_my_certificate',
'post_title' => $this->title,
'post_content' => $content,
'post_status' => 'publish',
'post_author' => 1,
)
);
$new_user_certificate_id = wp_insert_post( $new_user_certificate, true );
update_post_meta( $new_user_certificate_id, '_llms_certificate_title', $this->certificate_title );
update_post_meta( $new_user_certificate_id, '_llms_certificate_image', $this->image );
update_post_meta( $new_user_certificate_id, '_llms_certificate_template', $this->certificate_template_id );
$user_metadatas = array(
'_certificate_earned' => $new_user_certificate_id,
);
foreach ( $user_metadatas as $key => $value ) {
$update_user_postmeta = $wpdb->insert(
$wpdb->prefix . 'lifterlms_user_postmeta',
array(
'user_id' => $this->userid,
'post_id' => $this->lesson_id,
'meta_key' => $key,
'meta_value' => $value,
'updated_date' => current_time( 'mysql' ),
)
);
}
// This hook is documented in includes/class-llms-engagement-handler.php.
do_action( 'llms_user_earned_certificate', $this->userid, $new_user_certificate_id, $this->lesson_id );
}
}
================================================
FILE: includes/class.llms.certificates.php
================================================
<?php
/**
* LLMS_Certificates class file
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Main LifterLMS Certificates "factory"
*
* Handles certificate generation and exports.
*
* @see llms()->certificates()
*
* @since 1.0.0
* @since 3.30.3 Explicitly define class properties.
* @since 3.37.3 Refactored `get_export_html()` method.
* Added an action `llms_certificate_generate_export` to allow modification of certificate exports before being stored on the server.
* @since 3.38.1 Use `LLMS_Mime_Type_Extractor::from_file_path()` when retrieving the certificate's images mime types during html export.
* @since 4.3.1 When generating the certificate to export, if `$this->scrape_certificate()` generates a WP_Error early, return it to avoid fatal errors.
* @since 4.21.0 Added new class properties: `$export_local_hosts`, `$export_blocked_stylesheet_hosts`, and `$export_blocked_image_hosts`.
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
* @since 6.0.0 Changes:
* - Deprecated the `LLMS_Certificates::trigger_engagement()` method.
* Use the {@see LLMS_Engagement_Handler::handle_certificate()} method instead.
* - Removed the deprecated `LLMS_Certificates::$_instance` property.
*/
class LLMS_Certificates {
use LLMS_Trait_Singleton,
LLMS_Trait_Award_Default_Images;
/**
* The ID for the award type.
*
* Used by {@see LLMS_Trait_Award_Default_Images}.
*
* @var string
*/
protected $award_type = 'certificate';
/**
* Array of Certificate types.
*
* @var array
*/
public $certs = array();
/**
* Array of local hosts
*
* @var string[]
*/
private $export_local_hosts;
/**
* Array of hosts from which stylesheets won't be retrieved during the export
*
* @var string[]
*/
private $export_blocked_stylesheet_hosts;
/**
* Array of hosts from which images won't be retrieved during the export
*
* @var string[]
*/
private $export_blocked_image_hosts;
/**
* Constructor
*
* @since 1.0.0
*
* @return void
*/
private function __construct() {
$this->init();
}
/**
* Initialize class.
*
* @since 1.0.0
* @since 4.21.0 Define useful class properties used when exporting.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
public function init() {
$this->certs['LLMS_Certificate_User'] = isset( $this->certs['LLMS_Certificate_User'] ) ? $this->certs['LLMS_Certificate_User'] : include_once 'certificates/class.llms.certificate.user.php';
$this->export_local_hosts = array_unique(
array(
wp_parse_url( get_home_url(), PHP_URL_HOST ),
wp_parse_url( get_site_url(), PHP_URL_HOST ),
)
);
$this->export_blocked_stylesheet_hosts = array_unique(
/**
* Filters the blocked hosts for stylesheets in certificate exports
*
* @since 4.21.0
*
* @param string[] Array of hosts to block.
*/
apply_filters(
'llms_certificate_export_blocked_stylesheet_hosts',
array(
'fonts.googleapis.com',
)
)
);
$this->export_blocked_image_hosts = array_unique(
/**
* Filters the blocked hosts for images in certificate exports
*
* @since 4.21.0
*
* @param string[] Array of hosts to block.
*/
apply_filters(
'llms_certificate_export_blocked_image_hosts',
array()
)
);
}
/**
* Award a certificate to a user.
*
* Calls trigger method passing arguments
*
* @since 1.0.0
* @deprecated 6.0.0 `LLMS_Certificates::trigger_engagement()` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate()`.
*
* @param int $person_id WP_User ID.
* @param int $certificate_id WP_Post ID of the certificate template.
* @param int $related_post_id WP_Post ID of the related post, for example a lesson id.
* @return void
*/
public function trigger_engagement( $person_id, $certificate_id, $related_post_id ) {
_deprecated_function( 'LLMS_Certificates::trigger_engagement()', '6.0.0', 'LLMS_Engagement_Handler::handle_certificate()' );
LLMS_Engagement_Handler::handle_certificate( array( $person_id, $certificate_id, $related_post_id, null ) );
}
/**
* Generate a downloadable HTML file for a certificate
*
* @since 3.18.0
* @since 3.37.3 Added action `llms_certificate_generate_export`.
* @since 4.3.1 Introduce `llms_certificate_error` WP_Error code.
*
* @param string $filepath Full path for the created file.
* @param int $certificate_id WP_Post ID of the earned certificate.
* @return mixed WP_Error or full path to the generated export.
*/
private function generate_export( $filepath, $certificate_id ) {
$html = $this->get_export_html( $certificate_id );
if ( is_wp_error( $html ) ) {
return $html;
}
/**
* Run actions prior to certificate export generation.
*
* @param string $filepath Full path where the created file will be stored. Passed as a reference.
* @param string $html Certificate HTML. Passed as a reference.
* @param int $certificate_id WP_Post ID of the earned certificate.
*/
do_action_ref_array( 'llms_certificate_generate_export', array( &$filepath, &$html, $certificate_id ) );
$file = fopen( $filepath, 'w' );
if ( false === $file ) {
return new WP_Error( 'llms_certificate_error', __( 'Unable to open export file (HTML certificate) for writing.', 'lifterlms' ) );
}
if ( false === fwrite( $file, $html ) ) {
return new WP_Error( 'llms_certificate_error', __( 'Unable to write to export file (HTML certificate).', 'lifterlms' ) );
}
fclose( $file );
return $filepath;
}
/**
* Retrieve an existing or generate a downloadable HTML file for a certificate
*
* @since 3.18.0
* @since 6.0.0 Use the certificate post title in favor of the deprecated meta value `_llms_certificate_title`.
*
* @param int $certificate_id WP Post ID of the earned certificate.
* @param bool $use_cache If true will check for existence of a cached version of the file first.
* @return mixed WP_Error or full path to the generated export.
*/
public function get_export( $certificate_id, $use_cache = false ) {
if ( $use_cache ) {
$cached = get_post_meta( $certificate_id, '_llms_export_filepath', true );
if ( $cached && file_exists( $cached ) ) {
return $cached;
}
}
$cert = new LLMS_User_Certificate( $certificate_id );
// Translators: %1$s = url-safe certificate title, %2$s = random alpha-numeric characters for filename obscurity.
$filename = sanitize_title( sprintf( esc_attr_x( 'certificate-%1$s-%2$s', 'certificate download filename', 'lifterlms' ), $cert->get( 'title' ), wp_generate_password( 12, false, false ) ) );
$filename .= '.html';
$filepath = LLMS_TMP_DIR . $filename;
// Generate the file.
$filepath = $this->generate_export( $filepath, $certificate_id );
if ( $use_cache && ! is_wp_error( $filepath ) ) {
update_post_meta( $certificate_id, '_llms_export_filepath', $filepath );
}
return $filepath;
}
/**
* Retrieves the HTML of a certificate which can be used to create an exportable download
*
* @since 3.18.0
* @since 3.24.3 Unknown.
* @since 3.37.3 Refactored method into multiple functions.
* @since 4.3.1 If `$this->scrape_certificate()` generates a `WP_Error` early return it.
* @since 4.8.0 Remove redundant check for the presence of `DOMDocument`.
*
* @param int $certificate_id WP_Post ID of the earned certificate.
* @return WP_Error|string HTML of the certificate on success, otherwise an error object.
*/
private function get_export_html( $certificate_id ) {
// Retrieve the raw HTML of the page.
$html = $this->scrape_certificate( $certificate_id );
if ( is_wp_error( $html ) ) {
return $html;
}
// Modify the DOM.
$html = $this->modify_dom( $html );
/**
* Modify the HTML of a certificate export.
*
* @since 3.18.0
*
* @param string $html HTML to be exported.
* @param int $certificate_id WP_Post ID of the earned certificate.
*/
return apply_filters( 'llms_get_certificate_export_html', $html, $certificate_id );
}
/**
* Create a unique slug for earned certificates.
*
* When relying only on `wp_unique_post_slug()`, predictable URLs are created for earned certificates,
* such as "certificate-of-completion-1", "certificate-of-completion-2", etc... this method creates
* an obtuse and randomized suffix and appends it to the post slug.
*
* The unique suffix will be a randomized string at least 3 characters long and made up of lowercase letters and numbers.
*
* When ensuring uniqueness of the generated suffix, the length of the string will be increased by one for every 5
* encountered collisions.
*
* @since 6.0.0
*
* @param string $title The title of the certificate being created.
* @return string
*/
public function get_unique_slug( $title ) {
$title = sanitize_title( $title ) . '-';
/**
* Filters the minimum length of the suffix used to create a unique earned certificate slug.
*
* @since 6.0.0
*
* @param int $min_strlen The minimum desired suffix string length.
*/
$min_strlen = apply_filters( 'llms_certificate_unique_slug_suffix_min_length', 3 );
$i = 0;
do {
$length = $min_strlen + floor( $i / 5 );
$slug = $title . strtolower( wp_generate_password( absint( $length ), false ) );
$i++;
} while ( wp_unique_post_slug( $slug, 0, 'publish', 'llms_my_certificate', 0 ) !== $slug );
return $slug;
}
/**
* Modify the HTML using DOMDocument.
*
* Preparations include:
*
* 1. Removing all `script` tags.
* 2. Removes the WP Admin Bar.
* 3. Converting all stylesheets into inline `style` tags.
* 4. Removes all non stylesheet `link` tags.
* 5. Converts `img` tags into data uris.
* 6. Adds inline CSS to hide anything hidden in a print view.
*
* @since 3.37.3
* @since 3.38.1 Use `LLMS_Mime_Type_Extractor::from_file_path()` in place of `mime_content_type()` to avoid issues with PHP installs that do not support it.
* @since 4.8.0 Use `llms_get_dom_document()` in favor of loading `DOMDocument` directly.
* @since 4.21.0 Allow external assets (e.g. images/stylesheets from CDN) to be embedded/inlined.
* Also, remove the WP Admin Bar earlier.
* Move the links and images modification in specific methods.
*
* @param string $html Certificate HTML.
* @return string
*/
private function modify_dom( $html ) {
$dom = llms_get_dom_document( $html );
if ( is_wp_error( $dom ) ) {
return $html;
}
// Don't throw or log warnings.
$libxml_state = libxml_use_internal_errors( true );
// Remove all <scripts>.
$scripts = $dom->getElementsByTagName( 'script' );
while ( $scripts && $scripts->length ) {
$scripts->item( 0 )->parentNode->removeChild( $scripts->item( 0 ) );
}
// Remove the admin bar (if found).
$admin_bar = $dom->getElementById( 'wpadminbar' );
if ( $admin_bar ) {
$admin_bar->parentNode->removeChild( $admin_bar ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
}
$this->modify_dom_links( $dom );
$this->modify_dom_images( $dom );
// Hide print stuff (this is faster than traversing the dom to remove the element).
$header = $dom->getElementsByTagName( 'head' )->item( 0 );
$header->appendChild( $dom->createELement( 'style', '.no-print { display: none !important; }' ) );
$html = $dom->saveHTML();
// Handle errors.
libxml_clear_errors();
// Restore.
libxml_use_internal_errors( $libxml_state );
return $html;
}
/**
* Modify head's <link>s of the DOMDocument.
*
* @since 4.21.0
*
* @param DOMDocument $dom The DOMDocument containing the certificate.
* @return void
*/
private function modify_dom_links( $dom ) {
// Get all <links>.
$links = $dom->getElementsByTagName( 'link' );
$to_replace = array();
// Inline stylesheets.
foreach ( $links as $link ) {
// Only proceed for stylesheets.
if ( 'stylesheet' !== $link->getAttribute( 'rel' ) ) {
continue;
}
$raw = $this->get_stylesheet_raw( $link->getAttribute( 'href' ) );
if ( empty( $raw ) ) {
continue;
}
// Add it to be inlined late.
$tag = $dom->createElement( 'style', $raw );
$to_replace[] = array(
'old' => $link,
'new' => $tag,
);
}
// Do replacements, ensures cascade order is retained.
foreach ( $to_replace as $replacement ) {
$replacement['old']->parentNode->replaceChild( $replacement['new'], $replacement['old'] );
}
// Remove all remaining non stylesheet <links>.
$links = $dom->getElementsByTagName( 'link' );
while ( $links && $links->length ) {
$links->item( 0 )->parentNode->removeChild( $links->item( 0 ) );
}
}
/**
* Get stylesheet raw content given its URL
*
* @since 4.21.0
*
* @param string $stylesheet_href The stylesheet href.
* @param boolean $allowed_only Optional. Get only stylesheet whose host is not in the `export_blocked_stylesheet_hosts` list.
* @return string|false
*/
private function get_stylesheet_raw( $stylesheet_href, $allowed_only = true ) {
$href_host = wp_parse_url( $stylesheet_href, PHP_URL_HOST );
// Only include stylesheets from non blocked hosts.
if ( $allowed_only && in_array( $href_host, $this->export_blocked_stylesheet_hosts, true ) ) {
return false;
}
// Get the actual CSS.
if ( in_array( $href_host, $this->export_local_hosts, true ) ) { // Is local?
$raw = file_get_contents( untrailingslashit( ABSPATH ) . wp_parse_url( $stylesheet_href, PHP_URL_PATH ) ); // phpcs:ignore WordPress.WP.AlternativeFunctions -- getting a local file.
} else {
$response = wp_remote_get( $stylesheet_href );
$raw = wp_remote_retrieve_body( $response );
}
return $raw;
}
/**
* Modify images of the DOMDocument
*
* @since 4.21.0
*
* @param DOMDocument $dom The DOMDocument containing the certificate.
* @return void
*/
private function modify_dom_images( $dom ) {
$images = $dom->getElementsByTagName( 'img' );
$to_remove = array();
// Convert images to data uris.
foreach ( $images as $img ) {
$img_data_type = $this->get_image_data_and_type( $img->getAttribute( 'src' ) );
if ( empty( $img_data_type['data'] ) || empty( $img_data_type['type'] ) ) {
$to_remove[] = $img; // Save images to remove: removing them directly here will alter the collection iteration (skip).
continue;
}
$data = base64_encode( $img_data_type['data'] );// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
$img->setAttribute( 'src', 'data:' . $img_data_type['type'] . ';base64,' . $data );
// Remove srcset and sizes attributes.
$img->removeAttribute( 'sizes' );
$img->removeAttribute( 'srcset' );
// Remove useless loading attribute.
$img->removeAttribute( 'loading' );
}
foreach ( $to_remove as $img ) {
$img->parentNode->removeChild( $img ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
}
}
/**
* Get image data and type given its source URL
*
* @since 4.21.0
*
* @param string $image_src The image src.
* @param boolean $allowed_only Optional. Get only images whose host is not in the `export_blocked_image_hosts` list.
* @return array|false
*/
private function get_image_data_and_type( $image_src, $allowed_only = true ) {
$src_host = wp_parse_url( $image_src, PHP_URL_HOST );
// Only include images from non blocked hosts.
if ( $allowed_only && in_array( $src_host, $this->export_blocked_image_hosts, true ) ) {
return false;
}
if ( in_array( $src_host, $this->export_local_hosts, true ) ) { // Is local?
$imgpath = untrailingslashit( ABSPATH ) . wp_parse_url( $image_src, PHP_URL_PATH );
$data = file_get_contents( $imgpath ); // phpcs:ignore WordPress.WP.AlternativeFunctions -- getting a local file.
$type = LLMS_Mime_Type_Extractor::from_file_path( $imgpath );
} else {
$response = wp_remote_get( $image_src );
$data = wp_remote_retrieve_body( $response );
$type = wp_remote_retrieve_header( $response, 'content-type' );
}
return compact( 'data', 'type' );
}
/**
* Scrape a LifterLMS Certificate permalink and return the generated HTML.
*
* @since 3.37.3
*
* @param int $certificate_id WP_Post ID of the earned certificate (an "llms_my_certificate" post).
* @return WP_Error|string WP_Error on failure or the full page HTML on success.
*/
private function scrape_certificate( $certificate_id ) {
// Create a nonce for getting the export HTML.
$token = wp_generate_password( 32, false );
update_post_meta( $certificate_id, '_llms_auth_nonce', $token );
/**
* Modify the URL used to scrape the HTML of a certificate in preparation for a certificate export.
*
* @since 3.18.0
*
* @param string $url Certificate permalink with a one-time use authorization token appended as a query string variable.
* @param int $certificate_id WP_Post ID of the earned certificate (an "llms_my_certificate" post).
*/
$url = apply_filters(
'llms_get_certificate_export_html_url',
add_query_arg(
'_llms_cert_auth',
$token,
get_permalink( $certificate_id )
),
$certificate_id
);
// Perform the request.
$req = wp_safe_remote_get(
$url,
array(
'sslverify' => false,
)
);
// Delete the token after the request.
delete_post_meta( $certificate_id, '_llms_auth_nonce', $token );
// Error.
if ( is_wp_error( $req ) ) {
return $req;
}
return wp_remote_retrieve_body( $req );
}
}
================================================
FILE: includes/class.llms.comments.php
================================================
<?php
/**
* LLMS_Comments class file.
*
* @package LifterLMS/Classes
*
* @since 3.0.0
* @version 6.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Custom filters & actions for LifterLMS comments.
*
* This class owes a great debt to WooCommerce.
*
* @since 3.0.0
*/
class LLMS_Comments {
/**
* Transient key where calculated comment stats are stored.
*
* @var string
*/
protected static $count_transient_key = 'llms_count_comments';
/**
* Constructor.
*
* @since 3.37.12
* @since 6.6.0 Conditionally hook `wp_count_comments` filter.
*
* @return void
*/
public function __construct() {
// Secure order notes.
add_filter( 'comments_clauses', array( __CLASS__, 'exclude_order_comments' ), 10, 1 );
add_action( 'comment_feed_join', array( __CLASS__, 'exclude_order_comments_from_feed_join' ) );
add_action( 'comment_feed_where', array( __CLASS__, 'exclude_order_comments_from_feed_where' ) );
// Delete comments count cache whenever there is a new comment or a comment status changes.
add_action( 'wp_insert_comment', array( __CLASS__, 'delete_comments_count_cache' ) );
add_action( 'wp_set_comment_status', array( __CLASS__, 'delete_comments_count_cache' ) );
/**
* Remove order notes when counting comments on WP versions earlier than 6.0.
*
* @todo This filter can be safely deprecated once support is dropped for WordPress 6.0.
*/
if ( self::should_modify_comment_counts() ) {
add_filter( 'wp_count_comments', array( __CLASS__, 'wp_count_comments' ), 999, 2 );
}
}
/**
* Delete transient data when inserting new comments or updating comment status
*
* Next time wp_count_comments is called it'll be automatically regenerated
*
* @since 3.0.0
* @since 3.37.12 Use class variable to access the transient key name.
*
* @return void
*/
public static function delete_comments_count_cache() {
delete_transient( self::$count_transient_key );
}
/**
* Exclude order comments from queries and RSS.
*
* @since 3.0.0
* @since 3.37.12 Use strict comparison for `in_array()`.
*
* @param array $clauses Array of SQL clauses.
* @return array
*/
public static function exclude_order_comments( $clauses ) {
global $wpdb, $typenow;
// Allow queries when in the admin.
if ( is_admin() && in_array( $typenow, array( 'llms_order' ), true ) && current_user_can( apply_filters( 'lifterlms_admin_order_access', 'manage_options' ) ) ) {
return $clauses;
}
if ( ! $clauses['join'] ) {
$clauses['join'] = '';
}
if ( ! strstr( $clauses['join'], "JOIN $wpdb->posts" ) ) {
$clauses['join'] .= " LEFT JOIN $wpdb->posts ON comment_post_ID = $wpdb->posts.ID ";
}
if ( $clauses['where'] ) {
$clauses['where'] .= ' AND ';
}
$clauses['where'] .= " $wpdb->posts.post_type NOT IN ('" . implode( "','", array( 'llms_order' ) ) . "') ";
return $clauses;
}
/**
* Exclude order comments from queries and RSS.
*
* @since 3.0.0
*
* @param string $join SQL join clause.
* @return string
*/
public static function exclude_order_comments_from_feed_join( $join ) {
global $wpdb;
if ( ! strstr( $join, $wpdb->posts ) ) {
$join = " LEFT JOIN $wpdb->posts ON $wpdb->comments.comment_post_ID = $wpdb->posts.ID ";
}
return $join;
}
/**
* Exclude order comments from queries and RSS.
*
* @since 3.0.0
*
* @param string $where SQL where clause.
* @return string
*/
public static function exclude_order_comments_from_feed_where( $where ) {
global $wpdb;
if ( $where ) {
$where .= ' AND ';
}
$where .= " $wpdb->posts.post_type NOT IN ('" . implode( "','", array( 'llms_order' ) ) . "') ";
return $where;
}
/**
* Retrieve an array mapping database values to their human-readable meanings
*
* The array key is the value stored in the $wpdb->comments table for the `comment_approved` column.
*
* The array values are the equivalent value as expected by the return of the `wp_count_comments()` function.
*
* @since 3.37.12
*
* @return array
*/
protected static function get_approved_map() {
return array(
'0' => 'moderated',
'1' => 'approved',
'spam' => 'spam',
'trash' => 'trash',
'post-trashed' => 'post-trashed',
);
}
/**
* Retrieve order note comment counts.
*
* @since 3.37.12
*
* @return array[]
*/
protected static function get_note_counts() {
global $wpdb;
return $wpdb->get_results( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
"
SELECT comment_approved, COUNT( * ) AS num_comments
FROM {$wpdb->comments}
WHERE comment_type = 'llms_order_note'
GROUP BY comment_approved;
",
ARRAY_A
);
}
/**
* Remove order notes from an existing comment count stats object.
*
* This method accepts a stats object, generated by another plugin (like WooCommerce) or using core information
* from `get_comment_counts()` and then subtracts LifterLMS order note comments from the existing comment counts
* which would have included order notes in the counts.
*
* @since 3.37.12
*
* @todo This method can be safely deprecated once support is dropped for WordPress 6.0.
*
* @param stdClass $stats Comment stats object. See the return of LLMS_Comments::wp_comment_counts() for object details.
* @return stdClass See LLMS_Comments::wp_comment_counts() for return object details.
*/
protected static function modify_comment_stats( $stats ) {
$counts = self::get_note_counts();
$map = self::get_approved_map();
foreach ( (array) $counts as $row ) {
if ( ! in_array( $row['comment_approved'], array( 'post-trashed', 'trash', 'spam' ), true ) ) {
$stats->all -= $row['num_comments'];
$stats->total_comments -= $row['num_comments'];
}
if ( isset( $map[ $row['comment_approved'] ] ) ) {
$var = $map[ $row['comment_approved'] ];
$stats->$var -= $row['num_comments'];
}
}
set_transient( self::$count_transient_key, $stats );
return $stats;
}
/**
* Determines whether or not comment count modification is necessary.
*
* Since WordPress 6.0 the `get_comment_count()` function utilizes `get_comments()` whereas in earlier versions the counts
* are retrieved by a direct SQL query. This change means that the filter in this class on `comments_clauses` ensures that
* our comments we hide & don't count in the comments management UI are already excluded and we do not need to filter
* `wp_count_comments` to subtract our comments.
*
* @since 6.6.0
*
* @return boolean Returns `true` on WP earlier than 6.0 and `false` on 6.0 and later.
*/
private static function should_modify_comment_counts() {
global $wp_version;
return version_compare( $wp_version, '6.0-src', '<' );
}
/**
* Remove order notes from the count when counting comments
*
* This method is hooked to `wp_count_comments`, called by `wp_count_comments()`.
*
* It handles two potential scenarios:
*
* 1) No other plugins have run the filter and the incoming $stats is an empty array.
* In this scenario we'll utilize `get_comment_count()` to create a new $stats object
*
* 2) Another plugin has already generated a stats object and then incoming $stats is a stdClass.
*
* In either scenario we query the number of order notes and subtract this number from the existing
* comment counts.
*
* @since 3.0.0
* @since 3.37.12 Use strict comparisons.
* Fix issue encountered when $stats is an empty array.
* Modify the stats generation method.
* @since 6.6.0 Will throw `_doing_it_wrong()` when run on WP 6.0 or later and return the input `$stats` unchanged.
*
* @todo This method can be safely deprecated once support is dropped for WordPress 6.0.
*
* @param stdClass|array $stats Empty array or a stdClass of stats from another plugin.
* @param int $post_id WP Post ID. `0` indicates comment stats for the entire site.
* @return stdClass {
* The number of comments keyed by their status.
*
* @type int $approved The number of approved comments.
* @type int $moderated The number of comments awaiting moderation (a.k.a. pending).
* @type int $spam The number of spam comments.
* @type int $trash The number of trashed comments.
* @type int $post-trashed The number of comments for posts that are in the trash.
* @type int $total_comments The total number of non-trashed comments, including spam.
* @type int $all The total number of pending or approved comments.
* }
*/
public static function wp_count_comments( $stats, $post_id ) {
// If someone calls this directly on 6.0 or later notify them and return early.
if ( ! self::should_modify_comment_counts() ) {
_doing_it_wrong( __METHOD__, 'This method should not be called on WordPress 6.0 or later.', '6.6.0' );
return $stats;
}
// Don't modify when querying for a specific post.
if ( 0 !== $post_id ) {
return $stats;
}
// Return cached object if available.
$cached = get_transient( self::$count_transient_key );
if ( $cached ) {
return $cached;
}
// If $stats is empty, get a new object from the WP Core that we can modify.
if ( empty( $stats ) ) {
$stats = get_comment_count( $post_id );
// The keys in wp_count_comments() and get_comment_counts() don't match.
$stats['moderated'] = $stats['awaiting_moderation'];
unset( $stats['awaiting_moderation'] );
// Cast to an object.
$stats = (object) $stats;
}
// Otherwise modify the existing stats object.
return self::modify_comment_stats( $stats );
}
}
return new LLMS_Comments();
================================================
FILE: includes/class.llms.course.data.php
================================================
<?php
/**
* Query data about a course
*
* @package LifterLMS/Classes
*
* @since 3.15.0
* @version 5.10.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Query data about a course
*
* @since 3.15.0
* @since 3.30.3 Explicitly define class properties.
* @since 3.31.0 Extends LLMS_Abstract_Post_Data.
* @since 4.0.0 Remove previously deprecated class properties `$course` and `$course_id`.
*/
class LLMS_Course_Data extends LLMS_Abstract_Post_Data {
public $course_id;
public $course;
/**
* Constructor
*
* @since 3.15.0
*
* @param int $course_id WP Post ID of the course
*/
public function __construct( $course_id ) {
$this->course_id = $course_id;
$this->course = llms_get_post( $this->course_id );
parent::__construct( $course_id );
}
/**
* Retrieve an array of all post ids in the course
*
* Includes course id, all section ids, all lesson ids, and all quiz ids.
*
* @since 3.15.0
* @since 3.31.0 Use $this->post_id instead of deprecated $this->course_id.
*
* @return array
*/
private function get_all_ids() {
return array_merge(
array( $this->post_id ),
$this->post->get_sections( 'ids' ),
$this->post->get_lessons( 'ids' ),
$this->post->get_quizzes()
);
}
/**
* Retrieve # of course completions within the period
*
* @since 3.15.0
* @since 3.31.0 Use $this->post_id instead of deprecated $this->course_id.
*
* @param string $period Optional. Date period [current|previous]. Default is 'current'.
* @return int
*/
public function get_completions( $period = 'current' ) {
global $wpdb;
return $wpdb->get_var(
$wpdb->prepare(
"
SELECT DISTINCT COUNT( user_id )
FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE meta_value = 'yes'
AND meta_key = '_is_complete'
AND post_id = %d
AND updated_date BETWEEN %s AND %s
",
$this->post_id,
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);// db call ok; no-cache ok.
}
/**
* Retrieve # of course enrollments within the period
*
* @since 3.15.0
* @since 3.31.0 Use $this->post_id instead of deprecated $this->course_id.
*
* @param string $period Optional. Date period [current|previous]. Default is 'current'.
* @return int
*/
public function get_enrollments( $period = 'current' ) {
global $wpdb;
return $wpdb->get_var(
$wpdb->prepare(
"
SELECT DISTINCT COUNT( user_id )
FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE meta_value = 'yes'
AND meta_key = '_start_date'
AND post_id = %d
AND updated_date BETWEEN %s AND %s
",
$this->post_id,
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);// db call ok; no-cache ok.
}
/**
* Retrieve # of engagements related to the course awarded within the period
*
* @since 3.15.0
*
* @param string $type Engagement type [email|certificate|achievement].
* @param string $period Optional. Date period [current|previous]. Default is 'current'.
* @return int
*/
public function get_engagements( $type, $period = 'current' ) {
global $wpdb;
$ids = implode( ',', array_map( 'absint', $this->get_all_ids() ) );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $wpdb->get_var(
$wpdb->prepare(
"
SELECT DISTINCT COUNT( user_id )
FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE meta_key = %s
AND post_id IN ( {$ids} )
AND updated_date BETWEEN %s AND %s
",
'_' . $type,
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);// db call ok; no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
/**
* Retrieves and returns the number of lessons completed within the period.
*
* @since 3.15.0
* @since 5.10.0 Fixed issue when the course has no lessons.
*
* @param string $period Optional. Date period [current|previous]. Default is 'current'.
* @return int
*/
public function get_lesson_completions( $period = 'current' ) {
global $wpdb;
$lesson_ids = $this->post->get_lessons( 'ids' );
// Return early for courses without any lessons.
if ( empty( $lesson_ids ) ) {
return 0;
}
$lessons = implode( ',', array_map( 'absint', $this->post->get_lessons( 'ids' ) ) );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $wpdb->get_var(
$wpdb->prepare(
"
SELECT COUNT( * )
FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE meta_value = 'yes'
AND meta_key = '_is_complete'
AND post_id IN ( {$lessons} )
AND updated_date BETWEEN %s AND %s
",
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);// db call ok; no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
/**
* Retrieve # of orders placed for the course within the period
*
* @since 3.15.0
* @since 4.21.0 Fixed order params passed to the `$this->orders_query()` method.
*
* @param string $period Optional. Date period [current|previous]. Default is 'current'.
* @return int
*/
public function get_orders( $period = 'current' ) {
$query = $this->orders_query(
1,
array(
array(
'after' => $this->get_date( $period, 'start' ),
'before' => $this->get_date( $period, 'end' ),
'inclusive' => true,
),
)
);
return $query->found_posts;
}
/**
* Retrieve total amount of transactions related to orders for the course completed within the period
*
* @since 3.15.0
*
* @param string $period Date period [current|previous].
* @return float
*/
public function get_revenue( $period ) {
$query = $this->orders_query( -1 );
$order_ids = wp_list_pluck( $query->posts, 'ID' );
$revenue = 0;
if ( $order_ids ) {
$order_ids = implode( ',', array_map( 'absint', $order_ids ) );
global $wpdb;
$revenue = $wpdb->get_var(
$wpdb->prepare(
"SELECT SUM( m2.meta_value )
FROM $wpdb->posts AS p
LEFT JOIN $wpdb->postmeta AS m1 ON m1.post_id = p.ID AND m1.meta_key = '_llms_order_id' -- join for the ID
LEFT JOIN $wpdb->postmeta AS m2 ON m2.post_id = p.ID AND m2.meta_key = '_llms_amount'-- get the actual amounts
WHERE p.post_type = 'llms_transaction'
AND p.post_status = 'llms-txn-succeeded'
AND m1.meta_value IN ({$order_ids})
AND p.post_modified BETWEEN %s AND %s
;",
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);// db call ok; no-cache ok.
if ( is_null( $revenue ) ) {
$revenue = 0;
}
}
return apply_filters( 'llms_course_data_get_revenue', $revenue, $period, $this );
}
/**
* Retrieve the number of unenrollments on a given date.
*
* @since 3.15.0
*
* @param tring $period Optional. Date period [current|previous]. Default 'current'.
* @return int
*/
public function get_unenrollments( $period = 'current' ) {
global $wpdb;
return $wpdb->get_var(
$wpdb->prepare(
"
SELECT DISTINCT COUNT( user_id )
FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE meta_value != 'enrolled'
AND meta_key = '_status'
AND post_id = %d
AND updated_date BETWEEN %s AND %s
",
$this->post_id,
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);// db call ok; no-cache ok.
}
/**
* Execute a WP Query to retrieve orders within the given date range
*
* @since 3.15.0
* @since 4.21.0 Fixed the post status for completed orders.
*
* @param int $num_orders Optional. Number of orders to retrieve. Default is `1`.
* @param array $dates Optional. Date range (passed to WP_Query['date_query']). Default is empty array.
* @return WP_Query
*/
private function orders_query( $num_orders = 1, $dates = array() ) {
$args = array(
'post_type' => 'llms_order',
'post_status' => array( 'llms-active', 'llms-completed' ),
'posts_per_page' => $num_orders,
'meta_key' => '_llms_product_id',
'meta_value' => $this->post_id,
);
if ( ! empty( $dates ) ) {
$args['date_query'] = $dates;
}
return new WP_Query( $args );
}
}
================================================
FILE: includes/class.llms.data.php
================================================
<?php
/**
* Retrieve data sets used by various other classes and functions
*
* @package LifterLMS/Classes
*
* @since 3.0.0
* @version 4.13.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Data
*
* @since 3.0.0
*/
class LLMS_Data {
/**
* Get the data data
*
* @since 3.0.0
* @since 3.17.0 Added browser/os data section.
* @since 4.13.0 Added constant data.
*
* @param string $dataset Dataset to retrieve data for [tracker|system_report].
* @param string $format Data return format (unused for unrecalled reasons).
* @return array
*/
public static function get_data( $dataset, $format = 'array' ) {
$data = array();
// Add admin email for tracker requests.
if ( 'tracker' === $dataset ) {
$data['email'] = apply_filters( 'llms_get_data_admin_email', get_option( 'admin_email' ) );
}
// General data.
$data['url'] = home_url();
// Wp info.
$data['wordpress'] = self::get_wp_data();
// Llms settings.
$data['settings'] = self::get_llms_settings();
if ( 'system_report' === $dataset ) {
// Constants.
$data['constants'] = self::get_constants_data();
}
// Gateways.
$data['gateways'] = self::get_gateway_data();
// Server info.
$data['server'] = self::get_server_data();
// Browser / os.
$data['browser'] = self::get_browser_data();
// Theme info.
$data['theme'] = self::get_theme_data();
// Plugin info.
$data['plugins'] = self::get_plugin_data();
if ( 'tracker' === $dataset ) {
// Published content type counts.
$data['post_counts'] = self::get_post_type_counts();
// User data.
$data['user_counts'] = self::get_user_counts();
// Count student engagements.
$data['engagement_counts'] = self::get_engagement_counts();
// Order data.
$data['order_counts'] = self::get_order_counts();
}
$data['integrations'] = self::get_integrations_data();
$data['template_overrides'] = self::get_templates_data();
return $data;
}
/**
* add browser and os info to the system report
*
* @since 3.17.0
* @since 3.35.0 Sanitize `$_SERVER` data.
*
* @return array
*/
private static function get_browser_data() {
$data = array(
'HTTP_USER_AGENT' => ! empty( $_SERVER['HTTP_USER_AGENT'] ) ? sanitize_text_field( wp_unslash( $_SERVER['HTTP_USER_AGENT'] ) ) : '',
);
return $data;
}
/**
* Retrieve data about LifterLMS constants
*
* @since 4.13.0
*
* @return array
*/
private static function get_constants_data() {
$data = array(
'LLMS_REMOVE_ALL_DATA' => 'undefined',
'LLMS_REST_DISABLE' => 'undefined',
'LLMS_SITE_FEATURE_RECURRING_PAYMENTS' => 'undefined',
'LLMS_SITE_IS_CLONE' => 'undefined',
);
foreach ( $data as $constant => &$value ) {
if ( defined( $constant ) ) {
$value = constant( $constant ) ? 'true' : 'false';
}
}
return $data;
}
/**
* Get student engagement counts for various llms interactions
*
* @since 3.0.0
*
* @return array
*/
private static function get_engagement_counts() {
global $wpdb;
$data = array();
$data['certificates'] = absint( $wpdb->get_var( "SELECT COUNT( * ) FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_key = '_certificate_earned'" ) );
$data['achievements'] = absint( $wpdb->get_var( "SELECT COUNT( * ) FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_key = '_achievement_earned'" ) );
$enrollments = $wpdb->get_results( "SELECT meta_id FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_key = '_status' AND ( meta_value = 'Enrolled' OR meta_value = 'enrolled' ) GROUP BY user_id, post_id" );
$data['enrollments'] = count( $enrollments );
$data['course_completions'] = absint( $wpdb->get_var( "SELECT COUNT( * ) FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_key = '_is_complete' AND meta_value = 'yes' " ) );
return $data;
}
/**
* Retrieve metadata from a file.
* Copied from WCs get_file_version which is based on WP Core's get_file_data function.
*
* @since 3.11.2
*
* @param string $file Path to the file.
* @return string
*/
private static function get_file_version( $file ) {
// Avoid notices if file does not exist.
if ( ! file_exists( $file ) ) {
return '';
}
// We don't need to write to the file, so just open for reading..
$fp = fopen( $file, 'r' );
// Pull only the first 8kiB of the file in..
$file_data = fread( $fp, 8192 );
// PHP will close file handle, but we are good citizens..
fclose( $fp );
// Make sure we catch CR-only line endings..
$file_data = str_replace( "\r", "\n", $file_data );
$version = '';
if ( preg_match( '/^[ \t\/*#@]*' . preg_quote( '@version', '/' ) . '(.*)$/mi', $file_data, $match ) && $match[1] ) {
$version = _cleanup_header_comment( $match[1] );
}
return $version;
}
/**
* Get data about llms payment gateways
*
* @since 3.0.0
* @since 3.17.8 Unknown.
*
* @return array
*/
private static function get_gateway_data() {
$data = array();
foreach ( llms()->payment_gateways()->get_payment_gateways() as $obj ) {
$data[ $obj->get_admin_title() ] = $obj->is_enabled() ? 'Enabled' : 'Disabled';
if ( $obj->supports( 'test_mode' ) ) {
$data[ $obj->get_admin_title() . '_test_mode' ] = $obj->is_test_mode_enabled() ? 'Enabled' : 'Disabled';
}
$data[ $obj->get_admin_title() . '_logging' ] = $obj->get_logging_enabled();
$data[ $obj->get_admin_title() . '_order' ] = $obj->get_display_order();
}
return $data;
}
/**
* Get data about existing llms integrations
*
* @since 3.0.0
* @since 3.17.8 Unknown.
*
* @return array
*/
private static function get_integrations_data() {
$data = array();
$integrations = llms()->integrations();
foreach ( $integrations->integrations() as $obj ) {
if ( method_exists( $obj, 'is_available' ) ) {
$data[ $obj->title ] = $obj->is_available() ? 'Yes' : 'No';
}
}
return $data;
}
/**
* Get LifterLMS settings
*
* @since 3.0.0
* @since 3.24.0 Unknown.
*
* @return array
*/
private static function get_llms_settings() {
$data = array();
$data['version'] = llms()->version;
$data['db_version'] = get_option( 'lifterlms_db_version' );
$data['course_catalog'] = self::get_page_data( 'lifterlms_shop_page_id' );
$data['membership_catalog'] = self::get_page_data( 'lifterlms_memberships_page_id' );
$data['student_dashboard'] = self::get_page_data( 'lifterlms_myaccount_page_id' );
$data['checkout_page'] = self::get_page_data( 'lifterlms_checkout_page_id' );
$data['course_catalog_per_page'] = get_option( 'lifterlms_shop_courses_per_page' );
$data['course_catalog_sorting'] = get_option( 'lifterlms_shop_ordering' );
$data['membership_catalog_per_page'] = get_option( 'lifterlms_memberships_per_page' );
$data['membership_catalog_sorting'] = get_option( 'lifterlms_memberships_ordering' );
$data['site_membership'] = self::get_page_data( 'lifterlms_membership_required' );
$data['courses_endpoint'] = get_option( 'lifterlms_myaccount_courses_endpoint' );
$data['edit_endpoint'] = get_option( 'lifterlms_myaccount_edit_account_endpoint' );
$data['lost_password_endpoint'] = get_option( 'lifterlms_myaccount_lost_password_endpoint' );
$data['vouchers_endpoint'] = get_option( 'lifterlms_myaccount_redeem_vouchers_endpoint' );
$data['autogenerate_username'] = get_option( 'lifterlms_registration_generate_username', 'no' );
$data['password_strength_meter'] = get_option( 'lifterlms_registration_password_strength', 'no' );
$data['minimum_password_strength'] = get_option( 'lifterlms_registration_password_min_strength' );
$data['terms_required'] = get_option( 'lifterlms_registration_require_agree_to_terms', 'no' );
$data['terms_page'] = self::get_page_data( 'lifterlms_terms_page_id' );
$data['checkout_names'] = get_option( 'lifterlms_user_info_field_names_checkout_visibility' );
$data['checkout_address'] = get_option( 'lifterlms_user_info_field_address_checkout_visibility' );
$data['checkout_phone'] = get_option( 'lifterlms_user_info_field_phone_checkout_visibility' );
$data['checkout_email_confirmation'] = get_option( 'lifterlms_user_info_field_email_confirmation_checkout_visibility', 'no' );
$data['open_registration'] = get_option( 'lifterlms_enable_myaccount_registration', 'no' );
$data['registration_names'] = get_option( 'lifterlms_user_info_field_names_registration_visibility' );
$data['registration_address'] = get_option( 'lifterlms_user_info_field_address_registration_visibility' );
$data['registration_phone'] = get_option( 'lifterlms_user_info_field_phone_registration_visibility' );
$data['registration_voucher'] = get_option( 'lifterlms_voucher_field_registration_visibility' );
$data['registration_email_confirmation'] = get_option( 'lifterlms_user_info_field_email_confirmation_registration_visibility', 'no' );
$data['account_names'] = get_option( 'lifterlms_user_info_field_names_account_visibility' );
$data['account_address'] = get_option( 'lifterlms_user_info_field_address_account_visibility' );
$data['account_phone'] = get_option( 'lifterlms_user_info_field_phone_account_visibility' );
$data['account_email_confirmation'] = get_option( 'lifterlms_user_info_field_email_confirmation_account_visibility', 'no' );
$data['confirmation_endpoint'] = get_option( 'lifterlms_myaccount_confirm_payment_endpoint' );
$data['force_ssl_checkout'] = get_option( 'lifterlms_checkout_force_ssl' );
$data['country'] = get_lifterlms_country();
$data['currency'] = get_lifterlms_currency();
$data['currency_position'] = get_option( 'lifterlms_currency_position' );
$data['thousand_separator'] = get_option( 'lifterlms_thousand_separator' );
$data['decimal_separator'] = get_option( 'lifterlms_decimal_separator' );
$data['decimals'] = get_option( 'lifterlms_decimals' );
$data['trim_zero_decimals'] = get_option( 'lifterlms_trim_zero_decimals', 'no' );
$data['recurring_payments'] = ( LLMS_Site::get_feature( 'recurring_payments' ) ) ? 'yes' : 'no';
$data['email_from_address'] = get_option( 'lifterlms_email_from_address' );
$data['email_from_name'] = get_option( 'lifterlms_email_from_name' );
$data['email_footer_text'] = get_option( 'lifterlms_email_footer_text' );
$data['email_header_image'] = get_option( 'lifterlms_email_header_image' );
$data['cert_bg_width'] = get_option( 'lifterlms_certificate_bg_img_width' );
$data['cert_bg_height'] = get_option( 'lifterlms_certificate_bg_img_height' );
$data['cert_legacy_compat'] = get_option( 'lifterlms_certificate_legacy_image_size' );
return $data;
}
/**
* Get number of orders per order status
*
* @since 3.0.0
*
* @return array
*/
private static function get_order_counts() {
$data = array();
$orders = wp_count_posts( 'llms_order' );
foreach ( llms_get_order_statuses() as $status => $name ) {
$data[ $status ] = absint( $orders->{$status} );
}
return $data;
}
/**
* Get an option that should return a page ID and return the page name and ID as a formatted string
*
* @since 3.0.0
*
* @param string $option Option name in the wp_options table.
* @return string
*/
private static function get_page_data( $option ) {
$id = get_option( $option );
if ( absint( $id ) ) {
return sprintf( '%1$s (#%2$d) [%3$s]', get_the_title( $id ), $id, get_permalink( $id ) );
}
return 'Not Set'; // Don't translate this or you won't be able to read it smartypants.
}
/**
* get an array of plugin data, sorted into two arrays (active and inactive)
*
* @since 3.0.0
*
* @return array
*/
private static function get_plugin_data() {
// Ensure we have our plugin function.
if ( ! function_exists( 'get_plugins' ) ) {
include ABSPATH . '/wp-admin/includes/plugin.php';
}
$plugins = get_plugins();
$active = array();
$inactive = array();
foreach ( get_plugins() as $path => $data ) {
if ( is_plugin_active( $path ) ) {
$active[ $path ] = $data;
} else {
$inactive[ $path ] = $data;
}
}
return array(
'active' => $active,
'inactive' => $inactive,
);
}
/**
* Retrieve the number of published posts for various LLMS post types
*
* @since 3.0.0
*
* @return array
*/
private static function get_post_type_counts() {
$data = array();
$posts = array(
'course',
'section',
'lesson',
'llms_quiz',
'llms_question',
'llms_review',
'llms_membership',
'llms_access_plan',
'llms_coupon',
'llms_voucher',
'llms_engagement',
'llms_achievement',
'llms_certificate',
'llms_email',
);
foreach ( $posts as $post_type ) {
$count = wp_count_posts( $post_type );
$data[ str_replace( 'llms_', '', $post_type ) ] = absint( $count->publish );
}
return $data;
}
/**
* Get PHP & Server Data
*
* @since 3.0.0
* @since 3.35.0 Sanitize `$_SERVER` data.
*
* @return array
*/
private static function get_server_data() {
global $wpdb;
$data = array();
if ( function_exists( 'ini_get' ) ) {
$data['php_max_input_vars'] = ini_get( 'max_input_vars' );
$data['php_memory_limit'] = ini_get( 'memory_limit' );
$data['php_post_max_size'] = ini_get( 'post_max_size' );
$data['php_time_limt'] = ini_get( 'max_execution_time' );
$data['php_suhosin'] = extension_loaded( 'suhosin' ) ? 'Yes' : 'No';
}
$data['mysql_version'] = $wpdb->db_version();
$data['php_curl'] = function_exists( 'curl_init' ) ? 'Yes' : 'No';
$data['php_default_timezone'] = date_default_timezone_get();
$data['php_fsockopen'] = function_exists( 'fsockopen' ) ? 'Yes' : 'No';
$data['php_max_upload_size'] = size_format( wp_max_upload_size() );
$data['php_soap'] = class_exists( 'SoapClient' ) ? 'Yes' : 'No';
if ( function_exists( 'phpversion' ) ) {
$data['php_version'] = phpversion();
}
if ( isset( $_SERVER['SERVER_SOFTWARE'] ) && ! empty( $_SERVER['SERVER_SOFTWARE'] ) ) {
$data['software'] = ! empty( $_SERVER['SERVER_SOFTWARE'] ) ? sanitize_text_field( wp_unslash( $_SERVER['SERVER_SOFTWARE'] ) ) : '';
}
$data['wp_memory_limit'] = WP_MEMORY_LIMIT;
ksort( $data );
return $data;
}
/**
* Retrieve information about template overrides
*
* @since 3.11.2
*
* @return array
*/
private static function get_templates_data() {
$path = llms()->plugin_path() . '/templates/';
$templates = array_merge( glob( $path . '*.php' ), glob( $path . '**/*.php' ) );
$overrides = array();
foreach ( $templates as $file ) {
$name = str_replace( $path, '', $file );
$found = llms_get_template_override( $name );
if ( $found ) {
$overrides[] = array(
'core_version' => self::get_file_version( $file ),
'location' => $found,
'version' => self::get_file_version( $found . $name ),
'template' => $name,
);
}
}
return $overrides;
}
/**
* Get an array of theme data
*
* @since 3.0.0
* @since 3.11.2 Unknown.
*
* @return array
*/
private static function get_theme_data() {
$data = array();
$theme_data = wp_get_theme();
$data['name'] = $theme_data->get( 'Name' );
$data['version'] = $theme_data->get( 'Version' );
$data['themeuri'] = $theme_data->get( 'ThemeURI' );
$data['authoruri'] = $theme_data->get( 'AuthorURI' );
$data['template'] = $theme_data->get( 'Template' );
$data['child_theme'] = is_child_theme() ? 'Yes' : 'No';
$data['llms_support'] = ( ! current_theme_supports( 'lifterlms' ) ) ? 'No' : 'Yes';
return $data;
}
/**
* Det the number of users and users by role registered on the site
*
* @since 3.0.0
*
* @return array
*/
private static function get_user_counts() {
$data = array();
$users = count_users();
$data = $users['avail_roles'];
$data['total'] = $users['total_users'];
return $data;
}
/**
* Get some WP core settings and info
*
* @since 3.0.0
* @since 3.24.0 Unknown.
*
* @return array
*/
private static function get_wp_data() {
$data = array();
$data['home_url'] = get_home_url();
$data['site_url'] = get_site_url();
$data['login_url'] = wp_login_url();
$data['version'] = get_bloginfo( 'version' );
$data['debug_mode'] = ( defined( 'WP_DEBUG' ) && WP_DEBUG ) ? 'Yes' : 'No';
$data['debug_log'] = ( defined( 'WP_DEBUG_LOG' ) && WP_DEBUG_LOG ) ? 'Yes' : 'No';
$data['debug_display'] = ( defined( 'WP_DEBUG_DISPLAY' ) && WP_DEBUG_DISPLAY ) ? 'Yes' : 'No';
$data['locale'] = get_locale();
$data['multisite'] = is_multisite() ? 'Yes' : 'No';
$data['page_for_posts'] = self::get_page_data( 'page_for_posts' );
$data['page_on_front'] = self::get_page_data( 'page_on_front' );
$data['permalink_structure'] = get_option( 'permalink_structure' );
$data['show_on_front'] = get_option( 'show_on_front' );
$data['wp_cron'] = ! ( defined( 'DISABLE_WP_CRON' ) && DISABLE_WP_CRON ) ? 'Yes' : 'No';
return $data;
}
}
================================================
FILE: includes/class.llms.date.php
================================================
<?php
/**
* Dates Class
*
* Manages formatting dates for I/O and display
*
* @package LifterLMS/Classes
*
* @since Unknown
* @version 3.24.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Date class
*
* @since Unknown
* @since 3.24.0 Unknown.
*/
class LLMS_Date {
/**
* Set date to dd/mm/yyyy
* Optional type value for converting AU date format
* Converts any type of date format
*
* @param [date] $date [datestring]
* @return [date] [datestring]
*/
public static function pretty_date( $date, $type = '' ) {
if ( 'au' === $type ) {
return date( 'd/m/Y', strtotime( $date ) );
} else {
return date( 'm/d/Y', strtotime( $date ) );
}
}
/**
* Date filter options for analytics
*
* @return [array] [array of date filters]
*/
public static function date_filters() {
$filters = array(
'none' => 'Enter Specific Dates',
'week' => 'Last 7 Days',
'month' => 'Current Month',
'quarter' => 'Current Quarter',
'year' => 'Current Year',
);
return $filters;
}
/**
* Converts date to yyyymmdd
* Converts any type of date format
* Optional field type accepts 'au' to convert Australian dd/mm/yyyy date format
* Used for date db storage
*
* @param [date] $date [datestring]
* @param [type] $type [optional field for managing AU date conversions]
* @return [date] [datestring]
*/
public static function db_date( $date, $type = '' ) {
if ( 'au' === $type ) {
list($d, $m, $y) = preg_split( '/\//', $date );
$date = sprintf( '%4d-%02d-%02d', $y, $m, $d );
} else {
$date = date( 'Y-m-d', strtotime( $date ) );
}
return $date;
}
/**
* Get date range by filter
*
* Calculates the date range based on the filter value selected.
*
* @param string $filter
* @return array $date_range
*/
public static function get_date_range_by_filter( $filter ) {
$today = current_time( 'Y-m-d' );
$current_month = date( 'm', strtotime( $today ) );
$current_year = date( 'Y', strtotime( $today ) );
if ( 'week' === $filter ) {
$start_date = self::db_date( $today . '- 7 days' );
$end_date = self::db_date( $today );
} elseif ( 'month' === $filter ) {
$start_date = date( 'Y-m-01', strtotime( $today ) );
$end_date = date( 'Y-m-t', strtotime( $today ) );
} elseif ( 'quarter' === $filter ) {
if ( $current_month >= 1 && $current_month <= 3 ) {
$start_date = $current_year . '-01-01';
$end_date = $current_year . '-03-31';
} elseif ( $current_month >= 4 && $current_month <= 6 ) {
$start_date = $current_year . '-04-01';
$end_date = $current_year . '-06-30';
} elseif ( $current_month >= 7 && $current_month <= 9 ) {
$start_date = $current_year . '-07-01';
$end_date = $current_year . '-09-30';
} elseif ( $current_month >= 10 && $current_month <= 12 ) {
$start_date = $current_year . '-10-01';
$end_date = ( $current_year + 1 ) . '-01-01';
}
} elseif ( 'year' === $filter ) {
$start_date = $current_year . '-01-01';
$end_date = ( $current_year + 1 ) . '-01-01';
}
$date_range = array(
'start_date' => $start_date,
'end_date' => $end_date,
);
return $date_range;
}
/**
* Query Filter for for last 7 days
* Appends AND statement to WP_Query WHERE clause
* Only retrieves posts created
*
* @param string $where [WP_Query Where clause]
* @return [string] [modified where clause]
*/
public function last_seven_days( $where = '' ) {
global $wpdb;
$where .= $wpdb->prepare( ' AND post_date > %s', date( 'Y-m-d', strtotime( '-7 days' ) ) );
return $where;
}
public static function get_last_login_date( $user_id ) {
$date = get_user_meta( $user_id, 'llms_last_login', true );
if ( $date ) {
return date( 'd.m.Y H:i:s', get_user_meta( $user_id, 'llms_last_login', true ) );
} else {
return false;
}
}
/**
* @todo deprecate
*/
public static function get_localized_date_string() {
return strftime( _x( '%1$b %2$d, %3$Y @ %4$I:%5$M %6$p', 'Localized Order DateTime', 'lifterlms' ) ); // phpcs:ignore Generic.PHP.DeprecatedFunctions.Deprecated -- Unused deprecated function to be removed shortly.
}
public static function convert_to_hours_minutes_string( $time ) {
$decimal_part = $time - floor( $time );
settype( $time, 'integer' );
if ( $time < 1 ) {
return;
}
$hours = floor( $time / 60 );
$minutes = ( $time % 60 );
$seconds = ( 60 * $decimal_part );
$hours_string = '';
$minutes_string = '';
$seconds_string = '';
// Determine hours vs hour in string.
if ( ! empty( $hours ) ) {
if ( $hours > 1 ) {
$hour_desc = __( 'hours', 'lifterlms' );
} else {
$hour_desc = __( 'hour', 'lifterlms' );
}
$hours_string = sprintf( __( '%1$d %2$s ', 'lifterlms' ), $hours, $hour_desc );
} else {
if ( ! empty( $seconds ) ) {
if ( $seconds > 1 ) {
$second_desc = __( 'seconds', 'lifterlms' );
} else {
$second_desc = __( 'second', 'lifterlms' );
}
$seconds_string = sprintf( ' %d %s', $seconds, $second_desc );
}
}
// Determine minutes vs minute in string.
if ( ! empty( $minutes ) ) {
if ( $minutes > 1 ) {
$minute_desc = __( 'minutes', 'lifterlms' );
} else {
$minute_desc = __( 'minute', 'lifterlms' );
}
$minutes_string = sprintf( ' %d %s', $minutes, $minute_desc );
}
return $hours_string . $minutes_string . $seconds_string;
}
}
return new LLMS_Date();
================================================
FILE: includes/class.llms.dot.com.api.php
================================================
<?php
/**
* Interact with the LifterLMS.com API
*
* @package LifterLMS/Classes
*
* @since 3.22.0
* @version 3.22.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Dot_Com_API
*
* @since 3.22.0
*/
class LLMS_Dot_Com_API extends LLMS_Abstract_API_Handler {
/**
* Send requests in JSON format
*
* @var bool
*/
protected $is_json = false;
/**
* Determines if it's a request to the .com REST api
*
* @var bool
*/
protected $is_rest = true;
/**
* Construct an API call, parameters are passed to private `call()` function
*
* @param stirng $resource url endpoint or resource to make a request to
* @param array $data array of data to pass in the body of the request
* @param string $method method of request (POST, GET, DELETE, PUT, etc...)
* @param bool $is_rest if true adds wp-json rest to request url, otherwise requests to site base
* @return void
* @since 3.22.0
* @version 3.22.0
*/
public function __construct( $resource, $data, $method = null, $is_rest = true ) {
$this->is_rest = $is_rest;
parent::__construct( $resource, $data, $method );
}
/**
* Determine if the current request is a rest request
*
* @return bool
* @since 3.22.0
* @version 3.22.0
*/
public function is_rest_request() {
return $this->is_rest;
}
/**
* Parse the body of the response and set a success/error
*
* @param array $response response data
* @return void
* @since 3.22.0
* @version 3.22.0
*/
protected function parse_response( $response ) {
$body = json_decode( wp_remote_retrieve_body( $response ), true );
if ( isset( $response['response'] ) && isset( $response['response']['code'] ) && ! in_array( $response['response']['code'], array( 200, 201 ) ) ) {
$msg = isset( $body['message'] ) ? $body['message'] : $response['response']['message'];
$this->set_error( $msg, isset( $body['code'] ) ? $body['code'] : $response['response']['code'], $body );
} else {
$this->set_result( $body );
}
}
/**
* Set request body
*
* @param array $data request body
* @param string $method request method
* @param string $resource requested resource
* @return array
* @since 3.22.0
* @version 3.22.0
*/
protected function set_request_body( $data, $method, $resource ) {
return apply_filters( 'llms_dot_com_api_request_body', $data, $method, $resource, $this );
}
/**
* Set request headers
*
* @param array $headers default request headers
* @param string $resource request resource
* @param string $method request method
* @return array
* @since 3.22.0
* @version 3.22.0
*/
protected function set_request_headers( $headers, $resource, $method ) {
return apply_filters( 'llms_dot_com_api_request_headers', $headers, $resource, $method, $this );
}
/**
* Set the request URL
*
* @param string $resource requested resource
* @param string $method request method
* @return string
* @since 3.22.0
* @version 3.22.0
*/
protected function set_request_url( $resource, $method ) {
$url = 'https://lifterlms.com';
if ( $this->is_rest_request() ) {
$url .= '/wp-json/llms/v3';
}
return apply_filters( 'llms_dot_com_api_request_url', $url . $resource, $resource, $method, $this );
}
/**
* Set the request User Agent
* Can be overridden by extending classes when necessary
*
* @param string $user_agent default user agent (LifterLMS {$version})
* @param string $resource requested resource
* @param string $method request method
* @return string
* @since 3.22.0
* @version 3.22.0
*/
protected function set_user_agent( $user_agent, $resource, $method ) {
return sprintf( 'LifterLMS/%1$s (%2$s)', LLMS_VERSION, get_site_url() );
}
}
================================================
FILE: includes/class.llms.emails.php
================================================
<?php
/**
* LifterLMS Emails Class
*
* Manages finding the appropriate email.
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Emails
*
* @since 1.0.0
* @since 3.8.0 Unknown.
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
* @since 6.0.0 Removed the deprecated `LLMS_Emails::$_instance` property.
*/
class LLMS_Emails {
use LLMS_Trait_Singleton;
/**
* Class names of all emails
*
* @var string[]
*/
public $emails;
/**
* Constructor
*
* Initializes class.
* Adds actions to trigger emails off of events.
*
* @since 1.0.0
* @since 3.8.0 Unknown.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
private function __construct() {
// Template functions.
llms()->include_template_functions();
// Email base class.
$this->emails['generic'] = 'LLMS_Email';
// Email child classes.
$this->emails['engagement'] = 'LLMS_Email_Engagement';
$this->emails['reset_password'] = 'LLMS_Email_Reset_Password';
$this->emails = apply_filters( 'lifterlms_email_classes', $this->emails );
}
/**
* Get a string of inline CSS to add to an email button
*
* Use {button_style} merge code to output in HTML emails.
*
* @since 3.8.0
*
* @return string
*/
public function get_button_style() {
/**
* Filters the default email button CSS rules
*
* @since 3.8.0
*
* @param array $email_button_css Associative array of the type css-property => definition.
*/
$rules = apply_filters(
'llms_email_button_css',
array(
'background-color' => $this->get_css( 'button-background-color', false ),
'color' => $this->get_css( 'button-font-color', false ),
'display' => 'inline-block',
'padding' => '10px 15px',
'text-decoration' => 'none',
)
);
$styles = '';
foreach ( $rules as $rule => $style ) {
$styles .= sprintf( '%1$s:%2$s !important;', $rule, $style );
}
return $styles;
}
/**
* Get css rules specific to the the email templates
*
* @since 3.8.0
* @since 5.2.0 Early bail if no rule is provided.
*
* @param string $rule Optional. Name of the css rule. Default is empty string.
* If not provided an empty string will be returned/echoed.
* @param boolean $echo Optional. If true, echo the definition. Default is `true`.
* @return string
*/
public function get_css( $rule = '', $echo = true ) {
if ( empty( $rule ) ) {
return '';
}
/**
* Filters the default email CSS rules
*
* @since 3.8.0
*
* @param array $email_css Associative array of the type css-property => definition.
*/
$css = apply_filters(
'llms_email_css',
array(
'background-color' => '#f6f6f6',
'border-radius' => '3px',
'button-background-color' => '#2295ff',
'button-font-color' => '#ffffff',
'divider-color' => '#cecece',
'font-color' => '#222222',
'font-family' => 'sans-serif',
'font-size' => '15px',
'font-size-small' => '13px',
'heading-background-color' => '#2295ff',
'heading-font-color' => '#ffffff',
'main-color' => '#2295ff',
'max-width' => '580px',
)
);
if ( isset( $css[ $rule ] ) ) {
if ( $echo ) {
echo esc_attr( $css[ $rule ] );
}
return $css[ $rule ];
}
}
/**
* Get an HTML divider for use in HTML emails
*
* Can use shortcode {divider} to output in any email.
*
* @since 3.8.0
*
* @return string
*/
public function get_divider_html() {
return '<div style="height:1px;width:100%;margin:15px auto;background-color:' . $this->get_css( 'divider-color', false ) . '"></div>';
}
/**
* Retrieve a new instance of an email
*
* @since 3.8.0
*
* @param string $id Email id.
* @param array $args Optional arguments to pass to the email.
* @return LLMS_Email
*/
public function get_email( $id, $args = array() ) {
$emails = $this->get_emails();
// If we have an email matching the ID, return an instance of that email class.
if ( isset( $emails[ $id ] ) ) {
return new $emails[ $id ]( $args );
}
// Otherwise return a generic email and set the ID to be the requested ID.
/** @var LLMS_Email $generic */
$generic = new $emails['generic']( $args );
$generic->set_id( $id );
return $generic;
}
/**
* Get all email objects
*
* @since 1.0.0
*
* @return string[] Array of all email class names.
*/
public function get_emails() {
return $this->emails;
}
/**
* Retrieve the source url of the header image as defined in LifterLMS settings
*
* @since 3.8.0
*
* @return string
*/
public function get_header_image_src() {
$src = get_option( 'lifterlms_email_header_image', '' );
if ( is_numeric( $src ) ) {
$attachment = wp_get_attachment_image_src( $src, 'full' );
$src = $attachment ? $attachment[0] : '';
}
/**
* Filters the header image src
*
* @since 3.8.0
*
* @param string $src Image `src` attribute value.
*/
return apply_filters( 'llms_email_header_image_src', $src );
}
/**
* Returns an array with the table's tags inline style
*
* It makes sure that all the required tags (table, tr, td) are set.
*
* @since 5.2.0
*
* @return array {
* Array of table style.
*
* @type string $0 Style of the table tag.
* @type string $1 Style of the tr tag.
* @type string $2 Style of the td tag.
* }
*/
private function get_parsed_table_style() {
$table_style = $this->get_table_style();
$table_style = is_array( $table_style ) ? $table_style : array( $table_style );
$table_style = wp_parse_args(
$table_style,
array(
'table' => '',
'tr' => '',
'td' => '',
)
);
return array_values( $table_style );
}
/**
* Return an associative array with the table's tags inline style
*
* @since 5.2.0
*
* @return string
*/
protected function get_table_style() {
return array(
'table' => $this->get_table_table_style(),
'tr' => $this->get_table_tr_style(),
'td' => $this->get_table_td_style(),
);
}
/**
* Return the table's `table` tag inline style
*
* @since 5.2.0
*
* @return string
*/
protected function get_table_table_style() {
return sprintf(
'border-collapse:collapse;color:%1$s;font-family:%2$s;font-size:%3$s;Margin-bottom:15px;text-align:left;width:100%%;',
$this->get_css( 'font-color', false ),
$this->get_css( 'font-family', false ),
$this->get_css( 'font-size', false )
);
}
/**
* Return the table's `tr` tag inline style
*
* @since 5.2.0
*
* @return string
*/
protected function get_table_tr_style() {
return 'color:inherit;font-family:inherit;font-size:inherit;';
}
/**
* Return the table's `td` tag inline style
*
* @since 5.2.0
*
* @return string
*/
protected function get_table_td_style() {
return sprintf(
'border-bottom:1px solid %s;color:inherit;font-family:inherit;font-size:inherit;padding:10px;',
$this->get_css( 'divider-color', false )
);
}
/**
* Returns the table html
*
* @since 5.2.0
*
* @param array $rows Array of rows to populate the table with.
* @return string
*/
public function get_table_html( $rows ) {
if ( empty( $rows ) ) {
return '';
}
ob_start();
$this->output_table_html( $rows );
return ob_get_clean();
}
public function output_table_html( $rows ) {
if ( empty( $rows ) ) {
return '';
}
list( $table_style, $tr_style, $td_style ) = $this->get_parsed_table_style();
?>
<table style="<?php echo esc_attr( $table_style ); ?>">
<?php foreach ( $rows as $code => $name ) : ?>
<tr style="<?php echo esc_attr( $tr_style ); ?>">
<th style="<?php echo esc_attr( $td_style ); ?>width:33.3333%;"><?php echo esc_html( $name ); ?></th>
<td style="<?php echo esc_attr( $td_style ); ?>">{{<?php echo esc_html( $code ); ?>}}</td>
</tr>
<?php endforeach; ?>
</table>
<?php
}
}
================================================
FILE: includes/class.llms.engagements.php
================================================
<?php
/**
* LLMS_Engagements class file
*
* @package LifterLMS/Classes
*
* @since 2.3.0
* @version 6.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Engagements Class
*
* @since 2.3.0
* @since 3.30.3 Fixed spelling errors.
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
* @since 6.0.0 Changes:
* - Deprecated the `LLMS_Engagements::handle_achievement()` method.
* Use the {@see LLMS_Engagement_Handler::handle_achievement()} method instead.
* - Deprecated the `LLMS_Engagements::handle_certificate()` method.
* Use the {@see LLMS_Engagement_Handler::handle_certificate()} method instead.
* - Deprecated the `LLMS_Engagements::handle_email()` method.
* Use the {@see LLMS_Engagement_Handler::handle_email()} method instead.
* - Deprecated the `LLMS_Engagements::init()` method with no replacement.
* - Deprecated the `LLMS_Engagements::log()` method.
* Engagement debug logging is removed. Use the {@see llms_log()} function directly instead.
* - Removed the deprecated `LLMS_Engagements::$_instance` property.
*/
class LLMS_Engagements {
use LLMS_Trait_Singleton;
/**
* Enable debug logging
*
* @since 2.7.9
* @var boolean
*/
private $debug = false;
/**
* Constructor
*
* Adds actions to events that trigger engagements.
*
* @since 2.3.0
* @since 6.0.0 Added deprecation warning when using constant `LLMS_ENGAGEMENT_DEBUG`.
* Don't call deprecated `init()` method.
*
* @return void
*/
private function __construct() {
if ( defined( 'LLMS_ENGAGEMENT_DEBUG' ) && LLMS_ENGAGEMENT_DEBUG ) {
_deprecated_function( 'Constant: LLMS_ENGAGEMENT_DEBUG', '6.0.0' );
$this->debug = true;
}
$this->add_actions();
}
/**
* Register all actions that trigger engagements
*
* @since 2.3.0
* @since 3.11.0 Unknown.
* @since 3.39.0 Added `llms_rest_student_registered` as action hook.
* @since 6.0.0 Moved the list of hooks to the `get_trigger_hooks()` method.
*
* @return void
*/
private function add_actions() {
foreach ( $this->get_trigger_hooks() as $action ) {
add_action( $action, array( $this, 'maybe_trigger_engagement' ), 777, 3 );
}
// Handlers are in charge of processing (awarding/sending) the email/cert/achievement.
$handlers = array(
'lifterlms_engagement_send_email' => 'handle_email',
'lifterlms_engagement_award_achievement' => 'handle_achievement',
'lifterlms_engagement_award_certificate' => 'handle_certificate',
);
foreach ( $handlers as $action => $method ) {
/**
* Adds an action for the deprecated method so that `remove_action()` calls
* on the old method will continue to remove the new method.
*
* When we *remove* the deprecated methods we can remove this logic.
*/
add_action( $action, array( $this, $method ) );
// If the above action has been completely removed this will be false and we won't add the new method callback.
$priority = has_action( $action, array( $this, $method ) );
if ( false !== $priority ) {
// Remove the deprecated action.
remove_action( $action, array( $this, $method ) );
// Call the new action at the specified priority. If the old action was restored at a different priority this will retain that customization.
add_action( $action, array( 'LLMS_Engagement_Handler', $method ), $priority );
}
}
add_action( 'deleted_post', array( $this, 'unschedule_delayed_engagements' ), 20, 2 );
}
/**
* Retrieve a group id used when scheduling delayed engagement action triggers.
*
* @since 6.0.0
*
* @param int $engagement_id WP_Post ID of the `llms_engagement` post type.
* @return string
*/
private function get_delayed_group_id( $engagement_id ) {
return sprintf( 'llms_engagement_%d', $engagement_id );
}
/**
* Retrieve engagements based on the trigger type
*
* Joins rather than nested loops and sub queries ftw.
*
* @since 2.3.0
* @since 3.13.1 Unknown.
* @since 6.0.0 Removed engagement debug logging & moved filter onto the return instead of calling in `maybe_trigger_engagement()`.
*
* @param string $trigger_type Name of the trigger to look for.
* @param int|string $related_post_id The WP_Post ID of the related post or an empty string.
* @return object[] {
* Array of objects from the database.
*
* @type int $engagement_id WP_Post ID of the engagement post (email, certificate, achievement).
* @type int $trigger_id WP_Post ID of the llms_engagement post.
* @type string $trigger_event The triggering action (user_registration, course_completed, etc...).
* @type string $event_type The engagement event action (certificate, achievement, email).
* @type int $delay The engagement send delay (in days).
* }
*/
private function get_engagements( $trigger_type, $related_post_id = '' ) {
global $wpdb;
$related_select = '';
$related_join = '';
$related_where = '';
if ( $related_post_id ) {
$related_select = ', relation_meta.meta_value AS related_post_id';
$related_join = "LEFT JOIN $wpdb->postmeta AS relation_meta ON triggers.ID = relation_meta.post_id";
$related_where = $wpdb->prepare(
"AND relation_meta.meta_key = '_llms_engagement_trigger_post' AND ( relation_meta.meta_value = %d OR relation_meta.meta_value = 'any' )",
$related_post_id
);
}
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$results = $wpdb->get_results(
$wpdb->prepare(
"SELECT
DISTINCT triggers.ID AS trigger_id
, triggers_meta.meta_value AS engagement_id
, engagements_meta.meta_value AS trigger_event
, event_meta.meta_value AS event_type
, delay.meta_value AS delay
$related_select
FROM $wpdb->postmeta AS engagements_meta
LEFT JOIN $wpdb->posts AS triggers ON triggers.ID = engagements_meta.post_id
LEFT JOIN $wpdb->postmeta AS triggers_meta ON triggers.ID = triggers_meta.post_id
LEFT JOIN $wpdb->posts AS engagements ON engagements.ID = triggers_meta.meta_value
LEFT JOIN $wpdb->postmeta AS event_meta ON triggers.ID = event_meta.post_id
LEFT JOIN $wpdb->postmeta AS delay ON triggers.ID = delay.post_id
$related_join
WHERE
triggers.post_type = 'llms_engagement'
AND triggers.post_status = 'publish'
AND triggers_meta.meta_key = '_llms_engagement'
AND engagements_meta.meta_key = '_llms_trigger_type'
AND engagements_meta.meta_value = %s
AND engagements.post_status = 'publish'
AND event_meta.meta_key = '_llms_engagement_type'
AND delay.meta_key = '_llms_engagement_delay'
$related_where
",
// Prepare variables.
$trigger_type
),
OBJECT
); // no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
/**
* Filters the list of engagements to be triggered for a given trigger type and related post.
*
* @since 6.0.0
*
* @param object[] $results Array of engagement objects.
* @param string $trigger_type Name of the engagement trigger.
* @param int $related_post_id WP_Post ID of the related post.
*/
return apply_filters( 'lifterlms_get_engagements', $results, $trigger_type, $related_post_id );
}
/**
* Retrieve a list of hooks that trigger engagements to be awarded.
*
* @since 6.0.0
*
* @return string[]
*/
protected function get_trigger_hooks() {
$hooks = array(
'lifterlms_access_plan_purchased',
'lifterlms_course_completed',
'lifterlms_course_track_completed',
'lifterlms_lesson_completed',
'lifterlms_product_purchased',
'lifterlms_quiz_completed',
'lifterlms_quiz_failed',
'lifterlms_quiz_passed',
'lifterlms_section_completed',
'lifterlms_user_registered',
'llms_rest_student_registered',
'llms_user_added_to_membership_level',
'llms_user_enrolled_in_course',
);
// If there are any actions registered to this deprecated hook, add it to the list.
if ( has_action( 'lifterlms_created_person' ) ) {
$hooks[] = 'lifterlms_created_person';
}
/**
* Filters the list of hooks which can trigger engagements to be sent/awarded.
*
* @since 2.3.0
*
* @param string[] $hooks List of hook names.
*/
return apply_filters( 'lifterlms_engagement_actions', $hooks );
}
/**
* Include engagement types (excluding email)
*
* @since Unknown
* @deprecated 6.0.0 `LLMS_Engagements::init()` is deprecated with no replacement.
*
* @return void
*/
public function init() {
_deprecated_function( 'LLMS_Engagements::init()', '6.0.0' );
}
/**
* Award an achievement
*
* @since 2.3.0
* @deprecated 6.0.0 `LLMS_Engagements::handle_achievement` is deprecated in favor of `LLMS_Engagement_Handler::handle_achievement`.
*
* @param array $args {
* Indexed array of arguments.
*
* @type int $0 WP_User ID.
* @type int $1 WP_Post ID of the achievement template post.
* @type int|string $2 WP_Post ID of the related post that triggered the award or an empty string.
* @type int $3 WP_Post ID of the engagement post.
* }
* @return void
*/
public function handle_achievement( $args ) {
_deprecated_function( 'LLMS_Engagements::handle_achievement', '6.0.0', 'LLMS_Engagement_Handler::handle_achievement' );
LLMS_Engagement_Handler::handle_achievement( $args );
}
/**
* Award a certificate
*
* @since 2.3.0
* @deprecated 6.0.0 `LLMS_Engagements::handle_certificate` is deprecated in favor of `LLMS_Engagement_Handler::handle_certificate`.
*
* @param array $args {
* Indexed array of arguments.
*
* @type int $0 WP_User ID.
* @type int $1 WP_Post ID of the certificate template post.
* @type int|string $2 WP_Post ID of the related post that triggered the award or an empty string.
* @type int $3 WP_Post ID of the engagement post.
* }
* @return void
*/
public function handle_certificate( $args ) {
_deprecated_function( 'LLMS_Engagements::handle_certificate', '6.0.0', 'LLMS_Engagement_Handler::handle_certificate' );
LLMS_Engagement_Handler::handle_certificate( $args );
}
/**
* Send an email engagement
*
* This is called via do_action() by the 'maybe_trigger_engagement' function in this class.
*
* @since 2.3.0
* @since 3.8.0 Unknown.
* @since 4.4.1 Use postmeta helpers for dupcheck and postmeta insertion.
* Add a return value in favor of `void`.
* Log successes and failures to the `engagement-emails` log file instead of the main `llms` log.
* @since 4.4.3 Fixed different emails triggered by the same related post not sent because of a wrong duplicate check.
* Fixed dupcheck log message and error message which reversed the email and person order.
* @deprecated 6.0.0 `LLMS_Engagements::handle_email` is deprecated in favor of `LLMS_Engagement_Handler::handle_email`.
*
* @param mixed[] $args {
* An array of arguments from the triggering hook.
*
* @type int $0 WP_User ID.
* @type int $1 WP_Post ID of the email.
* @type int|string $2 WP_Post ID of the related triggering post or an empty string for engagements with no related post.
* @type int $3 WP_Post ID of the engagement post.
* }
* @return bool|WP_Error Returns `true` on success, `false` when the email is skipped, and a `WP_Error` when
* the email has failed or is prevented.
*/
public function handle_email( $args ) {
_deprecated_function( 'LLMS_Engagements::handle_email', '6.0.0', 'LLMS_Engagement_Handler::handle_email' );
$res = LLMS_Engagement_Handler::handle_email( $args );
if ( true === $res ) {
return $res;
}
// The new handler returns an array of errors in favor of a single error. Retain the initial return type for this deprecated version.
return $res[0];
}
/**
* Parse incoming hook / callback data to determine if an engagement should be triggered from a given hook.
*
* @since 6.0.0
* @since 6.6.0 Fixed an issue where the `lifterlms_external_engagement_query_arguments` filter
* would not trigger if a 3rd party registered a trigger hook.
*
* @param string $action Action hook name.
* @param array $args Array of arguments passed to the callback function.
* @return array {
* An associative array of parsed data used to trigger the engagement.
*
* @type string $trigger_type The name of the engagement trigger. See `llms_get_engagement_triggers()` for a list of valid triggers.
* @type int $user_id The WP_User ID of the user who the engagement is being awarded or sent to.
* @type int $related_post_id The WP_Post ID of a related post.
* }
*/
private function parse_hook( $action, $args ) {
$parsed = array(
'trigger_type' => null,
'user_id' => null,
'related_post_id' => null,
);
/**
* Allows 3rd parties to hook into the core engagement system by parsing data passed to the hook.
*
* @since 2.3.0
*
* @param array $parsed {
* An associative array of parsed data used to trigger the engagement.
*
* @type string $trigger_type (Required) The name of the engagement trigger. See `llms_get_engagement_triggers()` for a list of valid triggers.
* @type int $user_id (Required) The WP_User ID of the user who the engagement is being awarded or sent to.
* @type int $related_post_id (Optional) The WP_Post ID of a related post.
* }
* @param string $action The name of the hook which triggered the engagement.
* @param array $args The original arguments provided by the triggering hook.
*/
$filtered_parsed = apply_filters(
'lifterlms_external_engagement_query_arguments',
$parsed,
$action,
$args
);
// If valid, return the filtered parsed data.
if ( isset( $filtered_parsed['trigger_type'] ) && isset( $filtered_parsed['user_id'] ) ) {
return $filtered_parsed;
}
// Verify that the action is a supported hook.
if ( ! in_array( $action, $this->get_trigger_hooks(), true ) ) {
return $parsed;
}
// The user registration action doesn't have a related post id.
$related_post_id = isset( $args[1] ) && is_numeric( $args[1] ) ? absint( $args[1] ) : '';
$parsed['user_id'] = absint( $args[0] );
$parsed['trigger_type'] = $this->parse_hook_find_trigger_type( $action, $related_post_id );
$parsed['related_post_id'] = $related_post_id;
return $parsed;
}
/**
* Get the engagement trigger type based on the action and related post id
*
* @since 6.0.0
*
* @param string $action Name of the triggering action hook.
* @param int|string $related_post_id WP_Post ID of the related post or an empty string.
* @return string
*/
private function parse_hook_find_trigger_type( $action, $related_post_id ) {
$trigger_type = '';
switch ( $action ) {
case 'llms_rest_student_registered':
case 'lifterlms_created_person':
case 'lifterlms_user_registered':
$trigger_type = 'user_registration';
break;
case 'lifterlms_course_completed':
case 'lifterlms_course_track_completed':
case 'lifterlms_lesson_completed':
case 'lifterlms_section_completed':
case 'lifterlms_quiz_completed':
case 'lifterlms_quiz_passed':
case 'lifterlms_quiz_failed':
$trigger_type = str_replace( 'lifterlms_', '', $action );
break;
case 'llms_user_added_to_membership_level':
case 'llms_user_enrolled_in_course':
$trigger_type = str_replace( 'llms_', '', get_post_type( $related_post_id ) ) . '_enrollment';
break;
case 'lifterlms_access_plan_purchased':
case 'lifterlms_product_purchased':
$trigger_type = str_replace( 'llms_', '', get_post_type( $related_post_id ) ) . '_purchased';
break;
}
return $trigger_type;
}
/**
* Handles all actions that could potentially trigger an engagement
*
* It will fire or schedule the actions after gathering all necessary data.
*
* @since 2.3.0
* @since 3.11.0 Unknown.
* @since 3.39.0 Treat also `llms_rest_student_registered` action.
* @since 6.0.0 Major refactor to reduce code complexity.
*
* @return void
*/
public function maybe_trigger_engagement() {
// Parse incoming hook data.
$hook = $this->parse_hook( current_filter(), func_get_args() );
// We need a user and a trigger to proceed, related_post is optional though.
if ( ! $hook['user_id'] || ! $hook['trigger_type'] ) {
return;
}
// Gather triggerable engagements matching the supplied criteria.
$engagements = $this->get_engagements( $hook['trigger_type'], $hook['related_post_id'] );
// Loop through the retrieved engagements and trigger them.
foreach ( $engagements as $engagement ) {
$handler = $this->parse_engagement( $engagement, $hook );
$this->trigger_engagement( $handler, $engagement->delay );
}
}
/**
* Parse engagement objects from the DB and return data needed to trigger the engagements.
*
* @since 6.0.0
* @since 6.6.0 Fixed an issue where the `lifterlms_external_engagement_handler_arguments` filter
* would not trigger if a 3rd party registered an engagement type.
*
* @param object $engagement The engagement object from the `get_engagements()` query.
* @param array $trigger_data Parsed hook data from `parse_hook()`.
* @return array {
* An associative array of parsed data used to trigger the engagement.
*
* @type string $handler_action Hook name of the action that will handle awarding the sending the engagement.
* @type array $handler_args Arguments passed to the `$handler_action` callback.
* }
*/
private function parse_engagement( $engagement, $trigger_data ) {
$parsed = array(
'handler_action' => null,
'handler_args' => null,
);
/**
* Enable 3rd parties to parse custom engagement types.
*
* @since 2.3.0
*
* @param array $parsed {
* An associative array of parsed data used to trigger the engagement.
*
* @type string $handler_action (Required) Hook name of the action that will handle awarding the sending the engagement.
* @type array $handler_args (Required) Arguments passed to the `$handler_action` callback.
* }
* @param object $engagement The engagement object from the `get_engagements()` query.
* @param int $user_id WP_User ID who will be awarded the engagement.
* @param int $related_post_id WP_Post ID of the related post.
* @param string $event_type The type of engagement event.
*/
$filtered_parsed = apply_filters(
'lifterlms_external_engagement_handler_arguments',
$parsed,
$engagement,
$trigger_data['user_id'],
$trigger_data['related_post_id'],
$engagement->event_type
);
// If valid, return the filtered parsed data.
if ( isset( $filtered_parsed['handler_action'] ) && isset( $filtered_parsed['handler_args'] ) ) {
return $filtered_parsed;
}
// Verify that the engagement event type is supported.
if ( ! array_key_exists( $engagement->event_type, llms_get_engagement_types() ) ) {
return $parsed;
}
$parsed['handler_args'] = array(
$trigger_data['user_id'],
$engagement->engagement_id,
$trigger_data['related_post_id'],
absint( $engagement->trigger_id ),
);
/**
* @todo Fix this
*
* If there's no related post id we have to send one anyway for certs to work.
*
* This would only be for registration events @ version 2.3.0 so we pass the engagement_id twice until we find a better solution.
*/
if ( 'certificate' === $engagement->event_type && empty( $parsed['handler_args'][2] ) ) {
$parsed['handler_args'][2] = $parsed['handler_args'][1];
}
$parsed['handler_action'] = sprintf(
'lifterlms_engagement_%1$s_%2$s',
'email' === $engagement->event_type ? 'send' : 'award',
$engagement->event_type
);
return $parsed;
}
/**
* Triggers or schedules an engagement
*
* @since 6.0.0
*
* @param array $data Handler data from `parse_engagement()`.
* @param int $delay The engagement send delay (in days).
* @return void
*/
private function trigger_engagement( $data, $delay ) {
// Can't proceed without an action and a handler.
if ( empty( $data['handler_action'] ) || empty( $data['handler_args'] ) ) {
return;
}
// If we have a delay, schedule the engagement handler.
$delay = absint( $delay );
if ( $delay ) {
as_schedule_single_action(
current_datetime()->modify( "+{$delay} days" )->getTimestamp(),
$data['handler_action'],
array( $data['handler_args'] ),
! empty( $data['handler_args'][3] ) ? $this->get_delayed_group_id( $data['handler_args'][3] ) : null
);
} else {
/**
* Skip processing checks for immediate engagements.
*
* We know the user exists (because they're currently logged in) and we don't have to run
* publish/existence checks on all the related posts because the `get_engagement()` query takes care
* of that already.
*/
add_filter( 'llms_skip_engagement_processing_checks', '__return_true' );
do_action( $data['handler_action'], $data['handler_args'] );
remove_filter( 'llms_skip_engagement_processing_checks', '__return_true' );
}
}
/**
* Unschedule all scheduled actions for a delayed engagement
*
* This is the callback function for deleted engagement posts.
*
* The `deleted_post` action param `$post` has been added since WordPress 5.5.0.
*
* @since 6.0.0
*
* @param int $post_id WP_Post ID.
* @param WP_Post|null $post Post object of the deleted post.
* @return void
*/
public function unschedule_delayed_engagements( $post_id, $post = null ) {
// @todo Remove compatibility with WP < 5.5 when bumping the minimum WP required version to 5.5+
$post_type = $post ? $post->post_type : get_post_type( $post_id );
if ( 'llms_engagement' === $post_type ) {
as_unschedule_all_actions( '', array(), $this->get_delayed_group_id( $post_id ) );
}
}
/**
* Log debug data to the WordPress debug.log file
*
* @since 2.7.9
* @since 3.12.0 Unknown.
* @deprecated 6.0.0 Engagement debug logging is removed. Use `llms_log()` directly instead.
*
* @param mixed $log Data to write to the log.
* @return void
*/
public function log( $log ) {
_deprecated_function( 'LLMS_Engagements::log()', '6.0.0', 'llms_log()' );
if ( $this->debug ) {
llms_log( $log, 'engagements' );
}
}
}
================================================
FILE: includes/class.llms.frontend.assets.php
================================================
<?php
/**
* Frontend scripts class
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Frontend_Assets
*
* @since 1.0.0
* @since 3.35.0 Explicitly define asset versions.
* @since 3.36.0 Localize tracking with client-side settings.
* @since 4.0.0 Remove JS dependencies "collapse" and "transition".
* @since 4.4.0 Method `enqueue_inline_script()` is deprecated in favor of `LLMS_Assets::enqueue_inline()`.
* Method `is_inline_script_enqueued()` is deprecated in favor of `LLMS_Frontend_Assets::is_inline_enqueued()`.
* Private properties `$enqueued_inline_scripts` and `$inline_scripts` have been removed.
* Removed private methods `get_inline_scripts()` and `output_inline_scripts()`.
* @since 6.0.0 Removed deprecated items.
* - `LLMS_Frontend_Assets::enqueue_inline_pw_script()` method
* - `LLMS_Frontend_Assets::enqueue_inline_script()` method
* - `LLMS_Frontend_Assets::is_inline_script_enqueued()` method
*/
class LLMS_Frontend_Assets {
/**
* Inline script ids that have been enqueued.
*
* @var array
*/
private static $enqueued_inline_scripts = array();
/**
* Array of inline scripts to be output in the header / footer respectively.
*
* @var array
*/
private static $inline_scripts = array(
'header' => array(),
'footer' => array(),
);
/**
* Initializer
*
* Replaces non-static __construct() from 3.4.0 & lower.
*
* @since 3.4.1
* @since 3.17.5 Unknown.
* @since 5.6.0 Add content protection inline script enqueue.
*
* @return void
*/
public static function init() {
add_action( 'wp_enqueue_scripts', array( __CLASS__, 'enqueue_styles' ) );
add_action( 'wp_enqueue_scripts', array( __CLASS__, 'enqueue_scripts' ) );
add_action( 'wp_head', array( __CLASS__, 'output_header_scripts' ) );
add_action( 'wp_print_footer_scripts', array( __CLASS__, 'output_footer_scripts' ), 1 );
add_action( 'wp', array( __CLASS__, 'enqueue_content_protection' ) );
}
/**
* Enqueue inline copy prevention scripts.
*
* @since 5.6.0
*
* @return void
*/
public static function enqueue_content_protection() {
$allow_copying = ! llms_parse_bool( get_option( 'lifterlms_content_protection', 'no' ) ) || llms_can_user_bypass_restrictions( get_current_user_id() );
/**
* Filters whether or not content prevention is enabled.
*
* This hook runs on the `wp` action, at this point the current user is available and
* the global `$post` has already been set up.
*
* @since 5.6.0
*
* @param boolean $allow_copying Whether or not copying is allowed. If `true`, copying
* is allowed, otherwise copy prevention scripts are
* loaded.
*/
$allow_copying = apply_filters( 'llms_skip_content_prevention', $allow_copying );
if ( $allow_copying ) {
return;
}
ob_start();
?>
( function(){
function dispatchEvent( type ) {
document.dispatchEvent( new Event( type ) );
}
document.addEventListener( 'copy', function( event ) {
// Allow copying if the target is an input or textarea element
if (event.target.tagName === 'INPUT' || event.target.tagName === 'TEXTAREA') {
return; // Let the default copy behavior proceed
}
// Prevent copying outside input/textarea elements
event.preventDefault();
event.clipboardData.setData( 'text/plain', '<?php echo esc_html__( 'Copying is not allowed.', 'lifterlms' ); ?>' );
dispatchEvent( 'llms-copy-prevented' );
}, false );
document.addEventListener( 'contextmenu', function( event ) {
// Prevent right-click context menu on images
if ( event.target && 'IMG' === event.target.nodeName ) {
event.preventDefault();
dispatchEvent( 'llms-context-prevented' );
}
}, false );
} )();
<?php
$script = ob_get_clean();
llms()->assets->enqueue_inline( 'llms-integrity', $script, 'header' );
}
/**
* Enqueue Styles
*
* @since 1.0.0
* @since 3.18.0 Unknown.
* @since 3.35.0 Explicitly define asset versions.
* @since 4.4.0 Enqueue & register scripts using `LLMS_Assets` methods.
* @since 5.0.0 Enqueue select2 on account and checkout pages for searchable dropdowns for country & state.
*
* @return void
*/
public static function enqueue_styles() {
global $post_type;
llms()->assets->register_style( 'llms-iziModal' );
llms()->assets->enqueue_style( 'webui-popover' );
llms()->assets->enqueue_style( 'lifterlms-styles' );
if ( in_array( $post_type, array( 'llms_my_certificate', 'llms_certificate' ), true ) ) {
llms()->assets->enqueue_style( 'certificates' );
} elseif ( is_llms_account_page() ) {
llms()->assets->enqueue_style( 'llms-iziModal' );
} elseif ( is_singular( 'llms_quiz' ) ) {
wp_enqueue_style( 'wp-mediaelement' );
}
if ( is_llms_account_page() || is_llms_checkout() ) {
llms()->assets->enqueue_style( 'llms-select2-styles' );
}
}
/**
* Enqueue Scripts
*
* @since 1.0.0
* @since 3.22.0 Unknown.
* @since 3.35.0 Explicitly define asset versions.
* @since 3.36.0 Localize tracking with client-side settings.
* @since 4.0.0 Remove dependencies "collapse" and "transition".
* @since 4.4.0 Enqueue & register scripts using `LLMS_Assets` methods.
* Add Add `window.llms.ajax_nonce` data to replace `wp_ajax_data.nonce`.
* Moved inline scripts to `enqueue_inline_scripts()`.
* @since 5.0.0 Enqueue locale data and dependencies on account and checkout pages for searchable dropdowns for country & state.
* Remove password strength inline enqueue.
* @since 7.5.0 Enqueue `llms-favorites` script on lesson and course page.
*
* @return void
*/
public static function enqueue_scripts() {
// I don't think we need these next 3 scripts.
wp_enqueue_script( 'jquery-ui-tooltip' );
wp_enqueue_script( 'jquery-ui-datepicker' );
wp_enqueue_script( 'jquery-ui-slider' );
llms()->assets->enqueue_script( 'webui-popover' );
llms()->assets->register_script( 'llms-jquery-matchheight' );
if ( is_llms_account_page() || is_course() || is_membership() || is_lesson() || is_memberships() || is_courses() || is_tax( array( 'course_cat', 'course_tag', 'course_difficulty', 'course_track', 'membership_tag', 'membership_cat' ) ) ) {
llms()->assets->enqueue_script( 'llms-jquery-matchheight' );
}
llms()->assets->enqueue_script( 'llms' );
llms()->assets->register_script( 'llms-notifications' );
if ( get_current_user_id() ) {
llms()->assets->enqueue_script( 'llms-notifications' );
}
// Doesn't seem like there's any reason to enqueue this script on the frontend.
wp_enqueue_script( 'llms-ajax', LLMS_PLUGIN_URL . 'assets/js/llms-ajax' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), llms()->version, true );
// I think we only need this on account and checkout pages.
llms()->assets->enqueue_script( 'llms-form-checkout' );
if ( is_singular( 'llms_quiz' ) ) {
llms()->assets->enqueue_script( 'llms-quiz' );
}
llms()->assets->register_script( 'llms-favorites' );
if ( ( is_lesson() || is_course() ) && true === llms_is_favorites_enabled() ) {
llms()->assets->enqueue_script( 'llms-favorites' );
}
llms()->assets->register_script( 'llms-iziModal' );
if ( is_llms_account_page() ) {
llms()->assets->enqueue_script( 'llms-iziModal' );
}
self::enqueue_inline_scripts();
self::enqueue_locale_scripts();
}
/**
* Enqueue inline scripts.
*
* @since 4.4.0
* @since 7.0.0 Include checkout page script data for AJAX-powered gateways.
*
* @return void
*/
protected static function enqueue_inline_scripts() {
// Ensure the main llms object exists.
llms()->assets->enqueue_inline( 'llms-obj', 'window.llms = window.llms || {};', 'footer', 5 );
// Define inline scripts.
$scripts = array(
'llms-ajaxurl' => 'window.llms.ajaxurl = "' . admin_url( 'admin-ajax.php', is_ssl() ? 'https' : 'http' ) . '";',
'llms-ajax-nonce' => 'window.llms.ajax_nonce = "' . wp_create_nonce( LLMS_AJAX::NONCE ) . '";',
'llms-tracking-settings' => "window.llms.tracking = '" . wp_json_encode( llms()->events()->get_client_settings() ) . "';",
'llms-LLMS-obj' => 'window.LLMS = window.LLMS || {};',
'llms-l10n' => 'window.LLMS.l10n = window.LLMS.l10n || {}; window.LLMS.l10n.strings = ' . LLMS_L10n::get_js_strings( true ) . ';',
);
$checkout_urls = self::get_checkout_urls();
if ( ! empty( $checkout_urls ) ) {
$scripts['llms-checkout-urls'] = "window.llms.checkoutUrls = JSON.parse( '" . wp_json_encode( $checkout_urls ) . "' );";
}
// Enqueue them.
foreach ( $scripts as $handle => $script ) {
llms()->assets->enqueue_inline( $handle, $script, 'footer' );
}
}
/**
* Enqueue dependencies and inline script data for form localization
*
* @since 5.0.0
*
* @return void
*/
protected static function enqueue_locale_scripts() {
if ( is_llms_account_page() || is_llms_checkout() ) {
llms()->assets->enqueue_script( 'llms-select2' );
llms()->assets->enqueue_inline(
'llms-countries-locale',
"window.llms.address_info = '" . wp_json_encode( llms_get_countries_address_info() ) . "';",
'footer',
20
);
}
}
/**
* Retrieves AJAX checkout URLs used for checkout and switching payment source on the student dashboard.
*
* @since 7.0.0
*
* @return array
*/
private static function get_checkout_urls() {
$urls = array();
$controller = LLMS_Controller_Checkout::instance();
if ( is_llms_checkout() ) {
$urls = array(
'createPendingOrder' => $controller->get_url( $controller::ACTION_CREATE_PENDING_ORDER ),
'confirmPendingOrder' => $controller->get_url( $controller::ACTION_CONFIRM_PENDING_ORDER ),
);
} elseif ( is_llms_account_page() && 'orders' === LLMS_Student_Dashboard::get_current_tab( 'slug' ) && is_numeric( get_query_var( 'orders', false ) ) ) {
$urls = array(
'switchPaymentSource' => $controller->get_url( $controller::ACTION_SWITCH_PAYMENT_SOURCE ),
);
}
return $urls;
}
/**
* Output inline scripts in the footer
*
* @since 3.4.1
* @since 4.4.0 Use `LLMS_Assets::output_inline()` to output scripts.
*
* @return void
*/
public static function output_footer_scripts() {
llms()->assets->output_inline( 'footer' );
}
/**
* Output inline scripts in the header
*
* @since 3.4.1
* @since 4.4.0 Use `LLMS_Assets::output_inline()` to output scripts.
*
* @return void
*/
public static function output_header_scripts() {
llms()->assets->output_inline( 'header' );
}
}
return LLMS_Frontend_Assets::init();
================================================
FILE: includes/class.llms.gateway.manual.php
================================================
<?php
/**
* Manual Payment Gateway Class
*
* @package LifterLMS/Classes
*
* @since 3.0.0
* @version 6.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Manual Payment Gateway Class
*
* @since 3.0.0
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Payment_Gateway_Manual extends LLMS_Payment_Gateway {
/**
* @var string
* @since 3.0.0
*/
public $payment_instructions;
/**
* Constructor
*
* @return void
* @since 3.0.0
* @version 3.10.0
*/
public function __construct() {
$this->id = 'manual';
$this->admin_description = __( 'Collect manual or offline payments. Also handles any free orders during checkout.', 'lifterlms' );
$this->admin_title = __( 'Manual', 'lifterlms' );
$this->title = __( 'Manual', 'lifterlms' );
$this->description = __( 'Pay manually via check', 'lifterlms' );
$this->payment_instructions = ''; // Fields.
$this->supports = array(
'checkout_fields' => false,
'refunds' => false, // Manual refunds are available always for all gateways and are not handled by this class.
'single_payments' => true,
'recurring_payments' => true,
'test_mode' => false,
);
add_filter( 'llms_get_gateway_settings_fields', array( $this, 'get_settings_fields' ), 10, 2 );
add_action( 'lifterlms_before_view_order_table', array( $this, 'before_view_order_table' ) );
}
/**
* Output payment instructions if the order is pending.
*
* @since 3.0.0
* @since 6.4.0 Allowed classes extended from this manual payment gateway class to display payment instructions.
*
* @return void
*/
public function before_view_order_table() {
global $wp;
if ( ! empty( $wp->query_vars['orders'] ) ) {
$order = new LLMS_Order( intval( $wp->query_vars['orders'] ) );
if (
$order->get( 'payment_gateway' ) === $this->id &&
in_array( $order->get( 'status' ), array( 'llms-pending', 'llms-on-hold', true ) )
) {
echo wp_kses_post( $this->get_payment_instructions() );
}
}
}
/**
* Get fields displayed on the checkout form
*
* @return string
* @since 3.0.0
* @version 3.7.5
*/
public function get_payment_instructions() {
$opt = $this->get_option( 'payment_instructions' );
if ( $opt ) {
$fields = '<div class="llms-notice llms-info"><h3>' . esc_html__( 'Payment Instructions', 'lifterlms' ) . '</h3>' . wpautop( wptexturize( wp_kses_post( $opt ) ) ) . '</div>';
} else {
$fields = '';
}
return apply_filters( 'llms_get_payment_instructions', $fields, $this->id );
}
/**
* Get admin setting fields
*
* @param array $fields default fields
* @param string $gateway_id gateway ID
* @return array
* @since 3.0.0
* @version 3.0.0
*/
public function get_settings_fields( $fields, $gateway_id ) {
if ( $this->id !== $gateway_id ) {
return $fields;
}
$fields[] = array(
'id' => $this->get_option_name( 'payment_instructions' ),
'desc' => '<br>' . __( 'Displayed to the user when this gateway is selected during checkout. Add information here instructing the student on how to send payment.', 'lifterlms' ),
'title' => __( 'Payment Instructions', 'lifterlms' ),
'type' => 'textarea',
);
return $fields;
}
/**
* Called when the Update Payment Method form is submitted from a single order view on the student dashboard
*
* Gateways should do whatever the gateway needs to do to validate the new payment method and save it to the order
* so that future payments on the order will use this new source
*
* @param obj $order Instance of the LLMS_Order
* @param array $form_data Additional data passed from the submitted form (EG $_POST)
* @return void
* @since 3.10.0
* @version 3.10.0
*/
public function handle_payment_source_switch( $order, $form_data = array() ) {
$previous_gateway = $order->get( 'payment_gateway' );
if ( $this->get_id() === $previous_gateway ) {
return;
}
$order->set( 'payment_gateway', $this->get_id() );
$order->set( 'gateway_customer_id', '' );
$order->set( 'gateway_source_id', '' );
$order->set( 'gateway_subscription_id', '' );
$order->add_note( sprintf( __( 'Payment method switched from "%1$s" to "%2$s"', 'lifterlms' ), $previous_gateway, $this->get_admin_title() ) );
}
/**
* Handle a Pending Order.
*
* @since 3.0.0
* @since 3.10.0 Unknown.
* @since 6.4.0 Use `llms_redirect_and_exit()` in favor of `wp_redirect()` and `exit()`.
*
* @param LLMS_Order $order Order object.
* @param LLMS_Access_Plan $plan Access plan object.
* @param LLMS_Student $student Student object.
* @param LLMS_Coupon|boolean $coupon Coupon object or `false` when no coupon is being used for the order.
* @return void
*/
public function handle_pending_order( $order, $plan, $student, $coupon = false ) {
// Free orders (no payment is due).
if ( floatval( 0 ) === $order->get_initial_price( array(), 'float' ) ) {
// Free access plans do not generate receipts.
if ( $plan->is_free() ) {
$order->set( 'status', 'llms-completed' );
// Free trial, reduced to free via coupon, etc....
// We do want to record a transaction and then generate a receipt.
} else {
// Record a $0.00 transaction to ensure a receipt is sent.
$order->record_transaction(
array(
'amount' => floatval( 0 ),
'source_description' => __( 'Free', 'lifterlms' ),
'transaction_id' => uniqid(),
'status' => 'llms-txn-succeeded',
'payment_gateway' => 'manual',
'payment_type' => 'single',
)
);
}
return $this->complete_transaction( $order );
}
/**
* Action triggered when a manual payment is due.
*
* @hooked LLMS_Notification: manual_payment_due - 10
*
* @since Unknown.
*
* @param LLMS_Order $order The order object.
* @param LLMS_Payment_Gateway_Manual $gateway Manual gateway instance.
*/
do_action( 'llms_manual_payment_due', $order, $this );
/**
* Action triggered when the pending order processing has been completed.
*
* @since Unknown.
*
* @param LLMS_Order $order The order object.
*/
do_action( 'lifterlms_handle_pending_order_complete', $order );
llms_redirect_and_exit( $order->get_view_link() );
}
/**
* Called by scheduled actions to charge an order for a scheduled recurring transaction
* This function must be defined by gateways which support recurring transactions
*
* @param obj $order Instance LLMS_Order for the order being processed
* @return mixed
* @since 3.10.0
* @version 3.10.0
*/
public function handle_recurring_transaction( $order ) {
// Switch to order on hold if it's a paid order.
if ( $order->get_price( 'total', array(), 'float' ) > 0 ) {
// Update status.
$order->set_status( 'on-hold' );
/**
* @hooked LLMS_Notification: manual_payment_due - 10
*/
do_action( 'llms_manual_payment_due', $order, $this );
}
}
/**
* Determine if the gateway is enabled according to admin settings checkbox
*
* @return boolean
* @since 3.0.0
* @version 3.0.0
*/
public function is_enabled() {
return ( 'yes' === $this->get_enabled() ) ? true : false;
}
}
================================================
FILE: includes/class.llms.generator.php
================================================
<?php
/**
* Generate LMS Content from export files or raw arrays of data
*
* @package LifterLMS/Classes
*
* @since 3.3.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Generator class.
*
* @since 3.3.0
* @since 3.30.2 Added hooks and made numerous private functions public to expand extendability.
* @since 3.36.3 New method: is_generator_valid()
* Bugfix: Fix return of `set_generator()`.
* @since 6.0.0 Removed deprecated items.
* - `LLMS_Generator::add_custom_values()` method
* - `LLMS_Generator::format_date()` method
* - `LLMS_Generator::get_author_id_from_raw()` method
* - `LLMS_Generator::get_default_post_status()` method
* - `LLMS_Generator::get_generated_posts()` method
* - `LLMS_Generator::increment()` method
*/
class LLMS_Generator {
/**
* Courses generator subclass instance
*
* @var LLMS_Generator_Courses
*/
protected $courses_generator;
/**
* Instance of WP_Error
*
* @var obj
*/
public $error;
/**
* Array of generated objects.
*
* @var array
*/
protected $generated = array();
/**
* Name of the Generator to use for generation
*
* @var string
*/
protected $generator = '';
/**
* Raw contents passed into the generator's constructor
*
* @var array
*/
protected $raw = array();
/**
* Construct a new generator instance with data
*
* @since 3.3.0
* @since 4.7.0 Move most logic into helper functions.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @param array|string $raw Array or a JSON string of raw content.
* @return void
*/
public function __construct( $raw ) {
// Load generator class.
$this->courses_generator = new LLMS_Generator_Courses();
// Parse raw data.
$this->raw = $this->parse_raw( $raw );
// Instantiate an empty error object.
$this->error = new WP_Error();
// Add hooks.
$this->add_hooks();
}
/**
* Add actions and filters used by the class.
*
* @since 4.7.0
*
* @return void
*/
protected function add_hooks() {
// Watch creation of things, used on generation completion to return results of created objects.
foreach ( array( 'access_plan', 'course', 'section', 'lesson', 'quiz', 'question', 'term', 'user' ) as $type ) {
add_action( 'llms_generator_new_' . $type, array( $this, 'object_created' ) );
}
}
/**
* When called, generates raw content based on the defined generator
*
* @since 3.3.0
* @since 3.30.2 Add before and after generation hooks.
* @since 4.7.0 Return early if not generator is set.
*
* @return void
*/
public function generate() {
if ( empty( $this->generator ) ) {
return $this->error->add( 'missing-generator', __( 'No generator supplied.', 'lifterlms' ) );
}
global $wpdb;
$wpdb->hide_errors();
$wpdb->query( 'START TRANSACTION' ); // db call ok; no-cache ok.
/**
* Action run immediately prior to a LifterLMS Generator running.
*
* @since 3.30.2
*
* @param LLMS_Generator $generator The generator instance.
*/
do_action( 'llms_generator_before_generate', $this );
try {
call_user_func( $this->generator, $this->raw );
} catch ( Exception $exception ) {
$this->error->add( $this->get_error_code( $exception->getCode(), $this->generator[0] ), $exception->getMessage(), $exception->getTrace() );
}
/**
* Action run immediately after a LifterLMS Generator running.
*
* @since 3.30.2
*
* @param LLMS_Generator $generator The generator instance.
*/
do_action( 'llms_generator_after_generate', $this );
if ( $this->is_error() ) {
$wpdb->query( 'ROLLBACK' ); // db call ok; no-cache ok.
} else {
$wpdb->query( 'COMMIT' ); // db call ok; no-cache ok.
}
}
/**
* Retrieve a human-readable error code from a machine-readable error number
*
* @since 4.7.0
* @since 4.9.0 Handle PHP core errors, warnings, notices, etc... with a human-readable error code.
*
* @param int $code Error number.
* @param obj $class Generator class instance.
* @return string A human-readable error code.
*/
protected function get_error_code( $code, $class ) {
// See if the error code is a native php exception code constant.
$ret = llms_php_error_constant_to_code( $code );
// Code is not a native PHP exception code.
if ( is_numeric( $ret ) ) {
$reflect = new ReflectionClass( $class );
$constants = array_flip( $reflect->getConstants() );
$ret = isset( $constants[ $code ] ) ? $constants[ $code ] : 'ERROR_UNKNOWN';
}
/**
* Filter the human-readable error retrieved from a given error code
*
* @since 4.9.0
*
* @param string $ret The human-readable error code.
* @param int $code The initial error code as an integer.
* @param obj $class Generator class instance.
*/
return apply_filters( 'llms_generator_get_error_code', $ret, $code, $class );
}
/**
* Retrieves a multi-dimensional array of content generated by the most class
*
* @since 4.7.0
*
* @return array Returns an associative array where the keys are the object type and the values are an array of integers representing the generated object IDs.
*/
public function get_generated_content() {
return $this->generated;
}
/**
* Retrieve the array of generated course ids
*
* @since 3.7.3
* @since 3.14.8 Unknown.
* @since 4.7.0 Access generated posts from the `$generated` property in favor of the removed `$posts` property.
*
* @return array
*/
public function get_generated_courses() {
if ( isset( $this->generated['course'] ) ) {
return $this->generated['course'];
}
return array();
}
/**
* Get an array of valid LifterLMS generators
*
* @since 3.3.0
* @since 3.14.8 Unknown.
* @since 4.7.0 Load generators from `LLMS_Generator_Courses()`.
* @since 4.13.0 Use `clone_course()` method for cloning courses in favor of `genrate_course()`.
*
* @return array
*/
protected function get_generators() {
/**
* Filter the list of available generators.
*
* @since Unknown
*
* @param array[] $generators Array of generators. Array key is the generator name and the array value is a callable function.
*/
return apply_filters(
'llms_generators',
array(
'LifterLMS/BulkCourseExporter' => array( $this->courses_generator, 'generate_courses' ),
'LifterLMS/BulkCourseGenerator' => array( $this->courses_generator, 'generate_courses' ),
'LifterLMS/SingleCourseCloner' => array( $this->courses_generator, 'clone_course' ),
'LifterLMS/SingleCourseExporter' => array( $this->courses_generator, 'generate_course' ),
'LifterLMS/SingleCourseGenerator' => array( $this->courses_generator, 'generate_course' ),
'LifterLMS/SingleLessonCloner' => array( $this->courses_generator, 'clone_lesson' ),
)
);
}
/**
* Get the results of the generate function
*
* @since 3.3.0
* @since 4.7.0 Return generated stats from `$this->stats()` instead of from removed `$stats` property.
*
* @return int[]|WP_Error Array of stats on success and an error object on failure.
*/
public function get_results() {
if ( $this->is_error() ) {
return $this->error;
}
return $this->get_stats();
}
/**
* Get "stats" about the generated content.
*
* @since 4.7.0
*
* @return array
*/
public function get_stats() {
$stats = array();
foreach ( $this->generated as $type => $ids ) {
$stats[ $type ] = count( $ids );
}
// Add old plural keys that were guaranteed to exist.
$backwards_compat = array(
'course' => 'courses',
'section' => 'sections',
'lesson' => 'lessons',
'access_plan' => 'plans',
'quiz' => 'quizzes',
'question' => 'questions',
'term' => 'terms',
'user' => 'authors',
);
foreach ( $backwards_compat as $curr => $old ) {
$stats[ $old ] = isset( $stats[ $curr ] ) ? $stats[ $curr ] : 0;
}
return $stats;
}
/**
* Determines if there was an error during the running of the generator
*
* @since 3.3.0
* @since 3.16.11 Unknown.
*
* @return boolean Returns `true` when there was an error and `false` if there's no errors.
*/
public function is_error() {
return ( 0 !== count( $this->error->get_error_messages() ) );
}
/**
* Determine if a generator is a valid generator.
*
* @since 3.36.3
*
* @param string $generator Generator name.
* @return bool
*/
protected function is_generator_valid( $generator ) {
return in_array( $generator, array_keys( $this->get_generators() ), true );
}
/**
* Record the generation of an object
*
* @since 4.7.0
*
* @param LLMS_Post_Model|array|WP_User $object Created object or array.
* @return void
*/
public function object_created( $object ) {
switch ( current_action() ) {
case 'llms_generator_new_access_plan':
case 'llms_generator_new_course':
case 'llms_generator_new_section':
case 'llms_generator_new_lesson':
case 'llms_generator_new_quiz':
case 'llms_generator_new_question':
$this->record_generation( $object->get( 'id' ), $object->get( 'type' ) );
break;
case 'llms_generator_new_user':
$this->record_generation( $object, 'user' );
break;
case 'llms_generator_new_term':
$this->record_generation( $object['term_id'], 'term' );
break;
}
}
/**
* Parse raw data
*
* @since 4.7.0
*
* @param string|array|obj $raw Accepts a JSON string, array, or object of raw data to pass to a generator.
* @return array
*/
protected function parse_raw( $raw ) {
if ( is_string( $raw ) ) {
$raw = json_decode( $raw, true );
}
return (array) $raw;
}
/**
* Records a generated post id
*
* @since 3.14.8
* @since 4.7.0 Modified method access from `private` to `protected`.
* Add IDs to the `generated` variable in favor of `posts`.
*
* @param int $id WP Post ID of the generated post.
* @param string $key Key of the stat to increment.
* @return void
*/
protected function record_generation( $id, $key ) {
// Remove LifterLMS Prefix from the key (if it exists).
$key = str_replace( 'llms_', '', $key );
// Add an array if it doesn't already exist.
if ( ! isset( $this->generated[ $key ] ) ) {
$this->generated[ $key ] = array();
}
// Record the ID.
$this->generated[ $key ][] = $id;
}
/**
* Configure the default post status for generated posts at runtime
*
* @since 3.7.3
* @since 4.7.0 Call `set_default_post_status()` from the configured generator.
*
* @param string $status Any valid WP Post Status.
* @return void
*/
public function set_default_post_status( $status ) {
call_user_func( array( $this->generator[0], 'set_default_post_status' ), $status );
}
/**
* Sets the generator to use for the current instance
*
* @since 3.3.0
* @since 3.36.3 Fix error causing `null` to be returned instead of expected `WP_Error`.
* Return the generator name on success instead of void.
*
* @param string $generator Generator string, eg: "LifterLMS/SingleCourseExporter"
* @return string|WP_Error Name of the generator on success, otherwise an error object.
*/
public function set_generator( $generator = null ) {
// Interpret the generator from the raw data.
if ( empty( $generator ) ) {
// No generator can be interpreted.
if ( ! isset( $this->raw['_generator'] ) ) {
$this->error->add( 'missing-generator', __( 'The supplied file cannot be processed by the importer.', 'lifterlms' ) );
return $this->error;
}
// Set the generator using the interpreted data.
return $this->set_generator( $this->raw['_generator'] );
}
// Invalid generator.
if ( ! $this->is_generator_valid( $generator ) ) {
$this->error->add( 'invalid-generator', __( 'The supplied generator is invalid.', 'lifterlms' ) );
return $this->error;
}
// Set the generator.
$generators = $this->get_generators();
$this->generator = $generators[ $generator ];
// Return the generator name.
return $generator;
}
}
================================================
FILE: includes/class.llms.hasher.php
================================================
<?php
/**
* LifterLMS hash ID encrypt/decrypt
*
* Based on PseudoCrypt by KevBurns (http://blog.kevburnsjr.com/php-unique-hash).
*
* Modified from original source to remove reliance on bcmath functions.
*
* @package LifterLMS/Classes
*
* @since 3.16.7
* @version 3.24.0
*
* @link http://stackoverflow.com/a/1464155/933782
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Hasher
*
* @since 3.16.7
* @since 3.24.0 Unknown.
*/
class LLMS_Hasher {
/**
* Key: Next prime greater than 62 ^ n / 1.618033988749894848
* Value: modular multiplicative inverse
*
* @var array
*/
private static $golden_primes = array(
'1' => '1',
'41' => '59',
'2377' => '1677',
'147299' => '187507',
'9132313' => '5952585',
'566201239' => '643566407',
'35104476161' => '22071637057',
'2176477521929' => '294289236153',
'134941606358731' => '88879354792675',
'8366379594239857' => '7275288500431249',
'518715534842869223' => '280042546585394647',
);
/**
* Ascii = 0 9, A Z, a z
* $chars = array_merge(range(48,57), range(65,90), range(97,122))
*
* @var array
*/
private static $chars62 = array(
0 => 48,
1 => 49,
2 => 50,
3 => 51,
4 => 52,
5 => 53,
6 => 54,
7 => 55,
8 => 56,
9 => 57,
10 => 65,
11 => 66,
12 => 67,
13 => 68,
14 => 69,
15 => 70,
16 => 71,
17 => 72,
18 => 73,
19 => 74,
20 => 75,
21 => 76,
22 => 77,
23 => 78,
24 => 79,
25 => 80,
26 => 81,
27 => 82,
28 => 83,
29 => 84,
30 => 85,
31 => 86,
32 => 87,
33 => 88,
34 => 89,
35 => 90,
36 => 97,
37 => 98,
38 => 99,
39 => 100,
40 => 101,
41 => 102,
42 => 103,
43 => 104,
44 => 105,
45 => 106,
46 => 107,
47 => 108,
48 => 109,
49 => 110,
50 => 111,
51 => 112,
52 => 113,
53 => 114,
54 => 115,
55 => 116,
56 => 117,
57 => 118,
58 => 119,
59 => 120,
60 => 121,
61 => 122,
);
/**
* Modulo function
*
* @todo figure this out better...
* 64 bit systems can use % without issue
* 32 bit systems have problems with % and needs to use fmod
* however after 100001 unhash no longer works correctly when using fmod
*
* @param int $a first int
* @param int $b second int
* @return int
* @since 3.16.10
* @version 3.16.10
*/
private static function mod( $a, $b ) {
// 64 bit systems
if ( 8 === PHP_INT_SIZE ) {
return $a % $b;
}
// 32 bit systems?
return fmod( $a, $b );
}
/**
* Base 62 encode a number
*
* @param int $int number to encode
* @return string
* @since 3.16.7
* @version 3.16.10
*/
public static function base62( $int ) {
$key = '';
while ( $int > 0 ) {
$mod = self::mod( $int, 62 );
$key .= chr( self::$chars62[ $mod ] );
$int = floor( $int / 62 );
}
return strrev( $key );
}
/**
* Hash a number
*
* @param int $num number to hash
* @return string
* @since 3.16.7
* @version 3.24.0
*/
public static function hash( $num ) {
$numlen = strlen( $num );
if ( $numlen <= 3 ) {
$len = 3;
} elseif ( 4 === $numlen || 5 === $numlen ) {
$len = 4;
} else {
$len = 5;
}
$ceil = pow( 62, $len );
$primes = array_keys( self::$golden_primes );
$prime = $primes[ $len ];
$dec = self::mod( ( $num * $prime ), $ceil );
$hash = self::base62( $dec );
return str_pad( $hash, $len, '0', STR_PAD_LEFT );
}
/**
* Decode a base62 encoded string to get the associated number
*
* @param string $key encoded character
* @return int
* @since 3.16.7
* @version 3.16.7
*/
public static function unbase62( $key ) {
$int = 0;
foreach ( str_split( strrev( $key ) ) as $i => $char ) {
$dec = array_search( ord( $char ), self::$chars62 );
$int = ( ( $dec * pow( 62, $i ) ) + $int );
}
return $int;
}
/**
* Decode a hashed string to get the original number
*
* @param [type] $hash encoded hash string
* @return int
* @since 3.16.7
* @version 3.16.10
*/
public static function unhash( $hash ) {
$len = strlen( $hash );
$ceil = pow( 62, $len );
$mmiprimes = array_values( self::$golden_primes );
$mmi = $mmiprimes[ $len ];
$num = self::unbase62( $hash );
$dec = self::mod( ( $num * $mmi ), $ceil );
return $dec;
}
}
================================================
FILE: includes/class.llms.https.php
================================================
<?php
/**
* Handle HTTPS related redirects
*
* @package LifterLMS/Classes
*
* @since 3.0.0
* @version 3.35.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_HTTPS
*
* @since 3.0.0
* @since 3.35.1 Sanitize `$_SERVER` input.
*/
class LLMS_HTTPS {
/**
* Constructor
*
* @since 3.0.0
*/
public function __construct() {
if ( 'yes' === get_option( 'lifterlms_checkout_force_ssl' ) ) {
add_action( 'template_redirect', array( $this, 'force_https_redirect' ) );
add_action( 'template_redirect', array( $this, 'unforce_https_redirect' ) );
}
}
/**
* Retrieve the http/s version of the current url.
*
* @since 3.35.1
*
* @param bool $https If true, gets the HTTPS url, otherwise gets url without HTTPS
* @return string
*/
protected function get_force_redirect_url( $https = true ) {
$uri = ! empty( $_SERVER['REQUEST_URI'] ) ? filter_var( wp_unslash( $_SERVER['REQUEST_URI'] ), FILTER_SANITIZE_URL ) : '';
// URI is http, switch it to https.
if ( $uri && 0 === strpos( $uri, 'http' ) ) {
return $https ? preg_replace( '|^http://|', 'https://', $uri ) : preg_replace( '|^https://|', 'http://', $uri );
}
// URI doesn't have a protocol, build a new uri.
$redirect = $https ? 'https://' : 'http://';
if ( ! empty( $_SERVER['HTTP_X_FORWARDED_HOST'] ) ) {
$redirect .= sanitize_text_field( wp_unslash( $_SERVER['HTTP_X_FORWARDED_HOST'] ) );
} elseif ( ! empty( $_SERVER['HTTP_HOST'] ) ) {
$redirect .= sanitize_text_field( wp_unslash( $_SERVER['HTTP_HOST'] ) );
}
$redirect .= $uri;
return $redirect;
}
/**
* Redirect to https checkout page is force is enabled
*
* @since 3.0.0
* @since 3.10.0 Unknown
* @since 3.35.1 Sanitize `$_SERVER` input.
*
* @return void
*/
public function force_https_redirect() {
if ( ! is_ssl() && ( is_llms_checkout() || is_llms_account_page() || apply_filters( 'llms_force_ssl_checkout', false ) ) ) {
llms_redirect_and_exit(
$this->get_force_redirect_url( true ),
array(
'status' => 301,
)
);
}
}
/**
* Redirect back to http when not on checkout if force ssl is enabled and the site isn't fully ssl'd
*
* @since 3.0.0
* @since 3.10.0 Unknown
* @since 3.35.1 Sanitize `$_SERVER` input.
*
* @return void
*/
public function unforce_https_redirect() {
if ( ! llms_is_site_https() && is_ssl() && ! is_llms_checkout() & ! is_llms_account_page() && ! llms_is_ajax() && apply_filters( 'llms_unforce_ssl_checkout', true ) ) {
llms_redirect_and_exit(
$this->get_force_redirect_url( false ),
array(
'status' => 301,
)
);
}
}
}
return new LLMS_HTTPS();
================================================
FILE: includes/class.llms.install.php
================================================
<?php
/**
* LLMS_Install class file
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 7.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Install LifterLMS
*
* Creates required pages, cronjobs, options, tables, and more.
*
* Additionally handles running database updates and migrations required with plugin updates.
*
* @since 1.0.0
* @since 4.0.0 Added db update functions for session manager library cleanup.
* @since 4.15.0 Added db update functions for orphan access plans cleanup.
* @since 5.2.0 Removed private class property $db_updates.
* @since 6.0.0 Removed deprecated items.
* - `LLMS_Install::db_updates()` method
* - `LLMS_Install::update_notice()` method
*/
class LLMS_Install {
/**
* Instances of the bg updater.
*
* @var LLMS_Background_Updater
*/
public static $background_updater;
/**
* Initialize the install class
*
* Hooks all actions.
*
* @since 3.0.0
* @since 3.4.3 Unknown.
*
* @return void
*/
public static function init() {
include_once ABSPATH . 'wp-admin/includes/plugin.php';
require_once 'admin/llms.functions.admin.php';
add_action( 'init', array( __CLASS__, 'init_background_updater' ), 4 );
add_action( 'init', array( __CLASS__, 'check_version' ), 5 );
add_action( 'admin_init', array( __CLASS__, 'update_actions' ) );
add_action( 'admin_init', array( __CLASS__, 'wizard_redirect' ) );
}
/**
* Checks the current LLMS version and runs installer if required
*
* @since 3.0.0
*
* @return void
*/
public static function check_version() {
if ( ! defined( 'IFRAME_REQUEST' ) && get_option( 'lifterlms_current_version' ) !== llms()->version ) {
self::install();
do_action( 'lifterlms_updated' );
}
}
/**
* Create LifterLMS cron jobs
*
* @since 1.0.0
* @since 3.28.0 Remove unused cronjob `lifterlms_cleanup_sessions`.
* @since 4.0.0 Add expired session cleanup.
* @since 4.5.0 Add log backup cron.
*
* @return void
*/
public static function create_cron_jobs() {
$crons = array(
array(
/**
* Filter the recurrence interval at which files in the LifterLMS logs are scanned and backed up.
*
* @since 4.5.0
*
* @link https://developer.wordpress.org/reference/functions/wp_get_schedules/
*
* @param string $recurrence Cron job recurrence interval. Must be valid interval as retrieved from `wp_get_schedules()`. Default is "daily".
*/
'hook' => 'llms_backup_logs',
'interval' => apply_filters( 'llms_backup_logs_interval', 'daily' ),
),
array(
/**
* Filter the recurrence interval at which files in the LifterLMS tmp directory are cleaned.
*
* @since 4.5.0
*
* @link https://developer.wordpress.org/reference/functions/wp_get_schedules/
*
* @param string $recurrence Cron job recurrence interval. Must be valid interval as retrieved from `wp_get_schedules()`. Default is "daily".
*/
'hook' => 'llms_cleanup_tmp',
'interval' => apply_filters( 'llms_cleanup_tmp_interval', 'daily' ),
),
array(
'hook' => 'llms_send_tracking_data',
/**
* Filter the recurrence interval at which tracking data is gathered and sent.
*
* @since Unknown
*
* @link https://developer.wordpress.org/reference/functions/wp_get_schedules/
*
* @param string $recurrence Cron job recurrence interval. Must be valid interval as retrieved from `wp_get_schedules()`. Default is "daily".
*/
'interval' => apply_filters( 'llms_tracker_schedule_interval', 'daily' ),
),
array(
'hook' => 'llms_delete_expired_session_data',
/**
* Filter the recurrence interval at which expired session are removed from the database.
*
* @since 4.0.0
*
* @link https://developer.wordpress.org/reference/functions/wp_get_schedules/
*
* @param string $recurrence Cron job recurrence interval. Must be valid interval as retrieved from `wp_get_schedules()`. Default is "hourly".
*/
'interval' => apply_filters( 'llms_delete_expired_session_data_recurrence', 'hourly' ),
),
);
foreach ( $crons as $data ) {
if ( ! wp_next_scheduled( $data['hook'] ) ) {
wp_schedule_event( time(), $data['interval'], $data['hook'] );
}
}
}
/**
* Create basic course difficulties on installation
*
* @since 3.0.4
*
* @return void
*/
public static function create_difficulties() {
foreach ( self::get_difficulties() as $name ) {
// Only create if it doesn't already exist.
if ( ! get_term_by( 'name', $name, 'course_difficulty' ) ) {
wp_insert_term( $name, 'course_difficulty' );
}
}
}
/**
* Create files needed by LifterLMS
*
* @since 3.0.0
* @since 3.15.0 Unknown.
*
* @return void
*/
public static function create_files() {
$upload_dir = wp_upload_dir();
$files = array(
array(
'base' => LLMS_LOG_DIR,
'file' => '.htaccess',
'content' => 'deny from all',
),
array(
'base' => LLMS_LOG_DIR,
'file' => 'index.html',
'content' => '',
),
array(
'base' => LLMS_TMP_DIR,
'file' => '.htaccess',
'content' => 'deny from all',
),
array(
'base' => LLMS_TMP_DIR,
'file' => 'index.html',
'content' => '',
),
);
foreach ( $files as $file ) {
if ( wp_mkdir_p( $file['base'] ) && ! file_exists( trailingslashit( $file['base'] ) . $file['file'] ) ) {
$file_handle = @fopen( trailingslashit( $file['base'] ) . $file['file'], 'w' ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.WP.AlternativeFunctions.file_system_read_fopen
if ( $file_handle ) {
fwrite( $file_handle, $file['content'] ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fwrite
fclose( $file_handle ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fclose
}
}
}
}
/**
* Store all default options in the DB.
*
* @since 1.0.0
* @since 3.8.0 Unknown.
* @since 4.0.0 Include abstract table file.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
public static function create_options() {
$settings = LLMS_Admin_Settings::get_settings_tabs();
foreach ( $settings as $section ) {
foreach ( $section->get_settings( true ) as $value ) {
if ( isset( $value['default'] ) && isset( $value['id'] ) ) {
$autoload = isset( $value['autoload'] ) ? (bool) $value['autoload'] : true;
add_option( $value['id'], $value['default'], '', ( $autoload ? 'yes' : 'no' ) );
}
}
}
}
/**
* Get array of essential starter pages.
*
* @since 7.3.0
*
* @return array
*/
public static function get_pages() {
/**
* Filters the essential starter pages.
*
* These are the pages that are going to be created when installing LifterLMS.
* All these pages, as long as their `docs_url`, `description` and `wizard_title`
* fields are defined, are going to be shown in the Setup Wizard.
*
* @since 7.3.0
*
* @param array $pages A multidimensional array defining the essential starter pages.
*/
return apply_filters(
'llms_install_get_pages',
array(
array(
'content' => '',
'option' => 'lifterlms_shop_page_id',
'slug' => 'courses',
'title' => __( 'Course Catalog', 'lifterlms' ),
'wizard_title' => __( 'Course Catalog', 'lifterlms' ),
'description' => __( 'This page is where your visitors will find a list of all your available courses.', 'lifterlms' ),
'docs_url' => 'https://lifterlms.com/docs/course-catalog/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Wizard&utm_content=LifterLMS%20Course%20Catalog',
),
array(
'content' => '',
'option' => 'lifterlms_memberships_page_id',
'slug' => 'memberships',
'title' => __( 'Membership Catalog', 'lifterlms' ),
'wizard_title' => __( 'Membership Catalog', 'lifterlms' ),
'description' => __( 'This page is where your visitors will find a list of all your available memberships.', 'lifterlms' ),
'docs_url' => 'https://lifterlms.com/docs/membership-catalog/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Wizard&utm_content=LifterLMS%20Membership%20Catalog',
),
array(
'content' => '[lifterlms_checkout]',
'option' => 'lifterlms_checkout_page_id',
'slug' => 'purchase',
'title' => __( 'Purchase', 'lifterlms' ),
'wizard_title' => __( 'Checkout', 'lifterlms' ),
'description' => __( 'This is the page where visitors will be directed in order to pay for courses and memberships.', 'lifterlms' ),
'docs_url' => 'https://lifterlms.com/docs/checkout-page/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Wizard&utm_content=LifterLMS%20Checkout%20Page',
),
array(
'content' => '[lifterlms_my_account]',
'option' => 'lifterlms_myaccount_page_id',
'slug' => 'dashboard',
'title' => __( 'Dashboard', 'lifterlms' ),
'wizard_title' => __( 'Student Dashboard', 'lifterlms' ),
'description' => __( 'Page where students can view and manage their current enrollments, earned certificates and achievements, account information, and purchase history.', 'lifterlms' ),
'docs_url' => 'https://lifterlms.com/docs/student-dashboard/?utm_source=LifterLMS%20Plugin&utm_campaign=Plugin%20to%20Sale&utm_medium=Wizard&utm_content=LifterLMS%20Student%20Dashboard',
),
)
);
}
/**
* Create essential starter pages.
*
* @since 1.0.0
* @since 3.24.0 Unknown.
* @since 7.3.0 Using `$this->get_pages()` method now.
*
* @return boolean False on error, true on success.
*/
public static function create_pages() {
/**
* Filters the essential pages to be installed.
*
* @since 3.0.0
*
* {@see `llms_install_get_pages} filter hook.
*
* @param array $pages A multidimensional array defining the essential starter pages to be installed.
*/
$pages = apply_filters( 'llms_install_create_pages', self::get_pages() );
foreach ( $pages as $page ) {
if ( ! llms_create_page( $page['slug'], $page['title'], $page['content'], $page['option'] ) ) {
return false;
}
}
return true;
}
/**
* Create LifterLMS DB tables
*
* @since 1.0.0
* @since 3.3.1 Unknown.
*
* @return void
*/
public static function create_tables() {
global $wpdb;
$wpdb->hide_errors();
require_once ABSPATH . 'wp-admin/includes/upgrade.php';
dbDelta( self::get_schema() );
}
/**
* Create default LifterLMS Product & Access Plan Visibility Options
*
* @since 3.6.0
* @since 3.8.0 Unknown.
*
* @return void
*/
public static function create_visibilities() {
foreach ( array_keys( llms_get_access_plan_visibility_options() ) as $term ) {
if ( ! get_term_by( 'name', $term, 'llms_access_plan_visibility' ) ) {
wp_insert_term( $term, 'llms_access_plan_visibility' );
}
}
foreach ( array_keys( llms_get_product_visibility_options() ) as $term ) {
if ( ! get_term_by( 'name', $term, 'llms_product_visibility' ) ) {
wp_insert_term( $term, 'llms_product_visibility' );
}
}
}
/**
* Dispatches the bg updater
*
* @since 3.4.3
*
* @return void
*/
public static function dispatch_db_updates() {
self::$background_updater->save()->dispatch();
}
/**
* Retrieve the default difficulty terms that should be created on a fresh install
*
* @since 3.3.1
*
* @return array
*/
public static function get_difficulties() {
return apply_filters(
'llms_install_create_difficulties',
array(
_x( 'Beginner', 'course difficulty name', 'lifterlms' ),
_x( 'Intermediate', 'course difficulty name', 'lifterlms' ),
_x( 'Advanced', 'course difficulty name', 'lifterlms' ),
)
);
}
/**
* Get a string of table data that can be passed to dbDelta() to install LLMS tables.
*
* @since 3.0.0
* @since 3.16.9 Unknown
* @since 3.16.9 Unknown
* @since 3.34.0 Added `llms_install_get_schema` filter to method return.
* @since 3.36.0 Added `wp_lifterlms_events` table.
* @since 4.0.0 Added `wp_lifterlms_sessions` table.
* @since 4.5.0 Added `wp_lifterlms_events_open_sessions` table.
* @since 7.8.0 Added column `can_be_resumed` and `current_question_id` to the quiz attempt table.
*
* @return string
*/
private static function get_schema() {
global $wpdb;
$collate = '';
if ( $wpdb->has_cap( 'collation' ) ) {
if ( ! empty( $wpdb->charset ) ) {
$collate .= "DEFAULT CHARACTER SET $wpdb->charset";
}
if ( ! empty( $wpdb->collate ) ) {
$collate .= " COLLATE $wpdb->collate";
}
}
$tables = "
CREATE TABLE `{$wpdb->prefix}lifterlms_user_postmeta` (
meta_id bigint(20) NOT NULL auto_increment,
user_id bigint(20) NOT NULL,
post_id bigint(20) NOT NULL,
meta_key varchar(255) NULL,
meta_value longtext NULL,
updated_date datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
PRIMARY KEY (`meta_id`),
KEY user_id (`user_id`),
KEY post_id (`post_id`)
) $collate;
CREATE TABLE `{$wpdb->prefix}lifterlms_quiz_attempts` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`student_id` bigint(20) DEFAULT NULL,
`quiz_id` bigint(20) DEFAULT NULL,
`lesson_id` bigint(20) DEFAULT NULL,
`start_date` datetime DEFAULT NULL,
`update_date` datetime DEFAULT NULL,
`end_date` datetime DEFAULT NULL,
`status` varchar(15) DEFAULT '',
`attempt` bigint(20) DEFAULT NULL,
`grade` float DEFAULT NULL,
`can_be_resumed` tinyint(1) DEFAULT '0',
`current_question_id` bigint(20) DEFAULT NULL,
`questions` longtext,
PRIMARY KEY (`id`),
KEY `student_id` (`student_id`),
KEY `quiz_id` (`quiz_id`)
) $collate;
CREATE TABLE `{$wpdb->prefix}lifterlms_product_to_voucher` (
`product_id` bigint(20) NOT NULL,
`voucher_id` bigint(20) NOT NULL,
KEY `product_id` (`product_id`),
KEY `voucher_id` (`voucher_id`)
) $collate;
CREATE TABLE `{$wpdb->prefix}lifterlms_voucher_code_redemptions` (
`id` int(20) unsigned NOT NULL AUTO_INCREMENT,
`code_id` bigint(20) NOT NULL,
`user_id` bigint(20) NOT NULL,
`redemption_date` datetime DEFAULT NULL,
PRIMARY KEY (`id`),
KEY `code_id` (`code_id`),
KEY `user_id` (`user_id`)
) $collate;
CREATE TABLE `{$wpdb->prefix}lifterlms_vouchers_codes` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`voucher_id` bigint(20) NOT NULL,
`code` varchar(20) NOT NULL DEFAULT '',
`redemption_count` bigint(20) DEFAULT NULL,
`is_deleted` tinyint(1) NOT NULL DEFAULT '0',
`created_at` datetime DEFAULT NULL,
`updated_at` datetime DEFAULT NULL,
PRIMARY KEY (`id`),
KEY `code` (`code`),
KEY `voucher_id` (`voucher_id`)
) $collate;
CREATE TABLE `{$wpdb->prefix}lifterlms_notifications` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`created` datetime DEFAULT NULL,
`updated` datetime DEFAULT NULL,
`status` varchar(11) DEFAULT '0',
`type` varchar(75) DEFAULT NULL,
`subscriber` varchar(255) DEFAULT NULL,
`trigger_id` varchar(75) DEFAULT NULL,
`user_id` bigint(20) DEFAULT NULL,
`post_id` bigint(20) DEFAULT NULL,
PRIMARY KEY (`id`),
KEY `status` (`status`),
KEY `type` (`type`),
KEY `subscriber` (`subscriber`(191))
) $collate;
CREATE TABLE `{$wpdb->prefix}lifterlms_events` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`date` datetime DEFAULT NULL,
`actor_id` bigint(20) DEFAULT NULL,
`object_type` varchar(55) DEFAULT NULL,
`object_id` bigint(20) DEFAULT NULL,
`event_type` varchar(55) DEFAULT NULL,
`event_action` varchar(55) DEFAULT NULL,
`meta` longtext DEFAULT NULL,
PRIMARY KEY (`id`),
KEY actor_id (`actor_id`),
KEY object_id (`object_id`)
) $collate;
CREATE TABLE `{$wpdb->prefix}lifterlms_events_open_sessions` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`event_id` bigint(20) unsigned NOT NULL,
PRIMARY KEY (`id`)
) $collate;
CREATE TABLE `{$wpdb->prefix}lifterlms_sessions` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT,
`session_key` char(32) NOT NULL,
`data` longtext NOT NULL,
`expires` BIGINT unsigned NOT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `session_key` (`session_key`)
) $collate;
";
/**
* Filter the database table schema.
*
* @since 3.34.0
*
* @param string $tables A semi-colon (`;`) separated list of database table creating commands.
* @param string $collate Database collation statement.
*/
return apply_filters( 'llms_install_get_schema', $tables, $collate );
}
/**
* Initializes the bg updater class
*
* @since 3.4.3
* @since 3.6.0 Unknown.
* @since 5.2.0 Use `LLMS_PLUGIN_DIR` to include required class file.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
public static function init_background_updater() {
self::$background_updater = new LLMS_Background_Updater();
}
/**
* Core install function
*
* @since 1.0.0
* @since 3.13.0 Unknown.
* @since 5.0.0 Install forms.
* @since 5.2.0 Moved DB update logic to LLMS_Install::run_db_updates().
*
* @return void
*/
public static function install() {
if ( ! is_blog_installed() ) {
return;
}
/**
* Action run immediately prior to LLMS_Install::install() routine.
*
* @since Unknown
*/
do_action( 'lifterlms_before_install' );
LLMS_Site::set_lock_url();
self::create_tables();
self::create_options();
LLMS_Roles::install();
self::verify_permalinks();
LLMS_Post_Types::register_post_types();
LLMS_Post_Types::register_taxonomies();
llms()->query->init_query_vars();
llms()->query->add_endpoints();
self::create_cron_jobs();
self::create_files();
self::create_difficulties();
self::create_visibilities();
LLMS_Forms::instance()->install();
LLMS_Beaver_Builder::instance()->install();
$version = get_option( 'lifterlms_current_version', null );
$db_version = get_option( 'lifterlms_db_version', $version );
// Trigger first time run redirect.
if ( ( is_null( $version ) || is_null( $db_version ) ) || 'no' === get_option( 'lifterlms_first_time_setup', 'no' ) ) {
update_option( '_llms_first_time_setup_redirect', 'yes', false );
}
self::run_db_updates( $db_version );
self::update_llms_version();
flush_rewrite_rules();
/**
* Action run immediately after the LLMS_Install::install() routine has completed.
*
* @since Unknown
*/
do_action( 'lifterlms_after_install' );
}
/**
* Retrieve permalinks structure to verify if they are set, and any new defaults are saved
*
* @since 7.6.0
*
* @return void
*/
public static function verify_permalinks() {
if ( ! get_option( 'lifterlms_permalinks' ) ) {
llms_switch_to_site_locale();
// Retrieve the permalink structure, which will also save the default structure if it's not set.
llms_get_permalink_structure();
llms_restore_locale();
}
}
/**
* Remove the difficulties created by the `create_difficulties()` function
*
* Used during uninstall when "remove_all_data" is set.
*
* @since 3.3.1
*
* @return void
*/
public static function remove_difficulties() {
foreach ( self::get_difficulties() as $name ) {
$term = get_term_by( 'name', $name, 'course_difficulty' );
if ( $term ) {
wp_delete_term( $term->term_id, 'course_difficulty' );
}
}
}
/**
* Run database updates
*
* If no updates are required for the current version, records the DB version as the current
* plugin version.
*
* @since 5.2.0
*
* @param string $db_version The DB version to upgrade from.
* @return void
*/
private static function run_db_updates( $db_version ) {
if ( ! is_null( $db_version ) ) {
// Load the upgrader.
$upgrader = new LLMS_DB_Upgrader( $db_version );
if ( $upgrader->update() ) {
return;
}
}
self::update_db_version();
}
/**
* Handle form submission of update related actions
*
* @since 3.4.3
* @since 5.2.0 Use `LLMS_DB_Upgrader` and remove the "force upgrade" action handler.
*
* @return void
*/
public static function update_actions() {
if ( empty( $_GET['llms-db-update'] ) ) {
return;
}
if ( ! isset( $_REQUEST['llms-db-update'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['llms-db-update'] ) ), 'do_db_updates' ) ) {
wp_die( esc_html__( 'Action failed. Please refresh the page and retry.', 'lifterlms' ) );
}
if ( ! current_user_can( 'manage_options' ) ) {
wp_die( esc_html__( 'You are not allowed to perform the requested action.', 'lifterlms' ) );
}
LLMS_Admin_Notices::delete_notice( 'bg-db-update' );
$upgrader = new LLMS_DB_Upgrader( get_option( 'lifterlms_db_version' ) );
$upgrader->enqueue_updates();
llms_redirect_and_exit( remove_query_arg( array( 'llms-db-update' ) ) );
}
/**
* Update the LifterLMS DB record to the latest version
*
* @since 3.0.0
* @since 3.4.3 Unknown.
*
* @param string $version Version number.
* @return void
*/
public static function update_db_version( $version = null ) {
delete_option( 'lifterlms_db_version' );
add_option( 'lifterlms_db_version', is_null( $version ) ? llms()->version : $version );
}
/**
* Update the LifterLMS version record to the latest version
*
* @since 3.0.0
* @since 3.4.3 Unknown.
*
* @param string $version Version number.
* @return void
*/
public static function update_llms_version( $version = null ) {
delete_option( 'lifterlms_current_version' );
add_option( 'lifterlms_current_version', is_null( $version ) ? llms()->version : $version );
}
/**
* Redirects users to the setup wizard
*
* @since 1.0.0
* @since 3.0.0 Unknown.
* @since 5.2.0 Use strict array comparison and `wp_safe_redirect()` in favor of `wp_redirect()`.
*
* @return void
*/
public static function wizard_redirect() {
if ( 'yes' === get_option( '_llms_first_time_setup_redirect', 'no' ) ) {
update_option( '_llms_first_time_setup_redirect', 'no' );
if ( ( ! empty( $_GET['page'] ) && in_array( $_GET['page'], array( 'llms-setup' ), true ) ) || is_network_admin() || isset( $_GET['activate-multi'] ) || apply_filters( 'llms_prevent_automatic_wizard_redirect', false ) ) {
return;
}
if ( current_user_can( 'install_plugins' ) ) {
wp_safe_redirect( admin_url() . '?page=llms-setup' );
exit;
}
}
}
/**
* Get the WP User ID of the first available user who can 'manage_options'
*
* @since 5.0.0
*
* @return int Returns the ID of the current user if they can 'manage_options'.
* Otherwise returns the ID of the first Administrator if they can 'manage_options'.
* Returns 0 if the first Administrator cannot 'manage_options' or the current site has no Administrators.
*/
public static function get_can_install_user_id() {
$capability = 'manage_options';
if ( current_user_can( $capability ) ) {
return get_current_user_id();
}
// Get the first user with administrator role.
// Here, for simplicity, we're assuming the administrator's role capabilities are the original ones.
$first_admin_user = get_users(
array(
'role' => 'Administrator',
'number' => 1,
'orderby' => 'ID',
)
);
// Return 0 if the first Administrator cannot 'manage_options' or the current site has no Administrators.
return ! empty( $first_admin_user ) && $first_admin_user[0]->has_cap( $capability ) ? $first_admin_user[0]->ID : 0;
}
}
LLMS_Install::init();
================================================
FILE: includes/class.llms.integrations.php
================================================
<?php
/**
* LifterLMS Integrations
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Integrations
*
* @since 1.0.0
* @since 3.18.2 Updated.
* @since 3.33.1 Integrations are now loaded based on their defined priority.
* @since 3.33.2 Integration priority checks are backwards compatible to handle deprecated legacy integrations.
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
* @since 6.0.0 Removed the deprecated `LLMS_Integrations::$_instance` property.
*/
class LLMS_Integrations {
use LLMS_Trait_Singleton;
/**
* Array of integrations, regardless of availability
*
* @var LLMS_Abstract_Integration[]
*/
private $integrations = array();
/**
* Constructor
*
* @since 1.0.0
* @version 3.17.8
*/
private function __construct() {
$this->init();
}
/**
* Get an integration instance by id
*
* @param string $id id of the integration
* @return LLMS_Abstract_Integration|false
* @since 3.8.0
* @version 3.8.0
*/
public function get_integration( $id ) {
$available = $this->get_available_integrations();
return isset( $available[ $id ] ) ? $available[ $id ] : false;
}
/**
* Initialize Integration Classes
*
* @since 1.0.0
* @since 3.18.0 Updated.
* @since 3.33.1 Updated sort order to be based off the priority defined for the integration.
* @since 3.33.2 Made sort order check backwards compatible with deprecated legacy integrations.
*
* @return void
*/
public function init() {
$integrations = apply_filters(
'lifterlms_integrations',
array(
'LLMS_Integration_BBPress',
'LLMS_Integration_Buddypress',
)
);
if ( ! empty( $integrations ) ) {
foreach ( $integrations as $integration ) {
$load_integration = new $integration();
$priority = method_exists( $load_integration, 'get_priority' ) ? $load_integration->get_priority() : 50;
while ( array_key_exists( (string) $priority, $this->integrations ) ) {
$priority += .01;
}
$this->integrations[ (string) $priority ] = $load_integration;
ksort( $this->integrations );
}
}
do_action( 'llms_integrations_init', $this );
}
/**
* Get available integrations
*
* @return LLMS_Abstract_Integration[]
* @since 1.0.0
* @version 3.17.8
*/
public function get_available_integrations() {
$_available_integrations = array();
foreach ( $this->integrations as $integration ) {
if ( $integration->is_available() ) {
$_available_integrations[ $integration->id ] = $integration;
}
}
return apply_filters( 'lifterlms_available_integrations', $_available_integrations );
}
/**
* Get all integrations regardless of availability
*
* @return LLMS_Abstract_Integration[]
* @since 3.18.2
* @version 3.18.2
*/
public function get_integrations() {
return $this->integrations;
}
/**
* Get all integrations regardless of availability
*
* @return LLMS_Abstract_Integration[]
* @since 1.0.0
* @version 3.17.8
* @todo deprecate
*/
public function integrations() {
return $this->get_integrations();
}
}
================================================
FILE: includes/class.llms.l10n.php
================================================
<?php
/**
* Localization Functions
*
* Currently only used to translate strings output by Javascript functions.
* More robust features will be added in the future.
*
* @package LifterLMS/Classes
*
* @since 2.7.3
* @version 3.17.8
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_L10n
*
* @since 2.7.3
* @since 3.17.8 Unknown.
*/
class LLMS_L10n {
/**
* Create an object of translatable strings
*
* This object is added to the LLMS.l10n JS object.
*
* The text used in JS *MUST* exactly match the string found in this object.
*
* @since 2.7.3
* @since 3.17.8 Unknown.
*
* @param boolean $json If `true`, convert to JSON, otherwise return the array.
* @return string|array If `$json` is `true`, returns a JSON string, otherwise an array.
*/
public static function get_js_strings( $json = true ) {
$strings = array();
// Add strings that should only be translated on the admin panel.
if ( is_admin() ) {
$strings = apply_filters( 'lifterlms_js_l10n_admin', $strings );
}
// Allow filtering so extensions don't have to implement their own l10n functions.
$strings = apply_filters( 'lifterlms_js_l10n', $strings );
if ( true === $json ) {
return json_encode( $strings );
} else {
return $strings;
}
}
}
================================================
FILE: includes/class.llms.lesson.handler.php
================================================
<?php
/**
* Lesson Handler Class
*
* Main Handler for lesson management in LifterLMS
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 5.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Lesson_Handler
*
* @since 1.0.0
* @since 5.7.0 Deprecated the `LLMS_Lesson_Handler::assign_to_course()` method with no replacement.
*/
class LLMS_Lesson_Handler {
public function __construct( $lesson ) {}
public static function get_lesson_options_for_select_list() {
$lessons = LLMS_Post_Handler::get_posts( 'lesson' );
$options = array();
if ( ! empty( $lessons ) ) {
foreach ( $lessons as $key => $value ) {
// Get parent course if assigned.
$parent_course = get_post_meta( $value->ID, '_llms_parent_course', true );
if ( $parent_course ) {
$title = $value->post_title . ' ( ' . get_the_title( $parent_course ) . ' )';
} else {
$title = $value->post_title . ' ( ' . __( 'unassigned', 'lifterlms' ) . ' )';
}
$options[ $value->ID ] = $title;
}
}
return $options;
}
/**
* Assigns the lesson to a section and course, optionally by duplicating it.
*
* @since 1.2.4 Introduced.
* @deprecated 5.7.0 There is not a replacement.
*
* @param int $course_id
* @param int $section_id
* @param int $lesson_id
* @param bool $duplicate
* @param bool $reset_order
* @return false|int|WP_Error
*/
public static function assign_to_course( $course_id, $section_id, $lesson_id, $duplicate = true, $reset_order = true ) {
llms_deprecated_function( __METHOD__, '5.7.0' );
// Get position of next lesson.
$section = new LLMS_Section( $section_id );
$lesson_order = $section->get_next_available_lesson_order();
// First determine if lesson is associated with a course.
// We need to know this because if it is already associated then we duplicate it and assign the dupe.
$parent_course = get_post_meta( $lesson_id, '_llms_parent_course', true );
$parent_section = get_post_meta( $lesson_id, '_llms_parent_section', true );
// Parent course exists, lets dupe this baby!.
if ( $parent_course && true == $duplicate ) {
$lesson_id = self::duplicate_lesson( $course_id, $section_id, $lesson_id );
} else {
// Add parent section and course to new lesson.
update_post_meta( $lesson_id, '_llms_parent_section', $section_id );
update_post_meta( $lesson_id, '_llms_parent_course', $course_id );
}
if ( $reset_order ) {
update_post_meta( $lesson_id, '_llms_order', $lesson_order );
}
return $lesson_id;
}
public static function duplicate_lesson( $course_id, $section_id, $lesson_id ) {
if ( ! isset( $course_id ) || ! isset( $section_id ) || ! isset( $lesson_id ) ) {
return false;
}
// Duplicate the lesson.
$new_lesson_id = self::duplicate( $lesson_id );
if ( ! $new_lesson_id ) {
return false;
}
// Add parent section and course to new lesson.
update_post_meta( $new_lesson_id, '_llms_parent_section', $section_id );
update_post_meta( $new_lesson_id, '_llms_parent_course', $course_id );
return $new_lesson_id;
}
public static function duplicate( $post_id ) {
// Make sure we have a post id and it returns a post.
if ( ! isset( $post_id ) ) {
return false;
}
$post_obj = get_post( $post_id );
// Last check.
if ( ! isset( $post_obj ) || null == $post_obj ) {
return false;
}
// No going back now.
// Create duplicate post.
$args = array(
'comment_status' => $post_obj->comment_status,
'ping_status' => $post_obj->ping_status,
'post_author' => $post_obj->post_author,
'post_content' => $post_obj->post_content,
'post_excerpt' => $post_obj->post_excerpt,
'post_name' => $post_obj->post_name,
'post_parent' => $post_obj->post_parent,
'post_status' => 'publish',
'post_title' => $post_obj->post_title,
'post_type' => $post_obj->post_type,
'to_ping' => $post_obj->to_ping,
'menu_order' => $post_obj->menu_order,
'post_password' => $post_obj->post_password,
);
// Create the duplicate post.
$new_post_id = wp_insert_post( $args );
if ( $new_post_id ) {
// Get all current post terms and set them to the new post.
$taxonomies = get_object_taxonomies( $post_obj->post_type );
foreach ( $taxonomies as $taxonomy ) {
$post_terms = wp_get_object_terms(
$post_obj->ID,
$taxonomy,
array(
'fields' => 'slugs',
)
);
wp_set_object_terms( $new_post_id, $post_terms, $taxonomy, false );
}
// Duplicate meta.
$insert_meta = self::duplicate_meta( $post_id, $new_post_id );
}
return $new_post_id;
}
public static function duplicate_meta( $post_id, $new_post_id ) {
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
// Duplicate all post meta.
$post_meta_infos = $wpdb->get_results( "SELECT meta_key, meta_value FROM $wpdb->postmeta WHERE post_id=$post_id" );
if ( count( $post_meta_infos ) != 0 ) {
$sql_query = "INSERT INTO $wpdb->postmeta (post_id, meta_key, meta_value) ";
foreach ( $post_meta_infos as $meta_info ) {
// Do not copy the following meta values.
if ( '_llms_parent_section' === $meta_info->meta_key ) {
$meta_info->meta_value = '';
}
if ( '_llms_parent_course' === $meta_info->meta_key ) {
$meta_info->meta_value = '';
}
if ( '_prerequisite' === $meta_info->meta_key ) {
$meta_info->meta_value = '';
}
if ( '_has_prerequisite' === $meta_info->meta_key ) {
$meta_info->meta_value = '';
}
$meta_key = $meta_info->meta_key;
$meta_value = addslashes( $meta_info->meta_value );
$sql_query_sel[] = "SELECT $new_post_id, '$meta_key', '$meta_value'";
}
$sql_query .= implode( ' UNION ALL ', $sql_query_sel );
$insert_post_meta = $wpdb->query( $sql_query );
return $insert_post_meta;
}
// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
}
================================================
FILE: includes/class.llms.membership.data.php
================================================
<?php
/**
* Query data about a membership.
*
* @package LifterLMS/Classes
*
* @since 3.32.0
* @version 6.10.1
*/
defined( 'ABSPATH' ) || exit;
/**
* Query data about a membership.
*
* @since 3.32.0
* @since 3.35.0 Sanitize post ids from WP_Query before using for a new DB query.
*/
class LLMS_Membership_Data extends LLMS_Abstract_Post_Data {
/**
* Retrieve # of membership enrollments within the period.
*
* @since 3.32.0
*
* @param string $period Optional.Date period [current|previous]. Default 'current'.
* @return int
*/
public function get_enrollments( $period = 'current' ) {
global $wpdb;
return $wpdb->get_var(
$wpdb->prepare(
"
SELECT DISTINCT COUNT( user_id )
FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE meta_value = 'yes'
AND meta_key = '_start_date'
AND post_id = %d
AND updated_date BETWEEN %s AND %s
",
$this->post_id,
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);
}
/**
* Retrieve # of engagements related to the membership awarded within the period.
*
* @since 3.32.0
*
* @param string $type Engagement type [email|certificate|achievement].
* @param string $period Optional. Date period [current|previous]. Default 'current'.
* @return int
*/
public function get_engagements( $type, $period = 'current' ) {
global $wpdb;
return $wpdb->get_var(
$wpdb->prepare(
"
SELECT DISTINCT COUNT( user_id )
FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE meta_key = %s
AND post_id = %d
AND updated_date BETWEEN %s AND %s
",
'_' . $type,
$this->post_id,
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);
}
/**
* Retrieve # of orders placed for the membership within the period.
*
* @since 3.32.0
*
* @param string $period Optional. Date period [current|previous]. Default 'current'.
* @return int
*/
public function get_orders( $period = 'current' ) {
$query = $this->orders_query(
array(
array(
'after' => $this->get_date( $period, 'start' ),
'before' => $this->get_date( $period, 'end' ),
'inclusive' => true,
),
),
1
);
return $query->found_posts;
}
/**
* Retrieve total amount of transactions related to orders for the course completed within the period.
*
* @since 3.32.0
* @since 3.35.0 Sanitize post ids from WP_Query before using for a new DB query.
*
* @param string $period Optional. Date period [current|previous]. Default 'current'.
* @return float
*/
public function get_revenue( $period ) {
$query = $this->orders_query( -1 );
$order_ids = wp_list_pluck( $query->posts, 'ID' );
$revenue = 0;
if ( $order_ids ) {
$order_ids = implode( ',', array_map( 'absint', $order_ids ) );
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- ID list is sanitized via `absint()` earlier in this method.
$revenue = $wpdb->get_var(
$wpdb->prepare(
"SELECT SUM( m2.meta_value )
FROM $wpdb->posts AS p
LEFT JOIN $wpdb->postmeta AS m1 ON m1.post_id = p.ID AND m1.meta_key = '_llms_order_id' -- join for the ID
LEFT JOIN $wpdb->postmeta AS m2 ON m2.post_id = p.ID AND m2.meta_key = '_llms_amount'-- get the actual amounts
WHERE p.post_type = 'llms_transaction'
AND p.post_status = 'llms-txn-succeeded'
AND m1.meta_value IN ({$order_ids})
AND p.post_modified BETWEEN %s AND %s
;",
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);
// phpcs:enabled WordPress.DB.PreparedSQL.InterpolatedNotPrepared
if ( is_null( $revenue ) ) {
$revenue = 0;
}
}
return apply_filters( 'llms_membership_data_get_revenue', $revenue, $period, $this );
}
/**
* Retrieve the number of unenrollments on a given date.
*
* @since 3.32.0
*
* @param string $period Optional. Date period [current|previous]. Default 'current'.
* @return int
*/
public function get_unenrollments( $period = 'current' ) {
global $wpdb;
return $wpdb->get_var(
$wpdb->prepare(
"
SELECT DISTINCT COUNT( user_id )
FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE meta_value != 'enrolled'
AND meta_key = '_status'
AND post_id = %d
AND updated_date BETWEEN %s AND %s
",
$this->post_id,
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);
}
/**
* Execute a WP Query to retrieve orders within the given date range.
*
* @since 3.32.0
* @since 6.10.1 Fixed typo preventing one-time orders from adding to revenue.
*
* @param int $num_orders Optional. Number of orders to retrieve. Default 1.
* @param array $dates Optiona. Date range (passed to WP_Query['date_query']). Default empty array.
* @return obj
*/
private function orders_query( $num_orders = 1, $dates = array() ) {
$args = array(
'post_type' => 'llms_order',
'post_status' => array( 'llms-active', 'llms-completed' ),
'posts_per_page' => $num_orders,
'meta_key' => '_llms_product_id',
'meta_value' => $this->post_id,
);
if ( $dates ) {
$args['date_query'] = $dates;
}
$query = new WP_Query( $args );
return $query;
}
}
================================================
FILE: includes/class.llms.nav.menus.php
================================================
<?php
/**
* LifterLMS Navigation Menus
*
* @package LifterLMS/Classes
*
* @since 3.14.7
* @version 7.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Navigation Menus class.
*
* @since 3.14.7
* @since 3.24.0 Unknown.
* @since 3.37.12 Fixed possible access to undefined index.
* Excluded endpoints with an empty url.
* Made sure to use strict comparisons.
*/
class LLMS_Nav_Menus {
/**
* Constructor.
*
* @since 3.14.7
* @since 3.22.0 Unknown.
* @since 7.1.0 Postpone the LifterLMS menu meta box addition to `admin_head-nav-menus.php`
* rather than `load-nav-menus.php` it's not initially hidden (for new users).
* @since 7.2.0 Add navigation link block and enqueue block editor assets.
* @since 7.3.0 Change `render_block_llms/navigation-link` to `render_block` for compatibility with LLMS block visibility.
*
* @return void
*/
public function __construct() {
// Filter menu items on frontend to add real URLs to menu items.
add_filter( 'wp_nav_menu_objects', array( $this, 'filter_nav_items' ) );
// Add meta box to the Appearance -> Menus screen on admin panel.
add_action( 'admin_head-nav-menus.php', array( $this, 'add_metabox' ) );
// Add LifterLMS menu item type section to customizer.
add_filter( 'customize_nav_menu_available_item_types', array( $this, 'customize_add_type' ) );
// Add LifterLMS menu items links to the customizer.
add_filter( 'customize_nav_menu_available_items', array( $this, 'customize_add_items' ), 10, 4 );
// Add active classes for nav items for catalog pages.
add_filter( 'wp_nav_menu_objects', array( $this, 'menu_item_classes' ) );
// Register block.
add_action( 'init', array( $this, 'register_block' ) );
// Render block.
add_filter( 'render_block', array( $this, 'render_block' ), 10, 2 );
// Load menu items data in block editor.
add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_block_editor_assets' ) );
}
/**
* Add nav menu metabox.
*
* @since 3.14.7
*
* @return void
*/
public function add_metabox() {
add_meta_box( 'llms-nav-menu', __( 'LifterLMS', 'lifterlms' ), array( $this, 'output' ), 'nav-menus', 'side', 'default' );
add_action( 'admin_print_footer_scripts', array( $this, 'output_scripts' ) );
}
/**
* Adds LifterLMS menu items to the customizer.
*
* @since 3.14.7
*
* @param array $items Optional. Menu items. Default empty array.
* @param string $type Optional. Requested menu item type. Default empty string.
* @param string $object Optional. Requested menu item object. Default empty string.
* @param integer $page Optional. Requested page number. Default `0`.
* @return array
*/
public function customize_add_items( $items = array(), $type = '', $object = '', $page = 0 ) {
if ( 'llms_nav' !== $object ) {
return $items;
}
foreach ( $this->get_nav_items() as $id => $data ) {
$items[] = array(
'classes' => 'llms-nav-item-' . $id,
'id' => $id,
'title' => $data['title'],
'type_label' => __( 'Custom Link', 'lifterlms' ),
'url' => esc_url_raw( $data['url'] ),
);
}
return array_slice( $items, 10 * $page, 10 );
}
/**
* Add the LifterLMS menu item section to the customizer.
*
* @since 3.14.7
*
* @param array $types Existing menu item types.
* @return array
*/
public function customize_add_type( $types ) {
$types['llms_nav_menu_items'] = array(
'title' => _x( 'LifterLMS', 'customizer menu section title', 'lifterlms' ),
'type' => 'llms_nav',
'object' => 'llms_nav',
);
return $types;
}
/**
* Filters Nav Menu Items to convert #llms- urls into actual URLs.
*
* Also hides URLs that should only be available to logged-in users.
*
* @since 3.14.7
* @since 3.37.12 Use `in_array` with strict types comparison.
* @since 7.2.0 Remove passing item data by reference and improve URL checks.
*
* @param array $items Nav menu items.
* @return array
*/
public function filter_nav_items( $items ) {
$urls = array(
'#llms-signout',
'#llms-signin',
);
foreach ( $items as $i => $data ) {
$is_object = is_object( $data ) && property_exists( $data, 'url' );
$url = $is_object ? $data->url : $data['url'] ?? '';
if ( ! in_array( $url, $urls, true ) ) {
continue;
}
$data = (object) $data;
$logged_in = is_user_logged_in();
if ( '#llms-signin' === $url && ! $logged_in ) {
$data->url = llms_get_page_url( 'myaccount' );
} elseif ( '#llms-signout' === $url && $logged_in ) {
$data->url = wp_logout_url( llms_get_page_url( 'myaccount' ) );
} else {
unset( $items[ $i ] );
continue;
}
$items[ $i ] = $is_object ? $data : (array) $data;
}
return $items;
}
/**
* Retrieve a filtered array of custom LifterLMS nav menu items.
*
* @since 3.14.7
* @since 3.37.12 Fixed possible access to undefined index.
* Excluded endpoints with an empty url.
*
* @return array
*/
private function get_nav_items() {
$items = array();
foreach ( LLMS_Student_Dashboard::get_tabs() as $id => $data ) {
if ( ! empty( $data['nav_item'] ) ) {
$url = ! empty( $data['endpoint'] ) ? llms_get_endpoint_url( $data['endpoint'], '', llms_get_page_url( 'myaccount' ) ) : '';
// No URL no nav item.
if ( empty( $url ) ) {
if ( empty( $data['url'] ) ) {
continue;
} else {
$url = $data['url'];
}
}
$title = empty( $data['title'] ) ? '' : $data['title'];
$items[ $id ] = array(
'url' => $url,
'label' => $title,
'title' => $title,
);
}
}
$items['signin'] = array(
'url' => '#llms-signin',
'label' => __( 'Sign In', 'lifterlms' ),
'title' => __( 'Sign In', 'lifterlms' ),
);
$items['signout'] = array(
'url' => '#llms-signout',
'label' => __( 'Sign Out', 'lifterlms' ),
'title' => __( 'Sign Out', 'lifterlms' ),
);
/**
* Filters array of custom LifterLMS nav menu items
*
* @since 3.14.7
*
* @param array $items Array of custom LifterLMS nav menu items.
*/
return apply_filters( 'llms_nav_menu_items', $items );
}
/**
* Add "active" classes to menu items for LLMS catalog pages.
*
* @since 3.22.0
* @since 3.37.12 Use strict comparisons.
* Cast `page_for_posts` option to int in order to use strict comparisons.
* @since 4.12.0 Make sure `is_lifterlms()` exists before calling it.
*
* @param array $menu_items Menu items.
* @return array
*/
public function menu_item_classes( $menu_items ) {
if ( ! function_exists( 'is_lifterlms' ) || ! is_lifterlms() ) {
return $menu_items;
}
$courses_id = llms_get_page_id( 'courses' );
$memberships_id = llms_get_page_id( 'memberships' );
$blog_id = absint( get_option( 'page_for_posts', 0 ) );
foreach ( $menu_items as $key => $item ) {
$classes = $item->classes;
$object_id = absint( $item->object_id );
// Remove active class from blog archive.
if ( $blog_id === $object_id ) {
$menu_items[ $key ]->current = false;
foreach ( array( 'current_page_parent', 'current-menu-item' ) as $class ) {
if ( in_array( $class, $classes, true ) ) {
unset( $classes[ array_search( $class, $classes, true ) ] );
}
}
} elseif ( 'page' === $item->object && ( ( is_courses() && $courses_id === $object_id ) || ( is_memberships() && $memberships_id === $object_id ) ) ) {
$menu_items[ $key ]->current = true;
$classes[] = 'current-menu-item';
$classes[] = 'current_page_item';
// Set parent links for courses & memberships.
} elseif ( ( $courses_id === $object_id && ( is_singular( 'course' ) || is_course_taxonomy() ) ) || ( $memberships_id === $object_id && ( is_singular( 'llms_membership' ) || is_membership_taxonomy() ) ) ) {
$classes[] = 'current_page_parent';
}
$menu_items[ $key ]->classes = array_unique( $classes );
}
return $menu_items;
}
/**
* Output the metabox.
*
* @since 3.14.7
* @since 3.24.0 Unknown.
*
* @return void
*/
public function output() {
?>
<div id="posttype-llms-nav-items" class="posttypediv">
<div id="tabs-panel-llms-nav-items" class="tabs-panel tabs-panel-active">
<ul id="llms-nav-items-checklist" class="categorychecklist form-no-clear">
<?php
$i = -1;
foreach ( $this->get_nav_items() as $key => $data ) :
?>
<li>
<label class="menu-item-title">
<input type="checkbox" class="menu-item-checkbox" name="menu-item[<?php echo esc_attr( $i ); ?>][menu-item-object-id]" value="<?php echo esc_attr( $i ); ?>" /> <?php echo esc_html( $data['label'] ); ?>
</label>
<input type="hidden" class="menu-item-type" name="menu-item[<?php echo esc_attr( $i ); ?>][menu-item-type]" value="custom" />
<input type="hidden" class="menu-item-title" name="menu-item[<?php echo esc_attr( $i ); ?>][menu-item-title]" value="<?php echo esc_html( $data['title'] ); ?>" />
<input type="hidden" class="menu-item-url" name="menu-item[<?php echo esc_attr( $i ); ?>][menu-item-url]" value="<?php echo esc_url( $data['url'] ); ?>" />
<input type="hidden" class="menu-item-classes" name="menu-item[<?php echo esc_attr( $i ); ?>][menu-item-classes]" value="<?php echo esc_attr( 'llms-nav-item-' . $key ); ?>" />
</li>
<?php
--$i;
endforeach;
?>
</ul>
</div>
<p class="button-controls">
<span class="list-controls">
<a href="<?php echo esc_url( admin_url( 'nav-menus.php?page-tab=all&selectall=1#posttype-llms-nav-items' ) ); ?>" class="select-all"><?php esc_html_e( 'Select all', 'lifterlms' ); ?></a>
</span>
<span class="add-to-menu">
<input type="submit" class="button-secondary submit-add-to-menu right" value="<?php esc_attr_e( 'Add to menu', 'lifterlms' ); ?>" name="add-post-type-menu-item" id="submit-posttype-llms-nav-items">
<span class="spinner"></span>
</span>
</p>
</div>
<?php
}
/**
* Output JS to ensure that users don't edit the #llms-signout URL that's replaced dynamically with an actual signout link.
*
* @since 3.14.7
*
* @return void
*/
public function output_scripts() {
?>
<script type="text/javascript">
jQuery( '#menu-to-edit' ).on( 'click', 'a.item-edit', function() {
var $settings = jQuery(this).closest( '.menu-item-bar' ).next( '.menu-item-settings' ),
$url = $settings.find( '.edit-menu-item-url' );
if ( 0 === $url.val().indexOf( '#llms-sign' ) ) {
$url.closest( 'p.field-url' ).css( 'display', 'none' );
}
} );
</script>
<?php
}
/**
* Register navigation link block.
*
* @since 7.2.0
*
* @return void
*/
public function register_block() {
$block_dir = LLMS_PLUGIN_DIR . 'blocks/navigation-link';
if ( file_exists( "$block_dir/block.json" ) ) {
register_block_type( $block_dir );
}
}
/**
* Render the navigation link block.
*
* @since 7.2.0
* @since 7.3.0 Add block name check since filter changed.
*
* @param string $block_content Block content.
* @param array $block Block data.
* @return string
*/
public function render_block( string $block_content, array $block ): string {
if ( 'llms/navigation-link' !== $block['blockName'] ) {
return $block_content;
}
$items = $this->filter_nav_items( $this->get_nav_items() );
$page = $block['attrs']['page'] ?? 'dashboard';
if ( ! $page ) {
return '';
}
$url = $items[ $page ]['url'] ?? '';
// Support conditional URLs, e.g. when user logged in or not.
if ( ! $url ) {
return '';
}
$label = $block['attrs']['label'] ?? $items[ $page ]['label'] ?? '';
$html = '<li class="wp-block-navigation-item">';
$html .= '<a href="' . esc_url( $url ) . '" class="wp-block-navigation-item__content">';
$html .= '<span class="wp-block-navigation-item__label">';
$html .= esc_html( $label );
$html .= '</span></a></li>';
return $html;
}
/**
* Add LifterLMS nav menu item data to block editor.
*
* @since 7.2.0
*
* @return void
*/
public function enqueue_block_editor_assets() {
$links = array();
foreach ( $this->get_nav_items() as $key => $data ) {
$links[ $key ] = $data['label'];
}
wp_localize_script(
'llms-navigation-link-editor-script',
'llmsNavMenuItems',
$links
);
}
}
return new LLMS_Nav_Menus();
================================================
FILE: includes/class.llms.oembed.php
================================================
<?php
/**
* Handle custom oEmbed Providers
*
* @package LifterLMS/Classes
*
* @since 1.4.6
* @version 1.4.6
*/
defined( 'ABSPATH' ) || exit;
/**
* Handle custom oEmbed Providers
*
* @since 1.4.6
*/
class LLMS_OEmbed {
/**
* Constructor
*
* @since 1.4.6
*
* @return void
*/
public function __construct() {
/**
* Add oEmbed Provider for Wistia
*
* @since 1.4.6
*/
wp_oembed_add_provider( '/https?\:\/\/(.+)?(wistia\.com|wi\.st)\/.*/', 'https://fast.wistia.com/oembed', true );
}
}
return new LLMS_OEmbed();
================================================
FILE: includes/class.llms.payment.gateways.php
================================================
<?php
/**
* LLMS_Payment_Gateways class file.
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 6.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Manage and access LifterLMS payment gateways.
*
* @since 1.0.0
* @since 3.0.0 Unknown.
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
* @since 6.0.0 Removed the deprecated `LLMS_Payment_Gateways::$_instance` property.
*/
class LLMS_Payment_Gateways {
use LLMS_Trait_Singleton;
/**
* Payment Gateways
*
* @var LLMS_Payment_Gateway[]
*/
public $payment_gateways = array();
/**
* Constructor.
*
* @since 3.0.0
*
* @return void
*/
public function __construct() {
add_filter( 'lifterlms_payment_gateways', array( $this, 'add_core_gateways' ) );
/**
* Filters the list of registered LifterLMS Payment Gateway classes.
*
* @since 3.0.0
*
* @param string[] $gateways Array of payment gateway class names.
*/
$gateways = apply_filters( 'lifterlms_payment_gateways', $this->payment_gateways );
foreach ( $gateways as $gateway ) {
$load_gateway = new $gateway();
$order = absint( $load_gateway->get_display_order() );
// If the order already exists create a new order for it.
if ( isset( $this->payment_gateways[ $order ] ) ) {
$order = max( array_keys( $this->payment_gateways ) ) + 1;
}
$this->payment_gateways[ $order ] = $load_gateway;
}
ksort( $this->payment_gateways );
}
/**
* Register core gateways.
*
* @since 3.0.0
*
* @param string[] $gateways Array of gateway class names.
* @return string[]
*/
public function add_core_gateways( $gateways ) {
$gateways[] = 'LLMS_Payment_Gateway_Manual';
return $gateways;
}
/**
* Get only enabled payment gateways.
*
* @since 3.0.0
*
* @return array
*/
public function get_enabled_payment_gateways() {
$gateways = array();
foreach ( $this->get_payment_gateways() as $gateway ) {
if ( $gateway->is_enabled() ) {
$gateways[ $gateway->get_id() ] = $gateway;
}
}
/**
* Filters the registered LifterLMS Payment Gateways which are explicitly enabled.
*
* @since 3.0.0
*
* @param LLMS_Payment_Gateway[] $gateways List of enabled gateways.
*/
return apply_filters( 'lifterlms_enabled_payment_gateways', $gateways );
}
/**
* Retrieves the default payment gateway ID.
*
* The default gateway is the first gateway in the list of enabled gateways.
*
* @since 3.0.0
*
* @return string
*/
public function get_default_gateway() {
$gateways = $this->get_enabled_payment_gateways();
$ids = array_keys( $gateways );
return array_shift( $ids );
}
/**
* Retrieves a payment gateway object by the gateway ID.
*
* @since 2.5.0
*
* @param string $id id of the gateway (paypal, stripe, etc...)
* @return LLMS_Payment_Gateway|boolean Returns the gateway if it's registered, otherwise `false`.
*/
public function get_gateway_by_id( $id ) {
$gateways = $this->get_payment_gateways();
if ( array_key_exists( $id, $gateways ) ) {
return $gateways[ $id ];
}
return false;
}
/**
* Retrieves all registered payment gateways.
*
* @since 3.0.0
*
* @return LLMS_Payment_Gateway[]
*/
public function get_payment_gateways() {
$gateways = array();
foreach ( $this->payment_gateways as $gateway ) {
$gateways[ $gateway->id ] = $gateway;
}
return $gateways;
}
/**
* Retrieves all enabled gateways which support the specified gateway feature.
*
* @since 3.10.0
*
* @see LLMS_Payment_Gateway::get_supported_features()
*
* @param string $feature A gateway feature string.
* @return array
*/
public function get_supporting_gateways( $feature ) {
$gateways = array();
foreach ( $this->get_enabled_payment_gateways() as $id => $gateway ) {
if ( $gateway->supports( $feature ) ) {
$gateways[ $id ] = $gateway;
}
}
/**
* Filters the list of gateways supporting the specified feature.
*
* Hook description.
*
* @since 3.10.0
*
* @param LLMS_Payment_Gateway[] $gateways Array of supporting gateways.
* @param string $feature The requested gateway feature string.
*/
return apply_filters( 'lifterlms_supporting_payment_gateways', $gateways, $feature );
}
/**
* Determines if any payment gateways are registered.
*
* @since 3.0.0
* @since 6.5.0 Refactor for code simplicity.
*
* @param boolean $enabled Whether or not to check against only enabled gateways.
* @return boolean
*/
public function has_gateways( $enabled = false ) {
$method = $enabled ? 'get_enabled_payment_gateways' : 'get_payment_gateways';
return count( $this->{$method}() ) >= 1;
}
}
================================================
FILE: includes/class.llms.person.handler.php
================================================
<?php
/**
* User Handling for login and registration (mostly)
*
* @package LifterLMS/Classes
*
* @since 3.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Person_Handler class.
*
* @since 3.0.0
* @since 3.35.0 Sanitize field data when filling field with user-submitted data.
* @since 5.0.0 Private methods `LLMS_Person_Handler::fill_fields()` and `LLMS_Person_Handler::insert_data()` were removed.
* @since 6.0.0 Removed deprecated items.
* - `LLMS_Person_Handler::register()` method
* - `LLMS_Person_Handler::sanitize_field() method`
* - `LLMS_Person_Handler::update()` method
* - `LLMS_Person_Handler::validate_fields()` method
* - `LLMS_Person_Handler::voucher_toggle_script()` method
*/
class LLMS_Person_Handler {
/**
* Prefix for all user meta field keys
*
* @var string
*/
private static $meta_prefix = 'llms_';
/**
* Prevents the hacky voucher script from being output multiple times
*
* @var boolean
*/
private static $voucher_script_output = false;
/**
* Locate password fields from a given form location.
*
* @since 5.0.0
*
* @param string $location From location.
* @return false|array[]
*/
protected static function find_password_fields( $location ) {
$forms = LLMS_Forms::instance();
$all = $forms->get_form_fields( $location );
$pwd = $forms->get_field_by( (array) $all, 'id', 'password' );
// If we don't have a password in the form return early.
if ( ! $pwd ) {
return false;
}
// Setup the return array.
$fields = array( $pwd );
// Add confirmation and strength meter if they exist.
foreach ( array( 'password_confirm', 'llms-password-strength-meter' ) as $id ) {
$field = $forms->get_field_by( $all, 'id', $id );
if ( $field ) {
// If we have a confirmation field ensure that the fields sit side by side.
if ( 'password_confirm' === $id ) {
$fields[0]['columns'] = 6;
$fields[0]['last_column'] = false;
$fields[0]['wrapper_classes'] = array();
$field['columns'] = 6;
$field['last_column'] = true;
$field['wrapper_classes'] = array();
}
$fields[] = $field;
}
}
return $fields;
}
/**
* Generate a unique login based on the user's email address
*
* @since 3.0.0
* @since 3.19.4 Unknown.
*
* @param string $email User's email address.
* @return string
*/
public static function generate_username( $email ) {
/**
* Allow custom username generation
*
* @since 3.0.0
*
* @param string $custom_username The custom-generated username. If the filter returns a truthy string it will be used in favor
* of the automatically generated username.
* @param string $email User's email address.
*/
$custom_username = apply_filters( 'lifterlms_generate_username', null, $email );
if ( $custom_username && is_string( $custom_username ) ) {
return $custom_username;
}
$username = sanitize_user( current( explode( '@', $email ) ), true );
$orig_username = $username;
$i = 1;
while ( username_exists( $username ) ) {
$username = $orig_username . $i;
++$i;
}
/**
* Modify an auto-generated username before it is used
*
* @since 3.0.0
*
* @param string $username The generated user name.
* @param string $email User's email address which was used to generate the username.
*/
return apply_filters( 'lifterlms_generated_username', $username, $email );
}
/**
* Get the fields for the login form
*
* @since 3.0.0
* @since 3.0.4 Unknown.
* @since 5.0.0 Remove usage of the deprecated `lifterlms_registration_generate_username`.
*
* @param string $layout Form layout. Accepts "columns" (default) or "stacked".
* @return array[] An array of form field arrays.
*/
public static function get_login_fields( $layout = 'columns' ) {
$usernames = LLMS_Forms::instance()->are_usernames_enabled();
/**
* Customize the fields used to build the user login form
*
* @since 3.0.0
* @param array[] $fields An array of form field arrays.
*/
return apply_filters(
'lifterlms_person_login_fields',
array(
array(
'columns' => ( 'columns' == $layout ) ? 6 : 12,
'id' => 'llms_login',
'label' => ! $usernames ? __( 'Email Address', 'lifterlms' ) : __( 'Username or Email Address', 'lifterlms' ),
'last_column' => ( 'columns' == $layout ) ? false : true,
'required' => true,
'type' => ! $usernames ? 'email' : 'text',
),
array(
'columns' => ( 'columns' == $layout ) ? 6 : 12,
'id' => 'llms_password',
'label' => __( 'Password', 'lifterlms' ),
'last_column' => ( 'columns' == $layout ) ? true : true,
'required' => true,
'type' => 'password',
'visibility_toggle' => true,
),
array(
'columns' => ( 'columns' == $layout ) ? 3 : 12,
'classes' => 'llms-button-action',
'id' => 'llms_login_button',
'value' => __( 'Login', 'lifterlms' ),
'last_column' => ( 'columns' == $layout ) ? false : true,
'required' => false,
'type' => 'submit',
),
array(
'columns' => ( 'columns' == $layout ) ? 6 : 6,
'id' => 'llms_remember',
'label' => __( 'Remember me', 'lifterlms' ),
'last_column' => false,
'required' => false,
'type' => 'checkbox',
),
array(
'columns' => ( 'columns' == $layout ) ? 3 : 6,
'id' => 'llms_lost_password',
'last_column' => true,
'description' => '<a href="' . esc_url( wp_lostpassword_url() ) . '">' . __( 'Lost your password?', 'lifterlms' ) . '</a>',
'type' => 'html',
'wrapper_classes' => 'align-right',
),
)
);
}
/**
* Retrieve fields for password recovery
*
* Used to generate the form where a username/email is entered to start the password reset process.
*
* @since 3.8.0
* @since 5.0.0 Use LLMS_Forms::are_usernames_enabled() in favor of deprecated option "lifterlms_registration_generate_username".
* Remove field values set to the default value for a form field.
*
* @return array[] An array of form field arrays.
*/
public static function get_lost_password_fields() {
$usernames = LLMS_Forms::instance()->are_usernames_enabled();
if ( ! $usernames ) {
$message = __( 'Lost your password? Enter your email address and we will send you a link to reset it.', 'lifterlms' );
} else {
$message = __( 'Lost your password? Enter your username or email address and we will send you a link to reset it.', 'lifterlms' );
}
/**
* Filter the message displayed on the lost password form.
*
* @since Unknown.
*
* @param string $message The message displayed before the form.
*/
$message = apply_filters( 'lifterlms_lost_password_message', $message );
/**
* Filter the form fields displayed for the lost password form.
*
* @since 3.8.0
*
* @param array[] $fields An array of form field arrays.
*/
return apply_filters(
'lifterlms_lost_password_fields',
array(
array(
'id' => 'llms_lost_password_message',
'type' => 'html',
'value' => $message,
),
array(
'id' => 'llms_login',
'label' => ! $usernames ? __( 'Email Address', 'lifterlms' ) : __( 'Username or Email Address', 'lifterlms' ),
'required' => true,
'type' => ! $usernames ? 'email' : 'text',
),
array(
'classes' => 'llms-button-action auto',
'id' => 'llms_lost_password_button',
'value' => __( 'Reset Password', 'lifterlms' ),
'type' => 'submit',
),
)
);
}
/**
* Retrieve an array of password fields.
*
* This is only used on the password rest form as a fallback
* when no "custom" password fields can be found in either of the default
* checkout or registration forms.
*
* @since 3.7.0
* @since 5.0.0 Removed optional parameters
*
* @return array[]
*/
private static function get_password_fields() {
$fields = array();
$fields[] = array(
'columns' => 6,
'classes' => 'llms-password',
'id' => 'password',
'label' => __( 'Password', 'lifterlms' ),
'last_column' => false,
'match' => 'password_confirm',
'required' => true,
'type' => 'password',
'visibility_toggle' => true,
);
$fields[] = array(
'columns' => 6,
'classes' => 'llms-password-confirm',
'id' => 'password_confirm',
'label' => __( 'Confirm Password', 'lifterlms' ),
'match' => 'password',
'required' => true,
'type' => 'password',
);
$fields[] = array(
'classes' => 'llms-password-strength-meter',
'description' => __( 'A strong password is required. The password must be at least 6 characters in length. Consider adding letters, numbers, and symbols to increase the password strength.', 'lifterlms' ),
'id' => 'llms-password-strength-meter',
'type' => 'html',
'min_length' => 6,
'min_strength' => 'weak',
);
return $fields;
}
/**
* Retrieve form fields used on the password reset form.
*
* This method will attempt to the "custom" password fields in the checkout form
* and then in the registration form. At least a password field must be found. If
* it cannot be found this function falls back to a set of default fields as defined
* in the LLMS_Person_Handler::get_password_fields() method.
*
* @since Unknown
* @since 5.0.0 Get fields from the checkout or registration forms before falling back to default fields.
* Changed filter on return from "lifterlms_lost_password_fields" to "llms_password_reset_fields".
*
* @param string $key User password reset key, usually populated via $_GET vars.
* @param string $login User login (username), usually populated via $_GET vars.
* @return array[]
*/
public static function get_password_reset_fields( $key = '', $login = '' ) {
$fields = array();
foreach ( array( 'checkout', 'registration' ) as $location ) {
$fields = self::find_password_fields( $location );
if ( $fields ) {
break;
}
}
// Fallback if no custom fields are found.
if ( ! $fields ) {
$location = 'fallback';
$fields = self::get_password_fields();
}
// Add button.
$fields[] = array(
'classes' => 'llms-button-action auto',
'id' => 'llms_lost_password_button',
'type' => 'submit',
'value' => __( 'Reset Password', 'lifterlms' ),
);
// Add hidden fields.
$fields[] = array(
'id' => 'llms_reset_key',
'type' => 'hidden',
'value' => $key,
);
$fields[] = array(
'id' => 'llms_reset_login',
'type' => 'hidden',
'value' => $login,
);
/**
* Filter password reset form fields.
*
* @since 5.0.0
*
* @param array[] $fields Array of form field arrays.
* @param string $key User password reset key, usually populated via $_GET vars.
* @param string $login User login (username), usually populated via $_GET vars.
* @param string $location Location where the fields were retrieved from. Either "checkout", "registration", or "fallback".
* Fallback denotes that no password field was located in either of the previous forms so a default
* set of fields is generated programmatically.
*/
return apply_filters( 'llms_password_reset_fields', $fields, $key, $login, $location );
}
/**
* Login a user
*
* @since 3.0.0
* @since 3.29.4 Unknown.
* @since 5.0.0 Removed email lookup logic since `wp_authenticate()` supports email addresses as `user_login` since WP 4.5.
*
* @param array $data {
* User login information.
*
* @type string $llms_login User email address or username.
* @type string $llms_password User password.
* @type string $llms_remember Whether to extend the cookie duration to keep the user logged in for a longer period.
* }
* @return WP_Error|int The WP_User ID on login success or an error object on failure.
*/
public static function login( $data ) {
/**
* Run an action prior to user login.
*
* @since 3.0.0
*
* @param array $data {
* User login credentials.
*
* @type string $user_login User's username.
* @type string $password User's password.
* @type bool $remeber Whether to extend the cookie duration to keep the user logged in for a longer period.
* }
*/
do_action( 'lifterlms_before_user_login', $data );
/**
* Filter user submitted login data prior to data validation.
*
* @since 3.0.0
*
* @param array $data {
* User login credentials.
*
* @type string $user_login User's username.
* @type string $password User's password.
* @type bool $remeber Whether to extend the cookie duration to keep the user logged in for a longer period.
* }
*/
$data = apply_filters( 'lifterlms_user_login_data', $data );
// Validate the fields & allow custom validation to occur.
$valid = self::validate_login_fields( $data );
// If errors found, return them.
if ( is_wp_error( $valid ) ) {
/**
* Filters the errors found during a LifterLMS user login attempt
*
* @since Unknown
*
* @param WP_Error $valid Error object containing information about the login error.
* @param array $data User submitted login form data.
* @param WP_Error|false $signon The original WP Error object returned by `wp_signon()` or false if the error
* is encountered prior to the signon attempt.
*/
return apply_filters( 'lifterlms_user_login_errors', $valid, $data, false );
}
$creds = array(
'user_login' => wp_unslash( $data['llms_login'] ), // Unslash ensures that an email address with an apostrophe is unescaped for lookups.
'user_password' => $data['llms_password'],
'remember' => isset( $data['llms_remember'] ),
);
/**
* Filter a user's login credentials immediately prior to signing in.
*
* @since Unknown
*
* @param array $creds {
* User login credentials.
*
* @type string $user_login User's username.
* @type string $password User's password.
* @type bool $remeber Whether to extend the cookie duration to keep the user logged in for a longer period.
* }
*/
$creds = apply_filters( 'lifterlms_login_credentials', $creds );
$signon = wp_signon( $creds, is_ssl() );
if ( is_wp_error( $signon ) ) {
$err = new WP_Error( 'login-error', __( 'Could not find an account with the supplied email address and password combination.', 'lifterlms' ) );
// This hook is documented in includes/class.llms.person.handler.php.
return apply_filters( 'lifterlms_user_login_errors', $err, $data, $signon );
}
return $signon->ID;
}
/**
* Validate login form fields
*
* @since 5.0.0
*
* @param array $data Array of user-submitted data, usually from `$_POST`.
* @return WP_Error|true Returns an error object or `true` if the submission is valid.
*/
protected static function validate_login_fields( $data ) {
$err = new WP_Error();
$fields = self::get_login_fields();
foreach ( $fields as $field ) {
$name = isset( $field['name'] ) ? $field['name'] : $field['id'];
$label = isset( $field['label'] ) ? $field['label'] : $name;
$field_type = isset( $field['type'] ) ? $field['type'] : '';
$val = isset( $data[ $name ] ) ? $data[ $name ] : '';
// Ensure required fields are submitted.
if ( ! empty( $field['required'] ) && empty( $val ) ) {
$err->add( $field['id'], sprintf( __( '%s is a required field', 'lifterlms' ), $label ), 'required' );
continue;
}
// Email fields must be emails.
if ( 'email' === $field_type && ! is_email( $val ) ) {
$err->add( $field['id'], sprintf( __( '%s must be a valid email address', 'lifterlms' ), $label ), 'invalid' );
}
}
$valid = $err->has_errors() ? $err : true;
/**
* Filters the validation result of user-submitted login data
*
* @since 4.21.0
*
* @param WP_Error|boolean $valid An error object containing validation errors or `true` if no validation errors found.
* @param array $data User submitted login data.
*/
return apply_filters( 'llms_after_user_login_data_validation', $valid, $data );
}
/**
* Retrieve an array of fields for a specific screen
*
* @since 3.0.0
* @since 3.7.0 Unknown.
* @deprecated 5.0.0 `LLMS_Person_Handler::get_available_fields()` is deprecated in favor of `LLMS_Forms::get_form_fields()`.
*
* @param string $screen Name os the screen [account|checkout|registration].
* @param array|int $data Array of data to fill fields with or a WP User ID.
* @return array
*/
public static function get_available_fields( $screen = 'registration', $data = array() ) {
_deprecated_function( 'LLMS_Person_Handler::get_available_fields()', '5.0.0', 'LLMS_Forms::get_form_fields()' );
return LLMS_Forms::instance()->get_form_fields( $screen );
}
}
================================================
FILE: includes/class.llms.playnice.php
================================================
<?php
/**
* Make LifterLMS play nicely with other plugins, themes, & webhosts
*
* * * * * * * * * * * * * * * * * *
* True, there is no joy *
* in software conflicts (or war) *
* Here we are, trying *
* * * * * * * * * * * * * * * * * *
*
* @package LifterLMS/Classes
*
* @since 3.1.3
* @version 6.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_PlayNice class
*
* @since 3.1.3
* @since 3.31.0 Resolve dashboard endpoint 404s resulting from changes in WC 3.6.
* @since 3.37.17 Changed the way we handle the dashboard endpoints conflict, using a different wc filter hook.
* Deprecated `LLMS_PlayNice::wc_is_account_page()`.
* @since 3.37.18 Resolve Divi/WC conflict encountered using the frontend pagebuilder on courses and memberships.
* @since 4.0.0 Removed previously deprecated method `LLMS_PlayNice::wc_is_account_page()`.
* Remove Divi Frontend Builder WC conflict code.
*/
class LLMS_PlayNice {
/**
* Hold temporary variables used by methods in this class.
*
* @var array
*/
private $temp_vars = array();
/**
* Constructor
*
* @since 3.1.3
* @since 3.31.0 Add `plugins_loaded` hook.
* @since 6.8.0 Account for BuddyBoss compatibility issue.
*
* @return void
*/
public function __construct() {
// Optimize press live editor initialization.
add_action( 'op_liveeditor_init', array( $this, 'wp_optimizepress_live_editor' ) );
// WPEngine heartbeat fix.
add_filter( 'wpe_heartbeat_allowed_pages', array( $this, 'wpe_heartbeat_allowed_pages' ) );
// BuddyBoss profile nav compatibility issue fix (the nav is set up at priority 6).
add_action( 'bp_init', array( $this, 'buddyboss_compatibility' ), 5 );
// Load other playnice things based on the presence of other plugins.
add_action( 'init', array( $this, 'plugins_loaded' ), 11 );
}
/**
* Compatibility for BuddyBoss.
*
* @since 6.8.0
*
* @link https://github.com/gocodebox/lifterlms/issues/2142#issuecomment-1157924080.
*
* @return void
*/
public function buddyboss_compatibility() {
if ( ! function_exists( 'is_plugin_active' ) || ! function_exists( 'bp_is_my_profile' ) || bp_is_my_profile() ) {
return;
}
if (
is_plugin_active( 'buddyboss-platform/bp-loader.php' ) ||
( is_multisite() && is_plugin_active_for_network( 'buddyboss-platform/bp-loader.php' ) )
) {
$plugin_data = get_plugin_data( trailingslashit( WP_PLUGIN_DIR ) . 'buddyboss-platform/bp-loader.php' );
$plugin_version = ! empty( $plugin_data['Version'] ) ? $plugin_data['Version'] : 0;
if ( $plugin_version && version_compare( $plugin_version, '2.0.3', '>=' ) ) {
// Nothing to do.
return;
}
}
// Do not add our profile nav items when not in front-end (and not in "my profile"), to avoid a fatal error.
$bp_integration = llms()->integrations()->get_integration( 'buddypress' );
remove_action( 'bp_setup_nav', array( $bp_integration, 'add_profile_nav_items' ) );
}
/**
* Conditionally add hooks after the other plugin is loaded.
*
* @since 3.31.0
* @since 3.37.17 Changed the way we handle endpoints conflict, using a different WC filter hook.
* @since 3.37.18 Add fix for Divi Frontend-Builder WC conflict.
* @since 4.0.0 Remove Divi Frontend Builder WC conflict code.
*
* @return void
*/
public function plugins_loaded() {
$wc_exists = function_exists( 'WC' );
if ( $wc_exists ) {
add_filter( 'woocommerce_account_endpoint_page_not_found', array( $this, 'wc_account_endpoint_page_not_found' ) );
}
}
/**
* Allow our dashboard endpoints sharing a query var with WC to function
*
* Inform WC that it should not force a 404 because we're on a valid endpoint.
*
* @since 3.37.17
*
* @link https://github.com/gocodebox/lifterlms/issues/849
*
* @param bool $is_page_not_found True from `woocommerce_account_endpoint_page_not_found` filter.
* @return bool
*/
public function wc_account_endpoint_page_not_found( $is_page_not_found ) {
if ( is_llms_account_page() && is_wc_endpoint_url() ) {
$is_page_not_found = false;
}
return $is_page_not_found;
}
/**
* OptimizePress LiveEditor fix.
*
* The live editor for OptimizePress does not work because it is trying to load a frontend environment
* in the admin area and needs access to LifterLMS frontend files.
*
* This function loads all frontend files when the OptimizePress live editor is initialized.
*
* @since 3.2.2
* @since 3.19.6 Unknown.
* @since 4.0.0 Removed inclusion of removed 'class.llms.person.php' file.
* @since 5.0.0 Remove inclusion of removed files:
* + forms/frontend/class.llms.frontend.forms.php
* + forms/frontend/class.llms.frontend.password.php
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
public function wp_optimizepress_live_editor() {
// These files are necessary to get optimizepress ajax to play nicely in the liveeditor.
include_once 'class.llms.ajax.php';
include_once 'class.llms.ajax.handler.php';
// These files are all necessary to get the liveeditor to open.
include_once 'llms.template.functions.php';
include_once 'class.llms.https.php';
include_once 'class.llms.template.loader.php';
include_once 'class.llms.frontend.assets.php';
}
/**
* WPE blocks the WordPress Heartbeat script from being loaded
*
* Event when it's explicitly defined as a dependency.
*
* @since 3.16.4
*
* @param array $pages List of pages that the heartbeat is allowed to load on.
* @return array
*/
public function wpe_heartbeat_allowed_pages( $pages ) {
if ( is_admin() && isset( $_GET['page'] ) && 'llms-course-builder' === $_GET['page'] ) {
$pages[] = 'admin.php';
}
return $pages;
}
}
return new LLMS_PlayNice();
================================================
FILE: includes/class.llms.post-types.php
================================================
<?php
/**
* Register Post Types, Taxonomies, Statuses.
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Post_Types class
*
* @since 1.0.0
* @since 3.30.3 Removed duplicate array keys when registering course_tag taxonomy.
* @since 3.33.0 `llms_question` post type is not publicly queryable anymore.
* @since 3.34.1 Add the custom property `show_in_llms_rest` set to true by default, to those taxonomies we want to be shown in LLMS REST api.
* @since 3.37.12 Added 'revisions' support to course, lesson, and llms_mebership post types.
*/
class LLMS_Post_Types {
/**
* Reference to the block templates list.
*
* @var array
*/
private static $templates = array();
/**
* Constructor
*
* @since 1.0.0
* @since 3.0.4 Unknown.
* @since 4.3.2 Add filter to deregister protected post types.
*
* @return void
*/
public static function init() {
add_action( 'init', array( __CLASS__, 'add_membership_restriction_support' ) );
add_action( 'init', array( __CLASS__, 'register_post_types' ), 5 );
add_action( 'init', array( __CLASS__, 'register_post_statuses' ), 9 );
add_action( 'init', array( __CLASS__, 'register_taxonomies' ), 5 );
add_action( 'admin_bar_menu', array( __CLASS__, 'add_launch_course_builder_to_course_post_type_admin_bar' ), 100 );
add_filter( 'wp_sitemaps_post_types', array( __CLASS__, 'deregister_sitemap_post_types' ) );
add_action( 'after_setup_theme', array( __CLASS__, 'add_thumbnail_support' ), 777 );
}
/**
* Add Launch Course Builder top admin bar button for Course posts.
*
* @since 7.8.0
*
* @return void
*/
public static function add_launch_course_builder_to_course_post_type_admin_bar( $wp_admin_bar ) {
if ( is_admin() || ! is_singular( 'course' ) ) {
return;
}
$url = add_query_arg(
array(
'page' => 'llms-course-builder',
'course_id' => get_the_ID(),
),
admin_url( 'admin.php' )
);
$icon_url = 'data:image/svg+xml;base64,' . base64_encode( file_get_contents( LLMS_PLUGIN_DIR . 'assets/images/lifterlms-icon-grey.svg' ) ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents, WordPress.PHP.DiscouragedPHPFunctions.obfuscation_base64_encode
$wp_admin_bar->add_node(
array(
'id' => 'course_launch_course_builder',
'title' => '<div style="float:left;width:32px;height:32px;background-repeat:no-repeat;background-position:center;background-size:20px auto;background-image:url(\'' . $icon_url . '\')" aria-hidden="true"></div> ' . __( 'Launch Course Builder', 'lifterlms' ),
'href' => $url,
'meta' => array(
'class' => 'llms-admin-bar-launch-course-builder',
'title' => __( 'Launch Course Builder', 'lifterlms' ),
),
)
);
}
/**
* Add post type support for membership restrictions
*
* This enables the "Membership Access" metabox to display
*
* @since 3.0.0
* @since 3.0.4 Unknown.
*
* @return void
*/
public static function add_membership_restriction_support() {
/**
* Add llms-membership-restrictions support for the following post types.
*
* Adding support for a post type enables the display of the Membership Restriction metabox
* for each specified post type.
*
* These post types can then be "restricted" to enrollment in the selected memberships.
*
* @since Unknown
*
* @param string[] $post_types Array of post type names.
*/
$post_types = apply_filters( 'llms_membership_restricted_post_types', array( 'post', 'page' ) );
foreach ( $post_types as $post_type ) {
add_post_type_support( $post_type, 'llms-membership-restrictions' );
}
}
/**
* Ensure LifterLMS Post Types have thumbnail support
*
* @since 2.4.1
* @since 3.8.0 Unknown.
*
* @return void
*/
public static function add_thumbnail_support() {
// Ensure theme support exists for LifterLMS post types.
if ( ! current_theme_supports( 'post-thumbnails' ) ) {
add_theme_support( 'post-thumbnails' );
}
$thumbnail_post_types = array(
'course',
'lesson',
'llms_membership',
);
foreach ( $thumbnail_post_types as $p ) {
add_post_type_support( $p, 'thumbnail' );
}
add_image_size( 'llms_notification_icon', 64, 64, true );
}
/**
* De-register protected post types from wp-sitemap.xml
*
* @since 4.3.2
*
* @param WP_Post_Type[] $post_types Array of post types.
* @return WP_Post_Type[]
*/
public static function deregister_sitemap_post_types( $post_types ) {
unset(
$post_types['lesson'],
$post_types['llms_quiz'],
$post_types['llms_certificate'],
$post_types['llms_my_certificate']
);
return $post_types;
}
/**
* Retrieve all registered order statuses
*
* @since 3.19.0
*
* @return array
*/
public static function get_order_statuses() {
$statuses = array(
// Single payment only.
'llms-completed' => array(
'label' => _x( 'Completed', 'Order status', 'lifterlms' ),
/* translators: %s: Completed count, %s: Completed count. */
'label_count' => _n_noop( 'Completed <span class="count">(%s)</span>', 'Completed <span class="count">(%s)</span>', 'lifterlms' ),
),
// Recurring only.
'llms-active' => array(
'label' => _x( 'Active', 'Order status', 'lifterlms' ),
/* translators: %s: Active count, %s: Active count. */
'label_count' => _n_noop( 'Active <span class="count">(%s)</span>', 'Active <span class="count">(%s)</span>', 'lifterlms' ),
),
'llms-expired' => array(
'label' => _x( 'Expired', 'Order status', 'lifterlms' ),
'label_count' => _n_noop( 'Expired <span class="count">(%s)</span>', 'Expired <span class="count">(%s)</span>', 'lifterlms' ),
),
'llms-on-hold' => array(
'label' => _x( 'On Hold', 'Order status', 'lifterlms' ),
/* translators: %s: On hold count, %s: On hold count. */
'label_count' => _n_noop( 'On Hold <span class="count">(%s)</span>', 'On Hold <span class="count">(%s)</span>', 'lifterlms' ),
),
'llms-pending-cancel' => array(
'label' => _x( 'Pending Cancellation', 'Order status', 'lifterlms' ),
'label_count' => _n_noop( 'Pending Cancellation <span class="count">(%s)</span>', 'Pending Cancellation <span class="count">(%s)</span>', 'lifterlms' ),
),
// Shared.
'llms-pending' => array(
'label' => _x( 'Pending Payment', 'Order status', 'lifterlms' ),
/* translators: %s: Pending Payment count, %s: Pending Payment count. */
'label_count' => _n_noop( 'Pending Payment <span class="count">(%s)</span>', 'Pending Payment <span class="count">(%s)</span>', 'lifterlms' ),
),
'llms-cancelled' => array(
'label' => _x( 'Cancelled', 'Order status', 'lifterlms' ),
/* translators: %s: Cancelled count, %s: Cancelled count. */
'label_count' => _n_noop( 'Cancelled <span class="count">(%s)</span>', 'Cancelled <span class="count">(%s)</span>', 'lifterlms' ),
),
'llms-refunded' => array(
'label' => _x( 'Refunded', 'Order status', 'lifterlms' ),
/* translators: %s: Refunded count, %s: Refunded count. */
'label_count' => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'lifterlms' ),
),
'llms-failed' => array(
'label' => _x( 'Failed', 'Order status', 'lifterlms' ),
/* translators: %s: Failed count, %s: Failed count. */
'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'lifterlms' ),
),
);
$defaults = array(
'public' => true,
'exclude_from_search' => false,
'show_in_admin_all_list' => true,
'show_in_admin_status_list' => true,
);
foreach ( $statuses as &$status ) {
$status = array_merge( $status, $defaults );
}
/**
* Filter the list of order statuses that will be registered with WordPress.
*
* @since 3.19.0
*
* @param array[] $statuses Array of post status arrays.
*/
return apply_filters( 'lifterlms_register_order_post_statuses', $statuses );
}
/**
* Get an array of capabilities for a custom post type
*
* Due to core bug does not allow us to use capability_type in post type registration.
* See https://core.trac.wordpress.org/ticket/30991.
*
* @since 3.13.0
* @since 6.0.0 Add specific case for `llms_my_achievement`, `llms_my_certificate` post types.
*
* @param string $post_type Post type name.
* @return array
*/
public static function get_post_type_caps( $post_type ) {
if ( ! is_array( $post_type ) ) {
$singular = $post_type;
$plural = $post_type . 's';
} else {
$singular = $post_type[0];
$plural = $post_type[1];
}
if ( in_array( $singular, array( 'my_achievement', 'my_certificate' ), true ) ) {
$caps = self::get_earned_engagements_post_type_caps();
} else {
$caps = array(
'read_post' => sprintf( 'read_%s', $singular ),
'read_private_posts' => sprintf( 'read_private_%s', $plural ),
'edit_post' => sprintf( 'edit_%s', $singular ),
'edit_posts' => sprintf( 'edit_%s', $plural ),
'edit_others_posts' => sprintf( 'edit_others_%s', $plural ),
'edit_private_posts' => sprintf( 'edit_private_%s', $plural ),
'edit_published_posts' => sprintf( 'edit_published_%s', $plural ),
'publish_posts' => sprintf( 'publish_%s', $plural ),
'delete_post' => sprintf( 'delete_%s', $singular ),
'delete_posts' => sprintf( 'delete_%s', $plural ), // This is the core bug issue here.
'delete_private_posts' => sprintf( 'delete_private_%s', $plural ),
'delete_published_posts' => sprintf( 'delete_published_%s', $plural ),
'delete_others_posts' => sprintf( 'delete_others_%s', $plural ),
'create_posts' => sprintf( 'create_%s', $plural ),
);
}
/**
* Filter the list of post type capabilities for the given post type.
*
* The dynamic portion of this hook, `$singular` refers to the post type's
* name, for example "course" or "llms_membership".
*
* @since 3.13.0
*
* @param array $caps Array of capabilities.
*/
return apply_filters(
"llms_get_{$singular}_post_type_caps",
$caps
);
}
/**
* Get an array of capabilities for earned engagements post types.
*
* @since 6.0.0
*
* @return array
*/
public static function get_earned_engagements_post_type_caps() {
return array(
'read_post' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'read_private_posts' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'edit_post' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'edit_posts' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'edit_others_posts' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'edit_private_posts' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'edit_published_posts' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'publish_posts' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'delete_post' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'delete_posts' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'delete_private_posts' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'delete_published_posts' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'delete_others_posts' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
'create_posts' => LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP,
);
}
/**
* Retrieve taxonomy capabilities for custom taxonomies
*
* @since 3.13.0
*
* @param string|array $tax Taxonomy name/names (pass array of singular, plural to customize plural spelling).
* @return array
*/
public static function get_tax_caps( $tax ) {
if ( ! is_array( $tax ) ) {
$singular = $tax;
$plural = $tax . 's';
} else {
$singular = $tax[0];
$plural = $tax[1];
}
/**
* Customize the taxonomy capabilities for the given taxonomy.
*
* The dynamic portion of this hook, `$singular` refers to the taxonomy's
* registered name.
*
* @since 3.13.0
*
* @param array $caps Array of capabilities.
*/
return apply_filters(
"llms_get_{$singular}_tax_caps",
array(
'manage_terms' => sprintf( 'manage_%s', $plural ),
'edit_terms' => sprintf( 'edit_%s', $plural ),
'delete_terms' => sprintf( 'delete_%s', $plural ),
'assign_terms' => sprintf( 'assign_%s', $plural ),
)
);
}
/**
* Retrieves the block template for use in post type registration.
*
* @since 6.0.0
*
* @param string $post_type The post type.
* @return array|null Returns the block template array or null if no template is defined for the post type.
*/
private static function get_template( $post_type ) {
if ( empty( self::$templates ) ) {
self::$templates = require LLMS_PLUGIN_DIR . 'includes/schemas/llms-block-templates.php';
}
return self::$templates[ $post_type ] ?? null;
}
/**
* Register a custom post type.
*
* Automatically checks for duplicates and filters data.
*
* @since 3.13.0
* @since 5.5.0 Added `lifterlms_register_post_type_{$name}` filters deprecation
* where `$name` is the the post type name, if the unprefixed name (removing 'llms_')
* is different from `$name`. E.g. it'll be triggered when registering when using
* `lifterlms_register_post_type_llms_engagement` but not when using `lifterlms_register_post_type_course`,
* for the latter, both the name and the unprefixed name are the same.
* @since 6.0.0 Automatically load templates from the `llms-block-templates` schema.
* Added return value.
*
* @param string $name Post type name.
* @param array $data Post type data.
* @return WP_Post_Type|WP_Error
*/
public static function register_post_type( $name, $data ) {
if ( ! post_type_exists( $name ) ) {
$unprefixed_name = str_replace( 'llms_', '', $name );
if ( $unprefixed_name !== $name ) {
$data = apply_filters_deprecated(
"lifterlms_register_post_type_{$name}",
array( $data ),
'5.5.0',
"lifterlms_register_post_type_{$unprefixed_name}"
);
}
if ( empty( $data['template'] ) ) {
$data['template'] = self::get_template( $name );
}
/**
* Modify post type registration arguments of a LifterLMS custom post type.
*
* The dynamic portion of this hook refers to the post type's name with the `llms_` prefix
* removed (if it exist). For example, to modify the arguments for the membership post type
* (`llms_membership`) the full hook would be "lifterlms_register_post_type_membership".
*
* @since 3.13.0
*
* @param array $data Post type registration arguments passed to `register_post_type()`.
*/
$data = apply_filters( "lifterlms_register_post_type_{$unprefixed_name}", $data );
return register_post_type( $name, $data );
}
return get_post_type_object( $name );
}
/**
* Register Post Types.
*
* @since 1.0.0
* @since 3.0.4 Made 'llms_access_plan' post type hierarchical to prevent a conflict with the Redirection plugin.
* @since 3.33.0 `llms_question` post type is not publicly queryable anymore.
* @since 3.37.12 Added 'revisions' support to course, lesson, and llms_mebership post types.
* @since 4.5.1 Removed "excerpt" support for the course post type.
* @since 4.17.0 Add "llms-sales-page" feature to course and membership post types.
* @since 5.5.0 Register all the post types using `self::register_post_type()`.
* @since 5.8.0 Remove all post type descriptions.
* @since 6.0.0 Show `llms_my_certificate` ui (edit) only to who can `manage_lifterlms`.
* Register `llms_my_achievement` post type.
* Add thumbnail support for achievement and certificates (earned and template)
* Renames `llms_certificate` slug from `certificate` to `certificate-template`.
* Rename `llms_my_certificate` slug from `my_certificate` to `certificate`.
* Replaced the use of the deprecated `get_page() function with `get_post()`.
*
* @return void
*/
public static function register_post_types() {
$permalinks = llms_get_permalink_structure();
// Course.
$catalog_id = llms_get_page_id( 'shop' );
self::register_post_type(
'course',
array(
'labels' => array(
'name' => __( 'Courses', 'lifterlms' ),
'singular_name' => __( 'Course', 'lifterlms' ),
'menu_name' => _x( 'Courses', 'Admin menu name', 'lifterlms' ),
'add_new' => __( 'Add Course', 'lifterlms' ),
'add_new_item' => __( 'Add New Course', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Course', 'lifterlms' ),
'new_item' => __( 'New Course', 'lifterlms' ),
'view' => __( 'View Course', 'lifterlms' ),
'view_item' => __( 'View Course', 'lifterlms' ),
'search_items' => __( 'Search Courses', 'lifterlms' ),
'not_found' => __( 'No Courses found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Courses found in trash', 'lifterlms' ),
'parent' => __( 'Parent Course', 'lifterlms' ),
),
'public' => true,
'show_ui' => true,
'menu_icon' => 'dashicons-welcome-learn-more',
'capabilities' => self::get_post_type_caps( 'course' ),
'map_meta_cap' => true,
'publicly_queryable' => true,
'exclude_from_search' => false,
'hierarchical' => false,
'rewrite' => array(
'slug' => $permalinks['course_base'],
'with_front' => false,
'feeds' => true,
),
'query_var' => true,
'supports' => array( 'title', 'author', 'editor', 'thumbnail', 'comments', 'custom-fields', 'page-attributes', 'revisions', 'llms-clone-post', 'llms-export-post', 'llms-sales-page' ),
'has_archive' => ( $catalog_id && get_post( $catalog_id ) ) ? get_page_uri( $catalog_id ) : $permalinks['courses_base'],
'show_in_nav_menus' => true,
'menu_position' => 52,
)
);
// Section.
self::register_post_type(
'section',
array(
'labels' => array(
'name' => __( 'Sections', 'lifterlms' ),
'singular_name' => __( 'Section', 'lifterlms' ),
'add_new' => __( 'Add Section', 'lifterlms' ),
'add_new_item' => __( 'Add New Section', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Section', 'lifterlms' ),
'new_item' => __( 'New Section', 'lifterlms' ),
'view' => __( 'View Section', 'lifterlms' ),
'view_item' => __( 'View Section', 'lifterlms' ),
'search_items' => __( 'Search Sections', 'lifterlms' ),
'not_found' => __( 'No Sections found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Sections found in trash', 'lifterlms' ),
'parent' => __( 'Parent Sections', 'lifterlms' ),
'menu_name' => _x( 'Sections', 'Admin menu name', 'lifterlms' ),
),
'public' => false,
'show_ui' => false,
'map_meta_cap' => true,
'publicly_queryable' => false,
'exclude_from_search' => true,
'hierarchical' => false,
'show_in_nav_menus' => false,
'rewrite' => false,
'query_var' => false,
'supports' => array( 'title' ),
'has_archive' => false,
)
);
// Lesson.
self::register_post_type(
'lesson',
array(
'labels' => array(
'name' => __( 'Lessons', 'lifterlms' ),
'singular_name' => __( 'Lesson', 'lifterlms' ),
'add_new' => __( 'Add Lesson', 'lifterlms' ),
'add_new_item' => __( 'Add New Lesson', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Lesson', 'lifterlms' ),
'new_item' => __( 'New Lesson', 'lifterlms' ),
'view' => __( 'View Lesson', 'lifterlms' ),
'view_item' => __( 'View Lesson', 'lifterlms' ),
'search_items' => __( 'Search Lessons', 'lifterlms' ),
'not_found' => __( 'No Lessons found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Lessons found in trash', 'lifterlms' ),
'parent' => __( 'Parent Lessons', 'lifterlms' ),
'menu_name' => _x( 'Lessons', 'Admin menu name', 'lifterlms' ),
),
'public' => true,
'show_ui' => true,
'capabilities' => self::get_post_type_caps( 'lesson' ),
'map_meta_cap' => true,
'publicly_queryable' => true,
'exclude_from_search' => true,
'show_in_menu' => 'edit.php?post_type=course',
'hierarchical' => false,
'rewrite' => array(
'slug' => $permalinks['lesson_base'],
'with_front' => false,
'feeds' => true,
),
'show_in_nav_menus' => false,
'query_var' => true,
'supports' => array( 'title', 'editor', 'excerpt', 'thumbnail', 'comments', 'custom-fields', 'page-attributes', 'revisions', 'author', 'llms-clone-post', 'llms-detach-post' ),
)
);
// Quiz.
self::register_post_type(
'llms_quiz',
array(
'labels' => array(
'name' => __( 'Quizzes', 'lifterlms' ),
'singular_name' => __( 'Quiz', 'lifterlms' ),
'add_new' => __( 'Add Quiz', 'lifterlms' ),
'add_new_item' => __( 'Add New Quiz', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Quiz', 'lifterlms' ),
'new_item' => __( 'New Quiz', 'lifterlms' ),
'view' => __( 'View Quiz', 'lifterlms' ),
'view_item' => __( 'View Quiz', 'lifterlms' ),
'search_items' => __( 'Search Quiz', 'lifterlms' ),
'not_found' => __( 'No Quizzes found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Quizzes found in trash', 'lifterlms' ),
'parent' => __( 'Parent Quizzes', 'lifterlms' ),
'menu_name' => _x( 'Quizzes', 'Admin menu name', 'lifterlms' ),
),
'public' => true,
'show_ui' => false,
'map_meta_cap' => true,
'capabilities' => self::get_post_type_caps( array( 'quiz', 'quizzes' ) ),
'publicly_queryable' => true,
'exclude_from_search' => true,
'show_in_menu' => 'edit.php?post_type=course',
'hierarchical' => false,
'rewrite' => array(
'slug' => $permalinks['quiz_base'],
'with_front' => false,
'feeds' => true,
),
'show_in_nav_menus' => false,
'query_var' => true,
'supports' => array( 'title', 'editor', 'author', 'custom-fields' ),
)
);
// Quiz Question.
self::register_post_type(
'llms_question',
array(
'labels' => array(
'name' => __( 'Questions', 'lifterlms' ),
'singular_name' => __( 'Question', 'lifterlms' ),
'add_new' => __( 'Add Question', 'lifterlms' ),
'add_new_item' => __( 'Add New Question', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Question', 'lifterlms' ),
'new_item' => __( 'New Question', 'lifterlms' ),
'view' => __( 'View Question', 'lifterlms' ),
'view_item' => __( 'View Question', 'lifterlms' ),
'search_items' => __( 'Search Questions', 'lifterlms' ),
'not_found' => __( 'No Questions found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Questions found in trash', 'lifterlms' ),
'parent' => __( 'Parent Questions', 'lifterlms' ),
'menu_name' => _x( 'Quiz Questions', 'Admin menu name', 'lifterlms' ),
),
'public' => false,
'show_ui' => false,
'map_meta_cap' => true,
'capabilities' => self::get_post_type_caps( 'question' ),
'publicly_queryable' => false,
'exclude_from_search' => true,
'show_in_menu' => 'edit.php?post_type=course',
'hierarchical' => false,
'rewrite' => false,
'show_in_nav_menus' => false,
'query_var' => false,
'supports' => array( 'title', 'editor' ),
)
);
// Membership.
$membership_page_id = llms_get_page_id( 'memberships' );
self::register_post_type(
'llms_membership',
array(
'labels' => array(
'name' => __( 'Memberships', 'lifterlms' ),
'singular_name' => __( 'Membership', 'lifterlms' ),
'menu_name' => _x( 'Memberships', 'Admin menu name', 'lifterlms' ),
'add_new' => __( 'Add Membership', 'lifterlms' ),
'add_new_item' => __( 'Add New Membership', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Membership', 'lifterlms' ),
'new_item' => __( 'New Membership', 'lifterlms' ),
'view' => __( 'View Membership', 'lifterlms' ),
'view_item' => __( 'View Membership', 'lifterlms' ),
'search_items' => __( 'Search Memberships', 'lifterlms' ),
'not_found' => __( 'No Memberships found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Memberships found in trash', 'lifterlms' ),
'parent' => __( 'Parent Membership', 'lifterlms' ),
),
'public' => true,
'show_ui' => true,
'capabilities' => self::get_post_type_caps( 'membership' ),
'map_meta_cap' => true,
'menu_icon' => 'dashicons-groups',
'publicly_queryable' => true,
'exclude_from_search' => false,
'show_in_menu' => true,
'hierarchical' => false,
'rewrite' => array(
'slug' => _x( 'membership', 'membership url slug', 'lifterlms' ),
'with_front' => false,
'feeds' => true,
),
'query_var' => true,
'supports' => array( 'title', 'editor', 'thumbnail', 'comments', 'custom-fields', 'page-attributes', 'revisions', 'llms-sales-page' ),
'has_archive' => ( $membership_page_id && get_post( $membership_page_id ) ) ? get_page_uri( $membership_page_id ) : $permalinks['memberships_base'],
'show_in_nav_menus' => true,
'menu_position' => 52,
)
);
// Engagement.
self::register_post_type(
'llms_engagement',
array(
'labels' => array(
'name' => __( 'Engagements', 'lifterlms' ),
'singular_name' => __( 'Engagement', 'lifterlms' ),
'add_new' => __( 'Add Engagement', 'lifterlms' ),
'add_new_item' => __( 'Add New Engagement', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Engagement', 'lifterlms' ),
'new_item' => __( 'New Engagement', 'lifterlms' ),
'view' => __( 'View Engagement', 'lifterlms' ),
'view_item' => __( 'View Engagement', 'lifterlms' ),
'search_items' => __( 'Search Engagement', 'lifterlms' ),
'not_found' => __( 'No Engagement found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Engagement found in trash', 'lifterlms' ),
'parent' => __( 'Parent Engagement', 'lifterlms' ),
'menu_name' => _x( 'Engagements', 'Admin menu name', 'lifterlms' ),
),
'public' => false,
'show_ui' => ( current_user_can( apply_filters( 'lifterlms_admin_engagements_access', 'manage_lifterlms' ) ) ) ? true : false,
'map_meta_cap' => true,
'publicly_queryable' => false,
'exclude_from_search' => true,
'menu_position' => 52,
'menu_icon' => 'dashicons-awards',
'hierarchical' => false,
'show_in_nav_menus' => false,
'rewrite' => false,
'query_var' => false,
'supports' => array( 'title' ),
'has_archive' => false,
)
);
// Order.
self::register_post_type(
'llms_order',
array(
'labels' => array(
'name' => __( 'Orders', 'lifterlms' ),
'singular_name' => __( 'Order', 'lifterlms' ),
'add_new' => __( 'Add Order', 'lifterlms' ),
'add_new_item' => __( 'Add New Order', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Order', 'lifterlms' ),
'new_item' => __( 'New Order', 'lifterlms' ),
'view' => __( 'View Order', 'lifterlms' ),
'view_item' => __( 'View Order', 'lifterlms' ),
'search_items' => __( 'Search Orders', 'lifterlms' ),
'not_found' => __( 'No Orders found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Orders found in trash', 'lifterlms' ),
'parent' => __( 'Parent Orders', 'lifterlms' ),
'menu_name' => _x( 'Orders', 'Admin menu name', 'lifterlms' ),
),
'public' => false,
'show_ui' => ( current_user_can( apply_filters( 'lifterlms_admin_order_access', 'manage_lifterlms' ) ) ) ? true : false,
'map_meta_cap' => true,
'publicly_queryable' => false,
'menu_icon' => 'dashicons-cart',
'menu_position' => 52,
'exclude_from_search' => true,
'hierarchical' => false,
'show_in_nav_menus' => false,
'rewrite' => false,
'query_var' => false,
'supports' => array( 'title', 'comments', 'custom-fields' ),
'has_archive' => false,
'capabilities' => array(
'create_posts' => 'do_not_allow',
),
)
);
// Transaction.
self::register_post_type(
'llms_transaction',
array(
'labels' => array(
'name' => __( 'Transactions', 'lifterlms' ),
'singular_name' => __( 'Transaction', 'lifterlms' ),
'add_new' => __( 'Add Transaction', 'lifterlms' ),
'add_new_item' => __( 'Add New Transaction', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Transaction', 'lifterlms' ),
'new_item' => __( 'New Transaction', 'lifterlms' ),
'view' => __( 'View Transaction', 'lifterlms' ),
'view_item' => __( 'View Transaction', 'lifterlms' ),
'search_items' => __( 'Search Transactions', 'lifterlms' ),
'not_found' => __( 'No Transactions found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Transactions found in trash', 'lifterlms' ),
'parent' => __( 'Parent Transactions', 'lifterlms' ),
'menu_name' => _x( 'Orders', 'Admin menu name', 'lifterlms' ),
),
'public' => false,
'show_ui' => false,
'map_meta_cap' => true,
'publicly_queryable' => false,
'exclude_from_search' => true,
'show_in_menu' => false,
'hierarchical' => false,
'show_in_nav_menus' => false,
'rewrite' => false,
'query_var' => false,
'supports' => array( '' ),
'has_archive' => false,
'capabilities' => array(
'create_posts' => 'do_not_allow',
),
)
);
// Achievement.
self::register_post_type(
'llms_achievement',
array(
'labels' => array(
'name' => __( 'Achievement Templates', 'lifterlms' ),
'singular_name' => __( 'Achievement Template', 'lifterlms' ),
'add_new' => __( 'Add Achievement Template', 'lifterlms' ),
'add_new_item' => __( 'Add New Achievement Template', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Achievement Template', 'lifterlms' ),
'new_item' => __( 'New Achievement Template', 'lifterlms' ),
'view' => __( 'View Achievement Template', 'lifterlms' ),
'view_item' => __( 'View Achievement Template', 'lifterlms' ),
'search_items' => __( 'Search Achievement Templates', 'lifterlms' ),
'not_found' => __( 'No Achievement Templates found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Achievement Templates found in trash', 'lifterlms' ),
'parent' => __( 'Parent Achievement Template', 'lifterlms' ),
'menu_name' => _x( 'Achievements', 'Admin menu name', 'lifterlms' ),
'featured_image' => __( 'Achievement Image', 'lifterlms' ),
'set_featured_image' => __( 'Set achievement image', 'lifterlms' ),
'remove_featured_image' => __( 'Remove achievement image', 'lifterlms' ),
'use_featured_image' => __( 'Use achievement image', 'lifterlms' ),
),
'public' => false,
'show_ui' => ( current_user_can( apply_filters( 'lifterlms_admin_achievements_access', 'manage_lifterlms' ) ) ) ? true : false,
'map_meta_cap' => true,
'publicly_queryable' => false,
'exclude_from_search' => true,
'show_in_menu' => 'edit.php?post_type=llms_engagement',
'hierarchical' => false,
'show_in_nav_menus' => false,
'rewrite' => false,
'query_var' => false,
'supports' => array( 'title', 'thumbnail' ),
'has_archive' => false,
)
);
// Earned achievements.
self::register_post_type(
'llms_my_achievement',
array(
'labels' => array(
'name' => __( 'Awarded Achievements', 'lifterlms' ),
'singular_name' => __( 'Awarded Achievement', 'lifterlms' ),
'add_new' => __( 'Award Achievement', 'lifterlms' ),
'add_new_item' => __( 'Award New Achievement', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Awarded Achievement', 'lifterlms' ),
'new_item' => __( 'New Awarded Achievement', 'lifterlms' ),
'view' => __( 'View Awarded Achievement', 'lifterlms' ),
'view_item' => __( 'View Awarded Achievement', 'lifterlms' ),
'search_items' => __( 'Search Awarded Achievements', 'lifterlms' ),
'not_found' => __( 'No Awarded Achievements found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Awarded Achievements found in trash', 'lifterlms' ),
'parent' => __( 'Parent Awarded Achievements', 'lifterlms' ),
'menu_name' => _x( 'Awarded Achievements', 'Admin menu name', 'lifterlms' ),
'featured_image' => __( 'Achievement Image', 'lifterlms' ),
'set_featured_image' => __( 'Set awarded achievement image', 'lifterlms' ),
'remove_featured_image' => __( 'Remove awarded achievement image', 'lifterlms' ),
'use_featured_image' => __( 'Use awarded achievement image', 'lifterlms' ),
),
'description' => __( 'This is where you can view all of the awarded achievements.', 'lifterlms' ),
'public' => false,
/**
* Filters the needed capability to generate and allow a UI for managing `llms_my_achievement` post type in the admin.
*
* @since 6.0.0
*
* @param bool $show_ui The needed capability to generate and allow a UI for managing `llms_my_achievement` post type in the admin.
* Default is `manage_earned_engagements`.
*/
'show_ui' => ( current_user_can( apply_filters( 'lifterlms_admin_my_achievements_access', LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP ) ) ) ? true : false,
'capabilities' => self::get_post_type_caps( 'my_achievement' ),
'map_meta_cap' => false,
'publicly_queryable' => false,
'exclude_from_search' => true,
/** This filter is documented above. */
'show_in_menu' => ( current_user_can( apply_filters( 'lifterlms_admin_my_achievements_access', LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP ) ) ) ? 'edit.php?post_type=llms_engagement' : false,
'hierarchical' => false,
'rewrite' => false,
'show_in_nav_menus' => false,
'has_archive' => false,
'query_var' => false,
'supports' => array( 'title', 'thumbnail' ),
)
);
// Certificate.
self::register_certificate_post_type(
'llms_certificate',
array(
'name' => __( 'Certificate Templates', 'lifterlms' ),
'singular_name' => __( 'Certificate Template', 'lifterlms' ),
'add_new' => __( 'Add Certificate Template', 'lifterlms' ),
'add_new_item' => __( 'Add New Certificate Template', 'lifterlms' ),
'edit_item' => __( 'Edit Certificate Template', 'lifterlms' ),
'new_item' => __( 'New Certificate Template', 'lifterlms' ),
'view' => __( 'View Certificate Template', 'lifterlms' ),
'view_item' => __( 'View Certificate Template', 'lifterlms' ),
'search_items' => __( 'Search Certificate Templates', 'lifterlms' ),
'not_found' => __( 'No Certificate Templates found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Certificate Templates found in trash', 'lifterlms' ),
'parent' => __( 'Parent Certificate Templates', 'lifterlms' ),
'menu_name' => _x( 'Certificates', 'Admin menu name', 'lifterlms' ),
),
array(
'map_meta_cap' => true,
),
$permalinks['certificate_template_base'],
/**
* Filters the WordPress user capability required for a user to manage certificate templates on the admin panel.
*
* @since Unknown
*
* @param string $capability User capability. Default: `manage_lifterlms`.
*/
apply_filters( 'lifterlms_admin_certificates_access', 'manage_lifterlms' )
);
// Earned certificate.
self::register_certificate_post_type(
'llms_my_certificate',
array(
'name' => __( 'Awarded Certificates', 'lifterlms' ),
'singular_name' => __( 'Awarded Certificate', 'lifterlms' ),
'add_new' => __( 'Award Certificate', 'lifterlms' ),
'add_new_item' => __( 'Award New Certificate', 'lifterlms' ),
'edit_item' => __( 'Edit Awarded Certificate', 'lifterlms' ),
'new_item' => __( 'New Awarded Certificate', 'lifterlms' ),
'view' => __( 'View Awarded Certificate', 'lifterlms' ),
'view_item' => __( 'View Awarded Certificate', 'lifterlms' ),
'search_items' => __( 'Search Awarded Certificates', 'lifterlms' ),
'not_found' => __( 'No Awarded Certificates found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Awarded Certificates found in trash', 'lifterlms' ),
'parent' => __( 'Parent Awarded Certificates', 'lifterlms' ),
'menu_name' => _x( 'Awarded Certificates', 'Admin menu name', 'lifterlms' ),
),
array(
'capabilities' => self::get_post_type_caps( 'my_certificate' ),
'map_meta_cap' => false,
),
$permalinks['certificate_base'],
/**
* Filters the needed capability to generate and allow a UI for managing `llms_my_certificate` post type in the admin.
*
* @since 6.0.0
*
* @param bool $show_ui The needed capability to generate and allow a UI for managing `llms_my_certificate` post type in the admin.
* Default is `manage_earned_engagements`.
*/
apply_filters( 'lifterlms_admin_my_certificates_access', LLMS_Roles::MANAGE_EARNED_ENGAGEMENT_CAP )
);
// Email.
self::register_post_type(
'llms_email',
array(
'labels' => array(
'name' => __( 'Email Templates', 'lifterlms' ),
'singular_name' => __( 'Email Template', 'lifterlms' ),
'add_new' => __( 'Add Email Template', 'lifterlms' ),
'add_new_item' => __( 'Add New Email Template', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Email Template', 'lifterlms' ),
'new_item' => __( 'New Email Template', 'lifterlms' ),
'view' => __( 'View Email Template', 'lifterlms' ),
'view_item' => __( 'View Email Template', 'lifterlms' ),
'search_items' => __( 'Search Email Templates', 'lifterlms' ),
'not_found' => __( 'No Emails found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Emails found in trash', 'lifterlms' ),
'parent' => __( 'Parent Email Templates', 'lifterlms' ),
'menu_name' => _x( 'Emails', 'Admin menu name', 'lifterlms' ),
),
'public' => false,
'show_ui' => ( current_user_can( apply_filters( 'lifterlms_admin_emails_access', 'manage_lifterlms' ) ) ) ? true : false,
'map_meta_cap' => true,
'publicly_queryable' => false,
'exclude_from_search' => true,
'show_in_menu' => 'edit.php?post_type=llms_engagement',
'hierarchical' => false,
'show_in_nav_menus' => false,
'rewrite' => false,
'query_var' => false,
'supports' => array( 'title', 'editor' ),
'has_archive' => false,
)
);
// Coupon.
self::register_post_type(
'llms_coupon',
array(
'labels' => array(
'name' => __( 'Coupons', 'lifterlms' ),
'singular_name' => __( 'Coupon', 'lifterlms' ),
'add_new' => __( 'Add Coupon', 'lifterlms' ),
'add_new_item' => __( 'Add New Coupon', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Coupon', 'lifterlms' ),
'new_item' => __( 'New Coupon', 'lifterlms' ),
'view' => __( 'View Coupon', 'lifterlms' ),
'view_item' => __( 'View Coupon', 'lifterlms' ),
'search_items' => __( 'Search Coupon', 'lifterlms' ),
'not_found' => __( 'No Coupon found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Coupon found in trash', 'lifterlms' ),
'parent' => __( 'Parent Coupon', 'lifterlms' ),
'menu_name' => _x( 'Coupons', 'Admin menu name', 'lifterlms' ),
),
'public' => false,
'show_ui' => ( current_user_can( apply_filters( 'lifterlms_admin_coupons_access', 'manage_lifterlms' ) ) ) ? true : false,
'map_meta_cap' => true,
'publicly_queryable' => false,
'exclude_from_search' => true,
'show_in_menu' => 'edit.php?post_type=llms_order',
'hierarchical' => false,
'show_in_nav_menus' => false,
'rewrite' => false,
'query_var' => false,
'supports' => array( 'title' ),
'has_archive' => false,
)
);
// Voucher.
self::register_post_type(
'llms_voucher',
array(
'labels' => array(
'name' => __( 'Vouchers', 'lifterlms' ),
'singular_name' => __( 'Voucher', 'lifterlms' ),
'add_new' => __( 'Add Voucher', 'lifterlms' ),
'add_new_item' => __( 'Add New Voucher', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Voucher', 'lifterlms' ),
'new_item' => __( 'New Voucher', 'lifterlms' ),
'view' => __( 'View Voucher', 'lifterlms' ),
'view_item' => __( 'View Voucher', 'lifterlms' ),
'search_items' => __( 'Search Voucher', 'lifterlms' ),
'not_found' => __( 'No Voucher found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Voucher found in trash', 'lifterlms' ),
'parent' => __( 'Parent Voucher', 'lifterlms' ),
'menu_name' => _x( 'Vouchers', 'Admin menu name', 'lifterlms' ),
),
'public' => false,
'show_ui' => ( current_user_can( apply_filters( 'lifterlms_admin_vouchers_access', 'manage_lifterlms' ) ) ) ? true : false,
'map_meta_cap' => true,
'publicly_queryable' => false,
'exclude_from_search' => true,
'show_in_menu' => 'edit.php?post_type=llms_order',
'hierarchical' => false,
'show_in_nav_menus' => false,
'rewrite' => false,
'query_var' => false,
'supports' => array( 'title' ),
'has_archive' => false,
)
);
// Review.
self::register_post_type(
'llms_review',
array(
'labels' => array(
'name' => __( 'Reviews', 'lifterlms' ),
'singular_name' => __( 'Review', 'lifterlms' ),
'menu_name' => _x( 'Reviews', 'Admin menu name', 'lifterlms' ),
'add_new' => __( 'Add Review', 'lifterlms' ),
'add_new_item' => __( 'Add New Review', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Review', 'lifterlms' ),
'new_item' => __( 'New Review', 'lifterlms' ),
'view' => __( 'View Review', 'lifterlms' ),
'view_item' => __( 'View Review', 'lifterlms' ),
'search_items' => __( 'Search Reviews', 'lifterlms' ),
'not_found' => __( 'No Reviews found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Reviews found in trash', 'lifterlms' ),
'parent' => __( 'Parent Review', 'lifterlms' ),
),
'public' => false,
'show_ui' => ( current_user_can( apply_filters( 'lifterlms_admin_reviews_access', 'manage_lifterlms' ) ) ) ? true : false,
'map_meta_cap' => true,
'publicly_queryable' => false,
'exclude_from_search' => true,
'show_in_menu' => 'edit.php?post_type=course',
'hierarchical' => false,
'show_in_nav_menus' => false,
'rewrite' => false,
'query_var' => false,
'has_archive' => false,
'supports' => array( 'title', 'editor', 'excerpt', 'thumbnail', 'comments', 'custom-fields', 'page-attributes' ),
)
);
// Access Plan.
self::register_post_type(
'llms_access_plan',
array(
'labels' => array(
'name' => __( 'Access Plans', 'lifterlms' ),
'singular_name' => __( 'Access Plan', 'lifterlms' ),
'add_new' => __( 'Add Access Plan', 'lifterlms' ),
'add_new_item' => __( 'Add New Access Plan', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Access Plan', 'lifterlms' ),
'new_item' => __( 'New Access Plan', 'lifterlms' ),
'view' => __( 'View Access Plan', 'lifterlms' ),
'view_item' => __( 'View Access Plan', 'lifterlms' ),
'search_items' => __( 'Search Access Plans', 'lifterlms' ),
'not_found' => __( 'No Access Plans found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Access Plans found in trash', 'lifterlms' ),
'parent' => __( 'Parent Access Plans', 'lifterlms' ),
'menu_name' => _x( 'Access Plans', 'Admin menu name', 'lifterlms' ),
),
'public' => false,
'show_ui' => false,
'map_meta_cap' => true,
'publicly_queryable' => false,
'exclude_from_search' => true,
/**
* Making this post type hierarchical prevents a conflict
* with the Redirection plugin (https://wordpress.org/plugins/redirection/)
* When 301 monitoring is turned on, Redirection creates access plans
* for each access plan that redirect the course or membership
* to the site's home page.
*/
'hierarchical' => true,
'show_in_nav_menus' => false,
'rewrite' => false,
'query_var' => false,
'supports' => array( 'title' ),
'has_archive' => false,
)
);
}
/**
* Registers awarded and template certificate post types.
*
* @since 6.0.0
*
* @param string $post_type Post type name.
* @param array $labels Array of post type labels.
* @param array $args Array of post type args.
* @param string $rewrite_slug Post type rewrite slug.
* @param string $admin_cap User capability required to manage the post type on the admin panel.
* @return void
*/
private static function register_certificate_post_type( $post_type, $labels, $args, $rewrite_slug, $admin_cap ) {
$user_can = current_user_can( $admin_cap );
$supports = array( 'title', 'editor', 'thumbnail' );
if ( 'llms_my_certificate' === $post_type ) {
$supports[] = 'author';
}
$base_labels = array(
'edit' => __( 'Edit', 'lifterlms' ),
'featured_image' => __( 'Background Image', 'lifterlms' ),
'set_featured_image' => __( 'Set background image', 'lifterlms' ),
'remove_featured_image' => __( 'Remove background image', 'lifterlms' ),
'use_featured_image' => __( 'Use background image', 'lifterlms' ),
);
$base_args = array(
'labels' => wp_parse_args( $labels, $base_labels ),
'show_ui' => $user_can,
'publicly_queryable' => 'llms_certificate' === $post_type ? $user_can : true,
'show_in_rest' => llms_is_block_editor_supported_for_certificates() && $user_can,
'public' => true,
'hierarchical' => false,
'exclude_from_search' => true,
'show_in_menu' => 'edit.php?post_type=llms_engagement',
'show_in_nav_menus' => false,
'query_var' => true,
'supports' => $supports,
'rewrite' => array(
'slug' => $rewrite_slug,
'with_front' => false,
'feeds' => true,
),
);
self::register_post_type( $post_type, wp_parse_args( $args, $base_args ) );
}
/**
* Register post statuses
*
* @since 3.0.0
* @since 3.19.0 Unknwn.
*
* @return void
*/
public static function register_post_statuses() {
$order_statuses = self::get_order_statuses();
$txn_statuses = apply_filters(
'lifterlms_register_transaction_post_statuses',
array(
'llms-txn-failed' => array(
'label' => _x( 'Failed', 'Transaction status', 'lifterlms' ),
'public' => true,
'exclude_from_search' => false,
'show_in_admin_all_list' => true,
'show_in_admin_status_list' => true,
/* translators: %s: Failed count, %s: Failed count. */
'label_count' => _n_noop( 'Failed <span class="count">(%s)</span>', 'Failed <span class="count">(%s)</span>', 'lifterlms' ),
),
'llms-txn-pending' => array(
'label' => _x( 'Pending', 'Transaction status', 'lifterlms' ),
'public' => true,
'exclude_from_search' => false,
'show_in_admin_all_list' => true,
'show_in_admin_status_list' => true,
/* translators: %s: Pending count, %s: Pending count. */
'label_count' => _n_noop( 'Pending <span class="count">(%s)</span>', 'Pending <span class="count">(%s)</span>', 'lifterlms' ),
),
'llms-txn-refunded' => array(
'label' => _x( 'Refunded', 'Transaction status', 'lifterlms' ),
'public' => true,
'exclude_from_search' => false,
'show_in_admin_all_list' => true,
'show_in_admin_status_list' => true,
/* translators: %s: Refuned count, %s: Refunded count. */
'label_count' => _n_noop( 'Refunded <span class="count">(%s)</span>', 'Refunded <span class="count">(%s)</span>', 'lifterlms' ),
),
'llms-txn-succeeded' => array(
'label' => _x( 'Succeeded', 'Transaction status', 'lifterlms' ),
'public' => true,
'exclude_from_search' => false,
'show_in_admin_all_list' => true,
'show_in_admin_status_list' => true,
'label_count' => _n_noop( 'Succeeded <span class="count">(%s)</span>', 'Succeeded <span class="count">(%s)</span>', 'lifterlms' ),
),
)
);
foreach ( array_merge( $order_statuses, $txn_statuses ) as $status => $values ) {
register_post_status( $status, $values );
}
}
/**
* Register a custom post type taxonomy
* Automatically checks for duplicates and filters data
*
* @since 3.13.0
*
* @param string $name Taxonomy name.
* @param string|array $object Post type object(s) to associate the taxonomy with.
* @param array $data Taxonomy data.
* @return void
*/
public static function register_taxonomy( $name, $object, $data ) {
if ( ! taxonomy_exists( $name ) ) {
$filter_name = str_replace( 'llms_', '', $name );
register_taxonomy(
$name,
apply_filters( 'lifterlms_register_taxonomy_objects_' . $filter_name, $object ),
apply_filters( 'lifterlms_register_taxonomy_args_' . $filter_name, $data )
);
}
}
/**
* Register Taxonomies
*
* @since 1.0.0
* @since 3.30.3 Removed duplicate array keys when registering course_tag taxonomy.
* @since 3.34.1 Add custom property `show_in_llms_rest` set to true by default to those taxonomies we want to show in LLMS REST api.
*
* @return void
*/
public static function register_taxonomies() {
$permalinks = llms_get_permalink_structure();
// Course cat.
self::register_taxonomy(
'course_cat',
array( 'course' ),
array(
'label' => __( 'Course Categories', 'lifterlms' ),
'labels' => array(
'name' => __( 'Course Categories', 'lifterlms' ),
'singular_name' => __( 'Course Category', 'lifterlms' ),
'menu_name' => _x( 'Categories', 'Admin menu name', 'lifterlms' ),
'search_items' => __( 'Search Course Categories', 'lifterlms' ),
'all_items' => __( 'All Course Categories', 'lifterlms' ),
'parent_item' => __( 'Parent Course Category', 'lifterlms' ),
'parent_item_colon' => __( 'Parent Course Category:', 'lifterlms' ),
'edit_item' => __( 'Edit Course Category', 'lifterlms' ),
'update_item' => __( 'Update Course Category', 'lifterlms' ),
'add_new_item' => __( 'Add New Course Category', 'lifterlms' ),
'new_item_name' => __( 'New Course Category Name', 'lifterlms' ),
),
'capabilities' => self::get_tax_caps( 'course_cat' ),
'hierarchical' => true,
'query_var' => true,
'show_admin_column' => true,
'show_ui' => true,
'rewrite' => array(
'slug' => $permalinks['course_category_base'],
'with_front' => false,
'hierarchical' => true,
),
'show_in_llms_rest' => true,
)
);
// Course difficulty.
self::register_taxonomy(
'course_difficulty',
array( 'course' ),
array(
'label' => __( 'Course Difficulties', 'lifterlms' ),
'labels' => array(
'name' => __( 'Course Difficulties', 'lifterlms' ),
'singular_name' => __( 'Course Difficulty', 'lifterlms' ),
'menu_name' => _x( 'Difficulties', 'Admin menu name', 'lifterlms' ),
'search_items' => __( 'Search Course Difficulties', 'lifterlms' ),
'all_items' => __( 'All Course Difficulties', 'lifterlms' ),
'parent_item' => __( 'Parent Course Difficulty', 'lifterlms' ),
'parent_item_colon' => __( 'Parent Course Difficulty:', 'lifterlms' ),
'edit_item' => __( 'Edit Course Difficulty', 'lifterlms' ),
'update_item' => __( 'Update Course Difficulty', 'lifterlms' ),
'add_new_item' => __( 'Add New Course Difficulty', 'lifterlms' ),
'new_item_name' => __( 'New Course Difficulty Name', 'lifterlms' ),
),
'capabilities' => self::get_tax_caps( array( 'course_difficulty', 'course_difficulties' ) ),
'hierarchical' => false,
'query_var' => true,
'show_admin_column' => true,
'show_ui' => true,
'rewrite' => array(
'slug' => $permalinks['course_difficulty_base'],
'with_front' => false,
),
'show_in_llms_rest' => true,
)
);
// Course tag.
self::register_taxonomy(
'course_tag',
array( 'course' ),
array(
'label' => __( 'Course Tags', 'lifterlms' ),
'labels' => array(
'name' => __( 'Course Tags', 'lifterlms' ),
'singular_name' => __( 'Course Tag', 'lifterlms' ),
'menu_name' => _x( 'Tags', 'Admin menu name', 'lifterlms' ),
'search_items' => __( 'Search Course Tags', 'lifterlms' ),
'all_items' => __( 'All Course Tags', 'lifterlms' ),
'parent_item' => __( 'Parent Course Tag', 'lifterlms' ),
'parent_item_colon' => __( 'Parent Course Tag:', 'lifterlms' ),
'edit_item' => __( 'Edit Course Tag', 'lifterlms' ),
'update_item' => __( 'Update Course Tag', 'lifterlms' ),
'add_new_item' => __( 'Add New Course Tag', 'lifterlms' ),
'new_item_name' => __( 'New Course Tag Name', 'lifterlms' ),
),
'capabilities' => self::get_tax_caps( 'course_tag' ),
'hierarchical' => false,
'query_var' => true,
'show_admin_column' => true,
'show_ui' => true,
'rewrite' => array(
'slug' => $permalinks['course_tag_base'],
'with_front' => false,
),
'show_in_llms_rest' => true,
)
);
// Course track.
self::register_taxonomy(
'course_track',
array( 'course' ),
array(
'label' => __( 'Course Track', 'lifterlms' ),
'labels' => array(
'name' => __( 'Course Tracks', 'lifterlms' ),
'singular_name' => __( 'Course Track', 'lifterlms' ),
'menu_name' => _x( 'Tracks', 'Admin menu name', 'lifterlms' ),
'search_items' => __( 'Search Course Tracks', 'lifterlms' ),
'all_items' => __( 'All Course Tracks', 'lifterlms' ),
'parent_item' => __( 'Parent Course Track', 'lifterlms' ),
'parent_item_colon' => __( 'Parent Course Track:', 'lifterlms' ),
'edit_item' => __( 'Edit Course Track', 'lifterlms' ),
'update_item' => __( 'Update Course Track', 'lifterlms' ),
'add_new_item' => __( 'Add New Course Track', 'lifterlms' ),
'new_item_name' => __( 'New Course Track Name', 'lifterlms' ),
),
'capabilities' => self::get_tax_caps( 'course_track' ),
'hierarchical' => true,
'query_var' => true,
'show_admin_column' => true,
'show_ui' => true,
'rewrite' => array(
'slug' => $permalinks['course_track_base'],
'with_front' => false,
'hierarchical' => true,
),
'show_in_llms_rest' => true,
)
);
// Membership cat.
self::register_taxonomy(
'membership_cat',
array( 'llms_membership' ),
array(
'hierarchical' => true,
'label' => __( 'Membership Categories', 'lifterlms' ),
'labels' => array(
'name' => __( 'Membership Categories', 'lifterlms' ),
'singular_name' => __( 'Membership Category', 'lifterlms' ),
'menu_name' => _x( 'Categories', 'Admin menu name', 'lifterlms' ),
'search_items' => __( 'Search Membership Categories', 'lifterlms' ),
'all_items' => __( 'All Membership Categories', 'lifterlms' ),
'parent_item' => __( 'Parent Membership Category', 'lifterlms' ),
'parent_item_colon' => __( 'Parent Membership Category:', 'lifterlms' ),
'edit_item' => __( 'Edit Membership Category', 'lifterlms' ),
'update_item' => __( 'Update Membership Category', 'lifterlms' ),
'add_new_item' => __( 'Add New Membership Category', 'lifterlms' ),
'new_item_name' => __( 'New Membership Category Name', 'lifterlms' ),
),
'capabilities' => self::get_tax_caps( 'membership_cat' ),
'show_ui' => true,
'show_in_menu' => true,
'query_var' => true,
'show_admin_column' => true,
'rewrite' => array(
'slug' => $permalinks['membership_category_base'],
'with_front' => false,
'hierarchical' => true,
),
'show_in_llms_rest' => true,
)
);
// Membership tag.
self::register_taxonomy(
'membership_tag',
array( 'llms_membership' ),
array(
'hierarchical' => false,
'label' => __( 'Membership Tags', 'lifterlms' ),
'labels' => array(
'name' => __( 'Membership Tags', 'lifterlms' ),
'singular_name' => __( 'Membership Tag', 'lifterlms' ),
'menu_name' => _x( 'Tags', 'Admin menu name', 'lifterlms' ),
'search_items' => __( 'Search Membership Tags', 'lifterlms' ),
'all_items' => __( 'All Membership Tags', 'lifterlms' ),
'parent_item' => __( 'Parent Membership Tag', 'lifterlms' ),
'parent_item_colon' => __( 'Parent Membership Tag:', 'lifterlms' ),
'edit_item' => __( 'Edit Membership Tag', 'lifterlms' ),
'update_item' => __( 'Update Membership Tag', 'lifterlms' ),
'add_new_item' => __( 'Add New Membership Tag', 'lifterlms' ),
'new_item_name' => __( 'New Membership Tag Name', 'lifterlms' ),
),
'capabilities' => self::get_tax_caps( 'membership_tag' ),
'show_ui' => true,
'show_in_menu' => 'lifterlms',
'query_var' => true,
'show_admin_column' => true,
'rewrite' => array(
'slug' => $permalinks['membership_tag_base'],
'with_front' => false,
),
'show_in_llms_rest' => true,
)
);
// Course/membership visibility.
self::register_taxonomy(
'llms_product_visibility',
array( 'course', 'llms_membership' ),
array(
'hierarchical' => false,
'show_ui' => false,
'show_in_nav_menus' => false,
'query_var' => is_admin(),
'rewrite' => false,
'public' => false,
)
);
// Access plan visibility.
self::register_taxonomy(
'llms_access_plan_visibility',
array( 'llms_access_plan' ),
array(
'hierarchical' => false,
'show_ui' => false,
'show_in_nav_menus' => false,
'query_var' => is_admin(),
'rewrite' => false,
'public' => false,
)
);
}
}
LLMS_Post_Types::init();
================================================
FILE: includes/class.llms.post.handler.php
================================================
<?php
/**
* Post Handler Class
*
* Main Handler for post management in LifterLMS
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 5.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Post_Handler
*
* @since 1.0.0
* @since 4.4.3 Deprecated the `LLMS_Post_Handler::create_lesson()` method with no replacement.
* @since 5.7.0 Deprecated the `LLMS_Post_Handler::create_section()` method with no replacement.
*/
class LLMS_Post_Handler {
/**
* Create Post
*
* @param string $type [optional: a post type]
* @param string $title [optional: a title for the post]
* @return int [id of section]
*/
public static function create( $type = 'post', $title = '', $excerpt = '' ) {
if ( empty( $title ) ) {
$title = 'Section 1';
}
// Create section post.
$post_data = apply_filters(
'lifterlms_new_post',
array(
'post_type' => $type,
'post_title' => $title,
'post_status' => 'publish',
'post_author' => get_current_user_id(),
'post_excerpt' => $excerpt,
)
);
$post_id = wp_insert_post( $post_data, true );
// Check for error in update.
if ( is_wp_error( $post_id ) ) {
// For now just log the error and set $post_id to 0 (false).
llms_log( $post_id->get_error_message() );
$post_id = 0;
}
return $post_id;
}
public static function update_title( $post_id, $title ) {
$post_data = array(
'ID' => $post_id,
'post_title' => $title,
);
// Update the post into the database.
$updated_post_id = wp_update_post( $post_data );
if ( $updated_post_id ) {
return array(
'id' => $updated_post_id,
'title' => $title,
);
}
}
public static function update_excerpt( $post_id, $excerpt ) {
$post_data = array(
'ID' => $post_id,
'post_excerpt' => $excerpt,
);
// Update the post into the database.
$updated_post_id = wp_update_post( $post_data );
if ( $updated_post_id ) {
return array(
'id' => $updated_post_id,
'post_excerpt' => $excerpt,
);
}
}
/**
* Creates a new Section
*
* @since Unknown Introduced.
* @deprecated 5.7.0 There is not a replacement.
*
* @param int $course_id The parent course id.
* @param string $title An optional title for the section.
* @return int Post id of the section.
*/
public static function create_section( $course_id, $title = '' ) {
llms_deprecated_function( __METHOD__, '5.7.0' );
// No course id? no new section!.
if ( ! isset( $course_id ) ) {
return;
}
// Set the section_order variable.
// Get the count of sections in the course and add 1.
$course = new LLMS_Course( $course_id );
$sections = $course->get_sections( 'posts' );
$section_order = count( $sections ) + 1;
$title = isset( $title ) ? $title : 'New Section';
$post_id = self::create( 'section', $title );
// If post created set parent course and order to order determined above.
if ( $post_id ) {
update_post_meta( $post_id, '_llms_order', $section_order );
$section = new LLMS_Section( $post_id );
$updated_parent_course = $section->set_parent_course( $course_id );
}
return $post_id;
}
/**
* Create lesson
*
* @since Unknown
* @deprecated 4.4.3
*
* @param int $course_id WP_Post ID of the course.
* @param int $section_id WP_Post ID of the lesson's parent section.
* @param string $title Optional lesson title.
* @param string $excerpt Option excerpt.
* @return int WP_Post ID of the created lesson.
*/
public static function create_lesson( $course_id, $section_id, $title = '', $excerpt = '' ) {
// No course id or section id? no new lesson!.
if ( ! isset( $course_id ) || ! isset( $course_id ) ) {
return;
}
// Set the lesson_order variable.
// Get the count of lessons in the section.
$section = new LLMS_Section( $section_id );
$lesson_order = $section->get_next_available_lesson_order();
$title = isset( $title ) ? $title : 'New Lesson';
$post_id = self::create( 'lesson', $title, $excerpt );
// If post created set parent section, parent course and order determined above.
if ( $post_id ) {
update_post_meta( $post_id, '_llms_order', $lesson_order );
$lesson = new LLMS_Lesson( $post_id );
$updated_parent_section = $lesson->set_parent_section( $section_id );
$updated_parent_course = $lesson->set_parent_course( $course_id );
}
return $post_id;
}
public static function get_posts( $type = 'post' ) {
$args = array(
'posts_per_page' => 1000,
'post_type' => $type,
'nopaging' => true,
'post_status' => 'publish',
'orderby' => 'post_title',
'order' => 'ASC',
'suppress_filters' => true,
);
$postslist = get_posts( $args );
if ( ! empty( $postslist ) ) {
foreach ( $postslist as $key => $value ) {
$value->edit_url = get_edit_post_link( $value->ID, false );
}
}
return $postslist;
}
public static function get_lesson_options_for_select_list() {
$lessons = self::get_posts( 'lesson' );
$options = array();
if ( ! empty( $lessons ) ) {
foreach ( $lessons as $key => $value ) {
// Get parent course if assigned.
$parent_course = get_post_meta( $value->ID, '_llms_parent_course', true );
if ( $parent_course ) {
$title = $value->post_title . ' ( ' . get_the_title( $parent_course ) . ' )';
} else {
$title = $value->post_title . ' ( ' . __( 'unassigned', 'lifterlms' ) . ' )';
}
$options[ $value->ID ] = $title;
}
}
return $options;
}
public static function get_prerequisite( $post_id ) {
$post_type = get_post_type( $post_id );
if ( 'course' === $post_type ) {
$course = new LLMS_Course( $post_id );
return $course->get_prerequisite();
} elseif ( 'lesson' === $post_type ) {
$lesson = new LLMS_Lesson( $post_id );
return $lesson->get_prerequisite();
}
}
}
================================================
FILE: includes/class.llms.post.relationships.php
================================================
<?php
/**
* Define post and record relationships to automate cleanup of information when posts are deleted from the DB.
*
* @package LifterLMS/Classes
*
* @since 3.16.12
* @version 7.6.2
*/
defined( 'ABSPATH' ) || exit;
/**
* Hooks and actions related to post relationships.
*
* @since 3.16.12
* @since 3.24.0 Unknown.
* @since 3.37.8 Delete student quiz attempts when a quiz is deleted.
* @since 4.15.0 Delete access plans related to courses/memberships on their deletion.
*/
class LLMS_Post_Relationships {
/**
* Configure relationships.
*
* @since Unknown.
* @since 7.6.2 Added `llms_voucher` relationship.
* @var array
*/
private $relationships = array(
'course' => array(
array(
'action' => 'delete',
'meta_key' => '_llms_product_id',
'post_type' => 'llms_access_plan',
),
),
'llms_membership' => array(
array(
'action' => 'delete',
'meta_key' => '_llms_product_id',
'post_type' => 'llms_access_plan',
),
),
'lesson' => array(
array(
'action' => 'unset',
'meta_key' => '_llms_prerequisite', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'meta_keys_additional' => array( '_llms_has_prerequisite' ),
'post_type' => 'lesson',
),
array(
'action' => 'unset',
'meta_key' => '_llms_lesson_id', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'post_type' => 'llms_quiz',
),
),
'llms_order' => array(
array(
'action' => 'delete',
'meta_key' => '_llms_order_id', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'post_type' => 'llms_transaction',
),
),
'llms_quiz' => array(
array(
'action' => 'delete', // Delete = force delete; trash = move to trash.
'meta_key' => '_llms_parent_id', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'post_type' => 'llms_question',
),
array(
'action' => 'unset',
'meta_key' => '_llms_quiz', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'meta_keys_additional' => array( '_llms_quiz_enabled' ),
'post_type' => 'lesson',
),
array(
'action' => 'delete',
'table_name' => 'lifterlms_quiz_attempts',
'table_key' => 'quiz_id',
),
),
'llms_voucher' => array(
array(
'action' => 'delete',
'table_name' => 'lifterlms_vouchers_codes',
'table_key' => 'voucher_id',
),
),
);
/**
* Constructor.
*
* @since 3.16.12
* @since 5.4.0 Prevent course/membership with active subscriptions deletion.
* @since 6.0.0 Added hook to cleanup user post meta data when awarded certs and achievements are deleted.
*
* @return void
*/
public function __construct() {
add_action( 'delete_post', array( $this, 'maybe_update_relationships' ) );
add_action( 'pre_delete_post', array( __CLASS__, 'maybe_prevent_product_deletion' ), 10, 2 );
add_action( 'before_delete_post', array( __CLASS__, 'maybe_clean_earned_engagments_related_user_post_meta' ) );
}
/**
* Maybe delete LifterLMS user post meta related to earned engagements.
*
* @since 6.0.0
*
* @param int $post_id Post ID.
* @return void
*/
public static function maybe_clean_earned_engagments_related_user_post_meta( $post_id ) {
$post_types = array(
'llms_my_certificate',
'llms_my_achievement',
);
$post_type = get_post_type( $post_id );
if ( ! in_array( $post_type, $post_types, true ) ) {
return;
}
$earned_engagement = 'llms_my_certificate' === $post_type ? new LLMS_User_Certificate( $post_id ) : new LLMS_User_Achievement( $post_id );
do_action_deprecated(
'llms_before_delete_' . str_replace( 'llms_my_', '', $post_type ),
array(
$earned_engagement,
),
'6.0.0',
'',
__( 'Use WordPress core `before_delete_post` action hook', 'lifterlms' )
);
global $wpdb;
$wpdb->delete(
"{$wpdb->prefix}lifterlms_user_postmeta",
array(
'user_id' => $earned_engagement->get_user_id(),
'meta_key' => '_' . str_replace( 'llms_my_', '', $post_type ) . '_earned',
'meta_value' => $post_id,
),
array( '%d', '%s', '%d' )
); // no-cache ok.
add_action(
'after_delete_post',
function ( $post_id ) use ( $earned_engagement, $post_type ) {
if ( $earned_engagement->get( 'id' ) === $post_id ) {
do_action_deprecated(
'llms_delete_' . str_replace( 'llms_my_', '', $post_type ),
array(
$earned_engagement,
),
'6.0.0',
'',
__( 'Use WordPress core `deleted_post` action hook.', 'lifterlms' )
);
}
}
);
}
/**
* Determine whether a product deletion should take place.
*
* @since 5.4.0
*
* @param bool|null $delete Whether to go forward with deletion.
* @param WP_Post $post Post object.
* @return bool|null
*/
public static function maybe_prevent_product_deletion( $delete, $post ) {
if ( ! in_array( get_post_type( $post ), array( 'course', 'llms_membership' ), true ) ) {
return $delete;
}
$product = llms_get_product( $post );
if ( empty( $product ) || ! $product->has_active_subscriptions() ) {
return $delete;
}
// If performing the deletion via REST API change the error message to reflect the reason for the prevention.
if ( llms_is_rest() ) {
// Filter the error message.
add_filter( 'rest_request_after_callbacks', array( __CLASS__, 'rest_filter_products_with_active_subscriptions_error_message' ), 10, 3 );
} else { // Deleting via wp-admin.
wp_die(
esc_html( self::delete_product_with_active_subscriptions_error_message( $product->get( 'id' ) ) )
);
}
return false;
}
/**
* Filter the error message returned when trying to delete a product with active subscription via REST API.
*
* The original message is a standard permission denied message.
*
* @since 5.4.0
*
* @param WP_REST_Response|WP_HTTP_Response|WP_Error|mixed $response Result to send to the client.
* Usually a WP_REST_Response or WP_Error.
* @param array $handler Route handler used for the request.
* @param WP_REST_Request $request Request used to generate the response.
* @return WP_REST_Response|WP_HTTP_Response|WP_Error|mixed
*/
public static function rest_filter_products_with_active_subscriptions_error_message( $response, $handler, $request ) {
if ( is_wp_error( $response ) ) {
foreach ( $response->errors as $code => &$data ) {
// Error code can be produced by our rest-api or by wp core.
if ( in_array( $code, array( 'llms_rest_cannot_delete', 'rest_cannot_delete' ), true ) ) {
$data[0] = self::delete_product_with_active_subscriptions_error_message( $request['id'] );
break;
}
}
}
return $response;
}
/**
* Returns the error message to display when deleting a product with active subscriptions.
*
* @since 5.4.0
*
* @param int $post_id The WP_Post ID of the product.
* @return string
*/
public static function delete_product_with_active_subscriptions_error_message( $post_id ) {
$post_type = get_post_type( $post_id );
if ( ! in_array( $post_type, array( 'course', 'llms_membership' ), true ) ) {
return '';
}
$post_type_object = get_post_type_object( $post_type );
$post_type_name = $post_type_object->labels->name;
return sprintf(
// Translators: %s = The post type plural name.
__( 'Sorry, you are not allowed to delete %s with active subscriptions.', 'lifterlms' ),
$post_type_name
);
}
/**
* Delete / Trash posts related to the deleted post.
*
* @since 3.16.12
* @since 3.37.8 Allow for deletion of related items outside the WP core posts table.
*
* @param WP_Post $post WP Post that's been deleted.
* @param array $data Relationship data array.
* @return void
*/
private function delete_relationships( $post, $data ) {
if ( isset( $data['post_type'] ) && isset( $data['meta_key'] ) ) {
$this->delete_wp_posts( $post, $data );
} elseif ( isset( $data['table_name'] ) && isset( $data['table_key'] ) ) {
$this->delete_table_records( $post, $data );
}
}
/**
* Delete records from a table that are related to the deleted post.
*
* @since 3.37.8
*
* @param WP_Post $post WP Post that's been deleted.
* @param array $data Relationship data array.
* @return void
*/
private function delete_table_records( $post, $data ) {
global $wpdb;
$wpdb->delete( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
$wpdb->prefix . $data['table_name'],
array(
$data['table_key'] => $post->ID,
),
'%d'
);
}
/**
* Delete or trash WP Posts related to the deleted post.
*
* @since 3.37.8
*
* @param WP_Post $post WP Post that's been deleted.
* @param array $data Relationship data array.
* @return void
*/
private function delete_wp_posts( $post, $data ) {
$relationships = $this->get_related_posts( $post->ID, $data['post_type'], $data['meta_key'] );
$force = ( 'delete' === $data['action'] );
foreach ( $relationships as $id ) {
wp_delete_post( $id, $force );
}
}
/**
* Get a list of post types with relationships that should be checked.
*
* @since 3.16.12
*
* @return array
*/
private function get_post_types() {
return array_keys( $this->get_relationships() );
}
/**
* Retrieve filtered LifterLMS post relationships array.
*
* @since 3.16.12
*
* @return array
*/
private function get_relationships() {
return apply_filters( 'llms_get_post_relationships', $this->relationships );
}
/**
* Retrieve an array of post ids related to the deleted post by post type and meta key.
*
* @since 3.16.12
*
* @param int $post_id WP Post ID of the deleted post.
* @param string $post_type WP Post type of the related post(s).
* @param string $meta_key meta_key to check for relations by.
* @return array
*/
private function get_related_posts( $post_id, $post_type, $meta_key ) {
global $wpdb;
return $wpdb->get_col(
$wpdb->prepare(
"SELECT p.ID
FROM {$wpdb->posts} AS p
LEFT JOIN {$wpdb->postmeta} AS pm
ON p.ID = pm.post_id
AND pm.meta_key = %s
WHERE p.post_type = %s
AND pm.meta_value = %d",
$meta_key,
$post_type,
$post_id
)
); // db-call ok; no-cache ok.
}
/**
* Check relationships and delete / update related posts when a post is deleted.
*
* Called on `delete_post` hook (before a post is deleted).
*
* @since 3.16.12
* @since 3.24.0 Unknown.
*
* @param int $post_id WP Post ID of the deleted post.
* @return void
*/
public function maybe_update_relationships( $post_id ) {
$post = get_post( $post_id );
if ( ! in_array( $post->post_type, $this->get_post_types(), true ) ) {
return;
}
foreach ( $this->get_relationships() as $post_type => $relationships ) {
if ( $post->post_type !== $post_type ) {
continue;
}
foreach ( $relationships as $data ) {
if ( in_array( $data['action'], array( 'delete', 'trash' ), true ) ) {
$this->delete_relationships( $post, $data );
} elseif ( 'unset' === $data['action'] ) {
$this->unset_relationships( $post, $data );
}
}
}
}
/**
* Unsets relationship data from post_meta when a post is deleted.
*
* @since 3.16.12
* @since 3.24.0 Unknown.
*
* @param WP_Post $post WP Post that's been deleted.
* @param array $data Relationship data array.
* @return void
*/
private function unset_relationships( $post, $data ) {
$relationships = $this->get_related_posts( $post->ID, $data['post_type'], $data['meta_key'] );
foreach ( $relationships as $id ) {
delete_post_meta( $id, $data['meta_key'], $post->ID );
if ( isset( $data['meta_keys_additional'] ) ) {
foreach ( $data['meta_keys_additional'] as $key ) {
delete_post_meta( $id, $key );
}
}
}
}
}
return new LLMS_Post_Relationships();
================================================
FILE: includes/class.llms.query.php
================================================
<?php
/**
* LLMS_Query class file.
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Query base class
*
* Handles queries and endpoints.
*
* @since 1.0.0
* @since 4.0.0 Remove previously deprecated methods.
*/
class LLMS_Query {
/**
* Query var
*
* @var array
*/
public $query_vars = array();
/**
* Constructor.
*
* @since 1.0.0
* @since 3.28.2 Unknown.
* @since 3.36.3 Changed `pre_get_posts` callback from `10 (default) to `15`,
* so to avoid conflicts with the Divi theme whose callback runs at `10`,
* but since themes are loaded after plugins it overrode our one.
* @since 4.5.0 Added action to serve 404s on unviewable certificates.
* @since 6.0.0 Add callback to redirect old `llms_my_certificates` requests to the new url.
*/
public function __construct() {
add_action( 'init', array( $this, 'add_endpoints' ) );
if ( ! is_admin() ) {
add_filter( 'query_vars', array( $this, 'set_query_vars' ), 0 );
add_action( 'parse_request', array( $this, 'parse_request' ), 0 );
add_action( 'wp', array( $this, 'maybe_404_certificate' ), 50 );
add_action( 'wp', array( $this, 'maybe_redirect_certificate' ), 50 );
}
$this->init_query_vars();
add_action( 'pre_get_posts', array( $this, 'pre_get_posts' ), 15 );
add_filter( 'get_previous_post_where', array( $this, 'exclude_hidden_llms_products' ) );
add_filter( 'get_next_post_where', array( $this, 'exclude_hidden_llms_products' ) );
}
/**
* Add Query Endpoints
*
* @since 1.0.0
* @since 3.28.2 Handle dashboard tab pagination via a rewrite rule.
* @since 5.0.2 Add support for slugs with non-latin characters.
*
* @return void
*/
public function add_endpoints() {
foreach ( $this->get_query_vars() as $key => $var ) {
add_rewrite_endpoint( $var, EP_PAGES, $key );
}
global $wp_rewrite;
foreach ( LLMS_Student_Dashboard::get_tabs() as $id => $tab ) {
if ( ! empty( $tab['paginate'] ) ) {
$regex = sprintf( '(.?.+?)/%1$s/%2$s/?([0-9]{1,})/?$', urldecode( $tab['endpoint'] ), $wp_rewrite->pagination_base );
$redirect = sprintf( 'index.php?pagename=$matches[1]&%s=$matches[3]&paged=$matches[2]', $id );
add_rewrite_rule( $regex, $redirect, 'top' );
}
}
}
/**
* Get query variables
*
* @since Unknown
*
* @return array
*/
public function get_query_vars() {
return apply_filters( 'llms_get_endpoints', $this->query_vars );
}
/**
* Get a taxonomy query that filters out courses & memberships based on catalog / search visibility settings
*
* @since 3.6.0
*
* @param array $query Existing taxonomy query from the global $wp_query.
* @return array
*/
private function get_tax_query( $query = array() ) {
if ( ! is_array( $query ) ) {
$query = array(
'relation' => 'AND',
);
}
$terms = wp_list_pluck(
get_terms(
array(
'taxonomy' => 'llms_product_visibility',
'hide_empty' => false,
)
),
'term_taxonomy_id',
'name'
);
$not_in = ( is_search() ) ? array( $terms['hidden'], $terms['catalog'] ) : array( $terms['hidden'], $terms['search'] );
$query[] = array(
'field' => 'term_taxonomy_id',
'operator' => 'NOT IN',
'taxonomy' => 'llms_product_visibility',
'terms' => $not_in,
);
return $query;
}
/**
* Init queries
*
* @since Unknown
*
* @return void
*/
public function init_query_vars() {
$this->query_vars = array(
'confirm-payment' => get_option( 'lifterlms_myaccount_confirm_payment_endpoint', 'confirm-payment' ),
'lost-password' => get_option( 'lifterlms_myaccount_lost_password_endpoint', 'lost-password' ),
);
}
/**
* Parse the request for query variables
*
* @since unknown
* @since 3.31.0 sanitize and unslash `$_GET` vars.
*
* @return void
*/
public function parse_request() {
global $wp;
foreach ( $this->get_query_vars() as $key => $var ) {
if ( isset( $_GET[ $var ] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
$wp->query_vars[ $key ] = sanitize_text_field( wp_unslash( $_GET[ $var ] ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
} elseif ( isset( $wp->query_vars[ $var ] ) ) {
$wp->query_vars[ $key ] = $wp->query_vars[ $var ];
}
}
}
/**
* Sets the WP_Query variables for "post_type" on LifterLMS custom taxonomy archive pages for Courses and Memberships.
*
* @since 1.4.4 Moved from LLMS_Post_Types.
* @since 3.16.8
* @since 3.33.0 Added `post_title` as a secondary sort when the primary sort is `menu_order`
* @since 3.36.3 Changed `pre_get_posts` callback from `10 (default) to `15`,
* so to avoid conflicts with the Divi theme whose callback runs at `10`,
* but since themes are loaded after plugins it overrode our one.
* @since 3.36.4 Don't remove this callback from within the callback itself.
* Rather use a static variable to make sure the business logic of this
* method is executed only once.
*
* @param WP_Query $query Main WP_Query Object.
* @return void
*/
public function pre_get_posts( $query ) {
static $done = false;
$modify_tax_query = false;
if ( $done ) {
return;
}
if ( ! is_admin() && $query->is_main_query() ) {
if ( is_search() ) {
$modify_tax_query = true;
}
if ( is_tax( array( 'course_cat', 'course_tag', 'course_difficulty', 'course_track', 'membership_tag', 'membership_cat' ) ) ) {
$query->set( 'post_type', array( 'course', 'llms_membership' ) );
$modify_tax_query = true;
}
if ( is_post_type_archive( 'course' ) || $query->get( 'page_id' ) == llms_get_page_id( 'courses' ) || is_tax( array( 'course_cat', 'course_tag', 'course_difficulty', 'course_track' ) ) ) {
$query->set( 'posts_per_page', get_option( 'lifterlms_shop_courses_per_page', 10 ) );
$sorting = explode( ',', get_option( 'lifterlms_shop_ordering', 'menu_order,ASC' ) );
$orderby = empty( $sorting[0] ) ? 'menu_order' : $sorting[0];
if ( 'menu_order' === $orderby ) {
$orderby .= ' post_title';
}
$order = empty( $sorting[1] ) ? 'ASC' : $sorting[1];
$query->set( 'orderby', apply_filters( 'llms_courses_orderby', $orderby ) );
$query->set( 'order', apply_filters( 'llms_courses_order', $order ) );
$modify_tax_query = true;
} elseif ( is_post_type_archive( 'llms_membership' ) || $query->get( 'page_id' ) == llms_get_page_id( 'memberships' ) || is_tax( array( 'membership_tag', 'membership_cat' ) ) ) {
$query->set( 'posts_per_page', get_option( 'lifterlms_memberships_per_page', 10 ) );
$sorting = explode( ',', get_option( 'lifterlms_memberships_ordering', 'menu_order,ASC' ) );
$orderby = empty( $sorting[0] ) ? 'menu_order' : $sorting[0];
if ( 'menu_order' === $orderby ) {
$orderby .= ' post_title';
}
$order = empty( $sorting[1] ) ? 'ASC' : $sorting[1];
$query->set( 'orderby', apply_filters( 'llms_memberships_orderby', $orderby ) );
$query->set( 'order', apply_filters( 'llms_memberships_order', $order ) );
$modify_tax_query = true;
}
// Do it once.
$done = true;
}
if ( $modify_tax_query ) {
$query->set( 'tax_query', $this->get_tax_query( $query->get( 'tax_query' ) ) );
}
}
/**
* Serve a 404 for certificates that are not viewable by the current user
*
* @since 4.5.0
*
* @return void
*/
public function maybe_404_certificate() {
if ( 'llms_my_certificate' === get_post_type() ) {
$cert = new LLMS_User_Certificate( get_the_ID() );
if ( ! $cert->can_user_view() ) {
global $wp_query;
$wp_query->set_404();
status_header( 404 );
nocache_headers();
}
}
}
/**
* Redirect requests to old llms_my_certificate URLs to the new url.
*
* Redirects `/my_certificate/slug` to `/certificate/slug` maintaining
* translations.
*
* This will only redirect if `$wp_query` detects a 404 and a certificate
* exists with the parsed slug. This check is important to prevent against
* collisions which are theoretically possible, though probably unlikely.
*
* @since 6.0.0
* @since 7.5.0 Fixed passing null to parameter #1 ($haystack) using `strpos`.
*
* @return void
*/
public function maybe_redirect_certificate() {
global $wp, $wp_query;
$old = sprintf( '/%s/', _x( 'my_certificate', 'slug', 'lifterlms' ) );
$path = wp_parse_url( home_url( $wp->request ), PHP_URL_PATH );
if ( $wp_query->is_404() && $path && 0 === strpos( $path, $old ) ) {
$slug = str_replace( $old, '', $path );
$new_post = get_page_by_path( $slug, 'OBJECT', 'llms_my_certificate' );
if ( $new_post ) {
llms_redirect_and_exit( get_permalink( $new_post->ID ) );
}
}
}
/**
* Set query variables
*
* @since Unknown
*
* @param array $vars WP query variables available for query.
* @return array
*/
public function set_query_vars( $vars ) {
foreach ( $this->get_query_vars() as $key => $var ) {
$vars[] = $key;
}
return $vars;
}
/**
* Avoid showing hidden products in the previous/next post queries.
*
* @since 9.0.0
* @param $where
*
* @return string
*/
public function exclude_hidden_llms_products( $where ) {
global $wpdb;
$where .= " AND p.ID NOT IN (
SELECT object_id
FROM {$wpdb->term_relationships} AS tr
INNER JOIN {$wpdb->term_taxonomy} AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id
INNER JOIN {$wpdb->terms} AS t ON tt.term_id = t.term_id
WHERE tt.taxonomy = 'llms_product_visibility'
AND t.slug IN ('hidden')
)";
return $where;
}
}
return new LLMS_Query();
================================================
FILE: includes/class.llms.query.quiz.attempt.php
================================================
<?php
/**
* Query LifterLMS Students for a given course / membership.
*
* @package LifterLMS/Classes
*
* @since 3.16.0
* @version 7.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Query LifterLMS Students for a given course / membership
*
* @since 3.16.0
* @since 3.35.0 Unknown.
* @since 4.2.0 Added `exclude` arg.
*
* @arg $attempt (int) Query by attempt number
* @arg $quiz_id (int|array) Query by Quiz WP post ID (locate multiple quizzes with an array of ids)
* @arg $student_id (int|array) Query by WP User ID (locate by multiple users with an array of ids)
*
* @arg $page (int) Get results by page
* @arg $per_page (int) Number of results per page (default: 25)
* @arg $sort (array) Define query sorting options [id,student_id,quiz_id,start_date,update_date,end_date,attempt,grade,current,passed]
*
* @example
* $query = new LLMS_Query_Quiz_Attempt( array(
* 'student_id' => 1234,
* 'quiz_id' => 5678,
* ) );
*/
class LLMS_Query_Quiz_Attempt extends LLMS_Database_Query {
/**
* Identify the extending query
*
* @var string
*/
protected $id = 'quiz_attempt';
/**
* Retrieve default arguments for a student query.
*
* @since 3.16.0
* @since 4.2.0 Added `exclude` default arg.
* @since 7.8.0 Added `can_be_resumed` default arg.
*
* @return array
*/
protected function get_default_args() {
$args = array(
'student_id' => array(),
'quiz_id' => array(),
'sort' => array(
'start_date' => 'DESC',
'attempt' => 'DESC',
'id' => 'ASC',
),
'status' => array(),
'status_exclude' => array(),
'attempt' => null,
'exclude' => array(),
'can_be_resumed' => null,
'search' => '',
);
$args = wp_parse_args( $args, parent::get_default_args() );
return apply_filters( $this->get_filter( 'default_args' ), $args );
}
/**
* Retrieve an array of LLMS_Quiz_Attempts for the given result set returned by the query
*
* @since 3.16.0
*
* @return LLMS_Quiz_Attempt[]
*/
public function get_attempts() {
$attempts = array();
$results = $this->get_results();
if ( $results ) {
foreach ( $results as $result ) {
$attempts[] = new LLMS_Quiz_Attempt( $result->id );
}
}
if ( $this->get( 'suppress_filters' ) ) {
return $attempts;
}
return apply_filters( $this->get_filter( 'get_attempts' ), $attempts );
}
/**
* Parses data passed to $statuses
*
* Convert strings to array and ensure resulting array contains only valid statuses.
* If no valid statuses, returns to the default.
*
* @since 3.16.0
* @since 4.2.0 Added `exclude` arg sanitization.
*
* @return void
*/
protected function parse_args() {
// Sanitize post, user, excluded attempts ids.
foreach ( array( 'student_id', 'quiz_id', 'exclude' ) as $key ) {
$this->arguments[ $key ] = $this->sanitize_id_array( $this->arguments[ $key ] );
}
// Validate status args.
$valid_statuses = array_keys( llms_get_quiz_attempt_statuses() );
foreach ( array( 'status', 'status_exclude' ) as $key ) {
// Allow single statuses to be passed in as a string.
if ( is_string( $this->arguments[ $key ] ) ) {
$this->arguments[ $key ] = array( $this->arguments[ $key ] );
}
// Ensure submitted statuses are valid.
if ( $this->arguments[ $key ] ) {
$this->arguments[ $key ] = array_intersect( $valid_statuses, $this->arguments[ $key ] );
}
}
}
/**
* Prepare the SQL for the query.
*
* @since 3.16.0
* @since 6.0.0 Renamed from `preprare_query()`.
* @since 10.0.0 Build count_query from shared clauses instead of using SQL_CALC_FOUND_ROWS.
*
* @return string
*/
protected function prepare_query() {
global $wpdb;
$from = "FROM {$wpdb->prefix}lifterlms_quiz_attempts qa";
$joins = $this->sql_joins();
$where = $this->sql_where();
if ( $this->get( 'count_only' ) ) {
return "SELECT COUNT(*) AS total {$from} {$joins} {$where};";
}
if ( ! $this->get( 'no_found_rows' ) ) {
$this->count_query = "SELECT COUNT(*) {$from} {$joins} {$where}";
}
return "SELECT qa.id {$from} {$joins} {$where} {$this->sql_orderby()} {$this->sql_limit()};";
}
/**
* SQL "joins" clause for the query.
*
* @since 9.1.0
*
* @return string
*/
protected function sql_joins() {
global $wpdb;
$joins = '';
// Join users table for search functionality
if ( $this->get( 'search' ) ) {
$joins .= " LEFT JOIN {$wpdb->users} u ON qa.student_id = u.ID";
$joins .= " LEFT JOIN {$wpdb->usermeta} um_first ON u.ID = um_first.user_id AND um_first.meta_key = 'first_name'";
$joins .= " LEFT JOIN {$wpdb->usermeta} um_last ON u.ID = um_last.user_id AND um_last.meta_key = 'last_name'";
// Add in posts of type llms_quiz for search functionality
$joins .= " LEFT JOIN {$wpdb->posts} p ON qa.quiz_id = p.ID AND p.post_type = 'llms_quiz'";
}
return $joins;
}
/**
* SQL "where" clause for the query.
*
* @since 3.16.0
* @since 3.35.0 Better SQL preparation.
* @since 4.2.0 Added `exclude` arg logic.
* @since 7.8.0 Added `can_be_resumed` arg logic.
*
* @return string
*/
protected function sql_where() {
global $wpdb;
$sql = 'WHERE 1';
foreach ( array( 'quiz_id', 'student_id' ) as $key ) {
$ids = $this->get( $key );
if ( $ids ) {
$prepared = implode( ',', $ids );
$sql .= " AND qa.{$key} IN ({$prepared})";
}
}
// Add attempt lookup.
$val = $this->get( 'attempt' );
if ( '' !== $val ) {
$sql .= $wpdb->prepare( ' AND qa.attempt = %d', $val );
}
// Add attempt exclude.
$exclude = $this->get( 'exclude' );
if ( $exclude ) {
$prepared = implode( ',', $exclude );
$sql .= " AND qa.id NOT IN ({$prepared})";
}
$status = $this->get( 'status' );
if ( $status ) {
$prepared = implode( ',', array_map( array( $this, 'escape_and_quote_string' ), $status ) );
$sql .= " AND qa.status IN ({$prepared})";
}
$status_exclude = $this->get( 'status_exclude' );
if ( $status_exclude ) {
$prepared = implode( ',', array_map( array( $this, 'escape_and_quote_string' ), $status_exclude ) );
$sql .= " AND qa.status NOT IN ({$prepared})";
}
$can_be_resumed = $this->get( 'can_be_resumed' );
if ( '' !== $can_be_resumed ) {
$sql .= $wpdb->prepare( ' AND qa.can_be_resumed = %d', $can_be_resumed );
}
$search = $this->get( 'search' );
if ( $search ) {
$search = $wpdb->esc_like( $search );
$sql .= $wpdb->prepare(
' AND (
u.user_login LIKE %s
OR u.user_email LIKE %s
OR u.display_name LIKE %s
OR um_first.meta_value LIKE %s
OR um_last.meta_value LIKE %s
OR p.post_title LIKE %s
)',
'%' . $search . '%',
'%' . $search . '%',
'%' . $search . '%',
'%' . $search . '%',
'%' . $search . '%',
'%' . $search . '%'
);
}
return apply_filters( $this->get_filter( 'where' ), $sql, $this );
}
}
================================================
FILE: includes/class.llms.query.user.postmeta.php
================================================
<?php
/**
* LifterLMS User Postmeta Query
*
* @package LifterLMS/Classes
*
* @since 3.15.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS User Postmeta Query
*
* @since 3.15.0
*/
class LLMS_Query_User_Postmeta extends LLMS_Database_Query {
/**
* Identify the extending query
*
* @var string
*/
protected $id = 'user_postmeta';
/**
* Retrieve default arguments for a student query
*
* @return array
* @since 3.15.0
* @version 3.15.0
*/
protected function get_default_args() {
$args = array(
'include_post_children' => true,
'query' => array(),
'query_compare' => 'OR',
'post_id' => array(),
'sort' => array(
'updated_date' => 'DESC',
'meta_id' => 'ASC',
),
'types' => array(),
'user_id' => array(),
);
$args = wp_parse_args( $args, parent::get_default_args() );
return apply_filters( $this->get_filter( 'default_args' ), $args );
}
/**
* Retrieve an array of LLMS_User_Postmetas for the given set of results
*
* @return array
* @since 3.15.0
* @version 3.15.0
*/
public function get_metas() {
$metas = array();
$results = $this->get_results();
if ( $results ) {
foreach ( $results as $result ) {
$metas[] = new LLMS_User_Postmeta( $result->meta_id );
}
}
if ( $this->get( 'suppress_filters' ) ) {
return $metas;
}
return apply_filters( $this->get_filter( 'get_metas' ), $metas );
}
/**
* Parses data passed to $statuses
* Convert strings to array and ensure resulting array contains only valid statuses
* If no valid statuses, returns to the default
*
* @return void
* @since 3.15.0
* @since 7.5.0 Added 'Favorites' event.
*/
protected function parse_args() {
// Sanitize post & user ids.
foreach ( array( 'post_id', 'user_id' ) as $key ) {
$this->arguments[ $key ] = $this->sanitize_id_array( $this->arguments[ $key ] );
}
if ( $this->arguments['include_post_children'] ) {
foreach ( $this->arguments['post_id'] as $id ) {
if ( 'course' !== get_post_type( $id ) ) {
continue;
}
$course = llms_get_post( $id );
$this->arguments['post_id'] = array_merge(
$this->arguments['post_id'],
$this->sanitize_id_array( $course->get_sections( 'ids' ) ),
$this->sanitize_id_array( $course->get_lessons( 'ids' ) ),
$this->sanitize_id_array( $course->get_quizzes() )
);
}
}
if ( $this->arguments['types'] ) {
$all_events = array(
'completion' => array(
'key' => '_is_complete',
'value' => 'yes',
),
'status' => array(
'compare' => 'IS NOT NULL',
'key' => '_status',
),
'achievement' => array(
'compare' => 'IS NOT NULL',
'key' => '_achievement_earned',
),
'certificate' => array(
'compare' => 'IS NOT NULL',
'key' => '_certificate_earned',
),
'email' => array(
'compare' => 'IS NOT NULL',
'key' => '_email_sent',
),
'purchase' => array(
'compare' => 'LIKE',
'key' => '_enrollment_trigger',
'value' => 'order_%',
),
'favorites' => array(
'key' => '_favorite',
'compare' => 'IS NOT NULL',
),
);
if ( is_string( $this->arguments['types'] ) && 'all' === $this->arguments['types'] ) {
$this->arguments['query'] = array_values( $all_events );
} else {
$this->arguments['query'] = array();
if ( ! is_array( $this->arguments['types'] ) ) {
$this->arguments['types'] = array( $this->arguments['types'] );
}
foreach ( $this->arguments['types'] as $type ) {
if ( ! isset( $all_events[ $type ] ) ) {
continue;
}
$this->arguments['query'][] = $all_events[ $type ];
}
}
}
if ( $this->arguments['query'] ) {
foreach ( $this->arguments['query'] as $i => &$query ) {
// Ensure that each query has a compare operator.
$query = wp_parse_args(
$query,
array(
'compare' => '=',
'key' => '',
'value' => '',
)
);
$operators = array( '=', '!=', 'LIKE', 'IN', 'NOT IN', 'IS NOT NULL' );
if ( ! in_array( $query['compare'], $operators ) ) {
unset( $this->arguments['query'][ $i ] );
}
}
}
if ( ! in_array( $this->arguments['query_compare'], array( 'AND', 'OR' ) ) ) {
$this->arguments['query_compare'] = 'OR';
}
}
/**
* Prepare the SQL for the query.
*
* @since 3.15.0
* @since 6.0.0 Renamed from `preprare_query()`.
* @since 10.0.0 Build count_query from shared clauses instead of using SQL_CALC_FOUND_ROWS.
*
* @return string
*/
protected function prepare_query() {
global $wpdb;
$from = "FROM {$wpdb->prefix}lifterlms_user_postmeta";
$where = $this->sql_where();
if ( $this->get( 'count_only' ) ) {
return "SELECT COUNT(*) AS total {$from} {$where};";
}
if ( ! $this->get( 'no_found_rows' ) ) {
$this->count_query = "SELECT COUNT(*) {$from} {$where}";
}
$vars = array(
$this->get_skip(),
$this->get( 'per_page' ),
);
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$sql = $wpdb->prepare(
"SELECT meta_id
{$from}
{$where}
{$this->sql_orderby()}
LIMIT %d, %d;",
$vars
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $sql;
}
/**
* SQL "where" clause for the query
*
* @return string
* @since 3.15.0
* @version 3.15.0
*/
protected function sql_where() {
global $wpdb;
$sql = 'WHERE 1';
foreach ( array( 'post_id', 'user_id' ) as $key ) {
$ids = $this->get( $key );
if ( $ids ) {
$prepared = implode( ',', $ids );
$sql .= " AND {$key} IN ({$prepared})";
}
}
if ( $this->get( 'query' ) ) {
$sql .= ' AND ( ';
foreach ( $this->get( 'query' ) as $i => $query ) {
if ( 0 !== $i ) {
$sql .= " {$this->get( 'query_compare' )} ";
}
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
switch ( $query['compare'] ) {
case '=':
case '!=':
case 'LIKE':
$sql .= $wpdb->prepare( "( meta_key = %s AND meta_value {$query['compare']} %s )", $query['key'], $query['value'] );
break;
case 'IN':
case 'NOT IN':
$query['value'] = array_map( array( $this, 'escape_and_quote_string' ), $query['value'] );
$vals = implode( ',', $query['value'] );
$sql .= $wpdb->prepare( "( meta_key = %s AND meta_value {$query['compare']} ( {$vals} ) )", $query['key'] );
break;
case 'IS NOT NULL':
$sql .= $wpdb->prepare( "( meta_key = %s AND meta_value {$query['compare']} )", $query['key'] );
break;
}
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
$sql .= ' )';
}
return apply_filters( $this->get_filter( 'where' ), $sql, $this );
}
}
================================================
FILE: includes/class.llms.question.manager.php
================================================
<?php
/**
* LifterLMS Quiz Question Manager
*
* Don't instantiate this directly, instead use the wrapper functions
* found in the LLMS_Quiz and LLMS_Question classes
*
* @package LifterLMS/Classes
*
* @since 3.16.0
* @version 3.27.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Question_Manager class.
*
* @since 3.16.0
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Question_Manager {
/**
* @var LLMS_Question|LLMS_Quiz
* @since 3.16.0
*/
public $parent;
/**
* Constructor
*
* @param obj $parent instance of the parent LLMS_Quiz or LLMS_Question
* @since 3.16.0
* @version 3.16.0
*/
public function __construct( $parent ) {
$this->parent = $parent;
}
/**
* Quick access to the parent attribute
*
* @return [type]
* @since 3.16.0
* @version 3.16.0
*/
private function get_parent() {
return $this->parent;
}
/**
* Quick access to parents type property
*
* @return string [llms_quiz|llms_question]
* @since 3.16.0
* @version 3.16.0
*/
private function get_parent_type() {
return $this->parent->get( 'type' );
}
/**
* Retrieve the related LLMS_Quiz
*
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
private function get_quiz() {
if ( 'llms_quiz' === $this->get_parent_type() ) {
return $this->parent;
}
return $this->parent->get_quiz();
}
/**
* Create a new question and add it to the quiz
*
* @param array $data array of question data
* @return false|question id
* @since 3.16.0
* @version 3.16.0
*/
public function create_question( $data = array() ) {
// Ensure the question belongs to this quiz.
$data['parent_id'] = $this->get_parent()->get( 'id' );
$question = new LLMS_Question( 'new', $data );
if ( $question->get( 'id' ) ) {
return $question->get( 'id' );
}
return false;
}
/**
* Delete a question associated with this quiz
* skips trash and force deletes the question
*
* @param int $id WP Post ID of a question (must be associated with this quiz)
* @return boolean true = deleted, false = error
* @since 3.16.0
* @version 3.16.0
*/
public function delete_question( $id ) {
$question = $this->get_question( $id );
if ( ! $question ) {
return false;
}
// Error.
if ( ! wp_delete_post( $id, true ) ) {
return false;
}
// Deleted.
return true;
}
/**
* Retrieve a question associated with this quiz by question ID
*
* @param int $id WP Post ID of the question
* @return boolean
* @since 3.16.0
* @version 3.27.0
*/
public function get_question( $id ) {
$question = llms_get_post( $id );
// Not valid question, return false.
if ( empty( $question ) || ! is_a( $question, 'LLMS_Question' ) ) {
return false;
}
$parent_id = $question->get( 'parent_id' );
// When parent id is set, only retrieve questions attached to this parent.
if ( $parent_id && $parent_id !== $this->get_parent()->get( 'id' ) ) {
if ( 'llms_question' === $this->get_parent_type() && $this->get_quiz()->get( 'id' ) === $question->get_quiz()->get( 'id' ) ) {
return $question;
}
return false;
}
// Success.
return $question;
}
/**
* Get questions
*
* @param string $return type of return [ids|posts|questions]
* @return array
* @since 3.3.0
* @version 3.24.0
*/
public function get_questions( $return = 'questions' ) {
$query = new WP_Query(
array(
'meta_query' => array(
array(
'key' => '_llms_parent_id',
'value' => $this->get_parent()->get( 'id' ),
),
),
'order' => 'ASC',
'orderby' => 'menu_order',
'post_status' => 'publish',
'post_type' => 'llms_question',
'posts_per_page' => 500,
)
);
if ( 'ids' === $return ) {
$ret = wp_list_pluck( $query->posts, 'ID' );
} elseif ( 'posts' === $return ) {
$ret = $query->posts;
} else {
$ret = array();
foreach ( $query->posts as $post ) {
$ret[] = new LLMS_Question( $post );
}
}
return apply_filters( 'llms_quiz_get_questions', $ret, $this, $return );
}
/**
* Create or update questions
* If 'id' passed in $data array will update existing question
* Omit 'id' to create a new question
*
* @param array $data array of question data
* @return false|question id
* @since 3.16.0
* @version 3.17.2
*/
public function update_question( $data = array() ) {
// If there's no ID, we'll add a new question.
if ( ! isset( $data['id'] ) ) {
return $this->create_question( $data );
}
// Get the question.
$question = $this->get_question( $data['id'] );
if ( ! $question ) {
return false;
}
// Update all submitted data.
foreach ( $data as $key => $val ) {
// Merge image data into the array.
if ( 'image' === $key ) {
$val = array_merge(
array(
'enabled' => 'no',
'id' => '',
'src' => '',
),
$question->get( $key ),
$val
);
}
$question->set( $key, $val );
}
// Return question ID.
return $question->get( 'id' );
}
}
================================================
FILE: includes/class.llms.question.types.php
================================================
<?php
/**
* LifterLMS Question Types
*
* @package LifterLMS/Classes
*
* @since 3.16.0
* @version 3.30.3
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Question_Types class.
*
* @since 3.16.0
* @since 3.30.3 Fixed typo.
*/
class LLMS_Question_Types {
/**
* Initializer
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
public static function init() {
add_filter( 'llms_get_question_types', array( __CLASS__, 'load' ), 5 );
}
/**
* Retrieve question type model defaults
*
* @since 3.16.0
* @since 3.30.3 Fixed typo in icon name.
*
* @return array
*/
public static function get_model() {
return apply_filters(
'llms_question_type_model_defaults',
array(
'choices' => array(
'selectable' => true,
'markers' => range( 'A', 'Z' ),
'max' => 26,
'min' => 2,
'multi' => true,
'type' => 'text',
),
'clarifications' => true,
'description' => true,
'default_choices' => array(),
'grading' => 'auto',
'group' => array(
'order' => 20,
'name' => __( 'Other', 'lifterlms' ),
),
'icon' => 'question-circle',
'id' => 'generic',
'image' => true,
'name' => esc_html__( 'Question', 'lifterlms' ),
'placeholder' => esc_attr__( 'Enter your question...', 'lifterlms' ),
'points' => true,
'random_lock' => false,
'video' => true,
)
);
}
/**
* Retrieve all the default question types loaded by the LifterLMS core
*
* @return array
* @since 3.16.0
* @version 3.27.0
*/
private static function get_types() {
$upgrade_url = 'https://lifterlms.com/product/advanced-quizzes/?utm_source=LifterLMS%20Plugin&utm_medium=Quiz%20Builder%20Button&utm_campaign=Advanced%20Question%20Upsell&utm_content=3.16.0&utm_term=';
return array(
'choice' => array(
'choices' => array(),
'group' => array(
'order' => 0,
'name' => __( 'Basic Questions', 'lifterlms' ),
),
'icon' => 'check',
'id' => 'choice',
'name' => esc_html__( 'Multiple Choice', 'lifterlms' ),
),
'picture_choice' => array(
'choices' => array(
'type' => 'image',
),
'group' => array(
'order' => 0,
'name' => __( 'Basic Questions', 'lifterlms' ),
),
'icon' => 'picture-o',
'id' => 'picture_choice',
'name' => esc_html__( 'Picture Choice', 'lifterlms' ),
),
'true_false' => array(
'choices' => array(
'max' => 2,
'min' => 2,
'multi' => false,
),
'default_choices' => array(
array(
'choice' => esc_html__( 'True', 'lifterlms' ),
'correct' => true,
'marker' => 'A',
),
array(
'choice' => esc_html__( 'False', 'lifterlms' ),
'marker' => 'B',
),
),
'group' => array(
'order' => 0,
'name' => __( 'Basic Questions', 'lifterlms' ),
),
'icon' => 'toggle-on',
'id' => 'true_false',
'name' => esc_html__( 'True or False', 'lifterlms' ),
),
'content' => array(
'choices' => false,
'clarifications' => false,
'icon' => 'window-maximize',
'id' => 'content',
'grading' => false,
'name' => esc_html__( 'Content', 'lifterlms' ),
'placeholder' => esc_attr__( 'Enter your content title...', 'lifterlms' ),
'points' => false,
'random_lock' => true,
),
'existing' => array(
'choices' => false,
'clarifications' => false,
'icon' => 'file-text-o',
'id' => 'existing',
'grading' => false,
'name' => esc_html__( 'Add Existing Question', 'lifterlms' ),
'placeholder' => '',
'points' => false,
'random_lock' => true,
),
// 'group' => array(
// 'choices' => false,
// 'clarifications' => false,
// 'group' => array(
// 'order' => 0,
// 'name' => __( 'Basic Questions', 'lifterlms' )
// ),
// 'icon' => 'sitemap',
// 'id' => 'group',
// 'grading' => false,
// 'name' => esc_html__( 'Question Group', 'lifterlms' ),
// 'placeholder' => esc_attr__( 'Enter your group title...', 'lifterlms' ),
// ),
'blank' => array(
'choices' => false,
'group' => array(
'order' => 10,
'name' => __( 'Advanced Questions', 'lifterlms' ),
),
'icon' => 'window-minimize',
'id' => 'blank',
'name' => esc_html__( 'Fill in the Blank', 'lifterlms' ),
'upgrade' => $upgrade_url . 'blank',
),
'reorder' => array(
'choices' => false,
'group' => array(
'order' => 10,
'name' => __( 'Advanced Questions', 'lifterlms' ),
),
'icon' => 'sort-numeric-asc',
'id' => 'reorder',
'name' => esc_html__( 'Reorder Items', 'lifterlms' ),
'upgrade' => $upgrade_url . 'reorder',
),
'picture_reorder' => array(
'choices' => false,
'group' => array(
'order' => 10,
'name' => __( 'Advanced Questions', 'lifterlms' ),
),
'icon' => 'picture-o',
'id' => 'picture_reorder',
'name' => esc_html__( 'Reorder Pictures', 'lifterlms' ),
'upgrade' => $upgrade_url . 'picture_reorder',
),
'short_answer' => array(
'choices' => false,
'group' => array(
'order' => 10,
'name' => __( 'Advanced Questions', 'lifterlms' ),
),
'icon' => 'align-left',
'id' => 'short_answer',
'name' => esc_html__( 'Short Answer', 'lifterlms' ),
'upgrade' => $upgrade_url . 'short_answer',
),
'long_answer' => array(
'choices' => false,
'group' => array(
'order' => 10,
'name' => __( 'Advanced Questions', 'lifterlms' ),
),
'icon' => 'paragraph',
'id' => 'long_answer',
'name' => esc_html__( 'Long Answer', 'lifterlms' ),
'upgrade' => $upgrade_url . 'long_answer',
),
'upload' => array(
'choices' => false,
'group' => array(
'order' => 10,
'name' => __( 'Advanced Questions', 'lifterlms' ),
),
'icon' => 'cloud-upload',
'id' => 'upload',
'name' => esc_html__( 'File Upload', 'lifterlms' ),
'upgrade' => $upgrade_url . 'upload',
),
'code' => array(
'choices' => false,
'group' => array(
'order' => 10,
'name' => __( 'Advanced Questions', 'lifterlms' ),
),
'icon' => 'code',
'id' => 'code',
'name' => esc_html__( 'Code', 'lifterlms' ),
'upgrade' => $upgrade_url . 'code',
),
'scale' => array(
'choices' => false,
'group' => array(
'order' => 10,
'name' => __( 'Advanced Questions', 'lifterlms' ),
),
'icon' => 'sliders',
'id' => 'scale',
'name' => esc_html__( 'Scale', 'lifterlms' ),
'upgrade' => $upgrade_url . 'scale',
),
);
}
/**
* Load core question types
*
* @param array $questions array of question types (probably empty).
* @return void
* @since 3.16.0
* @version 3.16.0
*/
public static function load( $questions ) {
$model = self::get_model();
foreach ( self::get_types() as $id => $type ) {
if ( is_array( $type['choices'] ) ) {
$type['choices'] = wp_parse_args( $type['choices'], $model['choices'] );
}
$questions[ $id ] = wp_parse_args( $type, $model );
}
return $questions;
}
}
LLMS_Question_Types::init();
================================================
FILE: includes/class.llms.quiz.data.php
================================================
<?php
/**
* Query data about a quiz
*
* @package LifterLMS/Classes
*
* @since 3.16.0
* @version 7.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Query data about a quiz.
*
* @since 3.16.0
* @since 3.30.3 Explicitly define class properties.
* @since 3.31.0 Extends LLMS_Abstract_Post_Data.
* @since 4.0.0 Removed deprecated properties `$quiz` and `$quiz_id`.
*/
class LLMS_Quiz_Data extends LLMS_Abstract_Post_Data {
/**
* Post ID of the quiz
*
* @var int
*/
protected $quiz_id;
/**
* Post object of the quiz
*/
protected $quiz;
/**
* Constructor
*
* @since 3.16.0
*
* @param int $quiz_id WP Post ID of the quiz
*/
public function __construct( $quiz_id ) {
$this->quiz_id = $quiz_id;
$this->quiz = llms_get_post( $this->quiz_id );
parent::__construct( $quiz_id );
}
/**
* Retrieve # of quiz attempts within the period
*
* @since 3.16.0
*
* @param string $period date period [current|previous]
* @return int
*/
public function get_attempt_count( $period = 'current' ) {
global $wpdb;
return $wpdb->get_var(
$wpdb->prepare(
"
SELECT COUNT( id )
FROM {$wpdb->prefix}lifterlms_quiz_attempts
WHERE quiz_id = %d
AND update_date BETWEEN %s AND %s
",
$this->post_id,
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);
}
/**
* Retrieve avg grade of quiz attempts within the period
*
* @since 3.16.0
*
* @param string $period date period [current|previous]
* @return int
*/
public function get_average_grade( $period = 'current' ) {
global $wpdb;
$grade = $wpdb->get_var(
$wpdb->prepare(
"
SELECT ROUND( AVG( grade ), 3 )
FROM {$wpdb->prefix}lifterlms_quiz_attempts
WHERE quiz_id = %d
AND update_date BETWEEN %s AND %s
",
$this->post_id,
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);
return $grade ? $grade : 0;
}
/**
* Retrieve the number assignments with a given status
*
* @since 3.24.0
*
* @param string $status status name
* @param string $period date period [current|previous]
* @return int
*/
public function get_count_by_status( $status, $period = 'current' ) {
global $wpdb;
return $wpdb->get_var(
$wpdb->prepare(
"
SELECT COUNT( id )
FROM {$wpdb->prefix}lifterlms_quiz_attempts
WHERE quiz_id = %d
AND status = %s
AND update_date BETWEEN %s AND %s
",
$this->post_id,
$status,
$this->get_date( $period, 'start' ),
$this->get_date( $period, 'end' )
)
);
}
/**
* Retrieve # of quiz fails within the period.
*
* @since 3.16.0
*
* @param string $period Date period [current|previous].
* @return int
*/
public function get_fail_count( $period = 'current' ) {
return $this->get_count_by_status( 'fail', $period );
}
/**
* Retrieve # of quiz passes within the period.
*
* @since 3.16.0
*
* @param string $period Date period [current|previous].
* @return int
*/
public function get_pass_count( $period = 'current' ) {
return $this->get_count_by_status( 'pass', $period );
}
/**
* Retrieve recent LLMS_User_Postmeta for the quiz.
* This overrides the LLMS_Abstract_Post_Data method.
*
* @since 3.16.0
*
* @return array
*/
public function recent_events( $args = array() ) {
$query_args = wp_parse_args(
$args,
array(
'types' => array(),
)
);
return parent::recent_events( $query_args );
}
}
================================================
FILE: includes/class.llms.review.php
================================================
<?php
/**
* LifterLMS Course reviews
*
* This class handles the front end of the reviews. It is responsible
* for outputting the HTML on the course page (if reviews are activated).
*
* @package LifterLMS/Classes
*
* @since 1.2.7
* @version 7.1.3
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Reviews class
*
* @since 1.2.7
*/
class LLMS_Reviews {
/**
* This is the constructor for this class.
*
* It takes care of attaching the functions in this file to the
* appropriate actions.
* These actions are:
* 1) Output after course info.
* 2) Output after membership info.
* 3 & 4) Add function call to the proper AJAX call.
*
* @since 3.1.3
*
* @return void
*/
public function __construct() {
add_action( 'wp_ajax_LLMSSubmitReview', array( $this, 'process_review' ) );
add_action( 'wp_ajax_nopriv_LLMSSubmitReview', array( $this, 'process_review' ) );
}
/**
* This function handles the HTML output of the reviews and review form.
* If the option is enabled, the review form will be output,
* if not, nothing will happen. This function also checks to
* see if a user is allowed to review more than once.
*
* @since 1.2.7
* @since 3.24.0 Unknown.
* @since 7.1.3 Improve inline styles, escape output.
*
* @return void
*/
public static function output() {
/**
* Check to see if we are supposed to output the code at all.
*/
if ( get_post_meta( get_the_ID(), '_llms_display_reviews', true ) ) {
/**
* Filters the reviews section title.
*
* @since 1.2.7
*
* @param string $section_title The section title.
*/
$section_title = apply_filters( 'lifterlms_reviews_section_title', __( 'What Others Have Said', 'lifterlms' ) );
?>
<div id="old_reviews">
<h3><?php echo esc_html( $section_title ); ?></h3>
<?php
$args = array(
'posts_per_page' => get_post_meta( get_the_ID(), '_llms_num_reviews', true ),
'post_type' => 'llms_review',
'post_status' => 'publish',
'post_parent' => get_the_ID(),
'suppress_filters' => true,
);
$posts_array = get_posts( $args );
/**
* Allow review custom styles to be filtered.
*
* @since 1.2.7
*
* @param array $styles Array of custom styles.
*/
$styles = apply_filters(
'llms_review_custom_styles',
array(
'background-color' => '#efefef',
'title-color' => 'inherit',
'text-color' => 'inherit',
'custom-css' => '',
)
);
$inline_styles = '';
if ( $styles['background-color'] ?? '' ) {
$inline_styles .= '.llms_review{background-color:' . $styles['background-color'] . '}';
}
if ( $styles['title-color'] ?? '' ) {
$inline_styles .= '.llms_review h5{color:' . $styles['title-color'] . '}';
}
if ( $styles['text-color'] ?? '' ) {
$inline_styles .= '.llms_review h6,.llms_review p{color:' . $styles['text-color'] . '}';
}
if ( $styles['custom-css'] ?? '' ) {
// Remove style tags in case they were added with the filter.
$inline_styles .= str_replace( array( '<style>', '</style>' ), '', $styles['custom-css'] );
}
if ( $inline_styles ) {
echo '<style id="llms_review_custom_styles">' . esc_html( $inline_styles ) . '</style>';
}
foreach ( $posts_array as $post ) {
?>
<div class="llms_review">
<div class="llms_review_title"><strong><?php echo esc_html( get_the_title( $post->ID ) ); ?></strong></div>
<div class="llms_review_name">
<?php
// Translators: %s = The author display name.
echo esc_html( sprintf( __( 'By: %s', 'lifterlms' ), get_the_author_meta( 'display_name', get_post_field( 'post_author', $post->ID ) ) ) );
?>
</div>
<p><?php echo esc_html( get_post_field( 'post_content', $post->ID ) ); ?></p>
</div>
<?php
}
?>
<hr>
</div>
<?php
}
/**
* Check to see if reviews are open.
*/
if ( get_post_meta( get_the_ID(), '_llms_reviews_enabled', true ) && is_user_logged_in() ) {
/**
* Filters the thank you text.
*
* @since 1.2.7
*
* @param string $thank_you_text The thank you text.
*/
$thank_you_text = apply_filters( 'llms_review_thank_you_text', __( 'Thank you for your review!', 'lifterlms' ) );
if ( ! self::current_user_can_write_review( get_the_ID() ) ) {
?>
<div id="thank_you_box">
<div><?php echo esc_html( $thank_you_text ); ?></div>
</div>
<?php
} else {
?>
<div class="review_box" id="review_box">
<h3><?php esc_html_e( 'Write a Review', 'lifterlms' ); ?></h3>
<!--<form method="post" name="review_form" id="review_form">-->
<label for="review_title">
<?php esc_html_e( 'Review Title', 'lifterlms' ); ?>
</label>
<input type="text" name="review_title" id="review_title">
<div class="review_error" id="review_title_error"><?php esc_html_e( 'Review Title is required.', 'lifterlms' ); ?></div>
<label for="review_text">
<?php esc_html_e( 'Review Text', 'lifterlms' ); ?>
</label>
<textarea name="review_text" id="review_text"></textarea>
<div class="review_error" id="review_text_error"><?php esc_html_e( 'Review Text is required.', 'lifterlms' ); ?></div>
<input name="action" value="submit_review" type="hidden">
<input name="post_ID" value="<?php echo esc_attr( get_the_ID() ); ?>" type="hidden" id="post_ID">
<?php wp_nonce_field( 'llms-review', 'llms_review_nonce' ); ?>
<input type="submit" class="button" value="<?php esc_attr_e( 'Leave Review', 'lifterlms' ); ?>" id="llms_review_submit_button">
<!--</form> -->
</div>
<div class="thank_you_box" id="thank_you_box">
<h2><?php echo esc_html( $thank_you_text ); ?></h2>
</div>
<?php
}
}
}
/**
* This function adds the review to the database. It is
* called by the AJAX handler when the submit review button
* is pressed. This function gathers the data from $_POST and
* then adds the review with the appropriate content.
*
* @since 1.2.7
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 7.5.2 Now checking if the user can write a review.
*
* @return void
*/
public function process_review() {
// Check the nonce.
if ( ! isset( $_POST['llms_review_nonce'] ) || ! wp_verify_nonce( sanitize_key( $_POST['llms_review_nonce'] ), 'llms-review' ) ) {
return;
}
$parent_id = llms_filter_input_sanitize_string( INPUT_POST, 'pageID' );
// Make sure the current user can write reviews yet.
if ( ! self::current_user_can_write_review( $parent_id ) ) {
return;
}
$post = array(
'post_content' => llms_filter_input_sanitize_string( INPUT_POST, 'review_text' ), // The full text of the post.
'post_name' => llms_filter_input_sanitize_string( INPUT_POST, 'review_title' ), // The name (slug) for your post.
'post_title' => llms_filter_input_sanitize_string( INPUT_POST, 'review_title' ), // The title of your post.
'post_status' => 'publish',
'post_type' => 'llms_review',
'post_parent' => $parent_id, // Sets the parent of the new post, if any. Default 0.
'post_excerpt' => llms_filter_input_sanitize_string( INPUT_POST, 'review_title' ),
);
$result = wp_insert_post( $post, true );
}
/**
* Check to see if we are allowed to write more than one review.
* If we are not, check to see if we have written a review already.
*
* @since 7.5.2
*
* @param int $parent_id The ID of the parent post.
* @return bool True if the user can write a review, false if not.
*/
public static function current_user_can_write_review( $parent_id ) {
// Make sure the user is logged in.
if ( ! is_user_logged_in() ) {
return false;
}
// Make sure we have a post ID to check.
if ( empty( $parent_id ) ) {
return false;
}
// Check if reviews are disabled.
if ( ! get_post_meta( $parent_id, '_llms_reviews_enabled', true ) ) {
return false;
}
// Check if reviews are limited and the user has already written a review.
$args = array(
'posts_per_page' => 1,
'post_type' => 'llms_review',
'post_status' => 'publish',
'post_parent' => $parent_id,
'author' => get_current_user_id(),
'suppress_filters' => true,
);
$posts_array = get_posts( $args );
if ( get_post_meta( $parent_id, '_llms_multiple_reviews_disabled', true ) && $posts_array ) {
return false;
}
// If we got here, we can write a review.
return true;
}
}
return new LLMS_Reviews();
================================================
FILE: includes/class.llms.roles.php
================================================
<?php
/**
* LLMS_Roles class.
*
* @package LifterLMS/Classes
*
* @since 3.13.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Custom Roles and Capabilities.
*
* @since 3.13.0
*/
class LLMS_Roles {
/**
* The capability name to manage earned engagament.
*
* @since 6.0.0
*
* @var string
*/
const MANAGE_EARNED_ENGAGEMENT_CAP = 'manage_earned_engagement';
/**
* Retrieve an array of all capabilities for a role
*
* @since 3.13.0
*
* @param string $role Name of the role.
* @return array
*/
private static function get_all_caps( $role ) {
$caps = array();
$caps['core'] = self::get_core_caps( $role );
$caps['wp'] = self::get_wp_caps( $role );
$caps = array_merge( $caps, self::get_post_type_caps( $role ) );
return apply_filters( 'llms_get_all_' . $role . '_caps', $caps );
}
/**
* Get an array of registered core lifterlms caps.
*
* @since 3.13.0
* @since 3.14.0 Add the `lifterlms_instructor` capability.
* @since 3.34.0 Added capabilities for student management.
* @since 4.21.2 Added the `view_grades` capability.
* @since 6.0.0 Added `manage_earned_engagement` capability.
*
* @link https://lifterlms.com/docs/roles-and-capabilities/
*
* @return string[]
*/
public static function get_all_core_caps() {
/**
* Filters the list of available LifterLMS core user capabilities
*
* @since 3.13.0
*
* @param string[] $capabilities List of LifterLMS user capabilities.
*/
return apply_filters(
'llms_get_all_core_caps',
array(
'lifterlms_instructor',
'manage_lifterlms',
self::MANAGE_EARNED_ENGAGEMENT_CAP,
'view_lifterlms_reports',
'view_others_lifterlms_reports',
'enroll',
'unenroll',
'create_students',
'view_grades',
'view_students',
'view_others_students',
'edit_students',
'edit_others_students',
'delete_students',
'delete_others_students',
)
);
}
/**
* Retrieve the LifterLMS core capabilities for a give role
*
* @since 3.13.0
* @since 3.34.0 Added student management capabilities.
* @since 4.21.2 Added 'view_grades' to the list of instructor/assistant caps which are not automatically available.
* @since 6.0.0 Added `manage_earned_engagement` to the list of instructor/assistant caps which are not automatically available.
*
* @param string $role Name of the role.
* @return string[]
*/
private static function get_core_caps( $role ) {
$all_caps = array_fill_keys( array_values( self::get_all_core_caps() ), true );
switch ( $role ) {
case 'instructor':
case 'instructors_assistant':
$caps = $all_caps;
unset(
$caps['enroll'],
$caps['unenroll'],
$caps['manage_lifterlms'],
$caps[ self::MANAGE_EARNED_ENGAGEMENT_CAP ],
$caps['view_others_lifterlms_reports'],
$caps['create_students'],
$caps['view_others_students'],
$caps['edit_students'],
$caps['edit_others_students'],
$caps['delete_students'],
$caps['delete_others_students'],
$caps['view_grades']
);
break;
case 'administrator':
case 'lms_manager':
$caps = $all_caps;
break;
default:
$caps = array();
}
/**
* Filters the LifterLMS capabilities added to a LifterLMS user role.
*
* The dynamic portion of this hook `$role` refers to the user's role name.
*
* @since 4.21.2
*
* @param string[] $caps List of capabilities provided to the role.
* @param string[] $all_caps Full list of all LifterLMS user capabilities.
*/
return apply_filters( "llms_get_{$role}_core_caps", $caps, $all_caps );
}
/**
* Retrieve the post type specific capabilities for a give role.
*
* @since 3.13.0
* @since 4.21.2 Use strict comparisons for `in_array()`.
*
* @param string $role Name of the role
* @return array
*/
private static function get_post_type_caps( $role ) {
$caps = array();
// Students get nothing.
if ( 'student' !== $role ) {
$post_types = array(
'course' => 'course',
'lesson' => 'lesson',
'llms_quiz' => array( 'quiz', 'quizzes' ),
'llms_question' => 'question',
'llms_membership' => 'membership',
);
foreach ( $post_types as $post_type => $names ) {
$post_caps = LLMS_Post_Types::get_post_type_caps( $names );
// Filter the caps down for these roles.
if ( in_array( $role, array( 'instructor', 'instructors_assistant' ), true ) ) {
$allowed = array(
'instructor' => array(
'delete_posts',
'delete_published_posts',
'edit_post',
'edit_posts',
'edit_published_posts',
'publish_posts',
'create_posts',
),
'instructors_assistant' => array(
'edit_post',
'edit_posts',
'edit_published_posts',
),
);
foreach ( $post_caps as $post_cap => $cpt_cap ) {
if ( ! in_array( $post_cap, $allowed[ $role ], true ) ) {
unset( $post_caps[ $post_cap ] );
}
}
}
$caps[ $post_type ] = array_fill_keys( array_values( $post_caps ), true );
}
$taxes = array(
'course_cat' => 'course_cat',
'course_difficulty' => array( 'course_difficulty', 'course_difficulties' ),
'course_tag' => 'course_tag',
'course_track' => 'course_track',
'membership_cat' => 'membership_cat',
'membership_tag' => 'membership_tag',
);
foreach ( $taxes as $tax => $names ) {
$tax_caps = LLMS_Post_Types::get_tax_caps( $names );
// Filter the caps down for these roles.
if ( in_array( $role, array( 'instructor', 'instructors_assistant' ), true ) ) {
$allowed = array(
'assign_terms',
);
foreach ( $tax_caps as $tax_cap => $ct_cap ) {
if ( ! in_array( $tax_cap, $allowed, true ) ) {
unset( $tax_caps[ $tax_cap ] );
}
}
}
$caps[ $tax ] = array_fill_keys( array_values( $tax_caps ), true );
}
}
return apply_filters( 'llms_get_' . $role . '_post_type_caps', $caps );
}
/**
* Retrieve the core WP capabilities for a give role
*
* @since 3.13.0
* @since 3.34.0 Add the `list_users` capability to instructors.
*
* @param string $role Name of the role.
* @return array
*/
private static function get_wp_caps( $role ) {
$caps = array(
'read' => true,
);
switch ( $role ) {
case 'instructor':
$add = array(
'create_users' => true,
'edit_users' => true,
'promote_users' => true,
'list_users' => true,
'read' => true,
'upload_files' => true,
/**
* See WP Core issue(s)
*
* @link https://core.trac.wordpress.org/ticket/22895
* @link https://core.trac.wordpress.org/ticket/16808
*/
'edit_posts' => true,
);
break;
case 'instructors_assistant':
$add = array(
'read' => true,
'upload_files' => true,
/**
* See WP Core issue(s)
*
* @link https://core.trac.wordpress.org/ticket/22895
* @link https://core.trac.wordpress.org/ticket/16808
*/
'edit_posts' => true,
);
break;
case 'lms_manager':
$add = array(
'read_private_pages' => true,
'read_private_posts' => true,
'edit_posts' => true,
'edit_pages' => true,
'edit_published_posts' => true,
'edit_published_pages' => true,
'edit_private_pages' => true,
'edit_private_posts' => true,
'edit_others_posts' => true,
'edit_others_pages' => true,
'publish_posts' => true,
'publish_pages' => true,
'delete_posts' => true,
'delete_pages' => true,
'delete_private_pages' => true,
'delete_private_posts' => true,
'delete_published_pages' => true,
'delete_published_posts' => true,
'delete_others_posts' => true,
'delete_others_pages' => true,
'manage_categories' => true,
'manage_links' => true,
'moderate_comments' => true,
'upload_files' => true,
'export' => true,
'import' => true,
'edit_users' => true,
'create_users' => true,
'list_users' => true,
'promote_users' => true,
'delete_users' => true,
);
break;
default:
$add = array();
}
return apply_filters( 'llms_get_' . $role . '_wp_caps', array_merge( $add, $caps ) );
}
/**
* Retrieve LifterLMS roles and role names
*
* @since 3.13.0
*
* @return array
*/
public static function get_roles() {
return apply_filters(
'llms_get_roles',
array(
'lms_manager' => __( 'LMS Manager', 'lifterlms' ),
'instructor' => __( 'Instructor', 'lifterlms' ),
'instructors_assistant' => __( 'Instructor\'s Assistant', 'lifterlms' ),
'student' => __( 'Student', 'lifterlms' ),
)
);
}
/**
* Install custom roles and related capabilities
*
* Called from LLMS_Install during installation and upgrades.
*
* @since 3.13.0
*
* @return void
*/
public static function install() {
global $wp_roles;
if ( ! class_exists( 'WP_Roles' ) ) {
return;
}
$roles = self::get_roles();
$roles['administrator'] = __( 'Administrator', 'lifterlms' );
$wp_roles = wp_roles();
foreach ( $roles as $role => $name ) {
$role_obj = $wp_roles->get_role( $role );
if ( ! $role_obj ) {
$role_obj = $wp_roles->add_role( $role, $name );
}
self::update_caps( $role_obj, 'add' );
}
}
/**
* Uninstall custom roles and remove custom caps from default WP roles
*
* @since 3.13.0
*
* @return void
*/
public static function remove_roles() {
if ( ! class_exists( 'WP_Roles' ) ) {
return;
}
$wp_roles = wp_roles();
// Delete all our custom roles.
foreach ( array_keys( self::get_roles() ) as $role ) {
$wp_roles->remove_role( $role );
}
// Remove custom caps from the WP core admin role.
self::update_caps( $wp_roles->get_role( 'administrator' ), 'remove', array( 'wp' ) );
}
/**
* Update the capabilities for a given role
*
* @since 3.13.0
* @since 4.5.1 Added `$exclude_group` parameter that allows excluding groups of caps from the update.
*
* @param WP_Role $role Role object.
* @param string $type Update type [add|remove].
* @param string[] $exclude_groups Array of groups to exclude.
* @return void
*/
private static function update_caps( $role, $type = 'add', $exclude_groups = array() ) {
$role_caps = self::get_all_caps( $role->name );
$role_caps = empty( $exclude_groups ) ? $role_caps : array_diff_key( $role_caps, array_flip( $exclude_groups ) );
foreach ( $role_caps as $group => $caps ) {
foreach ( array_keys( $caps ) as $cap ) {
if ( 'add' === $type ) {
$role->add_cap( $cap );
} elseif ( 'remove' === $type ) {
$role->remove_cap( $cap );
}
}
}
}
/**
* Returns an array of role names.
*
* LLMS roles and WP core roles are translated.
*
* @since 5.6.0
*
* @return array
*/
public static function get_all_role_names() {
$all_roles = wp_roles()->roles;
return array_merge(
array_combine(
array_keys( $all_roles ),
array_map(
'translate_user_role', // Translates WP Core roles.
array_column( $all_roles, 'name' )
)
),
self::get_roles() // So our roles are translated as well.
);
}
}
================================================
FILE: includes/class.llms.session.php
================================================
<?php
/**
* LLMS_Session.
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 4.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Session class.
*
* @since 1.0.0
* @since 3.7.7 Unknown.
* @since 3.37.7 Added a second parameter to the `get()` method, that represents the default value
* to return if the session variable requested doesn't exist.
* @since 4.0.0 Major refactor to remove reliance on the wp-session-manager library:
* + Moved getters & setter methods into LLMS_Abstract_Session_Data
* + Added new methods to support built-in DB session management.
* + Deprecated legacy methods
* + Removed the ability to utilize PHP sessions.
* + Removed unused methods.
*/
class LLMS_Session extends LLMS_Abstract_Session_Database_Handler {
/**
* Session cookie name
*
* @var string
*/
protected $cookie = '';
/**
* Timestamp of the session's expiration
*
* @var int
*/
protected $expires;
/**
* Timestamp of when the session is nearing expiration
*
* @var int
*/
protected $expiring;
/**
* Constructor.
*
* @since 1.0.0
* @since 3.7.5 Unknown.
* @since 4.0.0 Removed PHP sessions.
* Added session auto-destroy on `wp_logout`.
*
* @return void
*/
public function __construct() {
/**
* Customize the name of the LifterLMS User Session Cookie
*
* @since 4.0.0
*
* @param string $name Default session cookie name.
*/
$this->cookie = apply_filters( 'llms_session_cookie_name', sprintf( 'wp_llms_session_%s', COOKIEHASH ) );
/**
* Trigger cleanup via action.
*
* This is hooked to an hourly scheduled task.
*/
add_action( 'llms_delete_expired_session_data', array( $this, 'clean' ) );
if ( $this->should_init() ) {
$this->init_cookie();
add_action( 'wp_logout', array( $this, 'destroy' ) );
add_action( 'shutdown', array( $this, 'maybe_save_data' ), 20 );
}
}
/**
* Destroys the current session
*
* Removes session data from the database, expires the cookie,
* and resets class variables.
*
* @since 4.0.0
*
* @return boolean
*/
public function destroy() {
// Delete from DB.
$this->delete( $this->get_id() );
// Reset class vars.
$this->id = '';
$this->data = array();
$this->is_clean = true;
// Destroy the cookie.
return llms_setcookie( $this->cookie, '', time() - YEAR_IN_SECONDS, COOKIEPATH ? COOKIEPATH : '/', COOKIE_DOMAIN, $this->use_secure_cookie(), true );
}
/**
* Retrieve an validate the session cookie
*
* @since 4.0.0
*
* @return false|mixed[]
*/
protected function get_cookie() {
$value = isset( $_COOKIE[ $this->cookie ] ) ? sanitize_text_field( wp_unslash( $_COOKIE[ $this->cookie ] ) ) : false;
if ( empty( $value ) || ! is_string( $value ) ) {
return false;
}
/**
* Explode the cookie into it's parts.
*
* @param string|int $0 User ID.
* @param int $1 Expiration timestamp.
* @param int $2 Expiration variance timestamp.
* @param string $3 Cookie hash.
*/
$parts = explode( '||', $value );
if ( empty( $parts[0] ) || empty( $parts[3] ) ) {
return false;
}
$hash_str = sprintf( '%1$s|%2$s', $parts[0], $parts[1] );
$expected = hash_hmac( 'md5', $hash_str, wp_hash( $hash_str ) );
if ( ! hash_equals( $expected, $parts[3] ) ) {
return false;
}
return $parts;
}
/**
* Initialize the session cookie
*
* Retrieves and validates the cookie,
* when there's a valid cookie it will initialize the object
* with data from the cookie. Otherwise it sets up and saves
* a new session and cookie.
*
* @since 4.0.0
*
* @return void
*/
protected function init_cookie() {
$cookie = $this->get_cookie();
$set_cookie = false;
if ( $cookie ) {
$this->id = $cookie[0];
$this->expires = $cookie[1];
$this->expiring = $cookie[2];
$this->data = $this->read( $this->id );
// If the user has logged in, update the session data.
$update_id = $this->maybe_update_id();
// If the session is nearing expiration, update the session.
$extend_expiration = $this->maybe_extend_expiration();
// If either of these two items are true, the cookie needs to be updated.
$set_cookie = $update_id || $extend_expiration;
} else {
$this->id = $this->generate_id();
$this->data = array();
$this->is_clean = false;
$set_cookie = true;
$this->set_expiration();
}
if ( $set_cookie ) {
$this->set_cookie();
}
}
/**
* Extend the sessions expiration when the session is nearing expiration
*
* If the user is still active on the site and the cookie is older than the
* "expiring" time but not yet expired, renew the session.
*
* @since 4.0.0
*
* @return boolean `true` if the expiration was extended, otherwise `false`.
*/
protected function maybe_extend_expiration() {
if ( time() > $this->expiring ) {
$this->set_expiration();
$this->is_clean = false;
return true;
}
return false;
}
/**
* Save session data if not clean
*
* Callback for `shutdown` action hook.
*
* @since 4.0.0
*
* @return boolean
*/
public function maybe_save_data() {
if ( ! $this->is_clean ) {
return $this->save( $this->expires );
}
return false;
}
/**
* Updates the session id when an anonymous visitor logs in.
*
* @since 4.0.0
*
* @return boolean `true` if the id was updated, otherwise `false`.
*/
protected function maybe_update_id() {
$uid = strval( get_current_user_id() );
if ( $uid && $uid !== $this->get_id() ) {
$old_id = $this->get_id();
$this->id = $uid;
$this->is_clean = false;
$this->delete( $old_id );
return true;
}
return false;
}
/**
* Determines if the cookie and related save/destroy handler actions should be initialized
*
* When doing CRON or when on the admin panel we don't want to load, otherwise we do.
*
* @since 4.0.0
*
* @return boolean
*/
protected function should_init() {
$init = ( defined( 'DOING_CRON' ) && DOING_CRON ) || ( is_admin() && ! wp_doing_ajax() ) ? false : true;
/**
* Filter whether or not session cookies and related hooks are initialized
*
* @since 4.0.0
*
* @param boolean $init Whether or not initialization should take place.
*/
return apply_filters( 'llms_session_should_init', $init );
}
/**
* Set the cookie
*
* @since 4.0.0
*
* @return boolean
*/
protected function set_cookie() {
$hash_str = sprintf( '%1$s|%2$s', $this->get_id(), $this->expires );
$hash = hash_hmac( 'md5', $hash_str, wp_hash( $hash_str ) );
$value = sprintf( '%1$s||%2$d||%3$d||%4$s', $this->get_id(), $this->expires, $this->expiring, $hash );
// There's no cookie set or the existing cookie needs to be updated.
if ( ! isset( $_COOKIE[ $this->cookie ] ) || $_COOKIE[ $this->cookie ] !== $value ) {
return llms_setcookie( $this->cookie, $value, $this->expires, COOKIEPATH ? COOKIEPATH : '/', COOKIE_DOMAIN, $this->use_secure_cookie(), true );
}
return false;
}
/**
* Set cookie expiration and expiring timestamps
*
* @since 4.0.0
*
* @return void
*/
protected function set_expiration() {
/**
* Filter the lifespan of user session data
*
* @since 4.0.0
*
* @param int $duration Lifespan of session data, in seconds.
*/
$duration = (int) apply_filters( 'llms_session_data_expiration_duration', HOUR_IN_SECONDS * 6 );
/**
* Filter the user session lifespan variance
*
* This is subtracted from the session cookie expiration to determine it's "expiring" timestamp.
*
* When an active session passes it's expiring timestamp but has not yet passed it's expiration timestamp
* the session data will be extended and the data session will not be destroyed.
*
* @since 4.0.0
*
* @param int $duration Lifespan of session data, in seconds.
*/
$variance = (int) apply_filters( 'llms_session_data_expiration_variance', HOUR_IN_SECONDS );
$this->expires = time() + $duration;
$this->expiring = $this->expires - $variance;
}
/**
* Determine if a secure cookie should be used.
*
* @since 4.0.0
*
* @return boolean
*/
protected function use_secure_cookie() {
$secure = llms_is_site_https() && is_ssl();
/**
* Determine whether or not a secure cookie should be used for user session data
*
* @since 4.0.0
*
* @param boolean $secure Whether or not a secure cookie should be used.
*/
return apply_filters( 'llms_session_use_secure_cookie', $secure );
}
}
================================================
FILE: includes/class.llms.sidebars.php
================================================
<?php
/**
* LifterLMS Sidebars
*
* @package LifterLMS/Classes
*
* @since 3.0.0
* @version 3.0.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Sidebars
*
* @since 3.0.0
*/
class LLMS_Sidebars {
/**
* Static Constructor
*
* @since 3.0.0
*/
public static function init() {
// Replaces sidebars with course & lesson sidebars.
add_filter( 'sidebars_widgets', array( __CLASS__, 'replace_default_sidebars' ) );
// Registers llms core sidebars.
add_action( 'widgets_init', array( __CLASS__, 'register_sidebars' ), 5 );
// Custom actions for genesis.
add_action( 'genesis_init', array( __CLASS__, 'genesis_support' ) );
}
/**
* Output course sidebar
*
* @since 3.0.0
*
* @return void
*/
public static function do_course_sidebar() {
if ( is_active_sidebar( 'llms_course_widgets_side' ) ) {
dynamic_sidebar( 'llms_course_widgets_side' );
}
}
/**
* Output lesson sidebar
*
* @since 3.0.0
*
* @return void
*/
public static function do_lesson_sidebar() {
if ( is_active_sidebar( 'llms_lesson_widgets_side' ) ) {
dynamic_sidebar( 'llms_lesson_widgets_side' );
}
}
/**
* Get the theme default sidebar that will be replaced by course and lesson sidebars
*
* @since 3.0.0
* @since 3.0.1 Unknown.
*
* @return string
*/
private static function get_theme_default_sidebar() {
$theme = get_option( 'template' );
switch ( $theme ) {
case 'canvas':
$id = 'primary';
break;
case 'Divi':
case 'twentyeleven':
case 'twentyfifteen':
case 'twentyfourteen':
case 'twentyseventeen':
case 'twentysixteen':
case 'twentytwelve':
$id = 'sidebar-1';
break;
case 'twentythirteen':
$id = 'sidebar-2';
break;
case 'twentyten':
$id = 'primary-widget-area';
break;
default:
$id = '';
}
return apply_filters( 'llms_get_theme_default_sidebar', $id, $theme );
}
/**
* Custom static constructor that modifies methods for native genesis sidebar compatibility
*
* @since 3.0.0
*
* @return void
*/
public static function genesis_support() {
// Remove default registration in favor of genesis registration methods.
remove_action( 'widgets_init', array( __CLASS__, 'register_sidebars' ), 5 );
// Add genesis registration method.
add_action( 'widgets_init', array( __CLASS__, 'genesis_register_sidebars' ), 5 );
// Replace primary genesis sidebar with our course / lesson sidebar.
add_action( 'genesis_before_sidebar_widget_area', array( __CLASS__, 'genesis_do_sidebar' ) );
// Genesis uses it's own reg method so we can send an empty array of settings.
add_filter( 'llms_sidebar_settings', '__return_empty_array' );
}
/**
* Outputs llms sidebars in place of the default Genesis Primary Sidebar
* Removes the default sidebar action and calls the respective output method
* from this class instead
*
* @since 3.0.0
*
* @return void
*/
public static function genesis_do_sidebar() {
$post_type = get_post_type();
if ( in_array( $post_type, array( 'course', 'lesson' ) ) ) {
remove_action( 'genesis_sidebar', 'genesis_do_sidebar' );
$method = 'do_' . $post_type . '_sidebar';
if ( method_exists( __CLASS__, $method ) ) {
add_action( 'genesis_sidebar', array( __CLASS__, $method ) );
}
}
}
/**
* Register LifterLMS Sidebars using genesis methods
*
* @since 3.0.0
*
* @return void
*/
public static function genesis_register_sidebars() {
$sidebars = self::get_sidebars();
foreach ( $sidebars as $sidebar ) {
genesis_register_sidebar( $sidebar );
}
}
/**
* Get a filtered array of sidebars to register
*
* @since 3.0.0
*
* @return array
*/
public static function get_sidebars() {
$sidebars = array(
apply_filters(
'lifterlms_register_lesson_sidebar',
array(
'id' => 'llms_course_widgets_side',
'description' => __( 'Widgets in this area will be shown on LifterLMS courses.', 'lifterlms' ),
'name' => __( 'Course Sidebar', 'lifterlms' ),
)
),
apply_filters(
'lifterlms_register_course_sidebar',
array(
'description' => __( 'Widgets in this area will be shown on LifterLMS lessons.', 'lifterlms' ),
'id' => 'llms_lesson_widgets_side',
'name' => __( 'Lesson Sidebar', 'lifterlms' ),
)
),
);
$settings = apply_filters(
'llms_sidebar_settings',
array(
'before_widget' => '<li id="%1$s" class="widget %2$s">',
'after_widget' => '</li>',
'before_title' => '<h2 class="widgettitle">',
'after_title' => '</h2>',
)
);
foreach ( $sidebars as &$s ) {
$s = array_merge( $settings, $s );
}
return $sidebars;
}
/**
* Registers all sidebars
*
* @since 3.0.0
*
* @return void
*/
public static function register_sidebars() {
$sidebars = self::get_sidebars();
foreach ( $sidebars as $sidebar ) {
register_sidebar( $sidebar );
}
}
/**
* Replaces existing sidebars with Course / Lesson sidebar widgets for supporting themes
*
* @since 1.0.0
* @since 3.0.0 Unknown.
*
* @param array $widgets array of sidebars and their widgets
* @return array
*/
public static function replace_default_sidebars( $widgets ) {
if ( is_singular( 'course' ) || is_singular( 'lesson' ) ) {
$sidebar_id = self::get_theme_default_sidebar();
if ( $sidebar_id ) {
if ( is_singular( 'course' ) && array_key_exists( 'llms_course_widgets_side', $widgets ) ) {
$widgets[ $sidebar_id ] = $widgets['llms_course_widgets_side'];
} elseif ( is_singular( 'lesson' ) && array_key_exists( 'llms_lesson_widgets_side', $widgets ) ) {
$widgets[ $sidebar_id ] = $widgets['llms_lesson_widgets_side'];
}
}
}
return $widgets;
}
}
LLMS_Sidebars::init();
================================================
FILE: includes/class.llms.site.php
================================================
<?php
/**
* LifterLMS Site Information.
*
* Handle Site switching to prevent recurring payment duplicates
* when using stating sites
*
* Heavily inspired by WC Subscriptions. Thank you!
*
* @package LifterLMS/Classes
*
* @since 3.0.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Site class.
*
* @since 3.0.0
*/
class LLMS_Site {
/**
* String part used to encrypt and decrypt the lock url.
*
* @var string
*/
public static $lock_string = '_[llms_site_url]_';
/**
* Clears the value of the lock URL
*
* @since 3.0.0
*
* @return void
*/
public static function clear_lock_url() {
update_option( 'llms_site_url', '' );
}
/**
* Check if the site is cloned and not ignored
*
* @since 4.12.0
* @since 4.13.0 Reverse the order of checks in the `if` statements for a minor performance improvement
* when the `LLMS_SITE_IS_CLONE` constant is being used.
*
* @return boolean Returns `true` when a clone is detected, otherwise `false`.
*/
public static function check_status() {
if ( self::is_clone() && ! self::is_clone_ignored() ) {
/**
* Action triggered when the current website is determined to be a "cloned" site
*
* @since 3.7.4
* @since 4.12.0 Moved from LLMS_Admin_Notices_Core::check_staging().
*/
do_action( 'llms_site_clone_detected' );
return true;
}
return false;
}
/**
* Get the lock url for the current site.
*
* Gets the WP site url and inserts the lock string into the (approximate) middle of the url.
*
* @since 3.0.0
* @since 5.9.0 Pass an explicit integer to `substr_replace()`.
*
* @return string
*/
public static function get_lock_url() {
$site_url = get_site_url();
return substr_replace( $site_url, self::$lock_string, intval( strlen( $site_url ) / 2 ), 0 );
}
/**
* Stores the current site's lock url into the database
*
* @since 3.0.0
*
* @return void
*/
public static function set_lock_url() {
update_option( 'llms_site_url', self::get_lock_url() );
}
/**
* Gets the stored url and cleans it for comparisons
*
* @since 3.0.0
*
* @return string
*/
public static function get_url() {
$url = get_option( 'llms_site_url' );
// Remove the lock string before returning it.
$url = str_replace( self::$lock_string, '', $url );
$url = set_url_scheme( $url );
/**
* Filters the stored LLMS_Site URL
*
* @since 3.0.0
*
* @param string $url The cleaned LLMS_Site URL.
*/
return apply_filters( 'llms_site_get_url', $url );
}
/**
* Get a single feature's status
*
* Checks for a feature constant first and, if none is defined,
* uses the stored site setting (with a fallback to the default value), and
* a final fallback to `false` if the feature cannot be found.
*
* @since 3.0.0
* @since 4.12.0 Allow feature configuration via constants.
*
* @param string $feature Feature id/key.
* @return bool
*/
public static function get_feature( $feature ) {
$status = self::get_feature_constant( $feature );
if ( is_null( $status ) ) {
$features = self::get_features();
$status = isset( $features[ $feature ] ) ? $features[ $feature ] : false;
}
/**
* Filters the status of a LLMS_Site feature.
*
* @since 4.12.0
*
* @param boolean $status Status of the feature.
* @param string $feature The feature ID/key.
*/
return apply_filters( 'llms_site_get_feature', $status, $feature );
}
/**
* Retrieve a constant value for a site feature
*
* This allows site features to be explicitly enabled or disabled
* in a wp-config.php file.
*
* @since 4.12.0
*
* @param string $feature Feature id/key.
* @return bool
*/
protected static function get_feature_constant( $feature ) {
$constant = sprintf( 'LLMS_SITE_FEATURE_%s', strtoupper( $feature ) );
if ( defined( $constant ) ) {
return constant( $constant );
}
return null;
}
/**
* Get a list of automated features
*
* These features are features that should be disabled
* in testing or staging environments.
*
* @since 3.0.0
*
* @return array An associative array of site features.
*/
public static function get_features() {
/**
* Filters the default values for LLMS_Site features
*
* @since 3.0.0
*
* @param array $defaults An associative array of site features.
*/
$defaults = apply_filters(
'llms_site_default_features',
array(
'recurring_payments' => true,
)
);
return get_option( 'llms_site_get_features', $defaults );
}
/**
* Update the status of a specific feature and save it to the db
*
* @since 3.0.0
*
* @param string $feature Name / key of the feature.
* @param bool $val Status of the feature [true = enabled; false = disabled].
* @return void
*/
public static function update_feature( $feature, $val ) {
$features = self::get_features();
$features[ $feature ] = $val;
update_option( 'llms_site_get_features', $features );
}
/**
* Determine if this is a cloned site
*
* Compares the stored (and cleaned) llms_site_url against the WP site url.
*
* @since 3.0.0
* @since 4.13.0 Add `LLMS_SITE_IS_CLONE` constant check.
*
* @return boolean Returns `true` if it's a cloned site (urls do not match)
* and `false` if it's not (urls DO match).
*/
public static function is_clone() {
$is_clone = defined( 'LLMS_SITE_IS_CLONE' ) ? LLMS_SITE_IS_CLONE : ( get_site_url() !== self::get_url() );
/**
* Filters whether or not the site is a "cloned" site
*
* @since 3.0.0
*
* @param boolean $is_clone When `true` the site is considered a "clone", otherwise it is not.
*/
return apply_filters( 'llms_site_is_clone', $is_clone );
}
/**
* Determines whether or not the clone warning notice has been ignored
*
* This prevents the warning from redisplaying when the site is a clone
* and automatic payments remain disabled.
*
* @since 3.0.0
* @since 4.12.0 Use `llms_parse_bool()` to determine check the option value.
*
* @return boolean
*/
public static function is_clone_ignored() {
/**
* Filters whether or not the "clone" site has already been ignored.
*
* @since 3.0.0
*
* @param boolean $is_clone_ignored If `true`, the clone is ignored, otherwise it is not.
*/
return apply_filters( 'llms_site_is_clone_ignored', llms_parse_bool( get_option( 'llms_site_url_ignore', 'no' ) ) );
}
}
================================================
FILE: includes/class.llms.student.dashboard.php
================================================
<?php
/**
* Retrieve data sets used by various other classes and functions
*
* @package LifterLMS/Classes
*
* @since 3.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Student_Dashboard class.
*
* @since 3.0.0
* @since 3.28.2 Unknown.
* @since 4.0.0 Removed deprecated methods.
*/
class LLMS_Student_Dashboard {
/**
* Constructor
*
* @since 3.0.0
* @version 3.24.0
*/
public function __construct() {
add_filter( 'llms_get_endpoints', array( $this, 'add_endpoints' ) );
add_filter( 'lifterlms_student_dashboard_title', array( $this, 'modify_dashboard_title' ), 5 );
add_filter( 'rewrite_rules_array', array( $this, 'modify_rewrite_rules_order' ) );
}
/**
* Add endpoints to the LLMS_Query class to be automatically registered
*
* @param array $endpoints updated array of endpoints
* @since 3.0.0
* @version 3.0.0
*/
public function add_endpoints( $endpoints ) {
return array_merge( $endpoints, $this->get_endpoints() );
}
/**
* Retrieve an array of all endpoint data for student dashboard endpoints
*
* @return array
* @since 3.0.0
* @version 3.0.0
*/
public function get_endpoints() {
$endpoints = array();
foreach ( self::get_tabs() as $var => $data ) {
if ( empty( $data['endpoint'] ) ) {
continue;
}
$endpoints[ $var ] = $data['endpoint'];
}
return $endpoints;
}
/**
* Get list of student's courses used for recent courses on the dashboard
* and all courses (paginated) on the "View Courses" endpoint
*
* @param integer $limit number of courses to return
* @param integer $skip number of courses to skip (for pagination)
* @return array
* @since 3.6.0
* @version 3.6.0
*/
private static function get_courses( $limit = 10, $skip = 0 ) {
// Get sorting option.
$option = get_option( 'lifterlms_myaccount_courses_in_progress_sorting', 'date,DESC' );
// Parse to order & orderby.
$option = explode( ',', $option );
$orderby = ! empty( $option[0] ) ? $option[0] : 'date';
$order = ! empty( $option[1] ) ? $option[1] : 'DESC';
$student = new LLMS_Student();
return $student->get_courses(
array(
'limit' => $limit,
'order' => $order,
'orderby' => $orderby,
'skip' => $skip,
'status' => 'enrolled',
)
);
}
/**
* Retrieve the current tab when on the student dashboard
*
* @param string $return type of return, either "data" for an array of data or 'slug' for just the slug
* @return mixed
* @since 3.0.0
* @version 3.0.0
*/
public static function get_current_tab( $return = 'data' ) {
global $wp;
// Set default tab.
$current_tab = apply_filters( 'llms_student_dashboard_default_tab', 'dashboard' );
$tabs = self::get_tabs();
foreach ( $tabs as $var => $data ) {
if ( isset( $wp->query_vars[ $var ] ) ) {
$current_tab = $var;
break;
}
}
if ( 'data' === $return ) {
return $tabs[ $current_tab ];
} else {
return $current_tab;
}
}
/**
* Retrieve all dashboard tabs and related data
*
* @since 3.0.0
* @since 3.28.2 Unknown.
* @since 6.0.0 Add pagination to the view-achievements and view-certificates tabs.
* @since 7.5.0 Add view-favorites tab.
*
* @return array
*/
public static function get_tabs() {
$tabs = array(
'dashboard' => array(
'content' => 'lifterlms_template_student_dashboard_home',
'endpoint' => false,
'nav_item' => true,
'title' => __( 'Dashboard', 'lifterlms' ),
'url' => llms_get_page_url( 'myaccount' ),
),
'view-courses' => array(
'content' => 'lifterlms_template_student_dashboard_my_courses',
'endpoint' => get_option( 'lifterlms_myaccount_courses_endpoint', 'my-courses' ),
'paginate' => true,
'nav_item' => true,
'title' => __( 'My Courses', 'lifterlms' ),
),
'my-grades' => array(
'content' => 'lifterlms_template_student_dashboard_my_grades',
'endpoint' => get_option( 'lifterlms_myaccount_grades_endpoint', 'my-grades' ),
'paginate' => true,
'nav_item' => true,
'title' => __( 'My Grades', 'lifterlms' ),
),
'view-memberships' => array(
'content' => 'lifterlms_template_student_dashboard_my_memberships',
'endpoint' => get_option( 'lifterlms_myaccount_memberships_endpoint', 'my-memberships' ),
'nav_item' => true,
'title' => __( 'My Memberships', 'lifterlms' ),
),
'view-achievements' => array(
'content' => 'lifterlms_template_student_dashboard_my_achievements',
'endpoint' => get_option( 'lifterlms_myaccount_achievements_endpoint', 'my-achievements' ),
'paginate' => true,
'nav_item' => true,
'title' => __( 'My Achievements', 'lifterlms' ),
),
'view-certificates' => array(
'content' => 'lifterlms_template_student_dashboard_my_certificates',
'endpoint' => get_option( 'lifterlms_myaccount_certificates_endpoint', 'my-certificates' ),
'paginate' => true,
'nav_item' => true,
'title' => __( 'My Certificates', 'lifterlms' ),
),
'notifications' => array(
'content' => 'lifterlms_template_student_dashboard_my_notifications',
'endpoint' => get_option( 'lifterlms_myaccount_notifications_endpoint', 'notifications' ),
'paginate' => true,
'nav_item' => true,
'title' => __( 'Notifications', 'lifterlms' ),
),
'edit-account' => array(
'content' => array( __CLASS__, 'output_edit_account_content' ),
'endpoint' => get_option( 'lifterlms_myaccount_edit_account_endpoint', 'edit-account' ),
'nav_item' => true,
'title' => __( 'Edit Account', 'lifterlms' ),
),
'redeem-voucher' => array(
'content' => array( __CLASS__, 'output_redeem_voucher_content' ),
'endpoint' => get_option( 'lifterlms_myaccount_redeem_vouchers_endpoint', 'redeem-voucher' ),
'nav_item' => true,
'title' => __( 'Redeem a Voucher', 'lifterlms' ),
),
'orders' => array(
'content' => array( __CLASS__, 'output_orders_content' ),
'endpoint' => get_option( 'lifterlms_myaccount_orders_endpoint', 'orders' ),
'nav_item' => true,
'title' => __( 'Order History', 'lifterlms' ),
),
'signout' => array(
'endpoint' => false,
'title' => __( 'Sign Out', 'lifterlms' ),
'nav_item' => false,
'url' => wp_logout_url( llms_get_page_url( 'myaccount' ) ),
),
);
if ( llms_is_favorites_enabled() ) {
$tabs = llms_assoc_array_insert(
$tabs,
'view-certificates',
'view-favorites',
array(
'content' => 'llms_template_student_dashboard_my_favorites',
'endpoint' => get_option( 'lifterlms_myaccount_favorites_endpoint', 'my-favorites' ),
'paginate' => true,
'nav_item' => true,
'title' => __( 'My Favorites', 'lifterlms' ),
)
);
}
return apply_filters(
'llms_get_student_dashboard_tabs',
$tabs
);
}
/**
* Retrieve dashboard tab data as required to display navigation links
* Excludes any endpoint disabled by deleting the slug from account settings
*
* @return array
* @since 3.17.5
* @version 3.17.5
*/
public static function get_tabs_for_nav() {
$tabs = array();
foreach ( self::get_tabs() as $var => $data ) {
if ( isset( $data['url'] ) ) {
$url = $data['url'];
} elseif ( ! empty( $data['endpoint'] ) ) {
$url = llms_get_endpoint_url( $var, '', llms_get_page_url( 'myaccount' ) );
} else {
continue;
}
$tabs[ $var ] = array(
'url' => $url,
'title' => $data['title'],
);
}
return apply_filters( 'llms_get_student_dashboard_tabs_for_nav', $tabs );
}
/**
* Determine if an endpoint is disabled
* If the custom endpoint option is an empty string (blank) the settings define the endpoint as disabled
*
* @param string $endpoint endpoint slug (eg: my-courses)
* @return bool
* @since 3.19.0
* @version 3.19.0
*/
public static function is_endpoint_enabled( $endpoint ) {
$tabs = self::get_tabs();
if ( isset( $tabs[ $endpoint ] ) && ! empty( $tabs[ $endpoint ]['endpoint'] ) ) {
return true;
}
return false;
}
/**
* Handle modification of the default dashboard title for certain pages and sub pages
*
* @param string $title default title HTML
* @return string
* @since 3.24.0
* @version 3.24.0
*/
public function modify_dashboard_title( $title ) {
global $wp_query;
$tab = self::get_current_tab( 'tab' );
if ( 'my-grades' === $tab && ! empty( $wp_query->query['my-grades'] ) ) {
$course = get_posts(
array(
'name' => $wp_query->query['my-grades'],
'post_type' => 'course',
)
);
$course = array_shift( $course );
if ( $course ) {
$data = self::get_current_tab();
$new_title = '<a href="' . esc_url( llms_get_endpoint_url( 'my-grades' ) ) . '">' . $data['title'] . '</a>';
$new_title .= sprintf( ' %1$s <a href="%2$s">%3$s</a>', apply_filters( 'llms_student_dashboard_title_separator', '<small>></small>' ), get_permalink( $course->ID ), get_the_title( $course->ID ) );
$title = str_replace( $data['title'], $new_title, $title );
}
}
return $title;
}
public function modify_rewrite_rules_order( $rules ) {
return $rules;
}
/**
* Callback to output the edit account content
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
public static function output_edit_account_content() {
llms_get_template(
'myaccount/form-edit-account.php',
array(
'user' => get_user_by( 'id', get_current_user_id() ),
)
);
}
/**
* Endpoint to output orders content
*
* @since 3.0.0
* @since 3.8.0 Unknown.
* @since 6.0.0 Use `llms_template_view_order()` in favor of including the template file directly.
*
* @return void
*/
public static function output_orders_content() {
global $wp;
$args = array();
if ( ! empty( $wp->query_vars['orders'] ) ) {
$order = llms_get_post( $wp->query_vars['orders'] );
llms_template_view_order( $order );
} else {
$student = new LLMS_Student();
llms_get_template(
'myaccount/my-orders.php',
array(
'orders' => $student->get_orders(
array(
'page' => isset( $_GET['opage'] ) ? intval( $_GET['opage'] ) : 1,
)
),
)
);
}
}
/**
* Callback to output content for the voucher endpoint
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
public static function output_redeem_voucher_content() {
llms_get_template(
'myaccount/form-redeem-voucher.php',
array(
'user' => get_user_by( 'id', get_current_user_id() ),
)
);
}
}
return new LLMS_Student_Dashboard();
================================================
FILE: includes/class.llms.student.query.php
================================================
<?php
/**
* Query LifterLMS Students for a given course / membership
*
* @package LifterLMS/Classes
*
* @since 3.4.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Student_Query
*
* @since 3.4.0
* @since 3.13.0 Unknown.
*/
class LLMS_Student_Query extends LLMS_Database_Query {
/**
* Identify the extending query
*
* @var string
*/
protected $id = 'student';
/**
* Retrieve default arguments for a student query
*
* @since 3.4.0
* @since 4.10.2 Drop usage of `this->get_filter( 'default_args' )` in favor of `'llms_student_query_default_args'`.
*
* @return array
*/
protected function get_default_args() {
global $post;
$post_id = ! empty( $post->ID ) ? $post->ID : array();
$args = array(
'post_id' => $post_id,
'sort' => array(
'date' => 'DESC',
'status' => 'ASC',
'last_name' => 'ASC',
'first_name' => 'ASC',
'id' => 'ASC',
),
'statuses' => array_keys( llms_get_enrollment_statuses() ),
);
$args = wp_parse_args( $args, parent::get_default_args() );
/**
* Filters the student query default args
*
* @since 3.4.0
*
* @param array $args Array of default arguments to set up the query with.
* @param LLMS_Student_Query $student_query Instance of LLMS_Student_Query.
*/
return apply_filters( 'llms_student_query_default_args', $args, $this );
}
/**
* Retrieve an array of LLMS_Students for the given set of students returned by the query
*
* @since 3.4.0
* @since 3.8.0 Unknown.
* @since 4.10.2 Drop usage of `this->get_filter( 'get_students' )` in favor of `'llms_student_query_get_students'`.
*
* @return array
*/
public function get_students() {
$students = array();
$results = $this->get_results();
if ( $results ) {
foreach ( $results as $result ) {
$students[] = new LLMS_Student( $result->id );
}
}
if ( $this->get( 'suppress_filters' ) ) {
return $students;
}
/**
* Filters the list of students
*
* @since Unknown
* @since 4.10.2 Pass this query instance as second parameter.
*
* @param LLMS_Student[] $students Array of LLMS_Student instances.
* @param LLMS_Student_Query $student_query Instance of LLMS_Student_Query.
*/
return apply_filters( 'llms_student_query_get_students', $students, $this );
}
/**
* Parses data passed to $statuses
*
* Convert strings to array and ensure resulting array contains only valid statuses
* If no valid statuses, returns to the default.
*
* @since 3.4.0
* @since 3.13.0 Unknown.
*
* @return void
*/
protected function parse_args() {
$statuses = $this->arguments['statuses'];
// Allow strings to be submitted when only requesting one status.
if ( is_string( $statuses ) ) {
$statuses = array( $statuses );
}
// Ensure only valid statuses are used.
$statuses = array_intersect( $statuses, array_keys( llms_get_enrollment_statuses() ) );
// No statuses should return original default.
if ( ! $statuses ) {
$statuses = array_keys( llms_get_enrollment_statuses() );
}
$this->arguments['statuses'] = $statuses;
// Allow numeric strings & ints to be passed instead of an array.
$post_ids = $this->arguments['post_id'];
if ( ! is_array( $post_ids ) && is_numeric( $post_ids ) && $post_ids > 0 ) {
$post_ids = array( $post_ids );
}
foreach ( $post_ids as $key => &$id ) {
$id = absint( $id ); // Verify we have ints.
if ( $id <= 0 ) { // Remove anything negative or 0.
unset( $post_ids[ $key ] );
}
}
$this->arguments['post_id'] = $post_ids;
}
/**
* Prepare the SQL for the query.
*
* @since 3.4.0
* @since 3.13.0 Unknown.
* @since 4.10.2 Demands to `$this->sql_select()` to determine whether or not `SQL_CALC_FOUND_ROWS` statement is needed.
* @since 6.0.0 Renamed from `preprare_query()`.
* @since 10.0.0 Build count_query from shared clauses instead of using SQL_CALC_FOUND_ROWS.
*
* @return string
*/
protected function prepare_query() {
global $wpdb;
$search_vars = array();
if ( $this->get( 'search' ) ) {
$search = '%' . $wpdb->esc_like( $this->get( 'search' ) ) . '%';
$search_vars[] = $search;
$search_vars[] = $search;
$search_vars[] = $search;
}
$base_query = "SELECT {$this->sql_select()}
FROM {$wpdb->users} AS u
{$this->sql_joins()}
{$this->sql_search()}
{$this->sql_having()}";
if ( $this->get( 'count_only' ) ) {
$sql_query = "SELECT COUNT(*) AS total FROM ({$base_query}) as t;";
if ( empty( $search_vars ) ) {
return $sql_query;
}
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $wpdb->prepare( $sql_query, $search_vars );
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
if ( ! $this->get( 'no_found_rows' ) ) {
$count_sql = "SELECT COUNT(*) FROM ({$base_query}) as t";
if ( ! empty( $search_vars ) ) {
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared, WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber
$this->count_query = $wpdb->prepare( $count_sql, $search_vars );
} else {
$this->count_query = $count_sql;
}
}
$vars = $search_vars;
$vars[] = $this->get_skip();
$vars[] = $this->get( 'per_page' );
$sql_query = "{$base_query}
{$this->sql_orderby()}
LIMIT %d, %d;";
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
// phpcs:ignore WordPress.DB.PreparedSQLPlaceholders.ReplacementsWrongNumber -- $vars is an array with the correct number of items.
$sql = $wpdb->prepare(
$sql_query,
$vars
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $sql;
}
/**
* Determines if a field should be selected/joined based on searching and sorting arguments
*
* @since 3.13.0
*
* @param string $field Field name/key.
* @return bool
*/
private function requires_field( $field ) {
// Get the fields we're sorting by to see if we need to select them for the sorting.
$sort_fields = array_keys( $this->get( 'sort' ) );
if ( in_array( $field, $sort_fields ) ) {
return true;
}
if ( $this->get( 'search' ) ) {
$search_fields = array( 'last_name', 'first_name', 'user_email' );
if ( in_array( $field, $search_fields ) ) {
return true;
}
}
return false;
}
/**
* Retrieve prepared SQL for the HAVING clause
*
* @since 3.4.0
* @since 3.13.0 Unknown.
* @since 4.10.2 Drop usage of `this->get_filter( 'having' )` in favor of `'llms_student_query_having'`.
*
* @return string
*/
private function sql_having() {
global $wpdb;
$sql = "HAVING status IS NOT NULL AND {$this->sql_status_in()}";
if ( $this->get( 'suppress_filters' ) ) {
return $sql;
}
/**
* Filters the query HAVING clause
*
* @since Unknown
*
* @param string $sql The HAVING clause of the query.
* @param LLMS_Student_Query $student_query Instance of LLMS_Student_Query.
*/
return apply_filters( 'llms_student_query_having', $sql, $this );
}
/**
* Setup joins based on submitted sort and search args
*
* @since 3.13.0
* @since 4.10.2 Drop usage of `this->get_filter( 'join' )` in favor of `'llms_student_query_join'`.
*
* @return string
*/
private function sql_joins() {
global $wpdb;
$joins = array();
$fields = array(
'first_name' => "JOIN {$wpdb->usermeta} AS m_first ON u.ID = m_first.user_id AND m_first.meta_key = 'first_name'",
'last_name' => "JOIN {$wpdb->usermeta} AS m_last ON u.ID = m_last.user_id AND m_last.meta_key = 'last_name'",
'overall_progress' => "JOIN {$wpdb->usermeta} AS m_o_p ON u.ID = m_o_p.user_id AND m_o_p.meta_key = 'llms_overall_progress'",
'overall_grade' => "JOIN {$wpdb->usermeta} AS m_o_g ON u.ID = m_o_g.user_id AND m_o_g.meta_key = 'llms_overall_grade'",
);
// Add the fields to the array of fields to select.
foreach ( $fields as $key => $statement ) {
if ( $this->requires_field( $key ) ) {
$joins[] = $statement;
}
}
$sql = implode( ' ', $joins );
if ( $this->get( 'suppress_filters' ) ) {
return $sql;
}
/**
* Filters the query JOIN clause
*
* @since 3.13.0
*
* @param string $sql The JOIN clause of the query.
* @param LLMS_Student_Query $student_query Instance of LLMS_Student_Query.
*/
return apply_filters( 'llms_student_query_join', $sql, $this );
}
/**
* Retrieve the prepared SEARCH query for the WHERE clause
*
* @since 3.4.0
* @since 3.8.0 Unknown.
* @since 4.10.2 Drop usage of `this->get_filter( 'search' )` in favor of `'llms_student_query_search'`.
*
* @return string
*/
private function sql_search() {
$sql = '';
if ( $this->get( 'search' ) ) {
global $wpdb;
$sql .= ' AND (
m_last.meta_value LIKE %s
OR m_first.meta_value LIKE %s
OR u.user_email LIKE %s
)';
}
if ( $this->get( 'suppress_filters' ) ) {
return $sql;
}
/**
* Filters the part of the SQL query that performs the search.
*
* @since Unknown
*
* @param string $sql The SQL part that performs the search.
* @param LLMS_Student_Query $student_query Instance of LLMS_Student_Query.
*/
return apply_filters( 'llms_student_query_search', $sql, $this );
}
/**
* Set up the SQL for the select statement.
*
* @since 3.13.0
* @since 4.10.2 Drop usage of `this->get_filter( 'select' )` in favor of `'llms_student_query_select'`.
* Use `$this->sql_select_columns({columns})` to determine additional columns to select.
* @since 5.10.0 Add a subquery for completed date.
*
* @return string
*/
private function sql_select() {
$selects = array();
// Always select the ID.
$selects[] = 'u.ID as id';
// Always add the subqueries for enrollment status.
$selects[] = "( {$this->sql_subquery( 'meta_value' )} ) AS status";
// All the possible fields.
$fields = array(
'completed' => "( {$this->sql_subquery( 'updated_date', '_is_complete' )} ) AS completed",
'date' => "( {$this->sql_subquery( 'updated_date' )} ) AS `date`",
'last_name' => 'm_last.meta_value AS last_name',
'first_name' => 'm_first.meta_value AS first_name',
'email' => 'u.user_email AS email',
'registered' => 'u.user_registered AS registered',
'overall_progress' => 'CAST( m_o_p.meta_value AS decimal( 5, 2 ) ) AS overall_progress',
'overall_grade' => 'CAST( m_o_g.meta_value AS decimal( 5, 2 ) ) AS overall_grade',
);
// Add the fields to the array of fields to select.
foreach ( $fields as $key => $statement ) {
if ( $this->requires_field( $key ) ) {
$selects[] = $statement;
}
}
$sql = implode( ', ', $selects );
$sql = $this->sql_select_columns( $sql );
if ( $this->get( 'suppress_filters' ) ) {
return $sql;
}
/**
* Filters the query SELECT clause
*
* @since 3.13.0
*
* @param string $sql The SELECT clause of the query.
* @param LLMS_Student_Query $student_query Instance of LLMS_Student_Query.
*/
return apply_filters( 'llms_student_query_select', $sql, $this );
}
/**
* Generate an SQL IN clause based on submitted status arguments
*
* @since 3.13.0
*
* @param string $column Name of the column.
* @return string
*/
private function sql_status_in( $column = 'status' ) {
global $wpdb;
$comma = false;
$statuses = array();
$sql = '';
foreach ( $this->get( 'statuses' ) as $status ) {
$sql .= $comma ? ',%s' : '%s';
$statuses[] = $status;
$comma = true;
}
$sql = $wpdb->prepare( $sql, $statuses ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
return "{$column} IN ( {$sql} )";
}
/**
* Generate an SQL subquery for the meta key in the main query.
*
* @since 3.13.0
* @since 5.10.0 Add `$meta_key` argument.
*
* @param string $column Column name.
* @param string $meta_key Optional meta key to use in the WHERE condition. Defaults to '_status'.
* @return string
*/
private function sql_subquery( $column, $meta_key = '_status' ) {
global $wpdb;
$post_ids = $this->get( 'post_id' );
if ( $post_ids ) {
$post_ids = implode( ',', $post_ids );
$and = "AND post_id IN ( {$post_ids} )";
} else {
$and = "AND {$this->sql_status_in( 'meta_value' )}";
}
return "SELECT {$column}
FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE meta_key = '{$meta_key}'
AND user_id = id
{$and}
ORDER BY updated_date DESC
LIMIT 1";
}
}
================================================
FILE: includes/class.llms.template.loader.php
================================================
<?php
/**
* Template loader
*
* @package LifterLMS/Classes
*
* @since 1.0.0
* @version 7.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Template loader class.
*
* @since 1.0.0
* @since 3.20.0 Unknown.
* @since 3.37.2 Notices are printed on sales pages too.
* @since 3.37.10 Notices are printed on pages configured as a membership restriction redirect page.
* @since 3.41.1 Fixed content membership restricted post's content not restricted in REST requests.
* @since 4.0.0 Don't pass objects by reference because it's unnecessary.
*/
class LLMS_Template_Loader {
/**
* Constructor.
*
* @since 1.0.0
* @since 3.20.0 Unknown.
* @since 3.41.1 Predispose posts content restriction in REST requests.
* @since 5.8.0 Handle block templates loading.
* @since 6.2.0 Added 'llms_template_loader_priority' filter.
* @since 6.4.0 Reverted back the priority of the `$this->template_loader()` callback
* (`template_include` hook's callback) from 100 to 10.
*/
public function __construct() {
// Template loading for FSE themes.
add_action( 'template_redirect', array( $this, 'hook_block_template_loader' ) );
/**
* Filters the template loading priority.
*
* Callback for the WP core filter `template_include`.
*
* @since 6.2.0
*
* @param int $priority The filter callback priority.
*/
$template_loader_cb_priority = apply_filters( 'llms_template_loader_priority', 10 );
/**
* Do template loading.
*
* The default priority is 10, so to allow theme builders, like Divi and Elementor (Pro),
* to override our templates (except single content restricted).
* see https://github.com/gocodebox/lifterlms/issues/2111
*/
add_filter( 'template_include', array( $this, 'template_loader' ), $template_loader_cb_priority );
add_action( 'rest_api_init', array( $this, 'maybe_prepare_post_content_restriction' ) );
// Restriction actions for each kind of restriction.
$reasons = apply_filters(
'llms_restriction_reasons',
array(
'course_prerequisite',
'course_track_prerequisite',
'course_time_period',
'enrollment_lesson',
'lesson_drip',
'lesson_prerequisite',
'membership',
'sitewide_membership',
'quiz',
)
);
foreach ( $reasons as $reason ) {
add_action( 'llms_content_restricted_by_' . $reason, array( $this, 'restricted_by_' . $reason ), 10, 1 );
}
add_action( 'wp', array( $this, 'maybe_redirect_to_sales_page' ) );
}
/**
* Add a notice and/or redirect during restriction actions.
*
* @since 3.0.0
* @since 7.4.0 Added `nocache_headers()` to prevent caching of redirects.
*
* @param string $msg Notice message to display.
* @param string $redirect Optional. Url to redirect to after setting a notice. Default empty string.
* @param string $msg_type Optional. Type of message to display [notice|success|error|debug]. Default 'notice'.
* @return void
*/
private function handle_restriction( $msg = '', $redirect = '', $msg_type = 'notice' ) {
if ( $msg ) {
llms_add_notice( do_shortcode( $msg ), $msg_type );
}
if ( $redirect ) {
nocache_headers();
wp_redirect( $redirect );
exit;
}
}
/**
* Handle sales page redirects for courses & memberships
*
* @since 3.20.0
* @since 3.37.2 Flag to print notices, if there are, when landing on the redirected sales page.
*
* @return void
*/
public function maybe_redirect_to_sales_page() {
// Only proceed for courses and memberships.
if ( ! in_array( get_post_type(), array( 'course', 'llms_membership' ), true ) ) {
return;
}
$page_restricted = llms_page_restricted( get_the_id() );
// Only proceed if the page isn't restricted.
if ( ! $page_restricted['is_restricted'] ) {
return;
}
/** @var LLMS_Trait_Sales_Page $post */
$post = llms_get_post( get_the_ID() );
if ( ! $post->has_sales_page_redirect() ) {
return;
}
llms_redirect_and_exit(
llms_notice_count() ?
add_query_arg(
array(
'llms_print_notices' => 1,
),
$post->get_sales_page_url()
) : $post->get_sales_page_url(),
array(
'safe' => false,
)
);
}
/**
* Handle redirects and messages when a user attempts to access an item
* restricted by a course track prerequisite.
*
* Redirect to parent course and display message.
* If course do nothing.
*
* @since 3.7.3
*
* @param array $info Array of restriction info from `llms_page_restricted()`.
* @return void
*/
public function restricted_by_course_track_prerequisite( $info ) {
if ( 'course' === get_post_type( $info['content_id'] ) ) {
return;
}
$msg = llms_get_restriction_message( $info );
$course = llms_get_post_parent_course( $info['content_id'] );
$redirect = get_permalink( $course->get( 'id' ) );
$this->handle_restriction(
apply_filters( 'llms_restricted_by_course_track_prerequisite_message', $msg, $info ),
apply_filters( 'llms_restricted_by_course_track_prerequisite_redirect', $redirect, $info ),
'error'
);
}
/**
* Handle redirects and messages when a user attempts to access an item
* restricted by a course prerequisite.
*
* Redirect to parent course and display message.
* If course do nothing.
*
* @since 3.7.3
*
* @param array $info Array of restriction info from `llms_page_restricted()`.
* @return void
*/
public function restricted_by_course_prerequisite( $info ) {
if ( 'course' === get_post_type( $info['content_id'] ) ) {
return;
}
$msg = llms_get_restriction_message( $info );
$course = llms_get_post_parent_course( $info['content_id'] );
$redirect = get_permalink( $course->get( 'id' ) );
$this->handle_restriction(
apply_filters( 'llms_restricted_by_course_prerequisite_message', $msg, $info ),
apply_filters( 'llms_restricted_by_course_prerequisite_redirect', $redirect, $info ),
'error'
);
}
/**
* Handle redirects and messages when a course or associated quiz or lesson has time period
* date restrictions placed upon it.
*
* Quizzes & Lessons redirect to the parent course.
* Courses display a notice until the course opens and an error once the course closes.
*
* @since 3.0.0
*
* @param array $info Array of restriction info from `llms_page_restricted()`.
* @return void
*/
public function restricted_by_course_time_period( $info ) {
$post_type = get_post_type( $info['content_id'] );
// If this restriction occurs when attempting to view a lesson,
// redirect the user to the course, course restriction will handle display of the
// message once we get there.
// This prevents duplicate messages from being displayed.
if ( 'lesson' === $post_type || 'llms_quiz' === $post_type ) {
$msg = '';
$redirect = get_permalink( $info['restriction_id'] );
}
if ( ! $msg && ! $redirect ) {
return;
}
// Handle the restriction action & allow developers to filter the results.
$this->handle_restriction(
apply_filters( 'llms_restricted_by_course_time_period_message', $msg, $info ),
apply_filters( 'llms_restricted_by_course_time_period_redirect', $redirect, $info ),
'notice'
);
}
/**
* Handle redirects and messages when a user attempts to access a lesson
* for a course they're not enrolled in.
*
* Redirect to parent course and display message.
*
* @since 3.0.0
* @since 3.2.4 Moved message generation to `llms_get_restriction_message()`
*
* @param array $info Array of restriction info from `llms_page_restricted()`.
* @return void
*/
public function restricted_by_enrollment_lesson( $info ) {
$msg = llms_get_restriction_message( $info );
$redirect = get_permalink( $info['restriction_id'] );
$this->handle_restriction(
apply_filters( 'llms_restricted_by_enrollment_lesson_message', $msg, $info ),
apply_filters( 'llms_restricted_by_enrollment_lesson_redirect', $redirect, $info ),
'error'
);
}
/**
* Handle redirects and messages when a user attempts to access a lesson
* for that is restricted by lesson drip settings.
*
* Redirect to parent course and display message.
*
* @since 3.0.0
* @since 3.2.4 Moved message generation to `llms_get_restriction_message()`
* @since 5.7.0 Replaced the call to the deprecated `LLMS_Lesson::get_parent_course()` method with `LLMS_Lesson::get( 'parent_course' )`.
*
* @param array $info Array of restriction info from `llms_page_restricted()`.
* @return void
*/
public function restricted_by_lesson_drip( $info ) {
$lesson = new LLMS_Lesson( $info['restriction_id'] );
$msg = llms_get_restriction_message( $info );
$redirect = get_permalink( $lesson->get( 'parent_course' ) );
$this->handle_restriction(
apply_filters( 'llms_restricted_by_lesson_drip_message', $msg, $info ),
apply_filters( 'llms_restricted_by_lesson_drip_redirect', $redirect, $info ),
'error'
);
}
/**
* Handle redirects and messages when a user attempts to access a lesson
* for that is restricted by prerequisite lesson.
*
* Redirect to parent course and display message.
*
* @since 3.0.0
* @since 3.2.4 Moved message generation to `llms_get_restriction_message()`
*
* @param array $info Array of restriction info from `llms_page_restricted()`.
* @return void
*/
public function restricted_by_lesson_prerequisite( $info ) {
$msg = llms_get_restriction_message( $info );
$redirect = get_permalink( $info['restriction_id'] );
$this->handle_restriction(
apply_filters( 'llms_restricted_by_lesson_prerequisite_message', $msg, $info ),
apply_filters( 'llms_restricted_by_lesson_prerequisite_redirect', $redirect, $info ),
'error'
);
}
/**
* Handle content restricted to a membership.
*
* Parses and obeys Membership "Restriction Behavior" settings.
*
* @since 3.0.0
* @since 3.37.10 Added Flag to print notices when landing on the redirected page.
*
* @param array $info Array of restriction info from `llms_page_restricted()`.
* @return void
*/
public function restricted_by_membership( $info ) {
$membership_id = $info['restriction_id'];
// Do nothing if we don't have a membership id.
if ( ! empty( $membership_id ) && is_numeric( $membership_id ) ) {
// Instantiate the membership.
$membership = new LLMS_Membership( $membership_id );
$msg = '';
$redirect = '';
if ( 'yes' === $membership->get( 'restriction_add_notice' ) ) {
$msg = $membership->get( 'restriction_notice' );
}
// Get the redirect based on the redirect type (if set).
switch ( $membership->get( 'restriction_redirect_type' ) ) {
case 'custom':
$redirect = $membership->get( 'redirect_custom_url' );
break;
case 'membership':
$redirect = get_permalink( $membership->get( 'id' ) );
break;
case 'page':
$redirect = get_permalink( $membership->get( 'redirect_page_id' ) );
// Make sure to print notices in wp pages.
$redirect = empty( $msg ) ? $redirect : add_query_arg(
array(
'llms_print_notices' => 1,
),
$redirect
);
break;
}
// Handle the restriction action & allow developers to filter the results.
$this->handle_restriction(
apply_filters( 'llms_restricted_by_membership_message', $msg, $info ),
apply_filters( 'llms_restricted_by_membership_redirect', $redirect, $info )
);
}
}
/**
* Handle attempts to access quizzes.
*
* @since 3.1.6
* @since 3.16.1 Unknown.
*
* @param array $info Array of restriction info from `llms_page_restricted()`.
* @return void
*/
public function restricted_by_quiz( $info ) {
$msg = '';
$redirect = '';
if ( get_current_user_id() ) {
$msg = __( 'You must be enrolled in the course to access this quiz.', 'lifterlms' );
$quiz = llms_get_post( $info['restriction_id'] );
if ( $quiz ) {
$course = $quiz->get_course();
if ( $course ) {
$redirect = get_permalink( $course->get( 'id' ) );
}
}
} else {
$msg = __( 'You must be logged in to take quizzes.', 'lifterlms' );
$redirect = llms_person_my_courses_url();
}
$this->handle_restriction(
apply_filters( 'llms_restricted_by_membership_message', $msg, $info ),
apply_filters( 'llms_restricted_by_membership_redirect', $redirect, $info ),
'error'
);
}
/**
* Handle content restricted to a membership
*
* Parses and obeys Membership "Restriction Behavior" settings.
*
* @since 3.0.0
*
* @param array $info Array of restriction info from `llms_page_restricted()`.
* @return void
*/
public function restricted_by_sitewide_membership( $info ) {
$this->restricted_by_membership( $info );
}
/**
* Hooks the callback to load FSE block templates.
*
* @since 5.8.0
*
* @return void
*/
public function hook_block_template_loader() {
add_filter( 'pre_get_block_templates', array( $this, 'block_template_loader' ), 99, 3 );
}
/**
* Filter blocks templates.
*
* @since 5.8.0
* @since 6.0.0 Remove LifterLMS 6.0 version check about the certificate template.
* Use `llms_is_block_theme()` in favor of `wp_is_block_theme()`.
*
* @param WP_Block_Template[] $result Array of found block templates.
* @param array $query {
* Optional. Arguments to retrieve templates.
*
* @type array $slug__in List of slugs to include.
* @type int $wp_id Post ID of customized template.
* }
* @param array $template_type wp_template or wp_template_part.
* @return array Templates.
*/
public function block_template_loader( $result, $query, $template_type ) {
// Bail if it's not a block theme, or is being retrieved a non wp_template file.
if ( ! llms_is_block_theme() || 'wp_template' !== $template_type ) {
return $result;
}
$template_name = $this->get_maybe_forced_template();
/**
* Since LifterLMS 6.0.0 certificates have their own PHP template that do no depend on the theme.
* This means that we can use the PHP template loaded in the method `LLMS_Template_Loader::template_loader()` below.
*/
$template_name = is_singular( array( 'llms_certificate', 'llms_my_certificate' ) ) ? '' : $template_name;
// Focus mode always uses the PHP template (not the block template) for a stable, non-editable layout.
if ( 'single-lesson-focus' === $template_name ) {
return $result;
}
/**
* Filters the block template to be loded forced.
*
* @since 5.8.0
*
* @param string $template_slug The template slug to be force loaded.
* @param string $template The name of template to be force loaded.
*/
$template_slug = apply_filters( 'llms_forced_block_template_slug', $template_name ? LLMS_Block_Templates::LLMS_BLOCK_TEMPLATES_PREFIX . $template_name : '', $template_name );
if ( empty( $template_slug ) ) {
return $result;
}
// Prevent template_loader to load a php template.
add_filter( 'llms_force_php_template_loading', '__return_false' );
return llms()->block_templates()->add_llms_block_templates(
array(),
array( 'slug__in' => array( $template_slug ) )
);
}
/**
* Check if content should be restricted and include overrides where appropriate.
*
* Triggers actions based on content restrictions.
*
* @since 1.0.0
* @since 3.16.11 Unknown.
* @since 3.37.2 Make sure to print notices on sales page redirect.
* @since 4.10.1 Refactor to reduce code duplication and replace usage of `llms_shop` with `courses` for catalog check.
* @since 5.8.0 Refactor: moved the template guessing in a specific method.
* @since 6.4.0 Defer single content restricted template loading.
*
* @param string $template The template to load.
* @return string
*/
public function template_loader( $template ) {
$page_restricted = llms_page_restricted( get_the_ID() );
$this->maybe_print_notices_on_sales_page_redirect();
if ( $page_restricted['is_restricted'] ) {
/**
* Generic action triggered when content is restricted.
*
* @since Unknown
*
* @see llms_content_restricted_by_{$page_restricted['reason']} A specific hook triggered by a specific restriction reason.
*
* @param array $page_restricted Restriction information from `llms_page_restricted()`.
*/
do_action( 'lifterlms_content_restricted', $page_restricted );
/**
* Action triggered when content is restricted for the specified reason.
*
* The dynamic portion of this hook, `{$page_restricted['reason']}` refers to the restriction reason
* code generated by `llms_page_restricted()`.
*
* @since Unknown
*
* @see llms_content_restricted A generic hook triggered at the same time.
*
* @param array $page_restricted Restriction information from `llms_page_restricted()`.
*/
do_action( "llms_content_restricted_by_{$page_restricted['reason']}", $page_restricted );
if ( is_home() && 'sitewide_membership' === $page_restricted['reason'] ) {
// Prints notices on the blog page when there's not redirects setup.
add_action( 'loop_start', 'llms_print_notices', 5 );
}
}
$forced_template = $this->maybe_force_php_template( $template );
/**
* When restricting single content use a lower priority so to always override
* theme builders like Divi and Elementor (Pro).
* see https://github.com/gocodebox/lifterlms/issues/2063.
*/
if ( llms_template_file_path( 'single-no-access.php' ) === $forced_template ) {
/**
* Filters the template loading priority for single restricted content.
*
* @since 6.4.0
*
* @param int $priority The filter callback priority.
*/
$template_loader_restricted_cb_priority = apply_filters( 'llms_template_loader_restricted_priority', 100 );
add_filter( 'template_include', array( $this, 'maybe_force_php_template' ), $template_loader_restricted_cb_priority );
} else {
$template = $forced_template;
}
return $template;
}
/**
* Force the PHP template to be loaded.
*
* @since 6.4.0
*
* @param string $template The original template to load.
* @return string
*/
public function maybe_force_php_template( $template ) {
/**
* Filters whether or not forcing a LifterLMS php template to be loaded.
*
* @since 5.8.0
*
* @param bool $force Whether or not forcing a LifterLMS PHP template to be loaded.
*/
$forced_template = apply_filters( 'llms_force_php_template_loading', true ) ? $this->get_maybe_forced_template() : false;
return $forced_template ? llms_template_file_path( "{$forced_template}.php" ) : $template;
}
/**
* Retrieve the hierarchical template to be loaded.
*
* @since 5.8.0
*
* @return null|string
*/
private function get_maybe_forced_template() {
$page_restricted = llms_page_restricted( get_the_ID() );
$template = null;
if ( $page_restricted['is_restricted'] ) {
// Blog should bypass checks, except when sitewide restrictions are enabled.
if ( ( is_home() && 'sitewide_membership' === $page_restricted['reason'] ) ||
// Course and membership content restrictions are handled by conditional elements in the editor.
( in_array( get_post_type(), array( 'course', 'llms_membership' ), true ) ) ) {
return;
}
// Content is restricted.
$template = 'single-no-access';
} elseif ( is_post_type_archive( 'course' ) || is_page( llms_get_page_id( 'courses' ) ) ) {
$template = 'archive-course';
} elseif ( is_post_type_archive( 'llms_membership' ) || is_page( llms_get_page_id( 'memberships' ) ) ) {
$template = 'archive-llms_membership';
} elseif ( is_tax( array( 'course_cat', 'course_tag', 'course_difficulty', 'course_track', 'membership_tag', 'membership_cat' ) ) ) {
global $wp_query;
$obj = $wp_query->get_queried_object();
$template = 'taxonomy-' . $obj->taxonomy;
} elseif ( is_singular( array( 'llms_certificate', 'llms_my_certificate' ) ) ) {
$template = 'single-certificate';
} elseif ( is_singular( apply_filters( 'llms_focus_mode_post_types', array( 'lesson', 'llms_quiz' ) ) ) && llms_is_focus_mode_enabled( get_the_ID() ) ) {
$template = 'single-lesson-focus';
}
/**
* Filters the template to be loded forced.
*
* @since 5.8.0
*
* @param string $template The template slug to be loaded forced.
*/
return apply_filters( 'llms_forced_template', $template );
}
/**
* Maybe print notices after redirection.
*
* @since 3.37.2
*
* @return void
*/
private function maybe_print_notices_on_sales_page_redirect() {
if ( llms_filter_input( INPUT_GET, 'llms_print_notices' ) ) {
// Prints notices on the page at loop start.
add_action( 'loop_start', 'llms_print_notices', 5 );
}
}
/**
* Maybe restrict the post content in REST requets
*
* @since 3.41.1
*
* @return void
*/
public function maybe_prepare_post_content_restriction() {
// Fired on `setup_postdata()` see `WP_REST_Posts_Controller::prepare_item_for_response()`.
add_action( 'the_post', array( $this, 'maybe_restrict_post_content' ), 9999, 2 );
}
/**
* Maybe restrict the post content in the REST loop
*
* @since 3.41.1
* @since 4.0.0 Don't pass by reference because it's unnecessary.
* @since 4.10.1 Fixed incorrect position of `true` in `in_array()`.
*
* @param WP_Post $post Post Object.
* @param WP_Query $query Query object.
* @return void
*/
public function maybe_restrict_post_content( $post, $query ) {
/**
* Filters the post types that must be skipped.
*
* The LifterLMS post types content restriction should be handled by the LifterLMS rest-api.
*
* @since 3.41.1
*
* @param string[] $post_types The array of post types to skip.
*/
$skip = apply_filters(
'llms_in_rest_restrict_content_skip_post_types',
array(
'course',
'lesson',
'llms_quiz',
'llms_membership',
'llms_question',
'llms_certificate',
'llms_my_certificate',
)
);
if ( in_array( get_post_type( $post ), $skip, true ) ) {
return;
}
// Needed by `llms_page_restricted()` to work as expected.
$is_singular = $query->is_singular;
$query->is_singular = true;
$page_restricted = llms_page_restricted( get_the_ID() );
if ( $page_restricted['is_restricted'] ) {
$msg = __( 'This content is restricted', 'lifterlms' );
$reason = $page_restricted['reason'];
if ( in_array( $reason, array( 'membership', 'sitewide_membership' ), true ) ) {
$membership_id = $page_restricted['restriction_id'];
if ( ! empty( $membership_id ) && is_numeric( $membership_id ) ) {
$membership = new LLMS_Membership( $membership_id );
if ( 'yes' === $membership->get( 'restriction_add_notice' ) ) {
$msg = $membership->get( 'restriction_notice' );
}
}
}
/**
* Filters the restriction message.
*
* The dynamic portion of the hook name, `$reason`, refers to the restriction reason.
*
* @since 3.41.1
*
* @param string $message Restriction message.
* @param array $restriction Array of restriction info from `llms_page_restricted()`.
*/
$msg = apply_filters( "llms_in_rest_restricted_by_{$reason}_message", $msg, $page_restricted );
$post->post_content = $msg;
$post->post_excerpt = $msg;
}
$query->is_singular = $is_singular;
}
}
new LLMS_Template_Loader();
================================================
FILE: includes/class.llms.track.php
================================================
<?php
/**
* LifterLMS Course Tracks
*
* @package LifterLMS/Classes
*
* @since 3.0.0
* @version 3.30.3
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Course Tracks
*
* @since 3.0.0
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Track {
/**
* @var string
* @since 3.0.0
*/
public $taxonomy = 'course_track';
/**
* @var WP_Term
* @since 3.0.0
*/
public $term;
/**
* Constructor
*
* @param int|string|obj $term term_id, term_slug, or instance of a WP_Term
* @since 3.0.0
* @version 3.0.0
*/
public function __construct( $term ) {
if ( is_numeric( $term ) ) {
$this->term = get_term( $term, $this->taxonomy );
} elseif ( is_string( $term ) ) {
$this->term = get_term_by( 'slug', $term, $this->taxonomy );
} elseif ( $term instanceof WP_Term ) {
$this->term = $term;
}
}
/**
* Get an array of WP Posts for the courses in the track
*
* @return array
* @since 3.0.0
* @version 3.0.0
*/
public function get_courses() {
// No posts in the term, return an empty array.
if ( 0 === $this->term->count ) {
return array();
}
$q = new WP_Query(
array(
'post_status' => 'publish',
'post_type' => 'course',
'posts_per_page' => -1,
'tax_query' => array(
array(
'field' => 'id',
'include_children' => false,
'taxonomy' => $this->taxonomy,
'terms' => $this->term->term_id,
),
),
)
);
if ( $q->have_posts() ) {
return $q->posts;
} else {
return array();
}
}
/**
* Get a permalink to the track's archive page
*
* @return string
* @since 3.0.0
* @version 3.0.0
*/
public function get_permalink() {
return get_term_link( $this->term->term_id, $this->taxonomy );
}
/**
* Get the track's title
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_title() {
return $this->term->name;
}
}
================================================
FILE: includes/class.llms.tracker.php
================================================
<?php
/**
* Handle sending data to LifterLMS when tracking is enabled
*
* @package LifterLMS/Classes
*
* @since 3.0.0
* @version 7.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS telemetry tracking data.
*
* @since 3.0.0
*/
class LLMS_Tracker {
/**
* URL endpoint where we'll receive the data
*/
const API_URL = 'https://lifterlms.com/llms-api/tracking';
/**
* Initialize.
*
* @since 3.0.0
*
* @return void
*/
public static function init() {
add_action( 'llms_send_tracking_data', array( __CLASS__, 'send_data' ) );
}
/**
* Retrieve a timestamp of the last time the tracks sent data home
*
* @since 3.0.0
*
* @return int a timestamp
*/
private static function get_last_send_time() {
return apply_filters( 'llms_tracker_get_last_send_time', get_option( 'llms_tracker_last_send_time', 0 ) );
}
/**
* Send data home
*
* @since 3.0.0
* @since 7.4.0 Fix return type.
*
* @param bool $force Force send regardless or the last send time.
* @return array|WP_Error|void
*/
public static function send_data( $force = false ) {
// Don't trigger during AJAX Requests.
if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
return;
}
// Allow forcing of the send despite the interval.
if ( ! $force && ! apply_filters( 'llms_tracker_force_send', false ) ) {
// Only send data once a week.
$last_send = self::get_last_send_time();
if ( $last_send && $last_send > apply_filters( 'llms_tracker_send_interval', strtotime( '-1 week' ) ) ) {
return;
}
}
// Record a last send time.
update_option( 'llms_tracker_last_send_time', time() );
$r = wp_remote_post(
self::API_URL,
array(
'body' => array(
'data' => json_encode( LLMS_Data::get_data( 'tracker' ) ),
),
'cookies' => array(),
'headers' => array(
'user-agent' => 'LifterLMS_Tracker/' . md5( esc_url( home_url( '/' ) ) ) . ';',
),
'method' => 'POST',
'redirection' => 5,
'timeout' => 60,
)
);
if ( ! is_wp_error( $r ) ) {
return json_decode( $r['body'], true );
} else {
return $r;
}
}
}
================================================
FILE: includes/class.llms.user.permissions.php
================================================
<?php
/**
* LLMS_User_Permissions class file
*
* @package LifterLMS/Classes
*
* @since 3.13.0
* @version 5.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Filters and actions related to user permissions
*
* @since 3.13.0
* @since 3.34.0 Always add the `editable_roles` filter.
* @since 3.34.0 Added methods and logic for managing user management of other users.
* Add logic for `view_students`, `edit_students`, and `delete_students` capabilities.
* @since 3.36.5 Add `llms_user_caps_edit_others_posts_post_types` filter to allow 3rd parties to utilize core methods for modifying other users posts.
* @since 3.37.14 Use strict comparisons where needed.
* @since 3.41.0 Improve user management of other users when the managing user has multiple roles.
*/
class LLMS_User_Permissions {
/**
* Constructor
*
* @since 3.13.0
* @since 3.34.0 Always add the `editable_roles` filter.
*
* @return void
*/
public function __construct() {
add_filter( 'user_has_cap', array( $this, 'handle_caps' ), 10, 3 );
add_filter( 'editable_roles', array( $this, 'editable_roles' ) );
add_filter( 'rest_user_query', array( $this, 'filter_rest_user_query' ), 10, 2 );
}
/**
* Determines what other user roles can be managed by a user role
*
* Allows LMS Managers to create instructors and other managers.
* Allows instructors to create & manage assistants.
*
* @since 3.13.0
* @since 3.34.0 Moved the `llms_editable_roles` filter to the class method get_editable_roles().
* @since 3.37.14 Use strict comparison.
* @since 4.10.0 Better handling of users with multiple roles.
*
* @link https://codex.wordpress.org/Plugin_API/Filter_Reference/editable_roles
*
* @param array $all_roles All roles array.
* @return array
*/
public function editable_roles( $all_roles ) {
/**
* Prevent issues when other plugins call get_editable_roles() before `init`.
*
* @link https://github.com/gocodebox/lifterlms/issues/1727
*/
if ( ! function_exists( 'wp_get_current_user' ) ) {
return $all_roles;
}
if ( is_multisite() && is_super_admin() ) {
return $all_roles;
}
$user = wp_get_current_user();
$user_roles = $user->roles;
if ( in_array( 'administrator', $user_roles, true ) ) {
return $all_roles;
}
$editable_roles = self::get_editable_roles();
if ( empty( array_intersect( $user_roles, array_keys( $editable_roles ) ) ) ) {
return $all_roles;
}
$roles = array();
foreach ( $user_roles as $user_role ) {
if ( isset( $editable_roles[ $user_role ] ) ) {
$roles = array_merge( $roles, $editable_roles[ $user_role ] );
}
}
$roles = array_unique( $roles );
foreach ( array_keys( $all_roles ) as $role ) {
if ( ! in_array( $role, $roles, true ) ) {
unset( $all_roles[ $role ] );
}
}
return $all_roles;
}
/**
* Filter the WP_User_Query args to ensure that instructors can only see their students
*
* @since 8.0.2
*
* @param array $args WP_User_Query args.
* @param WP_REST_Request $request Request object.
* @return array
*/
public function filter_rest_user_query( $args, $request ) {
$user = wp_get_current_user();
if ( ! $user ) {
return $args;
}
if ( ! in_array( 'instructor', $user->roles, true ) ) {
return $args;
}
$instructor = llms_get_instructor( $user );
if ( ! $instructor ) {
return $args;
}
$student_query = $instructor->get_students( array( 'statuses' => array( 'enrolled' ) ) );
$students = $student_query->get_results();
if ( empty( $students ) ) {
$args['include'] = array( 0 );
} else {
$args['include'] = wp_list_pluck( $students, 'id' );
}
return $args;
}
/**
* Handle capabilities checks for lms content to allow *editing* content based on course instructor
*
* @since 3.13.0
*
* @param bool[] $allcaps Array of key/value pairs where keys represent a capability name and boolean values
* represent whether the user has that capability.
* @param string[] $cap Required primitive capabilities for the requested capability.
* @param array $args {
* Arguments that accompany the requested capability check.
*
* @type string $0 Requested capability.
* @type int $1 Concerned user ID.
* @type mixed ...$2 Optional second and further parameters, typically object ID.
* }
* @return array
*/
public function edit_others_lms_content( $allcaps, $cap, $args ) {
/**
* this might be a problem
* this happens when in wp-admin/includes/post.php
* when actually creating/updating a course
* and no post_id is passed in $args[2].
*/
if ( empty( $args[2] ) ) {
$allcaps[ $cap[0] ] = true;
return $allcaps;
}
$instructor = llms_get_instructor( $args[1] );
if ( $instructor && $instructor->is_instructor( $args[2] ) ) {
$allcaps[ $cap[0] ] = true;
}
return $allcaps;
}
/**
* Get a map of roles that can be managed by LifterLMS User Roles
*
* @since 3.34.0
*
* @return array
*/
public static function get_editable_roles() {
/**
* Get a map of roles that can be managed by LifterLMS User Roles
*
* @since 3.13.0
*
* @param array $roles Array of user roles. The array key is the role and the value is an array of roles that can be managed by that role.
*/
$roles = apply_filters(
'llms_editable_roles',
array(
'lms_manager' => array( 'instructor', 'instructors_assistant', 'lms_manager', 'student' ),
'instructor' => array( 'instructors_assistant' ),
)
);
return $roles;
}
/**
* Modify a users ability to `view_grades`
*
* Users can view the grades (quiz results) if one of the following conditions is met:
* + Users can view their own grades.
* + Admins and LMS Managers can view anyone's grade.
* + Any user who has been explicitly granted the `view_grades` cap can view anyone's grade (via custom code).
* + Any instructor/assistant who can `edit_post` for the course the quiz belongs to can view grades of the students within that course.
*
* @since 4.21.2
*
* @param bool[] $allcaps Array of key/value pairs where keys represent a capability name and boolean values
* represent whether the user has that capability.
* @param array $args {
* Arguments that accompany the requested capability check.
*
* @type string $0 Requested capability: 'view_grades'.
* @type int $1 Current User ID.
* @type int $2 Requested User ID.
* @type int $3 WP_Post ID of the quiz (optional)
* }
* @return array
*/
private function handle_cap_view_grades( $allcaps, $args ) {
// Logged out user or missing required args.
if ( empty( $args[1] ) || empty( $args[2] ) ) {
return $allcaps;
}
$requested_cap = $args[0];
$current_user_id = intval( $args[1] );
$requested_user_id = intval( $args[2] );
$post_id = isset( $args[3] ) ? intval( $args[3] ) : false;
// Administrators and LMS managers explicitly have the cap so we don't need to perform any further checks.
if ( ! empty( $allcaps[ $requested_cap ] ) ) {
return $allcaps;
}
// Users can view their own grades.
if ( $current_user_id === $requested_user_id ) {
$allcaps[ $requested_cap ] = true;
} elseif ( $post_id && current_user_can( 'edit_post', $post_id ) ) {
if ( $this->instructor_has_student( $current_user_id, $requested_user_id ) ) {
$allcaps[ $requested_cap ] = true;
}
} elseif ( ! $post_id && current_user_can( 'view_students', $requested_user_id ) ) {
if ( $this->instructor_has_student( $current_user_id, $requested_user_id ) ) {
$allcaps[ $requested_cap ] = true;
}
}
return $allcaps;
}
/**
* Custom capability checks for LifterLMS things
*
* @since 3.13.0
* @since 3.34.0 Add logic for `edit_users` and `delete_users` capabilities with regards to LifterLMS user roles.
* Add logic for `view_students`, `edit_students`, and `delete_students` capabilities.
* @since 3.36.5 Add `llms_user_caps_edit_others_posts_post_types` filter.
* @since 3.37.14 Use strict comparison.
* @since 4.21.2 Add logic to handle the `view_grades` capability.
*
* @param bool[] $allcaps Array of key/value pairs where keys represent a capability name and boolean values
* represent whether the user has that capability.
* @param string[] $cap Required primitive capabilities for the requested capability.
* @param array $args {
* Arguments that accompany the requested capability check.
*
* @type string $0 Requested capability.
* @type int $1 Concerned user ID.
* @type mixed ...$2 Optional second and further parameters, typically object ID.
* }
* @return array
*/
public function handle_caps( $allcaps, $cap, $args ) {
/**
* Modify the list of post types that users may not own but can still edit based on instructor permissions on the course
*
* @since 3.36.5
*
* @param string[] $post_types Array of unprefixed post type names.
*/
$post_types = apply_filters( 'llms_user_caps_edit_others_posts_post_types', array( 'courses', 'lessons', 'sections', 'quizzes', 'questions', 'memberships' ) );
foreach ( $post_types as $cpt ) {
// Allow any instructor to edit courses they're attached to.
if ( in_array( sprintf( 'edit_others_%s', $cpt ), $cap, true ) ) {
$allcaps = $this->edit_others_lms_content( $allcaps, $cap, $args );
}
}
$required_cap = ! empty( $cap[0] ) ? $cap[0] : false;
if ( 'view_grades' === $required_cap ) {
return $this->handle_cap_view_grades( $allcaps, $args );
}
// We don't have a cap or the user doesn't have the requested cap.
if ( ! $required_cap || empty( $allcaps[ $required_cap ] ) ) {
return $allcaps;
}
$user_id = ! empty( $args[1] ) ? $args[1] : false;
$object_id = ! empty( $args[2] ) ? $args[2] : false;
if ( in_array( $required_cap, array( 'edit_users', 'delete_users' ), true ) ) {
if ( $user_id && $object_id && false === $this->user_can_manage_user( $user_id, $object_id ) ) {
unset( $allcaps[ $required_cap ] );
}
}
if ( in_array( $required_cap, array( 'view_students', 'edit_students', 'delete_students' ), true ) ) {
$others_cap = str_replace( '_', '_others_', $required_cap );
if ( $user_id && $object_id && ! user_can( $user_id, $others_cap ) ) {
$instructor = llms_get_instructor( $user_id );
if ( ! $instructor || ! $instructor->has_student( $object_id ) ) {
unset( $allcaps[ $required_cap ] );
}
}
}
return $allcaps;
}
/**
* Determines if the current user is an instructor.
*
* @since 3.34.0
*
* @return bool
*/
public static function is_current_user_instructor() {
return ( current_user_can( 'lifterlms_instructor' ) && current_user_can( 'list_users' ) && ! current_user_can( 'manage_lifterlms' ) );
}
/**
* Determine if a user can manage another user.
*
* Run on `user_has_cap` filters for the `edit_users` and `delete_users` capabilities.
*
* @since 3.34.0
* @since 3.41.0 Better handling of users with multiple roles.
*
* @param int $user_id WP User ID of the user requesting to perform the action.
* @param int $edit_id WP User ID of the user the action will be performed on.
* @return bool|null Returns true if the user performs the action, false if it can't, and null for core user roles which are skipped.
*/
protected function user_can_manage_user( $user_id, $edit_id ) {
$user = get_user_by( 'id', $user_id );
/**
* Filter the list of "ignored" user roles
*
* If a user has one of the roles specified in this list, LifterLMS
* will not attempt to determine if the user can manage other users
* and will instead allow the WordPress core (or another plugin)
* to determine if they have the required permissions.
*
* @since 3.41.0
*
* @param string[] $ignored Array of user roles.
*/
$ignored = apply_filters( 'llms_user_can_manage_user_ignored_roles', array( 'administrator' ) );
$lms_roles = array_keys( LLMS_Roles::get_roles() );
$user_roles = array_intersect( $user->roles, $lms_roles );
$user_ignored_roles = array_intersect( $user->roles, $ignored );
/**
* Skip the user because:
*
* + User has no LMS roles, eg: Administrator, Editor, or Subscriber.
* + User has an LMS role and a "protected" role, eg: Administrator and student.
*
* In both scenarios we will return `null` which signals that the WordPress core (or another plugin)
* should take care of determining if the user can manage the user.
*/
if ( ! $user_roles || ! empty( $user_ignored_roles ) ) {
return null;
}
$edit_id = absint( $edit_id );
$user_id = absint( $user_id );
// Users can edit themselves.
if ( $user_id === $edit_id ) {
return true;
}
$edit_user = get_user_by( 'id', $edit_id );
if ( ! $edit_user ) {
return false;
}
$edit_roles = array_intersect( $edit_user->roles, $lms_roles );
$editable_roles = self::get_editable_roles();
foreach ( $user_roles as $role ) {
if ( 'instructor' === $role && in_array( 'instructors_assistant', $edit_roles, true ) ) {
$instructor = llms_get_instructor( $user );
if ( in_array( $edit_id, array_map( 'absint', $instructor->get_assistants() ), true ) ) {
return true;
}
} elseif ( ! empty( $editable_roles[ $role ] ) && array_intersect( $edit_roles, $editable_roles[ $role ] ) ) {
return true;
}
}
return false;
}
/**
* Determine if an instructor has a student.
*
* @since 7.6.0
*
* @param int $current_user_id WP User ID of the user requesting to perform the action.
* @param int $requested_user_id WP User ID of the user the action will be performed on.
* @return bool Returns true if the user has the student, false if it doesn't
*/
protected function instructor_has_student( $current_user_id, $requested_user_id ) {
$instructor = llms_get_instructor( $current_user_id );
return $instructor && $instructor->has_student( $requested_user_id );
}
}
return new LLMS_User_Permissions();
================================================
FILE: includes/class.llms.view.manager.php
================================================
<?php
/**
* View Manager
*
* Allows qualifying user roles to view as various user types to make easier testing and editing of LLMS Content.
*
* @package LifterLMS/Classes
*
* @since 3.7.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_View_Manager class.
*
* @since 3.7.0
*/
class LLMS_View_Manager {
/**
* Constructor
*
* @since 3.7.0
* @since 4.2.0 Added early return when creating a pending order.
*/
public function __construct() {
// Do nothing if we're creating a pending order.
if ( ! empty( $_POST['action'] ) && 'create_pending_order' === $_POST['action'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
return;
}
add_action( 'init', array( $this, 'add_actions' ) );
}
/**
* Add actions & filters.
*
* @since 3.7.0
* @since 4.2.0 Added filter to handle the displaying of the free enroll.
* @since 4.16.0 Added filters to handle modification of the student dashboard.
* @since 5.9.0 Pass second parameter to `modify_course_open()` methods.
*
* @return void
*/
public function add_actions() {
// Output view links on the admin menu.
add_action( 'admin_bar_menu', array( $this, 'add_menu_items' ), 777 );
// Filter page restrictions.
add_filter( 'llms_page_restricted', array( $this, 'modify_restrictions' ), 10, 1 );
add_filter( 'llms_is_course_open', array( $this, 'modify_course_open' ), 10, 2 );
add_filter( 'llms_is_course_enrollment_open', array( $this, 'modify_course_open' ), 10, 2 );
// Filters we'll only run when view as links are called.
if ( isset( $_GET['llms-view-as'] ) ) { // phpcs:disable WordPress.Security.NonceVerification.Recommended
add_filter( 'llms_is_course_complete', array( $this, 'modify_completion' ), 10, 1 );
add_filter( 'llms_is_lesson_complete', array( $this, 'modify_completion' ), 10, 1 );
add_filter( 'llms_is_track_complete', array( $this, 'modify_completion' ), 10, 1 );
add_filter( 'llms_get_enrollment_status', array( $this, 'modify_enrollment_status' ), 10, 1 );
add_filter( 'llms_display_free_enroll_form', array( $this, 'modify_display_free_enroll_form' ), 10, 1 );
add_filter( 'llms_display_student_dashboard', array( $this, 'modify_dashboard' ), 10, 1 );
add_filter( 'llms_hide_registration_form', array( $this, 'modify_dashboard' ), 10, 1 );
add_filter( 'llms_enable_open_registration', array( $this, 'enable_open_reg' ), 10, 1 );
add_filter( 'llms_hide_login_form', array( $this, 'modify_dashboard' ), 10, 1 );
add_action( 'wp_enqueue_scripts', array( $this, 'scripts' ) );
}
}
/**
* Add view links to the admin menu bar for qualifying users.
*
* @since 3.7.0
* @since 3.16.0 Unknown.
* @since 4.2.0 Updated icon.
* @since 4.5.1 Use `should_display()` method to determine if the view manager should be added to the admin bar.
* @since 4.16.0 Retrieve nodes to add from `get_menu_items_to_add()`.
*
* @param WP_Admin_Bar $wp_admin_bar Admin bar class instance.
* @return void
*/
public function add_menu_items( $wp_admin_bar ) {
if ( ! $this->should_display() ) {
return;
}
foreach ( $this->get_menu_items_to_add() as $node ) {
$wp_admin_bar->add_node( $node );
}
}
/**
* Forces open registration on when previewing the registration form
*
* If open registration is disabled, adds an action to output an info notice at the start
* of the form alerting users that they're viewing a preview.
*
* @since 5.0.0
*
* @param string $status Current open registration status.
* @return string
*/
public function enable_open_reg( $status ) {
if ( ! llms_parse_bool( $status ) ) {
add_action( 'lifterlms_register_form_start', array( $this, 'open_reg_notice' ) );
}
return 'yes';
}
/**
* Inline JS.
*
* Updates links so admins can navigate around quickly when "viewing as".
*
* @since 3.7.0
* @since 3.35.0 Sanitize `$_GET` data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return string
*/
private function get_inline_script() {
ob_start();
?>
window.llms.ViewManager.set_nonce( '<?php echo esc_js( llms_filter_input_sanitize_string( INPUT_GET, 'view_nonce' ) ); ?>' ).set_view( '<?php echo esc_js( $this->get_view() ); ?>' ).update_links();
<?php
return ob_get_clean();
}
/**
* Retrieve an array of nodes to be added to the admin bar
*
* @since 4.16.0
*
* @return array[] An array of arrays formatted to be passed to `WP_Admin_Bar::add_node()`.
*/
private function get_menu_items_to_add() {
$nodes = array();
$view = $this->get_view();
$views = $this->get_views();
$top_id = 'llms-view-as-menu';
// Translators: %s = View manager role name.
$title = sprintf( __( 'Viewing as %s', 'lifterlms' ), $views[ $view ] );
// Add the top-level node.
$nodes[] = array(
'id' => $top_id,
'parent' => 'top-secondary',
'title' => '<span class="ab-icon"><img src="' . llms()->plugin_url() . '/assets/images/lifterlms-icon.png" style="height:17px;margin-top:3px;opacity:0.65;" alt="LifterLMS"></span>' . $title,
);
// Add view as links.
foreach ( $views as $role => $name ) {
// Exclude the current view.
if ( $role === $view ) {
continue;
}
$nodes[] = array(
'href' => self::get_url( $role ),
'id' => 'llms-view-as--' . $role,
'parent' => $top_id,
// Translators: %s = View manager role name.
'title' => sprintf( __( 'View as %s', 'lifterlms' ), $name ),
);
}
return $nodes;
}
/**
* Get a view url for the requested view.
*
* @since 3.7.0
* @since 4.2.0 Take into account already present query args. e.g. ?plan=X.
* @since 4.16.0 Changed method signature to add the `$href` parameter and changed access from private to public static.
*
* @param string $role Role to view the screen as. Accepts "self", "visitor", or "student".
* @param string|false $href Optional. The URL to create a URL for. If `false`, uses `$_SERVER['REQUEST_URI']`.
* @param array $args Optional. Additional query args to add to the url. Default empty array.
* @return string
*/
public static function get_url( $role, $href = false, $args = array() ) {
// If we want to view as "self" we should remove the query vars (if they're set).
if ( 'self' === $role ) {
return remove_query_arg( array( 'llms-view-as', 'view_nonce' ), $href );
}
// Create a new URL.
$args['llms-view-as'] = $role;
$href = add_query_arg( $args, $href );
return html_entity_decode( esc_url( wp_nonce_url( $href, 'llms-view-as', 'view_nonce' ) ) );
}
/**
* Get the current view role/type.
*
* @since 3.7.0
* @since 3.35.0 Sanitize `$_GET` data.
* @since 4.16.0 Don't access `$_GET` directly, use `llms_filter_input()`.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return string
*/
private function get_view() {
if ( ! isset( $_REQUEST['view_nonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['view_nonce'] ) ), 'llms-view-as' ) ) {
return 'self';
}
// Ensure it's a valid view.
$views = $this->get_views();
$view = llms_filter_input( INPUT_GET, 'llms-view-as' );
if ( ! $view || ! isset( $views[ $view ] ) ) {
return 'self';
}
return $view;
}
/**
* Test get_views() method
*
* @since 4.16.0
*
* @return void
*/
public function test_get_views() {
$this->assertEquals( array( 'self', 'visitor', 'student' ), array_keys( LLMS_Unit_Test_Util::call_method( $this->main, 'get_views' ) ) );
}
/**
* Get a list of available views.
*
* @since 3.7.0
*
* @return array
*/
private function get_views() {
return array(
'self' => __( 'Myself', 'lifterlms' ),
'visitor' => __( 'Visitor', 'lifterlms' ),
'student' => __( 'Student', 'lifterlms' ),
);
}
/**
* Modify the completion status of course, lessons, tracks based on current view.
*
* Visitors and students will always show content as not completed.
*
* @since 3.7.0
*
* @param boolean $completed The actual status for the current user.
* @return boolean
*/
public function modify_completion( $completed ) {
switch ( $this->get_view() ) {
case 'visitor':
$status = false;
break;
case 'student':
$status = true;
break;
}
return $completed;
}
/**
* Modify the status of a course access period based on the current view.
*
* Students and Visitors will see the actual access period.
*
* If viewing as self and self can bypass restrictions will appear as if course is open.
*
* @since 3.7.0
* @since 5.9.0 Pass the course ID to `llms_can_user_bypass_restrictions()`.
*
* @param boolean $status The default status.
* @return boolean
*/
public function modify_course_open( $status, $course ) {
if (
'self' === $this->get_view() &&
llms_can_user_bypass_restrictions( get_current_user_id(), $course->get( 'id' ) )
) {
return true;
}
return $status;
}
/**
* Modify the student dashboard
*
* @since 4.16.0
*
* @param boolean $value Default value from the filter.
* @return boolean
*/
public function modify_dashboard( $value ) {
switch ( $this->get_view() ) {
case 'visitor':
$value = false;
break;
case 'student':
$value = true;
break;
}
return $value;
}
/**
* Modify the enrollment status of current user based on the view.
*
* Students will always show as enrolled.
*
* Visitors will always show as not-enrolled.
*
* @since 3.7.0
*
* @param string $status The actual status for the current user.
* @return string
*/
public function modify_enrollment_status( $status ) {
switch ( $this->get_view() ) {
case 'visitor':
$status = false;
break;
case 'student':
$status = 'enrolled';
break;
}
return $status;
}
/**
* Modify the displaying of the free enroll form (free access plans).
*
* Visitors will never be shown the free enroll form.
*
* @since 4.2.0
*
* @param bool $display Whether or not the form is being displayed.
* @return bool
*/
public function modify_display_free_enroll_form( $display ) {
if ( ! $display || 'visitor' === $this->get_view() ) {
return false;
}
return $display;
}
/**
* Modify llms_page_restricted for qualifying users to allow them to bypass restrictions.
*
* @since 3.7.0
* @since 5.9.0 Pass the course ID to `llms_can_user_bypass_restrictions()`.
*
* @param array $restrictions Restriction data.
* @return array
*/
public function modify_restrictions( $restrictions ) {
if (
'self' === $this->get_view() &&
llms_can_user_bypass_restrictions( get_current_user_id(), $restrictions['restriction_id'] )
) {
$restrictions['is_restricted'] = false;
$restrictions['reason'] = 'role-access';
}
return $restrictions;
}
/**
* Output a notice alerting users that open registration is currently disabled
*
* @since 5.0.0
* @since 5.3.3 Added missing textdomain.
*
* @return void
*/
public function open_reg_notice() {
llms_print_notice( __( 'This is a preview of the Open Registration form but Open Registration is currently disabled. Enable Open Registration to allow users to create accounts on this page.', 'lifterlms' ), 'debug' );
}
/**
* Enqueue Scripts.
*
* @since 3.7.0
* @since 3.17.8 Unknown.
* @since 3.35.0 Declare asset version.
*
* @return void
*/
public function scripts() {
// If it's self we don't need anything fancy going on here.
if ( 'self' === $this->get_view() ) {
return;
}
wp_enqueue_script( 'llms-view-manager', LLMS_PLUGIN_URL . '/assets/js/llms-view-manager' . LLMS_ASSETS_SUFFIX . '.js', array( 'jquery' ), llms()->version, true );
wp_add_inline_script( 'llms-view-manager', $this->get_inline_script(), 'after' );
}
/**
* Determine whether or not the view manager should be added to the WP Admin Bar
*
* The view manager is only displayed when the following criteria is met:
* + The current user must have a role that is allowed to bypass LifterLMS restrictions
* + Must be viewing one of the following:
* + a single course, lesson, membership, or quiz
* + LifterLMS checkout page
* + LifterLMS student dashboard page
*
* @since 4.5.1
* @since 4.16.0 Display on the student dashboard.
* @since 5.9.0 When possible, pass the post ID to `llms_can_user_bypass_restrictions()`.
*
* @return boolean
*/
protected function should_display() {
$display = false;
global $post;
$is_restricted_post = $post && ( is_llms_checkout() || is_llms_account_page() || in_array( $post->post_type, array( 'course', 'lesson', 'llms_membership', 'llms_quiz' ), true ) );
$post_id = $is_restricted_post ? $post->ID : null;
if ( llms_can_user_bypass_restrictions( get_current_user_id(), $post_id ) ) {
$display = is_admin() || is_post_type_archive() || ! $post || ! $is_restricted_post ? false : true;
}
/**
* Filters whether or not the "View As..." menu item should be displayed in the WP Admin Bar
*
* @since 4.5.1
*
* @param boolean $display Whether or not the menu item should be displayed.
*/
return apply_filters( 'llms_view_manager_should_display', $display );
}
}
return new LLMS_View_Manager();
================================================
FILE: includes/class.llms.voucher.php
================================================
<?php
/**
* Voucher Class
*
* @package LifterLMS/Classes
*
* @since 2.0.0
* @version 3.37.17
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Voucher class
*
* @since 2.0.0
* @since 3.27.0 Unknown.
* @since 3.37.17 Only allow vouchers to be used if the voucher post is "published".
*/
class LLMS_Voucher {
// phpcs:disable WordPress.DB.PreparedSQL.NotPrepared
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
/**
* ID of the voucher
* This will be a LifterLMS Voucher custom post type Post ID
*
* @var int
*/
protected $id;
/**
* Unprefixed name of the vouchers codes table
*
* @var string
*/
protected $codes_table_name = 'lifterlms_vouchers_codes';
/**
* Unprefixed name of the product to voucher xref table
*
* @var string
*/
protected $product_to_voucher_table = 'lifterlms_product_to_voucher';
/**
* Unprefixed name of the voucher redemptions table
*
* @var string
*/
protected $redemptions_table = 'lifterlms_voucher_code_redemptions';
/**
* Constructor
*
* @since 2.0.0
*
* @param int $id WP_Post ID of the voucher.
* @return void
*/
public function __construct( $id = null ) {
$this->id = $id;
}
/**
* Retrieve the prefixed database table name for the table where voucher codes are stored
*
* @since 2.0.0
*
* @return string
*/
protected function get_codes_table_name() {
global $wpdb;
return $wpdb->prefix . $this->codes_table_name;
}
/**
* Retrieve the prefixed database table name where voucher to product relationships are stored
*
* @since 2.0.0
*
* @return string
*/
protected function get_product_to_voucher_table_name() {
global $wpdb;
return $wpdb->prefix . $this->product_to_voucher_table;
}
/**
* Retrieve the prefixed database table name where voucher redemptions are stored
*
* @since 2.0.0
*
* @return string
*/
protected function get_redemptions_table_name() {
global $wpdb;
return $wpdb->prefix . $this->redemptions_table;
}
/**
* Get voucher title
*
* @since 2.0.0
* @since 3.6.2 Unknown.
*
* @return string
*/
public function get_voucher_title() {
return get_the_title( $this->id );
}
/**
* Get a single voucher code by id
*
* @since 2.0.0
*
* @return obj
*/
public function get_voucher_by_voucher_id() {
global $wpdb;
$table = $this->get_codes_table_name();
$query = "SELECT * FROM $table WHERE `voucher_id` = $this->id AND `is_deleted` = 0 LIMIT 1";
return $wpdb->get_row( $query );
}
/**
* Get a single voucher code by string
*
* @since 2.0.0
*
* @param string $code Voucher code string.
* @return obj
*/
public function get_voucher_by_code( $code ) {
global $wpdb;
$table = $this->get_codes_table_name();
$redeemed_table = $this->get_redemptions_table_name();
$sql = $wpdb->prepare(
"SELECT c.*, count(r.id) as used
FROM $table as c
LEFT JOIN $redeemed_table as r
ON c.`id` = r.`code_id`
WHERE c.`code` = %s AND c.`is_deleted` = 0
GROUP BY c.`id`
LIMIT 1",
$code
);
return $wpdb->get_row( $sql );
}
/**
* Get a list of voucher codes
*
* @since 2.0.0
*
* @param string $format Return format.
* @return array
*/
public function get_voucher_codes( $format = 'OBJECT' ) {
global $wpdb;
$table = $this->get_codes_table_name();
$redeemed_table = $this->get_redemptions_table_name();
$query = "SELECT c.*, count(r.id) as used
FROM $table as c
LEFT JOIN $redeemed_table as r
ON c.`id` = r.`code_id`
WHERE `voucher_id` = $this->id AND `is_deleted` = 0
GROUP BY c.id";
return $wpdb->get_results( $query, $format );
}
/**
* Retrieve a voucher by ID.
*
* @since 2.0.0
*
* @param int $code_id Voucher code ID.
* @return object
*/
public function get_voucher_code_by_code_id( $code_id ) {
global $wpdb;
$table = $this->get_codes_table_name();
$query = $wpdb->prepare( 'SELECT * FROM $table WHERE `id` = %d AND `is_deleted` = 0 LIMIT 1', $code_id );
return $wpdb->get_row( $query );
}
/**
* Save a voucher code
*
* @since 2.0.0
*
* @param array $data Voucher data.
* @return int|false The number of rows inserted, or false on error.
*/
public function save_voucher_code( $data ) {
global $wpdb;
$data['voucher_id'] = $this->id;
$data['created_at'] = date( 'Y-m-d H:i:s' );
$data['updated_at'] = date( 'Y-m-d H:i:s' );
return $wpdb->insert( $this->get_codes_table_name(), $data );
}
/**
* Update a voucher code.
*
* @since 2.0.0
*
* @param array $data Array of voucher data.
* @return int|bool The number of rows updated, or false on error.
*/
public function update_voucher_code( $data ) {
global $wpdb;
$data['updated_at'] = date( 'Y-m-d H:i:s' );
$where = array(
'id' => $data['id'],
);
unset( $data['id'] );
return $wpdb->update( $this->get_codes_table_name(), $data, $where );
}
/**
* Delete a voucher code.
*
* @since 2.0.0
*
* @param int $id Voucher code id.
* @return int}bool The number of rows updated, or false on error.
*/
public function delete_voucher_code( $id ) {
global $wpdb;
$data['updated_at'] = date( 'Y-m-d H:i:s' );
$data['is_deleted'] = 1;
$where = array(
'id' => $id,
);
unset( $data['id'] );
return $wpdb->update( $this->get_codes_table_name(), $data, $where );
}
/**
* Determine if a voucher is valid
*
* @since 2.0.0
* @since 3.0.0 Unknown.
* @since 3.37.17 Ensure the code's parent post is published.
*
* @param string $code Voucher code.
* @return WP_Error|object WP_Error if invalid or not redeemable OR a voucher data object.
*/
public function check_voucher( $code ) {
$voucher = $this->get_voucher_by_code( $code );
if ( empty( $voucher ) ) {
return new WP_Error( 'not-found', sprintf( __( 'Voucher code "%s" could not be found.', 'lifterlms' ), $code ) );
} elseif ( $voucher->redemption_count <= $voucher->used ) {
return new WP_Error( 'max', sprintf( __( 'Voucher code "%s" has already been redeemed the maximum number of times.', 'lifterlms' ), $code ) );
} elseif ( '1' === $voucher->is_deleted || 'publish' !== get_post_status( $voucher->voucher_id ) ) { // @todo because get_voucher_code() adds `is_deleted=0` we should never get here, I think.
return new WP_Error( 'deleted', sprintf( __( 'Voucher code "%s" is no longer valid.', 'lifterlms' ), $code ) );
}
return $voucher;
}
/**
* Attempt to redeem a voucher for a user with a code
*
* @since 2.0.0
* @since 3.27.0 Unknown.
*
* @param string $code Voucher code of the voucher being redeemed.
* @param int $user_id WP_User ID of the user redeeming the voucher.
* @return bool|WP_Error Error object on failure, `true` when successful.
*/
public function use_voucher( $code, $user_id ) {
$code = sanitize_text_field( $code );
$voucher = $this->check_voucher( $code );
if ( ! is_wp_error( $voucher ) ) {
$this->id = $voucher->voucher_id;
// Ensure the user hasn't already redeemed this voucher.
if ( $this->get_redemptions_for_code_by_user( $voucher->id, $user_id ) ) {
return new WP_Error( 'error', __( 'You have already redeemed this voucher.', 'lifterlms' ) );
}
// Get products linked to the voucher.
$products = $this->get_products();
if ( ! empty( $products ) ) {
// Loop through all of them and attempt enrollment.
foreach ( $products as $product ) {
llms_enroll_student( $user_id, $product, 'voucher' );
}
/**
* Perform action before voucher redeemed.
*
* Action to perform before the voucher redeemed.
*
* @since 2.2.1
* @since 3.24.1 Added $voucher_title parameter.
* @since 3.27.0 Changed $voucher_title to $voucher_code to fix undefined property notice.
*
* @param int $voucher_id Voucher id of the voucher being redeemed.
* @param int $user_id WP_User ID of the user redeeming the voucher.
* @param string $voucher_code Voucher code of the voucher being redeemed.
*/
do_action( 'llms_voucher_used', $voucher->id, $user_id, $voucher->code );
// Use voucher code.
$data = array(
'user_id' => $user_id,
'code_id' => $voucher->id,
);
$this->save_redeemed_code( $data );
return true;
}
} else {
return $voucher;
}
}
/**
* Redeemed Codes
*
* @since 2.0.0
*
* @return array
*/
public function get_redeemed_codes( $format = 'OBJECT' ) {
global $wpdb;
$table = $this->get_codes_table_name();
$redeemed_table = $this->get_redemptions_table_name();
$users_table = $wpdb->prefix . 'users';
$query = "SELECT r.`id`, c.`id` as code_id, c.`voucher_id`, c.`code`, c.`redemption_count`, r.`user_id`, u.`user_email`, r.`redemption_date`
FROM $table as c
JOIN $redeemed_table as r
ON c.`id` = r.`code_id`
JOIN $users_table as u
ON r.`user_id` = u.`ID`
WHERE c.`is_deleted` = 0 AND c.`voucher_id` = $this->id";
return $wpdb->get_results( $query, $format );
}
/**
* Retrieve the number of times a voucher was redeemed by a specific user
*
* Hint, it should always be 1 or 0
*
* @since 2.0.0
*
* @param int $code_id Voucher Code ID from wp_lifterlms_vouchers_codes table.
* @param int $user_id User ID from wp_users tables.
* @return int
*/
public function get_redemptions_for_code_by_user( $code_id, $user_id ) {
global $wpdb;
return $wpdb->get_var(
$wpdb->prepare(
"SELECT count(id) FROM {$this->get_redemptions_table_name()} WHERE user_id = %d and code_id = %d", // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
array( $user_id, $code_id )
)
);
}
/**
* Save redeemed code
*
* @since 2.0.0
*
* @param array $data Voucher data.
* @return int|false The number of rows updated, or false on error.
*/
public function save_redeemed_code( $data ) {
global $wpdb;
$data['redemption_date'] = date( 'Y-m-d H:i:s' );
return $wpdb->insert( $this->get_redemptions_table_name(), $data );
}
/**
* Get an array of IDs for products associated with this voucher
*
* @since 2.0.0
* @since 3.24.0 Unknown.
*
* @param string $post_type Allows filtering of products by post type.
* @return array
*/
public function get_products( $post_type = 'any' ) {
global $wpdb;
$table = $this->get_product_to_voucher_table_name();
$products = $wpdb->get_col( $wpdb->prepare( "SELECT product_id FROM {$table} WHERE `voucher_id` = %d;", $this->id ) ); //phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
if ( ! empty( $products ) ) {
// Filter any products that don't match the supplied post type.
if ( 'any' !== $post_type ) {
foreach ( $products as $i => $id ) {
if ( get_post_type( $id ) !== $post_type ) {
unset( $products[ $i ] );
}
}
}
// Convert all elements to ints.
$products = array_map( 'intval', $products );
}
return $products;
}
/**
* Determine if the product is linked to a voucher by code
*
* @since 2.0.0
*
* @param string $code Voucher code string.
* @param int $product_id WP_Post ID of the product (course or membership).
* @return boolean
*/
public function is_product_to_voucher_link_valid( $code, $product_id ) {
$voucher = $this->check_voucher( $code );
if ( $voucher ) {
$this->id = $voucher->voucher_id;
$products = $this->get_products();
if ( ! empty( $products ) && in_array( $product_id, $products ) ) {
return true;
}
}
return false;
}
/**
* Dupcheck generated voucher codes.
*
* @since 2.0.0
* @since 3.35.0 Prepare SQL.
*
* @param string[] $codes Array of voucher code strings.
* @return boolean
*/
public function is_code_duplicate( $codes ) {
global $wpdb;
$codes_as_string = join( '","', $codes );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$codes = $wpdb->get_results(
$wpdb->prepare(
"SELECT code
FROM {$this->get_codes_table_name()}
WHERE code IN ( {$codes_as_string} )
AND voucher_id != %d",
array( $this->id )
),
ARRAY_A
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
if ( count( $codes ) ) {
return $codes;
}
return false;
}
/**
* Save products to a voucher
*
* @since 2.0.0
*
* @param int $product_id WP_Post ID of the product (course or membership).
* @return int|false The number of rows updated, or false on error.
*/
public function save_product( $product_id ) {
global $wpdb;
$data['voucher_id'] = $this->id;
$data['product_id'] = $product_id;
return $wpdb->insert( $this->get_product_to_voucher_table_name(), $data );
}
/**
* Delete products from a voucher
*
* @since 2.0.0
*
* @return int
*/
public function delete_products() {
global $wpdb;
return $wpdb->delete(
$this->get_product_to_voucher_table_name(),
array(
'voucher_id' => $this->id,
)
);
}
}
// phpcs:enable WordPress.DB.PreparedSQL.NotPrepared
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
================================================
FILE: includes/controllers/class-llms-controller-awards.php
================================================
<?php
/**
* LLMS_Controller_Awards class
*
* @package LifterLMS/Controllers/Classes
*
* @since 6.0.0
* @version 6.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Callback controller for award posts.
*
* Handles actions for `llms_my_achievement` and `llms_my_certificate` post types.
*
* @since 6.0.0
*/
class LLMS_Controller_Awards {
/**
* List of supported post types.
*
* @var string[]
*/
private static $post_types = array(
'llms_my_achievement',
'llms_my_certificate',
);
/**
* Constructor.
*
* @since 6.0.0
* @return void
*/
public static function init() {
foreach ( self::$post_types as $post_type ) {
$unprefixed = self::strip_prefix( $post_type );
add_action( "llms_user_earned_{$unprefixed}", array( __CLASS__, 'on_earn' ), 20, 2 );
add_action( "save_post_{$post_type}", array( __CLASS__, 'on_save' ), 20 );
}
add_action( 'rest_after_insert_llms_my_certificate', array( __CLASS__, 'on_rest_insert' ), 20, 3 );
}
/**
* Convert post type to award type.
*
* @since 6.0.0
*
* @param string $post_type A post type string.
* @return string
*/
private static function strip_prefix( $post_type ) {
return llms_strip_prefixes( $post_type, array( 'llms_my_' ) );
}
/**
* Retrieves the award post model for the given WP_Post.
*
* @since 6.0.0
*
* @param integer $post_id WP_Post ID.
* @return boolean|LLMS_User_Achievement|LLMS_User_Certificate Returns `false` for invalid post types.
* Otherwise returns the post model object.
*/
private static function get_object( $post_id ) {
$post_type = get_post_type( $post_id );
if ( ! in_array( $post_type, self::$post_types, true ) ) {
return false;
}
$class_name = sprintf( 'LLMS_User_%s', ucwords( self::strip_prefix( $post_type ) ) );
return new $class_name( $post_id );
}
/**
* Records a timestamp when the award is earned.
*
* @since 6.0.0
*
* @param int $user_id WP_User ID of the user who earned the certificate.
* @param int $post_id WP_Post ID of the certificate post.
* @return boolean|string Returns `false` if the certificate could not be loaded, otherwise returns the current
* timestamp in MySQL format.
*/
public static function on_earn( $user_id, $post_id ) {
$obj = self::get_object( $post_id );
if ( ! $obj ) {
return false;
}
$ts = llms_current_time( 'mysql' );
$obj->set( 'awarded', $ts );
return $ts;
}
/**
* Awarded certificate REST API insertion callback.
*
* Automatically syncs an awarded certificate with its parent when inserted via the REST API and
* sets a unique post name (slug).
*
* This method relies on the fact that there is (currently) no native way to insert an awarded
* certificate into the database via the REST API with a linked parent template without using the
* `AwardCertificateButton` Javascript component. The component sets the parent and student and allows
* this callback function to perform the remaining (necessary) sync operations.
*
* @since 6.0.0
*
* @param stdClass $post The post object.
* @param WP_Rest_Request $request Rest request object.
* @param boolean $creating Whether or not the post is being created.
* @return integer Returns an integer, primarily for unit tests: `0` if the insertion is an update,
* `1` if the post has not parent, and `2` when the certificate is synced and updated.
*/
public static function on_rest_insert( $post, $request, $creating ) {
if ( ! $creating ) {
return 0;
}
$cert = self::get_object( $post->ID );
if ( ! $cert->get( 'parent' ) ) {
return 1;
}
add_filter( 'llms_certificate_merge_data', array( __CLASS__, 'on_rest_insert_merge_data' ) );
$cert->sync( 'create' );
$cert->set( 'name', llms()->certificates()->get_unique_slug( $cert->get( 'title' ) ) );
remove_filter( 'llms_certificate_merge_data', array( __CLASS__, 'on_rest_insert_merge_data' ) );
return 2;
}
/**
* Modifies the merge data used when awarded a certificate using the REST API.
*
* This removes the `{sequential_id}` merge data. When creating the draft we don't want to use
* the default `1` or whatever the parent's ID is. If we use `1` that's just generally incorrect and
* if we use the parent's ID it might become the wrong ID by the time the certificate is published / awarded.
*
* Removing this will not merge the ID but on awarding the ID will be automatically merged with other merge codes.
*
* @since 6.0.0
*
* @param array $merge_data Merge data.
* @return array
*/
public static function on_rest_insert_merge_data( $merge_data ) {
unset( $merge_data['{sequential_id}'] );
return $merge_data;
}
/**
* Callback function when a post is saved or updated.
*
* This method automatically merges the certificates `post_content` and additionally triggers
* the creation actions to be fired if the certificate is newly created.
*
* @since 6.0.0
* @since 6.4.0 Added replacement of references to reusable blocks with their actual blocks.
*
* @param int $post_id WP_Post ID of the certificate.
* @return boolean Returns `true` if the certificate can't be loaded, otherwise returns `true`.
*/
public static function on_save( $post_id ) {
$obj = self::get_object( $post_id );
if ( ! $obj || 'publish' !== $obj->get( 'status' ) ) {
return false;
}
$post_type = get_post_type( $post_id );
remove_action( "save_post_{$post_type}", array( __CLASS__, 'on_save' ), 20 );
$is_awarded = $obj->is_awarded();
if ( 'llms_my_certificate' === $post_type ) {
if ( ! $is_awarded ) {
$obj->update_sequential_id();
}
/**
* Whenever an awarded certificate is updated, we want to re-merge the content
* in the event that any shortcodes or merge codes were added.
*/
$content = $obj->get( 'content', true );
$obj->set( 'content', $obj->merge_content( $content, true ) );
}
/**
* If the award is being published for the first time, trigger the creation actions.
*/
if ( ! $obj->is_awarded() ) {
LLMS_Engagement_Handler::create_actions(
self::strip_prefix( $post_type ),
$obj->get_user_id(),
$post_id,
$obj->get( 'related' ),
$obj->get( 'engagement' )
);
}
add_action( "save_post_{$post_type}", array( __CLASS__, 'on_save' ), 20 );
return true;
}
}
return LLMS_Controller_Awards::init();
================================================
FILE: includes/controllers/class-llms-controller-checkout.php
================================================
<?php
/**
* LLMS_Controller_Checkout
*
* @package LifterLMS/Controllers/Classes
*
* @since 7.0.0
* @version 7.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Checkout form controller.
*
* Processes orders and interacts with payment gateway classes during checkout.
*
* @since 7.0.0
*/
class LLMS_Controller_Checkout {
use LLMS_Trait_Singleton;
/**
* Action for creating a pending order.
*
* Used as both the nonce and the posted `action` field.
*/
public const ACTION_CREATE_PENDING_ORDER = 'create_pending_order';
/**
* Action for confirming a pending order.
*
* Used as both the nonce and the posted `action` field.
*/
public const ACTION_CONFIRM_PENDING_ORDER = 'confirm_pending_order';
/**
* Action for switching the payment source for an order.
*
* Used as the nonce action.
*/
public const ACTION_SWITCH_PAYMENT_SOURCE = 'llms_switch_order_source';
/**
* Query string variable used to identify AJAX order requests.
*/
public const AJAX_QS_VAR = 'llms-checkout';
/**
* Constructor.
*
* @since 7.0.0
*
* @return void
*/
private function __construct() {
$actions = array(
'create_pending_order',
'confirm_pending_order',
'switch_payment_source',
);
foreach ( $actions as $action ) {
add_action( 'init', array( $this, "{$action}_ajax" ), 5 );
add_action( 'init', array( $this, $action ) );
}
}
/**
* Checkout confirm order controller.
*
* Called via the confirm order form (via user form submission) or programmatically by payment gateways which
* require an order confirmation step. PayPal is a two-step checkout that requires confirmation
* whereas Stripe is a one-step checkout without a confirmation step.
*
* Validates all submitted data and passes the validated `LLMS_Order` object to the payment gateway's
* `confirm_pending_order()` method for further processing.
*
* If an error is encountered the method short circuits and adds an error notice via {@see llms_add_notice()},
* during gateway processing the same pattern should be observed.
*
* Upon success, gateways should perform a redirect to the appropriate URL (course, membership, etc...).
*
* Note that this method is widely used but the AJAX equivalent, {@see LLMS_Controller_Checkout::confirm_pending_order_ajax()},
* is preferred when implementing a new gateway.
*
* @since 7.0.0 Relocated from `LLMS_Controller_Orders`.
*
* @return null|boolean|void Returns `null` when the form isn't submitted or there's a nonce verification issue.
* Returns `false` when the the request is missing the action parameter or the action doesn't match
* the expected action. Otherwise there is no/void return.
*/
public function confirm_pending_order() {
// Verify form submission.
$verify = $this->verify_request( '_wpnonce', self::ACTION_CONFIRM_PENDING_ORDER );
if ( ! $verify ) {
return $verify;
}
// Ensure we have an order key we can locate the order with.
$key = llms_filter_input_sanitize_string( INPUT_POST, 'llms_order_key' );
if ( ! $key ) {
return llms_add_notice( __( 'Could not locate an order to confirm.', 'lifterlms' ), 'error' );
}
// Lookup the order & return error if not found.
$order = llms_get_order_by_key( $key );
if ( ! $order || ! $order instanceof LLMS_Order ) {
return llms_add_notice( __( 'Could not locate an order to confirm.', 'lifterlms' ), 'error' );
}
// Can the order be confirmed?
if ( ! $order->can_be_confirmed() ) {
return llms_add_notice( __( 'Only pending orders can be confirmed.', 'lifterlms' ), 'error' );
}
// Get the gateway.
$gateway = llms()->payment_gateways()->get_gateway_by_id( $order->get( 'payment_gateway' ) );
// Pass the order to the gateway.
$gateway->confirm_pending_order( $order );
}
/**
* AJAX checkout confirm order controller.
*
* Verifies the AJAX request, passes `$_POST` data to the `LLMS_Order_Generator`, and outputs a JSON response.
*
* Initiated via the confirm order form (via user form submission) or programmatically by payment gateways which
* require an order confirmation step. PayPal is a two-step checkout that requires confirmation
* whereas Stripe is a one-step checkout without a confirmation step.
*
* @since 7.0.0
*
* @return null|boolean|void Returns `null` when the form isn't submitted or there's a nonce verification issue.
* Returns `false` when the the request is missing the action parameter or the action doesn't match
* the expected action. Otherwise there is no return and a JSON response is output.
*/
public function confirm_pending_order_ajax() {
$verify = $this->verify_request( self::AJAX_QS_VAR, self::ACTION_CONFIRM_PENDING_ORDER );
if ( ! $verify ) {
return $verify;
}
$this->start_ajax( 'confirm_pending_order' );
// Confirm the order.
$generator = new LLMS_Order_Generator( $_POST ); // phpcs:ignore WordPress.Security.NonceVerification.Missing -- Nonce verified via `verify_request()`.
$this->send_json( $generator->confirm() );
}
/**
* Checkout new order controller.
*
* Handles form submission of the checkout form for new (or pending) orders.
*
* Verifies the request, validates request data, creates/updates the user, and creates/updates
* the order post.
*
* If the order is created successfully the order, access plan, student, and coupon data
* is passed to the payment gateway's `handle_pending_order()` method for further processing.
*
* If errors are encountered they are displayed to the user via {@see llms_add_notice()} and execution
* of the method is halted early. Gateways should do the same if they encounter errors during processing.
*
* This method also handles free enrollment form submission from the access plan button (on pricing tables, etc...).
* In the event of validation issues during free enrollment form submission the user is automatically redirect to checkout
* where the validation issues will be displayed.
*
* Upon success the gateway should redirect the user to the relevant next step. For multi-step checkout that
* requires payment confirmation, the user should be redirected to the order confirmation page, for one-step
* gateways assuming the order is moved to active or completed status and enrollment takes place, the user
* should be redirected to the relevant course or membership URL.
*
* @since 7.0.0 Moved from `LLMS_Controller_Orders.
*
* @return null|boolean|void Returns `null` when the form isn't submitted or there's a nonce verification issue.
* Returns `false` when the the request is missing the action parameter or the action doesn't match
* the expected action. Otherwise there is no/void return.
*/
public function create_pending_order() {
$verify = $this->verify_request( '_llms_checkout_nonce', self::ACTION_CREATE_PENDING_ORDER );
if ( ! $verify ) {
return $verify;
}
@set_time_limit( 0 ); // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
/**
* Allow 3rd parties to perform their own validation prior to standard validation.
*
* If this returns a truthy, we'll stop processing.
*
* The extension should add a notice in addition to returning the truthy.
*
* @since Unknown
*
* @param boolean $valid Validation status. If `true` ceases checkout execution. If `false` checkout proceeds.
*/
if ( apply_filters( 'llms_before_checkout_validation', false ) ) {
return false;
}
$setup_data = $this->extract_setup_data( wp_unslash( $_POST ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing -- Nonce verified via `verify_request()`.
// Setup the pending order.
$setup = llms_setup_pending_order( $setup_data );
if ( is_wp_error( $setup ) ) {
llms_add_notice( $setup->get_error_message(), 'error' );
/*
* If the free enroll form is being submitted and there were validation issues this will redirect
* to the checkout page in favor of returning an error.
*/
$this->maybe_redirect_from_free_enroll_form( $setup_data['plan_id'], llms_filter_input( INPUT_POST, 'form' ) ); // phpcs:ignore WordPress.Security.NonceVerification.Missing -- Nonce verified via `verify_request()`.
return $setup;
}
/**
* Allow gateways, extensions, etc to do their own validation.
*
* After all standard validations are successfully.
*
* If this returns a truthy, we'll stop processing.
* The extension should add a notice in addition to returning the truthy.
*
* @since Unknown
*
* @param boolean $stop_processing When a `true`, we'll stop processing. Default is `false`.
*/
if ( apply_filters( 'llms_after_checkout_validation', false ) ) {
return false;
}
$order_id = 'new';
// Get order ID by Key if it exists.
if ( ! empty( $_POST['llms_order_key'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing -- Nonce verified via `verify_request()`.
$locate = llms_get_order_by_key( llms_filter_input_sanitize_string( INPUT_POST, 'llms_order_key' ), 'id' );
if ( $locate ) {
$order_id = $locate;
}
}
// Instantiate the order.
$order = new LLMS_Order( $order_id );
// If there's no id we can't proceed, return an error.
if ( ! $order->get( 'id' ) ) {
return llms_add_notice( __( 'There was an error creating your order, please try again.', 'lifterlms' ), 'error' );
}
// Add order key to globals so the order can be retried if processing errors occur.
$_POST['llms_order_key'] = $order->get( 'order_key' );
$order->init( $setup['person'], $setup['plan'], $setup['gateway'], $setup['coupon'] );
// Pass to the gateway to start processing.
$setup['gateway']->handle_pending_order( $order, $setup['plan'], $setup['person'], $setup['coupon'] );
}
/**
* AJAX checkout new order controller.
*
* Handles AJAX form submission of the checkout form for new (or pending) orders.
*
* Verifies the AJAX request, passes the `$_POST` data to {@see LLMS_Order_Generator::generate},
* hands the resulting order and data to the gateway's `handle_pending_order()` method and then
* outputs a JSON response object.
*
* @since 7.0.0
*
* @return null|boolean|void Returns `null` when the form isn't submitted or there's a nonce verification issue.
* Returns `false` when the the request is missing the action parameter or the action doesn't match
* the expected action. Otherwise there is no return and a JSON response is output.
*/
public function create_pending_order_ajax() {
$verify = $this->verify_request( self::AJAX_QS_VAR, self::ACTION_CREATE_PENDING_ORDER );
if ( ! $verify ) {
return $verify;
}
$this->start_ajax( 'create_pending_order' );
// Generate the order.
$generator = new LLMS_Order_Generator( $_POST ); // phpcs:ignore WordPress.Security.NonceVerification.Missing -- Nonce verified via `verify_request()`.
$order = $generator->generate( $generator::UA_VALIDATE );
if ( is_wp_error( $order ) ) {
$this->send_json( $order );
}
// Pending order creation success, pass it over to the gateway.
$handle = $generator->get_gateway()->handle_pending_order(
$order,
$generator->get_plan(),
$generator->get_user_data(),
$generator->get_coupon()
);
// Automatically add the order key to non-error return arrays.
if ( ! is_wp_error( $handle ) ) {
$handle['order_key'] = $order->get( 'order_key' );
}
$this->send_json( $handle );
}
/**
* Extracts data from `$_POST` into an array that can be passed into `llms_setup_pending_order()`.
*
* @since 7.0.0
*
* @param array $posted_data Data array, from `$_POST`.
* @return array
*/
private function extract_setup_data( $posted_data ) {
$plan_id = absint( $posted_data['llms_plan_id'] ?? 0 );
$data = array(
'plan_id' => $plan_id,
'agree_to_terms' => llms_parse_bool( $posted_data['llms_agree_to_terms'] ?? '' ),
'coupon_code' => sanitize_text_field( $posted_data['llms_coupon_code'] ?? '' ),
'customer' => $this->extract_user_data( $posted_data, $plan_id ),
'payment_gateway' => sanitize_text_field( $posted_data['llms_payment_gateway'] ?? '' ),
);
return $data;
}
/**
* Extracts user registration / update information from a posted data array.
*
* @since 7.0.0
*
* @param array $posted_data Raw $_POST (or similar) data.
* @return array
*/
private function extract_user_data( $posted_data, $plan_id ) {
$user_data = array();
$plan = $plan_id ? llms_get_post( $plan_id ) : false;
$uid = get_current_user_id();
if ( $uid ) {
$user_data['user_id'] = $uid;
}
foreach ( LLMS_Forms::instance()->get_form_fields( 'checkout', compact( 'plan' ) ) as $field ) {
if ( isset( $posted_data[ $field['name'] ] ) ) {
$user_data[ $field['name'] ] = $posted_data[ $field['name'] ];
}
}
return $user_data;
}
/**
* Retrieves the AJAX URL for the requested action.
*
* @since 7.0.0
*
* @param string $action A checkout action. Expects a class action constant: `LLMS_Controller_Checkout::ACTION_*`.
* @return string
*/
public function get_url( $action ) {
return add_query_arg(
self::AJAX_QS_VAR,
wp_create_nonce( $action ),
get_site_url()
);
}
/**
* Handles redirection during {@see LLMS_Controller_Checkout::create_pending_order()} if validation errors are encountered
* via the free checkout/enrollment form.
*
* @since 7.0.0
*
* @param int $plan_id WP_Post ID of the access plan.
* @param string $form Value of the posted `form`, should be `free_enroll`.
* @return null|bool|void Returns `null` when called in an invalid context, `false` if the supplied access plan ID is invalid,
* and `void` when a redirect is performed to the checkout page.
*/
private function maybe_redirect_from_free_enroll_form( $plan_id, $form ) {
// Not the free enroll form.
if ( ! get_current_user_id() || 'free_enroll' !== $form || ! $plan_id ) {
return null;
}
// Invalid plan submitted.
$plan = llms_get_post( $plan_id );
if ( ! is_a( $plan, 'LLMS_Access_Plan' ) ) {
return false;
}
// Redirect to the checkout screen.
llms_redirect_and_exit( $plan->get_checkout_url() );
}
/**
* Sends a JSON response.
*
* @since 7.0.0
*
* @param array|WP_Error $data Response data.
* @return void
*/
private function send_json( $data ) {
wp_send_json( $data, is_wp_error( $data ) ? 400 : 200 );
}
/**
* Denotes an AJAX request in this method has started.
*
* This method "alerts" WordPress that an AJAX request is being processed. This is important, primarily, for
* testing purposes as `wp_send_json()` will call `wp_die()` when doing ajax as opposed to `die()` when not
* doing ajax. This helps us unit test better.
*
* Secondly, this will remove the non-ajax action callback of the method's name ensuring that the non-ajax version doesn't
* run immediately behind the ajax version.
*
* @since 7.0.0
*
* @param string $method Name of the non-ajax method to remove.
* @return void
*/
private function start_ajax( $method ) {
// Tell WP we're doing AJAX.
add_filter( 'wp_doing_ajax', '__return_true' );
// Don't process the non-ajax method.
remove_action( 'init', array( $this, $method ) );
}
/**
* Handle form submission of the "Update Payment Method" form on the student dashboard when viewing a single order.
*
* @since 7.0.0 Relocated from `LLMS_Controller_Orders`.
*
* @return void
*/
public function switch_payment_source() {
// Invalid nonce or the form wasn't submitted.
if ( ! isset( $_REQUEST['_switch_source_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_switch_source_nonce'] ) ), self::ACTION_SWITCH_PAYMENT_SOURCE ) ) {
return;
}
$data = $this->switch_payment_source_setup();
if ( is_wp_error( $data ) ) {
return llms_add_notice( $data->get_error_message(), 'error' );
}
// Handoff to the gateway.
llms()->payment_gateways()->get_gateway_by_id( $data['new_gateway'] )->handle_payment_source_switch( $data['order'], $_POST );
if ( ! llms_notice_count( 'error' ) ) {
$this->switch_payment_source_success( $data );
}
}
/**
* Handle ajax payment method switching from the student dashboard.
*
* @since 7.0.0
*
* @return void
*/
public function switch_payment_source_ajax() {
// Invalid nonce or the form wasn't submitted.
if ( ! isset( $_REQUEST[ self::AJAX_QS_VAR ] ) ) {
return null;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST[ self::AJAX_QS_VAR ] ) ), self::ACTION_SWITCH_PAYMENT_SOURCE ) ) {
return null;
}
$this->start_ajax( 'switch_payment_source' );
$data = $this->switch_payment_source_setup();
if ( is_wp_error( $data ) ) {
$this->send_json( $data );
}
// Handoff to the gateway.
$gateway_res = llms()->payment_gateways()->get_gateway_by_id( $data['new_gateway'] )->handle_payment_source_switch( $data['order'], $_POST );
$next_action = is_wp_error( $gateway_res ) ?
false :
/**
* Filters the next action when switching payment sources.
*
* Defaults to `COMPLETE` when gateways don't return a value via `next_action`
* in the response array.
*
* The `COMPLETE` action records the switch, updates the payment method, and changes
* `pending-cancel` to `active` status.
*
* Any other status will do nothing and the gateway should provide it's necessary logic in the
* {@see LLMS_Payment_Gateway::handle_payment_source_switch()} method.
*
* This is used by gateways such as PayPal that require a creation and approval step on PayPal as opposed
* to a gateway like Stripe that doesn't require end-user approval on the Stripe platform.
*
* @since 7.0.0
*
* @param type $arg Description.
*/
apply_filters(
'llms_switch_payment_source_next_action',
$gateway_res['next_action'] ?? 'COMPLETE',
$gateway_res,
$data
);
if ( 'COMPLETE' === $next_action ) {
$this->switch_payment_source_success( $data, true );
}
$this->send_json( $gateway_res );
}
/**
* Validates and parses user-submitted `$_POST` data during payment source switching.
*
* @since 7.0.0
*
* @return WP_Error|array {
* An error object or an associative array on success.
*
* @type string $old_gateway The ID of the order's previous payment gateway.
* @type string $new_gateway The ID of the order's new payment gateway.
* @type LLMS_Order $order The order object.
* }
*/
private function switch_payment_source_setup() {
$order_id = llms_filter_input( INPUT_POST, 'order_id', FILTER_SANITIZE_NUMBER_INT );
if ( ! $order_id ) {
return new WP_Error( 'switch-source-order-missing', __( 'Missing order information.', 'lifterlms' ), 'error' );
}
$order = llms_get_post( $order_id );
if ( ! is_a( $order, 'LLMS_Order' ) || get_current_user_id() !== $order->get( 'user_id' ) ) {
return new WP_Error( 'switch-source-order-invalid', __( 'Invalid order.', 'lifterlms' ), 'error' );
}
$new_gateway = llms_filter_input_sanitize_string( INPUT_POST, 'llms_payment_gateway' );
if ( empty( $new_gateway ) ) {
return new WP_Error( 'switch-source-gateway-missing', __( 'Missing gateway information.', 'lifterlms' ), 'error' );
}
$old_gateway = $order->get( 'payment_gateway' );
$can_process = llms_can_gateway_be_used_for_plan_or_order( $new_gateway, $order, true );
if ( is_wp_error( $can_process ) ) {
return $can_process;
}
// Prevent tampering with the form action and ensure the submitted action matches the expected action for the order.
$action = llms_filter_input( INPUT_POST, 'llms_switch_action' );
if ( empty( $action ) || $order->get_switch_source_action() !== $action ) {
return new WP_Error( 'switch-source-action-invalid', __( 'Invalid action.', 'lifterlms' ), 'error' );
}
// Temporarily store the gateway IDs so the previous values are accessible to the old gateway after the source switch.
$order->set(
'temp_gateway_ids',
/**
* Filters the gateway IDs that are temporarily stored during a payment source switch.
*
* @since 7.0.0
*
* @param array $temp_ids {
* An array of gateway-related IDs to be temporarily cached.
*
* @type string customer The value of the `gateway_customer_id` property.
* @type string source The value of the `gateway_source_id` property.
* @type string subscription The value of the `gateway_subscription_id` property.
* }
* @param LLMS_Order $order The order object.
*/
apply_filters(
'llms_order_set_temp_gateway_ids',
array(
'customer' => $order->get( 'gateway_customer_id' ),
'source' => $order->get( 'gateway_source_id' ),
'subscription' => $order->get( 'gateway_subscription_id' ),
),
$order
)
);
return compact( 'old_gateway', 'new_gateway', 'order' );
}
/**
* Action run following a successful payment source switch.
*
* @since 7.0.0
*
* @param array $args Payment switch arguments from {@see LLMS_Controller_Checkout::switch_payment_source_setup()}.
* @param bool $note If `true`, automatically records an order note for the source the switch.
* @return void
*/
private function switch_payment_source_success( $args, $note = false ) {
$order = $args['order'];
$old_gateway = $args['old_gateway'];
$new_gateway = $args['new_gateway'];
$order->set( 'payment_gateway', $new_gateway );
if ( $note ) {
$order->add_note(
sprintf(
// Translators: %1$s = old payment gateway ID; %2$s = new payment gateway ID.
__( 'Payment source updated by customer. Payment gateway changed from "%1$s" to "%2$s".', 'lifterlms' ),
$old_gateway,
$new_gateway
)
);
}
// If the order is pending-cancel, reactivate it.
if ( 'llms-pending-cancel' === $order->get( 'status' ) ) {
$order->set_status( 'active' );
}
/**
* Action run after an order's payment source is switched.
*
* @since 7.0.0
*
* @param LLMS_Order $order Order object.
* @param string $new_gateway The payment gateway ID of the new gateway.
* @param string $old_gateway The payment gateway ID of the previous gateway.
*/
do_action( 'llms_order_payment_source_switched', $order, $new_gateway, $old_gateway );
// Cleanup temp data.
delete_post_meta( $order->get( 'id' ), '_llms_temp_gateway_ids' );
}
/**
* Verifies an incoming request nonce and posted action field.
*
* @since 7.0.0
*
* @param string $field The nonce field.
* @param string $nonce The nonce & action value.
* @return null|bool Returns `null` if the nonce isn't submitted or can't be verified, `false` if the
* action isn't submitted or doesn't match the intended action, and `true` if
* the request is verified successfully.
*/
private function verify_request( $field, $nonce ) {
if ( ! isset( $_REQUEST[ $field ] ) ) {
return null;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST[ $field ] ) ), $nonce ) ) {
return null;
}
if ( llms_filter_input( INPUT_POST, 'action' ) !== $nonce ) {
return false;
}
return true;
}
}
return LLMS_Controller_Checkout::instance();
================================================
FILE: includes/controllers/class.llms.controller.achievements.php
================================================
<?php
/**
* LLMS_Controller_Achievements class
*
* @package LifterLMS/Controllers/Classes
*
* @since 3.18.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Handles awarded user achievements.
*
* @since 3.18.0
* @since 3.35.0 Sanitize `$_POST` data.
* @since 6.0.0 Extended from the LLMS_Abstract_Controller_User_Engagements class.
*/
class LLMS_Controller_Achievements extends LLMS_Abstract_Controller_User_Engagements {
/**
* Type of user engagement.
*
* @since 6.0.0
*
* @var string
*/
protected $engagement_type = 'achievement';
/**
* Constructor
*
* @since 3.18.0
*
* @return void
*/
public function __construct() {
parent::__construct();
add_action( 'init', array( $this, 'maybe_handle_reporting_actions' ) );
}
/**
* Returns a translated text of the given type.
*
* @since 6.0.0
*
* @param int $text_type One of the LLMS_Abstract_Controller_User_Engagements::TEXT_ constants.
* @param array $variables Optional variables that are used in sprintf().
* @return string
*/
protected function get_text( $text_type, $variables = array() ) {
switch ( $text_type ) {
case self::TEXT_SYNC_AWARDED_ENGAGEMENT_INSUFFICIENT_PERMISSIONS:
return sprintf(
/* translators: %1$d: awarded achievement ID */
__( 'Sorry, you are not allowed to edit the awarded achievement #%1$d.', 'lifterlms' ),
( $variables['engagement_id'] ?? 0 )
);
case self::TEXT_SYNC_AWARDED_ENGAGEMENT_INVALID_TEMPLATE:
return sprintf(
/* translators: %1$d: awarded achievement ID */
__( 'Sorry, the awarded achievement #%1$d does not have a valid achievement template.', 'lifterlms' ),
( $variables['engagement_id'] ?? 0 )
);
case self::TEXT_SYNC_AWARDED_ENGAGEMENTS_INSUFFICIENT_PERMISSIONS:
return __( 'Sorry, you are not allowed to edit awarded achievements.', 'lifterlms' );
case self::TEXT_SYNC_AWARDED_ENGAGEMENTS_INVALID_NONCE:
return __( 'Sorry, you are not allowed to sync awarded achievements.', 'lifterlms' );
case self::TEXT_SYNC_MISSING_AWARDED_ENGAGEMENT_ID:
return __( 'Sorry, you need to provide a valid awarded achievement ID.', 'lifterlms' );
case self::TEXT_SYNC_MISSING_ENGAGEMENT_TEMPLATE_ID:
return __( 'Sorry, you need to provide a valid achievement template ID.', 'lifterlms' );
default:
return parent::get_text( $text_type );
}
}
/**
* Handle achievement form actions to download (for students and admins) and to delete (admins only)
*
* @since 3.18.0
* @since 3.35.0 Sanitize `$_POST` data.
*
* @return void
*/
public function maybe_handle_reporting_actions() {
if ( ! isset( $_REQUEST['_llms_achievement_actions_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_llms_achievement_actions_nonce'] ) ), 'llms-achievement-actions' ) ) {
return;
}
if ( isset( $_POST['llms_delete_achievement'] ) ) {
if ( ! current_user_can( 'manage_lifterlms' ) ) {
return;
}
$this->delete( llms_filter_input( INPUT_POST, 'achievement_id', FILTER_SANITIZE_NUMBER_INT ) );
}
}
}
return new LLMS_Controller_Achievements();
================================================
FILE: includes/controllers/class.llms.controller.admin.quiz.attempts.php
================================================
<?php
/**
* Quiz Attempt Forms on the admin panel
*
* @package LifterLMS/Controllers/Classes
*
* @since 3.16.0
* @version 7.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Quiz Attempt Forms on the admin panel
*
* Allows admins to grade, leave remarks, and delete quiz attempts.
*
* @since 3.16.0
* @since 3.30.3 Fixed an issue causing backlashes to be saved around escaped characters when leaving remarks.
* @since 3.35.0 Sanitize `$_POST` data.
*/
class LLMS_Controller_Admin_Quiz_Attempts {
public function __construct() {
add_action( 'admin_init', array( $this, 'maybe_run_actions' ) );
}
/**
* Run actions on form submission.
*
* @since 3.16.0
* @since 3.16.9 Unknown.
* @since 3.35.0 Sanitize `$_POST` data.
* @since 4.4.4 Made sure to exit after redirecting on attempt deletion.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 7.8.0 Added `llms_quiz_resumable_attempt_action` action and single resumable attempt delete.
*
* @return void
*/
public function maybe_run_actions() {
if ( ! isset( $_REQUEST['_llms_quiz_attempt_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_llms_quiz_attempt_nonce'] ) ), 'llms_quiz_attempt_actions' ) ) {
return;
}
if ( isset( $_POST['llms_quiz_attempt_action'] ) && isset( $_POST['llms_attempt_id'] ) ) {
$action = llms_filter_input( INPUT_POST, 'llms_quiz_attempt_action' );
$attempt = new LLMS_Quiz_Attempt( absint( $_POST['llms_attempt_id'] ) );
if ( ! current_user_can( 'edit_post', $attempt->get( 'quiz_id' ) ) ) {
return;
}
if ( 'llms_attempt_delete' === $action ) {
$url = add_query_arg(
array(
'page' => 'llms-reporting',
'tab' => 'quizzes',
'quiz_id' => $attempt->get( 'quiz_id' ),
'stab' => 'attempts',
),
admin_url( 'admin.php' )
);
$attempt->delete();
wp_safe_redirect( $url );
exit();
} elseif ( 'llms_attempt_grade' === $action && ( isset( $_POST['remarks'] ) || isset( $_POST['points'] ) ) ) {
$this->save_grade( $attempt );
} elseif ( 'llms_disable_resume_attempt' === $action ) {
$attempt->set( 'can_be_resumed', false );
$attempt->save();
$attempt->end();
}
}
if ( isset( $_POST['llms_quiz_resumable_attempt_action'] ) ) {
$action = llms_filter_input( INPUT_POST, 'llms_quiz_resumable_attempt_action' );
if ( 'llms_clear_resumable_attempts' === $action ) {
$quiz_id = llms_filter_input( INPUT_POST, 'llms_quiz_id' );
if ( ! current_user_can( 'edit_post', $quiz_id ) ) {
return;
}
$resumable_attempts = $this->get_resumable_attempts( $quiz_id );
foreach ( $resumable_attempts as $attempt_id ) {
$attempt = new LLMS_Quiz_Attempt( $attempt_id );
$attempt->set( 'can_be_resumed', false );
$attempt->save();
$attempt->end();
}
}
}
}
/**
* Get resumable attempts for a quiz.
*
* @since 7.8.0
*
* @param int $quiz_id Quiz ID.
*/
public function get_resumable_attempts( $quiz_id ) {
// Query to get all resumable attempts.
$query = new LLMS_Query_Quiz_Attempt(
array(
'quiz_id' => $quiz_id,
'can_be_resumed' => true,
'status' => 'incomplete',
)
);
return wp_list_pluck( $query->get_results(), 'id' );
}
/**
* Saves changes to a quiz
*
* @since 3.16.0
* @since 3.30.3 Strip slashes on remarks.
* @since 3.35.0 Sanitize `$_POST` data.
* @since 4.4.4 Use strict type comparisons where needed.
*
* @param LLMS_Quiz_Attempt $attempt Quiz attempt instance.
* @return void
*/
private function save_grade( $attempt ) {
// phpcs:disable WordPress.Security.NonceVerification.Missing -- Nonce verified in `maybe_run_actions()` method.
$remarks = isset( $_POST['remarks'] ) ? llms_filter_input_sanitize_string( INPUT_POST, 'remarks', array( FILTER_REQUIRE_ARRAY ) ) : array();
$points = isset( $_POST['points'] ) ? llms_filter_input_sanitize_string( INPUT_POST, 'points', array( FILTER_REQUIRE_ARRAY ) ) : array();
$questions = $attempt->get_questions();
foreach ( $questions as &$question ) {
if ( isset( $remarks[ $question['id'] ] ) ) {
$question['remarks'] = wp_kses_post( nl2br( stripslashes( $remarks[ $question['id'] ] ) ) );
}
if ( isset( $points[ $question['id'] ] ) ) {
$earned = absint( $points[ $question['id'] ] );
$question['earned'] = $earned;
if ( ( $earned / $question['points'] ) >= 0.5 ) {
$question['correct'] = 'yes';
} else {
$question['correct'] = 'no';
}
}
}
// Update the attempt with new questions.
$attempt->set_questions( $questions, true );
// Attempt to calculate the grade.
$attempt->calculate_grade()->save();
// If all questions were graded the grade will have been calculated and we can trigger completion actions.
if ( in_array( $attempt->get( 'status' ), array( 'fail', 'pass' ), true ) ) {
$attempt->do_completion_actions();
}
do_action( 'llms_quiz_graded', $attempt->get_student()->get_id(), $attempt->get( 'quiz_id' ), $attempt );
// phpcs:enable
}
}
return new LLMS_Controller_Admin_Quiz_Attempts();
================================================
FILE: includes/controllers/class.llms.controller.certificates.php
================================================
<?php
/**
* LLMS_Controller_Certificates class
*
* @package LifterLMS/Controllers/Classes
*
* @since 3.18.0
* @version 5.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Handles awarded user certificates.
*
* @since 3.18.0
* @since 3.35.0 Sanitize `$_POST` data.
* @since 3.37.4 Modify `llms_certificate` post type registration to allow certificate templates to be exported.
* When exporting a certificate template, use the `post_author` for the certificate's WP User ID.
* @since 4.3.1 Properly use an `error` notice to display a WP_Error when trying to download a certificate.
* @since 6.0.0 Extended from the LLMS_Abstract_Controller_User_Engagements class.
*/
class LLMS_Controller_Certificates extends LLMS_Abstract_Controller_User_Engagements {
/**
* Type of user engagement.
*
* @since 6.0.0
*
* @var string
*/
protected $engagement_type = 'certificate';
/**
* Constructor.
*
* @since 3.18.0
* @since 3.37.4 Add filter hook for `lifterlms_register_post_type_llms_certificate`.
* @since 5.5.0 Drop usage of deprecated `lifterlms_register_post_type_llms_certificate` in favor of `lifterlms_register_post_type_certificate`.
*
* @return void
*/
public function __construct() {
parent::__construct();
add_filter( 'lifterlms_register_post_type_certificate', array( $this, 'maybe_allow_public_query' ) );
add_action( 'init', array( $this, 'maybe_handle_reporting_actions' ) );
add_action( 'wp', array( $this, 'maybe_authenticate_export_generation' ) );
}
/**
* Returns a translated text of the given type.
*
* @since 6.0.0
*
* @param int $text_type One of the LLMS_Abstract_Controller_User_Engagements::TEXT_ constants.
* @param array $variables Optional variables that are used in sprintf().
* @return string
*/
protected function get_text( $text_type, $variables = array() ) {
switch ( $text_type ) {
case self::TEXT_SYNC_AWARDED_ENGAGEMENT_INSUFFICIENT_PERMISSIONS:
return sprintf(
/* translators: %1$d: awarded certificate ID */
__( 'Sorry, you are not allowed to edit the awarded certificate #%1$d.', 'lifterlms' ),
( $variables['engagement_id'] ?? 0 )
);
case self::TEXT_SYNC_AWARDED_ENGAGEMENT_INVALID_TEMPLATE:
return sprintf(
/* translators: %1$d: awarded certificate ID */
__( 'Sorry, the awarded certificate #%1$d does not have a valid certificate template.', 'lifterlms' ),
( $variables['engagement_id'] ?? 0 )
);
case self::TEXT_SYNC_AWARDED_ENGAGEMENTS_INSUFFICIENT_PERMISSIONS:
return __( 'Sorry, you are not allowed to edit awarded certificates.', 'lifterlms' );
case self::TEXT_SYNC_AWARDED_ENGAGEMENTS_INVALID_NONCE:
return __( 'Sorry, you are not allowed to sync awarded certificates.', 'lifterlms' );
case self::TEXT_SYNC_MISSING_AWARDED_ENGAGEMENT_ID:
return __( 'Sorry, you need to provide a valid awarded certificate ID.', 'lifterlms' );
case self::TEXT_SYNC_MISSING_ENGAGEMENT_TEMPLATE_ID:
return __( 'Sorry, you need to provide a valid certificate template ID.', 'lifterlms' );
default:
return parent::get_text( $text_type );
}
}
/**
* Modify certificate post type registration data during a certificate template export.
*
* @since 3.37.4
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @link https://github.com/gocodebox/lifterlms/issues/776
*
* @param array $post_type_args Array of `llms_certificate` post type registration arguments.
* @return array
*/
public function maybe_allow_public_query( $post_type_args ) {
if ( ! empty( $_REQUEST['_llms_cert_auth'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
$auth = llms_filter_input( INPUT_GET, '_llms_cert_auth', FILTER_SANITIZE_FULL_SPECIAL_CHARS );
global $wpdb;
$post_id = $wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM {$wpdb->postmeta} WHERE meta_key = '_llms_auth_nonce' AND meta_value = %s", $auth ) ); // db call ok; no-cache ok.
if ( $post_id && 'llms_certificate' === get_post_type( $post_id ) ) {
$post_type_args['publicly_queryable'] = true;
}
}
return $post_type_args;
}
/**
* Allow cURL requests to view a certificate to be authenticated via a nonce.
*
* A cURL request is used to scrape the HTML and this will authenticate the scrape.
*
* @since 3.18.0
* @since 3.24.0 Unknown.
* @since 3.37.4 Use the `post_author` as the WP_User ID when exporting a certificate template.
*
* @return void
*/
public function maybe_authenticate_export_generation() {
if ( empty( $_REQUEST['_llms_cert_auth'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
return;
}
$post_id = get_the_ID();
$post_type = get_post_type( $post_id );
if ( ! in_array( $post_type, array( 'llms_my_certificate', 'llms_certificate' ), true ) ) {
return;
}
if ( get_post_meta( $post_id, '_llms_auth_nonce', true ) !== $_REQUEST['_llms_cert_auth'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Recommended
return;
}
$cert = new LLMS_User_Certificate( $post_id );
$uid = ( 'llms_certificate' === $post_type ) ? get_post_field( 'post_author', $post_id ) : $cert->get_user_id();
wp_set_current_user( $uid );
}
/**
* Handle certificate form actions
*
* Manages frontend actions to download and manage certificate sharing settings and reporting (admin)
* actions to download and delete.
*
* The method name is a misnomer as this method handles actions on reporting screens as well as
* on the site's frontend when actually viewing a certificate
*
* @since 3.18.0
* @since 3.35.0 Sanitize `$_POST` data.
* @since 4.5.0 Add handler for changing certificate sharing settings.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
public function maybe_handle_reporting_actions() {
if ( ! isset( $_REQUEST['_llms_cert_actions_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_llms_cert_actions_nonce'] ) ), 'llms-cert-actions' ) ) {
return;
}
$cert_id = absint( llms_filter_input( INPUT_POST, 'certificate_id', FILTER_SANITIZE_NUMBER_INT ) );
if ( isset( $_POST['llms_generate_cert'] ) ) {
$cert = new LLMS_User_Certificate( $cert_id );
if ( ! $cert->can_user_manage() ) {
return;
}
$this->download( $cert_id );
} elseif ( isset( $_POST['llms_delete_cert'] ) ) {
if ( ! current_user_can( 'manage_lifterlms' ) ) {
return;
}
$this->delete( $cert_id );
} elseif ( isset( $_POST['llms_enable_cert_sharing'] ) ) {
$this->change_sharing_settings( $cert_id, (bool) $_POST['llms_enable_cert_sharing'] );
}
}
/**
* Change shareable settings of a certificate.
*
* @since 4.5.0
*
* @param int $cert_id WP Post ID of the llms_my_certificate.
* @param bool $is_allowed Allow share the certificate or not.
* @return WP_Error|boolean Returns `true` on success and `false` on failure or an error object when the user does not have sufficient privileges.
*/
private function change_sharing_settings( $cert_id, $is_allowed ) {
$cert = new LLMS_User_Certificate( $cert_id );
if ( ! $cert->can_user_manage() ) {
return new WP_Error( 'insufficient-permissions', __( 'You are not allowed to manage this certificate.', 'lifterlms' ) );
}
return $cert->set( 'allow_sharing', $is_allowed ? 'yes' : 'no' );
}
/**
* Download a Certificate.
*
* Generates an HTML export of the certificate from the "Download" button
* on the View Certificate front end & on reporting backend for admins.
*
* @since 3.18.0
* @since 4.3.1 Properly use an `error` notice to display a WP_Error.
*
* @return void
*/
private function download( $cert_id ) {
$filepath = llms()->certificates()->get_export( $cert_id );
if ( is_wp_error( $filepath ) ) {
// @todo Need to handle errors differently on admin panel.
return llms_add_notice( $filepath->get_error_message(), 'error' );
}
header( 'Content-Description: File Transfer' );
header( 'Content-Type: application/octet-stream' );
header( 'Content-Disposition: attachment; filename="' . basename( $filepath ) . '"' );
readfile( $filepath ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_readfile
// Delete file after download.
ignore_user_abort( true );
wp_delete_file( $filepath );
exit;
}
}
return new LLMS_Controller_Certificates();
================================================
FILE: includes/controllers/class.llms.controller.lesson.progression.php
================================================
<?php
/**
* Lesson Progression Actions
*
* @package LifterLMS/Controllers/Classes
*
* @since 3.17.1
* @version 6.10.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Controller_Lesson_Progression class
*
* @since 3.17.1
*/
class LLMS_Controller_Lesson_Progression {
/**
* Constructor
*
* @since 3.17.1
* @since 3.29.0 Unknown
*
* @return void
*/
public function __construct() {
add_action( 'admin_init', array( $this, 'handle_admin_managment_forms' ) );
add_action( 'init', array( $this, 'handle_complete_form' ) );
add_action( 'init', array( $this, 'handle_incomplete_form' ) );
add_action( 'lifterlms_quiz_completed', array( $this, 'quiz_complete' ), 10, 3 );
add_filter( 'llms_allow_lesson_completion', array( $this, 'quiz_maybe_prevent_lesson_completion' ), 10, 5 );
add_action( 'llms_trigger_lesson_completion', array( $this, 'mark_complete' ), 10, 4 );
}
/**
* Retrieve a lesson ID from form data for the mark complete / incomplete forms
*
* @since 3.29.0
*
* @param string $action Form action, either "complete" or "incomplete".
* @return int|null Returns `null` when either required post fields are missing or if the lesson_id is non-numeric, int (lesson id) on success.
*/
private function get_lesson_id_from_form_data( $action ) {
if ( ! isset( $_REQUEST['_wpnonce'] ) ) {
return null;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_wpnonce'] ) ), 'mark_' . $action ) ) {
return null;
}
$submitted = llms_filter_input( INPUT_POST, 'mark_' . $action );
$lesson_id = llms_filter_input( INPUT_POST, 'mark-' . $action );
// Required fields.
if ( is_null( $submitted ) || is_null( $lesson_id ) ) {
return null;
}
$lesson_id = absint( $lesson_id );
// Invalid lesson ID.
if ( ! $lesson_id || ! is_numeric( $lesson_id ) ) {
llms_add_notice( __( 'An error occurred, please try again.', 'lifterlms' ), 'error' );
return null;
}
return $lesson_id;
}
/**
* Handle form submission from the Student -> Courses -> Course table where admins can toggle completion of lessons for a student.
*
* @since 3.29.0
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 6.10.0 Check the current user can edit the lesson they're going to mark complete/incomplete.
*
* @return void
*/
public function handle_admin_managment_forms() {
if ( ! isset( $_REQUEST['llms-admin-progression-nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['llms-admin-progression-nonce'] ) ), 'llms-admin-lesson-progression' ) ) {
return;
}
$action = llms_filter_input( INPUT_POST, 'llms-lesson-action' );
$lesson_id = absint( llms_filter_input( INPUT_POST, 'lesson_id' ) );
$student_id = absint( llms_filter_input( INPUT_POST, 'student_id' ) );
// Missing required data.
if ( empty( $action ) || empty( $lesson_id ) || empty( $student_id ) || ! current_user_can( 'edit_post', $lesson_id ) ) {
return;
}
$trigger = 'admin_' . get_current_user_id();
if ( 'complete' === $action ) {
$this->mark_complete( $student_id, $lesson_id, $trigger );
} elseif ( 'incomplete' === $action ) {
llms_mark_incomplete( $student_id, $lesson_id, 'lesson', $trigger );
}
}
/**
* Mark Lesson as complete
*
* + Complete Lesson form post.
* + Marks lesson as complete and returns completion message to user.
* + Autoadvances to next lesson if completion is successful.
*
* @since 3.17.1
* @since 3.29.0 Unknown.
*
* @return void
*/
public function handle_complete_form() {
$lesson_id = $this->get_lesson_id_from_form_data( 'complete' );
if ( is_null( $lesson_id ) ) {
return;
}
/**
* Filter to modify the user id instead of current logged in user id.
*
* @param int $user_id User id to mark lesson as complete.
*
* @since 5.4.0
*/
$user_id = apply_filters( 'llms_lesson_completion_user_id', get_current_user_id() );
do_action( 'llms_trigger_lesson_completion', $user_id, $lesson_id, 'lesson_' . $lesson_id );
if ( apply_filters( 'lifterlms_autoadvance', true ) ) {
$lesson = new LLMS_Lesson( $lesson_id );
$next_lesson_id = $lesson->get_next_lesson();
if ( $next_lesson_id ) {
wp_redirect( apply_filters( 'llms_lesson_complete_redirect', get_permalink( $next_lesson_id ) ) );
exit;
}
}
}
/**
* Mark Lesson as incomplete
*
* + Incomplete Lesson form post.
* + Marks lesson as incomplete and returns incompletion message to user.
*
* @since 3.17.1
* @since 3.29.0 Unknown.
*
* @return void
*/
public function handle_incomplete_form() {
$lesson_id = $this->get_lesson_id_from_form_data( 'incomplete' );
if ( is_null( $lesson_id ) ) {
return;
}
/**
* Filter to modify the user id instead of current logged in user id.
*
* @param int $user_id User id to mark lesson as incomplete.
*
* @since 5.4.0
*/
$user_id = apply_filters( 'llms_lesson_incomplete_user_id', get_current_user_id() );
// Mark incomplete and add a notice on success.
if ( llms_mark_incomplete( $user_id, $lesson_id, 'lesson', 'lesson_' . $lesson_id ) ) {
// Translators: %s is the title of the lesson.
llms_add_notice( sprintf( __( 'The lesson %s is now marked as incomplete.', 'lifterlms' ), get_the_title( $lesson_id ) ) );
}
}
/**
* Handle completion of lesson via `llms_trigger_lesson_completion` action
*
* @since 3.17.1
* @since 3.29.0 Unknown.
*
* @param int $user_id User ID.
* @param int $lesson_id Lesson ID.
* @param string $trigger Optional trigger description string.
* @param array $args Optional arguments.
* @return void
*/
public function mark_complete( $user_id, $lesson_id, $trigger = '', $args = array() ) {
if ( llms_allow_lesson_completion( $user_id, $lesson_id, $trigger, $args ) ) {
llms_mark_complete( $user_id, $lesson_id, 'lesson', $trigger );
}
}
/**
* Trigger lesson completion when a quiz is completed
*
* @since 3.17.1
*
* @param int $student_id WP User ID.
* @param int $quiz_id WP Post ID of the quiz.
* @param obj $attempt Instance of the LLMS_Quiz_Attempt.
* @return void
*/
public function quiz_complete( $student_id, $quiz_id, $attempt ) {
do_action(
'llms_trigger_lesson_completion',
$student_id,
$attempt->get( 'lesson_id' ),
'quiz_' . $quiz_id,
array(
'attempt' => $attempt,
)
);
}
/**
* Before a lesson is marked as complete, check if all the lesson's quiz requirements are met
*
* @since 3.17.1
*
* @param bool $allow_completion Whether or not to allow completion (true by default, false if something else has already prevented).
* @param int $user_id WP User ID of the student completing the lesson.
* @param int $lesson_id WP Post ID of the lesson to be completed.
* @param string $trigger Text string to record the reason why the lesson is being completed.
* @param array $args Optional additional arguments from the triggering function.
* @return bool
*/
public function quiz_maybe_prevent_lesson_completion( $allow_completion, $user_id, $lesson_id, $trigger, $args ) {
// If allow completion is already false, we don't need to run any quiz checks.
if ( ! $allow_completion ) {
return $allow_completion;
}
$lesson = llms_get_post( $lesson_id );
$passing_required = llms_parse_bool( $lesson->get( 'require_passing_grade' ) );
// If the lesson is being completed by a quiz.
if ( 0 === strpos( $trigger, 'quiz_' ) ) {
// Passing is required AND the attempt was a failure.
if ( $passing_required && ! $args['attempt']->is_passing() ) {
$allow_completion = false;
}
} elseif ( $lesson->is_quiz_enabled() ) {
$quiz_id = $lesson->get( 'quiz' );
$student = llms_get_student( $user_id );
$attempt = $student->quizzes()->get_best_attempt( $quiz_id );
// Passing is not required but there's not attempts yet.
// At least one attempt (passing or otherwise) is required!.
if ( ! $passing_required && ! $attempt ) {
$allow_completion = false;
// Passing is required and there's no attempts or the best attempt is not passing.
} elseif ( $passing_required && ( ! $attempt || ! $attempt->is_passing() ) ) {
$allow_completion = false;
}
}
return $allow_completion;
}
}
return new LLMS_Controller_Lesson_Progression();
================================================
FILE: includes/controllers/class.llms.controller.orders.php
================================================
<?php
/**
* Order processing and related actions controller.
*
* @package LifterLMS/Controllers/Classes
*
* @since 3.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Controller_Orders class.
*
* @since 3.0.0
* @since 3.33.0 Added logic to delete any enrollment records linked to an LLMS_Order on its permanent deletion.
* @since 3.34.4 Added filter `llms_order_can_be_confirmed`.
* @since 3.34.5 Fixed logic error in `llms_order_can_be_confirmed` conditional.
* @since 3.36.1 In `recurring_charge()`, made sure to process only proper LLMS_Orders of existing users.
* @since 4.2.0 Added logic to set the order status to 'cancelled' when an enrollment linked to an order is deleted.
* Also `llms_unenroll_on_error_order` fiter hook added.
* @since 5.0.0 Build customer data using LLMS_Forms fields information.
*/
class LLMS_Controller_Orders {
/**
* Constructor.
*
* @since 3.0.0
* @since 3.19.0 Updated.
* @since 3.33.0 Added `before_delete_post` action to handle order deletion.
* @since 4.2.0 Added `llms_user_enrollment_deleted` action to handle order status change on enrollment deletion.
* @since 5.4.0 Perform `error_order()` when Detect a product deletion while processing a recurring charge.
* @since 7.0.0 Added callback for `wp_untrash_post_status` filter.
* Remove action callbacks for order confirm, create, and payment source switch in favor of hooks in `LLMS_Controller_Checkout`.
*
* @return void
*/
public function __construct() {
add_filter( 'wp_untrash_post_status', array( $this, 'set_untrash_status' ), 10, 3 );
// This action adds our lifterlms specific actions when order & transaction statuses change.
add_action( 'transition_post_status', array( $this, 'transition_status' ), 10, 3 );
// This action adds lifterlms specific action when an order is deleted, just before the WP post postmetas are removed.
add_action( 'before_delete_post', array( $this, 'on_delete_order' ) );
// This action is meant to do specific actions on orders when an enrollment, with an order as trigger, is deleted.
add_action( 'llms_user_enrollment_deleted', array( $this, 'on_user_enrollment_deleted' ), 10, 3 );
// Transaction status changes cascade up to the order to change the order status.
add_action( 'lifterlms_transaction_status_failed', array( $this, 'transaction_failed' ), 10, 1 );
add_action( 'lifterlms_transaction_status_refunded', array( $this, 'transaction_refunded' ), 10, 1 );
add_action( 'lifterlms_transaction_status_succeeded', array( $this, 'transaction_succeeded' ), 10, 1 );
// Status changes for orders to enroll students and trigger completion actions.
add_action( 'lifterlms_order_status_completed', array( $this, 'complete_order' ), 10, 2 );
add_action( 'lifterlms_order_status_active', array( $this, 'complete_order' ), 10, 2 );
// Status changes to pending cancel.
add_action( 'lifterlms_order_status_pending-cancel', array( $this, 'pending_cancel_order' ), 10, 1 );
// Status changes for orders to unenroll students upon purchase.
add_action( 'lifterlms_order_status_refunded', array( $this, 'error_order' ), 10, 1 );
add_action( 'lifterlms_order_status_cancelled', array( $this, 'error_order' ), 10, 1 );
add_action( 'lifterlms_order_status_expired', array( $this, 'error_order' ), 10, 1 );
add_action( 'lifterlms_order_status_failed', array( $this, 'error_order' ), 10, 1 );
add_action( 'lifterlms_order_status_on-hold', array( $this, 'error_order' ), 10, 1 );
add_action( 'lifterlms_order_status_trash', array( $this, 'error_order' ), 10, 1 );
// Detect a product deletion while processing a recurring charge.
add_action( 'llms_order_recurring_charge_aborted_product_deleted', array( $this, 'error_order' ), 10, 1 );
/**
* Scheduler Actions
*/
// Charge recurring payments.
add_action( 'llms_charge_recurring_payment', array( $this, 'recurring_charge' ), 10, 1 );
// Expire access plans.
add_action( 'llms_access_plan_expiration', array( $this, 'expire_access' ), 10, 1 );
}
/**
* Perform actions on a successful order completion.
*
* @since 1.0.0
* @since 3.19.0 Unknown.
*
* @param LLMS_Order $order Instance of an LLMS_Order.
* @param string $old_status Previous order status (eg: 'pending').
* @return void
*/
public function complete_order( $order, $old_status ) {
// Clear expiration date when moving from a pending-cancel order.
if ( 'pending-cancel' === $old_status ) {
$order->set( 'date_access_expires', '' );
}
// Record access start time & maybe schedule expiration.
$order->start_access();
$order_id = $order->get( 'id' );
$product_id = $order->get( 'product_id' );
$user_id = $order->get( 'user_id' );
unset( llms()->session->llms_coupon );
/**
* Action fired on order complete.
*
* Prior to the students being enrolled.
*
* @since 1.0.0
*
* @param integer $order_id The WP_Post ID of the order.
*/
do_action( 'lifterlms_order_complete', $order_id ); // @todo used by AffiliateWP only, can remove after updating AffiliateWP.
/**
* Filter whether the user should be automatically enrolled when the order completes.
*
* @since 9.1.2
*
* @param bool Whether to enroll the student. Defaults to true.
* @param LLMS_Order $order The order.
*/
if ( apply_filters( 'lifterlms_enroll_student_on_order_complete', true, $order ) ) {
llms_enroll_student( $user_id, $product_id, 'order_' . $order_id );
}
// Trigger purchase action, used by engagements.
/**
* Action fired on product purchased.
*
* After the student has been enrolled.
*
* @since Unknown
*
* @param integer $user_id The WP_User ID of the buyer.
* @param integer $product_id The WP_Post ID of the purchased product (course/membership).
*/
do_action( 'lifterlms_product_purchased', $user_id, $product_id );
/**
* Action fired on access plan purchased.
*
* After the student has been enrolled.
*
* @since Unknown
*
* @param integer $user_id The WP_User ID of the buyer.
* @param integer $product_id The WP_Post ID of the purchased access plan.
*/
do_action( 'lifterlms_access_plan_purchased', $user_id, $order->get( 'plan_id' ) );
// Maybe schedule a payment.
$order->maybe_schedule_payment();
}
/**
* Called when an order's status changes to refunded, cancelled, expired, or failed.
*
* Also called on product deletion detected while processing a recurring charge.
* @since 3.0.0
* @since 3.10.0 Unknown.
* @since 4.2.0 Added `llms_unenroll_on_error_order` filter hook.
* @since 5.4.0 Unenroll with 'cancelled' status on 'llms_order_recurring_charge_aborted_product_deleted'.
* The `$order` param can be also a WP_Post or its `ID`.
*
* @param int|WP_Post|LLMS_Order $order Instance of an LLMS_Order, WP_Post or WP_Post ID of the order.
* @return void
*/
public function error_order( $order ) {
$order = is_a( $order, 'LLMS_Order' ) ? $order : llms_get_post( $order );
if ( ! ( $order && is_a( $order, 'LLMS_Order' ) ) ) {
return;
}
$order->unschedule_recurring_payment();
/**
* Determine if student should be unenrolled on order error.
*
* @since 4.2.0
*
* @param bool $unenroll_on_error_order True if the student should be unenrolled, false otherwise. Default true.
* @param LLMS_Order $order Order object.
*/
if ( ! apply_filters( 'llms_unenroll_on_error_order', true, $order ) ) {
return;
}
switch ( current_filter() ) {
case 'lifterlms_order_status_trash':
case 'lifterlms_order_status_cancelled':
case 'lifterlms_order_status_on-hold':
case 'lifterlms_order_status_refunded':
case 'llms_order_recurring_charge_aborted_product_deleted':
$status = 'cancelled';
break;
case 'lifterlms_order_status_expired':
case 'lifterlms_order_status_failed':
default:
$status = 'expired';
break;
}
llms_unenroll_student( $order->get( 'user_id' ), $order->get( 'product_id' ), $status, 'order_' . $order->get( 'id' ) );
}
/**
* Called when a post is permanently deleted.
*
* Will delete any enrollment records linked to the LLMS_Order with the ID of the deleted post.
*
* @since 3.33.0
*
* @param int $post_id WP_Post ID.
* @return void
*/
public function on_delete_order( $post_id ) {
$order = llms_get_post( $post_id );
if ( $order && is_a( $order, 'LLMS_Order' ) ) {
llms_delete_student_enrollment( $order->get( 'user_id' ), $order->get( 'product_id' ), 'order_' . $order->get( 'id' ) );
}
}
/**
* Called when an user enrollment is deleted.
*
* Will set the related order status to 'cancelled'.
*
* @since 4.2.0
*
* @param int $user_id WP User ID.
* @param int $product_id WP Post ID of the course or membership.
* @param string $trigger The deleted enrollment trigger, or 'any' if no specific trigger.
* @return void
*/
public function on_user_enrollment_deleted( $user_id, $product_id, $trigger ) {
$order_id = 'order_' === substr( $trigger, 0, 6 ) ? absint( substr( $trigger, 6 ) ) : false;
$order = $order_id ? llms_get_post( $order_id ) : false;
if ( $order && is_a( $order, 'LLMS_Order' ) ) {
// No need to run an unenrollment as we're reacting to an enrollment deletion, user enrollments data already removed.
add_filter( 'llms_unenroll_on_error_order', '__return_false', 100 );
$order->set_status( 'cancelled' );
// Reset unenrollment's suspension..
remove_filter( 'llms_unenroll_on_error_order', '__return_false', 100 );
}
}
/**
* Handle expiration & cancellation from a course / membership.
*
* Called via scheduled action set during order completion for plans with a limited access plan.
* Additionally called when an order is marked as "pending-cancel" to revoke access at the end of a pre-paid period.
*
* @since 3.0.0
* @since 3.19.0 Unknown.
* @since 7.5.0 Potentially allow recurring payment to go ahead even if access plans expired.
*
* @param int $order_id WP_Post ID of the LLMS Order.
* @return void
*/
public function expire_access( $order_id ) {
$order = new LLMS_Order( $order_id );
$new_order_status = false;
// Pending cancel order moves to cancelled.
if ( 'llms-pending-cancel' === $order->get( 'status' ) ) {
$status = 'cancelled'; // Enrollment status.
$note = __( 'Student unenrolled at the end of access period due to subscription cancellation.', 'lifterlms' );
$new_order_status = 'cancelled';
// All others move to expired.
} else {
$status = 'expired'; // Enrollment status.
$note = __( 'Student unenrolled due to automatic access plan expiration', 'lifterlms' );
}
/**
* Filters whether or not recurring payments should be stopped on access plan expiration.
*
* By default when an access plan expires, recurring payments are stopped.
*
* @since 7.5.0
*
* @param bool
* @param LLMS_Order $order Instance of the order.
* @param mixed $new_order_status New order status. If `false` it means that the new order status is not
* going to change. At this stage the orders status is not changed yet.
* @param string $enrollment_status The new enrollment status. At this stage the enrollment status is not changed yet.
*/
$unschedule_recurring_payment = apply_filters(
'llms_unschedule_recurring_payment_on_access_plan_expiration',
true,
$order,
$new_order_status,
$status
);
llms_unenroll_student( $order->get( 'user_id' ), $order->get( 'product_id' ), $status, 'order_' . $order->get( 'id' ) );
$order->add_note( $note );
if ( $unschedule_recurring_payment ) {
$order->unschedule_recurring_payment();
}
if ( $new_order_status ) {
$order->set_status( $new_order_status );
}
}
/**
* Unschedule recurring payments and schedule access expiration.
*
* @since 3.19.0
*
* @param LLMS_Order $order LLMS_Order object.
* @return void
*/
public function pending_cancel_order( $order ) {
$date = $order->get_next_payment_due_date( 'Y-m-d H:i:s' );
$order->set( 'date_access_expires', $date );
$order->unschedule_recurring_payment();
$order->maybe_schedule_expiration();
}
/**
* Trigger a recurring payment.
*
* Called by action scheduler.
*
* @since 3.0.0
* @since 3.32.0 Record order notes and trigger actions during errors.
* @since 3.36.1 Made sure to process only proper LLMS_Orders of existing users.
* @since 5.2.0 Fixed buggy logging on gateway error because it doesn't support recurring payments.
* @since 5.4.0 Handle case when the order's related product has been removed.
*
* @param int $order_id WP Post ID of the order.
* @return bool `false` if the recurring charge cannot be processed, `true` when the charge is successfully handed off to the gateway.
*/
public function recurring_charge( $order_id ) {
// Make sure the order still exists.
$order = llms_get_post( $order_id );
if ( ! $order || ! is_a( $order, 'LLMS_Order' ) ) {
/**
* Fired when a LifterLMS order's recurring charge errors because the order doesn't exist anymore
*
* @since Unknown
*
* @param int $order_id WP Post ID of the order.
* @param LLMS_Controller_Orders $controller This controller's instance.
*/
do_action( 'llms_order_recurring_charge_order_error', $order_id, $this );
llms_log( sprintf( 'Recurring charge for Order #%d could not be processed because the order no longer exists.', $order_id ), 'recurring-payments' );
return false;
}
// Check the user still exists.
$user_id = $order->get( 'user_id' );
if ( ! get_user_by( 'id', $user_id ) ) {
/**
* Fired when a LifterLMS order's recurring charge errors because the user who placed the order doesn't exist anymore
*
* @since Unknown
*
* @param int $order_id WP Post ID of the order.
* @param int $user_id WP User ID of the user who placed the order.
* @param LLMS_Controller_Orders $controller This controller's instance.
*/
do_action( 'llms_order_recurring_charge_user_error', $order_id, $user_id, $this );
llms_log( sprintf( 'Recurring charge for Order #%1$d could not be processed because the user (#%2$d) no longer exists.', $order_id, $user_id ), 'recurring-payments' );
// Translators: %d = The deleted user's ID.
$order->add_note( sprintf( __( 'Recurring charge skipped. The user (#%d) no longer exists.', 'lifterlms' ), $user_id ) );
return false;
}
// Ensure Gateway is still available.
$gateway = $order->get_gateway();
if ( is_wp_error( $gateway ) ) {
/**
* Fired when a LifterLMS order's recurring charge errors because of a gateway error. E.g. it's not available anymore.
*
* @since Unknown
*
* @param int $order_id WP Post ID of the order.
* @param WP_Error $error WP_Error instance.
* @param LLMS_Controller_Orders $controller This controller's instance.
*/
do_action( 'llms_order_recurring_charge_gateway_error', $order_id, $gateway, $this );
llms_log(
sprintf(
'Recurring charge for Order #%1$d could not be processed because the "%2$s" gateway is no longer available. Gateway Error: %3$s',
$order_id,
$order->get( 'payment_gateway' ),
$gateway->get_error_message()
),
'recurring-payments'
);
$order->add_note(
sprintf(
// Translators: %s = error message encountered while loading the gateway.
__( 'Recurring charge was not processed due to an error encountered while loading the payment gateway: %s.', 'lifterlms' ),
$gateway->get_error_message()
)
);
return false;
}
// Gateway doesn't support recurring payments.
if ( ! $gateway->supports( 'recurring_payments' ) ) {
/**
* Fired when a LifterLMS order's recurring charge errors because the selected gateway doesn't support recurring payments.
*
* @since Unknown
*
* @param int $order_id WP Post ID of the order.
* @param LLMS_Payment_Gateway $gateway LLMS_Payment_Gateway extending class instance.
* @param LLMS_Controller_Orders $controller This controller's instance.
*/
do_action( 'llms_order_recurring_charge_gateway_payments_disabled', $order_id, $gateway, $this );
llms_log(
sprintf(
'Recurring charge for order #%d could not be processed because the gateway no longer supports recurring payments.',
$order_id
),
'recurring-payments'
);
$order->add_note( __( 'Recurring charge skipped because recurring payments are disabled for the payment gateway.', 'lifterlms' ) );
return false;
}
// Recurring payments disabled as a site feature when in staging mode.
if ( ! LLMS_Site::get_feature( 'recurring_payments' ) ) {
/**
* Fired when a LifterLMS order's recurring charge errors because the recurring payments site feature is disabled.
*
* @since Unknown
*
* @param int $order_id WP Post ID of the order.
* @param LLMS_Payment_Gateway $gateway LLMS_Payment_Gateway extending class instance.
* @param LLMS_Controller_Orders $controller This controller's instance.
*/
do_action( 'llms_order_recurring_charge_skipped', $order_id, $gateway, $this );
$order->add_note( __( 'Recurring charge skipped because recurring payments are disabled in staging mode.', 'lifterlms' ) );
return false;
}
// Related product removed.
if ( empty( $order->get_product() ) ) {
/**
* Fired when a LifterLMS order's recurring charge errors because the purchased product (Course/Membership) doesn't exist anymore.
*
* @since Unknown
*
* @param int $order_id WP Post ID of the order.
* @param LLMS_Controller_Orders $controller This controller's instance.
*/
do_action( 'llms_order_recurring_charge_aborted_product_deleted', $order_id, $this );
llms_log(
sprintf(
'Recurring charge for order #%d could not be processed because the product #%d does not exist anymore.',
$order_id,
$order->get( 'product_id' )
),
'recurring-payments'
);
$order->add_note( __( 'Recurring charge aborted because the purchased product does not exist anymore.', 'lifterlms' ) );
return false;
}
// Passed validation, hand off to the gateway.
$gateway->handle_recurring_transaction( $order );
return true;
}
/**
* Sets an order's post status to `llms-pending` when untrashing an order.
*
* This is a filter hook callback for the WP core filter `wp_untrash_post_status`.
*
* @since 7.0.0
*
* @param string $new_status The new status of the post after untrashing.
* @param int $post_id The WP_Post ID of the order.
* @param string $previous_status The status of the post at the point where it was trashed.
* @return string
*/
public function set_untrash_status( $new_status, $post_id, $previous_status ) {
if ( 'llms_order' === get_post_type( $post_id ) ) {
/**
* Filters the status that an order post gets assigned when it is restored from the trash.
*
* This is a filter nearly identical to `wp_untrash_post_status` applied specifically to `llms_order` posts.
*
* @since 7.0.0
*
* @link https://developer.wordpress.org/reference/hooks/wp_untrash_post_status/
*
* @param string $new_status The new status of the post being restored.
* @param int $post_id The ID of the post being restored.
* @param string $previous_status The status of the post at the point where it was trashed.
*/
$new_status = apply_filters( 'llms_untrash_order_status', 'llms-pending', $post_id, $previous_status );
}
return $new_status;
}
/**
* When a transaction fails, update the parent order's status.
*
* @since 3.0.0
* @since 3.10.0 Unknown.
*
* @param LLMS_Transaction $txn Instance of the LLMS_Transaction.
* @return void
*/
public function transaction_failed( $txn ) {
$order = $txn->get_order();
// Halt if legacy.
if ( $order->is_legacy() ) {
return;
}
if ( $order->can_be_retried() ) {
$order->maybe_schedule_retry();
} else {
$order->set( 'status', 'llms-failed' );
}
}
/**
* When a transaction is refunded, update the parent order's status.
*
* @since 3.0.0
*
* @param LLMS_Transaction $txn Instance of the LLMS_Transaction.
* @return void
*/
public function transaction_refunded( $txn ) {
$order = $txn->get_order();
// Halt if legacy.
if ( $order->is_legacy() ) {
return; }
$order->set( 'status', 'llms-refunded' );
}
/**
* When a transaction succeeds, update the parent order's status.
*
* @since 3.0.0
* @since 3.10.0 Unknown.
*
* @param LLMS_Transaction $txn Instance of the LLMS_Transaction.
* @return void
*/
public function transaction_succeeded( $txn ) {
// Get the order.
$order = $txn->get_order();
// Halt if legacy.
if ( $order->is_legacy() ) {
return;
}
// Update the status based on the order type.
$status = $order->is_recurring() ? 'llms-active' : 'llms-completed';
$order->set( 'status', $status );
$order->set( 'last_retry_rule', '' ); // Retries should always start with tne first rule for new transactions.
// Maybe schedule a payment.
$order->maybe_schedule_payment();
}
/**
* Trigger actions when the status of LifterLMS Orders and LifterLMS Transactions change status.
*
* @since 3.0.0
* @since 3.19.0 Unknown.
*
* @param string $new_status New status.
* @param string $old_status Old status.
* @param WP_Post $post WP_Post instance of the transaction.
* @return void
*/
public function transition_status( $new_status, $old_status, $post ) {
// Don't do anything if the status hasn't changed.
if ( $new_status === $old_status ) {
return;
}
// We're only concerned with order post statuses here.
if ( 'llms_order' !== $post->post_type && 'llms_transaction' !== $post->post_type ) {
return;
}
$post_type = str_replace( 'llms_', '', $post->post_type );
$obj = 'order' === $post_type ? new LLMS_Order( $post ) : new LLMS_Transaction( $post );
// Record order status changes as notes.
if ( 'order' === $post_type ) {
/* translators: %1$s: Old Status, %2$s: New status. */
$obj->add_note( sprintf( __( 'Order status changed from %1$s to %2$s', 'lifterlms' ), llms_get_order_status_name( $old_status ), llms_get_order_status_name( $new_status ) ) );
}
// Remove prefixes from all the things.
$new_status = str_replace( array( 'llms-', 'txn-' ), '', $new_status );
$old_status = str_replace( array( 'llms-', 'txn-' ), '', $old_status );
/**
* Fired when a LifterLMS order or transaction changes status.
*
* The first dynamic portion of this hook, `$post_type`, refers to the unprefixed object post type ('order|transaction').
* The second dynamic portion of this hook, `$old_status`, refers to the previous object status.
* The third dynamic portion of this hook, `$new_status`, refers to the new object status.
*
* @since Unknown
*
* @param LLMS_Order|LLMS_Transaction $object The LifterLMS order or transaction instance.
* @param string $old_status The previous order or transaction status.
* @param string $new_status The new order or transaction status.
*/
do_action( "lifterlms_{$post_type}_status_{$old_status}_to_{$new_status}", $obj, $old_status, $new_status );
/**
* Fired when a LifterLMS order or transaction changes status.
*
* The first dynamic portion of this hook, `$post_type`, refers to the unprefixed object post type ('order|transaction').
* The second dynamic portion of this hook, `$new_status`, refers to the new object status.
*
* @since Unknown
*
* @param LLMS_Order|LLMS_Transaction $object The LifterLMS order or transaction instance.
* @param string $old_status The previous order or transaction status.
* @param string $new_status The new order or transaction status.
*/
do_action( "lifterlms_{$post_type}_status_{$new_status}", $obj, $old_status, $new_status );
}
/**
* Validate a gateway can be used to process the current action / transaction.
*
* @since 3.10.0
*
* @param string $gateway_id Gateway's id.
* @param LLMS_Access_Plan $plan Instance of the LLMS_Access_Plan related to the action/transaction.
* @return WP_Error|LLMS_Payment_Gateway WP_Error or LLMS_Payment_Gateway subclass.
*/
private function validate_selected_gateway( $gateway_id, $plan ) {
$gateway = llms()->payment_gateways()->get_gateway_by_id( $gateway_id );
$err = new WP_Error();
// Valid gateway.
if ( is_subclass_of( $gateway, 'LLMS_Payment_Gateway' ) ) {
// Gateway not enabled.
if ( 'manual' !== $gateway->get_id() && ! $gateway->is_enabled() ) {
return $err->add( 'gateway-error', __( 'The selected payment gateway is not currently enabled.', 'lifterlms' ) );
// It's a recurring plan and the gateway doesn't support recurring.
} elseif ( $plan->is_recurring() && ! $gateway->supports( 'recurring_payments' ) ) {
// Translators: %s = The gateway display name.
return $err->add( 'gateway-error', sprintf( __( '%s does not support recurring payments and cannot process this transaction.', 'lifterlms' ), $gateway->get_title() ) );
// Not recurring and the gateway doesn't support single payments.
} elseif ( ! $plan->is_recurring() && ! $gateway->supports( 'single_payments' ) ) {
// Translators: %s = The gateway display name.
return $err->add( 'gateway-error', sprintf( __( '%s does not support single payments and cannot process this transaction.', 'lifterlms' ), $gateway->get_title() ) );
}
} else {
return $err->add( 'invalid-gateway', __( 'An invalid payment method was selected.', 'lifterlms' ) );
}
return $gateway;
}
/**
* Confirm order form post.
*
* User clicks confirm order or gateway determines the order is confirmed.
*
* Executes payment gateway confirm order method and completes order.
* Redirects user to appropriate page / post
*
* @since 3.0.0
* @since 3.4.0 Unknown.
* @since 3.34.4 Added filter `llms_order_can_be_confirmed`.
* @since 3.34.5 Fixed logic error in `llms_order_can_be_confirmed` conditional.
* @since 3.35.0 Return early if nonce doesn't pass verification and sanitize `$_POST` data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @deprecated 7.0.0 Deprecated in favor of {@see LLMS_Controller_Checkout::confirm_pending_order()}.
*
* @return void
*/
public function confirm_pending_order() {
_deprecated_function( __METHOD__, '7.0.0', 'LLMS_Controller_Checkout::confirm_pending_order' );
LLMS_Controller_Checkout::instance()->confirm_pending_order();
}
/**
* Handle form submission of the checkout / payment form.
*
* 1. Logs in or Registers a user
* 2. Validates all fields
* 3. Handles coupon pricing adjustments
* 4. Creates a PENDING llms_order
*
* If errors, returns error on screen to user
* If success, passes to the selected gateways "process_payment" method
* the process_payment method should complete by returning an error or
* triggering the "lifterlms_process_payment_redirect" // Todo check this last statement.
*
* @since 3.0.0
* @since 3.27.0 Unknown.
* @since 3.35.0 Sanitize `$_POST` data.
* @since 5.0.0 Build customer data using LLMS_Forms fields information.
* @since 5.0.1 Delegate sanitization of user information fields of the `$_POST` to LLMS_Form_Handler::submit().
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @deprecated 7.0.0 Deprecated in favor of {@see LLMS_Controller_Checkout::create_pending_order()}.
*
* @return void
*/
public function create_pending_order() {
_deprecated_function( __METHOD__, '7.0.0', 'LLMS_Controller_Checkout::create_pending_order' );
LLMS_Controller_Checkout::instance()->create_pending_order();
}
/**
* Handle form submission of the "Update Payment Method" form on the student dashboard when viewing a single order.
*
* @since 3.10.0
* @since 3.19.0 Unknown.
* @since 3.35.0 Sanitize `$_POST` data.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @deprecated 7.0.0 Deprecated in favor of {@see LLMS_Controller_Checkout::switch_payment_source()}.
*
* @return void
*/
public function switch_payment_source() {
_deprecated_function( __METHOD__, '7.0.0', 'LLMS_Controller_Checkout::switch_payment_source' );
LLMS_Controller_Checkout::instance()->switch_payment_source();
}
}
return new LLMS_Controller_Orders();
================================================
FILE: includes/controllers/class.llms.controller.quizzes.php
================================================
<?php
/**
* LLMS_Controller_Quizzes class file
*
* @package LifterLMS/Controllers/Classes
*
* @since 3.9.0
* @version 5.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Quiz related form controller
*
* @since 3.9.0
* @since 5.0.0 Removed previously deprecated method `LLMS_Controller_Quizzes::take_quiz()`.
*/
class LLMS_Controller_Quizzes {
/**
* Constructor
*
* @since 3.9.0
* @since 3.37.8 Add reporting actions handler action.
* @since 4.14.0 Remove `add_action()` for deprecated `take_quiz()` method.
*
* @return void
*/
public function __construct() {
add_action( 'admin_init', array( $this, 'maybe_handle_reporting_actions' ) );
}
/**
* Handle quiz reporting screen actions buttons
*
* On the quiz reporting screen this allows orphaned quizzes to be deleted.
*
* @since 3.37.8
* @since 5.1.0 Use a deep orphan check to determine if the quiz can be deleted.
* @since 9.2.3 Add capability check before deleting quiz.
*
* @return null|false|WP_Post `null` if the form wasn't submitted or the nonce couldn't be verified.
* `false` if an error was encountered.
* `WP_Post` of the deleted quiz on success.
*/
public function maybe_handle_reporting_actions() {
if ( ! isset( $_REQUEST['_llms_quiz_actions_nonce'] ) ) {
return null;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_llms_quiz_actions_nonce'] ) ), 'llms-quiz-actions' ) ) {
return null;
}
$id = llms_filter_input( INPUT_POST, 'llms_del_quiz', FILTER_SANITIZE_NUMBER_INT );
if ( $id && 'llms_quiz' === get_post_type( $id ) ) {
if ( ! current_user_can( 'delete_post', $id ) ) {
return false;
}
$quiz = llms_get_post( $id );
if ( $quiz && ( $quiz->is_orphan( true ) || ! $quiz->get_course() ) ) {
return wp_delete_post( $id, true );
}
}
return false;
}
}
return new LLMS_Controller_Quizzes();
================================================
FILE: includes/controllers/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/elementor/class-llms-elementor-widget-base.php
================================================
<?php
abstract class LLMS_Elementor_Widget_Base extends \Elementor\Widget_Base {
public function __construct( $data = array(), $args = null ) {
parent::__construct( $data, $args );
}
public function get_icon() {
return 'dashicons-before dashicons-welcome-learn-more';
}
public function get_categories() {
return array( 'lifterlms' );
}
protected function add_footer_promo_control() {
$this->add_control(
'llms_footer_promo',
array(
'label' => '',
'type' => \Elementor\Controls_Manager::RAW_HTML,
'raw' => '<hr><p style="margin-top: 20px;">' .
/* translators: %1$s: Opening learn more link tag, %2$s: Closing link tag. */
sprintf( esc_html__( 'Learn more about %1$sediting LifterLMS courses with Elementor%2$s', 'lifterlms' ), '<a target="_blank" href="https://lifterlms.com/docs/how-to-edit-courses-with-elementor/?utm_source=LifterLMS%20Plugin&utm_medium=Elementor%20Edit%20Panel%20&utm_campaign=Plugin%20to%20Sale">', '</a>' ) .
'</p>',
'content_classes' => 'lifterlms-notice',
)
);
}
protected function render() {
$settings = $this->get_settings_for_display();
echo do_shortcode( '[lifterlms_course_continue_button]' );
}
protected function _content_template() {
// Define your template variables here
}
}
================================================
FILE: includes/elementor/class-llms-elementor-widget-course-continue-button.php
================================================
<?php
class LLMS_Elementor_Widget_Course_Continue_Button extends LLMS_Elementor_Widget_Base {
public function get_name() {
return 'llms_course_continue_button_widget';
}
public function get_title() {
return __( 'Course Continue Button', 'lifterlms' );
}
protected function _register_controls() {
$this->start_controls_section(
'content_section',
array(
'label' => __( 'Course Continue Button', 'lifterlms' ),
'tab' => \Elementor\Controls_Manager::TAB_CONTENT,
)
);
$this->add_control(
'description',
array(
'label' => esc_html__( 'Show course continue button to students for the current course.', 'lifterlms' ),
'type' => \Elementor\Controls_Manager::HEADING,
'separator' => 'before',
)
);
$this->add_footer_promo_control();
$this->end_controls_section();
}
protected function render() {
$settings = $this->get_settings_for_display();
echo do_shortcode( '[lifterlms_course_continue_button]' );
}
}
================================================
FILE: includes/elementor/class-llms-elementor-widget-course-instructors.php
================================================
<?php
class LLMS_Elementor_Widget_Course_Instructors extends LLMS_Elementor_Widget_Base {
public function get_name() {
return 'llms_course_instructors_widget';
}
public function get_title() {
return __( 'Course Instructors', 'lifterlms' );
}
protected function _register_controls() {
$this->start_controls_section(
'content_section',
array(
'label' => __( 'Course Instructors', 'lifterlms' ),
'tab' => \Elementor\Controls_Manager::TAB_CONTENT,
)
);
$this->add_control(
'description',
array(
'label' => esc_html__( 'Show current course instructors.', 'lifterlms' ),
'type' => \Elementor\Controls_Manager::HEADING,
'separator' => 'before',
)
);
$this->add_footer_promo_control();
$this->end_controls_section();
}
protected function render() {
$settings = $this->get_settings_for_display();
echo do_shortcode( '[lifterlms_course_instructors]' );
}
}
================================================
FILE: includes/elementor/class-llms-elementor-widget-course-meta-info.php
================================================
<?php
class LLMS_Elementor_Widget_Course_Meta_Info extends LLMS_Elementor_Widget_Base {
public function get_name() {
return 'llms_course_meta_information_widget';
}
public function get_title() {
return __( 'Course Meta Information', 'lifterlms' );
}
protected function _register_controls() {
$this->start_controls_section(
'content_section',
array(
'label' => __( 'Course Meta Information', 'lifterlms' ),
'tab' => \Elementor\Controls_Manager::TAB_CONTENT,
)
);
$this->add_control(
'description',
array(
'label' => esc_html__( 'Show current course meta information.', 'lifterlms' ),
'type' => \Elementor\Controls_Manager::HEADING,
'separator' => 'before',
)
);
$this->add_footer_promo_control();
$this->end_controls_section();
}
protected function render() {
$settings = $this->get_settings_for_display();
echo do_shortcode( '[lifterlms_course_meta_info]' );
}
}
================================================
FILE: includes/elementor/class-llms-elementor-widget-course-progress.php
================================================
<?php
class LLMS_Elementor_Widget_Course_Progress extends LLMS_Elementor_Widget_Base {
public function get_name() {
return 'llms_course_progress_widget';
}
public function get_title() {
return __( 'Course Progress', 'lifterlms' );
}
protected function _register_controls() {
$this->start_controls_section(
'content_section',
array(
'label' => __( 'Course Progress', 'lifterlms' ),
'tab' => \Elementor\Controls_Manager::TAB_CONTENT,
)
);
$this->add_control(
'description',
array(
'label' => esc_html__( 'Show course progress to students for the current course.', 'lifterlms' ),
'type' => \Elementor\Controls_Manager::HEADING,
'separator' => 'before',
)
);
$this->add_footer_promo_control();
$this->end_controls_section();
}
protected function render() {
$settings = $this->get_settings_for_display();
echo do_shortcode( '[lifterlms_course_progress check_enrollment="1"]' );
}
}
================================================
FILE: includes/elementor/class-llms-elementor-widget-course-syllabus.php
================================================
<?php
class LLMS_Elementor_Widget_Course_Syllabus extends LLMS_Elementor_Widget_Base {
public function get_name() {
return 'llms_course_syllabus_widget';
}
public function get_title() {
return __( 'Course Syllabus', 'lifterlms' );
}
protected function _register_controls() {
$this->start_controls_section(
'content_section',
array(
'label' => __( 'Course Syllabus', 'lifterlms' ),
'tab' => \Elementor\Controls_Manager::TAB_CONTENT,
)
);
$this->add_control(
'description',
array(
'label' => esc_html__( 'Show course syllabus for the current course.', 'lifterlms' ),
'type' => \Elementor\Controls_Manager::HEADING,
'separator' => 'before',
)
);
$this->add_footer_promo_control();
$this->end_controls_section();
}
protected function render() {
$settings = $this->get_settings_for_display();
echo do_shortcode( '[lifterlms_course_syllabus]' );
}
}
================================================
FILE: includes/elementor/class-llms-elementor-widget-pricing-table.php
================================================
<?php
class LLMS_Elementor_Widget_Pricing_Table extends LLMS_Elementor_Widget_Base {
public function get_name() {
return 'llms_pricing_table_widget';
}
public function get_title() {
return __( 'Pricing Table', 'lifterlms' );
}
protected function _register_controls() {
$this->start_controls_section(
'content_section',
array(
'label' => __( 'Pricing Table', 'lifterlms' ),
'tab' => \Elementor\Controls_Manager::TAB_CONTENT,
)
);
$this->add_control(
'description',
array(
'label' => esc_html__( 'Show pricing table for the current course.', 'lifterlms' ),
'type' => \Elementor\Controls_Manager::HEADING,
'separator' => 'before',
)
);
$this->add_footer_promo_control();
$this->end_controls_section();
}
protected function render() {
$settings = $this->get_settings_for_display();
echo do_shortcode( '[lifterlms_pricing_table]' );
}
}
================================================
FILE: includes/elementor/class-llms-elementor-widgets.php
================================================
<?php
/**
* LifterLMS Elementor Widgets
*
* @package LifterLMS/Classes
*
* @since 7.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Elementor_Widgets
*
* @since 7.7.0
*/
class LLMS_Elementor_Widgets {
/**
* Constructor.
*
* @since 7.7.0
*
* @return void
*/
public function __construct() {
add_action( 'elementor/widgets/widgets_registered', array( $this, 'init' ) );
add_action( 'elementor/elements/categories_registered', array( $this, 'add_widget_categories' ) );
add_filter( 'llms_render_block', array( $this, 'maybe_stop_rendering_block' ), 10, 2 );
}
/**
* Avoid rendering blocks on the front-end that are in an Elementor page (ie. a Text Editor widget when page/post first edited).
*
* @param $should_render bool Whether to render the block or not.
* @param $block WP_Block The block instance.
*
* @return false|mixed
*/
function maybe_stop_rendering_block( $should_render, $block ) {
if ( ! class_exists( 'Elementor\Plugin' ) || ! method_exists( 'Elementor\Plugin', 'instance' ) ) {
return $should_render;
}
$instance = Elementor\Plugin::instance();
if ( ! $instance ) {
return $should_render;
}
$documents = $instance->documents;
if ( ! $documents || ! method_exists( $documents, 'get' ) ) {
return $should_render;
}
$document = $documents->get( get_the_ID() );
if ( ! $document || ! method_exists( $document, 'is_built_with_elementor' ) ) {
return $should_render;
}
if ( $document->is_built_with_elementor() ) {
$should_render = false;
}
return $should_render;
}
public function init() {
require_once LLMS_PLUGIN_DIR . 'includes/elementor/class-llms-elementor-widget-base.php';
require_once LLMS_PLUGIN_DIR . 'includes/elementor/class-llms-elementor-widget-course-meta-info.php';
require_once LLMS_PLUGIN_DIR . 'includes/elementor/class-llms-elementor-widget-course-instructors.php';
require_once LLMS_PLUGIN_DIR . 'includes/elementor/class-llms-elementor-widget-pricing-table.php';
require_once LLMS_PLUGIN_DIR . 'includes/elementor/class-llms-elementor-widget-course-progress.php';
require_once LLMS_PLUGIN_DIR . 'includes/elementor/class-llms-elementor-widget-course-continue-button.php';
require_once LLMS_PLUGIN_DIR . 'includes/elementor/class-llms-elementor-widget-course-syllabus.php';
\Elementor\Plugin::instance()->widgets_manager->register( new LLMS_Elementor_Widget_Course_Meta_Info() );
\Elementor\Plugin::instance()->widgets_manager->register( new LLMS_Elementor_Widget_Course_Instructors() );
\Elementor\Plugin::instance()->widgets_manager->register( new LLMS_Elementor_Widget_Pricing_Table() );
\Elementor\Plugin::instance()->widgets_manager->register( new LLMS_Elementor_Widget_Course_Progress() );
\Elementor\Plugin::instance()->widgets_manager->register( new LLMS_Elementor_Widget_Course_Continue_Button() );
\Elementor\Plugin::instance()->widgets_manager->register( new LLMS_Elementor_Widget_Course_Syllabus() );
}
public function add_widget_categories( $elements_manager ) {
$elements_manager->add_category(
'lifterlms',
array(
'title' => 'LifterLMS',
'icon' => 'dashicons-before dashicons-welcome-learn-more',
)
);
}
}
return new LLMS_Elementor_Widgets();
================================================
FILE: includes/emails/class.llms.email.engagement.php
================================================
<?php
/**
* Engagement Email
*
* @package LifterLMS/Emails/Classes
*
* @since 1.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Engagement Email Class
*
* Generates emails and sends to user. Triggered from an engagement.
*
* @since 1.0.0
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Email_Engagement extends LLMS_Email {
/**
* Email identifier
*
* @since 1.0.0
* @var string
*/
protected $id = 'engagement';
/**
* @since 3.8.0
* @var WP_User
*/
public $student;
/**
* Initialize all variables
*
* @since 1.0.0
* @since 3.8.0 Unknown.
*
* @param array $args Associative array of engagement args.
* @return void
*/
public function init( $args ) {
$this->student = new WP_User( $args['person_id'] );
$this->email_post = get_post( $args['email_id'] );
$this->add_merge_data(
array(
'{user_login}' => stripslashes( $this->student->user_login ),
'{first_name}' => stripslashes( $this->student->first_name ),
'{last_name}' => stripslashes( $this->student->last_name ),
'{email_address}' => stripslashes( $this->student->user_email ),
'{site_url}' => get_permalink( llms_get_page_id( 'myaccount' ) ),
'{current_date}' => date_i18n( get_option( 'date_format' ), current_time( 'timestamp' ) ),
)
);
// Setup subject, headline, & body.
$this->body = $this->email_post->post_content;
$this->subject = get_post_meta( $this->email_post->ID, '_llms_email_subject', true );
$this->heading = get_post_meta( $this->email_post->ID, '_llms_email_heading', true );
// Setup all the recipients.
foreach ( array( 'to', 'cc', 'bcc' ) as $type ) {
$list = get_post_meta( $this->email_post->ID, '_llms_email_' . $type, true );
// Fall back to student email for existing emails with no definition.
if ( ! $list && 'to' === $type ) {
$list = '{student_email}';
}
if ( ! $list ) {
continue;
}
foreach ( $this->merge_emails( $list ) as $email ) {
$this->add_recipient( $email, $type );
}
}
}
/**
* Handles email merge codes that can be used in the to, cc, and bcc fields
*
* @since 3.1.0
* @since 3.8.0 Unknown.
*
* @param string $list Unmerged, comma-separated list of emails
* @return array
*/
private function merge_emails( $list ) {
$codes = array(
'{student_email}',
'{admin_email}',
);
$addresses = array(
$this->student->ID,
get_option( 'admin_email' ),
);
$merged = str_replace( $codes, $addresses, $list );
$array = explode( ',', $merged );
return array_map( 'trim', $array );
}
/**
* Send email
*
* @since 5.0.0
*
* @return boolean
*/
public function send() {
add_filter( 'llms_user_info_shortcode_user_id', array( $this, 'set_shortcode_user' ) );
$ret = parent::send();
remove_filter( 'llms_user_info_shortcode_user_id', array( $this, 'set_shortcode_user' ) );
return $ret;
}
/**
* Set the user ID used by [llms-user] to the user receiving the email.
*
* @since 5.0.0
*
* @param int $uid WP_User ID of the current user.
* @return int
*/
public function set_shortcode_user( $uid ) {
return $this->student->ID;
}
}
================================================
FILE: includes/emails/class.llms.email.php
================================================
<?php
/**
* Email Base
*
* @package LifterLMS/Emails/Classes
*
* @since 1.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Email Base Class
*
* @since 1.0.0
* @since 3.30.3 Explicitly define class properties.
* @since 4.0.0 Always supply a from address even if the option is empty.
*/
class LLMS_Email {
/**
* @var array
* @since 3.15.0
*/
private $attachments = array();
/**
* @var string
* @since 3.8.0
*/
protected $body = '';
/**
* @var string
* @since 3.8.0
*/
protected $content_type = 'text/html';
/**
* @var WP_Post
* @since 3.26.1
*/
public $email_post;
/**
* @var array
* @since 1.0.0
*/
private $find = array();
/**
* @var array
* @since 3.8.0
*/
private $headers = array();
/**
* @var string
* @since 1.0.0
*/
protected $heading = '';
/**
* @var string
* @since 1.0.0
*/
protected $id = 'generic';
/**
* @var array
* @since 1.0.0
*/
private $recipient = array();
/**
* @var array
* @since 1.0.0
*/
private $replace = array();
/**
* @var string
* @since 1.0.0
*/
protected $subject = '';
/**
* @var string
* @since 3.8.0
*/
protected $template_html = 'emails/template.php';
/**
* Initializer
* Children can configure the email in this function called by the __construct() function
*
* @param array $args optional arguments passed in from the constructor
* @return void
* @since 3.8.0
* @version 3.8.0
*/
protected function init( $args ) {}
/**
* Constructor
* Sets up data needed to generate email content
*
* @since 1.0.0
* @version 3.8.0
*/
public function __construct( $args = array() ) {
$this->add_header( 'Content-Type', $this->get_content_type() );
$this->add_merge_data(
array(
'{blogname}' => get_bloginfo( 'name', 'display' ),
'{site_title}' => get_bloginfo( 'name', 'display' ),
'{divider}' => llms()->mailer()->get_divider_html(),
'{button_style}' => llms()->mailer()->get_button_style(),
)
);
$this->init( $args );
}
/**
* Add an attachment to the email
*
* @param string $attachment full system path to a file to attach
* @return void
* @since 3.15.0
* @version 3.15.0
*/
public function add_attachment( $attachment ) {
array_push( $this->attachments, $attachment );
}
/**
* Add a single header to the email headers array
*
* @param string $key header key eg: 'Cc'
* @param string $val header value eg: 'noreply@website.tld'
* @since 3.8.0
* @version 3.8.0
*/
public function add_header( $key, $val ) {
array_push( $this->headers, sprintf( '%1$s: %2$s', $key, $val ) );
}
/**
* Add merge data that will be used in the email
*
* @param array $data associative array where
* $key = merge field
* $val = merge value
* @since 3.8.0
* @version 3.8.0
*/
public function add_merge_data( $data = array() ) {
foreach ( $data as $find => $replace ) {
array_push( $this->find, $find );
array_push( $this->replace, $replace );
}
}
/**
* Add a single recipient for sending to, cc, or bcc
*
* @param int|string $address if string, must be a valid email address
* if int, must be the WP User ID of a user
* @param string $type recipient type [to,cc,bcc]
* @param string $name recipient name (optional)
* @return boolean
* @since 3.8.0
* @version 3.10.1
*/
public function add_recipient( $address, $type = 'to', $name = '' ) {
// If an ID was supplied, get the information from the student object.
if ( is_numeric( $address ) ) {
$student = llms_get_student( $address );
if ( ! $student ) {
return false;
}
$address = $student->get( 'user_email' );
$name = $student->get_name();
}
// Ensure address is a valid email.
if ( ! filter_var( $address, FILTER_VALIDATE_EMAIL ) ) {
return false;
}
// If a name is supplied format the name & address.
if ( $name ) {
$address = sprintf( '%1$s <%2$s>', $name, $address );
}
if ( 'to' === $type ) {
array_push( $this->recipient, $address );
return true;
} elseif ( 'cc' === $type || 'bcc' === $type ) {
$this->add_header( ucfirst( $type ), $address );
return true;
}
return false;
}
/**
* Add multiple recipients
*
* @param array $recipients array of recipient information
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function add_recipients( $recipients = array() ) {
foreach ( $recipients as $data ) {
$data = wp_parse_args(
$data,
array(
'address' => '',
'type' => 'to',
'name' => '',
)
);
if ( $data['address'] ) {
$this->add_recipient( $data['address'], $data['type'], $data['name'] );
}
}
}
/**
* Format string method
*
* Finds and replaces merge fields with appropriate data.
*
* @since 1.0.0
* @since 5.0.0 Process shortocdes when formatting a string.
*
* @param string $string String to be formatted.
* @return string
*/
public function format_string( $string ) {
return do_shortcode( str_replace( $this->find, $this->replace, $string ) );
}
/**
* Get attachments
*
* @return array
* @since 3.15.0
* @version 3.15.0
*/
public function get_attachments() {
return apply_filters( 'llms_email_get_attachments', $this->attachments, $this );
}
/**
* Get the body content of the email
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_body() {
return apply_filters( 'llms_email_body', $this->format_string( $this->body ), $this );
}
/**
* Get email content
*
* @return string
* @since 1.0.0
* @version 3.8.0
*/
public function get_content() {
$content = apply_filters( 'llms_email_content_get_content', $this->get_content_html(), $this );
return wordwrap( $content, 70 );
}
/**
* Get the HTML email content
*
* @return string
* @since 3.8.0
* @version 3.26.1
*/
public function get_content_html() {
global $post;
$temp = null;
// Override the $post global with the email post content (if it exists).
// This fixes Elementor / WC conflict outlined at https://github.com/gocodebox/lifterlms/issues/730.
if ( isset( $this->email_post ) ) {
$temp = $post;
$post = $this->email_post;
}
ob_start();
llms_get_template(
$this->template_html,
array(
'email_heading' => $this->get_heading(),
'email_message' => $this->get_body(),
)
);
$html = apply_filters( 'llms_email_content_get_content_html', ob_get_clean(), $this );
// Restore the default $post global.
if ( $temp ) {
$post = $temp;
}
return $html;
}
/**
* Get the content type
*
* @return string
* @since 1.0.0
* @version 3.8.0
*/
public function get_content_type() {
return apply_filters( 'llms_email_content_type', $this->content_type, $this );
}
/**
* Get from email option data
*
* @since 1.0.0
* @since 4.0.0 Use the address provided by `wp_mail_from` as the default if no option is stored.
*
* @return string
*/
public function get_from_address( $from_address ) {
return sanitize_email( get_option( 'lifterlms_email_from_address', $from_address ) );
}
/**
* Get from name option data
*
* @return string
* @since 1.0.0
* @version 1.0.0
*/
public function get_from_name() {
return wp_specialchars_decode( esc_html( get_option( 'lifterlms_email_from_name' ) ), ENT_QUOTES );
}
/**
* Get email headers
*
* @return string|array
* @since 1.0.0
* @version 3.8.0
*/
public function get_headers() {
return apply_filters( 'lifterlms_email_headers', $this->headers, $this->id );
}
/**
* Get the text of the email "heading"
*
* @return string
* @since 1.0.0
* @version 3.8.0
*/
public function get_heading() {
return apply_filters( 'lifterlms_email_heading', $this->format_string( $this->heading ), $this );
}
/**
* Get recipient email address
*
* @return string|array
* @since 1.0.0
* @version 3.8.0
*/
public function get_recipient() {
return apply_filters( 'lifterlms_email_recipient', $this->recipient, $this );
}
/**
* Get email subject
*
* @return string
* @since 1.0.0
* @version 3.8.0
*/
public function get_subject() {
return apply_filters( 'lifterlms_email_subject', $this->format_string( $this->subject ), $this );
}
/**
* Set the body for the email
*
* @param string $body text or html body content for the email
* @return $this
* @since 3.8.0
* @version 3.8.0
*/
public function set_body( $body = '' ) {
$this->body = $body;
return $this;
}
/**
* set the content_type for the email
*
* @param string $content_type content type (for the header)
* @return $this
* @since 3.8.0
* @version 3.8.0
*/
public function set_content_type( $content_type = 'text/html' ) {
$this->content_type = $content_type;
return $this;
}
/**
* set the heading for the email
*
* @param string $heading text string to use for the email heading
* @return $this
* @since 3.8.0
* @version 3.8.0
*/
public function set_heading( $heading = '' ) {
$this->heading = $heading;
return $this;
}
/**
* Set the ID of the email
*
* @param string $id id string
* @return $this
* @since 3.8.0
* @version 3.8.0
*/
public function set_id( $id = '' ) {
$this->id = $id;
return $this;
}
/**
* set the subject for the email
*
* @param string $subject Text string to use for the email subject.
* @return $this
* @since 3.8.0
* @version 3.24.0
*/
public function set_subject( $subject = '' ) {
$this->subject = html_entity_decode( $subject, ENT_QUOTES );
return $this;
}
/**
* Send email
*
* @return bool
* @since 1.0.0
* @version 3.15.0
*/
public function send() {
do_action( 'lifterlms_email_' . $this->id . '_before_send', $this );
add_filter( 'wp_mail_from', array( $this, 'get_from_address' ) );
add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ) );
add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
$return = wp_mail( $this->get_recipient(), $this->get_subject(), $this->get_content(), $this->get_headers(), $this->get_attachments() );
remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ) );
remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ) );
remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
do_action( 'lifterlms_email_' . $this->id . '_after_send', $this, $return );
return $return;
}
}
================================================
FILE: includes/emails/class.llms.email.reset.password.php
================================================
<?php
/**
* LifterLMS Password Reset Email
*
* @package LifterLMS/Emails/Classes
*
* @since 1.0.0
* @version 3.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Password Reset Email class
*
* @since 1.0.0
* @version 3.8.0
*/
class LLMS_Email_Reset_Password extends LLMS_Email {
protected $id = 'reset_password';
/**
* Initializer
*
* @param array $args associative array of user related data for the email to be sent
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function init( $args = array() ) {
$this->add_recipient( $args['user']->ID );
$original_locale = get_locale();
$locale = get_user_locale( $args['user']->ID );
if ( $locale && $locale !== $original_locale ) {
switch_to_locale( $locale );
}
$this->body = $this->get_body_content( $args );
$this->subject = __( 'Password Reset for {site_title}', 'lifterlms' );
$this->heading = __( 'Reset Your Password', 'lifterlms' );
if ( $locale && $locale !== $original_locale ) {
restore_previous_locale();
}
$this->add_merge_data(
array(
'{user_login}' => $args['login_display'],
)
);
}
/**
* Custom content for the password reset email
*
* @param array $data associative array of user related data for the email to be sent
* @since 3.8.0
*/
public function get_body_content( $data ) {
$url = esc_url(
add_query_arg(
array(
'key' => $data['key'],
'login' => rawurlencode( $data['user']->user_login ),
),
wp_lostpassword_url()
)
);
ob_start();
llms_get_template(
'emails/reset-password.php',
array(
'url' => $url,
)
);
return ob_get_clean();
}
}
================================================
FILE: includes/emails/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/forms/class-llms-form-field.php
================================================
<?php
/**
* Setup and render form fields.
*
* @package LifterLMS/Classes
*
* @since 5.0.0
* @version 6.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Form_Field class
*
* @since 5.0.0
*/
class LLMS_Form_Field {
/**
* Form Field Settings
*
* @var array {
* Array of field settings.
*
* @type array $attributes Associative array of HTML attributes to add to the field element.
* @type bool $checked Determines if radio and checkbox fields are checked.
* @type int $columns Number of columns the field wrapper should occupy when rendered. Accepts integers >= 1 and <= 12.
* @type string[]|string $classes Additional CSS classes to add to the field element. Accepts a string or an array of strings.
* @type string $data_store Determines where to store field values. Accepts "users" or "usermeta" to store on the respective WP core tables.
* @type string|false $data_store_key Determines the key name to use when storing the field value. Pass `false` to disable automatic storage. Defaults to the value of the `$name` property.
* @type string $description A string to use as the field's description or helper text.
* @type string $default The default value to use for the field.
* @type bool $disabled Whether or not the field is enabled.
* @type string $id The field's HTML "id" attribute. Must be unique. If not supplied, an ID is automatically generated.
* @type string $label Text to use in the label element associated with the field.
* @type bool $label_show_empty When true and no `$label` is supplied, will show an empty label element.
* @type bool $last_column When true, outputs a clearfix element following the element's wrapper. Allows ending a "row" of fields.
* @type bool $match Match this field to another field for validation purposes. Must be the `$id` of another field in the form.
* @type string $name The field's HTML "name" attribute. Default's to the value of `$id` when not supplied.
* @type array $options An associative array of options used for select, checkbox groups, and radio fields.
* @type string $options_preset A string representing a pre-defined set of `$options`. Accepts "countries" or "states". Custom presets can be defined using the filter "llms_form_field_options_preset_{$preset_id}".
* @type string $placeholder The field's HTML placeholder attribute.
* @type bool $required Determines if the field is marked as required.
* @type string $selected Alias of `$default`.
* @type string $type Field type. Accepts any HTML5 input type (text, email, tel, etc...), radio, checkbox, select, textarea, button, reset, submit, and html.
* @type string $value Value of the field.
* @type string $visibility_toggle Determines if the field should show a button to toggle field masking (for password fields).
* @type string[]|string $wrapper_classes Additional CSS classes to add to the field's wrapper element. Accepts a string or an array of strings.
* }
*/
protected $settings = array();
/**
* Cached field HTML.
*
* @var string
*/
protected $html = '';
/**
* Data source where to get field value from.
*
* @var null|WP_Post|WP_User
*/
private $data_source;
/**
* Data source type where to get field value from.
*
* @var null|string
*/
private $data_source_type;
/**
* Constructor
*
* @since 5.0.0
*
* @param array $settings Field settings.
* @param int|object $data_source Optional. Data source where to get field value from. Default is `null`.
* Can be a WP_User or a WP_Post, or their id.
* The actual object will be retrieved basing on the data_store.
* @return void
*/
public function __construct( $settings = array(), $data_source = null ) {
/**
* Filters the settings of a LifterLMS Form Field
*
* @since 5.0.0
*
* @param array $settings Field settings.
* @param LLMS_Form_Field $field Form field class instance.
*/
$this->settings = apply_filters( 'llms_field_settings', wp_parse_args( $settings, $this->get_defaults() ), $this );
$this->define_data_source( $data_source );
$this->prepare();
}
/**
* Define the source of the data
*
* @since 5.0.0
*
* @param int|object $data_source Data source where to get field value from.
* @return void
*/
private function define_data_source( $data_source ) {
if ( empty( $this->settings['data_store'] ) || ! in_array( $this->settings['data_store'], array( 'users', 'usermeta' ), true ) ) {
return;
}
if ( ! is_null( $data_source ) ) {
$data_source = $data_source instanceof WP_User ? $data_source : get_user_by( 'ID', $data_source );
} elseif ( is_user_logged_in() ) {
$data_source = wp_get_current_user();
}
if ( $data_source instanceof WP_User ) {
$this->data_source = $data_source;
$this->data_source_type = 'wp_user';
}
}
/**
* Merge an array of classes into a string or array of classes
*
* @since 5.0.0
*
* @param string[]|string $classes Classes.
* @param string[] $defaults Default classes.
* @return string[]
*/
protected function classes_ensure_array( $classes, $defaults = array() ) {
if ( is_string( $classes ) ) {
$classes = array_map( 'esc_attr', array_map( 'trim', explode( ' ', $classes ) ) );
}
$classes = array_merge( $defaults, $classes );
return array_filter( $classes );
}
/**
* Returns an array of form field objects from this checkbox or radio field's options array.
*
* @since 6.2.0 Moved from `LLMS_Form_Field::get_field_html()` and added the hidden logic.
*
* @param string $is_hidden If true, returns only the checked fields and sets their type to 'hidden',
* else returns all options as `$this->settings['type']` form fields.
* @return LLMS_Form_Field[]
*/
public function explode_options_to_fields( $is_hidden = false ) {
$fields = array();
$value = ! empty( $this->settings['value'] ) || is_array( $this->settings['value'] )
? $this->settings['value']
: $this->settings['default'];
foreach ( $this->settings['options'] as $key => $val ) {
$name = $this->settings['name'];
$checked = $value === $key;
if ( 'checkbox' === $this->settings['type'] ) {
$name .= '[]';
$value = is_array( $value ) ? $value : array( $value );
$checked = in_array( $key, $value, true );
}
if ( $is_hidden && ! $checked ) {
continue;
}
$fields[] = new self(
array(
'data_store' => false,
'id' => sprintf( '%1$s--%2$s', $this->settings['id'], $key ),
'name' => $name,
'value' => $key,
'label' => $val,
'checked' => $checked,
'type' => $is_hidden ? 'hidden' : $this->settings['type'],
)
);
}
return $fields;
}
/**
* Get default field settings.
*
* @since 5.0.0
*
* @return array
*/
protected function get_defaults() {
return array(
'attributes' => array(),
'checked' => false,
'columns' => 12,
'classes' => array(), // Or string of space-separated classes.
'data_store' => 'usermeta', // Users or usermeta.
'data_store_key' => '', // Defaults to value passed for "name".
'description' => '',
'default' => '',
'disabled' => false,
'id' => '',
'label' => '',
'label_show_empty' => false,
'last_column' => true,
'match' => '', // Test.
'name' => '', // Defaults to value passed for "id".
'options' => array(),
'options_preset' => '',
'placeholder' => '',
'required' => false,
'selected' => '', // Alias of "default".
'type' => 'text',
'value' => '',
'visibility_toggle' => false,
'wrapper_classes' => array(), // Or string of space-separated classes.
);
}
/**
* Ensure deprecated settings still function.
*
* The legacy "min_length", "max_length", and "style" settings should now
* be passed via the "attributes" setting.
*
* @since 5.0.0
*
* @return array
*/
protected function get_deprecated_html_attributes() {
$attrs = array();
foreach ( array( 'min_length', 'max_length', 'style' ) as $attr ) {
if ( isset( $this->settings[ $attr ] ) ) {
$attrs[ str_replace( '_', '', $attr ) ] = esc_attr( $this->settings[ $attr ] );
}
}
return $attrs;
}
/**
* Retrieve HTML for the fields description
*
* @since 5.0.0
*
* @return string
*/
protected function get_description_html() {
return $this->settings['description'] ? sprintf( '<span class="llms-description">%s</span>', $this->settings['description'] ) : '';
}
/**
* Retrieve HTML for the visibility toggle button
*
* @since TBD
*
* @return string
*/
protected function get_visibility_toggle_html() {
return $this->settings['visibility_toggle'] ? '<div class="llms-visibility-toggle"><button type="button" class="llms-button-plain hide-if-no-js" data-toggle="1"><i class="fa fa-eye"></i> <span class="llms-visibility-toggle-state">' . esc_html__( 'Show Password', 'lifterlms' ) . '</span></button></div>' : '';
}
/**
* Retrieve the full HTML for the field.
*
* @since 5.0.0
* @since 6.2.0 Moved exploding of checkbox and radio options to `explode_options_to_fields()`.
*
* @return string
*/
protected function get_field_html() {
/**
* Allow 3rd parties to create custom field types or their own field HTML methods.
*
* Returning a non-empty string will override default HTML generation and use the returned HTML instead.
*
* @since 5.0.0
*
* @param string $html Override html.
* @param array $settings Array of field settings initially passed to the class constructor.
* @param LLMS_Form_Field $field Form field object.
*/
$override = apply_filters( 'llms_form_field_get_' . $this->settings['type'] . '_html', '', $this->settings, $this );
if ( ! empty( $override ) ) {
return $override;
}
$extra_attrs = array();
$inner_html = '';
$self_closing = false;
switch ( $this->settings['type'] ) {
case 'button':
case 'reset':
case 'submit':
$tag = 'button';
$classes = array( 'llms-field-button' );
$inner_html = $this->settings['value'];
$extra_attrs['type'] = $this->settings['type'];
break;
case 'checkbox':
case 'radio':
$is_group = ! empty( $this->settings['options'] );
$tag = $is_group ? 'div' : 'input';
$self_closing = ! $is_group;
$classes = array( sprintf( 'llms-field-%s', $this->settings['type'] ) );
if ( ! $is_group ) {
$extra_attrs['type'] = $this->settings['type'];
if ( true === $this->settings['checked'] ) {
$extra_attrs['checked'] = 'checked';
}
} else {
$classes[] = 'llms-input-group';
$fields = $this->explode_options_to_fields( false );
foreach ( $fields as $field ) {
$inner_html .= $field->get_html();
}
}
break;
case 'html':
$tag = 'div';
$classes = array( 'llms-field-html' );
$inner_html = $this->settings['value'];
break;
case 'select':
$tag = 'select';
$classes = array( 'llms-field-select' );
$inner_html = $this->get_options_html();
break;
case 'textarea':
$tag = 'textarea';
$classes = array( 'llms-field-textarea' );
$inner_html = $this->settings['value'];
break;
default:
$tag = 'input';
$self_closing = true;
$classes = array( 'llms-field-input' );
$extra_attrs['type'] = $this->settings['type'];
}
$extra_attrs['class'] = implode( ' ', $this->classes_ensure_array( $this->settings['classes'], $classes ) );
$attributes = array_merge( $this->get_html_attributes( $this->settings ), $extra_attrs );
ksort( $attributes );
$attrs = '';
foreach ( $attributes as $attr => $val ) {
$attrs .= sprintf( ' %1$s="%2$s"', $attr, $val );
}
$open = $self_closing ? sprintf( '<%1$s%2$s', $tag, $attrs ) : sprintf( '<%1$s%2$s>', $tag, $attrs );
$close = $self_closing ? ' />' : sprintf( '</%s>', $tag );
return sprintf( '%1$s%2$s%3$s', $open, $inner_html, $close );
}
/**
* Retrieve an array of HTML attributes which should be added to the main field element.
*
* @since 5.0.0
*
* @return array
*/
protected function get_html_attributes() {
$check = array(
'id',
'disabled',
'name',
'placeholder',
'required',
'value',
);
// Input groups and html only have an id.
if ( $this->is_input_group() || 'html' === $this->settings['type'] ) {
$check = array( 'id' );
}
$attrs = array();
// Settings attributes.
foreach ( $check as $attr ) {
if ( ! empty( $this->settings[ $attr ] ) ) {
$attrs[ $attr ] = esc_attr( wp_strip_all_tags( $this->settings[ $attr ] ) );
}
}
// Any custom attributes.
foreach ( $this->settings['attributes'] as $attr => $val ) {
$attrs[ $attr ] = esc_attr( wp_strip_all_tags( $val ) );
}
if ( $this->settings['match'] ) {
$attrs['data-match'] = $this->settings['match'];
}
return array_merge( $attrs, $this->get_deprecated_html_attributes() );
}
/**
* Retrieve the field's HTML.
*
* @since 5.0.0
*
* @return string
*/
public function get_html() {
/**
* Short-circuit field HTML generation.
*
* Allows a 3rd party to replace the HTML generation method with entirely custom HTML
* by returning a non-null value.
*
* @since 5.0.0
*
* @param string $pre The pre-rendered HTML content. Default `null`.
* @param array $settings The prepared field settings array.
* @param LLMS_Form_Field $field_obj Form field instance.
*/
$pre = apply_filters( 'llms_form_field_pre_render', null, $this->settings, $this );
if ( ! is_null( $pre ) ) {
return $pre;
}
$before = '';
$after = '';
if ( 'hidden' !== $this->settings['type'] ) {
$before .= sprintf( '<div class="%s">', implode( ' ', $this->settings['wrapper_classes'] ) );
$label_pos = $this->get_label_position();
$$label_pos .= $this->get_label_html();
$desc = $this->get_description_html();
if ( $this->is_input_group() ) {
$before .= $desc;
} else {
$after .= $this->get_description_html();
}
$after .= $this->get_visibility_toggle_html();
$after .= '</div>';
if ( $this->settings['last_column'] ) {
$after .= '<div class="clear"></div>';
}
}
$this->html = $before . $this->get_field_html() . $after;
return apply_filters( 'llms_form_field', $this->html, $this->settings );
}
/**
* Retrieve the HTML for the fields label.
*
* @since 5.0.0
*
* @return string
*/
protected function get_label_html() {
if ( empty( $this->settings['label'] ) && ! $this->settings['label_show_empty'] ) {
return '';
}
$required = '';
if ( $this->settings['required'] ) {
/**
* Customize the character used to denote a required field
*
* @since Unknown.
*
* @param string $character The character used to denote a required field. Defaults to "*" (an asterisk).
* @param array $settings Associative array of field settings.
*/
$char = apply_filters( 'lifterlms_form_field_required_character', '*', $this->settings );
$required = sprintf( '<span class="llms-required">%s</span>', $char );
}
return sprintf( '<label for="%1$s">%2$s%3$s</label>', esc_attr( $this->settings['id'] ), $this->settings['label'], $required );
}
/**
* Determines if the label element should be rendered before the field or after it.
*
* @since 5.0.0
*
* @return string
*/
protected function get_label_position() {
$pos = 'before';
if ( in_array( $this->settings['type'], array( 'checkbox', 'radio' ), true ) && empty( $this->settings['options'] ) ) {
$pos = 'after';
}
return $pos;
}
/**
* Retrieve the HTML for an options list in a select field.
*
* This function works recursively to build optgroups.
*
* @since 5.0.0
*
* @param array $options Prepared options array.
* @param mixed $selected_val The value of the option that should be marked as "selected".
* @return string
*/
protected function get_option_list_html( $options, $selected_val ) {
$html = '';
foreach ( $options as $key => $val ) {
if ( is_array( $val ) ) {
$label = isset( $val['label'] ) ? $val['label'] : $key;
$group_options = isset( $val['options'] ) ? $val['options'] : $val;
$html .= sprintf( '<optgroup label="%1$s" data-key="%2$s">%3$s</optgroup>', esc_attr( $label ), esc_attr( $key ), $this->get_option_list_html( $group_options, $selected_val ) );
} else {
$selected = ( (string) $key === (string) $selected_val ) ? ' selected="selected"' : '';
$disabled = ( $this->settings['placeholder'] && '' === $key ) ? ' disabled="disabled"' : '';
$html .= sprintf( '<option value="%1$s"%3$s%4$s>%2$s</option>', esc_attr( $key ), esc_attr( $val ), $selected, $disabled );
}
}
return $html;
}
/**
* Retrieve the html for all options in a select field.
*
* @since 5.0.0
*
* @return string
*/
protected function get_options_html() {
$html = '';
if ( ! $this->settings['options'] ) {
return $html;
}
$selected_val = ! empty( $this->settings['value'] ) ? $this->settings['value'] : $this->settings['default'];
$html .= $this->get_option_list_html( $this->settings['options'], $selected_val );
return $html;
}
/**
* Retrieve the field settings array.
*
* @since 5.0.0
*
* @return array
*/
public function get_settings() {
return $this->settings;
}
/**
* Determines if the field is a group of checkboxes or radios.
*
* @since 5.0.0
*
* @return bool
*/
protected function is_input_group() {
return in_array( $this->settings['type'], array( 'checkbox', 'radio' ), true ) && ! empty( $this->settings['options'] );
}
/**
* Prepares the field for rendering by configuring all of it's settings.
*
* @since 5.0.0
*
* @return void
*/
protected function prepare() {
if ( empty( $this->settings['id'] ) ) {
$this->settings['id'] = uniqid( 'llms-field-' );
}
$this->prepare_wrapper_classes();
$this->settings['classes'] = $this->classes_ensure_array( $this->settings['classes'] );
// Allow setting `disabled` to `true` to disable the field.
if ( true === $this->settings['disabled'] ) {
$this->settings['disabled'] = 'disabled';
}
// Allow setting `required` to `true` to make the field required the field.
if ( true === $this->settings['required'] ) {
$this->settings['required'] = 'required';
}
// When name is `false` we don't want to output a name on the field.
if ( false !== $this->settings['name'] ) {
// Use the field id as the name if name isn't specified.
$this->settings['name'] = empty( $this->settings['name'] ) ? $this->settings['id'] : $this->settings['name'];
}
// When `data_store_key` is false we won't automatically store or populate the field.
if ( false !== $this->settings['data_store_key'] && empty( $this->settings['data_store_key'] ) ) {
$this->prepare_storage();
}
// Add preset options.
if ( $this->settings['options_preset'] ) {
$this->prepare_options_from_preset();
} elseif ( ! empty( $this->settings['options'] ) ) {
$this->settings['options'] = $this->prepare_options( $this->settings['options'] );
}
$this->prepare_value();
if ( 'llms-password-strength-meter' === $this->settings['id'] ) {
$this->prepare_password_strength_meter();
} elseif ( 'llms_voucher' === $this->settings['id'] ) {
$this->prepare_voucher();
}
}
/**
* Prepare the fields options.
*
* Allows options to be setup as an associative array of key/value pairs or
* an array of associative arrays each with a "label" and "key" property.
* The "key" property may be omitted, in which case the "label" will be
* duplicated as the option's "value".
*
* @since 5.0.0
*
* @param array $raw Raw field data.
* @return array
*/
protected function prepare_options( $raw ) {
$prepared = array();
foreach ( $raw as $key => $val ) {
if ( is_array( $val ) ) {
// Option group.
if ( isset( $val['options'] ) ) {
$prepared[ $key ] = array(
'label' => isset( $val['label'] ) ? $val['label'] : $key,
'options' => $this->prepare_options( $val['options'] ),
);
// From block editor options array.
} elseif ( isset( $val['text'] ) ) {
$item_key = isset( $val['key'] ) ? $val['key'] : $val['text'];
$prepared[ $item_key ] = $val['text'];
if ( isset( $val['default'] ) && llms_parse_bool( $val['default'] ) ) {
if ( 'checkbox' === $this->settings['type'] ) { // Account for multiple defaults.
$this->settings['default'] = is_array( $this->settings['default'] ) ? $this->settings['default'] : array();
$this->settings['default'][] = $item_key;
} else {
$this->settings['default'] = $item_key;
}
}
}
// Flat array of $key=>$val.
} else {
$prepared[ $key ] = $val;
}
}
// Add a placeholder.
if ( $this->settings['placeholder'] ) {
$this->settings['default'] = '';
$prepared = array_merge( array( '' => $this->settings['placeholder'] ), $prepared );
}
return $prepared;
}
/**
* Retrieve options list data based on the options_preset settings.
*
* @since 5.0.0
*
* @return void
*/
protected function prepare_options_from_preset() {
$preset_id = $this->settings['options_preset'];
switch ( $preset_id ) {
case 'countries':
$options = get_lifterlms_countries();
$default = get_lifterlms_country();
$this->settings['wrapper_classes'][] = 'llms-l10n-country-select';
break;
case 'states':
$options = llms_get_states();
$this->settings['wrapper_classes'][] = 'llms-l10n-state-select';
break;
default:
/**
* Define custom / 3rd party presets
*
* @since 5.0.0
*
* @param array $options Array of options.
* @param array $settings Prepared field settings.
* @param LLMS_Form_Field $fomr_field Form field object instance.
*/
$options = apply_filters( "llms_form_field_options_preset_{$preset_id}", array(), $this->settings, $this );
}
if ( isset( $options ) ) {
$this->settings['options'] = $options;
}
if ( isset( $default ) && ! $this->settings['default'] ) {
$this->settings['default'] = $default;
}
}
/**
* Additional preparation for the password strength meter.
*
* @since 5.0.0
* @since 5.10.0 Make sure to enqueue the strength meter js, whether or not `wp_enqueue_scripts` hook has been fired yet.
*
* @return void
*/
protected function prepare_password_strength_meter() {
$meter_settings = array(
'blocklist' => array(),
'min_strength' => ! empty( $this->settings['min_strength'] ) ? $this->settings['min_strength'] : 'weak',
'min_length' => ! empty( $this->settings['min_length'] ) ? max( 6, $this->settings['min_length'] ) : 6,
);
// Backwards compat functionality ends up outputting a minlength attribute on the <div> and we don't want that.
unset( $this->settings['min_length'] );
/**
* Modify password strength meter settings.
*
* @since 5.0.0
*
* @param array $meter_settings {
* Hash of meter configuration options.
*
* @type string[] $blocklist A list of strings that are penalized when used in the password. See "user_inputs" at https://github.com/dropbox/zxcvbn#usage.
* @type string $min_strength The minimum acceptable password strength. Accepts "strong", "medium", or "weak". Default: "weak".
* @type int $min_length The minimum acceptable password length. Must be >= 6. Default: 6.
* }
*/
$meter_settings = apply_filters( 'llms_password_strength_meter_settings', $meter_settings, $this->settings, $this );
// If scripts have been enqueued, add password strength meter script.
if ( did_action( 'wp_enqueue_scripts' ) ) {
return $this->enqueue_strength_meter( $meter_settings );
}
// Otherwise add it whe `wp_enqueue_scripts` is fired.
add_action(
'wp_enqueue_scripts',
function () use ( $meter_settings ) {
$this->enqueue_strength_meter( $meter_settings );
}
);
}
/**
* Enqueue password strength meter script.
*
* @since 5.10.0
*
* @param array $meter_settings {
* Hash of meter configuration options.
*
* @type string[] $blocklist A list of strings that are penalized when used in the password. See "user_inputs" at https://github.com/dropbox/zxcvbn#usage.
* @type string $min_strength The minimum acceptable password strength. Accepts "strong", "medium", or "weak". Default: "weak".
* @type int $min_length The minimum acceptable password length. Must be >= 6. Default: 6.
* }
* @return void
*/
private function enqueue_strength_meter( $meter_settings ) {
wp_enqueue_script( 'password-strength-meter' );
// Localize the script with meter data.
llms()->assets->enqueue_inline(
'llms-pw-strength-settings',
'window.LLMS.PasswordStrength = window.LLMS.PasswordStrength || {};window.LLMS.PasswordStrength.get_settings = function() { return JSON.parse( \'' . wp_json_encode( $meter_settings ) . '\' ); };',
'footer',
15
);
}
/**
* Setup default storage information.
*
* Ensures fields stored on the wp_users table have the proper default `data_store`.
*
* @since 5.0.0
*
* @return void
*/
protected function prepare_storage() {
$name = $this->settings['name'];
// Field Name => Storage Key.
$users_fields = array(
// We prefer these aliases for legacy reasons.
'email_address' => 'user_email',
'password' => 'user_pass',
// Default wp_users column names.
'user_login' => 'user_login',
'user_pass' => 'user_pass',
'user_nicename' => 'user_nicename',
'user_email' => 'user_email',
'user_url' => 'user_url',
'display_name' => 'display_name',
);
// Set data storage for items on the wp_users table.
if ( in_array( $name, array_keys( $users_fields ), true ) ) {
$this->settings['data_store'] = 'users';
$name = $users_fields[ $name ];
// Don't save default core confirmation fields.
} elseif ( in_array( $name, LLMS_CONFIRMATION_FIELDS, true ) ) {
$this->settings['data_store'] = false;
}
$this->settings['data_store_key'] = $name;
}
/**
* Prepare the field's value.
*
* @since 5.0.0
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
protected function prepare_value() {
// Never autoload passwords and or fields with an explicit value (except radio and checkbox).
if ( 'password' === $this->settings['type'] || ! empty( $this->settings['value'] && ! in_array( $this->settings['type'], array( 'checkbox', 'radio' ), true ) ) ) {
return;
}
$user_val = null;
// Attempt to populate field data from the most recent $_POST action.
if ( 'POST' === strtoupper( getenv( 'REQUEST_METHOD' ) ) ) {
$posted = wp_unslash( $_POST ); // phpcs:ignore WordPress.Security.NonceVerification.Missing -- nonce is verified prior to reaching this method.
if ( isset( $posted[ $this->settings['name'] ] ) ) {
$filter_options = is_array( $posted[ $this->settings['name'] ] ) ? array( FILTER_REQUIRE_ARRAY ) : array();
$user_val = llms_filter_input_sanitize_string( INPUT_POST, $this->settings['name'], $filter_options );
}
}
// Auto-populate field from the datastore if we have a user and datastore information.
if ( is_null( $user_val ) && ( isset( $this->data_source ) && 'wp_user' === $this->data_source_type ) && $this->settings['data_store_key'] ) {
$user_val = $this->data_source->get( $this->settings['data_store_key'] );
}
// Set the value to the user's submitted or stored value.
if ( ! is_null( $user_val ) ) {
if ( in_array( $this->settings['type'], array( 'checkbox', 'radio' ), true ) && ! $this->is_input_group() ) {
$this->settings['checked'] = ( $this->settings['value'] === $user_val );
} else {
$this->settings['value'] = $user_val;
}
}
// Handle "default" alias "selected".
if ( isset( $this->settings['selected'] ) && '' !== $this->settings['selected'] ) {
$this->settings['default'] = $this->settings['selected'];
}
// Add default value if there's no explicit value and a default value is set.
if ( ! $this->settings['value'] && ! is_array( $this->settings['value'] ) && '' !== $this->settings['default'] ) {
$this->settings['value'] = $this->settings['default'];
}
}
/**
* Additional preparation for the special voucher field.
*
* @since 5.0.0
*
* @return void
*/
protected function prepare_voucher() {
if ( ! $this->settings['required'] && $this->settings['toggleable'] ) {
$this->settings['label'] = sprintf( '<a class="llms-voucher-toggle" id="llms-voucher-toggle" href="#">%s</a>', $this->settings['label'] );
$this->settings['attributes']['style'] = 'display:none;';
$this->settings['data_store_key'] = false;
}
}
/**
* Prepare CSS wrapper classes for the field.
*
* @since 5.0.0
*
* @return void
*/
protected function prepare_wrapper_classes() {
$defaults = array();
// Base field class.
$defaults[] = 'llms-form-field';
// Add class for the field type.
$defaults[] = sprintf( 'type-%s', $this->settings['type'] );
if ( $this->is_input_group() ) {
$defaults[] = 'is-group';
}
// Add columns classes.
$defaults[] = sprintf( 'llms-cols-%d', $this->settings['columns'] );
if ( $this->settings['last_column'] ) {
$defaults[] = 'llms-cols-last';
}
// If required, add a class.
if ( $this->settings['required'] ) {
$defaults[] = 'llms-is-required';
}
$this->settings['wrapper_classes'] = $this->classes_ensure_array(
$this->settings['wrapper_classes'],
$defaults
);
}
/**
* Render/output the field's html.
*
* @since 5.0.0
*
* @return void
*/
public function render() {
if ( ! $this->html ) {
$this->get_html();
}
echo wp_kses( $this->html, LLMS_ALLOWED_HTML_FORM_FIELDS );
}
}
================================================
FILE: includes/forms/class-llms-form-handler.php
================================================
<?php
/**
* Handle LifterLMS Form submissions.
*
* @package LifterLMS/Classes
*
* @since 5.0.0
* @version 7.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Form_Handler class.
*
* @since 5.0.0
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
*/
class LLMS_Form_Handler {
use LLMS_Trait_Singleton;
/**
* Validation class instance.
*
* @var LLMS_Form_Validator
*/
protected $validator = null;
/**
* Private Constructor.
*
* @since 5.0.0
*
* @return void
*/
private function __construct() {
$this->validator = new LLMS_Form_Validator();
add_action( 'lifterlms_before_user_update', array( $this, 'maybe_modify_edit_account_field_settings' ), 10, 3 );
add_action( 'lifterlms_before_user_update', array( $this, 'maybe_modify_required_address_fields' ), 10, 3 );
add_action( 'lifterlms_before_user_registration', array( $this, 'maybe_modify_required_address_fields' ), 10, 3 );
}
/**
* Retrieve fields for a given form.
*
* Ensures the form exists and that the current user can access the form.
*
* @since 5.0.0
*
* @param string $action User action to be performed. Either "update" (for an existing user) or "registration" for a new user.
* @param string $location Form location ID.
* @param array $args Additional arguments passed to the short-circuit filter.
* @return WP_Error|array[] Array of LLMS_Form_Field arrays on success or an error object on failure.
*/
protected function get_fields( $action, $location, $args = array() ) {
$fields = LLMS_Forms::instance()->get_form_fields( $location, $args );
// Form couldn't be located.
if ( false === $fields ) {
// Translators: %s = form location ID.
return new WP_Error( 'llms-form-invalid-location', sprintf( __( 'The form location "%s" is invalid.', 'lifterlms' ), $location ), $args );
} elseif ( 'account' === $location && 'update' !== $action ) {
// No logged in user, can't update.
return new WP_Error( 'llms-form-no-user', __( 'You must be logged in to perform this action.', 'lifterlms' ), $args );
}
return $fields;
}
/**
* Insert user data into the database.
*
* @since 5.0.0
*
* @param string $action Type of insert action. Either "registration" for a new user or "update" for an existing one.
* @param array $posted_data User-submitted form data.
* @param array[] $fields List of LifterLMS Form fields for the form.
* @return WP_Error|int Error on failure or WP_User ID on success.
*/
protected function insert( $action, $posted_data, $fields ) {
$func = 'registration' === $action ? 'wp_insert_user' : 'wp_update_user';
$prepared = $this->prepare_data_for_insert( $posted_data, $fields, $action );
$user_id = $func( $prepared['users'] );
if ( is_wp_error( $user_id ) ) {
return $user_id;
}
foreach ( $prepared['usermeta'] as $key => $val ) {
// Double check that fields like password_confirm aren't saved to user meta.
if ( in_array( $key, LLMS_CONFIRMATION_FIELDS, true ) ) {
continue;
}
update_user_meta( $user_id, $key, $val );
}
return $user_id;
}
/**
* Modify LifterLMS Fields prior to performing submit handler validations.
*
* @since 5.0.0
* @since 5.1.0 Do not allow submitting a password change without providing a `password_current`
*
* @param array $posted_data User submitted form data (passed by reference).
* @param string $location Form location ID.
* @param array[] $fields Array of LifterLMS Form Fields (passed by reference).
* @return void
*/
public function maybe_modify_edit_account_field_settings( &$posted_data, $location, &$fields ) {
if ( 'account' !== $location ) {
return;
}
/**
* If email address and passwords aren't submitted we can mark them as "optional" fields.
*
* These fields are dynamically toggled and disabled if they're not modified.
* Process `password_current` as last as it depends on `password` field submission.
*/
foreach ( array( 'email_address', 'password', 'password_current' ) as $field_id ) {
// If the field exists and it's not included (or empty) in the posted data.
$index = LLMS_Forms::instance()->get_field_by( $fields, 'id', $field_id, 'index' );
if ( false !== $index && empty( $posted_data[ $fields[ $index ]['name'] ] ) ) {
// When updating a password, the `password_current` is mandatory.
if ( 'account' === $location && 'password_current' === $field_id ) {
// Get `password` field.
$password_index = LLMS_Forms::instance()->get_field_by( $fields, 'id', 'password', 'index' );
// If a `passowrd` feld has been submitted then the `password_current` cannot be skipped.
if ( false !== $password_index &&
! empty( $posted_data[ $fields[ $password_index ]['name'] ] ) ) {
continue;
}
}
// Remove the field so we don't accidentally save an empty value later.
unset( $posted_data[ $fields[ $index ]['name'] ] );
// Mark the field as optional (for validation purposes).
$fields[ $index ]['required'] = false;
// Check if there's a confirm field and do the same.
$con_index = LLMS_Forms::instance()->get_field_by( $fields, 'id', "{$field_id}_confirm", 'index' );
if ( false !== $con_index && empty( $posted_data[ $fields[ $con_index ]['name'] ] ) ) {
unset( $posted_data[ $fields[ $con_index ]['name'] ] );
$fields[ $con_index ]['required'] = false;
}
}
}
}
/**
* Modify LifterLMS Fields to allow some address fields to be conditionally required.
*
* Uses available country locale information to remove the "required" attribute for state
* and zip code fields when a user has chosen a country that doesn't use states and/or
* zip codes.
*
* @since 5.0.0
*
* @param array $posted_data User submitted form data (passed by reference).
* @param string $location Form location ID.
* @param array[] $fields Array of LifterLMS Form Fields (passed by reference).
* @return void
*/
public function maybe_modify_required_address_fields( &$posted_data, $location, &$fields ) {
// Only proceed if we have a country to review.
if ( empty( $posted_data['llms_billing_country'] ) ) {
return;
}
$country = $posted_data['llms_billing_country'];
$info = llms_get_country_address_info( $country );
// Fields to chek.
$check = array(
'llms_billing_city' => 'city',
'llms_billing_state' => 'state',
'llms_billing_zip' => 'postcode',
);
foreach ( $check as $post_key => $info_key ) {
$index = LLMS_Forms::instance()->get_field_by( $fields, 'name', $post_key, 'index' );
// Field exists, no data was posted, and the field is disabled (is `false`) in the address info array.
if ( false !== $index && empty( $posted_data[ $post_key ] ) && ! $info[ $info_key ] ) {
$fields[ $index ]['required'] = false;
}
}
}
/**
* Prepares user-submitted data for insertion into the database.
*
* @since 5.0.0
*
* @param array $posted_data Sanitized & validated user-submitted form data.
* @param array[] $fields LifterLMS form fields list.
* @param string $action Insert action, either "registration" for new users or "update" for existing, users.
* @return array
*/
protected function prepare_data_for_insert( $posted_data, $fields, $action ) {
$prepared = array();
foreach ( $fields as $field ) {
if ( empty( $field['data_store_key'] ) ) {
continue;
}
// We need to account for fields that are part of the form but are not present in the `$posted_data`
// e.g. unchecked check boxes.
if ( isset( $posted_data[ $field['name'] ] ) || 'checkbox' === $field['type'] ) {
if ( ! isset( $prepared[ $field['data_store'] ] ) ) {
$prepared[ $field['data_store'] ] = array();
}
$prepared[ $field['data_store'] ][ $field['data_store_key'] ] = isset( $posted_data[ $field['name'] ] ) ? $posted_data[ $field['name'] ] : array();
}
}
if ( 'registration' === $action ) {
$defaults = array(
'role' => 'student',
'show_admin_bar_front' => false,
);
// Add a username if we don't have a user_login field.
if ( empty( $prepared['users']['user_login'] ) ) {
$defaults['user_login'] = LLMS_Person_Handler::generate_username( $posted_data['email_address'] );
}
// Add a password if we don't have a password field.
if ( empty( $prepared['users']['user_pass'] ) ) {
$defaults['user_pass'] = wp_generate_password( 32, true, true );
}
$prepared['users'] = wp_parse_args( $prepared['users'], $defaults );
} elseif ( 'update' === $action ) {
$prepared['users']['ID'] = empty( $posted_data['user_id'] ) ? get_current_user_id() : absint( $posted_data['user_id'] );
}
// Record an IP Address.
$prepared['usermeta']['llms_ip_address'] = llms_get_ip_address();
// If terms have been agreed to, record a time stamp for the agreement.
if ( isset( $posted_data['llms_agress_to_terms'] ) ) {
$prepared['usermeta']['llms_agress_to_terms'] = current_time( 'mysql' );
}
/**
* Filter data added to the wp_users data via `wp_insert_user()` or `wp_update_user()`.
*
* The dynamic portion of this hook, `$action`, can be either "registration" or "update".
*
* @since 3.0.0
* @since 5.0.0 Moved from `LLMS_Person_Handler::insert_data()`.
*
* @param array $user_data Array of user data.
* @param array $posted_data Array of user-submitted data.
* @param string $action Submission action, either "registration" or "update".
*/
$prepared['users'] = apply_filters( "lifterlms_user_{$action}_insert_user", $prepared['users'], $posted_data, $action );
/**
* Filter meta data to be added for the user.
*
* The dynamic portion of this hook, `$action`, can be either "registration" or "update".
*
* @since 3.0.0
* @since 5.0.0 Moved from `LLMS_Person_Handler::insert_data()`.
*
* @param array $user_meta Array of user meta data.
* @param array $posted_data Array of user-submitted data.
* @param string $action Submission action, either "registration" or "update".
*/
$prepared['usermeta'] = apply_filters( "lifterlms_user_{$action}_insert_user_meta", $prepared['usermeta'], $posted_data, $action );
return $prepared;
}
/**
* Form submission handler.
*
* @since 5.0.0
* @since 5.1.0 Remove invisible fields from when loading the checkout form.
* @since 7.0.0 Allow submission validation only (without actually submitting the fields) using the
* `validate_only` flag in the `$args` array.
*
* @param array $posted_data User-submitted form data.
* @param string $location Form location ID.
* @param array $args Additional arguments passed to the short-circuit filter.
* @return integer|boolean|WP_Error On success returns the `WP_User` ID.
* If the `validate_only` argument is passed returns `true` on success.
* Returns an error object if any validation or processing errors are encountered.
*/
public function submit( $posted_data, $location, $args = array() ) {
// Determine the user action to perform.
$action = get_current_user_id() ? 'update' : 'registration';
// Load the form, filtering out invisible fields, only for checkout form.
if ( 'checkout' === $location ) {
add_filter( 'llms_forms_remove_invisible_field', '__return_true', 999 );
}
$fields = $this->get_fields( $action, $location, $args );
if ( 'checkout' === $location ) {
remove_filter( 'llms_forms_remove_invisible_field', '__return_true', 999 );
}
if ( is_wp_error( $fields ) ) {
return $this->submit_error( $fields, $posted_data, $action );
}
// Make sure the user id cannot be forced by user submission.
unset( $posted_data['user_id'] );
if ( ! empty( $args['validate_only'] ) ) {
return $this->validate_fields( $posted_data, $location, $fields, $action );
}
return $this->submit_fields( $posted_data, $location, $fields, $action );
}
/**
* Form fields submission.
*
* @since 5.0.0
* @since 5.1.0 Added "lifterlms_user_{$action}_required_data" filter, to filter the required fields validity of the form submission.
* @since 5.4.1 Sanitize filed only after validation. See https://github.com/gocodebox/lifterlms/issues/1829.
* @since 6.0.0 Notify developers of the deprecated `lifterlms_created_person` action hook.
* @since 7.0.0 Moved validation logic to the `validate_fields()` method.
*
* @param array $posted_data User-submitted form data.
* @param string $location Form location ID.
* @param array[] $fields Array of LifterLMS Form Fields.
* @param string $action User action to perform.
* @return int|WP_Error WP_User ID on success, error object on failure.
*/
public function submit_fields( $posted_data, $location, $fields, $action ) {
$validate = $this->validate_fields( $posted_data, $location, $fields, $action );
if ( is_wp_error( $validate ) ) {
return $validate;
}
// Sanitize.
$posted_data = $this->validator->sanitize_fields( $posted_data, $fields );
$user_id = $this->insert( $action, $posted_data, $fields );
if ( is_wp_error( $user_id ) ) {
return $this->submit_error( $user_id, $posted_data, $action );
}
if ( 'registration' === $action ) {
/**
* Deprecated user creation hook.
*
* @since Unknown.
* @deprecated 5.0.0
*
* @param int $user_id WP_User ID of the newly created user.
* @param array $posted_data Array of user-submitted data.
* @param string $location Form location.
*/
do_action_deprecated(
'lifterlms_created_person',
array( $user_id, $posted_data, $location ),
'5.0.0',
'lifterlms_user_registered'
);
/**
* Fire an action after a user has been registered.
*
* @since 3.0.0
* @since 5.0.0 Moved from `LLMS_Person_Handler::register()`.
*
* @param int $user_id WP_User ID of the user.
* @param array $posted_data Array of user submitted data.
* @param string $location Form location.
*/
do_action( 'lifterlms_user_registered', $user_id, $posted_data, $location );
} elseif ( 'update' === $action ) {
/**
* Fire an action after a user has been updated.
*
* @since 3.0.0
* @since 5.0.0 Moved from `LLMS_Person_Handler::update()`.
*
* @param int $user_id WP_User ID of the user.
* @param array $posted_data Array of user submitted data.
* @param string $location Form location.
*/
do_action( 'lifterlms_user_updated', $user_id, $posted_data, $location );
}
return $user_id;
}
/**
* Ensure all errors objects encountered during form submission are filterable.
*
* @since 5.0.0
*
* @param WP_Error $error Error object.
* @param array $posted_data User-submitted form data.
* @param string $action Form action, either "registration" or "update".
* @return WP_Error
*/
protected function submit_error( $error, $posted_data, $action ) {
/**
* Filter the error return when the insert/update fails.
*
* The dynamic portion of this hook, `$action`, can be either "registration" or "update".
*
* @since 3.0.0
* @since 5.0.0 Moved from `LLMS_Person_Handler::insert_data()`.
*
* @param WP_Error $error Error object.
* @param array $posted_data Array of user-submitted data.
* @param string $action Submission action, either "registration" or "update"!
*/
return apply_filters( "lifterlms_user_{$action}_failure", $error, $posted_data, $action );
}
/**
* Form fields submission validation.
*
* @since 7.0.0
*
* @param array $posted_data User-submitted form data.
* @param string $location Form location ID.
* @param array[] $fields Array of LifterLMS Form Fields.
* @param string $action User action to perform.
* @return boolean|WP_Error Returns `true` on success and an error object on failure.
*/
protected function validate_fields( $posted_data, $location, $fields, $action ) {
/**
* Run an action immediately prior to user registration or update.
*
* The dynamic portion of this hook, `$action`, can be either "registration" or "update".
*
* @since 3.0.0
* @since 5.0.0 Moved from `LLMS_Person_Handler::update()` & LLMS_Person_Handler::register().
* Added parameters `$fields` and `$args`.
* Triggered by `do_action_ref_array()` instead of `do_action()` allowing modification
* of `$posted_data` and `$fields` via hooks.
*
* @param array $posted_data Array of user-submitted data (passed by reference).
* @param string $location Form location.
* @param array[] $fields Array of LifterLMS Form Fields (passed by reference).
*/
do_action_ref_array( "lifterlms_before_user_{$action}", array( &$posted_data, $location, &$fields ) );
// Check for all required fields.
$required = $this->validator->validate_required_fields( $posted_data, $fields );
/**
* Filter the required fields validity of the form submission.
*
* The dynamic portion of this hook, `$action`, can be either "registration" or "update".
*
* @since 5.0.1
*
* @param WP_Error|true $valid Error object containing required validation errors or true when the data is valid.
* @param array $posted_data Array of user-submitted data.
* @param string $location Form location.
*/
$required = apply_filters( "lifterlms_user_{$action}_required_data", $required, $posted_data, $location );
if ( is_wp_error( $required ) ) {
return $this->submit_error( $required, $posted_data, $action );
}
$posted_data = wp_unslash( $posted_data );
$valid = $this->validator->validate_fields( $posted_data, $fields );
if ( is_wp_error( $valid ) ) {
return $this->submit_error( $valid, $posted_data, $action );
}
// Validate matching fields.
$matches = $this->validator->validate_matching_fields( $posted_data, $fields );
if ( is_wp_error( $matches ) ) {
return $this->submit_error( $matches, $posted_data, $action );
}
/**
* Filter the validity of the form submission.
*
* The dynamic portion of this hook, `$action`, can be either "registration" or "update".
*
* @since 3.0.0
* @since 5.0.0 Unknown.
*
* @param WP_Error|true $valid Error object containing validation errors or true when the data is valid.
* @param array $posted_data Array of user-submitted data.
* @param string $location Form location.
*/
$valid = apply_filters( "lifterlms_user_{$action}_data", true, $posted_data, $location );
if ( is_wp_error( $valid ) ) {
return $this->submit_error( $valid, $posted_data, $action );
}
/**
* Run an action immediately after user registration/update fields have been validated.
*
* The dynamic portion of this hook, `$action`, can be either "registration" or "update".
*
* @since 3.0.0
* @since 5.0.0 Moved from `LLMS_Person_Handler::update()` & LLMS_Person_Handler::register().
* Added parameters `$fields` and `$args`.
*
* @param array $posted_data Array of user-submitted data.
* @param string $location Form location.
* @param array[] $fields Array of LifterLMS Form Fields.
*/
do_action( "lifterlms_user_{$action}_after_validation", $posted_data, $location, $fields );
return true;
}
}
================================================
FILE: includes/forms/class-llms-form-post-type.php
================================================
<?php
/**
* LLMS_Form_Post_Type class
*
* @package LifterLMS/Classes
*
* @since 5.0.0
* @version 6.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Forms Post Type
*
* Handle post type registration and interactions
*
* @since 5.0.0
*/
class LLMS_Form_Post_Type {
private $forms = null;
/**
* User Capability required to manage forms
*
* @var string
*/
public $capability = 'manage_lifterlms';
/**
* Forms post type name.
*
* @var string
*/
public $post_type = 'llms_form';
/**
* Constructor
*
* @since 5.0.0
*
* @return void
*/
public function __construct( $forms ) {
$this->forms = $forms;
add_action( 'init', array( $this, 'register_post_type' ) );
add_action( 'init', array( $this, 'register_meta' ) );
// Modify permalink.
add_filter( 'post_type_link', array( $this, 'modify_permalink' ), 10, 2 );
// Prevent deletion of core forms.
add_filter( 'pre_delete_post', array( $this, 'maybe_prevent_deletion' ), 20, 2 );
add_filter( 'pre_trash_post', array( $this, 'maybe_prevent_deletion' ), 20, 2 );
add_filter( 'rest_prepare_post_type', array( $this, 'enable_post_type_visibility' ), 10, 2 );
/**
* Filters the capability required to manage LifterLMS Forms
*
* @since 5.0.0
*
* @param string $capability The user capability. Default: "manage_lifterlms".
*/
$this->capability = apply_filters( 'llms_forms_managment_capability', $this->capability );
}
/**
* Forces the non-visible form post type to be visible when REST requests for the post type info are made via the admin panel
*
* This enabled the "Preview in new tab" functionality of the block editor to be used to preview LifterLMS form posts.
*
* @since 5.0.0
*
* @param WP_REST_Response $response Response object.
* @param WP_Post_Type $post_type Post Type object.
* @return WP_REST_Response
*/
public function enable_post_type_visibility( $response, $post_type ) {
if ( is_admin() && $this->post_type === $post_type->name ) {
$response->data['viewable'] = true;
}
return $response;
}
/**
* Retrieve a permalink for a given form post.
*
* @since 5.0.0
*
* @param WP_Post $post Form post object.
* @return string|false Permalink to the form or `false` if no permalink exists for the given location.
*/
private function get_permalink( $post ) {
$url = false;
$location = get_post_meta( $post->ID, '_llms_form_location', true );
$method = "get_permalink_for_{$location}";
if ( $this->forms->is_location_valid( $location ) && method_exists( $this, $method ) ) {
$url = $this->$method();
}
/**
* Filters the permalink for a LifterLMS form
*
* @since 5.0.0
*
* @param string|false $url The form's URL.
* @param string $location The location ID for the form.
* @param WP_Post $post The form post object.
*/
return apply_filters( 'llms_form_permalink', $url, $location, $post );
}
/**
* Retrieve permalink for the account edit form
*
* @since 5.0.0
*
* @return string
*/
private function get_permalink_for_account() {
return llms_get_endpoint_url( 'edit-account', '', llms_get_page_url( 'myaccount' ) );
}
/**
* Retrieve permalink for the checkout form
*
* @since 5.0.0
*
* @return string
*/
private function get_permalink_for_checkout() {
$url = llms_get_page_url( 'checkout' );
$args = array();
// Add an access plan to the URL.
$plans = new WP_Query(
array(
'post_type' => 'llms_access_plan',
'posts_per_page' => 1,
'orderby' => 'ID',
'order' => 'ASC',
)
);
if ( $plans->have_posts() ) {
$args = array(
'plan' => $plans->posts[0]->ID,
);
}
return LLMS_View_Manager::get_url( 'visitor', $url, $args );
}
/**
* Retrieve permalink for the registration form
*
* @since 5.0.0
*
* @return string|false Permalink or `false` when open registration is disabled.
*/
private function get_permalink_for_registration() {
return LLMS_View_Manager::get_url( 'visitor', llms_get_page_url( 'myaccount' ) );
}
/**
* Maybe prevent a post from being deleted/trashed.
*
* We do not allow the "core" forms to be deleted. This action prevents both
* deletion and trash actions when run against one of the core form.
*
* @since 5.0.0
* @since 6.4.0 Use `LLMS_Forms::is_a_core_form()` to determine whether a form is a core form and cannot be deleted.
*
* @param null|bool $prevent Whether or not the action has been prevented.
* @param WP_Post $post The form post object.
* @return null|false Returns `null` when we don't prevent the action and `false` if we should.
*/
public function maybe_prevent_deletion( $prevent, $post ) {
if ( $post->post_type === $this->post_type && LLMS_Forms::instance()->is_a_core_form( $post ) ) {
$prevent = false;
}
return $prevent;
}
/**
* Modify the permalink of a given form.
*
* @since 5.0.0
*
* @param string $permalink Default permalink.
* @param WP_Post $post Post object.
* @return string|false
*/
public function modify_permalink( $permalink, $post ) {
if ( $this->post_type !== $post->post_type ) {
return $permalink;
}
return $this->get_permalink( $post );
}
/**
* Register the forms post type.
*
* @since 5.0.0
*
* @return void
*/
public function register_post_type() {
$args = array(
'label' => __( 'LifterLMS Forms', 'lifterlms' ),
'labels' => array(
'name' => __( 'Forms', 'lifterlms' ),
'singular_name' => __( 'Form', 'lifterlms' ),
'menu_name' => _x( 'Forms', 'Admin menu name', 'lifterlms' ),
'add_new' => __( 'Add New Form', 'lifterlms' ),
'add_new_item' => __( 'Add New Form', 'lifterlms' ),
'edit' => __( 'Edit', 'lifterlms' ),
'edit_item' => __( 'Edit Form', 'lifterlms' ),
'view' => __( 'View Form', 'lifterlms' ),
'view_item' => __( 'View Form', 'lifterlms' ),
'search_items' => __( 'Search Forms', 'lifterlms' ),
'not_found' => __( 'No Forms found', 'lifterlms' ),
'not_found_in_trash' => __( 'No Forms found in trash', 'lifterlms' ),
),
'public' => false,
'exclude_from_search' => true,
'publicly_queryable' => false,
'show_ui' => true,
'show_in_nav_menus' => false,
'show_in_menu' => 'lifterlms',
'show_in_admin_bar' => false,
'supports' => array( 'title', 'editor', 'custom-fields' ),
'show_in_rest' => true,
'rewrite' => false,
'capabilities' => array(
'edit_post' => $this->capability,
'read_post' => $this->capability,
'delete_post' => $this->capability,
'edit_posts' => $this->capability,
'edit_others_posts' => $this->capability,
'publish_posts' => $this->capability,
'read_private_posts' => $this->capability,
'read' => 'read',
'delete_posts' => $this->capability,
'delete_private_posts' => $this->capability,
'delete_published_posts' => $this->capability,
'delete_others_posts' => $this->capability,
'edit_private_posts' => $this->capability,
'edit_published_posts' => $this->capability,
'create_posts' => false,
),
);
LLMS_Post_Types::register_post_type( $this->post_type, $args );
}
/**
* Register custom postmeta properties for the forms post type.
*
* @since 5.0.0
* @since 5.10.0 Added new meta for checkout forms and free access plans.
*
* @return void
*/
public function register_meta() {
$props = array(
'_llms_form_location' => array(
'description' => __( 'Determines the front-end location where the form is displayed.', 'lifterlms' ),
),
'_llms_form_show_title' => array(
'description' => __( 'Determines whether or not to display the form\'s title on the front-end.', 'lifterlms' ),
),
// This is only actually used for 'checkout' forms.
'_llms_form_title_free_access_plans' => array(
'description' => __( 'The alternative form title to be shown on checkout for free access plans.', 'lifterlms' ),
'default' => __( 'Student Information', 'lifterlms' ),
),
'_llms_form_is_core' => array(
'description' => __( 'Determines if the form is a core form required for basic site functionality.', 'lifterlms' ),
),
);
foreach ( $props as $prop => $settings ) {
register_meta(
'post',
$prop,
wp_parse_args(
$settings,
array(
'object_subtype' => $this->post_type,
'sanitize_callback' => 'sanitize_text_field',
'auth_callback' => array( $this, 'meta_auth_callback' ),
'type' => 'string',
'single' => true,
'show_in_rest' => true,
)
)
);
}
}
/**
* Meta field update authorization callback.
*
* @since 5.0.0
*
* @param bool $allowed Is the update allowed.
* @param string $meta_key Meta keyname.
* @param int $object_id WP Object ID (post,comment,etc)...
* @param int $user_id WP User ID.
* @param string $cap Requested capability.
* @param array $caps User capabilities.
* @return bool
*/
public function meta_auth_callback( $allowed, $meta_key, $object_id, $user_id, $cap, $caps ) {
return user_can( $user_id, $this->capability, $object_id );
}
}
================================================
FILE: includes/forms/class-llms-form-templates.php
================================================
<?php
/**
* LLMS_Form_Templates class.
*
* @package LifterLMS/Classes
*
* @since 5.0.0
* @version 5.1.1
*/
defined( 'ABSPATH' ) || exit;
/**
* Manage llms_form post type templates
*
* Handles creation of reusable blocks for the core/default fields used
* by the default checkout, registration, and account edit forms.
*
* @since 5.0.0
*/
class LLMS_Form_Templates {
/**
* Transform a block definition into a confirm group
*
* @since 5.0.0
*
* @param array $block A WP_Block definition array.
* @return array
*/
private static function add_confirm_group( $block ) {
$inner = array(
self::get_confirm_group_controller( $block ),
self::get_confirm_group_controlled( $block ),
);
if ( is_rtl() ) {
$inner = array_reverse( $inner );
}
$attrs = array(
'fieldLayout' => 'columns',
);
if ( ! empty( $block['attrs']['llms_visibility'] ) ) {
$attrs['llms_visibility'] = $block['attrs']['llms_visibility'];
}
return array(
'blockName' => 'llms/form-field-confirm-group',
'innerBlocks' => $inner,
'attrs' => $attrs,
);
}
/**
* Create a wp_block (resuable block) post for a given field id
*
* This method will attempt to use an existing reusable block field
* if it already exists and will only create it if one isn't found.
*
* @since 5.0.0
* @since 5.1.1 Run serialized block content through `wp_slash()` to preserve special characters converted to character codes.
*
* @param string $field_id The field's identifier as found in the block schema list returned by LLMS_Form_Templates::get_reusable_block_schema().
* @return int Returns the WP_Post ID of the the wp_block post type or `0` on failure.
*/
private static function create_reusable_block( $field_id ) {
$existing = self::find_reusable_block( $field_id );
if ( $existing ) {
return $existing->ID;
}
$block_data = self::get_block_data( $field_id );
$args = array(
'post_title' => $block_data['title'],
'post_content' => wp_slash( serialize_blocks( $block_data['block'] ) ),
'post_status' => 'publish',
'post_type' => 'wp_block',
'meta_input' => array(
'_is_llms_field' => 'yes',
'_llms_field_id' => $field_id,
),
);
return wp_insert_post( $args );
}
/**
* Locates an existing wp_block post by field id
*
* @since 5.0.0
* @since 5.1.0 Method access changed from private to public.
*
* @param string $field_id The field's identifier as found in the block schema list returned by LLMS_Form_Templates::get_reusable_block_schema().
* @return WP_Post|boolean Returns the post object or false if not found.
*/
public static function find_reusable_block( $field_id ) {
$query = new WP_Query(
array(
'posts_per_page' => 1,
'no_found_rows' => true,
'post_type' => 'wp_block',
'meta_key' => '_llms_field_id',
'meta_value' => $field_id,
)
);
return $query->posts ? $query->posts[0] : false;
}
/**
* Retrieve a block array for use in a template
*
* Returns a reusable block when `$reusable` is `true` or returns a regular
* block modified by legacy options for the given location when `$reusable` is `false`.
*
* @since 5.0.0
* @since 5.1.0 Method access set to public.
*
* @param string $field_id The field's identifier as found in the block schema list returned by LLMS_Form_Templates::get_reusable_block_schema().
* @param string $location Form location. Accepts "checkout", "registration", or "account".
* @param boolean $reusable Whether or not a reusable block should be retrieved.
* @return array
*/
public static function get_block( $field_id, $location, $reusable ) {
if ( $reusable ) {
return self::get_reusable_block( $field_id );
}
$legacy_opt = self::get_legacy_option( $field_id, $location );
// Add a confirm group for email when confirmation is set or for password fields.
$confirm = ( ( 'email' === $field_id && 'yes' === $legacy_opt ) || 'password' === $field_id );
$block_data = self::get_block_data( $field_id, $confirm );
if ( 'hidden' === $legacy_opt ) {
return array();
}
$block = $block_data['block'][0];
if ( in_array( $legacy_opt, array( 'required', 'optional' ), true ) ) {
$block = self::set_required_atts( $block, ( 'required' === $legacy_opt ) );
}
return $block;
}
/**
* Retrieve data for a given field by id
*
* @since 5.0.0
*
* @param string $field_id The field's identifier as found in the block schema list returned by LLMS_Form_Templates::get_reusable_block_schema().
* @param boolean $confirm If `true` and the schema includes a confirmation field, will convert the field to a confirm group.
* @return array Returns an array containing the block data and title.
*/
private static function get_block_data( $field_id, $confirm = true ) {
$block = self::get_reusable_block_schema( $field_id );
$title = $block['title'];
unset( $block['title'] );
if ( $confirm && ! empty( $block['confirm'] ) ) {
$block = self::add_confirm_group( $block );
}
$block = self::prepare_blocks( array( $block ) );
return compact( 'title', 'block' );
}
/**
* Creates a WP_Block array definition for the confirmation (controlled) block in a confirm group
*
* @since 5.0.0
*
* @param array $block A WP_Block definition array for the primary/default block in the group.
* @return array A new WP_Block definition array for the controlled block.
*/
private static function get_confirm_group_controlled( $block ) {
$block['blockName'] = 'llms/form-field-text';
$block['attrs'] = wp_parse_args(
array(
'field' => $block['confirm'],
'id' => $block['attrs']['id'] . '_confirm',
'name' => $block['attrs']['id'] . '_confirm',
'label' => sprintf( __( 'Confirm %s', 'lifterlms' ), $block['attrs']['label'] ),
'columns' => 6,
'last_column' => is_rtl() ? false : true,
'isConfirmationField' => true,
'llms_visibility' => 'off',
'match' => $block['attrs']['id'],
'data_store' => false,
'data_store_key' => false,
),
$block['attrs']
);
return $block;
}
/**
* Creates a WP_Block array definition for the primary (controller) block in a confirm group
*
* @since 5.0.0
*
* @param array $block A WP_Block definition array for the primary/default block in the group.
* @return array A new WP_Block definition array for the controller block.
*/
private static function get_confirm_group_controller( $block ) {
$block['attrs'] = wp_parse_args(
array(
'columns' => 6,
'last_column' => is_rtl() ? true : false,
'isConfirmationControlField' => true,
'llms_visibility' => 'off',
'match' => $block['attrs']['id'] . '_confirm',
),
$block['attrs']
);
return $block;
}
/**
* Retrieves legacy option's value for a given field and location
*
* @since 5.0.0
*
* @param string $field_id The field's identifier as found in the block schema list returned by LLMS_Form_Templates::get_reusable_block_schema().
* @param string $location Form location. Accepts "checkout", "registration", or "account".
* @return string
*/
private static function get_legacy_option( $field_id, $location ) {
$name_map = array(
'address' => 'address',
'email' => 'email_confirmation',
'name' => 'names',
'phone' => 'phone',
);
$val = '';
if ( array_key_exists( $field_id, $name_map ) ) {
$key = sprintf( 'lifterlms_user_info_field_%1$s_%2$s_visibility', $name_map[ $field_id ], $location );
$val = get_option( $key );
}
return $val;
}
/**
* Retrieves a core/block WP_Block array for a given default/core field
*
* This method will attempt to use an existing wp_block for the given field id
* if it exists, and when not found creates a new one.
*
* @since 5.0.0
*
* @param string $field_id The field's identifier as found in the block schema list returned by LLMS_Form_Templates::get_reusable_block_schema().
* @return array A WP_Block definition array.
*/
private static function get_reusable_block( $field_id ) {
$ref = self::create_reusable_block( $field_id );
return array(
'blockName' => 'core/block',
'attrs' => compact( 'ref' ),
'innerContent' => array(),
);
}
/**
* Retrieves the schema definition for a default/core reusable block
*
* @since 5.0.0
*
* @param string $field_id The field's identifier as found in the block schema list returned by LLMS_Form_Templates::get_reusable_block_schema().
* @return array The block definition schema. This is a WP_Block array definition but missing some data that is automatically populated before serialization.
*/
private static function get_reusable_block_schema( $field_id ) {
$list = require LLMS_PLUGIN_DIR . 'includes/schemas/llms-reusable-blocks.php';
$definition = empty( $list[ $field_id ] ) ? array() : self::prepare_block_attrs( $list[ $field_id ] );
/**
* Filters the result of a schema definition.
*
* This hook can be used to add definitions for custom (non-core) fields or to modify a core definition.
*
* @since 5.0.0
*
* @param array $definition The schema definition.
* @param string $field_id The field's identifier as found in the block schema list returned by LLMS_Form_Templates::get_reusable_block_schema().
*/
return apply_filters( 'llms_get_reusable_block_schema', $definition, $field_id );
}
/**
* Retrieve the block template HTML for a given location.
*
* @since 5.0.0
*
* @param string $location Form location. Accepts "checkout", "registration", or "account".
* @return string
*/
public static function get_template( $location ) {
/**
* Filters whether or not reusable blocks should be used when generating a form template
*
* By default when migrating from 4.x, non-reusable blocks will be used in order to ensure legacy settings
* are transferred during an upgrade to 5.x. However, on a "clean" install of 5.x, reusable blocks will be
* used in favor of regular blocks.
*
* @since 5.0.0
*
* @param boolean $use_reusable Whether or not to use reusable blocks.
*/
$use_reusable = apply_filters( 'llms_blocks_template_use_reusable_blocks', ( 'not-set' === get_option( 'lifterlms_registration_generate_username', 'not-set' ) ) );
$blocks = self::get_template_blocks( $location, $use_reusable );
return serialize_blocks( $blocks );
}
/**
* Retrieve a list of blocks for the given template
*
* @since 5.0.0
*
* @param string $location Form location id.
* @param boolean $reusable Whether or not reusable blocks should be used.
* @return array[]
*/
private static function get_template_blocks( $location, $reusable ) {
$blocks = array();
// Email and password are added in different locations depending on the form.
$base = array(
self::get_block( 'email', $location, $reusable ),
self::get_block( 'password', $location, $reusable ),
);
// Username only added when option is off on legacy sites.
if ( 'account' !== $location && ! llms_parse_bool( get_option( 'lifterlms_registration_generate_username', 'yes' ) ) ) {
array_unshift( $base, self::get_reusable_block( 'username' ) );
}
// Email and password go first on checkout/reg forms.
if ( 'account' !== $location ) {
$blocks = array_merge( $base, $blocks );
}
$blocks[] = self::get_block( 'name', $location, $reusable );
// Display name on account only, users can add to other forms if desired.
if ( 'account' === $location ) {
$blocks[] = self::get_block( 'display_name', $location, $reusable );
}
$blocks[] = self::get_block( 'address', $location, $reusable );
$blocks[] = self::get_block( 'phone', $location, $reusable );
if ( 'registration' === $location ) {
$blocks[] = self::get_voucher_block();
}
// Email and password go at the end on the account form.
if ( 'account' === $location ) {
$blocks = array_merge( $blocks, $base );
}
return array_filter( $blocks );
}
/**
* Retrieve block for the voucher row.
*
* @since 5.0.0
*
* @return array
*/
private static function get_voucher_block() {
// Don't include voucher if legacy option has vouchers hidden.
$option = get_option( 'lifterlms_voucher_field_registration_visibility', 'optional' );
if ( 'hidden' === $option ) {
return array();
}
return array(
'blockName' => 'llms/form-field-redeem-voucher',
'attrs' => array(
'id' => 'llms_voucher',
'label' => __( 'Have a voucher?', 'lifterlms' ),
'placeholder' => __( 'Voucher Code', 'lifterlms' ),
'required' => ( 'required' === $option ),
'toggleable' => true,
'data_store' => false,
'data_store_key' => false,
),
'innerContent' => array(),
);
}
/**
* Prepares block attributes for a given reusable block
*
* This method loads a reusable block from the blocks schema and attempts to locate a user information field
* for the given field block from the user information fields schema.
*
* The field is matched by the block's "id" attribute which should match a user information field's "name" attribute.
*
* When a match is found, the information field data is merged into the block data and the settings are converted from field settings
* to block attributes.
*
* @since 5.0.0
*
* @param array $block A partial WP_Block array used to create a reusable block.
* @return array
*/
private static function prepare_block_attrs( $block ) {
if ( ! empty( $block['innerBlocks'] ) ) {
foreach ( $block['innerBlocks'] as &$inner_block ) {
$inner_block = self::prepare_block_attrs( $inner_block );
}
} elseif ( ! empty( $block['attrs']['id'] ) ) {
// If we find a field, merge the block into the field and convert it to block attributes.
$field = llms_get_user_information_field( $block['attrs']['id'] );
$block['attrs'] = $field ? LLMS_Forms::instance()->convert_settings_to_block_attrs( wp_parse_args( $field, $block['attrs'] ) ) : $block['attrs'];
}
return $block;
}
/**
* Recursively prepare a list of blocks to ensure it can be passed into serialize_blocks() without error
*
* @since 5.0.0
*
* @param array[] $blocks Array of WP_Block definition arrays.
* @return array[]
*/
private static function prepare_blocks( $blocks ) {
foreach ( $blocks as &$block ) {
$block = wp_parse_args(
$block,
array(
'attrs' => array(),
'innerBlocks' => array(),
)
);
if ( ! empty( $block['innerBlocks'] ) ) {
$block['innerBlocks'] = self::prepare_blocks( $block['innerBlocks'] );
}
// WP core serialize_block() doesn't work unless this...
$block['innerContent'] = array_fill( 0, count( $block['innerBlocks'] ), null );
}
return $blocks;
}
/**
* Modifies the `required` block attribute
*
* @since 5.0.0
*
* @param array $block A WP_Block definition array.
* @param boolean $required Desired value of the required attribute.
*/
private static function set_required_atts( $block, $required ) {
if ( isset( $block['attrs']['required'] ) && 'llms/form-field-user-address-street-secondary' !== $block['blockName'] ) {
$block['attrs']['required'] = $required;
}
foreach ( $block['innerBlocks'] as &$inner_block ) {
$inner_block = self::set_required_atts( $inner_block, $required );
}
return $block;
}
}
================================================
FILE: includes/forms/class-llms-form-validator.php
================================================
<?php
/**
* Handles data sanitization & validation for the LLMS_Form_Handler class
*
* @package LifterLMS/Classes
*
* @since 5.0.0
* @version 5.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Form_Handler class.
*
* @since 5.0.0
*/
class LLMS_Form_Validator {
/**
* Filters a list of fields down to only the required fields.
*
* @since 5.0.0
*
* @param array[] $fields Array of LifterLMS Form Field settings arrays.
* @return array[]
*/
public function get_required_fields( $fields ) {
return array_values(
array_filter(
$fields,
function( $field ) {
return ! empty( $field['required'] );
}
)
);
}
/**
* Sanitize a single field according to its type
*
* @since 5.0.0
*
* @param mixed $posted_value User-submitted (dirty) value.
* @param array $field LifterLMS field settings.
* @return mixed
*/
public function sanitize_field( $posted_value, $field ) {
$map = array(
'email' => 'sanitize_email',
'number' => array( $this, 'sanitize_field_number' ),
'tel' => array( $this, 'sanitize_field_tel' ),
'textarea' => 'sanitize_textarea_field',
'url' => 'esc_url_raw',
);
$func = isset( $map[ $field['type'] ] ) ? $map[ $field['type'] ] : 'sanitize_text_field';
// Turn the submitted value into array, so to unify sanitization of scalar and array posted values.
$to_sanitize = is_array( $posted_value ) ? $posted_value : array( $posted_value );
$sanitized = array();
foreach ( $to_sanitize as $value ) {
$sanitized[] = trim( call_user_func( $func, $value ) );
}
return is_array( $posted_value ) ? $sanitized : $sanitized[0];
}
/**
* Sanitize a number field
*
* @since 5.0.0
*
* @param string $posted_value User-submitted (dirty) value.
* @return string
*/
protected function sanitize_field_number( $posted_value ) {
return preg_replace( '/[^0-9.,]/', '', $posted_value );
}
/**
* Sanitize a telephone field
*
* @since 5.0.0
*
* @param string $posted_value User-submitted (dirty) value.
* @return string
*/
protected function sanitize_field_tel( $posted_value ) {
return preg_replace( '/[^\s\#0-9\-\+\(\)\.]/', '', $posted_value );
}
/**
* Sanitize all user-submitted data according to field settings
*
* @since 5.0.0
*
* @param array $posted_data User-submitted form data.
* @param array[] $fields LifterLMS form fields settings.
* @return array
*/
public function sanitize_fields( $posted_data, $fields ) {
foreach ( $fields as $field ) {
if ( empty( $field['name'] ) || ! isset( $posted_data[ $field['name'] ] ) ) {
continue;
}
$posted_data[ $field['name'] ] = $this->sanitize_field( $posted_data[ $field['name'] ], $field );
}
return $posted_data;
}
/**
* Validate a posted value
*
* @since 5.0.0
*
* @param mixed $posted_value Posted data.
* @param array $field LifterLMS Form Field settings array.
* @return WP_Error|true
*/
public function validate_field( $posted_value, $field ) {
// Validate field by type.
$type_map = array(
'email' => array( $this, 'validate_field_email' ),
'number' => array( $this, 'validate_field_number' ),
'tel' => array( $this, 'validate_field_tel' ),
'url' => array( $this, 'validate_field_url' ),
);
// Turn the submitted value into array, so to unify validation of scalar and array posted values.
$to_validate = is_array( $posted_value ) ? $posted_value : array( $posted_value );
foreach ( $to_validate as $value ) {
$valid = isset( $type_map[ $field['type'] ] ) ? call_user_func( $type_map[ $field['type'] ], $value, $field ) : true;
if ( is_wp_error( $valid ) ) { // Return as soon as a field is not valid.
return $valid;
}
// HTML Attribute Validations.
if ( ! empty( $field['attributes']['minlength'] ) ) {
$valid = $this->validate_field_attribute_minlength( $value, $field['attributes']['minlength'], $field );
if ( is_wp_error( $valid ) ) {
return $valid;
}
}
}
// Perform special validations for special field types (scalar by their nature).
$extra_map = array(
'llms_voucher' => array( $this, 'validate_field_voucher' ),
'password_current' => array( $this, 'validate_field_current_password' ),
'user_email' => array( $this, 'validate_field_user_email' ),
'user_login' => array( $this, 'validate_field_user_login' ),
);
$valid = isset( $extra_map[ $field['id'] ] ) ? call_user_func( $extra_map[ $field['id'] ], $posted_value ) : true;
if ( is_wp_error( $valid ) ) {
return $valid;
}
return true;
}
/**
* Validates the html input minlength attribute
*
* Used by the User Password field.
*
* @since 5.0.0
*
* @param string $posted_value User-submitted value.
* @param int $minlength The minimum string length as parsed from the field block.
* @param array $field LifterLMS Form Field settings array.
* @return WP_Error|boolean Returns `true` for a valid value, otherwise an error.
*/
protected function validate_field_attribute_minlength( $posted_value, $minlength, $field ) {
if ( strlen( $posted_value ) < $minlength ) {
return new WP_Error(
'llms-form-field-invalid',
sprintf(
__( 'The %1$s must be at least %2$d characters in length.', 'lifterlms' ),
isset( $field['label'] ) ? $field['label'] : $field['name'],
$minlength
)
);
}
return true;
}
/**
* Validate an email field
*
* @since 5.0.0
*
* @param string $posted_value User-submitted (dirty) value.
* @return WP_Error|boolean Returns `true` for a valid submission, otherwise an error.
*/
protected function validate_field_email( $posted_value ) {
if ( ! is_email( $posted_value ) ) {
// Translators: %s user submitted value.
return new WP_Error( 'llms-form-field-invalid', sprintf( __( 'The email address "%s" is not valid.', 'lifterlms' ), $posted_value ) );
}
return true;
}
/**
* Validate a number field
*
* Ensures the posted valued is numeric and, where applicable, ensures that the number falls
* within minimum and maximum value requirements.
*
* @since 5.0.0
*
* @param string $posted_value User-submitted (dirty) value.
* @param array $field The LLMS_Form_Field settings array.
* @return WP_Error|boolean Returns `true` for a valid submission, otherwise an error.
*/
protected function validate_field_number( $posted_value, $field ) {
$temp_value = str_replace( ',', '', $posted_value );
if ( ! is_numeric( $temp_value ) ) {
// Translators: %1$s field label or name; %2$s = user submitted value.
return new WP_Error( 'llms-form-field-invalid', sprintf( __( 'The %1$s "%2$s" is not valid number.', 'lifterlms' ), isset( $field['label'] ) ? $field['label'] : $field['name'], $posted_value ) );
} elseif ( isset( $field['attributes'] ) ) {
if ( ( ! empty( $field['attributes']['min'] ) || ( isset( $field['attributes']['min'] ) && '0' === $field['attributes']['min'] ) ) && $temp_value < $field['attributes']['min'] ) {
// Translators: %1$s = field label or name; %2$s = user submitted value; %3$d = minimum allowed number.
return new WP_Error( 'llms-form-field-invalid', sprintf( __( 'The %1$s "%2$s" must be greater than or equal to %3$d.', 'lifterlms' ), isset( $field['label'] ) ? $field['label'] : $field['name'], $posted_value, $field['attributes']['min'] ) );
} elseif ( ( ! empty( $field['attributes']['max'] ) || ( isset( $field['attributes']['max'] ) && '0' === $field['attributes']['max'] ) ) && $temp_value > $field['attributes']['max'] ) {
// Translators: %1$s = field label or name; %2$s = user submitted value; %3$d = maximum allowed number.
return new WP_Error( 'llms-form-field-invalid', sprintf( __( 'The %1$s "%2$s" must be less than or equal to %3$d.', 'lifterlms' ), isset( $field['label'] ) ? $field['label'] : $field['name'], $posted_value, $field['attributes']['max'] ) );
}
}
return true;
}
/**
* Validate a logged-in users current password
*
* @since 5.0.0
*
* @param string $posted_value User-submitted (dirty) value.
* @return WP_Error|boolean Returns `true` for a valid submission, otherwise an error.
*/
protected function validate_field_current_password( $posted_value ) {
if ( ! is_user_logged_in() ) {
return new WP_Error( 'llms-form-field-invalid-no-user', __( 'You must be logged in to update your password.', 'lifterlms' ), $posted_value );
}
$user = wp_get_current_user();
if ( ! wp_check_password( $posted_value, $user->user_pass ) ) {
return new WP_Error( 'llms-form-field-invalid', __( 'The submitted password was not correct.', 'lifterlms' ), $posted_value );
}
return true;
}
/**
* Validate a telephone field
*
* @since 5.0.0
*
* @param string $posted_value User-submitted (dirty) value.
* @return WP_Error|boolean Returns `true` for a valid submission, otherwise an error.
*/
protected function validate_field_tel( $posted_value ) {
if ( 0 < strlen( trim( preg_replace( '/[\s\#0-9\-\+\(\)\.]/', '', $posted_value ) ) ) ) {
// Translators: %s = user submitted value.
return new WP_Error( 'llms-form-field-invalid', sprintf( __( 'The phone number "%s" is not valid.', 'lifterlms' ), $posted_value ) );
}
return true;
}
/**
* Validate a url field
*
* @since 5.0.0
*
* @param string $posted_value User-submitted (dirty) value.
* @return WP_Error|boolean Returns `true` for a valid submission, otherwise an error.
*/
protected function validate_field_url( $posted_value ) {
if ( ! filter_var( $posted_value, FILTER_VALIDATE_URL ) ) {
// Translators: %s = user submitted value.
return new WP_Error( 'llms-form-field-invalid', sprintf( __( 'The URL "%s" is not valid.', 'lifterlms' ), $posted_value ) );
}
return true;
}
/**
* Validate a user-email field
*
* User emails must be unique.
*
* @since 5.0.0
*
* @param string $posted_value User-submitted (dirty) value.
* @return WP_Error|boolean Returns `true` for a valid submission, otherwise an error.
*/
protected function validate_field_user_email( $posted_value ) {
if ( email_exists( $posted_value ) ) {
return new WP_Error( 'llms-form-field-not-unique', sprintf( __( 'An account with the email address "%s" already exists.', 'lifterlms' ), $posted_value ) );
}
return true;
}
/**
* Validate a user-login field
*
* Ensures that a username isn't found in the LifterLMS username blocklist, that it meets the default
* WP core username criteria and that the username doesn't already exist.
*
* @since 5.0.0
*
* @param string $posted_value User-submitted (dirty) value.
* @return WP_Error|boolean Returns `true` for a valid submission, otherwise an error.
*/
protected function validate_field_user_login( $posted_value ) {
if ( in_array( $posted_value, llms_get_usernames_blocklist(), true ) || ! validate_username( $posted_value ) ) {
return new WP_Error( 'llms-form-field-invalid', sprintf( __( 'The username "%s" is invalid, please try a different username.', 'lifterlms' ), $posted_value ), $posted_value );
} elseif ( username_exists( $posted_value ) ) {
return new WP_Error( 'llms-form-field-not-unique', sprintf( __( 'An account with the username "%s" already exists.', 'lifterlms' ), $posted_value ), $posted_value );
}
return true;
}
/**
* Validate a voucher field ensuring it's a valid and usable voucher code
*
* @since 5.0.0
*
* @param string $posted_value User-submitted (dirty) value.
* @return WP_Error|boolean Returns `true` for a valid submission, otherwise an error.
*/
protected function validate_field_voucher( $posted_value ) {
$voucher = new LLMS_Voucher();
$check = $voucher->check_voucher( $posted_value );
if ( is_wp_error( $check ) ) {
return new WP_Error( 'llms-form-field-invalid', $check->get_error_message(), array( $posted_value, $check ) );
}
return true;
}
/**
* Validate submitted field values.
*
* @since 5.0.0
* @since 5.1.0 Don't validate form with no user input only if the form is not empty itself (e.g. contains only invisible fields).
*
* @param array $posted_data Array of posted data.
* @param array[] $fields Array of LifterLMS Form Fields.
* @return WP_Error|true
*/
public function validate_fields( $posted_data, $fields ) {
if ( empty( $posted_data ) && ! empty( $fields ) ) {
return new WP_Error( 'llms-form-no-input', __( 'Cannot validate a form with no user input.', 'lifterlms' ) );
}
$err = new WP_Error();
$err_data = array();
foreach ( $fields as $field ) {
if ( empty( $field['name'] ) || empty( $posted_data[ $field['name'] ] ) ) {
continue;
}
$valid = $this->validate_field( $posted_data[ $field['name'] ], $field );
if ( is_wp_error( $valid ) ) {
$err->add( $valid->get_error_code(), $valid->get_error_message() );
$err_data[ $field['name'] ] = $field;
}
}
if ( $err->errors ) {
$err->add_data( $err_data );
return $err;
}
return true;
}
/**
* Ensure matching fields match one another.
*
* @since 5.0.0
*
* @param array $posted_data Array of posted data.
* @param array[] $fields Array of LifterLMS form fields.
* @return WP_Error|true
*/
public function validate_matching_fields( $posted_data, $fields ) {
$err = new WP_Error();
$err_data = array();
$matches = array();
foreach ( $fields as $field ) {
// Field doesn't have a match to check or it was already checked by it's match.
if ( empty( $field['match'] ) || in_array( $field['id'], $matches, true ) ) {
continue;
}
$field_name = isset( $field['label'] ) ? $field['label'] : $field['name'];
$name = $field['name'];
$match_field = LLMS_Forms::instance()->get_field_by( $fields, 'id', $field['match'] );
if ( ! $match_field ) {
continue;
}
$match = $match_field['name'];
$val = isset( $posted_data[ $name ] ) ? $posted_data[ $name ] : '';
$match = isset( $posted_data[ $match ] ) ? $posted_data[ $match ] : '';
if ( $val !== $match ) {
$match_name = isset( $match_field['label'] ) ? $match_field['label'] : $match_field['name'];
$err->add( 'llms-form-field-not-matched', sprintf( __( '%1$s must match %2$s.', 'lifterlms' ), $field_name, $match_name ) );
$err_data[] = array( $field, $match_field );
}
// Fields reference each other so we only need to check the pair one time.
$matches[] = $match_field['id'];
}
if ( $err->errors ) {
$err->add_data( $err_data, 'llms-form-field-not-matched' );
return $err;
}
return true;
}
/**
* Ensure that all of the forms required fields are present in the submitted data.
*
* @since 5.0.0
*
* @param array $posted_data User data (likely from $_POST).
* @param array[] $fields Array of LifterLMS form fields.
* @return WP_Error|true
*/
public function validate_required_fields( $posted_data, $fields ) {
// Ensure all required fields have been submitted.
$err = new WP_Error();
$err_data = array();
foreach ( $this->get_required_fields( $fields ) as $field ) {
if ( empty( $posted_data[ $field['name'] ] ) ) {
// Translators: %s = field label or name.
$err->add( 'llms-form-missing-required', sprintf( __( '%s is a required field.', 'lifterlms' ), isset( $field['label'] ) ? $field['label'] : $field['name'] ) );
$err_data[ $field['name'] ] = $field;
}
}
if ( $err->errors ) {
$err->add_data( $err_data, 'llms-form-missing-required' );
return $err;
}
return true;
}
}
================================================
FILE: includes/forms/class-llms-forms-admin-bar.php
================================================
<?php
/**
* LLMS_Forms_Admin_Bar calss
*
* @package LifterLMS/Classes
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Add WP Admin Bar Nodes to enable editing of the currently-viewed form by a qualifying user
*
* @since 5.0.0
*/
class LLMS_Forms_Admin_Bar {
/**
* Constructor
*
* @since 5.0.0
*
* @return void
*/
public function __construct() {
add_action( 'admin_bar_menu', array( $this, 'add_menu_items' ), 999 );
}
/**
* Add view links to the admin menu bar for qualifying users.
*
* @since 3.7.0
* @since 3.16.0 Unknown.
* @since 4.2.0 Updated icon.
* @since 4.5.1 Use `should_display()` method to determine if the view manager should be added to the admin bar.
* @since 4.16.0 Retrieve nodes to add from `get_menu_items_to_add()`.
*
* @param WP_Admin_Bar $wp_admin_bar Admin bar class instance.
* @return void
*/
public function add_menu_items( $wp_admin_bar ) {
if ( ! $this->should_display() ) {
return;
}
$args = array( $this->get_current_location() );
$plan = llms_filter_input( INPUT_GET, 'plan', FILTER_SANITIZE_NUMBER_INT );
if ( $plan ) {
$args[] = array( 'plan' => llms_get_post( $plan ) );
}
$form = llms_get_form( ...$args );
$wp_admin_bar->add_node(
array(
'id' => 'llms-edit-form',
'parent' => 'edit',
'title' => __( 'Edit Form', 'lifterlms' ),
'href' => get_edit_post_link( $form->ID ),
)
);
}
/**
* Retrieve the form location for the current screen
*
* Must be on a checkout screen, the "edit account" tab of the dashboard,
* or be viewing as a visitor on the main dashboard page with open registration enabled.
*
* @since 5.0.0
*
* @return string|boolean Returns the location id as a string or `false` if not on a form location screen.
*/
private function get_current_location() {
if ( is_llms_checkout() ) {
return 'checkout';
} elseif ( is_llms_account_page() ) {
$tab = LLMS_Student_Dashboard::get_current_tab( 'tab' );
if ( 'edit-account' === $tab ) {
return 'account';
}
if ( 'dashboard' === $tab && 'visitor' === llms_filter_input( INPUT_GET, 'llms-view-as' ) && llms_parse_bool( llms_get_open_registration_status() ) ) {
return 'registration';
}
}
return false;
}
/**
* Determine whether or an Edit Form node should be added to the admin bar.
*
* The user must be able to edit forms and be on a screen with a displayed form.
*
* @return boolean
*/
private function should_display() {
$display = ( current_user_can( LLMS_Forms::instance()->get_capability() ) && $this->get_current_location() );
/**
* Filters whether or not the "Edit Form" WP_Admin_Bar node is displayed
*
* @since 5.0.0
*
* @param boolean $display Whether or not to display the node.
*/
return apply_filters( 'llms_should_display_wp_admin_bar_nodes_for_forms', $display );
}
}
return new LLMS_Forms_Admin_Bar();
================================================
FILE: includes/forms/class-llms-forms-classic-editor.php
================================================
<?php
/**
* Disables Classic Editor plugin functionality for forms post types
*
* We do not support the classic editor for form building.
*
* @package LifterLMS/Classes
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Forms_Classic_Editor
*
* @since 5.0.0
*/
class LLMS_Forms_Classic_Editor {
/**
* Static "constructor"
*
* @since 5.0.0
*
* @return void
*/
public static function init() {
add_filter( 'use_block_editor_for_post_type', array( __CLASS__, 'force_block_editor' ), 200, 2 );
add_filter( 'classic_editor_enabled_editors_for_post_type', array( __CLASS__, 'disable_classic_editor' ), 20, 2 );
}
/**
* Force the block editor to be used for forms post type editing
*
* The classic editor uses this filter (at priority 100) to disable the block editor
* when the default editor for all users is the classic editor and users are not
* allowed to switch editors.
*
* @since 5.0.0
*
* @link https://developer.wordpress.org/reference/functions/use_block_editor_for_post_type
*
* @param boolean $use_block_editor Whether or not to use the block editor for the post type.
* @param string $post_type The post type being checked.
* @return boolean
*/
public static function force_block_editor( $use_block_editor, $post_type ) {
return LLMS_Forms::instance()->get_post_type() === $post_type ? true : $use_block_editor;
}
/**
* Prevent users from being allowed to choose the classic editor for forms post types
*
* The classic editor uses this filter to determine which editors are available for the given custom
* post type when users are allowed to choose which editor to use.
*
* @since 5.0.0
*
* @param array $editors Associative array. The array key identifies the editor and the array value is a boolean
* specifying whether or not the editor is enabled for the given post type.
* @param string $post_type The post type being checked.
* @return array
*/
public static function disable_classic_editor( $editors, $post_type ) {
if ( LLMS_Forms::instance()->get_post_type() === $post_type ) {
$editors['classic_editor'] = false;
}
return $editors;
}
}
return LLMS_Forms_Classic_Editor::init();
================================================
FILE: includes/forms/class-llms-forms-data.php
================================================
<?php
/**
* LLMS_Forms Data class file
*
* @package LifterLMS/Classes
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Manage data associated with llms_form posts
*
* @since 5.0.0
*/
class LLMS_Forms_Data {
/**
* Reference to the LLMS_Forms instance
*
* @var LLMS_Forms
*/
private $forms = null;
/**
* Constructor
*
* @since 5.0.0
*
* @return void
*/
public function __construct() {
$this->forms = LLMS_Forms::instance();
add_action( "save_post_{$this->forms->get_post_type()}", array( $this, 'save_username_locations' ), 10, 2 );
}
/**
* Locate a username/user login block within a list of blocks
*
* Checks into innerBlocks recursively.
*
* @since 5.0.0
*
* @param array[] $blocks Array of WP_Block definition arrays.
* @return boolean Returns `true` when a username block is found, otherwise returns `false`.
*/
private function has_username_block( $blocks ) {
foreach ( $blocks as $block ) {
if ( 'llms/form-field-user-login' === $block['blockName'] ) {
return true;
} elseif ( $block['innerBlocks'] ) {
if ( $this->has_username_block( $block['innerBlocks'] ) ) {
return true;
}
}
}
return false;
}
/**
* When saving a form store a form reference in the options table
*
* This will be used to LLMS_Forms::are_usernames_enabled() to determine
* if the site allows login via usernames.
*
* Callback function for save_post_llms_forms and delete_post hooks.
*
* @since 5.0.0
*
* @param int $post_id ID of the form being saved.
* @param WP_Post $post Form post object.
* @return int[] Returns an array of WP_Post IDs representing all the forms where the username block existss.
*/
public function save_username_locations( $post_id, $post ) {
// Load existing locations.
$locations = get_option( 'llms_forms_username_locations', array() );
$post_id = absint( $post_id );
$blocks = $this->forms->parse_blocks( $post->post_content );
$has_username_block = $this->has_username_block( $blocks );
// Add or remove the location depending on the presence of the block.
if ( $has_username_block ) {
$locations[] = $post_id;
} else {
$locations = array_diff( $locations, array( $post_id ) );
}
$locations = array_unique( $locations );
// Store it.
update_option( 'llms_forms_username_locations', $locations );
return $locations;
}
}
return new LLMS_Forms_Data();
================================================
FILE: includes/forms/class-llms-forms-dynamic-fields.php
================================================
<?php
/**
* LLMS_Forms_Dynamic_Fields file
*
* @package LifterLMS/Classes/Forms
*
* @since 5.0.0
* @version 5.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Manage dynamically generated fields added to the form outside of the block editor
*
* @since 5.0.0
*/
class LLMS_Forms_Dynamic_Fields {
/**
* Constructor
*
* @since 5.0.0
* @since 5.1.0 Added logic to make sure forms have all the required fields.
*
* @return void
*/
public function __construct() {
add_filter( 'llms_get_form_blocks', array( $this, 'add_password_strength_meter' ), 10, 2 );
add_filter( 'llms_get_form_blocks', array( $this, 'maybe_add_required_block_fields' ), 10, 3 );
add_filter( 'llms_get_form_blocks', array( $this, 'modify_account_form' ), 15, 2 );
}
/**
* Creates a new HTML block with the given settings and inserts it into an existing blocks array at the specified location
*
* @since 5.0.0
*
* @param array[] $blocks Array of WP_Block arrays.
* @param array $block_settings Block attributes used to generate a new custom HTML field block.
* @param integer $index Desired index of the new block.
*
* @return array[]
*/
private function add_block( $blocks, $block_settings, $index ) {
// Make the new block.
$add_block = parse_blocks(
LLMS_Forms::instance()->get_custom_field_block_markup( $block_settings )
);
// Add it into the form after the specified index.
array_splice( $blocks, $index + 1, 0, $add_block );
return $blocks;
}
/**
* Adds a password strength meter to a block list
*
* This function will programmatically add an html block containing the necessary
* markup for the password strength meter to function.
*
* This will locate the user password block and output the meter immediately after
* the block. If the password block is within a group it'll output it after the
* group block.
*
* @since 5.0.0
* @since 5.0.1 Add `aria-live=polite` to ensure password strength is announced for screen readers.
*
* @param array[] $blocks WP_Block list.
* @return array[]
*/
public function add_password_strength_meter( $blocks, $location ) {
$password = $this->find_block( 'password', $blocks );
// No password field in the form.
if ( ! $password ) {
return $blocks;
}
list( $index, $block ) = $password;
// Meter not enabled.
if ( empty( $block['attrs']['meter'] ) || ! llms_parse_bool( $block['attrs']['meter'] ) ) {
return $blocks;
}
$meter_settings = array(
'type' => 'html',
'id' => 'llms-password-strength-meter',
'classes' => 'llms-password-strength-meter',
'description' => ! empty( $block['attrs']['meter_description'] ) ? $block['attrs']['meter_description'] : '',
'min_length' => ! empty( $block['attrs']['html_attrs']['minlength'] ) ? $block['attrs']['html_attrs']['minlength'] : '',
'min_strength' => ! empty( $block['attrs']['min_strength'] ) ? $block['attrs']['min_strength'] : '',
'llms_visibility' => ! empty( $block['attrs']['llms_visibility'] ) ? $block['attrs']['llms_visibility'] : '',
'attributes' => array(
'aria-live' => 'polite',
),
);
if ( 'account' === $location ) {
$meter_settings['wrapper_classes'] = 'llms-visually-hidden-field';
}
/**
* Filters the settings used to create the dynamic password strength meter block
*
* @since 5.0.0
*
* @param array $meter_settings Array or block attributes/settings.
*/
$meter_settings = apply_filters( 'llms_password_strength_meter_field_settings', $meter_settings );
return $this->add_block( $blocks, $meter_settings, $index );
}
/**
* Finds a block with the specified ID within a list of blocks
*
* There's a gotcha with this function... if a user password field is placed within a wp core columns block
* the password strength meter will be added outside the column the password is contained within.
*
* @since 5.0.0
*
* @param string $id The ID of the field to find.
* @param array[] $blocks WP_Block list.
* @param integer $parent_index Top level index of the parent block. Used to hold a reference to the current index within the toplevel
* blocks of the form when looking into the innerBlocks of a block.
* @return boolean|array Returns `false` when the block cannot be found in the given list, otherwise returns a numeric array
* where item `0` is the index of the block within the list (the index of the items parent if it's in a
* group) and item `1` is the block array.
*/
private function find_block( $id, $blocks, $parent_index = null ) {
foreach ( $blocks as $index => $block ) {
if ( ! empty( $block['attrs']['id'] ) && $id === $block['attrs']['id'] ) {
return array( is_null( $parent_index ) ? $index : $parent_index, $block );
}
if ( $block['innerBlocks'] ) {
$inner = $this->find_block( $id, $block['innerBlocks'], is_null( $parent_index ) ? $index : $parent_index );
if ( false !== $inner ) {
return $inner;
}
}
}
return false;
}
/**
* Retrieve the fields required for a given location based on user state
*
* @since 5.1.0
*
* @param string $location The request form location ID.
* @param array $args Additional arguments passed to the short-circuit filter.
* @return array[] Array of field_id => block_name required or an empty array if no fields required.
*/
private function get_required_fields_for_location( $location, $args ) {
$fields = array();
if (
( ! is_user_logged_in() && in_array( $location, array( 'checkout', 'registration' ), true ) ) ||
( is_user_logged_in() && 'account' === $location ) ) {
$fields = array(
// Field ID => block name.
'email_address' => 'email',
'password' => 'password',
);
}
/**
* Filters the required block fields to add to the form
*
* @since 5.1.0
*
* @param array[] $fields Array of field_id => block_name required.
* @param string $location The request form location ID.
* @param array $args Additional arguments passed to the short-circuit filter.
*/
return apply_filters( 'llms_forms_required_block_fields', $fields, $location, $args );
}
/**
* Retrieve the HTML for a field toggle button link
*
* @since 5.0.0
*
* @param string $fields A comma-separated list of selectors for the controlled fields.
* @param string $field_label Label for the original field.
* @return string
*/
private function get_toggle_button_html( $fields, $field_label ) {
// Translator: %s = user-selected label for the given field being toggled.
$change_text = sprintf( esc_attr_x( 'Change %s', 'Toggle button for changing email or password', 'lifterlms' ), $field_label );
$cancel_text = esc_attr_x( 'Cancel', 'Cancel password or email address change button text', 'lifterlms' );
return '<a class="llms-toggle-fields" data-fields="' . $fields . '" data-change-text="' . $change_text . '" data-cancel-text="' . $cancel_text . '" href="#">' . $change_text . '</a>';
}
/**
* Modifies account form to improve the UX of editing the email address and password fields
*
* Adds a "Current Password" field used to verify the existing user password when changing passwords.
*
* Forces email & password fields to be required and makes them disabled and visually hidden on page load.
*
* Adds a toggle button for each set of fields, when the toggle is clicked the fields are revealed and enabled
* so they can be used. Ensuring that the fields are only required when they're being explicitly changed.
*
* @since 5.0.0
*
* @param array[] $blocks Array of parsed WP_Block arrays.
* @param string $location The form location ID.
*
* @return array[]
*/
public function modify_account_form( $blocks, $location ) {
// Only add toggles on the account edit form.
if ( 'account' !== $location ) {
return $blocks;
}
$blocks = $this->modify_toggle_blocks( $blocks );
foreach ( array( 'email_address', 'password' ) as $id ) {
$field = $this->find_block( $id, $blocks );
$blocks = $field ? $this->{"toggle_for_$id"}( $field, $blocks ) : $blocks;
}
return $blocks;
}
/**
* Maybe add the required email and password block to a form.
*
* @since 5.1.0
* @since 5.4.1 Make sure added reusable blocks contain the actual required field,
* otherwise fall back on the dynamically generated ones.
*
* @param array[] $blocks Array of parsed WP_Block arrays.
* @param string $location The request form location ID.
* @param array $args Additional arguments passed to the short-circuit filter.
* @return array[]
*/
public function maybe_add_required_block_fields( $blocks, $location, $args ) {
$fields_to_require = $this->get_required_fields_for_location( $location, $args );
if ( empty( $fields_to_require ) ) {
return $blocks;
}
foreach ( $fields_to_require as $field_id => $field_block_name ) {
$block = $this->find_block( $field_id, $blocks );
if ( ! empty( $block ) ) {
// Fields in non checkout forms are always visible - see LLMS_Forms::get_form_html().
$blocks = 'checkout' === $location ? $this->make_block_visible( $block[1], $blocks, $block[0] ) : $blocks;
unset( $fields_to_require[ $field_id ] );
if ( empty( $fields_to_require ) ) { // All the required blocks are present.
return $blocks;
}
}
}
return $this->add_required_block_fields( $fields_to_require, $blocks, $location );
}
/**
* Add required block fields.
*
* @since 5.4.1
*
* @param string[] $fields_to_require Array of field ids to require.
* @param array[] $blocks Array of parsed WP_Block arrays to add required fields to.
* @param string $location The request form location ID.
* @return array[]
*/
private function add_required_block_fields( $fields_to_require, $blocks, $location ) {
$blocks_to_add = array();
foreach ( $fields_to_require as $field_id => $block_to_add ) {
// If a reusable block exists for the field, use it. Otherwise use a dynamically generated block from the template schema.
$use_reusable = LLMS_Form_Templates::find_reusable_block( $block_to_add );
$block = LLMS_Form_Templates::get_block( $block_to_add, $location, $use_reusable );
if ( $use_reusable ) {
// Load reusable block.
$_blocks = LLMS_Forms::instance()->load_reusable_blocks( array( $block ) );
// The reusable block doesn't contain the needed block, use a dynamically generated block from the template schema.
if ( empty( $_blocks ) || ! $this->find_block( $field_id, $_blocks ) ) {
$_blocks = array( LLMS_Form_Templates::get_block( $block_to_add, $location, false ) );
}
$block = $_blocks[0];
}
$blocks_to_add[] = $block;
}
// Make blocks to add visible.
$blocks_to_add = 'checkout' === $location ? array_map( array( $this, 'make_all_visible' ), $blocks_to_add ) : $blocks_to_add;
return array_merge(
$blocks,
$blocks_to_add
);
}
/**
* Make a block visible within its list of blocks
*
* @since 5.1.0
*
* @param array $block Parsed WP_Block array.
* @param array[] $blocks Array of parsed WP_Block arrays.
* @param int $block_index Index of the block within the `$blocks` list.
* If the block is in a group, this is the the index of the item's parent.
* @return array[]
*/
private function make_block_visible( $block, $blocks, $block_index ) {
if ( LLMS_Forms::instance()->is_block_visible_in_list( $block, array( $blocks[ $block_index ] ) ) ) {
return $blocks;
}
// If the block has a confirm group, use that.
$confirm = $this->get_confirm_group( $block['attrs']['id'], array( $blocks[ $block_index ] ) );
$block_to_add = empty( $confirm ) ? $block : $confirm;
$replace = true;
// Insert the visible block before the invisible one if the block is in a group,
// so to avoid the replacement of the whole group which might contain other required fields.
// But replace the invisible with the visible if otherwise.
if ( $block_to_add !== $blocks[ $block_index ] ) {
$replace = false;
$this->remove_block( $block_to_add, $blocks );
}
// Make the block to add and its children visible.
$block_to_add = $this->make_all_visible( $block_to_add );
array_splice( $blocks, $block_index, (int) ( ! empty( $replace ) ), array( $block_to_add ) );
return $blocks;
}
/**
* Remove block from the list which contains it.
*
* @since 5.1.0
*
* @param array $block Parsed WP_Block array.
* @param array[] $blocks Array of parsed WP_Block arrays (passed by reference).
* @param array $parent Optional. Parsed WP_Block array representing the parent block of the `$blocks`, in case this is a list of inner blocks. Default null.
* Passed by reference.
* @return bool
*/
private function remove_block( $block, &$blocks, &$parent = null ) {
foreach ( $blocks as $index => &$_block ) {
if ( $_block === $block ) {
array_splice( $blocks, $index, 1 ); // Remove and re-index.
// If we're removing an innerBlock we need to update the innerContent too, to avoid wp calling the render method on nulls.
if ( ! is_null( $parent ) ) {
$this->remove_inner_block_from_inner_content( $index, $parent );
}
return true;
}
if ( ! empty( $_block['innerBlocks'] ) ) {
$removed = $this->remove_block( $block, $_block['innerBlocks'], $_block );
}
if ( ! empty( $removed ) ) { // Break as soon as the desired block is removed from one of the innerBlocks.
return true;
}
}
return false;
}
/**
* Remove inner block reference from inner content
*
* See WP_Block::inner_content documentation.
*
* The inner_content block's property is an array of string fragments and null markers where inner blocks were found.
* So here we cycle over the block's parent innerContent field looking for references to innerBlocks (null).
* When we found a positional correspondance between the removed innerBlock and its refernce in innerContent we remove the latter too.
*
* @since 5.1.0
*
* @param int $inner_block_index The index of the inner block in the block's innerBlocks list.
* @param array $parent Parsed WP_Block array representing the inner blocks parent. Passed by reference.
*/
private function remove_inner_block_from_inner_content( $inner_block_index, &$parent ) {
$inner_block_in_content_index = 0;
foreach ( $parent['innerContent'] as $chunk_index => $chunk ) {
if ( ! is_string( $chunk ) && $inner_block_index === $inner_block_in_content_index++ ) {
array_splice( $parent['innerContent'], $chunk_index, 1 ); // Remove and re-index.
break;
}
}
}
/**
* Make the block and its children visible
*
* @since 5.1.0
*
* @param array $block A parsed WP_Block.
* @return array
*/
private function make_all_visible( $block ) {
if ( ! empty( $block['innerBlocks'] ) ) {
foreach ( $block['innerBlocks'] as $index => $inner_block ) {
$block['innerBlocks'][ $index ] = $this->make_all_visible( $inner_block );
}
}
$block['attrs']['llms_visibility'] = '';
return $block;
}
/**
* Get confirm group in a list of blocks for a given block id
*
* @since 5.1.0
*
* @param string $id The ID of the field to find the confirm group for.
* @param array[] $blocks WP_Block list.
* @return array
*/
private function get_confirm_group( $id, $blocks ) {
foreach ( $blocks as $index => $block ) {
if ( $block['innerBlocks'] ) {
if ( ( 'llms/form-field-confirm-group' === $block['blockName'] ) &&
$this->find_block( $id, $block['innerBlocks'] ) ) {
return $block;
}
$inner = $this->get_confirm_group( $id, $block['innerBlocks'] );
if ( false !== $inner ) {
return $inner;
}
}
}
return false;
}
/**
* Modifies block settings for toggle-controlled fields
*
* @since 5.0.0
*
* @param array[] $blocks Array of WP_Block arrays.
* @return array[]
*/
private function modify_toggle_blocks( $blocks ) {
// List of toggle fields to modify.
$fields = array(
'email_address',
'email_address_confirm',
'password',
'password_confirm',
);
foreach ( $blocks as &$block ) {
if ( ! empty( $block['innerBlocks'] ) ) {
$block['innerBlocks'] = $this->modify_toggle_blocks( $block['innerBlocks'] );
} elseif ( ! empty( $block['attrs']['id'] ) && in_array( $block['attrs']['id'], $fields, true ) ) {
$block['attrs']['wrapper_classes'] = 'llms-visually-hidden-field';
$block['attrs']['disabled'] = true;
$block['attrs']['required'] = true;
}
}
return $blocks;
}
/**
* Adds a toggle link button allowing the user to change their email address
*
* @since 5.0.0
*
* @param array $email Email field data as located by LLMS_Forms_Dynamic_Fields::find_block().
* @param array[] $blocks Array of WP_Block arrays.
* @return array[]
*/
private function toggle_for_email_address( $email, $blocks ) {
return $this->add_block(
$blocks,
array(
'type' => 'html',
'id' => 'llms-field-toggle--email',
'value' => $this->get_toggle_button_html( '#email_address,#email_address_confirm', $email[1]['attrs']['label'] ),
),
$email[0]
);
}
/**
* Adds a current password field and a toggle link button allowing the user to change their password
*
* @since 5.0.0
*
* @param array $password Password field data as located by LLMS_Forms_Dynamic_Fields::find_block().
* @param array[] $blocks Array of WP_Block arrays.
* @return array[]
*/
private function toggle_for_password( $password, $blocks ) {
// Add the toggle button.
$blocks = $this->add_block(
$blocks,
array(
'type' => 'html',
'id' => 'llms-field-toggle--password',
'value' => $this->get_toggle_button_html( '#password,#password_confirm,#llms-password-strength-meter,#password_current', $password[1]['attrs']['label'] ),
),
$password[1]['attrs']['meter'] ? $password[0] + 1 : $password[0]
);
/**
* Filters the settings used to create the dynamic password strength meter block
*
* @since 5.0.0
*
* @param array $settings Array or block attributes/settings.
*/
$current_password = apply_filters(
'llms_current_password_field_settings',
array(
'type' => 'password',
'id' => 'password_current',
'name' => 'password_current',
'label' => sprintf( __( 'Current %s', 'lifterlms' ), $password[1]['attrs']['label'] ),
'required' => true,
'disabled' => true,
'data_store_key' => false,
'wrapper_classes' => 'llms-visually-hidden-field',
)
);
return $this->add_block( $blocks, $current_password, $password[0] - 1 );
}
}
return new LLMS_Forms_Dynamic_Fields();
================================================
FILE: includes/forms/class-llms-forms-unsupported-versions.php
================================================
<?php
/**
* LLMS_Forms_Unsupported_Versions file
*
* @package LifterLMS/Classes/Forms
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Handles admin interface changes when forms cannot be managed with the block editor
*
* The file, class, and all class methods will be removed without warning when the overall supported
* WordPress version is 5.7. Class methods are public in order to function within the WordPress API
* but should be considered private for this reason.
*
* @since 5.0.0
*
* @access private
*/
class LLMS_Forms_Unsupported_Versions {
/**
* Constructor
*
* @since 5.0.0
*
* @access private
*
* @return void
*/
public function __construct() {
if ( LLMS_Forms::instance()->are_requirements_met() ) {
return;
}
add_action( 'current_screen', array( $this, 'init' ) );
}
/**
* Add actions depending on the current screen
*
* @since 5.0.0
*
* @access private
*
* @return void
*/
public function init() {
$screen = get_current_screen();
if ( 'edit-llms_form' === $screen->id ) {
add_action( 'admin_print_styles', array( $this, 'print_styles' ) );
add_action( 'admin_notices', array( $this, 'output_notice' ) );
} elseif ( 'llms_form' === $screen->id ) {
llms_redirect_and_exit( admin_url( 'edit.php?post_type=llms_form' ) );
}
}
/**
* Output an admin error notice alerting users when requirements are not met.
*
* @since 5.0.0
*
* @access private
*
* @return void
*/
public function output_notice() {
?>
<div class="notice notice-error">
<p><b><?php esc_html_e( 'Minimum Version Requirements Error', 'lifterlms' ); ?></b></p>
<p><?php printf( esc_html__( 'In order to manage LifterLMS Forms you must upgrade to at least WordPress version %s or later or install the latest version of the Gutenberg plugin.', 'lifterlms' ), esc_html( LLMS_Forms::instance()::MIN_WP_VERSION ) ); ?></p>
<p><?php esc_html_e( 'If you do not upgrade, your forms will display properly on the frontend and users will be able to create accounts, enroll, and checkout but you will be unable to customize them.', 'lifterlms' ); ?></p>
</div>
<?php
}
/**
* Output dirty inline CSS to prevent interaction with the posts table list
*
* @since 5.0.0
*
* @access private
*
* @return void
*/
public function print_styles() {
echo '<style type="text/css" id="llms-forms-unsupported-styles">#the-list { pointer-events: none; filter: blur( 1px ); }</style>';
}
}
return new LLMS_Forms_Unsupported_Versions();
================================================
FILE: includes/forms/class-llms-forms.php
================================================
<?php
/**
* Register and manage LifterLMS user forms.
*
* @package LifterLMS/Classes
*
* @since 5.0.0
* @version 7.1.4
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Forms class
*
* @since 5.0.0
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
*/
class LLMS_Forms {
use LLMS_Trait_Singleton;
/**
* Minimum Supported WP Version required to manage forms with the block editor UI.
*/
const MIN_WP_VERSION = '5.7.0';
/**
* Provide access to the post type manager class
*
* @var LLMS_Forms_Post_Type
*/
public $post_type_manager = null;
/**
* Private Constructor
*
* @since 5.0.0
*
* @return void
*/
private function __construct() {
$this->post_type_manager = new LLMS_Form_Post_Type( $this );
add_filter( 'render_block', array( $this, 'render_field_block' ), 10, 2 );
add_filter( 'llms_get_form_post', array( $this, 'maybe_load_preview' ) );
}
/**
* Determines if the WP core requirements are met
*
* This is used to determine if the block editor can be used to manage forms and fields,
* all frontend and server-side handling works on all core supported WP versions.
*
* @since 5.0.0
*
* @return boolean
*/
public function are_requirements_met() {
global $wp_version;
return version_compare( $wp_version, self::MIN_WP_VERSION, '>=' ) || is_plugin_active( 'gutenberg/gutenberg.php' );
}
/**
* Determine if usernames are enabled on the site.
*
* This method is used to determine if a username can be used to login / reset a user's password.
*
* A reference to every form with a username block is stored in an option. The option is an array
* of integers, the WP_Post IDs of all the form posts containing a username block.
*
* If the array is empty, there are no forms with username blocks and, therefore, usernames are disabled.
* If the array contains at least one item that means there is a form with a username block in it and,
* we therefore consider usernames to be enabled for the site.
*
* @since 5.0.0
*
* @return bool
*/
public function are_usernames_enabled() {
$locations = get_option( 'llms_forms_username_locations', array() );
/**
* Use this to explicitly enable of disable username fields.
*
* Note that usage of this filter will not actually disable the llms/form-field-username block.
* It's possible to create a confusing user experience by explicitly disabling usernames and
* leaving username field blocks on one or more forms. If you decide to explicitly disable via
* this filter you should also remove all the username blocks from all of your forms.
*
* @since 5.0.0
*
* @param boolean $enabled Whether or not usernames are enabled.
*/
return apply_filters( 'llms_are_usernames_enabled', ! empty( $locations ) );
}
/**
* Converts a block to settings understandable by `llms_form_field()`
*
* @since 5.0.0
* @since 5.1.0 Added logic to remove invisible fields.
* Added `$block_list` param.
*
* @param array $block A WP Block array.
* @param array[] $block_list Optional. The list of WP Block array `$block` comes from. Default is empty array.
* @return array
*/
private function block_to_field_settings( $block, $block_list = array() ) {
$is_visible = $this->is_block_visible_in_list( $block, $block_list );
/**
* Filters whether or not invisible fields should be included
*
* If the block is not visible (according to LLMS block-level visibility settings)
* it will return an empty array (signaling the field to be removed).
*
* @since 5.1.0
*
* @param boolean $filter Whether or not invisible fields should be included. Default is `false`.
* @param array $block A WP Block array.
* @param array[] $block_list The list of WP Block array `$block` comes from.
*/
if ( ! $is_visible && apply_filters( 'llms_forms_remove_invisible_field', false, $block, $block_list ) ) {
return array();
}
$attrs = $this->convert_settings_format( $block['attrs'], 'block' );
// If the field is required and hidden it's impossible for the user to fill it out so it gets marked as optional at runtime.
if ( ! empty( $attrs['required'] ) && ! $is_visible ) {
$attrs['required'] = false;
}
/**
* Filter an LLMS_Form_Field settings array after conversion from a field block
*
* @since 5.0.0
* @since 5.1.0 Added `$block_list` param.
*
* @param array $attrs An array of LLMS_Form_Field settings.
* @param array $block A WP Block array.
* @param array[] $block_list The list of WP Block array `$block` comes from.
*/
return apply_filters( 'llms_forms_block_to_field_settings', $attrs, $block, $block_list );
}
/**
* Cascade all llms_visibility attributes down into inner blocks.
*
* If a parent block has a visibility setting this will apply that visibility to a chlid block *if*
* the child block does not have a visibility setting of its own.
*
* Ultimately this ensures that a field block that's not visible can be marked as "optional" so that
* form validation can take place.
*
* For example, if a columns block is displayed only to logged out users and it's child fields are marked
* as required that means that it's required only to logged out users and the field becomes "optional"
* (for validation purposes) to logged in users.
*
* @since 5.0.0
*
* @param array[] $blocks Array of parsed block arrays.
* @param string|null $visibility The llms_visibility attribute of the parent block which is applied to all innerBlocks
* if the innerBlock does not already have it's own visibility attribute.
* @return array[]
*/
private function cascade_visibility_attrs( $blocks, $visibility = null ) {
foreach ( $blocks as &$block ) {
// If a visibility setting has been passed from the parent and the block does not have visibility setting of it's own.
if ( $visibility && ( empty( $block['attrs']['llms_visibility'] ) || 'off' === $block['attrs']['llms_visibility'] ) ) {
$block['attrs']['llms_visibility'] = $visibility;
}
// This block has a visibility attribute and it should be applied it to all the innerBlocks.
if ( ! empty( $block['attrs']['llms_visibility'] ) && ! empty( $block['innerBlocks'] ) ) {
$block['innerBlocks'] = $this->cascade_visibility_attrs( $block['innerBlocks'], $block['attrs']['llms_visibility'] );
}
}
return $blocks;
}
/**
* Converts field settings formats
*
* There are small differences between the LLMS_Form_Fields settings array
* and the WP_Block settings array.
*
* This method accepts an associative array
* in one format or the other and converts it from the original format to the opposite format.
*
* @since 5.0.0
*
* @param array $map Associative array of settings.
* @param string $orignal_format The original format of the submitted `$map`. Either "field" for
* an array of LLMS_Form_Field settings or `block` for an array
* of WP_Block attributes.
* @return [type] [description]
*/
private function convert_settings_format( $map, $orignal_format ) {
// Block attributes to LLMS_Form_Field settings.
$keys = array(
'field' => 'type',
'className' => 'classes',
'html_attrs' => 'attributes',
);
// LLMS_Form_Field settings to block attributes.
if ( 'field' === $orignal_format ) {
$keys = array_flip( $keys );
}
// Loop through the original map and rename the necessary keys.
foreach ( $keys as $orig_key => $new_key ) {
if ( isset( $map[ $orig_key ] ) ) {
$map[ $new_key ] = $map[ $orig_key ];
unset( $map[ $orig_key ] );
}
}
return $map;
}
/**
* Converts an array of LLMS_Form_Field settings to a block attributes array
*
* @since 5.0.0
*
* @param array $settings An array of LLMS_Form_Field settings.
* @return array An array of WP_Block attributes.
*/
public function convert_settings_to_block_attrs( $settings ) {
return $this->convert_settings_format( $settings, 'field' );
}
/**
* Create a form for a given location with the provided data.
*
* @since 5.0.0
*
* @param string $location_id Location id.
* @param bool $recreate If `true` and the form already exists, will recreate the existing form using the existing form's id.
* @return int|false Returns the created/update form post ID on success.
* If the location doesn't exist, returns `false`.
* If the form already exists and `$recreate` is `false` will return `false`.
*/
public function create( $location_id, $recreate = false ) {
if ( ! $this->is_location_valid( $location_id ) ) {
return false;
}
$locs = $this->get_locations();
$data = $locs[ $location_id ];
$existing = $this->get_form_post( $location_id );
// Form already exists and we haven't requested an update.
if ( false !== $existing && ! $recreate ) {
return false;
}
$args = array(
'ID' => $existing ? $existing->ID : 0,
'post_content' => LLMS_Form_Templates::get_template( $location_id ),
'post_status' => 'publish',
'post_title' => $data['title'],
'post_type' => $this->get_post_type(),
'meta_input' => $data['meta'],
'post_author' => $existing ? $existing->post_author : LLMS_Install::get_can_install_user_id(),
);
/**
* Filter arguments used to install a new form.
*
* @since 5.0.0
*
* @param array $args Array of arguments to be passed to wp_insert_post
* @param string $location_id Location ID/name.
* @param array $data Array of location information from LLMS_Forms::get_locations().
*/
$args = apply_filters( 'llms_forms_install_post_args', $args, $location_id, $data );
return wp_insert_post( $args );
}
/**
* Retrieve the form management user capability.
*
* @since 5.0.0
*
* @return string
*/
public function get_capability() {
return $this->post_type_manager->capability;
}
/**
* Pull LifterLMS Form Field blocks from an array of parsed WP Blocks.
*
* Searches innerBlocks arrays recursively.
*
* @since 5.0.0
* @since 5.1.0 First check block's innerBlock attribute exists when checking for inner blocks.
* Also made the access visibility public.
* @since 5.9.0 Pass an empty string to `strpos()` instead of `null`.
*
* @param array $blocks Array of WP Block arrays from `parse_blocks()`.
* @return array
*/
public function get_field_blocks( $blocks ) {
$fields = array();
foreach ( $blocks as $block ) {
if ( ! empty( $block['innerBlocks'] ) ) {
$fields = array_merge( $fields, $this->get_field_blocks( $block['innerBlocks'] ) );
} elseif ( false !== strpos( $block['blockName'] ?? '', 'llms/form-field-' ) ) {
$fields[] = $block;
} elseif ( 'core/html' === $block['blockName'] && ! empty( $block['attrs']['type'] ) ) {
$fields[] = $block;
}
}
return $fields;
}
/**
* Returns a list of field names used by LifterLMS forms
*
* Used to validate uniqueness of custom field data.
*
* @since 5.0.0
*
* @return string[]
*/
public function get_field_names() {
$names = array(
'user_login',
'user_login_confirm',
'email_address',
'email_address_confirm',
'password',
'password_confirm',
'first_name',
'last_name',
'display_name',
'llms_billing_address_1',
'llms_billing_address_2',
'llms_billing_city',
'llms_billing_country',
'llms_billing_state',
'llms_billing_zip',
'llms_phone',
);
/**
* Filters the list of field names used by LifterLMS forms
*
* @since 5.0.0
*
* @param string[] $names List of registered field names.
*/
return apply_filters( 'llms_forms_field_names', $names );
}
/**
* Retrieve an array of parsed blocks for the form at a given location.
*
* @since 5.0.0
*
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter.
* @return array|false
*/
public function get_form_blocks( $location, $args = array() ) {
$post = $this->get_form_post( $location, $args );
if ( ! $post ) {
return false;
}
$content = $post->post_content;
$content .= $this->get_additional_fields_html( $location, $args );
$blocks = $this->parse_blocks( $content );
/**
* Filters the parsed block list for a given LifterLMS form
*
* This hook can be used to programmatically modify, insert, or remove
* blocks (fields) from a form.
*
* @since 5.0.0
*
* @param array[] $blocks Array of parsed WP_Block arrays.
* @param string $location The request form location ID.
* @param array $args Additional arguments passed to the short-circuit filter.
*/
return apply_filters( 'llms_get_form_blocks', $blocks, $location, $args );
}
/**
* Retrieve an array of LLMS_Form_Fields settings arrays for the form at a given location.
*
* This method is used by the LLMS_Form_Handler to perform validations on user-submitted data.
*
* @since 5.0.0
*
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter in `get_form_post()`.
* @return false|array
*/
public function get_form_fields( $location, $args = array() ) {
$blocks = $this->get_form_blocks( $location, $args );
if ( false === $blocks ) {
return false;
}
$fields = $this->get_fields_settings_from_blocks( $blocks );
/**
* Modify the parsed array of LifterLMS Form Fields
*
* @since 5.0.0
*
* @param array[] $fields Array of LifterLMS Form Field settings data.
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter in `get_form_post()`.
*/
return apply_filters( 'llms_get_form_fields', $fields, $location, $args );
}
/**
* Retrieve an array of LLMS_Form_Field settings from an array of blocks.
*
* @since 5.0.0
* @since 5.1.0 Pass the whole list of blocks to the `$this->block_to_field_settings()` method
* to better check whether a block is visible.
* @since 6.2.0 Exploded hidden checkbox fields.
*
* @param array $blocks Array of WP Block arrays from `parse_blocks()`.
* @return array
*/
public function get_fields_settings_from_blocks( $blocks ) {
$fields = array();
$blocks = $this->get_field_blocks( $blocks );
foreach ( $blocks as $block ) {
$settings = $this->block_to_field_settings( $block, $blocks );
if ( empty( $settings ) ) {
continue;
}
if (
'hidden' === ( $settings['type'] ?? null ) &&
isset( $block['attrs']['field'] ) && 'checkbox' === $block['attrs']['field']
) {
// Convert hidden checkbox settings into multiple "checked" hidden fields.
$settings['type'] = $block['attrs']['field'];
$field = new LLMS_Form_Field( $settings );
$form_fields = $field->explode_options_to_fields( true );
foreach ( $form_fields as $form_field ) {
$fields[] = $form_field->get_settings();
}
} else {
$field = new LLMS_Form_Field( $settings );
$fields[] = $field->get_settings();
}
}
return $fields;
}
/**
* Retrieve a field item from a list of fields by a key/value pair.
*
* @since 5.0.0
*
* @param array[] $fields List of LifterLMS Form Fields.
* @param string $key Setting key to search for.
* @param mixed $val Setting valued to search for.
* @param string $return Determine the return value. Use "field" to return the field settings
* array. Use "index" to return the index of the field in the $fields array.
* @return array|int|false `false` when the field isn't found in $fields, otherwise returns the field settings
* as an array when `$return` is "field". Otherwise returns the field's index as an int.
*/
public function get_field_by( $fields, $key, $val, $return = 'field' ) {
foreach ( $fields as $index => $field ) {
if ( isset( $field[ $key ] ) && $val === $field[ $key ] ) {
return 'field' === $return ? $field : $index;
}
}
return false;
}
/**
* Retrieve the rendered HTML for the form at a given location.
*
* @since 5.0.0
*
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter in `get_form_post()`.
* @return string
*/
public function get_form_html( $location, $args = array() ) {
$blocks = $this->get_form_blocks( $location, $args );
if ( ! $blocks ) {
return '';
}
$disable_visibility = ( 'checkout' !== $location );
// Force fields to display regardless of visibility settings when viewing account/registration forms.
if ( $disable_visibility ) {
add_filter( 'llms_blocks_visibility_should_filter_block', '__return_false', 999 );
}
$html = '';
foreach ( $blocks as $block ) {
$html .= render_block( $block );
}
if ( $disable_visibility ) {
remove_filter( 'llms_blocks_visibility_should_filter_block', '__return_false', 999 );
}
/**
* Modify the parsed array of LifterLMS Form Fields.
*
* @since 5.0.0
*
* @param string $html Form fields HTML.
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter in `get_form_post()`.
*/
return apply_filters( 'llms_get_form_html', $html, $location, $args );
}
/**
* Retrieve the WP Post for the form at a given location.
*
* @since 5.0.0
*
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter.
* @return WP_Post|false
*/
public function get_form_post( $location, $args = array() ) {
// @todo Add caching. This runs twice on some page loads.
/**
* Skip core lookup of the form for the request location and return a custom form post.
*
* @since 5.0.0
*
* @param null|WP_Post $post Return a WP_Post object to short-circuit default lookup query.
* @param string $location Form location. Either "checkout", "registration", or "account".
* @param array $args Additional custom arguments.
*/
$post = apply_filters( 'llms_get_form_post_pre_query', null, $location, $args );
if ( is_a( $post, 'WP_Post' ) ) {
return $post;
}
$query = new WP_Query(
array(
'post_type' => $this->get_post_type(),
'posts_per_page' => 1,
'no_found_rows' => true,
// Only show published forms to end users but allow admins to "preview" drafts.
'post_status' => current_user_can( $this->get_capability() ) ? array( 'publish', 'draft' ) : 'publish',
'meta_query' => array(
'relation' => 'AND',
array(
'key' => '_llms_form_location',
'value' => $location,
),
array(
'key' => '_llms_form_is_core',
'value' => 'yes',
),
),
)
);
$post = $query->have_posts() ? $query->posts[0] : false;
/**
* Filters the returned `llms_form` post object
*
* @since 5.0.0
*
* @param WP_Post|boolean $post The post object of the form or `false` if no form could be located.
* @param string $location Form location. Either "checkout", "registration", or "account".
* @param array $args Additional custom arguments.
*/
return apply_filters( 'llms_get_form_post', $post, $location, $args );
}
/**
* Check whether a given form is a core form.
*
* When there are multiple forms for a location, the core form is identified as the one with the lowest ID.
*
* @since 6.4.0
*
* @param WP_Post|int $form Form's WP_Post instance, or its ID.
* @return boolean
*/
public function is_a_core_form( $form ) {
$form_id = $form instanceof WP_Post ? $form->ID : $form;
if ( ! $form_id ) {
return false;
}
return in_array( $form_id, $this->get_core_forms( 'ids' ), true );
}
/**
* Retrieves only core forms.
*
* When there are multiple forms for a location, the core form is identified as the one with the lowest ID.
*
* @since 6.4.0
*
* @param string $return What to return: 'posts', for an array of WP_Post; 'ids' for an array of WP_Post ids.
* @return WP_Post[]|int[]
*/
private function get_core_forms( $return = 'posts', $use_cache = true ) {
global $wpdb;
$forms_cache_key = 'posts' === $return ? 'llms_core_forms' : 'llms_core_form_ids';
$forms = $use_cache ? wp_cache_get( $forms_cache_key ) : false;
if ( false !== $forms ) {
return $forms;
}
$locations = array_keys( $this->get_locations() );
$locations_placeholders = implode( ',', array_fill( 0, count( $locations ), '%s' ) );
$prepare_values = array_merge( array( $this->get_post_type() ), $locations );
$query = "
SELECT MIN({$wpdb->posts}.ID) AS ID
FROM $wpdb->posts
INNER JOIN {$wpdb->postmeta} AS locations ON {$wpdb->posts}.ID = locations.post_id AND locations.meta_key='_llms_form_location'
INNER JOIN {$wpdb->postmeta} AS is_cores ON {$wpdb->posts}.ID = is_cores.post_id AND is_cores.meta_key='_llms_form_is_core'
WHERE {$wpdb->posts}.post_type = %s
AND locations.meta_value IN ({$locations_placeholders})
AND is_cores.meta_value = 'yes'
GROUP BY locations.meta_value";
$form_ids = $wpdb->get_col(
$wpdb->prepare(
$query, // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- It is prepared.
$prepare_values
)
);
$form_ids = array_map( 'absint', $form_ids );
$forms = 'post' === $return ? array_map( 'get_post', $form_ids ) : $form_ids;
wp_cache_set( $forms_cache_key, $forms );
return $forms;
}
/**
* Retrieve additional fields added to the form programmatically.
*
* @since 5.0.0
*
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter.
* @return array[]
*/
private function get_additional_fields( $location, $args = array() ) {
/**
* Filter to add custom fields to a form programmatically.
*
* @since 3.0.0
* @since 5.0.0 Moved from deprecated function `LLMS_Person_Handler::get_available_fields()`.
*
* @param array[] $fields Array of field array suitable to pass to `llms_form_field()`.
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter.
*/
return apply_filters( 'lifterlms_get_person_fields', array(), $location, $args );
}
/**
* Retrieve HTML for the form's additional programmatically-added fields.
*
* Gets the HTML for each field from `llms_form_field()` and wraps it as a `wp/html` block.
*
* @since 5.0.0
*
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter.
* @return string
*/
private function get_additional_fields_html( $location, $args = array() ) {
$html = '';
$fields = $this->get_additional_fields( $location, $args );
foreach ( $fields as $field ) {
$html .= "\r" . $this->get_custom_field_block_markup( $field );
}
return $html;
}
/**
* Retrieve the HTML markup for a custom form field block
*
* Retrieves an array of `LLMS_Form_Field` settings, generates the HTML
* for the field, and wraps it in a `wp:html` block.
*
* @since 5.0.0
*
* @param array $settings Form field settings (passed to `llms_form_field()`).
* @return string
*/
public function get_custom_field_block_markup( $settings ) {
return sprintf( '<!-- wp:html %1$s -->%2$s%3$s%2$s<!-- /wp:html -->', wp_json_encode( $settings ), "\r", llms_form_field( $settings, false ) );
}
/**
* Retrieve an array of form fields used for the "free enrollment" form
*
* This is the "one-click" enrollment form used when a logged-in user clicks the "checkout" button
* from an access plan.
*
* This function converts the checkout form to hidden fields, the result is that users with all required fields
* will be enrolled into the course with a single click (no need to head to the checkout page) and users
* who are missing required information will be directed to the checkout page.
*
* @since 5.0.0
* @since 5.1.0 Specifiy to pass the new 3rd param to the `llms_forms_block_to_field_settings` filter callback.
* @since 5.9.0 Fix php 8.1 deprecation warnings when `get_form_fields()` returns `false`.
* @since 7.0.0 Retrieve and use the free checkout redirect URL as not encoded.
*
* @param LLMS_Access_Plan $plan Access plan being used for enrollment.
* @return array[] List of LLMS_Form_Field settings arrays.
*/
public function get_free_enroll_form_fields( $plan ) {
// Convert all fields to hidden fields and remove any fields hidden by LLMS block-level visibility settings.
add_filter( 'llms_forms_block_to_field_settings', array( $this, 'prepare_field_for_free_enroll_form' ), 999, 3 );
$fields = $this->get_form_fields( 'checkout', compact( 'plan' ) );
remove_filter( 'llms_forms_block_to_field_settings', array( $this, 'prepare_field_for_free_enroll_form' ), 999, 3 );
// If no fields are found, ensure we add to an array instead of casting false to an array (causing a PHP 8.1 deprecation warning).
$fields = ! is_array( $fields ) ? array() : $fields;
// Add additional fields required for form processing.
$fields[] = array(
'name' => 'free_checkout_redirect',
'type' => 'hidden',
'value' => $plan->get_redirection_url( false ),
'data_store_key' => false,
);
$fields[] = array(
'id' => 'llms-plan-id',
'name' => 'llms_plan_id',
'type' => 'hidden',
'value' => $plan->get( 'id' ),
'data_store_key' => false,
);
/**
* Filter the list of LLMS_Form_Fields used to generate the "free enrollment" form
*
* @since 5.0.0
*
* @param array[] $fields List of LLMS_Form_Field settings arrays.
* @param LLMS_Access_Plan $plan Access plan being used for enrollment.
*/
return apply_filters( 'llms_forms_get_free_enroll_form_fields', $fields, $plan );
}
/**
* Retrieve the HTML of form fields used for the "free enrollment" form
*
* @since 5.0.0
*
* @see LLMS_Forms::get_free_enroll_form_fields()
*
* @param LLMS_Access_Plan $plan Access plan being used for enrollment.
* @return string
*/
public function get_free_enroll_form_html( $plan ) {
$html = '';
foreach ( $this->get_free_enroll_form_fields( $plan ) as $field ) {
$html .= llms_form_field( $field, false );
}
return $html;
}
/**
* Retrieve information on all the available form locations.
*
* @since 5.0.0
*
* @return array[] {
* An associative array. The array key is the location ID and each array is a location definition array.
*
* @type string $name The human-readable location name (as displayed on the admin panel).
* @type string $description A description of the form (as displayed on the admin panel).
* @type string $title The form's post title. This is displayed to the end user when the "Show Form Title" option is enabled.
* @type array $meta An associative array of postmeta information for the form. The array key is the meta key and the value is the meta value.
* @type string $template A string used to generate the post content of the form post, usually retrieve from `LLMS_Form_Templates`.
* @type array $meta Array of meta data used when generating the form. The array key is the meta key and array value is the meta value.
* @type array[] $required Array of arrays defining required fields for each form.
* }
*/
public function get_locations() {
$locations = require LLMS_PLUGIN_DIR . 'includes/schemas/llms-form-locations.php';
/**
* Filter the available form locations.
*
* NOTE: Removing core forms (as well as modifying the ids / keys) may cause areas of LifterLMS to stop working.
*
* @since 5.0.0
*
* @param array[] $locations Associative array of form location information.
*/
return apply_filters( 'llms_forms_get_locations', $locations );
}
/**
* Retrieve the forms post type name.
*
* @since 5.0.0
*
* @return string
*/
public function get_post_type() {
return $this->post_type_manager->post_type;
}
/**
* Determine if a block is visible based on LifterLMS Visibility Settings.
*
* @since 5.0.0
* @since 7.1.4 Fixed an issue running unit tests on PHP 7.4 and WordPress 6.2
* expecting `render_block()` returning a string while we were applying a filter
* that returned the boolean `true`.
*
* @param array $block Parsed block array.
* @return bool
*/
private function is_block_visible( $block ) {
// Make the block return a non empty string if it's visible, it will already automatically return an empty string if it's invisible.
add_filter( 'render_block', array( __CLASS__, '__return_string' ), 5 );
// Don't run this class render function on the block during this test.
remove_filter( 'render_block', array( $this, 'render_field_block' ), 10, 2 );
// Render the block.
$render = render_block( $block );
// Cleanup / reapply filters.
add_filter( 'render_block', array( $this, 'render_field_block' ), 10, 2 );
remove_filter( 'render_block', array( __CLASS__, '__return_string' ), 5 );
/**
* Filter whether or not the block is visible.
*
* @since 5.0.0
*
* @param bool $visible Whether or not the block is visible.
* @param array $block Parsed block array.
*/
return apply_filters( 'llms_forms_is_block_visible', llms_parse_bool( $render ), $block );
}
/**
* Determine if a block is visible in the list it's contained based on LifterLMS Visibility Settings
*
* Fall back on `$this->is_block_visible()` if empty `$block_list` is provided.
*
* @since 5.1.0
*
* @param array $block Parsed block array.
* @param array[] $block_list The list of WP Block array `$block` comes from.
* @return bool Returns `true` if `$block` (and all its parents) are visible. Returns `false` when `$block`
* or any of its parents are hidden or when `$block` is not found within `$block_list`.
*/
public function is_block_visible_in_list( $block, $block_list ) {
if ( empty( $block_list ) ) {
return $this->is_block_visible( $block );
}
$path = $this->get_block_path( $block, $block_list );
$is_visible = ! empty( $path ); // Assume the block is visible until proven hidden, except when path is empty.
foreach ( $path as $block ) {
if ( ! $this->is_block_visible( $block ) ) {
$is_visible = false;
break;
}
}
/**
* Filter whether or not the block is visible in the list of blocks it's contained.
*
* @since 5.1.0
*
* @param bool $is_visible Whether or not the block is visible.
* @param array $block Parsed block array.
* @param array[] $block_list The list of WP Block array `$block` comes from.
*/
return apply_filters( 'llms_forms_is_block_visible', $is_visible, $block, $block_list );
}
/**
* Returns a list of block parents plus the block itself in reverse order
*
* @since 5.1.0
*
* @param array $block Parsed block array.
* @param array[] $block_list The list of WP Block array `$block` comes from.
* @param int $iterations Stores the number of iterations.
* @return array[] List of WP_Block arrays or an empty array if `$block` cannot be found within `$block_list`.
*/
private function get_block_path( $block, $block_list, $iterations = 0 ) {
foreach ( $block_list as $_block ) {
// Found the block.
if ( $block === $_block ) {
return array( $block );
}
// No innerblocks, proceed to the next block.
if ( empty( $_block['innerBlocks'] ) ) {
continue;
}
// Look in innerblocks for the block.
foreach ( $_block['innerBlocks'] as $inner_block ) {
// The inner block needs to be merged to the path.
$to_merge = array( $inner_block );
if ( $block === $inner_block ) { // Inner block is the one we're looking for.
$path = array( $block );
$to_merge = array(); // Inner block equals the path, no need to merge it.
} else {
$path = $this->get_block_path( $block, array( $inner_block ), $iterations + 1 );
}
if ( $path ) {
// First iteration, append first block too.
if ( ! $iterations ) {
$to_merge[] = $_block;
}
// Merge.
return array_merge( $path, $to_merge );
}
}
}
// Block not found in the list.
return array();
}
/**
* Returns a filtered version of `$block_list` containing only the passed `$block` and its parents.
*
* @since 5.1.0
*
* @param array $block Parsed block array.
* @param array[] $block_list The list of WP Block array `$block` comes from.
* @return array[] Filtered version of `$block_list` containing only the passed `$block` and its parents.
* Or an empty array if `$block` cannot be found within `$block_list`.
*/
private function get_block_tree( $block, $block_list ) {
foreach ( $block_list as &$_block ) {
// Found the block.
if ( $block === $_block ) {
return array( $block );
}
if ( ! empty( $_block['innerBlocks'] ) ) {
$tree = $this->get_block_tree( $block, $_block['innerBlocks'] );
}
if ( ! empty( $tree ) ) { // Break as soon as the desired block is removed from one of the innerBlocks.
if ( $_block['innerBlocks'] !== $tree ) { // Update innerBlocks/innerContent structure if needed.
$_block['innerBlocks'] = $tree;
// Update innerContent to reflect the innerBlocks changes = only 1 innerBlock.
$inner_block_in_content_index = 0;
foreach ( $_block['innerContent'] as $index => $chunk ) {
if ( ! is_string( $chunk ) && $inner_block_in_content_index++ ) {
unset( $_block['innerContent'][ $index ] );
}
}
// Re-index.
$_block['innerContent'] = array_values( $_block['innerContent'] );
}
return array( $_block );
}
}
return array();
}
/**
* Installation function to install core forms.
*
* @since 5.0.0
*
* @param bool $recreate Whether or not to recreate an existing form. This is passed to `LLMS_Forms::create()`.
* @return WP_Post[] Array of created posts. Array key is the location id and array value is the WP_Post object.
*/
public function install( $recreate = false ) {
$installed = array();
foreach ( array_keys( $this->get_locations() ) as $location ) {
$installed[ $location ] = $this->create( $location, $recreate );
}
return $installed;
}
/**
* Determines if a location is a valid & registered form location
*
* @since 5.0.0
*
* @param string $location The location id.
* @return boolean
*/
public function is_location_valid( $location ) {
return in_array( $location, array_keys( $this->get_locations() ), true );
}
/**
* Loads reusable blocks into a block list.
*
* A reusable block contains a reference to the block post, e.g. `<!-- wp:block {"ref":2198} /-->`,
* which will be loaded during rendering.
*
* Dereferencing the reusable blocks allows the entire block list to be reviewed and to validate all form fields.
* This function will replace each reusable block with the parsed blocks from its reference post.
*
* @since 5.0.0
* @since 5.1.0 Access turned to public.
*
* @param array[] $blocks An array of blocks from `parse_blocks()`,
* where each block is usually an array cast from `WP_Block_Parser_Block`.
*
* @return array[]
*/
public function load_reusable_blocks( $blocks ) {
$loaded = array();
foreach ( $blocks as $block ) {
// Skip blocks that are not reusable blocks.
if ( 'core/block' === $block['blockName'] ) {
// Skip reusable blocks that do not exist or are not published.
$post = get_post( $block['attrs']['ref'] );
if ( ! $post || 'publish' !== get_post_status( $post ) ) {
continue;
}
$loaded = array_merge( $loaded, $this->parse_blocks( $post->post_content ) );
continue;
}
// Does this block's inner blocks have references to reusable blocks?
if ( $block['innerBlocks'] ) {
$block['innerBlocks'] = $this->load_reusable_blocks( $block['innerBlocks'] );
}
$loaded[] = $block;
}
return $loaded;
}
/**
* Load form autosaves when previewing a form
*
* @since 5.0.0
*
* @param WP_Post|boolean $post WP_Post object for the llms_form post or `false` if no form found.
* @return WP_Post|boolean
*/
public function maybe_load_preview( $post ) {
// No form post found.
if ( ! is_object( $post ) ) {
return $post;
}
// The `_set_preview()` method is marked as private but has existed since 2.7 and my guess is that we can use this safely.
if ( ! function_exists( '_set_preview' ) ) {
return $post;
}
$is_preview = ( is_preview() && current_user_can( $this->get_capability(), $post->ID ) );
return $is_preview ? _set_preview( $post ) : $post;
}
/**
* Parse the post_content of a form into a list of WP_Block arrays.
*
* This method parses the blocks, loads block data from any reusable blocks,
* and cascades visibility attributes onto a block's innerBlocks.
*
* @since 5.0.0
*
* @param string $content Post content HTML.
* @return array[] Array of parsed block arrays.
*/
public function parse_blocks( $content ) {
$blocks = parse_blocks( $content );
$blocks = $this->load_reusable_blocks( $blocks );
$blocks = $this->cascade_visibility_attrs( $blocks );
return $blocks;
}
/**
* Modifies a field for usage in the "free enrollment" checkout form
*
* If the block is not visible (according to LLMS block-level visibility settings)
* it will return an empty array (signaling the field to be removed).
*
* Otherwise the block will be converted to a hidden field.
*
* This method is a filter callback and is intended for internal use only.
*
* Backwards incompatible changes and/or method removal may occur without notice.
*
* @since 5.0.0
* @since 5.1.0 Added `$block_list` param.
* @access private
*
* @param array $attrs LLMS_Form_Field settings array for the field.
* @param array $block WP_Block settings array.
* @param array[] $block_list The list of WP Block array `$block` comes from.
* @return array
*/
public function prepare_field_for_free_enroll_form( $attrs, $block, $block_list ) {
if ( ! $this->is_block_visible_in_list( $block, $block_list ) ) {
return array();
}
$attrs['type'] = 'hidden';
if ( isset( $attrs['classes'] ) && strpos( $attrs['classes'], 'llms-select2' ) !== false ) {
// Avoids trying to register the select2 script when the field is a hidden field vs. select field.
$attrs['classes'] = str_replace( 'llms-select2', '', $attrs['classes'] );
}
return $attrs;
}
/**
* Render form field blocks.
*
* @since 5.0.0
* @since 5.9.0 Pass an empty string to `strpos()` instead of `null`.
*
* @param string $html Block HTML.
* @param array $block Array of block information.
* @return string
*/
public function render_field_block( $html, $block ) {
// Return HTML for any non llms/form-field blocks.
if ( false === strpos( $block['blockName'] ?? '', 'llms/form-field-' ) ) {
return $html;
}
if ( ! empty( $block['innerBlocks'] ) ) {
$inner_blocks = array_map( 'render_block', $block['innerBlocks'] );
return implode( "\n", $inner_blocks );
}
$attrs = $this->block_to_field_settings( $block );
return llms_form_field( $attrs, false );
}
/**
* Returns a non-empty string.
*
* Useful for returning a non empty string to filters easily.
*
* @since 7.1.4
*
* @access private
*
* @return string
*/
public static function __return_string(): string {// phpcs:ignore -- PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames.MethodDoubleUnderscore.
return '1';
}
}
return LLMS_Forms::instance();
================================================
FILE: includes/forms/controllers/class.llms.controller.account.php
================================================
<?php
/**
* Form submission handler for forms on the Student Dashboard.
*
* @package LifterLMS/Forms/Controllers/Classes
*
* @since 3.7.0
* @version 6.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Controller_Account class.
*
* @since 3.7.0
* @since 3.35.0 Sanitize `$_POST` data.
* @since 3.37.17 Refactored `lost_password()` and `reset_password()` methods.
*/
class LLMS_Controller_Account {
/**
* Constructor
*
* @since 3.7.0
* @since 3.10.0 Add student subscription cancellation handler.
* @since 5.0.0 Add reset password link redirection handler.
*
* @return void
*/
public function __construct() {
add_action( 'wp', array( $this, 'reset_password_link_redirect' ), 1 );
add_action( 'init', array( $this, 'update' ) );
add_action( 'init', array( $this, 'lost_password' ) );
add_action( 'init', array( $this, 'reset_password' ) );
add_action( 'init', array( $this, 'cancel_subscription' ) );
add_action( 'init', array( $this, 'redeem_voucher' ) );
}
/**
* Lets student cancel recurring access plan subscriptions from the student dashboard view order screen
*
* @since 3.10.0
* @since 3.19.0 Unknown.
* @since 3.35.0 Sanitize `$_POST` data.
*
* @return void
*/
public function cancel_subscription() {
// Invalid nonce or the form wasn't submitted.
if ( ! isset( $_REQUEST['_cancel_sub_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_cancel_sub_nonce'] ) ), 'llms_cancel_subscription' ) ) {
return;
} elseif ( empty( $_POST['order_id'] ) ) {
return llms_add_notice( __( 'Something went wrong. Please try again.', 'lifterlms' ), 'error' );
}
$order = llms_get_post( llms_filter_input( INPUT_POST, 'order_id', FILTER_SANITIZE_NUMBER_INT ) );
$uid = get_current_user_id();
if ( ! $order || $uid != $order->get( 'user_id' ) ) {
return llms_add_notice( __( 'Something went wrong. Please try again.', 'lifterlms' ), 'error' );
}
$note = __( 'Subscription cancelled by student from account page.', 'lifterlms' );
// Active subscriptions move to pending-cancel.
// All other statuses are cancelled immediately.
if ( 'llms-active' === $order->get( 'status' ) ) {
$new_status = 'pending-cancel';
$note .= ' ' . __( 'Enrollment will be cancelled at the end of the prepaid period.', 'lifterlms' );
} else {
$new_status = 'cancelled';
}
$order->set_status( $new_status );
$order->add_note( $note );
/**
* Action triggered after a recurring subscription is cancelled from the student dashboard by the student.
*
* @since 3.17.8
*
* @param LLMS_Order $order The order object.
* @param integer $uid The WP_User ID the student who cancelled the subscription.
*/
do_action( 'llms_subscription_cancelled_by_student', $order, $uid );
}
/**
* Handle submission of user account edit form
*
* @since 3.7.0
* @since 3.24.0 Unknown.
*
* @return void
*/
public function update() {
if ( ! isset( $_REQUEST['_llms_update_person_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_llms_update_person_nonce'] ) ), 'llms_update_person' ) ) {
return;
}
do_action( 'llms_before_user_account_update_submit' );
// No user logged in, can't update!
// This shouldn't happen but let's check anyway.
if ( ! get_current_user_id() ) {
return llms_add_notice( __( 'Please log in and try again.', 'lifterlms' ), 'error' );
}
$person_id = llms_update_user( $_POST, 'account' );
// Validation or update issues.
if ( is_wp_error( $person_id ) ) {
foreach ( $person_id->get_error_messages() as $msg ) {
llms_add_notice( $msg, 'error' );
}
return;
} elseif ( ! is_numeric( $person_id ) ) {
return llms_add_notice( __( 'An unknown error occurred when attempting to create an account, please try again.', 'lifterlms' ), 'error' );
} else {
llms_add_notice( __( 'Your account information has been saved.', 'lifterlms' ), 'success' );
// Handle redirect.
llms_redirect_and_exit( apply_filters( 'lifterlms_update_account_redirect', llms_get_endpoint_url( 'edit-account', '', llms_get_page_url( 'myaccount' ) ) ) );
}
}
/**
* Handle form submission of the Lost Password form
*
* This is the form that sends a password recovery email with a link to reset the password.
*
* @since 3.8.0
* @since 3.9.5 Unknown.
* @since 3.35.0 Sanitize `$_POST` data.
* @since 3.37.17 Refactored for readability and added new hooks.
* @since 4.21.3 Increase 3rd party support for WP core hooks.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return null|WP_Error|true `null` when nonce cannot be verified.
* `WP_Error` when an error is encountered.
* `true` on success.
*/
public function lost_password() {
// Invalid nonce or the form wasn't submitted.
if ( ! isset( $_REQUEST['_lost_password_nonce'] ) ) {
return null;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_lost_password_nonce'] ) ), 'llms_lost_password' ) ) {
return null;
}
/**
* Fire an action immediately prior to the lost password form submission processing.
*
* @since 3.37.17
*/
do_action( 'llms_before_lost_password_form_submit' );
$err = new WP_Error();
$user = false;
$login = llms_filter_input_sanitize_string( INPUT_POST, 'llms_login' );
// Login is required.
if ( empty( $login ) ) {
$err->add( 'llms_pass_reset_missing_login', __( 'Enter a username or e-mail address.', 'lifterlms' ) );
} else {
// Locate the user.
$field = strpos( $login, '@' ) ? 'email' : 'login';
$user = get_user_by( $field, $login );
// No user found.
if ( ! $user ) {
$err->add( 'llms_pass_reset_invalid_login', __( 'Invalid username or e-mail address.', 'lifterlms' ) );
}
}
/**
* Ensure 3rd parties that don't use the 2nd param of `lostpassword_post` still work with our reset functionality.
*
* This specifically adds support for WordFence's "max allowed password resets" under brute force protection, but
* might be useful in other scenarios.
*/
$_POST['user_login'] = $login;
/**
* Fires before errors are returned from a password reset request.
*
* Mimics WordPress core behavior so 3rd parties don't need to add special handlers for LifterLMS
* password reset flows.
*
* @since 3.37.17
*
* @link https://developer.wordpress.org/reference/hooks/lostpassword_post/
*
* @param WP_Error $err A WP_Error object containing any errors generated by using invalid credentials.
* @param WP_User|false $user WP_User object if found, false if the user does not exist.
*/
do_action( 'lostpassword_post', $err, $user );
// If we have errors, output them and return.
if ( ! empty( $err->errors ) ) { // @todo: When we can drop support for WP 5.0 and earlier we can switch to $err->has_errors().
foreach ( $err->get_error_messages() as $message ) {
llms_add_notice( $message, 'error' );
}
return $err;
}
// Set the user's password reset key.
$key = get_password_reset_key( $user );
if ( is_wp_error( $key ) ) {
llms_add_notice( $key->get_error_message(), 'error' );
return $key;
}
// Setup the email.
$email = llms()->mailer()->get_email(
'reset_password',
array(
'key' => $key,
'user' => $user,
'login_display' => 'email' === $field ? $user->user_email : $user->user_login,
)
);
// Error generating or sending the email.
if ( ! $email || ! $email->send() ) {
$err->add( 'llms_pass_reset_email_failure', __( 'Unable to reset password due to an unknown error. Please try again.', 'lifterlms' ) );
llms_add_notice( $err->get_error_message(), 'error' );
return $err;
}
// Success.
llms_add_notice( __( 'Check your e-mail for the confirmation link.', 'lifterlms' ) );
return true;
}
/**
* Redeem a voucher from the "Redeem Voucher" endpoint of the student dashboard
*
* @since 4.12.0
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return null|true|WP_Error Returns `null` when the form hasn't been submitted, there's a nonce error, or there's no logged in user.
* Returns `true` on success and an error object when an error is encountered redeeming the voucher.
*/
public function redeem_voucher() {
if ( ! isset( $_REQUEST['lifterlms_voucher_nonce'] ) || ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['lifterlms_voucher_nonce'] ) ), 'lifterlms_voucher_check' ) || ! get_current_user_id() ) {
return null;
}
$voucher = new LLMS_Voucher();
$redeemed = $voucher->use_voucher( llms_filter_input_sanitize_string( INPUT_POST, 'llms_voucher_code' ), get_current_user_id() );
if ( is_wp_error( $redeemed ) ) {
llms_add_notice( $redeemed->get_error_message(), 'error' );
return $redeemed;
}
llms_add_notice( __( 'Voucher redeemed successfully!', 'lifterlms' ), 'success' );
return true;
}
/**
* Handle form submission of the Reset Password form
*
* This is the form that actually updates a users password.
*
* @since 3.8.0
* @since 3.35.0 Sanitize `$_POST` data.
* @since 3.37.17 Use WP core functions in favor of their (deprecated) LifterLMS clones.
* @since 4.21.0 Use `addslashes()` and `FILTER_UNSAFE_RAW` to mimic magic quotes behavior of the WP core reset flow.
* @since 5.0.0 Refactored to move reset logic into it's own method.
*
* @return null|WP_Error|true Returns `null` for nonce errors or when the form hasn't been submitted, an error object when
* errors are encountered, and `true` on success.
*/
public function reset_password() {
$result = $this->reset_password_handler();
if ( ! $result ) {
return null;
} elseif ( is_wp_error( $result ) ) {
llms_add_notice( implode( '<br>', $result->get_error_messages() ), 'error' );
return $result;
}
// Success.
llms_add_notice( __( 'Your password has been updated.', 'lifterlms' ) );
llms_redirect_and_exit( add_query_arg( 'password-reset', 1, llms_get_page_url( 'myaccount' ) ) );
}
/**
* Handle the submission of the password reset form.
*
* @since 5.0.0
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return null|WP_Error|true Returns `null` when the nonce can't be verified, on failure a `WP_Error` object, and `true` on success.
*/
private function reset_password_handler() {
// Invalid nonce or the form wasn't submitted.
if ( ! isset( $_REQUEST['_reset_password_nonce'] ) ) {
return null;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_reset_password_nonce'] ) ), 'llms_reset_password' ) ) {
return null;
}
/**
* Fire an action before the user password reset form is handled.
*
* @since 5.0.0
*/
do_action( 'llms_before_user_reset_password_submit' );
/**
* Add custom validations to the password reset form.
*
* @since 5.0.0
*
* @param WP_Error|true $valid Whether or not the submitted data is valid. Return `true` for valid data or a `WP_Error` when invalid.
*/
$valid = apply_filters( 'llms_validate_password_reset_form', $this->validate_password_reset( wp_unslash( $_POST ) ) );
if ( is_wp_error( $valid ) ) {
return $valid;
}
$login = llms_filter_input_sanitize_string( INPUT_POST, 'llms_reset_login' );
$key = llms_filter_input_sanitize_string( INPUT_POST, 'llms_reset_key' );
$user = check_password_reset_key( $key, $login );
if ( is_wp_error( $user ) ) {
// Error code is either "llms_password_reset_invalid_key" or "llms_password_reset_expired_key".
return new WP_Error( sprintf( 'llms_password_reset_%s', $user->get_error_code() ), __( 'This password reset key is invalid or has already been used. Please reset your password again if needed.', 'lifterlms' ) );
}
reset_password( $user, addslashes( llms_filter_input( INPUT_POST, 'password' ) ) );
/**
* Send the WP Core admin notification when a user's password is changed via the password reset form.
*
* @since 3.37.17
*
* @param bool $notify_admin If `true`, the admin will be notified.
* @param WP_User $user User object.
*/
$notify_admin = apply_filters( 'llms_password_reset_send_admin_notification', true, $user );
if ( $notify_admin ) {
wp_password_change_notification( $user );
}
/**
* Fire an action the the user's password is reset.
*
* @since 5.0.0
*
* @param WP_User $user User object.
*/
do_action( 'llms_user_password_reset', $user );
return true;
}
/**
* Automatically redirect password reset links to the password reset form page.
*
* Strips the `key` and `login` query string parameters and sets them in a cookie
* (which is accessed later to populate the hidden fields on the reset form) and then
* redirect to the password reset form.
*
* @since 5.0.0
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 6.6.0 Prevented client and server caching of the password reset form page.
*
* @return void
*/
public function reset_password_link_redirect() {
if ( is_llms_account_page() && isset( $_GET['key'] ) && isset( $_GET['login'] ) ) {
$user = get_user_by( 'login', wp_unslash( llms_filter_input_sanitize_string( INPUT_GET, 'login' ) ) );
$uid = $user ? $user->ID : 0;
$val = sprintf( '%1$d:%2$s', $uid, wp_unslash( llms_filter_input_sanitize_string( INPUT_GET, 'key' ) ) );
( new LLMS_Cache_Helper() )->maybe_no_cache();
llms_set_password_reset_cookie( $val );
llms_redirect_and_exit( add_query_arg( 'reset-pass', 1, wp_lostpassword_url() ) );
}
}
/**
* Validates the password reset form.
*
* @since 5.0.0
*
* @param array $posted_data User submitted data.
* @return WP_Error|true
*/
protected function validate_password_reset( $posted_data ) {
$err = new WP_Error();
$fields = LLMS_Person_Handler::get_password_reset_fields();
// Validate required fields.
foreach ( $fields as &$field ) {
$obj = new LLMS_Form_Field( $field );
$field = $obj->get_settings();
// Field is required, submittable, and wasn't posted.
if ( ! empty( $field['required'] ) && ! empty( $field['name'] ) && empty( $posted_data[ $field['name'] ] ) ) {
// Translators: %s = field label or id.
$msg = sprintf( __( '%s is a required field.', 'lifterlms' ), isset( $field['label'] ) ? $field['label'] : $field['name'] );
$err->add( 'llms-password-reset-missing-field', $msg );
}
}
if ( count( $err->errors ) ) {
return $err;
}
// If we have a password and password confirm and they don't match.
if ( isset( $posted_data['password'] ) && isset( $posted_data['password_confirm'] ) && $posted_data['password'] !== $posted_data['password_confirm'] ) {
$msg = __( 'The submitted passwords do must match.', 'lifterlms' );
$err->add( 'llms-passwords-must-match', $msg );
return $err;
}
return true;
}
}
return new LLMS_Controller_Account();
================================================
FILE: includes/forms/controllers/class.llms.controller.login.php
================================================
<?php
/**
* User Login Form Controller
*
* @package LifterLMS/Forms/Controllers/Classes
*
* @since 3.19.4
* @version 3.35.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Controller_Login
*
* @since 3.19.4
* @since 3.35.0 Sanitize `$_POST` data.
*/
class LLMS_Controller_Login {
/**
* Constructor
*
* @since 3.19.4
*
* @return void
*/
public function __construct() {
add_action( 'init', array( $this, 'login' ) );
}
/**
* Handle Login Form Submission
*
* @since 3.19.4
* @since 3.35.0 Sanitize `$_POST` data.
*
* @return void
*/
public function login() {
if ( ! isset( $_REQUEST['_llms_login_user_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_llms_login_user_nonce'] ) ), 'llms_login_user' ) ) {
return;
}
$login = LLMS_Person_Handler::login( $_POST );
// Validation or login issues.
if ( is_wp_error( $login ) ) {
foreach ( $login->get_error_messages() as $msg ) {
llms_add_notice( $msg, 'error' );
}
return;
}
$redirect = isset( $_POST['redirect'] ) ? llms_filter_input( INPUT_POST, 'redirect', FILTER_SANITIZE_URL ) : get_permalink( llms_get_page_id( 'myaccount' ) );
llms_redirect_and_exit( apply_filters( 'lifterlms_login_redirect', $redirect, $login ) );
}
}
return new LLMS_Controller_Login();
================================================
FILE: includes/forms/controllers/class.llms.controller.registration.php
================================================
<?php
/**
* User Registration Forms
*
* @package LifterLMS/Forms/Controllers/Classes
*
* @since 3.0.0
* @version 3.24.0
*/
defined( 'ABSPATH' ) || exit;
/**
* User Registration Forms (excludes checkout registration)
*
* @since 3.0.0
*/
class LLMS_Controller_Registration {
/**
* Constructor
*
* @since 3.0.0
*
* @return void
*/
public function __construct() {
add_action( 'init', array( $this, 'register' ) );
add_action( 'lifterlms_user_registered', array( $this, 'voucher' ), 10, 3 );
}
/**
* Attempt to redeem a voucher on user registration if a voucher was submitted during registration
*
* @since 3.0.0
* @since 3.19.4 Unknown.
*
* @param int $person_id WP_User ID of the newly registered user.
* @param array $data $_POST data.
* @param string $screen Screen user registered from [checkout|registration].
* @return void
*/
public function voucher( $person_id, $data, $screen ) {
if ( 'registration' === $screen && ! empty( $data['llms_voucher'] ) ) {
$voucher = new LLMS_Voucher();
$redeemed = $voucher->use_voucher( $data['llms_voucher'], $person_id );
if ( is_wp_error( $redeemed ) ) {
llms_add_notice( $redeemed->get_error_message(), 'error' );
}
}
}
/**
* Handle submission of user registration forms
*
* @since 3.0.0
* @since 3.24.0 Unknown.
*
* @return void
*/
public function register() {
if ( ! isset( $_REQUEST['_llms_register_person_nonce'] ) ) {
return;
}
if ( ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST['_llms_register_person_nonce'] ) ), 'llms_register_person' ) ) {
return;
}
/**
* Allow 3rd parties to perform their own validation prior to standard validation.
*
* If this returns a truthy, we'll stop processing.
*
* The extension should add a notice in addition to returning the truthy.
*
* @since 7.8.0
*
* @param boolean $valid Validation status. If `true` ceases registration execution. If `false` registration proceeds.
*/
if ( apply_filters( 'llms_before_registration_validation', false ) ) {
return false;
}
do_action( 'lifterlms_before_new_user_registration' );
// Already logged in can't register!
// This shouldn't happen but let's check anyway.
if ( get_current_user_id() ) {
return llms_add_notice( __( 'Already logged in! Please log out and try again.', 'lifterlms' ), 'error' );
}
$person_id = llms_register_user( $_POST, 'registration', true );
// Validation or registration issues.
if ( is_wp_error( $person_id ) ) {
foreach ( $person_id->get_error_messages() as $msg ) {
llms_add_notice( $msg, 'error' );
}
return;
} elseif ( ! is_numeric( $person_id ) ) {
// Catch unexpected returns from llms_register_user().
return llms_add_notice( __( 'An unknown error occurred when attempting to create an account, please try again.', 'lifterlms' ), 'error' );
} else {
// Handle redirect.
llms_redirect_and_exit( apply_filters( 'lifterlms_registration_redirect', llms_get_page_url( 'myaccount' ) ) );
}
}
}
return new LLMS_Controller_Registration();
================================================
FILE: includes/forms/controllers/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/forms/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/functions/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/functions/llms-functions-access-plans.php
================================================
<?php
/**
* Functions for LifterLMS Access Plans
*
* @package LifterLMS/Functions
*
* @since 3.29.0
* @version 7.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Create or update an access plan.
*
* If $props has an "ID" parameter, that plan will be updated, otherwise a new plan will be created.
*
* @see LLMS_Access_Plan
*
* @since 3.29.0
* @since 3.30.0 Added checkout redirect options.
* @since 3.30.3 Fixed spelling errors.
* @since 7.0.0 Correctly handle `$checkout_redirect_forced` property when updating.
*
* @param array $props {
* An array of of properties that make up the plan to create or update.
*
* @type int $product_id Required) WP Post ID of the related LifterLMS Product (course or membership).
* @type int $id WP Post ID of the Access Plan, if omitted a new plan is created, if supplied, that plan is updated.
* @type string $access_expiration Expiration type [lifetime|limited-period|limited-date].
* @type string $access_expires Date access expires in m/d/Y format. Only applicable when $access_expiration is "limited-date".
* @type int $access_length Length of access from time of purchase, combine with $access_period. Only applicable when $access_expiration is "limited-period".
* @type string $access_period Time period of access from time of purchase, combine with $access_length. Only applicable when $access_expiration is "limited-period" [year|month|week|day].
* @type string $availability Determine if this access plan is available to anyone or to members only. Use with $availability_restrictions to determine if the member can use the access plan. [open|members].
* @type array $availability_restrictions Indexed array of LifterLMS Membership IDs a user must belong to to use the access plan. Only applicable if $availability is "members".
* @type string $checkout_redirect_forced On a members' only access plan, whether to force redirect users back to the redirect settings specified in this access plan.
* @type string $checkout_redirect_type Type of checkout redirection [self|page|url].
* @type string $content Plan description (post_content).
* @type string $enroll_text Text to display on buy buttons.
* @type int $frequency Frequency of billing. 0 = a one-time payment [0-6].
* @type string $is_free Whether or not the plan requires payment [yes|no].
* @type int $length Number of intervals to run payment for, combine with $period & $frequency. 0 = forever / until cancelled. Only applicable if $frequency is not 0.
* @type int $menu_order Order to display access plans in when listing them. Displayed in ascending order.
* @type string $on_sale Enable or disable plan sale pricing [yes|no].
* @type string $period Interval period, combine with $length. Only applicable if $frequency is not 0. [year|month|week|day].
* @type float $price Price per charge/
* @type string $sale_end Date when the sale pricing ends.
* @type string $sale_start Date when the sale pricing begins.
* @type float $sale_price Sale price.
* @type string $sku Short user-created plan identifier.
* @type string $title Plan title.
* @type int $trial_length length of the trial period. Only applicable if $trial_offer is "yes".
* @type string $trial_offer Enable or disable a plan trial period. [yes|no].
* @type string $trial_period Period for the trial period. Only applicable if $trial_offer is "yes". [year|month|week|day].
* @type float $trial_price Price for the trial period. Can be 0 for a free trial period.
* }
* @return LLMS_Access_Plan|WP_Error `LLMS_Access_Plan` on success, `WP_Error` on failure.
*/
function llms_insert_access_plan( $props = array() ) {
$action = 'create';
if ( ! empty( $props['id'] ) ) {
$action = 'update';
$plan = llms_get_post( $props['id'] );
if ( ! $plan || ! is_a( $plan, 'LLMS_Access_Plan' ) ) {
// Translators: %s = The invalid access plan ID.
return new WP_Error( 'invalid-plan', sprintf( __( 'Access Plan ID "%s" is not valid.', 'lifterlms' ), $props['id'] ) );
}
unset( $props['id'] );
$plan_array = $plan->toArray();
/**
* The property 'checkout_redirect_forced' is not sent when the related checkbox is unchecked,
* so we have to avoid to override it with the saved value.
*
* {@see https://github.com/gocodebox/lifterlms/issues/2234}
*/
if ( ! isset( $props['checkout_redirect_forced'] ) ) {
unset( $plan_array['checkout_redirect_forced'] );
}
$props = wp_parse_args( $props, $plan );
}
// Merge in default properties.
$props = wp_parse_args(
$props,
apply_filters(
'llms_access_plan_default_properties',
array(
'access_expiration' => 'lifetime',
'access_length' => 1,
'access_period' => 'year',
'availability' => 'open',
'checkout_redirect_forced' => 'no',
'checkout_redirect_type' => 'self',
'frequency' => 0,
'is_free' => 'yes',
'length' => 0,
'on_sale' => 'no',
'period' => 'year',
'price' => 0,
'sale_price' => 0,
'title' => __( 'Access Plan', 'lifterlms' ),
'trial_length' => 1,
'trial_offer' => 'no',
'trial_period' => 'year',
'trial_price' => 0,
'visibility' => 'visible',
)
)
);
/**
* Modify the properties passed into `llms_insert_access_plan()`.
*
* Either `llms_access_plan_before_create` for new plans or `llms_access_plan_before_update` for updates.
*
* @since 3.29.0
*
* @param array $props Properties used to create/update the access plan.
*/
$props = apply_filters( 'llms_access_plan_before_' . $action, $props );
// Cannot create an access plan without a product.
if ( empty( $props['product_id'] ) || ! is_numeric( $props['product_id'] ) ) {
// Translators: %s = property key ('product_id').
return new WP_Error( 'missing-product-id', sprintf( __( 'Missing required property: "%s".', 'lifterlms' ), 'product_id' ) );
}
// Paid plan.
if ( $props['price'] > 0 ) {
$props['is_free'] = 'no';
// One-time (no trial).
if ( 0 === $props['frequency'] ) {
$props['trial_offer'] = 'no';
}
} else {
$props['is_free'] = 'yes';
$props['price'] = 0;
$props['frequency'] = 0;
$props['on_sale'] = 'no';
$props['trial_offer'] = 'no';
}
// Unset recurring props when it's a 1-time payment.
if ( 0 === $props['frequency'] ) {
unset( $props['length'], $props['period'] );
}
// Unset trial props when no trial enabled.
if ( ! llms_parse_bool( $props['trial_offer'] ) ) {
unset( $props['trial_price'], $props['trial_length'], $props['trial_period'] );
}
// Unset sale props when no sale enabled.
if ( ! llms_parse_bool( $props['on_sale'] ) ) {
unset( $props['sale_price'], $props['sale_end'], $props['sale_start'] );
}
// Unset expiration props based on expiration settings.
if ( 'lifetime' === $props['access_expiration'] ) {
unset( $props['access_expires'], $props['access_length'], $props['access_period'] );
} elseif ( 'limited-date' === $props['access_expiration'] ) {
unset( $props['access_length'], $props['access_period'] );
} elseif ( 'limited-period' === $props['access_expiration'] ) {
unset( $props['access_expires'] );
}
// Ensure visibility setting is valid.
if ( ! in_array( $props['visibility'], array_keys( llms_get_access_plan_visibility_options() ), true ) ) {
// Translators: %s = supplied visibility setting.
return new WP_Error( 'invalid-visibility', sprintf( __( 'Invalid access plan visibility: "%s"', 'lifterlms' ), $props['visibility'] ) );
}
// Ensure all periods are valid.
$valid_periods = array_keys( llms_get_access_plan_period_options() );
foreach ( array( 'period', 'access_period', 'trial_period' ) as $key ) {
if ( ! empty( $props[ $key ] ) && ! in_array( $props[ $key ], $valid_periods, true ) ) {
// Translators: %1$s = plan period key name; %2$s = the invalid period.
return new WP_Error( 'invalid-' . $key, sprintf( __( 'Invalid access plan %1$s: "%2$s"', 'lifterlms' ), $key, $props[ $key ] ) );
}
}
$checkout_redirect_type = $props['checkout_redirect_type'];
// Ensure that the checkout redirection type is valid.
if ( ! in_array( $checkout_redirect_type, array_keys( llms_get_checkout_redirection_types() ), true ) ) {
// Translators: %s = supplied checkout redirect type.
return new WP_Error( 'invalid-checkout-redirect-type', sprintf( __( 'Invalid checkout redirect type: "%s"', 'lifterlms' ), $checkout_redirect_type ) );
// Ensure that the correct checkout redirection value is set if the type is page.
} elseif ( 'page' === $checkout_redirect_type && empty( get_post( $props['checkout_redirect_page'] ) ) ) {
// Translators: %d = supplied checkout redirect page ID.
return new WP_Error( 'invalid-checkout-redirect-page', sprintf( __( 'Invalid checkout redirect page ID: "%d"', 'lifterlms' ), $props['checkout_redirect_page'] ) );
// Ensure that the correct checkout redirection value is set if the type is url.
} elseif ( 'url' === $checkout_redirect_type && ! filter_var( $props['checkout_redirect_url'], FILTER_VALIDATE_URL ) ) {
// Translators: %s = supplied checkout redirect page URL.
return new WP_Error( 'invalid-checkout-redirect-url', sprintf( __( 'Invalid checkout redirect URL: "%s"', 'lifterlms' ), $props['checkout_redirect_url'] ) );
}
if ( 'create' === $action ) {
$plan = new LLMS_Access_Plan( 'new' );
if ( ! $plan ) {
return new WP_Error( 'plan-creation', __( 'An error was encountered while creating the access plan', 'lifterlms' ) );
}
}
// Set visibility.
$plan->set_visibility( $props['visibility'] );
// Set all valid properties.
$valid_props = array_keys( $plan->get_properties() );
foreach ( $props as $prop_key => $prop_val ) {
if ( in_array( $prop_key, $valid_props, true ) ) {
$plan->set( $prop_key, $prop_val );
}
}
/**
* Do something with an access plan immediately after the access plan is created/updated.
*
* Either `llms_access_plan_after_create` during creation or `llms_access_plan_after_update` during an update.
*
* @since 3.29.0
*
* @param LLMS_Access_Plan $plan Access plan instance.
* @param array $props Properties used to create/update the access plan.
*/
do_action( 'llms_access_plan_after_' . $action, $plan, $props );
return $plan;
}
/**
* Retrieve available options for access plan periods
*
* @since 3.29.0
*
* @return array
*/
function llms_get_access_plan_period_options() {
return apply_filters(
'llms_get_access_plan_period_options',
array(
'year' => __( 'Year', 'lifterlms' ),
'month' => __( 'Month', 'lifterlms' ),
'week' => __( 'Week', 'lifterlms' ),
'day' => __( 'Day', 'lifterlms' ),
)
);
}
/**
* Get a list of available access plan visibility options
*
* @since 3.8.0
*
* @return array
*/
function llms_get_access_plan_visibility_options() {
return apply_filters(
'lifterlms_access_plan_visibility_options',
array(
'visible' => __( 'Visible', 'lifterlms' ),
'hidden' => __( 'Hidden', 'lifterlms' ),
'featured' => __( 'Featured', 'lifterlms' ),
)
);
}
================================================
FILE: includes/functions/llms-functions-conditional-tags.php
================================================
<?php
/**
* LifterLMS Conditional Tag Functions
*
* @package LifterLMS/Functions
*
* @since 3.37.0
* @version 3.37.0
*/
defined( 'ABSPATH' ) || exit;
if ( ! function_exists( 'is_course' ) ) {
/**
* Determine if a single course is being displayed.
*
* @since Unknown
*
* @return boolean
*/
function is_course() {
return is_singular( array( 'course' ) );
}
}
if ( ! function_exists( 'is_course_category' ) ) {
/**
* Determine if a course category archive page is being displayed.
*
* @since Unknown
*
* @param mixed $term Single or array of course category ID(s), name(s), or slug(s).
* @return boolean
*/
function is_course_category( $term = '' ) {
return is_tax( 'course_cat', $term );
}
}
if ( ! function_exists( 'is_course_tag' ) ) {
/**
* Determine if a course tag archive page is being displayed.
*
* @since 3.37.0
*
* @param mixed $term Single or array of course tag ID(s), name(s), or slug(s).
* @return boolean
*/
function is_course_tag( $term = '' ) {
return is_tax( 'course_tag', $term );
}
}
if ( ! function_exists( 'is_course_taxonomy' ) ) {
/**
* Determine if any course taxonomy archive page is being displayed.
*
* @since Unknown
*
* @return boolean
*/
function is_course_taxonomy() {
return is_tax( get_object_taxonomies( 'course' ) );
}
}
if ( ! function_exists( 'is_courses' ) ) {
/**
* Determine if the course catalog (post type archive) is being displayed.
*
* @since 1.4.4
* @since 3.0.0 Unknown.
* @since 3.37.0 Remove ternary.
*
* @return boolean
*/
function is_courses() {
return ( ( is_post_type_archive( 'course' ) ) || ( is_singular() && is_page( llms_get_page_id( 'courses' ) ) ) );
}
}
if ( ! function_exists( 'is_lesson' ) ) {
/**
* Determine if current post is a lifterLMS Lesson
*
* @since Unknown
* @since 3.37.0 Use `is_singular()` instead of comparing against global post's post type.
*
* @return boolean
*/
function is_lesson() {
return is_singular( array( 'lesson' ) );
}
}
if ( ! function_exists( 'is_lifterlms' ) ) {
/**
* Determine if a LifterLMS post type or post type archive is being displayed.
*
* @since Unknown.
*
* @return boolean
*/
function is_lifterlms() {
/**
* Modify the return of the is_lifterlms() conditional function.
*
* @since Unknown
* @since 3.37.0 Add check for `is_membership_taxonomy()`.
*
* @param boolean $is_lifterlms Default value.
*/
return apply_filters( 'is_lifterlms', ( is_course() || is_courses() || is_course_taxonomy() || is_lesson() || is_quiz() || is_membership() || is_memberships() || is_membership_taxonomy() ) );
}
}
if ( ! function_exists( 'is_llms_account_page' ) ) {
/**
* Determine if the LifterLMS Student Dashboard (account page) is being displayed.
*
* @since 1.4.6
* @since 3.37.0 Remove ternary condition.
*
* @return boolean
*/
function is_llms_account_page() {
/**
* Override the default return of `is_llms_account_page()`
*
* @since Unknown
*
* @param bool $override Default override value (false).
*/
return ( is_page( llms_get_page_id( 'myaccount' ) ) || apply_filters( 'lifterlms_is_account_page', false ) );
}
}
if ( ! function_exists( 'is_llms_checkout' ) ) {
/**
* Determine if the LifterLMS Checkout page is being displayed.
*
* @since 1.4.6
* @since 3.37.0 Remove ternary condition.
*
* @return boolean
*/
function is_llms_checkout() {
return is_page( llms_get_page_id( 'checkout' ) );
}
}
if ( ! function_exists( 'is_membership' ) ) {
/**
* Determine if a Membership is being displayed.
*
* @since 3.0.0
*
* @return bool
*/
function is_membership() {
return is_singular( array( 'llms_membership' ) );
}
}
if ( ! function_exists( 'is_membership_category' ) ) {
/**
* Determine if a membership category archive page is being displayed.
*
* @since 3.37.0
*
* @param mixed $term Single or array of membership category ID(s), name(s), or slug(s).
* @return boolean
*/
function is_membership_category( $term = '' ) {
return is_tax( 'membership_cat', $term );
}
}
if ( ! function_exists( 'is_membership_tag' ) ) {
/**
* Determine if a membership tag archive page is being displayed.
*
* @since 3.37.0
*
* @param mixed $term Single or array of membership tag ID(s), name(s), or slug(s).
* @return boolean
*/
function is_membership_tag( $term = '' ) {
return is_tax( 'membership_tag', $term );
}
}
if ( ! function_exists( 'is_membership_taxonomy' ) ) {
/**
* Determine if any course taxonomy archive page is being displayed.
*
* @since 3.22.0
*
* @return bool
*/
function is_membership_taxonomy() {
return is_tax( get_object_taxonomies( 'llms_membership' ) );
}
}
if ( ! function_exists( 'is_memberships' ) ) {
/**
* Determine if the membership catalog (post type archive) is being displayed.
*
* @since Unknown
* @since 3.37.0 Removed ternary condition.
*
* @return boolean
*/
function is_memberships() {
return ( is_post_type_archive( 'llms_membership' ) || ( is_singular() && is_page( llms_get_page_id( 'memberships' ) ) ) );
}
}
if ( ! function_exists( 'is_quiz' ) ) {
/**
* Determine if a single Quiz is being displayed.
*
* @since Unknown.
* @since 3.37.0 Use `is_singular()` instead of comparing against global post's post type.
*
* @return boolean
*/
function is_quiz() {
return is_singular( array( 'llms_quiz' ) );
}
}
================================================
FILE: includes/functions/llms-functions-content.php
================================================
<?php
/**
* (Post) Content functions
*
* @package LifterLMS/Functions
*
* @since 3.25.1
* @version 4.17.0
*/
defined( 'ABSPATH' ) || exit;
if ( ! function_exists( 'llms_get_post_content' ) ) {
/**
* Post Template Include
*
* Adds LifterLMS template content before and after the post's default content.
*
* @since 1.0.0
* @since 3.25.2 Unknown.
* @since 4.17.0 Refactored.
*
* @param string $content WP_Post post_content.
* @return string
*/
function llms_get_post_content( $content ) {
global $post;
if ( ! $post instanceof WP_Post ) {
return $content;
}
$restrictions = llms_page_restricted( $post->ID );
if ( in_array( $post->post_type, array( 'course', 'llms_membership', 'lesson', 'llms_quiz' ), true ) ) {
$post_type = str_replace( 'llms_', '', $post->post_type );
$template_before = 'single-' . $post_type . '-before';
$template_after = 'single-' . $post_type . '-after';
if ( $restrictions['is_restricted'] ) {
$content = llms_get_post_sales_page_content( $post, $content );
if ( in_array( $post->post_type, array( 'lesson', 'llms_quiz' ), true ) ) {
$content = '';
$template_before = 'no-access-before';
$template_after = 'no-access-after';
}
}
ob_start();
load_template( llms_get_template_part_contents( 'content', $template_before ), false );
$before = ob_get_clean();
ob_start();
load_template( llms_get_template_part_contents( 'content', $template_after ), false );
$after = ob_get_clean();
$content = do_shortcode( $before . $content . $after );
}
/**
* Filter the post_content of a LifterLMS post type.
*
* @since Unknown
*
* @param string $content Post content.
* @param WP_Post $post Post object.
* @param array $restrictions Result from `llms_page_restricted()` for the current post.
*/
return apply_filters( 'llms_get_post_content', $content, $post, $restrictions );
}
}
/**
* Retrieve the sales page content for a course or membership
*
* By default only courses and memberships support sales pages, the meta property
* must be set to `content` or an empty string, and the post must have a `post_excerpt`
* property value.
*
* @since 4.17.0
*
* @param WP_Post $post The post object.
* @param string $default Optional. Default content to use when no override content can be found.
* @return string
*/
function llms_get_post_sales_page_content( $post, $default = '' ) {
$content = $default;
if ( post_type_supports( $post->post_type, 'llms-sales-page' ) ) {
$sales_page = get_post_meta( $post->ID, '_llms_sales_page_content_type', true );
if ( $post->post_excerpt && ( '' === $sales_page || 'content' === $sales_page ) ) {
add_filter( 'the_excerpt', array( $GLOBALS['wp_embed'], 'autoembed' ), 9 );
$content = llms_get_excerpt( $post->ID );
}
}
/**
* Filters the HTML content of a LifterLMS post type's sales page content
*
* @since 4.17.0
*
* @param string $content HTML content of the sales page.
* @param WP_Post $content Post object.
* @param string $default Default content used when no override content can be found.
*/
return apply_filters( 'llms_post_sales_page_content', $content, $post, $default );
}
/**
* Initialize LifterLMS post type content filters
*
* This method is used to determine whether or `llms_get_post_content()` should automatically
* be added as a filter callback for the WP core `the_content` filter.
*
* When working with posts on the admin panel (during course building, importing) we don't want
* other plugins that may desire running `apply_filters( 'the_content', $content )` to apply our
* plugin's filters.
*
* @since 4.17.0
*
* @param callable $callback Optional. Callback function to be added as a callback for the filter `the_content`. Default 'llms_get_post_content'.
* @param integer $priority Optional. Priority used when adding the filter. Default: 10.
* @return boolean Returns `true` if content filters are added and `false` if not.
*/
function llms_post_content_init( $callback = 'llms_get_post_content', $priority = 10 ) {
// Don't filter post content on the admin panel.
$should_filter = ( false === is_admin() );
/**
* Filters whether or not LifterLMS content filters should be applied.
*
* @since 4.17.0
*
* @param boolean $should_filter Whether or not to filter the content.
* @param callable $callback Callback function to be added as a callback for the filter `the_content`.
*/
if ( apply_filters( 'llms_should_filter_post_content', $should_filter, $callback ) ) {
return add_filter( 'the_content', $callback, $priority );
}
return false;
}
llms_post_content_init();
================================================
FILE: includes/functions/llms-functions-deprecated.php
================================================
<?php
/**
* Deprecated Functions
*
* * * * * * * * * * * * * * * *
* sometimes a thing must *
* be set aflame for from that *
* black all new things come *
* * * * * * * * * * * * * * * *
*
* @package LifterLMS/Functions
*
* @since 3.29.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Add product-id to WP query variables
*
* @param array $vars [WP query variables]
* @return array $vars [WP query variables]
*
* @todo deprecate?
*/
function llms_add_query_var_product_id( $vars ) {
$vars[] = 'product-id';
return $vars;
}
add_filter( 'query_vars', 'llms_add_query_var_product_id' );
/**
* Sanitize text field
*
* @param string $var [raw text field input]
* @return string [clean string]
*
* @todo deprecate b/c sanitize_text_field() already exists....
*/
function llms_clean( $var ) {
return sanitize_text_field( $var );
}
/**
* Schedule expired membership cron
*
* @return void
*/
function llms_expire_membership_schedule() {
if ( ! wp_next_scheduled( 'llms_check_for_expired_memberships' ) ) {
wp_schedule_event( time(), 'daily', 'llms_check_for_expired_memberships' );
}
}
add_action( 'wp', 'llms_expire_membership_schedule' );
/**
* Expire Membership
*
* @return void
*/
function llms_expire_membership() {
global $wpdb;
// find all memberships wth an expiration date
$args = array(
'post_type' => 'llms_membership',
'posts_per_page' => 500,
'meta_query' => array(
'key' => '_llms_expiration_interval',
),
);
$posts = get_posts( $args );
if ( empty( $posts ) ) {
return;
}
foreach ( $posts as $post ) {
// make sure interval and period exist before continuing.
$interval = get_post_meta( $post->ID, '_llms_expiration_interval', true );
$period = get_post_meta( $post->ID, '_llms_expiration_period', true );
if ( empty( $interval ) || empty( $period ) ) {
continue;
}
// query postmeta table and find all users enrolled
$meta_key_status = '_status';
$meta_value_status = 'Enrolled';
$results = $wpdb->get_results(
$wpdb->prepare(
"SELECT * FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE post_id = %d AND meta_key = %s AND meta_value = %s ORDER BY updated_date DESC",
$post->ID,
$meta_key_status,
$meta_value_status
)
);
for ( $i = 0; $i < count( $results ); $i++ ) {
$results[ $results[ $i ]->post_id ] = $results[ $i ];
unset( $results[ $i ] );
}
$enrolled_users = $results;
foreach ( $enrolled_users as $user ) {
$user_id = $user->user_id;
$meta_key_start_date = '_start_date';
$meta_value_start_date = 'yes';
$start_date = $wpdb->get_results(
$wpdb->prepare(
"SELECT updated_date FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE user_id = %d AND post_id = %d AND meta_key = %s AND meta_value = %s ORDER BY updated_date DESC",
$user_id,
$post->ID,
$meta_key_start_date,
$meta_value_start_date
)
);
// add expiration terms to start date
$exp_date = date( 'Y-m-d', strtotime( date( 'Y-m-d', strtotime( $start_date[0]->updated_date ) ) . ' +' . $interval . ' ' . $period ) );
// get current datetime
$today = current_time( 'mysql' );
$today = date( 'Y-m-d', strtotime( $today ) );
// if a date parse causes exp date to be unmodified then return.
if ( $exp_date == $start_date[0]->updated_date ) {
LLMS_log( 'An error occurred modifying the date value. Function: llms_expire_membership, interval: ' . $interval . ' period: ' . $period );
continue;
}
// compare expiration date to current date.
if ( $exp_date < $today ) {
$set_user_expired = array(
'post_id' => $post->ID,
'user_id' => $user_id,
'meta_key' => '_status',
);
$status_update = array(
'meta_value' => 'Expired',
'updated_date' => current_time( 'mysql' ),
);
// change enrolled to expired in user_postmeta
$wpdb->update( $wpdb->prefix . 'lifterlms_user_postmeta', $status_update, $set_user_expired );
// remove membership id from usermeta array
$users_levels = get_user_meta( $user_id, '_llms_restricted_levels', true );
if ( in_array( $post->ID, $users_levels ) ) {
$key = array_search( $post->ID, $users_levels );
unset( $users_levels[ $key ] );
update_user_meta( $user_id, '_llms_restricted_levels', $users_levels );
}
}
}// End foreach().
}// End foreach().
}
add_action( 'llms_check_for_expired_memberships', 'llms_expire_membership' );
/**
* Retrieve the minimum accepted password strength for student passwords
*
* @since 3.0.0
* @deprecated 5.0.0 `llms_get_minimum_password_strength` is deprecated with no replacement.
*
* @return string
*/
function llms_get_minimum_password_strength() {
llms_deprecated_function( 'llms_get_minimum_password_strength', '5.0.0' );
return apply_filters( 'llms_get_minimum_password_strength', 'strong' );
}
/**
* Backwards compatibility for the deprecated earned engagement content meta keys.
*
* This public function is intentionally marked as private to denote it's temporary lifespan. This function
* will be removed in the next major release when the associated meta key is also fully removed.
*
* @since 6.0.0
*
* @access private
*
* @param string $val Default value (an empty string).
* @param LLMS_User_Certificate|LLMS_User_Achievement $obj User engagement object.
* @return string
*/
function llms_earned_engagement_deprecated_content( $val, $obj ) {
_llms_earned_engagement_deprecated_function( $obj, 'content', 'the WP_Post object property "post_content"' );
return $obj->get( 'content' );
}
/**
* Backwards compatibility for the deprecated earned engagement image meta keys.
*
* This public function is intentionally marked as private to denote it's temporary lifespan. This function
* will be removed in the next major release when the associated meta key is also fully removed.
*
* @since 6.0.0
*
* @access private
*
* @param string $val Default value (an empty string).
* @param LLMS_User_Certificate|LLMS_User_Achievement $obj User engagement object.
* @return int
*/
function llms_earned_engagement_deprecated_image( $val, $obj ) {
_llms_earned_engagement_deprecated_function( $obj, 'image', 'the WP_Post meta key "_thumbnail_id"' );
return get_post_thumbnail_id( $obj->get( 'id' ) );
}
/**
* Backwards compatibility for the deprecated earned engagement template meta keys.
*
* This public function is intentionally marked as private to denote it's temporary lifespan. This function
* will be removed in the next major release when the associated meta key is also fully removed.
*
* @since 6.0.0
*
* @access private
*
* @param string $val Default value (an empty string).
* @param LLMS_User_Certificate|LLMS_User_Achievement $obj User engagement object.
* @return string
*/
function llms_earned_engagement_deprecated_template( $val, $obj ) {
_llms_earned_engagement_deprecated_function( $obj, 'template', 'the WP_Post object property "post_parent"' );
return $obj->get( 'parent' );
}
/**
* Backwards compatibility for the deprecated earned engagement title meta keys.
*
* This public function is intentionally marked as private to denote it's temporary lifespan. This function
* will be removed in the next major release when the associated meta key is also fully removed.
*
* @since 6.0.0
*
* @access private
*
* @param string $val Default value (an empty string).
* @param LLMS_User_Certificate|LLMS_User_Achievement $obj User engagement object.
* @return string
*/
function llms_earned_engagement_deprecated_title( $val, $obj ) {
_llms_earned_engagement_deprecated_function( $obj, 'title', 'the WP_Post object property "post_title"' );
return $obj->get( 'title' );
}
/**
* Handle earned engagement deprecated meta keys.
*
* Throws a deprecation warning and replaces the default value with the new value.
*
* This public function is intentionally marked as private to denote it's temporary lifespan. This function
* will be removed in the next major release when the associated meta key is also fully removed.
*
* @since 6.0.0
*
* @access private
*
* @param string $val Meta value.
* @param int $obj_id Object ID.
* @param string $key Meta key.
* @return string
*/
function llms_engagement_handle_deprecated_meta_keys( $val, $obj_id, $key ) {
$deprecated = array(
'_llms_certificate_content' => 'llms_earned_engagement_deprecated_content',
'_llms_achievement_content' => 'llms_earned_engagement_deprecated_content',
'_llms_certificate_title' => 'llms_earned_engagement_deprecated_title',
'_llms_achievement_title' => 'llms_earned_engagement_deprecated_title',
'_llms_certificate_image' => 'llms_earned_engagement_deprecated_image',
'_llms_achievement_image' => 'llms_earned_engagement_deprecated_image',
'_llms_certificate_template' => 'llms_earned_engagement_deprecated_template',
'_llms_achievement_template' => 'llms_earned_engagement_deprecated_template',
);
if ( array_key_exists( $key, $deprecated ) ) {
$post_type = get_post_type( $obj_id );
if ( in_array( $post_type, array( 'llms_my_achievement', 'llms_my_certificate' ), true ) ) {
$class = 'LLMS_User_' . strtoupper( str_replace( 'llms_my_', '', $post_type ) );
return $deprecated[ $key ]( $val, new $class( $obj_id ) );
}
}
return $val;
}
add_filter( 'get_post_metadata', 'llms_engagement_handle_deprecated_meta_keys', 20, 3 );
/**
* Throw a deprecated function warning for earned engagement meta deprecations.
*
* This public function is intentionally marked as private to denote it's temporary lifespan. This function
* will be removed in the next major release when the associated meta key is also fully removed.
*
* @since 6.0.0
*
* @access private
*
* @param LLMS_User_Certificate|LLMS_User_Achievement $obj User engagement object.
* @param string $meta_key Deprecated meta key part (excluding the prefix and post type).
* @param string $replacement_msg The replacement message.
* @return void
*/
function _llms_earned_engagement_deprecated_function( $obj, $meta_key, $replacement_msg ) {
$classname = get_class( $obj );
$keyname = strtolower( str_replace( 'LLMS_User_', '', $classname ) ) . '_' . $meta_key;
_deprecated_function( esc_html( "{$classname} meta key '{$keyname}'" ), '6.0.0', wp_kses_post( $replacement_msg ) );
}
================================================
FILE: includes/functions/llms-functions-forms.php
================================================
<?php
/**
* Functions for LifterLMS Forms
*
* @package LifterLMS/Functions/Forms
*
* @since 5.0.0
* @version 7.1.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Generate the HTML for a form field
*
* This function is used during AJAX calls so needs to be in a core file
* loaded during AJAX calls!
*
* @since 3.0.0
* @since 3.19.4 Unknown.
* @since 5.0.0 Move from file: llms.functions.core.php.
* Utilize `LLMS_Form_Field` class for field generation and output.
*
* @param array $field Field settings.
* @param boolean $echo Optional. Whether or not to output (echo) the field HTML. Default is `true`.
* @param int|object $data_source Optional. Data source where to get field value from. Default is `null`.
* @return string
*/
function llms_form_field( $field = array(), $echo = true, $data_source = null ) {
$args = array( $field );
if ( ! is_null( $data_source ) ) {
$args[] = $data_source;
}
$field = new LLMS_Form_Field( ...$args );
if ( $echo ) {
$field->render();
}
return $field->get_html();
}
/**
* Retrieve the form post for a form at a given location.
*
* @since 5.0.0
*
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter in `LLMS_Forms->get_form_post()`.
* @return WP_Post|false
*/
function llms_get_form( $location, $args = array() ) {
return LLMS_Forms::instance()->get_form_post( $location, $args );
}
/**
* Retrieve the HTML for a form at the given location.
*
* @since 5.0.0
*
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter in `LLMS_Forms->get_form_post()`.
* @return string
*/
function llms_get_form_html( $location, $args = array() ) {
return LLMS_Forms::instance()->get_form_html( $location, $args );
}
/**
* Retrieve the title of a form at a given location.
*
* Returns an empty string if the form is disabled via form settings.
*
* @since 5.0.0
* @since 5.10.0 Return specific form title for checkout forms and free access plans.
* @since 7.1.3 Added 3rd missing `$post_id` parameter for the Post Title Filter.
*
* @param string $location Form location, one of: "checkout", "registration", or "account".
* @param array $args Additional arguments passed to the short-circuit filter in `LLMS_Forms->get_form_post()`.
* @return string
*/
function llms_get_form_title( $location, $args = array() ) {
$post = llms_get_form( $location, $args );
if ( ! $post || ! llms_parse_bool( get_post_meta( $post->ID, '_llms_form_show_title', true ) ) ) {
return '';
}
return 'checkout' === $location && isset( $args['plan'] ) && $args['plan']->is_free()
?
apply_filters( 'the_title', get_post_meta( $post->ID, '_llms_form_title_free_access_plans', true ), $post->ID )
:
get_the_title( $post->ID );
}
/**
* Displays a login form.
*
* Only displays the form for logged out users (because logged in users cannot login).
*
* @since 1.0.0
* @since 3.19.4 Unknown
* @since 5.0.0 Moved logic and filters for the $message, $redirect, and $layout parameters from the template into the function.
*
* @param string $message Optional. Messages to display before login form via llms_add_notice().
* @param string $redirect Optional. URL to redirect to after login. Defaults to current page url.
* @param string $layout Optional. Form layout. Accepts either 'columns' (default) or 'stacked'. Default is 'columns'.
* @return void
*/
if ( ! function_exists( 'llms_get_login_form' ) ) {
function llms_get_login_form( $message = null, $redirect = null, $layout = 'columns' ) {
/**
* Filters whether or not the login form should be displayed
*
* By default, the registration form is hidden from logged-in users and
* displayed to logged out users.
*
* @since 4.16.0
* @since 5.0.0 Moved from template `global/form-login.php`/.
*
* @param boolean $hide_form Whether or not to hide the form. If `true`, the form is hidden, otherwise it is displayed.
*/
if ( apply_filters( 'llms_hide_login_form', is_user_logged_in() ) ) {
return;
}
/**
* Customize the layout of the login form.
*
* @since Unknown
*
* @param string $layout Form layout. Accepts "columns" (default) for a side-by-side layout
* for form fields or "stacked" so fields sit on top of each other. Default is 'columns'.
*/
$layout = apply_filters( 'llms_login_form_layout', $layout );
if ( ! empty( $message ) ) {
llms_add_notice( $message, 'notice' );
}
$redirect = empty( $redirect ) ? get_permalink() : $redirect;
llms_get_template( 'global/form-login.php', compact( 'message', 'redirect', 'layout' ) );
}
}
================================================
FILE: includes/functions/llms-functions-l10n.php
================================================
<?php
/**
* Localization functions
*
* @package LifterLMS/Functions
*
* @since 4.9.0
* @version 4.9.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Retrieve the current plugin locale.
*
* @since 4.9.0
*
* @param string $domain Text domain.
* @return string
*/
function llms_get_locale( $domain = 'lifterlms' ) {
$locale = determine_locale();
/**
* Filter the plugin's locale
*
* @since Unknown
*
* @link https://developer.wordpress.org/reference/hooks/plugin_locale/
*
* @param string $locale The plugin's current locale.
* @param string $domain The textdomain.
*/
return apply_filters( 'plugin_locale', $locale, $domain );
}
function llms_l10n_get_safe_directory() {
/**
* Filter the LifterLMS language file "safe" directory.
*
* This safe directory exists to provide a place where custom translations can be placed
* which will not be automatically overridden by l10n files automatically pulled into
* the default language directory from the WP GlotPress server during plugin updates.
*
* By default the safe directory is `wp-content/languages/lifterlms`.
*
* @since 4.9.0
*
* @param string $path Full server path to the safe directory.
*/
return apply_filters( 'llms_l10n_safe_directory', WP_LANG_DIR . '/lifterlms' );
}
/**
* Load MO format localization files for the given text domain
*
* This function localizes using the WP Core's default language file directories as a after
* checking in the LifterLMS-defined "safe" directory.
*
* Language files files can be found in the following locations (The first loaded file takes priority):
*
* 1. wp-content/languages/{$domain}/{$domain}-{$locale}.mo
*
* This is recommended "safe" location where custom language files can be stored. A file
* stored in this directory will never be automatically overwritten.
*
* 2. wp-content/languages/plugins/{$domain}-{$locale}.mo
*
* This is the default directory where WordPress will download language files from the
* WordPress GlotPress server during updates. If you store a custom language file in this
* directory it will be overwritten during updates.
*
* 3. wp-content/plugins/{$domain}/languages/{$domain}-{$locale}.mo
*
* This is the the LifterLMS plugin directory. A language file stored in this directory will
* be removed from the server during a LifterLMS plugin update.
*
* @since 4.9.0
*
* @param string $domain Textdomain being loaded.
* @param string|null $plugin_dir Full path to the plugin directory, if none supplied `LLMS_PLUGIN_DIR` is used.
* @param string|null $language_dir Relative path to the language directory within the plugin. If none supplied, `languages` is used.
* @return void
*/
function llms_load_textdomain( $domain, $plugin_dir = null, $language_dir = null ) {
$plugin_dir = $plugin_dir ? $plugin_dir : LLMS_PLUGIN_DIR;
$language_dir = $language_dir ? $language_dir : 'languages';
/**
* Load from the custom LifterLMS "safe" directory (if it exists).
*
* Example path: wp-content/languages/lifterlms/lifterlms-en_US.mo
*/
load_textdomain( $domain, sprintf( '%1$s/%2$s-%3$s.mo', llms_l10n_get_safe_directory(), $domain, llms_get_locale( $domain ) ) );
/**
* Load from default plugin locations specified by the WP core.
*
* 1. wp-content/languages/plugins/lifterlms-en_US.mo
* 2. wp-content/plugins/lifterlms/languages/lifterlms-en_US.mo
*/
load_plugin_textdomain( $domain, false, sprintf( '%1$s/%2$s', basename( $plugin_dir ), $language_dir ) );
}
/**
* Retrieve the current permalink structure. If no structure is set, the default structure is returned.
*
* Note: this should be called on install or update of LifterLMS at a time when the site language is known and set.
*
* @since 7.6.0
*
* @return array
*/
function llms_get_permalink_structure() {
$saved_permalinks = (array) get_option( 'llms_permalinks', array() );
$permalinks = wp_parse_args(
// Remove false or empty entries so we can use the default values.
array_filter( $saved_permalinks ),
array(
'course_base' => _x( 'course', 'course url slug', 'lifterlms' ),
'courses_base' => _x( 'courses', 'course archive url slug', 'lifterlms' ),
'memberships_base' => _x( 'memberships', 'membership archive url slug', 'lifterlms' ),
'lesson_base' => _x( 'lesson', 'lesson url slug', 'lifterlms' ),
'quiz_base' => _x( 'quiz', 'quiz url slug', 'lifterlms' ),
'certificate_template_base' => _x( 'certificate-template', 'slug', 'lifterlms' ),
'certificate_base' => _x( 'certificate', 'slug', 'lifterlms' ),
'course_category_base' => _x( 'course-category', 'slug', 'lifterlms' ),
'course_tag_base' => _x( 'course-tag', 'slug', 'lifterlms' ),
'course_track_base' => _x( 'course-track', 'slug', 'lifterlms' ),
'course_difficulty_base' => _x( 'course-difficulty', 'slug', 'lifterlms' ),
'membership_category_base' => _x( 'membership-category', 'slug', 'lifterlms' ),
'membership_tag_base' => _x( 'membership-tag', 'slug', 'lifterlms' ),
)
);
array_filter( $permalinks, 'untrailingslashit' );
if ( $saved_permalinks !== $permalinks ) {
update_option( 'llms_permalinks', $permalinks );
}
return $permalinks;
}
/**
* Set the permalink structure and only allow keys we know about.
*
* @since 7.6.0
*
* @param array $permalinks
*
* @return void
*/
function llms_set_permalink_structure( $permalinks ) {
$defaults = llms_get_permalink_structure();
$permalinks = wp_parse_args(
// Only allow values whose keys are in the defaults array.
array_intersect_key( $permalinks, $defaults ),
$defaults
);
array_filter( $permalinks, 'untrailingslashit' );
update_option( 'llms_permalinks', $permalinks );
}
/**
* Switch LifterLMS language to site language.
*
* @param string $textdomain Text domain. Defaults to lifterlms.
* @param string $plugin_dir Plugin directory. Defaults to null.
* @param string $language_dir Language directory. Defaults to null.
*
* @since 7.6.0
*/
function llms_switch_to_site_locale( $textdomain = 'lifterlms', $plugin_dir = null, $language_dir = null ) {
global $wp_locale_switcher;
if ( function_exists( 'switch_to_locale' ) && isset( $wp_locale_switcher ) ) {
switch_to_locale( get_locale() );
// Filter on plugin_locale so load_plugin_textdomain loads the correct locale.
add_filter( 'plugin_locale', 'get_locale' );
llms_load_textdomain( $textdomain, $plugin_dir, $language_dir );
}
}
/**
* Switch LifterLMS language to original.
*
* @param string $textdomain Text domain. Defaults to lifterlms.
* @param string $plugin_dir Plugin directory. Defaults to null.
* @param string $language_dir Language directory. Defaults to null.
*
* @since 7.6.0
*/
function llms_restore_locale( $textdomain = 'lifterlms', $plugin_dir = null, $language_dir = null ) {
global $wp_locale_switcher;
if ( function_exists( 'restore_previous_locale' ) && isset( $wp_locale_switcher ) ) {
restore_previous_locale();
remove_filter( 'plugin_locale', 'get_locale' );
llms_load_textdomain( $textdomain, $plugin_dir, $language_dir );
}
}
================================================
FILE: includes/functions/llms-functions-locale.php
================================================
<?php
/**
* Localization functions.
*
* @package LifterLMS/Functions/Locales
*
* @since 5.0.0
* @version 5.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Get countries address formatting and l10n information.
*
* Provides a list of language and address information for supported countries.
*
* @since 5.0.0
*
* @see languages/countries-address-info.php
*
* @return array
*/
function llms_get_countries_address_info() {
$info = require LLMS_PLUGIN_DIR . 'languages/countries-address-info.php';
/**
* Modify the default states list.
*
* @since 5.0.0
*
* @param array $info Multi-dimensional array. See "languages/address-countries-address-info.php" for details.
*/
return apply_filters( 'llms_countries_address_info', $info );
}
/**
* Retrieve locale information for a specific country
*
* @since 5.0.0
*
* @param string $code Country code.
* @return array
*/
function llms_get_country_address_info( $code ) {
$all = llms_get_countries_address_info();
return isset( $all[ $code ] ) ? $all[ $code ] : array();
}
/**
* Retrieve the country name by country code
*
* @since 3.8.0
*
* @param string $code Country code.
* @return string
*/
function llms_get_country_name( $code ) {
$countries = get_lifterlms_countries();
return isset( $countries[ $code ] ) ? $countries[ $code ] : $code;
}
/**
* Retrieve a list of states for a given country.
*
* @since 5.0.0
*
* @param string $code Country code.
* @return array
*/
function llms_get_country_states( $code ) {
$all = llms_get_states();
return isset( $all[ $code ] ) ? $all[ $code ] : array();
}
/**
* Retrieve a list of states organized by country.
*
* @since 5.0.0
*
* @see languages/states.php
*
* @return array
*/
function llms_get_states() {
$states = require LLMS_PLUGIN_DIR . 'languages/states.php';
/**
* Modify the default states list.
*
* @since 1.0.0
*
* @param array $states Multi-dimensional array. See "languages/states.php" for details.
*/
return apply_filters( 'lifterlms_states', $states );
}
/**
* Retrieve the translated (and optionally pluralized) name for a given time period string
*
* This is used primarily to display time period data which is stored directly in the database. When displaying
* to a user, we wish to ensure that the translated version is displayed instead of the raw and untranslated value
* stored in the database.
*
* @since 5.3.0
*
* @param string $period A time period string, accepts "day", "week", "month", or "year".
* @param integer $length The length of the period, passed to `_n()` and used for pluralization. Defaults to `1`.
* @return string The translated and pluralized time period string. Returns the submitted string for unsupported strings.
*/
function llms_get_time_period_l10n( $period, $length = 1 ) {
switch ( strtolower( $period ) ) {
case 'day':
$period = _n( 'day', 'days', $length, 'lifterlms' );
break;
case 'week':
$period = _n( 'week', 'weeks', $length, 'lifterlms' );
break;
case 'month':
$period = _n( 'month', 'months', $length, 'lifterlms' );
break;
case 'year':
$period = _n( 'year', 'years', $length, 'lifterlms' );
break;
}
/**
* Filter the translated name for a given time period string.
*
* @since 5.3.0
*
* @param string $period Translated period name.
* @param int $length Period length, used for pluralization.
*/
return apply_filters( 'llms_time_period_l10n', $period, $length );
}
/**
* Get Countries array for Select list
*
* @since 1.0.0
* @since 3.28.2 Updated country list.
* @since 5.0.0 Moved from llms.functions.currency.php.
* Use country list stored in file at languages/countries.php.
*
* @return array
*/
function get_lifterlms_countries() {
$countries = require LLMS_PLUGIN_DIR . 'languages/countries.php';
/**
* Modify the default countries list.
*
* @since 1.0.0
*
* @param array $countries Associative array of Country Code => Country Name.
*/
$countries = apply_filters( 'lifterlms_countries', $countries );
return array_unique( $countries );
}
/**
* Get the default LifterLMS country as configured in site settings.
*
* @since 3.0.0
* @since 5.0.0 Moved from llms.functions.currency.php.
*
* @return string Country code.
*/
function get_lifterlms_country() {
return apply_filters( 'lifterlms_country', get_option( 'lifterlms_country', 'US' ) );
}
================================================
FILE: includes/functions/llms-functions-options.php
================================================
<?php
/**
* Option/Settings related functions
*
* @package LifterLMS/Functions
*
* @since 3.29.0
* @version 7.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Retrieve a "secure" option.
*
* Checks environment variables and then constant definitions
*
* @since 3.29.0
*
* @param string $secure_name Name of the option variable / constant.
* @param mixed $default Optional default value used as a fallback.
* @param string $db_name Optional option name to fallback on if no constant or environment var is found.
* @return mixed
*/
function llms_get_secure_option( $secure_name, $default = false, $db_name = '' ) {
// Try an environment variable first.
$val = getenv( $secure_name );
if ( false !== $val ) {
return $val;
}
// Try a constant.
if ( defined( $secure_name ) ) {
return constant( $secure_name );
}
if ( $db_name ) {
return get_option( $db_name, $default );
}
// Return the default value.
return $default;
}
/**
* Determines if the given option name is stored in a "secure" manner, i.e. an environment variable or a constant.
*
* @since 7.0.0
*
* @param string $secure_name The name of the possibly secure option.
* @return bool Returns `true` if the option is defined in an environment variable or a constant, else `false`.
*/
function llms_is_option_secure( $secure_name ) {
// Sanity check for empty strings to prevent `getenv()` from returning ALL variables.
if ( '' === $secure_name ) {
return false;
}
/*
* Note: Do not store `false` values in an environment variable
* because `getenv()` returns `false` if the variable is not set.
*/
if ( false !== getenv( $secure_name ) ) {
return true;
}
return defined( $secure_name );
}
================================================
FILE: includes/functions/llms-functions-progression.php
================================================
<?php
/**
* Course / Lesson progression functions
*
* @package LifterLMS/Functions
*
* @since 3.29.0
* @version 3.29.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Determine if lesson completion is allowed for a given user & lesson
*
* @param int $user_id WP User ID.
* @param int $lesson_id WP Post ID of a lesson.
* @param string $trigger Optional trigger description string.
* @param array $args Optional arguments.
* @return boolean
* @since 3.29.0
* @version 3.29.0
*/
function llms_allow_lesson_completion( $user_id, $lesson_id, $trigger = '', $args = array() ) {
/**
* @filter llms_allow_lesson_completion
* @since 3.17.1
* @version 3.17.1
*/
return apply_filters( 'llms_allow_lesson_completion', true, $user_id, $lesson_id, $trigger, $args );
}
/**
* Determines whether or not a "Mark Complete" button should be displayed for a given lesson
*
* If the lesson has a quiz, the button will only be shown if the current user has
* already met the quiz requirements (passed the quiz, or completed at least one attempt
* if passing is not required).
*
* @since 3.29.0
* @since 10.0.0 Show button when quiz requirements are already met. Fixes issue #3058.
*
* @param LLMS_Lesson $lesson LLMS_Lesson instance.
* @return boolean
*/
function llms_show_mark_complete_button( $lesson ) {
$show = true;
// If a quiz button should be shown, check if user already met quiz requirements.
if ( llms_show_take_quiz_button( $lesson ) ) {
$show = false;
// Check if current user has already met quiz requirements.
$user_id = get_current_user_id();
if ( $user_id && $lesson->is_quiz_enabled() ) {
$student = llms_get_student( $user_id );
if ( $student ) {
$quiz_id = $lesson->get( 'quiz' );
$attempt = $student->quizzes()->get_best_attempt( $quiz_id );
if ( $attempt ) {
$passing_required = llms_parse_bool( $lesson->get( 'require_passing_grade' ) );
// Show button if: passing not required, OR attempt is passing.
if ( ! $passing_required || $attempt->is_passing() ) {
$show = true;
}
}
}
}
}
return apply_filters( 'llms_show_mark_complete_button', $show, $lesson );
}
/**
* Determines whether or not a "Take Quiz" button should be displayed for a given lesson.
*
* @param obj $lesson LLMS_Lesson.
* @return boolean
* @since 3.29.0
* @version 3.29.0
*/
function llms_show_take_quiz_button( $lesson ) {
// If a lesson has a quiz, show the button, otherwise don't.
$show = $lesson->has_quiz();
// if the lesson has a quiz make sure we can show the button to the current user.
if ( $show ) {
$quiz_id = $lesson->get( 'quiz' );
// if the quiz isn't published and the current user can't edit the quiz don't show the button.
if ( 'publish' !== get_post_status( $quiz_id ) && ! current_user_can( 'edit_post', $quiz_id ) ) {
$show = false;
}
}
// allow 3rd parties to modify default behavior.
return apply_filters( 'llms_show_take_quiz_button', $show, $lesson );
}
================================================
FILE: includes/functions/llms-functions-template-view-order.php
================================================
<?php
/**
* Order view template functions.
*
* @package LifterLMS/Functions
*
* @since 6.0.0
* @version 6.0.0
*/
if ( ! function_exists( 'llms_template_view_order' ) ) {
/**
* Loads the template for a single order view on the student dashboard.
*
* @since 6.0.0
*
* @param LLMS_Order $order The order to display.
* @return void
*/
function llms_template_view_order( $order ) {
// Validate order object and only allow the order's user to view the order.
if ( ! $order instanceof LLMS_Order || get_current_user_id() !== $order->get( 'user_id' ) ) {
esc_html_e( 'Invalid Order.', 'lifterlms' );
return;
}
/**
* Allows customization of the view order layout on the student dashboard.
*
* @since 6.0.0
*
* @param boolean $use_stacked_layout If `true`, forces usage of the stacked layout instead of the default side-by-side layout.
* @param LLMS_Order $order The order to display.
*/
$layout_class = apply_filters( 'llms_sd_stacked_order_layout', false, $order ) ? 'llms-stack-cols' : '';
$transactions = _llms_template_view_order_get_transactions( $order );
llms_get_template( 'myaccount/view-order.php', compact( 'order', 'transactions', 'layout_class' ) );
}
}
if ( ! function_exists( 'llms_template_view_order_actions' ) ) {
/**
* Loads the single order view actions sidebar on the student dashboard.
*
* @since 6.0.0
*
* @param LLMS_Order $order The order to display.
* @return void
*/
function llms_template_view_order_actions( $order ) {
llms_get_template( 'myaccount/view-order-actions.php', compact( 'order' ) );
}
}
if ( ! function_exists( 'llms_template_view_order_information' ) ) {
/**
* Loads the single order view information main area on the student dashboard.
*
* @since 6.0.0
*
* @param LLMS_Order $order The order to display.
* @return void
*/
function llms_template_view_order_information( $order ) {
$gateway = $order->get_gateway();
llms_get_template( 'myaccount/view-order-information.php', compact( 'order', 'gateway' ) );
}
}
if ( ! function_exists( 'llms_template_view_order_transactions' ) ) {
/**
* Loads the single order view transactions table on the student dashboard.
*
* @since 6.0.0
*
* @param LLMS_Order $order The order to display.
* @param array $transactions Result array from LLMS_Order::get_transactions(). If null, will load transactions from the order.
* @param integer $per_page Number of results to display per page. Only used if `$transactions` is `null`.
* @param integer $page Current results page to display. Only used if `$transactions` is `null`.
* @return void
*/
function llms_template_view_order_transactions( $order, $transactions = null, $per_page = 20, $page = null ) {
if ( is_null( $transactions ) ) {
$transactions = _llms_template_view_order_get_transactions( $order, $per_page, $page );
}
if ( empty( $transactions['transactions'] ) ) {
return;
}
llms_get_template( 'myaccount/view-order-transactions.php', compact( 'transactions' ) );
}
}
/**
* Loads transactions for the given order.
*
* @since 6.0.0
*
* @access private
*
* @param LLMS_order $order Order object.
* @param integer $per_page Transactions to display per page.
* @param null|integer $page Results page.
* @return array Results from LLMS_Order::get_transactions().
*/
function _llms_template_view_order_get_transactions( $order, $per_page = 20, $page = null ) {
$page = is_null( $page ) ? absint( llms_filter_input( INPUT_GET, 'txnpage', FILTER_SANITIZE_NUMBER_INT ) ) : $page;
return $order->get_transactions(
array(
/**
* Filters the number of transactions displayed on each page when viewing order details.
*
* @since Unknown
*
* @param integer $per_page Number of orders per page. Default: `20`.
*/
'per_page' => apply_filters( 'llms_student_dashboard_transactions_per_page', $per_page ),
'paged' => $page ? $page : 1,
)
);
}
================================================
FILE: includes/functions/llms-functions-templates-courses.php
================================================
<?php
/**
* Course template functions
*
* @package LifterLMS/Functions
*
* @since 4.11.0
* @version 4.11.0
*/
defined( 'ABSPATH' ) || exit;
if ( ! function_exists( 'lifterlms_template_course_author' ) ) {
/**
* Get single post author template
*
* @since Unknown
*
* @return void
*/
function lifterlms_template_course_author() {
llms_get_template( 'course/author.php' );
}
}
================================================
FILE: includes/functions/llms-functions-templates-memberships.php
================================================
<?php
/**
* Membership template functions
*
* @package LifterLMS/Functions
*
* @since 4.11.0
* @version 4.11.0
*/
defined( 'ABSPATH' ) || exit;
if ( ! function_exists( 'llms_template_membership_instructors' ) ) {
/**
* Get single membership instructors template
*
* @since 4.11.0
*
* @return void
*/
function llms_template_membership_instructors() {
llms_get_template( 'membership/instructors.php' );
}
}
================================================
FILE: includes/functions/llms-functions-templates-shared.php
================================================
<?php
/**
* Shared template functions
*
* A "shared" function is any function used by more than one post type.
*
* @package LifterLMS/Functions
*
* @since 4.11.0
* @version 4.11.0
*/
defined( 'ABSPATH' ) || exit;
if ( ! function_exists( 'llms_template_instructors' ) ) {
/**
* Get single post instructors template
*
* Used by courses and membership.
*
* @since 4.11.0
*
* @return void
*/
function llms_template_instructors() {
$llms_post = llms_get_post( get_the_ID() );
if ( ! $llms_post || ! $llms_post instanceof LLMS_Post_Model || ! $llms_post instanceof LLMS_Interface_Post_Instructors ) {
return;
}
$instructors = $llms_post->get_instructors( true );
if ( ! $instructors ) {
return;
}
$count = count( $instructors );
llms_get_template( 'shared/instructors.php', compact( 'llms_post', 'instructors', 'count' ) );
}
}
================================================
FILE: includes/functions/llms-functions-user-information-fields.php
================================================
<?php
/**
* Functions for LifterLMS user information fields
*
* @package LifterLMS/Functions
*
* @since 5.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Retrieve a single user information field by its ID attribute.
*
* @since 5.0.0
*
* @param string $name The field's name.
* @return array|boolean Returns the field settings array or `false` when the field cannot be found.
*/
function llms_get_user_information_field( $name ) {
$fields = llms_get_user_information_fields();
$field_index = array_search( $name, array_column( $fields, 'name' ), true );
return false === $field_index ? false : $fields[ $field_index ];
}
/**
* Retrieve the filtered user information field schema
*
* @since 5.0.0
*
* @return array[] A list of LLMS_Form_Field settings arrays.
*/
function llms_get_user_information_fields() {
$fields = require LLMS_PLUGIN_DIR . 'includes/schemas/llms-user-information-fields.php';
/**
* Filters the user information fields schema
*
* Custom fields can be added, removed, and modified using this filter. Please note that
* LifterLMS relies on these fields so removal or modification of attributes (like `name`,
* `id`, and `data_store*`) may cause LifterLMS to break in unexpected ways.
*
* @since 5.0.0
*
* @param array[] $fields List of field definitions.
*/
return apply_filters( 'llms_user_information_fields', $fields );
}
/**
* Retrieve user information fields used by the block editor
*
* This is used for JS localization purposes and returns a reduced set of data as used by
* the editor for validation purposes.
*
* @since 5.0.0
*
* @return array[]
*/
function llms_get_user_information_fields_for_editor() {
$fields = llms_get_user_information_fields();
/**
* Filters the list of keys included for user information fields when localized into the block editor
*
* @since 5.0.0
*
* @param string[] $keys Array of key names.
*/
$keys = apply_filters(
'llms_get_user_information_fields_for_editor_keys',
array(
'id',
'name',
'label',
'data_store',
'data_store_key',
)
);
// Add a value so we can use array_interect_key() later.
$keys = array_fill_keys( $keys, 1 );
// Return a reduced list.
return array_map(
function ( $field ) use ( $keys ) {
return array_intersect_key( $field, $keys );
},
$fields
);
}
/**
* Add [llms-user] shortcodes to email and certificate template editor instances.
*
* This is a callback function for the `llms_merge_codes_for_button` filter.
*
* @since 6.0.0
*
* @access private
*
* @see llms_merge_codes_for_button
*
* @param array[] $codes Associative array of merge codes where the array key is the merge code and the array value is a name / description of the merge code.
* @param WP_Screen|null $screen The screen object from `get_current_screen().
* @return array[]
*/
function _llms_add_user_info_to_merge_buttons( $codes, $screen ) {
if ( $screen && ! empty( $screen->post_type ) && in_array( $screen->post_type, array( 'llms_certificate', 'llms_email' ), true ) ) {
foreach ( llms_get_user_information_fields_for_editor() as $field ) {
if ( 'password' === $field['id'] ) {
continue;
}
if ( 'llms_billing_address_2' === $field['id'] ) {
$field['label'] = __( 'Address Line 2', 'lifterlms' );
}
$shortcode = "[llms-user {$field['data_store_key']}]";
$codes[ $shortcode ] = $field['label'];
}
}
return $codes;
}
add_filter( 'llms_merge_codes_for_button', '_llms_add_user_info_to_merge_buttons', 10, 2 );
================================================
FILE: includes/functions/llms-functions-wrappers.php
================================================
<?php
/**
* Functions that wrap native PHP or WordPress core functions
*
* Most of these are pluggable primarily to allow easier testing when
* running phpunit.
*
* @package LifterLMS/Functions
*
* @since 5.3.0
* @version 7.4.0
*/
defined( 'ABSPATH' ) || exit;
if ( ! function_exists( 'llms_current_time' ) ) {
/**
* Retrieve the current time based on specified type.
*
* This is a wrapper for the WP Core current_time which can be plugged
* We plug this during unit testing to allow mocking the current time.
*
* The 'mysql' type will return the time in the format for MySQL DATETIME field.
* The 'timestamp' type will return the current timestamp.
* Other strings will be interpreted as PHP date formats (e.g. 'Y-m-d').
*
* If $gmt is set to either '1' or 'true', then both types will use GMT time.
* if $gmt is false, the output is adjusted with the GMT offset in the WordPress option.
*
* @since 3.4.0
* @since 5.3.0 Moved location from `includes/llms.functions.core.php`.
*
* @link https://developer.wordpress.org/reference/functions/current_time/
* @link https://github.com/gocodebox/lifterlms-tests/blob/472c5a286e9f65e2be0c1d6b7edd8d5340d052ed/framework/functions-llms-tests.php#L2-L26
*
* @param string $type Type of time to retrieve. Accepts 'mysql', 'timestamp', or PHP date format string (e.g. 'Y-m-d').
* @param int|bool $gmt Optional. Whether to use GMT timezone. Default false.
* @return int|string Integer if $type is 'timestamp', string otherwise.
*/
function llms_current_time( $type, $gmt = 0 ) {
return current_time( $type, $gmt );
}
}
if ( ! function_exists( 'llms_exit' ) ) {
/**
* Native php exit() wrapper
*
* This wrapper exists primarily to allow easy testing of code that calls exit().
*
* @since 5.3.0
*
* @link https://www.php.net/manual/en/function.exit.php
* @link https://github.com/gocodebox/lifterlms-tests/blob/472c5a286e9f65e2be0c1d6b7edd8d5340d052ed/framework/functions-llms-tests.php#L164-L176
*
* @param int|string $status Exit status passed to `exit()`.
* @return void
*/
function llms_exit( $status = null ) {
if ( is_null( $status ) ) {
exit();
}
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
exit( $status );
}
}
if ( ! function_exists( 'llms_filter_input' ) ) {
/**
* Gets a specific external variable by name and optionally filters it
*
* This is a pluggable wrapper around native `filter_input` which is plugged in the testing framework
* to allow easy mocking of form variables when testing form controller functions and methods.
*
* @since 3.29.0
* @since 5.3.0 Moved location from `includes/llms.functions.core.php`.
*
* @link https://www.php.net/manual/en/function.filter-input.php
* @link https://github.com/gocodebox/lifterlms-tests/blob/472c5a286e9f65e2be0c1d6b7edd8d5340d052ed/framework/functions-llms-tests.php#L113-L162
*
* @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, or INPUT_ENV.
* @param string $variable_name Name of a variable to get.
* @param int $filter Optional. The ID of the filter to apply. Default is `FILTER_DEFAULT`.
* @param mixed $options Optional. Associative array of options or bitwise disjunction of flags. Default is empty array.
* If filter accepts options, flags can be provided in "flags" field of array.
* @return mixed Value of the requested variable on success, FALSE if the filter fails, or NULL if
* the variable_name variable is not set. If the flag FILTER_NULL_ON_FAILURE is used,
* it returns FALSE if the variable is not set and NULL if the filter fails.
*/
function llms_filter_input( $type, $variable_name, $filter = FILTER_DEFAULT, $options = array() ) {
return filter_input( $type, $variable_name, $filter, $options );
}
}
if ( ! function_exists( 'llms_redirect_and_exit' ) ) {
/**
* Redirect and exit
*
* Wrapper for WP core redirects which automatically calls `exit();`.
*
* This function is redefined when running phpunit tests to make testing code that redirects (and exits).
*
* @since 3.19.4
* @since 5.3.0 Moved location from `includes/llms.functions.core.php`.
* @since 7.4.0 Added `nocache_headers()` to prevent caching of temporary redirects.
*
* @link https://github.com/gocodebox/lifterlms-tests/blob/472c5a286e9f65e2be0c1d6b7edd8d5340d052ed/framework/functions-llms-tests.php#L178-L199
*
* @param string $location Full URL to redirect to.
* @param array $options {
* Optional. Array of options. Default is empty array.
*
* @type int $status HTTP status code of the redirect. Default: `302`.
* @type bool $safe If true, use `wp_safe_redirect()` otherwise use `wp_redirect()`. Default: `true`.
* }
* @return void
*/
function llms_redirect_and_exit( $location, $options = array() ) {
$options = wp_parse_args(
$options,
array(
'status' => 302,
'safe' => true,
)
);
if ( 302 === $options['status'] ) {
nocache_headers(); // Prevent caching of redirects.
}
$func = $options['safe'] ? 'wp_safe_redirect' : 'wp_redirect';
$func( $location, $options['status'] );
exit();
}
}
if ( ! function_exists( 'llms_setcookie' ) ) {
/**
* Set a cookie.
*
* A pluggable wrapper for the native PHP function `set_cookie()`.
*
* The lifterlms-tests library plugs this function during unit testing so we can mock
* the returns of methods that set cookies and write tests for those functions.
*
* @since 4.0.0
* @since 5.3.0 Moved location from `includes/llms.functions.core.php`.
*
* @link https://www.php.net/manual/en/function.setcookie.php
* @link https://github.com/gocodebox/lifterlms-tests/blob/trunk/framework/functions-llms-tests.php#L81-L111
*
* @param string $name The name of the cookie.
* @param string $value The value of the cookie.
* @param int $expires The time wehn the cookie expires as a Unix timestamp.
* @param string $path The path on the server where the cookie will be available.
* @param string $domain The (sub)domain that the cookie is available to.
* @param bool $secure Indicates the cookie should only be transmitted over a secure HTTPS connection.
* @param bool $httponly When `true` the cookie will only be made accessible through the HTTP protocol,
* preventing it from being accessed by scripting languages (such as Javascript).
*
* @return boolean
*/
function llms_setcookie( $name, $value = '', $expires = 0, $path = '', $domain = '', $secure = false, $httponly = false ) {
return setcookie( $name, $value, $expires, $path, $domain, $secure, $httponly );
}
}
================================================
FILE: includes/functions/llms.functions.access.php
================================================
<?php
/**
* Functions used for managing page / post access
*
* @package LifterLMS/Functions
*
* @since 1.0.0
* @version 7.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Determine if content should be restricted.
*
* Called during "template_include" to determine if redirects
* or template overrides are in order.
*
* @since 1.0.0
* @since 3.16.11 Unknown.
* @since 5.7.0 Replaced the call to the deprecated `LLMS_Lesson::get_parent_course()` method with `LLMS_Lesson::get( 'parent_course' )`.
*
* @param int $post_id WordPress Post ID of the content.
* @param int|null $user_id Optional. WP User ID (will use get_current_user_id() if none supplied). Default `null`.
* @return array Restriction check result data.
*/
function llms_page_restricted( $post_id, $user_id = null ) {
$results = array(
'content_id' => $post_id,
'is_restricted' => false,
'reason' => 'accessible',
'restriction_id' => 0,
);
if ( ! $user_id ) {
$user_id = get_current_user_id();
}
$student = false;
if ( $user_id ) {
$student = new LLMS_Student( $user_id );
}
$post_type = get_post_type( $post_id );
/**
* Do checks to determine if the content should be restricted.
*/
$sitewide_membership_id = llms_is_post_restricted_by_sitewide_membership( $post_id, $user_id );
$membership_id = llms_is_post_restricted_by_membership( $post_id, $user_id );
if ( is_home() && $sitewide_membership_id ) {
$restriction_id = $sitewide_membership_id;
$reason = 'sitewide_membership';
// if it's a search page and the site isn't restricted to a membership bypass restrictions.
} elseif ( ( is_search() ) && ! get_option( 'lifterlms_membership_required', '' ) ) {
return apply_filters( 'llms_page_restricted', $results, $post_id );
} elseif ( is_singular() && $sitewide_membership_id ) {
$restriction_id = $sitewide_membership_id;
$reason = 'sitewide_membership';
} elseif ( is_singular() && $membership_id ) {
$restriction_id = $membership_id;
$reason = 'membership';
} elseif ( is_singular() && 'lesson' === $post_type ) {
$lesson = new LLMS_Lesson( $post_id );
// if lesson is free, return accessible results and skip the rest of this function.
if ( $lesson->is_free() ) {
return $results;
} else {
$restriction_id = $lesson->get( 'parent_course' );
$reason = 'enrollment_lesson';
}
} elseif ( is_singular() && 'course' === $post_type ) {
$restriction_id = $post_id;
$reason = 'enrollment_course';
} elseif ( is_singular() && 'llms_membership' === $post_type ) {
$restriction_id = $post_id;
$reason = 'enrollment_membership';
} else {
/**
* Allow filtering of results before checking if the student has access.
*
* @since Unknown.
*
* @param array $results Restriction check result data.
* @param int $post_id WordPress Post ID of the content.
*/
$results = apply_filters( 'llms_page_restricted_before_check_access', $results, $post_id );
extract( $results ); // phpcs:ignore
}
/**
* Content should be restricted, so we'll do the restriction checks
* and return restricted results.
*
* This is run if we have a restriction and a reason for restriction
* and we either don't have a logged in student or the logged in student doesn't have access.
*/
if ( ! empty( $restriction_id ) && ! empty( $reason ) && ( ! $student || ! $student->is_enrolled( $restriction_id ) ) ) {
$results['is_restricted'] = true;
$results['reason'] = $reason;
$results['restriction_id'] = $restriction_id;
/**
* Allow filtering of the restricted results.
*
* @since Unknown
*
* @param array $results Restriction check result data.
* @param int $post_id WordPress Post ID of the content.
*/
return apply_filters( 'llms_page_restricted', $results, $post_id );
}
/**
* At this point student has access or the content isn't supposed to be restricted
* we need to do some additional checks for specific post types.
*/
if ( is_singular() ) {
if ( 'llms_quiz' === $post_type ) {
$quiz_id = llms_is_quiz_accessible( $post_id, $user_id );
if ( $quiz_id ) {
$results['is_restricted'] = true;
$results['reason'] = 'quiz';
$results['restriction_id'] = $post_id;
/* This filter is documented above. */
return apply_filters( 'llms_page_restricted', $results, $post_id );
}
}
if ( 'lesson' === $post_type || 'llms_quiz' === $post_type ) {
$course_id = llms_is_post_restricted_by_time_period( $post_id, $user_id );
if ( $course_id ) {
if ( 'lesson' === $post_type ) {
$lesson = new LLMS_Lesson( $post_id );
}
// If the lesson is dripped based on enrollment, we don't want to restrict it based on course time period.
if ( 'lesson' !== $post_type || ( $lesson && 'enrollment' !== $lesson->get( 'drip_method' ) ) ) {
$results['is_restricted'] = true;
$results['reason'] = 'course_time_period';
$results['restriction_id'] = $course_id;
/* This filter is documented above. */
return apply_filters( 'llms_page_restricted', $results, $post_id );
}
}
$lesson_id = llms_is_post_restricted_by_drip_settings( $post_id, $user_id );
if ( $lesson_id ) {
$results['is_restricted'] = true;
$results['reason'] = 'lesson_drip';
$results['restriction_id'] = $lesson_id;
/* This filter is documented above. */
return apply_filters( 'llms_page_restricted', $results, $post_id );
}
$prereq_data = llms_is_post_restricted_by_prerequisite( $post_id, $user_id );
if ( $prereq_data ) {
$results['is_restricted'] = true;
$results['reason'] = sprintf( '%s_prerequisite', $prereq_data['type'] );
$results['restriction_id'] = $prereq_data['id'];
/* This filter is documented above. */
return apply_filters( 'llms_page_restricted', $results, $post_id );
}
}
}
/* This filter is documented above. */
return apply_filters( 'llms_page_restricted', $results, $post_id );
}
/**
* Retrieve a message describing the reason why content is restricted.
* Accepts an associative array of restriction data that can be retrieved from llms_page_restricted().
*
* This function doesn't handle all restriction types but it should in the future.
* Currently it's being utilized for tooltips on lesson previews and some messages
* output during LLMS_Template_Loader handling redirects.
*
* @since 3.2.4
* @since 3.16.12 Unknown.
*
* @param array $restriction Array of data from `llms_page_restricted()`.
* @return string
*/
function llms_get_restriction_message( $restriction ) {
$msg = __( 'You do not have permission to access this content', 'lifterlms' );
switch ( $restriction['reason'] ) {
case 'course_prerequisite':
$lesson = new LLMS_Lesson( $restriction['content_id'] );
$course_id = $restriction['restriction_id'];
$prereq_link = '<a href="' . get_permalink( $course_id ) . '">' . get_the_title( $course_id ) . '</a>';
$msg = sprintf(
/* Translators: %$1s = lesson title; %2$s link of the course prerequisite */
_x(
'The lesson "%1$s" cannot be accessed until the required prerequisite course "%2$s" is completed.',
'restricted by course prerequisite message',
'lifterlms'
),
$lesson->get( 'title' ),
$prereq_link
);
break;
case 'course_track_prerequisite':
$lesson = new LLMS_Lesson( $restriction['content_id'] );
$track = new LLMS_Track( $restriction['restriction_id'] );
$prereq_link = '<a href="' . $track->get_permalink() . '">' . $track->term->name . '</a>';
$msg = sprintf(
/* Translators: %$1s = lesson title; %2$s link of the track prerequisite */
_x(
'The lesson "%1$s" cannot be accessed until the required prerequisite track "%2$s" is completed.',
'restricted by course track prerequisite message',
'lifterlms'
),
$lesson->get( 'title' ),
$prereq_link
);
break;
// this particular case is only utilized by lessons, courses do the check differently in the template.
case 'course_time_period':
$course = new LLMS_Course( $restriction['restriction_id'] );
// if the start date hasn't passed yet.
if ( ! $course->has_date_passed( 'start_date' ) ) {
$msg = $course->get( 'course_opens_message' );
} elseif ( $course->has_date_passed( 'end_date' ) ) {
$msg = $course->get( 'course_closed_message' );
}
break;
case 'enrollment_lesson':
$course = new LLMS_Course( $restriction['restriction_id'] );
$msg = $course->get( 'content_restricted_message' );
break;
case 'lesson_drip':
$lesson = new LLMS_Lesson( $restriction['restriction_id'] );
$msg = sprintf(
/* Translators: %$1s = lesson title; %2$s available date */
_x(
'The lesson "%1$s" will be available on %2$s',
'lesson restricted by drip settings message',
'lifterlms'
),
$lesson->get( 'title' ),
$lesson->get_available_date()
);
break;
case 'lesson_prerequisite':
$lesson = new LLMS_Lesson( $restriction['content_id'] );
$prereq_lesson = new LLMS_Lesson( $restriction['restriction_id'] );
$prereq_link = '<a href="' . get_permalink( $prereq_lesson->get( 'id' ) ) . '">' . $prereq_lesson->get( 'title' ) . '</a>';
$msg = sprintf(
/* Translators: %$1s = lesson title; %2$s link of the lesson prerequisite */
_x(
'The lesson "%1$s" cannot be accessed until the required prerequisite "%2$s" is completed.',
'lesson restricted by prerequisite message',
'lifterlms'
),
$lesson->get( 'title' ),
$prereq_link
);
break;
default:
}
/**
* Allow filtering the restriction message.
*
* @since Unknown
*
* @param string $msg Restriction message.
* @param array $restriction Array of data from `llms_page_restricted()`.
*/
return apply_filters( 'llms_get_restriction_message', do_shortcode( $msg ), $restriction );
}
/**
* Get a boolean out of llms_page_restricted for easy if checks.
*
* @since 3.0.0
* @since 3.37.10 Made `$user_id` parameter optional. Default is `null`.
*
* @param int $post_id WordPress Post ID of the content.
* @param int|null $user_id Optional. WP User ID (will use get_current_user_id() if none supplied). Default `null`.
* @return bool
*/
function llms_is_page_restricted( $post_id, $user_id = null ) {
$restrictions = llms_page_restricted( $post_id, $user_id );
return $restrictions['is_restricted'];
}
/**
* Determine if a lesson/quiz is restricted by drip settings.
*
* @since 3.0.0
* @since 3.16.11 Unknown.
* @since 3.37.10 Use strict comparison '===' in place of '=='.
* @since 6.5.0 Improve code readability turning if-elseif into a switch-case.
* Bypass drip content restriction on already completed lessons.
*
* @param int $post_id WP Post ID of a lesson or quiz.
* @param int|null $user_id Optional. WP User ID (will use get_current_user_id() if none supplied). Default `null`.
* @return int|false False if the lesson is available.
* WP Post ID of the lesson if it is not.
*/
function llms_is_post_restricted_by_drip_settings( $post_id, $user_id = null ) {
$post_type = get_post_type( $post_id );
switch ( $post_type ) {
// If we're on a lesson, lesson id is the post id.
case 'lesson':
$lesson_id = $post_id;
break;
case 'llms_quiz':
$quiz = llms_get_post( $post_id );
$lesson_id = $quiz->get( 'lesson_id' );
if ( ! $lesson_id ) {
return false;
}
break;
default: // Don't pass other post types.
return false;
}
$lesson = new LLMS_Lesson( $lesson_id );
$user_id = $user_id ?? get_current_user_id();
/**
* Filters whether or not to bypass drip restrictions on completed lessons.
*
* @since 6.5.0
*
* @param boolean $drip_bypass Whether or not to bypass drip restrictions on completed lessons.
* @param int $post_id WP Post ID of a lesson or quiz potentially restricted by drip settings.
* @param int $user_id WP User ID.
*/
$drip_bypass = apply_filters( 'llms_lesson_drip_bypass_if_completed', true, $post_id, $user_id );
$is_available = ( $drip_bypass && $user_id && llms_is_complete( $user_id, $lesson_id, 'lesson' ) ) || $lesson->is_available();
return $is_available ? false : $lesson_id;
}
/**
* Determine if a lesson/quiz is restricted by a prerequisite lesson.
*
* @since 3.0.0
* @since 3.16.11 Unknown.
* @since 6.5.0 Improve code readability turning if-elseif into a switch-case.
*
* @param int $post_id WP Post ID of a lesson or quiz.
* @param int|null $user_id Optional. WP User ID (will use get_current_user_id() if none supplied). Default `null`.
* @return array|false False if the post is not restricted or the user has completed the prereq
* associative array with prereq type and prereq id
* array(
* type => [course|course_track|lesson]
* id => int (object id)
* ).
*/
function llms_is_post_restricted_by_prerequisite( $post_id, $user_id = null ) {
$post_type = get_post_type( $post_id );
switch ( $post_type ) {
// If we're on a lesson, lesson id is the post id.
case 'lesson':
$lesson_id = $post_id;
break;
case 'llms_quiz':
$quiz = llms_get_post( $post_id );
$lesson_id = $quiz->get( 'lesson_id' );
if ( ! $lesson_id ) {
return false;
}
break;
default: // Don't pass other post types.
return false;
}
$lesson = llms_get_post( $lesson_id );
$course = $lesson->get_course();
if ( ! $course ) {
return false;
}
// Get an array of all possible prerequisites.
$prerequisites = array();
if ( $course->has_prerequisite( 'course' ) ) {
$prerequisites[] = array(
'id' => $course->get_prerequisite_id( 'course' ),
'type' => 'course',
);
}
if ( $course->has_prerequisite( 'course_track' ) ) {
$prerequisites[] = array(
'id' => $course->get_prerequisite_id( 'course_track' ),
'type' => 'course_track',
);
}
if ( $lesson->has_prerequisite() ) {
$prerequisites[] = array(
'id' => $lesson->get_prerequisite(),
'type' => 'lesson',
);
}
// Prerequisites exist and user is not logged in, return the first prereq id.
if ( $prerequisites && ! $user_id ) {
return array_shift( $prerequisites );
// If incomplete, send the prereq id.
} else {
$student = new LLMS_Student( $user_id );
foreach ( $prerequisites as $prereq ) {
if ( ! $student->is_complete( $prereq['id'], $prereq['type'] ) ) {
return $prereq;
}
}
}
// Otherwise return false: no prerequisite.
return false;
}
/**
* Determine if a course (or lesson/quiz) is "open" according to course time period settings.
*
* @since 3.0.0
* @since 3.16.11 Unknown.
* @since 5.7.0 Replaced the call to the deprecated `LLMS_Lesson::get_parent_course()` method with `LLMS_Lesson::get( 'parent_course' )`.
* @since 6.5.0 Improve code readability turning if-elseif into a switch-case.
*
* @param int $post_id WP Post ID of a course, lesson, or quiz.
* @param int|null $user_id Optional. WP User ID (will use get_current_user_id() if none supplied). Default `null`.
* @return int|false False if the post is not restricted by course time period,
* WP Post ID of the course if it is.
*/
function llms_is_post_restricted_by_time_period( $post_id, $user_id = null ) {
$post_type = get_post_type( $post_id );
switch ( $post_type ) {
// If we're on a lesson, get course information.
case 'lesson':
$lesson = new LLMS_Lesson( $post_id );
$course_id = $lesson->get( 'parent_course' );
break;
case 'llms_quiz':
$quiz = llms_get_post( $post_id );
$lesson_id = $quiz->get( 'lesson_id' );
if ( ! $lesson_id ) {
return false;
}
$lesson = llms_get_post( $lesson_id );
if ( ! $lesson_id ) {
return false;
}
$course_id = $lesson->get( 'parent_course' );
break;
case 'course':
$course_id = $post_id;
break;
default: // Don't pass other post types.
return false;
}
$course = new LLMS_Course( $course_id );
return $course->is_open() ? false : $course_id;
}
/**
* Determine if a WordPress post (of any type) is restricted to at least one LifterLMS Membership level.
*
* This function replaces the now deprecated page_restricted_by_membership() (and has slightly different functionality).
*
* @since 3.0.0
* @since 3.16.14 Unknown.
* @since 3.37.10 Call `in_array()` with strict comparison.
*
* @param int $post_id WP_Post ID.
* @param int|null $user_id Optional. WP User ID (will use get_current_user_id() if none supplied). Default `null`.
* @return bool|int WP_Post ID of the membership if a restriction is found.
* False if no restrictions found.
*/
function llms_is_post_restricted_by_membership( $post_id, $user_id = null ) {
// don't check these posts types.
$skip = apply_filters(
'llms_is_post_restricted_by_membership_skip_post_types',
array(
'course',
'lesson',
'llms_quiz',
'llms_membership',
'llms_question',
'llms_certificate',
'llms_my_certificate',
)
);
if ( in_array( get_post_type( $post_id ), $skip, true ) ) {
return false;
}
$memberships = get_post_meta( $post_id, '_llms_restricted_levels', true );
$restricted = get_post_meta( $post_id, '_llms_is_restricted', true );
if ( 'yes' === $restricted && $memberships && is_array( $memberships ) ) {
// if no user, return the first membership from the array as the restriction id.
if ( ! $user_id ) {
$restriction_id = array_shift( $memberships );
} else {
$student = llms_get_student( $user_id );
if ( ! $student ) {
$restriction_id = array_shift( $memberships );
} else {
// reverse so to ensure that if user is in none of the memberships,
// they'd encounter the same restriction settings as a visitor.
$memberships = array_reverse( $memberships );
// loop through the memberships.
foreach ( $memberships as $mid ) {
// set this as the restriction id.
$restriction_id = $mid;
// once we find the student has access break the loop,
// this will be the restriction that the template loader will check against later.
if ( $student->is_enrolled( $mid ) ) {
break;
}
}
}
}
return absint( $restriction_id );
}
return false;
}
/**
* Determine if a post should bypass sitewide membership restrictions.
*
* If sitewide membership restriction is disabled, this will always return false.
* This function replaces the now deprecated site_restricted_by_membership() (and has slightly different functionality).
*
* @since 3.0.0
* @since 3.37.10 Do not apply membership restrictions on the page set as membership's restriction redirect page.
* Exclude the privacy policy from the sitewide restriction.
* Call `in_array()` with strict comparison.
*
* @param int $post_id WP Post ID.
* @param int|null $user_id Optional. WP User ID (will use get_current_user_id() if none supplied). Default `null`.
* @return bool|int If the post is not restricted (or there are not sitewide membership restrictions) returns false.
* If the post is restricted, returns the membership id required.
*/
function llms_is_post_restricted_by_sitewide_membership( $post_id, $user_id = null ) {
$membership_id = absint( get_option( 'lifterlms_membership_required', '' ) );
// site is restricted to a membership.
if ( ! empty( $membership_id ) ) {
$membership = new LLMS_Membership( $membership_id );
if ( ! $membership || ! is_a( $membership, 'LLMS_Membership' ) ) {
return false;
}
// Restricted contents redirection page id, if any.
$redirect_page_id = 'page' === $membership->get( 'restriction_redirect_type' ) ? absint( $membership->get( 'redirect_page_id' ) ) : 0;
/**
* Pages that can be bypassed when sitewide restrictions are enabled.
*/
$allowed = apply_filters(
'lifterlms_sitewide_restriction_bypass_ids',
array_filter(
array(
absint( $membership_id ), // the membership page the site is restricted to.
absint( get_option( 'lifterlms_terms_page_id' ) ), // terms and conditions.
llms_get_page_id( 'memberships' ), // membership archives.
llms_get_page_id( 'myaccount' ), // lifterlms account page.
llms_get_page_id( 'checkout' ), // lifterlms checkout page.
absint( get_option( 'wp_page_for_privacy_policy' ) ), // wp privacy policy page.
$redirect_page_id, // Restricted contents redirection page id.
)
)
);
if ( in_array( $post_id, $allowed, true ) ) {
return false;
}
return $membership_id;
} else {
return false;
}
}
/**
* Determine if a quiz should be accessible by a user.
*
* @since 3.1.6
* @since 3.16.1 Unknown.
*
* @param int $post_id WP Post ID.
* @param int|null $user_id Optional. WP User ID (will use get_current_user_id() if none supplied). Default `null`.
* @return bool|int If the post is not restricted returns false.
* If the post is restricted, returns the quiz id.
*/
function llms_is_quiz_accessible( $post_id, $user_id = null ) {
$quiz = llms_get_post( $post_id );
$lesson_id = $quiz->get( 'lesson_id' );
// No lesson or the user is not enrolled.
if ( ! $lesson_id || ! llms_is_user_enrolled( $user_id, $lesson_id ) ) {
return $post_id;
}
return false;
}
================================================
FILE: includes/functions/llms.functions.certificate.php
================================================
<?php
/**
* LifterLMS Certificate Functions
*
* @package LifterLMS/Functions
*
* @since 2.2.0
* @version 6.11.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Retrieve the LLMS_User_Certificate instance for a given post.
*
* Expects the input post to be either an `llms_my_certificate` post. An `llms_certificate` post can be used
* when `$preview_template` is `true`.
*
* @since 6.0.0
*
* @param WP_Post|int|null $post A WP_Post object or a WP_Post ID. A falsy value will use the current global `$post` object (if one exists).
* @param boolean $preview_template If `true`, allows loading an `llms_certificate` post type for previewing the template.
* @return LLMS_User_Certificate|boolean Returns the LLMS_User_Certificate object for the given post. Returns `false` if the post doesn't exist or is
* not of the expected post type.
*/
function llms_get_certificate( $post = null, $preview_template = false ) {
$post = get_post( $post );
if ( ! $post ) {
return false;
}
if ( 'llms_my_certificate' === $post->post_type || ( 'llms_certificate' === $post->post_type && $preview_template ) ) {
return new LLMS_User_Certificate( $post );
}
return false;
}
/**
* Retrieve the content of a certificate.
*
* This allows utilizing the `LLMS_User_Certificate` class with an `llms_certificate` post type to render a preview
* of the certificate template. The saved `post_content` will be merged (using the current user's information).
*
* This function is intended for use on the certificate's front-end display template. In order to retrieve the
* raw content use `LLMS_User_Certificate->get( 'content' )` or `WP_Post->post_content`.
*
* @since 2.2.0
* @since 3.18.0 Unknown.
* @since 6.0.0 Use `llms_get_certificate()` and `LLMS_User_Certificate` methods.
* If this function is used out of the intended certificate context this will now
* return an empty string, whereas previously it returned the content of the post.
* @since 6.4.0 Fixed issue with merge codes in reusable blocks by merging *after* filtering the post content.
*
* @param integer $id WP Post ID of the cert (optional if used within a loop).
* @return string
*/
function llms_get_certificate_content( $id = 0 ) {
$content = '';
$certificate = llms_get_certificate( $id, true );
if ( $certificate ) {
// If `$id` was empty to use the global, ensure an id is available in filter on the return.
$id = $certificate->get( 'id' );
// Get raw content because we filter it again below.
$content = $certificate->get( 'content', true );
}
/** WordPress core filter documented at {@link https://developer.wordpress.org/reference/hooks/the_content/}. */
$content = apply_filters( 'the_content', $content );
// Get merged content for templates.
if ( 'llms_certificate' === get_post_type( $id ) ) {
$content = $certificate->merge_content( $content );
}
/**
* Filter the `post_content` of a certificate or certificate template.
*
* @since Unknown
* @since 6.0.0 Added the `$certificate` parameter.
*
* @param string $content The certificate content.
* @param int $id The ID of the certificate.
* @param bool|LLMS_User_Certificate $certificate Certificate object or `false` if the post couldn't be found.
*/
return apply_filters( 'lifterlms_certificate_content', $content, $id, $certificate );
}
/**
* Retrieves a list of fonts available for use in certificates.
*
* @since 6.0.0
* @since 6.11.0 Added internal call for certificate fonts, with external option enabled.
*
* @return array[] {
* Array of font definition arrays. The array key is the font's unique id.
*
* @type string $name The human-readable name of the font.
* @type string|null $href The href used to load the font or `null` for system or default fonts.
* @type string|null $css The CSS `font-family` rule value.
* }
*/
function llms_get_certificate_fonts() {
/**
* Determines whether or not webfonts are loaded from Google CDNs.
*
* @since 6.11.0
*
* @param bool $use_g_fonts If `true`, fonts are loaded from Google, otherwise they are loaded from the local site.
*/
$use_g_fonts = apply_filters( 'llms_use_google_webfonts', false );
$serif = '"Iowan Old Style", "Apple Garamond", Baskerville, "Times New Roman", "Droid Serif", Times, "Source Serif Pro", serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol"';
$fonts = array(
// Default fonts.
'sans' => array(
'name' => __( 'Sans-serif', 'lifterlms' ),
'href' => null,
// From https://systemfontstack.com.
'fontFamily' => '-apple-system, BlinkMacSystemFont, "avenir next", avenir, "segoe ui", "helvetica neue", helvetica, Ubuntu, roboto, noto, arial, sans-serif',
),
'serif' => array(
'name' => __( 'Serif', 'lifterlms' ),
'href' => null,
// From https://systemfontstack.com.
'fontFamily' => $serif,
),
// Newspaper-style display fonts.
'pirata-one' => array(
'name' => 'Pirata One',
'href' => $use_g_fonts ? 'https://fonts.googleapis.com/css2?family=Pirata+One&display=swap' : LLMS_PLUGIN_URL . 'assets/css/pirata-one.css?ver=v22',
'fontFamily' => '"Pirata One", ' . $serif,
),
'unifraktur-maguntia' => array(
'name' => 'UnifrakturMaguntia',
'href' => $use_g_fonts ? 'https://fonts.googleapis.com/css2?family=UnifrakturMaguntia&display=swap' : LLMS_PLUGIN_URL . 'assets/css/unifraktur-maguntia.css?ver=v16',
'fontFamily' => '"UnifrakturMaguntia", ' . $serif,
),
// Cursive-style handwriting fonts.
'dancing-script' => array(
'name' => 'Dancing Script',
'href' => $use_g_fonts ? 'https://fonts.googleapis.com/css2?family=Dancing+Script&display=swap' : LLMS_PLUGIN_URL . 'assets/css/dancing-script.css?ver=v24',
'fontFamily' => '"Dancing Script", ' . $serif,
),
'imperial-script' => array(
'name' => 'Imperial Script',
'href' => $use_g_fonts ? 'https://fonts.googleapis.com/css2?family=Imperial+Script&display=swap' : LLMS_PLUGIN_URL . 'assets/css/imperial-script.css?ver=v24',
'fontFamily' => '"Imperial Script", ' . $serif,
),
);
/**
* Filters the list of fonts available to certificates.
*
* @since 6.0.0
*
* @param array[] $fonts Array of font definitions, {@see llms_get_certificate_fonts()}.
*/
return apply_filters( 'llms_certificate_fonts', $fonts );
}
/**
* Retrieve an array of image data for a certificate background image
*
* If no image found, will default to the LifterLMS placeholder (which can be filtered for a custom placeholder).
*
* @since 2.2.0
* @since 6.0.0 Use `LLMS_User_Certificate::get_background_image()`.
*
* @param int $id Optional. WP Certificate Post ID. Default is 0.
* When not provide the current post id will be used.
* @return array Associative array of certificate image details
*/
function llms_get_certificate_image( $id = 0 ) {
$id = ( $id ) ? $id : get_the_ID();
$cert = new LLMS_User_Certificate( $id );
return $cert->get_background_image();
}
/**
* Retrieve a list of merge codes that can be used in certificate templates.
*
* @since 6.0.0
* @since 6.1.0 Changed `{current_date}` label from 'Earned Date' to 'Current Date' and added `{earned_date}` merge code.
*
* @return string[] Associative array of merge codes where the array key is the merge code and the array value is a name / description of the merge code.
*/
function llms_get_certificate_merge_codes() {
/**
* Filters the list of available merge codes for certificates.
*
* @since 9.1.0
*
* @param array[] $codes Associative array of merge codes where the array key is the merge code and the array value is a name / description of the merge code.
*/
return apply_filters(
'llms_certificate_available_merge_codes',
array(
'{site_title}' => __( 'Site Title', 'lifterlms' ),
'{site_url}' => __( 'Site URL', 'lifterlms' ),
'{current_date}' => __( 'Current Date', 'lifterlms' ),
'{earned_date}' => __( 'Earned Date', 'lifterlms' ),
'{first_name}' => __( 'Student First Name', 'lifterlms' ),
'{last_name}' => __( 'Student Last Name', 'lifterlms' ),
'{email_address}' => __( 'Student Email', 'lifterlms' ),
'{student_id}' => __( 'Student User ID', 'lifterlms' ),
'{user_login}' => __( 'Student Username', 'lifterlms' ),
'{certificate_id}' => __( 'Certificate ID', 'lifterlms' ),
'{sequential_id}' => __( 'Sequential Certificate ID', 'lifterlms' ),
)
);
}
/**
* Retrieves registered certificate orientations.
*
* @since 6.0.0
*
* @return array Key value array where the array key is the orientation ID and the value is the
* translated name of the orientation.
*/
function llms_get_certificate_orientations() {
$orientations = array(
'portrait' => __( 'Portrait', 'lifterlms' ),
'landscape' => __( 'Landscape', 'lifterlms' ),
);
/**
* Filters the list of available certificate orientations.
*
* @since 6.0.0
*
* @param array $orientations Array of orientations.
*/
return apply_filters( 'llms_certificate_orientations', $orientations );
}
/**
* Retrieve the next sequential ID for a given certificate template and optionally increment it.
*
* If there's no existing ID, a default ID of 1 will be used. This can be customized using the filter `llms_certificate_sequential_id_starting_number`.
*
* When an increment is requested, the new incremented ID will be automatically persisted to the database.
*
* @since 6.0.0
*
* @param integer $template_id WP_Post ID of the certificate template (`llms_certificate`) post.
* @param boolean $increment Whether or not to increment the current ID.
* @return int
*/
function llms_get_certificate_sequential_id( $template_id, $increment = false ) {
$key = '_llms_sequential_id';
$update = $increment;
$id = absint( get_post_meta( $template_id, $key, true ) );
// No id, get the initial ID.
if ( ! $id ) {
/**
* Determines the default starting number for the a certificate's sequential ID.
*
* The returned number *must* be an absolute integer (zero included). The returned value will be
* passed through `absint()` to sanitize the filtered value.
*
* @since 6.0.0
*
* @param int $starting_id The starting number.
* @param int $template_id WP_Post ID of the certificate template.
*/
$starting_id = apply_filters( 'llms_certificate_sequential_id_starting_number', 1, $template_id );
$id = absint( $starting_id );
$update = true;
}
if ( $update ) {
update_post_meta( $template_id, $key, $increment ? $id + 1 : $id );
}
/**
* Filters the sequential ID number for a given certificate template.
*
* The returned number *must* be an absolute integer. The returned value will be
* passed through `absint()` to sanitize the filtered value.
*
* @since 6.0.0
*
* @param int $id The sequential ID.
* @param int $template_id WP_Post ID of the certificate template.
*/
return absint( apply_filters( 'llms_certificate_sequential_id', $id, $template_id ) );
}
/**
* Retrieves a list of registered certificate sizes.
*
* @since 6.0.0
*
* @return {
* Array of sizes. The array key is the size's unique ID.
*
* @type string $name The translated name for the size.
* @type float $width The portrait width dimension of the size.
* @type float $height The portrait height dimension of the size.
* @type string $unit The unit used for the dimensions of the size. Must be the ID of a unit registered via {@see llms_get_certificate_units()}.
* }
*/
function llms_get_certificate_sizes() {
$sizes = array(
// ISO 216 sizes.
'A3' => array(
'name' => _x( 'A3', 'Paper size name', 'lifterlms' ),
'width' => 297,
'height' => 420,
'unit' => 'mm',
),
'A4' => array(
'name' => _x( 'A4', 'Paper size name', 'lifterlms' ),
'width' => 210,
'height' => 297,
'unit' => 'mm',
),
'A5' => array(
'name' => _x( 'A5', 'Paper size name', 'lifterlms' ),
'width' => 148,
'height' => 210,
'unit' => 'mm',
),
// North American sizes.
'LETTER' => array(
'name' => _x( 'Letter', 'Paper size name', 'lifterlms' ),
'width' => 8.5,
'height' => 11,
'unit' => 'in',
),
'LEGAL' => array(
'name' => _x( 'Legal', 'Paper size name', 'lifterlms' ),
'width' => 8.5,
'height' => 14,
'unit' => 'in',
),
'LEDGER' => array(
'name' => _x( 'Ledger', 'Paper size name', 'lifterlms' ),
'width' => 11,
'height' => 17,
'unit' => 'in',
),
'USER_DEFINED' => array(
'name' => __( 'User defined', 'lifterlms' ),
'width' => get_option( 'lifterlms_certificate_default_user_defined_width', 400 ),
'height' => get_option( 'lifterlms_certificate_default_user_defined_height', 400 ),
'unit' => get_option( 'lifterlms_certificate_default_user_defined_unit', 'mm' ),
),
);
/**
* Filters registered certificate size options.
*
* @since 6.0.0
*
* @param array $sizes Array of registered sizes.
*/
return apply_filters( 'llms_certificate_sizes', $sizes );
}
/**
* Retrieves units available for certificate dimensions.
*
* @since 6.0.0
*
* @link https://developer.mozilla.org/en-US/docs/Web/CSS/length
*
* @return {
* Array of unit information. The array key is the unit ID, which should be a valid absolute length CSS unit.
*
* @type string $name Translated name of the unit.
* @type string $symbol Translated symbol used when displaying dimensions with the unit.
.* }
*/
function llms_get_certificate_units() {
$units = array(
'in' => array(
'name' => __( 'Inches', 'lifterlms' ),
'symbol' => _x( '"', 'Symbol for inches', 'lifterlms' ),
),
'mm' => array(
'name' => __( 'Millimeters', 'lifterlms' ),
'symbol' => _x( 'mm', 'Symbol for millimeters', 'lifterlms' ),
),
);
/**
* Filters the list of certificate dimension units.
*
* @since 6.0.0
*
* @param array $units Array of available units.
*/
return apply_filters( 'llms_certificate_units', $units );
}
/**
* Retrieve the title of a certificate
*
* This function is intended for use on the certificate's front-end display template.
*
* @since 2.2.0
* @since 6.0.0 Use `LLMS_User_Certificate()` to retrieve the title for earned certificates.
*
* @param int $id WP Certificate Post ID. When not provide the current post id will be used.
* @return string The title of the certificate.
*/
function llms_get_certificate_title( $id = 0 ) {
$id = $id ? $id : get_the_ID();
$title = '';
$certificate = llms_get_certificate( $id, false );
if ( $certificate ) {
$title = $certificate->get( 'title' );
} elseif ( 'llms_certificate' === get_post_type( $id ) ) {
$title = get_post_meta( $id, '_llms_certificate_title', true );
}
/**
* Filter the title of a certificate or certificate template.
*
* @since Unknown
* @since 6.0.0 Added the `$certificate` parameter.
*
* @param string $title The certificate title.
* @param int $id The ID of the certificate.
*/
return apply_filters( 'lifterlms_certificate_title', $title, $id );
}
/**
* Determines whether or not the block editor can be used to build certificates.
*
* The JS used for certificates in the block editor relies on WP functions and APIs available
* since WordPress 5.8. Earlier versions of WordPress won't work.
*
* @since 6.0.0
*
* @return boolean
*/
function llms_is_block_editor_supported_for_certificates() {
global $wp_version;
$is_supported = version_compare( $wp_version, '5.8-src', '>=' );
/**
* Filters whether or not the block editor can be used for building certificates.
*
* By default, `$is_supported` will be `true` for WordPress 5.8 or later and false for versions less than
* 5.8.
*
* This filter may be used to disable the block editor on later versions.
*
* @since 6.0.0
*
* @param boolean $is_supported Whether or not the block editor is supported.
*/
return apply_filters( 'llms_block_editor_supported_for_certificates', $is_supported );
}
/**
* Register the custom "print_certificate" image size
*
* @since 2.2.0
*
* @return void
*/
function llms_register_certificate_image_size() {
$width = get_option( 'lifterlms_certificate_bg_img_width', '800' );
$height = get_option( 'lifterlms_certificate_bg_img_height', '616' );
add_image_size( 'lifterlms_certificate_background', $width, $height, true );
}
add_action( 'after_setup_theme', 'llms_register_certificate_image_size' );
================================================
FILE: includes/functions/llms.functions.course.php
================================================
<?php
/**
* LifterLMS Course Functions
*
* @package LifterLMS/Functions
*
* @since Unknown
* @version 3.37.13
*/
defined( 'ABSPATH' ) || exit;
/**
* Get course object
*
* @since Unknown
* @since 3.37.13 Use `LLMS_Course` in favor of the deprecated `LLMS_Course_Factory::get_course()` method.
*
* @param WP_Post|int|false $the_course Course post object or id. If `false` uses the global `$post` object.
* @param array $args Arguments to pass to the LLMS_Course Constructor.
* @return LLMS_Course
*/
function get_course( $the_course = false, $args = array() ) {
if ( ! $the_course ) {
global $post;
$the_course = $post;
}
return new LLMS_Course( $the_course, $args );
}
/**
* Get lesson object
*
* @since Unknown
* @since 3.37.13 Use `LLMS_Lesson` in favor of the deprecated `LLMS_Course_Factory::get_lesson()` method.
*
* @param WP_Post|int|false $the_lesson Lesson post object or id. If `false` uses the global `$post` object.
* @param array $args Arguments to pass to the LLMS_Lesson Constructor.
* @return LLMS_Lesson
*/
function get_lesson( $the_lesson = false, $args = array() ) {
if ( ! $the_lesson ) {
global $post;
$the_lesson = $post;
}
return new LLMS_Lesson( $the_lesson, $args );
}
================================================
FILE: includes/functions/llms.functions.currency.php
================================================
<?php
/**
* Currency and Price related functions for LifterLMS Products
*
* @package LifterLMS/Functions
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Get the currency selected
*
* @since 1.0.0
* @since 3.0.0 Added USD as default when no option is set.
*
* @return string Currency code.
*/
function get_lifterlms_currency() {
/**
* Hook Summary
*
* Hook description.
*
* @since Unknown
*
* @param string $currency Currency code.
*/
return apply_filters( 'lifterlms_currency', get_option( 'lifterlms_currency', 'USD' ) );
}
/**
* Get the name of a currency
*
* @since 3.0.0
*
* @param string $currency A currency code.
* @return string
*/
function get_lifterlms_currency_name( $currency = '' ) {
if ( ! $currency ) {
$currency = get_lifterlms_currency();
}
$name = '';
$currencies = get_lifterlms_currencies();
if ( isset( $currencies[ $currency ] ) ) {
$name = $currencies[ $currency ];
}
/**
* Filters the name of the given currency.
*
* @since 3.0.0
*
* @param string $name Currency name.
* @param string $currency Currency code.
*/
return apply_filters( 'lifterlms_currency_name', $name, $currency );
}
/**
* Get array of supported currencies
*
* @since Unknown
* @since 3.0.0 Unknown.
* @since 5.0.0 Use currency list provided in `languages/currencies.php`.
*
* @return array
*/
function get_lifterlms_currencies() {
$currencies = require LLMS_PLUGIN_DIR . 'languages/currencies.php';
/**
* Filters the list of available currencies
*
* @since Unknown
*
* @param array $currencies A list of currency codes to currency names. See "languages/currencies.php" for details.
*/
return apply_filters( 'lifterlms_currencies', $currencies );
}
/**
* Get Currency Symbol text code
*
* @since Unknown
* @since 3.30.3 Removed duplicate key "MAD".
* @since 5.0.0 Retrieve symbols list from `llms_get_currency_symbols()`.
* If a symbol cannot be found for the supplied currency code, return the code instead of an empty string.
*
* @param string $currency Currency Code.
* @return string
*/
function get_lifterlms_currency_symbol( $currency = '' ) {
if ( ! $currency ) {
$currency = get_lifterlms_currency();
}
$symbols = llms_get_currency_symbols();
$currency_symbol = isset( $symbols[ $currency ] ) ? $symbols[ $currency ] : $currency;
/**
* Filters the symbol for the specified currency
*
* @since Unknown
*
* @param string $currency_symbol Currency symbol. If the symbol contains non-Latin characters, the HTML entity code for those characters will be used.
* @param string $currency Currency code.
*/
return apply_filters( 'lifterlms_currency_symbol', $currency_symbol, $currency );
}
/**
* Get the number of decimals places used for prices as defined by the setting.
*
* @since 3.0.0
*
* @return int
*/
function get_lifterlms_decimals() {
return absint( apply_filters( 'lifterlms_decimals', get_option( 'lifterlms_decimals', 2 ) ) );
}
/**
* Retrieve the character used as a decimal separator
*
* @since 3.0.0
*
* @return string
*/
function get_lifterlms_decimal_separator() {
return apply_filters( 'lifterlms_decimal_separator', get_option( 'lifterlms_decimal_separator', '.' ) );
}
/**
* Retrieve the setting for trimming zero value decimals from the end of prices
*
* @since 3.0.0
*
* @return string Either 'yes' or 'no'.
*/
function get_lifterlms_trim_zero_decimals() {
return apply_filters( 'lifterlms_trim_zero_decimals', get_option( 'lifterlms_trim_zero_decimals', 'no' ) );
}
/**
* Get a format string that can be passed to printf or sprintf to format prices
*
* The format string is created using user-defined price formatting settings.
*
* @since 3.0.0
*
* @return string
*/
function get_lifterlms_price_format() {
$pos = get_option( 'lifterlms_currency_position', 'left' );
$format = '%1$s%2$s';
switch ( $pos ) {
case 'left':
$format = '%1$s%2$s';
break;
case 'right':
$format = '%2$s%1$s';
break;
case 'left_space':
$format = '%1$s %2$s';
break;
case 'right_space':
$format = '%2$s %1$s';
break;
}
return apply_filters( 'lifterlms_price_format', $format, $pos );
}
/**
* Retrieve the character used as the thousands separator
*
* @since 3.0.0
*
* @return string
*/
function get_lifterlms_thousand_separator() {
return apply_filters( 'lifterlms_thousand_separator', get_option( 'lifterlms_thousand_separator', '.' ) );
}
/**
* Retrieve a list of available currency symbols
*
* Retrieves the symbols list from `languages/currency-symbols.php`.
*
* @since 5.0.0
*
* @return array Array of currency codes to their symbols. Any non-Latin characters found in a symbol are returned as an HTML character entity code.
*/
function llms_get_currency_symbols() {
$symbols = require LLMS_PLUGIN_DIR . 'languages/currency-symbols.php';
/**
* Filters the list of currency symbols
*
* @since Unknown
*
* @param array $symbols List of currency codes to their symbol. See "languages/currency-symbols.php" for details.
*/
return apply_filters( 'lifterlms_currency_symbols', $symbols );
}
/**
* Get a formatted price price
*
* @since Unknown
* @since 3.0.0 Unknown.
*
* @param int $price Price to display.
* @param array $args Array of arguments.
* @return string
*/
function llms_price( $price, $args = array() ) {
extract(
apply_filters(
'llms_price_args',
array_merge(
array(
'currency' => '',
'decimal_separator' => get_lifterlms_decimal_separator(),
'decimals' => get_lifterlms_decimals(),
'format' => get_lifterlms_price_format(),
'thousand_separator' => get_lifterlms_thousand_separator(),
'trim_zeros' => get_lifterlms_trim_zero_decimals(),
),
$args
)
)
);
$negative = $price < 0;
$price = apply_filters( 'raw_lifterlms_price', floatval( $negative ? $price * -1 : $price ) );
$price = apply_filters( 'formatted_lifterlms_price', number_format( $price, $decimals, $decimal_separator, $thousand_separator ), $price, $decimals, $decimal_separator, $thousand_separator );
if ( 'yes' === $trim_zeros && $decimals > 0 ) {
$price = llms_trim_zeros( $price );
}
$formatted_price = ( $negative ? '-' : '' ) . sprintf( $format, '<span class="llms-price-currency-symbol">' . get_lifterlms_currency_symbol( $currency ) . '</span>', $price );
$r = '<span class="lifterlms-price">' . $formatted_price . '</span>';
return apply_filters( 'llms_price', $r, $price, $args );
}
/**
* Get a simple string (no html) based on the output of llms_price
*
* @since Unknown
* @since 3.0.0 Unknown.
*
* @param int $price Price to display.
* @param array $args Array of arguments.
* @return string
*/
function llms_price_raw( $price, $args = array() ) {
return html_entity_decode( wp_strip_all_tags( llms_price( $price, $args ) ) );
}
/**
* Trim trailing zeros off a price
*
* @since 3.0.0
*
* @param mixed $price Price string.
* @return string
*/
function llms_trim_zeros( $price ) {
return preg_replace( '/' . preg_quote( get_lifterlms_decimal_separator(), '/' ) . '0++$/', '', $price );
}
================================================
FILE: includes/functions/llms.functions.favorite.php
================================================
<?php
/**
* LifterLMS Favorite Functions
*
* @package LifterLMS/Functions
*
* @since 7.5.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Get Favorites Count.
*
* @since 7.5.0
*
* @param bool|int $object_id WP Post ID of the Lesson. If not supplied it will default to the current post ID.
* @return int
*/
function llms_get_object_total_favorites( $object_id = false ) {
global $wpdb;
// Getting ID from Global Post object.
if ( ! $object_id ) {
$object_id = get_the_ID();
}
$res = $wpdb->get_var(
$wpdb->prepare(
"SELECT COUNT(DISTINCT meta_id) FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE post_id = %d AND meta_key = %s ORDER BY updated_date DESC",
$object_id,
'_favorite'
)
); // db call ok; no-cache ok.
return $res;
}
/**
* Filter Hook to enable the Favorite feature.
*
* @since 7.5.0
*
* @return bool True if favorites are enabled, false otherwise.
*/
function llms_is_favorites_enabled() {
$favorite_enabled = llms_parse_bool( get_option( 'lifterlms_favorites', 'no' ) );
/**
* Filter to enable/disable the Favorite feature.
*
* @since 7.5.0
*
* @param bool $favorite_enabled True if favorites are enabled, false otherwise.
*/
return apply_filters( 'llms_favorites_enabled', $favorite_enabled );
}
================================================
FILE: includes/functions/llms.functions.log.php
================================================
<?php
/**
* Logging & Related Functions
*
* @package LifterLMS/Functions
*
* @since 3.0.0
* @version 6.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Copy a log file that is greater than or equal to the max allowed log file size
*
* If the log file's size is larger than the maximum allowed log file size (5MB) it will rename the log, adding
* the current timestamp as a suffix and `.bk` to the extension.
*
* Future logs to the same file will result in a new logfile being created, ensuring that log files never grow
* too large which could cause performance issues during reads and writes.
*
* @since 4.5.0
*
* @see llms_backup_logs()
*
* @param string $handle Log file handle.
* @return null|boolean|string Returns `null` if the log file is not larger than the max size, `false` if an error is encountered,
* and the new log file path on success.
*/
function llms_backup_log( $handle ) {
$file = llms_get_log_path( $handle );
$size = file_exists( $file ) ? filesize( $file ) : 0;
/**
* Filter the max filesize of a log file before the log is backed up
*
* The value of this filter, `$maxsize` is an integer representing the maximum number of megabytes
* a file can be before it is split.
*
* @since 4.5.0
*
* @param int $maxsize Maximum file size (in MB). The default value is `5` (5MB).
*/
$maxsize = absint( apply_filters( 'llms_log_max_filesize', 5 ) ) * 1000 * 1000;
if ( $size >= $maxsize ) {
$copy = str_replace( '.log', sprintf( '-%d.log.bk', time() ), $file );
/**
* Filter the name of a log file copy that's being backed up because it's reached the maximum allowed size
*
* While it is possible to change the extension of the log file (`.log.bk`), it is not recommended. The cron
* which creates copies filters out `.log.bk` so that it doesn't scan backups and attempt to split them
* again (infinitely).
*
* @since 4.5.0
*
* @param string $copy Full path for the copy log file (the backup).
* @param string $file Full path for the original log file.
* @param string $handle Log file handle.
*/
$copy = apply_filters( 'llms_log_split_file_name', $copy, $file, $handle );
if ( rename( $file, $copy ) ) {
/**
* Action triggered immediately following the creation of a logfile backup.
*
* @since 4.5.0
*
* @param string $copy Full path for the copy log file (the backup).
* @param string $file Full path for the original log file.
* @param string $handle Log file handle.
*/
do_action( 'llms_log_file_backup_created', $copy, $file, $handle );
return $copy;
}
}
return null;
}
/**
* Backup all log files in the LifterLMS log directory
*
* This function scans the `LLMS_LOG_DIR` and passes each log file to `llms_backup_log()` to
* create backups of each log file.
*
* It does not include logs with the `.log.bk` extension as those logs are logs created by this process
* and don't need to be scanned again.
*
* @since 4.5.0
*
* @see llms_backup_log()
*
* @return void
*/
function llms_backup_logs() {
foreach ( glob( LLMS_LOG_DIR . '*.log' ) as $file ) {
// Get the handle from the file path.
$parts = explode( '-', basename( $file, '.log' ) );
if ( $parts ) {
llms_backup_log( implode( '-', array_slice( $parts, 0, -1 ) ) );
}
}
}
add_action( 'llms_backup_logs', 'llms_backup_logs' );
/**
* Retrieve a string representing a PHP callable
*
* This can be used to log callables regardless of the callable format.
*
* @since 5.2.0
*
* @param mixed $callable PHP callable.
* @return string
*/
function llms_get_callable_name( $callable ) {
// Function name or static class -> method: 'function' or 'class::method'.
if ( is_string( $callable ) ) {
return $callable;
}
if ( is_array( $callable ) && ! empty( $callable ) ) {
// Class and class method: [ $class, 'method' ]. (phpcs:ignore Squiz.PHP.CommentedOutCode.Found).
if ( is_object( $callable[0] ) ) {
return get_class( $callable[0] ) . '->' . $callable[1];
}
// Static class + method: [ 'class', 'method' ]. (phpcs:ignore Squiz.PHP.CommentedOutCode.Found).
return implode( '::', $callable );
}
// Invokable class: $class. (phpcs:ignore Squiz.PHP.CommentedOutCode.Found).
if ( is_object( $callable ) ) {
return get_class( $callable );
}
return 'Unknown';
}
/**
* Retrieve the full path to the log file for a given log handle
*
* @since 3.0.0
*
* @param string $handle Log handle.
* @return string
*/
function llms_get_log_path( $handle ) {
return trailingslashit( LLMS_LOG_DIR ) . $handle . '-' . sanitize_file_name( wp_hash( $handle ) ) . '.log';
}
/**
* Log arbitrary messages to a log file
*
* @since 1.0.0
* @since 3.7.5 Unknown.
*
* @param mixed $message Data to log.
* @param string $handle Allow creation of multiple log files by handle.
* @return boolean
*/
function llms_log( $message, $handle = 'llms' ) {
/**
* Filter a log data before it's written to the logger.
*
* This hook filters the log message in its raw format which may be a string, object, or array. To
* filter the final log message after string conversion, use `llms_log_message_string`.
*
* @since 4.12.0
*
* @see llms_log_message_string
*
* @param mixed $message Data to log.
* @param string $handle Allow creation of multiple log files by handle.
*/
$message = apply_filters( 'llms_log_message', $message, $handle );
$ret = false;
$fh = fopen( llms_get_log_path( $handle ), 'a' ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fopen
// Open the file (creates it if it doesn't already exist).
if ( $fh ) {
$message = is_array( $message ) || is_object( $message ) ? print_r( $message, true ) : $message; // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_print_r -- This is intentional.
/**
* Filter a log message before it's written to the logger.
*
* This hook filters the log message in its final string format To filter the log message
* before string conversion, use `llms_log_message`.
*
* @since 6.4.0
*
* @see llms_log_message
*
* @param string $message Log message string.
* @param string $handle Allow creation of multiple log files by handle.
*/
$message = apply_filters( 'llms_log_message_string', $message, $handle );
$ret = fwrite( $fh, gmdate( 'Y-m-d H:i:s' ) . ' - ' . $message . "\n" ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fwrite
fclose( $fh ); // phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fclose
}
return $ret ? true : false;
}
/**
* Automatically anonymize a list of registered "secure" strings before writing logs.
*
* This function is a callback for the `llms_log_message_string` filter. It loads secure strings
* defined in the `llms_secure_strings` filter and automatically anonymizes them when
* they are found within the supplied log message.
*
* @since 6.4.0
*
* @access private
*
* @param string $message The string to log.
* @param string $handle Log file handle.
* @return string
*/
function _llms_secure_log_messages( $message, $handle ) {
/**
* Filters a list of "secure" strings which should be anonymized prior to logging.
*
* A plugin or theme that might log potentially sensitive data (such as API keys), the
* API key strings can be registered with this filter to automatically be anonymized
* if they are found within logs.
*
* @since 6.4.0
*
* @param string[] $secure_strings An array of secure strings that should be anonymized.
* @param string $handle The log handle. This can be used to only register strings for a specific log file.
*/
$secure_strings = apply_filters( 'llms_secure_strings', array(), $handle );
// Nothing to do.
if ( empty( $secure_strings ) ) {
return $message;
}
$find = array();
$replace = array();
foreach ( $secure_strings as $string ) {
if ( false !== strpos( $message, $string ) ) {
$find[] = $string;
$replace[] = llms_anonymize_string( $string );
}
}
$message = str_replace( $find, $replace, $message );
return $message;
}
add_filter( 'llms_log_message_string', '_llms_secure_log_messages', 999, 2 );
================================================
FILE: includes/functions/llms.functions.notice.php
================================================
<?php
/**
* Notice Functions
*
* Functions for managing front end notices (alert messages).
*
* @package LifterLMS/Functions
*
* @since unknown
* @version 3.14.7
*/
defined( 'ABSPATH' ) || exit;
/**
* Stores notice in llms_notices session
*
* @param string $message [The notice message]
* @param string $notice_type [notice type]
* @return void
* @since 1.0.0
* @version 1.0.0
*/
function llms_add_notice( $message, $notice_type = 'success' ) {
$notices = llms()->session->get( 'llms_notices', array() );
if ( 'success' === $notice_type ) {
$message = apply_filters( 'lifterlms_add_message', $message );
}
$notices[ $notice_type ][] = apply_filters( 'lifterlms_add_' . $notice_type, $message );
llms()->session->set( 'llms_notices', $notices );
}
/**
* Clears all notices from session
*
* @return void
* @since 1.0.0
* @version 3.12.0
*/
function llms_clear_notices() {
llms()->session->set( 'llms_notices', array() );
}
/**
* Retrieve an array of notice types
*
* @return array
* @since 1.0.0
* @version 1.0.0
*/
function llms_get_notice_types() {
return apply_filters( 'lifterlms_notice_types', array( 'debug', 'error', 'notice', 'success' ) );
}
/**
* Gets messages and errors which are stored in the session, then clears them.
*
* @package LifterLMS/Functions
*
* @return string
* @since 3.0.0
* @version 3.12.0
*/
function llms_get_notices() {
$all_notices = apply_filters( 'lifterlms_print_notices', llms()->session->get( 'llms_notices', array() ) );
$notice_types = llms_get_notice_types();
ob_start();
foreach ( $notice_types as $notice_type ) {
if ( llms_notice_count( $notice_type ) > 0 ) {
llms_get_template(
"notices/{$notice_type}.php",
array(
'messages' => $all_notices[ $notice_type ],
)
);
}
}
add_action( 'shutdown', 'llms_clear_notices', 1 ); // Prior to shutdown functions executed by session manager.
return ob_get_clean();
}
/**
* Returns a count of all current notices by type.
*
* @param string $notice_type Type of notice passed. IE: error, success, warning
* @return int
* @since 1.0.0
* @version 1.0.0
*/
function llms_notice_count( $notice_type = '' ) {
$notice_count = 0;
$all_notices = llms()->session->get( 'llms_notices', array() );
if ( isset( $all_notices[ $notice_type ] ) ) {
$notice_count = absint( count( $all_notices[ $notice_type ] ) );
} elseif ( empty( $notice_type ) ) {
foreach ( $all_notices as $notices ) {
$notice_count += absint( count( $all_notices ) );
}
}
return $notice_count;
}
/**
* Prints a single notice
*
* @param string $message [The notice message]
* @param string $notice_type [notice type]
* @return void
* @since 1.0.0
* @version 1.0.0
*/
function llms_print_notice( $message, $notice_type = 'success' ) {
if ( 'success' === $notice_type ) {
$message = apply_filters( 'lifterlms_add_message', $message );
}
llms_get_template(
"notices/{$notice_type}.php",
array(
'messages' => array( apply_filters( 'lifterlms_add_' . $notice_type, $message ) ),
)
);
}
/**
* Prints all notices
*
* @return void
* @since 1.0.0
* @version 3.14.7
*/
function llms_print_notices() {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in templates.
echo llms_get_notices();
llms_clear_notices();
}
================================================
FILE: includes/functions/llms.functions.order.php
================================================
<?php
/**
* Functions for LifterLMS Orders.
*
* @package LifterLMS/Functions
*
* @since 3.29.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Determine if a gateway can be used for a given LLMS_Access_Plan.
*
* @since 3.29.0
* @since 7.0.0 Updated to utilize llms_can_gateway_be_used_for_plan_or_order().
*
* @param string $gateway_id LLMS_Payment_Gateway ID.
* @param LLMS_Access_Plan $plan The access plan.
* @return WP_Error|bool WP_Error on error, true on success.
*/
function llms_can_gateway_be_used_for_plan( $gateway_id, $plan ) {
$can_be_used = llms_can_gateway_be_used_for_plan_or_order( $gateway_id, $plan, true, ( 'manual' !== $gateway_id ) );
/**
* Filters whether or not a gateway can be used for a given access plan.
*
* @since 3.29.0
* @since 7.0.0 The filter now runs on all possible return values instead of running only when the gateway can be used.
*
* @param boolean|WP_Error $can_be_used Whether or not the gateway can be used for the plan. This value will be `true`
* when the gateway can be used an an error object when it cannot.
* @param string $gateway_id The LLMS_Payment_Gateway ID.
* @param LLMS_Access_plan $plan The access plan object.
*/
return apply_filters( 'llms_can_gateway_be_used_for_plan', $can_be_used, $gateway_id, $plan );
}
/**
* Determines if a payment gateway can be used to process transactions for an LLMS_Order or an LLMS_Access_Plan.
*
* + The plan/order must exist
* + The gateway must exist.
* + The gateway must be enabled unless `$enabled_only` is `false`.
* + The gateway must support the order/plan's type (recurring or single).
*
* @since 7.0.0
* @since 7.5.0 Added check on whether a gateway can process a plan.
*
* @param string $gateway_id Payment gateway ID.
* @param LLMS_Order|LLMS_Access_Plan|int $plan_or_order The `WP_Post` id of a plan or order, a plan object, or an order object.
* @param boolean $wp_err Determines the return type when the gateway cannot be used.
* @param boolean $enabled_only If `true` requires the specified gateway to be enabled for use. This property
* exists to ensure the manual payment gateway can be used to record free transactions
* regardless of the gateway's status.
* @return boolean|WP_Error Returns `true` if the gateway can be used. If the gateway cannot be used, returns `false` if `$wp_error` is
* `false` and a `WP_Error` if `$wp_err` is `true`.
*/
function llms_can_gateway_be_used_for_plan_or_order( $gateway_id, $plan_or_order, $wp_err = false, $enabled_only = true ) {
$can_use = true;
$plan_or_order = is_numeric( $plan_or_order ) ? llms_get_post( $plan_or_order ) : $plan_or_order;
$err_data = compact( 'gateway_id', 'plan_or_order' );
$order = is_a( $plan_or_order, 'LLMS_Order' ) ? $plan_or_order : null;
$plan = ! $order && is_a( $plan_or_order, 'LLMS_Access_Plan' ) ? $plan_or_order : null;
if ( is_null( $order ) && is_null( $plan ) ) {
$can_use = new WP_Error( 'post-invalid', __( 'A valid order or access plan must be supplied.', 'lifterlms' ), $err_data );
} else {
$gateway = llms()->payment_gateways()->get_gateway_by_id( $gateway_id );
if ( ! $gateway ) {
$can_use = new WP_Error( 'gateway-invalid', __( 'The selected payment gateway is not valid.', 'lifterlms' ), $err_data );
} elseif ( $enabled_only && ! $gateway->is_enabled() ) {
$can_use = new WP_Error( 'gateway-disabled', __( 'The selected payment gateway is not available.', 'lifterlms' ), $err_data );
} elseif ( ! $gateway->can_process_access_plan( $plan, $order ) ) {
// Check whether the gateway can process the plan or the order's plan (which is the plan at the moment of the order's creation).
$can_use = new WP_Error( 'gateway-support-plan', __( 'The selected payment gateway is not available for the given plan.', 'lifterlms' ), $err_data );
} elseif ( $plan_or_order->is_recurring() && ! $gateway->supports( 'recurring_payments' ) ) {
$can_use = new WP_Error( 'gateway-support-recurring', __( 'The selected payment gateway does not support recurring payments.', 'lifterlms' ), $err_data );
} elseif ( ! $plan_or_order->is_recurring() && ! $gateway->supports( 'single_payments' ) ) {
$can_use = new WP_Error( 'gateway-support-single', __( 'The selected payment gateway does not support one-time payments.', 'lifterlms' ), $err_data );
}
}
/**
* Filters whether or not a gateway can be used for a given plan or order.
*
* @since 7.0.0
*
* @param boolean|WP_Error $can_be_used Whether or not the gateway can be used for the plan. This value will be `true`
* when the gateway can be used an an error object when it cannot.
* @param string $gateway_id The LLMS_Payment_Gateway ID.
* @param LLMS_Access_plan $plan The access plan object.
*/
$can_use = apply_filters( 'llms_can_gateway_be_used_for_plan_or_order', $can_use, $gateway_id, $plan_or_order );
return is_wp_error( $can_use ) && ! $wp_err ? false : $can_use;
}
/**
* Retrieve an LLMS Order ID by the associated order_key.
*
* @since 3.0.0
* @since 3.30.1 Return `null` instead of `false` when requesting an `LLMS_Order` return and no order could be found.
* @since 3.30.1 Return a real `int` (instead of a numeric string).
*
* @param string $key The order key.
* @param string $return Type of return, "order" for an instance of the LLMS_Order or "id" to return only the order ID.
* @return mixed `null` when no order found, LLMS_Order when `$return` = 'order', or the WP_Post ID as an `int`.
*/
function llms_get_order_by_key( $key, $return = 'order' ) {
global $wpdb;
$id = $wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM {$wpdb->prefix}postmeta WHERE meta_key = '_llms_order_key' AND meta_value = %s", $key ) ); // no-cache ok.
if ( $id && 'order' === $return ) {
return new LLMS_Order( $id );
}
// Return an int not a numeric string.
return $id ? absint( $id ) : $id;
}
/**
* Get the human readable status for a LifterLMS status.
*
* @since 3.0.0
* @since 3.6.0 Unknown.
*
* @param string $status LifterLMS Order Status.
* @return string
*/
function llms_get_order_status_name( $status ) {
$statuses = llms_get_order_statuses();
if ( is_array( $statuses ) && isset( $statuses[ $status ] ) ) {
$status = $statuses[ $status ];
}
return apply_filters( 'lifterlms_get_order_status_name', $status );
}
/**
* Retrieve an array of registered and available LifterLMS Order Post Statuses.
*
* @since 3.0.0
* @since 3.19.0 Unknown.
*
* @param string $order_type Filter statuses which are specific to the supplied order type, defaults to any statuses.
* @return array[]
*/
function llms_get_order_statuses( $order_type = 'any' ) {
$statuses = wp_list_pluck( LLMS_Post_Types::get_order_statuses(), 'label' );
// Remove types depending on order type.
switch ( $order_type ) {
case 'recurring':
unset( $statuses['llms-completed'] );
break;
case 'single':
unset( $statuses['llms-active'] );
unset( $statuses['llms-expired'] );
unset( $statuses['llms-on-hold'] );
unset( $statuses['llms-pending-cancel'] );
break;
}
/**
* Filters the order statuses.
*
* @since Unknown.
*
* @param array[] $statuses Array of order post status arrays.
* @param string $order_type The type of the order.
*/
return apply_filters( 'llms_get_order_statuses', $statuses, $order_type );
}
/**
* Get the possible statuses of a given order.
*
* @since 5.4.0
*
* @param LLMS_Order $order The LLMS_Order instance.
* @return array[]
*/
function llms_get_possible_order_statuses( $order ) {
$is_recurring = $order->is_recurring();
$statuses = llms_get_order_statuses( $is_recurring ? 'recurring' : 'single' );
// Limit the possible status for recurring orders whose product ID doesn't exist anymore.
if ( $is_recurring && ! llms_get_post( $order->get( 'product_id' ) ) ) {
unset( $statuses['llms-active'] );
unset( $statuses['llms-on-hold'] );
unset( $statuses['llms-pending'] );
unset( $statuses['llms-pending-cancel'] );
}
return $statuses;
}
/**
* Locates an order by email address and access plan ID.
*
* Used during AJAX checkout order creation when users are not created until the gateway confirms success.
*
* Ensures that only a single pending order for a given plan and email address will exist at any given time.
*
* @since 7.0.0
*
* @param string $email An email address.
* @param int $plan_id Access plan WP_Post ID.
* @return null|int Returns the post id if found, otherwise returns `null`.
*/
function llms_locate_order_for_email_and_plan( $email, $plan_id ) {
$query = new WP_Query(
array(
'post_type' => 'llms_order',
'post_status' => 'llms-pending',
'fields' => 'ids',
'posts_per_page' => 1,
'no_found_rows' => true,
'meta_query' => array(
'relation' => 'AND',
array(
'key' => '_llms_billing_email',
'value' => $email,
),
array(
'key' => '_llms_plan_id',
'value' => $plan_id,
),
),
)
);
return $query->posts[0] ?? null;
}
/**
* Find an existing order for a given plan by a given user.
*
* @since 3.30.1
*
* @param int $user_id The WP_User ID.
* @param int $plan_id The Access Plan post ID.
* @return mixed null if no order found, WP_Post ID as an int if found
*/
function llms_locate_order_for_user_and_plan( $user_id, $plan_id ) {
global $wpdb;
// Query.
$id = $wpdb->get_var(
$wpdb->prepare(
"SELECT ID FROM {$wpdb->prefix}posts AS p
JOIN {$wpdb->prefix}postmeta AS pm_user ON pm_user.post_id = p.ID AND pm_user.meta_key = '_llms_user_id'
JOIN {$wpdb->prefix}postmeta AS pm_plan ON pm_plan.post_id = p.ID AND pm_plan.meta_key = '_llms_plan_id'
WHERE p.post_type = 'llms_order'
AND pm_user.meta_value = %d
AND pm_plan.meta_value = %d
;",
$user_id,
$plan_id
)
); // db-cache ok.
// Return an int not a numeric string.
return $id ? absint( $id ) : $id;
}
/**
* Setup a pending order which can be passed to an LLMS_Payment_Gateway for processing.
*
* @since 3.29.0
* @since 4.2.0 Prevent double displaying a notice to already enrolled students in the product being purchased.
* @since 4.21.1 Sanitize coupon code prior to outputting it in error messages.
* @since 5.0.0 Use `llms_update_user()` instead of deprecated `LLMS_Person_Handler::update()`.
*
* @param array $data {
* Data used to create a pending order.
*
* @type int plan_id (Required) LLMS_Access_Plan ID.
* @type array customer (Required). Array of customer information formatted to be passed to `LLMS_Person_Handler::update()` or `llms_register_user()`
* @type string agree_to_terms (Required if `llms_are_terms_and_conditions_required()` are required) If terms & conditions are required this should be "yes" for agreement.
* @type string payment_gateway (Optional) ID of a registered LLMS_Payment_Gateway which will be used to process the order.
* @type string coupon_code (Optional) Coupon code to be applied to the order.
* }
* @return array
*/
function llms_setup_pending_order( $data = array() ) {
/**
* Filters the order data before setting up the pending order.
*
* @since Unknown.
*
* @param array $data Array of input data from a checkout form.
*/
$data = apply_filters( 'llms_before_setup_pending_order', $data );
// Request keys that can be submitted with or without the `llms_` prefix.
$keys = array(
'llms_agree_to_terms',
'llms_coupon_code',
'llms_plan_id',
);
foreach ( $keys as $key ) {
if ( isset( $data[ $key ] ) ) {
$data[ str_replace( 'llms_', '', $key ) ] = $data[ $key ];
}
}
$err = new WP_Error();
// Check t & c if configured.
if ( llms_are_terms_and_conditions_required() ) {
if ( ! isset( $data['agree_to_terms'] ) || ! llms_parse_bool( $data['agree_to_terms'] ) ) {
$err->add( 'terms-violation', sprintf( __( 'You must agree to the %s to continue.', 'lifterlms' ), get_the_title( get_option( 'lifterlms_terms_page_id' ) ) ) );
return $err;
}
}
// We must have a plan_id to proceed.
if ( empty( $data['plan_id'] ) ) {
$err->add( 'missing-plan-id', __( 'Missing an Access Plan ID.', 'lifterlms' ) );
return $err;
}
// Validate the plan is a real plan.
$plan = llms_get_post( absint( $data['plan_id'] ) );
if ( ! $plan || 'llms_access_plan' !== $plan->get( 'type' ) ) {
$err->add( 'invalid-plan-id', __( 'Invalid Access Plan ID.', 'lifterlms' ) );
return $err;
}
// Used later.
$coupon_id = null;
$coupon = false;
// If a coupon is being used, validate it.
if ( ! empty( $data['coupon_code'] ) ) {
$data['coupon_code'] = sanitize_text_field( $data['coupon_code'] );
$coupon_id = llms_find_coupon( $data['coupon_code'] );
// Coupon couldn't be found.
if ( ! $coupon_id ) {
$err->add( 'coupon-not-found', sprintf( __( 'Coupon code "%s" not found.', 'lifterlms' ), $data['coupon_code'] ) );
return $err;
}
// Coupon is real, make sure it's valid for the current plan.
$coupon = llms_get_post( $coupon_id );
$valid = $coupon->is_valid( $data['plan_id'] );
// If the coupon has a validation error, return an error message.
if ( is_wp_error( $valid ) ) {
$err->add( 'invalid-coupon', $valid->get_error_message() );
return $err;
}
}
// If payment is required, verify we have a gateway.
if ( $plan->requires_payment( $coupon_id ) && empty( $data['payment_gateway'] ) ) {
$err->add( 'missing-gateway-id', __( 'No payment method selected.', 'lifterlms' ) );
return $err;
}
$gateway_id = empty( $data['payment_gateway'] ) ? 'manual' : $data['payment_gateway'];
$gateway_error = llms_can_gateway_be_used_for_plan( $gateway_id, $plan );
if ( is_wp_error( $gateway_error ) ) {
return $gateway_error;
}
if ( empty( $data['customer'] ) ) {
$err->add( 'missing-customer', __( 'Missing customer information.', 'lifterlms' ) );
return $err;
}
// Update the customer.
if ( ! empty( $data['customer']['user_id'] ) ) {
$person_id = llms_update_user( $data['customer'], 'checkout', compact( 'plan' ) );
} else {
$person_id = llms_register_user( $data['customer'], 'checkout', true, compact( 'plan' ) );
}
// Validation or registration issues.
if ( is_wp_error( $person_id ) ) {
return $person_id;
}
// This will likely never actually happen unless there's something very strange afoot.
if ( ! is_numeric( $person_id ) ) {
$err->add( 'account-creation', __( 'An unknown error occurred when attempting to create an account, please try again.', 'lifterlms' ) );
return $err;
}
// Ensure the new user isn't enrolled in the product being purchased.
/**
* Filter to allow checkout if already enrolled.
*
* @param bool $block_checkout Whether to block checkout if already enrolled.
* @param LLMS_Access_Plan $plan The access plan.
*
* @since 9.1.2
*/
if ( llms_is_user_enrolled( $person_id, $plan->get( 'product_id' ) ) && apply_filters( 'llms_checkout_block_enrolled_checkout', true, $plan ) ) {
$product = $plan->get_product();
$err->add(
'already-enrolled',
sprintf(
// Translators: %2$s = The product type (course/membership); %1$s = product permalink.
__( 'You already have access to this %2$s! Visit your dashboard <a href="%1$s">here.</a>', 'lifterlms' ),
llms_get_page_url( 'myaccount' ),
$product->get_post_type_label()
)
);
// Prevent double displaying a notice to already enrolled students in the product being purchased.
add_filter( 'llms_display_checkout_form_enrolled_students_notice', '__return_false' );
return $err;
}
$person = llms_get_student( $person_id );
$gateway = llms()->payment_gateways()->get_gateway_by_id( $gateway_id );
/**
* Filter the return of pending order setup data.
*
* @since 3.30.1
*
* @param array $setup {
* Data used to create the pending order.
*
* @type LLMS_Student $person Student object.
* @type LLMS_Access_Plan $plan Access plan object.
* @type LLMS_Payment_Gateway $gateway Instance of the selected gateway.
* @type LLMS_Coupon|false $coupon Coupon object or false if none used.
* }
* @param array $data Array of input data from a checkout form.
*/
return apply_filters( 'llms_after_setup_pending_order', compact( 'person', 'plan', 'gateway', 'coupon' ), $data );
}
================================================
FILE: includes/functions/llms.functions.page.php
================================================
<?php
/**
* Page functions.
*
* @package LifterLMS/Functions
*
* @since 1.0.0
* @version 6.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Get url for when user cancels payment.
*
* @since 1.0.0
*
* @return string
*/
function llms_cancel_payment_url() {
$cancel_payment_url = esc_url( get_permalink( llms_get_page_id( 'checkout' ) ) );
return apply_filters( 'lifterlms_checkout_confirm_payment_url', $cancel_payment_url );
}
/**
* Get url for redirect when user confirms payment.
*
* @since 1.0.0
* @since 3.38.0 Added redirect query string parameter.
* @since 5.9.0 Avoid passing `null` to `urldecode()` when no redirect is set in the `$_GET` array.
*
* @return string
*/
function llms_confirm_payment_url( $order_key = null ) {
$args = array();
if ( $order_key ) {
$args['order'] = $order_key;
}
$redirect = llms_filter_input( INPUT_GET, 'redirect', FILTER_VALIDATE_URL );
if ( $redirect ) {
$args['redirect'] = rawurlencode( urldecode( $redirect ) );
}
$url = llms_get_endpoint_url( 'confirm-payment', '', get_permalink( llms_get_page_id( 'checkout' ) ) );
if ( $args ) {
$url = add_query_arg( $args, $url );
}
/**
* Filter the checkout confirmation URL.
*
* @since 1.0.0
*
* @param string $url URL to the payment confirmation screen.
*/
return apply_filters( 'lifterlms_checkout_confirm_payment_url', $url );
}
/**
* Retrieve the full URL to a LifterLMS endpoint.
*
* @since 1.0.0
* @since 3.26.3 Unknown.
* @since 5.9.0 Update to ensure the generated URL has (or doesn't have) a trailing slash based on the site's permalink settings.
* @since 6.3.0 Try to build the correct URL even when `get_permalink()` returns an empty string (e.g. in BuddyPress profile endpoints).
* Prefer faster `strpos()` over `strstr()` since we only need to know if a substring is contained in a string.
*
* @param string $endpoint ID of the endpoint, eg "view-courses".
* @param string $value Endpoint query parameter value.
* @param string $permalink Base URL to append the endpoint to. Optional, uses the current page when not supplied.
* @return string
*/
function llms_get_endpoint_url( $endpoint, $value = '', $permalink = '' ) {
// Map endpoint to options.
$vars = llms()->query->get_query_vars();
$endpoint = $vars[ $endpoint ] ?? $endpoint;
/**
* In our dashboard endpoints, get_permalink() always returns the dashboard page permalink:
* something like https://example.com/dashboard/
* which is the base URL to append the endpoint to.
*/
$permalink = $permalink ? $permalink : get_permalink();
$is_base_permalink = true;
/**
* No permalink available, e.g. in BuddyPress profile endpoint.
*
* We need to get the base URL to append the endpoint to, starting from
* the current requested URL.
*/
if ( ! $permalink && ! empty( $_SERVER['REQUEST_URI'] ) ) {
$permalink = home_url( filter_var( wp_unslash( $_SERVER['REQUEST_URI'] ), FILTER_SANITIZE_URL ) );
$is_base_permalink = false;
}
if ( get_option( 'permalink_structure' ) ) {
$query_string = '';
if ( false !== strpos( $permalink, '?' ) ) {
$query_string = '?' . wp_parse_url( $permalink, PHP_URL_QUERY );
$permalink = current( explode( '?', $permalink ) );
}
/**
* Normalize the permalink when not referring to the base URL.
*/
if ( ! $is_base_permalink ) {
$permalink = _llms_normalize_endpoint_base_url( $permalink, $endpoint );
}
$url = trailingslashit( $permalink );
if ( $value ) {
$url .= trailingslashit( $endpoint ) . user_trailingslashit( $value );
} else {
$url .= user_trailingslashit( $endpoint );
}
$url .= $query_string;
} else {
$url = add_query_arg( $endpoint, $value, $permalink );
}
/**
* Filter the final endpoint URL.
*
* @since 1.0.0
* @since 5.9.0 Added `$value` and `$permalink` parameters.
*
* @param string $url The endpoint URL.
* @param string $endpoint ID of the endpoint.
* @param string $value Endpoint query parameter value.
* @param string $permalink Base URL to append the endpoint to. Optional, uses the current page when not supplied.
*/
return apply_filters( 'lifterlms_get_endpoint_url', $url, $endpoint, $value, $permalink );
}
/**
* Normalize the endpoint base URL.
*
* E.g., in the BuddyPress profile's tab, on my grades, page 2, it'll look like
* //example.com/members/admin/courses/my-courses/page/2/
*
* We then need to normalize the endpoint base URL, which means
* removing /my-courses/ (the endpoint) and the pagination information /page/2/.
*
* @since 6.3.0
* @access private
*
* @param string $url URL to extract the Base URL, to append the endpoint to, from.
* @param string $endpoint Slug of the endpoint, eg "my-courses".
* @return string
*/
function _llms_normalize_endpoint_base_url( $url, $endpoint ) {
$_url = untrailingslashit( $url );
// Remove pagination.
global $wp_rewrite;
$page = llms_get_paged_query_var();
$pagination = '/' . $wp_rewrite->pagination_base . '/' . $page;
if ( $page > 1 && substr( $_url, -1 * strlen( $pagination ) ) === $pagination ) { // PHP8: str_ends_with(string $haystack, string $needle).
$_url = substr( $_url, 0, -1 * strlen( $pagination ) );
}
// Remove the endpoint slug from the URL if it's its last part.
if ( substr( $_url, -1 * strlen( $endpoint ) ) === $endpoint ) { // PHP8: str_ends_with(string $haystack, string $needle).
$url = substr( $_url, 0, -1 * strlen( $endpoint ) );
}
return $url;
}
/**
* Retrieve the WordPress Page ID of a LifterLMS Core Page.
*
* Available core pages are:
* + checkout (formerly "shop")
* + courses (Course catalog)
* + myaccount (Student Dashboard)
* + memberships (Membership catalog)
*
* @since 1.0.0
*
* @param string $page The page slug/name.
* @return int The WP_Post ID of the page or -1 if the page is not found.
*/
function llms_get_page_id( $page ) {
// Normalize some pages to make more sense without having to migrate options.
if ( 'courses' === $page ) {
$page = 'shop';
}
$id = get_option( 'lifterlms_' . $page . '_page_id' );
/**
* Filter the ID of the requested LifterLMS Page.
*
* The dynamic portion of this filter, {$page}, refers to the LifterLMS page slug/name.
*
* Note that, historically, the course catalog was called the "shop" and therefore when requesting
* the filter will be "lifterlms_get_shop_page_id" instead of "lifterlms_get_courses_page_id".
*
* @since 1.0.0
*
* @param int|string $id The WP_Post ID of the requested page or an empty string if the page doesn't exist.
*/
$page = apply_filters( "lifterlms_get_{$page}_page_id", $id );
return $page ? absint( $page ) : -1;
}
/**
* Retrieve the URL for a LifterLMS Page.
*
* EG: 'checkout', 'memberships', 'myaccount', 'courses' etc...
*
* @since 3.0.0
*
* @param string $page Name of the page.
* @param array $args Optional array of query arguments that can be passed to add_query_arg().
* @return string
*/
function llms_get_page_url( $page, $args = array() ) {
$url = add_query_arg( $args, get_permalink( llms_get_page_id( $page ) ) );
return $url ? $url : '';
}
/**
* Returns the url to the lost password endpoint url.
*
* @since Unknown
*
* @return string
*/
function llms_lostpassword_url( $lostpassword_url ) {
if ( llms_get_page_id( 'myaccount' ) <= 0 || ! get_permalink( llms_get_page_id( 'myaccount' ) ) ) {
return $lostpassword_url;
}
return llms_get_endpoint_url( 'lost-password', '', get_permalink( llms_get_page_id( 'myaccount' ) ) );
}
add_filter( 'lostpassword_url', 'llms_lostpassword_url', 10, 1 );
/**
* Returns the page number query var for the current request.
*
* `paged`:
* Used on the homepage, blogpage, archive pages and pages to calculate pagination.
* 1st page is 0 and from there the number correspond to the page number
* `page`:
* Used on a static front page and single pages for pagination (`<!--nextpage-->`).
* Pagination on these pages works the same, a static front page is treated as single page on pagination.
*
* @since 6.3.0
*
* @return int
*/
function llms_get_paged_query_var() {
if ( get_query_var( 'paged' ) ) {
$paged = get_query_var( 'paged' );
} elseif ( get_query_var( 'page' ) ) {
$paged = get_query_var( 'page' );
} else {
$paged = 1;
}
return (int) $paged;
}
================================================
FILE: includes/functions/llms.functions.person.php
================================================
<?php
/**
* Person Functions
*
* Functions for managing users in the LifterLMS system.
*
* @package LifterLMS/Functions
*
* @since 1.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Determines whether or not a user can bypass enrollment, drip, and prerequisite restrictions.
*
* @since 3.7.0
* @since 3.9.0 Unknown.
* @since 5.9.0 Added optional second parameter `$post_id`.
*
* @param LLMS_Student|WP_User|int $user LLMS_Student, WP_User, or WP User ID, if none supplied get_current_user() will be used.
* @param integer $post_id A WP_Post ID to check permissions against. If supplied, in addition to the user's role
* being allowed to bypass the restrictions, the user must also have `edit_post` capabilities
* for the requested post.
* @return bool
*/
function llms_can_user_bypass_restrictions( $user = null, $post_id = null ) {
$user = llms_get_student( $user );
if ( ! $user ) {
return false;
}
$roles = get_option( 'llms_grant_site_access', '' );
if ( ! $roles ) {
$roles = array();
}
if ( ! array_intersect( $user->get_user()->roles, $roles ) ) {
return false;
}
if ( $post_id && ! user_can( $user->get( 'id' ), 'edit_post', $post_id ) ) {
return false;
}
return true;
}
/**
* Checks LifterLMS user capabilities against an object
*
* @since 3.13.0
* @since 4.5.0 Use strict array comparison.
*
* @param string $cap Capability name.
* @param int $obj_id WP_Post or WP_User ID.
* @return bool
*/
function llms_current_user_can( $cap, $obj_id = null ) {
$caps = LLMS_Roles::get_all_core_caps();
$grant = false;
if ( in_array( $cap, $caps, true ) ) {
// If the user has the cap, maybe do some additional checks.
if ( current_user_can( $cap ) ) {
switch ( $cap ) {
case 'view_lifterlms_reports':
// Can view others reports so its okay.
if ( current_user_can( 'view_others_lifterlms_reports' ) ) {
$grant = true;
// Can only view their own reports check if the student is their instructor.
} elseif ( $obj_id ) {
$instructor = llms_get_instructor();
$student = llms_get_student( $obj_id );
if ( $instructor && $student ) {
foreach ( $instructor->get_posts(
array(
'posts_per_page' => -1,
),
'ids'
) as $id ) {
if ( $student->get_enrollment_status( $id ) ) {
$grant = true;
break;
}
}
}
}
break;
// No other checks needed.
default:
$grant = true;
}
}
}
/**
* Filters whether or not the current user can perform the requested action
*
* The dynamic portion of this hook, `$cap`, refers to the requested user capability.
*
* @since 3.13.0
*
* @param bool $grant Whether or not the requested capability is granted to the user.
* @param int $obj_id WP_Post or WP_User ID.
*/
return apply_filters( "llms_current_user_can_{$cap}", $grant, $obj_id );
}
/**
* Delete LifterLMS Student's Enrollment record related to a given product.
*
* @since 3.33.0
*
* @see `LLMS_Student->delete_enrollment()` the class method wrapped by this function.
*
* @param int $user_id WP User ID.
* @param int $product_id WP Post ID of the Course or Membership.
* @param string $trigger Optional. Only delete the student enrollment if the original enrollment trigger matches the submitted value.
* Passing "any" will remove regardless of enrollment trigger.
* @return bool Whether or not the enrollment records have been successfully removed.
*/
function llms_delete_student_enrollment( $user_id, $product_id, $trigger = 'any' ) {
$student = new LLMS_Student( $user_id );
return $student->delete_enrollment( $product_id, $trigger );
}
/**
* Disables admin bar on front end
*
* @since 1.0.0
* @since 3.27.0 Unknown
*
* @param bool $show_admin_bar default value (true).
* @return bool
*/
function llms_disable_admin_bar( $show_admin_bar ) {
/**
* Filter whether or not the WP Admin Bar is disabled for users
*
* By default, the admin bar is disabled for all users except those with the `edit_posts` or `manage_lifterlms` capabilities.
*
* @since Unknown
*
* @param bool $disabled Whether or not the admin bar should be disabled.
*/
if ( apply_filters( 'lifterlms_disable_admin_bar', true ) && ! ( current_user_can( 'edit_posts' ) || current_user_can( 'manage_lifterlms' ) ) ) {
$show_admin_bar = false;
}
return $show_admin_bar;
}
add_filter( 'show_admin_bar', 'llms_disable_admin_bar', 10 );
/**
* Enroll a WordPress user in a course or membership
*
* @since 2.2.3
* @since 3.0.0 Added `$trigger` parameter.
*
* @see LLMS_Student->enroll() the class method wrapped by this function
*
* @param int $user_id WP User ID.
* @param int $product_id WP Post ID of the Course or Membership.
* @param string $trigger String describing the event that triggered the enrollment.
* @return bool
*/
function llms_enroll_student( $user_id, $product_id, $trigger = 'unspecified' ) {
$student = new LLMS_Student( $user_id );
return $student->enroll( $product_id, $trigger );
}
/**
* Get an LLMS_Instructor
*
* @since 3.13.0
*
* @param mixed $user WP_User ID, instance of WP_User, or instance of any instructor class extending this class.
* @return LLMS_Instructor|false LLMS_Instructor instance on success, false if user not found
*/
function llms_get_instructor( $user = null ) {
$student = new LLMS_Instructor( $user );
return $student->exists() ? $student : false;
}
/**
* Retrieve the translated name of minimum accepted password strength for student passwords
*
* @since 3.0.0
* @since 5.0.0 Remove database call to deprecated option and add the $strength parameter.
*
* @param string $strength Optional. Password strength value to translate. Default is 'strong'.
* @return string
*/
function llms_get_minimum_password_strength_name( $strength = 'strong' ) {
$opts = array(
'strong' => __( 'strong', 'lifterlms' ),
'medium' => __( 'medium', 'lifterlms' ),
'weak' => __( 'weak', 'lifterlms' ),
'very-weak' => __( 'very weak', 'lifterlms' ),
);
$name = isset( $opts[ $strength ] ) ? $opts[ $strength ] : $strength;
/**
* Filter the name of the password strength
*
* The dynamic portion of this hook, `$strength`, can be either "strong", "medium", "weak" or "very-weak".
*
* @since 5.0.0
*
* @param $string $name Translated name of the password strength value.
*/
return apply_filters( 'llms_get_minimum_password_strength_name_' . $strength, $name );
}
/**
* Get an LLMS_Student.
*
* @since 3.8.0
* @since 3.9.0 Unknown
* @since 7.1.0 Added the `$autoload` parameter.
*
* @param mixed $user WP_User ID, instance of WP_User, or instance of any student class extending this class.
* @param bool $autoload If `true` and `$user` input is empty, the user will be loaded from `get_current_user_id()`.
* If `$user` is not empty then this parameter has no impact.
* @return LLMS_Student|false LLMS_Student instance on success, false if user not found.
*/
function llms_get_student( $user = null, $autoload = true ) {
$student = new LLMS_Student( $user, $autoload );
return $student->exists() ? $student : false;
}
/**
* Retrieve a list of disallowed usernames.
*
* @since 5.0.0
* @since 6.0.0 Removed the deprecated `llms_usernames_blacklist` filter hook.
*
* @return string[]
*/
function llms_get_usernames_blocklist() {
$list = array( 'admin', 'test', 'administrator', 'password', 'testing' );
/**
* Modify the list of disallowed usernames
*
* If a user attempts to create a new account with any username found in this list they will receive an error and will not
* be able to register the account.
*
* @since 5.0.0
*
* @param string[] $list List of banned usernames.
*/
return apply_filters( 'llms_usernames_blocklist', $list );
}
/**
* Checks if user is currently enrolled in cours
*
* @since Unknown
* @since 3.3.1 Updated to use `LLMS_Student->is_enrolled()`.
*
* @see LLMS_Student->is_complete()
*
* @param int $user_id WP User ID of the user.
* @param int $object_id WP Post ID of a Course, Section, or Lesson.
* @param int $object_type Type, either Course, Section, or Lesson.
* @return bool Returns `true` if complete, otherwise `false`.
*/
function llms_is_complete( $user_id, $object_id, $object_type = 'course' ) {
$s = new LLMS_Student( $user_id );
return $s->is_complete( $object_id, $object_type );
}
/**
* Checks if user is currently enrolled courses, sections, lessons, or memberships.
*
* @since Unknown
* @since 3.25.0 Unknown.
* @since 7.1.0 From now on this function will always return false for non existing users,
* e.g. deleted users.
*
* @see LLMS_Student->is_enrolled()
*
* @param int $user_id WP_User ID.
* @param int|int[] $product_id WP Post ID of a Course, Lesson, or Membership or array of multiple IDs.
* @param string $relation Comparator for enrollment check.
* All = user must be enrolled in all $product_ids.
* Any = user must be enrolled in at least one of the $product_ids.
* @param bool $use_cache If true, returns cached data if available, if false will run a db query.
* @return bool
*/
function llms_is_user_enrolled( $user_id, $product_id, $relation = 'all', $use_cache = true ) {
$student = new LLMS_Student( $user_id );
return $student->exists() ?
$student->is_enrolled( $product_id, $relation, $use_cache ) :
false;
}
/**
* Mark a lesson, section, course, or track as complete
*
* @since 3.3.1
*
* @see LLMS_Student->mark_complete()
*
* @param int $user_id WP User ID.
* @param int $object_id WP Post ID of the Lesson, Section, Track, or Course.
* @param string $object_type Object type [lesson|section|course|track].
* @param string $trigger String describing the event that triggered marking the object as complete.
* @return bool
*/
function llms_mark_complete( $user_id, $object_id, $object_type, $trigger = 'unspecified' ) {
$student = new LLMS_Student( $user_id );
return $student->mark_complete( $object_id, $object_type, $trigger );
}
/**
* Mark a lesson, section, course, or track as incomplete
*
* @since 3.5.0
*
* @see LLMS_Student->mark_incomplete()
*
* @param int $user_id WP User ID.
* @param int $object_id WP Post ID of the Lesson, Section, Track, or Course.
* @param string $object_type Object type [lesson|section|course|track].
* @param string $trigger String describing the event that triggered marking the object as incomplete.
* @return bool
*/
function llms_mark_incomplete( $user_id, $object_id, $object_type, $trigger = 'unspecified' ) {
$student = new LLMS_Student( $user_id );
return $student->mark_incomplete( $object_id, $object_type, $trigger );
}
/**
* Mark an object as favorite.
*
* @since 7.5.0
*
* @see LLMS_Student->mark_favorite()
*
* @param int $user_id WP User ID.
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @param string $object_type The object type, currently only 'lesson'.
* @return bool
*/
function llms_mark_favorite( $user_id, $object_id, $object_type ) {
$student = new LLMS_Student( $user_id );
return $student->mark_favorite( $object_id, $object_type );
}
/**
* Mark a lesson as unfavorite.
*
* @since 7.5.0
*
* @see LLMS_Student->mark_unfavorite()
*
* @param int $user_id WP User ID.
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @param string $object_type The object type, currently only 'lesson'.
* @return bool
*/
function llms_mark_unfavorite( $user_id, $object_id, $object_type ) {
$student = new LLMS_Student( $user_id );
return $student->mark_unfavorite( $object_id, $object_type );
}
/**
* Parses the password reset cookie.
*
* This is the cookie set when a user uses the password reset link found in a reset password email. The query string
* vars in the link (user login and reset key) are parsed and stored in this cookie.
*
* @since 5.0.0
* @since 5.1.2 Fixed typos in error messages.
*
* @return array|WP_Error On success, returns an associative array containing the keys "key" and "login", on error
* returns a WP_Error.
*/
function llms_parse_password_reset_cookie() {
if ( ! isset( $_COOKIE[ 'wp-resetpass-' . COOKIEHASH ] ) ) {
return new WP_Error( 'llms_password_reset_no_cookie', __( 'The password reset key could not be found. Please reset your password again if needed.', 'lifterlms' ) );
}
$parsed = array_map( 'sanitize_text_field', explode( ':', wp_unslash( $_COOKIE[ 'wp-resetpass-' . COOKIEHASH ] ), 2 ) ); // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
if ( 2 !== count( $parsed ) ) {
return new WP_Error( 'llms_password_reset_invalid_cookie', __( 'The password reset key is in an invalid format. Please reset your password again if needed.', 'lifterlms' ) );
}
$uid = $parsed[0];
$key = $parsed[1];
$user = get_user_by( 'ID', $uid );
$login = $user ? $user->user_login : '';
$user = check_password_reset_key( $key, $login );
if ( is_wp_error( $user ) ) {
// Error code is either "llms_password_reset_invalid_key" or "llms_password_reset_expired_key".
return new WP_Error( sprintf( 'llms_password_reset_%s', $user->get_error_code() ), __( 'This password reset key is invalid or has already been used. Please reset your password again if needed.', 'lifterlms' ) );
}
// Success.
return compact( 'key', 'login' );
}
/**
* Register a new user
*
* @since 3.0.0
* @since 5.0.0 Use `LLMS_Form_Handler()` for registration.
*
* @param array $data Array of registration data.
* @param string $screen The screen to be used for the validation template, accepts "registration" or "checkout".
* @param bool $signon If true, signon the newly created user.
* @param array $args Additional arguments passed to the short-circuit filter.
* @return int|WP_Error
*/
function llms_register_user( $data = array(), $screen = 'registration', $signon = true, $args = array() ) {
$user_id = LLMS_Form_Handler::instance()->submit( $data, $screen, $args );
if ( is_wp_error( $user_id ) ) {
return $user_id;
}
// Signon.
if ( $signon && ! empty( $data['password'] ) ) {
$user = get_user_by( 'ID', $user_id );
/**
* Filters whether or not a new user should be "remembered" when signing on during account creation
*
* @since 5.0.0
*
* @param bool $remember If `true` (default), the user signon will be set to "remember".
* @param string $screen Current validation template, either "registration" or "checkout".
* @param WP_User $user User object for the newly registered user.
*/
$remember = apply_filters( 'llms_user_registration_remember', true, $screen, $user );
wp_signon(
array(
'user_login' => $user->user_login,
'user_password' => $data['password'],
'remember' => $remember,
),
is_ssl()
);
}
return $user_id;
}
/**
* Set or unset a user's password reset cookie.
*
* @since 5.0.0
*
* @param string $val Cookie value.
* @return bool
*/
function llms_set_password_reset_cookie( $val = '' ) {
$cookie = sprintf( 'wp-resetpass-%s', COOKIEHASH );
$expires = $val ? 0 : time() - YEAR_IN_SECONDS;
$path = isset( $_SERVER['REQUEST_URI'] ) ? current( explode( '?', wp_unslash( $_SERVER['REQUEST_URI'] ) ) ) : ''; // phpcs:ignore WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
return llms_setcookie( $cookie, $val, $expires, $path, COOKIE_DOMAIN, is_ssl(), true );
}
/**
* Set/Update user login time
*
* @since 4.5.0
*
* @param string $user_login Username.
* @param WP_User $user WP_User object of the logged-in user.
* @return void
*/
function llms_set_user_login_time( $user_login, $user ) {
update_user_meta( $user->ID, 'llms_last_login', llms_current_time( 'mysql' ) );
}
add_action( 'wp_login', 'llms_set_user_login_time', 10, 2 );
/**
* Remove a LifterLMS Student from a course or membership
*
* @since 3.0.0
*
* @see LLMS_Student->unenroll() the class method wrapped by this function
*
* @param int $user_id WP User ID.
* @param int $product_id WP Post ID of the Course or Membership.
* @param string $new_status The value to update the new status with after removal is complete.
* @param string $trigger Only remove the student if the original enrollment trigger matches the submitted value.
* Passing "any" will remove regardless of enrollment trigger.
* @return bool
*/
function llms_unenroll_student( $user_id, $product_id, $new_status = 'expired', $trigger = 'any' ) {
$student = new LLMS_Student( $user_id );
return $student->unenroll( $product_id, $trigger, $new_status );
}
/**
* Update a user.
*
* @since 3.0.0
* @since 3.7.0 Unknown.
* @since 5.0.0 Updated to utilize LLMS_Form_Handler class.
*
* @param array $data Array of user data.
* @param string $location (Optional) screen to perform validations for, accepts "account" or "checkout". Default value: 'account'
* @param array $args Additional arguments passed to the short-circuit filter.
* @return int|WP_Error WP_User ID on success or error object on failure.
*/
function llms_update_user( $data = array(), $location = 'account', $args = array() ) {
return LLMS_Form_Handler::instance()->submit( $data, $location, $args );
}
/**
* Performs validations for submitted user data.
*
* The related functions `llms_update_user()` and `llms_register_user()` automatically perform validations so this method
* should only be used if you wish to test updates / registration without actually performing the registration or update action.
*
* @since 7.0.0
*
* @param array $data Array of user data.
* @param string $location (Optional) screen to perform validations for, accepts "account" or "checkout". Default value: 'checkout'
* @param array $args Additional arguments passed to the short-circuit filter.
* @return bool|WP_Error Returns `true` if the user data passes validation, otherwise returns an error object describing
* the validation issues.
*/
function llms_validate_user( $data = array(), $location = 'checkout', $args = array() ) {
$args['validate_only'] = true;
return LLMS_Form_Handler::instance()->submit( $data, $location, $args );
}
================================================
FILE: includes/functions/llms.functions.privacy.php
================================================
<?php
/**
* Functions related to privacy policy and terms & conditions
*
* @package LifterLMS/Functions
*
* @since 3.18.0
* @version 3.18.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Determine if Terms & Conditions agreement is required during registration according to global settings
*
* @since 3.0.0
* @since 3.3.1 Unknown.
*
* @return boolean
*/
function llms_are_terms_and_conditions_required() {
$enabled = get_option( 'lifterlms_registration_require_agree_to_terms' );
$page_id = absint( get_option( 'lifterlms_terms_page_id', false ) );
return ( 'yes' === $enabled && $page_id );
}
/**
* Retrieve the text/html for the custom privacy policy notice
*
* @since 3.18.0
*
* @param bool $merge If true, will merge {{policy}} to an HTML anchor.
* Uses `wp_page_for_privacy_policy` for page ID & title.
* @return string
*/
function llms_get_privacy_notice( $merge = false ) {
$text = get_option( 'llms_privacy_notice', esc_html__( 'Your personal data will be used to process your enrollment, support your experience on this website, and for other purposes described in our {{policy}}.', 'lifterlms' ) );
$ret = $text;
// Merge the {{policy}} code.
if ( $merge ) {
// Only merge if we some text saved & a page set.
if ( $text && get_option( 'wp_page_for_privacy_policy', false ) ) {
$ret = str_replace( '{{policy}}', llms_get_option_page_anchor( 'wp_page_for_privacy_policy' ), $ret );
// Otherwise return empty string.
} else {
$ret = '';
}
$ret = wp_kses(
$ret,
array(
'a' => array(
'href' => array(),
'target' => array(),
),
'b' => array(),
'em' => array(),
'i' => array(),
'strong' => array(),
)
);
}
return apply_filters( 'llms_get_privacy_notice', $ret, $text );
}
/**
* Retrieve the text/html for the custom t&c notice
*
* @since 3.18.0
*
* @param bool $merge If true, will merge {{terms}} to an HTML anchor.
* Uses `lifterlms_terms_page_id` for page ID & title
* @return string
*/
function llms_get_terms_notice( $merge = false ) {
// Get the option.
$text = get_option( 'llms_terms_notice' );
// Fallback to default if no option set.
if ( ! $text ) {
$text = esc_html__( 'I have read and agree to the {{terms}}.', 'lifterlms' );
}
$ret = $text;
// Merge the {{terms}} code.
if ( $merge ) {
// Only merge if we have a page set.
if ( get_option( 'lifterlms_terms_page_id', false ) ) {
$ret = str_replace( '{{terms}}', llms_get_option_page_anchor( 'lifterlms_terms_page_id' ), $ret );
// Otherwise return empty string.
} else {
$ret = '';
}
$ret = wp_kses(
$ret,
array(
'a' => array(
'href' => array(),
'target' => array(),
),
'b' => array(),
'em' => array(),
'i' => array(),
'strong' => array(),
)
);
}
return apply_filters( 'llms_get_terms_notice', $ret, $text );
}
================================================
FILE: includes/functions/llms.functions.quiz.php
================================================
<?php
/**
* LifterLMS Quiz Functions.
*
* @package LifterLMS/Functions
*
* @since 3.16.0
* @version 5.3.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Retrieve the number of columns needed for a picture choice question.
*
* @since 3.16.0
*
* @param int $num_choices Number of choices.
* @return int
*/
function llms_get_picture_choice_question_cols( $num_choices ) {
/**
* Allow 3rd parties to override this function with a custom number of columns.
*
* If this responds with a non null will bypass column counter function return it immediately
*
* @since 3.16.0
*
* @param null|int $cols Number of columns needed for a picture choice question.
* @param int $num_choices Number of choices.
*/
$cols = apply_filters( 'llms_get_picture_choice_question_cols', null, $num_choices );
if ( 1 === $num_choices ) {
$cols = 1;
} elseif ( $num_choices >= 25 ) {
$cols = 5;
} elseif ( $num_choices >= 10 ) {
$max_cols = 5;
$min_cols = 3;
} else {
$max_cols = 4;
$min_cols = 2;
}
if ( is_null( $cols ) ) {
$i = $max_cols;
while ( $i >= $min_cols ) {
if ( 0 === $num_choices % $i ) {
$cols = $i;
break;
}
$i--;
}
if ( ! $cols ) {
$cols = llms_get_picture_choice_question_cols( $num_choices + 1 );
}
}
/** This filter is documented above */
return apply_filters( 'llms_get_picture_choice_question_cols', $cols, $num_choices );
}
/**
* Retrieve data for a single question type.
*
* @since 3.16.0
*
* @param string $type Id of the question type.
* @return array|false
*/
function llms_get_question_type( $type ) {
$types = llms_get_question_types();
$ret = isset( $types[ $type ] ) ? $types[ $type ] : false;
/**
* Filters the data for a single question type.
*
* @since 3.16.0
*
* @param array|false $data Data for a single question type. False it there's no data for a given quesiton type.
* @param string $type Id of the question type.
*/
return apply_filters( 'llms_get_question_type', $ret, $type );
}
/**
* Retrieve question types.
*
* See `LLMS_Question_Types` class for actual loading of core question types.
*
* @since 3.16.0
* @return array
*/
function llms_get_question_types() {
/**
* Filters the question types.
*
* @since 3.16.0
*
* @param array $question_types Question types.
*/
return apply_filters( 'llms_get_question_types', array() );
}
/**
* Retrieve statuses for quiz attempts.
*
* @since 3.16.0
*
* @return array
*/
function llms_get_quiz_attempt_statuses() {
/**
* Filters the quiz attempt statuses
*
* @since 3.16.0
*
* @param array $quiz_attempt_statuses Statuses for quiz attempts.
*/
return apply_filters(
'llms_get_quiz_attempt_statuses',
array(
'incomplete' => __( 'Incomplete', 'lifterlms' ),
'pending' => __( 'Pending Review', 'lifterlms' ),
'fail' => __( 'Fail', 'lifterlms' ),
'pass' => __( 'Pass', 'lifterlms' ),
)
);
}
/**
* Get quiz settings defined by supporting themes
*
* @since 3.16.8
* @since 3.38.0 Moved deprecation notice from `LLMS_Admin_Builder::get_custom_schemas()`.
* @since 4.6.0 Removed logging and use `apply_filters_deprecated()` in favor of `apply_filters()`.
* @since 5.3.3 Correctly pass an array of settings as parameter for `apply_filters_deprecated()`.
* @deprecated 3.38.0 See https://lifterlms.com/docs/course-builder-custom-fields-for-developers for more information.
*
* @param string $setting Name of setting, if omitted returns all settings.
* @param string $default Default fallback if setting not set.
* @return array
*/
function llms_get_quiz_theme_setting( $setting = '', $default = '' ) {
/**
* Deprecated.
*
* @since 3.17.0
* @deprecated 3.17.6 Deprecated. See https://lifterlms.com/docs/course-builder-custom-fields-for-developers for more information.
*
* @param array[] $settings Array of quiz theme settings.
*/
$settings = apply_filters_deprecated(
'llms_get_quiz_theme_settings',
array(
array(
'layout' => array(
'id' => '',
'name' => __( 'Layout', 'lifterlms' ),
'options' => array(),
'type' => 'select', // Either: select or image_select.
),
),
),
'3.17.6'
);
if ( $setting ) {
return isset( $settings[ $setting ] ) ? $settings[ $setting ] : $default;
}
return $settings;
}
/**
* Shuffles choices until the choice order has changed from the original.
*
* The smaller the list of choices the greater the chance of shuffling not changing the array.
*
* @since 3.16.12
*
* @param array $choices Choices from an LLMS_Question
* @return array
*/
function llms_shuffle_choices( $choices ) {
$count = count( $choices );
// If we only have one choice there's not much to shuffle with.
if ( $count <= 1 ) {
return $choices;
// Reverse the array when we only have two.
} elseif ( 2 === $count ) {
$shuffled = array_reverse( $choices );
// Shuffle until the order has changed.
} else {
$shuffled = $choices;
while ( $shuffled === $choices ) {
shuffle( $shuffled );
}
}
return $shuffled;
}
================================================
FILE: includes/functions/llms.functions.template.php
================================================
<?php
/**
* LifterLMS Template functions
*
* @package LifterLMS/Functions
*
* @since Unknown
* @version 7.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Get template part
*
* @since Unknown
*
* @param string $slug The slug name for the generic template.
* @param string $name Optional. The name of the specialised template. Default is empty string.
* @return void
*/
function llms_get_template_part( $slug, $name = '' ) {
$template = '';
if ( $name ) {
$template = llms_locate_template( "{$slug}-{$name}.php", llms()->template_path() . "{$slug}-{$name}.php" );
}
// Get default slug-name.php.
if ( ! $template && $name && file_exists( llms()->plugin_path() . "/templates/{$slug}-{$name}.php" ) ) {
$template = llms()->plugin_path() . "/templates/{$slug}-{$name}.php";
}
if ( ! $template ) {
$template = llms_locate_template( "{$slug}.php", llms()->template_path() . "{$slug}.php" );
}
/**
* Filters the template file path
*
* Allow 3rd party plugin filter template file from their plugin.
*
* @since Unknown
*
* @param string $template The path to the template file.
* @param string $slug The slug name for the generic template.
* @param stirng $name The name of the specialised template.
*/
$template = apply_filters( 'llms_get_template_part', $template, $slug, $name );
if ( $template ) {
load_template( $template, false );
}
}
/**
* Get Template part contents
*
* @since Unknown
*
* @param string $slug The slug name for the generic template.
* @param string $name Optional. The name of the specialised template. Default is empty string.
* @return string
*/
function llms_get_template_part_contents( $slug, $name = '' ) {
$template = '';
if ( $name ) {
$template = llms_locate_template( "{$slug}-{$name}.php", llms()->template_path() . "{$slug}-{$name}.php" );
}
// Get default slug-name.php.
if ( ! $template && $name && file_exists( llms()->plugin_path() . "/templates/{$slug}-{$name}.php" ) ) {
$template = llms()->plugin_path() . "/templates/{$slug}-{$name}.php";
}
if ( ! $template ) {
$template = llms_locate_template( "{$slug}.php", llms()->template_path() . "{$slug}.php" );
}
if ( $template ) {
return $template;
}
}
/**
* Get Template Part
*
* @since 1.0.0
* @since 3.16.0 Unknown
*
* @param string $template_name Name of template.
* @param array $args Array of arguments accessible from the template.
* @param string $template_path Optional. Dir path to template. Default is empty string.
* If not supplied the one retrived from `llms()->template_path()` will be used.
* @param string $default_path Optional. Default path is empty string.
* If not supplied the template path is `llms()->plugin_path() . '/templates/'`.
* @return void
*/
function llms_get_template( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
if ( $args && is_array( $args ) ) {
extract( $args );
}
$located = llms_locate_template( $template_name, $template_path, $default_path );
/**
* Fired before a template part is included
*
* @since Unknown
*
* @param string $template_name Name of template.
* @param string $template_path Dir path to template as passed to the `llms_get_template()` function.
* @param string $located The full path of the template file to load.
* @param array $args Array of arguments accessible from the template.
*/
do_action( 'lifterlms_before_template_part', $template_name, $template_path, $located, $args );
if ( file_exists( $located ) ) {
include $located;
}
/**
* Fired after a template part is included
*
* @since Unknown
*
* @param string $template_name Name of template.
* @param string $template_path Dir path to template as passed to the `llms_get_template()` function.
* @param string $located The full path of the (maybe) loaded template file.
* @param array $args Array of arguments accessible from the template.
*/
do_action( 'lifterlms_after_template_part', $template_name, $template_path, $located, $args );
}
function llms_get_template_ajax( $template_name, $args = array(), $template_path = '', $default_path = '' ) {
ob_start();
llms_get_template( $template_name, $args, $template_path, $default_path );
return ob_get_clean();
}
/**
* Locate Template
*
* @param string $template_name Name of template.
* @param string $template_path Optional. Dir path to template. Default is empty string.
* If not supplied the one retrived from `llms()->template_path()` will be used.
* @param string $default_path Optional. Default path is empty string.
* If not supplied the template path is `llms()->plugin_path() . '/templates/'`.
* @return string
*
* @since 1.0.0
* @since 3.0.0 Only returns path if template exists.
*/
function llms_locate_template( $template_name, $template_path = '', $default_path = '' ) {
if ( ! $template_path ) {
$template_path = llms()->template_path();
}
if ( ! $default_path ) {
$default_path = llms()->plugin_path() . '/templates/';
}
// Check theme and template directories for the template.
$override_path = llms_get_template_override( $template_name );
// Get default template.
$path = ( $override_path ) ? $override_path : $default_path;
$template = $path . $template_name;
if ( ! file_exists( $template ) ) {
$template = '';
}
/**
* Filters the maybe located template file path
*
* Allow 3rd party plugin filter template file from their plugin.
*
* @since Unknown
*
* @param string $template The path to the template file. Empty string if no template found.
* @param string $template_name Name of template.
* @param string $template_path Dir path to template.
*/
return apply_filters( 'lifterlms_locate_template', $template, $template_name, $template_path );
}
/**
* Get template override.
*
* @since Unknown
* @since 4.8.0 Move template override directories logic into llms_get_template_override_directories.
*
* @param string $template Template file.
* @return mixed Template file directory or false if none exists.
*/
function llms_get_template_override( $template = '' ) {
$dirs = llms_get_template_override_directories();
foreach ( $dirs as $dir ) {
$path = $dir . '/';
if ( file_exists( "{$path}{$template}" ) ) {
return $path;
}
}
return false;
}
/**
* Get template override directories.
*
* Moved from `llms_get_template_override()`.
*
* @since 4.8.0
*
* @return string[]
*/
function llms_get_template_override_directories() {
$dirs = wp_cache_get( 'theme-override-directories', 'llms_template_functions' );
if ( false === $dirs ) {
$dirs = array_filter(
array_unique(
array(
get_stylesheet_directory() . '/lifterlms',
get_template_directory() . '/lifterlms',
)
),
'is_dir'
);
wp_cache_set( 'theme-override-directories', $dirs, 'llms_template_functions' );
}
/**
* Filters the theme override directories.
*
* Allow themes and plugins to determine which folders to look in for theme overrides.
*
* @since Unknown
*
* @param string[] $theme_override_directories List of theme override directory paths.
*/
return apply_filters( 'lifterlms_theme_override_directories', $dirs );
}
/**
* Determine if Focus Mode is enabled for a specific post (lesson, quiz, or other post types via filter).
*
* For lessons and quizzes, uses the parent course focus mode setting (or global setting).
* Add-ons (e.g. LifterLMS Assignments) can use the filter to enable focus mode for their post types.
*
* @since 10.0.0
*
* @param int $post_id The ID of the post (lesson, quiz, etc.).
* @return bool
*/
function llms_is_focus_mode_enabled( $post_id ) {
$post = llms_get_post( $post_id );
if ( ! $post ) {
return false;
}
$result = false;
$type = $post->get( 'type' );
if ( 'lesson' === $type || 'llms_quiz' === $type ) {
$course = llms_get_post_parent_course( $post_id );
if ( ! $course ) {
return apply_filters( 'llms_is_focus_mode_enabled', false, $post_id );
}
$course_focus_mode = $course->get( 'focus_mode' );
if ( 'enable' === $course_focus_mode ) {
$result = true;
} elseif ( 'disable' === $course_focus_mode ) {
$result = false;
} else {
$result = 'yes' === get_option( 'lifterlms_enable_focus_mode', 'no' );
}
if ( $result && ! current_user_can( 'manage_lifterlms' ) ) {
$student = llms_get_student();
if ( ! $student || ! $student->is_enrolled( $course->get( 'id' ) ) ) {
$result = false;
}
}
}
/**
* Filters whether focus mode is enabled for a given post.
*
* Used by add-ons (e.g. LifterLMS Assignments) to enable focus mode for their post types
* when focus mode is enabled globally and/or for the course.
*
* @since 10.0.0
*
* @param bool $result Whether focus mode is enabled.
* @param int $post_id The post ID.
*/
return apply_filters( 'llms_is_focus_mode_enabled', $result, $post_id );
}
/**
* Retrieve the effective focus mode content width for a post.
*
* Checks the parent course setting first (for lesson/quiz), then falls back to global.
*
* @since 10.0.0
*
* @param int $post_id The ID of the post (lesson, quiz, or other focus-mode post type).
* @return string Width value: 'full', '1600', '1180', '960', or '768'.
*/
function llms_get_focus_mode_content_width( $post_id ) {
$course = llms_get_post_parent_course( $post_id );
if ( $course ) {
$value = $course->get( 'focus_mode_content_width' );
if ( $value && 'inherit' !== $value ) {
return $value;
}
}
return get_option( 'lifterlms_focus_mode_content_width', '960' );
}
/**
* Retrieve the effective focus mode sidebar position for a post.
*
* Checks the parent course setting first (for lesson/quiz), then falls back to global.
*
* @since 10.0.0
*
* @param int $post_id The ID of the post (lesson, quiz, or other focus-mode post type).
* @return string 'left' or 'right'.
*/
function llms_get_focus_mode_sidebar_position( $post_id ) {
$course = llms_get_post_parent_course( $post_id );
if ( $course ) {
$value = $course->get( 'focus_mode_sidebar_position' );
if ( $value && 'inherit' !== $value ) {
return $value;
}
}
return get_option( 'lifterlms_focus_mode_sidebar_position', 'left' );
}
/**
* Get focus mode content width select options for course-level settings.
*
* @since 10.0.0
*
* @param bool $include_inherit Whether to include the "Inherit" option with the current global value.
* @return array Array of key/title option arrays.
*/
function llms_get_focus_mode_content_width_options( $include_inherit = false ) {
$widths = array(
'full' => __( 'Full Width', 'lifterlms' ),
'1600' => __( 'Extra Wide (1600px)', 'lifterlms' ),
'1180' => __( 'Wide (1180px)', 'lifterlms' ),
'960' => __( 'Default (960px)', 'lifterlms' ),
'768' => __( 'Narrow (768px)', 'lifterlms' ),
);
$options = array();
if ( $include_inherit ) {
$global_value = get_option( 'lifterlms_focus_mode_content_width', '960' );
$global_label = isset( $widths[ $global_value ] ) ? $widths[ $global_value ] : $global_value;
$options[] = array(
'key' => 'inherit',
'title' => sprintf(
/* translators: %s: current global setting label */
__( 'Inherit Global Setting (%s)', 'lifterlms' ),
$global_label
),
);
}
foreach ( $widths as $key => $title ) {
$options[] = array(
'key' => $key,
'title' => $title,
);
}
return $options;
}
/**
* Get focus mode sidebar position select options for course-level settings.
*
* @since 10.0.0
*
* @param bool $include_inherit Whether to include the "Inherit" option with the current global value.
* @return array Array of key/title option arrays.
*/
function llms_get_focus_mode_sidebar_position_options( $include_inherit = false ) {
$positions = array(
'left' => __( 'Left', 'lifterlms' ),
'right' => __( 'Right', 'lifterlms' ),
);
$options = array();
if ( $include_inherit ) {
$global_value = get_option( 'lifterlms_focus_mode_sidebar_position', 'left' );
$global_label = isset( $positions[ $global_value ] ) ? $positions[ $global_value ] : $global_value;
$options[] = array(
'key' => 'inherit',
'title' => sprintf(
/* translators: %s: current global setting label */
__( 'Inherit Global Setting (%s)', 'lifterlms' ),
$global_label
),
);
}
foreach ( $positions as $key => $title ) {
$options[] = array(
'key' => $key,
'title' => $title,
);
}
return $options;
}
/**
* Add body classes for focus mode.
*
* @since 10.0.0
*
* @param array $classes Body classes.
* @return array
*/
function llms_focus_mode_body_class( $classes ) {
/**
* Post types that can use the focus mode template when focus mode is enabled.
*
* Add-ons (e.g. LifterLMS Assignments) can add their post types here and use
* the `llms_is_focus_mode_enabled` filter to return true when appropriate.
*
* @since 10.0.0
*
* @param string[] $post_types Post type names. Default: [ 'lesson', 'llms_quiz' ].
*/
$focus_mode_post_types = apply_filters( 'llms_focus_mode_post_types', array( 'lesson', 'llms_quiz' ) );
if ( is_singular( $focus_mode_post_types ) && llms_is_focus_mode_enabled( get_the_ID() ) ) {
$classes[] = 'llms-focus-mode';
$width = llms_get_focus_mode_content_width( get_the_ID() );
if ( 'full' !== $width ) {
$classes[] = 'llms-focus-mode-width-' . $width;
}
$position = llms_get_focus_mode_sidebar_position( get_the_ID() );
$classes[] = 'llms-focus-mode-sidebar-' . $position;
}
return $classes;
}
add_filter( 'body_class', 'llms_focus_mode_body_class' );
/**
* Enqueue focus mode frontend scripts.
*
* @since 10.0.0
*
* @return void
*/
function llms_focus_mode_enqueue_scripts() {
$focus_mode_post_types = apply_filters( 'llms_focus_mode_post_types', array( 'lesson', 'llms_quiz' ) );
if ( is_singular( $focus_mode_post_types ) && llms_is_focus_mode_enabled( get_the_ID() ) ) {
$suffix = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
wp_enqueue_style(
'llms-focus-mode',
llms()->plugin_url() . '/assets/css/llms-focus-mode' . $suffix . '.css',
array(),
llms()->version
);
wp_enqueue_script(
'llms-focus-mode',
llms()->plugin_url() . '/assets/js/llms-focus-mode.js',
array(),
llms()->version,
true
);
}
}
add_action( 'wp_enqueue_scripts', 'llms_focus_mode_enqueue_scripts' );
/**
* Render focus mode post content.
*
* Themes can override by removing this action and adding their own:
* remove_action( 'llms_focus_mode_the_content', 'llms_focus_mode_render_content' );
* add_action( 'llms_focus_mode_the_content', 'my_theme_render_content' );
*
* @since 10.0.0
*
* @return void
*/
function llms_focus_mode_render_content() {
the_content();
}
add_action( 'llms_focus_mode_the_content', 'llms_focus_mode_render_content' );
/**
* Build the plugin's template file path.
*
* @since 5.8.0
* @since 7.2.0 Do not add leading slash to absolute template directory.
*
* @param string $template Template file name.
* @param string $template_directory Template directory relative to the plugin base directory.
* @param bool $template_directory_absolute Whether the template directory is absolute or not.
* @return string
*/
function llms_template_file_path( $template, $template_directory = 'templates', $template_directory_absolute = false ) {
// We have reason to use a LifterLMS template, check if there's an override we should use from a theme / etc...
$override = llms_get_template_override( $template );
$template_directory = $template_directory_absolute ? $template_directory : llms()->plugin_path() . "/{$template_directory}/";
$template_path = $override ? $override : $template_directory;
return trailingslashit( $template_path ) . "{$template}";
}
================================================
FILE: includes/functions/llms.functions.templates.achievements.php
================================================
<?php
/**
* Achievements & Related template functions
*
* @package LifterLMS/Functions
*
* @since 3.14.0
* @version 7.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Get the content of a single achievement
*
* @since 3.14.0
*
* @param LLMS_User_Achievement $achievement Instance of an LLMS_User_Achievement.
* @return void
*/
function llms_get_achievement( $achievement ) {
ob_start();
llms_get_template(
'achievements/template.php',
array(
'achievement' => $achievement,
)
);
return ob_get_clean();
}
/**
* Output the content of a single achievement
*
* @since 3.14.0
*
* @param LLMS_Achievement $achievement Instance of an LLMS_User_Achievement.
* @return void
*/
function llms_the_achievement( $achievement ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo llms_get_achievement( $achievement );
}
/**
* Retrieve the number of columns used in achievement loops
*
* @since 3.14.0
*
* @return int
*/
function llms_get_achievement_loop_columns() {
return apply_filters( 'llms_achievement_loop_columns', 4 );
}
/**
* Get template for achievements loop.
*
* @since 3.14.0
* @since 3.14.1 Unknown.
* @since 6.0.0 Updated to use the new signature of the {@see LLMS_Student::get_achievements()}.
* @since 7.2.0 Made sure to always enqueue needed assets.
*
* @param LLMS_Student $student Optional. LLMS_Student (uses current if none supplied). Default is `null`.
* The current student will be used if none supplied.
* @param bool|int $limit Optional. Number of achievements to show or `false` to display all.
* @param int $columns Optional. Number of achievements columns. Default is `null`.
* The default achievement loop columns will be used if none supplied. See `llms_get_achievement_loop_columns()`.
* @return void
*/
if ( ! function_exists( 'lifterlms_template_achievements_loop' ) ) {
function lifterlms_template_achievements_loop( $student = null, $limit = false, $columns = null ) {
// Get the current student if none supplied.
if ( ! $student ) {
$student = llms_get_student();
}
// Don't proceed without a student.
if ( ! $student ) {
return;
}
llms()->assets->enqueue_style( 'llms-iziModal' );
llms()->assets->enqueue_script( 'llms-iziModal' );
$cols = $columns ? $columns : llms_get_achievement_loop_columns();
$per_page = $cols * 5;
// Get achievements.
$query = $student->get_achievements(
array(
'page' => max( 1, get_query_var( 'paged' ) ),
'per_page' => $limit ? min( $limit, $per_page ) : $per_page,
)
);
$achievements = $query->get_awards();
/**
* If no columns are specified and we have a specified limit
* and results and the limit is less than the number of columns
* force the columns to equal the limit.
*/
if ( ! $columns && $limit && $limit < $cols && $query->get_number_results() ) {
$cols = $limit;
}
$pagination = 'dashboard' === LLMS_Student_Dashboard::get_current_tab( 'slug' ) ? false : array(
'total' => $query->get_max_pages(),
'context' => 'student_dashboard',
);
llms_get_template(
'achievements/loop.php',
compact( 'cols', 'achievements', 'pagination' )
);
}
}
================================================
FILE: includes/functions/llms.functions.templates.certificates.php
================================================
<?php
/**
* Certificates & Related template functions
*
* @package LifterLMS/Functions
*
* @since 3.14.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Loads the certificate content template.
*
* @since 6.0.0
*
* @param LLMS_User_Certificate $certificate Certificate object.
* @return void
*/
function llms_certificate_content( $certificate ) {
$template = 1 === $certificate->get_template_version() ? 'content-legacy' : 'content';
llms_get_template(
"certificates/{$template}.php",
compact( 'certificate' )
);
}
/**
* Outputs dynamic CSS for a single certificate template.
*
* Hooked to action `wp_head` at priority 10.
*
* @since 6.0.0
*
* @return void
*/
function llms_certificate_styles() {
$certificate = llms_get_certificate( get_the_ID(), true );
if ( ! $certificate || 1 === $certificate->get_template_version() ) {
return;
}
$image = $certificate->get_background_image();
$background_img = $image['src'];
$background_color = $certificate->get( 'background' );
$padding = implode( ' ', $certificate->get_margins( true ) );
$dimensions = $certificate->get_dimensions_for_display();
$width = $dimensions['width'];
$height = $dimensions['height'];
$fonts = $certificate->get_custom_fonts();
llms_get_template(
'certificates/dynamic-styles.php',
compact( 'certificate', 'width', 'height', 'background_color', 'background_img', 'padding', 'fonts' )
);
}
/**
* Loads the certificate actions template.
*
* @since 6.0.0
*
* @param LLMS_User_Certificate $certificate Certificate object.
* @return void
*/
function llms_certificate_actions( $certificate ) {
if ( ! $certificate->can_user_manage() ) {
return;
}
$dashboard_url = get_permalink( llms_get_page_id( 'myaccount' ) );
$cert_ep_enabled = LLMS_Student_Dashboard::is_endpoint_enabled( 'view-certificates' );
$back_link = $cert_ep_enabled ? llms_get_endpoint_url( 'view-certificates', '', $dashboard_url ) : $dashboard_url;
$back_text = $cert_ep_enabled ? __( 'All certificates', 'lifterlms' ) : __( 'Dashboard', 'lifterlms' );
$is_template = 'llms_certificate' === $certificate->get( 'type' );
$is_sharing_enabled = $certificate->is_sharing_enabled();
llms_get_template(
'certificates/actions.php',
compact( 'certificate', 'back_link', 'back_text', 'is_sharing_enabled', 'is_template' )
);
}
/**
* Get the content of a single certificates
*
* @since 3.14.0
*
* @param LLMS_User_Certificate $certificate Instance of an LLMS_User_Certificate.
* @return void
*/
function llms_get_certificate_preview( $certificate ) {
ob_start();
llms_get_template(
'certificates/preview.php',
array(
'certificate' => $certificate,
)
);
return ob_get_clean();
}
/**
* Output the content of a single certificate
*
* @since 3.14.0
*
* @param LLMS_User_Certificate $certificate Instance of an LLMS_User_Certificate.
* @return void
*/
function llms_the_certificate_preview( $certificate ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in template file.
echo llms_get_certificate_preview( $certificate );
}
/**
* Retrieve the number of columns used in certificates loops
*
* @since 3.14.0
* @since 6.0.0 Reduced default columns from 5 to 3.
*
* @return int
*/
function llms_get_certificates_loop_columns() {
/**
* Filters the number of columns used to display a list of certificate previews.
*
* @since 3.14.0
*
* @param integer $cols Number of columns.
*/
return apply_filters( 'llms_certificates_loop_columns', 3 );
}
/**
* Get template for certificates loop
*
* @since 3.14.0
* @since 6.0.0 Updated to use the new signature of the {@see LLMS_Student::get_certificates()}.
* Add pagination.
*
* @param LLMS_Student $student Optional. LLMS_Student (uses current if none supplied). Default is `null`.
* The current student will be used if none supplied.
* @param bool|int $limit Optional. Number of certificates to show (defaults to all). Default is `false`.
* @return void
*/
if ( ! function_exists( 'lifterlms_template_certificates_loop' ) ) {
function lifterlms_template_certificates_loop( $student = null, $limit = false ) {
// Get the current student if none supplied.
if ( ! $student ) {
$student = llms_get_student();
}
// Don't proceed without a student.
if ( ! $student ) {
return;
}
$cols = llms_get_certificates_loop_columns();
$per_page = $cols * 5;
// Get certificates.
$query = $student->get_certificates(
array(
'page' => max( 1, get_query_var( 'paged' ) ),
'per_page' => $limit ? min( $limit, $per_page ) : $per_page,
)
);
$certificates = $query->get_awards();
/**
* If no columns are specified and we have a specified limit
* and results and the limit is less than the number of columns
* force the columns to equal the limit.
*/
if ( $limit && $limit < $cols && $query->get_number_results() ) {
$cols = $limit;
}
$pagination = 'dashboard' === LLMS_Student_Dashboard::get_current_tab( 'slug' ) ? false : array(
'total' => $query->get_max_pages(),
'context' => 'student_dashboard',
);
llms_get_template(
'certificates/loop.php',
compact( 'cols', 'certificates', 'pagination' )
);
}
}
/**
* Automatically remove all non-safelisted print stylesheets from certificate and certificate templates.
*
* @since 6.0.0
*
* @return boolean Returns `false` when run on non-certificate post types, otherwise returns `true`.
*/
function llms_certificates_remove_print_styles() {
if ( ! in_array( get_post_type(), array( 'llms_certificate', 'llms_my_certificate' ), true ) ) {
return false;
}
/**
* A list of registered print stylesheet handles which should be allowed for certificate and certificate templates.
*
* By default, any enqueued print stylesheets are automatically dequeued to prevent visual issues encountered when
* printing certificates.
*
* Any stylesheets added to this safelist will not be removed from certificates.
*
* @since 6.0.0
*
* @param string[] $safelist Array of print stylesheet handles.
*/
$safelist = apply_filters( 'llms_certificate_print_styles_safelist', array() );
$styles = wp_styles();
foreach ( $styles->queue as $handle ) {
$style = $styles->registered[ $handle ] ?? false;
if ( ! empty( $style->args ) && 'print' === $style->args && ! in_array( $handle, $safelist, true ) ) {
wp_dequeue_style( $handle );
}
}
return true;
}
add_action( 'wp_enqueue_scripts', 'llms_certificates_remove_print_styles', 999 );
================================================
FILE: includes/functions/llms.functions.templates.dashboard.php
================================================
<?php
/**
* Template functions for the student dashboard
*
* @package LifterLMS/Functions
*
* @since 3.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
if ( ! function_exists( 'lifterlms_student_dashboard' ) ) {
/**
* Output the LifterLMS Student Dashboard
*
* @since 3.25.1
* @since 3.35.0 unslash `$_GET` data.
* @since 3.37.10 Add filter `llms_enable_open_registration`.
* @since 5.0.0 During password reset, retrieve reset key and login from cookie instead of query string.
* Use `llms_get_open_registration_status()`.
*
* @param array $options Optional. Array of options. Default empty array.
* @return void
*/
function lifterlms_student_dashboard( $options = array() ) {
$options = wp_parse_args(
$options,
array(
'layout' => 'columns',
'login_redirect' => get_permalink( llms_get_page_id( 'myaccount' ) ),
)
);
/**
* Fires before the student dashboard output.
*
* @since 7.8.0
*
* @param string $layout The layout of the dashboard.
*
* @hooked lifterlms_template_student_dashboard_wrapper_open - 10
*/
do_action( 'lifterlms_before_student_dashboard', $options['layout'] );
/**
* Filters whether or not to display the student dashboard
*
* By default, this condition will show the dashboard to a logged in user
* and the login/registration forms (as well as the password recovery flow)
* to logged out users.
*
* The `LLMS_View_Manager` class uses this filter to modify the dashboard view
* conditionally based on the requested view role.
*
* @since 4.16.0
*
* @param bool $is_user_logged-in Whether or not the user is logged in.
*/
$display_dashboard = apply_filters( 'llms_display_student_dashboard', is_user_logged_in() );
// Not displaying the dashboard (the user is not logged in), we'll show login/registration forms.
if ( ! $display_dashboard ) {
/**
* Allow adding a notice message to be displayed in the student dashboard where `llms_print_notices()` will be invoked.
*
* @since unknown
*
* @param string $message The notice message to be displayed in the student dashboard. Default empty string.
*/
$message = apply_filters( 'lifterlms_my_account_message', '' );
if ( ! empty( $message ) ) {
llms_add_notice( $message );
}
global $wp;
if ( isset( $wp->query_vars['lost-password'] ) ) {
$args = array();
if ( llms_filter_input( INPUT_GET, 'reset-pass', FILTER_SANITIZE_NUMBER_INT ) ) {
$args['form'] = 'reset_password';
$cookie = llms_parse_password_reset_cookie();
$key = '';
$login = '';
$fields = array();
if ( is_wp_error( $cookie ) ) {
llms_add_notice( $cookie->get_error_message(), 'error' );
} else {
$fields = LLMS_Person_Handler::get_password_reset_fields( $cookie['key'], $cookie['login'] );
}
$args['fields'] = $fields;
} else {
$args['form'] = 'lost_password';
$args['fields'] = LLMS_Person_Handler::get_lost_password_fields();
}
llms_get_template( 'myaccount/form-lost-password.php', $args );
} else {
llms_print_notices();
llms_get_login_form(
null,
/**
* Filter login form redirect URL
*
* @since unknown
*
* @param string $login_redirect The login redirect URL.
*/
apply_filters( 'llms_student_dashboard_login_redirect', $options['login_redirect'] )
);
if ( llms_parse_bool( llms_get_open_registration_status() ) ) {
llms_get_template( 'global/form-registration.php' );
}
}
} else {
$tabs = LLMS_Student_Dashboard::get_tabs();
$current_tab = LLMS_Student_Dashboard::get_current_tab( 'slug' );
/**
* Fires before the student dashboard content output.
*
* @since unknown
*
* @hooked lifterlms_template_student_dashboard_navigation - 10
* @hooked lifterlms_template_student_dashboard_header - 20
*/
do_action( 'lifterlms_before_student_dashboard_content' );
if ( isset( $tabs[ $current_tab ] ) && isset( $tabs[ $current_tab ]['content'] ) && is_callable( $tabs[ $current_tab ]['content'] ) ) {
call_user_func( $tabs[ $current_tab ]['content'] );
}
}
/**
* Fires after the student dashboard output.
*
* @since unknown
*
* @hooked lifterlms_template_student_dashboard_wrapper_close - 10
*/
do_action( 'lifterlms_after_student_dashboard' );
}
}
if ( ! function_exists( 'lifterlms_template_my_courses_loop' ) ) {
/**
* Get course tiles for a student's courses
*
* @since 3.14.0
* @since 3.26.3 Unknown.
* @since 3.37.15 Added secondary sorting by `post_title` when the primary sort is `menu_order`.
* @since 6.3.0 Fix paged query not working when using plain permalinks.
* @since 7.1.3 Added filter for filtering 'Not enrolled text'.
*
* @param LLMS_Student $student Optional. LLMS_Student (current student if none supplied). Default `null`.
* @param bool $preview Optional. If true, outputs a short list of courses (based on dashboard_recent_courses filter). Default `false`.
* @return void
*/
function lifterlms_template_my_courses_loop( $student = null, $preview = false ) {
$student = llms_get_student( $student );
if ( ! $student ) {
return;
}
$courses = $student->get_courses(
/**
* Filter the query args to retrieve the courses ids to be used for the "my_courses" loop.
*
* @since unknown
*
* @param array $args The query args.
*/
apply_filters(
'llms_my_courses_loop_courses_query_args',
array(
'limit' => 500,
),
$student
)
);
if ( ! $courses['results'] ) {
printf(
'<p>%s</p>',
/**
* Not enrolled text.
*
* Allows developers to filter the text to be displayed when the student is not enrolled in any courses.
*
* @since 7.1.3
*
* @param string $not_enrolled_text The text to be displayed when the student is not enrolled in any course.
*/
esc_html( apply_filters( 'lifterlms_dashboard_courses_not_enrolled_text', __( 'You are not enrolled in any courses.', 'lifterlms' ) ) )
);
} else {
add_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_enroll_status', 25 );
add_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_enroll_date', 30 );
// get sorting option.
$option = get_option( 'lifterlms_myaccount_courses_in_progress_sorting', 'date,DESC' );
// parse to order & orderby.
$option = explode( ',', $option );
$orderby = ! empty( $option[0] ) ? $option[0] : 'date';
$order = ! empty( $option[1] ) ? $option[1] : 'DESC';
// Enrollment date will obey the results order.
if ( 'date' === $orderby ) {
$orderby = 'post__in';
} elseif ( 'order' === $orderby ) {
// Add secondary sorting by `post_title` when the primary sort is `menu_order`.
$orderby = 'menu_order post_title';
}
/**
* Filter the number of courses per page to be displayed in the dashboard.
*
* @since unknown
*
* @param int $per_page The number or courses per page to be displayed. Defaults to the 'Courses per page' course catalog's setting.
*/
$per_page = apply_filters( 'llms_dashboard_courses_per_page', get_option( 'lifterlms_shop_courses_per_page', 9 ) );
if ( $preview ) {
/**
* Filter the number of courses per page to be displayed in the dashboard, when outputting a short list of courses.
*
* @since unknown
*
* @param int $per_page The number or courses per page to be displayed. Default is `3`.
*/
$per_page = apply_filters( 'llms_dashboard_recent_courses_count', llms_get_loop_columns() );
}
/**
* Filter the wp query args to retrieve the courses for the "my_courses" loop.
*
* @since unknown
*
* @param array $args The query args.
*/
$query_args = apply_filters(
'llms_dashboard_courses_wp_query_args',
array(
'paged' => llms_get_paged_query_var(),
'orderby' => $orderby,
'order' => $order,
'post__in' => $courses['results'],
'post_status' => 'publish',
'post_type' => 'course',
'posts_per_page' => $per_page,
)
);
$query = new WP_Query( $query_args );
// Prevent pagination on the preview.
if ( $preview ) {
$query->max_num_pages = 1;
}
add_filter( 'paginate_links', 'llms_modify_dashboard_pagination_links' );
lifterlms_loop( $query );
remove_filter( 'paginate_links', 'llms_modify_dashboard_pagination_links' );
remove_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_enroll_status', 25 );
remove_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_enroll_date', 30 );
}
}
}
if ( ! function_exists( 'llms_template_my_favorites_loop' ) ) {
/**
* Get student's favorites.
*
* @since 7.5.0
*
* @param LLMS_Student $student Optional. LLMS_Student (current student if none supplied). Default `null`.
* @param array $favorites Optional. Array of favorites (current student's favorites if none supplied). Default `null`.
* @return void
*/
function llms_template_my_favorites_loop( $student = null, $favorites = null ) {
$student = llms_get_student( $student );
if ( ! $student ) {
return;
}
$favorites = $favorites ?? $student->get_favorites();
if ( ! $favorites ) {
printf( '<p>%s</p>', esc_html__( 'No favorites found.', 'lifterlms' ) );
} else {
// Adding Parent Course IDs in Favorites for each lesson.
foreach ( $favorites as $key => $favorite ) {
$lesson = new LLMS_Lesson( $favorite->post_id );
$favorite->parent_course = $lesson->get( 'parent_course' );
}
// Grouping Favorites by Parent Course ID.
$favorites = array_reduce(
$favorites,
function ( $carry, $item ) {
$carry[ $item->parent_course ][] = $item;
return $carry;
},
array()
);
echo '<div class="llms-syllabus-wrapper">';
// Printing Favorite Lessons under each Parent Course.
foreach ( $favorites as $course => $lessons ) {
// Get Course Name.
$course = new LLMS_Course( $course );
echo '<h3 class="llms-h3 llms-section-title">';
echo esc_html( $course->get( 'title' ) );
echo '</h3>';
foreach ( $lessons as $lesson ) {
$lesson = new LLMS_Lesson( $lesson->post_id );
llms_get_template(
'course/lesson-preview.php',
array(
'lesson' => $lesson,
)
);
}
}
echo '</div>';
}
}
}
if ( ! function_exists( 'lifterlms_template_my_memberships_loop' ) ) {
/**
* Get course tiles for a student's memberships
*
* @since 3.14.0
* @since 3.14.8 Unknown.
* @since 7.1.3 Added filter for filtering 'Not enrolled text'.
*
* @param LLMS_Student $student Optional. LLMS_Student (current student if none supplied). Default `null`.
* @return void
*/
function lifterlms_template_my_memberships_loop( $student = null ) {
$student = llms_get_student( $student );
if ( ! $student ) {
return;
}
$memberships = $student->get_membership_levels();
if ( ! $memberships ) {
printf(
'<p>%s</p>',
/**
* Not enrolled text.
*
* Allows developers to filter the text to be displayed when the student is not enrolled in any memberships.
*
* @since 7.1.3
*
* @param string $not_enrolled_text The text to be displayed when the student is not enrolled in any memberships.
*/
esc_html( apply_filters( 'lifterlms_dashboard_memberships_not_enrolled_text', __( 'You are not enrolled in any memberships.', 'lifterlms' ) ) )
);
} else {
add_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_enroll_status', 25 );
add_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_enroll_date', 30 );
$query = new WP_Query(
array(
'orderby' => 'title',
'order' => 'ASC',
'post__in' => $memberships,
'post_status' => 'publish',
'post_type' => 'llms_membership',
'posts_per_page' => -1,
)
);
$query->max_num_pages = 1; // Prevent pagination here.
lifterlms_loop( $query );
remove_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_enroll_status', 25 );
remove_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_enroll_date', 30 );
}
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_home' ) ) {
/**
* Main dashboard homepage template
*
* @since 3.14.0
*
* @return void
*/
function lifterlms_template_student_dashboard_home() {
llms_get_template( 'myaccount/dashboard.php' );
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_header' ) ) {
/**
* Dashboard header template
*
* @since 3.0.0
*
* @return void
*/
function lifterlms_template_student_dashboard_header() {
llms_get_template( 'myaccount/header.php' );
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_my_achievements' ) ) {
/**
* Template for My Achievements on dashboard
*
* @since 3.14.0
* @since 3.19.0 Unknown.
* @since 6.0.0 Don't output HTML when the endpoint is disabled.
*
* @param bool $preview If `true`, outputs a short list of achievements to display on the dashboard
* landing page. Otherwise displays all of the earned achievements for display
* on the view-achievements endpoint.
* @return void
*/
function lifterlms_template_student_dashboard_my_achievements( $preview = false ) {
$student = llms_get_student();
if ( ! $student ) {
return;
}
$enabled = LLMS_Student_Dashboard::is_endpoint_enabled( 'view-achievements' );
if ( ! $enabled ) {
return;
}
$more = false;
if ( $preview ) {
$more = array(
'url' => llms_get_endpoint_url( 'view-achievements', '', llms_get_page_url( 'myaccount' ) ),
'text' => __( 'View All My Achievements', 'lifterlms' ),
);
}
ob_start();
lifterlms_template_achievements_loop( $student, $preview ? llms_get_achievement_loop_columns() : false );
llms_get_template(
'myaccount/dashboard-section.php',
array(
'action' => 'my_achievements',
'slug' => 'llms-my-achievements',
'title' => $preview ? __( 'My Achievements', 'lifterlms' ) : '',
'content' => ob_get_clean(),
'more' => $more,
)
);
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_my_certificates' ) ) {
/**
* Template for My Certificates on dashboard
*
* @since 3.14.0
* @since 3.19.0 Unknown
* @since 6.0.0 Output short list when `$preview` is `true`.
* Don't output any HTML when the endpoint is disabled.
*
* @param bool $preview If `true`, outputs a short list of certificates to display on the dashboard
* landing page. Otherwise displays all of the earned certificates for display
* on the view-certificates endpoint.
* @return void
*/
function lifterlms_template_student_dashboard_my_certificates( $preview = false ) {
$student = llms_get_student();
if ( ! $student ) {
return;
}
$enabled = LLMS_Student_Dashboard::is_endpoint_enabled( 'view-certificates' );
if ( ! $enabled ) {
return;
}
$more = false;
if ( $preview ) {
$more = array(
'url' => llms_get_endpoint_url( 'view-certificates', '', llms_get_page_url( 'myaccount' ) ),
'text' => __( 'View All My Certificates', 'lifterlms' ),
);
}
ob_start();
lifterlms_template_certificates_loop( $student, $preview ? llms_get_certificates_loop_columns() : false );
llms_get_template(
'myaccount/dashboard-section.php',
array(
'action' => 'my_certificates',
'slug' => 'llms-my-certificates',
'title' => $preview ? __( 'My Certificates', 'lifterlms' ) : '',
'content' => ob_get_clean(),
'more' => $more,
)
);
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_my_courses' ) ) {
/**
* Template for My Courses section on dashboard index
*
* @since 3.14.0
* @since 3.19.0 Unknown.
*
* @param bool $preview Optional. If true, outputs a short list of courses (based on dashboard_recent_courses filter). Default `false`.
* @return void
*/
function lifterlms_template_student_dashboard_my_courses( $preview = false ) {
$student = llms_get_student();
if ( ! $student ) {
return;
}
$more = false;
if ( $preview && LLMS_Student_Dashboard::is_endpoint_enabled( 'view-courses' ) ) {
$more = array(
'url' => llms_get_endpoint_url( 'view-courses', '', llms_get_page_url( 'myaccount' ) ),
'text' => __( 'View All My Courses', 'lifterlms' ),
);
}
ob_start();
lifterlms_template_my_courses_loop( $student, $preview );
llms_get_template(
'myaccount/dashboard-section.php',
array(
'action' => 'my_courses',
'slug' => 'llms-my-courses',
'title' => $preview ? __( 'My Courses', 'lifterlms' ) : '',
'content' => ob_get_clean(),
'more' => $more,
)
);
}
}
if ( ! function_exists( 'llms_template_student_dashboard_my_favorites' ) ) {
/**
* Template for My Favorites section on dashboard index.
*
* @since 7.5.0
*
* @return void
*/
function llms_template_student_dashboard_my_favorites() {
$student = llms_get_student();
if ( ! $student || ! llms_is_favorites_enabled() ) {
return;
}
ob_start();
llms_template_my_favorites_loop( $student );
llms_get_template(
'myaccount/my-favorites.php',
array(
'content' => ob_get_clean(),
)
);
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_my_grades' ) ) {
/**
* Output the "My Grades" template screen on the student dashboard.
*
* @since 3.24.0
* @since 3.26.3 Unknown.
* @since 5.3.2 Cast achievement_template ID to string when comparing to the list of achievement IDs related the course/membership (list of strings).
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 6.0.0 Use updated method signature for `LLMS_Student::get_achievements()`.
* @since 6.3.0 Prevent trying to access to a non existing index when retrieving the slug from the `$wp_query`.
* Fixed pagination not working when using plain permalinks.
* @return void
*/
function lifterlms_template_student_dashboard_my_grades() {
$student = llms_get_student();
if ( ! $student ) {
return;
}
global $wp_query, $wp_rewrite;
$slug = $wp_query->query['my-grades'] ?? '';
// List courses.
if ( empty( $slug ) || false !== strpos( $slug, $wp_rewrite->pagination_base . '/' ) ) {
/**
* Filter the number of courses per pages to be displayed in my grades
*
* @since unknown
*
* @param int $per_page The number of courses per pages to be displayed. Default is `10`.
*/
$per_page = apply_filters( 'llms_sd_grades_courses_per_page', 10 );
$page = llms_get_paged_query_var();
$sort = llms_filter_input_sanitize_string( INPUT_GET, 'sort' );
if ( ! $sort ) {
$sort = 'date_desc';
}
$parts = explode( '_', $sort );
// Validate sort.
$parts[0] = llms_sanitize_with_safelist( $parts[0], array( 'date', 'title' ) );
$parts[1] = llms_sanitize_with_safelist( $parts[1], array( 'desc', 'asc' ) );
$courses = $student->get_courses(
array(
'limit' => $per_page,
'skip' => $per_page * ( $page - 1 ),
'orderby' => $parts[0],
'order' => strtoupper( $parts[1] ),
)
);
add_filter( 'paginate_links', 'llms_modify_dashboard_pagination_links' );
llms_get_template(
'myaccount/my-grades.php',
array(
'courses' => array_map( 'llms_get_post', $courses['results'] ),
'student' => $student,
'sort' => $sort,
'pagination' => array(
'current' => absint( $page ),
'max' => absint( ceil( $courses['found'] / $per_page ) ),
),
)
);
remove_filter( 'paginate_links', 'llms_modify_dashboard_pagination_links' );
// Show single.
} else {
$course = get_posts(
array(
'name' => $slug,
'post_type' => 'course',
)
);
$course = array_shift( $course );
if ( $course ) {
$course = llms_get_post( $course );
}
// It's not stupid if it works unless it is stupid.
$post_ids = array_merge(
array( $course->get( 'id' ) ),
$course->get_sections( 'ids' ),
$course->get_lessons( 'ids' ),
$course->get_quizzes()
);
$achievements = $student->get_achievements(
array(
'related_posts' => $post_ids,
'per_page' => 1,
'no_found_rows' => true,
)
)->get_awards();
$latest_achievement = $achievements ? $achievements[0] : false;
$last_activity = $student->get_events(
array(
'per_page' => 1,
'post_id' => $course->get( 'id' ),
)
);
llms_get_template(
'myaccount/my-grades-single.php',
array(
'course' => $course,
'student' => $student,
'latest_achievement' => $latest_achievement,
'last_activity' => $last_activity ? strtotime( $last_activity[0]->get( 'updated_date' ) ) : false,
)
);
}
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_my_grades_table' ) ) {
/**
* Output the template for a single grades table on the student dashboard
*
* @since 3.24.0
*
* @param LLMS_Course $course LLMS_Course.
* @param LLMS_Student $student LLMS_Student.
* @return void
*/
function lifterlms_template_student_dashboard_my_grades_table( $course, $student ) {
/**
* Filter the student dashboard "my grades" table headings
*
* @since unknown
*
* @param array $section_headings "My Grades" table headings.
*/
$section_headings = apply_filters(
'llms_student_dashboard_my_grades_table_headings',
array(
'completion_date' => __( 'Completion Date', 'lifterlms' ),
'associated_quiz' => __( 'Quiz', 'lifterlms' ),
'overall_grade' => __( 'Grade', 'lifterlms' ),
)
);
llms_get_template(
'myaccount/my-grades-single-table.php',
array(
'course' => $course,
'student' => $student,
'section_headings' => $section_headings,
)
);
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_my_memberships' ) ) {
/**
* Template for My Memberships section on dashboard index
*
* @since 3.14.0
* @since 3.19.0 Unknown.
*
* @param bool $preview Optional. If true, outputs a short list of courses (based on dashboard_recent_courses filter). Default `false`.
* @return void
*/
function lifterlms_template_student_dashboard_my_memberships( $preview = false ) {
$student = llms_get_student();
if ( ! $student ) {
return;
}
$more = false;
if ( $preview && LLMS_Student_Dashboard::is_endpoint_enabled( 'view-memberships' ) ) {
$more = array(
'url' => llms_get_endpoint_url( 'view-memberships', '', llms_get_page_url( 'myaccount' ) ),
'text' => __( 'View All My Memberships', 'lifterlms' ),
);
}
ob_start();
lifterlms_template_my_memberships_loop( $student );
llms_get_template(
'myaccount/dashboard-section.php',
array(
'action' => 'my_memberships',
'slug' => 'llms-my-memberships',
'title' => $preview ? __( 'My Memberships', 'lifterlms' ) : '',
'content' => ob_get_clean(),
'more' => $more,
)
);
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_my_notifications' ) ) {
/**
* Template for My Notifications student dashboard endpoint
*
* @since 3.26.3
* @since 3.35.0 Sanitize `$_GET` data.
* @since 3.37.15 Use `in_array()`'s strict comparison.
* @since 3.37.16 Fixed typo when comparing the current view.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* Fix how the protected {@see LLMS_Notifications_Query::$max_pages} property is accessed.
* @since 6.3.0 Fix paged query not working when using plain permalinks.
*
* @return void
*/
function lifterlms_template_student_dashboard_my_notifications() {
$url = llms_get_endpoint_url( 'notifications', '', llms_get_page_url( 'myaccount' ) );
$sections = array(
array(
'url' => $url,
'name' => __( 'View Notifications', 'lifterlms' ),
),
array(
'url' => add_query_arg( 'sdview', 'prefs', $url ),
'name' => __( 'Manage Preferences', 'lifterlms' ),
),
);
$view = isset( $_GET['sdview'] ) ? llms_filter_input( INPUT_GET, 'sdview' ) : 'view';
if ( 'view' === $view ) {
$page = llms_get_paged_query_var();
$notifications = new LLMS_Notifications_Query(
array(
'page' => $page,
/**
* Filter the number of notifications per page to be displayed in the dashboard's "my_notifications" tab.
*
* @since unknown
*
* @param int $per_page The number of notifications per page to be displayed. Default `25`.
*/
'per_page' => apply_filters( 'llms_sd_my_notifications_per_page', 25 ),
'subscriber' => get_current_user_id(),
'sort' => array(
'created' => 'DESC',
'id' => 'DESC',
),
'types' => 'basic',
)
);
$pagination = array(
'max' => $notifications->get_max_pages(),
'current' => $page,
);
$args = array(
'notifications' => $notifications->get_notifications(),
'pagination' => $pagination,
'sections' => $sections,
);
} else {
/**
* Filter the types of subscriber notification which can be managed
*
* @since unknown
*
* @param array $types The array of manageable types. Default is `array( 'email' )`.
*/
$types = apply_filters( 'llms_notification_subscriber_manageable_types', array( 'email' ) );
$settings = array();
$student = new LLMS_Student( get_current_user_id() );
foreach ( llms()->notifications()->get_controllers() as $controller ) {
foreach ( $types as $type ) {
$configs = $controller->get_subscribers_settings( $type );
if ( in_array( 'student', array_keys( $configs ), true ) && 'yes' === $configs['student'] ) {
if ( ! isset( $settings[ $type ] ) ) {
$settings[ $type ] = array();
}
$settings[ $type ][ $controller->id ] = array(
'name' => $controller->get_title(),
'value' => $student->get_notification_subscription( $type, $controller->id, 'yes' ),
);
}
}
}
$args = array(
'sections' => $sections,
'settings' => $settings,
);
}
add_filter( 'paginate_links', 'llms_modify_dashboard_pagination_links' );
llms_get_template( 'myaccount/my-notifications.php', $args );
remove_filter( 'paginate_links', 'llms_modify_dashboard_pagination_links' );
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_navigation' ) ) {
/**
* Dashboard Navigation template
*
* @since 3.0.0
*
* @return void
*/
function lifterlms_template_student_dashboard_navigation() {
llms_get_template( 'myaccount/navigation.php' );
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_title' ) ) {
/**
* Dashboard title template
*
* @since 3.0.0
* @since 3.14.0 Unknown.
*
* @return void
*/
function lifterlms_template_student_dashboard_title() {
$data = LLMS_Student_Dashboard::get_current_tab();
$title = isset( $data['title'] ) ? $data['title'] : '';
/**
* Filter the student dasbhoard title for the current tab
*
* @since unknown
*
* @param string $title The student dashboard title.
*/
echo wp_kses_post( apply_filters( 'lifterlms_student_dashboard_title', '<h2 class="llms-sd-title">' . $title . '</h2>', $data ) );
}
}
if ( ! function_exists( 'lifterlms_template_student_dashboard_wrapper_close' ) ) :
/**
* Output the student dashboard wrapper closing tags
*
* @since 3.0.0
*
* @return void
*/
function lifterlms_template_student_dashboard_wrapper_close() {
echo '</div><!-- .llms-student-dashboard -->';
}
endif;
if ( ! function_exists( 'lifterlms_template_student_dashboard_wrapper_open' ) ) :
/**
* Output the student dashboard wrapper opening tags
*
* @since 3.0.0
* @since 3.10.0 Unknown.
* @since 7.8.0
*
* @param string $layout Dashboard layout. Accepts "stacked" (default) or "columns".
*
* @return void
*/
function lifterlms_template_student_dashboard_wrapper_open( $layout ) {
$current = LLMS_Student_Dashboard::get_current_tab( 'slug' );
echo '<div class="llms-student-dashboard ' . esc_attr( $current ) . ' llms-sd-layout-' . esc_attr( $layout ) . '" data-current="' . esc_attr( $current ) . '">';
}
endif;
if ( ! function_exists( 'lifterlms_template_student_dashboard_select_mobile_navigation' ) ) :
/**
* Output the student dashboard mobile navigation
*
* @since 9.0.0
*
* @param string $current The current tab slug.
* @return void
*/
function lifterlms_template_student_dashboard_select_mobile_navigation( $current ) {
?>
<select onChange="window.location.replace(this.options[this.selectedIndex].value)">
<?php foreach ( LLMS_Student_Dashboard::get_tabs_for_nav() as $var => $data ) : ?>
<option value="<?php echo esc_attr( esc_url( $data['url'] ) ); ?>" <?php selected( $var, $current ); ?>>
<?php echo esc_html( $data['title'] ); ?>
</option>
<?php endforeach; ?>
</select>
<?php
}
endif;
/**
* Modify the pagination links displayed on endpoints using the default LLMS loop.
*
* @since 3.24.0
* @since 3.26.3 Unknown.
* @since 6.3.0 Fixed pagination when using plain permalinks.
* @since 7.2.0 Made sure the pagination links is not altered when not in the LifterLMS dashboard context.
*
* @param string $link Default link.
* @return string
*/
function llms_modify_dashboard_pagination_links( $link ) {
/**
* Allow 3rd parties to disable dashboard pagination link rewriting
*
* Resolves compatibility issues with LifterLMS WooCommerce.
*
* @since unknown
* @since 7.2.0 Defaults to `false` only on the LifterLMS dashboard context, while `true` elsewhere.
*
* @param bool $disable Whether or not the dashboard pagination links should be disabled.
* Default `false` in the LifterLMS dashboard context, `true` elsewhere.
* @param string $link The default link.
*/
if ( apply_filters( 'llms_modify_dashboard_pagination_links_disable', ! is_page( llms_get_page_id( 'myaccount' ) ), $link ) ) {
return $link;
}
global $wp_rewrite;
$query = wp_parse_url( $link, PHP_URL_QUERY );
if ( $query ) {
$link = str_replace( '?' . $query, '', $link );
}
// No plain permalinks.
if ( get_option( 'permalink_structure' ) ) {
$parts = explode( '/', untrailingslashit( $link ) );
$page = end( $parts );
$link = llms_get_endpoint_url( LLMS_Student_Dashboard::get_current_tab( 'slug' ), $wp_rewrite->pagination_base . '/' . $page . '/', llms_get_page_url( 'myaccount' ) );
} else { // With plain permalinks.
preg_match( '/paged?=([0-9]+)/', $link, $pages ); // Extract the 'page(d)' var.
$paged = empty( $pages ) || count( $pages ) < 2 || $pages[1] < 2 ? '' : $pages[0]; // No pagination or page 1 nothing to add.
$query .= $paged ? '&' . $paged : '';
$link = home_url();
}
if ( $query ) {
$link .= '?' . $query;
}
return $link;
}
/**
* Output content for a single cell on the student single course grades table
*
* @since 3.24.0
*
* @param string $id Key of the table cell.
* @param LLMS_Lesson $lesson LLMS_Lesson.
* @param LLMS_Student $student LLMS_Student.
* @param array $restrictions Restriction data from `llms_page_restricted()`.
* @return void
*/
function llms_sd_my_grades_table_content( $id, $lesson, $student, $restrictions ) {
ob_start();
/**
* Fires before the student dashboard my grades table cell content output
*
* The dynamic portion of the hook name, `$id`, refers to the key of the table cell.
*
* @since unknown
*
* @param LLMS_Lesson $lesson LLMS_Lesson instance.
* @param LLMS_Student $student LLMS_Student instance.
* @param array $restrictions Restriction data from `llms_page_restricted()`.
*/
do_action( 'llms_sd_my_grades_table_content_' . $id . '_before', $lesson, $student, $restrictions );
switch ( $id ) {
case 'completion_date':
if ( $student->is_complete( $lesson->get( 'id' ) ) ) {
echo esc_html( $student->get_completion_date( $lesson->get( 'id' ), get_option( 'date_format' ) ) );
} else {
echo '–';
}
break;
case 'associated_quiz':
if ( $lesson->has_quiz() && $restrictions['is_restricted'] ) {
echo '<i class="fa fa-lock" aria-hidden="true"></i>';
} elseif ( $lesson->has_quiz() ) {
$attempt = $student->quizzes()->get_last_attempt( $lesson->get( 'quiz' ) );
$url = $attempt ? $attempt->get_permalink() : get_permalink( $lesson->get( 'quiz' ) );
$text = $attempt ? __( 'Review', 'lifterlms' ) : __( 'Start', 'lifterlms' );
if ( $attempt ) {
echo '<span class="llms-status llms-' . esc_attr( $attempt->get( 'status' ) ) . '">' . esc_html( $attempt->l10n( 'status' ) ) . '</span>';
}
echo '<a href="' . esc_url( $url ) . '">' . esc_html( $text ) . '</a>';
} else {
echo '–';
}
break;
case 'overall_grade':
$grade = $student->get_grade( $lesson->get( 'id' ) );
echo is_numeric( $grade ) ? wp_kses_post( llms_get_donut( $grade, '', 'mini' ) ) : '–';
break;
}
/**
* Fires after the student dashboard my grades default table cell content output
*
* If id id one oare `completion_date`, `associated_quiz`, `overall_grade`.
* Can be used to display custom table cells.
*
* The dynamic portion of the hook name, `$id`, refers to the key of the table cell.
*
* @since unknown
*
* @param LLMS_Lesson $lesson LLMS_Lesson instance.
* @param LLMS_Student $student LLMS_Student instance.
* @param array $restrictions Restriction data from `llms_page_restricted()`.
*/
do_action( 'llms_sd_my_grades_table_content_' . $id, $lesson, $student, $restrictions );
$html = ob_get_clean();
/**
* Filters the HTML returned by llms_sd_my_grades_table_content().
*
* @since 6.0.0
*
* @param string $html The cell HTML.
* @param string $id Key of the table cell.
* @param LLMS_Lesson $lesson LLMS_Lesson.
* @param LLMS_Student $student LLMS_Student.
* @param array $restrictions Restriction data from `llms_page_restricted()`.
*/
return apply_filters( 'llms_sd_my_grades_table_content', $html, $id, $lesson, $student, $restrictions );
}
================================================
FILE: includes/functions/llms.functions.templates.dashboard.widgets.php
================================================
<?php
/**
* Template functions for displaying stat widgets on the student dashboard
*
* @package LifterLMS/Functions
*
* @since 3.24.0
* @version 3.24.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Main function used to display a dashboard widget
*
* @param string $title Title of the widget.
* @param string $content Content (HTML) of the widget body.
* @param string $empty_text Content (text) to display if $content is empty.
* @return void
* @since 3.24.0
* @version 3.24.0
*/
function llms_sd_dashboard_widget( $title, $content, $empty_text = '' ) {
?>
<div class="llms-sd-widget">
<h4 class="llms-sd-widget-title"><?php echo esc_html( $title ); ?></h4>
<?php if ( $content ) : ?>
<?php
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped before being passed to dashboard widget.
echo $content;
?>
<?php elseif ( ! $content && $empty_text ) : ?>
<p class="llms-sd-widget-empty"><?php echo esc_html( $empty_text ); ?></p>
<?php endif; ?>
</div>
<?php
}
/**
* Displays a date widget
*
* @param string $title Title of the widget.
* @param int $timestamp Timestamp used to display the date.
* @param string $empty_text Content (text) to display if $content is empty.
* @return void
* @since 3.24.0
* @version 3.24.0
*/
function llms_sd_dashboard_date_widget( $title, $timestamp, $empty_text = '' ) {
$html = '';
if ( $timestamp ) {
ob_start();
?>
<div class="llms-sd-date">
<span class="month"><?php echo esc_html( date_i18n( 'F', $timestamp ) ); ?></span>
<span class="day"><?php echo esc_html( date_i18n( 'j', $timestamp ) ); ?></span>
<span class="year"><?php echo esc_html( date_i18n( 'Y', $timestamp ) ); ?></span>
<span class="diff"><?php printf( esc_html__( '%s ago', 'lifterlms' ), esc_html( llms_get_date_diff( $timestamp, current_time( 'timestamp' ) ) ) ); ?>
</div>
<?php
$html = ob_get_clean();
}
llms_sd_dashboard_widget( $title, $html, $empty_text );
}
/**
* Displays a donut chart widget
*
* @param string $title Title of the widget.
* @param float $perc donut chart percentage.
* @param string $text Text to display within the donut.
* @param string $size Size of the chart.
* @return void
* @since 3.24.0
* @version 3.24.0
*/
function llms_sd_dashboard_donut_widget( $title, $perc, $text = '', $size = 'medium' ) {
llms_sd_dashboard_widget( $title, llms_get_donut( $perc, $text, $size ) );
}
================================================
FILE: includes/functions/llms.functions.templates.loop.php
================================================
<?php
/**
* Template functions for loops (catalogs)
*
* @package LifterLMS/Functions
*
* @since 1.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
if ( ! function_exists( 'lifterlms_archive_description' ) ) {
/**
* Output the archive description for LifterLMS catalogs pages and post type / tax archives.
*
* @since 3.16.10
* @since 3.19.0 Unknown.
* @since 4.10.0 Moved logic to `lifterlms_get_archive_description()` so the function can be called without outputting the content.
*
* @see lifterlms_get_archive_description()
*
* @return void
*/
function lifterlms_archive_description() {
echo wp_kses_post( lifterlms_get_archive_description() );
}
}
if ( ! function_exists( 'lifterlms_get_archive_description' ) ) {
/**
* Retrieve the archive description for LifterLMS catalogs pages and post type / tax archives.
*
* If content is added to the course/membership catalog page via the WP editor, output it as the archive description before the loop.
*
* @since 4.10.0 Moved from `lifterlms_archive_description()`.
* Adjusted filter `llms_archive_description` to always run instead of only running if content exists to display,
* this allows developers to filter the content even when an empty string is returned.
* @since 7.3.0 Fixed PHP Warning when no course/membership catalog page was set or if the
* selected page doesn't exist anymore.
*
* @return string
*/
function lifterlms_get_archive_description() {
$content = '';
$page_id = false;
// Get the page id for the catalog page setup in LLMS settings.
if ( is_post_type_archive( 'course' ) || is_tax( array( 'course_cat', 'course_tag', 'course_difficulty', 'course_track' ) ) ) {
$page_id = llms_get_page_id( 'courses' );
} elseif ( is_post_type_archive( 'llms_membership' ) || is_tax( array( 'membership_tag', 'membership_cat' ) ) ) {
$page_id = llms_get_page_id( 'memberships' );
}
// If a description is setup for the taxonomy term, use that description.
if ( is_tax( array( 'course_cat', 'course_tag', 'course_difficulty', 'course_track', 'membership_tag', 'membership_cat' ) ) ) {
$content = get_the_archive_description();
}
// If we don't have a description, try to pull it from the page's content area.
if ( empty( $content ) && (int) $page_id > 0 ) {
$page = get_post( $page_id );
$content = $page ? $page->post_content : $content;
}
/**
* Filter the archive description
*
* @since Unknown
* @since 4.10.0 Added `$page_id` parameter.
*
* @param string $content HTML description string.
* @param int|false $page_id WP_Post ID of the archive page being displayed.
*/
return apply_filters( 'llms_archive_description', llms_content( $content ), $page_id );
}
}
/**
* Output a LifterLMS Loop
*
* @param obj $query WP_Query, uses global $wp_query if not supplied
* @return void
* @since 3.14.0
* @version 3.14.0
*/
function lifterlms_loop( $query = null ) {
global $wp_query;
$temp = null;
if ( $query ) {
$temp = $wp_query;
$wp_query = $query;
}
if ( have_posts() ) {
/**
* lifterlms_before_loop hook
*
* @hooked lifterlms_loop_start - 10
*/
do_action( 'lifterlms_before_loop' );
while ( have_posts() ) {
the_post();
llms_get_template_part( 'loop/content', get_post_type() );
}
/**
* lifterlms_before_loop hook
*
* @hooked lifterlms_loop_end - 10
*/
do_action( 'lifterlms_after_loop' );
llms_get_template_part( 'loop/pagination' );
} else {
llms_get_template( 'loop/none-found.php' );
}
if ( $query ) {
$wp_query = $temp;
wp_reset_postdata();
}
}
/**
* Link pagination helper.
*
* This is a wrapper around WP's `paginate_links()` method with common styling
* and helpers for use within LifterLMS.
*
* @since 6.0.0
*
* @param array $args {
* Pagination arguments.
*
* @type integer $current Current page number. Defaults to `1` or the value of `get_query_var( 'paged' )`.
* @type integer $total Total number of pages to display. Defaults to `1` or `$wp_query->max_num_pages`.
* @type string $context Display context. Adds additional customization depending on the context. Supported
* contexts are "student_dashboard" which automatically filters links for use on the
* dashboard.
* }
* @return string
*/
function llms_paginate_links( $args ) {
global $wp_query;
$args = wp_parse_args(
$args,
array(
'current' => max( 1, get_query_var( 'paged' ) ),
'total' => max( 1, $wp_query->max_num_pages ),
'context' => '',
)
);
// Don't display pagination if there's only one page of results and `show_for_single` isn't explicitly enabled.
if ( $args['total'] <= 1 ) {
return '';
}
/**
* Filter the list of CSS classes on the pagination wrapper element.
*
* @since 4.10.0
*
* @param string[] $classes Array of CSS classes.
*/
$classes = apply_filters( 'llms_get_pagination_wrapper_classes', array( 'llms-pagination' ) );
if ( 'student_dashboard' === $args['context'] ) {
add_filter( 'paginate_links', 'llms_modify_dashboard_pagination_links' );
}
$links = paginate_links(
array(
'base' => str_replace( 999999, '%#%', get_pagenum_link( 999999, false ) ),
'format' => '?page=%#%',
'total' => $args['total'],
'current' => $args['current'],
'prev_next' => true,
// Translators: %s = Left double arrow character.
'prev_text' => sprintf( _x( '%s Previous', 'pagination link text', 'lifterlms' ), '«' ),
// Translators: %s = Right double arrow character.
'next_text' => sprintf( _x( 'Next %s', 'pagination link text', 'lifterlms' ), '»' ),
'type' => 'list',
)
);
if ( 'student_dashboard' === $args['context'] ) {
remove_filter( 'paginate_links', 'llms_modify_dashboard_pagination_links' );
}
return sprintf(
'<nav class="%1$s">%2$s</nav>',
esc_attr( implode( ' ', $classes ) ),
$links
);
}
/**
* Retrieve the number of columns for llms loops
*
* @return int
* @since 3.14.0
* @version 3.14.0
*/
function llms_get_loop_columns() {
return absint( apply_filters( 'lifterlms_loop_columns', 3 ) );
}
/**
* Get classes to add to the loop wrapper based on the queried object
* Used in templates/loop/loop-start.php
*
* @return string
* @since 3.0.0
* @version 3.14.0
*/
function llms_get_loop_list_classes() {
$classes = array();
$obj = get_queried_object();
if ( $obj && $obj->name ) {
$classes[] = 'llms-' . str_replace( 'llms_', '', $obj->name ) . '-list';
}
$classes[] = sprintf( 'cols-%d', llms_get_loop_columns() );
return ' ' . implode( ' ', apply_filters( 'llms_get_loop_list_classes', $classes ) );
}
/**
* Get archive loop end
*
* @return void
* @since 1.0.0
* @version 3.0.0
*/
if ( ! function_exists( 'lifterlms_loop_end' ) ) {
function lifterlms_loop_end() {
llms_get_template( 'loop/loop-end.php' );
}
}
/**
* Output a featured video on the course tile in a LifterLMS Loop.
*
* @since 3.3.0
* @since 7.1.3 Add div tag to wrap featured video output in loop.
*
* @return void
*/
function lifterlms_loop_featured_video() {
global $post;
if ( 'course' === $post->post_type || 'llms_membership' === $post->post_type ) {
$product = llms_get_post( $post );
if ( 'yes' === $product->get( 'tile_featured_video' ) ) {
$video = $product->get_video();
if ( $video ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo '<div class="llms-video-wrapper">' . $video . '</div>';
}
}
}
}
/**
* Archive loop link end
*
* @return void
* @since 1.0.0
* @version 3.0.0
*/
if ( ! function_exists( 'lifterlms_loop_link_end' ) ) {
function lifterlms_loop_link_end() {
echo '</a><!-- .llms-loop-link -->';
}
}
/**
* Archive loop link start
*
* @return void
* @since 1.0.0
* @version 3.0.0
*/
if ( ! function_exists( 'lifterlms_loop_link_start' ) ) {
function lifterlms_loop_link_start() {
echo '<a class="llms-loop-link" href="' . esc_url( get_the_permalink() ) . '">';
}
}
/**
* Get Archive loop start
*
* @return void
* @since 1.0.0
* @version 3.0.0
*/
if ( ! function_exists( 'lifterlms_loop_start' ) ) {
function lifterlms_loop_start() {
llms_get_template( 'loop/loop-start.php' );
}
}
/**
* Get loop item author template
*
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_loop_author' ) ) {
function lifterlms_template_loop_author() {
llms_get_template( 'loop/author.php' );
}
}
/**
* Course Difficulty Template Include
*
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_loop_difficulty' ) ) {
function lifterlms_template_loop_difficulty() {
if ( 'course' === get_post_type( get_the_ID() ) ) {
llms_get_template( 'course/difficulty.php' );
}
}
}
/**
* Count of total lessons in a course.
*
* @since 7.5.0
*
* @return void.
*/
if ( ! function_exists( 'lifterlms_template_loop_lesson_count' ) ) {
function lifterlms_template_loop_lesson_count() {
if ( 'course' === get_post_type( get_the_ID() ) ) {
llms_get_template( 'course/lesson-count.php' );
}
}
}
if ( ! function_exists( 'lifterlms_template_loop_featured_pricing_information' ) ) {
function lifterlms_template_loop_featured_pricing_information() {
if ( in_array( get_post_type( get_the_ID() ), array( 'course', 'llms_membership' ) ) ) {
llms_get_template( 'loop/featured-pricing.php' );
}
}
}
/**
* Show enrollment date meta
* used on Dashboard only
*
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_loop_enroll_date' ) ) {
function lifterlms_template_loop_enroll_date() {
llms_get_template( 'loop/enroll-date.php' );
}
}
/**
* Show enrollment status meta
* used on dashboard only
*
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_loop_enroll_status' ) ) {
function lifterlms_template_loop_enroll_status() {
llms_get_template( 'loop/enroll-status.php' );
}
}
/**
* Lesson Length Template Include
*
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_loop_length' ) ) {
function lifterlms_template_loop_length() {
if ( 'course' === get_post_type( get_the_ID() ) ) {
llms_get_template( 'course/length.php' );
}
}
}
/**
* Archive loop progress bar for courses
*
* @return void
* @since 1.0.0
* @version 3.0.0
*/
if ( ! function_exists( 'lifterlms_template_loop_progress' ) ) {
function lifterlms_template_loop_progress() {
$uid = get_current_user_id();
$cid = get_the_ID();
if ( 'course' === get_post_type() && $uid ) {
$student = new LLMS_Student( $uid );
lifterlms_course_progress_bar( $student->get_progress( $cid, 'course' ), false, false );
}
}
}
/**
* Product Thumbnail Template Include
*
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_loop_thumbnail' ) ) {
function lifterlms_template_loop_thumbnail() {
llms_get_template( 'loop/featured-image.php' );
}
}
================================================
FILE: includes/functions/llms.functions.templates.pricing.table.php
================================================
<?php
/**
* Template functions for pricing tables
*
* @package LifterLMS/Functions
*
* @since 3.23.0
* @version 3.38.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Retrieve a list of CSS classes for a single access plan element
*
* @since 3.23.0
*
* @param LLMS_Access_Plan $plan Access plan object.
* @return string
*/
function llms_get_access_plan_classes( $plan ) {
$classes = array(
'llms-access-plan',
sprintf( 'llms-access-plan-%d', $plan->get( 'id' ) ),
);
if ( $plan->is_featured() ) {
$classes[] = 'featured';
}
if ( $plan->is_on_sale() ) {
$classes[] = 'on-sale';
}
return implode( ' ', apply_filters( 'llms_access_plan_classes', $classes, $plan ) );
}
if ( ! function_exists( 'llms_template_access_plan' ) ) {
/**
* Include single access plan template within the pricing table
*
* @since 3.23.0
*
* @param LLMS_Access_Plan $plan Access plan object.
* @return void
*/
function llms_template_access_plan( $plan ) {
llms_get_template(
'product/access-plan.php',
compact( 'plan' )
);
}
}
if ( ! function_exists( 'llms_template_access_plan_button' ) ) {
/**
* Include Single Access Plan Button Template
*
* @since 3.23.0
*
* @param LLMS_Access_Plan $plan Access plan object.
* @return void
*/
function llms_template_access_plan_button( $plan ) {
llms_get_template(
'product/access-plan-button.php',
compact( 'plan' )
);
}
}
if ( ! function_exists( 'llms_template_access_plan_description' ) ) {
/**
* Include Single Access Plan Description Template
*
* @since 3.23.0
*
* @param LLMS_Access_Plan $plan Access plan object.
* @return void
*/
function llms_template_access_plan_description( $plan ) {
llms_get_template(
'product/access-plan-description.php',
compact( 'plan' )
);
}
}
if ( ! function_exists( 'llms_template_access_plan_feature' ) ) {
/**
* Include Single Access Plan Featured Template
*
* @since 3.23.0
*
* @param LLMS_Access_Plan $plan Access plan object.
* @return void
*/
function llms_template_access_plan_feature( $plan ) {
llms_get_template(
'product/access-plan-feature.php',
compact( 'plan' )
);
}
}
if ( ! function_exists( 'llms_template_access_plan_pricing' ) ) {
/**
* Include Single Access Plan pricing Template
*
* @since 3.23.0
*
* @param LLMS_Access_Plan $plan Access plan object.
* @return void
*/
function llms_template_access_plan_pricing( $plan ) {
llms_get_template(
'product/access-plan-pricing.php',
compact( 'plan' )
);
}
}
if ( ! function_exists( 'llms_template_access_plan_restrictions' ) ) {
/**
* Include Single Access Plan restrictions Template
*
* @since 3.23.0
*
* @param LLMS_Access_Plan $plan Access plan object.
* @return void
*/
function llms_template_access_plan_restrictions( $plan ) {
llms_get_template(
'product/access-plan-restrictions.php',
compact( 'plan' )
);
}
}
if ( ! function_exists( 'llms_template_access_plan_title' ) ) {
/**
* Include Single Access Plan title Template
*
* @since 3.23.0
*
* @param LLMS_Access_Plan $plan Access plan object.
* @return void
*/
function llms_template_access_plan_title( $plan ) {
llms_get_template(
'product/access-plan-title.php',
compact( 'plan' )
);
}
}
if ( ! function_exists( 'llms_template_access_plan_trial' ) ) {
/**
* Include Single Access Plan trial Template
*
* @since 3.23.0
*
* @param LLMS_Access_Plan $plan Access plan object.
* @return void
*/
function llms_template_access_plan_trial( $plan ) {
llms_get_template(
'product/access-plan-trial.php',
compact( 'plan' )
);
}
}
if ( ! function_exists( 'llms_template_product_not_purchasable' ) ) {
/**
* Include template for products that aren't purchasable
*
* @since 3.38.0
*
* @param int $post_id Optional. WP Post ID of the product. Default is ID of the global $post.
* @return void
*/
function llms_template_product_not_purchasable( $post_id = null ) {
$post_id = $post_id ? $post_id : get_the_ID();
$product = new LLMS_Product( $post_id );
llms_get_template(
'product/not-purchasable.php',
compact( 'product' )
);
}
}
if ( ! function_exists( 'lifterlms_template_pricing_table' ) ) {
/**
* Include pricing table for a LifterLMS Product (course or membership)
*
* @since 3.0.0
* @since 3.38.0 Fixed spelling error in variable passed to template.
* @since 6.0.0 Removed the deprecated and misspelled `$purchaseable` global variable.
*
* @param int $post_id Optional. WP Post ID of the product. Default is ID of the global $post.
* @return void
*/
function lifterlms_template_pricing_table( $post_id = null ) {
$post_id = $post_id ? $post_id : get_the_ID();
$product = new LLMS_Product( $post_id );
/**
* Filter current user's enrollment status
*
* This filter is used to customize the output behavior of the pricing table.
* It does not modify the user's enrollment status.
*
* @since Unknown
* @since 9.1.2 Added product param.
*
* @param boolean $is_enrolled User's current enrollment status.
* @param LLMS_Product $product Product for the pricing table.
*/
$is_enrolled = apply_filters(
'llms_product_pricing_table_enrollment_status',
llms_is_user_enrolled( get_current_user_id(), $product->get( 'id' ) ),
$product
);
$purchasable = $product->is_purchasable();
$has_free = $product->has_free_access_plan();
$has_restrictions = $product->has_restrictions();
llms_get_template(
'product/pricing-table.php',
compact( 'product', 'is_enrolled', 'purchasable', 'has_free', 'has_restrictions' )
);
}
}
================================================
FILE: includes/functions/llms.functions.templates.privacy.php
================================================
<?php
/**
* Privacy related template functions
*
* @package LifterLMS/Functions
*
* @since 3.18.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Get the HTML for the Terms field displayed on reg forms
*
* @since 3.0.0
* @since 3.18.1 Unknown.
*
* @param boolean $echo Echo the data if true, return otherwise.
* @return string
*/
if ( ! function_exists( 'llms_agree_to_terms_form_field' ) ) {
function llms_agree_to_terms_form_field( $echo = true ) {
// Because `do_action()` passes empty string.
if ( '' === $echo ) {
$echo = true;
}
$ret = '';
if ( llms_are_terms_and_conditions_required() ) {
$ret = llms_form_field(
array(
'columns' => 12,
'description' => '',
'default' => 'no',
'id' => 'llms_agree_to_terms',
'label' => llms_get_terms_notice( true ),
'last_column' => true,
'required' => true,
'type' => 'checkbox',
'value' => 'yes',
'wrapper_classes' => 'llms-agree-to-terms-wrapper',
),
false
);
}
$ret = apply_filters( 'llms_agree_to_terms_form_field', $ret, $echo );
if ( $echo ) {
echo wp_kses( $ret, LLMS_ALLOWED_HTML_FORM_FIELDS );
return;
}
return $ret;
}
}
/**
* Get the HTML for the Privacy Policy section on checkout / registration forms
*
* @since 3.0.0
* @since 3.18.1 Unknown.
* @since 5.0.0 Update to support changes to `llms_form_field()`.
*
* @param boolean $echo Echo the data if true, return otherwise.
* @return string
*/
if ( ! function_exists( 'llms_privacy_policy_form_field' ) ) {
function llms_privacy_policy_form_field( $echo = true ) {
// Because `do_action()` passes empty string.
if ( '' === $echo ) {
$echo = true;
}
$ret = '';
$notice = llms_get_privacy_notice( true );
if ( $notice ) {
$ret = llms_form_field(
array(
'columns' => 12,
'value' => '<p>' . $notice . '</p>',
'last_column' => true,
'type' => 'html',
'id' => 'llms-privacy-policy',
),
false
);
}
$ret = apply_filters( 'llms_privacy_policy_form_field', $ret, $echo );
if ( $echo ) {
echo wp_kses( $ret, LLMS_ALLOWED_HTML_FORM_FIELDS );
return;
}
return $ret;
}
}
================================================
FILE: includes/functions/llms.functions.templates.quizzes.php
================================================
<?php
/**
* Template functions for quizzes & questions
*
* @package LifterLMS/Functions
*
* @since 1.0.0
* @version 3.16.0
*/
if ( ! defined( 'ABSPATH' ) ) {
exit; }
/**
* Single question main content template
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
if ( ! function_exists( 'lifterlms_template_question_content' ) ) {
function lifterlms_template_question_content( $args ) {
$type = $args['question']->get( 'question_type' );
$template = apply_filters( 'llms_get_' . $type . '_question_template', 'quiz/questions/content-' . $type, $args['question'] );
llms_get_template(
$template . '.php',
array(
'question' => $args['question'],
'attempt' => $args['attempt'],
)
);
}
}
/**
* Single question description template
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
if ( ! function_exists( 'lifterlms_template_question_description' ) ) {
function lifterlms_template_question_description( $args ) {
llms_get_template( 'quiz/questions/description.php', $args );
}
}
/**
* Single question featured image template
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
if ( ! function_exists( 'lifterlms_template_question_image' ) ) {
function lifterlms_template_question_image( $args ) {
llms_get_template( 'quiz/questions/image.php', $args );
}
}
/**
* Single question featured video template
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
if ( ! function_exists( 'lifterlms_template_question_video' ) ) {
function lifterlms_template_question_video( $args ) {
llms_get_template( 'quiz/questions/video.php', $args );
}
}
/**
* Question Wrapper End Template Include
*
* @return void
* @since 1.0.0
* @version 3.16.0
*/
if ( ! function_exists( 'lifterlms_template_question_wrapper_end' ) ) {
function lifterlms_template_question_wrapper_end( $args ) {
llms_get_template( 'quiz/questions/wrapper-end.php', $args );
}
}
/**
* Question Wrapper Start Template Include
*
* @return void
* @since 1.0.0
* @version 3.16.0
*/
if ( ! function_exists( 'lifterlms_template_question_wrapper_start' ) ) {
function lifterlms_template_question_wrapper_start( $args ) {
llms_get_template( 'quiz/questions/wrapper-start.php', $args );
}
}
/**
* Passing Percent Template Include
*
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_quiz_meta_info' ) ) {
function lifterlms_template_quiz_meta_info() {
llms_get_template( 'quiz/meta-information.php' );
}
}
/**
* Quiz Single Attempt Results
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
if ( ! function_exists( 'lifterlms_template_quiz_attempt_results' ) ) {
function lifterlms_template_quiz_attempt_results( $attempt = null ) {
llms_get_template(
'quiz/results-attempt.php',
array(
'attempt' => $attempt,
)
);
}
}
/**
* Quiz Single Attempt Results Question List
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
if ( ! function_exists( 'lifterlms_template_quiz_attempt_results_questions_list' ) ) {
function lifterlms_template_quiz_attempt_results_questions_list( $attempt = null ) {
llms_get_template(
'quiz/results-attempt-questions-list.php',
array(
'attempt' => $attempt,
)
);
}
}
/**
* Quiz Results Template Include
*
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_quiz_results' ) ) {
function lifterlms_template_quiz_results() {
llms_get_template( 'quiz/results.php' );
}
}
/**
* Lesson Return link Template Include
*
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_quiz_return_link' ) ) {
function lifterlms_template_quiz_return_link() {
llms_get_template( 'quiz/return-to-lesson.php' );
}
}
/**
* Quiz: wrapper end ( quiz container )
*
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_quiz_wrapper_end' ) ) {
function lifterlms_template_quiz_wrapper_end() {
llms_get_template( 'quiz/quiz-wrapper-end.php' );
}
}
/**
* Quiz: wrapper start ( quiz container )
*
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_quiz_wrapper_start' ) ) {
function lifterlms_template_quiz_wrapper_start() {
llms_get_template( 'quiz/quiz-wrapper-start.php' );
}
}
/**
* Start Button Template Include
*
* @todo this should be renamed to lifterlms_template_quiz_start_button
* @return void
* @since 1.0.0
* @version 1.0.0
*/
if ( ! function_exists( 'lifterlms_template_start_button' ) ) {
function lifterlms_template_start_button() {
llms_get_template( 'quiz/start-button.php' );
}
}
================================================
FILE: includes/functions/llms.functions.updates.php
================================================
<?php
/**
* LifterLMS Update Functions
*
* Functions here are used by the background updater during db updates.
*
* @package LifterLMS/Functions
*
* @since 3.4.3
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
// Include all update function files.
foreach ( glob( LLMS_PLUGIN_DIR . 'includes/functions/updates/llms-functions-updates-*.php' ) as $filename ) {
require_once $filename;
}
/**
* Get the number of items per page used in paginated migration queries.
*
* @since 6.0.0
*
* @return int
*/
function llms_update_util_get_items_per_page() {
/**
* Filters the number of items per page in migration queries.
*
* This filter exists primarily to allow phpunit tests for migration
* functions and queries to reduce the number of items per query. In this
* way pagination functionality can be tested without having to tests
* a large number of items.
*
* @since 6.0.0
*
* @param int $per_page Number of items per page.
*/
return apply_filters( 'llms_update_items_per_page', 50 );
}
/**
* Duplicate a WP Post & all relate metadata.
*
* @since 3.16.0
*
* @param int $id WP Post ID.
* @return int WP Post ID of the new duplicate.
*/
function llms_update_util_post_duplicator( $id ) {
$copy = (array) get_post( $id );
unset( $copy['ID'] );
$new_id = wp_insert_post( $copy );
foreach ( get_post_custom( $id ) as $key => $values ) {
foreach ( $values as $value ) {
add_post_meta( $new_id, $key, maybe_unserialize( $value ) );
}
}
return $new_id;
}
/**
* Update the key of a postmeta item
*
* @since 3.4.3
*
* @param string $post_type Post type.
* @param string $new_key New postmeta key.
* @param string $old_key Old postmeta key.
* @return void
*/
function llms_update_util_rekey_meta( $post_type, $new_key, $old_key ) {
global $wpdb;
$wpdb->query(
$wpdb->prepare(
"UPDATE {$wpdb->prefix}postmeta AS m
INNER JOIN {$wpdb->prefix}posts AS p ON p.ID = m.post_ID
SET m.meta_key = %s
WHERE p.post_type = %s AND m.meta_key = %s;",
array( $new_key, $post_type, $old_key )
)
); // no-cache ok.
}
================================================
FILE: includes/functions/llms.functions.user.postmeta.php
================================================
<?php
/**
* CRUD LifterLMS User Postmeta Data
*
* All functions are pluggable.
*
* @package LifterLMS/Functions
*
* @since 3.21.0
* @version 3.36.3
*/
defined( 'ABSPATH' ) || exit;
/**
* CRUD LifterLMS User Postmeta Data.
*
* @since 3.21.0
* @since 3.33.0 Added `llms_bulk_delete_user_postmeta`.
* Also now `llms_delete_user_postmeta` returns true only if at least one existing user postmeta has been successfully deleted.
* @since 3.36.3 Fix doc and indentation.
*/
if ( ! function_exists( 'llms_delete_user_postmeta' ) ) :
/**
* Delete user postmeta data.
*
* @since 3.21.0
* @since 3.33.0 Returns true only if at least one existing user postmeta has been successfully deleted.
*
* @param int $user_id WP User ID.
* @param int $post_id WP Post ID.
* @param string $meta_key Optional. Meta key for lookup, if not supplied, all matching items will be removed. Default null.
* @param mixed $meta_value Optional. Meta value for lookup, if not supplied, all matching items will be removed. Default null.
*
* @return bool False if no postmetas has been deleted either because they do not exist or because of an error during the
* actual row deletion from the db. True if at least one existing user postmeta has been successfully deleted.
*/
function llms_delete_user_postmeta( $user_id, $post_id, $meta_key = null, $meta_value = null ) {
$ret = false;
$existing = _llms_query_user_postmeta( $user_id, $post_id, $meta_key, maybe_unserialize( $meta_value ) );
if ( $existing ) {
foreach ( $existing as $obj ) {
$item = new LLMS_User_Postmeta( $obj->meta_id, false );
if ( ! $item->delete() ) {
$ret = $ret || false;
} else {
$ret = true;
}
}
}
return $ret;
}
endif;
if ( ! function_exists( 'llms_bulk_delete_user_postmeta' ) ) :
/**
* Bulk remove user postmeta data.
*
* @since 3.33.0
*
* @param int $user_id WP User ID.
* @param int $post_id WP Post ID.
* @param array $data Optional. Associative array of meta keys => meta values to delete.
* If not meta values supplied, all matching items will be removed. Default empty array.
* @return array|boolean On error returns an associative array of the submitted keys, each item will be true for success or false for error.
* On success returns true.
*/
function llms_bulk_delete_user_postmeta( $user_id, $post_id, $data = array() ) {
$res = array_fill_keys( array_keys( $data ), null );
$err = false;
if ( ! empty( $data ) ) {
foreach ( $data as $key => $value ) {
$delete = llms_delete_user_postmeta( $user_id, $post_id, $key, $value );
$res[ $key ] = $delete;
if ( ! $delete ) {
$err = true;
}
}
} else {
$res = llms_delete_user_postmeta( $user_id, $post_id );
$err = ! $res;
}
return $err ? $res : true;
}
endif;
if ( ! function_exists( 'llms_get_user_postmeta' ) ) :
/**
* Get user postmeta data or dates by user, post, and key.
*
* @since 3.21.0
*
* @param int $user_id WP User ID.
* @param int $post_id WP Post ID.
* @param string $meta_key Optional. Meta key, if not supplied returns associative array of all metadata found for the given user / post. Default null.
* @param bool $single Optional. If true, returns only the data. Default true.
* @param string $return Optional. Determine if the meta value or updated date should be returned [meta_value,updated_date]. Default 'meta_value'.
* @return mixed
*/
function llms_get_user_postmeta( $user_id, $post_id, $meta_key = null, $single = true, $return = 'meta_value' ) {
$single = is_null( $meta_key ) ? false : $single;
$res = array();
$metas = _llms_query_user_postmeta( $user_id, $post_id, $meta_key );
if ( count( $metas ) ) {
foreach ( $metas as $meta ) {
if ( $meta_key ) {
$res[ $meta_key ][] = maybe_unserialize( $meta->$return );
} else {
$res[ $meta->meta_key ][] = maybe_unserialize( $meta->$return );
}
}
}
if ( $single ) {
return count( $res ) ? $res[ $meta_key ][0] : '';
} elseif ( $meta_key ) {
return count( $res ) ? $res[ $meta_key ] : array();
}
return $res;
}
endif;
if ( ! function_exists( 'llms_update_user_postmeta' ) ) :
/**
* Update user postmeta data.
*
* @since 3.21.0
*
* @param int $user_id WP User ID.
* @param int $post_id WP Post ID.
* @param string $meta_key Meta key.
* @param mixed $meta_value Meta value (don't serialize serializable values).
* @param bool $unique Optional. If true, updates existing value (if it exists).
* If false, will add a new record (allowing multiple records with the same key to exist).
* Deafult true.
* @return bool
*/
function llms_update_user_postmeta( $user_id, $post_id, $meta_key, $meta_value, $unique = true ) {
$item = false;
// if unique is true, make an update to the existing item (if it exists).
if ( $unique ) {
// locate the item.
$existing = _llms_query_user_postmeta( $user_id, $post_id, $meta_key );
if ( $existing ) {
// load it and make sure it exists.
$item = new LLMS_User_Postmeta( $existing[0]->meta_id, false );
if ( ! $item->exists() ) {
$item = false;
}
}
}
if ( ! $item ) {
$item = new LLMS_User_Postmeta();
}
// setup the data we want to store.
$updated_date = llms_current_time( 'mysql' );
$meta_value = maybe_serialize( $meta_value );
$item->setup( compact( 'user_id', 'post_id', 'meta_key', 'meta_value', 'updated_date' ) );
return $item->save();
}
endif;
if ( ! function_exists( 'llms_bulk_update_user_postmeta' ) ) :
/**
* Update bulk update user postmeta data.
*
* @since 3.21.0
*
* @param int $user_id WP User ID.
* @param int $post_id WP Post ID.
* @param array $data Optional. Associative array of meta keys => meta values to update.
* Default empty array.
* @param bool $unique Optional. If true, updates existing value (if it exists).
* If false, will add a new record (allowing multiple records with the same key to exist).
* Deafult true.
* @return array|true On error returns an associative array of the submitted keys, each item will be true for success or false for error.
* On success returns true.
*/
function llms_bulk_update_user_postmeta( $user_id, $post_id, $data = array(), $unique = true ) {
$res = array_fill_keys( array_keys( $data ), null );
$err = false;
foreach ( $data as $key => $val ) {
$update = llms_update_user_postmeta( $user_id, $post_id, $key, $val, $unique );
$res[ $key ] = $update;
if ( ! $update ) {
$err = true;
}
}
return $err ? $res : true;
}
endif;
if ( ! function_exists( '_llms_query_user_postmeta' ) ) :
/**
* Query user postmeta data.
* This function is marked for internal use only.
*
* @since 3.21.0
*
* @access private
*
* @param int $user_id WP User ID.
* @param int $post_id WP Post ID.
* @param string $meta_key Optional. Meta key. Default null.
* @param string $meta_value Optional. Meta value. Default null.
* @return array
*/
function _llms_query_user_postmeta( $user_id, $post_id, $meta_key = null, $meta_value = null ) {
global $wpdb;
$key = $meta_key ? $wpdb->prepare( 'AND meta_key = %s', $meta_key ) : '';
$val = $meta_value ? $wpdb->prepare( 'AND meta_value = %s', $meta_value ) : '';
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$res = $wpdb->get_results(
$wpdb->prepare(
"SELECT * FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE user_id = %d AND post_id = %d {$key} {$val} ORDER BY updated_date DESC",
$user_id,
$post_id
)
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $res;
}
endif;
================================================
FILE: includes/functions/updates/index.php
================================================
<?php // quiet.
================================================
FILE: includes/functions/updates/llms-functions-updates-300.php
================================================
<?php
/**
* Update functions for version 3.0.0
*
* @package LifterLMS/Functions/Updates
*
* @since 3.39.0
* @version 3.39.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Creates access plans for each course & membership
*
* Creates up to 3 plans per course and up to two plans per membership.
*
* Migrates price & subscription data to a single & recurring plan where applicable.
*
* If course is restricted to a membership a free members only plan will be created
* in addition to paid open recurring & single plans.
*
* If course is restricted to a membership and no price is found
* only one free members only plan will be created.
*
* @since 3.0.0
*
* @return void
*/
function llms_update_300_create_access_plans() {
$courses = new WP_Query(
array(
'post_type' => array( 'course', 'llms_membership' ),
'posts_per_page' => -1,
'status' => 'any',
)
);
if ( $courses->have_posts() ) {
foreach ( $courses->posts as $post ) {
$meta = get_post_meta( $post->ID );
$is_free = ( ! $meta['_price'][0] || floatval( 0 ) === floatval( $meta['_price'][0] ) );
$has_recurring = ( 1 == $meta['_llms_recurring_enabled'][0] );
if ( 'course' === $post->post_type ) {
$members_only = ( 'on' === $meta['_llms_is_restricted'][0] && $meta['_llms_restricted_levels'][0] );
} else {
$members_only = false;
}
// Base plan for single & recurring.
$base_plan = array(
'access_expiration' => 'lifetime',
'availability' => 'open',
'availability_restrictions' => array(),
'content' => '',
'enroll_text' => ( 'course' === $post->post_type ) ? __( 'Enroll', 'lifterlms' ) : __( 'Join', 'lifterlms' ),
'featured' => 'no',
'frequency' => 0,
'is_free' => 'no',
'product_id' => $post->ID,
'sku' => $meta['_sku'][0],
'trial_offer' => 'no',
);
$single = array_merge(
array(
'price' => $meta['_price'][0],
),
$base_plan
);
$recurring = array_merge(
array(
'price' => $meta['_llms_subscription_price'][0],
),
$base_plan
);
/**
* Determine what kinds of plans to create
*/
// Free and members only, only available to members.
if ( $is_free && $members_only ) {
$free_members_only = true;
$single_paid_open = false;
$single_free_open = false;
$recurring_paid = false;
} elseif ( ! $is_free && $members_only ) {
$free_members_only = true;
$single_paid_open = true;
$single_free_open = false;
$recurring_paid = $has_recurring;
} else {
// No restrictions, normal settings apply.
$free_members_only = false;
$single_paid_open = ! $is_free ? true : false;
$single_free_open = $is_free ? true : false;
$recurring_paid = $has_recurring;
}
$order = 1;
/**
* CREATE THE PLANS
*/
if ( $free_members_only ) {
$plan = $single;
$plan['menu_order'] = $order;
$plan['is_free'] = 'yes';
$plan['sku'] = ! empty( $plan['sku'] ) ? $plan['sku'] . '-membersonly' : '';
$plan['availability'] = 'members';
$plan['availability_restrictions'] = unserialize( $meta['_llms_restricted_levels'][0] );
$obj = new LLMS_Access_Plan( 'new', __( 'Members Only', 'lifterlms' ) );
foreach ( $plan as $key => $val ) {
$obj->set( $key, $val );
}
unset( $plan );
$order++;
}
if ( $single_paid_open ) {
$plan = $single;
$plan['menu_order'] = $order;
$plan['sku'] = ! empty( $plan['sku'] ) ? $plan['sku'] . '-onetime' : '';
$plan['on_sale'] = ! empty( $meta['_sale_price'][0] ) ? 'yes' : 'no';
if ( 'yes' === $plan['on_sale'] ) {
$plan['sale_end'] = ! empty( $meta['_sale_price_dates_to'][0] ) ? date( 'm/d/Y', strtotime( $meta['_sale_price_dates_to'][0] ) ) : '';
$plan['sale_start'] = ! empty( $meta['_sale_price_dates_from'][0] ) ? date( 'm/d/Y', strtotime( $meta['_sale_price_dates_from'][0] ) ) : '';
$plan['sale_price'] = $meta['_sale_price'][0];
}
$obj = new LLMS_Access_Plan( 'new', __( 'One-Time Payment', 'lifterlms' ) );
foreach ( $plan as $key => $val ) {
$obj->set( $key, $val );
}
unset( $plan );
$order++;
}
if ( $single_free_open ) {
$plan = $single;
$plan['menu_order'] = $order;
$plan['is_free'] = 'yes';
$plan['sku'] = ! empty( $plan['sku'] ) ? $plan['sku'] . '-free' : '';
$obj = new LLMS_Access_Plan( 'new', __( 'Free', 'lifterlms' ) );
foreach ( $plan as $key => $val ) {
$obj->set( $key, $val );
}
unset( $plan );
$order++;
}
if ( $recurring_paid ) {
$plan = $recurring;
$plan['menu_order'] = $order;
$plan['sku'] = ! empty( $plan['sku'] ) ? $plan['sku'] . '-subscription' : '';
if ( isset( $meta['_llms_subscription_first_payment'][0] ) && $meta['_llms_subscription_first_payment'][0] != $meta['_llms_subscription_price'][0] ) {
$plan['trial_offer'] = 'yes';
$plan['trial_length'] = $meta['_llms_billing_freq'][0];
$plan['trial_period'] = $meta['_llms_billing_period'][0];
$plan['trial_price'] = $meta['_llms_subscription_first_payment'][0];
}
$plan['frequency'] = $meta['_llms_billing_freq'][0];
$plan['length'] = $meta['_llms_billing_cycle'][0];
$plan['period'] = $meta['_llms_billing_period'][0];
$obj = new LLMS_Access_Plan( 'new', __( 'Subscription', 'lifterlms' ) );
foreach ( $plan as $key => $val ) {
$obj->set( $key, $val );
}
unset( $plan );
$order++;
}
$keys = array(
'_regular_price',
'_price',
'_sale_price',
'_sale_price_dates_from',
'_sale_price_dates_to',
'_on_sale',
'_llms_recurring_enabled',
'_llms_subscription_price',
'_llms_subscription_first_payment',
'_llms_billing_period',
'_llms_billing_freq',
'_llms_billing_cycle',
'_llms_subscriptions',
'_sku',
'_is_custom_single_price',
'_custom_single_price_html',
'_llms_is_restricted',
'_llms_restricted_levels',
'_llms_expiration_interval',
'_llms_expiration_period',
);
foreach ( $keys as $key ) {
delete_post_meta( $post->ID, $key );
}
}
}
}
/**
* Delete deprecated options that are no longer used by LifterLMS after 3.0.0
*
* @since 3.0.0
*
* @return void
*/
function llms_update_300_del_deprecated_options() {
/**
* Delete legacy options related to LifterLMS updating
* prior to 2.0 release. this is long overdue
*/
delete_option( 'lifterlms_is_activated' );
delete_option( 'lifterlms_update_key' );
delete_option( 'lifterlms_authkey' );
delete_option( 'lifterlms_activation_key' );
/**
* Legacy option no longer needed
*/
delete_option( 'lifterlms_student_role_created' );
/**
* Delete course and membership display & related options
* these are now filters or can be handled with action hooks
* moving forward
*/
delete_option( 'lifterlms_button_purchase_membership_custom_text' );
delete_option( 'lifterlms_course_display_outline_lesson_thumbnails' );
delete_option( 'lifterlms_course_display_author' );
delete_option( 'lifterlms_course_display_banner' );
delete_option( 'lifterlms_course_display_difficulty' );
delete_option( 'lifterlms_course_display_length' );
delete_option( 'lifterlms_course_display_categories' );
delete_option( 'lifterlms_course_display_tags' );
delete_option( 'lifterlms_course_display_tracks' );
delete_option( 'lifterlms_lesson_nav_display_excerpt' );
delete_option( 'lifterlms_course_display_outline' );
delete_option( 'lifterlms_course_display_outline_titles' );
delete_option( 'lifterlms_course_display_outline_lesson_thumbnails' );
delete_option( 'lifterlms_display_lesson_complete_placeholders' );
delete_option( 'redirect_to_checkout' );
}
/**
* Migrate deprecated account field related options to new ones
*
* @since 3.0.0
*
* @return void
*/
function llms_update_300_migrate_account_field_options() {
$email_confirm = get_option( 'lifterlms_registration_confirm_email' );
if ( 'yes' === $email_confirm ) {
$email_confirm = 'yes';
} elseif ( 'no' === $email_confirm ) {
$email_confirm = 'no';
} else {
$email_confirm = false;
}
$names = get_option( 'lifterlms_registration_require_name' );
if ( 'yes' === $names ) {
$names = 'required';
} elseif ( 'no' === $names ) {
$names = 'hidden';
} else {
$names = false;
}
$addresses = get_option( 'lifterlms_registration_require_address' );
if ( 'yes' === $addresses ) {
$addresses = 'required';
} elseif ( 'no' === $addresses ) {
$addresses = 'hidden';
} else {
$addresses = false;
}
$phone = get_option( 'lifterlms_registration_add_phone' );
if ( 'yes' === $phone ) {
$phone = 'optional';
} elseif ( 'no' === $phone ) {
$phone = 'hidden';
} else {
$phone = false;
}
foreach ( array( 'checkout', 'registration', 'account' ) as $screen ) {
if ( $email_confirm ) {
update_option( 'lifterlms_user_info_field_email_confirmation_' . $screen . '_visibility', $email_confirm );
}
if ( $names ) {
update_option( 'lifterlms_user_info_field_names_' . $screen . '_visibility', $names );
}
if ( $addresses ) {
update_option( 'lifterlms_user_info_field_address_' . $screen . '_visibility', $addresses );
}
if ( $phone ) {
update_option( 'lifterlms_user_info_field_phone_' . $screen . '_visibility', $phone );
}
}
delete_option( 'lifterlms_registration_confirm_email' );
delete_option( 'lifterlms_registration_require_name' );
delete_option( 'lifterlms_registration_require_address' );
delete_option( 'lifterlms_registration_add_phone' );
}
/**
* Move coupon title (previously used for description) to the postmeta table in the new description field
* Move old coupon code from meta table to the coupon post title *
*
* @since 3.0.0
*
* @return void
*/
function llms_update_300_migrate_coupon_data() {
global $wpdb;
$coupon_title_metas = $wpdb->get_results(
"SELECT * FROM {$wpdb->postmeta}
WHERE meta_key = '_llms_coupon_title';"
);
foreach ( $coupon_title_metas as $obj ) {
// Update new description field with the title b/c the title previously acted as a description.
update_post_meta( $obj->post_id, '_llms_description', get_the_title( $obj->post_id ) );
// Update the post title to be the value of the old meta field.
wp_update_post(
array(
'ID' => $obj->post_id,
'post_title' => $obj->meta_value,
)
);
// Clean up.
delete_post_meta( $obj->post_id, '_llms_coupon_title' );
}
}
/**
* Update keys of course meta fields for consistency
*
* @since 3.0.0
*
* @return void
*/
function llms_update_300_migrate_course_postmeta() {
global $wpdb;
// Rekey meta fields.
llms_update_util_rekey_meta( 'course', '_llms_audio_embed', '_audio_embed' );
llms_update_util_rekey_meta( 'course', '_llms_video_embed', '_video_embed' );
llms_update_util_rekey_meta( 'course', '_llms_has_prerequisite', '_has_prerequisite' );
llms_update_util_rekey_meta( 'course', '_llms_length', '_lesson_length' );
llms_update_util_rekey_meta( 'course', '_llms_capacity', '_lesson_max_user' );
llms_update_util_rekey_meta( 'course', '_llms_prerequisite', '_prerequisite' );
llms_update_util_rekey_meta( 'course', '_llms_prerequisite_track', '_prerequisite_track' );
llms_update_util_rekey_meta( 'course', '_llms_start_date', '_course_dates_from' );
llms_update_util_rekey_meta( 'course', '_llms_end_date', '_course_dates_to' );
// Updates course enrollment settings and reformats existing dates.
$dates = $wpdb->get_results(
"SELECT m.meta_id, m.post_id, m.meta_value
FROM {$wpdb->postmeta} AS m
INNER JOIN {$wpdb->posts} AS p ON p.ID = m.post_ID
WHERE p.post_type = 'course' AND ( m.meta_key = '_llms_start_date' OR m.meta_key = '_llms_end_date' );"
); // db call ok; no-cache ok.
foreach ( $dates as $r ) {
// If no value in the field skip it otherwise we end up with start of the epoch.
if ( ! $r->meta_value ) {
continue; }
$wpdb->update(
$wpdb->postmeta,
array(
'meta_value' => date( 'm/d/Y', strtotime( $r->meta_value ) ),
),
array(
'meta_id' => $r->meta_id,
)
); // db call ok; no-cache ok.
add_post_meta( $r->post_id, '_llms_time_period', 'yes' );
add_post_meta( $r->post_id, '_llms_course_opens_message', sprintf( __( 'This course opens on [lifterlms_course_info id="%d" key="start_date"].', 'lifterlms' ), $r->post_id ) );
add_post_meta( $r->post_id, '_llms_course_closed_message', sprintf( __( 'This course closed on [lifterlms_course_info id="%d" key="end_date"].', 'lifterlms' ), $r->post_id ) );
}
// Update course capacity bool and related settings.
$capacity = $wpdb->get_results(
"SELECT m.post_id, m.meta_value
FROM {$wpdb->postmeta} AS m
INNER JOIN {$wpdb->posts} AS p ON p.ID = m.post_ID
WHERE p.post_type = 'course' AND m.meta_key = '_llms_capacity';"
); // db call ok; no-cache ok.
foreach ( $capacity as $r ) {
if ( $r->meta_value ) {
add_post_meta( $r->post_id, '_llms_enable_capacity', 'yes' );
add_post_meta( $r->post_id, '_llms_capacity_message', __( 'Enrollment has closed because the maximum number of allowed students has been reached.', 'lifterlms' ) );
}
}
// Convert numeric has_preqeq to "yes".
$prereq = $wpdb->query(
"UPDATE {$wpdb->prefix}postmeta AS m
INNER JOIN {$wpdb->prefix}posts AS p ON p.ID = m.post_ID
SET m.meta_value = 'yes'
WHERE p.post_type = 'course' AND m.meta_key = '_llms_has_prerequisite' AND m.meta_value = 1;"
); // db call ok; no-cache ok.
// Convert empty has_prereq to "no".
$prereq = $wpdb->query(
"UPDATE {$wpdb->prefix}postmeta AS m
INNER JOIN {$wpdb->prefix}posts AS p ON p.ID = m.post_ID
SET m.meta_value = 'no'
WHERE p.post_type = 'course' AND m.meta_key = '_llms_has_prerequisite' AND m.meta_value = '';"
); // db call ok; no-cache ok.
}
/**
* Update keys of email meta fields for consistency
*
* @since 3.0.0
*
* @return void
*/
function llms_update_300_migrate_email_postmeta() {
llms_update_util_rekey_meta( 'llms_email', '_llms_email_subject', '_email_subject' );
llms_update_util_rekey_meta( 'llms_email', '_llms_email_heading', '_email_heading' );
}
/**
* Update keys of lesson meta fields for consistency
*
* @since 3.0.0
*
* @return void
*/
function llms_update_300_migrate_lesson_postmeta() {
global $wpdb;
llms_update_util_rekey_meta( 'lesson', '_llms_audio_embed', '_audio_embed' );
llms_update_util_rekey_meta( 'lesson', '_llms_video_embed', '_video_embed' );
llms_update_util_rekey_meta( 'lesson', '_llms_has_prerequisite', '_has_prerequisite' );
llms_update_util_rekey_meta( 'lesson', '_llms_prerequisite', '_prerequisite' );
llms_update_util_rekey_meta( 'lesson', '_llms_days_before_available', '_days_before_avalailable' );
// Convert numeric has_preqeq to "yes".
// Convert numeric free_lesson to "yes".
// Convert numeric require_passing_grade to "yes".
$wpdb->query(
"UPDATE {$wpdb->prefix}postmeta AS m
INNER JOIN {$wpdb->prefix}posts AS p ON p.ID = m.post_ID
SET m.meta_value = 'yes'
WHERE p.post_type = 'lesson' AND (
( m.meta_key = '_llms_has_prerequisite' AND m.meta_value = 1 )
OR ( m.meta_key = '_llms_free_lesson' AND m.meta_value = 1 )
OR ( m.meta_key = '_llms_require_passing_grade' AND m.meta_value = 1 )
);"
); // db call ok; no-cache ok.
// Convert empty has_prereq to "no".
// Convert empty free_lesson to "no".
// Convert empty require_passing_grade to "no".
$wpdb->query(
"UPDATE {$wpdb->prefix}postmeta AS m
INNER JOIN {$wpdb->prefix}posts AS p ON p.ID = m.post_ID
SET m.meta_value = 'no'
WHERE p.post_type = 'lesson' AND (
( m.meta_key = '_llms_has_prerequisite' AND m.meta_value = '' )
OR ( m.meta_key = '_llms_free_lesson' AND m.meta_value = '' )
OR ( m.meta_key = '_llms_require_passing_grade' AND m.meta_value = '' )
);"
); // db call ok; no-cache ok.
// Updates course enrollment settings and reformats existing dates.
$drips = $wpdb->get_results(
"SELECT m.post_id
FROM {$wpdb->postmeta} AS m
INNER JOIN {$wpdb->posts} AS p ON p.ID = m.post_ID
WHERE p.post_type = 'lesson' AND m.meta_key = '_llms_days_before_available';"
); // db call ok; no-cache ok.
foreach ( $drips as $r ) {
add_post_meta( $r->post_id, '_llms_drip_method', 'enrollment' );
}
}
/**
* Change the post type of orders and rekey meta fields
*
* @since 3.0.0
*
* @return void
*/
function llms_update_300_migrate_order_data() {
global $wpdb;
// Prefix the old unprefixed order post type.
$wpdb->query(
"UPDATE {$wpdb->posts}
SET post_type = 'llms_order'
WHERE post_type = 'order';"
);
// Rekey postmetas.
llms_update_util_rekey_meta( 'llms_order', '_llms_payment_gateway', '_llms_payment_method' );
llms_update_util_rekey_meta( 'llms_order', '_llms_product_id', '_llms_order_product_id' );
llms_update_util_rekey_meta( 'llms_order', '_llms_currency', '_llms_order_currency' );
llms_update_util_rekey_meta( 'llms_order', '_llms_coupon_id', '_llms_order_coupon_id' );
llms_update_util_rekey_meta( 'llms_order', '_llms_coupon_code', '_llms_order_coupon_code' );
llms_update_util_rekey_meta( 'llms_order', '_llms_coupon_type', '_llms_order_coupon_type' );
llms_update_util_rekey_meta( 'llms_order', '_llms_coupon_amount', '_llms_order_coupon_amount' );
llms_update_util_rekey_meta( 'llms_order', '_llms_billing_frequency', '_llms_order_billing_freq' );
llms_update_util_rekey_meta( 'llms_order', '_llms_billing_length', '_llms_order_billing_cycle' );
llms_update_util_rekey_meta( 'llms_order', '_llms_billing_period', '_llms_order_billing_period' );
llms_update_util_rekey_meta( 'llms_order', '_llms_gateway_api_mode', '_llms_stripe_api_mode' );
llms_update_util_rekey_meta( 'llms_order', '_llms_gateway_subscription_id', '_llms_stripe_subscription_id' );
llms_update_util_rekey_meta( 'llms_order', '_llms_gateway_customer_id', '_llms_stripe_customer_id' );
llms_update_util_rekey_meta( 'llms_order', '_llms_trial_total', '_llms_order_first_payment' );
llms_update_util_rekey_meta( 'llms_order', '_llms_start_date', '_llms_order_date' );
}
/**
* Migrate all orders from the 2.x to 3.x data structure
*
* @since 3.0.0
*
* @return void
*/
function llms_update_300_update_orders() {
$args = array(
'post_type' => array( 'llms_order' ),
'posts_per_page' => -1,
'status' => 'publish',
);
$orders = new WP_Query( $args );
if ( $orders->have_posts() ) {
foreach ( $orders->posts as $post ) {
$order = new LLMS_Order( $post );
// Add an order key.
$order->set( 'order_key', $order->generate_order_key() );
$order->set( 'access_expiration', 'lifetime' );
// Add coupon used info.
$coupon_used = $order->get( 'coupon_id' ) ? 'yes' : 'no';
$order->set( 'coupon_used', $coupon_used );
// Add data about the user to the order if we can find it.
if ( isset( $order->user_id ) ) {
$id = $order->get( 'user_id' );
if ( $id && get_user_by( 'ID', $id ) ) {
$student = new LLMS_Student( $id );
$metas = array(
'billing_address_1' => 'billing_address_1',
'billing_address_2' => 'billing_address_2',
'billing_city' => 'billing_city',
'billing_country' => 'billing_country',
'billing_email' => 'user_email',
'billing_first_name' => 'first_name',
'billing_last_name' => 'last_name',
'billing_state' => 'billing_state',
'billing_zip' => 'billing_zip',
);
foreach ( $metas as $ordermeta => $usermeta ) {
$v = $student->$usermeta;
if ( $v ) {
$order->set( $ordermeta, $v );
}
}
}
}
// Setup trial info if there was a first payment recorded.
if ( $order->get( 'trial_total' ) ) {
$order->set( 'trial_offer', 'yes' );
$order->set( 'trial_length', $order->get( 'billing_length' ) );
$order->set( 'trial_period', $order->get( 'billing_period' ) );
$order->set( 'trial_original_total', $order->get( 'trial_total' ) );
} else {
$order->set( 'trial_offer', 'no' );
}
$total = $order->is_recurring() ? get_post_meta( $post->ID, '_llms_order_recurring_price', true ) : get_post_meta( $post->ID, '_llms_order_total', true );
$order->set( 'original_total', $total );
$order->set( 'total', $total );
$order->add_note( sprintf( __( 'This order was migrated to the LifterLMS 3.0 data structure. %1$sLearn more%2$s.', 'lifterlms' ), '<a href="https://lifterlms.com/docs/lifterlms-orders#migration" target="_blank">', '</a>' ) );
// Remove deprecated.
delete_post_meta( $post->ID, '_llms_order_recurring_price' );
delete_post_meta( $post->ID, '_llms_order_total' );
delete_post_meta( $post->ID, '_llms_order_coupon_limit' );
delete_post_meta( $post->ID, '_llms_order_product_price' );
delete_post_meta( $post->ID, '_llms_order_billing_start_date' );
delete_post_meta( $post->ID, '_llms_order_coupon_value' );
delete_post_meta( $post->ID, '_llms_order_original_total' );
}
}
}
/**
* Update db version at conclusion of 3.0.0 updates
*
* @since 3.0.0
*
* @return void
*/
function llms_update_300_update_db_version() {
LLMS_Install::update_db_version( '3.0.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-303.php
================================================
<?php
/**
* Update functions for version 3.0.3
*
* @package LifterLMS/Functions/Updates
*
* @since 3.39.0
* @version 3.39.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Fix students with the bugged role "students"
*
* @since 3.0.3
*
* @return void
*/
function llms_update_303_update_students_role() {
// Add the bugged role so we can remove it.
// We delete it at the conclusion of the function.
if ( ! get_role( 'studnet' ) ) {
add_role(
'studnet',
__( 'Student', 'lifterlms' ),
array(
'read' => true,
)
);
}
$users = new WP_User_Query(
array(
'number' => -1,
'role__in' => array( 'studnet' ),
)
);
if ( $users->get_results() ) {
foreach ( $users->get_results() as $user ) {
$user->remove_role( 'studnet' );
$user->add_role( 'student' );
}
}
// Remove the bugged role when finished.
remove_role( 'studnet' );
}
/**
* Update db version at conclusion of 3.0.3 updates
*
* @since 3.0.3
*
* @return void
*/
function llms_update_303_update_db_version() {
LLMS_Install::update_db_version( '3.0.3' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-3120.php
================================================
<?php
/**
* Update functions for version 3.12.0
*
* @package LifterLMS/Functions/Updates
*
* @since 3.39.0
* @version 3.39.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Add end dates to LifterLMS Orders which have a length but no saved end date
*
* @since 3.12.0
*
* @return void
*/
function llms_update_3120_update_order_end_dates() {
global $wpdb;
$ids = $wpdb->get_col(
"SELECT posts.ID
FROM {$wpdb->posts} AS posts
JOIN {$wpdb->postmeta} AS meta1 ON meta1.post_id = posts.ID AND meta1.meta_key = '_llms_billing_length'
LEFT JOIN {$wpdb->postmeta} AS meta2 ON meta2.post_id = posts.ID AND meta2.meta_key = '_llms_date_billing_end'
WHERE posts.post_type = 'llms_order'
AND meta2.meta_value IS NULL
AND meta1.meta_value > 0;"
); // db call ok; no-cache ok.
foreach ( $ids as $id ) {
$order = llms_get_post( $id );
if ( ! is_a( $order, 'LLMS_Order' ) ) {
continue;
}
$order->maybe_schedule_payment( true );
}
}
/**
* Rename options for bbPress and BuddyPress to follow the abstract integration options structure
*
* @since 3.12.0
*
* @return void
*/
function llms_update_3120_update_integration_options() {
global $wpdb;
$wpdb->update(
$wpdb->options,
array(
'option_name' => 'llms_integration_bbpress_enabled',
),
array(
'option_name' => 'lifterlms_bbpress_enabled',
)
); // db call ok; no-cache ok.
$wpdb->update(
$wpdb->options,
array(
'option_name' => 'llms_integration_buddypress_enabled',
),
array(
'option_name' => 'lifterlms_buddypress_enabled',
)
); // db call ok; no-cache ok.
}
/**
* Update db version at conclusion of 3.12.0 updates
*
* @since 3.12.0
*
* @return void
*/
function llms_update_3120_update_db_version() {
LLMS_Install::update_db_version( '3.12.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-3130.php
================================================
<?php
/**
* Update functions for version 3.13.0
*
* @package LifterLMS/Functions/Updates
*
* @since 3.39.0
* @version 3.39.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Setup default instructor data for courses and memberships
*
* @since 3.13.0
*
* @return void
*/
function llms_update_3130_create_default_instructors() {
$query = new WP_Query(
array(
'post_type' => array( 'course', 'llms_membership' ),
'posts_per_page' => -1,
)
);
foreach ( $query->posts as $post ) {
$course = llms_get_post( $post );
$course->set_instructors();
}
}
/**
* Add an admin notice about the new builder
*
* @since 3.13.0
*
* @return void
*/
function llms_update_3130_builder_notice() {
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.notices.php';
LLMS_Admin_Notices::add_notice(
'update-3130',
array(
'html' => sprintf(
__( 'Welcome to LifterLMS 3.13.0! We\'ve packed a ton of features into this release: Take a moment to get familiar with the all new %1$scourse builder%3$s and our new %2$suser roles%3$s.', 'lifterlms' ),
'<a href="https://lifterlms.com/docs/using-course-builder/" target="_blank">',
'<a href="https://lifterlms.com/docs/roles-and-capabilities/" target="_blank">',
'</a>'
),
'type' => 'info',
'dismissible' => true,
'remindable' => false,
)
);
}
/**
* Update db version at conclusion of 3.13.0 updates
*
* @since 3.13.0
*
* @return void
*/
function llms_update_3130_update_db_version() {
LLMS_Install::update_db_version( '3.13.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-3160.php
================================================
<?php
/**
* Update functions for version 3.16.0
*
* @package LifterLMS/Functions/Updates
*
* @since 3.39.0
* @version 3.39.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Add yes/no vals for quiz new quiz settings
*
* @since 3.16.0
*
* @return void
*/
function llms_update_3160_update_quiz_settings() {
global $wpdb;
$ids = $wpdb->get_col( "SELECT ID FROM {$wpdb->posts} WHERE post_type = 'llms_quiz'" );
foreach ( $ids as $id ) {
$quiz = llms_get_post( $id );
if ( $quiz->get( 'time_limit' ) > 0 ) {
$quiz->set( 'limit_time', 'yes' );
}
if ( $quiz->get( 'allowed_attempts' ) > 0 ) {
$quiz->set( 'limit_attempts', 'yes' );
}
}
}
/**
* Rename meta keys for lesson -> quiz relationship
*
* @since 3.16.0
*
* @return void
*/
function llms_update_3160_lesson_to_quiz_relationships_migration() {
global $wpdb;
$wpdb->update(
$wpdb->postmeta,
array(
'meta_key' => '_llms_quiz',
),
array(
'meta_key' => '_llms_assigned_quiz',
)
); // db call ok; no-cache ok.
}
/**
* Migrate attempt data from the former location on the wp_usermeta table
*
* @since 3.16.0
* @since 3.24.1 Unknown.
*
* @return void
*/
function llms_update_3160_attempt_migration() {
global $wpdb;
$query = $wpdb->get_results( "SELECT user_id, meta_value FROM {$wpdb->usermeta} WHERE meta_key = 'llms_quiz_data' LIMIT 100;" ); // db call ok; no-cache ok.
// Finished.
if ( ! $query ) {
set_transient( 'llms_update_3160_attempt_migration', 'complete', DAY_IN_SECONDS );
return false;
}
foreach ( $query as $record ) {
if ( ! empty( $record->meta_value ) ) {
foreach ( unserialize( $record->meta_value ) as $attempt ) {
if ( ! is_array( $attempt ) ) {
continue;
}
$to_insert = array();
$format = array();
$start = $attempt['start_date'];
$end = $attempt['end_date'];
if ( $end ) {
$to_insert['update_date'] = $end;
$format[] = '%s';
} elseif ( $start ) {
$to_insert['update_date'] = $start;
$format[] = '%s';
} else {
continue;
}
foreach ( $attempt as $key => $val ) {
$insert_key = $key;
$insert_val = $val;
if ( 'assoc_lesson' === $key ) {
$insert_key = 'lesson_id';
} elseif ( 'id' === $key ) {
$insert_key = 'quiz_id';
} elseif ( 'user_id' === $key ) {
$insert_key = 'student_id';
} elseif ( 'wpnonce' === $key ) {
continue;
} elseif ( 'current' === $key ) {
continue;
} elseif ( 'questions' === $key ) {
$insert_val = serialize( $val );
} elseif ( 'passed' === $key ) {
$insert_key = 'status';
if ( $val ) {
$insert_val = 'pass';
} else {
// Quiz has been initialized but hasn't been started yet,
// we don't need to migrate these.
if ( ! $start && ! $end ) {
// $insert_val = 'new';
continue;
} elseif ( $start && ! $end ) {
// sSill taking the quiz.
if ( isset( $attempt['current'] ) && $attempt['current'] ) {
$insert_val = 'current';
}
// Quiz was abandoned.
$insert_val = 'incomplete';
// Actual failure.
} else {
$insert_val = 'fail';
}
}
}
switch ( $insert_key ) {
case 'lesson_id':
case 'quiz_id':
case 'student_id':
case 'attempt':
$insert_format = '%d';
break;
case 'grade':
$insert_format = '%f';
break;
default:
$insert_format = '%s';
}
$to_insert[ $insert_key ] = $insert_val;
$format[] = $insert_format;
}
$wpdb->insert( $wpdb->prefix . 'lifterlms_quiz_attempts', $to_insert, $format ); // db call ok; no-cache ok.
}
}
// Backup original.
update_user_meta( $record->user_id, 'llms_legacy_quiz_data', $record->meta_value );
// Selete the original so it's not there on the next run.
delete_user_meta( $record->user_id, 'llms_quiz_data' );
}
// Needs to run again.
return true;
}
/**
* Create duplicate questions for each question attached to multiple quizzes
*
* @since 3.16.0
*
* @return void
*/
function llms_update_3160_ensure_no_dupe_question_rels() {
if ( 'complete' !== get_transient( 'llms_update_3160_attempt_migration' ) ) {
return true;
}
$skip = get_transient( 'llms_3160_skipper_dupe_q' );
if ( ! $skip ) {
$skip = 0;
}
set_transient( 'llms_3160_skipper_dupe_q', $skip + 20, DAY_IN_SECONDS );
global $wpdb;
$question_ids = $wpdb->get_col(
$wpdb->prepare(
"SELECT ID
FROM {$wpdb->posts}
WHERE post_type = 'llms_question'
ORDER BY ID ASC
LIMIT %d, 20;",
$skip
)
); // db call ok; no-cache ok.
if ( ! $question_ids ) {
set_transient( 'llms_update_3160_ensure_no_dupe_question_rels_status', 'complete', DAY_IN_SECONDS );
return false;
}
foreach ( $question_ids as $qid ) {
$parts = array(
serialize(
array(
'id' => $qid,
)
),
serialize(
array(
'id' => absint( $qid ),
)
),
);
foreach ( $parts as &$part ) {
$part = substr( $part, 5, -1 );
}
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$quiz_ids = $wpdb->get_col(
"
SELECT post_id
FROM {$wpdb->postmeta}
WHERE meta_key = '_llms_questions'
AND ( meta_value LIKE '%{$parts[0]}%' OR meta_value LIKE '%{$parts[1]}%' );"
); // db call ok; no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
// Question is attached to 2 or more quizzes.
if ( count( $quiz_ids ) >= 2 ) {
// Remove the first quiz and duplicate questions for the remaining quizzes.
array_shift( $quiz_ids );
foreach ( $quiz_ids as $quiz_id ) {
// Copy the question and add update the reference on the quiz.
$question_copy_id = llms_update_util_post_duplicator( $qid );
$questions = get_post_meta( $quiz_id, '_llms_questions', true );
foreach ( $questions as &$qdata ) {
if ( $qdata['id'] == $qid ) {
$qdata['id'] = $question_copy_id;
}
}
update_post_meta( $quiz_id, '_llms_questions', $questions );
// Update references to the quiz in quiz attempts.
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$attempt_ids = $wpdb->get_col(
"
SELECT id
FROM {$wpdb->prefix}lifterlms_quiz_attempts
WHERE quiz_id = {$quiz_id}
AND ( questions LIKE '%{$parts[0]}%' OR questions LIKE '%{$parts[1]}%' );"
); // db call ok; no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
foreach ( $attempt_ids as $aid ) {
$attempt = new LLMS_Quiz_Attempt( $aid );
$attempt_qs = $attempt->get_questions();
foreach ( $attempt_qs as &$answer ) {
if ( $answer['id'] == $qid ) {
$answer['id'] = $question_copy_id;
}
}
$attempt->set_questions( $attempt_qs, true );
}
}
}
}
// Need to run again.
return true;
}
/**
* Create duplicates for any quiz attached to multiple lessons
*
* @since 3.16.0
*
* @return void
*/
function llms_update_3160_ensure_no_lesson_dupe_rels() {
if ( 'complete' !== get_transient( 'llms_update_3160_ensure_no_dupe_question_rels_status' ) ) {
return true;
}
$skip = get_transient( 'llms_3160_skipper_dupe_l' );
if ( ! $skip ) {
$skip = 0;
}
set_transient( 'llms_3160_skipper_dupe_l', $skip + 100, DAY_IN_SECONDS );
global $wpdb;
$res = $wpdb->get_results(
$wpdb->prepare(
"SELECT post_id AS lesson_id, meta_value AS quiz_id
FROM {$wpdb->postmeta}
WHERE meta_key = '_llms_quiz'
AND meta_value != 0
ORDER BY lesson_id ASC
LIMIT %d, 100
;",
$skip
)
); // db call ok; no-cache ok.
if ( ! $res ) {
set_transient( 'llms_update_3160_ensure_no_lesson_dupe_rels', 'complete', DAY_IN_SECONDS );
return false;
}
$quizzes_set = array();
foreach ( $res as $data ) {
$lesson = llms_get_post( $data->lesson_id );
if ( ! $lesson ) {
continue;
}
// Quiz no longer exists, unset the data from the lesson.
$quiz = llms_get_post( $data->quiz_id );
if ( ! $quiz ) {
$lesson->set( 'quiz', 0 );
$lesson->set( 'quiz_enabled', 'no' );
continue;
}
/**
* Quiz already attached to a lesson
* + duplicate it
* + assign lesson/quiz relationships off new quiz
* + find quiz attempts by old quiz / lesson
* + update attempt quiz id
* + update attempt question ids
*/
if ( in_array( $data->quiz_id, $quizzes_set ) ) {
$orig_questions = get_post_meta( $data->quiz_id, '_llms_questions', true );
$qid_map = array();
$dupe_quiz_id = llms_update_util_post_duplicator( $data->quiz_id );
foreach ( $orig_questions as &$oqdata ) {
$dupe_q = llms_update_util_post_duplicator( $oqdata['id'] );
$qid_map[ $oqdata['id'] ] = $dupe_q;
$oqdata['id'] = $dupe_q;
}
update_post_meta( $dupe_quiz_id, '_llms_questions', $orig_questions );
update_post_meta( $dupe_quiz_id, '_llms_lesson_id', $data->lesson_id );
$lesson->set( 'quiz', $dupe_quiz_id );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$attempt_ids = $wpdb->get_col(
"
SELECT id
FROM {$wpdb->prefix}lifterlms_quiz_attempts
WHERE quiz_id = {$data->quiz_id} AND lesson_id = {$data->lesson_id}"
); // db call ok; no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
foreach ( $attempt_ids as $aid ) {
$attempt = new LLMS_Quiz_Attempt( $aid );
$questions = $attempt->get_questions();
foreach ( $questions as &$aqd ) {
if ( isset( $qid_map[ $aqd['id'] ] ) ) {
$aqd['id'] = $qid_map[ $aqd['id'] ];
}
}
$attempt->set_questions( $questions, true );
$attempt->set( 'quiz_id', $dupe_quiz_id );
$attempt->save();
}
}
$quizzes_set[] = $data->quiz_id;
$lesson->set( 'quiz_enabled', 'yes' ); // Ensure the new quiz enabled key is set.
}
// Run it again.
return true;
}
/**
* Update question & choice data to new structure
*
* @since 3.16.0
*
* @return void
*/
function llms_update_3160_update_question_data() {
if ( 'complete' !== get_transient( 'llms_update_3160_ensure_no_lesson_dupe_rels' ) ) {
return true;
}
$skip = get_transient( 'llms_3160_skipper_qdata' );
if ( ! $skip ) {
$skip = 0;
}
set_transient( 'llms_3160_skipper_qdata', $skip + 100, DAY_IN_SECONDS );
global $wpdb;
$res = $wpdb->get_results(
$wpdb->prepare(
"SELECT post_id AS quiz_id, meta_value AS questions
FROM {$wpdb->postmeta}
WHERE meta_key = '_llms_questions'
ORDER BY post_id ASC
LIMIT %d, 100;",
$skip
)
); // db call ok; no-cache ok.
// Finished.
if ( ! $res ) {
set_transient( 'llms_update_3160_update_question_data', 'complete', DAY_IN_SECONDS );
return false;
}
foreach ( $res as $data ) {
$questions = maybe_unserialize( $data->questions );
if ( is_array( $questions ) ) {
foreach ( $questions as $raw_question ) {
$points = isset( $raw_question['points'] ) ? $raw_question['points'] : 1;
$question = llms_get_post( $raw_question['id'] );
if ( ! $question ) {
continue;
}
$question->set( 'parent_id', $data->quiz_id );
$question->set( 'question_type', 'choice' );
$question->set( 'points', $points );
update_post_meta( $question->get( 'id' ), '_llms_legacy_question_title', $question->get( 'title' ) );
$question->set( 'title', strip_tags( str_replace( array( '<p>', '</p>' ), '', $question->get( 'content' ) ), '<b><em><u><strong><i>' ) );
$options = get_post_meta( $question->get( 'id' ), '_llms_question_options', true );
update_post_meta( $question->get( 'id' ), '_llms_legacy_question_options', $options );
delete_post_meta( $question->get( 'id' ), '_llms_question_options' );
if ( ! $options ) {
continue;
}
$clarify = '';
$markers = range( 'A', 'Z' );
foreach ( (array) $options as $index => $option ) {
if ( ! isset( $option['option_text'] ) ) {
continue;
}
$correct = false;
// No correct_option set for the choice, set it to false.
if ( ! isset( $option['correct_option'] ) ) {
$correct = false;
/**
* Handle bool strings like "on" "off" "yes" "no"
* and questions imported from a 3rd party Excel to LifterLMS plugin
* that doesn't save options in the expected format...
* dev if you're reading this I love you but you caused me a pretty large headache
* trying to figure out where in our codebase we went wrong...
*/
} elseif ( is_string( $option['correct_option'] ) && '' !== $option['correct_option'] ) {
$correct = true;
// Catch everything else and filter var it.
} else {
$correct = filter_var( $option['correct_option'], FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE );
// Nothing should get here but I'm tired...
if ( is_null( $correct ) ) {
$correct = true;
}
}
$question->create_choice(
array(
'choice' => $option['option_text'],
'correct' => $correct,
'marker' => $markers[ $index ],
)
);
// If an option desc is set.
if ( ! empty( $option['option_description'] ) ) {
// If the description hasn't already been added to the new clarification.
if ( false === strpos( $clarify, $option['option_description'] ) ) {
$clarify .= $option['option_description'] . '<br><br>';
}
}
}
if ( $clarify ) {
$question->set( 'clarifications', trim( rtrim( $clarify, '<br><br>' ) ) );
$question->set( 'clarifications_enabled', 'yes' );
}
}
}
}
// Run it again.
return true;
}
/**
* Update question data to new formats & match question choice indexes to new choice IDs
*
* @since 3.16.0
*
* @return void
*/
function llms_update_3160_update_attempt_question_data() {
if ( 'complete' !== get_transient( 'llms_update_3160_update_question_data' ) ) {
return true;
}
$skip = get_transient( 'llms_update_3160_skipper' );
if ( ! $skip ) {
$skip = 0;
}
set_transient( 'llms_update_3160_skipper', $skip + 500, DAY_IN_SECONDS );
global $wpdb;
$res = $wpdb->get_col( $wpdb->prepare( "SELECT id FROM {$wpdb->prefix}lifterlms_quiz_attempts ORDER BY id ASC LIMIT %d, 500", $skip ) ); // db call ok; no-cache ok.
// Finished.
if ( ! $res ) {
set_transient( 'llms_update_3160_update_attempt_question_data', 'complete', DAY_IN_SECONDS );
return false;
}
foreach ( $res as $att_id ) {
$attempt = new LLMS_Quiz_Attempt( $att_id );
$questions = $attempt->get_questions();
foreach ( $questions as &$question ) {
$question['earned'] = empty( $question['correct'] ) ? 0 : $question['points'];
if ( ! isset( $question['answer'] ) ) {
$question['answer'] = array();
} elseif ( ! is_array( $question['answer'] ) && is_numeric( $question['answer'] ) ) {
$obj = llms_get_post( $question['id'] );
if ( $obj ) {
$choices = $obj->get_choices();
if ( isset( $choices[ $question['answer'] ] ) ) {
$question['answer'] = array( $choices[ $question['answer'] ]->get( 'id' ) );
}
}
}
}
$attempt->set_questions( $questions, true );
}
return true;
}
/**
* Ensure quizzes backreference their parent lessons
*
* @since 3.16.0
*
* @return void
*/
function llms_update_3160_update_quiz_to_lesson_rels() {
if ( 'complete' !== get_transient( 'llms_update_3160_update_attempt_question_data' ) ) {
return true;
}
global $wpdb;
$ids = $wpdb->get_col( "SELECT post_id FROM {$wpdb->postmeta} WHERE meta_key = '_llms_quiz_enabled' AND meta_value = 'yes'" );
foreach ( $ids as $id ) {
$lesson = llms_get_post( $id );
if ( $lesson ) {
$quiz_id = $lesson->get( 'quiz' );
if ( $quiz_id ) {
$quiz = llms_get_post( $quiz_id );
$quiz->set( 'lesson_id', $id );
}
}
}
}
/**
* Add an admin notice about new quiz things
*
* @since 3.16.0
*
* @return void
*/
function llms_update_3160_builder_notice() {
if ( 'complete' !== get_transient( 'llms_update_3160_update_attempt_question_data' ) ) {
return true;
}
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.notices.php';
LLMS_Admin_Notices::add_notice(
'update-3160',
array(
'html' => sprintf(
__( 'Welcome to LifterLMS 3.16.0! This update adds significant improvements to the quiz-building experience. Notice quizzes and questions are no longer found under "Courses" on the sidebar? Your quizzes have not been deleted but they have been moved! Read more about the all new %1$squiz builder%2$s.', 'lifterlms' ),
'<a href="http://blog.lifterlms.com/hello-quizzes/" target="_blank">',
'</a>'
),
'type' => 'info',
'dismissible' => true,
'remindable' => false,
)
);
}
/**
* Update db version at conclusion of 3.16.0 updates
*
* @since 3.16.0
*
* @return void
*/
function llms_update_3160_update_db_version() {
if ( 'complete' !== get_transient( 'llms_update_3160_update_attempt_question_data' ) ) {
return true;
}
LLMS_Install::update_db_version( '3.16.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-3280.php
================================================
<?php
/**
* Update functions for version 3.28.0
*
* @package LifterLMS/Functions/Updates
*
* @since 3.39.0
* @version 3.39.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Clear the unused cron `lifterlms_cleanup_sessions`
*
* @since 3.28.0
*
* @return void
*/
function llms_update_3280_clear_session_cleanup_cron() {
wp_clear_scheduled_hook( 'lifterlms_cleanup_sessions' );
}
/**
* Update db version at conclusion of 3.28.0 updates
*
* @return void
*
* @since 3.28.0
*/
function llms_update_3280_update_db_version() {
LLMS_Install::update_db_version( '3.28.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-343.php
================================================
<?php
/**
* Update functions for version 3.4.3
*
* @package LifterLMS/Functions/Updates
*
* @since 3.39.0
* @version 3.39.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Rename meta keys for parent section and parent course relationships for all LifterLMS Lessons and Sections
*
* @since 3.4.3
*
* @return void
*/
function llms_update_343_update_relationships() {
global $wpdb;
// Update parent course key for courses and lessons.
$wpdb->query(
"UPDATE {$wpdb->postmeta} AS m
JOIN {$wpdb->posts} AS p ON p.ID = m.post_id
SET m.meta_key = '_llms_parent_course'
WHERE m.meta_key = '_parent_course'
AND ( p.post_type = 'lesson' OR p.post_type = 'section' );"
);
// Update parent section key for lessons.
$wpdb->query(
"UPDATE {$wpdb->postmeta} AS m
JOIN {$wpdb->posts} AS p ON p.ID = m.post_id
SET m.meta_key = '_llms_parent_section'
WHERE m.meta_key = '_parent_section'
AND p.post_type = 'lesson';"
);
}
/**
* Update db version at conclusion of 3.4.3 updates
*
* @since 3.4.3
*
* @return void
*/
function llms_update_343_update_db_version() {
LLMS_Install::update_db_version( '3.4.3' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-360.php
================================================
<?php
/**
* Update functions for version 3.6.0
*
* @package LifterLMS/Functions/Updates
*
* @since 3.39.0
* @version 3.39.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Add course and membership visibility settings
*
* Default course is catalog only and default membership is catalog & search.
* Courses were NOT SEARCHABLE in earlier versions.
*
* @since 3.6.0
*
* @return void
*/
function llms_update_360_set_product_visibility() {
$query = new WP_Query(
array(
'post_status' => 'any',
'post_type' => array( 'course', 'llms_membership' ),
'posts_per_page' => -1,
)
);
if ( $query->have_posts() ) {
foreach ( $query->posts as $post ) {
$visibility = ( 'course' === $post->post_type ) ? 'catalog' : 'catalog_search';
wp_set_object_terms( $post->ID, $visibility, 'llms_product_visibility', false );
}
}
}
/**
* Update db version at conclusion of 3.6.0 updates
*
* @since 3.6.0
*
* @return void
*/
function llms_update_360_update_db_version() {
LLMS_Install::update_db_version( '3.6.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-380.php
================================================
<?php
/**
* Update functions for version 3.8.0
*
* @package LifterLMS/Functions/Updates
*
* @since 3.39.0
* @version 3.39.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Add visibility settings to all access plans and delete the "featured" meta values for all access plans
*
* @since 3.8.0
*
* @return void
*/
function llms_update_380_set_access_plan_visibility() {
$query = new WP_Query(
array(
'post_status' => 'any',
'post_type' => array( 'llms_access_plan' ),
'posts_per_page' => -1,
)
);
if ( $query->have_posts() ) {
foreach ( $query->posts as $post ) {
$plan = llms_get_post( $post );
$visibility = $plan->is_featured() ? 'featured' : 'visible';
wp_set_object_terms( $post->ID, $visibility, 'llms_access_plan_visibility', false );
delete_post_meta( $post->ID, '_llms_featured' );
}
}
}
/**
* Update db version at conclusion of 3.8.0 updates
*
* @since 3.8.0
*
* @return void
*/
function llms_update_380_update_db_version() {
LLMS_Install::update_db_version( '3.8.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-400.php
================================================
<?php
/**
* Update functions for version 4.0.0
*
* @package LifterLMS/Functions/Updates
*
* @since 4.0.0
* @version 4.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Remove session data stored on the options table by removed the WP Session Manager library
*
* @since 4.0.0
*
* @return void
*/
function llms_update_400_remove_session_options() {
global $wpdb;
$wpdb->query( "DELETE FROM {$wpdb->options} WHERE option_name LIKE '_wp_session_%';" ); // db call ok; no cache ok.
}
/**
* Clear cron hook used by the WP Session Manager library to cleanup expired sessions
*
* @since 4.0.0
*
* @return void
*/
function llms_update_400_clear_session_cron() {
wp_clear_scheduled_hook( 'wp_session_garbage_collection' );
}
/**
* Update db version to 4.0.0
*
* @since 4.0.0
*
* @return void
*/
function llms_update_400_update_db_version() {
LLMS_Install::update_db_version( '4.0.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-4150.php
================================================
<?php
/**
* Update functions for version 4.15.0
*
* @package LifterLMS/Functions/Updates
*
* @since 4.15.0
* @version 4.15.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Remove orphan access plans
*
* @since 4.15.0
*
* @return bool True if it needs to run again, false otherwise.
*/
function llms_update_4150_remove_orphan_access_plans() {
$limit = 50;
global $wpdb;
$orphan_access_plans = $wpdb->get_col(
$wpdb->prepare(
"SELECT pm.post_id AS apid
FROM {$wpdb->postmeta} AS pm
LEFT JOIN {$wpdb->posts} AS p
ON pm.meta_value = p.ID
WHERE pm.meta_key = '_llms_product_id'
AND p.ID IS NULL
ORDER BY apid ASC
LIMIT %d
",
$limit
)
); // db call ok; no-cache ok.
// Finished.
if ( empty( $orphan_access_plans ) ) {
set_transient( 'llms_update_4150_remove_orphan_access_plans', 'complete', DAY_IN_SECONDS );
return false;
}
foreach ( $orphan_access_plans as $orphan_access_plan_id ) {
wp_delete_post( $orphan_access_plan_id );
}
// Needs to run again.
return true;
}
/**
* Update db version to 4.15.0
*
* @since 4.15.0
*
* @return void|true True if it needs to run again, nothing if otherwise.
*/
function llms_update_4150_update_db_version() {
if ( 'complete' !== get_transient( 'llms_update_4150_remove_orphan_access_plans' ) ) {
// Needs to run again.
return true;
}
LLMS_Install::update_db_version( '4.15.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-450.php
================================================
<?php
/**
* Update functions for version 4.5.0
*
* @package LifterLMS/Functions/Updates
*
* @since 4.5.0
* @version 4.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Record open sessions in wp_lifterlms_events_open_sessions
*
* @since 4.5.0
*
* @return bool True if it needs to run again, false otherwise.
*/
function llms_update_450_migrate_events_open_sessions() {
$limit = 200;
$skip = get_transient( 'llms_450_skipper_events_open_sessions' );
if ( ! $skip ) {
$skip = 0;
}
set_transient( 'llms_450_skipper_events_open_sessions', $skip + $limit, DAY_IN_SECONDS );
global $wpdb;
$maybe_open_sessions = $wpdb->get_results(
$wpdb->prepare(
"SELECT id, actor_id, object_id
FROM {$wpdb->prefix}lifterlms_events
WHERE event_type='session'
AND event_action='start'
ORDER BY id ASC
LIMIT %d, %d
",
$skip,
$limit
)
); // db call ok; no-cache ok.
// Finished.
if ( empty( $maybe_open_sessions ) ) {
set_transient( 'llms_update_450_migrate_events_open_sessions', 'complete', DAY_IN_SECONDS );
return false;
}
$insert = '';
foreach ( $maybe_open_sessions as $maybe_open_session ) {
// Create an event instance so to pass it to the `LLMS_Sessions::instance()->is_session_open()` util.
$start = new LLMS_Event( $maybe_open_session->id );
// Set the only useful properties, without the need to save them from the db.
$start->set( 'actor_id', $maybe_open_session->actor_id, false );
$start->set( 'object_id', $maybe_open_session->object_id, false );
if ( LLMS_Sessions::instance()->is_session_open( $start ) ) {
if ( ! empty( $insert ) ) {
$insert .= ', ';
}
$insert .= $wpdb->prepare( '(%s)', $maybe_open_session->id );
}
}
// Add the open sessions to the new table.
if ( ! empty( $insert ) ) {
$wpdb->query(
"INSERT INTO {$wpdb->prefix}lifterlms_events_open_sessions ( `event_id` ) VALUES " . $insert . ';' // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- Values are prepared above.
); // db call ok; no-cache ok.
}
// Needs to run again.
return true;
}
/**
* Update db version to 4.5.0
*
* @since 4.5.0
*
* @return void|true True if it needs to run again, nothing if otherwise.
*/
function llms_update_450_update_db_version() {
if ( 'complete' !== get_transient( 'llms_update_450_migrate_events_open_sessions' ) ) {
// Needs to run again.
return true;
}
LLMS_Install::update_db_version( '4.5.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-500.php
================================================
<?php
/**
* Update functions for version 5.0.0
*
* @package LifterLMS/Functions/Updates
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Turn off autoload for accounting legacy options
*
* @since 5.0.0
*
* @return bool True if it needs to run again, false otherwise.
*/
function llms_update_500_legacy_options_autoload_off() {
global $wpdb;
$legacy_options_to_stop_autoloading = array(
'lifterlms_registration_generate_username',
'lifterlms_registration_password_strength',
'lifterlms_registration_password_min_strength',
);
$sql = "
UPDATE {$wpdb->options} SET autoload='no'
WHERE option_name IN (" . implode( ', ', array_fill( 0, count( $legacy_options_to_stop_autoloading ), '%s' ) ) . ')';
$wpdb->query(
$wpdb->prepare(
$sql, // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared -- No user input, it's safe.
$legacy_options_to_stop_autoloading
)
); // db call ok; no-cache ok.
return false;
}
/**
* Admin welcome notice
*
* @since 5.0.0
*
* @return void
*/
function llms_update_500_add_admin_notice() {
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.notices.php';
$notice_id = 'v500-welcome-msg';
$get_started_link = add_query_arg(
array(
'post_type' => 'llms_form',
),
admin_url( 'edit.php' )
);
$html = sprintf(
'<strong>%1$s</strong><br><br>%2$s<br><br>%3$s',
__( 'Welcome to LifterLMS 5.0!', 'lifterlms' ),
__( 'This new version of LifterLMS brings you the power to build and customize your student information forms using a simple point and click interface constructed on top of the WordPress block editor. Customization like the removal of default fields, changing the text of field labels, or reordering fields within a form is all possible without any code or professional help.', 'lifterlms' ),
sprintf(
// Translators: %1$s = Opening anchor tag to Forms admin page; %2$s = Closing anchor tag.
__( '%1$sGet Started%2$s', 'lifterlms' ),
'<a class="button-primary" href="' . esc_url( $get_started_link ) . '" >',
'</a>'
) . ' ' .
sprintf(
// Translators: %1$s = Opening anchor tag to the welcome blog post on lifterlms.com; %2$s = Closing anchor tag.
__( '%1$sRead More%2$s', 'lifterlms' ),
'<a class="button" href="https://blog.lifterlms.com/5-0/" target="_blank" rel="noopener">',
'</a>'
)
);
LLMS_Admin_Notices::add_notice(
$notice_id,
$html,
array(
'type' => 'success',
'dismiss_for_days' => 0,
'remindable' => false,
)
);
return false;
}
/**
* Update db version to 5.0.0
*
* @since 5.0.0]
*
* @return void|true True if it needs to run again, nothing if otherwise.
*/
function llms_update_500_update_db_version() {
LLMS_Install::update_db_version( '5.0.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-520.php
================================================
<?php
/**
* Update functions for version 5.2.0
*
* @package LifterLMS/Functions/Updates
*
* @since 5.2.0
* @version 5.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Explicitly set no subscribers for the new upcoming payment reminder notification
*
* @since 5.2.0
*
* @return bool True if it needs to run again, false otherwise.
*/
function llms_update_520_upcoming_reminder_notification_backward_compat() {
$subscribers_for_type = array(
'email' => array(
'student',
),
'basic' => array(
'student',
'author',
'custom',
),
);
foreach ( $subscribers_for_type as $type => $subscribers ) {
add_option( "llms_notification_upcoming_payment_reminder_{$type}_subscribers", array_fill_keys( $subscribers, 'no' ) );
}
return false;
}
/**
* Update db version to 5.2.0
*
* @since 5.2.0
*
* @return void|true True if it needs to run again, nothing if otherwise.
*/
function llms_update_520_update_db_version() {
LLMS_Install::update_db_version( '5.2.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-600.php
================================================
<?php
/**
* Update functions for version 6.0.0.
*
* @package LifterLMS/Functions/Updates
*
* @since 6.0.0
* @version 6.0.0
*/
namespace LLMS\Updates\Version_6_0_0;
defined( 'ABSPATH' ) || exit;
/**
* Retrieves the DB version of the migration.
*
* @since 6.0.0
*
* @return string
*/
function _get_db_version() {
return '6.0.0';
}
/**
* Migrate deprecated meta values for earned achievements.
*
* @since 6.0.0
*
* @return bool Returns `true` if more records need to be updated and `false` upon completion.
*/
function migrate_achievements() {
return _migrate_awards( 'achievement' );
}
/**
* Migrate deprecated meta values for earned certificates.
*
* @since 6.0.0
*
* @return bool Returns `true` if more records need to be updated and `false` upon completion.
*/
function migrate_certificates() {
return _migrate_awards( 'certificate' );
}
/**
* Migrates meta data for achievement and certificate template posts.
*
* @since 6.0.0
*
* @return bool Returns `true` if more records need to be updated and `false` upon completion.
*/
function migrate_award_templates() {
$per_page = llms_update_util_get_items_per_page();
$query = new \WP_Query(
array(
'orderby' => array( 'ID' => 'ASC' ),
'post_status' => 'any',
'post_type' => array( 'llms_achievement', 'llms_certificate' ),
'posts_per_page' => $per_page,
'no_found_rows' => true, // We don't care about found rows since we'll run the query as many times as needed anyway.
'meta_query' => array(
'relation' => 'OR',
array(
'key' => '_llms_achievement_image',
'compare' => 'EXISTS',
),
array(
'key' => '_llms_certificate_image',
'compare' => 'EXISTS',
),
array(
'key' => '_llms_achievement_content',
'compare' => 'EXISTS',
),
),
)
);
$legacy_option_added['achievement'] = false;
$legacy_option_added['certificate'] = false;
foreach ( $query->posts as $post ) {
$type = llms_strip_prefixes( $post->post_type );
$image_migrated = _migrate_image( $post->ID, $type );
if ( 'achievement' === $type ) {
_migrate_achievement_content( $post->ID );
}
if ( ! $legacy_option_added[ $type ] && ! $image_migrated ) {
_add_legacy_opt( $type );
$legacy_option_added[ $type ] = true;
}
}
// If there was 50 results assume there's another page and run again, otherwise we're done.
return ( count( $query->posts ) === $per_page );
}
/**
* Shows an admin welcome notice.
*
* @since 6.0.0
*
* @return boolean
*/
function show_notice() {
$notice_id = sprintf( 'v%s-welcome-msg', str_replace( array( '.', '-' ), '', _get_db_version() ) );
$get_started_link = admin_url( 'post-new.php?post_type=llms_certificate' );
$html = sprintf(
'<strong>%1$s</strong><br><br>%2$s<br><br>%3$s',
__( 'Welcome to LifterLMS 6.0.0!', 'lifterlms' ),
__( "This new version brings you the power to build and customize certificates using the WordPress block editor! Start building beautiful certificates using all the blocks you're already familiar, the new Certificate Title block, and new certificate settings like page size (Letter or A4, for example), orientation, background color, and more. In addition to design features, this version also adds the ability to modify already-awarded certificates and achievements and to sync template updates with the click of a button.", 'lifterlms' ),
sprintf(
// Translators: %1$s = Opening anchor tag to Forms admin page; %2$s = Closing anchor tag.
__( '%1$sGet Started%2$s', 'lifterlms' ),
'<a class="button-primary" href="' . esc_url( $get_started_link ) . '" >',
'</a>'
) . ' ' .
sprintf(
// Translators: %1$s = Opening anchor tag to the welcome blog post on lifterlms.com; %2$s = Closing anchor tag.
__( '%1$sRead More%2$s', 'lifterlms' ),
'<a class="button" href="https://blog.lifterlms.com/6-beta?utm_source=notice&utm_medium=product&utm_campaign=lifterlmsplugin&utm_content=600-welcome" target="_blank" rel="noopener">',
'</a>'
)
);
\LLMS_Admin_Notices::add_notice(
$notice_id,
$html,
array(
'type' => 'success',
'dismiss_for_days' => 0,
'remindable' => false,
)
);
return false;
}
/**
* Update db version to 6.0.0.
*
* @since 6.0.0
*
* @return boolean
*/
function update_db_version() {
\LLMS_Install::update_db_version( _get_db_version() );
return false;
}
/**
* Migrate deprecated meta values for user awards by type.
*
* Queries 50 earned awards at a time and migrates their data by moving meta data
* to the new location and then deleting the deprecated meta values.
*
* @since 6.0.0
*
* @param string $type Award type, either "achievement" or "certificate".
* @return boolean Returns `true` if there are more results and `false` if there are no further results.
*/
function _migrate_awards( $type ) {
$per_page = llms_update_util_get_items_per_page();
$query_args = array(
'orderby' => array( 'ID' => 'ASC' ),
'post_type' => "llms_my_{$type}",
'post_status' => 'any',
'posts_per_page' => $per_page,
'no_found_rows' => true, // We don't care about found rows since we'll run the query as many times as needed anyway.
'fields' => 'ids', // We just need the ID for the updates we'll perform.
'meta_query' => array(
'relation' => 'OR',
array(
'key' => "_llms_{$type}_title",
'compare' => 'EXISTS',
),
array(
'key' => "_llms_{$type}_template",
'compare' => 'EXISTS',
),
array(
'key' => "_llms_{$type}_image",
'compare' => 'EXISTS',
),
),
);
if ( 'achievement' === $type ) {
$query_args['meta_query'][] = array(
'key' => '_llms_achievement_content',
'compare' => 'EXISTS',
);
}
$query = new \WP_Query( $query_args );
// Don't trigger deprecations.
remove_filter( 'get_post_metadata', 'llms_engagement_handle_deprecated_meta_keys', 20, 3 );
// Don't trigger save hooks.
remove_action( "save_post_llms_my_{$type}", array( 'LLMS_Controller_Awards', 'on_save' ), 20 );
$legacy_option_added = false;
foreach ( $query->posts as $post_id ) {
$image_migrated = _migrate_award( $post_id, $type );
if ( ! $legacy_option_added && ! $image_migrated ) {
_add_legacy_opt( $type );
$legacy_option_added = true;
}
}
// Re-enable deprecations.
add_filter( 'get_post_metadata', 'llms_engagement_handle_deprecated_meta_keys', 20, 3 );
// Re-enabled save hooks.
add_action( "save_post_llms_my_{$type}", array( 'LLMS_Controller_Awards', 'on_save' ), 20 );
// If there was 50 results assume there's another page and run again, otherwise we're done.
return ( count( $query->posts ) === $per_page );
}
/**
* Migrate meta values for a single award.
*
* Performs the following updates:
* + Copies lifterlms_user_postmeta user data to the post_author property.
* + Moves the title from postmeta to the post_title property.
* + Moves the template relationship from meta to the post_parent property.
* + Moves the award image from custom meta to the post's featured image.
*
* And then deletes the previous metadata after performing the necessary updates.
*
* @since 6.0.0
*
* @param int $post_id WP_Post ID.
* @param string $type Award type, either "achievement" or "certificate".
* @return bool `true` if there was an image to migrate, else `false`.
*/
function _migrate_award( $post_id, $type ) {
$obj = 'achievement' === $type ? new \LLMS_User_Achievement( $post_id ) : new \LLMS_User_Certificate( $post_id );
$updates = array(
'awarded' => $obj->get_earned_date( 'Y-m-d H:i:s' ),
'author' => $obj->get_user_id(),
);
$title = get_post_meta( $post_id, "_llms_{$type}_title", true );
if ( $title ) {
$updates['title'] = $title;
}
$template = get_post_meta( $post_id, "_llms_{$type}_template", true );
if ( $template ) {
$updates['parent'] = $template;
}
$obj->set_bulk( $updates );
$image_migrated = _migrate_image( $post_id, $type );
if ( 'achievement' === $type ) {
_migrate_achievement_content( $post_id );
}
delete_post_meta( $post_id, "_llms_{$type}_title" );
delete_post_meta( $post_id, "_llms_{$type}_template" );
return $image_migrated;
}
/**
* Migrate the achievement content legacy post meta to post_content.
*
* @since 6.0.0
*
* @param int $post_id WP_Post ID.
* @return void
*/
function _migrate_achievement_content( $post_id ) {
$meta_key = '_llms_achievement_content';
$content = get_post_meta( $post_id, $meta_key, true );
if ( $content ) {
wp_update_post(
array(
'ID' => $post_id,
'post_content' => $content,
)
);
}
delete_post_meta( $post_id, $meta_key );
}
/**
* Migrate the attachment image id from the legacy post meta location
* to the WP core's featured image.
*
* @since 6.0.0
*
* @param int $post_id WP_Post ID.
* @param string $type Award type, either "achievement" or "certificate".
* @return bool `true` if there was an image to migrate, else `false`.
*/
function _migrate_image( $post_id, $type ) {
$image_migrated = false;
$image = get_post_meta( $post_id, "_llms_{$type}_image", true );
if ( $image ) {
set_post_thumbnail( $post_id, $image );
$image_migrated = true;
}
delete_post_meta( $post_id, "_llms_{$type}_image" );
return $image_migrated;
}
/**
* Adds an option used to determine if the site has at least one legacy achievement or certificate template or award
* that uses the default image.
*
* @since 6.0.0
*
* @param string $engagement_type Either 'achievement' or 'certificate'.
* @return void
*/
function _add_legacy_opt( $engagement_type ) {
update_option( "llms_has_{$engagement_type}s_with_legacy_default_image", 'yes', 'no' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-6100.php
================================================
<?php
/**
* Update functions for version 6.10.0
*
* @package LifterLMS/Functions/Updates
*
* @since 6.10.0
* @version 6.10.0
*/
namespace LLMS\Updates\Version_6_10_0;
defined( 'ABSPATH' ) || exit;
/**
* Retrieves the DB version of the migration.
*
* @since 6.10.0
*
* @access private
*
* @return string
*/
function _get_db_version() {
return '6.10.0';
}
/**
* Migrates spanish user's provinces to the correct ones.
*
* @since 6.10.0
*
* @return bool Returns `true` if more records need to be updated and `false` upon completion.
*/
function migrate_spanish_users() {
$per_page = \llms_update_util_get_items_per_page();
$states_migration_map = array(
'AS' => 'O', // Asturias.
'CB' => 'S', // Cantabria.
'RI' => 'LO', // 'La Rioja'.
'MD' => 'M', // Madrid.
'MC' => 'MU', // 'Murcia'.
'NC' => 'NA', // 'Navarra'.
'VC' => 'V', // 'Valencia'.
// No map.
'AN' => '',
'AR' => '',
'PV' => '',
'CN' => '',
'CL' => '',
'CM' => '',
'CT' => '',
'EX' => '',
'GA' => '',
'SA' => '',
);
$query = new \WP_User_Query(
array(
'orderby' => array(
'ID' => 'ASC',
),
'meta_query' => array(
'relation' => 'AND',
array(
'key' => 'llms_billing_country',
'value' => 'ES',
'compare' => '=',
),
array(
'key' => 'llms_billing_state',
'value' => array_keys( $states_migration_map ),
'compare' => 'IN',
),
),
'posts_per_page' => $per_page,
'no_found_rows' => true, // We don't care about found rows since we'll run the query as many times as needed anyway.
)
);
$users = $query->get_results();
if ( $users ) {
foreach ( $users as $user ) {
$new_state = $states_migration_map[ \get_user_meta( $user->ID, 'llms_billing_state', true ) ] ?? '';
\update_user_meta( $user->ID, 'llms_billing_state', $new_state );
}
}
// If there was `$per_page` results assume there's another page and run again, otherwise we're done.
return ( count( $users ) === $per_page );
}
/**
* Update db version to 6.10.0.
*
* @since 6.10.0
*
* @return false.
*/
function update_db_version() {
\LLMS_Install::update_db_version( _get_db_version() );
return false;
}
================================================
FILE: includes/functions/updates/llms-functions-updates-630.php
================================================
<?php
/**
* Update functions for version 6.3.0.
*
* @package LifterLMS/Functions/Updates
*
* @since 6.3.0
* @version 6.3.0
*/
namespace LLMS\Updates\Version_6_3_0;
defined( 'ABSPATH' ) || exit;
/**
* For old users: explicitly limit by default the buddypress profile endpoints to those existing prior to 6.3.0.
*
* @since 6.3.0
*
* @return bool True if it needs to run again, false otherwise.
*/
function buddypress_profile_endpoints_bc() {
if ( ! llms_parse_bool( get_option( 'llms_integration_buddypress_enabled', 'no' ) ) ) {
return;
}
update_option(
'llms_integration_buddypress_profile_endpoints',
array(
'view-courses',
'view-memberships',
'view-achievements',
'view-certificates',
)
);
return false;
}
/**
* Update db version to 6.3.0.
*
* @since 6.3.0
*
* @return void|true True if it needs to run again, nothing if otherwise.
*/
function update_db_version() {
\LLMS_Install::update_db_version( '6.3.0' );
}
================================================
FILE: includes/functions/updates/llms-functions-updates-750.php
================================================
<?php
/**
* Update functions for version 7.5.0
*
* @package LifterLMS/Functions/Updates
*
* @since 7.5.0
* @version [versoin]]
*/
namespace LLMS\Updates\Version_7_5_0;
defined( 'ABSPATH' ) || exit;
/**
* Retrieves the DB version of the migration.
*
* @since 7.5.0
*
* @access private
*
* @return string
*/
function _get_db_version() {
return '7.5.0';
}
/**
* Disable favorites feature for old users.
*
* @since 7.5.0
*
* @return void
*/
function favorites_feature_bc() {
update_option( 'lifterlms_favorites', 'no' );
}
/**
* Update db version to 7.5.0
*
* @since 7.5.0
*
* @return false.
*/
function update_db_version() {
\LLMS_Install::update_db_version( _get_db_version() );
return false;
}
================================================
FILE: includes/functions/updates/llms-functions-updates-780.php
================================================
<?php
/**
* Update functions for version [version]
*
* @package LifterLMS/Functions/Updates
*
* @since 7.8.0
* @version 7.8.0
*/
namespace LLMS\Updates\Version_7_8_0;
defined( 'ABSPATH' ) || exit;
/**
* Retrieves the DB version of the migration.
*
* @since 7.8.0
*
* @access private
*
* @return string
*/
function _get_db_version() {
return '7.8.0';
}
/**
* Create a new option to enable Access Plan SKUs if any existing plans have a SKU set.
*
* @since 7.8.0
*
* @return false
*/
function maybe_set_option_llms_access_plans_allow_skus() {
// Find postmeta values for `_llms_plan_sku` that are not empty.
global $wpdb;
$found_plan_skus = $wpdb->get_results(
"SELECT *
FROM {$wpdb->postmeta}
WHERE meta_key = '_llms_sku'
AND meta_value != ''"
);
// If we found a plan with a SKU, update the option and return.
if ( $found_plan_skus ) {
update_option( 'llms_access_plans_allow_skus', 'yes' );
}
return false;
}
/**
* Update db version to [version].
*
* @since 7.8.0
*
* @return false.
*/
function update_db_version() {
\LLMS_Install::update_db_version( _get_db_version() );
return false;
}
================================================
FILE: includes/functions/updates/llms-functions-updates-785.php
================================================
<?php
/**
* Update functions for version [version]
*
* @package LifterLMS/Functions/Updates
*
* @since 7.8.5
* @version 7.8.5
*/
namespace LLMS\Updates\Version_7_8_5;
defined( 'ABSPATH' ) || exit;
/**
* Retrieves the DB version of the migration.
*
* @since 7.8.5
*
* @access private
*
* @return string
*/
function _get_db_version() {
return '7.8.5';
}
/**
* Verify and delete the password_confirm usermeta.
*
* @since 7.8.5
*
* @return false
*/
function maybe_remove_pwc() {
global $wpdb;
$found_pwc_meta = $wpdb->get_results(
"SELECT *
FROM {$wpdb->usermeta}
WHERE meta_key = 'password_confirm'"
);
if ( $found_pwc_meta ) {
update_option( 'llms_pwc_notice', 'yes' );
$wpdb->query(
"DELETE
FROM {$wpdb->usermeta}
WHERE meta_key = 'password_confirm'"
);
show_notice();
}
return false;
}
/**
* Shows an admin notice.
*
* @since 7.8.5
*
* @return boolean
*/
function show_notice() {
$notice_id = sprintf( 'v%s-msg', str_replace( array( '.', '-' ), '', _get_db_version() ) );
$html = sprintf(
'<strong>%1$s</strong><br><br>%2$s<br><br>%3$s',
__( 'Security Notice', 'lifterlms' ),
sprintf(
// Translators: %1$s = Opening anchor tag to the welcome blog post on lifterlms.com; %2$s = Closing anchor tag.
__( 'We\'ve detected that your site has been affected by a security issue fixed in the v7.8.5 update to LifterLMS. Further action is required. Your site may have been saving user passwords to the user meta table in plaintext. %1$sClick here to learn more%2$s.', 'lifterlms' ),
'<a href="https://lifterlms.com/blog/security-release-password-block/?utm_source=notice&utm_medium=product&utm_campaign=lifterlmsplugin&utm_content=785-notice" target="_blank" rel="noopener">',
'</a>'
),
sprintf(
// Translators: %1$s = Opening anchor tag to the welcome blog post on lifterlms.com; %2$s = Closing anchor tag.
__( '%1$sRead More%2$s', 'lifterlms' ),
'<a class="button" href="https://lifterlms.com/blog/security-release-password-block/?utm_source=notice&utm_medium=product&utm_campaign=lifterlmsplugin&utm_content=785-notice" target="_blank" rel="noopener">',
'</a>'
)
);
\LLMS_Admin_Notices::add_notice(
$notice_id,
$html,
array(
'type' => 'error',
'dismiss_for_days' => 0,
'remindable' => false,
)
);
return false;
}
/**
* Update db version to [version].
*
* @since 7.8.5
*
* @return false.
*/
function update_db_version() {
global $wpdb;
$found_pwc_meta = $wpdb->get_results(
"SELECT *
FROM {$wpdb->usermeta}
WHERE meta_key = 'password_confirm'"
);
if ( $found_pwc_meta ) {
// Don't update the db version yet.
return;
}
\LLMS_Install::update_db_version( _get_db_version() );
return false;
}
================================================
FILE: includes/functions/updates/llms-functions-updates-900.php
================================================
<?php
/**
* Update functions for version [version]
*
* @package LifterLMS/Functions/Updates
*
* @since 9.0.0
*/
namespace LLMS\Updates\Version_9_0_0;
defined( 'ABSPATH' ) || exit;
function _get_db_version() {
return '9.0.0';
}
/**
* Shows an admin notice.
*
* @since 9.0.0
*
* @return boolean
*/
function show_notice() {
$notice_id = sprintf( 'v%s-msg', str_replace( array( '.', '-' ), '', _get_db_version() ) );
$html = sprintf(
'<strong>%1$s</strong><br><br>%2$s<br><br>%3$s',
__( 'New Features Available', 'lifterlms' ),
// Translators: %1$s = Opening anchor tag to the security settings tab; %2$s = Closing anchor tag.
sprintf(
__( 'We\'ve added spam and security features to protect your website inside the core plugin. You can review the available features on the new %1$sSecurity settings tab%2$s.', 'lifterlms' ),
'<a href="' . admin_url( 'admin.php?page=llms-settings&tab=security' ) . '">',
'</a>'
),
sprintf(
// Translators: %1$s = Opening anchor tag to the blog post on lifterlms.com; %2$s = Closing anchor tag.
__( '%1$sRead More%2$s', 'lifterlms' ),
'<a class="button" href="https://lifterlms.com/blog/new-website-spam-and-security-features/?utm_source=notice&utm_medium=product&utm_campaign=lifterlmsplugin&utm_content=900-notice" target="_blank" rel="noopener">',
'</a>'
)
);
\LLMS_Admin_Notices::add_notice(
$notice_id,
$html,
array(
'type' => 'info',
'dismiss_for_days' => 0,
'remindable' => false,
)
);
return false;
}
/**
* Update db version.
*
* @since 9.0.0
*
* @return false.
*/
function update_db_version() {
\LLMS_Install::update_db_version( _get_db_version() );
return false;
}
================================================
FILE: includes/functions/updates/llms-functions-updates-921.php
================================================
<?php
/**
* Update functions for version 9.2.1
*
* @package LifterLMS/Functions/Updates
*
* @since 9.2.1
*/
namespace LLMS\Updates\Version_9_2_1;
defined( 'ABSPATH' ) || exit;
/**
* Retrieves the DB version of the migration.
*
* @since 9.2.1
*
* @return string
*/
function _get_db_version() {
return '9.2.1';
}
/**
* Clear stale course data locks and re-schedule course data processing.
*
* Finds all `_llms_temp_calc_data_lock` postmeta entries, deletes them, and
* triggers `llms_course_calculate_data` for each affected course.
*
* Returns `true` if there may be more records to process so the background
* updater can call this again, otherwise `false` when done.
*
* @since 9.2.1
*
* @return bool
*/
function reset_course_calc_data_locks() {
global $wpdb;
$per_page = \llms_update_util_get_items_per_page();
// Find a page of locked courses.
$course_ids = $wpdb->get_col(
$wpdb->prepare(
"
SELECT DISTINCT pm.post_id
FROM {$wpdb->postmeta} AS pm
INNER JOIN {$wpdb->posts} AS p
ON p.ID = pm.post_id
WHERE pm.meta_key = %s
AND p.post_type = %s
LIMIT %d
",
'_llms_temp_calc_data_lock',
'course',
$per_page
)
);// db call ok; no-cache ok.
if ( empty( $course_ids ) ) {
return false;
}
foreach ( $course_ids as $course_id ) {
$course_id = (int) $course_id;
// Drop the temp lock meta.
\delete_post_meta( $course_id, '_llms_temp_calc_data_lock' );
// Kick off a fresh course data calculation round.
// LLMS_Processor_Course_Data::schedule_calculation() is already
// wired to this action and internally avoids duplicate scheduling
// via wp_next_scheduled().
\do_action( 'llms_course_calculate_data', $course_id );
}
// If there were $per_page results, assume there might be more.
return ( count( $course_ids ) === $per_page );
}
/**
* Update db version to 9.2.1.
*
* @since 9.2.1
*
* @return false
*/
function update_db_version() {
\LLMS_Install::update_db_version( _get_db_version() );
return false;
}
================================================
FILE: includes/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/integrations/class.llms.integration.bbpress.php
================================================
<?php
/**
* bbPress Integration
*
* @package LifterLMS/Integrations/Classes
*
* @since 3.0.0
* @version 4.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* bbPress Integration
*
* @since 3.0.0
* @since 3.30.3 Fixed spelling errors.
* @since 3.35.0 Sanitize input data.
* @since 3.37.11 Don't update saved forum values during course quick edits.
* @since 3.38.1 When looking for forum course restrictions make sure to run a more generic query
* so that it matches forum ids whether they've been save as integers or strings.
* @since 4.0.0 Added MySQL 8.0 compatibility.
*/
class LLMS_Integration_BBPress extends LLMS_Abstract_Integration {
/**
* Integration ID
*
* @var string
*/
public $id = 'bbpress';
/**
* Display order on Integrations tab
*
* @var integer
*/
protected $priority = 5;
/**
* Configure the integration
*
* @since 3.8.0
* @since 3.30.3 Fixed spelling errors.
*
* @return void
*/
protected function configure() {
add_action( 'init', array( $this, 'set_title_and_description' ) );
if ( $this->is_available() ) {
// Custom engagements.
add_filter( 'lifterlms_engagement_triggers', array( $this, 'register_engagement_triggers' ) );
add_action( 'bbp_new_topic', array( llms()->engagements(), 'maybe_trigger_engagement' ), 10, 4 );
add_action( 'bbp_new_reply', array( llms()->engagements(), 'maybe_trigger_engagement' ), 10, 5 );
add_filter( 'lifterlms_external_engagement_query_arguments', array( $this, 'engagement_query_args' ), 10, 3 );
// Register shortcode.
add_filter( 'llms_load_shortcodes', array( $this, 'register_shortcodes' ) );
// Add memberships restriction metabox.
add_filter( 'llms_membership_restricted_post_types', array( $this, 'add_membership_restrictions' ) );
// Check forum/bbp template restrictions.
add_filter( 'llms_page_restricted_before_check_access', array( $this, 'restriction_checks_memberships' ), 40, 1 );
add_filter( 'llms_page_restricted_before_check_access', array( $this, 'restriction_checks_courses' ), 50, 1 );
// Add and save custom fields.
add_filter( 'llms_metabox_fields_lifterlms_course_options', array( $this, 'course_settings_fields' ) );
add_action( 'llms_metabox_after_save_lifterlms-course-options', array( $this, 'save_course_settings' ) );
add_filter( 'llms_get_course_properties', array( $this, 'add_course_props' ), 10, 2 );
add_action( 'llms_content_restricted_by_bbp_course_forum', array( $this, 'handle_course_forum_restriction' ), 10, 1 );
}
}
public function set_title_and_description() {
$this->title = __( 'bbPress', 'lifterlms' );
/* translators: %1$s: Open learn more link tag, %2$s: Closing tag. */
$this->description = sprintf( __( 'Restrict forums and topics to memberships, add forums to courses, and %1$smore%2$s.', 'lifterlms' ), '<a href="https://lifterlms.com/docs/lifterlms-and-bbpress/" target="_blank">', '</a>' );
}
/**
* Register the custom course property with the LLMS_Course Model
*
* @since 3.12.0
*
* @param array $props Default properties.
* @param LLMS_Course $course Course object.
* @return array
*/
public function add_course_props( $props, $course ) {
$props['bbp_forum_ids'] = 'array';
return $props;
}
/**
* Add the membership restrictions metabox to bbPress forums on admin panel
*
* @since 3.0.0
*
* @param string[] $post_types Array of existing post types.
* @return string[]
*/
public function add_membership_restrictions( $post_types ) {
$post_types[] = bbp_get_forum_post_type();
return $post_types;
}
/**
* Register custom bbPress tab with the LLMS Course metabox
*
* @since 3.12.0
*
* @param array $fields Existing fields.
* @return array
*/
public function course_settings_fields( $fields ) {
global $post;
$selected = $this->get_course_forum_ids( $post );
$fields[] = array(
'title' => __( 'bbPress', 'lifterlms' ),
'fields' => array(
array(
'allow_null' => false,
'data_attributes' => array(
'post-type' => 'forum',
'allow-clear' => true,
'placeholder' => __( 'Select forums', 'lifterlms' ),
),
'desc' => __( 'Add forums which will only be available to students currently enrolled in this course.', 'lifterlms' ),
'class' => 'llms-select2-post',
'id' => '_llms_bbp_forum_ids',
'type' => 'select',
'label' => __( 'Private Course Forums', 'lifterlms' ),
'multi' => true,
'value' => llms_make_select2_post_array( $selected ),
),
),
);
return $fields;
}
/**
* Parse action arguments for bbPress engagements and pass them back to the LLMS Engagements handler
*
* @since 3.12.0
* @since 3.37.11 Use strict comparison for `in_array()`.
*
* @param array $query_args Query args for handler.
* @param string $action Triggering action name.
* @param array $orig_args Original arguments from the action (indexed array).
* @return array
*/
public function engagement_query_args( $query_args, $action, $orig_args ) {
if ( in_array( $action, array( 'bbp_new_reply', 'bbp_new_topic' ), true ) ) {
$query_args['trigger_type'] = $action;
$query_args['related_post_id'] = '';
if ( 'bbp_new_reply' === $action ) {
$query_args['user_id'] = $orig_args[4]; // Reply Author.
} elseif ( 'bbp_new_topic' === $action ) {
$query_args['user_id'] = $orig_args[3]; // Topic Author.
}
}
return $query_args;
}
/**
* Handle course forum restrictions
*
* Add a notice and redirect to the course
*
* @since 3.12.0
* @since 3.13.0 Unknown.
* @since 3.37.11 Use `llms_redirect_and_exit()` in favor of `wp_redirect()`.
*
* @param array $restriction Restriction Results from `llms_page_restricted()`.
* @return void
*/
public function handle_course_forum_restriction( $restriction ) {
/**
* Customize the restriction notice message displayed when a forum is restricted to a course.
*
* @since 3.37.11
*
* @param string $msg Default message.
* @param array $restriction Results from `llms_page_restricted()`.
*/
$msg = apply_filters( 'llms_bbp_course_forum_restriction_msg', __( 'You must be enrolled in this course to access the course forum.', 'lifterlms' ), $restriction );
llms_add_notice( $msg, 'error' );
llms_redirect_and_exit( get_permalink( $restriction['restriction_id'] ) );
}
/**
* Retrieve course ids restricted to a LifterLMS course
*
* @since 3.12.0
*
* @param mixed $course WP_Post, LLMS_Course, or WP_Post ID.
* @return array
*/
public function get_course_forum_ids( $course ) {
$course = llms_get_post( $course );
if ( ! $course ) {
$ids = array();
} else {
$ids = $course->get( 'bbp_forum_ids' );
if ( '' === $ids ) {
$ids = array();
}
}
/**
* Customize the bbPress forum IDs associated with a course.
*
* @since 3.37.11
*
* @param int[] $ids Array of WP_Post IDs of the bbPress forums restricted to the course.
* @param LLMS_Course $course LifterLMS course object.
*/
return apply_filters( 'llms_bbp_get_course_forum_ids', $ids, $course );
}
/**
* Check if a forum is restricted to a course(s)
*
* @since 3.12.0
* @since 3.38.1 Make the query more generic so that it matches forum ids whether they've been saved as integers or strings.
* @since 4.0.0 Escape `{` character in SQL query to add MySQL 8.0 support.
*
* @param int $forum_id WP_Post ID of the forum.
* @return int[]
*/
public function get_forum_course_restrictions( $forum_id ) {
global $wpdb;
$query = $wpdb->get_col( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching
$wpdb->prepare(
"SELECT metas.post_id
FROM {$wpdb->postmeta} AS metas
JOIN {$wpdb->posts} AS posts on posts.ID = metas.post_id
WHERE metas.meta_key = '_llms_bbp_forum_ids'
AND metas.meta_value REGEXP %s
AND posts.post_status = 'publish';",
'a:[0-9][0-9]*:\{(i:[0-9][0-9]*;(i|s:[0-9][0-9]*):"?[0-9][0-9]*"?;)*(i:[0-9][0-9]*;(i|s:[0-9][0-9]*):"?' . sprintf( '%d', absint( $forum_id ) ) . '"?;)'
)
);
$query = array_map( 'absint', $query );
return $query;
}
/**
* Determine if bbPress is installed and activated
*
* @since 3.0.0
*
* @return boolean
*/
public function is_installed() {
return class_exists( 'bbPress' );
}
/**
* Register shortcodes via LifterLMS core registration methods
*
* @since 3.12.0
*
* @param string[] $classes Existing shortcode classes.
* @return array
*/
public function register_shortcodes( $classes ) {
$classes[] = 'LLMS_BBP_Shortcode_Course_Forums_List';
return $classes;
}
/**
* Check forum restrictions for course restrictions
*
* @since 3.12.0
* @since 3.12.2 Unknown.
*
* @param array $results Array of restriction results.
* @return array
*/
public function restriction_checks_courses( $results ) {
$post_id = null;
if ( bbp_is_forum( $results['content_id'] ) ) {
$user_id = get_current_user_id();
$courses = $this->get_forum_course_restrictions( $results['content_id'] );
// No user and at least one course restriction, return the first.
if ( $courses && ! $user_id ) {
$post_id = $courses[0];
// Courses and a user, find at least one enrollment.
} elseif ( $courses && $user_id ) {
foreach ( $courses as $course_id ) {
// Not enrolled, use this for the restriction but dont break because we may find an enrollment later.
if ( ! llms_is_user_enrolled( $user_id, $course_id ) ) {
$post_id = $course_id;
// Enrolled in one, reset the post id and break.
} else {
$post_id = null;
break;
}
}
}
} elseif ( bbp_is_topic( $results['content_id'] ) ) {
$results['content_id'] = bbp_get_topic_forum_id( $results['content_id'] );
return $this->restriction_checks_courses( $results );
}
if ( $post_id ) {
$results['restriction_id'] = $post_id;
$results['reason'] = 'bbp_course_forum';
}
return $results;
}
/**
* Check membership restrictions for Topics and Forum Archive pages
*
* @since 3.12.0
*
* @param array $results Array of restriction results.
* @return array
*/
public function restriction_checks_memberships( $results ) {
$post_id = null;
// Forum archive, grab the page (if set).
if ( bbp_is_forum_archive() ) {
$page = bbp_get_page_by_path( bbp_get_root_slug() );
$post_id = ( $page && $page->ID ) ? $page->ID : null;
$reason = 'membership';
} elseif ( bbp_is_topic( $results['content_id'] ) ) {
$post_id = bbp_get_topic_forum_id( $results['content_id'] );
$reason = 'membership';
}
if ( $post_id ) {
$restriction_id = llms_is_post_restricted_by_membership( $post_id, get_current_user_id() );
if ( $restriction_id ) {
$results['restriction_id'] = $restriction_id;
$results['reason'] = 'membership';
}
}
return $results;
}
/**
* Register engagement triggers
*
* @since 3.12.0
*
* @param string[] $triggers Existing triggers.
* @return array
*/
public function register_engagement_triggers( $triggers ) {
$triggers['bbp_new_topic'] = __( 'Student creates a new forum topic', 'lifterlms' );
$triggers['bbp_new_reply'] = __( 'Student creates a new forum reply', 'lifterlms' );
return $triggers;
}
/**
* Save course metabox custom fields
*
* @since 3.12.0
* @since 3.35.0 Sanitize input data.
* @since 3.37.11 Don't update saved forum values during course quick edits & remove redundant sanitization.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @param int $post_id WP_Post ID of the course.
* @return null|int[]
*/
public function save_course_settings( $post_id ) {
// Return early on quick edits.
$action = llms_filter_input( INPUT_POST, 'action' );
if ( 'inline-save' === $action ) {
return null;
}
$ids = array();
if ( isset( $_POST['_llms_bbp_forum_ids'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
$ids = llms_filter_input( INPUT_POST, '_llms_bbp_forum_ids', FILTER_SANITIZE_NUMBER_INT, FILTER_REQUIRE_ARRAY );
}
update_post_meta( $post_id, '_llms_bbp_forum_ids', $ids );
return $ids;
}
}
================================================
FILE: includes/integrations/class.llms.integration.buddypress.php
================================================
<?php
/**
* BuddyPress Integration
*
* @package LifterLMS/Integrations/Classes
*
* @since 1.0.0
* @version 6.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* BuddyPress Integration.
*
* @since 1.0.0
* @since 3.37.17 Fixed `courses` pagination.
*/
class LLMS_Integration_Buddypress extends LLMS_Abstract_Integration {
public $id = 'buddypress';
/**
* Display order on Integrations tab.
*
* @var integer
*/
protected $priority = 5;
/**
* Current endpoint's key being processed.
*
* @var string
*/
private $current_endpoint_key;
/**
* Profile endpoints.
*
* @var array[]
*/
private $endpoints;
/**
* Options data abstract version.
*
* This is used to determine the behavior of the `get_option()` method.
*
* Concrete classes should use version 2 in order to use the new (future default)
* behavior of the method.
*
* @var int
*/
protected $version = 2;
/**
* Configure the integration.
*
* Do things like configure ID and title here.
*
* @since 3.12.0
*
* @return void
*/
protected function configure() {
add_action( 'init', array( $this, 'set_title_and_description' ) );
if ( $this->is_available() ) {
add_action( 'bp_setup_nav', array( $this, 'add_profile_nav_items' ) );
add_filter( 'llms_page_restricted_before_check_access', array( $this, 'restriction_checks' ), 40, 1 );
add_filter( 'lifterlms_update_account_redirect', array( $this, 'maybe_alter_update_account_redirect' ) );
// Groups Add-on integration.
add_filter( 'llms_groups_enqueue_dashboard_style', array( $this, 'return_true_on_bp_my_profile' ) );
add_filter( 'llms_groups_maybe_hide_dashboard_tab', array( $this, 'return_true_on_bp_my_profile' ) );
}
}
public function set_title_and_description() {
$this->title = __( 'BuddyPress', 'lifterlms' );
/* translators: %1$s: Open learn more link tag, %2$s: Closing tag. */
$this->description = sprintf( __( 'Add LifterLMS information to user profiles and enable membership restrictions for activity, group, and member directories. %1$sLearn More%2$s.', 'lifterlms' ), '<a href="https://lifterlms.com/docs/lifterlms-and-buddypress/" target="_blank">', '</a>' );
}
/**
* Retrieve integration settings.
*
* @since 6.3.0
*
* @return array
*/
public function get_integration_settings() {
$settings = array();
if ( $this->is_available() ) {
$display_eps = $this->get_profile_endpoints_options();
$settings[] = array(
'class' => 'llms-select2',
'desc' => '<br>' . __( 'The following LifterLMS Student Dashboard areas will be added to the BuddyPress user profiles', 'lifterlms' ),
'default' => array_keys( $display_eps ),
'id' => $this->get_option_name( 'profile_endpoints' ),
'options' => $display_eps,
'type' => 'multiselect',
'title' => __( 'User Profile Endpoints', 'lifterlms' ),
);
}
return $settings;
}
/**
* Add LLMS navigation items to the BuddyPress User Profile.
*
* @since 1.0.0
* @since 6.3.0 Display all registered dashboard tabs (enabled in the settings) automatically.
* Use `bp_loggedin_user_domain()` to determine the current user domain
* to be used in the profile nav item's links, in favor of relying on the global `$bp`.
* @since 6.8.0 Revert adding nav items only on bp my profile. @link https://github.com/gocodebox/lifterlms/issues/2142.
*
* @return void
*/
public function add_profile_nav_items() {
$profile_endpoints = $this->get_profile_endpoints();
if ( empty( $profile_endpoints ) ) {
return;
}
$bp_is_my_profile = bp_is_my_profile();
$user_domain = bp_loggedin_user_domain();
$first_endpoint = reset( $profile_endpoints );
/**
* Filters the LifterLMS main nav item slug in the BuddyPress profile menu.
*
* @since 6.3.0
*
* @param string $slug The LifterLMS main nav item slug in the BuddyPress profile menu.
*/
$main_nav_slug = apply_filters( 'llms_buddypress_main_nav_item_slug', _x( 'courses', 'BuddyPress profile main nav item slug', 'lifterlms' ) );
$parent_url = $user_domain . $main_nav_slug . '/';
// Add the main nav menu.
bp_core_new_nav_item(
array(
/**
* Filters the LifterLMS main nav item label in the BuddyPress profile menu.
*
* @since 6.3.0
*
* @param string $label The LifterLMS main nav item label in the BuddyPress profile menu.
*/
'name' => apply_filters( 'llms_buddypress_main_nav_item_label', _x( 'Courses', 'BuddyPress profile main nav item label', 'lifterlms' ) ),
'slug' => $main_nav_slug,
/**
* Filters the LifterLMS main nav item position in the BuddyPress profile menu.
*
* @since 6.3.0
*
* @param string $position The LifterLMS main nav item position in the BuddyPress profile menu.
*/
'position' => apply_filters( 'llms_buddypress_main_nav_item_position', 20 ),
'default_subnav_slug' => $first_endpoint['endpoint'],
'show_for_displayed_user' => false,
)
);
foreach ( $profile_endpoints as $ep_key => $profile_endpoint ) {
// Add sub nav item.
bp_core_new_subnav_item(
array(
'name' => $profile_endpoint['title'],
'slug' => $profile_endpoint['endpoint'],
'parent_slug' => $main_nav_slug,
'parent_url' => $parent_url,
'screen_function' => function () use ( $ep_key, $profile_endpoint ) {
$this->endpoint_content( $ep_key, $profile_endpoint['content'] );
},
'user_has_access' => $bp_is_my_profile,
)
);
}
}
/**
* Redirect on the same bb profile page when successfully update the account.
*
* @since 6.3.0
*
* @param string $account_update_redirect_url Account update redirect url.
* @return string
*/
public function maybe_alter_update_account_redirect( $account_update_redirect_url ) {
return bp_is_my_profile() ? bp_get_requested_url() : $account_update_redirect_url;
}
/**
* Checks if the BuddyPress plugin is installed & activated
*
* @since 1.0.0
*
* @return bool
*/
public function is_installed() {
return ( class_exists( 'BuddyPress' ) );
}
/**
* Callback for "Achievements" profile screen.
*
* @since 1.0.0
* @since 3.14.4 Unknown.
* @deprecated 6.3.0 Deprecated with no replacement. {@see LLMS_Integration_Buddypress::endpoint_content()}.
*
* @return void
*/
public function achievements_screen() {
llms_deprecated_function( 'LLMS_Integration_Buddypress::achievements_screen()', '6.3.0' );
add_action( 'bp_template_content', 'lifterlms_template_student_dashboard_my_achievements' );
bp_core_load_template( apply_filters( 'bp_core_template_plugin', 'members/single/plugins' ) );
}
/**
* Callback for "Certificates" profile screen.
*
* @since 1.0.0
* @since 3.14.4 Unknown.
* @deprecated 6.3.0 Deprecated with no replacement. {@see LLMS_Integration_Buddypress::endpoint_content()}.
*
* @return void
*/
public function certificates_screen() {
llms_deprecated_function( 'LLMS_Integration_Buddypress::certificates_screen()', '6.3.0' );
add_action( 'bp_template_content', 'lifterlms_template_student_dashboard_my_certificates' );
bp_core_load_template( apply_filters( 'bp_core_template_plugin', 'members/single/plugins' ) );
}
/**
* Callback for "Courses" profile screen.
*
* @since 1.0.0
* @since 3.14.4 Unknown.
* @since 3.37.17 Added action and filters to fix handling pagination links mofication.
* @deprecated 6.3.0 Deprecated with no replacement. {@see LLMS_Integration_Buddypress::endpoint_content()}.
*
* @return void
*/
public function courses_screen() {
llms_deprecated_function( 'LLMS_Integration_Buddypress::courses_screen()', '6.3.0' );
// Prevent paginate links alteration performed in includes/functions/llms.functions.templates.dashboard.php.
add_filter( 'llms_modify_dashboard_pagination_links_disable', '__return_true', 999 );
// Add specific paginate links filter.
add_filter( 'paginate_links', array( $this, 'modify_courses_paginate_links' ) );
add_action( 'bp_template_content', 'lifterlms_template_student_dashboard_my_courses' );
// Remove specific paginate links filter after the template has been rendered.
add_action( 'bp_template_content', array( $this, 'remove_courses_paginate_links_filter' ), 15 );
bp_core_load_template( apply_filters( 'bp_core_template_plugin', 'members/single/plugins' ) );
}
/**
* Callback for endpoint profile content.
*
* @since 6.3.0
*
* @param string $ep_key The endpoint's key being processed.
* @param Callable $ep_template_cb The endpoint's template callback.
* @return void
*/
public function endpoint_content( $ep_key, $ep_template_cb ) {
// Store what endpoint key we're processing.
$this->current_endpoint_key = $ep_key;
// Enqueue scripts.
add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_assets' ), 20 );
// Prevent paginate links alteration performed in includes/functions/llms.functions.templates.dashboard.php.
add_filter( 'llms_modify_dashboard_pagination_links_disable', '__return_true', 999 );
// Add specific paginate links filter.
add_filter( 'paginate_links', array( $this, 'modify_paginate_links' ) );
add_action( 'bp_template_content', $ep_template_cb );
// Remove specific paginate links filter after the template has been rendered.
add_action( 'bp_template_content', array( $this, 'remove_paginate_links_filter' ), 15 );
// This triggers 'bp_template_content' action hook.
bp_core_load_template( apply_filters( 'bp_core_template_plugin', 'members/single/plugins' ) );
}
/**
* Enqueue assets specific for the profile endpoints.
*
* @since 6.3.0
*
* @return void
*/
public function enqueue_assets() {
if ( empty( $this->current_endpoint_key ) ) {
return;
}
if ( 'view-achievements' === $this->current_endpoint_key ) {
// The iziModal is needed by the achievements endpoint.
llms()->assets->enqueue_style( 'llms-iziModal' );
llms()->assets->enqueue_script( 'llms-iziModal' );
}
if ( 'edit-account' === $this->current_endpoint_key ) {
// Needed in the account edit endpoint.
llms()->assets->enqueue_style( 'llms-select2-styles' );
llms()->assets->enqueue_script( 'llms-select2' );
wp_add_inline_script(
'llms',
"window.llms.address_info = '" . wp_json_encode( llms_get_countries_address_info() ) . "';"
);
}
}
/**
* Remove specific paginate links filter after the template has been rendered.
*
* @since 6.3.0
*
* @return void
*/
public function remove_paginate_links_filter() {
remove_filter( 'paginate_links', array( $this, 'modify_paginate_links' ) );
}
/**
* Remove specific paginate links filter after the template has been rendered.
*
* @since 3.37.17
* @deprecated 6.3.0 Deprecated with no replacement. {@see LLMS_Integration_Buddypress::remove_paginate_links_filter()}.
*
* @return void
*/
public function remove_courses_paginate_links_filter() {
llms_deprecated_function( 'LLMS_Integration_Buddypress::remove_courses_paginate_links_filter()', '6.3.0' );
remove_filter( 'paginate_links', array( $this, 'modify_courses_paginate_links' ) );
}
/**
* Modify the pagination links displayed on the courses endpoint in the bp member profile.
*
* @since 3.37.17
* @deprecated 6.3.0 Deprecated with no replacement. {@see LLMS_Integration_Buddypress::modify_paginate_links()}.
*
* @param string $link Default link.
* @return string
*/
public function modify_courses_paginate_links( $link ) {
llms_deprecated_function( 'LLMS_Integration_Buddypress::modify_courses_paginate_links()', '6.3.0' );
$this->current_endpoint_key;
return $this->modify_paginate_links( $link );
}
/**
* Modify the pagination links for the endpoints in the bp member profile.
*
* This fixes the pagination not correctly working on the fist subnav.
*
* @since 6.3.0
*
* @param string $link Default link.
* @return string
*/
public function modify_paginate_links( $link ) {
global $wp_rewrite;
// With ugly permalinks actually the whole BuddyPress member profile page doesn't work.
if ( ! get_option( 'permalink_structure' ) ) {
return $link;
}
// Remove query vars if any, we'll add them back later.
$query = wp_parse_url( $link, PHP_URL_QUERY );
if ( $query ) {
$link = str_replace( '?' . $query, '', $link );
}
// Retrieve link's page number.
$parts = explode( '/', untrailingslashit( $link ) );
$page = end( $parts );
// For links to page 1 let's remove it to avoid ugly URLs.
if ( 1 === (int) $page ) {
$link = str_replace(
user_trailingslashit( $wp_rewrite->pagination_base . '/' . $page ),
'',
$link
);
}
$endpoints = $this->get_profile_endpoints();
// If we're not the first subnav, our job is done, add back the query var and return.
if ( key( $endpoints ) !== $this->current_endpoint_key ) {
return $query ? $link . '?' . $query : $link;
}
// Retrieve our first subnav menu item.
$first_subnav_item = buddypress()->members->nav->get_secondary(
array(
/** This filter is documented above */
'parent_slug' => apply_filters( 'llms_buddypress_main_nav_item_slug', _x( 'courses', 'BuddyPress profile main nav item slug', 'lifterlms' ) ),
'slug' => $endpoints[ $this->current_endpoint_key ]['endpoint'],
)
);
if ( is_array( $first_subnav_item ) ) {
$first_subnav_item = reset( $first_subnav_item );
} else { // Bail.
return $query ? $link . '?' . $query : $link;
}
$current_page = llms_get_paged_query_var();
/**
* Here's the core of this filter.
*
* What happens is that the pagination links on the first page of the fist subnav,
* e.g. 'my-courses' endpoint (as example for the fist subnav) are of this type:
* `example.local/members/admin/courses/page/N`,
* where 'courses' is the slug of the main nav item.
* While the "working" paginate links must be of the type:
* `example.local/members/admin/courses/my-courses/page/N`
* where 'courses' is the slug of the main nav item, and 'my-courses' is the slug of
* the subnav item which is the default subnav for the main nav item.
*
* So what we do here is replacing the link that looks like:
* `example.local/members/admin/courses/page/N` to something like:
* `example.local/members/admin/courses/my-courses/page/N`
*
* Despite one might expect, `$first_subnav_item->link` doesn't point to `example.local/members/admin/courses/my-courses/`
* but to `example.local/members/admin/courses/`, which is the link of the parent nav, the main nav item,
* this because the 'my-courses' subnav item is the default of the 'courses' nav item (default_subnav_slug).
*/
if ( 1 === $current_page ) {
$link = user_trailingslashit( $first_subnav_item->link . $first_subnav_item->slug . '/' . $wp_rewrite->pagination_base . '/' . $page );
} elseif ( 1 === (int) $page ) {
/**
* For links to page 1, when not on page 1, let's back on the main nav item URL, so we replace something like
* `example.local/members/admin/courses/my-courses/`
* to something like
* `example.local/members/admin/courses/`
*/
$link = $first_subnav_item->link;
}
return $query ? $link . '?' . $query : $link;
}
/**
* Helper that returns true when on BuddyPress My Profile.
*
* @since 6.3.0
*
* @param mixed $arg Argument to return when not on BuddyPress My Profile.
* @return mixed
*/
public function return_true_on_bp_my_profile( $arg = null ) {
return bp_is_my_profile() ? true : $arg;
}
/**
* Callback for "memberships" profile screen.
*
* @since 1.0.0
* @since 3.14.4 Unknown.
* @deprecated 6.3.0 Deprecated with no replacement. {@see LLMS_Integration_Buddypress::endpoint_content()}.
*
* @return void
*/
public function memberships_screen() {
llms_deprecated_function( 'LLMS_Integration_Buddypress::memberships_screen()', '6.3.0' );
add_action( 'bp_template_content', 'lifterlms_template_student_dashboard_my_memberships' );
bp_core_load_template( apply_filters( 'bp_core_template_plugin', 'members/single/plugins' ) );
}
/**
* Allows restricting of BP Directory Pages for Activity and Members via LifterLMS membership restrictions.
*
* @since 3.12.0
*
* @param array $results Array of restriction results.
* @return array
*/
public function restriction_checks( $results ) {
// Only check directories.
if ( ! bp_is_directory() ) {
return $results;
}
$post_id = null;
// Activity.
if ( bp_is_activity_component() ) {
$post_id = bp_core_get_directory_page_id( 'activity' );
} elseif ( bp_is_members_component() ) {
$post_id = bp_core_get_directory_page_id( 'members' );
} elseif ( bp_is_groups_component() ) {
$post_id = bp_core_get_directory_page_id( 'groups' );
}
if ( $post_id ) {
$restriction_id = llms_is_post_restricted_by_membership( $post_id, get_current_user_id() );
if ( $restriction_id ) {
$results['content_id'] = $post_id;
$results['restriction_id'] = $restriction_id;
$results['reason'] = 'membership';
}
}
return $results;
}
/**
* Get profile endpoints options.
*
* Used to populate the settings' select.
*
* @since 6.3.0
*
* @return void
*/
private function get_profile_endpoints_options() {
$endpoints = $this->get_profile_endpoints( false );
return array_combine(
array_keys( $endpoints ),
array_column( $endpoints, 'title' )
);
}
/**
* Populate list of endpoints from LifterLMS Dashboard Settings.
*
* @since 6.3.0
*
* @return void
*/
private function populate_profile_endpoints() {
$exclude_llms_eps = array( 'dashboard', 'signout' );
$exclude_fields = array( 'nav_item', 'url', 'paginate' );
$endpoints = array();
foreach ( LLMS_Student_Dashboard::get_tabs() as $ep_key => $endpoint ) {
if ( ! in_array( $ep_key, $exclude_llms_eps, true ) ) {
$endpoints[ $ep_key ] = array_diff_key( $endpoint, array_flip( $exclude_fields ) );
}
}
/**
* Filter profile endpoints.
*
* Modify the LifterLMS dashboard endpoints which can be added to the BuddyPress profile page as custom tabs.
*
* @since 6.3.0
*
* @param array $endpoints Array of endpoint data.
*/
$this->endpoints = apply_filters( 'llms_buddypress_profile_endpoints', $endpoints );
}
/**
* Get a list of custom endpoints to add to BuddyPress profile page.
*
* @since 6.3.0
* @since 6.8.0 Remove redundant check on `is_null()`: `isset()` already implies it.
*
* @param bool $active_only If true, returns only active endpoints.
* @return array
*/
public function get_profile_endpoints( $active_only = true ) {
if ( ! isset( $this->endpoints ) ) {
$this->populate_profile_endpoints();
}
// Remove endpoints that don't have an 'endpoint' value.
$endpoints = array_filter(
$this->endpoints,
function ( $endpoint ) {
return ! empty( $endpoint['endpoint'] );
}
);
if ( $active_only ) {
// If no endpoints are saved an empty string is returned.
$active = $this->get_option( 'profile_endpoints', array_keys( $endpoints ) );
// Filter active endpoints only.
$endpoints = '' === $active
?
array()
:
array_intersect_key(
$endpoints,
array_flip( $active )
);
}
return $endpoints;
}
}
================================================
FILE: includes/integrations/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/interfaces/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/interfaces/interface.llms.notification.manager.php
================================================
<?php
/**
* LifterLMS Notification Interface
*
* @package LifterLMS/Interfaces
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Interface_Notification_Manager
*
* @since Unknown
*/
interface LLMS_Interface_Notification_Manager {
/**
* Characters added before merge codes
*
* @var string
*/
const MERGE_CODE_PREFIX = '{{';
/**
* Characters added after merge codes
*
* @var string
*/
const MERGE_CODE_SUFFIX = '}}';
/**
* Callback function for notifications
*
* Depending on the action that triggers this callback there will be a variable number of parameters
*
* @since Unknown
*
* @return void
*/
public function callback();
}
================================================
FILE: includes/interfaces/llms.interface.notification.controller.php
================================================
<?php
/**
* LifterLMS Notification Controller Interface
*
* @package LifterLMS/Interfaces
*
* @since Unknown
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Interface_Notification_Controller
*
* @since Unknown
*/
interface LLMS_Interface_Notification_Controller {
/**
* Callback function for sending notifications
*
* Depending on the action that triggers this callback there will be a variable number of parameters
*
* @since Unknown
*
* @return void
*/
public function action_callback();
}
================================================
FILE: includes/interfaces/llms.interface.post.instructors.php
================================================
<?php
/**
* LifterLMS Post Instructors Interface
*
* @package LifterLMS/Interfaces
*
* @since 3.13.0
* @version 3.13.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Interface_Post_Instructors interface
*
* @since 3.13.0
*/
interface LLMS_Interface_Post_Instructors {
/**
* Retrieve an instance of the Post Instructors model
*
* @since 3.13.0
*
* @return obj
*/
public function instructors();
/**
* Retrieve course instructor information
*
* @since 3.13.0
*
* @param boolean $exclude_hidden If true, excludes hidden instructors from the return array.
* @return array
*/
public function get_instructors( $exclude_hidden = false );
/**
* Save instructor information
*
* @since 3.13.0
*
* @param array $instructors Array of course instructor information.
* @return array
*/
public function set_instructors( $instructors = array() );
}
================================================
FILE: includes/llms-notifications.php
================================================
<?php
defined( 'ABSPATH' ) || exit;
require_once LLMS_PLUGIN_DIR . '/libraries/banner-notifications/banner-notifications.php';
$GLOBALS['lifterlms_banner_notifications'] = new Gocodebox_Banner_Notifier(
array(
'prefix' => 'lifterlms',
'version' => llms()->version,
'notifications_url' => 'https://notifications.lifterlms.com/v1/notifications.json',
)
);
function llms_maybe_hide_notifications( $priority ) {
if ( ! is_admin() ) {
return 0;
}
$current_screen = get_current_screen();
if ( ! isset( $current_screen->post_type ) ) {
return $priority;
}
// Check if we're on the main WP admin dashboard.
if ( 'dashboard' === $current_screen->id ) {
return $priority;
}
if ( llms_is_block_editor() ) {
return 0;
}
if (
strpos( $current_screen->post_type, 'llms_' ) !== 0 &&
strpos( $current_screen->base, 'lifterlms' ) !== 0 &&
! in_array( $current_screen->post_type, array( 'course', 'lesson' ), true )
) {
return 0;
}
return $priority;
}
add_filter( 'lifterlms_max_notification_priority', 'llms_maybe_hide_notifications', 10, 1 );
================================================
FILE: includes/llms.functions.core.php
================================================
<?php
/**
* Core LifterLMS functions file
*
* @package LifterLMS/Functions
*
* @since 1.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
require_once 'functions/llms-functions-l10n.php';
require_once 'functions/llms-functions-access-plans.php';
require_once 'functions/llms-functions-deprecated.php';
require_once 'functions/llms-functions-forms.php';
require_once 'functions/llms-functions-locale.php';
require_once 'functions/llms-functions-options.php';
require_once 'functions/llms-functions-progression.php';
require_once 'functions/llms-functions-user-information-fields.php';
require_once 'functions/llms-functions-wrappers.php';
require_once 'functions/llms.functions.access.php';
require_once 'functions/llms.functions.certificate.php';
require_once 'functions/llms.functions.course.php';
require_once 'functions/llms.functions.currency.php';
require_once 'functions/llms.functions.log.php';
require_once 'functions/llms.functions.notice.php';
require_once 'functions/llms.functions.order.php';
require_once 'functions/llms.functions.page.php';
require_once 'functions/llms.functions.person.php';
require_once 'functions/llms.functions.privacy.php';
require_once 'functions/llms.functions.quiz.php';
require_once 'functions/llms.functions.template.php';
require_once 'functions/llms.functions.user.postmeta.php';
require_once 'functions/llms.functions.favorite.php';
if ( ! function_exists( 'llms_anonymize_string' ) ) {
/**
* Anonymize a string.
*
* Masks the characters in a string with the specified character leaving a small number
* of characters visible. For example `llms_anonymize_string( 'MY_SECRET_STRING' ) will return
* 'MY************NG'.
*
* The number of retained original characters is dependent on the string's length:
*
* | Length | At start | At end | Example |
* | ------------- | -------- | ------ | ------------ |
* | 1 | 0 | 0 | * |
* | >= 2 && <= 6 | 0 | 1 | *****A |
* | >= 7 && <= 10 | 0 | 2 | ********AA |
* | >= 11 | 2 | 2 | AA*******AA |
*
* Any string that validates as an email address using `is_email()` will be split at the `@` symbol
* and each part of the email address will be anonymized separately, for example:
* `llms_anonymize_string( 'help@lifterlms.com' )` will return '***p@li*********om'.
*
* @since 6.4.0
*
* @param string $string The input string to be anonymized.
* @param string $char The character used to mask the string.
* @return string
*/
function llms_anonymize_string( $string, $char = '*' ) {
if ( is_email( $string ) ) {
$parts = explode( '@', $string );
return llms_anonymize_string( $parts[0] ) . '@' . llms_anonymize_string( $parts[1] );
}
$len = strlen( $string );
$at_front = 2;
$at_back = 2;
if ( 1 === $len ) {
return $char;
} elseif ( $len <= 6 ) {
$at_front = 0;
$at_back = 1;
} elseif ( $len <= 10 ) {
$at_front = 0;
}
$start = substr( $string, 0, $at_front );
$body = str_repeat( $char, strlen( $string ) - ( $at_front + $at_back ) );
$end = substr( $string, - $at_back );
return "{$start}{$body}{$end}";
}
}
/**
* Insert elements into an associative array after a specific array key
*
* If the requested key doesn't exit, the new item will be added to the end of the array.
* If you need to insert at the beginning of an array use array_merge( $new_item, $orig_item ).
*
* @since 3.21.0
*
* @param array $array Original associative array.
* @param string $after_key Key name in original array to insert new item after.
* @param string $insert_key Key name of the item to be inserted.
* @param mixed $insert_item Value to be inserted.
* @return array
*/
function llms_assoc_array_insert( $array, $after_key, $insert_key, $insert_item ) {
$res = array();
$new_item = array(
$insert_key => $insert_item,
);
$index = array_search( $after_key, array_keys( $array ) );
if ( false !== $index ) {
++$index;
$res = array_merge(
array_slice( $array, 0, $index, true ),
$new_item,
array_slice( $array, $index, count( $array ) - 1, true )
);
} else {
$res = array_merge( $array, $new_item );
}
return $res;
}
/**
* Do apply_filters( 'the_content', $content ) without actions adding their own content onto us...
*
* @param string $content Optional. The content. Default is empty string.
* @return string
* @since 3.16.10
* @version 3.19.2
*/
if ( ! function_exists( 'llms_content' ) ) {
function llms_content( $content = '' ) {
$content = do_shortcode( shortcode_unautop( wpautop( convert_chars( wptexturize( $content ) ) ) ) );
global $wp_embed;
if ( $wp_embed && method_exists( $wp_embed, 'autoembed' ) ) {
$content = $wp_embed->autoembed( $content );
}
return $content;
}
}
/**
* Mark a function as deprecated and inform when it is used.
*
* This function uses WP core's `_deprecated_function()`, logging to the LifterLMS log file
* located at `wp-content/updloads/llms-logs/llms-{$hash}.log` instead of `wp-content/debug.log`.
*
* @since 2.6.0
* @since 3.6.0 Unknown.
* @since 4.4.0 Uses WP `_deprecated_function()` instead of duplicating its logic.
*
* @param string $function Name of the deprecated function.
* @param string $version LifterLMS version that deprecated the function.
* @param string $replacement Optional. Replacement function. Default is `null`.
* @return void
*/
function llms_deprecated_function( $function, $version, $replacement = null ) {
_deprecated_function( esc_html( $function ), esc_html( $version ), esc_html( $replacement ) );
}
/**
* Cron function to cleanup files in the LLMS_TMP_DIR
*
* Removes any files that are more than a day old.
*
* @since 3.18.0
* @since 4.10.1 Use strict type comparisons.
*
* @return void
*/
function llms_cleanup_tmp() {
$max_age = llms_current_time( 'timestamp' ) - apply_filters( 'llms_tmpfile_max_age', DAY_IN_SECONDS );
$exclude = array( '.htaccess', 'index.html' );
foreach ( glob( LLMS_TMP_DIR . '*' ) as $file ) {
// Don't cleanup index and .htaccess.
if ( in_array( basename( $file ), $exclude, true ) ) {
continue;
}
if ( filemtime( $file ) < $max_age ) {
wp_delete_file( $file );
}
}
}
add_action( 'llms_cleanup_tmp', 'llms_cleanup_tmp' );
/**
* Escape and add quotes to a string, useful for array mapping when building queries.
*
* @since 6.0.0
*
* @param string $str Input string.
* @return string Escaped string wrapped in quotation marks.
*/
function llms_esc_and_quote_str( $str ) {
return "'" . esc_sql( $str ) . "'";
}
/**
* Retrieve an array of post types which can be completed by students
*
* @since 4.2.0
*
* @return string[]
*/
function llms_get_completable_post_types() {
/**
* Filter the list of post types which can be completed by students.
*
* @since Unknown
*
* @param string[] $post_types WP_Post post type names.
*/
return apply_filters( 'llms_completable_post_types', array( 'course', 'section', 'lesson' ) );
}
/**
* Retrieve an array of taxonomies which can be completed by students
*
* @since 4.2.0
*
* @return string[]
*/
function llms_get_completable_taxonomies() {
/**
* Filter the list of taxonomies which can be completed by students.
*
* @since 4.2.0
*
* @param string[] $taxonomies Taxonomy names.
*/
return apply_filters( 'llms_completable_taxonomies', array( 'course_track' ) );
}
/**
* Retrieve an array of post types whose name doesn't start with the prefix 'llms_'.
*
* @since 4.10.1
*
* @return string[]
*/
function llms_get_unprefixed_post_types() {
/**
* Filter the list of post types whose name doesn't start with the prefix 'llms_'.
*
* @since 4.10.1
*
* @param string[] $post_types WP_Post post type names.
*/
return apply_filters( 'llms_unprefixed_post_types', array( 'course', 'section', 'lesson' ) );
}
/**
* Get themes natively supported by LifterLMS
*
* @since 3.0.0
*
* @return array
*/
function llms_get_core_supported_themes() {
return array(
'canvas',
'Divi',
'genesis',
'twentyseventeen',
'twentysixteen',
'twentyfifteen',
'twentyfourteen',
'twentythirteen',
'twentyeleven',
'twentytwelve',
'twentyten',
);
}
/**
* Get human readable time difference between 2 dates
*
* Return difference between 2 dates in year, month, hour, minute or second
* The $precision caps the number of time units used: for instance if
* $time1 - $time2 = 3 days, 4 hours, 12 minutes, 5 seconds
* - with precision = 1 : 3 days
* - with precision = 2 : 3 days, 4 hours
* - with precision = 3 : 3 days, 4 hours, 12 minutes.
*
* @since Unknown
* @since 3.24.0 Unknown.
*
* @source http://www.if-not-true-then-false.com/2010/php-calculate-real-differences-between-two-dates-or-timestamps/
*
* @param mixed $time1 A time (string or timestamp).
* @param mixed $time2 A time (string or timestamp).
* @param integer $precision Optional precision. Default is 2.
* @return string time difference
*/
function llms_get_date_diff( $time1, $time2, $precision = 2 ) {
// If not numeric then convert timestamps.
if ( ! is_numeric( $time1 ) ) {
$time1 = strtotime( $time1 );
}
if ( ! is_numeric( $time2 ) ) {
$time2 = strtotime( $time2 );
}
// If time1 > time2 then swap the 2 values.
if ( $time1 > $time2 ) {
list( $time1, $time2 ) = array( $time2, $time1 );
}
// Set up intervals and diffs arrays.
$intervals = array( 'year', 'month', 'day', 'hour', 'minute', 'second' );
$l18n_singular = array(
'year' => __( 'year', 'lifterlms' ),
'month' => __( 'month', 'lifterlms' ),
'day' => __( 'day', 'lifterlms' ),
'hour' => __( 'hour', 'lifterlms' ),
'minute' => __( 'minute', 'lifterlms' ),
'second' => __( 'second', 'lifterlms' ),
);
$l18n_plural = array(
'year' => __( 'years', 'lifterlms' ),
'month' => __( 'months', 'lifterlms' ),
'day' => __( 'days', 'lifterlms' ),
'hour' => __( 'hours', 'lifterlms' ),
'minute' => __( 'minutes', 'lifterlms' ),
'second' => __( 'seconds', 'lifterlms' ),
);
$diffs = array();
foreach ( $intervals as $interval ) {
// Create temp time from time1 and interval.
$ttime = strtotime( '+1 ' . $interval, $time1 );
// Set initial values.
$add = 1;
$looped = 0;
// Loop until temp time is smaller than time2.
while ( $time2 >= $ttime ) {
// Create new temp time from time1 and interval.
++$add;
$ttime = strtotime( '+' . $add . ' ' . $interval, $time1 );
++$looped;
}
$time1 = strtotime( '+' . $looped . ' ' . $interval, $time1 );
$diffs[ $interval ] = $looped;
}
$count = 0;
$times = array();
foreach ( $diffs as $interval => $value ) {
// Break if we have needed precision.
if ( $count >= $precision ) {
break;
}
// Add value and interval if value is bigger than 0.
if ( $value > 0 ) {
if ( 1 != $value ) {
$text = $l18n_plural[ $interval ];
} else {
$text = $l18n_singular[ $interval ];
}
// Add value and interval to times array.
$times[] = $value . ' ' . $text;
++$count;
}
}
// Return string with times.
return implode( ', ', $times );
}
/**
* Instantiate an instance of DOMDocument with an HTML string
*
* This function suppresses PHP warnings that would be thrown by DOMDocument when
* loading a partial string or an HTML string with errors.
*
* @see LLMS_DOM_Document->load().
*
* @since 4.7.0
* @since 4.8.0 Remove reliance on `mb_convert_encoding()`.
* @since 4.13.0 Add back partial reliance on `mb_convert_encoding()` but keep the previous implementation as a fall-back.
* Also fix a potential fatal in the fall-back which tried to manipulate a non existent node.
* Wrapper for `LLMS_Dom_Document:load()`.
*
* @param string $string An HTML string, either a full HTML document or a partial string.
* @return DOMDocument|WP_Error Returns an instance of DOMDocument with `$string` loaded into it
* or an error object when DOMDocument isn't available or an error is encountered during loading.
*/
function llms_get_dom_document( $string ) {
$llms_dom = new LLMS_DOM_Document( $string );
$load = $llms_dom->load();
return is_wp_error( $load ) ? $load : $llms_dom->dom();
}
/**
* Retrieve the HTML for a donut chart
*
* Note that this must be used in conjunction with some JS to initialize the chart!
*
* @since 3.9.0
* @since 3.24.0 Unknown.
*
* @param mixed $percentage Percentage to display
* @param string $text Optional. Text/caption to display (short). Default is empty string.
* @param string $size Optional. Size of the chart (mini, small, default, large). Default is 'default'.
* @param array $classes Optional. Additional custom css classes to add to the chart element. Default is empty array.
* @return string
*/
function llms_get_donut( $percentage, $text = '', $size = 'default', $classes = array() ) {
$percentage = is_numeric( $percentage ) ? $percentage : 0;
$classes = array_merge( array( 'llms-donut', $size ), $classes );
$classes = implode( ' ', $classes );
$percentage = 'mini' === $size ? round( $percentage, 0 ) : llms()->grades()->round( $percentage );
return '
<div class="' . esc_attr( $classes ) . '" data-perc="' . esc_attr( $percentage ) . '">
<div class="inside">
<div class="percentage">
' . esc_html( $percentage ) . '<small>%</small>
<div class="caption">' . esc_html( $text ) . '</div>
</div>
</div>
</div>';
}
/**
* Get a list of registered engagement triggers
*
* @return array
* @since 3.1.0
* @since 3.24.1
*/
function llms_get_engagement_triggers() {
/**
* Filter the engagement triggers
*
* @since Unknown
*
* @param array $engagement_triggers An associative array of engagement triggers. Keys are the engagement trigger slugs, values are their description.
*/
return apply_filters(
'lifterlms_engagement_triggers',
array(
'user_registration' => __( 'Student creates a new account', 'lifterlms' ),
'access_plan_purchased' => __( 'Student Purchases an Access Plan', 'lifterlms' ),
'course_enrollment' => __( 'Student enrolls in a course', 'lifterlms' ),
'course_purchased' => __( 'Student purchases a course', 'lifterlms' ),
'course_completed' => __( 'Student completes a course', 'lifterlms' ),
// 'days_since_login' => __( 'Days since user last logged in', 'lifterlms' ), // @todo.
'lesson_completed' => __( 'Student completes a lesson', 'lifterlms' ),
'quiz_completed' => __( 'Student completes a quiz', 'lifterlms' ),
'quiz_passed' => __( 'Student passes a quiz', 'lifterlms' ),
'quiz_failed' => __( 'Student fails a quiz', 'lifterlms' ),
'section_completed' => __( 'Student completes a section', 'lifterlms' ),
'course_track_completed' => __( 'Student completes a course track', 'lifterlms' ),
'membership_enrollment' => __( 'Student enrolls in a membership', 'lifterlms' ),
'membership_purchased' => __( 'Student purchases a membership', 'lifterlms' ),
)
);
}
/**
* Verify if the current user can edit the given product id (course or membership).
*
* @param $product_id
* @since 8.0.2
*
* @return bool
*/
function llms_current_user_can_edit_product( $product_id ) {
return current_user_can( 'edit_course', $product_id ) || current_user_can( 'edit_membership', $product_id );
}
/**
* Get a list of registered engagement types
*
* @return array
* @since 3.1.0
* @version 3.24.0
*/
function llms_get_engagement_types() {
/**
* Filter the engagement types
*
* @since Unknown
*
* @param array $engagement_types An associative array of engagement types. Keys are the engagement type slugs, values are their description.
*/
return apply_filters(
'lifterlms_engagement_types',
array(
'achievement' => __( 'Award an Achievement', 'lifterlms' ),
'certificate' => __( 'Award a Certificate', 'lifterlms' ),
'email' => __( 'Send an Email', 'lifterlms' ),
)
);
}
/**
* Retrieve a list of post types which users can be enrolled into.
*
* @since 4.4.1
*
* @return string[] A list of post type names.
*/
function llms_get_enrollable_post_types() {
/**
* Customize the post types which users can be enrolled into.
*
* This filter differs slightly from `llms_user_enrollment_status_allowed_post_types`. This filter
* determines which post types a user can be physically associated with through enrollment while
* `llms_user_enrollment_status_allowed_post_types` allows checking of user enrollment based on
* posts which are associated with a post type.
*
* @since 3.37.9
*
* @see llms_user_enrollment_status_allowed_post_types
*
* @param string[] $post_types Array of post type names.
*/
return apply_filters( 'llms_user_enrollment_allowed_post_types', array( 'course', 'llms_membership' ) );
}
/**
* Retrieve a list of post types that can be used to check a users enrollment status in an enroll-able post type.
*
* @since 4.4.1
*
* @return string[] A list of post type names.
*/
function llms_get_enrollable_status_check_post_types() {
/**
* Customize the post types that can be used to check a user's enrollment status.
*
* This filter differs slightly from `llms_user_enrollment_allowed_post_types`. The difference is that
* a user can be enrolled into a course but we can check their course enrollment status using the ID of a child (section or lesson).
*
* When adding a new post type for custom enrollment functionality the post type should be registered with
* both of these filters.
*
* @since 3.37.9
*
* @see llms_user_enrollment_allowed_post_types
*
* @param string[] $post_types List of allowed post types names.
*/
return apply_filters( 'llms_user_enrollment_status_allowed_post_types', array( 'course', 'section', 'lesson', 'llms_membership' ) );
}
/**
* Retrieve an HTML anchor for an option page
*
* @since 3.18.0
*
* @param string $option_name Option name.
* @param string $target Optional. HTML target attribute. Defaults to _blank.
* @return string
*/
function llms_get_option_page_anchor( $option_name, $target = '_blank' ) {
$page_id = get_option( $option_name );
if ( ! $page_id ) {
return '';
}
$target = $target ? ' target="' . esc_attr( $target ) . '"' : '';
return sprintf(
'<a href="%1$s"%2$s>%3$s</a>',
get_the_permalink( $page_id ),
$target,
get_the_title( $page_id )
);
}
/**
* Get a list of available product (course & membership) catalog visibility options
*
* @since 3.6.0
*
* @return array
*/
function llms_get_product_visibility_options() {
/**
* Filter the product visibility options
*
* @since 3.6.0
*
* @param array $product_visibility_options. An associative array representing of visibility options. Keys are the engagement type slugs, values are their description.
*/
return apply_filters(
'lifterlms_product_visibility_options',
array(
'catalog_search' => __( 'Catalog & Search', 'lifterlms' ),
'catalog' => __( 'Catalog only', 'lifterlms' ),
'search' => __( 'Search only', 'lifterlms' ),
'hidden' => __( 'Hidden', 'lifterlms' ),
)
);
}
/**
* Get an array of student IDs based on enrollment status a course or membership
*
* @since 3.0.0
* @since 3.8.0 Unknown.
* @since 4.10.2 Instantiate the student query passing `no_found_rows` arg as `true`,
* as we don't need (and do not return) pagination info, e.g. max_pages.
* @since 6.0.0 Don't access `LLMS_Student_Query` properties directly.
*
* @param int $post_id WP_Post id of a course or membership.
* @param string|array $statuses List of enrollment statuses to query by status query is an OR relationship. Default is 'enrolled'.
* @param integer $limit Number of results.
* @param integer $skip Number of results to skip (for pagination).
* @return array
*/
function llms_get_enrolled_students( $post_id, $statuses = 'enrolled', $limit = 50, $skip = 0 ) {
$query = new LLMS_Student_Query(
array(
'post_id' => $post_id,
'statuses' => $statuses,
'page' => ( 0 === $skip ) ? 1 : ( $skip / $limit ) + 1,
'per_page' => $limit,
'sort' => array(
'id' => 'ASC',
),
'no_found_rows' => true,
)
);
if ( $query->has_results() ) {
return wp_list_pluck( $query->get_results(), 'id' );
}
return array();
}
/**
* Retrieve default instructor data structure.
*
* @since 3.25.0
*
* @return array
*/
function llms_get_instructors_defaults() {
/**
* Filter the instructor's default data structure.
*
* @since 3.25.0
*
* @param array $product_visibility_options. An associative array representing the instructor's default data structure.
*/
return apply_filters(
'llms_post_instructors_get_defaults',
array(
'label' => __( 'Author', 'lifterlms' ),
'visibility' => 'visible',
'id' => '',
)
);
}
/**
* Function used to sanitize user input in a manner similar to the (deprecated) FILTER_SANITIZE_STRING.
*
* This function retrieves the raw user input via `llms_filter_input()` using the FILTER_UNSAFE_RAW filter, strips
* all tags, and then encodes single and double quotes with the relevant HTML entity codes.
*
* In many cases, the usage of `FILTER_SANITIZE_STRING` can be easily replaced with `FILTER_SANITIZE_FULL_SPECIAL_CHARS` but
* in some cases, especially when storing the user input, encoding all special characters can result in an stored XSS injection
* so this function can be used to preserve the pre PHP 8.1 behavior where sanitization is expected during the retrieval
* of user input.
*
* @since 5.9.0
*
* @param int $type One of INPUT_GET, INPUT_POST, INPUT_COOKIE, INPUT_SERVER, or INPUT_ENV.
* @param string $variable_name Name of a variable to retrieve.
* @param int[] $flags Array of supported filter options and flags.
* Accepts `FILTER_REQUIRE_ARRAY` in order to require the input to be an array.
* Accepts `FILTER_FLAG_NO_ENCODE_QUOTES` to prevent encoding of quotes.
* @return string|string[]|null|boolean Value of the requested variable on success, `false` if the filter fails, or `null` if the `$variable_name` variable is not set.
*/
function llms_filter_input_sanitize_string( $type, $variable_name, $flags = array() ) {
$require_array = in_array( FILTER_REQUIRE_ARRAY, $flags, true );
$string = llms_filter_input( $type, $variable_name, FILTER_UNSAFE_RAW, $require_array ? FILTER_REQUIRE_ARRAY : array() );
// If we have an empty string or the input var isn't found we can return early.
if ( empty( $string ) ) {
return $string;
}
$string = $require_array ? array_map( 'wp_strip_all_tags', $string ) : wp_strip_all_tags( $string );
if ( ! in_array( FILTER_FLAG_NO_ENCODE_QUOTES, $flags, true ) ) {
$string = str_replace(
array( "'", '"' ),
array( ''', '"' ),
$string
);
}
return $string;
}
/**
* Get the most recently created coupon ID for a given code
*
* @param string $code Optional. The coupon's code (title). Default is empty string.
* @param int $dupcheck_id Optional. Coupon id that can be passed which will be excluded during the query
* this is used to dupcheck the coupon code during coupon creation. Default is 0.
* @return int
* @since 3.0.0
* @version 3.0.0
*/
function llms_find_coupon( $code = '', $dupcheck_id = 0 ) {
global $wpdb;
return $wpdb->get_var(
$wpdb->prepare(
"SELECT ID
FROM {$wpdb->posts}
WHERE post_title = %s
AND post_type = 'llms_coupon'
AND post_status = 'publish'
AND ID != %d
ORDER BY ID desc;
",
array( $code, $dupcheck_id )
)
); // no-cache ok.
}
/**
* Get a list of available course / membership enrollment statuses
*
* @since 3.0.0
*
* @return array
*/
function llms_get_enrollment_statuses() {
/**
* Filter the enrollment statuses
*
* @since 3.0.0
*
* @param array $enrollment_statuses An associative array representing the enrollment statuses. Keys are the statuses, values are their human readable labels (names).
*/
return apply_filters(
'llms_get_enrollment_statuses',
array(
'cancelled' => __( 'Cancelled', 'lifterlms' ),
'enrolled' => __( 'Enrolled', 'lifterlms' ),
'expired' => __( 'Expired', 'lifterlms' ),
)
);
}
/**
* Get the human readable (and translated) name of an enrollment status
*
* @since 3.0.0
* @since 3.6.0 Unknown.
*
* @param string $status Enrollment status key.
* @return string
*/
function llms_get_enrollment_status_name( $status ) {
$status = strtolower( $status ); // Backwards compatibility.
$statuses = llms_get_enrollment_statuses();
if ( is_array( $statuses ) && isset( $statuses[ $status ] ) ) {
$status = $statuses[ $status ];
}
/**
* Filter the enrollment status name
*
* @since Unknown
*
* @param array $enrollment_status The enrollment status name.
*/
return apply_filters( 'lifterlms_get_enrollment_status_name', $status );
}
/**
* Retrieve an IP Address for the current user
*
* @since 3.0.0
* @since 3.35.0 Sanitize superglobal input.
*
* @return string
*/
function llms_get_ip_address() {
$ip = '';
// phpcs:disable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized -- Look below you.
// phpcs:disable WordPress.Security.ValidatedSanitizedInput.MissingUnslash -- Look below you.
if ( isset( $_SERVER['HTTP_X_REAL_IP'] ) ) {
$ip = $_SERVER['HTTP_X_REAL_IP'];
} elseif ( isset( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
// Proxy servers can send through this header like this: X-Forwarded-For: client1, proxy1, proxy2.
// Make sure we always only send through the first IP in the list which should always be the client IP.
$ip = trim( current( explode( ',', $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) );
} elseif ( isset( $_SERVER['REMOTE_ADDR'] ) ) {
$ip = $_SERVER['REMOTE_ADDR'];
}
// phpcs:enable WordPress.Security.ValidatedSanitizedInput.InputNotSanitized
// phpcs:enable WordPress.Security.ValidatedSanitizedInput.MissingUnslash
$ip = sanitize_text_field( wp_unslash( $ip ) );
if ( ! filter_var( $ip, FILTER_VALIDATE_IP ) ) {
return '';
}
return $ip;
}
/**
* Retrieves and filters the value open registration option
*
* @since 5.0.0
*
* @return string The value of the open registration status. Either "yes" for enabled or "no" for disabled.
*/
function llms_get_open_registration_status() {
$status = get_option( 'lifterlms_enable_myaccount_registration', 'no' );
/**
* Filter the value of the open registration setting
*
* @since 3.37.10
*
* @param string $status The current value of the open registration option. Either "yes" for enabled or "no" for disabled.
*/
return apply_filters( 'llms_enable_open_registration', $status );
}
/**
* Retrieve the LLMS Post Model for a give post by ID or WP_Post Object
*
* @since 3.3.0
* @since 3.16.11 Unknown.
* @since 4.10.1 Made sure to only instantiate LifterLMS classes.
*
* @param WP_Post|int $post Instance of WP_Post or a WP Post ID.
* @param mixed $error Determine what to return if the LLMS class isn't found.
* post = WP_Post
* falsy = false.
* @return LLMS_Post_Model|WP_Post|null|false LLMS_Post_Model extended object,
* null if WP get_post() fails,
* WP_Post if LLMS_Post_Model extended class isn't found and $error = 'post'
* false if LLMS_Post_Model extended class isn't found and $error != 'post'.
*/
function llms_get_post( $post, $error = false ) {
$post = get_post( $post );
if ( ! $post ) {
return $post;
}
$class = '';
// Check whether it's an llms post candidate: `post_type` starts with the 'llms_' prefix, or is one of the unprefixed ones.
if ( 0 === strpos( $post->post_type, 'llms_' ) || in_array( $post->post_type, llms_get_unprefixed_post_types(), true ) ) {
$post_type = explode( '_', str_replace( 'llms_', '', $post->post_type ) );
$class = 'LLMS';
foreach ( $post_type as $part ) {
$class .= '_' . ucfirst( $part );
}
}
if ( $class && class_exists( $class ) ) {
return new $class( $post );
} elseif ( 'post' === $error ) {
return $post;
}
return false;
}
/**
* Retrieve the parent course for a section, lesson, or quiz
*
* @since 3.6.0
* @since 3.17.7 Unknown.
* @since 3.37.14 Bail if `$post` is not an istance of `LLMS_Post_Model`.
* Use strict comparison.
*
* @param WP_Post|int $post WP Post ID or instance of WP_Post.
* @return LLMS_Course|null Instance of the LLMS_Course or null.
*/
function llms_get_post_parent_course( $post ) {
$post = llms_get_post( $post );
if ( ! $post || ! is_a( $post, 'LLMS_Post_Model' ) ) {
return null;
}
/**
* Filter the course children post types
*
* @since Unknown
*
* @param $post_type string[] Names of the post types that can be children of a course.
*/
$post_types = apply_filters( 'llms_course_children_post_types', array( 'section', 'lesson', 'llms_quiz' ) );
if ( ! in_array( $post->get( 'type' ), $post_types, true ) ) {
return null;
}
/** @var LLMS_Section|LLMS_Lesson|LLMS_Quiz $post */
return $post->get_course();
}
/**
* Retrieve an array of existing transaction statuses
*
* @since 3.0.0
*
* @return array
*/
function llms_get_transaction_statuses() {
/**
* Filter the transaction statuses
*
* @since Unknown
*
* @param $statuses string[] Names of the possible transaction statuses.
*/
return apply_filters(
'llms_get_transaction_statuses',
array(
'llms-txn-failed',
'llms-txn-pending',
'llms-txn-refunded',
'llms-txn-succeeded',
)
);
}
/**
* Determine is request is an ajax request
*
* @since 3.0.1
* @since 4.0.0 Use WP core `wp_doing_ajax()`.
*
* @return bool
*/
function llms_is_ajax() {
return wp_doing_ajax();
}
/**
* Determine if request is a REST request
*
* @since 3.27.0
*
* @return bool
*/
function llms_is_rest() {
/**
* Filters whether the current request is a REST request.
*
* @since 5.4.0
*
* @param $is_rest Whether the current request is a REST request.
*/
return apply_filters( 'llms_is_rest', ( defined( 'REST_REQUEST' ) && REST_REQUEST ) );
}
/**
* Determine whether the current theme is a block theme.
*
* Just a wrapper for WordPress core `wp_is_block_theme()` so to filter for testing purposes.
*
* @since 6.0.0
*
* @return string
*/
function llms_is_block_theme() {
/**
* Filters whether the current theme is a block theme.
*
* @since 6.0.0
*
* @param $is_block_theme Whether the current theme is a block theme.
*/
return apply_filters( 'llms_is_block_theme', function_exists( 'wp_is_block_theme' ) && wp_is_block_theme() );
}
/**
* Checks if the current admin page is the block editor.
*
* @since 7.2.0
*
* @return bool
*/
function llms_is_block_editor(): bool {
if ( function_exists( 'is_gutenberg_page' ) && is_gutenberg_page() ) {
return true;
}
$current_screen = get_current_screen();
if ( method_exists( $current_screen, 'is_block_editor' ) && $current_screen->is_block_editor() ) {
return true;
}
return false;
}
/**
* Determine if the current request is a block rendering request in the editor.
*
* @since 7.2.0
*
* @return bool
*/
function llms_is_editor_block_rendering() {
if ( ! defined( 'REST_REQUEST' ) || ! is_user_logged_in() ) {
return false;
}
global $wp;
if ( ! $wp instanceof WP || empty( $wp->query_vars['rest_route'] ) ) {
return false;
}
$route = $wp->query_vars['rest_route'];
return false !== strpos( $route, '/block-renderer/' );
}
/**
* Check if the home URL is https. If it is, we don't need to do things such as 'force ssl'.
*
* @thanks woocommerce <3.
*
* @since 3.0.0
*
* @return bool
*/
function llms_is_site_https() {
return false !== strstr( get_option( 'home' ), 'https:' );
}
/**
* Create an array that can be passed to metabox select elements configured as an llms-select2-post query-ier
*
* @since 3.0.0
* @since 3.6.0 Unknown
*
* @param array $post_ids Optional. Indexed array of WordPress Post IDs. Defayult is empty array.
* @param string $template Optional. A template to customize the way the results look. Default is empty string.
* {title} and {id} can be passed into the template
* and will be replaced with the post title and post id respectively.
* @return array
*/
function llms_make_select2_post_array( $post_ids = array(), $template = '' ) {
if ( ! $template ) {
$template = '{title} (' . __( 'ID#', 'lifterlms' ) . ' {id})';
}
if ( ! is_array( $post_ids ) ) {
$post_ids = array( $post_ids );
}
$ret = array();
foreach ( $post_ids as $id ) {
$title = str_replace( array( '{title}', '{id}' ), array( get_the_title( $id ), $id ), $template );
$ret[] = array(
'key' => $id,
'title' => $title,
);
}
/**
* Filter the select2 post array
*
* @since Unknown
*
* @param array Associative array of representing select2 post elements.
* @param array $post_ids Optional. Indexed array of WordPress Post IDs.
*/
return apply_filters( 'llms_make_select2_post_array', $ret, $post_ids );
}
/**
* Create an array that can be passed to metabox select elements configured as an llms-select2-student query-ier.
*
* @since 3.10.1
* @version 3.23.0
*
* @param array $user_ids Optional. Indexed array of WordPress User IDs. Default is empty array.
* @param string $template Optional. A template to customize the way the results look. Default is empty string.
* %1$s = student name
* %2$s = student email.
* @return array
*/
function llms_make_select2_student_array( $user_ids = array(), $template = '' ) {
if ( ! $template ) {
$template = '%1$s <%2$s>';
}
if ( ! is_array( $user_ids ) ) {
$user_ids = array( $user_ids );
}
$ret = array();
foreach ( $user_ids as $id ) {
$student = llms_get_student( $id );
if ( ! $student ) {
continue;
}
$ret[] = array(
'key' => $id,
'title' => sprintf( $template, $student->get_name(), $student->get( 'user_email' ) ),
);
}
/**
* Filter the select2 student array
*
* @since Unknown
*
* @param array $elements Associative array representing select2 student elements.
* @param array $post_ids Optional. Indexed array of WordPress Post IDs.
*/
return apply_filters( 'llms_make_select2_student_array', $ret, $user_ids );
}
/**
* Define a constant if it's not already defined
*
* @since 3.15.0
*
* @param string $name Constant name.
* @param mixed $value Constant values.
* @return void
*/
function llms_maybe_define_constant( $name, $value ) {
if ( ! defined( $name ) ) {
define( $name, $value );
}
}
/**
* Parse booleans
*
* Mostly used to parse yes/no bools stored in various meta data fields
*
* @since 3.16.0
*
* @param mixed $val Value to parse.
* @return bool
*/
function llms_parse_bool( $val ) {
return filter_var( $val, FILTER_VALIDATE_BOOLEAN );
}
/**
* Convert a PHP error constant to a human readable error code
*
* @since 4.9.0
*
* @link https://www.php.net/manual/en/errorfunc.constants.php
*
* @param int $code A predefined php error constant.
* @return string A human readable string version of the constant.
*/
function llms_php_error_constant_to_code( $code ) {
$codes = array(
E_ERROR => 'E_ERROR', // 1.
E_WARNING => 'E_WARNING', // 2.
E_PARSE => 'E_PARSE', // 4.
E_NOTICE => 'E_NOTICE', // 8.
E_CORE_ERROR => 'E_CORE_ERROR', // 16.
E_CORE_WARNING => 'E_CORE_WARNING', // 32.
E_COMPILE_ERROR => 'E_COMPILE_ERROR', // 64.
E_COMPILE_WARNING => 'E_COMPILE_WARNING', // 128.
E_USER_ERROR => 'E_USER_ERROR', // 256.
E_USER_WARNING => 'E_USER_WARNING', // 512.
E_USER_NOTICE => 'E_USER_NOTICE', // 1024.
E_STRICT => 'E_STRICT', // 2048.
E_RECOVERABLE_ERROR => 'E_RECOVERABLE_ERROR', // 4096.
E_DEPRECATED => 'E_DEPRECATED', // 8192.
E_USER_DEPRECATED => 'E_USER_DEPRECATED', // 16384.
);
return isset( $codes[ $code ] ) ? $codes[ $code ] : $code;
}
/**
* Wrapper for set_time_limit to ensure it's enabled before calling
*
* @since 3.16.5
*
* @source thanks WooCommerce <3
*
* @param int $limit Optional. Script time limit. Default is 0 = no time limit.
* @return void
*/
function llms_set_time_limit( $limit = 0 ) {
if ( function_exists( 'set_time_limit' ) && false === strpos( ini_get( 'disable_functions' ), 'set_time_limit' ) && ! ini_get( 'safe_mode' ) ) {
@set_time_limit( $limit ); // @phpcs:ignore
}
}
/**
* Strips a list of prefixes from the start of a string.
*
* By default, strips `llms_`, `lifterlms_`, 'llms-', or 'lifterlms-'. Other prefixes may be provided.
*
* Will strip only the first prefix found from the list of supplied prefixes.
*
* @since 6.0.0
* @since 7.0.0 Added `llms-` and `lifterlms-` as additional default prefixes to strip.
*
* @param string $string String to modify.
* @param string[] $prefixes List of prefixs.
* @return string The modified string. If no prefixes were found, the original string is returned without modification.
*/
function llms_strip_prefixes( $string, $prefixes = array() ) {
$prefixes = empty( $prefixes ) ? array( 'llms_', 'lifterlms_', 'llms-', 'lifterlms-' ) : $prefixes;
foreach ( $prefixes as $prefix ) {
if ( 0 === strpos( $string, $prefix ) ) {
$string = substr( $string, strlen( $prefix ) );
/**
* Most of the time we'll be using this to replace `llms_` as we don't often use `lifterlms_` for
* prefixing (anymore).
*
* Also, while it's probably not ever in use, this will prevent double-stripping if, for example,
* the string was `llms_lifterlms_something`. If we did want to strip that, the `$prefixes` should
* be overwritten to have both these items stripped.
*
* So once we find a prefix, we'll break the loop and return the string with the stripped prefix.
*/
break;
}
}
return $string;
}
/**
* Trim a string and append a suffix
*
* @since 3.0.0
*
* @source thank you WooCommerce <3
*
* @param string $string Input string.
* @param int $chars Optional. Max number of characters. Default is 200.
* @param string $suffix Optional. A suffix to append. Default is '...'.
* @return string
*/
function llms_trim_string( $string, $chars = 200, $suffix = '...' ) {
if ( strlen( $string ) > $chars ) {
if ( function_exists( 'mb_substr' ) ) {
$string = mb_substr( $string, 0, ( $chars - mb_strlen( $suffix ) ) ) . $suffix;
} else {
$string = substr( $string, 0, ( $chars - strlen( $suffix ) ) ) . $suffix;
}
}
return $string;
}
/**
* Verify nonce with additional checks to confirm request method
*
* Skips verification if the nonce is not set
* Useful for checking nonce for various LifterLMS forms which check for the form submission on init actions.
*
* @since 3.8.0
* @since 3.35.0 Sanitize nonce field before verification.
* @deprecated 10.0.0 Use `isset()` and `wp_verify_nonce()` directly.
*
* @param string $nonce Name of the nonce field.
* @param string $action Name of the action.
* @param string $request_method Optional. Name of the intended request method. Default is 'POST'.
* @return null|false|int
*/
function llms_verify_nonce( $nonce, $action, $request_method = 'POST' ) {
_deprecated_function( __FUNCTION__, '10.0.0', 'isset() and wp_verify_nonce()' );
/**
* Filter whether to use $_SERVER instead of getenv when fetching an environment variable.
*
* @since 9.0.0
*/
$server_request_method = apply_filters( 'llms_use_server_for_environment_fetch', false, $nonce, $action, $request_method ) ?
$_SERVER['REQUEST_METHOD'] :
getenv( 'REQUEST_METHOD' );
if ( strtoupper( $server_request_method ) !== $request_method ) {
return;
}
if ( empty( $_REQUEST[ $nonce ] ) ) {
return;
}
return wp_verify_nonce( sanitize_text_field( wp_unslash( $_REQUEST[ $nonce ] ) ), $action );
}
/**
* Check that the test value is a member of a specific array for sanitization purposes.
*
* @param mixed $needle Value to be tested.
* @param array $safelist Array of safelist values.
* @param mixed $default Default value to return if the needle is not in the safelist. Defaults to the first value in the safelist array if not provided.
* @since 7.6.0
*/
function llms_sanitize_with_safelist( $needle, $safelist, $default = null ) {
if ( ! in_array( $needle, $safelist ) ) {
if ( isset( $default ) ) {
return $default;
} else {
return $safelist[0];
}
} else {
return $needle;
}
}
================================================
FILE: includes/llms.spam.functions.php
================================================
<?php
defined( 'ABSPATH' ) || exit;
/**
* Code related to spam detection and prevention.
*/
// Constants. Define these in wp-config.php to override.
if ( ! defined( 'LLMS_SPAM_ACTION_NUM_LIMIT' ) ) {
define( 'LLMS_SPAM_ACTION_NUM_LIMIT', 10 );
}
if ( ! defined( 'LLMS_SPAM_ACTION_TIME_LIMIT' ) ) {
define( 'LLMS_SPAM_ACTION_TIME_LIMIT', 900 ); // in seconds
}
/**
* Determine whether the current visitor a spammer.
*
* @since 9.0.0
*
* @return bool Whether the current visitor a spammer.
*/
function llms_is_spammer() {
$is_spammer = false;
$activity = llms_get_spam_activity();
if ( false !== $activity && count( $activity ) >= LLMS_SPAM_ACTION_NUM_LIMIT ) {
$is_spammer = true;
}
/**
* Allow filtering whether the current visitor is a spammer.
*
* @since 9.0.0
*
* @param bool $is_spammer Whether the current visitor is a spammer.
* @param array $activity The list of potential spam activity.
*/
return apply_filters( 'llms_is_spammer', $is_spammer, $activity );
}
/**
* Get the list of potential spam activity.
*
* @since 9.0.0
*
* @param string|null $ip The IP address to get activity for, or leave as null to attempt to determine current IP address.
*
* @return array|false The list of potential spam activity if successful, or false if IP could not be determined.
*/
function llms_get_spam_activity( $ip = null ) {
if ( empty( $ip ) ) {
$ip = llms_get_ip_address();
}
// If we can't determine the IP, let's bail.
if ( empty( $ip ) ) {
return false;
}
$ip = preg_replace( '/[^0-9a-fA-F:., ]/', '', $ip );
$transient_key = 'llms_spam_activity_' . $ip;
$activity = get_transient( $transient_key );
if ( empty( $activity ) || ! is_array( $activity ) ) {
$activity = array();
}
// Remove old items.
$new_activity = array();
$now = time(); // UTC
foreach ( $activity as $item ) {
// Determine whether this item is recent enough to include.
if ( $item > $now - ( absint( LLMS_SPAM_ACTION_TIME_LIMIT ) ) ) {
$new_activity[] = $item;
}
}
return $new_activity;
}
/**
* Track spam activity.
* When we hit a certain number, the spam flag will trigger.
* For now we are only tracking credit card declines their timestamps.
* IP address isn't a perfect way to track this, but it's the best we have.
*
* @since 9.0.0
*
* @param string|null $ip The IP address to track activity for, or leave as null to attempt to determine current IP address.
*
* @return bool True if the tracking of activity was successful, or false if IP could not be determined.
*/
function llms_track_spam_activity( $ip = null ) {
if ( empty( $ip ) ) {
$ip = llms_get_ip_address();
}
// If we can't determine the IP, let's bail.
if ( empty( $ip ) ) {
return false;
}
$activity = llms_get_spam_activity( $ip );
$now = time(); // UTC
array_unshift( $activity, $now );
// If we have more than the limit, don't bother storing them.
if ( count( $activity ) > absint( LLMS_SPAM_ACTION_NUM_LIMIT ) ) {
rsort( $activity );
$activity = array_slice( $activity, 0, absint( LLMS_SPAM_ACTION_NUM_LIMIT ) );
}
// Save to transient.
$ip = preg_replace( '/[^0-9a-fA-F:., ]/', '', $ip );
$transient_key = 'llms_spam_activity_' . $ip;
set_transient( $transient_key, $activity, (int) absint( LLMS_SPAM_ACTION_TIME_LIMIT ) );
return true;
}
/**
* Clears all stored spam activity for an IP address.
* Note that the llms_get_spam_activity function clears out old values
* automatically, and this should only be used to completely clear the activity.
*
* @since 9.0.0
*
* @param string|null $ip The IP address to clear activity for, or leave as null to attempt to determine current IP address.
*
* @return bool True if the clearing of activity was successful, or false if IP could not be determined.
*/
function llms_clear_spam_activity( $ip = null ) {
if ( empty( $ip ) ) {
$ip = llms_get_ip_address();
}
// If we can't determine the IP, let's bail.
if ( empty( $ip ) ) {
return false;
}
$transient_key = 'llms_spam_activity_' . $ip;
delete_transient( $transient_key );
return true;
}
/**
* Track spam activity when checkouts or billing updates fail.
* Hooked on wp so the $post global is set up.
*
* @since 9.0.0
* @param MemberOrder $morder The order object used at checkout. We ignore it.
*/
function llms_track_failed_checkouts_for_spam() {
// Bail if Spam Protection is disabled.
if ( ! llms_is_spam_protection_enabled() ) {
return;
}
// Bail if we're not on the LifterLMS checkout page.
if ( is_admin() || ! is_llms_checkout() ) {
return;
}
// Bail if there are no notices with type error.
$notices = llms()->session->get( 'llms_notices', array() );
$types = array_keys( $notices );
if ( ! in_array( 'error', $types ) ) {
return;
}
llms_track_spam_activity();
}
/**
* Determine whether spam protection is enabled.
*
* @since 9.0.0
*
* @return bool Whether spam protection is enabled.
*/
function llms_is_spam_protection_enabled() {
return llms_parse_bool( get_option( 'lifterlms_spam_protection', 'yes' ) );
}
add_action( 'wp', 'llms_track_failed_checkouts_for_spam' );
/**
* Disable checkout and billing update forms for spammers.
*
* @since 9.0.0
*
* @return mixed Truthy means stop checkout.
*/
function llms_disable_checkout_for_spammers() {
// Bail if Spam Protection is disabled.
if ( ! llms_is_spam_protection_enabled() ) {
return false;
}
// Bail if the current visitor is not a spammer.
if ( ! llms_is_spammer() ) {
return false;
}
// Show a notice at LifterLMS checkout RE spam.
$notice = __( 'Suspicious activity detected. Try again in a few minutes.', 'lifterlms' );
llms_add_notice( $notice, 'error' );
return true;
}
add_filter( 'llms_before_checkout_validation', 'llms_disable_checkout_for_spammers' );
================================================
FILE: includes/llms.template.functions.php
================================================
<?php
/**
* Front end template functions
*
* @package LifterLMS/Functions/Templates
*
* @since 1.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
require 'functions/llms-functions-content.php';
require 'functions/llms-functions-conditional-tags.php';
require 'functions/llms-functions-templates-courses.php';
require 'functions/llms-functions-templates-memberships.php';
require 'functions/llms-functions-templates-shared.php';
require 'functions/llms-functions-template-view-order.php';
require 'functions/llms.functions.templates.achievements.php';
require 'functions/llms.functions.templates.certificates.php';
require 'functions/llms.functions.templates.dashboard.php';
require 'functions/llms.functions.templates.dashboard.widgets.php';
require 'functions/llms.functions.templates.loop.php';
require 'functions/llms.functions.templates.pricing.table.php';
require 'functions/llms.functions.templates.privacy.php';
require 'functions/llms.functions.templates.quizzes.php';
/**
* Output email body content
*
* @return void
* @since 3.8.0
* @version 3.8.0
*/
if ( ! function_exists( 'llms_email_body' ) ) {
function llms_email_body( $content = '' ) {
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
echo apply_filters( 'the_content', $content );
}
}
/**
* Output email footer template
*
* @return void
* @since 3.8.0
* @version 3.8.0
*/
if ( ! function_exists( 'llms_email_footer' ) ) {
function llms_email_footer() {
llms_get_template( 'emails/footer.php' );
}
}
/**
* Output email header template with optional heading
*
* @param string $heading optional heading text to output above the main content
* @return void
* @since 3.8.0
* @version 3.8.0
*/
if ( ! function_exists( 'llms_email_header' ) ) {
function llms_email_header( $heading = '' ) {
llms_get_template(
'emails/header.php',
array(
'email_heading' => $heading,
)
);
}
}
/**
* Template Redirect
*
* @return void
*/
function llms_template_redirect() {
global $wp_query, $wp;
// When default permalinks are enabled, redirect shop page to post type archive url.
if ( ! empty( $_GET['page_id'] ) && get_option( 'permalink_structure' ) == '' && llms_get_page_id( 'shop' ) == $_GET['page_id'] ) {
wp_safe_redirect( get_post_type_archive_link( 'course' ) );
exit;
}
// When default permalinks are enabled, redirect memberships page to post type archive url.
if ( ! empty( $_GET['page_id'] ) && get_option( 'permalink_structure' ) == '' && llms_get_page_id( 'memberships' ) == $_GET['page_id'] ) {
wp_safe_redirect( get_post_type_archive_link( 'llms_membership' ) );
exit;
}
}
add_action( 'template_redirect', 'llms_template_redirect' );
/**
* Title Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_title' ) ) {
function lifterlms_template_single_title() {
llms_get_template( 'course/title.php' );
}
}
/**
* Short Description Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_short_description' ) ) {
function lifterlms_template_single_short_description() {
llms_get_template( 'course/short-description.php' );
}
}
/**
* Course Content Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_course_content' ) ) {
function lifterlms_template_single_course_content() {
global $post;
$page_restricted = llms_page_restricted( $post->ID );
if ( $page_restricted['is_restricted'] ) {
llms_get_template( 'course/short-description.php' );
} else {
llms_get_template( 'course/full-description.php' );
}
}
}
/**
* Course Full Description Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_full_description' ) ) {
function lifterlms_template_single_full_description() {
llms_get_template( 'lesson/full-description.php' );
}
}
/**
* Membership Featured Image Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_membership_full_description' ) ) {
function lifterlms_template_single_membership_full_description() {
llms_get_template( 'membership/full-description.php' );
}
}
/**
* Add a course progress bar with a continue button
*
* @return void
* @since 3.0.1
* @version 3.0.1
*/
if ( ! function_exists( 'lifterlms_template_single_course_progress' ) ) {
function lifterlms_template_single_course_progress() {
llms_get_template( 'course/progress.php' );
}
}
/**
* Open the course meta information wrapper
*
* @since 3.0.0
* @version 3.0.0
*/
if ( ! function_exists( 'lifterlms_template_single_meta_wrapper_start' ) ) {
function lifterlms_template_single_meta_wrapper_start() {
llms_get_template( 'course/meta-wrapper-start.php' );
}
}
/**
* Close the course meta information wrapper
*
* @since 3.0.0
* @version 3.0.0
*/
if ( ! function_exists( 'lifterlms_template_single_meta_wrapper_end' ) ) {
function lifterlms_template_single_meta_wrapper_end() {
llms_get_template( 'course/meta-wrapper-end.php' );
}
}
/**
* Course Estimated Length Template
* replaced 'lifterlms_template_single_lesson_length()' which was misnamed as being related to a lesson
* when it was actually related to a course
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
if ( ! function_exists( 'lifterlms_template_single_length' ) ) {
function lifterlms_template_single_length() {
llms_get_template( 'course/length.php' );
}
}
/**
* Display a list of course categories
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
if ( ! function_exists( 'lifterlms_template_single_course_categories' ) ) {
function lifterlms_template_single_course_categories() {
llms_get_template( 'course/categories.php' );
}
}
/**
* Display a list of course tags
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
if ( ! function_exists( 'lifterlms_template_single_course_tags' ) ) {
function lifterlms_template_single_course_tags() {
llms_get_template( 'course/tags.php' );
}
}
/**
* Display a list of course tracks
*
* @return void
* @since 3.0.0
* @version 3.0.0
*/
if ( ! function_exists( 'lifterlms_template_single_course_tracks' ) ) {
function lifterlms_template_single_course_tracks() {
llms_get_template( 'course/tracks.php' );
}
}
/**
* Course Video Embed Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_video' ) ) {
function lifterlms_template_single_video() {
llms_get_template( 'course/video.php' );
}
}
/**
* Membership Video Embed Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_membership_video' ) ) {
function lifterlms_template_single_membership_video() {
llms_get_template( 'membership/video.php' );
}
}
/**
* Lesson Video Embed Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_lesson_video' ) ) {
function lifterlms_template_single_lesson_video() {
llms_get_template( 'lesson/video.php' );
}
}
/**
* Course Audio Embed Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_audio' ) ) {
function lifterlms_template_single_audio() {
llms_get_template( 'course/audio.php' );
}
}
/**
* Membership Audio Embed Template Include.
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_membership_audio' ) ) {
function lifterlms_template_single_membership_audio() {
llms_get_template( 'membership/audio.php' );
}
}
/**
* Lesson Audio Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_lesson_audio' ) ) {
function lifterlms_template_single_lesson_audio() {
llms_get_template( 'lesson/audio.php' );
}
}
/**
* Course Difficulty Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_difficulty' ) ) {
function lifterlms_template_single_difficulty() {
llms_get_template( 'course/difficulty.php' );
}
}
/**
* Course Prerequisites Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_prerequisites' ) ) {
function lifterlms_template_single_prerequisites() {
global $post;
llms_get_template(
'course/prerequisites.php',
array(
'course' => new LLMS_Course( $post ),
)
);
}
}
/**
* Course Syllabus Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_syllabus' ) ) {
function lifterlms_template_single_syllabus() {
llms_get_template( 'course/syllabus.php' );
}
}
/**
* Parent Course Link Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_parent_course' ) ) {
function lifterlms_template_single_parent_course() {
llms_get_template( 'course/parent-course.php' );
}
}
if ( ! function_exists( 'llms_template_favorite' ) ) {
/**
* Favorite Lesson Template Include.
*
* @since 7.5.0
*
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @param string $object_type The object type, currently only 'lesson'.
* @return void
*/
function llms_template_favorite( $object_id = null, $object_type = 'lesson' ) {
llms()->assets->enqueue_script( 'llms-favorites' );
llms_get_template(
'course/favorite.php',
array(
'object_id' => $object_id,
'object_type' => $object_type,
)
);
}
}
if ( ! function_exists( 'llms_template_syllabus_favorite_lesson_preview' ) ) {
/**
* Favorite Lesson Template Include when displayed in the syllabus lesson preview.
*
* @since 7.5.0
*
* @return void
*/
function llms_template_syllabus_favorite_lesson_preview( $lesson ) {
if ( 'course' === get_post_type( get_the_ID() ) ) {
llms_template_favorite( $lesson->get( 'id' ) );
}
}
}
/**
* Complete Lesson Link Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_complete_lesson_link' ) ) {
function lifterlms_template_complete_lesson_link() {
llms_get_template( 'course/complete-lesson-link.php' );
}
}
/**
* Lesson Navigation Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_lesson_navigation' ) ) {
function lifterlms_template_lesson_navigation() {
llms_get_template( 'course/lesson-navigation.php' );
}
}
/**
* Membership Title Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_template_single_membership_title' ) ) {
function lifterlms_template_single_membership_title() {
llms_get_template( 'membership/title.php' );
}
}
if ( ! function_exists( 'lifterlms_get_content' ) ) {
function lifterlms_get_content( $args ) {
llms_get_template( 'content-single-question.php', $args );
}
}
/**
* When the_post is called, put course data into a global.
*
* @param mixed $post
* @return LLMS_Course
*/
function llms_setup_course_data( $post ) {
if ( ! is_admin() ) {
if ( $post && 'course' === $post->post_type ) {
unset( $GLOBALS['course'] );
if ( is_int( $post ) ) {
$post = get_post( $post );
}
if ( empty( $post->post_type ) ) {
return;
}
$GLOBALS['course'] = new LLMS_Course( $post );
return $GLOBALS['course'];
}
}
}
add_action( 'the_post', 'llms_setup_course_data' );
/**
* When the_post is called, put lesson data into a global.
*
* @param mixed $post
* @return LLMS_Course
*/
function llms_setup_lesson_data( $post ) {
if ( ! is_admin() ) {
if ( 'lesson' == $post->post_type ) {
unset( $GLOBALS['lesson'] );
if ( is_int( $post ) ) {
$post = get_post( $post ); }
if ( empty( $post->post_type ) ) {
return; }
$courseid = get_post_meta( $post->ID, '_llms_parent_course' );
if ( isset( $courseid ) ) {
$parent_course = get_post( $courseid );
}
$GLOBALS['lesson'] = get_lesson( $post );
llms_setup_course_data( $parent_course );
return $GLOBALS['lesson'];
}
}
}
add_action( 'the_post', 'llms_setup_lesson_data' );
/**
* Returns post array of data for sections associated with a course
*
* @param array
* @return array
*/
function get_section_data( $sections ) {
global $post;
$html = '';
$args = array(
'post_type' => 'section',
'post_status' => 'publish',
'nopaging' => true,
);
$sections_query = get_posts( $args );
$array = array();
foreach ( $sections as $key => $value ) :
foreach ( $sections_query as $section ) :
if ( $value == $section->ID ) {
$array[ $section->ID ] = $section;
}
endforeach;
endforeach;
return $array;
}
/**
* Returns post array of data for lessons associated with a course
*
* @param array
* @return array
*/
function get_lesson_data( $lessons ) {
global $post;
$html = '';
$args = array(
'post_type' => 'lesson',
'post_status' => 'publish',
'nopaging' => true,
);
$lessons_query = get_posts( $args );
$array = array();
foreach ( $lessons as $key => $value ) :
foreach ( $lessons_query as $lesson ) :
if ( $value == $lesson->ID ) {
$array[ $value ] = $lesson;
}
endforeach;
endforeach;
return $array;
}
/**
* Get Page Title
*
* @param boolean $echo [echo string?]
* @return string $page_title [page title]
*/
if ( ! function_exists( 'lifterlms_page_title' ) ) {
function lifterlms_page_title( $echo = true ) {
$page_title = '';
if ( is_search() ) {
$page_title = sprintf( __( 'Search Results: “%s”', 'lifterlms' ), get_search_query() );
if ( get_query_var( 'paged' ) ) {
$page_title .= sprintf( __( ' – Page %s', 'lifterlms' ), get_query_var( 'paged' ) );
}
} elseif ( is_tax() ) {
$page_title = single_term_title( '', false );
} elseif ( is_post_type_archive( 'course' ) ) {
$page_title = get_the_title( llms_get_page_id( 'courses' ) );
} elseif ( is_post_type_archive( 'llms_membership' ) ) {
$page_title = get_the_title( llms_get_page_id( 'memberships' ) );
}
$page_title = apply_filters( 'lifterlms_page_title', $page_title );
if ( $echo ) {
echo wp_kses_post( $page_title );
} else {
return $page_title;
}
}
}
/**
* Outputs the html for a progress bar
*
* @param int $progress percent completion
* @param string $link permalink to link the button to, if false will output a span with no href
* @param bool $button output a button with the link
* @param bool $echo true will echo content, false will return it
* @return void|string
* @since 1.0.0
* @version 3.24.0
*/
if ( ! function_exists( 'lifterlms_course_progress_bar' ) ) {
function lifterlms_course_progress_bar( $progress, $link = false, $button = true, $echo = true ) {
$progress = round( $progress, 2 );
$tag = ( $link ) ? 'a' : 'span';
$href = ( $link ) ? ' href=" ' . $link . ' "' : '';
$html = llms_get_progress_bar_html( $progress );
if ( $button ) {
$html .= '<' . $tag . ' class="llms-button-primary llms-purchase-button"' . $href . '>' . __( 'Continue', 'lifterlms' ) . '(' . $progress . '%)</' . $tag . '>';
}
if ( $echo ) {
echo wp_kses_post( $html );
} else {
return $html;
}
}
}
function llms_get_progress_bar_html( $percentage ) {
$percentage = sprintf( '%s%%', $percentage );
$html = '<div class="llms-progress">
<div class="progress__indicator">' . $percentage . '</div>
<div class="llms-progress-bar">
<div class="progress-bar-complete" data-progress="' . $percentage . '" style="width:' . $percentage . '"></div>
</div></div>';
return $html;
}
/**
* Output a course continue button linking to the incomplete lesson for a given student.
*
* If the course is complete "Course Complete" is displayed.
*
* @since 3.11.1
* @since 3.15.0 Unknown.
* @since 7.1.0 Remove check on student existence, now included in the enrollment check.
*
* @param int $post_id WP Post ID for a course, lesson, or quiz.
* @param LLMS_Student $student Instance of an LLMS_Student, defaults to current student.
* @param int $progress Current progress of the student through the course.
* @return void
*/
if ( ! function_exists( 'lifterlms_course_continue_button' ) ) {
function lifterlms_course_continue_button( $post_id = null, $student = null, $progress = null ) {
if ( ! $post_id ) {
$post_id = get_the_ID();
if ( ! $post_id ) {
return '';
}
}
$course = llms_get_post( $post_id );
if ( ! $course || ! is_a( $course, 'LLMS_Post_Model' ) ) {
return '';
}
if ( in_array( $course->get( 'type' ), array( 'lesson', 'quiz' ) ) ) {
$course = llms_get_post_parent_course( $course->get( 'id' ) );
if ( ! $course ) {
return '';
}
}
if ( ! $student ) {
$student = llms_get_student();
}
if ( ! $student || ! llms_is_user_enrolled( $student->get_id(), $course->get( 'id' ) ) ) {
return '';
}
if ( is_null( $progress ) ) {
$progress = $student->get_progress( $course->get( 'id' ), 'course' );
}
if ( 100 == $progress ) {
echo '<p class="llms-course-complete-text">' . wp_kses_post( apply_filters( 'llms_course_continue_button_complete_text', __( 'Course Complete', 'lifterlms' ), $course ) ) . '</p>';
} else {
$lesson = apply_filters( 'llms_course_continue_button_next_lesson', $student->get_next_lesson( $course->get( 'id' ) ), $course, $student );
if ( $lesson ) { ?>
<a class="llms-button-primary llms-course-continue-button" href="<?php echo esc_url( get_permalink( $lesson ) ); ?>">
<?php if ( 0 == $progress ) : ?>
<?php esc_html_e( 'Get Started', 'lifterlms' ); ?>
<?php else : ?>
<?php esc_html_e( 'Continue', 'lifterlms' ); ?>
<?php endif; ?>
</a>
<?php
}
}
}
}
/**
* Course Thumbnail Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_get_course_thumbnail' ) ) {
function lifterlms_get_course_thumbnail() {
global $post;
if ( has_post_thumbnail() ) {
return lifterlms_get_featured_image( $post->ID );
} elseif ( llms_placeholder_img_src() ) {
return llms_placeholder_img( 'full' );
}
}
}
/**
* Featured Image Template Include
*
* @return void
*/
if ( ! function_exists( 'lifterlms_get_featured_image' ) ) {
function lifterlms_get_featured_image( $post_id ) {
if ( has_post_thumbnail( $post_id ) ) {
return llms_featured_img( $post_id, 'full' );
} elseif ( llms_placeholder_img_src() ) {
return llms_placeholder_img();
}
}
}
/**
* Get the placeholder image URL for courses
*
* @access public
* @return string
*/
function llms_placeholder_img_src() {
return apply_filters( 'lifterlms_placeholder_img_src', llms()->plugin_url() . '/assets/images/placeholder.png' );
}
/**
* Get the placeholder image
*
* @access public
* @return string
*/
function llms_placeholder_img( $size = 'full' ) {
return apply_filters( 'lifterlms_placeholder_img', '<img src="' . esc_url( llms_placeholder_img_src() ) . '" alt="placeholder" class="llms-placeholder llms-featured-image wp-post-image" />' );
}
/**
* Get the featured image.
*
* @since unknown
* @since 7.1.2 Fix bug when the featured image file is not available.
*
* @access public
*
* @param int|WP_Post $post_id Post ID or WP_Post object.
* @param string|int[] $size Accepts any registered image size name, or an array of width and height values in pixels (in that order).
* @return string
*/
function llms_featured_img( $post_id, $size ) {
$img = wp_get_attachment_image_src( get_post_thumbnail_id( $post_id ), $size );
$html = '';
if ( isset( $img[0] ) ) {
$html = '<img src="' . esc_url( $img[0] ) . '" alt="' . esc_attr( get_the_title( $post_id ) ) . '" class="llms-featured-image wp-post-image">';
}
/**
* Filters the featured image of a given LifterLMS post.
*
* @since unknown
* @since 7.1.2 Added `$post_id` parameter.
*
* @param string $html HTML img element or empty string if the post has no thumbnail.
* @param int|WP_Post $post_id Post ID or WP_Post object.
*/
return apply_filters( 'lifterlms_featured_img', $html, $post_id );
}
/**
* Retrieve author name, avatar, and bio
*
* @param array $args arguments
* @return string
* @since 3.0.0
* @version 3.13.0
*/
function llms_get_author( $args = array() ) {
$args = wp_parse_args(
$args,
array(
'avatar' => true,
'avatar_size' => 96,
'bio' => false,
'label' => '',
'user_id' => get_the_author_meta( 'ID' ),
)
);
$name = get_the_author_meta( 'display_name', $args['user_id'] );
if ( $args['avatar'] ) {
$img = get_avatar( $args['user_id'], $args['avatar_size'], apply_filters( 'lifterlms_author_avatar_placeholder', '' ), $name );
} else {
$img = '';
}
$img = apply_filters( 'llms_get_author_image', $img );
$desc = '';
if ( $args['bio'] ) {
$desc = get_the_author_meta( 'description', $args['user_id'] );
}
ob_start();
?>
<div class="llms-author">
<?php
// Escaping, but allowing flexibility for the filter above.
echo wp_kses_post( $img );
?>
<span class="llms-author-info name"><?php echo esc_html( $name ); ?></span>
<?php if ( $args['label'] ) : ?>
<span class="llms-author-info label"><?php echo esc_html( $args['label'] ); ?></span>
<?php endif; ?>
<?php if ( $desc ) : ?>
<p class="llms-author-info bio"><?php echo wp_kses( $desc, wp_kses_allowed_html( 'user_description' ) ); ?></p>
<?php endif; ?>
</div>
<?php
$html = ob_get_clean();
return apply_filters( 'llms_get_author', $html );
}
/**
* Global Content Wrapper Start Template
*
* @return [type] [description]
*/
if ( ! function_exists( 'lifterlms_output_content_wrapper' ) ) {
function lifterlms_output_content_wrapper() {
llms_get_template( 'global/wrapper-start.php' );
}
}
/**
* Global Content Wrapper End Template
*
* @return [type] [description]
*/
if ( ! function_exists( 'lifterlms_output_content_wrapper_end' ) ) {
function lifterlms_output_content_wrapper_end() {
llms_get_template( 'global/wrapper-end.php' );
}
}
/**
* Sidebar Template
*
* @return [type] [description]
*/
if ( ! function_exists( 'lifterlms_get_sidebar' ) ) {
function lifterlms_get_sidebar() {
llms_get_template( 'global/sidebar.php' );
}
}
/**
* Get the link to the edit account details page
*
* @return string
*/
function llms_person_edit_account_url() {
$edit_account_url = llms_get_endpoint_url( 'edit-account', '', get_permalink( llms_get_page_id( 'myaccount' ) ) );
return apply_filters( 'lifterlms_person_edit_account_url', $edit_account_url );
}
/**
* Get the link to the redeem voucher page
*
* @return string
*/
function llms_person_redeem_voucher_url() {
$url = llms_get_endpoint_url( 'redeem-voucher', '', get_permalink( llms_get_page_id( 'myaccount' ) ) );
return apply_filters( 'lifterlms_person_redeem_voucher_url', $url );
}
/**
* Get the link to the My Courses endpoint
*
* @return string
*
* @since 3.0.0
*/
function llms_person_my_courses_url() {
$url = llms_get_endpoint_url( 'my-courses', '', get_permalink( llms_get_page_id( 'myaccount' ) ) );
return apply_filters( 'lifterlms_person_my_courses_url', $url );
}
/**
* Get Product Query Var
* REFACTOR: Move to query class
*
* @param array $vars [array of query variables]
* @return array $vars [array of query variables]
*/
function get_product_query_var( $vars ) {
$vars[] = 'product';
return $vars;
}
add_filter( 'query_vars', 'get_product_query_var' );
/**
* Get available payment gateway options
* Get's available payment gateways options IE: single, recurring
*
* @return void
*/
function get_available_payment_options() {
$_available_options = array();
$option_prefix = 'lifterlms_gateway_enable_';
$options = array(
'paypal',
);
foreach ( $options as $option ) {
$single_option = '';
$single_option = get_option( $option_prefix . $option, 'no' );
if ( 'yes' === $single_option ) {
array_push( $_available_options, $option );
}
llms_get_template( 'checkout/' . $option . '.php' );
}
}
/**
* Get Product Object
*
* @since Unknown
* @since 3.37.13 Use `LLMS_Product` in favor of the deprecated `LLMS_Course_Factory::get_product()` method.
*
* @param WP_Post|int|false $the_product Course or membership post object or id. If `false` uses the global `$post` object.
* @param array $args Arguments to pass to the LLMS_Product Constructor.
* @return LLMS_Proudct
*/
function llms_get_product( $the_product = false, $args = array() ) {
if ( ! $the_product ) {
global $post;
$the_product = $post;
}
return new LLMS_Product( $the_product, $args );
}
/**
* Retrieve an excerpt
*
* @todo deprecate this, I have no idea why this is being done this way...
*
* @param int $post_id WordPress post id
* @return string
* @version 2.7.5
*/
function llms_get_excerpt( $post_id ) {
global $post;
$temp = $post;
$post = get_post( $post_id );
setup_postdata( $post );
$excerpt = apply_filters( 'the_excerpt', $post->post_excerpt );
wp_reset_postdata();
$post = $temp;
return $excerpt;
}
/**
* Shuffles an array while keeping the array indices
*
* @param array $array
*
* @return bool
*/
function llms_shuffle_assoc( &$array ) {
$keys = array_keys( $array );
shuffle( $keys );
foreach ( $keys as $key ) {
$new[ $key ] = $array[ $key ];
}
$array = $new;
return true;
}
/**
* Get Image size for custom image sizes
*
* @param string $name
* @param arrray $default
* @return array
*/
if ( ! function_exists( 'llms_get_image_size' ) ) {
function llms_get_image_size( $name, $default = array() ) {
global $_wp_additional_image_sizes;
if ( isset( $_wp_additional_image_sizes[ $name ] ) ) {
return $_wp_additional_image_sizes[ $name ];
}
return $default;
}
}
/**
* Add various css classes to LifterLMS post types when `post_class()` is called
*
* Succeeds now deprecated `llms_lesson_complete_classes()`.
*
* @param array $classes array of classes to be applied to the post element
* @param array $class array of additional classes
* @param int $post_id WP Post ID
* @return array
* @since 2.7.11
* @version 3.0.0
*
* @todo add additional classes based on course/lesson availability and whatnot
*/
function llms_post_classes( $classes, $class = array(), $post_id = '' ) {
if ( ! $post_id ) {
return $classes;
}
$post_type = get_post_type( $post_id );
// Add enrolled classes.
if ( 'lesson' === $post_type || 'course' === $post_type || 'llms_membership' === $post_type ) {
$classes[] = llms_is_user_enrolled( get_current_user_id(), $post_id ) ? 'is-enrolled' : 'not-enrolled';
}
// Add completion classes.
if ( 'lesson' === $post_type || 'course' === $post_type ) {
if ( get_current_user_id() ) {
$student = new LLMS_Student();
$classes[] = $student->is_complete( $post_id, $post_type ) ? 'is-complete' : 'is-incomplete';
} else {
$classes[] = 'is-complete';
}
}
return $classes;
}
/**
* Output course reviews
*
* @return void
* @since 3.1.3
* @version 3.1.3
*/
if ( ! function_exists( 'lifterlms_template_single_reviews' ) ) {
function lifterlms_template_single_reviews() {
LLMS_Reviews::output();
}
}
/**
* Function to check if a post is built with Elementor
*
* @since 7.7.0
*/
if ( ! function_exists( 'llms_is_elementor_post' ) ) {
function llms_is_elementor_post( $post_id = false ) {
if ( ! $post_id ) {
$post_id = get_the_ID();
}
if ( ! $post_id ) {
return false;
}
if ( ! class_exists( 'Elementor\Plugin' ) ) {
return false;
}
$elementor_plugin = Elementor\Plugin::instance();
if ( ! $elementor_plugin->documents || ! method_exists( $elementor_plugin->documents, 'get' ) ) {
return false;
}
$elementor_post = $elementor_plugin->documents->get( $post_id );
if ( ! $elementor_post || ! method_exists( $elementor_post, 'is_built_with_elementor' ) ) {
return false;
}
return $elementor_post->is_built_with_elementor();
}
}
/**
* Function to check if a post is built with Beaver Builder
*
* @since 8.0.0
*/
if ( ! function_exists( 'llms_is_beaver_builder_post' ) ) {
function llms_is_beaver_builder_post( $post_id = false ) {
if ( ! $post_id ) {
$post_id = get_the_ID();
}
return $post_id && class_exists( 'FLBuilderModel' ) && FLBuilderModel::is_builder_enabled( $post_id );
}
}
================================================
FILE: includes/llms.template.hooks.php
================================================
<?php
/**
* LifterLMS template hooks
*
* Defines all action hooks used by various templates.
*
* @package LifterLMS/Hooks
*
* @since 1.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Main content wrappers
*
* @since Unknown
*/
add_action( 'lifterlms_before_main_content', 'lifterlms_output_content_wrapper', 10 );
add_action( 'lifterlms_after_main_content', 'lifterlms_output_content_wrapper_end', 10 );
/**
* Single Course
*
* @since Unknown
*/
add_action( 'lifterlms_single_course_before_summary', 'lifterlms_template_single_video', 20 );
add_action( 'lifterlms_single_course_before_summary', 'lifterlms_template_single_audio', 30 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_meta_wrapper_start', 5 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_length', 10 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_difficulty', 20 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_tracks', 25 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_categories', 30 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_tags', 35 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_course_author', 40 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_meta_wrapper_end', 50 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_prerequisites', 55 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_pricing_table', 60 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_course_progress', 60 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_syllabus', 90 );
add_action( 'lifterlms_single_course_after_summary', 'lifterlms_template_single_reviews', 100 );
/**
* Single Lesson
*
* @since Unknown
* @since 7.5.0 Maybe add favorite template.
*/
add_action( 'lifterlms_single_lesson_before_summary', 'lifterlms_template_single_parent_course', 10 );
if ( llms_is_favorites_enabled() ) {
add_action( 'lifterlms_single_lesson_before_summary', 'llms_template_favorite', 10 );
}
add_action( 'lifterlms_single_lesson_before_summary', 'lifterlms_template_single_lesson_video', 20 );
add_action( 'lifterlms_single_lesson_before_summary', 'lifterlms_template_single_lesson_audio', 20 );
add_action( 'lifterlms_single_lesson_after_summary', 'lifterlms_template_complete_lesson_link', 10 );
add_action( 'lifterlms_single_lesson_after_summary', 'lifterlms_template_lesson_navigation', 20 );
/**
* Course & Membership Loops
*
* @since Unknown
*/
add_action( 'lifterlms_archive_description', 'lifterlms_archive_description', 10 );
add_action( 'lifterlms_before_loop', 'lifterlms_loop_start', 10 );
add_action( 'lifterlms_loop', 'lifterlms_loop', 10 );
add_action( 'lifterlms_after_loop', 'lifterlms_loop_end', 10 );
/**
* Course & Membership Loop Items
*
* @since Unknown
*/
add_action( 'lifterlms_before_loop_item', 'lifterlms_loop_featured_video', 8 );
add_action( 'lifterlms_before_loop_item', 'lifterlms_loop_link_start', 10 );
add_action( 'lifterlms_before_loop_item_title', 'lifterlms_template_loop_thumbnail', 10 );
add_action( 'lifterlms_before_loop_item_title', 'lifterlms_template_loop_progress', 15 );
add_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_author', 10 );
add_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_length', 15 );
add_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_difficulty', 20 );
add_action( 'lifterlms_after_loop_item_title', 'lifterlms_template_loop_lesson_count', 22 );
add_action( 'lifterlms_after_loop_item', 'lifterlms_template_loop_featured_pricing_information', 3 );
add_action( 'lifterlms_after_loop_item', 'lifterlms_loop_link_end', 5 );
/**
* Course Syllabus
*
* @since 7.5.0
*/
if ( llms_is_favorites_enabled() ) {
add_action( 'llms_lesson_preview_after_title', 'llms_template_syllabus_favorite_lesson_preview', 10 );
}
/**
* Emails
*
* @since Unknown
*/
add_action( 'lifterlms_email_header', 'llms_email_header', 10, 1 );
add_action( 'lifterlms_email_body', 'llms_email_body', 10, 1 );
add_action( 'lifterlms_email_footer', 'llms_email_footer', 10 );
/**
* Pricing Tables
*
* @since Unknown
* @since 3.38.0 Added `lifterlms_product_not_purchasable`.
*/
add_action( 'llms_access_plan', 'llms_template_access_plan', 10 );
add_action( 'llms_before_access_plan', 'llms_template_access_plan_feature', 10 );
add_action( 'llms_acces_plan_content', 'llms_template_access_plan_title', 10 );
add_action( 'llms_acces_plan_content', 'llms_template_access_plan_pricing', 20 );
add_action( 'llms_acces_plan_content', 'llms_template_access_plan_restrictions', 30 );
add_action( 'llms_acces_plan_content', 'llms_template_access_plan_description', 40 );
add_action( 'llms_acces_plan_footer', 'llms_template_access_plan_trial', 10 );
add_action( 'llms_acces_plan_footer', 'llms_template_access_plan_button', 20 );
add_action( 'lifterlms_product_not_purchasable', 'llms_template_product_not_purchasable', 10 );
/**
* Privacy
*
* @since Unknown
*/
add_action( 'llms_registration_privacy', 'llms_privacy_policy_form_field', 10 );
add_action( 'llms_registration_privacy', 'llms_agree_to_terms_form_field', 20 );
/**
* Quizzes
*
* @since Unknown
*/
add_action( 'lifterlms_single_quiz_before_summary', 'lifterlms_template_quiz_wrapper_start', 5 );
add_action( 'lifterlms_single_quiz_before_summary', 'lifterlms_template_quiz_return_link', 10 );
add_action( 'lifterlms_single_quiz_before_summary', 'lifterlms_template_quiz_results', 15 );
add_action( 'llms_single_quiz_attempt_results', 'lifterlms_template_quiz_attempt_results', 10 );
add_action( 'llms_single_quiz_attempt_results_main', 'lifterlms_template_quiz_attempt_results_questions_list', 10 );
add_action( 'lifterlms_single_quiz_before_summary', 'lifterlms_template_quiz_meta_info', 25 );
add_action( 'lifterlms_single_quiz_after_summary', 'lifterlms_template_quiz_wrapper_end', 5 );
add_action( 'lifterlms_single_quiz_after_summary', 'lifterlms_template_start_button', 10 );
/**
* Questions
*
* @since Unknown
*/
add_action( 'lifterlms_single_question_before_summary', 'lifterlms_template_question_wrapper_start', 10 );
add_action( 'lifterlms_single_question_content', 'lifterlms_template_question_description', 10 );
add_action( 'lifterlms_single_question_content', 'lifterlms_template_question_image', 20 );
add_action( 'lifterlms_single_question_content', 'lifterlms_template_question_video', 30 );
add_action( 'lifterlms_single_question_content', 'lifterlms_template_question_content', 40 );
add_action( 'lifterlms_single_question_after_summary', 'lifterlms_template_question_wrapper_end', 10 );
/**
* Student Dashboard
*
* @since 7.8.0
*/
add_action( 'lifterlms_before_student_dashboard', 'lifterlms_template_student_dashboard_wrapper_open', 10 );
add_action( 'lifterlms_before_student_dashboard_content', 'lifterlms_template_student_dashboard_navigation', 10 );
add_action( 'lifterlms_before_student_dashboard_content', 'lifterlms_template_student_dashboard_header', 20 );
add_action( 'lifterlms_student_dashboard_header', 'lifterlms_template_student_dashboard_title', 10 );
add_action( 'lifterlms_student_dashboard_index', 'lifterlms_template_student_dashboard_my_courses', 10 );
add_action( 'lifterlms_student_dashboard_index', 'lifterlms_template_student_dashboard_my_achievements', 20 );
add_action( 'lifterlms_student_dashboard_index', 'lifterlms_template_student_dashboard_my_certificates', 30 );
add_action( 'llms_achievement_content', 'llms_the_achievement', 10 );
add_action( 'llms_certificate_preview', 'llms_the_certificate_preview', 10 );
add_action( 'lifterlms_student_dashboard_index', 'lifterlms_template_student_dashboard_my_memberships', 40 );
add_action( 'llms_my_grades_course_table', 'lifterlms_template_student_dashboard_my_grades_table', 10, 2 );
add_action( 'llms_view_order_information', 'llms_template_view_order_information', 10 );
add_action( 'llms_view_order_actions', 'llms_template_view_order_actions', 10 );
add_action( 'llms_view_order_transactions', 'llms_template_view_order_transactions', 10, 2 );
add_action( 'lifterlms_after_student_dashboard', 'lifterlms_template_student_dashboard_wrapper_close', 10 );
/**
* Single Membership
*
* @since Unknown
*/
add_action( 'lifterlms_single_membership_before_summary', 'lifterlms_template_single_membership_video', 20 );
add_action( 'lifterlms_single_membership_before_summary', 'lifterlms_template_single_membership_audio', 30 );
add_action( 'lifterlms_single_membership_after_summary', 'lifterlms_template_pricing_table', 10 );
/**
* Sidebar
*
* LifterLMS *does not* automatically output sidebars on course
* and membership catalogs.
*
* But there is a "stub" that themes (or other plugins) can utilize
* in order to add a sidebar to the catalogs.
*
* @since Unknown
*/
add_action( 'lifterlms_sidebar', 'lifterlms_get_sidebar', 10 );
/**
* Single Certificate
*
* @since 6.0.0
*/
add_action( 'wp_head', 'llms_certificate_styles' );
add_action( 'llms_display_certificate', 'llms_certificate_content', 10 );
add_action( 'llms_display_certificate', 'llms_certificate_actions', 20 );
if ( ! is_admin() ) {
add_filter( 'post_class', 'llms_post_classes', 20, 3 );
}
================================================
FILE: includes/models/class-llms-event.php
================================================
<?php
/**
* LifterLMS Event Model
*
* @package LifterLMS/Models/Classes
*
* @since 3.36.0
* @version 4.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Event Model
*
* @since 3.36.0
* @since 4.3.0 Added record `$type` property definition.
*/
class LLMS_Event extends LLMS_Abstract_Database_Store {
/**
* Array of table column name => format
*
* @var array
*/
protected $columns = array(
'date' => '%s',
'actor_id' => '%d',
'object_type' => '%s',
'object_id' => '%d',
'event_type' => '%s',
'event_action' => '%s',
'meta' => '%s',
);
/**
* Created date key name.
*
* @var string
*/
protected $date_created = 'date';
/**
* Updated date not supported.
*
* @var null
*/
protected $date_updated = null;
/**
* Database Table Name
*
* @var string
*/
protected $table = 'events';
/**
* The record type
*
* @var string
*/
protected $type = 'event';
/**
* Constructor
*
* @since 3.36.0
*
* @param int $id Event ID.
* @param bool $hydrate If true, hydrates the object on instantiation if an ID is supplied.
*/
public function __construct( $id = null, $hydrate = false ) {
$this->id = $id;
if ( $this->id && $hydrate ) {
$this->hydrate();
}
// Adds created and updated dates on instantiation.
parent::__construct();
}
/**
* Delete meta data
*
* @since 3.36.0
*
* @param string $key Meta key, if omitted deletes *all* metadata.
* @param bool $save If true, saves updated metadata to the database.
* @return LLMS_Event
*/
public function delete_meta( $key = null, $save = false ) {
if ( ! $key ) {
return $this->set_unencoded_metas( array(), $save );
}
$all = $this->get_meta( null, false );
unset( $all[ $key ] );
return $this->set_unencoded_metas( $all, $save );
}
/**
* Retrieve metadata.
*
* @since 3.36.0
*
* @param string $key Metadata key, if omitted returns an associative array of all metadata as key=>val pairs.
* @param bool $cache If true, uses cached data when available.
* @return mixed
*/
public function get_meta( $key = null, $cache = true ) {
$all = $this->get( 'meta', $cache );
$all = empty( $all ) ? array() : json_decode( $all, true );
if ( ! $key ) {
return $all;
}
return isset( $all[ $key ] ) ? $all[ $key ] : null;
}
/**
* Update/Add a single meta item.
*
* @since 3.36.0
*
* @param string $key Meta key.
* @param mixed $val Meta value.
* @param bool $save If true, saves the updated metadata to the database.
* @return LLMS_Event
*/
public function set_meta( $key, $val, $save = false ) {
$all = $this->get_meta();
$all[ $key ] = $val;
return $this->set_unencoded_metas( $all, $save );
}
/**
* Update/Add multiple metas.
*
* @since 3.36.0
*
* @param array $metas Associative array of metadata to update/add as key=>val pairs.
* @param bool $save If true, saves the updated metadata to the database.
* @return LLMS_Event
*/
public function set_metas( $metas, $save = false ) {
foreach ( $metas as $key => $val ) {
$this->set_meta( $key, $val );
}
if ( $save ) {
$this->save();
}
return $this;
}
/**
* Encode the array of metadata before setting it to the object.
*
* @since 3.36.0
*
* @param array $metas Associative array of metadata to update/add as key=>val pairs.
* @param bool $save If true, saves the updated metadata to the database.
* @return LLMS_Event
*/
protected function set_unencoded_metas( $metas, $save = false ) {
return $this->set( 'meta', wp_json_encode( $metas ), $save );
}
}
================================================
FILE: includes/models/index.php
================================================
<?php // shhhh.
================================================
FILE: includes/models/model.llms.access.plan.php
================================================
<?php
/**
* LifterLMS Access Plan Model
*
* @package LifterLMS/Models/Classes
*
* @since 3.0.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Access_Plan Model.
*
* @property $access_expiration (string) Expiration type [lifetime|limited-period|limited-date]
* @property $access_expires (string) Date access expires in m/d/Y format. Only applicable when $access_expiration is "limited-date"
* @property $access_length (int) Length of access from time of purchase, combine with $access_period. Only applicable when $access_expiration is "limited-period"
* @property $access_period (string) Time period of access from time of purchase, combine with $access_length. Only applicable when $access_expiration is "limited-period" [year|month|week|day]
* @property $availability (string) Determine if this access plan is available to anyone or to members only. Use with $availability_restrictions to determine if the member can use the access plan. [open|members]
* @property $availability_restrictions (array) Indexed array of LifterLMS Membership IDs a user must belong to to use the access plan. Only applicable if $availability is "members".
* @property $content (string) Plan description (post_content)
* @property $checkout_redirect_forced (string) On a members' only access plan, whether to force redirect users back to course after checking out the membership.
* @property $checkout_redirect_type (string) Type of checkout redirection [self|page|url]
* @property $checkout_redirect_page (int) Page to redirect to after checkout
* @property $checkout_redirect_url (string) URL to redirect to after checkout
* @property $enroll_text (string) Text to display on buy buttons
* @property $frequency (int) Frequency of billing. 0 = a one-time payment [0-6]
* @property $id (int) Post ID
* @property $is_free (string) Whether or not the plan requires payment [yes|no]
* @property $length (int) Number of intervals to run payment for, combine with $period & $frequency. 0 = forever / until cancelled. Only applicable if $frequency is not 0.
* @property $menu_order (int) Order to display access plans in when listing them. Displayed in ascending order.
* @property $on_sale (string) Enable or disable plan sale pricing [yes|no]
* @property $period (string) Interval period, combine with $length. Only applicable if $frequency is not 0. [year|month|week|day]
* @property $price (float) Price per charge
* @property $product_id (int) WP Post ID of the related LifterLMS Product (course or membership)
* @property $sale_end (string) Date when the sale pricing ends
* @property $sale_start (string) Date when the sale pricing begins
* @property $sale_price (float) Sale price
* @property $sku (string) Short user-created plan identifier
* @property $title (string) Plan title
* @property $trial_length (int) length of the trial period. Only applicable if $trial_offer is "yes"
* @property $trial_offer (string) Enable or disable a plan trial period. [yes|no]
* @property $trial_period (string) Period for the trial period. Only applicable if $trial_offer is "yes". [year|month|week|day]
* @property $trial_price (float) Price for the trial period. Can be 0 for a free trial period
*
* @since 3.0.0
* @since 3.30.0 Added checkout redirect properties and methods
* @since 3.30.1 Added method to get the initial price due on checkout.
* @since 3.31.0 The `$check_availability` parameter was added to the `llms_plan_get_checkout_url` filter.
*/
class LLMS_Access_Plan extends LLMS_Post_Model {
/**
* Map of meta properties => type.
*
* @var array
*/
protected $properties = array(
'access_expiration' => 'string',
'access_expires' => 'string',
'access_length' => 'absint',
'access_period' => 'string',
'availability' => 'string',
'availability_restrictions' => 'array',
'content' => 'html',
'checkout_redirect_forced' => 'yesno',
'checkout_redirect_type' => 'string',
'checkout_redirect_page' => 'absint',
'checkout_redirect_url' => 'string',
'enroll_text' => 'string',
'frequency' => 'absint',
'is_free' => 'yesno',
'length' => 'absint',
'menu_order' => 'absint',
'on_sale' => 'yesno',
'period' => 'string',
'price' => 'float',
'product_id' => 'absint',
'sale_end' => 'string',
'sale_start' => 'string',
'sale_price' => 'float',
'sku' => 'string',
'title' => 'string',
'trial_length' => 'absint',
'trial_offer' => 'yesno',
'trial_period' => 'string',
'trial_price' => 'float',
);
/**
* Post Type name
*
* @var string
*/
protected $db_post_type = 'llms_access_plan';
/**
* Name of the model.
*
* @var string
*/
protected $model_post_type = 'access_plan';
/**
* Determine if the access plan has expiration settings
*
* @since 3.0.0
* @version 3.0.0
* @return boolean true if it can expire, false if it's for lifetime access
*/
public function can_expire() {
return ( 'lifetime' !== $this->get( 'access_expiration' ) );
}
/**
* Calculate redirection url from settings
*
* @param string The redirection type: self, page or url.
* @return string
* @since 3.30.0
* @version 3.30.0
*/
private function calculate_redirection_url( $redirect_type ) {
$available = $this->is_available_to_user( get_current_user_id() );
if ( ! $available && 'no' === $this->get( 'checkout_redirect_forced' ) ) {
$redirect_type = 'membership';
}
// by default, no special redirection is needed.
$redirection = '';
switch ( $redirect_type ) {
// redirect to itself.
case 'self':
/**
* Only set up when it is a member's only access plan with forced redirection to course.
* This will ensure that on a regular access plan, no special parameter is added to querystring.
* At the same time, if it is a members' only access plan,
* after membership checkout we'd like to force redirect to course
*/
if ( ! $available && llms_parse_bool( $this->get( 'checkout_redirect_forced' ) ) ) {
$redirection = get_permalink( $this->get( 'product_id' ) );
}
break;
case 'page':
$redirection = get_permalink( $this->get( 'checkout_redirect_page' ) );
break;
case 'url':
$redirection = $this->get( 'checkout_redirect_url' );
break;
}
return $redirection;
}
/**
* Get the translated and pluralized name of the plan's access period
*
* @since 3.4.6
* @since 3.23.0 Unknown.
* @since 5.3.0 Use llms_get_time_period_l10n().
*
* @param string $period Untranslated access period, if not supplied uses stored value for the plan.
* @param int $length Access length (for pluralization), if not supplied uses stored value for the plan.
* @return string
*/
public function get_access_period_name( $period = null, $length = null ) {
$period = $period ? $period : $this->get( 'access_period' );
$length = $length ? $length : $this->get( 'access_length' );
$period = llms_get_time_period_l10n( $period, $length );
/**
* Filter the translated name of an access plan's billing period.
*
* @since 3.4.6
* @version 3.4.6
*
* @param string $period Translated period name.
* @param int $length Access length, used for pluralization.
* @param LLMS_Access_Plan $this Access plan instance.
*/
return apply_filters( 'llms_plan_get_access_period_name', $period, $length, $this );
}
/**
* Default arguments for creating a new post
*
* @since 3.0.0
* @version 3.0.0
*
* @param string $title Title to create the post with
* @return array
*/
protected function get_creation_args( $title = '' ) {
return array_merge(
parent::get_creation_args( $title ),
array(
'post_status' => 'publish',
)
);
}
/**
* Retrieve the full URL to redirect to after successful checkout.
*
* @since 3.30.0
* @since 7.0.0 Addeded `$encode` and `$querystring_only` parameters.
*
* @param bool $encode Whether or not encoding the URL.
* @param bool $querystring_only Only return the redirect URL bassed by the querystring.
* @return string
*/
public function get_redirection_url( $encode = true, $querystring_only = false ) {
// What type of redirection is set up by user?
$redirect_type = $this->get( 'checkout_redirect_type' );
// Force redirect querystring parameter over all else.
$redirection = llms_filter_input( INPUT_GET, 'redirect', FILTER_VALIDATE_URL ) ?? '';
if ( ! $redirection && ! $querystring_only ) {
$redirection = $this->calculate_redirection_url( $redirect_type );
}
/**
* Filter the checkout redirection parameter.
*
* @since 3.30.0
* @since 7.0.0 Added `$querystring_only` parameter.
*
* @param string $redirection The calculated url to redirect to.
* @param string $redirection_type Available redirection types 'self', 'membership', 'page', 'url' or a custom type.
* @param LLMS_Acccess_Plan $access_plan Current Access Plan object.
* @param bool $querystring_only Whether or not it was requested to only return the redirect URL passed by querystring.
*/
$redirection = apply_filters( 'llms_plan_get_checkout_redirection', $redirection, $redirect_type, $this, $querystring_only );
return $encode ? urlencode( $redirection ) : $redirection;
}
/**
* Retrieve the full URL to the checkout screen for the plan.
*
* @since 3.0.0
* @since 3.30.0 Added access plan redirection settings.
* @since 3.31.0 The `$check_availability` parameter was added to the filter `llms_plan_get_checkout_url`
* @since 7.0.0 No need to add the redirect querystring parameter if not already set, except for unavailable members only plans.
*
* @param bool $check_availability Determine if availability checks should be made (allows retrieving plans on admin panel).
* @return string
*/
public function get_checkout_url( $check_availability = true ) {
$ret = '#llms-plan-locked';
$available = $this->is_available_to_user( get_current_user_id() );
// if bypassing availability checks OR plan is available to user.
if ( ! $check_availability || $available ) {
$ret = '';
if ( llms_get_page_id( 'checkout' ) > 0 ) {
$ret_params = array(
'plan' => $this->get( 'id' ),
);
$redirection = $this->get_redirection_url( true, true );
if ( $redirection ) {
$ret_params['redirect'] = $redirection;
}
$ret = llms_get_page_url( 'checkout', $ret_params );
}
// not available to user -- this is a member's only plan.
} elseif ( ! $available ) {
$memberships = $this->get_array( 'availability_restrictions' );
// if there's only 1 plan associated with the membership return that url.
if ( 1 === count( $memberships ) ) {
$ret = get_permalink( $memberships[0] );
$redirection = $this->get_redirection_url();
if ( $redirection ) {
$ret = add_query_arg(
array(
'redirect' => $redirection,
),
$ret
);
}
}
}
/**
* Filter the checkout URL for an access plan.
*
* @since Unknown
* @since 3.31.0 The `$check_availability` parameter was added.
*
* @param string $ret The checkout URL.
* @param LLMS_Access_Plan $this Access plan object.
* @param bool $check_availability Determine if availability checks should be made.
* (allows retrieving plans on admin panel)
*/
return apply_filters( 'llms_plan_get_checkout_url', $ret, $this, $check_availability );
}
/**
* Get the initial price due on checkout.
*
* Automatically accounts for Trials, sales, and coupon discounts.
*
* @since 3.30.1
* @since 3.40.0 Simplify logic by using new 4th argument ($coupon) of the `get_price()` method.
*
* @param array $price_args Arguments passed to the price getter function to generate the price.
* @param LLMS_Coupon|int|null $coupon Coupon ID, object, or `null` if no coupon is being used.
* @param string $format Format the price to be returned. Options: html, raw, float (default).
* @return mixed
*/
public function get_initial_price( $price_args = array(), $coupon = null, $format = 'float' ) {
// If it's free it's a bit simpler.
if ( $this->is_free() ) {
$ret = $this->get_free_pricing_text( $format );
} else {
$price_key = 'price';
// Setup the price key name based on the presence of a trial or sale.
if ( $this->has_trial() ) {
$price_key = 'trial_price';
} elseif ( $this->is_on_sale() ) {
$price_key = 'sale_price';
}
$ret = $this->get_price( $price_key, $price_args, $format, $coupon );
}
/**
* Filter an access plan's initial price due on checkout.
*
* @since 3.30.1
*
* @param mixed $ret Price due on checkout.
* @param array $price_args Arguments passed to the price getter function to generate the price.
* @param LLMS_Coupon|int|null $coupon Coupon ID, object, or `null` if no coupon is being used.
* @param string $format Format the price to be returned. Options: html, raw, float (default).
* @param LLMS_Access_Plan $this Access Plan object.
*/
return apply_filters( 'llms_access_plan_get_initial_price', $ret, $price_args, $coupon, $format, $this );
}
/**
* Get a string to use for 0 dollar amount prices rather than 0
*
* @param string $format format to display the price in
* @return string
* @since 3.0.0
* @version 3.0.0
*/
public function get_free_pricing_text( $format = 'html' ) {
$text = __( 'FREE', 'lifterlms' );
if ( 'html' === $format ) {
$text = '<span class="lifterlms-price">' . $text . '</span>';
} elseif ( 'float' === $format ) {
$text = 0.00;
}
/**
* Filter the text displayed when a plan has no price.
*
* @since 3.0.0
* @version 3.0.0
*
* @param string $text Displayed text.
* @param LLMS_Access_Plan $this The access plan instance.
*/
return apply_filters( "llms_get_free_{$this->model_post_type}_pricing_text", $text, $this );
}
/**
* Getter for price strings with optional formatting options
*
* @since 3.0.0
* @since 3.23.0 Unknown.
* @since 3.40.0 Added `$coupon` parameter.
*
* @param string $key Property key.
* @param array $price_args Optional array of arguments that can be passed to `llms_price()`.
* @param string $format Optional format conversion method [html|raw|float].
* @param LLMS_Coupon|int|null $coupon Coupon ID, object, or `null` if no coupon is being used.
* @return mixed
*/
public function get_price( $key, $price_args = array(), $format = 'html', $coupon = null ) {
if ( $coupon ) {
return $this->get_price_with_coupon( $key, $coupon, $price_args, $format );
}
$price = $this->get( $key );
if ( $price <= 0 ) {
$ret = $this->get_free_pricing_text( $format );
} else {
$ret = parent::get_price( $key, $price_args, $format );
}
/**
* Filter the access plan's price.
*
* @since 3.40.0
*
* @param mixed $ret Returned price.
* @param string $key The key of the price property.
* @param array $price_args Price arguments.
* @param string $format Price format string.
* @param LLMS_Access_Plan $this Instance of the access plan.
*/
return apply_filters( 'llms_plan_get_price', $ret, $key, $price_args, $format, $this );
}
/**
* Apply a coupon to a price
*
* @since 3.0.0
* @since 3.7.0 Unknown.
* @since 3.40.0 Use `wp_strip_all_tags()` in favor of `strip_tags()`.
*
* @param string $key Price to retrieve, "price", "sale_price", or "trial_price".
* @param LLMS_Coupon|int $coupon_id Coupon object or post id.
* @param array $price_args Optional arguments to be passed to `llms_price()`.
* @param string $format Optional return format as passed to `llms_price()`.
* @return mixed
*/
public function get_price_with_coupon( $key, $coupon_id, $price_args = array(), $format = 'html' ) {
// Allow id or instance to be passed for $coupon_id.
if ( $coupon_id instanceof LLMS_Coupon ) {
$coupon = $coupon_id;
} else {
$coupon = new LLMS_Coupon( $coupon_id );
}
$price = $this->get( $key );
// Ensure the coupon *can* be applied to this plan.
if ( ! $coupon->is_valid( $this ) ) {
return $price;
}
$discount_type = $coupon->get( 'discount_type' );
// Price and sale price are calculated of coupon amount.
if ( 'price' === $key || 'sale_price' === $key ) {
$coupon_amount = $coupon->get( 'coupon_amount' );
} elseif ( 'trial_price' === $key && $coupon->has_trial_discount() && $this->has_trial() ) {
$coupon_amount = $coupon->get( 'trial_amount' );
} else {
$coupon_amount = 0;
}
if ( $coupon_amount ) {
// Simple subtraction.
if ( 'dollar' === $discount_type ) {
$price = $price - $coupon_amount;
} elseif ( 'percent' === $discount_type ) {
$price = $price - ( $price * ( $coupon_amount / 100 ) );
}
}
/**
* Filter the price of a plan with a coupon applied before formatting the price for display.
*
* @since 7.8.0
*/
$price = apply_filters( "llms_get_{$this->model_post_type}_{$key}_price_with_coupon_before_formatting", $price, $key, $price_args, $this );
// If price is less than 0 return the pricing text.
if ( $price <= 0 ) {
$price = $this->get_free_pricing_text( $format );
} elseif ( 'html' === $format || 'raw' === $format ) {
$price = llms_price( $price, $price_args );
if ( 'raw' === $format ) {
$price = wp_strip_all_tags( $price );
}
} elseif ( 'float' === $format ) {
$price = floatval( number_format( $price, get_lifterlms_decimals(), '.', '' ) );
} else {
$price = apply_filters( "llms_get_{$this->model_post_type}_{$key}_{$format}_with_coupon", $price, $key, $price_args, $format, $this );
}
return apply_filters( "llms_get_{$this->model_post_type}_{$key}_price_with_coupon", $price, $key, $price_args, $format, $this );
}
/**
* Retrieve an instance of the associated LLMS_Product
*
* @return obj
* @since 3.0.0
* @version 3.0.0
*/
public function get_product() {
return new LLMS_Product( $this->get( 'product_id' ) );
}
/**
* Retrieve the product type (course or membership) for the associated product
*
* @return string
* @since 3.0.0
* @version 3.0.0
*/
public function get_product_type() {
$product = $this->get_product();
return str_replace( 'llms_', '', $product->get( 'type' ) );
}
/**
* Retrieve the text displayed on "Buy" buttons
* Uses optional user submitted text and falls back to LifterLMS defaults if none is supplied
*
* @param boolean $verbose If true, the text will be verbose and include the plan name for accessibility.
* @return string
* @since 3.0.0
* @since 8.0.0 Added $verbose parameter.
* @version 8.0.0
*/
public function get_enroll_text( $verbose = false ) {
// User custom text option.
$text = $this->get( 'enroll_text' );
if ( ! $text ) {
switch ( $this->get_product_type() ) {
case 'course':
$text = apply_filters( 'llms_course_enroll_button_text', __( 'Enroll', 'lifterlms' ), $this );
break;
case 'membership':
$text = apply_filters( 'llms_membership_enroll_button_text', __( 'Join', 'lifterlms' ), $this );
break;
}
}
// Build the verbose enroll text, if requested.
if ( $verbose ) {
$plan_name = $this->get( 'title' );
$text = sprintf( _x( '%1$s: Select the %2$s plan.', 'Verbose enrollment text', 'lifterlms' ), $text, $plan_name );
}
return apply_filters( 'llms_plan_get_enroll_text', $text, $this, $verbose );
}
/**
* Get a sentence explaining plan expiration details
*
* @return string
* @since 3.0.0
* @version 3.28.2
*/
public function get_expiration_details() {
$ret = '';
$expiration = $this->get( 'access_expiration' );
if ( 'limited-date' === $expiration ) {
$ret = sprintf( _x( 'access until %s', 'Access expiration date', 'lifterlms' ), $this->get_date( 'access_expires' ) );
} elseif ( 'limited-period' === $expiration ) {
$ret = sprintf( _x( '%1$d %2$s of access', 'Access period description', 'lifterlms' ), $this->get( 'access_length' ), $this->get_access_period_name() );
}
return apply_filters( 'llms_get_product_expiration_details', $ret, $this );
}
/**
* Get a sentence explaining the plan's payment schedule
*
* @return string
* @since 3.0.0
* @version 3.23.0
*/
public function get_schedule_details() {
$ret = '';
$period = $this->get( 'period' );
$frequency = $this->get( 'frequency' );
$length = $this->get( 'length' );
// One-time payments don't display anything here unless filtered.
if ( $frequency > 0 ) {
if ( 1 === $frequency ) {
$ret = sprintf( _x( 'per %s', 'subscription schedule', 'lifterlms' ), $this->get_access_period_name( $period, $frequency ) );
} else {
$ret = sprintf( _x( 'every %1$d %2$s', 'subscription schedule', 'lifterlms' ), $frequency, $this->get_access_period_name( $period, $frequency ) );
}
// Add length sentence if applicable.
if ( $length > 0 ) {
$ret .= ' ' . sprintf( _x( 'for %1$d total payments', 'subscription # of payments', 'lifterlms' ), $length );
}
}
return apply_filters( 'llms_get_product_schedule_details', sprintf( $ret, $this->get( 'period' ), $frequency, $length ), $this );
}
/**
* Get a sentence explaining the plan's trial offer
*
* @return string
* @since 3.0.0
* @version 3.4.8
*/
public function get_trial_details() {
$details = '';
if ( $this->has_trial() ) {
$length = $this->get( 'trial_length' );
$period = $this->get( 'trial_period' );
$details = sprintf( _x( 'for %1$d %2$s', 'trial offer description', 'lifterlms' ), $length, $this->get_access_period_name( $period, $length ) );
}
return apply_filters( 'llms_get_product_trial_details', $details, $this );
}
/**
* Get the access plans visibility setting
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_visibility() {
$term = $this->get_terms( 'llms_access_plan_visibility', true );
$ret = ( $term && $term->name ) ? $term->name : 'visible';
return apply_filters( 'llms_get_access_plan_visibility', $ret, $this );
}
/**
* Determine if the plan has availability restrictions
*
* Related product must be a COURSE.
* Availability must be set to "members" and at least one membership must be selected.
*
* @since 3.0.0
*
* @return boolean
*/
public function has_availability_restrictions() {
return ( 'course' === $this->get_product_type() && 'members' === $this->get( 'availability' ) && $this->get_array( 'availability_restrictions' ) );
}
/**
* Determine if the free checkout process & interface should be used for this access plan
*
* @return boolean
* @since 3.4.0
* @version 3.4.0
*/
public function has_free_checkout() {
return ( $this->is_free() && apply_filters( 'llms_has_free_checkout', true, $this ) );
}
/**
* Determine if the plan has a trial offer
* One-time payments can't have a trial, so the plan must have a frequency greater than 0
*
* @return boolean
* @since 3.0.0
* @version 3.23.0
*/
public function has_trial() {
$ret = false;
if ( $this->get( 'frequency' ) > 0 ) {
$ret = llms_parse_bool( $this->get( 'trial_offer' ) );
}
return apply_filters( 'llms_plan_has_trial', $ret, $this );
}
/**
* Determine if the plan is available to a user based on configured availability restrictions
*
* @param int $user_id (optional) WP User ID, if not supplied get_current_user_id() will be used
* @return boolean
* @since 3.4.4
* @version 3.23.0
*/
public function is_available_to_user( $user_id = null ) {
$user_id = empty( $user_id ) ? get_current_user_id() : $user_id;
$access = true;
// If there are membership restrictions, check the user is in at least one membership.
if ( $this->has_availability_restrictions() ) {
$access = false;
foreach ( $this->get_array( 'availability_restrictions' ) as $mid ) {
// Once we find a membership, exit.
if ( llms_is_user_enrolled( $user_id, $mid ) ) {
$access = true;
break;
}
}
}
return apply_filters( 'llms_plan_is_available_to_user', $access, $user_id, $this );
}
/**
* Determine if the plan is marked as "featured"
*
* @return boolean
* @since 3.0.0
* @version 3.8.0
*/
public function is_featured() {
return ( 'featured' === $this->get_visibility() );
}
/**
* Determines if a plan is marked ar free
* This only returns the value of the setting and should not
* be used to check if payment is required (when using a coupon for example)
*
* @return boolean
* @since 3.0.0
* @version 3.23.0
*/
public function is_free() {
return llms_parse_bool( $this->get( 'is_free' ) );
}
/**
* Determine if a plan is *currently* on sale
*
* @return boolean
* @since 3.0.0
* @version 3.24.3
*/
public function is_on_sale() {
$ret = false;
if ( llms_parse_bool( $this->get( 'on_sale' ) ) ) {
$now = llms_current_time( 'timestamp' );
$start = $this->get( 'sale_start' );
$end = $this->get( 'sale_end' );
// Add times if the values exist (start of day & end of day).
$start = ( $start ) ? strtotime( $start . ' 00:00:00' ) : $start;
$end = ( $end ) ? strtotime( '+1 day', strtotime( $end . ' 00:00:00' ) ) : $end;
// No dates, the product is indefinitely on sale.
if ( ! $start && ! $end ) {
$ret = true;
// Start and end.
} elseif ( $start && $end ) {
$ret = ( $now < $end && $now > $start );
// Only start.
} elseif ( $start && ! $end ) {
$ret = ( $now > $start );
// Only end.
} elseif ( ! $start && $end ) {
$ret = ( $now < $end );
}
}
return apply_filters( 'llms_plan_is_on_sale', $ret, $this );
}
/**
* Determine if the plan is visible
* Both featured and visible access plans are considered visible
*
* @return boolean
* @since 3.8.0
* @version 3.8.0
*/
public function is_visible() {
return ( 'hidden' !== $this->get_visibility() );
}
/**
* Determine if the Access Plan has recurring payments
*
* @return boolean true if it is recurring, false otherwise
* @since 3.0.0
* @version 3.0.0
*/
public function is_recurring() {
return ( 0 !== $this->get( 'frequency' ) );
}
/**
* Determine if the access plan requires payment.
*
* Automatically accounts for coupons, sales, trials, and whether the plan is marked as free.
*
* @since 3.0.0
* @since 3.30.1 Uses self::get_initial_price().
*
* @param int $coupon_id LLMS_Coupon ID.
* @return bool true if payment required, false otherwise
*/
public function requires_payment( $coupon_id = null ) {
$ret = false;
if ( ! $this->is_free() ) {
$ret = ( $this->get_initial_price( array(), $coupon_id, 'float' ) > 0 );
// Ensure that we still collect payment details if a free trial is used.
if ( false === $ret ) {
$price_key = $this->is_on_sale() ? 'sale_price' : 'price';
$ret = ( $this->get_price( $price_key, array(), 'float', $coupon_id ) > 0 );
}
}
return apply_filters( 'llms_plan_requires_payment', $ret, $coupon_id, $this );
}
/**
* Update the visibility term for the access plan
*
* @param string $visibility access plan name
* @since 3.8.0
* @version 3.8.0
*/
public function set_visibility( $visibility ) {
return $this->set_terms( array( $visibility ), 'llms_access_plan_visibility', false );
}
/**
* Cleanup data to remove unnecessary defaults
*
* @param array $arr array of data to be serialized
* @return array
* @since 3.16.11
* @version 3.16.11
*/
protected function toArrayAfter( $arr ) {
unset( $arr['author'] );
return $arr;
}
/**
* Don't add custom fields during toArray()
*
* @param array $arr post model array
* @return array
* @since 3.16.11
* @version 3.16.11
*/
protected function toArrayCustom( $arr ) {
return $arr;
}
}
================================================
FILE: includes/models/model.llms.add-on.php
================================================
<?php
/**
* LLMS_Add_On model class file.
*
* @package LifterLMS/Models/Classes
*
* @since 3.22.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Add-On Model
*
* @since 3.22.0
*/
class LLMS_Add_On {
/**
* Add On ID
*
* @var string
*/
private $id = '';
/**
* Add On Data
*
* @var array
*/
private $data = array();
/**
* Constructor
*
* @since 3.22.0
* @since 4.21.3 Move lookup logic to its own private method: `lookup_add_on()`.
*
* @param string|array $addon Add-on data array or a string (such as an ID or update file path) used to lookup the addon.
* @param string $lookup_key If $addon is a string, this determines how to lookup the addon from the available list of addons.
* @return void
*/
public function __construct( $addon = array(), $lookup_key = 'id' ) {
if ( is_string( $addon ) ) {
$addon = $this->lookup_add_on( $lookup_key, $addon );
}
$this->id = ! empty( $addon['id'] ) ? $addon['id'] : '';
$this->data = $addon ? $addon : array();
}
/**
* Magic getter to retrieve add-on props from private $data array
*
* @since 3.22.0
*
* @param string $key Property key.
* @return mixed
*/
public function __get( $key ) {
return isset( $this->data[ $key ] ) ? $this->data[ $key ] : '';
}
/**
* Activate an add-on
*
* @since 3.22.0
* @since 3.25.0 Unknown.
*
* @return string|WP_Error
*/
public function activate() {
$ret = false;
if ( 'plugin' === $this->get( 'type' ) ) {
$ret = activate_plugins( $this->get( 'update_file' ) );
} elseif ( 'theme' === $this->get( 'type' ) ) {
$ret = true;
switch_theme( $this->get( 'update_file' ) );
}
if ( true === $ret ) {
// Translators: %s = Add-on name.
return sprintf( __( '%s was successfully activated.', 'lifterlms' ), $this->get( 'title' ) );
}
// Translators: %s = Add-on name.
return new WP_Error( 'activation', sprintf( __( 'Could not activate %s.', 'lifterlms' ), $this->get( 'title' ) ) );
}
/**
* Deactivate the addon
*
* @since 3.22.0
* @since 4.21.3 Updated the failure error code from 'activation' to 'deactivation'.
*
* @return string|WP_Error
*/
public function deactivate() {
$ret = false;
if ( 'plugin' === $this->get( 'type' ) ) {
deactivate_plugins( $this->get( 'update_file' ) );
// Translators: %s = Add-on name.
return sprintf( __( '%s was successfully deactivated.', 'lifterlms' ), $this->get( 'title' ) );
}
// Translators: %s = Add-on name.
return new WP_Error( 'deactivation', sprintf( __( 'Could not deactivate %s.', 'lifterlms' ), $this->get( 'title' ) ) );
}
/**
* Get add-on properties
*
* @since 3.22.0
*
* @param string $key Property key.
* @return mixed
*/
public function get( $key ) {
return $this->$key;
}
/**
* Retrieve the update channel for the addon
*
* @since 3.22.0
*
* @return string
*/
public function get_channel_subscription() {
return 'stable';
}
/**
* Determine the status of an addon's license
*
* @since 3.22.0
*
* @param bool $translate If `true`, returns the translated string for on-screen display.
* @return string
*/
public function get_install_status( $translate = false ) {
if ( ! $this->is_installable() ) {
$ret = 'none';
} else {
$ret = $this->is_installed() ? 'installed' : 'uninstalled';
}
return $translate ? $this->get_l10n( $ret ) : $ret;
}
/**
* Get the currently installed version of an addon
*
* @since 3.22.0
*
* @return string
*/
public function get_installed_version() {
if ( $this->is_installable() && $this->is_installed() ) {
$type = $this->get( 'type' );
if ( 'plugin' === $type ) {
$data = get_plugin_data( trailingslashit( WP_PLUGIN_DIR ) . $this->get( 'update_file' ) );
return $data['Version'];
} elseif ( 'theme' === $type ) {
$data = wp_get_theme( $this->get( 'update_file' ) );
return $data->get( 'Version' );
}
}
return '';
}
/**
* Retrieve the latest available version for the current channel
*
* @since 3.22.0
*
* @return string
*/
public function get_latest_version() {
if ( 'beta' === $this->get_channel_subscription() && $this->get( 'version_beta' ) ) {
return $this->get( 'version_beta' );
}
return $this->get( 'version' );
}
/**
* Translate strings
*
* @since 3.22.0
*
* @param string $string Untranslated string / key.
* @return string
*/
public function get_l10n( $string ) {
$strings = array(
'active' => __( 'Active', 'lifterlms' ),
'inactive' => __( 'Inactive', 'lifterlms' ),
'installed' => __( 'Installed', 'lifterlms' ),
'uninstalled' => __( 'Not Installed', 'lifterlms' ),
'activate' => __( 'Activate', 'lifterlms' ),
'deactivate' => __( 'Deactivate', 'lifterlms' ),
'install' => __( 'Install', 'lifterlms' ),
'none' => __( 'N/A', 'lifterlms' ),
'license_active' => __( 'Licensed', 'lifterlms' ),
'license_inactive' => __( 'Unlicensed', 'lifterlms' ),
);
return $strings[ $string ];
}
/**
* Determine the status of an addon's license
*
* @since 3.22.0
*
* @param bool $translate If `true`, returns the translated string for on-screen display.
* @return string
*/
public function get_license_status( $translate = false ) {
if ( ! llms_parse_bool( $this->get( 'has_license' ) ) ) {
$ret = 'none';
} else {
$ret = $this->is_licensed() ? 'license_active' : 'license_inactive';
}
return $translate ? $this->get_l10n( $ret ) : $ret;
}
/**
* Retrieve a utm'd link to the add-on
*
* @since 3.22.0
* @since 4.21.3 Use `rawurlencode()` in favor of `urlencode()`.
*
* @return string
*/
public function get_permalink() {
$url = add_query_arg(
array(
'utm_source' => rawurlencode( 'LifterLMS Plugin' ),
'utm_campaign' => rawurlencode( 'Plugin to Sale' ),
'utm_medium' => rawurlencode( 'Add-Ons Screen' ),
'utm_content' => rawurlencode( sprintf( '%1$s Ad %2$s', $this->get( 'title' ), LLMS_VERSION ) ),
),
$this->get( 'permalink' )
);
return $url;
}
/**
* Get the type of addon
*
* @since 3.22.0
* @since 4.21.3 Use strict comparison for `in_array()`.
*
* @return string
*/
public function get_type() {
$type = $this->get( 'type' );
if ( $type ) {
return $type;
}
$cats = array_keys( $this->get( 'categories' ) );
if ( in_array( 'bundles', $cats, true ) ) {
$type = 'bundle';
} elseif ( in_array( 'third-party', $cats, true ) ) {
$type = 'external';
} else {
$type = 'support';
}
return $type;
}
/**
* Get the addon's status
*
* @since 3.22.0
* @param bool $translate If `true`, translates the status for on-screen display.
* @return string
*/
public function get_status( $translate = false ) {
if ( ! $this->is_installable() ) {
$ret = 'none';
} elseif ( $this->is_installed() ) {
$ret = $this->is_active() ? 'active' : 'inactive';
} else {
$ret = 'uninstalled';
}
if ( $translate ) {
$ret = $this->get_l10n( $ret );
}
return $ret;
}
/**
* Get the addon or author image URL for the add-on.
*
* @since 7.5.0
*
* @param string $type Type of image to retrieve. Defaults to 'addon'. Accepts 'addon' or 'author'.
* @return string
*/
public function get_image( $type = 'addon' ) {
$img = 'author' === $type ? $this->get( 'author' )['image'] : $this->get( 'image' );
if ( ! $img ) {
return '';
}
if ( is_readable( llms()->plugin_path() . '/assets/images/addons/' . basename( $img ) ) ) {
return llms()->plugin_url() . '/assets/images/addons/' . basename( $img );
}
return $img;
}
/**
* Determine if there is an available update for the add-on
*
* @since 3.22.0
*
* @return bool
*/
public function has_available_update() {
return version_compare( $this->get_installed_version(), $this->get_latest_version(), '<' );
}
/**
* Determine if an installable addon is active
*
* @since 3.22.0
*
* @return bool
*/
public function is_active() {
if ( $this->is_installable() && $this->is_installed() ) {
$file = $this->get( 'update_file' );
$type = $this->get_type();
if ( 'plugin' === $type ) {
return is_plugin_active( $file );
} elseif ( 'theme' === $type ) {
$theme = wp_get_theme();
return ( $file === $theme->get_stylesheet() );
}
}
return false;
}
/**
* Determines if the add-on is installable
*
* @since 3.22.0
* @since 3.22.1 Unknown.
* @since 4.21.3 Use strict comparison for `in_array()`.
*
* @return boolean
*/
public function is_installable() {
return ( $this->get( 'update_file' ) && in_array( $this->get_type(), array( 'plugin', 'theme' ), true ) );
}
/**
* Determine if the add-on is currently installed
*
* @since 3.22.0
* @since 4.21.3 Use strict comparison for `in_array()`.
*
* @return bool
*/
public function is_installed() {
if ( ! $this->is_installable() ) {
return false;
}
$type = $this->get_type();
if ( 'plugin' === $type ) {
return in_array( $this->get( 'update_file' ), array_keys( get_plugins() ), true );
} elseif ( 'theme' === $type ) {
return wp_get_theme( $this->get( 'update_file' ) )->exists();
}
return false;
}
/**
* Determines if the add-on is licensed
*
* @since 3.22.0
*
* @return bool
*/
public function is_licensed() {
return false;
}
/**
* Locate an add-on by a key/val pair
*
* Loads add-ons via `llms_get_add_ons()` and loops through the items list
* to find an addon specified by the key/val pair.
*
* @since 4.21.3
*
* @param string $lookup_key Key found within the add-on item. EG: "id" or "update_file".
* @param string $lookup_val Value of the key to match.
* @return array|false Returns the add-on data array of `false` if no found.
*/
private function lookup_add_on( $lookup_key, $lookup_val ) {
$addons = llms_get_add_ons();
// Error communicating with the API or no items found.
if ( is_wp_error( $addons ) || empty( $addons['items'] ) ) {
return false;
}
// Loop through the list.
foreach ( $addons['items'] as $addon ) {
// We've found a match.
if ( isset( $addon[ $lookup_key ] ) && $addon[ $lookup_key ] === $lookup_val ) {
return $addon;
}
}
return false;
}
/**
* Verifies the add-on can be uninstalled, and performs the uninstall (permanently deleting its files)
*
* @since 5.1.1
*
* @return string|WP_Error Success message or an error object.
*/
public function uninstall() {
$title = $this->get( 'title' );
if ( ! $this->is_installed() ) {
// Translators: %s = Add-on title.
return new WP_Error( 'not-installed', sprintf( __( '%s is not installed.', 'lifterlms' ), $title ) );
}
if ( $this->is_active() ) {
// Translators: %s = Add-on title.
return new WP_Error( 'uninstall-active', sprintf( __( '%s is active and cannot be uninstalled.', 'lifterlms' ), $title ) );
}
return $this->uninstall_real();
}
/**
* Actually performs the uninstall
*
* @since 5.1.1
*
* @return string|WP_Error Success message or an error object.
*/
private function uninstall_real() {
$type = $this->get_type();
if ( ! in_array( $type, array( 'plugin', 'theme' ), true ) ) {
// Translators: %s = add-on type.
return new WP_Error( 'uninstall-invalid-type', sprintf( __( 'Cannot uninstall "%s" type add-ons.', 'lifterlms' ), $type ) );
}
$file = $this->get( 'update_file' );
if ( 'plugin' === $type ) {
uninstall_plugin( $file );
$del = delete_plugins( array( $file ) );
} else {
$del = delete_theme( $file );
}
if ( is_wp_error( $del ) ) {
return $del;
}
// Translators: %s = Add-on title.
return sprintf( __( '%s was successfully uninstalled.', 'lifterlms' ), $this->get( 'title' ) );
}
}
================================================
FILE: includes/models/model.llms.coupon.php
================================================
<?php
/**
* LifterLMS Coupon Model
*
* @package LifterLMS/Models/Classes
*
* @since 3.0.0
* @version 3.24.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Coupon model.
*
* @property $coupon_amount (float) Amount to subtract from the price when using the coupon. Used with $discount_type to determine the type of discount
* @property $coupon_courses (array) Array of Course IDs the coupon can be used against
* @property $coupon_membership (array) Array of Membership IDs the coupon can be used against
* @property $description (string) A string of text. Used as an internal note field .
* @property $discount_type (string) Determines the discount type [dollar|percent]
* @property $enable_trial_discount (yes/no) Enables an optional additional amount field to apply to the Trial Price of access plans with a trial [yes|no]
* @property $expiration_date (string) Date String describing a date after which the coupon can no longer be used. Format: m/d/Y
* @property $plan_type (string) Determine the type of plans the coupon can be used with . [any|one-time|recurring]
* @property $title (string) Coupon Code / Post Title
* @property $trial_amount (float) Amount to subtract from the trial price when using the coupon. Used with $discount_type to determine the type of discount
* @property $usage_limit (int) Amount of times the coupon can be used.
*
* @since 3.0.0
* @since 3.24.0 Unknown.
*/
class LLMS_Coupon extends LLMS_Post_Model {
protected $properties = array(
'coupon_amount' => 'float',
'coupon_courses' => 'array',
'coupon_membership' => 'array',
'description' => 'string',
'discount_type' => 'string',
'enable_trial_discount' => 'yesno',
'expiration_date' => 'string',
'plan_type' => 'string',
'trial_amount' => 'float',
'usage_limit' => 'absint',
);
protected $db_post_type = 'llms_coupon';
protected $model_post_type = 'coupon';
/**
* Determine if the coupon can be applied to an access plan
*
* @since 3.0.0
* @version 3.0.0
* @param int|obj $plan_id WP Post ID of the LLMS Access Plan or an instance of LLMS_Access_Plan
* @return bool
*/
public function applies_to_plan( $plan_id ) {
if ( $plan_id instanceof LLMS_Access_Plan ) {
$plan = $plan_id;
} else {
$plan = new LLMS_Access_Plan( $plan_id );
}
// Check if it can be applied to the plan's product first.
if ( ! $this->applies_to_product( $plan->get( 'product_id' ) ) ) {
return false;
}
// If the coupon can only be used with one-time plans and the plan is recurring.
if ( 'one-time' === $this->get( 'plan_type' ) && $plan->is_recurring() ) {
return false;
}
if ( 'recurring' === $this->get( 'plan_type' ) && ! $plan->is_recurring() ) {
return false;
}
return true;
}
/**
* Determine if a coupon can be applied to a specific product
*
* @since 3.0.0
* @version 3.0.0
* @param int $product_id WP Post ID of a LLMS Course or Membership
* @return boolean true if it can be applied, false otherwise
*/
public function applies_to_product( $product_id ) {
$products = $this->get_products();
// No product restrictions.
if ( empty( $products ) ) {
return true;
} else {
return in_array( $product_id, $products );
}
}
/**
* Retrieve the timestamp of a coupon expiration date
* Transforms the expiration date to a timestamp and adds 23 hours 59 minutes and 59 seconds to the date
* Coupons expire end of day on the expiration date (EG: 2015-12-01 @ 23:59:59)
*
* @return false|int
* @since 3.19.0
* @version 3.19.0
*/
public function get_expiration_time() {
$expires = $this->get_date( 'expiration_date', 'U' );
if ( ! $expires ) {
return false;
}
return ( (int) $expires + DAY_IN_SECONDS - 1 );
}
/**
* Get the discount type for human reading and allow translation
*
* @since 3.0.0
* @version 3.24.0
* @return string
*/
public function get_formatted_discount_type() {
switch ( $this->get_discount_type() ) {
case 'percent':
return __( 'Percentage Discount', 'lifterlms' );
break;
case 'dollar':
return sprintf( _x( '%s Discount', 'flat rate coupon discount', 'lifterlms' ), get_lifterlms_currency_symbol() );
break;
}
}
/**
* Get the formatted coupon amount with currency symbol and/or percentage symbol
*
* @since 3.0.0
* @version 3.0.0
* @param string $amount key for the amount to format
* @return string
*/
public function get_formatted_amount( $amount = 'coupon_amount' ) {
$amount = $this->get( $amount );
switch ( $this->get( 'discount_type' ) ) {
case 'percent':
$amount .= '%';
break;
case 'dollar':
$amount = llms_price( $amount );
break;
}
return $amount;
}
/**
* Get an array of all products the coupon can be used with
* Combines $this->coupon_courses & $this->coupon_membership
*
* @since 3.0.0
* @version 3.0.0
* @return array
*/
public function get_products() {
return array_merge( $this->get_array( 'coupon_courses' ), $this->get_array( 'coupon_membership' ) );
}
/**
* Get the number of remaining uses
* calculated by subtracting # of uses from the usage limit
*
* @since 3.0.0
* @version 3.0.0
* @return string|int
*/
public function get_remaining_uses() {
$limit = $this->get( 'usage_limit' );
// If usage is unlimited.
if ( ! $limit ) {
return _x( 'Unlimited', 'Remaining coupon uses', 'lifterlms' );
} else {
return $limit - $this->get_uses();
}
}
/**
* Get the number of times the coupon has been used
*
* @return int
* @since 3.0.0
* @version 3.19.0
*/
public function get_uses() {
$query = new WP_Query(
array(
'meta_query' => array(
array(
'key' => $this->meta_prefix . 'coupon_code',
'value' => $this->get( 'title' ),
),
),
'post_status' => 'any',
'post_type' => 'llms_order',
'posts_per_page' => -1,
)
);
return $query->post_count;
}
/**
* Determine if the main (non-trial) price is discounted by this coupon
*
* @return bool
* @since 3.21.1
* @version 3.21.1
*/
public function has_main_discount() {
return ( $this->get( 'coupon_amount' ) > 0 );
}
/**
* Determine if a coupon has uses remaining
*
* @return boolean true if uses are remaining, false otherwise
*/
public function has_remaining_uses() {
$uses = $this->get_remaining_uses();
if ( is_numeric( $uses ) ) {
return ( $uses >= 1 ) ? true : false;
}
return true;
}
/**
* Determine if trial amount discount is enabled for the coupon
*
* @return boolean
* @since 3.0.0
* @version 3.21.1
*/
public function has_trial_discount() {
return llms_parse_bool( $this->get( 'enable_trial_discount' ) );
}
/**
* Determine if a coupon is expired
*
* @return boolean true if expired, false otherwise
* @since 3.0.0
* @version 3.19.0
*/
public function is_expired() {
$expires = $this->get_expiration_time();
// No expiration date, can't expire.
if ( ! $expires ) {
return false;
} else {
return $expires < llms_current_time( 'timestamp' );
}
}
/**
* Perform all available validations and return a success or error message
*
* @param int $plan_id WP Post ID of an LLMS Access Plan
* @return WP_Error|true If true, the coupon is valid, if WP_Error, there was an error
* @since 3.0.0
* @version 3.19.0
*/
public function is_valid( $plan_id ) {
$msg = false;
$plan = new LLMS_Access_Plan( $plan_id );
if ( ! $this->has_remaining_uses() ) {
$msg = __( 'This coupon has reached its usage limit and can no longer be used.', 'lifterlms' );
} elseif ( $this->is_expired() ) {
$msg = sprintf( __( 'This coupon expired on %s and can no longer be used.', 'lifterlms' ), $this->get_date( 'expiration_date', 'F d, Y' ) );
} elseif ( ! $this->applies_to_product( $plan->get( 'product_id' ) ) ) {
$msg = sprintf( __( 'This coupon cannot be used to purchase "%s".', 'lifterlms' ), get_the_title( $plan->get( 'product_id' ) ) );
} elseif ( ! $this->applies_to_plan( $plan ) ) {
$msg = sprintf( __( 'This coupon cannot be used to purchase "%s".', 'lifterlms' ), $plan->get( 'title' ) );
}
// Error encountered.
if ( $msg ) {
$ret = new WP_Error();
$ret->add( 'error', apply_filters( 'lifterlms_coupon_validation_error_message', $msg, $this ) );
} else {
$ret = true;
}
return apply_filters( 'llms_coupon_is_valid', $ret, $plan, $this );
}
}
================================================
FILE: includes/models/model.llms.course.php
================================================
<?php
/**
* LifterLMS Course Model
*
* @package LifterLMS/Models/Classes
*
* @since 1.0.0
* @version 7.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Course model class.
*
* @since 1.0.0
* @since 3.30.3 Explicitly define class properties.
* @since 4.0.0 Remove previously deprecated class methods.
* @since 5.2.1 Check for an empty sales page URL or ID.
* @since 5.3.0 Move audio and video embed methods to `LLMS_Trait_Audio_Video_Embed`.
* Move sales page methods to `LLMS_Trait_Sales_Page`.
* @since 6.0.0 Removed deprecated items.
* - `LLMS_Course::sections` property
* - `LLMS_Course::sku` property
*
* @property string $audio_embed URL to an oEmbed enable audio URL.
* @property float $average_grade Calculated value of the overall average grade of all *enrolled* students in the course..
* @property float $average_progress Calculated value of the overall average progress of all *enrolled* students in the course..
* @property int $capacity Number of students who can be enrolled in the course before enrollment closes.
* @property string $capacity_message Message displayed when capacity has been reached.
* @property string $content_restricted_message Message displayed when non-enrolled visitors try to access lessons/quizzes directly.
* @property string $course_closed_message Message displayed to visitors when the course is accessed after the Course End Date has passed. Only applicable when $time_period is 'yes'.
* @property string $course_opens_message Message displayed to visitors when the course is accessed before the Course Start Date has passed. Only applicable when $time_period is 'yes'.
* @property string $enable_capacity Whether capacity restrictions are enabled [yes|no].
* @property string $enrollment_closed_message Message displayed to non-enrolled visitors when the course is accessed after the Enrollment End Date has passed. Only applicable when $enrollment_period is 'yes'.
* @property string $enrollment_end_date After this date, registration closes.
* @property string $enrollment_opens_message Message displayed to non-enrolled visitors when the course is accessed before the Enrollment Start Date has passed. Only applicable when $enrollment_period is 'yes'.
* @property string $enrollment_period Whether or not a course time period restriction is enabled [yes|no] (all checks should check for 'yes' as an empty string might be returned).
* @property string $enrollment_start_date Before this date, registration is closed.
* @property string $end_date Date when a course closes. Students may no longer view content or complete lessons / quizzes after this date..
* @property string $has_prerequisite Determine if prerequisites are enabled [yes|no].
* @property array $instructors Course instructor user information.
* @property int $prerequisite WP Post ID of a the prerequisite course.
* @property int $prerequisite_track WP Tax ID of a the prerequisite track.
* @property string $start_date Date when a course is opens. Students may register before this date but can only view content and complete lessons or quizzes after this date..
* @property string $length User defined course length.
* @property string $featured_pricing User defined additional pricing information.
* @property int $sales_page_content_page_id WP Post ID of the WP page to redirect to when $sales_page_content_type is 'page'.
* @property string $sales_page_content_type Sales page behavior [none,content,page,url].
* @property string $sales_page_content_url Redirect URL for a sales page, when $sales_page_content_type is 'url'.
* @property string $tile_featured_video Displays the featured video instead of the featured image on course tiles [yes|no].
* @property string $time_period Whether or not a course time period restriction is enabled [yes|no] (all checks should check for 'yes' as an empty string might be returned).
* @property string $video_embed URL to an oEmbed enable video URL.
*/
class LLMS_Course extends LLMS_Post_Model implements LLMS_Interface_Post_Instructors {
use LLMS_Trait_Audio_Video_Embed;
use LLMS_Trait_Sales_Page;
/**
* Meta properties.
*
* @var array
*/
protected $properties = array(
// Public.
'average_grade' => 'float',
'average_progress' => 'float',
'capacity' => 'absint',
'capacity_message' => 'text',
'course_closed_message' => 'text',
'course_opens_message' => 'text',
'content_restricted_message' => 'text',
'enable_capacity' => 'yesno',
'end_date' => 'text',
'enrolled_students' => 'absint',
'enrollment_closed_message' => 'text',
'enrollment_end_date' => 'text',
'enrollment_opens_message' => 'text',
'enrollment_period' => 'yesno',
'enrollment_start_date' => 'text',
'has_prerequisite' => 'yesno',
'instructors' => 'array',
'length' => 'text',
'prerequisite' => 'absint',
'prerequisite_track' => 'absint',
'tile_featured_video' => 'yesno',
'time_period' => 'yesno',
'start_date' => 'text',
'lesson_drip' => 'yesno',
'drip_method' => 'text',
'ignore_lessons' => 'absint',
'days_before_available' => 'absint',
'featured_pricing' => 'html',
'completion_page_id' => 'absint',
// Private.
'temp_calc_data' => 'array',
'last_data_calc_run' => 'absint',
);
/**
* Default property values
*
* @var array
*/
protected $property_defaults = array(
'enrolled_students' => 0,
);
/**
* DB post type name.
*
* @var string
*/
protected $db_post_type = 'course';
/**
* Model post type name.
*
* @var string
*/
protected $model_post_type = 'course';
/**
* Constructor for this class and the traits it uses.
*
* @since 5.3.0
*
* @param string|int|LLMS_Post_Model|WP_Post $model 'new', WP post id, instance of an extending class, instance of WP_Post.
* @param array $args Args to create the post, only applies when $model is 'new'.
*/
public function __construct( $model, $args = array() ) {
$this->construct_audio_video_embed();
$this->construct_sales_page();
parent::__construct( $model, $args );
}
/**
* Retrieve an instance of the Post Instructors model
*
* @since 3.13.0
*
* @return LLMS_Post_Instructors
*/
public function instructors() {
return new LLMS_Post_Instructors( $this );
}
/**
* Retrieve the total points available for the course
*
* @since 3.24.0
*
* @return int
*/
public function get_available_points() {
$points = 0;
foreach ( $this->get_lessons() as $lesson ) {
$points += $lesson->get( 'points' );
}
/**
* Filters the total available points for the course.
*
* @since 3.24.0
*
* @param int $points Number of available points.
* @param LLMS_Course $course Course object.
*/
return apply_filters( 'llms_course_get_available_points', $points, $this );
}
/**
* Get course's prerequisite id based on the type of prerequisite
*
* @since 3.0.0
* @since 3.7.3 Unknown.
*
* @param string $type Optional. Type of prereq to retrieve id for [course|track]. Default is 'course'.
* @return int|false Post ID of a course, taxonomy ID of a track, or false if none found.
. */
public function get_prerequisite_id( $type = 'course' ) {
if ( $this->has_prerequisite( $type ) ) {
switch ( $type ) {
case 'course':
$key = 'prerequisite';
break;
case 'course_track':
$key = 'prerequisite_track';
break;
}
if ( isset( $key ) ) {
return $this->get( $key );
}
}
return false;
}
/**
* Retrieve course categories
*
* @since 3.3.0
*
* @param array $args Array of args passed to wp_get_post_terms.
* @return array
*/
public function get_categories( $args = array() ) {
return wp_get_post_terms( $this->get( 'id' ), 'course_cat', $args );
}
/**
* Get Difficulty
*
* @since 1.0.0
* @since 3.24.0 Unknown.
* @since 7.2.0 Added support for showing multiple difficulties.
*
* @param string $field Optional. Which field to return from the available term fields.
* Any public variables from a WP_Term object are acceptable: term_id, name, slug, and more.
* Default is 'name'.
* @return string
*/
public function get_difficulty( $field = 'name' ) {
$terms = get_the_terms( $this->get( 'id' ), 'course_difficulty' );
if ( false === $terms ) {
return '';
}
$difficulties = wp_list_pluck( $terms, $field );
return implode( ', ', $difficulties );
}
/**
* Retrieve course instructor information
*
* @since 3.13.0
*
* @param boolean $exclude_hidden Optional. If true, excludes hidden instructors from the return array. Default is `false`.
* @return array
*/
public function get_instructors( $exclude_hidden = false ) {
/**
* Filters the course's instructors list
*
* @since 3.13.0
*
* @param array $instructors Instructor data array.
* @param LLMS_Course $course Course object.
* @param boolearn $exclude_hidden If true, excludes hidden instructors from the return array.
*/
return apply_filters(
'llms_course_get_instructors',
$this->instructors()->get_instructors( $exclude_hidden ),
$this,
$exclude_hidden
);
}
/**
* Get course lessons
*
* @since 3.0.0
* @since 3.24.0 Unknown.
*
* @param string $return Optional. Type of return [ids|posts|lessons]. Default is 'lessons'.
* @return int[]|WP_Post[]|LLMS_Lesson[] The type depends on value of `$return`.
*/
public function get_lessons( $return = 'lessons' ) {
$lessons = array();
foreach ( $this->get_sections( 'sections' ) as $section ) {
$lessons = array_merge( $lessons, $section->get_lessons( 'posts' ) );
}
if ( 'ids' === $return ) {
$ret = wp_list_pluck( $lessons, 'ID' );
} elseif ( 'posts' === $return ) {
$ret = $lessons;
} else {
$ret = array_map( 'llms_get_post', $lessons );
}
return $ret;
}
/**
* Retrieve the number of course's lessons.
*
* This is less expensive than counting the result of {@see LLMS_Course::get_lessons()},
* and should be preferred when you only need to count the number of lessons of a course.
*
* @since 7.1.0
*
* @return int
*/
public function get_lessons_count() {
$query = new WP_Query(
array(
'meta_key' => '_llms_parent_course',
'meta_value' => $this->get( 'id' ),
'post_type' => 'lesson',
'posts_per_page' => -1,
'no_found_rows' => true,
'update_post_meta_cache' => false,
'update_post_term_cache' => false,
'fields' => 'ids',
'orderby' => 'ID',
'order' => 'ASC',
)
);
return $query->post_count;
}
/**
* Retrieve an array of quizzes within a course
*
* @since 3.12.0
* @since 3.16.0 Unknown.
*
* @return int[] Array of WP_Post IDs of the quizzes.
*/
public function get_quizzes() {
$quizzes = array();
foreach ( $this->get_lessons( 'lessons' ) as $lesson ) {
if ( $lesson->has_quiz() ) {
$quizzes[] = $lesson->get( 'quiz' );
}
}
return $quizzes;
}
/**
* Get course sections
*
* @since 3.0.0
* @since 3.24.0 Unknown.
*
* @param string $return Optional. Type of return [ids|posts|sections]. Default is 'sections'.
* @return int[]|WP_Post[]|LLMS_Section[] The type depends on value of `$return`.
*/
public function get_sections( $return = 'sections' ) {
$q = new WP_Query(
array(
'meta_key' => '_llms_order',
'meta_query' => array(
array(
'key' => '_llms_parent_course',
'value' => $this->id,
),
),
'order' => 'ASC',
'orderby' => 'meta_value_num',
'post_type' => 'section',
'posts_per_page' => 500,
)
);
if ( 'ids' === $return ) {
$r = wp_list_pluck( $q->posts, 'ID' );
} elseif ( 'posts' === $return ) {
$r = $q->posts;
} else {
$r = array();
foreach ( $q->posts as $p ) {
$r[] = new LLMS_Section( $p );
}
}
return $r;
}
/**
* Retrieve the number of enrolled students in the course
*
* The cached value is calculated in the `LLMS_Processor_Course_Data` background processor.
*
* If, for whatever reason, it's not found, it will be calculated on demand and saved for later use.
*
* @since 3.15.0
* @since 4.12.0 Use cached value where possible.
* @since 6.0.0 Don't access `LLMS_Student_Query` properties directly.
*
* @param boolean $skip_cache Default: `false`. Whether or not to bypass the cache. If `true`, bypasses the cache.
* @return int
*/
public function get_student_count( $skip_cache = false ) {
$count = ! $skip_cache ? $this->get( 'enrolled_students' ) : false;
/**
* Query enrolled students when `$skip_cache=true` or when there's no stored meta data.
*
* The second condition is necessary to disambiguate between a cached `0` and a `0` that's
* returned as the default value when the metadata doesn't exist.
*/
if ( false === $count || ! isset( $this->enrolled_students ) ) {
$query = new LLMS_Student_Query(
array(
'post_id' => $this->get( 'id' ),
'statuses' => array( 'enrolled' ),
'per_page' => 1,
'sort' => array(
'id' => 'ASC',
),
'count_only' => true,
)
);
$count = $query->get_count_only_result();
// Cache result for later use.
$this->set( 'enrolled_students', $count );
}
/**
* Filter the number of actively enrolled students in the course
*
* @since 4.12.0
*
* @param int $count Number of students enrolled in the course.
* @param LLMS_Course $course Instance of the course object.
*/
$count = apply_filters( 'llms_course_get_student_count', $count, $this );
return absint( $count );
}
/**
* Get an array of student IDs based on enrollment status in the course
*
* @since 3.0.0
*
* @param string|string[] $statuses Optional. List of enrollment statuses to query by. Students matching at least one of the provided statuses will be returned. Default is 'enrolled'.
* @param integer $limit Optional. Number of results. Default is `50`.
* @param integer $skip Optional. Number of results to skip (for pagination). Default is `0`.
* @return array
*/
public function get_students( $statuses = 'enrolled', $limit = 50, $skip = 0 ) {
return llms_get_enrolled_students( $this->get( 'id' ), $statuses, $limit, $skip );
}
/**
* Retrieve course tags
*
* @since 3.3.0
*
* @param array $args Array of args passed to wp_get_post_terms.
* @return array
*/
public function get_tags( $args = array() ) {
return wp_get_post_terms( $this->get( 'id' ), 'course_tag', $args );
}
/**
* Get the properties that will be explicitly excluded from the array representation of the model.
*
* This stub can be overloaded by an extending class and the property list is filterable via the
* {@see llms_get_{$this->model_post_type}_excluded_to_array_properties} filter.
*
* @since 5.4.1
*
* @return string[]
*/
protected function get_to_array_excluded_properties() {
/**
* Disable course property exclusion while running `toArray()`.
*
* This hook is intended to allow developers to retain the functionality implemented
* prior to the introduction of this hook.
*
* The LifterLMS developers consider the presence of these properties to be a bug but
* acknowledge that the removal of these properties could be seen as a backwards incompatible
* "feature" removal.
*
* This hook disables the exclusion of the following properties: 'average_grade', 'average_progress',
* 'enrolled_students', 'last_data_calc_run', and 'temp_calc_data'. Any excluded properties added in the
* future will not be excluded when using this hook.
*
* @example `add_filter( 'llms_course_to_array_disable_prop_exclusion', '__return_true' );`
*
* @since 5.4.1
*
* @param boolean $disable Whether or not to disable property exclusions.
*/
$disable = apply_filters( 'llms_course_to_array_disable_prop_exclusion', false );
if ( $disable ) {
return array();
}
return array(
'average_grade',
'average_progress',
'enrolled_students',
'last_data_calc_run',
'temp_calc_data',
);
}
/**
* Retrieve course tracks
*
* @since 3.3.0
*
* @param array $args Array of args passed to wp_get_post_terms.
* @return array
*/
public function get_tracks( $args = array() ) {
return wp_get_post_terms( $this->get( 'id' ), 'course_track', $args );
}
/**
* Retrieve an array of students currently enrolled in the course
*
* @since 1.0.0
* @since 3.0.0 Use `LLMS_Course::get_students()`.
*
* @param integer $limit Number of results.
* @param integer $skip Number of results to skip (for pagination).
* @return array
*/
public function get_enrolled_students( $limit, $skip ) {
return $this->get_students( 'enrolled', $limit, $skip );
}
/**
* Get a user's percentage completion through the course
*
* @since 1.0.0
* @since 3.17.2 Unknown.
*
* @return float
*/
public function get_percent_complete( $user_id = '' ) {
$student = llms_get_student( $user_id );
if ( ! $student ) {
return 0;
}
return $student->get_progress( $this->get( 'id' ), 'course' );
}
/**
* Retrieve an instance of the LLMS_Product for this course
*
* @since 3.3.0
*
* @return LLMS_Product
*/
public function get_product() {
return new LLMS_Product( $this->get( 'id' ) );
}
/**
* Compare a course meta info date to the current date and get a bool
*
* @since 3.0.0
*
* @param string $date_key Property key, eg "start_date" or "enrollment_end_date".
* @return boolean Returns `true` when the date is in the past and `false` when the date is in the future.
*/
public function has_date_passed( $date_key ) {
$now = current_time( 'timestamp' );
$date = $this->get_date( $date_key, 'U' );
/**
* If there's no date, we can't make a comparison
* so assume it's unset and unnecessary
* so return 'false'.
*/
if ( ! $date ) {
return false;
}
return $now > $date;
}
/**
* Determine if the course is at capacity based on course capacity settings
*
* @since 3.0.0
* @since 3.15.0 Unknown.
*
* @return boolean Returns `true` if not at capacity & `false` if at or over capacity.
*/
public function has_capacity() {
// Capacity disabled, so there is capacity.
if ( 'yes' !== $this->get( 'enable_capacity' ) ) {
return true;
}
$capacity = $this->get( 'capacity' );
// No capacity restriction set, so it has capacity.
if ( ! $capacity ) {
return true;
}
// Compare results.
return ( $this->get_student_count() < $capacity );
}
/**
* Determine if prerequisites are enabled and there are prereqs configured
*
* @since 3.0.0
* @since 3.7.5 Unknown.
*
* @param string $type Determine if a specific type of prereq exists [any|course|track].
* @return boolean Returns true if prereq is enabled and there is a prerequisite course or track.
*/
public function has_prerequisite( $type = 'any' ) {
if ( 'yes' === $this->get( 'has_prerequisite' ) ) {
if ( 'any' === $type ) {
return ( $this->get( 'prerequisite' ) || $this->get( 'prerequisite_track' ) );
} elseif ( 'course' === $type ) {
return ( $this->get( 'prerequisite' ) ) ? true : false;
} elseif ( 'course_track' === $type ) {
return ( $this->get( 'prerequisite_track' ) ) ? true : false;
}
}
return false;
}
/**
* Determine if students can access course content based on the current date
*
* @since 3.0.0
* @since 3.7.0 Unknown.
*
* @return boolean
*/
public function is_enrollment_open() {
// If no period is set, enrollment is automatically open.
if ( 'yes' !== $this->get( 'enrollment_period' ) ) {
$is_open = true;
} else {
$is_open = ( $this->has_date_passed( 'enrollment_start_date' ) && ! $this->has_date_passed( 'enrollment_end_date' ) );
}
/**
* Filters whether or not course enrollment is open.
*
* @since Unknown
*
* @param boolean $is_open Whether or not enrollment is open.
* @param LLMS_Course $course Course object.
*/
return apply_filters( 'llms_is_course_enrollment_open', $is_open, $this );
}
/**
* Determine if students can access course content based on the current date
*
* Note that enrollment does not affect the outcome of this check as regardless
* of enrollment, once a course closes content is locked.
*
* @since 3.0.0
* @since 3.7.0 Unknown.
*
* @return boolean
*/
public function is_open() {
// If a course time period is not enabled, just return true (content is accessible).
if ( 'yes' !== $this->get( 'time_period' ) ) {
$is_open = true;
} else {
$is_open = ( $this->has_date_passed( 'start_date' ) && ! $this->has_date_passed( 'end_date' ) );
}
/**
* Filters whether or not the course is considered open based on the current date.
*
* @since Unknown
*
* @param boolean $is_open Whether or not enrollment is open.
* @param LLMS_Course $course Course object.
*/
return apply_filters( 'llms_is_course_open', $is_open, $this );
}
/**
* Determine if a prerequisite is completed for a student
*
* @since 3.0.0
*
* @param string $type Type of prereq [course|track].
* @return boolean
*/
public function is_prerequisite_complete( $type = 'course', $student_id = null ) {
if ( ! $student_id ) {
$student_id = get_current_user_id();
}
// No user or no prereqs so no reason to proceed.
if ( ! $student_id || ! $this->has_prerequisite( $type ) ) {
return false;
}
$prereq_id = $this->get_prerequisite_id( $type );
// No prereq id of this type, no need to proceed.
if ( ! $prereq_id ) {
return false;
}
// Setup student.
$student = new LLMS_Student( $student_id );
return $student->is_complete( $prereq_id, $type );
}
/**
* Save instructor information
*
* @since 3.13.0
*
* @param array $instructors Array of course instructor information.
*/
public function set_instructors( $instructors = array() ) {
return $this->instructors()->set_instructors( $instructors );
}
/**
* Add data to the course model when converted to array
*
* Called before data is sorted and returned by $this->jsonSerialize().
*
* @since 3.3.0
* @since 3.8.0 Unknown.
*
* @param array $arr Data to be serialized.
* @return array
*/
public function toArrayAfter( $arr ) {
$product = $this->get_product();
$arr['access_plans'] = array();
foreach ( $product->get_access_plans( false, false ) as $p ) {
$arr['access_plans'][] = $p->toArray();
}
$arr['sections'] = array();
foreach ( $this->get_sections() as $s ) {
$arr['sections'][] = $s->toArray();
}
$arr['categories'] = $this->get_categories(
array(
'fields' => 'names',
)
);
$arr['tags'] = $this->get_tags(
array(
'fields' => 'names',
)
);
$arr['tracks'] = $this->get_tracks(
array(
'fields' => 'names',
)
);
$arr['difficulty'] = $this->get_difficulty();
return $arr;
}
}
================================================
FILE: includes/models/model.llms.instructor.php
================================================
<?php
/**
* LifterLMS Instructor
*
* @package LifterLMS/Models/Classes
*
* @since 3.13.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Instructor model class
*
* Manages data and interactions with a LifterLMS Instructor or Instructor's Assistant.
*
* @since 3.13.0
* @since 3.30.3 Fixed typo in "description" key of the the toArray() method.
* @since 3.32.0 Add validation to data passed into the `get_students()` method.
* @since 3.34.0 Fix issue causing `get_assistants()` to return assistants to the currently logged in user instead of using the user id of the current object.
* Add `has_student()` method.
*/
class LLMS_Instructor extends LLMS_Abstract_User_Data {
/**
* Add a parent instructor to an assistant instructor
*
* @param mixed $parent_ids WP User ID of the parent instructor or array of User IDs to add multiple
* @return boolean
* @since 3.13.0
* @version 3.14.4
*/
public function add_parent( $parent_ids ) {
// Get existing parents.
$parents = $this->get( 'parent_instructors' );
// No existing, use an empty array as the default.
if ( ! $parents ) {
$parents = array();
}
if ( ! is_array( $parent_ids ) ) {
$parent_ids = array( $parent_ids );
}
// Make ints.
$parent_ids = array_map( 'absint', $parent_ids );
// Add the new parents.
$parents = array_unique( array_merge( $parents, $parent_ids ) );
// Remove duplicates and save.
return $this->set( 'parent_instructors', array_unique( $parents ) );
}
/**
* Retrieve an array of user ids for assistant instructors attached to the instructor
*
* @since 3.14.4
* @since 3.34.0 Uses object ID instead of current user id.
*
* @return int[]
*/
public function get_assistants() {
global $wpdb;
$results = $wpdb->get_col(
$wpdb->prepare(
"SELECT user_id FROM {$wpdb->usermeta}
WHERE meta_key = 'llms_parent_instructors'
AND meta_value LIKE %s;",
'%i:' . $this->get_id() . ';%'
)
); // db call ok; no-cache ok.
return $results;
}
/**
* Retrieve instructor's courses
*
* @uses $this->get_posts()
* @param array $args query argument, see $this->get_posts()
* @param string $return return format, see $this->get_posts()
* @return mixed
* @since 3.13.0
* @version 3.13.0
*/
public function get_courses( $args = array(), $return = 'llms_posts' ) {
$args = wp_parse_args(
$args,
array(
'post_type' => 'course',
)
);
return $this->get_posts( $args, $return );
}
/**
* Retrieve instructor's memberships
*
* @uses $this->get_posts()
* @param array $args query argument, see $this->get_posts()
* @param string $return return format, see $this->get_posts()
* @return mixed
* @since 3.13.0
* @version 3.13.0
*/
public function get_memberships( $args = array(), $return = 'llms_posts' ) {
$args = wp_parse_args(
$args,
array(
'post_type' => 'llms_membership',
)
);
return $this->get_posts( $args, $return );
}
/**
* Retrieve instructor's posts (courses and memberships, mixed)
*
* @param array $args query arguments passed to WP_Query
* @param string $return return format [llms_posts|ids|posts|query]
* @return mixed
* @since 3.13.0
* @version 3.13.0
*/
public function get_posts( $args = array(), $return = 'llms_posts' ) {
$serialized_id = serialize( // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize
array(
'id' => $this->get_id(),
)
);
$serialized_id = str_replace( array( 'a:1:{', '}' ), '', $serialized_id );
$args = wp_parse_args(
$args,
array(
'post_type' => array( 'course', 'llms_membership' ),
'post_status' => 'publish',
'meta_query' => array(
array(
'compare' => 'LIKE',
'key' => '_llms_instructors',
'value' => $serialized_id,
),
),
)
);
$query = new WP_Query( $args );
if ( 'llms_posts' === $return ) {
$ret = array();
foreach ( $query->posts as $post ) {
$ret[] = llms_get_post( $post );
}
return $ret;
} elseif ( 'ids' === $return ) {
return wp_list_pluck( $query->posts, 'ID' );
} elseif ( 'posts' === $return ) {
return $query->posts;
}
// If 'query' === $return.
return $query;
}
/**
* Retrieve instructor's students
*
* @since 3.13.0
* @since 3.32.0 Validate `post_id` data passed into this function to ensure only students
* in courses/memberships for this instructor are returned.
* @since 6.0.0 Don't access `LLMS_Student_Query` properties directly.
*
* @see LLMS_Student_Query
*
* @param array $args Array of args passed to LLMS_Student_Query.
* @return LLMS_Student_Query
*/
public function get_students( $args = array() ) {
$ids = $this->get_posts(
array(
'posts_per_page' => -1,
),
'ids'
);
// If post IDs were passed we need to verify they're IDs that the instructor has access to.
if ( ! empty( $args['post_id'] ) ) {
$args['post_id'] = ! is_array( $args['post_id'] ) ? array( $args['post_id'] ) : $args['post_id'];
$args['post_id'] = array_intersect( $args['post_id'], $ids );
} else {
// No post IDs passed in, query all of the instructor's posts.
$args['post_id'] = $ids;
}
// The instructor has no posts, so we want to force no results.
// @todo add an instructor query parameter to the student query.
if ( empty( $args['post_id'] ) ) {
$args['per_page'] = 0;
$args['no_found_rows'] = true;
}
return new LLMS_Student_Query( $args );
}
/**
* Determines if the instructor is an instructor to a specific student.
*
* @since 3.34.0
*
* @param LLMS_Student|WP_User|int $student Student or user object or WP User ID.
* @return bool
*/
public function has_student( $student ) {
$student = llms_get_student( $student );
if ( ! $student ) {
return false;
}
$ids = $this->get_posts(
array(
'posts_per_page' => -1,
),
'ids'
);
if ( ! $ids ) {
return false;
}
return $student->is_enrolled( $ids, 'any' );
}
/**
* Determine if the user is an instructor on a post
*
* @param int $post_id WP Post ID of a course or membership
* @return boolean
* @since 3.13.0
* @version 3.13.0
*/
public function is_instructor( $post_id = null ) {
$ret = false;
// Use current post if no post is set.
if ( ! $post_id ) {
global $post;
if ( ! $post ) {
return apply_filters( 'llms_instructor_is_instructor', $ret, $post_id, $this );
}
$post_id = $post->ID;
}
$check_id = false;
switch ( get_post_type( $post_id ) ) {
case 'course':
$check_id = $post_id;
break;
case 'llms_membership':
$check_id = $post_id;
break;
case 'llms_question':
$question = llms_get_post( $post_id );
$check_id = array();
foreach ( $question->get_quizzes() as $qid ) {
$course = llms_get_post_parent_course( $qid );
if ( $course ) {
$check_id[] = $course->get( 'id' );
}
}
break;
default:
$course = llms_get_post_parent_course( $post_id );
if ( $course ) {
$check_id = $course->get( 'id' );
}
}
if ( $check_id ) {
$check_ids = ! is_array( $check_id ) ? array( $check_id ) : $check_id;
$query = $this->get_posts(
array(
'post__in' => $check_ids,
'posts_per_page' => 1,
),
'query'
);
$ret = $query->have_posts();
}
return apply_filters( 'llms_instructor_is_instructor', $ret, $post_id, $check_id, $this );
}
/**
* Used by exporter / cloner to get instructor data
*
* @since 3.16.11
* @since 3.30.3 Renamed "descrpition" key to "description".
*
* @return array
*/
public function toArray() {
return array(
'description' => $this->get( 'description' ),
'email' => $this->get( 'user_email' ),
'first_name' => $this->get( 'first_name' ),
'id' => $this->get_id(),
'last_name' => $this->get( 'last_name' ),
);
}
}
================================================
FILE: includes/models/model.llms.lesson.php
================================================
<?php
/**
* LifterLMS Lesson Model
*
* @package LifterLMS/Models/Classes
*
* @since 1.0.0
* @version 6.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Lesson model class
*
* @since 1.0.0
* @since 3.29.0 Unknown.
* @since 3.36.2 When getting the lesson's available date: add available number of days to the course start date only if there's a course start date.
* @since 4.0.0 Remove deprecated methods.
* @since 4.4.0 Improve the query used to retrieve the previous/next so that we don't miss sibling lessons within the same section
* if the previous/next one(s) status is (are) not published. Make sure to always return `false` if no previous lesson is found.
* Use strict comparisons where needed.
* @since 5.3.0 Move audio and video embed methods to `LLMS_Trait_Audio_Video_Embed`.
* @since 5.7.0 Deprecated the `LLMS_Lesson::get_order()` method in favor of the `LLMS_Lesson::get( 'order' )` method.
* Deprecated the `LLMS_Lesson::get_parent_course()` method in favor of the `LLMS_Lesson::get( 'parent_course' )` method.
* Deprecated the `LLMS_Lesson::set_parent_course()` method in favor of the `LLMS_Lesson::set( 'parent_course', $course_id )` method.
*
* @property string $audio_embed URL to an oEmbed enable audio URL.
* @property string $date_available Date when lesson becomes available, applies when $drip_method is "date".
* @property int $days_before_available The number of days before the lesson is available, applies when $drip_method is "enrollment" or "start".
* @property string $drip_method What sort of drip method to utilize [''(none)|date|enrollment|start|prerequisite].
* @property string $free_lesson Yes if the lesson is free [yes|no].
* @property string $has_prerequisite Yes if the lesson has a prereq lesson [yes|no].
* @property int $order Lesson's order within its parent section.
* @property int $points Number of points assigned to the lesson, used to calculate the weight of the lesson when grading courses.
* @property int $prerequisite WP Post ID of the prerequisite lesson, only if $has_prerequisite is 'yes'.
* @property int $parent_course WP Post ID of the course the lesson belongs to.
* @property int $parent_section WP Post ID of the section the lesson belongs to.
* @property int $quiz WP Post ID of the llms_quiz.
* @property string $quiz_enabled Whether or not the attached quiz is enabled for students [yes|no].
* @property string $require_passing_grade Whether of not students have to pass the quiz to advance to the next lesson [yes|no].
* @property string $require_assignment_passing_grade Whether of not students have to pass the assignment to advance to the next lesson [yes|no].
* @property string $time_available Optional time to make lesson available on $date_available when $drip_method is "date".
* @property string $video_embed URL to an oEmbed enable video URL.
* @property string $content_added_in_builder Whether content was (at least initially) added within the page builder.
*/
class LLMS_Lesson extends LLMS_Post_Model {
use LLMS_Trait_Audio_Video_Embed;
protected $properties = array(
'order' => 'absint',
// Drippable.
'days_before_available' => 'absint',
'date_available' => 'text',
'drip_method' => 'text',
'time_available' => 'text',
// Parent element.
'parent_course' => 'absint',
'parent_section' => 'absint',
'free_lesson' => 'yesno',
'has_prerequisite' => 'yesno',
'prerequisite' => 'absint',
'require_passing_grade' => 'yesno',
'require_assignment_passing_grade' => 'yesno',
'points' => 'absint',
'content_added_in_builder' => 'yesno',
// Quizzes.
'quiz' => 'absint',
'quiz_enabled' => 'yesno',
);
/**
* Associative array of default property values
*
* @since 3.24.0
* @var array
*/
protected $property_defaults = array(
'points' => 1,
);
/**
* Name of the post type as stored in the database
*
* @since unknown
* @var string
*/
protected $db_post_type = 'lesson';
/**
* Post type name
*
* To use unprefixed post type names for filters and more.
*
* @since unknown
* @var string
*/
protected $model_post_type = 'lesson';
/**
* Constructor for this class and the traits it uses.
*
* @since 5.3.0
*
* @param string|int|LLMS_Post_Model|WP_Post $model 'new', WP post id, instance of an extending class, instance of WP_Post.
* @param array $args Args to create the post, only applies when $model is 'new'.
*/
public function __construct( $model, $args = array() ) {
$this->construct_audio_video_embed();
parent::__construct( $model, $args );
}
/**
* Get the date a lesson became or will become available according to element drip settings
*
* If there are no drip settings, the published date of the element will be returned.
*
* @since 3.16.0
* @since 3.36.2 Add available number of days to the course start date only if there's a course start date.
* @since 5.7.0 Replaced the call to the deprecated `LLMS_Lesson::get_parent_course()` method with `LLMS_Lesson::get( 'parent_course' )`.
*
* @param string $format Optional. Date format (passed to date_i18n()). Default is empty string.
* When not specified the WP Core date + time formats will be used.
* @return string
*/
public function get_available_date( $format = '' ) {
if ( ! $format ) {
$format = get_option( 'date_format' ) . ' ' . get_option( 'time_format' );
}
$drip_method = $this->get( 'drip_method' );
$days = $this->get( 'days_before_available' ) * DAY_IN_SECONDS;
// Default availability is the element's post date.
$available = $this->get_date( 'date', 'U' );
// get the course setting first, if any.
$course = $this->get_course();
if ( $course && 'yes' === $course->get( 'lesson_drip' ) ) {
$course_drip_method = $course->get( 'drip_method' );
switch ( $course_drip_method ) {
case 'start':
$ignore_lessons = intval( $course->get( 'ignore_lessons' ) );
$course_lessons = $course->get_lessons( 'ids' );
$lesson_number = array_search( $this->get( 'id' ), $course_lessons ) + 1;
$course_days = $course->get( 'days_before_available' ) * DAY_IN_SECONDS;
$course_start_date = $course->get_date( 'start_date', 'U' );
$course_enrollment_date = llms_get_student() ? llms_get_student()->get_enrollment_date( $course->get( 'id' ), 'enrolled', 'U' ) : false;
// If it's one of the first X lessons in a course, return availability based on published date.
if ( $lesson_number <= $ignore_lessons ) {
return date_i18n( $format, $available );
}
if ( $course_start_date || $course_enrollment_date ) {
$available = ( ( $lesson_number - $ignore_lessons ) * $course_days ) + ( $course_start_date ? $course_start_date : $course_enrollment_date );
return date_i18n( $format, $available );
}
break;
}
}
switch ( $drip_method ) {
// Available on a specific date / time.
case 'date':
$date = $this->get( 'date_available' );
$time = $this->get( 'time_available' );
if ( ! $time ) {
$time = '12:00 AM';
}
$available = strtotime( $date . ' ' . $time );
break;
// Available # of days after enrollment in course.
case 'enrollment':
$student = llms_get_student();
if ( $student ) {
$available = $days + $student->get_enrollment_date( $this->get( 'parent_course' ), 'enrolled', 'U' );
}
break;
case 'prerequisite':
if ( $this->has_prerequisite() ) {
$student = llms_get_student();
if ( $student ) {
$date = $student->get_completion_date( $this->get( 'prerequisite' ), 'U' );
if ( $date ) {
$available = $days + $date;
}
}
}
break;
// Available # of days after course start date.
case 'start':
$course = $this->get_course();
$course_start_date = $course ? $course->get_date( 'start_date', 'U' ) : '';
if ( $course_start_date ) {
$available = $days + $course_start_date;
}
break;
}
return date_i18n( $format, $available );
}
/**
* Retrieve an instance of LLMS_Course for the element's parent course
*
* @since 3.16.0
*
* @return LLMS_Course|null Returns `null` if the lesson is not attached to any courses.
*/
public function get_course() {
$course_id = $this->get( 'parent_course' );
if ( ! $course_id ) {
return null;
}
return llms_get_post( $course_id );
}
/**
* An array of default arguments to pass to $this->create() when creating a new post.
*
* @since 3.13.0
* @since 6.3.0 Retrieve `comment_status` parameter value from the global discussion settings.
*
* @param array $args Optional. Args of data to be passed to `wp_insert_post()`. Default `null`.
* @return array
*/
protected function get_creation_args( $args = null ) {
// Allow nothing to be passed in.
if ( empty( $args ) ) {
$args = array();
}
// Backwards compat to original 3.0.0 format when just a title was passed in.
if ( is_string( $args ) ) {
$args = array(
'post_title' => $args,
);
}
$post_type = $this->get( 'db_post_type' );
$args = wp_parse_args(
$args,
array(
'comment_status' => get_default_comment_status( $post_type ),
'ping_status' => 'closed',
'post_author' => get_current_user_id(),
'post_content' => '',
'post_excerpt' => '',
'post_status' => 'publish',
'post_title' => '',
'post_type' => $post_type,
)
);
/**
* Filter the model creation args
*
* The dynamic portion of this hook, `$this->model_post_type`, refers to model post type.
*
* @since unknown
*
* @param array $args Args of data to be passed to `wp_insert_post()`.
* @param LLMS_Lesson $lesson Instance of the LLMS_Lesson.
*/
return apply_filters( "llms_{$this->model_post_type}_get_creation_args", $args, $this );
}
/**
* Retrieves the lesson's order within its parent section
*
* @since 1.0.0
* @since 3.0.0 Unknown.
* @deprecated 5.7.0 Use `LLMS_Lesson::get( 'order' )`, via {@see LLMS_Post_Model::get()}, instead.
*
* @return int
*/
public function get_order() {
llms_deprecated_function( __METHOD__, '5.7.0', __CLASS__ . '::get( \'order\' )' );
return $this->get( 'order' );
}
/**
* Get parent course id
*
* @since 1.0.0
* @since 3.0.0 Unknown.
* @deprecated 5.7.0 Use `LLMS_Lesson::get( 'parent_course' )`, via {@see LLMS_Post_Model::get()}, instead.
*
* @return int
*/
public function get_parent_course() {
llms_deprecated_function( __METHOD__, '5.7.0', __CLASS__ . '::get( \'parent_course\' )' );
return absint( get_post_meta( $this->get( 'id' ), '_llms_parent_course', true ) );
}
/**
* Get parent section id
*
* @since 1.0.0
* @since 3.0.0 Unknown.
*
* @return int
*/
public function get_parent_section() {
return absint( get_post_meta( $this->get( 'id' ), '_llms_parent_section', true ) );
}
/**
* Get CSS classes to display on the course syllabus .llms-lesson-preview element
*
* @since 3.0.0
*
* @return string
*/
public function get_preview_classes() {
$classes = '';
if ( $this->is_complete() ) {
$classes = ' is-complete has-icon';
} elseif ( apply_filters( 'lifterlms_display_lesson_complete_placeholders', true ) && llms_is_user_enrolled( get_current_user_id(), $this->get( 'id' ) ) ) {
$classes = ' is-incomplete has-icon';
} elseif ( $this->is_free() ) {
$classes = ' is-free has-icon';
} else {
$classes = ' is-incomplete';
}
if ( get_queried_object_id() === intval( $this->get( 'id' ) ) ) {
$classes .= ' current-lesson';
}
return apply_filters( 'llms_get_preview_classes', $classes );
}
/**
* Get HTML of the icon to display in the .llms-lesson-preview element on the syllabus
*
* @since 3.0.0
*
* @return string
*/
public function get_preview_icon_html() {
$html = '';
if ( llms_is_user_enrolled( get_current_user_id(), $this->get( 'id' ) ) ) {
if ( $this->is_complete() || apply_filters( 'lifterlms_display_lesson_complete_placeholders', true ) ) {
$html = '<span class="llms-lesson-complete"><i class="fa fa-' . apply_filters( 'lifterlms_lesson_complete_icon', 'check-circle' ) . '"></i></span>';
}
} elseif ( $this->is_free() ) {
$html = '<span class="llms-icon-free">' . __( 'FREE', 'lifterlms' ) . '</span>';
}
return apply_filters( 'llms_get_preview_icon_html', $html );
}
/**
* Retrieve an instance of LLMS_Course for the elements's parent section
*
* @since 3.16.0
*
* @return LLMS_Section|null Returns `null` it the lesson is not attached to any sections.
*/
public function get_section() {
$section_id = $this->get( 'parent_section' );
if ( ! $section_id ) {
return null;
}
return llms_get_post( $section_id );
}
/**
* Retrieve an object for the assigned quiz (if a quiz is assigned)
*
* @since 3.3.0
* @since 3.16.0 Unknown.
*
* @return LLMS_Quiz|false Returns `false` if the lesson has no existing quiz assigned.
*/
public function get_quiz() {
if ( $this->has_quiz() ) {
$quiz = llms_get_post( $this->get( 'quiz' ) );
if ( $quiz ) {
return $quiz;
}
}
return false;
}
/**
* Determine if lesson prereq is enabled and a prereq lesson is selected
*
* @since 3.0.0
* @since 4.4.0 Use strict comparison.
*
* @return boolean
*/
public function has_prerequisite() {
return ( 'yes' === $this->get( 'has_prerequisite' ) && $this->get( 'prerequisite' ) );
}
/**
* Determine if the slug (post name) of a lesson has been modified
*
* Ensures that lessons created via the builder with "New Lesson" as the title (default slug "new-lesson-{$num}")
* have their slug renamed when the title is renamed for the first time.
*
* @since 3.14.8
*
* @return bool
*/
public function has_modified_slug() {
$default = sanitize_title( __( 'New Lesson', 'lifterlms' ) );
return ( false === strpos( $this->get( 'name' ), $default ) );
}
/**
* Determine if a quiz is assigned to this lesson
*
* @since 3.3.0
* @since 3.29.0 Unknown.
*
* @return boolean
*/
public function has_quiz() {
return $this->get( 'quiz' ) ? true : false;
}
/**
* Determine if an element is available based on drip settings
*
* If no settings, this will return true if the posts's published
* date is in the past.
*
* @since 3.16.0
*
* @return boolean
*/
public function is_available() {
$drip_method = $this->get( 'drip_method' );
$course_drip_method = $this->get_course() ? 'yes' === $this->get_course()->get( 'lesson_drip' ) && $this->get_course()->get( 'drip_method' ) : '';
// Drip is not enabled, so the element is available.
if ( ! $drip_method && ! $course_drip_method ) {
return true;
}
$available = $this->get_available_date( 'U' );
$now = llms_current_time( 'timestamp' );
return ( $now >= $available );
}
/**
* Determine if the lesson has been completed by a specific user
*
* @since 1.0.0
* @since 3.0.0 Refactored to utilize LLMS_Student->is_complete().
* Added $user_id param.
*
* @param int $user_id Optional. WP_User ID of a student. Default `null`.
* If not provided, or a falsy is provided, will fall back on the current user id.
* @return bool
*/
public function is_complete( $user_id = null ) {
$user_id = $user_id ? $user_id : get_current_user_id();
// Incomplete b/c no user.
if ( ! $user_id ) {
return false;
}
$student = new LLMS_Student( $user_id );
return $student->is_complete( $this->get( 'id' ), 'lesson' );
}
/**
* Determine if a the lesson is marked as "free"
*
* @since 3.0.0
*
* @return boolean
*/
public function is_free() {
return ( 'yes' === $this->get( 'free_lesson' ) );
}
/**
* Determine if the lesson is an orphan
*
* @since 3.14.8
* @since 4.4.0 Use `in_array()` with strict comparison to decide whether the parent course/section post status
* is in a set of allowed statuses.
* @return bool
*/
public function is_orphan() {
$statuses = array( 'publish', 'future', 'draft', 'pending', 'private', 'auto-draft' );
foreach ( array( 'course', 'section' ) as $parent ) {
$parent_id = $this->get( sprintf( 'parent_%s', $parent ) );
if ( ! $parent_id ) {
return true;
} elseif ( ! in_array( get_post_status( $parent_id ), $statuses, true ) ) {
return true;
}
}
return false;
}
/**
* Determines if a quiz is enabled for the lesson
*
* Lesson must have a quiz and the quiz must be enabled.
*
* @since 3.16.0
* @since 3.18.0
*
* @return bool
*/
public function is_quiz_enabled() {
return ( $this->has_quiz() && llms_parse_bool( $this->get( 'quiz_enabled' ) ) && 'publish' === get_post_status( $this->get( 'quiz' ) ) );
}
/**
* Add data to the course model when converted to array
*
* Called before data is sorted and returned by $this->jsonSerialize().
*
* @since 3.3.0
* @since 3.16.0 Unknown.
*
* @param array $arr Data to be serialized.
* @return array
*/
public function toArrayAfter( $arr ) {
if ( $this->has_quiz() ) {
$quiz = $this->get_quiz();
if ( $quiz ) {
$arr['quiz'] = $quiz->toArray();
}
}
return $arr;
}
/**
* Update object data
*
* @since unknown.
*
* @param array $data Data to update as key=>val.
* @return array
*/
public function update( $data ) {
$updated_values = array();
foreach ( $data as $key => $value ) {
$method = 'set_' . $key;
if ( method_exists( $this, $method ) ) {
$updated_value = $this->$method( $value );
$updated_values[ $key ] = $updated_value;
}
}
return $updated_values;
}
/**
* Set lesson title
*
* @since unknown
*
* @param string $title The lesson title.
* @return false|array False if the title couldn't be updated. An array of the type
* array(
* 'id' => lesson id,
* 'title' => the new title,
* )
* otherwise.
*/
public function set_title( $title ) {
return LLMS_Post_Handler::update_title( $this->id, $title );
}
/**
* Set lesson's excerpt
*
* @since unknown
*
* @param string $excerpt The lesson excerpt.
* @return false|array False if the title couldn't be updated. An array of the type
* array(
* 'id' => lesson id,
* 'post_excerpt' => the new excerpt,
* )
* otherwise.
*/
public function set_excerpt( $excerpt ) {
return LLMS_Post_Handler::update_excerpt( $this->id, $excerpt );
}
/**
* Set parent section
*
* Sets parent section in database.
*
* @since unknown
*
* @param int $section_id The WP Post ID of the section to be set as parent.
* @return mixed $meta If meta didn't exist returns the meta_id else t/f if update success.
* Returns `false` if the provided section id value was already set.
*/
public function set_parent_section( $section_id ) {
return update_post_meta( $this->id, '_llms_parent_section', $section_id );
}
/**
* Set order
*
* Sets lesson order within the parent sectionin database
*
* @since unknown
*
* @param int $order The new order
* @return mixed $meta If meta didn't exist returns the meta_id else t/f if update success.
* Returns `false` if the provided order value was already set.
*/
public function set_order( $order ) {
return update_post_meta( $this->id, '_llms_order', $order );
}
/**
* Set parent course
*
* Sets parent course in database
*
* @since Unknown Introduced.
* @deprecated 5.7.0 Use `LLMS_Lesson::set( 'parent_course', $course_id )`, via {@see LLMS_Post_Model::set()}, instead.
*
* @param int $course_id The WP Post ID of the course to be set as parent.
* @return int|bool If meta didn't exist returns the meta_id else t/f if update success.
* Returns `false` if the course id value was already set.
*/
public function set_parent_course( $course_id ) {
llms_deprecated_function( __METHOD__, '5.7.0', __CLASS__ . '::set( \'parent_course\', $course_id )' );
return update_post_meta( $this->id, '_llms_parent_course', $course_id );
}
/**
* Get the lesson prerequisite
*
* @since unknown
*
* @return int ID of the prerequisite post.
*/
public function get_prerequisite() {
if ( $this->has_prerequisite ) {
return $this->prerequisite;
} else {
return false;
}
}
/**
* Get whether the lesson has a content set
*
* @since unknown
*
* @return boolean
*/
public function has_content() {
if ( ! empty( $this->post->post_content ) ) {
return true;
} else {
return false;
}
}
/**
* Get next lesson ID
*
* @since 1.0.0
* @since 3.24.0
* @since 4.4.0 Improve query so that unpublished siblings do not break expected results.
* @since 4.4.2 Use a numeric comparison for the previous position meta query.
* @since 4.10.2 Refactor to use helper method `get_sibling()`.
*
* @return false|int ID of the next lesson, if any, `false` otherwise.
*/
public function get_next_lesson() {
return $this->get_sibling( 'next' );
}
/**
* Get previous lesson ID
*
* @since 1.0.0
* @since 3.24.0 Unknown.
* @since 4.4.0 Improve query so that unpublished siblings do not break expected results.
* Use strict comparisons where needed.
* Make sure to always return `false` if no previous lesson is found.
* @since 4.4.2 Use a numeric comparison for the previous position meta query.
* @since 4.10.2 Refactor to use helper method `get_sibling()`.
*
* @return false|int WP_Post ID of the previous lesson or `false` if one doesn't exist.
*/
public function get_previous_lesson() {
return $this->get_sibling( 'prev' );
}
/**
* Retrieve the sibling lesson in a specified direction
*
* @since 4.10.2
*
* @param string $direction Direction of navigation. Accepts either "prev" or "next".
* @return false|int WP_Post ID of the sibling lesson or `false` if one doesn't exist.
*/
protected function get_sibling( $direction ) {
$lesson = $this->get_sibling_lesson_query( $direction );
// No lesson found within the section, look within the sibling section.
if ( ! $lesson ) {
$lesson = $this->get_sibling_section_query( $direction );
}
return $lesson;
}
/**
* Performs a query to retrieve a sibling lesson in the specified direction
*
* This method tries to locate a sibling lesson in the next or previous position.
*
* It *does not* account for lessons in a sibling section. For example, if the lesson
* is the last lesson in a section this function will *not* locate the first lesson
* in the course's next section. For this reason this function should not be relied upon
* alone.
*
* @since 4.10.2
* @since 5.7.0 Replaced the call to the deprecated `LLMS_Lesson::get_order()` method with `LLMS_Lesson::get( 'order' )`.
*
* @param string $direction Direction of navigation. Accepts either "prev" or "next".
* @return false|int WP_Post ID of the sibling lesson or `false` if one doesn't exist.
*/
protected function get_sibling_lesson_query( $direction ) {
$curr_position = $this->get( 'order' );
// First cannot have a previous.
if ( 1 === $curr_position && 'prev' === $direction ) {
return false;
}
if ( 'next' === $direction ) {
$sibling_position = $curr_position + 1;
$order = 'ASC';
$comparator = '>=';
} elseif ( 'prev' === $direction ) {
$sibling_position = $curr_position - 1;
$order = 'DESC';
$comparator = '<=';
}
$args = array(
'posts_per_page' => 1,
'post_type' => 'lesson',
'nopaging' => true,
'post_status' => 'publish',
'meta_key' => '_llms_order', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'orderby' => 'meta_value_num',
'order' => $order,
'meta_query' => array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
'relation' => 'AND',
array(
'key' => '_llms_parent_section',
'value' => $this->get_parent_section(),
'compare' => '=',
),
array(
'key' => '_llms_order',
'value' => $sibling_position,
'compare' => $comparator,
'type' => 'numeric',
),
),
);
/**
* Filter the WP_Query arguments used to locate a sibling lesson for the specified lesson.
*
* @since 4.10.2
*
* @param array $args WP_Query arguments array.
* @param string $direction Navigation direction. Either "prev" or "next".
* @param LLMS_Lesson $lesson Current lesson object.
*/
$args = apply_filters( 'llms_lesson_get_sibling_lesson_query_args', $args, $direction );
$lessons = get_posts( $args );
return empty( $lessons ) ? false : $lessons[0]->ID;
}
/**
* Performs a query to retrieve sibling lessons from the lesson's adjacent section
*
* This will retrieve either the first lesson from the course's next section or the last
* lesson from the course's previous section.
*
* @since 4.10.2
* @since 4.11.0 Fix PHP Notice when trying to retrieve next lesson from an empty section.
* @since 5.7.0 Replaced the call to the deprecated `LLMS_Section::get_order()` method with `LLMS_Section::get( 'order' )`.
*
* @param string $direction Direction of navigation. Accepts either "prev" or "next".
* @return false|int WP_Post ID of the sibling lesson or `false` if one doesn't exist.
*/
protected function get_sibling_section_query( $direction ) {
$sibling_lesson = false;
$curr_section = $this->get_section();
// Ensure we're not working with an orphan.
if ( $curr_section ) {
$curr_position = $curr_section->get( 'order' );
// First cannot have a previous.
if ( 1 === $curr_position && 'prev' === $direction ) {
return false;
}
if ( 'next' === $direction ) {
$sibling_position = $curr_position + 1;
$order = 'ASC';
} elseif ( 'prev' === $direction ) {
$sibling_position = $curr_position - 1;
$order = 'DESC';
}
$args = array(
'post_type' => 'section',
'posts_per_page' => 1,
'nopaging' => true,
'meta_key' => '_llms_order', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'orderby' => 'meta_value_num',
'order' => $order,
'meta_query' => array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
'relation' => 'AND',
array(
'key' => '_llms_parent_course',
'value' => $this->get( 'parent_course' ),
'compare' => '=',
),
array(
'key' => '_llms_order',
'value' => $sibling_position,
'compare' => '=',
),
),
);
/**
* Filter the WP_Query arguments used to locate a sibling lesson from a sibling section for the specified lesson.
*
* @since 4.10.2
*
* @param array $args WP_Query arguments array.
* @param string $direction Navigation direction. Either "prev" or "next".
* @param LLMS_Lesson $lesson Current lesson object.
*/
$args = apply_filters( 'llms_lesson_get_sibling_section_query_args', $args, $direction, $this );
$sections = get_posts( $args );
if ( ! empty( $sections ) ) {
$sibling_section = llms_get_post( $sections[0]->ID );
$lessons = $sibling_section ? $sibling_section->get_lessons( 'posts' ) : array( false );
$sibling_lesson = 'next' === $direction ? reset( $lessons ) : end( $lessons );
}
}
return $sibling_lesson instanceof WP_Post ? $sibling_lesson->ID : $sibling_lesson;
}
}
================================================
FILE: includes/models/model.llms.membership.php
================================================
<?php
/**
* LifterLMS Membership Model
*
* @package LifterLMS/Models/Classes
*
* @since 3.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Membership model class
*
* @since 3.0.0
* @since 3.30.0 Added optional argument to `add_auto_enroll_courses()` method.
* @since 3.32.0 Added `get_student_count()` method.
* @since 3.36.3 Added `get_categories()`, `get_tags()` and `toArrayAfter()` methods.
* @since 3.38.1 Added methods for retrieving posts associated with the membership.
* @since 4.0.0 Added MySQL 8.0 compatibility.
* @since 5.2.1 Check for an empty sales page URL or ID.
* @since 5.3.0 Move sales page methods to `LLMS_Trait_Sales_Page`.
*
* @property string $audio_embed URL to an oEmbed enable audio URL.
* @property int[] $auto_enroll Array of course IDs that users will be autoenrolled in upon successful enrollment in this membership.
* @property array $instructors Course instructor user information.
* @property string $restriction_redirect_type What type of redirect action to take when content is restricted by this membership [none|membership|page|custom].
* @property int $redirect_page_id WP Post ID of a page to redirect users to when $restriction_redirect_type is 'page'.
* @property string $redirect_custom_url Arbitrary URL to redirect users to when $restriction_redirect_type is 'custom'.
* @property string $restriction_add_notice Whether or not to add an on screen message when content is restricted by this membership [yes|no].
* @property string $restriction_notice Notice to display when $restriction_add_notice is 'yes'.
* @property string $featured_pricing User defined additional pricing information.
* @property int $sales_page_content_page_id WP Post ID of the WP page to redirect to when $sales_page_content_type is 'page'.
* @property string $sales_page_content_type Sales page behavior [none,content,page,url].
* @property string $sales_page_content_url Redirect URL for a sales page, when $sales_page_content_type is 'url'.
* @property string $video_embed URL to an oEmbed enable video URL.
*/
class LLMS_Membership extends LLMS_Post_Model implements LLMS_Interface_Post_Instructors {
use LLMS_Trait_Audio_Video_Embed;
use LLMS_Trait_Sales_Page;
/**
* Membership post meta.
*
* @var array
*/
protected $properties = array(
'auto_enroll' => 'array',
'instructors' => 'array',
'redirect_page_id' => 'absint',
'restriction_add_notice' => 'yesno',
'restriction_notice' => 'html',
'restriction_redirect_type' => 'text',
'redirect_custom_url' => 'text',
'featured_pricing' => 'html',
'tile_featured_video' => 'yesno',
);
/**
* Database post type.
*
* @var string
*/
protected $db_post_type = 'llms_membership';
/**
* Model name.
*
* @var string
*/
protected $model_post_type = 'membership';
/**
* Constructor for this class and the traits it uses.
*
* @since 5.3.0
*
* @param string|int|LLMS_Post_Model|WP_Post $model 'new', WP post id, instance of an extending class, instance of WP_Post.
* @param array $args Args to create the post, only applies when $model is 'new'.
*/
public function __construct( $model, $args = array() ) {
$this->construct_audio_video_embed();
$this->construct_sales_page();
parent::__construct( $model, $args );
}
/**
* Add courses to autoenrollment by id
*
* @since 3.0.0
* @since 3.30.0 Added optional `$replace` argument.
*
* @param array|int $course_ids Array of course id or course id as int.
* @param bool $replace Optional. When `true`, replaces all existing courses with `$course_ids`, when false merges `$course_ids` with existing courses. Default `false`.
* @return boolean Returns `true` on success, and `false` on error or if the value in the db is unchanged.
*/
public function add_auto_enroll_courses( $course_ids, $replace = false ) {
// allow a single course_id to be passed in.
if ( ! is_array( $course_ids ) ) {
$course_ids = array( $course_ids );
}
// add existing courses to the array if replace is false.
if ( ! $replace ) {
$course_ids = array_merge( $course_ids, $this->get_auto_enroll_courses() );
}
return $this->set( 'auto_enroll', array_unique( $course_ids ) );
}
/**
* Retrieve a list of posts associated with the membership
*
* An associated post is:
* + A post, page, or custom post type which supports `llms-membership-restrictions` and has restrictions enabled to this membership
* + A course that exists in the memberships list of auto-enroll courses
* + A course that has at least one access plan with members-only availability linked to this membership
*
* @since 3.38.1
* @since 4.15.0 Minor restructuring to only query post type data when it's needed.
*
* @param string $post_type If supplied, returns only associations of this post type, otherwise returns an associative array of all associations.
* @return array[]|int[] An array of arrays of post IDs. The array keys are the post type and the array values are arrays of integers.
* If `$post_type` is supplied returns an array of associated post ids as integers.
*/
public function get_associated_posts( $post_type = null ) {
// If we're querying only posts, we can skip these associations entirely because courses don't support them.
$post_types = 'course' !== $post_type ? get_post_types_by_support( 'llms-membership-restrictions' ) : array();
// If we're looking at a single post type we only have to query associations for that post type.
$post_types = $post_type ? array_intersect( $post_types, array( $post_type ) ) : $post_types;
// Our return array.
$posts = array();
// Retrieve all posts that are restricted to a membership via a LifterLMS Membership Restriction setting.
foreach ( $post_types as $type ) {
$posts[ $type ] = $this->query_associated_posts( $type, '_llms_is_restricted', 'yes', '_llms_restricted_levels' );
}
// Include courses if courses were requested or if no specific post type was requested.
if ( ! $post_type || 'course' === $post_type ) {
$posts['course'] = $this->query_associated_courses();
}
/**
* Filter the list of posts associated with the membership.
*
* @since 3.38.1
*
* @param array[] $posts An array of arrays of post IDs. The array keys are the post type and the array values are arrays of integers.
* @param string|null $post_type The requested post type if only a specific post type was requested, otherwise `null` to indicate all associated post types.
* @param LLMS_Membership $this Membership object.
*/
$posts = apply_filters( 'llms_membership_get_associated_posts', $posts, $post_type, $this );
// If a single post type was requested, return only that.
if ( $post_type ) {
// Return the request post type array and fallback to an empty array if that post type doesn't exist.
return isset( $posts[ $post_type ] ) ? $posts[ $post_type ] : array();
}
// Remove empty arrays and return the rest.
return array_filter( $posts );
}
/**
* Get an array of the auto enrollment course ids
*
* Uses a custom function due to the default "get_array" returning an array with an empty string
*
* @since 3.0.0
* @since 4.15.0 Exclude unpublished courses from the return array.
*
* @return array
*/
public function get_auto_enroll_courses() {
// Ensure an array when metadata is not set.
$courses = isset( $this->auto_enroll ) ? $this->get( 'auto_enroll' ) : array();
// Exclude unpublished courses.
$courses = array_values(
array_filter(
$courses,
function ( $id ) {
return 'publish' === get_post_status( $id );
}
)
);
/**
* Filters the list of the membership's auto enroll courses
*
* @since 3.0.0
*
* @param int[] $courses List of LLMS_Course IDs.
* @param LLMS_Membership $membership Membership post object.
*/
return apply_filters( 'llms_membership_get_auto_enroll_courses', $courses, $this );
}
/**
* Retrieve membership categories.
*
* @since 3.36.3
*
* @param array $args Array of args passed to `wp_get_post_terms()`.
* @return array
*/
public function get_categories( $args = array() ) {
return wp_get_post_terms( $this->get( 'id' ), 'membership_cat', $args );
}
/**
* Retrieve course instructor information
*
* @since 3.13.0
*
* @param boolean $exclude_hidden If true, excludes hidden instructors from the return array.
* @return array
*/
public function get_instructors( $exclude_hidden = false ) {
return apply_filters(
'llms_membership_get_instructors',
$this->instructors()->get_instructors( $exclude_hidden ),
$this,
$exclude_hidden
);
}
/**
* Retrieve an instance of the LLMS_Product for this course
*
* @since 3.3.0
* @return LLMS_Product
*/
public function get_product() {
return new LLMS_Product( $this->get( 'id' ) );
}
/**
* Retrieve the number of enrolled students in the membership.
*
* @since 3.32.0
* @since 6.0.0 Don't access `LLMS_Student_Query` properties directly.
*
* @return int
*/
public function get_student_count() {
$query = new LLMS_Student_Query(
array(
'post_id' => $this->get( 'id' ),
'statuses' => array( 'enrolled' ),
'count_only' => true,
'sort' => array( 'id' => 'ASC' ),
)
);
return $query->get_count_only_result();
}
/**
* Get an array of student IDs based on enrollment status in the membership
*
* @since 3.0.0
*
* @param string|string[] $statuses Optional. List of enrollment statuses to query by status query is an OR relationship. Default is 'enrolled'.
* @param int $limit Optional. Number of results. Default is `50`.
* @param int $skip Optional. Number of results to skip (for pagination). Default is `0`.
* @return array
*/
public function get_students( $statuses = 'enrolled', $limit = 50, $skip = 0 ) {
return llms_get_enrolled_students( $this->get( 'id' ), $statuses, $limit, $skip );
}
/**
* Retrieve membership tags.
*
* @since 3.36.3
*
* @param array $args Array of args passed to `wp_get_post_terms()`.
* @return array
*/
public function get_tags( $args = array() ) {
return wp_get_post_terms( $this->get( 'id' ), 'membership_tag', $args );
}
/**
* Retrieve an instance of the Post Instructors model
*
* @since 3.13.0
*
* @return LLMS_Post_Instructors
*/
public function instructors() {
return new LLMS_Post_Instructors( $this );
}
/**
* Retrieve courses associated with the membership
*
* @since 3.38.1
* @since 4.15.0 Exclude unpublished courses.
*
* @see LLMS_Membership::get_associated_posts()
*
* @return int[]
*/
protected function query_associated_courses() {
// Start with autoenroll courses.
$courses = $this->get_auto_enroll_courses();
// Retrieve all access plans with a members-only availability restriction for this membership.
foreach ( $this->query_associated_posts( 'llms_access_plan', '_llms_availability', 'members', '_llms_availability_restrictions' ) as $plan_id ) {
$plan = llms_get_post( $plan_id );
if ( $plan ) {
$id = $plan->get( 'product_id' );
if ( 'publish' === get_post_status( $id ) ) {
$courses[] = $id;
}
}
}
return array_unique( $courses );
}
/**
* Performs a WPDB query to retrieve posts associated with the membership
*
* @since 3.38.1
* @since 4.0.0 Escape `{` character in SQL query to add MySQL 8.0 support.
*
* @see LLMS_Membesrhip::get_associated_posts()
*
* @param string $post_type Post type to query for an association with.
* @param string $enabled_key A meta key name, used to check if the association is enabled for the associated post. For example: "_llms_is_restricted"
* @param string $enabled_value The meta value of the `$enabled_key` when the association is enabled. For example "yes" when checking "_llms_is_restricted"..
* @param string $list_key The meta key name where associations are stored as a serialized array of WP_Post IDs. For example "_llms_restricted_levels".
* @return int[]
*/
protected function query_associated_posts( $post_type, $enabled_key, $enabled_value, $list_key ) {
global $wpdb;
// See if we have a cached result first.
$cache = sprintf( 'membership_%1$d_associated_%2$s', $this->get( 'id' ), $post_type );
$found = null;
$ids = wp_cache_get( $cache, '', false, $found );
// We don't, perform a query.
if ( ! $found ) {
$ids = $wpdb->get_col( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
$wpdb->prepare(
"SELECT metas.post_id
FROM {$wpdb->postmeta} AS metas
JOIN {$wpdb->postmeta} AS metas2 ON metas2.post_id = metas.post_id
JOIN {$wpdb->posts} AS posts ON posts.ID = metas.post_id
WHERE 1
AND posts.post_status = 'publish'
AND posts.post_type = %s
AND metas2.meta_key = %s
AND metas2.meta_value = %s
AND metas.meta_key = %s
AND metas.meta_value REGEXP %s;",
$post_type,
$enabled_key,
$enabled_value,
$list_key,
'a:[0-9][0-9]*:\{(i:[0-9][0-9]*;(i|s:[0-9][0-9]*):"?[0-9][0-9]*"?;)*(i:[0-9][0-9]*;(i|s:[0-9][0-9]*):"?' . $this->get( 'id' ) . '"?;)'
)
);
// Only return ints.
$ids = array_map( 'absint', $ids );
// Cache the result.
wp_cache_set( $cache, $ids );
}
return $ids;
}
/**
* Remove a course from auto enrollment
*
* @since 3.0.0
*
* @param int $course_id WP_Post ID of the course.
* @return bool
*/
public function remove_auto_enroll_course( $course_id ) {
return $this->set( 'auto_enroll', array_diff( $this->get_auto_enroll_courses(), array( $course_id ) ) );
}
/**
* Save instructor information
*
* @since 3.13.0
*
* @param array $instructors Array of course instructor information.
* @return array
*/
public function set_instructors( $instructors = array() ) {
return $this->instructors()->set_instructors( $instructors );
}
/**
* Add data to the membership model when converted to array.
*
* Called before data is sorted and returned by `$this->jsonSerialize()`.
*
* @since 3.36.3
*
* @param array $arr Data to be serialized.
* @return array
*/
public function toArrayAfter( $arr ) {
$arr['categories'] = $this->get_categories(
array(
'fields' => 'names',
)
);
$arr['tags'] = $this->get_tags(
array(
'fields' => 'names',
)
);
return $arr;
}
}
================================================
FILE: includes/models/model.llms.notification.php
================================================
<?php
/**
* LLMS_Notification class file
*
* @package LifterLMS/Models/Classes
*
* @since 3.8.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Notification model class.
*
* Used for notification CRUD and Display.
*
* @since 3.8.0
*/
class LLMS_Notification implements JsonSerializable {
/**
* Notification ID
*
* @var int
*/
public $id;
/**********************************************************
*
* Default Properties
**********************************************************/
/**
* Created Date
*
* @var string (DATETIME)
*/
private $created;
/**
* Updated Date
*
* @var string (DATETIME)
*/
private $updated;
/**
* Current Status
* Options vary based on notification type
*
* @var string
*/
private $status;
/**
* Type of Notification
* basic, email, sms, etc...
*
* @var string
*/
private $type;
/**
* Subscriber Identifier
* WP User ID, email address (for cc,bcc), phone number, etc...
*
* @var mixed
*/
private $subscriber;
/**
* Trigger ID for the notification
* lesson_complete, course_complete, etc...
*
* @var string
*/
private $trigger_id;
/**
* WP User ID of the user who triggered the notification to be generated
* NOT to be confused with $subscriber and can be different than the subscriber
*
* @var int
*/
private $user_id;
/**
* WP Post ID of the post which triggered the notification to be generated
*
* @var int
*/
private $post_id;
/**********************************************************
*
* View Related Properties
**********************************************************/
/**
* Merged HTML for the notification
* used for displaying a notification view
*
* @var string
*/
private $html;
/**
* Constructor
*
* @param int $notification Notification ID
* @since 3.8.0
* @version 3.8.0
*/
public function __construct( $notification = null ) {
if ( is_numeric( $notification ) ) {
$this->id = $notification;
}
}
/**
* Get notification properties
*
* @param string $key key to retrieve
* @return mixed
* @since 3.8.0
* @version 3.8.0
*/
public function __get( $key ) {
return $this->get( $key, false );
}
/**
* Create a new notification in the database
*
* @param array $data notification data
* @return int|false new notification id on success, false otherwise
* @since 3.8.0
* @version 3.8.0
*/
public function create( $data = array() ) {
$time = current_time( 'mysql' );
$data = wp_parse_args(
$data,
array(
'created' => $time,
'post_id' => null,
'status' => 'new',
'subscriber' => null,
'trigger_id' => null,
'type' => '',
'updated' => $time,
'user_id' => null,
)
);
ksort( $data ); // Maintain alpha sort you savages.
$format = array(
'%s', // For created.
'%d', // For post_id.
'%s', // For status.
'%s', // For subscriber.
'%s', // For trigger_id.
'%s', // For type.
'%s', // For updated.
'%d', // For user_id.
);
global $wpdb;
if ( 1 !== $wpdb->insert( $this->get_table(), $data, $format ) ) {
return false;
}
$this->id = $wpdb->insert_id;
return $this->id;
}
/**
* Determine if the triggering user is the subscriber
*
* @return boolean
* @since 3.8.0
* @version 3.8.0
*/
public function is_subscriber_self() {
return ( $this->get( 'subscriber' ) == $this->get( 'user_id' ) );
}
/**
* Get notification properties
*
* @param string $key key to retrieve
* @return mixed
* @since 3.8.0
* @version 3.8.0
*/
public function get( $key, $skip_cache = false ) {
// Id will always be accessed from the object.
if ( 'id' === $key ) {
return $this->id;
}
// Return cached values if they exist.
if ( ! is_null( $this->$key ) && ! $skip_cache ) {
return $this->$key;
}
// get the value from the database.
global $wpdb;
// phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $wpdb->get_var( $wpdb->prepare( "SELECT {$key} FROM {$this->get_table()} WHERE id = %d", $this->id ) ); // db call ok; no-cache ok.
}
/**
* Retrieve the HTML for the current notification
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_html() {
$view = $this->get_view();
if ( $view ) {
return $view->get_html();
}
return '';
}
/**
* Get the table name for notification data
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
private function get_table() {
global $wpdb;
return $wpdb->prefix . 'lifterlms_notifications';
}
/**
* Retrieve an instance of the notification view class for the notification
*
* @return LLMS_Abstract_Notification_View|false
* @since 3.8.0
* @version 3.8.0
*/
public function get_view() {
return llms()->notifications()->get_view( $this );
}
/**
* Called when converting a notification to JSON
*
* @since 3.8.0
*
* @todo The `mixed` return type declared by the parent method, which should be defined here as well,
* is not available until PHP 8.0. Once support is dropped for 7.4 we can add the return type declaration
* and remove the `#[ReturnTypeWillChange]` attribute. This *must* happen before the release of PHP 9.0.
*
* @return array
*/
#[ReturnTypeWillChange]
public function jsonSerialize() {
return $this->toArray();
}
/**
* Load all notification data into the instance.
*
* @since 3.8.0
* @since 7.1.0 Catch possible fatals while generating the notification HTML and log them.
*
* @return LLMS_Notification
*/
public function load() {
global $wpdb;
$notification = $wpdb->get_row(
$wpdb->prepare( "SELECT created, updated, status, type, subscriber, trigger_id, user_id, post_id FROM {$this->get_table()} WHERE id = %d", $this->id ), // phpcs:ignore WordPress.DB.PreparedSQL.InterpolatedNotPrepared
ARRAY_A
); // db call ok; no-cache ok.
if ( $notification ) {
foreach ( $notification as $key => $val ) {
$this->$key = $val;
}
try {
$this->html = $this->get_html();
} catch ( Error $e ) {
llms_log( sprintf( 'Error generating the HTML for the notification ID #%d', $this->id ) );
llms_log( sprintf( 'Error caught %1$s in %2$s on line %3$s', $e->getMessage(), $e->getFile(), $e->getLine() ) );
$this->set( 'status', 'error' );
}
}
return $this;
}
/**
* Set object variables
*
* @since 3.8.0
*
* @param string $key variable name
* @param mixed $val data
*/
public function set( $key, $val ) {
global $wpdb;
switch ( $key ) {
case 'created':
case 'id':
case 'updated':
return false;
break;
default:
$this->$key = $val;
if ( $this->id ) {
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $wpdb->query(
$wpdb->prepare(
"UPDATE {$this->get_table()} SET {$key} = %s, updated = %s WHERE id = %d",
$val,
current_time( 'mysql' ),
$this->id
)
); // db call ok; no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
}
return true;
break;
}
}
/**
* Convert the notification to an array
* access to all properties and meta items will be made accessible
*
* @return array
* @since 3.8.0
* @version 3.8.0
*/
public function toArray() {
return get_object_vars( $this->load() );
}
}
================================================
FILE: includes/models/model.llms.order.php
================================================
<?php
/**
* LLMS_Order class/model file
*
* @package LifterLMS/Models/Classes
*
* @since 3.0.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS order model.
*
* Provides CRUD operations for the `llms_order` post type.
*
* @property string $access_expiration Access expiration type, accepts: lifetime (default), limited-period, or limited-date.
* @property string $access_expires Date on which access expires in `m/d/Y` format. Only applicable when the `$access_expiration` property is set to "limited-date".
* @property int $access_length Length of access from time of purchase, combine with the `$access_period`. Only applicable when the `$access_expiration` property is set to "limited-period".
* @property string $access_period Time period of access from time of purchase, combine with `$access_length`. Only applicable when the `$access_expiration` property is set to "limited-period". Accepts: year, month, week, or day.
* @property string $anonymized Determines if the order has been anonymized due to a personal information erasure request. Accepts "yes" or "no".
* @property string $billing_address_1 Customer billing address line 1.
* @property string $billing_address_2 Customer billing address line 2.
* @property string $billing_city Customer billing city.
* @property string $billing_country Customer billing country, two character ISO code.
* @property string $billing_email Customer email address.
* @property string $billing_first_name Customer first name.
* @property string $billing_last_name Customer last name.
* @property string $billing_phone Customer phone number.
* @property string $billing_state Customer billing state.
* @property string $billing_zip Customer billing zip/postal code.
* @property int $billing_frequency The billing frequency interval. A value of `0` indicates a one-time payment. Accepts integers <= 6.
* @property int $billing_length Number of intervals to run payment for, combine with `$billing_period` & `$billing_frequency`. A value of `0` indicates that recurring payments run indefinitely (until cancelled). Only applicable if `$billing_frequency` is not 0.
* @property string $billing_period The billing period. Combine with `$length`. Only applicable if `$billing_frequency` is not 0. Accepts: year, month, week, or day.
* @property float $coupon_amount Amount of the coupon (flat/percentage) in relation to the plan amount.
* @property float $coupon_amout_trial Amount of the coupon (flat/percentage) in relation to the plan trial amount where applicable.
* @property string $coupon_code Coupon code applied to the order.
* @property int $coupon_id The WP_Post ID of the used coupon.
* @property string $coupon_type Type of coupon used, either percent or dollar.
* @property string $coupon_used Whether or not a coupon was used for the order. Accepts yes or no.
* @property float $coupon_value Value of the coupon. When on sale, `$sale_price` minus `$total`; when not on sale `$original_total` minus `$total`.
* @property float $coupon_value_trial Value of the coupon applied to the trial. The `$trial_original_total` minus `$trial_total`.
* @property string $currency Transaction's currency code.
* @property string $date_access_expires Date when access should expire as a datetime string: `Y-m-d H:i:s`.
* @property string $date_next_payment Date when the next recurring payment is due as a datemtime string: `Y-m-d H:i:s`. Use function LLMS_Order::get_next_payment_due_date() instead of accessing directly!
* @property string $date_trial_end Date when the trial ends for orders with a trial as a datemtime string: `Y-m-d H:i:s`. Use function LLMS_Order::get_trial_end_date() instead of accessing directly!
* @property string $gateway_api_mode API Mode of the gateway when the transaction was made, either "test" or "live".
* @property string $gateway_customer_id Gateway's unique ID for the customer who placed the order (if supported by the gateway).
* @property string $gateway_source_id Gateway's unique ID for the card or source to be used for recurring subscriptions (if supported by gateway).
* @property string $gateway_subscription_id Gateway's unique ID for the recurring subscription (if supported by the gateway).
* @property int $id The WP_Post ID of the order.
* @property int $last_retry_rule Rule number for current retry step for the order.
* @property string $on_sale Whether or not sale pricing was used for the plan, either "yes" or "no".
* @property string $order_key A unique identifier for the order that can be passed safely in URLs.
* @property string $order_type Single or recurring order, either "single" or "recurring".
* @property float $original_total Price of the order before applicable sale and coupon adjustments.
* @property string $payment_gateway LifterLMS Payment Gateway ID (eg "paypal" or "stripe").
* @property int $plan_id WP_Post ID of the purchased access plan.
* @property string $plan_sku SKU of the purchased access plan.
* @property string $plan_title Title / Name of the purchased access plan.
* @property string $plan_ended Whether or not the payment plan has ended. Only applicable when the plan is not "unlimited". Accepts "yes" or "no".
* @property int $product_id WP_Post ID of the purchased course or membership product.
* @property string $product_sku SKU of the purchased product.
* @property string $product_title Title / Name of the purchased product.
* @property string $product_type Type of product purchased (course or membership).
* @property float $sale_price Sale price before coupon adjustments.
* @property float $sale_value The value of the sale, `$original_total` - `$sale_price`.
* @property string $start_date Date when access was initially granted; this is used to determine when access expires.
* @property array $temp_gateway_ids {
* An associative array containing gateway ids. The gateway IDs are cached in this meta property while the source is being
* switched. Any gateway running actions when a source is switched may need to know the previous source IDs which might be
* cleared or overwritten by other gateways during the switch.
*
* @type string customer The value of the `gateway_customer_id` property when the source switch starts.
* @type string source The value of the `gateway_source_id` property when the source switch starts.
* @type string subscription The value of the `gateway_subscription_id` property when the source switch starts.
* }
* @property float $total Actual price of the order, after applicable sale & coupon adjustments.
* @property int $trial_length Length of the trial. Combined with $trial_period to determine the actual length of the trial.
* @property string $trial_offer Whether or not there was a trial offer applied to the order, either yes or no.
* @property float $trial_original_total Total price of the trial before applicable coupon adjustments.
* @property string $trial_period Period for the trial period. Accepts: year, month, week, or day.
* @property float $trial_total Total price of the trial after applicable coupon adjustments/
* @property int $user_id Customer WP_User ID.
* @property string $user_ip_address Customer's IP address at time of purchase.
*
* @since 3.0.0
* @since 3.32.0 Update to use latest action-scheduler functions.
* @since 3.35.0 Prepare transaction revenue SQL query properly; Sanitize $_SERVER data.
* @since 4.7.0 Added `plan_ended` meta property.
* @since 5.3.0 Removed usage of the meta property `date_billing_end` and removed private method `calculate_billing_end_date()`.
*/
class LLMS_Order extends LLMS_Post_Model {
/**
* Database post type.
*
* @var string
*/
protected $db_post_type = 'llms_order';
/**
* Model post type.
*
* @var string
*/
protected $model_post_type = 'order';
/**
* Meta properties.
*
* @var array
*/
protected $properties = array(
'anonymized' => 'yesno',
'coupon_amount' => 'float',
'coupon_amout_trial' => 'float',
'coupon_value' => 'float',
'coupon_value_trial' => 'float',
'original_total' => 'float',
'sale_price' => 'float',
'sale_value' => 'float',
'total' => 'float',
'trial_original_total' => 'float',
'trial_total' => 'float',
'access_length' => 'absint',
'billing_frequency' => 'absint',
'billing_length' => 'absint',
'coupon_id' => 'absint',
'plan_id' => 'absint',
'product_id' => 'absint',
'trial_length' => 'absint',
'user_id' => 'absint',
'access_expiration' => 'text',
'access_expires' => 'text',
'access_period' => 'text',
'billing_address_1' => 'text',
'billing_address_2' => 'text',
'billing_city' => 'text',
'billing_country' => 'text',
'billing_email' => 'text',
'billing_first_name' => 'text',
'billing_last_name' => 'text',
'billing_state' => 'text',
'billing_zip' => 'text',
'billing_period' => 'text',
'coupon_code' => 'text',
'coupon_type' => 'text',
'coupon_used' => 'text',
'currency' => 'text',
'on_sale' => 'text',
'order_key' => 'text',
'order_type' => 'text',
'payment_gateway' => 'text',
'plan_ended' => 'yesno',
'plan_sku' => 'text',
'plan_title' => 'text',
'product_sku' => 'text',
'product_type' => 'text',
'title' => 'text',
'gateway_api_mode' => 'text',
'gateway_customer_id' => 'text',
'trial_offer' => 'text',
'trial_period' => 'text',
'user_ip_address' => 'text',
'date_access_expires' => 'text',
'date_next_payment' => 'text',
'date_trial_end' => 'text',
'temp_gateway_ids' => 'array',
);
/**
* Add an admin-only note to the order visible on the admin panel
* notes are recorded using the wp comments API & DB
*
* @since 3.0.0
* @since 3.35.0 Sanitize $_SERVER data.
*
* @param string $note Note content.
* @param boolean $added_by_user Optional. If this is an admin-submitted note adds user info to note meta. Default is false.
* @return null|int Null on error or WP_Comment ID of the note.
*/
public function add_note( $note, $added_by_user = false ) {
if ( ! $note ) {
return;
}
// Added by a user from the admin panel.
if ( $added_by_user && is_user_logged_in() && current_user_can( apply_filters( 'lifterlms_admin_order_access', 'manage_options' ) ) ) {
$user_id = get_current_user_id();
$user = get_user_by( 'id', $user_id );
$author = $user->display_name;
$author_email = $user->user_email;
} else {
$user_id = 0;
$author = _x( 'LifterLMS', 'default order note author', 'lifterlms' );
$author_email = strtolower( _x( 'LifterLms', 'default order note author', 'lifterlms' ) ) . '@';
$author_email .= isset( $_SERVER['HTTP_HOST'] ) ? str_replace( 'www.', '', sanitize_text_field( wp_unslash( $_SERVER['HTTP_HOST'] ) ) ) : 'noreply.com';
$author_email = sanitize_email( $author_email );
}
$note_id = wp_insert_comment(
apply_filters(
'llms_add_order_note_content',
array(
'comment_post_ID' => $this->get( 'id' ),
'comment_author' => $author,
'comment_author_email' => $author_email,
'comment_author_url' => '',
'comment_content' => $note,
'comment_type' => 'llms_order_note',
'comment_parent' => 0,
'user_id' => $user_id,
'comment_approved' => 1,
'comment_agent' => 'LifterLMS',
'comment_date' => current_time( 'mysql' ),
)
)
);
do_action( 'llms_new_order_note_added', $note_id, $this );
return $note_id;
}
/**
* Called after inserting a new order into the database
*
* @since 3.0.0
*
* @return void
*/
protected function after_create() {
// Add a random key that can be passed in the URL and whatever.
$this->set( 'order_key', $this->generate_order_key() );
}
/**
* Calculate the next payment due date
*
* @since 3.10.0
* @since 3.12.0 Unknown.
* @since 3.37.6 Now uses the last successful transaction time to calculate from when the previously
* stored next payment date is in the future.
* @since 4.9.0 Fix comparison for PHP8 compat.
* @since 5.3.0 Determine if a limited order has ended based on number of remaining payments in favor of current date/time.
*
* @param string $format PHP date format used to format the returned date string.
* @return string The formatted next payment due date or an empty string when there is no next payment.
*/
private function calculate_next_payment_date( $format = 'Y-m-d H:i:s' ) {
// If the limited plan has already ended return early.
$remaining = $this->get_remaining_payments();
if ( 0 === $remaining ) {
// This filter is documented below.
return apply_filters( 'llms_order_calculate_next_payment_date', '', $format, $this );
}
$start_time = $this->get_date( 'date', 'U' );
$next_payment_time = $this->get_date( 'date_next_payment', 'U' );
$last_txn_time = $this->get_last_transaction_date( 'llms-txn-succeeded', 'recurring', 'U' );
// If were on a trial and the trial hasn't ended yet next payment date is the date the trial ends.
if ( $this->has_trial() && ! $this->has_trial_ended() ) {
$next_payment_time = $this->get_trial_end_date( 'U' );
} else {
/**
* Calculate next payment date from the saved `date_next_payment` calculated during
* the previous recurring transaction or during order initialization.
*
* This condition will be encountered during the 2nd, 3rd, 4th, etc... recurring payments.
*/
if ( $next_payment_time && $next_payment_time < llms_current_time( 'timestamp' ) ) {
$from_time = $next_payment_time;
/**
* Use the order's last successful transaction date.
*
* This will be encountered when any amount of "chaos" is
* introduced causing the previously stored `date_next_payment`
* to be GREATER than the current time.
*
* Orders created
*/
} elseif ( $last_txn_time && $last_txn_time > $start_time ) {
$from_time = $last_txn_time;
/**
* Use the order's creation time.
*
* This condition will be encountered for the 1st recurring payment only.
*/
} else {
$from_time = $start_time;
}
$period = $this->get( 'billing_period' );
$frequency = $this->get( 'billing_frequency' );
$next_payment_time = strtotime( '+' . $frequency . ' ' . $period, $from_time );
/**
* Make sure the next payment is more than 2 hours in the future
*
* This ensures changes to the site's timezone because of daylight savings
* will never cause a 2nd renewal payment to be processed on the same day.
*/
$i = 1;
while ( $next_payment_time < ( llms_current_time( 'timestamp', true ) + 2 * HOUR_IN_SECONDS ) && $i < 3000 ) {
$next_payment_time = strtotime( '+' . $frequency . ' ' . $period, $next_payment_time );
++$i;
}
}
/**
* Filter the calculated next payment date
*
* @since 3.10.0
*
* @param string $ret The formatted next payment due date or an empty string when there is no next payment.
* @param string $format The requested date format.
* @param LLMS_Order $order The order object.
*/
return apply_filters( 'llms_order_calculate_next_payment_date', date( $format, $next_payment_time ), $format, $this );
}
/**
* Calculate the end date of the trial
*
* @since 3.10.0
*
* @param string $format Optional. Desired return format of the date. Defalt is 'Y-m-d H:i:s'.
* @return string
*/
private function calculate_trial_end_date( $format = 'Y-m-d H:i:s' ) {
$start = $this->get_date( 'date', 'U' ); // Start with the date the order was initially created.
$length = $this->get( 'trial_length' );
$period = $this->get( 'trial_period' );
$end = strtotime( '+' . $length . ' ' . $period, $start );
$ret = date_i18n( $format, $end );
return apply_filters( 'llms_order_calculate_trial_end_date', $ret, $format, $this );
}
/**
* Determines if an order can be confirmed.
*
* An order can be confirmed only when the order's status is pending.
*
* Additional requirements can be introduced via the filter `llms_order_can_be_confirmed`.
*
* @since 7.0.0
*
* @return boolean
*/
public function can_be_confirmed() {
/**
* Determine if the order can be confirmed.
*
* @since 3.34.4
*
* @param boolean $can_be_confirmed Whether or not the order can be confirmed.
* @param LLMS_Order $order Order object.
* @param string $gateway_id Payment gateway ID.
*/
return apply_filters(
'llms_order_can_be_confirmed',
( 'llms-pending' === $this->get( 'status' ) ),
$this,
$this->get( 'payment_gateway' )
);
}
/**
* Determine if the order can be retried for recurring payments
*
* @since 3.10.0
* @since 5.2.0 Use strict type comparison.
* @since 5.2.1 Combine conditions that return `false`.
*
* @return boolean
*/
public function can_be_retried() {
$can_retry = true;
if (
// Only recurring orders can be retried.
! $this->is_recurring() ||
// Recurring rety feature is disabled.
! llms_parse_bool( get_option( 'lifterlms_recurring_payment_retry', 'yes' ) ) ||
// Only active & on-hold orders qualify for a retry.
! in_array( $this->get( 'status' ), array( 'llms-active', 'llms-on-hold' ), true )
) {
$can_retry = false;
} else {
// If the gateway isn't active or the gateway doesn't support recurring retries.
$gateway = $this->get_gateway();
if ( is_wp_error( $gateway ) || ! $gateway->supports( 'recurring_retry' ) ) {
$can_retry = false;
}
}
/**
* Filters whether or not a recurring order can be retried
*
* @since 5.2.1
*
* @param boolean $can_retry Whether or not the order can be retried.
* @param LLMS_Order $order Order object.
*/
return apply_filters( 'llms_order_can_be_retried', $can_retry, $this );
}
/**
* Determines if the order can be resubscribed to.
*
* @since 3.19.0
* @since 5.2.0 Use strict type comparison.
*
* @return bool
*/
public function can_resubscribe() {
$can_resubscribe = false;
if ( $this->is_recurring() ) {
/**
* Filters the order statuses from which an order can be reactivated.
*
* @since 7.0.0
*
* @param string[] $allowed_statuses The list of allowed order statuses.
*/
$allowed_statuses = apply_filters(
'llms_order_status_can_resubscribe_from',
array(
'llms-on-hold',
'llms-pending',
'llms-pending-cancel',
)
);
$can_resubscribe = in_array( $this->get( 'status' ), $allowed_statuses, true );
}
/**
* Determines whether or not a user can resubscribe to an inactive recurring payment order.
*
* @since 3.19.0
*
* @param boolean $can_resubscribe Whether or not a user can resubscribe.
* @param LLMS_Order $order The order object.
*/
return apply_filters( 'llms_order_can_resubscribe', $can_resubscribe, $this );
}
/**
* Determines if the order's payment source can be changed.
*
* @since 7.0.0
*
* @return boolean
*/
public function can_switch_source() {
$can_switch = 'llms-active' === $this->get( 'status' ) || $this->can_resubscribe();
/**
* Filters whether or not the order's payment source can be changed.
*
* @since 7.0.0
*
* @param boolean $can_switch Whether or not the order's source can be switched.
* @param LLMS_Order $order The order object.
*/
return apply_filters( 'llms_order_can_switch_source', $can_switch, $this );
}
/**
* Generate an order key for the order
*
* @since 3.0.0
*
* @return string
*/
public function generate_order_key() {
/**
* Modify the generated order key for the order.
*
* @since 3.0.0
* @since 5.2.1 Added the `$order` parameter.
*
* @param string $order_key The generated order key.
* @param LLMS_Order $order_key Order object.
*/
return apply_filters( 'lifterlms_generate_order_key', uniqid( 'order-' ), $this );
}
/**
* Determine the date when access will expire
*
* Based on the access settings of the access plan
* at the `$start_date` of access.
*
* @since 3.0.0
* @since 3.19.0 Unknown.
*
* @param string $format Optional. Date format. Default is 'Y-m-d'.
* @return string Date string.
* "Lifetime Access" for plans with lifetime access.
* "To be Determined" for limited date when access hasn't started yet.
*/
public function get_access_expiration_date( $format = 'Y-m-d' ) {
$type = $this->get( 'access_expiration' );
$ret = $this->get_date( 'date_access_expires', $format );
if ( ! $ret ) {
switch ( $type ) {
case 'lifetime':
$ret = __( 'Lifetime Access', 'lifterlms' );
break;
case 'limited-date':
$ret = date_i18n( $format, ( $this->get_date( 'access_expires', 'U' ) + ( DAY_IN_SECONDS - 1 ) ) );
break;
case 'limited-period':
if ( $this->get( 'start_date' ) ) {
$time = strtotime( '+' . $this->get( 'access_length' ) . ' ' . $this->get( 'access_period' ), $this->get_date( 'start_date', 'U' ) ) + ( DAY_IN_SECONDS - 1 );
$ret = date_i18n( $format, $time );
} else {
$ret = __( 'To be Determined', 'lifterlms' );
}
break;
default:
$ret = apply_filters( 'llms_order_' . $type . '_access_expiration_date', $type, $this, $format );
}
}
return apply_filters( 'llms_order_get_access_expiration_date', $ret, $this, $format );
}
/**
* Get the current status of a student's access
*
* Based on the access plan data stored on the order at the time of purchase.
*
* @since 3.0.0
* @since 3.19.0 Unknown.
* @since 5.2.0 Use stric type comparison.
*
* @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.
*/
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';
}
/**
* Retrieve arguments passed to order-related events processed by the action scheduler
*
* @since 3.19.0
*
* @return array
*/
protected function get_action_args() {
return array(
'order_id' => $this->get( 'id' ),
);
}
/**
* Get the formatted coupon amount with a currency symbol or percentage
*
* @since 3.0.0
*
* @param string $payment Coupon discount type, either 'regular' or 'trial'.
* @return string
*/
public function get_coupon_amount( $payment = 'regular' ) {
if ( 'regular' === $payment ) {
$amount = $this->get( 'coupon_amount' );
} elseif ( 'trial' === $payment ) {
$amount = $this->get( 'coupon_amount_trial' );
}
$type = $this->get( 'coupon_type' );
if ( 'percent' === $type ) {
$amount = $amount . '%';
} elseif ( 'dollar' === $type ) {
$amount = llms_price( $amount );
}
return $amount;
}
/**
* Retrieve the customer's full name
*
* @since 3.0.0
* @since 3.18.0 Unknown.
*
* @return string
*/
public function get_customer_name() {
if ( 'yes' === $this->get( 'anonymized' ) ) {
return __( 'Anonymous', 'lifterlms' );
}
return trim( $this->get( 'billing_first_name' ) . ' ' . $this->get( 'billing_last_name' ) );
}
/**
* Retrieve the customer's full billing address
*
* @since 5.2.0
*
* @return string
*/
public function get_customer_full_address() {
$billing_address_1 = $this->get( 'billing_address_1' );
if ( empty( $billing_address_1 ) ) {
return '';
}
$address = array(
trim( $billing_address_1 . ' ' . $this->get( 'billing_address_2' ) ),
);
$address[] = trim( $this->get( 'billing_city' ) . ' ' . $this->get( 'billing_state' ) );
$address[] = $this->get( 'billing_zip' );
$address[] = llms_get_country_name( $this->get( 'billing_country' ) );
return implode( ', ', array_filter( $address ) );
}
/**
* An array of default arguments to pass to $this->create() when creating a new post
*
* @since 3.0.0
* @since 3.10.0 Unknown.
* @since 5.3.1 Set the `post_date` property using `llms_current_time()`.
* @since 5.9.0 Remove usage of deprecated `strftime()`.
*
* @param string $title Title to create the post with.
* @return array
*/
protected function get_creation_args( $title = '' ) {
$date = llms_current_time( 'mysql' );
if ( empty( $title ) ) {
$title = sprintf(
// Translators: %1$s = Transaction creation date.
__( 'Order – %1$s', 'lifterlms' ),
date_format( date_create( $date ), 'M d, Y @ h:i A' )
);
}
return apply_filters(
"llms_{$this->model_post_type}_get_creation_args",
array(
'comment_status' => 'closed',
'ping_status' => 'closed',
'post_author' => 1,
'post_content' => '',
'post_date' => $date,
'post_excerpt' => '',
'post_password' => uniqid( 'order_' ),
'post_status' => 'llms-' . apply_filters( 'llms_default_order_status', 'pending' ),
'post_title' => $title,
'post_type' => $this->get( 'db_post_type' ),
),
$this
);
}
/**
* Retrieve the payment gateway instance for the order's selected payment gateway
*
* @since 1.0.0
*
* @return LLMS_Payment_Gateway|WP_Error Instance of the LLMS_Payment_Gateway extending class used for the payment.
* WP_Error if the gateway cannot be located, e.g. because it's no longer enabled.
*/
public function get_gateway() {
$gateways = llms()->payment_gateways();
$gateway = $gateways->get_gateway_by_id( $this->get( 'payment_gateway' ) );
if ( $gateway && ( $gateway->is_enabled() || is_admin() ) ) {
return $gateway;
} else {
return new WP_Error( 'error', sprintf( __( 'Payment gateway %s could not be located or is no longer enabled', 'lifterlms' ), $this->get( 'payment_gateway' ) ) );
}
}
/**
* Get the initial payment amount due on checkout
*
* This will always be the value of "total" except when the product has a trial.
*
* @since 3.0.0
*
* @return mixed
*/
public function get_initial_price( $price_args = array(), $format = 'html' ) {
if ( $this->has_trial() ) {
$price = 'trial_total';
} else {
$price = 'total';
}
return $this->get_price( $price, $price_args, $format );
}
/**
* Get an array of the order notes
*
* Each note is actually a WordPress comment.
*
* @since 3.0.0
*
* @param integer $number Number of comments to return.
* @param integer $page Page number for pagination.
* @return array
*/
public function get_notes( $number = 10, $page = 1 ) {
$comments = get_comments(
array(
'status' => 'approve',
'number' => $number,
'offset' => ( $page - 1 ) * $number,
'post_id' => $this->get( 'id' ),
)
);
return $comments;
}
/**
* Retrieve an LLMS_Post_Model object for the associated product
*
* @since 3.8.0
*
* @return LLMS_Post_Model|WP_Post|null|false LLMS_Post_Model extended object (LLMS_Course|LLMS_Membership),
* null if WP get_post() fails,
* false if LLMS_Post_Model extended class isn't found.
*/
public function get_product() {
return llms_get_post( $this->get( 'product_id' ) );
}
/**
* Retrieve the last (most recent) transaction processed for the order.
*
* @since 3.0.0
* @since 7.1.0 Skip counting the total rows found when retrieving the last transaction.
*
* @param array|string $status Filter by status (see transaction statuses). By default looks for any status.
* @param array|string $type Filter by type [recurring|single|trial]. By default looks for any type.
* @return LLMS_Transaction|false instance of the LLMS_Transaction or false if none found
*/
public function get_last_transaction( $status = 'any', $type = 'any' ) {
$txns = $this->get_transactions(
array(
'per_page' => 1,
'status' => $status,
'type' => $type,
'no_found_rows' => true,
)
);
if ( $txns['count'] ) {
return array_pop( $txns['transactions'] );
}
return false;
}
/**
* Retrieve the date of the last (most recent) transaction
*
* @since 3.0.0
*
* @param array|string $status Optional. Filter by status (see transaction statuses). Default is 'llms-txn-succeeded'.
* @param array|string $type Optional. Filter by type [recurring|single|trial]. By default looks for any type.
* @param string $format Optional. Date format of the return. Default is 'Y-m-d H:i:s'.
* @return string|false Date or false if none found.
*/
public function get_last_transaction_date( $status = 'llms-txn-succeeded', $type = 'any', $format = 'Y-m-d H:i:s' ) {
$txn = $this->get_last_transaction( $status, $type );
if ( $txn ) {
return $txn->get_date( 'date', $format );
} else {
return false;
}
}
/**
* Retrieve the due date of the next payment according to access plan terms
*
* @since 3.0.0
* @since 3.19.0 Unknown.
* @since 5.2.0 Use stric type comparisons.
*
* @param string $format Optional. Date return format. Default is 'Y-m-d H:i:s'.
* @return string
*/
public function get_next_payment_due_date( $format = 'Y-m-d H:i:s' ) {
// Single payments will never have a next payment date.
if ( ! $this->is_recurring() ) {
return new WP_Error( 'not-recurring', __( 'Order is not recurring', 'lifterlms' ) );
} elseif ( ! in_array( $this->get( 'status' ), array( 'llms-active', 'llms-failed', 'llms-on-hold', 'llms-pending', 'llms-pending-cancel' ), true ) ) {
return new WP_Error( 'invalid-status', __( 'Invalid order status', 'lifterlms' ), $this->get( 'status' ) );
}
// Retrieve the saved due date.
$next_payment_time = $this->get_date( 'date_next_payment', 'U' );
// Calculate it if not saved.
if ( ! $next_payment_time ) {
$next_payment_time = $this->calculate_next_payment_date( 'U' );
if ( ! $next_payment_time ) {
return new WP_Error( 'plan-ended', __( 'No more payments due', 'lifterlms' ) );
}
}
/**
* Filter the next payment due date.
*
* A timestamp should always be returned as the conversion to the requested format
* will be performed on the returned value.
*
* @since 3.0.0
*
* @param int $next_payment_time Unix timestamp for the next payment due date.
* @param LLMS_Order $order Order object.
* @param string $format Requested date format.
*/
$next_payment_time = apply_filters( 'llms_order_get_next_payment_due_date', $next_payment_time, $this, $format );
return date_i18n( $format, $next_payment_time );
}
/**
* Retrieve the timestamp of the next scheduled event for a given action
*
* @since 4.6.0
*
* @param string $action Action hook ID. Core actions are "llms_charge_recurring_payment", "llms_access_plan_expiration".
* @return int|false Returns the timestamp of the next action as an integer or `false` when no action exist.
*/
public function get_next_scheduled_action_time( $action ) {
return as_next_scheduled_action( $action, $this->get_action_args() );
}
/**
* Retrieves the number of payments remaining for a recurring plan with a limited number of payments
*
* @since 5.3.0
*
* @return bool|int Returns `false` for invalid order types (single-payment orders or recurring orders
* without a billing length). Otherwise returns the number of remaining payments as an integer.
*/
public function get_remaining_payments() {
$remaining = false;
if ( $this->has_plan_expiration() ) {
$len = $this->get( 'billing_length' );
$txns = $this->get_transactions(
array(
'status' => array( 'llms-txn-succeeded', 'llms-txn-refunded' ),
'per_page' => 1,
'type' => array( 'recurring', 'single' ), // If a manual payment is recorded it's counted a single payment and that should count.
)
);
$remaining = $len - $txns['total'];
}
/**
* Filters the number of payments remaining for a recurring plan with a limited number of payments.
*
* @since 5.3.0
*
* @param bool|int $remaining Number of remaining payments or `false` when called against invalid order types.
* @param LLMS_Order $order Order object.
*/
return apply_filters( 'llms_order_remaining_payments', $remaining, $this );
}
/**
* Get configured payment retry rules
*
* @since 3.10.0
*
* @return array[] {
* An array of retry rule arrays.
*
* @type int $delay The number of seconds to delay to use when scheduling the retry attempt.
* @type string $status The status of the order while awaiting the next retry.
* @type bool $notifications Whether or not to trigger notifications to the student/user.
* }
*/
private function get_retry_rules() {
$rules = array(
array(
'delay' => HOUR_IN_SECONDS * 12,
'status' => 'on-hold',
'notifications' => false,
),
array(
'delay' => DAY_IN_SECONDS,
'status' => 'on-hold',
'notifications' => true,
),
array(
'delay' => DAY_IN_SECONDS * 2,
'status' => 'on-hold',
'notifications' => true,
),
array(
'delay' => DAY_IN_SECONDS * 3,
'status' => 'on-hold',
'notifications' => true,
),
);
/**
* Filters the automatic payment recurring retry rules.
*
* @since 7.0.0
*
* @param array $rules Array of retry rule arrays {@see LLMS_Order::get_retry_rules()}.
* @param LLMS_Order $rules The order object.
*/
return apply_filters( 'llms_order_automatic_retry_rules', $rules, $this );
}
/**
* SQL query to retrieve total amounts for transactions by type
*
* @since 3.0.0
* @since 3.35.0 Prepare SQL query properly.
* @since 7.7.0 Caching results to avoid duplicate queries.
*
* @param string $type Optional. Type can be 'amount' or 'refund_amount'. Default is 'amount'.
* @return float
*/
public function get_transaction_total( $type = 'amount' ) {
// Check the cache.
static $cache = array();
if ( isset( $cache[ $this->get( 'id' ) ] )
&& isset( $cache[ $this->get( 'id' ) ][ $type ] ) ) {
return $cache[ $this->get( 'id' ) ][ $type ];
}
$statuses = array( 'llms-txn-refunded' );
if ( 'amount' === $type ) {
$statuses[] = 'llms-txn-succeeded';
}
$post_statuses = '';
foreach ( $statuses as $i => $status ) {
$post_statuses .= " p.post_status = '$status'";
if ( $i + 1 < count( $statuses ) ) {
$post_statuses .= 'OR';
}
}
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- $post_statuses is prepared above.
$grosse = $wpdb->get_var(
$wpdb->prepare(
"SELECT SUM( m2.meta_value )
FROM $wpdb->posts AS p
LEFT JOIN $wpdb->postmeta AS m1 ON m1.post_id = p.ID -- Join for the ID.
LEFT JOIN $wpdb->postmeta AS m2 ON m2.post_id = p.ID -- Get the actual amounts.
WHERE p.post_type = 'llms_transaction'
AND ( $post_statuses )
AND m1.meta_key = %s
AND m1.meta_value = %d
AND m2.meta_key = %s
;",
array(
"{$this->meta_prefix}order_id",
$this->get( 'id' ),
"{$this->meta_prefix}{$type}",
)
)
); // db call ok; no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
// Save to cache.
if ( ! isset( $cache[ $this->get( 'id' ) ] ) ) {
$cache[ $this->get( 'id' ) ] = array();
}
$cache[ $this->get( 'id' ) ][ $type ] = floatval( $grosse );
return $cache[ $this->get( 'id' ) ][ $type ];
}
/**
* Get the start date for the order.
*
* Gets the date of the first initially successful transaction
* if none found, uses the created date of the order.
*
* @since 3.0.0
* @since 7.1.0 Skip counting the total rows found when retrieving the first transaction.
*
* @param string $format Desired return format of the date.
* @return string
*/
public function get_start_date( $format = 'Y-m-d H:i:s' ) {
/**
* Get the first recorded transaction.
* Refunds are okay b/c that would have initially given the user access.
*/
$txns = $this->get_transactions(
array(
'order' => 'ASC',
'orderby' => 'date',
'per_page' => 1,
'status' => array( 'llms-txn-succeeded', 'llms-txn-refunded' ),
'type' => 'any',
'no_found_rows' => true,
)
);
if ( $txns['count'] ) {
$txn = array_pop( $txns['transactions'] );
$date = $txn->get_date( 'date', $format );
} else {
$date = $this->get_date( 'date', $format );
}
/**
* Filter the order start date.
*
* @since 3.0.0
* @since 7.1.0 Added the `$format` parameter.
*
* @param string $date The formatted start date for the order.
* @param LLMS_Order $order The order object.
* @param string $format The requested format of the date.
*/
return apply_filters( 'llms_order_get_start_date', $date, $this, $format );
}
/**
* Retrieves the user action required when changing the order's payment source.
*
* @since 7.0.0
*
* @return null|string Returns `switch` when the payment source can be switched and `pay` when payment on the new source
* is required before switching. A `null` return indicates that the order's payment source cannot be switched.
*/
public function get_switch_source_action() {
$action = null;
if ( $this->can_switch_source() ) {
$action = in_array( $this->get( 'status' ), array( 'llms-active', 'llms-pending-cancel' ), true ) ? 'switch' : 'pay';
}
/**
* Filters the required user action for the order when switching the order's payment source.
*
* @since 7.0.0
*
* @param null|string $action The switch action ID or `null` when the payment source cannot be switched.
* @param LLMS_Order $order The order object.
*/
return apply_filters( 'llms_order_switch_source_action', $action, $this );
}
/**
* Retrieve an array of transactions associated with the order according to supplied arguments.
*
* @since 3.0.0
* @since 3.10.0 Unknown.
* @since 3.37.6 Add additional return property, `total`, which returns the total number of found transactions.
* @since 5.2.0 Use stric type comparisons.
* @since 7.1.0 Added `no_found_rows` parameter.
*
* @param array $args {
* Hash of query argument data, ultimately passed to a WP_Query.
*
* @type string|string[] $status Transaction post status or array of transaction post status. Defaults to "any".
* @type string|string[] $type Transaction types or array of transaction types. Defaults to "any".
* Accepts "recurring", "single", or "trial".
* @type int $per_page Number of transactions to include in the return. Default `50`.
* @type int $paged Result set page number.
* @type string $order Result set order. Default "DESC". Accepts "DESC" or "ASC".
* @type string $orderby Result set ordering field. Default "date".
* @type bool $no_found_rows Whether to skip counting the total rows found. Enabling can improve
* performance. Default `false`.
* }
* @return array
*/
public function get_transactions( $args = array() ) {
extract(
wp_parse_args(
$args,
array(
'status' => 'any', // String or array or post statuses.
'type' => 'any', // String or array of transaction types [recurring|single|trial].
'per_page' => 50, // Int, number of transactions to return.
'paged' => 1, // Int, page number of transactions to return.
'order' => 'DESC',
'orderby' => 'date', // Field to order results by.
'no_found_rows' => false,
)
)
);
// Assume any and use this to check for valid statuses.
$statuses = llms_get_transaction_statuses();
// Check statuses.
if ( 'any' !== $statuses ) {
// If status is a string, ensure it's a valid status.
if ( is_string( $status ) && in_array( $status, $statuses, true ) ) {
$statuses = array( $status );
} elseif ( is_array( $status ) ) {
$temp = array();
foreach ( $status as $stat ) {
if ( in_array( (string) $stat, $statuses, true ) ) {
$temp[] = $stat;
}
}
$statuses = $temp;
}
}
// Setup type meta query.
$types = array(
'relation' => 'OR',
);
if ( 'any' === $type ) {
$types[] = array(
'key' => $this->meta_prefix . 'payment_type',
'value' => 'recurring',
);
$types[] = array(
'key' => $this->meta_prefix . 'payment_type',
'value' => 'single',
);
$types[] = array(
'key' => $this->meta_prefix . 'payment_type',
'value' => 'trial',
);
} elseif ( is_string( $type ) ) {
$types[] = array(
'key' => $this->meta_prefix . 'payment_type',
'value' => $type,
);
} elseif ( is_array( $type ) ) {
foreach ( $type as $t ) {
$types[] = array(
'key' => $this->meta_prefix . 'payment_type',
'value' => $t,
);
}
}
// Execute the query.
$query = new WP_Query(
/**
* Filters the order's transactions query aguments.
*
* @since 3.0.0
* @since 7.1.0 Added `$no_found_rows` arg.
*
* @param array $query_args {
* Hash of query argument data passed to a WP_Query.
*
* @type string|string[] $status Transaction post status or array of transaction post status.
* Defaults to "any".
* @type string|string[] $type Transaction types or array of transaction types.
* Defaults to "any".
* Accepts "recurring", "single", or "trial".
* @type int $per_page Number of transactions to include in the return. Default `50`.
* @type int $paged Result set page number.
* @type string $order Result set order. Default "DESC". Accepts "DESC" or "ASC".
* @type string $orderby Result set ordering field. Default "date".
* @type bool $no_found_rows Whether to skip counting the total rows found.
* Enabling can improve performance. Default false.
* }
*/
apply_filters(
'llms_order_get_transactions_query',
array(
'meta_query' => array(
'relation' => 'AND',
array(
'key' => $this->meta_prefix . 'order_id',
'value' => $this->get( 'id' ),
),
$types,
),
'order' => $order,
'orderby' => $orderby,
'post_status' => $statuses,
'post_type' => 'llms_transaction',
'posts_per_page' => $per_page,
'paged' => $paged,
'no_found_rows' => $no_found_rows,
)
),
$this,
$status
);
$transactions = array();
foreach ( $query->posts as $post ) {
$transactions[ $post->ID ] = llms_get_post( $post );
}
return array(
'total' => $query->found_posts,
'count' => $query->post_count,
'page' => $paged,
'pages' => $query->max_num_pages,
'transactions' => $transactions,
);
}
/**
* Retrieve the date when a trial will end
*
* @since 3.0.0
*
* @param string $format Optional. Date return format. Default is 'Y-m-d H:i:s'.
* @return string
*/
public function get_trial_end_date( $format = 'Y-m-d H:i:s' ) {
if ( ! $this->has_trial() ) {
$trial_end_date = '';
} else {
// Retrieve the saved end date.
$trial_end_date = $this->get_date( 'date_trial_end', $format );
// If not saved, calculate it.
if ( ! $trial_end_date ) {
$trial_end_date = $this->calculate_trial_end_date( $format );
}
}
return apply_filters( 'llms_order_get_trial_end_date', $trial_end_date, $this );
}
/**
* Gets the total revenue of an order
*
* @since 3.0.0
* @since 3.1.3 Handle legacy orders.
*
* @param string $type Optional. Revenue type [grosse|net]. Default is 'net'.
* @return float
*/
public function get_revenue( $type = 'net' ) {
if ( $this->is_legacy() ) {
$amount = $this->get( 'total' );
} else {
$amount = $this->get_transaction_total( 'amount' );
if ( 'net' === $type ) {
$refunds = $this->get_transaction_total( 'refund_amount' );
$amount = $amount - $refunds;
}
}
return apply_filters( 'llms_order_get_revenue', $amount, $type, $this );
}
/**
* Get a link to view the order on the student dashboard
*
* @since 3.0.0
* @since 3.8.0 Unknown.
*
* @return string
*/
public function get_view_link() {
$link = llms_get_endpoint_url( 'orders', $this->get( 'id' ), llms_get_page_url( 'myaccount' ) );
return apply_filters( 'llms_order_get_view_link', $link, $this );
}
/**
* Determine if the student associated with this order has access
*
* @since 3.0.0
*
* @return boolean
*/
public function has_access() {
return ( 'active' === $this->get_access_status() ) ? true : false;
}
/**
* Determine if a coupon was used
*
* @since 3.0.0
*
* @return boolean
*/
public function has_coupon() {
return ( 'yes' === $this->get( 'coupon_used' ) );
}
/**
* Determine if there was a discount applied to this order via either a sale or a coupon
*
* @since 3.0.0
*
* @return boolean
*/
public function has_discount() {
return ( $this->has_coupon() || $this->has_sale() );
}
/**
* Determine if a recurring order has a limited number of payments
*
* @since 5.3.0
*
* @return boolean Returns `true` for recurring orders with a billing length and `false` otherwise.
*/
public function has_plan_expiration() {
return ( $this->is_recurring() && ( $this->get( 'billing_length' ) > 0 ) );
}
/**
* Determine if the access plan was on sale during the purchase
*
* @since 3.0.0
*
* @return boolean
*/
public function has_sale() {
return ( 'yes' === $this->get( 'on_sale' ) );
}
/**
* Determine if there's a payment scheduled for the order
*
* @since 3.0.0
*
* @return boolean
*/
public function has_scheduled_payment() {
$date = $this->get_next_payment_due_date();
return is_wp_error( $date ) ? false : true;
}
/**
* Determine if the order has a trial
*
* @since 3.0.0
*
* @return boolean True if has a trial, false if it doesn't.
*/
public function has_trial() {
return ( $this->is_recurring() && 'yes' === $this->get( 'trial_offer' ) );
}
/**
* Determine if the trial period has ended for the order
*
* @since 3.0.0
* @since 3.10.0 Unknown.
*
* @return boolean True if ended, false if not ended.
*/
public function has_trial_ended() {
return ( llms_current_time( 'timestamp' ) >= $this->get_trial_end_date( 'U' ) );
}
/**
* Initializes a new order with user, plan, gateway, and coupon metadata.
*
* Assumes all data passed in has already been validated.
*
* @since 3.8.0
* @since 3.10.0 Unknown.
* @since 5.3.0 Don't set unused legacy property `date_billing_end`.
* @since 7.0.0 Use `LLMS_Order::set_user_data()` to update user data.
*
* @param array|LLMS_Student|WP_User|integer $user_data User info for the person placing the order. See
* {@see LLMS_Order::set_user_data()} for more info.
* @param LLMS_Access_Plan $plan The purchase access plan.
* @param LLMS_Payment_Gateway $gateway Gateway being used.
* @param LLMS_Coupon $coupon Coupon object or `false` if no coupon used.
* @return LLMS_Order
*/
public function init( $user_data, $plan, $gateway, $coupon = false ) {
$this->set_user_data( $user_data );
// Access plan data.
$this->set( 'plan_id', $plan->get( 'id' ) );
$this->set( 'plan_title', $plan->get( 'title' ) );
$this->set( 'plan_sku', $plan->get( 'sku' ) );
// Product data.
$product = $plan->get_product();
$this->set( 'product_id', $product->get( 'id' ) );
$this->set( 'product_title', $product->get( 'title' ) );
$this->set( 'product_sku', $product->get( 'sku' ) );
$this->set( 'product_type', $plan->get_product_type() );
$this->set( 'payment_gateway', $gateway->get_id() );
$this->set( 'gateway_api_mode', $gateway->get_api_mode() );
// Trial data.
if ( $plan->has_trial() ) {
$this->set( 'trial_offer', 'yes' );
$this->set( 'trial_length', $plan->get( 'trial_length' ) );
$this->set( 'trial_period', $plan->get( 'trial_period' ) );
$trial_price = $plan->get_price( 'trial_price', array(), 'float' );
$this->set( 'trial_original_total', $trial_price );
$trial_total = $coupon ? $plan->get_price_with_coupon( 'trial_price', $coupon, array(), 'float' ) : $trial_price;
$this->set( 'trial_total', $trial_total );
$this->set( 'date_trial_end', $this->calculate_trial_end_date() );
} else {
$this->set( 'trial_offer', 'no' );
}
$price = $plan->get_price( 'price', array(), 'float' );
$this->set( 'currency', get_lifterlms_currency() );
// Price data.
if ( $plan->is_on_sale() ) {
$price_key = 'sale_price';
$this->set( 'on_sale', 'yes' );
$sale_price = $plan->get( 'sale_price', array(), 'float' );
$this->set( 'sale_price', $sale_price );
$this->set( 'sale_value', $price - $sale_price );
} else {
$price_key = 'price';
$this->set( 'on_sale', 'no' );
}
// Store original total before any discounts.
$this->set( 'original_total', $price );
// Get the actual total due after discounts if any are applicable.
$total = $coupon ? $plan->get_price_with_coupon( $price_key, $coupon, array(), 'float' ) : $$price_key;
$this->set( 'total', $total );
// Coupon data.
if ( $coupon ) {
$this->set( 'coupon_id', $coupon->get( 'id' ) );
$this->set( 'coupon_amount', $coupon->get( 'coupon_amount' ) );
$this->set( 'coupon_code', $coupon->get( 'title' ) );
$this->set( 'coupon_type', $coupon->get( 'discount_type' ) );
$this->set( 'coupon_used', 'yes' );
$this->set( 'coupon_value', $$price_key - $total );
if ( $plan->has_trial() && $coupon->has_trial_discount() ) {
$this->set( 'coupon_amount_trial', $coupon->get( 'trial_amount' ) );
$this->set( 'coupon_value_trial', $trial_price - $trial_total );
}
} else {
$this->set( 'coupon_used', 'no' );
}
// Get all billing schedule related information.
$this->set( 'billing_frequency', $plan->get( 'frequency' ) );
if ( $plan->is_recurring() ) {
$this->set( 'billing_length', $plan->get( 'length' ) );
$this->set( 'billing_period', $plan->get( 'period' ) );
$this->set( 'order_type', 'recurring' );
$this->set( 'date_next_payment', $this->calculate_next_payment_date() );
} else {
$this->set( 'order_type', 'single' );
}
$this->set( 'access_expiration', $plan->get( 'access_expiration' ) );
// Get access related data so when payment is complete we can calculate the actual expiration date.
if ( $plan->can_expire() ) {
$this->set( 'access_expires', $plan->get( 'access_expires' ) );
$this->set( 'access_length', $plan->get( 'access_length' ) );
$this->set( 'access_period', $plan->get( 'access_period' ) );
}
/**
* Action triggered after the order is initialized.
*
* @since Unknown.
* @since 7.0.0 Added `$user_data` parameter.
* The `$student` parameter returns an "empty" student object
* if the method's input data is an array instead of an existing
* user object.
*
* @param LLMS_Order $order The order object.
* @param LLMS_Student $student The student object. If an array of data is passed
* to `LLMS_Order::init()` then an empty student object
* will be passed.
* @param array|LLMS_Student|WP_User|integer $user_data User data.
*/
do_action(
'lifterlms_new_pending_order',
$this,
is_array( $user_data ) ? new LLMS_Student( null, false ) : llms_get_student( $user_data ),
$user_data
);
return $this;
}
/**
* Determine if the order is a legacy order migrated from 2.x
*
* @since 3.0.0
*
* @return boolean
*/
public function is_legacy() {
return ( 'publish' === $this->get( 'status' ) );
}
/**
* Determine if the order is recurring or singular
*
* @since 3.0.0
*
* @return boolean True if recurring, false if not.
*/
public function is_recurring() {
return $this->get( 'order_type' ) === 'recurring';
}
/**
* Schedule access expiration
*
* @since 3.19.0
* @since 3.32.0 Update to use latest action-scheduler functions.
*
* @return void
*/
public function maybe_schedule_expiration() {
// Get expiration date based on setting.
$expires = $this->get_access_expiration_date( 'U' );
// Will return a timestamp or "Lifetime Access as a string".
if ( is_numeric( $expires ) ) {
$this->unschedule_expiration();
as_schedule_single_action( $expires, 'llms_access_plan_expiration', $this->get_action_args() );
}
}
/**
* Schedules the next payment due on a recurring order
*
* Can be called without consequence on a single payment order.
* Will always unschedule the scheduled action (if one exists) before scheduling another.
*
* @since 3.0.0
* @since 3.32.0 Update to use latest action-scheduler functions.
* @since 4.7.0 Add `plan_ended` metadata when a plan ends.
* @since 5.2.0 Move scheduling recurring payment into a proper method.
*
* @return void
*/
public function maybe_schedule_payment( $recalc = true ) {
if ( ! $this->is_recurring() ) {
return;
}
if ( $recalc ) {
$this->set( 'date_next_payment', $this->calculate_next_payment_date() );
}
$date = $this->get_next_payment_due_date();
// Unschedule and reschedule.
if ( $date && ! is_wp_error( $date ) ) {
$this->schedule_recurring_payment( $date );
} elseif ( is_wp_error( $date ) ) {
if ( 'plan-ended' === $date->get_error_code() ) {
// Unschedule the next action (does nothing if no action scheduled).
$this->unschedule_recurring_payment();
// Add a note that the plan has completed.
$this->add_note( __( 'Order payment plan completed.', 'lifterlms' ) );
$this->set( 'plan_ended', 'yes' );
}
}
}
/**
* Handles scheduling recurring payment retries when the gateway supports them
*
* @since 3.10.0
* @since 7.0.0 Added return value.
*
* @return null|boolean Returns `null` if the order cannot be retried, `false` when all retry rules have been tried (or none exist), and `true`
* when a retry is scheduled.
*/
public function maybe_schedule_retry() {
if ( ! $this->can_be_retried() ) {
return null;
}
// Get the index of the rule to use for this retry.
$current_rule_index = $this->get( 'last_retry_rule' );
if ( '' === $current_rule_index ) {
$current_rule_index = 0;
} else {
++$current_rule_index;
}
$rules = $this->get_retry_rules();
$current_rule = $rules[ $current_rule_index ] ?? false;
// No rule to run.
if ( ! $current_rule ) {
$this->set_status( 'failed' );
$this->set( 'last_retry_rule', '' );
$this->add_note( esc_html__( 'Maximum retry attempts reached.', 'lifterlms' ) );
/**
* Action triggered when there are not more recurring payment retry rules.
*
* @since 3.10.0
*
* @param LLMS_Order $order The order object.
*/
do_action( 'llms_automatic_payment_maximum_retries_reached', $this );
return false;
}
$timestamp = current_time( 'timestamp' ) + $current_rule['delay'];
$this->set_date( 'next_payment', date_i18n( 'Y-m-d H:i:s', $timestamp ) );
$this->set_status( $current_rule['status'] );
$this->set( 'last_retry_rule', $current_rule_index );
$this->add_note(
sprintf(
// Translators: %s = next attempt date.
esc_html__( 'Automatic retry attempt scheduled for %s', 'lifterlms' ),
date( get_option( 'date_format' ) . ' ' . get_option( 'time_format' ), $timestamp )
)
);
// If notifications should be sent, trigger them.
if ( $current_rule['notifications'] ) {
/**
* Triggers the "Payment Retry Scheduled" notification.
*
* @since 3.10.0
*
* @param LLMS_Order $order The order object.
*/
do_action( 'llms_send_automatic_payment_retry_notification', $this );
}
/**
* Action triggered after a recurring payment retry is successfully scheduled.
*
* @since 3.10.0
*
* @param LLMS_Order $order The order object.
*/
do_action( 'llms_automatic_payment_retry_scheduled', $this );
return true;
}
/**
* Record a transaction for the order
*
* @since 3.0.0
*
* @param array $data Optional array of additional data to store for the transaction.
* @return LLMS_Transaction Instance of LLMS_Transaction for the created transaction.
*/
public function record_transaction( $data = array() ) {
extract(
array_merge(
array(
'amount' => 0,
'completed_date' => current_time( 'mysql' ),
'customer_id' => '',
'fee_amount' => 0,
'source_id' => '',
'source_description' => '',
'transaction_id' => '',
'status' => 'llms-txn-succeeded',
'payment_gateway' => $this->get( 'payment_gateway' ),
'payment_type' => 'single',
),
$data
)
);
$txn = new LLMS_Transaction( 'new', $this->get( 'id' ) );
$txn->set( 'api_mode', $this->get( 'gateway_api_mode' ) );
$txn->set( 'amount', $amount );
$txn->set( 'currency', $this->get( 'currency' ) );
$txn->set( 'gateway_completed_date', date_i18n( 'Y-m-d h:i:s', strtotime( $completed_date ) ) );
$txn->set( 'gateway_customer_id', $customer_id );
$txn->set( 'gateway_fee_amount', $fee_amount );
$txn->set( 'gateway_source_id', $source_id );
$txn->set( 'gateway_source_description', $source_description );
$txn->set( 'gateway_transaction_id', $transaction_id );
$txn->set( 'order_id', $this->get( 'id' ) );
$txn->set( 'payment_gateway', $payment_gateway );
$txn->set( 'payment_type', $payment_type );
$txn->set( 'status', $status );
return $txn;
}
/**
* Date field setter for date fields that require things to be updated when their value changes
*
* This is mainly used to allow updating dates which are editable from the admin panel which
* should trigger additional actions when updated.
*
* Settable dates: date_next_payment, date_trial_end, date_access_expires.
*
* @since 3.10.0
* @since 3.19.0 Unknown.
*
* @param string $date_key Date field to set.
* @param string $date_val Date string or a unix time stamp.
*/
public function set_date( $date_key, $date_val ) {
// Convert to timestamp if not already a timestamp.
if ( ! is_numeric( $date_val ) ) {
$date_val = strtotime( $date_val );
}
$this->set( 'date_' . $date_key, date( 'Y-m-d H:i:s', $date_val ) );
switch ( $date_key ) {
// Reschedule access expiration.
case 'access_expires':
$this->maybe_schedule_expiration();
break;
// Additionally update the next payment date & don't break because we want to reschedule payments too.
case 'trial_end':
$this->set_date( 'next_payment', $this->calculate_next_payment_date( 'U' ) );
// Everything else reschedule's payments.
default:
$this->maybe_schedule_payment( false );
}
}
/**
* Update the status of an order
*
* @since 3.8.0
* @since 3.10.0 Unknown.
* @since 5.2.0 Prefer `array_key_exists( $key, $keys )` over `in_array( $key, array_keys( $assoc_array ) )`.
*
* @param string $status Status name, accepts unprefixed statuses.
* @return void
*/
public function set_status( $status ) {
if ( false === strpos( $status, 'llms-' ) ) {
$status = 'llms-' . $status;
}
if ( array_key_exists( $status, llms_get_order_statuses( $this->get( 'order_type' ) ) ) ) {
$this->set( 'status', $status );
}
}
/**
* Sets user-related metadata for the order.
*
* @since 7.0.0
*
* @param array|LLMS_Student|WP_User|integer $user_or_data Accepts a raw array user meta-data or
* an input string accepted by `llms_get_student()`.
* When passing an existing user the data will be pulled
* from the user metadata and saved to the order.
* @return array {
* Returns an associative array representing the user metadata that was stored on the order.
*
* @type integer $user_id User's WP_User id.
* @type string $user_ip_address User's ip address.
* @type string $billing_email User's email.
* @type string $billing_first_name User's first name.
* @type string $billing_last_name User's last name.
* @type string $billing_address_1 User's address line 1.
* @type string $billing_address_2 User's address line 2.
* @type string $billing_city User's city.
* @type string $billing_state User's state.
* @type string $billing_zip User's zip.
* @type string $billing_country User's country.
* @type string $billing_phone User's phone.
* }
*/
public function set_user_data( $user_or_data ) {
$to_set = array(
'user_id' => '',
'billing_email' => '',
'billing_first_name' => '',
'billing_last_name' => '',
'billing_address_1' => '',
'billing_address_2' => '',
'billing_city' => '',
'billing_state' => '',
'billing_zip' => '',
'billing_country' => '',
'billing_phone' => '',
);
$user = ! is_array( $user_or_data ) ? llms_get_student( $user_or_data ) : false;
if ( $user ) {
$user_or_data = array();
$map = array(
'user_id' => 'id',
'billing_email' => 'user_email',
'billing_phone' => 'phone',
'billing_first_name' => 'first_name',
'billing_last_name' => 'last_name',
);
foreach ( array_keys( $to_set ) as $order_key ) {
$to_set[ $order_key ] = $user->get( $map[ $order_key ] ?? $order_key );
}
}
// Only use the default IP address if it wasn't specified in the input array.
$to_set['user_ip_address'] = $user_or_data['user_ip_address'] ?? llms_get_ip_address();
// Merge the data and remove excess keys.
$to_set = array_intersect_key(
array_merge( $to_set, $user_or_data ),
$to_set
);
$this->set_bulk( $to_set );
return $to_set;
}
/**
* Record the start date of the access plan and schedule expiration if expiration is required in the future
*
* @since 3.0.0
* @since 3.19.0 Unknown.
* @since 5.2.0 Use strict type comparision.
*
* @return void
*/
public function start_access() {
// Only start access if access isn't already started.
$date = $this->get( 'start_date' );
if ( ! $date ) {
// Set the start date to now.
$date = llms_current_time( 'mysql' );
$this->set( 'start_date', $date );
}
$this->unschedule_expiration();
// Setup expiration.
if ( in_array( $this->get( 'access_expiration' ), array( 'limited-date', 'limited-period' ), true ) ) {
$expires_date = $this->get_access_expiration_date( 'Y-m-d H:i:s' );
$this->set( 'date_access_expires', $expires_date );
$this->maybe_schedule_expiration();
}
}
/**
* Cancels a scheduled expiration action
*
* Does nothing if no expiration is scheduled
*
* @since 3.19.0
* @since 3.32.0 Update to use latest action-scheduler functions.
* @since 4.6.0 Use `$this->get_next_scheduled_action_time()` to determine if the action is currently scheduled.
*
* @return void
*/
public function unschedule_expiration() {
if ( $this->get_next_scheduled_action_time( 'llms_access_plan_expiration' ) ) {
as_unschedule_action( 'llms_access_plan_expiration', $this->get_action_args() );
}
}
/**
* Cancels a scheduled recurring payment action
*
* Does nothing if no payments are scheduled
*
* @since 3.0.0
* @since 3.32.0 Update to use latest action-scheduler functions.
* @since 4.6.0 Use `$this->get_next_scheduled_action_time()` to determine if the action is currently scheduled.
*
* @return void
*/
public function unschedule_recurring_payment() {
if ( $this->get_next_scheduled_action_time( 'llms_charge_recurring_payment' ) ) {
$action_args = $this->get_action_args();
as_unschedule_action( 'llms_charge_recurring_payment', $action_args );
/**
* Fired after a recurring payment is unscheduled
*
* @since 5.2.0
*
* @param LLMS_Order $order LLMS_Order instance.
* @param int $date Timestamp of the recurring payment date UTC.
* @param array $action_args Arguments passed to the scheduler.
*/
do_action( 'llms_charge_recurring_payment_unscheduled', $this, $action_args );
}
}
/**
* Schedule recurring payment
*
* It will unschedule the next recurring payment action, if any, before scheduling.
*
* @since 5.2.0
*
* @param string $next_payment_date Optional. Next payment date. If not provided it'll be retrieved using `$this->get_next_payment_due_date()`.
* @param boolean $gmt Optional. Whether the provided `$next_payment_date` date is gmt. Default is `false`.
* Only applies when the `$next_payment_date` is provided.
* @return WP_Error|integer WP_Error if the plan ended. Otherwise returns the return value of `as_schedule_single_action`: the action's ID.
*/
public function schedule_recurring_payment( $next_payment_date = false, $gmt = false ) {
// Unschedule the next action (does nothing if no action scheduled).
$this->unschedule_recurring_payment();
$date = $this->get_recurring_payment_due_date_for_scheduler( $next_payment_date, $gmt );
if ( is_wp_error( $date ) ) {
return $date;
}
$action_args = $this->get_action_args();
// Schedule the payment.
$action_id = as_schedule_single_action(
$date,
'llms_charge_recurring_payment',
$action_args
);
/**
* Fired after a recurring payment is scheduled
*
* @since 5.2.0
*
* @param LLMS_Order $order LLMS_Order instance.
* @param integer $date Timestamp of the recurring payment date UTC.
* @param array $action_args Arguments passed to the scheduler.
* @param integer $action_id Scheduled action ID.
*/
do_action( 'llms_charge_recurring_payment_scheduled', $this, $date, $action_args, $action_id );
return $action_id;
}
/**
* Returns the recurring payment due date in a suitable format for the scheduler.
*
* @since 5.2.0
*
* @param string $next_payment_date Optional. Next payment date. If not provided it'll be retrieved using `$this->get_next_payment_due_date()`.
* @param boolean $gmt Optional. Whether the provided `$next_payment_date` date is gmt. Default is `false`.
* Only applies when the `$next_payment_date` is provided.
* @return WP_Error|integer
*/
public function get_recurring_payment_due_date_for_scheduler( $next_payment_date = false, $gmt = false ) {
$date = false === $next_payment_date ? $this->get_next_payment_due_date() : $next_payment_date;
if ( ! $date ) {
return new WP_Error( 'invalid-recurring-payment-date', __( 'Next recurring payment due date is not valid', 'lifterlms' ) );
}
if ( is_wp_error( $date ) ) {
return $date;
}
// Convert our date to Unix time and UTC before passing to the scheduler.
// No date parameter passed, or passed date parameter was not in gmt.
if ( ! $next_payment_date || ( $next_payment_date && ! $gmt ) ) {
$date = get_gmt_from_date( $date, 'U' );
} else {
// Get timestamp.
$date = date_format( date_create( $date ), 'U' );
}
return (int) $date;
}
/**
* Determine whether the recurring payment for this order can be modified.
*
* Depends on whether the order's gateway supports.
*
* @since 7.0.0
*
* @return bool
*/
public function supports_modify_recurring_payments() {
$gateway = $this->get_gateway();
return is_wp_error( $gateway ) ? false : $gateway->supports( 'modify_recurring_payments', $this );
}
}
================================================
FILE: includes/models/model.llms.post.instructors.php
================================================
<?php
/**
* LLMS Post Instructors
*
* @package LifterLMS/Models/Classes
*
* @since 3.13.0
* @version 4.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Post_Instructors class
*
* Allow interactions with the custom multi-author functionality
* currently enabled for Courses and Memberships only.
*
* Rather than instantiating this class directly
* you should use LLMS_Course->instructors() or LLMS_Membership()->instructors()
*
* @since 3.13.0
* @since 3.30.3 Explicitly define class properties.
* @since 4.0.0 Remove deprecated method `get_defaults()`.
* @since 4.2.0 Normalized return structure in `get_instructors()` when no instructor set.
*/
class LLMS_Post_Instructors {
/**
* WP Post ID
*
* @var int
*/
public $id;
/**
* Instance of the post (course or membership)
*
* @var LLMS_Post_Model
*/
public $post;
/**
* Constructor
*
* @since 3.13.0
*
* @param LLMS_Post_Model|WP_Post|int $post Post object or ID.
*/
public function __construct( $post ) {
// Setup a post if post id of WP_Post is passed in.
if ( is_numeric( $post ) || is_a( $post, 'WP_Post' ) ) {
$post = llms_get_post( $post );
}
// Double check we have an LLMS_Post.
if ( is_subclass_of( $post, 'LLMS_Post_Model' ) ) {
$this->post = $post;
$this->id = $post->get( 'id' );
}
}
/**
* Retrieve course instructor information
*
* @since 3.13.0
* @since 3.23.0 Unknown.
* @since 4.2.0 Normalize return data when no instructor data is saved.
*
* @param boolean $exclude_hidden If true, excludes hidden instructors from the return array.
* @return array[] {
* Array or instructor data arrays.
*
* @type int $id WP_User ID of the instructor user.
* @type string $visibility Display visibility option for the instructor.
* @type string $label User input display noun for the instructor. EG: "Author" or "Coach" or "Instructor".
* @type string $name WP_User Display Name.
* }
*/
public function get_instructors( $exclude_hidden = false ) {
$instructors = $this->post->get( 'instructors' );
// If empty, respond with the course author in an array.
if ( ! $instructors ) {
$author_id = $this->post->get( 'author' );
$author = get_userdata( $author_id );
$instructors = array(
wp_parse_args(
array(
'id' => $author_id,
'name' => $author ? $author->display_name : '',
),
llms_get_instructors_defaults()
),
);
}
if ( $exclude_hidden ) {
foreach ( $instructors as $key => $instructor ) {
if ( 'hidden' === $instructor['visibility'] ) {
unset( $instructors[ $key ] );
}
}
}
return $instructors;
}
/**
* Format an instructors array for saving to the db.
*
* @since 3.25.0
*
* @param array $instructors Array of full (or partial) instructor data.
* @return array
*/
public function pre_set_instructors( $instructors = array() ) {
/**
* We cannot allow no instructors to exist
* so we'll revert to the default `post_author`.
*/
if ( ! $instructors ) {
// Clear so the getter will retrieve the default author.
$this->post->set( 'instructors', array() );
$instructors = $this->get_instructors();
}
// Allow partial arrays to be passed & we'll fill em up with defaults.
foreach ( $instructors as $i => &$instructor ) {
$instructor = wp_parse_args( $instructor, llms_get_instructors_defaults() );
$instructor['id'] = absint( $instructor['id'] );
// Remove instructors without an ID.
if ( empty( $instructor['id'] ) ) {
unset( $instructors[ $i ] );
}
}
return array_values( $instructors );
}
/**
* Save instructor information
*
* @since 3.13.0
* @since 3.25.0 Unknown.
*
* @param array $instructors Array of course instructor information.
*/
public function set_instructors( $instructors = array() ) {
$instructors = $this->pre_set_instructors( $instructors );
// Set the post_author to be the first author in the array.
$this->post->set( 'author', $instructors[0]['id'] );
// Save the instructors array.
$this->post->set( 'instructors', $instructors );
return $instructors;
}
}
================================================
FILE: includes/models/model.llms.product.php
================================================
<?php
/**
* LifterLMS Product Model.
*
* @package LifterLMS/Models/Classes
*
* @since 1.0.0
* @version 6.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Product model class.
*
* Both Courses and Memberships are sellable and can be instantiated as a product.
*
* @since 1.0.0
* @since 3.25.2 Unknown.
* @since 3.37.17 Fixed a typo in the `post_status` query arg when retrieving access plans for this product.
* Use `in_array` with strict comparison where possible.
* @since 3.38.0 Add `get_restrictions()` and `has_restrictions()` methods.
*/
class LLMS_Product extends LLMS_Post_Model {
/**
* Model properties.
*
* @var array
*/
protected $properties = array();
/**
* Model DB Post Type.
*
* @todo The post type depends conditionally on whether it's a course or a membership so this is semantically incorrect.
*
* @var string
*/
protected $db_post_type = 'product';
/**
* Model type.
*
* @var string
*/
protected $model_post_type = 'product';
/**
* Retrieve the max number of access plans that can be created for this product.
*
* @since 3.0.0
*
* @return int
*/
public function get_access_plan_limit() {
/**
* Determine the number of access plans allowed on the product.
*
* This is a (somewhat) arbitrary limit chosen mostly based on the following 2 factors:
*
* 1) It looks visually unappealing to have a pricing table with 7+ items on it.
* 2) Having 7+ pricing plans creates a lot of decision fatigue for users.
*
* If you disagree with either of these two factors you can quite easily change the
* limit using this filter.
*
* Keep in mind that increasing the limit will likely require you to add CSS to accommodate
* 7+ plans on the automatically generated pricing tables.
*
* Also, since plans are limited by the core to 6, we have no pagination built in for any queries that
* lookup or list access plans. This means that if you greatly increase the limit (say 200) you
* could very quickly run into issues where the default queries "do not scale" well. In which
* case you should first consider if you really need 200 plans and then start investigating other
* filters to add pagination (and probably caching) to these (now slow) queries.
*
* @since 3.0.0
*
* @param int $limit Number of plans.
* @param LLMS_Proudct $this Product object.
*/
return apply_filters( 'llms_get_product_access_plan_limit', 6, $this );
}
/**
* Get all access plans for the product.
*
* @since 3.0.0
* @since 3.25.2 Unknown.
* @since 3.37.17 Fixed a typo in the `post_status` query arg when retrieving access plans for this product.
*
* @param bool $free_only Optional. Only include free access plans if `true`. Defalt `false`
* @param bool $visible_only Optional. Excludes hidden access plans from results. Default `true`.
* @return array
*/
public function get_access_plans( $free_only = false, $visible_only = true ) {
$args = array(
'meta_key' => '_llms_product_id', // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_key
'meta_value' => $this->get( 'id' ), // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_value
'order' => 'ASC',
'orderby' => 'menu_order',
'posts_per_page' => $this->get_access_plan_limit(),
'post_type' => 'llms_access_plan',
'post_status' => 'publish',
);
// Filter results to only free access plans.
if ( $free_only ) {
$args['meta_query'] = array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_meta_query
array(
'key' => '_llms_is_free',
'value' => 'yes',
),
);
}
// Exclude hidden access plans from the results.
if ( $visible_only ) {
$args['tax_query'] = array( // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query
array(
'field' => 'name',
'operator' => 'NOT IN',
'terms' => array( 'hidden' ),
'taxonomy' => 'llms_access_plan_visibility',
),
);
}
/**
* Filter the product's access plan query args.
*
* @since Unknown
*
* @param array $args Query args.
* @param LLMS_Product $product The LLMS_Product instance.
* @param bool $free_only Whether or not to include the free access plans only.
* @param bool $visbile_only Whether or not to exclude the hidden access plans.
*/
$query = new WP_Query( apply_filters( 'llms_get_product_access_plans_args', $args, $this, $free_only, $visible_only ) );
$plans = array();
// If we have plans, setup access plan instances.
if ( $query->have_posts() ) {
foreach ( $query->posts as $post ) {
$plans[] = new LLMS_Access_Plan( $post );
}
}
/**
* Filter the product's access plans.
*
* @since Unknown
*
* @param array $plans An array of LLMS_Access_Plan instances related to the product `$product`.
* @param LLMS_Product $product The LLMS_Product instance.
* @param bool $free_only Whether or not to include the free access plans only.
* @param bool $visbile_only Whether or not to exclude the hidden access plans.
*/
return apply_filters( 'llms_get_product_access_plans', $plans, $this, $free_only, $visible_only );
}
/**
* Retrieve the product's catalog visibility term.
*
* @since 3.6.0
*
* @return string
*/
public function get_catalog_visibility() {
$terms = wp_get_post_terms( $this->get( 'id' ), 'llms_product_visibility' );
if ( $terms && is_array( $terms ) ) {
$obj = $terms[0];
if ( isset( $obj->name ) ) {
return $obj->name;
}
}
return 'catalog_search';
}
/**
* Retrieve the product's catalog visibility name for display.
*
* @since 3.6.0
*
* @return string
*/
public function get_catalog_visibility_name() {
$visibility = $this->get_catalog_visibility();
$options = llms_get_product_visibility_options();
if ( isset( $options[ $visibility ] ) ) {
return $options[ $visibility ];
}
return $visibility;
}
/**
* Get the number of columns for the pricing table.
*
* @since 3.0.0
*
* @param bool $free_only Optional. Only include free access plans if true. Default `false`.
* @return int
*/
public function get_pricing_table_columns_count( $free_only = false ) {
$count = count( $this->get_access_plans( $free_only ) );
switch ( $count ) {
case 0:
$cols = 1;
break;
case 6:
$cols = 3;
break;
default:
$cols = $count;
}
/**
* Filter the number of columns of the product's pricing table.
*
* @since 3.0.0
*
* @param int $cols The number of columns of the pricing table for the `$product`.
* @param LLMS_Product $product The LLMS_Product instance.
* @param int $count The number of access plans related to the product `$product`.
* @param bool $free_only Whether or not to include the free access plans only.
*/
return apply_filters( 'llms_get_product_pricing_table_columns_count', $cols, $this, $count, $free_only );
}
/**
* Retrieve a list of restrictions on the product.
*
* Restrictions are used to in conjunction with "is_purchasable()" to
* determine if purchase/enrollment should be allowed for a given product.
*
* Restrictions in the core currently only exist on courses:
* + Enrollment time period.
* + Student capacity.
*
* @since 3.38.0
*
* @return string[] An array of strings describing the restrictions placed on the product.
*/
public function get_restrictions() {
$restrictions = array();
if ( 'course' === $this->get( 'type' ) ) {
$course = new LLMS_Course( $this->get( 'id' ) );
// Is the course enrollment period open?
if ( ! $course->is_enrollment_open() ) {
$restrictions[] = 'enrollment_period';
}
// Does the course have capacity?
if ( ! $course->has_capacity() ) {
$restrictions[] = 'student_capacity';
}
}
/**
* Filter the product's restrictions.
*
* @since 6.8.0
*
* @param string[] $restrictions An array of strings describing the restrictions placed on the product.
* @param LLMS_Product $product The LLMS_Product object.
*/
return apply_filters( 'llms_product_get_restrictions', $restrictions, $this );
}
/**
* Determine if the product has at least one free access plan.
*
* @since 3.0.0
* @since 3.25.2 Unknown.
*
* @return bool
*/
public function has_free_access_plan() {
/**
* Filter whether the product has free access plans.
*
* @since Unknown
* @since 3.37.17 Added the `$product` param.
*
* @param bool $has_free_access_plan Whether the product `$product` has free access plans.
* @param LLMS_Product $product The LLMS_Product instance.
*/
return apply_filters( 'llms_product_has_free_access_plan', ( 0 !== count( $this->get_access_plans( true ) ) ), $this );
}
/**
* Determine if any restrictions exist on the product.
*
* @since 3.38.0
*
* @see LLMS_Proudct::get_restrictions()
*
* @return boolean `true` if there is at least one restriction on the product, `false` otherwise.
*/
public function has_restrictions() {
$restrictions = $this->get_restrictions();
$has_restrictions = count( $restrictions ) > 0;
/**
* Filter whether the product has any purchase restrictions.
*
* @since 3.38.0
*
* @param bool $has_restrictions Whether the product `$product` has restrictions.
* @param string[] $restrictions Array of restrictions placed on the product.
* @param LLMS_Product $product The LLMS_Product object.
*/
return apply_filters( 'llms_product_has_restrictions', $has_restrictions, $restrictions, $this );
}
/**
* Determine if the product is purchasable.
*
* At least one gateway must be enabled and at least one access plan must exist.
* If the product is a course, additionally checks to ensure course enrollment is open and has capacity.
*
* @since 3.0.0
* @since 3.25.2 Unknown.
* @since 3.38.0 Use `has_restrictions()` to determine if the product has additional restrictions.
*
* @return bool
*/
public function is_purchasable() {
// Default to false.
$purchasable = false;
// If the product doesn't have any purchase restrictions, make sure we have a purchasable plan & active gateways.
if ( ! $this->has_restrictions() ) {
$gateways = llms()->payment_gateways();
$purchasable = ( $this->get_access_plans( false, false ) && $gateways->has_gateways( true ) );
}
/**
* Filter whether the product is purchasable.
*
* @since Unknown
*
* @param bool $purchasable Whether the product `$product` is purchasable.
* @param LLMS_Product $product The LLMS_Product instance.
*/
return apply_filters( 'llms_product_is_purchasable', $purchasable, $this );
}
/**
* Update the product's catalog visibility setting.
*
* @since 3.6.0
* @since 3.37.17 Use `in_array` with strict comparison.
*
* @param string $visibility Visibility term name.
* @return void
*/
public function set_catalog_visibility( $visibility ) {
if ( ! in_array( $visibility, array_keys( llms_get_product_visibility_options() ), true ) ) {
return;
}
wp_set_object_terms( $this->get( 'id' ), $visibility, 'llms_product_visibility', false );
}
/**
* Check if there are active subscriptions for this product.
*
* @since 5.4.0
*
* @param boolean $use_cache Whether or not leveraging the cache.
* @return boolean
*/
public function has_active_subscriptions( $use_cache = true ) {
$found = false;
if ( $use_cache ) {
$subscriptions_count = wp_cache_get( $this->get( 'id' ), 'llms_product_subscriptions_count', true, $found );
}
if ( false === $found ) {
global $wpdb;
$subscriptions_count = $wpdb->get_var(
$wpdb->prepare(
"
SELECT COUNT(*) FROM {$wpdb->posts} as p
JOIN {$wpdb->postmeta} as pm1
JOIN {$wpdb->postmeta} as pm2
WHERE p.ID=pm1.post_id
AND p.post_type='llms_order'
AND pm1.post_id=pm2.post_id
AND pm1.meta_key='_llms_product_id' AND pm1.meta_value=%d
AND pm2.meta_key='_llms_order_type' AND pm2.meta_value='recurring'
AND p.post_status IN ( 'llms-active', 'llms-pending-cancel', 'llms-on-hold' )
",
$this->get( 'id' )
)
);
wp_cache_set(
$this->get( 'id' ),
$subscriptions_count,
'llms_product_subscriptions_count'
);
}
return (bool) $subscriptions_count;
}
}
================================================
FILE: includes/models/model.llms.question.choice.php
================================================
<?php
/**
* LifterLMS Quiz Question Model
*
* @package LifterLMS/Models/Classes
*
* @since 3.16.0
* @version 7.4.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Question_Choice model class
*
* @since 3.16.0
*/
class LLMS_Question_Choice {
protected $prefix = '_llms_choice_';
private $id = null;
private $data = array();
private $question = null;
private $question_id = null;
/**
* Constructor
*
* @param int $question_id WP Post ID of the choice's parent LLMS_Question
* @param array|string $data_or_id array of choice data or the choice ID string
* @since 3.16.0
* @version 3.16.0
*/
public function __construct( $question_id, $data_or_id = array() ) {
// Ensure the question is valid.
if ( $this->set_question( $question_id ) ) {
// If an ID is passed in, load the question data from post meta.
if ( ! is_array( $data_or_id ) ) {
$data_or_id = str_replace( $this->prefix, '', $data_or_id );
$data_or_id = get_post_meta( $this->question_id, $this->prefix . $data_or_id, true );
}
// Hydrate with postmeta data or array of data passed in.
if ( is_array( $data_or_id ) && isset( $data_or_id['id'] ) ) {
$this->hydrate( $data_or_id );
}
}
}
/**
* Creates a new question
*
* @param array $data question data array
* @return self
* @since 3.16.0
* @version 3.16.0
*/
public function create( $data ) {
$this->id = uniqid();
return $this->update( $data )->save();
}
/**
* Delete a choice
*
* @return boolean
* @since 3.16.0
* @version 3.16.0
*/
public function delete() {
return delete_post_meta( $this->question_id, $this->prefix . $this->id );
}
/**
* Determine if the choice that's been requested actually exists
*
* @return boolean
* @since 3.16.0
* @version 3.16.0
*/
public function exists() {
return ( $this->id );
}
/**
* Retrieve a piece of choice data by key
*
* @param string $key name of the data to be retrieved
* @param mixed $default default value if key isn't set
* @return mixed
* @since 3.16.0
* @version 3.16.0
*/
public function get( $key, $default = '' ) {
if ( isset( $this->data[ $key ] ) ) {
return $this->data[ $key ];
}
return $default;
}
/**
* Generic choice getter which automatically uses correct functions based on choice type
*
* @return string
* @since 3.16.0
* @version 3.16.0
*/
public function get_choice() {
if ( 'image' === $this->get( 'choice_type' ) ) {
return $this->get_image();
}
return $this->get( 'choice' );
}
/**
* Retrieve an image for picture choices
*
* @return [type]
* @since 3.16.0
* @version 3.16.0
*/
public function get_image() {
if ( 'image' !== $this->get( 'choice_type' ) ) {
return '';
}
$img = $this->get( 'choice' );
if ( is_array( $img ) && isset( $img['id'] ) ) {
return wp_get_attachment_image( $img['id'], 'full' );
}
return '';
}
/**
* Retrieve all of the choice data as an array
*
* @return array
* @since 3.16.0
* @version 3.16.0
*/
public function get_data() {
return $this->data;
}
/**
* Retrieve an instance of an LLMS_Question for questions parent
*
* @return obj
* @since 3.16.0
* @version 3.16.0
*/
public function get_question() {
return $this->question;
}
/**
* Retrieve the question ID for the given choice
*
* @return int
* @since 3.16.0
* @version 3.16.0
*/
public function get_question_id() {
return $this->question_id;
}
/**
* Setup the id and data variables
*
* @param array $data array of question data
* @return void
* @since 3.16.0
* @version 3.16.0
*/
private function hydrate( $data ) {
$this->id = $data['id'];
$this->data['id'] = $this->id;
$this->update( $data );
}
/**
* Determine if the choice is correct
*
* @return bool
* @since 3.16.0
* @version 3.16.0
*/
public function is_correct() {
/**
* Filter to modify if this question choice is correct, ie. reorder questions in Advanced Quizzes.
*
* @since 9.1.0
*
* @param bool Whether this question choice is correct or not.
* @param LLMS_Question_Choice
*/
return apply_filters( 'llms_question_choice_is_correct', filter_var( $this->get( 'correct' ), FILTER_VALIDATE_BOOLEAN ), $this );
}
/**
* Save $this->data to the postmeta table
*
* @return void
* @since 3.16.0
* @version 3.16.0
*/
public function save() {
$this->data['id'] = $this->id; // Always ensure the ID is set when saving data.
$update = update_post_meta( $this->question_id, $this->prefix . $this->id, $this->data );
return ( $update );
}
/**
* Set a piece of data by key.
*
* @since 3.16.0
* @since 7.4.1 Check `$type['choices']` is an array before trying to access it as such.
*
* @param string $key Name of the key to set.
* @param mixed $val Value to set.
* @return self
*/
public function set( $key, $val ) {
// Don't set the ID.
if ( 'id' === $key ) {
return $this;
}
switch ( $key ) {
case 'choice_type':
if ( ! in_array( $val, array( 'text', 'image' ) ) ) {
$val = 'text';
}
break;
case 'correct':
$val = filter_var( $val, FILTER_VALIDATE_BOOLEAN );
break;
case 'marker':
$type = $this->get_question()->get_question_type();
if ( is_array( $type['choices'] ?? false ) ) {
$markers = $type['choices']['markers'];
if ( ! in_array( $val, $markers ) ) {
$val = $markers[0];
}
}
break;
case 'choice':
default:
if ( is_array( $val ) ) {
$val = array_map( 'sanitize_text_field', $val );
} else {
$val = wp_kses_post( $val );
}
break;
}
$this->data[ $key ] = $val;
return $this;
}
/**
* Sets question-related data from constructor
*
* @param int $id WP Post ID of the question's parent question
* @return boolean
* @since 3.16.0
* @version 3.16.0
*/
public function set_question( $id ) {
$question = llms_get_post( $id );
if ( $question && is_a( $question, 'LLMS_Question' ) ) {
$this->question = $question;
$this->question_id = $id;
return true;
}
return false;
}
/**
* Update multiple data by key=>val pairs
*
* @param array $data array of data to set
* @return self
* @since 3.16.0
* @version 3.16.0
*/
public function update( $data = array() ) {
foreach ( $data as $key => $val ) {
$this->set( $key, $val );
}
return $this;
}
}
================================================
FILE: includes/models/model.llms.question.php
================================================
<?php
/**
* LifterLMS Quiz Question Model
*
* @package LifterLMS/Models/Classes
*
* @since 1.0.0
* @version 7.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS Quiz Question Model class
*
* @property string $question_type Type of question.
*
* @since 1.0.0
* @since 3.30.1 Fixed choice sorting issues.
* @since 3.35.0 Escape `LIKE` clause when retrieving choices.
* @since 3.38.2 When getting the 'not raw' question_type, made sure to always return a valid value.
* @since 4.0.0 Remove deprecated class methods.
*/
class LLMS_Question extends LLMS_Post_Model {
/**
* Database post type name
*
* @var string
*/
protected $db_post_type = 'llms_question';
/**
* Modefl post type name
*
* @var string
*/
protected $model_post_type = 'question';
/**
* Map of Model properties to property type
*
* @var array
*/
protected $properties = array(
'content' => 'html',
'clarifications' => 'html',
'clarifications_enabled' => 'yesno',
'description_enabled' => 'yesno',
'image' => 'array',
'multi_choices' => 'yesno',
'parent_id' => 'absint',
'points' => 'absint',
'question_type' => 'string',
'question' => 'html',
'title' => 'html',
'video_enabled' => 'yesno',
'video_src' => 'string',
);
/**
* Create a new question choice
*
* @since 3.16.0
*
* @param array $data Array of question choice data.
* @return string|boolean
*/
public function create_choice( $data ) {
$data = wp_parse_args(
$data,
array(
'choice' => '',
'choice_type' => 'text',
'correct' => false,
'marker' => $this->get_next_choice_marker(),
'question_id' => $this->get( 'id' ),
)
);
$choice = new LLMS_Question_Choice( $this->get( 'id' ) );
if ( $choice->create( $data ) ) {
return $choice->get( 'id' );
}
return false;
}
/**
* Delete a choice by ID
*
* @since 3.16.0
*
* @param string $id Choice ID.
* @return boolean
*/
public function delete_choice( $id ) {
$choice = $this->get_choice( $id );
if ( ! $choice ) {
return false;
}
return $choice->delete();
}
/**
* Retrieve the type of automatic grading that can be performed on the question
*
* @since 3.16.0
*
* @return string|false
*/
public function get_auto_grade_type() {
if ( $this->supports( 'choices' ) && $this->supports( 'grading', 'auto' ) ) {
return 'choices';
} elseif ( $this->supports( 'grading', 'conditional' ) && llms_parse_bool( $this->get( 'auto_grade' ) ) ) {
return 'conditional';
}
return false;
}
/**
* An array of default arguments to pass to $this->create() when creating a new post
*
* @since 3.16.0
* @since 3.16.12 Unknown.
*
* @param array $args Args of data to be passed to wp_insert_post.
* @return array
*/
protected function get_creation_args( $args = null ) {
// Allow nothing to be passed in.
if ( empty( $args ) ) {
$args = array();
}
// Backwards compat to original 3.0.0 format when just a title was passed in.
if ( is_string( $args ) ) {
$args = array(
'post_title' => $args,
);
}
if ( isset( $args['title'] ) ) {
$args['post_title'] = $args['title'];
unset( $args['title'] );
}
if ( isset( $args['content'] ) ) {
$args['post_content'] = $args['content'];
unset( $args['content'] );
}
$meta = isset( $args['meta_input'] ) ? $args['meta_input'] : array();
$props = array_diff( array_keys( $this->get_properties() ), array_keys( $this->get_post_properties() ) );
foreach ( $props as $prop ) {
if ( isset( $args[ $prop ] ) ) {
$meta[ $this->meta_prefix . $prop ] = $args[ $prop ];
unset( $args[ $prop ] );
}
}
$args['meta_input'] = wp_parse_args( $meta, $meta );
$args = wp_parse_args(
$args,
array(
'comment_status' => 'closed',
'meta_input' => array(),
'menu_order' => 1,
'ping_status' => 'closed',
'post_author' => get_current_user_id(),
'post_content' => '',
'post_excerpt' => '',
'post_status' => 'publish',
'post_title' => '',
'post_type' => $this->get( 'db_post_type' ),
)
);
return apply_filters( "llms_{$this->model_post_type}_get_creation_args", $args, $this );
}
/**
* Getter
*
* @since 3.38.2
*
* @param string $key The property key.
* @param boolean $raw Optional. Whether or not we need to get the raw value. Default false.
* @return mixed
*/
public function get( $key, $raw = false ) {
$value = parent::get( $key, $raw );
// When getting the 'not raw' value, make sure we always return a valid question type.
if ( ! $raw && ! $value && 'question_type' === $key ) {
$value = 'choice';
}
return $value;
}
/**
* Retrieve a choice by id
*
* @since 3.16.0
* @since 4.4.0 Use strict comparison.
*
* @param string $id Choice ID.
* @return obj|false
*/
public function get_choice( $id ) {
$choice = new LLMS_Question_Choice( $this->get( 'id' ), $id );
if ( $choice->exists() && absint( $this->get( 'id' ) ) === absint( $choice->get_question_id() ) ) {
return $choice;
}
return false;
}
/**
* Retrieve the question's choices
*
* @since 3.16.0
* @since 3.30.1 Improve choice sorting to accommodate numeric markers.
* @since 3.35.0 Escape `LIKE` clause.
* @since 4.4.0 Don't allow objects when using `unserialize()`.
*
* @param string $return Optional. Determine how to return the choice data.
* 'choices' (default) returns an array of LLMS_Question_Choice objects.
* 'ids' returns an array of LLMS_Question_Choice ids.
* @return array
*/
public function get_choices( $return = 'choices' ) {
global $wpdb;
$results = $wpdb->get_results( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
$wpdb->prepare(
"SELECT meta_key AS id
, meta_value AS data
FROM {$wpdb->postmeta}
WHERE post_id = %d
AND meta_key LIKE %s
;",
$this->get( 'id' ),
'_llms_choice_%'
)
);
usort( $results, array( $this, 'sort_choices' ) );
if ( 'ids' === $return ) {
return wp_list_pluck( $results, 'id' );
}
$ret = array();
foreach ( $results as $result ) {
$ret[] = new LLMS_Question_Choice( $this->get( 'id' ), unserialize( $result->data, array( 'allowed_classes' => false ) ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
}
return $ret;
}
/**
* Retrieve the question description (post_content)
*
* Add's extra allowed tags to wp_kses_post allowed tags so that async audio shortcodes will work properly
*
* @since 3.16.6
*
* @return string
*/
public function get_description() {
global $allowedposttags;
$allowedposttags['source'] = array(
'src' => true,
'type' => true,
);
$desc = $this->get( 'content' );
unset( $allowedposttags['source'] );
return apply_filters( 'llms_' . $this->get( 'question_type' ) . '_question_get_description', $desc, $this );
}
/**
* Retrieve the correct values for a conditionally graded question
*
* @since 3.16.15
*
* @return array
*/
public function get_conditional_correct_value() {
$correct = explode( '|', $this->get( 'correct_value' ) );
$correct = array_map( 'trim', $correct );
return $correct;
}
/**
* Retrieve correct choices for a given question
*
* @since 3.16.0
*
* @return array
*/
public function get_correct_choice() {
$correct = false;
if ( $this->supports( 'choices' ) && $this->supports( 'grading', 'auto' ) ) {
$multi = ( 'yes' === $this->get( 'multi_choices' ) );
$correct = array();
foreach ( $this->get_choices() as $choice ) {
if ( $choice->is_correct() ) {
$correct[] = $choice->get( 'id' );
if ( ! $multi ) {
break;
}
}
}
// Always sort multi choices for easy auto comparison.
if ( $multi && $this->supports( 'selectable' ) ) {
sort( $correct );
}
}
return $correct;
}
/**
* Get the question text (title).
*
* @since 3.16.0
* @since 7.8.0 Added $attempt param.
*
* @param string $format Optional. Format of the question text. Accepts 'html' or 'plain'.
* @param LLMS_Quiz_Attempt $attempt Optional. Quiz Attempt object.
* @return string
*/
public function get_question( $format = 'html', $attempt = null ) {
/**
* Filter the question text.
*
* The dynamic portion of this filter, `{$type}`, refers to the question type.
*
* @since 7.8.0
*
* @param string $title Question title.
* @param string $format Format of the question text. Accepts 'html' or 'plain'.
* @param LLMS_Question $question Question object.
* @param LLMS_Quiz_Attempt $attempt Attempt object.
*/
return apply_filters( "llms_{$this->get( 'question_type' )}_question_get_question", $this->get( 'title' ), $format, $this, $attempt );
}
/**
* Retrieve child questions (for question group)
*
* @since 3.16.0
*
* @todo Need to prevent access for non-group questions.
*
* @return array
*/
public function get_questions() {
return $this->questions()->get_questions();
}
/**
* Retrieve URL for an image associated with the question if it's enabled
*
* @since 3.16.0
*
* @param string|array $size Registered image size or a numeric array with width/height.
* @param null $unused Unused parameter.
* @return string Source URL or an Eepty string if no image or not supported.
*/
public function get_image( $size = 'full', $unused = null ) {
$url = '';
if ( $this->has_image() ) {
$img = $this->get( 'image' );
if ( isset( $img['id'] ) && is_numeric( $img['id'] ) ) {
$src = wp_get_attachment_image_src( $img['id'], $size );
if ( $src ) {
$url = $src[0];
} elseif ( isset( $img['src'] ) ) {
$url = $img['src'];
}
}
}
return apply_filters( 'llms_' . $this->get( 'question_type' ) . '_question_get_image', $url, $this );
}
/**
* Retrieve the next marker for question choices.
*
* @since 3.16.0
* @since 3.30.1 Fixed bug which caused the next marker to be 1 index too high.
* @since 7.4.1 Check `$type['choices']` is an array before trying to access it as such.
*
* @return string
*/
protected function get_next_choice_marker() {
$next_index = count( $this->get_choices( 'ids', false ) );
$type = $this->get_question_type();
if ( ! is_array( $type['choices'] ?? false ) ) {
return false;
}
$markers = $type['choices']['markers'];
return $next_index > count( $markers ) ? false : $markers[ $next_index ];
}
/**
* Retrieve question type data for the given question
*
* @since 3.16.0
*
* @return array
*/
public function get_question_type() {
return llms_get_question_type( $this->get( 'question_type' ) );
}
/**
* Retrieve an instance of the questions parent LLMS_Quiz
*
* @since 3.16.0
*
* @return obj
*/
public function get_quiz() {
return new LLMS_Quiz( $this->get( 'parent_id' ) );
}
/**
* Retrieve video embed for question featured video
*
* @since 3.16.0
* @since 3.17.0 Unknown.
*
* @return string
*/
public function get_video() {
$html = '';
$embed = $this->get( 'video_src' );
if ( $embed ) {
// Get oembed.
$html = wp_oembed_get( $embed );
// Fallback to video shortcode.
if ( ! $html ) {
$html = do_shortcode( '[video src="' . $embed . '"]' );
}
}
return apply_filters( 'llms_' . $this->get( 'question_type' ) . '_question_get_video', $html, $embed, $this );
}
/**
* Attempt to grade a question
*
* @since 3.16.0
* @since 3.16.15 Unknown.
* @since 4.4.0 Combined nested if statements into a single condition.
*
* @param array[] $answer Selected answer(s).
* @return string|null Returns `null` if the question cannot be automatically graded.
* Returns `yes` for correct answers and `no` for incorrect answers.
*/
public function grade( $answer ) {
$question_type = $this->get( 'question_type' );
/**
* Use this filter to bypass core grading for a given question type.
*
* If the filter returns a non-null value core grading is bypassed.
*
* The dynamic portion of this hook, `$question_type`, refers to the type of question being graded.
*
* @since 3.16.0
*
* @param null|string $grade Defaults to `null` which signifies that LifterLMS should attempt to grade the answer.
* Return `yes` (correct) or `no` (incorrect) to bypass core grading methods.
* @param string[] $answer User-submitted answers.
* @param LLMS_Question $question Question object.
*/
$grade = apply_filters( "llms_{$question_type}_question_pre_grade", null, $answer, $this );
if ( is_null( $grade ) && $this->get( 'points' ) >= 1 ) {
$grading_type = $this->get_auto_grade_type();
if ( 'choices' === $grading_type ) {
sort( $answer );
$grade = ( $answer === $this->get_correct_choice() ) ? 'yes' : 'no';
} elseif ( 'conditional' === $grading_type ) {
$correct = $this->get_conditional_correct_value();
/**
* Filter whether or not conditionally graded question answers are treated as a case-sensitive
*
* By default, case sensitivity is disabled.
*
* @since 3.16.15
*
* @param boolean $case_sensitive Whether or not answers are treated as case-sensitive.
* @param string[] $answer User-submitted answers.
* @param string[] $correct Correct answers.
* @param LLMS_Question $question Question object.
*/
if ( false === apply_filters( 'llms_quiz_grading_case_sensitive', false, $answer, $correct, $this ) ) {
$answer = array_map( 'strtolower', $answer );
$correct = array_map( 'strtolower', $correct );
}
$answer = array_map( 'trim', $answer );
$correct = array_map( 'trim', $correct );
$grade = ( $answer === $correct ) ? 'yes' : 'no';
}
}
/**
* Filter the grading result of an answer for a given question type.
*
* The dynamic portion of this hook, `$question_type`, refers to the type of question being graded.
*
* @since 3.16.0
*
* @param null|string $grade Defaults to `null` which signifies that LifterLMS should attempt to grade the answer.
* Return `yes` (correct) or `no` (incorrect) to bypass core grading methods.
* @param string[] $answer User-submitted answers.
* @param LLMS_Question $question Question object.
*/
return apply_filters( "llms_{$question_type}_question_grade", $grade, $answer, $this );
}
/**
* Determine if a description is enabled and not empty
*
* @since 3.16.0
* @since 3.16.12 Unknown.
*
* @return bool
*/
public function has_description() {
$enabled = $this->get( 'description_enabled' );
$content = $this->get( 'content' );
return ( 'yes' === $enabled && $content );
}
/**
* Determine if a featured image is enabled and not empty
*
* @since 3.16.0
*
* @return bool
*/
public function has_image() {
$img = $this->get( 'image' );
if ( is_array( $img ) ) {
if ( ! empty( $img['enabled'] ) && ( ! empty( $img['id'] ) || ! empty( $img['src'] ) ) ) {
return ( 'yes' === $img['enabled'] );
}
}
return false;
}
/**
* Determine if a featured video is enabled & not empty
*
* @since 3.16.0
* @since 3.16.12 Unknown.
*
* @return bool
*/
public function has_video() {
$enabled = $this->get( 'video_enabled' );
$src = $this->get( 'video_src' );
return ( 'yes' === $enabled && $src );
}
/**
* Determine if the question is an orphan
*
* @since 3.27.0
*
* @return bool
*/
public function is_orphan() {
$statuses = array( 'publish', 'draft' );
$parent_id = $this->get( 'parent_id' );
if ( ! $parent_id ) {
return true;
} elseif ( ! in_array( get_post_status( $parent_id ), $statuses, true ) ) {
return true;
}
return false;
}
/**
* Access question manager (used for question groups)
*
* @since 3.16.0
*
* @todo Need to prevent access for non-group questions.
*
* @return obj
*/
public function questions() {
return new LLMS_Question_Manager( $this );
}
/**
* Sort choices by marker.
*
* @since 3.30.1
* @since 4.4.0 Don't allow objects when using `unserialize()`.
*
* @param string $choice_a Serialized choice data.
* @param string $choice_b Serialized choice data.
* @return int
*/
private function sort_choices( $choice_a, $choice_b ) {
$a_data = unserialize( $choice_a->data, array( 'allowed_classes' => false ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
$b_data = unserialize( $choice_b->data, array( 'allowed_classes' => false ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize
return strnatcmp( $a_data['marker'], $b_data['marker'] );
}
/**
* Determine if the question supports a question feature
*
* @since 3.16.0
* @since 3.16.15 Unknown.
*
* @param string $feature Name of the feature (eg "choices").
* @param mixed $option Allow matching feature options.
* @return boolean
*/
public function supports( $feature, $option = null ) {
$ret = false;
$type = $this->get_question_type();
if ( $type ) {
if ( 'choices' === $feature ) {
$ret = ( ! empty( $type['choices'] ) );
} elseif ( 'grading' === $feature ) {
$ret = ( $type['grading'] && $option === $type['grading'] );
} elseif ( 'points' === $feature ) {
$ret = $type['points'];
} elseif ( 'random_lock' === $feature ) {
$ret = $type['random_lock'];
} elseif ( 'selectable' === $feature ) {
$ret = empty( $type['choices'] ) ? false : $type['choices']['selectable'];
}
}
/**
* Filter supported features of a given question type.
*
* The dynamic portion of this hook, `$this->get( 'question_type' )`, refers to the type of question
* being filtered.
*
* @since 3.16.0
*
* @param boolean $ret Return value.
* @param string $string Name of the feature being checked.
* @param string $option Name of the option being checked.
* @param LLMS_Question $question Instance of the LLMS_Question.
*/
return apply_filters( "llms_{$this->get( 'question_type' )}_question_supports", $ret, $feature, $option, $this );
}
/**
* Called before data is sorted and returned by $this->toArray()
*
* Extending classes should override this data if custom data should
* be added when object is converted to an array or json.
*
* @since 3.3.0
* @since 3.16.0 Unknown.
*
* @param array $arr Array of data to be serialized.
* @return array
*/
protected function toArrayAfter( $arr ) {
unset( $arr['author'] );
unset( $arr['date'] );
unset( $arr['excerpt'] );
unset( $arr['modified'] );
unset( $arr['status'] );
$choices = array();
foreach ( $this->get_choices() as $choice ) {
$choices[] = $choice->get_data();
}
$arr['choices'] = $choices;
if ( 'group' === $this->get( 'question_type' ) ) {
$arr['questions'] = array();
foreach ( $this->get_questions() as $question ) {
$arr['questions'][] = $question->toArray();
}
}
return $arr;
}
/**
* Update a question choice
*
* If no id is supplied will create a new choice.
*
* @since 3.16.0
*
* @param array $data Array of choice data.
* @return string|boolean
*/
public function update_choice( $data ) {
// If there's no ID, we'll add a new choice.
if ( ! isset( $data['id'] ) ) {
return $this->create_choice( $data );
}
// Get the question.
$choice = $this->get_choice( $data['id'] );
if ( ! $choice ) {
return false;
}
$choice->update( $data )->save();
// Return choice ID.
return $choice->get( 'id' );
}
/**
* Retrieve quizzes this quiz is assigned to
*
* @since 3.12.0
*
* @return array Array of WP_Post IDs (quiz post types).
*/
public function get_quizzes() {
$id = absint( $this->get( 'id' ) );
$len = strlen( strval( $id ) );
$str_like = '%' . sprintf( 's:2:"id";s:%1$d:"%2$s";', $len, $id ) . '%';
$int_like = '%' . sprintf( 's:2:"id";i:%1$s;', $id ) . '%';
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$query = $wpdb->get_col( // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
"SELECT post_id
FROM {$wpdb->postmeta}
WHERE meta_key = '_llms_questions'
AND (
meta_value LIKE '{$str_like}'
OR meta_value LIKE '{$int_like}'
);"
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $query;
}
/**
* Don't add custom fields during toArray()
*
* @since 3.16.11
*
* @param array $arr Post model array.
* @return array
*/
protected function toArrayCustom( $arr ) {
return $arr;
}
}
================================================
FILE: includes/models/model.llms.quiz.attempt.php
================================================
<?php
/**
* Quiz Attempt Model
*
* @package LifterLMS/Models/Classes
*
* @since 3.9.0
* @version 7.4.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Quiz_Attempt model class.
*
* @since 3.9.0
* @since 3.9.2 Added `calculate_point_weight()`, `get_question_order()`, `is_passing()` methods.
* @since 3.16.0 Unknown.
* @since 3.16.7 Unknown.
* @since 3.17.1 Unknown.
* @since 3.19.2 Unknown.
* @since 3.24.0 Unknown.
* @since 3.26.3 Unknown.
* @since 3.29.0 Unknown.
* @since 4.0.0 Remove reliance on deprecated method `LLMS_Quiz::get_passing_percent()` & remove deprecated class method `get_status()`.
* Fix issue encountered when answering a question incorrectly after initially answering it correctly.
* @since 4.2.0 Use strict type comparisons where possible.
* In the `l10n()` method, made sure the status key exists to avoid trying to access to array's undefined index.
* Added the public method `get_siblings()`.
* @since 4.3.0 Added `$type` property declaration.
*/
class LLMS_Quiz_Attempt extends LLMS_Abstract_Database_Store {
/**
* Array of table column name => format
*
* @since unknown
* @since 7.8.0 Added `can_be_resumed` column.
* @var array
*/
protected $columns = array(
'student_id' => '%d',
'quiz_id' => '%d',
'lesson_id' => '%d',
'start_date' => '%s',
'update_date' => '%s',
'end_date' => '%s',
'status' => '%s',
'attempt' => '%d',
'grade' => '%f',
'questions' => '%s',
'can_be_resumed' => '%d',
'current_question_id' => '%d',
);
protected $date_created = 'start_date';
protected $date_updated = 'update_date';
/**
* Database Table Name
*
* @var string
*/
protected $table = 'quiz_attempts';
/**
* The record type
*
* @var string
*/
protected $type = 'quiz_attempt';
/**
* Constructor
*
* @since 3.9.0
* @since 3.16.0 Unknown.
*
* @param mixed $item Optional. Array/obj of attempt data or int. Default `null`.
* @return void
*/
public function __construct( $item = null ) {
if ( is_numeric( $item ) ) {
$this->id = $item;
} elseif ( is_object( $item ) && isset( $item->id ) ) {
$this->id = $item->id;
} elseif ( is_array( $item ) && isset( $item['id'] ) ) {
$this->id = $item['id'];
}
if ( ! $this->id ) {
if ( is_array( $item ) || is_object( $item ) ) {
$this->setup( $item );
}
parent::__construct();
}
}
/**
* Answer a question
*
* Records the selected option and whether or not the selected option was the correct option.
*
* Automatically updates & saves the attempt to the database
*
* @since 3.9.0
* @since 3.16.0 Updated to accommodate quiz builder improvements.
* @since 4.0.0 Explicitly set earned points to `0` when answering incorrectly.
* Exit the loop as soon as we find our question.
* Use strict comparison for IDs.
*
* @param int $question_id WP_Post ID of the LLMS_Question.
* @param string[] $answer Array of selected choice IDs (for core question types) or an array containing the user-submitted answer(s).
* @return LLMS_Quiz_Attempt Instance of the current attempt.
*/
public function answer_question( $question_id, $answer ) {
$questions = $this->get_questions();
foreach ( $questions as $key => $data ) {
if ( absint( $question_id ) !== absint( $data['id'] ) ) {
continue;
}
$question = llms_get_post( $question_id );
$graded = $question->grade( $answer );
$questions[ $key ]['answer'] = $answer;
$questions[ $key ]['correct'] = $graded;
$questions[ $key ]['earned'] = llms_parse_bool( $graded ) ? $questions[ $key ]['points'] : 0;
break;
}
$this->set_questions( $questions )->save();
return $this;
}
/**
* Calculate and the grade for a completed quiz
*
* @since 3.9.0
* @since 3.24.0 Unknown.
* @since 4.0.0 Remove reliance on deprecated method `LLMS_Quiz::get_passing_percent()`.
*
* @return LLMS_Quiz_Attempt Instance of the current quiz attempt.
*/
public function calculate_grade() {
$status = 'pending';
if ( $this->is_auto_gradeable() ) {
$grade = llms()->grades()->round( $this->get_count( 'earned' ) * $this->calculate_point_weight() );
$quiz = $this->get_quiz();
$min_grade = $quiz ? $quiz->get( 'passing_percent' ) : 100;
$this->set( 'grade', $grade );
$status = ( $min_grade <= $grade ) ? 'pass' : 'fail';
}
$this->set_status( $status );
return $this;
}
/**
* Calculate the weight of each point
*
* @since 3.9.2
* @since 3.16.0 Unknown.
*
* @return float
*/
private function calculate_point_weight() {
$available = $this->get_count( 'available_points' );
return ( $available > 0 ) ? ( 100 / $available ) : 0;
}
/**
* Run actions designating quiz completion
*
* @since 3.16.0
* @since 3.17.1 Unknown.
*
* @return void
*/
public function do_completion_actions() {
// Do quiz completion actions.
do_action( 'lifterlms_quiz_completed', $this->get_student()->get_id(), $this->get( 'quiz_id' ), $this );
$passed = false;
switch ( $this->get( 'status' ) ) {
case 'pass':
$passed = true;
do_action( 'lifterlms_quiz_passed', $this->get_student()->get_id(), $this->get( 'quiz_id' ), $this );
break;
case 'fail':
do_action( 'lifterlms_quiz_failed', $this->get_student()->get_id(), $this->get( 'quiz_id' ), $this );
break;
case 'pending':
do_action( 'lifterlms_quiz_pending', $this->get_student()->get_id(), $this->get( 'quiz_id' ), $this );
break;
}
}
/**
* End a quiz attempt
*
* Sets end date, unsets the quiz as the current quiz, and records a grade.
*
* @since 3.9.0
* @since 3.16.0 Unknown.
*
* @param boolean $silent Optional. If `true`, will not trigger actions or mark related lesson as complete. Default `false`.
* @return LLMS_Quiz_Attempt This quiz attempt instance (for chaining).
*/
public function end( $silent = false ) {
$this->set( 'end_date', current_time( 'mysql' ) );
$this->calculate_grade()->save();
if ( ! $silent ) {
$this->do_completion_actions();
}
// Clear "cached" grade so it's recalculated next time it's requested.
$this->get_student()->set( 'overall_grade', '' );
return $this;
}
/**
* Get sibling attempts
*
* @since 4.2.0
*
* @param array $args Optional. List of args to be passed as params of the quiz attempts query. Default empty array.
* See `LLMS_Query_Quiz_Attempt` and `LLMS_Database_Query` for the list of args.
* By default the `per_page` param is set to 1000.
* @param string $return Optional. Type of return [ids|attempts]. Default 'attempts'.
* @return int[]|LLMS_Quiz_Attempt[] Type depends on value of `$return`.
*/
public function get_siblings( $args = array(), $return = 'attempts' ) {
$defaults = array(
'per_page' => 1000,
);
$args = wp_parse_args( $args, $defaults );
$query = new LLMS_Query_Quiz_Attempt(
array_merge(
$args,
array(
'student_id' => $this->get( 'student_id' ),
'quiz_id' => $this->get( 'quiz_id' ),
)
)
);
return 'ids' === $return ? wp_list_pluck( $query->get_results(), 'id' ) : $query->get_attempts();
}
/**
* Retrieve a count for various pieces of information related to the attempt
*
* @since 3.9.0
* @since 3.19.2 Unknown.
* @since 4.2.0 Ensure only one return point.
*
* @param string $key The key of the data to count.
* @return int
*/
public function get_count( $key ) {
$count = 0;
$questions = $this->get_questions();
switch ( $key ) {
case 'available_points':
case 'correct_answers':
case 'earned':
case 'gradeable_questions': // Like "questions" but excludes content questions.
case 'points': // Legacy version of earned.
foreach ( $questions as $data ) {
// Get the total number of correct answers.
if ( 'correct_answers' === $key ) {
if ( 'yes' === $data['correct'] ) {
++$count;
}
} elseif ( 'earned' === $key || 'points' === $key ) {
$count += $data['earned'];
// Get the total number of possible points.
} elseif ( 'available_points' === $key ) {
$count += $data['points'];
} elseif ( 'gradeable_questions' === $key ) {
if ( $data['points'] ) {
++$count;
}
}
}
break;
case 'questions':
$count = count( $questions );
break;
}
return $count;
}
/**
* Retrieve a formatted date
*
* @since 3.9.0
* @since 3.16.0 Unknown.
*
* @param string $key 'start' or 'end'.
* @param string $format Optional. Output date format (PHP), uses WordPress format options if none provided.
* If not provided defaults to WP date format options.
* @return string
*/
public function get_date( $key, $format = null ) {
if ( ! $this->get( $key . '_date' ) ) {
return '';
}
$date = strtotime( $this->get( $key . '_date' ) );
$format = ! $format ? get_option( 'date_format' ) . ' ' . get_option( 'time_format' ) : $format;
return date_i18n( $format, $date );
}
/**
* Retrieve the first question for the attempt
*
* @since 3.9.0
* @since 3.16.0 Unknown.
*
* @return int|false
*/
public function get_first_question() {
$questions = $this->get_questions();
if ( $questions ) {
$first = array_shift( $questions );
return $first['id'];
}
return false;
}
/**
* Get the numeric order of a question in a given quiz
*
* @since 3.9.2
* @since 3.16.0 Unknown.
* @since 4.2.0 Use strict type comparison.
*
* @param int $question_id WP Post ID of the LLMS_Question.
* @return int
*/
public function get_question_order( $question_id ) {
foreach ( $this->get_questions() as $order => $data ) {
if ( absint( $data['id'] ) === $question_id ) {
return $order + 1;
}
}
return 0;
}
/**
* Get an encoded attempt key that can be passed in URLs and the like
*
* @since 3.9.0
* @since 3.16.7 Unknown.
*
* @return string
*/
public function get_key() {
return LLMS_Hasher::hash( $this->get( 'id' ) );
}
/**
* Retrieve an array of blank questions for insertion into a new attempt during initialization.
*
* @since 3.9.0
* @since 3.16.0 Unknown.
* @since 7.4.1 Moved randomization into `LLMS_Quiz_Attempt::randomize_attempt_questions()`.
*
* @return array
*/
private function get_new_questions() {
$quiz = llms_get_post( $this->get( 'quiz_id' ) );
$questions = array();
if ( $quiz ) {
/**
* Filter randomize value for quiz questions.
*
* @since 7.4.0
*
* @param bool $randomize The randomize boolean value.
* @param LLMS_Quiz $quiz LLMS_Quiz instance.
* @param LLMS_Quiz_Attempt $attempt LLMS_Quiz_Attempt instance.
*/
$randomize = apply_filters( 'llms_quiz_attempt_questions_randomize', llms_parse_bool( $quiz->get( 'random_questions' ) ), $quiz, $this );
/**
* Filter questions for the quiz.
*
* Sets the questions to be used for the quiz.
*
* @since 7.4.0
*
* @param array $questions Array of LLMS_Question objects.
* @param LLMS_Quiz $quiz LLMS_Quiz instance.
* @param LLMS_Quiz_Attempt $attempt LLMS_Quiz_Attempt instance.
*/
$quiz_questions = apply_filters( 'llms_quiz_attempt_questions', $quiz->get_questions(), $quiz, $this );
foreach ( $quiz_questions as $index => $question ) {
$questions[] = array(
'id' => $question->get( 'id' ),
'earned' => 0,
'points' => $question->supports( 'points' ) ? $question->get( 'points' ) : 0,
'answer' => null,
'correct' => null,
);
}
/**
* Filter attempt's questions array for the quiz.
*
* @since 7.4.1
*
* @param array $questions Array of question (each question is an array itself).
* @param LLMS_Quiz $quiz LLMS_Quiz instance.
* @param LLMS_Quiz_Attempt $attempt LLMS_Quiz_Attempt instance.
*/
$questions = apply_filters( 'llms_quiz_attempt_questions_array', $questions, $quiz, $this );
if ( $randomize ) {
$questions = self::randomize_attempt_questions( $questions );
}
}
return $questions;
}
/**
* Retrieve the next unanswered question in the attempt
*
* @since 3.9.0
* @since 3.16.0 Unknown.
* @since 4.2.0 Use strict type comparison.
* @since 7.8.0 Added `$return` param, by default `"id"`.
*
* @param int $last_question Optional. WP Post ID of the current LLMS_Question the "next" refers to. Default `null`.
* @param string $return Optional. Return type 'id|array'. Default 'id'.
* @return int|array|false
*/
public function get_next_question( $last_question = null, $return = 'id' ) {
$next = false;
foreach ( $this->get_questions() as $question ) {
if ( $next || is_null( $question['answer'] ) ) {
return 'id' === $return ? $question['id'] : $question;
// When rewinding and moving back through we don't want to skip questions.
} elseif ( $last_question && absint( $last_question ) === absint( $question['id'] ) ) {
$next = true;
}
}
return false;
}
/**
* Retrieve the previous question in the attempt relative to a given question ID.
*
* @since 7.8.0
*
* @param int $question_id WP Post ID of the current LLMS_Question.
* @return int|false
*/
public function get_previous_question( $question_id ) {
$next = false;
foreach ( array_reverse( $this->get_questions() ) as $question ) {
if ( $next ) {
return $question['id'];
} elseif ( $question_id && absint( $question_id ) === absint( $question['id'] ) ) {
$next = true;
}
}
return false;
}
/**
* Retrieve the question in the attempt.
*
* @since 7.8.0
*
* @param int $question_id WP Post ID of the required LLMS_Question.
* @param string $return Optional. Return type 'id|array'. Default 'id'.
* @return int|array|false
*/
public function get_question( $question_id, $return = 'id' ) {
$ids = array_map( 'intval', array_column( $this->get_questions(), 'id' ) );
$index = array_search( (int) $question_id, $ids, true );
return $index >= 0 ?
'id' === $return ? $question_id : $this->get_questions()[ $index ]
:
false;
}
/**
* Retrieve a permalink for the attempt
*
* @since 3.9.0
*
* @return string
*/
public function get_permalink() {
if ( ! $this->get_quiz() ) {
return '';
}
return add_query_arg( 'attempt_key', $this->get_key(), get_permalink( $this->get_quiz()->get( 'id' ) ) );
}
/**
* Get array of serialized questions
*
* @since 3.16.0
*
* @param boolean $cache Optional. If `true`, save data to to the object for future gets. Default `true`.
* @return array
*/
public function get_questions( $cache = true ) {
$questions = $this->get( 'questions', $cache );
if ( $questions ) {
return unserialize( $questions );
}
return array();
}
/**
* Retrieve an array of attempt question objects
*
* @since 3.16.0
* @since 5.3.0 Add a parameter to filter out removed questions.
*
* @param boolean $cache Optional. If `true`, save data to to the object for future gets. Default `true`.
* Cached questions won't take into account the `$filte_removed` parameter.
* @param boolean $filter_removed Optional. If `true`, removed questions will be filtered out. Default `false`.
* @return array
*/
public function get_question_objects( $cache = true, $filter_removed = false ) {
$questions = array();
foreach ( $this->get_questions( $cache ) as $qdata ) {
$question = new LLMS_Quiz_Attempt_Question( $qdata );
if ( ! $filter_removed || $question->get_question() instanceof LLMS_Question ) {
$questions[] = $question;
}
}
return $questions;
}
/**
* Retrieve an an answer to a specific question.
*
* @since 7.8.0
*
* @param int $question_id Question ID.
* @param boolean $cache Optional. If `true`, save data to to the object for future gets. Default `true`.
* Cached questions won't take into account the `$filte_removed` parameter.
* @param boolean $filter_removed Optional. If `true`, removed questions will be filtered out. Default `false`.
* @return mixed
*/
public function get_question_answer( $question_id, $cache = true, $filter_removed = false ) {
$question_objects = $this->get_question_objects( $cache, $filter_removed );
if ( ! $question_objects ) {
return array();
}
foreach ( $question_objects as $attempt_question ) {
$quiz_question = $attempt_question->get_question();
if ( $attempt_question->get_question()->get( 'id' ) === $question_id ) {
$answer = $attempt_question->get( 'answer' );
break;
}
}
return $answer ?? array();
}
/**
* Get an instance of the LLMS_Quiz for the attempt
*
* @since 3.9.0
*
* @return LLMS_Quiz
*/
public function get_quiz() {
return llms_get_post( $this->get( 'quiz_id' ) );
}
/**
* Get an LLMS_Student for the quiz
*
* @since 3.9.0
*
* @return LLMS_Student
*/
public function get_student() {
return llms_get_student( $this->get( 'student_id' ) );
}
/**
* Get the time spent on the quiz from start to end
*
* @since 3.9.0
*
* @param integer $precision Precision passed to `llms_get_date_diff()`.
* @return string
*/
public function get_time( $precision = 2 ) {
if ( ! $this->get( 'end_date' ) ) {
return esc_html__( 'Unknown', 'lifterlms' );
}
return llms_get_date_diff( $this->get_date( 'start', 'U' ), $this->get_date( 'end', 'U' ), $precision );
}
/**
* Retrieve a title-like string
*
* @since 3.16.0
* @since 3.26.3 Unknown.
*
* @return string
*/
public function get_title() {
$student = $this->get_student();
$name = $student ? $this->get_student()->get_name() : apply_filters( 'llms_quiz_attempt_deleted_student_name', __( '[Deleted]', 'lifterlms' ) );
return sprintf( __( 'Quiz Attempt #%1$d by %2$s', 'lifterlms' ), $this->get( 'attempt' ), $name );
}
/**
* Initialize a new quiz attempt by quiz and lesson for a user.
*
* If no user found throws an Exception.
*
* @since 3.9.0
* @since 3.16.0 Unknown.
* @since 7.8.0 Set the property `can_be_resumed` on init.
*
* @throws Exception When the user is not logged in.
*
* @param int $quiz_id WP Post ID of the quiz.
* @param int $lesson_id WP Post ID of the lesson.
* @param mixed $student Optional. Accepts anything that can be passed to llms_get_student.
* If no user is passed the current user will be used. Default `null`.
*
* @return obj
*/
public static function init( $quiz_id, $lesson_id, $student = null ) {
$student = llms_get_student( $student );
if ( ! $student ) {
throw new Exception( esc_html__( 'You must be logged in to take a quiz!', 'lifterlms' ) );
}
// Initialize a new attempt.
$attempt = new self();
$quiz = llms_get_post( $quiz_id );
$attempt->set( 'quiz_id', $quiz_id );
$attempt->set( 'lesson_id', $lesson_id );
$attempt->set( 'student_id', $student->get_id() );
$attempt->set_status( 'incomplete' );
$attempt->set( 'can_be_resumed', $quiz->can_be_resumed() );
$attempt->set_questions( $attempt->get_new_questions() );
$number = 1;
$last_attempt = $student->quizzes()->get_last_attempt( $quiz_id );
if ( $last_attempt ) {
$number = absint( $last_attempt->get( 'attempt' ) ) + 1;
}
$attempt->set( 'attempt', $number );
return $attempt;
}
/**
* Randomize attempt questions.
*
* Logic moved from `LLMS_Quiz_Attempt::get_new_questions()`.
*
* @since 7.4.1
*
* @param array $questions Array of attempt's questions (each question is an array itself).
* @return array.
*/
public static function randomize_attempt_questions( $questions ) {
if ( empty( $questions ) ) {
return $questions;
}
// Array of indexes that will be locked during shuffling.
$locks = array();
foreach ( $questions as $index => $question_array ) {
$question = llms_get_post( $question_array['id'] );
// If randomization is enabled, store the questions index so we can lock it during randomization.
if ( $question->supports( 'random_lock' ) ) {
$locks[] = $index;
}
}
// Lifted from https://stackoverflow.com/a/28491007/400568.
// I generally comprehend this code but also in a truer way i have no idea...
$inc = array();
$i = 0;
$j = 0;
$l = count( $questions );
$le = count( $locks );
while ( $i < $l ) {
if ( $j >= $le || $i < $locks[ $j ] ) {
$inc[] = $i;
} else {
++$j;
}
++$i;
}
// Fisher-yates-knuth shuffle variation O(n).
$num = count( $inc );
while ( $num-- ) {
$perm = wp_rand( 0, $num );
$swap = $questions[ $inc[ $num ] ];
$questions[ $inc[ $num ] ] = $questions[ $inc[ $perm ] ];
$questions[ $inc[ $perm ] ] = $swap;
}
return $questions;
}
/**
* Determine if the attempt can be autograded.
*
* @since 3.16.0
*
* @return bool
*/
private function is_auto_gradeable() {
foreach ( $this->get_question_objects() as $question ) {
if ( 'waiting' === $question->get_status() ) {
return false;
}
}
return true;
}
/**
* Determine if the attempt is the last attempt of its quiz.
*
* @since 7.8.0
*
* @return bool
*/
public function is_last_attempt() {
$student = llms_get_student( $this->get( 'student_id' ) );
if ( ! $student ) {
return false;
}
$last_attempt = $student->quizzes()->get_last_attempt( $this->get( 'quiz_id' ) );
return $last_attempt && ( $this->get( 'id' ) === $last_attempt->get( 'id' ) );
}
/**
* Determine if the attempt was passing.
*
* @since 3.9.2
* @since 3.16.0 Unknown.
*
* @return boolean
*/
public function is_passing() {
return ( 'pass' === $this->get( 'status' ) );
}
/**
* Determine if the attempt can be resumed.
*
* @since 7.8.0
*
* @return boolean
*/
public function can_be_resumed() {
return 1 === (int) $this->get( 'can_be_resumed' ) && 'incomplete' === $this->get( 'status' ) && ! $this->has_resume_attempt_time_expired() && $this->is_last_attempt();
}
/**
* Determine if the student's resume quiz attempt time limit is expired.
*
* The default resume quiz attempt time limit for a student is 1 day.
*
* @since 7.8.0
*
* @return bool
*/
public function has_resume_attempt_time_expired() {
$student = llms_get_student();
if ( ! $student ) {
return false;
}
if ( ! $this->get( 'start_date' ) ) {
return false;
}
$start_date = $this->get( 'start_date' );
/**
* Filters the X time for resuming quiz.
*
* @since 7.8.0
*
* @param int $resume_time_period The time period in hours.
*/
$resume_time_period = apply_filters( 'llms_quiz_attempt_resume_time_period', 24, $this );
$start_date_obj = new DateTime( $start_date, wp_timezone() );
$current_date_obj = current_datetime();
return $current_date_obj > $start_date_obj->modify( sprintf( '+%d hours', intval( $resume_time_period ) ) );
}
/**
* Translate attempt related strings.
*
* @since 3.9.0
* @since 3.16.0 Unknown.
* @since 4.2.0 Made sure the status key exists to avoid trying to access to array's undefined index.
*
* @param string $key Key to translate.
* @return string
*/
public function l10n( $key ) {
$tkey = '';
switch ( $key ) {
case 'passed': // Deprecated.
case 'status':
$statuses = llms_get_quiz_attempt_statuses();
$status = $this->get( 'status' );
$tkey = ( $status && isset( $statuses[ $status ] ) ) ? $statuses[ $status ] : $tkey;
break;
}
return $tkey;
}
/**
* Setter for serialized questions array.
*
* @since 3.16.0
*
* @param array $questions Question data.
* @param boolean $save Optional. If `true`, immediately persists to database. Default `false`.
* @return LLMS_Quiz_Attempt This quiz attempt instance (for chaining).
*/
public function set_questions( $questions = array(), $save = false ) {
return $this->set( 'questions', serialize( $questions ), $save );
}
/**
* Set the status of the attempt.
*
* @since 3.16.0
* @since 4.0.0 Use strict comparisons.
*
* @param string $status Status value.
* @param boolean $save If `true`, immediately persists to database.
* @return false|LLMS_Quiz_Attempt
*/
public function set_status( $status, $save = false ) {
$statuses = array_keys( llms_get_quiz_attempt_statuses() );
if ( ! in_array( $status, $statuses, true ) ) {
return false;
}
return $this->set( 'status', $status );
}
/**
* Record the attempt as started
*
* @since 3.9.0
*
* @return LLMS_Quiz_Attempt Instance of the current quiz attempt object.
*/
public function start() {
$this->set( 'start_date', current_time( 'mysql' ) );
$this->save();
return $this;
}
/**
* Retrieve the private data array
*
* @since 3.9.0
*
* @return array
*/
public function to_array() {
return $this->data;
}
/**
* Delete the object from the database.
*
* Overrides the parent method to perform other actions before deletion.
*
* @since 4.2.0
*
* @return bool `true` on success, `false` otherwise.
*/
public function delete() {
if ( ! $this->id ) {
return false;
}
$lesson = llms_get_post( $this->get( 'lesson_id' ) );
// No lesson, or lesson incomplete, nothing special to do here.
if ( ! $lesson || ! ( $lesson instanceof LLMS_Lesson ) || ! llms_is_complete( $this->get( 'student_id' ), $this->get( 'lesson_id' ), 'lesson' ) ) {
return parent::delete();
}
/**
* Prepare the query args to retrieve at least another sibling attempt,
* excluding the current one.
*/
$sibling_query_args = array(
'exclude' => $this->get_id( 'id' ),
'per_page' => 1,
);
/**
* If this lesson requires a passing grade, then retrieve only the possible passed sibling
* that might have been triggered the lesson completion.
*/
if ( llms_parse_bool( $lesson->get( 'require_passing_grade' ) ) ) {
$sibling_query_args['status'] = array(
'pass',
);
}
$sibling_attempts = $this->get_siblings( $sibling_query_args, 'ids' );
// If this is the only one relevant left attempt.
if ( empty( $sibling_attempts ) ) {
llms_mark_incomplete(
$this->get( 'student_id' ),
$this->get( 'lesson_id' ),
'lesson',
'quiz_' . $this->get( 'quiz_id' )
);
}
return parent::delete();
}
}
================================================
FILE: includes/models/model.llms.quiz.attempt.question.php
================================================
<?php
/**
* Quiz Attempt Answer Question
*
* @package LifterLMS/Models/Classes
*
* @since 3.16.0
* @version 5.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Quiz_Attempt_Question model class
*
* @since 3.16.0
* @since 3.16.15 Unknown.
*/
class LLMS_Quiz_Attempt_Question {
private $data = array();
/**
* Constructor
*
* @since 3.16.0
*
* @param array $data Question data array from attempt record.
* @return void
*/
public function __construct( $data = array() ) {
$this->data = wp_parse_args(
$data,
array(
'id' => null,
'earned' => null,
'points' => null,
'remarks' => null,
'answer' => null,
'correct' => null,
)
);
}
/**
* Determine if it's possible to manually grade the question
*
* @since 3.16.8
* @since 3.16.9 Unknown.
* @since 5.3.0 Early bail for deleted questions.
*
* @return boolean
*/
public function can_be_manually_graded() {
$question = $this->get_question();
if ( $question && $this->get( 'points' ) >= 1 ) {
// The question is auto-gradable so it cannot be manually graded.
if ( $question->get_auto_grade_type() ) {
return false;
} elseif ( $question->supports( 'grading', 'manual' ) || $question->supports( 'grading', 'conditional' ) ) {
return true;
}
}
return false;
}
/**
* Getter
*
* @since 3.16.0
*
* @param string $key Data key name
* @param mixed $default Optional. Default fallback value if key is unset. Default is empty string.
* @return mixed
*/
public function get( $key, $default = '' ) {
if ( isset( $this->data[ $key ] ) ) {
return $this->data[ $key ];
}
return $default;
}
/**
* Retrieve answer HTML for the question answers
*
* @since 3.16.0
* @since 3.16.15 Unknown.
*
* @return string
*/
public function get_answer() {
$question = $this->get_question();
$answers = $this->get_answer_array();
$ret = apply_filters( 'llms_quiz_attempt_question_get_answer_pre', '', $answers, $question, $this );
if ( ! $ret ) {
if ( $answers ) {
$ret = '<ul class="llms-quiz-attempt-answers">';
foreach ( $answers as $answer ) {
$ret .= sprintf( '<li class="llms-quiz-attempt-answer">%s</li>', wp_kses_post( $answer ) );
}
$ret .= '</ul>';
}
}
return apply_filters( 'llms_quiz_attempt_question_get_answer', $ret, $answers, $question, $this );
}
/**
* Get answer(s) as an array
*
* @since 3.16.15
* @since 3.27.0 Unknown.
*
* @return array
*/
public function get_answer_array() {
$ret = array();
$question = $this->get_question();
$answers = $this->get( 'answer' );
if ( $answers ) {
if ( $question->supports( 'choices' ) && $question->supports( 'grading', 'auto' ) ) {
foreach ( $answers as $aid ) {
$choice = $question->get_choice( $aid );
$ret[] = $choice ? $choice->get_choice() : _x( '[Deleted]', 'Selected quiz choice has been deleted.', 'lifterlms' );
}
} else {
$ret = $answers;
}
}
return apply_filters( 'llms_quiz_attempt_question_get_answer_array', $ret, $answers, $question, $this );
}
/**
* Retrieve answer HTML for the question correct answers
*
* @since 3.16.0
* @since 3.16.15 Unknown.
*
* @return string
*/
public function get_correct_answer() {
$ret = '';
$answers = $this->get_correct_answer_array();
if ( $answers ) {
$ret = '<ul class="llms-quiz-attempt-answers">';
foreach ( $answers as $answer ) {
$ret .= sprintf( '<li class="llms-quiz-attempt-answer">%s</li>', wp_kses_post( $answer ) );
}
$ret .= '</ul>';
}
return apply_filters( 'llms_quiz_attempt_question_get_correct_answer', $ret, $answers, $this->get_question(), $this );
}
/**
* Get correct answer(s) as an array
*
* @since 3.16.15
*
* @return array
*/
public function get_correct_answer_array() {
$ret = array();
$question = $this->get_question();
$type = $question->get_auto_grade_type();
if ( 'choices' === $type ) {
foreach ( $question->get_correct_choice() as $aid ) {
$choice = $question->get_choice( $aid );
$ret[] = $choice->get_choice();
}
} elseif ( 'conditional' === $type ) {
$ret = $question->get_conditional_correct_value();
}
return apply_filters( 'llms_quiz_attempt_question_get_correct_answer_array', $ret, $question, $this );
}
/**
* Retrieve an instance of the LLMS_Question
*
* @since 3.16.0
*
* @return LLMS_Question
*/
public function get_question() {
return llms_get_post( $this->get( 'id' ) );
}
/**
* Retrieve the status icon HTML based on the question's status/answer
*
* @since 3.16.0
*
* @return string
*/
public function get_status_icon() {
$icon = '';
switch ( $this->get_status() ) {
case 'graded':
if ( $this->is_correct() ) {
$icon = 'check';
$tip = esc_attr__( 'Correct answer', 'lifterlms' );
} else {
$icon = 'times';
$tip = esc_attr__( 'Incorrect answer', 'lifterlms' );
}
break;
case 'waiting':
$icon = 'clock-o';
$tip = esc_attr__( 'Awaiting review', 'lifterlms' );
break;
}
if ( $icon ) {
return sprintf( '<span class="llms-status-icon-tip tip--top-left" data-tip="%1$s"><i class="llms-status-icon fa fa-%2$s"></i><span>', $tip, $icon );
}
return '';
}
/**
* Receive the graded status of the question
*
* @since 3.16.0
* @since 3.16.9 Unknown.
* @since 5.3.0 Account for deleted questions.
*
* @return string Attempt's question status [graded|waiting|none].
*/
public function get_status() {
$question = $this->get_question();
if ( ! $question ) {
return 'graded';
}
$status = 'none';
if ( $this->get( 'points' ) >= 1 ) {
if ( $question->get_auto_grade_type() ) {
$status = 'graded';
} elseif ( $question->supports( 'grading', 'manual' ) || $question->supports( 'grading', 'conditional' ) ) {
if ( ! $this->get( 'correct' ) ) {
$status = 'waiting';
} else {
$status = 'graded';
}
}
}
return $status;
}
/**
* Determine if remarks are available for the question
*
* @since 3.16.0
*
* @return bool
*/
public function has_remarks() {
return ( $this->get( 'remarks' ) );
}
/**
* Determine if a question is correct
*
* @since 3.16.8
*
* @return bool
*/
public function is_correct() {
if ( 'graded' === $this->get_status() ) {
return llms_parse_bool( $this->get( 'correct' ) );
}
return false;
}
/**
* Setter
*
* @since 3.16.0
*
* @param string $key Data key name.
* @param mixed $val Value.
* @return void
*/
public function set( $key, $val ) {
$this->data[ $key ] = $val;
}
}
================================================
FILE: includes/models/model.llms.quiz.php
================================================
<?php
/**
* LifterLMS Quiz Model
*
* @package LifterLMS/Models/Classes
*
* @since 3.3.0
* @version 7.6.2
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Quiz model class.
*
* @property $allowed_attempts (int) Number of times a student is allowed to take the quiz before being locked out of it.
* @property $passing_percent (float) Grade required for a student to "pass" the quiz.
* @property $random_questions (yesno) Whether or not to randomize the order of questions for each attempt.
* @property $show_correct_answer (yesno) Whether or not to show the correct answer(s) to students on the quiz results screen.
* @property $show_options_description_right_answer (yesno) If yes, displays the question description when the student chooses the correct answer.
* @property $show_options_description_wrong_answer (yesno) If yes, displays the question description when the student chooses the wrong answer.
* @property $show_results (yesno) If yes, results will be shown to the student at the conclusion of the quiz.
* @property $time_limit (int) Quiz time limit (in minutes), empty denotes unlimited (untimed) quiz.
* @property $can_be_resumed (yesno) If yes, the latest incomplete quiz attempt can be resumed.
*
* @since 3.3.0
* @since 3.19.2 Unkwnown.
* @since 3.37.2 Added `llms_quiz_is_open` filter hook.
* @since 3.38.0 Only add theme metadata to the quiz array when the `llms_get_quiz_theme_settings` filter is being used.
* @since 4.0.0 Remove deprecated methods.
* @since 4.2.0 Added a parameter to the `is_orphan()` method to deeply check the quiz is not really attached to any lesson.
* @since 5.0.0 Remove previously deprecated method `LLMS_Quiz::get_lessons()`.
*/
class LLMS_Quiz extends LLMS_Post_Model {
/**
* Post Type Database name (as registered via `register_post_type()`).
*
* @var string
*/
protected $db_post_type = 'llms_quiz';
/**
* Post type name (without prefix).
*
* @var string
*/
protected $model_post_type = 'quiz';
/**
* Post type meta properties.
*
* Array key is the meta_key and array values is property's type.
*
* @since Unknown.
* @since 7.6.2 Added the `disable_retake` property.
* @since 7.8.0 Added `can_be_resumed` property.
* @var string[] Array key is the meta_key and array values is property's type.
*/
protected $properties = array(
'lesson_id' => 'absint',
'allowed_attempts' => 'int',
'limit_attempts' => 'yesno',
'limit_time' => 'yesno',
'passing_percent' => 'float',
'random_questions' => 'yesno',
'show_correct_answer' => 'yesno',
'time_limit' => 'int',
'can_be_resumed' => 'yesno',
'disable_retake' => 'yesno',
);
/**
* Retrieve the LLMS_Course for the quiz.
*
* @since 3.16.0
*
* @return LLMS_Course|false
*/
public function get_course() {
$lesson = $this->get_lesson();
if ( $lesson ) {
return $lesson->get_course();
}
return false;
}
/**
* Retrieve LLMS_Lesson for the quiz's parent lesson.
*
* @since 3.16.0
* @since 3.16.12 Unknown.
*
* @return LLMS_Lesson|false|null The lesson object on success, `false` if no id stored, and `null` if the stored ID doesn't exist.
*/
public function get_lesson() {
$id = $this->get( 'lesson_id' );
if ( ! $id ) {
return false;
}
return llms_get_post( $id );
}
/**
* Retrieve the quizzes child questions.
*
* @since 3.16.0
*
* @param string $return Optional. Type of return [ids|posts|questions]. Default `'questions'`.
* @return array
*/
public function get_questions( $return = 'questions' ) {
return $this->questions()->get_questions( $return );
}
/**
* Get questions count.
*
* @since 7.4.0
*
* @return int Question Count.
*/
public function get_questions_count() {
/**
* Filter the count of questions in a quiz.
*
* @since 7.4.0
*
* @param int $questions_count Number of questions in a quiz.
* @param LLMS_Quiz $quiz Current quiz object.
*/
return apply_filters( 'llms_quiz_questions_count', count( $this->get_questions( 'ids' ) ), $this );
}
/**
* Retrieve the time limit formatted as a human readable string.
*
* @since 3.16.0
*
* @return string
*/
public function get_time_limit_string() {
return LLMS_Date::convert_to_hours_minutes_string( $this->get( 'time_limit' ) );
}
/**
* Determine if the quiz defines limited attempts.
*
* @since 3.16.0
*
* @return bool
*/
public function has_attempt_limit() {
return ( 'yes' === $this->get( 'limit_attempts' ) );
}
/**
* Determine if a time limit is enabled for the quiz.
*
* @since 3.16.0
*
* @return bool
*/
public function has_time_limit() {
return ( 'yes' === $this->get( 'limit_time' ) );
}
/**
* Determine if the quiz is an orphan.
*
* @since 3.16.12
* @since 4.2.0 Added the $deep parameter.
*
* @param bool $deep Optional. Whether or not deeply check this quiz is orphan. Default `false`.
* When set to true will ensure not only that this quiz as a `lesson_id` property set
* But also that the lesson with id `lesson_id` has a `quiz` property as equal as this quiz id.
* @return bool
*/
public function is_orphan( $deep = false ) {
$parent_id = $this->get( 'lesson_id' );
if ( ! $parent_id ) {
return true;
}
/**
* This is to take into account possible data inconsistency.
*
* @link https://github.com/gocodebox/lifterlms/issues/1039
*/
if ( $deep ) {
$lesson = llms_get_post( $parent_id );
// Both the ids are already absint, see LLMS_Post_Model::___get().
if ( ! $lesson || $this->get( 'id' ) !== $lesson->get( 'quiz' ) ) {
return true;
}
}
return false;
}
/**
* Determine if a quiz can be resumed.
*
* A quiz can only be resumed if it's set to be resumed
* and has no time limit.
*
* @since 7.8.0
*
* @return bool
*/
public function can_be_resumed() {
return llms_parse_bool( $this->get( 'can_be_resumed' ) ) && ! $this->has_time_limit();
}
/**
* Determine if a student can resume the quiz.
*
* A student can resume the quiz only if their latest attempt can be resumed.
*
* @since 7.8.0
*
* @param int $user_id Optional. WP User ID, none supplied uses current user. Default `null`.
* @return bool
*/
public function can_be_resumed_by_student( $user_id = null ) {
$can_be_resumed_by_student = false;
$student = llms_get_student( $user_id );
if ( $student ) {
$last_attempt = $student->quizzes()->get_last_attempt( $this->get( 'id' ) );
$can_be_resumed_by_student = $last_attempt && $last_attempt->can_be_resumed();
}
return $can_be_resumed_by_student;
}
/**
* Gets quiz's last attempt key of a user.
*
* @since 7.8.0
*
* @param int $user_id Optional. WP User ID, none supplied uses current user. Default `null`.
* @return string|bool
*/
public function get_student_last_attempt_key( $user_id = null ) {
$student = llms_get_student( $user_id );
$last_attempt_key = false;
if ( $student ) {
$last_attempt = $student->quizzes()->get_last_attempt( $this->get( 'id' ) );
if ( $last_attempt ) {
$last_attempt_key = $last_attempt->get_key();
}
}
return $last_attempt_key;
}
/**
* Determine if a student can take the quiz.
*
* @since 3.0.0
* @since 3.16.0 Unkwnown.
* @since 3.37.2 Added `llms_quiz_is_open` filter hook.
*
* @param int $user_id Optional. WP User ID, none supplied uses current user. Default `null`.
* @return boolean
*/
public function is_open( $user_id = null ) {
$student = llms_get_student( $user_id );
if ( ! $student ) {
$quiz_open = false;
} else {
$remaining = $student->quizzes()->get_attempts_remaining_for_quiz( $this->get( 'id' ) );
// string for "unlimited" or number of attempts.
$quiz_open = ! is_numeric( $remaining ) || $remaining > 0;
// Check for a passed attempt and disable the quiz.
if ( $quiz_open && llms_parse_bool( $this->get( 'disable_retake' ) ) ) {
$passed_attempts = $student->quizzes()->get_attempts_by_quiz(
$this->get( 'id' ),
array(
'status' => array( 'pass' ),
)
);
if ( count( $passed_attempts ) ) {
$quiz_open = false;
}
}
}
/**
* Filters whether the quiz is open to a student or not.
*
* @param boolean $quiz_open Whether the quiz is open.
* @param int|null $user_id WP User ID, can be `null`.
* @param int $quiz_id The Quiz id.
* @param LLMS_Quiz $quiz The LLMS_Quiz instance.
* @param LLMS_Student|false $student LLMS_Student instance or false if user not found.
*/
return apply_filters( 'llms_quiz_is_open', $quiz_open, $user_id, $this->get( 'id' ), $this, $student );
}
/**
* Retrieve an instance of the question manager for the quiz.
*
* @since 3.16.0
*
* @return LLMS_Question_Manager
*/
public function questions() {
return new LLMS_Question_Manager( $this );
}
/**
* Called before data is sorted and returned by $this->toArray().
* Extending classes should override this data if custom data should
* be added when object is converted to an array or json.
*
* @since 3.3.0
* @since 3.19.2 Unknown.
* @since 3.38.0 Only add theme metadata to the quiz array when the `llms_get_quiz_theme_settings` filter is being used.
*
* @param array $arr Array of data to be serialized.
* @return array
*/
protected function toArrayAfter( $arr ) {
$arr['questions'] = array();
// Builder lazy loads questions via ajax.
global $llms_builder_lazy_load;
if ( ! $llms_builder_lazy_load ) {
foreach ( $this->get_questions() as $question ) {
$arr['questions'][] = $question->toArray();
}
}
// If theme has legacy support quiz layouts, add theme metadata to the array.
if ( get_theme_support( 'lifterlms-quizzes' ) && has_filter( 'llms_get_quiz_theme_settings' ) ) {
$layout = llms_get_quiz_theme_setting( 'layout' );
if ( $layout ) {
$arr[ $layout['id'] ] = get_post_meta( $this->get( 'id' ), $layout['id'], true );
}
}
return $arr;
}
/**
* Get the (points) value of a question.
*
* @since 3.3.0
* @since 3.37.2 Use strict comparison '===' in place of '=='.
*
* @param int $question_id WP Post ID of the LLMS_Question.
* @return int
*/
public function get_question_value( $question_id ) {
foreach ( $this->get_questions_raw() as $q ) {
if ( $question_id === $q['id'] ) {
return absint( $q['points'] );
}
}
return 0;
}
/**
* Retrieve the array of raw question data from the postmeta table.
*
* @since 3.3.0
*
* @return array
*/
private function get_questions_raw() {
$q = get_post_meta( $this->get( 'id' ), $this->meta_prefix . 'questions', true );
return $q ? $q : array();
}
}
================================================
FILE: includes/models/model.llms.section.php
================================================
<?php
/**
* LLMS Section Model
*
* @package LifterLMS/Models/Classes
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Section model class
*
* @since 1.0.0
* @since 4.0.0 Remove deprecated class methods.
* @since 5.7.0 Informed developers about the deprecated `LLMS_Section::get_next_available_lesson_order()` method.
* Informed developers about the deprecated `LLMS_Section::get_order()` method.
* Informed developers about the deprecated `LLMS_Section::get_parent_course()` method.
* Informed developers about the deprecated `LLMS_Section::set_parent_course()` method.
* @since 6.0.0 Removed deprecated items.
* - `LLMS_Section::get_next_available_lesson_order()` method
* - `LLMS_Section::get_order()` method
* - `LLMS_Section::get_parent_course()` method
* - `LLMS_Section::set_parent_course()` method
*
* @property int $order The section's order within its parent course.
* @property int $parent_course The WP_Post ID of the section's parent course.
* @property string $title The title / display name of the section.
*/
class LLMS_Section extends LLMS_Post_Model {
/**
* Post model properties.
*
* @var array
*/
protected $properties = array(
'order' => 'absint',
'parent_course' => 'absint',
);
/**
* Database post type name.
*
* @var string
*/
protected $db_post_type = 'section';
/**
* Model post type name.
*
* @var string
*/
protected $model_post_type = 'section';
/**
* Retrieve the total number of elements in the section
*
* @since 3.16.0
*
* @return int
*/
public function count_elements() {
return count( $this->get_lessons( 'ids' ) );
}
/**
* Retrieve an instance of LLMS_Course for the sections's parent course
*
* @since 3.6.0
*
* @return LLMS_Course|null|false Course object, `null` if `get_post()` fails, or `false` if LLMS_Course class isn't found.
*/
public function get_course() {
return llms_get_post( $this->get( 'parent_course' ) );
}
/**
* An array of default arguments to pass to $this->create() when creating a new section
*
* @since 3.13.0
*
* @param array $args Data to be passed to `wp_insert_post()`.
* @return array
*/
protected function get_creation_args( $args = null ) {
// Allow nothing to be passed in.
if ( empty( $args ) ) {
$args = array();
}
// Backwards compat to original 3.0.0 format when just a title was passed in.
if ( is_string( $args ) ) {
$args = array(
'post_title' => $args,
);
}
$args = wp_parse_args(
$args,
array(
'comment_status' => 'closed',
'ping_status' => 'closed',
'post_author' => get_current_user_id(),
'post_content' => '',
'post_excerpt' => '',
'post_status' => 'publish',
'post_title' => '',
'post_type' => $this->get( 'db_post_type' ),
)
);
/**
* Filter arguments used to create a new section post
*
* @since 4.11.0
*
* @param array $args Data to be passed to `wp_insert_post()`.
* @param LLMS_Section $section Instance of the section object.
*/
return apply_filters( 'llms_section_get_creation_args', $args, $this );
}
/**
* Retrieve the previous section
*
* @since 3.13.0
* @since 3.24.0 Unknown.
*
* @return LLMS_Section|false
*/
public function get_next() {
$siblings = $this->get_siblings( 'ids' );
$index = array_search( $this->get( 'id' ), $siblings );
/**
* The `$index` var will be false if the current section isn't found and
* will equal the length of the array if it's the last one (and there is no next).
*/
if ( false === $index || count( $siblings ) - 1 === $index ) {
return false;
}
return llms_get_post( $siblings[ $index + 1 ] );
}
/**
* Retrieve section completion percentage
*
* @since 3.24.0
*
* @see LLMS_Student::get_progress()
*
* @param string $user_id Optional. WP_User ID, if none supplied uses current user (if exists). Default is empty string.
* @param bool $use_cache Optional. When true, uses results from from the wp object cache (if available). Default is `false`.
* @return float
*/
public function get_percent_complete( $user_id = '', $use_cache = true ) {
$student = llms_get_student( $user_id );
if ( ! $student ) {
/** This filter is documented in includes/models/model.llms.student.php */
return apply_filters( 'llms_student_get_progress', 0, $this->get( 'id' ), 'section', $user_id );
}
return $student->get_progress( $this->get( 'id' ), 'section', $use_cache );
}
/**
* Retrieve the previous section
*
* @since 3.13.0
*
* @return LLMS_Section|false
*/
public function get_previous() {
$siblings = $this->get_siblings( 'ids' );
$index = array_search( $this->get( 'id' ), $siblings );
/**
* The `$index` var will be `0` if we're on the first section and
* will be `false` if the current section isn't found.
*/
if ( $index ) {
return llms_get_post( $siblings[ $index - 1 ] );
}
return false;
}
/**
* Get all lessons in the section
*
* @since 3.3.0
* @since 3.24.0 Unknown.
*
* @param string $return Optional. Type of return [ids|posts|lessons]. Default is `lessons`.
* @return int[]|WP_Post[]|LLMS_Lesson[] Return ty depends on value of `$return` argument.
*/
public function get_lessons( $return = 'lessons' ) {
$query = new WP_Query(
array(
'meta_key' => '_llms_order',
'meta_query' => array(
array(
'key' => '_llms_parent_section',
'value' => $this->get( 'id' ),
),
),
'order' => 'ASC',
'orderby' => 'meta_value_num',
'post_type' => 'lesson',
'posts_per_page' => 500,
)
);
if ( 'ids' === $return ) {
$ret = wp_list_pluck( $query->posts, 'ID' );
} elseif ( 'posts' === $return ) {
$ret = $query->posts;
} else {
$ret = array_map( 'llms_get_post', $query->posts );
}
return $ret;
}
/**
* Get sibling sections
*
* @since 3.13.0
*
* @param string $return Optional. Type of return [ids|posts|sections]. Default is `sections`.
* @return int[]|WP_Post[]|LLMS_Section[] Return type depends on value of `$return` argument.
*/
public function get_siblings( $return = 'sections' ) {
$course = $this->get_course();
return $course->get_sections( $return );
}
/**
* Add data to the course model when converted to array
*
* Called before data is sorted and returned by $this->jsonSerialize().
*
* @since 3.3.0
* @since 3.24.0 Unknown.
*
* @param array $arr Data to be serialized.
* @return array
*/
public function toArrayAfter( $arr ) {
$arr['lessons'] = array();
foreach ( $this->get_lessons() as $lesson ) {
$arr['lessons'][] = $lesson->toArray();
}
return $arr;
}
}
================================================
FILE: includes/models/model.llms.student.php
================================================
<?php
/**
* Student Model
*
* @package LifterLMS/Models/Classes
*
* @since 2.2.3
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Student model class
*
* Manages data and interactions with a LifterLMS Student.
*
* @since 2.2.3
* @since 3.33.0 Added the `delete_student_enrollment` public method that allows student's enrollment unrollment and deletion.
* @since 3.33.0 Added the `delete_enrollment_postmeta` private method that allows student's enrollment postmeta deletion.
* @since 3.34.0 Added new filters for differentiating between enrollment update and creation; Added the ability to check enrollment from a section.
* @since 3.35.0 Prepare all variables when querying for enrollment date.
* @since 3.36.2 Added logic to physically remove from the membership level and remove enrollments data on related products, when deleting a membership enrollment.
* @since 3.37.9 Added filters `llms_user_enrollment_allowed_post_types` & `llms_user_enrollment_status_allowed_post_types` which allow 3rd parties to enroll users into additional post types via core enrollment methods.
* @since 4.0.0 Remove previously deprecated methods.
* @since 4.2.0 The `$enrollment_trigger` parameter was added to the `'llms_user_enrollment_deleted'` action hook.
* Added new filter to allow customization of object completion data.
* @since 5.2.0 Changed the date to be relative to the local time zone in `get_registration_date`.
* @since 6.0.0 Removed the deprecated `llms_user_removed_from_membership_level` action hook from the `LLMS_Student::unenroll()` method.
* @since 7.5.0 Added the logic to add and remove lesson favorite.
*/
class LLMS_Student extends LLMS_Abstract_User_Data {
use LLMS_Trait_Student_Awards;
/**
* Retrieve an instance of the LLMS_Instructor model for the current user
*
* @return LLMS_Instructor|false
* @since 3.14.0
* @version 3.14.0
*/
public function instructor() {
if ( $this->is_instructor() ) {
return llms_get_instructor( $this->get_id() );
}
return false;
}
/**
* Retrieve an instance of the student quiz data model
*
* @return LLMS_Student_Quizzes
* @since 3.9.0
* @version 3.9.0
*/
public function quizzes() {
return new LLMS_Student_Quizzes( $this->get_id() );
}
/**
* Add the student to a LifterLMS Membership
*
* @param int $membership_id WP Post ID of the membership
* @return void
*
* @since 2.2.3
*/
private function add_membership_level( $membership_id ) {
// Add the user to the membership level.
$membership_levels = $this->get_membership_levels();
array_push( $membership_levels, $membership_id );
update_user_meta( $this->get_id(), '_llms_restricted_levels', $membership_levels );
// If there's auto-enroll courses, enroll the user in those courses.
$autoenroll_courses = get_post_meta( $membership_id, '_llms_auto_enroll', true );
if ( $autoenroll_courses ) {
foreach ( $autoenroll_courses as $course_id ) {
$this->enroll( $course_id, 'membership_' . $membership_id );
}
}
}
/**
* Enroll the student into a course or membership
*
* @since 2.2.3
* @since 3.17.0 Unknown.
* @since 3.34.0 Added new actions to differentiate between first-time enrollment and enrollment status updates.
* @since 3.37.9 Added filter `llms_user_enrollment_allowed_post_types` to customize the post types a user can be enrolled into.
* @since 4.4.1 Moved filter `llms_user_enrollment_allowed_post_types` to function `llms_get_enrollable_post_types()`.
*
* @see llms_enroll_student()
*
* @param int $product_id WP Post ID of the course or membership
* @param string $trigger String describing the reason for enrollment
* @return bool
*/
public function enroll( $product_id, $trigger = 'unspecified' ) {
/**
* Fires before a user is enrolled into a course or membership.
*
* @param int $user_id WP User ID.
* @param int $product_id WP Post ID of the course or membership.
*/
do_action( 'before_llms_user_enrollment', $this->get_id(), $product_id );
// Users can only be enrolled into the following post types.
if ( ! in_array( get_post_type( $product_id ), llms_get_enrollable_post_types(), true ) ) {
return false;
}
// Check enrollment before enrolling to prevent duplicates.
if ( llms_is_user_enrolled( $this->get_id(), $product_id ) ) {
return false;
}
// If the student has been previously enrolled, simply update don't run a full enrollment.
if ( $this->get_enrollment_status( $product_id, false ) ) {
$insert = $this->insert_status_postmeta( $product_id, 'enrolled', $trigger );
$action_type = 'updated';
} else {
$insert = $this->insert_enrollment_postmeta( $product_id, $trigger );
$action_type = 'created';
}
// Add the user postmeta for the enrollment.
if ( ! empty( $insert ) ) {
// Update the cache.
$this->cache_set( sprintf( 'enrollment_status_%d', $product_id ), 'enrolled' );
$this->cache_delete( sprintf( 'date_enrolled_%d', $product_id ) );
$this->cache_delete( sprintf( 'date_updated_%d', $product_id ) );
$post_type = str_replace( 'llms_', '', get_post_type( $product_id ) );
if ( 'course' === $post_type ) {
/**
* Fires after a user is enrolled in course
*
* @param int $user_id WP User ID.
* @param int $product_id WP Post ID of the course or membership.
*/
do_action( 'llms_user_enrolled_in_course', $this->get_id(), $product_id );
} elseif ( 'membership' === $post_type ) {
$this->add_membership_level( $product_id );
/**
* Fires after a user is enrolled in membership
*
* @param int $user_id WP User ID.
* @param int $product_id WP Post ID of the course or membership.
*/
do_action( 'llms_user_added_to_membership_level', $this->get_id(), $product_id );
}
/**
* Fires after a user's enrollment is created or updated.
*
* `$post_type` refers to the type of item the user is enrolled in, either 'course' or 'membership'
* `$action_type` refers to the type of action taking place, either "created" or "updated".
*
* @param int $user_id WP User ID.
* @param int $product_id WP Post ID of the course or membership.
*/
do_action( "llms_user_{$post_type}_enrollment_{$action_type}", $this->get_id(), $product_id );
return true;
}
return false;
}
public function get_avatar( $size = 96 ) {
return '<span class="llms-student-avatar">' . get_avatar( $this->get_id(), $size, null, $this->get_name() ) . '</span>';
}
/**
* Retrieve the order which enrolled a student in a given course or membership.
*
* Retrieves the most recently updated order for the given product.
*
* @since 3.0.0
* @since 5.7.0 Replaced the call to the deprecated `LLMS_Lesson::get_parent_course()` method with `LLMS_Lesson::get( 'parent_course' )`.
*
* @param int $product_id WP Post ID of the LifterLMS Product (course, lesson, or membership)
* @return LLMS_Order|false Instance of the LLMS_Order or false if none found
*/
public function get_enrollment_order( $product_id ) {
// If a lesson id was passed in, cascade up to the course for order retrieval.
if ( 'lesson' === get_post_type( $product_id ) ) {
$lesson = new LLMS_Lesson( $product_id );
$product_id = $lesson->get( 'parent_course' );
}
// Attempt to locate the order via the enrollment trigger.
$trigger = $this->get_enrollment_trigger( $product_id );
if ( strpos( $trigger, 'order_' ) !== false ) {
$id = str_replace( array( 'order_', 'wc_' ), '', $trigger );
if ( is_numeric( $id ) ) {
if ( 'llms_order' === get_post_type( $id ) ) {
return new LLMS_Order( $id );
} else {
return get_post( $id );
}
}
}
// Couldn't find via enrollment trigger, do a WP_Query.
$q = new WP_Query(
array(
'order' => 'DESC',
'orderby' => 'modified',
'meta_query' => array(
'relation' => 'AND',
array(
'key' => '_llms_user_id',
'value' => $this->get_id(),
),
array(
'key' => '_llms_product_id',
'value' => $product_id,
),
),
'posts_per_page' => 1,
'post_type' => 'llms_order',
)
);
if ( $q->have_posts() ) {
return new LLMS_Order( $q->posts[0] );
}
// Couldn't find an order, return false.
return false;
}
/**
* Retrieve IDs of user's courses based on supplied criteria
*
* @param array $args see `get_enrollments`
* @return array
* @since 3.0.0
* @version 3.15.0
*/
public function get_courses( $args = array() ) {
return $this->get_enrollments( 'course', $args );
}
/**
* Retrieve user's favorites based on supplied criteria.
*
* @since 7.5.0
*
* @param string $order_by Result set ordering field. Default "updated_date".
* @param string $order Result set order. Default "DESC". Accepts "DESC" or "ASC".
* @param int $limit Number of favorites to return. Default is infinite.
* @return bool|array
*/
public function get_favorites( $order_by = 'updated_date', $order = 'DESC', $limit = -1 ) {
global $wpdb;
$limit_clause = $limit < 1 ? '' : 'LIMIT 0, ' . intval( $limit );
$res = $wpdb->get_results(
$wpdb->prepare(
"SELECT * FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE meta_key = %s AND user_id = %d ORDER BY %s %s %s;",
'_favorite',
get_current_user_id(),
$order_by,
'DESC' === $order ? 'DESC' : 'ASC',
$limit_clause
)
);
return empty( $res ) ? false : $res;
}
/**
* Retrieve IDs of courses a user has completed
*
* @param array $args query arguments
* @arg int $limit number of courses to return
* @arg string $orderby table reference and field to order results by
* @arg string $order result order (DESC, ASC)
* @arg int $skip number of results to skip for pagination purposes
* @return array "courses" will contain an array of course ids
* "more" will contain a boolean determining whether or not more courses are available beyond supplied limit/skip criteria
* @since ??
* @version 3.24.0
*/
public function get_completed_courses( $args = array() ) {
global $wpdb;
$args = array_merge(
array(
'limit' => 20,
'orderby' => 'upm.updated_date',
'order' => 'DESC',
'skip' => 0,
),
$args
);
// Add one to the limit to see if there's pagination.
++$args['limit'];
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$q = $wpdb->get_results(
$wpdb->prepare(
"SELECT upm.post_id AS id
FROM {$wpdb->prefix}lifterlms_user_postmeta AS upm
JOIN {$wpdb->posts} AS p ON p.ID = upm.post_id
WHERE p.post_type = 'course'
AND upm.meta_key = '_is_complete'
AND upm.meta_value = 'yes'
AND upm.user_id = %d
ORDER BY {$args['orderby']} {$args['order']}
LIMIT %d, %d;
",
array(
$this->get_id(),
$args['skip'],
$args['limit'],
)
),
'OBJECT_K'
); // db call ok; no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$ids = array_keys( $q );
$more = false;
// If we hit our limit we have too many results, pop the last one.
if ( count( $ids ) === $args['limit'] ) {
array_pop( $ids );
$more = true;
}
// Reset args to pass back for pagination.
--$args['limit'];
$r = array(
'limit' => $args['limit'],
'more' => $more,
'results' => $ids,
'skip' => $args['skip'],
);
return $r;
}
/**
* Get the formatted date when a course or lesson was completed by the student
*
* @param int $object_id WP Post ID of a course or lesson
* @param string $format date format as accepted by php date()
* @return false|string will return false if the user is not enrolled
* @since ??
* @version ??
*/
public function get_completion_date( $object_id, $format = 'F d, Y' ) {
global $wpdb;
$q = $wpdb->get_var(
$wpdb->prepare(
"SELECT updated_date FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_key = '_is_complete' AND meta_value = 'yes' AND user_id = %d AND post_id = %d ORDER BY updated_date DESC LIMIT 1",
array( $this->get_id(), $object_id )
)
); // db call ok; no-cache ok.
return ( $q ) ? date_i18n( $format, strtotime( $q ) ) : false;
}
/**
* Retrieve IDs of user's enrollments by post type (and additional criteria)
*
* @param string $post_type name of the post type (course|membership)
* @param array $args query arguments
* @arg int $limit number of courses to return
* @arg string $orderby table reference and field to order results by
* @arg string $order result order (DESC, ASC)
* @arg int $skip number of results to skip for pagination purposes
* @arg string $status filter results by enrollment status, "any", "enrolled", "cancelled", or "expired"
* @return array "results" will contain an array of course ids
* "more" will contain a boolean determining whether or not more courses are available beyond supplied limit/skip criteria
* "found" will contain the total possible FOUND_ROWS() for the query
* @since 3.0.0
* @version 3.15.1
*/
public function get_enrollments( $post_type = 'course', $args = array() ) {
global $wpdb;
$args = wp_parse_args(
$args,
array(
'limit' => 20,
'orderby' => 'upm.updated_date',
'order' => 'DESC',
'skip' => 0,
'status' => 'any', // Any, enrolled, cancelled, expired.
)
);
// Prefix membership.
if ( 'membership' === $post_type ) {
$post_type = 'llms_membership';
}
// Sanitize order & orderby.
$args['orderby'] = preg_replace( '/[^a-zA-Z_.]/', '', $args['orderby'] );
$args['order'] = preg_replace( '/[^a-zA-Z_.]/', '', $args['order'] );
// Allow "short" orderby's to be passed in without a table reference.
switch ( $args['orderby'] ) {
case 'date':
$args['orderby'] = 'upm.updated_date';
break;
case 'order':
$args['orderby'] = 'p.menu_order';
break;
case 'title':
$args['orderby'] = 'p.post_title';
break;
}
// Prepare additional status AND clauses.
if ( 'any' !== $args['status'] ) {
$status = $wpdb->prepare(
"
AND upm.meta_value = %s
AND upm.updated_date = (
SELECT MAX( upm2.updated_date )
FROM {$wpdb->prefix}lifterlms_user_postmeta AS upm2
WHERE upm2.meta_key = '_status'
AND upm2.user_id = %d
AND upm2.post_id = upm.post_id
)",
$args['status'],
$this->get_id()
);
} else {
$status = '';
}
$from_where = "FROM {$wpdb->prefix}lifterlms_user_postmeta AS upm
JOIN {$wpdb->posts} AS p ON p.ID = upm.post_id
WHERE p.post_type = %s
AND p.post_status = 'publish'
AND upm.meta_key = '_status'
AND upm.user_id = %d
{$status}";
$prepare_args = array( $post_type, $this->get_id() );
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$found = absint(
$wpdb->get_var(
$wpdb->prepare(
"SELECT COUNT(DISTINCT upm.post_id) {$from_where}",
$prepare_args
)
)
); // db call ok; no-cache ok.
$query = $wpdb->get_results(
$wpdb->prepare(
"SELECT DISTINCT upm.post_id AS id
{$from_where}
ORDER BY {$args['orderby']} {$args['order']}
LIMIT %d, %d;
",
array_merge(
$prepare_args,
array( $args['skip'], $args['limit'] )
)
),
'OBJECT_K'
); // db call ok; no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return array(
'found' => $found,
'limit' => $args['limit'],
'more' => ( $found > ( ( $args['skip'] / $args['limit'] + 1 ) * $args['limit'] ) ),
'skip' => $args['skip'],
'results' => array_keys( $query ),
);
}
/**
* Get the formatted date when a user initially enrolled in a product or when they were last updated
*
* @since 3.0.0
* @since 3.35.0 Prepare SQL properly.
*
* @param int $product_id WP Post ID of a course or membership
* @param string $date "enrolled" will get the most recent start date, "updated" will get the most recent status change date
* @param string $format date format as accepted by php date(), if none supplied uses the WP core "date_format" option
* @return false|string will return false if the user is not enrolled
*/
public function get_enrollment_date( $product_id, $date = 'enrolled', $format = null ) {
if ( ! $format ) {
$format = get_option( 'date_format', 'M d, Y' );
}
$cache_key = sprintf( 'date_%1$s_%2$s', $date, $product_id );
$res = $this->cache_get( $cache_key );
if ( false === $res ) {
$key = ( 'enrolled' === $date ) ? '_start_date' : '_status';
global $wpdb;
// Get the oldest recorded Enrollment date.
$res = $wpdb->get_var(
$wpdb->prepare(
"SELECT updated_date FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE meta_key = %s AND user_id = %d AND post_id = %d ORDER BY updated_date DESC LIMIT 1",
array( $key, $this->get_id(), $product_id )
)
);
$this->cache_set( $cache_key, $res );
}
return ( $res ) ? date_i18n( $format, strtotime( $res ) ) : false;
}
/**
* Get the current enrollment status of a student for a particular product
*
* @since 3.0.0
* @since 3.17.0 Unknown.
* @since 3.37.9 Added filter `llms_user_enrollment_status_allowed_post_types`.
* @since 4.4.1 Moved filter `llms_user_enrollment_status_allowed_post_types` to function `llms_get_enrollable_status_check_post_types()`.
* @since 4.18.0 Added a tie-breaker when there are multiple enrollment statuses with the same date & time.
* @since 5.7.0 Replaced the call to the deprecated `LLMS_Lesson::get_parent_course()` method with `LLMS_Lesson::get( 'parent_course' )`.
*
* @param int $product_id WP Post ID of a Course, Section, Lesson, or Membership
* @param bool $use_cache If true, returns cached data if available, if false will run a db query
* @return false|string When no enrollment status exists, returns `false`. Otherwise returns the
* enrollment status as a string.
*/
public function get_enrollment_status( $product_id, $use_cache = true ) {
$status = false;
$product_type = get_post_type( $product_id );
if ( ! in_array( $product_type, llms_get_enrollable_status_check_post_types(), true ) ) {
/* This filter is documented at the end of this method. */
return apply_filters( 'llms_get_enrollment_status', $status, $this->get_id(), $product_id, $use_cache );
}
// Get course ID if we're looking at a lesson or section.
if ( in_array( $product_type, array( 'section', 'lesson' ), true ) ) {
$llms_post = llms_get_post( $product_id );
if ( $llms_post ) {
$product_id = $llms_post->get( 'parent_course' );
}
}
if ( $use_cache ) {
$status = $this->cache_get( sprintf( 'enrollment_status_%d', $product_id ) );
}
/**
* After checking the cache, $status will be:
* + `false` if there was nothing in the cache or the function was instructed to not use the cache: Query the database to get the status.
* + a string if there was a status: No need to query the database.
* + `null` if there's no status: No need to query the database.
*/
if ( false === $status ) {
global $wpdb;
// Get the most recent recorded status.
$status = $wpdb->get_var(
$wpdb->prepare(
"SELECT meta_value FROM {$wpdb->prefix}lifterlms_user_postmeta
WHERE meta_key = '_status' AND user_id = %d AND post_id = %d
ORDER BY updated_date DESC, meta_id DESC LIMIT 1;",
array( $this->get_id(), $product_id )
)
);
// Cache the data: `null` will be stored if the student has no status.
$this->cache_set( sprintf( 'enrollment_status_%d', $product_id ), $status );
}
// Don't return `null` values from the database.
$status = $status ? $status : false;
/**
* Filter a user's enrollment status for a specific post.
*
* Note that if a value is modified by this filter the modified value is *not* cached. Therefore you should
* consider implementing caching of your modified value which matches the caching implemented by this method
* so that the modified value obeys the default caching behavior.
*
* @since Unknown
*
* @param false|string $status When no enrollment status exists, returns `false`. Otherwise returns the
* enrollment status as a string.
* @param int $user_id WP_User ID of the student
* @param int $product_id WP_Post ID of the post used to check the enrollment status.
* @param boolean $use_cache Whether or not to use the local cache.
*/
return apply_filters( 'llms_get_enrollment_status', $status, $this->get_id(), $product_id, $use_cache );
}
/**
* Get the enrollment trigger for a the student's enrollment in a course
*
* @param int $product_id WP Post ID of the course or membership
* @return string|false
* @since ??
* @version 3.21.0
*/
public function get_enrollment_trigger( $product_id ) {
$trigger = llms_get_user_postmeta( $this->get_id(), $product_id, '_enrollment_trigger', true );
return $trigger ? $trigger : false;
}
/**
* Get the enrollment trigger id for a the student's enrollment in a course
*
* @param int $product_id WP Post ID of the course or membership
* @return int|false
* @since 3.0.0
* @version 3.17.2
*/
public function get_enrollment_trigger_id( $product_id ) {
$trigger = $this->get_enrollment_trigger( $product_id );
$id = false;
if ( $trigger && false !== strpos( $trigger, 'order_' ) ) {
$trigger_obj = $this->get_enrollment_order( $product_id );
if ( $trigger_obj instanceof LLMS_Order ) {
$id = $trigger_obj->get( 'id' );
} elseif ( $trigger_obj instanceof WP_Post ) {
$id = $trigger_obj->ID;
}
} elseif ( $trigger && false !== strpos( $trigger, 'admin_' ) ) {
$id = absint( str_replace( 'admin_', '', $trigger ) );
}
return $id;
}
/**
* Retrieve postmeta events related to the student
*
* @param array $args default args, see LLMS_Query_User_Postmeta
* @return array
* @since 3.15.0
* @version 3.15.0
*/
public function get_events( $args = array() ) {
$query = new LLMS_Query_User_Postmeta(
wp_parse_args(
$args,
array(
'types' => 'all',
'per_page' => 10,
'user_id' => $this->get_id(),
'no_found_rows' => true,
)
)
);
return $query->get_metas();
}
/**
* Get the students grade for a lesson / course
* All grades are based on quizzes assigned to lessons
*
* @param int $object_id WP Post ID of a course or lesson
* @param bool $use_cache If true, uses cached results
* @return mixed
* @since ??
* @version 3.24.0
*/
public function get_grade( $object_id, $use_cache = true ) {
$grade = llms()->grades()->get_grade( $object_id, $this, $use_cache );
if ( is_null( $grade ) ) {
$grade = _x( 'N/A', 'Grade to display when no quizzes taken or available', 'lifterlms' );
}
return apply_filters( 'llms_student_get_grade', $grade, $this, $object_id, get_post_type( $object_id ) );
}
/**
* Retrieve IDs of user's memberships based on supplied criteria
*
* @param array $args see `get_enrollments`
* @return array
* @since 3.15.0
* @version 3.15.0
*/
public function get_memberships( $args = array() ) {
return $this->get_enrollments( 'membership', $args );
}
/**
* Retrieve a user's notification subscription preferences for a given type & trigger
*
* @param string $type notification type: email, basic, etc...
* @param string $trigger notification trigger: eg purchase_receipt, lesson_complete, etc...
* @param string $default value to return if no setting is saved in the db
* @return string yes or no
* @since 3.10.0
* @version 3.10.0
*/
public function get_notification_subscription( $type, $trigger, $default = 'no' ) {
$prefs = $this->get( 'notification_subscriptions' );
if ( ! $prefs ) {
$prefs = array();
}
if ( isset( $prefs[ $type ] ) && isset( $prefs[ $type ][ $trigger ] ) ) {
return $prefs[ $type ][ $trigger ];
}
return $default;
}
/**
* Retrieve the student's overall grade
*
* Grade = sum of grades for all courses divided by number of enrolled courses
* if a course has no quizzes in it, it cannot be graded and is therefore excluded from the calculation.
*
* Cached data is automatically cleared when a student completes a quiz.
*
* @since 3.2.0
*
* @param boolean $use_cache If `false`, calculates the grade, otherwise utilizes cached data (if available)
* @return float|string Grade as float or "N/A"
*/
public function get_overall_grade( $use_cache = true ) {
$grade = null;
// Attempt to pull from the cache first.
if ( $use_cache ) {
$grade = $this->get( $this->meta_prefix . 'overall_grade' );
if ( is_numeric( $grade ) ) {
$grade = floatval( $grade );
}
}
// Cache disabled or no cached data available.
if ( ! $use_cache || null === $grade || '' === $grade ) {
$grades = array();
// Get courses.
$courses = $this->get_courses(
array(
'limit' => 9999,
)
);
// Loop through courses.
foreach ( $courses['results'] as $course_id ) {
// Get course grade.
$g = $this->get_grade( $course_id );
// If an actual grade (not N/A) is returned.
if ( is_numeric( $g ) ) {
array_push( $grades, $g );
}
}
// If we have at least one grade.
$count = count( $grades );
if ( $count ) {
$grade = round( array_sum( $grades ) / $count, 2 );
} else {
$grade = _x( 'N/A', 'overall grade when no quizzes', 'lifterlms' );
}
// Cache the grade.
$this->set( 'overall_grade', $grade );
}
return apply_filters( 'llms_student_get_overall_grade', $grade, $this );
}
/**
* Retrieve a student's overall progress
* Overall progress is the total percentage completed based on all courses the student is enrolled in
* Cached data is cleared every time the student completes a lesson
*
* @param boolean $use_cache if false, calculates the progress, otherwise utilizes cached data (if available)
* @return float
* @since 3.2.0
* @version 3.2.0
*/
public function get_overall_progress( $use_cache = true ) {
$progress = null;
// Attempt to pull from the cache first.
if ( $use_cache ) {
$progress = $this->get( $this->meta_prefix . 'overall_progress' );
if ( is_numeric( $progress ) ) {
$progress = floatval( $progress );
}
}
// Cache disabled or no cached data available.
if ( ! $use_cache || null === $progress || '' === $progress ) {
$progresses = array();
// Get courses.
$courses = $this->get_courses(
array(
'limit' => 9999,
)
);
// Loop through courses.
foreach ( $courses['results'] as $course_id ) {
array_push( $progresses, $this->get_progress( $course_id, 'course' ) );
}
$count = count( $progresses );
if ( $count ) {
$progress = round( array_sum( $progresses ) / $count, 2 );
} else {
$progress = 0;
}
// Cache the grade.
$this->set( 'overall_progress', $progress );
}
return apply_filters( 'llms_student_get_overall_progress', $progress, $this );
}
/**
* Get the students last completed lesson in a course
*
* @param int $course_id WP_Post ID of the course
* @return int WP_Post ID of the lesson or false if no progress has been made
* @since 3.0.0
* @version 3.0.0
*/
public function get_last_completed_lesson( $course_id ) {
$course = new LLMS_Course( $course_id );
$lessons = array_reverse( $course->get_lessons( 'ids' ) );
foreach ( $lessons as $lesson ) {
if ( $this->is_complete( $lesson, 'lesson' ) ) {
return $lesson;
}
}
return false;
}
public function has_unlimited_quiz_time() {
$unlimited = get_user_option( 'llms_allow_unlimited_quiz_time', $this->get_id() );
return ( 'yes' === $unlimited );
}
/**
* Retrieve an array of Membership Levels for a user
*
* @return array
* @since 2.2.3
* @version 2.2.3
*/
public function get_membership_levels() {
$levels = get_user_meta( $this->get_id(), '_llms_restricted_levels', true );
if ( empty( $levels ) ) {
$levels = array();
}
return $levels;
}
/**
* Get the full name of a student
*
* @return string
* @since 3.0.4
* @version 3.5.1
*/
public function get_name() {
$name = trim( $this->get( 'first_name' ) . ' ' . $this->get( 'last_name' ) );
if ( ! $name ) {
$name = $this->display_name;
}
return apply_filters( 'llms_student_get_name', $name, $this->get_id(), $this );
}
/**
* Get the next lesson a student needs to complete in a course
*
* @param int $course_id WP_Post ID of the course
* @return int WP_Post ID of the lesson or false if all courses are complete
* @since 3.0.1
* @version 3.0.1
*/
public function get_next_lesson( $course_id ) {
$course = new LLMS_Course( $course_id );
$lessons = $course->get_lessons( 'ids' );
foreach ( $lessons as $lesson ) {
if ( ! $this->is_complete( $lesson, 'lesson' ) ) {
return $lesson;
}
}
return false;
}
public function get_orders( $params = array() ) {
$params = wp_parse_args(
$params,
array(
'count' => 25,
'page' => 1,
'statuses' => array_keys( llms_get_order_statuses() ),
)
);
extract( $params );
$q = new WP_Query(
array(
'order' => 'DESC',
'orderby' => 'date',
'meta_query' => array(
array(
'key' => '_llms_user_id',
'value' => $this->get_id(),
),
),
'paged' => $page,
'posts_per_page' => $count,
'post_status' => $statuses,
'post_type' => 'llms_order',
)
);
$orders = array();
if ( $q->have_posts() ) {
foreach ( $q->posts as $post ) {
$orders[ $post->ID ] = new LLMS_Order( $post );
}
}
return array(
'count' => count( $q->posts ),
'page' => $page,
'pages' => $q->max_num_pages,
'orders' => $orders,
);
}
/**
* Get students progress through a course or track
*
* @param int $object_id course or track id
* @param string $type object type [course|course_track|section]
* @param boolean $use_cache if true, will use cached data from the usermeta table (if available)
* if false, will bypass cached data and recalculate the progress from scratch
* @return float
* @since 3.0.0
* @version 3.24.0
*/
public function get_progress( $object_id, $type = 'course', $use_cache = true ) {
$ret = 0;
$cache_key = sprintf( '%1$s_%2$d_progress', $type, $object_id );
$cached = $use_cache ? $this->get( $cache_key ) : '';
if ( '' === $cached ) {
$total = 0;
$completed = 0;
if ( 'course' === $type ) {
$course = new LLMS_Course( $object_id );
$lessons = $course->get_lessons( 'ids' );
$total = count( $lessons );
foreach ( $lessons as $lesson ) {
if ( $this->is_complete( $lesson, 'lesson' ) ) {
++$completed;
}
}
} elseif ( 'course_track' === $type ) {
$track = new LLMS_Track( $object_id );
$courses = $track->get_courses();
$total = count( $courses );
foreach ( $courses as $course ) {
if ( $this->is_complete( $course->ID, 'course' ) ) {
++$completed;
}
}
} elseif ( 'section' === $type ) {
$section = new LLMS_Section( $object_id );
$lessons = $section->get_lessons( 'ids' );
$total = count( $lessons );
foreach ( $lessons as $lesson ) {
if ( $this->is_complete( $lesson, 'lesson' ) ) {
++$completed;
}
}
}
$ret = ( ! $completed || ! $total ) ? 0 : round( 100 / ( $total / $completed ), 2 );
$this->set( $cache_key, $ret );
} else {
$ret = $cached;
}// End if().
/**
* @filter llms_student_get_progress
* Filters the return of get_progress method
* @param float $ret student's progress
* @param int $object_id WP_Post ID of the object
* @param string $type object post type [course|course_track|section]
* @param int $user_id WP_User ID of the student
* @since unknown
* @version 3.24.0
*/
return apply_filters( 'llms_student_get_progress', $ret, $object_id, $type, $this->get_id() );
}
/**
* Retrieve the student's original registration date in the chosen format.
*
* @since Unknown
* @since 5.2.0 Changed the date to be relative to the local time zone.
*
* @param string $format Any date format that can be passed to date().
* @return string
*/
public function get_registration_date( $format = '' ) {
if ( ! $format ) {
$format = get_option( 'date_format' );
}
return wp_date( $format, strtotime( $this->get( 'user_registered' ) ) );
}
/**
* Determine if the student is active in at least one course or membership
*
* @since 3.14.0
*
* @return bool
*/
public function is_active() {
// Check memberships first, it's a faster query.
if ( $this->get_membership_levels() ) {
return true;
}
// Check for at least one enrolled course.
$courses = $this->get_courses(
array(
'limit' => 1,
'status' => 'enrolled',
)
);
if ( $courses['results'] ) {
return true;
}
// Not active.
return false;
}
/**
* Determine if the student has completed a course, track, or lesson
*
* @param int $object_id WP Post ID of a course or lesson or section or the term id of the track
* @param string $type Object type (course, lesson, section, or track)
* @return boolean
* @since 3.0.0
* @version 3.24.0
*/
public function is_complete( $object_id, $type = 'course' ) {
// check tracks by progress
// this is done because tracks can have the same id as another object...
// @todo tracks should have a different table or format since the post_id col won't guarantee uniqueness...
if ( 'course_track' === $type ) {
$ret = ( 100 == $this->get_progress( $object_id, $type ) );
// Everything else can be checked on the postmeta table.
} else {
$query = new LLMS_Query_User_Postmeta(
array(
'types' => 'completion',
'include_post_children' => false,
'user_id' => $this->get_id(),
'post_id' => $object_id,
'per_page' => 1,
'no_found_rows' => true,
)
);
$ret = $query->has_results();
}
return apply_filters( 'llms_is_' . $type . '_complete', $ret, $object_id, $type, $this );
}
/**
* Determine if the student is a LifterLMS Instructor (of any kind)
*
* Can be admin, manager, instructor, assistant.
*
* @return boolean
* @since 3.14.0
* @version 3.14.0
*/
public function is_instructor() {
return $this->user->has_cap( 'lifterlms_instructor' );
}
/**
* Add student postmeta data for completion of a lesson, section, course or track
*
* @param int $object_id WP Post ID of the lesson, section, course or track
* @param string $trigger String describing the reason for mark completion
* @return bool
* @since 3.3.1
* @version 3.21.0
*/
private function insert_completion_postmeta( $object_id, $trigger = 'unspecified' ) {
// Add info to the user postmeta table.
$user_metadatas = array(
'_is_complete' => 'yes',
'_completion_trigger' => $trigger,
);
$update = llms_bulk_update_user_postmeta( $this->get_id(), $object_id, $user_metadatas, false );
// Returns an array with errored keys or true on success.
return is_array( $update ) ? false : true;
}
/**
* Add student postmeta data for incompletion of a lesson, section, course or track
* An "_is_complete" value of "no" is inserted into postmeta
*
* @param int $object_id WP Post ID of the lesson, section, course or track
* @param string $trigger String describing the reason for mark incompletion
* @return boolean
* @since 3.5.0
* @version 3.24.0
*/
private function insert_incompletion_postmeta( $object_id, $trigger = 'unspecified' ) {
global $wpdb;
// Add '_is_complete' to the user postmeta table for object.
$user_metadatas = array(
'_is_complete' => 'no',
'_completion_trigger' => $trigger,
);
foreach ( $user_metadatas as $key => $value ) {
/**
* It's too difficult to keep track of multiple postmetas for each lesson incomplete
* Instead, I'm just replacing the old '_is_complete' value with 'no'
*
* Lessons that have never been complete will not have an '_is_complete' record,
* Lessons that were completed will have an '_is_complete' record of 'yes',
* Lessons that have been completed once but were marked incomplete will have an '_is_complete' record of 'no'
*/
$update = $wpdb->update(
$wpdb->prefix . 'lifterlms_user_postmeta',
array(
'user_id' => $this->get_id(),
'post_id' => $object_id,
'meta_key' => $key,
'meta_value' => $value,
'updated_date' => current_time( 'mysql' ),
),
array(
'user_id' => $this->get_id(),
'post_id' => $object_id,
'meta_key' => $key,
),
array( '%d', '%d', '%s', '%s', '%s' )
); // db call ok; no-cache ok.
if ( false === $update ) {
return false;
}
}
return true;
}
/**
* Add student postmeta data when lesson is favorited.
*
* @since 7.5.0
*
* @see LLMS_Student->mark_favorite()
*
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @return bool
*/
private function insert_favorite_postmeta( $object_id ) {
$update = llms_update_user_postmeta( $this->get_id(), $object_id, '_favorite', true );
// Returns boolean if postmeta update is successful.
return is_array( $update ) ? false : true;
}
/**
* Remove student postmeta data when lesson is unfavorited.
*
* @since 7.5.0
*
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @return bool
*/
private function remove_favorite_postmeta( $object_id ) {
$update = llms_delete_user_postmeta( $this->get_id(), $object_id, '_favorite', true );
// Returns boolean if postmeta update is successful.
return is_array( $update ) ? false : true;
}
/**
* Add student postmeta data for enrollment into a course or membership
*
* @param int $product_id WP Post ID of the course or membership
* @param string $trigger String describing the reason for enrollment
* @return boolean
* @since 2.2.3
* @version 3.21.0
*/
private function insert_enrollment_postmeta( $product_id, $trigger = 'unspecified' ) {
// Add info to the user postmeta table.
$user_metadatas = array(
'_enrollment_trigger' => $trigger,
'_start_date' => 'yes',
'_status' => 'enrolled',
);
$update = llms_bulk_update_user_postmeta( $this->get_id(), $product_id, $user_metadatas, false );
// Returns an array with errored keys or true on success.
return is_array( $update ) ? false : true;
}
/**
* Remove student enrollment postmeta for a given product.
*
* @since 3.33.0
*
* @param int $product_id WP Post ID of the course or membership.
* @param string $trigger Optional. String the reason for enrollment. Default `null`
* @return bool Whether or not the enrollment records have been succesfully removed.
*/
private function delete_enrollment_postmeta( $product_id, $trigger = null ) {
// Delete info from the user postmeta table.
$user_metadatas = array(
'_enrollment_trigger' => $trigger,
'_start_date' => null,
'_status' => null,
);
$delete = llms_bulk_delete_user_postmeta( $this->get_id(), $product_id, $user_metadatas );
return is_array( $delete ) ? false : true;
}
/**
* Add a new status record to the user postmeta table for a specific product
*
* @param int $product_id WP Post ID of the course or membership
* @param string $status string describing the new status
* @param string $trigger String describing the reason for enrollment (optional)
* @return boolean
* @since 3.0.0
* @version 3.21.0
*/
private function insert_status_postmeta( $product_id, $status = '', $trigger = null ) {
$update = llms_update_user_postmeta( $this->get_id(), $product_id, '_status', $status, false );
if ( $update && $trigger ) {
$update = llms_update_user_postmeta( $this->get_id(), $product_id, '_enrollment_trigger', $trigger, false );
}
return $update;
}
/**
* Determine if a student is enrolled in a Course or Membership.
*
* @see llms_is_user_enrolled()
*
* @param int|array $product_ids WP Post ID of a Course, Section, Lesson, or Membership or array of multiple IDs.
* @param string $relation Comparator for enrollment check.
* All = user must be enrolled in all $product_ids.
* Any = user must be enrolled in at least one of the $product_ids.
* @param bool $use_cache If true, returns cached data if available, if false will run a db query.
*
* @return boolean
*
* @since 3.0.0
* @version 3.25.0
*/
public function is_enrolled( $product_ids = null, $relation = 'all', $use_cache = true ) {
// Assume enrollment unless we find otherwise.
$ret = true;
// Allow a single product ID to be submitted (backwards compat).
$product_ids = ! is_array( $product_ids ) ? array( $product_ids ) : $product_ids;
foreach ( $product_ids as $id ) {
$enrolled = ( 'enrolled' === strtolower( $this->get_enrollment_status( $id, $use_cache ) ) );
// If use must be enrolled in all products and one is not enrolled: quit the loop & return false.
if ( 'all' === $relation && ! $enrolled ) {
$ret = false;
break;
// If user must be enrolled in any.
} elseif ( 'any' === $relation ) {
// If we find an enrollment: return true and quit the loop.
if ( $enrolled ) {
$ret = true;
break;
// If not switch return to false but keep looking.
} else {
$ret = false;
}
}
}
return apply_filters( 'llms_is_user_enrolled', $ret, $this, $product_ids, $relation, $use_cache );
}
/**
* Mark a lesson, section, course, or track complete for the given user.
*
* @param int $object_id WP Post ID of the lesson, section, course, or track
* @param string $object_type object type [lesson|section|course|track]
* @param string $trigger String describing the reason for marking complete
* @return bool
*
* @see llms_mark_complete() calls this function without having to instantiate the LLMS_Student class first
*
* @since 3.3.1
* @version 3.17.1
*/
public function mark_complete( $object_id, $object_type, $trigger = 'unspecified' ) {
// Short circuit if it's already completed.
if ( $this->is_complete( $object_id, $object_type ) ) {
return true;
}
return $this->update_completion_status( 'complete', $object_id, $object_type, $trigger );
}
/**
* Mark a lesson, section, course, or track incomplete for the given user
* Gives an "_is_complete" value of "no" for the given object
*
* @param int $object_id WP Post ID of the lesson, section, course, or track
* @param string $object_type object type [lesson|section|course|track]
* @param string $trigger String describing the reason for marking incomplete
* @return bool
*
* @see llms_mark_incomplete() calls this function without having to instantiate the LLMS_Student class first
*
* @since 3.5.0
* @version 3.17.0
*/
public function mark_incomplete( $object_id, $object_type, $trigger = 'unspecified' ) {
return $this->update_completion_status( 'incomplete', $object_id, $object_type, $trigger );
}
/**
* Remove a student from a membership level.
*
* @since 2.7
* @since 3.7.5 Unknown.
* @since 3.36.2 Added the $delete parameter, that will allow related courses enrollments data deletion.
*
* @param int $membership_id WP Post ID of the membership.
* @param string $status Optional. Status to update the removal to. Default is `expired`.
* @param boolean $delete Optional. Status to update the removal to. Default is `false`.
* @return void
*/
private function remove_membership_level( $membership_id, $status = 'expired', $delete = false ) {
// Remove the user from the membership level.
$membership_levels = $this->get_membership_levels();
$key = array_search( $membership_id, $membership_levels );
if ( false !== $key ) {
unset( $membership_levels[ $key ] );
}
update_user_meta( $this->get_id(), '_llms_restricted_levels', $membership_levels );
global $wpdb;
// Locate all enrollments triggered by this membership level.
$q = $wpdb->get_results(
$wpdb->prepare(
"SELECT post_id FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE user_id = %d AND meta_key = '_enrollment_trigger' AND meta_value = %s",
array( $this->get_id(), 'membership_' . $membership_id )
),
'OBJECT_K'
); // db call ok; no-cache ok.
$courses = array_keys( $q );
if ( $courses ) {
// Loop through all the courses and update the enrollment status.
foreach ( $courses as $course_id ) {
// See if they should continue to have access to this course via another membership's current auto-enroll settings.
$membership_levels = $this->get_membership_levels();
$unenroll_from_course = true;
foreach ( $membership_levels as $membership_level_id ) {
if ( $membership_id === $membership_level_id ) {
continue;
}
$membership = new LLMS_Membership( $membership_level_id );
$autoenroll_courses = $membership->get_auto_enroll_courses();
if ( $autoenroll_courses ) {
if ( in_array( $course_id, $autoenroll_courses ) ) {
// Update the enrollment trigger to the membership that is keeping them enrolled in the course.
llms_update_user_postmeta( $this->get_id(), $course_id, '_enrollment_trigger', 'membership_' . $membership_level_id, false );
$unenroll_from_course = false;
break;
}
}
}
if ( ! $unenroll_from_course ) {
continue;
}
if ( ! $delete ) {
$this->unenroll( $course_id, 'membership_' . $membership_id, $status );
} else {
$this->delete_enrollment( $course_id, 'membership_' . $membership_id );
}
}
}
}
/**
* Remove a student from a LifterLMS course or membership
*
* @since 3.0.0
* @since 3.26.0 Unknown.
* @since 3.37.9 Update to accommodate custom post type enrollments added through new filters.
* Marked action `llms_user_removed_from_membership_level` as deprecated, use `llms_user_removed_from_membership` instead.
* @since 6.0.0 Removed the deprecated `llms_user_removed_from_membership_level` action hook
* and moved the call to `LLMS_Student::remove_membership_level()` to be before triggering the
* `llms_user_removed_from_{$post_type}` action hook.
*
* @see llms_unenroll_student()
*
* @param int $product_id WordPress Post ID of the course or membership.
* @param string $trigger Only remove the student if the original enrollment trigger matches the submitted value.
* Passing `any` will remove regardless of enrollment trigger.
* @param string $new_status the value to update the new status with after removal is complete.
* @return bool
*/
public function unenroll( $product_id, $trigger = 'any', $new_status = 'expired' ) {
// Can only unenroll those that are a currently enrolled.
if ( ! $this->is_enrolled( $product_id, 'all', false ) ) {
return false;
}
// Assume we can't unenroll.
$update = false;
// If trigger is "any" we'll unenroll regardless of the trigger.
if ( 'any' === $trigger ) {
$update = true;
} else {
$enrollment_trigger = $this->get_enrollment_trigger( $product_id );
// No enrollment trigger exists b/c pre 3.0.0 enrollment, unenroll the user as if it was an 'any' trigger.
if ( ! $enrollment_trigger ) {
/**
* This filter allows customization of enrollments created prior to version 3.0.0
*
* Prior to 3.0.0 enrollments did not track an enrollment trigger so any unenrollments
* performed on an enrollment in this state will automatically be unenrolled.
*
* Returning `false` will prevent unenrollments against enrollments which don't have
* an enrollment trigger.
*
* @since 3.0.0
*
* @param bool $allow_unenrollment If true, allows unenrollment, otherwise prevents unenrollment.
*/
$update = apply_filters( 'lifterlms_legacy_unenrollment_action', true );
} elseif ( $enrollment_trigger === $trigger ) {
$update = true;
}
}
// Update if we can.
if ( $update ) {
// Update enrollment for the product.
if ( $this->insert_status_postmeta( $product_id, $new_status ) ) {
// Update the cache.
$this->cache_set( sprintf( 'enrollment_status_%d', $product_id ), $new_status );
$this->cache_delete( sprintf( 'date_enrolled_%d', $product_id ) );
$this->cache_delete( sprintf( 'date_updated_%d', $product_id ) );
$post_type = str_replace( 'llms_', '', get_post_type( $product_id ) );
// Run legacy action and trigger cascading unenrollments for membership relationships.
if ( 'membership' === $post_type ) {
// Users should be unenrolled from all courses they accessed through this membership.
$this->remove_membership_level( $product_id, $new_status );
}
/**
* Trigger an action immediately following user unenrollment
*
* The dynamic portion of this hook, `{$post_type}` corresponds to the post type of the
* `$product_id`. Note that any post type prefixed with `llms_` is stripped. For example
* when triggered by a membership (`llms_membership`) the hook will be `llms_user_removed_from_membership`.
*
* @since 3.37.9
*
* @param int $user_id WP_User ID of the student
* @param int $product_id WP_Post ID of the product.
* @param string $trigger Enrollment trigger.
* @param string $new_status New enrollment status of the student after the unenrollment has taken place.
*/
do_action( "llms_user_removed_from_{$post_type}", $this->get_id(), $product_id, $trigger, $new_status );
return true;
}
}
// Update was prevented.
return false;
}
/**
* Delete a student enrollment.
*
* @since 3.33.0
* @since 3.36.2 Added logic to physically remove from the membership level and remove enrollments data on related products.
* @since 4.2.0 The `$enrollment_trigger` parameter was added to the `llms_user_enrollment_deleted` action hook.
*
* @see `llms_delete_student_enrollment()` calls this function without having to instantiate the LLMS_Student class first.
*
* @param int $product_id WP Post ID of the course or membership.
* @param string $trigger Optional. Only delete the student's enrollment if the original enrollment trigger matches the submitted value.
* "any" will remove regardless of enrollment trigger. Default "any".
* @return bool Whether or not the enrollment records have been successfully removed.
*/
public function delete_enrollment( $product_id, $trigger = 'any' ) {
// Assume we can't delete the enrollment.
$delete = false;
// Get the stored trigger.
$enrollment_trigger = $this->get_enrollment_trigger( $product_id );
// Okay to delete if trigger is "any" or if it matches the stored enrollment trigger.
if ( 'any' === $trigger || $enrollment_trigger === $trigger ) {
$delete = true;
} elseif ( ! $enrollment_trigger ) {
/**
* Customize the behavior of enrollment deletion for "legacy" orders.
*
* These orders were created before version 3.0.0 when there was no stored
* enrollment trigger.
*
* By default, we'll automatically delete these enrollments regardless of trigger.
*
* @since 3.33.0
*
* @param boolean $delete Whether or not to delete the enrollment.
*/
$delete = apply_filters( 'lifterlms_legacy_delete_enrollment_action', true );
// Ensure we have an `$enrollment_trigger` when firing the `llms_user_enrollment_deleted` hook.
$enrollment_trigger = $trigger;
}
// Delete the enrollment.
if ( $delete && $this->delete_enrollment_postmeta( $product_id ) ) {
// Clean the cache.
$this->cache_delete( sprintf( 'enrollment_status_%d', $product_id ) );
$this->cache_delete( sprintf( 'date_enrolled_%d', $product_id ) );
$this->cache_delete( sprintf( 'date_updated_%d', $product_id ) );
if ( 'llms_membership' === get_post_type( $product_id ) ) {
// Physically remove from the membership level & remove enrollments data on related products.
$this->remove_membership_level( $product_id, '', true );
}
/**
* Fires after an user enrollment has been deleted.
*
* @since 3.33.0
* @since 4.2.0 The `$enrollment_trigger` parameter was added.
*
* @param int $user_id WP User ID.
* @param int $product_id WP Post ID of the course or membership.
* @param string $enrollment_trigger The enrollment trigger.
*/
do_action( 'llms_user_enrollment_deleted', $this->get_id(), $product_id, $enrollment_trigger );
// Success.
return true;
}
// Nothing was deleted.
return false;
}
/**
* Update the completion status of a track, course, section, or lesson for the current student
*
* Cascades up to parents and clears progress caches for parents.
*
* Triggers actions for completion/incompletion.
*
* Inserts / updates necessary user postmeta data.
*
* @since 3.17.0
* @since 4.2.0 Use filterable functions to determine if the object is completable.
* Added filter to allow customization of object parent data.
*
* @param string $status New status to update to, either "complete" or "incomplete".
* @param int $object_id WP_Post ID of the object.
* @param string $object_type The type of object. A lesson, section, course, or course_track.
* @param string $trigger String describing the reason for the status change.
* @return bool
*/
private function update_completion_status( $status, $object_id, $object_type, $trigger = 'unspecified' ) {
$student_id = $this->get_id();
/**
* Fires before a student's object completion status is updated.
*
* The dynamic portion of this hook, `$status`, refers to the new completion status of the object,
* either "complete" or "incomplete"
*
* @since Unknown
*
* @param int $student_id WP_User ID of the student.
* @param int $object_id WP_Post ID of the object.
* @param string $object_type The type of object. A lesson, section, course, or course_track.
* @param string $trigger String describing the reason for the status change.
*/
do_action( "before_llms_mark_{$status}", $student_id, $object_id, $object_type, $trigger );
// Retrieve an instance of the objec we're acting on.
if ( in_array( $object_type, llms_get_completable_post_types(), true ) ) {
$object = llms_get_post( $object_id );
} elseif ( in_array( $object_type, llms_get_completable_taxonomies(), true ) ) {
$object = get_term( $object_id, $object_type );
} else {
return false;
}
/**
* Lessons have binary completion (complete or incomplete).
*
* Other objects are dependent on their children's statuses. These other object types
* must check the combined progress of their children to see if it's complete / incomplete.
*/
$complete = ( 'lesson' === $object_type ) ? ( 'complete' === $status ) : ( 100 == $this->get_progress( $object_id, $object_type, false ) );
// Get parent information.
$parent_data = array(
'ids' => array(),
'type' => false,
);
// Get the immediate parent so we can cascade up and maybe update the parent's status.
switch ( $object_type ) {
case 'lesson':
$parent_data['ids'] = array( $object->get( 'parent_section' ) );
$parent_data['type'] = 'section';
break;
case 'section':
$parent_data['ids'] = array( $object->get( 'parent_course' ) );
$parent_data['type'] = 'course';
break;
case 'course':
$parent_data['ids'] = wp_list_pluck( $object->get_tracks(), 'term_id' );
$parent_data['type'] = 'course_track';
break;
}
/**
* Filter the parent data used to cascade object completion up to an object's parent(s).
*
* @since 4.2.0
*
* @param array $parent_data {
* Array of the object's parent information.
*
* @type int[] $ids Object ids for the parent object(s).
* @type string $type Object type (course, course_track, etc...).
* }
* @param object $object The object. An `LLMS_Course`, for example.
* @param int $ojbect_id The object's ID.
* @param string $object_type The object's type.
*/
$parent_data = apply_filters( 'llms_mark_complete_parent_data', $parent_data, $object, $object_id, $object_type );
// Reset the cached progress for any objects with children.
if ( 'lesson' !== $object_type ) {
$this->set( sprintf( '%1$s_%2$d_progress', $object_type, $object_id ), '' );
}
// Reset cache for all parents.
if ( $parent_data['ids'] && $parent_data['type'] ) {
foreach ( $parent_data['ids'] as $pid ) {
$this->set( sprintf( '%1$s_%2$d_progress', $parent_data['type'], $pid ), '' );
}
}
// Determine if an update should be made.
$update = ( 'complete' === $status && $complete ) || ( 'incomplete' === $status && ! $complete );
if ( $update ) {
// Insert meta data.
if ( 'complete' === $status ) {
$this->insert_completion_postmeta( $object_id, $trigger );
} elseif ( 'incomplete' === $status ) {
$this->insert_incompletion_postmeta( $object_id, $trigger );
}
/**
* Hook that fires when a student's completion status is updated for any object.
*
* The dynamic portion of this hook, `$status`, refers to the new completion status of the object,
* either "complete" or "incomplete"
*
* @since Unknown
*
* @param int $student_id WP_User ID of the student.
* @param int $object_id WP_Post ID of the object.
* @param string $object_type The type of object. A lesson, section, course, or course_track.
* @param string $trigger String describing the reason for the status change.
*/
do_action( "llms_mark_{$status}", $student_id, $object_id, $object_type, $trigger );
/**
* Hook that fires when a student's completion status is updated for a specific object type.
*
* The dynamic portion of this hook, `$object_type` refers to the WP_Post post_type of the object
* which the student's completion status is being updated for.
*
* The dynamic portion of this hook, `$status`, refers to the new completion status of the object,
* either "complete" or "incomplete"
*
* @since Unknown
*
* @param int $student_id WP_User ID of the student.
* @param int $object_id WP_Post ID of the object.
*/
do_action( "lifterlms_{$object_type}_{$status}d", $student_id, $object_id );
// Cascade up for parents.
if ( $parent_data['ids'] && $parent_data['type'] ) {
foreach ( $parent_data['ids'] as $pid ) {
$this->update_completion_status( $status, $pid, $parent_data['type'], $trigger );
}
}
/**
* Hook that fires after a student's completion status for an object and it's parents have
* been updated.
*
* The dynamic portion of this hook, `$status`, refers to the new completion status of the object,
* either "complete" or "incomplete"
*
* @since Unknown
*
* @param int $student_id WP_User ID of the student.
* @param int $object_id WP_Post ID of the object.
* @param string $object_type The type of object. A lesson, section, course, or course_track.
* @param string $trigger String describing the reason for the status change.
*/
do_action( "after_llms_mark_{$status}", $student_id, $object_id, $object_type, $trigger );
}
return $update;
}
/**
* Determine if the student has favorited a lesson.
*
* @since 7.5.0
*
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @param string $object_type The object type, currently only 'lesson'.
* @return bool
*/
public function is_favorite( $object_id, $object_type = 'lesson' ) {
$query = new LLMS_Query_User_Postmeta(
array(
'types' => 'favorites',
'include_post_children' => false,
'user_id' => $this->get_id(),
'post_id' => $object_id,
'per_page' => 1,
'no_found_rows' => true,
)
);
$ret = $query->has_results();
/**
* Filter object favorite boolean value prior to returning.
*
* The dynamic portion of this filter, `{$object_type}`, refers to the Lesson.
*
* @since 7.5.0
*
* @param array|false $ret Array of favorite data or `false` if no favorite is found.
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @param string $object_type The object type, currently only 'lesson'.
* @param LLMS_Student $instance The Student Instance
*/
return apply_filters( 'llms_is_' . $object_type . '_favorite', $ret, $object_id, $object_type, $this );
}
/**
* Mark a lesson favorite for the given user.
*
* @since 7.5.0
*
* @see llms_mark_favorite() calls this function without having to instantiate the LLMS_Student class first.
*
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @param string $object_type The object type, currently only 'lesson'.
* @return bool
*/
public function mark_favorite( $object_id, $object_type ) {
// Short circuit if it's already favorited.
if ( $this->is_favorite( $object_id, $object_type ) ) {
return true;
}
return $this->update_favorite_status( 'favorite', $object_id, $object_type );
}
/**
* Mark a lesson unfavorite for the given user.
*
* @since 7.5.0
*
* @see llms_mark_unfavorite() calls this function without having to instantiate the LLMS_Student class first.
*
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @param string $object_type The object type, currently only 'lesson'.
* @return bool
*/
public function mark_unfavorite( $object_id, $object_type ) {
// Short circuit if it's not favorited.
if ( ! $this->is_favorite( $object_id, $object_type ) ) {
return true;
}
return $this->update_favorite_status( 'unfavorite', $object_id, $object_type );
}
/**
* Triggers actions for favorite/unfavorite.
*
* Update the favorite status of a lesson for the current student.
* Inserts / updates necessary user postmeta data.
*
* @since 7.5.0 Use filterable functions to determine if the object can be marked favorite.
*
* @param string $status New status to update to, either "favorite" or "unfavorite".
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @param string $object_type The object type, currently only 'lesson'.
* @return bool
*/
private function update_favorite_status( $status, $object_id, $object_type ) {
$student_id = $this->get_id();
/**
* Fires before a student's object favorite status is updated.
*
* The dynamic portion of this hook, `$status`, refers to the new completion status of the object,
* either "favorite" or "unfavorite".
*
* @since 7.5.0
*
* @param int $student_id WP_User ID of the student.
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @param string $object_type The object type, currently only 'lesson'.
*/
do_action( "before_llms_mark_{$status}", $student_id, $object_id, $object_type );
// Insert / Remove meta data.
if ( 'favorite' === $status ) {
$this->insert_favorite_postmeta( $object_id );
} elseif ( 'unfavorite' === $status ) {
$this->remove_favorite_postmeta( $object_id );
}
/**
* Hook that fires when a student's favorite status is updated for any object.
*
* The dynamic portion of this hook, `$status`, refers to the new favorite status of the object,
* either "favorite" or "unfavorite".
*
* @since 7.5.0
*
* @param int $student_id WP_User ID of the student.
* @param int $object_id WP Post ID of the object to mark/unmark as favorite.
* @param string $object_type The object type, currently only 'lesson'.
*/
do_action( "llms_mark_{$status}", $student_id, $object_id, $object_type );
/**
* Hook that fires when a student's favorite status is updated for a specific object type.
*
* The dynamic portion of this hook, `$object_type` refers to the WP_Post post_type of the object
* which the student's completion status is being updated for.
*
* The dynamic portion of this hook, `$status`, refers to the new completion status of the object,
* either "favorite" or "unfavorite".
*
* @since 7.5.0
*
* @param int $student_id WP_User ID of the student.
* @param int $object_id WP_Post ID of the object.
*/
do_action( "lifterlms_{$object_type}_{$status}d", $student_id, $object_id );
return true;
}
}
================================================
FILE: includes/models/model.llms.student.quizzes.php
================================================
<?php
/**
* LLMS_Student_Quizzes model class file
*
* @package LifterLMS/Models/Classes
*
* @since 3.9.0
* @version 6.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Access student quiz attempt data
*
* @see LLMS_Student->quizzes()
*
* @since 3.9.0
*/
class LLMS_Student_Quizzes extends LLMS_Abstract_User_Data {
/**
* Retrieve the number of quiz attempts for a quiz
*
* @since 3.16.0
* @since 6.0.0 Don't access `LLMS_Query_Quiz_Attempt` properties directly.
*
* @param int $quiz_id WP Post ID of the quiz.
* @return int
*/
public function count_attempts_by_quiz( $quiz_id ) {
$query = new LLMS_Query_Quiz_Attempt(
array(
'student_id' => $this->get_id(),
'quiz_id' => $quiz_id,
'count_only' => true,
)
);
return $query->get_count_only_result();
}
/**
* Remove Student Quiz attempt by ID
*
* @since 3.9.0
* @since 3.16.11 Unknown.
*
* @param int $attempt_id Attempt ID.
* @return boolean Returns `true` on success and `false` on error.
*/
public function delete_attempt( $attempt_id ) {
$attempt = $this->get_attempt_by_id( $attempt_id );
return $attempt ? $attempt->delete() : false;
}
/**
* Retrieve quiz data for a student and optionally filter by quiz_id(s)
*
* @since 3.9.0
* @since 3.16.11 Unknown.
* @since 4.21.2 Retrieve only attempts for the initialized student.
*
* @param int[]|Int $quiz Array or single WP_Post ID for quizzes to retrieve attempts for.
* @return LLMS_Quiz_Attempt[] Array of quiz attempts for the requested quiz or quizzes.
*/
public function get_all( $quiz = array() ) {
$query = new LLMS_Query_Quiz_Attempt(
array(
'quiz_id' => $quiz,
'per_page' => 5000,
'student_id' => $this->get( 'id' ),
)
);
/**
* Filters the list of quiz attempts for a student
*
* @since Unknown
*
* @param int[]|Int $quiz Array or single WP_Post ID for quizzes to retrieve attempts for.
*/
return apply_filters( 'llms_student_get_quiz_data', $query->get_attempts(), $quiz );
}
/**
* Retrieve quiz attempts
*
* @since 3.16.0
*
* @param int $quiz_id WP Post ID of the quiz.
* @param array $args Additional args to pass to LLMS_Query_Quiz_Attempt.
* @return LLMS_Quiz_Attempt[]
*/
public function get_attempts_by_quiz( $quiz_id, $args = array() ) {
$args = wp_parse_args(
array(
'student_id' => $this->get_id(),
'quiz_id' => $quiz_id,
),
$args
);
$query = new LLMS_Query_Quiz_Attempt( $args );
if ( $query->has_results() ) {
return $query->get_attempts();
}
return array();
}
/**
* Retrieve an attempt by attempt id
*
* @since 3.16.0
* @since 4.21.2 Return `false` for invalid IDs & check permissions before returning the attempt.
*
* @param int $attempt_id Attempt ID.
* @return LLMS_Quiz_Attempt|boolean Returns the quiz attempt or `false` if the attempt doesn't exist or
* doesn't belong to the initialized student.
*/
public function get_attempt_by_id( $attempt_id ) {
$attempt = new LLMS_Quiz_Attempt( $attempt_id );
// Invalid ID.
if ( ! $attempt->exists() || ! current_user_can( 'view_grades', absint( $attempt->get( 'student_id' ) ), absint( $attempt->get( 'quiz_id' ) ) ) ) {
return false;
}
return $attempt;
}
/**
* Decodes an attempt string and returns the associated attempt
*
* @since 3.9.0
* @since 3.16.0 Unknown.
*
* @param string $attempt_key Encoded attempt key.
* @return LLMS_Quiz_Attempt|false
*/
public function get_attempt_by_key( $attempt_key ) {
$id = $this->parse_attempt_key( $attempt_key );
if ( ! $id ) {
return false;
}
return $this->get_attempt_by_id( $id );
}
/**
* Get the number of attempts remaining by a student for a given quiz.
*
* @since 3.16.0
* @since 6.4.0 Added parameter `$allow_negative` to allow remaining negative remaining attempts.
* It can happen when the allowed attempts number is decreased to a number lower than
* the number of the attempts already made by a given student.
*
* @param int $quiz_id WP Post ID of the Quiz.
* @param bool $allow_negative Allow returning negative remaining attempts.
* @return mixed
*/
public function get_attempts_remaining_for_quiz( $quiz_id, $allow_negative = false ) {
$quiz = llms_get_post( $quiz_id );
$ret = _x( 'Unlimited', 'quiz attempts remaining', 'lifterlms' );
if ( $quiz->has_attempt_limit() ) {
$allowed = $quiz->get( 'allowed_attempts' );
$used = $this->count_attempts_by_quiz( $quiz->get( 'id' ) );
// Ensure undefined, null, '', etc. show as an int.
if ( ! $allowed ) {
$allowed = 0;
}
$remaining = ( $allowed - $used );
// Don't show negative attempts.
$ret = $allow_negative ? $remaining : max( 0, $remaining );
}
/**
* Filters the number of attempts remaining by a student for a given quiz.
*
* @since 3.16.0
*
* @param mixed $ret The number of attempts remaining by a student for a given quiz,
* or 'Unlimited' for quizzes with no attempts limit.
* @param LLMS_Quiz $quiz Quiz object.
* @param LLMS_Student_Quizzes $student_quizzes Student quizzes object.
*/
return apply_filters( 'llms_student_quiz_attempts_remaining_for_quiz', $ret, $quiz, $this );
}
/**
* Get all the attempts for a given quiz/lesson from an attempt key
*
* @since 3.9.0
*
* @param string $attempt_key An encoded attempt key.
* @return false|array
*/
public function get_sibling_attempts_by_key( $attempt_key ) {
$id = $this->parse_attempt_key( $attempt_key );
if ( ! $id ) {
return false;
}
}
/**
* Get the quiz attempt with the highest grade for a given quiz and lesson combination
*
* @since 3.9.0
* @since 3.16.0 Unknown.
*
* @param int $quiz_id WP Post ID of a Quiz.
* @param null $deprecated Deprecated.
* @return false|LLMS_Quiz_Attempt
*/
public function get_best_attempt( $quiz_id = null, $deprecated = null ) {
$attempts = $this->get_attempts_by_quiz(
$quiz_id,
array(
'per_page' => 1,
'sort' => array(
'grade' => 'DESC',
'update_date' => 'DESC',
'id' => 'DESC',
),
'status' => array( 'pass', 'fail' ),
)
);
if ( $attempts ) {
return $attempts[0];
}
return false;
}
/**
* Retrieve the last recorded attempt for a student for a given quiz/lesson
*
* "Last" is defined as the attempt with the highest attempt number
*
* @since 3.9.0
* @since 3.16.0 Unknown.
*
* @param int $quiz_id WP Post ID of the quiz.
* @return LLMS_Quiz_Attempt|false
*/
public function get_last_attempt( $quiz_id ) {
$attempts = $this->get_attempts_by_quiz(
$quiz_id,
array(
'per_page' => 1,
'sort' => array(
'attempt' => 'DESC',
),
)
);
if ( $attempts ) {
return $attempts[0];
}
return false;
}
/**
* Get the last completed attempt for a given quiz or quiz/lesson combination
*
* @since 3.9.0
* @since 3.16.0 Unknown.
*
* @param int $quiz_id WP Post ID of a Quiz.
* @param int $deprecated Deprecated.
* @return false|LLMS_Quiz_Attempt
*/
public function get_last_completed_attempt( $quiz_id = null, $deprecated = null ) {
$query = new LLMS_Query_Quiz_Attempt(
array(
'student_id' => $this->get_id(),
'quiz_id' => $quiz_id,
'per_page' => 1,
'status_exclude' => array( 'incomplete' ),
'sort' => array(
'end_date' => 'DESC',
'id' => 'DESC',
),
)
);
if ( $query->has_results() ) {
return $query->get_attempts()[0];
}
return false;
}
/**
* Parse an attempt key into it's parts
*
* @since 3.9.0
* @since 3.16.7 Unknown.
*
* @param string $attempt_key An encoded attempt key.
* @return int
*/
private function parse_attempt_key( $attempt_key ) {
return LLMS_Hasher::unhash( $attempt_key );
}
}
================================================
FILE: includes/models/model.llms.transaction.php
================================================
<?php
/**
* LLMS_Transaction model class file
*
* @package LifterLMS/Models/Classes
*
* @since 3.0.0
* @version 7.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS order transactions
*
* @since 3.0.0
*
* @property string $api_mode API Mode of the gateway when the transaction was made [test|live].
* @property float $amount Transaction charge amount.
* @property string $currency Transaction's currency code.
* @property string $gateway_completed_date Datetime string when the transaction was completed by the gateway (if gateway supports).
* @property string $gateway_customer_id Gateway's unique ID for the customer who placed the order.
* @property float $gateway_fee_amount Fee charged to the user by the gateway for the transaction (if gateway supports).
* @property string $gateway_source_id Source Identifier from the gateway -- eg: credit card id or account id.
* @property string $gateway_source_description Short description of the source from the gateway. EG: Visa 1234.
* @property string $gateway_transaction_id Gateway's unique ID for the transaction.
* @property int $order_id ID of the related LLMS_Order.
* @property string $payment_type Type of payment. [recurring|single|trial].
* @property string $payment_gateway LifterLMS Payment Gateway ID (eg "paypal" or "stripe").
* @property float $refund_amount Amount refunded, will always be 0 until a refund is actually recorded.
* @property array $refund_data Array of arrays. Contains refund data for each refund recorded for this transaction.
*/
class LLMS_Transaction extends LLMS_Post_Model {
/**
* DB Post Type.
*
* @var string
*/
protected $db_post_type = 'llms_transaction';
/**
* Model Name/Type.
*
* @var string
*/
protected $model_post_type = 'transaction';
/**
* Post model properties.
*
* @var array
*/
protected $properties = array(
'api_mode' => 'text',
'amount' => 'float',
'currency' => 'text',
'gateway_completed_date' => 'text',
'gateway_customer_id' => 'text',
'gateway_fee_amount' => 'float',
'gateway_source_id' => 'text',
'gateway_source_description' => 'text',
'gateway_transaction_id' => 'text',
'order_id' => 'absint',
'payment_type' => 'text',
'payment_gateway' => 'text',
'refund_amount' => 'float',
'refund_data' => 'array',
);
/**
* Determines if the transaction can be refunded.
*
* Status must not be "failed" and total refunded amount must be less than order amount.
*
* @since 3.0.0
* @since 7.0.0 Made the return value filterable via the `llms_transaction_can_be_refunded` hook.
*
* @return boolean
*/
public function can_be_refunded() {
$can_be_refunded = true;
if ( in_array( $this->get( 'status' ), array( 'llms-txn-failed', 'llms-txn-pending' ), true ) ) {
$can_be_refunded = false;
} elseif ( $this->get_refundable_amount( array(), 'float' ) <= 0 ) {
$can_be_refunded = false;
}
/**
* Filters whether or not a transaction can be refunded.
*
* @since 7.0.0
*
* @param boolean $can_be_refunded Whether the transaction can be refunded.
* @param LLMS_Transaction $transaction The transaction object.
*/
return apply_filters( 'llms_transaction_can_be_refunded', $can_be_refunded, $this );
}
/**
* Generates a refund ID based on the refund method.
*
* When manually processing a refund an ID is generated, if processing via a gateway the data
* is passed to the {@see LLMS_Transaction::process_refund_via_gateway()} and ultimately passed
* to the gateway for processing (via the gateway's API). For custom methods processing is handled
* via the `llms_{$method}_refund_id` filter.
*
* @since 7.0.0
*
* @param string $method Refund processing method ID.
* @param float $amount The amount to refund.
* @param string $note Refund notes.
* @return string|boolean|WP_Error Returns the generated refund ID string or an error object. If a falsy value
* is returned the refund processing will fail with a generic error message.
*/
protected function generate_refund_id( $method, $amount, $note = '' ) {
if ( 'manual' === $method ) {
/**
* Filters the refund id for manual refunds.
*
* The default refund ID is a microtime string generated by `uniqid()`.
*
* @since 3.0.0
*
* @param string $refund_id The refund ID.
*/
$refund_id = apply_filters( 'llms_manual_refund_id', (string) uniqid() );
} elseif ( 'gateway' === $method ) {
$refund_id = $this->process_refund_via_gateway( $amount, $note );
} else {
/**
* Filters the refund ID for custom refund methods.
*
* This filter should return a string representing the refund ID as generated by the custom refund method.
*
* The dynamic portion of this hook, `{$method}`, represents the ID of the custom refund method.
*
* @since 3.0.0
*
* @param string|boolean|WP_Error $refund_id The generated refund ID or an error object. Returning a falsy value
* will result in the default error handling and no refund being recorded.
* @param string $method The method ID.
* @param LLMS_Transaction $transaction The transaction object.
* @param float $amount The refund amount.
* @param string $note The user-submitted refund note.
*/
$refund_id = apply_filters( "llms_{$method}_refund_id", false, $method, $this, $amount, $note );
}
return $refund_id;
}
/**
* Retrieves the amount of the transaction that can be refunded.
*
* @since 3.0.0
* @return float
*/
public function get_refundable_amount() {
$amount = $this->get_price( 'amount', array(), 'float' );
$refunded = $this->get_price( 'refund_amount', array(), 'float' );
return $amount - $refunded;
}
/**
* Retrieves the array of default arguments to pass to {@see LLMS_Transaction::create()} when creating a new post.
*
* @since 3.0.0
* @since 3.37.6 Add a default date information using `llms_current_time()`.
* Remove ordering placeholders from strftime().
* @since 5.9.0 Remove usage of deprecated `strftime()`.
*
* @param int $order_id LLMS_Order ID of the related order.
* @return array
*/
protected function get_creation_args( $order_id = 0 ) {
$date = llms_current_time( 'mysql' );
$title = sprintf(
// Translators: %1$d = Order ID; %2$s = Transaction creation date.
__( 'Transaction for Order #%1$d – %2$s', 'lifterlms' ),
$order_id,
date_format( date_create( $date ), 'M d, Y @ h:i A' )
);
// This filter is documented in includes/abstracts/abstract.llms.post.model.php.
return apply_filters(
"llms_{$this->model_post_type}_get_creation_args",
array(
'comment_status' => 'closed',
'ping_status' => 'closed',
'post_author' => 0,
'post_content' => '',
'post_date' => $date,
'post_excerpt' => '',
'post_password' => uniqid( 'order_' ),
'post_status' => 'llms-' . apply_filters( 'llms_default_order_status', 'txn-pending' ),
'post_title' => $title,
'post_type' => $this->get( 'db_post_type' ),
),
$this
);
}
/**
* Get the total amount of the transaction after deducting refunds
*
* @param array $price_args optional array of arguments that can be passed to llms_price()
* @param string $format optional format conversion method [html|raw|float]
* @return mixed
* @since 3.0.0
*/
public function get_net_amount( $price_args = array(), $format = 'html' ) {
$amount = $this->get_price( 'amount', array(), 'float' );
$refund = $this->get_price( 'refund_amount', array(), 'float' );
return llms_price( $amount - $refund, $price_args, $format );
}
/**
* Retrieves an instance of LLMS_Order for the transaction's parent order.
*
* @since 3.0.0
*
* @return LLMS_Order
*/
public function get_order() {
return new LLMS_Order( $this->get( 'order_id' ) );
}
/**
* Retrieves the payment gateway instance for the transactions payment gateway.
*
* @since 3.0.0
*
* @return LLMS_Payment_Gateway|WP_Error
*/
public function get_gateway() {
$gateways = llms()->payment_gateways();
$gateway = $gateways->get_gateway_by_id( $this->get( 'payment_gateway' ) );
if ( $gateway && $gateway->is_enabled() || is_admin() ) {
return $gateway;
}
// Translators: %s = The payment gateway ID.
return new WP_Error(
'error',
sprintf(
__( 'Payment gateway %s could not be located or is no longer enabled', 'lifterlms' ),
$this->get( 'payment_gateway' )
)
);
}
/**
* Retrieves the title of the refund method using during refund processing.
*
* This method records the method used to process a refund in the refund order note.
*
* @since 7.0.0
*
* @param string $method The refund method ID.
* @return string
*/
protected function get_refund_method_title( $method ) {
switch ( $method ) {
case 'manual':
$method_title = __( 'manual refund', 'lifterlms' );
break;
case 'gateway':
$method_title = $this->get_gateway()->get_admin_title();
break;
default:
/**
* Filters the refund method title for custom refund methods.
*
* The dynamic portion of this hook, `{$method}`, represents the ID of the custom refund method.
*
* @since 3.0.0
* @deprecated 7.0.0 Replaced with `llms_{$method}_refund_title`.
*
* @param string $method The method ID.
*/
$method_title = apply_filters_deprecated( "llms_{$method}_title", array( $method ), '7.0.0', "llms_{$method}_refund_title" );
if ( $method_title !== $method ) {
return $method_title;
}
/**
* Filters the refund method title for custom refund methods.
*
* The dynamic portion of this hook, `{$method}`, represents the ID of the custom refund method.
*
* @since Unknown
*
* @param string $method The method ID.
* @param LLMS_Transaction $transaction The transaction object.
*/
$method_title = apply_filters( "llms_{$method}_refund_title", $method, $this );
}
return $method_title;
}
/**
* Retrieves a single refund by ID.
*
* @since 7.0.0
*
* @param string $id The refund ID.
* @return array|boolean {
* An array of refund data. Returns `false` if the ID isn't found.
*
* @type string id The refund ID
* @type string date The date the refund was recorded in MySQL date format `Y-m-d H:i:s`.
* @type string method The processing method ID. Defaults are "manual" or "gateway". Custom values can be implemented via hooks.
* @type float amount The amount of the refund.
* }
*/
public function get_refund( $id ) {
$refunds = $this->get_refunds();
return $refunds[ $id ] ?? false;
}
/**
* Retrieves a list of refunds against the transaction.
*
* @since 7.0.0
*
* @return array[] An array of refund arrays as described by {@see LLMS_Transaction::get_refund()}.
*/
public function get_refunds() {
return $this->get_array( 'refund_data' );
}
/**
* Processes a refund against the transaction.
*
* This method is called called from the admin panel by clicking a refund (manual or gateway) button.
*
* @since 3.0.0
* @since 7.0.0 Refactored code into multiple methods.
*
* @see LLMS_Meta_Box_Order_Transactions::save_refund()
*
* @param float $amount Amount to refund.
* @param string $note Optional note to record as an order note. This is passed to the gateway to do store in the gateway if available.
* @param string $method Method used to refund, either "manual" (available for all transactions) or "gateway" (when supported by the gateway that processed the transaction).
* @return string|WP_Error A refund ID on success or an error object.
*/
public function process_refund( $amount, $note = '', $method = 'manual' ) {
// Ensure the transaction is still eligible for a refund.
if ( ! $this->can_be_refunded() ) {
return new WP_Error(
'llms-txn-refund-not-eligible',
__( 'The selected transaction is not eligible for a refund.', 'lifterlms' )
);
}
$amount = floatval( $amount );
// Ensure we can refund the requested amount.
$refundable = $this->get_refundable_amount();
if ( $amount > $refundable ) {
return new WP_Error(
'llms-txn-refund-amount-too-high',
sprintf(
// Translators: %1$s = The requested refund amount; %2$s = the available refundable amount.
__( 'Requested refund amount was %1$s, the maximum possible refund for this transaction is %2$s.', 'lifterlms' ),
llms_price( $amount ),
llms_price( $refundable )
)
);
}
$id = $this->generate_refund_id( $method, $amount, $note );
if ( is_string( $id ) ) {
$this->record_refund( compact( 'amount', 'id', 'method' ), $note );
} elseif ( ! is_wp_error( $id ) ) {
$id = new WP_Error( 'llms-txn-refund-unknown-error', __( 'An unknown error occurred while processing the refund.', 'lifterlms' ) );
}
return $id;
}
/**
* Processes a refund via the gateway that processed the transaction.
*
* @since 7.0.0
*
* @param float $amount The refund amount.
* @param string $note Refund order note.
* @return string|WP_Error The refund ID or an error object.
*/
protected function process_refund_via_gateway( $amount, $note = '' ) {
$gateway = $this->get_gateway();
if ( is_wp_error( $gateway ) ) {
return new WP_Error(
'llms-txn-refund-gateway-invalid',
sprintf(
// Translators: %s = the payment gateway ID.
__( 'Selected gateway "%s" is inactive or invalid.', 'lifterlms' ),
$this->get( 'payment_gateway' )
)
);
}
if ( ! $gateway->supports( 'refunds' ) ) {
return new WP_Error(
'llms-txn-refund-gateway-support',
sprintf(
// Translators: %s = the payment gateway admin title.
__( 'Selected gateway "%s" does not support refunds.', 'lifterlms' ),
$gateway->get_admin_title()
)
);
}
return $gateway->process_refund( $this, $amount, $note );
}
/**
* Records a refund against the transaction.
*
* This method performs no validations and assumes that the refund has already been verified against
* the refund method and current transaction restrictions.
*
* If the refund data isn't validated, try using {@see LLMS_Transaction::process_refund()} instead.
*
* @since 7.0.0
*
* @param array $refund {
* Refund arguments.
*
* @type float $amount The refund amount.
* @type string $id The generated refund ID.
* @type string $method The refund processing method ID.
* @type string $date The refund date in MySQL date format. If not supplied, the current time is used.
* }
* @param string $note User-submitted refund note to add to the order alongside the refund.
* @return void
*/
public function record_refund( $refund, $note = '' ) {
$refund = wp_parse_args(
$refund,
array(
'amount' => 0.00,
'id' => '',
'method' => '',
'date' => llms_current_time( 'mysql' ),
)
);
// Record the note.
$this->record_refund_note( $note, $refund['amount'], $refund['id'], $refund['method'] );
// Update the refunded amount.
$refund_amount = $this->get( 'refund_amount' );
$new_amount = ! $refund_amount ? $refund['amount'] : $refund_amount + $refund['amount'];
$this->set( 'refund_amount', $new_amount );
// Record refund metadata.
$refund_data = $this->get_refunds();
/**
* Filters the stored refund data before saving it.
*
* @since Unknown
*
* @param array $refund {
* An associative array of refund data.
*
* @type float $amount The refund amount.
* @type string $date The refund date in MySQL date format: `Y-m-d H:i:s`.
* @type string $id The refund ID.
* @type string $method The refund method ID.
* }
* @param LLMS_Transaction $transaction The transaction object.
* @param float $amount The refund amount.
* @param string $method The refund method ID
*/
$refund_data[ $refund['id'] ] = apply_filters( 'llms_transaction_refund_data', $refund, $this, $refund['amount'], $refund['method'] );
$this->set( 'refund_data', $refund_data );
// Update status.
$this->set( 'status', 'llms-txn-refunded' );
}
/**
* Records an order note associated with a refund.
*
* @since 7.0.0
*
* @param string $note User-submitted refund note data to add to the order alongside the refund.
* @param float $amount The refund amount.
* @param string $refund_id The generated refund ID.
* @param string $method The refund processing method ID.
* @return int The WP_Comment ID of the recorded order note.
*/
private function record_refund_note( $note, $amount, $refund_id, $method ) {
/**
* Filters user-submitted transaction refund order note.
*
* @since Unknown.
*
* @param string $note The user-submitted order note text.
* @param LLMS_Transaction $transaction The transaction object.
* @param float $amount The refund amount.
* @param string $method The ID of the refund method.
*/
$orig_note = apply_filters( 'llms_transaction_refund_note', $note, $this, $amount, $method );
$note = sprintf(
// Translators: %1$s = The refund amount; %2$d the transaction ID; %3$s The refund method name; %4$s = the refund ID.
__( 'Refunded %1$s for transaction #%2$d via %3$s [Refund ID: %4$s]', 'lifterlms' ),
wp_strip_all_tags( llms_price( $amount ) ),
$this->get( 'id' ),
$this->get_refund_method_title( $method ),
$refund_id
);
if ( $orig_note ) {
$note .= "\r\n";
$note .= __( 'Refund Notes: ', 'lifterlms' );
$note .= "\r\n";
$note .= $orig_note;
}
// Record the note.
return $this->get_order()->add_note( $note, true );
}
/**
* Translation wrapper for {@see LLMS_Transaction::get()` which enables l10n of database values.
*
* @since 3.0.0
*
* @param string $key Key to retrieve.
* @return string
*/
public function translate( $key ) {
$val = $this->get( $key );
switch ( $key ) {
case 'payment_type':
if ( 'single' === $val ) {
$val = __( 'Single', 'lifterlms' );
} elseif ( 'recurring' === $val ) {
$val = __( 'Recurring', 'lifterlms' );
} elseif ( 'trial' === $val ) {
$val = __( 'Trial', 'lifterlms' );
}
break;
default:
$val = $val;
}
return $val;
}
}
================================================
FILE: includes/models/model.llms.user.achievement.php
================================================
<?php
/**
* LLMS_User_Achievement model
*
* @package LifterLMS/Models/Classes
*
* @since 3.8.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* An achievement awarded to a student.
*
* @since 3.8.0
* @since 6.0.0 Utilize `LLMS_Abstract_User_Engagement` abstract.
*
* @property int $author WP_User ID of the user who the achievement belongs to.
* @property string $awarded MySQL timestamp recorded when the achievement was first awarded.
* @property string $content The achievement content.
* @property int $engagement WP_Post ID of the `llms_engagement` post used to trigger the achievement.
* An empty value or `0` indicates the achievement was awarded manually or
* before the engagement value was stored.
* @property int $parent WP_Post ID of the template `llms_achievement` post.
* @property int $related WP_Post ID of the related post.
* @property string $title Achievement title.
*/
class LLMS_User_Achievement extends LLMS_Abstract_User_Engagement {
/**
* Database (WP) post type name
*
* @var string
*/
protected $db_post_type = 'llms_my_achievement';
/**
* Post type model name
*
* @var string
*/
protected $model_post_type = 'achievement';
/**
* Object properties
*
* @var array
*/
protected $properties = array(
'awarded' => 'string',
'engagement' => 'absint',
'related' => 'absint',
);
/**
* Retrieve the image source for the achievement.
*
* @since 3.14.0
* @since 6.0.0 Set a default size when an empty array is passed and use global default image when possible.
*
* @param int[] $size Dimensions of the image to return passed as [ width, height ] (in pixels).
* @param null $unused Unused parameter inherited from the parent method.
* @return string Image source URL.
*/
public function get_image( $size = array(), $unused = null ) {
$id = $this->get( 'id' );
$img_id = get_post_thumbnail_id( $id );
$size = empty( $size ) ? array( 380, 380 ) : $size;
/**
* Filters the size used to retrieve an achievement image.
*
* @since 6.0.0
*
* @param int[] $size Dimensions of the image passed as [ width, height ] (in pixels).
*/
$size = apply_filters( 'llms_achievement_image_size', $size );
if ( ! $img_id ) {
$src = llms()->achievements()->get_default_image( $id );
} else {
list( $src ) = wp_get_attachment_image_src( $img_id, $size );
}
/**
* Filter the image source URL for the achievement.
*
* @since 6.0.0
*
* @param string $src Image source URL.
* @param LLMS_User_Achievement $achievement The achievement object.
* @param int[] $size Dimensions of the image to return passed as [ width, height ] (in pixels).
*/
return apply_filters( 'llms_achievement_get_image', $src, $this, $size );
}
/**
* Retrieve the HTML <img> for the achievement.
*
* @since 3.14.0
*
* @param array $size Dimensions of the image to return passed as [ width, height ] (in pixels).
* @return string
*/
public function get_image_html( $size = array() ) {
/**
* Filters the HTML used to display an achievement image.
*
* @since 3.14.0
* @since 6.0.0 Added `$size` parameter.
*
* @param string $html Image HTML.
* @param LLMS_User_Achievement $achievement The achievement object.
* @param int[] $size Dimensions of the image to return passed as [ width, height ] (in pixels).
*/
return apply_filters(
'llms_achievement_get_image_html',
sprintf(
'<img alt="%1$s" class="llms-achievement-img" src="%2$s">',
esc_attr( $this->get( 'title' ) ),
$this->get_image( $size )
),
$this,
$size
);
}
}
================================================
FILE: includes/models/model.llms.user.certificate.php
================================================
<?php
/**
* LLMS_User_Certificate model class
*
* @package LifterLMS/Models/Classes
*
* @since 3.8.0
* @version 6.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* A certificate awarded to a student.
*
* @since 3.8.0
* @since 6.0.0 Utilize `LLMS_Abstract_User_Engagement` abstract.
*
* @property string $allow_sharing Whether or not public certificate sharing is enabled for the certificate.
* Either "yes" or "no".
* @property string $awarded MySQL timestamp recorded when the certificate was first awarded.
* @property string $background The CSS background color for the certificate.
* @property int $author WP_User ID of the user who the certificate belongs to.
* @property string $content The merged certificate content.
* @property int $engagement WP_Post ID of the `llms_engagement` post used to trigger the certificate.
* An empty value or `0` indicates the certificate was awarded manually or
* before the engagement value was stored.
* @property float $height The certificate's height.
* @property float[] $margins The certificate's margins.
* @property string $orientation The certificate's orientation.
* @property int $parent WP_Post ID of the template `llms_certificate` post.
* @property int $related WP_Post ID of the related post.
* @property int $sequential_id The sequential certificate ID.
* @property string $size The certificate's registered size ID.
* @property string $title Certificate title.
* @property string $unit The certificate's registered unit ID.
* @property float $width The certificate's width.
*/
class LLMS_User_Certificate extends LLMS_Abstract_User_Engagement {
/**
* Database (WP) post type name
*
* @var string
*/
protected $db_post_type = 'llms_my_certificate';
/**
* Post type model name
*
* @var string
*/
protected $model_post_type = 'certificate';
/**
* Object properties
*
* @var array
*/
protected $properties = array(
'allow_sharing' => 'string',
'awarded' => 'string',
'background' => 'string',
'engagement' => 'absint',
'height' => 'float',
'margins' => 'array',
'orientation' => 'string',
'related' => 'absint',
'sequential_id' => 'absint',
'size' => 'string',
'unit' => 'string',
'width' => 'float',
);
/**
* Array of default property values.
*
* In the form of key => default value.
*
* @var array
*/
protected $property_defaults = array(
'background' => '#ffffff',
'orientation' => 'landscape',
'margins' => array( 5, 5, 5, 5 ),
'sequential_id' => 1,
);
/**
* Constructor.
*
* Overrides parent method to setup default properties that depend on other property values.
*
* @since 6.0.0
*
* @param string|int|LLMS_Post_Model|WP_Post $model Existing post or model object or ID
* @param array $args Args to create the post, only applies when $model is 'new'.
* @return void
*/
public function __construct( $model, $args = array() ) {
$this->set_property_defaults();
parent::__construct( $model, $args );
}
/**
* Set this awarded certificate sequential id based on the parent's meta.
*
* @since 6.0.0
*
* @return int|false Returns the awarded certificate sequenatial id.
* Returns false if the awarded certificate has no parent template.
*/
public function update_sequential_id() {
$parent = $this->get( 'parent' );
if ( ! $parent ) {
return false;
}
$next_sequential_id = llms_get_certificate_sequential_id( $parent, true );
$this->set( 'sequential_id', $next_sequential_id );
return $next_sequential_id;
}
/**
* Can user manage and make some actions on the certificate
*
* @since 4.5.0
* @since 6.0.0 Prevent logged out users from managing certificates not assigned to a user.
*
* @param int|null $user_id Optional. WP User ID (will use get_current_user_id() if none supplied). Default `null`.
* @return bool
*/
public function can_user_manage( $user_id = null ) {
$user_id = $user_id ? $user_id : get_current_user_id();
$result = ( $user_id && ( $user_id === $this->get_user_id() || llms_can_user_bypass_restrictions( $user_id ) ) );
/**
* Filter whether or not a user can manage a given certificate.
*
* @since 4.5.0
*
* @param boolean $result Whether or not the user can manage certificate.
* @param int $user_id WP_User ID of the user viewing the certificate.
* @param LLMS_User_Certificate $certificate Certificate class instance.
*/
return apply_filters( 'llms_certificate_can_user_manage', $result, $user_id, $this );
}
/**
* Can user view the certificate
*
* @since 4.5.0
*
* @param int|null $user_id Optional. WP User ID (will use get_current_user_id() if none supplied). Default `null`.
* @return bool
*/
public function can_user_view( $user_id = null ) {
$user_id = $user_id ? $user_id : get_current_user_id();
$result = $this->can_user_manage( $user_id ) || $this->is_sharing_enabled();
/**
* Filter whether or not a user can view a user's certificate.
*
* @since 4.5.0
*
* @param boolean $result Whether or not the user can view the certificate.
* @param int $user_id WP_User ID of the user viewing the certificate.
* @param LLMS_User_Certificate $certificate Certificate class instance.
*/
return apply_filters( 'llms_certificate_can_user_view', $result, $user_id, $this );
}
/**
* Retrieves the certificate background color value.
*
* @since 6.0.0
*
* @return string
*/
public function get_background() {
return $this->get( 'background' );
}
/**
* Retrieve information about the certificate background image.
*
* This function returns an array of information used for legacy certificates using the v1 template.
*
* When using the v2 template, only the `$src` value is utilized and the background image itself is
* always set to 100% width and height of certificate as defined by the certificate's sizing settings.
*
* @since 6.0.0
*
* @return array {
* Returns an associative array of information about the background image.
*
* @type string $src The image source url.
* @type int $width The image display width, in pixels.
* @type int $height The image display height, in pixels.
* @type bool $is_default Whether or not the default image was returned.
* }
*/
public function get_background_image() {
$id = $this->get( 'id' );
$img_id = get_post_thumbnail_id( $id );
$size = 'full';
if ( 1 === $this->get_template_version() ) {
$size = llms_parse_bool( get_option( 'lifterlms_certificate_legacy_image_size', 'yes' ) ) ? 'full' : 'lifterlms_certificate_background';
}
if ( ! $img_id ) {
// Get the source.
$src = llms()->certificates()->get_default_image( $id );
// Denote it's the default image in the return.
$is_default = true;
/**
* Filters the display height of the default certificate background image.
*
* This filter is used by legacy certificates only. If the certificate is utilizing
* the block editor the filtered value does not affect the size of the background image as
* the image is always set to fill the width and height of the certificate itself.
*
* @since 2.2.0
*
* @param int $height Display height of the image, in pixels.
* @param int $certificate_id WP_Post ID of the awarded certificate.
*/
$height = apply_filters( 'lifterlms_certificate_background_image_placeholder_height', 616, $id );
/**
* Filters the display width of the default certificate background image.
*
* This filter is used by legacy certificates only. If the certificate is utilizing
* the block editor the filtered value does not affect the size of the background image as
* the image is always set to fill the width and height of the certificate itself.
*
* @since 2.2.0
*
* @param int $width Display width of the image, in pixels.
* @param int $certificate_id WP_Post ID of the awarded certificate.
*/
$width = apply_filters( 'lifterlms_certificate_background_image_placeholder_width', 800, $id );
} else {
list( $src, $width, $height ) = wp_get_attachment_image_src( $img_id, $size );
// Denote it's not the default image in the return.
$is_default = false;
/**
* Filters the image source of the certificate background image.
*
* @since 2.2.0
*
* @param string $src The image source url.
* @param int $certificate_id WP_Post ID of the awarded certificate.
*/
$src = apply_filters( 'lifterlms_certificate_background_image_src', $src, $id );
/**
* Filters the display height of the certificate background image.
*
* This filter is used by legacy certificates only. If the certificate is utilizing
* the block editor the filtered value does not affect the size of the background image as
* the image is always set to fill the width and height of the certificate itself.
*
* @since 2.2.0
*
* @param int $height Display height of the image, in pixels.
* @param int $certificate_id WP_Post ID of the awarded certificate.
*/
$height = apply_filters( 'lifterlms_certificate_background_image_height', $height, $id );
/**
* Filters the display width of the certificate background image.
*
* This filter is used by legacy certificates only. If the certificate is utilizing
* the block editor the filtered value does not affect the size of the background image as
* the image is always set to fill the width and height of the certificate itself.
*
* @since 2.2.0
*
* @param int $width Display width of the image, in pixels.
* @param int $certificate_id WP_Post ID of the awarded certificate.
*/
$width = apply_filters( 'lifterlms_certificate_background_image_width', $width, $id );
}
return compact( 'src', 'width', 'height', 'is_default' );
}
/**
* Retrieves a list of the fonts used by the certificate.
*
* @since 6.0.0
*
* @see llms_get_certificate_fonts()
*
* @param array|null $blocks A list of parsed block arrays or null. If none supplied the certificate's
* content is parsed and used instead.
* @return array[] Array of fonts by the certificate. Each array is a font definition with the font's
* id added to the array.
*/
public function get_custom_fonts( $blocks = null ) {
$fonts = array();
$blocks = is_null( $blocks ) ? parse_blocks( $this->get( 'content', true ) ) : $blocks;
foreach ( $blocks as $block ) {
if ( ! empty( $block['attrs']['fontFamily'] ) ) {
$fonts[] = $block['attrs']['fontFamily'];
}
if ( ! empty( $block['innerBlocks'] ) ) {
$fonts = array_merge( $fonts, wp_list_pluck( $this->get_custom_fonts( $block['innerBlocks'] ), 'id' ) );
}
}
$valid_fonts = llms_get_certificate_fonts();
return array_filter(
array_map(
function( $font ) use ( $valid_fonts ) {
if ( 'default' === $font ) {
return null;
}
$ret = $valid_fonts[ $font ] ?? null;
if ( $ret ) {
$ret['id'] = $font;
}
return $ret;
},
array_unique( $fonts )
)
);
}
/**
* Retrieves the value for either the width or height.
*
* @since 6.0.0
*
* @param string $dimension Dimension key, either "width" or "height".
* @param boolean $with_unit Whether or not to include the unit in the return.
* @return string|float If `$with_unit` is `true`, returns a string with the unit, otherwise returns the dimension as a float.
*/
private function get_dimension( $dimension, $with_unit = false ) {
$ret = 0;
if ( 'CUSTOM' === $this->get_size() ) {
$ret = $this->get( $dimension );
} else {
$size_info = $this->get_registered_size_data();
$ret = $size_info[ $dimension ];
}
return $with_unit ? sprintf( '%1$s%2$s', $ret, $this->get_unit() ) : $ret;
}
/**
* Retrieve dimensions adjusted for orientation.
*
* The width and height are always stored as if the certificate were to be displayed in portrait
* mode. This method will return the dimensions as necessary to use in styling rules.
*
* When the certificate is displaying in landscape the width and height are transposed
* automatically by this method.
*
* @since 6.0.0
*
* @param bool $with_units Whether or not to include the unit in the return.
* @return array {
* Array of dimensions.
*
* @type string|float $width The display width.
* @type string|float $height The display height.
* }
*/
public function get_dimensions_for_display( $with_units = true ) {
$orientation = $this->get_orientation();
$width = $this->get_width( $with_units );
$height = $this->get_height( $with_units );
return array(
'width' => 'portrait' === $orientation ? $width : $height,
'height' => 'portrait' === $orientation ? $height : $width,
);
}
/**
* Retrieve the height dimension.
*
* @since 6.0.0
*
* @param boolean $with_unit Whether or not to include the unit in the return.
* @return string|float If `$with_unit` is `true`, returns a string with the unit, otherwise returns the height as a float.
*/
public function get_height( $with_unit = false ) {
return $this->get_dimension( 'height', $with_unit );
}
/**
* Retrieves the certificate's margins.
*
* @since 6.0.0
*
* @param boolean $with_units Whether or not to include the percent sign unit in the return.
* @return float[] Array of floats representing the margins. The margins are listed as they would be
* when defining the margins of an element in CSS: `array( $left, $top, $right, $bottom )`.
*/
public function get_margins( $with_units = false ) {
$margins = $this->get( 'margins' );
if ( $with_units ) {
$margins = array_map(
function( $margin ) {
return $margin . '%';
},
$margins
);
}
return $margins;
}
/**
* Retrieve merge codes and data.
*
* @since 6.0.0
* @since 6.1.0 Added `{earned_date}` merge code.
* Allowed `{current_date}` to be mocked.
*
* @return string[] Array mapping merge codes to the merge data.
*/
protected function get_merge_data() {
$template_id = $this->get( 'parent' );
$user_id = $this->get_user_id();
$related_id = $this->get( 'related' );
$engagement_id = $this->get( 'engagement' );
$date_format = get_option( 'date_format' );
$user = get_userdata( $user_id );
$codes = array(
// Site.
'{site_title}' => wp_specialchars_decode( get_option( 'blogname' ), ENT_QUOTES ),
'{site_url}' => get_permalink( llms_get_page_id( 'myaccount' ) ),
// User.
'{user_login}' => $user ? $user->user_login : '',
'{first_name}' => $user ? $user->first_name : '',
'{last_name}' => $user ? $user->last_name : '',
'{email_address}' => $user ? $user->user_email : '',
'{student_id}' => $user ? $user_id : '',
// Certificate.
'{current_date}' => wp_date( $date_format, llms_current_time( 'timestamp' ) ),
'{earned_date}' => $this->get_date( 'date', $date_format ),
'{certificate_id}' => $this->get( 'id' ),
'{sequential_id}' => $this->get_sequential_id(),
);
$codes = LLMS_Engagement_Handler::do_deprecated_filter(
$codes,
array( $template_id, $user_id, $related_id ),
'certificate',
'llms_certificate_merge_codes',
'llms_certificate_merge_data'
);
/**
* Filters the certificate merge data.
*
* @since 6.0.0
*
* @param array $codes {
* Merge codes and data.
*
* @type string $code The merge code. E.g. {first_name}.
* @type int|string|bool $data The merga data to replace the merge code with. E.g. 'Dude'.
* }
* @param int $user_id WP User ID of the user who earned the certificate.
* @param int $template_id WP_Post ID of the certificate template.
* @param int $related_id WP Post ID of the post which triggered the certificate to be awarded.
*/
return apply_filters( 'llms_certificate_merge_data', $codes, $user_id, $template_id, $related_id );
}
/**
* Retrieves the certificate's orientation value.
*
* @since 6.0.0
*
* @see llms_get_certificate_orientations()
*
* @return string
*/
public function get_orientation() {
return $this->get( 'orientation' );
}
/**
* Retrieves the registered size data array for the certificate's size.
*
* This method should not be used without first verifying that the certificate's
* size is not set to CUSTOM as this is not a valid size and the sitewide default
* will be returned.
*
* @since 6.0.0
*
* @see llms_get_certificate_sizes()
*
* @return array
*/
private function get_registered_size_data() {
$size = $this->get_size();
$sizes = llms_get_certificate_sizes();
if ( ! $size || empty( $sizes[ $size ] ) ) {
$size = get_option( 'lifterlms_certificate_default_size', 'LETTER' );
}
return $sizes[ $size ] ?? array_values( $sizes )[0];
}
/**
* Retrieve the formatted sequential id for the certificate.
*
* The sequential ID is stored as an integer and formatted for display according the filterable
* settings found in this method.
*
* By default, the sequential ID will appear as a 6 character number, left-side padded with zeros.
*
* Examples:
* + 1 = 000001
* + 20 = 000020
* + 12345 = 012345
* + 999999 = 999999
*
* @since 6.0.0
*
* @return string
*/
public function get_sequential_id() {
/**
* Filter certificate sequential id formatting settings.
*
* These settings are passed as arguments to `str_pad()`.
*
* @since 6.0.0
*
* @link https://www.php.net/manual/en/function.str-pad.php
*
* @param array {
* Array of formatting settings.
*
* @type int $length Number of characters for the ID.
* @type string $character Padding character.
* @type int $type String padding type. Expects a valid `pad_type` PHP constant: STR_PAD_RIGHT, STR_PAD_LEFT, or STR_PAD_BOTH.
* }
* @param LLMS_User_Certificate $certificate Instance of the certificate object.
*/
$formatting = apply_filters(
'llms_certificate_sequential_id_format',
array(
'length' => 6,
'character' => '0',
'type' => STR_PAD_LEFT,
),
$this
);
$raw_id = $this->get( 'sequential_id' );
$id = str_pad(
(string) $raw_id,
$formatting['length'],
$formatting['character'],
$formatting['type']
);
/**
* Filters the formatted certificate sequential ID string.
*
* @since 6.0.0
*
* @param string $id The formatted sequential ID.
* @param int $raw_id The raw ID before formatting was applied.
* @param array $formatting Array of formatting settings, see `llms_certificate_sequential_id_format`.
* @param LLMS_User_Certificate $certificate Instance of the certificate object.
*/
return apply_filters( 'llms_certificate_sequential_id', $id, $raw_id, $formatting, $this );
}
/**
* Retrieves the ID of the certificate's size.
*
* @since 6.0.0
*
* @see llms_get_certificate_sizes()
*
* @return string
*/
public function get_size() {
return $this->get( 'size' );
}
/**
* Retrieves the certificate's template version.
*
* Since LifterLMS 6.0.0, certificates are created using the block editor.
*
* Certificates created in the classic editor will use template version 1 while any certificates
* created in the block editor use template version 2. Therefore a certificate that has content
* and no blocks will use template version 1 and any empty certificates or those containing blocks
* will use template version 2.
*
* @since 6.0.0
*
* @return integer
*/
public function get_template_version() {
$version = empty( $this->get( 'content', true ) ) || has_blocks( $this->get( 'id' ) ) ? 2 : 1;
/**
* Filters a certificate's template version.
*
* @since 6.0.0
*
* @param int $version The template version.
*/
return apply_filters( 'llms_certificate_template_version', $version, $this );
}
/**
* Retrieves the ID of the certificate's unit.
*
* @since 6.0.0
*
* @see llms_get_certificate_units()
*
* @return string
*/
public function get_unit() {
if ( 'CUSTOM' === $this->get_size() ) {
return $this->get( 'unit' );
}
$size_info = $this->get_registered_size_data();
return $size_info['unit'];
}
/**
* Retrieve the width dimension.
*
* @since 6.0.0
*
* @param boolean $with_unit Whether or not to include the unit in the return.
* @return string|float If `$with_unit` is `true`, returns a string with the unit, otherwise returns the width as a float.
*/
public function get_width( $with_unit = false ) {
return $this->get_dimension( 'width', $with_unit );
}
/**
* Is sharing enabled
*
* @since 4.5.0
*
* @return bool
*/
public function is_sharing_enabled() {
/**
* Filter whether or not sharing is enabled for a certificate.
*
* @since 4.5.0
*
* @param boolean $enabled Whether or not sharing is enabled.
* @param LLMS_User_Certificate $certificate Certificate class instance.
*/
return apply_filters( 'llms_certificate_is_sharing_enabled', llms_parse_bool( $this->get( 'allow_sharing' ) ), $this );
}
/**
* Merges the post content based on content from the template.
*
* @since 6.0.0
* @since 6.4.0 Added optional `$content` and `$load_reusable_blocks` parameters.
* Removed initialization of shortcodes now that they are registered earlier.
*
* @param string $content Optionally use the given content instead of `$this->content`.
* @param bool $load_reusable_blocks Optionally replace reusable blocks with their actual blocks.
* @return string
*/
public function merge_content( $content = null, $load_reusable_blocks = false ) {
$content = parent::merge_content( $content, $load_reusable_blocks );
// Merge.
$merge = $this->get_merge_data();
$content = str_replace( array_keys( $merge ), array_values( $merge ), $content );
// Do shortcodes.
add_filter( 'llms_user_info_shortcode_user_id', array( $this, 'get_user_id' ) );
$content = do_shortcode( $content );
remove_filter( 'llms_user_info_shortcode_user_id', array( $this, 'get_user_id' ) );
// Preserve legacy functionality which wraps the post content in the HTML specified in the template file.
$use_template = apply_filters_deprecated(
'llms_certificate_use_legacy_template',
array( false, $this ),
'6.0.0',
'', // There is no direct replacement.
__( 'Loading custom HTML from the certificate template is deprecated. All HTML should be added to the certificate directly via the editor or applied via post content filters.', 'lifterlms' )
);
if ( $use_template ) {
ob_start();
llms_get_template(
'certificates/template.php',
array(
'email_message' => $content,
'title' => $this->get( 'title' ),
'image' => $this->get( 'certificate_image' ),
)
);
$content = ob_get_clean();
}
return $content;
}
/**
* Configure non-static property defaults.
*
* @since 6.0.0
*
* @return void
*/
private function set_property_defaults() {
// Default size is configured via a site option.
$default_size = get_option( 'lifterlms_certificate_default_size', 'LETTER' );
$this->property_defaults['size'] = ! $default_size ? 'LETTER' : $default_size;
}
/**
* Sync block editor layout properties.
*
* @since 6.0.0
*
* @param LLMS_User_Certificate $template
* @return void
*/
protected function sync_meta( $template ) {
if ( 1 === $template->get_template_version() ) {
return;
}
$props = array(
'background',
'height',
'margins',
'orientation',
'size',
'unit',
'width',
);
foreach ( $props as $prop ) {
$this->set( $prop, $template->get( $prop ) );
}
}
}
================================================
FILE: includes/models/model.llms.user.postmeta.php
================================================
<?php
/**
* LLMS_User_Postmeta data model
*
* @package LifterLMS/Models/Classes
*
* @since 3.15.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_User_Postmeta model class
*
* @since 3.15.0
* @since 4.3.0 Added `$type` property declaration.
*/
class LLMS_User_Postmeta extends LLMS_Abstract_Database_Store {
/**
* Created date column key.
*
* Disabled for this record type.
*
* @var null
*/
protected $date_created = null;
/**
* Updated date column key.
*
* @var string
*/
protected $date_updated = 'updated_date';
/**
* Array of table column name => format.
*
* @var array
*/
protected $columns = array(
'user_id' => '%d',
'post_id' => '%d',
'meta_key' => '%s',
'meta_value' => '%s',
'updated_date' => '%s',
);
/**
* Primary Key column name => format.
*
* @var array
*/
protected $primary_key = array(
'meta_id' => '%d',
);
/**
* Database Table Name.
*
* @var string
*/
protected $table = 'user_postmeta';
/**
* The record type.
*
* @var string
*/
protected $type = 'user_postmeta';
/**
* Constructor
*
* @since 3.15.0
* @since 3.21.0 Unknown.
*
* @param mixed $item Meta_id of a user postmeta item or an object with at least an "id".
* @param boolean $hydrate If true, hydrates the object on instantiation (if an ID was found via $item).
*/
public function __construct( $item = null, $hydrate = true ) {
if ( is_numeric( $item ) ) {
$this->id = $item;
} elseif ( is_object( $item ) && isset( $item->id ) ) {
$this->id = $item->id;
}
parent::__construct();
if ( $this->id && $hydrate ) {
$this->hydrate();
}
}
/**
* Get a string used to describe the postmeta item.
*
* @since 3.15.0
*
* @param string $context Display context either "course" or "student".
* @return string
*/
public function get_description( $context = 'course' ) {
$key = $this->get( 'meta_key' );
$student = $this->get_student();
$name = $student ? $student->get( 'display_name' ) : __( '[Deleted]', 'lifterlms' );
$post = llms_get_post( $this->get( 'post_id' ) );
$label = is_a( $post, 'LLMS_Post_Model' ) ? strtolower( $post->get_post_type_label() ) : __( 'quiz', 'lifterlms' );
$post_name = ( 'course' === $context ) ? $label : sprintf( '%1$s "%2$s"', $label, get_the_title( $this->get( 'post_id' ) ) );
$string = '';
switch ( $key ) {
case '_achievement_earned':
$string = sprintf( __( '%1$s earned the achievement "%2$s"', 'lifterlms' ), $name, get_the_title( $this->get( 'meta_value' ) ) );
break;
case '_certificate_earned':
$string = sprintf( __( '%1$s earned the certificate "%2$s"', 'lifterlms' ), $name, get_the_title( $this->get( 'meta_value' ) ) );
break;
case '_email_sent':
$string = sprintf( __( 'Email "%1$s" was sent to %2$s', 'lifterlms' ), get_the_title( $this->get( 'meta_value' ) ), $name );
break;
case '_enrollment_trigger':
$string = sprintf( __( '%1$s purchased the %2$s', 'lifterlms' ), $name, $post_name );
break;
case '_status':
if ( 'enrolled' === $this->get( 'meta_value' ) ) {
$string = sprintf( __( '%1$s enrolled into the %2$s', 'lifterlms' ), $name, $post_name );
} else {
$string = sprintf( __( '%1$s unenrolled from the %2$s', 'lifterlms' ), $name, $post_name );
}
break;
case '_is_complete':
$string = sprintf( __( '%1$s completed the %2$s', 'lifterlms' ), $name, $post_name );
break;
}// End switch().
return $string;
}
/**
* Retrieve a link for the item on the admin panel
*
* @since 3.15.0
* @since 6.0.0 Don't use deprecated achievement and certificate meta data.
* Combined redundant cases into a single case.
* Fixed return value.
*
* @param string $context Display context either "course" or "student".
* @return string
*/
public function get_link( $context = 'course' ) {
$url = '';
switch ( $this->get( 'meta_key' ) ) {
case '_achievement_earned':
case '_certificate_earned':
case '_email_sent':
$url = get_edit_post_link( $this->get( 'meta_value' ) );
break;
case '_enrollment_trigger':
$url = get_edit_post_link( str_replace( 'order_', '', $this->get( 'meta_value' ) ) );
break;
default:
$student = $this->get_student();
if ( ! $student ) {
return '';
}
$course = false;
if ( 'course' === get_post_type( $this->get( 'post_id' ) ) ) {
$course = llms_get_post( $this->get( 'post_id' ) );
} else {
$course = llms_get_post_parent_course( $this->get( 'post_id' ) );
}
if ( $course ) {
$url = LLMS_Admin_Reporting::get_current_tab_url(
array(
'course_id' => $course->get( 'id' ),
'stab' => 'courses',
'student_id' => $student->get_id(),
'tab' => 'students',
)
);
}
}
return $url;
}
/**
* Retrieve a student obj for the meta item.
*
* @since 3.15.0
*
* @return LLMS_Student|false
*/
public function get_student() {
return llms_get_student( $this->get( 'user_id' ) );
}
}
================================================
FILE: includes/notifications/class.llms.notifications.php
================================================
<?php
/**
* LifterLMS Notifications Management and Interface
*
* @package LifterLMS/Notifications/Classes
*
* @since 3.8.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Notifications Management and Interface
*
* Loads and allows interactions with notification views, controllers, and processors.
*
* @since 3.8.0
* @since 3.24.0 Unknown.
* @since 3.36.1 Record notifications as read during the `wp_print_footer_scripts` hook.
* @since 3.38.0 Updated processor scheduling for increased performance and reliability.
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
* @since 6.0.0 Removed deprecated items.
* - `LLMS_Notifications::dispatch_processors()` method
* - `LLMS_Notifications::$_instance` property
*/
class LLMS_Notifications {
use LLMS_Trait_Singleton;
/**
* Controller instances
*
* @var LLMS_Abstract_Notification_Controller[]
*/
private $controllers = array();
/**
* Notifications being displayed on this page load.
*
* @var array
*/
private $displayed = array();
/**
* Background processor instances
*
* @var LLMS_Abstract_Notification_Processor[]
*/
private $processors = array();
/**
* Array of processors needing to be dispatched on shutdown
*
* @var string[]
*/
private $processors_to_dispatch = array();
/**
* [string $view_classname => string $trigger ]
*
* @var string[]
*/
private $views = array();
/**
* Constructor
*
* @since 3.8.0
* @since 3.22.0 Unknown.
* @since 3.36.1 Record basic notifications as read during `wp_print_footer_scripts`.
* @since 3.38.0 Schedule processors using an async scheduled action.
* @since 6.0.0 Do not load / enqueue basic notifications on the admin panel.
* Removed the deprecated `llms_processors_async_dispatching` filter hook.
*
* @return void
*/
private function __construct() {
$this->load();
if ( ! is_admin() ) {
add_action( 'wp', array( $this, 'enqueue_basic' ) );
add_action( 'wp_print_footer_scripts', array( $this, 'mark_displayed_basics_as_read' ) );
}
add_action( 'shutdown', array( $this, 'schedule_processors_dispatch' ) );
add_action( 'llms_dispatch_notification_processor_async', array( $this, 'dispatch_processor_async' ) );
}
/**
* Async callback to dispatch processors
*
* Locates the processor by ID and dispatches it for processing.
*
* The trigger hook `llms_dispatch_notification_processor_async` is called by the action scheduler library.
*
* @since 3.38.0
*
* @see llms_dispatch_notification_processor_async
*
* @param string $id Processor ID.
* @return array|WP_Error
*/
public function dispatch_processor_async( $id ) {
$processor = $this->get_processor( $id );
if ( $processor ) {
return $processor->dispatch();
}
// Translators: %s = Processor ID.
return new WP_Error( 'invalid-processor', sprintf( __( 'The processor "%s" does not exist.', 'lifterlms' ), $id ) );
}
/**
* Enqueue basic notifications for onscreen display.
*
* @since 3.22.0
* @since 3.36.1 Don't automatically mark notifications as read.
* @since 3.38.0 Use `wp_json_decode()` in favor of `json_decode()`.
* @since 4.4.0 Use `LLMS_Assets::enqueue_inline()` in favor of deprecated `LLMS_Frontend_Assets::enqueue_inline_script()`.
* @since 7.1.0 Improve notifications query performance by not calculating unneeded found rows.
*
* @return void
*/
public function enqueue_basic() {
$user_id = get_current_user_id();
if ( ! $user_id ) {
return;
}
// Get 5 most recent new notifications for the current user.
$query = new LLMS_Notifications_Query(
array(
'per_page' => 5,
'statuses' => 'new',
'types' => 'basic',
'subscriber' => $user_id,
'no_found_rows' => true,
)
);
$this->displayed = $query->get_notifications();
// Push to JS.
llms()->assets->enqueue_inline(
'llms-queued-notifications',
'window.llms.queued_notifications = ' . wp_json_encode( $this->displayed ) . ';',
'footer'
);
}
/**
* Record notifications as read.
*
* Ensures that notifications are not missed due to redirects that happen after `wp`.
*
* @since 3.36.1
*
* @return void
*/
public function mark_displayed_basics_as_read() {
if ( $this->displayed ) {
foreach ( $this->displayed as $notification ) {
$notification->set( 'status', 'read' );
}
}
}
/**
* Get the directory path for core notification classes
*
* @since 3.8.0
*
* @return string
*/
private function get_directory() {
return LLMS_PLUGIN_DIR . 'includes/notifications/';
}
/**
* Get a single controller instance
*
* @since 3.8.0
*
* @param string $controller Trigger id (eg: lesson_complete).
* @return LLMS_Abstract_Notification_Controller|false
*/
public function get_controller( $controller ) {
if ( isset( $this->controllers[ $controller ] ) ) {
return $this->controllers[ $controller ];
}
return false;
}
/**
* Get loaded controllers
*
* @since 3.8.0
*
* @return LLMS_Abstract_Notification_Controller[]
*/
public function get_controllers() {
return $this->controllers;
}
/**
* Retrieve a single processor instance
*
* @since 3.8.0
*
* @param string $processor Name of the processor (eg: email).
* @return LLMS_Abstract_Notification_Processor|false
*/
public function get_processor( $processor ) {
if ( isset( $this->processors[ $processor ] ) ) {
return $this->processors[ $processor ];
}
return false;
}
/**
* Get loaded processors
*
* @since 3.8.0
*
* @return LLMS_Abstract_Notification_Processor[]
*/
public function get_processors() {
return $this->processors;
}
/**
* Retrieve a view instance of a notification
*
* @since 3.8.0
* @since 3.24.0 Unknown.
* @since 3.38.0 Use strict comparison.
*
* @param LLMS_Notification $notification Notification instance.
* @return LLMS_Abstract_Notification_View|false
*/
public function get_view( $notification ) {
$trigger = $notification->get( 'trigger_id' );
if ( in_array( $trigger, $this->views, true ) ) {
$views = array_flip( $this->views );
$class = $views[ $trigger ];
$view = new $class( $notification );
return $view;
}
return false;
}
/**
* Get the classname for the view of a given notification based off it's trigger
*
* @since 3.8.0
* @since 3.24.0 Unknown.
*
* @param string $trigger Trigger id (eg: lesson_complete).
* @param string $prefix Default = 'LLMS'.
* @return string
*/
private function get_view_classname( $trigger, $prefix = null ) {
$prefix = $prefix ? $prefix : 'LLMS';
$name = str_replace( ' ', '_', ucwords( str_replace( '_', ' ', $trigger ) ) );
return sprintf( '%1$s_Notification_View_%2$s', $prefix, $name );
}
/**
* Load all notifications
*
* @since 3.8.0
* @since 3.24.0 Unknown.
* @since 5.2.0 Added 'upcoming_payment_reminder'.
*
* @return void
*/
private function load() {
$triggers = array(
'achievement_earned',
'certificate_earned',
'course_complete',
'course_track_complete',
'enrollment',
'lesson_complete',
'manual_payment_due',
'payment_retry',
'purchase_receipt',
'quiz_failed',
'quiz_graded',
'quiz_passed',
'section_complete',
'student_welcome',
'subscription_cancelled',
'upcoming_payment_reminder',
);
foreach ( $triggers as $name ) {
$this->load_controller( $name );
$this->load_view( $name );
}
$processors = array(
'email',
);
foreach ( $processors as $name ) {
$this->load_processor( $name );
}
/**
* Run an action after all core notification classes are loaded.
*
* Third party notifications can hook into this action.
* Use `load_view()`, `load_controller()`, and `load_processor()` methods
* to load notifications into the class and be auto-called by the core APIs.
*
* @since Unknown
*
* @param LLMS_Notifications $this Instance of the notifications singleton.
*/
do_action( 'llms_notifications_loaded', $this );
}
/**
* Load and initialize a single controller
*
* @since 3.8.0
*
* @param string $trigger Trigger id (eg: lesson_complete).
* @param string $path Full path to the controller file, allows third parties to load external controllers.
* @return boolean `true` if the controller is added and loaded, `false` otherwise.
*/
public function load_controller( $trigger, $path = null ) {
// Default path for core views.
if ( ! $path ) {
$path = $this->get_directory() . 'controllers/class.llms.notification.controller.' . $this->name_to_file( $trigger ) . '.php';
}
if ( file_exists( $path ) ) {
$this->controllers[ $trigger ] = require_once $path;
return true;
}
return false;
}
/**
* Load a single processor
*
* @since 3.8.0
*
* @param string $type Processor type id.
* @param string $path Optional path (for allowing 3rd party processor loading).
* @return boolean
*/
public function load_processor( $type, $path = null ) {
// Default path for core processors.
if ( ! $path ) {
$path = $this->get_directory() . 'processors/class.llms.notification.processor.' . $type . '.php';
}
if ( file_exists( $path ) ) {
$this->processors[ $type ] = require_once $path;
return true;
}
return false;
}
/**
* Validate trigger and load its view.
*
* @since 3.8.0
* @since 3.24.0 Unknown.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @param string $trigger Trigger id (eg: lesson_complete).
* @param string $path Full path to the view file, allows third parties to load external views.
* @param string $prefix Classname prefix. Defaults to "LLMS". Can be used by 3rd parties to adjust
* the prefix in accordance with the projects standards.
* @return boolean `true` if the view is added and loaded, `false` otherwise.
*/
public function load_view( $trigger, $path = null, $prefix = null ) {
// Default path for core views.
if ( ! $path ) {
$path = $this->get_directory() . 'views/class.llms.notification.view.' . $this->name_to_file( $trigger ) . '.php';
}
if ( file_exists( $path ) ) {
if ( ! is_null( $prefix ) ) {
require_once $path;
}
$this->views[ $this->get_view_classname( $trigger, $prefix ) ] = $trigger;
return true;
}
return false;
}
/**
* Convert a trigger name to a filename string
*
* EG: "lesson_complete" to "lesson.complete".
*
* @since 3.8.0
*
* @param string $name Trigger name.
* @return string
*/
private function name_to_file( $name ) {
return str_replace( '_', '.', $name );
}
/**
* Schedule a processor to dispatch its queue on shutdown
*
* @since 3.8.0
* @since 3.38.0 Use strict comparisons.
*
* @param string $id Processor ID (eg: email).
* @return void
*/
public function schedule_processing( $id ) {
if ( ! in_array( $id, $this->processors_to_dispatch, true ) ) {
$this->processors_to_dispatch[] = $id;
}
}
/**
* Check for processors that have items in the queue
*
* For any found processors, saves their queue and schedules them to be processes via a scheduled event.
*
* @since 3.38.0
*
* @return array Array containing information about the scheduled processors.
* The array keys will be the processor ID and the values will be the timestamp of the event or a WP_Error object.
*/
public function schedule_processors_dispatch() {
$scheduled = array();
if ( $this->processors_to_dispatch ) {
foreach ( $this->processors_to_dispatch as $key => $id ) {
// Retrieve the processor.
$processor = $this->get_processor( $id );
// Remove it from the list of processors to dispatch.
unset( $this->processors_to_dispatch[ $key ] );
$scheduled[ $id ] = $processor ? $this->schedule_single_processor( $processor, $id ) : new WP_Error(
'invalid-processor',
// Translators: %s = Processor ID.
sprintf( __( 'The processor "%s" does not exist.', 'lifterlms' ), $id )
);
}
}
return $scheduled;
}
/**
* Save pending batches and schedule the async dispatching of a processor.
*
* @since 3.38.0
*
* @param LLMS_Abstract_Notification_Processor $processor Notification processor object.
* @param string $id Processor ID.
* @return int|WP_Error Timestamp of the scheduled event or an error object.
*/
protected function schedule_single_processor( $processor, $id ) {
$hook = 'llms_dispatch_notification_processor_async';
$args = array( $id );
// Save items in the queue.
$processor->save();
// Check if there's already a scheduled event.
$timestamp = as_next_scheduled_action( $hook, $args );
// If there's no event scheduled already, schedule one.
if ( ! $timestamp ) {
$timestamp = llms_current_time( 'timestamp', 1 );
// Error encountered scheduling the event.
if ( ! as_schedule_single_action( $timestamp, $hook, $args ) ) {
$timestamp = new WP_Error(
'schedule-error',
// Translators: %s = Processor ID.
sprintf( __( 'There was an error dispatching the "%s" processor.', 'lifterlms' ), $id )
);
}
}
return $timestamp;
}
}
================================================
FILE: includes/notifications/class.llms.notifications.query.php
================================================
<?php
/**
* LLMS_Notifications_Query class file
*
* @package LifterLMS/Notifications/Classes
*
* @since 3.8.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Notifications_Query class.
*
* Query LifterLMS Students for a given course/membership.
*
* @example
* $query = new LLMS_Notifications_Query( array(
* 'subscriber' => 123, // null
* 'per_page' => 10,
* 'statuses' => 'new', // array( 'new', 'read', '...' )
* 'types' => 'basic', // array( 'basic', 'email', '...' )
* ) );
*
* @since 3.8.0
* @since 3.14.0 Unknown.
*/
class LLMS_Notifications_Query extends LLMS_Database_Query {
/**
* Identify the extending query
*
* @var string
*/
protected $id = 'notifications';
/**
* Get an array of allowed notification statuses.
*
* @since 3.8.0
* @since 7.1.0 Added 'error' among the available statuses.
*
* @return string[]
*/
private function get_available_statuses() {
return array( 'new', 'sent', 'read', 'unread', 'deleted', 'failed', 'error' );
}
/**
* Get the available notification types
*
* @return string[]
* @since 3.8.0
* @version 3.8.0
*/
private function get_available_types() {
return array( 'basic', 'email' );
}
/**
* Retrieve default arguments for a student query.
*
* @since 3.8.0
* @since 3.11.0 Unknown.
* @since 7.1.0 Explicitly exclude 'error' status.
* Drop usage of `this->get_filter( 'default_args' )` in favor of `'llms_notification_query_default_args'`.
* @return array
*/
protected function get_default_args() {
$args = array(
'post_id' => null,
'subscriber' => null,
'sort' => array(
'updated' => 'DESC',
'id' => 'DESC',
),
'statuses' => array_values( array_diff( $this->get_available_statuses(), array( 'error' ) ) ),
'triggers' => array(),
'types' => array(),
'user_id' => null,
);
$args = wp_parse_args( $args, parent::get_default_args() );
/**
* Filters the notifications query's default args.
*
* @since 3.8.0
* @since 7.1.0 Added `$notifications_query` parameter.
*
* @param array $args Array of default arguments to set up the query with.
* @param LLMS_Notifications_Query $notifications_query Instance of `LLMS_Notifications_Query`.
*/
return apply_filters( 'llms_notifications_query_default_args', $args, $this );
}
/**
* Convert raw results to notification objects.
*
* @since 3.8.0
* @since 7.1.0 When loading a notification, if errored, exclude it when not explictly requested.
* Drop usage of `this->get_filter( 'default_args' )` in favor of `llms_notifications_query_get_notifications`.
*
* @return LLMS_Notification[]
*/
public function get_notifications() {
$notifications = array();
$results = $this->get_results();
if ( $results ) {
foreach ( $results as $result ) {
$notification = ( new LLMS_Notification( $result->id ) )->load();
// If the notification status is 'error' and errored notifications were not requested, skip it.
if ( 'error' === $notification->get( 'status' ) && ! in_array( 'error', $this->arguments['statuses'], true ) ) {
continue;
}
$notifications[] = $notification;
}
}
if ( $this->get( 'suppress_filters' ) ) {
return $notifications;
}
/**
* Filters the list of notifications.
*
* @since 3.8.0
*
* @param array $notifications Array of {@see LLMS_Notification} instances.
* @param LLMS_Notifications_Query $notifications_query Instance of `LLMS_Notifications_Query`.
*/
return apply_filters( 'llms_notifications_query_get_notifications', $notifications, $this );
}
/**
* Parse arguments needed for the query
*
* @return void
* @since 3.8.0
* @version 3.8.0
*/
protected function parse_args() {
$this->parse_statuses();
$this->parse_types();
}
/**
* Parse submitted statuses
*
* @return void
* @since 3.8.0
* @version 3.8.0
*/
private function parse_statuses() {
$statuses = $this->arguments['statuses'];
// allow strings to be submitted when only requesting one status
if ( is_string( $statuses ) ) {
$statuses = array( $statuses );
}
// ensure only valid statuses are used
$statuses = array_intersect( $statuses, $this->get_available_statuses() );
$this->arguments['statuses'] = $statuses;
}
/**
* Parse submitted types
*
* @return void
* @since 3.8.0
* @version 3.8.0
*/
private function parse_types() {
$types = $this->arguments['types'];
// allow strings to be submitted when only requesting one status
if ( is_string( $types ) ) {
$types = array( $types );
}
// ensure only valid types are used
$types = array_intersect( $types, $this->get_available_types() );
$this->arguments['types'] = $types;
}
/**
* Parse submitted triggers
*
* @return void
* @since 3.11.0
* @version 3.11.0
*/
private function parse_triggers() {
$triggers = $this->arguments['triggers'];
// allow strings to be submitted when only requesting one status
if ( is_string( $triggers ) ) {
$triggers = array( $triggers );
}
$this->arguments['triggers'] = $triggers;
}
/**
* Prepare the SQL for the query.
*
* @since 3.8.0
* @since 3.9.4 Unknown.
* @since 6.0.0 Renamed from `preprare_query()`.
* @since 7.1.0 Use `$this->sql_select_columns({columns})` to determine the columns to select.
* @since 10.0.0 Build count_query from shared clauses instead of using SQL_CALC_FOUND_ROWS.
*
* @return string
*/
protected function prepare_query() {
global $wpdb;
$from = "FROM {$wpdb->prefix}lifterlms_notifications AS n";
$join = "LEFT JOIN {$wpdb->posts} AS p on p.ID = n.post_id";
$where = $this->sql_where();
if ( ! $this->get( 'no_found_rows' ) ) {
$this->count_query = "SELECT COUNT(*) {$from} {$join} {$where}";
}
$vars = array(
$this->get_skip(),
$this->get( 'per_page' ),
);
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared -- SQL is prepared in other functions.
$sql = $wpdb->prepare(
"SELECT {$this->sql_select_columns()}
{$from}
{$join}
{$where}
{$this->sql_orderby()}
LIMIT %d, %d
;",
$vars
);
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
return $sql;
}
/**
* Retrieve the prepared SQL for the ORDER clause.
*
* Slightly modified from abstract to include the table name to prevent ambiguous errors.
*
* @since 3.9.2
* @since 7.1.0 Drop usage of `$this->get_filter('where')` in favor of `llms_notifications_query_where`.
*
* @return string
*/
protected function sql_orderby() {
$sql = 'ORDER BY';
$comma = false;
foreach ( $this->get( 'sort' ) as $orderby => $order ) {
$pre = ( $comma ) ? ', ' : ' ';
$sql .= $pre . 'n.' . sanitize_sql_orderby( "{$orderby} {$order}" );
$comma = true;
}
if ( $this->get( 'suppress_filters' ) ) {
return $sql;
}
/**
* Filters the query WHERE clause.
*
* @since 7.1.0
*
* @param string $sql The WHERE clause of the query.
* @param LLMS_Notifications_Query $notifications_query Instance of LLMS_Events_Query.
*/
return apply_filters( 'llms_notifications_query_where', $sql, $this );
}
/**
* Retrieve the prepared SQL for the WHERE clause
*
* @return string
* @since 3.8.0
* @version 3.14.0
*/
private function sql_where() {
global $wpdb;
$where = 'WHERE 1';
$post_statuses = array_merge( array( 'publish' ), array_keys( llms_get_order_statuses() ) );
$post_statuses = array_map( array( $this, 'escape_and_quote_string' ), $post_statuses );
$where .= sprintf( ' AND p.post_status IN ( %s )', implode( ', ', $post_statuses ) );
// these args are all "whered" in the same way
$wheres = array(
'statuses' => 'status',
'triggers' => 'trigger_id',
'types' => 'type',
);
// loop through them and build the where clauses based off the submitted data
foreach ( $wheres as $arg_name => $col_name ) {
$arg = $this->get( $arg_name );
if ( $arg ) {
$prepped = array_map( array( $this, 'escape_and_quote_string' ), $arg );
$where .= sprintf( ' AND n.%1$s IN( %2$s )', $col_name, implode( ', ', $prepped ) );
}
}
// add subscriber info if set
$subscriber = $this->get( 'subscriber' );
if ( $subscriber ) {
$where .= $wpdb->prepare( ' AND n.subscriber = %s', $subscriber );
}
// add post and user id checks
foreach ( array( 'post_id', 'user_id' ) as $var ) {
$arg = $this->get( $var );
if ( $arg ) {
$where .= sprintf( ' AND n.%1$s = %2$d', esc_sql( $var ), absint( $arg ) );
}
}
return $where;
}
}
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.achievement.earned.php
================================================
<?php
/**
* Notification Controller: Achievement Earned
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 3.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Achievement Earned
*
* @since 3.8.0
*/
class LLMS_Notification_Controller_Achievement_Earned extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'achievement_earned';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 3;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'llms_user_earned_achievement' );
/**
* Callback function, called upon achievement post generation
*
* @param int $user_id WP User ID of the user who earned the achievement
* @param int $achievement_id WP Post ID of the new achievement post
* @param int $related_post_id WP Post ID of the post which triggered the achievement to be awarded
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function action_callback( $user_id = null, $achievement_id = null, $related_post_id = null ) {
$this->user_id = $user_id;
$this->post_id = $achievement_id;
$this->related_post_id = $related_post_id;
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.8.0
* @version 3.8.0
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_title() {
return __( 'Achievement Earned', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
}
return $options;
}
/**
* Determine what types are supported
* Extending classes can override this function in order to add or remove support
* 3rd parties should add support via filter on $this->get_supported_types()
*
* @return array associative array, keys are the ID/db type, values should be translated display types
* @since 3.8.0
* @version 3.8.0
*/
protected function set_supported_types() {
return array(
'basic' => __( 'Popup', 'lifterlms' ),
);
}
}
return LLMS_Notification_Controller_Achievement_Earned::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.certificate.earned.php
================================================
<?php
/**
* Notification Controller: Certificate Earned
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 3.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Certificate Earned
*
* @since 3.8.0
*/
class LLMS_Notification_Controller_Certificate_Earned extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'certificate_earned';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 3;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'llms_user_earned_certificate' );
/**
* Callback function, called upon certificate post generation
*
* @param int $user_id WP User ID of the user who earned the certificate
* @param int $certificate_id WP Post ID of the new achievement post
* @param int $related_post_id WP Post ID of the post which triggered the certificate to be awarded
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function action_callback( $user_id = null, $certificate_id = null, $related_post_id = null ) {
$this->user_id = $user_id;
$this->post_id = $certificate_id;
$this->related_post_id = $related_post_id;
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.8.0
* @version 3.8.0
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_title() {
return __( 'Certificate Earned', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
}
return $options;
}
/**
* Determine what types are supported
* Extending classes can override this function in order to add or remove support
* 3rd parties should add support via filter on $this->get_supported_types()
*
* @return array associative array, keys are the ID/db type, values should be translated display types
* @since 3.8.0
* @version 3.8.0
*/
protected function set_supported_types() {
return array(
'basic' => __( 'Popup', 'lifterlms' ),
);
}
}
return LLMS_Notification_Controller_Certificate_Earned::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.course.complete.php
================================================
<?php
/**
* Notification Controller: Course Complete
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 3.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Course Complete
*
* @since 3.8.0
*/
class LLMS_Notification_Controller_Course_Complete extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'course_complete';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'lifterlms_course_completed' );
/**
* Callback function called when a course is completed by a student
*
* @param int $student_id WP User ID of a LifterLMS Student
* @param int $course_id WP Post ID of a LifterLMS Course
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function action_callback( $student_id = null, $course_id = null ) {
$this->user_id = $student_id;
$this->post_id = $course_id;
$this->course = llms_get_post( $course_id );
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.8.0
* @version 3.8.0
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'course_author':
$uid = $this->course->get( 'author' );
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_title() {
return __( 'Course Complete', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'course_author', 'yes' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Course_Complete::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.course.track.complete.php
================================================
<?php
/**
* Notification Controller: Course Track Complete
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 3.30.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Course Track Complete
*
* @since 3.8.0
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Notification_Controller_Course_Track_Complete extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'course_track_complete';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'lifterlms_course_track_completed' );
/**
* @var LLMS_Track
* @since 3.8.0
*/
public $track;
/**
* Callback function called when a course track is completed by a student
*
* @param int $student_id WP User ID of a LifterLMS Student
* @param int $course_track_id WP Post ID of a LifterLMS Course
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function action_callback( $student_id = null, $course_track_id = null ) {
$this->user_id = $student_id;
$this->post_id = $course_track_id;
$this->track = new LLMS_Track( $course_track_id );
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.8.0
* @version 3.8.0
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_title() {
return __( 'Course Track Complete', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Course_Track_Complete::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.enrollment.php
================================================
<?php
/**
* Notification Controller: Enrollment
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 3.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Enrollment
*
* @since 3.8.0
*/
class LLMS_Notification_Controller_Enrollment extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'enrollment';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array(
'llms_user_enrolled_in_course',
'llms_user_added_to_membership_level',
);
/**
* Callback function, called after enrollment into a course
*
* @param int $user_id WP User ID of the user
* @param int $post_id WP Post ID of the course or membership
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function action_callback( $user_id = null, $post_id = null ) {
$this->user_id = $user_id;
$this->post_id = $post_id;
$this->course = llms_get_post( $post_id );
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.8.0
* @version 3.8.0
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'author':
$uid = $this->course->get( 'author' );
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_title() {
return __( 'Enrollment', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
$options[] = $this->get_subscriber_option_array( 'author', 'no' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'author', 'no' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Enrollment::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.lesson.complete.php
================================================
<?php
/**
* Notification Controller: Lesson Complete
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 3.30.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Lesson Complete
*
* @since 3.8.0
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Notification_Controller_Lesson_Complete extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'lesson_complete';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'lifterlms_lesson_completed' );
/**
* @var LLMS_Lesson
* @since 3.8.0
*/
public $lesson;
/**
* Callback function called when a lesson is completed by a student
*
* @param int $student_id WP User ID of a LifterLMS Student
* @param int $lesson_id WP Post ID of a LifterLMS Lesson
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function action_callback( $student_id = null, $lesson_id = null ) {
$this->user_id = $student_id;
$this->post_id = $lesson_id;
$this->lesson = llms_get_post( $lesson_id );
$this->course = $this->lesson->get_course();
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.8.0
* @version 3.8.0
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'course_author':
$uid = $this->course->get( 'author' );
break;
case 'lesson_author':
$uid = $this->lesson->get( 'author' );
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_title() {
return __( 'Lesson Complete', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'lesson_author', 'no' );
$options[] = $this->get_subscriber_option_array( 'course_author', 'no' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Lesson_Complete::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.manual.payment.due.php
================================================
<?php
/**
* Notification Controller: Manual Gateway Payment Due
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.10.0
* @version 3.10.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Manual Gateway Payment Due
*
* @since 3.10.0
*/
class LLMS_Notification_Controller_Manual_Payment_Due extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'manual_payment_due';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array(
'llms_manual_payment_due',
);
/**
* Callback function called when a payment retry is scheduled
*
* @param int $order Instance of an LLMS_Order
* @return void
* @since 3.10.0
* @version 3.10.0
*/
public function action_callback( $order = null ) {
$this->user_id = $order->get( 'user_id' );
$this->post_id = $order->get( 'id' );
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.10.0
* @version 3.10.0
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'author':
$order = llms_get_post( $this->post_id );
if ( ! is_a( $order, 'LLMS_Order' ) ) {
return false;
}
$product = $order->get_product();
if ( is_a( $product, 'WP_Post' ) ) {
return false;
}
$uid = $product->get( 'author' );
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Determine what types are supported
* Extending classes can override this function in order to add or remove support
* 3rd parties should add support via filter on $this->get_supported_types()
*
* @return array associative array, keys are the ID/db type, values should be translated display types
* @since 3.10.0
* @version 3.10.0
*/
protected function set_supported_types() {
return array(
'basic' => __( 'Popup', 'lifterlms' ),
'email' => __( 'Email', 'lifterlms' ),
);
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.10.0
* @version 3.10.0
*/
public function get_title() {
return __( 'Gateway: Manual - Payment Due', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.10.0
* @version 3.10.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'author', 'no' );
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Manual_Payment_Due::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.payment.retry.php
================================================
<?php
/**
* Notification Controller: Payment Retry Scheduled
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.10.0
* @version 5.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Payment Retry Scheduled
*
* @since 3.10.0
*/
class LLMS_Notification_Controller_Payment_Retry extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var string
*/
public $id = 'payment_retry';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 1;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array(
'llms_send_automatic_payment_retry_notification',
);
/**
* Callback function called when a payment retry is scheduled
*
* @since 3.10.0
*
* @param int $order Instance of an LLMS_Order.
* @return void
*/
public function action_callback( $order = null ) {
$this->user_id = $order->get( 'user_id' );
$this->post_id = $order->get( 'id' );
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @since 3.10.0
*
* @param string $subscriber Subscriber type string.
* @return int|false
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'author':
$order = llms_get_post( $this->post_id );
if ( ! is_a( $order, 'LLMS_Order' ) ) {
return false;
}
$product = $order->get_product();
if ( is_a( $product, 'WP_Post' ) ) {
return false;
}
$uid = $product->get( 'author' );
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
*
* Used on settings screens.
*
* @since 3.10.0
*
* @return string
*/
public function get_title() {
return __( 'Payment Retry Scheduled', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @since 3.10.0
*
* @param string $type Notification type id.
* @return array
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'author', 'no' );
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Payment_Retry::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.purchase.receipt.php
================================================
<?php
/**
* Notification Controller: Transaction Success
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 3.24.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Transaction Success
*
* @since 3.8.0
* @since 3.24.0 Unknown
*/
class LLMS_Notification_Controller_Purchase_Receipt extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var string
*/
public $id = 'purchase_receipt';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 1;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array(
'lifterlms_resend_transaction_receipt',
'lifterlms_transaction_status_succeeded',
);
/**
* Determines if test notifications can be sent
*
* @var bool
*/
protected $testable = array(
'basic' => false,
'email' => true,
);
/**
* Callback function called when a lesson is completed by a student
*
* @since 3.8.0
*
* @param int $transaction Instance of a LLMS_Transaction.
* @return void
*/
public function action_callback( $transaction = null ) {
$order = $transaction->get_order();
/**
* Filter to avoid sending notification for purchase receipts.
*
* @since 9.1.2
*/
if ( ! apply_filters( 'llms_send_purchase_receipt_notification', true, $order, $transaction ) ) {
return;
}
$this->user_id = $order->get( 'user_id' );
$this->post_id = $transaction->get( 'id' );
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @since 3.8.0
* @since 3.10.2 Unknown.
*
* @param string $subscriber Subscriber type string.
* @return int|false
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'author':
$txn = llms_get_post( $this->post_id );
$order = $txn->get_order();
if ( ! $order ) {
return false;
}
$product = $order->get_product();
if ( ! $product ) {
return false;
}
$uid = $product->get( 'author' );
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Determine what types are supported
*
* Extending classes can override this function in order to add or remove support.
* 3rd parties should add support via filter on $this->get_supported_types().
*
* @since 3.8.0
*
* @return array Associative array, keys are the ID/db type, values should be translated display types.
*/
protected function set_supported_types() {
return array(
'email' => __( 'Email', 'lifterlms' ),
);
}
/**
* Get an array of LifterLMS Admin Page settings to send test notifications
*
* @since 3.24.0
*
* @param string $type Notification type [basic|email].
* @return array
*/
public function get_test_settings( $type ) {
$query = new WP_Query(
array(
'post_type' => 'llms_transaction',
'posts_per_page' => 25,
)
);
$options = array(
'' => '',
);
foreach ( $query->posts as $post ) {
$transaction = llms_get_post( $post );
$order = $transaction->get_order();
$student = llms_get_student( $order->get( 'user_id' ) );
if ( $transaction && $student ) {
$options[ $transaction->get( 'id' ) ] = esc_attr(
sprintf(
// Translators: %1$d = The Order ID; %2$s The customer's full name; %3$s The product title.
__( 'Order #%1$d from %2$s for "%3$s"', 'lifterlms' ),
$order->get( 'id' ),
$student->get_name(),
$order->get( 'product_title' )
)
);
}
}
return array(
array(
'class' => 'llms-select2',
'custom_attributes' => array(
'data-allow-clear' => true,
'data-placeholder' => __( 'Select a transaction', 'lifterlms' ),
),
'default' => '',
'id' => 'transaction_id',
'desc' => '<br/>' . __( 'Send yourself a test notification using information from the selected transaction.', 'lifterlms' ),
'options' => $options,
'title' => __( 'Send a Test', 'lifterlms' ),
'type' => 'select',
// 'selected' => false,
),
);
}
/**
* Get the translatable title for the notification
*
* Used on settings screens.
*
* @since 3.8.0
*
* @return string
*/
public function get_title() {
return __( 'Purchase Receipt', 'lifterlms' );
}
/**
* Send a test notification to the currently logged in users
*
* Extending classes should redefine this in order to properly setup the controller with post_id and user_id data.
*
* @since 3.24.0
*
* @param string $type Notification type [basic|email].
* @param array $data Array of test notification data as specified by $this->get_test_data().
* @return int|false
*/
public function send_test( $type, $data = array() ) {
if ( empty( $data['transaction_id'] ) ) {
return;
}
$transaction = llms_get_post( $data['transaction_id'] );
$order = $transaction->get_order();
$this->user_id = $order->get( 'user_id' );
$this->post_id = $transaction->get( 'id' );
return parent::send_test( $type );
}
/**
* Setup the subscriber options for the notification
*
* @since 3.8.0
*
* @param string $type Notification type id.
* @return array
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'email':
$options[] = $this->get_subscriber_option_array( 'author', 'yes' );
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Purchase_Receipt::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.quiz.failed.php
================================================
<?php
/**
* Notification Controller: Quiz Failed
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 6.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Quiz Failed
*
* @since 3.8.0
* @since 3.24.0 Unknown.
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Notification_Controller_Quiz_Failed extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var string
*/
public $id = 'quiz_failed';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'lifterlms_quiz_failed' );
/**
* @var LLMS_Quiz
* @since 3.8.0
*/
public $quiz;
/**
* Determines if test notifications can be sent
*
* @var array
*/
protected $testable = array(
'basic' => false,
'email' => true,
);
/**
* Callback function called when a quiz is failed by a student
*
* @param int $student_id WP User ID of a LifterLMS Student
* @param array $quiz_id WP Post ID of a LifterLMS quiz
* @return void
* @since 3.8.0
* @version 3.16.6
*/
public function action_callback( $student_id = null, $quiz_id = null ) {
$this->user_id = $student_id;
$this->post_id = $quiz_id;
$this->quiz = llms_get_post( $quiz_id );
if ( ! $this->quiz ) {
return;
}
$this->course = $this->quiz->get_course();
$this->send();
}
/**
* Get an array of LifterLMS Admin Page settings to send test notifications.
*
* @since 3.24.0
* @since 6.1.0 Fixed access of protected LLMS_Abstract_Query properties.
* Fixed issue where void was returned instead of an empty array if the type was 'email'.
*
* @param string $type Notification type [basic|email].
* @return array
*/
public function get_test_settings( $type ) {
if ( 'email' !== $type ) {
return array();
}
$query = new LLMS_Query_Quiz_Attempt(
array(
'per_page' => 25,
'status' => 'fail',
)
);
$options = array(
'' => '',
);
$attempts = array();
$results = $query->get_results();
if ( $query->has_results() ) {
foreach ( $query->get_attempts() as $attempt ) {
$quiz = llms_get_post( $attempt->get( 'quiz_id' ) );
$student = llms_get_student( $attempt->get( 'student_id' ) );
if ( $attempt && $student ) {
$options[ $attempt->get( 'id' ) ] = esc_attr( sprintf( __( 'Attempt #%1$d for Quiz "%2$s" by %3$s', 'lifterlms' ), $attempt->get( 'id' ), $quiz->get( 'title' ), $student->get_name() ) );
}
}
}
return array(
array(
'class' => 'llms-select2',
'custom_attributes' => array(
'data-allow-clear' => true,
'data-placeholder' => __( 'Select a failed quiz', 'lifterlms' ),
),
'default' => '',
'id' => 'attempt_id',
'desc' => '<br/>' . __( 'Send yourself a test notification using information from the selected quiz.', 'lifterlms' ),
'options' => $options,
'title' => __( 'Send a Test', 'lifterlms' ),
'type' => 'select',
),
);
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.8.0
* @version 3.13.1
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'course_author':
if ( $this->course ) {
$uid = $this->course->get( 'author' );
} else {
$uid = $this->quiz->post->post_author;
}
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.8.0
* @version 3.24.0
*/
public function get_title() {
return __( 'Quizzes: Quiz Failed', 'lifterlms' );
}
/**
* Send a test notification to the currently logged in users
* Extending classes should redefine this in order to properly setup the controller with post_id and user_id data
*
* @param string $type notification type [basic|email]
* @param array $data array of test notification data as specified by $this->get_test_data()
* @return int|false
* @since 3.24.0
* @version 3.24.0
*/
public function send_test( $type, $data = array() ) {
if ( empty( $data['attempt_id'] ) ) {
return;
}
$attempt = new LLMS_Quiz_Attempt( $data['attempt_id'] );
$this->user_id = $attempt->get( 'student_id' );
$this->post_id = $attempt->get( 'quiz_id' );
$this->quiz = llms_get_post( $attempt->get( 'quiz_id' ) );
$this->course = $this->quiz->get_course();
return parent::send_test( $type );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'course_author', 'no' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Quiz_Failed::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.quiz.graded.php
================================================
<?php
/**
* Notification Controller: Quiz Graded
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.24.0
* @version 3.24.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Quiz Graded
*
* @since 3.24.0
*/
class LLMS_Notification_Controller_Quiz_Graded extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'quiz_graded';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 3;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'llms_quiz_graded' );
/**
* Determines if test notifications can be sent
*
* @var bool
*/
protected $testable = array(
'basic' => false,
'email' => true,
);
/**
* Callback function called when a quiz is failed by a student
*
* @param int $student_id WP User ID of a LifterLMS Student
* @param array $quiz_id WP Post ID of a LifterLMS quiz
* @param obj $attempt LLMS_Quiz_Attempt
* @return void
* @since 3.24.0
* @version 3.24.0
*/
public function action_callback( $student_id = null, $quiz_id = null, $attempt = null ) {
$this->user_id = $student_id;
$this->post_id = $attempt->get( 'id' );
$this->send();
}
/**
* Get an array of LifterLMS Admin Page settings to send test notifications
*
* @param string $type notification type [basic|email]
* @return array
* @since 3.24.0
* @version 3.24.0
*/
public function get_test_settings( $type ) {
if ( 'email' !== $type ) {
return;
}
$query = new LLMS_Query_Quiz_Attempt(
array(
'per_page' => 25,
)
);
$options = array(
'' => '',
);
$attempts = array();
if ( $query->has_results() ) {
foreach ( $query->get_attempts() as $attempt ) {
$quiz = llms_get_post( $attempt->get( 'quiz_id' ) );
$student = llms_get_student( $attempt->get( 'student_id' ) );
if ( $attempt && $student && $quiz ) {
$options[ $attempt->get( 'id' ) ] = esc_attr( sprintf( __( 'Attempt #%1$d for Quiz "%2$s" by %3$s', 'lifterlms' ), $attempt->get( 'id' ), $quiz->get( 'title' ), $student->get_name() ) );
}
}
}
return array(
array(
'class' => 'llms-select2',
'custom_attributes' => array(
'data-allow-clear' => true,
'data-placeholder' => __( 'Select a passed quiz', 'lifterlms' ),
),
'default' => '',
'id' => 'attempt_id',
'desc' => '<br/>' . __( 'Send yourself a test notification using information from the selected quiz.', 'lifterlms' ),
'options' => $options,
'title' => __( 'Send a Test', 'lifterlms' ),
'type' => 'select',
),
);
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.24.0
* @version 3.24.0
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.24.0
* @version 3.24.0
*/
public function get_title() {
return __( 'Quizzes: Quiz Graded', 'lifterlms' );
}
/**
* Send a test notification to the currently logged in users
* Extending classes should redefine this in order to properly setup the controller with post_id and user_id data
*
* @param string $type notification type [basic|email]
* @param array $data array of test notification data as specified by $this->get_test_data()
* @return int|false
* @since 3.24.0
* @version 3.24.0
*/
public function send_test( $type, $data = array() ) {
if ( empty( $data['attempt_id'] ) ) {
return;
}
$attempt = new LLMS_Quiz_Attempt( $data['attempt_id'] );
$this->user_id = $attempt->get( 'student_id' );
$this->post_id = $attempt->get( 'id' );
return parent::send_test( $type );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.24.0
* @version 3.24.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Quiz_Graded::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.quiz.passed.php
================================================
<?php
/**
* Notification Controller: Quiz Passed
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 3.30.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Quiz Passed
*
* @since 3.8.0
* @since 3.24.0 Unknown.
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Notification_Controller_Quiz_Passed extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'quiz_passed';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'lifterlms_quiz_passed' );
/**
* @var LLMS_Quiz
* @since 3.8.0
*/
public $quiz;
/**
* Determines if test notifications can be sent
*
* @var bool
*/
protected $testable = array(
'basic' => false,
'email' => true,
);
/**
* Callback function called when a quiz is failed by a student
*
* @param int $student_id WP User ID of a LifterLMS Student
* @param array $quiz_id WP Post ID of a LifterLMS quiz
* @return void
* @since 3.8.0
* @version 3.16.6
*/
public function action_callback( $student_id = null, $quiz_id = null ) {
$this->user_id = $student_id;
$this->post_id = $quiz_id;
$this->quiz = llms_get_post( $quiz_id );
if ( ! $this->quiz ) {
return;
}
$this->course = $this->quiz->get_course();
$this->send();
}
/**
* Get an array of LifterLMS Admin Page settings to send test notifications
*
* @param string $type notification type [basic|email]
* @return array
* @since 3.24.0
* @version 3.24.0
*/
public function get_test_settings( $type ) {
if ( 'email' !== $type ) {
return;
}
$query = new LLMS_Query_Quiz_Attempt(
array(
'per_page' => 25,
'status' => 'pass',
)
);
$options = array(
'' => '',
);
$attempts = array();
if ( $query->has_results() ) {
foreach ( $query->get_attempts() as $attempt ) {
$quiz = llms_get_post( $attempt->get( 'quiz_id' ) );
$student = llms_get_student( $attempt->get( 'student_id' ) );
if ( $attempt && $student && $quiz ) {
$options[ $attempt->get( 'id' ) ] = esc_attr( sprintf( __( 'Attempt #%1$d for Quiz "%2$s" by %3$s', 'lifterlms' ), $attempt->get( 'id' ), $quiz->get( 'title' ), $student->get_name() ) );
}
}
}
return array(
array(
'class' => 'llms-select2',
'custom_attributes' => array(
'data-allow-clear' => true,
'data-placeholder' => __( 'Select a passed quiz', 'lifterlms' ),
),
'default' => '',
'id' => 'attempt_id',
'desc' => '<br/>' . __( 'Send yourself a test notification using information from the selected quiz.', 'lifterlms' ),
'options' => $options,
'title' => __( 'Send a Test', 'lifterlms' ),
'type' => 'select',
),
);
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.8.0
* @version 3.8.0
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'course_author':
if ( $this->course ) {
$uid = $this->course->get( 'author' );
} else {
$uid = $this->quiz->post->post_author;
}
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.8.0
* @version 3.24.0
*/
public function get_title() {
return __( 'Quizzes: Quiz Passed', 'lifterlms' );
}
/**
* Send a test notification to the currently logged in users
* Extending classes should redefine this in order to properly setup the controller with post_id and user_id data
*
* @param string $type notification type [basic|email]
* @param array $data array of test notification data as specified by $this->get_test_data()
* @return int|false
* @since 3.24.0
* @version 3.24.0
*/
public function send_test( $type, $data = array() ) {
if ( empty( $data['attempt_id'] ) ) {
return;
}
$attempt = new LLMS_Quiz_Attempt( $data['attempt_id'] );
$this->user_id = $attempt->get( 'student_id' );
$this->post_id = $attempt->get( 'quiz_id' );
$this->quiz = llms_get_post( $attempt->get( 'quiz_id' ) );
$this->course = $this->quiz->get_course();
return parent::send_test( $type );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'course_author', 'no' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Quiz_Passed::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.section.complete.php
================================================
<?php
/**
* Notification Controller: Section Complete
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 3.30.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Section Complete
*
* @since 3.8.0
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Notification_Controller_Section_Complete extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'section_complete';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'lifterlms_section_completed' );
/**
* @var LLMS_Section
* @since 3.8.0
*/
public $section;
/**
* Callback function called when a section is completed by a student
*
* @param int $student_id WP User ID of a LifterLMS Student
* @param int $section_id WP Post ID of a LifterLMS Section
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function action_callback( $student_id = null, $section_id = null ) {
$this->user_id = $student_id;
$this->post_id = $section_id;
$this->section = llms_get_post( $section_id );
$this->course = $this->section->get_course();
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.8.0
* @version 3.8.0
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'course_author':
$uid = $this->course->get( 'author' );
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_title() {
return __( 'Section Complete', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'course_author', 'no' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Section_Complete::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.student.welcome.php
================================================
<?php
/**
* Notification Controller: Student Welcome
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 3.39.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Student Welcome
*
* @since 3.8.0
* @since 3.33.2 Add test send functionality.
* @since 3.39.0 Added `llms_rest_student_registered` as action hook.
*/
class LLMS_Notification_Controller_Student_Welcome extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'student_welcome';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 1;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array(
'lifterlms_user_registered',
'llms_rest_student_registered',
);
/**
* Determines if test notifications can be sent
*
* @var bool
*/
protected $testable = array(
'basic' => false,
'email' => true,
);
/**
* Callback function called when a lesson is completed by a student
*
* @since 3.8.0
*
* @param int $user_id WP_User ID.
* @return void
*/
public function action_callback( $user_id = null ) {
$this->user_id = $user_id;
$this->post_id = null;
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @since 3.8.0
*
* @param string $subscriber Subscriber type string.
* @return int|false
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Determine what types are supported
*
* Extending classes can override this function in order to add or remove support
* 3rd parties should add support via filter on $this->get_supported_types().
*
* @since 3.8.0
*
* @return array Associative array, keys are the ID/db type, values should be translated display types.
*/
protected function set_supported_types() {
return array(
'email' => __( 'Email', 'lifterlms' ),
);
}
/**
* Get an array of LifterLMS Admin Page settings to send test notifications
*
* @since 3.33.2
*
* @param string $type Notification type [basic|email]
* @return array
*/
public function get_test_settings( $type ) {
$query = new WP_User_Query(
array(
'number' => 25,
)
);
$options = array(
'' => '',
);
foreach ( $query->get_results() as $user ) {
$student = llms_get_student( $user );
if ( $student ) {
$options[ $student->get_id() ] = esc_attr( sprintf( __( '%1$s <%2$s>', 'lifterlms' ), $student->get_name(), $student->get( 'user_email' ) ) );
}
}
return array(
array(
'class' => 'llms-select2',
'custom_attributes' => array(
'data-allow-clear' => true,
'data-placeholder' => __( 'Select a user', 'lifterlms' ),
),
'default' => '',
'id' => 'user_id',
'desc' => '<br/>' . __( 'Send yourself a test notification using information for the selected user.', 'lifterlms' ),
'options' => $options,
'title' => __( 'Send a Test', 'lifterlms' ),
'type' => 'select',
),
);
}
/**
* Get the translatable title for the notification used on settings screens
*
* @since 3.8.0
*
* @return string
*/
public function get_title() {
return __( 'Student Welcome', 'lifterlms' );
}
/**
* Send a test notification to the currently logged in users
*
* Extending classes should redefine this in order to properly setup the controller with post_id and user_id data.
*
* @since 3.33.2
*
* @param string $type Notification type [basic|email].
* @param array $data Array of test notification data as specified by $this->get_test_data().
*
* @return int|false
*/
public function send_test( $type, $data = array() ) {
if ( empty( $data['user_id'] ) ) {
return;
}
$this->user_id = $data['user_id'];
$this->post_id = null;
return parent::send_test( $type );
}
/**
* Setup the subscriber options for the notification
*
* @since 3.8.0
*
* @param string $type Notification type id.
* @return array
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'email':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Student_Welcome::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.subscription.cancelled.php
================================================
<?php
/**
* Notification Controller: Subscription Cancelled (by Student)
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.17.8
* @version 3.17.8
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Subscription Cancelled (by Student)
*
* @since 3.17.8
*/
class LLMS_Notification_Controller_Subscription_Cancelled extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'subscription_cancelled';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'llms_subscription_cancelled_by_student' );
/**
* Callback function, called upon student subscription cancellation
*
* @param obj $order Instance of the LLMS_Order
* @param int $student_id WP User ID of the Student
* @return void
* @since 3.17.8
* @version 3.17.8
*/
public function action_callback( $order = null, $student_id = null ) {
$this->user_id = $student_id;
$this->post_id = $order->get( 'id' );
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.17.8
* @version 3.17.8
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'author':
$order = llms_get_post( $this->post_id );
if ( ! $order ) {
return false;
}
$product = $order->get_product();
if ( ! $product ) {
return false;
}
$uid = $product->get( 'author' );
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.17.8
* @version 3.17.8
*/
public function get_title() {
return __( 'Subscription Cancellation Notice', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.17.8
* @version 3.17.8
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'email':
$options[] = $this->get_subscriber_option_array( 'author', 'yes' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
/**
* Determine what types are supported
* Extending classes can override this function in order to add or remove support
* 3rd parties should add support via filter on $this->get_supported_types()
*
* @return array associative array, keys are the ID/db type, values should be translated display types
* @since 3.17.8
* @version 3.17.8
*/
protected function set_supported_types() {
return array(
'email' => __( 'Email', 'lifterlms' ),
);
}
}
return LLMS_Notification_Controller_Subscription_Cancelled::instance();
================================================
FILE: includes/notifications/controllers/class.llms.notification.controller.upcoming.payment.reminder.php
================================================
<?php
/**
* Notification Controller: Upcoming Payment Reminder
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 5.2.0
* @version 5.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Upcoming Payment Reminder
*
* @since 5.2.0
*/
class LLMS_Notification_Controller_Upcoming_Payment_Reminder extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var string
*/
public $id = 'upcoming_payment_reminder';
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array(
'llms_send_upcoming_payment_reminder_notification',
);
/**
* Determines if test notifications can be sent
*
* @var bool
*/
protected $testable = array(
'basic' => false,
'email' => true,
);
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Add an action to trigger the notification to send
*
* @since 5.2.0
*
* @return void
*/
protected function add_actions() {
parent::add_actions();
// Add actions to recurring payment scheduling/unscheduling.
add_action( 'llms_charge_recurring_payment_scheduled', array( $this, 'schedule_upcoming_payment_reminders' ), 10, 2 );
add_action( 'llms_charge_recurring_payment_unscheduled', array( $this, 'unschedule_upcoming_payment_reminders' ) );
}
/**
* Callback function called when the upcoming payment reminder notification is fired
*
* @since 5.2.0
*
* @param int $order_id WP Post ID of the order.
* @param string $type The notification type identifier.
* @return boolean
*/
public function action_callback( $order_id = null, $type = null ) {
// Make sure order_id and type have been provided.
if ( ! $order_id || ! $type ) {
return false;
}
// These checks are basically the same we do in LLMS_Controller_Orders::recurring_charge().
// Recurring payments disabled as a site feature when in staging mode.
if ( ! LLMS_Site::get_feature( 'recurring_payments' ) ) {
return false;
}
$order = llms_get_post( $order_id );
// Make sure the order still exists.
if ( ! $order || ! is_a( $order, 'LLMS_Order' ) ) {
return false;
}
$user_id = $order->get( 'user_id' );
// Check the user still exists.
if ( ! get_user_by( 'id', $user_id ) ) {
return false;
}
// Ensure Gateway is still available and supports recurring payments.
$gateway = $order->get_gateway();
if ( is_wp_error( $gateway ) || ! $gateway->supports( 'recurring_payments' ) ) {
return false;
}
$this->user_id = $user_id;
$this->post_id = $order->get( 'id' );
$this->send( false, array( $type ) );
return true;
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID.
*
* @since 5.2.0
*
* @param string $subscriber Subscriber type string.
* @return int|false
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'author':
$order = llms_get_post( $this->post_id );
if ( ! is_a( $order, 'LLMS_Order' ) ) {
return false;
}
$product = $order->get_product();
if ( is_a( $product, 'WP_Post' ) ) {
return false;
}
$uid = $product->get( 'author' );
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
*
* Used on settings screens.
*
* @since 5.2.0
*
* @return string
*/
public function get_title() {
return __( 'Upcoming Payment Reminder', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @since 5.2.0
*
* @param string $type The notification type identifier.
* @return array
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'author', 'no' );
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
/**
* Cancels scheduled upcoming payment reminder notifications
*
* Does nothing if no payments are scheduled.
*
* @since 5.2.0
*
* @param LLMS_Order $order Instance of the LLMS_Order which we'll schedule the payment reminder for.
* @return void
*/
public function unschedule_upcoming_payment_reminders( $order ) {
$types = array_keys( $this->get_supported_types() );
foreach ( $types as $type ) {
$this->unschedule_upcoming_payment_reminder( $order, $type );
}
}
/**
* Cancels a scheduled upcoming payment reminder notification type
*
* Does nothing if no payments are scheduled.
*
* @since 5.2.0
*
* @param LLMS_Order $order Instance of the LLMS_Order which we'll schedule the payment reminder for.
* @param string $type The notification type identifier.
* @return void
*/
public function unschedule_upcoming_payment_reminder( $order, $type ) {
$action_args = $this->get_recurring_payment_reminder_action_args( $order, $type );
if ( as_next_scheduled_action( 'llms_send_upcoming_payment_reminder_notification', $action_args ) ) {
as_unschedule_action( 'llms_send_upcoming_payment_reminder_notification', $action_args );
}
}
/**
* Schedule upcoming payment reminder notification
*
* @since 5.2.0
*
* @param LLMS_Order $order Instance of the LLMS_Order which we'll schedule the payment reminder for.
* @param int $payment_date Optional. The upcoming payment due date in Unix time format and UTC. Default is 0.
* When not provided it'll be calculated from the order.
* @return array
*/
public function schedule_upcoming_payment_reminders( $order, $payment_date = 0 ) {
$types = array_keys( $this->get_supported_types() );
$return = array();
foreach ( $types as $type ) {
$return[ $type ] = $this->schedule_upcoming_payment_reminder( $order, $type, $payment_date );
}
return $return;
}
/**
* Schedule upcoming payment reminder notification
*
* @since 5.2.0
*
* @param LLMS_Order $order Instance of the LLMS_Order which we'll schedule the payment reminder for.
* @param string $type The notification type identifier.
* @param int $payment_date Optional. The upcoming payment due date in Unix time format and UTC. Default is 0.
* When not provided it'll be calculated from the order.
* @return WP_Error|int WP_Error either if there's no reminder date or if it's passed. Otherwise returns the return value of `as_schedule_single_action`: the action's ID.
*/
public function schedule_upcoming_payment_reminder( $order, $type, $payment_date = 0 ) {
$action_args = $this->get_recurring_payment_reminder_action_args( $order, $type );
// Unschedule upcoming payment reminder (does nothing if no action scheduled).
$this->unschedule_upcoming_payment_reminder( $order, $type );
// Convert our reminder date to Unix Time and UTC before passing to the scheduler.
$reminder_date = $this->get_upcoming_payment_reminder_date( $order, $type, $payment_date );
// If no reminder date.
if ( is_wp_error( $reminder_date ) ) {
return $reminder_date;
}
// Or reminder date set in the past.
if ( $reminder_date < llms_current_time( 'U', true ) ) {
return new WP_Error( 'upcoming-payment-reminder-passed', __( 'Upcoming payment reminder passed', 'lifterlms' ) );
}
// Schedule upcoming payment reminder.
return as_schedule_single_action(
$reminder_date,
'llms_send_upcoming_payment_reminder_notification',
$action_args
);
}
/**
* Retrieve the date to remind user before actual payment
*
* @since 5.2.0
*
* @param LLMS_Order $order Instance of the LLMS_Order which we'll schedule the payment reminder for.
* @param string $type The notification type identifier.
* @param integer $payment_date Optional. The upcoming payment due date in Unix time format and UTC. Default is 0.
* When not provided it'll be calculated from the order.
* @return WP_Error|integer Returns a WP_Error if there's no payment scheduled, otherwise the reminder date in Unix format and UTC.
*/
private function get_upcoming_payment_reminder_date( $order, $type, $payment_date = 0 ) {
$next_payment_date = $payment_date ? $payment_date : $order->get_recurring_payment_due_date_for_scheduler();
if ( is_wp_error( $next_payment_date ) ) {
return $next_payment_date;
}
/**
* Filters the number of days before the upcoming payment due date when to notify the customer
*
* The dynamic portion of this filter, `$this->id`, refers to the notification trigger identifier.
*
* @since 5.2.0
*
* @param integer $days The number of days before the upcoming payment due date when to notify the customer.
* @param LLMS_Order $order Order object.
* @param string $type The notification type identifier.
*/
$days = apply_filters( "llms_notification_{$this->id}_reminder_days", $this->get_reminder_days( $type ), $order, $type );
// Sanitize: makes sure it's always a negative number.
$days = -1 * max( 1, absint( $days ) );
/**
* Filters the next upcoming payment reminder date
*
* The dynamic portion of this filter, `$this->id`, refers to the notification trigger identifier.
*
* @since 5.2.0
*
* @param integer $upcoming_payment_reminder_time Unix timestamp for the next payment due date.
* @param LLMS_Order $order Order object.
* @param string $type The notification type identifier.
*/
$upcoming_payment_reminder_time = apply_filters( "llms_notification_{$this->id}_reminder_date", strtotime( "{$days} day", $next_payment_date ), $order, $type );
return $upcoming_payment_reminder_time;
}
/**
* Retrieve arguments passed to order-related events processed by the action scheduler
*
* @since 5.2.0
*
* @param LLMS_Order $order Instance of the LLMS_Order which we'll schedule the payment reminder for.
*/
private function get_recurring_payment_reminder_action_args( $order, $type ) {
return array(
'order_id' => $order->get( 'id' ),
'type' => $type,
);
}
/**
* Set array of additional options to be added to the notification view in the admin panel
*
* @since 5.2.0
*
* @param string $type Type of the notification.
* @return array
*/
protected function set_additional_options( $type ) {
return array(
array(
'id' => $this->get_option_name( $type . '_reminder_days' ),
'title' => __( 'Reminder days', 'lifterlms' ),
'desc' => '<br>' . __( 'The number of days before the upcoming payment due date when to notify the customer.', 'lifterlms' ),
'type' => 'number',
'value' => $this->get_reminder_days( $type ),
'custom_attributes' => array(
'min' => 1,
),
),
);
}
/**
* Get an array of LifterLMS Admin Page settings to send test notifications
*
* Retrieves 25 recurring orders with an existing next payment date.
*
* @since 5.2.0
*
* @param string $type Notification type [basic|email].
* @return array
*/
public function get_test_settings( $type ) {
$query = new WP_Query(
array(
'post_type' => 'llms_order',
'posts_per_page' => 25,
'post_status' => array( 'llms-active', 'llms-failed', 'llms-on-hold', 'llms-pending', 'llms-pending-cancel' ),
'meta_query' => array(
'relation' => 'and',
array(
'key' => '_llms_order_type',
'value' => 'recurring',
'compare' => '=',
),
array(
'key' => '_llms_date_next_payment',
'compare' => 'EXISTS',
),
),
'no_found_rows' => true,
'order_by' => 'ID',
)
);
$options = array(
'' => '',
);
foreach ( $query->posts as $post ) {
$order = llms_get_post( $post );
$student = llms_get_student( $order->get( 'user_id' ) );
if ( $order && $student ) {
$options[ $order->get( 'id' ) ] = esc_attr(
sprintf(
// Translators: %1$d = The Order ID; %2$s The customer's full name; %3$s The product title.
__( 'Order #%1$d from %2$s for "%3$s"', 'lifterlms' ),
$order->get( 'id' ),
$student->get_name(),
$order->get( 'product_title' )
)
);
}
}
return array(
array(
'class' => 'llms-select2',
'custom_attributes' => array(
'data-allow-clear' => true,
'data-placeholder' => __( 'Select a recurring order', 'lifterlms' ),
),
'default' => '',
'id' => 'order_id',
'desc' => '<br/>' . __( 'Send yourself a test notification using information from the selected recurring order.', 'lifterlms' ),
'options' => $options,
'title' => __( 'Send a Test', 'lifterlms' ),
'type' => 'select',
),
);
}
/**
* Send a test notification to the currently logged in users
*
* @since 5.2.0
*
* @param string $type Notification type [basic|email].
* @param array $data Array of test notification data as specified by $this->get_test_data().
*
* @return int|false
*/
public function send_test( $type, $data = array() ) {
if ( empty( $data['order_id'] ) ) {
return;
}
$order = llms_get_post( $data['order_id'] );
$this->user_id = $order->get( 'user_id' );
$this->post_id = $order->get( 'id' );
return parent::send_test( $type );
}
/**
* Undocumented function
*
* @since 5.2.0
*
* @param string $type The notification type identifier.
* @param int $default Opional. The default value. Default is `1`.
* @return int
*/
private function get_reminder_days( $type, $default = 1 ) {
return $this->get_option( $type . '_reminder_days', $default );
}
}
return LLMS_Notification_Controller_Upcoming_Payment_Reminder::instance();
================================================
FILE: includes/notifications/controllers/index.php
================================================
<?php // quiet.
================================================
FILE: includes/notifications/index.php
================================================
<?php // quiet.
================================================
FILE: includes/notifications/processors/class.llms.notification.processor.email.php
================================================
<?php
/**
* Notification Background Processor: Emails
*
* @package LifterLMS/Notifications/Processors/Classes
*
* @since 3.8.0
* @version 7.1.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Background Processor: Emails
*
* @since 3.8.0
* @since 3.10.1 Unknown.
* @since 3.33.2 Improve data logged during errors.
*/
class LLMS_Notification_Processor_Email extends LLMS_Abstract_Notification_Processor {
/**
* action name
*
* @var string
*/
protected $action = 'llms_notification_processor_email';
/**
* Processes an item in the queue.
*
* @since 3.8.0
* @since 3.10.1 Unknown.
* @since 3.33.2 Log additional data during errors.
* @since 7.1.0 Catch possible fatals and in that case remove from the queue the item that produced them.
*
* @param int $notification_id ID of an LLMS_Notification.
* @return bool `false` removes item from queue, `true` retain for further processing.
*/
protected function task( $notification_id ) {
$this->log( sprintf( 'sending email notification ID #%d', $notification_id ) );
try {
$notification = new LLMS_Notification( $notification_id );
$view = $notification->get_view();
if ( ! $view ) {
$this->log( 'ID#' . $notification_id );
return false;
}
// Setup the email.
$mailer = llms()->mailer()->get_email( 'notification' );
if ( ! $mailer->add_recipient( $notification->get( 'subscriber' ), 'to' ) ) {
$this->log( sprintf( 'Error sending email notification ID #%d - subscriber does not exist', $notification_id ) );
$this->log( $notification->toArray() );
$notification->set( 'status', 'error' );
return false;
}
$mailer->set_subject( $view->get_subject() )->set_heading( $view->get_title() )->set_body( $view->get_html() );
} catch ( Error $e ) {
$this->log( sprintf( 'Error sending email notification ID #%d', $notification_id ) );
$this->log( sprintf( 'Error caught %1$s in %2$s on line %3$s', $e->getMessage(), $e->getFile(), $e->getLine() ) );
$notification->set( 'status', 'error' );
return false;
}
// Log when wp_mail fails.
if ( $mailer->send() ) {
$notification->set( 'status', 'sent' );
} else {
$this->log( sprintf( 'Error sending email notification ID #%d', $notification_id ) );
$this->log( $notification->toArray() );
}
return false;
}
}
return new LLMS_Notification_Processor_Email();
================================================
FILE: includes/notifications/processors/index.php
================================================
<?php // quiet.
================================================
FILE: includes/notifications/views/class.llms.notification.view.achievement.earned.php
================================================
<?php
/**
* Notification View: Achievement Earned
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.8.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Achievement Earned
*
* @since 3.8.0
* @since 3.17.6 Unknown.
* @since 3.30.3 Fixed spelling errors.
*/
class LLMS_Notification_View_Achievement_Earned extends LLMS_Abstract_Notification_View {
/**
* Settings for basic notifications
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification
* before automatically dismissing it
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications
*/
'dismissible' => true,
);
/**
* Notification Trigger ID
*
* @var string
*/
public $trigger_id = 'achievement_earned';
/**
* Setup body content for output
*
* @since 3.8.0
*
* @return string
*/
protected function set_body() {
ob_start();
?>
<p style="text-align: center;">{{ACHIEVEMENT_IMAGE}}</p>
<h2 style="text-align: center;"><strong>{{ACHIEVEMENT_TITLE}}</strong></h2>
<p style="text-align: center;">{{ACHIEVEMENT_CONTENT}}</p>
<?php
return ob_get_clean();
}
/**
* Setup footer content for output
*
* @since 3.8.0
*
* @return string
*/
protected function set_footer() {
return '';
}
/**
* Setup notification icon for output
*
* @since 3.8.0
*
* @return string
*/
protected function set_icon() {
return '';
}
/**
* Setup merge codes that can be used with the notification
*
* @since 3.8.0
* @since 3.30.3 Fixed spelling errors.
*
* @return array
*/
protected function set_merge_codes() {
return array(
'{{ACHIEVEMENT_CONTENT}}' => __( 'Achievement Content', 'lifterlms' ),
'{{ACHIEVEMENT_IMAGE}}' => __( 'Achievement Image', 'lifterlms' ),
'{{ACHIEVEMENT_IMAGE_URL}}' => __( 'Achievement Image URL', 'lifterlms' ),
'{{ACHIEVEMENT_TITLE}}' => __( 'Achievement Title', 'lifterlms' ),
'{{STUDENT_NAME}}' => __( 'Student Name', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values
*
* @since 3.8.0
* @since 3.8.2 Unknown.
* @since 4.7.0 Use `achievement_title` in favor of `title` for the {{ACHIEVEMENT_TITLE}} merge code.
* @since 6.0.0 Use `title` in favor of deprecated `achievement_title` meta key for the {{ACHIEVEMENT_TITLE}} merge code.
*
* @param string $code The merge code to get merged data for.
* @return string
*/
protected function set_merge_data( $code ) {
$achievement = new LLMS_User_Achievement( $this->post );
switch ( $code ) {
case '{{ACHIEVEMENT_CONTENT}}':
$code = $achievement->get( 'content' );
break;
case '{{ACHIEVEMENT_IMAGE}}':
$title = $this->set_merge_data( '{{ACHIEVEMENT_TITLE}}' );
$url = $this->set_merge_data( '{{ACHIEVEMENT_IMAGE_URL}}' );
$code = '<img alt="' . sprintf( _x( '%s Icon', 'Achievement icon alt text', 'lifterlms' ), $title ) . '" src="' . $url . '">';
break;
case '{{ACHIEVEMENT_IMAGE_URL}}':
$code = $achievement->get_image( 'medium', 'achievement_image' );
if ( ! $code ) {
$code = apply_filters( 'lifterlms_placeholder_img_src', llms()->plugin_url() . '/assets/images/optional_achievement.png' );
}
break;
case '{{ACHIEVEMENT_TITLE}}':
$code = $achievement->get( 'title' );
break;
case '{{STUDENT_NAME}}':
$code = $this->is_for_self() ? __( 'you', 'lifterlms' ) : $this->user->get_name();
break;
}
return $code;
}
/**
* Setup notification subject for output
*
* @since 3.8.0
*
* @return string
*/
protected function set_subject() {
return '';
}
/**
* Setup notification title for output
*
* @since 3.8.0
*
* @return string
*/
protected function set_title() {
return __( 'You\'ve been awarded an achievement!', 'lifterlms' );
}
/**
* Define field support for the view
*
* @since 3.8.0
*
* @return array
*/
protected function set_supported_fields() {
return array(
'basic' => array(
'body' => true,
'title' => true,
'icon' => false,
),
);
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.certificate.earned.php
================================================
<?php
/**
* Notification View: Certificate Earned
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.8.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Certificate Earned
*
* @since 3.8.0
*/
class LLMS_Notification_View_Certificate_Earned extends LLMS_Abstract_Notification_View {
/**
* Settings for basic notifications
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification
* before automatically dismissing it
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications
*/
'dismissible' => true,
);
/**
* Notification Trigger ID
*
* @var string
*/
public $trigger_id = 'certificate_earned';
/**
* Get the HTML for the mini certificate preview.
*
* @since Unknown
* @since 6.0.0 Removed `$content` parameter & updated HTML to display a placeholder.
*
* @param string $title The (merged) certificate title.
* @return string
*/
private function get_mini_html( $title ) {
ob_start();
?>
<div class="llms-mini-cert">
<h2 class="llms-mini-cert-title"><?php echo wp_kses_post( $title ); ?></h2>
<div class="llms-mini-cert--body ">
<div class="llms-mini-cert--mock-line"></div>
<div class="llms-mini-cert--mock-line"></div>
<div class="llms-mini-cert--mock-line"></div>
<div class="llms-mini-cert--mock-line"></div>
<div class="llms-mini-cert--mock-line"></div>
<div class="llms-mini-cert--mock-dot"></div>
<div class="llms-mini-cert--mock-line"></div>
</div>
</div>
<?php
return ob_get_clean();
}
/**
* Setup body content for output.
*
* @since 3.8.0
*
* @return string
*/
protected function set_body() {
return '{{MINI_CERTIFICATE}}';
}
/**
* Setup footer content for output.
*
* @since 3.8.0
*
* @return string
*/
protected function set_footer() {
$url = $this->set_merge_data( '{{CERTIFICATE_URL}}' );
return '<a href="' . esc_url( $url ) . '">' . __( 'View Full Certificate', 'lifterlms' ) . '</a>';
}
/**
* Setup notification icon for output.
*
* @since 3.8.0
*
* @return string
*/
protected function set_icon() {
return $this->get_icon_default( 'positive' );
}
/**
* Setup merge codes that can be used with the notification.
*
* @since 3.8.0
*
* @return array
*/
protected function set_merge_codes() {
return array(
'{{CERTIFICATE_CONTENT}}' => __( 'Certificate Content', 'lifterlms' ),
'{{CERTIFICATE_TITLE}}' => __( 'Certificate Title', 'lifterlms' ),
'{{CERTIFICATE_URL}}' => __( 'Certificate URL', 'lifterlms' ),
'{{STUDENT_NAME}}' => __( 'Student Name', 'lifterlms' ),
'{{MINI_CERTIFICATE}}' => __( 'Mini Certificate', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values.
*
* @since 3.8.0
* @since 3.16.6 Unknown.
* @since 6.0.0 Refactor to give each merge code it's own method.
*
* @param string $code The merge code to get merged data for.
* @return string The merged string or the original code for invalid merge codes.
*/
protected function set_merge_data( $code ) {
if ( in_array( $code, array_keys( $this->set_merge_codes() ), true ) ) {
$method = 'set_merge_data_' . strtolower( str_replace( array( '{{', '}}' ), '', $code ) );
$code = method_exists( $this, $method ) ? $this->$method( new LLMS_User_Certificate( $this->notification->post_id ) ) : $code;
}
return $code;
}
/**
* Get merge data for the {{CERTIFICATE_CONTENT}} merge code.
*
* @since 6.0.0
*
* @param LLMS_User_Certificate $cert Earned certificate object.
* @return string
*/
private function set_merge_data_certificate_content( $cert ) {
return $cert->get( 'content' );
}
/**
* Get merge data for the {{CERTIFICATE_TITLE}} merge code.
*
* @since 6.0.0
*
* @param LLMS_User_Certificate $cert Earned certificate object.
* @return string
*/
private function set_merge_data_certificate_title( $cert ) {
return $cert->get( 'title' );
}
/**
* Get merge data for the {{CERTIFICATE_URL}} merge code.
*
* @since 6.0.0
*
* @param LLMS_User_Certificate $cert Earned certificate object.
* @return string
*/
private function set_merge_data_certificate_url( $cert ) {
return get_permalink( $cert->get( 'id' ) );
}
/**
* Get merge data for the {{MINI_CERTIFICATE}} merge code.
*
* @since 6.0.0
*
* @param LLMS_User_Certificate $cert Earned certificate object.
* @return string
*/
private function set_merge_data_mini_certificate( $cert ) {
return $this->get_mini_html( $this->set_merge_data( '{{CERTIFICATE_TITLE}}' ) );
}
/**
* Get merge data for the {{STUDENT_NAME}} merge code.
*
* @since 6.0.0
*
* @param LLMS_User_Certificate $cert Earned certificate object.
* @return string
*/
private function set_merge_data_student_name( $cert ) {
return $this->is_for_self() ? __( 'you', 'lifterlms' ) : $this->user->get_name();
}
/**
* Setup notification subject for output.
*
* @since 3.8.0
*
* @return string
*/
protected function set_subject() {
return '';
}
/**
* Setup notification title for output.
*
* @since 3.8.0
*
* @return string
*/
protected function set_title() {
return __( 'You\'ve earned a certificate!', 'lifterlms' );
}
/**
* Defines field support for the view.
*
* @since 3.8.0
*
* @return array
*/
protected function set_supported_fields() {
return array(
'basic' => array(
'body' => true,
'title' => true,
'icon' => true,
),
);
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.course.complete.php
================================================
<?php
/**
* Notification View: Course Complete
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.8.0
* @version 3.8.2
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Course Complete
*
* @since 3.8.0
* @since 3.8.2 Unknown.
*/
class LLMS_Notification_View_Course_Complete extends LLMS_Abstract_Notification_View {
/**
* Settings for basic notifications
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification
* before automatically dismissing it
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications
*/
'dismissible' => true,
);
/**
* Notification Trigger ID
*
* @var [type]
*/
public $trigger_id = 'course_complete';
/**
* Setup body content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_body() {
if ( 'email' === $this->notification->get( 'type' ) ) {
return sprintf( __( 'Congratulations! %1$s completed %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{COURSE_TITLE}}' );
}
return sprintf( __( 'Congratulations! You finished %s', 'lifterlms' ), '{{COURSE_TITLE}}' );
}
/**
* Setup footer content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_footer() {
return '';
}
/**
* Setup notification icon for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_icon() {
return $this->get_icon_default( 'positive' );
}
/**
* Setup merge codes that can be used with the notification
*
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_merge_codes() {
return array(
'{{COURSE_TITLE}}' => __( 'Course Title', 'lifterlms' ),
'{{STUDENT_NAME}}' => __( 'Student Name', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values
*
* @param string $code the merge code to ge merged data for
* @return string
* @since 3.8.0
* @version 3.8.2
*/
protected function set_merge_data( $code ) {
switch ( $code ) {
case '{{COURSE_TITLE}}':
$code = $this->post->get( 'title' );
break;
case '{{STUDENT_NAME}}':
$code = $this->is_for_self() ? __( 'you', 'lifterlms' ) : $this->user->get_name();
break;
}
return $code;
}
/**
* Setup notification subject for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subject() {
return sprintf( __( 'Congratulations! %1$s completed %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{COURSE_TITLE}}' );
}
/**
* Setup notification title for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_title() {
return sprintf( __( '%s Completed a Course', 'lifterlms' ), '{{STUDENT_NAME}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.course.track.complete.php
================================================
<?php
/**
* Notification View: Course Track Complete
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.8.0
* @version 3.8.2
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Course Track Complete
*
* @since 3.8.0
* @since 3.8.2 Unknown.
*/
class LLMS_Notification_View_Course_Track_Complete extends LLMS_Abstract_Notification_View {
/**
* Settings for basic notifications
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification
* before automatically dismissing it
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications
*/
'dismissible' => true,
);
/**
* Notification Trigger ID
*
* @var [type]
*/
public $trigger_id = 'course_track_complete';
/**
* Setup body content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_body() {
if ( 'email' === $this->notification->get( 'type' ) ) {
return sprintf( __( 'Congratulations! %1$s completed %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{TRACK_TITLE}}' );
}
return sprintf( __( 'Congratulations! You finished %s', 'lifterlms' ), '{{TRACK_TITLE}}' );
}
/**
* Setup footer content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_footer() {
return '';
}
/**
* Setup notification icon for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_icon() {
return $this->get_icon_default( 'positive' );
}
/**
* Setup merge codes that can be used with the notification
*
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_merge_codes() {
return array(
'{{TRACK_TITLE}}' => __( 'Track Title', 'lifterlms' ),
'{{STUDENT_NAME}}' => __( 'Student Name', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values
*
* @param string $code the merge code to ge merged data for
* @return string
* @since 3.8.0
* @version 3.8.2
*/
protected function set_merge_data( $code ) {
switch ( $code ) {
case '{{TRACK_TITLE}}':
$track = new LLMS_Track( $this->notification->get( 'post_id' ) );
$code = $track->get_title();
break;
case '{{STUDENT_NAME}}':
$code = $this->is_for_self() ? __( 'you', 'lifterlms' ) : $this->user->get_name();
break;
}
return $code;
}
/**
* Setup notification subject for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subject() {
return sprintf( __( 'Congratulations! %1$s completed %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{TRACK_TITLE}}' );
}
/**
* Setup notification title for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_title() {
return sprintf( __( '%s Completed a Track', 'lifterlms' ), '{{STUDENT_NAME}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.enrollment.php
================================================
<?php
/**
* Notification View: Course/Membership Enrollment
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.8.0
* @version 3.8.2
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Course/Membership Enrollment
*
* @since 3.8.0
* @since 3.8.2 Unknown.
*/
class LLMS_Notification_View_Enrollment extends LLMS_Abstract_Notification_View {
/**
* Settings for basic notifications
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification
* before automatically dismissing it
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications
*/
'dismissible' => true,
);
/**
* Notification Trigger ID
*
* @var [type]
*/
public $trigger_id = 'enrollment';
/**
* Setup body content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_body() {
return sprintf( __( 'Congratulations! %1$s enrolled in %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{TITLE}}' );
}
/**
* Setup footer content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_footer() {
return '';
}
/**
* Setup notification icon for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_icon() {
return $this->get_icon_default( 'positive' );
}
/**
* Setup merge codes that can be used with the notification
*
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_merge_codes() {
return array(
'{{TITLE}}' => __( 'Title', 'lifterlms' ),
'{{TYPE}}' => __( 'Type (Course or Membership)', 'lifterlms' ),
'{{STUDENT_NAME}}' => __( 'Student Name', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values
*
* @param string $code the merge code to ge merged data for
* @return string
* @since 3.8.0
* @version 3.8.2
*/
protected function set_merge_data( $code ) {
switch ( $code ) {
case '{{TITLE}}':
$code = $this->post->get( 'title' );
break;
case '{{TYPE}}':
$code = $this->post->get_post_type_label();
break;
case '{{STUDENT_NAME}}':
$code = $this->is_for_self() ? __( 'you', 'lifterlms' ) : $this->user->get_name();
break;
}
return $code;
}
/**
* Setup notification subject for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subject() {
return sprintf( __( '%1$s enrolled in %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{TITLE}}' );
}
/**
* Setup notification title for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_title() {
return sprintf( __( '%1$s enrollment success!', 'lifterlms' ), '{{TYPE}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.lesson.complete.php
================================================
<?php
/**
* Notification View: Lesson Complete
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.8.0
* @version 3.10.1
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Lesson Complete
*
* @since 3.8.0
* @since 3.10.1 Unknown.
*/
class LLMS_Notification_View_Lesson_Complete extends LLMS_Abstract_Notification_View {
/**
* Settings for basic notifications
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification
* before automatically dismissing it
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications
*/
'dismissible' => true,
);
/**
* Notification Trigger ID
*
* @var [type]
*/
public $trigger_id = 'lesson_complete';
/**
* Setup body content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_body() {
if ( 'email' === $this->notification->get( 'type' ) ) {
return sprintf( __( 'Congratulations! %1$s completed %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{LESSON_TITLE}}' );
}
$content = sprintf( __( 'Congratulations! You finished %s', 'lifterlms' ), '{{LESSON_TITLE}}' );
$content .= "\r\n\r\n{{COURSE_PROGRESS}}";
return $content;
}
/**
* Setup footer content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_footer() {
return '';
}
/**
* Setup notification icon for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_icon() {
return $this->get_icon_default( 'positive' );
}
/**
* Setup merge codes that can be used with the notification
*
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_merge_codes() {
return array(
'{{COURSE_PROGRESS}}' => __( 'Course Progress Bar', 'lifterlms' ),
'{{COURSE_TITLE}}' => __( 'Course Title', 'lifterlms' ),
'{{LESSON_TITLE}}' => __( 'Lesson Title', 'lifterlms' ),
'{{STUDENT_NAME}}' => __( 'Student Name', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values
*
* @param string $code the merge code to ge merged data for
* @return string
* @since 3.8.0
* @version 3.10.1
*/
protected function set_merge_data( $code ) {
switch ( $code ) {
case '{{COURSE_PROGRESS}}':
$progress = $this->user->get_progress( $this->post->get( 'parent_course' ), 'course' );
$code = lifterlms_course_progress_bar( $progress, false, false, false );
break;
case '{{COURSE_TITLE}}':
$course = $this->post->get_course();
if ( $course ) {
$code = $course->get( 'title' );
} else {
$code = '';
}
break;
case '{{LESSON_TITLE}}':
$code = $this->post->get( 'title' );
break;
case '{{STUDENT_NAME}}':
$code = $this->is_for_self() ? __( 'you', 'lifterlms' ) : $this->user->get_name();
break;
}
return $code;
}
/**
* Setup notification subject for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subject() {
return sprintf( __( 'Congratulations! %1$s completed %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{LESSON_TITLE}}' );
}
/**
* Setup notification title for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_title() {
return sprintf( __( '%s Completed a Lesson', 'lifterlms' ), '{{STUDENT_NAME}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.manual.payment.due.php
================================================
<?php
/**
* Notification View: Payment Due.
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.10.0
* @version 5.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Payment Due.
*
* @since 3.10.0
*/
class LLMS_Notification_View_Manual_Payment_Due extends LLMS_Abstract_Notification_View {
/**
* Settings for basic notifications.
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification before automatically dismissing it
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications
*/
'dismissible' => true,
);
/**
* Notification Trigger ID.
*
* @var string
*/
public $trigger_id = 'manual_payment_due';
/**
* Setup body content for output.
*
* @since 3.10.0
*
* @return string
*/
protected function set_body() {
if ( 'email' === $this->notification->get( 'type' ) ) {
return $this->set_body_email();
}
return $this->set_body_basic();
}
/**
* Setup default notification body for basic notifications.
*
* @since 3.10.0
*/
private function set_body_basic() {
return __( 'Head over to your dashboard for payment instructions.', 'lifterlms' );
}
/**
* Setup default notification body for email notifications.
*
* @since 3.10.0
* @since 5.2.0 Build the table with mailer helper.
*/
private function set_body_email() {
$mailer = llms()->mailer();
$rows = array(
'NEXT_PAYMENT_DATE' => __( 'Payment Due Date', 'lifterlms' ),
'PRODUCT_TITLE_LINK' => '{{PRODUCT_TYPE}}',
'PLAN_TITLE' => __( 'Plan', 'lifterlms' ),
'PAYMENT_AMOUNT' => __( 'Amount', 'lifterlms' ),
);
ob_start();
?><p><?php printf( esc_html__( 'Hello %s,', 'lifterlms' ), '{{CUSTOMER_NAME}}' ); ?></p>
<p><?php printf( esc_html__( 'A payment for your subscription to %1$s is due.', 'lifterlms' ), '{{PRODUCT_TITLE}}' ); ?></p>
<p><?php printf( esc_html__( 'Sign in to your account and %1$spay now%2$s.', 'lifterlms' ), '<a href="{{ORDER_URL}}">', '</a>' ); ?></p>
<h4><?php printf( esc_html__( 'Order #%s', 'lifterlms' ), '{{ORDER_ID}}' ); ?></h4>
<?php
$mailer->output_table_html( $rows );
?>
<p><a href="{{ORDER_URL}}"><?php esc_html_e( 'Pay Invoice', 'lifterlms' ); ?></a></p>
<?php
return ob_get_clean();
}
/**
* Setup footer content for output.
*
* @since 3.10.0
*
* @return string
*/
protected function set_footer() {
$url = $this->set_merge_data( '{{ORDER_URL}}' );
return '<a href="' . esc_url( $url ) . '">' . esc_html__( 'Pay Now', 'lifterlms' ) . '</a>';
}
/**
* Setup notification icon for output.
*
* @since 3.10.0
*
* @return string
*/
protected function set_icon() {
return $this->get_icon_default( 'warning' );
}
/**
* Setup merge codes that can be used with the notification.
*
* @since 3.10.0
*
* @return array
*/
protected function set_merge_codes() {
return array(
'{{CUSTOMER_ADDRESS}}' => __( 'Customer Address', 'lifterlms' ),
'{{CUSTOMER_NAME}}' => __( 'Customer Name', 'lifterlms' ),
'{{CUSTOMER_PHONE}}' => __( 'Customer Phone', 'lifterlms' ),
'{{NEXT_PAYMENT_DATE}}' => __( 'Next Payment Date', 'lifterlms' ),
'{{ORDER_ID}}' => __( 'Order ID', 'lifterlms' ),
'{{ORDER_URL}}' => __( 'Order URL', 'lifterlms' ),
'{{PAYMENT_AMOUNT}}' => __( 'Payment Amount', 'lifterlms' ),
'{{PLAN_TITLE}}' => __( 'Plan Title', 'lifterlms' ),
'{{PRODUCT_TITLE}}' => __( 'Product Title', 'lifterlms' ),
'{{PRODUCT_TYPE}}' => __( 'Product Type', 'lifterlms' ),
'{{PRODUCT_TITLE_LINK}}' => __( 'Product Title (Link)', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values.
*
* @since 3.10.0
* @since 5.2.0 Retrieve the customer's full address using the proper order's method.
* @since 5.4.0 Account for deleted products.
*
* @param string $code The merge code to get merged data for.
* @return string
*/
protected function set_merge_data( $code ) {
$order = $this->post;
switch ( $code ) {
case '{{CUSTOMER_ADDRESS}}':
$code = $order->get_customer_full_address();
break;
case '{{CUSTOMER_NAME}}':
$code = $order->get_customer_name();
break;
case '{{CUSTOMER_PHONE}}':
$code = $order->get( 'billing_phone' );
break;
case '{{NEXT_PAYMENT_DATE}}':
$code = $order->get_date( 'date_next_payment', get_option( 'date_format' ) . ' ' . get_option( 'time_format' ) );
break;
case '{{ORDER_ID}}':
$code = $order->get( 'id' );
break;
case '{{ORDER_URL}}':
$code = esc_url( $order->get_view_link() );
break;
case '{{PAYMENT_AMOUNT}}':
$code = $order->get_price( 'total' );
break;
case '{{PLAN_TITLE}}':
$code = $order->get( 'plan_title' );
break;
case '{{PRODUCT_TITLE}}':
$code = $order->get( 'product_title' );
break;
case '{{PRODUCT_TITLE_LINK}}':
$permalink = esc_url( get_permalink( $order->get( 'product_id' ) ) );
if ( $permalink ) {
$title = $this->set_merge_data( '{{PRODUCT_TITLE}}' );
$code = '<a href="' . $permalink . '">' . $title . '</a>';
}
break;
case '{{PRODUCT_TYPE}}':
$obj = $order->get_product();
if ( empty( $obj ) ) {
$code = __( '[DELETED ITEM]', 'lifterlms' );
} elseif ( is_a( $obj, 'WP_Post' ) ) {
$code = _x( 'Item', 'generic product type description', 'lifterlms' );
} else {
$code = $obj->get_post_type_label( 'singular_name' );
}
break;
}
return $code;
}
/**
* Setup notification subject for output.
*
* @since 3.10.0
*
* @return string
*/
protected function set_subject() {
return sprintf( __( 'A payment is due for your subscription to %s', 'lifterlms' ), '{{PRODUCT_TITLE}}' );
}
/**
* Setup notification title for output.
*
* @since 3.10.0
*
* @return string
*/
protected function set_title() {
if ( 'email' === $this->notification->get( 'type' ) ) {
// Translators: %s = The order ID.
return sprintf( __( 'Payment Due for Order #%s', 'lifterlms' ), '{{ORDER_ID}}' );
}
// Translators: %s = The product title.
return sprintf( __( 'A payment is due for your subscription to %s', 'lifterlms' ), '{{PRODUCT_TITLE}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.payment.retry.php
================================================
<?php
/**
* Notification View: Payment Retry.
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.10.0
* @version 5.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Payment Retry.
*
* @since 3.10.0
*/
class LLMS_Notification_View_Payment_Retry extends LLMS_Abstract_Notification_View {
/**
* Settings for basic notifications.
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification before automatically dismissing it.
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications
*/
'dismissible' => true,
);
/**
* Notification Trigger ID.
*
* @var string
*/
public $trigger_id = 'payment_retry';
/**
* Setup body content for output.
*
* @since 3.10.0
*
* @return string
*/
protected function set_body() {
if ( 'email' === $this->notification->get( 'type' ) ) {
return $this->set_body_email();
}
return $this->set_body_basic();
}
/**
* Setup default notification body for basic notifications.
*
* @since 3.10.0
*
* @return string
*/
private function set_body_basic() {
return esc_html__( 'Head over to the order to see what went wrong and update your payment method to reactivate your subscription.', 'lifterlms' );
}
/**
* Setup default notification body for email notifications.
*
* @since 3.10.0
* @since 5.2.0 Build the table with mailer helper.
*
* @return void
*/
private function set_body_email() {
$mailer = llms()->mailer();
$rows = array(
'NEXT_PAYMENT_DATE' => __( 'Payment Due Date', 'lifterlms' ),
'PRODUCT_TITLE_LINK' => '{{PRODUCT_TYPE}}',
'PLAN_TITLE' => __( 'Plan', 'lifterlms' ),
'PAYMENT_AMOUNT' => __( 'Amount', 'lifterlms' ),
);
ob_start();
?><p><?php printf( esc_html__( 'Hello %s,', 'lifterlms' ), '{{CUSTOMER_NAME}}' ); ?></p>
<p><?php printf( esc_html__( 'The automatic payment for your subscription to %1$s has failed. We\'ll automatically retry this charge on %2$s.', 'lifterlms' ), '{{PRODUCT_TITLE}}', '{{NEXT_PAYMENT_DATE}}' ); ?></p>
<p><?php printf( esc_html__( 'To reactivate your subscription you can login to your account and %1$spay now%2$s.', 'lifterlms' ), '<a href="{{ORDER_URL}}">', '</a>' ); ?></p>
<h4><?php printf( esc_html__( 'Order #%s', 'lifterlms' ), '{{ORDER_ID}}' ); ?></h4>
<?php $mailer->output_table_html( $rows ); ?>
<p><a href="{{ORDER_URL}}"><?php esc_html_e( 'Update Payment Method', 'lifterlms' ); ?></a></p>
<?php
return ob_get_clean();
}
/**
* Setup footer content for output.
*
* @since 3.10.0
*
* @return string
*/
protected function set_footer() {
$url = $this->set_merge_data( '{{ORDER_URL}}' );
return '<a href="' . esc_url( $url ) . '">' . esc_html__( 'Update Payment Method', 'lifterlms' ) . '</a>';
}
/**
* Setup notification icon for output.
*
* @since 3.10.0
*
* @return string
*/
protected function set_icon() {
return $this->get_icon_default( 'warning' );
}
/**
* Setup merge codes that can be used with the notification.
*
* @since 3.10.0
*
* @return array
*/
protected function set_merge_codes() {
return array(
'{{CUSTOMER_ADDRESS}}' => __( 'Customer Address', 'lifterlms' ),
'{{CUSTOMER_NAME}}' => __( 'Customer Name', 'lifterlms' ),
'{{CUSTOMER_PHONE}}' => __( 'Customer Phone', 'lifterlms' ),
'{{NEXT_PAYMENT_DATE}}' => __( 'Next Payment Date', 'lifterlms' ),
'{{ORDER_ID}}' => __( 'Order ID', 'lifterlms' ),
'{{ORDER_URL}}' => __( 'Order URL', 'lifterlms' ),
'{{PAYMENT_AMOUNT}}' => __( 'Payment Amount', 'lifterlms' ),
'{{PLAN_TITLE}}' => __( 'Plan Title', 'lifterlms' ),
'{{PRODUCT_TITLE}}' => __( 'Product Title', 'lifterlms' ),
'{{PRODUCT_TYPE}}' => __( 'Product Type', 'lifterlms' ),
'{{PRODUCT_TITLE_LINK}}' => __( 'Product Title (Link)', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values.
*
* @since 3.10.0
* @since 5.2.0 Retrieve the customer's full address using the proper order's method.
* @since 5.4.0 Account for deleted products.
*
* @param string $code The merge code to get merged data for.
* @return string
*/
protected function set_merge_data( $code ) {
$order = $this->post;
switch ( $code ) {
case '{{CUSTOMER_ADDRESS}}':
$code = $order->get_customer_full_address();
break;
case '{{CUSTOMER_NAME}}':
$code = $order->get_customer_name();
break;
case '{{CUSTOMER_PHONE}}':
$code = $order->get( 'billing_phone' );
break;
case '{{NEXT_PAYMENT_DATE}}':
$code = $order->get_date( 'date_next_payment', get_option( 'date_format' ) . ' ' . get_option( 'time_format' ) );
break;
case '{{ORDER_ID}}':
$code = $order->get( 'id' );
break;
case '{{ORDER_URL}}':
$code = esc_url( $order->get_view_link() );
break;
case '{{PAYMENT_AMOUNT}}':
$code = $order->get_price( 'total' );
break;
case '{{PLAN_TITLE}}':
$code = $order->get( 'plan_title' );
break;
case '{{PRODUCT_TITLE}}':
$code = $order->get( 'product_title' );
break;
case '{{PRODUCT_TITLE_LINK}}':
$permalink = esc_url( get_permalink( $order->get( 'product_id' ) ) );
if ( $permalink ) {
$title = $this->set_merge_data( '{{PRODUCT_TITLE}}' );
$code = '<a href="' . $permalink . '">' . $title . '</a>';
}
break;
case '{{PRODUCT_TYPE}}':
$obj = $order->get_product();
if ( empty( $obj ) ) {
$code = __( '[DELETED ITEM]', 'lifterlms' );
} elseif ( is_a( $obj, 'WP_Post' ) ) {
$code = _x( 'Item', 'generic product type description', 'lifterlms' );
} else {
$code = $obj->get_post_type_label( 'singular_name' );
}
break;
}
return $code;
}
/**
* Setup notification subject for output.
*
* @since 3.10.0
*
* @return string
*/
protected function set_subject() {
return sprintf( __( 'Automatic payment for %1$s failed, retry scheduled for %2$s', 'lifterlms' ), '{{PRODUCT_TITLE}}', '{{NEXT_PAYMENT_DATE}}' );
}
/**
* Setup notification title for output.
*
* @since 3.10.0
*
* @return string
*/
protected function set_title() {
if ( 'email' === $this->notification->get( 'type' ) ) {
// Translators: %s = The order ID.
return sprintf( __( 'Automatic payment failed for order #%s', 'lifterlms' ), '{{ORDER_ID}}' );
}
// Translators: %s = The product title.
return sprintf( __( 'An automatic payment failed for your subscription to %s', 'lifterlms' ), '{{PRODUCT_TITLE}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.purchase.receipt.php
================================================
<?php
/**
* Notification View: Payment Receipt
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.8.0
* @version 5.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Purchase Receipt
*
* @since 3.8.0
* @since 3.8.2 Unknown.
*/
class LLMS_Notification_View_Purchase_Receipt extends LLMS_Abstract_Notification_View {
/**
* Notification Trigger ID
*
* @var string
*/
public $trigger_id = 'purchase_receipt';
/**
* Setup body content for output
*
* @since 3.8.0
* @since 5.2.0 Build the table with mailer helper.
*
* @return string
*/
protected function set_body() {
$mailer = llms()->mailer();
$rows = array(
'TRANSACTION_DATE' => __( 'Date', 'lifterlms' ),
'PRODUCT_TITLE_LINK' => '{{PRODUCT_TYPE}}',
'PLAN_TITLE' => __( 'Plan', 'lifterlms' ),
'TRANSACTION_AMOUNT' => __( 'Amount', 'lifterlms' ),
'TRANSACTION_SOURCE' => __( 'Payment Method', 'lifterlms' ),
'TRANSACTION_ID' => __( 'Transaction ID', 'lifterlms' ),
);
ob_start();
$mailer->output_table_html( $rows );
?>
<p><a href="{{ORDER_URL}}"><?php esc_html_e( 'View Order Details', 'lifterlms' ); ?></a></p>
<?php
return ob_get_clean();
}
/**
* Setup footer content for output
*
* @since 3.8.0
*
* @return string
*/
protected function set_footer() {
return '';
}
/**
* Setup notification icon for output
*
* @since 3.8.0
*
* @return string
*/
protected function set_icon() {
return '';
}
/**
* Setup merge codes that can be used with the notification
*
* @since 3.8.0
*
* @return array
*/
protected function set_merge_codes() {
return array(
'{{CUSTOMER_ADDRESS}}' => __( 'Customer Address', 'lifterlms' ),
'{{CUSTOMER_NAME}}' => __( 'Customer Name', 'lifterlms' ),
'{{CUSTOMER_PHONE}}' => __( 'Customer Phone', 'lifterlms' ),
'{{ORDER_ID}}' => __( 'Order ID', 'lifterlms' ),
'{{ORDER_URL}}' => __( 'Order URL', 'lifterlms' ),
'{{PLAN_TITLE}}' => __( 'Plan Title', 'lifterlms' ),
'{{PRODUCT_TITLE}}' => __( 'Product Title', 'lifterlms' ),
'{{PRODUCT_TYPE}}' => __( 'Product Type', 'lifterlms' ),
'{{PRODUCT_TITLE_LINK}}' => __( 'Product Title (Link)', 'lifterlms' ),
'{{TRANSACTION_AMOUNT}}' => __( 'Transaction Amount', 'lifterlms' ),
'{{TRANSACTION_DATE}}' => __( 'Transaction Date', 'lifterlms' ),
'{{TRANSACTION_ID}}' => __( 'Transaction ID', 'lifterlms' ),
'{{TRANSACTION_SOURCE}}' => __( 'Transaction Source', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values
*
* @since 3.8.0
* @since 3.8.2 Unknown.
* @since 5.2.0 Retrieve the customer's full address using the proper order's method.
*
* @param string $code The merge code to get merged data for.
* @return string
*/
protected function set_merge_data( $code ) {
$transaction = $this->post;
$order = $transaction->get_order();
switch ( $code ) {
case '{{CUSTOMER_ADDRESS}}':
$code = $order->get_customer_full_address();
break;
case '{{CUSTOMER_NAME}}':
$code = $order->get_customer_name();
break;
case '{{CUSTOMER_PHONE}}':
$code = $order->get( 'billing_phone' );
break;
case '{{ORDER_ID}}':
$code = $order->get( 'id' );
break;
case '{{ORDER_URL}}':
$code = esc_url( $order->get_view_link() );
break;
case '{{PLAN_TITLE}}':
$code = $order->get( 'plan_title' );
break;
case '{{PRODUCT_TITLE}}':
$code = $order->get( 'product_title' );
break;
case '{{PRODUCT_TITLE_LINK}}':
$permalink = esc_url( get_permalink( $order->get( 'product_id' ) ) );
if ( $permalink ) {
$title = $this->set_merge_data( '{{PRODUCT_TITLE}}' );
$code = '<a href="' . $permalink . '">' . $title . '</a>';
}
break;
case '{{PRODUCT_TYPE}}':
$obj = $order->get_product();
if ( $obj ) {
$code = $obj->get_post_type_label( 'singular_name' );
} else {
$code = _x( 'Item', 'generic product type description', 'lifterlms' );
}
break;
case '{{TRANSACTION_AMOUNT}}':
$code = $transaction->get_price( 'amount' );
break;
case '{{TRANSACTION_DATE}}':
$code = $transaction->get_date( 'date', get_option( 'date_format' ) . ' ' . get_option( 'time_format' ) );
break;
case '{{TRANSACTION_ID}}':
$code = $transaction->get( 'id' );
break;
case '{{TRANSACTION_SOURCE}}':
$code = $transaction->get( 'gateway_source_description' );
break;
}
return $code;
}
/**
* Setup notification subject for output
*
* @since 3.8.0
*
* @return string
*/
protected function set_subject() {
// Translators: %s = Product Title.
return sprintf( __( 'Purchase Receipt for %s', 'lifterlms' ), '{{PRODUCT_TITLE}}' );
}
/**
* Setup notification title for output
*
* @since 3.8.0
*
* @return string
*/
protected function set_title() {
// Translators: %s = Order ID.
return sprintf( __( 'Purchase Receipt for Order #%s', 'lifterlms' ), '{{ORDER_ID}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.quiz.failed.php
================================================
<?php
/**
* Notification View: Quiz Failed
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.8.0
* @version 3.24.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Quiz Failed
*
* @since 3.8.0
* @since 3.24.0 Unknown.
*/
class LLMS_Notification_View_Quiz_Failed extends LLMS_Abstract_Notification_View_Quiz_Completion {
/**
* Notification Trigger ID
*
* @var string
*/
public $trigger_id = 'quiz_failed';
/**
* Setup body content for output
*
* @return string
* @since 3.8.0
* @version 3.24.0
*/
protected function set_body() {
if ( 'email' === $this->notification->get( 'type' ) ) {
return $this->set_body_email();
}
$content = sprintf( __( 'You failed %s!', 'lifterlms' ), '{{QUIZ_TITLE}}' );
$content .= "\r\n\r\n{{GRADE_BAR}}";
return $content;
}
/**
* Setup notification icon for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_icon() {
return $this->get_icon_default( 'negative' );
}
/**
* Setup notification subject for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subject() {
return sprintf( __( '%1$s failed %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{QUIZ_TITLE}}' );
}
/**
* Setup notification title for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_title() {
return sprintf( __( '%s failed a quiz', 'lifterlms' ), '{{STUDENT_NAME}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.quiz.graded.php
================================================
<?php
/**
* Notification View: Quiz Graded
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.24.0
* @version 5.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Notification_View_Quiz_Graded class
*
* @since 3.24.0
* @since 3.29.0 Unknown.
*/
class LLMS_Notification_View_Quiz_Graded extends LLMS_Abstract_Notification_View {
/**
* Notification Trigger ID
*
* @var string
*/
public $trigger_id = 'quiz_graded';
/**
* Settings for basic notifications
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification before automatically dismissing it
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications
*/
'dismissible' => true,
);
/**
* Setup body content for output
*
* @since 3.24.0
*
* @return string
*/
protected function set_body() {
if ( 'email' === $this->notification->get( 'type' ) ) {
return $this->set_body_email();
}
// Translators: %s = Quiz attempt grade.
$content = sprintf( __( 'You received a %1$s', 'lifterlms' ), '{{GRADE}}' );
return $content;
}
/**
* Setup body for email notification
*
* @since 3.24.0
* @since 5.2.0 Build the table with mailer helper.
*
* @return string
*/
protected function set_body_email() {
$mailer = llms()->mailer();
$btn_style = $mailer->get_button_style();
$rows = array(
'QUIZ_TITLE' => __( 'Quiz', 'lifterlms' ),
'LESSON_TITLE' => __( 'Lesson', 'lifterlms' ),
'COURSE_TITLE' => __( 'Course', 'lifterlms' ),
'GRADE' => __( 'Grade', 'lifterlms' ),
'STATUS' => __( 'Status', 'lifterlms' ),
);
ob_start();
$mailer->output_table_html( $rows );
?>
<p><a href="{{REVIEW_URL}}" style="<?php echo esc_attr( $btn_style ); ?>"><?php esc_html_e( 'View the whole attempt', 'lifterlms' ); ?></a></p>
<p><small><?php esc_html_e( 'Trouble clicking? Copy and paste this URL into your browser:', 'lifterlms' ); ?><br><a href="{{REVIEW_URL}}">{{REVIEW_URL}}</a></small></p>
<?php
return ob_get_clean();
}
/**
* Setup notification icon for output
*
* @since 3.24.0
*
* @return string
*/
protected function set_icon() {
return $this->get_icon_default( 'warning' );
}
/**
* Setup footer content for output
*
* @since 3.24.0
* @since 3.29.0 Unknown.
*
* @return string
*/
protected function set_footer() {
$attempt = new LLMS_Quiz_Attempt( $this->notification->get( 'post_id' ) );
if ( ! $attempt->exists() ) {
return '';
}
$permalink = $attempt->get_permalink();
if ( ! $permalink ) {
return '';
}
return '<a href="' . esc_url( $permalink ) . '">' . __( 'View the attempt', 'lifterlms' ) . '</a>';
}
/**
* Setup merge codes that can be used with the notification
*
* @since 3.24.0
*
* @return array
*/
protected function set_merge_codes() {
return array(
'{{COURSE_TITLE}}' => __( 'Course Title', 'lifterlms' ),
'{{GRADE}}' => __( 'Grade', 'lifterlms' ),
'{{LESSON_TITLE}}' => __( 'Lesson Title', 'lifterlms' ),
'{{QUIZ_TITLE}}' => __( 'Quiz Title', 'lifterlms' ),
'{{REVIEW_URL}}' => __( 'Review URL', 'lifterlms' ),
'{{STATUS}}' => __( 'Quiz Status', 'lifterlms' ),
'{{STUDENT_NAME}}' => __( 'Student Name', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values
*
* @since 3.24.0
*
* @param string $code The merge code to get merged data for.
* @return string
*/
protected function set_merge_data( $code ) {
$attempt = new LLMS_Quiz_Attempt( $this->notification->get( 'post_id' ) );
if ( ! $attempt->exists() ) {
return '';
}
$lesson = llms_get_post( $attempt->get( 'lesson_id' ) );
if ( ! $lesson ) {
return '';
}
switch ( $code ) {
case '{{COURSE_TITLE}}':
$course = $lesson->get_course();
if ( $course ) {
$code = $course->get( 'title' );
} else {
$code = '';
}
break;
case '{{GRADE}}':
$code = llms()->grades()->round( $attempt->get( 'grade' ) ) . '%';
break;
case '{{LESSON_TITLE}}':
$code = $lesson->get( 'title' );
break;
case '{{QUIZ_TITLE}}':
$code = get_the_title( $attempt->get( 'quiz_id' ) );
break;
case '{{REVIEW_URL}}':
$code = $attempt->get_permalink();
break;
case '{{STATUS}}':
$code = $attempt->l10n( 'status' );
break;
case '{{STUDENT_NAME}}':
$code = $this->user->get_name();
break;
}// End switch().
return $code;
}
/**
* Setup notification subject for output
*
* @since 3.24.0
*
* @return string
*/
protected function set_subject() {
// Translators: %s = Quiz Title.
return sprintf( __( 'Your quiz "%s" has been reviewed', 'lifterlms' ), '{{QUIZ_TITLE}}' );
}
/**
* Setup notification title for output
*
* @since 3.24.0
*
* @return string
*/
protected function set_title() {
return __( 'Quiz Review Details', 'lifterlms' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.quiz.passed.php
================================================
<?php
/**
* Notification View: Quiz Passed
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.8.0
* @version 3.24.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Quiz Passed
*
* @since 3.8.0
* @since 3.24.0 Unknown.
*/
class LLMS_Notification_View_Quiz_Passed extends LLMS_Abstract_Notification_View_Quiz_Completion {
/**
* Notification Trigger ID
*
* @var string
*/
public $trigger_id = 'quiz_passed';
/**
* Setup body content for output
*
* @return string
* @since 3.8.0
* @version 3.24.0
*/
protected function set_body() {
if ( 'email' === $this->notification->get( 'type' ) ) {
return $this->set_body_email();
}
$content = sprintf( __( 'Congratulations! You passed %s!', 'lifterlms' ), '{{QUIZ_TITLE}}' );
$content .= "\r\n\r\n{{GRADE_BAR}}";
return $content;
}
/**
* Setup notification icon for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_icon() {
return $this->get_icon_default( 'positive' );
}
/**
* Setup notification subject for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subject() {
return sprintf( __( 'Congratulations! %1$s passed %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{QUIZ_TITLE}}' );
}
/**
* Setup notification title for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_title() {
return sprintf( __( '%s passed a quiz', 'lifterlms' ), '{{STUDENT_NAME}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.section.complete.php
================================================
<?php
/**
* Notification View: Section Complete
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.8.0
* @version 3.10.1
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Section Complete
*
* @since 3.8.0
* @since 3.10.1 Unknown.
*/
class LLMS_Notification_View_Section_Complete extends LLMS_Abstract_Notification_View {
/**
* Settings for basic notifications
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification
* before automatically dismissing it
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications
*/
'dismissible' => true,
);
/**
* Notification Trigger ID
*
* @var [type]
*/
public $trigger_id = 'section_complete';
/**
* Setup body content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_body() {
if ( 'email' === $this->notification->get( 'type' ) ) {
return sprintf( __( 'Congratulations! %1$s completed %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{SECTION_TITLE}}' );
}
return sprintf( __( 'Congratulations! You finished %s', 'lifterlms' ), '{{SECTION_TITLE}}' );
}
/**
* Setup footer content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_footer() {
return '';
}
/**
* Setup notification icon for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_icon() {
return $this->get_icon_default( 'positive' );
}
/**
* Setup merge codes that can be used with the notification
*
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_merge_codes() {
return array(
'{{COURSE_PROGRESS}}' => __( 'Course Progress Bar', 'lifterlms' ),
'{{COURSE_TITLE}}' => __( 'Course Title', 'lifterlms' ),
'{{SECTION_TITLE}}' => __( 'Section Title', 'lifterlms' ),
'{{STUDENT_NAME}}' => __( 'Student Name', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values
*
* @param string $code the merge code to ge merged data for
* @return string
* @since 3.8.0
* @version 3.10.1
*/
protected function set_merge_data( $code ) {
switch ( $code ) {
case '{{COURSE_PROGRESS}}':
$progress = $this->user->get_progress( $this->post->get( 'parent_course' ), 'course' );
$code = lifterlms_course_progress_bar( $progress, false, false, false );
break;
case '{{COURSE_TITLE}}':
$course = $this->post->get_course();
if ( $course ) {
$code = $course->get( 'title' );
} else {
$code = '';
}
break;
case '{{SECTION_TITLE}}':
$code = $this->post->get( 'title' );
break;
case '{{STUDENT_NAME}}':
$code = $this->is_for_self() ? __( 'you', 'lifterlms' ) : $this->user->get_name();
break;
}
return $code;
}
/**
* Setup notification subject for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subject() {
return sprintf( __( 'Congratulations! %1$s completed %2$s', 'lifterlms' ), '{{STUDENT_NAME}}', '{{SECTION_TITLE}}' );
}
/**
* Setup notification title for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_title() {
return sprintf( __( '%s Completed a Section', 'lifterlms' ), '{{STUDENT_NAME}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.student.welcome.php
================================================
<?php
/**
* Notification View: Student Welcome
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.8.0
* @version 3.10.1
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Student Welcome
*
* @since 3.8.0
* @version 3.10.1
*/
class LLMS_Notification_View_Student_Welcome extends LLMS_Abstract_Notification_View {
/**
* Notification Trigger ID
*
* @var [type]
*/
public $trigger_id = 'student_welcome';
/**
* Setup body content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_body() {
ob_start();
?><p><?php printf( esc_html__( 'Hello %s,', 'lifterlms' ), '{{STUDENT_NAME}}' ); ?></p>
<p><?php printf( esc_html__( 'Here\'s some helpful information to help you get started at %s.', 'lifterlms' ), '{{SITE_TITLE}}' ); ?></p>
<p><b><?php esc_html_e( 'Your Login', 'lifterlms' ); ?></b>: {{STUDENT_LOGIN}}</p>
<p><b><?php esc_html_e( 'Your Dashboard', 'lifterlms' ); ?></b>: <a href="{{DASHBOARD_URL}}">{{DASHBOARD_URL}}</a></p>
<p><?php esc_html_e( 'If you forgot or don\'t have a password you can reset it now so you can login and get started:', 'lifterlms' ); ?> <a href="{{PASSWORD_RESET_URL}}">{{PASSWORD_RESET_URL}}</a></p>
<?php
return ob_get_clean();
}
/**
* Setup footer content for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_footer() {
return '';
}
/**
* Setup notification icon for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_icon() {
return $this->get_icon_default( 'positive' );
}
/**
* Setup merge codes that can be used with the notification
*
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_merge_codes() {
return array(
'{{DASHBOARD_URL}}' => __( 'Dashboard URL', 'lifterlms' ),
'{{PASSWORD_RESET_URL}}' => __( 'Password Reset URL', 'lifterlms' ),
'{{SITE_TITLE}}' => __( 'Site Title', 'lifterlms' ),
'{{STUDENT_NAME}}' => __( 'Student Name', 'lifterlms' ),
'{{STUDENT_LOGIN}}' => __( 'Student Login', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values
*
* @param string $code the merge code to ge merged data for
* @return string
* @since 3.8.0
* @version 3.8.2
*/
protected function set_merge_data( $code ) {
switch ( $code ) {
case '{{DASHBOARD_URL}}':
$code = llms_get_page_url( 'myaccount' );
break;
case '{{PASSWORD_RESET_URL}}':
$code = wp_lostpassword_url();
break;
case '{{SITE_TITLE}}':
$code = get_bloginfo( 'name', 'display' );
break;
case '{{STUDENT_NAME}}':
$code = $this->user->get_name();
break;
case '{{STUDENT_LOGIN}}':
$field = ( LLMS_Forms::instance()->are_usernames_enabled() ) ? 'user_login' : 'user_email';
$code = $this->user->get( $field );
break;
}
return $code;
}
/**
* Setup notification subject for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subject() {
return sprintf( __( 'Welcome to %s', 'lifterlms' ), '{{SITE_TITLE}}' );
}
/**
* Setup notification title for output
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
protected function set_title() {
return sprintf( __( 'Let\'s get started %s', 'lifterlms' ), '{{STUDENT_NAME}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.subscription.cancelled.php
================================================
<?php
/**
* Notification View: Student Welcome.
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 3.17.8
* @version 5.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Purchase Receipt.
*
* @since 3.17.8
*/
class LLMS_Notification_View_Subscription_Cancelled extends LLMS_Abstract_Notification_View {
/**
* Notification Trigger ID.
*
* @var string
*/
public $trigger_id = 'subscription_cancelled';
/**
* Setup body content for output.
*
* @since 3.17.8
*
* @return string
*/
protected function set_body() {
return sprintf(
__( '%1$s has cancelled their subscription (#%2$s) to the %3$s %4$s', 'lifterlms' ),
'{{CUSTOMER_NAME}}',
'{{ORDER_ID}}',
'{{PRODUCT_TYPE}}',
'{{PRODUCT_TITLE_LINK}}'
);
}
/**
* Setup footer content for output.
*
* @since 3.17.8
*
* @return string
*/
protected function set_footer() {
return '';
}
/**
* Setup notification icon for output.
*
* @since 3.17.8
*
* @return string
*/
protected function set_icon() {
return '';
}
/**
* Setup merge codes that can be used with the notification.
*
* @since 3.17.8
*
* @return array
*/
protected function set_merge_codes() {
return array(
'{{CUSTOMER_NAME}}' => __( 'Customer Name', 'lifterlms' ),
'{{ORDER_ID}}' => __( 'Order ID', 'lifterlms' ),
'{{PLAN_TITLE}}' => __( 'Plan Title', 'lifterlms' ),
'{{PRODUCT_TITLE}}' => __( 'Product Title', 'lifterlms' ),
'{{PRODUCT_TYPE}}' => __( 'Product Type', 'lifterlms' ),
'{{PRODUCT_TITLE_LINK}}' => __( 'Product Title (Link)', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values.
*
* @since 3.17.8
* @since 5.4.0 Account for deleted products.
*
* @param string $code The merge code to ge merged data for.
* @return string
*/
protected function set_merge_data( $code ) {
$order = $this->post;
switch ( $code ) {
case '{{CUSTOMER_NAME}}':
$code = $order->get_customer_name();
break;
case '{{ORDER_ID}}':
$code = $order->get( 'id' );
break;
case '{{PLAN_TITLE}}':
$code = $order->get( 'plan_title' );
break;
case '{{PRODUCT_TITLE}}':
$code = $order->get( 'product_title' );
break;
case '{{PRODUCT_TITLE_LINK}}':
$permalink = esc_url( get_permalink( $order->get( 'product_id' ) ) );
if ( $permalink ) {
$title = $this->set_merge_data( '{{PRODUCT_TITLE}}' );
$code = '<a href="' . $permalink . '">' . $title . '</a>';
}
break;
case '{{PRODUCT_TYPE}}':
$obj = $order->get_product();
if ( empty( $obj ) ) {
$code = __( '[DELETED ITEM]', 'lifterlms' );
} elseif ( is_a( $obj, 'WP_Post' ) ) {
$code = _x( 'Item', 'generic product type description', 'lifterlms' );
} else {
$code = $obj->get_post_type_label( 'singular_name' );
}
break;
}
return $code;
}
/**
* Setup notification subject for output.
*
* @since 3.17.8
*
* @return string
*/
protected function set_subject() {
return esc_html__( 'Subscription Cancellation Notice', 'lifterlms' );
}
/**
* Setup notification title for output.
*
* @since 3.17.8
*
* @return string
*/
protected function set_title() {
return sprintf( esc_html__( '%1$s subscription cancellation', 'lifterlms' ), '{{PRODUCT_TYPE}}' );
}
}
================================================
FILE: includes/notifications/views/class.llms.notification.view.upcoming.payment.reminder.php
================================================
<?php
/**
* Notification View: Upcoming Payment Reminder.
*
* @package LifterLMS/Notifications/Views/Classes
*
* @since 5.2.0
* @version 5.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification View: Payment Retry.
*
* @since 5.2.0
*/
class LLMS_Notification_View_Upcoming_Payment_Reminder extends LLMS_Abstract_Notification_View {
/**
* Settings for basic notifications.
*
* @var array
*/
protected $basic_options = array(
/**
* Time in milliseconds to show a notification
* before automatically dismissing it.
*/
'auto_dismiss' => 10000,
/**
* Enables manual dismissal of notifications.
*/
'dismissible' => true,
);
/**
* Notification Trigger ID.
*
* @var string
*/
public $trigger_id = 'upcoming_payment_reminder';
/**
* Setup body content for output.
*
* @since 5.2.0
*
* @return string
*/
protected function set_body() {
if ( 'email' === $this->notification->get( 'type' ) ) {
return $this->set_body_email();
}
return $this->set_body_basic();
}
/**
* Setup default notification body for basic notifications.
*
* @since 5.2.0
*
* @return string
*/
private function set_body_basic() {
return sprintf( esc_html__( 'You will be charged for your subscription to %1$s tomorrow.', 'lifterlms' ), '{{PRODUCT_TITLE}}' );
}
/**
* Setup default notification body for email notifications.
*
* @since 5.2.0
*
* @return string
*/
private function set_body_email() {
$mailer = llms()->mailer();
$rows = array(
'NEXT_PAYMENT_DATE' => __( 'Payment Due Date', 'lifterlms' ),
'PRODUCT_TITLE_LINK' => '{{PRODUCT_TYPE}}',
'PLAN_TITLE' => __( 'Plan', 'lifterlms' ),
'PAYMENT_AMOUNT' => __( 'Amount', 'lifterlms' ),
);
ob_start();
?>
<p>
<?php
// Translators: %s= The customer name.
printf( esc_html__( 'Hello %s,', 'lifterlms' ), '{{CUSTOMER_NAME}}' );
?>
</p>
<p>
<?php
// Translators: %1$s = The product title, %2$s The upcoming payment due date.
printf( esc_html__( 'You will be charged for your subscription to %1$s on %2$s.', 'lifterlms' ), '{{PRODUCT_TITLE}}', '{{NEXT_PAYMENT_DATE}}' );
?>
</p>
<h4>
<?php
// Translators: %s= The order ID.
printf( esc_html__( 'Order #%s', 'lifterlms' ), '{{ORDER_ID}}' );
?>
</h4>
<?php
$mailer->output_table_html( $rows );
?>
<p><a href="{{ORDER_URL}}"><?php esc_html_e( 'Update Payment Method', 'lifterlms' ); ?></a></p>
<?php
return ob_get_clean();
}
/**
* Setup footer content for output.
*
* @since 5.2.0
*
* @return string
*/
protected function set_footer() {
$url = $this->set_merge_data( '{{ORDER_URL}}' );
return '<a href="' . esc_url( $url ) . '">' . esc_html__( 'Update Payment Method', 'lifterlms' ) . '</a>';
}
/**
* Setup notification icon for output.
*
* @since 5.2.0
*
* @return string
*/
protected function set_icon() {
return $this->get_icon_default( 'warning' );
}
/**
* Setup merge codes that can be used with the notification.
*
* @since 5.2.0
*
* @return array
*/
protected function set_merge_codes() {
return array(
'{{CUSTOMER_ADDRESS}}' => __( 'Customer Address', 'lifterlms' ),
'{{CUSTOMER_NAME}}' => __( 'Customer Name', 'lifterlms' ),
'{{CUSTOMER_PHONE}}' => __( 'Customer Phone', 'lifterlms' ),
'{{NEXT_PAYMENT_DATE}}' => __( 'Next Payment Date', 'lifterlms' ),
'{{ORDER_ID}}' => __( 'Order ID', 'lifterlms' ),
'{{ORDER_URL}}' => __( 'Order URL', 'lifterlms' ),
'{{PAYMENT_AMOUNT}}' => __( 'Payment Amount', 'lifterlms' ),
'{{PLAN_TITLE}}' => __( 'Plan Title', 'lifterlms' ),
'{{PRODUCT_TITLE}}' => __( 'Product Title', 'lifterlms' ),
'{{PRODUCT_TYPE}}' => __( 'Product Type', 'lifterlms' ),
'{{PRODUCT_TITLE_LINK}}' => __( 'Product Title (Link)', 'lifterlms' ),
);
}
/**
* Replace merge codes with actual values.
*
* @since 5.2.0
* @since 5.4.0 Account for deleted products.
*
* @param string $code The merge code to get merged data for.
* @return string
*/
protected function set_merge_data( $code ) {
$order = $this->post;
switch ( $code ) {
case '{{CUSTOMER_ADDRESS}}':
$code = $order->get_customer_full_address();
break;
case '{{CUSTOMER_NAME}}':
$code = $order->get_customer_name();
break;
case '{{CUSTOMER_PHONE}}':
$code = $order->get( 'billing_phone' );
break;
case '{{NEXT_PAYMENT_DATE}}':
$code = $order->get_date( 'date_next_payment', get_option( 'date_format' ) . ' ' . get_option( 'time_format' ) );
break;
case '{{ORDER_ID}}':
$code = $order->get( 'id' );
break;
case '{{ORDER_URL}}':
$code = esc_url( $order->get_view_link() );
break;
case '{{PAYMENT_AMOUNT}}':
$code = $order->get_price( 'total' );
break;
case '{{PLAN_TITLE}}':
$code = $order->get( 'plan_title' );
break;
case '{{PRODUCT_TITLE}}':
$code = $order->get( 'product_title' );
break;
case '{{PRODUCT_TITLE_LINK}}':
$permalink = esc_url( get_permalink( $order->get( 'product_id' ) ) );
if ( $permalink ) {
$title = $this->set_merge_data( '{{PRODUCT_TITLE}}' );
$code = '<a href="' . $permalink . '">' . $title . '</a>';
}
break;
case '{{PRODUCT_TYPE}}':
$obj = $order->get_product();
if ( empty( $obj ) ) {
$code = __( '[DELETED ITEM]', 'lifterlms' );
} elseif ( is_a( $obj, 'WP_Post' ) ) {
$code = _x( 'Item', 'generic product type description', 'lifterlms' );
} else {
$code = $obj->get_post_type_label( 'singular_name' );
}
break;
}
return $code;
}
/**
* Setup notification subject for output.
*
* @since 5.2.0
*
* @return string
*/
protected function set_subject() {
// Translators: %s = The product title.
return sprintf( __( 'Upcoming payment reminder for your subscription to %1$s', 'lifterlms' ), '{{PRODUCT_TITLE}}' );
}
/**
* Setup notification title for output
*
* @since 5.2.0
*
* @return string
*/
protected function set_title() {
return __( 'Upcoming Subscription Payment', 'lifterlms' );
}
}
================================================
FILE: includes/notifications/views/index.php
================================================
<?php // quiet.
================================================
FILE: includes/privacy/class-llms-privacy-erasers.php
================================================
<?php
/**
* LifterLMS Privacy Eraser
*
* @package LifterLMS/Privacy/Classes
*
* @since 3.18.0
* @version 3.30.3
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Privacy Eraser class
*
* @since 3.18.0
* @since 3.30.3 Fixed spelling errors.
*/
class LLMS_Privacy_Erasers extends LLMS_Privacy {
/**
* Erase student certificate data by email address
*
* @param string $email_address email address of the user to retrieve data for
* @param int $page process page number
* @return array
* @since 3.18.0
* @version 3.18.0
*/
public static function achievement_data( $email_address, $page ) {
$ret = self::get_return();
$student = parent::get_student_by_email( $email_address );
if ( ! $student ) {
return $ret;
}
$messages = array();
$achievements = self::get_student_achievements( $student );
if ( $achievements ) {
foreach ( $achievements as $achievement ) {
$messages[] = sprintf( 'Achievement %d deleted.', $achievement->get( 'id' ) );
$achievement->delete();
}
}
return self::get_return( $messages, true, ( $messages ) );
}
/**
* Setup anonymous values for anonymized data
*
* @param string $val default anonymous value ('')
* @param string $prop key name of the property
* @param obj $obj related object
* @return mixed
* @since 3.18.0
* @version 3.18.0
*/
public static function anonymize_prop( $val, $prop, $obj = null ) {
switch ( $prop ) {
case 'user_id':
$val = 0;
break;
}
return $val;
}
/**
* Erase student certificate data by email address
*
* @param string $email_address email address of the user to retrieve data for
* @param int $page process page number
* @return array
* @since 3.18.0
* @version 3.18.0
*/
public static function certificate_data( $email_address, $page ) {
$ret = self::get_return();
$student = parent::get_student_by_email( $email_address );
if ( ! $student ) {
return $ret;
}
$messages = array();
$certs = self::get_student_certificates( $student );
if ( $certs ) {
foreach ( $certs as $cert ) {
$messages[] = sprintf( 'Certificate %d deleted.', $cert->get( 'id' ) );
$cert->delete();
}
}
return self::get_return( $messages, true, ( $messages ) );
}
/**
* Return export data to an exporter
*
* @param array $messages array of messages
* @return array
* @since 3.18.0
* @version 3.18.0
*/
private static function get_return( $messages = array(), $done = true, $removed = false, $retained = false ) {
return array(
'messages' => $messages,
'done' => $done,
'items_removed' => $removed,
'items_retained' => $retained,
);
}
/**
* Erase notifications for a student
*
* @param LLMS_Student $student
* @return array
* @since 3.18.0
* @version 3.18.0
*/
private static function erase_notification_data( $student ) {
$messages = array();
global $wpdb;
$deleted = $wpdb->query(
$wpdb->prepare(
"DELETE FROM {$wpdb->prefix}lifterlms_notifications WHERE user_id = %d OR subscriber = %d",
$student->get( 'id' ),
$student->get( 'id' )
)
);
if ( $deleted ) {
// Translators: %d = number of notifications.
$messages[] = sprintf( __( 'Removed %d notifications.', 'lifterlms' ), $deleted );
}
return apply_filters( 'llms_privacy_erase_notification_data', $messages, $student );
}
/**
* Erase and anonymize an order
*
* @since 3.18.0
* @since 3.30.3 Fixed spelling error.
*
* @param LLMS_Order $order Order object.
* @return void
*/
private static function erase_order_data( $order ) {
// Cancel recurring orders.
if ( $order->is_recurring() && in_array( $order->get( 'status' ), array( 'llms-on-hold', 'llms-active', 'llms-pending-cancel' ) ) ) {
$order->set_status( 'cancelled' );
$order->add_note( __( 'Order cancelled during personal data erasure.', 'lifterlms' ) );
}
$props = array_keys( self::get_order_data_props( 'erasure' ) );
foreach ( $props as $prop ) {
$val = self::get_anon_prop_value( $prop );
$order->set( $prop, $val );
}
$order->set( 'anonymized', 'yes' );
$order->add_note( __( 'Personal data removed during personal data erasure.', 'lifterlms' ) );
}
/**
* Erase student data
*
* @param LLMS_Student $student
* @return array
* @since 3.18.0
* @version 3.18.0
*/
private static function erase_student_data( $student ) {
$messages = array();
$props = parent::get_student_data_props();
foreach ( $props as $prop => $name ) {
$erased = false;
$val = $student->get( $prop );
if ( $val ) {
$student->set( $prop, '' );
$erased = true;
}
if ( apply_filters( 'llms_privacy_erase_student_data_prop', $erased, $prop, $student ) ) {
/* Translators: %s Prop name. */
$messages[] = sprintf( __( 'Removed student "%s"', 'lifterlms' ), $name );
}
}
return apply_filters( 'llms_privacy_erase_student_data', $messages, $student );
}
/**
* Erase student notification data by email address
*
* @param string $email_address email address of the user to retrieve data for
* @param int $page process page number
* @return [type]
* @since 3.18.0
* @version 3.18.0
*/
public static function notification_data( $email_address, $page ) {
$ret = self::get_return();
$student = parent::get_student_by_email( $email_address );
if ( ! $student ) {
return $ret;
}
$messages = self::erase_notification_data( $student );
return self::get_return( $messages, true, ( $messages ) );
}
/**
* Erase student order data by email address
*
* @param string $email_address email address of the user to retrieve data for
* @param int $page process page number
* @return array
* @since 3.18.0
* @version 3.18.0
*/
public static function order_data( $email_address, $page ) {
$ret = self::get_return();
$student = parent::get_student_by_email( $email_address );
if ( ! $student ) {
return $ret;
}
$enabled = llms_parse_bool( get_option( 'llms_erasure_request_removes_order_data', 'no' ) );
$orders = self::get_student_orders( $student, $page );
foreach ( $orders['orders'] as $order ) {
if ( apply_filters( 'llms_privacy_erase_order_data', $enabled, $order ) ) {
self::erase_order_data( $order );
/* Translators: %d Order number. */
$ret['messages'][] = sprintf( __( 'Removed personal data from order #%d.', 'lifterlms' ), $order->get( 'id' ) );
$ret['items_removed'] = true;
} else {
/* Translators: %d Order number. */
$ret['messages'][] = sprintf( __( 'Personal data within order #%d has been retained.', 'lifterlms' ), $order->get( 'id' ) );
$ret['items_retained'] = true;
}
}
$ret['done'] = isset( $orders['done'] ) ? $orders['done'] : true;
return $ret;
}
/**
* Erase student postmeta data by email address
*
* @param string $email_address email address of the user to retrieve data for
* @param int $page process page number
* @return [type]
* @since 3.18.0
* @version 3.18.0
*/
public static function postmeta_data( $email_address, $page ) {
$ret = self::get_return();
$student = parent::get_student_by_email( $email_address );
if ( ! $student ) {
return $ret;
}
$messages = array();
$enabled = llms_parse_bool( get_option( 'llms_erasure_request_removes_lms_data', 'no' ) );
if ( apply_filters( 'llms_privacy_erase_postmeta_data', $enabled, $attempt ) ) {
global $wpdb;
$deleted = $wpdb->query(
$wpdb->prepare(
"DELETE FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE user_id = %d",
$student->get( 'id' )
)
);
$ret['messages'][] = __( 'Removed all student course and membership enrollment and activity data.', 'lifterlms' );
$ret['items_removed'] = true;
} else {
$ret['messages'][] = __( 'Retained all student course and membership enrollment and activity data.', 'lifterlms' );
$ret['items_retained'] = true;
}
return $ret;
}
/**
* Erase student quiz attempt data by email address
*
* @param string $email_address email address of the user to retrieve data for
* @param int $page process page number
* @return array
* @since 3.18.0
* @version 3.18.0
*/
public static function quiz_data( $email_address, $page ) {
$ret = self::get_return();
$student = parent::get_student_by_email( $email_address );
if ( ! $student ) {
return $ret;
}
$enabled = llms_parse_bool( get_option( 'llms_erasure_request_removes_lms_data', 'no' ) );
$query = self::get_student_quizzes( $student, $page );
foreach ( $query->get_attempts() as $attempt ) {
if ( apply_filters( 'llms_privacy_erase_quiz_data', $enabled, $attempt ) ) {
/* Translators: %d quiz attempt id. */
$ret['messages'][] = sprintf( __( 'Quiz attempt #%d removed.', 'lifterlms' ), $attempt->get_id() );
$ret['items_removed'] = true;
$attempt->delete();
} else {
/* Translators: %d quiz attempt id. */
$ret['messages'][] = sprintf( __( 'Quiz attempt #%d retained.', 'lifterlms' ), $attempt->get_id() );
$ret['items_retained'] = true;
}
}
$ret['done'] = $query->has_results() ? $query->is_last_page() : true;
return $ret;
}
/**
* Erase student data by email address
*
* @param string $email_address email address of the user to retrieve data for
* @param int $page process page number
* @return [type]
* @since 3.18.0
* @version 3.18.0
*/
public static function student_data( $email_address, $page ) {
$ret = self::get_return();
$student = parent::get_student_by_email( $email_address );
if ( ! $student ) {
return $ret;
}
$messages = self::erase_student_data( $student );
return self::get_return( $messages, true, ( $messages ) );
}
}
================================================
FILE: includes/privacy/class-llms-privacy-exporters.php
================================================
<?php
/**
* LifterLMS Privacy Exporter
*
* @package LifterLMS/Privacy/Classes
*
* @since 3.18.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Privacy Exporter class
*
* @since 3.18.0
* @since 3.30.3 Fixed spelling error.
* @since 3.37.9 Add export group descriptions.
*/
class LLMS_Privacy_Exporters extends LLMS_Privacy {
/**
* Export student achievement data by email address
*
* @since 3.18.0
* @since 3.37.9 Added `$group_description` to the group exporter.
*
* @param string $email_address Email address of the user to retrieve data for.
* @param int $page Process page number.
* @return array
*/
public static function achievement_data( $email_address, $page ) {
$data = array();
$student = self::get_student_by_email( $email_address );
if ( ! $student ) {
return self::get_return( $data );
}
$achievements = self::get_student_achievements( $student );
if ( $achievements ) {
$group_label = __( 'Achievements', 'lifterlms' );
$group_description = __( 'Student achievement data.', 'lifterlms' );
foreach ( $achievements as $achievement ) {
$data[] = array(
'group_id' => 'lifterlms_achievements',
'group_label' => $group_label,
'group_description' => $group_description,
'item_id' => sprintf( 'achievement-%d', $achievement->get( 'id' ) ),
'data' => self::get_achievement_data( $achievement ),
);
}
}
return self::get_return( $data );
}
/**
* Export student certificate data by email address
*
* @since 3.18.0
* @since 3.37.9 Added `$group_description` to the group exporter.
*
* @param string $email_address Email address of the user to retrieve data for.
* @param int $page Process page number.
* @return array
*/
public static function certificate_data( $email_address, $page ) {
$data = array();
$student = self::get_student_by_email( $email_address );
if ( ! $student ) {
return self::get_return( $data );
}
$certs = self::get_student_certificates( $student );
if ( $certs ) {
$group_label = __( 'Certificates', 'lifterlms' );
$group_description = __( 'Student certificate data.', 'lifterlms' );
foreach ( $certs as $cert ) {
$data[] = array(
'group_id' => 'lifterlms_certificates',
'group_label' => $group_label,
'group_description' => $group_description,
'item_id' => sprintf( 'certificate-%d', $cert->get( 'id' ) ),
'data' => self::get_certificate_data( $cert ),
);
}
}
return self::get_return( $data );
}
/**
* Get data for a certificate
*
* @since 3.18.0
*
* @param obj $achievement LLMS_User_Certificate.
* @return array
*/
private static function get_achievement_data( $achievement ) {
$data = array();
$data[] = array(
'name' => __( 'Title', 'lifterlms' ),
'value' => $achievement->get( 'title' ),
);
$data[] = array(
'name' => __( 'Description', 'lifterlms' ),
'value' => $achievement->get( 'content' ),
);
$data[] = array(
'name' => __( 'Earned Date', 'lifterlms' ),
'value' => $achievement->get_earned_date( 'Y-m-d H:i:s' ),
);
$data[] = array(
'name' => __( 'Image', 'lifterlms' ),
'value' => $achievement->get_image(),
);
return $data;
}
/**
* Get data for a certificate.
*
* @since 3.18.0
* @since 6.0.0 Replaced the use of the deprecated `certificate_title` meta key with the post's title property.
*
* @param LLMS_User_Certificate $cert Certificate object.
* @return array
*/
private static function get_certificate_data( $cert ) {
$data = array();
$title = $cert->get( 'title' );
$filename = llms()->certificates()->get_export( $cert->get( 'id' ), true );
if ( ! is_wp_error( $filename ) ) {
$title = '<a href="certificates/' . basename( $filename ) . '">' . $title . '</a>';
}
$data[] = array(
'name' => __( 'Title', 'lifterlms' ),
'value' => $title,
);
$data[] = array(
'name' => __( 'Earned Date', 'lifterlms' ),
'value' => $cert->get_earned_date( 'Y-m-d H:i:s' ),
);
return $data;
}
/**
* Get an array of enrollment data for a course or membership
*
* @since 3.18.0
* @since 3.30.3 Fixed spelling errors.
*
* @param int $post_id WP Post ID of course or membership.
* @param obj $student LLMS_Student.
* @param obj $post_type_object WP post type object.
* @return array
*/
private static function get_enrollment_data( $post_id, $student, $post_type_object ) {
$data = array();
$data[] = array(
// Translators: %s = post type singular name label (Course or Membership).
'name' => sprintf( __( '%s Title', 'lifterlms' ), $post_type_object->labels->singular_name ),
'value' => get_the_title( $post_id ),
);
$data[] = array(
'name' => __( 'Enrollment Status', 'lifterlms' ),
'value' => llms_get_enrollment_status_name( $student->get_enrollment_status( $post_id ) ),
);
$data[] = array(
'name' => __( 'Enrollment Date', 'lifterlms' ),
'value' => $student->get_enrollment_date( $post_id, 'enrolled', 'Y-m-d H:i:s' ),
);
if ( 'course' === $post_type_object->name ) {
$data[] = array(
'name' => __( 'Last Activity', 'lifterlms' ),
'value' => $student->get_enrollment_date( $post_id, 'updated', 'Y-m-d H:i:s' ),
);
$progress = $student->get_progress( $post_id, 'course' );
if ( is_numeric( $progress ) ) {
$progress .= '%';
}
$data[] = array(
'name' => __( 'Progress', 'lifterlms' ),
'value' => $progress,
);
$grade = $student->get_grade( $post_id );
if ( is_numeric( $grade ) ) {
$grade .= '%';
}
$data[] = array(
'name' => __( 'Grade', 'lifterlms' ),
'value' => $grade,
);
}
return apply_filters( 'llms_privacy_export_enrollment_data', $data, $post_id, $student, $post_type_object );
}
/**
* Retrieve export data for a single order
*
* @since 3.18.0
*
* @param LLMS_Order $order Order object.
* @return array
*/
private static function get_order_data( $order ) {
$data = array();
$props = self::get_order_data_props( 'export' );
foreach ( $props as $prop => $name ) {
$value = apply_filters( 'llms_privacy_export_order_data_prop_value', $order->get( $prop ), $prop, $order );
if ( $value ) {
$data[] = array(
'name' => $name,
'value' => $value,
);
}
}
$transactions = $order->get_transactions(
array(
'per_page' => 500,
)
);
if ( $transactions['transactions'] ) {
$txns = array();
foreach ( $transactions['transactions'] as $txn ) {
$txns[] = sprintf( '%1$s — %2$s (#%3$d)', $txn->get( 'date' ), $txn->get_price( 'amount' ), $txn->get( 'id' ) );
}
$data[] = array(
'name' => __( 'Transactions', 'lifterlms' ),
'value' => implode( '<br>', $txns ),
);
}
return apply_filters( 'llms_privacy_export_order_data', $data, $order );
}
/**
* Get export data for a single quiz attempt
*
* @since 3.18.0
*
* @param LLMS_Quiz_Attempt $attempt Quiz attempt object.
* @return array
*/
private static function get_quiz_attempt_data( $attempt ) {
$data = array();
$quiz = $attempt->get_quiz();
if ( $quiz ) {
$data[] = array(
'name' => __( 'Title', 'lifterlms' ),
'value' => $quiz->get( 'title' ),
);
}
$data[] = array(
'name' => __( 'Attempt ID', 'lifterlms' ),
'value' => $attempt->get_key(),
);
$data[] = array(
'name' => __( 'Attempt Number', 'lifterlms' ),
'value' => $attempt->get( 'attempt' ),
);
$data[] = array(
'name' => __( 'Status', 'lifterlms' ),
'value' => $attempt->l10n( 'status' ),
);
$grade = $attempt->get( 'grade' );
$data[] = array(
'name' => __( 'Grade', 'lifterlms' ),
'value' => is_numeric( $grade ) ? $grade . '%' : '–',
);
return $data;
}
/**
* Return export data to an exporter
*
* @since 3.18.0
*
* @param array $data Array of data.
* @return array
*/
private static function get_return( $data = array(), $done = true ) {
return array(
'data' => $data,
'done' => $done,
);
}
/**
* Get student data to export for a user
*
* @since 3.18.0
*
* @param LLMS_Student $student Student object.
* @return array
*/
private static function get_student_data( $student ) {
$data = array();
$props = self::get_student_data_props();
foreach ( $props as $prop => $name ) {
$value = apply_filters( 'llms_privacy_export_student_data_prop_value', $student->get( $prop ), $prop, $student );
if ( $value ) {
$data[] = array(
'name' => $name,
'value' => $value,
);
}
}
return apply_filters( 'llms_privacy_export_student_data', $data, $student );
}
/**
* Export student course data by email address
*
* @since 3.18.0
*
* @param string $email_address Email address of the user to retrieve data for.
* @param int $page Process page number.
* @return array
*/
public static function course_data( $email_address, $page ) {
return self::enrollment_data( $email_address, $page, 'course' );
}
/**
* General exporter for handling course and membership enrollment data
*
* @since 3.18.0
* @since 3.37.9 Added `$group_description` to the group exporter.
*
* @param string $email_address Requested user's email address
* @param int $page process page number
* @param string $post_type name of the post type
* @return array
*/
private static function enrollment_data( $email_address, $page, $post_type ) {
$data = array();
$student = self::get_student_by_email( $email_address );
if ( ! $student ) {
return self::get_return( $data );
}
$enrollments = self::get_student_enrollments( $student, $page, $post_type );
if ( $enrollments['results'] ) {
$post_type_obj = get_post_type_object( $post_type );
$group_id = 'lifterlms_' . $post_type;
foreach ( $enrollments['results'] as $post_id ) {
$data[] = array(
'group_id' => $group_id,
'group_label' => $post_type_obj->labels->name,
/* translators: %s: The name of the enrollment post type. */
'group_description' => sprintf( __( 'Student %s enrollment data.', 'lifterlms' ), $post_type_obj->labels->name ),
'item_id' => sprintf( '%1$s-%2$d', $post_type, $post_id ),
'data' => self::get_enrollment_data( $post_id, $student, $post_type_obj ),
);
}
}
return self::get_return( $data, $enrollments['done'] );
}
/**
* Add files to the zip file for a data export request.
*
* Adds certificate files into the `/certificates/` directory within the archive.
*
* @since 3.18.0
* @since 6.0.0 Replaced the use of the deprecated `wp_get_user_request_data()` function with `wp_get_user_request()`.
*
* @param string $archive_pathname Full path to the zip archive.
* @param string $archive_url Full URI to the zip archive.
* @param string $html_report_pathname Full path to the .html file within the archive.
* @param int $request_id WP Post ID of the export request.
* @return void
*/
public static function maybe_add_export_files( $archive_pathname, $archive_url, $html_report_pathname, $request_id ) {
if ( ! class_exists( 'ZipArchive' ) ) {
return;
}
$request = wp_get_user_request( $request_id );
$student = self::get_student_by_email( $request->email );
if ( ! $student ) {
return;
}
$certs = self::get_student_certificates( $student );
if ( ! $certs ) {
return;
}
$zip = new ZipArchive();
$delete = array();
if ( true === $zip->open( $archive_pathname ) ) {
foreach ( $certs as $cert ) {
$filepath = llms()->certificates()->get_export( $cert->get( 'id' ), true );
$delete[ $cert->certificate_id ] = $filepath;
if ( is_wp_error( $filepath ) ) {
continue;
}
$zip->addFile( $filepath, '/certificates/' . basename( $filepath ) );
}
}
$zip->close();
// cleanup all files
foreach ( $delete as $id => $path ) {
wp_delete_file( $path );
delete_post_meta( $id, '_llms_export_filepath' );
}
}
/**
* Export student membership data by email address
*
* @since 3.18.0
*
* @param string $email_address email address of the user to retrieve data for
* @param int $page process page number
* @return array
*/
public static function membership_data( $email_address, $page ) {
return self::enrollment_data( $email_address, $page, 'llms_membership' );
}
/**
* Export student orders data by email address
*
* @since 3.18.0
* @since 3.37.9 Added `$group_description` to the group exporter.
*
* @param string $email_address Email address of the user to retrieve data for.
* @param int $page Process page number.
* @return array
*/
public static function order_data( $email_address, $page ) {
$data = array();
$student = self::get_student_by_email( $email_address );
if ( ! $student ) {
return self::get_return( $data );
}
$orders = self::get_student_orders( $student, $page );
$group_label = __( 'Orders', 'lifterlms' );
$group_description = __( 'Student orders data.', 'lifterlms' );
foreach ( $orders['orders'] as $order ) {
$data[] = array(
'group_id' => 'lifterlms_orders',
'group_label' => $group_label,
'group_description' => $group_description,
'item_id' => sprintf( 'order-%d', $order->get( 'id' ) ),
'data' => self::get_order_data( $order ),
);
}
return self::get_return( $data, $orders['done'] );
}
/**
* Export student data by email address
*
* @since 3.18.0
* @since 3.37.9 Added `$group_description` to the group exporter.
*
* @param string $email_address Email address of the user to retrieve data for.
* @param int $page Process page number.
* @return array
*/
public static function student_data( $email_address, $page ) {
$data = array();
$student = self::get_student_by_email( $email_address );
if ( ! $student ) {
return self::get_return( $data );
}
$data[] = array(
'group_id' => 'lifterlms_student',
'group_label' => __( 'Personal Information', 'lifterlms' ),
'group_description' => __( 'Student personal information data.', 'lifterlms' ),
'item_id' => sprintf( 'student-%d', $student->get( 'id' ) ),
'data' => self::get_student_data( $student ),
);
return self::get_return( $data );
}
/**
* Export quiz attempt data by email address
*
* @since 3.18.0
* @since 3.37.9 Added `$group_description` to the group exporter.
*
* @param string $email_address Email address of the user to retrieve data for.
* @param int $page Process page number.
* @return array
*/
public static function quiz_data( $email_address, $page ) {
$data = array();
$student = self::get_student_by_email( $email_address );
if ( ! $student ) {
return self::get_return( $data );
}
$query = self::get_student_quizzes( $student, $page );
$done = true;
if ( $query->has_results() ) {
$group_label = __( 'Quiz Attempts', 'lifterlms' );
$group_descriptions = __( 'Student quiz attempt data', 'lifterlms' );
foreach ( $query->get_attempts() as $attempt ) {
$data[] = array(
'group_id' => 'lifterlms_quizzes',
'group_label' => $group_label,
'group_description' => $group_description,
'item_id' => sprintf( 'order-%d', $attempt->get( 'id' ) ),
'data' => self::get_quiz_attempt_data( $attempt ),
);
}
$done = $query->is_last_page();
}
return self::get_return( $data, $done );
}
}
================================================
FILE: includes/privacy/class-llms-privacy.php
================================================
<?php
/**
* Main Privacy Class
*
* @package LifterLMS/Privacy/Classes
*
* @since 3.18.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Privacy class
*
* Hooks into WP Core data exporters and erasers to export / erase LifterLMS data.
*
* @since 3.18.0
* @since 3.37.9 Update CSS classes used in privacy text suggestions.
*/
class LLMS_Privacy extends LLMS_Abstract_Privacy {
/**
* Constructor.
*
* @since 3.18.0
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
public function __construct() {
parent::__construct( __( 'LifterLMS', 'lifterlms' ) );
/**
* Exporters
*/
$this->add_exporter( 'lifterlms-student-data', __( 'Student Data', 'lifterlms' ), array( 'LLMS_Privacy_Exporters', 'student_data' ) );
$this->add_exporter( 'lifterlms-course-data', __( 'Course Data', 'lifterlms' ), array( 'LLMS_Privacy_Exporters', 'course_data' ) );
$this->add_exporter( 'lifterlms-quiz-data', __( 'Quiz Data', 'lifterlms' ), array( 'LLMS_Privacy_Exporters', 'quiz_data' ) );
$this->add_exporter( 'lifterlms-membership-data', __( 'Membership Data', 'lifterlms' ), array( 'LLMS_Privacy_Exporters', 'membership_data' ) );
$this->add_exporter( 'lifterlms-order-data', __( 'Order Data', 'lifterlms' ), array( 'LLMS_Privacy_Exporters', 'order_data' ) );
$this->add_exporter( 'lifterlms-achievement-data', __( 'Achievement Data', 'lifterlms' ), array( 'LLMS_Privacy_Exporters', 'achievement_data' ) );
$this->add_exporter( 'lifterlms-certificate-data', __( 'Certificate Data', 'lifterlms' ), array( 'LLMS_Privacy_Exporters', 'certificate_data' ) );
/**
* Erasers
*/
$this->add_eraser( 'lifterlms-student-data', __( 'Student Data', 'lifterlms' ), array( 'LLMS_Privacy_Erasers', 'student_data' ) );
$this->add_eraser( 'lifterlms-quiz-data', __( 'Quiz Data', 'lifterlms' ), array( 'LLMS_Privacy_Erasers', 'quiz_data' ) );
$this->add_eraser( 'lifterlms-order-data', __( 'Order Data', 'lifterlms' ), array( 'LLMS_Privacy_Erasers', 'order_data' ) );
$this->add_eraser( 'lifterlms-achievement-data', __( 'Achievement Data', 'lifterlms' ), array( 'LLMS_Privacy_Erasers', 'achievement_data' ) );
$this->add_eraser( 'lifterlms-certificate-data', __( 'Order Data', 'lifterlms' ), array( 'LLMS_Privacy_Erasers', 'certificate_data' ) );
$this->add_eraser( 'lifterlms-notification-data', __( 'Notification Data', 'lifterlms' ), array( 'LLMS_Privacy_Erasers', 'notification_data' ) );
// This eraser should always be last because some of the items above rely on postmeta data to function.
$this->add_eraser( 'lifterlms-postmeta-data', __( 'Postmeta Data', 'lifterlms' ), array( 'LLMS_Privacy_Erasers', 'postmeta_data' ) );
/**
* Hooks
*/
// Add individual cert HTML files to the export directory.
add_action( 'wp_privacy_personal_data_export_file_created', array( 'LLMS_Privacy_Exporters', 'maybe_add_export_files' ), 100, 4 );
// Anonymize erased order properties.
add_filter( 'llms_privacy_get_anon_prop_value', array( 'LLMS_Privacy_Erasers', 'anonymize_prop' ), 10, 3 );
}
/**
* Anonymize a property value
*
* @since 3.18.0
*
* @param string $prop Property name.
* @param object $obj Associated object (if any).
* @return string
*/
public static function get_anon_prop_value( $prop, $obj = null ) {
return apply_filters( 'llms_privacy_get_anon_prop_value', '', $prop, $obj );
}
/**
* Retrieve an array of student data properties which should be exported & erased
*
* @since 3.18.0
*
* @param string $type Request type [export|erasure].
* @return array
*/
protected static function get_order_data_props( $type ) {
$props = array();
// don't erase these fields, only export them
if ( 'export' === $type ) {
$props = array(
'id' => __( 'Order Number', 'lifterlms' ),
'date' => __( 'Order Date', 'lifterlms' ),
'product_title' => __( 'Product', 'lifterlms' ),
'plan_title' => __( 'Plan', 'lifterlms' ),
);
} elseif ( 'erasure' === $type ) {
$props = array(
'user_id' => __( 'User ID', 'lifterlms' ),
);
}
$props = array_merge(
$props,
array(
'billing_first_name' => __( 'Billing First Name', 'lifterlms' ),
'billing_last_name' => __( 'Billing Last Name', 'lifterlms' ),
'billing_email' => __( 'Billing Email', 'lifterlms' ),
'billing_address_1' => __( 'Billing Address 1', 'lifterlms' ),
'billing_address_2' => __( 'Billing Address 2', 'lifterlms' ),
'billing_city' => __( 'Billing City', 'lifterlms' ),
'billing_state' => __( 'Billing State', 'lifterlms' ),
'billing_zip' => __( 'Billing Zip Code', 'lifterlms' ),
'billing_country' => __( 'Billing Country', 'lifterlms' ),
'billing_phone' => __( 'Phone', 'lifterlms' ),
'user_ip_address' => __( 'IP Address', 'lifterlms' ),
)
);
return apply_filters( 'llms_privacy_order_data_props', $props, $type );
}
/**
* Get the privacy message sample content
*
* This stub can be overloaded.
*
* @since 3.18.0
* @since 3.37.9 Replaced deprecated `.wp-policy-help` class with `.privacy-policy-tutorial`.
*
* @return string
*/
public function get_privacy_message() {
$content = '
<div class="wp-suggested-text">' .
'<p class="privacy-policy-tutorial">' .
__( 'This sample language includes the basics around what personal data your learning platform may be collecting, storing and sharing, as well as who may have access to that data. Depending on what settings are enabled and which additional add-ons are used, the specific information shared by your site will vary. We recommend consulting with a lawyer when deciding what information to disclose on your privacy policy.', 'lifterlms' ) .
'</p>' .
'<p>' . __( 'We collect information about you during the registration, enrollment, and checkout processes on our site.', 'lifterlms' ) . '</p>' .
'<h2>' . __( 'What we collect and store', 'lifterlms' ) . '</h2>' .
'<p>' . __( 'When you register an account with us, we’ll ask you to provide information including your name, billing address, email address, phone number, credit card/payment details and optional account information like username and password. We’ll use this information for purposes, such as, to:', 'lifterlms' ) . '</p>' .
'<ul>' .
'<li>' . __( 'Send you information about your account, orders, courses, and memberships', 'lifterlms' ) . '</li>' .
'<li>' . __( 'Communicate with you about courses and memberships that you’re enrolled in', 'lifterlms' ) . '</li>' .
'<li>' . __( 'Respond to your requests, including refunds and complaints', 'lifterlms' ) . '</li>' .
'<li>' . __( 'Process payments and prevent fraud', 'lifterlms' ) . '</li>' .
'<li>' . __( 'Set up your account for our site', 'lifterlms' ) . '</li>' .
'<li>' . __( 'Comply with any legal obligations we have', 'lifterlms' ) . '</li>' .
'<li>' . __( 'Improve our site’s offerings', 'lifterlms' ) . '</li>' .
'<li>' . __( 'Send you marketing messages, if you choose to receive them', 'lifterlms' ) . '</li>' .
'</ul>' .
'<p>' . __( 'When you create an account, we will store your name, address, email and phone number, which will be used to populate the enrollment and checkout for future purchases and enrollments.', 'lifterlms' ) . '</p>' .
'<p>' . __( 'We generally store information about you for as long as we need the information for the purposes for which we collect and use it, and we are not legally required to continue to keep it. For example, we will store order information for XXX years for tax and accounting purposes. This includes your name, email address and billing address.', 'lifterlms' ) . '</p>' .
'<p>' . __( 'We will also store comments or reviews, if you chose to leave them.', 'lifterlms' ) . '</p>' .
'<h2>' . __( 'Who on our team has access', 'lifterlms' ) . '</h2>' .
'<p>' . __( 'Members of our team have access to the information you provide us. For example, both Administrators and Site Managers can access:', 'lifterlms' ) . '</p>' .
'<ul>' .
'<li>' . __( 'Order information like what was purchased, when it was purchased and where it should be sent, and', 'lifterlms' ) . '</li>' .
'<li>' . __( 'Customer information like your name, email address, and billing information.', 'lifterlms' ) . '</li>' .
'</ul>' .
'<p>' . __( 'Course and membership instructors can access your course progress and activities including:', 'lifterlms' ) . '</p>' .
'<ul>' .
'<li>' . __( 'Enrollment dates for their courses and memberships', 'lifterlms' ) . '</li>' .
'<li>' . __( 'Course progress and status information for their courses', 'lifterlms' ) . '</li>' .
'<li>' . __( 'Quiz and assignments answers and grades for their courses', 'lifterlms' ) . '</li>' .
'<li>' . __( 'Comments and reviews made on their memberships and courses', 'lifterlms' ) . '</li>' .
'</ul>' .
'<p>' . __( 'Our team members have access to this information to help fulfill orders, process refunds, and support you.', 'lifterlms' ) . '</p>' .
'<h2>' . __( 'What we share with others', 'lifterlms' ) . '</h2>' .
'<p class="privacy-policy-tutorial">' . __( 'In this section you should list who you’re sharing data with, and for what purpose. This could include, but may not be limited to, analytics, marketing, payment gateways, and third party embeds.', 'lifterlms' ) . '</p>' .
'<p>' . __( 'We share information with third parties who help us provide our orders and store services to you; for example --', 'lifterlms' ) . '</p>' .
'</div>';
/**
* Customize the default privacy policy content provided by LifterLMS.
*
* @since 3.18.0
*
* @param string $content Privacy policy content as an html string.
*/
return apply_filters( 'llms_privacy_policy_content', $content );
}
/**
* Retrieve student achievements.
*
* @since 3.18.0
* @since 6.0.0 Updated the use of `LLMS_Student::get_achievements()` with its new behavior.
*
* @param LLMS_Student $student Student object.
* @return LLMS_User_Achievement[]
*/
protected static function get_student_achievements( $student ) {
$query = $student->get_achievements( array( 'sort' => array( 'date' => 'DESC' ) ) );
return $query->get_awards();
}
/**
* Retrieve student certificates.
*
* @since 3.18.0
* @since 6.0.0 Updated the use of `LLMS_Student::get_certificates()` with its new behavior.
*
* @param LLMS_Student $student Student object.
* @return LLMS_User_Certificate[]
*/
protected static function get_student_certificates( $student ) {
$query = $student->get_certificates( array( 'sort' => array( 'date' => 'DESC' ) ) );
return $query->get_awards();
}
/**
* Retrieve an array of student data properties which should be exported & erased
*
* @since 3.18.0
*
* @return array
*/
protected static function get_student_data_props() {
return apply_filters(
'llms_privacy_get_student_data_props',
array(
'billing_address_1' => __( 'Billing Address 1', 'lifterlms' ),
'billing_address_2' => __( 'Billing Address 2', 'lifterlms' ),
'billing_city' => __( 'Billing City', 'lifterlms' ),
'billing_state' => __( 'Billing State', 'lifterlms' ),
'billing_zip' => __( 'Billing Zip Code', 'lifterlms' ),
'billing_country' => __( 'Billing Country', 'lifterlms' ),
'phone' => __( 'Phone', 'lifterlms' ),
'ip_address' => __( 'IP Address', 'lifterlms' ),
'last_login' => __( 'Last Login Date', 'lifterlms' ),
)
);
}
/**
* Retrieve student course & membership enrollment data
*
* @since 3.18.0
*
* @param LLMS_Student $student Student object.
* @param int $page Page number.
* @param string $post_type WP Post type (course/membership).
* @return array
*/
protected static function get_student_enrollments( $student, $page, $post_type ) {
$limit = 250;
$enrollments = $student->get_enrollments(
$post_type,
array(
'limit' => $limit,
'skip' => ( $page - 1 ) * $limit,
)
);
return array(
'done' => ( ! $enrollments['more'] ),
'results' => $enrollments['results'],
);
}
/**
* Retrieve student orders
*
* @since 3.18.0
*
* @param LLMS_Student $student Student object.
* @param int $page Page number.
* @return array
*/
protected static function get_student_orders( $student, $page ) {
$done = true;
$results = array();
$orders = $student->get_orders(
array(
'count' => 250,
'page' => $page,
)
);
if ( $orders && $orders['pages'] ) {
$results = $orders['orders'];
$done = ( absint( $page ) === absint( $orders['pages'] ) );
}
return array(
'done' => $done,
'orders' => $results,
);
}
/**
* Retrieve student quizzes.
*
* @since 3.18.0
*
* @param LLMS_Student $student Student object.
* @param int $page Page number.
* @return LLMS_Query_Quiz_Attempt
*/
protected static function get_student_quizzes( $student, $page ) {
return new LLMS_Query_Quiz_Attempt(
array(
'page' => $page,
'per_page' => 500,
'quiz_id' => array(),
'student_id' => $student->get( 'id' ),
)
);
}
}
function llms_load_privacy() {
return new LLMS_Privacy();
}
add_action( 'init', 'llms_load_privacy' );
================================================
FILE: includes/privacy/index.php
================================================
<?php // silence.
================================================
FILE: includes/processors/class-llms-processor-achievement-sync.php
================================================
<?php
/**
* LLMS_Processor_Achievement_Sync class
*
* @package LifterLMS/Processors/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Processor: Sync awarded achievements to their achievement template.
*
* @since 6.0.0
*/
class LLMS_Processor_Achievement_Sync extends LLMS_Abstract_Processor_User_Engagement_Sync {
/**
* The type of the user engagement.
*
* @since 6.0.0
*
* @var string
*/
protected $engagement_type = 'achievement';
/**
* Unique identifier for the processor.
*
* @var string
*/
protected $id = 'awarded_achievements_bulk_sync';
/**
* WP Cron Hook for scheduling the background process.
*
* @var string
*/
protected $schedule_hook = 'llms_awarded_achievements_bulk_sync';
/**
* Returns a translated text of the given type.
*
* @since 6.0.0
*
* @param int $text_type One of the LLMS_Abstract_Processor_User_Engagement_Sync::TEXT_ constants.
* @param array $variables Optional variables that are used in sprintf().
* @return string
*/
protected function get_text( $text_type, $variables = array() ) {
$engagement_template_id = $variables['engagement_template_id'] ?? 0;
switch ( $text_type ) {
case self::TEXT_SYNC_NOTICE_ALREADY_SCHEDULED:
return sprintf(
/* translators: %1$s: opening anchor tag that links to the achievement template, %2$s: achievement template name, #%3$d: achievement template ID, %4$s: closing anchor tag */
__( 'Awarded achievements sync already scheduled for the template %1$s%2$s (#%3$d)%4$s.', 'lifterlms' ),
'<a href="' . get_edit_post_link( $engagement_template_id ) . '" target="_blank">',
get_the_title( $engagement_template_id ),
$engagement_template_id,
'</a>'
);
case self::TEXT_SYNC_NOTICE_AWARDED_ENGAGEMENTS_COMPLETE:
return sprintf(
/* translators: %1$s: opening anchor tag that links to the achievement template, %2$s: achievement template name, %3$d: achievement template ID, %4$s: closing anchor tag */
__( 'Awarded achievements sync completed for the template %1$s%2$s (#%3$d)%4$s.', 'lifterlms' ),
'<a href="' . $this->get_edit_post_link( $engagement_template_id ) . '" target="_blank">',
get_the_title( $engagement_template_id ),
$engagement_template_id,
'</a>'
);
case self::TEXT_SYNC_NOTICE_NO_AWARDED_ENGAGEMENTS:
return sprintf(
/* translators: %1$s: opening anchor tag that links to the achievement template, %2$s: achievement template name, #%3$d: achievement template ID, %4$s: closing anchor tag */
__( 'There are no awarded achievements to sync with the template %1$s%2$s (#%3$d)%4$s.', 'lifterlms' ),
'<a href="' . get_edit_post_link( $engagement_template_id ) . '" target="_blank">',
get_the_title( $engagement_template_id ),
$engagement_template_id,
'</a>'
);
case self::TEXT_SYNC_NOTICE_SCHEDULED:
return sprintf(
/* translators: %1$s: opening anchor tag that links to the achievement template, %2$s: achievement template name, #%3$d: achievement template ID, %4$s: closing anchor tag */
__( 'Awarded achievements sync scheduled for the template %1$s%2$s (#%3$d)%4$s.', 'lifterlms' ),
'<a href="' . get_edit_post_link( $engagement_template_id ) . '" target="_blank">',
get_the_title( $engagement_template_id ),
$engagement_template_id,
'</a>'
);
default:
return parent::get_text( $text_type );
}
}
}
return new LLMS_Processor_Achievement_Sync();
================================================
FILE: includes/processors/class-llms-processor-certificate-sync.php
================================================
<?php
/**
* LLMS_Processor_Certificate_Sync class
*
* @package LifterLMS/Processors/Classes
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Processor: Sync awarded certificates to their certificate template.
*
* @since 6.0.0
*/
class LLMS_Processor_Certificate_Sync extends LLMS_Abstract_Processor_User_Engagement_Sync {
/**
* The type of the user engagement.
*
* @since 6.0.0
*
* @var string
*/
protected $engagement_type = 'certificate';
/**
* Unique identifier for the processor.
*
* @var string
*/
protected $id = 'awarded_certificates_bulk_sync';
/**
* WP Cron Hook for scheduling the background process.
*
* @var string
*/
protected $schedule_hook = 'llms_awarded_certificates_bulk_sync';
/**
* Returns a translated text of the given type.
*
* @since 6.0.0
*
* @param int $text_type One of the LLMS_Abstract_Processor_User_Engagement_Sync::TEXT_ constants.
* @param array $variables Optional variables that are used in sprintf().
* @return string
*/
protected function get_text( $text_type, $variables = array() ) {
$engagement_template_id = $variables['engagement_template_id'] ?? 0;
switch ( $text_type ) {
case self::TEXT_SYNC_NOTICE_ALREADY_SCHEDULED:
return sprintf(
/* translators: %1$s: opening anchor tag that links to the certificate template, %2$s: certificate template name, #%3$d: certificate template ID, %4$s: closing anchor tag */
__( 'Awarded certificates sync already scheduled for the template %1$s%2$s (#%3$d)%4$s.', 'lifterlms' ),
'<a href="' . get_edit_post_link( $engagement_template_id ) . '" target="_blank">',
get_the_title( $engagement_template_id ),
$engagement_template_id,
'</a>'
);
case self::TEXT_SYNC_NOTICE_AWARDED_ENGAGEMENTS_COMPLETE:
return sprintf(
/* translators: %1$s: opening anchor tag that links to the certificate template, %2$s: certificate template name, %3$d: certificate template ID, %4$s: closing anchor tag */
__( 'Awarded certificates sync completed for the template %1$s%2$s (#%3$d)%4$s.', 'lifterlms' ),
'<a href="' . $this->get_edit_post_link( $engagement_template_id ) . '" target="_blank">',
get_the_title( $engagement_template_id ),
$engagement_template_id,
'</a>'
);
case self::TEXT_SYNC_NOTICE_NO_AWARDED_ENGAGEMENTS:
return sprintf(
/* translators: %1$s: opening anchor tag that links to the certificate template, %2$s: certificate template name, #%3$d: certificate template ID, %4$s: closing anchor tag */
__( 'There are no awarded certificates to sync with the template %1$s%2$s (#%3$d)%4$s.', 'lifterlms' ),
'<a href="' . get_edit_post_link( $engagement_template_id ) . '" target="_blank">',
get_the_title( $engagement_template_id ),
$engagement_template_id,
'</a>'
);
case self::TEXT_SYNC_NOTICE_SCHEDULED:
return sprintf(
/* translators: %1$s: opening anchor tag that links to the certificate template, %2$s: certificate template name, #%3$d: certificate template ID, %4$s: closing anchor tag */
__( 'Awarded certificates sync scheduled for the template %1$s%2$s (#%3$d)%4$s.', 'lifterlms' ),
'<a href="' . get_edit_post_link( $engagement_template_id ) . '" target="_blank">',
get_the_title( $engagement_template_id ),
$engagement_template_id,
'</a>'
);
default:
return parent::get_text( $text_type );
}
}
}
return new LLMS_Processor_Certificate_Sync();
================================================
FILE: includes/processors/class.llms.processor.course.data.php
================================================
<?php
/**
* Processor: Course Data
*
* @package LifterLMS/Processors/Classes
*
* @since 3.15.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Processor_Course_Data
*
* Handle background processing of average progress & average grade for courses.
*
* The background process calculates "expensive" aggregate course data and stores them
* on the `wp_postmeta` table so the data can be access later with a single
* database read.
*
* The process is queued for recalculation when:
*
* + Students enroll.
* + Students unenroll.
* + Students complete lessons.
* + Students complete quizzes.
*
* Upon completion, the following values can be accessed via the `LLMS_Course` model
* to retrieve the aggregate data for the course:
*
* + Average grade: `LLMS_Course::get( 'average_grade' )`
* + Average progress: `LLMS_Course::get( 'average_progress' )`
* + Number of currently enrolled students: `LLMS_Course::get( 'enrolled_students' )`
*
* @since 3.15.0
* @since 4.12.0 Remove (protected) method `LLMS_Processor_Course_Data::complete()`, the override of the parent method is no longer needed.
*/
class LLMS_Processor_Course_Data extends LLMS_Abstract_Processor {
/**
* Unique identifier for the processor
*
* @var string
*/
protected $id = 'course_data';
/**
* WP Cron Hook for scheduling the bg process
*
* @var string
*/
private $schedule_hook = 'llms_calculate_course_data';
/**
* Maximum number of students allowed in a course
*
* When enrollment is higher than this number
* throttling the calculations will be delayed.
*
* @var int
*/
private $throttle_max_students;
/**
* Frequency of calculation process when the process is throttled.
*
* @var int
*/
private $throttle_frequency;
/**
* Action triggered to queue queries needed to make the calculation
*
* @since 3.15.0
* @since 4.12.0 Add throttling by course in progress and adjust last_run calculation to be specific to the course.
* Improve performance of the student query by removing unneeded sort columns.
* @since 4.21.0 When there's no students found in the course, run the `task_complete()` method to ensure data
* from a previous calculation is cleared.
* @since 6.0.0 Don't access `LLMS_Student_Query` properties directly.
*
* @param int $course_id WP Post ID of the course.
* @return void|null
*/
public function dispatch_calc( $course_id ) {
$this->log( sprintf( 'Course data calculation dispatched for course %d.', $course_id ) );
// Make sure we have a course.
$course = llms_get_post( $course_id );
if ( ! $course instanceof LLMS_Course ) {
return null;
}
// Return early if we're already processing data for the given course.
if ( $this->is_already_processing_course( $course_id ) ) {
return $this->dispatch_calc_throttled( $course_id );
}
// Retrieve args.
$args = $this->get_student_query_args( $course_id );
// Get the results for the current set of arguments.
$query = new LLMS_Student_Query( $args );
// No students in the course, run task completion.
if ( ! $query->get_number_results() ) {
return $this->task_complete( $course, $this->get_task_data(), true );
}
// Get the total number of students as a separate query since deprecating SQL_CALC_FOUND_ROWS usage.
$count_query = new LLMS_Student_Query( $this->get_student_count_query_from_args( $args ) );
if ( ! $count_query->get_count_only_result() ) {
return $this->task_complete( $course, $this->get_task_data(), true );
}
$course->set( 'enrolled_students', $count_query->get_count_only_result() );
// Throttle processing.
if ( $this->maybe_throttle( $count_query->get_count_only_result(), $course_id ) ) {
return $this->dispatch_calc_throttled( $course_id );
}
// Add each page to the queue.
$max_pages = absint( ceil( $count_query->get_count_only_result() / $args['per_page'] ) );
// Pass in the max pages as an argument to the task so we don't need to run the count query each time.
$args['max_pages'] = $max_pages;
while ( $args['page'] <= $max_pages ) {
$this->push_to_queue( $args );
++$args['page'];
}
// Save queue and dispatch the process.
$this->save()->dispatch();
}
/**
* Schedule data calculation for the future
*
* This method is called when data processing is triggered for a course that is currently being processed
* or for a course that qualifies for process throttling based on the number of students in the course.
*
* @since 4.12.0
*
* @param int $course_id WP_Post ID of the course.
* @return void
*/
protected function dispatch_calc_throttled( $course_id ) {
$this->schedule_calculation( $course_id, time() + $this->throttle_frequency );
$this->log( sprintf( 'Course data calculation throttled for course %d.', $course_id ) );
}
/**
* Modify the query arguments for calculating the total count.
*
* @param $args
*
* @return array Array of arguments passed to an LLMS_Student_Query for calculating the student count.
*/
protected function get_student_count_query_from_args( $args ) {
$count_args = array_merge( $args, array( 'count_only' => true ) );
return $count_args;
}
/**
* Retrieve arguments used to perform an LLMS_Student_Query for background data processing
*
* @since 4.12.0
*
* @param int $course_id WP_Post ID of the course.
* @return array Array of arguments passed to an LLMS_Student_Query.
*/
protected function get_student_query_args( $course_id ) {
/**
* Filter the query arguments used when calculating course data
*
* @since 4.12.0
*
* @param array $args Query arguments passed to LLMS_Student_Query.
* @param LLMS_Processor_Course_Data $processor Instance of the data processor class.
*/
return apply_filters(
'llms_data_processor_course_data_student_query_args',
array(
'post_id' => $course_id,
'statuses' => array( 'enrolled' ),
'page' => 1,
'per_page' => 100,
'sort' => array(
'id' => 'ASC',
),
'no_found_rows' => true,
),
$this
);
}
/**
* Retrieve a timestamp for the last time data calculation was completed for a given course
*
* @since 4.12.0
*
* @param int $course_id WP_Post ID of the course.
* @return int The timestamp of the last run. Returns `0` when no data recorded.
*/
protected function get_last_run( $course_id ) {
return absint( get_post_meta( $course_id, '_llms_last_data_calc_run', true ) );
}
/**
* Retrieve structured task data array.
*
* Ensures the expected required array keys are found on the task array
* and optionally merges in an existing array of day with the (empty) defaults.
*
* @since 4.21.0
*
* @param array $data Existing array of day (from a previous task).
* @return array
*/
protected function get_task_data( $data = array() ) {
return wp_parse_args(
$data,
array(
'students' => 0,
'progress' => 0,
'quizzes' => 0,
'grade' => 0,
)
);
}
/**
* Initializer
*
* @since 3.15.0
*
* @return void
*/
protected function init() {
// For the cron.
add_action( $this->schedule_hook, array( $this, 'dispatch_calc' ), 10, 1 );
// For LifterLMS actions which trigger recalculation.
$this->actions = array(
'llms_course_calculate_data' => array(
'arguments' => 1,
'callback' => 'schedule_calculation',
'priority' => 10,
),
'llms_user_enrolled_in_course' => array(
'arguments' => 2,
'callback' => 'schedule_from_course',
'priority' => 10,
),
'llms_user_removed_from_course' => array(
'arguments' => 2,
'callback' => 'schedule_from_course',
'priority' => 10,
),
'lifterlms_lesson_completed' => array(
'arguments' => 2,
'callback' => 'schedule_from_lesson',
'priority' => 10,
),
'lifterlms_quiz_completed' => array(
'arguments' => 3,
'callback' => 'schedule_from_quiz',
'priority' => 10,
),
);
/**
* Throttles course data processing based on the number of a students in a course.
*
* If the number of students in a course is greater than or equal to this number, the background
* process will be throttled to run only once every N hours where N is equal to the number of hours
* defined by the `llms_data_processor_course_data_throttle_frequency` filter.
*
* @since 3.15.0
* @since 4.12.0 Reduced default value of `$number_students` from 2500 to 500.
*
* @see llms_data_processor_course_data_throttle_frequency
*
* @param int $number_students The number of students. Default is `500`.
* @param LLMS_Processor_Course_Data $processor Instance of the data processor class.
*/
$this->throttle_max_students = apply_filters( 'llms_data_processor_course_data_throttle_count', 500, $this );
/**
* Frequency to run the processor for a given course when processing is throttled
*
* @since 3.15.0
*
* @see llms_data_processor_course_data_throttle_count
*
* @param int $frequency Frequency of the calculation process in seconds. Default `HOUR_IN_SECONDS * 4`.
* @param LLMS_Processor_Course_Data $processor Instance of the data processor class.
*/
$this->throttle_frequency = apply_filters( 'llms_data_processor_course_data_throttle_frequency', HOUR_IN_SECONDS * 4, $this );
}
/**
* Determines if the supplied course is already being processed.
*
* If it's already being processed we'll throttle the processing so we'll wait until the course
* completes its current data processing and start again later.
*
* @since 4.12.0
*
* @param int $course_id WP_Post ID of the course.
* @return boolean
*/
protected function is_already_processing_course( $course_id ) {
return llms_parse_bool( get_post_meta( $course_id, '_llms_temp_calc_data_lock', true ) );
}
/**
* For large courses, only recalculate once every 4 hours
*
* @since 3.15.0
* @since 4.12.0 Adjusted access from private to protected.
* Pull last run data on a per-course basis.
* Added parameter `$course_id`.
*
* @param int $num_students Number of students in the current course.
* @param int $course_id WP_Post ID of the course.
* @return boolean When `true` the dispatch is throttled and when `false` it will run.
*/
protected function maybe_throttle( $num_students, $course_id ) {
$throttled = false;
if ( $num_students >= $this->throttle_max_students ) {
$throttled = ( time() - $this->get_last_run( $course_id ) <= $this->throttle_frequency );
}
/**
* Filters whether or not data processing is throttled for a request
*
* @since 4.12.0
*
* @param boolean $throttled If `true`, the processing for the current request is throttled, otherwise data processing will begin.
* @param int $num_students Number of students in the current course.
* @param int $course_id WP_Post ID of the course.
* $param int $max_students Maximum number of students in the course before processing is throttled.
*/
return apply_filters( 'llms_data_processor_course_data_throttled', $throttled, $num_students, $course_id, $this->throttle_max_students );
}
/**
* Schedule recalculation from actions triggered against a course
*
* @since 3.15.0
*
* @param int $user_id WP user id of the student.
* @param int $course_id WP Post ID of the course.
* @return void
*/
public function schedule_from_course( $user_id, $course_id ) {
$this->schedule_calculation( $course_id );
}
/**
* Schedule recalculation from actions triggered against a lesson
*
* @since 3.15.0
*
* @param int $user_id WP user id of the student.
* @param int $lesson_id WP Post ID of the lesson.
* @return void
*/
public function schedule_from_lesson( $user_id, $lesson_id ) {
$lesson = llms_get_post( $lesson_id );
$this->schedule_calculation( $lesson->get( 'parent_course' ) );
}
/**
* Schedule recalculation from actions triggered against a quiz
*
* @since 3.15.0
*
* @param int $user_id WP user id of the student.
* @param int $quiz_id WP Post ID of the quiz.
* @param LLMS_Quiz_Attempt $attempt Quiz attempt object.
* @return void
*/
public function schedule_from_quiz( $user_id, $quiz_id, $attempt ) {
$this->schedule_from_lesson( $user_id, $attempt->get( 'lesson_id' ) );
}
/**
* Schedule a calculation to execute
*
* This will schedule an event that will setup the queue of items for the background process.
*
* @since 3.15.0
* @since 4.21.0 Force `$course_id` to an absolute integer to avoid duplicate scheduling resulting from loose variable typing.
*
* @param int $course_id WP Post ID of the course.
* @param int $time Optionally pass a timestamp for when the event should be run.
* @return void
*/
public function schedule_calculation( $course_id, $time = null ) {
$course_id = absint( $course_id );
$this->log( sprintf( 'Course data calculation triggered for course %d.', $course_id ) );
$args = array( $course_id );
if ( ! wp_next_scheduled( $this->schedule_hook, $args ) ) {
$time = ! $time ? time() : $time;
wp_schedule_single_event( $time, $this->schedule_hook, $args );
$this->log( sprintf( 'Course data calculation scheduled for course %d.', $course_id ) );
}
}
/**
* Execute calculation for each item in the queue until all students in the course have been polled
*
* Stores the data in the postmeta table to be accessible via LLMS_Course.
*
* @since 3.15.0
* @since 4.12.0 Moved task completion logic to `task_complete()`.
* @since 4.16.0 Fix log string to properly record the post_id.
* @since 4.21.0 Use `get_task_data()` to merge/retrieve aggregate task data.
* Return early for non-courses.
*
* @param array $args Query arguments passed to LLMS_Student_Query.
* @return boolean Always returns `false` to remove the item from the queue when processing is complete.
*/
public function task( $args ) {
$this->log( sprintf( 'Course data calculation task called for course %1$d with args: %2$s', $args['post_id'], wp_json_encode( $args ) ) );
$course = llms_get_post( $args['post_id'] );
// Only process existing courses.
if ( ! $course instanceof LLMS_Course ) {
$this->log( sprintf( 'Course data calculation task skipped for course %1$d.', $args['post_id'] ) );
return false;
}
// Lock the course against duplicate processing.
$course->set( 'temp_calc_data_lock', 'yes' );
// Get saved data or empty array when on first page.
$data = ( 1 !== $args['page'] ) ? $course->get( 'temp_calc_data' ) : array();
// Merge with the defaults.
$data = $this->get_task_data( $data );
/**
* Save the max number of pages value passed in when the tasks were pushed to the queue.
*
* If a task was dispatched without it, set the max pages to 0 so we can try to calculate the count
* using a new count-only query.
*/
$max_pages = isset( $args['max_pages'] ) ? $args['max_pages'] : 0;
unset( $args['max_pages'] );
// Perform the query.
$query = new LLMS_Student_Query( $args );
foreach ( $query->get_students() as $student ) {
// Progress, all students counted here.
++$data['students'];
$data['progress'] = $data['progress'] + $student->get_progress( $args['post_id'] );
// Grades only counted when a student has taken a quiz.
// If a student hasn't taken it, we don't count it as a 0 on the quiz.
$grade = $student->get_grade( $args['post_id'] );
// Only check actual quiz grades.
if ( is_numeric( $grade ) ) {
++$data['quizzes'];
$data['grade'] = $data['grade'] + $grade;
}
}
if ( $max_pages === 0 ) {
$count_query = new LLMS_Student_Query( $this->get_student_count_query_from_args( $args ) );
if ( ! $count_query->get_count_only_result() ) {
// End processing when we can't get the count.
$is_last_page = true;
return $this->task_complete( $course, $data, $is_last_page );
}
$max_pages = absint( ceil( $count_query->get_count_only_result() / $args['per_page'] ) );
}
$is_last_page = ( absint( $max_pages ) === absint( $args['page'] ) );
return $this->task_complete( $course, $data, $is_last_page );
}
/**
* Complete a task
*
* Stores the current (incomplete) array of course data on the postmeta table for use
* by the next task in the queue.
*
* Upon completion, uses the data array to calculate the final aggregate values and store
* them on the postmeta table for the course for quick retrieval later.
*
* @since 4.12.0
* @since 4.16.0 Fix log string to properly log the course id.
*
* @param LLMS_Course $course Course object.
* @param array $data Aggregate calculation data array.
* @param boolean $last_page Whether or not this is the last page set of students for the process.
* @return boolean Always returns false.
*/
protected function task_complete( $course, $data, $last_page ) {
$this->log( sprintf( 'Course data calculation task completed for course %1$d with data: %2$s', $course->get( 'id' ), wp_json_encode( $data ) ) );
// Save our work on the last run.
if ( $last_page ) {
// Calculate.
$grade = $data['quizzes'] ? round( $data['grade'] / $data['quizzes'], 2 ) : 0;
$progress = $data['students'] ? round( $data['progress'] / $data['students'], 2 ) : 0;
// Save the data to the course.
$course->set( 'average_grade', $grade );
$course->set( 'average_progress', $progress );
$course->set( 'enrolled_students', $data['students'] );
$course->set( 'last_data_calc_run', time() );
// Delete the temporary data so its fresh for next time.
delete_post_meta( $course->get( 'id' ), '_llms_temp_calc_data' );
// Unlock the course.
delete_post_meta( $course->get( 'id' ), '_llms_temp_calc_data_lock' );
$this->log( sprintf( 'Course data calculation completed for course %d.', $course->get( 'id' ) ) );
} else {
// Save temporary data so it can be used by the next run in the process.
$course->set( 'temp_calc_data', $data );
}
return false;
}
}
return new LLMS_Processor_Course_Data();
================================================
FILE: includes/processors/class.llms.processor.membership.bulk.enroll.php
================================================
<?php
/**
* Processor: Membership Bulk Enroll
*
* @package LifterLMS/Processors/Classes
*
* @since 3.15.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Processor_Membership_Bulk_Enroll class
*
* Handle background processing of average progress & average grade for LifterLMS Courses.
* This triggers a bg process which gets the current progress
* of all students in a course.
*
* Progress is queued for recalculation when:
* students enroll
* students unenroll
* students complete lessons
*
* @since 3.15.0
* @since 3.26.1 Unknown.
*/
class LLMS_Processor_Membership_Bulk_Enroll extends LLMS_Abstract_Processor {
/**
* Unique identifier for the processor
*
* @var string
*/
protected $id = 'membership_bulk_enroll';
/**
* WP Cron Hook for scheduling the bg process
*
* @var string
*/
private $schedule_hook = 'llms_membership_bulk_enroll';
/**
* Action triggered to queue all students who need to be enrolled
*
* @since 3.15.0
* @since 6.0.0 Don't access `LLMS_Student_Query` properties directly.
*
* @param int $membership_id WP Post ID of the membership.
* @param int $course_id WP Post ID of the course to enroll members into.
* @return void
*/
public function dispatch_enrollment( $membership_id, $course_id ) {
$this->log( sprintf( 'membership bulk enrollment dispatched for membership %1$d into course %2$d', $membership_id, $course_id ) );
// cancel process in case it's currently running
$this->cancel_process();
$args = array(
'post_id' => $membership_id,
'statuses' => 'enrolled',
'page' => 1,
'per_page' => 250,
);
$query = new LLMS_Student_Query( $args );
if ( $query->has_results() ) {
while ( $args['page'] <= $query->get_max_pages() ) {
$this->push_to_queue(
array(
'course_id' => $course_id,
'query_args' => $args,
'trigger' => sprintf( 'membership_%d', $membership_id ),
)
);
$args['page']++;
}
$this->save()->dispatch();
$this->log( sprintf( 'membership bulk enrollment started for membership %1$d into course %2$d', $membership_id, $course_id ) );
}
}
/**
* Initializer
*
* @return void
* @since 3.15.0
* @version 3.15.0
*/
protected function init() {
// for the cron
add_action( $this->schedule_hook, array( $this, 'dispatch_enrollment' ), 10, 2 );
// for LifterLMS actions which trigger bulk enrollment
$this->actions = array(
'llms_membership_do_bulk_course_enrollment' => array(
'arguments' => 2,
'callback' => 'schedule_enrollment',
'priority' => 10,
),
);
}
/**
* Schedule bulk enrollment
* This will schedule an event that will setup the queue of items for the background process
*
* @param int $membership_id WP Post ID of the membership
* @param int $course_id WP Post ID of the course to enroll members into
* @return void
* @since 3.15.0
* @version 3.15.0
*/
public function schedule_enrollment( $membership_id, $course_id ) {
$this->log( sprintf( 'membership bulk enrollment triggered for membership %1$d into course %2$d', $membership_id, $course_id ) );
$args = array( $membership_id, $course_id );
if ( ! wp_next_scheduled( $this->schedule_hook, $args ) ) {
wp_schedule_single_event( time(), $this->schedule_hook, $args );
$this->log( sprintf( 'membership bulk enrollment scheduled for membership %1$d into course %2$d', $membership_id, $course_id ) );
}
}
/**
* Execute calculation for each item in the queue until all students in the course have been polled.
*
* Stores the data in the postmeta table to be accessible via LLMS_Course.
*
* @since 3.15.0
* @since 6.0.0 Replaced access of LLMS_Student_Query::$found_results protected property with LLMS_Student_Query::has_results().
*
* @param array $item Array of processing data.
* @return boolean True to keep the item in the queue and process again.
* False to remove the item from the queue.
*/
public function task( $item ) {
$this->log( sprintf( 'membership bulk enrollment task started for membership %1$d into course %2$d', $item['query_args']['post_id'], $item['course_id'] ) );
$this->log( $item );
// ensure the item has all the data we need to process it
if ( ! is_array( $item ) || ! isset( $item['course_id'] ) || ! isset( $item['query_args'] ) || ! isset( $item['trigger'] ) ) {
return false;
}
// turn the course data processor off
$course_data_processor = llms()->processors()->get( 'course_data' );
if ( $course_data_processor ) {
$course_data_processor->disable();
}
$query = new LLMS_Student_Query( $item['query_args'] );
if ( $query->has_results() ) {
foreach ( $query->get_students() as $student ) {
$student->enroll( $item['course_id'], $item['trigger'] );
}
}
if ( $query->is_last_page() ) {
$this->log( sprintf( 'membership bulk enrollment completed for membership %1$d into course %2$d', $item['query_args']['post_id'], $item['course_id'] ) );
// turn the course data processor back on
if ( $course_data_processor ) {
$course_data_processor->add_actions();
}
// process the course data
do_action( 'llms_course_calculate_data', $item['course_id'] );
}
return false;
}
}
return new LLMS_Processor_Membership_Bulk_Enroll();
================================================
FILE: includes/processors/class.llms.processors.php
================================================
<?php
/**
* Processors.
*
* @package LifterLMS/Processors/Classes
*
* @since 3.15.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Processors class
*
* Load, access, and manage LifterLMS Processors
*
* @since 3.15.0
* @since 5.0.0 Removed private method `includes()`.
* Stop loading removed processor "table_to_csv".
* @since 5.3.0 Replace singleton code with `LLMS_Trait_Singleton`.
* @since 6.0.0 Added the awarded certificates bulk sync processor.
* Removed the deprecated `LLMS_Processors::$_instance` property.
*/
class LLMS_Processors {
use LLMS_Trait_Singleton;
/**
* Processor classes that should be loaded
*
* This should match the classname of a processor.
*
* @var array
*/
private $classes = array(
'achievement_sync',
'certificate_sync',
'course_data',
'membership_bulk_enroll',
);
/**
* Array of available processors loaded via $this->load_all()
*
* @var LLMS_Abstract_Processor[]
*/
private $processors = array();
/**
* Constructor.
*
* @since 3.15.0
* @since 5.0.0 Remove call to removed method `includes()`.
* @since 6.0.0 Made sure the admin notices file is required.
*
* @return void
*/
private function __construct() {
// Processors may trigger a notice during a cron and notices might not be available.
require_once LLMS_PLUGIN_DIR . 'includes/admin/class.llms.admin.notices.php';
$this->load_all();
}
/**
* Access a single loaded processor instance
*
* @since 3.15.0
*
* @param string $name Name of the processor.
* @return LLMS_Abstract_Processor|false Instance of the processor if found, otherwise false.
*/
public function get( $name ) {
if ( isset( $this->processors[ $name ] ) ) {
return $this->processors[ $name ];
}
return false;
}
/**
* Load all processors.
*
* @since 3.15.0
* @since 5.8.0 Use the value from the `llms_load_processors` filter.
*
* @return void
*/
private function load_all() {
/**
* Filter the list of available processors to be loaded.
*
* Third parties can use this filter to load custom processors.
*
* @since 5.0.0
*
* @see llms_load_processor_path To add a custom load path for the loaded processor.
*
* @param string[] $classes A list of processor class ids/slugs.
*/
$classes = apply_filters( 'llms_load_processors', $this->classes );
foreach ( $classes as $name ) {
$class = $this->load_processor( $name );
if ( $class ) {
$this->processors[ $name ] = $class;
}
}
}
/**
* Load a single processor
*
* @since 3.15.0
* @since 6.0.0 Added the ability to load processor class files with dashes in their file name.
*
* @param string $name Name of the processor.
* @return LLMS_Abstract_Processor|boolean Instance of the processor if found and not yet included, `false` if
* the processor can't be found, and `true` if it has already been included.
*/
public function load_processor( $name ) {
/**
* Filter the path of a processor class.
*
* If the returned path isn't the full path to a PHP file the file will be attempted to be
* loaded from the LifterLMS core's processor directory by replacing underscores with dashes
* and prepending `class-llms-processor-` and appending `.php`.
*
* @since 5.0.0
*
* @see LLMS_Processors::load_all() For the `llms_load_processors` filter used to register custom processors.
*
* @param string $name Processor class name ID/slug.
*/
$path = apply_filters( 'llms_load_processor_path', $name );
// Try loading the filtered processor path.
if ( $path !== $name ) {
return file_exists( $name ) ? require_once $name : false;
}
$file = 'class-llms-processor-' . str_replace( '_', '-', $name ) . '.php';
$path = LLMS_PLUGIN_DIR . 'includes/processors/';
// Try loading a LifterLMS processor with a dashed file name.
if ( file_exists( $path . $file ) ) {
return require_once $path . $file;
}
// Try loading a LifterLMS processor with a dotted file name.
$file = str_replace( '-', '.', $file );
if ( file_exists( $path . $file ) ) {
return require_once $path . $file;
}
return false;
}
}
================================================
FILE: includes/processors/index.php
================================================
<?php // quiet.
================================================
FILE: includes/schemas/index.php
================================================
<?php // No.
================================================
FILE: includes/schemas/llms-block-templates.php
================================================
<?php
/**
* Post type block templates.
*
* Returns an array of post type block types for use in post type registration.
*
* @package LifterLMS/Schemas
*
* @since 6.0.0
* @version 7.3.0
*
* @see LLMS_Post_Types::get_template().
* @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-templates/
*/
defined( 'ABSPATH' ) || exit;
global $wp_version;
$blocks_styles = array(
'certificate' => array(
'title' => array(
'style' => array(
'typography' => array(
'fontSize' => '90px',
'lineHeight' => '1.1',
),
'spacing' => array(
'margin' => array(
'top' => '40px',
'bottom' => '0px',
),
),
),
'textColor' => 'black',
),
'h2' => array(
'style' => array(
'typography' => array(
'fontSize' => '48px',
'lineHeight' => '1.3',
),
'spacing' => array(
'margin' => array(
'top' => '0px',
'bottom' => '0px',
),
),
),
'textColor' => 'black',
),
'h3' => array(
'style' => array(
'typography' => array(
'fontSize' => '32px',
'lineHeight' => '1.3',
),
'spacing' => array(
'margin' => array(
'top' => '0px',
'bottom' => '0px',
),
),
),
'textColor' => 'black',
),
'p' => array(
'style' => array(
'typography' => array(
'fontSize' => '18px',
'lineHeight' => '1.6',
),
),
'textColor' => 'black',
),
'spacer' => array(
'height' => version_compare( $wp_version, '6.3-beta2', '>=' ) ? '100px' : 100,
),
),
);
/**
* Filters the template blocks styling.
*
* @since 6.0.0
*
* @param array $blocks_styles Array of blocks styles.
*/
$blocks_styles = apply_filters( 'llms_block_templates_styling', $blocks_styles );
/**
* Shared block template for the `llms_certificate` and `llms_my_certificate` post types.
*
* @since 6.0.0
* @since 6.1.0 Changed the certificate template's use of the `{current_date}` merge code to `{earned_date}`.
*/
$certificates = array(
array(
'llms/certificate-title',
array(
'style' => $blocks_styles['certificate']['title']['style'],
'textColor' => $blocks_styles['certificate']['title']['textColor'],
),
),
array(
'core/spacer',
array(
'height' => $blocks_styles['certificate']['spacer']['height'],
),
),
array(
'core/heading',
array(
'content' => __( 'Presented to', 'lifterlms' ),
'level' => 3,
'textAlign' => 'center',
'style' => $blocks_styles['certificate']['h3']['style'],
'textColor' => $blocks_styles['certificate']['h3']['textColor'],
),
),
array(
'core/heading',
array(
'content' => '[llms-user display_name]',
'level' => 2,
'textAlign' => 'center',
'style' => $blocks_styles['certificate']['h2']['style'],
'textColor' => $blocks_styles['certificate']['h2']['textColor'],
),
),
array(
'core/heading',
array(
'content' => __( 'for demonstration of excellence', 'lifterlms' ),
'level' => 3,
'textAlign' => 'center',
'style' => $blocks_styles['certificate']['h3']['style'],
'textColor' => $blocks_styles['certificate']['h3']['textColor'],
),
),
array(
'core/spacer',
array(
'height' => $blocks_styles['certificate']['spacer']['height'],
),
),
array(
'core/columns',
array(
'isStackedOnMobile' => false,
),
array(
array(
'core/column',
array(),
array(
array(
'core/paragraph',
array(
'align' => 'center',
'content' => '{earned_date}',
'style' => $blocks_styles['certificate']['p']['style'],
'textColor' => $blocks_styles['certificate']['p']['textColor'],
),
),
array(
'core/separator',
array(
'align' => 'center',
),
),
array(
'core/paragraph',
array(
'align' => 'center',
'content' => __( 'DATE', 'lifterlms' ),
'style' => $blocks_styles['certificate']['p']['style'],
'textColor' => $blocks_styles['certificate']['p']['textColor'],
),
),
),
),
array( 'core/column' ),
array(
'core/column',
array(),
array(
array(
'core/paragraph',
array(
'align' => 'center',
'content' => '{site_title}',
'style' => $blocks_styles['certificate']['p']['style'],
'textColor' => $blocks_styles['certificate']['p']['textColor'],
),
),
array(
'core/separator',
array(
'align' => 'center',
),
),
array(
'core/paragraph',
array(
'align' => 'center',
'content' => __( 'SIGNED', 'lifterlms' ),
'style' => $blocks_styles['certificate']['p']['style'],
'textColor' => $blocks_styles['certificate']['p']['textColor'],
),
),
),
),
),
),
);
return array(
'llms_certificate' => $certificates,
'llms_my_certificate' => $certificates,
);
================================================
FILE: includes/schemas/llms-db-updates.php
================================================
<?php
/**
* LifterLMS database migrations
*
* Lists database updates to be run during a plugin upgrade.
*
* Each array key should map to the LifterLMS version when the update should be run.
*
* Each array should contain a 'type' and 'updates' key
*
* The 'type' is either or either 'automatic' or 'manual'. Specifying whether
* or not the user is prompted to run the upgrade (manual) or if it just runs automatically during
* an upgrade (automatic).
*
* The 'updates' is an array of functions to be called to run the upgrade. They will be run in the order
* they are listed. A function to upgrade to the version should always be included as the last update in the list.
* This is important if multiple sets of updates need to be run during the same upgrade. For example a user upgrading from
* versions less than 3.0.0 would have to run the entire list of upgrades for each version and upgrading the version at the end
* of the set to the specific version will ensure that the next set of upgrades runs and then the next and so on.
*
* @package LifterLMS/Schemas
*
* @since 5.2.0
* @version 7.8.0
*/
defined( 'ABSPATH' ) || exit;
return array(
'3.0.0' => array(
'type' => 'manual',
'updates' => array(
'llms_update_300_create_access_plans',
'llms_update_300_del_deprecated_options',
'llms_update_300_migrate_account_field_options',
'llms_update_300_migrate_coupon_data',
'llms_update_300_migrate_course_postmeta',
'llms_update_300_migrate_lesson_postmeta',
'llms_update_300_migrate_order_data',
'llms_update_300_migrate_email_postmeta',
'llms_update_300_update_orders',
'llms_update_300_update_db_version',
),
),
'3.0.3' => array(
'type' => 'manual',
'updates' => array(
'llms_update_303_update_students_role',
'llms_update_303_update_db_version',
),
),
'3.4.3' => array(
'type' => 'manual',
'updates' => array(
'llms_update_343_update_relationships',
'llms_update_343_update_db_version',
),
),
'3.6.0' => array(
'type' => 'manual',
'updates' => array(
'llms_update_360_set_product_visibility',
'llms_update_360_update_db_version',
),
),
'3.8.0' => array(
'type' => 'manual',
'updates' => array(
'llms_update_380_set_access_plan_visibility',
'llms_update_380_update_db_version',
),
),
'3.12.0' => array(
'type' => 'manual',
'updates' => array(
'llms_update_3120_update_order_end_dates',
'llms_update_3120_update_integration_options',
'llms_update_3120_update_db_version',
),
),
'3.13.0' => array(
'type' => 'manual',
'updates' => array(
'llms_update_3130_create_default_instructors',
'llms_update_3130_builder_notice',
'llms_update_3130_update_db_version',
),
),
'3.16.0' => array(
'type' => 'manual',
'updates' => array(
'llms_update_3160_update_quiz_settings',
'llms_update_3160_lesson_to_quiz_relationships_migration',
'llms_update_3160_attempt_migration',
'llms_update_3160_ensure_no_dupe_question_rels',
'llms_update_3160_ensure_no_lesson_dupe_rels',
'llms_update_3160_update_question_data',
'llms_update_3160_update_attempt_question_data',
'llms_update_3160_update_quiz_to_lesson_rels',
'llms_update_3160_builder_notice',
'llms_update_3160_update_db_version',
),
),
'3.28.0' => array(
'type' => 'manual',
'updates' => array(
'llms_update_3280_clear_session_cleanup_cron',
'llms_update_3280_update_db_version',
),
),
'4.0.0' => array(
'type' => 'manual',
'updates' => array(
'llms_update_400_remove_session_options',
'llms_update_400_clear_session_cron',
'llms_update_400_update_db_version',
),
),
'4.5.0' => array(
'type' => 'manual',
'updates' => array(
'llms_update_450_migrate_events_open_sessions',
'llms_update_450_update_db_version',
),
),
'4.15.0' => array(
'type' => 'manual',
'updates' => array(
'llms_update_4150_remove_orphan_access_plans',
'llms_update_4150_update_db_version',
),
),
'5.0.0' => array(
'type' => 'auto',
'updates' => array(
'llms_update_500_legacy_options_autoload_off',
'llms_update_500_update_db_version',
'llms_update_500_add_admin_notice',
),
),
'5.2.0' => array(
'type' => 'auto',
'updates' => array(
'llms_update_520_upcoming_reminder_notification_backward_compat',
'llms_update_520_update_db_version',
),
),
'6.0.0' => array(
'type' => 'manual',
'namespace' => true,
'updates' => array(
'migrate_achievements',
'migrate_certificates',
'migrate_award_templates',
'show_notice',
'update_db_version',
),
),
'6.3.0' => array(
'type' => 'auto',
'namespace' => true,
'updates' => array(
'buddypress_profile_endpoints_bc',
'update_db_version',
),
),
'6.10.0' => array(
'type' => 'auto',
'namespace' => true,
'updates' => array(
'migrate_spanish_users',
'update_db_version',
),
),
'7.5.0' => array(
'type' => 'auto',
'namespace' => true,
'updates' => array(
'favorites_feature_bc',
'update_db_version',
),
),
'7.8.0' => array(
'type' => 'auto',
'namespace' => true,
'updates' => array(
'maybe_set_option_llms_access_plans_allow_skus',
'update_db_version',
),
),
'7.8.5' => array(
'type' => 'auto',
'namespace' => true,
'updates' => array(
'maybe_remove_pwc',
'update_db_version',
),
),
'9.0.0' => array(
'type' => 'auto',
'namespace' => true,
'updates' => array(
'show_notice',
'update_db_version',
),
),
'9.2.1' => array(
'type' => 'auto',
'namespace' => true,
'updates' => array(
'reset_course_calc_data_locks',
'update_db_version',
),
),
);
================================================
FILE: includes/schemas/llms-form-locations.php
================================================
<?php
/**
* Default LifterLMS Form location definitions
*
* This file returns a list of the default LifterLMS form locations required
* by LifterLMS for allowing users to create and manage accounts on the website.
*
* @package LifterLMS/Schemas
*
* @since 5.0.0
* @version 5.0.0
*
* @see LLMS_Forms::get_locations() The core method used to retrieve the form locations schema.
* @see llms_forms_get_locations Filter the form locations schema.
*/
defined( 'ABSPATH' ) || exit;
return array(
'checkout' => array(
'name' => __( 'Checkout', 'lifterlms' ),
'description' => __( 'Handles new user registration and existing user information updates during checkout and enrollment.', 'lifterlms' ),
'title' => __( 'Billing Information', 'lifterlms' ),
'template' => LLMS_Form_Templates::get_template( 'checkout' ),
'required' => array(
array(
'fieldName' => 'email_address',
'blockName' => 'llms/form-field-user-email',
),
array(
'fieldName' => 'password',
'blockName' => 'llms/form-field-user-password',
),
),
'meta' => array(
'_llms_form_location' => 'checkout',
'_llms_form_show_title' => 'yes',
'_llms_form_is_core' => 'yes',
),
),
'registration' => array(
'name' => __( 'Registration', 'lifterlms' ),
'description' => __( 'Handles new user registration and existing user information updates for open registration on the student dashboard and wherever the [lifterlms_registration] shortcode is used.', 'lifterlms' ),
'title' => __( 'Register', 'lifterlms' ),
'template' => LLMS_Form_Templates::get_template( 'registration' ),
'required' => array(
array(
'fieldName' => 'email_address',
'blockName' => 'llms/form-field-user-email',
),
array(
'fieldName' => 'password',
'blockName' => 'llms/form-field-user-password',
),
),
'meta' => array(
'_llms_form_location' => 'registration',
'_llms_form_show_title' => 'yes',
'_llms_form_is_core' => 'yes',
),
),
'account' => array(
'name' => __( 'Account', 'lifterlms' ),
'description' => __( 'Handles user account information updates on the edit account area of the student dashboard.', 'lifterlms' ),
'title' => __( 'Edit Account Information', 'lifterlms' ),
'template' => LLMS_Form_Templates::get_template( 'account' ),
'required' => array(
array(
'fieldName' => 'email_address',
'blockName' => 'llms/form-field-user-email',
),
array(
'fieldName' => 'password',
'blockName' => 'llms/form-field-user-password',
),
array(
'fieldName' => 'display_name',
'blockName' => 'llms/form-field-user-display-name',
),
),
'meta' => array(
'_llms_form_location' => 'account',
'_llms_form_show_title' => 'no',
'_llms_form_is_core' => 'yes',
),
),
);
================================================
FILE: includes/schemas/llms-reusable-blocks.php
================================================
<?php
/**
* Default form field blocks schema
*
* This file returns a list of the default LifterLMS form fields
* used to build an initial set of reusable blocks used across the
* core user information forms (checkout, registration, and account).
*
* Each field block is an incomplete form field definition. Each field
* is linked to a user information form field by its name attribute which
* will match an info field by its id attribute.
*
* User information fields are defined in `includes/schemas/llms-user-information-fields.php.
*
* @package LifterLMS/Schemas
*
* @since 5.0.0
* @version 5.3.1
*/
defined( 'ABSPATH' ) || exit;
return array(
'username' => array(
'title' => _x( 'Username (Reusable)', 'Default form field reusable block title', 'lifterlms' ),
'blockName' => 'llms/form-field-user-login',
'attrs' => array(
'required' => true,
'id' => 'user_login',
'llms_visibility' => 'logged_out',
),
),
'email' => array(
'title' => _x( 'Email Address (Reusable)', 'Default form field reusable block title', 'lifterlms' ),
'blockName' => 'llms/form-field-user-email',
'attrs' => array(
'required' => true,
'id' => 'email_address',
'llms_visibility' => 'logged_out',
),
'confirm' => 'email',
),
'password' => array(
'title' => _x( 'Password (Reusable)', 'Default form field reusable block title', 'lifterlms' ),
'blockName' => 'llms/form-field-user-password',
'attrs' => array(
'required' => true,
'id' => 'password',
'llms_visibility' => 'logged_out',
),
'confirm' => 'password',
),
'name' => array(
'title' => _x( 'First and Last Name (Reusable)', 'Default form field reusable block title', 'lifterlms' ),
'blockName' => 'llms/form-field-user-name',
'innerBlocks' => array(
array(
'blockName' => 'llms/form-field-user-first-name',
'attrs' => array(
'id' => 'first_name',
'required' => true,
'columns' => 6,
'last_column' => false,
),
),
array(
'blockName' => 'llms/form-field-user-last-name',
'attrs' => array(
'id' => 'last_name',
'required' => true,
'columns' => 6,
'last_column' => true,
),
),
),
),
'display_name' => array(
'title' => _x( 'Public Display Name (Reusable)', 'Default form field reusable block title', 'lifterlms' ),
'blockName' => 'llms/form-field-user-display-name',
'attrs' => array(
'required' => true,
'id' => 'display_name',
),
),
'address' => array(
'title' => _x( 'Address (Reusable)', 'Default form field reusable block title', 'lifterlms' ),
'blockName' => 'llms/form-field-user-address',
'innerBlocks' => array(
array(
'blockName' => 'llms/form-field-user-address-street',
'innerBlocks' => array(
array(
'blockName' => 'llms/form-field-user-address-street-primary',
'attrs' => array(
'id' => 'llms_billing_address_1',
'required' => true,
'columns' => 8,
'last_column' => false,
),
),
array(
'blockName' => 'llms/form-field-user-address-street-secondary',
'attrs' => array(
'id' => 'llms_billing_address_2',
'required' => false,
'columns' => 4,
'last_column' => true,
),
),
),
),
array(
'blockName' => 'llms/form-field-user-address-city',
'attrs' => array(
'id' => 'llms_billing_city',
'required' => true,
),
),
array(
'blockName' => 'llms/form-field-user-address-country',
'attrs' => array(
'id' => 'llms_billing_country',
'required' => true,
),
),
array(
'blockName' => 'llms/form-field-user-address-region',
'innerBlocks' => array(
array(
'blockName' => 'llms/form-field-user-address-state',
'attrs' => array(
'id' => 'llms_billing_state',
'required' => true,
'columns' => 6,
'last_column' => false,
),
),
array(
'blockName' => 'llms/form-field-user-address-postal-code',
'attrs' => array(
'id' => 'llms_billing_zip',
'required' => true,
'columns' => 6,
'last_column' => true,
),
),
),
),
),
),
'phone' => array(
'title' => _x( 'Phone Number (Reusable)', 'Default form field reusable block title', 'lifterlms' ),
'blockName' => 'llms/form-field-user-phone',
'attrs' => array(
'id' => 'llms_phone',
'required' => false,
),
),
);
================================================
FILE: includes/schemas/llms-user-information-fields.php
================================================
<?php
/**
* User information fields schema
*
* A list of user information fields used by LifterLMS in various places, namely to build
* the editable user information forms (Checkout, Registration, and Edit Account).
*
* Each item in this list should be an array compatible with the `LLMS_Form_Field` class'
* settings array.
*
* Fields can be added and modified using the `llms_user_information_fields` filter.
*
* @package LifterLMS/Schemas
*
* @since 5.0.0
* @version 5.0.0
*
* @see llms_get_user_information_fields() Retrieves the (filtered) schema.
* @see llms_get_user_information_field() Retrieve a single field from this schema by ID.
*/
defined( 'ABSPATH' ) || exit;
return array(
// WordPress Core.
array(
'id' => 'user_login',
'name' => 'user_login',
'type' => 'text',
'label' => __( 'Username', 'lifterlms' ),
'data_store' => 'users',
'data_store_key' => 'user_login',
),
array(
'id' => 'email_address',
'name' => 'email_address',
'type' => 'email',
'label' => __( 'Email Address', 'lifterlms' ),
'data_store' => 'users',
'data_store_key' => 'user_email',
),
array(
'id' => 'password',
'name' => 'password',
'type' => 'password',
'label' => __( 'Password', 'lifterlms' ),
'data_store' => 'users',
'data_store_key' => 'user_pass',
'meter' => llms_parse_bool( get_option( 'lifterlms_registration_password_strength', 'yes' ) ),
'min_strength' => get_option( 'lifterlms_registration_password_min_strength', 'weak' ),
'html_attrs' => array(
'minlength' => 8,
),
'meter_description' => sprintf(
// Translators: %s = Minimum password strength.
__(
'A %s password is required with at least 8 characters. To make it stronger, use both upper and lower case letters, numbers, and symbols.',
'lifterlms'
),
llms_get_minimum_password_strength_name( get_option( 'lifterlms_registration_password_min_strength', 'weak' ) )
),
),
array(
'id' => 'first_name',
'name' => 'first_name',
'type' => 'text',
'label' => __( 'First Name', 'lifterlms' ),
'data_store' => 'usermeta',
'data_store_key' => 'first_name',
),
array(
'id' => 'last_name',
'name' => 'last_name',
'type' => 'text',
'label' => __( 'Last Name', 'lifterlms' ),
'data_store' => 'usermeta',
'data_store_key' => 'last_name',
),
array(
'id' => 'display_name',
'name' => 'display_name',
'type' => 'text',
'label' => __( 'Display Name', 'lifterlms' ),
'data_store' => 'users',
'data_store_key' => 'display_name',
),
// LifterLMS core.
array(
'id' => 'llms_billing_address_1',
'name' => 'llms_billing_address_1',
'type' => 'text',
'label' => __( 'Address', 'lifterlms' ),
'data_store' => 'usermeta',
'data_store_key' => 'llms_billing_address_1',
),
array(
'id' => 'llms_billing_address_2',
'name' => 'llms_billing_address_2',
'type' => 'text',
'label' => '',
'label_show_empty' => true,
'data_store' => 'usermeta',
'data_store_key' => 'llms_billing_address_2',
'placeholder' => __( 'Apartment, suite, etc...', 'lifterlms' ),
),
array(
'id' => 'llms_billing_city',
'name' => 'llms_billing_city',
'type' => 'text',
'label' => __( 'City', 'lifterlms' ),
'data_store' => 'usermeta',
'data_store_key' => 'llms_billing_city',
),
array(
'id' => 'llms_billing_country',
'name' => 'llms_billing_country',
'type' => 'select',
'label' => __( 'Country', 'lifterlms' ),
'data_store' => 'usermeta',
'data_store_key' => 'llms_billing_country',
'options_preset' => 'countries',
'placeholder' => __( 'Select a Country', 'lifterlms' ),
'classes' => 'llms-select2',
),
array(
'id' => 'llms_billing_state',
'name' => 'llms_billing_state',
'type' => 'select',
'label' => __( 'State / Region', 'lifterlms' ),
'data_store' => 'usermeta',
'data_store_key' => 'llms_billing_state',
'options_preset' => 'states',
'placeholder' => __( 'Select a State / Region', 'lifterlms' ),
'classes' => 'llms-select2',
),
array(
'id' => 'llms_billing_zip',
'name' => 'llms_billing_zip',
'type' => 'text',
'label' => __( 'Postal / Zip Code', 'lifterlms' ),
'data_store' => 'usermeta',
'data_store_key' => 'llms_billing_zip',
),
array(
'id' => 'llms_phone',
'name' => 'llms_phone',
'type' => 'tel',
'label' => __( 'Phone Number', 'lifterlms' ),
'data_store' => 'usermeta',
'data_store_key' => 'llms_phone',
),
);
================================================
FILE: includes/shortcodes/class-llms-shortcode-user-info.php
================================================
<?php
/**
* LLMS_Shortcode_User_Info class.
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS User Information Shortcode.
*
* Shortcode: [llms-user]
*
* @since 5.0.0
*/
class LLMS_Shortcode_User_Info extends LLMS_Shortcode {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'llms-user';
/**
* Retrieves a list of keys that cannot be displayed by the shortcode.
*
* @since 5.0.0
*
* @return string[]
*/
protected function get_blocklist() {
/**
* Filters the list of keys which cannot be displayed using the [user] shortcode
*
* @since 5.0.0
*
* @param string[] $keys List of user and usermeta keys.
*/
return apply_filters( 'llms_user_info_shortcode_blocked_keys', array( 'user_pass' ) );
}
/**
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output()
*
* @since 5.0.0
*
* @return array
*/
protected function get_default_attributes() {
return array(
'key' => '',
'or' => '',
);
}
/**
* Retrieve the actual content of the shortcode
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter
*
* @since 5.0.0
*
* @return string
*/
protected function get_output() {
/**
* Filters the user used to retrieve user information displayed by the [llms-user] shortcode
*
* @since 5.0.0
*
* @param integer $user_id The WP_User ID of the currently logged-in user or `0` if no user logged in.
*/
$user_id = apply_filters( 'llms_user_info_shortcode_user_id', get_current_user_id() );
$key = $this->get_attribute( 'key' );
$default = $this->get_attribute( 'or' );
if ( in_array( $key, $this->get_blocklist(), true ) ) {
return '';
}
// No user OR no key provided.
if ( ! $user_id || ! $key ) {
return $default;
}
$user = new WP_User( $user_id );
$val = $user->exists() ? $user->get( $key ) : null;
return ! empty( $val ) && is_scalar( $val ) ? $val : $default;
}
/**
* Merge user attributes with default attributes.
*
* @since 5.0.0
*
* @param array $atts User-submitted shortcode attributes.
*
* @return array
*/
protected function set_attributes( $atts = array() ) {
// Allow `key` attribute to be submitted without a key, eg: [llms-user first_name].
if ( isset( $atts[0] ) ) {
$atts['key'] = $atts[0];
unset( $atts[0] );
}
return parent::set_attributes( $atts );
}
}
return LLMS_Shortcode_User_Info::instance();
================================================
FILE: includes/shortcodes/class.llms.bbp.shortcode.course.forums.list.php
================================================
<?php
/**
* LifterLMS Course Meta Information Shortcode
*
* [lifterlms_bbp_course_forums]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.12.0
* @version 3.12.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_BBP_Shortcode_Course_Forums_List
*
* @since 3.12.0
* @since 3.12.1 Unknown.
*/
class LLMS_BBP_Shortcode_Course_Forums_List extends LLMS_Shortcode_Course_Element {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_bbp_course_forums';
/**
* Retrieve the forum ids associated with the course
*
* @since 3.12.0
* @since 3.12.1 Unknown.
*
* @return array
*/
private function get_forums() {
global $post;
$course = llms_get_post( $post );
if ( $course ) {
return $course->get( 'bbp_forum_ids' );
}
return array();
}
/**
* Call the template function for the course element
*
* @since 3.12.0
*
* @return void
*/
protected function template_function() {
$forums = $this->get_forums();
if ( $forums ) {
echo '<div class="llms-bbp-course-forums-wrap">';
echo '<ul class="llms-bbp-course-forums-list">';
foreach ( $forums as $forum_id ) : ?>
<li><a class="llms-bbp-forum-title" href="<?php bbp_forum_permalink( $forum_id ); ?>">
<?php bbp_forum_title( $forum_id ); ?>
</a></li>
<?php
endforeach;
echo '</ul>';
echo '</div>';
}
}
}
return LLMS_BBP_Shortcode_Course_Forums_List::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.checkout.php
================================================
<?php
/**
* LifterLMS Checkout Page Shortcode
*
* Controls functionality associated with shortcode [llms_checkout].
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 1.0.0
* @version 7.0.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Checkout class.
*
* @since 1.0.0
* @since 3.30.1 Added check via llms_locate_order_for_user_and_plan() to automatically resume an existing pending order for logged in users if one exists.
* @since 3.33.0 Checkout form not displayed to users already enrolled in the product being purchased, a notice informing them of that is displayed instead.
* @since 3.35.0 Sanitize input data.
* @since 3.36.3 Added l10n function to membership restriction error message.
* @since 4.2.0 Added filter to control the displaying of the notice informing the students they're already enrolled in the product being purchased.
* @since 5.0.0 Add support for LLMS_Form field management.
*/
class LLMS_Shortcode_Checkout {
/**
* Current User ID.
*
* @var int
*/
public static $uid;
/**
* Renders the checkout template.
*
* @since 1.0.0
* @since 3.33.0 Do not display the checkout form but a notice to a logged in user enrolled in the product being purchased.
* @since 3.36.3 Added l10n function to membership restriction error message.
* @since 4.2.0 Added filter to control the displaying of the notice informing the students they're already enrolled in the product being purchased.
*
* @param array $atts Shortcode attributes array.
* @return void
*/
private static function checkout( $atts ) {
// if there are membership restrictions, check the user is in at least one membership.
// this is to combat CHEATERS.
if ( $atts['plan']->has_availability_restrictions() ) {
$access = false;
foreach ( $atts['plan']->get_array( 'availability_restrictions' ) as $mid ) {
// once we find a membership, exit.
if ( llms_is_user_enrolled( self::$uid, $mid ) ) {
$access = true;
break;
}
}
if ( ! $access ) {
llms_print_notice( __( 'You must be a member in order to purchase this access plan.', 'lifterlms' ), 'error' );
return;
}
}
if ( self::$uid ) {
// ensure the user isn't enrolled in the product being purchased.
if ( isset( $atts['product'] ) && llms_is_user_enrolled( self::$uid, $atts['product']->get( 'id' ) ) ) {
/**
* Filter the displaying of the checkout form notice for already enrolled in the product being purchased.
*
* @param bool $display_notice Whether or not displaying the checkout form notice for already enrolled students in the product being purchased.
* @param LLMS_Access_Plan $plan The access plan.
*
* @since 4.2.0
*/
if ( apply_filters( 'llms_display_checkout_form_enrolled_students_notice', true, $atts['plan'] ) ) {
llms_print_notice(
sprintf(
// Translators: %2$s = The product type (course/membership); %1$s = product permalink.
__( 'You already have access to this %2$s! Visit your dashboard <a href="%1$s">here.</a>', 'lifterlms' ),
llms_get_page_url( 'myaccount' ),
$atts['product']->get_post_type_label()
),
'notice'
);
}
/**
* Filter to block checkout when the student is enrolled. Defaults to true.
*
* @param bool $block_checkout Whether or not blocking the checkout form for already enrolled students in the product being purchased.
* @param LLMS_Access_Plan $plan The access plan.
*
* @since 9.1.2
*/
if ( apply_filters( 'llms_checkout_block_enrolled_checkout', true, $atts['plan'] ) ) {
return;
}
}
$user = get_userdata( self::$uid );
llms_print_notice( sprintf( __( 'You are currently logged in as <em>%1$s</em>. <a href="%2$s">Click here to logout</a>', 'lifterlms' ), $user->user_email, wp_logout_url( $atts['plan']->get_checkout_url() ) ), 'notice' );
} else {
llms_get_login_form( sprintf( __( 'Already have an account? <a href="%s">Click here to login</a>', 'lifterlms' ), '#llms-show-login' ), $atts['plan']->get_checkout_url() );
}
if ( isset( $atts['product'] ) && 'course' === $atts['product']->get( 'type' ) && ( $course = new LLMS_Course( $atts['product']->post ) ) && ! $course->has_capacity() ) {
/**
* Filter the displaying of the checkout form notice for already enrolled in the product being purchased.
*
* @param bool $display_notice Whether or not displaying the checkout form notice for already enrolled students in the product being purchased.
* @param LLMS_Access_Plan $plan The access plan.
*
* @since 4.2.0
*/
if ( apply_filters( 'llms_display_checkout_form_course_capacity_notice', true, $atts['plan'] ) ) {
llms_print_notice(
$course->get( 'capacity_message' ),
'error'
);
}
/**
* Filter to block checkout when the course capacity has been reached. Defaults to true.
*
* @param bool $block_checkout Whether or not blocking the checkout form when a course is at capacity.
* @param LLMS_Access_Plan $plan The access plan.
*
* @since 10.0.0
*/
if ( apply_filters( 'llms_checkout_block_course_capacity_checkout', true, $atts['plan'] ) ) {
return;
}
}
llms_get_template( 'checkout/form-checkout.php', $atts );
}
/**
* Renders the confirm payment checkout template.
*
* @since 1.0.0
* @version 3.0.0
*
* @param array $atts shortcode attributes.
* @return void
*/
private static function confirm_payment( $atts ) {
llms_get_template( 'checkout/form-confirm-payment.php', $atts );
}
/**
* Output error messages when they're encountered.
*
* @since 3.0.0
*
* @param string $message The error message.
* @return void
*/
private static function error( $message ) {
/**
* Filters error messages displayed on the checkout screen.
*
* @since 3.0.0
*
* @param string $message The error message.
*/
echo wp_kses_post( apply_filters( 'llms_checkout_error_output', $message ) );
}
/**
* Retrieve the shortcode content.
*
* @since 1.0.0
*
* @param array $atts Shortcode attributes.
* @return string
*/
public static function get( $atts ) {
return LLMS_Shortcodes::shortcode_wrapper( array( __CLASS__, 'output' ), $atts );
}
/**
* Gather a bunch of information and output the actual content for the shortcode.
*
* @since 1.0.0
* @since 3.30.1 Added check via llms_locate_order_for_user_and_plan() to automatically resume an existing pending order for logged in users if one exists.
* @since 3.35.0 Sanitize input data.
* @since 5.0.0 Organize attribute configuration and add new dynamic attributes related to the LLMS_Form post.
* @since 5.9.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
* @since 7.0.0 Fixed unclosed `div.llms-checkout-wrapper` on empty cart.
* @since 7.0.1 Fixed issue encountered when trying to confirm payment for a non-existent order.
*
* @param array $atts Shortcode atts from originating shortcode.
* @return void
*/
public static function output( $atts ) {
global $wp;
$atts = $atts ? $atts : array();
$atts['cols'] = isset( $atts['cols'] ) ? $atts['cols'] : 2;
self::$uid = get_current_user_id();
$atts['gateways'] = llms()->payment_gateways()->get_enabled_payment_gateways();
$atts['selected_gateway'] = llms()->payment_gateways()->get_default_gateway();
$atts['order_key'] = '';
$atts['field_data'] = array();
if ( isset( $_POST ) && isset( $_POST['action'] ) && 'create_pending_order' === $_POST['action'] ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
$atts['field_data'] = wp_unslash( $_POST ); // phpcs:ignore WordPress.Security.NonceVerification.Missing
} elseif ( self::$uid ) {
$atts['field_data'] = get_current_user_id();
}
self::checkout_wrapper_start();
/**
* Allows gateways or third parties to output custom errors before
* any core logic is executed.
*
* This filter returns `false` by default. To output custom errors return
* the error message as a string that will be displayed on screen.
*
* @since Unknown
*
* @param bool|string $pre_error A custom error message.
*/
$err = apply_filters( 'lifterlms_pre_checkout_error', false );
if ( $err ) {
self::error( $err );
self::checkout_wrapper_end();
return;
}
llms_print_notices();
// purchase step 1.
if ( isset( $_GET['plan'] ) && is_numeric( $_GET['plan'] ) ) {
$plan_id = llms_filter_input( INPUT_GET, 'plan', FILTER_SANITIZE_NUMBER_INT );
// Only retrieve if plan is a llms_access_plan and is published.
if ( 0 === strcmp( get_post_status( $plan_id ), 'publish' ) && 0 === strcmp( get_post_type( $plan_id ), 'llms_access_plan' ) ) {
$coupon = llms()->session->get( 'llms_coupon' );
if ( isset( $coupon['coupon_id'] ) && isset( $coupon['plan_id'] ) ) {
if ( $coupon['plan_id'] == $_GET['plan'] ) {
$atts['coupon'] = new LLMS_Coupon( $coupon['coupon_id'] );
} else {
llms()->session->set( 'llms_coupon', false );
$atts['coupon'] = false;
}
} else {
$atts['coupon'] = false;
}
// Use posted order key to resume a pending order.
if ( isset( $_POST['llms_order_key'] ) ) { // phpcs:ignore WordPress.Security.NonceVerification.Missing
$atts['order_key'] = llms_filter_input_sanitize_string( INPUT_POST, 'llms_order_key' );
// Attempt to locate a pending order.
} elseif ( self::$uid ) {
$pending_order = llms_locate_order_for_user_and_plan( self::$uid, $plan_id );
if ( $pending_order ) {
$order = llms_get_post( $pending_order );
$atts['order_key'] = ( 'llms-pending' === $order->get( 'status' ) ) ? $order->get( 'order_key' ) : '';
}
}
$atts = self::setup_plan_and_form_atts( $plan_id, $atts );
/**
* Filter the number of columns used to render the checkout/enrollment form.
*
* @since Unknown.
* @since 5.0.0 Added `$form_location` parameter.
*
* @param int $cols Number of columns. Accepts 1 or 2.
* @param LLMS_Access_Plan $plan Access plan object.
* @param string $form_location Form location ID.
*/
$atts['cols'] = apply_filters( 'llms_checkout_columns', ( $atts['is_free'] || ! $atts['form_fields'] ) ? 1 : $atts['cols'], $atts['plan'], $atts['form_location'] );
self::checkout( $atts );
} else {
self::error( __( 'Invalid access plan.', 'lifterlms' ) );
}
} elseif ( isset( $wp->query_vars['confirm-payment'] ) ) {
$order_key = llms_filter_input_sanitize_string( INPUT_GET, 'order' );
$order = $order_key ? llms_get_order_by_key( $order_key ) : false;
if ( ! $order ) {
self::error( __( 'Could not locate an order to confirm.', 'lifterlms' ) );
self::checkout_wrapper_end();
return;
}
$atts = self::setup_plan_and_form_atts( $order->get( 'plan_id' ), $atts );
if ( $order->get( 'coupon_id' ) ) {
$atts['coupon'] = new LLMS_Coupon( $order->get( 'coupon_id' ) );
} else {
$atts['coupon'] = false;
}
$atts['selected_gateway'] = llms()->payment_gateways()->get_gateway_by_id( $order->get( 'payment_gateway' ) );
self::confirm_payment( $atts );
} else {
self::error( sprintf( __( 'Your cart is currently empty. Click <a href="%s">here</a> to get started.', 'lifterlms' ), llms_get_page_url( 'courses' ) ) );
}
self::checkout_wrapper_end();
}
/**
* Setup attributes for plan and form information.
*
* @since 5.0.0
* @since 5.1.0 Properly detect empty form fields when the html is only composed of blanks and empty paragraphs.
* @since 7.0.0 Add 'redirect' hidden field to be used on purchase completion.
*
* @param int $plan_id LLMS_Access_Plan post id.
* @param array $atts Existing attributes.
* @return array Modified attributes array.
*/
protected static function setup_plan_and_form_atts( $plan_id, $atts ) {
$plan = new LLMS_Access_Plan( $plan_id );
$atts['plan'] = $plan;
$atts['product'] = $plan->get_product();
$atts['is_free'] = $plan->has_free_checkout();
$atts['form_location'] = 'checkout';
$atts['form_title'] = llms_get_form_title( $atts['form_location'], array( 'plan' => $plan ) );
$atts['form_fields'] = self::clean_form_fields( llms_get_form_html( $atts['form_location'], array( 'plan' => $plan ) ) );
// Add 'redirect' URL hidden field to be used on purchase completion.
$plan_redirection_url = $plan->get_redirection_url( false );
if ( $plan_redirection_url ) {
$atts['form_fields'] .= ( new LLMS_Form_Field(
array(
'id' => 'llms-redirect',
'name' => 'redirect',
'type' => 'hidden',
'value' => $plan_redirection_url,
'data_store_key' => false,
)
) )->get_html();
}
return $atts;
}
/**
* Clean form fields html
*
* Properly detects empty form fields when the html is only composed of blanks and empty paragraphs.
* In this case the form fields html is turned into an empty string.
*
* @since 5.1.0
*
* @param array $fields_html Form Fields.
* @return array
*/
private static function clean_form_fields( $fields_html ) {
// If fields html has only blanks and emoty paragraphs (autop?), clean it.
if ( empty( preg_replace( '/(\s)*(<p><\/p>)*/m', '', $fields_html ) ) ) {
$fields_html = '';
}
return $fields_html;
}
/**
* Output the checkout wrapper opening tags.
*
* @since 7.0.0
*
* @return void
*/
private static function checkout_wrapper_start() {
echo '<div class="llms-checkout-wrapper">';
}
/**
* Output the checkout wrapper closing tags.
*
* @since 7.0.0
*
* @return void
*/
private static function checkout_wrapper_end() {
echo '</div><!-- .llms-checkout-wrapper -->';
}
}
================================================
FILE: includes/shortcodes/class.llms.shortcode.course.author.php
================================================
<?php
/**
* LifterLMS Course Meta Information Shortcode
*
* [lifterlms_course_author]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.6.0
* @version 3.11.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Course_Author
*
* @since 3.6.0
* @since 3.11.1 Unknown.
*/
class LLMS_Shortcode_Course_Author extends LLMS_Shortcode_Course_Element {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_course_author';
/**
* Get default shortcode attributes.
*
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output()
*
* @since 3.6.0
*
* @return array
*/
protected function get_default_attributes() {
return array(
'avatar_size' => 48,
'bio' => 'yes',
'course_id' => get_the_ID(),
);
}
/**
* Retrieve the author ID of the course
*
* Lessons and Quizzes cascade up
*
* @since 3.11.1
*
* @return int|null
*/
private function get_author_id() {
$post = llms_get_post( $this->get_attribute( 'course_id' ) );
if ( ! $post ) {
return null;
}
if ( in_array( $post, array( 'lesson', 'quiz' ) ) ) {
$course = llms_get_post_parent_course( $post->get( 'id' ) );
if ( ! $course ) {
return null;
}
}
return $post->get( 'author' );
}
/**
* Call the template function for the course element
*
* @since 3.6.0
* @since 3.11.1
*
* @return void
*/
protected function template_function() {
echo '<div class="llms-meta-info">';
// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Escaped in function.
echo llms_get_author(
array(
'avatar_size' => $this->get_attribute( 'avatar_size' ),
'bio' => ( 'yes' === $this->get_attribute( 'bio' ) ) ? true : false,
'user_id' => $this->get_author_id(),
)
);
echo '</div><!-- .llms-meta-info -->';
}
}
return LLMS_Shortcode_Course_Author::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.course.continue.button.php
================================================
<?php
/**
* LifterLMS Course Continue Button
*
* [lifterlms_course_continue_button]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.11.1
* @version 3.11.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Course_Element
*
* @since 3.11.1
*/
class LLMS_Shortcode_Course_Continue_Button extends LLMS_Shortcode_Course_Element {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_course_continue_button';
/**
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output()
*
* @since 3.11.1
*
* @return array
*/
protected function get_default_attributes() {
return array(
'course_id' => get_the_ID(),
);
}
/**
* Call the template function for the course element
*
* @since 3.11.1
*
* @return void
*/
protected function template_function() {
lifterlms_course_continue_button( $this->get_attribute( 'course_id' ) );
}
}
return LLMS_Shortcode_Course_Continue_Button::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.course.continue.php
================================================
<?php
/**
* LifterLMS Course Progress & Continue Button Shortcode
*
* [lifterlms_course_continue]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.6.0
* @version 3.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Course_Continue
*
* @since 3.6.0
*/
class LLMS_Shortcode_Course_Continue extends LLMS_Shortcode_Course_Element {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_course_continue';
/**
* Call the template function for the course element
*
* @since 3.6.0
*
* @return void
*/
protected function template_function() {
lifterlms_template_single_course_progress();
}
}
return LLMS_Shortcode_Course_Continue::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.course.instructors.php
================================================
<?php
/**
* LifterLMS Course Instructors
*
* [lifterlms_course_instructors]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 7.7.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Course_Instructors
*
* @since 7.7.0
*/
class LLMS_Shortcode_Course_Instructors extends LLMS_Shortcode_Course_Element {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_course_instructors';
/**
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output()
*
* @since 7.7.0
*
* @return array
*/
protected function get_default_attributes() {
return array();
}
/**
* Call the template function for the course element
*
* @since 7.7.0
*
* @return void
*/
protected function template_function() {
llms_template_instructors();
}
}
return LLMS_Shortcode_Course_Instructors::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.course.meta.info.php
================================================
<?php
/**
* LifterLMS Course Meta Information Shortcode
*
* [lifterlms_course_meta_info]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.6.0
* @version 3.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Course_Meta_Info
*
* @since 3.6.0
*/
class LLMS_Shortcode_Course_Meta_Info extends LLMS_Shortcode_Course_Element {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_course_meta_info';
/**
* Call the template function for the course element
*
* @since 3.6.0
*
* @return void
*/
protected function template_function() {
echo '<div class="llms-meta-info">';
lifterlms_template_single_length();
lifterlms_template_single_difficulty();
lifterlms_template_single_course_tracks();
lifterlms_template_single_course_categories();
lifterlms_template_single_course_tags();
echo '</div><!-- .llms-meta-info -->';
}
}
return LLMS_Shortcode_Course_Meta_Info::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.course.outline.php
================================================
<?php
/**
* LifterLMS Course Outline Shortcode
*
* [lifterlms_course_outline]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.5.1
* @version 3.19.2
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Course_Outline
*
* @since 3.5.1
* @since 3.19.2 Unknown.
*/
class LLMS_Shortcode_Course_Outline extends LLMS_Shortcode {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_course_outline';
/**
* Retrieve the default course id depending on the current post
*
* @return int|null
* @since 3.5.1
* @version 3.17.7
*/
private function get_course_id() {
global $post;
$post_id = isset( $post->ID ) ? $post->ID : null;
$course_id = null;
if ( $post_id ) {
if ( 'course' !== $post->post_type ) {
// get the parent
$parent = llms_get_post_parent_course( $post );
if ( $parent ) {
$course_id = $parent->get( 'id' );
}
} else {
$course_id = $post_id;
}
}
return $course_id;
}
/**
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output()
*
* @return array
* @since 3.5.1
* @version 3.5.1
*/
protected function get_default_attributes() {
return array(
'collapse' => 0, // outputs a collapsible syllabus when true
'course_id' => $this->get_course_id(),
'outline_type' => 'full', // full, current_section
'toggles' => 0, // outputs open/close all toggles when true
);
}
/**
* Retrieve the actual content of the shortcode
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter
*
* @return string
* @since 3.5.1
* @version 3.19.2
*/
protected function get_output() {
$course = new LLMS_Course( $this->get_attribute( 'course_id' ) );
$student = llms_get_student();
$args = array(
'collapse' => $this->get_attribute( 'collapse' ),
'course' => $course,
'current_section' => null,
'current_lesson' => null,
'sections' => array(),
'student' => $student,
'toggles' => $this->get_attribute( 'toggles' ),
);
if ( ! $course ) {
return '';
}
$next_lesson = $student ? llms_get_post( $student->get_next_lesson( $course->get( 'id' ) ) ) : false;
if ( 'lesson' === get_post_type() ) {
$args['current_lesson'] = get_the_ID();
}
// show only the current section
if ( $next_lesson && 'current_section' === $this->get_attribute( 'outline_type' ) ) {
$section = llms_get_post( $next_lesson->get( 'parent_section' ) );
$args['sections'][] = $section;
$args['current_section'] = $section->get( 'id' );
} else {
if ( 'lesson' === get_post_type() ) {
$lesson = llms_get_post( get_the_ID() );
} else {
$lesson = $next_lesson;
}
$args['sections'] = $course->get_sections();
$args['current_section'] = ! empty( $lesson ) && is_a( $lesson, 'LLMS_Post_Model' ) ? $lesson->get( 'parent_section' ) : false;
}
ob_start();
llms_get_template( 'course/outline-list-small.php', $args );
return ob_get_clean();
}
}
return LLMS_Shortcode_Course_Outline::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.course.prerequisites.php
================================================
<?php
/**
* LifterLMS Course Prerequisites notice Shortcode
*
* [lifterlms_course_prerequisites]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.6.0
* @version 3.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Course_Prerequisites
*
* @since 3.6.0
*/
class LLMS_Shortcode_Course_Prerequisites extends LLMS_Shortcode_Course_Element {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_course_prerequisites';
/**
* Call the template function for the course element
*
* @since 3.6.0
*
* @return void
*/
protected function template_function() {
lifterlms_template_single_prerequisites();
}
}
return LLMS_Shortcode_Course_Prerequisites::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.course.reviews.php
================================================
<?php
/**
* LifterLMS Course Reviews notice Shortcode
*
* [lifterlms_course_reviews]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.6.0
* @version 3.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Course_Reviews
*
* @since 3.6.0
*/
class LLMS_Shortcode_Course_Reviews extends LLMS_Shortcode_Course_Element {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_course_reviews';
/**
* Call the template function for the course element
*
* @return void
* @since 3.6.0
* @version 3.6.0
*/
protected function template_function() {
lifterlms_template_single_reviews();
}
}
return LLMS_Shortcode_Course_Reviews::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.course.syllabus.php
================================================
<?php
/**
* LifterLMS Course Syllabus Shortcode
*
* [lifterlms_course_syllabus]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.6.0
* @version 3.6.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Course_Syllabus
*
* @since 3.6.0
*/
class LLMS_Shortcode_Course_Syllabus extends LLMS_Shortcode_Course_Element {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_course_syllabus';
/**
* Call the template function for the course element
*
* @since 3.6.0
*
* @return void
*/
protected function template_function() {
// TODO: Don't render if an elementor page?
lifterlms_template_single_syllabus();
}
}
return LLMS_Shortcode_Course_Syllabus::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.courses.php
================================================
<?php
/**
* LifterLMS Courses Shortcode
*
* [lifterlms_courses]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.14.0
* @version 4.12.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Courses Shortcode class.
*
* @since 3.14.0
* @since 3.30.2 Output a message instead of the entire course catalog when "mine" is used and and current student is not enrolled in any courses.
* @since 3.31.0 Adjusted several private methods to be protected.
* @since 3.37.17 Use strict comparisons for `in_array()`.
*/
class LLMS_Shortcode_Courses extends LLMS_Shortcode {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_courses';
/**
* Get shortcode attributes
*
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output().
*
* @since 3.14.0
*
* @return array
*/
protected function get_default_attributes() {
return array(
'category' => '',
'hidden' => 'yes',
'id' => '', // Allow comma-separated list of course ids.
'mine' => 'no',
'post_status' => 'publish',
'posts_per_page' => -1,
'order' => 'ASC',
'orderby' => 'title',
);
}
/**
* Retrieve an array of post ids based on submitted ID parameter and the mine parameter
*
* @since 3.14.0
* @since 3.31.0 Changed access from private to protected.
* @since 3.37.17 Use strict comparisons for `in_array()`.
*
* @return array
*/
protected function get_post__in() {
$ids = array();
$post_id = $this->get_attribute( 'id' );
if ( $post_id ) {
$ids = explode( ',', $post_id ); // Allow multiple ids to be passed.
$ids = array_map( 'trim', $ids );
}
$student = llms_get_student();
$mine = $this->get_attribute( 'mine' );
if ( in_array( $mine, array( 'any', 'cancelled', 'enrolled', 'expired' ), true ) ) {
$courses = $student->get_courses(
array(
'limit' => 1000,
'status' => $this->get_attribute( 'mine' ),
)
);
$ids = $ids ? array_intersect( $ids, $courses['results'] ) : $courses['results'];
}
/**
* Filter the array of IDs returned for use in querying courses to display.
*
* @since 4.16.0
*
* @param array $ids The IDs of courses that will be displayed.
* @param LLMS_Student $student The student object for the current user.
* @param string $mine The "mine" attribute of the shortcode.
*/
return apply_filters( 'llms_courses_shortcode_get_post__in', $ids, $student, $mine );
}
/**
* Retrieve the tax query based on submitted category & visibility
*
* @since 3.14.0
* @since 3.31.0 Changed access from private to protected.
*
* @return array|string
*/
protected function get_tax_query() {
$has_tax_query = false;
$tax_query = array(
'relation' => 'AND',
);
$category = $this->get_attribute( 'category' );
if ( $category ) {
$tax_query[] = array(
'taxonomy' => 'course_cat',
'field' => 'slug',
'terms' => $category,
);
$has_tax_query = true;
}
$hidden = $this->get_attribute( 'hidden' );
if ( 'no' === $hidden || false === $hidden || '' === $hidden ) {
$terms = wp_list_pluck(
get_terms(
array(
'taxonomy' => 'llms_product_visibility',
'hide_empty' => false,
)
),
'term_taxonomy_id',
'name'
);
$tax_query[] = array(
'field' => 'term_taxonomy_id',
'operator' => 'NOT IN',
'taxonomy' => 'llms_product_visibility',
'terms' => array( $terms['hidden'] ),
);
$has_tax_query = true;
}
return $has_tax_query ? $tax_query : '';
}
/**
* Retrieve a WP_Query based on all submitted parameters
*
* @since 3.14.0
* @since 3.31.0 Changed access from private to protected.
* @since 4.12.0 Handle pagination when the shortcode is used on the static front page.
*
* @return WP_Query
*/
protected function get_wp_query() {
$args = array(
'paged' => is_front_page() ? get_query_var( 'page' ) : get_query_var( 'paged' ),
'post__in' => $this->get_post__in(),
'post_type' => 'course',
'post_status' => $this->get_attribute( 'post_status' ),
'tax_query' => $this->get_tax_query(), // phpcs:ignore WordPress.DB.SlowDBQuery.slow_db_query_tax_query
'posts_per_page' => $this->get_attribute( 'posts_per_page' ),
'order' => $this->get_attribute( 'order' ),
'orderby' => $this->get_attribute( 'orderby' ),
);
return new WP_Query( $args );
}
/**
* Retrieve the actual content of the shortcode
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter.
*
* @since 3.14.0
* @since 3.30.2 Output a message instead of the entire course catalog when "mine" is used and and current student is not enrolled in any courses.
*
* @return string
*/
protected function get_output() {
$this->enqueue_script( 'llms-jquery-matchheight' );
ob_start();
// If we're outputting a "My Courses" list and we don't have a student output login info.
if ( 'no' !== $this->get_attribute( 'mine' ) && ! llms_get_student() ) {
printf(
esc_html__( 'You must be logged in to view this information. Click %1$shere%2$s to login.', 'lifterlms' ),
'<a href="' . esc_url( llms_get_page_url( 'myaccount' ) ) . '">',
'</a>'
);
} elseif ( 'no' !== $this->get_attribute( 'mine' ) && ! $this->get_post__in() ) {
printf( '<p>%s</p>', esc_html__( 'No courses found.', 'lifterlms' ) );
} else {
lifterlms_loop( $this->get_wp_query() );
}
return ob_get_clean();
}
}
return LLMS_Shortcode_Courses::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.favorites.php
================================================
<?php
/**
* LifterLMS Favorites Shortcode.
*
* [lifterlms_favorites]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 7.5.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Favorites Shortcode class.
*
* @since version
*/
class LLMS_Shortcode_Favorites extends LLMS_Shortcode {
/**
* Shortcode tag.
*
* @var string
*/
public $tag = 'lifterlms_favorites';
/**
* Get shortcode attributes.
*
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output().
*
* @since 7.5.0
*
* @return array
*/
protected function get_default_attributes() {
return array(
'orderby' => 'updated_date',
'order' => 'ASC',
'limit' => '',
);
}
/**
* Retrieve an array of Favorites from `lifterlms_user_postmeta`.
*
* @since 7.5.0
*
* @return WP_Query
*/
protected function get_favorites() {
$student = llms_get_student();
$order_by = $this->get_attribute( 'orderby' );
$order = $this->get_attribute( 'order' );
$limit = $this->get_attribute( 'limit' );
return $student->get_favorites( $order_by, $order, $limit );
}
/**
* Retrieve the actual content of the shortcode.
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter.
*
* @since 7.5.0
*
* @return string
*/
protected function get_output() {
ob_start();
// If we're outputting a "My Favorites" list and we don't have a student output login info.
if ( ! llms_get_student() ) {
printf(
// Translators: 1%$s = Opening anchor tag; %2$s = Closing anchor tag.
esc_html__( 'You must be logged in to view this information. Click %1$shere%2$s to login.', 'lifterlms' ),
'<a href="' . esc_url( llms_get_page_url( 'myaccount' ) ) . '">',
'</a>'
);
} else {
$favorites = $this->get_favorites();
llms_template_my_favorites_loop( get_current_user_id(), $favorites );
}
return ob_get_clean();
}
}
return LLMS_Shortcode_Favorites::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.hide.content.php
================================================
<?php
/**
* LifterLMS Hide Content Shortcode
*
* [lifterlms_hide_content]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.5.1
* @version 3.24.1
*
* @example
* [hide_content id="1"] allows user with access to 1 to access content
* [hide_content id="1,2,3,4" relation="any"] allows user with access to 1,2,3, OR 4 to access content
* [hide_content id="1,2,3,4" relation="all"] allows only users with access 1,2,3 AND 4 to access
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Hide_Content
*
* @since 3.5.1
* @since 3.24.1 Unknown.
*/
class LLMS_Shortcode_Hide_Content extends LLMS_Shortcode {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_hide_content';
/**
* Get default shortcode attributes
*
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output()
*
* @since 3.5.1
* @since 3.24.1 Unknown.
*
* @return array
*/
protected function get_default_attributes() {
return array(
'membership' => '', // For backwards compat, use id moving forward/
'message' => '',
'id' => get_the_ID(),
'relation' => 'all',
);
}
/**
* Retrieve the actual content of the shortcode
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter
*
* @since 3.5.1
* @since 3.24.1 Unknown.
*
* @return string
*/
protected function get_output() {
// Backwards compatibility, get membership if set and fallback to the id.
$ids = $this->get_attribute( 'membership' ) ? $this->get_attribute( 'membership' ) : $this->get_attribute( 'id' );
// Explode, trim whitespace and remove empty values.
$ids = (array) array_map( 'trim', array_filter( explode( ',', $ids ) ) );
// Assume content is hidden.
$hidden = true;
if ( 'any' === $this->get_attribute( 'relation' ) && ! empty( $ids ) ) {
foreach ( $ids as $id ) {
if ( llms_is_user_enrolled( get_current_user_id(), $id ) ) {
$hidden = false;
break;
}
}
} elseif ( 'all' === $this->get_attribute( 'relation' ) && ! empty( $ids ) ) {
$inc = 0;
foreach ( $ids as $id ) {
if ( llms_is_user_enrolled( get_current_user_id(), $id ) ) {
$inc++;
}
}
if ( count( $ids ) === $inc ) {
$hidden = false;
}
}
return ! $hidden ? do_shortcode( $this->get_content() ) : $this->get_attribute( 'message' );
}
}
return LLMS_Shortcode_Hide_Content::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.lesson.mark.complete.php
================================================
<?php
/**
* LifterLMS Hide Content Shortcode
*
* [lifterlms_lesson_mark_complete]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.11.1
* @version 3.11.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Lesson_Mark_Complete
*
* @since 3.11.1
*/
class LLMS_Shortcode_Lesson_Mark_Complete extends LLMS_Shortcode {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_lesson_mark_complete';
/**
* Retrieve the actual content of the shortcode
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter
*
* @since 3.11.1
*
* @return string
*/
protected function get_output() {
ob_start();
lifterlms_template_complete_lesson_link();
return ob_get_clean();
}
}
return LLMS_Shortcode_Lesson_Mark_Complete::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.lesson.navigation.php
================================================
<?php
/**
* LifterLMS Lesson Navigation Shortcode
*
* [lifterlms_lesson_navigation]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 10.0.0
* @version 10.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Lesson_Navigation
*
* @since 10.0.0
*/
class LLMS_Shortcode_Lesson_Navigation extends LLMS_Shortcode {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_lesson_navigation';
/**
* Retrieve the actual content of the shortcode
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter
*
* @since 10.0.0
*
* @return string
*/
protected function get_output() {
ob_start();
lifterlms_template_lesson_navigation();
return ob_get_clean();
}
}
return LLMS_Shortcode_Lesson_Navigation::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.membership.instructors.php
================================================
<?php
/**
* LifterLMS Membership Instructors Shortcode
*
* Output an anchor link for a membership.
*
* [lifterlms_membership_instructors]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 8.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Membership_Link
*
* @since 3.0.0
* @since 3.4.3 Unknown.
*/
class LLMS_Shortcode_Membership_Instructors extends LLMS_Shortcode {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_membership_instructors';
/**
* Retrieve the actual content of the shortcode
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter
*
* @return string
* @since 8.0.0
*/
protected function get_output() {
if ( 'llms_membership' !== get_post_type( get_the_ID() ) ) {
return '';
}
ob_start();
llms_template_instructors();
return ob_get_clean();
}
/**
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output()
*
* @return array
* @since 8.0.0
*/
protected function get_default_attributes() {
return array();
}
}
return LLMS_Shortcode_Membership_Instructors::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.membership.link.php
================================================
<?php
/**
* LifterLMS Membership Link Shortcode
*
* Output an anchor link for a membership.
*
* [lifterlms_membership_link]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.0.0
* @version 3.4.3
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Membership_Link
*
* @since 3.0.0
* @since 3.4.3 Unknown.
*/
class LLMS_Shortcode_Membership_Link extends LLMS_Shortcode {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_membership_link';
/**
* Retrieve the actual content of the shortcode
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter
*
* @return string
* @since 3.4.3
* @version 3.4.3
*/
protected function get_output() {
if ( 'publish' !== get_post_status( $this->get_attribute( 'id' ) ) ) {
return '';
}
return '<a href="' . get_permalink( $this->get_attribute( 'id' ) ) . '">' . $this->get_content() . '</a>';
}
/**
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output()
*
* @return array
* @since 3.4.3
* @version 3.4.3
*/
protected function get_default_attributes() {
return array(
'id' => get_the_ID(),
);
}
/**
* Retrieves a string used for default content which is used if no content is supplied
*
* @return string
* @since 3.4.3
* @version 3.4.3
*/
protected function get_default_content( $atts = array() ) {
$default_content = 'publish' === get_post_status( $this->get_attribute( 'id' ) ) ? get_the_title( $this->get_attribute( 'id' ) ) : '';
return apply_filters( 'lifterlms_membership_link_text', $default_content, $this->get_attribute( 'id' ) );
}
}
return LLMS_Shortcode_Membership_Link::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.my.account.php
================================================
<?php
/**
* My Account Shortcode
*
* Shortcode: [lifterlms_my_account].
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 1.0.0
* @version 4.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_My_Account class.
*
* @since 1.0.0
* @since 3.25.1 Deprecated method `LLMS_Shortcode_My_Account::lost_password()`.
* @since 4.0.0 Removed previously deprecated method `LLMS_Shortcode_My_Account::lost_password()`.
*/
class LLMS_Shortcode_My_Account {
/**
* Get shortcode content
*
* @since Unknown
*
* @param array $atts Shortcode attributes array.
* @return array $messages
*/
public static function get( $atts ) {
return LLMS_Shortcodes::shortcode_wrapper( array( __CLASS__, 'output' ), $atts );
}
/**
* Determines what content to output to user based on status
*
* @since 1.0.0
* @since 3.25.1
*
* @param array $atts Array of user submitted shortcode attributes.
* @return void
*/
public static function output( $atts ) {
$atts = shortcode_atts(
array(
'layout' => 'columns',
'login_redirect' => null,
),
$atts,
'lifterlms_my_account'
);
lifterlms_student_dashboard( $atts );
}
}
================================================
FILE: includes/shortcodes/class.llms.shortcode.my.achievements.php
================================================
<?php
/**
* LifterLMS My Achievements
*
* [lifterlms_my_achievements]
*
* @package LifterLMS/Shortcodes/Classes
*
* @since 3.14.1
* @version 3.14.1
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_My_Achievements
*
* @since 3.14.1
*/
class LLMS_Shortcode_My_Achievements extends LLMS_Shortcode {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_my_achievements';
/**
* Retrieves an array of default attributes which are automatically merged
* with the user submitted attributes and passed to $this->get_output()
*
* @since 3.14.1
* @return array
*/
protected function get_default_attributes() {
return array(
'count' => null,
'columns' => 5,
'user_id' => get_current_user_id(),
);
}
/**
* Retrieve the actual content of the shortcode
*
* $atts & $content are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter
*
* @since 3.14.1
*
* @return string
*/
protected function get_output() {
if ( ! $this->get_attribute( 'user_id' ) ) {
return '';
}
$student = llms_get_student( $this->get_attribute( 'user_id' ) );
if ( ! $student ) {
return '';
}
$course = new LLMS_Course( $this->get_attribute( 'course_id' ) );
ob_start();
lifterlms_template_achievements_loop( $student, $this->get_attribute( 'count' ), $this->get_attribute( 'columns' ) );
return ob_get_clean();
}
}
return LLMS_Shortcode_My_Achievements::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcode.registration.php
================================================
<?php
/**
* LifterLMS Registration Shortcode
*
* [lifterlms_registration]
*
* @package LifterLMS/Classes/Shortcodes
*
* @since 3.0.0
* @version 5.0.2
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcode_Registration
*
* @since 3.0.0
* @since 3.4.3 Migrated to utilize `LLMS_Shortcode` abstract.
*/
class LLMS_Shortcode_Registration extends LLMS_Shortcode {
/**
* Shortcode tag
*
* @var string
*/
public $tag = 'lifterlms_registration';
/**
* Retrieve the actual content of the shortcode
*
* The variables `$atts` & `$content` are both filtered before being passed to get_output()
* output is filtered so the return of get_output() doesn't need its own filter.
*
* @since 3.4.3
* @since 5.0.0 Remove password strength enqueue script.
* @since 5.0.2 Added select enqueue script and inline script for address info.
*
* @return string
*/
protected function get_output() {
/**
* Enqueue select2 scripts and styles.
*/
llms()->assets->enqueue_script( 'llms-select2' );
llms()->assets->enqueue_style( 'llms-select2-styles' );
if ( ! wp_script_is( 'llms' ) ) {
// If the main LifterLMS script isn't enqueued, adding inline script below will fail.
llms()->assets->enqueue_script( 'llms' );
}
wp_add_inline_script(
'llms',
"window.llms.address_info = '" . wp_json_encode( llms_get_countries_address_info() ) . "';"
);
ob_start();
include llms_get_template_part_contents( 'global/form', 'registration' );
return ob_get_clean();
}
}
return LLMS_Shortcode_Registration::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcodes.blocks.php
================================================
<?php
/**
* LifterLMS Shortcodes Blocks
*
* @package LifterLMS/Classes/Shortcodes
*
* @since 7.2.0
* @version 7.2.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcodes_Blocks class.
*
* @since 7.2.0
*/
class LLMS_Shortcodes_Blocks {
/**
* Instance of the class.
*
* @since 7.2.0
*
* @var self
*/
private static $instance;
/**
* Get instance of the class.
*
* @since 7.2.0
*
* @return self
*/
public static function instance(): LLMS_Shortcodes_Blocks {
if ( ! isset( self::$instance ) ) {
self::$instance = new LLMS_Shortcodes_Blocks();
}
return self::$instance;
}
/**
* Constructor.
*
* @since 7.2.0
*
* @return void
*/
public function __construct() {
add_action( 'init', array( $this, 'register_blocks' ) );
add_action( 'init', array( __CLASS__, 'add_editor_styles' ) );
add_action( 'admin_enqueue_scripts', array( __CLASS__, 'enqueue_editor_styles' ) );
add_filter( 'llms_hide_registration_form', array( $this, 'show_form_preview' ) );
add_filter( 'llms_hide_login_form', array( $this, 'show_form_preview' ) );
}
/**
* Available shortcode blocks.
*
* @since 7.2.0
*
* @return array
*/
private function get_config(): array {
$config = array(
'access-plan-button' => array(
'render' => array( 'LLMS_Shortcodes', 'access_plan_button' ),
),
'checkout' => array(
'render' => array( 'LLMS_Shortcodes', 'checkout' ),
),
'courses' => array(
'render' => array( 'LLMS_Shortcode_Courses', 'output' ),
),
'course-author' => array(
'render' => array( 'LLMS_Shortcode_Course_Author', 'output' ),
),
'course-continue' => array(
'render' => array( 'LLMS_Shortcode_Course_Continue', 'output' ),
),
'course-meta-info' => array(
'render' => array( 'LLMS_Shortcode_Course_Meta_Info', 'output' ),
),
'course-outline' => array(
'render' => array( 'LLMS_Shortcode_Course_Outline', 'output' ),
),
'course-prerequisites' => array(
'render' => array( 'LLMS_Shortcode_Course_Prerequisites', 'output' ),
),
'course-reviews' => array(
'render' => array( 'LLMS_Shortcode_Course_Reviews', 'output' ),
),
'course-syllabus' => array(
'render' => array( 'LLMS_Shortcode_Course_Syllabus', 'output' ),
),
'login' => array(
'render' => array( 'LLMS_Shortcodes', 'login' ),
),
'memberships' => array(
'render' => array( 'LLMS_Shortcodes', 'memberships' ),
),
'my-account' => array(
'render' => array( 'LLMS_Shortcodes', 'my_account' ),
),
'my-achievements' => array(
'render' => array( 'LLMS_Shortcode_My_Achievements', 'output' ),
),
'registration' => array(
'render' => array( 'LLMS_Shortcode_Registration', 'output' ),
),
);
/**
* Filters shortcode blocks config.
*
* @since 7.2.0
*
* @param array $config Array of shortcode blocks.
*/
return apply_filters( 'llms_shortcode_blocks', $config );
}
/**
* Registers shortcode blocks.
*
* @since 7.2.0
*
* @return void
*/
public function register_blocks(): void {
$blocks = $this->get_config();
foreach ( $blocks as $name => $args ) {
$block_dir = $args['path'] ?? LLMS_PLUGIN_DIR . "blocks/$name";
if ( file_exists( "$block_dir/block.json" ) ) {
register_block_type(
$block_dir,
array(
'render_callback' => array( $this, 'render_block' ),
)
);
}
}
}
/**
* Loads front end CSS in the editor.
*
* @since 7.2.0
*
* @return void
*/
public static function add_editor_styles(): void {
$plugins_dir = basename( WP_PLUGIN_DIR );
$plugin_dir = basename( LLMS_PLUGIN_DIR );
$rtl = is_rtl() ? '-rtl' : '';
$path = "../../$plugins_dir/$plugin_dir/assets/css/lifterlms{$rtl}.min.css";
add_editor_style( $path );
}
/**
* Enqueues editor styles.
*
* @since 7.2.0
*
* @return void
*/
public static function enqueue_editor_styles(): void {
if ( ! llms_is_block_editor() ) {
return;
}
$path = '/assets/css/editor.min.css';
if ( ! file_exists( LLMS()->plugin_path() . $path ) ) {
return;
}
wp_enqueue_style(
'llms-editor',
LLMS()->plugin_url() . $path,
array(),
filemtime( LLMS()->plugin_path() . $path )
);
}
/**
* Determines whether to show the registration and login form in editor preview.
*
* @since 7.2.0
*
* @param bool $hide Whether to hide the registration form.
* @return bool
*/
public function show_form_preview( bool $hide ): bool {
if ( llms_is_editor_block_rendering() ) {
$hide = false;
}
return $hide;
}
/**
* Renders a shortcode block.
*
* @since 7.2.0
*
* @param array $attributes The block attributes.
* @param string $content The block default content.
* @param WP_Block $block The block instance.
* @return string
*/
public function render_block( array $attributes, string $content, WP_Block $block ): string {
if ( ! property_exists( $block, 'name' ) ) {
return '';
}
$name = str_replace( 'llms/', '', $block->name );
$config = $this->get_config();
$render = $config[ $name ]['render'] ?? array();
if ( method_exists( $render[0] ?? '', 'instance' ) ) {
$render = array( $render[0]::instance(), $render[1] ?? '' );
}
if ( ! is_callable( $render ) ) {
return '';
}
if ( ! apply_filters( 'llms_render_block', true, $block ) ) {
return '';
}
$text = $attributes['text'] ?? '';
unset( $attributes['text'] );
$args = array( $attributes );
if ( $text ) {
$args[] = $text;
}
$html = call_user_func( $render, ...$args );
// This allows emptyResponsePlaceholder to be used when no content is returned.
if ( ! $html ) {
return '';
}
// Use emptyResponsePlaceholder for Courses block instead of shortcode message.
if ( false !== strpos( $html, __( 'No products were found matching your selection.', 'lifterlms' ) ) ) {
return '';
}
return sprintf(
'<div %1$s>%2$s</div>',
get_block_wrapper_attributes(),
trim( $html )
);
}
}
return LLMS_Shortcodes_Blocks::instance();
================================================
FILE: includes/shortcodes/class.llms.shortcodes.php
================================================
<?php
/**
* LifterLMS Shortcodes
*
* @package LifterLMS/Classes/Shortcodes
*
* @since 1.0.0
* @version 7.5.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Shortcodes
*
* @since 1.0.0
* @since 4.0.0 Remove reliance on deprecated class `LLMS_Quiz_Legacy` & stop registering deprecated shortcode `[courses]` and `[lifterlms_user_statistics]`.
*/
class LLMS_Shortcodes {
/**
* Constructor.
*
* @since 6.4.0
*
* @return void
*/
public function __construct() {
add_action( 'init', array( 'LLMS_Shortcodes', 'init' ) );
}
/**
* Initialize shortcodes array.
*
* @since 1.0.0
* @since 3.11.1 Unknown.
* @since 4.0.0 Stop registering previously deprecated shortcode `[courses]` and `[lifterlms_user_statistics]`.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
* @since 6.4.0 Allowed `LLMS_Shortcode_User_Info` class to be filtered.
* @since 7.5.0 Added `LLMS_Shortcode_Favorites` class in shortcodes array.
* @since 10.0.0 Added `LLMS_Shortcode_Lesson_Navigation` class in shortcodes array.
*
* @return void
*/
public static function init() {
// New method.
$scs = apply_filters(
/**
* Filters the shortcodes to initialize.
*
* @since Unknown
*
* @param string[] $shortcodes Array of shortcode class names to initialize.
*/
'llms_load_shortcodes',
array(
'LLMS_Shortcode_Course_Author',
'LLMS_Shortcode_Course_Continue',
'LLMS_Shortcode_Course_Continue_Button',
'LLMS_Shortcode_Course_Instructors',
'LLMS_Shortcode_Course_Meta_Info',
'LLMS_Shortcode_Course_Outline',
'LLMS_Shortcode_Course_Prerequisites',
'LLMS_Shortcode_Course_Reviews',
'LLMS_Shortcode_Course_Syllabus',
'LLMS_Shortcode_Courses',
'LLMS_Shortcode_Hide_Content',
'LLMS_Shortcode_Lesson_Mark_Complete',
'LLMS_Shortcode_Lesson_Navigation',
'LLMS_Shortcode_Membership_Link',
'LLMS_Shortcode_Membership_Instructors',
'LLMS_Shortcode_My_Achievements',
'LLMS_Shortcode_Registration',
'LLMS_Shortcode_User_Info',
'LLMS_Shortcode_Favorites',
)
);
$hyphenated_file_classes = array(
'LLMS_Shortcode_User_Info',
);
foreach ( $scs as $class ) {
$separator = in_array( $class, $hyphenated_file_classes, true ) ? '-' : '.';
$filename = "class{$separator}" . strtolower( str_replace( '_', $separator, $class ) );
/**
* Filters the path of the shortcode class file.
*
* @since Unknown
*
* @param string $file The shortcode class file name.
* @param string $class The shortcode class name.
*/
$path = apply_filters( 'llms_load_shortcode_path', LLMS_PLUGIN_DIR . "includes/shortcodes/{$filename}.php", $class );
if ( file_exists( $path ) ) {
require_once $path;
}
}
/**
* @deprecated 2.0.0
* @todo deprecate
*/
add_shortcode( 'courses', array( LLMS_Shortcode_Courses::instance(), 'output' ) );
// Old method.
$shortcodes = array(
'lifterlms_access_plan_button' => __CLASS__ . '::access_plan_button',
'lifterlms_my_account' => __CLASS__ . '::my_account',
'lifterlms_checkout' => __CLASS__ . '::checkout',
'lifterlms_course_info' => __CLASS__ . '::course_info',
'lifterlms_course_progress' => __CLASS__ . '::course_progress',
'lifterlms_course_title' => __CLASS__ . '::course_title',
'lifterlms_related_courses' => __CLASS__ . '::related_courses',
'lifterlms_login' => __CLASS__ . '::login',
'lifterlms_pricing_table' => __CLASS__ . '::pricing_table',
'lifterlms_memberships' => __CLASS__ . '::memberships',
);
foreach ( $shortcodes as $shortcode => $function ) {
add_shortcode(
/**
* Filters the shortcode tag.
*
* The dynamic portion of the hook name, `$shortcode` refers to the shortcode tag itself.
*
* @since Unknown
*
* @param string $shortcode The shortcode tag.
*/
apply_filters( "{$shortcode}_shortcode_tag", $shortcode ),
$function
);
}
}
/**
* Allows shortcodes to enqueue a script by handle
*
* Ensures the handle is registered and that it hasn't already been enqueued.
*
* @since 3.0.2
*
* @param string $handle Script handle used to register the script.
* The script should be registered in `LLMS_Frontend_Assets`.
* @return void
*/
private static function enqueue_script( $handle ) {
if ( wp_script_is( $handle, 'registered' ) && ! wp_script_is( $handle, 'enqueued' ) ) {
wp_enqueue_script( $handle );
}
}
/**
* Retrieve the course ID from within a course, lesson, or quiz
*
* @since 2.7.9
* @since 3.16.0 Unknown.
* @since 4.0.0 Remove reliance on deprecated class `LLMS_Quiz_Legacy`.
*
* @return int
*/
private static function get_course_id() {
$id = get_the_ID();
if ( is_course() ) {
return $id;
}
$course = llms_get_post_parent_course( $id );
if ( $course ) {
return $course->get( 'id' );
}
return 0;
}
/**
* Creates a wrapper for shortcode.
*
* @return string
*/
public static function shortcode_wrapper(
$function,
$atts = array(),
$wrapper = array(
'class' => 'lifterlms',
'before' => null,
'after' => null,
)
) {
ob_start();
echo empty( $wrapper['before'] ) ? '<div class="' . esc_attr( $wrapper['class'] ) . '">' : wp_kses_post( $wrapper['before'] );
call_user_func( $function, $atts );
echo empty( $wrapper['after'] ) ? '</div>' : wp_kses_post( $wrapper['after'] );
return ob_get_clean();
}
/**
* Create a button for an Access Plan
*
* @since 3.2.5
* @since 3.4.1 Unknown.
*
* @param array $atts Associative array of shortcode attributes.
* @param string $content Optional. Shortcode content, enables custom text/html in the button. Default empty string.
* @return string
*/
public static function access_plan_button( $atts, $content = '' ) {
$atts = shortcode_atts(
array(
'classes' => '',
'id' => null,
'size' => '', // Can be: small, large.
'type' => 'primary', // Can be: primary, secondary, action, danger.
),
$atts,
'lifterlms_access_plan_button'
);
$ret = '';
if ( ! empty( $atts['id'] ) && is_numeric( $atts['id'] ) ) {
$plan = new LLMS_Access_Plan( $atts['id'] );
$classes = 'llms-button-' . $atts['type'];
$classes .= ! empty( $atts['size'] ) ? ' ' . $atts['size'] : '';
$classes .= ! empty( $atts['classes'] ) ? ' ' . $atts['classes'] : '';
$text = empty( $content ) ? $plan->get_enroll_text() : $content;
$ret = '<a class="' . esc_attr( $classes ) . '" href="' . esc_url( $plan->get_checkout_url() ) . '" title="' . esc_attr( $plan->get( 'title' ) ) . '" aria-label="' . esc_attr( $plan->get_enroll_text( true ) ) . '">' . $text . '</a>';
}
/**
* Filters the access plan button shortcode output
*
* @since unknown
*
* @param string $ret The shortcode output.
* @param array $atts Associative array of shortcode attributes.
* @param string $content Shortcode content, enables custom text/html in the button. Default empty string.
*/
return apply_filters( 'llms_shortcode_access_plan_button', $ret, $atts, $content );
}
/**
* Add a login form
*
* @since 3.0.4
* @since 3.19.4 Unknown.
*
* @param array $atts Associative array of shortcode attributes.
* @return string
*/
public static function login( $atts ) {
extract(
shortcode_atts(
array(
'layout' => 'columns',
'redirect' => get_permalink(),
),
$atts,
'lifterlms_login'
)
);
ob_start();
llms_print_notices();
llms_get_login_form( null, $redirect, $layout );
return ob_get_clean();
}
/**
* My account shortcode
*
* Used for displaying account.
*
* @see self::shortcode_wrapper()
*
* @return string
*/
public static function my_account( $atts ) {
return self::shortcode_wrapper( array( 'LLMS_Shortcode_My_Account', 'output' ), $atts );
}
/**
* Memberships Shortcode
*
* Used for shortcode [lifterlms_memberships].
*
* @since 1.4.4
* @since 3.0.2
* @since 4.12.0 Handle pagination when the shortcode is used on the static front page.
*
* @param array $atts Associative array of shortcode attributes.
* @return string
*/
public static function memberships( $atts ) {
// Enqueue match height so the loop isn't all messed up visually.
self::enqueue_script( 'llms-jquery-matchheight' );
if ( isset( $atts['category'] ) ) {
$tax = array(
array(
'taxonomy' => 'membership_cat',
'field' => 'slug',
'terms' => $atts['category'],
),
);
}
$args = array(
'paged' => is_front_page() ? get_query_var( 'page' ) : get_query_var( 'paged' ),
'post_type' => 'llms_membership',
'post_status' => 'publish',
'posts_per_page' => isset( $atts['posts_per_page'] ) ? $atts['posts_per_page'] : -1,
'order' => isset( $atts['order'] ) ? $atts['order'] : 'ASC',
'orderby' => isset( $atts['orderby'] ) ? $atts['orderby'] : 'title',
'tax_query' => isset( $tax ) ? $tax : '',
);
if ( isset( $atts['id'] ) ) {
$args['p'] = $atts['id'];
}
$query = new WP_Query( $args );
ob_start();
if ( $query->have_posts() ) :
/**
* lifterlms_before_loop hook
*
* @hooked lifterlms_loop_start - 10
*/
do_action( 'lifterlms_before_loop' );
while ( $query->have_posts() ) :
$query->the_post();
llms_get_template_part( 'loop/content', get_post_type() );
endwhile;
/**
* lifterlms_before_loop hook
*
* @hooked lifterlms_loop_end - 10
*/
do_action( 'lifterlms_after_loop' );
echo '<nav class="llms-pagination">';
$pagination = paginate_links(
array(
'base' => str_replace( 999999, '%#%', esc_url( get_pagenum_link( 999999 ) ) ),
'format' => '?page=%#%',
'total' => $query->max_num_pages,
'current' => max( 1, $args['paged'] ),
'prev_next' => true,
'prev_text' => '«' . __( 'Previous', 'lifterlms' ),
'next_text' => __( 'Next', 'lifterlms' ) . '»',
'type' => 'list',
)
);
if ( ! empty( $pagination ) ) {
echo wp_kses_post( $pagination );
}
echo '</nav>';
else :
llms_get_template( 'loop/none-found.php' );
endif;
wp_reset_postdata();
return ob_get_clean();
}
/**
* Checkout shortcode
*
* Used for displaying checkout form.
*
* @see self::shortcode_wrapper
*
* @param array $atts Associative array of shortcode attributes.
* @return string
*/
public static function checkout( $atts ) {
return self::shortcode_wrapper( array( 'LLMS_Shortcode_Checkout', 'output' ), $atts );
}
/**
* Output various pieces of metadata about a course
*
* @since 3.0.0
* @since 3.4.1 Unknown.
*
* @param array $atts Array of user-submitted shortcode attributes.
* @return string
*/
public static function course_info( $atts ) {
$default_type = '';
if ( isset( $atts['key'] ) && false !== strpos( $atts['key'], '_date' ) ) {
$default_type = 'date';
}
extract(
shortcode_atts(
array(
'date_format' => get_option( 'date_format' ), // If $type is date, a custom date format can be supplied.
'id' => get_the_ID(),
'key' => '',
'type' => $default_type, // Can either be: date, price or empty string.
),
$atts,
'lifterlms_course_info'
)
);
$ret = '';
if ( $key ) {
$course = new LLMS_Course( $id );
switch ( $type ) {
case 'date':
$ret = $course->get_date( $key, $date_format );
break;
case 'price':
$ret = $course->get_price( $key );
break;
default:
$ret = $course->get( $key );
}
}
/**
* Filters the course info shortcode output
*
* @since unknown
*
* @param string $ret The shortcode output.
* @param array $atts Associative array of shortcode attributes.
*/
return apply_filters( 'llms_shortcode_course_info', $ret, $atts );
}
/**
* Course Progress Bar Shortcode
*
* @since unknown
* @since 3.38.0 Added logic to display the bar only to enrolled user.
*
* @param array $atts Associative array of shortcode attributes.
* @return string
*/
public static function course_progress( $atts ) {
$course_id = self::get_course_id();
if ( ! $course_id ) {
return '';
}
if ( ! empty( $atts['check_enrollment'] ) && ! llms_is_user_enrolled( get_current_user_id(), $course_id ) ) {
return '';
}
$course = new LLMS_Course( $course_id );
$course_progress = $course->get_percent_complete();
return lifterlms_course_progress_bar( $course_progress, false, false, false );
}
/**
* Retrieve the Course Title
*
* @since unknown
* @since 2.7.9 Unknown
*
* @param array $atts Associative array of shortcode attributes.
* @return string
*/
public static function course_title( $atts ) {
$course_id = self::get_course_id();
if ( ! $course_id ) {
return '';
}
return get_the_title( $course_id );
}
/**
* Courses shortcode
*
* Used for [lifterlms_related_courses].
*
* @since unknown
*
* @param array $atts Associative array of shortcode attributes.
* @return array
*/
public static function related_courses( $atts ) {
ob_start();
if ( isset( $atts['category'] ) ) {
$tax = array(
array(
'taxonomy' => 'course_cat',
'field' => 'slug',
'terms' => $atts['category'],
),
);
}
$query = new WP_Query(
array(
'post_type' => 'course',
'post_status' => 'publish',
'posts_per_page' => isset( $atts['per_page'] ) ? $atts['per_page'] : -1,
'order' => isset( $atts['order'] ) ? $atts['order'] : 'ASC',
'orderby' => isset( $atts['orderby'] ) ? $atts['orderby'] : 'title',
'tax_query' => isset( $tax ) ? $tax : '',
)
);
if ( $query->have_posts() ) {
lifterlms_course_loop_start();
while ( $query->have_posts() ) :
$query->the_post();
llms_get_template_part( 'content', 'course' );
endwhile;
lifterlms_course_loop_end();
$courses = ob_get_clean();
wp_reset_postdata();
return $courses;
}
}
/**
* Output a Pricing Table anywhere a shortcode can be output
*
* @since 3.2.5
* @since 3.23.0 Unknown.
* @since 3.38.0 Use `in_array()` with strict comparison.
*
* @param array $atts Associative array of shortcode attributes.
* @return string
*/
public static function pricing_table( $atts ) {
$atts = shortcode_atts(
array(
'product' => null,
),
$atts,
'lifterlms_pricing_table'
);
$ret = '';
// get product id from loop if used from within a course or membership.
if ( ! $atts['product'] ) {
$id = get_the_ID();
if ( in_array( get_post_type( $id ), array( 'course', 'llms_membership' ), true ) ) {
$atts['product'] = get_the_ID();
}
}
if ( ! empty( $atts['product'] ) && is_numeric( $atts['product'] ) ) {
// enqueue match height for height alignments.
self::enqueue_script( 'llms-jquery-matchheight' );
ob_start();
lifterlms_template_pricing_table( $atts['product'] );
$ret = ob_get_clean();
}
/**
* Filters the pricing table shortcode output
*
* @since unknown
*
* @param string $ret The shortcode output.
* @param array $atts Associative array of shortcode attributes.
*/
return apply_filters( 'llms_shortcode_pricing_table', $ret, $atts );
}
}
return new LLMS_Shortcodes();
================================================
FILE: includes/shortcodes/index.php
================================================
<?php // silence.
================================================
FILE: includes/spam/class-llms-akismet.php
================================================
<?php
/**
* LifterLMS Google reCAPTCHA integration.
*
* This class integrates Google's reCAPTCHA into LifterLMS checkout and registration forms.
*
* @package LifterLMS/Includes/Spam
* @since 9.0.0
*/
defined( 'ABSPATH' ) || exit;
class LLMS_Akismet extends LLMS_Captcha {
use LLMS_Trait_Singleton;
public function get_slug() {
return 'akismet';
}
public function render() {
// Add in a honey pot field to help prevent spam bots.
if ( ! $this->is_enabled() || is_admin() ) {
return;
}
echo '<input type="text" aria-hidden="true" class="sr-only" name="llms_hp_fullname" style="display:none;" autocomplete="off" />';
}
public function is_available() {
// Check if the Akismet plugin is active and the API key is set.
return defined( 'AKISMET_VERSION' ) && class_exists( 'Akismet' ) && method_exists( 'Akismet', 'get_api_key' ) && ! empty( Akismet::get_api_key() );
}
public function is_enabled() {
return $this->is_available() && llms_parse_bool( get_option( 'lifterlms_akismet_enabled', false ) );
}
public function validate( $valid ) {
if ( ! $this->is_enabled() ) {
return $valid;
}
// If $valid is already a truthy, return early since something else already encountered a validation issue.
if ( $valid ) {
return $valid;
}
$data_to_check = array(
'user_ip' => sanitize_text_field( llms_get_ip_address() ),
'user_agent' => sanitize_text_field( $_SERVER['HTTP_USER_AGENT'] ),
'referrer' => sanitize_text_field( $_SERVER['HTTP_REFERER'] ),
'blog' => get_option( 'home' ),
'blog_lang' => get_locale(),
'blog_charset' => get_option( 'blog_charset' ),
'permalink' => get_permalink(),
'comment_type' => 'signup',
'comment_author' => sanitize_text_field( $_REQUEST['email_address'] ?? wp_get_current_user()->user_email ?? '' ),
'comment_author_email' => sanitize_email( $_REQUEST['email_address'] ?? wp_get_current_user()->user_email ?? '' ),
'honeypot_field_name' => 'llms_hp_fullname',
);
$response = Akismet::http_post( build_query( $data_to_check ), 'comment-check' );
// If the response is empty, we can't determine if it's spam or not.
if ( empty( $response ) ) {
return $valid;
}
$passed = true;
// If the X-akismet-pro-tip is set to 'discard' return 2 as blatant spam.
if ( ! empty( $response[0] ) ) {
$headers = $response[0]->getAll();
if ( isset( $headers['x-akismet-pro-tip'] ) && $headers['x-akismet-pro-tip'] === 'discard' ) {
$passed = false;
}
}
// If the response is true, return 1 as likely spam.
if ( ! empty( $response[1] ) && $response[1] == 'true' ) {
// Check if this is a free plan or paid. If it's a free plan or not a checkout, we treat it as spam.
$plan_id = absint( $_POST['llms_plan_id'] ?? 0 );
if ( ! $plan_id ) {
// If no plan ID is provided, we assume it's open registration.
$passed = false;
}
if ( $plan_id && ( $plan = new LLMS_Access_Plan( $plan_id ) ) && $plan->is_free() ) {
$passed = false;
}
}
if ( ! $passed ) {
if ( apply_filters( 'llms_enable_spam_logs', false ) ) {
error_log( 'LLMS_Akismet verification failed: ' . print_r( $response, true ) );
}
llms_add_notice( __( 'Suspicious activity detected. Try again in a few minutes.', 'lifterlms' ), 'error' );
return true;
}
// We're okay to proceed.
return $valid;
}
}
return LLMS_Akismet::instance();
================================================
FILE: includes/spam/class-llms-captcha.php
================================================
<?php
/**
* LifterLMS Google reCAPTCHA integration.
*
* This class integrates Google's reCAPTCHA into LifterLMS checkout and registration forms.
*
* @package LifterLMS/Includes/Spam
* @since 9.0.0
*/
abstract class LLMS_Captcha {
protected $site_key;
protected $secret_key;
public function __construct() {
$slug = sanitize_title( $this->get_slug() );
$constant_prefix = 'LLMS_' . strtoupper( $slug );
$this->site_key = defined( $constant_prefix . '_SITE_KEY' ) ? constant( $constant_prefix . '_SITE_KEY' ) : get_option( 'lifterlms_' . $slug . '_site_key' );
$this->secret_key = defined( $constant_prefix . '_SECRET_KEY' ) ? constant( $constant_prefix . '_SECRET_KEY' ) : get_option( 'lifterlms_' . $slug . '_secret_key' );
add_action( 'llms_checkout_footer_before', array( $this, 'render' ) );
add_action( 'lifterlms_after_registration_fields', array( $this, 'render' ) );
add_action( 'lifterlms_after_free_enroll_fields', array( $this, 'render' ) );
add_action( 'llms_before_checkout_validation', array( $this, 'validate' ) );
add_filter( 'llms_before_registration_validation', array( $this, 'validate' ) );
add_action( 'lifterlms_after_free_enroll_fields', array( $this, 'show_notices' ) );
}
/**
* Get the name of the captcha service.
*
* @return string
*/
abstract public function get_slug();
/**
* Render the captcha in the footer.
*
* @since 9.0.0
*
* @return void
*/
abstract public function render();
/**
* Validate the captcha response.
*
* @since 9.0.0
*
* @param array $data Form data.
*
* @return array
*/
abstract public function validate( $data );
/**
* Check if the captcha is enabled.
*
* @since 9.0.0
*
* @return bool
*/
public function is_enabled() {
return $this->get_slug() === get_option( 'lifterlms_captcha' );
}
/**
* Show notices if enabled.
*
* @since 9.0.0
*
* @return void
*/
function show_notices() {
if ( ! $this->is_enabled() ) {
return;
}
if ( is_admin() ) {
return;
}
llms_print_notices();
}
}
================================================
FILE: includes/spam/class-llms-recaptcha.php
================================================
<?php
/**
* LifterLMS Google reCAPTCHA integration.
*
* This class integrates Google's reCAPTCHA into LifterLMS checkout and registration forms.
*
* @package LifterLMS/Includes/Spam
* @since 9.0.0
*/
defined( 'ABSPATH' ) || exit;
class LLMS_Google_Recaptcha extends LLMS_Captcha {
use LLMS_Trait_Singleton;
protected $min_score;
protected $action;
public function __construct() {
parent::__construct();
/**
* Minimum score for reCAPTCHA validation.
*
* @since 9.0.0
*/
$this->min_score = apply_filters( 'lifterlms_recaptcha_min_score', ( absint( get_option( 'lifterlms_recaptcha_min_score', 5 ) ) / 10 ) );
/**
* Action name for reCAPTCHA validation.
*
* @since 9.0.0
*/
$this->action = apply_filters( 'lifterlms_recaptcha_action', 'submit' );
}
public function get_slug() {
return 'recaptcha';
}
public function render() {
if ( ! $this->is_enabled() ) {
return;
}
if ( is_admin() ) {
return;
}
echo '<input type="hidden" name="g-recaptcha-response" class="llms-google-recaptcha g-recaptcha-response" />';
wp_enqueue_script(
'llms-google-recaptcha',
'https://www.google.com/recaptcha/api.js?render=' . $this->site_key,
array(),
null,
true
);
wp_add_inline_script(
'llms-google-recaptcha',
'
document.querySelectorAll( "form" ).forEach( function( form ) {
if ( form.querySelector( ".llms-google-recaptcha" ) === null ) {
return;
}
function checkout_before_submit( self, callback ) {
grecaptcha.ready(() => {
grecaptcha.execute( "' . esc_js( $this->site_key ) . '", { action: "' . esc_js( $this->action ) . '" } ).then( token => {
self.querySelector("[name=g-recaptcha-response]").value = token;
callback( true );
} );
} );
}
if ( window.llms && "llms-product-purchase-form" === form.id ) {
// If this is the checkout form, use the before_submit method to handle reCAPTCHA.
if ( window.llms.checkout && window.llms.checkout.add_before_submit_event ) {
window.llms.checkout.add_before_submit_event( { data: form, handler: checkout_before_submit } );
} else {
const interval = setInterval( function() {
if ( window.llms.checkout && window.llms.checkout.add_before_submit_event ) {
window.llms.checkout.add_before_submit_event( { data: form, handler: checkout_before_submit } );
clearInterval( interval );
}
}, 100 );
}
return;
}
form.addEventListener( "submit", function( event ) {
event.preventDefault();
if ( form.querySelector( ".llms-password-strength-meter" ) &&
window.LLMS &&
window.LLMS.PasswordStrength &&
window.LLMS.PasswordStrength.get_current_strength_status &&
! window.LLMS.PasswordStrength.get_current_strength_status() ) {
console.log( "Password strength validation failed." );
return false;
}
grecaptcha.ready(() => {
grecaptcha.execute( "' . esc_js( $this->site_key ) . '", { action: "' . esc_js( $this->action ) . '" } ).then( token => {
form.querySelector( "[name=g-recaptcha-response]" ).value = token;
form.submit();
} );
} );
} );
} );
'
);
}
public function validate( $valid ) {
if ( ! $this->is_enabled() ) {
return $valid;
}
// If $valid is already a truthy, return early since something else already encountered a validation issue.
if ( $valid ) {
return $valid;
}
$token = isset( $_POST['g-recaptcha-response'] )
? sanitize_text_field( wp_unslash( $_POST['g-recaptcha-response'] ) )
: '';
if ( ! $token ) {
if ( apply_filters( 'llms_enable_recaptcha_logs', false ) ) {
error_log( 'LifterLMS form blocked due to missing captcha' );
}
llms_add_notice( __( 'CAPTCHA token missing, please refresh and try again.', 'lifterlms' ), 'error' );
return true;
}
$response = wp_remote_post(
'https://www.google.com/recaptcha/api/siteverify',
array(
'body' => array(
'secret' => $this->secret_key,
'response' => $token,
'remoteip' => $_SERVER['REMOTE_ADDR'] ?? '',
),
'timeout' => 15,
)
);
$body = ! is_wp_error( $response ) ? json_decode( wp_remote_retrieve_body( $response ), true ) : null;
$passed = $body
&& ! empty( $body['success'] )
&& $body['score'] >= $this->min_score
&& ( empty( $body['action'] ) || $body['action'] === $this->action ); // action check is optional but recommended
if ( ! $passed ) {
if ( apply_filters( 'llms_enable_spam_logs', false ) ) {
error_log( 'LLMS_Google_Recaptcha verification failed: ' . ( $body ? print_r( $body, true ) : '' ) );
}
llms_add_notice( __( 'CAPTCHA validation failed — please try again.', 'lifterlms' ), 'error' );
return true;
}
// We're okay to proceed.
return $valid;
}
}
return LLMS_Google_Recaptcha::instance();
================================================
FILE: includes/spam/class-llms-turnstile.php
================================================
<?php
/**
* LifterLMS Turnstile integration.
*
* This class integrates Cloudflare's Turnstile captcha into LifterLMS checkout and registration forms.
*
* @package LifterLMS/Includes/Spam
* @since 9.0.0
*/
defined( 'ABSPATH' ) || exit;
class LLMS_Turnstile extends LLMS_Captcha {
use LLMS_Trait_Singleton;
public function __construct() {
parent::__construct();
add_action( 'wp_head', array( $this, 'add_turnstile_script' ) );
}
public function get_slug() {
return 'turnstile';
}
/**
* Enqueue the Cloudflare Turnstile script.
*
* @since 9.0.0
*
* @return void
*/
public function add_turnstile_script() {
if ( ! $this->is_enabled() ) {
return;
}
if ( is_admin() ) {
return;
}
wp_enqueue_script( 'cloudflare-turnstile', 'https://challenges.cloudflare.com/turnstile/v0/api.js' );
}
/**
* Add the Turnstile widget to the checkout and registration forms.
*
* @since 9.0.0
*
* @return void
*/
public function render() {
if ( ! $this->is_enabled() ) {
return;
}
if ( is_admin() ) {
return;
}
?>
<div class="cf-turnstile" data-sitekey="<?php echo esc_attr( $this->site_key ); ?>"></div>
<?php
}
/**
* Validate the Turnstile captcha response.
*
* @since 9.0.0
*
* @param mixed $valid The current validation status.
* @return mixed True if validation fails, otherwise the original $valid value.
*/
public function validate( $valid ) {
if ( ! $this->is_enabled() ) {
return $valid;
}
// If $valid is already a truthy, return early since something else already encountered a validation issue.
if ( $valid ) {
return $valid;
}
// If we don't have a response to test, return an error and stop registration.
$captcha = llms_filter_input_sanitize_string( INPUT_POST, 'cf-turnstile-response' );
if ( ! $captcha ) {
if ( apply_filters( 'llms_enable_recaptcha_logs', false ) ) {
error_log( 'LifterLMS form blocked due to missing captcha' );
}
// Customize the error message displayed when a registration is blocked.
llms_add_notice( __( 'Blocked.', 'lifterlms' ), 'error' );
return true;
}
// Ok, try to validate the captcha.
if ( isset( $_SERVER['HTTP_CF_CONNECTING_IP'] ) && filter_var( $_SERVER['HTTP_CF_CONNECTING_IP'], FILTER_VALIDATE_IP ) ) {
// Use the CloudFlare IP if it exists.
$ip = $_SERVER['HTTP_CF_CONNECTING_IP'];
} else {
$ip = $_SERVER['REMOTE_ADDR'];
}
$url_path = 'https://challenges.cloudflare.com/turnstile/v0/siteverify';
$data = array(
'secret' => $this->secret_key,
'response' => $captcha,
'remoteip' => $ip,
);
$options = array(
'http' => array(
'header' => "Content-Type: application/x-www-form-urlencoded\r\n" .
"User-Agent: PHP Script\r\n",
'method' => 'POST',
'content' => http_build_query( $data ),
),
);
$stream = stream_context_create( $options );
$result = file_get_contents( $url_path, false, $stream );
$response = $result;
$response_keys = json_decode( $response, true );
if ( intval( $response_keys['success'] ) !== 1 ) {
if ( apply_filters( 'llms_enable_spam_logs', false ) ) {
error_log( 'LLMS_Turnstile verification failed: ' . print_r( $response, true ) );
}
llms_add_notice( __( 'Verification failed. Please try again.', 'lifterlms' ), 'error' );
return true;
}
// We're okay to proceed.
return $valid;
}
}
return LLMS_Turnstile::instance();
================================================
FILE: includes/theme-support/class-llms-theme-support.php
================================================
<?php
/**
* Manage Theme Support classes
*
* @package LifterLMS/ThemeSupport/Classes
*
* @since 3.37.0
* @version 5.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Twenty_Twenty class.
*
* @since 3.37.0
*/
class LLMS_Theme_Support {
/**
* Constructor
*
* @since 3.37.0
* @since 4.3.0 Load includes during `after_setup_theme` instead of `plugins_loaded`.
*
* @return void
*/
public function __construct() {
add_action( 'after_setup_theme', array( $this, 'includes' ) );
}
/**
* Retrieve formatted inline CSS for a given list of selectors and rules
*
* @since 4.10.0
*
* @param string[] $selectors Array of CSS selectors.
* @param string[] $rules Associative array of CSS rules and properties. For example: `array( 'color' => '#fff' )`.
* @param string $selector_prefix A CSS selector to prefix each item in $selectors with.
* @return string
*/
public static function get_css( $selectors, $rules, $selector_prefix = '' ) {
// Convert the $rules array to a list of CSS strings.
$rules_list = array();
foreach ( $rules as $prop => $val ) {
$val = is_array( $val ) ? $val : array( $val );
foreach ( $val as $value ) {
$rules_list[] = sprintf( '%1$s: %2$s;', $prop, $value );
}
}
// When supplied, prefix each selector.
if ( $selector_prefix ) {
foreach ( $selectors as &$selector ) {
$selector = $selector_prefix . ' ' . $selector;
}
}
// Return the formatted CSS.
return implode( ', ', $selectors ) . ' { ' . implode( ' ', $rules_list ) . ' }';
}
/**
* Retrieve a list of CSS selectors for elements where the primary color is used as the background
*
* The primary color is a bright blue (#2295ff).
*
* @since 4.10.0
*
* @return string[] A list of CSS selectors.
*/
public static function get_selectors_primary_color_background() {
/**
* Filter the list of CSS selectors for elements where the primary color is used as the background
*
* @since 4.10.0
*
* @param string[] $selectors A list of CSS selectors.
*/
return apply_filters(
'llms_theme_support_get_selectors_primary_color_background',
array(
// Buttons.
'.llms-button-primary',
'.llms-button-primary:hover',
'.llms-button-primary.clicked',
'.llms-button-primary:focus',
'.llms-button-primary:active',
'.llms-button-action',
'.llms-button-action:hover',
'.llms-button-action.clicked',
'.llms-button-action:focus',
'.llms-button-action:active',
// Pricing Tables.
'.llms-access-plan-title',
'.llms-access-plan .stamp',
'.llms-access-plan.featured .llms-access-plan-featured',
// Checkout.
'.llms-checkout-wrapper .llms-form-heading',
// Notices.
'.llms-notice:not(.llms-debug)',
// Progress Bar.
'.llms-progress .progress-bar-complete',
// My Grades.
'.llms-sd-widgets .llms-sd-widget .llms-sd-widget-title',
// Instructor.
'.llms-instructor-info .llms-instructors .llms-author .avatar',
// Quizzes.
'.llms-question-wrapper ol.llms-question-choices li.llms-choice input:checked + .llms-marker',
)
);
}
/**
* Retrieve a list of CSS selectors for elements where the primary color is used as the border color
*
* The primary color is a bright blue (#2295ff).
*
* @since 4.10.0
*
* @return string[] A list of CSS selectors.
*/
public static function get_selectors_primary_color_border() {
/**
* Filter the list of CSS selectors for elements where the primary color is used as the border
*
* @since 4.10.0
*
* @param string[] $selectors A list of CSS selectors.
*/
return apply_filters(
'llms_theme_support_get_selectors_primary_color_background',
array(
// Notifications.
'.llms-notification',
// Featured access plan.
'.llms-access-plan.featured .llms-access-plan-content',
'.llms-access-plan.featured .llms-access-plan-footer',
// Checkout.
'.llms-checkout-section',
'.llms-checkout-wrapper form.llms-login',
// Notices.
'.llms-notice:not(.llms-debug)',
// Instructor.
'.llms-instructor-info .llms-instructors .llms-author',
'.llms-instructor-info .llms-instructors .llms-author .avatar',
)
);
}
/**
* Retrieve a list of CSS selectors for elements where the primary color is used as the text color
*
* The primary color is a bright blue (#2295ff).
*
* @since 4.10.0
*
* @return string[] A list of CSS selectors.
*/
public static function get_selectors_primary_color_text() {
/**
* Filter the list of CSS selectors for elements where the primary color is used as the text color
*
* @since 4.10.0
*
* @param string[] $selectors A list of CSS selectors.
*/
return apply_filters(
'llms_theme_support_get_selectors_primary_color_background',
array(
// Pricing Tables.
'.llms-access-plan-restrictions a',
'.llms-access-plan-restrictions a:hover',
// Loop.
'.llms-loop-item-content .llms-loop-title:hover',
// Donuts.
'.llms-donut',
// Checks on Syllabus.
'.llms-lesson-preview.is-free .llms-lesson-complete',
'.llms-lesson-preview.is-complete .llms-lesson-complete',
)
);
}
/**
* Conditionally require additional theme support classes.
*
* @since 3.37.0
* @since 4.3.0 Method access changed to `public`.
* @since 5.8.0 Added twenty-twenty-two compatibility.
*
* @return void
*/
public function includes() {
switch ( get_template() ) {
case 'twentynineteen':
require_once 'class-llms-twenty-nineteen.php';
break;
case 'twentytwenty':
require_once 'class-llms-twenty-twenty.php';
break;
case 'twentytwentyone':
require_once 'class-llms-twenty-twenty-one.php';
break;
case 'twentytwentytwo':
require_once 'class-llms-twenty-twenty-two.php';
break;
}
}
}
return new LLMS_Theme_Support();
================================================
FILE: includes/theme-support/class-llms-twenty-nineteen.php
================================================
<?php
/**
* Theme Support: Twenty Nineteen
*
* @package LifterLMS/ThemeSupport/Classes
*
* @since 3.31.0
* @version 3.31.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Twenty Nineteen Theme Support
*
* @since 3.31.0
*/
class LLMS_Twenty_Nineteen {
/**
* Static Constructor.
*
* @since 3.31.0
*
* @return void
*/
public static function init() {
// This theme doesn't have a sidebar.
remove_action( 'lifterlms_sidebar', 'lifterlms_get_sidebar', 10 );
// Handle content wrappers.
remove_action( 'lifterlms_before_main_content', 'lifterlms_output_content_wrapper', 10 );
remove_action( 'lifterlms_after_main_content', 'lifterlms_output_content_wrapper_end', 10 );
add_action( 'lifterlms_before_main_content', array( __CLASS__, 'output_content_wrapper' ), 10 );
add_action( 'lifterlms_after_main_content', array( __CLASS__, 'output_content_wrapper_end' ), 10 );
}
/**
* Output Twentynineteen theme wrapper openers
*
* @since 3.31.0
*
* @return void
*/
public static function output_content_wrapper() {
echo '<section id="primary" class="content-area"><main id="main" class="site-main"><div class="entry"><div class="entry-content">';
}
/**
* Output Twentynineteen theme wrapper closers
*
* @since 3.31.0
*
* @return void
*/
public static function output_content_wrapper_end() {
echo '</div></div></main></section>';
}
}
return LLMS_Twenty_Nineteen::init();
================================================
FILE: includes/theme-support/class-llms-twenty-twenty-one.php
================================================
<?php
/**
* Theme Support: Twenty Twenty-One
*
* @package LifterLMS/ThemeSupport/Classes
*
* @since 4.10.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Twenty_Twenty_One class.
*
* @since 4.10.0
*/
class LLMS_Twenty_Twenty_One {
/**
* Static "constructor"
*
* @since 4.10.0
* @since 6.0.0 Add `handle_certificicate_title` callback.
*
* @return void
*/
public static function init() {
// This theme doesn't have a sidebar.
remove_action( 'lifterlms_sidebar', 'lifterlms_get_sidebar', 10 );
// Handle content wrappers.
remove_action( 'lifterlms_before_main_content', 'lifterlms_output_content_wrapper', 10 );
remove_action( 'lifterlms_after_main_content', 'lifterlms_output_content_wrapper_end', 10 );
add_action( 'lifterlms_before_main_content', array( __CLASS__, 'handle_page_header_wrappers' ) );
// Theme has no extra wrappers, add this class to the main list element to fix the layout.
add_filter( 'llms_get_loop_list_classes', array( __CLASS__, 'add_max_width_class' ) );
add_filter( 'llms_get_pagination_wrapper_classes', array( __CLASS__, 'add_pagination_classes' ) );
// Modify catalog & checkout columns when the catalog page isn't full width.
add_filter( 'lifterlms_loop_columns', array( __CLASS__, 'modify_columns_count' ) );
add_filter( 'llms_checkout_columns', array( __CLASS__, 'modify_columns_count' ) );
add_filter( 'navigation_markup_template', array( __CLASS__, 'maybe_disable_post_navigation' ) );
// Use theme colors for various LifterLMS elements.
add_action( 'wp_enqueue_scripts', array( __CLASS__, 'add_inline_styles' ) );
add_action( 'enqueue_block_editor_assets', array( __CLASS__, 'add_inline_editor_styles' ) );
add_action( 'wp', array( __CLASS__, 'handle_certificate_title' ) );
}
/**
* Enqueue inline styles for the block editor.
*
* @since 4.10.0
*
* @return void
*/
public static function add_inline_editor_styles() {
wp_add_inline_style( 'twenty-twenty-one-custom-color-overrides', self::generate_inline_styles( 'editor' ) );
}
/**
* Enqueue inline styles on the frontend
*
* @since 4.10.0
*
* @return void
*/
public static function add_inline_styles() {
wp_add_inline_style( 'twenty-twenty-one-style', self::generate_inline_styles() );
}
/**
* Adds the 2021 theme max-width class around the catalog loop element.
*
* This adds catalog theme support.
*
* @since 4.10.0
*
* @param string[] $classes List of CSS classes.
* @return string[]
*/
public static function add_max_width_class( $classes ) {
$classes[] = 'default-max-width';
return $classes;
}
/**
* Add 2021 theme classes to the LLMS pagnation element
*
* Makes the pagination on catalogs look like the 2021 pagination on post type archives
*
* @since 4.10.0
*
* @param string[] $classes List of CSS classes.
* @return string[]
*/
public static function add_pagination_classes( $classes ) {
$classes[] = 'navigation';
$classes[] = 'pagination';
return $classes;
}
/**
* Generate inline CSS for a given context
*
* @since 4.10.0
*
* @param string|null $context Inline CSS context. Accepts "editor" to define styles loaded within the block editor or `null` for frontend styles.
* @return string
*/
protected static function generate_inline_styles( $context = null ) {
$selector_prefix = ( 'editor' === $context ) ? '.editor-styles-wrapper' : '';
$styles = array();
// Frontend only.
if ( is_null( $context ) ) {
// Fix alignment of content in an access plan.
$styles[] = '.llms-access-plan-description ul { padding-left: 0; }';
// Fix checkboxes.
$styles[] = '.llms-form-field.type-checkbox input { width: 25px; display: inline-block; }';
// Hide header/footer on certificate pages.
$styles[] = '.single-llms_certificate .site-header, .single-llms_my_certificate .site-header, .single-llms_certificate .widget-area, .single-llms_my_certificate .widget-area { display: none; }';
// Question layout.
$styles[] = '.llms-question-wrapper ol.llms-question-choices li.llms-choice .llms-choice-text { width: calc( 100% - 110px); }';
// Payment gateway stylized radio buttons.
$styles[] = LLMS_Theme_Support::get_css(
array( '.llms-form-field.type-radio input[type=radio]:checked+label:before' ),
array(
'background-image' => '-webkit-radial-gradient(center,ellipse,var( --global--color-secondary ) 0,var( --global--color-secondary ) 40%,#fafafa 45%)',
'background-image' => 'radial-gradient(ellipse at center,var( --global--color-secondary ) 0,var( --global--color-secondary ) 40%,#fafafa 45%)',
)
);
// Darkmode fix.
$styles[] = LLMS_Theme_Support::get_css(
array( '.is-dark-theme .llms-form-field.type-radio input[type=radio]:checked+label:before' ),
array(
'background-image' => array(
'-webkit-radial-gradient(center,ellipse,var( --global--color-background ) 0,var( --global--color-background ) 40%,#fafafa 45%)',
'radial-gradient(ellipse at center,var( --global--color-background ) 0,var( --global--color-background ) 40%,#fafafa 45%)',
),
)
);
// Donuts.
$styles[] = '.llms-donut svg path { stroke: var( --global--color-secondary ); }';
$styles[] = '.is-dark-theme .llms-donut svg path { stroke: var( --global--color-background ); opacity: 0.5; }';
$styles[] = '.is-dark-theme .llms-donut { color: var( --global--color-background ); }';
}
// Editor only.
if ( 'editor' === $context ) {
// Elements with a light background that become unreadable in darkmode in the block editor.
$styles[] = LLMS_Theme_Support::get_css(
array(
'.llms-lesson-link .llms-lesson-title',
'.llms-lesson-link .llms-main > *',
),
array(
'color' => 'var( --global--color-background )',
),
'.is-dark-theme ' . $selector_prefix
);
}
$styles[] = '.llms-quiz-ui { background: transparent; }';
// Fix anchor buttons.
$styles[] = 'a.llms-button-action, a.llms-button-danger, a.llms-button-primary, a.llms-button-secondary { display: inline-block; }';
// Elements with a light background that become unreadable in darkmode.
$styles[] = LLMS_Theme_Support::get_css(
array(
'.is-dark-theme .llms-notification',
'.is-dark-theme .llms-table tbody tr:nth-child(odd) td',
'.is-dark-theme .llms-table tbody tr:nth-child(odd) td a',
'.is-dark-theme .llms-certificate-container',
'.is-dark-theme a.llms-certificate',
'.is-dark-theme .llms-instructor-info .llms-instructors',
'.is-dark-theme .llms-achievement-loop-item.achievement-item',
'.is-dark-theme .llms-achievement',
'.is-dark-theme .llms-loop-item-content .llms-loop-title:hover',
'.llms-notice a',
'.is-dark-theme .llms-question-wrapper ol.llms-question-choices li.llms-choice .llms-marker',
'.is-dark-theme .llms-table tbody tr:nth-child(odd) td',
'.is-dark-theme .llms-table tbody tr:nth-child(odd) th',
'.is-dark-theme .llms-lesson-preview.is-complete .llms-lesson-complete',
),
array(
'color' => 'var( --global--color-background )',
),
$selector_prefix
);
$styles[] = LLMS_Theme_Support::get_css(
array(
'.llms-checkout',
'.llms-access-plan .llms-access-plan-footer',
'.llms-access-plan .llms-access-plan-content',
'.is-dark-theme .llms-progress .progress-bar-complete',
),
array(
'background-color' => 'var( --global--color-background )',
),
$selector_prefix
);
// Add background color and color to qualifying elements.
$styles[] = LLMS_Theme_Support::get_css(
LLMS_Theme_Support::get_selectors_primary_color_background(),
array(
'color' => 'var( --global--color-background )',
'background-color' => 'var( --global--color-secondary )',
),
$selector_prefix
);
// Add border color to qualifying elements.
$styles[] = LLMS_Theme_Support::get_css(
LLMS_Theme_Support::get_selectors_primary_color_border(),
array(
'border-color' => 'var( --global--color-secondary )',
),
$selector_prefix
);
// Add color to qualifying elements.
$styles[] = LLMS_Theme_Support::get_css(
LLMS_Theme_Support::get_selectors_primary_color_text(),
array(
'color' => 'var( --global--color-secondary )',
),
$selector_prefix
);
// Fix progress bars.
$styles[] = '.llms-progress { color: var( --global--color-background ); }';
$styles[] = '.is-dark-theme .llms-progress .progress-bar-complete { opacity: 0.5; }';
return implode( "\r", $styles );
}
/**
* Don't show the default "Untitled" post title for certificates without a title.
*
* Designers may opt to exclude the certificate title for aesthetic reasons, in this scenario
* we should simply *not display* a title.
*
* @since 6.0.0
*
* @return void
*/
public static function handle_certificate_title() {
if ( in_array( get_post_type(), array( 'llms_certificate', 'llms_my_certificate' ), true ) ) {
remove_filter( 'the_title', 'twenty_twenty_one_post_title' );
}
}
/**
* Handle wrapping the catalog page header in 2021 theme elements.
*
* This method determines if the catalog title are to be displayed and adds additional actions
* which will wrap the elements in 2021 theme elements depending on what is meant to be displayed.
*
* @since 4.10.0
*
* @return void
*/
public static function handle_page_header_wrappers() {
/** This filter is documented in templates/loop.php */
$show_title = apply_filters( 'lifterlms_show_page_title', true );
if ( $show_title ) {
add_action( 'lifterlms_before_main_content', array( __CLASS__, 'page_header_wrap' ), 11 );
add_action( 'lifterlms_archive_description', array( __CLASS__, 'page_header_wrap_end' ), 99999999 );
}
if ( $show_title && ! empty( lifterlms_get_archive_description() ) ) {
add_action( 'lifterlms_archive_description', array( __CLASS__, 'output_archive_description_wrapper' ), -1 );
add_action( 'lifterlms_archive_description', array( __CLASS__, 'output_archive_description_wrapper_end' ), 99999998 );
}
}
/**
* Modify the number of catalog & checkout columns.
*
* @since 4.10.0
*
* @param int $cols Number of columns.
* @return int
*/
public static function modify_columns_count( $cols ) {
return 1;
}
/**
* Disable 2021 theme post navigation on LifterLMS post types
*
* @since 4.10.0
*
* @param string $html Post navigation HTML.
* @return string
*/
public static function maybe_disable_post_navigation( $html ) {
if ( in_array( get_post_type(), array( 'course', 'llms_membership', 'lesson', 'llms_quiz', 'llms_assignment', 'llms_group' ), true ) ) {
return '';
}
return $html;
}
/**
* Output the catalog archive description 2021 theme wrapper opener
*
* @since 4.10.0
*
* @return void
*/
public static function output_archive_description_wrapper() {
echo '<div class="archive-description">';
}
/**
* Output the catalog archive description 2021 theme wrapper closer
*
* @since 4.10.0
*
* @return void
*/
public static function output_archive_description_wrapper_end() {
echo '</div><!-- .archive-description -->';
}
/**
* Output the catalog page header 2021 theme wrapper opener
*
* @since 4.10.0
*
* @return void
*/
public static function page_header_wrap() {
echo '<header class="page-header alignwide">';
}
/**
* Output the catalog page header 2021 theme wrapper closer
*
* @since 4.10.0
*
* @return void
*/
public static function page_header_wrap_end() {
echo '</header><!-- .page-header -->';
}
}
return LLMS_Twenty_Twenty_One::init();
================================================
FILE: includes/theme-support/class-llms-twenty-twenty-two.php
================================================
<?php
/**
* LLMS_Twenty_Twenty_Two class file
*
* @package LifterLMS/ThemeSupport/Classes
*
* @since 5.8.0
* @version 6.8.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Theme Support: Twenty Twenty-Two.
*
* @since 5.8.0
*/
class LLMS_Twenty_Twenty_Two {
/**
* Static "constructor".
*
* @since 5.8.0
*
* @return void
*/
public static function init() {
// This theme doesn't have a sidebar.
remove_action( 'lifterlms_sidebar', 'lifterlms_get_sidebar', 10 );
// Handle content wrappers.
remove_action( 'lifterlms_before_main_content', 'lifterlms_output_content_wrapper', 10 );
remove_action( 'lifterlms_after_main_content', 'lifterlms_output_content_wrapper_end', 10 );
add_action( 'lifterlms_before_main_content', array( __CLASS__, 'handle_page_header_wrappers' ) );
// Modify catalog & checkout columns when the catalog page isn't full width.
add_filter( 'lifterlms_loop_columns', array( __CLASS__, 'modify_columns_count' ) );
add_filter( 'llms_checkout_columns', array( __CLASS__, 'modify_columns_count' ) );
// Use theme colors for various LifterLMS elements.
add_action( 'wp_enqueue_scripts', array( __CLASS__, 'add_inline_styles' ) );
add_action( 'enqueue_block_editor_assets', array( __CLASS__, 'add_inline_editor_styles' ) );
}
/**
* Enqueue inline styles for the block editor.
*
* @since 5.8.0
*
* @return void
*/
public static function add_inline_editor_styles() {
wp_add_inline_style( 'llms-blocks-editor', self::generate_inline_styles( 'editor' ) );
}
/**
* Enqueue inline styles on the frontend.
*
* @since 5.8.0
*
* @return void
*/
public static function add_inline_styles() {
wp_add_inline_style( 'twentytwentytwo-style', self::generate_inline_styles() );
}
/**
* Generate inline CSS for a given context.
*
* @since 5.8.0
* @since 5.9.0 Fixed stretched images in questions with pictures, and images in quiz/questions description.
* @since 6.8.0 Fixed label/text alignment by removing text’s margin top. Also, removed now outdated width rule.
*
* @param string|null $context Inline CSS context. Accepts "editor" to define styles loaded within the block editor or `null` for frontend styles.
* @return string
*/
protected static function generate_inline_styles( $context = null ) {
$selector_prefix = ( 'editor' === $context ) ? '.editor-styles-wrapper' : '';
$styles = array();
// Frontend only.
if ( is_null( $context ) ) {
// Fix alignment of content in an access plan, and navigation.
$styles[] = '.llms-access-plan-description ul, .llms-pagination ul { padding-left: 0; }';
// Fix form input padding.
$styles[] = '.llms-form-field input, .llms-form-field textarea, .llms-form-field select { padding: 6px 10px }';
// Question layout.
$styles[] = '.llms-question-wrapper ol.llms-question-choices li.llms-choice .llms-choice-text { margin-top: 0; }';
// Payment gateway stylized radio buttons.
$styles[] = LLMS_Theme_Support::get_css(
array( '.llms-form-field.type-radio:not(.is-group) input[type=radio]:checked+label:before' ),
array(
'background-image' => '-webkit-radial-gradient(center,ellipse,var(--wp--preset--color--primary) 0,var(--wp--preset--color--primary) 40%,#fafafa 45%)',
'background-image' => 'radial-gradient(ellipse at center,var(--wp--preset--color--primary) 0,var(--wp--preset--color--primary) 40%,#fafafa 45%)',
)
);
// Completed lesson check.
$styles[] = LLMS_Theme_Support::get_css(
array(
'.llms-lesson-preview.is-free .llms-lesson-complete',
'.llms-lesson-preview.is-complete .llms-lesson-complete',
),
array(
'color' => 'var(--wp--preset--color--primary)',
)
);
}
// Editor only.
if ( 'editor' === $context ) {
// Elements with a light background that become unreadable in darkmode in the block editor.
$styles[] = LLMS_Theme_Support::get_css(
array(
'.wp-block-llms-course-progress .progress-bar .progress--fill',
'.wp-block[data-type="llms/course-continue-button"] button',
'.wp-block[data-type="llms/lesson-progression"] button',
),
array(
'background-color' => 'var(--wp--preset--color--primary)',
'color' => 'var(--wp--preset--color--background)',
),
$selector_prefix
);
}
// Fix lesson preview titles.
$styles[] = '.llms-lesson-preview h6 { margin: 0 0 10px; }';
// Primary background color.
$styles[] = LLMS_Theme_Support::get_css(
LLMS_Theme_Support::get_selectors_primary_color_background(),
array(
'background-color' => 'var(--wp--preset--color--primary)',
'color' => 'var(--wp--preset--color--background)',
)
);
// Add border color to qualifying elements.
$styles[] = LLMS_Theme_Support::get_css(
LLMS_Theme_Support::get_selectors_primary_color_border(),
array(
'border-color' => 'var(--wp--preset--color--primary)',
)
);
// Quiz.
$styles[] = '.llms-quiz-ui { background: transparent; }';
// Fix questions with pictures, and images in quiz/questions description.
$styles[] = '.llms-quiz-wrapper img, .llms-quiz-question-wrapper img { max-width: 100%; height: auto; }';
// Fix anchor buttons.
$styles[] = 'a.llms-button-action, a.llms-button-danger, a.llms-button-primary, a.llms-button-secondary { display: inline-block; }';
return implode( "\r", $styles );
}
/**
* Handle wrapping the catalog page header in 2022 theme elements.
*
* This method determines if the catalog title are to be displayed and adds additional actions
* which will wrap the elements in 2022 theme elements depending on what is meant to be displayed.
*
* @since 5.8.0
*
* @return void
*/
public static function handle_page_header_wrappers() {
/** This filter is documented in templates/loop.php */
$show_title = apply_filters( 'lifterlms_show_page_title', true );
if ( $show_title ) {
add_action( 'lifterlms_before_main_content', array( __CLASS__, 'page_header_wrap' ), 11 );
add_action( 'lifterlms_archive_description', array( __CLASS__, 'page_header_wrap_end' ), 99999999 );
}
if ( $show_title && ! empty( lifterlms_get_archive_description() ) ) {
add_action( 'lifterlms_archive_description', array( __CLASS__, 'output_archive_description_wrapper' ), -1 );
add_action( 'lifterlms_archive_description', array( __CLASS__, 'output_archive_description_wrapper_end' ), 99999998 );
}
}
/**
* Modify the number of catalog & checkout columns.
*
* @since 5.8.0
*
* @param int $cols Number of columns.
* @return int
*/
public static function modify_columns_count( $cols ) {
return 1;
}
/**
* Output the catalog archive description 2022 theme wrapper opener.
*
* @since 5.8.0
*
* @return void
*/
public static function output_archive_description_wrapper() {
echo '<div class="archive-description">';
}
/**
* Output the catalog archive description 2022 theme wrapper closer.
*
* @since 5.8.0
*
* @return void
*/
public static function output_archive_description_wrapper_end() {
echo '</div><!-- .archive-description -->';
}
/**
* Output the catalog page header 2022 theme wrapper opener.
*
* @since 5.8.0
*
* @return void
*/
public static function page_header_wrap() {
echo '<header class="page-header alignwide">';
}
/**
* Output the catalog page header 2022 theme wrapper closer.
*
* @since 5.8.0
*
* @return void
*/
public static function page_header_wrap_end() {
echo '</header><!-- .page-header -->';
}
}
return LLMS_Twenty_Twenty_Two::init();
================================================
FILE: includes/theme-support/class-llms-twenty-twenty.php
================================================
<?php
/**
* Theme Support: Twenty Twenty
*
* @package LifterLMS/ThemeSupport/Classes
*
* @since 3.37.0
* @version 4.10.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Twenty_Twenty class..
*
* @since 3.37.0
* @since 3.37.1 Fixed course information block misalignment.
* @since 3.37.2 Updated to use `background-color` property instead of `background` shorthand
* when adding custom elements to style.
* @since 3.37.3 Hide site header and footer, and set a white body background in
* single certificates.
*/
class LLMS_Twenty_Twenty {
/**
* Constructor.
*
* @since 3.37.0
*
* @return void
*/
public static function init() {
// This theme doesn't have a sidebar.
remove_action( 'lifterlms_sidebar', 'lifterlms_get_sidebar', 10 );
// Handle content wrappers.
remove_action( 'lifterlms_before_main_content', 'lifterlms_output_content_wrapper', 10 );
remove_action( 'lifterlms_after_main_content', 'lifterlms_output_content_wrapper_end', 10 );
add_action( 'lifterlms_before_main_content', array( __CLASS__, 'output_content_wrapper' ), 10 );
add_action( 'lifterlms_after_main_content', array( __CLASS__, 'output_content_wrapper_end' ), 10 );
// Add the proper Twenty Twenty Body class on the catalogs.
add_filter( 'body_class', array( __CLASS__, 'body_classes' ) );
// Modify catalog & checkout columns when the catalog page isn't full width.
add_filter( 'lifterlms_loop_columns', array( __CLASS__, 'modify_columns_count' ) );
add_filter( 'llms_checkout_columns', array( __CLASS__, 'modify_columns_count' ) );
// Prevent meta output for LifterLMS custom Post Types.
add_filter( 'twentytwenty_disallowed_post_types_for_meta_output', array( __CLASS__, 'hide_meta_output' ) );
add_filter( 'twentytwenty_get_elements_array', array( __CLASS__, 'add_elements' ) );
add_action( 'wp_head', array( __CLASS__, 'add_inline_styles' ), 100 );
}
/**
* Generate inline CSS using colors from the TwenyTwenty Theme settings.
*
* @since 3.37.0
* @since 3.37.1 Fixed course information block misalignment.
* @since 3.37.3 Hide site header and footer, and set a white body background in single certificates.
*
* @return void
*/
public static function add_inline_styles() {
global $post_type;
$accent = twentytwenty_get_color_for_area( 'content', 'accent' );
?>
<style id="llms-twentytweny-style">
.llms-access-plan.featured .llms-access-plan-content,
.llms-access-plan.featured .llms-access-plan-footer {
border-left-color: <?php echo sanitize_hex_color( $accent ); ?>;
border-right-color: <?php echo sanitize_hex_color( $accent ); ?>;
}
.llms-access-plan.featured .llms-access-plan-footer {
border-bottom-color: <?php echo sanitize_hex_color( $accent ); ?>;
}
.llms-form-field.type-radio input[type=radio]:checked+label:before {
background-image: -webkit-radial-gradient(center,ellipse,<?php echo sanitize_hex_color( $accent ); ?> 0,<?php echo sanitize_hex_color( $accent ); ?> 40%,#fafafa 45%);
background-image: radial-gradient(ellipse at center,<?php echo sanitize_hex_color( $accent ); ?> 0,<?php echo sanitize_hex_color( $accent ); ?> 40%,#fafafa 45%);
}
.llms-checkout-section,
.llms-lesson-preview section.llms-main {
padding-bottom: 0;
padding-top: 0;
}
.llms-lesson-link .llms-pre-text,
.llms-access-plan .llms-access-plan-title {
margin-top: 0;
}
.llms-donut svg path {
stroke: <?php echo sanitize_hex_color( $accent ); ?>;
}
.llms-notification,
.llms-instructor-info .llms-instructors .llms-author {
border-top-color: <?php echo sanitize_hex_color( $accent ); ?>;
}
.llms-pagination ul li:first-of-type,
.llms-pagination ul {
margin-left: 0;
margin-right: 0;
}
.course .llms-meta-info {
margin-left: auto;
margin-right: auto;
}
<?php if ( 'llms_my_certificate' === $post_type || 'llms_certificate' === $post_type ) : ?>
body {
background-color: #fff;
background-image: none;
}
#site-header,
#site-footer {
display: none;
}
<?php endif; ?>
</style>
<?php
}
/**
* Add LifterLMS Elments to the array of Twenty Twenty elements.
*
* This is used to automatically generate inline CSS via the Twenty Twenty Theme.
*
* @since 3.37.0
* @since 3.37.2 Updated to use `background-color` property instead of `background` shorthand.
*
* @param array $elements Multidimensional array of CSS selectors.
* @return array
*/
public static function add_elements( $elements ) {
// Accent Background.
$elements['content']['accent']['background-color'] = array_merge(
$elements['content']['accent']['background-color'],
self::add_elements_content_accent_background()
);
// Accent Border Color.
$elements['content']['accent']['border-color'] = array_merge(
$elements['content']['accent']['border-color'],
self::add_elements_content_accent_border()
);
// Accent Color.
$elements['content']['accent']['color'] = array_merge(
$elements['content']['accent']['color'],
self::add_elements_content_accent_color()
);
// Background Text Color.
$elements['content']['background']['color'] = array_merge(
$elements['content']['background']['color'],
self::add_elements_content_background_color()
);
// Background Background Color.
$elements['content']['background']['background-color'] = array_merge(
$elements['content']['background']['background-color'],
array( '.llms-checkout' )
);
// Text Color.
$elements['content']['text']['color'] = array_merge(
$elements['content']['text']['color'],
array(
'.llms-notice.llms-debug',
'.llms-notice.llms-debug a',
)
);
return $elements;
}
/**
* Get an array of selectors for items that have the accent color as the background.
*
* @since 3.37.0
* @since 4.10.0 Use LLMS_Theme_Support utility classes.
*
* @return string[]
*/
protected static function add_elements_content_accent_background() {
return LLMS_Theme_Support::get_selectors_primary_color_background();
}
/**
* Get an array of selectors for items that have the accent color as the border.
*
* @since 3.37.0
* @since 4.10.0 Use LLMS_Theme_Support utility classes.
*
* @return string[]
*/
protected static function add_elements_content_accent_border() {
return LLMS_Theme_Support::get_selectors_primary_color_border();
}
/**
* Get an array of selectors for items that have the accent color as the text color.
*
* @since 3.37.0
* @since 4.10.0 Use LLMS_Theme_Support utility classes.
*
* @return string[]
*/
protected static function add_elements_content_accent_color() {
return LLMS_Theme_Support::get_selectors_primary_color_text();
}
/**
* Get an array of selectors for items that have the background color as the text color.
*
* @since 3.37.0
*
* @return string[]
*/
protected static function add_elements_content_background_color() {
return array(
// Buttons.
'.llms-button-primary',
'.llms-button-primary:hover',
'.llms-button-primary.clicked',
'.llms-button-primary:focus',
'.llms-button-primary:active',
'.llms-button-action',
'.llms-button-action:hover',
'.llms-button-action.clicked',
'.llms-button-action:focus',
'.llms-button-action:active',
// Pricing Tables.
'.llms-access-plan-title',
'.llms-access-plan .stamp',
'.llms-access-plan.featured .llms-access-plan-featured',
// Checkout.
'.llms-checkout-wrapper .llms-form-heading',
// Notices.
'.llms-notice',
'.llms-notice a',
// My Grades.
'.llms-sd-widgets .llms-sd-widget .llms-sd-widget-title',
);
}
/**
* Add Twenty Twenty's full-width template body class on catalogs where the page is set to use the Full Width template.
*
* @since 3.37.0
*
* @param string[] $classes Array of body classes.
* @return string[]
*/
public static function body_classes( $classes ) {
$page_id = self::get_archive_page_id();
if ( $page_id && self::is_page_full_width( $page_id ) ) {
$classes[] = 'template-full-width';
}
return $classes;
}
/**
* Retrieve the page ID of a a catalog page.
*
* @since 3.37.0
*
* @return int|false
*/
protected static function get_archive_page_id() {
$page_id = false;
if ( is_courses() ) {
$page_id = llms_get_page_id( 'courses' );
} elseif ( is_memberships() ) {
$page_id = llms_get_page_id( 'memberships' );
}
return $page_id;
}
/**
* Get the twenty twenty theme's "width" class for use in wrapper elements.
*
* If the "Full Width" template is utilized, there's no class, otherwise the class `thin` is used.
*
* @since 3.37.0
*
* @return string
*/
protected static function get_page_template_class() {
$template_class = 'thin';
$page_id = self::get_archive_page_id();
if ( $page_id ) {
$template_class = self::is_page_full_width( $page_id ) ? '' : 'thin';
} else {
$template_class = is_page_template( 'templates/template-full-width.php' ) ? '' : 'thin';
}
return $template_class;
}
/**
* Prevent theme meta information from being output on LifterLMS Custom Post Types.
*
* @since 3.37.0
*
* @param string[] $post_types Array of post type names.
* @return string[]
*/
public static function hide_meta_output( $post_types ) {
return array_merge( $post_types, array( 'course', 'llms_membership', 'lesson', 'llms_quiz' ) );
}
/**
* Determine if the given page is utilizing the twenty twenty full-width page template.
*
* @since 3.37.0
*
* @param int $page_id WP_Post ID of the catalog page.
* @return bool
*/
protected static function is_page_full_width( $page_id ) {
return 'templates/template-full-width.php' === get_page_template_slug( $page_id );
}
/**
* Modify the number of catalog & checkout columns.
*
* If the default template is used, drop to a single column.
*
* @since 3.37.0
*
* @param int $cols Number of columns.
* @return int
*/
public static function modify_columns_count( $cols ) {
if ( 'thin' === self::get_page_template_class() ) {
return 1;
}
return $cols;
}
/**
* Output the opening wrapper for the content description element in the theme's header.
*
* @since 3.37.0
*
* @return void
*/
public static function output_archive_description_wrapper() {
echo '<div class="archive-subtitle section-inner thin max-percentage intro-text">';
}
/**
* Output the closing wrapper for the content description element in the theme's header.
*
* @since 3.37.0
*
* @return void
*/
public static function output_archive_description_wrapper_end() {
echo '</div><!-- .archive-subtitle -->';
}
/**
* Output Twenty Twenty theme wrapper openers
*
* @since 3.37.0
*
* @return void
*/
public static function output_content_wrapper() {
$show_title = apply_filters( 'lifterlms_show_page_title', true );
$has_desc = has_action( 'lifterlms_archive_description' );
if ( $has_desc ) {
add_action( 'lifterlms_archive_description', array( __CLASS__, 'output_archive_description_wrapper' ), -1 );
add_action( 'lifterlms_archive_description', array( __CLASS__, 'output_archive_description_wrapper_end' ), 99999999 );
}
if ( $show_title ) {
add_filter( 'lifterlms_show_page_title', '__return_false' );
}
?>
<main id="site-content" role="main">
<?php if ( $show_title || $has_desc ) : ?>
<header class="archive-header has-text-align-center header-footer-group">
<div class="archive-header-inner section-inner medium">
<?php if ( $show_title ) : ?>
<h1 class="archive-title"><?php lifterlms_page_title(); ?></h1>
<?php endif; ?>
<?php endif; ?>
<?php
// If there's no description, output the end wrapper now.
if ( $show_title && ! $has_desc ) {
self::output_content_wrapper_part_two();
} else {
// Otherwise output the wrapper after the end wrapper for the description wrapper div.
add_action( 'lifterlms_archive_description', array( __CLASS__, 'output_content_wrapper_part_two' ), 99999999 );
}
}
/**
* Outputs header closing wrappers and inner element opening wrappers for the theme wrappers.
*
* @since 3.37.0
*
* @return void
*/
public static function output_content_wrapper_part_two() {
?>
</div><!-- .archive-header-inner -->
</header><!-- .archive-header -->
<article <?php post_class(); ?> id="post-<?php the_ID(); ?>">
<div class="post-inner section-inner <?php echo esc_attr( self::get_page_template_class() ); ?> ">
<div class="entry-content">
<?php
}
/**
* Output Twenty Twenty theme wrapper closers
*
* @since 3.37.0
*
* @return void
*/
public static function output_content_wrapper_end() {
?>
</div><!-- .entry-content -->
</div><!-- .post-inner -->
</article><!-- .post -->
</main><!-- #site-content -->
<?php
}
}
return LLMS_Twenty_Twenty::init();
================================================
FILE: includes/theme-support/index.php
================================================
<?php // silence.
================================================
FILE: includes/traits/llms-trait-audio-video-embed.php
================================================
<?php
/**
* LifterLMS audio video embed trait
*
* @package LifterLMS/Traits
*
* @since 5.3.0
* @version 5.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS audio video embed trait.
*
* **Classes that use this trait must call {@see LLMS_Trait_Audio_Video_Embed::construct_audio_video_embed()}
* in their constructor.**
*
* @since 5.3.0
*
* @property string $audio_embed URL to an oEmbed enable audio URL.
* @property string $video_embed URL to an oEmbed enable video URL.
*/
trait LLMS_Trait_Audio_Video_Embed {
/**
* @inheritdoc
*/
abstract protected function add_properties( $props = array() );
/**
* Setup properties used by this trait.
*
* **Must be called by the constructor of the class that uses this trait.**
*
* @since 5.3.0
*/
protected function construct_audio_video_embed() {
$this->add_properties(
array(
'audio_embed' => 'url',
'video_embed' => 'url',
)
);
}
/**
* @inheritdoc
*/
abstract public function get( $key, $raw = false );
/**
* Attempt to get oEmbed for an audio provider.
*
* Falls back to the [audio] shortcode if the oEmbed fails.
*
* @since 1.0.0
* @since 3.17.0 Unknown.
* @since 5.3.0 Refactored from `LLMS_Course` and `LLMS_Lesson`.
*
* @return string
*/
public function get_audio() {
return $this->get_embed( 'audio' );
}
/**
* @inheritdoc
*/
abstract protected function get_embed( $type = 'video', $prop = '' );
/**
* Attempt to get oEmbed for a video provider.
*
* Falls back to the [video] shortcode if the oEmbed fails.
*
* @since 1.0.0
* @since 3.17.0 Unknown.
* @since 5.3.0 Refactored from `LLMS_Course` and `LLMS_Lesson`.
*
* @return string
*/
public function get_video() {
return $this->get_embed( 'video' );
}
}
================================================
FILE: includes/traits/llms-trait-award-default-images.php
================================================
<?php
/**
* LLMS_Trait_Award_Default_Images
*
* @package LifterLMS/Traits
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Default image getters for LifterLMS awards.
*
* Classes that utilize this trait should declare a protected class property `$award_type`, which
* is used to define the award's type ID. Core supported types are 'achievement' and 'certificate'.
*
* @since 6.0.0
*/
trait LLMS_Trait_Award_Default_Images {
/**
* Retrieve the default image source for the given engagement type.
*
* The method name is not a typo. This retrieves the default image used when the default image
* option is not set or doesn't exist. Thus, it retrieves the default default. Thumbs up.
*
* This method retrieves the image stored in the plugin's assets directory. The images
* were updated with the release of this method and allows usage of the previous version's
* images via the filter {@see llms_use_legacy_engagement_images}.
*
* The legacy default image URL is returned if the current certificate version is 1 and the
* 'llms_has_achievements_with_legacy_default_image' option is 'yes' or the type is achievement and the
* 'llms_has_certificates_with_legacy_default_image' option is 'yes. These options are set when LifterLMS is updated
* to 6.0.0 and there are legacy user engagements ({@see \LLMS\Updates\Version_6_0_0\_add_legacy_opt()}).
*
* @since 6.0.0
*
* @return string The URL to the default image.
*/
protected function get_default_default_image_src() {
$img = "default-{$this->award_type}.png";
$use_legacy = false;
switch ( $this->award_type ) {
case 'achievement':
$use_legacy = llms_parse_bool( get_option( 'llms_has_achievements_with_legacy_default_image', 'no' ) );
break;
case 'certificate':
$certificate = llms_get_certificate( null, true );
if ( $certificate && 1 === $certificate->get_template_version() ) {
$use_legacy = llms_parse_bool( get_option( 'llms_has_certificates_with_legacy_default_image', 'no' ) );
}
break;
}
/**
* Filter whether or not the legacy default images should be used for achievement and certificates.
*
* @since 6.0.0
*
* @example add_filter( 'llms_use_legacy_award_images', '__return_true' );
*
* @param boolean $use_legacy If `true`, the legacy image will be used.
* @param string $award_type The type of award, either "achievement" or "certificate".
*/
if ( apply_filters( 'llms_use_legacy_award_images', $use_legacy, $this->award_type ) ) {
$img = "optional_{$this->award_type}.png";
}
return llms()->plugin_url() . '/assets/images/' . $img;
}
/**
* Retrieve the default image for a given object.
*
* @since 6.0.0
*
* @param int $object_id WP_Post ID of the earned achievement. This is passed so that anyone filtering the default image could
* provide a different default image based on the achievement.
* @return string The full image source url.
*/
public function get_default_image( $object_id ) {
$src = '';
// Retrieve the stored value from the database.
$id = $this->get_default_image_id();
if ( $id ) {
$src = wp_get_attachment_url( $id );
}
// Use the attachment stored for the option in the DB and fallback to the default image from the plugin's assets dir.
$src = $src ? $src : $this->get_default_default_image_src();
/**
* Filters the default image source for an award.
*
* The dynamic portion of this hook, {$this->award_type}, refers to the award type, either "achievement" or "certificate".
*
* @since 2.2.0
* @since 6.0.0 Merged achievement and certificate filters into a single dynamic filter.
*
* @param string $src The full image source url.
* @param int $object_id The WP_Post ID of the award.
*/
return apply_filters(
"lifterlms_{$this->award_type}_image_placeholder_src",
$src,
$object_id
);
}
/**
* Retrieve attachment ID of the default achievement image.
*
* If the attachment post doesn't exist will return false. This would happen
* if the post is deleted from the media library.
*
* @since 6.0.0
*
* @return int Returns the WP_Post ID of the attachment or `0` if not set.
*/
public function get_default_image_id() {
$id = get_option( "lifterlms_{$this->award_type}_default_img", 0 );
return $id && get_post( $id ) ? absint( $id ) : 0;
}
}
================================================
FILE: includes/traits/llms-trait-award-templates-post-list-table.php
================================================
<?php
/**
* LifterLMS Certificate/Achievement Templates Post List Table trait
*
* @package LifterLMS/Traits
*
* @since 6.0.0
* @version 6.4.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Certificate/Achievement Templates Post List Table trait.
*
* @since 6.0.0
*/
trait LLMS_Trait_Award_Templates_Post_List_Table {
/**
* Add post row actions filter callback.
*
* @since 6.0.0
* @since 6.4.0 Stop using deprecated `FILTER_SANITIZE_STRING`.
*
* @return void
*/
protected function award_template_row_actions() {
if ( "llms_{$this->engagement_type}" === llms_filter_input( INPUT_GET, 'post_type' ) ) {
add_filter( 'post_row_actions', array( $this, 'add_post_actions' ), 20, 2 );
}
}
/**
* Add post row actions.
*
* @since 6.0.0
*
* @param array $actions Array of post row actions.
* @param WP_Post $post Post object for the row.
* @return array
*/
public function add_post_actions( $actions, $post ) {
if ( ! $post || "llms_{$this->engagement_type}" !== $post->post_type ) {
return $actions;
}
$post_type_object = get_post_type_object( $post->post_type );
if ( ! $post_type_object->show_ui ) {
return $actions;
}
$award_post_type = str_replace( 'llms_', 'llms_my_', $post->post_type );
$actions['llms-awards-list'] = sprintf(
'<a href="%1$s">%2$s</a>',
add_query_arg(
array(
LLMS_Admin_Post_Table_Awards::TEMPLATE_FILTER_QUERY_VAR => $post->ID,
'post_type' => $award_post_type,
),
admin_url( 'edit.php' )
),
sprintf(
// Translators: %1$s the awarded post type name label.
__( 'View %1$s', 'lifterlms' ),
get_post_type_labels(
get_post_type_object( $award_post_type )
)->name
)
);
$sync_action = "sync_awarded_{$this->engagement_type}s";
$sync_url = add_query_arg(
array(
'action' => $sync_action,
"_llms_{$this->engagement_type}_sync_actions_nonce" => wp_create_nonce( "llms-{$this->engagement_type}-sync-actions" ),
),
get_edit_post_link( $post, 'raw' )
);
$text = sprintf(
/* translators: %1$s: the plural awarded post type name label */
__( 'Sync %1$s', 'lifterlms' ),
get_post_type_labels( get_post_type_object( $award_post_type ) )->name
);
$actions[ $sync_action ] = '<a href="' . esc_html( $sync_url ) . '">' . $text . '</a>';
return $actions;
}
}
================================================
FILE: includes/traits/llms-trait-earned-engagement-reporting-table.php
================================================
<?php
/**
* LifterLMS Eearned Engagements (Certificate/Achievement) Reporting Table trait.
*
* @package LifterLMS/Traits
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Eearned Engagements (Certificate/Achievement) Reporting Table trait.
*
* This trait should only be used by classes that extend from the {@see LLMS_Admin_Table} class.
*
* @since 6.0.0
*/
trait LLMS_Trait_Earned_Engagement_Reporting_Table {
/**
* Add award engagement button above the table.
*
* @since 6.0.0
*
* @return void
*/
public function output_table_html() {
$post_type = null;
if ( 'certificates' === $this->id ) {
$post_type = 'llms_my_certificate';
} elseif ( 'achievements' === $this->id ) {
$post_type = 'llms_my_achievement';
}
if ( empty( $post_type ) ) {
parent::output_table_html();
return;
}
$post_type_object = get_post_type_object( $post_type );
if ( ! current_user_can( $post_type_object->cap->edit_post ) ) {
parent::output_table_html();
return;
}
$student = false;
if ( ! empty( $this->student ) ) {
$student = $this->student->get_id();
} elseif ( ! empty( $_GET['student_id'] ) ) { //phpcs:ignore -- Nonce verification not needed.
$student = llms_filter_input( INPUT_GET, 'student_id', FILTER_SANITIZE_NUMBER_INT );
}
$post_new_file = "post-new.php?post_type=$post_type";
?>
<a id="llms-new-award-button" style="display:inline-block;margin-bottom:20px" href="<?php echo esc_url( add_query_arg( 'sid', $student, admin_url( $post_new_file ) ) ); ?>" class="llms-button-secondary small"><?php echo esc_html( $post_type_object->labels->add_new ); ?></a>
<?php
parent::output_table_html();
}
}
================================================
FILE: includes/traits/llms-trait-sales-page.php
================================================
<?php
/**
* LifterLMS Sales Page trait
*
* @package LifterLMS/Traits
*
* @since 5.3.0
* @version 5.3.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS Sales Page trait.
*
* **This trait should only be used by classes that extend from the {@see LLMS_Post_Model} class.**
* **Classes that use this trait must call {@see LLMS_Trait_Sales_Page::construct_sales_page()} in their constructor.**
*
* @since 5.3.0
*
* @property int $sales_page_content_page_id WP Post ID of the WP page to redirect to when $sales_page_content_type is 'page'.
* @property string $sales_page_content_type Sales page behavior [none,content,page,url].
* @property string $sales_page_content_url Redirect URL for a sales page, when $sales_page_content_type is 'url'.
*/
trait LLMS_Trait_Sales_Page {
/**
* @inheritdoc
*/
abstract protected function add_properties( $props = array() );
/**
* Setup properties used by this trait.
*
* **Must be called by the constructor of the class that uses this trait.**
*
* @since 5.3.0
*/
protected function construct_sales_page() {
$this->add_properties(
array(
'sales_page_content_page_id' => 'absint',
'sales_page_content_type' => 'string',
'sales_page_content_url' => 'string',
)
);
}
/**
* @inheritdoc
*/
abstract public function get( $key, $raw = false );
/**
* Get the URL to a WP page or custom URL when sales page redirection is enabled.
*
* **The class that uses this trait must have the {@see LLMS_Post_Model::$model_post_type} property.**
*
* @since 3.20.0
* @since 5.3.0 Check for an empty URL or ID.
* Refactored from `LLMS_Course` and `LLMS_Membership`.
*
* @return string
*/
public function get_sales_page_url() {
$type = $this->get( 'sales_page_content_type' );
switch ( $type ) {
case 'page':
$url = get_permalink( $this->get( 'sales_page_content_page_id' ) );
break;
case 'url':
$url = $this->get( 'sales_page_content_url' );
break;
default:
$url = get_permalink( $this->get( 'id' ) );
}
/**
* Filters the model's sales page URL
*
* The dynamic portion of the hook name, $this->model_post_type,
* refers to the model's post type, e.g. 'course' or 'membership'.
*
* @since Unknown
*
* @param string $url Sales page URL.
* @param LLMS_Post_Model $object The LLMS_Course or LLMS_Membership object.
* @param string $type The model's $sales_page_content_type property.
*/
$url = apply_filters( "llms_{$this->model_post_type}_get_sales_page_url", $url, $this, $type );
return $url;
}
/**
* Determine if sales page redirection is enabled.
*
* **The class that uses this trait must have the {@see LLMS_Post_Model::$model_post_type} property.**
*
* @since 5.3.0 Refactored from `LLMS_Course` and `LLMS_Membership`.
*
* @return boolean
*/
public function has_sales_page_redirect() {
$type = $this->get( 'sales_page_content_type' );
switch ( $type ) {
case 'page':
$has_redirect = (bool) $this->get( 'sales_page_content_page_id' );
break;
case 'url':
$has_redirect = (bool) $this->get( 'sales_page_content_url' );
break;
default:
$has_redirect = false;
}
/**
* Filters whether or not the model has a sales page redirect.
*
* The dynamic portion of the hook name, $this->model_post_type,
* refers to the model's post type, e.g. 'course' or 'membership'.
*
* @since Unknown
*
* @param boolean $has_redirect Whether or not the model has a sales page redirect.
* @param LLMS_Post_Model $object The LLMS_Course or LLMS_Membership object.
* @param string $type The model's $sales_page_content_type property.
*/
$has_redirect = apply_filters(
"llms_{$this->model_post_type}_has_sales_page_redirect",
$has_redirect,
$this,
$type
);
return $has_redirect;
}
}
================================================
FILE: includes/traits/llms-trait-singleton.php
================================================
<?php
/**
* LifterLMS singleton trait
*
* @package LifterLMS/Traits
*
* @since 5.3.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS singleton trait.
*
* @since 5.3.0
*/
trait LLMS_Trait_Singleton {
/**
* Singleton instance of the class.
*
* @var object
*/
private static $instance = null;
/**
* Returns a singleton instance of the class that uses this trait.
*
* @since 5.3.0
* @since 6.0.0 Removed backward compatible use of the removed `$_instance` property.
*
* @return self
*/
public static function instance() {
if ( is_null( self::$instance ) ) {
self::$instance = new self();
}
return self::$instance;
}
}
================================================
FILE: includes/traits/llms-trait-student-awards.php
================================================
<?php
/**
* LifterLMS singleton trait.
*
* @package LifterLMS/Traits
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Retrieve data related to awards earned by a student.
*
* This trait should only be used by classes that extend from the {@see LLMS_Abstract_User_Data} class.
*
* @since 6.0.0
*/
trait LLMS_Trait_Student_Awards {
/**
* Retrieve achievements that a user has earned.
*
* @since 2.4.0
* @since 3.14.0 Unknown.
* @since 6.0.0 Moved from `LLMS_Student` class.
* Introduced alternate usage via `LLMS_Awards_Query` and deprecated previous behavior.
*
* @param string|array $args_or_orderby An array of arguments to pass to LLMS_Awards_Query. The deprecated method
* signature accepts a string representing the field to order the returned results by.
* @param string $order Deprecated signature only: Ordering method for returned results (ASC or DESC).
* @param string $return Deprecated signature only: Return type. Accepts "obj" for an array of objects from
* $wpdb->get_results and "certificates" for an array of LLMS_User_Certificate instances.
* @return LLMS_Awards_Query|object[]|LLMS_User_Achievement[]
*/
public function get_achievements( $args_or_orderby = 'updated_date', $order = 'DESC', $return = 'obj' ) {
// New behavior.
if ( is_array( $args_or_orderby ) ) {
return $this->get_awards( $args_or_orderby, 'achievement' );
}
_deprecated_function( 'LLMS_Student::get_achievements()', '6.0.0', 'The behavior of this method has changed. Please refer to https://developer.lifterlms.com/reference/classes/llms_student/get_achievements/ for more information.' );
$orderby = esc_sql( $args_or_orderby );
$order = esc_sql( $order );
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$query = $wpdb->get_results(
$wpdb->prepare(
"SELECT post_id, meta_value AS achievement_id, updated_date AS earned_date FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE user_id = %d and meta_key = '_achievement_earned' ORDER BY $orderby $order",
$this->get_id()
)
);// db call ok; no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
if ( 'achievements' === $return ) {
$ret = array();
foreach ( $query as $obj ) {
$ret[] = new LLMS_User_Achievement( $obj->achievement_id );
}
return $ret;
}
return $query;
}
/**
* Query student awards.
*
* @since 6.0.0
*
* @param array $args Query arguments to pass into `LLMS_Awards_Query`.
* @param string $type Award type. Accepts "any", "achievement", or "certificate".
* @return LLMS_Awards_Query
*/
public function get_awards( $args = array(), $type = 'any' ) {
$args['type'] = $type;
$args['users'] = $this->get_id();
// Prevent potential funny business.
unset( $args['users__exclude'] );
return new LLMS_Awards_Query( $args );
}
/**
* Retrieve the total number of awards earned by the student.
*
* @since 6.0.0
*
* @param string $type Award type. Accepts "any", "achievement", or "certificate".
* @return int
*/
public function get_awards_count( $type = 'any' ) {
$query = $this->get_awards(
array(
'per_page' => 1,
'fields' => 'ids',
),
$type
);
return $query->get_found_results();
}
/**
* Retrieve certificates that the student has been awarded.
*
* The default behavior of this method is deprecated since version 6.0.0. The previous behavior
* is retained for backwards compatibility but will be removed in the next major release.
*
* @since 2.4.0
* @since 3.14.1 Unknown.
* @since 6.0.0 Moved from `LLMS_Student` class.
* Introduced alternate usage via `LLMS_Awards_Query` and deprecated previous behavior.
*
* @param string|array $args_or_orderby An array of arguments to pass to LLMS_Awards_Query. The deprecated method
* signature accepts a string representing the field to order the returned results by.
* @param string $order Deprecated signature only: Ordering method for returned results (ASC or DESC).
* @param string $return Deprecated signature only: Return type. Accepts "obj" for an array of objects from
* $wpdb->get_results and "certificates" for an array of LLMS_User_Certificate instances.
* @return LLMS_Awards_Query|object[]|LLMS_User_Certificate[]
*/
public function get_certificates( $args_or_orderby = 'updated_date', $order = 'DESC', $return = 'obj' ) {
// New behavior.
if ( is_array( $args_or_orderby ) ) {
return $this->get_awards( $args_or_orderby, 'certificate' );
}
_deprecated_function( 'LLMS_Student::get_certificates()', '6.0.0', 'The behavior of this method has changed. Please refer to https://developer.lifterlms.com/reference/classes/llms_student/get_certificates/ for more information.' );
$orderby = esc_sql( $args_or_orderby );
$order = esc_sql( $order );
global $wpdb;
// phpcs:disable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
$query = $wpdb->get_results(
$wpdb->prepare(
"SELECT post_id, meta_value AS certificate_id, updated_date AS earned_date FROM {$wpdb->prefix}lifterlms_user_postmeta WHERE user_id = %d and meta_key = '_certificate_earned' ORDER BY $orderby $order",
$this->get_id()
)
); // db call ok; no-cache ok.
// phpcs:enable WordPress.DB.PreparedSQL.InterpolatedNotPrepared
if ( 'certificates' === $return ) {
$ret = array();
foreach ( $query as $obj ) {
$ret[] = new LLMS_User_Certificate( $obj->certificate_id );
}
return $ret;
}
return $query;
}
}
================================================
FILE: includes/traits/llms-trait-user-engagement-type.php
================================================
<?php
/**
* LLMS_Trait_User_Engagement_Type definition
*
* @package LifterLMS/Traits
*
* @since 6.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Methods and properties to help with user engagements.
*
* @since 6.0.0
*/
trait LLMS_Trait_User_Engagement_Type {
/**
* The type of user engagement, e.g. 'achievement' or 'certificate'.
*
* @since 6.0.0
*
* @var string
*/
protected $engagement_type;
/**
* Returns the number of user engagements that have been awarded from the template.
*
* @since 6.0.0
*
* @param int $template_id The post ID of the template.
* @return int
*/
protected function count_awarded_engagements( $template_id ) {
$awarded_engagements_query = new LLMS_Awards_Query(
array(
'fields' => 'ids',
'templates' => $template_id,
'per_page' => 1,
'status' => array(
'draft',
'future',
'publish',
),
'type' => $this->engagement_type,
)
);
return $awarded_engagements_query->get_found_results();
}
/**
* Returns an awarded engagement or an engagement template, based on a LLMS_Post_Model object, for the given post or false if not found.
*
* @since 6.0.0
*
* @param WP_Post|int|null $post A WP_Post object or a WP_Post ID. A falsy value will use
* the current global `$post` object (if one exists).
* @param int $is_awarded If true, returns an awarded engagement, else an engagement template.
* @return LLMS_Abstract_User_Engagement|false
*/
protected function get_user_engagement( $post, $is_awarded ) {
$is_awarded = $is_awarded ? 'my_' : null;
$post = get_post( $post );
if ( ! $post || "llms_{$is_awarded}{$this->engagement_type}" !== $post->post_type ) {
return false;
}
$class = 'LLMS_User_' . ucwords( $this->engagement_type, '_' );
return new $class( $post );
}
}
================================================
FILE: includes/widgets/class.llms.bbp.widget.course.forums.list.php
================================================
<?php
/**
* LifterLMS bbPress forms list widget
*
* @package LifterLMS/Integrations/bbPress
*
* @since 3.12.0
* @version 3.24.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LifterLMS bbPress forms list widget
*
* @since 3.12.0
* @since 3.24.0 Unknown.
*/
class LLMS_BBP_Widget_Course_Forums_List extends WP_Widget {
/**
* Constructor
*
* @since 3.12.0
* @version 3.12.0
*/
public function __construct() {
$options = array(
'classname' => 'llms-bbp-widget-course-forums',
'description' => esc_html__( 'Displays a list of bbPress forums associated with the course.', 'lifterlms' ),
);
parent::__construct( 'llms_bbp_widget_course_forums_list', esc_html__( 'LifterLMS Course Forums List', 'lifterlms' ), $options );
}
/**
* Output the widget
*
* @param array $args arguments passed to the widget
* @param array $instance instance information
* @return void
* @since 3.12.0
* @version 3.12.0
*/
public function widget( $args, $instance ) {
$id = get_the_ID();
if ( 'course' !== get_post_type( $id ) ) {
$course = llms_get_post_parent_course( $id );
} else {
$course = llms_get_post( $id );
}
if ( ! $course ) {
return;
}
if ( ! $course->get( 'bbp_forum_ids' ) ) {
return;
}
echo wp_kses_post( $args['before_widget'] );
if ( ! empty( $instance['title'] ) ) {
echo wp_kses_post( $args['before_title'] . apply_filters( 'widget_title', $instance['title'] ) . $args['after_title'] );
}
echo do_shortcode( '[lifterlms_bbp_course_forums]' );
echo wp_kses_post( $args['after_widget'] );
}
/**
* Output widget options form
*
* @param array $instance instance data
* @return void
* @since 3.12.0
* @version 3.24.0
*/
public function form( $instance ) {
$title = isset( $instance['title'] ) ? $instance['title'] : __( 'Course Forums', 'lifterlms' );
?>
<p>
<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'lifterlms' ); ?></label>
<input class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>">
</p>
<?php
}
}
================================================
FILE: includes/widgets/class.llms.widget.course.progress.php
================================================
<?php
/**
* Course progress widget
*
* Displays course progress.
*
* @package LifterLMS/Widgets/Classes
*
* @since 1.0.0
* @version 4.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Widget_Course_Progress
*
* @since 1.0.0
* @since 3.38.0 Introduced a new option to display/hide the course progress widget to enrolled students only.
* Hidden to not enrolled students by default.
* @since 4.0.0 Remove previously deprecated method `LLMS_Widget_Course_Progress::widget_contents()`.
*/
class LLMS_Widget_Course_Progress extends LLMS_Widget {
/**
* Register widget with WordPress.
*
* @since 1.0.0
*
* @return void
*/
public function __construct() {
WP_Widget::__construct(
'course_progress',
__( 'Course Progress', 'lifterlms' ),
array(
'description' => __( 'Displays Course Progress on Course or Lesson', 'lifterlms' ),
)
);
}
/**
* Back-end widget form.
*
* @since 3.38.0
*
* @see WP_Widget::form()
*
* @param array $instance Previously saved values from database.
*/
public function form( $instance ) {
// Call widget defaults from parent.
parent::form( $instance );
$check_enrollment = ( isset( $instance['check_enrollment'] ) ) ? $instance['check_enrollment'] : 1;
?>
<p>
<input <?php checked( 1, $check_enrollment ); ?> class="checkbox llms-course-progress-check-enrollment" id="<?php echo esc_attr( $this->get_field_id( 'check_enrollment' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'check_enrollment' ) ); ?>" type="checkbox" value="1">
<label for="<?php echo esc_attr( $this->get_field_id( 'check_enrollment' ) ); ?>">
<?php esc_html_e( 'Display to enrolled students only?', 'lifterlms' ); ?><br>
<em><?php esc_html_e( 'When checked the course progress bar will be shown only to those students enrolled in the course.', 'lifterlms' ); ?></em>
</label>
</p>
<?php
}
/**
* Front-end display of widget
*
* @since 3.38.0
*
* @see WP_Widget::widget()
*
* @param array $args Widget arguments.
* @param array $instance Saved values from database.
* @return void
*/
public function widget( $args, $instance ) {
$check_enrollment = ( ! isset( $instance['check_enrollment'] ) ) ? 1 : $instance['check_enrollment'];
$course_progress = do_shortcode( '[lifterlms_course_progress check_enrollment=' . $check_enrollment . ']' );
// Do not show the widget title if no progress bar is displayed.
if ( empty( $course_progress ) ) {
return;
}
echo wp_kses_post( $args['before_widget'] );
if ( ! empty( $instance['title'] ) ) {
echo wp_kses_post( $args['before_title'] ) . wp_kses_post( apply_filters( 'widget_title', $instance['title'] ) ) . wp_kses_post( $args['after_title'] );
}
echo wp_kses_post( $course_progress );
echo wp_kses_post( $args['after_widget'] );
}
/**
* Sanitize widget form values as they are saved.
*
* @since 3.38.0
*
* @see WP_Widget::update()
*
* @param array $new_instance Values just sent to be saved.
* @param array $old_instance Previously saved values from database.
* @return array Updated safe values to be saved.
*/
public function update( $new_instance, $old_instance ) {
$instance = parent::update( $new_instance, $old_instance );
$instance['check_enrollment'] = ( ! empty( $new_instance['check_enrollment'] ) ) ? 1 : 0;
return $instance;
}
}
================================================
FILE: includes/widgets/class.llms.widget.course.syllabus.php
================================================
<?php
/**
* Course syllabus widget
*
* Displays all lessons in the course
*
* @package LifterLMS/Widgets/Classes
*
* @since 1.0.0
* @version Unknown
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Widget_Course_Syllabus
*
* @since 1.0.0
*/
class LLMS_Widget_Course_Syllabus extends LLMS_Widget {
/**
* Register widget with WordPress.
*/
public function __construct() {
WP_Widget::__construct(
'course_syllabus',
__( 'Course Syllabus', 'lifterlms' ),
array(
'description' => __( 'Displays All Course lessons on Course or Lesson page', 'lifterlms' ),
)
);
}
/**
* Back-end widget form.
*
* @see WP_Widget::form()
*
* @param array $instance Previously saved values from database.
*/
public function form( $instance ) {
// Call widget defaults from parent.
parent::form( $instance );
$collapse = ( ! empty( $instance['collapse'] ) ) ? $instance['collapse'] : 0;
$toggles = ( ! empty( $instance['toggles'] ) ) ? $instance['toggles'] : 0;
?>
<p>
<input <?php checked( 1, $collapse ); ?> class="checkbox llms-course-outline-collapse" id="<?php echo esc_attr( $this->get_field_id( 'collapse' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'collapse' ) ); ?>" type="checkbox" value="1">
<label for="<?php echo esc_attr( $this->get_field_id( 'collapse' ) ); ?>">
<?php esc_html_e( 'Make outline collapsible?', 'lifterlms' ); ?><br>
<em><?php esc_html_e( 'Allow students to hide lessons within a section by clicking the section titles.', 'lifterlms' ); ?></em>
</label>
</p>
<p class="llms-course-outline-toggle-wrapper"<?php echo ( ! $collapse ) ? ' style="display:none;"' : '';?>>
<input <?php checked( 1, $toggles ); ?> class="checkbox" id="<?php echo esc_attr( $this->get_field_id( 'toggles' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'toggles' ) ); ?>" type="checkbox" value="1">
<label for="<?php echo esc_attr( $this->get_field_id( 'toggles' ) ); ?>">
<?php esc_html_e( 'Display open and close all toggles', 'lifterlms' ); ?><br>
<em><?php esc_html_e( 'Display "Open All" and "Close All" toggles at the bottom of the outline.', 'lifterlms' ); ?></em>
</label>
</p>
<?php
}
/**
* Widget Content
* Overrides parent class
*
* @see LLMS_Widget()
* @return void
*/
public function widget_contents( $args, $instance ) {
$collapse = ( isset( $instance['collapse'] ) ) ? $instance['collapse'] : 0;
$toggles = ( isset( $instance['toggles'] ) ) ? $instance['toggles'] : 0;
echo do_shortcode( '[lifterlms_course_outline collapse="' . $collapse . '" toggles="' . $toggles . '"]' );
}
/**
* Sanitize widget form values as they are saved.
*
* @see WP_Widget::update()
*
* @param array $new_instance Values just sent to be saved.
* @param array $old_instance Previously saved values from database.
*
* @return array Updated safe values to be saved.
*/
public function update( $new_instance, $old_instance ) {
$instance = parent::update( $new_instance, $old_instance );
$instance['collapse'] = ( ! empty( $new_instance['collapse'] ) ) ? 1 : 0;
$instance['toggles'] = ( ! empty( $new_instance['toggles'] ) ) ? 1 : 0;
return $instance;
}
}
================================================
FILE: includes/widgets/class.llms.widget.php
================================================
<?php
/**
* Base LifterLMS Widget Class
*
* @package LifterLMS/Widgets/Classes
*
* @since 1.0.0
* @version 3.24.0
*/
defined( 'ABSPATH' ) || exit;
/**
* Base LifterLMS Widget Class
*
* @since 1.0.0
* @since 3.24.0 Unknown.
*/
class LLMS_Widget extends WP_Widget {
/**
* Register widget with WordPress.
*
* @see WP_Widget::__construct()
*/
public function __construct() {}
/**
* Front-end display of widget.
*
* @see WP_Widget::widget()
*
* @param array $args Widget arguments.
* @param array $instance Saved values from database.
*
* @return void
*/
public function widget( $args, $instance ) {
echo wp_kses_post( $args['before_widget'] );
if ( ! empty( $instance['title'] ) ) {
echo wp_kses_post( $args['before_title'] . apply_filters( 'widget_title', $instance['title'] ) . $args['after_title'] );
}
$this->widget_contents( $args, $instance );
echo wp_kses_post( $args['after_widget'] );
}
/**
* Echo Widget content.
* This is called in widget()
*
* @return void
*/
public function widget_contents( $args, $instance ) {}
/**
* Back-end widget form.
*
* @see WP_Widget::form()
* @param array $instance Previously saved values from database.
* @return void
* @since 1.0.0
* @version 3.24.0
*/
public function form( $instance ) {
$title = ! empty( $instance['title'] ) ? $instance['title'] : '';
?>
<p>
<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php esc_html_e( 'Title:', 'lifterlms' ); ?></label>
<input class="widefat" id="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $title ); ?>">
</p>
<?php
}
/**
* Sanitize widget form values as they are saved.
*
* @see WP_Widget::update()
*
* @param array $new_instance Values just sent to be saved.
* @param array $old_instance Previously saved values from database.
*
* @return array Updated safe values to be saved.
*/
public function update( $new_instance, $old_instance ) {
$instance = array();
$instance['title'] = ( ! empty( $new_instance['title'] ) ) ? wp_strip_all_tags( $new_instance['title'] ) : '';
return $instance;
}
}
return new LLMS_Widget();
================================================
FILE: includes/widgets/class.llms.widgets.php
================================================
<?php
/**
* Base Widgets Class
*
* Calls WP register widgets for each widget in filter lifterlms_widgets
*
* @package LifterLMS/Widgets/Classes
*
* @since 1.0.0
* @version 6.0.0
*/
defined( 'ABSPATH' ) || exit;
/**
* LLMS_Widgets
*
* @since 1.0.0
* @since 3.12.0 Unknown.
*/
class LLMS_Widgets {
/**
* Constructor
*
* @since 1.0.0
*
* @return void
*/
public function __construct() {
add_action( 'widgets_init', array( $this, 'register_widgets' ) );
}
/**
* Registers all lifterlms_widgets
*
* @since 1.0.0
* @since 3.12.0 Unknown.
* @since 6.0.0 Removed loading of class files that don't instantiate their class in favor of autoloading.
*
* @return void
*/
public function register_widgets() {
$widgets = apply_filters(
'lifterlms_widgets',
array(
'LLMS_Widget_Course_Progress',
'LLMS_Widget_Course_Syllabus',
)
);
if ( class_exists( 'bbPress' ) && 'yes' === get_option( 'llms_integration_bbpress_enabled', 'no' ) ) {
$widgets[] = 'LLMS_BBP_Widget_Course_Forums_List';
}
foreach ( $widgets as $widget ) {
register_widget( $widget );
}
}
}
return new LLMS_Widgets();
================================================
FILE: includes/widgets/index.php
================================================
<?php // quiet.
================================================
FILE: index.php
================================================
<?php // shhhh.
================================================
FILE: languages/README.md
================================================
LifterLMS Localization and Language Files
=========================================
This directory contains localization and language files for the LifterLMS plugin.
## Translating LifterLMS
LifterLMS is fully translatable. The main `.pot` file contained in this directory ([lifterlms.pot](lifterlms.pot)) contains all translatable strings available in the source code. This file is automatically generated on release.
## Localization Information Files
The `.php` files contained within this directory contain lists of localization information (such as country, address, and currency formatting data). These files are loaded by LifterLMS core functions to various areas of the LifterLMS plugin.
The data contained within these files is compiled from regularly updated sources and converted into a format used by our internal API. These files are automatically generated during a release step.
Information for these files is derived from the following projects and sources:
+ [Countries States Cities Database](https://github.com/dr5hn/countries-states-cities-database)
+ [Currency Formatter](https://github.com/smirzaei/currency-formatter)
+ [addressfield.json](https://github.com/tableau-mkt/addressfield.json)
+ [LocalePlanet](https://www.localeplanet.com/)
If you locate any incorrect information in any of these files, please let us know by opening [a new issue](https://github.com/gocodebox/lifterlms/issues/new/choose).
================================================
FILE: languages/countries-address-info.php
================================================
<?php
/**
* Countries Address Info
*
* Returns a map of countries and localization information related to address formatting.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* The data contained within this file is derived from various open-source *
* projects and libraries. *
* *
* See the README.md file in this directory for credits and more. *
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Note to contributors: *
* *
* The data contained within this file is automatically generated. Do not *
* modify or submit pull requests on this file directly. If you've located *
* an issue with any of the data contained within this file please open a *
* new issue at https://github.com/gocodebox/lifterlms/issues/new/choose. *
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* @package LifterLMS/i18n
*
* @see llms_get_countries_address_info()
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
return array(
'AD' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'AE' => array(
'city' => false,
'state' => false,
'postcode' => false,
),
'AF' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'AG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'AI' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'AL' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => false,
),
'AM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'AO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => false,
),
'AQ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'AR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'AS' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'ZIP code', 'lifterlms' ),
),
'AT' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'AU' => array(
'city' => __( 'City / Suburb', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'Postcode', 'lifterlms' ),
),
'AW' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'AX' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'AZ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BB' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'BD' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BE' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BF' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BH' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BI' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'BJ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => false,
),
'BL' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BN' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => false,
),
'BQ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal Code', 'lifterlms' ),
),
'BR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BS' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'BT' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BV' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BW' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'BY' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'BZ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'CA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CC' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CD' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CF' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'CG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'CH' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CI' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CK' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CL' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'CN' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => false,
),
'CR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CU' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CV' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CW' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CX' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CY' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'CZ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'DE' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'DJ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'DK' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'DM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'DO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'DZ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'EC' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'EE' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'EG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Governorate', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'EH' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'ER' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'ES' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'ET' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'FI' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'FJ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'FK' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'FM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'ZIP code', 'lifterlms' ),
),
'FO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'FR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GB' => array(
'city' => __( 'Town / City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postcode', 'lifterlms' ),
),
'GD' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'GE' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GF' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GH' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => false,
),
'GI' => array(
'city' => false,
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GL' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'GN' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GP' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GQ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'GR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GS' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GT' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GU' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'ZIP code', 'lifterlms' ),
),
'GW' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'GY' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'HK' => array(
'city' => __( 'District', 'lifterlms' ),
'state' => __( 'Area', 'lifterlms' ),
'postcode' => false,
),
'HM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'HN' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'HR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'HT' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'HU' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'ID' => array(
'city' => __( 'City / Regency', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'IE' => array(
'city' => __( 'Town / City', 'lifterlms' ),
'state' => __( 'County', 'lifterlms' ),
'postcode' => __( 'Eircode', 'lifterlms' ),
),
'IL' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'IM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'IN' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'PIN code', 'lifterlms' ),
),
'IO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'IQ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'IR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'IS' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'IT' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'JE' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'JM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Parish', 'lifterlms' ),
'postcode' => false,
),
'JO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'JP' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Prefecture', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'KE' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'KG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'KH' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'KI' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'KM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'KN' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Island', 'lifterlms' ),
'postcode' => false,
),
'KP' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'KR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'KW' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'KY' => array(
'city' => false,
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'KZ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'LA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'LB' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'LC' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'LI' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'LK' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'LR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'LS' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'LT' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'LU' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'LV' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'LY' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'MA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MC' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MD' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'ME' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MF' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MH' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'ZIP code', 'lifterlms' ),
),
'MK' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'ML' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'MM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MN' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MP' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'ZIP code', 'lifterlms' ),
),
'MQ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'MS' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MT' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MU' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MV' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MW' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MX' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MY' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'MZ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'NA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => false,
),
'NC' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'NE' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'NF' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'NG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'NI' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Department', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'NL' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'NO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'NP' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'NR' => array(
'city' => false,
'state' => false,
'postcode' => false,
),
'NU' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'NZ' => array(
'city' => __( 'Town / City', 'lifterlms' ),
'state' => __( 'Region', 'lifterlms' ),
'postcode' => __( 'Postcode', 'lifterlms' ),
),
'OM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'PA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => false,
),
'PE' => array(
'city' => __( 'District', 'lifterlms' ),
'state' => __( 'Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'PF' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'PG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'PH' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'PK' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'PL' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'PM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'PN' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'PR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'ZIP code', 'lifterlms' ),
),
'PS' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'PT' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'PW' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'ZIP code', 'lifterlms' ),
),
'PY' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'QA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'RE' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'RO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'RS' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'RU' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'RW' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'SA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SB' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'SC' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'SD' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SE' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SG' => array(
'city' => false,
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SH' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SI' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SJ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SK' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SL' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'SM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SN' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'SS' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal Code', 'lifterlms' ),
),
'ST' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'SV' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SX' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal Code', 'lifterlms' ),
),
'SY' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'SZ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'TC' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'TD' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'TF' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'TG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'TH' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'TJ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'TK' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'TL' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'TM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'TN' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'TO' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'TR' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'TT' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'TV' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'TW' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'TZ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => false,
),
'UA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'UG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => false,
),
'UM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'ZIP code', 'lifterlms' ),
),
'US' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'ZIP code', 'lifterlms' ),
),
'UY' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'UZ' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'VA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'VC' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'VE' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'VG' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'VI' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'VN' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'VU' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'WF' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'WS' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
'XK' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal Code', 'lifterlms' ),
),
'YE' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'YT' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'ZA' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'Province', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'ZM' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => __( 'State / Region', 'lifterlms' ),
'postcode' => __( 'Postal code', 'lifterlms' ),
),
'ZW' => array(
'city' => __( 'City', 'lifterlms' ),
'state' => false,
'postcode' => false,
),
);
================================================
FILE: languages/countries.php
================================================
<?php
/**
* Countries
*
* Returns an array of countries and codes.
* Country codes and names should follow the Unicode CLDR recommendation (https://cldr.unicode.org/translation/displaynames/countryregion-territory-names).
*
* See https://github.com/unicode-org/cldr/blob/master/common/subdivisions/en.xml
*
* @package WooCommerce\i18n
* @version 3.8.0
*/
defined( 'ABSPATH' ) || exit;
return array(
'AF' => __( 'Afghanistan', 'lifterlms' ),
'AX' => __( 'Åland Islands', 'lifterlms' ),
'AL' => __( 'Albania', 'lifterlms' ),
'DZ' => __( 'Algeria', 'lifterlms' ),
'AS' => __( 'American Samoa', 'lifterlms' ),
'AD' => __( 'Andorra', 'lifterlms' ),
'AO' => __( 'Angola', 'lifterlms' ),
'AI' => __( 'Anguilla', 'lifterlms' ),
'AQ' => __( 'Antarctica', 'lifterlms' ),
'AG' => __( 'Antigua and Barbuda', 'lifterlms' ),
'AR' => __( 'Argentina', 'lifterlms' ),
'AM' => __( 'Armenia', 'lifterlms' ),
'AW' => __( 'Aruba', 'lifterlms' ),
'AU' => __( 'Australia', 'lifterlms' ),
'AT' => __( 'Austria', 'lifterlms' ),
'AZ' => __( 'Azerbaijan', 'lifterlms' ),
'BS' => __( 'Bahamas', 'lifterlms' ),
'BH' => __( 'Bahrain', 'lifterlms' ),
'BD' => __( 'Bangladesh', 'lifterlms' ),
'BB' => __( 'Barbados', 'lifterlms' ),
'BY' => __( 'Belarus', 'lifterlms' ),
'BE' => __( 'Belgium', 'lifterlms' ),
'PW' => __( 'Belau', 'lifterlms' ),
'BZ' => __( 'Belize', 'lifterlms' ),
'BJ' => __( 'Benin', 'lifterlms' ),
'BM' => __( 'Bermuda', 'lifterlms' ),
'BT' => __( 'Bhutan', 'lifterlms' ),
'BO' => __( 'Bolivia', 'lifterlms' ),
'BQ' => __( 'Bonaire, Saint Eustatius and Saba', 'lifterlms' ),
'BA' => __( 'Bosnia and Herzegovina', 'lifterlms' ),
'BW' => __( 'Botswana', 'lifterlms' ),
'BV' => __( 'Bouvet Island', 'lifterlms' ),
'BR' => __( 'Brazil', 'lifterlms' ),
'IO' => __( 'British Indian Ocean Territory', 'lifterlms' ),
'BN' => __( 'Brunei', 'lifterlms' ),
'BG' => __( 'Bulgaria', 'lifterlms' ),
'BF' => __( 'Burkina Faso', 'lifterlms' ),
'BI' => __( 'Burundi', 'lifterlms' ),
'KH' => __( 'Cambodia', 'lifterlms' ),
'CM' => __( 'Cameroon', 'lifterlms' ),
'CA' => __( 'Canada', 'lifterlms' ),
'CV' => __( 'Cape Verde', 'lifterlms' ),
'KY' => __( 'Cayman Islands', 'lifterlms' ),
'CF' => __( 'Central African Republic', 'lifterlms' ),
'TD' => __( 'Chad', 'lifterlms' ),
'CL' => __( 'Chile', 'lifterlms' ),
'CN' => __( 'China', 'lifterlms' ),
'CX' => __( 'Christmas Island', 'lifterlms' ),
'CC' => __( 'Cocos (Keeling) Islands', 'lifterlms' ),
'CO' => __( 'Colombia', 'lifterlms' ),
'KM' => __( 'Comoros', 'lifterlms' ),
'CG' => __( 'Congo (Brazzaville)', 'lifterlms' ),
'CD' => __( 'Congo (Kinshasa)', 'lifterlms' ),
'CK' => __( 'Cook Islands', 'lifterlms' ),
'CR' => __( 'Costa Rica', 'lifterlms' ),
'HR' => __( 'Croatia', 'lifterlms' ),
'CU' => __( 'Cuba', 'lifterlms' ),
'CW' => __( 'Curaçao', 'lifterlms' ),
'CY' => __( 'Cyprus', 'lifterlms' ),
'CZ' => __( 'Czech Republic', 'lifterlms' ),
'DK' => __( 'Denmark', 'lifterlms' ),
'DJ' => __( 'Djibouti', 'lifterlms' ),
'DM' => __( 'Dominica', 'lifterlms' ),
'DO' => __( 'Dominican Republic', 'lifterlms' ),
'EC' => __( 'Ecuador', 'lifterlms' ),
'EG' => __( 'Egypt', 'lifterlms' ),
'SV' => __( 'El Salvador', 'lifterlms' ),
'GQ' => __( 'Equatorial Guinea', 'lifterlms' ),
'ER' => __( 'Eritrea', 'lifterlms' ),
'EE' => __( 'Estonia', 'lifterlms' ),
'ET' => __( 'Ethiopia', 'lifterlms' ),
'FK' => __( 'Falkland Islands', 'lifterlms' ),
'FO' => __( 'Faroe Islands', 'lifterlms' ),
'FJ' => __( 'Fiji', 'lifterlms' ),
'FI' => __( 'Finland', 'lifterlms' ),
'FR' => __( 'France', 'lifterlms' ),
'GF' => __( 'French Guiana', 'lifterlms' ),
'PF' => __( 'French Polynesia', 'lifterlms' ),
'TF' => __( 'French Southern Territories', 'lifterlms' ),
'GA' => __( 'Gabon', 'lifterlms' ),
'GM' => __( 'Gambia', 'lifterlms' ),
'GE' => __( 'Georgia', 'lifterlms' ),
'DE' => __( 'Germany', 'lifterlms' ),
'GH' => __( 'Ghana', 'lifterlms' ),
'GI' => __( 'Gibraltar', 'lifterlms' ),
'GR' => __( 'Greece', 'lifterlms' ),
'GL' => __( 'Greenland', 'lifterlms' ),
'GD' => __( 'Grenada', 'lifterlms' ),
'GP' => __( 'Guadeloupe', 'lifterlms' ),
'GU' => __( 'Guam', 'lifterlms' ),
'GT' => __( 'Guatemala', 'lifterlms' ),
'GG' => __( 'Guernsey', 'lifterlms' ),
'GN' => __( 'Guinea', 'lifterlms' ),
'GW' => __( 'Guinea-Bissau', 'lifterlms' ),
'GY' => __( 'Guyana', 'lifterlms' ),
'HT' => __( 'Haiti', 'lifterlms' ),
'HM' => __( 'Heard Island and McDonald Islands', 'lifterlms' ),
'HN' => __( 'Honduras', 'lifterlms' ),
'HK' => __( 'Hong Kong', 'lifterlms' ),
'HU' => __( 'Hungary', 'lifterlms' ),
'IS' => __( 'Iceland', 'lifterlms' ),
'IN' => __( 'India', 'lifterlms' ),
'ID' => __( 'Indonesia', 'lifterlms' ),
'IR' => __( 'Iran', 'lifterlms' ),
'IQ' => __( 'Iraq', 'lifterlms' ),
'IE' => __( 'Ireland', 'lifterlms' ),
'IM' => __( 'Isle of Man', 'lifterlms' ),
'IL' => __( 'Israel', 'lifterlms' ),
'IT' => __( 'Italy', 'lifterlms' ),
'CI' => __( 'Ivory Coast', 'lifterlms' ),
'JM' => __( 'Jamaica', 'lifterlms' ),
'JP' => __( 'Japan', 'lifterlms' ),
'JE' => __( 'Jersey', 'lifterlms' ),
'JO' => __( 'Jordan', 'lifterlms' ),
'KZ' => __( 'Kazakhstan', 'lifterlms' ),
'KE' => __( 'Kenya', 'lifterlms' ),
'KI' => __( 'Kiribati', 'lifterlms' ),
'KW' => __( 'Kuwait', 'lifterlms' ),
'KG' => __( 'Kyrgyzstan', 'lifterlms' ),
'LA' => __( 'Laos', 'lifterlms' ),
'LV' => __( 'Latvia', 'lifterlms' ),
'LB' => __( 'Lebanon', 'lifterlms' ),
'LS' => __( 'Lesotho', 'lifterlms' ),
'LR' => __( 'Liberia', 'lifterlms' ),
'LY' => __( 'Libya', 'lifterlms' ),
'LI' => __( 'Liechtenstein', 'lifterlms' ),
'LT' => __( 'Lithuania', 'lifterlms' ),
'LU' => __( 'Luxembourg', 'lifterlms' ),
'MO' => __( 'Macao', 'lifterlms' ),
'MK' => __( 'North Macedonia', 'lifterlms' ),
'MG' => __( 'Madagascar', 'lifterlms' ),
'MW' => __( 'Malawi', 'lifterlms' ),
'MY' => __( 'Malaysia', 'lifterlms' ),
'MV' => __( 'Maldives', 'lifterlms' ),
'ML' => __( 'Mali', 'lifterlms' ),
'MT' => __( 'Malta', 'lifterlms' ),
'MH' => __( 'Marshall Islands', 'lifterlms' ),
'MQ' => __( 'Martinique', 'lifterlms' ),
'MR' => __( 'Mauritania', 'lifterlms' ),
'MU' => __( 'Mauritius', 'lifterlms' ),
'YT' => __( 'Mayotte', 'lifterlms' ),
'MX' => __( 'Mexico', 'lifterlms' ),
'FM' => __( 'Micronesia', 'lifterlms' ),
'MD' => __( 'Moldova', 'lifterlms' ),
'MC' => __( 'Monaco', 'lifterlms' ),
'MN' => __( 'Mongolia', 'lifterlms' ),
'ME' => __( 'Montenegro', 'lifterlms' ),
'MS' => __( 'Montserrat', 'lifterlms' ),
'MA' => __( 'Morocco', 'lifterlms' ),
'MZ' => __( 'Mozambique', 'lifterlms' ),
'MM' => __( 'Myanmar', 'lifterlms' ),
'NA' => __( 'Namibia', 'lifterlms' ),
'NR' => __( 'Nauru', 'lifterlms' ),
'NP' => __( 'Nepal', 'lifterlms' ),
'NL' => __( 'Netherlands', 'lifterlms' ),
'NC' => __( 'New Caledonia', 'lifterlms' ),
'NZ' => __( 'New Zealand', 'lifterlms' ),
'NI' => __( 'Nicaragua', 'lifterlms' ),
'NE' => __( 'Niger', 'lifterlms' ),
'NG' => __( 'Nigeria', 'lifterlms' ),
'NU' => __( 'Niue', 'lifterlms' ),
'NF' => __( 'Norfolk Island', 'lifterlms' ),
'MP' => __( 'Northern Mariana Islands', 'lifterlms' ),
'KP' => __( 'North Korea', 'lifterlms' ),
'NO' => __( 'Norway', 'lifterlms' ),
'OM' => __( 'Oman', 'lifterlms' ),
'PK' => __( 'Pakistan', 'lifterlms' ),
'PS' => __( 'Palestinian Territory', 'lifterlms' ),
'PA' => __( 'Panama', 'lifterlms' ),
'PG' => __( 'Papua New Guinea', 'lifterlms' ),
'PY' => __( 'Paraguay', 'lifterlms' ),
'PE' => __( 'Peru', 'lifterlms' ),
'PH' => __( 'Philippines', 'lifterlms' ),
'PN' => __( 'Pitcairn', 'lifterlms' ),
'PL' => __( 'Poland', 'lifterlms' ),
'PT' => __( 'Portugal', 'lifterlms' ),
'PR' => __( 'Puerto Rico', 'lifterlms' ),
'QA' => __( 'Qatar', 'lifterlms' ),
'RE' => __( 'Reunion', 'lifterlms' ),
'RO' => __( 'Romania', 'lifterlms' ),
'RU' => __( 'Russia', 'lifterlms' ),
'RW' => __( 'Rwanda', 'lifterlms' ),
'BL' => __( 'Saint Barthélemy', 'lifterlms' ),
'SH' => __( 'Saint Helena', 'lifterlms' ),
'KN' => __( 'Saint Kitts and Nevis', 'lifterlms' ),
'LC' => __( 'Saint Lucia', 'lifterlms' ),
'MF' => __( 'Saint Martin (French part)', 'lifterlms' ),
'SX' => __( 'Saint Martin (Dutch part)', 'lifterlms' ),
'PM' => __( 'Saint Pierre and Miquelon', 'lifterlms' ),
'VC' => __( 'Saint Vincent and the Grenadines', 'lifterlms' ),
'SM' => __( 'San Marino', 'lifterlms' ),
'ST' => __( 'São Tomé and Príncipe', 'lifterlms' ),
'SA' => __( 'Saudi Arabia', 'lifterlms' ),
'SN' => __( 'Senegal', 'lifterlms' ),
'RS' => __( 'Serbia', 'lifterlms' ),
'SC' => __( 'Seychelles', 'lifterlms' ),
'SL' => __( 'Sierra Leone', 'lifterlms' ),
'SG' => __( 'Singapore', 'lifterlms' ),
'SK' => __( 'Slovakia', 'lifterlms' ),
'SI' => __( 'Slovenia', 'lifterlms' ),
'SB' => __( 'Solomon Islands', 'lifterlms' ),
'SO' => __( 'Somalia', 'lifterlms' ),
'ZA' => __( 'South Africa', 'lifterlms' ),
'GS' => __( 'South Georgia/Sandwich Islands', 'lifterlms' ),
'KR' => __( 'South Korea', 'lifterlms' ),
'SS' => __( 'South Sudan', 'lifterlms' ),
'ES' => __( 'Spain', 'lifterlms' ),
'LK' => __( 'Sri Lanka', 'lifterlms' ),
'SD' => __( 'Sudan', 'lifterlms' ),
'SR' => __( 'Suriname', 'lifterlms' ),
'SJ' => __( 'Svalbard and Jan Mayen', 'lifterlms' ),
'SZ' => __( 'Eswatini', 'lifterlms' ),
'SE' => __( 'Sweden', 'lifterlms' ),
'CH' => __( 'Switzerland', 'lifterlms' ),
'SY' => __( 'Syria', 'lifterlms' ),
'TW' => __( 'Taiwan', 'lifterlms' ),
'TJ' => __( 'Tajikistan', 'lifterlms' ),
'TZ' => __( 'Tanzania', 'lifterlms' ),
'TH' => __( 'Thailand', 'lifterlms' ),
'TL' => __( 'Timor-Leste', 'lifterlms' ),
'TG' => __( 'Togo', 'lifterlms' ),
'TK' => __( 'Tokelau', 'lifterlms' ),
'TO' => __( 'Tonga', 'lifterlms' ),
'TT' => __( 'Trinidad and Tobago', 'lifterlms' ),
'TN' => __( 'Tunisia', 'lifterlms' ),
'TR' => __( 'Turkey', 'lifterlms' ),
'TM' => __( 'Turkmenistan', 'lifterlms' ),
'TC' => __( 'Turks and Caicos Islands', 'lifterlms' ),
'TV' => __( 'Tuvalu', 'lifterlms' ),
'UG' => __( 'Uganda', 'lifterlms' ),
'UA' => __( 'Ukraine', 'lifterlms' ),
'AE' => __( 'United Arab Emirates', 'lifterlms' ),
'GB' => __( 'United Kingdom (UK)', 'lifterlms' ),
'US' => __( 'United States (US)', 'lifterlms' ),
'UM' => __( 'United States (US) Minor Outlying Islands', 'lifterlms' ),
'UY' => __( 'Uruguay', 'lifterlms' ),
'UZ' => __( 'Uzbekistan', 'lifterlms' ),
'VU' => __( 'Vanuatu', 'lifterlms' ),
'VA' => __( 'Vatican', 'lifterlms' ),
'VE' => __( 'Venezuela', 'lifterlms' ),
'VN' => __( 'Vietnam', 'lifterlms' ),
'VG' => __( 'Virgin Islands (British)', 'lifterlms' ),
'VI' => __( 'Virgin Islands (US)', 'lifterlms' ),
'WF' => __( 'Wallis and Futuna', 'lifterlms' ),
'EH' => __( 'Western Sahara', 'lifterlms' ),
'WS' => __( 'Samoa', 'lifterlms' ),
'YE' => __( 'Yemen', 'lifterlms' ),
'ZM' => __( 'Zambia', 'lifterlms' ),
'ZW' => __( 'Zimbabwe', 'lifterlms' ),
);
================================================
FILE: languages/currencies.php
================================================
<?php
/**
* Currencies
*
* currenciesList a map of currency codes and their names.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* The data contained within this file is derived from various open-source *
* projects and libraries. *
* *
* See the README.md file in this directory for credits and more. *
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Note to contributors: *
* *
* The data contained within this file is automatically generated. Do not *
* modify or submit pull requests on this file directly. If you've located *
* an issue with any of the data contained within this file please open a *
* new issue at https://github.com/gocodebox/lifterlms/issues/new/choose. *
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* @package LifterLMS/i18n
*
* @see get_lifterlms_currencies()
*
* @since 5.0.0
* @version 5.0.0
*/
defined( 'ABSPATH' ) || exit;
return array(
'AFN' => __( 'Afghan Afghani', 'lifterlms' ),
'ALL' => __( 'Albanian Lek', 'lifterlms' ),
'DZD' => __( 'Algerian Dinar', 'lifterlms' ),
'AOA' => __( 'Angolan Kwanza', 'lifterlms' ),
'ARS' => __( 'Argentine Peso', 'lifterlms' ),
'AMD' => __( 'Armenian Dram', 'lifterlms' ),
'AWG' => __( 'Aruban Florin', 'lifterlms' ),
'AUD' => __( 'Australian Dollar', 'lifterlms' ),
'AZN' => __( 'Azerbaijani Manat', 'lifterlms' ),
'BSD' => __( 'Bahamian Dollar', 'lifterlms' ),
'BHD' => __( 'Bahraini Dinar', 'lifterlms' ),
'BDT' => __( 'Bangladeshi Taka', 'lifterlms' ),
'BBD' => __( 'Barbadian Dollar', 'lifterlms' ),
'BYN' => __( 'Belarusian Ruble', 'lifterlms' ),
'BZD' => __( 'Belize Dollar', 'lifterlms' ),
'BMD' => __( 'Bermudan Dollar', 'lifterlms' ),
'BTN' => __( 'Bhutanese Ngultrum', 'lifterlms' ),
'BTC' => __( 'Bitcoin', 'lifterlms' ),
'BOB' => __( 'Bolivian Boliviano', 'lifterlms' ),
'BAM' => __( 'Bosnia-Herzegovina Convertible Mark', 'lifterlms' ),
'BWP' => __( 'Botswanan Pula', 'lifterlms' ),
'BRL' => __( 'Brazilian Real', 'lifterlms' ),
'GBP' => __( 'British Pound', 'lifterlms' ),
'BND' => __( 'Brunei Dollar', 'lifterlms' ),
'BGN' => __( 'Bulgarian Lev', 'lifterlms' ),
'BIF' => __( 'Burundian Franc', 'lifterlms' ),
'XPF' => __( 'CFP Franc', 'lifterlms' ),
'KHR' => __( 'Cambodian Riel', 'lifterlms' ),
'CAD' => __( 'Canadian Dollar', 'lifterlms' ),
'CVE' => __( 'Cape Verdean Escudo', 'lifterlms' ),
'KYD' => __( 'Cayman Islands Dollar', 'lifterlms' ),
'XAF' => __( 'Central African CFA Franc', 'lifterlms' ),
'CLP' => __( 'Chilean Peso', 'lifterlms' ),
'CNY' => __( 'Chinese Yuan', 'lifterlms' ),
'COP' => __( 'Colombian Peso', 'lifterlms' ),
'KMF' => __( 'Comorian Franc', 'lifterlms' ),
'CDF' => __( 'Congolese Franc', 'lifterlms' ),
'CRC' => __( 'Costa Rican Colón', 'lifterlms' ),
'HRK' => __( 'Croatian Kuna', 'lifterlms' ),
'CUC' => __( 'Cuban Convertible Peso', 'lifterlms' ),
'CUP' => __( 'Cuban Peso', 'lifterlms' ),
'CZK' => __( 'Czech Koruna', 'lifterlms' ),
'DKK' => __( 'Danish Krone', 'lifterlms' ),
'DJF' => __( 'Djiboutian Franc', 'lifterlms' ),
'DOP' => __( 'Dominican Peso', 'lifterlms' ),
'XCD' => __( 'East Caribbean Dollar', 'lifterlms' ),
'EGP' => __( 'Egyptian Pound', 'lifterlms' ),
'ERN' => __( 'Eritrean Nakfa', 'lifterlms' ),
'ETH' => __( 'Ethereum', 'lifterlms' ),
'ETB' => __( 'Ethiopian Birr', 'lifterlms' ),
'EUR' => __( 'Euro', 'lifterlms' ),
'FKP' => __( 'Falkland Islands Pound', 'lifterlms' ),
'FJD' => __( 'Fijian Dollar', 'lifterlms' ),
'GMD' => __( 'Gambian Dalasi', 'lifterlms' ),
'GEL' => __( 'Georgian Lari', 'lifterlms' ),
'GHS' => __( 'Ghanaian Cedi', 'lifterlms' ),
'GIP' => __( 'Gibraltar Pound', 'lifterlms' ),
'GTQ' => __( 'Guatemalan Quetzal', 'lifterlms' ),
'GPP' => __( 'Guernsey Pound', 'lifterlms' ),
'GNF' => __( 'Guinean Franc', 'lifterlms' ),
'GYD' => __( 'Guyanaese Dollar', 'lifterlms' ),
'HTG' => __( 'Haitian Gourde', 'lifterlms' ),
'HNL' => __( 'Honduran Lempira', 'lifterlms' ),
'HKD' => __( 'Hong Kong Dollar', 'lifterlms' ),
'HUF' => __( 'Hungarian Forint', 'lifterlms' ),
'ISK' => __( 'Icelandic Króna', 'lifterlms' ),
'INR' => __( 'Indian Rupee', 'lifterlms' ),
'IDR' => __( 'Indonesian Rupiah', 'lifterlms' ),
'IRR' => __( 'Iranian Rial', 'lifterlms' ),
'IQD' => __( 'Iraqi Dinar', 'lifterlms' ),
'ILS' => __( 'Israeli New Shekel', 'lifterlms' ),
'JMD' => __( 'Jamaican Dollar', 'lifterlms' ),
'JPY' => __( 'Japanese Yen', 'lifterlms' ),
'JEP' => __( 'Jersey Pound', 'lifterlms' ),
'JOD' => __( 'Jordanian Dinar', 'lifterlms' ),
'KZT' => __( 'Kazakhstani Tenge', 'lifterlms' ),
'KES' => __( 'Kenyan Shilling', 'lifterlms' ),
'KWD' => __( 'Kuwaiti Dinar', 'lifterlms' ),
'KGS' => __( 'Kyrgystani Som', 'lifterlms' ),
'LAK' => __( 'Laotian Kip', 'lifterlms' ),
'LBP' => __( 'Lebanese Pound', 'lifterlms' ),
'LSL' => __( 'Lesotho Loti', 'lifterlms' ),
'LRD' => __( 'Liberian Dollar', 'lifterlms' ),
'LYD' => __( 'Libyan Dinar', 'lifterlms' ),
'LTC' => __( 'Litecoin', 'lifterlms' ),
'MOP' => __( 'Macanese Pataca', 'lifterlms' ),
'MKD' => __( 'Macedonian Denar', 'lifterlms' ),
'MGA' => __( 'Malagasy Ariary', 'lifterlms' ),
'MWK' => __( 'Malawian Kwacha', 'lifterlms' ),
'MYR' => __( 'Malaysian Ringgit', 'lifterlms' ),
'MVR' => __( 'Maldivian rufiyaa', 'lifterlms' ),
'IMP' => __( 'Manx Pound', 'lifterlms' ),
'MRO' => __( 'Mauritanian Ouguiya', 'lifterlms' ),
'MUR' => __( 'Mauritian Rupee', 'lifterlms' ),
'MXN' => __( 'Mexican Peso', 'lifterlms' ),
'MDL' => __( 'Moldovan Leu', 'lifterlms' ),
'MNT' => __( 'Mongolian Tugrik', 'lifterlms' ),
'MAD' => __( 'Moroccan Dirham', 'lifterlms' ),
'MZN' => __( 'Mozambican Metical', 'lifterlms' ),
'MMK' => __( 'Myanmar Kyat', 'lifterlms' ),
'NAD' => __( 'Namibian Dollar', 'lifterlms' ),
'NPR' => __( 'Nepalese Rupee', 'lifterlms' ),
'ANG' => __( 'Netherlands Antillean Guilder', 'lifterlms' ),
'TWD' => __( 'New Taiwan Dollar', 'lifterlms' ),
'NZD' => __( 'New Zealand Dollar', 'lifterlms' ),
'NIO' => __( 'Nicaraguan Córdoba', 'lifterlms' ),
'NGN' => __( 'Nigerian Naira', 'lifterlms' ),
'KPW' => __( 'North Korean Won', 'lifterlms' ),
'NOK' => __( 'Norwegian Krone', 'lifterlms' ),
'OMR' => __( 'Omani Rial', 'lifterlms' ),
'PKR' => __( 'Pakistani Rupee', 'lifterlms' ),
'PAB' => __( 'Panamanian Balboa', 'lifterlms' ),
'PGK' => __( 'Papua New Guinean Kina', 'lifterlms' ),
'PYG' => __( 'Paraguayan Guarani', 'lifterlms' ),
'PEN' => __( 'Peruvian Sol', 'lifterlms' ),
'PHP' => __( 'Philippine Piso', 'lifterlms' ),
'PLN' => __( 'Polish Zloty', 'lifterlms' ),
'QAR' => __( 'Qatari Rial', 'lifterlms' ),
'RON' => __( 'Romanian Leu', 'lifterlms' ),
'RUB' => __( 'Russian Ruble', 'lifterlms' ),
'RWF' => __( 'Rwandan Franc', 'lifterlms' ),
'WST' => __( 'Samoan Tala', 'lifterlms' ),
'SAR' => __( 'Saudi Riyal', 'lifterlms' ),
'RSD' => __( 'Serbian Dinar', 'lifterlms' ),
'SCR' => __( 'Seychellois Rupee', 'lifterlms' ),
'SLL' => __( 'Sierra Leonean Leone', 'lifterlms' ),
'SGD' => __( 'Singapore Dollar', 'lifterlms' ),
'SBD' => __( 'Solomon Islands Dollar', 'lifterlms' ),
'SOS' => __( 'Somali Shilling', 'lifterlms' ),
'ZAR' => __( 'South African Rand', 'lifterlms' ),
'KRW' => __( 'South Korean Won', 'lifterlms' ),
'SSP' => __( 'South Sudanese Pound', 'lifterlms' ),
'LKR' => __( 'Sri Lankan Rupee', 'lifterlms' ),
'SHP' => __( 'St. Helena Pound', 'lifterlms' ),
'SDG' => __( 'Sudanese Pound', 'lifterlms' ),
'SRD' => __( 'Surinamese Dollar', 'lifterlms' ),
'SZL' => __( 'Swazi Lilangeni', 'lifterlms' ),
'SEK' => __( 'Swedish Krona', 'lifterlms' ),
'CHF' => __( 'Swiss Franc', 'lifterlms' ),
'SYP' => __( 'Syrian Pound', 'lifterlms' ),
'STD' => __( 'São Tomé and Príncipe dobra', 'lifterlms' ),
'TJS' => __( 'Tajikistani Somoni', 'lifterlms' ),
'TZS' => __( 'Tanzanian Shilling', 'lifterlms' ),
'THB' => __( 'Thai Baht', 'lifterlms' ),
'TOP' => __( 'Tongan Paʻanga', 'lifterlms' ),
'PRB' => __( 'Transnistrian Ruble', 'lifterlms' ),
'TTD' => __( 'Trinidad & Tobago Dollar', 'lifterlms' ),
'TND' => __( 'Tunisian Dinar', 'lifterlms' ),
'TRY' => __( 'Turkish Lira', 'lifterlms' ),
'TMT' => __( 'Turkmenistan manat', 'lifterlms' ),
'UGX' => __( 'Ugandan Shilling', 'lifterlms' ),
'UAH' => __( 'Ukrainian Hryvnia', 'lifterlms' ),
'AED' => __( 'United Arab Emirates Dirham', 'lifterlms' ),
'USD' => __( 'United States Dollar', 'lifterlms' ),
'UYU' => __( 'Uruguayan Peso', 'lifterlms' ),
'UZS' => __( 'Uzbekistani Som', 'lifterlms' ),
'VUV' => __( 'Vanuatu Vatu', 'lifterlms' ),
'VEF' => __( 'Venezuelan Bolívar', 'lifterlms' ),
'VND' => __( 'Vietnamese Dong', 'lifterlms' ),
'XOF' => __( 'West African CFA Franc', 'lifterlms' ),
'YER' => __( 'Yemeni Rial', 'lifterlms' ),
'ZMW' => __( 'Zambian Kwacha', 'lifterlms' ),
'ZWL' => __( 'Zimbabwean Dollar', 'lifterlms' ),
);
================================================
FILE: languages/currency-symbols.php
================================================
<?php
/**
* Currency Symbols
*
* Returns a map of currency codes and their symbols.
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* The data contained within this file is derived from various open-source *
* projects and libraries. *
* *
* See the README.md file in this directory for credits and more. *
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
*
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* *
* Note to contributors: *
* *
* The data contained within this file is automatically generated. Do not *
* modify or submit pull requests on this file directly. If you've located *
* an issue with any of the data contained within this file please open a *
* new issue at https://github.com/gocodebox/lifterlms/issues/new/choose. *
* *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
*
* @package LifterLMS/i18n
*
* @see llms_get_currency_symbols()
*
* @since 5.0.0
* @version 7.3.0
*/
defined( 'ABSPATH' ) || exit;
return array(
'AED' => __( 'إ.د', 'lifterlms' ),
'AFN' => __( '؋', 'lifterlms' ),
'ALL' => __( 'Lek', 'lifterlms' ),
'AMD' => __( '֏', 'lifterlms' ),
'ANG' => __( 'ƒ', 'lifterlms' ),
'AOA' => __( 'Kz', 'lifterlms' ),
'ARS' => __( '$', 'lifterlms' ),
'AUD' => __( '$', 'lifterlms' ),
'AWG' => __( 'ƒ', 'lifterlms' ),
'AZN' => __( 'm', 'lifterlms' ),
'BAM' => __( 'KM', 'lifterlms' ),
'BBD' => __( 'Bds$', 'lifterlms' ),
'BDT' => __( '৳', 'lifterlms' ),
'BGN' => __( 'Лв.', 'lifterlms' ),
'BHD' => __( '.د.ب', 'lifterlms' ),
'BIF' => __( 'FBu', 'lifterlms' ),
'BMD' => __( '$', 'lifterlms' ),
'BND' => __( 'B$', 'lifterlms' ),
'BOB' => __( 'Bs.', 'lifterlms' ),
'BRL' => __( 'R$', 'lifterlms' ),
'BSD' => __( 'B$', 'lifterlms' ),
'BTC' => __( '₿', 'lifterlms' ),
'BTN' => __( 'Nu.', 'lifterlms' ),
'BWP' => __( 'P', 'lifterlms' ),
'BYN' => __( 'Br', 'lifterlms' ),
'BZD' => __( '$', 'lifterlms' ),
'CAD' => __( '$', 'lifterlms' ),
'CDF' => __( 'FC', 'lifterlms' ),
'CHF' => __( 'CHF', 'lifterlms' ),
'CLP' => __( '$', 'lifterlms' ),
'CNY' => __( '¥', 'lifterlms' ),
'COP' => __( '$', 'lifterlms' ),
'CRC' => __( '₡', 'lifterlms' ),
'CUC' => __( 'CUC', 'lifterlms' ),
'CUP' => __( '$', 'lifterlms' ),
'CVE' => __( '$', 'lifterlms' ),
'CZK' => __( 'Kč', 'lifterlms' ),
'DJF' => __( 'Fdj', 'lifterlms' ),
'DKK' => __( 'Kr.', 'lifterlms' ),
'DOP' => __( '$', 'lifterlms' ),
'DZD' => __( 'دج', 'lifterlms' ),
'EGP' => __( 'ج.م', 'lifterlms' ),
'ERN' => __( 'Nfk', 'lifterlms' ),
'ETB' => __( 'Nkf', 'lifterlms' ),
'ETH' => __( 'ETH', 'lifterlms' ),
'EUR' => __( '€', 'lifterlms' ),
'FJD' => __( 'FJ$', 'lifterlms' ),
'FKP' => __( '£', 'lifterlms' ),
'GBP' => __( '£', 'lifterlms' ),
'GEL' => __( 'ლ', 'lifterlms' ),
'GHS' => __( 'GH₵', 'lifterlms' ),
'GIP' => __( '£', 'lifterlms' ),
'GMD' => __( 'D', 'lifterlms' ),
'GNF' => __( 'FG', 'lifterlms' ),
'GPP' => __( '£', 'lifterlms' ),
'GTQ' => __( 'Q', 'lifterlms' ),
'GYD' => __( '$', 'lifterlms' ),
'HKD' => __( '$', 'lifterlms' ),
'HNL' => __( 'L', 'lifterlms' ),
'HRK' => __( 'kn', 'lifterlms' ),
'HTG' => __( 'G', 'lifterlms' ),
'HUF' => __( 'Ft', 'lifterlms' ),
'IDR' => __( 'Rp', 'lifterlms' ),
'ILS' => __( '₪', 'lifterlms' ),
'IMP' => __( '£', 'lifterlms' ),
'INR' => __( '₹', 'lifterlms' ),
'IQD' => __( 'د.ع', 'lifterlms' ),
'IRR' => __( '﷼', 'lifterlms' ),
'ISK' => __( 'kr', 'lifterlms' ),
'JEP' => __( '£', 'lifterlms' ),
'JMD' => __( 'J$', 'lifterlms' ),
'JOD' => __( 'ا.د', 'lifterlms' ),
'JPY' => __( '¥', 'lifterlms' ),
'KES' => __( 'KSh', 'lifterlms' ),
'KGS' => __( 'лв', 'lifterlms' ),
'KHR' => __( 'KHR', 'lifterlms' ),
'KMF' => __( 'CF', 'lifterlms' ),
'KPW' => __( '₩', 'lifterlms' ),
'KRW' => __( '₩', 'lifterlms' ),
'KWD' => __( 'ك.د', 'lifterlms' ),
'KYD' => __( '$', 'lifterlms' ),
// 'KZT' symbol manually updated, see https://github.com/gocodebox/lifterlms/issues/2475.
'KZT' => __( '₸', 'lifterlms' ),
'LAK' => __( '₭', 'lifterlms' ),
'LBP' => __( '£', 'lifterlms' ),
'LKR' => __( 'Rs', 'lifterlms' ),
'LRD' => __( '$', 'lifterlms' ),
'LSL' => __( 'L', 'lifterlms' ),
'LTC' => __( 'LTC', 'lifterlms' ),
'LYD' => __( 'د.ل', 'lifterlms' ),
'MAD' => __( 'MAD', 'lifterlms' ),
'MDL' => __( 'L', 'lifterlms' ),
'MGA' => __( 'Ar', 'lifterlms' ),
'MKD' => __( 'ден', 'lifterlms' ),
'MMK' => __( 'K', 'lifterlms' ),
'MNT' => __( '₮', 'lifterlms' ),
'MOP' => __( '$', 'lifterlms' ),
'MRO' => __( 'MRU', 'lifterlms' ),
'MUR' => __( '₨', 'lifterlms' ),
'MVR' => __( 'Rf', 'lifterlms' ),
'MWK' => __( 'MK', 'lifterlms' ),
'MXN' => __( '$', 'lifterlms' ),
'MYR' => __( 'RM', 'lifterlms' ),
'MZN' => __( 'MT', 'lifterlms' ),
'NAD' => __( '$', 'lifterlms' ),
'NGN' => __( '₦', 'lifterlms' ),
'NIO' => __( 'C$', 'lifterlms' ),
'NOK' => __( 'kr', 'lifterlms' ),
'NPR' => __( '₨', 'lifterlms' ),
'NZD' => __( '$', 'lifterlms' ),
'OMR' => __( '.ع.ر', 'lifterlms' ),
'PAB' => __( 'B/.', 'lifterlms' ),
'PEN' => __( 'S/.', 'lifterlms' ),
'PGK' => __( 'K', 'lifterlms' ),
'PHP' => __( '₱', 'lifterlms' ),
'PKR' => __( '₨', 'lifterlms' ),
'PLN' => __( 'zł', 'lifterlms' ),
'PRB' => __( '₽', 'lifterlms' ),
'PYG' => __( '₲', 'lifterlms' ),
'QAR' => __( 'ق.ر', 'lifterlms' ),
'RON' => __( 'lei', 'lifterlms' ),
'RSD' => __( 'din', 'lifterlms' ),
'RUB' => __( '₽', 'lifterlms' ),
'RWF' => __( 'FRw', 'lifterlms' ),
'SAR' => __( '﷼', 'lifterlms' ),
'SBD' => __( 'Si$', 'lifterlms' ),
'SCR' => __( 'SRe', 'lifterlms' ),
'SDG' => __( '.س.ج', 'lifterlms' ),
'SEK' => __( 'kr', 'lifterlms' ),
'SGD' => __( '$', 'lifterlms' ),
'SHP' => __( '£', 'lifterlms' ),
'SLL' => __( 'Le', 'lifterlms' ),
'SOS' => __( 'Sh.so.', 'lifterlms' ),
'SRD' => __( '$', 'lifterlms' ),
'SSP' => __( '£', 'lifterlms' ),
'STD' => __( 'Db', 'lifterlms' ),
'SYP' => __( 'LS', 'lifterlms' ),
'SZL' => __( 'E', 'lifterlms' ),
'THB' => __( '฿', 'lifterlms' ),
'TJS' => __( 'SM', 'lifterlms' ),
'TMT' => __( 'T', 'lifterlms' ),
'TND' => __( 'ت.د', 'lifterlms' ),
'TOP' => __( '$', 'lifterlms' ),
'TRY' => __( '₺', 'lifterlms' ),
'TTD' => __( '$', 'lifterlms' ),
'TWD' => __( '$', 'lifterlms' ),
'TZS' => __( 'TSh', 'lifterlms' ),
'UAH' => __( '₴', 'lifterlms' ),
'UGX' => __( 'USh', 'lifterlms' ),
'USD' => __( '$', 'lifterlms' ),
'UYU' => __( '$', 'lifterlms' ),
'UZS' => __( 'лв', 'lifterlms' ),
'VEF' => __( 'Bs', 'lifterlms' ),
'VND' => __( '₫', 'lifterlms' ),
'VUV' => __( 'VT', 'lifterlms' ),
'WST' => __( 'SAT', 'lifterlms' ),
'XAF' => __( 'FCFA', 'lifterlms' ),
'XCD' => __( '$', 'lifterlms' ),
'XOF' => __( 'CFA', 'lifterlms' ),
'XPF' => __( '₣', 'lifterlms' ),
'YER' => __( '﷼', 'lifterlms' ),
'ZAR' => __( 'R', 'lifterlms' ),
'ZMW' => __( 'ZK', 'lifterlms' ),
'ZWL' => __( '$', 'lifterlms' ),
);
================================================
FILE: languages/states.php
================================================
<?php
/**
* States
*
* Returns an array of country states. This deprecates and replaces the /states/ directory found in older versions.
*
* States should be defined in English and translated native through localisation files.
*
* Country codes and states (or province) names should follow the Unicode CLDR recommendation (https://cldr.unicode.org/translation/displaynames/countryregion-territory-names).
*
* Countries defined with empty arrays have no states. These should also be defined in countries-address-info.php to mark the state field as not required and hidden.
*
* @package WooCommerce\i18n
* @version 3.8.0
*/
defined( 'ABSPATH' ) || exit;
return array(
'AF' => array(),
'AL' => array( // Albanian states.
'AL-01' => __( 'Berat', 'lifterlms' ),
'AL-09' => __( 'Dibër', 'lifterlms' ),
'AL-02' => __( 'Durrës', 'lifterlms' ),
'AL-03' => __( 'Elbasan', 'lifterlms' ),
'AL-04' => __( 'Fier', 'lifterlms' ),
'AL-05' => __( 'Gjirokastër', 'lifterlms' ),
'AL-06' => __( 'Korçë', 'lifterlms' ),
'AL-07' => __( 'Kukës', 'lifterlms' ),
'AL-08' => __( 'Lezhë', 'lifterlms' ),
'AL-10' => __( 'Shkodër', 'lifterlms' ),
'AL-11' => __( 'Tirana', 'lifterlms' ),
'AL-12' => __( 'Vlorë', 'lifterlms' ),
),
'AO' => array( // Angolan states.
'BGO' => __( 'Bengo', 'lifterlms' ),
'BLU' => __( 'Benguela', 'lifterlms' ),
'BIE' => __( 'Bié', 'lifterlms' ),
'CAB' => __( 'Cabinda', 'lifterlms' ),
'CNN' => __( 'Cunene', 'lifterlms' ),
'HUA' => __( 'Huambo', 'lifterlms' ),
'HUI' => __( 'Huíla', 'lifterlms' ),
'CCU' => __( 'Kuando Kubango', 'lifterlms' ),
'CNO' => __( 'Kwanza-Norte', 'lifterlms' ),
'CUS' => __( 'Kwanza-Sul', 'lifterlms' ),
'LUA' => __( 'Luanda', 'lifterlms' ),
'LNO' => __( 'Lunda-Norte', 'lifterlms' ),
'LSU' => __( 'Lunda-Sul', 'lifterlms' ),
'MAL' => __( 'Malanje', 'lifterlms' ),
'MOX' => __( 'Moxico', 'lifterlms' ),
'NAM' => __( 'Namibe', 'lifterlms' ),
'UIG' => __( 'Uíge', 'lifterlms' ),
'ZAI' => __( 'Zaire', 'lifterlms' ),
),
'AR' => array( // Argentinian provinces.
'C' => __( 'Ciudad Autónoma de Buenos Aires', 'lifterlms' ),
'B' => __( 'Buenos Aires', 'lifterlms' ),
'K' => __( 'Catamarca', 'lifterlms' ),
'H' => __( 'Chaco', 'lifterlms' ),
'U' => __( 'Chubut', 'lifterlms' ),
'X' => __( 'Córdoba', 'lifterlms' ),
'W' => __( 'Corrientes', 'lifterlms' ),
'E' => __( 'Entre Ríos', 'lifterlms' ),
'P' => __( 'Formosa', 'lifterlms' ),
'Y' => __( 'Jujuy', 'lifterlms' ),
'L' => __( 'La Pampa', 'lifterlms' ),
'F' => __( 'La Rioja', 'lifterlms' ),
'M' => __( 'Mendoza', 'lifterlms' ),
'N' => __( 'Misiones', 'lifterlms' ),
'Q' => __( 'Neuquén', 'lifterlms' ),
'R' => __( 'Río Negro', 'lifterlms' ),
'A' => __( 'Salta', 'lifterlms' ),
'J' => __( 'San Juan', 'lifterlms' ),
'D' => __( 'San Luis', 'lifterlms' ),
'Z' => __( 'Santa Cruz', 'lifterlms' ),
'S' => __( 'Santa Fe', 'lifterlms' ),
'G' => __( 'Santiago del Estero', 'lifterlms' ),
'V' => __( 'Tierra del Fuego', 'lifterlms' ),
'T' => __( 'Tucumán', 'lifterlms' ),
),
'AT' => array(),
'AU' => array( // Australian states.
'ACT' => __( 'Australian Capital Territory', 'lifterlms' ),
'NSW' => __( 'New South Wales', 'lifterlms' ),
'NT' => __( 'Northern Territory', 'lifterlms' ),
'QLD' => __( 'Queensland', 'lifterlms' ),
'SA' => __( 'South Australia', 'lifterlms' ),
'TAS' => __( 'Tasmania', 'lifterlms' ),
'VIC' => __( 'Victoria', 'lifterlms' ),
'WA' => __( 'Western Australia', 'lifterlms' ),
),
'AX' => array(),
'BD' => array( // Bangladeshi districts.
'BD-05' => __( 'Bagerhat', 'lifterlms' ),
'BD-01' => __( 'Bandarban', 'lifterlms' ),
'BD-02' => __( 'Barguna', 'lifterlms' ),
'BD-06' => __( 'Barishal', 'lifterlms' ),
'BD-07' => __( 'Bhola', 'lifterlms' ),
'BD-03' => __( 'Bogura', 'lifterlms' ),
'BD-04' => __( 'Brahmanbaria', 'lifterlms' ),
'BD-09' => __( 'Chandpur', 'lifterlms' ),
'BD-10' => __( 'Chattogram', 'lifterlms' ),
'BD-12' => __( 'Chuadanga', 'lifterlms' ),
'BD-11' => __( "Cox's Bazar", 'lifterlms' ),
'BD-08' => __( 'Cumilla', 'lifterlms' ),
'BD-13' => __( 'Dhaka', 'lifterlms' ),
'BD-14' => __( 'Dinajpur', 'lifterlms' ),
'BD-15' => __( 'Faridpur ', 'lifterlms' ),
'BD-16' => __( 'Feni', 'lifterlms' ),
'BD-19' => __( 'Gaibandha', 'lifterlms' ),
'BD-18' => __( 'Gazipur', 'lifterlms' ),
'BD-17' => __( 'Gopalganj', 'lifterlms' ),
'BD-20' => __( 'Habiganj', 'lifterlms' ),
'BD-21' => __( 'Jamalpur', 'lifterlms' ),
'BD-22' => __( 'Jashore', 'lifterlms' ),
'BD-25' => __( 'Jhalokati', 'lifterlms' ),
'BD-23' => __( 'Jhenaidah', 'lifterlms' ),
'BD-24' => __( 'Joypurhat', 'lifterlms' ),
'BD-29' => __( 'Khagrachhari', 'lifterlms' ),
'BD-27' => __( 'Khulna', 'lifterlms' ),
'BD-26' => __( 'Kishoreganj', 'lifterlms' ),
'BD-28' => __( 'Kurigram', 'lifterlms' ),
'BD-30' => __( 'Kushtia', 'lifterlms' ),
'BD-31' => __( 'Lakshmipur', 'lifterlms' ),
'BD-32' => __( 'Lalmonirhat', 'lifterlms' ),
'BD-36' => __( 'Madaripur', 'lifterlms' ),
'BD-37' => __( 'Magura', 'lifterlms' ),
'BD-33' => __( 'Manikganj ', 'lifterlms' ),
'BD-39' => __( 'Meherpur', 'lifterlms' ),
'BD-38' => __( 'Moulvibazar', 'lifterlms' ),
'BD-35' => __( 'Munshiganj', 'lifterlms' ),
'BD-34' => __( 'Mymensingh', 'lifterlms' ),
'BD-48' => __( 'Naogaon', 'lifterlms' ),
'BD-43' => __( 'Narail', 'lifterlms' ),
'BD-40' => __( 'Narayanganj', 'lifterlms' ),
'BD-42' => __( 'Narsingdi', 'lifterlms' ),
'BD-44' => __( 'Natore', 'lifterlms' ),
'BD-45' => __( 'Nawabganj', 'lifterlms' ),
'BD-41' => __( 'Netrakona', 'lifterlms' ),
'BD-46' => __( 'Nilphamari', 'lifterlms' ),
'BD-47' => __( 'Noakhali', 'lifterlms' ),
'BD-49' => __( 'Pabna', 'lifterlms' ),
'BD-52' => __( 'Panchagarh', 'lifterlms' ),
'BD-51' => __( 'Patuakhali', 'lifterlms' ),
'BD-50' => __( 'Pirojpur', 'lifterlms' ),
'BD-53' => __( 'Rajbari', 'lifterlms' ),
'BD-54' => __( 'Rajshahi', 'lifterlms' ),
'BD-56' => __( 'Rangamati', 'lifterlms' ),
'BD-55' => __( 'Rangpur', 'lifterlms' ),
'BD-58' => __( 'Satkhira', 'lifterlms' ),
'BD-62' => __( 'Shariatpur', 'lifterlms' ),
'BD-57' => __( 'Sherpur', 'lifterlms' ),
'BD-59' => __( 'Sirajganj', 'lifterlms' ),
'BD-61' => __( 'Sunamganj', 'lifterlms' ),
'BD-60' => __( 'Sylhet', 'lifterlms' ),
'BD-63' => __( 'Tangail', 'lifterlms' ),
'BD-64' => __( 'Thakurgaon', 'lifterlms' ),
),
'BE' => array(),
'BG' => array( // Bulgarian states.
'BG-01' => __( 'Blagoevgrad', 'lifterlms' ),
'BG-02' => __( 'Burgas', 'lifterlms' ),
'BG-08' => __( 'Dobrich', 'lifterlms' ),
'BG-07' => __( 'Gabrovo', 'lifterlms' ),
'BG-26' => __( 'Haskovo', 'lifterlms' ),
'BG-09' => __( 'Kardzhali', 'lifterlms' ),
'BG-10' => __( 'Kyustendil', 'lifterlms' ),
'BG-11' => __( 'Lovech', 'lifterlms' ),
'BG-12' => __( 'Montana', 'lifterlms' ),
'BG-13' => __( 'Pazardzhik', 'lifterlms' ),
'BG-14' => __( 'Pernik', 'lifterlms' ),
'BG-15' => __( 'Pleven', 'lifterlms' ),
'BG-16' => __( 'Plovdiv', 'lifterlms' ),
'BG-17' => __( 'Razgrad', 'lifterlms' ),
'BG-18' => __( 'Ruse', 'lifterlms' ),
'BG-27' => __( 'Shumen', 'lifterlms' ),
'BG-19' => __( 'Silistra', 'lifterlms' ),
'BG-20' => __( 'Sliven', 'lifterlms' ),
'BG-21' => __( 'Smolyan', 'lifterlms' ),
'BG-23' => __( 'Sofia District', 'lifterlms' ),
'BG-22' => __( 'Sofia', 'lifterlms' ),
'BG-24' => __( 'Stara Zagora', 'lifterlms' ),
'BG-25' => __( 'Targovishte', 'lifterlms' ),
'BG-03' => __( 'Varna', 'lifterlms' ),
'BG-04' => __( 'Veliko Tarnovo', 'lifterlms' ),
'BG-05' => __( 'Vidin', 'lifterlms' ),
'BG-06' => __( 'Vratsa', 'lifterlms' ),
'BG-28' => __( 'Yambol', 'lifterlms' ),
),
'BH' => array(),
'BI' => array(),
'BJ' => array( // Beninese states.
'AL' => __( 'Alibori', 'lifterlms' ),
'AK' => __( 'Atakora', 'lifterlms' ),
'AQ' => __( 'Atlantique', 'lifterlms' ),
'BO' => __( 'Borgou', 'lifterlms' ),
'CO' => __( 'Collines', 'lifterlms' ),
'KO' => __( 'Kouffo', 'lifterlms' ),
'DO' => __( 'Donga', 'lifterlms' ),
'LI' => __( 'Littoral', 'lifterlms' ),
'MO' => __( 'Mono', 'lifterlms' ),
'OU' => __( 'Ouémé', 'lifterlms' ),
'PL' => __( 'Plateau', 'lifterlms' ),
'ZO' => __( 'Zou', 'lifterlms' ),
),
'BO' => array( // Bolivian states.
'BO-B' => __( 'Beni', 'lifterlms' ),
'BO-H' => __( 'Chuquisaca', 'lifterlms' ),
'BO-C' => __( 'Cochabamba', 'lifterlms' ),
'BO-L' => __( 'La Paz', 'lifterlms' ),
'BO-O' => __( 'Oruro', 'lifterlms' ),
'BO-N' => __( 'Pando', 'lifterlms' ),
'BO-P' => __( 'Potosí', 'lifterlms' ),
'BO-S' => __( 'Santa Cruz', 'lifterlms' ),
'BO-T' => __( 'Tarija', 'lifterlms' ),
),
'BR' => array( // Brazilian states.
'AC' => __( 'Acre', 'lifterlms' ),
'AL' => __( 'Alagoas', 'lifterlms' ),
'AP' => __( 'Amapá', 'lifterlms' ),
'AM' => __( 'Amazonas', 'lifterlms' ),
'BA' => __( 'Bahia', 'lifterlms' ),
'CE' => __( 'Ceará', 'lifterlms' ),
'DF' => __( 'Distrito Federal', 'lifterlms' ),
'ES' => __( 'Espírito Santo', 'lifterlms' ),
'GO' => __( 'Goiás', 'lifterlms' ),
'MA' => __( 'Maranhão', 'lifterlms' ),
'MT' => __( 'Mato Grosso', 'lifterlms' ),
'MS' => __( 'Mato Grosso do Sul', 'lifterlms' ),
'MG' => __( 'Minas Gerais', 'lifterlms' ),
'PA' => __( 'Pará', 'lifterlms' ),
'PB' => __( 'Paraíba', 'lifterlms' ),
'PR' => __( 'Paraná', 'lifterlms' ),
'PE' => __( 'Pernambuco', 'lifterlms' ),
'PI' => __( 'Piauí', 'lifterlms' ),
'RJ' => __( 'Rio de Janeiro', 'lifterlms' ),
'RN' => __( 'Rio Grande do Norte', 'lifterlms' ),
'RS' => __( 'Rio Grande do Sul', 'lifterlms' ),
'RO' => __( 'Rondônia', 'lifterlms' ),
'RR' => __( 'Roraima', 'lifterlms' ),
'SC' => __( 'Santa Catarina', 'lifterlms' ),
'SP' => __( 'São Paulo', 'lifterlms' ),
'SE' => __( 'Sergipe', 'lifterlms' ),
'TO' => __( 'Tocantins', 'lifterlms' ),
),
'CA' => array( // Canadian states.
'AB' => __( 'Alberta', 'lifterlms' ),
'BC' => __( 'British Columbia', 'lifterlms' ),
'MB' => __( 'Manitoba', 'lifterlms' ),
'NB' => __( 'New Brunswick', 'lifterlms' ),
'NL' => __( 'Newfoundland and Labrador', 'lifterlms' ),
'NT' => __( 'Northwest Territories', 'lifterlms' ),
'NS' => __( 'Nova Scotia', 'lifterlms' ),
'NU' => __( 'Nunavut', 'lifterlms' ),
'ON' => __( 'Ontario', 'lifterlms' ),
'PE' => __( 'Prince Edward Island', 'lifterlms' ),
'QC' => __( 'Quebec', 'lifterlms' ),
'SK' => __( 'Saskatchewan', 'lifterlms' ),
'YT' => __( 'Yukon Territory', 'lifterlms' ),
),
'CH' => array( // Swiss cantons.
'AG' => __( 'Aargau', 'lifterlms' ),
'AR' => __( 'Appenzell Ausserrhoden', 'lifterlms' ),
'AI' => __( 'Appenzell Innerrhoden', 'lifterlms' ),
'BL' => __( 'Basel-Landschaft', 'lifterlms' ),
'BS' => __( 'Basel-Stadt', 'lifterlms' ),
'BE' => __( 'Bern', 'lifterlms' ),
'FR' => __( 'Fribourg', 'lifterlms' ),
'GE' => __( 'Geneva', 'lifterlms' ),
'GL' => __( 'Glarus', 'lifterlms' ),
'GR' => __( 'Graubünden', 'lifterlms' ),
'JU' => __( 'Jura', 'lifterlms' ),
'LU' => __( 'Luzern', 'lifterlms' ),
'NE' => __( 'Neuchâtel', 'lifterlms' ),
'NW' => __( 'Nidwalden', 'lifterlms' ),
'OW' => __( 'Obwalden', 'lifterlms' ),
'SH' => __( 'Schaffhausen', 'lifterlms' ),
'SZ' => __( 'Schwyz', 'lifterlms' ),
'SO' => __( 'Solothurn', 'lifterlms' ),
'SG' => __( 'St. Gallen', 'lifterlms' ),
'TG' => __( 'Thurgau', 'lifterlms' ),
'TI' => __( 'Ticino', 'lifterlms' ),
'UR' => __( 'Uri', 'lifterlms' ),
'VS' => __( 'Valais', 'lifterlms' ),
'VD' => __( 'Vaud', 'lifterlms' ),
'ZG' => __( 'Zug', 'lifterlms' ),
'ZH' => __( 'Zürich', 'lifterlms' ),
),
'CL' => array( // Chilean states.
'CL-AI' => __( 'Aisén del General Carlos Ibañez del Campo', 'lifterlms' ),
'CL-AN' => __( 'Antofagasta', 'lifterlms' ),
'CL-AP' => __( 'Arica y Parinacota', 'lifterlms' ),
'CL-AR' => __( 'La Araucanía', 'lifterlms' ),
'CL-AT' => __( 'Atacama', 'lifterlms' ),
'CL-BI' => __( 'Biobío', 'lifterlms' ),
'CL-CO' => __( 'Coquimbo', 'lifterlms' ),
'CL-LI' => __( 'Libertador General Bernardo O\'Higgins', 'lifterlms' ),
'CL-LL' => __( 'Los Lagos', 'lifterlms' ),
'CL-LR' => __( 'Los Ríos', 'lifterlms' ),
'CL-MA' => __( 'Magallanes', 'lifterlms' ),
'CL-ML' => __( 'Maule', 'lifterlms' ),
'CL-NB' => __( 'Ñuble', 'lifterlms' ),
'CL-RM' => __( 'Región Metropolitana de Santiago', 'lifterlms' ),
'CL-TA' => __( 'Tarapacá', 'lifterlms' ),
'CL-VS' => __( 'Valparaíso', 'lifterlms' ),
),
'CN' => array( // Chinese states.
'CN1' => __( 'Yunnan / 云南', 'lifterlms' ),
'CN2' => __( 'Beijing / 北京', 'lifterlms' ),
'CN3' => __( 'Tianjin / 天津', 'lifterlms' ),
'CN4' => __( 'Hebei / 河北', 'lifterlms' ),
'CN5' => __( 'Shanxi / 山西', 'lifterlms' ),
'CN6' => __( 'Inner Mongolia / 內蒙古', 'lifterlms' ),
'CN7' => __( 'Liaoning / 辽宁', 'lifterlms' ),
'CN8' => __( 'Jilin / 吉林', 'lifterlms' ),
'CN9' => __( 'Heilongjiang / 黑龙江', 'lifterlms' ),
'CN10' => __( 'Shanghai / 上海', 'lifterlms' ),
'CN11' => __( 'Jiangsu / 江苏', 'lifterlms' ),
'CN12' => __( 'Zhejiang / 浙江', 'lifterlms' ),
'CN13' => __( 'Anhui / 安徽', 'lifterlms' ),
'CN14' => __( 'Fujian / 福建', 'lifterlms' ),
'CN15' => __( 'Jiangxi / 江西', 'lifterlms' ),
'CN16' => __( 'Shandong / 山东', 'lifterlms' ),
'CN17' => __( 'Henan / 河南', 'lifterlms' ),
'CN18' => __( 'Hubei / 湖北', 'lifterlms' ),
'CN19' => __( 'Hunan / 湖南', 'lifterlms' ),
'CN20' => __( 'Guangdong / 广东', 'lifterlms' ),
'CN21' => __( 'Guangxi Zhuang / 广西壮族', 'lifterlms' ),
'CN22' => __( 'Hainan / 海南', 'lifterlms' ),
'CN23' => __( 'Chongqing / 重庆', 'lifterlms' ),
'CN24' => __( 'Sichuan / 四川', 'lifterlms' ),
'CN25' => __( 'Guizhou / 贵州', 'lifterlms' ),
'CN26' => __( 'Shaanxi / 陕西', 'lifterlms' ),
'CN27' => __( 'Gansu / 甘肃', 'lifterlms' ),
'CN28' => __( 'Qinghai / 青海', 'lifterlms' ),
'CN29' => __( 'Ningxia Hui / 宁夏', 'lifterlms' ),
'CN30' => __( 'Macao / 澳门', 'lifterlms' ),
'CN31' => __( 'Tibet / 西藏', 'lifterlms' ),
'CN32' => __( 'Xinjiang / 新疆', 'lifterlms' ),
),
'CO' => array( // Colombian states.
'CO-AMA' => __( 'Amazonas', 'lifterlms' ),
'CO-ANT' => __( 'Antioquia', 'lifterlms' ),
'CO-ARA' => __( 'Arauca', 'lifterlms' ),
'CO-ATL' => __( 'Atlántico', 'lifterlms' ),
'CO-BOL' => __( 'Bolívar', 'lifterlms' ),
'CO-BOY' => __( 'Boyacá', 'lifterlms' ),
'CO-CAL' => __( 'Caldas', 'lifterlms' ),
'CO-CAQ' => __( 'Caquetá', 'lifterlms' ),
'CO-CAS' => __( 'Casanare', 'lifterlms' ),
'CO-CAU' => __( 'Cauca', 'lifterlms' ),
'CO-CES' => __( 'Cesar', 'lifterlms' ),
'CO-CHO' => __( 'Chocó', 'lifterlms' ),
'CO-COR' => __( 'Córdoba', 'lifterlms' ),
'CO-CUN' => __( 'Cundinamarca', 'lifterlms' ),
'CO-DC' => __( 'Capital District', 'lifterlms' ),
'CO-GUA' => __( 'Guainía', 'lifterlms' ),
'CO-GUV' => __( 'Guaviare', 'lifterlms' ),
'CO-HUI' => __( 'Huila', 'lifterlms' ),
'CO-LAG' => __( 'La Guajira', 'lifterlms' ),
'CO-MAG' => __( 'Magdalena', 'lifterlms' ),
'CO-MET' => __( 'Meta', 'lifterlms' ),
'CO-NAR' => __( 'Nariño', 'lifterlms' ),
'CO-NSA' => __( 'Norte de Santander', 'lifterlms' ),
'CO-PUT' => __( 'Putumayo', 'lifterlms' ),
'CO-QUI' => __( 'Quindío', 'lifterlms' ),
'CO-RIS' => __( 'Risaralda', 'lifterlms' ),
'CO-SAN' => __( 'Santander', 'lifterlms' ),
'CO-SAP' => __( 'San Andrés & Providencia', 'lifterlms' ),
'CO-SUC' => __( 'Sucre', 'lifterlms' ),
'CO-TOL' => __( 'Tolima', 'lifterlms' ),
'CO-VAC' => __( 'Valle del Cauca', 'lifterlms' ),
'CO-VAU' => __( 'Vaupés', 'lifterlms' ),
'CO-VID' => __( 'Vichada', 'lifterlms' ),
),
'CR' => array( // Costa Rican states.
'CR-A' => __( 'Alajuela', 'lifterlms' ),
'CR-C' => __( 'Cartago', 'lifterlms' ),
'CR-G' => __( 'Guanacaste', 'lifterlms' ),
'CR-H' => __( 'Heredia', 'lifterlms' ),
'CR-L' => __( 'Limón', 'lifterlms' ),
'CR-P' => __( 'Puntarenas', 'lifterlms' ),
'CR-SJ' => __( 'San José', 'lifterlms' ),
),
'CZ' => array(),
'DE' => array( // German states.
'DE-BW' => __( 'Baden-Württemberg', 'lifterlms' ),
'DE-BY' => __( 'Bavaria', 'lifterlms' ),
'DE-BE' => __( 'Berlin', 'lifterlms' ),
'DE-BB' => __( 'Brandenburg', 'lifterlms' ),
'DE-HB' => __( 'Bremen', 'lifterlms' ),
'DE-HH' => __( 'Hamburg', 'lifterlms' ),
'DE-HE' => __( 'Hesse', 'lifterlms' ),
'DE-MV' => __( 'Mecklenburg-Vorpommern', 'lifterlms' ),
'DE-NI' => __( 'Lower Saxony', 'lifterlms' ),
'DE-NW' => __( 'North Rhine-Westphalia', 'lifterlms' ),
'DE-RP' => __( 'Rhineland-Palatinate', 'lifterlms' ),
'DE-SL' => __( 'Saarland', 'lifterlms' ),
'DE-SN' => __( 'Saxony', 'lifterlms' ),
'DE-ST' => __( 'Saxony-Anhalt', 'lifterlms' ),
'DE-SH' => __( 'Schleswig-Holstein', 'lifterlms' ),
'DE-TH' => __( 'Thuringia', 'lifterlms' ),
),
'DK' => array(),
'DO' => array( // Dominican states.
'DO-01' => __( 'Distrito Nacional', 'lifterlms' ),
'DO-02' => __( 'Azua', 'lifterlms' ),
'DO-03' => __( 'Baoruco', 'lifterlms' ),
'DO-04' => __( 'Barahona', 'lifterlms' ),
'DO-33' => __( 'Cibao Nordeste', 'lifterlms' ),
'DO-34' => __( 'Cibao Noroeste', 'lifterlms' ),
'DO-35' => __( 'Cibao Norte', 'lifterlms' ),
'DO-36' => __( 'Cibao Sur', 'lifterlms' ),
'DO-05' => __( 'Dajabón', 'lifterlms' ),
'DO-06' => __( 'Duarte', 'lifterlms' ),
'DO-08' => __( 'El Seibo', 'lifterlms' ),
'DO-37' => __( 'El Valle', 'lifterlms' ),
'DO-07' => __( 'Elías Piña', 'lifterlms' ),
'DO-38' => __( 'Enriquillo', 'lifterlms' ),
'DO-09' => __( 'Espaillat', 'lifterlms' ),
'DO-30' => __( 'Hato Mayor', 'lifterlms' ),
'DO-19' => __( 'Hermanas Mirabal', 'lifterlms' ),
'DO-39' => __( 'Higüamo', 'lifterlms' ),
'DO-10' => __( 'Independencia', 'lifterlms' ),
'DO-11' => __( 'La Altagracia', 'lifterlms' ),
'DO-12' => __( 'La Romana', 'lifterlms' ),
'DO-13' => __( 'La Vega', 'lifterlms' ),
'DO-14' => __( 'María Trinidad Sánchez', 'lifterlms' ),
'DO-28' => __( 'Monseñor Nouel', 'lifterlms' ),
'DO-15' => __( 'Monte Cristi', 'lifterlms' ),
'DO-29' => __( 'Monte Plata', 'lifterlms' ),
'DO-40' => __( 'Ozama', 'lifterlms' ),
'DO-16' => __( 'Pedernales', 'lifterlms' ),
'DO-17' => __( 'Peravia', 'lifterlms' ),
'DO-18' => __( 'Puerto Plata', 'lifterlms' ),
'DO-20' => __( 'Samaná', 'lifterlms' ),
'DO-21' => __( 'San Cristóbal', 'lifterlms' ),
'DO-31' => __( 'San José de Ocoa', 'lifterlms' ),
'DO-22' => __( 'San Juan', 'lifterlms' ),
'DO-23' => __( 'San Pedro de Macorís', 'lifterlms' ),
'DO-24' => __( 'Sánchez Ramírez', 'lifterlms' ),
'DO-25' => __( 'Santiago', 'lifterlms' ),
'DO-26' => __( 'Santiago Rodríguez', 'lifterlms' ),
'DO-32' => __( 'Santo Domingo', 'lifterlms' ),
'DO-41' => __( 'Valdesia', 'lifterlms' ),
'DO-27' => __( 'Valverde', 'lifterlms' ),
'DO-42' => __( 'Yuma', 'lifterlms' ),
),
'DZ' => array( // Algerian states.
'DZ-01' => __( 'Adrar', 'lifterlms' ),
'DZ-02' => __( 'Chlef', 'lifterlms' ),
'DZ-03' => __( 'Laghouat', 'lifterlms' ),
'DZ-04' => __( 'Oum El Bouaghi', 'lifterlms' ),
'DZ-05' => __( 'Batna', 'lifterlms' ),
'DZ-06' => __( 'Béjaïa', 'lifterlms' ),
'DZ-07' => __( 'Biskra', 'lifterlms' ),
'DZ-08' => __( 'Béchar', 'lifterlms' ),
'DZ-09' => __( 'Blida', 'lifterlms' ),
'DZ-10' => __( 'Bouira', 'lifterlms' ),
'DZ-11' => __( 'Tamanghasset', 'lifterlms' ),
'DZ-12' => __( 'Tébessa', 'lifterlms' ),
'DZ-13' => __( 'Tlemcen', 'lifterlms' ),
'DZ-14' => __( 'Tiaret', 'lifterlms' ),
'DZ-15' => __( 'Tizi Ouzou', 'lifterlms' ),
'DZ-16' => __( 'Algiers', 'lifterlms' ),
'DZ-17' => __( 'Djelfa', 'lifterlms' ),
'DZ-18' => __( 'Jijel', 'lifterlms' ),
'DZ-19' => __( 'Sétif', 'lifterlms' ),
'DZ-20' => __( 'Saïda', 'lifterlms' ),
'DZ-21' => __( 'Skikda', 'lifterlms' ),
'DZ-22' => __( 'Sidi Bel Abbès', 'lifterlms' ),
'DZ-23' => __( 'Annaba', 'lifterlms' ),
'DZ-24' => __( 'Guelma', 'lifterlms' ),
'DZ-25' => __( 'Constantine', 'lifterlms' ),
'DZ-26' => __( 'Médéa', 'lifterlms' ),
'DZ-27' => __( 'Mostaganem', 'lifterlms' ),
'DZ-28' => __( 'M’Sila', 'lifterlms' ),
'DZ-29' => __( 'Mascara', 'lifterlms' ),
'DZ-30' => __( 'Ouargla', 'lifterlms' ),
'DZ-31' => __( 'Oran', 'lifterlms' ),
'DZ-32' => __( 'El Bayadh', 'lifterlms' ),
'DZ-33' => __( 'Illizi', 'lifterlms' ),
'DZ-34' => __( 'Bordj Bou Arréridj', 'lifterlms' ),
'DZ-35' => __( 'Boumerdès', 'lifterlms' ),
'DZ-36' => __( 'El Tarf', 'lifterlms' ),
'DZ-37' => __( 'Tindouf', 'lifterlms' ),
'DZ-38' => __( 'Tissemsilt', 'lifterlms' ),
'DZ-39' => __( 'El Oued', 'lifterlms' ),
'DZ-40' => __( 'Khenchela', 'lifterlms' ),
'DZ-41' => __( 'Souk Ahras', 'lifterlms' ),
'DZ-42' => __( 'Tipasa', 'lifterlms' ),
'DZ-43' => __( 'Mila', 'lifterlms' ),
'DZ-44' => __( 'Aïn Defla', 'lifterlms' ),
'DZ-45' => __( 'Naama', 'lifterlms' ),
'DZ-46' => __( 'Aïn Témouchent', 'lifterlms' ),
'DZ-47' => __( 'Ghardaïa', 'lifterlms' ),
'DZ-48' => __( 'Relizane', 'lifterlms' ),
),
'EE' => array(),
'EC' => array( // Ecuadorian states.
'EC-A' => __( 'Azuay', 'lifterlms' ),
'EC-B' => __( 'Bolívar', 'lifterlms' ),
'EC-F' => __( 'Cañar', 'lifterlms' ),
'EC-C' => __( 'Carchi', 'lifterlms' ),
'EC-H' => __( 'Chimborazo', 'lifterlms' ),
'EC-X' => __( 'Cotopaxi', 'lifterlms' ),
'EC-O' => __( 'El Oro', 'lifterlms' ),
'EC-E' => __( 'Esmeraldas', 'lifterlms' ),
'EC-W' => __( 'Galápagos', 'lifterlms' ),
'EC-G' => __( 'Guayas', 'lifterlms' ),
'EC-I' => __( 'Imbabura', 'lifterlms' ),
'EC-L' => __( 'Loja', 'lifterlms' ),
'EC-R' => __( 'Los Ríos', 'lifterlms' ),
'EC-M' => __( 'Manabí', 'lifterlms' ),
'EC-S' => __( 'Morona-Santiago', 'lifterlms' ),
'EC-N' => __( 'Napo', 'lifterlms' ),
'EC-D' => __( 'Orellana', 'lifterlms' ),
'EC-Y' => __( 'Pastaza', 'lifterlms' ),
'EC-P' => __( 'Pichincha', 'lifterlms' ),
'EC-SE' => __( 'Santa Elena', 'lifterlms' ),
'EC-SD' => __( 'Santo Domingo de los Tsáchilas', 'lifterlms' ),
'EC-U' => __( 'Sucumbíos', 'lifterlms' ),
'EC-T' => __( 'Tungurahua', 'lifterlms' ),
'EC-Z' => __( 'Zamora-Chinchipe', 'lifterlms' ),
),
'EG' => array( // Egyptian states.
'EGALX' => __( 'Alexandria', 'lifterlms' ),
'EGASN' => __( 'Aswan', 'lifterlms' ),
'EGAST' => __( 'Asyut', 'lifterlms' ),
'EGBA' => __( 'Red Sea', 'lifterlms' ),
'EGBH' => __( 'Beheira', 'lifterlms' ),
'EGBNS' => __( 'Beni Suef', 'lifterlms' ),
'EGC' => __( 'Cairo', 'lifterlms' ),
'EGDK' => __( 'Dakahlia', 'lifterlms' ),
'EGDT' => __( 'Damietta', 'lifterlms' ),
'EGFYM' => __( 'Faiyum', 'lifterlms' ),
'EGGH' => __( 'Gharbia', 'lifterlms' ),
'EGGZ' => __( 'Giza', 'lifterlms' ),
'EGIS' => __( 'Ismailia', 'lifterlms' ),
'EGJS' => __( 'South Sinai', 'lifterlms' ),
'EGKB' => __( 'Qalyubia', 'lifterlms' ),
'EGKFS' => __( 'Kafr el-Sheikh', 'lifterlms' ),
'EGKN' => __( 'Qena', 'lifterlms' ),
'EGLX' => __( 'Luxor', 'lifterlms' ),
'EGMN' => __( 'Minya', 'lifterlms' ),
'EGMNF' => __( 'Monufia', 'lifterlms' ),
'EGMT' => __( 'Matrouh', 'lifterlms' ),
'EGPTS' => __( 'Port Said', 'lifterlms' ),
'EGSHG' => __( 'Sohag', 'lifterlms' ),
'EGSHR' => __( 'Al Sharqia', 'lifterlms' ),
'EGSIN' => __( 'North Sinai', 'lifterlms' ),
'EGSUZ' => __( 'Suez', 'lifterlms' ),
'EGWAD' => __( 'New Valley', 'lifterlms' ),
),
'ES' => array( // Spanish states.
'C' => __( 'A Coruña', 'lifterlms' ),
'VI' => __( 'Araba/Álava', 'lifterlms' ),
'AB' => __( 'Albacete', 'lifterlms' ),
'A' => __( 'Alicante', 'lifterlms' ),
'AL' => __( 'Almería', 'lifterlms' ),
'O' => __( 'Asturias', 'lifterlms' ),
'AV' => __( 'Ávila', 'lifterlms' ),
'BA' => __( 'Badajoz', 'lifterlms' ),
'PM' => __( 'Baleares', 'lifterlms' ),
'B' => __( 'Barcelona', 'lifterlms' ),
'BU' => __( 'Burgos', 'lifterlms' ),
'CC' => __( 'Cáceres', 'lifterlms' ),
'CA' => __( 'Cádiz', 'lifterlms' ),
'S' => __( 'Cantabria', 'lifterlms' ),
'CS' => __( 'Castellón', 'lifterlms' ),
'CE' => __( 'Ceuta', 'lifterlms' ),
'CR' => __( 'Ciudad Real', 'lifterlms' ),
'CO' => __( 'Córdoba', 'lifterlms' ),
'CU' => __( 'Cuenca', 'lifterlms' ),
'GI' => __( 'Girona', 'lifterlms' ),
'GR' => __( 'Granada', 'lifterlms' ),
'GU' => __( 'Guadalajara', 'lifterlms' ),
'SS' => __( 'Gipuzkoa', 'lifterlms' ),
'H' => __( 'Huelva', 'lifterlms' ),
'HU' => __( 'Huesca', 'lifterlms' ),
'J' => __( 'Jaén', 'lifterlms' ),
'LO' => __( 'La Rioja', 'lifterlms' ),
'GC' => __( 'Las Palmas', 'lifterlms' ),
'LE' => __( 'León', 'lifterlms' ),
'L' => __( 'Lleida', 'lifterlms' ),
'LU' => __( 'Lugo', 'lifterlms' ),
'M' => __( 'Madrid', 'lifterlms' ),
'MA' => __( 'Málaga', 'lifterlms' ),
'ML' => __( 'Melilla', 'lifterlms' ),
'MU' => __( 'Murcia', 'lifterlms' ),
'NA' => __( 'Navarra', 'lifterlms' ),
'OR' => __( 'Ourense', 'lifterlms' ),
'P' => __( 'Palencia', 'lifterlms' ),
'PO' => __( 'Pontevedra', 'lifterlms' ),
'SA' => __( 'Salamanca', 'lifterlms' ),
'TF' => __( 'Santa Cruz de Tenerife', 'lifterlms' ),
'SG' => __( 'Segovia', 'lifterlms' ),
'SE' => __( 'Sevilla', 'lifterlms' ),
'SO' => __( 'Soria', 'lifterlms' ),
'T' => __( 'Tarragona', 'lifterlms' ),
'TE' => __( 'Teruel', 'lifterlms' ),
'TO' => __( 'Toledo', 'lifterlms' ),
'V' => __( 'Valencia', 'lifterlms' ),
'VA' => __( 'Valladolid', 'lifterlms' ),
'BI' => __( 'Biscay', 'lifterlms' ),
'ZA' => __( 'Zamora', 'lifterlms' ),
'Z' => __( 'Zaragoza', 'lifterlms' ),
),
'ET' => array(),
'FI' => array(),
'FR' => array(),
'GF' => array(),
'GH' => array( // Ghanaian regions.
'AF' => __( 'Ahafo', 'lifterlms' ),
'AH' => __( 'Ashanti', 'lifterlms' ),
'BA' => __( 'Brong-Ahafo', 'lifterlms' ),
'BO' => __( 'Bono', 'lifterlms' ),
'BE' => __( 'Bono East', 'lifterlms' ),
'CP' => __( 'Central', 'lifterlms' ),
'EP' => __( 'Eastern', 'lifterlms' ),
'AA' => __( 'Greater Accra', 'lifterlms' ),
'NE' => __( 'North East', 'lifterlms' ),
'NP' => __( 'Northern', 'lifterlms' ),
'OT' => __( 'Oti', 'lifterlms' ),
'SV' => __( 'Savannah', 'lifterlms' ),
'UE' => __( 'Upper East', 'lifterlms' ),
'UW' => __( 'Upper West', 'lifterlms' ),
'TV' => __( 'Volta', 'lifterlms' ),
'WP' => __( 'Western', 'lifterlms' ),
'WN' => __( 'Western North', 'lifterlms' ),
),
'GP' => array(),
'GR' => array( // Greek regions.
'I' => __( 'Attica', 'lifterlms' ),
'A' => __( 'East Macedonia and Thrace', 'lifterlms' ),
'B' => __( 'Central Macedonia', 'lifterlms' ),
'C' => __( 'West Macedonia', 'lifterlms' ),
'D' => __( 'Epirus', 'lifterlms' ),
'E' => __( 'Thessaly', 'lifterlms' ),
'F' => __( 'Ionian Islands', 'lifterlms' ),
'G' => __( 'West Greece', 'lifterlms' ),
'H' => __( 'Central Greece', 'lifterlms' ),
'J' => __( 'Peloponnese', 'lifterlms' ),
'K' => __( 'North Aegean', 'lifterlms' ),
'L' => __( 'South Aegean', 'lifterlms' ),
'M' => __( 'Crete', 'lifterlms' ),
),
'GT' => array( // Guatemalan states.
'GT-AV' => __( 'Alta Verapaz', 'lifterlms' ),
'GT-BV' => __( 'Baja Verapaz', 'lifterlms' ),
'GT-CM' => __( 'Chimaltenango', 'lifterlms' ),
'GT-CQ' => __( 'Chiquimula', 'lifterlms' ),
'GT-PR' => __( 'El Progreso', 'lifterlms' ),
'GT-ES' => __( 'Escuintla', 'lifterlms' ),
'GT-GU' => __( 'Guatemala', 'lifterlms' ),
'GT-HU' => __( 'Huehuetenango', 'lifterlms' ),
'GT-IZ' => __( 'Izabal', 'lifterlms' ),
'GT-JA' => __( 'Jalapa', 'lifterlms' ),
'GT-JU' => __( 'Jutiapa', 'lifterlms' ),
'GT-PE' => __( 'Petén', 'lifterlms' ),
'GT-QZ' => __( 'Quetzaltenango', 'lifterlms' ),
'GT-QC' => __( 'Quiché', 'lifterlms' ),
'GT-RE' => __( 'Retalhuleu', 'lifterlms' ),
'GT-SA' => __( 'Sacatepéquez', 'lifterlms' ),
'GT-SM' => __( 'San Marcos', 'lifterlms' ),
'GT-SR' => __( 'Santa Rosa', 'lifterlms' ),
'GT-SO' => __( 'Sololá', 'lifterlms' ),
'GT-SU' => __( 'Suchitepéquez', 'lifterlms' ),
'GT-TO' => __( 'Totonicapán', 'lifterlms' ),
'GT-ZA' => __( 'Zacapa', 'lifterlms' ),
),
'HK' => array( // Hong Kong states.
'HONG KONG' => __( 'Hong Kong Island', 'lifterlms' ),
'KOWLOON' => __( 'Kowloon', 'lifterlms' ),
'NEW TERRITORIES' => __( 'New Territories', 'lifterlms' ),
),
'HN' => array( // Honduran states.
'HN-AT' => __( 'Atlántida', 'lifterlms' ),
'HN-IB' => __( 'Bay Islands', 'lifterlms' ),
'HN-CH' => __( 'Choluteca', 'lifterlms' ),
'HN-CL' => __( 'Colón', 'lifterlms' ),
'HN-CM' => __( 'Comayagua', 'lifterlms' ),
'HN-CP' => __( 'Copán', 'lifterlms' ),
'HN-CR' => __( 'Cortés', 'lifterlms' ),
'HN-EP' => __( 'El Paraíso', 'lifterlms' ),
'HN-FM' => __( 'Francisco Morazán', 'lifterlms' ),
'HN-GD' => __( 'Gracias a Dios', 'lifterlms' ),
'HN-IN' => __( 'Intibucá', 'lifterlms' ),
'HN-LE' => __( 'Lempira', 'lifterlms' ),
'HN-LP' => __( 'La Paz', 'lifterlms' ),
'HN-OC' => __( 'Ocotepeque', 'lifterlms' ),
'HN-OL' => __( 'Olancho', 'lifterlms' ),
'HN-SB' => __( 'Santa Bárbara', 'lifterlms' ),
'HN-VA' => __( 'Valle', 'lifterlms' ),
'HN-YO' => __( 'Yoro', 'lifterlms' ),
),
'HR' => array( // Croatian counties.
'HR-01' => __( 'Zagreb County', 'lifterlms' ),
'HR-02' => __( 'Krapina-Zagorje County', 'lifterlms' ),
'HR-03' => __( 'Sisak-Moslavina County', 'lifterlms' ),
'HR-04' => __( 'Karlovac County', 'lifterlms' ),
'HR-05' => __( 'Varaždin County', 'lifterlms' ),
'HR-06' => __( 'Koprivnica-Križevci County', 'lifterlms' ),
'HR-07' => __( 'Bjelovar-Bilogora County', 'lifterlms' ),
'HR-08' => __( 'Primorje-Gorski Kotar County', 'lifterlms' ),
'HR-09' => __( 'Lika-Senj County', 'lifterlms' ),
'HR-10' => __( 'Virovitica-Podravina County', 'lifterlms' ),
'HR-11' => __( 'Požega-Slavonia County', 'lifterlms' ),
'HR-12' => __( 'Brod-Posavina County', 'lifterlms' ),
'HR-13' => __( 'Zadar County', 'lifterlms' ),
'HR-14' => __( 'Osijek-Baranja County', 'lifterlms' ),
'HR-15' => __( 'Šibenik-Knin County', 'lifterlms' ),
'HR-16' => __( 'Vukovar-Srijem County', 'lifterlms' ),
'HR-17' => __( 'Split-Dalmatia County', 'lifterlms' ),
'HR-18' => __( 'Istria County', 'lifterlms' ),
'HR-19' => __( 'Dubrovnik-Neretva County', 'lifterlms' ),
'HR-20' => __( 'Međimurje County', 'lifterlms' ),
'HR-21' => __( 'Zagreb City', 'lifterlms' ),
),
'HU' => array( // Hungarian states.
'BK' => __( 'Bács-Kiskun', 'lifterlms' ),
'BE' => __( 'Békés', 'lifterlms' ),
'BA' => __( 'Baranya', 'lifterlms' ),
'BZ' => __( 'Borsod-Abaúj-Zemplén', 'lifterlms' ),
'BU' => __( 'Budapest', 'lifterlms' ),
'CS' => __( 'Csongrád-Csanád', 'lifterlms' ),
'FE' => __( 'Fejér', 'lifterlms' ),
'GS' => __( 'Győr-Moson-Sopron', 'lifterlms' ),
'HB' => __( 'Hajdú-Bihar', 'lifterlms' ),
'HE' => __( 'Heves', 'lifterlms' ),
'JN' => __( 'Jász-Nagykun-Szolnok', 'lifterlms' ),
'KE' => __( 'Komárom-Esztergom', 'lifterlms' ),
'NO' => __( 'Nógrád', 'lifterlms' ),
'PE' => __( 'Pest', 'lifterlms' ),
'SO' => __( 'Somogy', 'lifterlms' ),
'SZ' => __( 'Szabolcs-Szatmár-Bereg', 'lifterlms' ),
'TO' => __( 'Tolna', 'lifterlms' ),
'VA' => __( 'Vas', 'lifterlms' ),
'VE' => __( 'Veszprém', 'lifterlms' ),
'ZA' => __( 'Zala', 'lifterlms' ),
),
'ID' => array( // Indonesian provinces.
'AC' => __( 'Daerah Istimewa Aceh', 'lifterlms' ),
'SU' => __( 'Sumatera Utara', 'lifterlms' ),
'SB' => __( 'Sumatera Barat', 'lifterlms' ),
'RI' => __( 'Riau', 'lifterlms' ),
'KR' => __( 'Kepulauan Riau', 'lifterlms' ),
'JA' => __( 'Jambi', 'lifterlms' ),
'SS' => __( 'Sumatera Selatan', 'lifterlms' ),
'BB' => __( 'Bangka Belitung', 'lifterlms' ),
'BE' => __( 'Bengkulu', 'lifterlms' ),
'LA' => __( 'Lampung', 'lifterlms' ),
'JK' => __( 'DKI Jakarta', 'lifterlms' ),
'JB' => __( 'Jawa Barat', 'lifterlms' ),
'BT' => __( 'Banten', 'lifterlms' ),
'JT' => __( 'Jawa Tengah', 'lifterlms' ),
'JI' => __( 'Jawa Timur', 'lifterlms' ),
'YO' => __( 'Daerah Istimewa Yogyakarta', 'lifterlms' ),
'BA' => __( 'Bali', 'lifterlms' ),
'NB' => __( 'Nusa Tenggara Barat', 'lifterlms' ),
'NT' => __( 'Nusa Tenggara Timur', 'lifterlms' ),
'KB' => __( 'Kalimantan Barat', 'lifterlms' ),
'KT' => __( 'Kalimantan Tengah', 'lifterlms' ),
'KI' => __( 'Kalimantan Timur', 'lifterlms' ),
'KS' => __( 'Kalimantan Selatan', 'lifterlms' ),
'KU' => __( 'Kalimantan Utara', 'lifterlms' ),
'SA' => __( 'Sulawesi Utara', 'lifterlms' ),
'ST' => __( 'Sulawesi Tengah', 'lifterlms' ),
'SG' => __( 'Sulawesi Tenggara', 'lifterlms' ),
'SR' => __( 'Sulawesi Barat', 'lifterlms' ),
'SN' => __( 'Sulawesi Selatan', 'lifterlms' ),
'GO' => __( 'Gorontalo', 'lifterlms' ),
'MA' => __( 'Maluku', 'lifterlms' ),
'MU' => __( 'Maluku Utara', 'lifterlms' ),
'PA' => __( 'Papua', 'lifterlms' ),
'PB' => __( 'Papua Barat', 'lifterlms' ),
),
'IE' => array( // Irish states.
'CW' => __( 'Carlow', 'lifterlms' ),
'CN' => __( 'Cavan', 'lifterlms' ),
'CE' => __( 'Clare', 'lifterlms' ),
'CO' => __( 'Cork', 'lifterlms' ),
'DL' => __( 'Donegal', 'lifterlms' ),
'D' => __( 'Dublin', 'lifterlms' ),
'G' => __( 'Galway', 'lifterlms' ),
'KY' => __( 'Kerry', 'lifterlms' ),
'KE' => __( 'Kildare', 'lifterlms' ),
'KK' => __( 'Kilkenny', 'lifterlms' ),
'LS' => __( 'Laois', 'lifterlms' ),
'LM' => __( 'Leitrim', 'lifterlms' ),
'LK' => __( 'Limerick', 'lifterlms' ),
'LD' => __( 'Longford', 'lifterlms' ),
'LH' => __( 'Louth', 'lifterlms' ),
'MO' => __( 'Mayo', 'lifterlms' ),
'MH' => __( 'Meath', 'lifterlms' ),
'MN' => __( 'Monaghan', 'lifterlms' ),
'OY' => __( 'Offaly', 'lifterlms' ),
'RN' => __( 'Roscommon', 'lifterlms' ),
'SO' => __( 'Sligo', 'lifterlms' ),
'TA' => __( 'Tipperary', 'lifterlms' ),
'WD' => __( 'Waterford', 'lifterlms' ),
'WH' => __( 'Westmeath', 'lifterlms' ),
'WX' => __( 'Wexford', 'lifterlms' ),
'WW' => __( 'Wicklow', 'lifterlms' ),
),
'IN' => array( // Indian states.
'AP' => __( 'Andhra Pradesh', 'lifterlms' ),
'AR' => __( 'Arunachal Pradesh', 'lifterlms' ),
'AS' => __( 'Assam', 'lifterlms' ),
'BR' => __( 'Bihar', 'lifterlms' ),
'CT' => __( 'Chhattisgarh', 'lifterlms' ),
'GA' => __( 'Goa', 'lifterlms' ),
'GJ' => __( 'Gujarat', 'lifterlms' ),
'HR' => __( 'Haryana', 'lifterlms' ),
'HP' => __( 'Himachal Pradesh', 'lifterlms' ),
'JK' => __( 'Jammu and Kashmir', 'lifterlms' ),
'JH' => __( 'Jharkhand', 'lifterlms' ),
'KA' => __( 'Karnataka', 'lifterlms' ),
'KL' => __( 'Kerala', 'lifterlms' ),
'LA' => __( 'Ladakh', 'lifterlms' ),
'MP' => __( 'Madhya Pradesh', 'lifterlms' ),
'MH' => __( 'Maharashtra', 'lifterlms' ),
'MN' => __( 'Manipur', 'lifterlms' ),
'ML' => __( 'Meghalaya', 'lifterlms' ),
'MZ' => __( 'Mizoram', 'lifterlms' ),
'NL' => __( 'Nagaland', 'lifterlms' ),
'OD' => __( 'Odisha', 'lifterlms' ),
'PB' => __( 'Punjab', 'lifterlms' ),
'RJ' => __( 'Rajasthan', 'lifterlms' ),
'SK' => __( 'Sikkim', 'lifterlms' ),
'TN' => __( 'Tamil Nadu', 'lifterlms' ),
'TS' => __( 'Telangana', 'lifterlms' ),
'TR' => __( 'Tripura', 'lifterlms' ),
'UK' => __( 'Uttarakhand', 'lifterlms' ),
'UP' => __( 'Uttar Pradesh', 'lifterlms' ),
'WB' => __( 'West Bengal', 'lifterlms' ),
'AN' => __( 'Andaman and Nicobar Islands', 'lifterlms' ),
'CH' => __( 'Chandigarh', 'lifterlms' ),
'DN' => __( 'Dadra and Nagar Haveli', 'lifterlms' ),
'DD' => __( 'Daman and Diu', 'lifterlms' ),
'DL' => __( 'Delhi', 'lifterlms' ),
'LD' => __( 'Lakshadeep', 'lifterlms' ),
'PY' => __( 'Pondicherry (Puducherry)', 'lifterlms' ),
),
'IR' => array( // Iranian states.
'KHZ' => __( 'Khuzestan (خوزستان)', 'lifterlms' ),
'THR' => __( 'Tehran (تهران)', 'lifterlms' ),
'ILM' => __( 'Ilaam (ایلام)', 'lifterlms' ),
'BHR' => __( 'Bushehr (بوشهر)', 'lifterlms' ),
'ADL' => __( 'Ardabil (اردبیل)', 'lifterlms' ),
'ESF' => __( 'Isfahan (اصفهان)', 'lifterlms' ),
'YZD' => __( 'Yazd (یزد)', 'lifterlms' ),
'KRH' => __( 'Kermanshah (کرمانشاه)', 'lifterlms' ),
'KRN' => __( 'Kerman (کرمان)', 'lifterlms' ),
'HDN' => __( 'Hamadan (همدان)', 'lifterlms' ),
'GZN' => __( 'Ghazvin (قزوین)', 'lifterlms' ),
'ZJN' => __( 'Zanjan (زنجان)', 'lifterlms' ),
'LRS' => __( 'Luristan (لرستان)', 'lifterlms' ),
'ABZ' => __( 'Alborz (البرز)', 'lifterlms' ),
'EAZ' => __( 'East Azarbaijan (آذربایجان شرقی)', 'lifterlms' ),
'WAZ' => __( 'West Azarbaijan (آذربایجان غربی)', 'lifterlms' ),
'CHB' => __( 'Chaharmahal and Bakhtiari (چهارمحال و بختیاری)', 'lifterlms' ),
'SKH' => __( 'South Khorasan (خراسان جنوبی)', 'lifterlms' ),
'RKH' => __( 'Razavi Khorasan (خراسان رضوی)', 'lifterlms' ),
'NKH' => __( 'North Khorasan (خراسان شمالی)', 'lifterlms' ),
'SMN' => __( 'Semnan (سمنان)', 'lifterlms' ),
'FRS' => __( 'Fars (فارس)', 'lifterlms' ),
'QHM' => __( 'Qom (قم)', 'lifterlms' ),
'KRD' => __( 'Kurdistan / کردستان)', 'lifterlms' ),
'KBD' => __( 'Kohgiluyeh and BoyerAhmad (کهگیلوییه و بویراحمد)', 'lifterlms' ),
'GLS' => __( 'Golestan (گلستان)', 'lifterlms' ),
'GIL' => __( 'Gilan (گیلان)', 'lifterlms' ),
'MZN' => __( 'Mazandaran (مازندران)', 'lifterlms' ),
'MKZ' => __( 'Markazi (مرکزی)', 'lifterlms' ),
'HRZ' => __( 'Hormozgan (هرمزگان)', 'lifterlms' ),
'SBN' => __( 'Sistan and Baluchestan (سیستان و بلوچستان)', 'lifterlms' ),
),
'IS' => array(),
'IT' => array( // Italian provinces.
'AG' => __( 'Agrigento', 'lifterlms' ),
'AL' => __( 'Alessandria', 'lifterlms' ),
'AN' => __( 'Ancona', 'lifterlms' ),
'AO' => __( 'Aosta', 'lifterlms' ),
'AR' => __( 'Arezzo', 'lifterlms' ),
'AP' => __( 'Ascoli Piceno', 'lifterlms' ),
'AT' => __( 'Asti', 'lifterlms' ),
'AV' => __( 'Avellino', 'lifterlms' ),
'BA' => __( 'Bari', 'lifterlms' ),
'BT' => __( 'Barletta-Andria-Trani', 'lifterlms' ),
'BL' => __( 'Belluno', 'lifterlms' ),
'BN' => __( 'Benevento', 'lifterlms' ),
'BG' => __( 'Bergamo', 'lifterlms' ),
'BI' => __( 'Biella', 'lifterlms' ),
'BO' => __( 'Bologna', 'lifterlms' ),
'BZ' => __( 'Bolzano', 'lifterlms' ),
'BS' => __( 'Brescia', 'lifterlms' ),
'BR' => __( 'Brindisi', 'lifterlms' ),
'CA' => __( 'Cagliari', 'lifterlms' ),
'CL' => __( 'Caltanissetta', 'lifterlms' ),
'CB' => __( 'Campobasso', 'lifterlms' ),
'CE' => __( 'Caserta', 'lifterlms' ),
'CT' => __( 'Catania', 'lifterlms' ),
'CZ' => __( 'Catanzaro', 'lifterlms' ),
'CH' => __( 'Chieti', 'lifterlms' ),
'CO' => __( 'Como', 'lifterlms' ),
'CS' => __( 'Cosenza', 'lifterlms' ),
'CR' => __( 'Cremona', 'lifterlms' ),
'KR' => __( 'Crotone', 'lifterlms' ),
'CN' => __( 'Cuneo', 'lifterlms' ),
'EN' => __( 'Enna', 'lifterlms' ),
'FM' => __( 'Fermo', 'lifterlms' ),
'FE' => __( 'Ferrara', 'lifterlms' ),
'FI' => __( 'Firenze', 'lifterlms' ),
'FG' => __( 'Foggia', 'lifterlms' ),
'FC' => __( 'Forlì-Cesena', 'lifterlms' ),
'FR' => __( 'Frosinone', 'lifterlms' ),
'GE' => __( 'Genova', 'lifterlms' ),
'GO' => __( 'Gorizia', 'lifterlms' ),
'GR' => __( 'Grosseto', 'lifterlms' ),
'IM' => __( 'Imperia', 'lifterlms' ),
'IS' => __( 'Isernia', 'lifterlms' ),
'SP' => __( 'La Spezia', 'lifterlms' ),
'AQ' => __( "L'Aquila", 'lifterlms' ),
'LT' => __( 'Latina', 'lifterlms' ),
'LE' => __( 'Lecce', 'lifterlms' ),
'LC' => __( 'Lecco', 'lifterlms' ),
'LI' => __( 'Livorno', 'lifterlms' ),
'LO' => __( 'Lodi', 'lifterlms' ),
'LU' => __( 'Lucca', 'lifterlms' ),
'MC' => __( 'Macerata', 'lifterlms' ),
'MN' => __( 'Mantova', 'lifterlms' ),
'MS' => __( 'Massa-Carrara', 'lifterlms' ),
'MT' => __( 'Matera', 'lifterlms' ),
'ME' => __( 'Messina', 'lifterlms' ),
'MI' => __( 'Milano', 'lifterlms' ),
'MO' => __( 'Modena', 'lifterlms' ),
'MB' => __( 'Monza e della Brianza', 'lifterlms' ),
'NA' => __( 'Napoli', 'lifterlms' ),
'NO' => __( 'Novara', 'lifterlms' ),
'NU' => __( 'Nuoro', 'lifterlms' ),
'OR' => __( 'Oristano', 'lifterlms' ),
'PD' => __( 'Padova', 'lifterlms' ),
'PA' => __( 'Palermo', 'lifterlms' ),
'PR' => __( 'Parma', 'lifterlms' ),
'PV' => __( 'Pavia', 'lifterlms' ),
'PG' => __( 'Perugia', 'lifterlms' ),
'PU' => __( 'Pesaro e Urbino', 'lifterlms' ),
'PE' => __( 'Pescara', 'lifterlms' ),
'PC' => __( 'Piacenza', 'lifterlms' ),
'PI' => __( 'Pisa', 'lifterlms' ),
'PT' => __( 'Pistoia', 'lifterlms' ),
'PN' => __( 'Pordenone', 'lifterlms' ),
'PZ' => __( 'Potenza', 'lifterlms' ),
'PO' => __( 'Prato', 'lifterlms' ),
'RG' => __( 'Ragusa', 'lifterlms' ),
'RA' => __( 'Ravenna', 'lifterlms' ),
'RC' => __( 'Reggio Calabria', 'lifterlms' ),
'RE' => __( 'Reggio Emilia', 'lifterlms' ),
'RI' => __( 'Rieti', 'lifterlms' ),
'RN' => __( 'Rimini', 'lifterlms' ),
'RM' => __( 'Roma', 'lifterlms' ),
'RO' => __( 'Rovigo', 'lifterlms' ),
'SA' => __( 'Salerno', 'lifterlms' ),
'SS' => __( 'Sassari', 'lifterlms' ),
'SV' => __( 'Savona', 'lifterlms' ),
'SI' => __( 'Siena', 'lifterlms' ),
'SR' => __( 'Siracusa', 'lifterlms' ),
'SO' => __( 'Sondrio', 'lifterlms' ),
'SU' => __( 'Sud Sardegna', 'lifterlms' ),
'TA' => __( 'Taranto', 'lifterlms' ),
'TE' => __( 'Teramo', 'lifterlms' ),
'TR' => __( 'Terni', 'lifterlms' ),
'TO' => __( 'Torino', 'lifterlms' ),
'TP' => __( 'Trapani', 'lifterlms' ),
'TN' => __( 'Trento', 'lifterlms' ),
'TV' => __( 'Treviso', 'lifterlms' ),
'TS' => __( 'Trieste', 'lifterlms' ),
'UD' => __( 'Udine', 'lifterlms' ),
'VA' => __( 'Varese', 'lifterlms' ),
'VE' => __( 'Venezia', 'lifterlms' ),
'VB' => __( 'Verbano-Cusio-Ossola', 'lifterlms' ),
'VC' => __( 'Vercelli', 'lifterlms' ),
'VR' => __( 'Verona', 'lifterlms' ),
'VV' => __( 'Vibo Valentia', 'lifterlms' ),
'VI' => __( 'Vicenza', 'lifterlms' ),
'VT' => __( 'Viterbo', 'lifterlms' ),
),
'IL' => array(),
'IM' => array(),
'JM' => array( // Jamaican parishes.
'JM-01' => __( 'Kingston', 'lifterlms' ),
'JM-02' => __( 'Saint Andrew', 'lifterlms' ),
'JM-03' => __( 'Saint Thomas', 'lifterlms' ),
'JM-04' => __( 'Portland', 'lifterlms' ),
'JM-05' => __( 'Saint Mary', 'lifterlms' ),
'JM-06' => __( 'Saint Ann', 'lifterlms' ),
'JM-07' => __( 'Trelawny', 'lifterlms' ),
'JM-08' => __( 'Saint James', 'lifterlms' ),
'JM-09' => __( 'Hanover', 'lifterlms' ),
'JM-10' => __( 'Westmoreland', 'lifterlms' ),
'JM-11' => __( 'Saint Elizabeth', 'lifterlms' ),
'JM-12' => __( 'Manchester', 'lifterlms' ),
'JM-13' => __( 'Clarendon', 'lifterlms' ),
'JM-14' => __( 'Saint Catherine', 'lifterlms' ),
),
/**
* Japanese states.
*
* English notation of prefectures conform to the notation of Japan Post.
* The suffix corresponds with the Japanese translation file.
*/
'JP' => array(
'JP01' => __( 'Hokkaido', 'lifterlms' ),
'JP02' => __( 'Aomori', 'lifterlms' ),
'JP03' => __( 'Iwate', 'lifterlms' ),
'JP04' => __( 'Miyagi', 'lifterlms' ),
'JP05' => __( 'Akita', 'lifterlms' ),
'JP06' => __( 'Yamagata', 'lifterlms' ),
'JP07' => __( 'Fukushima', 'lifterlms' ),
'JP08' => __( 'Ibaraki', 'lifterlms' ),
'JP09' => __( 'Tochigi', 'lifterlms' ),
'JP10' => __( 'Gunma', 'lifterlms' ),
'JP11' => __( 'Saitama', 'lifterlms' ),
'JP12' => __( 'Chiba', 'lifterlms' ),
'JP13' => __( 'Tokyo', 'lifterlms' ),
'JP14' => __( 'Kanagawa', 'lifterlms' ),
'JP15' => __( 'Niigata', 'lifterlms' ),
'JP16' => __( 'Toyama', 'lifterlms' ),
'JP17' => __( 'Ishikawa', 'lifterlms' ),
'JP18' => __( 'Fukui', 'lifterlms' ),
'JP19' => __( 'Yamanashi', 'lifterlms' ),
'JP20' => __( 'Nagano', 'lifterlms' ),
'JP21' => __( 'Gifu', 'lifterlms' ),
'JP22' => __( 'Shizuoka', 'lifterlms' ),
'JP23' => __( 'Aichi', 'lifterlms' ),
'JP24' => __( 'Mie', 'lifterlms' ),
'JP25' => __( 'Shiga', 'lifterlms' ),
'JP26' => __( 'Kyoto', 'lifterlms' ),
'JP27' => __( 'Osaka', 'lifterlms' ),
'JP28' => __( 'Hyogo', 'lifterlms' ),
'JP29' => __( 'Nara', 'lifterlms' ),
'JP30' => __( 'Wakayama', 'lifterlms' ),
'JP31' => __( 'Tottori', 'lifterlms' ),
'JP32' => __( 'Shimane', 'lifterlms' ),
'JP33' => __( 'Okayama', 'lifterlms' ),
'JP34' => __( 'Hiroshima', 'lifterlms' ),
'JP35' => __( 'Yamaguchi', 'lifterlms' ),
'JP36' => __( 'Tokushima', 'lifterlms' ),
'JP37' => __( 'Kagawa', 'lifterlms' ),
'JP38' => __( 'Ehime', 'lifterlms' ),
'JP39' => __( 'Kochi', 'lifterlms' ),
'JP40' => __( 'Fukuoka', 'lifterlms' ),
'JP41' => __( 'Saga', 'lifterlms' ),
'JP42' => __( 'Nagasaki', 'lifterlms' ),
'JP43' => __( 'Kumamoto', 'lifterlms' ),
'JP44' => __( 'Oita', 'lifterlms' ),
'JP45' => __( 'Miyazaki', 'lifterlms' ),
'JP46' => __( 'Kagoshima', 'lifterlms' ),
'JP47' => __( 'Okinawa', 'lifterlms' ),
),
'KE' => array( // Kenyan counties.
'KE01' => __( 'Baringo', 'lifterlms' ),
'KE02' => __( 'Bomet', 'lifterlms' ),
'KE03' => __( 'Bungoma', 'lifterlms' ),
'KE04' => __( 'Busia', 'lifterlms' ),
'KE05' => __( 'Elgeyo-Marakwet', 'lifterlms' ),
'KE06' => __( 'Embu', 'lifterlms' ),
'KE07' => __( 'Garissa', 'lifterlms' ),
'KE08' => __( 'Homa Bay', 'lifterlms' ),
'KE09' => __( 'Isiolo', 'lifterlms' ),
'KE10' => __( 'Kajiado', 'lifterlms' ),
'KE11' => __( 'Kakamega', 'lifterlms' ),
'KE12' => __( 'Kericho', 'lifterlms' ),
'KE13' => __( 'Kiambu', 'lifterlms' ),
'KE14' => __( 'Kilifi', 'lifterlms' ),
'KE15' => __( 'Kirinyaga', 'lifterlms' ),
'KE16' => __( 'Kisii', 'lifterlms' ),
'KE17' => __( 'Kisumu', 'lifterlms' ),
'KE18' => __( 'Kitui', 'lifterlms' ),
'KE19' => __( 'Kwale', 'lifterlms' ),
'KE20' => __( 'Laikipia', 'lifterlms' ),
'KE21' => __( 'Lamu', 'lifterlms' ),
'KE22' => __( 'Machakos', 'lifterlms' ),
'KE23' => __( 'Makueni', 'lifterlms' ),
'KE24' => __( 'Mandera', 'lifterlms' ),
'KE25' => __( 'Marsabit', 'lifterlms' ),
'KE26' => __( 'Meru', 'lifterlms' ),
'KE27' => __( 'Migori', 'lifterlms' ),
'KE28' => __( 'Mombasa', 'lifterlms' ),
'KE29' => __( 'Murang’a', 'lifterlms' ),
'KE30' => __( 'Nairobi County', 'lifterlms' ),
'KE31' => __( 'Nakuru', 'lifterlms' ),
'KE32' => __( 'Nandi', 'lifterlms' ),
'KE33' => __( 'Narok', 'lifterlms' ),
'KE34' => __( 'Nyamira', 'lifterlms' ),
'KE35' => __( 'Nyandarua', 'lifterlms' ),
'KE36' => __( 'Nyeri', 'lifterlms' ),
'KE37' => __( 'Samburu', 'lifterlms' ),
'KE38' => __( 'Siaya', 'lifterlms' ),
'KE39' => __( 'Taita-Taveta', 'lifterlms' ),
'KE40' => __( 'Tana River', 'lifterlms' ),
'KE41' => __( 'Tharaka-Nithi', 'lifterlms' ),
'KE42' => __( 'Trans Nzoia', 'lifterlms' ),
'KE43' => __( 'Turkana', 'lifterlms' ),
'KE44' => __( 'Uasin Gishu', 'lifterlms' ),
'KE45' => __( 'Vihiga', 'lifterlms' ),
'KE46' => __( 'Wajir', 'lifterlms' ),
'KE47' => __( 'West Pokot', 'lifterlms' ),
),
'KN' => array( // Saint Kitts and Nevis parishes.
'KNK' => __( 'Saint Kitts', 'lifterlms' ),
'KNN' => __( 'Nevis', 'lifterlms' ),
'KN01' => __( 'Christ Church Nichola Town', 'lifterlms' ),
'KN02' => __( 'Saint Anne Sandy Point', 'lifterlms' ),
'KN03' => __( 'Saint George Basseterre', 'lifterlms' ),
'KN04' => __( 'Saint George Gingerland', 'lifterlms' ),
'KN05' => __( 'Saint James Windward', 'lifterlms' ),
'KN06' => __( 'Saint John Capisterre', 'lifterlms' ),
'KN07' => __( 'Saint John Figtree', 'lifterlms' ),
'KN08' => __( 'Saint Mary Cayon', 'lifterlms' ),
'KN09' => __( 'Saint Paul Capisterre', 'lifterlms' ),
'KN10' => __( 'Saint Paul Charlestown', 'lifterlms' ),
'KN11' => __( 'Saint Peter Basseterre', 'lifterlms' ),
'KN12' => __( 'Saint Thomas Lowland', 'lifterlms' ),
'KN13' => __( 'Saint Thomas Middle Island', 'lifterlms' ),
'KN15' => __( 'Trinity Palmetto Point', 'lifterlms' ),
),
'KR' => array(),
'KW' => array(),
'LA' => array( // Laotian provinces.
'AT' => __( 'Attapeu', 'lifterlms' ),
'BK' => __( 'Bokeo', 'lifterlms' ),
'BL' => __( 'Bolikhamsai', 'lifterlms' ),
'CH' => __( 'Champasak', 'lifterlms' ),
'HO' => __( 'Houaphanh', 'lifterlms' ),
'KH' => __( 'Khammouane', 'lifterlms' ),
'LM' => __( 'Luang Namtha', 'lifterlms' ),
'LP' => __( 'Luang Prabang', 'lifterlms' ),
'OU' => __( 'Oudomxay', 'lifterlms' ),
'PH' => __( 'Phongsaly', 'lifterlms' ),
'SL' => __( 'Salavan', 'lifterlms' ),
'SV' => __( 'Savannakhet', 'lifterlms' ),
'VI' => __( 'Vientiane Province', 'lifterlms' ),
'VT' => __( 'Vientiane', 'lifterlms' ),
'XA' => __( 'Sainyabuli', 'lifterlms' ),
'XE' => __( 'Sekong', 'lifterlms' ),
'XI' => __( 'Xiangkhouang', 'lifterlms' ),
'XS' => __( 'Xaisomboun', 'lifterlms' ),
),
'LB' => array(),
'LI' => array(),
'LR' => array( // Liberian provinces.
'BM' => __( 'Bomi', 'lifterlms' ),
'BN' => __( 'Bong', 'lifterlms' ),
'GA' => __( 'Gbarpolu', 'lifterlms' ),
'GB' => __( 'Grand Bassa', 'lifterlms' ),
'GC' => __( 'Grand Cape Mount', 'lifterlms' ),
'GG' => __( 'Grand Gedeh', 'lifterlms' ),
'GK' => __( 'Grand Kru', 'lifterlms' ),
'LO' => __( 'Lofa', 'lifterlms' ),
'MA' => __( 'Margibi', 'lifterlms' ),
'MY' => __( 'Maryland', 'lifterlms' ),
'MO' => __( 'Montserrado', 'lifterlms' ),
'NM' => __( 'Nimba', 'lifterlms' ),
'RV' => __( 'Rivercess', 'lifterlms' ),
'RG' => __( 'River Gee', 'lifterlms' ),
'SN' => __( 'Sinoe', 'lifterlms' ),
),
'LU' => array(),
'MA' => array( // Moroccan regions.
'maagd' => __( 'Agadir-Ida Ou Tanane', 'lifterlms' ),
'maazi' => __( 'Azilal', 'lifterlms' ),
'mabem' => __( 'Béni-Mellal', 'lifterlms' ),
'maber' => __( 'Berkane', 'lifterlms' ),
'mabes' => __( 'Ben Slimane', 'lifterlms' ),
'mabod' => __( 'Boujdour', 'lifterlms' ),
'mabom' => __( 'Boulemane', 'lifterlms' ),
'mabrr' => __( 'Berrechid', 'lifterlms' ),
'macas' => __( 'Casablanca', 'lifterlms' ),
'mache' => __( 'Chefchaouen', 'lifterlms' ),
'machi' => __( 'Chichaoua', 'lifterlms' ),
'macht' => __( 'Chtouka Aït Baha', 'lifterlms' ),
'madri' => __( 'Driouch', 'lifterlms' ),
'maedi' => __( 'Essaouira', 'lifterlms' ),
'maerr' => __( 'Errachidia', 'lifterlms' ),
'mafah' => __( 'Fahs-Beni Makada', 'lifterlms' ),
'mafes' => __( 'Fès-Dar-Dbibegh', 'lifterlms' ),
'mafig' => __( 'Figuig', 'lifterlms' ),
'mafqh' => __( 'Fquih Ben Salah', 'lifterlms' ),
'mafes' => __( 'Fès-Dar-Dbibegh', 'lifterlms' ),
'mague' => __( 'Guelmim', 'lifterlms' ),
'maguf' => __( 'Guercif', 'lifterlms' ),
'mahaj' => __( 'El Hajeb', 'lifterlms' ),
'mahao' => __( 'Al Haouz', 'lifterlms' ),
'mahoc' => __( 'Al Hoceïma', 'lifterlms' ),
'maifr' => __( 'Ifrane', 'lifterlms' ),
'maine' => __( 'Inezgane-Aït Melloul', 'lifterlms' ),
'majdi' => __( 'El Jadida', 'lifterlms' ),
'majra' => __( 'Jerada', 'lifterlms' ),
'maken' => __( 'Kénitra', 'lifterlms' ),
'makes' => __( 'Kelaat Sraghna', 'lifterlms' ),
'makhe' => __( 'Khemisset', 'lifterlms' ),
'makhn' => __( 'Khénifra', 'lifterlms' ),
'makho' => __( 'Khouribga', 'lifterlms' ),
'malaa' => __( 'Laâyoune', 'lifterlms' ),
'malar' => __( 'Larache', 'lifterlms' ),
'mamar' => __( 'Marrakech', 'lifterlms' ),
'mamdf' => __( 'M’diq-Fnideq', 'lifterlms' ),
'mamed' => __( 'Médiouna', 'lifterlms' ),
'mamek' => __( 'Meknès', 'lifterlms' ),
'mamid' => __( 'Midelt', 'lifterlms' ),
'mammd' => __( 'Marrakech-Medina', 'lifterlms' ),
'mammn' => __( 'Marrakech-Menara', 'lifterlms' ),
'mamoh' => __( 'Mohammedia', 'lifterlms' ),
'mamou' => __( 'Moulay Yacoub', 'lifterlms' ),
'manad' => __( 'Nador', 'lifterlms' ),
'manou' => __( 'Nouaceur', 'lifterlms' ),
'maoua' => __( 'Ouarzazate', 'lifterlms' ),
'maoud' => __( 'Oued Ed-Dahab', 'lifterlms' ),
'maouj' => __( 'Oujda-Angad', 'lifterlms' ),
'maouz' => __( 'Ouezzane', 'lifterlms' ),
'marab' => __( 'Rabat', 'lifterlms' ),
'mareh' => __( 'Rehamna', 'lifterlms' ),
'masaf' => __( 'Safi', 'lifterlms' ),
'masal' => __( 'Salé', 'lifterlms' ),
'masef' => __( 'Sefrou', 'lifterlms' ),
'maset' => __( 'Settat', 'lifterlms' ),
'masib' => __( 'Sidi Bennour', 'lifterlms' ),
'masif' => __( 'Sidi Ifni', 'lifterlms' ),
'masik' => __( 'Sidi Kacem', 'lifterlms' ),
'masil' => __( 'Sidi Slimane', 'lifterlms' ),
'maskh' => __( 'Skhirat-Témara', 'lifterlms' ),
'masyb' => __( 'Sidi Youssef Ben Ali', 'lifterlms' ),
'mataf' => __( 'Tarfaya (EH-partial)', 'lifterlms' ),
'matai' => __( 'Taourirt', 'lifterlms' ),
'matao' => __( 'Taounate', 'lifterlms' ),
'matar' => __( 'Taroudant', 'lifterlms' ),
'matat' => __( 'Tata', 'lifterlms' ),
'mataz' => __( 'Taza', 'lifterlms' ),
'matet' => __( 'Tétouan', 'lifterlms' ),
'matin' => __( 'Tinghir', 'lifterlms' ),
'matiz' => __( 'Tiznit', 'lifterlms' ),
'matng' => __( 'Tangier-Assilah', 'lifterlms' ),
'matnt' => __( 'Tan-Tan', 'lifterlms' ),
'mayus' => __( 'Youssoufia', 'lifterlms' ),
'mazag' => __( 'Zagora', 'lifterlms' )
),
'MD' => array( // Moldovan states.
'C' => __( 'Chișinău', 'lifterlms' ),
'BL' => __( 'Bălți', 'lifterlms' ),
'AN' => __( 'Anenii Noi', 'lifterlms' ),
'BS' => __( 'Basarabeasca', 'lifterlms' ),
'BR' => __( 'Briceni', 'lifterlms' ),
'CH' => __( 'Cahul', 'lifterlms' ),
'CT' => __( 'Cantemir', 'lifterlms' ),
'CL' => __( 'Călărași', 'lifterlms' ),
'CS' => __( 'Căușeni', 'lifterlms' ),
'CM' => __( 'Cimișlia', 'lifterlms' ),
'CR' => __( 'Criuleni', 'lifterlms' ),
'DN' => __( 'Dondușeni', 'lifterlms' ),
'DR' => __( 'Drochia', 'lifterlms' ),
'DB' => __( 'Dubăsari', 'lifterlms' ),
'ED' => __( 'Edineț', 'lifterlms' ),
'FL' => __( 'Fălești', 'lifterlms' ),
'FR' => __( 'Florești', 'lifterlms' ),
'GE' => __( 'UTA Găgăuzia', 'lifterlms' ),
'GL' => __( 'Glodeni', 'lifterlms' ),
'HN' => __( 'Hîncești', 'lifterlms' ),
'IL' => __( 'Ialoveni', 'lifterlms' ),
'LV' => __( 'Leova', 'lifterlms' ),
'NS' => __( 'Nisporeni', 'lifterlms' ),
'OC' => __( 'Ocnița', 'lifterlms' ),
'OR' => __( 'Orhei', 'lifterlms' ),
'RZ' => __( 'Rezina', 'lifterlms' ),
'RS' => __( 'Rîșcani', 'lifterlms' ),
'SG' => __( 'Sîngerei', 'lifterlms' ),
'SR' => __( 'Soroca', 'lifterlms' ),
'ST' => __( 'Strășeni', 'lifterlms' ),
'SD' => __( 'Șoldănești', 'lifterlms' ),
'SV' => __( 'Ștefan Vodă', 'lifterlms' ),
'TR' => __( 'Taraclia', 'lifterlms' ),
'TL' => __( 'Telenești', 'lifterlms' ),
'UN' => __( 'Ungheni', 'lifterlms' ),
),
'MF' => array(),
'MQ' => array(),
'MT' => array(),
'MX' => array( // Mexican states.
'DF' => __( 'Ciudad de México', 'lifterlms' ),
'JA' => __( 'Jalisco', 'lifterlms' ),
'NL' => __( 'Nuevo León', 'lifterlms' ),
'AG' => __( 'Aguascalientes', 'lifterlms' ),
'BC' => __( 'Baja California', 'lifterlms' ),
'BS' => __( 'Baja California Sur', 'lifterlms' ),
'CM' => __( 'Campeche', 'lifterlms' ),
'CS' => __( 'Chiapas', 'lifterlms' ),
'CH' => __( 'Chihuahua', 'lifterlms' ),
'CO' => __( 'Coahuila', 'lifterlms' ),
'CL' => __( 'Colima', 'lifterlms' ),
'DG' => __( 'Durango', 'lifterlms' ),
'GT' => __( 'Guanajuato', 'lifterlms' ),
'GR' => __( 'Guerrero', 'lifterlms' ),
'HG' => __( 'Hidalgo', 'lifterlms' ),
'MX' => __( 'Estado de México', 'lifterlms' ),
'MI' => __( 'Michoacán', 'lifterlms' ),
'MO' => __( 'Morelos', 'lifterlms' ),
'NA' => __( 'Nayarit', 'lifterlms' ),
'OA' => __( 'Oaxaca', 'lifterlms' ),
'PU' => __( 'Puebla', 'lifterlms' ),
'QT' => __( 'Querétaro', 'lifterlms' ),
'QR' => __( 'Quintana Roo', 'lifterlms' ),
'SL' => __( 'San Luis Potosí', 'lifterlms' ),
'SI' => __( 'Sinaloa', 'lifterlms' ),
'SO' => __( 'Sonora', 'lifterlms' ),
'TB' => __( 'Tabasco', 'lifterlms' ),
'TM' => __( 'Tamaulipas', 'lifterlms' ),
'TL' => __( 'Tlaxcala', 'lifterlms' ),
'VE' => __( 'Veracruz', 'lifterlms' ),
'YU' => __( 'Yucatán', 'lifterlms' ),
'ZA' => __( 'Zacatecas', 'lifterlms' ),
),
'MY' => array( // Malaysian states.
'JHR' => __( 'Johor', 'lifterlms' ),
'KDH' => __( 'Kedah', 'lifterlms' ),
'KTN' => __( 'Kelantan', 'lifterlms' ),
'LBN' => __( 'Labuan', 'lifterlms' ),
'MLK' => __( 'Malacca (Melaka)', 'lifterlms' ),
'NSN' => __( 'Negeri Sembilan', 'lifterlms' ),
'PHG' => __( 'Pahang', 'lifterlms' ),
'PNG' => __( 'Penang (Pulau Pinang)', 'lifterlms' ),
'PRK' => __( 'Perak', 'lifterlms' ),
'PLS' => __( 'Perlis', 'lifterlms' ),
'SBH' => __( 'Sabah', 'lifterlms' ),
'SWK' => __( 'Sarawak', 'lifterlms' ),
'SGR' => __( 'Selangor', 'lifterlms' ),
'TRG' => __( 'Terengganu', 'lifterlms' ),
'PJY' => __( 'Putrajaya', 'lifterlms' ),
'KUL' => __( 'Kuala Lumpur', 'lifterlms' ),
),
'MZ' => array( // Mozambican provinces.
'MZP' => __( 'Cabo Delgado', 'lifterlms' ),
'MZG' => __( 'Gaza', 'lifterlms' ),
'MZI' => __( 'Inhambane', 'lifterlms' ),
'MZB' => __( 'Manica', 'lifterlms' ),
'MZL' => __( 'Maputo Province', 'lifterlms' ),
'MZMPM' => __( 'Maputo', 'lifterlms' ),
'MZN' => __( 'Nampula', 'lifterlms' ),
'MZA' => __( 'Niassa', 'lifterlms' ),
'MZS' => __( 'Sofala', 'lifterlms' ),
'MZT' => __( 'Tete', 'lifterlms' ),
'MZQ' => __( 'Zambézia', 'lifterlms' ),
),
'NA' => array( // Namibian regions.
'ER' => __( 'Erongo', 'lifterlms' ),
'HA' => __( 'Hardap', 'lifterlms' ),
'KA' => __( 'Karas', 'lifterlms' ),
'KE' => __( 'Kavango East', 'lifterlms' ),
'KW' => __( 'Kavango West', 'lifterlms' ),
'KH' => __( 'Khomas', 'lifterlms' ),
'KU' => __( 'Kunene', 'lifterlms' ),
'OW' => __( 'Ohangwena', 'lifterlms' ),
'OH' => __( 'Omaheke', 'lifterlms' ),
'OS' => __( 'Omusati', 'lifterlms' ),
'ON' => __( 'Oshana', 'lifterlms' ),
'OT' => __( 'Oshikoto', 'lifterlms' ),
'OD' => __( 'Otjozondjupa', 'lifterlms' ),
'CA' => __( 'Zambezi', 'lifterlms' ),
),
'NG' => array( // Nigerian provinces.
'AB' => __( 'Abia', 'lifterlms' ),
'FC' => __( 'Abuja', 'lifterlms' ),
'AD' => __( 'Adamawa', 'lifterlms' ),
'AK' => __( 'Akwa Ibom', 'lifterlms' ),
'AN' => __( 'Anambra', 'lifterlms' ),
'BA' => __( 'Bauchi', 'lifterlms' ),
'BY' => __( 'Bayelsa', 'lifterlms' ),
'BE' => __( 'Benue', 'lifterlms' ),
'BO' => __( 'Borno', 'lifterlms' ),
'CR' => __( 'Cross River', 'lifterlms' ),
'DE' => __( 'Delta', 'lifterlms' ),
'EB' => __( 'Ebonyi', 'lifterlms' ),
'ED' => __( 'Edo', 'lifterlms' ),
'EK' => __( 'Ekiti', 'lifterlms' ),
'EN' => __( 'Enugu', 'lifterlms' ),
'GO' => __( 'Gombe', 'lifterlms' ),
'IM' => __( 'Imo', 'lifterlms' ),
'JI' => __( 'Jigawa', 'lifterlms' ),
'KD' => __( 'Kaduna', 'lifterlms' ),
'KN' => __( 'Kano', 'lifterlms' ),
'KT' => __( 'Katsina', 'lifterlms' ),
'KE' => __( 'Kebbi', 'lifterlms' ),
'KO' => __( 'Kogi', 'lifterlms' ),
'KW' => __( 'Kwara', 'lifterlms' ),
'LA' => __( 'Lagos', 'lifterlms' ),
'NA' => __( 'Nasarawa', 'lifterlms' ),
'NI' => __( 'Niger', 'lifterlms' ),
'OG' => __( 'Ogun', 'lifterlms' ),
'ON' => __( 'Ondo', 'lifterlms' ),
'OS' => __( 'Osun', 'lifterlms' ),
'OY' => __( 'Oyo', 'lifterlms' ),
'PL' => __( 'Plateau', 'lifterlms' ),
'RI' => __( 'Rivers', 'lifterlms' ),
'SO' => __( 'Sokoto', 'lifterlms' ),
'TA' => __( 'Taraba', 'lifterlms' ),
'YO' => __( 'Yobe', 'lifterlms' ),
'ZA' => __( 'Zamfara', 'lifterlms' ),
),
'NL' => array(),
'NO' => array(),
'NP' => array( // Nepalese zones.
'BAG' => __( 'Bagmati', 'lifterlms' ),
'BHE' => __( 'Bheri', 'lifterlms' ),
'DHA' => __( 'Dhaulagiri', 'lifterlms' ),
'GAN' => __( 'Gandaki', 'lifterlms' ),
'JAN' => __( 'Janakpur', 'lifterlms' ),
'KAR' => __( 'Karnali', 'lifterlms' ),
'KOS' => __( 'Koshi', 'lifterlms' ),
'LUM' => __( 'Lumbini', 'lifterlms' ),
'MAH' => __( 'Mahakali', 'lifterlms' ),
'MEC' => __( 'Mechi', 'lifterlms' ),
'NAR' => __( 'Narayani', 'lifterlms' ),
'RAP' => __( 'Rapti', 'lifterlms' ),
'SAG' => __( 'Sagarmatha', 'lifterlms' ),
'SET' => __( 'Seti', 'lifterlms' ),
),
'NI' => array( // Nicaraguan states.
'NI-AN' => __( 'Atlántico Norte', 'lifterlms' ),
'NI-AS' => __( 'Atlántico Sur', 'lifterlms' ),
'NI-BO' => __( 'Boaco', 'lifterlms' ),
'NI-CA' => __( 'Carazo', 'lifterlms' ),
'NI-CI' => __( 'Chinandega', 'lifterlms' ),
'NI-CO' => __( 'Chontales', 'lifterlms' ),
'NI-ES' => __( 'Estelí', 'lifterlms' ),
'NI-GR' => __( 'Granada', 'lifterlms' ),
'NI-JI' => __( 'Jinotega', 'lifterlms' ),
'NI-LE' => __( 'León', 'lifterlms' ),
'NI-MD' => __( 'Madriz', 'lifterlms' ),
'NI-MN' => __( 'Managua', 'lifterlms' ),
'NI-MS' => __( 'Masaya', 'lifterlms' ),
'NI-MT' => __( 'Matagalpa', 'lifterlms' ),
'NI-NS' => __( 'Nueva Segovia', 'lifterlms' ),
'NI-RI' => __( 'Rivas', 'lifterlms' ),
'NI-SJ' => __( 'Río San Juan', 'lifterlms' ),
),
'NZ' => array( // New Zealand states.
'NTL' => __( 'Northland', 'lifterlms' ),
'AUK' => __( 'Auckland', 'lifterlms' ),
'WKO' => __( 'Waikato', 'lifterlms' ),
'BOP' => __( 'Bay of Plenty', 'lifterlms' ),
'TKI' => __( 'Taranaki', 'lifterlms' ),
'GIS' => __( 'Gisborne', 'lifterlms' ),
'HKB' => __( 'Hawke’s Bay', 'lifterlms' ),
'MWT' => __( 'Manawatu-Whanganui', 'lifterlms' ),
'WGN' => __( 'Wellington', 'lifterlms' ),
'NSN' => __( 'Nelson', 'lifterlms' ),
'MBH' => __( 'Marlborough', 'lifterlms' ),
'TAS' => __( 'Tasman', 'lifterlms' ),
'WTC' => __( 'West Coast', 'lifterlms' ),
'CAN' => __( 'Canterbury', 'lifterlms' ),
'OTA' => __( 'Otago', 'lifterlms' ),
'STL' => __( 'Southland', 'lifterlms' ),
),
'PA' => array( // Panamanian states.
'PA-1' => __( 'Bocas del Toro', 'lifterlms' ),
'PA-2' => __( 'Coclé', 'lifterlms' ),
'PA-3' => __( 'Colón', 'lifterlms' ),
'PA-4' => __( 'Chiriquí', 'lifterlms' ),
'PA-5' => __( 'Darién', 'lifterlms' ),
'PA-6' => __( 'Herrera', 'lifterlms' ),
'PA-7' => __( 'Los Santos', 'lifterlms' ),
'PA-8' => __( 'Panamá', 'lifterlms' ),
'PA-9' => __( 'Veraguas', 'lifterlms' ),
'PA-10' => __( 'West Panamá', 'lifterlms' ),
'PA-EM' => __( 'Emberá', 'lifterlms' ),
'PA-KY' => __( 'Guna Yala', 'lifterlms' ),
'PA-NB' => __( 'Ngöbe-Buglé', 'lifterlms' ),
),
'PE' => array( // Peruvian states.
'CAL' => __( 'El Callao', 'lifterlms' ),
'LMA' => __( 'Municipalidad Metropolitana de Lima', 'lifterlms' ),
'AMA' => __( 'Amazonas', 'lifterlms' ),
'ANC' => __( 'Ancash', 'lifterlms' ),
'APU' => __( 'Apurímac', 'lifterlms' ),
'ARE' => __( 'Arequipa', 'lifterlms' ),
'AYA' => __( 'Ayacucho', 'lifterlms' ),
'CAJ' => __( 'Cajamarca', 'lifterlms' ),
'CUS' => __( 'Cusco', 'lifterlms' ),
'HUV' => __( 'Huancavelica', 'lifterlms' ),
'HUC' => __( 'Huánuco', 'lifterlms' ),
'ICA' => __( 'Ica', 'lifterlms' ),
'JUN' => __( 'Junín', 'lifterlms' ),
'LAL' => __( 'La Libertad', 'lifterlms' ),
'LAM' => __( 'Lambayeque', 'lifterlms' ),
'LIM' => __( 'Lima', 'lifterlms' ),
'LOR' => __( 'Loreto', 'lifterlms' ),
'MDD' => __( 'Madre de Dios', 'lifterlms' ),
'MOQ' => __( 'Moquegua', 'lifterlms' ),
'PAS' => __( 'Pasco', 'lifterlms' ),
'PIU' => __( 'Piura', 'lifterlms' ),
'PUN' => __( 'Puno', 'lifterlms' ),
'SAM' => __( 'San Martín', 'lifterlms' ),
'TAC' => __( 'Tacna', 'lifterlms' ),
'TUM' => __( 'Tumbes', 'lifterlms' ),
'UCA' => __( 'Ucayali', 'lifterlms' ),
),
'PH' => array( // Philippine provinces.
'ABR' => __( 'Abra', 'lifterlms' ),
'AGN' => __( 'Agusan del Norte', 'lifterlms' ),
'AGS' => __( 'Agusan del Sur', 'lifterlms' ),
'AKL' => __( 'Aklan', 'lifterlms' ),
'ALB' => __( 'Albay', 'lifterlms' ),
'ANT' => __( 'Antique', 'lifterlms' ),
'APA' => __( 'Apayao', 'lifterlms' ),
'AUR' => __( 'Aurora', 'lifterlms' ),
'BAS' => __( 'Basilan', 'lifterlms' ),
'BAN' => __( 'Bataan', 'lifterlms' ),
'BTN' => __( 'Batanes', 'lifterlms' ),
'BTG' => __( 'Batangas', 'lifterlms' ),
'BEN' => __( 'Benguet', 'lifterlms' ),
'BIL' => __( 'Biliran', 'lifterlms' ),
'BOH' => __( 'Bohol', 'lifterlms' ),
'BUK' => __( 'Bukidnon', 'lifterlms' ),
'BUL' => __( 'Bulacan', 'lifterlms' ),
'CAG' => __( 'Cagayan', 'lifterlms' ),
'CAN' => __( 'Camarines Norte', 'lifterlms' ),
'CAS' => __( 'Camarines Sur', 'lifterlms' ),
'CAM' => __( 'Camiguin', 'lifterlms' ),
'CAP' => __( 'Capiz', 'lifterlms' ),
'CAT' => __( 'Catanduanes', 'lifterlms' ),
'CAV' => __( 'Cavite', 'lifterlms' ),
'CEB' => __( 'Cebu', 'lifterlms' ),
'COM' => __( 'Compostela Valley', 'lifterlms' ),
'NCO' => __( 'Cotabato', 'lifterlms' ),
'DAV' => __( 'Davao del Norte', 'lifterlms' ),
'DAS' => __( 'Davao del Sur', 'lifterlms' ),
'DAC' => __( 'Davao Occidental', 'lifterlms' ),
'DAO' => __( 'Davao Oriental', 'lifterlms' ),
'DIN' => __( 'Dinagat Islands', 'lifterlms' ),
'EAS' => __( 'Eastern Samar', 'lifterlms' ),
'GUI' => __( 'Guimaras', 'lifterlms' ),
'IFU' => __( 'Ifugao', 'lifterlms' ),
'ILN' => __( 'Ilocos Norte', 'lifterlms' ),
'ILS' => __( 'Ilocos Sur', 'lifterlms' ),
'ILI' => __( 'Iloilo', 'lifterlms' ),
'ISA' => __( 'Isabela', 'lifterlms' ),
'KAL' => __( 'Kalinga', 'lifterlms' ),
'LUN' => __( 'La Union', 'lifterlms' ),
'LAG' => __( 'Laguna', 'lifterlms' ),
'LAN' => __( 'Lanao del Norte', 'lifterlms' ),
'LAS' => __( 'Lanao del Sur', 'lifterlms' ),
'LEY' => __( 'Leyte', 'lifterlms' ),
'MAG' => __( 'Maguindanao', 'lifterlms' ),
'MAD' => __( 'Marinduque', 'lifterlms' ),
'MAS' => __( 'Masbate', 'lifterlms' ),
'MSC' => __( 'Misamis Occidental', 'lifterlms' ),
'MSR' => __( 'Misamis Oriental', 'lifterlms' ),
'MOU' => __( 'Mountain Province', 'lifterlms' ),
'NEC' => __( 'Negros Occidental', 'lifterlms' ),
'NER' => __( 'Negros Oriental', 'lifterlms' ),
'NSA' => __( 'Northern Samar', 'lifterlms' ),
'NUE' => __( 'Nueva Ecija', 'lifterlms' ),
'NUV' => __( 'Nueva Vizcaya', 'lifterlms' ),
'MDC' => __( 'Occidental Mindoro', 'lifterlms' ),
'MDR' => __( 'Oriental Mindoro', 'lifterlms' ),
'PLW' => __( 'Palawan', 'lifterlms' ),
'PAM' => __( 'Pampanga', 'lifterlms' ),
'PAN' => __( 'Pangasinan', 'lifterlms' ),
'QUE' => __( 'Quezon', 'lifterlms' ),
'QUI' => __( 'Quirino', 'lifterlms' ),
'RIZ' => __( 'Rizal', 'lifterlms' ),
'ROM' => __( 'Romblon', 'lifterlms' ),
'WSA' => __( 'Samar', 'lifterlms' ),
'SAR' => __( 'Sarangani', 'lifterlms' ),
'SIQ' => __( 'Siquijor', 'lifterlms' ),
'SOR' => __( 'Sorsogon', 'lifterlms' ),
'SCO' => __( 'South Cotabato', 'lifterlms' ),
'SLE' => __( 'Southern Leyte', 'lifterlms' ),
'SUK' => __( 'Sultan Kudarat', 'lifterlms' ),
'SLU' => __( 'Sulu', 'lifterlms' ),
'SUN' => __( 'Surigao del Norte', 'lifterlms' ),
'SUR' => __( 'Surigao del Sur', 'lifterlms' ),
'TAR' => __( 'Tarlac', 'lifterlms' ),
'TAW' => __( 'Tawi-Tawi', 'lifterlms' ),
'ZMB' => __( 'Zambales', 'lifterlms' ),
'ZAN' => __( 'Zamboanga del Norte', 'lifterlms' ),
'ZAS' => __( 'Zamboanga del Sur', 'lifterlms' ),
'ZSI' => __( 'Zamboanga Sibugay', 'lifterlms' ),
'00' => __( 'Metro Manila', 'lifterlms' ),
),
'PK' => array( // Pakistani states.
'JK' => __( 'Azad Kashmir', 'lifterlms' ),
'BA' => __( 'Balochistan', 'lifterlms' ),
'TA' => __( 'FATA', 'lifterlms' ),
'GB' => __( 'Gilgit Baltistan', 'lifterlms' ),
'IS' => __( 'Islamabad Capital Territory', 'lifterlms' ),
'KP' => __( 'Khyber Pakhtunkhwa', 'lifterlms' ),
'PB' => __( 'Punjab', 'lifterlms' ),
'SD' => __( 'Sindh', 'lifterlms' ),
),
'PL' => array(),
'PR' => array(),
'PT' => array(),
'PY' => array( // Paraguayan states.
'PY-ASU' => __( 'Asunción', 'lifterlms' ),
'PY-1' => __( 'Concepción', 'lifterlms' ),
'PY-2' => __( 'San Pedro', 'lifterlms' ),
'PY-3' => __( 'Cordillera', 'lifterlms' ),
'PY-4' => __( 'Guairá', 'lifterlms' ),
'PY-5' => __( 'Caaguazú', 'lifterlms' ),
'PY-6' => __( 'Caazapá', 'lifterlms' ),
'PY-7' => __( 'Itapúa', 'lifterlms' ),
'PY-8' => __( 'Misiones', 'lifterlms' ),
'PY-9' => __( 'Paraguarí', 'lifterlms' ),
'PY-10' => __( 'Alto Paraná', 'lifterlms' ),
'PY-11' => __( 'Central', 'lifterlms' ),
'PY-12' => __( 'Ñeembucú', 'lifterlms' ),
'PY-13' => __( 'Amambay', 'lifterlms' ),
'PY-14' => __( 'Canindeyú', 'lifterlms' ),
'PY-15' => __( 'Presidente Hayes', 'lifterlms' ),
'PY-16' => __( 'Alto Paraguay', 'lifterlms' ),
'PY-17' => __( 'Boquerón', 'lifterlms' ),
),
'RE' => array(),
'RO' => array( // Romanian states.
'AB' => __( 'Alba', 'lifterlms' ),
'AR' => __( 'Arad', 'lifterlms' ),
'AG' => __( 'Argeș', 'lifterlms' ),
'BC' => __( 'Bacău', 'lifterlms' ),
'BH' => __( 'Bihor', 'lifterlms' ),
'BN' => __( 'Bistrița-Năsăud', 'lifterlms' ),
'BT' => __( 'Botoșani', 'lifterlms' ),
'BR' => __( 'Brăila', 'lifterlms' ),
'BV' => __( 'Brașov', 'lifterlms' ),
'B' => __( 'București', 'lifterlms' ),
'BZ' => __( 'Buzău', 'lifterlms' ),
'CL' => __( 'Călărași', 'lifterlms' ),
'CS' => __( 'Caraș-Severin', 'lifterlms' ),
'CJ' => __( 'Cluj', 'lifterlms' ),
'CT' => __( 'Constanța', 'lifterlms' ),
'CV' => __( 'Covasna', 'lifterlms' ),
'DB' => __( 'Dâmbovița', 'lifterlms' ),
'DJ' => __( 'Dolj', 'lifterlms' ),
'GL' => __( 'Galați', 'lifterlms' ),
'GR' => __( 'Giurgiu', 'lifterlms' ),
'GJ' => __( 'Gorj', 'lifterlms' ),
'HR' => __( 'Harghita', 'lifterlms' ),
'HD' => __( 'Hunedoara', 'lifterlms' ),
'IL' => __( 'Ialomița', 'lifterlms' ),
'IS' => __( 'Iași', 'lifterlms' ),
'IF' => __( 'Ilfov', 'lifterlms' ),
'MM' => __( 'Maramureș', 'lifterlms' ),
'MH' => __( 'Mehedinți', 'lifterlms' ),
'MS' => __( 'Mureș', 'lifterlms' ),
'NT' => __( 'Neamț', 'lifterlms' ),
'OT' => __( 'Olt', 'lifterlms' ),
'PH' => __( 'Prahova', 'lifterlms' ),
'SJ' => __( 'Sălaj', 'lifterlms' ),
'SM' => __( 'Satu Mare', 'lifterlms' ),
'SB' => __( 'Sibiu', 'lifterlms' ),
'SV' => __( 'Suceava', 'lifterlms' ),
'TR' => __( 'Teleorman', 'lifterlms' ),
'TM' => __( 'Timiș', 'lifterlms' ),
'TL' => __( 'Tulcea', 'lifterlms' ),
'VL' => __( 'Vâlcea', 'lifterlms' ),
'VS' => __( 'Vaslui', 'lifterlms' ),
'VN' => __( 'Vrancea', 'lifterlms' ),
),
'SN' => array( // Regions of Senegal. Ref: https://github.com/unicode-org/cldr/blob/release-42/common/subdivisions/en.xml#L4801.
'SNDB' => __( 'Diourbel', 'lifterlms' ),
'SNDK' => __( 'Dakar', 'lifterlms' ),
'SNFK' => __( 'Fatick', 'lifterlms' ),
'SNKA' => __( 'Kaffrine', 'lifterlms' ),
'SNKD' => __( 'Kolda', 'lifterlms' ),
'SNKE' => __( 'Kédougou', 'lifterlms' ),
'SNKL' => __( 'Kaolack', 'lifterlms' ),
'SNLG' => __( 'Louga', 'lifterlms' ),
'SNMT' => __( 'Matam', 'lifterlms' ),
'SNSE' => __( 'Sédhiou', 'lifterlms' ),
'SNSL' => __( 'Saint-Louis', 'lifterlms' ),
'SNTC' => __( 'Tambacounda', 'lifterlms' ),
'SNTH' => __( 'Thiès', 'lifterlms' ),
'SNZG' => __( 'Ziguinchor', 'lifterlms' ),
),
'SG' => array(),
'SK' => array(),
'SI' => array(),
'SV' => array( // Salvadoran states.
'SV-AH' => __( 'Ahuachapán', 'lifterlms' ),
'SV-CA' => __( 'Cabañas', 'lifterlms' ),
'SV-CH' => __( 'Chalatenango', 'lifterlms' ),
'SV-CU' => __( 'Cuscatlán', 'lifterlms' ),
'SV-LI' => __( 'La Libertad', 'lifterlms' ),
'SV-MO' => __( 'Morazán', 'lifterlms' ),
'SV-PA' => __( 'La Paz', 'lifterlms' ),
'SV-SA' => __( 'Santa Ana', 'lifterlms' ),
'SV-SM' => __( 'San Miguel', 'lifterlms' ),
'SV-SO' => __( 'Sonsonate', 'lifterlms' ),
'SV-SS' => __( 'San Salvador', 'lifterlms' ),
'SV-SV' => __( 'San Vicente', 'lifterlms' ),
'SV-UN' => __( 'La Unión', 'lifterlms' ),
'SV-US' => __( 'Usulután', 'lifterlms' ),
),
'TH' => array( // Thai states.
'TH-37' => __( 'Amnat Charoen', 'lifterlms' ),
'TH-15' => __( 'Ang Thong', 'lifterlms' ),
'TH-14' => __( 'Ayutthaya', 'lifterlms' ),
'TH-10' => __( 'Bangkok', 'lifterlms' ),
'TH-38' => __( 'Bueng Kan', 'lifterlms' ),
'TH-31' => __( 'Buri Ram', 'lifterlms' ),
'TH-24' => __( 'Chachoengsao', 'lifterlms' ),
'TH-18' => __( 'Chai Nat', 'lifterlms' ),
'TH-36' => __( 'Chaiyaphum', 'lifterlms' ),
'TH-22' => __( 'Chanthaburi', 'lifterlms' ),
'TH-50' => __( 'Chiang Mai', 'lifterlms' ),
'TH-57' => __( 'Chiang Rai', 'lifterlms' ),
'TH-20' => __( 'Chonburi', 'lifterlms' ),
'TH-86' => __( 'Chumphon', 'lifterlms' ),
'TH-46' => __( 'Kalasin', 'lifterlms' ),
'TH-62' => __( 'Kamphaeng Phet', 'lifterlms' ),
'TH-71' => __( 'Kanchanaburi', 'lifterlms' ),
'TH-40' => __( 'Khon Kaen', 'lifterlms' ),
'TH-81' => __( 'Krabi', 'lifterlms' ),
'TH-52' => __( 'Lampang', 'lifterlms' ),
'TH-51' => __( 'Lamphun', 'lifterlms' ),
'TH-42' => __( 'Loei', 'lifterlms' ),
'TH-16' => __( 'Lopburi', 'lifterlms' ),
'TH-58' => __( 'Mae Hong Son', 'lifterlms' ),
'TH-44' => __( 'Maha Sarakham', 'lifterlms' ),
'TH-49' => __( 'Mukdahan', 'lifterlms' ),
'TH-26' => __( 'Nakhon Nayok', 'lifterlms' ),
'TH-73' => __( 'Nakhon Pathom', 'lifterlms' ),
'TH-48' => __( 'Nakhon Phanom', 'lifterlms' ),
'TH-30' => __( 'Nakhon Ratchasima', 'lifterlms' ),
'TH-60' => __( 'Nakhon Sawan', 'lifterlms' ),
'TH-80' => __( 'Nakhon Si Thammarat', 'lifterlms' ),
'TH-55' => __( 'Nan', 'lifterlms' ),
'TH-96' => __( 'Narathiwat', 'lifterlms' ),
'TH-39' => __( 'Nong Bua Lam Phu', 'lifterlms' ),
'TH-43' => __( 'Nong Khai', 'lifterlms' ),
'TH-12' => __( 'Nonthaburi', 'lifterlms' ),
'TH-13' => __( 'Pathum Thani', 'lifterlms' ),
'TH-94' => __( 'Pattani', 'lifterlms' ),
'TH-82' => __( 'Phang Nga', 'lifterlms' ),
'TH-93' => __( 'Phatthalung', 'lifterlms' ),
'TH-56' => __( 'Phayao', 'lifterlms' ),
'TH-67' => __( 'Phetchabun', 'lifterlms' ),
'TH-76' => __( 'Phetchaburi', 'lifterlms' ),
'TH-66' => __( 'Phichit', 'lifterlms' ),
'TH-65' => __( 'Phitsanulok', 'lifterlms' ),
'TH-54' => __( 'Phrae', 'lifterlms' ),
'TH-83' => __( 'Phuket', 'lifterlms' ),
'TH-25' => __( 'Prachin Buri', 'lifterlms' ),
'TH-77' => __( 'Prachuap Khiri Khan', 'lifterlms' ),
'TH-85' => __( 'Ranong', 'lifterlms' ),
'TH-70' => __( 'Ratchaburi', 'lifterlms' ),
'TH-21' => __( 'Rayong', 'lifterlms' ),
'TH-45' => __( 'Roi Et', 'lifterlms' ),
'TH-27' => __( 'Sa Kaeo', 'lifterlms' ),
'TH-47' => __( 'Sakon Nakhon', 'lifterlms' ),
'TH-11' => __( 'Samut Prakan', 'lifterlms' ),
'TH-74' => __( 'Samut Sakhon', 'lifterlms' ),
'TH-75' => __( 'Samut Songkhram', 'lifterlms' ),
'TH-19' => __( 'Saraburi', 'lifterlms' ),
'TH-91' => __( 'Satun', 'lifterlms' ),
'TH-17' => __( 'Sing Buri', 'lifterlms' ),
'TH-33' => __( 'Sisaket', 'lifterlms' ),
'TH-90' => __( 'Songkhla', 'lifterlms' ),
'TH-64' => __( 'Sukhothai', 'lifterlms' ),
'TH-72' => __( 'Suphan Buri', 'lifterlms' ),
'TH-84' => __( 'Surat Thani', 'lifterlms' ),
'TH-32' => __( 'Surin', 'lifterlms' ),
'TH-63' => __( 'Tak', 'lifterlms' ),
'TH-92' => __( 'Trang', 'lifterlms' ),
'TH-23' => __( 'Trat', 'lifterlms' ),
'TH-34' => __( 'Ubon Ratchathani', 'lifterlms' ),
'TH-41' => __( 'Udon Thani', 'lifterlms' ),
'TH-61' => __( 'Uthai Thani', 'lifterlms' ),
'TH-53' => __( 'Uttaradit', 'lifterlms' ),
'TH-95' => __( 'Yala', 'lifterlms' ),
'TH-35' => __( 'Yasothon', 'lifterlms' ),
),
'TR' => array( // Turkish states.
'TR01' => __( 'Adana', 'lifterlms' ),
'TR02' => __( 'Adıyaman', 'lifterlms' ),
'TR03' => __( 'Afyon', 'lifterlms' ),
'TR04' => __( 'Ağrı', 'lifterlms' ),
'TR05' => __( 'Amasya', 'lifterlms' ),
'TR06' => __( 'Ankara', 'lifterlms' ),
'TR07' => __( 'Antalya', 'lifterlms' ),
'TR08' => __( 'Artvin', 'lifterlms' ),
'TR09' => __( 'Aydın', 'lifterlms' ),
'TR10' => __( 'Balıkesir', 'lifterlms' ),
'TR11' => __( 'Bilecik', 'lifterlms' ),
'TR12' => __( 'Bingöl', 'lifterlms' ),
'TR13' => __( 'Bitlis', 'lifterlms' ),
'TR14' => __( 'Bolu', 'lifterlms' ),
'TR15' => __( 'Burdur', 'lifterlms' ),
'TR16' => __( 'Bursa', 'lifterlms' ),
'TR17' => __( 'Çanakkale', 'lifterlms' ),
'TR18' => __( 'Çankırı', 'lifterlms' ),
'TR19' => __( 'Çorum', 'lifterlms' ),
'TR20' => __( 'Denizli', 'lifterlms' ),
'TR21' => __( 'Diyarbakır', 'lifterlms' ),
'TR22' => __( 'Edirne', 'lifterlms' ),
'TR23' => __( 'Elazığ', 'lifterlms' ),
'TR24' => __( 'Erzincan', 'lifterlms' ),
'TR25' => __( 'Erzurum', 'lifterlms' ),
'TR26' => __( 'Eskişehir', 'lifterlms' ),
'TR27' => __( 'Gaziantep', 'lifterlms' ),
'TR28' => __( 'Giresun', 'lifterlms' ),
'TR29' => __( 'Gümüşhane', 'lifterlms' ),
'TR30' => __( 'Hakkari', 'lifterlms' ),
'TR31' => __( 'Hatay', 'lifterlms' ),
'TR32' => __( 'Isparta', 'lifterlms' ),
'TR33' => __( 'İçel', 'lifterlms' ),
'TR34' => __( 'İstanbul', 'lifterlms' ),
'TR35' => __( 'İzmir', 'lifterlms' ),
'TR36' => __( 'Kars', 'lifterlms' ),
'TR37' => __( 'Kastamonu', 'lifterlms' ),
'TR38' => __( 'Kayseri', 'lifterlms' ),
'TR39' => __( 'Kırklareli', 'lifterlms' ),
'TR40' => __( 'Kırşehir', 'lifterlms' ),
'TR41' => __( 'Kocaeli', 'lifterlms' ),
'TR42' => __( 'Konya', 'lifterlms' ),
'TR43' => __( 'Kütahya', 'lifterlms' ),
'TR44' => __( 'Malatya', 'lifterlms' ),
'TR45' => __( 'Manisa', 'lifterlms' ),
'TR46' => __( 'Kahramanmaraş', 'lifterlms' ),
'TR47' => __( 'Mardin', 'lifterlms' ),
'TR48' => __( 'Muğla', 'lifterlms' ),
'TR49' => __( 'Muş', 'lifterlms' ),
'TR50' => __( 'Nevşehir', 'lifterlms' ),
'TR51' => __( 'Niğde', 'lifterlms' ),
'TR52' => __( 'Ordu', 'lifterlms' ),
'TR53' => __( 'Rize', 'lifterlms' ),
'TR54' => __( 'Sakarya', 'lifterlms' ),
'TR55' => __( 'Samsun', 'lifterlms' ),
'TR56' => __( 'Siirt', 'lifterlms' ),
'TR57' => __( 'Sinop', 'lifterlms' ),
'TR58' => __( 'Sivas', 'lifterlms' ),
'TR59' => __( 'Tekirdağ', 'lifterlms' ),
'TR60' => __( 'Tokat', 'lifterlms' ),
'TR61' => __( 'Trabzon', 'lifterlms' ),
'TR62' => __( 'Tunceli', 'lifterlms' ),
'TR63' => __( 'Şanlıurfa', 'lifterlms' ),
'TR64' => __( 'Uşak', 'lifterlms' ),
'TR65' => __( 'Van', 'lifterlms' ),
'TR66' => __( 'Yozgat', 'lifterlms' ),
'TR67' => __( 'Zonguldak', 'lifterlms' ),
'TR68' => __( 'Aksaray', 'lifterlms' ),
'TR69' => __( 'Bayburt', 'lifterlms' ),
'TR70' => __( 'Karaman', 'lifterlms' ),
'TR71' => __( 'Kırıkkale', 'lifterlms' ),
'TR72' => __( 'Batman', 'lifterlms' ),
'TR73' => __( 'Şırnak', 'lifterlms' ),
'TR74' => __( 'Bartın', 'lifterlms' ),
'TR75' => __( 'Ardahan', 'lifterlms' ),
'TR76' => __( 'Iğdır', 'lifterlms' ),
'TR77' => __( 'Yalova', 'lifterlms' ),
'TR78' => __( 'Karabük', 'lifterlms' ),
'TR79' => __( 'Kilis', 'lifterlms' ),
'TR80' => __( 'Osmaniye', 'lifterlms' ),
'TR81' => __( 'Düzce', 'lifterlms' ),
),
'TZ' => array( // Tanzanian states.
'TZ01' => __( 'Arusha', 'lifterlms' ),
'TZ02' => __( 'Dar es Salaam', 'lifterlms' ),
'TZ03' => __( 'Dodoma', 'lifterlms' ),
'TZ04' => __( 'Iringa', 'lifterlms' ),
'TZ05' => __( 'Kagera', 'lifterlms' ),
'TZ06' => __( 'Pemba North', 'lifterlms' ),
'TZ07' => __( 'Zanzibar North', 'lifterlms' ),
'TZ08' => __( 'Kigoma', 'lifterlms' ),
'TZ09' => __( 'Kilimanjaro', 'lifterlms' ),
'TZ10' => __( 'Pemba South', 'lifterlms' ),
'TZ11' => __( 'Zanzibar South', 'lifterlms' ),
'TZ12' => __( 'Lindi', 'lifterlms' ),
'TZ13' => __( 'Mara', 'lifterlms' ),
'TZ14' => __( 'Mbeya', 'lifterlms' ),
'TZ15' => __( 'Zanzibar West', 'lifterlms' ),
'TZ16' => __( 'Morogoro', 'lifterlms' ),
'TZ17' => __( 'Mtwara', 'lifterlms' ),
'TZ18' => __( 'Mwanza', 'lifterlms' ),
'TZ19' => __( 'Coast', 'lifterlms' ),
'TZ20' => __( 'Rukwa', 'lifterlms' ),
'TZ21' => __( 'Ruvuma', 'lifterlms' ),
'TZ22' => __( 'Shinyanga', 'lifterlms' ),
'TZ23' => __( 'Singida', 'lifterlms' ),
'TZ24' => __( 'Tabora', 'lifterlms' ),
'TZ25' => __( 'Tanga', 'lifterlms' ),
'TZ26' => __( 'Manyara', 'lifterlms' ),
'TZ27' => __( 'Geita', 'lifterlms' ),
'TZ28' => __( 'Katavi', 'lifterlms' ),
'TZ29' => __( 'Njombe', 'lifterlms' ),
'TZ30' => __( 'Simiyu', 'lifterlms' ),
),
'LK' => array(),
'RS' => array( // Serbian districts.
'RS00' => _x( 'Belgrade', 'district', 'lifterlms' ),
'RS14' => _x( 'Bor', 'district', 'lifterlms' ),
'RS11' => _x( 'Braničevo', 'district', 'lifterlms' ),
'RS02' => _x( 'Central Banat', 'district', 'lifterlms' ),
'RS10' => _x( 'Danube', 'district', 'lifterlms' ),
'RS23' => _x( 'Jablanica', 'district', 'lifterlms' ),
'RS09' => _x( 'Kolubara', 'district', 'lifterlms' ),
'RS08' => _x( 'Mačva', 'district', 'lifterlms' ),
'RS17' => _x( 'Morava', 'district', 'lifterlms' ),
'RS20' => _x( 'Nišava', 'district', 'lifterlms' ),
'RS01' => _x( 'North Bačka', 'district', 'lifterlms' ),
'RS03' => _x( 'North Banat', 'district', 'lifterlms' ),
'RS24' => _x( 'Pčinja', 'district', 'lifterlms' ),
'RS22' => _x( 'Pirot', 'district', 'lifterlms' ),
'RS13' => _x( 'Pomoravlje', 'district', 'lifterlms' ),
'RS19' => _x( 'Rasina', 'district', 'lifterlms' ),
'RS18' => _x( 'Raška', 'district', 'lifterlms' ),
'RS06' => _x( 'South Bačka', 'district', 'lifterlms' ),
'RS04' => _x( 'South Banat', 'district', 'lifterlms' ),
'RS07' => _x( 'Srem', 'district', 'lifterlms' ),
'RS12' => _x( 'Šumadija', 'district', 'lifterlms' ),
'RS21' => _x( 'Toplica', 'district', 'lifterlms' ),
'RS05' => _x( 'West Bačka', 'district', 'lifterlms' ),
'RS15' => _x( 'Zaječar', 'district', 'lifterlms' ),
'RS16' => _x( 'Zlatibor', 'district', 'lifterlms' ),
'RS25' => _x( 'Kosovo', 'district', 'lifterlms' ),
'RS26' => _x( 'Peć', 'district', 'lifterlms' ),
'RS27' => _x( 'Prizren', 'district', 'lifterlms' ),
'RS28' => _x( 'Kosovska Mitrovica', 'district', 'lifterlms' ),
'RS29' => _x( 'Kosovo-Pomoravlje', 'district', 'lifterlms' ),
'RSKM' => _x( 'Kosovo-Metohija', 'district', 'lifterlms' ),
'RSVO' => _x( 'Vojvodina', 'district', 'lifterlms' ),
),
'RW' => array(),
'SE' => array(),
'UA' => array( // Ukrainian oblasts. https://github.com/unicode-org/cldr/blob/release-42/common/subdivisions/en.xml#L5243.
'UA05' => __( 'Vinnychchyna', 'lifterlms' ),
'UA07' => __( 'Volyn', 'lifterlms' ),
'UA09' => __( 'Luhanshchyna', 'lifterlms' ),
'UA12' => __( 'Dnipropetrovshchyna', 'lifterlms' ),
'UA14' => __( 'Donechchyna', 'lifterlms' ),
'UA18' => __( 'Zhytomyrshchyna', 'lifterlms' ),
'UA21' => __( 'Zakarpattia', 'lifterlms' ),
'UA23' => __( 'Zaporizhzhya', 'lifterlms' ),
'UA26' => __( 'Prykarpattia', 'lifterlms' ),
'UA30' => __( 'Kyiv', 'lifterlms' ),
'UA32' => __( 'Kyivshchyna', 'lifterlms' ),
'UA35' => __( 'Kirovohradschyna', 'lifterlms' ),
'UA40' => __( 'Sevastopol', 'lifterlms' ),
'UA43' => __( 'Crimea', 'lifterlms' ),
'UA46' => __( 'Lvivshchyna', 'lifterlms' ),
'UA48' => __( 'Mykolayivschyna', 'lifterlms' ),
'UA51' => __( 'Odeshchyna', 'lifterlms' ),
'UA53' => __( 'Poltavshchyna', 'lifterlms' ),
'UA56' => __( 'Rivnenshchyna', 'lifterlms' ),
'UA59' => __( 'Sumshchyna', 'lifterlms' ),
'UA61' => __( 'Ternopilshchyna', 'lifterlms' ),
'UA63' => __( 'Kharkivshchyna', 'lifterlms' ),
'UA65' => __( 'Khersonshchyna', 'lifterlms' ),
'UA68' => __( 'Khmelnychchyna', 'lifterlms' ),
'UA71' => __( 'Cherkashchyna', 'lifterlms' ),
'UA74' => __( 'Chernihivshchyna', 'lifterlms' ),
'UA77' => __( 'Chernivtsi Oblast', 'lifterlms' ),
),
'UG' => array( // Ugandan districts.
'UG314' => __( 'Abim', 'lifterlms' ),
'UG301' => __( 'Adjumani', 'lifterlms' ),
'UG322' => __( 'Agago', 'lifterlms' ),
'UG323' => __( 'Alebtong', 'lifterlms' ),
'UG315' => __( 'Amolatar', 'lifterlms' ),
'UG324' => __( 'Amudat', 'lifterlms' ),
'UG216' => __( 'Amuria', 'lifterlms' ),
'UG316' => __( 'Amuru', 'lifterlms' ),
'UG302' => __( 'Apac', 'lifterlms' ),
'UG303' => __( 'Arua', 'lifterlms' ),
'UG217' => __( 'Budaka', 'lifterlms' ),
'UG218' => __( 'Bududa', 'lifterlms' ),
'UG201' => __( 'Bugiri', 'lifterlms' ),
'UG235' => __( 'Bugweri', 'lifterlms' ),
'UG420' => __( 'Buhweju', 'lifterlms' ),
'UG117' => __( 'Buikwe', 'lifterlms' ),
'UG219' => __( 'Bukedea', 'lifterlms' ),
'UG118' => __( 'Bukomansimbi', 'lifterlms' ),
'UG220' => __( 'Bukwa', 'lifterlms' ),
'UG225' => __( 'Bulambuli', 'lifterlms' ),
'UG416' => __( 'Buliisa', 'lifterlms' ),
'UG401' => __( 'Bundibugyo', 'lifterlms' ),
'UG430' => __( 'Bunyangabu', 'lifterlms' ),
'UG402' => __( 'Bushenyi', 'lifterlms' ),
'UG202' => __( 'Busia', 'lifterlms' ),
'UG221' => __( 'Butaleja', 'lifterlms' ),
'UG119' => __( 'Butambala', 'lifterlms' ),
'UG233' => __( 'Butebo', 'lifterlms' ),
'UG120' => __( 'Buvuma', 'lifterlms' ),
'UG226' => __( 'Buyende', 'lifterlms' ),
'UG317' => __( 'Dokolo', 'lifterlms' ),
'UG121' => __( 'Gomba', 'lifterlms' ),
'UG304' => __( 'Gulu', 'lifterlms' ),
'UG403' => __( 'Hoima', 'lifterlms' ),
'UG417' => __( 'Ibanda', 'lifterlms' ),
'UG203' => __( 'Iganga', 'lifterlms' ),
'UG418' => __( 'Isingiro', 'lifterlms' ),
'UG204' => __( 'Jinja', 'lifterlms' ),
'UG318' => __( 'Kaabong', 'lifterlms' ),
'UG404' => __( 'Kabale', 'lifterlms' ),
'UG405' => __( 'Kabarole', 'lifterlms' ),
'UG213' => __( 'Kaberamaido', 'lifterlms' ),
'UG427' => __( 'Kagadi', 'lifterlms' ),
'UG428' => __( 'Kakumiro', 'lifterlms' ),
'UG101' => __( 'Kalangala', 'lifterlms' ),
'UG222' => __( 'Kaliro', 'lifterlms' ),
'UG122' => __( 'Kalungu', 'lifterlms' ),
'UG102' => __( 'Kampala', 'lifterlms' ),
'UG205' => __( 'Kamuli', 'lifterlms' ),
'UG413' => __( 'Kamwenge', 'lifterlms' ),
'UG414' => __( 'Kanungu', 'lifterlms' ),
'UG206' => __( 'Kapchorwa', 'lifterlms' ),
'UG236' => __( 'Kapelebyong', 'lifterlms' ),
'UG126' => __( 'Kasanda', 'lifterlms' ),
'UG406' => __( 'Kasese', 'lifterlms' ),
'UG207' => __( 'Katakwi', 'lifterlms' ),
'UG112' => __( 'Kayunga', 'lifterlms' ),
'UG407' => __( 'Kibaale', 'lifterlms' ),
'UG103' => __( 'Kiboga', 'lifterlms' ),
'UG227' => __( 'Kibuku', 'lifterlms' ),
'UG432' => __( 'Kikuube', 'lifterlms' ),
'UG419' => __( 'Kiruhura', 'lifterlms' ),
'UG421' => __( 'Kiryandongo', 'lifterlms' ),
'UG408' => __( 'Kisoro', 'lifterlms' ),
'UG305' => __( 'Kitgum', 'lifterlms' ),
'UG319' => __( 'Koboko', 'lifterlms' ),
'UG325' => __( 'Kole', 'lifterlms' ),
'UG306' => __( 'Kotido', 'lifterlms' ),
'UG208' => __( 'Kumi', 'lifterlms' ),
'UG333' => __( 'Kwania', 'lifterlms' ),
'UG228' => __( 'Kween', 'lifterlms' ),
'UG123' => __( 'Kyankwanzi', 'lifterlms' ),
'UG422' => __( 'Kyegegwa', 'lifterlms' ),
'UG415' => __( 'Kyenjojo', 'lifterlms' ),
'UG125' => __( 'Kyotera', 'lifterlms' ),
'UG326' => __( 'Lamwo', 'lifterlms' ),
'UG307' => __( 'Lira', 'lifterlms' ),
'UG229' => __( 'Luuka', 'lifterlms' ),
'UG104' => __( 'Luwero', 'lifterlms' ),
'UG124' => __( 'Lwengo', 'lifterlms' ),
'UG114' => __( 'Lyantonde', 'lifterlms' ),
'UG223' => __( 'Manafwa', 'lifterlms' ),
'UG320' => __( 'Maracha', 'lifterlms' ),
'UG105' => __( 'Masaka', 'lifterlms' ),
'UG409' => __( 'Masindi', 'lifterlms' ),
'UG214' => __( 'Mayuge', 'lifterlms' ),
'UG209' => __( 'Mbale', 'lifterlms' ),
'UG410' => __( 'Mbarara', 'lifterlms' ),
'UG423' => __( 'Mitooma', 'lifterlms' ),
'UG115' => __( 'Mityana', 'lifterlms' ),
'UG308' => __( 'Moroto', 'lifterlms' ),
'UG309' => __( 'Moyo', 'lifterlms' ),
'UG106' => __( 'Mpigi', 'lifterlms' ),
'UG107' => __( 'Mubende', 'lifterlms' ),
'UG108' => __( 'Mukono', 'lifterlms' ),
'UG334' => __( 'Nabilatuk', 'lifterlms' ),
'UG311' => __( 'Nakapiripirit', 'lifterlms' ),
'UG116' => __( 'Nakaseke', 'lifterlms' ),
'UG109' => __( 'Nakasongola', 'lifterlms' ),
'UG230' => __( 'Namayingo', 'lifterlms' ),
'UG234' => __( 'Namisindwa', 'lifterlms' ),
'UG224' => __( 'Namutumba', 'lifterlms' ),
'UG327' => __( 'Napak', 'lifterlms' ),
'UG310' => __( 'Nebbi', 'lifterlms' ),
'UG231' => __( 'Ngora', 'lifterlms' ),
'UG424' => __( 'Ntoroko', 'lifterlms' ),
'UG411' => __( 'Ntungamo', 'lifterlms' ),
'UG328' => __( 'Nwoya', 'lifterlms' ),
'UG331' => __( 'Omoro', 'lifterlms' ),
'UG329' => __( 'Otuke', 'lifterlms' ),
'UG321' => __( 'Oyam', 'lifterlms' ),
'UG312' => __( 'Pader', 'lifterlms' ),
'UG332' => __( 'Pakwach', 'lifterlms' ),
'UG210' => __( 'Pallisa', 'lifterlms' ),
'UG110' => __( 'Rakai', 'lifterlms' ),
'UG429' => __( 'Rubanda', 'lifterlms' ),
'UG425' => __( 'Rubirizi', 'lifterlms' ),
'UG431' => __( 'Rukiga', 'lifterlms' ),
'UG412' => __( 'Rukungiri', 'lifterlms' ),
'UG111' => __( 'Sembabule', 'lifterlms' ),
'UG232' => __( 'Serere', 'lifterlms' ),
'UG426' => __( 'Sheema', 'lifterlms' ),
'UG215' => __( 'Sironko', 'lifterlms' ),
'UG211' => __( 'Soroti', 'lifterlms' ),
'UG212' => __( 'Tororo', 'lifterlms' ),
'UG113' => __( 'Wakiso', 'lifterlms' ),
'UG313' => __( 'Yumbe', 'lifterlms' ),
'UG330' => __( 'Zombo', 'lifterlms' ),
),
'UM' => array(
'81' => __( 'Baker Island', 'lifterlms' ),
'84' => __( 'Howland Island', 'lifterlms' ),
'86' => __( 'Jarvis Island', 'lifterlms' ),
'67' => __( 'Johnston Atoll', 'lifterlms' ),
'89' => __( 'Kingman Reef', 'lifterlms' ),
'71' => __( 'Midway Atoll', 'lifterlms' ),
'76' => __( 'Navassa Island', 'lifterlms' ),
'95' => __( 'Palmyra Atoll', 'lifterlms' ),
'79' => __( 'Wake Island', 'lifterlms' ),
),
'US' => array( // U.S. states.
'AL' => __( 'Alabama', 'lifterlms' ),
'AK' => __( 'Alaska', 'lifterlms' ),
'AZ' => __( 'Arizona', 'lifterlms' ),
'AR' => __( 'Arkansas', 'lifterlms' ),
'CA' => __( 'California', 'lifterlms' ),
'CO' => __( 'Colorado', 'lifterlms' ),
'CT' => __( 'Connecticut', 'lifterlms' ),
'DE' => __( 'Delaware', 'lifterlms' ),
'DC' => __( 'District of Columbia', 'lifterlms' ),
'FL' => __( 'Florida', 'lifterlms' ),
'GA' => _x( 'Georgia', 'US state of Georgia', 'lifterlms' ),
'HI' => __( 'Hawaii', 'lifterlms' ),
'ID' => __( 'Idaho', 'lifterlms' ),
'IL' => __( 'Illinois', 'lifterlms' ),
'IN' => __( 'Indiana', 'lifterlms' ),
'IA' => __( 'Iowa', 'lifterlms' ),
'KS' => __( 'Kansas', 'lifterlms' ),
'KY' => __( 'Kentucky', 'lifterlms' ),
'LA' => __( 'Louisiana', 'lifterlms' ),
'ME' => __( 'Maine', 'lifterlms' ),
'MD' => __( 'Maryland', 'lifterlms' ),
'MA' => __( 'Massachusetts', 'lifterlms' ),
'MI' => __( 'Michigan', 'lifterlms' ),
'MN' => __( 'Minnesota', 'lifterlms' ),
'MS' => __( 'Mississippi', 'lifterlms' ),
'MO' => __( 'Missouri', 'lifterlms' ),
'MT' => __( 'Montana', 'lifterlms' ),
'NE' => __( 'Nebraska', 'lifterlms' ),
'NV' => __( 'Nevada', 'lifterlms' ),
'NH' => __( 'New Hampshire', 'lifterlms' ),
'NJ' => __( 'New Jersey', 'lifterlms' ),
'NM' => __( 'New Mexico', 'lifterlms' ),
'NY' => __( 'New York', 'lifterlms' ),
'NC' => __( 'North Carolina', 'lifterlms' ),
'ND' => __( 'North Dakota', 'lifterlms' ),
'OH' => __( 'Ohio', 'lifterlms' ),
'OK' => __( 'Oklahoma', 'lifterlms' ),
'OR' => __( 'Oregon', 'lifterlms' ),
'PA' => __( 'Pennsylvania', 'lifterlms' ),
'RI' => __( 'Rhode Island', 'lifterlms' ),
'SC' => __( 'South Carolina', 'lifterlms' ),
'SD' => __( 'South Dakota', 'lifterlms' ),
'TN' => __( 'Tennessee', 'lifterlms' ),
'TX' => __( 'Texas', 'lifterlms' ),
'UT' => __( 'Utah', 'lifterlms' ),
'VT' => __( 'Vermont', 'lifterlms' ),
'VA' => __( 'Virginia', 'lifterlms' ),
'WA' => __( 'Washington', 'lifterlms' ),
'WV' => __( 'West Virginia', 'lifterlms' ),
'WI' => __( 'Wisconsin', 'lifterlms' ),
'WY' => __( 'Wyoming', 'lifterlms' ),
'AA' => __( 'Armed Forces (AA)', 'lifterlms' ),
'AE' => __( 'Armed Forces (AE)', 'lifterlms' ),
'AP' => __( 'Armed Forces (AP)', 'lifterlms' ),
),
'UY' => array( // Uruguayan states.
'UY-AR' => __( 'Artigas', 'lifterlms' ),
'UY-CA' => __( 'Canelones', 'lifterlms' ),
'UY-CL' => __( 'Cerro Largo', 'lifterlms' ),
'UY-CO' => __( 'Colonia', 'lifterlms' ),
'UY-DU' => __( 'Durazno', 'lifterlms' ),
'UY-FS' => __( 'Flores', 'lifterlms' ),
'UY-FD' => __( 'Florida', 'lifterlms' ),
'UY-LA' => __( 'Lavalleja', 'lifterlms' ),
'UY-MA' => __( 'Maldonado', 'lifterlms' ),
'UY-MO' => __( 'Montevideo', 'lifterlms' ),
'UY-PA' => __( 'Paysandú', 'lifterlms' ),
'UY-RN' => __( 'Río Negro', 'lifterlms' ),
'UY-RV' => __( 'Rivera', 'lifterlms' ),
'UY-RO' => __( 'Rocha', 'lifterlms' ),
'UY-SA' => __( 'Salto', 'lifterlms' ),
'UY-SJ' => __( 'San José', 'lifterlms' ),
'UY-SO' => __( 'Soriano', 'lifterlms' ),
'UY-TA' => __( 'Tacuarembó', 'lifterlms' ),
'UY-TT' => __( 'Treinta y Tres', 'lifterlms' ),
),
'VE' => array( // Venezuelan states.
'VE-A' => __( 'Capital', 'lifterlms' ),
'VE-B' => __( 'Anzoátegui', 'lifterlms' ),
'VE-C' => __( 'Apure', 'lifterlms' ),
'VE-D' => __( 'Aragua', 'lifterlms' ),
'VE-E' => __( 'Barinas', 'lifterlms' ),
'VE-F' => __( 'Bolívar', 'lifterlms' ),
'VE-G' => __( 'Carabobo', 'lifterlms' ),
'VE-H' => __( 'Cojedes', 'lifterlms' ),
'VE-I' => __( 'Falcón', 'lifterlms' ),
'VE-J' => __( 'Guárico', 'lifterlms' ),
'VE-K' => __( 'Lara', 'lifterlms' ),
'VE-L' => __( 'Mérida', 'lifterlms' ),
'VE-M' => __( 'Miranda', 'lifterlms' ),
'VE-N' => __( 'Monagas', 'lifterlms' ),
'VE-O' => __( 'Nueva Esparta', 'lifterlms' ),
'VE-P' => __( 'Portuguesa', 'lifterlms' ),
'VE-R' => __( 'Sucre', 'lifterlms' ),
'VE-S' => __( 'Táchira', 'lifterlms' ),
'VE-T' => __( 'Trujillo', 'lifterlms' ),
'VE-U' => __( 'Yaracuy', 'lifterlms' ),
'VE-V' => __( 'Zulia', 'lifterlms' ),
'VE-W' => __( 'Federal Dependencies', 'lifterlms' ),
'VE-X' => __( 'La Guaira (Vargas)', 'lifterlms' ),
'VE-Y' => __( 'Delta Amacuro', 'lifterlms' ),
'VE-Z' => __( 'Amazonas', 'lifterlms' ),
),
'VN' => array(),
'YT' => array(),
'ZA' => array( // South African states.
'EC' => __( 'Eastern Cape', 'lifterlms' ),
'FS' => __( 'Free State', 'lifterlms' ),
'GP' => __( 'Gauteng', 'lifterlms' ),
'KZN' => __( 'KwaZulu-Natal', 'lifterlms' ),
'LP' => __( 'Limpopo', 'lifterlms' ),
'MP' => __( 'Mpumalanga', 'lifterlms' ),
'NC' => __( 'Northern Cape', 'lifterlms' ),
'NW' => __( 'North West', 'lifterlms' ),
'WC' => __( 'Western Cape', 'lifterlms' ),
),
'ZM' => array( // Zambian provinces.
'ZM-01' => __( 'Western', 'lifterlms' ),
'ZM-02' => __( 'Central', 'lifterlms' ),
'ZM-03' => __( 'Eastern', 'lifterlms' ),
'ZM-04' => __( 'Luapula', 'lifterlms' ),
'ZM-05' => __( 'Northern', 'lifterlms' ),
'ZM-06' => __( 'North-Western', 'lifterlms' ),
'ZM-07' => __( 'Southern', 'lifterlms' ),
'ZM-08' => __( 'Copperbelt', 'lifterlms' ),
'ZM-09' => __( 'Lusaka', 'lifterlms' ),
'ZM-10' => __( 'Muchinga', 'lifterlms' ),
),
);
================================================
FILE: lerna.json
================================================
{
"packages": [
"packages/*"
],
"version": "independent"
}
================================================
FILE: libraries/README.md
================================================
External Libraries
==================
Installation directory for plugin libraries included in the core plugin but developed outside of this repository.
See [Installing for Development](../docs/installing.md) for installation instructions.
================================================
FILE: libraries/index.php
================================================
<?php // Quiet.
================================================
FILE: lifterlms.php
================================================
<?php
/**
* Main LifterLMS plugin file
*
* @package LifterLMS/Main
*
* @since 1.0.0
* @version 5.3.0
*
* Plugin Name: LifterLMS
* Plugin URI: https://lifterlms.com/
* Description: Complete e-learning platform to sell online courses, protect lessons, offer memberships, and quiz students. WP Learning Management System.
* Version: 10.0.0
* Author: LifterLMS
* Author URI: https://lifterlms.com/
* Text Domain: lifterlms
* Domain Path: /languages
* License: GPLv3
* License URI: https://www.gnu.org/licenses/gpl-3.0.html
* Requires at least: 5.9
* Tested up to: 6.9
* Requires PHP: 7.4
*
* * * * * * * * * * * * * * * * * * * * * *
* *
* Reporting a Security Vulnerability *
* *
* Please disclose any security issues or *
* vulnerabilities to team@lifterlms.com *
* *
* See our full Security Policy at *
* https://lifterlms.com/security-policy *
* *
* * * * * * * * * * * * * * * * * * * * * *
*/
defined( 'ABSPATH' ) || exit;
if ( ! defined( 'LLMS_PLUGIN_FILE' ) ) {
define( 'LLMS_PLUGIN_FILE', __FILE__ );
}
if ( ! defined( 'LLMS_PLUGIN_DIR' ) ) {
define( 'LLMS_PLUGIN_DIR', __DIR__ . '/' );
}
// Autoloader.
require_once LLMS_PLUGIN_DIR . 'vendor/autoload.php';
require_once LLMS_PLUGIN_DIR . 'includes/class-llms-loader.php';
if ( ! class_exists( 'LifterLMS' ) ) {
require_once LLMS_PLUGIN_DIR . 'class-lifterlms.php';
}
register_activation_hook( __FILE__, array( 'LLMS_Install', 'install' ) );
require_once LLMS_PLUGIN_DIR . 'includes/llms-notifications.php';
/**
* Returns the main instance of LifterLMS
*
* @since 4.0.0
*
* @return LifterLMS
*/
function llms() {
return LifterLMS::instance();
}
return llms();
================================================
FILE: package.json
================================================
{
"name": "lifterlms",
"version": "10.0.0",
"description": "LifterLMS by codeBOX",
"repository": {
"type": "git",
"url": "https://github.com/gocodebox/lifterlms.git"
},
"author": "Team LifterLMS <team@lifterlms.com>",
"license": "GPL-3.0",
"bugs": {
"url": "https://github.com/gocodebox/lifterlms/issues"
},
"homepage": "https://lifterlms.com",
"engines": {
"node": ">=16.0.0",
"npm": ">=8.0.0"
},
"dependencies": {
"@emotion/styled": "^11.6.0",
"classnames": "^2.3.1"
},
"devDependencies": {
"@lifterlms/brand": "file:packages/brand",
"@lifterlms/components": "file:packages/components",
"@lifterlms/dev": "file:packages/dev",
"@lifterlms/fontawesome": "file:packages/fontawesome",
"@lifterlms/icons": "file:packages/icons",
"@lifterlms/llms-e2e-test-utils": "file:packages/llms-e2e-test-utils",
"@lifterlms/scripts": "file:packages/scripts",
"@lifterlms/utils": "file:packages/utils",
"@wordpress/docgen": "^1.18.0",
"gulp-header": "^2.0.9",
"gulp-replace": "^0.5.4",
"gulp-requirejs-optimize": "^1.2.0",
"gulp-uglify": "^3.0.2",
"lerna": "^5.5.2",
"lifterlms-lib-tasks": "^4.0.1",
"postcss": "^8.4.6"
},
"scripts": {
"clean": "rm -f assets/js/*.min.js assets/js/*.asset.php assets/css/*.map assets/js/*.map assets/maps/*.map assets/css/*.map",
"build": "npm run clean && npm run build:scripts && npm run build:scripts:legacy && npm run build:styles && npm run build:pot && llms-dev readme",
"build:pot": "gulp pot-js && llms-dev pot",
"build:scripts": "wp-scripts build",
"build:scripts:legacy": "gulp scripts && gulp js-additional && gulp js-builder",
"build:styles": "gulp styles && gulp styles-rtl && gulp hacky-clean",
"build:blocks": "wp-scripts build --config packages/scripts/config/blocks-webpack.config.js",
"dev": "llms-dev",
"lerna": "lerna",
"lint:js": "wp-scripts lint-js ./src/js ./src/blocks",
"test": "wp-scripts test-e2e --config packages/scripts/e2e/jest.config.js",
"test:dev": "npm run test -- --puppeteer-interactive",
"test:unit": "wp-scripts test-unit-js ./src/js --config packages/scripts/config/jest-unit.config.js --verbose",
"pkg:docgen": "lerna run docgen",
"pkg:hoist": "lerna bootstrap --hoist",
"pkg:lint:js": "lerna run lint:js",
"pkg:test": "wp-scripts test-unit-js ./packages --config packages/scripts/config/jest-unit.config.js --verbose",
"postinstall": "npm run pkg:hoist",
"start": "wp-scripts start",
"start:legacy": "gulp watch",
"start:blocks": "wp-scripts start --config packages/scripts/config/blocks-webpack.config.js"
}
}
================================================
FILE: packages/README.md
================================================
LifterLMS Javascript Packages
=============================
This repository uses [lerna](https://lerna.js.org/) to manage LifterLMS modules and publish them as packages to [npm](https://www.npmjs.com/).
---
## Package Changelogs
Each package is versioned independently and maintains its own changelog.
When updating packages, an update to the changelog should be included outlining the changes. This should be added to the "Unreleased" heading at the top of the changelog file. If the heading doesn't already exist it should be added.
Additionally, methods and functions keep their own changelogs (like the LifterLMS core plugin) and `[version]` placeholders should be used for unreleased changes.
## Inclusion in the LifterLMS Core Plugin
Some packages are included in the LifterLMS Core Plugin. See package details for usage instructions. Each package that is included this way maintains a table outlining the package version included in various LifterLMS versions.
## API Documentation
Where applicable, each package maintains its own independent API documentation which is published to the package's README.md file. The API documentation is automatically generated using the `docgen` script for each package.
## Scripts
Most packages should include at least a `docgen`, `lint:js`, and `test` script. These can be run within the package itself and in bulk via the associated `pkg:*` commands from with the root directory of the repository.
## Publishing Releases
Releases are published using the `npm run lerna publish` command from the repository root on the `trunk` branch.
_Note: Packages which are included with the LifterLMS core should *always* be released alongside LifterLMS core releases._
To publish a release:
+ Make sure you are on the trunk branch.
+ Make sure you are logged into npmjs. Run `npm adduser` and follow the prompt.
+ Run `npm run lerna changed` to see which packages have changes to be published.
+ Ensure the `lint:js` and `test` scripts pass.
+ Ensure CHANGELOG.md in each package directory has been updated to the appropriate version and the "Unreleased" header has been removed.
+ Run `npm run dev update-version -- -F {version}` from each packages directory to update `[version]` placeholders to the appropriate version.
+ Commit and push changes to git from the base lifterlms directory.
+ Run `npm run lerna publish` and follow the prompts. (Alternatively, publish with `npm publish .` from each packages directory.
================================================
FILE: packages/brand/README.md
================================================
LifterLMS Brand
===============
LifterLMS brand icons, colors, and more.
## Installation
Install the module
```
npm install --save @lifterlms/brand
```
## Usage
### SCSS Colors
Import LifterLMS brand colors and WordPress core admin colors:
_Note: Ensure that `node_modules` is included in your SASS load path!_
```scss
// Import all brand files.
@import '@lifterlms/brand/sass/brand'
// Import colors only.
@import '@lifterlms/brand/sass/colors'
// Import typography only.
@import '@lifterlms/brand/sass/typography'
// Use a color.
body {
background: llms-color( llms-blue );
}
// Use the gradient mixin.
.banner {
@include llms-gradient-bg();
}
// Use a font.
body {
font-family: llms-font( llms-sans );
}
`
================================================
FILE: packages/brand/package.json
================================================
{
"name": "@lifterlms/brand",
"version": "0.0.2",
"description": "LifterLMS brand icons, colors, and more.",
"author": "Team LifterLMS <team@lifterlms.com>",
"license": "GPL-3.0-or-later",
"homepage": "https://github.com/gocodebox/lifterlms/tree/master/packages/brand",
"keywords": [
"lifterlms",
"wordpress"
],
"repository": {
"type": "git",
"url": "https://github.com/gocodebox/lifterlms.git",
"directory": "packages/brand"
},
"bugs": {
"url": "https://github.com/gocodebox/lifterlms/labels/package%3A%20brand"
},
"publishConfig": {
"access": "public"
}
}
================================================
FILE: packages/brand/sass/brand.scss
================================================
@import 'colors';
@import 'typography';
================================================
FILE: packages/brand/sass/colors.scss
================================================
// Color Map.
$colors: (
// LifterLMS Brand Colors.
llms-blue: #466dd8,
llms-blue-alt: #2295ff,
llms-orange: #f8954f,
// Standard colors.
white: #fff,
black: #000,
// WP Colors.
// @link https://make.wordpress.org/core/2021/02/23/standardization-of-wp-admin-colors-in-wordpress-5-7/
wp-gray-0: #f6f7f7,
wp-gray-2: #f0f0f1,
wp-gray-5: #dcdcde,
wp-gray-10: #c3c4c7,
wp-gray-20: #a7aaad,
wp-gray-30: #8c8f94,
wp-gray-40: #787c82,
wp-gray-50: #646970,
wp-gray-60: #50575e,
wp-gray-70: #3c434a,
wp-gray-80: #2c3338,
wp-gray-90: #1d2327,
wp-gray-100: #101517,
wp-blue-0: #f0f6fc,
wp-blue-5: #c5d9ed,
wp-blue-10: #9ec2e6,
wp-blue-20: #72aee6,
wp-blue-30: #4f94d4,
wp-blue-40: #3582c4,
wp-blue-50: #2271b1,
wp-blue-60: #135e96,
wp-blue-70: #0a4b78,
wp-blue-80: #043959,
wp-blue-90: #01263a,
wp-blue-100: #00131c,
wp-red-0: #fcf0f1,
wp-red-5: #facfd2,
wp-red-10: #ffabaf,
wp-red-20: #ff8085,
wp-red-30: #f86368,
wp-red-40: #e65054,
wp-red-50: #d63638,
wp-red-60: #b32d2e,
wp-red-70: #8a2424,
wp-red-80: #691c1c,
wp-red-90: #451313,
wp-red-100: #240a0a,
wp-yellow-0: #fcf9e8,
wp-yellow-5: #f5e6ab,
wp-yellow-10: #f2d675,
wp-yellow-20: #f0c33c,
wp-yellow-30: #dba617,
wp-yellow-40: #bd8600,
wp-yellow-50: #996800,
wp-yellow-60: #755100,
wp-yellow-70: #614200,
wp-yellow-80: #4a3200,
wp-yellow-90: #362400,
wp-yellow-100: #211600,
wp-green-0: #edfaef,
wp-green-5: #b8e6bf,
wp-green-10: #68de7c,
wp-green-20: #1ed14b,
wp-green-30: #00ba37,
wp-green-40: #00a32a,
wp-green-50: #008a20,
wp-green-60: #007017,
wp-green-70: #005c12,
wp-green-80: #00450c,
wp-green-90: #003008,
wp-green-100: #001c05
);
// Simple function to retreive colors in the $colors map.
// e.g. `background-color: color( gray-50 );`
@function llms-color( $key ) {
@if map-has-key( $colors, $key ) {
@return map-get( $colors, $key );
}
@warn "Unknown `#{$key}` in $colors.";
@return null;
}
@function llms-gradient() {
@return linear-gradient( 45deg, llms-color( llms-blue-alt ), llms-color( llms-blue ) );
}
// Use the LifterLMS brand gradient as the background of an element.
// e.g.: `@include llms-gradient-bg()`
@mixin llms-gradient-bg() {
background: llms-color( llms-blue );
background: llms-gradient();
}
================================================
FILE: packages/brand/sass/typography.scss
================================================
$fonts: (
llms-sans: 'Montserrat, sans-serif',
llms-mono: monospace,
);
@function llms-font( $key ) {
@if map-has-key( $fonts, $key ) {
@return map-get( $fonts, $key );
}
@warn "Unknown `#{$key}` in $fonts.";
@return null;
}
================================================
FILE: packages/components/.llmsdev.yml
================================================
update-version:
skip-config: true
================================================
FILE: packages/components/.npmrc
================================================
package-lock=false
================================================
FILE: packages/components/CHANGELOG.md
================================================
@lifterlms/components CHANGELOG
===============================
v1.1.0 - 2022-10-12
-------------------
+ Adds a spinner component intended to replace `LLMS.Spinner`.
v1.0.0 - 2022-03-08
-------------------
+ Initial public release.
================================================
FILE: packages/components/README.md
================================================
# LifterLMS UI Components
UI components for use in LifterLMS and LifterLMS add-ons. This package extends functionality provided by [@wordpress/components](https://github.com/WordPress/gutenberg/tree/master/packages/components), adding additional components specific to the LifterLMS project.
## Usage in a LifterLMS add-on
This package is included in the LifterLMS core plugin as a module and registered using the WordPress scripts dependency API (see [wp_register_script()][https://developer.wordpress.org/reference/functions/wp_register_script/]).
To use components you can add `llms-components` as a dependency to your script and access the module via `window.llms.components`, for example:
```js
const { ButtonGroupControl } = window.llms.components;
```
## LifterLMS Versions
The following table records the module version and which LifterLMS versions it has been included in.
| Module Version | LifterLMS Version |
| -------------- | ----------------- |
| 1.0.0 | 6.0.0 |
## Installation
Install the module as a dependency in your project:
```bash
npm install --save-dev @lifterlms/components`
```
## Changelog
[View the Changelog](./CHANGELOG.md)
## API Docs
<!-- START TOKEN(Autogenerated API docs) -->
### BaseSearchControl
Searchable <select> element powered by a WordPress REST API endpoint.
_Parameters_
- _args_ `Object`: Component arguments.
- _args.searchPath_ `string`: Required. API path used to perform the search.
- _args.onUpdate_ `Function`: Callback function invoked when the value of the select changes. The callback function is passed a single parameter, the new selected value object(s). For multiselects it will be an array of objects. If the select is clearable, the value will be `null` when the select is cleared.
- _args.selectedValue_ `Array`: The currently selected value(s). If an object is passed, it should contain at least a `label` and `value` key. Can pass IDs as integers and the values will be automatically hydrated.
- _args.placeholder_ `string`: The placeholder displayed within an empty search control.
- _args.className_ `string`: HTML class attribute added to the select control.
- _args.classNamePrefix_ `string`: Prefix added to select control subcomponent classnames. In most circumstances this should not be changed as it is used to style the compontents.
- _args.searchDebounceDelay_ `number`: Search debounce delay, in milliseconds.
- _args.additionalSearchArgs_ `Object`: Object of additional query string arguments to use with the API request.
- _args.label_ `?string`: Search control label, passed to <BaseControl>.
- _args.id_ `?string`: Search control HTML ID attribute, passed to <BaseControl>.
- _args.defaultOptions_ `?Object[]`: Array of hydrated objects to preload into the select as options.
- _args.getSearchArgs_ `?Function`: Function invoked to generate the query string arguments used when fetching results from the API. The callback function is passed the search string.
- _args.getSearchURL_ `?Function`: Function invoked to create the search URL used to fetch results. The function is passed the `searchPath` and generated query string arguments from `getSearchArgs()`.
- _args.hydrateValues_ `?Function`: Function invoked to hydrate integer values. The function is passed the currently selected values, the `searchPath`, and an array of cached (and hydrated) objects previously loaded from the server.
- _args.formatSearchResults_ `?Function`: Function invoked to format results retrieved from the server. The function is passed an array of objects from the server. It should return an array of objects, each containing at least a value and label property.
- _args.formatSearchResultLabel_ `?Function`: Function invoked to format the display label for a result. The function is passed an object representing a single result and should return a string.
- _args.formatSearchResultValue_ `?Function`: Function invoked to format the saved value for a result. The function is passed an object representing a single result and should the value to be stored.
- _args.selectProps_ `...*`: Any remaining properties are passed to the <Select> component, {@link <https://react-select.com/props#select-props}>.
_Returns_
- `StyledBaseControl`: The component.
### ButtonGroupControl
Button Group Control component
Similar to the experimental `<RadioGroup>` component from @wordpress/components but it allows
passing in an array of options.
_Related_
- BaseControl <https://github.com/WordPress/gutenberg/tree/trunk/packages/components/src/base-control>
_Parameters_
- _props_ `Object`: Component properties object.
- _props.label_ `string`: Control label text.
- _props.className_ `string`: Control element css class name attribute.
- _props.id_ `string`: Control element ID attribute.
- _props.onClick_ `Function`: Callback function when a button in the group is clicked.
- _props.selected_ `string`: The value of the currently selected option.
- _props.options_ `Object[]`: An array of objects used to create the buttons in the group. Each object should contain at least a "label" and "value" property and can optionally include an "icon" property.
_Returns_
- `BaseControl`: The rendered component.
### CopyButton
A "click to copy" button.
Uses the `useCopyToClipboard()` hook with a <Button> on WP 5.8 & later, otherwise falls back
to the deprecated <ClipboardButton>.
_Parameters_
- _args_ `Object`: Component arguments.
- _args.buttonText_ `string`: Text to to display within the button.
- _args.copyText_ `string`: Text to copy to the clipboard.
- _args.tooltipText_ `string`: Text to use in the tooltip wrapper around the button.
- _args.onCopy_ `Function`: Copy success callback function.
- _args.buttonProps_ `...*`: Remaining properties passed to the underlying <Button> component.
_Returns_
- `Object`: The copy button fragment.
### PostSearchControl
Searchable <select> element powered by a WordPress REST API users endpoint.
This component is a wrapper around the <BaseSearchControl> component. It is configured
to search users via the WordPress user REST API endpoint.
_Parameters_
- _args_ `Object`: Component arguments.
- _args.postType_ `string`: Post type endpoint.
- _args.baseSearchPath_ `string`: Base search path used to create the searchPath.
- _args.searchPath_ `?string`: API path used to perform the search. If passed, will be used instead of the path generated from `args.postType` and `args.baseSearchPath`.
- _args.placeholder_ `string`: The placeholder displayed within an empty search control.
- _args.className_ `string`: HTML class attribute added to the select control.
- _args.formatSearchResultLabel_ `?Function`: Function invoked to format the display label for a result. The function is passed
- _args.additionalSearchArgs_ `Object`: An object representing a single result and should return a string.
- _args.baseProps_ `...*`: Any remaining properties are passed to the <BaseSearchControl> component.
_Returns_
- `BaseSearchControl`: The component.
### UserSearchControl
Searchable <select> element powered by a WordPress REST API users endpoint.
This component is a wrapper around the <BaseSearchControl> component. It is configured
to search users via the WordPress user REST API endpoint.
_Parameters_
- _args_ `Object`: Component arguments.
- _args.searchPath_ `string`: Required. API path used to perform the search.
- _args.placeholder_ `string`: The placeholder displayed within an empty search control.
- _args.className_ `string`: HTML class attribute added to the select control.
- _args.formatSearchResultLabel_ `?Function`: Function invoked to format the display label for a result. The function is passed
- _args.additionalSearchArgs_ `Object`: An object representing a single result and should return a string.
- _args.baseProps_ `...*`: Any remaining properties are passed to the <BaseSearchControl> component.
_Returns_
- `BaseSearchControl`: The component.
<!-- END TOKEN(Autogenerated API docs) -->
================================================
FILE: packages/components/babel.config.js
================================================
/**
* Babel config
*
* @package
*
* @since 1.0.0
* @version 1.0.0
*/
const presets = [ '@wordpress/default' ];
module.exports = { presets };
================================================
FILE: packages/components/package.json
================================================
{
"name": "@lifterlms/components",
"version": "1.1.0",
"description": "UI components for LifterLMS.",
"author": "Team LifterLMS <dev@lifterlms.com>",
"license": "GPL-3.0-or-later",
"homepage": "https://github.com/gocodebox/lifterlms/tree/trunk/packages/components",
"keywords": [
"lifterlms",
"wordpress",
"components",
"ui"
],
"repository": {
"type": "git",
"url": "https://github.com/gocodebox/lifterlms.git",
"directory": "packages/components"
},
"bugs": {
"url": "https://github.com/gocodebox/lifterlms/labels/package%3A%components"
},
"main": "src/index.js",
"publishConfig": {
"access": "public"
},
"dependencies": {
"@emotion/styled": "^11.6.0",
"@wordpress/api-fetch": "^5.2.6",
"@wordpress/components": "^19.5.0",
"@wordpress/compose": "^5.0.6",
"@wordpress/element": "^4.14.0",
"@wordpress/i18n": "^4.2.4",
"@wordpress/url": "^3.3.1",
"lodash": "^4.17.21",
"react-select": "^5.2.1",
"throttle-debounce": "^3.0.1"
},
"devDependencies": {
"@testing-library/react": "^12.1.2"
},
"scripts": {
"docgen": "docgen src/index.js --output README.md --to-token",
"dev": "./../dev/src/index.js",
"lint:js": "wp-scripts lint-js ./ --config ../../.eslintrc.js",
"test": "wp-scripts test-unit-js ./ --config ../scripts/config/jest-unit.config.js --verbose"
}
}
================================================
FILE: packages/components/src/button-group-control/index.js
================================================
// WP deps.
import { BaseControl, Button, ButtonGroup } from '@wordpress/components';
import { useState } from '@wordpress/element';
/**
* Button Group Control component
*
* Similar to the experimental `<RadioGroup>` component from @wordpress/components but it allows
* passing in an array of options.
*
* @since 1.0.0
*
* @see BaseControl https://github.com/WordPress/gutenberg/tree/trunk/packages/components/src/base-control
*
* @param {Object} props Component properties object.
* @param {string} props.label Control label text.
* @param {string} props.className Control element css class name attribute.
* @param {string} props.id Control element ID attribute.
* @param {Function} props.onClick Callback function when a button in the group is clicked.
* @param {string} props.selected The value of the currently selected option.
* @param {Object[]} props.options An array of objects used to create the buttons in the group.
* Each object should contain at least a "label" and "value" property and
* can optionally include an "icon" property.
* @return {BaseControl} The rendered component.
*/
export default function( {
label,
onClick = () => {},
className = null,
id = null,
selected = '',
options = [],
} ) {
const [ selectedValue, setSelectedValue ] = useState( selected );
className = className ? ` ${ className }` : '';
return (
<BaseControl
label={ label }
className={ `llms-button-group-control${ className }` }
id={ id }
>
<ButtonGroup style={ { display: 'flex' } }>
{ options.map(
( { label: buttonLabel, value, icon = null } ) => (
<Button
style={ { padding: '6px 8px' } }
key={ value }
isPrimary={ value === selectedValue }
isSecondary={ value !== selectedValue }
icon={ icon }
onClick={ () => {
setSelectedValue( value );
onClick( value );
} }
>
{ buttonLabel }
</Button>
)
) }
</ButtonGroup>
</BaseControl>
);
}
================================================
FILE: packages/components/src/button-group-control/test/index.js
================================================
/**
* External dependencies
*/
import { render } from '@testing-library/react';
/**
* Internal dependencies
*/
import ButtonGroupControl from '../';
describe( 'ButtonGroupControl', () => {
it( 'should render a <ButtonGroupControl> component', () => {
const args = {
id: 'group-id',
className: 'extra-class',
label: 'Label',
options: [
{
label: 'Button 1',
value: 'button-1',
},
{
label: 'Button 2',
value: 'button-2',
},
],
selected: 'button-1',
},
{ container } = render( <ButtonGroupControl { ...args } /> ),
control = container.firstChild,
label = control.querySelector( 'label' ),
buttons = control.querySelectorAll( 'button' );
expect(
control.classList.contains( 'llms-button-group-control' )
).toBe( true );
expect( control.classList.contains( 'components-base-control' ) ).toBe(
true
);
expect( control.classList.contains( 'extra-class' ) ).toBe( true );
expect( label.getAttribute( 'for' ) ).toBe( args.id );
expect( label.textContent ).toBe( args.label );
expect( buttons.length ).toBe( args.options.length );
expect( buttons[ 0 ].textContent ).toBe( args.options[ 0 ].label );
expect( buttons[ 0 ].classList.contains( 'is-primary' ) ).toBe( true );
expect( buttons[ 1 ].textContent ).toBe( args.options[ 1 ].label );
expect( buttons[ 1 ].classList.contains( 'is-secondary' ) ).toBe(
true
);
} );
} );
================================================
FILE: packages/components/src/copy-button/index.js
================================================
import { __ } from '@wordpress/i18n';
import { ClipboardButton, Button, Tooltip } from '@wordpress/components';
import { useCopyToClipboard } from '@wordpress/compose';
/**
* A "click to copy" button.
*
* Uses the `useCopyToClipboard()` hook with a <Button> on WP 5.8 & later, otherwise falls back
* to the deprecated <ClipboardButton>.
*
* @since 1.0.0
*
* @param {Object} args Component arguments.
* @param {string} args.buttonText Text to to display within the button.
* @param {string} args.copyText Text to copy to the clipboard.
* @param {string} args.tooltipText Text to use in the tooltip wrapper around the button.
* @param {Function} args.onCopy Copy success callback function.
* @param {...*} args.buttonProps Remaining properties passed to the underlying <Button> component.
* @return {Object} The copy button fragment.
*/
export default function( {
buttonText,
copyText,
onCopy,
tooltipText = null,
...buttonProps
} ) {
tooltipText = tooltipText || __( 'Click to copy.', 'lifterlms' );
const canUseHook = 'undefined' !== typeof useCopyToClipboard;
// WP 5.8+.
const HookButton = () => {
const ref = useCopyToClipboard( copyText, onCopy );
return (
<Button { ...buttonProps } ref={ ref }>
{ buttonText }
</Button>
);
};
// WP < 5.8.
const BackwardsButton = () => {
return (
<ClipboardButton
{ ...buttonProps }
text={ copyText }
onCopy={ onCopy }
>
{ buttonText }
</ClipboardButton>
);
};
return (
<Tooltip text={ tooltipText }>
{ canUseHook && <HookButton /> }
{ ! canUseHook && <BackwardsButton /> }
</Tooltip>
);
}
================================================
FILE: packages/components/src/index.js
================================================
export { default as ButtonGroupControl } from './button-group-control';
export { default as CopyButton } from './copy-button';
export * from './search-control';
export * as Spinner from './spinner';
================================================
FILE: packages/components/src/post-select/index.js
================================================
import { __, sprintf } from '@wordpress/i18n';
import { useSelect } from '@wordpress/data';
import { PanelRow, SelectControl } from '@wordpress/components';
export const llmsPostTypes = [
'course',
'lesson',
'llms_quiz'
];
export const getPostTypeName = ( slug, format = 'name' ) => {
const name = slug?.replace( 'llms_', '' );
const title = name.charAt( 0 ).toUpperCase() + name.slice( 1 );
return format === 'name' ? name : title;
};
export const useLlmsPostType = () => {
const postType = useSelect( ( select ) => select( 'core/editor' )?.getCurrentPostType(), [] );
return llmsPostTypes.includes( postType );
};
export const usePostOptions = ( postType = 'course' ) => {
const { posts, currentPostType } = useSelect( ( select ) => {
return {
posts: select( 'core' ).getEntityRecords( 'postType', postType ),
currentPostType: select( 'core/editor' )?.getCurrentPostType(),
};
}, [] );
const postTypeName = getPostTypeName( postType );
const options = [];
if ( ! llmsPostTypes.includes( currentPostType ) ) {
options.push( {
label: __( 'Select course', 'lifterlms' ),
value: 0,
} );
}
if ( posts?.length ) {
posts.forEach( ( post ) => {
options.push( {
label: post.title.rendered + ' (ID: ' + post.id + ')',
value: post.id,
} );
} );
}
if ( llmsPostTypes.includes( currentPostType ) ) {
options.unshift( {
label: sprintf(
// Translators: %s = Post type name.
__( 'Inherit from current %s', 'lifterlms' ),
getPostTypeName( currentPostType )
),
value: 0,
} );
}
if ( ! options?.length ) {
options.push( {
label: __( 'Loading', 'lifterlms' ),
value: 0,
} );
}
return options;
};
export const PostSelect = (
{
attributes,
setAttributes,
postType = 'course',
attribute = 'course_id',
}
) => {
const options = usePostOptions( postType );
const postTypeName = getPostTypeName( postType );
const postTypeTitle = getPostTypeName( postType, 'title' );
const helpText = sprintf(
// Translators: %s = Post type name.
__( 'Select the %s to associate with this block.', 'lifterlms' ),
postTypeName
);
return <PanelRow>
<SelectControl
label={ postTypeTitle }
help={ helpText }
value={ attributes?.[ attribute ] ?? options?.[ 0 ]?.value }
options={ options }
onChange={ ( value ) => {
setAttributes( {
[ attribute ]: parseInt( value, 10 ),
} );
} }
/>
</PanelRow>;
};
================================================
FILE: packages/components/src/search-control/base-search-control.js
================================================
// External Deps.
import Select from 'react-select/async';
import { debounce } from 'throttle-debounce';
import { uniqueId, differenceBy, uniqBy } from 'lodash';
// WP Deps.
import { __ } from '@wordpress/i18n';
import { useState, useEffect } from '@wordpress/element';
import apiFetch from '@wordpress/api-fetch';
import { addQueryArgs } from '@wordpress/url';
// Internal Deps.
import { StyledBaseControl } from './styled-base-control';
import {
defaultHydrateValues,
defaultStyles,
defaultTheme,
defaultFormatSearchResults,
} from './defaults';
/**
* Searchable <select> element powered by a WordPress REST API endpoint.
*
* @since 1.0.0
*
* @param {Object} args Component arguments.
* @param {string} args.searchPath Required. API path used to perform the search.
* @param {Function} args.onUpdate Callback function invoked when the value of the select changes.
* The callback function is passed a single parameter, the new selected
* value object(s). For multiselects it will be an array of objects.
* If the select is clearable, the value will be `null` when the select
* is cleared.
* @param {Array} args.selectedValue The currently selected value(s). If an object is passed, it should contain at least
* a `label` and `value` key. Can pass IDs as integers and the values will be automatically
* hydrated.
* @param {string} args.placeholder The placeholder displayed within an empty search control.
* @param {string} args.className HTML class attribute added to the select control.
* @param {string} args.classNamePrefix Prefix added to select control subcomponent classnames. In most circumstances this should not
* be changed as it is used to style the compontents.
* @param {number} args.searchDebounceDelay Search debounce delay, in milliseconds.
* @param {Object} args.additionalSearchArgs Object of additional query string arguments to use with the API request.
* @param {?string} args.label Search control label, passed to <BaseControl>.
* @param {?string} args.id Search control HTML ID attribute, passed to <BaseControl>.
* @param {?Object[]} args.defaultOptions Array of hydrated objects to preload into the select as options.
* @param {?Function} args.getSearchArgs Function invoked to generate the query string arguments used when fetching
* results from the API. The callback function is passed the search string.
* @param {?Function} args.getSearchURL Function invoked to create the search URL used to fetch results. The function
* is passed the `searchPath` and generated query string arguments from `getSearchArgs()`.
* @param {?Function} args.hydrateValues Function invoked to hydrate integer values. The function is passed the currently selected values,
* the `searchPath`, and an array of cached (and hydrated) objects previously loaded from the server.
* @param {?Function} args.formatSearchResults Function invoked to format results retrieved from the server. The function is passed an array
* of objects from the server. It should return an array of objects, each containing at least a
* value and label property.
* @param {?Function} args.formatSearchResultLabel Function invoked to format the display label for a result. The function is passed
* an object representing a single result and should return a string.
* @param {?Function} args.formatSearchResultValue Function invoked to format the saved value for a result. The function is passed
* an object representing a single result and should the value to be stored.
* @param {...*} args.selectProps Any remaining properties are passed to the <Select> component, {@link https://react-select.com/props#select-props}.
* @return {StyledBaseControl} The component.
*/
export default function BaseSearchControl( {
searchPath,
onUpdate = () => {},
selectedValue = [],
additionalSearchArgs = {},
defaultOptions = null,
getSearchArgs = null,
label = null,
getSearchURL = null,
hydrateValues = null,
formatSearchResults = null,
formatSearchResultLabel = null,
formatSearchResultValue = null,
id = null,
placeholder = __( 'Search…', 'lifterlms' ),
className = 'llms-base-search-control',
classNamePrefix = 'llms-search-control',
searchDebounceDelay = 300,
...selectProps
} ) {
// Setup state variables.
const [ loadedResults, setLoadedResults ] = useState( [] ),
addLoadedResults = ( newResults ) =>
setLoadedResults( loadedResults.concat( newResults ) ),
[ value, setValue ] = useState(
Array.isArray( selectedValue ) ? selectedValue : [ selectedValue ]
);
// If an ID is stored and passed into component as the selectedValue, hydrate the value from cached results or the API.
useEffect( () => {
// Nothing to hydrate.
if ( ! selectedValue.length ) {
return;
}
hydrateValues = hydrateValues || defaultHydrateValues;
hydrateValues( value, searchPath, loadedResults ).then(
( newValues ) => {
newValues = formatSearchResults(
newValues,
formatSearchResultLabel,
formatSearchResultValue
);
const toAdd = differenceBy( newValues, loadedResults, 'id' );
if ( toAdd.length ) {
addLoadedResults( toAdd );
}
setValue( newValues );
return newValues;
}
);
}, [ selectedValue ] );
/**
* On change function callback.
*
* Updates the current value's state and calls the `onUpdate()` user function.
*
* @since 1.0.0
*
* @param {?Object[]} newValues Newly selected values.
* @return {void}
*/
const onChange = ( newValues ) => {
setValue( Array.isArray( newValues ) ? newValues : [ newValues ] );
onUpdate( newValues );
};
/**
* Load options from the server.
*
* On search term update callback function.
*
* @since 1.0.0
*/
const loadOptions = debounce(
searchDebounceDelay,
( searchQuery, callback ) => {
apiFetch( {
path: getSearchURL( searchPath, getSearchArgs( searchQuery ) ),
} ).then( ( results ) => {
const formatted = formatSearchResults(
results,
formatSearchResultLabel,
formatSearchResultValue
);
addLoadedResults( formatted );
callback( formatted );
} );
}
);
// Setup defaults.
id = id || uniqueId( `${ className }--` );
formatSearchResults = formatSearchResults || defaultFormatSearchResults;
formatSearchResultLabel = formatSearchResultLabel
? formatSearchResultLabel
: ( res ) => res?.id;
formatSearchResultValue = formatSearchResultValue
? formatSearchResultValue
: ( res ) => res?.id;
getSearchArgs = getSearchArgs
? getSearchArgs
: ( searchQuery ) => ( {
per_page: 10,
search: searchQuery,
...additionalSearchArgs,
} );
getSearchURL = getSearchURL
? getSearchURL
: ( path, args ) => addQueryArgs( path, args );
selectProps.styles = selectProps.styles || defaultStyles;
selectProps.theme = selectProps.theme || defaultTheme;
if ( null === defaultOptions && value.length ) {
defaultOptions = loadedResults.length
? uniqBy( loadedResults, 'id' )
: true;
}
return (
<StyledBaseControl { ...{ id, label } }>
<Select
{ ...{
className,
classNamePrefix,
value,
placeholder,
loadOptions,
defaultOptions,
onChange,
...selectProps,
} }
/>
</StyledBaseControl>
);
}
================================================
FILE: packages/components/src/search-control/defaults.js
================================================
// External deps.
import { isPlainObject } from 'lodash';
// WP deps.
import apiFetch from '@wordpress/api-fetch';
/**
* Default function used to hydrate stored numeric IDs to the equivalent object.
*
* @since 1.0.0
*
* @param {Array} values Array of values.
* @param {string} path API request path.
* @param {Object[]} loadedResults Array of already-hydrated API results.
* @return {Object[]} Hydrated result array.
*/
export async function defaultHydrateValues( values, path, loadedResults ) {
const isResultHydrated = ( result ) =>
isPlainObject( result ) && result.label && result.value;
return Promise.all(
values.map( async ( value ) => {
if ( ! isResultHydrated( value ) && Number.isInteger( value ) ) {
value =
loadedResults.find( ( { id } ) => id === value ) ||
( await apiFetch( { path: `${ path }/${ value }` } ) );
}
return value;
} )
);
}
/**
* Default styles object passed to the underlying <Select> component.
*
* @type {Object}
*/
export const defaultStyles = {
control: ( control ) => ( {
...control,
borderColor: '#8d96a0',
'&:hover': {
...control[ '&:hover' ],
borderColor: '#8d96a0',
},
} ),
};
/**
* Default <Select> component theme callback function.
*
* Customizes the theme of the component to better match the WordPress editor UI.
*
* Uses the default UI color from the current admin theme. The theme doesn't work that well
* with the other provided theme colors (which are darker than the Select component options which
* are lighter highlights). So if you're using a non-default admin color scheme the select will probably
* look a bit weird. I'm sorry.
*
* @since 1.0.0
*
* @see https://react-select.com/styles#overriding-the-theme
*
* @param {Object} theme Theme object.
* @return {Object} Theme object.
*/
export function defaultTheme( theme ) {
return {
...theme,
colors: {
...theme.colors,
primary: 'var( --wp-admin-theme-color )',
// primary25: '#ccf2ff',
// primary50: '#b3ecff',
// primary75: '#4dd2ff',
},
spacing: {
...theme.spacing,
baseUnit: 2,
controlHeight: 28,
menuGutter: 4,
},
};
}
/**
* Default format search results function.
*
* Accepts an array of raw API results adds a label and value for use by the <Select>
* component.
*
* @since 1.0.0
*
* @param {Object[]} results API result array.
* @param {Function} formatSearchResultLabel Label formatting function.
* @param {Function} formatSearchResultValue Value formatting function.
* @return {Object[]} Formatted results.
*/
export function defaultFormatSearchResults(
results,
formatSearchResultLabel,
formatSearchResultValue
) {
return results.map( ( result ) => ( {
...result,
label: formatSearchResultLabel( result ),
value: formatSearchResultValue( result ),
} ) );
}
================================================
FILE: packages/components/src/search-control/index.js
================================================
import BaseSearchControl from './base-search-control';
import PostSearchControl from './post-search-control';
import UserSearchControl from './user-search-control';
export { BaseSearchControl, PostSearchControl, UserSearchControl };
================================================
FILE: packages/components/src/search-control/post-search-control.js
================================================
import { __, _x, sprintf } from '@wordpress/i18n';
import BaseSearchControl from './base-search-control';
/**
* Searchable <select> element powered by a WordPress REST API users endpoint.
*
* This component is a wrapper around the <BaseSearchControl> component. It is configured
* to search users via the WordPress user REST API endpoint.
*
* @since 1.0.0
*
* @param {Object} args Component arguments.
* @param {string} args.postType Post type endpoint.
* @param {string} args.baseSearchPath Base search path used to create the searchPath.
* @param {?string} args.searchPath API path used to perform the search. If passed, will be used instead of the
* path generated from `args.postType` and `args.baseSearchPath`.
* @param {string} args.placeholder The placeholder displayed within an empty search control.
* @param {string} args.className HTML class attribute added to the select control.
* @param {?Function} args.formatSearchResultLabel Function invoked to format the display label for a result. The function is passed
* @param {Object} args.additionalSearchArgs An object representing a single result and should return a string.
* @param {...*} args.baseProps Any remaining properties are passed to the <BaseSearchControl> component.
* @return {BaseSearchControl} The component.
*/
export default function PostSearchControl( {
postType = 'posts',
baseSearchPath = '/wp/v2/',
searchPath = null,
className = 'llms-post-search-control',
placeholder = __( 'Search for posts…', 'lifterlms' ),
formatSearchResultLabel = null,
additionalSearchArgs = {},
...baseProps
} ) {
// Default result label.
formatSearchResultLabel = formatSearchResultLabel
? formatSearchResultLabel
: ( { title, id } ) =>
sprintf(
// Translators: %1$s = Post title; %2$s = Post id.
_x(
'%1$s (ID# %2$d)',
'Post search result label',
'lifterlms'
),
title.rendered,
id
);
return (
<BaseSearchControl
{ ...{
searchPath: searchPath || `${ baseSearchPath }${ postType }`,
className,
placeholder,
formatSearchResultLabel,
additionalSearchArgs,
...baseProps,
} }
/>
);
}
================================================
FILE: packages/components/src/search-control/styled-base-control.js
================================================
// External deps.
import styled from '@emotion/styled';
// WP deps.
import { BaseControl } from '@wordpress/components';
/**
* A <BaseControl> component with styles targeting the <BaseSearchControl> components within it.
*
* Addresses issues arising from WP core styles loaded in the block editor that create visual
* issues with our components.
*
* @since 1.0.0
*/
export const StyledBaseControl = styled( BaseControl )`
width: 100%;
& .llms-search-control__input:focus {
box-shadow: none;
}
& .llms-search-control__menu {
background: #fff !important;
z-index: 9999999 !important;
}
& .llms-search-control__value-container {
width: 100%;
}
`;
================================================
FILE: packages/components/src/search-control/user-search-control.js
================================================
import { __, _x, sprintf } from '@wordpress/i18n';
import BaseSearchControl from './base-search-control';
/**
* Searchable <select> element powered by a WordPress REST API users endpoint.
*
* This component is a wrapper around the <BaseSearchControl> component. It is configured
* to search users via the WordPress user REST API endpoint.
*
* @since 1.0.0
*
* @param {Object} args Component arguments.
* @param {string} args.searchPath Required. API path used to perform the search.
* @param {string} args.placeholder The placeholder displayed within an empty search control.
* @param {string} args.className HTML class attribute added to the select control.
* @param {?Function} args.formatSearchResultLabel Function invoked to format the display label for a result. The function is passed
* @param {Object} args.additionalSearchArgs An object representing a single result and should return a string.
* @param {...*} args.baseProps Any remaining properties are passed to the <BaseSearchControl> component.
* @return {BaseSearchControl} The component.
*/
export default function UserSearchControl( {
searchPath = '/wp/v2/users',
className = 'llms-user-search-control',
placeholder = __( 'Search users by email or name…', 'lifterlms' ),
formatSearchResultLabel = null,
additionalSearchArgs = {},
...baseProps
} ) {
// Default result label.
formatSearchResultLabel = formatSearchResultLabel
? formatSearchResultLabel
: ( { name, id } ) =>
sprintf(
// Translators: %1$s = User's name; %2$s = User's id.
_x(
'%1$s (ID# %2$d)',
'User search result label',
'lifterlms'
),
name,
id
);
return (
<BaseSearchControl
{ ...{
searchPath,
className,
placeholder,
formatSearchResultLabel,
additionalSearchArgs,
...baseProps,
} }
/>
);
}
================================================
FILE: packages/components/src/spinner/.eslintrc.js
================================================
module.exports = {
env: {
browser: true,
},
globals: {
jQuery: true,
},
};
================================================
FILE: packages/components/src/spinner/constants.js
================================================
/**
* Spinner wrapper element class name.
*
* @type {string}
*/
export const WRAPPER_CLASSNAME = 'llms-spinning';
/**
* Spinner element class name.
*
* @type {string}
*/
export const CLASSNAME = 'llms-spinner';
/**
* Small-sized spinner identifier / class name.
*
* @type {string}
*/
export const SIZE_SMALL = 'small';
/**
* Default-sized spinner identifier / class name.
*
* @type {string}
*/
export const SIZE_DEFAULT = 'default';
================================================
FILE: packages/components/src/spinner/index.js
================================================
/* eslint-env jquery */
// Internal deps.
import { SIZE_DEFAULT } from './constants';
import { create, ensureElementList, find, loadStyles } from './utils';
/**
* This module was originally included in the LifterLMS Core Javascript in the `LLMS` global object as `LLMS.Spinner`.
*
* It has since been relocated here as a module in the `@lifterlms/components` package. During the move it was upgraded
* to enable usage without the requirement of passing in jQuery selectors.
*
* In the future, passing native jQuery selectors into any of these modules will be deprecated in favor of native/vanilla Javascript
* Elements or selector strings that can be passed into `document.querySelector()` or `document.querySelectorAll()`.
*/
/**
* Retrieves spinner(s) inside a given element.
*
* If the spinner element doesn't already exist it will be created.
*
* @since 1.1.0
*
* @param {jQuery|Element|string} selector A selector to be parsed by `jQuery()`, an existing `jQuery()` selection, a DOM Element. The first spinner
* found within the element will be returned. If none found it will be created, appended to the element, and
* then returned.
* @param {string} size Size or the spinner element. Accepts "default" (40px) or "small" (20px).
* @param {boolean} useJQuery If `true`, the return value will be a jQuery selection as opposed to an Element. This is the default behavior
* for backwards compatibility but will be removed in a future version.
* @return {null|Element|jQuery} Returns `null` when the selector cannot be located, otherwise returns an `Element` or `jQuery` selection based on the value
* of `useJQuery`.
*/
export function get( selector, size = SIZE_DEFAULT, useJQuery = true ) {
loadStyles();
const nodeList = ensureElementList( selector );
if ( ! nodeList.length ) {
return null;
}
const wrapper = nodeList[ 0 ],
// Find an existing spinner and create it if one doesn't exist.
spinner = find( wrapper ) || create( wrapper, size );
// Return it.
return useJQuery && typeof jQuery !== 'undefined'
? jQuery( spinner )
: spinner;
}
/**
* Starts spinner(s) inside a given element or element list.
*
* If the spinner element doesn't already exist it will be created.
*
* @since 1.1.0
*
* @param {jQuery|Element|NodeList|string} selector A selector to be parsed by `jQuery()`, an existing `jQuery()` selection, a DOM Element, or an
* array of DOM Elements. Each element in the list will have it's spinner started. If a spinner doesn't
* exist within the element, it will be appended and then started.
* @param {string} size Size or the spinner element. Accepts "default" (40px) or "small" (20px).
* @return {void}
*/
export function start( selector, size = SIZE_DEFAULT ) {
ensureElementList( selector ).forEach( ( el ) => {
const spinner = get( el, size, false );
if ( spinner ) {
spinner.style.display = 'block';
}
} );
}
/**
* Stops spinner(s) inside a given element or element list.
*
* @since 1.1.0
*
* @param {jQuery|Element|NodeList|string} selector A selector to be parsed by `jQuery()`, an existing `jQuery()` selection, a DOM Element, or an
* array of DOM Elements. Each element in the list will have it's spinner stopped.
* @return {void}
*/
export function stop( selector ) {
ensureElementList( selector ).forEach( ( el ) => {
const spinner = get( el, SIZE_DEFAULT, false );
if ( spinner ) {
spinner.style.display = 'none';
}
} );
}
================================================
FILE: packages/components/src/spinner/styles.js
================================================
import { WRAPPER_CLASSNAME, CLASSNAME, SIZE_SMALL } from './constants';
/**
* CSS Styles for the components.
*
* @type {string}
*/
export const STYLES = `
.${ WRAPPER_CLASSNAME } {
background: rgba( 250, 250, 250, 0.7 );
bottom: 0;
display: none;
left: 0;
position: absolute;
right: 0;
top: 0;
z-index: 2;
}
.${ CLASSNAME } {
animation: llms-spinning 1.5s linear infinite;
box-sizing: border-box;
border: 4px solid #313131;
border-radius: 50%;
height: 40px;
left: 50%;
margin-left: -20px;
margin-top: -20px;
position: absolute;
top: 50%;
width: 40px;
}
.${ CLASSNAME }.${ SIZE_SMALL } {
border-width: 2px;
height: 20px;
margin-left: -10px;
margin-top: -10px;
width: 20px;
}
@keyframes llms-spinning {
0% {
transform: rotate( 0deg )
}
50% {
border-radius: 5%;
}
100% {
transform: rotate( 220deg)
}
}
`;
================================================
FILE: packages/components/src/spinner/test/__MOCKS__/jquery.js
================================================
/**
* Mock jQuery class.
*
* Generates a minimal mocked jQuery object for use by unit tests.
*
* @since 1.1.0
*
* @param {string} selector A selector string that can be passed to `document.querySelectorAll()`.
* @return {Object} A mock jQuery object.
*/
function fakeQuery( selector ) {
return {
isFakeQuery: true,
toArray: () => document.querySelectorAll( selector ),
};
}
Object.defineProperty( fakeQuery, Symbol.hasInstance, {
value: ( instance ) => {
return instance.isFakeQuery;
},
} );
export { fakeQuery };
================================================
FILE: packages/components/src/spinner/test/__snapshots__/index.test.js.snap
================================================
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`Spinner: public API get() Autoload styles 1`] = `"<style id=\\"llms-spinner-styles\\"> .llms-spinning { background: rgba( 250, 250, 250, 0.7 ); bottom: 0; display: none; left: 0; position: absolute; right: 0; top: 0; z-index: 2; } .llms-spinner { animation: llms-spinning 1.5s linear infinite; box-sizing: border-box; border: 4px solid #313131; border-radius: 50%; height: 40px; left: 50%; margin-left: -20px; margin-top: -20px; position: absolute; top: 50%; width: 40px; } .llms-spinner.small { border-width: 2px; height: 20px; margin-left: -10px; margin-top: -10px; width: 20px; } @keyframes llms-spinning { 0% { transform: rotate( 0deg ) } 50% { border-radius: 5%; } 100% { transform: rotate( 220deg) } }</style>"`;
exports[`Spinner: public API get() Create and return 1`] = `"<div class=\\"abc\\"><div class=\\"llms-spinning\\"><i class=\\"llms-spinner default\\" role=\\"alert\\" aria-live=\\"assertive\\"><span class=\\"screen-reader-text\\">Loading…</span></i></div></div>"`;
exports[`Spinner: public API get() Create and return 2`] = `
<div
class="llms-spinning"
>
<i
aria-live="assertive"
class="llms-spinner small"
role="alert"
>
<span
class="screen-reader-text"
>
Loading…
</span>
</i>
</div>
`;
exports[`Spinner: public API get() Create and return 3`] = `"<div class=\\"abc\\"><div class=\\"llms-spinning\\"><i class=\\"llms-spinner default\\" role=\\"alert\\" aria-live=\\"assertive\\"><span class=\\"screen-reader-text\\">Loading…</span></i></div></div><div class=\\"llms-spinning\\"><i class=\\"llms-spinner small\\" role=\\"alert\\" aria-live=\\"assertive\\"><span class=\\"screen-reader-text\\">Loading…</span></i></div>"`;
exports[`Spinner: public API get() Create small size 1`] = `"<div class=\\"abc\\"><div class=\\"llms-spinning\\"><i class=\\"llms-spinner small\\" role=\\"alert\\" aria-live=\\"assertive\\"><span class=\\"screen-reader-text\\">Loading…</span></i></div></div>"`;
exports[`Spinner: public API start() and stop() 1`] = `"<div class=\\"abc xyz\\"><div class=\\"llms-spinning\\" style=\\"display: block;\\"><i class=\\"llms-spinner default\\" role=\\"alert\\" aria-live=\\"assertive\\"><span class=\\"screen-reader-text\\">Loading…</span></i></div></div><div class=\\"def xyz\\"><div class=\\"llms-spinning\\" style=\\"display: block;\\"><i class=\\"llms-spinner default\\" role=\\"alert\\" aria-live=\\"assertive\\"><span class=\\"screen-reader-text\\">Loading…</span></i></div></div>"`;
exports[`Spinner: public API start() and stop() 2`] = `"<div class=\\"abc xyz\\"><div class=\\"llms-spinning\\" style=\\"display: none;\\"><i class=\\"llms-spinner default\\" role=\\"alert\\" aria-live=\\"assertive\\"><span class=\\"screen-reader-text\\">Loading…</span></i></div></div><div class=\\"def xyz\\"><div class=\\"llms-spinning\\" style=\\"display: none;\\"><i class=\\"llms-spinner default\\" role=\\"alert\\" aria-live=\\"assertive\\"><span class=\\"screen-reader-text\\">Loading…</span></i></div></div>"`;
================================================
FILE: packages/components/src/spinner/test/__snapshots__/utils.test.js.snap
================================================
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`Spinner: utils create() Default size (not specified) 1`] = `"<i class=\\"llms-spinner default\\" role=\\"alert\\" aria-live=\\"assertive\\"><span class=\\"screen-reader-text\\">Loading…</span></i>"`;
exports[`Spinner: utils create() Default size (passed) 1`] = `"<i class=\\"llms-spinner default\\" role=\\"alert\\" aria-live=\\"assertive\\"><span class=\\"screen-reader-text\\">Loading…</span></i>"`;
exports[`Spinner: utils create() Small size 1`] = `"<i class=\\"llms-spinner small\\" role=\\"alert\\" aria-live=\\"assertive\\"><span class=\\"screen-reader-text\\">Loading…</span></i>"`;
exports[`Spinner: utils ensureElementList() Element input 1`] = `
Array [
<div
class="abc"
/>,
]
`;
exports[`Spinner: utils ensureElementList() Element input 2`] = `
"
<div class=\\"abc\\"></div>
<div class=\\"def\\"></div>
"
`;
exports[`Spinner: utils ensureElementList() NodeList input 1`] = `
Array [
<div
class="abc"
/>,
<div
class="def"
/>,
]
`;
exports[`Spinner: utils ensureElementList() NodeList input 2`] = `
"
<div class=\\"abc\\"></div>
<div class=\\"def\\"></div>
"
`;
exports[`Spinner: utils ensureElementList() String (multiple) input 1`] = `
Array [
<div
class="abc"
/>,
<div
class="def"
/>,
]
`;
exports[`Spinner: utils ensureElementList() String (multiple) input 2`] = `
"
<div class=\\"abc\\"></div>
<div class=\\"def\\"></div>
"
`;
exports[`Spinner: utils ensureElementList() String (single) input 1`] = `
Array [
<div
class="def"
/>,
]
`;
exports[`Spinner: utils ensureElementList() String (single) input 2`] = `
"
<div class=\\"abc\\"></div>
<div class=\\"def\\"></div>
"
`;
exports[`Spinner: utils ensureElementList() jQuery input 1`] = `
Array [
<div
class="abc"
/>,
<div
class="def"
/>,
]
`;
exports[`Spinner: utils ensureElementList() jQuery input 2`] = `
"
<div class=\\"abc\\"></div>
<div class=\\"def\\"></div>
"
`;
exports[`Spinner: utils loadStyles() 1`] = `"<style id=\\"llms-spinner-styles\\"> .llms-spinning { background: rgba( 250, 250, 250, 0.7 ); bottom: 0; display: none; left: 0; position: absolute; right: 0; top: 0; z-index: 2; } .llms-spinner { animation: llms-spinning 1.5s linear infinite; box-sizing: border-box; border: 4px solid #313131; border-radius: 50%; height: 40px; left: 50%; margin-left: -20px; margin-top: -20px; position: absolute; top: 50%; width: 40px; } .llms-spinner.small { border-width: 2px; height: 20px; margin-left: -10px; margin-top: -10px; width: 20px; } @keyframes llms-spinning { 0% { transform: rotate( 0deg ) } 50% { border-radius: 5%; } 100% { transform: rotate( 220deg) } }</style>"`;
================================================
FILE: packages/components/src/spinner/test/index.test.js
================================================
import { fakeQuery } from './__MOCKS__/jquery';
import { get, start, stop } from '../';
import { SIZE_SMALL, SIZE_DEFAULT } from '../constants';
global.jQuery = fakeQuery;
describe( 'Spinner: public API', () => {
describe( 'get()', () => {
test( 'Autoload styles', () => {
document.head.innerHTML = '';
get( 'div', SIZE_DEFAULT, false );
expect( document.head.innerHTML ).toMatchSnapshot();
} );
test( 'Empty return', () => {
document.body.innerHTML = '<div class="abc"></div>';
expect( get( '.xyz', SIZE_DEFAULT, false ) ).toBeNull();
} );
test( 'Create and return', () => {
document.body.innerHTML = '<div class="abc"></div>';
const createResult = get( '.abc', SIZE_DEFAULT, false ),
body = document.body.innerHTML;
expect( createResult ).toBeInstanceOf( Element );
expect( body ).toMatchSnapshot();
// Don't need to create it again.
const alreadExistsResult = get( '.abc', SIZE_DEFAULT, false );
expect( alreadExistsResult ).toBe( createResult );
expect( document.body.innerHTML ).toBe( body );
const differentParentResult = get( 'body', SIZE_SMALL, false );
expect( differentParentResult ).toMatchSnapshot();
expect( document.body.innerHTML ).toMatchSnapshot();
} );
test( 'Create small size', () => {
document.body.innerHTML = '<div class="abc"></div>';
const res = get( '.abc', SIZE_SMALL, false ),
body = document.body.innerHTML;
expect( res ).toBeInstanceOf( Element );
expect( body ).toMatchSnapshot();
} );
test( 'Return a jQuery selection', () => {
document.body.innerHTML = '<div class="abc"></div>';
expect( get( '.abc', SIZE_DEFAULT ) ).toBeInstanceOf( jQuery );
} );
} );
test( 'start() and stop()', () => {
document.body.innerHTML =
'<div class="abc xyz"></div><div class="def xyz"></div>';
get( '.abc' );
get( '.def' );
start( '.xyz' );
expect( document.body.innerHTML ).toMatchSnapshot();
stop( '.xyz' );
expect( document.body.innerHTML ).toMatchSnapshot();
} );
} );
================================================
FILE: packages/components/src/spinner/test/utils.test.js
================================================
import { fakeQuery } from './__MOCKS__/jquery';
import { create, ensureElementList, find, loadStyles } from '../utils';
import { SIZE_SMALL, SIZE_DEFAULT, WRAPPER_CLASSNAME } from '../constants';
global.jQuery = fakeQuery;
describe( 'Spinner: utils', () => {
describe( 'create()', () => {
const tests = [
{
name: 'Default size (not specified)',
size: undefined,
},
{
name: 'Default size (passed)',
size: SIZE_DEFAULT,
},
{
name: 'Small size',
size: SIZE_SMALL,
},
];
test.each( tests )( '$name', ( { size } ) => {
document.body.innerHTML = '<div id="wrapper"></div>';
const el = create( document.querySelector( '#wrapper' ), size );
expect( el ).toBeInstanceOf( Element );
expect( el.innerHTML ).toMatchSnapshot();
} );
} );
describe( 'ensureElementList()', () => {
const tests = [
{
name: 'NodeList',
getInput: () => document.querySelectorAll( 'div' ),
},
{
name: 'Element',
getInput: () => document.querySelector( '.abc' ),
},
{
name: 'String (single)',
getInput: () => '.def',
},
{
name: 'String (multiple)',
getInput: () => 'div',
},
{
name: 'jQuery',
getInput: () => global.jQuery( 'div' ),
},
];
test.each( tests )( '$name input', ( { getInput } ) => {
document.body.innerHTML = `
<div class="abc"></div>
<div class="def"></div>
`;
const input = getInput(),
list = ensureElementList( input );
expect( list ).toMatchSnapshot();
list.forEach( ( el ) => {
expect( el ).toBeInstanceOf( Element );
} );
// Make sure Elements aren't removed from the DOM.
expect( document.body.innerHTML ).toMatchSnapshot();
} );
} );
describe( 'find()', () => {
test( 'No spinners found in wrapper', () => {
document.body.innerHTML = `
<div id="wrap">
<div class="abc"></div>
</div>
`;
expect( find( document.getElementById( 'wrap' ) ) ).toBeNull();
} );
test( 'No spinners that are direct children of the wrapper', () => {
document.body.innerHTML = `
<div id="wrap">
<div class="abc"><div class="${ WRAPPER_CLASSNAME }"></div></div>
</div>
`;
expect( find( document.getElementById( 'wrap' ) ) ).toBeUndefined();
} );
test( 'Spinner found', () => {
document.body.innerHTML = `
<div id="wrap">
<div class="${ WRAPPER_CLASSNAME }" id="shouldbefound"></div>
</div>
`;
const spinner = find( document.getElementById( 'wrap' ) );
expect( spinner ).toBeInstanceOf( Element );
expect( spinner.id ).toBe( 'shouldbefound' );
} );
} );
test( 'loadStyles()', () => {
document.head.innerHTML = '';
// Load them.
loadStyles();
const headHTML = document.head.innerHTML;
expect( headHTML ).toMatchSnapshot();
// Doesn't load them again.
loadStyles();
expect( document.head.innerHTML ).toBe( headHTML );
} );
} );
================================================
FILE: packages/components/src/spinner/utils.js
================================================
// WP deps.
import { __ } from '@wordpress/i18n';
// Internal deps.
import { WRAPPER_CLASSNAME, CLASSNAME, SIZE_DEFAULT } from './constants';
import { STYLES } from './styles';
/**
* Creates a spinner element inside the specified wrapper Element.
*
* @since 1.1.0
*
* @param {Element} wrapper DOM node to append the created spinner element to.
* @param {string} size Spinner element size.
* @return {Element} Returns the created spinner node.
*/
export function create( wrapper, size = SIZE_DEFAULT ) {
const spinner = document.createElement( 'div' ),
loadingMsg = __( 'Loading…', 'lifterlms' );
spinner.innerHTML = `<i class="${ CLASSNAME } ${ size }" role="alert" aria-live="assertive"><span class="screen-reader-text">${ loadingMsg }</span></i>`;
spinner.classList.add( WRAPPER_CLASSNAME );
wrapper.appendChild( spinner );
return spinner;
}
/**
* Normalizes accepted selector inputs and returns a `NodeList`.
*
* When jQuery selection is detected, adds a console deprecation warning as well.
*
* @since 1.1.0
*
* @param {NodeList|Element|string|jQuery} selector The input selector.
* @return {Element[]} An array of `Element` objects derived from the selector input.
*/
export function ensureElementList( selector ) {
selector =
typeof selector === 'string'
? document.querySelectorAll( selector )
: selector;
// Already a NodeList.
if ( selector instanceof NodeList ) {
return Array.from( selector );
}
const list = [];
if ( selector instanceof Element ) {
list.push( selector );
} else if ( typeof jQuery !== 'undefined' && selector instanceof jQuery ) {
selector.toArray().forEach( ( el ) => list.push( el ) );
}
return list;
}
/**
* Locates an existing spinner element which is a direct child of the specified wrapper element.
*
* @since 1.1.0
*
* @param {Element} wrapper Node element for the wrapper.
* @return {null|undefined|Element} Returns `null` if no spinners exist within the wrapper, undefined if no spinners are
* direct descendants of the wrapper, otherwise returns the spinner element.
*/
export function find( wrapper ) {
const spinners = wrapper.querySelectorAll( `.${ WRAPPER_CLASSNAME }` );
if ( ! spinners.length ) {
return null;
}
return Array.from( spinners ).find( ( el ) => wrapper === el.parentNode );
}
/**
* Loads CSS styles and appends them to the document's <head>.
*
* Attaching CSS directly to the `get()` method means that we don't have to worry about loading CSS files (or relying on CSS) included
* by the LifterLMS core plugin in order to use this styled component.
*
* @since 1.1.0
*
* @return {void}
*/
export function loadStyles() {
const STYLE_ID = 'llms-spinner-styles';
if ( ! document.getElementById( STYLE_ID ) ) {
const style = document.createElement( 'style' );
style.textContent = STYLES.replace( /\n/g, '' )
.replace( /\t/g, ' ' )
.replace( /\s\s+/g, ' ' );
style.id = STYLE_ID;
document.head.appendChild( style );
}
}
================================================
FILE: packages/dev/.llmsdev.yml
================================================
update-version:
skip-config: true
================================================
FILE: packages/dev/.npmrc
================================================
package-lock=false
engine-strict=true
================================================
FILE: packages/dev/CHANGELOG.md
================================================
@lifterlms/dev CHANGELOG
========================
v0.2.4 - 2025-12-19
----------
* Avoid deleting the `composer.lock` file.
v0.2.3 - 2025-12-19
----------
* Use `composer install` vs. `composer update` during zip creation.
v0.2.2 - 2024-04-18
----------
* Changes the default to not merge PRs against dev.
v0.2.1 - 2023-04-18
----------
+ Fixed an issue with paths containing spaces on Windows OS.
+ Fixed an issue when trying to create a folder on Windows OS.
v0.2.0 - 2022-10-12
-------------------
+ When using `update-version` with a prerelease version, certain replacements will be automatically excluded.
v0.1.0 - 2022-08-11
-------------------
+ Updated: [**BREAKING**] During prerelease builds the `readme` command will now exit with code `0` and output a warning message instead of previous behavior: exit code `1` with an error message.
+ Added: The `readme` command now merges additional merge codes as derived from the `parseMainFileMetadata()` utility function.
+ Added: A New command `meta` has been added.
+ Added: `docgen` will now include `beforeHelp` and `afterHelp` text added via `Command.addHelpText()`.
v0.0.5 - 2022-05-23
-------------------
+ Added: `update-version` default replacements will now additionally replace the `[version]` placeholder in the following functions: `_deprecated_argument`, `_deprecated_constructor`, `_deprecated_hook`, `_doing_it_wrong`, `apply_filters_deprecated`, and `do_action_deprecated`.
+ Added: `update-version` command RegEx lists now accept an optional 3rd item used to specify the `RegExp` flags argument. If not supplied the flags list defaults to `g`.
v0.0.4 - 2022-02-15
-------------------
+ Added: New utility methods for generating links to the project's GitHub repository.
+ Fixed: Incorrect issue link URL generated during `changelog write` command.
v0.0.3 - 2021-12-23
-------------------
+ Bugfix: [**Breaking**] The short option `-t` for the `--title` option for the `changelog add` command has been changed to `-T`.
v0.0.2 - 2021-11-10
-------------------
+ Added flag `--links` to `changelog write` command in order to allow default flag configuration via the `.yml` config file. The flag is enabled by default for public repos and disabled for private ones.
+ Fixed an OSX issue encountered in the `changelog write` command resulting from the use of `xargs -d`.
+ Fixed an issue causing `changelog version next` to fail when passing the `--preid` flag.
+ Don't provide a default value to the `update-version` command option `--preid`.
v0.0.1 - 2021-11-05
-------------------
+ Initial release.
================================================
FILE: packages/dev/README.md
================================================
LifterLMS Dev CLI
-----------------
A command-line interface (CLI) for LifterLMS contributors and maintainers. This packages provides a reusable set of tools to reduce redundant dev tasks and chores such as release publication, changelog maintenance, pot file generation, and etc...
---
## CHANGELOG
[CHANGELOG](./CHANGELOG.md)
## Installation
```bash
npm install --save-dev @lifterlms/dev`
```
## Setup
This packages offers a command-line interfaces and exposes the `llms-dev` binary. It is recommended to add a shorthand script to access the binary by adding a new script to your `package.json` file:
```json
{
"scripts": {
"dev": "llms-dev"
}
}
```
After adding this you may access any of the CLI's commands by running:
```bash
npm run dev <command> [options...]
```
## Available Commands and Usage
List available commands by running: `llms-dev help`.
Get help with a specific command by running: `llms-dev help [command]`.
<!-- START TOKEN(Autogenerated API docs) -->
### changelog add
```bash
Usage: index changelog add [options]
Create a new changelog entry.
Options:
-s, --significance <level> The semantic version significance of the
change. Accepts: major, minor, patch.
(default: "patch")
-t, --type <type> The type of change. Accepts: added, changed,
fixed, deprecated, removed, dev, performance,
security. (default: "changed")
-c, --comment <comment> An internal-use comment to include with the
changelog entry which is not published with
the final changelog.
-l, --links <issues...> Link the changelog to one or more GitHub
issues. Can be provided multiple times to link
to multiple issues.
-a, --attributions <users...> Attribute the changelog entry to one or more
individuals. Attributions are provided to
thank contributions which originate from
outside the LifterLMS organization. Provide a
GitHub username or a markdown-formatted
anchor. Can be provided multiple times to
attribute to multiple users.
-e, --entry <entry> The changelog entry.
-T, --title <title> Changelog entry file name. Uses the current
git branch name as the default. Automatically
appends a number to the title if the title
already exists. (default: "trunk")
-i, --interactive Create the changelog interactively. (default:
false)
-E, --use-editor When creating a changelog interactively, will
open an editor to write the entry, This is
useful when creating multi-line entries.
-d, --dir <directory> Directory where changelog entries are stored.
(default: ".changelogs")
-h, --help display help for command
```
### changelog list
```bash
Usage: index changelog list [options]
List existing changelog entries.
Options:
-d, --dir <directory> Directory where changelog entries are stored.
(default: ".changelogs")
-h, --help display help for command
```
### changelog validate
```bash
Usage: index changelog validate [options] [entries...]
Validate existing changelog entries.
Arguments:
entries Optionally specify a list of changelog entries to
validate. If omitted will validate all existing
entries.
Options:
-f, --format [format] Output format. Accepts: list, json, yaml. (default:
"list")
-s, --silent Skip validation output and communicate validation
status only through the exit status of the command.
-d, --dir <directory> Directory where changelog entries are stored.
(default: ".changelogs")
-h, --help display help for command
```
### changelog version
```bash
Usage: index changelog version [options] <which>
List existing changelog entries.
Arguments:
which Which version to retrieve. Accepts: current, next.
Options:
-p, --preid <identifier> Identifier to be used to prefix premajor, preminor,
prepatch or prerelease version increments.
-d, --dir <directory> Directory where changelog entries are stored.
(default: ".changelogs")
-h, --help display help for command
```
### changelog write
```bash
Usage: index changelog write [options]
Write existing changelog entries to the changelog file.
Options:
-p, --preid <identifier> Identifier to be used to prefix premajor, preminor,
prepatch or prerelease version increments.
-F, --force <version> Use the specified version string instead of
determining the version based on changelog entry
significance.
-l, --log-file <file> The changelog file. (default: "CHANGELOG.md")
-d, --date <YYYY-MM-DD> Changelog publication date. (default: "2022-08-11")
-L, --links Add GitHub links to templates and issues in
changelog entries. (default: false)
-n, --no-links Do not add GitHub links in changelog entries. Use
this option to override the --links flag.
-D, --dry-run Output what would be written to the changelog
instead of writing it to the changelog file.
-k, --keep-entries Preserve entry files deletion after the changelog
is written.
-d, --dir <directory> Directory where changelog entries are stored.
(default: ".changelogs")
-h, --help display help for command
```
### docgen
```bash
Usage: index docgen [options]
Generates documentation for the CLI.
Options:
-h, --help display help for command
```
### meta parse
```bash
Usage: index meta parse [options]
Retrieves metadata from the project's main file.
Options:
-F, --file <file> Main project file name. (default: "dev.php")
-k, --key <key> Retrieves a single metadata by key name.
-f, --format [format] Output format. Accepts: table, json, yaml. (default:
"table")
-h, --help display help for command
```
### pot
```bash
Usage: index pot [options]
Generate i18n pot and json files using the WP-CLI.
Options:
-d, --text-domain <text-domain> Specify the text domain. Used to generate
the filenames for generated files. (default:
"dev")
-e, --exclude <glob...> Specify files to exclude from scanning.
(default: "vendor/**, node_modules/**,
tmp/**, dist/**, docs/**, src/**, tests/**,
*.js.map")
-ee, --extra-exclude <glob...> Additional files to add to the --exclude
option.
-d, --dir <directory> Output directory where generated files will
be stored. (default: "i18n")
-t, --translator <translator> Customize the Last Translator header.
(default: "Team LifterLMS
<team@lifterlms.com>")
-b, --bugs <url> Customize the bug report location header.
(default:
"https://lifterlms.com/my-account/my-tickets")
-h, --help display help for command
```
### readme
```bash
Usage: index readme [options]
Create a readme.txt file suitable for the WordPress.org plugin repository.
Options:
-o, --output-file <filename> Specify the output readme file name.
(default: "readme.txt")
-i, --input-file <filename> Specify the input changelog file name.
(default: "CHANGELOG.md")
-m, --main-file <filename> Specify the project main file name where
metadata is stored. (default: "dev.php")
-d, --dir <directory> Directory where the readme part files are
stored (default: ".wordpress-org/readme")
-l, --changelog-length <number> Specify the number of versions to display
before truncating the changelog. (default:
10)
-r, --read-more <url> Specify the "Read More" url where changelogs
are published. (default:
"https://make.lifterlms.com/tag/dev")
-h, --help display help for command
Merge codes:
The following merge codes can be used in any of the readme part markdown files.
| Merge Code | Description | Source |
| ----------------------------- | -----------------------------------------------------------------------| ------------ |
| {{__CHANGELOG_ENTRIES__}} | The most recent 10 changelog entries. | --input-file |
| {{__LICENSE__}} | The project's license (GPLv3). | --main-file |
| {{__LICENSE_URI__}} | The URI to the project's license. | --main-file |
| {{__MIN_WP_VERSION__}} | The minimum required WordPress core version. | --main-file |
| {{__MIN_LLMS_VERSION__}} | The minimum required LifterLMS version. | --main-file |
| {{__MIN_PHP_VERSION__}} | The minimum required PHP version. | --main-file |
| {{__PROJECT_URI__}} | The project's URI. | --main-file |
| {{__READ_MORE_LINK__}} | A link to the full project changelog. | --main-file |
| {{__SHORT_DESCRIPTION__}} | A short description of the project. | --main-file |
| {{__TESTED_LLMS_VERSION__}} | The latest LifterLMS version the project has been tested against. | --main-file |
| {{__TESTED_WP_VERSION__}} | The latest WordPress core version the project has been tested against. | --main-file |
| {{__VERSION__}} | The current project version. | package.json |
```
### release archive
```bash
Usage: index release archive [options]
Build a distribution archive (.zip) file for the project.
Options:
-i, --inspect Automatically unzip the zip file after creation. (default:
false)
-d, --dir <dir> Directory where the generated archive file will be saved,
relative to the project root directory. (default: "dist")
-v, --verbose Output extra information with result messages. (default:
false)
-h, --help display help for command
```
### release create
```bash
Usage: index release create [options]
Create a GitHub release and tag from a specified file or branch.
Options:
-a, --archive <zip> If specified, the zip file will be
committed and force-pushed to the specified
branch before creating the release. Pass
--no-archive to skip this step. (default:
"dev-0.0.5.zip")
-A, --no-archive Skip creation from an archive file and use
the target --branch for release creation.
-c, --commit-message <message> Customize the commit message used when
pushing to the target branch. Used only
when releasing from an archive. The
placeholder "%s" is replaced with the
release version. (default: "Release v%s [ci
skip]")
-d, --dir <directory> Directory where distribution files are
stored. (default: "dist")
-b, --branch <branch> Target branch to use when creating the
release. (default: "release")
-l, --logfile <file> Specify the changelog file. (default:
"CHANGELOG.md")
-p, --prerelease Mark the GitHub release as a prerelease and
skip merging.
-P, --prerelease-branch <branch> When creating a prerelease, use this branch
as the target branch in favor of the
default branch specified via the --branch
option. (default: "prerelease")
-D, --draft Create the release as an unpublished draft
and skip merging.
-M, --merge <branch> Merge open PRs on the specified branch
before creating the release. If publishing
a prerelease, or draft merging is
automatically disabled as if passing
"--no-merge". (default: "dev")
-n, --no-merge Disable merging before release creation.
Automatically passed when publishing a
prerelease.
-Y, --yes Skip confirmations.
-v, --verbose Output extra information with result
messages.
-h, --help display help for command
```
### release prepare
```bash
Usage: index release prepare [options]
Prepare and build a release.
Options:
-F, --force <version> Specify a version to use. If not specified uses
`changelog version next` to determine the version.
-p, --preid <identifier> Identifier to be used to prefix premajor, preminor,
prepatch or prerelease version increments.
-y, --yes Specify no-interaction mode. Responds "yes" to all
confirmation prompts.
-b, --build <cmd> Specify an npm script to use for the build command.
(default: "build")
-B, --no-build Disabled build script.
-h, --help display help for command
```
### update-version
```bash
Usage: index update-version [options]
Update the project version and replace all [version] placeholders.
Options:
-i, --increment <level> Increment the version by the specified level. Accepts: major, minor, patch, premajor, preminor, prepatch, or prerelease. (default: "patch")
-p, --preid <identifier> Identifier to be used to prefix premajor, preminor, prepatch or prerelease version increments.
-F, --force <version> Specify an explicit version instead of incrementing the current version with --increment.
-r, --replacements <replacement...>] Replacements to be made. Each replacement is an array containing a list of globs for the files to be tested, a regex used to perform the replacement, and an optional list of RegEx flags (defaults to `g` if not supplied). It is recommended that this argument to configured via a configuration file as opposed to being passed via a CLI flag. (default: [["./**","(?<=@(?:since|version|deprecated) +)(\\[version\\])"],["./*.php,./**/*.php","(?<=(?:_deprecated_argument|_deprecated_constructor|_deprecated_hook|_deprecated_file|_deprecated_function|_doing_it_wrong|apply_filters_deprecated|do_action_deprecated|llms_deprecated_function\\().+)(?<=')(\\[version\\])(?=')"],["*lifterlms*.php","(?<=[Vv]ersion *[:=] *[ '\"])(0|[1-9]d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?"],["*lifterlms*.php","(?<=define\\( '(?:LLMS|LIFTERLMS).*_VERSION', ')(.*)(?=' \\);)"],["./style.css","(?<=Version: )(.+)"]])
-e, --extra-replacements <replacement...>] Additional replacements added to --replacements array. This option allows adding to the default replacements instead of overwriting them. (default: [])
-E, --exclude <glob...> Specify files to exclude from the update. (default: "./vendor/**, ./node_modules/**, ./tmp/**, ./dist/**, ./docs/**, ./packages/**")
-s, --skip-config Skip updating the version of the package.json or composer.json file. (default: true)
-h, --help display help for command
```
<!-- END TOKEN(Autogenerated API docs) -->
## Configuration Files
The default values for all command options may be customized by placing a YAML configuration file in the project's root directory name `.llmsdev.yml`.
The configuration file may contain any number of objects, the top-level keys correspond to the command being configured. The keys of each object represent the long form (eg: `--option-name`) option flag for the option being configured. When configuring a subcommand, separate the parent and child commands with a dot `.`.
The following is an annotated configuration example:
```yaml
# Configure the archive command defaults, eg `llms-dev archive`.
archive:
# Equivalent to always passing `llms-dev archive --inspect`.
inspect: true
# Configure the the changelog add command, eg `llms-dev changelog add`
changelog.add
type: added
```
================================================
FILE: packages/dev/package.json
================================================
{
"name": "@lifterlms/dev",
"version": "0.2.4",
"description": "Developer's CLI for managing, building, and deploying LifterLMS projects.",
"author": "Team LifterLMS <dev@lifterlms.com>",
"license": "GPL-3.0-or-later",
"homepage": "https://github.com/gocodebox/lifterlms/tree/master/packages/dev",
"keywords": [
"lifterlms",
"wordpress",
"scripts",
"utils"
],
"repository": {
"type": "git",
"url": "https://github.com/gocodebox/lifterlms.git",
"directory": "packages/dev"
},
"bugs": {
"url": "https://github.com/gocodebox/lifterlms/labels/package%3A%dev"
},
"bin": {
"llms-dev": "src/index.js"
},
"main": "src/index.js",
"publishConfig": {
"access": "public"
},
"engines": {
"node": ">=14.14.0"
},
"dependencies": {
"chalk": "^4.1.2",
"columnify": "^1.5.4",
"commander": "^8.2.0",
"inquirer": "^8.2.0",
"replace-in-file": "^6.3.1",
"semver": "^7.3.5",
"yaml": "^2.2.2"
},
"scripts": {
"docgen": "npm run dev docgen",
"dev": "./src/index.js",
"test": "cd ../../ && wp-scripts test-unit-js ./packages/dev --config ./packages/scripts/config/jest-unit.config.js --verbose && cd packages/dev"
}
}
================================================
FILE: packages/dev/src/.eslintrc.js
================================================
module.exports = {
rules: {
// The CLI program utilizes console to output responses.
'no-console': 'off',
},
};
================================================
FILE: packages/dev/src/cmds/changelog/add.js
================================================
const
inquirer = require( 'inquirer' ),
chalk = require( 'chalk' ),
path = require( 'path' ),
YAML = require( 'yaml' ),
{ existsSync, mkdirSync, writeFileSync } = require( 'fs' ),
{
ChangelogEntry,
getChangelogOptions,
logResult,
execSync,
isAttributionValid,
isEntryValid,
isLinkValid,
getChangelogValidationIssues,
} = require( '../../utils' ),
opts = getChangelogOptions();
/**
* Generate a list for the given option key.
*
* @since 0.0.1
*
* @param {string} option Option key.
* @return {Object[]} Array of objects used for the list.
*/
function generateList( option ) {
return Object.entries( opts[ option ] )
.map( ( [ value, desc ] ) => ( {
name: `${ value.charAt( 0 ).toUpperCase() }${ value.slice( 1 ) } [${ desc }]`,
value,
} ) );
}
/**
* Coerces a numeric value to a valid link value.
*
* @since 0.0.1
*
* @param {any} link User-submitted link value.
* @return {any} The link as a valid link value if it can be coerced or the user-submitted value if it cannot.
*/
function coerceLink( link ) {
return ! isNaN( parseInt( link ) ) ? `#${ link }` : link;
}
/**
* Create the changelog entry from the given entry object.
*
* @since 0.0.1
*
* @param {ChangelogEntry} log Changelog entry object.
* @return {void}
*/
function writeChangelog( log ) {
const { dir } = log;
let { title } = log;
delete log.dir;
delete log.title;
const logDir = path.join( process.cwd(), dir );
if ( ! existsSync( logDir ) ) {
mkdirSync( logDir, { recursive: true } );
}
if ( log.links ) {
log.links = log.links.map( coerceLink );
}
const validation = getChangelogValidationIssues( log );
if ( ! validation.valid ) {
const errs = validation.errors.map( ( err ) => `\n - ${ err }` ).join( '' );
logResult( `The changelog entry could not be written due to validation errors:${ errs }`, 'error' );
process.exit( 1 );
}
// Remove optional empty values.
Object.keys( log ).forEach( ( key ) => ( ! log[ key ] || ( Array.isArray( log[ key ] ) && ! log[ key ].length ) ) && delete log[ key ] );
// Make sure filenames are unique.
let i = 1;
title = path.join( dir, title );
const baseTitle = title;
while ( existsSync( title + '.yml' ) ) {
title = `${ baseTitle }-${ i }`;
++i;
}
title += '.yml';
writeFileSync( title, YAML.stringify( log ) );
logResult( `New changelog entry written to ${ chalk.bold( title ) }.`, 'success' );
}
const defaultTitle = execSync( `git branch --show-current`, true ).replace( '/', '_' );
module.exports = {
command: 'add',
description: 'Create a new changelog entry.',
options: [
[ '-s, --significance <level>', `The semantic version significance of the change. Accepts: ${ Object.keys( opts.significance ).join( ', ' ) }.`, 'patch' ],
[ '-t, --type <type>', `The type of change. Accepts: ${ Object.keys( opts.type ).join( ', ' ) }.`, 'changed' ],
[ '-c, --comment <comment>', 'An internal-use comment to include with the changelog entry which is not published with the final changelog.' ],
[ '-l, --links <issues...>', 'Link the changelog to one or more GitHub issues. Can be provided multiple times to link to multiple issues.' ],
[ '-a, --attributions <users...>', 'Attribute the changelog entry to one or more individuals. Attributions are provided to thank contributions which originate from outside the LifterLMS organization. Provide a GitHub username or a markdown-formatted anchor. Can be provided multiple times to attribute to multiple users.' ],
[ '-e, --entry <entry>', 'The changelog entry.' ],
[ '-T, --title <title>', 'Changelog entry file name. Uses the current git branch name as the default. Automatically appends a number to the title if the title already exists.', defaultTitle ],
[ '-i, --interactive', 'Create the changelog interactively.', false ],
[ '-E, --use-editor', 'When creating a changelog interactively, will open an editor to write the entry, This is useful when creating multi-line entries.' ],
],
action: ( { significance, type, comment, entry, interactive, links, attributions, dir, title, useEditor } ) => {
if ( ! entry && ! interactive ) {
logResult( 'A changelog entry is required.', 'error' );
process.exit( 1 );
}
if ( interactive ) {
const commasToArray = ( arr ) => arr.split( ',' ).filter( ( part ) => part ).map( ( str ) => str.trim() );
const questions = [
{
type: 'list',
name: 'significance',
message: 'Change Significance',
default: significance,
choices: generateList( 'significance' ),
pageSize: Object.keys( opts.significance ).length,
},
{
type: 'list',
name: 'type',
message: 'Change Type',
default: significance,
choices: generateList( 'type' ),
pageSize: Object.keys( opts.type ).length,
},
{
type: 'input',
name: 'comment',
message: 'Comment [For internal use only]',
default: comment,
},
{
type: 'input',
name: 'links',
message: 'Linked Issues [Separate multiple issues with a comma]',
default: links ? links.join( ', ' ) : null,
filter: ( vals ) => commasToArray( vals ).map( coerceLink ),
validate: ( userVal ) => userVal.every( ( val ) => isLinkValid( val ) ) ? true : chalk.red( 'Error: Invalid link' ),
},
{
type: 'input',
name: 'attributions',
message: 'Attributions [Separate multiple individuals with a comma]',
default: attributions ? attributions.join( ', ' ) : null,
filter: commasToArray,
validate: ( userVal ) => userVal.every( ( val ) => isAttributionValid( val ) ) ? true : chalk.red( 'Error: Invalid attribution' ),
},
{
type: useEditor ? 'editor' : 'input',
name: 'entry',
message: 'Changelog Entry Content',
default: entry,
validate: ( val ) => isEntryValid( val ) ? true : chalk.red( 'Error: Invalid entry.' ),
},
];
inquirer.prompt( questions )
.then( ( answers ) => writeChangelog( { ...answers, dir, title } ) )
.catch( ( err ) => console.log( err ) );
} else {
writeChangelog( { significance, type, comment, links, attributions, entry, dir, title } );
}
},
};
================================================
FILE: packages/dev/src/cmds/changelog/index.js
================================================
module.exports = {
command: 'changelog',
description: "Mange the project's changelog.",
optionsShared: [
[ '-d, --dir <directory>', 'Directory where changelog entries are stored.', '.changelogs' ],
],
args: [
[ '<command>', 'The changelog subcommand to execute.' ],
],
};
================================================
FILE: packages/dev/src/cmds/changelog/list.js
================================================
const
chalk = require( 'chalk' ),
columnify = require( 'columnify' ),
{ getChangelogEntries, logResult } = require( '../../utils' );
module.exports = {
command: 'list',
description: 'List existing changelog entries.',
action: ( { dir } ) => {
const val = {
major: 2,
minor: 1,
patch: 0,
};
const entries = getChangelogEntries( dir )
// Group by significance and then sort by title.
.sort( ( { significance: aSig, title: aTitle }, { significance: bSig, title: bTitle } ) => {
if ( val[ aSig ] < val[ bSig ] ) {
return 1;
}
if ( val[ aSig ] > val[ bSig ] ) {
return -1;
}
return aTitle > bTitle ? -1 : 1;
} )
.map( ( entry ) => {
if ( 'major' === entry.significance ) {
Object.keys( entry ).forEach( ( key ) => entry[ key ] = chalk.bold( entry[ key ] ) );
} else if ( 'patch' === entry.significance ) {
Object.keys( entry ).forEach( ( key ) => entry[ key ] = chalk.dim( entry[ key ] ) );
}
return entry;
} );
if ( ! entries.length ) {
logResult( 'No changelog entries found.', 'warning' );
process.exit( 0 );
}
console.log( columnify(
entries,
{
headingTransform: ( heading ) => chalk.bold.underline( heading.toUpperCase() ),
preserveNewLines: true,
truncate: true,
maxWidth: 18,
config: {
entry: {
maxWidth: 40,
},
},
},
) );
},
};
================================================
FILE: packages/dev/src/cmds/changelog/validate.js
================================================
const
chalk = require( 'chalk' ),
path = require( 'path' ),
YAML = require( 'yaml' ),
{ getChangelogEntries, getChangelogValidationIssues, logResult } = require( '../../utils' );
/**
* Retrieve a symbol describing the status type.
*
* @since 0.0.1
*
* @param {string} type Status type.
* @return {string} The UTF8 symbol for the requested status.
*/
function getSymbol( type ) {
let symbol = '';
switch ( type ) {
case 'error':
symbol = chalk.red( '✘' );
break;
case 'success':
symbol = chalk.green( '✔' );
break;
case 'warning':
symbol = chalk.yellow( '▲' );
break;
}
return symbol;
}
/**
* Log a message with a status symbol prefix.
*
* @since 0.0.1
*
* @param {string} msg The message to log.
* @param {string} type The status type.
* @return {void}
*/
function logWithSymbol( msg, type ) {
console.log( chalk.italic( ` ${ getSymbol( type ) } ${ msg }` ) );
}
/**
* Determine the overall status for a given changelog entry
*
* @since 0.0.1
*
* @param {string[]} errors Array of encountered error messages.
* @param {string[]} warnings Array of encountered warning messages.
* @return {string} The overall status as a string.
*/
function determineOverallStatus( errors, warnings ) {
if ( errors.length ) {
return 'error';
}
if ( warnings.length ) {
return 'warning';
}
return 'success';
}
module.exports = {
command: 'validate',
description: 'Validate existing changelog entries.',
args: [
[ '[entries...]', 'Optionally specify a list of changelog entries to validate. If omitted will validate all existing entries.' ],
],
options: [
[ '-f, --format [format]', 'Output format. Accepts: list, json, yaml.', 'list' ],
[ '-s, --silent', 'Skip validation output and communicate validation status only through the exit status of the command.' ],
],
action: ( entries, { dir, silent, format } ) => {
let all;
try {
all = getChangelogEntries( dir );
} catch ( { name, message } ) {
logResult( `${ name }: ${ message }`, 'error' );
if ( 'YAMLSyntaxError' === name ) {
console.log( chalk.red( ' This usually means that one or more existing changelog entries contains invalid YAML.' ) );
}
process.exit( 1 );
}
// Reduce the list to only the requested entries.
if ( entries.length ) {
all = all.filter( ( { title } ) => entries.includes( path.parse( title ).name ) );
}
const res = {};
let exitStatus = 0;
all.forEach( ( log ) => {
const validation = getChangelogValidationIssues( log, 'list' === format ),
{ errors, warnings } = validation,
overallStatus = determineOverallStatus( errors, warnings );
if ( ! silent && 'list' === format ) {
console.log( '' );
console.log( `${ getSymbol( overallStatus ) } ${ chalk.bold( log.title ) }` );
console.log( chalk.dim( '-'.repeat( log.title.length + 2 ) ) );
if ( 'success' === overallStatus ) {
console.log( ' No issues.' );
}
errors.forEach( ( err ) => logWithSymbol( err, 'error' ) );
warnings.forEach( ( warn ) => logWithSymbol( warn, 'warning' ) );
}
if ( 'error' === overallStatus ) {
exitStatus = 1;
}
res[ log.title ] = validation;
} );
if ( ! silent ) {
if ( 'json' === format ) {
console.log( JSON.stringify( res ) );
} else if ( 'yaml' === format ) {
console.log( YAML.stringify( res ) );
}
}
process.exit( exitStatus );
},
};
================================================
FILE: packages/dev/src/cmds/changelog/version.js
================================================
const
chalk = require( 'chalk' ),
{ getNextVersion, getCurrentVersion, determineVersionIncrement, logResult } = require( '../../utils' );
const whichOpts = [ 'current', 'next' ];
module.exports = {
command: 'version',
description: 'List existing changelog entries.',
args: [
[ '<which>', `Which version to retrieve. Accepts: ${ whichOpts.join( ', ' ) }.` ],
],
options: [
[ '-p, --preid <identifier>', 'Identifier to be used to prefix premajor, preminor, prepatch or prerelease version increments.' ],
],
action: ( which, { dir, preid } ) => {
if ( ! whichOpts.includes( which ) ) {
logResult( `Unknown argument: "${ chalk.bold( which ) }".`, 'error' );
process.exit( 1 );
}
const currentVersion = getCurrentVersion();
if ( ! currentVersion ) {
logResult( 'No current version found.\n A version number must defined in the package.json file or in the composer.json file at ".extra.llms.version".', 'error' );
process.exit( 1 );
}
if ( 'current' === which ) {
console.log( currentVersion );
process.exit( 0 );
}
console.log( getNextVersion( currentVersion, determineVersionIncrement( dir, currentVersion, preid ), preid ) );
},
};
================================================
FILE: packages/dev/src/cmds/changelog/write.js
================================================
const
path = require( 'path' ),
{ readFileSync, writeFileSync, readdirSync, rmSync } = require( 'fs' ),
chalk = require( 'chalk' ),
semver = require( 'semver' ),
{
ChangelogEntry,
getNextVersion,
getCurrentVersion,
getChangelogOptions,
getChangelogValidationIssues,
getChangelogEntries,
getFileLink,
getIssueLink,
isProjectPublic,
determineVersionIncrement,
logResult,
execSync,
} = require( '../../utils' );
/**
* Accepts a date/time string and converts it to YYYY-MM-DD format used in changelog version titles.
*
* @since 0.0.1
*
* @param {string|number} date Timestamp or datetime string parseable by `Date.parse()`.
* @return {string} Date string in YYYY-MM-DD format.
*/
const formatDate = ( date ) => new Date( date ).toISOString().split( 'T' )[ 0 ];
/**
* Retrieve the an array of lines for the changelog entry's header.
*
* @since 0.0.1
*
* @param {string} version A semver string.
* @param {string} date A date string.
* @return {string[]} Array of lines.
*/
function getHeaderLines( version, date ) {
const lines = [ `v${ version } - ${ date }` ];
lines.push( '-'.repeat( lines[ 0 ].length ) );
return lines;
}
/**
* Retrieve the title for the changelog item's type.
*
* @since 0.0.1
*
* @param {string} type The changelog item type key.
* @return {string} The changelog item type title.
*/
function getTypeTitle( type ) {
const map = {
added: 'New Features',
changed: 'Updates and Enhancements',
fixed: 'Bug Fixes',
deprecated: 'Deprecations',
removed: 'Breaking Changes',
dev: 'Developer Notes',
performance: 'Performance Improvements',
security: 'Security Fixes',
template: 'Updated Templates',
};
return `\n##### ${ map[ type ] }\n`;
}
/**
* Formats a single changelog item.
*
* @since 0.0.1
* @since 0.1.0 Use `getIssueLink()` for generation of issue links.
* @since 0.2.1 Remove trailing `@` from the GitHub handler when building the contributor's profile URL.
*
* @param {ChangelogEntry} args The changelog entry object.
* @param {string} args.entry The content of the changelog entry.
* @param {string} args.type Entry type.
* @param {string[]} args.attributions List of individuals attributed to the entry.
* @param {string[]} args.links of GitHub issues linked to the entry.
* @param {boolean} includeLinks Whether or not to include links.
* @return {string} The formatted changelog entry line.
*/
function formatChangelogItem( { entry, type, attributions = [], links = [] }, includeLinks ) {
entry = entry.trim();
// Entries should always end in a full stop.
if ( 'template' !== type && ! [ '.', '?', '!' ].includes( entry.split( '' ).reverse()[ 0 ] ) ) {
entry += '.';
}
let line = '';
// Single entry, add a bullet.
if ( ! entry.includes( '\n' ) ) {
line += '+ ';
}
// Add the line(s).
line += entry;
// Add formatted attribution links.
if ( attributions.length ) {
attributions = attributions.map( ( v ) => {
if ( '@' === v.charAt( 0 ) ) {
v = `[${ v }](https://github.com/${ v.slice( 1 ) })`;
}
return v;
} );
line += ` Thanks ${ new Intl.ListFormat( 'en', { style: 'long', type: 'conjunction' } ).format( attributions ) }!`;
}
// Add issue links.
if ( includeLinks && links.length ) {
line += ' ' + links.map( ( iss ) => `[${ iss }](${ getIssueLink( iss ) })` ).join( ', ' );
}
return line;
}
/**
* Retrieve a list changelog entry objects for all the template files that have been modified.
*
* Compares the current git branch against the `trunk` branch in order to find all files in the `templates/` directory
* which have been modified.
*
* @since 0.0.1
* @since 0.1.0 Use `getFileLink()` to generate links to the template file.
*
* @param {boolean} includeLinks Whether or not the entry items should be formatted as links to the GitHub repository.
* @param {string} version A semver string.
* @return {ChangelogEntry[]} Array of changelog entry objects.
*/
function getUpdatedTemplates( includeLinks, version ) {
try {
return execSync( 'git diff --name-only trunk | grep "^templates/"', true ).split( '\n' ).map( ( template ) => {
return {
type: 'template',
entry: includeLinks ? `[${ template }](${ getFileLink( template, version ) })` : template,
};
} );
} catch ( e ) {}
return [];
}
/**
* Format the changelog entry for the given version.
*
* @since 0.0.1
*
* @param {string} version A semver string.
* @param {string} date Version release date in YYYY-MM-DD format.
* @param {ChangelogEntry[]} entries All entry objects to be included.
* @param {boolean} links Whether or not to add links to GitHub issues and templates. For public repos we want to show links, otherwise we don't bother.
* @return {string[]} Array of lines to be added to the changelog.
*/
function formatChangelogVersionEntry( version, date, entries, links ) {
const
groups = {},
{ type } = getChangelogOptions();
Object.keys( type ).forEach( ( groupKey ) => {
groups[ groupKey ] = [];
} );
groups.template = [];
// Add updated template list.
entries = [ ...entries, ...getUpdatedTemplates( links, version ) ];
entries.forEach( ( entry ) => {
groups[ entry.type ].push( entry );
} );
const lines = [
...getHeaderLines( version, date ),
];
Object.entries( groups ).forEach( ( [ groupType, groupEntries ] ) => {
if ( ! groupEntries.length ) {
return;
}
lines.push( getTypeTitle( groupType ) );
groupEntries.forEach( ( entry ) => {
lines.push( formatChangelogItem( entry, links ) );
} );
} );
return lines;
}
/**
* Delete all changelog entry files from the changelog directory.
*
* @since 0.0.1
*
* @param {string} dir Changelog directory.
* @return {void}
*/
function cleanupLogs( dir ) {
readdirSync( dir ).forEach( ( file ) => {
if ( file.endsWith( '.yml' ) ) {
rmSync( path.join( dir, file ) );
}
} );
}
module.exports = {
command: 'write',
description: 'Write existing changelog entries to the changelog file.',
options: [
[ '-p, --preid <identifier>', 'Identifier to be used to prefix premajor, preminor, prepatch or prerelease version increments.' ],
[ '-F, --force <version>', 'Use the specified version string instead of determining the version based on changelog entry significance.' ],
[ '-l, --log-file <file>', 'The changelog file.', 'CHANGELOG.md' ],
[ '-d, --date <YYYY-MM-DD>', 'Changelog publication date.', formatDate( Date.now() ) ],
[ '-L, --links', 'Add GitHub links to templates and issues in changelog entries.', true === isProjectPublic() ],
[ '-n, --no-links', 'Do not add GitHub links in changelog entries. Use this option to override the --links flag.' ],
[ '-D, --dry-run', 'Output what would be written to the changelog instead of writing it to the changelog file.' ],
[ '-k, --keep-entries', 'Preserve entry files deletion after the changelog is written.' ],
],
action: ( { dir, preid, force, logFile, date, links, dryRun, keepEntries } ) => {
try {
date = formatDate( date );
} catch ( e ) {
logResult( 'Invalid date supplied. Please provide a date in YYYY-MM-DD format.', 'error' );
process.exit( 1 );
}
const currentVersion = getCurrentVersion();
if ( ! currentVersion ) {
logResult( 'No current version found.\n A version number must defined in the package.json file or in the composer.json file at ".extra.llms.version".', 'error' );
process.exit( 1 );
}
const entries = getChangelogEntries( dir );
const areEntriesValid = entries.every( ( entry ) => {
const { valid } = getChangelogValidationIssues( entry );
return valid;
} );
if ( ! areEntriesValid ) {
logResult( 'One or more invalid changelog entries were found. Please resolve all validation issues and try again.', 'error' );
process.exit( 1 );
}
let version = force;
if ( ! version ) {
version = getNextVersion( currentVersion, determineVersionIncrement( dir, currentVersion, preid ), preid );
} else if ( ! semver.valid( version ) ) {
logResult( `The supplied version string ${ chalk.bold( version ) } is invalid.`, 'error' );
process.exit( 1 );
}
logResult( `${ dryRun ? 'Generating' : 'Writing' } changelog for version ${ chalk.bold( version ) }.` );
const logFileContents = readFileSync( logFile, 'utf8' );
const
logFileParts = logFileContents.split( '\n\n' ),
[ header, ...body ] = logFileParts,
items = formatChangelogVersionEntry( version, date, entries, links ).join( '\n' ) + '\n';
if ( dryRun ) {
console.log( items );
process.exit( 0 );
}
writeFileSync( logFile, [ header, items, ...body ].join( '\n\n' ) );
logResult( `Changelog for version ${ chalk.bold( version ) } written.` );
if ( ! keepEntries ) {
logResult( `Peforming entry file cleanup`, 'warning' );
cleanupLogs( dir );
}
},
};
================================================
FILE: packages/dev/src/cmds/docgen.js
================================================
const path = require( 'path' ),
{ Command } = require( 'commander' ), // Including for the type definition.
{ readFileSync, writeFileSync } = require( 'fs' );
/**
* Generate a doc section for the specified command.
*
* @since 0.0.1
* @since 0.1.0 Include beforeHelp and afterHelp data added by `Command.addHelpText()`.
*
* @param {Command} command A commander command instance.
* @param {string} parentName Name of the parent command (used for subcommands).
* @return {string} Documentation section MD text.
*/
function createCommandSection( command, parentName = '' ) {
parentName = parentName ? `${ parentName } ` : '';
const commandName = command.name();
let text = '';
if ( ! command.commands.length ) {
text = `\n### ${ parentName }${ commandName }\n\n`;
text += '```bash\n';
command.emit( 'beforeHelp', { write: ( helpStr ) => text += helpStr } );
text += command.helpInformation();
command.emit( 'afterHelp', { write: ( helpStr ) => text += helpStr } );
text += '\n```\n';
} else {
command.commands.forEach( ( subcommand ) => {
text += createCommandSection( subcommand, commandName );
} );
}
return text;
}
module.exports = {
command: 'docgen',
description: 'Generates documentation for the CLI.',
action: ( env, { parent } ) => {
const readmeFile = path.join( __dirname, '../../README.md' ),
readmeContents = readFileSync( readmeFile, 'utf8' ),
startToken = '<!-- START TOKEN(Autogenerated API docs) -->',
endToken = '<!-- END TOKEN(Autogenerated API docs) -->',
docsToken = '<!-- DOCS TOKEN -->';
let newReadme = [],
addLine = true;
readmeContents.split( '\n' ).forEach( ( line ) => {
if ( line === startToken ) {
newReadme.push( line );
newReadme.push( docsToken );
addLine = false;
} else if ( line === endToken ) {
addLine = true;
}
if ( addLine ) {
newReadme.push( line );
}
} );
newReadme = newReadme.join( '\n' );
let docs = '';
parent.commands.forEach( ( command ) => {
docs += createCommandSection( command );
} );
writeFileSync( readmeFile, newReadme.replace( docsToken, docs ) );
},
};
================================================
FILE: packages/dev/src/cmds/meta/index.js
================================================
module.exports = {
command: 'meta',
description: "Mange the project's metadata.",
optionsShared: [
],
args: [
[ '<command>', 'The meta subcommand to execute.' ],
],
};
================================================
FILE: packages/dev/src/cmds/meta/parse.js
================================================
const
chalk = require( 'chalk' ),
columnify = require( 'columnify' ),
YAML = require( 'yaml' ),
{ existsSync } = require( 'fs' ),
{ getProjectSlug, logResult, parseMainFileMetadata } = require( '../../utils' );
module.exports = {
command: 'parse',
description: "Retrieves metadata from the project's main file.",
options: [
[ '-F, --file <file>', 'Main project file name.', `${ getProjectSlug() }.php` ],
[ '-k, --key <key>', 'Retrieves a single metadata by key name.' ],
[ '-f, --format [format]', 'Output format. Accepts: table, json, yaml.', 'table' ],
],
action: ( { file, key, format } ) => {
if ( ! existsSync( file ) ) {
logResult( `Invalid file: "${ chalk.bold( file ) }".`, 'error' );
process.exit( 1 );
}
const metas = parseMainFileMetadata( file );
if ( key ) {
if ( metas[ key ] ) {
console.log( metas[ key ] );
process.exit( 0 );
} else {
logResult( `No metadata found for key name "${ chalk.bold( key ) }".`, 'error' );
process.exit( 1 );
}
}
if ( 'json' === format ) {
console.log( JSON.stringify( metas ) );
} else if ( 'yaml' === format || 'yml' === format ) {
console.log( YAML.stringify( metas ) );
} else if ( 'table' === format ) {
console.log(
columnify(
metas,
{
headingTransform: ( heading ) => chalk.bold.underline( heading.toUpperCase() ),
},
)
);
}
},
};
================================================
FILE: packages/dev/src/cmds/pot.js
================================================
const
path = require( 'path' ),
{ Command } = require( 'commander' ), // Including for the type definition.
{ readFileSync, writeFileSync } = require( 'fs' ),
{ execSync, logResult, getProjectSlug } = require( '../utils' ),
defaultExclude = 'vendor/**, node_modules/**, tmp/**, dist/**, docs/**, src/**, tests/**, *.js.map';
/**
* Command: pot
*
* @since 0.0.1
*
* @type {Object}
*/
module.exports = {
command: 'pot',
description: 'Generate i18n pot and json files using the WP-CLI.',
options: [
[ '-d, --text-domain <text-domain>', 'Specify the text domain. Used to generate the filenames for generated files.', getProjectSlug() ],
[ '-e, --exclude <glob...>', 'Specify files to exclude from scanning.', defaultExclude ],
[ '-ee, --extra-exclude <glob...>', 'Additional files to add to the --exclude option.' ],
[ '-d, --dir <directory>', 'Output directory where generated files will be stored.', 'i18n' ],
[ '-t, --translator <translator>', 'Customize the Last Translator header.', 'Team LifterLMS <team@lifterlms.com>' ],
[ '-b, --bugs <url>', 'Customize the bug report location header.', 'https://lifterlms.com/my-account/my-tickets' ],
],
/**
* Callback action for the pot command
*
* @since 0.0.1
*
* @param {Object} options Command options.
* @param {string} options.textDomain Project text domain.
* @param {string} options.exclude Comma separated list of globs used to exclude files from the pot file generation.
* @param {string} options.extraExclude Extra globs to be added to exclude.
* @param {string} options.dir Output directory where the generated files will be saved.
* @param {string} options.translator Translator name and email.
* @param {string} options.bugs Bug report URL.
* @param {Command} command The command instance.
* @param {Command} command.parent The command's parent command.
* @return {void}
*/
action: ( { textDomain, exclude, extraExclude, dir, translator, bugs }, { parent } ) => {
// Ensure WP-CLI is available.
try {
execSync( 'which wp', true );
} catch ( e ) {
logResult( 'WP-CLI must be installed in your $PATH in order to use this command.', 'error' );
process.exit( 1 );
}
const
// Replace the WP CLI generator with our own generator string.
generator = `llms/dev ${ parent.version() }`,
// Get the year of the first commit to the repo.
initYear = parseInt( execSync( 'git log --reverse --format="format:%cd" --date="format:%Y" | sed -n 1p', true ) ),
currDate = new Date(),
currYear = currDate.getFullYear(),
pot = path.join( dir, `${ textDomain }.pot` ),
// Custom Headers.
headers = {
'Last-Translator': translator,
'Language-Team': translator,
'Report-Msgid-Bugs-To': bugs,
'X-Generator': generator,
};
// Add extra exclude globs, if defined.
if ( extraExclude ) {
exclude = exclude + ', ' + extraExclude;
}
// Update excludes glob formatting to a format acceptable by WP CLI.
exclude = exclude.replace( /\/\*\*/g, '/' ).replace( /\.\//g, '' );
const cmdOpts = `--exclude="${ exclude }" --headers='${ JSON.stringify( headers ) }'`;
// Generate the POT file.
execSync( `wp i18n make-pot ./ ${ pot } ${ cmdOpts }` );
// Get the original header comment.
let headerComment = execSync( `head -2 ${ pot }`, true ),
potContents = readFileSync( pot ).toString();
// If the initial commit date is not equal to the current year, update the copyright to include the date range.
if ( initYear !== currYear ) {
potContents = potContents.replace( headerComment, '' );
headerComment = headerComment.replace( `(C) ${ currYear }`, `(C) ${ initYear }-${ currYear }` );
}
// Write the header back to the file.
writeFileSync( pot, headerComment + potContents );
},
};
================================================
FILE: packages/dev/src/cmds/readme.js
================================================
const
path = require( 'path' ),
chalk = require( 'chalk' ),
semver = require( 'semver' ),
{ readdirSync, readFileSync, writeFileSync } = require( 'fs' ),
{ parseChangelogFile, parseMainFileMetadata, getCurrentVersion, logResult, getProjectSlug } = require( '../utils' );
/**
* Generate the truncated changelog section content.
*
* @since 0.0.1
*
* @param {string} file Changelog file.
* @param {number} length Number of versions to include.
* @return {string} The truncated changelog section content.
*/
function getChangelogSection( file, length ) {
const entries = parseChangelogFile( file ),
total = entries.length,
lines = [];
let i = 0,
added = 0;
while ( added < length && i < total ) {
const currLog = entries[ i ];
// Don't add prereleases.
if ( ! semver.prerelease( currLog.version ) ) {
lines.push( `= v${ currLog.version } - ${ currLog.date } =\n\n` );
lines.push( currLog.logs );
++added;
if ( added < length ) {
lines.push( '\n\n\n' );
}
}
++i;
}
return lines.join( '' );
}
/**
* Generates the merge code help text.
*
* @since 0.1.0
*
* @return {string} Help text.
*/
function getMergeCodeHelp() {
return `
Merge codes:
The following merge codes can be used in any of the readme part markdown files.
| Merge Code | Description | Source |
| ----------------------------- | -----------------------------------------------------------------------| ------------ |
| {{__CHANGELOG_ENTRIES__}} | The most recent 10 changelog entries. | --input-file |
| {{__LICENSE__}} | The project's license (GPLv3). | --main-file |
| {{__LICENSE_URI__}} | The URI to the project's license. | --main-file |
| {{__MIN_WP_VERSION__}} | The minimum required WordPress core version. | --main-file |
| {{__MIN_LLMS_VERSION__}} | The minimum required LifterLMS version. | --main-file |
| {{__MIN_PHP_VERSION__}} | The minimum required PHP version. | --main-file |
| {{__PROJECT_URI__}} | The project's URI. | --main-file |
| {{__READ_MORE_LINK__}} | A link to the full project changelog. | --main-file |
| {{__SHORT_DESCRIPTION__}} | A short description of the project. | --main-file |
| {{__TESTED_LLMS_VERSION__}} | The latest LifterLMS version the project has been tested against. | --main-file |
| {{__TESTED_WP_VERSION__}} | The latest WordPress core version the project has been tested against. | --main-file |
| {{__VERSION__}} | The current project version. | package.json |
`;
}
/**
* Command: readme
*
* @since 0.0.1
* @since 0.1.0 Added the `--main-file` option as well as additional merge codes derived from metadata found in the main file's header comment.
* Exits with a warning and exit code `0` (instead of an error and exit code `1`) when running this command against a prerelease.
*
* @type {Object}
*/
module.exports = {
command: 'readme',
description: 'Create a readme.txt file suitable for the WordPress.org plugin repository.',
options: [
[ '-o, --output-file <filename>', 'Specify the output readme file name.', 'readme.txt' ],
[ '-i, --input-file <filename>', 'Specify the input changelog file name.', 'CHANGELOG.md' ],
[ '-m, --main-file <filename>', 'Specify the project main file name where metadata is stored.', `${ getProjectSlug() }.php` ],
[ '-d, --dir <directory>', 'Directory where the readme part files are stored', '.wordpress-org/readme' ],
[ '-l, --changelog-length <number>', 'Specify the number of versions to display before truncating the changelog.', 10 ],
[ '-r, --read-more <url>', 'Specify the "Read More" url where changelogs are published.', `https://make.lifterlms.com/tag/${ getProjectSlug() }` ],
],
help: [
[ 'after', getMergeCodeHelp() ]
],
action: ( { outputFile, inputFile, mainFile, dir, readMore, changelogLength } ) => {
const version = getCurrentVersion();
// Don't generate readme files for pre-releases.
if ( semver.prerelease( version ) ) {
logResult( 'Cannot generate a readme for prereleases.', 'warning' );
process.exit( 0 );
}
const metas = parseMainFileMetadata( mainFile );
const replacements = {
PROJECT_URI: metas['Plugin URI'] ?? '',
LICENSE: metas['License'] ?? '',
LICENSE_URI: metas['License URI'] ?? '',
MIN_WP_VERSION: metas['Requires at least'] ?? '',
TESTED_WP_VERSION: metas['Tested up to'] ?? '',
MIN_LLMS_VERSION: metas['LLMS requires at least'] ?? '',
TESTED_LLMS_VERSION: metas['LLMS tested up to'] ?? '',
MIN_PHP_VERSION: metas['Requires PHP'] ?? '',
SHORT_DESCRIPTION: metas['Description'] ?? '',
VERSION: version,
CHANGELOG_ENTRIES: getChangelogSection( inputFile, changelogLength ),
READ_MORE_LINK: readMore,
},
files = readdirSync( dir );
let readme = '';
files.forEach( ( filename, i ) => {
const file = readFileSync( path.join( dir, filename ), 'utf8' );
readme += file;
// Add newlines if it's not the last section.
if ( files.length - 1 !== i ) {
readme += '\n\n';
}
} );
// Replace variables.
Object.keys( replacements ).forEach( ( varname ) => {
readme = readme.replace( new RegExp( `{{__${ varname }__}}`, 'g' ), replacements[ varname ] );
} );
writeFileSync( outputFile, readme );
logResult( `Generated ${ chalk.bold( outputFile ) } for version ${ chalk.bold( version ) }.`, 'success' );
},
};
================================================
FILE: packages/dev/src/cmds/release/archive.js
================================================
const
chalk = require( 'chalk' ),
{ createDistFile, execSync, logResult } = require( '../../utils' );
/**
* Build distribution archive.
*
* @since 0.0.1
* @since 0.2.1 Windows compatibility: account for spaces in file paths.
*
* @return {string}
*/
module.exports = {
command: 'archive',
description: 'Build a distribution archive (.zip) file for the project.',
options: [
[ '-i, --inspect', 'Automatically unzip the zip file after creation.', false ],
[ '-d, --dir <dir>', 'Directory where the generated archive file will be saved, relative to the project root directory.', 'dist' ],
[ '-v, --verbose', 'Output extra information with result messages.', false ],
],
action: ( { inspect, dir, verbose } ) => {
const distDir = `${ process.cwd() }/${ dir }`,
fileName = createDistFile(
distDir,
! verbose,
( msg ) => logResult( msg, 'info' )
);
// Unzip the archive for inspection.
if ( inspect ) {
execSync( `unzip "${ fileName }"`, ! verbose, { cwd: distDir } );
}
logResult( `Distribution file ${ chalk.bold( fileName ) } created successfully.`, 'success' );
},
};
================================================
FILE: packages/dev/src/cmds/release/create.js
================================================
const
path = require( 'path' ),
{ existsSync, writeFileSync } = require( 'fs' ),
chalk = require( 'chalk' ),
inquirer = require( 'inquirer' ),
{ getCurrentVersion, getChangelogForVersion, getArchiveFilename, logResult, pushDistFile, execSync } = require( '../../utils' );
/**
* Create a temporary changelog file used to add the changelog to the GitHub release.
*
* @since 0.0.1
*
* @param {string} version Semver string for the version being published.
* @param {string} logfile Path to the the changelog file.
* @return {string} Path to the temporary notes file.
*/
function writeTempNotesFile( version, logfile ) {
const { date, logs } = getChangelogForVersion( version, logfile ),
tmpFile = path.join( process.cwd(), 'tmp', 'release-notes.txt' );
let header = `v${ version } - ${ date }`;
header = `${ header }\n${ '-'.repeat( header.length ) }`;
writeFileSync( tmpFile, `${ header }\n\n${ logs }` );
return tmpFile;
}
module.exports = {
command: 'create',
description: 'Create a GitHub release and tag from a specified file or branch.',
options: [
[ '-a, --archive <zip>', 'If specified, the zip file will be committed and force-pushed to the specified branch before creating the release. Pass --no-archive to skip this step.', getArchiveFilename() ],
[ '-A, --no-archive', 'Skip creation from an archive file and use the target --branch for release creation.' ],
[ '-c, --commit-message <message>', 'Customize the commit message used when pushing to the target branch. Used only when releasing from an archive. The placeholder "%s" is replaced with the release version.', 'Release v%s [ci skip]' ],
[ '-d, --dir <directory>', 'Directory where distribution files are stored.', 'dist' ],
[ '-b, --branch <branch>', 'Target branch to use when creating the release.', 'release' ],
[ '-l, --logfile <file>', 'Specify the changelog file.', 'CHANGELOG.md' ],
[ '-p, --prerelease', 'Mark the GitHub release as a prerelease and skip merging.' ],
[ '-P, --prerelease-branch <branch>', 'When creating a prerelease, use this branch as the target branch in favor of the default branch specified via the --branch option.', 'prerelease' ],
[ '-D, --draft', 'Create the release as an unpublished draft and skip merging.' ],
[ '-M, --merge <branch>', 'Merge open PRs on the specified branch before creating the release. If publishing a prerelease, or draft merging is automatically disabled as if passing "--no-merge".', '' ],
[ '-n, --no-merge', 'Disable merging before release creation. Automatically passed when publishing a prerelease.' ],
[ '-Y, --yes', 'Skip confirmations.' ],
[ '-v, --verbose', 'Output extra information with result messages.' ],
],
/**
* The `create` command.
*
* @since 0.0.1
* @since 0.2.1 Windows compatibility: account for spaces in file paths.
*
* @return {void}
*/
action: async ( { archive, dir, commitMessage, branch, logfile, prerelease, prereleaseBranch, draft, merge, yes, verbose } ) => {
// Ensure the CLI is installed before proceeding.
try {
execSync( 'which gh', true );
} catch ( Error ) {
logResult( 'The GitHub CLI client "gh" must be installed to use this command.', 'error' );
process.exit( 1 );
}
// If there's untracked files or the working tree is dirty.
if ( execSync( 'git status -s', true ) ) {
logResult( 'The working tree must be clean before publishing.', 'error' );
process.exit( 1 );
}
if ( archive ) {
archive = path.join( dir, archive );
if ( ! existsSync( archive ) ) {
logResult( `The distribution file ${ chalk.bold( archive ) } doesn't exist.`, 'error' );
process.exit( 1 );
}
}
const version = getCurrentVersion();
commitMessage = commitMessage.replace( '%s', version );
// Use the prerelease branch when publishing a prerelease.
if ( prerelease ) {
branch = prereleaseBranch;
merge = false;
}
// Disable merging if publishing a draft.
if ( draft ) {
merge = false;
}
// Output information and confirm the release (unless `--yes` is passed);
if ( ! yes ) {
logResult( `About to publish a new ${ prerelease ? 'prerelease' : 'release' }${ draft ? ' (draft)' : '' }:`, 'warning' );
logResult( `${ chalk.bold( version ) }`, ' + Version' );
if ( archive ) {
logResult( `${ chalk.bold( archive ) }`, ' + Archive' );
}
logResult( `${ chalk.bold( branch ) }`, ' + Branch' );
if ( merge ) {
logResult( `${ chalk.bold( merge ) }`, ' + Merge from branch' );
}
yes = await inquirer.prompt( [ {
type: 'expand',
message: 'Are you sure you wish to proceed?',
name: 'yes',
choices: [
{
key: 'y',
name: 'Yes',
value: true,
},
{
key: 'n',
name: 'No',
value: false,
},
],
} ] )
.then( ( answers ) => answers.yes )
.catch( ( err ) => console.log( err ) );
}
if ( ! yes ) {
logResult( 'Release aborted.', 'error' );
process.exit( 1 );
}
logResult( `Releasing version ${ chalk.bold( version ) } to the ${ chalk.bold( branch ) } branch.` );
// Push the distfile to the release branch.
if ( archive ) {
pushDistFile( archive, branch, commitMessage, ! verbose );
}
// Merge open PRs against the specified branch.
if ( merge ) {
execSync( `gh pr merge ${ merge } --merge`, true );
}
// Setup the release to pass to the GH CLI.
const
notesFile = writeTempNotesFile( version, logfile ),
createArgs = [];
if ( archive ) {
createArgs.push( archive );
}
createArgs.push( `--title "Version ${ version }"` );
createArgs.push( `--target ${ branch }` );
createArgs.push( `--notes-file "${ notesFile }"` );
if ( draft ) {
createArgs.push( '--draft' );
}
if ( prerelease ) {
createArgs.push( '--prerelease' );
}
// Create the release.
const res = execSync( `gh release create ${ version } ${ createArgs.join( ' ' ) }`, true );
logResult( `Release v${ chalk.bold( version ) } published. Permalink: ${ chalk.underline( res ) }.` );
// Cleanup the tmp notesfile.
execSync( `rm "${ notesFile }"` );
},
};
================================================
FILE: packages/dev/src/cmds/release/index.js
================================================
module.exports = {
command: 'release',
description: 'Prepare and deploy releases.',
args: [
[ '<command>', 'The changelog subcommand to execute.' ],
],
};
================================================
FILE: packages/dev/src/cmds/release/prepare.js
================================================
const
chalk = require( 'chalk' ),
inquirer = require( 'inquirer' ),
semver = require( 'semver' ),
{ execSync, logResult } = require( '../../utils' );
/**
* Call the cli from within the cli.
*
* @since 0.0.1
* @since 0.2.1 Account for spaces in the file paths.
*
* @param {string} cmd CLI command and options.
* @param {boolean} silent If `true`, silence STDOUT.
* @return {?string} The STDOUT content if `silent` is `true`, otherwise `null`.
*/
function callSelf( cmd, silent = true ) {
const [ node, cli ] = process.argv;
let ret = null;
try {
ret = execSync( `"${ node }" "${ cli }" ${ cmd }`, silent );
} catch ( e ) {
logResult( `${ e.type }: ${ e.message }.`, 'error' );
console.error( e );
process.exit( 1 );
}
return ret;
}
/**
* Open a CLI prompt and await user confirmation.
*
* @since 0.0.1
*
* @param {string} message Message to prompt for confirmation.
* @param {boolean} skip If true, the script is being run with `--yes` and no prompt should be made.
* @return {Promise} Returns a promise from the inquirer prompt.
*/
function prompt( message, skip = false ) {
if ( skip ) {
return true;
}
const questions = [
{
type: 'confirm',
name: 'confirm',
message,
default: true,
},
];
return inquirer.prompt( questions )
.then( ( { confirm } ) => confirm );
}
module.exports = {
command: 'prepare',
description: 'Prepare and build a release.',
options: [
[ '-F, --force <version>', 'Specify a version to use. If not specified uses `changelog version next` to determine the version.' ],
[ '-p, --preid <identifier>', 'Identifier to be used to prefix premajor, preminor, prepatch or prerelease version increments.' ],
[ '-y, --yes', 'Specify no-interaction mode. Responds "yes" to all confirmation prompts.' ],
[ '-b, --build <cmd>', 'Specify an npm script to use for the build command.', 'build' ],
[ '-B, --no-build', 'Disabled build script.' ],
],
action: async ( { force, preid, build, yes } ) => {
preid = preid ? ` --preid ${ preid }` : '';
// Prepare release version.
const version = force ? force : callSelf( `changelog version next${ preid }` );
if ( ! semver.valid( version ) ) {
logResult( `The supplied version string ${ chalk.bold( version ) } is invalid.`, 'error' );
process.exit( 1 );
}
// Confirm version.
if ( ! await prompt( `Proceed using version ${ chalk.bold( version ) }?`, yes ) ) {
process.exit( 1 );
}
// Get the changelog.
if ( ! yes ) {
callSelf( `changelog write --dry-run --force ${ version }`, false );
if ( ! await prompt( 'Use the above output for the changelog and build the release?' ) ) {
process.exit( 1 );
}
}
// Update files.
callSelf( `changelog write --force ${ version }`, false );
// Update version.
callSelf( `update-version --force ${ version }` );
// Build.
if ( build ) {
execSync( `npm run ${ build }` );
}
logResult( `Release preparation for version ${ chalk.bold( version ) } complete.`, 'success' );
},
};
================================================
FILE: packages/dev/src/cmds/update-version.js
================================================
const
chalk = require( 'chalk' ),
semver = require( 'semver' ),
columnify = require( 'columnify' ),
replace = require( 'replace-in-file' ),
{ writeFileSync } = require( 'fs' ),
{ getCurrentVersion, getNextVersion, logResult, getConfig, hasConfig, execSync } = require( '../utils' );
/**
* Update [version] placeholders via a regex against a list of file globs
*
* @since 0.0.1
* @since 0.0.5 Added `flags` argument to allow customization of the regex flags.
*
* @param {string} files Comma separated list of file globs.
* @param {regex} regex A regular expression to use for the replacements.
* @param {string flags A regex options string.
* @param {string} ignore A comma separated list of file globs to be ignored.
* @param {string} ver The semantic version string to replace the placeholder with.
* @return {Object} Replacement result object from `replace.sync()`.
*/
function updateVersions( files, regex, flags, ignore, ver ) {
const commasToArray = ( string ) => string.split( ',' ).map( ( s ) => s.trim() );
files = commasToArray( files );
logResult( `Replacing ${ chalk.bold( files ) } using regex ${ chalk.bold( regex ) }.` );
const
opts = {
files,
from: new RegExp( regex, flags ),
to: ver,
ignore: ignore ? commasToArray( ignore ) : null,
countMatches: true,
};
return replace.sync( opts );
}
/**
* Updates the version number in the package's config file.
*
* If a package.json file is present, uses `npm version` to update the project's version.
*
* If there is no package.json, will attempt to update the `extra.llms.version` item in the
* project's composer.json file.
*
* @since 0.0.1
*
* @param {string} ver Semantic version string.
* @return {Object} A replacement result string.
*/
function updateConfig( ver ) {
const ret = {
Matches: chalk.yellow( 1 ),
Replacements: chalk.yellow( 1 ),
};
if ( hasConfig( 'package' ) ) {
// Silence update errors. When updating new files and the package has already been updated the CLI throws an error which we can ignore.
try {
logResult( 'Updating package.json.' );
execSync( `npm version --no-git-tag-version ${ ver }`, true );
return [
{
File: chalk.green( 'package.json' ),
...ret,
},
{
File: chalk.green( 'package-lock.json' ),
...ret,
},
];
} catch ( e ) {}
} else if ( hasConfig( 'composer' ) ) {
const composer = getConfig( 'composer' );
if ( composer?.extra?.llms?.version ) {
logResult( 'Updating composer.json.' );
composer.extra.llms.version = ver;
writeFileSync( `${ process.cwd() }/composer.json`, JSON.stringify( composer, null, 2 ) );
return [
{
File: chalk.green( 'composer.json' ),
...ret,
},
];
}
}
return false;
}
const deprecatedFunctions = [
// WP deprecation warnings.
'_deprecated_argument',
'_deprecated_constructor',
'_deprecated_hook',
'_deprecated_file',
'_deprecated_function',
// Doing it wrong warning.
'_doing_it_wrong',
// Deprecated hook callers.
'apply_filters_deprecated',
'do_action_deprecated',
// LLMS deprecation warnings.
'llms_deprecated_function',
].join( '|' );
const defaultReplacements = [
// 1. Replace [version] placeholder in all @since, @version, and @deprecated tags.
[
'./**',
'(?<=@(?:since|version|deprecated) +)(\\[version\\])',
'g',
false,
],
// 2. Replace [version] placeholder in all deprecate function methods tags.
[
'./*.php,./**/*.php',
`(?<=(?:${ deprecatedFunctions }\\().+)(?<=\')(\\[version\\])(?=\')`,
'g',
false,
],
// 3. Replace plugin metadata "Version" with current version.
[
'*lifterlms*.php',
'(?<=[Vv]ersion *[:=] *[ \'\"])(0|[1-9]\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?',
'g',
true,
],
// 4. Replace LIFTERLMS*_VERSION constants with the current version.
[
'*lifterlms*.php',
'(?<=define\\( \'(?:LLMS|LIFTERLMS).*_VERSION\', \')(.*)(?=\' \\);)',
'g',
true,
],
// 5. Replace theme stylesheet's version number with the current version.
[
'./style.css',
'(?<=Version: )(.+)',
'g',
true,
],
];
/**
* Command: update-version
*
* @since 0.0.1
* @since 0.2.0 Added 4th parameter to the replacement arrays to allow excluding replacement sets when building a prerelease.
*
* @type {Object}
*/
module.exports = {
command: 'update-version',
description: 'Update the project version and replace all [version] placeholders.',
options: [
[ '-i, --increment <level>', 'Increment the version by the specified level. Accepts: major, minor, patch, premajor, preminor, prepatch, or prerelease.', 'patch' ],
[ '-p, --preid <identifier>', 'Identifier to be used to prefix premajor, preminor, prepatch or prerelease version increments.' ],
[ '-F, --force <version>', 'Specify an explicit version instead of incrementing the current version with --increment.' ],
[ '-r, --replacements <replacement...>]', 'Replacements to be made. Each replacement is an array containing a list of globs for the files to be tested, a regex used to perform the replacement, an optional list of RegEx flags (defaults to `g` if not supplied), and a boolean used to specify if the replacement should be run when building a prerelease (defaults to `false` if not supplied). It is recommended that this argument to configured via a configuration file as opposed to being passed via a CLI flag.', defaultReplacements ],
[ '-e, --extra-replacements <replacement...>]', 'Additional replacements added to --replacements array. This option allows adding to the default replacements instead of overwriting them.', [] ],
[ '-E, --exclude <glob...>', 'Specify files to exclude from the update.', './vendor/**, ./node_modules/**, ./tmp/**, ./dist/**, ./docs/**, ./packages/**' ],
[ '-s, --skip-config', 'Skip updating the version of the package.json or composer.json file.' ],
],
action: ( { increment, preid, exclude, force, skipConfig, replacements, extraReplacements } ) => {
const version = force ? force : getNextVersion( getCurrentVersion(), increment, preid );
if ( ! semver.valid( version ) ) {
logResult( `The supplied version string ${ chalk.bold( version ) } is invalid.`, 'error' );
process.exit( 1 );
}
const isPrerelease = semver.prerelease( version )?.length ? true : false;
// Add extraReplacements.
replacements = [ ...replacements, ...extraReplacements ];
const res = [];
if ( ! skipConfig ) {
const configUpdate = updateConfig( version );
if ( configUpdate ) {
configUpdate.forEach( ( configRes ) => res.push( configRes ) );
}
}
logResult( `Updating project files to version ${ chalk.bold( version ) }.` );
for ( let i = 0; i < replacements.length; i++ ) {
if ( replacements[ i ].length < 3 ) {
replacements[ i ].push( 'g' );
}
const [ glob, regex, flags, forPreleases ] = replacements[ i ];
if ( isPrerelease && ! forPreleases ) {
continue;
}
updateVersions( glob, regex, flags, exclude, version )
.filter( ( { hasChanged } ) => hasChanged )
.forEach( ( update ) => {
res.push( {
File: chalk.green( update.file ),
Matches: chalk.yellow( update.numMatches ),
Replacements: chalk.yellow( update.numReplacements ),
} );
}
);
}
if ( ! res.length ) {
logResult( 'No updates made.', 'warning' );
} else {
logResult( 'Version update completed.', 'success' );
console.log(
columnify(
res,
{
headingTransform: ( heading ) => chalk.bold.underline( heading ),
},
)
);
}
},
};
================================================
FILE: packages/dev/src/index.js
================================================
#!/usr/bin/env node
const { argv } = process,
{ readFileSync, readdirSync, lstatSync } = require( 'fs' ),
path = require( 'path' ),
{ Command } = require( 'commander' ),
program = new Command(),
pkg = JSON.parse( readFileSync( path.join( __dirname, '../package.json' ), 'utf8' ) ),
{ getDefault } = require( './utils' );
// Setup the CLI program.
program
.description( pkg.description )
.version( pkg.version )
.addHelpCommand( 'help [command]', 'Display help for command.' );
/**
* Read the contents of the specified directory, registering all as subcommands of the specified parent command.
*
* @since 0.0.1
*
* @param {Command} parent Parent command instance.
* @param {string} dir Path to the directory where the command modules should be loaded from.
* @param {Array[]} optionsParent Array of options shared from the parent to all subcommands.
* @return {void}
*/
function registerCommands( parent, dir, optionsParent = [] ) {
readdirSync( dir )
// Exclude index files, they're picked up automatically so we don't want to double register them.
.filter( ( file ) => 'index.js' !== file )
.forEach( ( file ) => {
const filePath = path.join( dir, file );
// Register the command.
registerCommand( parent, filePath, optionsParent );
} );
}
/**
* Register a command with the specified parent.
*
* @since 0.0.1
*
* @param {Command} parent Parent command instance.
* @param {string} filePath Path to the directory where the command modules should be loaded from.
* @param {Array[]} optionsParent Array of options shared from the parent to all subcommands.
* @return {void}
*/
function registerCommand( parent, filePath, optionsParent = [] ) {
const {
command,
description,
action,
args = [],
options = [],
optionsShared = [],
help = [],
} = require( filePath );
const cmd = parent
.command( command )
.description( description );
if ( action ) {
cmd.action( action );
}
args.forEach( ( cmdArgs ) => cmd.argument( ...cmdArgs ) );
[ ...options, ...optionsParent, ...optionsShared ].forEach( ( opts ) => {
// Attempts to parse default values from the config file.
opts[ 2 ] = getDefault( parent._name ? parent._name + '.' + command : command, opts[ 0 ], opts[ 2 ] );
cmd.option( ...opts );
} );
help.forEach( ( helpText ) => cmd.addHelpText( ...helpText ) );
// If it's a directory, recursively register files in the directory.
if ( lstatSync( filePath ).isDirectory() ) {
registerCommands( cmd, filePath, optionsShared );
cmd.addHelpCommand( 'help [command]', 'Display help for command.' );
}
}
// Register all commands.
registerCommands( program, path.join( __dirname, 'cmds' ) );
// Parse incoming arguments.
program.parse( argv );
================================================
FILE: packages/dev/src/utils/changelog-entry.js
================================================
/**
* A changelog entry object.
*
* @typedef {Object} ChangelogEntry
* @property {string} title Title of the changelog entry. Used as the filename (excluding the extension) for the changelog file.
* @property {string} significance Entry significance.
* @property {string} type Entry type.
* @property {string} comment Internal-use comment accompanying the entry.
* @property {string[]} links List of GitHub issues linked to the entry.
* @property {string[]} attributions List of individuals attributed to the entry.
* @property {string} entry The content of the changelog entry.
*/
module.exports = {
title: '',
significance: '',
type: '',
comment: '',
links: [],
attributions: [],
entry: '',
};
================================================
FILE: packages/dev/src/utils/configs.js
================================================
const { existsSync } = require( 'fs' );
/**
* Retrieve a JS object for the specified JSON config file.
*
* Returns an empty object if the config file can't be found.
*
* @since 0.0.1
*
* @param {string} filename The JSON config filename, eg "composer" or "package".
* @return {Object} The config file as a JS object.
*/
function getConfig( filename ) {
const path = `${ process.cwd() }/${ filename }.json`;
if ( existsSync( path ) ) {
return require( path );
}
return {};
}
/**
* Determines if the specified JSON config file exists.
*
* @since 0.0.1
*
* @param {string} filename The JSON config file name, eg "composer" or "package".
* @return {boolean} Returns true if the config file exists, otherwise false.
*/
function hasConfig( filename ) {
return Object.keys( getConfig( filename ) ).length >= 1;
}
module.exports = {
getConfig,
hasConfig,
};
================================================
FILE: packages/dev/src/utils/create-dist-file.js
================================================
const
{ existsSync } = require( 'fs' ),
getArchiveFilename = require( './get-archive-filename' ),
{ getConfig } = require( './configs' ),
getProjectSlug = require( './get-project-slug' ),
execSync = require( './exec-sync' );
/**
* Determine if the project has composer production dependencies warranting a `composer install` during builds.
*
* @since 0.0.1
*
* @return {boolean} Whether or not a composer install is required.
*/
function requiresComposerInstall() {
const
pkg = getConfig( 'composer' ),
keys = pkg.require ? Object.keys( pkg.require ) : [],
autoload = pkg.autoload ? Object.keys( pkg.autoload ) : [];
// If we have autoloading enabled we need to build for production.
if ( 0 !== autoload.length ) {
return true;
}
// Not defined or empty.
if ( 0 === keys.length ) {
return false;
}
// Has only a php (platform) requirement.
if ( 1 === keys.length && 'php' === keys[ 0 ] ) {
return false;
}
return true;
}
/**
* Create dist file.
*
* @since 0.0.1
* @since 0.2.1 Windows compatibility: account for spaces in file paths.
*
* @return {string}
*/
module.exports = ( distDir, silent, log = () => {} ) => {
const name = getArchiveFilename(),
slug = getProjectSlug(),
composer = requiresComposerInstall(),
cwd = distDir;
// If we have composer dependencies, reinstall with no dev requirements or scripts.
if ( composer ) {
log( 'Installing composer production dependencies...' );
execSync( `composer install --no-dev --no-scripts`, silent );
}
// Empty inspected directories in the distribution directory (if any are leftover from the last run of the command).
if ( existsSync( distDir ) ) {
execSync( `rm -rf ${ slug }`, silent, { cwd } );
}
// Create the initial archive using composer.
execSync( `composer archive --format=zip --dir="${ distDir }" --file=${ name.replace( '.zip', '' ) }`, true );
// Unzip the initial archive into a subdirectory matching the project's slug.
execSync( `unzip ${ name } -d ${ slug }`, silent, { cwd } );
// Remove the original zip file.
execSync( `rm ${ name }`, true, { cwd } );
// Zip up the subdirectory.
execSync( `zip -r ${ name } ${ slug }/`, silent, { cwd } );
// Remove the subdirectory.
execSync( `rm -rf ${ slug }/`, silent, { cwd } );
// If we have composer dependencies, reinstall with dev requirements when we're done.
if ( composer ) {
log( 'Reinstalling all composer dependencies...' );
execSync( `composer install`, silent );
}
return name;
};
================================================
FILE: packages/dev/src/utils/determine-version-increment.js
================================================
const
semver = require( 'semver' ),
getChangelogEntries = require( './get-changelog-entries' );
/**
* Determine a version increment level.
*
* Uses existing changelog entries, the current version, and the requested preid to determine the increment to
* be made.
*
* Finds the highest significance changelog entry and uses that significance for the increment.
*
* When a preid is passed and the current version is a prerelease, significance will be disregarded and "prerelease"
* will be used for the increment.
*
* @since 0.0.1
* @since 0.0.2 Added currentVersion and preid parameters.
* Add `pre` prefix when a `preid` is specified.
* Return `prerelease` when a `preid` is specified and `currentVersion` is already a prerelease.
*
* @param {string} dir Path to the directory where changelog entries are stored.
* @param {string} currentVersion Current project version.
* @param {?string} preid Preid identifier, eg "alpha", "beta", etc... And `null` when not requesting a prerelease.
* @return {string} A version increment string.
*/
module.exports = ( dir, currentVersion, preid = null ) => {
if ( preid && null !== semver.prerelease( currentVersion ) ) {
return 'prerelease';
}
const
logs = Array.from( new Set( getChangelogEntries( dir ).map( ( { significance } ) => significance ) ) ),
increment = [ 'major', 'minor', 'patch' ].find( ( level ) => logs.includes( level ) ) || 'patch';
return preid ? `pre${ increment }` : increment;
};
================================================
FILE: packages/dev/src/utils/exec-sync.js
================================================
const { execSync } = require( 'child_process' );
/**
* Execute a command in a child process.
*
* This is a wrapper for node's child_process.execSync() with some
* quality of life improvements to reduce the necessity of specifying
* an options object to silence output.
*
* @since 0.0.1
*
* @param {string} cmd Command to execute.
* @param {boolean} quiet If true, silences stdio output.
* @param {Object} opts Additional options object passed to `execSync()`.
* @return {string} The stdout from the command.
*/
module.exports = ( cmd, quiet = false, opts = {} ) => {
const stdio = quiet ? 'pipe' : 'inherit',
stdout = execSync( cmd, { stdio, ...opts } );
return quiet ? stdout.toString().trim() : '';
};
================================================
FILE: packages/dev/src/utils/get-archive-filename.js
================================================
const getCurrentVersion = require( './get-current-version' ),
getProjectSlug = require( './get-project-slug' );
/**
* Retrieve the filename of the project's archive/distribution zip file.
*
* @since 0.0.1
*
* @param {?string} version The version number. If not supplied uses the current version.
* @return {string} The archive filename.
*/
module.exports = ( version = null ) => {
version = version ? version : getCurrentVersion();
return `${ getProjectSlug() }-${ version }.zip`;
};
================================================
FILE: packages/dev/src/utils/get-changelog-entries.js
================================================
const ChangelogEntry = require( './changelog-entry' ),
{ readdirSync, readFileSync, existsSync } = require( 'fs' ),
path = require( 'path' ),
YAML = require( 'yaml' );
/**
* Retrieve all changelog entry files from the specified directory.
*
* This will attempt to parse all .y[a]ml files found in the specified directory.
*
* @since 0.0.1
*
* @param {string} dir Path to the directory.
* @return {ChangelogEntry[]} Array of changelog entry objects.
*/
module.exports = ( dir ) => {
const res = [];
if ( ! existsSync( dir ) ) {
return res;
}
readdirSync( dir ).forEach( ( file ) => {
// Only parse valid changelog files.
if ( ! file.includes( '.yml' ) && ! file.includes( '.yaml' ) ) {
return;
}
const log = YAML.parse( readFileSync( path.join( dir, file ), 'utf8' ) ),
{ comment = '', links = '', attributions = '' } = log;
delete log.links;
delete log.comment;
delete log.attributions;
res.push( {
title: path.parse( file ).name,
...log,
comment,
links,
attributions,
} );
} );
return res;
};
================================================
FILE: packages/dev/src/utils/get-changelog-for-version.js
================================================
const parseChangelogFile = require( './parse-changelog-file' );
/**
* Retrieve a changelog for the given version.
*
* @since 0.0.1
*
* @param {string} ver A semver string for the version to retrieve.
* @param {string} file Changelog file path.
* @return {Object|undefined} Returns the changelog version entry object or undefined if not found.
*/
module.exports = ( ver, file ) => {
return parseChangelogFile( file ).find( ( { version } ) => ver === version );
};
================================================
FILE: packages/dev/src/utils/get-changelog-options.js
================================================
module.exports = () => {
return {
significance: {
major: 'Backwards incompatible or breaking changes',
minor: 'New features or backwards-compatible deprecations',
patch: 'Backwards-compatible bug fixes',
},
type: {
added: 'New features',
changed: 'Updates to existing features',
fixed: 'Any bug fixes',
deprecated: 'Features to be removed',
removed: 'Features that are being removed',
dev: 'Developer-related notes or changes',
performance: 'Performance improvements or fixes',
security: 'Changes related to security vulnerabilities',
},
};
};
================================================
FILE: packages/dev/src/utils/get-current-version.js
================================================
const { getConfig } = require( './configs' );
/**
* Retrieve the current version number of the project
*
* @since 0.0.1
*
* @return {string} A semver string or an empty string if no version could be parsed.
*/
module.exports = () => {
const npm = getConfig( 'package' );
if ( npm.version ) {
return npm.version;
}
const composer = getConfig( 'composer' );
if ( composer?.extra?.llms?.version ) {
return composer.extra.llms.version;
}
return '';
};
================================================
FILE: packages/dev/src/utils/get-default.js
================================================
const
path = require( 'path' ),
parseYaml = require( 'yaml' ).parse,
{ existsSync, readFileSync } = require( 'fs' );
/**
* Find the config file.
*
* Looks in the project's root directory for .llmsdev.yml or .llmsdev.yaml.
*
* @since 0.0.1
*
* @return {string} Returns the full path to the config file or an empty string if none can be found.
*/
function getConfigFilePath() {
const basePath = path.join( process.cwd(), '.llmsdev' );
let configFilePath = '';
[ '.yml', '.yaml' ].some( ( ext ) => {
const testPath = basePath + ext;
if ( existsSync( testPath ) ) {
configFilePath = testPath;
return true;
}
return false;
} );
return configFilePath;
}
/**
* Load the gloabl config file.
*
* @since 0.0.1
*
* @return {Object} Returns the parsed config file as a JS object or an empty object if none found.
*/
function loadConfigFile() {
const filePath = getConfigFilePath();
if ( ! filePath ) {
return {};
}
return parseYaml( readFileSync( filePath, 'utf8' ) );
}
/**
* Get a default value for a given command and option.
*
* @since
*
* @param {string} command Name of the command. When accessing subcommands the command name will be "parent.subcommand".
* @param {string} setting The option value, eg: "-v --verbose" or "-m --mode <mode>".
* This string will be parsed and use the value following the two hyphens.
* Using the examples the value from the config would accept the value of "verbose" or "mode".
* @param {any} defaultValue The default value as specified in the command options.
* @return {any} The default value of the option.
*/
module.exports = ( command, setting, defaultValue = undefined ) => {
setting = setting.split( ' ' )[ 1 ].replace( '--', '' );
const config = loadConfigFile();
if (
! config ||
0 === Object.keys( config ) ||
undefined === config[ command ] ||
undefined === config[ command ][ setting ] ) {
return defaultValue;
}
return config[ command ][ setting ];
};
================================================
FILE: packages/dev/src/utils/get-next-version.js
================================================
const semver = require( 'semver' );
/**
* Determine the next version for a release given the current version and an increment level + preid.
*
* This function is a wrapper around `semver.inc()` with some modifications:
* + If a `preid` is provided, `pre` will automatically be added to `increment` (unless it's already been added).
* + When creating the first prerelease, eg 1.0.0 -> 2.0.0-beta.1, this function skips beta.0 and makes beta.1.
*
* @since 0.0.1
* @since 0.0.2 Only add "pre" to the increment if it is already added.
*
* @param {string} version Version to increment.
* @param {string} increment Increment level: major, premajor, minor, preminor, patch, prepatch, or prerelease.
* @param {string} preid Prerelease identifier when using `pre*` increment levels. EG: "alpha", "beta", "rc".
* @return {string} The incremented string.
*/
module.exports = ( version, increment, preid = null ) => {
increment = preid && ! increment.startsWith( 'pre' ) ? `pre${ increment }` : increment;
// When incrementing a prerelease we want to skip versions like "-beta.0" and go right to "-beta.1".
if ( increment.includes( 'pre' ) ) {
const prever = semver.inc( version, increment, preid );
if ( 0 === semver.prerelease( prever ).reverse()[ 0 ] ) {
version = prever;
increment = 'prerelease';
}
}
return semver.inc( version, increment, preid );
};
================================================
FILE: packages/dev/src/utils/get-project-privacy.js
================================================
const
getProjectSlug = require( './get-project-slug' ),
execSync = require( './exec-sync' );
/**
* Get the project's repo privacy status.
*
* Uses the GitHub CLI client (gh) to lookup the project's status via the GitHub api. If the API
* encounters errors (like a 404 or an authentication error) it will fail silently and result
* in an "unknown" response.
*
* @since 0.0.2
*
* @return {string} Returns 'public' or 'private'. If the repo cannot be found, returns 'unknown'.
*/
function getProjectPrivacy() {
let status = 'unknown';
try {
const res = JSON.parse( execSync( `gh api repos/gocodebox/${ getProjectSlug() }`, true ) );
status = res.private ? 'private' : 'public';
} catch ( e ) {}
return status;
}
/**
* Determine if the project is private.
*
* @since 0.0.2
*
* @return {boolean | undefined} Returns `true` for private repos, `false` for public repos, and `undefined` for unknown repos.
*/
function isProjectPrivate() {
const privacy = getProjectPrivacy();
if ( 'unknown' === privacy ) {
return undefined;
}
return 'private' === privacy;
}
/**
* Determine if the project is private.
*
* @since 0.0.2
*
* @return {boolean | undefined} Returns `false` for private repos, `true` for public repos, and `undefined` for unknown repos.
*/
function isProjectPublic() {
const privacy = getProjectPrivacy();
if ( 'unknown' === privacy ) {
return undefined;
}
return 'public' === privacy;
}
module.exports = {
isProjectPrivate,
isProjectPublic,
getProjectPrivacy,
};
================================================
FILE: packages/dev/src/utils/get-project-slug.js
================================================
const { basename } = require( 'path' );
/**
* Retrieve the package's "slug".
*
* This will always be equal to the directory name.
*
* For example "lifterlms" or "lifterlms-integration-woocommerce".
*
* @since 0.0.1
*
* @return {string} The project's slug.
*/
module.exports = () => {
return basename( process.cwd() );
};
================================================
FILE: packages/dev/src/utils/index.js
================================================
const
ChangelogEntry = require( './changelog-entry' ),
createDistFile = require( './create-dist-file' ),
determineVersionIncrement = require( './determine-version-increment' ),
execSync = require( './exec-sync' ),
getArchiveFilename = require( './get-archive-filename' ),
getChangelogEntries = require( './get-changelog-entries' ),
getChangelogForVersion = require( './get-changelog-for-version' ),
getChangelogOptions = require( './get-changelog-options' ),
getCurrentVersion = require( './get-current-version' ),
getDefault = require( './get-default' ),
getNextVersion = require( './get-next-version' ),
{ isProjectPrivate, isProjectPublic, getProjectPrivacy } = require( './get-project-privacy' ),
getProjectSlug = require( './get-project-slug' ),
{ getConfig, hasConfig } = require( './configs' ),
{ getFileLink, getRepoLink, getIssueLink } = require( './repo-links' ),
logResult = require( './log-result' ),
parseChangelogFile = require( './parse-changelog-file' ),
parseIssueString = require( './parse-issue-string' ),
parseMainFileMetadata = require( './pare-main-file-metadata' ),
pushDistFile = require( './push-dist-file' ),
{ isAttributionValid, isEntryValid, isLinkValid, getChangelogValidationIssues } = require( './validate-changelog' );
module.exports = {
ChangelogEntry,
createDistFile,
determineVersionIncrement,
execSync,
getArchiveFilename,
getChangelogEntries,
getChangelogForVersion,
getChangelogOptions,
getConfig,
getCurrentVersion,
getDefault,
getFileLink,
getIssueLink,
getNextVersion,
getProjectSlug,
getRepoLink,
isProjectPrivate,
isProjectPublic,
getProjectPrivacy,
hasConfig,
logResult,
isAttributionValid,
isEntryValid,
isLinkValid,
getChangelogValidationIssues,
parseChangelogFile,
parseIssueString,
parseMainFileMetadata,
pushDistFile,
};
================================================
FILE: packages/dev/src/utils/log-result.js
================================================
const chalk = require( 'chalk' );
/**
* Log a result to the console
*
* @since 0.0.1
*
* @param {string} msg Message to log.
* @param {string} type Message type. Accepts success, warning, error, or info.
* @return {void}
*/
module.exports = ( msg, type = 'info' ) => {
msg = chalk.bold( type.charAt( 0 ).toUpperCase() + type.slice( 1 ) ) + ': ' + msg;
switch ( type ) {
case 'success':
msg = chalk.green( msg );
break;
case 'warning':
msg = chalk.yellow( msg );
break;
case 'error':
msg = chalk.red( msg );
break;
case 'info':
msg = chalk.blue( msg );
break;
}
console.log( msg );
};
================================================
FILE: packages/dev/src/utils/pare-main-file-metadata.js
================================================
const { readFileSync } = require( 'fs' );
/**
* Parses WordPress project metadata from a file header comment.
*
* @since 0.1.0
*
* @return {Object} A key/value object containing the metadata found within the file.
*/
module.exports = ( file ) => {
const contents = readFileSync( file ).toString(),
regex = new RegExp( / \* (?<key>[A-Z][A-Za-z ]+)\: (?<val>.*)\n/g, 'g' );
let matches, metas = {};
while ( matches = regex.exec( contents ) ) {
metas[ matches.groups.key ] = matches.groups.val;
}
return metas;
}
================================================
FILE: packages/dev/src/utils/parse-changelog-file.js
================================================
const { readFileSync } = require( 'fs' );
/**
* Retrieve an entry object stub with the given date and version.
*
* @since 0.0.1
*
* @param {string} date Release date in `YYYY-MM-DD` format.
* @param {string} version A semver string.
* @return {Object} Entry object.
*/
function getEntryObject( date, version ) {
return {
date,
version,
logs: [],
};
}
/**
* Convert an entry item list into a string, preserving newlines within the list but stripping them from the start and end.
*
* @since 0.0.1
*
* @param {string[]} entry Array of lines.
* @return {string} Joined entry string.
*/
function finalizeEntry( entry ) {
// Trim newlines from the beginning of the entry list.
if ( ! entry.logs[ 0 ] ) {
entry.logs.splice( 0, 1 );
}
// Trim trailing nnewlines from the end of the entry list.
while ( ! entry.logs[ entry.logs.length - 1 ] ) {
entry.logs.splice( entry.logs.length - 1, 1 );
}
// Join them all together with a new line.
entry.logs = entry.logs.join( '\n' );
return entry;
}
/**
* Convert a changelog file to a JSON object
*
* @since 0.0.1
*
* @param {string} file Path to the changelog MD file.
* @return {Object[]} Changelog as an array of JSON objects.
*/
module.exports = ( file ) => {
const changelog = readFileSync( file, 'utf8' ),
lines = changelog.split( '\n' ),
logs = [],
regex = /v(?<version>[0-9]\d*\.[0-9]\d*\.[0-9]\d*(?:-(?:[0-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:[0-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*)?(?:\+[0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*)?) - (?<date>\d{4}\-\d{2}\-\d{2})/;
// Remove title, title underline, and first blank line.
lines.splice( 0, 3 );
let currEntry = {};
lines.forEach( ( line ) => {
if ( line.startsWith( '====' ) || line.startsWith( '----' ) ) {
return;
}
const parsed = regex.exec( line );
// This is a header line.
if ( parsed ) {
// Before we start processing the next log item, finalize what we've compiled from the previous.
if ( currEntry.logs && currEntry.logs.length ) {
logs.push( finalizeEntry( currEntry ) );
}
currEntry = getEntryObject( parsed.groups.date, parsed.groups.version );
} else {
currEntry.logs.push( line );
}
} );
// The final entry in the changelog won't get caught by the next parsed date so we'll finalize that entry here at the end.
logs.push( finalizeEntry( currEntry ) );
return logs;
};
================================================
FILE: packages/dev/src/utils/parse-issue-string.js
================================================
const getProjectSlug = require( './get-project-slug' );
/**
* A GitHub-style issue reference object.
*
* @typedef {Object} GitHubIssueRef
* @property {string} org The GitHub organization slug, eg "gocodebox".
* @property {string} repo The GitHub repo slug, eg "lifterlms".
* @property {string} num The issue number, eg "1234".
*/
/**
* Parses a GitHub-style issue reference string into it's parts.
*
* @since 0.1.0
*
* @param {string} issue A GitHub-style issue reference string. Formatted as either "#123" or "organization/repository#123".
* @return {GitHubIssueRef} An issue object.
*/
module.exports = ( issue ) => {
let org = 'gocodebox',
repo = getProjectSlug(),
num = '';
// Is an external reference.
if ( issue.includes( '/' ) ) {
const split = issue.split( '/' );
org = split[ 0 ];
[ repo, num ] = split[ 1 ].split( '#' );
} else {
num = issue.slice( 1 );
}
return { org, repo, num };
};
================================================
FILE: packages/dev/src/utils/push-dist-file.js
================================================
// Deps.
const
fs = require( 'fs' ),
execSync = require( './exec-sync' ),
getProjectSlug = require( './get-project-slug' );
/**
* Commit and push a specified zip file to a git branch.
*
* This is used, primarily, to publish the distribution archive of a project
* to the "release" branch which is used to create and publish installable releases.
*
* @since 0.0.1
* @since 0.0.2 OSX compatibility: don't use `xargs -d`.
* @since 0.2.1 Windows compatibility:
* - account for spaces in file paths
* - use node fs utility to create a directory in place of `mkdir` to
* override Windows' restrictions.
*
* @param {string} distFile Distribution file used as the source of the commit.
* @param {string} branch Branch to commit and push to.
* @param {string} message Commit message.
* @param {boolean} silent Whether or not to output child process stdout.
* @return {void}
*/
module.exports = ( distFile, branch, message, silent = true ) => {
const slug = getProjectSlug();
if ( ! fs.existsSync( process.cwd() + '/tmp' ) ) {
fs.mkdirSync( process.cwd() + '/tmp', true );
};
const
cwd = process.cwd() + '/tmp/git',
url = execSync( 'git config --get remote.origin.url', true );
// Clone the repo into a temp directory.
execSync( `git clone ${ url } "${ cwd }"`, silent );
// Checkout to the publication branch.
execSync( `git checkout -b ${ branch }`, silent, { cwd } );
// Empty everything except the git directory.
execSync( `mv .git ../ && cd ../ && rm -rf ./git && mkdir git && mv .git ./git && cd git`, silent, { cwd } );
// Extract the distribution file.
execSync( `unzip "${ distFile }" -d ./tmp/git/`, silent );
// Move all the contents into the publication branch.
execSync( `mv ./${ slug }/* ./ && rm -rf ${ slug }/`, silent, { cwd } );
// Add all files.
execSync( `git add -A`, silent, { cwd } );
// Commit.
execSync( `git commit --allow-empty -m "${ message }"`, silent, { cwd } );
// Force push.
execSync( `git push origin ${ branch } -f`, silent, { cwd } );
// Remove temp repo dir.
execSync( `rm -rf ./tmp/git`, silent );
};
================================================
FILE: packages/dev/src/utils/repo-links.js
================================================
const getProjectSlug = require( './get-project-slug' ),
parseIssueString = require( './parse-issue-string' );
/**
* Retrieves a link to the specified file on the project's GitHub repository.
*
* @since 0.1.0
*
* @param {string} path Path to the file (relative to the root directory), eg: "includes/file.php" or "main.php".
* @param {string} branch Branch or version number. Defaults to "trunk".
* @return {string} The full URL to a file on the project's GitHub repository.
*/
function getFileLink( path, branch = 'trunk' ) {
return `${ getRepoLink() }/blob/${ branch }/${ path }`;
}
/**
* Retrieves a link to the specified issue on the project's GitHub repository.
*
* @since 0.1.0
*
* @param {string} issue A GitHub-style issue reference string. Formatted as either "#123" or "organization/repository#123".
* @return {string} The full URL to the specified issue.
*/
function getIssueLink( issue ) {
const { org, repo, num } = parseIssueString( issue );
return `${ getRepoLink( repo, org ) }/issues/${ num }`;
}
/**
* Retrieves the base link to a project's GitHub repository.
*
* @since 0.1.0
*
* @param {string} project The project slug.
* @param {string} org The project organization.
* @return {string} The full URL to the current project's GitHub repository.
*/
function getRepoLink( project, org ) {
project = project || getProjectSlug();
org = org || 'gocodebox';
return `https://github.com/${ org }/${ project }`;
}
module.exports = {
getFileLink,
getIssueLink,
getRepoLink,
};
================================================
FILE: packages/dev/src/utils/validate-changelog.js
================================================
require( 'url' );
const
ChangelogEntry = require( './changelog-entry' ),
chalk = require( 'chalk' ),
getChangelogOptions = require( './get-changelog-options' );
/**
* Highlights text depending on the formatting request
*
* When formatting is disabled, the text is wrapped in quotes.
*
* When formatting is enabled, the text will be quoted and emboldened.
*
* @since 0.0.1
*
* @param {string} text The text to highlight.
* @param {boolean} formatting Whether or not rich formatting should be used.
* @return {string} The highlighted text.
*/
function highlight( text, formatting = true ) {
text = formatting ? chalk.bold( text ) : text;
return `"${ text }"`;
}
/**
* Determines if an attribution string is valid.
*
* Attributions are valid in the following formats:
* + GitHub username reference: @thomasplevy
* + Markdown link: [Jeffrey Lebowski](https://elduderino.geocites.com/)
*
* @since 0.0.1
*
* @param {string} attr User-submitted attribution string.
* @return {boolean} Returns `true` if the attribution string is valid, otherwise `false`.
*/
function isAttributionValid( attr ) {
attr = attr.toString();
const firstChar = attr.charAt( 0 );
// GitHub username.
if ( '@' === firstChar ) {
return true;
}
const
match = attr.match( /\[[^\]]*\]\(([^)]*)\)*/ );
if ( ! match ) {
return false;
}
try {
new URL( match[ 1 ] );
return true;
} catch ( e ) {}
return false;
}
/**
* Determine if a supplied link is valid
*
* Links are valid in the following formats:
* + GitHub issue reference in the current repo: #12345
* + GitHub issue reference to another repo: organization/repository#12345
*
* @since 0.0.1
*
* @param {string} link User-submitted link string.
* @return {boolean} Returns `true` if the link is valid and false otherwise.
*/
function isLinkValid( link ) {
// Force values to a string.
link = link.toString();
const isValidHash = ( hash ) => ! isNaN( parseInt( hash.slice( 1 ) ) );
let valid = false;
// Valid hash string, eg "#123".
if ( '#' === link.charAt( '0' ) ) {
valid = isValidHash( link );
} else {
// Valid reference to another repo, eg: "org/repo#123".
const split = link.split( '/' );
if ( 2 !== split.length ) {
valid = false;
} else {
valid = split[ 1 ].includes( '#' ) && isValidHash( '#' + split[ 1 ].split( '#' )[ 1 ] );
}
}
return valid;
}
/**
* Determine if the supplied entry is valid.
*
* A valid entry can be single or multiple lines.
*
* A single-line must:
* + Begin with a capital letter (the bullet character should be omitted).
* + End with a full stop: period, question mark, or exclamation point.
*
* A multi-line:
* + Each line must start with a plus sign bullet character: `+`.
* + A single space must follow the bullet.
* + The remaining portion of each line follows the same rules as a single-line entry.
* + Additionally, a line may end in a colon.
*
* @since 0.0.1
*
* @param {string} entry The changelog entry string.
* @return {boolean} Returns `true` if the entry is valid and `false` otherwise.
*/
function isEntryValid( entry ) {
const singleLineRegex = /^[A-Z].*[.!?]$/,
multiLineRegex = /^( )?[+] [A-Z].*[:.!?]$/;
const test = ( line, regex ) => null !== line.match( regex );
if ( entry.includes( '\n' ) ) {
return entry.split( '\n' ).filter( ( line ) => line ).every( ( line ) => test( line, multiLineRegex ) );
}
return test( entry, singleLineRegex );
}
/**
* Object describing changelog validation issues found with a specified ChangelogEntry.
*
* @typedef {Object} ChangelogValidationIssues
* @property {boolean} valid Whether or not validation errors were found.
* @property {string[]} errors Array of validation error messages.
* @property {string[]} warnings Array of validation warning messages.
*/
/**
* Retrieve a list of changelog validation issues.
*
* @since 0.0.1
*
* @param {ChangelogEntry} logEntry The changelog entry object to validate.
* @param {boolean} formatting Whether or not messages should include formatting (colors and bold).
* @return {ChangelogValidationIssues} Encountered validation issues
*/
function getChangelogValidationIssues( logEntry, formatting = true ) {
const options = getChangelogOptions(),
errors = [],
warnings = [];
// Check required fields.
[ 'significance', 'type', 'entry' ].forEach( ( key ) => {
if ( ! logEntry[ key ] ) {
errors.push( `Missing required field: ${ highlight( key, formatting ) }.` );
}
} );
// Validate the entry.
if ( logEntry.entry && ! isEntryValid( logEntry.entry ) ) {
errors.push( `The submitted entry text did not pass validation.` );
}
// Validate enum values.
[ 'significance', 'type' ].forEach( ( key ) => {
if ( logEntry[ key ] && ! Object.keys( options[ key ] ).includes( logEntry[ key ] ) ) {
errors.push( `Invalid value ${ highlight( logEntry[ key ], formatting ) } supplied for field: ${ highlight( key, formatting ) }.` );
}
} );
// Warn when encountering extra/non-standard keys.
Object.keys( logEntry )
// Expected keys.
.filter( ( k ) => ! Object.keys( ChangelogEntry ).includes( k ) )
.forEach( ( key ) => {
warnings.push( `Unexpected key: ${ highlight( key, formatting ) }.` );
} );
// Ensure array fields are arrays.
[ 'links', 'attributions' ].forEach( ( key ) => {
if ( logEntry[ key ] && ! Array.isArray( logEntry[ key ] ) ) {
errors.push( `The ${ highlight( key, formatting ) } field must be an array.` );
}
} );
// Validate all links.
if ( Array.isArray( logEntry.links ) ) {
logEntry.links.forEach( ( link ) => {
if ( ! isLinkValid( link ) ) {
errors.push( `The link ${ highlight( link, formatting ) } is invalid.` );
}
} );
}
// Validate all attributions.
if ( Array.isArray( logEntry.attributions ) ) {
logEntry.attributions.forEach( ( attribution ) => {
if ( ! isAttributionValid( attribution ) ) {
errors.push( `The attribution ${ highlight( attribution, formatting ) } is invalid.` );
}
} );
}
return {
valid: 0 === errors.length,
errors,
warnings,
};
}
module.exports = {
isAttributionValid,
isEntryValid,
isLinkValid,
getChangelogValidationIssues,
};
================================================
FILE: packages/dev/test/utils/configs.test.js
================================================
const { getConfig, hasConfig } = require( '../../src/utils' );
describe( 'hasConfig', () => {
it( 'should return `true` if the project has the specified config file', () => {
expect( hasConfig( 'package' ) ).toBe( true );
expect( hasConfig( 'composer' ) ).toBe( true );
} );
it( 'should return `false` if the project does not have the config or the config is empty', () => {
expect( hasConfig( 'fake' ) ).toBe( false );
} );
} );
describe( 'getConfig', () => {
it( 'should return the config file as a JS object', () => {
const expectedPkg = require( '../../../../package.json' ),
expectedComposer = require( '../../../../composer.json' );
expect( getConfig( 'package' ) ).toStrictEqual( expectedPkg );
expect( getConfig( 'composer' ) ).toStrictEqual( expectedComposer );
} );
it( 'should return an empty object if the project does not have the specified config', () => {
expect( getConfig( 'fake' ) ).toStrictEqual( {} );
} );
} );
================================================
FILE: packages/dev/test/utils/determine-version-increment.test.js
================================================
jest.mock( '../../src/utils/get-changelog-entries' );
const getChangelogEntries = require( '../../src/utils/get-changelog-entries' ),
determineVersionIncrement = require( '../../src/utils/determine-version-increment' );
let mockedEntries;
/**
* Create mock entries for the return of getChangelogEntries().
*
* @since 0.0.2
*
* @param {string} significance Highest significance to add to the list.
* @return {Object[]} Array of partial log entry objects.
*/
function setupMockEntries( significance ) {
const entries = [];
for ( let i = 0; i <= 3; i++ ) {
entries.push( { significance: 'patch' } );
}
entries.push( { significance } );
// Shuffle entries.
return entries.slice().sort( () => Math.random() - 0.5 );
}
getChangelogEntries.mockImplementation( () => mockedEntries );
describe( 'determineVersionIncrement', () => {
it.each( [ 'major', 'minor', 'patch' ] )( 'Should return "%s" when it is the highest significance', ( significance ) => {
mockedEntries = setupMockEntries( significance );
expect( determineVersionIncrement( 'dir', '1.0.0' ) ).toBe( significance );
} );
it.each( [ 'major', 'minor', 'patch' ] )( 'Should return "pre%s" when it is the highest significance, a preid is specified, and the current version is not a prerelease', ( significance ) => {
mockedEntries = setupMockEntries( significance );
expect( determineVersionIncrement( 'dir', '1.0.0', 'beta' ) ).toBe( `pre${ significance }` );
} );
const testData = [
[ '1.0.0-beta.1', 'beta' ],
[ '1.3.0-rc.3', 'alpha' ],
[ '5.2.0-alpha.23', 'rc' ],
];
it.each( testData )( 'Should return "prerelease" for currentVersion=%s and preid=%s', ( currVersion, preid ) => {
expect( determineVersionIncrement( 'dir', currVersion, preid ) ).toBe( 'prerelease' );
} );
it( 'Should return "patch" when no entries can be found', () => {
mockedEntries = [];
expect( determineVersionIncrement( 'dir', '1.0.0' ) ).toBe( 'patch' );
} );
} );
================================================
FILE: packages/dev/test/utils/exec-sync.test.js
================================================
// eslint-disable-next-line camelcase
const childProcess = require( 'child_process' ),
{ execSync } = require( '../../src/utils' );
jest.mock( 'child_process' );
// Mock submitted command options.
let cmdOpts = {};
childProcess.execSync.mockImplementation( ( cmd, opts ) => cmdOpts = opts );
/**
* Test execSync utility.
*
* Note this test doesn't attempt to ensure the output is correct as it assumes
* that child_proccess.execSync() works as expected. This tests only our logic
* to ensure that we properly merge the options passed to execSync.
*/
describe( 'execSync', () => {
// Reset mocked options.
beforeEach( () => {
cmdOpts = {};
} );
it( 'should output command output by default', () => {
execSync( 'echo "HELLO"' );
expect( cmdOpts ).toStrictEqual( { stdio: 'inherit' } );
} );
it( 'should silence output', () => {
execSync( 'echo "HELLO"', true );
expect( cmdOpts ).toStrictEqual( { stdio: 'pipe' } );
} );
it( 'should add accept additional arguments', () => {
execSync( 'echo "HELLO"', true, { timeout: 1000 } );
expect( cmdOpts ).toStrictEqual( { stdio: 'pipe', timeout: 1000 } );
} );
} );
================================================
FILE: packages/dev/test/utils/get-archive-filename.test.js
================================================
const { getArchiveFilename } = require( '../../src/utils' );
describe( 'getArchiveFilename', () => {
it( 'should assume the current version when no version is specified', () => {
const { version } = require( '../../../../package.json' );
expect( getArchiveFilename() ).toBe( `lifterlms-${ version }.zip` );
} );
it( 'should add the specified version', () => {
expect( getArchiveFilename( '9.9.9' ) ).toBe( 'lifterlms-9.9.9.zip' );
} );
} );
================================================
FILE: packages/dev/test/utils/get-changelog-for-version.test.js
================================================
const { getChangelogForVersion } = require( '../../src/utils' );
describe( 'getChangelogForVersion', () => {
it.each( [ '5.4.0', '3.0.0', '1.0.1' ] )( 'should retrieve the changelog for the existing version %s', ( version ) => {
const entry = getChangelogForVersion( version, process.cwd() + '/CHANGELOG.md' );
expect( typeof entry ).toBe( 'object' );
expect( entry.version ).toStrictEqual( version );
expect( Object.keys( entry ) ).toStrictEqual( [ 'date', 'version', 'logs' ] );
} );
it( 'should return undefined for non-existent versions', () => {
const entry = getChangelogForVersion( '0.0.1', process.cwd() + '/CHANGELOG.md' );
expect( entry ).toBeUndefined();
} );
} );
================================================
FILE: packages/dev/test/utils/get-next-version.test.js
================================================
const
{ getNextVersion } = require( '../../src/utils' );
describe( 'getNextVersion', () => {
describe( 'increment=patch', () => {
const testData = [
[ '1.0.0', '1.0.1' ],
[ '5.1.2', '5.1.3' ],
[ '0.12.9', '0.12.10' ],
[ '1.0.0-beta.1', '1.0.0' ],
[ '999.9.9-rc.1', '999.9.9' ],
];
it.each( testData )( 'Should increment %s to %s', ( current, next ) => {
expect( getNextVersion( current, 'patch' ) ).toBe( next );
} );
} );
describe( 'increment=minor', () => {
const testData = [
[ '1.0.0', '1.1.0' ],
[ '5.3.9', '5.4.0' ],
[ '0.54.3', '0.55.0' ],
[ '1.0.0-beta.1', '1.0.0' ],
[ '999.9.9-rc.1', '999.10.0' ],
];
it.each( testData )( 'Should increment %s to %s', ( current, next ) => {
expect( getNextVersion( current, 'minor' ) ).toBe( next );
} );
} );
describe( 'increment=major', () => {
const testData = [
[ '1.0.0', '2.0.0' ],
[ '1.15.999', '2.0.0' ],
[ '5.3.9', '6.0.0' ],
[ '0.54.3', '1.0.0' ],
[ '1.0.0-beta.1', '1.0.0' ],
[ '999.9.9-rc.1', '1000.0.0' ],
];
it.each( testData )( 'Should increment %s to %s', ( current, next ) => {
expect( getNextVersion( current, 'major' ) ).toBe( next );
} );
} );
describe( 'increment=prerelease preid=beta', () => {
const testData = [
[ '1.0.0', '1.0.1-beta.1' ],
[ '1.0.0-beta.1', '1.0.0-beta.2' ],
[ '3.2.5', '3.2.6-beta.1' ],
];
it.each( testData )( 'Should increment %s to %s', ( current, next ) => {
expect( getNextVersion( current, 'prerelease', 'beta' ) ).toBe( next );
} );
} );
} );
================================================
FILE: packages/dev/test/utils/get-project-privacy.test.js
================================================
jest.mock( '../../src/utils/get-project-slug' );
// eslint-disable-next-line camelcase
const childProcess = require( 'child_process' ),
getProjectSlug = require( '../../src/utils/get-project-slug' ),
{ getProjectPrivacy, isProjectPublic, isProjectPrivate } = require( '../../src/utils/get-project-privacy' );
// Mocked return values.
let mockedSlug,
mockedApiReturn;
jest.mock( 'child_process' );
childProcess.execSync.mockImplementation( () => mockedApiReturn );
getProjectSlug.mockImplementation( () => mockedSlug );
/**
* Mock the API return retrieved by `gh api...`.
*
* @since 0.1.0
*
* @param {boolean} isPublic Whether or not the repo is public. Pass `undefined` to for an "unknown" return.
* @return {string|Object} A JSON string or object to be parsed. Returning an object causes an error for the test unknown responses.
*/
function getMockApiReturn( isPublic ) {
if ( undefined === isPublic ) {
return {}; // Causes an error which is enough to get the proper return.
}
return JSON.stringify( { private: ! isPublic } );
}
describe( 'getProjectPrivacy', () => {
const testData = [
[ 'Should return "public" for public repos', 'lifterlms', 'public', true ],
[ 'Should return "private" for private repos', 'lifterlms-groups', 'private', false ],
[ 'Should return "unknown" for invalid repos', 'fake-repo', 'unknown', undefined ],
];
it.each( testData )( '%s', ( name, slug, expected, isPublic ) => {
mockedApiReturn = getMockApiReturn( isPublic );
mockedSlug = slug;
expect( getProjectPrivacy() ).toBe( expected );
} );
} );
describe( 'isProjectPublic', () => {
const testData = [
[ 'Should return true for public repos', 'lifterlms', true ],
[ 'Should return false for private repos', 'lifterlms-groups', false ],
[ 'Should return undefined for invalid repos', 'fake-repo', undefined ],
];
it.each( testData )( '%s', ( name, slug, expected ) => {
mockedApiReturn = getMockApiReturn( expected );
mockedSlug = slug;
expect( isProjectPublic() ).toBe( expected );
} );
} );
describe( 'isProjectPrivate', () => {
const testData = [
[ 'Should return false for public repos', 'lifterlms', false, true ],
[ 'Should return true for private repos', 'lifterlms-groups', true, false ],
[ 'Should return undefined for invalid repos', 'fake-repo', undefined, undefined ],
];
it.each( testData )( '%s', ( name, slug, expected, isPublic ) => {
mockedApiReturn = getMockApiReturn( isPublic );
mockedSlug = slug;
expect( isProjectPrivate() ).toBe( expected );
} );
} );
================================================
FILE: packages/dev/test/utils/get-project-slug.test.js
================================================
const { getProjectSlug } = require( '../../src/utils' );
describe( 'getProjectSlug', () => {
it( 'should return the directory name of the project', () => {
expect( getProjectSlug() ).toBe( 'lifterlms' );
} );
} );
================================================
FILE: packages/dev/test/utils/parse-changelog-file.test.js
================================================
const
semver = require( 'semver' ),
{ parseChangelogFile } = require( '../../src/utils' );
describe( 'parseChangelogFile', () => {
it( 'should parse the changelog file', () => {
const parsed = parseChangelogFile( process.cwd() + '/CHANGELOG.md' );
parsed.forEach( ( { date, version, logs } ) => {
// Valid version.
expect( semver.valid( version ) ).toStrictEqual( version );
// Valid date.
expect( Date.parse( date ) ).not.toBeNaN();
// Should be a string.
expect( typeof logs ).toStrictEqual( 'string' );
} );
} );
} );
================================================
FILE: packages/dev/test/utils/parse-issue-string.test.js
================================================
const { parseIssueString } = require( '../../src/utils' );
describe( 'parseIssueString', () => {
const testData = [
[ 'Should accept issue references to the current project', { org: 'gocodebox', repo: 'lifterlms', num: '123' }, '#123' ],
[ 'Should accept issue references to the current project', { org: 'org', repo: 'repo', num: '456' }, 'org/repo#456' ],
];
it.each( testData )( '%s', ( name, expected, issue ) => {
expect( parseIssueString( issue ) ).toStrictEqual( expected );
} );
} );
================================================
FILE: packages/dev/test/utils/repo-links.test.js
================================================
jest.mock( '../../src/utils/get-project-slug' );
const { getFileLink, getRepoLink, getIssueLink } = require( '../../src/utils' ),
getProjectSlug = require( '../../src/utils/get-project-slug' );
let mockedSlug = '';
getProjectSlug.mockImplementation( () => mockedSlug ? mockedSlug : 'lifterlms' );
describe( 'repoLinks', () => {
beforeEach( () => {
mockedSlug = 'lifterlms';
} );
describe( 'getFileLink', () => {
const path = 'inc/file.php',
testData = [
[ 'Should use trunk if a branch is not specified', 'https://github.com/gocodebox/lifterlms/blob/trunk/inc/file.php' ],
[ 'Should use the specified branch', 'https://github.com/gocodebox/lifterlms/blob/dev-123/inc/file.php', 'dev-123' ],
[ 'Should use the specified version tag', 'https://github.com/gocodebox/lifterlms/blob/1.0.0/inc/file.php', '1.0.0' ],
[ 'Should use the specified prerelease version tag', 'https://github.com/gocodebox/lifterlms/blob/1.0.0-beta.3/inc/file.php', '1.0.0-beta.3' ],
];
it.each( testData )( '%s', ( name, expected, branch = undefined ) => {
expect( getFileLink( path, branch ) ).toBe( expected );
} );
} );
describe( 'getIssueLink', () => {
const testData = [
[ 'Should accept issue references to the current project', 'https://github.com/gocodebox/lifterlms/issues/123', '#123' ],
[ 'Should accept issue references to the another project', 'https://github.com/org/repo/issues/456', 'org/repo#456' ],
];
it.each( testData )( '%s', ( name, expected, issue ) => {
expect( getIssueLink( issue ) ).toBe( expected );
} );
} );
describe( 'getRepoLink', () => {
const testData = [
[ 'Should use the default slug and organization when no values (undefined) are provided', 'https://github.com/gocodebox/lifterlms', undefined, undefined ],
[ 'Should use the default slug and organization when null values are provided', 'https://github.com/gocodebox/lifterlms', null, null ],
[ 'Should use the default slug and organization when empty values are provided', 'https://github.com/gocodebox/lifterlms', '', false ],
[ 'Should use the specified slug and organization when provided', 'https://github.com/org/slug', 'slug', 'org' ],
];
it.each( testData )( '%s', ( name, expected, project, org ) => {
mockedSlug = project;
expect( getRepoLink( project, org ) ).toBe( expected );
} );
} );
} );
================================================
FILE: packages/dev/test/utils/validate-changelog.test.js
================================================
const {
isAttributionValid,
isEntryValid,
isLinkValid,
getChangelogValidationIssues,
} = require( '../../src/utils' );
describe( 'isAttributionValid', () => {
const testData = [
// Valid data.
[ 'Should accept a GitHub username', '@username', true ],
[ 'Should accept a markdown link', '[username](https://fake.tld)', true ],
// Invalid data.
[ 'Should not accept a username without a leading @ symbol', 'username', false ],
[ 'Should not accept a markdown link without a fully qualified URL', '[username](www.fake.tld)', false ],
[ 'Should not accept a markdown reference link', '[username][link]', false ],
// Weird types.
[ 'Should not accept an integer', 123, false ],
[ 'Should not accept an object', {}, false ],
[ 'Should not accept an array', [], false ],
];
it.each( testData )( '%s', ( name, input, expected ) => {
expect( isAttributionValid( input ) ).toStrictEqual( expected );
} );
} );
describe( 'isEntryValid', () => {
describe( 'Single-line entries', () => {
const testData = [
// Valid.
[ 'Should accept any capital letter and full stop at the end: A -> period', 'A valid line.', true ],
[ 'Should accept any capital letter and full stop at the end: T -> period', 'This is also valid.', true ],
[ 'Should accept any capital letter and full stop at the end: Z -> question mark', 'Z This is also valid?', true ],
[ 'Should accept any capital letter and full stop at the end: P -> exclamation point', 'Plus this is too!', true ],
[ 'Contains multiple sentences', 'Are multiple sentences okay? Yes, This is okay.', true ],
// Invalid.
[ 'Should not start with a plus bullet character', '+ The bullet is added automatically so this is invalid.', false ],
[ 'Should not start with a minus bullet character', '- Other types of bullets are also invalid.', false ],
[ 'Should not start with a lowercase letter', 'must be capital letter.', false ],
[ 'Should not end without a full stop character', 'Must end in a fullstop', false ],
[ 'Should not start with a number', '1 is numeric so it\'s invalid!', false ],
[ 'Should not start with leading spaces', ' Leading spaces are invalid.', false ],
[ 'Should not start with leading tabs', ' Leading tabs are invalid.', false ],
[ 'Should not end with trailing new lines', 'Trailing tabs are invalid.\n', false ],
[ 'Should not end with trailing tabs', 'Trailing tabs are invalid. ', false ],
[ 'Should not end with trailing space', 'Trailing spaces are invalid. ', false ],
[ 'Should not end have multiple sentences without a full stop at the end', 'Trailing characters are invalid. Another', false ],
];
it.each( testData )( '%s', ( name, input, expected ) => {
expect( isEntryValid( input ) ).toStrictEqual( expected );
} );
} );
describe( 'Multi-line entries', () => {
const testData = [
// Valid.
[ 'Should accept a multi-line entry with only a single valid line', '+ A single valid line.\n', true ],
[ 'Should accept any number of valid lines', '+ Multiple valid lines?\n+ Of course.\n+ They\'re okay!', true ],
[ 'Should accept nested indented lines and lines ending in a colon', '+ Nested indentations are okay:\n + Yes.\n + Me 2.', true ],
// Invalid.
[ 'Should not allow the minus character to be used as a bullet', '- No minus signs allowed.\n', false ],
[ 'Should not allow indentation greater than one level deep', ' + This has three spaces.\n', false ],
[ 'Should not allow any lines missing a full stop', '+ Not okay\n+ Okay!', false ],
[ 'Should not allow any lines with improper capitalization', '+ capitalization is still important.\n+ Okay!', false ],
];
it.each( testData )( '%s', ( name, input, expected ) => {
expect( isEntryValid( input ) ).toStrictEqual( expected );
} );
} );
} );
describe( 'isLinkValid', () => {
const testData = [
// Valid data.
[ 'Should accept a reference to the current repo', '#123', true ],
[ 'Should accept a reference to another repo', 'org/repo#123', true ],
// Invalid data.
[ 'Should not accept a local reference without a # symbol', '123', false ],
[ 'Should not accept a reference to another repo without a # symbol', 'org/repo123', false ],
[ 'Should not accept a reference to another repo without an organization', 'repo#123', false ],
// Weird types.
[ 'Should not accept an integer', 123, false ],
[ 'Should not accept an object', {}, false ],
[ 'Should not accept an array', [], false ],
];
it.each( testData )( '%s', ( name, input, expected ) => {
expect( isLinkValid( input ) ).toStrictEqual( expected );
} );
} );
describe( 'getChangelogValidationIssues', () => {
it( 'should return errors when missing required fields', () => {
const { valid, errors, warnings } = getChangelogValidationIssues( {}, false );
expect( valid ).toStrictEqual( false );
expect( warnings ).toStrictEqual( [] );
expect( errors ).toStrictEqual( [ 'Missing required field: "significance".', 'Missing required field: "type".', 'Missing required field: "entry".' ] );
} );
it( 'should return errors for invalid entry values', () => {
const { valid, errors, warnings } = getChangelogValidationIssues( { significance: 'patch', type: 'changed', entry: 'invalid' }, false );
expect( valid ).toStrictEqual( false );
expect( warnings ).toStrictEqual( [] );
expect( errors ).toStrictEqual( [ 'The submitted entry text did not pass validation.' ] );
} );
it( 'should return errors for invalid significance values', () => {
const { valid, errors, warnings } = getChangelogValidationIssues( { significance: 'fake', type: 'changed', entry: 'Valid.' }, false );
expect( valid ).toStrictEqual( false );
expect( warnings ).toStrictEqual( [] );
expect( errors ).toStrictEqual( [ 'Invalid value "fake" supplied for field: "significance".' ] );
} );
it( 'should return errors for invalid type values', () => {
const { valid, errors, warnings } = getChangelogValidationIssues( { type: 'fake', significance: 'patch', entry: 'Valid.' }, false );
expect( valid ).toStrictEqual( false );
expect( warnings ).toStrictEqual( [] );
expect( errors ).toStrictEqual( [ 'Invalid value "fake" supplied for field: "type".' ] );
} );
it( 'should return warnings when non-standard keys are found in the entry object', () => {
const { valid, warnings } = getChangelogValidationIssues( { extra: 1 }, false );
expect( valid ).toStrictEqual( false );
expect( warnings ).toStrictEqual( [ 'Unexpected key: "extra".' ] );
} );
it( 'should return errors when an array is not submitted for the attributions list', () => {
const { valid, errors, warnings } = getChangelogValidationIssues( { attributions: 1, type: 'changed', significance: 'patch', entry: 'Valid.' }, false );
expect( valid ).toStrictEqual( false );
expect( warnings ).toStrictEqual( [] );
expect( errors ).toStrictEqual( [ 'The "attributions" field must be an array.' ] );
} );
it( 'should return errors when an array is not submitted for the links list', () => {
const { valid, errors, warnings } = getChangelogValidationIssues( { links: 1, type: 'changed', significance: 'patch', entry: 'Valid.' }, false );
expect( valid ).toStrictEqual( false );
expect( warnings ).toStrictEqual( [] );
expect( errors ).toStrictEqual( [ 'The "links" field must be an array.' ] );
} );
it( 'should return errors when an invalid attribution is submitted', () => {
const { valid, errors, warnings } = getChangelogValidationIssues( { attributions: [ 'abc' ], type: 'changed', significance: 'patch', entry: 'Valid.' }, false );
expect( valid ).toStrictEqual( false );
expect( warnings ).toStrictEqual( [] );
expect( errors ).toStrictEqual( [ 'The attribution "abc" is invalid.' ] );
} );
it( 'should return errors when an invalid link is submitted', () => {
const { valid, errors, warnings } = getChangelogValidationIssues( { links: [ 'abc' ], type: 'changed', significance: 'patch', entry: 'Valid.' }, false );
expect( valid ).toStrictEqual( false );
expect( warnings ).toStrictEqual( [] );
expect( errors ).toStrictEqual( [ 'The link "abc" is invalid.' ] );
} );
const testData = [
[
'should validate a valid entry that is missing optional fields',
{
significance: 'major',
type: 'added',
entry: 'Entry content.',
},
[],
],
[
'should validate a valid entry that includes valid optional fields',
{
significance: 'major',
type: 'added',
entry: 'Entry content.',
comment: 'A comment',
title: 'title',
attributions: [ '@username', '[user](https://fake.tld)' ],
links: [ '#1234', 'org/repo#123' ],
},
[],
],
[
'should validate a valid entry that has warnings and no errors',
{
significance: 'major',
type: 'added',
entry: 'Entry content.',
fake: 'extra-field-generates-warning',
},
[ 'Unexpected key: "fake".' ],
],
];
it.each( testData )( '%s', ( name, entry, expectedWarnings ) => {
const { valid, errors, warnings } = getChangelogValidationIssues( entry, false );
expect( valid ).toStrictEqual( true );
expect( warnings ).toStrictEqual( expectedWarnings );
expect( errors ).toStrictEqual( [] );
} );
} );
================================================
FILE: packages/fontawesome/.eslintrc.js
================================================
const config = require( '../scripts/config/.eslintrc.js' );
module.exports = config;
================================================
FILE: packages/fontawesome/.npmrc
================================================
package-lock=false
================================================
FILE: packages/fontawesome/CHANGELOG.md
================================================
@lifterlms/fontawesome CHANGELOG
================================
v0.0.1 - 2022-08-11
-------------------
+ Initial public release.
================================================
FILE: packages/fontawesome/README.md
================================================
# LifterLMS Font Awesome
A wrapper around [Font Awesome](https://github.com/FortAwesome/Font-Awesome) and a collection of related React components for use in LifterLMS projects.
* * *
## Changelog
[View the Changelog](./CHANGELOG.md)
## Configure and generate CSS files
To create the relevant CSS file which includes all the free icons and necessary CSS classes, create an SCSS file:
```scss
$llms-css-prefix: my-prefix-fa;
@import '@lifterlms/fontawesome/src/fontawesome';
```
The `$llms-css-prefix` variable allows creation of the Font Awesome CSS file in a "no-conflict" mode using a different prefix than the default `fa` prefix commonly used with Font Awesome. The default prefix, `llms-fa` is used by the LifterLMS core plugin. Any other projects should choose a unique prefix in order to avoid conflicts with other plugins (or LifterLMS) which may be loading various other versions of Font Awesome.
Then add an entry to your webpack config file, if you're using `@lifterlms/scripts/config/webpack.config.js`:
```js
const { resolve } = require( 'path' ),
config = generate( {} );
config.entry.fontawesome = resolve( './src/scss/fa-file.scss' );
module.exports = config;
```
When building you'll now find the Font Awesome CSS file at `assets/css/fa-file.scss` and the `assets/fonts` directory will contain copies of the Font Awesome font files.
## Using SVGs
The above steps enable using Font Awesome as a webfont. If you wish to instead use SVGs, you may wish to copy the SVGs to your project's directory. The [svg](./bin/svg.js) script can be used to copy the source SVGs into you project.
```bash
node ./node_modules/@lifterlms/fontawesome/bin/svg.js [destDir]
```
The `destDir` parameter defaults to `./src/img/fontawesome` if omitted.
## Component and API Docs
<!-- START TOKEN(Autogenerated API docs) -->
### getMetadata
Retrieves metadata for a given icon.
_Parameters_
- _iconId_ `string`: The icon ID.
_Returns_
- `IconMeta|boolean`: An icon metadata object or `false` if the icon can't be found.
### Icon
Renders a Font Awesome icon.
_Parameters_
- _props_ `Object`: Component properties.
- _props.icon_ `string`: The Icon ID.
- _props.iconStyle_ `string`: The icon style, enum: "solid", "regular", or "brands".
- _props.iconPrefix_ `string`: The project's icon prefix.
- _props.label_ `string`: The (optional) accessibility label to display for the icon.
- _props.wrapperProps_ `...Object`: Any remaining properties which are passed to the icon wrapper component.
_Returns_
- `WPElement`: The component.
### IconPicker
Renders an icon picker component, intended to be used within the WordPress block editor.
_Parameters_
- _props_ `Object`: Component properties.
- _props.icon_ `string`: The Icon ID.
- _props.iconStyle_ `string`: The icon style, enum: "solid", "regular", or "brands".
- _props.iconPrefix_ `string`: The project's icon prefix.
- _props.controlProps_ `Object`: Properties to pass through to the <BaseControl> component.
- _props.onChange_ `Function`: Function called when an icon is selected from the picker. The function is passed three properties: The icon ID, the currently selected style, and the icon's predefined label.
_Returns_
- `BaseControl`: A BaseControl containing the icon picker component.
<!-- END TOKEN(Autogenerated API docs) -->
================================================
FILE: packages/fontawesome/babel.config.js
================================================
/**
* Babel config
*
* @package
*
* @since 1.0.0
* @version 1.0.0
*/
const presets = [ '@wordpress/default' ];
module.exports = { presets };
================================================
FILE: packages/fontawesome/bin/.eslintrc.js
================================================
module.exports = {
rules: {
'no-console': 'off',
},
};
================================================
FILE: packages/fontawesome/bin/metadata.js
================================================
#!/usr/bin/node
/**
* A CLI utility used to create the FontAwesome icon metadata file located at `src/metadata.json`
*
* This utility parses YAML metadata included with the FA package and converts it to our desired format.
*
* This is an internal script intended to be run during package builds before release or after updating the FontAwesome dependency.
*
* @since 0.0.1
* @version 0.0.1
*
* Example usage:
*
* node ./bin/metadata.js
*/
const
{ resolve } = require( 'path' ),
YAML = require( 'yaml' ),
{ existsSync, readFileSync, writeFileSync } = require( 'fs' ),
METADATA_FILE = resolve( './node_modules/@fortawesome/fontawesome-free/metadata/icons.yml' ),
SRC_DIR = resolve( './src' );
if ( ! existsSync( METADATA_FILE ) ) {
console.error( 'Cannot locate the source metadata file, please run `npm i` and try again.' );
process.exit( 1 );
}
const origMetadata = YAML.parse( readFileSync( METADATA_FILE, 'utf8' ) ),
metadata = {};
Object.keys( origMetadata ).forEach( ( id ) => {
const { styles, label, aliases } = origMetadata[ id ],
terms = aliases?.names || [];
metadata[ id ] = { styles, label, terms: [ ...terms, label, id ] };
} );
writeFileSync( `${ SRC_DIR }/metadata.json`, JSON.stringify( metadata, null, 2 ) );
console.log( `Successfully created ${ SRC_DIR }/metadata.json` );
================================================
FILE: packages/fontawesome/bin/svg.js
================================================
#!/usr/bin/node
/**
* A CLI utility used to copy source SVGs files from the FontAwesome package to a specified location.
*
* This script is intended to be used by projects including SVGs through this package.
*
* @since 0.0.1
* @version 0.0.1
*
* Example usage:
*
* node ./node_modules/@lifterlms/fontawesome/bin/svg.js [distDirectory]
*
* The distDirectory parameter is optional and defaults to `./src/img/fontawesome`.
*/
const
{ argv } = process,
srcDir = argv[ 2 ] || './src/img/fontawesome',
{ resolve } = require( 'path' ),
{ cpSync, existsSync } = require( 'fs' ),
SVG_DIR = resolve( './node_modules/@fortawesome/fontawesome-free/svgs' ),
SRC_DIR = resolve( srcDir );
const bold = '\x1b[32m\x1b[1m',
reset = '\x1b[0m';
if ( ! existsSync( SVG_DIR ) ) {
console.error( 'Cannot locate the SVG source directory, please run `npm i` and try again.' );
process.exit( 1 );
}
console.log( `Copying SVG files from ${ bold }${ SVG_DIR }${ reset } to ${ bold }${ SRC_DIR }${ reset }.` );
cpSync( SVG_DIR, SRC_DIR, { recursive: true } );
================================================
FILE: packages/fontawesome/package.json
================================================
{
"name": "@lifterlms/fontawesome",
"version": "0.0.1",
"description": "A no-conflict fork of Font Awesome for use in LifterLMS projects.",
"author": "Team LifterLMS <dev@lifterlms.com>",
"license": "GPL-3.0-or-later",
"homepage": "https://github.com/gocodebox/lifterlms/tree/trunk/packages/fontawesome",
"keywords": [
"lifterlms",
"wordpress",
"fontawesome",
"ui"
],
"repository": {
"type": "git",
"url": "https://github.com/gocodebox/lifterlms.git",
"directory": "packages/fontawesome"
},
"bugs": {
"url": "https://github.com/gocodebox/lifterlms/labels/package%3A%fontawesome"
},
"main": "src/index.js",
"publishConfig": {
"access": "public"
},
"dependencies": {
"@emotion/styled": "^11.10.0",
"@fortawesome/fontawesome-free": "^6.1.2",
"react-infinite-scroller": "^1.2.6"
},
"devDependencies": {
"yaml": "^2.1.1"
},
"scripts": {
"build": "node ./bin/metadata.js",
"docgen": "docgen src/index.js --output README.md --to-token",
"dev": "./../dev/src/index.js",
"lint:js": "wp-scripts lint-js ./",
"test": "wp-scripts test-unit-js ./ --config ../scripts/config/jest-unit.config.js --verbose"
}
}
================================================
FILE: packages/fontawesome/src/components/icon-list.js
================================================
// External deps.
import styled from '@emotion/styled';
import InfiniteScroll from 'react-infinite-scroller';
import { debounce } from 'lodash';
import { __ } from '@wordpress/i18n';
import { Button, ButtonGroup, SearchControl } from '@wordpress/components';
import { useEffect, useState } from '@wordpress/element';
import iconMetadata from '../metadata.json';
import Icon from './icon';
/**
* A styled div wrapper component.
*/
const Wrapper = styled.div`
& .llms-fa-icon-picker--content-header {
border-bottom: 1px solid rgb( 204, 204, 204 );
margin: 0 -8px;
padding: 0 8px 8px;
}
& .llms-fa-icon-picker--list {
display: flex;
flex-wrap: wrap;
padding-top: 8px;
max-height: 440px;
overflow: auto;
> div {
width: 100%;
}
}
& .llms-fa-icon-picker--icon-button {
border: 1px solid rgba( 0, 0, 0, 0.1 );
display: inline-block;
height: 90px;
padding: 12px 12px 8px;
margin: 2px;
width: calc( 25% - 4px );
vertical-align: middle;
}
& .llms-fa-icon-picker--icon-button i {
display: block;
font-size: 24px;
}
& .llms-fa-icon-picker--icon-button span {
display: block;
font-size: 10px;
}
`;
const STYLES = [
{
label: __( 'Solid', 'lifterlms' ),
id: 'solid',
},
{
label: __( 'Regular', 'lifterlms' ),
id: 'regular',
},
{
label: __( 'Brands', 'lifterlms' ),
id: 'brands',
},
];
/**
* Renders an infinitely scrollable list of the available icons.
*
* @since 0.0.1
*
* @param {Object} props Component properties.
* @param {Function} props.onChange Function to call when a new icon is selected.
* @param {string} props.selectedStyle The currently selected icon style.
* @param {Object} props.availableIcons The available icons to display.
* @param {string} props.iconPrefix The project icon prefix.
* @param {number} props.perPage Number of icons to display per "page" of results.
* @return {WPElement} A scrollable list.
*/
function List( { onChange, selectedStyle, availableIcons, iconPrefix, perPage } ) {
const [ endIndex, setEndIndex ] = useState( perPage ),
numIcons = Object.keys( availableIcons ).length;
return (
<div className="llms-fa-icon-picker--list">
<InfiniteScroll
loadMore={ debounce( () => setEndIndex( endIndex + perPage ), 300 ) }
hasMore={ ! numIcons || endIndex <= numIcons ? true : false }
useWindow={ false }
>
{ Object.keys( availableIcons ).slice( 0, endIndex ).map( ( icon, key ) => (
<Button
key={ key }
className="llms-fa-icon-picker--icon-button"
onClick={ () => onChange( icon, selectedStyle, availableIcons[ icon ].label ) }
>
<Icon { ...{ icon, iconStyle: selectedStyle, iconPrefix } } />
<span>{ availableIcons[ icon ].label }</span>
</Button>
) ) }
</InfiniteScroll>
</div>
);
}
/**
* Renders the icon picker list.
*
* @since 0.0.1
*
* @param {Object} props Component properties.
* @param {Function} props.onChange Icon select callback function.
* @param {string} props.iconPrefix Project icon prefix.
* @param {number} props.perPage Number of icons to display per page of results.
* @return {WPElement} The list component.
*/
export default function( { onChange, iconPrefix, perPage = 48 } ) {
const [ availableIcons, setAvailableIcons ] = useState( [] ),
[ search, setSearch ] = useState( '' ),
[ selectedStyle, setSelectedStyle ] = useState( STYLES[ 0 ].id );
useEffect( () => {
const normalSearch = search.toLowerCase(),
filteredIcons = Object.fromEntries(
Object.entries( iconMetadata ).filter( ( [ , { terms, styles } ] ) => {
if ( ! styles.includes( selectedStyle ) ) {
return false;
}
return ! search || terms.map( ( term ) => term.toLowerCase() ).some( ( term ) => term.includes( normalSearch ) );
} )
);
setAvailableIcons( { ...filteredIcons } );
}, [ search, selectedStyle ] );
return (
<Wrapper>
<header className="llms-fa-icon-picker--content-header">
<SearchControl
value={ search }
onChange={ ( newSearch ) => setSearch( newSearch ) }
/>
<span>{ __( 'Styles:', 'lifterlms' ) } </span>
<ButtonGroup>
{ STYLES.map( ( { label, id } ) => (
<Button
key={ id }
text={ label }
variant={ selectedStyle === id ? 'primary' : 'secondary' }
onClick={ () => setSelectedStyle( id ) }
/>
) ) }
</ButtonGroup>
</header>
<List { ...{ onChange, selectedStyle, availableIcons, iconPrefix, perPage } } />
</Wrapper>
);
}
================================================
FILE: packages/fontawesome/src/components/icon-picker.js
================================================
// External deps.
import styled from '@emotion/styled';
// WP deps.
import { BaseControl, Button, Dropdown } from '@wordpress/components';
// Internal deps.
import { getMetadata } from '../';
import Icon from './icon';
import IconList from './icon-list';
/**
* A <Dropdown> component with styles targeting the sub-components within it.
*
* @since 0.0.1
*/
const StyledDropdown = styled( Dropdown )`
display: block;
width: 100%;
> .components-button {
border: 1px solid rgba( 0, 0, 0, 0.1 );
border-radius: 2px;
padding-bottom: 24px;
padding-top: 24px;
width: 100%;
}
`;
/**
* Renders an icon picker component, intended to be used within the WordPress block editor.
*
* @since 0.0.1
*
* @param {Object} props Component properties.
* @param {string} props.icon The Icon ID.
* @param {string} props.iconStyle The icon style, enum: "solid", "regular", or "brands".
* @param {string} props.iconPrefix The project's icon prefix.
* @param {Object} props.controlProps Properties to pass through to the <BaseControl> component.
* @param {Function} props.onChange Function called when an icon is selected from the picker. The function is passed three properties:
* The icon ID, the currently selected style, and the icon's predefined label.
* @return {BaseControl} A BaseControl containing the icon picker component.
*/
export default function( { icon, iconStyle, controlProps = {}, onChange = () => {}, iconPrefix = 'llms-fa-' } ) {
const { label } = getMetadata( icon );
return (
<BaseControl { ...controlProps }>
<StyledDropdown
// position="bottom left"
className="llms-fa-icon-picker--dropdown"
contentClassName="llms-fa-icon-picker--content"
popoverProps={ {
style: {
marginTop: '-50px',
marginLeft: '-180px',
},
// placement: 'left-start',
// offset: 200,
} }
renderToggle={ ( { isOpen, onToggle } ) => (
<Button
onClick={ onToggle }
aria-expanded={ isOpen }
style={ isOpen ? { background: '#f0f0f0' } : {} }
>
<Icon { ...{ icon, iconStyle, iconPrefix, style: { fontSize: '18px', marginRight: '8px' } } } />
<span>{ label }</span>
</Button>
) }
renderContent={ () => (
<div style={ { width: '380px', maxWidth: '100%' } }>
<IconList { ...{ iconPrefix, onChange } } />
</div>
) }
/>
</BaseControl>
);
}
================================================
FILE: packages/fontawesome/src/components/icon.js
================================================
/**
* Renders a Font Awesome icon.
*
* @since 0.0.1
*
* @param {Object} props Component properties.
* @param {string} props.icon The Icon ID.
* @param {string} props.iconStyle The icon style, enum: "solid", "regular", or "brands".
* @param {string} props.iconPrefix The project's icon prefix.
* @param {string} props.label The (optional) accessibility label to display for the icon.
* @param {...Object} props.wrapperProps Any remaining properties which are passed to the icon wrapper component.
* @return {WPElement} The component.
*/
export default function( { icon, iconStyle = 'solid', iconPrefix = 'llms-fa-', label = '', ...wrapperProps } ) {
return (
<i
className={ `${ iconPrefix }${ iconStyle } ${ iconPrefix }${ icon }` }
{ ...wrapperProps }
>
{ label && (
<span className="screen-reader-text">{ label }</span>
) }
</i>
);
}
================================================
FILE: packages/fontawesome/src/fontawesome.scss
================================================
$llms-css-prefix: llms-fa !default;
$llms-font-path: "~@fortawesome/fontawesome-free/webfonts" !default;
$fa-css-prefix: $llms-css-prefix;
$fa-font-path : $llms-font-path;
@import "@fortawesome/fontawesome-free/scss/fontawesome.scss";
@import "@fortawesome/fontawesome-free/scss/regular.scss";
@import "@fortawesome/fontawesome-free/scss/solid.scss";
@import "@fortawesome/fontawesome-free/scss/brands.scss";
================================================
FILE: packages/fontawesome/src/index.js
================================================
import icons from './metadata.json';
export { default as Icon } from './components/icon';
export { default as IconPicker } from './components/icon-picker';
/**
* An icon metadata object.
*
* @typedef {Object} IconMeta
* @property {string[]} styles An array of icon styles available for the icon. Enum: "solid", "regular", or "brands".
* @property {string} label The human-readable name / title of the icon.
* @property {string[]} terms A list of keywords or terms for the icon.
*/
/**
* Retrieves metadata for a given icon.
*
* @since 0.0.1
*
* @param {string} iconId The icon ID.
* @return {IconMeta|boolean} An icon metadata object or `false` if the icon can't be found.
*/
export function getMetadata( iconId ) {
return icons[ iconId ] ?? false;
}
================================================
FILE: packages/fontawesome/src/metadata.json
================================================
{
"0": {
"styles": [
"solid"
],
"label": "0",
"terms": [
"0",
"0"
]
},
"1": {
"styles": [
"solid"
],
"label": "1",
"terms": [
"1",
"1"
]
},
"2": {
"styles": [
"solid"
],
"label": "2",
"terms": [
"2",
"2"
]
},
"3": {
"styles": [
"solid"
],
"label": "3",
"terms": [
"3",
"3"
]
},
"4": {
"styles": [
"solid"
],
"label": "4",
"terms": [
"4",
"4"
]
},
"5": {
"styles": [
"solid"
],
"label": "5",
"terms": [
"5",
"5"
]
},
"6": {
"styles": [
"solid"
],
"label": "6",
"terms": [
"6",
"6"
]
},
"7": {
"styles": [
"solid"
],
"label": "7",
"terms": [
"7",
"7"
]
},
"8": {
"styles": [
"solid"
],
"label": "8",
"terms": [
"8",
"8"
]
},
"9": {
"styles": [
"solid"
],
"label": "9",
"terms": [
"9",
"9"
]
},
"42-group": {
"styles": [
"brands"
],
"label": "42.group",
"terms": [
"innosoft",
"42.group",
"42-group"
]
},
"500px": {
"styles": [
"brands"
],
"label": "500px",
"terms": [
"500px",
"500px"
]
},
"a": {
"styles": [
"solid"
],
"label": "A",
"terms": [
"A",
"a"
]
},
"accessible-icon": {
"styles": [
"brands"
],
"label": "Accessible Icon",
"terms": [
"Accessible Icon",
"accessible-icon"
]
},
"accusoft": {
"styles": [
"brands"
],
"label": "Accusoft",
"terms": [
"Accusoft",
"accusoft"
]
},
"address-book": {
"styles": [
"solid",
"regular"
],
"label": "Address Book",
"terms": [
"contact-book",
"Address Book",
"address-book"
]
},
"address-card": {
"styles": [
"solid",
"regular"
],
"label": "Address Card",
"terms": [
"contact-card",
"vcard",
"Address Card",
"address-card"
]
},
"adn": {
"styles": [
"brands"
],
"label": "App.net",
"terms": [
"App.net",
"adn"
]
},
"adversal": {
"styles": [
"brands"
],
"label": "Adversal",
"terms": [
"Adversal",
"adversal"
]
},
"affiliatetheme": {
"styles": [
"brands"
],
"label": "affiliatetheme",
"terms": [
"affiliatetheme",
"affiliatetheme"
]
},
"airbnb": {
"styles": [
"brands"
],
"label": "Airbnb",
"terms": [
"Airbnb",
"airbnb"
]
},
"algolia": {
"styles": [
"brands"
],
"label": "Algolia",
"terms": [
"Algolia",
"algolia"
]
},
"align-center": {
"styles": [
"solid"
],
"label": "align-center",
"terms": [
"align-center",
"align-center"
]
},
"align-justify": {
"styles": [
"solid"
],
"label": "align-justify",
"terms": [
"align-justify",
"align-justify"
]
},
"align-left": {
"styles": [
"solid"
],
"label": "align-left",
"terms": [
"align-left",
"align-left"
]
},
"align-right": {
"styles": [
"solid"
],
"label": "align-right",
"terms": [
"align-right",
"align-right"
]
},
"alipay": {
"styles": [
"brands"
],
"label": "Alipay",
"terms": [
"Alipay",
"alipay"
]
},
"amazon": {
"styles": [
"brands"
],
"label": "Amazon",
"terms": [
"Amazon",
"amazon"
]
},
"amazon-pay": {
"styles": [
"brands"
],
"label": "Amazon Pay",
"terms": [
"Amazon Pay",
"amazon-pay"
]
},
"amilia": {
"styles": [
"brands"
],
"label": "Amilia",
"terms": [
"Amilia",
"amilia"
]
},
"anchor": {
"styles": [
"solid"
],
"label": "Anchor",
"terms": [
"Anchor",
"anchor"
]
},
"anchor-circle-check": {
"styles": [
"solid"
],
"label": "Anchor Circle-check",
"terms": [
"Anchor Circle-check",
"anchor-circle-check"
]
},
"anchor-circle-exclamation": {
"styles": [
"solid"
],
"label": "Anchor Circle-exclamation",
"terms": [
"Anchor Circle-exclamation",
"anchor-circle-exclamation"
]
},
"anchor-circle-xmark": {
"styles": [
"solid"
],
"label": "Anchor Circle-xmark",
"terms": [
"Anchor Circle-xmark",
"anchor-circle-xmark"
]
},
"anchor-lock": {
"styles": [
"solid"
],
"label": "Anchor Lock",
"terms": [
"Anchor Lock",
"anchor-lock"
]
},
"android": {
"styles": [
"brands"
],
"label": "Android",
"terms": [
"Android",
"android"
]
},
"angellist": {
"styles": [
"brands"
],
"label": "AngelList",
"terms": [
"AngelList",
"angellist"
]
},
"angle-down": {
"styles": [
"solid"
],
"label": "angle-down",
"terms": [
"angle-down",
"angle-down"
]
},
"angle-left": {
"styles": [
"solid"
],
"label": "angle-left",
"terms": [
"angle-left",
"angle-left"
]
},
"angle-right": {
"styles": [
"solid"
],
"label": "angle-right",
"terms": [
"angle-right",
"angle-right"
]
},
"angle-up": {
"styles": [
"solid"
],
"label": "angle-up",
"terms": [
"angle-up",
"angle-up"
]
},
"angles-down": {
"styles": [
"solid"
],
"label": "Angles down",
"terms": [
"angle-double-down",
"Angles down",
"angles-down"
]
},
"angles-left": {
"styles": [
"solid"
],
"label": "Angles left",
"terms": [
"angle-double-left",
"Angles left",
"angles-left"
]
},
"angles-right": {
"styles": [
"solid"
],
"label": "Angles right",
"terms": [
"angle-double-right",
"Angles right",
"angles-right"
]
},
"angles-up": {
"styles": [
"solid"
],
"label": "Angles up",
"terms": [
"angle-double-up",
"Angles up",
"angles-up"
]
},
"angrycreative": {
"styles": [
"brands"
],
"label": "Angry Creative",
"terms": [
"Angry Creative",
"angrycreative"
]
},
"angular": {
"styles": [
"brands"
],
"label": "Angular",
"terms": [
"Angular",
"angular"
]
},
"ankh": {
"styles": [
"solid"
],
"label": "Ankh",
"terms": [
"Ankh",
"ankh"
]
},
"app-store": {
"styles": [
"brands"
],
"label": "App Store",
"terms": [
"App Store",
"app-store"
]
},
"app-store-ios": {
"styles": [
"brands"
],
"label": "iOS App Store",
"terms": [
"iOS App Store",
"app-store-ios"
]
},
"apper": {
"styles": [
"brands"
],
"label": "Apper Systems AB",
"terms": [
"Apper Systems AB",
"apper"
]
},
"apple": {
"styles": [
"brands"
],
"label": "Apple",
"terms": [
"Apple",
"apple"
]
},
"apple-pay": {
"styles": [
"brands"
],
"label": "Apple Pay",
"terms": [
"Apple Pay",
"apple-pay"
]
},
"apple-whole": {
"styles": [
"solid"
],
"label": "Apple whole",
"terms": [
"apple-alt",
"Apple whole",
"apple-whole"
]
},
"archway": {
"styles": [
"solid"
],
"label": "Archway",
"terms": [
"Archway",
"archway"
]
},
"arrow-down": {
"styles": [
"solid"
],
"label": "Arrow down",
"terms": [
"Arrow down",
"arrow-down"
]
},
"arrow-down-1-9": {
"styles": [
"solid"
],
"label": "Arrow down 1 9",
"terms": [
"sort-numeric-asc",
"sort-numeric-down",
"Arrow down 1 9",
"arrow-down-1-9"
]
},
"arrow-down-9-1": {
"styles": [
"solid"
],
"label": "Arrow down 9 1",
"terms": [
"sort-numeric-desc",
"sort-numeric-down-alt",
"Arrow down 9 1",
"arrow-down-9-1"
]
},
"arrow-down-a-z": {
"styles": [
"solid"
],
"label": "Arrow down a z",
"terms": [
"sort-alpha-asc",
"sort-alpha-down",
"Arrow down a z",
"arrow-down-a-z"
]
},
"arrow-down-long": {
"styles": [
"solid"
],
"label": "Arrow down long",
"terms": [
"long-arrow-down",
"Arrow down long",
"arrow-down-long"
]
},
"arrow-down-short-wide": {
"styles": [
"solid"
],
"label": "Arrow down short wide",
"terms": [
"sort-amount-desc",
"sort-amount-down-alt",
"Arrow down short wide",
"arrow-down-short-wide"
]
},
"arrow-down-up-across-line": {
"styles": [
"solid"
],
"label": "Arrow Down-up-across-line",
"terms": [
"Arrow Down-up-across-line",
"arrow-down-up-across-line"
]
},
"arrow-down-up-lock": {
"styles": [
"solid"
],
"label": "Arrow Down-up-lock",
"terms": [
"Arrow Down-up-lock",
"arrow-down-up-lock"
]
},
"arrow-down-wide-short": {
"styles": [
"solid"
],
"label": "Arrow down wide short",
"terms": [
"sort-amount-asc",
"sort-amount-down",
"Arrow down wide short",
"arrow-down-wide-short"
]
},
"arrow-down-z-a": {
"styles": [
"solid"
],
"label": "Arrow down z a",
"terms": [
"sort-alpha-desc",
"sort-alpha-down-alt",
"Arrow down z a",
"arrow-down-z-a"
]
},
"arrow-left": {
"styles": [
"solid"
],
"label": "arrow-left",
"terms": [
"arrow-left",
"arrow-left"
]
},
"arrow-left-long": {
"styles": [
"solid"
],
"label": "Arrow left long",
"terms": [
"long-arrow-left",
"Arrow left long",
"arrow-left-long"
]
},
"arrow-pointer": {
"styles": [
"solid"
],
"label": "Arrow pointer",
"terms": [
"mouse-pointer",
"Arrow pointer",
"arrow-pointer"
]
},
"arrow-right": {
"styles": [
"solid"
],
"label": "arrow right",
"terms": [
"arrow right",
"arrow-right"
]
},
"arrow-right-arrow-left": {
"styles": [
"solid"
],
"label": "Arrow right arrow left",
"terms": [
"exchange",
"Arrow right arrow left",
"arrow-right-arrow-left"
]
},
"arrow-right-from-bracket": {
"styles": [
"solid"
],
"label": "Arrow right from bracket",
"terms": [
"sign-out",
"Arrow right from bracket",
"arrow-right-from-bracket"
]
},
"arrow-right-long": {
"styles": [
"solid"
],
"label": "Arrow right long",
"terms": [
"long-arrow-right",
"Arrow right long",
"arrow-right-long"
]
},
"arrow-right-to-bracket": {
"styles": [
"solid"
],
"label": "Arrow right to bracket",
"terms": [
"sign-in",
"Arrow right to bracket",
"arrow-right-to-bracket"
]
},
"arrow-right-to-city": {
"styles": [
"solid"
],
"label": "Arrow Right-to-city",
"terms": [
"Arrow Right-to-city",
"arrow-right-to-city"
]
},
"arrow-rotate-left": {
"styles": [
"solid"
],
"label": "Arrow Rotate Left",
"terms": [
"arrow-left-rotate",
"arrow-rotate-back",
"arrow-rotate-backward",
"undo",
"Arrow Rotate Left",
"arrow-rotate-left"
]
},
"arrow-rotate-right": {
"styles": [
"solid"
],
"label": "Arrow Rotate Right",
"terms": [
"arrow-right-rotate",
"arrow-rotate-forward",
"redo",
"Arrow Rotate Right",
"arrow-rotate-right"
]
},
"arrow-trend-down": {
"styles": [
"solid"
],
"label": "Arrow trend down",
"terms": [
"Arrow trend down",
"arrow-trend-down"
]
},
"arrow-trend-up": {
"styles": [
"solid"
],
"label": "Arrow trend up",
"terms": [
"Arrow trend up",
"arrow-trend-up"
]
},
"arrow-turn-down": {
"styles": [
"solid"
],
"label": "Arrow turn down",
"terms": [
"level-down",
"Arrow turn down",
"arrow-turn-down"
]
},
"arrow-turn-up": {
"styles": [
"solid"
],
"label": "Arrow turn up",
"terms": [
"level-up",
"Arrow turn up",
"arrow-turn-up"
]
},
"arrow-up": {
"styles": [
"solid"
],
"label": "Arrow up",
"terms": [
"Arrow up",
"arrow-up"
]
},
"arrow-up-1-9": {
"styles": [
"solid"
],
"label": "Arrow up 1 9",
"terms": [
"sort-numeric-up",
"Arrow up 1 9",
"arrow-up-1-9"
]
},
"arrow-up-9-1": {
"styles": [
"solid"
],
"label": "Arrow up 9 1",
"terms": [
"sort-numeric-up-alt",
"Arrow up 9 1",
"arrow-up-9-1"
]
},
"arrow-up-a-z": {
"styles": [
"solid"
],
"label": "Arrow up a z",
"terms": [
"sort-alpha-up",
"Arrow up a z",
"arrow-up-a-z"
]
},
"arrow-up-from-bracket": {
"styles": [
"solid"
],
"label": "Arrow up from bracket",
"terms": [
"Arrow up from bracket",
"arrow-up-from-bracket"
]
},
"arrow-up-from-ground-water": {
"styles": [
"solid"
],
"label": "Arrow Up-from-ground-water",
"terms": [
"Arrow Up-from-ground-water",
"arrow-up-from-ground-water"
]
},
"arrow-up-from-water-pump": {
"styles": [
"solid"
],
"label": "Arrow Up-from-water-pump",
"terms": [
"Arrow Up-from-water-pump",
"arrow-up-from-water-pump"
]
},
"arrow-up-long": {
"styles": [
"solid"
],
"label": "Arrow up long",
"terms": [
"long-arrow-up",
"Arrow up long",
"arrow-up-long"
]
},
"arrow-up-right-dots": {
"styles": [
"solid"
],
"label": "Arrow Up-right-dots",
"terms": [
"Arrow Up-right-dots",
"arrow-up-right-dots"
]
},
"arrow-up-right-from-square": {
"styles": [
"solid"
],
"label": "Arrow up right from square",
"terms": [
"external-link",
"Arrow up right from square",
"arrow-up-right-from-square"
]
},
"arrow-up-short-wide": {
"styles": [
"solid"
],
"label": "Arrow up short wide",
"terms": [
"sort-amount-up-alt",
"Arrow up short wide",
"arrow-up-short-wide"
]
},
"arrow-up-wide-short": {
"styles": [
"solid"
],
"label": "Arrow up wide short",
"terms": [
"sort-amount-up",
"Arrow up wide short",
"arrow-up-wide-short"
]
},
"arrow-up-z-a": {
"styles": [
"solid"
],
"label": "Arrow up z a",
"terms": [
"sort-alpha-up-alt",
"Arrow up z a",
"arrow-up-z-a"
]
},
"arrows-down-to-line": {
"styles": [
"solid"
],
"label": "Arrows Down-to-line",
"terms": [
"Arrows Down-to-line",
"arrows-down-to-line"
]
},
"arrows-down-to-people": {
"styles": [
"solid"
],
"label": "Arrows Down-to-people",
"terms": [
"Arrows Down-to-people",
"arrows-down-to-people"
]
},
"arrows-left-right": {
"styles": [
"solid"
],
"label": "Arrows left right",
"terms": [
"arrows-h",
"Arrows left right",
"arrows-left-right"
]
},
"arrows-left-right-to-line": {
"styles": [
"solid"
],
"label": "Arrows Left-right-to-line",
"terms": [
"Arrows Left-right-to-line",
"arrows-left-right-to-line"
]
},
"arrows-rotate": {
"styles": [
"solid"
],
"label": "Arrows rotate",
"terms": [
"refresh",
"sync",
"Arrows rotate",
"arrows-rotate"
]
},
"arrows-spin": {
"styles": [
"solid"
],
"label": "Arrows Spin",
"terms": [
"Arrows Spin",
"arrows-spin"
]
},
"arrows-split-up-and-left": {
"styles": [
"solid"
],
"label": "Arrows Split-up-and-left",
"terms": [
"Arrows Split-up-and-left",
"arrows-split-up-and-left"
]
},
"arrows-to-circle": {
"styles": [
"solid"
],
"label": "Arrows To-circle",
"terms": [
"Arrows To-circle",
"arrows-to-circle"
]
},
"arrows-to-dot": {
"styles": [
"solid"
],
"label": "Arrows To-dot",
"terms": [
"Arrows To-dot",
"arrows-to-dot"
]
},
"arrows-to-eye": {
"styles": [
"solid"
],
"label": "Arrows To-eye",
"terms": [
"Arrows To-eye",
"arrows-to-eye"
]
},
"arrows-turn-right": {
"styles": [
"solid"
],
"label": "Arrows Turn-right",
"terms": [
"Arrows Turn-right",
"arrows-turn-right"
]
},
"arrows-turn-to-dots": {
"styles": [
"solid"
],
"label": "Arrows Turn-to-dots",
"terms": [
"Arrows Turn-to-dots",
"arrows-turn-to-dots"
]
},
"arrows-up-down": {
"styles": [
"solid"
],
"label": "Arrows up down",
"terms": [
"arrows-v",
"Arrows up down",
"arrows-up-down"
]
},
"arrows-up-down-left-right": {
"styles": [
"solid"
],
"label": "Arrows up down left right",
"terms": [
"arrows",
"Arrows up down left right",
"arrows-up-down-left-right"
]
},
"arrows-up-to-line": {
"styles": [
"solid"
],
"label": "Arrows Up-to-line",
"terms": [
"Arrows Up-to-line",
"arrows-up-to-line"
]
},
"artstation": {
"styles": [
"brands"
],
"label": "Artstation",
"terms": [
"Artstation",
"artstation"
]
},
"asterisk": {
"styles": [
"solid"
],
"label": "asterisk",
"terms": [
"asterisk",
"asterisk"
]
},
"asymmetrik": {
"styles": [
"brands"
],
"label": "Asymmetrik, Ltd.",
"terms": [
"Asymmetrik, Ltd.",
"asymmetrik"
]
},
"at": {
"styles": [
"solid"
],
"label": "At",
"terms": [
"At",
"at"
]
},
"atlassian": {
"styles": [
"brands"
],
"label": "Atlassian",
"terms": [
"Atlassian",
"atlassian"
]
},
"atom": {
"styles": [
"solid"
],
"label": "Atom",
"terms": [
"Atom",
"atom"
]
},
"audible": {
"styles": [
"brands"
],
"label": "Audible",
"terms": [
"Audible",
"audible"
]
},
"audio-description": {
"styles": [
"solid"
],
"label": "Rectangle audio description",
"terms": [
"Rectangle audio description",
"audio-description"
]
},
"austral-sign": {
"styles": [
"solid"
],
"label": "Austral Sign",
"terms": [
"Austral Sign",
"austral-sign"
]
},
"autoprefixer": {
"styles": [
"brands"
],
"label": "Autoprefixer",
"terms": [
"Autoprefixer",
"autoprefixer"
]
},
"avianex": {
"styles": [
"brands"
],
"label": "avianex",
"terms": [
"avianex",
"avianex"
]
},
"aviato": {
"styles": [
"brands"
],
"label": "Aviato",
"terms": [
"Aviato",
"aviato"
]
},
"award": {
"styles": [
"solid"
],
"label": "Award",
"terms": [
"Award",
"award"
]
},
"aws": {
"styles": [
"brands"
],
"label": "Amazon Web Services (AWS)",
"terms": [
"Amazon Web Services (AWS)",
"aws"
]
},
"b": {
"styles": [
"solid"
],
"label": "B",
"terms": [
"B",
"b"
]
},
"baby": {
"styles": [
"solid"
],
"label": "Baby",
"terms": [
"Baby",
"baby"
]
},
"baby-carriage": {
"styles": [
"solid"
],
"label": "Baby Carriage",
"terms": [
"carriage-baby",
"Baby Carriage",
"baby-carriage"
]
},
"backward": {
"styles": [
"solid"
],
"label": "backward",
"terms": [
"backward",
"backward"
]
},
"backward-fast": {
"styles": [
"solid"
],
"label": "Backward fast",
"terms": [
"fast-backward",
"Backward fast",
"backward-fast"
]
},
"backward-step": {
"styles": [
"solid"
],
"label": "Backward step",
"terms": [
"step-backward",
"Backward step",
"backward-step"
]
},
"bacon": {
"styles": [
"solid"
],
"label": "Bacon",
"terms": [
"Bacon",
"bacon"
]
},
"bacteria": {
"styles": [
"solid"
],
"label": "Bacteria",
"terms": [
"Bacteria",
"bacteria"
]
},
"bacterium": {
"styles": [
"solid"
],
"label": "Bacterium",
"terms": [
"Bacterium",
"bacterium"
]
},
"bag-shopping": {
"styles": [
"solid"
],
"label": "Bag shopping",
"terms": [
"shopping-bag",
"Bag shopping",
"bag-shopping"
]
},
"bahai": {
"styles": [
"solid"
],
"label": "Bahá'í",
"terms": [
"haykal",
"Bahá'í",
"bahai"
]
},
"baht-sign": {
"styles": [
"solid"
],
"label": "Baht Sign",
"terms": [
"Baht Sign",
"baht-sign"
]
},
"ban": {
"styles": [
"solid"
],
"label": "ban",
"terms": [
"cancel",
"ban",
"ban"
]
},
"ban-smoking": {
"styles": [
"solid"
],
"label": "Ban smoking",
"terms": [
"smoking-ban",
"Ban smoking",
"ban-smoking"
]
},
"bandage": {
"styles": [
"solid"
],
"label": "Bandage",
"terms": [
"band-aid",
"Bandage",
"bandage"
]
},
"bandcamp": {
"styles": [
"brands"
],
"label": "Bandcamp",
"terms": [
"Bandcamp",
"bandcamp"
]
},
"barcode": {
"styles": [
"solid"
],
"label": "barcode",
"terms": [
"barcode",
"barcode"
]
},
"bars": {
"styles": [
"solid"
],
"label": "Bars",
"terms": [
"navicon",
"Bars",
"bars"
]
},
"bars-progress": {
"styles": [
"solid"
],
"label": "Bars progress",
"terms": [
"tasks-alt",
"Bars progress",
"bars-progress"
]
},
"bars-staggered": {
"styles": [
"solid"
],
"label": "Bars staggered",
"terms": [
"reorder",
"stream",
"Bars staggered",
"bars-staggered"
]
},
"baseball": {
"styles": [
"solid"
],
"label": "Baseball Ball",
"terms": [
"baseball-ball",
"Baseball Ball",
"baseball"
]
},
"baseball-bat-ball": {
"styles": [
"solid"
],
"label": "Baseball bat ball",
"terms": [
"Baseball bat ball",
"baseball-bat-ball"
]
},
"basket-shopping": {
"styles": [
"solid"
],
"label": "Basket shopping",
"terms": [
"shopping-basket",
"Basket shopping",
"basket-shopping"
]
},
"basketball": {
"styles": [
"solid"
],
"label": "Basketball Ball",
"terms": [
"basketball-ball",
"Basketball Ball",
"basketball"
]
},
"bath": {
"styles": [
"solid"
],
"label": "Bath",
"terms": [
"bathtub",
"Bath",
"bath"
]
},
"battery-empty": {
"styles": [
"solid"
],
"label": "Battery Empty",
"terms": [
"battery-0",
"Battery Empty",
"battery-empty"
]
},
"battery-full": {
"styles": [
"solid"
],
"label": "Battery Full",
"terms": [
"battery",
"battery-5",
"Battery Full",
"battery-full"
]
},
"battery-half": {
"styles": [
"solid"
],
"label": "Battery 1/2 Full",
"terms": [
"battery-3",
"Battery 1/2 Full",
"battery-half"
]
},
"battery-quarter": {
"styles": [
"solid"
],
"label": "Battery 1/4 Full",
"terms": [
"battery-2",
"Battery 1/4 Full",
"battery-quarter"
]
},
"battery-three-quarters": {
"styles": [
"solid"
],
"label": "Battery 3/4 Full",
"terms": [
"battery-4",
"Battery 3/4 Full",
"battery-three-quarters"
]
},
"battle-net": {
"styles": [
"brands"
],
"label": "Battle.net",
"terms": [
"Battle.net",
"battle-net"
]
},
"bed": {
"styles": [
"solid"
],
"label": "Bed",
"terms": [
"Bed",
"bed"
]
},
"bed-pulse": {
"styles": [
"solid"
],
"label": "Bed pulse",
"terms": [
"procedures",
"Bed pulse",
"bed-pulse"
]
},
"beer-mug-empty": {
"styles": [
"solid"
],
"label": "Beer mug empty",
"terms": [
"beer",
"Beer mug empty",
"beer-mug-empty"
]
},
"behance": {
"styles": [
"brands"
],
"label": "Behance",
"terms": [
"Behance",
"behance"
]
},
"bell": {
"styles": [
"solid",
"regular"
],
"label": "bell",
"terms": [
"bell",
"bell"
]
},
"bell-concierge": {
"styles": [
"solid"
],
"label": "Bell concierge",
"terms": [
"concierge-bell",
"Bell concierge",
"bell-concierge"
]
},
"bell-slash": {
"styles": [
"solid",
"regular"
],
"label": "Bell Slash",
"terms": [
"Bell Slash",
"bell-slash"
]
},
"bezier-curve": {
"styles": [
"solid"
],
"label": "Bezier Curve",
"terms": [
"Bezier Curve",
"bezier-curve"
]
},
"bicycle": {
"styles": [
"solid"
],
"label": "Bicycle",
"terms": [
"Bicycle",
"bicycle"
]
},
"bilibili": {
"styles": [
"brands"
],
"label": "Bilibili",
"terms": [
"Bilibili",
"bilibili"
]
},
"bimobject": {
"styles": [
"brands"
],
"label": "BIMobject",
"terms": [
"BIMobject",
"bimobject"
]
},
"binoculars": {
"styles": [
"solid"
],
"label": "Binoculars",
"terms": [
"Binoculars",
"binoculars"
]
},
"biohazard": {
"styles": [
"solid"
],
"label": "Biohazard",
"terms": [
"Biohazard",
"biohazard"
]
},
"bitbucket": {
"styles": [
"brands"
],
"label": "Bitbucket",
"terms": [
"Bitbucket",
"bitbucket"
]
},
"bitcoin": {
"styles": [
"brands"
],
"label": "Bitcoin",
"terms": [
"Bitcoin",
"bitcoin"
]
},
"bitcoin-sign": {
"styles": [
"solid"
],
"label": "Bitcoin Sign",
"terms": [
"Bitcoin Sign",
"bitcoin-sign"
]
},
"bity": {
"styles": [
"brands"
],
"label": "Bity",
"terms": [
"Bity",
"bity"
]
},
"black-tie": {
"styles": [
"brands"
],
"label": "Font Awesome Black Tie",
"terms": [
"Font Awesome Black Tie",
"black-tie"
]
},
"blackberry": {
"styles": [
"brands"
],
"label": "BlackBerry",
"terms": [
"BlackBerry",
"blackberry"
]
},
"blender": {
"styles": [
"solid"
],
"label": "Blender",
"terms": [
"Blender",
"blender"
]
},
"blender-phone": {
"styles": [
"solid"
],
"label": "Blender Phone",
"terms": [
"Blender Phone",
"blender-phone"
]
},
"blog": {
"styles": [
"solid"
],
"label": "Blog",
"terms": [
"Blog",
"blog"
]
},
"blogger": {
"styles": [
"brands"
],
"label": "Blogger",
"terms": [
"Blogger",
"blogger"
]
},
"blogger-b": {
"styles": [
"brands"
],
"label": "Blogger B",
"terms": [
"Blogger B",
"blogger-b"
]
},
"bluetooth": {
"styles": [
"brands"
],
"label": "Bluetooth",
"terms": [
"Bluetooth",
"bluetooth"
]
},
"bluetooth-b": {
"styles": [
"brands"
],
"label": "Bluetooth",
"terms": [
"Bluetooth",
"bluetooth-b"
]
},
"bold": {
"styles": [
"solid"
],
"label": "bold",
"terms": [
"bold",
"bold"
]
},
"bolt": {
"styles": [
"solid"
],
"label": "Bolt",
"terms": [
"zap",
"Bolt",
"bolt"
]
},
"bolt-lightning": {
"styles": [
"solid"
],
"label": "Lightning Bolt",
"terms": [
"Lightning Bolt",
"bolt-lightning"
]
},
"bomb": {
"styles": [
"solid"
],
"label": "Bomb",
"terms": [
"Bomb",
"bomb"
]
},
"bone": {
"styles": [
"solid"
],
"label": "Bone",
"terms": [
"Bone",
"bone"
]
},
"bong": {
"styles": [
"solid"
],
"label": "Bong",
"terms": [
"Bong",
"bong"
]
},
"book": {
"styles": [
"solid"
],
"label": "book",
"terms": [
"book",
"book"
]
},
"book-atlas": {
"styles": [
"solid"
],
"label": "Book atlas",
"terms": [
"atlas",
"Book atlas",
"book-atlas"
]
},
"book-bible": {
"styles": [
"solid"
],
"label": "Book bible",
"terms": [
"bible",
"Book bible",
"book-bible"
]
},
"book-bookmark": {
"styles": [
"solid"
],
"label": "Book Bookmark",
"terms": [
"Book Bookmark",
"book-bookmark"
]
},
"book-journal-whills": {
"styles": [
"solid"
],
"label": "Book journal whills",
"terms": [
"journal-whills",
"Book journal whills",
"book-journal-whills"
]
},
"book-medical": {
"styles": [
"solid"
],
"label": "Medical Book",
"terms": [
"Medical Book",
"book-medical"
]
},
"book-open": {
"styles": [
"solid"
],
"label": "Book Open",
"terms": [
"Book Open",
"book-open"
]
},
"book-open-reader": {
"styles": [
"solid"
],
"label": "Book open reader",
"terms": [
"book-reader",
"Book open reader",
"book-open-reader"
]
},
"book-quran": {
"styles": [
"solid"
],
"label": "Book quran",
"terms": [
"quran",
"Book quran",
"book-quran"
]
},
"book-skull": {
"styles": [
"solid"
],
"label": "Book skull",
"terms": [
"book-dead",
"Book skull",
"book-skull"
]
},
"book-tanakh": {
"styles": [
"solid"
],
"label": "Book tanakh",
"terms": [
"tanakh",
"Book tanakh",
"book-tanakh"
]
},
"bookmark": {
"styles": [
"solid",
"regular"
],
"label": "bookmark",
"terms": [
"bookmark",
"bookmark"
]
},
"bootstrap": {
"styles": [
"brands"
],
"label": "Bootstrap",
"terms": [
"Bootstrap",
"bootstrap"
]
},
"border-all": {
"styles": [
"solid"
],
"label": "Border All",
"terms": [
"Border All",
"border-all"
]
},
"border-none": {
"styles": [
"solid"
],
"label": "Border None",
"terms": [
"Border None",
"border-none"
]
},
"border-top-left": {
"styles": [
"solid"
],
"label": "Border top left",
"terms": [
"border-style",
"Border top left",
"border-top-left"
]
},
"bore-hole": {
"styles": [
"solid"
],
"label": "Bore Hole",
"terms": [
"Bore Hole",
"bore-hole"
]
},
"bots": {
"styles": [
"brands"
],
"label": "Bots",
"terms": [
"Bots",
"bots"
]
},
"bottle-droplet": {
"styles": [
"solid"
],
"label": "Bottle Droplet",
"terms": [
"Bottle Droplet",
"bottle-droplet"
]
},
"bottle-water": {
"styles": [
"solid"
],
"label": "Bottle Water",
"terms": [
"Bottle Water",
"bottle-water"
]
},
"bowl-food": {
"styles": [
"solid"
],
"label": "Bowl Food",
"terms": [
"Bowl Food",
"bowl-food"
]
},
"bowl-rice": {
"styles": [
"solid"
],
"label": "Bowl Rice",
"terms": [
"Bowl Rice",
"bowl-rice"
]
},
"bowling-ball": {
"styles": [
"solid"
],
"label": "Bowling Ball",
"terms": [
"Bowling Ball",
"bowling-ball"
]
},
"box": {
"styles": [
"solid"
],
"label": "Box",
"terms": [
"Box",
"box"
]
},
"box-archive": {
"styles": [
"solid"
],
"label": "Box archive",
"terms": [
"archive",
"Box archive",
"box-archive"
]
},
"box-open": {
"styles": [
"solid"
],
"label": "Box Open",
"terms": [
"Box Open",
"box-open"
]
},
"box-tissue": {
"styles": [
"solid"
],
"label": "Tissue Box",
"terms": [
"Tissue Box",
"box-tissue"
]
},
"boxes-packing": {
"styles": [
"solid"
],
"label": "Boxes Packing",
"terms": [
"Boxes Packing",
"boxes-packing"
]
},
"boxes-stacked": {
"styles": [
"solid"
],
"label": "Boxes stacked",
"terms": [
"boxes",
"boxes-alt",
"Boxes stacked",
"boxes-stacked"
]
},
"braille": {
"styles": [
"solid"
],
"label": "Braille",
"terms": [
"Braille",
"braille"
]
},
"brain": {
"styles": [
"solid"
],
"label": "Brain",
"terms": [
"Brain",
"brain"
]
},
"brazilian-real-sign": {
"styles": [
"solid"
],
"label": "Brazilian Real Sign",
"terms": [
"Brazilian Real Sign",
"brazilian-real-sign"
]
},
"bread-slice": {
"styles": [
"solid"
],
"label": "Bread Slice",
"terms": [
"Bread Slice",
"bread-slice"
]
},
"bridge": {
"styles": [
"solid"
],
"label": "Bridge",
"terms": [
"Bridge",
"bridge"
]
},
"bridge-circle-check": {
"styles": [
"solid"
],
"label": "Bridge Circle-check",
"terms": [
"Bridge Circle-check",
"bridge-circle-check"
]
},
"bridge-circle-exclamation": {
"styles": [
"solid"
],
"label": "Bridge Circle-exclamation",
"terms": [
"Bridge Circle-exclamation",
"bridge-circle-exclamation"
]
},
"bridge-circle-xmark": {
"styles": [
"solid"
],
"label": "Bridge Circle-xmark",
"terms": [
"Bridge Circle-xmark",
"bridge-circle-xmark"
]
},
"bridge-lock": {
"styles": [
"solid"
],
"label": "Bridge Lock",
"terms": [
"Bridge Lock",
"bridge-lock"
]
},
"bridge-water": {
"styles": [
"solid"
],
"label": "Bridge Water",
"terms": [
"Bridge Water",
"bridge-water"
]
},
"briefcase": {
"styles": [
"solid"
],
"label": "Briefcase",
"terms": [
"Briefcase",
"briefcase"
]
},
"briefcase-medical": {
"styles": [
"solid"
],
"label": "Medical Briefcase",
"terms": [
"Medical Briefcase",
"briefcase-medical"
]
},
"broom": {
"styles": [
"solid"
],
"label": "Broom",
"terms": [
"Broom",
"broom"
]
},
"broom-ball": {
"styles": [
"solid"
],
"label": "Broom and Ball",
"terms": [
"quidditch",
"quidditch-broom-ball",
"Broom and Ball",
"broom-ball"
]
},
"brush": {
"styles": [
"solid"
],
"label": "Brush",
"terms": [
"Brush",
"brush"
]
},
"btc": {
"styles": [
"brands"
],
"label": "BTC",
"terms": [
"BTC",
"btc"
]
},
"bucket": {
"styles": [
"solid"
],
"label": "Bucket",
"terms": [
"Bucket",
"bucket"
]
},
"buffer": {
"styles": [
"brands"
],
"label": "Buffer",
"terms": [
"Buffer",
"buffer"
]
},
"bug": {
"styles": [
"solid"
],
"label": "Bug",
"terms": [
"Bug",
"bug"
]
},
"bug-slash": {
"styles": [
"solid"
],
"label": "Bug Slash",
"terms": [
"Bug Slash",
"bug-slash"
]
},
"bugs": {
"styles": [
"solid"
],
"label": "Bugs",
"terms": [
"Bugs",
"bugs"
]
},
"building": {
"styles": [
"solid",
"regular"
],
"label": "Building",
"terms": [
"Building",
"building"
]
},
"building-circle-arrow-right": {
"styles": [
"solid"
],
"label": "Building Circle-arrow-right",
"terms": [
"Building Circle-arrow-right",
"building-circle-arrow-right"
]
},
"building-circle-check": {
"styles": [
"solid"
],
"label": "Building Circle-check",
"terms": [
"Building Circle-check",
"building-circle-check"
]
},
"building-circle-exclamation": {
"styles": [
"solid"
],
"label": "Building Circle-exclamation",
"terms": [
"Building Circle-exclamation",
"building-circle-exclamation"
]
},
"building-circle-xmark": {
"styles": [
"solid"
],
"label": "Building Circle-xmark",
"terms": [
"Building Circle-xmark",
"building-circle-xmark"
]
},
"building-columns": {
"styles": [
"solid"
],
"label": "Building with Columns",
"terms": [
"bank",
"institution",
"museum",
"university",
"Building with Columns",
"building-columns"
]
},
"building-flag": {
"styles": [
"solid"
],
"label": "Building Flag",
"terms": [
"Building Flag",
"building-flag"
]
},
"building-lock": {
"styles": [
"solid"
],
"label": "Building Lock",
"terms": [
"Building Lock",
"building-lock"
]
},
"building-ngo": {
"styles": [
"solid"
],
"label": "Building Ngo",
"terms": [
"Building Ngo",
"building-ngo"
]
},
"building-shield": {
"styles": [
"solid"
],
"label": "Building Shield",
"terms": [
"Building Shield",
"building-shield"
]
},
"building-un": {
"styles": [
"solid"
],
"label": "Building Un",
"terms": [
"Building Un",
"building-un"
]
},
"building-user": {
"styles": [
"solid"
],
"label": "Building User",
"terms": [
"Building User",
"building-user"
]
},
"building-wheat": {
"styles": [
"solid"
],
"label": "Building Wheat",
"terms": [
"Building Wheat",
"building-wheat"
]
},
"bullhorn": {
"styles": [
"solid"
],
"label": "bullhorn",
"terms": [
"bullhorn",
"bullhorn"
]
},
"bullseye": {
"styles": [
"solid"
],
"label": "Bullseye",
"terms": [
"Bullseye",
"bullseye"
]
},
"burger": {
"styles": [
"solid"
],
"label": "Burger",
"terms": [
"hamburger",
"Burger",
"burger"
]
},
"buromobelexperte": {
"styles": [
"brands"
],
"label": "Büromöbel-Experte GmbH & Co. KG.",
"terms": [
"Büromöbel-Experte GmbH & Co. KG.",
"buromobelexperte"
]
},
"burst": {
"styles": [
"solid"
],
"label": "Burst",
"terms": [
"Burst",
"burst"
]
},
"bus": {
"styles": [
"solid"
],
"label": "Bus",
"terms": [
"Bus",
"bus"
]
},
"bus-simple": {
"styles": [
"solid"
],
"label": "Bus simple",
"terms": [
"bus-alt",
"Bus simple",
"bus-simple"
]
},
"business-time": {
"styles": [
"solid"
],
"label": "Briefcase clock",
"terms": [
"briefcase-clock",
"Briefcase clock",
"business-time"
]
},
"buy-n-large": {
"styles": [
"brands"
],
"label": "Buy n Large",
"terms": [
"Buy n Large",
"buy-n-large"
]
},
"buysellads": {
"styles": [
"brands"
],
"label": "BuySellAds",
"terms": [
"BuySellAds",
"buysellads"
]
},
"c": {
"styles": [
"solid"
],
"label": "C",
"terms": [
"C",
"c"
]
},
"cable-car": {
"styles": [
"solid"
],
"label": "Cable Car",
"terms": [
"tram",
"Cable Car",
"cable-car"
]
},
"cake-candles": {
"styles": [
"solid"
],
"label": "Cake candles",
"terms": [
"birthday-cake",
"cake",
"Cake candles",
"cake-candles"
]
},
"calculator": {
"styles": [
"solid"
],
"label": "Calculator",
"terms": [
"Calculator",
"calculator"
]
},
"calendar": {
"styles": [
"solid",
"regular"
],
"label": "Calendar",
"terms": [
"Calendar",
"calendar"
]
},
"calendar-check": {
"styles": [
"solid",
"regular"
],
"label": "Calendar Check",
"terms": [
"Calendar Check",
"calendar-check"
]
},
"calendar-day": {
"styles": [
"solid"
],
"label": "Calendar with Day Focus",
"terms": [
"Calendar with Day Focus",
"calendar-day"
]
},
"calendar-days": {
"styles": [
"solid",
"regular"
],
"label": "Calendar Days",
"terms": [
"calendar-alt",
"Calendar Days",
"calendar-days"
]
},
"calendar-minus": {
"styles": [
"solid",
"regular"
],
"label": "Calendar Minus",
"terms": [
"Calendar Minus",
"calendar-minus"
]
},
"calendar-plus": {
"styles": [
"solid",
"regular"
],
"label": "Calendar Plus",
"terms": [
"Calendar Plus",
"calendar-plus"
]
},
"calendar-week": {
"styles": [
"solid"
],
"label": "Calendar with Week Focus",
"terms": [
"Calendar with Week Focus",
"calendar-week"
]
},
"calendar-xmark": {
"styles": [
"solid",
"regular"
],
"label": "Calendar X Mark",
"terms": [
"calendar-times",
"Calendar X Mark",
"calendar-xmark"
]
},
"camera": {
"styles": [
"solid"
],
"label": "camera",
"terms": [
"camera-alt",
"camera",
"camera"
]
},
"camera-retro": {
"styles": [
"solid"
],
"label": "Retro Camera",
"terms": [
"Retro Camera",
"camera-retro"
]
},
"camera-rotate": {
"styles": [
"solid"
],
"label": "Camera Rotate",
"terms": [
"Camera Rotate",
"camera-rotate"
]
},
"campground": {
"styles": [
"solid"
],
"label": "Campground",
"terms": [
"Campground",
"campground"
]
},
"canadian-maple-leaf": {
"styles": [
"brands"
],
"label": "Canadian Maple Leaf",
"terms": [
"Canadian Maple Leaf",
"canadian-maple-leaf"
]
},
"candy-cane": {
"styles": [
"solid"
],
"label": "Candy Cane",
"terms": [
"Candy Cane",
"candy-cane"
]
},
"cannabis": {
"styles": [
"solid"
],
"label": "Cannabis",
"terms": [
"Cannabis",
"cannabis"
]
},
"capsules": {
"styles": [
"solid"
],
"label": "Capsules",
"terms": [
"Capsules",
"capsules"
]
},
"car": {
"styles": [
"solid"
],
"label": "Car",
"terms": [
"automobile",
"Car",
"car"
]
},
"car-battery": {
"styles": [
"solid"
],
"label": "Car Battery",
"terms": [
"battery-car",
"Car Battery",
"car-battery"
]
},
"car-burst": {
"styles": [
"solid"
],
"label": "Car Crash",
"terms": [
"car-crash",
"Car Crash",
"car-burst"
]
},
"car-on": {
"styles": [
"solid"
],
"label": "Car On",
"terms": [
"Car On",
"car-on"
]
},
"car-rear": {
"styles": [
"solid"
],
"label": "Car rear",
"terms": [
"car-alt",
"Car rear",
"car-rear"
]
},
"car-side": {
"styles": [
"solid"
],
"label": "Car Side",
"terms": [
"Car Side",
"car-side"
]
},
"car-tunnel": {
"styles": [
"solid"
],
"label": "Car Tunnel",
"terms": [
"Car Tunnel",
"car-tunnel"
]
},
"caravan": {
"styles": [
"solid"
],
"label": "Caravan",
"terms": [
"Caravan",
"caravan"
]
},
"caret-down": {
"styles": [
"solid"
],
"label": "Caret Down",
"terms": [
"Caret Down",
"caret-down"
]
},
"caret-left": {
"styles": [
"solid"
],
"label": "Caret Left",
"terms": [
"Caret Left",
"caret-left"
]
},
"caret-right": {
"styles": [
"solid"
],
"label": "Caret Right",
"terms": [
"Caret Right",
"caret-right"
]
},
"caret-up": {
"styles": [
"solid"
],
"label": "Caret Up",
"terms": [
"Caret Up",
"caret-up"
]
},
"carrot": {
"styles": [
"solid"
],
"label": "Carrot",
"terms": [
"Carrot",
"carrot"
]
},
"cart-arrow-down": {
"styles": [
"solid"
],
"label": "Shopping Cart Arrow Down",
"terms": [
"Shopping Cart Arrow Down",
"cart-arrow-down"
]
},
"cart-flatbed": {
"styles": [
"solid"
],
"label": "Cart flatbed",
"terms": [
"dolly-flatbed",
"Cart flatbed",
"cart-flatbed"
]
},
"cart-flatbed-suitcase": {
"styles": [
"solid"
],
"label": "Cart flatbed suitcase",
"terms": [
"luggage-cart",
"Cart flatbed suitcase",
"cart-flatbed-suitcase"
]
},
"cart-plus": {
"styles": [
"solid"
],
"label": "Add to Shopping Cart",
"terms": [
"Add to Shopping Cart",
"cart-plus"
]
},
"cart-shopping": {
"styles": [
"solid"
],
"label": "Cart shopping",
"terms": [
"shopping-cart",
"Cart shopping",
"cart-shopping"
]
},
"cash-register": {
"styles": [
"solid"
],
"label": "Cash Register",
"terms": [
"Cash Register",
"cash-register"
]
},
"cat": {
"styles": [
"solid"
],
"label": "Cat",
"terms": [
"Cat",
"cat"
]
},
"cc-amazon-pay": {
"styles": [
"brands"
],
"label": "Amazon Pay Credit Card",
"terms": [
"Amazon Pay Credit Card",
"cc-amazon-pay"
]
},
"cc-amex": {
"styles": [
"brands"
],
"label": "American Express Credit Card",
"terms": [
"American Express Credit Card",
"cc-amex"
]
},
"cc-apple-pay": {
"styles": [
"brands"
],
"label": "Apple Pay Credit Card",
"terms": [
"Apple Pay Credit Card",
"cc-apple-pay"
]
},
"cc-diners-club": {
"styles": [
"brands"
],
"label": "Diner's Club Credit Card",
"terms": [
"Diner's Club Credit Card",
"cc-diners-club"
]
},
"cc-discover": {
"styles": [
"brands"
],
"label": "Discover Credit Card",
"terms": [
"Discover Credit Card",
"cc-discover"
]
},
"cc-jcb": {
"styles": [
"brands"
],
"label": "JCB Credit Card",
"terms": [
"JCB Credit Card",
"cc-jcb"
]
},
"cc-mastercard": {
"styles": [
"brands"
],
"label": "MasterCard Credit Card",
"terms": [
"MasterCard Credit Card",
"cc-mastercard"
]
},
"cc-paypal": {
"styles": [
"brands"
],
"label": "Paypal Credit Card",
"terms": [
"Paypal Credit Card",
"cc-paypal"
]
},
"cc-stripe": {
"styles": [
"brands"
],
"label": "Stripe Credit Card",
"terms": [
"Stripe Credit Card",
"cc-stripe"
]
},
"cc-visa": {
"styles": [
"brands"
],
"label": "Visa Credit Card",
"terms": [
"Visa Credit Card",
"cc-visa"
]
},
"cedi-sign": {
"styles": [
"solid"
],
"label": "Cedi Sign",
"terms": [
"Cedi Sign",
"cedi-sign"
]
},
"cent-sign": {
"styles": [
"solid"
],
"label": "Cent Sign",
"terms": [
"Cent Sign",
"cent-sign"
]
},
"centercode": {
"styles": [
"brands"
],
"label": "Centercode",
"terms": [
"Centercode",
"centercode"
]
},
"centos": {
"styles": [
"brands"
],
"label": "Centos",
"terms": [
"Centos",
"centos"
]
},
"certificate": {
"styles": [
"solid"
],
"label": "certificate",
"terms": [
"certificate",
"certificate"
]
},
"chair": {
"styles": [
"solid"
],
"label": "Chair",
"terms": [
"Chair",
"chair"
]
},
"chalkboard": {
"styles": [
"solid"
],
"label": "Chalkboard",
"terms": [
"blackboard",
"Chalkboard",
"chalkboard"
]
},
"chalkboard-user": {
"styles": [
"solid"
],
"label": "Chalkboard user",
"terms": [
"chalkboard-teacher",
"Chalkboard user",
"chalkboard-user"
]
},
"champagne-glasses": {
"styles": [
"solid"
],
"label": "Champagne glasses",
"terms": [
"glass-cheers",
"Champagne glasses",
"champagne-glasses"
]
},
"charging-station": {
"styles": [
"solid"
],
"label": "Charging Station",
"terms": [
"Charging Station",
"charging-station"
]
},
"chart-area": {
"styles": [
"solid"
],
"label": "Area Chart",
"terms": [
"area-chart",
"Area Chart",
"chart-area"
]
},
"chart-bar": {
"styles": [
"solid",
"regular"
],
"label": "Bar Chart",
"terms": [
"bar-chart",
"Bar Chart",
"chart-bar"
]
},
"chart-column": {
"styles": [
"solid"
],
"label": "Chart Column",
"terms": [
"Chart Column",
"chart-column"
]
},
"chart-gantt": {
"styles": [
"solid"
],
"label": "Chart Gantt",
"terms": [
"Chart Gantt",
"chart-gantt"
]
},
"chart-line": {
"styles": [
"solid"
],
"label": "Line Chart",
"terms": [
"line-chart",
"Line Chart",
"chart-line"
]
},
"chart-pie": {
"styles": [
"solid"
],
"label": "Pie Chart",
"terms": [
"pie-chart",
"Pie Chart",
"chart-pie"
]
},
"chart-simple": {
"styles": [
"solid"
],
"label": "Chart Simple",
"terms": [
"Chart Simple",
"chart-simple"
]
},
"check": {
"styles": [
"solid"
],
"label": "Check",
"terms": [
"Check",
"check"
]
},
"check-double": {
"styles": [
"solid"
],
"label": "Double Check",
"terms": [
"Double Check",
"check-double"
]
},
"check-to-slot": {
"styles": [
"solid"
],
"label": "Check to Slot",
"terms": [
"vote-yea",
"Check to Slot",
"check-to-slot"
]
},
"cheese": {
"styles": [
"solid"
],
"label": "Cheese",
"terms": [
"Cheese",
"cheese"
]
},
"chess": {
"styles": [
"solid"
],
"label": "Chess",
"terms": [
"Chess",
"chess"
]
},
"chess-bishop": {
"styles": [
"solid",
"regular"
],
"label": "Chess Bishop",
"terms": [
"Chess Bishop",
"chess-bishop"
]
},
"chess-board": {
"styles": [
"solid"
],
"label": "Chess Board",
"terms": [
"Chess Board",
"chess-board"
]
},
"chess-king": {
"styles": [
"solid",
"regular"
],
"label": "Chess King",
"terms": [
"Chess King",
"chess-king"
]
},
"chess-knight": {
"styles": [
"solid",
"regular"
],
"label": "Chess Knight",
"terms": [
"Chess Knight",
"chess-knight"
]
},
"chess-pawn": {
"styles": [
"solid",
"regular"
],
"label": "Chess Pawn",
"terms": [
"Chess Pawn",
"chess-pawn"
]
},
"chess-queen": {
"styles": [
"solid",
"regular"
],
"label": "Chess Queen",
"terms": [
"Chess Queen",
"chess-queen"
]
},
"chess-rook": {
"styles": [
"solid",
"regular"
],
"label": "Chess Rook",
"terms": [
"Chess Rook",
"chess-rook"
]
},
"chevron-down": {
"styles": [
"solid"
],
"label": "chevron-down",
"terms": [
"chevron-down",
"chevron-down"
]
},
"chevron-left": {
"styles": [
"solid"
],
"label": "chevron-left",
"terms": [
"chevron-left",
"chevron-left"
]
},
"chevron-right": {
"styles": [
"solid"
],
"label": "chevron-right",
"terms": [
"chevron-right",
"chevron-right"
]
},
"chevron-up": {
"styles": [
"solid"
],
"label": "chevron-up",
"terms": [
"chevron-up",
"chevron-up"
]
},
"child": {
"styles": [
"solid"
],
"label": "Child",
"terms": [
"Child",
"child"
]
},
"child-dress": {
"styles": [
"solid"
],
"label": "Child Dress",
"terms": [
"Child Dress",
"child-dress"
]
},
"child-reaching": {
"styles": [
"solid"
],
"label": "Child Reaching",
"terms": [
"Child Reaching",
"child-reaching"
]
},
"child-rifle": {
"styles": [
"solid"
],
"label": "Child Rifle",
"terms": [
"Child Rifle",
"child-rifle"
]
},
"children": {
"styles": [
"solid"
],
"label": "Children",
"terms": [
"Children",
"children"
]
},
"chrome": {
"styles": [
"brands"
],
"label": "Chrome",
"terms": [
"Chrome",
"chrome"
]
},
"chromecast": {
"styles": [
"brands"
],
"label": "Chromecast",
"terms": [
"Chromecast",
"chromecast"
]
},
"church": {
"styles": [
"solid"
],
"label": "Church",
"terms": [
"Church",
"church"
]
},
"circle": {
"styles": [
"solid",
"regular"
],
"label": "Circle",
"terms": [
"Circle",
"circle"
]
},
"circle-arrow-down": {
"styles": [
"solid"
],
"label": "Circle arrow down",
"terms": [
"arrow-circle-down",
"Circle arrow down",
"circle-arrow-down"
]
},
"circle-arrow-left": {
"styles": [
"solid"
],
"label": "Circle arrow left",
"terms": [
"arrow-circle-left",
"Circle arrow left",
"circle-arrow-left"
]
},
"circle-arrow-right": {
"styles": [
"solid"
],
"label": "Circle arrow right",
"terms": [
"arrow-circle-right",
"Circle arrow right",
"circle-arrow-right"
]
},
"circle-arrow-up": {
"styles": [
"solid"
],
"label": "Circle arrow up",
"terms": [
"arrow-circle-up",
"Circle arrow up",
"circle-arrow-up"
]
},
"circle-check": {
"styles": [
"solid",
"regular"
],
"label": "Circle check",
"terms": [
"check-circle",
"Circle check",
"circle-check"
]
},
"circle-chevron-down": {
"styles": [
"solid"
],
"label": "Circle chevron down",
"terms": [
"chevron-circle-down",
"Circle chevron down",
"circle-chevron-down"
]
},
"circle-chevron-left": {
"styles": [
"solid"
],
"label": "Circle chevron left",
"terms": [
"chevron-circle-left",
"Circle chevron left",
"circle-chevron-left"
]
},
"circle-chevron-right": {
"styles": [
"solid"
],
"label": "Circle chevron right",
"terms": [
"chevron-circle-right",
"Circle chevron right",
"circle-chevron-right"
]
},
"circle-chevron-up": {
"styles": [
"solid"
],
"label": "Circle chevron up",
"terms": [
"chevron-circle-up",
"Circle chevron up",
"circle-chevron-up"
]
},
"circle-dollar-to-slot": {
"styles": [
"solid"
],
"label": "Circle dollar to slot",
"terms": [
"donate",
"Circle dollar to slot",
"circle-dollar-to-slot"
]
},
"circle-dot": {
"styles": [
"solid",
"regular"
],
"label": "Circle dot",
"terms": [
"dot-circle",
"Circle dot",
"circle-dot"
]
},
"circle-down": {
"styles": [
"solid",
"regular"
],
"label": "Circle down",
"terms": [
"arrow-alt-circle-down",
"Circle down",
"circle-down"
]
},
"circle-exclamation": {
"styles": [
"solid"
],
"label": "Circle exclamation",
"terms": [
"exclamation-circle",
"Circle exclamation",
"circle-exclamation"
]
},
"circle-h": {
"styles": [
"solid"
],
"label": "Circle h",
"terms": [
"hospital-symbol",
"Circle h",
"circle-h"
]
},
"circle-half-stroke": {
"styles": [
"solid"
],
"label": "Circle half stroke",
"terms": [
"adjust",
"Circle half stroke",
"circle-half-stroke"
]
},
"circle-info": {
"styles": [
"solid"
],
"label": "Circle info",
"terms": [
"info-circle",
"Circle info",
"circle-info"
]
},
"circle-left": {
"styles": [
"solid",
"regular"
],
"label": "Circle left",
"terms": [
"arrow-alt-circle-left",
"Circle left",
"circle-left"
]
},
"circle-minus": {
"styles": [
"solid"
],
"label": "Circle minus",
"terms": [
"minus-circle",
"Circle minus",
"circle-minus"
]
},
"circle-nodes": {
"styles": [
"solid"
],
"label": "Circle Nodes",
"terms": [
"Circle Nodes",
"circle-nodes"
]
},
"circle-notch": {
"styles": [
"solid"
],
"label": "Circle Notched",
"terms": [
"Circle Notched",
"circle-notch"
]
},
"circle-pause": {
"styles": [
"solid",
"regular"
],
"label": "Circle pause",
"terms": [
"pause-circle",
"Circle pause",
"circle-pause"
]
},
"circle-play": {
"styles": [
"solid",
"regular"
],
"label": "Circle play",
"terms": [
"play-circle",
"Circle play",
"circle-play"
]
},
"circle-plus": {
"styles": [
"solid"
],
"label": "Circle plus",
"terms": [
"plus-circle",
"Circle plus",
"circle-plus"
]
},
"circle-question": {
"styles": [
"solid",
"regular"
],
"label": "Circle question",
"terms": [
"question-circle",
"Circle question",
"circle-question"
]
},
"circle-radiation": {
"styles": [
"solid"
],
"label": "Circle radiation",
"terms": [
"radiation-alt",
"Circle radiation",
"circle-radiation"
]
},
"circle-right": {
"styles": [
"solid",
"regular"
],
"label": "Circle right",
"terms": [
"arrow-alt-circle-right",
"Circle right",
"circle-right"
]
},
"circle-stop": {
"styles": [
"solid",
"regular"
],
"label": "Circle stop",
"terms": [
"stop-circle",
"Circle stop",
"circle-stop"
]
},
"circle-up": {
"styles": [
"solid",
"regular"
],
"label": "Circle up",
"terms": [
"arrow-alt-circle-up",
"Circle up",
"circle-up"
]
},
"circle-user": {
"styles": [
"solid",
"regular"
],
"label": "Circle user",
"terms": [
"user-circle",
"Circle user",
"circle-user"
]
},
"circle-xmark": {
"styles": [
"solid",
"regular"
],
"label": "Circle X Mark",
"terms": [
"times-circle",
"xmark-circle",
"Circle X Mark",
"circle-xmark"
]
},
"city": {
"styles": [
"solid"
],
"label": "City",
"terms": [
"City",
"city"
]
},
"clapperboard": {
"styles": [
"solid"
],
"label": "Clapperboard",
"terms": [
"Clapperboard",
"clapperboard"
]
},
"clipboard": {
"styles": [
"solid",
"regular"
],
"label": "Clipboard",
"terms": [
"Clipboard",
"clipboard"
]
},
"clipboard-check": {
"styles": [
"solid"
],
"label": "Clipboard with Check",
"terms": [
"Clipboard with Check",
"clipboard-check"
]
},
"clipboard-list": {
"styles": [
"solid"
],
"label": "Clipboard List",
"terms": [
"Clipboard List",
"clipboard-list"
]
},
"clipboard-question": {
"styles": [
"solid"
],
"label": "Clipboard Question",
"terms": [
"Clipboard Question",
"clipboard-question"
]
},
"clipboard-user": {
"styles": [
"solid"
],
"label": "Clipboard with User",
"terms": [
"Clipboard with User",
"clipboard-user"
]
},
"clock": {
"styles": [
"solid",
"regular"
],
"label": "Clock",
"terms": [
"clock-four",
"Clock",
"clock"
]
},
"clock-rotate-left": {
"styles": [
"solid"
],
"label": "Clock Rotate Left",
"terms": [
"history",
"Clock Rotate Left",
"clock-rotate-left"
]
},
"clone": {
"styles": [
"solid",
"regular"
],
"label": "Clone",
"terms": [
"Clone",
"clone"
]
},
"closed-captioning": {
"styles": [
"solid",
"regular"
],
"label": "Closed Captioning",
"terms": [
"Closed Captioning",
"closed-captioning"
]
},
"cloud": {
"styles": [
"solid"
],
"label": "Cloud",
"terms": [
"Cloud",
"cloud"
]
},
"cloud-arrow-down": {
"styles": [
"solid"
],
"label": "Cloud arrow down",
"terms": [
"cloud-download",
"cloud-download-alt",
"Cloud arrow down",
"cloud-arrow-down"
]
},
"cloud-arrow-up": {
"styles": [
"solid"
],
"label": "Cloud arrow up",
"terms": [
"cloud-upload",
"cloud-upload-alt",
"Cloud arrow up",
"cloud-arrow-up"
]
},
"cloud-bolt": {
"styles": [
"solid"
],
"label": "Cloud bolt",
"terms": [
"thunderstorm",
"Cloud bolt",
"cloud-bolt"
]
},
"cloud-meatball": {
"styles": [
"solid"
],
"label": "Cloud with (a chance of) Meatball",
"terms": [
"Cloud with (a chance of) Meatball",
"cloud-meatball"
]
},
"cloud-moon": {
"styles": [
"solid"
],
"label": "Cloud with Moon",
"terms": [
"Cloud with Moon",
"cloud-moon"
]
},
"cloud-moon-rain": {
"styles": [
"solid"
],
"label": "Cloud with Moon and Rain",
"terms": [
"Cloud with Moon and Rain",
"cloud-moon-rain"
]
},
"cloud-rain": {
"styles": [
"solid"
],
"label": "Cloud with Rain",
"terms": [
"Cloud with Rain",
"cloud-rain"
]
},
"cloud-showers-heavy": {
"styles": [
"solid"
],
"label": "Cloud with Heavy Showers",
"terms": [
"Cloud with Heavy Showers",
"cloud-showers-heavy"
]
},
"cloud-showers-water": {
"styles": [
"solid"
],
"label": "Cloud Showers-water",
"terms": [
"Cloud Showers-water",
"cloud-showers-water"
]
},
"cloud-sun": {
"styles": [
"solid"
],
"label": "Cloud with Sun",
"terms": [
"Cloud with Sun",
"cloud-sun"
]
},
"cloud-sun-rain": {
"styles": [
"solid"
],
"label": "Cloud with Sun and Rain",
"terms": [
"Cloud with Sun and Rain",
"cloud-sun-rain"
]
},
"cloudflare": {
"styles": [
"brands"
],
"label": "Cloudflare",
"terms": [
"Cloudflare",
"cloudflare"
]
},
"cloudscale": {
"styles": [
"brands"
],
"label": "cloudscale.ch",
"terms": [
"cloudscale.ch",
"cloudscale"
]
},
"cloudsmith": {
"styles": [
"brands"
],
"label": "Cloudsmith",
"terms": [
"Cloudsmith",
"cloudsmith"
]
},
"cloudversify": {
"styles": [
"brands"
],
"label": "cloudversify",
"terms": [
"cloudversify",
"cloudversify"
]
},
"clover": {
"styles": [
"solid"
],
"label": "Clover",
"terms": [
"Clover",
"clover"
]
},
"cmplid": {
"styles": [
"brands"
],
"label": "Cmplid",
"terms": [
"Cmplid",
"cmplid"
]
},
"code": {
"styles": [
"solid"
],
"label": "Code",
"terms": [
"Code",
"code"
]
},
"code-branch": {
"styles": [
"solid"
],
"label": "Code Branch",
"terms": [
"Code Branch",
"code-branch"
]
},
"code-commit": {
"styles": [
"solid"
],
"label": "Code Commit",
"terms": [
"Code Commit",
"code-commit"
]
},
"code-compare": {
"styles": [
"solid"
],
"label": "Code Compare",
"terms": [
"Code Compare",
"code-compare"
]
},
"code-fork": {
"styles": [
"solid"
],
"label": "Code Fork",
"terms": [
"Code Fork",
"code-fork"
]
},
"code-merge": {
"styles": [
"solid"
],
"label": "Code Merge",
"terms": [
"Code Merge",
"code-merge"
]
},
"code-pull-request": {
"styles": [
"solid"
],
"label": "Code Pull Request",
"terms": [
"Code Pull Request",
"code-pull-request"
]
},
"codepen": {
"styles": [
"brands"
],
"label": "Codepen",
"terms": [
"Codepen",
"codepen"
]
},
"codiepie": {
"styles": [
"brands"
],
"label": "Codie Pie",
"terms": [
"Codie Pie",
"codiepie"
]
},
"coins": {
"styles": [
"solid"
],
"label": "Coins",
"terms": [
"Coins",
"coins"
]
},
"colon-sign": {
"styles": [
"solid"
],
"label": "Colon Sign",
"terms": [
"Colon Sign",
"colon-sign"
]
},
"comment": {
"styles": [
"solid",
"regular"
],
"label": "comment",
"terms": [
"comment",
"comment"
]
},
"comment-dollar": {
"styles": [
"solid"
],
"label": "Comment Dollar",
"terms": [
"Comment Dollar",
"comment-dollar"
]
},
"comment-dots": {
"styles": [
"solid",
"regular"
],
"label": "Comment Dots",
"terms": [
"commenting",
"Comment Dots",
"comment-dots"
]
},
"comment-medical": {
"styles": [
"solid"
],
"label": "Alternate Medical Chat",
"terms": [
"Alternate Medical Chat",
"comment-medical"
]
},
"comment-slash": {
"styles": [
"solid"
],
"label": "Comment Slash",
"terms": [
"Comment Slash",
"comment-slash"
]
},
"comment-sms": {
"styles": [
"solid"
],
"label": "Comment sms",
"terms": [
"sms",
"Comment sms",
"comment-sms"
]
},
"comments": {
"styles": [
"solid",
"regular"
],
"label": "comments",
"terms": [
"comments",
"comments"
]
},
"comments-dollar": {
"styles": [
"solid"
],
"label": "Comments Dollar",
"terms": [
"Comments Dollar",
"comments-dollar"
]
},
"compact-disc": {
"styles": [
"solid"
],
"label": "Compact Disc",
"terms": [
"Compact Disc",
"compact-disc"
]
},
"compass": {
"styles": [
"solid",
"regular"
],
"label": "Compass",
"terms": [
"Compass",
"compass"
]
},
"compass-drafting": {
"styles": [
"solid"
],
"label": "Compass drafting",
"terms": [
"drafting-compass",
"Compass drafting",
"compass-drafting"
]
},
"compress": {
"styles": [
"solid"
],
"label": "Compress",
"terms": [
"Compress",
"compress"
]
},
"computer": {
"styles": [
"solid"
],
"label": "Computer",
"terms": [
"Computer",
"computer"
]
},
"computer-mouse": {
"styles": [
"solid"
],
"label": "Computer mouse",
"terms": [
"mouse",
"Computer mouse",
"computer-mouse"
]
},
"confluence": {
"styles": [
"brands"
],
"label": "Confluence",
"terms": [
"Confluence",
"confluence"
]
},
"connectdevelop": {
"styles": [
"brands"
],
"label": "Connect Develop",
"terms": [
"Connect Develop",
"connectdevelop"
]
},
"contao": {
"styles": [
"brands"
],
"label": "Contao",
"terms": [
"Contao",
"contao"
]
},
"cookie": {
"styles": [
"solid"
],
"label": "Cookie",
"terms": [
"Cookie",
"cookie"
]
},
"cookie-bite": {
"styles": [
"solid"
],
"label": "Cookie Bite",
"terms": [
"Cookie Bite",
"cookie-bite"
]
},
"copy": {
"styles": [
"solid",
"regular"
],
"label": "Copy",
"terms": [
"Copy",
"copy"
]
},
"copyright": {
"styles": [
"solid",
"regular"
],
"label": "Copyright",
"terms": [
"Copyright",
"copyright"
]
},
"cotton-bureau": {
"styles": [
"brands"
],
"label": "Cotton Bureau",
"terms": [
"Cotton Bureau",
"cotton-bureau"
]
},
"couch": {
"styles": [
"solid"
],
"label": "Couch",
"terms": [
"Couch",
"couch"
]
},
"cow": {
"styles": [
"solid"
],
"label": "Cow",
"terms": [
"Cow",
"cow"
]
},
"cpanel": {
"styles": [
"brands"
],
"label": "cPanel",
"terms": [
"cPanel",
"cpanel"
]
},
"creative-commons": {
"styles": [
"brands"
],
"label": "Creative Commons",
"terms": [
"Creative Commons",
"creative-commons"
]
},
"creative-commons-by": {
"styles": [
"brands"
],
"label": "Creative Commons Attribution",
"terms": [
"Creative Commons Attribution",
"creative-commons-by"
]
},
"creative-commons-nc": {
"styles": [
"brands"
],
"label": "Creative Commons Noncommercial",
"terms": [
"Creative Commons Noncommercial",
"creative-commons-nc"
]
},
"creative-commons-nc-eu": {
"styles": [
"brands"
],
"label": "Creative Commons Noncommercial (Euro Sign)",
"terms": [
"Creative Commons Noncommercial (Euro Sign)",
"creative-commons-nc-eu"
]
},
"creative-commons-nc-jp": {
"styles": [
"brands"
],
"label": "Creative Commons Noncommercial (Yen Sign)",
"terms": [
"Creative Commons Noncommercial (Yen Sign)",
"creative-commons-nc-jp"
]
},
"creative-commons-nd": {
"styles": [
"brands"
],
"label": "Creative Commons No Derivative Works",
"terms": [
"Creative Commons No Derivative Works",
"creative-commons-nd"
]
},
"creative-commons-pd": {
"styles": [
"brands"
],
"label": "Creative Commons Public Domain",
"terms": [
"Creative Commons Public Domain",
"creative-commons-pd"
]
},
"creative-commons-pd-alt": {
"styles": [
"brands"
],
"label": "Alternate Creative Commons Public Domain",
"terms": [
"Alternate Creative Commons Public Domain",
"creative-commons-pd-alt"
]
},
"creative-commons-remix": {
"styles": [
"brands"
],
"label": "Creative Commons Remix",
"terms": [
"Creative Commons Remix",
"creative-commons-remix"
]
},
"creative-commons-sa": {
"styles": [
"brands"
],
"label": "Creative Commons Share Alike",
"terms": [
"Creative Commons Share Alike",
"creative-commons-sa"
]
},
"creative-commons-sampling": {
"styles": [
"brands"
],
"label": "Creative Commons Sampling",
"terms": [
"Creative Commons Sampling",
"creative-commons-sampling"
]
},
"creative-commons-sampling-plus": {
"styles": [
"brands"
],
"label": "Creative Commons Sampling +",
"terms": [
"Creative Commons Sampling +",
"creative-commons-sampling-plus"
]
},
"creative-commons-share": {
"styles": [
"brands"
],
"label": "Creative Commons Share",
"terms": [
"Creative Commons Share",
"creative-commons-share"
]
},
"creative-commons-zero": {
"styles": [
"brands"
],
"label": "Creative Commons CC0",
"terms": [
"Creative Commons CC0",
"creative-commons-zero"
]
},
"credit-card": {
"styles": [
"solid",
"regular"
],
"label": "Credit Card",
"terms": [
"credit-card-alt",
"Credit Card",
"credit-card"
]
},
"critical-role": {
"styles": [
"brands"
],
"label": "Critical Role",
"terms": [
"Critical Role",
"critical-role"
]
},
"crop": {
"styles": [
"solid"
],
"label": "crop",
"terms": [
"crop",
"crop"
]
},
"crop-simple": {
"styles": [
"solid"
],
"label": "Crop simple",
"terms": [
"crop-alt",
"Crop simple",
"crop-simple"
]
},
"cross": {
"styles": [
"solid"
],
"label": "Cross",
"terms": [
"Cross",
"cross"
]
},
"crosshairs": {
"styles": [
"solid"
],
"label": "Crosshairs",
"terms": [
"Crosshairs",
"crosshairs"
]
},
"crow": {
"styles": [
"solid"
],
"label": "Crow",
"terms": [
"Crow",
"crow"
]
},
"crown": {
"styles": [
"solid"
],
"label": "Crown",
"terms": [
"Crown",
"crown"
]
},
"crutch": {
"styles": [
"solid"
],
"label": "Crutch",
"terms": [
"Crutch",
"crutch"
]
},
"cruzeiro-sign": {
"styles": [
"solid"
],
"label": "Cruzeiro Sign",
"terms": [
"Cruzeiro Sign",
"cruzeiro-sign"
]
},
"css3": {
"styles": [
"brands"
],
"label": "CSS 3 Logo",
"terms": [
"CSS 3 Logo",
"css3"
]
},
"css3-alt": {
"styles": [
"brands"
],
"label": "Alternate CSS3 Logo",
"terms": [
"Alternate CSS3 Logo",
"css3-alt"
]
},
"cube": {
"styles": [
"solid"
],
"label": "Cube",
"terms": [
"Cube",
"cube"
]
},
"cubes": {
"styles": [
"solid"
],
"label": "Cubes",
"terms": [
"Cubes",
"cubes"
]
},
"cubes-stacked": {
"styles": [
"solid"
],
"label": "Cubes Stacked",
"terms": [
"Cubes Stacked",
"cubes-stacked"
]
},
"cuttlefish": {
"styles": [
"brands"
],
"label": "Cuttlefish",
"terms": [
"Cuttlefish",
"cuttlefish"
]
},
"d": {
"styles": [
"solid"
],
"label": "D",
"terms": [
"D",
"d"
]
},
"d-and-d": {
"styles": [
"brands"
],
"label": "Dungeons & Dragons",
"terms": [
"Dungeons & Dragons",
"d-and-d"
]
},
"d-and-d-beyond": {
"styles": [
"brands"
],
"label": "D&D Beyond",
"terms": [
"D&D Beyond",
"d-and-d-beyond"
]
},
"dailymotion": {
"styles": [
"brands"
],
"label": "dailymotion",
"terms": [
"dailymotion",
"dailymotion"
]
},
"dashcube": {
"styles": [
"brands"
],
"label": "DashCube",
"terms": [
"DashCube",
"dashcube"
]
},
"database": {
"styles": [
"solid"
],
"label": "Database",
"terms": [
"Database",
"database"
]
},
"deezer": {
"styles": [
"brands"
],
"label": "Deezer",
"terms": [
"Deezer",
"deezer"
]
},
"delete-left": {
"styles": [
"solid"
],
"label": "Delete left",
"terms": [
"backspace",
"Delete left",
"delete-left"
]
},
"delicious": {
"styles": [
"brands"
],
"label": "Delicious",
"terms": [
"Delicious",
"delicious"
]
},
"democrat": {
"styles": [
"solid"
],
"label": "Democrat",
"terms": [
"Democrat",
"democrat"
]
},
"deploydog": {
"styles": [
"brands"
],
"label": "deploy.dog",
"terms": [
"deploy.dog",
"deploydog"
]
},
"deskpro": {
"styles": [
"brands"
],
"label": "Deskpro",
"terms": [
"Deskpro",
"deskpro"
]
},
"desktop": {
"styles": [
"solid"
],
"label": "Desktop",
"terms": [
"desktop-alt",
"Desktop",
"desktop"
]
},
"dev": {
"styles": [
"brands"
],
"label": "DEV",
"terms": [
"DEV",
"dev"
]
},
"deviantart": {
"styles": [
"brands"
],
"label": "deviantART",
"terms": [
"deviantART",
"deviantart"
]
},
"dharmachakra": {
"styles": [
"solid"
],
"label": "Dharmachakra",
"terms": [
"Dharmachakra",
"dharmachakra"
]
},
"dhl": {
"styles": [
"brands"
],
"label": "DHL",
"terms": [
"DHL",
"dhl"
]
},
"diagram-next": {
"styles": [
"solid"
],
"label": "Diagram Next",
"terms": [
"Diagram Next",
"diagram-next"
]
},
"diagram-predecessor": {
"styles": [
"solid"
],
"label": "Diagram Predecessor",
"terms": [
"Diagram Predecessor",
"diagram-predecessor"
]
},
"diagram-project": {
"styles": [
"solid"
],
"label": "Project Diagram",
"terms": [
"project-diagram",
"Project Diagram",
"diagram-project"
]
},
"diagram-successor": {
"styles": [
"solid"
],
"label": "Diagram Successor",
"terms": [
"Diagram Successor",
"diagram-successor"
]
},
"diamond": {
"styles": [
"solid"
],
"label": "Diamond",
"terms": [
"Diamond",
"diamond"
]
},
"diamond-turn-right": {
"styles": [
"solid"
],
"label": "Diamond turn right",
"terms": [
"directions",
"Diamond turn right",
"diamond-turn-right"
]
},
"diaspora": {
"styles": [
"brands"
],
"label": "Diaspora",
"terms": [
"Diaspora",
"diaspora"
]
},
"dice": {
"styles": [
"solid"
],
"label": "Dice",
"terms": [
"Dice",
"dice"
]
},
"dice-d20": {
"styles": [
"solid"
],
"label": "Dice D20",
"terms": [
"Dice D20",
"dice-d20"
]
},
"dice-d6": {
"styles": [
"solid"
],
"label": "Dice D6",
"terms": [
"Dice D6",
"dice-d6"
]
},
"dice-five": {
"styles": [
"solid"
],
"label": "Dice Five",
"terms": [
"Dice Five",
"dice-five"
]
},
"dice-four": {
"styles": [
"solid"
],
"label": "Dice Four",
"terms": [
"Dice Four",
"dice-four"
]
},
"dice-one": {
"styles": [
"solid"
],
"label": "Dice One",
"terms": [
"Dice One",
"dice-one"
]
},
"dice-six": {
"styles": [
"solid"
],
"label": "Dice Six",
"terms": [
"Dice Six",
"dice-six"
]
},
"dice-three": {
"styles": [
"solid"
],
"label": "Dice Three",
"terms": [
"Dice Three",
"dice-three"
]
},
"dice-two": {
"styles": [
"solid"
],
"label": "Dice Two",
"terms": [
"Dice Two",
"dice-two"
]
},
"digg": {
"styles": [
"brands"
],
"label": "Digg Logo",
"terms": [
"Digg Logo",
"digg"
]
},
"digital-ocean": {
"styles": [
"brands"
],
"label": "Digital Ocean",
"terms": [
"Digital Ocean",
"digital-ocean"
]
},
"discord": {
"styles": [
"brands"
],
"label": "Discord",
"terms": [
"Discord",
"discord"
]
},
"discourse": {
"styles": [
"brands"
],
"label": "Discourse",
"terms": [
"Discourse",
"discourse"
]
},
"disease": {
"styles": [
"solid"
],
"label": "Disease",
"terms": [
"Disease",
"disease"
]
},
"display": {
"styles": [
"solid"
],
"label": "Display",
"terms": [
"Display",
"display"
]
},
"divide": {
"styles": [
"solid"
],
"label": "Divide",
"terms": [
"Divide",
"divide"
]
},
"dna": {
"styles": [
"solid"
],
"label": "DNA",
"terms": [
"DNA",
"dna"
]
},
"dochub": {
"styles": [
"brands"
],
"label": "DocHub",
"terms": [
"DocHub",
"dochub"
]
},
"docker": {
"styles": [
"brands"
],
"label": "Docker",
"terms": [
"Docker",
"docker"
]
},
"dog": {
"styles": [
"solid"
],
"label": "Dog",
"terms": [
"Dog",
"dog"
]
},
"dollar-sign": {
"styles": [
"solid"
],
"label": "Dollar Sign",
"terms": [
"dollar",
"usd",
"Dollar Sign",
"dollar-sign"
]
},
"dolly": {
"styles": [
"solid"
],
"label": "Dolly",
"terms": [
"dolly-box",
"Dolly",
"dolly"
]
},
"dong-sign": {
"styles": [
"solid"
],
"label": "Dong Sign",
"terms": [
"Dong Sign",
"dong-sign"
]
},
"door-closed": {
"styles": [
"solid"
],
"label": "Door Closed",
"terms": [
"Door Closed",
"door-closed"
]
},
"door-open": {
"styles": [
"solid"
],
"label": "Door Open",
"terms": [
"Door Open",
"door-open"
]
},
"dove": {
"styles": [
"solid"
],
"label": "Dove",
"terms": [
"Dove",
"dove"
]
},
"down-left-and-up-right-to-center": {
"styles": [
"solid"
],
"label": "Down left and up right to center",
"terms": [
"compress-alt",
"Down left and up right to center",
"down-left-and-up-right-to-center"
]
},
"down-long": {
"styles": [
"solid"
],
"label": "Down long",
"terms": [
"long-arrow-alt-down",
"Down long",
"down-long"
]
},
"download": {
"styles": [
"solid"
],
"label": "Download",
"terms": [
"Download",
"download"
]
},
"draft2digital": {
"styles": [
"brands"
],
"label": "Draft2digital",
"terms": [
"Draft2digital",
"draft2digital"
]
},
"dragon": {
"styles": [
"solid"
],
"label": "Dragon",
"terms": [
"Dragon",
"dragon"
]
},
"draw-polygon": {
"styles": [
"solid"
],
"label": "Draw Polygon",
"terms": [
"Draw Polygon",
"draw-polygon"
]
},
"dribbble": {
"styles": [
"brands"
],
"label": "Dribbble",
"terms": [
"Dribbble",
"dribbble"
]
},
"dropbox": {
"styles": [
"brands"
],
"label": "Dropbox",
"terms": [
"Dropbox",
"dropbox"
]
},
"droplet": {
"styles": [
"solid"
],
"label": "Droplet",
"terms": [
"tint",
"Droplet",
"droplet"
]
},
"droplet-slash": {
"styles": [
"solid"
],
"label": "Droplet slash",
"terms": [
"tint-slash",
"Droplet slash",
"droplet-slash"
]
},
"drum": {
"styles": [
"solid"
],
"label": "Drum",
"terms": [
"Drum",
"drum"
]
},
"drum-steelpan": {
"styles": [
"solid"
],
"label": "Drum Steelpan",
"terms": [
"Drum Steelpan",
"drum-steelpan"
]
},
"drumstick-bite": {
"styles": [
"solid"
],
"label": "Drumstick with Bite Taken Out",
"terms": [
"Drumstick with Bite Taken Out",
"drumstick-bite"
]
},
"drupal": {
"styles": [
"brands"
],
"label": "Drupal Logo",
"terms": [
"Drupal Logo",
"drupal"
]
},
"dumbbell": {
"styles": [
"solid"
],
"label": "Dumbbell",
"terms": [
"Dumbbell",
"dumbbell"
]
},
"dumpster": {
"styles": [
"solid"
],
"label": "Dumpster",
"terms": [
"Dumpster",
"dumpster"
]
},
"dumpster-fire": {
"styles": [
"solid"
],
"label": "Dumpster Fire",
"terms": [
"Dumpster Fire",
"dumpster-fire"
]
},
"dungeon": {
"styles": [
"solid"
],
"label": "Dungeon",
"terms": [
"Dungeon",
"dungeon"
]
},
"dyalog": {
"styles": [
"brands"
],
"label": "Dyalog",
"terms": [
"Dyalog",
"dyalog"
]
},
"e": {
"styles": [
"solid"
],
"label": "E",
"terms": [
"E",
"e"
]
},
"ear-deaf": {
"styles": [
"solid"
],
"label": "Ear deaf",
"terms": [
"deaf",
"deafness",
"hard-of-hearing",
"Ear deaf",
"ear-deaf"
]
},
"ear-listen": {
"styles": [
"solid"
],
"label": "Ear listen",
"terms": [
"assistive-listening-systems",
"Ear listen",
"ear-listen"
]
},
"earlybirds": {
"styles": [
"brands"
],
"label": "Earlybirds",
"terms": [
"Earlybirds",
"earlybirds"
]
},
"earth-africa": {
"styles": [
"solid"
],
"label": "Earth Africa",
"terms": [
"globe-africa",
"Earth Africa",
"earth-africa"
]
},
"earth-americas": {
"styles": [
"solid"
],
"label": "Earth americas",
"terms": [
"earth",
"earth-america",
"globe-americas",
"Earth americas",
"earth-americas"
]
},
"earth-asia": {
"styles": [
"solid"
],
"label": "Earth Asia",
"terms": [
"globe-asia",
"Earth Asia",
"earth-asia"
]
},
"earth-europe": {
"styles": [
"solid"
],
"label": "Earth Europe",
"terms": [
"globe-europe",
"Earth Europe",
"earth-europe"
]
},
"earth-oceania": {
"styles": [
"solid"
],
"label": "Earth Oceania",
"terms": [
"globe-oceania",
"Earth Oceania",
"earth-oceania"
]
},
"ebay": {
"styles": [
"brands"
],
"label": "eBay",
"terms": [
"eBay",
"ebay"
]
},
"edge": {
"styles": [
"brands"
],
"label": "Edge Browser",
"terms": [
"Edge Browser",
"edge"
]
},
"edge-legacy": {
"styles": [
"brands"
],
"label": "Edge Legacy Browser",
"terms": [
"Edge Legacy Browser",
"edge-legacy"
]
},
"egg": {
"styles": [
"solid"
],
"label": "Egg",
"terms": [
"Egg",
"egg"
]
},
"eject": {
"styles": [
"solid"
],
"label": "eject",
"terms": [
"eject",
"eject"
]
},
"elementor": {
"styles": [
"brands"
],
"label": "Elementor",
"terms": [
"Elementor",
"elementor"
]
},
"elevator": {
"styles": [
"solid"
],
"label": "Elevator",
"terms": [
"Elevator",
"elevator"
]
},
"ellipsis": {
"styles": [
"solid"
],
"label": "Ellipsis",
"terms": [
"ellipsis-h",
"Ellipsis",
"ellipsis"
]
},
"ellipsis-vertical": {
"styles": [
"solid"
],
"label": "Ellipsis vertical",
"terms": [
"ellipsis-v",
"Ellipsis vertical",
"ellipsis-vertical"
]
},
"ello": {
"styles": [
"brands"
],
"label": "Ello",
"terms": [
"Ello",
"ello"
]
},
"ember": {
"styles": [
"brands"
],
"label": "Ember",
"terms": [
"Ember",
"ember"
]
},
"empire": {
"styles": [
"brands"
],
"label": "Galactic Empire",
"terms": [
"Galactic Empire",
"empire"
]
},
"envelope": {
"styles": [
"solid",
"regular"
],
"label": "Envelope",
"terms": [
"Envelope",
"envelope"
]
},
"envelope-circle-check": {
"styles": [
"solid"
],
"label": "Envelope Circle-check",
"terms": [
"Envelope Circle-check",
"envelope-circle-check"
]
},
"envelope-open": {
"styles": [
"solid",
"regular"
],
"label": "Envelope Open",
"terms": [
"Envelope Open",
"envelope-open"
]
},
"envelope-open-text": {
"styles": [
"solid"
],
"label": "Envelope Open-text",
"terms": [
"Envelope Open-text",
"envelope-open-text"
]
},
"envelopes-bulk": {
"styles": [
"solid"
],
"label": "Envelopes bulk",
"terms": [
"mail-bulk",
"Envelopes bulk",
"envelopes-bulk"
]
},
"envira": {
"styles": [
"brands"
],
"label": "Envira Gallery",
"terms": [
"Envira Gallery",
"envira"
]
},
"equals": {
"styles": [
"solid"
],
"label": "Equals",
"terms": [
"Equals",
"equals"
]
},
"eraser": {
"styles": [
"solid"
],
"label": "eraser",
"terms": [
"eraser",
"eraser"
]
},
"erlang": {
"styles": [
"brands"
],
"label": "Erlang",
"terms": [
"Erlang",
"erlang"
]
},
"ethereum": {
"styles": [
"brands"
],
"label": "Ethereum",
"terms": [
"Ethereum",
"ethereum"
]
},
"ethernet": {
"styles": [
"solid"
],
"label": "Ethernet",
"terms": [
"Ethernet",
"ethernet"
]
},
"etsy": {
"styles": [
"brands"
],
"label": "Etsy",
"terms": [
"Etsy",
"etsy"
]
},
"euro-sign": {
"styles": [
"solid"
],
"label": "Euro Sign",
"terms": [
"eur",
"euro",
"Euro Sign",
"euro-sign"
]
},
"evernote": {
"styles": [
"brands"
],
"label": "Evernote",
"terms": [
"Evernote",
"evernote"
]
},
"exclamation": {
"styles": [
"solid"
],
"label": "exclamation",
"terms": [
"exclamation",
"exclamation"
]
},
"expand": {
"styles": [
"solid"
],
"label": "Expand",
"terms": [
"Expand",
"expand"
]
},
"expeditedssl": {
"styles": [
"brands"
],
"label": "ExpeditedSSL",
"terms": [
"ExpeditedSSL",
"expeditedssl"
]
},
"explosion": {
"styles": [
"solid"
],
"label": "Explosion",
"terms": [
"Explosion",
"explosion"
]
},
"eye": {
"styles": [
"solid",
"regular"
],
"label": "Eye",
"terms": [
"Eye",
"eye"
]
},
"eye-dropper": {
"styles": [
"solid"
],
"label": "Eye Dropper",
"terms": [
"eye-dropper-empty",
"eyedropper",
"Eye Dropper",
"eye-dropper"
]
},
"eye-low-vision": {
"styles": [
"solid"
],
"label": "Eye low vision",
"terms": [
"low-vision",
"Eye low vision",
"eye-low-vision"
]
},
"eye-slash": {
"styles": [
"solid",
"regular"
],
"label": "Eye Slash",
"terms": [
"Eye Slash",
"eye-slash"
]
},
"f": {
"styles": [
"solid"
],
"label": "F",
"terms": [
"F",
"f"
]
},
"face-angry": {
"styles": [
"solid",
"regular"
],
"label": "Face angry",
"terms": [
"angry",
"Face angry",
"face-angry"
]
},
"face-dizzy": {
"styles": [
"solid",
"regular"
],
"label": "Face dizzy",
"terms": [
"dizzy",
"Face dizzy",
"face-dizzy"
]
},
"face-flushed": {
"styles": [
"solid",
"regular"
],
"label": "Face flushed",
"terms": [
"flushed",
"Face flushed",
"face-flushed"
]
},
"face-frown": {
"styles": [
"solid",
"regular"
],
"label": "Face frown",
"terms": [
"frown",
"Face frown",
"face-frown"
]
},
"face-frown-open": {
"styles": [
"solid",
"regular"
],
"label": "Face frown open",
"terms": [
"frown-open",
"Face frown open",
"face-frown-open"
]
},
"face-grimace": {
"styles": [
"solid",
"regular"
],
"label": "Face grimace",
"terms": [
"grimace",
"Face grimace",
"face-grimace"
]
},
"face-grin": {
"styles": [
"solid",
"regular"
],
"label": "Face grin",
"terms": [
"grin",
"Face grin",
"face-grin"
]
},
"face-grin-beam": {
"styles": [
"solid",
"regular"
],
"label": "Face grin beam",
"terms": [
"grin-beam",
"Face grin beam",
"face-grin-beam"
]
},
"face-grin-beam-sweat": {
"styles": [
"solid",
"regular"
],
"label": "Face grin beam sweat",
"terms": [
"grin-beam-sweat",
"Face grin beam sweat",
"face-grin-beam-sweat"
]
},
"face-grin-hearts": {
"styles": [
"solid",
"regular"
],
"label": "Face grin hearts",
"terms": [
"grin-hearts",
"Face grin hearts",
"face-grin-hearts"
]
},
"face-grin-squint": {
"styles": [
"solid",
"regular"
],
"label": "Face grin squint",
"terms": [
"grin-squint",
"Face grin squint",
"face-grin-squint"
]
},
"face-grin-squint-tears": {
"styles": [
"solid",
"regular"
],
"label": "Face grin squint tears",
"terms": [
"grin-squint-tears",
"Face grin squint tears",
"face-grin-squint-tears"
]
},
"face-grin-stars": {
"styles": [
"solid",
"regular"
],
"label": "Face grin stars",
"terms": [
"grin-stars",
"Face grin stars",
"face-grin-stars"
]
},
"face-grin-tears": {
"styles": [
"solid",
"regular"
],
"label": "Face grin tears",
"terms": [
"grin-tears",
"Face grin tears",
"face-grin-tears"
]
},
"face-grin-tongue": {
"styles": [
"solid",
"regular"
],
"label": "Face grin tongue",
"terms": [
"grin-tongue",
"Face grin tongue",
"face-grin-tongue"
]
},
"face-grin-tongue-squint": {
"styles": [
"solid",
"regular"
],
"label": "Face grin tongue squint",
"terms": [
"grin-tongue-squint",
"Face grin tongue squint",
"face-grin-tongue-squint"
]
},
"face-grin-tongue-wink": {
"styles": [
"solid",
"regular"
],
"label": "Face grin tongue wink",
"terms": [
"grin-tongue-wink",
"Face grin tongue wink",
"face-grin-tongue-wink"
]
},
"face-grin-wide": {
"styles": [
"solid",
"regular"
],
"label": "Face grin wide",
"terms": [
"grin-alt",
"Face grin wide",
"face-grin-wide"
]
},
"face-grin-wink": {
"styles": [
"solid",
"regular"
],
"label": "Face grin wink",
"terms": [
"grin-wink",
"Face grin wink",
"face-grin-wink"
]
},
"face-kiss": {
"styles": [
"solid",
"regular"
],
"label": "Face kiss",
"terms": [
"kiss",
"Face kiss",
"face-kiss"
]
},
"face-kiss-beam": {
"styles": [
"solid",
"regular"
],
"label": "Face Kiss Beam",
"terms": [
"kiss-beam",
"Face Kiss Beam",
"face-kiss-beam"
]
},
"face-kiss-wink-heart": {
"styles": [
"solid",
"regular"
],
"label": "Face Kiss Wink Heart",
"terms": [
"kiss-wink-heart",
"Face Kiss Wink Heart",
"face-kiss-wink-heart"
]
},
"face-laugh": {
"styles": [
"solid",
"regular"
],
"label": "Face Laugh",
"terms": [
"laugh",
"Face Laugh",
"face-laugh"
]
},
"face-laugh-beam": {
"styles": [
"solid",
"regular"
],
"label": "Face Laugh Beam",
"terms": [
"laugh-beam",
"Face Laugh Beam",
"face-laugh-beam"
]
},
"face-laugh-squint": {
"styles": [
"solid",
"regular"
],
"label": "Face Laugh Squint",
"terms": [
"laugh-squint",
"Face Laugh Squint",
"face-laugh-squint"
]
},
"face-laugh-wink": {
"styles": [
"solid",
"regular"
],
"label": "Face Laugh Wink",
"terms": [
"laugh-wink",
"Face Laugh Wink",
"face-laugh-wink"
]
},
"face-meh": {
"styles": [
"solid",
"regular"
],
"label": "Face meh",
"terms": [
"meh",
"Face meh",
"face-meh"
]
},
"face-meh-blank": {
"styles": [
"solid",
"regular"
],
"label": "Face Meh Blank",
"terms": [
"meh-blank",
"Face Meh Blank",
"face-meh-blank"
]
},
"face-rolling-eyes": {
"styles": [
"solid",
"regular"
],
"label": "Face Rolling Eyes",
"terms": [
"meh-rolling-eyes",
"Face Rolling Eyes",
"face-rolling-eyes"
]
},
"face-sad-cry": {
"styles": [
"solid",
"regular"
],
"label": "Face Sad Cry",
"terms": [
"sad-cry",
"Face Sad Cry",
"face-sad-cry"
]
},
"face-sad-tear": {
"styles": [
"solid",
"regular"
],
"label": "Face Sad Tear",
"terms": [
"sad-tear",
"Face Sad Tear",
"face-sad-tear"
]
},
"face-smile": {
"styles": [
"solid",
"regular"
],
"label": "Face Smile",
"terms": [
"smile",
"Face Smile",
"face-smile"
]
},
"face-smile-beam": {
"styles": [
"solid",
"regular"
],
"label": "Face Smile Beam",
"terms": [
"smile-beam",
"Face Smile Beam",
"face-smile-beam"
]
},
"face-smile-wink": {
"styles": [
"solid",
"regular"
],
"label": "Face Smile Wink",
"terms": [
"smile-wink",
"Face Smile Wink",
"face-smile-wink"
]
},
"face-surprise": {
"styles": [
"solid",
"regular"
],
"label": "Face Surprise",
"terms": [
"surprise",
"Face Surprise",
"face-surprise"
]
},
"face-tired": {
"styles": [
"solid",
"regular"
],
"label": "Face Tired",
"terms": [
"tired",
"Face Tired",
"face-tired"
]
},
"facebook": {
"styles": [
"brands"
],
"label": "Facebook",
"terms": [
"Facebook",
"facebook"
]
},
"facebook-f": {
"styles": [
"brands"
],
"label": "Facebook F",
"terms": [
"Facebook F",
"facebook-f"
]
},
"facebook-messenger": {
"styles": [
"brands"
],
"label": "Facebook Messenger",
"terms": [
"Facebook Messenger",
"facebook-messenger"
]
},
"fan": {
"styles": [
"solid"
],
"label": "Fan",
"terms": [
"Fan",
"fan"
]
},
"fantasy-flight-games": {
"styles": [
"brands"
],
"label": "Fantasy Flight-games",
"terms": [
"Fantasy Flight-games",
"fantasy-flight-games"
]
},
"faucet": {
"styles": [
"solid"
],
"label": "Faucet",
"terms": [
"Faucet",
"faucet"
]
},
"faucet-drip": {
"styles": [
"solid"
],
"label": "Faucet Drip",
"terms": [
"Faucet Drip",
"faucet-drip"
]
},
"fax": {
"styles": [
"solid"
],
"label": "Fax",
"terms": [
"Fax",
"fax"
]
},
"feather": {
"styles": [
"solid"
],
"label": "Feather",
"terms": [
"Feather",
"feather"
]
},
"feather-pointed": {
"styles": [
"solid"
],
"label": "Feather pointed",
"terms": [
"feather-alt",
"Feather pointed",
"feather-pointed"
]
},
"fedex": {
"styles": [
"brands"
],
"label": "FedEx",
"terms": [
"FedEx",
"fedex"
]
},
"fedora": {
"styles": [
"brands"
],
"label": "Fedora",
"terms": [
"Fedora",
"fedora"
]
},
"ferry": {
"styles": [
"solid"
],
"label": "Ferry",
"terms": [
"Ferry",
"ferry"
]
},
"figma": {
"styles": [
"brands"
],
"label": "Figma",
"terms": [
"Figma",
"figma"
]
},
"file": {
"styles": [
"solid",
"regular"
],
"label": "File",
"terms": [
"File",
"file"
]
},
"file-arrow-down": {
"styles": [
"solid"
],
"label": "File arrow down",
"terms": [
"file-download",
"File arrow down",
"file-arrow-down"
]
},
"file-arrow-up": {
"styles": [
"solid"
],
"label": "File arrow up",
"terms": [
"file-upload",
"File arrow up",
"file-arrow-up"
]
},
"file-audio": {
"styles": [
"solid",
"regular"
],
"label": "Audio File",
"terms": [
"Audio File",
"file-audio"
]
},
"file-circle-check": {
"styles": [
"solid"
],
"label": "File Circle-Check",
"terms": [
"File Circle-Check",
"file-circle-check"
]
},
"file-circle-exclamation": {
"styles": [
"solid"
],
"label": "File Circle-exclamation",
"terms": [
"File Circle-exclamation",
"file-circle-exclamation"
]
},
"file-circle-minus": {
"styles": [
"solid"
],
"label": "File Circle-minus",
"terms": [
"File Circle-minus",
"file-circle-minus"
]
},
"file-circle-plus": {
"styles": [
"solid"
],
"label": "File Circle-plus",
"terms": [
"File Circle-plus",
"file-circle-plus"
]
},
"file-circle-question": {
"styles": [
"solid"
],
"label": "File Circle-question",
"terms": [
"File Circle-question",
"file-circle-question"
]
},
"file-circle-xmark": {
"styles": [
"solid"
],
"label": "File Circle-xmark",
"terms": [
"File Circle-xmark",
"file-circle-xmark"
]
},
"file-code": {
"styles": [
"solid",
"regular"
],
"label": "Code File",
"terms": [
"Code File",
"file-code"
]
},
"file-contract": {
"styles": [
"solid"
],
"label": "File Contract",
"terms": [
"File Contract",
"file-contract"
]
},
"file-csv": {
"styles": [
"solid"
],
"label": "File CSV",
"terms": [
"File CSV",
"file-csv"
]
},
"file-excel": {
"styles": [
"solid",
"regular"
],
"label": "Excel File",
"terms": [
"Excel File",
"file-excel"
]
},
"file-export": {
"styles": [
"solid"
],
"label": "File Export",
"terms": [
"arrow-right-from-file",
"File Export",
"file-export"
]
},
"file-image": {
"styles": [
"solid",
"regular"
],
"label": "Image File",
"terms": [
"Image File",
"file-image"
]
},
"file-import": {
"styles": [
"solid"
],
"label": "File Import",
"terms": [
"arrow-right-to-file",
"File Import",
"file-import"
]
},
"file-invoice": {
"styles": [
"solid"
],
"label": "File Invoice",
"terms": [
"File Invoice",
"file-invoice"
]
},
"file-invoice-dollar": {
"styles": [
"solid"
],
"label": "File Invoice with US Dollar",
"terms": [
"File Invoice with US Dollar",
"file-invoice-dollar"
]
},
"file-lines": {
"styles": [
"solid",
"regular"
],
"label": "File lines",
"terms": [
"file-alt",
"file-text",
"File lines",
"file-lines"
]
},
"file-medical": {
"styles": [
"solid"
],
"label": "Medical File",
"terms": [
"Medical File",
"file-medical"
]
},
"file-pdf": {
"styles": [
"solid",
"regular"
],
"label": "PDF File",
"terms": [
"PDF File",
"file-pdf"
]
},
"file-pen": {
"styles": [
"solid"
],
"label": "File pen",
"terms": [
"file-edit",
"File pen",
"file-pen"
]
},
"file-powerpoint": {
"styles": [
"solid",
"regular"
],
"label": "Powerpoint File",
"terms": [
"Powerpoint File",
"file-powerpoint"
]
},
"file-prescription": {
"styles": [
"solid"
],
"label": "File Prescription",
"terms": [
"File Prescription",
"file-prescription"
]
},
"file-shield": {
"styles": [
"solid"
],
"label": "File Shield",
"terms": [
"File Shield",
"file-shield"
]
},
"file-signature": {
"styles": [
"solid"
],
"label": "File Signature",
"terms": [
"File Signature",
"file-signature"
]
},
"file-video": {
"styles": [
"solid",
"regular"
],
"label": "Video File",
"terms": [
"Video File",
"file-video"
]
},
"file-waveform": {
"styles": [
"solid"
],
"label": "File waveform",
"terms": [
"file-medical-alt",
"File waveform",
"file-waveform"
]
},
"file-word": {
"styles": [
"solid",
"regular"
],
"label": "Word File",
"terms": [
"Word File",
"file-word"
]
},
"file-zipper": {
"styles": [
"solid",
"regular"
],
"label": "File zipper",
"terms": [
"file-archive",
"File zipper",
"file-zipper"
]
},
"fill": {
"styles": [
"solid"
],
"label": "Fill",
"terms": [
"Fill",
"fill"
]
},
"fill-drip": {
"styles": [
"solid"
],
"label": "Fill Drip",
"terms": [
"Fill Drip",
"fill-drip"
]
},
"film": {
"styles": [
"solid"
],
"label": "Film",
"terms": [
"Film",
"film"
]
},
"filter": {
"styles": [
"solid"
],
"label": "Filter",
"terms": [
"Filter",
"filter"
]
},
"filter-circle-dollar": {
"styles": [
"solid"
],
"label": "Filter Circle Dollar",
"terms": [
"funnel-dollar",
"Filter Circle Dollar",
"filter-circle-dollar"
]
},
"filter-circle-xmark": {
"styles": [
"solid"
],
"label": "Filter Circle X Mark",
"terms": [
"Filter Circle X Mark",
"filter-circle-xmark"
]
},
"fingerprint": {
"styles": [
"solid"
],
"label": "Fingerprint",
"terms": [
"Fingerprint",
"fingerprint"
]
},
"fire": {
"styles": [
"solid"
],
"label": "fire",
"terms": [
"fire",
"fire"
]
},
"fire-burner": {
"styles": [
"solid"
],
"label": "Fire Burner",
"terms": [
"Fire Burner",
"fire-burner"
]
},
"fire-extinguisher": {
"styles": [
"solid"
],
"label": "fire-extinguisher",
"terms": [
"fire-extinguisher",
"fire-extinguisher"
]
},
"fire-flame-curved": {
"styles": [
"solid"
],
"label": "Fire flame curved",
"terms": [
"fire-alt",
"Fire flame curved",
"fire-flame-curved"
]
},
"fire-flame-simple": {
"styles": [
"solid"
],
"label": "Fire flame simple",
"terms": [
"burn",
"Fire flame simple",
"fire-flame-simple"
]
},
"firefox": {
"styles": [
"brands"
],
"label": "Firefox",
"terms": [
"Firefox",
"firefox"
]
},
"firefox-browser": {
"styles": [
"brands"
],
"label": "Firefox Browser",
"terms": [
"Firefox Browser",
"firefox-browser"
]
},
"first-order": {
"styles": [
"brands"
],
"label": "First Order",
"terms": [
"First Order",
"first-order"
]
},
"first-order-alt": {
"styles": [
"brands"
],
"label": "Alternate First Order",
"terms": [
"Alternate First Order",
"first-order-alt"
]
},
"firstdraft": {
"styles": [
"brands"
],
"label": "firstdraft",
"terms": [
"firstdraft",
"firstdraft"
]
},
"fish": {
"styles": [
"solid"
],
"label": "Fish",
"terms": [
"Fish",
"fish"
]
},
"fish-fins": {
"styles": [
"solid"
],
"label": "Fish Fins",
"terms": [
"Fish Fins",
"fish-fins"
]
},
"flag": {
"styles": [
"solid",
"regular"
],
"label": "flag",
"terms": [
"flag",
"flag"
]
},
"flag-checkered": {
"styles": [
"solid"
],
"label": "flag-checkered",
"terms": [
"flag-checkered",
"flag-checkered"
]
},
"flag-usa": {
"styles": [
"solid"
],
"label": "United States of America Flag",
"terms": [
"United States of America Flag",
"flag-usa"
]
},
"flask": {
"styles": [
"solid"
],
"label": "Flask",
"terms": [
"Flask",
"flask"
]
},
"flask-vial": {
"styles": [
"solid"
],
"label": "Flask and Vial",
"terms": [
"Flask and Vial",
"flask-vial"
]
},
"flickr": {
"styles": [
"brands"
],
"label": "Flickr",
"terms": [
"Flickr",
"flickr"
]
},
"flipboard": {
"styles": [
"brands"
],
"label": "Flipboard",
"terms": [
"Flipboard",
"flipboard"
]
},
"floppy-disk": {
"styles": [
"solid",
"regular"
],
"label": "Floppy Disk",
"terms": [
"save",
"Floppy Disk",
"floppy-disk"
]
},
"florin-sign": {
"styles": [
"solid"
],
"label": "Florin Sign",
"terms": [
"Florin Sign",
"florin-sign"
]
},
"fly": {
"styles": [
"brands"
],
"label": "Fly",
"terms": [
"Fly",
"fly"
]
},
"folder": {
"styles": [
"solid",
"regular"
],
"label": "Folder",
"terms": [
"folder-blank",
"Folder",
"folder"
]
},
"folder-closed": {
"styles": [
"solid",
"regular"
],
"label": "Folder Closed",
"terms": [
"Folder Closed",
"folder-closed"
]
},
"folder-minus": {
"styles": [
"solid"
],
"label": "Folder Minus",
"terms": [
"Folder Minus",
"folder-minus"
]
},
"folder-open": {
"styles": [
"solid",
"regular"
],
"label": "Folder Open",
"terms": [
"Folder Open",
"folder-open"
]
},
"folder-plus": {
"styles": [
"solid"
],
"label": "Folder Plus",
"terms": [
"Folder Plus",
"folder-plus"
]
},
"folder-tree": {
"styles": [
"solid"
],
"label": "Folder Tree",
"terms": [
"Folder Tree",
"folder-tree"
]
},
"font": {
"styles": [
"solid"
],
"label": "font",
"terms": [
"font",
"font"
]
},
"font-awesome": {
"styles": [
"solid",
"regular",
"brands"
],
"label": "Font Awesome",
"terms": [
"font-awesome-flag",
"font-awesome-logo-full",
"Font Awesome",
"font-awesome"
]
},
"fonticons": {
"styles": [
"brands"
],
"label": "Fonticons",
"terms": [
"Fonticons",
"fonticons"
]
},
"fonticons-fi": {
"styles": [
"brands"
],
"label": "Fonticons Fi",
"terms": [
"Fonticons Fi",
"fonticons-fi"
]
},
"football": {
"styles": [
"solid"
],
"label": "Football Ball",
"terms": [
"football-ball",
"Football Ball",
"football"
]
},
"fort-awesome": {
"styles": [
"brands"
],
"label": "Fort Awesome",
"terms": [
"Fort Awesome",
"fort-awesome"
]
},
"fort-awesome-alt": {
"styles": [
"brands"
],
"label": "Alternate Fort Awesome",
"terms": [
"Alternate Fort Awesome",
"fort-awesome-alt"
]
},
"forumbee": {
"styles": [
"brands"
],
"label": "Forumbee",
"terms": [
"Forumbee",
"forumbee"
]
},
"forward": {
"styles": [
"solid"
],
"label": "forward",
"terms": [
"forward",
"forward"
]
},
"forward-fast": {
"styles": [
"solid"
],
"label": "Forward fast",
"terms": [
"fast-forward",
"Forward fast",
"forward-fast"
]
},
"forward-step": {
"styles": [
"solid"
],
"label": "Forward step",
"terms": [
"step-forward",
"Forward step",
"forward-step"
]
},
"foursquare": {
"styles": [
"brands"
],
"label": "Foursquare",
"terms": [
"Foursquare",
"foursquare"
]
},
"franc-sign": {
"styles": [
"solid"
],
"label": "Franc Sign",
"terms": [
"Franc Sign",
"franc-sign"
]
},
"free-code-camp": {
"styles": [
"brands"
],
"label": "freeCodeCamp",
"terms": [
"freeCodeCamp",
"free-code-camp"
]
},
"freebsd": {
"styles": [
"brands"
],
"label": "FreeBSD",
"terms": [
"FreeBSD",
"freebsd"
]
},
"frog": {
"styles": [
"solid"
],
"label": "Frog",
"terms": [
"Frog",
"frog"
]
},
"fulcrum": {
"styles": [
"brands"
],
"label": "Fulcrum",
"terms": [
"Fulcrum",
"fulcrum"
]
},
"futbol": {
"styles": [
"solid",
"regular"
],
"label": "Futbol ball",
"terms": [
"futbol-ball",
"soccer-ball",
"Futbol ball",
"futbol"
]
},
"g": {
"styles": [
"solid"
],
"label": "G",
"terms": [
"G",
"g"
]
},
"galactic-republic": {
"styles": [
"brands"
],
"label": "Galactic Republic",
"terms": [
"Galactic Republic",
"galactic-republic"
]
},
"galactic-senate": {
"styles": [
"brands"
],
"label": "Galactic Senate",
"terms": [
"Galactic Senate",
"galactic-senate"
]
},
"gamepad": {
"styles": [
"solid"
],
"label": "Gamepad",
"terms": [
"Gamepad",
"gamepad"
]
},
"gas-pump": {
"styles": [
"solid"
],
"label": "Gas Pump",
"terms": [
"Gas Pump",
"gas-pump"
]
},
"gauge": {
"styles": [
"solid"
],
"label": "Gauge med",
"terms": [
"dashboard",
"gauge-med",
"tachometer-alt-average",
"Gauge med",
"gauge"
]
},
"gauge-high": {
"styles": [
"solid"
],
"label": "Gauge",
"terms": [
"tachometer-alt",
"tachometer-alt-fast",
"Gauge",
"gauge-high"
]
},
"gauge-simple": {
"styles": [
"solid"
],
"label": "Gauge simple med",
"terms": [
"gauge-simple-med",
"tachometer-average",
"Gauge simple med",
"gauge-simple"
]
},
"gauge-simple-high": {
"styles": [
"solid"
],
"label": "Gauge simple",
"terms": [
"tachometer",
"tachometer-fast",
"Gauge simple",
"gauge-simple-high"
]
},
"gavel": {
"styles": [
"solid"
],
"label": "Gavel",
"terms": [
"legal",
"Gavel",
"gavel"
]
},
"gear": {
"styles": [
"solid"
],
"label": "Gear",
"terms": [
"cog",
"Gear",
"gear"
]
},
"gears": {
"styles": [
"solid"
],
"label": "Gears",
"terms": [
"cogs",
"Gears",
"gears"
]
},
"gem": {
"styles": [
"solid",
"regular"
],
"label": "Gem",
"terms": [
"Gem",
"gem"
]
},
"genderless": {
"styles": [
"solid"
],
"label": "Genderless",
"terms": [
"Genderless",
"genderless"
]
},
"get-pocket": {
"styles": [
"brands"
],
"label": "Get Pocket",
"terms": [
"Get Pocket",
"get-pocket"
]
},
"gg": {
"styles": [
"brands"
],
"label": "GG Currency",
"terms": [
"GG Currency",
"gg"
]
},
"gg-circle": {
"styles": [
"brands"
],
"label": "GG Currency Circle",
"terms": [
"GG Currency Circle",
"gg-circle"
]
},
"ghost": {
"styles": [
"solid"
],
"label": "Ghost",
"terms": [
"Ghost",
"ghost"
]
},
"gift": {
"styles": [
"solid"
],
"label": "gift",
"terms": [
"gift",
"gift"
]
},
"gifts": {
"styles": [
"solid"
],
"label": "Gifts",
"terms": [
"Gifts",
"gifts"
]
},
"git": {
"styles": [
"brands"
],
"label": "Git",
"terms": [
"Git",
"git"
]
},
"git-alt": {
"styles": [
"brands"
],
"label": "Git Alt",
"terms": [
"Git Alt",
"git-alt"
]
},
"github": {
"styles": [
"brands"
],
"label": "GitHub",
"terms": [
"GitHub",
"github"
]
},
"github-alt": {
"styles": [
"brands"
],
"label": "Alternate GitHub",
"terms": [
"Alternate GitHub",
"github-alt"
]
},
"gitkraken": {
"styles": [
"brands"
],
"label": "GitKraken",
"terms": [
"GitKraken",
"gitkraken"
]
},
"gitlab": {
"styles": [
"brands"
],
"label": "GitLab",
"terms": [
"GitLab",
"gitlab"
]
},
"gitter": {
"styles": [
"brands"
],
"label": "Gitter",
"terms": [
"Gitter",
"gitter"
]
},
"glass-water": {
"styles": [
"solid"
],
"label": "Glass Water",
"terms": [
"Glass Water",
"glass-water"
]
},
"glass-water-droplet": {
"styles": [
"solid"
],
"label": "Glass Water-droplet",
"terms": [
"Glass Water-droplet",
"glass-water-droplet"
]
},
"glasses": {
"styles": [
"solid"
],
"label": "Glasses",
"terms": [
"Glasses",
"glasses"
]
},
"glide": {
"styles": [
"brands"
],
"label": "Glide",
"terms": [
"Glide",
"glide"
]
},
"glide-g": {
"styles": [
"brands"
],
"label": "Glide G",
"terms": [
"Glide G",
"glide-g"
]
},
"globe": {
"styles": [
"solid"
],
"label": "Globe",
"terms": [
"Globe",
"globe"
]
},
"gofore": {
"styles": [
"brands"
],
"label": "Gofore",
"terms": [
"Gofore",
"gofore"
]
},
"golang": {
"styles": [
"brands"
],
"label": "Go",
"terms": [
"Go",
"golang"
]
},
"golf-ball-tee": {
"styles": [
"solid"
],
"label": "Golf ball tee",
"terms": [
"golf-ball",
"Golf ball tee",
"golf-ball-tee"
]
},
"goodreads": {
"styles": [
"brands"
],
"label": "Goodreads",
"terms": [
"Goodreads",
"goodreads"
]
},
"goodreads-g": {
"styles": [
"brands"
],
"label": "Goodreads G",
"terms": [
"Goodreads G",
"goodreads-g"
]
},
"google": {
"styles": [
"brands"
],
"label": "Google Logo",
"terms": [
"Google Logo",
"google"
]
},
"google-drive": {
"styles": [
"brands"
],
"label": "Google Drive",
"terms": [
"Google Drive",
"google-drive"
]
},
"google-pay": {
"styles": [
"brands"
],
"label": "Google Pay",
"terms": [
"Google Pay",
"google-pay"
]
},
"google-play": {
"styles": [
"brands"
],
"label": "Google Play",
"terms": [
"Google Play",
"google-play"
]
},
"google-plus": {
"styles": [
"brands"
],
"label": "Google Plus",
"terms": [
"Google Plus",
"google-plus"
]
},
"google-plus-g": {
"styles": [
"brands"
],
"label": "Google Plus G",
"terms": [
"Google Plus G",
"google-plus-g"
]
},
"google-wallet": {
"styles": [
"brands"
],
"label": "Google Wallet",
"terms": [
"Google Wallet",
"google-wallet"
]
},
"gopuram": {
"styles": [
"solid"
],
"label": "Gopuram",
"terms": [
"Gopuram",
"gopuram"
]
},
"graduation-cap": {
"styles": [
"solid"
],
"label": "Graduation Cap",
"terms": [
"mortar-board",
"Graduation Cap",
"graduation-cap"
]
},
"gratipay": {
"styles": [
"brands"
],
"label": "Gratipay (Gittip)",
"terms": [
"Gratipay (Gittip)",
"gratipay"
]
},
"grav": {
"styles": [
"brands"
],
"label": "Grav",
"terms": [
"Grav",
"grav"
]
},
"greater-than": {
"styles": [
"solid"
],
"label": "Greater Than",
"terms": [
"Greater Than",
"greater-than"
]
},
"greater-than-equal": {
"styles": [
"solid"
],
"label": "Greater Than Equal To",
"terms": [
"Greater Than Equal To",
"greater-than-equal"
]
},
"grip": {
"styles": [
"solid"
],
"label": "Grip",
"terms": [
"grip-horizontal",
"Grip",
"grip"
]
},
"grip-lines": {
"styles": [
"solid"
],
"label": "Grip Lines",
"terms": [
"Grip Lines",
"grip-lines"
]
},
"grip-lines-vertical": {
"styles": [
"solid"
],
"label": "Grip Lines Vertical",
"terms": [
"Grip Lines Vertical",
"grip-lines-vertical"
]
},
"grip-vertical": {
"styles": [
"solid"
],
"label": "Grip Vertical",
"terms": [
"Grip Vertical",
"grip-vertical"
]
},
"gripfire": {
"styles": [
"brands"
],
"label": "Gripfire, Inc.",
"terms": [
"Gripfire, Inc.",
"gripfire"
]
},
"group-arrows-rotate": {
"styles": [
"solid"
],
"label": "Group Arrows-rotate",
"terms": [
"Group Arrows-rotate",
"group-arrows-rotate"
]
},
"grunt": {
"styles": [
"brands"
],
"label": "Grunt",
"terms": [
"Grunt",
"grunt"
]
},
"guarani-sign": {
"styles": [
"solid"
],
"label": "Guarani Sign",
"terms": [
"Guarani Sign",
"guarani-sign"
]
},
"guilded": {
"styles": [
"brands"
],
"label": "Guilded",
"terms": [
"Guilded",
"guilded"
]
},
"guitar": {
"styles": [
"solid"
],
"label": "Guitar",
"terms": [
"Guitar",
"guitar"
]
},
"gulp": {
"styles": [
"brands"
],
"label": "Gulp",
"terms": [
"Gulp",
"gulp"
]
},
"gun": {
"styles": [
"solid"
],
"label": "Gun",
"terms": [
"Gun",
"gun"
]
},
"h": {
"styles": [
"solid"
],
"label": "H",
"terms": [
"H",
"h"
]
},
"hacker-news": {
"styles": [
"brands"
],
"label": "Hacker News",
"terms": [
"Hacker News",
"hacker-news"
]
},
"hackerrank": {
"styles": [
"brands"
],
"label": "Hackerrank",
"terms": [
"Hackerrank",
"hackerrank"
]
},
"hammer": {
"styles": [
"solid"
],
"label": "Hammer",
"terms": [
"Hammer",
"hammer"
]
},
"hamsa": {
"styles": [
"solid"
],
"label": "Hamsa",
"terms": [
"Hamsa",
"hamsa"
]
},
"hand": {
"styles": [
"solid",
"regular"
],
"label": "Paper (Hand)",
"terms": [
"hand-paper",
"Paper (Hand)",
"hand"
]
},
"hand-back-fist": {
"styles": [
"solid",
"regular"
],
"label": "Rock (Hand)",
"terms": [
"hand-rock",
"Rock (Hand)",
"hand-back-fist"
]
},
"hand-dots": {
"styles": [
"solid"
],
"label": "Hand dots",
"terms": [
"allergies",
"Hand dots",
"hand-dots"
]
},
"hand-fist": {
"styles": [
"solid"
],
"label": "Raised Fist",
"terms": [
"fist-raised",
"Raised Fist",
"hand-fist"
]
},
"hand-holding": {
"styles": [
"solid"
],
"label": "Hand Holding",
"terms": [
"Hand Holding",
"hand-holding"
]
},
"hand-holding-dollar": {
"styles": [
"solid"
],
"label": "Hand holding dollar",
"terms": [
"hand-holding-usd",
"Hand holding dollar",
"hand-holding-dollar"
]
},
"hand-holding-droplet": {
"styles": [
"solid"
],
"label": "Hand holding droplet",
"terms": [
"hand-holding-water",
"Hand holding droplet",
"hand-holding-droplet"
]
},
"hand-holding-hand": {
"styles": [
"solid"
],
"label": "Hand Holding-hand",
"terms": [
"Hand Holding-hand",
"hand-holding-hand"
]
},
"hand-holding-heart": {
"styles": [
"solid"
],
"label": "Hand Holding Heart",
"terms": [
"Hand Holding Heart",
"hand-holding-heart"
]
},
"hand-holding-medical": {
"styles": [
"solid"
],
"label": "Hand Holding Medical Cross",
"terms": [
"Hand Holding Medical Cross",
"hand-holding-medical"
]
},
"hand-lizard": {
"styles": [
"solid",
"regular"
],
"label": "Lizard (Hand)",
"terms": [
"Lizard (Hand)",
"hand-lizard"
]
},
"hand-middle-finger": {
"styles": [
"solid"
],
"label": "Hand with Middle Finger Raised",
"terms": [
"Hand with Middle Finger Raised",
"hand-middle-finger"
]
},
"hand-peace": {
"styles": [
"solid",
"regular"
],
"label": "Peace (Hand)",
"terms": [
"Peace (Hand)",
"hand-peace"
]
},
"hand-point-down": {
"styles": [
"solid",
"regular"
],
"label": "Hand Pointing Down",
"terms": [
"Hand Pointing Down",
"hand-point-down"
]
},
"hand-point-left": {
"styles": [
"solid",
"regular"
],
"label": "Hand Pointing Left",
"terms": [
"Hand Pointing Left",
"hand-point-left"
]
},
"hand-point-right": {
"styles": [
"solid",
"regular"
],
"label": "Hand Pointing Right",
"terms": [
"Hand Pointing Right",
"hand-point-right"
]
},
"hand-point-up": {
"styles": [
"solid",
"regular"
],
"label": "Hand Pointing Up",
"terms": [
"Hand Pointing Up",
"hand-point-up"
]
},
"hand-pointer": {
"styles": [
"solid",
"regular"
],
"label": "Pointer (Hand)",
"terms": [
"Pointer (Hand)",
"hand-pointer"
]
},
"hand-scissors": {
"styles": [
"solid",
"regular"
],
"label": "Scissors (Hand)",
"terms": [
"Scissors (Hand)",
"hand-scissors"
]
},
"hand-sparkles": {
"styles": [
"solid"
],
"label": "Hand Sparkles",
"terms": [
"Hand Sparkles",
"hand-sparkles"
]
},
"hand-spock": {
"styles": [
"solid",
"regular"
],
"label": "Spock (Hand)",
"terms": [
"Spock (Hand)",
"hand-spock"
]
},
"handcuffs": {
"styles": [
"solid"
],
"label": "Handcuffs",
"terms": [
"Handcuffs",
"handcuffs"
]
},
"hands": {
"styles": [
"solid"
],
"label": "Hands",
"terms": [
"sign-language",
"signing",
"Hands",
"hands"
]
},
"hands-asl-interpreting": {
"styles": [
"solid"
],
"label": "Hands american sign language interpreting",
"terms": [
"american-sign-language-interpreting",
"asl-interpreting",
"hands-american-sign-language-interpreting",
"Hands american sign language interpreting",
"hands-asl-interpreting"
]
},
"hands-bound": {
"styles": [
"solid"
],
"label": "Hands Bound",
"terms": [
"Hands Bound",
"hands-bound"
]
},
"hands-bubbles": {
"styles": [
"solid"
],
"label": "Hands bubbles",
"terms": [
"hands-wash",
"Hands bubbles",
"hands-bubbles"
]
},
"hands-clapping": {
"styles": [
"solid"
],
"label": "Hands Clapping",
"terms": [
"Hands Clapping",
"hands-clapping"
]
},
"hands-holding": {
"styles": [
"solid"
],
"label": "Hands holding",
"terms": [
"Hands holding",
"hands-holding"
]
},
"hands-holding-child": {
"styles": [
"solid"
],
"label": "Hands Holding-child",
"terms": [
"Hands Holding-child",
"hands-holding-child"
]
},
"hands-holding-circle": {
"styles": [
"solid"
],
"label": "Hands Holding-circle",
"terms": [
"Hands Holding-circle",
"hands-holding-circle"
]
},
"hands-praying": {
"styles": [
"solid"
],
"label": "Hands praying",
"terms": [
"praying-hands",
"Hands praying",
"hands-praying"
]
},
"handshake": {
"styles": [
"solid",
"regular"
],
"label": "Handshake",
"terms": [
"Handshake",
"handshake"
]
},
"handshake-angle": {
"styles": [
"solid"
],
"label": "Handshake angle",
"terms": [
"hands-helping",
"Handshake angle",
"handshake-angle"
]
},
"handshake-simple": {
"styles": [
"solid"
],
"label": "Handshake simple",
"terms": [
"handshake-alt",
"Handshake simple",
"handshake-simple"
]
},
"handshake-simple-slash": {
"styles": [
"solid"
],
"label": "Handshake simple slash",
"terms": [
"handshake-alt-slash",
"Handshake simple slash",
"handshake-simple-slash"
]
},
"handshake-slash": {
"styles": [
"solid"
],
"label": "Handshake Slash",
"terms": [
"Handshake Slash",
"handshake-slash"
]
},
"hanukiah": {
"styles": [
"solid"
],
"label": "Hanukiah",
"terms": [
"Hanukiah",
"hanukiah"
]
},
"hard-drive": {
"styles": [
"solid",
"regular"
],
"label": "Hard drive",
"terms": [
"hdd",
"Hard drive",
"hard-drive"
]
},
"hashnode": {
"styles": [
"brands"
],
"label": "Hashnode",
"terms": [
"Hashnode",
"hashnode"
]
},
"hashtag": {
"styles": [
"solid"
],
"label": "Hashtag",
"terms": [
"Hashtag",
"hashtag"
]
},
"hat-cowboy": {
"styles": [
"solid"
],
"label": "Cowboy Hat",
"terms": [
"Cowboy Hat",
"hat-cowboy"
]
},
"hat-cowboy-side": {
"styles": [
"solid"
],
"label": "Cowboy Hat Side",
"terms": [
"Cowboy Hat Side",
"hat-cowboy-side"
]
},
"hat-wizard": {
"styles": [
"solid"
],
"label": "Wizard's Hat",
"terms": [
"Wizard's Hat",
"hat-wizard"
]
},
"head-side-cough": {
"styles": [
"solid"
],
"label": "Head Side Cough",
"terms": [
"Head Side Cough",
"head-side-cough"
]
},
"head-side-cough-slash": {
"styles": [
"solid"
],
"label": "Head Side-cough-slash",
"terms": [
"Head Side-cough-slash",
"head-side-cough-slash"
]
},
"head-side-mask": {
"styles": [
"solid"
],
"label": "Head Side Mask",
"terms": [
"Head Side Mask",
"head-side-mask"
]
},
"head-side-virus": {
"styles": [
"solid"
],
"label": "Head Side Virus",
"terms": [
"Head Side Virus",
"head-side-virus"
]
},
"heading": {
"styles": [
"solid"
],
"label": "heading",
"terms": [
"header",
"heading",
"heading"
]
},
"headphones": {
"styles": [
"solid"
],
"label": "headphones",
"terms": [
"headphones",
"headphones"
]
},
"headphones-simple": {
"styles": [
"solid"
],
"label": "Headphones simple",
"terms": [
"headphones-alt",
"Headphones simple",
"headphones-simple"
]
},
"headset": {
"styles": [
"solid"
],
"label": "Headset",
"terms": [
"Headset",
"headset"
]
},
"heart": {
"styles": [
"solid",
"regular"
],
"label": "Heart",
"terms": [
"Heart",
"heart"
]
},
"heart-circle-bolt": {
"styles": [
"solid"
],
"label": "Heart Circle-bolt",
"terms": [
"Heart Circle-bolt",
"heart-circle-bolt"
]
},
"heart-circle-check": {
"styles": [
"solid"
],
"label": "Heart Circle-check",
"terms": [
"Heart Circle-check",
"heart-circle-check"
]
},
"heart-circle-exclamation": {
"styles": [
"solid"
],
"label": "Heart Circle-exclamation",
"terms": [
"Heart Circle-exclamation",
"heart-circle-exclamation"
]
},
"heart-circle-minus": {
"styles": [
"solid"
],
"label": "Heart Circle-minus",
"terms": [
"Heart Circle-minus",
"heart-circle-minus"
]
},
"heart-circle-plus": {
"styles": [
"solid"
],
"label": "Heart Circle-plus",
"terms": [
"Heart Circle-plus",
"heart-circle-plus"
]
},
"heart-circle-xmark": {
"styles": [
"solid"
],
"label": "Heart Circle-xmark",
"terms": [
"Heart Circle-xmark",
"heart-circle-xmark"
]
},
"heart-crack": {
"styles": [
"solid"
],
"label": "Heart crack",
"terms": [
"heart-broken",
"Heart crack",
"heart-crack"
]
},
"heart-pulse": {
"styles": [
"solid"
],
"label": "Heart pulse",
"terms": [
"heartbeat",
"Heart pulse",
"heart-pulse"
]
},
"helicopter": {
"styles": [
"solid"
],
"label": "Helicopter",
"terms": [
"Helicopter",
"helicopter"
]
},
"helicopter-symbol": {
"styles": [
"solid"
],
"label": "Helicopter Symbol",
"terms": [
"Helicopter Symbol",
"helicopter-symbol"
]
},
"helmet-safety": {
"styles": [
"solid"
],
"label": "Helmet safety",
"terms": [
"hard-hat",
"hat-hard",
"Helmet safety",
"helmet-safety"
]
},
"helmet-un": {
"styles": [
"solid"
],
"label": "Helmet Un",
"terms": [
"Helmet Un",
"helmet-un"
]
},
"highlighter": {
"styles": [
"solid"
],
"label": "Highlighter",
"terms": [
"Highlighter",
"highlighter"
]
},
"hill-avalanche": {
"styles": [
"solid"
],
"label": "Hill Avalanche",
"terms": [
"Hill Avalanche",
"hill-avalanche"
]
},
"hill-rockslide": {
"styles": [
"solid"
],
"label": "Hill Rockslide",
"terms": [
"Hill Rockslide",
"hill-rockslide"
]
},
"hippo": {
"styles": [
"solid"
],
"label": "Hippo",
"terms": [
"Hippo",
"hippo"
]
},
"hips": {
"styles": [
"brands"
],
"label": "Hips",
"terms": [
"Hips",
"hips"
]
},
"hire-a-helper": {
"styles": [
"brands"
],
"label": "HireAHelper",
"terms": [
"HireAHelper",
"hire-a-helper"
]
},
"hive": {
"styles": [
"brands"
],
"label": "Hive Blockchain Network",
"terms": [
"Hive Blockchain Network",
"hive"
]
},
"hockey-puck": {
"styles": [
"solid"
],
"label": "Hockey Puck",
"terms": [
"Hockey Puck",
"hockey-puck"
]
},
"holly-berry": {
"styles": [
"solid"
],
"label": "Holly Berry",
"terms": [
"Holly Berry",
"holly-berry"
]
},
"hooli": {
"styles": [
"brands"
],
"label": "Hooli",
"terms": [
"Hooli",
"hooli"
]
},
"hornbill": {
"styles": [
"brands"
],
"label": "Hornbill",
"terms": [
"Hornbill",
"hornbill"
]
},
"horse": {
"styles": [
"solid"
],
"label": "Horse",
"terms": [
"Horse",
"horse"
]
},
"horse-head": {
"styles": [
"solid"
],
"label": "Horse Head",
"terms": [
"Horse Head",
"horse-head"
]
},
"hospital": {
"styles": [
"solid",
"regular"
],
"label": "hospital",
"terms": [
"hospital-alt",
"hospital-wide",
"hospital",
"hospital"
]
},
"hospital-user": {
"styles": [
"solid"
],
"label": "Hospital with User",
"terms": [
"Hospital with User",
"hospital-user"
]
},
"hot-tub-person": {
"styles": [
"solid"
],
"label": "Hot tub person",
"terms": [
"hot-tub",
"Hot tub person",
"hot-tub-person"
]
},
"hotdog": {
"styles": [
"solid"
],
"label": "Hot Dog",
"terms": [
"Hot Dog",
"hotdog"
]
},
"hotel": {
"styles": [
"solid"
],
"label": "Hotel",
"terms": [
"Hotel",
"hotel"
]
},
"hotjar": {
"styles": [
"brands"
],
"label": "Hotjar",
"terms": [
"Hotjar",
"hotjar"
]
},
"hourglass": {
"styles": [
"solid",
"regular"
],
"label": "Hourglass",
"terms": [
"hourglass-empty",
"Hourglass",
"hourglass"
]
},
"hourglass-end": {
"styles": [
"solid"
],
"label": "Hourglass End",
"terms": [
"hourglass-3",
"Hourglass End",
"hourglass-end"
]
},
"hourglass-half": {
"styles": [
"solid",
"regular"
],
"label": "Hourglass Half",
"terms": [
"hourglass-2",
"Hourglass Half",
"hourglass-half"
]
},
"hourglass-start": {
"styles": [
"solid"
],
"label": "Hourglass Start",
"terms": [
"hourglass-1",
"Hourglass Start",
"hourglass-start"
]
},
"house": {
"styles": [
"solid"
],
"label": "House",
"terms": [
"home",
"home-alt",
"home-lg-alt",
"House",
"house"
]
},
"house-chimney": {
"styles": [
"solid"
],
"label": "House Chimney",
"terms": [
"home-lg",
"House Chimney",
"house-chimney"
]
},
"house-chimney-crack": {
"styles": [
"solid"
],
"label": "House crack",
"terms": [
"house-damage",
"House crack",
"house-chimney-crack"
]
},
"house-chimney-medical": {
"styles": [
"solid"
],
"label": "House medical",
"terms": [
"clinic-medical",
"House medical",
"house-chimney-medical"
]
},
"house-chimney-user": {
"styles": [
"solid"
],
"label": "House User",
"terms": [
"House User",
"house-chimney-user"
]
},
"house-chimney-window": {
"styles": [
"solid"
],
"label": "House with Window + Chimney",
"terms": [
"House with Window + Chimney",
"house-chimney-window"
]
},
"house-circle-check": {
"styles": [
"solid"
],
"label": "House Circle-check",
"terms": [
"House Circle-check",
"house-circle-check"
]
},
"house-circle-exclamation": {
"styles": [
"solid"
],
"label": "House Circle-exclamation",
"terms": [
"House Circle-exclamation",
"house-circle-exclamation"
]
},
"house-circle-xmark": {
"styles": [
"solid"
],
"label": "House Circle-xmark",
"terms": [
"House Circle-xmark",
"house-circle-xmark"
]
},
"house-crack": {
"styles": [
"solid"
],
"label": "House Simple Crack",
"terms": [
"House Simple Crack",
"house-crack"
]
},
"house-fire": {
"styles": [
"solid"
],
"label": "House Fire",
"terms": [
"House Fire",
"house-fire"
]
},
"house-flag": {
"styles": [
"solid"
],
"label": "House Flag",
"terms": [
"House Flag",
"house-flag"
]
},
"house-flood-water": {
"styles": [
"solid"
],
"label": "House Flood",
"terms": [
"House Flood",
"house-flood-water"
]
},
"house-flood-water-circle-arrow-right": {
"styles": [
"solid"
],
"label": "House Flood-circle-arrow-right",
"terms": [
"House Flood-circle-arrow-right",
"house-flood-water-circle-arrow-right"
]
},
"house-laptop": {
"styles": [
"solid"
],
"label": "House laptop",
"terms": [
"laptop-house",
"House laptop",
"house-laptop"
]
},
"house-lock": {
"styles": [
"solid"
],
"label": "House Lock",
"terms": [
"House Lock",
"house-lock"
]
},
"house-medical": {
"styles": [
"solid"
],
"label": "House Simple Medical",
"terms": [
"House Simple Medical",
"house-medical"
]
},
"house-medical-circle-check": {
"styles": [
"solid"
],
"label": "House Medical-circle-check",
"terms": [
"House Medical-circle-check",
"house-medical-circle-check"
]
},
"house-medical-circle-exclamation": {
"styles": [
"solid"
],
"label": "House Medical-circle-exclamation",
"terms": [
"House Medical-circle-exclamation",
"house-medical-circle-exclamation"
]
},
"house-medical-circle-xmark": {
"styles": [
"solid"
],
"label": "House Medical-circle-xmark",
"terms": [
"House Medical-circle-xmark",
"house-medical-circle-xmark"
]
},
"house-medical-flag": {
"styles": [
"solid"
],
"label": "House Medical-flag",
"terms": [
"House Medical-flag",
"house-medical-flag"
]
},
"house-signal": {
"styles": [
"solid"
],
"label": "House Signal",
"terms": [
"House Signal",
"house-signal"
]
},
"house-tsunami": {
"styles": [
"solid"
],
"label": "House Tsunami",
"terms": [
"House Tsunami",
"house-tsunami"
]
},
"house-user": {
"styles": [
"solid"
],
"label": "Home User",
"terms": [
"home-user",
"Home User",
"house-user"
]
},
"houzz": {
"styles": [
"brands"
],
"label": "Houzz",
"terms": [
"Houzz",
"houzz"
]
},
"hryvnia-sign": {
"styles": [
"solid"
],
"label": "Hryvnia sign",
"terms": [
"hryvnia",
"Hryvnia sign",
"hryvnia-sign"
]
},
"html5": {
"styles": [
"brands"
],
"label": "HTML 5 Logo",
"terms": [
"HTML 5 Logo",
"html5"
]
},
"hubspot": {
"styles": [
"brands"
],
"label": "HubSpot",
"terms": [
"HubSpot",
"hubspot"
]
},
"hurricane": {
"styles": [
"solid"
],
"label": "Hurricane",
"terms": [
"Hurricane",
"hurricane"
]
},
"i": {
"styles": [
"solid"
],
"label": "I",
"terms": [
"I",
"i"
]
},
"i-cursor": {
"styles": [
"solid"
],
"label": "I Beam Cursor",
"terms": [
"I Beam Cursor",
"i-cursor"
]
},
"ice-cream": {
"styles": [
"solid"
],
"label": "Ice Cream",
"terms": [
"Ice Cream",
"ice-cream"
]
},
"icicles": {
"styles": [
"solid"
],
"label": "Icicles",
"terms": [
"Icicles",
"icicles"
]
},
"icons": {
"styles": [
"solid"
],
"label": "Icons",
"terms": [
"heart-music-camera-bolt",
"Icons",
"icons"
]
},
"id-badge": {
"styles": [
"solid",
"regular"
],
"label": "Identification Badge",
"terms": [
"Identification Badge",
"id-badge"
]
},
"id-card": {
"styles": [
"solid",
"regular"
],
"label": "Identification Card",
"terms": [
"drivers-license",
"Identification Card",
"id-card"
]
},
"id-card-clip": {
"styles": [
"solid"
],
"label": "Id card clip",
"terms": [
"id-card-alt",
"Id card clip",
"id-card-clip"
]
},
"ideal": {
"styles": [
"brands"
],
"label": "iDeal",
"terms": [
"iDeal",
"ideal"
]
},
"igloo": {
"styles": [
"solid"
],
"label": "Igloo",
"terms": [
"Igloo",
"igloo"
]
},
"image": {
"styles": [
"solid",
"regular"
],
"label": "Image",
"terms": [
"Image",
"image"
]
},
"image-portrait": {
"styles": [
"solid"
],
"label": "Image portrait",
"terms": [
"portrait",
"Image portrait",
"image-portrait"
]
},
"images": {
"styles": [
"solid",
"regular"
],
"label": "Images",
"terms": [
"Images",
"images"
]
},
"imdb": {
"styles": [
"brands"
],
"label": "IMDB",
"terms": [
"IMDB",
"imdb"
]
},
"inbox": {
"styles": [
"solid"
],
"label": "inbox",
"terms": [
"inbox",
"inbox"
]
},
"indent": {
"styles": [
"solid"
],
"label": "Indent",
"terms": [
"Indent",
"indent"
]
},
"indian-rupee-sign": {
"styles": [
"solid"
],
"label": "Indian Rupee-sign",
"terms": [
"indian-rupee",
"inr",
"Indian Rupee-sign",
"indian-rupee-sign"
]
},
"industry": {
"styles": [
"solid"
],
"label": "Industry",
"terms": [
"Industry",
"industry"
]
},
"infinity": {
"styles": [
"solid"
],
"label": "Infinity",
"terms": [
"Infinity",
"infinity"
]
},
"info": {
"styles": [
"solid"
],
"label": "Info",
"terms": [
"Info",
"info"
]
},
"instagram": {
"styles": [
"brands"
],
"label": "Instagram",
"terms": [
"Instagram",
"instagram"
]
},
"instalod": {
"styles": [
"brands"
],
"label": "InstaLOD",
"terms": [
"InstaLOD",
"instalod"
]
},
"intercom": {
"styles": [
"brands"
],
"label": "Intercom",
"terms": [
"Intercom",
"intercom"
]
},
"internet-explorer": {
"styles": [
"brands"
],
"label": "Internet-explorer",
"terms": [
"Internet-explorer",
"internet-explorer"
]
},
"invision": {
"styles": [
"brands"
],
"label": "InVision",
"terms": [
"InVision",
"invision"
]
},
"ioxhost": {
"styles": [
"brands"
],
"label": "ioxhost",
"terms": [
"ioxhost",
"ioxhost"
]
},
"italic": {
"styles": [
"solid"
],
"label": "italic",
"terms": [
"italic",
"italic"
]
},
"itch-io": {
"styles": [
"brands"
],
"label": "itch.io",
"terms": [
"itch.io",
"itch-io"
]
},
"itunes": {
"styles": [
"brands"
],
"label": "iTunes",
"terms": [
"iTunes",
"itunes"
]
},
"itunes-note": {
"styles": [
"brands"
],
"label": "Itunes Note",
"terms": [
"Itunes Note",
"itunes-note"
]
},
"j": {
"styles": [
"solid"
],
"label": "J",
"terms": [
"J",
"j"
]
},
"jar": {
"styles": [
"solid"
],
"label": "Jar",
"terms": [
"Jar",
"jar"
]
},
"jar-wheat": {
"styles": [
"solid"
],
"label": "Jar Wheat",
"terms": [
"Jar Wheat",
"jar-wheat"
]
},
"java": {
"styles": [
"brands"
],
"label": "Java",
"terms": [
"Java",
"java"
]
},
"jedi": {
"styles": [
"solid"
],
"label": "Jedi",
"terms": [
"Jedi",
"jedi"
]
},
"jedi-order": {
"styles": [
"brands"
],
"label": "Jedi Order",
"terms": [
"Jedi Order",
"jedi-order"
]
},
"jenkins": {
"styles": [
"brands"
],
"label": "Jenkis",
"terms": [
"Jenkis",
"jenkins"
]
},
"jet-fighter": {
"styles": [
"solid"
],
"label": "Jet fighter",
"terms": [
"fighter-jet",
"Jet fighter",
"jet-fighter"
]
},
"jet-fighter-up": {
"styles": [
"solid"
],
"label": "Jet Fighter Up",
"terms": [
"Jet Fighter Up",
"jet-fighter-up"
]
},
"jira": {
"styles": [
"brands"
],
"label": "Jira",
"terms": [
"Jira",
"jira"
]
},
"joget": {
"styles": [
"brands"
],
"label": "Joget",
"terms": [
"Joget",
"joget"
]
},
"joint": {
"styles": [
"solid"
],
"label": "Joint",
"terms": [
"Joint",
"joint"
]
},
"joomla": {
"styles": [
"brands"
],
"label": "Joomla Logo",
"terms": [
"Joomla Logo",
"joomla"
]
},
"js": {
"styles": [
"brands"
],
"label": "JavaScript (JS)",
"terms": [
"JavaScript (JS)",
"js"
]
},
"jsfiddle": {
"styles": [
"brands"
],
"label": "jsFiddle",
"terms": [
"jsFiddle",
"jsfiddle"
]
},
"jug-detergent": {
"styles": [
"solid"
],
"label": "Jug Detergent",
"terms": [
"Jug Detergent",
"jug-detergent"
]
},
"k": {
"styles": [
"solid"
],
"label": "K",
"terms": [
"K",
"k"
]
},
"kaaba": {
"styles": [
"solid"
],
"label": "Kaaba",
"terms": [
"Kaaba",
"kaaba"
]
},
"kaggle": {
"styles": [
"brands"
],
"label": "Kaggle",
"terms": [
"Kaggle",
"kaggle"
]
},
"key": {
"styles": [
"solid"
],
"label": "key",
"terms": [
"key",
"key"
]
},
"keybase": {
"styles": [
"brands"
],
"label": "Keybase",
"terms": [
"Keybase",
"keybase"
]
},
"keyboard": {
"styles": [
"solid",
"regular"
],
"label": "Keyboard",
"terms": [
"Keyboard",
"keyboard"
]
},
"keycdn": {
"styles": [
"brands"
],
"label": "KeyCDN",
"terms": [
"KeyCDN",
"keycdn"
]
},
"khanda": {
"styles": [
"solid"
],
"label": "Khanda",
"terms": [
"Khanda",
"khanda"
]
},
"kickstarter": {
"styles": [
"brands"
],
"label": "Kickstarter",
"terms": [
"Kickstarter",
"kickstarter"
]
},
"kickstarter-k": {
"styles": [
"brands"
],
"label": "Kickstarter K",
"terms": [
"Kickstarter K",
"kickstarter-k"
]
},
"kip-sign": {
"styles": [
"solid"
],
"label": "Kip Sign",
"terms": [
"Kip Sign",
"kip-sign"
]
},
"kit-medical": {
"styles": [
"solid"
],
"label": "Kit medical",
"terms": [
"first-aid",
"Kit medical",
"kit-medical"
]
},
"kitchen-set": {
"styles": [
"solid"
],
"label": "Kitchen Set",
"terms": [
"Kitchen Set",
"kitchen-set"
]
},
"kiwi-bird": {
"styles": [
"solid"
],
"label": "Kiwi Bird",
"terms": [
"Kiwi Bird",
"kiwi-bird"
]
},
"korvue": {
"styles": [
"brands"
],
"label": "KORVUE",
"terms": [
"KORVUE",
"korvue"
]
},
"l": {
"styles": [
"solid"
],
"label": "L",
"terms": [
"L",
"l"
]
},
"land-mine-on": {
"styles": [
"solid"
],
"label": "Land Mine-on",
"terms": [
"Land Mine-on",
"land-mine-on"
]
},
"landmark": {
"styles": [
"solid"
],
"label": "Landmark",
"terms": [
"Landmark",
"landmark"
]
},
"landmark-dome": {
"styles": [
"solid"
],
"label": "Landmark dome",
"terms": [
"landmark-alt",
"Landmark dome",
"landmark-dome"
]
},
"landmark-flag": {
"styles": [
"solid"
],
"label": "Landmark Flag",
"terms": [
"Landmark Flag",
"landmark-flag"
]
},
"language": {
"styles": [
"solid"
],
"label": "Language",
"terms": [
"Language",
"language"
]
},
"laptop": {
"styles": [
"solid"
],
"label": "Laptop",
"terms": [
"Laptop",
"laptop"
]
},
"laptop-code": {
"styles": [
"solid"
],
"label": "Laptop Code",
"terms": [
"Laptop Code",
"laptop-code"
]
},
"laptop-file": {
"styles": [
"solid"
],
"label": "Laptop File",
"terms": [
"Laptop File",
"laptop-file"
]
},
"laptop-medical": {
"styles": [
"solid"
],
"label": "Laptop Medical",
"terms": [
"Laptop Medical",
"laptop-medical"
]
},
"laravel": {
"styles": [
"brands"
],
"label": "Laravel",
"terms": [
"Laravel",
"laravel"
]
},
"lari-sign": {
"styles": [
"solid"
],
"label": "Lari Sign",
"terms": [
"Lari Sign",
"lari-sign"
]
},
"lastfm": {
"styles": [
"brands"
],
"label": "last.fm",
"terms": [
"last.fm",
"lastfm"
]
},
"layer-group": {
"styles": [
"solid"
],
"label": "Layer Group",
"terms": [
"Layer Group",
"layer-group"
]
},
"leaf": {
"styles": [
"solid"
],
"label": "leaf",
"terms": [
"leaf",
"leaf"
]
},
"leanpub": {
"styles": [
"brands"
],
"label": "Leanpub",
"terms": [
"Leanpub",
"leanpub"
]
},
"left-long": {
"styles": [
"solid"
],
"label": "Left long",
"terms": [
"long-arrow-alt-left",
"Left long",
"left-long"
]
},
"left-right": {
"styles": [
"solid"
],
"label": "Left right",
"terms": [
"arrows-alt-h",
"Left right",
"left-right"
]
},
"lemon": {
"styles": [
"solid",
"regular"
],
"label": "Lemon",
"terms": [
"Lemon",
"lemon"
]
},
"less": {
"styles": [
"brands"
],
"label": "Less",
"terms": [
"Less",
"less"
]
},
"less-than": {
"styles": [
"solid"
],
"label": "Less Than",
"terms": [
"Less Than",
"less-than"
]
},
"less-than-equal": {
"styles": [
"solid"
],
"label": "Less Than Equal To",
"terms": [
"Less Than Equal To",
"less-than-equal"
]
},
"life-ring": {
"styles": [
"solid",
"regular"
],
"label": "Life Ring",
"terms": [
"Life Ring",
"life-ring"
]
},
"lightbulb": {
"styles": [
"solid",
"regular"
],
"label": "Lightbulb",
"terms": [
"Lightbulb",
"lightbulb"
]
},
"line": {
"styles": [
"brands"
],
"label": "Line",
"terms": [
"Line",
"line"
]
},
"lines-leaning": {
"styles": [
"solid"
],
"label": "Lines Leaning",
"terms": [
"Lines Leaning",
"lines-leaning"
]
},
"link": {
"styles": [
"solid"
],
"label": "Link",
"terms": [
"chain",
"Link",
"link"
]
},
"link-slash": {
"styles": [
"solid"
],
"label": "Link Slash",
"terms": [
"chain-broken",
"chain-slash",
"unlink",
"Link Slash",
"link-slash"
]
},
"linkedin": {
"styles": [
"brands"
],
"label": "LinkedIn",
"terms": [
"LinkedIn",
"linkedin"
]
},
"linkedin-in": {
"styles": [
"brands"
],
"label": "LinkedIn In",
"terms": [
"LinkedIn In",
"linkedin-in"
]
},
"linode": {
"styles": [
"brands"
],
"label": "Linode",
"terms": [
"Linode",
"linode"
]
},
"linux": {
"styles": [
"brands"
],
"label": "Linux",
"terms": [
"Linux",
"linux"
]
},
"lira-sign": {
"styles": [
"solid"
],
"label": "Turkish Lira Sign",
"terms": [
"Turkish Lira Sign",
"lira-sign"
]
},
"list": {
"styles": [
"solid"
],
"label": "List",
"terms": [
"list-squares",
"List",
"list"
]
},
"list-check": {
"styles": [
"solid"
],
"label": "List check",
"terms": [
"tasks",
"List check",
"list-check"
]
},
"list-ol": {
"styles": [
"solid"
],
"label": "list-ol",
"terms": [
"list-1-2",
"list-numeric",
"list-ol",
"list-ol"
]
},
"list-ul": {
"styles": [
"solid"
],
"label": "list-ul",
"terms": [
"list-dots",
"list-ul",
"list-ul"
]
},
"litecoin-sign": {
"styles": [
"solid"
],
"label": "Litecoin Sign",
"terms": [
"Litecoin Sign",
"litecoin-sign"
]
},
"location-arrow": {
"styles": [
"solid"
],
"label": "location-arrow",
"terms": [
"location-arrow",
"location-arrow"
]
},
"location-crosshairs": {
"styles": [
"solid"
],
"label": "Location Crosshairs",
"terms": [
"location",
"Location Crosshairs",
"location-crosshairs"
]
},
"location-dot": {
"styles": [
"solid"
],
"label": "Location dot",
"terms": [
"map-marker-alt",
"Location dot",
"location-dot"
]
},
"location-pin": {
"styles": [
"solid"
],
"label": "Location",
"terms": [
"map-marker",
"Location",
"location-pin"
]
},
"location-pin-lock": {
"styles": [
"solid"
],
"label": "Location Pin-lock",
"terms": [
"Location Pin-lock",
"location-pin-lock"
]
},
"lock": {
"styles": [
"solid"
],
"label": "lock",
"terms": [
"lock",
"lock"
]
},
"lock-open": {
"styles": [
"solid"
],
"label": "Lock Open",
"terms": [
"Lock Open",
"lock-open"
]
},
"locust": {
"styles": [
"solid"
],
"label": "Locust",
"terms": [
"Locust",
"locust"
]
},
"lungs": {
"styles": [
"solid"
],
"label": "Lungs",
"terms": [
"Lungs",
"lungs"
]
},
"lungs-virus": {
"styles": [
"solid"
],
"label": "Lungs Virus",
"terms": [
"Lungs Virus",
"lungs-virus"
]
},
"lyft": {
"styles": [
"brands"
],
"label": "lyft",
"terms": [
"lyft",
"lyft"
]
},
"m": {
"styles": [
"solid"
],
"label": "M",
"terms": [
"M",
"m"
]
},
"magento": {
"styles": [
"brands"
],
"label": "Magento",
"terms": [
"Magento",
"magento"
]
},
"magnet": {
"styles": [
"solid"
],
"label": "magnet",
"terms": [
"magnet",
"magnet"
]
},
"magnifying-glass": {
"styles": [
"solid"
],
"label": "Magnifying glass",
"terms": [
"search",
"Magnifying glass",
"magnifying-glass"
]
},
"magnifying-glass-arrow-right": {
"styles": [
"solid"
],
"label": "Magnifying Glass-arrow-right",
"terms": [
"Magnifying Glass-arrow-right",
"magnifying-glass-arrow-right"
]
},
"magnifying-glass-chart": {
"styles": [
"solid"
],
"label": "Magnifying Glass-chart",
"terms": [
"Magnifying Glass-chart",
"magnifying-glass-chart"
]
},
"magnifying-glass-dollar": {
"styles": [
"solid"
],
"label": "Magnifying glass dollar",
"terms": [
"search-dollar",
"Magnifying glass dollar",
"magnifying-glass-dollar"
]
},
"magnifying-glass-location": {
"styles": [
"solid"
],
"label": "Magnifying glass location",
"terms": [
"search-location",
"Magnifying glass location",
"magnifying-glass-location"
]
},
"magnifying-glass-minus": {
"styles": [
"solid"
],
"label": "Magnifying glass minus",
"terms": [
"search-minus",
"Magnifying glass minus",
"magnifying-glass-minus"
]
},
"magnifying-glass-plus": {
"styles": [
"solid"
],
"label": "Magnifying glass plus",
"terms": [
"search-plus",
"Magnifying glass plus",
"magnifying-glass-plus"
]
},
"mailchimp": {
"styles": [
"brands"
],
"label": "Mailchimp",
"terms": [
"Mailchimp",
"mailchimp"
]
},
"manat-sign": {
"styles": [
"solid"
],
"label": "Manat Sign",
"terms": [
"Manat Sign",
"manat-sign"
]
},
"mandalorian": {
"styles": [
"brands"
],
"label": "Mandalorian",
"terms": [
"Mandalorian",
"mandalorian"
]
},
"map": {
"styles": [
"solid",
"regular"
],
"label": "Map",
"terms": [
"Map",
"map"
]
},
"map-location": {
"styles": [
"solid"
],
"label": "Map location",
"terms": [
"map-marked",
"Map location",
"map-location"
]
},
"map-location-dot": {
"styles": [
"solid"
],
"label": "Map location dot",
"terms": [
"map-marked-alt",
"Map location dot",
"map-location-dot"
]
},
"map-pin": {
"styles": [
"solid"
],
"label": "Map Pin",
"terms": [
"Map Pin",
"map-pin"
]
},
"markdown": {
"styles": [
"brands"
],
"label": "Markdown",
"terms": [
"Markdown",
"markdown"
]
},
"marker": {
"styles": [
"solid"
],
"label": "Marker",
"terms": [
"Marker",
"marker"
]
},
"mars": {
"styles": [
"solid"
],
"label": "Mars",
"terms": [
"Mars",
"mars"
]
},
"mars-and-venus": {
"styles": [
"solid"
],
"label": "Mars and Venus",
"terms": [
"Mars and Venus",
"mars-and-venus"
]
},
"mars-and-venus-burst": {
"styles": [
"solid"
],
"label": "Mars and Venus Burst",
"terms": [
"Mars and Venus Burst",
"mars-and-venus-burst"
]
},
"mars-double": {
"styles": [
"solid"
],
"label": "Mars Double",
"terms": [
"Mars Double",
"mars-double"
]
},
"mars-stroke": {
"styles": [
"solid"
],
"label": "Mars Stroke",
"terms": [
"Mars Stroke",
"mars-stroke"
]
},
"mars-stroke-right": {
"styles": [
"solid"
],
"label": "Mars stroke right",
"terms": [
"mars-stroke-h",
"Mars stroke right",
"mars-stroke-right"
]
},
"mars-stroke-up": {
"styles": [
"solid"
],
"label": "Mars stroke up",
"terms": [
"mars-stroke-v",
"Mars stroke up",
"mars-stroke-up"
]
},
"martini-glass": {
"styles": [
"solid"
],
"label": "Martini glass",
"terms": [
"glass-martini-alt",
"Martini glass",
"martini-glass"
]
},
"martini-glass-citrus": {
"styles": [
"solid"
],
"label": "Martini glass citrus",
"terms": [
"cocktail",
"Martini glass citrus",
"martini-glass-citrus"
]
},
"martini-glass-empty": {
"styles": [
"solid"
],
"label": "Martini glass empty",
"terms": [
"glass-martini",
"Martini glass empty",
"martini-glass-empty"
]
},
"mask": {
"styles": [
"solid"
],
"label": "Mask",
"terms": [
"Mask",
"mask"
]
},
"mask-face": {
"styles": [
"solid"
],
"label": "Face Mask",
"terms": [
"Face Mask",
"mask-face"
]
},
"mask-ventilator": {
"styles": [
"solid"
],
"label": "Mask Ventilator",
"terms": [
"Mask Ventilator",
"mask-ventilator"
]
},
"masks-theater": {
"styles": [
"solid"
],
"label": "Masks theater",
"terms": [
"theater-masks",
"Masks theater",
"masks-theater"
]
},
"mastodon": {
"styles": [
"brands"
],
"label": "Mastodon",
"terms": [
"Mastodon",
"mastodon"
]
},
"mattress-pillow": {
"styles": [
"solid"
],
"label": "Mattress Pillow",
"terms": [
"Mattress Pillow",
"mattress-pillow"
]
},
"maxcdn": {
"styles": [
"brands"
],
"label": "MaxCDN",
"terms": [
"MaxCDN",
"maxcdn"
]
},
"maximize": {
"styles": [
"solid"
],
"label": "Maximize",
"terms": [
"expand-arrows-alt",
"Maximize",
"maximize"
]
},
"mdb": {
"styles": [
"brands"
],
"label": "Material Design for Bootstrap",
"terms": [
"Material Design for Bootstrap",
"mdb"
]
},
"medal": {
"styles": [
"solid"
],
"label": "Medal",
"terms": [
"Medal",
"medal"
]
},
"medapps": {
"styles": [
"brands"
],
"label": "MedApps",
"terms": [
"MedApps",
"medapps"
]
},
"medium": {
"styles": [
"brands"
],
"label": "Medium",
"terms": [
"medium-m",
"Medium",
"medium"
]
},
"medrt": {
"styles": [
"brands"
],
"label": "MRT",
"terms": [
"MRT",
"medrt"
]
},
"meetup": {
"styles": [
"brands"
],
"label": "Meetup",
"terms": [
"Meetup",
"meetup"
]
},
"megaport": {
"styles": [
"brands"
],
"label": "Megaport",
"terms": [
"Megaport",
"megaport"
]
},
"memory": {
"styles": [
"solid"
],
"label": "Memory",
"terms": [
"Memory",
"memory"
]
},
"mendeley": {
"styles": [
"brands"
],
"label": "Mendeley",
"terms": [
"Mendeley",
"mendeley"
]
},
"menorah": {
"styles": [
"solid"
],
"label": "Menorah",
"terms": [
"Menorah",
"menorah"
]
},
"mercury": {
"styles": [
"solid"
],
"label": "Mercury",
"terms": [
"Mercury",
"mercury"
]
},
"message": {
"styles": [
"solid",
"regular"
],
"label": "Message",
"terms": [
"comment-alt",
"Message",
"message"
]
},
"meta": {
"styles": [
"brands"
],
"label": "Meta",
"terms": [
"Meta",
"meta"
]
},
"meteor": {
"styles": [
"solid"
],
"label": "Meteor",
"terms": [
"Meteor",
"meteor"
]
},
"microblog": {
"styles": [
"brands"
],
"label": "Micro.blog",
"terms": [
"Micro.blog",
"microblog"
]
},
"microchip": {
"styles": [
"solid"
],
"label": "Microchip",
"terms": [
"Microchip",
"microchip"
]
},
"microphone": {
"styles": [
"solid"
],
"label": "microphone",
"terms": [
"microphone",
"microphone"
]
},
"microphone-lines": {
"styles": [
"solid"
],
"label": "Microphone lines",
"terms": [
"microphone-alt",
"Microphone lines",
"microphone-lines"
]
},
"microphone-lines-slash": {
"styles": [
"solid"
],
"label": "Microphone lines slash",
"terms": [
"microphone-alt-slash",
"Microphone lines slash",
"microphone-lines-slash"
]
},
"microphone-slash": {
"styles": [
"solid"
],
"label": "Microphone Slash",
"terms": [
"Microphone Slash",
"microphone-slash"
]
},
"microscope": {
"styles": [
"solid"
],
"label": "Microscope",
"terms": [
"Microscope",
"microscope"
]
},
"microsoft": {
"styles": [
"brands"
],
"label": "Microsoft",
"terms": [
"Microsoft",
"microsoft"
]
},
"mill-sign": {
"styles": [
"solid"
],
"label": "Mill Sign",
"terms": [
"Mill Sign",
"mill-sign"
]
},
"minimize": {
"styles": [
"solid"
],
"label": "Minimize",
"terms": [
"compress-arrows-alt",
"Minimize",
"minimize"
]
},
"minus": {
"styles": [
"solid"
],
"label": "minus",
"terms": [
"subtract",
"minus",
"minus"
]
},
"mitten": {
"styles": [
"solid"
],
"label": "Mitten",
"terms": [
"Mitten",
"mitten"
]
},
"mix": {
"styles": [
"brands"
],
"label": "Mix",
"terms": [
"Mix",
"mix"
]
},
"mixcloud": {
"styles": [
"brands"
],
"label": "Mixcloud",
"terms": [
"Mixcloud",
"mixcloud"
]
},
"mixer": {
"styles": [
"brands"
],
"label": "Mixer",
"terms": [
"Mixer",
"mixer"
]
},
"mizuni": {
"styles": [
"brands"
],
"label": "Mizuni",
"terms": [
"Mizuni",
"mizuni"
]
},
"mobile": {
"styles": [
"solid"
],
"label": "Mobile",
"terms": [
"mobile-android",
"mobile-phone",
"Mobile",
"mobile"
]
},
"mobile-button": {
"styles": [
"solid"
],
"label": "Mobile button",
"terms": [
"Mobile button",
"mobile-button"
]
},
"mobile-retro": {
"styles": [
"solid"
],
"label": "Mobile Retro",
"terms": [
"Mobile Retro",
"mobile-retro"
]
},
"mobile-screen": {
"styles": [
"solid"
],
"label": "Mobile screen",
"terms": [
"mobile-android-alt",
"Mobile screen",
"mobile-screen"
]
},
"mobile-screen-button": {
"styles": [
"solid"
],
"label": "Mobile screen button",
"terms": [
"mobile-alt",
"Mobile screen button",
"mobile-screen-button"
]
},
"modx": {
"styles": [
"brands"
],
"label": "MODX",
"terms": [
"MODX",
"modx"
]
},
"monero": {
"styles": [
"brands"
],
"label": "Monero",
"terms": [
"Monero",
"monero"
]
},
"money-bill": {
"styles": [
"solid"
],
"label": "Money Bill",
"terms": [
"Money Bill",
"money-bill"
]
},
"money-bill-1": {
"styles": [
"solid",
"regular"
],
"label": "Money bill 1",
"terms": [
"money-bill-alt",
"Money bill 1",
"money-bill-1"
]
},
"money-bill-1-wave": {
"styles": [
"solid"
],
"label": "Money bill 1 wave",
"terms": [
"money-bill-wave-alt",
"Money bill 1 wave",
"money-bill-1-wave"
]
},
"money-bill-transfer": {
"styles": [
"solid"
],
"label": "Money Bill-transfer",
"terms": [
"Money Bill-transfer",
"money-bill-transfer"
]
},
"money-bill-trend-up": {
"styles": [
"solid"
],
"label": "Money Bill-trend-up",
"terms": [
"Money Bill-trend-up",
"money-bill-trend-up"
]
},
"money-bill-wave": {
"styles": [
"solid"
],
"label": "Wavy Money Bill",
"terms": [
"Wavy Money Bill",
"money-bill-wave"
]
},
"money-bill-wheat": {
"styles": [
"solid"
],
"label": "Money Bill-wheat",
"terms": [
"Money Bill-wheat",
"money-bill-wheat"
]
},
"money-bills": {
"styles": [
"solid"
],
"label": "Money Bills",
"terms": [
"Money Bills",
"money-bills"
]
},
"money-check": {
"styles": [
"solid"
],
"label": "Money Check",
"terms": [
"Money Check",
"money-check"
]
},
"money-check-dollar": {
"styles": [
"solid"
],
"label": "Money check dollar",
"terms": [
"money-check-alt",
"Money check dollar",
"money-check-dollar"
]
},
"monument": {
"styles": [
"solid"
],
"label": "Monument",
"terms": [
"Monument",
"monument"
]
},
"moon": {
"styles": [
"solid",
"regular"
],
"label": "Moon",
"terms": [
"Moon",
"moon"
]
},
"mortar-pestle": {
"styles": [
"solid"
],
"label": "Mortar Pestle",
"terms": [
"Mortar Pestle",
"mortar-pestle"
]
},
"mosque": {
"styles": [
"solid"
],
"label": "Mosque",
"terms": [
"Mosque",
"mosque"
]
},
"mosquito": {
"styles": [
"solid"
],
"label": "Mosquito",
"terms": [
"Mosquito",
"mosquito"
]
},
"mosquito-net": {
"styles": [
"solid"
],
"label": "Mosquito Net",
"terms": [
"Mosquito Net",
"mosquito-net"
]
},
"motorcycle": {
"styles": [
"solid"
],
"label": "Motorcycle",
"terms": [
"Motorcycle",
"motorcycle"
]
},
"mound": {
"styles": [
"solid"
],
"label": "Mound",
"terms": [
"Mound",
"mound"
]
},
"mountain": {
"styles": [
"solid"
],
"label": "Mountain",
"terms": [
"Mountain",
"mountain"
]
},
"mountain-city": {
"styles": [
"solid"
],
"label": "Mountain City",
"terms": [
"Mountain City",
"mountain-city"
]
},
"mountain-sun": {
"styles": [
"solid"
],
"label": "Mountain Sun",
"terms": [
"Mountain Sun",
"mountain-sun"
]
},
"mug-hot": {
"styles": [
"solid"
],
"label": "Mug Hot",
"terms": [
"Mug Hot",
"mug-hot"
]
},
"mug-saucer": {
"styles": [
"solid"
],
"label": "Mug saucer",
"terms": [
"coffee",
"Mug saucer",
"mug-saucer"
]
},
"music": {
"styles": [
"solid"
],
"label": "Music",
"terms": [
"Music",
"music"
]
},
"n": {
"styles": [
"solid"
],
"label": "N",
"terms": [
"N",
"n"
]
},
"naira-sign": {
"styles": [
"solid"
],
"label": "Naira Sign",
"terms": [
"Naira Sign",
"naira-sign"
]
},
"napster": {
"styles": [
"brands"
],
"label": "Napster",
"terms": [
"Napster",
"napster"
]
},
"neos": {
"styles": [
"brands"
],
"label": "Neos",
"terms": [
"Neos",
"neos"
]
},
"network-wired": {
"styles": [
"solid"
],
"label": "Wired Network",
"terms": [
"Wired Network",
"network-wired"
]
},
"neuter": {
"styles": [
"solid"
],
"label": "Neuter",
"terms": [
"Neuter",
"neuter"
]
},
"newspaper": {
"styles": [
"solid",
"regular"
],
"label": "Newspaper",
"terms": [
"Newspaper",
"newspaper"
]
},
"nfc-directional": {
"styles": [
"brands"
],
"label": "NFC Directional",
"terms": [
"NFC Directional",
"nfc-directional"
]
},
"nfc-symbol": {
"styles": [
"brands"
],
"label": "NFC Simplified",
"terms": [
"NFC Simplified",
"nfc-symbol"
]
},
"nimblr": {
"styles": [
"brands"
],
"label": "Nimblr",
"terms": [
"Nimblr",
"nimblr"
]
},
"node": {
"styles": [
"brands"
],
"label": "Node.js",
"terms": [
"Node.js",
"node"
]
},
"node-js": {
"styles": [
"brands"
],
"label": "Node.js JS",
"terms": [
"Node.js JS",
"node-js"
]
},
"not-equal": {
"styles": [
"solid"
],
"label": "Not Equal",
"terms": [
"Not Equal",
"not-equal"
]
},
"notdef": {
"styles": [
"solid",
"regular"
],
"label": "Notdef",
"terms": [
"Notdef",
"notdef"
]
},
"note-sticky": {
"styles": [
"solid",
"regular"
],
"label": "Note sticky",
"terms": [
"sticky-note",
"Note sticky",
"note-sticky"
]
},
"notes-medical": {
"styles": [
"solid"
],
"label": "Medical Notes",
"terms": [
"Medical Notes",
"notes-medical"
]
},
"npm": {
"styles": [
"brands"
],
"label": "npm",
"terms": [
"npm",
"npm"
]
},
"ns8": {
"styles": [
"brands"
],
"label": "NS8",
"terms": [
"NS8",
"ns8"
]
},
"nutritionix": {
"styles": [
"brands"
],
"label": "Nutritionix",
"terms": [
"Nutritionix",
"nutritionix"
]
},
"o": {
"styles": [
"solid"
],
"label": "O",
"terms": [
"O",
"o"
]
},
"object-group": {
"styles": [
"solid",
"regular"
],
"label": "Object Group",
"terms": [
"Object Group",
"object-group"
]
},
"object-ungroup": {
"styles": [
"solid",
"regular"
],
"label": "Object Ungroup",
"terms": [
"Object Ungroup",
"object-ungroup"
]
},
"octopus-deploy": {
"styles": [
"brands"
],
"label": "Octopus Deploy",
"terms": [
"Octopus Deploy",
"octopus-deploy"
]
},
"odnoklassniki": {
"styles": [
"brands"
],
"label": "Odnoklassniki",
"terms": [
"Odnoklassniki",
"odnoklassniki"
]
},
"oil-can": {
"styles": [
"solid"
],
"label": "Oil Can",
"terms": [
"Oil Can",
"oil-can"
]
},
"oil-well": {
"styles": [
"solid"
],
"label": "Oil Well",
"terms": [
"Oil Well",
"oil-well"
]
},
"old-republic": {
"styles": [
"brands"
],
"label": "Old Republic",
"terms": [
"Old Republic",
"old-republic"
]
},
"om": {
"styles": [
"solid"
],
"label": "Om",
"terms": [
"Om",
"om"
]
},
"opencart": {
"styles": [
"brands"
],
"label": "OpenCart",
"terms": [
"OpenCart",
"opencart"
]
},
"openid": {
"styles": [
"brands"
],
"label": "OpenID",
"terms": [
"OpenID",
"openid"
]
},
"opera": {
"styles": [
"brands"
],
"label": "Opera",
"terms": [
"Opera",
"opera"
]
},
"optin-monster": {
"styles": [
"brands"
],
"label": "Optin Monster",
"terms": [
"Optin Monster",
"optin-monster"
]
},
"orcid": {
"styles": [
"brands"
],
"label": "ORCID",
"terms": [
"ORCID",
"orcid"
]
},
"osi": {
"styles": [
"brands"
],
"label": "Open Source Initiative",
"terms": [
"Open Source Initiative",
"osi"
]
},
"otter": {
"styles": [
"solid"
],
"label": "Otter",
"terms": [
"Otter",
"otter"
]
},
"outdent": {
"styles": [
"solid"
],
"label": "Outdent",
"terms": [
"dedent",
"Outdent",
"outdent"
]
},
"p": {
"styles": [
"solid"
],
"label": "P",
"terms": [
"P",
"p"
]
},
"padlet": {
"styles": [
"brands"
],
"label": "Padlet",
"terms": [
"Padlet",
"padlet"
]
},
"page4": {
"styles": [
"brands"
],
"label": "page4 Corporation",
"terms": [
"page4 Corporation",
"page4"
]
},
"pagelines": {
"styles": [
"brands"
],
"label": "Pagelines",
"terms": [
"Pagelines",
"pagelines"
]
},
"pager": {
"styles": [
"solid"
],
"label": "Pager",
"terms": [
"Pager",
"pager"
]
},
"paint-roller": {
"styles": [
"solid"
],
"label": "Paint Roller",
"terms": [
"Paint Roller",
"paint-roller"
]
},
"paintbrush": {
"styles": [
"solid"
],
"label": "Paint Brush",
"terms": [
"paint-brush",
"Paint Brush",
"paintbrush"
]
},
"palette": {
"styles": [
"solid"
],
"label": "Palette",
"terms": [
"Palette",
"palette"
]
},
"palfed": {
"styles": [
"brands"
],
"label": "Palfed",
"terms": [
"Palfed",
"palfed"
]
},
"pallet": {
"styles": [
"solid"
],
"label": "Pallet",
"terms": [
"Pallet",
"pallet"
]
},
"panorama": {
"styles": [
"solid"
],
"label": "Panorama",
"terms": [
"Panorama",
"panorama"
]
},
"paper-plane": {
"styles": [
"solid",
"regular"
],
"label": "Paper Plane",
"terms": [
"Paper Plane",
"paper-plane"
]
},
"paperclip": {
"styles": [
"solid"
],
"label": "Paperclip",
"terms": [
"Paperclip",
"paperclip"
]
},
"parachute-box": {
"styles": [
"solid"
],
"label": "Parachute Box",
"terms": [
"Parachute Box",
"parachute-box"
]
},
"paragraph": {
"styles": [
"solid"
],
"label": "paragraph",
"terms": [
"paragraph",
"paragraph"
]
},
"passport": {
"styles": [
"solid"
],
"label": "Passport",
"terms": [
"Passport",
"passport"
]
},
"paste": {
"styles": [
"solid",
"regular"
],
"label": "Paste",
"terms": [
"file-clipboard",
"Paste",
"paste"
]
},
"patreon": {
"styles": [
"brands"
],
"label": "Patreon",
"terms": [
"Patreon",
"patreon"
]
},
"pause": {
"styles": [
"solid"
],
"label": "pause",
"terms": [
"pause",
"pause"
]
},
"paw": {
"styles": [
"solid"
],
"label": "Paw",
"terms": [
"Paw",
"paw"
]
},
"paypal": {
"styles": [
"brands"
],
"label": "Paypal",
"terms": [
"Paypal",
"paypal"
]
},
"peace": {
"styles": [
"solid"
],
"label": "Peace",
"terms": [
"Peace",
"peace"
]
},
"pen": {
"styles": [
"solid"
],
"label": "Pen",
"terms": [
"Pen",
"pen"
]
},
"pen-clip": {
"styles": [
"solid"
],
"label": "Pen clip",
"terms": [
"pen-alt",
"Pen clip",
"pen-clip"
]
},
"pen-fancy": {
"styles": [
"solid"
],
"label": "Pen Fancy",
"terms": [
"Pen Fancy",
"pen-fancy"
]
},
"pen-nib": {
"styles": [
"solid"
],
"label": "Pen Nib",
"terms": [
"Pen Nib",
"pen-nib"
]
},
"pen-ruler": {
"styles": [
"solid"
],
"label": "Pen ruler",
"terms": [
"pencil-ruler",
"Pen ruler",
"pen-ruler"
]
},
"pen-to-square": {
"styles": [
"solid",
"regular"
],
"label": "Pen to square",
"terms": [
"edit",
"Pen to square",
"pen-to-square"
]
},
"pencil": {
"styles": [
"solid"
],
"label": "pencil",
"terms": [
"pencil-alt",
"pencil",
"pencil"
]
},
"people-arrows": {
"styles": [
"solid"
],
"label": "People arrows left right",
"terms": [
"people-arrows-left-right",
"People arrows left right",
"people-arrows"
]
},
"people-carry-box": {
"styles": [
"solid"
],
"label": "People carry box",
"terms": [
"people-carry",
"People carry box",
"people-carry-box"
]
},
"people-group": {
"styles": [
"solid"
],
"label": "People Group",
"terms": [
"People Group",
"people-group"
]
},
"people-line": {
"styles": [
"solid"
],
"label": "People Line",
"terms": [
"People Line",
"people-line"
]
},
"people-pulling": {
"styles": [
"solid"
],
"label": "People Pulling",
"terms": [
"People Pulling",
"people-pulling"
]
},
"people-robbery": {
"styles": [
"solid"
],
"label": "People Robbery",
"terms": [
"People Robbery",
"people-robbery"
]
},
"people-roof": {
"styles": [
"solid"
],
"label": "People Roof",
"terms": [
"People Roof",
"people-roof"
]
},
"pepper-hot": {
"styles": [
"solid"
],
"label": "Hot Pepper",
"terms": [
"Hot Pepper",
"pepper-hot"
]
},
"perbyte": {
"styles": [
"brands"
],
"label": "PerByte",
"terms": [
"PerByte",
"perbyte"
]
},
"percent": {
"styles": [
"solid"
],
"label": "Percent",
"terms": [
"percentage",
"Percent",
"percent"
]
},
"periscope": {
"styles": [
"brands"
],
"label": "Periscope",
"terms": [
"Periscope",
"periscope"
]
},
"person": {
"styles": [
"solid"
],
"label": "Person",
"terms": [
"male",
"Person",
"person"
]
},
"person-arrow-down-to-line": {
"styles": [
"solid"
],
"label": "Person Arrow-down-to-line",
"terms": [
"Person Arrow-down-to-line",
"person-arrow-down-to-line"
]
},
"person-arrow-up-from-line": {
"styles": [
"solid"
],
"label": "Person Arrow-up-from-line",
"terms": [
"Person Arrow-up-from-line",
"person-arrow-up-from-line"
]
},
"person-biking": {
"styles": [
"solid"
],
"label": "Person biking",
"terms": [
"biking",
"Person biking",
"person-biking"
]
},
"person-booth": {
"styles": [
"solid"
],
"label": "Person Entering Booth",
"terms": [
"Person Entering Booth",
"person-booth"
]
},
"person-breastfeeding": {
"styles": [
"solid"
],
"label": "Person Breastfeeding",
"terms": [
"Person Breastfeeding",
"person-breastfeeding"
]
},
"person-burst": {
"styles": [
"solid"
],
"label": "Person Burst",
"terms": [
"Person Burst",
"person-burst"
]
},
"person-cane": {
"styles": [
"solid"
],
"label": "Person Cane",
"terms": [
"Person Cane",
"person-cane"
]
},
"person-chalkboard": {
"styles": [
"solid"
],
"label": "Person Chalkboard",
"terms": [
"Person Chalkboard",
"person-chalkboard"
]
},
"person-circle-check": {
"styles": [
"solid"
],
"label": "Person Circle-check",
"terms": [
"Person Circle-check",
"person-circle-check"
]
},
"person-circle-exclamation": {
"styles": [
"solid"
],
"label": "Person Circle-exclamation",
"terms": [
"Person Circle-exclamation",
"person-circle-exclamation"
]
},
"person-circle-minus": {
"styles": [
"solid"
],
"label": "Person Circle-minus",
"terms": [
"Person Circle-minus",
"person-circle-minus"
]
},
"person-circle-plus": {
"styles": [
"solid"
],
"label": "Person Circle-plus",
"terms": [
"Person Circle-plus",
"person-circle-plus"
]
},
"person-circle-question": {
"styles": [
"solid"
],
"label": "Person Circle-question",
"terms": [
"Person Circle-question",
"person-circle-question"
]
},
"person-circle-xmark": {
"styles": [
"solid"
],
"label": "Person Circle-xmark",
"terms": [
"Person Circle-xmark",
"person-circle-xmark"
]
},
"person-digging": {
"styles": [
"solid"
],
"label": "Person digging",
"terms": [
"digging",
"Person digging",
"person-digging"
]
},
"person-dots-from-line": {
"styles": [
"solid"
],
"label": "Person dots from line",
"terms": [
"diagnoses",
"Person dots from line",
"person-dots-from-line"
]
},
"person-dress": {
"styles": [
"solid"
],
"label": "Person dress",
"terms": [
"female",
"Person dress",
"person-dress"
]
},
"person-dress-burst": {
"styles": [
"solid"
],
"label": "Person Dress BUrst",
"terms": [
"Person Dress BUrst",
"person-dress-burst"
]
},
"person-drowning": {
"styles": [
"solid"
],
"label": "Person Drowning",
"terms": [
"Person Drowning",
"person-drowning"
]
},
"person-falling": {
"styles": [
"solid"
],
"label": "Person Falling",
"terms": [
"Person Falling",
"person-falling"
]
},
"person-falling-burst": {
"styles": [
"solid"
],
"label": "Person Falling Burst",
"terms": [
"Person Falling Burst",
"person-falling-burst"
]
},
"person-half-dress": {
"styles": [
"solid"
],
"label": "Person Half-dress",
"terms": [
"Person Half-dress",
"person-half-dress"
]
},
"person-harassing": {
"styles": [
"solid"
],
"label": "Person Harassing",
"terms": [
"Person Harassing",
"person-harassing"
]
},
"person-hiking": {
"styles": [
"solid"
],
"label": "Person hiking",
"terms": [
"hiking",
"Person hiking",
"person-hiking"
]
},
"person-military-pointing": {
"styles": [
"solid"
],
"label": "Person Military-pointing",
"terms": [
"Person Military-pointing",
"person-military-pointing"
]
},
"person-military-rifle": {
"styles": [
"solid"
],
"label": "Person Military-rifle",
"terms": [
"Person Military-rifle",
"person-military-rifle"
]
},
"person-military-to-person": {
"styles": [
"solid"
],
"label": "Person Military-to-person",
"terms": [
"Person Military-to-person",
"person-military-to-person"
]
},
"person-praying": {
"styles": [
"solid"
],
"label": "Person praying",
"terms": [
"pray",
"Person praying",
"person-praying"
]
},
"person-pregnant": {
"styles": [
"solid"
],
"label": "Person Pregnant",
"terms": [
"Person Pregnant",
"person-pregnant"
]
},
"person-rays": {
"styles": [
"solid"
],
"label": "Person Rays",
"terms": [
"Person Rays",
"person-rays"
]
},
"person-rifle": {
"styles": [
"solid"
],
"label": "Person Rifle",
"terms": [
"Person Rifle",
"person-rifle"
]
},
"person-running": {
"styles": [
"solid"
],
"label": "Person running",
"terms": [
"running",
"Person running",
"person-running"
]
},
"person-shelter": {
"styles": [
"solid"
],
"label": "Person Shelter",
"terms": [
"Person Shelter",
"person-shelter"
]
},
"person-skating": {
"styles": [
"solid"
],
"label": "Person skating",
"terms": [
"skating",
"Person skating",
"person-skating"
]
},
"person-skiing": {
"styles": [
"solid"
],
"label": "Person skiing",
"terms": [
"skiing",
"Person skiing",
"person-skiing"
]
},
"person-skiing-nordic": {
"styles": [
"solid"
],
"label": "Person skiing nordic",
"terms": [
"skiing-nordic",
"Person skiing nordic",
"person-skiing-nordic"
]
},
"person-snowboarding": {
"styles": [
"solid"
],
"label": "Person snowboarding",
"terms": [
"snowboarding",
"Person snowboarding",
"person-snowboarding"
]
},
"person-swimming": {
"styles": [
"solid"
],
"label": "Person swimming",
"terms": [
"swimmer",
"Person swimming",
"person-swimming"
]
},
"person-through-window": {
"styles": [
"solid"
],
"label": "Person Through-window",
"terms": [
"Person Through-window",
"person-through-window"
]
},
"person-walking": {
"styles": [
"solid"
],
"label": "Person walking",
"terms": [
"walking",
"Person walking",
"person-walking"
]
},
"person-walking-arrow-loop-left": {
"styles": [
"solid"
],
"label": "Person Walking-arrow-loop-left",
"terms": [
"Person Walking-arrow-loop-left",
"person-walking-arrow-loop-left"
]
},
"person-walking-arrow-right": {
"styles": [
"solid"
],
"label": "Person Walking-arrow-right",
"terms": [
"Person Walking-arrow-right",
"person-walking-arrow-right"
]
},
"person-walking-dashed-line-arrow-right": {
"styles": [
"solid"
],
"label": "Person Walking-dashed-line-arrow-right",
"terms": [
"Person Walking-dashed-line-arrow-right",
"person-walking-dashed-line-arrow-right"
]
},
"person-walking-luggage": {
"styles": [
"solid"
],
"label": "Person Walking-luggage",
"terms": [
"Person Walking-luggage",
"person-walking-luggage"
]
},
"person-walking-with-cane": {
"styles": [
"solid"
],
"label": "Person walking with cane",
"terms": [
"blind",
"Person walking with cane",
"person-walking-with-cane"
]
},
"peseta-sign": {
"styles": [
"solid"
],
"label": "Peseta Sign",
"terms": [
"Peseta Sign",
"peseta-sign"
]
},
"peso-sign": {
"styles": [
"solid"
],
"label": "Peso Sign",
"terms": [
"Peso Sign",
"peso-sign"
]
},
"phabricator": {
"styles": [
"brands"
],
"label": "Phabricator",
"terms": [
"Phabricator",
"phabricator"
]
},
"phoenix-framework": {
"styles": [
"brands"
],
"label": "Phoenix Framework",
"terms": [
"Phoenix Framework",
"phoenix-framework"
]
},
"phoenix-squadron": {
"styles": [
"brands"
],
"label": "Phoenix Squadron",
"terms": [
"Phoenix Squadron",
"phoenix-squadron"
]
},
"phone": {
"styles": [
"solid"
],
"label": "Phone",
"terms": [
"Phone",
"phone"
]
},
"phone-flip": {
"styles": [
"solid"
],
"label": "Phone flip",
"terms": [
"phone-alt",
"Phone flip",
"phone-flip"
]
},
"phone-slash": {
"styles": [
"solid"
],
"label": "Phone Slash",
"terms": [
"Phone Slash",
"phone-slash"
]
},
"phone-volume": {
"styles": [
"solid"
],
"label": "Phone Volume",
"terms": [
"volume-control-phone",
"Phone Volume",
"phone-volume"
]
},
"photo-film": {
"styles": [
"solid"
],
"label": "Photo film",
"terms": [
"photo-video",
"Photo film",
"photo-film"
]
},
"php": {
"styles": [
"brands"
],
"label": "PHP",
"terms": [
"PHP",
"php"
]
},
"pied-piper": {
"styles": [
"brands"
],
"label": "Pied Piper Logo",
"terms": [
"Pied Piper Logo",
"pied-piper"
]
},
"pied-piper-alt": {
"styles": [
"brands"
],
"label": "Alternate Pied Piper Logo (Old)",
"terms": [
"Alternate Pied Piper Logo (Old)",
"pied-piper-alt"
]
},
"pied-piper-hat": {
"styles": [
"brands"
],
"label": "Pied Piper Hat (Old)",
"terms": [
"Pied Piper Hat (Old)",
"pied-piper-hat"
]
},
"pied-piper-pp": {
"styles": [
"brands"
],
"label": "Pied Piper PP Logo (Old)",
"terms": [
"Pied Piper PP Logo (Old)",
"pied-piper-pp"
]
},
"piggy-bank": {
"styles": [
"solid"
],
"label": "Piggy Bank",
"terms": [
"Piggy Bank",
"piggy-bank"
]
},
"pills": {
"styles": [
"solid"
],
"label": "Pills",
"terms": [
"Pills",
"pills"
]
},
"pinterest": {
"styles": [
"brands"
],
"label": "Pinterest",
"terms": [
"Pinterest",
"pinterest"
]
},
"pinterest-p": {
"styles": [
"brands"
],
"label": "Pinterest P",
"terms": [
"Pinterest P",
"pinterest-p"
]
},
"pix": {
"styles": [
"brands"
],
"label": "Pix",
"terms": [
"Pix",
"pix"
]
},
"pizza-slice": {
"styles": [
"solid"
],
"label": "Pizza Slice",
"terms": [
"Pizza Slice",
"pizza-slice"
]
},
"place-of-worship": {
"styles": [
"solid"
],
"label": "Place of Worship",
"terms": [
"Place of Worship",
"place-of-worship"
]
},
"plane": {
"styles": [
"solid"
],
"label": "plane",
"terms": [
"plane",
"plane"
]
},
"plane-arrival": {
"styles": [
"solid"
],
"label": "Plane Arrival",
"terms": [
"Plane Arrival",
"plane-arrival"
]
},
"plane-circle-check": {
"styles": [
"solid"
],
"label": "Plane Circle-check",
"terms": [
"Plane Circle-check",
"plane-circle-check"
]
},
"plane-circle-exclamation": {
"styles": [
"solid"
],
"label": "Plane Circle-exclamation",
"terms": [
"Plane Circle-exclamation",
"plane-circle-exclamation"
]
},
"plane-circle-xmark": {
"styles": [
"solid"
],
"label": "Plane Circle-xmark",
"terms": [
"Plane Circle-xmark",
"plane-circle-xmark"
]
},
"plane-departure": {
"styles": [
"solid"
],
"label": "Plane Departure",
"terms": [
"Plane Departure",
"plane-departure"
]
},
"plane-lock": {
"styles": [
"solid"
],
"label": "Plane Lock",
"terms": [
"Plane Lock",
"plane-lock"
]
},
"plane-slash": {
"styles": [
"solid"
],
"label": "Plane Slash",
"terms": [
"Plane Slash",
"plane-slash"
]
},
"plane-up": {
"styles": [
"solid"
],
"label": "Plane Up",
"terms": [
"Plane Up",
"plane-up"
]
},
"plant-wilt": {
"styles": [
"solid"
],
"label": "Plant Wilt",
"terms": [
"Plant Wilt",
"plant-wilt"
]
},
"plate-wheat": {
"styles": [
"solid"
],
"label": "Plate Wheat",
"terms": [
"Plate Wheat",
"plate-wheat"
]
},
"play": {
"styles": [
"solid"
],
"label": "play",
"terms": [
"play",
"play"
]
},
"playstation": {
"styles": [
"brands"
],
"label": "PlayStation",
"terms": [
"PlayStation",
"playstation"
]
},
"plug": {
"styles": [
"solid"
],
"label": "Plug",
"terms": [
"Plug",
"plug"
]
},
"plug-circle-bolt": {
"styles": [
"solid"
],
"label": "Plug Circle-bolt",
"terms": [
"Plug Circle-bolt",
"plug-circle-bolt"
]
},
"plug-circle-check": {
"styles": [
"solid"
],
"label": "Plug Circle-check",
"terms": [
"Plug Circle-check",
"plug-circle-check"
]
},
"plug-circle-exclamation": {
"styles": [
"solid"
],
"label": "Plug Circle-exclamation",
"terms": [
"Plug Circle-exclamation",
"plug-circle-exclamation"
]
},
"plug-circle-minus": {
"styles": [
"solid"
],
"label": "Plug Circle-minus",
"terms": [
"Plug Circle-minus",
"plug-circle-minus"
]
},
"plug-circle-plus": {
"styles": [
"solid"
],
"label": "Plug Circle-plus",
"terms": [
"Plug Circle-plus",
"plug-circle-plus"
]
},
"plug-circle-xmark": {
"styles": [
"solid"
],
"label": "Plug Circle-xmark",
"terms": [
"Plug Circle-xmark",
"plug-circle-xmark"
]
},
"plus": {
"styles": [
"solid"
],
"label": "plus",
"terms": [
"add",
"plus",
"plus"
]
},
"plus-minus": {
"styles": [
"solid"
],
"label": "Plus Minus",
"terms": [
"Plus Minus",
"plus-minus"
]
},
"podcast": {
"styles": [
"solid"
],
"label": "Podcast",
"terms": [
"Podcast",
"podcast"
]
},
"poo": {
"styles": [
"solid"
],
"label": "Poo",
"terms": [
"Poo",
"poo"
]
},
"poo-storm": {
"styles": [
"solid"
],
"label": "Poo bolt",
"terms": [
"poo-bolt",
"Poo bolt",
"poo-storm"
]
},
"poop": {
"styles": [
"solid"
],
"label": "Poop",
"terms": [
"Poop",
"poop"
]
},
"power-off": {
"styles": [
"solid"
],
"label": "Power Off",
"terms": [
"Power Off",
"power-off"
]
},
"prescription": {
"styles": [
"solid"
],
"label": "Prescription",
"terms": [
"Prescription",
"prescription"
]
},
"prescription-bottle": {
"styles": [
"solid"
],
"label": "Prescription Bottle",
"terms": [
"Prescription Bottle",
"prescription-bottle"
]
},
"prescription-bottle-medical": {
"styles": [
"solid"
],
"label": "Prescription bottle medical",
"terms": [
"prescription-bottle-alt",
"Prescription bottle medical",
"prescription-bottle-medical"
]
},
"print": {
"styles": [
"solid"
],
"label": "print",
"terms": [
"print",
"print"
]
},
"product-hunt": {
"styles": [
"brands"
],
"label": "Product Hunt",
"terms": [
"Product Hunt",
"product-hunt"
]
},
"pump-medical": {
"styles": [
"solid"
],
"label": "Pump Medical",
"terms": [
"Pump Medical",
"pump-medical"
]
},
"pump-soap": {
"styles": [
"solid"
],
"label": "Pump Soap",
"terms": [
"Pump Soap",
"pump-soap"
]
},
"pushed": {
"styles": [
"brands"
],
"label": "Pushed",
"terms": [
"Pushed",
"pushed"
]
},
"puzzle-piece": {
"styles": [
"solid"
],
"label": "Puzzle Piece",
"terms": [
"Puzzle Piece",
"puzzle-piece"
]
},
"python": {
"styles": [
"brands"
],
"label": "Python",
"terms": [
"Python",
"python"
]
},
"q": {
"styles": [
"solid"
],
"label": "Q",
"terms": [
"Q",
"q"
]
},
"qq": {
"styles": [
"brands"
],
"label": "QQ",
"terms": [
"QQ",
"qq"
]
},
"qrcode": {
"styles": [
"solid"
],
"label": "qrcode",
"terms": [
"qrcode",
"qrcode"
]
},
"question": {
"styles": [
"solid"
],
"label": "Question",
"terms": [
"Question",
"question"
]
},
"quinscape": {
"styles": [
"brands"
],
"label": "QuinScape",
"terms": [
"QuinScape",
"quinscape"
]
},
"quora": {
"styles": [
"brands"
],
"label": "Quora",
"terms": [
"Quora",
"quora"
]
},
"quote-left": {
"styles": [
"solid"
],
"label": "quote-left",
"terms": [
"quote-left-alt",
"quote-left",
"quote-left"
]
},
"quote-right": {
"styles": [
"solid"
],
"label": "quote-right",
"terms": [
"quote-right-alt",
"quote-right",
"quote-right"
]
},
"r": {
"styles": [
"solid"
],
"label": "R",
"terms": [
"R",
"r"
]
},
"r-project": {
"styles": [
"brands"
],
"label": "R Project",
"terms": [
"R Project",
"r-project"
]
},
"radiation": {
"styles": [
"solid"
],
"label": "Radiation",
"terms": [
"Radiation",
"radiation"
]
},
"radio": {
"styles": [
"solid"
],
"label": "Radio",
"terms": [
"Radio",
"radio"
]
},
"rainbow": {
"styles": [
"solid"
],
"label": "Rainbow",
"terms": [
"Rainbow",
"rainbow"
]
},
"ranking-star": {
"styles": [
"solid"
],
"label": "Ranking Star",
"terms": [
"Ranking Star",
"ranking-star"
]
},
"raspberry-pi": {
"styles": [
"brands"
],
"label": "Raspberry Pi",
"terms": [
"Raspberry Pi",
"raspberry-pi"
]
},
"ravelry": {
"styles": [
"brands"
],
"label": "Ravelry",
"terms": [
"Ravelry",
"ravelry"
]
},
"react": {
"styles": [
"brands"
],
"label": "React",
"terms": [
"React",
"react"
]
},
"reacteurope": {
"styles": [
"brands"
],
"label": "ReactEurope",
"terms": [
"ReactEurope",
"reacteurope"
]
},
"readme": {
"styles": [
"brands"
],
"label": "ReadMe",
"terms": [
"ReadMe",
"readme"
]
},
"rebel": {
"styles": [
"brands"
],
"label": "Rebel Alliance",
"terms": [
"Rebel Alliance",
"rebel"
]
},
"receipt": {
"styles": [
"solid"
],
"label": "Receipt",
"terms": [
"Receipt",
"receipt"
]
},
"record-vinyl": {
"styles": [
"solid"
],
"label": "Record Vinyl",
"terms": [
"Record Vinyl",
"record-vinyl"
]
},
"rectangle-ad": {
"styles": [
"solid"
],
"label": "Rectangle ad",
"terms": [
"ad",
"Rectangle ad",
"rectangle-ad"
]
},
"rectangle-list": {
"styles": [
"solid",
"regular"
],
"label": "Rectangle list",
"terms": [
"list-alt",
"Rectangle list",
"rectangle-list"
]
},
"rectangle-xmark": {
"styles": [
"solid",
"regular"
],
"label": "Rectangle X Mark",
"terms": [
"rectangle-times",
"times-rectangle",
"window-close",
"Rectangle X Mark",
"rectangle-xmark"
]
},
"recycle": {
"styles": [
"solid"
],
"label": "Recycle",
"terms": [
"Recycle",
"recycle"
]
},
"red-river": {
"styles": [
"brands"
],
"label": "red river",
"terms": [
"red river",
"red-river"
]
},
"reddit": {
"styles": [
"brands"
],
"label": "reddit Logo",
"terms": [
"reddit Logo",
"reddit"
]
},
"reddit-alien": {
"styles": [
"brands"
],
"label": "reddit Alien",
"terms": [
"reddit Alien",
"reddit-alien"
]
},
"redhat": {
"styles": [
"brands"
],
"label": "Redhat",
"terms": [
"Redhat",
"redhat"
]
},
"registered": {
"styles": [
"solid",
"regular"
],
"label": "Registered Trademark",
"terms": [
"Registered Trademark",
"registered"
]
},
"renren": {
"styles": [
"brands"
],
"label": "Renren",
"terms": [
"Renren",
"renren"
]
},
"repeat": {
"styles": [
"solid"
],
"label": "Repeat",
"terms": [
"Repeat",
"repeat"
]
},
"reply": {
"styles": [
"solid"
],
"label": "Reply",
"terms": [
"mail-reply",
"Reply",
"reply"
]
},
"reply-all": {
"styles": [
"solid"
],
"label": "reply-all",
"terms": [
"mail-reply-all",
"reply-all",
"reply-all"
]
},
"replyd": {
"styles": [
"brands"
],
"label": "replyd",
"terms": [
"replyd",
"replyd"
]
},
"republican": {
"styles": [
"solid"
],
"label": "Republican",
"terms": [
"Republican",
"republican"
]
},
"researchgate": {
"styles": [
"brands"
],
"label": "Researchgate",
"terms": [
"Researchgate",
"researchgate"
]
},
"resolving": {
"styles": [
"brands"
],
"label": "Resolving",
"terms": [
"Resolving",
"resolving"
]
},
"restroom": {
"styles": [
"solid"
],
"label": "Restroom",
"terms": [
"Restroom",
"restroom"
]
},
"retweet": {
"styles": [
"solid"
],
"label": "Retweet",
"terms": [
"Retweet",
"retweet"
]
},
"rev": {
"styles": [
"brands"
],
"label": "Rev.io",
"terms": [
"Rev.io",
"rev"
]
},
"ribbon": {
"styles": [
"solid"
],
"label": "Ribbon",
"terms": [
"Ribbon",
"ribbon"
]
},
"right-from-bracket": {
"styles": [
"solid"
],
"label": "Right from bracket",
"terms": [
"sign-out-alt",
"Right from bracket",
"right-from-bracket"
]
},
"right-left": {
"styles": [
"solid"
],
"label": "Right left",
"terms": [
"exchange-alt",
"Right left",
"right-left"
]
},
"right-long": {
"styles": [
"solid"
],
"label": "Right long",
"terms": [
"long-arrow-alt-right",
"Right long",
"right-long"
]
},
"right-to-bracket": {
"styles": [
"solid"
],
"label": "Right to bracket",
"terms": [
"sign-in-alt",
"Right to bracket",
"right-to-bracket"
]
},
"ring": {
"styles": [
"solid"
],
"label": "Ring",
"terms": [
"Ring",
"ring"
]
},
"road": {
"styles": [
"solid"
],
"label": "road",
"terms": [
"road",
"road"
]
},
"road-barrier": {
"styles": [
"solid"
],
"label": "Road Barrier",
"terms": [
"Road Barrier",
"road-barrier"
]
},
"road-bridge": {
"styles": [
"solid"
],
"label": "Road Bridge",
"terms": [
"Road Bridge",
"road-bridge"
]
},
"road-circle-check": {
"styles": [
"solid"
],
"label": "Road Circle-check",
"terms": [
"Road Circle-check",
"road-circle-check"
]
},
"road-circle-exclamation": {
"styles": [
"solid"
],
"label": "Road Circle-exclamation",
"terms": [
"Road Circle-exclamation",
"road-circle-exclamation"
]
},
"road-circle-xmark": {
"styles": [
"solid"
],
"label": "Road Circle-xmark",
"terms": [
"Road Circle-xmark",
"road-circle-xmark"
]
},
"road-lock": {
"styles": [
"solid"
],
"label": "Road Lock",
"terms": [
"Road Lock",
"road-lock"
]
},
"road-spikes": {
"styles": [
"solid"
],
"label": "Road Spikes",
"terms": [
"Road Spikes",
"road-spikes"
]
},
"robot": {
"styles": [
"solid"
],
"label": "Robot",
"terms": [
"Robot",
"robot"
]
},
"rocket": {
"styles": [
"solid"
],
"label": "rocket",
"terms": [
"rocket",
"rocket"
]
},
"rocketchat": {
"styles": [
"brands"
],
"label": "Rocket.Chat",
"terms": [
"Rocket.Chat",
"rocketchat"
]
},
"rockrms": {
"styles": [
"brands"
],
"label": "Rockrms",
"terms": [
"Rockrms",
"rockrms"
]
},
"rotate": {
"styles": [
"solid"
],
"label": "Rotate",
"terms": [
"sync-alt",
"Rotate",
"rotate"
]
},
"rotate-left": {
"styles": [
"solid"
],
"label": "Rotate Left",
"terms": [
"rotate-back",
"rotate-backward",
"undo-alt",
"Rotate Left",
"rotate-left"
]
},
"rotate-right": {
"styles": [
"solid"
],
"label": "Rotate Right",
"terms": [
"redo-alt",
"rotate-forward",
"Rotate Right",
"rotate-right"
]
},
"route": {
"styles": [
"solid"
],
"label": "Route",
"terms": [
"Route",
"route"
]
},
"rss": {
"styles": [
"solid"
],
"label": "rss",
"terms": [
"feed",
"rss",
"rss"
]
},
"ruble-sign": {
"styles": [
"solid"
],
"label": "Ruble Sign",
"terms": [
"rouble",
"rub",
"ruble",
"Ruble Sign",
"ruble-sign"
]
},
"rug": {
"styles": [
"solid"
],
"label": "Rug",
"terms": [
"Rug",
"rug"
]
},
"ruler": {
"styles": [
"solid"
],
"label": "Ruler",
"terms": [
"Ruler",
"ruler"
]
},
"ruler-combined": {
"styles": [
"solid"
],
"label": "Ruler Combined",
"terms": [
"Ruler Combined",
"ruler-combined"
]
},
"ruler-horizontal": {
"styles": [
"solid"
],
"label": "Ruler Horizontal",
"terms": [
"Ruler Horizontal",
"ruler-horizontal"
]
},
"ruler-vertical": {
"styles": [
"solid"
],
"label": "Ruler Vertical",
"terms": [
"Ruler Vertical",
"ruler-vertical"
]
},
"rupee-sign": {
"styles": [
"solid"
],
"label": "Indian Rupee Sign",
"terms": [
"rupee",
"Indian Rupee Sign",
"rupee-sign"
]
},
"rupiah-sign": {
"styles": [
"solid"
],
"label": "Rupiah Sign",
"terms": [
"Rupiah Sign",
"rupiah-sign"
]
},
"rust": {
"styles": [
"brands"
],
"label": "Rust",
"terms": [
"Rust",
"rust"
]
},
"s": {
"styles": [
"solid"
],
"label": "S",
"terms": [
"S",
"s"
]
},
"sack-dollar": {
"styles": [
"solid"
],
"label": "Sack of Money",
"terms": [
"Sack of Money",
"sack-dollar"
]
},
"sack-xmark": {
"styles": [
"solid"
],
"label": "Sack Xmark",
"terms": [
"Sack Xmark",
"sack-xmark"
]
},
"safari": {
"styles": [
"brands"
],
"label": "Safari",
"terms": [
"Safari",
"safari"
]
},
"sailboat": {
"styles": [
"solid"
],
"label": "Sailboat",
"terms": [
"Sailboat",
"sailboat"
]
},
"salesforce": {
"styles": [
"brands"
],
"label": "Salesforce",
"terms": [
"Salesforce",
"salesforce"
]
},
"sass": {
"styles": [
"brands"
],
"label": "Sass",
"terms": [
"Sass",
"sass"
]
},
"satellite": {
"styles": [
"solid"
],
"label": "Satellite",
"terms": [
"Satellite",
"satellite"
]
},
"satellite-dish": {
"styles": [
"solid"
],
"label": "Satellite Dish",
"terms": [
"Satellite Dish",
"satellite-dish"
]
},
"scale-balanced": {
"styles": [
"solid"
],
"label": "Scale balanced",
"terms": [
"balance-scale",
"Scale balanced",
"scale-balanced"
]
},
"scale-unbalanced": {
"styles": [
"solid"
],
"label": "Scale unbalanced",
"terms": [
"balance-scale-left",
"Scale unbalanced",
"scale-unbalanced"
]
},
"scale-unbalanced-flip": {
"styles": [
"solid"
],
"label": "Scale unbalanced flip",
"terms": [
"balance-scale-right",
"Scale unbalanced flip",
"scale-unbalanced-flip"
]
},
"schlix": {
"styles": [
"brands"
],
"label": "SCHLIX",
"terms": [
"SCHLIX",
"schlix"
]
},
"school": {
"styles": [
"solid"
],
"label": "School",
"terms": [
"School",
"school"
]
},
"school-circle-check": {
"styles": [
"solid"
],
"label": "School Circle-check",
"terms": [
"School Circle-check",
"school-circle-check"
]
},
"school-circle-exclamation": {
"styles": [
"solid"
],
"label": "School Circle-exclamation",
"terms": [
"School Circle-exclamation",
"school-circle-exclamation"
]
},
"school-circle-xmark": {
"styles": [
"solid"
],
"label": "School Circle-xmark",
"terms": [
"School Circle-xmark",
"school-circle-xmark"
]
},
"school-flag": {
"styles": [
"solid"
],
"label": "School Flag",
"terms": [
"School Flag",
"school-flag"
]
},
"school-lock": {
"styles": [
"solid"
],
"label": "School Lock",
"terms": [
"School Lock",
"school-lock"
]
},
"scissors": {
"styles": [
"solid"
],
"label": "Scissors",
"terms": [
"cut",
"Scissors",
"scissors"
]
},
"screenpal": {
"styles": [
"brands"
],
"label": "Screenpal",
"terms": [
"Screenpal",
"screenpal"
]
},
"screwdriver": {
"styles": [
"solid"
],
"label": "Screwdriver",
"terms": [
"Screwdriver",
"screwdriver"
]
},
"screwdriver-wrench": {
"styles": [
"solid"
],
"label": "Screwdriver wrench",
"terms": [
"tools",
"Screwdriver wrench",
"screwdriver-wrench"
]
},
"scribd": {
"styles": [
"brands"
],
"label": "Scribd",
"terms": [
"Scribd",
"scribd"
]
},
"scroll": {
"styles": [
"solid"
],
"label": "Scroll",
"terms": [
"Scroll",
"scroll"
]
},
"scroll-torah": {
"styles": [
"solid"
],
"label": "Scroll torah",
"terms": [
"torah",
"Scroll torah",
"scroll-torah"
]
},
"sd-card": {
"styles": [
"solid"
],
"label": "Sd Card",
"terms": [
"Sd Card",
"sd-card"
]
},
"searchengin": {
"styles": [
"brands"
],
"label": "Searchengin",
"terms": [
"Searchengin",
"searchengin"
]
},
"section": {
"styles": [
"solid"
],
"label": "Section",
"terms": [
"Section",
"section"
]
},
"seedling": {
"styles": [
"solid"
],
"label": "Seedling",
"terms": [
"sprout",
"Seedling",
"seedling"
]
},
"sellcast": {
"styles": [
"brands"
],
"label": "Sellcast",
"terms": [
"Sellcast",
"sellcast"
]
},
"sellsy": {
"styles": [
"brands"
],
"label": "Sellsy",
"terms": [
"Sellsy",
"sellsy"
]
},
"server": {
"styles": [
"solid"
],
"label": "Server",
"terms": [
"Server",
"server"
]
},
"servicestack": {
"styles": [
"brands"
],
"label": "Servicestack",
"terms": [
"Servicestack",
"servicestack"
]
},
"shapes": {
"styles": [
"solid"
],
"label": "Shapes",
"terms": [
"triangle-circle-square",
"Shapes",
"shapes"
]
},
"share": {
"styles": [
"solid"
],
"label": "Share",
"terms": [
"arrow-turn-right",
"mail-forward",
"Share",
"share"
]
},
"share-from-square": {
"styles": [
"solid",
"regular"
],
"label": "Share from square",
"terms": [
"share-square",
"Share from square",
"share-from-square"
]
},
"share-nodes": {
"styles": [
"solid"
],
"label": "Share nodes",
"terms": [
"share-alt",
"Share nodes",
"share-nodes"
]
},
"sheet-plastic": {
"styles": [
"solid"
],
"label": "Sheet Plastic",
"terms": [
"Sheet Plastic",
"sheet-plastic"
]
},
"shekel-sign": {
"styles": [
"solid"
],
"label": "Shekel Sign",
"terms": [
"ils",
"shekel",
"sheqel",
"sheqel-sign",
"Shekel Sign",
"shekel-sign"
]
},
"shield": {
"styles": [
"solid"
],
"label": "shield",
"terms": [
"shield-blank",
"shield",
"shield"
]
},
"shield-cat": {
"styles": [
"solid"
],
"label": "Shield Cat",
"terms": [
"Shield Cat",
"shield-cat"
]
},
"shield-dog": {
"styles": [
"solid"
],
"label": "Shield Dog",
"terms": [
"Shield Dog",
"shield-dog"
]
},
"shield-halved": {
"styles": [
"solid"
],
"label": "Shield Halved",
"terms": [
"shield-alt",
"Shield Halved",
"shield-halved"
]
},
"shield-heart": {
"styles": [
"solid"
],
"label": "Shield Heart",
"terms": [
"Shield Heart",
"shield-heart"
]
},
"shield-virus": {
"styles": [
"solid"
],
"label": "Shield Virus",
"terms": [
"Shield Virus",
"shield-virus"
]
},
"ship": {
"styles": [
"solid"
],
"label": "Ship",
"terms": [
"Ship",
"ship"
]
},
"shirt": {
"styles": [
"solid"
],
"label": "T-Shirt",
"terms": [
"t-shirt",
"tshirt",
"T-Shirt",
"shirt"
]
},
"shirtsinbulk": {
"styles": [
"brands"
],
"label": "Shirts in Bulk",
"terms": [
"Shirts in Bulk",
"shirtsinbulk"
]
},
"shoe-prints": {
"styles": [
"solid"
],
"label": "Shoe Prints",
"terms": [
"Shoe Prints",
"shoe-prints"
]
},
"shop": {
"styles": [
"solid"
],
"label": "Shop",
"terms": [
"store-alt",
"Shop",
"shop"
]
},
"shop-lock": {
"styles": [
"solid"
],
"label": "Shop Lock",
"terms": [
"Shop Lock",
"shop-lock"
]
},
"shop-slash": {
"styles": [
"solid"
],
"label": "Shop slash",
"terms": [
"store-alt-slash",
"Shop slash",
"shop-slash"
]
},
"shopify": {
"styles": [
"brands"
],
"label": "Shopify",
"terms": [
"Shopify",
"shopify"
]
},
"shopware": {
"styles": [
"brands"
],
"label": "Shopware",
"terms": [
"Shopware",
"shopware"
]
},
"shower": {
"styles": [
"solid"
],
"label": "Shower",
"terms": [
"Shower",
"shower"
]
},
"shrimp": {
"styles": [
"solid"
],
"label": "Shrimp",
"terms": [
"Shrimp",
"shrimp"
]
},
"shuffle": {
"styles": [
"solid"
],
"label": "Shuffle",
"terms": [
"random",
"Shuffle",
"shuffle"
]
},
"shuttle-space": {
"styles": [
"solid"
],
"label": "Shuttle space",
"terms": [
"space-shuttle",
"Shuttle space",
"shuttle-space"
]
},
"sign-hanging": {
"styles": [
"solid"
],
"label": "Sign hanging",
"terms": [
"sign",
"Sign hanging",
"sign-hanging"
]
},
"signal": {
"styles": [
"solid"
],
"label": "signal",
"terms": [
"signal-5",
"signal-perfect",
"signal",
"signal"
]
},
"signature": {
"styles": [
"solid"
],
"label": "Signature",
"terms": [
"Signature",
"signature"
]
},
"signs-post": {
"styles": [
"solid"
],
"label": "Signs post",
"terms": [
"map-signs",
"Signs post",
"signs-post"
]
},
"sim-card": {
"styles": [
"solid"
],
"label": "SIM Card",
"terms": [
"SIM Card",
"sim-card"
]
},
"simplybuilt": {
"styles": [
"brands"
],
"label": "SimplyBuilt",
"terms": [
"SimplyBuilt",
"simplybuilt"
]
},
"sink": {
"styles": [
"solid"
],
"label": "Sink",
"terms": [
"Sink",
"sink"
]
},
"sistrix": {
"styles": [
"brands"
],
"label": "SISTRIX",
"terms": [
"SISTRIX",
"sistrix"
]
},
"sitemap": {
"styles": [
"solid"
],
"label": "Sitemap",
"terms": [
"Sitemap",
"sitemap"
]
},
"sith": {
"styles": [
"brands"
],
"label": "Sith",
"terms": [
"Sith",
"sith"
]
},
"sitrox": {
"styles": [
"brands"
],
"label": "Sitrox",
"terms": [
"Sitrox",
"sitrox"
]
},
"sketch": {
"styles": [
"brands"
],
"label": "Sketch",
"terms": [
"Sketch",
"sketch"
]
},
"skull": {
"styles": [
"solid"
],
"label": "Skull",
"terms": [
"Skull",
"skull"
]
},
"skull-crossbones": {
"styles": [
"solid"
],
"label": "Skull & Crossbones",
"terms": [
"Skull & Crossbones",
"skull-crossbones"
]
},
"skyatlas": {
"styles": [
"brands"
],
"label": "skyatlas",
"terms": [
"skyatlas",
"skyatlas"
]
},
"skype": {
"styles": [
"brands"
],
"label": "Skype",
"terms": [
"Skype",
"skype"
]
},
"slack": {
"styles": [
"brands"
],
"label": "Slack Logo",
"terms": [
"slack-hash",
"Slack Logo",
"slack"
]
},
"slash": {
"styles": [
"solid"
],
"label": "Slash",
"terms": [
"Slash",
"slash"
]
},
"sleigh": {
"styles": [
"solid"
],
"label": "Sleigh",
"terms": [
"Sleigh",
"sleigh"
]
},
"sliders": {
"styles": [
"solid"
],
"label": "Sliders",
"terms": [
"sliders-h",
"Sliders",
"sliders"
]
},
"slideshare": {
"styles": [
"brands"
],
"label": "Slideshare",
"terms": [
"Slideshare",
"slideshare"
]
},
"smog": {
"styles": [
"solid"
],
"label": "Smog",
"terms": [
"Smog",
"smog"
]
},
"smoking": {
"styles": [
"solid"
],
"label": "Smoking",
"terms": [
"Smoking",
"smoking"
]
},
"snapchat": {
"styles": [
"brands"
],
"label": "Snapchat",
"terms": [
"snapchat-ghost",
"Snapchat",
"snapchat"
]
},
"snowflake": {
"styles": [
"solid",
"regular"
],
"label": "Snowflake",
"terms": [
"Snowflake",
"snowflake"
]
},
"snowman": {
"styles": [
"solid"
],
"label": "Snowman",
"terms": [
"Snowman",
"snowman"
]
},
"snowplow": {
"styles": [
"solid"
],
"label": "Snowplow",
"terms": [
"Snowplow",
"snowplow"
]
},
"soap": {
"styles": [
"solid"
],
"label": "Soap",
"terms": [
"Soap",
"soap"
]
},
"socks": {
"styles": [
"solid"
],
"label": "Socks",
"terms": [
"Socks",
"socks"
]
},
"solar-panel": {
"styles": [
"solid"
],
"label": "Solar Panel",
"terms": [
"Solar Panel",
"solar-panel"
]
},
"sort": {
"styles": [
"solid"
],
"label": "Sort",
"terms": [
"unsorted",
"Sort",
"sort"
]
},
"sort-down": {
"styles": [
"solid"
],
"label": "Sort Down (Descending)",
"terms": [
"sort-desc",
"Sort Down (Descending)",
"sort-down"
]
},
"sort-up": {
"styles": [
"solid"
],
"label": "Sort Up (Ascending)",
"terms": [
"sort-asc",
"Sort Up (Ascending)",
"sort-up"
]
},
"soundcloud": {
"styles": [
"brands"
],
"label": "SoundCloud",
"terms": [
"SoundCloud",
"soundcloud"
]
},
"sourcetree": {
"styles": [
"brands"
],
"label": "Sourcetree",
"terms": [
"Sourcetree",
"sourcetree"
]
},
"spa": {
"styles": [
"solid"
],
"label": "Spa",
"terms": [
"Spa",
"spa"
]
},
"space-awesome": {
"styles": [
"brands"
],
"label": "Space Awesome",
"terms": [
"Space Awesome",
"space-awesome"
]
},
"spaghetti-monster-flying": {
"styles": [
"solid"
],
"label": "Spaghetti monster flying",
"terms": [
"pastafarianism",
"Spaghetti monster flying",
"spaghetti-monster-flying"
]
},
"speakap": {
"styles": [
"brands"
],
"label": "Speakap",
"terms": [
"Speakap",
"speakap"
]
},
"speaker-deck": {
"styles": [
"brands"
],
"label": "Speaker Deck",
"terms": [
"Speaker Deck",
"speaker-deck"
]
},
"spell-check": {
"styles": [
"solid"
],
"label": "Spell Check",
"terms": [
"Spell Check",
"spell-check"
]
},
"spider": {
"styles": [
"solid"
],
"label": "Spider",
"terms": [
"Spider",
"spider"
]
},
"spinner": {
"styles": [
"solid"
],
"label": "Spinner",
"terms": [
"Spinner",
"spinner"
]
},
"splotch": {
"styles": [
"solid"
],
"label": "Splotch",
"terms": [
"Splotch",
"splotch"
]
},
"spoon": {
"styles": [
"solid"
],
"label": "Spoon",
"terms": [
"utensil-spoon",
"Spoon",
"spoon"
]
},
"spotify": {
"styles": [
"brands"
],
"label": "Spotify",
"terms": [
"Spotify",
"spotify"
]
},
"spray-can": {
"styles": [
"solid"
],
"label": "Spray Can",
"terms": [
"Spray Can",
"spray-can"
]
},
"spray-can-sparkles": {
"styles": [
"solid"
],
"label": "Spray Can Sparkles",
"terms": [
"air-freshener",
"Spray Can Sparkles",
"spray-can-sparkles"
]
},
"square": {
"styles": [
"solid",
"regular"
],
"label": "Square",
"terms": [
"Square",
"square"
]
},
"square-arrow-up-right": {
"styles": [
"solid"
],
"label": "Square arrow up right",
"terms": [
"external-link-square",
"Square arrow up right",
"square-arrow-up-right"
]
},
"square-behance": {
"styles": [
"brands"
],
"label": "Behance Square",
"terms": [
"behance-square",
"Behance Square",
"square-behance"
]
},
"square-caret-down": {
"styles": [
"solid",
"regular"
],
"label": "Square caret down",
"terms": [
"caret-square-down",
"Square caret down",
"square-caret-down"
]
},
"square-caret-left": {
"styles": [
"solid",
"regular"
],
"label": "Square caret left",
"terms": [
"caret-square-left",
"Square caret left",
"square-caret-left"
]
},
"square-caret-right": {
"styles": [
"solid",
"regular"
],
"label": "Square caret right",
"terms": [
"caret-square-right",
"Square caret right",
"square-caret-right"
]
},
"square-caret-up": {
"styles": [
"solid",
"regular"
],
"label": "Square caret up",
"terms": [
"caret-square-up",
"Square caret up",
"square-caret-up"
]
},
"square-check": {
"styles": [
"solid",
"regular"
],
"label": "Square check",
"terms": [
"check-square",
"Square check",
"square-check"
]
},
"square-dribbble": {
"styles": [
"brands"
],
"label": "Dribbble Square",
"terms": [
"dribbble-square",
"Dribbble Square",
"square-dribbble"
]
},
"square-envelope": {
"styles": [
"solid"
],
"label": "Square envelope",
"terms": [
"envelope-square",
"Square envelope",
"square-envelope"
]
},
"square-facebook": {
"styles": [
"brands"
],
"label": "Facebook Square",
"terms": [
"facebook-square",
"Facebook Square",
"square-facebook"
]
},
"square-font-awesome": {
"styles": [
"brands"
],
"label": "Font Awesome in Square",
"terms": [
"Font Awesome in Square",
"square-font-awesome"
]
},
"square-font-awesome-stroke": {
"styles": [
"brands"
],
"label": "Font Awesome in Square with Stroke Outline",
"terms": [
"font-awesome-alt",
"Font Awesome in Square with Stroke Outline",
"square-font-awesome-stroke"
]
},
"square-full": {
"styles": [
"solid",
"regular"
],
"label": "Square Full",
"terms": [
"Square Full",
"square-full"
]
},
"square-git": {
"styles": [
"brands"
],
"label": "Git Square",
"terms": [
"git-square",
"Git Square",
"square-git"
]
},
"square-github": {
"styles": [
"brands"
],
"label": "GitHub Square",
"terms": [
"github-square",
"GitHub Square",
"square-github"
]
},
"square-gitlab": {
"styles": [
"brands"
],
"label": "Square Gitlab",
"terms": [
"gitlab-square",
"Square Gitlab",
"square-gitlab"
]
},
"square-google-plus": {
"styles": [
"brands"
],
"label": "Google Plus Square",
"terms": [
"google-plus-square",
"Google Plus Square",
"square-google-plus"
]
},
"square-h": {
"styles": [
"solid"
],
"label": "Square h",
"terms": [
"h-square",
"Square h",
"square-h"
]
},
"square-hacker-news": {
"styles": [
"brands"
],
"label": "Hacker News Square",
"terms": [
"hacker-news-square",
"Hacker News Square",
"square-hacker-news"
]
},
"square-instagram": {
"styles": [
"brands"
],
"label": "Instagram Square",
"terms": [
"instagram-square",
"Instagram Square",
"square-instagram"
]
},
"square-js": {
"styles": [
"brands"
],
"label": "JavaScript (JS) Square",
"terms": [
"js-square",
"JavaScript (JS) Square",
"square-js"
]
},
"square-lastfm": {
"styles": [
"brands"
],
"label": "last.fm Square",
"terms": [
"lastfm-square",
"last.fm Square",
"square-lastfm"
]
},
"square-minus": {
"styles": [
"solid",
"regular"
],
"label": "Square minus",
"terms": [
"minus-square",
"Square minus",
"square-minus"
]
},
"square-nfi": {
"styles": [
"solid"
],
"label": "Square Nfi",
"terms": [
"Square Nfi",
"square-nfi"
]
},
"square-odnoklassniki": {
"styles": [
"brands"
],
"label": "Odnoklassniki Square",
"terms": [
"odnoklassniki-square",
"Odnoklassniki Square",
"square-odnoklassniki"
]
},
"square-parking": {
"styles": [
"solid"
],
"label": "Square parking",
"terms": [
"parking",
"Square parking",
"square-parking"
]
},
"square-pen": {
"styles": [
"solid"
],
"label": "Square pen",
"terms": [
"pen-square",
"pencil-square",
"Square pen",
"square-pen"
]
},
"square-person-confined": {
"styles": [
"solid"
],
"label": "Square Person-confined",
"terms": [
"Square Person-confined",
"square-person-confined"
]
},
"square-phone": {
"styles": [
"solid"
],
"label": "Square phone",
"terms": [
"phone-square",
"Square phone",
"square-phone"
]
},
"square-phone-flip": {
"styles": [
"solid"
],
"label": "Square phone flip",
"terms": [
"phone-square-alt",
"Square phone flip",
"square-phone-flip"
]
},
"square-pied-piper": {
"styles": [
"brands"
],
"label": "Pied Piper Square Logo (Old)",
"terms": [
"pied-piper-square",
"Pied Piper Square Logo (Old)",
"square-pied-piper"
]
},
"square-pinterest": {
"styles": [
"brands"
],
"label": "Pinterest Square",
"terms": [
"pinterest-square",
"Pinterest Square",
"square-pinterest"
]
},
"square-plus": {
"styles": [
"solid",
"regular"
],
"label": "Square plus",
"terms": [
"plus-square",
"Square plus",
"square-plus"
]
},
"square-poll-horizontal": {
"styles": [
"solid"
],
"label": "Square poll horizontal",
"terms": [
"poll-h",
"Square poll horizontal",
"square-poll-horizontal"
]
},
"square-poll-vertical": {
"styles": [
"solid"
],
"label": "Square poll vertical",
"terms": [
"poll",
"Square poll vertical",
"square-poll-vertical"
]
},
"square-reddit": {
"styles": [
"brands"
],
"label": "reddit Square",
"terms": [
"reddit-square",
"reddit Square",
"square-reddit"
]
},
"square-root-variable": {
"styles": [
"solid"
],
"label": "Square root variable",
"terms": [
"square-root-alt",
"Square root variable",
"square-root-variable"
]
},
"square-rss": {
"styles": [
"solid"
],
"label": "Square rss",
"terms": [
"rss-square",
"Square rss",
"square-rss"
]
},
"square-share-nodes": {
"styles": [
"solid"
],
"label": "Square share nodes",
"terms": [
"share-alt-square",
"Square share nodes",
"square-share-nodes"
]
},
"square-snapchat": {
"styles": [
"brands"
],
"label": "Snapchat Square",
"terms": [
"snapchat-square",
"Snapchat Square",
"square-snapchat"
]
},
"square-steam": {
"styles": [
"brands"
],
"label": "Steam Square",
"terms": [
"steam-square",
"Steam Square",
"square-steam"
]
},
"square-tumblr": {
"styles": [
"brands"
],
"label": "Tumblr Square",
"terms": [
"tumblr-square",
"Tumblr Square",
"square-tumblr"
]
},
"square-twitter": {
"styles": [
"brands"
],
"label": "Twitter Square",
"terms": [
"twitter-square",
"Twitter Square",
"square-twitter"
]
},
"square-up-right": {
"styles": [
"solid"
],
"label": "Square up right",
"terms": [
"external-link-square-alt",
"Square up right",
"square-up-right"
]
},
"square-viadeo": {
"styles": [
"brands"
],
"label": "Viadeo Square",
"terms": [
"viadeo-square",
"Viadeo Square",
"square-viadeo"
]
},
"square-vimeo": {
"styles": [
"brands"
],
"label": "Vimeo Square",
"terms": [
"vimeo-square",
"Vimeo Square",
"square-vimeo"
]
},
"square-virus": {
"styles": [
"solid"
],
"label": "Square Virus",
"terms": [
"Square Virus",
"square-virus"
]
},
"square-whatsapp": {
"styles": [
"brands"
],
"label": "What's App Square",
"terms": [
"whatsapp-square",
"What's App Square",
"square-whatsapp"
]
},
"square-xing": {
"styles": [
"brands"
],
"label": "Xing Square",
"terms": [
"xing-square",
"Xing Square",
"square-xing"
]
},
"square-xmark": {
"styles": [
"solid"
],
"label": "Square X Mark",
"terms": [
"times-square",
"xmark-square",
"Square X Mark",
"square-xmark"
]
},
"square-youtube": {
"styles": [
"brands"
],
"label": "YouTube Square",
"terms": [
"youtube-square",
"YouTube Square",
"square-youtube"
]
},
"squarespace": {
"styles": [
"brands"
],
"label": "Squarespace",
"terms": [
"Squarespace",
"squarespace"
]
},
"stack-exchange": {
"styles": [
"brands"
],
"label": "Stack Exchange",
"terms": [
"Stack Exchange",
"stack-exchange"
]
},
"stack-overflow": {
"styles": [
"brands"
],
"label": "Stack Overflow",
"terms": [
"Stack Overflow",
"stack-overflow"
]
},
"stackpath": {
"styles": [
"brands"
],
"label": "Stackpath",
"terms": [
"Stackpath",
"stackpath"
]
},
"staff-snake": {
"styles": [
"solid"
],
"label": "Staff Aesculapius",
"terms": [
"rod-asclepius",
"rod-snake",
"staff-aesculapius",
"Staff Aesculapius",
"staff-snake"
]
},
"stairs": {
"styles": [
"solid"
],
"label": "Stairs",
"terms": [
"Stairs",
"stairs"
]
},
"stamp": {
"styles": [
"solid"
],
"label": "Stamp",
"terms": [
"Stamp",
"stamp"
]
},
"stapler": {
"styles": [
"solid"
],
"label": "Stapler",
"terms": [
"Stapler",
"stapler"
]
},
"star": {
"styles": [
"solid",
"regular"
],
"label": "Star",
"terms": [
"Star",
"star"
]
},
"star-and-crescent": {
"styles": [
"solid"
],
"label": "Star and Crescent",
"terms": [
"Star and Crescent",
"star-and-crescent"
]
},
"star-half": {
"styles": [
"solid",
"regular"
],
"label": "star-half",
"terms": [
"star-half",
"star-half"
]
},
"star-half-stroke": {
"styles": [
"solid",
"regular"
],
"label": "Star half stroke",
"terms": [
"star-half-alt",
"Star half stroke",
"star-half-stroke"
]
},
"star-of-david": {
"styles": [
"solid"
],
"label": "Star of David",
"terms": [
"Star of David",
"star-of-david"
]
},
"star-of-life": {
"styles": [
"solid"
],
"label": "Star of Life",
"terms": [
"Star of Life",
"star-of-life"
]
},
"staylinked": {
"styles": [
"brands"
],
"label": "StayLinked",
"terms": [
"StayLinked",
"staylinked"
]
},
"steam": {
"styles": [
"brands"
],
"label": "Steam",
"terms": [
"Steam",
"steam"
]
},
"steam-symbol": {
"styles": [
"brands"
],
"label": "Steam Symbol",
"terms": [
"Steam Symbol",
"steam-symbol"
]
},
"sterling-sign": {
"styles": [
"solid"
],
"label": "Sterling sign",
"terms": [
"gbp",
"pound-sign",
"Sterling sign",
"sterling-sign"
]
},
"stethoscope": {
"styles": [
"solid"
],
"label": "Stethoscope",
"terms": [
"Stethoscope",
"stethoscope"
]
},
"sticker-mule": {
"styles": [
"brands"
],
"label": "Sticker Mule",
"terms": [
"Sticker Mule",
"sticker-mule"
]
},
"stop": {
"styles": [
"solid"
],
"label": "stop",
"terms": [
"stop",
"stop"
]
},
"stopwatch": {
"styles": [
"solid"
],
"label": "Stopwatch",
"terms": [
"Stopwatch",
"stopwatch"
]
},
"stopwatch-20": {
"styles": [
"solid"
],
"label": "Stopwatch 20",
"terms": [
"Stopwatch 20",
"stopwatch-20"
]
},
"store": {
"styles": [
"solid"
],
"label": "Store",
"terms": [
"Store",
"store"
]
},
"store-slash": {
"styles": [
"solid"
],
"label": "Store Slash",
"terms": [
"Store Slash",
"store-slash"
]
},
"strava": {
"styles": [
"brands"
],
"label": "Strava",
"terms": [
"Strava",
"strava"
]
},
"street-view": {
"styles": [
"solid"
],
"label": "Street View",
"terms": [
"Street View",
"street-view"
]
},
"strikethrough": {
"styles": [
"solid"
],
"label": "Strikethrough",
"terms": [
"Strikethrough",
"strikethrough"
]
},
"stripe": {
"styles": [
"brands"
],
"label": "Stripe",
"terms": [
"Stripe",
"stripe"
]
},
"stripe-s": {
"styles": [
"brands"
],
"label": "Stripe S",
"terms": [
"Stripe S",
"stripe-s"
]
},
"stroopwafel": {
"styles": [
"solid"
],
"label": "Stroopwafel",
"terms": [
"Stroopwafel",
"stroopwafel"
]
},
"studiovinari": {
"styles": [
"brands"
],
"label": "Studio Vinari",
"terms": [
"Studio Vinari",
"studiovinari"
]
},
"stumbleupon": {
"styles": [
"brands"
],
"label": "StumbleUpon Logo",
"terms": [
"StumbleUpon Logo",
"stumbleupon"
]
},
"stumbleupon-circle": {
"styles": [
"brands"
],
"label": "StumbleUpon Circle",
"terms": [
"StumbleUpon Circle",
"stumbleupon-circle"
]
},
"subscript": {
"styles": [
"solid"
],
"label": "subscript",
"terms": [
"subscript",
"subscript"
]
},
"suitcase": {
"styles": [
"solid"
],
"label": "Suitcase",
"terms": [
"Suitcase",
"suitcase"
]
},
"suitcase-medical": {
"styles": [
"solid"
],
"label": "Suitcase medical",
"terms": [
"medkit",
"Suitcase medical",
"suitcase-medical"
]
},
"suitcase-rolling": {
"styles": [
"solid"
],
"label": "Suitcase Rolling",
"terms": [
"Suitcase Rolling",
"suitcase-rolling"
]
},
"sun": {
"styles": [
"solid",
"regular"
],
"label": "Sun",
"terms": [
"Sun",
"sun"
]
},
"sun-plant-wilt": {
"styles": [
"solid"
],
"label": "Sun Plant-wilt",
"terms": [
"Sun Plant-wilt",
"sun-plant-wilt"
]
},
"superpowers": {
"styles": [
"brands"
],
"label": "Superpowers",
"terms": [
"Superpowers",
"superpowers"
]
},
"superscript": {
"styles": [
"solid"
],
"label": "superscript",
"terms": [
"superscript",
"superscript"
]
},
"supple": {
"styles": [
"brands"
],
"label": "Supple",
"terms": [
"Supple",
"supple"
]
},
"suse": {
"styles": [
"brands"
],
"label": "Suse",
"terms": [
"Suse",
"suse"
]
},
"swatchbook": {
"styles": [
"solid"
],
"label": "Swatchbook",
"terms": [
"Swatchbook",
"swatchbook"
]
},
"swift": {
"styles": [
"brands"
],
"label": "Swift",
"terms": [
"Swift",
"swift"
]
},
"symfony": {
"styles": [
"brands"
],
"label": "Symfony",
"terms": [
"Symfony",
"symfony"
]
},
"synagogue": {
"styles": [
"solid"
],
"label": "Synagogue",
"terms": [
"Synagogue",
"synagogue"
]
},
"syringe": {
"styles": [
"solid"
],
"label": "Syringe",
"terms": [
"Syringe",
"syringe"
]
},
"t": {
"styles": [
"solid"
],
"label": "T",
"terms": [
"T",
"t"
]
},
"table": {
"styles": [
"solid"
],
"label": "table",
"terms": [
"table",
"table"
]
},
"table-cells": {
"styles": [
"solid"
],
"label": "Table cells",
"terms": [
"th",
"Table cells",
"table-cells"
]
},
"table-cells-large": {
"styles": [
"solid"
],
"label": "Table cells large",
"terms": [
"th-large",
"Table cells large",
"table-cells-large"
]
},
"table-columns": {
"styles": [
"solid"
],
"label": "Table columns",
"terms": [
"columns",
"Table columns",
"table-columns"
]
},
"table-list": {
"styles": [
"solid"
],
"label": "Table list",
"terms": [
"th-list",
"Table list",
"table-list"
]
},
"table-tennis-paddle-ball": {
"styles": [
"solid"
],
"label": "Table tennis paddle ball",
"terms": [
"ping-pong-paddle-ball",
"table-tennis",
"Table tennis paddle ball",
"table-tennis-paddle-ball"
]
},
"tablet": {
"styles": [
"solid"
],
"label": "Tablet",
"terms": [
"tablet-android",
"Tablet",
"tablet"
]
},
"tablet-button": {
"styles": [
"solid"
],
"label": "Tablet button",
"terms": [
"Tablet button",
"tablet-button"
]
},
"tablet-screen-button": {
"styles": [
"solid"
],
"label": "Tablet screen button",
"terms": [
"tablet-alt",
"Tablet screen button",
"tablet-screen-button"
]
},
"tablets": {
"styles": [
"solid"
],
"label": "Tablets",
"terms": [
"Tablets",
"tablets"
]
},
"tachograph-digital": {
"styles": [
"solid"
],
"label": "Tachograph digital",
"terms": [
"digital-tachograph",
"Tachograph digital",
"tachograph-digital"
]
},
"tag": {
"styles": [
"solid"
],
"label": "tag",
"terms": [
"tag",
"tag"
]
},
"tags": {
"styles": [
"solid"
],
"label": "tags",
"terms": [
"tags",
"tags"
]
},
"tape": {
"styles": [
"solid"
],
"label": "Tape",
"terms": [
"Tape",
"tape"
]
},
"tarp": {
"styles": [
"solid"
],
"label": "Tarp",
"terms": [
"Tarp",
"tarp"
]
},
"tarp-droplet": {
"styles": [
"solid"
],
"label": "Tarp Droplet",
"terms": [
"Tarp Droplet",
"tarp-droplet"
]
},
"taxi": {
"styles": [
"solid"
],
"label": "Taxi",
"terms": [
"cab",
"Taxi",
"taxi"
]
},
"teamspeak": {
"styles": [
"brands"
],
"label": "TeamSpeak",
"terms": [
"TeamSpeak",
"teamspeak"
]
},
"teeth": {
"styles": [
"solid"
],
"label": "Teeth",
"terms": [
"Teeth",
"teeth"
]
},
"teeth-open": {
"styles": [
"solid"
],
"label": "Teeth Open",
"terms": [
"Teeth Open",
"teeth-open"
]
},
"telegram": {
"styles": [
"brands"
],
"label": "Telegram",
"terms": [
"telegram-plane",
"Telegram",
"telegram"
]
},
"temperature-arrow-down": {
"styles": [
"solid"
],
"label": "Temperature arrow down",
"terms": [
"temperature-down",
"Temperature arrow down",
"temperature-arrow-down"
]
},
"temperature-arrow-up": {
"styles": [
"solid"
],
"label": "Temperature arrow up",
"terms": [
"temperature-up",
"Temperature arrow up",
"temperature-arrow-up"
]
},
"temperature-empty": {
"styles": [
"solid"
],
"label": "Temperature empty",
"terms": [
"temperature-0",
"thermometer-0",
"thermometer-empty",
"Temperature empty",
"temperature-empty"
]
},
"temperature-full": {
"styles": [
"solid"
],
"label": "Temperature full",
"terms": [
"temperature-4",
"thermometer-4",
"thermometer-full",
"Temperature full",
"temperature-full"
]
},
"temperature-half": {
"styles": [
"solid"
],
"label": "Temperature half",
"terms": [
"temperature-2",
"thermometer-2",
"thermometer-half",
"Temperature half",
"temperature-half"
]
},
"temperature-high": {
"styles": [
"solid"
],
"label": "High Temperature",
"terms": [
"High Temperature",
"temperature-high"
]
},
"temperature-low": {
"styles": [
"solid"
],
"label": "Low Temperature",
"terms": [
"Low Temperature",
"temperature-low"
]
},
"temperature-quarter": {
"styles": [
"solid"
],
"label": "Temperature quarter",
"terms": [
"temperature-1",
"thermometer-1",
"thermometer-quarter",
"Temperature quarter",
"temperature-quarter"
]
},
"temperature-three-quarters": {
"styles": [
"solid"
],
"label": "Temperature three quarters",
"terms": [
"temperature-3",
"thermometer-3",
"thermometer-three-quarters",
"Temperature three quarters",
"temperature-three-quarters"
]
},
"tencent-weibo": {
"styles": [
"brands"
],
"label": "Tencent Weibo",
"terms": [
"Tencent Weibo",
"tencent-weibo"
]
},
"tenge-sign": {
"styles": [
"solid"
],
"label": "Tenge sign",
"terms": [
"tenge",
"Tenge sign",
"tenge-sign"
]
},
"tent": {
"styles": [
"solid"
],
"label": "Tent",
"terms": [
"Tent",
"tent"
]
},
"tent-arrow-down-to-line": {
"styles": [
"solid"
],
"label": "Tent Arrow-down-to-line",
"terms": [
"Tent Arrow-down-to-line",
"tent-arrow-down-to-line"
]
},
"tent-arrow-left-right": {
"styles": [
"solid"
],
"label": "Tent Arrow-left-right",
"terms": [
"Tent Arrow-left-right",
"tent-arrow-left-right"
]
},
"tent-arrow-turn-left": {
"styles": [
"solid"
],
"label": "Tent Arrow-turn-left",
"terms": [
"Tent Arrow-turn-left",
"tent-arrow-turn-left"
]
},
"tent-arrows-down": {
"styles": [
"solid"
],
"label": "Tent Arrows-down",
"terms": [
"Tent Arrows-down",
"tent-arrows-down"
]
},
"tents": {
"styles": [
"solid"
],
"label": "Tents",
"terms": [
"Tents",
"tents"
]
},
"terminal": {
"styles": [
"solid"
],
"label": "Terminal",
"terms": [
"Terminal",
"terminal"
]
},
"text-height": {
"styles": [
"solid"
],
"label": "text-height",
"terms": [
"text-height",
"text-height"
]
},
"text-slash": {
"styles": [
"solid"
],
"label": "Text slash",
"terms": [
"remove-format",
"Text slash",
"text-slash"
]
},
"text-width": {
"styles": [
"solid"
],
"label": "Text Width",
"terms": [
"Text Width",
"text-width"
]
},
"the-red-yeti": {
"styles": [
"brands"
],
"label": "The Red Yeti",
"terms": [
"The Red Yeti",
"the-red-yeti"
]
},
"themeco": {
"styles": [
"brands"
],
"label": "Themeco",
"terms": [
"Themeco",
"themeco"
]
},
"themeisle": {
"styles": [
"brands"
],
"label": "ThemeIsle",
"terms": [
"ThemeIsle",
"themeisle"
]
},
"thermometer": {
"styles": [
"solid"
],
"label": "Thermometer",
"terms": [
"Thermometer",
"thermometer"
]
},
"think-peaks": {
"styles": [
"brands"
],
"label": "Think Peaks",
"terms": [
"Think Peaks",
"think-peaks"
]
},
"thumbs-down": {
"styles": [
"solid",
"regular"
],
"label": "thumbs-down",
"terms": [
"thumbs-down",
"thumbs-down"
]
},
"thumbs-up": {
"styles": [
"solid",
"regular"
],
"label": "thumbs-up",
"terms": [
"thumbs-up",
"thumbs-up"
]
},
"thumbtack": {
"styles": [
"solid"
],
"label": "Thumbtack",
"terms": [
"thumb-tack",
"Thumbtack",
"thumbtack"
]
},
"ticket": {
"styles": [
"solid"
],
"label": "Ticket",
"terms": [
"Ticket",
"ticket"
]
},
"ticket-simple": {
"styles": [
"solid"
],
"label": "Ticket simple",
"terms": [
"ticket-alt",
"Ticket simple",
"ticket-simple"
]
},
"tiktok": {
"styles": [
"brands"
],
"label": "TikTok",
"terms": [
"TikTok",
"tiktok"
]
},
"timeline": {
"styles": [
"solid"
],
"label": "Timeline",
"terms": [
"Timeline",
"timeline"
]
},
"toggle-off": {
"styles": [
"solid"
],
"label": "Toggle Off",
"terms": [
"Toggle Off",
"toggle-off"
]
},
"toggle-on": {
"styles": [
"solid"
],
"label": "Toggle On",
"terms": [
"Toggle On",
"toggle-on"
]
},
"toilet": {
"styles": [
"solid"
],
"label": "Toilet",
"terms": [
"Toilet",
"toilet"
]
},
"toilet-paper": {
"styles": [
"solid"
],
"label": "Toilet Paper",
"terms": [
"Toilet Paper",
"toilet-paper"
]
},
"toilet-paper-slash": {
"styles": [
"solid"
],
"label": "Toilet Paper Slash",
"terms": [
"Toilet Paper Slash",
"toilet-paper-slash"
]
},
"toilet-portable": {
"styles": [
"solid"
],
"label": "Toilet Portable",
"terms": [
"Toilet Portable",
"toilet-portable"
]
},
"toilets-portable": {
"styles": [
"solid"
],
"label": "Toilets Portable",
"terms": [
"Toilets Portable",
"toilets-portable"
]
},
"toolbox": {
"styles": [
"solid"
],
"label": "Toolbox",
"terms": [
"Toolbox",
"toolbox"
]
},
"tooth": {
"styles": [
"solid"
],
"label": "Tooth",
"terms": [
"Tooth",
"tooth"
]
},
"torii-gate": {
"styles": [
"solid"
],
"label": "Torii Gate",
"terms": [
"Torii Gate",
"torii-gate"
]
},
"tornado": {
"styles": [
"solid"
],
"label": "Tornado",
"terms": [
"Tornado",
"tornado"
]
},
"tower-broadcast": {
"styles": [
"solid"
],
"label": "Tower broadcast",
"terms": [
"broadcast-tower",
"Tower broadcast",
"tower-broadcast"
]
},
"tower-cell": {
"styles": [
"solid"
],
"label": "Tower Cell",
"terms": [
"Tower Cell",
"tower-cell"
]
},
"tower-observation": {
"styles": [
"solid"
],
"label": "Tower Observation",
"terms": [
"Tower Observation",
"tower-observation"
]
},
"tractor": {
"styles": [
"solid"
],
"label": "Tractor",
"terms": [
"Tractor",
"tractor"
]
},
"trade-federation": {
"styles": [
"brands"
],
"label": "Trade Federation",
"terms": [
"Trade Federation",
"trade-federation"
]
},
"trademark": {
"styles": [
"solid"
],
"label": "Trademark",
"terms": [
"Trademark",
"trademark"
]
},
"traffic-light": {
"styles": [
"solid"
],
"label": "Traffic Light",
"terms": [
"Traffic Light",
"traffic-light"
]
},
"trailer": {
"styles": [
"solid"
],
"label": "Trailer",
"terms": [
"Trailer",
"trailer"
]
},
"train": {
"styles": [
"solid"
],
"label": "Train",
"terms": [
"Train",
"train"
]
},
"train-subway": {
"styles": [
"solid"
],
"label": "Train subway",
"terms": [
"subway",
"Train subway",
"train-subway"
]
},
"train-tram": {
"styles": [
"solid"
],
"label": "Train tram",
"terms": [
"Train tram",
"train-tram"
]
},
"transgender": {
"styles": [
"solid"
],
"label": "Transgender",
"terms": [
"transgender-alt",
"Transgender",
"transgender"
]
},
"trash": {
"styles": [
"solid"
],
"label": "Trash",
"terms": [
"Trash",
"trash"
]
},
"trash-arrow-up": {
"styles": [
"solid"
],
"label": "Trash arrow up",
"terms": [
"trash-restore",
"Trash arrow up",
"trash-arrow-up"
]
},
"trash-can": {
"styles": [
"solid",
"regular"
],
"label": "Trash can",
"terms": [
"trash-alt",
"Trash can",
"trash-can"
]
},
"trash-can-arrow-up": {
"styles": [
"solid"
],
"label": "Trash can arrow up",
"terms": [
"trash-restore-alt",
"Trash can arrow up",
"trash-can-arrow-up"
]
},
"tree": {
"styles": [
"solid"
],
"label": "Tree",
"terms": [
"Tree",
"tree"
]
},
"tree-city": {
"styles": [
"solid"
],
"label": "Tree City",
"terms": [
"Tree City",
"tree-city"
]
},
"trello": {
"styles": [
"brands"
],
"label": "Trello",
"terms": [
"Trello",
"trello"
]
},
"triangle-exclamation": {
"styles": [
"solid"
],
"label": "Triangle exclamation",
"terms": [
"exclamation-triangle",
"warning",
"Triangle exclamation",
"triangle-exclamation"
]
},
"trophy": {
"styles": [
"solid"
],
"label": "trophy",
"terms": [
"trophy",
"trophy"
]
},
"trowel": {
"styles": [
"solid"
],
"label": "Trowel",
"terms": [
"Trowel",
"trowel"
]
},
"trowel-bricks": {
"styles": [
"solid"
],
"label": "Trowel Bricks",
"terms": [
"Trowel Bricks",
"trowel-bricks"
]
},
"truck": {
"styles": [
"solid"
],
"label": "truck",
"terms": [
"truck",
"truck"
]
},
"truck-arrow-right": {
"styles": [
"solid"
],
"label": "Truck Arrow-right",
"terms": [
"Truck Arrow-right",
"truck-arrow-right"
]
},
"truck-droplet": {
"styles": [
"solid"
],
"label": "Truck Droplet",
"terms": [
"Truck Droplet",
"truck-droplet"
]
},
"truck-fast": {
"styles": [
"solid"
],
"label": "Truck fast",
"terms": [
"shipping-fast",
"Truck fast",
"truck-fast"
]
},
"truck-field": {
"styles": [
"solid"
],
"label": "Truck Field",
"terms": [
"Truck Field",
"truck-field"
]
},
"truck-field-un": {
"styles": [
"solid"
],
"label": "Truck Field-un",
"terms": [
"Truck Field-un",
"truck-field-un"
]
},
"truck-front": {
"styles": [
"solid"
],
"label": "Truck Front",
"terms": [
"Truck Front",
"truck-front"
]
},
"truck-medical": {
"styles": [
"solid"
],
"label": "Truck medical",
"terms": [
"ambulance",
"Truck medical",
"truck-medical"
]
},
"truck-monster": {
"styles": [
"solid"
],
"label": "Truck Monster",
"terms": [
"Truck Monster",
"truck-monster"
]
},
"truck-moving": {
"styles": [
"solid"
],
"label": "Truck Moving",
"terms": [
"Truck Moving",
"truck-moving"
]
},
"truck-pickup": {
"styles": [
"solid"
],
"label": "Truck Side",
"terms": [
"Truck Side",
"truck-pickup"
]
},
"truck-plane": {
"styles": [
"solid"
],
"label": "Truck Plane",
"terms": [
"Truck Plane",
"truck-plane"
]
},
"truck-ramp-box": {
"styles": [
"solid"
],
"label": "Truck ramp box",
"terms": [
"truck-loading",
"Truck ramp box",
"truck-ramp-box"
]
},
"tty": {
"styles": [
"solid"
],
"label": "TTY",
"terms": [
"teletype",
"TTY",
"tty"
]
},
"tumblr": {
"styles": [
"brands"
],
"label": "Tumblr",
"terms": [
"Tumblr",
"tumblr"
]
},
"turkish-lira-sign": {
"styles": [
"solid"
],
"label": "Turkish Lira-sign",
"terms": [
"try",
"turkish-lira",
"Turkish Lira-sign",
"turkish-lira-sign"
]
},
"turn-down": {
"styles": [
"solid"
],
"label": "Turn down",
"terms": [
"level-down-alt",
"Turn down",
"turn-down"
]
},
"turn-up": {
"styles": [
"solid"
],
"label": "Turn up",
"terms": [
"level-up-alt",
"Turn up",
"turn-up"
]
},
"tv": {
"styles": [
"solid"
],
"label": "Television",
"terms": [
"television",
"tv-alt",
"Television",
"tv"
]
},
"twitch": {
"styles": [
"brands"
],
"label": "Twitch",
"terms": [
"Twitch",
"twitch"
]
},
"twitter": {
"styles": [
"brands"
],
"label": "Twitter",
"terms": [
"Twitter",
"twitter"
]
},
"typo3": {
"styles": [
"brands"
],
"label": "Typo3",
"terms": [
"Typo3",
"typo3"
]
},
"u": {
"styles": [
"solid"
],
"label": "U",
"terms": [
"U",
"u"
]
},
"uber": {
"styles": [
"brands"
],
"label": "Uber",
"terms": [
"Uber",
"uber"
]
},
"ubuntu": {
"styles": [
"brands"
],
"label": "Ubuntu",
"terms": [
"Ubuntu",
"ubuntu"
]
},
"uikit": {
"styles": [
"brands"
],
"label": "UIkit",
"terms": [
"UIkit",
"uikit"
]
},
"umbraco": {
"styles": [
"brands"
],
"label": "Umbraco",
"terms": [
"Umbraco",
"umbraco"
]
},
"umbrella": {
"styles": [
"solid"
],
"label": "Umbrella",
"terms": [
"Umbrella",
"umbrella"
]
},
"umbrella-beach": {
"styles": [
"solid"
],
"label": "Umbrella Beach",
"terms": [
"Umbrella Beach",
"umbrella-beach"
]
},
"uncharted": {
"styles": [
"brands"
],
"label": "Uncharted Software",
"terms": [
"Uncharted Software",
"uncharted"
]
},
"underline": {
"styles": [
"solid"
],
"label": "Underline",
"terms": [
"Underline",
"underline"
]
},
"uniregistry": {
"styles": [
"brands"
],
"label": "Uniregistry",
"terms": [
"Uniregistry",
"uniregistry"
]
},
"unity": {
"styles": [
"brands"
],
"label": "Unity 3D",
"terms": [
"Unity 3D",
"unity"
]
},
"universal-access": {
"styles": [
"solid"
],
"label": "Universal Access",
"terms": [
"Universal Access",
"universal-access"
]
},
"unlock": {
"styles": [
"solid"
],
"label": "unlock",
"terms": [
"unlock",
"unlock"
]
},
"unlock-keyhole": {
"styles": [
"solid"
],
"label": "Unlock keyhole",
"terms": [
"unlock-alt",
"Unlock keyhole",
"unlock-keyhole"
]
},
"unsplash": {
"styles": [
"brands"
],
"label": "Unsplash",
"terms": [
"Unsplash",
"unsplash"
]
},
"untappd": {
"styles": [
"brands"
],
"label": "Untappd",
"terms": [
"Untappd",
"untappd"
]
},
"up-down": {
"styles": [
"solid"
],
"label": "Up down",
"terms": [
"arrows-alt-v",
"Up down",
"up-down"
]
},
"up-down-left-right": {
"styles": [
"solid"
],
"label": "Up down left right",
"terms": [
"arrows-alt",
"Up down left right",
"up-down-left-right"
]
},
"up-long": {
"styles": [
"solid"
],
"label": "Up long",
"terms": [
"long-arrow-alt-up",
"Up long",
"up-long"
]
},
"up-right-and-down-left-from-center": {
"styles": [
"solid"
],
"label": "Up right and down left from center",
"terms": [
"expand-alt",
"Up right and down left from center",
"up-right-and-down-left-from-center"
]
},
"up-right-from-square": {
"styles": [
"solid"
],
"label": "Up right from square",
"terms": [
"external-link-alt",
"Up right from square",
"up-right-from-square"
]
},
"upload": {
"styles": [
"solid"
],
"label": "Upload",
"terms": [
"Upload",
"upload"
]
},
"ups": {
"styles": [
"brands"
],
"label": "UPS",
"terms": [
"UPS",
"ups"
]
},
"usb": {
"styles": [
"brands"
],
"label": "USB",
"terms": [
"USB",
"usb"
]
},
"user": {
"styles": [
"solid",
"regular"
],
"label": "User",
"terms": [
"User",
"user"
]
},
"user-astronaut": {
"styles": [
"solid"
],
"label": "User Astronaut",
"terms": [
"User Astronaut",
"user-astronaut"
]
},
"user-check": {
"styles": [
"solid"
],
"label": "User Check",
"terms": [
"User Check",
"user-check"
]
},
"user-clock": {
"styles": [
"solid"
],
"label": "User Clock",
"terms": [
"User Clock",
"user-clock"
]
},
"user-doctor": {
"styles": [
"solid"
],
"label": "User doctor",
"terms": [
"user-md",
"User doctor",
"user-doctor"
]
},
"user-gear": {
"styles": [
"solid"
],
"label": "User gear",
"terms": [
"user-cog",
"User gear",
"user-gear"
]
},
"user-graduate": {
"styles": [
"solid"
],
"label": "User Graduate",
"terms": [
"User Graduate",
"user-graduate"
]
},
"user-group": {
"styles": [
"solid"
],
"label": "User group",
"terms": [
"user-friends",
"User group",
"user-group"
]
},
"user-injured": {
"styles": [
"solid"
],
"label": "User Injured",
"terms": [
"User Injured",
"user-injured"
]
},
"user-large": {
"styles": [
"solid"
],
"label": "User large",
"terms": [
"user-alt",
"User large",
"user-large"
]
},
"user-large-slash": {
"styles": [
"solid"
],
"label": "User large slash",
"terms": [
"user-alt-slash",
"User large slash",
"user-large-slash"
]
},
"user-lock": {
"styles": [
"solid"
],
"label": "User Lock",
"terms": [
"User Lock",
"user-lock"
]
},
"user-minus": {
"styles": [
"solid"
],
"label": "User Minus",
"terms": [
"User Minus",
"user-minus"
]
},
"user-ninja": {
"styles": [
"solid"
],
"label": "User Ninja",
"terms": [
"User Ninja",
"user-ninja"
]
},
"user-nurse": {
"styles": [
"solid"
],
"label": "Nurse",
"terms": [
"Nurse",
"user-nurse"
]
},
"user-pen": {
"styles": [
"solid"
],
"label": "User pen",
"terms": [
"user-edit",
"User pen",
"user-pen"
]
},
"user-plus": {
"styles": [
"solid"
],
"label": "User Plus",
"terms": [
"User Plus",
"user-plus"
]
},
"user-secret": {
"styles": [
"solid"
],
"label": "User Secret",
"terms": [
"User Secret",
"user-secret"
]
},
"user-shield": {
"styles": [
"solid"
],
"label": "User Shield",
"terms": [
"User Shield",
"user-shield"
]
},
"user-slash": {
"styles": [
"solid"
],
"label": "User Slash",
"terms": [
"User Slash",
"user-slash"
]
},
"user-tag": {
"styles": [
"solid"
],
"label": "User Tag",
"terms": [
"User Tag",
"user-tag"
]
},
"user-tie": {
"styles": [
"solid"
],
"label": "User Tie",
"terms": [
"User Tie",
"user-tie"
]
},
"user-xmark": {
"styles": [
"solid"
],
"label": "User X Mark",
"terms": [
"user-times",
"User X Mark",
"user-xmark"
]
},
"users": {
"styles": [
"solid"
],
"label": "Users",
"terms": [
"Users",
"users"
]
},
"users-between-lines": {
"styles": [
"solid"
],
"label": "Users Between-lines",
"terms": [
"Users Between-lines",
"users-between-lines"
]
},
"users-gear": {
"styles": [
"solid"
],
"label": "Users gear",
"terms": [
"users-cog",
"Users gear",
"users-gear"
]
},
"users-line": {
"styles": [
"solid"
],
"label": "Users Line",
"terms": [
"Users Line",
"users-line"
]
},
"users-rays": {
"styles": [
"solid"
],
"label": "Users Rays",
"terms": [
"Users Rays",
"users-rays"
]
},
"users-rectangle": {
"styles": [
"solid"
],
"label": "Users Rectangle",
"terms": [
"Users Rectangle",
"users-rectangle"
]
},
"users-slash": {
"styles": [
"solid"
],
"label": "Users Slash",
"terms": [
"Users Slash",
"users-slash"
]
},
"users-viewfinder": {
"styles": [
"solid"
],
"label": "Users Viewfinder",
"terms": [
"Users Viewfinder",
"users-viewfinder"
]
},
"usps": {
"styles": [
"brands"
],
"label": "United States Postal Service",
"terms": [
"United States Postal Service",
"usps"
]
},
"ussunnah": {
"styles": [
"brands"
],
"label": "us-Sunnah Foundation",
"terms": [
"us-Sunnah Foundation",
"ussunnah"
]
},
"utensils": {
"styles": [
"solid"
],
"label": "Utensils",
"terms": [
"cutlery",
"Utensils",
"utensils"
]
},
"v": {
"styles": [
"solid"
],
"label": "V",
"terms": [
"V",
"v"
]
},
"vaadin": {
"styles": [
"brands"
],
"label": "Vaadin",
"terms": [
"Vaadin",
"vaadin"
]
},
"van-shuttle": {
"styles": [
"solid"
],
"label": "Van shuttle",
"terms": [
"shuttle-van",
"Van shuttle",
"van-shuttle"
]
},
"vault": {
"styles": [
"solid"
],
"label": "Vault",
"terms": [
"Vault",
"vault"
]
},
"vector-square": {
"styles": [
"solid"
],
"label": "Vector Square",
"terms": [
"Vector Square",
"vector-square"
]
},
"venus": {
"styles": [
"solid"
],
"label": "Venus",
"terms": [
"Venus",
"venus"
]
},
"venus-double": {
"styles": [
"solid"
],
"label": "Venus Double",
"terms": [
"Venus Double",
"venus-double"
]
},
"venus-mars": {
"styles": [
"solid"
],
"label": "Venus Mars",
"terms": [
"Venus Mars",
"venus-mars"
]
},
"vest": {
"styles": [
"solid"
],
"label": "vest",
"terms": [
"vest",
"vest"
]
},
"vest-patches": {
"styles": [
"solid"
],
"label": "vest-patches",
"terms": [
"vest-patches",
"vest-patches"
]
},
"viacoin": {
"styles": [
"brands"
],
"label": "Viacoin",
"terms": [
"Viacoin",
"viacoin"
]
},
"viadeo": {
"styles": [
"brands"
],
"label": "Viadeo",
"terms": [
"Viadeo",
"viadeo"
]
},
"vial": {
"styles": [
"solid"
],
"label": "Vial",
"terms": [
"Vial",
"vial"
]
},
"vial-circle-check": {
"styles": [
"solid"
],
"label": "Vial Circle-check",
"terms": [
"Vial Circle-check",
"vial-circle-check"
]
},
"vial-virus": {
"styles": [
"solid"
],
"label": "Vial Virus",
"terms": [
"Vial Virus",
"vial-virus"
]
},
"vials": {
"styles": [
"solid"
],
"label": "Vials",
"terms": [
"Vials",
"vials"
]
},
"viber": {
"styles": [
"brands"
],
"label": "Viber",
"terms": [
"Viber",
"viber"
]
},
"video": {
"styles": [
"solid"
],
"label": "Video",
"terms": [
"video-camera",
"Video",
"video"
]
},
"video-slash": {
"styles": [
"solid"
],
"label": "Video Slash",
"terms": [
"Video Slash",
"video-slash"
]
},
"vihara": {
"styles": [
"solid"
],
"label": "Vihara",
"terms": [
"Vihara",
"vihara"
]
},
"vimeo": {
"styles": [
"brands"
],
"label": "Vimeo",
"terms": [
"Vimeo",
"vimeo"
]
},
"vimeo-v": {
"styles": [
"brands"
],
"label": "Vimeo",
"terms": [
"Vimeo",
"vimeo-v"
]
},
"vine": {
"styles": [
"brands"
],
"label": "Vine",
"terms": [
"Vine",
"vine"
]
},
"virus": {
"styles": [
"solid"
],
"label": "Virus",
"terms": [
"Virus",
"virus"
]
},
"virus-covid": {
"styles": [
"solid"
],
"label": "Virus Covid",
"terms": [
"Virus Covid",
"virus-covid"
]
},
"virus-covid-slash": {
"styles": [
"solid"
],
"label": "Virus Covid-slash",
"terms": [
"Virus Covid-slash",
"virus-covid-slash"
]
},
"virus-slash": {
"styles": [
"solid"
],
"label": "Virus Slash",
"terms": [
"Virus Slash",
"virus-slash"
]
},
"viruses": {
"styles": [
"solid"
],
"label": "Viruses",
"terms": [
"Viruses",
"viruses"
]
},
"vk": {
"styles": [
"brands"
],
"label": "VK",
"terms": [
"VK",
"vk"
]
},
"vnv": {
"styles": [
"brands"
],
"label": "VNV",
"terms": [
"VNV",
"vnv"
]
},
"voicemail": {
"styles": [
"solid"
],
"label": "Voicemail",
"terms": [
"Voicemail",
"voicemail"
]
},
"volcano": {
"styles": [
"solid"
],
"label": "Volcano",
"terms": [
"Volcano",
"volcano"
]
},
"volleyball": {
"styles": [
"solid"
],
"label": "Volleyball Ball",
"terms": [
"volleyball-ball",
"Volleyball Ball",
"volleyball"
]
},
"volume-high": {
"styles": [
"solid"
],
"label": "Volume high",
"terms": [
"volume-up",
"Volume high",
"volume-high"
]
},
"volume-low": {
"styles": [
"solid"
],
"label": "Volume low",
"terms": [
"volume-down",
"Volume low",
"volume-low"
]
},
"volume-off": {
"styles": [
"solid"
],
"label": "Volume Off",
"terms": [
"Volume Off",
"volume-off"
]
},
"volume-xmark": {
"styles": [
"solid"
],
"label": "Volume X Mark",
"terms": [
"volume-mute",
"volume-times",
"Volume X Mark",
"volume-xmark"
]
},
"vr-cardboard": {
"styles": [
"solid"
],
"label": "Cardboard VR",
"terms": [
"Cardboard VR",
"vr-cardboard"
]
},
"vuejs": {
"styles": [
"brands"
],
"label": "Vue.js",
"terms": [
"Vue.js",
"vuejs"
]
},
"w": {
"styles": [
"solid"
],
"label": "W",
"terms": [
"W",
"w"
]
},
"walkie-talkie": {
"styles": [
"solid"
],
"label": "Walkie Talkie",
"terms": [
"Walkie Talkie",
"walkie-talkie"
]
},
"wallet": {
"styles": [
"solid"
],
"label": "Wallet",
"terms": [
"Wallet",
"wallet"
]
},
"wand-magic": {
"styles": [
"solid"
],
"label": "Wand magic",
"terms": [
"magic",
"Wand magic",
"wand-magic"
]
},
"wand-magic-sparkles": {
"styles": [
"solid"
],
"label": "Wand magic sparkles",
"terms": [
"magic-wand-sparkles",
"Wand magic sparkles",
"wand-magic-sparkles"
]
},
"wand-sparkles": {
"styles": [
"solid"
],
"label": "Wand sparkles",
"terms": [
"Wand sparkles",
"wand-sparkles"
]
},
"warehouse": {
"styles": [
"solid"
],
"label": "Warehouse",
"terms": [
"Warehouse",
"warehouse"
]
},
"watchman-monitoring": {
"styles": [
"brands"
],
"label": "Watchman Monitoring",
"terms": [
"Watchman Monitoring",
"watchman-monitoring"
]
},
"water": {
"styles": [
"solid"
],
"label": "Water",
"terms": [
"Water",
"water"
]
},
"water-ladder": {
"styles": [
"solid"
],
"label": "Water ladder",
"terms": [
"ladder-water",
"swimming-pool",
"Water ladder",
"water-ladder"
]
},
"wave-square": {
"styles": [
"solid"
],
"label": "Square Wave",
"terms": [
"Square Wave",
"wave-square"
]
},
"waze": {
"styles": [
"brands"
],
"label": "Waze",
"terms": [
"Waze",
"waze"
]
},
"weebly": {
"styles": [
"brands"
],
"label": "Weebly",
"terms": [
"Weebly",
"weebly"
]
},
"weibo": {
"styles": [
"brands"
],
"label": "Weibo",
"terms": [
"Weibo",
"weibo"
]
},
"weight-hanging": {
"styles": [
"solid"
],
"label": "Hanging Weight",
"terms": [
"Hanging Weight",
"weight-hanging"
]
},
"weight-scale": {
"styles": [
"solid"
],
"label": "Weight scale",
"terms": [
"weight",
"Weight scale",
"weight-scale"
]
},
"weixin": {
"styles": [
"brands"
],
"label": "Weixin (WeChat)",
"terms": [
"Weixin (WeChat)",
"weixin"
]
},
"whatsapp": {
"styles": [
"brands"
],
"label": "What's App",
"terms": [
"What's App",
"whatsapp"
]
},
"wheat-awn": {
"styles": [
"solid"
],
"label": "Wheat awn",
"terms": [
"wheat-alt",
"Wheat awn",
"wheat-awn"
]
},
"wheat-awn-circle-exclamation": {
"styles": [
"solid"
],
"label": "Wheat Awn-circle-exclamation",
"terms": [
"Wheat Awn-circle-exclamation",
"wheat-awn-circle-exclamation"
]
},
"wheelchair": {
"styles": [
"solid"
],
"label": "Wheelchair",
"terms": [
"Wheelchair",
"wheelchair"
]
},
"wheelchair-move": {
"styles": [
"solid"
],
"label": "Wheelchair Move",
"terms": [
"wheelchair-alt",
"Wheelchair Move",
"wheelchair-move"
]
},
"whiskey-glass": {
"styles": [
"solid"
],
"label": "Whiskey glass",
"terms": [
"glass-whiskey",
"Whiskey glass",
"whiskey-glass"
]
},
"whmcs": {
"styles": [
"brands"
],
"label": "WHMCS",
"terms": [
"WHMCS",
"whmcs"
]
},
"wifi": {
"styles": [
"solid"
],
"label": "WiFi",
"terms": [
"wifi-3",
"wifi-strong",
"WiFi",
"wifi"
]
},
"wikipedia-w": {
"styles": [
"brands"
],
"label": "Wikipedia W",
"terms": [
"Wikipedia W",
"wikipedia-w"
]
},
"wind": {
"styles": [
"solid"
],
"label": "Wind",
"terms": [
"Wind",
"wind"
]
},
"window-maximize": {
"styles": [
"solid",
"regular"
],
"label": "Window Maximize",
"terms": [
"Window Maximize",
"window-maximize"
]
},
"window-minimize": {
"styles": [
"solid",
"regular"
],
"label": "Window Minimize",
"terms": [
"Window Minimize",
"window-minimize"
]
},
"window-restore": {
"styles": [
"solid",
"regular"
],
"label": "Window Restore",
"terms": [
"Window Restore",
"window-restore"
]
},
"windows": {
"styles": [
"brands"
],
"label": "Windows",
"terms": [
"Windows",
"windows"
]
},
"wine-bottle": {
"styles": [
"solid"
],
"label": "Wine Bottle",
"terms": [
"Wine Bottle",
"wine-bottle"
]
},
"wine-glass": {
"styles": [
"solid"
],
"label": "Wine Glass",
"terms": [
"Wine Glass",
"wine-glass"
]
},
"wine-glass-empty": {
"styles": [
"solid"
],
"label": "Wine glass empty",
"terms": [
"wine-glass-alt",
"Wine glass empty",
"wine-glass-empty"
]
},
"wirsindhandwerk": {
"styles": [
"brands"
],
"label": "wirsindhandwerk",
"terms": [
"wsh",
"wirsindhandwerk",
"wirsindhandwerk"
]
},
"wix": {
"styles": [
"brands"
],
"label": "Wix",
"terms": [
"Wix",
"wix"
]
},
"wizards-of-the-coast": {
"styles": [
"brands"
],
"label": "Wizards of the Coast",
"terms": [
"Wizards of the Coast",
"wizards-of-the-coast"
]
},
"wodu": {
"styles": [
"brands"
],
"label": "Wodu",
"terms": [
"Wodu",
"wodu"
]
},
"wolf-pack-battalion": {
"styles": [
"brands"
],
"label": "Wolf Pack Battalion",
"terms": [
"Wolf Pack Battalion",
"wolf-pack-battalion"
]
},
"won-sign": {
"styles": [
"solid"
],
"label": "Won Sign",
"terms": [
"krw",
"won",
"Won Sign",
"won-sign"
]
},
"wordpress": {
"styles": [
"brands"
],
"label": "WordPress Logo",
"terms": [
"WordPress Logo",
"wordpress"
]
},
"wordpress-simple": {
"styles": [
"brands"
],
"label": "Wordpress Simple",
"terms": [
"Wordpress Simple",
"wordpress-simple"
]
},
"worm": {
"styles": [
"solid"
],
"label": "Worm",
"terms": [
"Worm",
"worm"
]
},
"wpbeginner": {
"styles": [
"brands"
],
"label": "WPBeginner",
"terms": [
"WPBeginner",
"wpbeginner"
]
},
"wpexplorer": {
"styles": [
"brands"
],
"label": "WPExplorer",
"terms": [
"WPExplorer",
"wpexplorer"
]
},
"wpforms": {
"styles": [
"brands"
],
"label": "WPForms",
"terms": [
"WPForms",
"wpforms"
]
},
"wpressr": {
"styles": [
"brands"
],
"label": "wpressr",
"terms": [
"rendact",
"wpressr",
"wpressr"
]
},
"wrench": {
"styles": [
"solid"
],
"label": "Wrench",
"terms": [
"Wrench",
"wrench"
]
},
"x": {
"styles": [
"solid"
],
"label": "X",
"terms": [
"X",
"x"
]
},
"x-ray": {
"styles": [
"solid"
],
"label": "X-Ray",
"terms": [
"X-Ray",
"x-ray"
]
},
"xbox": {
"styles": [
"brands"
],
"label": "Xbox",
"terms": [
"Xbox",
"xbox"
]
},
"xing": {
"styles": [
"brands"
],
"label": "Xing",
"terms": [
"Xing",
"xing"
]
},
"xmark": {
"styles": [
"solid"
],
"label": "X Mark",
"terms": [
"close",
"multiply",
"remove",
"times",
"X Mark",
"xmark"
]
},
"xmarks-lines": {
"styles": [
"solid"
],
"label": "Xmarks Lines",
"terms": [
"Xmarks Lines",
"xmarks-lines"
]
},
"y": {
"styles": [
"solid"
],
"label": "Y",
"terms": [
"Y",
"y"
]
},
"y-combinator": {
"styles": [
"brands"
],
"label": "Y Combinator",
"terms": [
"Y Combinator",
"y-combinator"
]
},
"yahoo": {
"styles": [
"brands"
],
"label": "Yahoo Logo",
"terms": [
"Yahoo Logo",
"yahoo"
]
},
"yammer": {
"styles": [
"brands"
],
"label": "Yammer",
"terms": [
"Yammer",
"yammer"
]
},
"yandex": {
"styles": [
"brands"
],
"label": "Yandex",
"terms": [
"Yandex",
"yandex"
]
},
"yandex-international": {
"styles": [
"brands"
],
"label": "Yandex International",
"terms": [
"Yandex International",
"yandex-international"
]
},
"yarn": {
"styles": [
"brands"
],
"label": "Yarn",
"terms": [
"Yarn",
"yarn"
]
},
"yelp": {
"styles": [
"brands"
],
"label": "Yelp",
"terms": [
"Yelp",
"yelp"
]
},
"yen-sign": {
"styles": [
"solid"
],
"label": "Yen Sign",
"terms": [
"cny",
"jpy",
"rmb",
"yen",
"Yen Sign",
"yen-sign"
]
},
"yin-yang": {
"styles": [
"solid"
],
"label": "Yin Yang",
"terms": [
"Yin Yang",
"yin-yang"
]
},
"yoast": {
"styles": [
"brands"
],
"label": "Yoast",
"terms": [
"Yoast",
"yoast"
]
},
"youtube": {
"styles": [
"brands"
],
"label": "YouTube",
"terms": [
"YouTube",
"youtube"
]
},
"z": {
"styles": [
"solid"
],
"label": "Z",
"terms": [
"Z",
"z"
]
},
"zhihu": {
"styles": [
"brands"
],
"label": "Zhihu",
"terms": [
"Zhihu",
"zhihu"
]
}
}
================================================
FILE: packages/icons/.eslintrc.js
================================================
const config = require( '../scripts/config/.eslintrc.js' );
module.exports = config;
================================================
FILE: packages/icons/.llmsdev.yml
================================================
update-version:
skip-config: true
================================================
FILE: packages/icons/.npmrc
================================================
package-lock=false
engine-strict=true
================================================
FILE: packages/icons/CHANGELOG.md
================================================
LifterLMS Icons
===============
v1.0.0 - 2022-03-08
-------------------
+ Initial public release.
================================================
FILE: packages/icons/README.md
================================================
LifterLMS Icons
---------------
LifterLMS Icon library.
---
## CHANGELOG
[CHANGELOG](./CHANGELOG.md)
## Installation
```bash
npm install --save @lifterlms/icons`
```
## Usage
```jsx
import { Icon, lifterlms } from '@lifterlms/icons';
<Icon icon={ lifterlms } />;
```
## LifterLMS Versions
The following table records the module version and which LifterLMS versions it has been included in.
| Module Version | LifterLMS Version |
| -------------- | ----------------- |
| 1.0.0 | 6.0.0 |
## Gallery
<!-- START TOKEN(Autogenerated Icon Gallery) -->
<table>
<thead>
<tr>
<th>Icon</th>
<th>ID</th>
<th>Usage</th>
</tr>
</thead>
<tbody>
<tr>
<td><img src="raw/lifterlms.svg" width="48" height="48" alt="lifterlms icon" /></td>
<td>lifterlms</td>
<td><code><Icon icon={ lifterlms } /></code></td>
</tr>
</tbody>
</table>
<!-- END TOKEN(Autogenerated Icon Gallery) -->
================================================
FILE: packages/icons/babel.config.js
================================================
/**
* Babel config
*
* @since 1.0.0
* @version 1.0.0
*/
module.exports = {
presets: [ '@babel/preset-env', '@babel/preset-react' ],
};
================================================
FILE: packages/icons/docs/app.js
================================================
import { render } from 'react-dom';
import * as Icons from '../src';
const { Icon, ...icons } = Icons;
/**
* React App that automatically renders all icons in the library into a static file.
*
* This app is rendered as a static HTML file and generate.js pulls the HTML the icons
* and stores them as raw SVG files for display use in the README.md file between
* the appropriate comment tokens.
*
* @since 1.0.0
*
* @return {Object} React component fragment.
*/
function App() {
return (
<>
{ Object.entries( icons ).map( ( [ id, icon ] ) => {
return (
<div key={ id } id={ id }>
<Icon icon={ icon } size="48" />
</div>
);
} ) }
</>
);
}
render( <App />, document.getElementById( 'app' ) );
================================================
FILE: packages/icons/docs/generate.js
================================================
#!/usr/bin/node
/**
* Docgen script.
*
* After creating a temporary snapshot of the icon library React app, this script
* parses the static HTML and adds the icon table to the README.md file in the
* package root.
*/
const cheerio = require( 'cheerio' ),
{ readFileSync, writeFileSync, rmSync, mkdirSync } = require( 'fs' ),
BUILD_DIR = 'raw';
rmSync( BUILD_DIR, { force: true, recursive: true } );
mkdirSync( BUILD_DIR );
const $ = cheerio.load( readFileSync( 'docs/build/index.html', 'utf8' ) );
let docs = `<table>
<thead>
<tr>
<th>Icon</th>
<th>ID</th>
<th>Usage</th>
</tr>
</thead>
<tbody>`;
$( '#app div' ).each( ( i, el ) => {
const id = $( el ).attr( 'id' );
writeFileSync( `${ BUILD_DIR }/${ id }.svg`, $( el ).html() );
docs += `
<tr>
<td><img src="${ BUILD_DIR }/${ id }.svg" width="48" height="48" alt="${ id } icon" /></td>
<td>${ id }</td>
<td><code><Icon icon={ ${ id } } /></code></td>
</tr>
`;
} );
docs += `</tbody>
</table>`;
const readmeFile = 'README.md',
readmeContents = readFileSync( readmeFile, 'utf8' ),
startToken = '<!-- START TOKEN(Autogenerated Icon Gallery) -->',
endToken = '<!-- END TOKEN(Autogenerated Icon Gallery) -->',
docsToken = '<!-- DOCS TOKEN -->';
let newReadme = [],
addLine = true;
readmeContents.split( '\n' ).forEach( ( line ) => {
if ( line === startToken ) {
newReadme.push( line );
newReadme.push( docsToken );
addLine = false;
} else if ( line === endToken ) {
addLine = true;
}
if ( addLine ) {
newReadme.push( line );
}
} );
newReadme = newReadme.join( '\n' );
writeFileSync( readmeFile, newReadme.replace( docsToken, `\n${ docs }\n` ) );
================================================
FILE: packages/icons/docs/index.html
================================================
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>@lifterlms/icons