Getting started

First of all, we would like to thank you for purchasing our Plugin. If you have any questions that are beyond the scope of this help, please feel free to email us via our user page contact form here.

We'd be glad to help you if you have any questions related to this plugin. No guarantees, but we'll do our best to assist. If you have a more general question relating to our products you might consider visiting our support forum.


Quick-start guide

For the impatient, here’s how to get the plugin up and running in a second.

  1. Go to the WP admin › Plugins › Add New, upload snax.zip and activate it. Need more details?
  2. Under the WP admin › Settings › Snax › Pages, click the View button next to the Frontend Submission page.
  3. Choose what kind of story you want to create (eg. Create open list).
  4. Upload an image or paste embed URL, fill in the Title and accept the Terms and Conditions.
  5. Click the Publish button and voilà, you've just submitted your first post!

Installation

Please follow these simple steps to install the plugin and import the demo content in just few clicks.

  1. Go to the WP admin panel › Plugins
  2. Click the Add New button


  1. Click the Upload Plugin button
  2. Find the snax.zip file inside the package you've downloaded from CodeCanyon
  3. Upload it


  1. After few seconds the plugin will be installed.
  2. Click the Activate Plugin button



Basic workflow

Post vs. Submission

Snax workflow is based on two main concepts, Posts and Submissions. Before further reading, you should first get to know what they are and what's the main difference between them.

Posts - you can think of them as standard Wordpres posts. Besides plugin related options, they work in pretty much the same way.
Example: User creates new "Open List". Other users may contribute to it.

Submissions - children of a post. They are similar, in behaviour, to posts but cannot exist alone.
Example: User adds new "Submission" to an existing open list.

Add new post

Here's how the standard submission process, from post creation to final approval, works:

  1. User clicks the "+ Create" button.
  2. Choose one of available formats (e.g. Create open list).
  3. Upload images or add embeds.
  4. Fill required fields and submit a post for a review.
  5. Now, the submitted post is waiting for your approval in the review queue.
  6. At this stage, only you (as administrator) and post author (as owner) have access to it.
  7. Until you publish this post, it won't be publicly accessible for all other visitors.
  8. To allow direct publishing, please read the Users permissions section.

Add new submission

Here are steps involved in new contribution process:

  1. User visits one of the existing open lists.
  2. After all items, there's a new item form.
  3. User uploads an image or adds an embed.
  4. Fill required fields and submit an item for a review.
  5. Now, the submitted item is waiting for your approval in the review queue.
  6. At this stage, only you (as administrator) and item author (as owner) have access to this item.
  7. Until you publish this item, it won't be publicly accessible for all other visitors.
  8. To allow direct publishing, please read the Users permissions section.

Profile

Use the BuddyPress plugin

When you think about users, relations between them and entire community they are part of, most likely the first thing that come up to your mind is the BuddyPress plugin.

BuddyPress is the most popular Wordpress plugin for online communities, so the choice tends to be obvious.

What Snax has to do with BuddyPress?

We always try to give you possibility to best adapt our products to your site. The more compatible the product is with other well known Wordpress plugins the more options to combine them you have. If so, what can be more capable to adjust that the plugin with 200K+ community and almost 100 of plugins wrote just for it!

Snax is a way to get your community more involved. BuddyPress is a best choice for communities. Both create perfect combination. And that's why the Snax is fully integrated with the BuddyPress.

Snax + BuddyPress

Using BuddyPress as your Snax community partner, your users can use BuddyPress profiles to:

  • manage their posts
  • check status of posts that are still under review process
  • quickly access all submissions (items added to someone else open list)
  • check pending/rejected submissions
  • see all upvotes and downvotes
  • be notified about others actions (e.g. when your post was voted)
  • see all their activities (e.g. when you add a new item to someone else list)

Can I use Snax without BuddyPress?

Using BuddyPress it's not a requirement. You have still, as site owner, full access to all posts/submissions added by users using traditional Wordpress admin area. The only difference is that your users don't have profiles so until you accept their items, they can't see them, check their status etc.


Setup the BuddyPress plugin

Start with BuddyPress

If you are not already familar with the BuddyPress plugin, you probalby want to learn all about it before you start playing with the Snax. There are a lot of useful guides on the web but we recommend The Complete Guide to BuddyPress for WordPress.

Start with Snax

To start using Snax and BuddyPress you don't need to do any special configuration steps. Just install BuddyPress and Snax will do the rest. The order of plugin installation doesn't matter. You can have BuddyPress already installed or install it after Snax.

