### Install WPCS Composer Packages

Source: https://github.com/themeum/tutor/blob/master/readme.md

Install the required PHP CodeSniffer and WordPress Coding Standards packages globally.

```bash
1. composer global require squizlabs/php_codesniffer
2. composer global require wp-coding-standards/wpcs
```

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

### Install Cypress Dependencies

Source: https://github.com/themeum/tutor/blob/master/readme.md

Install project dependencies required for running Cypress tests.

```bash
npm install
```

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

### Configure WPCS for WordPress

Source: https://github.com/themeum/tutor/blob/master/readme.md

Set the installed paths and default coding standard to WordPress.

```bash
phpcs --config-set installed_paths /Users/your_username/.composer/vendor/wp-coding-standards/wpcs
phpcs --config-set default_standard WordPress
```

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

### Run PHP Unit Tests

Source: https://github.com/themeum/tutor/blob/master/readme.md

Commands to install dependencies, set up the test database, and execute PHPUnit tests.

```bash
1. composer install
2. bash bin/install-wp-tests.sh db_name user_name password host latest
3. vendor/bin/phpunit --info
```

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

### Cypress Environment Configuration

Source: https://github.com/themeum/tutor/blob/master/readme.md

Example content for the .env file required for Cypress test authentication and configuration.

```text
# WordPress site URL
CYPRESS_base_url=<YOUR WORDPRESS SITE>

# Admin credentials
CYPRESS_admin_username=<ADMIN USERNAME>
CYPRESS_admin_password=<ADMIN PASSWORD>

# Zoom credentials
CYPRESS_instructor_zoom_account_id=<YOUR ZOOM ACCOUNT ID>
CYPRESS_instructor_zoom_client_id=<YOUR ZOOM CLIENT ID>
CYPRESS_instructor_zoom_client_secret=<YOUR ZOOM CLIENT SECRET>
```

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

### Check if Quiz is Started

Source: https://context7.com/themeum/tutor/llms.txt

Determine if a user has started a particular quiz. Returns attempt details if started.

```php
<?php
// Check if quiz is started
$attempt = tutor_utils()->is_started_quiz($quiz_id);
```

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

### Get Course Contents by Topic

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve all content items (lessons, quizzes, etc.) belonging to a specific topic. Use -1 for limit to get all.

```php
<?php
// Get course content by topic
$contents = tutor_utils()->get_course_contents_by_topic($topic_id, -1);
```

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

### Get Raw Course Price

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve the regular and sale prices for a course.

```php
<?php
// Get course price
$price = tutor_utils()->get_raw_course_price($course_id);
echo "Regular Price: " . $price->regular_price;
echo "Sale Price: " . $price->sale_price;
```

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

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

Source: https://context7.com/themeum/tutor/llms.txt

Retrieves instructor profile information.

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

### Description
Retrieve instructor profile information.

### Method
GET

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

### Parameters
#### Path Parameters
- **user_id** (integer) - Required - The ID of the instructor whose information is to be retrieved.

### Request Example
```bash
curl -X GET "https://yoursite.com/wp-json/tutor/v1/author-information/42" \
  -H "Authorization: Bearer YOUR_API_KEY"
```
```

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

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

Source: https://context7.com/themeum/tutor/llms.txt

Retrieves ratings and reviews for a specific course.

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

### Description
Retrieve ratings and reviews for a specific course.

### Method
GET

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

### Parameters
#### Path Parameters
- **course_id** (integer) - Required - The ID of the course to retrieve ratings for.
#### Query Parameters
- **offset** (integer) - Optional - The number of records to skip.
- **limit** (integer) - Optional - The maximum number of records to return.

### Response
#### Success Response (200)
- **code** (string) - Indicates the status of the request, e.g., "success".
- **message** (string) - A message describing the result of the request.
- **data** (object) - Contains the rating and review information.
  - **rating_avg** (float) - The average rating for the course.
  - **rating_count** (integer) - The total number of ratings.
  - **reviews** (array) - A list of reviews for the course.
    - **comment_ID** (integer) - The ID of the review comment.
    - **comment_content** (string) - The content of the review.
    - **rating** (integer) - The rating given in the review.
    - **user_id** (integer) - The ID of the user who submitted the review.

### Response Example
```json
{
  "code": "success",
  "message": "Course rating retrieved successfully",
  "data": {
    "rating_avg": 4.5,
    "rating_count": 150,
    "reviews": [
      {
        "comment_ID": 1,
        "comment_content": "Great course!",
        "rating": 5,
        "user_id": 42
      }
    ]
  }
}
```
```

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

### Get Lessons by Topic ID

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve lessons that belong to a specific topic within a course. Requires an API key for authorization.

```bash
curl -X GET "https://yoursite.com/wp-json/tutor/v1/lessons?topic_id=456" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Get User Profile URL

Source: https://context7.com/themeum/tutor/llms.txt

Generate the URL for a user's profile page, with an option to view as an instructor.

```php
<?php
// Get user profile URL
$profile_url = tutor_utils()->profile_url($user_id, $instructor_view = true);
```

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

### Get Author/Instructor Information

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve profile information for a specific author or instructor using their user ID.

```bash
curl -X GET "https://yoursite.com/wp-json/tutor/v1/author-information/42" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Get and Set Tutor LMS Options

