Tutor LMS

https://docs.themeum.com/tutor-lms/
Admin
Tutor LMS is a robust WordPress eLearning plugin that enables users to create, customize, and manage...
Tokens:398,748
Snippets:8,069
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Apply Setup Wizard Attributes Filter

Source: https://docs.themeum.com/tutor-lms/developer-documentation/filters

Filters the attributes array used in the setup wizard.

```php
apply_filters('tutor_wizard_attributes', array());
```

--------------------------------

### Tutor Setup Admin Hooks

Source: https://docs.themeum.com/tutor-lms/developer-documentation/action-hooks/classes

Standard WordPress admin hooks utilized during Tutor LMS setup.

```php
do_action( 'admin_enqueue_scripts' );
do_action( 'admin_print_styles' );
do_action( 'admin_head' );
```

--------------------------------

### GET /tutor/v1/qna

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves the Q&A list for a user.

```APIDOC
## GET /tutor/v1/qna

### Description
Retrieves the Q&A list for a user.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/qna?user_id={user_id}&offset={offset}&limit={limit}
```

--------------------------------

### GET /wp-json/tutor/v1/reviews

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves a list of reviews for a user.

```APIDOC
## GET /wp-json/tutor/v1/reviews

### Description
Fetches the list of course reviews for a specific user.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/reviews

### Parameters
#### Query Parameters
- **user_id** (integer) - Required - The ID of the user.
```

--------------------------------

### GET /wp-json/tutor/v1/enrollments

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves a list of enrolled users for a course.

```APIDOC
## GET /wp-json/tutor/v1/enrollments

### Description
Fetches enrolled users based on the provided course ID.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/enrollments

### Parameters
#### Query Parameters
- **course_id** (integer) - Required - The ID of the course.
```

--------------------------------

### Embed Courses with Full Parameters

Source: https://docs.themeum.com/tutor-lms/shortcodes

Example showing the usage of multiple parameters including IDs, categories, sorting, and display settings.

```text
[tutor_course id="20,64" exclude_ids="567,332" category="18,19" orderby="ID" order="desc" count="3" column_per_row='3'
course_filter='off' show_pagination='on']
```

--------------------------------

### GET /tutor/v1/lesson/{lesson_id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves a lesson by its ID.

```APIDOC
## GET /tutor/v1/lesson/{lesson_id}

### Description
Retrieves a lesson by its ID.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/lesson/{lesson_id}

### Parameters
#### Path Parameters
- **lesson_id** (integer) - Required
```

--------------------------------

### Display Latest Featured Courses

Source: https://docs.themeum.com/tutor-lms/shortcodes

Example demonstrating how to display the 3 latest courses from a specific category.

```text
[tutor_course category="28" orderby="Date" order="desc" count="3"]
```

--------------------------------

### Quiz Type Examples

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

JSON examples for various quiz question types including True/False, Multiple Choice, and Matching.

```json
True/False Quiz
    {
      "quiz_id": 5595,
      "question_title": "Mark is the owner of FB",
      "question_type": "true_false",
      "correct_answer": "true",
      "answer_required": 1,
      "randomize_question": 1,
      "question_mark": 1.00,
      "show_question_mark": 1,
      "answer_explanation": "\n\nAnswer explanation\n\n",
      "question_description": "\n\nDummy description\n\n"
    }
```

```json
Single Choice Quiz
    {
      "quiz_id": 5592,
      "question_title": "Choose the NoSQL database from the list below",
      "question_type": "single_choice",
      "options": ["MySQL", "Mongo DB", "postgreSQL"],
      "correct_answer": "Mongo DB",
      "answer_required": 1,
      "randomize_question": 1,
      "question_mark": 1.00,
      "show_question_mark": 1,
      "answer_explanation": "\n\nAnswer explanation\n\n",
      "question_description": "\n\nDummy description\n\n"
    }
```

```json
Multiple Choice Quiz
    {
      "quiz_id": 5596,
      "question_title": "Choose the SQL databases from the below list",
      "question_type": "multiple_choice",
      "options": ["MySQL", "Mongo DB", "PostgreSQL"],
      "correct_answer": ["MySQL", "PostgreSQL"],
      "answer_required": 1,
      "randomize_question": 1,
      "question_mark": 1.00,
      "show_question_mark": 1,
      "answer_explanation": "\n\nAnswer explanation\n\n",
      "question_description": "\n\nDummy description\n\n"
    }
```

