- Getting Started
- Installation of the theme
- Activate the theme and Import the demo content
- Setting up the Homepage
- Theme Features
- Theme Options
- Adding the Images to Revolution slider
- LMS Settings
- Quizzes and Questions
- Paid Memberships PRO
- MasterStudy PRO Addons
- Udemy Courses
- Online Testing
- Statistics & Payouts
- Setting up Content pages and posts
- Blog page
- Woocommerce Courses (not LMS)
- WooCommerce shop
- Update the theme
- Actions & Hooks
Masterstudy - Education WordPress Theme Documentation
A short guide and general information to help you get to know your new theme.
Above all, We would like to thank you for purchasing this theme, your contribution is very much appreciated.
This document covers the installation and use of this theme and reveals answers to common problems and issues - We encourage you to read this document thoroughly if you are experiencing any difficulties. If you have any questions that are beyond the scope of this document, feel free to pose them in the dedicated support forum.
Installation of the theme
Installation of the themeTo install this theme you must have a working version of WordPress already installed. For information regarding the installing of the WordPress platform, please see the WordPress Codex - http://codex.wordpress.org/Installing_WordPress
InstallationWhen you are ready to install a theme, you must first upload the theme files and then activate the theme itself. The theme files can be uploaded in two ways: FTP Upload - Using your FTP client, upload the non-zipped theme folder into the /wp-content/themes/ folder on your server WordPress Upload - Navigate to Appearance -> Add New Themes -> Upload. Go to browse, and select the zipped theme folder. Hit “Install Now” and the theme will be uploaded and installed.
2. WooCommerce (for online shop)
3. Revolution Slider
4. Contact Form 7
5. Breadcrumb NavXT
Activate the theme and Import the demo content
Activate the theme and Import the demo contentAfter completing installation of the theme, you need to activate your product under Masterstudy -> Product registration following these instructions:
2. Enter a name for your token, then check the boxes for View Your Envato Account Username, Download Your Purchased Items, Verify Purchases You've Made and List Purchases You've Made from the permissions needed section. Check the box to agree to the terms and conditions, then click the Create Token button.
3. A new page will load with a token number in a box. Copy the token number then come back to this registration page and paste it into the field below and click the Submit button.
4. You will see a green check mark for success, or a failure message if something went wrong. If it failed, please make sure you followed the steps above correctly.
What if the Import fails or stalls?If the import stalls and fails to respond after a few minutes You are suffering from PHP configuration limits that are set too low to complete the process. You should contact your hosting provider and ask them to increase those limits to a minimum as follows:
- max_execution_time 600
- memory_limit 128M
- post_max_size 32M
- upload_max_filesize 32M
Setting up the Homepage
Setting up the HomepageTo set up the homepage you must create a new page, you can do so by navigating to Pages > Add New. The title for this page can be up to your liking. Under Settings > Reading please setup the new Homepage. Actually you can set any page to be your homepage. Once it’s created you can compose your homepage layout. The design layout is created under Bootstrap framework which is split into 12 columns grid. Each widget has its own maximum and minimum widths, so depending on that you can work out the layout for each page. As you can see the homepage just like any the page is now 100% constructible out of the modules we have in Visual Composer. The homepage can be created by any element in Visual Composer. To view the short manual on how to use the Visual Composer, please follow this link:
http://codecanyon.net/item/visual-composer-page-builder-for-wordpress/full_screen_preview/242431 The detailed documentation of Visual Composer can be found in main ZIP archive under ‘manual’ folder.
Theme OptionsWordPress Customize allows you to regulate the general settings of the website. In WordPress menu go to Appearance > Customize Site title & tagline: That’s pretty obvious, you can name your site here. Navigation: You can choose the menu to display in the top from precreated sets in wp-menu Widgets: You can set up the widgets into the precreated areas. You can do the same later Appearance > Widgets Static Front Page: Choose the Homepage and the Blog from the list of created Pages to assign their functions. You can do the same later under Settings > Reading Redux Framework: For additional theme settings we use Redux framework. So all general settings can be setup after clicking on Theme Options in WordPress Panel: Using Redux framework you can easily change:
- Header area
- Setup sidebars for Custom Post types
- Social media profiles
- Mailchimp subscription
- Footer area
- Demo Content upload
How to set up the sidebar
How to set up the sidebarIn this theme we paid special attention to Sidebars for your biggest convenience and on multiple previous requests. We have two types of sidebar: shop sidebar and blog sidebar, either of them can be positioned on the left or on the right based on your selection in the Customize section. Now how it works. There are default sidebars set up as usual under Appearance - > Widgets as well. That’s how it is going to look by default. In addition to that, you can add any element you want for a specific page, in this case you will need to go here: Edit or create a new sidebar, and add any sections you need by means of VisualComposer Shop sidebar is a little more complicated. If you need to add only woocommerce widgets – you can use the Appearance -> Widgets to set it up. If you need any VC elements in addition to that – you can edit shop sidebar under Sidebars above or below the Widgetsized sidebar element.
Adding Images to Revolution slider
Adding Images to Revolution sliderYou will need to upload various images to the Revolution slider. You can add items from Revolution Slider plugin in the WordPress backend. When you go there first you need to create the new Slider, and add new slides. More detailed manual you can find in the downloaded Manual folder “Revolution Slider”.
MenusThere is only one navigation on the site – in the top, so you can adjust it under Appearance - > Menus This is standard Wordpress functionality, you can choose from the pages, post categories, or custom links.
LMS SettingsMasterstudy LMS – Learning Management System PRO plugin includes all features for making your website LMS Portal. After installing one of the LMS Demo Layouts, you will be able to see LMS demo content on your site. LMS Settings have the functions as seen on the screen below. These functions include General, Courses, Course, Routes,Payment Methods, Google API, Profiles, Certificates, Addons, Payout, GDPR.
GeneralIn General, users can change the main and secondary colors of the theme, set the currency that will be displayed on the screen and the position of the “Currency symbol”. Further, you can choose what symbol you want to use to separate integer and fractional numbers with the “Thousands Separator”. Moreover, you can enable the WooCommerce checkout and when the customers would click to buy/purchase it will direct them to the Woocommerce’s checkout page. Next, you can set the Author Fee as you wish. For instance, you can set “Author Fee” as 10% or another percent that you would like to set. When the authors will post the course and the visitor will buy that course, you will get 10% of the course price. In addition, there is a “Number of free featured” function; you can set how many courses will be shown as a featured product.
CoursesIn Course, the “Courses Page Style” has three styles “Default”, “Classic” and “Udemy”. Moreover, you enable the function “Redirect to Checkout after adding to Cart”.
RoutesIn Routes, you can set the URL of your webpage. Write your URL in the corresponding field. Then open Settings -> Permalinks and click Save Changes.
Payment MethodsYou can set up also your Payment Methods under STM LMS settings:
Google APIIn Google API, you should insert here your Google ReCaptcha API. You can find information on how to get Google ReCaptcha Key at https://www.google.com/recaptcha/ and on the screen below, there is an example on how to correctly fill the page.
ProfilesIn Profiles, when you click the “Instructors Archive Page”, there will be a drop-down list. You can choose from the drop-down list a page where the Instructors Page will be displayed. Further, you can choose the style from “Profile Page Style”. Next, you can switch on the function “Enable Course Pre-moderation”.
CertificatesCertificates allow you to add the certificates that you possess to the website. You will be able to add your certificate as a picture. Further, you will be able to add title, subtitle, description to describe your certificate. Moreover, you will be able to change the colors and font size of the title, subtitle, and text of the certificate description.
Course CategoryTo set the course category settings click STM MLS -> Course Category. When you open the Course Category, you will see “Add New Course Category”. There, you can set the Name of the Category. In “Slug” you will add the URL to the new category. Further, you can choose the “Parent Course category” from the drop-down list. In the “Description” you will be able to describe a category. Moreover, you will be able to add the image, icon, and color to your category. Adding the image, icon, and color will allow you to have an accurate list of categories displayed on your web page. First, add colors, image, and icons. Second, add the STM LMS Course Categories element to your page to display your course categories in different styles. Pictures below illustrate an example of how your categories will look.
Quizzes and QuestionsFirst, you have to set the question. Second, choose the type of questions that you would like to use in your quiz. There are several types of questions, namely “Single choice”, “Multi choice”, “True or False”, “Item Match”, “Keywords”, “Fill the Gap”.
Matching questionsOn the matching questions, the users will set the questions and the correct answers. Students will solve the quiz by matching the question and correct answer.
CoursesLMS Courses can be found under STM LMS > Courses menu. Single Course have its own content which can be built via VC Page Builder, Featured Image, Categories and Course Settings. Besides this, you can add new Lesson and Quiz or include existing Lessons and Quizzes:
LessonsSTM LMS > Lessons menu includes your Lessons list. You can add your Course content wither with VC Page Builder or WP Classic Editor. Also, Lesson settings section allows you to choose:
• Lesson duration: any text;
• Lesson Preview: Makes the Lesson open/private for visitors;
• Lesson Frontend description: Description of the Lesson;
Quizzes and Questions
Quizzes and QuestionsQuiz can be created via STM LMS > Quizzes menu. Each Quiz may include unlimited Questions. You can add either existing questions to your Quiz or create new one via Add new question field. Quiz settings includes:
• Quiz duration: duration in minutes/hours/days;
• Show correct answer: displays correct answer at the end of the Quiz;
• Passing grade: Minimum percentage of correct answers for passing the quiz;
• Points total cut after re-take: Quiz re-take cut percentage;
ReviewsUsers can leave reviews for Courses and you can see all reviews under STM LMS > Reviews menu:
OrdersYou can check orders through STM LMS > Orders: Admin can see the order details and change its status from Pending to Complete or Canceled:
Paid Memberships PRO
Paid Memberships PROMasterstudy LMS plugin supports Paid Memberships plugin and smoothly works together for creating Membership System with Subscription Plans on your website. This third-party plugin allows you to create Membership Levels (Plans). In order to create Membership Plans, got to Dashboard > Memberships > Add New Level. Here you can set up Plan options and number of available courses in subscription under STM LMS Settings: Payment Gateway also should be set up separately for Membership plans:
Integration with BuddyPress Plugin
Integration with BuddyPress PluginRecently, our developers integrated the MasterStudy with BuddyPress plugin to expand the opportunities of the theme. BuddyPress gives an opportunity for the students and teachers to create a community. Further, BuddyPress has incredible features as Course Groups, Activity Feeds, Course messaging and Advanced Profiles. Next, BuddyPress allows students and teachers to socialize as they can add friends, have group chats or private messages. The BuddyPress will be as Facebook, but only for the MasterStudy students. Students and teachers will have their own profiles and manage others by sending messages and chatting. Group chats will allow sharing the knowledge or experience with other students who are struggling with a specific topic or question. The BuddyPress in integration with MasterStudy will provide tremendous opportunities, as the students will not only study but also make a network. It will engage other potential customers as well because people will share their experience through word of mouth. As a consequence, your business will have more potential to be recognized and to be expanded. 1. To Install and Activate BuddyPress, navigate to Plugins and select Add New. 2. On the right top, there is a search field, write there BuddyPress and when the search finds it enter Install Now. 3. After Installation, you should Activate the plugin as shown on the screen below.
MasterStudy PRO Addons
Udemy Courses Importer
Udemy Courses ImporterDo you want to import courses from Udemy and display on your website? You can enable the Udemy Course Importer addon in the STM LMS ▸ LMS Settings ▸ Addons section of the WordPress dashboard menu. You need to click on the "Enable Addon" and a gear icon appears over the image of the addon where you can set up Udemy Settings and import courses. In the Credentials tab of the STM LMS Udemy Settings section, you need to add your client ID, Secret API keys, and Udemy Rakuten Affiliate script.
Udemy API ClientYou need to click on the Udemy API link in order to get your Udemy credentials. When your API Client request is approved, API credentials will be available in the API Clients section.
Import and manage Udemy coursesAfter adding Udemy API credentials, you will be able to search and import Udemy courses in Search tab. Imported Courses tab contains options for managing your imported courses. Your customers will be able to get published courses on Udemy from your website.
Import and manage Udemy coursesFor the Udemy Rakuten Affiliate script, you need to register on Rakuten Marketing website and generate unique Rakuten Automate script. Here you can read more about Rakuten Automate tool - https://blog.rakutenmarketing.com/news/attention-publishers-announcing-automate-new-deep-linking-tool/ .
Masterstudy PrerequisitesYou can enable the Prerequisites addon in the STM LMS ▸ LMS Settings ▸ Addons section of the WordPress dashboard menu. After, you need to edit a needed course and set up prerequisites’ settings of a course in the Course Prerequisites section. In the Course Prerequisites section, you can add courses which should be completed before purchasing this course.
Online TestingOnline Testing Addons allows pasting any quizzes through the shortcode to any page. You can enable the Online Testing addon in the STM LMS ▸ LMS Settings ▸ Addons section of the WordPress dashboard menu. After that, go to the Quizzes page and add a new Quiz.
Create quiz and insert shortcode with quiz id on a page. Shortcode:
Create quiz and insert shortcode with quiz id on a page. Shortcode:
Statistics & Payouts
Statistics & PayoutsThis add-on allows you to manage all payments and track affiliated statistics for the sold courses, such as Total Profit, Total Payments, get statistics for a specific period, and etc. Also, you can proceed payments for course authors manually or automatically. You can enable the Statistics & Payouts addon in the STM LMS ▸ LMS Settings ▸ Addons section of the WordPress dashboard menu.
Statistics for the Course authorsCourse authors can track sales and earning statistics from the Account page (Statistics tab) and for receiving Payout earning user should enter the PayPal account email address.
Statistics and Payouts for website ownerWebsite administrators can see statistics of users purchase histories, course authors earnings and proceed payments for course authors Statistics are located under the STM LMS menu area in the dashboard.
Statistics and Payouts for website ownerWebsite owner can use the PayPal payment for automated payouts and it can be enabled from the STM LMS settings ▸ Payout tab and click to the Gear icon to configure PayPal settings In the PayPal payout settings, you need to fill up the needed fields by creating a new Application from the PayPal developers page. You need to get Client ID and Secret key to add it to the PayPal settings. Also, you need to add a webhook by adding the web hook URL like below:
Adding a Cron Job for PayoutsIn order to automate Payouts, you can use Cron Jobs on your server/site. First, you need to edit the wp-config.php file and paste the following line of code anywhere above the line that says "That’s all, stop editing! Happy blogging":
Cron At 00:00 on day-of-month 1.
0 0 1 * * wget -O /dev/null https://yoursite.com/wp-cron.php?doing_wp_cron
cPanel - https://www.youtube.com/watch?v=YwpUjz1tMbA
Vesta CP - https://www.plothost.com/kb/create-delete-cron-jobs-vesta/
Kinsta Hosting - https://kinsta.com/knowledgebase/how-to-write-a-cron-job/
Setting up Content Pages and Posts
Setting up Content Pages and PostsAll pages can be created as simple content pages or built by means of Visual Composer page builder. You will need to first set up the page and then add and set up content blocks. Just add a row and add the modules to row from the Visual Composer dashboard. Now you can choose how to compose your template. Add Content modules, Testimonials, etc. You have everything to realize your imagination. We have also included extension packages for Visual Composer. You can use them free. Just pick the module you like and add it to the row. Then you can edit it. You can also edit the row background, add video or parallax images to the background. Just click on Row edit icon and you will see the options & features, which are available for this row. Custom added shortcodes in our theme are on a separate tab: Besides this, each page contains these options which include header color or background image, title fonts and colors, breadcrumbs and button settings:
Blog pageThe Blog page is a usual blog, formed from the posts which belong to categories created by you, which have tags and featured images that show in the post listings on the blog page. The blog page can have the sidebar on the left, right or no sidebar, and the contents of the sidebar, as described above, are set under the Appearance > Widgets. Blogs can be posted by someone who has the access to the backend of the site with admin or author role. Anyway that person will be able to log into the WordPress panel and have a user profile. Default blog layout is grid layout and once you set up an empty page in the theme setting where it is said blog, it will show posts in grid layout.
GalleryGalleries are created as another custom post type called Projects. It has Categories that can be ordered as needed. Here you create just single gallery photo. All the content of Gallery page can be built by means of Visual Composer on the Gallery page. So basically, you create an individual post describing for each photo in your gallery. After that you go to the Pages > Add new On the new page you should insert Gallery Grid shortcode from Visual Composer. After that you can have an option go make your gallery view Masonry or Standard grid (by default):
EventsEvents are created as another custom post type called Gallery. You can see all your Events under Dashboard > Events menu on your Admin menu. It has Tags that can be ordered as needed. All the content of Event page can be built by means of Visual Composer. And there is a main Information section for the Event details: Also, there is All Participants section in order to see the list of the joined users:
Woocommerce Courses (not LMS)
Woocommerce Courses (not LMS)Default Masterstudy layout Courses are built on WooCommerce Products. To create a course you need to add a Product: For each course you can specify the Category, add Course name and Description. For the Description we use standard Content area with Visual Composer, where you can insert any shortcode you would like to display. Moreover, you can add the course image or image gallery: For the Content area – if you want to add a Course plan, Course sections or Course lessons overview, just insert the Course Lessons shortcode: After you insert it, you have the option to add a lesson into the Course section: After you add a Lesson, it has addional options: Once you complete the Course description, go to the Product Data to specify the Price: If it’s a Free course, you just put 0 for Regular Price. If you have limited seatings in classes, you should go to Inventory tab specify Stock Qty. After that you can specify the Course Details information and assign a Teacher of that Course.
WooCommerce shopWooCommerce is the most popular e-commerce plugin for WordPress. Now you can have a shop with all e-commerce features on WordPress. Before you start adding products, please go through the WooCommerce plugin settings and specify everything you need for your site. Go to WooCommerce > Settings > Products > Display Specify the Single Product Image and Thumbnails sizes: Adding the products: You can easily add new products via Products > Add Product Just specify all details with the description and shipping details. For a single product you can upload several photos in Product Gallery. More information about the WooCommerce features you can find here:
TestimonialsIn order that you could create testimonials in one place and then use all over the site, just inserting a VC element, we have created custom posts. Each testimonial is a simple post
Update the theme
Update the themeThere are 3 methods to update our wordpress themes to newer version. These new updates are essential if you want to have a bug free website as we give new features and improvements to the theme over time. Some of these updates might be needed in order to make the theme compatible with wordpress newer versions. There is no risk on losing your settings and pages. However if you have done modifications on core theme files, then they will be lost, so you should back up those files.
Update Through Wordpress Admin Panel (Envato Extension)It's possible to update the theme easily via Dashboard -> Updates, after entering correct API credentials via Theme Options -> One Click Update:
- Envato Username - your ThemeForest (or Envato) username (i.e. Stylemixthemes).
- Envato API Key - secret API key you have on ThemeForest. You can create a new one under the Settings > API Keys section of your profile.
Update Through Wordpress Admin Panel (using extra plugin)
- For this method you should first install Theme Upgrades Tool (http://wordpress.org/plugins/easy-theme-and-plugin-upgrades/)
- Unzip the file you just downloaded from ThemeForest and locate the WordPress Theme.
- Click on Appearance > Themes in your Dashboard. Still within the Themes section, on header tab, click on Add New, then on header second tab click Upload Theme.
- Click Browse… and locate the new theme file.
- In the Upgrade existing theme? Option choose Yes from the dropdown list.
- Click Install Now and Activate the theme.
Updating using a FTP software
- Login into your Themeforest account and go to downloads (Dashboard > Downloads)
- Download the theme into your computer
- Install an FTP program (Filezilla is free) Retrieve your FTP login information from your hosting admin panel and login into your hosting via FTP
- Unzip the item main file and locate theme archive file and unzip it. Make sure your unzipping software do not create extra directory with the same name nested into each other.
- Drag and drop theme main folder into your FTP program with the destination : YOUR_HOSTING_ROOT/YOUR_SUBDIRECTORY/wp-content/themes/
- FTP program will give a warning that there is an existing with the same directory name, choose replace all.
Actions & Hooks
Actions & HooksHere is a list of our Actions and Hooks for developers:
do_action('stm_lms_user_registered', $user_id);- Fires when user registered on site;
do_action('add_user_course', $user_id, $course_id);- Fires when course added to user;
do_action('stm_lms_lesson_passed', $user_id, $lesson_id);- Fires when user completed lesson;
do_action('stm_lms_quiz_' . $status, $user_id, $quiz_id, $progress);- Fires when quiz finished. Available $status - failed and passed;
do_action('stm_lms_assignment_' . $status, $student_id, $assignment_id);- Fires when user assignment was checked by Instructor. Available $status - passed and not_passed;
do_action('stm_lms_certificate_generated', $user_id, $course_id);- Fires when user downloading course certificate (Certificate couldn't be downloaded without minimum course progress);
do_action('stm_lms_progress_updated', $course_id, $user_id, $progress);- Fires when Course Progress changes