Turn on/off Snax components

By default, Snax enables all its components (Posts, Submissions, Votes). Of course it always depends on you, what components you want to use. To change default configuration, please do as follows:

  1. Go to the WP admin › Settings › BuddyPress.
  2. In the Components tab, you will find all Snax components (name with the "Snax" prefix).
  3. For example, if you don't like to use the Snax Submissions component, just uncheck it.

Do I need to use all other BuddyPress components?

No, you don't need to use any additional components delivered with the BuddyPress. BuddyPress requires two components: BuddyPress Core and Comunnity Members and that's all. All others are optional.


Social Login

Use the Wordpress Social Login plugin

With the WordPress Social Login plugin, you give your visitors an ability to login with social networks like Facebook, Twitter and more. No more old fashioned registration form and confirmation emails! No one wants to create a new account just to check what your site has to offer. Don't make this mistake and don't try to change users habits.

Snax + WP Social Login

Using WP Social Login as your Snax login/register service, your users DON'T NEED TO:

  • create a new account
  • fill out registration forms
  • wait for confirmation emails
  • remember another usernames and passwords

Can I use Snax without WP Social Login?

Yes, of course you can use the Snax without any 3rd party login plugins. But believe us, you don't want to do that. Nowadays, for most users creation of a new account seems hard to overcome. If user needs to register when he only wants to check how a site works, it will probaly quickly leave it. And that's the last thing you want.


Setup the Wordpress Social Login plugin

Social Login requires a little bit of effort on your part to have it up and running in your website. As a matter of control and security, Google, Facebook, Twitter, etc., will require you to apply for an application first. Generally speaking, registering a new application is free and only takes a few minutes.

Social Networks Setup

To configure your preferred login channels, please do as follows:

  1. Go to the WP admin › Settings › General and check the Anyone can register box to allow creating new user accounts.
  2. Go to the WP admin › Settings › WP Social Login.
  3. Choose the Networks tab, and follow Social Networks Setup guide to set them up.
  4. If you need to add more providers, use the sidebar on the right.
  5. Now to load big social buttons, go to the WP admin › Settings › WP Social Login › Widget and choose the option None, display providers names instead of icons for the Social Icon Set..

For more information about plugin configuration and more advanced options, please refer to the WordPress Social Login Documentation.


Configuration

General

All Snax configuration options are located under WP admin panel › Settings › Snax.

They are divided into separate sections:

  1. General configuration.
  2. Lists related settings.
  3. Pages setup.
  4. Demo mode. Useful for quick start and testing purposes.

Single options

Options specific for a single Post (open list, gallery etc) or Submission can be adjusted directly on its edit page.
Under the WP content edition you will always find, if applicable, metabox called Snax.


Post Formats

Snax is delivered with 5 post formats. Each has a different purpose:

  1. Open List. For images and/or embeds. Users can contribute by submitting new items. Ranking (order) is based on votes.
  2. Ranked List. For images and/or embeds. Users can't contribute. Ranking (order) is based on votes.
  3. Classic List. For images and/or embeds. Users can't contribute. Ranking (order) is set by list author.
  4. Story. Best for text stories, similar to WordPress posts.
  5. Gallery. Best for photo stories.
  6. Image. For a single image.
  7. Embed. For a single YouTube, Twitter, Instagram content.
  8. Meme. For a funny image with top and bottom texts.

Deactivating formats

There's no need to use all available formats. If your site is focused just on funny images and you don't want to embed any Youtube video there, you can simply disable the Embed format. To disable unwanted format, please follow these simple steps:

  1. Go to the WP admin panel › Snax.
  2. Choose the General section.
  3. Uncheck the box right beside that format.
  4. Save changes.

Item Forms

Item forms are types of content users can add to existing lists. By default, these are New Image and New Embed forms. If you want to have a list consists of only images, you can disable the Embed form and that's all.

Global Setup

To configure forms globally, please do as follows:

  1. Go to the WP admin panel › Snax.
  2. Switch to the Lists tab.
  3. Uncheck all forms you don't want to use.
  4. Save changes.

Single List Setup

If you want to override global setup, just for one or few lists, please follow these steps:

  1. Go to the WP admin panel › Posts.
  2. Find your list (using filters and search form).
  3. Go to its edit page.
  4. In the Snax metabox, check the "Change Default Forms" field.
  5. Uncheck all forms you don't want to use.
  6. Save changes.