Source: https://context7.com/themeum/tutor/llms.txt

Use `tutor_utils()->get_option()` to retrieve configuration values and `tutor_utils()->update_option()` to modify them. Default values can be provided for `get_option` if the option does not exist.

```php
<?php
// Get option value
$monetize_by = tutor_utils()->get_option('monetize_by'); // 'wc', 'edd', 'tutor'
$courses_per_page = tutor_utils()->get_option('courses_per_page', 12);
$enable_qa = tutor_utils()->get_option('enable_q_and_a_on_course', true);

// Get option with dot notation for nested values
$time_type = tutor_utils()->get_option('time_limit.time_type');

// Update option
tutor_utils()->update_option('courses_per_page', 16);

// Check specific settings
$can_publish = tutor_utils()->get_option('instructor_can_publish_course', false);
$is_marketplace = tutor_utils()->get_option('enable_course_marketplace');
```

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

### Get All Courses with Pagination and Filters

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve a paginated list of published courses. Supports filtering by order, orderby, pagination, and categories. Requires an API key for authorization.

```bash
# Get all courses with default pagination
curl -X GET "https://yoursite.com/wp-json/tutor/v1/courses" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```bash
# Get courses with filters
curl -X GET "https://yoursite.com/wp-json/tutor/v1/courses?order=DESC&orderby=title&paged=1&categories=web-development,design" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "code": "success",
  "message": "Course retrieved successfully",
  "data": {
    "posts": [
      {
        "ID": 123,
        "post_title": "Complete Web Development",
        "post_content": "Course description...",
        "post_author": {
          "ID": 1,
          "user_login": "instructor",
          "display_name": "John Doe"
        },
        "thumbnail_url": "https://yoursite.com/wp-content/uploads/course-thumb.jpg",
        "ratings": {
          "rating_avg": 4.5,
          "rating_count": 150
        },
        "course_category": [...],
        "course_tag": [...],
        "price": "99.00",
        "additional_info": {...}
      }
    ],
    "total_course": 50,
    "total_page": 5
  }
}
```

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

### Get Questions by Quiz

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve all questions associated with a specific quiz.

```php
<?php
// Get questions by quiz
$questions = tutor_utils()->get_questions_by_quiz($quiz_id);
```

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

### GET /tutor/v1/quizzes/{id}

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve quiz information, settings, and associated questions.

```APIDOC
## GET /tutor/v1/quizzes/{id}

### Description
Retrieve quiz information with settings or specific quiz details.

### Method
GET

### Endpoint
/wp-json/tutor/v1/quizzes/{id}

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique ID of the quiz

### Response
#### Success Response (200)
- **data** (object) - Quiz settings and metadata
```

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

### Get Instructor List

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve a paginated list of instructors, with options for searching, filtering by course, and sorting.

```php
<?php
// Get instructor list with pagination
$instructors = tutor_utils()->get_instructors(
    $offset = 0,
    $limit = 10,
    $search_term = '',
    $course_id = '',
    $date = '',
    $order = 'ASC',
    $status = 'approved'
);
```

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

### GET /tutor/v1/course-contents/{id}

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve the complete curriculum structure for a course, including topics, lessons, and quizzes.

```APIDOC
## GET /tutor/v1/course-contents/{id}

### Description
Retrieve the complete curriculum structure for a course.

### Method
GET

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

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique ID of the course

### Response
#### Success Response (200)
- **data** (array) - List of topics containing lessons and quizzes
```

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

### Get Enrolled Courses by User

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve a list of all courses a specific user is enrolled in.

```php
<?php
// Get enrolled courses for a user
$courses = tutor_utils()->get_enrolled_courses_by_user($user_id);
```

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

### GET /tutor/v1/courses

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve a paginated list of all published courses with categories, tags, author details, and ratings.

```APIDOC
## GET /tutor/v1/courses

### Description
Retrieve a paginated list of all published courses.

### Method
GET

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

### Parameters
#### Query Parameters
- **order** (string) - Optional - Sort order (DESC/ASC)
- **orderby** (string) - Optional - Field to order by (e.g., title)
- **paged** (integer) - Optional - Page number for pagination
- **categories** (string) - Optional - Comma-separated list of category slugs

### Response
#### Success Response (200)
- **code** (string) - Status code
- **message** (string) - Success message
- **data** (object) - Contains posts array, total_course, and total_page
```

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

### GET /tutor/v1/courses/{id}

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve detailed information about a specific course including settings, duration, level, and materials.

```APIDOC
## GET /tutor/v1/courses/{id}

### Description
Retrieve detailed information about a specific course.

### Method
GET

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

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique ID of the course

### Response
#### Success Response (200)
- **data** (object) - Detailed course settings, price, duration, level, and media info
```

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

### GET /wp-json/tutor/v1/quiz-attempt-details/{attempt_id}

Source: https://context7.com/themeum/tutor/llms.txt

Retrieves the details of a specific quiz attempt.

```APIDOC
## GET /wp-json/tutor/v1/quiz-attempt-details/{attempt_id}

### Description
Retrieves the details of a specific quiz attempt using its ID.

