Skip to content

Latest commit

 

History

History
100 lines (65 loc) · 5.87 KB

readme.md

File metadata and controls

100 lines (65 loc) · 5.87 KB
Raw

WP Restaurant Listings

Contributors: WPdrift, upnrunn, Kishores, Mithun
Tags: restaurant manager, restaurant listing, restaurant board, restaurant management, restaurant lists, restaurant list, restaurant
Requires at least: 4.7
Tested up to: 4.9
Stable tag: 1.0.0
License: GPLv3
License URI: https://www.gnu.org/licenses/gpl-3.0.html

Manage restaurant listings from the WordPress admin panel, and allow users to post restaurants directly to your site.

Description

WP Restaurant Listings is a lightweight restaurant listing plugin for adding restaurant listing functionality to your WordPress site. Being shortcode based, it can work with any theme (given a bit of CSS styling) and is really simple to setup.

Features

  • Add, manage, and categorize restaurant listings using the familiar WordPress UI.
  • Searchable & filterable ajax powered restaurant listings added to your pages via shortcodes.
  • Frontend forms for guests and registered users to submit & manage restaurant listings.
  • Allow restaurant listers to preview their listing before it goes live. The preview matches the appearance of a live restaurant listing.
  • Searches also display RSS links to allow restaurant seekers to be alerted to new restaurants matching their search.
  • Allow logged in listers to view, edit, or delete their active restaurant listings.
  • Developer friendly code — Custom Post Types & template files.

The plugin comes with several shortcodes to output restaurants in various formats, and since it's built with Custom Post Types you are free to extend it further through themes.

Read more about WP Restaurant Listings.

Documentation

Documentation for the core plugin and add-ons can be found on the docs site here. Please take a look before requesting support because it covers all frequently asked questions!

Support

Use the WordPress.org forums for community support where we try to help all users. If you spot a bug, you can log it (or fix it) on Github where we can act upon them more efficiently.

If you need help with one of our add-ons, please raise a ticket at our help desk.

If you want help with a customization, please consider hiring a developer! https://upnrunn.com/services/ is a good place to start.

Installation

Automatic installation

Automatic installation is the easiest option as WordPress handles the file transfers itself and you don't even need to leave your web browser. To do an automatic install, log in to your WordPress admin panel, navigate to the Plugins menu and click Add New.

In the search field type "WP Restaurant Listings" and click Search Plugins. Once you've found the plugin you can view details about it such as the point release, rating, and description. Most importantly, of course, you can install it by clicking Install Now.

Manual installation

The manual installation method involves downloading the plugin and uploading it to your web server via your favorite FTP application.

  • Download the plugin file to your computer and unzip it
  • Using an FTP program, or your hosting control panel, upload the unzipped plugin folder to your WordPress installation's wp-content/plugins/ directory.
  • Activate the plugin from the Plugins menu within the WordPress admin.

Getting started

Once installed:

  1. Create a page called "restaurants" and inside place the [restaurants] shortcode. This will list your restaurants.
  2. Create a page called "submit restaurant" and inside place the [submit_restaurant_form] shortcode if you want front-end submissions.
  3. Create a page called "restaurant dashboard" and inside place the [restaurant_dashboard] shortcode for logged in users to manage their listings.

Note when using shortcodes, if the content looks blown up/spaced out/poorly styled, edit your page and above the visual editor click on the 'text' tab. Then remove any 'pre' or 'code' tags wrapping your shortcode.

For more information, read the documentation.

Frequently Asked Questions

How do I setup WP Restaurant Listings?

View the getting installation and setup guide for advice getting started with the plugin. In most cases it's just a case of adding some shortcodes to your pages!

Can I use WP Restaurant Listings without frontend restaurant submission?

Yes! If you don't setup the [submit_restaurant_form] shortcode, you can just post from the admin backend.

How can I customize the restaurant submission form?

There are three ways to customize the fields in WP Restaurant Listings;

  1. For simple text changes, using a localisation file or a plugin such as https://wordpress.org/plugins/say-what/
  2. For field changes, or adding new fields, using functions/filters inside your theme's functions.php file: https://wpdrift.com/docs/restaurants/editing-job-submission-fields/
  3. Use a 3rd party plugin which has a UI for field editing.

If you'd like to learn about WordPress filters, here is a great place to start: https://pippinsplugins.com/a-quick-introduction-to-using-filters/

Screenshots

  1. The submit restaurant form.
  2. Submit restaurant preview.
  3. A single restaurant listing.
  4. Restaurant dashboard.
  5. Restaurant Listings and filters.
  6. Restaurant Listings in admin.

Changelog

1.0.0

  • First stable release.