Way to send basic xAPI statements from WordPress for various events.
Contributors: John McClane, BigLebo, P@ntaJim, CTLT, Devindra Payment, loongchan.
(Honorable Mentions: Robert Plant, Jimmy Page, John Paul Jones, John Bonham, VR46, Lucy McClane - Gennero, Jeff Lebowski, Walter Sobchak, Jesus Quintana.)
Tags: xAPI, BadgeOS, Tincan, LRS, Experience API, Tin Can API
Requires at least: WordPress 3.5
Tested up to: 6.8
Stable tag: 1.7.00
License: GNU AGPLv3
License URI: GNU Affero General Public License Version 3
Adds the ability for WordPress to send preset xAPI statements to a Learning Record Store.
Sends xAPI statements to LRS (tested against LearningLocker). Some features are enabled ONLY if the dependent plugins have also been installed. The plugin can be used as a MU plugin as well.
It has been extensively tested and is (or appears to be) working seamlessly with:
(well, so far at least, but, as everything with LL, YMMV!).
Statements that can be sent are:
- Page Views.
- Page Interactions (clicks).
- Video Interactions (start, play, pause, seek, complete).
- Post/Page Status Changes.
- Commenting.
This plugin was developed at the NTUA NetMode Laboratory.
Assumes you are using PHP version >= 5.4 (requirement of TinCanPHP Library that the plugin includes) and optimally PHP version >= 7.4. Currently being tested internally with PHP 8.
- Plunk folder into plugins.
- Activate the plugin "WP Experience API" through the "Plugins" menu in WordPress.
= EXTRA NOTES FOR MU: =
If you want to install in wp-content/mu-plugins folder, the plugin uses a proxy loader file.
- Copy wp-experience-api directory to mu-plugins folder
- Copy wp-experience-api/wp-experience-api-mu-loader.php to directory one level up (same level as wp-experience-api itself AKA just under mu-plugins folder)
- It should be installed! Enjoy!
= EXTRA EXTRA NOTES: =
- Note that the plugin uses the TinCanPHP library, please make sure that it is updated regularly as well! Current version is 1.1.1.
== Frequently Asked Questions ==
= How can I add more xAPI statements to the plugin? =
You can create your own plugin and use the plugin's hooks!
= How come nothing is being sent to the LRS after I activate the plugin? =
The settings are defaulted so that nothing is sent by default. Please go to the dashboard and the WP xAPI settings page to configure what statements are sent.
= What is the queue for? =
The queue is used for when for some reason, LRS can't be reached, then statements meant to be sent will be added to the queue to be sent later in the admin screen.
== Upgrade Notice ==
Nothing yet.
== Screenshots ==
- The network level administration screen for a Multisite WordPress installation.
- Site level administration page for users autorized to set the LRS at the site level.
See the releases pages for a history of releases and highlights for each release.
== Changelog ==
= 1.7.00 =
- John McClane, BigLebo, P@ntaJim version.
- Implemented non-logged-in Agent recording as Guest.OS.Browser.Version, rather than Guest.IP. Great for Data Anonymization too.
- Added a few more exceptions on Page Views Tracking (eg. cron jobs were erroneously recorded before).
- Other video interactions (Initialize, Seek, Complete, Terminate etc) waiting patiently in the sidelines.
- Clean-up code and directories.
- Bug fixes and performance improvements.
= 1.6.00 =
- John McClane, BigLebo, P@ntaJim version.
- Implemented non-logged-in Agent recording as Guest.OS.Browser.Version, rather than Guest.IP. Great for Data Anonymization too.
- Added a few more exceptions on Page Views Tracking (eg. cron jobs were erroneously recorded before).
- Other video interactions (Initialize, Seek, Complete, Terminate etc) waiting patiently in the sidelines.
- Clean-up code and directories.
- Bug fixes and performance improvements.
= 1.5.00 =
- John McClane, BigLebo, P@ntaJim version.
- Implemented non-logged-in Agent recording as Guest.OS.Browser.Version, rather than Guest.IP. Great for Data Anonymization too.
- Added a few more exceptions on Page Views Tracking (eg. cron jobs were erroneously recorded before).
- Other video interactions (Initialize, Seek, Complete, Terminate etc) waiting patiently in the sidelines.
- Clean-up code and directories.
- Bug fixes and performance improvements.
= 1.4.00 =
- John McClane, BigLebo, P@ntaJim version.
- Implemented non-logged-in Agent recording as Guest.OS.Browser.Version, rather than Guest.IP. Great for Data Anonymization too.
- Added a few more exceptions on Page Views Tracking (eg. cron jobs were erroneously recorded before).
- Other video interactions (Initialize, Seek, Complete, Terminate etc) waiting patiently in the sidelines.
- Clean-up code and directories.
- Bug fixes and performance improvements.
= 1.3.00 =
- John McClane, BigLebo, P@ntaJim version.
- Implement KMeans_Clustering_on_Learning_Analytics_Data.
- Clean-up code and directories.
- Bug fixes and performance improvements.
= 1.2.00 =
- John McClane, BigLebo, P@ntaJim version.
- Added a few more exceptions on Page Views Tracking (eg. cron jobs were erroneously recorded before).
- Implemented Play / Pause / Seek Video Interactions Tracking.
- Other video interactions (Initialize, Seek, Complete, Terminate etc) waiting patiently in the sidelines.
- Clean-up code and directories.
- Bug fixes and performance improvements.
= 1.1.17 - 1.1.19 =
- John McClane, BigLebo, P@ntaJim version.
- JWPlayer onPlay and onPause integration v1.2 on /includes/triggers.php and /js/wpxapi_link_click_log.js, /js/wpxapi_video_interactions_log.js
- correlating_xapi_events and xapi-youtube integration v1.2
= 1.1.12 - 1.1.17 =
- John McClane, BigLebo, P@ntaJim version.
- JWPlayer onPlay and onPause integration v1.17 on /includes/triggers.php and /js/wpxapi_link_click_log.js, /js/wpxapi_video_interactions_log.js
- correlating_xapi_events and xapi-youtube integration v1.17
= 1.1.11 =
- John McClane, BigLebo, P@ntaJim version.
- jwplayer onPause integration v1.3 on /includes/triggers.php and /js/wpxapi_link_click_log.js
- correlating_xapi_events and xapi-youtube integration v1.3
= 1.1.10 =
- John McClane, BigLebo, P@ntaJim version.
- jwplayer onPause integration v1.2 on /includes/triggers.php and /js/wpxapi_link_click_log.js
- correlating_xapi_events and xapi-youtube integration v1.2
= 1.1.9 =
- John McClane, BigLebo, P@ntaJim version.
- jwplayer onPause integration v1.1 on /includes/triggers.php and /js/wpxapi_link_click_log.js
- correlating_xapi_events and xapi-youtube integration v1.1
= 1.1.8 =
- John McClane, BigLebo, P@ntaJim version.
- jwplayer onPause integration v1.0 on /includes/triggers.php
- xapi-youtube integration v1.0
= 1.1.7 =
- John McClane, BigLebo, P@ntaJim version.
- xapi-youtube integration v1.0
= 1.1.6 =
- John McClane, BigLebo, P@ntaJim version.
= 1.1.5 =
- John McClane, BigLebo, P@ntaJim version.
= 1.1.4 =
- John McClane, BigLebo, P@ntaJim version.
= 1.1.3 =
- John McClane, BigLebo, P@ntaJim version.
= 1.1.2 =
- John McClane, BigLebo, P@ntaJim version.
= 1.1.1 =
- John McClane, BigLebo, P@ntaJim version.
= 1.1.0 =
- John McClane, BigLebo, P@ntaJim version.
= 1.0.6 =
- tweaked syntax to fit with wordpress better (got codesniffer to work on my ide again!)
- fixed bug where posts with empty body makes invalid statements.
= 1.0.5 =
- tweaked the queueing system so that you click on a button on the admin pages to run the queue instead of trying to use wp-cron.
- bug fixes (made timestamp follow iso8601 more strictly and fixed typo)
= 1.0.4 =
- added a queueing system. Also setting timestamp field is done by the plugin.
= 1.0.3 =
- added additional options for whitelisted users access level. Options are whitelisted users have full control or only control LRS info at the site level.
= 1.0.2 =
- changed verb for commented statements from created to commented
= 1.0.1 =
- fixed bug found where statements are invalid if site tagline is left blank. Now it will dispay 'n/a' for empty website taglines.
- updated readme formatting
= 1.0.0 =
- Initial public release
Free. Open source. For users by users. No donations sought.
If ever you really do want to contribute something, think about the people working hard to maintain the projects you are using, which were made available to use by all for free.