Pages

Snax requires only one custom page to work. It's the Frontend Submission page. It's a start point to create any new post (Open List, Embed etc.).

Other pages are optional. These are:

  • Terms and Conditions - frontend submission rules and privacy policy.
  • Report - page on which you can put some contact form to get feedback from users about all kind of abuses.

Setup

The Frontend Submission page is created and assigned during plugin installation. Only optional pages have to be created manually. Please follow these simple steps to set them up:

  1. Go to the WP admin panel › Pages › Add New and create a new page (e.g. Report).
  2. Fill its content (add a contact form, describe rules to follow etc).
  3. Publish page.
  4. Now, go to the WP admin panel › Snax.
  5. Switch to the Pages section.
  6. Assign your newly created page to the relevant field.
  7. Save changes.

Post Titles

Snax adds post format related information to Wordpress post titles.

For the Open List post format it will be (example below):

  • already submitted items count
  • list status (open | closed for submission)

Can You Get Through These 20+ Sexy Photos Without Saying WOW (Open for submission)?

For the Gallery post format it will be (example below):

  • number of gallery items

Why my last holidays turned into a trip of my life (10 photos)

Setup

To enable/disable post titles parts, please follow these steps:

  1. Go to the WP admin panel › Snax.
  2. Choose the General section.
  3. Check/uncheck the Show items count in title to show/hide items count.
  4. Choose the Lists section.
  5. Check/uncheck the Show list status in title to show/hide list status.
  6. Save changes.

To change items count position from the beginning of a post, please do as follows:

  1. Go to the WP admin panel › Posts.
  2. Choose one of your list (or gallery) posts.
  3. To a post title, add the %%items%% placeholder in the place you want to show counter.


  1. Update post.
  2. Snax will replace that placeholder with a real value.

Voting

Voting system allows users to upvote/downvote every post that was created using Snax uploader (List, Gallery, Story etc).

Disable voting

To disable voting globally, please do as follows:

  1. Go to the WP admin panel › Snax.
  2. Switch to the Voting section.
  3. Uncheck the Voting enabled? option.
  4. Save changes.

Allow users to vote on other post types

To allow users to vote on a post that is not any of Snax formats, please do as follows:

  1. Go to the WP admin panel › Snax.
  2. Switch to the Voting section.
  3. Make sure that the Voting enabled? option is checked.
  4. Check all post types that can be voted
  5. Save changes.

Demo Mode

The demo mode is the fastest way to start playing with frontend submission. Thanks to it, you don't need to upload new images/embeds all the time you want to test submission process.

Setup

To enable demo mode, please do as follows:

  1. Go to the WP admin panel › Snax.
  2. Switch to the Demo section.
  3. Check the Demo mode enabled? box.
  4. From the Media Library choose (or upload new ones) images that will be used as your demo images.
  5. Fill in embed URL and choose post image if you want to test embeds.
  6. Now, when you create a new post, demo data will show up under the upload image/embeb form.
  7. Save changes.

Administration

Review new posts and submissions

When user creates a new post/submission, new item is not published immediately. Lack of verification it is not a good idea and most likely you want to know what is added to your site. That's why before any new item will be accessible for your visitors, it's waiting for moderation in the review queue.

How to approve new post?

To change post status from pending (in the review queue) to published (visible on site), please follow these simple steps:

  1. Go to the WP admin panel › Posts.
  2. Click the Pending tab.
  3. Choose the Snax: All formats option and click Filter.
  4. From list of pending posts, choose one and go to its edit page.
  5. Verify it and if all is fine, click the Publish button

How to approve new submission?

To change submission status from pending to published, please follow these simple steps:

  1. Go to the WP admin panel › Snax Items.
  2. Click the Pending tab.
  3. From filtered list of pending submissions, choose one and go to its edit page.
  4. Verify it and if all is fine, click the Publish button

How to skip verification step?

To allow user to create and publish new post/submission immidiately, you need to grant him the snax_publish_posts permission. For more informaton about users access levels, please read the Users Permissions section.


Users permissions

Snax permissions are based on the WordPress roles and capabilities system. Most of necessary configuration is done during plugin activation so, in most cases, you don't need to do anything more.

Roles and capabilities

Snax provides only one Snax Author (snax_author) role and the following capabilites:

  • snax_upload_files - allows users to upload files
  • snax_add_posts - allows users to create new posts
  • snax_add_items - allows users to create new submissions
  • snax_delete_items - allows users to delete their own submissions
  • snax_vote_posts - allows users to vote on posts
  • snax_vote_items - allow users to vote on submissions