```json
Fill in the blanks Quiz
    {
      "quiz_id": 5597,
      "question_title": "Fill up the gaps",
      "question_type": "fill_in_the_blank",
      "question": "Dhaka city has a {dash} population. It is well known for its diverse {dash} & bustling {dash}.",
      "correct_answer": "large|cuisine|commerce",
      "answer_required": 1,
      "randomize_question": 1,
      "question_mark": 1.00,
      "show_question_mark": 1,
      "answer_explanation": "\n\nAnswer explanation\n\n",
      "question_description": "\n\nDummy description\n\n"
    }
```

```json
Short Answer Quiz
    {
      "quiz_id": 5598,
      "question_title": "Write a short answer about Software Engineering",
      "question_type": "short_answer",
      "answer_required": 1,
      "randomize_question": 1,
      "question_mark": 1.00,
      "show_question_mark": 1,
      "answer_explanation": "\n\nAnswer explanation\n\n",
      "question_description": "\n\nDummy description\n\n"
    }
```

```json
Open Ended Quiz 
    {
      "quiz_id": 5591,
      "question_title": "Describe your understanding of Data Structures with examples",
      "question_type": "open_ended",
      "answer_required": 1,
      "randomize_question": 1,
      "question_mark": 2.00,
      "show_question_mark": 1,
      "answer_explanation": "\n\nAnswer explanation\n\n",
      "question_description": "\n\nDummy description\n\n"
    }
```

```json
Matching Quiz
    {
      "quiz_id": 5594,
      "question_title": "Match the following programming languages with their primary use",
      "question_type": "matching",
      "matching_options": {
        "left": ["HTML", "Python", "CSS", "SQL"],
        "right": ["Styling", "Database", "Markup", "Scripting"]
      },
      "correct_answer": {
        "HTML": "Markup",
        "Python": "Scripting",
        "CSS": "Styling",
        "SQL": "Database"
      },
      "answer_required": 1,
      "randomize_question": 1,
      "question_mark": 2.00,
      "show_question_mark": 1,
      "answer_explanation": "\n\nAnswer explanation\n\n",
      "question_description": "\n\nDummy description\n\n"
    }
```

--------------------------------

### GET /wp-json/tutor/v1/lessons

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieves lessons for a specific topic ID.

```APIDOC
## GET /wp-json/tutor/v1/lessons

### Description
Retrieves lessons associated with a specific topic.

### Method
GET

### Endpoint
/wp-json/tutor/v1/lessons

### Parameters
#### Query Parameters
- **topic_id** (number) - Required - The ID of the topic.
```

--------------------------------

### GET /wp-json/tutor/v1/courses

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieves a list of courses with optional filtering and pagination.

```APIDOC
## GET /wp-json/tutor/v1/courses

### Description
Retrieves a list of courses. Supports pagination and filtering by order, orderby, tags, and categories.

### Method
GET

### Endpoint
/wp-json/tutor/v1/courses

### Parameters
#### Query Parameters
- **order** (string) - Optional - The order direction.
- **orderby** (string) - Optional - The field to order by.
- **paged** (number) - Optional - The page number for pagination.
- **tags** (string) - Optional - Comma-separated list of tags.
- **categories** (string) - Optional - Comma-separated list of categories.
```

--------------------------------

### GET /tutor/v1/topics

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves topics for a specific course.

```APIDOC
## GET /tutor/v1/topics

### Description
Retrieves topics for a specific course.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/topics?course_id={course_id}

### Parameters
#### Query Parameters
- **course_id** (integer) - Required
```

--------------------------------

### Implement Getter Method

Source: https://docs.themeum.com/tutor-lms/developer-documentation/custom-payment-gateways/step-2

Example of a getter method to access the merchant ID configuration value.

```php
private function getMerchantID(): string {
       return $this->merchant_id;
}
```

--------------------------------

### GET /wp-json/tutor/v1/course-annoucement/{course-id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieves announcements for a specific course.

```APIDOC
## GET /wp-json/tutor/v1/course-annoucement/{course-id}

### Description
Retrieves announcements for a specific course.

### Method
GET

### Endpoint
/wp-json/tutor/v1/course-annoucement/{course-id}

### Parameters
#### Path Parameters
- **course-id** (number) - Required - The ID of the course.
```

--------------------------------