### Method
GET

### Endpoint
/wp-json/tutor/v1/quiz-attempt-details/{attempt_id}

### Parameters
#### Path Parameters
- **attempt_id** (integer) - Required - The ID of the quiz attempt to retrieve.

### Request Example
```bash
curl -X GET "https://yoursite.com/wp-json/tutor/v1/quiz-attempt-details/789" \
  -H "Authorization: Bearer YOUR_API_KEY"
```
```

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

### Get Specific Course Details

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve detailed information for a single course using its ID. Includes settings, duration, level, and materials. Requires an API key for authorization.

```bash
# Get course details by ID
curl -X GET "https://yoursite.com/wp-json/tutor/v1/courses/123" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "code": "course_detail",
  "message": "Course detail retrieved successfully",
  "data": {
    "course_settings": {...},
    "course_price_type": "paid",
    "course_duration": {"hours": "10", "minutes": "30"},
    "course_level": "intermediate",
    "course_benefits": "What you'll learn...",
    "course_requirements": "Prerequisites...",
    "course_target_audience": "This course is for...",
    "course_material_includes": "Downloadable resources...",
    "video": {"source": "youtube", "source_youtube": "https://..."},
    "disable_qa": false
  }
}
```

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

### Get Course Duration

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve the duration of a course in a specified format.

```php
<?php
// Get course duration
$duration = tutor_utils()->get_course_duration($course_id, false);
```

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

### Get Course Topics

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve all topics associated with a course. Requires WP_Query loop.

```php
<?php
// Get course topics
$topics = tutor_utils()->get_topics($course_id);
while ($topics->have_posts()) {
    $topics->the_post();
    echo get_the_title();
}
```

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

### Get Course Contents by Course ID

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve the complete curriculum structure for a course, including topics, lessons, and quizzes. Requires an API key for authorization.

```bash
# Get course contents by course ID
curl -X GET "https://yoursite.com/wp-json/tutor/v1/course-contents/123" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "code": "success",
  "message": "Course contents retrieved successfully",
  "data": [
    {
      "id": 456,
      "title": "Getting Started",
      "summary": "Introduction to the course",
      "contents": [
        {
          "ID": 789,
          "post_title": "Welcome Lesson",
          "post_type": "lesson"
        },
        {
          "ID": 790,
          "post_title": "Module Quiz",
          "post_type": "tutor_quiz",
          "total_question": 10
        }
      ]
    }
  ]
}
```

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

### Get Course Rating Information

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve the average rating and total review count for a course.

```php
<?php
// Get course rating information
$rating = tutor_utils()->get_course_rating($course_id);
echo "Average Rating: " . $rating->rating_avg;
echo "Total Reviews: " . $rating->rating_count;
```

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

### Get Tutor Dashboard URL

Source: https://context7.com/themeum/tutor/llms.txt

Generate URLs for the Tutor dashboard, including specific sections like 'my-courses'.

```php
<?php
// Get dashboard URL
$dashboard_url = tutor_utils()->tutor_dashboard_url();
$my_courses_url = tutor_utils()->tutor_dashboard_url('my-courses');
```

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

### Get Course Topics by Course ID

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve all topics associated with a specific course. Requires an API key for authorization.

```bash
curl -X GET "https://yoursite.com/wp-json/tutor/v1/topics?course_id=123" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Get Course Ratings and Reviews

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve ratings and reviews for a specific course using its ID. Supports pagination with offset and limit parameters.

```bash
curl -X GET "https://yoursite.com/wp-json/tutor/v1/course-rating/123?offset=0&limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```json
{
  "code": "success",
  "message": "Course rating retrieved successfully",
  "data": {
    "rating_avg": 4.5,
    "rating_count": 150,
    "reviews": [
      {
        "comment_ID": 1,
        "comment_content": "Great course!",
        "rating": 5,
        "user_id": 42
      }
    ]
  }
}
```

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

### Get Quiz Option/Setting

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve specific settings or options for a quiz, such as time limit or passing grade.

```php
<?php
// Get quiz option/setting
$time_limit = tutor_utils()->get_quiz_option($quiz_id, 'time_limit.time_value');
$passing_grade = tutor_utils()->get_quiz_option($quiz_id, 'passing_grade', 0);
```

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

### Get Quiz Attempt Details

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve details for a specific quiz attempt using its ID.

```bash
curl -X GET "https://yoursite.com/wp-json/tutor/v1/quiz-attempt-details/789" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Get Course Announcements by Course ID

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve announcements made for a specific course. Requires an API key for authorization.

```bash
curl -X GET "https://yoursite.com/wp-json/tutor/v1/course-announcement/123" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Get Quiz Attempt Details

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve detailed information about a specific quiz attempt using its attempt ID.

```php
<?php
// Get quiz attempt details
$attempt = tutor_utils()->get_attempt($attempt_id);
```

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

### Get Tutor User Data

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve user data, including Tutor-specific fields like display name and profile photo URL.

```php
<?php
// Get user data with tutor-specific fields
$tutor_user = tutor_utils()->get_tutor_user($user_id);
echo $tutor_user->display_name;
echo $tutor_user->tutor_profile_photo_url;
```

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

### Tutor Quiz Hooks

Source: https://context7.com/themeum/tutor/llms.txt

These actions allow you to hook into various stages of the quiz process, including starting, ending, and reviewing quiz attempts. They are useful for logging, tracking progress, and handling quiz timeouts.

```php
<?php
// Before quiz starts
add_action('tutor_quiz/start/before', function($quiz_id, $user_id) {
    // Log quiz attempt start
}, 10, 2);

