Rental Products

Installation

↑ Back to top

Download, install and activate the extension.

It is strongly recommended you initially use a staging/development environment and test the extension before use on a production website.

If you haven’t already, connect your store to your WooCommerce.com account. This ensures you get extension update notifications when available.

Quick start guide

↑ Back to top

• Perform the installation steps above
• Go to WooCommerce > Settings > Products > Rental products and configure the settings as you require or use the defaults
• Add/edit a product via the dashboard products menu, to make a product rental based under the Product data > Rental tab select one of the rental product yes options
• Set any other rental product options required e.g. pricing, availability, deposits, etc
• For variable type products there are additional fields when editing each variation which you can set
• Save the product, it will now be available for rental on the frontend
• Once you have some rental products you will notice from the products list in the dashboard these now show the rental stock/price in the columns in the products list, you can also filter the products list by rentals
• When a customer orders a rental product that order will show an includes rentals suffix on the orders list in WooCommerce > Orders, you can also filter the orders list by orders with rentals
• For details on how to manage orders with rentals click into the order and read the information in the managing rental orders meta box, this covers order statuses, cancelling/removing individual rental items, adding/changing rental items, etc
• You can find the rentals dashboard at WooCommerce > Rentals, this gives you an overview of all rentals in a calendar, inventory insights and some useful tools for advanced rental product management

Settings

↑ Back to top

To access the global settings go to WooCommerce > Settings > Products > Rental products and configure the settings as you require or use the defaults. The settings page includes information and various settings you can configured which cover:

• Rental date format – configure the rental date format
• Rental form – configure the rental form shown to customers
• Availability checker – configure the availability checker which customers can use to quickly see which products are available for specific dates as they browse your store
• Disable rental dates – configure specific dates to be disabled for rental, used in addition to any dates automatically disabled where no availability
• Rental or purchase toggle – Configure the rental or purchase toggle shown on products of a rental or purchase type
• Rental price display – Configure the rental price display
• Rental information – Configure the rental information display
• Order management – Configure order management related settings
• Misc – Configure miscellaneous settings
• Emails – Configure the rental return reminder email sent to customers
• Text – Configure the most commonly used text references

Each setting has a description of what the setting does, for some settings this can be revealed by hovering over the tool tip icon.

Products

↑ Back to top

Options

↑ Back to top

To use a product as a rental go to the products section in your dashboard and add a new product or edit an existing product. Rental products can be used with simple, variable and grouped product types. Note that grouped products are simply a collection of other products so you will not see a rental option for products of this type but you can select rental based products to be grouped with the product.

Upon adding or editing a product you will see a rental tab within the product data section, click on this to reveal the rental product options, the options are grouped into categories:

The rental product options are split into the following categories:

• Rental – Configure whether this product is a rental
• Pricing – Configure rental pricing options
• Availability – Configure rental availability options
• Deposits – Configure deposits for this rental product
• Calendar – Configure the calendar display on the product page
• Information – Configure rental information to be displayed
• Add-ons – Configure rental product add-ons
• Advanced – Configure advanced options for this rental product

Each rental product option has a description of what the product option does, for some rental product options this can be revealed by hovering over the tool tip icon.

List

↑ Back to top

From the products menu the listing of all products in your store show any rental products and these include rental information such as price and stock so you can quickly see this information without clicking into a product. There is also a filter included so you can filter the products list by rentals.

Tools

↑ Back to top

Within the WooCommerce > Rentals > Tools you will find clone, import/export information and debugging tools which are useful for managing product data.

Orders

↑ Back to top

Management

↑ Back to top

Orders which contain rentals are managed the same as you do for normal orders with a few differences. Information on how to manage rental orders is shown in a meta box when adding/editing an order. Note that the meta box will only appear if the managing rental orders information setting is enabled (this is enabled by default), and if it hasn’t been disabled by the user via screen options.

This information changes depending on the overall settings you have applied for rentals, below is an example of the managing rental orders meta box, the information shown may differ for your store due to the settings configured.

List

↑ Back to top

In WooCommerce > Orders you will see a list of all orders, if an order includes rentals it will show a suffix next to the order and customer name.

You can also filter the orders list by rentals using the rentals filter.

Rentals dashboard

↑ Back to top

The rentals dashboard is where you can get an overview of rental orders in a calendar, view rental inventory and access tools. To access the rentals dashboard go to WooCommerce > Rentals.

Once in the rentals dashboard you can use the top shortcut buttons as a shortcut to other areas within the WordPress/WooCommerce dashboard to view all rental products and orders which contain rentals.

The rentals dashboard is split up until different tabs.

• Calendar
• Inventory
• Tools

Calendar

↑ Back to top

The calendar tab shows all past, current and scheduled rentals with information on the products included and the order they were placed. Rentals are shown in a number of colors depending on their status, use the color key at the top of the page for details on how each color relates to the rental.

You can also enable a calendar feed setting in the overall rental settings, this allows you to subscribe to a calendar feed to view rentals in your chosen calendar application. For further details on this see the related information in settings.

Inventory

↑ Back to top

The inventory tab shows all published rental products and stock total, in and out levels based on the inventory date you set. You can search, sort, print and export the inventory.

For details on how these rental stock levels are calculated click the link at the top right of the page.

Tools

↑ Back to top

The tools tab has a number of tools to manage rental products such as cloning rental product options from one rental product to another rental product or set of products, import/export information and debugging tools.

Frontend examples

↑ Back to top

This extension includes several rental specific features to the customer throughout their journey around your store and within emails, below are some examples of this.

Custom development

↑ Back to top

The following information is provided for custom development purposes for web developers, they are useful if you wish to add custom features or modify how the extension works. As per the WooCommerce support policy we cannot offer any support for your use of these custom development features.