### GET /wp-json/tutor/v1/course-contents/{course_id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieves the content structure of a specific course.

```APIDOC
## GET /wp-json/tutor/v1/course-contents/{course_id}

### Description
Retrieves the content structure of a specific course.

### Method
GET

### Endpoint
/wp-json/tutor/v1/course-contents/{course_id}

### Parameters
#### Path Parameters
- **course_id** (number) - Required - The ID of the course.
```

--------------------------------

### Get Course List

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieve a list of courses with optional filtering and pagination parameters.

```text
URL: http://yourwebsiteaddress/wp-json/tutor/v1/courses?order=&orderby=&paged=1&tags=tag1,tag2&categories=category1,category2
Type: GET
Parameters: optional
Pagination: true
```

--------------------------------

### GET /wp-json/tutor/v1/course-rating/{course-id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieves ratings for a specific course.

```APIDOC
## GET /wp-json/tutor/v1/course-rating/{course-id}

### Description
Retrieves ratings for a specific course.

### Method
GET

### Endpoint
/wp-json/tutor/v1/course-rating/{course-id}

### Parameters
#### Path Parameters
- **course-id** (number) - Required - The ID of the course.
```

--------------------------------

### GET /wp-json/tutor/v1/courses/{course_id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieves detailed information for a specific course by its ID.

```APIDOC
## GET /wp-json/tutor/v1/courses/{course_id}

### Description
Retrieves detailed information for a specific course.

### Method
GET

### Endpoint
/wp-json/tutor/v1/courses/{course_id}

### Parameters
#### Path Parameters
- **course_id** (number) - Required - The ID of the course.
```

--------------------------------

### GET /wp-json/tutor/v1/topics

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieves course topics for a specific course ID.

```APIDOC
## GET /wp-json/tutor/v1/topics

### Description
Retrieves topics associated with a specific course.

### Method
GET

### Endpoint
/wp-json/tutor/v1/topics

### Parameters
#### Query Parameters
- **course_id** (number) - Required - The ID of the course.
```

--------------------------------

### Get Lesson By Topic

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieve lessons associated with a specific topic ID.

```text
URL: http://yourwebsiteaddress/wp-json/tutor/v1/lessons?topic_id={lesson_id}
Type: GET
Parameter: required(number)
```

--------------------------------

### Define Gateway Configuration Field

Source: https://docs.themeum.com/tutor-lms/developer-documentation/custom-payment-gateways/step-4

Example of adding a configuration field, such as a merchant ID, to the gateway's fields array.

```php
array(
                   'name'  => 'merchant_id',
                   'type'  => 'secret_key',
                   'label' => 'Merchant ID',
                   'value' => '',
)
```

--------------------------------

### Initialize and Validate Configuration

Source: https://docs.themeum.com/tutor-lms/developer-documentation/custom-payment-gateways/step-2

Methods to initialize configuration values and verify that all required fields are set.

```php
public function createConfig(): void {
       parent::createConfig();
       $config = array( 'merchant_id' => $this->getMerchantID() );
       $this->updateConfig( $config );
}
```

```php
public function is_configured() {
       return $this->secret_key && $this->public_key && $this->merchant_id;
}
```

--------------------------------

### POST /tutor/v1/lessons/

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Creates a new lesson.

```APIDOC
## POST /tutor/v1/lessons/

### Description
Creates a new lesson.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/lessons/
```

--------------------------------

### GET /wp-json/tutor/v1/wishlists

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves the wishlist for a specific student.

```APIDOC
## GET /wp-json/tutor/v1/wishlists

### Description
Returns the list of courses in a student's wishlist.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/wishlists

### Parameters
#### Query Parameters
- **user_id** (integer) - Required - The ID of the user.
```

--------------------------------

### POST /tutor/v1/topics

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Creates a new course topic.

```APIDOC
## POST /tutor/v1/topics

### Description
Creates a new course topic.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/topics

### Request Body
- **topic_course_id** (integer) - Required
- **topic_title** (string) - Required
- **topic_summary** (string) - Optional
- **topic_author** (integer) - Optional
```

--------------------------------

### Course Create

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Creates a new course.

```APIDOC
## POST /wp-json/tutor/v1/courses

### Description
Creates a new course in the system.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/courses
```

--------------------------------

### GET /wp-json/tutor/v1/assignments

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves student assignment submission information.

