lw-lms-quiz-integration

LW LMS quiz integration

Use the canonical quiz schema, learner REST endpoint, and stored attempt history. Never expose stored correct answers to a learner.

Canonical quiz document

{
  "pass_percentage": 80,
  "shuffle_options": true,
  "questions": [
    {
      "id": "q1",
      "type": "single",
      "prompt": "Choose one",
      "options": [
        { "id": "a", "text": "A", "correct": true },
        { "id": "b", "text": "B", "correct": false }
      ]
    },
    { "id": "q2", "type": "boolean", "prompt": "True?", "correct": true },
    { "id": "q3", "type": "open", "prompt": "Explain", "sample": "Example response" }
  ]
}

Question and option IDs must start with a letter and contain at most 64 letters, digits, underscores, or hyphens. Keep IDs stable across edits so attempt snapshots remain understandable. The normalizer rejects unknown keys and duplicate IDs instead of silently dropping them.

single needs at least two options and exactly one correct option. boolean needs a strict boolean correct. open is ungraded; an optional sample may be returned as guidance. A quiz with no scored questions passes at 100%.

Import and inspect with WP-CLI

wp lw-lms lesson set-quiz 99 --file=quiz.json
cat quiz.json | wp lw-lms lesson set-quiz intro --file=-
wp lw-lms lesson get-quiz 99 --format=json
wp lw-lms lesson delete-quiz 99 --yes

set-quiz replaces the whole document. get-quiz includes correct answers, so treat its output as administrative data and do not publish logs. Deleting the quiz does not delete historical attempts.

Learner REST

GET /lms/v1/lessons/{id} includes quiz or null. The public quiz contains pass percentage, shuffle flag, questions, stable option IDs, and the current user's last_attempt; it strips every correct key.

Submit answers:

POST /wp-json/lms/v1/lessons/99/quiz
Content-Type: application/json
X-WP-Nonce: ...

{
  "answers": {
    "q1": "a",
    "q2": true,
    "q3": "Free text"
  }
}