WPSQT – Creating custom pages

By Iain Cambridge Monday, 18th April 2011

Plenty of WPQST users have been requesting custom page creation documentation, so here it is! As usual, if you have any questions leave a comment and I’ll get back to you.

---

Step One – Creating the directory

Firstly create the custom directory. The name and required location of the custom directory can be found on the quiz or survey details page, it will be highlighted with a yellow background. It will look something like…

/var/ww/wp-content/plugins/wp-survey-and-quiz-tool/pages/custom/0/quiz-1.

You should create this directory and then copy the folders from pages/site into the custom directory. You’re custom directory should have the following layout for a quiz.

• quiz-1/
  • site/
    • quiz/
      • finished.php
      • review.php
      • section.php
    • shared/
      • contact.php
      • custom-form.php

---

• survey-1/
  • site/
    • survey/
      • finished.php
      • section.php
    • shared/
      • contact.php
      • custom-form.php

---

---

Step Two – Editing Files

Each page has different variables available to it. These variables give you great flexibility with options ranging from showing custom messages based on the percentage of the questions that have been answered right or wrong to custom styling of the survey.

Variables

quiz/
finished.php
Raw
$canAutoMark – Tells us if it’s a quiz that can be automarked.
$correctAnswers – The number of questions that were answered correctly.
$totalPoints – The number of points that were availble during the quiz.
$quizName – The name of the quiz.
$percentRight – The percentage of questions that are correct.
$emailAddress – The target email for notification messages
$timeTaken – The amount of time taken to complete the quiz in seconds.
$personName – The name of the user who has taken the test.
$emailTrue – Boolean true or false that an email is to be sent.
Sessions
$_SESSION[‘wpsqt’][$quizName][‘quiz_details’][‘display_results’] – Yes or no to whether to show the results or not.
$_SESSION[‘wpsqt’][$quizName][‘quiz_details’][‘display_review’] – Yes or no to the question are we to show the review.
$_SESSION[‘wpsqt’][‘result_id’] – the id of the result in the MySQL database.

---

section.php
Raw
$quizName – The name of the quiz.
$sectionKey – The section key for the quiz.
$correct – The number of correct responses in last section.
$incorrect – The number of incorrect responses in the last section.
$numberOfSections – The number of sections in the quiz.
Sessions
$_SESSION[‘wpsqt’][$quizName][‘quiz_sections’][$sectionKey][‘questions’] – Array of questions.
$_SESSION[‘wpsqt’][‘current_step’] – The current step in the quiz.

---

review.php
Raw
$currentPoints – The current number of points.
$totalPoints – The total number of points.
Sessions
$_SESSION[‘wpsqt’]$quizName][‘quiz_sections’] – Array of the sections of the quiz.

---

---

survey/
finish.php
Raw
$surveyName – The name of the survey.
$personName – The name of the user who has taken the test.
$emailTrue – Boolean true or false that an email is to be sent.

---

section.php
Raw
$sectionKey – The section key for the survey.
$numberOfSections – The number of sections in the survey.
Sessions
$_SESSION[‘wpsqt’][$surveyName][‘survey_sections’][$sectionKey][‘questions’] – Survey questions.

---

---

shared/
Raw
$fields – Contains the custom fields for the form.

---

Array Layout

$_SESSION[‘wpsqt‘][$quizName][‘quiz_sections‘]

Array (
‘questions’ => Question Layout, // An Array of questions, layout can be found below
‘name’ => ‘cool section’, // Name of the section
‘type’ => ‘multiple’, // Type of the section, textarea or multiple
‘number’ => 10, // Number of questions in the section
‘orderby’ => ‘random’, // How the questions are to be ordered by
‘difficulty’ => ‘easy’, // The difficultly of the section, easy, medium or difficult.
‘stats’ => Array(
‘correct’ => 1,
‘incorrect’ => 2,
) // Correct/incorrect stats for the section.
)

---

$_SESSION[‘wpsqt‘][$quizName][‘quiz_sections‘][$sectionKey]['questions']

Array (
‘id’ => 1, // The question ID.
‘text’ => ‘What does Two plus Two equal?’, // The text for the questions.
‘additional’ => ‘Additional text, for the question’, // The additional text for the question.
‘type’ => ‘single’, // The type of question it is, multiple choice – single is “single”, or multiple choice – multiple is “multiple”.
‘type’ => ‘answers’ => Array(
0 => Array(
‘id’ => 1, // The Answer ID
‘text’ => ‘Answer one’ // The text for the answer
),
),
)

---

$_SESSION[‘wpsqt‘][$surveyName][‘survey_sections‘]

‘id’ => 1, // The section id
‘name’ => ‘Best Drink’, // The name of the survey
‘type’ => ‘’ // The type of questions in this section of the survey
‘number’ => 10 // The number of questions in this section of the survey
‘orderby’ => ‘random’ // The order of which the survey questions are to be displayed in
)

---

$_SESSION[‘wpsqt‘][$surveyName][‘survey_sections‘][$sectionKey]['questions']

Array (
‘id’ => 1, // The question ID.
‘text’ => ‘How awesome is IRN BRU?’, // The text for the questions.
‘type’ => ‘multiple’, // The type of question it is, multiple choice – single is “single”, or multiple choice – multiple is “multiple”.
‘type’ => ‘answers’ => Array(
0 => Array(
‘id’ => 1, // The Answer ID
‘text’ => ‘So awesome words can’t properly describe it.’ // The text for the answer
),
),
)

---

---

Required Code

Every form must have the field “wpsqt_nonce” with the value being the constant WPSQT_NONCE_CURRENT. Without this an error will be return for invalid referrer reference. As well as in a field which has the current step.

Example

<input type=”hidden” name=”wpsqt_nonce” value=”<?php echo WPSQT_NONCE_CURRENT; ?>” />

<input type=”hidden” name=”step” value=”<?php echo ( $_SESSION['wpsqt']['current_step']+1); ?>” />

---

Fields

Quiz
section.php
answers[$question_id][] – Contains the response(s), replace the “$question_id” with the question id.

Note: The extra [] is required.

Survey
section
answers[$survey_id] – Contains the response(s), replace the “$survey_id” with the survey id.

Note: The extra [] is NOT required.

---

Leave a comment if you need any further help with custom pages!

Posted in Plugins | 14 Comments »