```APIDOC
## GET /wp-json/tutor/v1/assignments

### Description
Retrieves submission information for a student assignment.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/assignments?student_id={student_id}&assignment_id={assignment_id}

### Parameters
#### Query Parameters
- **student_id** (integer) - Required - The ID of the student.
- **assignment_id** (integer) - Required - The ID of the assignment.
```

--------------------------------

### POST /wp-json/tutor/v1/assignments/

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Creates a new course assignment.

```APIDOC
## POST /wp-json/tutor/v1/assignments/

### Description
Creates a new assignment within a course.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/assignments/
```

--------------------------------

### POST /wp-json/tutor/v1/enrollments

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Enrolls a user in a specific course.

```APIDOC
## POST /wp-json/tutor/v1/enrollments

### Description
Facilitates the onboarding of a user into a Tutor LMS course.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/enrollments

### Request Body
- **user_id** (integer) - Required - The ID of the user.
- **course_id** (integer) - Required - The ID of the course.
```

--------------------------------

### GET /wp-json/tutor/v1/author-information/{author-id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieves information about a specific author.

```APIDOC
## GET /wp-json/tutor/v1/author-information/{author-id}

### Description
Retrieves profile information for a specific author.

### Method
GET

### Endpoint
/wp-json/tutor/v1/author-information/{author-id}

### Parameters
#### Path Parameters
- **author-id** (number) - Required - The ID of the author.
```

--------------------------------

### POST /tutor/v1/qna

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Adds or updates a Q&A entry.

```APIDOC
## POST /tutor/v1/qna

### Description
Adds or updates a Q&A entry.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/qna
```

--------------------------------

### Display Login Page

Source: https://docs.themeum.com/tutor-lms/shortcodes

Embed the login page on a site; requires Tutor LMS Pro.

```shortcode
[tutor_login]
```

--------------------------------

### POST /tutor/v1/quizzes

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Creates a new quiz.

```APIDOC
## POST /tutor/v1/quizzes

### Description
Creates a new quiz.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/quizzes
```

--------------------------------

### GET /tutor/v1/profile/{user_id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves the profile information for a specific user.

```APIDOC
## GET /tutor/v1/profile/{user_id}

### Description
Retrieves the profile information for a specific user.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/profile/{user_id}
```

--------------------------------

### Apply Template and Video Filters

Source: https://docs.themeum.com/tutor-lms/developer-documentation/filters

Handles template overrides, lesson template selection, and video stream visibility.

```php
$template_override = apply_filters('tutor_lms_should_template_override', true);
return apply_filters('tutor_lesson_template', $template);
$isPublicVideo = apply_filters('tutor_video_stream_is_public', false,  get_the_ID());
```

--------------------------------

### GET /tutor/v1/quiz-attempts/{attempt_id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves a single quiz attempt by ID.

```APIDOC
## GET /tutor/v1/quiz-attempts/{attempt_id}

### Description
Retrieves a single quiz attempt by ID.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/quiz-attempts/{attempt_id}

### Parameters
#### Path Parameters
- **attempt_id** (string) - Required - The ID of the attempt.
```

--------------------------------

### Course Lead Info Hooks

Source: https://docs.themeum.com/tutor-lms/developer-documentation/action-hooks/templates

Hooks for injecting content around course title, meta, and excerpt sections.

```php
do_action('tutor_course/single/title/before');
do_action('tutor_course/single/title/after');
do_action('tutor_course/single/lead_meta/before');
do_action('tutor_course/single/lead_meta/after');
do_action('tutor_course/single/excerpt/before');
do_action('tutor_course/single/excerpt/after');
```

--------------------------------

### Get Quiz Details

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Endpoint to retrieve details for a specific quiz.

```text
URL: https://yourdomain.com/wp-json/tutor/v1/quizzes/{quiz_id}
Type: PUT
```

--------------------------------

### GET /wp-json/tutor/v1/quiz/{quiz_id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves details for a specific quiz by its ID.

```APIDOC
## GET /wp-json/tutor/v1/quiz/{quiz_id}

### Description
Retrieves the details of a quiz using the specified quiz ID.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/quiz/{quiz_id}

### Parameters
#### Path Parameters
- **quiz_id** (integer) - Required - The unique identifier of the quiz.
```

--------------------------------

### POST /wp-json/tutor/v1/reviews

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Adds a new review for a course.

