Skip to main content

WordPress Plugin

WordPress is a popular and powerful content management system (CMS) that is used by millions of websites around the world. It is an open-source platform, which means that it is free to use and customize, and has a large and active community of developers and users who contribute to its development and support.

One of the main advantages of WordPress is its user-friendly interface, which makes it easy for people with no technical skills to create and manage a professional-looking website. WordPress also has a wide range of plugins and themes that you can use to extend its functionality and customize the appearance of your website. This allows you to easily add features like contact forms, forums, e-commerce capabilities, and more to your website without needing to know how to code.

WithWine + WordPress​

WithWine offers tight integration with WordPress, allowing you to easily create an online storefront for your Winery. Our WordPress plugin is designed to give you out-of-the box ecommerce capabilities with minimal setup, or you can take it to a whole other level with fully customised layouts by leveraging the plugins API integrations.

WordPress is a compelling application to use for an ecommerce website for several reasons. WordPress is an open-source platform that has a large and active community of developers and users. This means that there is a wealth of resources, documentation, and support available for building and maintaining WordPress sites, including ecommerce websites.

WordPress is also highly customizable and extensible. It offers a wide range of themes and plugins that can be used to customize the look and functionality of your ecommerce website. This allows you to create a unique and personalized online store that reflects your brand and meets the needs of your customers.

Getting Started​

To get started, you will need to have a WordPress website that is hosted on a web server. Once you have a WordPress website, you can install the WithWine plugin to add your online store to your website. We have a comprehensive Getting Started guide and Installation guide that will walk you through the process of installing the plugin and setting up your online store.

General plugin information​

Dependencies​

Settings Reset​

You can do a hard reset the plugin's setting by providing default_withwine_settings in the admin url, eg.

https://[your domain here]/wp-admin/options-general.php?default_withwine_settings
caution

This action cannot be undone, so make sure to keep a note of any important setting you may want to restore afterwords. You might want to take extra care if you are performing this action in a production environment.

Important plugin information​

Below are a number important points about the plugin and they way it operates. Please read this in its entirety before proceeding with the installation. It's important that you understand the implications of each of these points as they may directly impact the correct operation of the plugin and.or your website. We will try to reference these points throughout the documentation where applicable to reiterate their importance.

Caching​

Important

If using a caching layer / CDN such as; Akamai, Amazon CloudFront, Azure CDN, CacheFly, Cloudflare, Fastly, Google Cloud CDN, among others, great care must be taken to ensure that paths starting with the following are not cached:

  • /user/login
  • /user/logout
  • /user/checkout
  • /auth/refresh
  • /JoinClub
  • /WithWineOrder
  • /?rest_route
  • /wp-json
  • /LoginCallback

If any of these paths are cached, the application will fail to operate correctly, as these paths are critical to supplying up to date data. It is important that you work with your CDN provider to ensure that these paths are not cached and are not suplying stale data to your website.

Checkout Success Page​

It is important to create a /CheckoutSuccess page on WordPress, otherwise users will receive a "Not Found" page after completing checkout. This URL can be customised in WithWine's Website settings under the "Custom Credentials and Configuration" section. This URL also includes query string parameters such as:

  • oid if the checkout was for an order
  • cmid if it was for a club membership join/update
  • agcid if it was for a gift card redemption.

Product Details Page​

In order for the plugin to display the product details page, it is important to set the page ID in the settings. In this page, you can use the product-details shortcode without providing the data_product_id attribute. Do not forget to flush and regenerate the rewrite rules database. From WordPress Administration Screens, Select Settings -> Permalinks and just click Save Changes without any changes.

The plugin will attempt to add the Cart and Login / Logout links in the primary menu navigation. You can override the container on which these widgets will appear by providing the respective container IDs in the settings page.

Cart Widget​

The Cart widget will be always available in every page. This widget appears after you click "Buy" from the Store widgets or by clicking the Cart link in the navigation.

Store Widget​

The Store widget is useful in full-width template pages, but if you prefer to separate the store and the filter in different places, use store-products and store-filter widgets, this will enable a more customised layout.

Web Browser support​

If the user is using Internet Explorer, all of the widgets will be hidden and a dialog box will appear which encourages the user to use a different browser. The dialog box can be hidden indefinitely by ticking "Don't show this again", otherwise it will always appear for every page navigation.