https://github.com/ubc/wp-caliper
https://github.com/ubc/wp-caliper
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ubc/wp-caliper
- Owner: ubc
- License: gpl-3.0
- Created: 2018-11-06T23:14:16.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T00:30:10.000Z (over 1 year ago)
- Last Synced: 2025-03-26T07:43:35.182Z (7 months ago)
- Language: PHP
- Size: 304 KB
- Stars: 2
- Watchers: 16
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wp-caliper
Sends Caliper events to LRS (tested against IMS Global Learning Consortium Member Caliper Analytics™
Conformance Test Suite). Some features are ONLY enabled if the dependent plugins have also been installed.
The plugin can be used as a MU plugin as well.
### Setup Plugin
See [readme.txt](readme.txt) for setup instructions.
### Settings
`WP_CALIPER_DEFAULT_ACTOR_HOMEPAGE` set the base url for the Caliper actor's IRI (default `http://www.ubc.ca`).
`WP_CALIPER_DEFAULT_ACTOR_IDENTIFIER` set the field name to fetch for getting the actor's unique identifier for the IRI (default `puid`).
`WP_CALIPER_MAX_SENDING_TRIES` number of retries when trying to send failed Caliper events from the queue (default `15`). If retry limit is reached, the event is discarded.
`WP_CALIPER_QUEUE_TABLE_NAME` name of the Caliper queue table (default `wp_caliper_queue`). Will be pre-pended by the wordpress db `base_prefix`.
### Filters
`wp_caliper_actor_homepage` alternative way to set the base url for the Caliper actor's IRI.
`wp_caliper_actor_identifier` alternative way to set the actor's unique identifier (not limited to user meta data).
`wp_caliper_actor` alternative way to set the entire Caliper actor object.