```APIDOC
## POST /wp-json/tutor/v1/reviews

### Description
Adds a student's review for a specific course.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/reviews

### Request Body
- **user_id** (integer) - Required - The ID of the user.
- **course_id** (integer) - Required - The ID of the course.
- **rating** (integer) - Required - The rating value.
- **review** (string) - Required - The review text.
```

--------------------------------

### GET /wp-json/tutor/v1/quiz-question-answer/{quiz-id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieves questions and answers for a specific quiz.

```APIDOC
## GET /wp-json/tutor/v1/quiz-question-answer/{quiz-id}

### Description
Retrieves questions and answers for a specific quiz.

### Method
GET

### Endpoint
/wp-json/tutor/v1/quiz-question-answer/{quiz-id}

### Parameters
#### Path Parameters
- **quiz-id** (number) - Required - The ID of the quiz.
```

--------------------------------

### Enqueue Custom Scripts for Course Builder

Source: https://docs.themeum.com/tutor-lms/developer-documentation/register-custom-fields

Hooks into the course builder load event to register a JavaScript file with the required dependencies.

```php
<?php
/**
 * Plugin Name: Tutor LMS Custom Fields
 * Description: Adds custom fields to Tutor LMS course builder.
 * Version: 1.0.0
 * Author: Themeum
 */

add_action('tutor_after_course_builder_load', 'tlcf_enqueue_scripts');
/**
* Enqueue custom scripts for course builder
*
* @return void
*/
function tlcf_enqueue_scripts() {
   $js_url = plugin_dir_url( __FILE__ ) . 'custom-fields.js';
   wp_enqueue_script(
       'tlcf-custom-fields-js',
       $js_url,
       array( 'tutor-course-builder' ),
       '1.0.0',
       true
   );
}

// ... (rest of the code will be added here)
?>
```

--------------------------------

### GET /wp-json/tutor/v1/quiz/{topic-id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieves quiz information for a specific topic.

```APIDOC
## GET /wp-json/tutor/v1/quiz/{topic-id}

### Description
Retrieves quiz details for a specific topic.

### Method
GET

### Endpoint
/wp-json/tutor/v1/quiz/{topic-id}

### Parameters
#### Path Parameters
- **topic-id** (number) - Required - The ID of the topic.
```

--------------------------------

### Configure Instructor List Filter

Source: https://docs.themeum.com/tutor-lms/shortcodes

Toggle the visibility of category, search, and rating filters.

```shortcode
filter=on
```

```shortcode
filter=off
```

--------------------------------

### POST /tutor/v1/lesson-mark-complete

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Marks a lesson as complete.

```APIDOC
## POST /tutor/v1/lesson-mark-complete

### Description
Marks a lesson as complete.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/lesson-mark-complete
```

--------------------------------

### Display Instructor List

Source: https://docs.themeum.com/tutor-lms/shortcodes

Use this shortcode to showcase an instructor list on a page or post.

```shortcode
[tutor_instructor_list column_per_row="1" filter=on count="2" layout="pp-top-left" category_limit="2" hide_empty_category]
```

--------------------------------

### Get Course Ratings

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieve ratings for a specific course ID.

```text
URL: http://yourwebsiteaddress/wp-json/tutor/v1/course-rating/{course-id}
Type: GET
Parameter: required(number)
```

--------------------------------

### Instructor Signup Form Action Hooks

Source: https://docs.themeum.com/tutor-lms/developer-documentation/action-hooks/action-hooks-overview

Hooks for injecting content before or after fields in the instructor registration form.

```php
do_action('tutor_add_new_instructor_form_fields_before');
do_action('tutor_add_new_instructor_form_fields_after');
```

--------------------------------

### Get Author Information

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieve information about an author using their ID.

```text
URL: http://yourwebsiteaddress/wp-json/tutor/v1/author-information/{author-id}
Type: GET
Parameter: required(number)
```

--------------------------------

### Get Course Announcements

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieve announcements for a specific course ID.

```text
URL: http://yourwebsiteaddress/wp-json/tutor/v1/course-annoucement/{course-id}
Type: GET
Parameter: required(number)
```

--------------------------------

### GET /tutor/v1/students/{student_id}/order-histories

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves the order history for a specific student.

```APIDOC
## GET /tutor/v1/students/{student_id}/order-histories

### Description
Retrieves the order history for a specific student.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/students/{student_id}/order-histories
```