Filter hooks

↑ Back to top

Filter hook	Description
wcrp_rental_products_cart_item_price	Rental cart item price
wcrp_rental_products_default_rental_options	Default rental options
wcrp_rental_products_rental_information_title	String from settings
wcrp_rental_products_rental_price_display_prefix	String from settings
wcrp_rental_products_rental_price_display_suffix	String from settings
wcrp_rental_products_rental_price_html	Rental price HTML markup
wcrp_rental_products_select_dates_button_html	Select dates button HTML
wcrp_rental_products_text_availability_checker_applied	String from settings
wcrp_rental_products_text_check_availability	String from settings
wcrp_rental_products_text_disable_rental_start_end_dates_notice	String from settings
wcrp_rental_products_text_disable_rental_start_end_days_notice	String from settings
wcrp_rental_products_text_non_refundable	String from settings
wcrp_rental_products_text_refundable	String from settings
wcrp_rental_products_text_rental_available	String from settings
wcrp_rental_products_text_rental_cancelled	String from settings
wcrp_rental_products_text_rental_dates	String from settings
wcrp_rental_products_text_rental_period	String from settings
wcrp_rental_products_text_rental_returned	String from settings
wcrp_rental_products_text_rental_return_within	String from settings
wcrp_rental_products_text_rental_unavailable	String from settings
wcrp_rental_products_text_rent_for	String from settings
wcrp_rental_products_text_rent_from	String from settings
wcrp_rental_products_text_rent_to	String from settings
wcrp_rental_products_text_reset_dates	String from settings
wcrp_rental_products_text_security_deposit	String from settings
wcrp_rental_products_text_select_dates	String from settings
wcrp_rental_products_text_view_purchase_options	String from settings
wcrp_rental_products_text_view_rental_options	String from settings

Functions

↑ Back to top

Function	Return
wcrp_rental_products_advanced_configuration	Array of any advanced configuration options set
wcrp_rental_products_availability_checker_data	Array of availability checker data the user has selected in the availability checker
wcrp_rental_products_check_availability	Availability status string
wcrp_rental_products_default_rental_options	Array of the default rental options
wcrp_rental_products_is_rental_only	True/false
wcrp_rental_products_is_rental_purchase	True/false
wcrp_rental_products_order_has_rentals	True/false
wcrp_rental_products_rental_date_format	Rental date format string
wcrp_rental_products_rental_form_date_format	Rental form date format string
wcrp_rental_products_rental_form_first_day	First day set on rental form string
wcrp_rental_products_rental_form_maximum_date	The maximum date string or number of days until allowed for selection in the rental form

Cookies

↑ Back to top

This extension may set the following cookies, it is recommended you include details of these cookies in your cookie policy.

Name	Description	Expiry
wcrp_rental_products_availability_checker_quantity	Stores the quantity when a user uses the availability checker for next time	30 days
wcrp_rental_products_availability_checker_rent_from	Stores the rent from date when a user uses the availability checker for next time	30 days
wcrp_rental_products_availability_checker_rent_to	Stores the rent to date when a user uses the availability checker for next time	30 days

FAQs

↑ Back to top

Something is not working as expected?

↑ Back to top

We recommend reviewing the known compatibility issues information in WooCommerce > Settings > Products > Rental products for a list of potential issues and how to rectify them.

Does it work with WooCommerce product blocks?

↑ Back to top

Rental products work in all standard core WooCommerce Product Blocks with the exception of the All Products Block, this is because all the other blocks have a filter hook to allow extensions like ours to conditionally change elements of the product display in each block using a filter hook. Currently the All Products Block does not include this. Unfortunately this means if you have a rental only product displaying within this block a user can click to attempt to add it to cart without selecting any dates, however they will receive an error on cart instructing them that options have not been selected and therefore they cannot continue to checkout.

Is it compatible with a specific theme?

↑ Back to top

This extension will generally be compatible with most themes. There may be a small number of themes that are fully or partially incompatible due to clashes in functionality and/or if the theme has removed or adapted core WooCommerce functionality. If you would like to know if a specific theme will be compatible before purchase then please contact us and we can advise, it may not be possible for us to determine this e.g. if the theme requires a license and/or several configuration steps. In this scenario you are welcome to purchase and test this extension with the theme and if there is a a compatibility issue you can take advantage of the 30 day refund policy for this extension.

Is it compatible with a specific extension/plugin?

↑ Back to top

This extension will generally be compatible with most extensions/plugins. There may be a small number of extensions/plugins that are fully or partially incompatible due to clashes in functionality and/or if the extension/plugin has removed or adapted core WooCommerce functionality. If you would like to know if a specific extension/plugin will be compatible before purchase then please contact us and we can advise, it may not be possible for us to determine this e.g. if the extension/plugin requires a license and/or several configuration steps. In this scenario you are welcome to purchase and test this extension with the other extension/plugin and if there is a a compatibility issue you can take advantage of the 30 day refund policy for this extension.

Is it compatible with a specific page builder?

↑ Back to top

This extension will generally be compatible with most page builders. There may be a small number of page builders that are fully or partially incompatible due to clashes in functionality and/or if the page builder has removed or adapted core WooCommerce functionality. If you would like to know if a specific page builder will be compatible before purchase then please contact us and we can advise, it may not be possible for us to determine this e.g. if the page builder requires a license and/or several configuration steps. In this scenario you are welcome to purchase and test this extension with the page builder and if there is a a compatibility issue you can take advantage of the 30 day refund policy for this extension.

Support

↑ Back to top

If you need any further assistance with this extension please contact us. Please note that extension support does not include providing assistance with any custom development requirements as per the WooCommerce Support Policy.