// After quiz starts
add_action('tutor_quiz/start/after', function($quiz_id, $user_id, $attempt_id) {
    // Track attempt, set timers
}, 10, 3);

// When quiz attempt ends
add_action('tutor_quiz/attempt_ended', function($attempt_id, $course_id, $user_id) {
    // Calculate results, check for course completion
}, 10, 3);

// After quiz answer is reviewed by instructor
add_action('tutor_quiz/answer/review/after', function($attempt_answer_id, $course_id, $student_id) {
    // Notify student of review, update progress
}, 10, 3);

// Quiz timeout
add_action('tutor_quiz_timeout', function($attempt_id, $quiz_id, $user_id) {
    // Handle timeout, mark attempt as timed out
}, 10, 3);
```

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

### Get Quiz Information

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve quiz details, including quizzes by topic ID, a specific quiz by ID, and its questions and answers. Requires an API key for authorization.

```bash
# Get quizzes by topic ID
curl -X GET "https://yoursite.com/wp-json/tutor/v1/quizzes?topic_id=456" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```bash
# Get specific quiz by ID
curl -X GET "https://yoursite.com/wp-json/tutor/v1/quizzes/789" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

```bash
# Get quiz questions and answers
curl -X GET "https://yoursite.com/wp-json/tutor/v1/quiz-question-answer/789" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

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

### Runtime Configuration with Tutor

Source: https://github.com/themeum/tutor/blob/master/stories/Docs/GettingStarted.mdx

Import and use `tutorConfig` for runtime settings like API endpoints and feature flags. Ensure `wpAjaxInstance` is available for API calls.

```typescript
import { tutorConfig } from '@TutorShared/config/config';
import { wpAjaxInstance } from '@TutorShared/utils/api';

// API Integration
const fetchCourses = async () => {
  const response = await wpAjaxInstance.get('/courses');
  return response.data;
};

// Feature Flag Usage
const shouldShowNewFeature = tutorConfig.features?.newDashboard?.enabled;

// Environment-specific Logic
const isProduction = tutorConfig.environment === 'production';
```

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

### Using Constants for Responsive Design and Validation

Source: https://github.com/themeum/tutor/blob/master/stories/Docs/GettingStarted.mdx

Import constants like `BREAKPOINTS` and `FILE_SIZE_LIMIT` from `@TutorShared/config/constants`. Use `BREAKPOINTS` for responsive layouts and `FILE_SIZE_LIMIT` for file validation.

```typescript
import { 
  BREAKPOINTS, 
  FILE_SIZE_LIMIT, 
  DateFormats,
  DEFAULT_FORM_FIELD_PROPS 
} from '@TutorShared/config/constants';

// Responsive Design Implementation
const useResponsiveLayout = () => {
  const [isMobile, setIsMobile] = useState(window.innerWidth < BREAKPOINTS.md);
  
  useEffect(() => {
    const handleResize = () => setIsMobile(window.innerWidth < BREAKPOINTS.md);
    window.addEventListener('resize', handleResize);
    return () => window.removeEventListener('resize', handleResize);
  }, []);
  
  return { isMobile };
};

// File Upload Validation
const validateFileSize = (file: File) => {
  return file.size <= FILE_SIZE_LIMIT.image;
};
```

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

### User Registration and Completion Filter Hooks

Source: https://context7.com/themeum/tutor/llms.txt

Filters for validating registration fields and controlling course/lesson completion logic.

```php
<?php
// Modify student registration required fields
add_filter('tutor_student_registration_required_fields', function($fields) {
    $fields['phone'] = __('Phone number is required', 'tutor');
    return $fields;
});

// Modify instructor registration required fields
add_filter('tutor_instructor_registration_required_fields', function($fields) {
    $fields['qualification'] = __('Qualification is required', 'tutor');
    return $fields;
});

// Validate lesson completion
add_filter('tutor_validate_lesson_complete', function($validated, $user_id, $lesson_id) {
    // Add custom validation logic
    $video_watched = get_user_meta($user_id, "_video_watched_{$lesson_id}", true);
    return $validated && $video_watched;
}, 10, 3);

// Control course completion
add_filter('tutor_user_can_complete_course', function($can_complete, $user_id, $course_id) {
    // Add prerequisite check
    return $can_complete;
}, 10, 3);
```

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

### Add PHPCS to PATH

Source: https://github.com/themeum/tutor/blob/master/readme.md

Add the composer vendor bin directory to your system PATH if commands are not found.

```bash
export PATH="/Users/your_username/.composer/vendor/bin:$PATH"
```

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

### Manage Lessons via AJAX

Source: https://context7.com/themeum/tutor/llms.txt

Endpoints for saving, deleting, and rendering lesson content within the course player.