--------------------------------

### POST /wp-json/tutor/v1/reviews/{course_id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Updates an existing review.

```APIDOC
## POST /wp-json/tutor/v1/reviews/{course_id}

### Description
Updates the student's review for a specific course.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/reviews/{course_id}

### Parameters
#### Path Parameters
- **course_id** (integer) - Required - The ID of the course.
```

--------------------------------

### GET /tutor/v1/students/{student_id}/calendar

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves the calendar events for a specific student.

```APIDOC
## GET /tutor/v1/students/{student_id}/calendar

### Description
Retrieves the calendar events for a specific student.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/students/{student_id}/calendar
```

--------------------------------

### GET /tutor/v1/students/{student_id}/dashboard

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves the dashboard information for a specific student.

```APIDOC
## GET /tutor/v1/students/{student_id}/dashboard

### Description
Retrieves the dashboard information for a specific student.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/students/{student_id}/dashboard
```

--------------------------------

### POST /tutor/v1/quiz-questions

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Creates a new quiz question.

```APIDOC
## POST /tutor/v1/quiz-questions

### Description
Creates a new quiz question.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/quiz-questions
```

--------------------------------

### Quiz Attempts Get API

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieve quiz attempts for a user profile.

```text
URL: https://yourdomain.com/wp-json/tutor/v1/profile/{user_id}
Type: GET
```

--------------------------------

### Define Class Namespace and Imports

Source: https://docs.themeum.com/tutor-lms/developer-documentation/custom-payment-gateways/step-2

The initial namespace declaration and required imports for the payment configuration class.

```php
namespace CustomPayment;

use Tutor\Ecommerce\Settings;
use Ollyo\PaymentHub\Core\Payment\BaseConfig;
use Tutor\PaymentGateways\Configs\PaymentUrlsTrait;
use Ollyo\PaymentHub\Contracts\Payment\ConfigContract;
```

--------------------------------

### GET /wp-json/tutor/v1/course-assignment/{assignment_id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves information for a specific course assignment by its ID.

```APIDOC
## GET /wp-json/tutor/v1/course-assignment/{assignment_id}

### Description
Retrieves details for a specific course assignment.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/course-assignment/{assignment_id}

### Parameters
#### Path Parameters
- **assignment_id** (integer) - Required - The unique identifier of the assignment.
```

--------------------------------

### Utility and Enrollment Action Hooks

Source: https://docs.themeum.com/tutor-lms/developer-documentation/action-hooks/classes

Hooks for managing course enrollment, lesson completion, and instructor status changes.

```php
do_action('tutor_is_enrolled_before', $course_id, $user_id);
do_action('tutor_mark_lesson_complete_before', $post_id, $user_id);
do_action('tutor_mark_lesson_complete_after', $post_id, $user_id);
do_action('tutor_before_enroll', $course_id);
do_action('tutor_after_enroll', $course_id, $isEnrolled);
do_action('tutor/course/enrol_status_change/before',$enrol_id, $new_status );
do_action('tutor/course/enrol_status_change/after',$enrol_id, $new_status );
do_action('tutor_before_approved_instructor', $instructor_id);
do_action('tutor_after_approved_instructor', $instructor_id);
do_action('tutor_before_blocked_instructor', $instructor_id);
do_action('tutor_after_blocked_instructor', $instructor_id);
do_action( 'password_reset', $user, $new_pass );
```

--------------------------------

### Template and Pagination Action Hooks

Source: https://docs.themeum.com/tutor-lms/developer-documentation/action-hooks/includes

Use these hooks to execute code before or after template loading or lesson pagination.

```php
do_action('tutor_load_template_before', $template, $variables);
do_action('tutor_load_template_after', $template, $variables);
do_action('tutor_lesson_next_previous_pagination_before');
do_action('tutor_lesson_next_previous_pagination_after');
```

--------------------------------

### Get Quiz Questions

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieve questions and answers for a specific quiz ID.

```text
URL: http://yourwebsiteaddress/wp-json/tutor/v1/quiz-question-answer/{quiz-id}
Type: GET
Parameter: required(number)
```

--------------------------------

### POST /tutor/v1/upload-photo/profile-photo

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Uploads a profile photo.

```APIDOC
## POST /tutor/v1/upload-photo/profile-photo

### Description
Uploads a profile photo.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/upload-photo/profile-photo
```