Basic configuration

By default, Wordpress assigns its default role (the Subsciber role) to all new users registered on your site. If you don't change that setting, Snax during activation process will change it to the Snax Author role. From now, all new users will be able to use Snax. For old users, if you have any, you will need to assign the Snax Author role to them manually (or using some 3rd party plugin).

Generally speaking, all your user needs to start using Snax is the Snax Author role assigned to him.

How to change default user role (for all new users)?

To change the role that will be assigned to all new users registered on your site, please follow these simple steps:

  1. Go to the WP admin panel › Settings › General
  2. Select the Snax Author option in the New User Default Role field.
  3. Save changes.

How to assign new role to existing user?

To assign new role, and keep all current user roles assigned, please do as follows:

  1. Install and activate the Members plugin.
  2. Go to the WP admin panel › Users
  3. Choose a user and click it.
  4. Scroll down to the Roles section.
  5. Check the box right next to the role you want to add (Snax Author role).
  6. Click the Update User button

Advanced permissions management

If the basic configuration is not sufficent for your site, e.g. becuase you have already defined other users permissions, you can use the Members plugin to add necessary capabilities to existing roles.

Let's say your users (old and new) require to have the SPECIAL_ROLE role and you can't change this. It's not a problem, you can assign Snax capabilites to any role you want. To do this, using the Members plugin, please follow these steps:

  1. Install and activate the Members plugin.
  2. Go to the WP admin panel › Users › Roles
  3. Click your SPECIAL_ROLE role (or any other role you want to assign Snax capabilites to).
  4. Check the box (in the "Grant" column) right beside capabilites with the snax_ prefix (full list above).
  5. Click the Update button

Miscellaneous

Sources and Credits

JavaScripts

Fonts


JavaScript files

The main power behind this plugin is the famous javascript framework jQuery.

The plugin uses:

  • front.js - plugin specific functions and initializations (frontend side)
  • front-submission.js - user submission (new post) specific functions (frontend side)
  • add-to-list.js - user submission (contribution) specific functions (frontend side)
  • admin.js - plugin specific functions and initializations (admin side)

All used 3rd party scripts are listed on the Sources and Credits page.


CSS files

Reset Styles

The first rules in main.css file are generic reset rules. Many browser interpret the default behavior of html elements differently. By using a general reset styles, we can work round this.

General Styles

The main css file main.css is separated into sections:

  1. Settings
    1. Global
  2. Tools
    1. Functions
    2. Mixins
  3. Generic
    1. Reset
  4. Elements
    1. Default
    2. Forms
  5. Objects
    1. Grid
    2. Fluid wrapper
  6. Components

If you would like to edit a specific section of the site, simply find the appropriate label in the CSS file, and then scroll down until you find the appropriate style that needs to be edited. Sections are marked as follows:

/**
 * 1 . SAMPLE SECTION NAME
 */

Folder Structure

After unzipping the file downloaded from the CodeCanyon you'll see the following folder structure:

  • snax - plugin files - in case you want to upload the plugin through the FTP
  • snax.zip - zipped plugin files - in case you want to upload the plugin through the WordPress admin
  • changelog.txt - releases history
  • Documentation - an entry point to the online documentation. Online version it's always up to date.
  • License - licensing files
  • Licensing - licensing files

Custom Widgets

The Plugin comes with some custom widgets ready to use. All custom widgets names start with the Snax prefix.

All available widgets can be found in the WP Admin › Appearance › Widgets.


FAQ

How to update plugin?

Automatic updates

To use automatic updates you need the Envato Market plugin. You can do that now via WordPress Admin › Appearance › Install Plugins or WordPress Admin › Plugins › Install Plugins panel.
After installing, go to the WordPress Admin › Envato Market and enter your token. If you don't have it, you can generate new one by clicking the generate a personal token link in the Global OAuth Personal Token section.

Manual updates

If, for some reasons, you can't use automatic updates, you can always use default way to update the plugin. When new update will be released, the CodeCanyon will notify you about that so you can download new package and install it manually, via WP admin panel › Plugins › Add new.


What's the difference between Post and Submission?


Do I need the BuddyPress plugin?


Do I need the Wordpress Social Login plugin?


How to change default user role (for all new users)?


How to assign new role to existing user?


Do I need to use all other BuddyPress components?