```javascript
// Save lesson
// Action: wp_ajax_tutor_save_lesson
jQuery.ajax({
    url: ajaxurl,
    type: 'POST',
    data: {
        action: 'tutor_save_lesson',
        _wpnonce: _tutorobject.nonce,
        topic_id: 456,
        lesson_id: 0, // 0 for new lesson
        title: 'Lesson Title',
        description: 'Lesson content...'
    }
});

// Delete lesson
// Action: wp_ajax_tutor_delete_lesson
jQuery.ajax({
    url: ajaxurl,
    type: 'POST',
    data: {
        action: 'tutor_delete_lesson',
        _wpnonce: _tutorobject.nonce,
        lesson_id: 789
    }
});

// Render lesson content (for course player)
// Action: wp_ajax_tutor_render_lesson_content
jQuery.ajax({
    url: ajaxurl,
    type: 'POST',
    data: {
        action: 'tutor_render_lesson_content',
        _wpnonce: _tutorobject.nonce,
        lesson_id: 789
    },
    success: function(response) {
        $('#lesson-content').html(response.data.html);
    }
});
```

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

### Display Registration Forms Shortcodes

Source: https://context7.com/themeum/tutor/llms.txt

Use `[tutor_student_registration_form]` to display the student registration form and `[tutor_instructor_registration_form]` for the instructor registration form.

```shortcode
[tutor_student_registration_form]
```

```shortcode
[tutor_instructor_registration_form]
```

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

### Tutor Enrollment Hooks

Source: https://context7.com/themeum/tutor/llms.txt

These actions manage the enrollment process. Use `tutor_before_enroll` for validation, `tutor_after_enrolled` for post-enrollment actions like sending emails, and `tutor_enrollment_cancelled` for handling cancellations.

```php
<?php
// Before enrollment
add_action('tutor_before_enroll', function($course_id, $user_id) {
    // Validate enrollment requirements
}, 10, 2);

// After successful enrollment
add_action('tutor_after_enrolled', function($course_id, $isEnrolled, $user_id) {
    // Send welcome email, grant access to resources
}, 10, 3);

// When enrollment is cancelled
add_action('tutor_enrollment_cancelled', function($enrol_id) {
    // Revoke access, update stats
});
```

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

### Display Courses with Shortcodes

Source: https://context7.com/themeum/tutor/llms.txt

Use the `[tutor_course]` shortcode to display courses on your WordPress site. Options include pagination, filtering by category, excluding/including specific courses, and custom ordering.

```shortcode
[tutor_course]
```

```shortcode
[tutor_course count="12" column_per_row="3" course_filter="on" show_pagination="on"]
```

```shortcode
[tutor_course category="web-development,design" count="6"]
```

```shortcode
[tutor_course exclude_ids="123,456,789"]
```

```shortcode
[tutor_course id="100,101,102"]
```

```shortcode
[tutor_course orderby="date" order="DESC" count="8"]
```

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

### Enroll User in a Course

Source: https://context7.com/themeum/tutor/llms.txt

Enroll a user into a course. Returns the enrollment ID on success.

```php
<?php
// Enroll a user in a course
$enroll_id = tutor_utils()->do_enroll($course_id, $order_id = 0, $user_id);
if ($enroll_id) {
    echo 'Successfully enrolled!';
}
```

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

### Display E-commerce Pages Shortcodes

Source: https://context7.com/themeum/tutor/llms.txt

Use `[tutor_cart]` to display the shopping cart page and `[tutor_checkout]` to display the checkout page. These are used for Tutor's native monetization features.

```shortcode
[tutor_cart]
```

```shortcode
[tutor_checkout]
```

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

### Tutor Course Lifecycle Hooks

Source: https://context7.com/themeum/tutor/llms.txt

These actions hook into the course creation and saving process. Use them to initialize settings, process custom data, or perform actions after a course is saved.

```php
<?php
// After course is created (draft)
add_action('tutor_draft_course_created', function($course_id) {
    // Initialize default course settings
    update_post_meta($course_id, '_custom_setting', 'value');
});

// When course is saved
add_action('tutor_save_course', function($course_id, $post) {
    // Process custom course data
}, 10, 2);

// After course save completes
add_action('tutor_save_course_after', function($course_id, $post) {
    // Clear caches, send notifications, etc.
}, 10, 2);

// When course is started by student
add_action('tutor/course/started', function($course_id) {
    // Log course start, trigger notifications
});

// When student completes the course
add_action('tutor_course_completed_after', function($course_id, $user_id) {
    // Generate certificate, send email, award badges
}, 10, 2);
```

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

### Check if Course is Purchasable

Source: https://context7.com/themeum/tutor/llms.txt

Determine if a course can be purchased.

```php
<?php
// Check if course is purchasable
$is_purchasable = tutor_utils()->is_course_purchasable($course_id);
```

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

### Get Course ID by Content Type

Source: https://context7.com/themeum/tutor/llms.txt

Retrieve the course ID associated with various content types like lessons, quizzes, or topics.

```php
<?php
// Get course ID from various content types (lesson, quiz, etc.)
$course_id = tutor_utils()->get_course_id_by('lesson', $lesson_id);
$course_id = tutor_utils()->get_course_id_by('quiz', $quiz_id);
$course_id = tutor_utils()->get_course_id_by('topic', $topic_id);
```

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