--------------------------------

### Course Loop and Archive Filters

Source: https://docs.themeum.com/tutor-lms/developer-documentation/filters

Filters for customizing the course archive loop, including pagination, content wrappers, and loop elements.

```php
apply_filters( 'tutor_course_loop_start', ob_get_clean());
apply_filters( 'tutor_course_loop_end', ob_get_clean() );

apply_filters( 'tutor_course_archive_pagination', ob_get_clean() );

apply_filters( 'tutor_course_loop_before_content', ob_get_clean() );
apply_filters( 'tutor_course_loop_after_content', ob_get_clean() );

apply_filters( 'tutor_course_loop_title', ob_get_clean() );
apply_filters( 'tutor_course_loop_header', ob_get_clean() );
apply_filters( 'tutor_course_loop_footer', ob_get_clean() );

apply_filters( 'tutor_course_loop_start_content_wrap', ob_get_clean() );
apply_filters( 'tutor_course_loop_end_content_wrap', ob_get_clean() );

apply_filters( 'tutor_course_loop_thumbnail', ob_get_clean() );
apply_filters( 'tutor_course_loop_wrap_classes', array(
apply_filters( 'tutor_course_loop_col_classes', array(
apply_filters( 'tutor_container_classes', array(

apply_filters( 'tutor_post_class', array(
apply_filters( 'tutor_course_archive_filter_bar', ob_get_clean() );
apply_filters( 'tutor_widget_course_loop_classes', array(
```

--------------------------------

### Get Quiz By Topic

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieve quiz information for a specific topic ID.

```text
URL: http://yourwebsiteaddress/wp-json/tutor/v1/quiz/{topic-id}
Type: GET
Parameter: required(number)
```

--------------------------------

### Template Loading Action Hooks

Source: https://docs.themeum.com/tutor-lms/developer-documentation/action-hooks/classes

Hook triggered before a lesson template is loaded.

```php
do_action('tutor_lesson_load_before', $template);
```

--------------------------------

### Addon List Filters

Source: https://docs.themeum.com/tutor-lms/developer-documentation/filters

Filters for addon configuration and display lists.

```php
apply_filters('tutor_addons_lists_config', array());
```

```php
apply_filters('tutor_pro_addons_lists_for_display', array());
```

--------------------------------

### Get Course Topics

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieve topics associated with a specific course ID.

```text
URL: http://yourwebsiteaddress/wp-json/tutor/v1/topics?course_id={course_id}
Type: GET
Parameter: required(number)
```

--------------------------------

### Get Course Details

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieve details for a specific course using its ID.

```text
URL: http://yourwebsiteaddress/wp-json/tutor/v1/courses/{course_id}
Type: GET
Parameter: required(number)
```

--------------------------------

### POST /tutor/v1/quiz-attempts

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Creates a new quiz attempt.

```APIDOC
## POST /tutor/v1/quiz-attempts

### Description
Creates a new quiz attempt.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/quiz-attempts
```

--------------------------------

### Single Preview Lesson Template Hooks

Source: https://docs.themeum.com/tutor-lms/developer-documentation/action-hooks/templates

Hooks available in single-preview-lesson.php for modifying the preview lesson layout.

```php
do_action('tutor_lesson/single/before/wrap');
do_action('tutor_lesson/single/before/lesson_sidebar');
do_action('tutor/lesson_list/before/topic', $topic_id);
do_action('tutor/lesson_list/after/topic', $topic_id);
do_action('tutor_lesson/single/after/lesson_sidebar');
do_action('tutor_lesson/single/before/content');
do_action('tutor_lesson/single/before/content');
do_action('tutor_lesson/single/after/content');
do_action('tutor_lesson/single/after/wrap');
```

--------------------------------

### Quiz Body Hooks

Source: https://docs.themeum.com/tutor-lms/developer-documentation/action-hooks/templates

Hooks for the quiz body and start form area.

```php
do_action('tutor_quiz/body/before', $quiz_id);
do_action('tuotr_quiz/start_form/before', $quiz_id);
do_action('tuotr_quiz/start_form/after', $quiz_id);
do_action('tutor_quiz/previous_attempts_html/before', $previous_attempts, $quiz_id);
do_action('tutor_quiz/previous_attempts/after', $previous_attempts, $quiz_id);
do_action('tutor_quiz/body/after', $quiz_id);
```

