Notice: Function _load_textdomain_just_in_time was called incorrectly. Translation loading for the neve domain was triggered too early. This is usually an indicator for some code in the plugin or theme running too early. Translations should be loaded at the init action or later. Please see Debugging in WordPress for more information. (This message was added in version 6.7.0.) in /home/hosting/domains/woo-products-list.hostin.gr/public_html/wp-includes/functions.php on line 6121
Documentation – WooCommerce Products List Pro
Skip to content

Documentation

Installation


This wordpress plugin can be installed as any other wordpress plugin. Installation is simple.

  1. Extract the zip file you have downloaded.
  2. Login to your administration panel (ex. http://www.yourdomain.com/wp-admin).
  3. Go to Plugins → Add New.
  4. At the top of the page click the “Upload Plugin” link
  5. Click choose file (or what your browser uses to navigate to your files)
  6. From the extracted files of step one (1) navigate to and select woo-products-list-pro.zip and click “Install Now
  7. You may be asked to confirm your wish to install the Plugin.
  8. If this is the first time you’ve installed a WordPress Plugin, you may need to enter the FTP login credential information. If you’ve installed a Plugin before, it will still have the login information. This information is available through your web server host.
  9. Click Proceed to continue with the installation. The resulting installation screen will list the installation as successful or note any problems during the install.
  10. If successful, please click Activate Plugin to activate it.

Upgrade

– Deactivate and delete the plugin.
– Install the new version and activate it.

or overwrite via FTP

Features

  • User friendly and self-explanatory administration panel.
  • Displays all the needed data for your products according to your settings.
  • Easy to add a list anywhere on your WordPress via shortcode.
  • Easy to add a list anywhere on your WordPress via PHP function.
  • Comes with a WordPress shortcode creator editor plugin.
  • You can create unlimited product lists by filtering per product category, product tag, product publishing date etc.
  • “Add Selected to Cart” with select all checkbox for mass / bulk adding products to cart
  • Extensible / developer friendly. You can alter the plugin without hacking it, but via WordPress filters and actions.
  • Make your products stand out with your custom sticker/icon. You can enable/disable or override it per product.
  • Supports YITH WooCommerce Wishlist
  • Supports YITH WooCommerce Quick View
  • Supports WooCommerce Product Gift Wrap
  • AJAX can be enabled / disabled from the settings page
  • Sorting of table columns in the frontend by clicking at each column header
  • List pagination
  • On the fly categories and tags filters
  • Attributes are supported
  • Custom fields and meta are supported
  • Supports WooCommerce Direct Checkout
  • Responsive Layout / Mobile Ready
  • Easily translatable via .po / .mo files.

Usage

In order to use the Woocommerce Products List PRO plugin, please navigate from your WordPress administration panel to “Woocommerce -> Products List PRO

Options
  1. Display Product Title: Select “yes” to display the product title column or “no” to hide it.
  2. Display SKU: Select “yes” to display the product SKU column or “no” to hide it.
  3. Display Thumbnail: Select “yes” to display the thumbnail column or “no” to hide it.
  4. Thumbnail Width in Pixels: You may define the with of the thumbnail in pixels in this field
  5. Display Categories: Select “yes” to display a column with the categories that are assigned to the product or “no” to hide it.
  6. Display Tags: Select “yes” to display a column with the tags that are assigned to the product or “no” to hide it.
  7. Display Stock: Select “yes” to display the stock condition column or “no” to hide it.
  8. Hide Zero Priced Products: Select “yes” to skip empty or zero priced products or “no” to include them on the list.
  9. Hide Out of Stock Products: Select “yes” to skip out of stock products or “no” to include them on the list.
  10. Treat zero quantity Products as Out of Stock: Select “yes” to skip products that do not have a quantity set or “no” to include them on the list.
  11. Display Price: Select “yes” to display the price column or “no” to hide it.
  12. Display Total: Select “yes” to display the total per row column or “no” to hide it.
  13. Display Quantity Field: Select “yes” to display the quantity input field of the products to be added to cart column or “no” to hide it.
  14. Display Quantity Controls: Select “yes” to display -/+ buttons for the quantity field or no to hide them.
  15. Default Quantity Value: Enter any number to set as default quantity, default is 1.
  16. Display Weight: Select “yes” to display the weight of the products or “no” to hide it.
  17. Display Dimensions: Select “yes” to display the dimensions of the products or “no” to hide it.
  18. Display Add To Cart: Select “yes” to display the add to cart button column or “no” to hide it.
  19. Add to Cart Icon: You may select to display any of the available icons or not to display any icon at all.
  20. Display Global Add To Cart: Select “yes” to display the global add to cart button or “no” to hide it.
  21. Global Add To Cart Button Position: Here you can choose where to place the global add to cart button.
  22. Global Add To Cart Button Default Status: You may set it to checked or un-checked when the list loads.
  23. Display Wishlist: Select “yes” to display the wishlist icon column or “no” to hide it.
  24. Display Gift Wrap Option: Select “yes” to display the gift wrap checkbox column or “no” to hide it, if you have the gift wrap plugin.
  25. Display Image: Select “yes” to display an extra image/sticker/icon column or “no” to hide it.
  26. Add Image: Upload the extra image/sticker/icon by clicking on the Open Media Manager button. The image will obey the thumb width settings.
  27. Display Excerpt: Select “yes” to display a excerpt of the product.
  28. Excerpt max length in characters: Enter the max number of characters in order to limit it. Leave blank for WP default.
  29. Display Excerpt Inline: Select where you would like to place the description.
  30. Display Table Head: Select “yes” to display table head or no to hide it. Hiding it will also remove the frontend sorting functionality.
  31. Enable Sorting: Select “yes” to enable sorting by clicking the table header on the frontend
  32. Enable Ajax: Select “yes” to enable AJAX for the “add to cart” button
  33. Order Direction: Select “ascending” or “descending” to set the default order direction for the list.
  34. Order By: Select the desired value to set the default element to order the products list.
  35. Order Columns: You may order the columns by drag-n-dropping the list elements.
  36. You are ready to go! * Save Changes *
Shortcode

On your product page or anywhere were shortcodes are executed (eg. posts and pages), you may use the shortcode.

[wcplpro wcplid=”somerandomstringhere” ]

If you just put the shortcode then it will read the default settings of the plugin that you have just set via the admin settings panel. The wcplid parameter should not be missing and it should be unique for each shortocde instance.

In order to customize the shortcode, it is strongly recommended to use the “WOO List” icon that is now available on the WP Editor.
However, you may also enter the shortcode manually by using any of the following attributes (respectively to the above options):

  • keyword
  • categories_exc
  • categories_inc
  • tag_exc
  • tag_inc
  • posts_inc
  • posts_exc
  • categories
  • tags
  • sku
  • title
  • thumb
  • thumb_size
  • stock
  • hide_zero
  • hide_outofstock
  • zero_to_out
  • price
  • total
  • offer
  • image
  • qty
  • default_qty
  • qty_control
  • cart
  • globalcart
  • globalposition
  • global_status
  • wishlist
  • gift
  • ajax
  • desc
  • weight
  • dimensions
  • desc_inline
  • head
  • sorting
  • order
  • orderby
  • order_direction
  • date
  • wcplid
  • quickview
  • pagination
  • posts_per_page
  • filter_cat
  • filter_tag
  • filters_position

On all attributes, setting it to “1” equals to “yes” and “0” equals to “no”, when yes or no apply as a possible options. Here is an example:

[wcplpro wcplid="put_sth_unique_here" keyword="woo ninja" thumb=1 thumb_size=150 stock=1 offer=0 qty=1 default_qty=4 ajax=0]

As you may notice we have not set the cart, wishlist etc. attributes, hence the shortcode will do as we have set via the plugin’s settings panel

Guide to some special shortocde attributes

keyword: This is a free text attribute. The shortcode will do a search for the term you entered.
categories_exc: Comma separated categories IDs that you want its products’ to be excluded form the list.
categories_inc: Comma separated categories IDs that you want products from these categories only to be excluded to the list.
tag_exc: Same as categories but for excluding product tags
tag_inc: Same as categories but for restricting to specific product tags only
posts_inc: Enter comma separated products IDs (no spaces), to only include those products in the list
posts_exc: Enter comma separated products IDs (no spaces), to exclude those products from the list
thumb_size: This will take a number only and will be used as pixels
image: It has to be a full URL to the image
globalposition: Available values are “bottom”, “top” and “both”
desc: This will display the excerpt or not. Again 0 and 1 are the available options
order_direction: Available values are “asc” for ascending and “desc” for descending
orderby: Available values are “date”, “title”, “_price”, “_sale_price”, “_regular_price”, “_sku”, “_weight”, “_length”, “_width”, “_stock”, “total_sales”, “_stock_status”, “_wc_average_rating”
date: You can use this to display products only from specific year, month or day, eg. 2016 will display only products that were added in 2016 and 2016/09 will display products added on September of 2016 etc.
quickview: This will take as options: no, simple, variable, all
pagination: This will take as options: no, before, after, both
posts_per_page: This should be a number
filter_cat: This will take as options: yes, no
filter_tag: This will take as options: yes, no
filters_position: This will take as options: no, before, after, both

For Developers

Many hooks are in place. Please search the code for a full list. Below are some of them with examples.

Filters

You can add alter the css class of the link to the full image for each variation with the filter “vartable_thumb_class_filter”, eg.

add_filter( 'wcplpro_thumb_class_filter', 'my_wcplpro_custom_img_class');
function my_wcplpro_custom_img_class($class) {
  $class = $class.' myclass anotherclass';
  return ($class);
}

The Woocommerce “single_add_to_cart_text” filter is in place. Please refer to Woocommerce documentation.

Actions

You may add your own css class for the table with “wcplpro_table_class”, eg.

add_action( 'wcplpro_table_class', 'my_wcplpro_table_class');
function my_wcplpro_table_class($class) {
  $class = ' table-hover table-striped ';
  return ($class);
}

You can add text before and after the table with, “wcplpro_before_table” and “wcplpro_after_table”, eg.

add_action( 'wcplpro_before_table', 'my_wcplpro_before_table');
function my_wcplpro_before_table($text) {
  $text = 'This text ';
  $text .= 'will go before the table';
  echo $text;
}
add_action( 'wcplpro_after_table', 'my_wcplpro_after_table');
function my_wcplpro_after_table($text) {
  $text = 'This text ';
  $text .= 'will go after the table';
  echo $text;
}