### Display Instructor List Shortcodes

Source: https://context7.com/themeum/tutor/llms.txt

Use the `[tutor_instructor_list]` shortcode to display a grid of instructors. You can enable filtering, customize the layout, and set the number of instructors to show. Available layouts include 'default', 'cover', 'minimal', 'portrait-horizontal', and 'minimal-horizontal'.

```shortcode
[tutor_instructor_list]
```

```shortcode
[tutor_instructor_list filter="on" layout="cover" column_per_row="4" count="12"]
```

```shortcode
[tutor_instructor_list layout="minimal" category_limit="10" hide_empty_category="1"]
```

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

### Tutor Utility Functions (PHP)

Source: https://context7.com/themeum/tutor/llms.txt

Provides a collection of PHP utility functions for managing courses, enrollments, users, and quizzes within the Tutor LMS plugin.

```APIDOC
## PHP Utility Functions (tutor_utils())

### Get Course Information

Utility functions for retrieving course-related data.

```php
<?php
// Get course ID from various content types (lesson, quiz, etc.)
$course_id = tutor_utils()->get_course_id_by('lesson', $lesson_id);
$course_id = tutor_utils()->get_course_id_by('quiz', $quiz_id);
$course_id = tutor_utils()->get_course_id_by('topic', $topic_id);

// Check if user is enrolled in a course
$is_enrolled = tutor_utils()->is_enrolled($course_id, $user_id);
if ($is_enrolled) {
    echo 'User has access to this course';
}

// Get course rating information
$rating = tutor_utils()->get_course_rating($course_id);
echo "Average Rating: " . $rating->rating_avg;
echo "Total Reviews: " . $rating->rating_count;

// Check if course is purchasable
$is_purchasable = tutor_utils()->is_course_purchasable($course_id);

// Get course price
$price = tutor_utils()->get_raw_course_price($course_id);
echo "Regular Price: " . $price->regular_price;
echo "Sale Price: " . $price->sale_price;

// Get course topics
$topics = tutor_utils()->get_topics($course_id);
while ($topics->have_posts()) {
    $topics->the_post();
    echo get_the_title();
}

// Get course content by topic
$contents = tutor_utils()->get_course_contents_by_topic($topic_id, -1);

// Get course duration
$duration = tutor_utils()->get_course_duration($course_id, false);
?>
```

### Enrollment Management

Functions for managing student enrollments.

```php
<?php
// Enroll a user in a course
$enroll_id = tutor_utils()->do_enroll($course_id, $order_id = 0, $user_id);
if ($enroll_id) {
    echo 'Successfully enrolled!';
}

// Cancel enrollment
tutor_utils()->cancel_course_enrol($course_id, $user_id);

// Count enrolled students
$enrolled_count = tutor_utils()->count_enrolled_users_by_course($course_id);

// Check if course is fully booked (member limit reached)
$is_full = tutor_utils()->is_course_fully_booked($course_id);

// Get enrolled courses for a user
$courses = tutor_utils()->get_enrolled_courses_by_user($user_id);
?>
```

### User and Instructor Functions

Functions for managing users and instructors.

```php
<?php
// Check if user is an instructor
$is_instructor = tutor_utils()->is_instructor($user_id);

// Check if user is instructor of specific course
$is_course_instructor = tutor_utils()->is_instructor_of_this_course($user_id, $course_id);

// Get instructor list with pagination
$instructors = tutor_utils()->get_instructors(
    $offset = 0,
    $limit = 10,
    $search_term = '',
    $course_id = '',
    $date = '',
    $order = 'ASC',
    $status = 'approved'
);

// Get user profile URL
$profile_url = tutor_utils()->profile_url($user_id, $instructor_view = true);

// Get dashboard URL
$dashboard_url = tutor_utils()->tutor_dashboard_url();
$my_courses_url = tutor_utils()->tutor_dashboard_url('my-courses');

// Get user data with tutor-specific fields
$tutor_user = tutor_utils()->get_tutor_user($user_id);
echo $tutor_user->display_name;
echo $tutor_user->tutor_profile_photo_url;
?>
```

### Quiz Functions

Functions for quiz management and attempts.

```php
<?php
// Get quiz option/setting
$time_limit = tutor_utils()->get_quiz_option($quiz_id, 'time_limit.time_value');
$passing_grade = tutor_utils()->get_quiz_option($quiz_id, 'passing_grade', 0);

// Check if quiz is started
$attempt = tutor_utils()->is_started_quiz($quiz_id);

// Get quiz attempt details
$attempt = tutor_utils()->get_attempt($attempt_id);

// Get questions by quiz
$questions = tutor_utils()->get_questions_by_quiz($quiz_id);

// Calculate completion stats
$completed = tutor_utils()->get_completed_lesson_count_by_course($course_id);
$total = tutor_utils()->get_lesson_count_by_course($course_id);
$progress = ($completed / $total) * 100;
?>
```
```

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

### Run Cypress Tests

Source: https://github.com/themeum/tutor/blob/master/readme.md

Commands for executing Cypress tests in various modes.

```bash
npm run cy:open
```

```bash
npm run test
```