--------------------------------

### GET /tutor/v1/students/{student_id}/courses

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves the list of courses enrolled by a specific student.

```APIDOC
## GET /tutor/v1/students/{student_id}/courses

### Description
Retrieves the list of courses enrolled by a specific student.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/students/{student_id}/courses
```

--------------------------------

### POST /wp-json/tutor/v1/wishlists

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Adds a course to a student's wishlist.

```APIDOC
## POST /wp-json/tutor/v1/wishlists

### Description
Adds a course to the user's wishlist.

### Method
POST

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/wishlists

### Request Body
- **user_id** (integer) - Required - The ID of the user.
- **course_id** (integer) - Required - The ID of the course.
```

--------------------------------

### Get Student Course List API

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieve a list of courses for a specific student.

```text
URL: https://yourdomain.com/wp-json/tutor/v1/students/{student_id}/courses
Type: GET
```

--------------------------------

### Create Course Dashboard Hooks

Source: https://docs.themeum.com/tutor-lms/developer-documentation/action-hooks/dashboard

Hooks triggered during the course creation process in the dashboard.

```php
do_action('tutor_load_template_before', 'dashboard.create-course', null);
do_action('tutor/dashboard_course_builder_before');
do_action('tutor/dashboard_course_builder_form_field_before');
do_action('tutor/frontend_course_edit/after/description', $post);
do_action('tutor/dashboard_course_builder_form_field_after');
do_action('tutor/dashboard_course_builder_after');
do_action('tutor_load_template_after', 'dashboard.create-course', null);
```

--------------------------------

### GET /tutor/v1/quiz-attempts

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves quiz attempts filtered by quiz ID and student ID.

```APIDOC
## GET /tutor/v1/quiz-attempts

### Description
Retrieves quiz attempts filtered by quiz ID and student ID.

### Method
GET

### Endpoint
https://yourdomain.com/wp-json/tutor/v1/quiz-attempts?quiz_id={quiz_id}&student_id={student_id}

### Parameters
#### Query Parameters
- **quiz_id** (string) - Required - The ID of the quiz.
- **student_id** (string) - Required - The ID of the student.
```

--------------------------------

### Course Question and Answer Hooks

Source: https://docs.themeum.com/tutor-lms/developer-documentation/action-hooks/templates

Hooks for the course Q&A section.

```php
do_action('tutor_course/question_and_answer/before');
do_action('tutor_course/question_and_answer/after');
```

--------------------------------

### GET /tutor/v1/quiz-question-answer/{quiz_id}

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Retrieves quiz attempt details for a specific quiz ID.

```APIDOC
## GET /tutor/v1/quiz-question-answer/{quiz_id}

### Description
Retrieves quiz attempt details for a specific quiz ID.

### Method
GET

### Endpoint
https://yourdomain.com/tutor/wp-json/tutor/v1/quiz-question-answer/{quiz_id}

### Parameters
#### Path Parameters
- **quiz_id** (string) - Required - The ID of the quiz.
```

--------------------------------

### Define Plugin Constants

Source: https://docs.themeum.com/tutor-lms/developer-documentation/custom-payment-gateways/step-6

Set the version, URL, path, and payments directory constants to ensure the plugin can correctly locate its internal resources.

```php
// Define plugin meta info.
define( 'CUSTOM_PAYMENT_VERSION', '1.0.0' );
define( 'CUSTOM_PAYMENT_URL', plugin_dir_url( __FILE__ ) );
define( 'CUSTOM_PAYMENT_PATH', plugin_dir_path( __FILE__ ) );
define( 'CUSTOM_PAYMENT_PAYMENTS_DIR', trailingslashit( CUSTOM_PAYMENT_PATH . 'src/Payments' ) );
```

--------------------------------

### Get Single Quiz Attempt

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-apis-for-tutor-lms-pro

Endpoint to retrieve a specific quiz attempt by ID.

```text
URL: https://yourdomain.com/wp-json/tutor/v1/quiz-attempts/{attempt_id}
Type: GET
```

--------------------------------

### Get Course Content

Source: https://docs.themeum.com/tutor-lms/developer-documentation/rest-api

Retrieve the full content structure for a specific course ID.

```text
URL: http://yourwebsiteaddress/wp-json/tutor/v1/course-contents/{course_id}
Type: GET
```
Tokens:
Raw