# Documentation

1. [Introduction](#introduction)
2. [Installation](#installation)
3. [Settings](#settings)
4. [Shortcode](#shortcode)
5. [Widget](#widget)
6. [Elementor](#elementor)
7. [Dokan](#dokan)
8. [Update](#update)
9. [Support](#support)
10. [Translation](#translation)

***

#### INTRODUCTION <a href="#introduction" id="introduction"></a>

WooThanks, an add-on for the WooCommerce plugin, enables you and your members to get benefit from the generosity of others.

<figure><img src="/files/Ivhn8Ia4NafJD3bLyUxL" alt=""><figcaption></figcaption></figure>

***

#### INSTALLATION <a href="#installation" id="installation"></a>

1. Go to your Codecanyon Download page at <https://codecanyon.net/downloads>
2. Find "**WooThanks - WooCommerce Bonus Plugin**" and download the "**Installable WordPress file only**" zip file.
3. In your WordPress admin panel, navigate to **Plugins > Add New**.
4. Click the "**Upload Plugin**" button and choose the downloaded zip file.
5. Click "**Install Now**" then activate the plugin.

WooThanks relies on the WooCommerce plugin for proper functionality. If the WooCommerce plugin isn't activated, you may encounter an error. In such cases, activating and setting up WooCommerce is required.

***

#### SETTINGS <a href="#settings" id="settings"></a>

Navigate to **WooCommerce > Settings > WooThanks** tab

<figure><img src="/files/yFYFYvELnvkfzNPLfT5N" alt=""><figcaption></figcaption></figure>

By default, only administrator users are eligible to receive bonuses. However, if your website operates as a multi-author or multi-vendor platform, you have the option to enable other members to receive bonuses as well. This can be done by configuring custom roles and/or capabilities in the "**Roles (or capabilities)**" field.

* **Enable**: Enable the Bonus feature globally.
* **Roles (or capabilities)**: Customize the roles and/or capabilities of members eligible to receive bonuses.
* **Buy Form Placement**: Select where you want the buy form to appear relative to the post content. Opting for "custom" allows you to manually place the form in your theme's template.

  <br>

  ```php
  <?php
  if( function_exists( 'woothanks' ) ){
      echo woothanks()->buy_form();
  }
  ?>
  ```
* **Amount Input**: Either "number" or "range".default: Default amount.
* **Minimum Amount**: The lowest value users can set
* **Maximum Amount**: The maximum value users can set.
* **Range Step**: The range field step.
* **Datalist Step**: The step for the datalist, which may be required if "Amount Input" is set to "range".
* **Default Amount**: The default value for the amount.
* **Submit Button Text:** The default text for the submit button, which is "Buy and Send" by default.
* **Submit Button Classes**: The classes for the submit button, with the default being "btn btn-primary".
* **Submit Button Icon**: The default icon for the submit button. Please note that the appearance of this icon may vary depending on your main theme's stylesheet

***

#### SHORTCODE <a href="#shortcode" id="shortcode"></a>

```
[woothanks_buyform]
```

**Parameters**<br>

* **user\_id**
* **amount\_input**
* **default**
* **min**
* **max**
* **step:** The range field step.
* **datalist\_step:** The datalist step, may be necessary if "Amount Input" is set to "range".
* **button\_text:** Button text, default is "Buy and Send".
* **button\_class:** Button classes, default is "btn btn-primary".

For instance

```
[woothanks_buyform user_id="1" default="10" min="5" max="500"]
```

All parameters are automatically applied based on the WooThanks settings

***

#### WIDGET <a href="#widget" id="widget"></a>

Navigate to **Appearance > Widgets** and find "**\[WooThanks] Buy Form**" widget.

***

#### ELEMENTOR <a href="#elementor" id="elementor"></a>

Open Elementor page builder panel and search for "**WooThanks**"<br>

<figure><img src="/files/D4lnwz8Or0mcDLUw6fSu" alt=""><figcaption></figcaption></figure>

***

#### DOKAN <a href="#dokan" id="dokan"></a>

If Dokan is activated, a "**Bonus**" status will appear next to "**Failed**" status within Dokan dashboard > Orders page

<figure><img src="/files/GylfSJBYvn91XRHXAPZX" alt=""><figcaption></figcaption></figure>

***

#### UPDATE <a href="#update" id="update"></a>

We suggest using Envato Market plugin <https://www.envato.com/lp/market-plugin/>

***

#### SUPPORT <a href="#support" id="support"></a>

Feel free to open a ticket on our Custom Support if you need any technical assistance.

<https://phpface.ticksy.com/submit/>

***

#### TRANSLATION <a href="#translation" id="translation"></a>

We suggest using Loco Translate Plugin as it is easy and free for downloading from WordPress Plugin repository

<https://wordpress.org/plugins/loco-translate/>

***

Once again, thank you so much for purchasing WooThanks. As we said at the beginning, we would be glad to help you if you have any questions relating to the plugin, no guarantees, but we will do my best to assist.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://phpface.gitbook.io/woothanks/documentation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.