Version 7.0.0-alpha.2

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

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
• 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
• templates/checkout/form-switch-source.php
• templates/myaccount/view-order-actions.php

Version 7.0.0-alpha.1

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
• 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
• templates/checkout/form-switch-source.php
• templates/myaccount/view-order-actions.php

Version 6.7.0

v6.7.0 - 2022-06-09

Updates and Enhancements

• Update LifterLMS Blocks to v2.4.3.
• Upgraded Action Scheduler to v3.4.1.
• Upgraded Action Scheduler to v3.4.2.

Bug Fixes

• Fixed a fatal error on PHP 8+ when restoring a post type from revision. #2164

Version 6.6.0

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
• 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

Version 6.5.0

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 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.

Bug Fixes

• Students who have already completed a lesson will now automatically bypass the lesson's drip restrictions. #1835
• Properly encode certificate JS localization data. #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
• Allow avoiding error return when updating an LLMS_Post_Model post meta with the same value as the one stored in the database. #909

Version 6.4.0

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 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
• Improved checks related to the number of quiz attempts allowed for each student.
• Prevent browser page caching on quizzes. #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
• Improve core forms detection so to exclude duplicates. #2052
• Added Aosta (AO) to the list of Italian provinces. #2098
• Fixed a compatibility issue with the Elementor Pro Theme Builder encountered on course and membership catalogs. #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
• Fixed an issue with OceanWP and Twenty Twenty themes where the Terms and Conditions checkbox was displayed incorrectly. #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
• 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.

Version 6.3.0

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 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

Updates and Enhancements

• Upgraded LifterLMS Blocks to v2.4.2.
• Updated LifterLMS Helper to v3.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
• Fixed lesson's comments status not reflecting default global setting when created with the course builder. #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.

Version 6.2.0

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.

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
• Fixed an error encountered on the Engagements > Certificates screen when using the BuddyBoss theme. #2080

Deprecations

• Deprecated LLMS_AJAX_Handler::query_students(). Use the REST API list students 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.

Version 6.1.0

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 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.

Bug Fixes

• Fixed an issue encountered when editing an order with a completed payment plan. #2067
• Fixed access of protected LLMS_Abstract_Query properties.

Version 6.0.0

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. 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
• 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
• 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
• 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
• The achievements and certificates dashboard endpoints are now paginated. #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
• 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
• The coupon code in the student's order details table is now wrapped in a <code> tag instead of an <a> tag. #2033
• Updates LifterLMS REST to v1.0.0-beta.23.
• Updated LifterLMS Blocks to 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
• 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
• 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

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.

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.
  • Meth...