# WordPress User Feedback - ZuFusion
### WordPress User Feedback
Thank you for purchasing my plugin. If you have any questions that are beyond the scope of this documentation, please feel free to email via my user page contact form [here](http://codecanyon.net/user/zufusion). Thanks so much!
## 1. Introduction
WordPress User Feedback plugin is a great tool to increase the interaction between users and your site.
This plugin empowers users to voice out their opinions to help site admin to improve site content magnificently.
The admin can create / edit / delete / approve / reject feedback.
Also, easy-to-use feedback features that help users manage their feedback easily.
Additionally, statistic widget helps promote the site by highlighting total views, total votes, and total feedback
### Main features:
* Increase the interaction between users and your site by feedback and responses
* Allow users to manage their feedback and share permission
* Allow other users can edit the feedback
* Unlimited feedback for users
* Allow guest to post feedback to the site
* Allow Administrators to manage feedback
* Allow Administrators to manage statuses
* Allow Administrators to manage severities
* The Administrators can create / edit / delete / approve / reject feedback
* Allow automatically approve the feedback created by role
* View feedback detail and the response from admin
* Like comment, share, vote feedback
* Feedback view/download/vote counter
* Widgets: Top Viewed Feedback, Most Discussed Feedback, Statistic, Mot Voted Feedback, Categories, Feedback, Feedback search
* Many configurations in Admin Control Panel: Roles, Settings, Email, etc
* Searching and Sorting Option
* Email notification
* Support BuddyPress group
* Administrators can add feedback to users
* Secure feedback under login for each user
* Email editor to customize all emails
* WordPress capabilities and roles integration to limit who can do what
* Custom templates.
* Template type: Plugin or Theme
* Widget support
* Responsive layout
* Cross Browser (IE11+, Chrome, Safari, Firefox, Opera, Edge, CentBrowser)
* Translation Ready
* Documentation included
## 2. Installation
Download the zipped package from Codecanyon and extract to your desktop. Before processing the installation, you need to upgrade WordPress to WordPress 4.9 or later.
You can use FTP or WordPress to install
#### 2.1 Using WordPress
* Log into your WP dashboard
* Go to **Plugins > Add New > Upload**
* Click Choose File .
* Navigate to find the "wordpress-user-feedback.zip" file in the extracted package.
* Click "Install Now" button.
* Click Active plugin to activate WordPress User Feedback
#### 2.2 Using FTP
* Log into your site via FTP
* Find the "wordpress-user-feedback" folder in the extracted package. Then upload this folder to the **wp-content/plugins** folder in your WordPress directory on your server
* Log Into WordPress and go to **Plugins > Installed Plugins**. Find WordPress User Feedback in the list
* Active "WordPress User Feedback" plugins
## 3. Create category
Click on the **Manage Feedback ->** **Categories** menu item. You will see a welcome screen like this:
## 4. Create status
Click on the **Manage Feedback -> Statuses** menu item. You will see a welcome screen like this:
## 5. Create severity
Click on the **Manage Feedback -> Severities** menu item. You will see a welcome screen like this:
## 6. Manage feedback
After the users submitted the their feedback to your site, the feedback displayed all here to you review the their feedback.
Click on the **Manage Feedback ->** **All Feedback** menu item. You will see a welcome screen like this:
Here, Administrators can toggle **Approved/Featured/Allow vote** status for the feedback without going to edit the detail feedback.
### 6.1 Reject a feedback
If you want to reject a the feedback and send the email notification for reason reject to user, you edit the detail feedback then select **reject** in **Privacy** box.
### 6.2 Approve a feedback
After you reviewed a the feedback and you want to approved the feedback, you edit the detail feedback then select **approved** in **Privacy** box. An approved notification will be sent to user
### 6.3 Answer a feedback
If you want to answer a the feedback to user, you can view feedback detail or go to **Manage Feedback ->** **All Feedback** and click on **Answer** button
An answer box will be displayed here, now if you have any changes to **answer message** or **status** of feedback then an email notification will be sent to user
## 7. Users to manage their feedback
You need to create a **My Feedback** page to users can manage their feedback, Default the plugin will create this page automatically
In which the content of **My Feedback** page will includes the **\[wuf\_my\_feedback]** shortcode to display manage feedback for user
With shortcode you can display anywhere. you can display them in a post/page like this
Finally, you need to set my feedback page for the plugin, Go to **Manage Feedback -> Settings -> Feedback**
### 7.1 All Feedback
All feedback of user will be displayed here, includes the both pending and approved feedback
### 7.2 Pending
All feedback which need to wait administrator review feedback
### 7.3 Approved
All feedback which approved by administrator will be displayed here
### 7.4 Create a feedback
You can allow users to create feedback as guest or require logged in, you can setting this in settings page. To create a new feedback you go to my feedback page at frontend.
Now click on **Create Guest Feedback** button or **Click here** to create new a feedback
You fill all required fields in feedback form then click on **Submit** button to submit the feedback to server, an email notification will be sent to administrators for reviewing the feedback .
### 7.5 Update a feedback
Go to My Feedback to find out any feedback you want to edit , click on **Edit** button.
Administrator can allow/disable the ability of Edit/Delete their own feedback in the **settings** page
## 8. Feedback Home Page
This page will list out all feedback created by all users, You need to create a **Feedback** page to display feedback, Default the plugin will create this page automatically
Now, you need to set **Feedback page** for the plugin, Go to **Manage Feedback -> Settings -> Feedback**
Set Feedback page such as
> You can use \[wuf\_feedback] shortcode to display list feedback on any pages
## 9. Template type
The plugin allow you load template of plugin or your theme with template type is **Plugin** or **Theme.**
* **Plugin**: Load template base on the plugin
* **Theme**: Load template base on your theme
When you use **Plugin** it will load template base on the plugin, in this case, the layout structure will not be exactly the same as the layout of the theme
When you use **Theme** it will load template base on your theme to display but you need to set overwrite sidebar to replace with Feedback sidebar. of source, it only replace when you view list feedback or single feedback, ...
## 10. Roles
Go to **Manage Feedback > Settings -> Roles**.
The plugin use WordPress capabilities and roles integration to limit who can do what
## 11. Settings
Go to **Manage Feedback > Settings**. the plugin allows to configure feedback, roles, template, email, ...
## 12. The Plugin Template
### 12.1 Default Templates
The plugins allow use template for display layout, so you can custom template easily
You can see in the folder **{root}/wp-content/plugins/wordpress-user-feedback/templates/**
### 12.2 Custom Template
The plugin support overwrite, custom template from default template. You only create a **wordpress-user-feedback** in the root of activating theme. Copy the template of the plugin you need to custom to here and change what you want to
### 12.3 Hook template
The plugin use action hook to render template, here is some basic actions, you can view some template of the plugin to know more actions
#### 12.3.1 Single template
```
```
#### 12.3.2 Archive template
```
```
## 13. Hooks: Actions and filters
#### Introduction: What are hooks?
Hooks in WordPress essentially allow you to change or add code without editing core files. They are used extensively throughout WordPress and WordPress User Feedback and are very useful for developers.
There are two types of hook: actions and filters.
* **Action** Hooks allow you to insert custom code at various points (wherever the hook is run).
* **Filter** Hooks allow you to manipulate and return a variable which it passes
#### Using hooks
If you use a hook to add or manipulate code, you can add your custom code in a variety of ways:
* To a [custom child theme’s `functions.php` file](https://developer.wordpress.org/themes/advanced-topics/child-themes/).
* Using a plugin such as [Code Snippets](https://wordpress.org/plugins/code-snippets/).
#### Using action hooks
To execute your own code, you hook in by using the action hook `do_action('action_name');`. Here is where to place your code:
```
add_action( 'action_name', 'your_function_name' );
function your_function_name() {
// Your code
}
```
#### Using filter hooks
Filter hooks are called throughout are code using `apply_filter( 'filter_name', $variable );`. To manipulate the passed variable, you can do something like the following:
```
add_filter( 'filter_name', 'your_function_name' );
function your_function_name( $variable ) {
// Your code
return $variable;
}
```
With filters, you must return a value.
## 14. Hooks: The plugin supported
The developer can use these hooks function to customize display, fields, build query, ....
### Actions:
* do\_action( 'wuf\_before\_container' )
* do\_action( 'wuf\_sidebar\_left' )
* do\_action( 'wuf\_before\_main\_content' )
* do\_action( 'wuf\_before\_feedback\_loop' )
* do\_action( 'wuf\_feedback\_in\_loop' )
* do\_action( 'wuf\_after\_feedback\_loop' )
* do\_action( 'wuf\_no\_feedback\_found' )
* do\_action( 'wuf\_after\_main\_content' )
* do\_action( 'wuf\_sidebar\_right' )
* do\_action( 'wuf\_after\_container' )
* do\_action('wuf\_save\_settings');
* do\_action( 'wuf\_query', $q, $this )
* do\_action( "wuf\_feedback\_shortcode\_before\_{$this->type}\_wrapper", $this->attributes );
* do\_action( "wuf\_feedback\_shortcode\_before\_{$this->type}\_loop", $this->attributes );
* do\_action( 'wuf\_feedback\_before\_loop' );
* do\_action( 'wuf\_feedback\_after\_loop' );
* do\_action( "wuf\_feedback\_shortcode\_after\_{$this->type}\_loop", $this->attributes );
* do\_action( "wuf\_feedback\_shortcode\_{$this->type}\_loop\_no\_results", $this->attributes );
* do\_action( "wuf\_feedback\_shortcode\_after\_{$this->type}\_wrapper", $this->attributes );
* do\_action( 'wuf\_archive\_main\_header' );
* do\_action( 'wuf\_archive\_description' );
* do\_action( 'wuf\_feedback\_navigation' );
* do\_action( 'wuf\_feedback\_content' );
* do\_action( 'wuf\_feedback\_home\_start' );
* do\_action( 'wuf\_feedback\_home\_end' );
### Filters:
* apply\_filters( 'wuf\_default\_options', $defaults )
* apply\_filters('wuf\_enable\_theme\_support', $is\_template\_plugin)
* apply\_filters( 'wuf\_get\_template\_part', $template, $slug, $name )
* apply\_filters( 'wuf\_template\_path', 'wordpress-user-feedback/' )
* apply\_filters( 'wuf\_get\_template', $file, $template )
* apply\_filters( 'wuf\_visited\_url', $url )
* apply\_filters( 'wuf\_message\_notice', $messagewrapstart . $message . $messagewrapend, $action, $message, $messagewrapstart, $messagewrapend )
* apply\_filters( 'wuf\_main\_class', $class, $sidebar )
* apply\_filters( 'wuf\_sidebar\_class', $class )
* apply\_filters( 'wuf\_sidebar\_main', $wuf\_settings->get\_input\_value( 'sidebar', 'sidebar' ) )
* apply\_filters( 'wuf\_sidebar\_single', $wuf\_settings->get\_input\_value( 'sidebar\_single', 'sidebar' ) )
* apply\_filters( 'wuf\_sidebar\_value', $sidebar, $sidebar\_main, $sidebar\_single )
* apply\_filters( 'wuf\_page\_title', $page\_title )
* apply\_filters( 'wuf\_is\_feedback', wuf\_is\_feedback\_post\_type() || wuf\_is\_feedback\_taxonomy() || wuf\_is\_single\_feedback() || wuf\_is\_author\_feedback())
* apply\_filters( 'wuf\_is\_search', isset($\_GET\['wuf\_search']) )
* apply\_filters( 'wuf\_get\_' . $page . '\_page\_id', $page\_id )
* apply\_filters( 'wuf\_feedback\_loop\_start', ob\_get\_clean() )
* apply\_filters( 'wuf\_feedback\_loop\_end', ob\_get\_clean() )
* apply\_filters( 'post\_class', $post\_classes, $class, $feedback->get\_id() )
* apply\_filters( 'wuf\_feedback\_post\_class', $classes, $feedback )
* apply\_filters( 'wuf\_loop\_feedback\_rows', $rows )
* apply\_filters( 'wuf\_loop\_feedback\_columns', $columns )
* apply\_filters( 'wuf\_get\_' . $page . '\_page\_permalink', $permalink )
* apply\_filters( 'wuf\_get\_endpoint\_url', $url, $endpoint, $value, $permalink )
* apply\_filters( 'wuf\_sortby\_options', $sor\_options )
* apply\_filters( 'wuf\_range\_date\_options', $range\_date\_options )
* apply\_filters( 'wuf\_reject\_feed\_message', $mail\_body, $feed\['ID'] )
* apply\_filters( 'wuf\_approved\_feed\_message', $mail\_body, $feed\['ID'] )
* apply\_filters( 'wuf\_answer\_feed\_message', $mail\_body, $feed\['ID'] )
* apply\_filters( 'wuf\_admin\_new\_feed\_message', $mail\_body, $feed\['ID'] )
* apply\_filters( 'wuf\_admin\_update\_feed\_message', $mail\_body, $feed\['ID'] )
* apply\_filters( 'wuf\_get\_query\_vars', $this->query\_vars )
* apply\_filters( 'wuf\_default\_feedback\_orderby', $wuf\_settings->get\_input\_value( 'default\_feedback\_sortby', 'latest' ) )
* apply\_filters( 'wuf\_get\_catalog\_ordering\_args', $args, $orderby, $order )
* apply\_filters( 'wuf\_feedback\_query\_meta\_query', $meta\_query, $this )
* apply\_filters( 'wuf\_feedback\_query\_tax\_query', $tax\_query, $this )
* apply\_filters( 'wuf\_feedback\_query\_comment\_tax\_query', $tax\_query, $this )
* apply\_filters( 'wuf\_feedback\_query\_comment\_tax\_query', $tax\_query, $this )
* apply\_filters( 'wuf\_default\_range\_date', $wuf\_settings->get\_input\_value( 'default\_range\_date', 'all' ) )
* apply\_filters( 'wuf\_feedback\_query\_date\_query', $date\_query, $this )
* apply\_filters( 'wuf\_shortcode\_feedback\_query', $query\_args, $this->attributes, $this->type )
* apply\_filters( 'wuf\_feedback\_query\_max\_rand\_cache\_count', 5 )
* apply\_filters( 'wuf\_feedback\_filters', $output )
* apply\_filters( 'wuf\_load\_font\_awesome', $wuf\_settings->get\_input\_value( 'load\_fontawesome', 'yes' ), $wuf, $wuf\_settings )
* apply\_filters( 'wuf\_load\_grid', $wuf\_settings->get\_input\_value( 'load\_bootstrap\_grid', 'yes' ), $wuf, $wuf\_settings )
* apply\_filters( 'wuf\_delete\_redirect', wuf\_get\_page\_permalink( 'my-feedback' ) )
* apply\_filters( 'wuf\_show\_page\_title', true )
* apply\_filters( 'wuf\_table\_rows\_per\_page', 15 )
## 15. Credits & resources
1. [jQuery](http://jquery.com/)
2. [jQuery UI](https://jqueryui.com/)
3. [Bootstrap 4](https://getbootstrap.com/)
4. [Bootstrap Grid](https://github.com/dmhendricks/bootstrap-grid-css)
5. [fontawesome](https://fontawesome.com/icons?d=gallery)
6.
7. [Select 2](https://select2.github.io)
8. [Magnific Popup](http://dimsemenov.com/plugins/magnific-popup/)
9. [Amsify Suggestags](https://github.com/amsify42/jquery.amsify.suggestags)