To Get Started
Start by reading Installing Plugins section in our comprehensive WordPress and WordPress Multisite Manual if you are new to WordPress.
The plugin is compatible with both WordPress standard installation and WordPress Multisite.
- For a single site WordPress install, click “Activate Plugin” or
- “Network Activate” (for Multisite, if you want to activate the plugin across all sites on the network. If not you can go to the Plugins section under each site and activate individually).
Setting-Up the Directory Plugin
When you Activate the plugin, you will be taken to the plugin page automatically. If not, Click on “Listings” from the side bar on your WordPress Dashboard.
You’ll be taken to a “Getting Started” page. Click on “Configure Your Settings” to setup the plugin. If you are on WordPress 3.3.1 and beyond, the plugin will be able to use its step-by-step Set-up tutorial that will guide you through the process. Yes! We are that awesome!
The Settings that need to be set are categorized neatly. Lets go through all of them:
The General Tab
This is where you set-up some basic settings for the plugin.
1. Directory Member Role
2. Directoyr Status Options
3. Redirection Options
4. Custom Field Options
5. Display Options
6. Pagination Settings
7. Notification Settings
8. Getting Started Page
- Directory Member Role: Here you can select the role which you want to be assigned to a Directory member when he signs up on your Directory site. You should make sure that if you are using multiple plugins which control the signups on your site, use the same role in all of them. You can also add a new role here and you must add the appropriate capabilities to make it work.
- Directory Status Options: Specify what all options will be available to the members while they are creating a new listing. You can offer them to publish, set as pending review or save a draft. So if you do not want members to publish the listings then uncheck the Published checkbox.
- Redirection Settings -
Redirect URL (sign in): Set the URL where you want the user to be redirected to when they login. By default the user is taken to your homepage, but using the link to your listings page (YourSite.com/listings/) is a good idea, if your site is mainly a directory.
Redirect URL (logout): Like the sign-in redirect, but this time you get to decide where to send the user when they Log out. A thank you page? Not a bad idea!
- Custom Field Options: The Directory Plugin actually includes a copy of the CustomPress plugin with which allows you to Custom Fields to work with your listings. This setting decides on how the Custom Fields should be listed on the Site. This is discussed in detail towards the end of this documentation.
- Display Options -
Count of category: Set the number of categories that you want to list when you list the categories using short code. Count of sub-category: Set the number of sub-categories that you want to list when you list the categories using short code.
Empty sub-category: Tick this if you don’t want the empty sub-categories to show up in the list. Quite Handy.
- Pagination Settings: Directory plugin supports pagination. You can define where to show it on a page and how many page links to show at one time.
- Notification Settings:
- Getting Started Page: If you wish to see the “Getting Started Page” again, this is how you do that. It is usually shown only during the first run after the plugin install.
This is where you set the capabilities of each user. By default, the admin has all capabilities.
To assign capabilities, just select each role, the plugin will load the previously set settings for each role. Set the ones you want and click “Save Changes”. Repeat this for each role.
For any custom roles which you created under General tab, you will need to define the capabilities here.
If you plan to charge people for listings, this is where you set your price. The Directory plugin has everything you need to create a paid listing portal!
You can receive Recurring Daily/Weekly /Monthly/Yearly Payments for your service, or a one time up-front payment. The options are pretty straight forward.
You can also use Credits for publishing a listing. Define the cost per credit, number of credits required per listing and signup credits (If you want to offer free credits for signup)
You can also type in Terms of Service, in this page. When you are done, click “Save Changes” before proceeding to the next tab.
Payments Type Tab
Now this is where you actually decide whether you want to enable paid listings or not.
Clicking “Free Listings” will just save the page. But when you click “Paypal”, a whole lot of settings open up:
- PayPal API Calls URL: Choose Sandbox while you are testing your set-up. The sandbox mode will let you actually test out if the payment system would work, without making actual payments. When you are ready and all set, come back and choose Live to start marking money!
- PayPal Business Email: This is the email of the account to which you wish to receive payments to. Your account should be either a Business account or a Premier account for the gateway to work.
- PayPal API Credentials: You will need some information from PayPal so that the plugin can integrate with your account and work for you. You will need API Username API Password & API Signature. Note that, these are NOT your account login username, or password. Instructions to how to get these information can be found here.
- Currency: Choose your currency from the list.
Having completed this, you are all set to make some money. Way to go!
Affiliate settings Tab
- Note: The Affiliate Tab will only display if you also have our Affiliates plugin installed and activated.
You can grow your directory site faster by using our Affiliates Plugin. The latest release of the affiliate plugin has an add-on for the directory plugin. Go to the “Manage Addons” Tab in the affiliate plugin and activate the Directory Add-on
Once enabled, you can choose the following options:
- Affiliate payment credited for signed member (recurring payments): The amount that you wish to pay your affiliate promoter for recurring billings. Lets assume, Mr. Mark is your affiliate. And he sends a user, one Mr. Tony to your listing site. And Tony signs-up for a recurring plan (the one we set in the Payment Settings tab). Mark gets paid the first time Tony pays you with the amount you set in here. Note that the affiliate is NOT paid every month, only the first time, so make sure you reward him well for all the money he is bringing in! Cool, huh?
- Affiliate payment credited for permanent member (one-time payments): This is the amount that your affiliate gets paid for the one time payment plan that you have set.
Hit “Save Changes” before proceeding to the next!
Directory Shortcodes Tab
Shortcodes are the easiest way to integrate your plugin to your theme. Add them to a normal Post/Page in the HTML view and the shortcode will be replaced by really cool stuff when you look at the page. Like magic!
The shortcodes you have for the Directory plugin:
List of Categories: [dr_list_categories] : Displays a list of Categories and Sub-Categories on a Post/Page. This shortcode has the optional attributes to display as a list or in a grid format.
Tip: To make this shortcode working on your sidebar, insert add_filter(‘widget_text’, ‘do_shortcode’); into the functions.php of your theme. Now insert the shortcode into a text widget and add it to your sidebar widget. It should work!
Listings Button: [dr_listings_btn] : Displays a link to the listings page.
Add Listing Button: [dr_add_listing_btn] : Displays a link to the add listings page.
My Listings Button: [dr_my_listings_btn] : Displays a link to the my listings page.
Profile Button: [dr_profile_btn] : Displays a link to the profile page.
Signin Button: [dr_signin_btn] : Displays a link to the signin page.
Signup Button: [dr_signup_btn] : Displays a link to the signup page.
Logout Button: [dr_logout_btn] : Displays a link to the logout page.
Note : Attributes should be selected carefully. “|” means one OR the other. More info is available on the Shortcodes tab.
The plugin creates the following pages for you to use:
- The Sign-up Page at: YourSite.com/signup/
- The Sign-in Page at: YourSite.com/signin/
- Listings Page at: YourSite.com/listings/
- And when you have paid for the listings: An “Add New Listing” Page (as a drop down to the Listings page)
Once the plugin is configured well, you can get the signup page to work. When you are in the sandbox mode, with a developer Paypal account, you can test out the working of the plugin. When you are happy and all set, Go to Listings > Payments Type and change PayPal API Calls URL to “Live”.
You are ready to roll!
Creating a Listing
A new listing can be created by visiting the Listings page on your site and clicking the “Create New Listing” button. Every user that has the capability to create a new listing will be able to access that page.
Note that if you have BuddyPress active on your site, Directory will integrate with BuddyPress profiles where users can create their listings.
While creating a new listing, the following details can be added:
- The content of the Listing.
- Tags and Categories.
- Custom Fields created with included version of CustomPress. Do not activate CustomPress separately.
Creating User Defined Custom Fields
The Directory plugin uses our CustomPress plugin. You can create your own custom fields and add them to your listings.
IMPORTANT: Please do not activate CustomPress along with Directory. Doing so will cause issues and is unnecessary as the Directory plugin already has everything you need.
- Navigate to CustomPress > Content Types > Custom Fields Tab
- Click “Add Custom Field”
- Enter “Field Title”, “Field Type”, “Field Description” and select the “Post Type” as directory_listing
- Click “Add Custom Field”
The custom field you just created will show up in the post editor for the Directory Plugin. Enter the value for the field there. You can create as many custom fields as you want.
Custom Fields you create are automatically integrated to the listings. You can set the style in which they show up on the Display Custom Fields as setting in the General Settings Tab of the Directory Plugin. The “table” layout (as shown in the screenshot) will look elegant, but its up to you!
Hope you make the most of the Directory Plugin. We would love to hear from you. Discuss your suggestions, questions or feature requests in the Forum.