```bash
npx cypress run --spec "cypress/e2e/backend/**/*.cy.ts"
```

```bash
npx cypress run --browser chrome
```

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

### Instructor Management Action Hooks

Source: https://context7.com/themeum/tutor/llms.txt

Hooks for handling instructor registration, approval, and blocking events.

```php
<?php
// After new instructor registration
add_action('tutor_new_instructor_after', function($user_id) {
    // Send welcome email, notify admin for review
});

// After instructor is approved
add_action('tutor_after_approved_instructor', function($instructor_id) {
    // Grant permissions, send approval email
});

// After instructor is blocked
add_action('tutor_after_blocked_instructor', function($instructor_id) {
    // Revoke permissions, hide courses
});

// After instructor signup (registration complete)
add_action('tutor_after_instructor_signup', function($user_id) {
    // Set default instructor settings
});
```

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

### Course Builder AJAX Endpoints

Source: https://context7.com/themeum/tutor/llms.txt

Server-side actions and client-side AJAX requests for managing course drafts and updates.

```php
<?php
// Create new draft course
add_action('wp_ajax_tutor_create_new_draft_course', function() {
    // Handler in Course class
});
```

```javascript
// Get course list for builder
// Action: wp_ajax_tutor_course_list
jQuery.ajax({
    url: ajaxurl,
    type: 'POST',
    data: {
        action: 'tutor_course_list',
        _wpnonce: _tutorobject.nonce,
        limit: 10,
        offset: 0,
        filter: JSON.stringify({search: 'keyword'})
    },
    success: function(response) {
        console.log(response.data.results);
    }
});
```

```javascript
// Update course
// Action: wp_ajax_tutor_update_course
jQuery.ajax({
    url: ajaxurl,
    type: 'POST',
    data: {
        action: 'tutor_update_course',
        _wpnonce: _tutorobject.nonce,
        course_id: 123,
        post_title: 'Updated Course Title',
        post_content: 'Course description...',
        post_status: 'publish',
        course_level: 'intermediate',
        pricing: {
            type: 'paid',
            product_id: 456
        }
    }
});
```

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

### Check User Enrollment in a Course

Source: https://context7.com/themeum/tutor/llms.txt

Verify if a specific user is enrolled in a given course.

```php
<?php
// Check if user is enrolled in a course
$is_enrolled = tutor_utils()->is_enrolled($course_id, $user_id);
if ($is_enrolled) {
    echo 'User has access to this course';
}
```

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

### Lesson Lifecycle Action Hooks

Source: https://context7.com/themeum/tutor/llms.txt

Hooks triggered during the creation, update, and completion of lessons.

```php
<?php
// When lesson is created
add_action('tutor/lesson/created', function($lesson_id) {
    // Set default lesson settings
});

// Before lesson update
add_action('tutor/lesson_update/before', function($lesson_id) {
    // Backup previous content
});

// After lesson update
add_action('tutor/lesson_update/after', function($lesson_id) {
    // Clear cache, notify enrolled students
});

// Before lesson is marked complete
add_action('tutor_lesson_completed_before', function($lesson_id) {
    // Validate completion requirements
});

// After lesson completion
add_action('tutor_lesson_completed_after', function($lesson_id, $user_id) {
    // Update progress, check for topic completion
}, 10, 2);
```

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

### Optimize Bundle Size with Tree-shakeable Imports

Source: https://github.com/themeum/tutor/blob/master/stories/Docs/GettingStarted.mdx

Prefer specific named imports over namespace imports to allow bundlers to remove unused code.

```tsx
// ✅ Tree-shakeable imports
import { colorTokens } from '@TutorShared/config/styles';
import { typography } from '@TutorShared/config/typography';

// ❌ Avoid entire module imports
import * as TutorConfig from '@TutorShared/config';
```

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

### Quiz Configuration and Data Filter Hooks

Source: https://context7.com/themeum/tutor/llms.txt

Filters for adjusting quiz settings, answer data, and total marks calculation.

```php
<?php
// Modify default quiz settings
add_filter('tutor_quiz_default_settings', function($settings) {
    $settings['passing_grade'] = 70;
    $settings['attempts_allowed'] = 3;
    return $settings;
});

// Filter quiz answer data before saving
add_filter('tutor_filter_quiz_answer_data', function($answers_data, $question_id, $question_type, $user_id, $attempt_id) {
    // Modify answer data
    return $answers_data;
}, 10, 5);

// Modify total marks calculation
add_filter('tutor_filter_quiz_total_marks', function($total_marks, $question_id, $question_type, $user_id, $attempt_id) {
    // Apply bonus or penalty
    return $total_marks;
}, 10, 5);
```

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

### User and Validation Filters

Source: https://context7.com/themeum/tutor/llms.txt

Filters for customizing user registration fields and validation logic for lesson and course completion.

```APIDOC
## User and Validation Filters

### Description
These filters allow you to modify required fields for student and instructor registration, and to implement custom validation for lesson and course completion.

### Filters
- **tutor_student_registration_required_fields**: Filters the array of required fields for student registration.
- **tutor_instructor_registration_required_fields**: Filters the array of required fields for instructor registration.
- **tutor_validate_lesson_complete**: Filters the validation result for lesson completion, allowing custom checks.
- **tutor_user_can_complete_course**: Filters whether a user can complete a course, enabling prerequisite checks.

### Example Usage (PHP)
```php
<?php
add_filter('tutor_student_registration_required_fields', function($fields) {
    $fields['phone'] = __('Phone number is required', 'tutor');
    return $fields;
});

add_filter('tutor_validate_lesson_complete', function($validated, $user_id, $lesson_id) {
    // Add custom validation logic
    $video_watched = get_user_meta($user_id, "_video_watched_{$lesson_id}", true);
    return $validated && $video_watched;
}, 10, 3);
?>
```
```

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

### Build Advanced Course Form

Source: https://github.com/themeum/tutor/blob/master/stories/Docs/GettingStarted.mdx

A form implementation using react-hook-form for state management. Use the Controller component for integrating custom inputs.

```tsx
import { css } from '@emotion/react';
import { spacing, colorTokens } from '@TutorShared/config/styles';
import { typography } from '@TutorShared/config/typography';
import { useForm, Controller } from 'react-hook-form';

interface CourseFormData {
  title: string;
  description: string;
  category: string;
  level: 'beginner' | 'intermediate' | 'advanced';
  price: number;
  published: boolean;
}

const CourseForm: React.FC = () => {
  const { control, handleSubmit, formState } = useForm<CourseFormData>();
  
  const handleFormSubmit = (data: CourseFormData) => {
    console.log('Course data:', data);
  };
  
  return (
    <form 
      onSubmit={handleSubmit(handleFormSubmit)}
      aria-label="Create Course Form"
      noValidate
    >
      {/* Form implementation with Controller components */}
    </form>
  );
};
```

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

### Lesson AJAX Endpoints

Source: https://context7.com/themeum/tutor/llms.txt

Endpoints for managing lesson data.

```APIDOC
## POST /wp-admin/admin-ajax.php (tutor_save_lesson)

### Description
Saves a new or existing lesson.

### Method
POST

### Endpoint
/wp-admin/admin-ajax.php

### Parameters
#### Request Body
- **action** (string) - Required - Must be 'tutor_save_lesson'
- **_wpnonce** (string) - Required - WordPress nonce for security
- **topic_id** (integer) - Required - The ID of the topic this lesson belongs to
- **lesson_id** (integer) - Optional - The ID of the lesson to update. Use 0 for a new lesson.
- **title** (string) - Required - The title of the lesson
- **description** (string) - Required - The content of the lesson

### Request Example
```json
{
  "action": "tutor_save_lesson",
  "_wpnonce": "your_nonce_here",
  "topic_id": 456,
  "lesson_id": 0,
  "title": "Lesson Title",
  "description": "Lesson content..."
}
```

## POST /wp-admin/admin-ajax.php (tutor_delete_lesson)

### Description
Deletes a lesson.

### Method
POST

### Endpoint
/wp-admin/admin-ajax.php

### Parameters
#### Request Body
- **action** (string) - Required - Must be 'tutor_delete_lesson'
- **_wpnonce** (string) - Required - WordPress nonce for security
- **lesson_id** (integer) - Required - The ID of the lesson to delete

### Request Example
```json
{
  "action": "tutor_delete_lesson",
  "_wpnonce": "your_nonce_here",
  "lesson_id": 789
}
```

## POST /wp-admin/admin-ajax.php (tutor_render_lesson_content)

### Description
Renders the content of a lesson, typically for display in the course player.

### Method
POST

### Endpoint
/wp-admin/admin-ajax.php

### Parameters
#### Request Body
- **action** (string) - Required - Must be 'tutor_render_lesson_content'
- **_wpnonce** (string) - Required - WordPress nonce for security
- **lesson_id** (integer) - Required - The ID of the lesson to render

### Request Example
```json
{
  "action": "tutor_render_lesson_content",
  "_wpnonce": "your_nonce_here",
  "lesson_id": 789
}
```

### Response
#### Success Response (200)
- **data.html** (string) - The HTML content of the lesson
```

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

### Component Styling with Design Tokens

Source: https://github.com/themeum/tutor/blob/master/stories/Docs/GettingStarted.mdx

Apply styles using design tokens for background, borders, spacing, and shadows. Ensure consistency and ease of global design changes.

```typescript
import { 
  colorTokens, 
  spacing, 
  borderRadius, 
  shadow,
} from '@TutorShared/config/styles';
import { typography } from '@TutorShared/config/typography';

// Component Styling with Tokens
const cardStyles = css`
  background: ${colorTokens.background.white};
  border: 1px solid ${colorTokens.stroke.default};
  border-radius: ${borderRadius[12]};
  box-shadow: ${shadow[2]};
  padding: ${spacing[24]};
  
  &:hover {
    border-color: ${colorTokens.stroke.hover};
    box-shadow: ${shadow[4]};
    transform: translateY(-2px);
    transition: all 0.2s ease;
  }
`;

// Theme-aware Color Usage
const getStatusColor = (status: 'success' | 'warning' | 'error') => {
  const statusColors = {
    success: colorTokens.status.success,
    warning: colorTokens.status.warning,
    error: colorTokens.status.error
  };
  return statusColors[status];
};
```