edd_review<\/code><\/li>\n- Add two new comment meta keys:
edd_review_approved<\/code> and\u00a0edd_review_reply<\/code>.\u00a0edd_review_approved<\/code> just copies the value of the comment_approved<\/code>\u00a0field from the wp_comments\u00a0table and edd_review_reply<\/code> is only added for\u00a0replies which were made to reviews. The plugin makes use of\u00a0edd_review_approved<\/code>\u00a0for the comment status instead of the WordPress comment_approved<\/code> field due to the way WordPress counts comments; it would cause the comment unread count to be incorrect.<\/li>\n<\/ul>\nWhen first updating to Reviews 2.0, the following admin notice will be displayed:<\/p>\n
![\"Screen](\"https:\/\/easydigitaldownloads.com\/development\/files\/2016\/06\/Screen-Shot-2016-07-08-at-20.58.55.png\")
<\/p>\n
Following the link will begin the database upgrade and the\u00a0upgrade routines described above wit<\/p>\n
Moving away from the WordPress Comment Form<\/h3>\n
There are a huge number of improvements in 2.0 in the way reviews are handled. Up until now, we have been extending\u00a0the WordPress comment_form<\/code> by enabling support for comments on all downloads. In\u00a02.0, we hook on to the the_content<\/code>\u00a0filter and display a custom form to submit reviews along with a custom Walker to display all the reviews.<\/p>\nThe form displayed in Reviews 1.3.10 looks like this:<\/p>\n
![\"Screen](\"https:\/\/easydigitaldownloads.com\/development\/files\/2016\/06\/Screen-Shot-2016-07-08-at-21.04.09.png\")
<\/p>\n
The new form coming to Reviews 2.0, looks like this:<\/p>\n
![\"Screen](\"https:\/\/easydigitaldownloads.com\/development\/files\/2016\/06\/Screen-Shot-2016-07-08-at-21.04.26.png\")
<\/p>\n
As you can see, the standard WordPress comment form is displayed beneath\u00a0the\u00a0review submission form. \u00a0It should be noted that the comment form is only displayed if\u00a0comments have been enabled on the Downloads post type.<\/p>\n
There is very minimal\u00a0styling applied to the form, in fact, only one CSS rule is applied which is:
\n
\n.edd-reviews-form label {
\ndisplay: inline-block;
\nwidth: 150px;
\n}
\n<\/code><\/p>\nThis rule just ensures that the labels and inputs line up. \u00a0Besides that,\u00a0any\u00a0global styling applied to input fields will be inherited from your theme.<\/p>\n
In terms of the markup changes for the reviews form, this is an example of the markup\u00a0for the review form:<\/p>\n
https:\/\/gist.github.com\/sunnyratilal\/e7ccfbe2e83a4e322e2bf745a58d5ab2<\/p>\n
This change\u00a0not only makes the submission form more reliable, it also means that download products can now have reviews and comments enabled at the same time.<\/p>\n
Please note: the markup has changed significantly from Reviews 1.x so\u00a0themes\u00a0that\u00a0had specific styling for Reviews should be tested<\/strong><\/p>\nAll reviews now have a comment type of\u00a0edd_review\u00a0and are still stored in the wp_comments table. \u00a0They are filtered out from the\u00a0WP_Comment_Query and other queries. If\u00a0you\u00a0currently query for\u00a0reviews using get_comments, you need to remove the actions and filters which stop reviews and replies to reviews being queried.\u00a0An example of querying reviews can be done\u00a0as follows:<\/p>\n
https:\/\/gist.github.com\/sunnyratilal\/7d814cd99d0ea006355d01afea1a4d8f<\/p>\n
If you are doing custom\u00a0querying of\u00a0reviews, you must ensure to add the\u00a0actions and filters\u00a0after the get_comments call to\u00a0ensure reviews are not tied in with\u00a0comments.<\/p>\n
Replies made to reviews have also been\u00a0adjusted, they also follow the comment type of edd_review<\/code> but have a meta key\u00a0attached to them entitled edd_review_reply<\/code> and it has a value of 1.<\/p>\nAll reviews are displayed using a new Walker created:\u00a0Walker_EDD_Review. The reviews are still displayed by making a call to\u00a0wp_list_comments, the only thing\u00a0different is the Walker which traverses over the reviews.<\/p>\n
In the WordPress Dashboard, all reviews are now displayed on a new page which is located at Downloads > Reviews.\u00a0No\u00a0reviews will be\u00a0displayed on the Comments admin page. The output of the review is\u00a0controlled by the\u00a0EDD_Reviews_List_Table class.<\/p>\n
Improved API Output Data<\/h3>\n
Changes have been made to the\u00a0data that is output\u00a0when querying the reviews endpoint on the EDD API.<\/p>\n
New keys that have been added:<\/p>\n
\nparent<\/code>: displays the ID of the parent review (only valid for replies)<\/li>\ntype<\/code>: displays the type of the review: whether it’s a review or a reply<\/li>\n<\/ul>\nThe output has changed so that null is displayed if a review doesn’t have a title or a rating rather than just displaying a blank\u00a0string. The same applies for votes: if no votes have been cast for a review, the votes key is\u00a0simply set to null\u00a0with no ‘yes’ and ‘no’ sub-keys.<\/p>\n
Here is an example of the data output by the API in Reviews 2.0:<\/p>\n
![\"Screen](\"https:\/\/easydigitaldownloads.com\/development\/files\/2016\/06\/Screen-Shot-2016-07-08-at-21.07.45.png\")
<\/p>\n
The first JSON\u00a0element is of a reply to a\u00a0review as can be distinguished by it having a\u00a0value of reply<\/code> for the type<\/code> key. You can also see that the votes<\/code> key has a value of null<\/code> as replies\u00a0do not have the voting feature. \u00a0The second JSON element has a type<\/code> of review<\/code> as well as a title<\/code>\u00a0key which has a value as well as having sub-keys for the votes<\/code> key.<\/p>\nIntegration with Frontend Submissions<\/h3>\n
Reviews now work alongside Frontend Submissions\u00a0by allowing\u00a0a much requested feature:\u00a0Vendor Feedback. \u00a0All the code to integrates FES is stored under includes\/class-edd-reviews-fes-integration.php<\/code>.<\/p>\nA link is added to the Purchase History table to allow vendor feedback to be supplied. The labels\u00a0can be changed using the templates and the Reviews settings under Downloads > Settings > Extensions\u00a0> Reviews.<\/p>\n
![\"Screen](\"https:\/\/easydigitaldownloads.com\/development\/files\/2016\/06\/Screen-Shot-2016-07-08-at-21.15.32.png\")
<\/p>\n
Upon installing Reviews,\u00a0a new page is created called Vendor Feedback, this page has a shortcode which\u00a0renders the feedback submission form. \u00a0The form looks like this:<\/p>\n
![\"Screen](\"https:\/\/easydigitaldownloads.com\/development\/files\/2016\/06\/Screen-Shot-2016-07-08-at-21.16.45.png\")
<\/p>\n
All Vendor Feedback can be viewed from the FES\u00a0Vendor Dashboard:<\/p>\n
![\"Screen](\"https:\/\/easydigitaldownloads.com\/development\/files\/2016\/06\/Screen-Shot-2016-07-08-at-21.23.36.png\")
<\/p>\n
Administrators can view all\u00a0Vendor Feedback by going to\u00a0EDD FES > Vendor Feedback within the\u00a0WordPress Admin interface. \u00a0It’s all displayed in a list table, as such:<\/p>\n
![\"Screen](\"https:\/\/easydigitaldownloads.com\/development\/files\/2016\/06\/Screen-Shot-2016-07-08-at-21.14.58.png\")
<\/p>\n
Vendor Feedback is stored with an edd_vendor_feedback<\/code> comment type in the comments table and, similar to reviews, is hidden from the WordPress Comments Query. \u00a0When querying vendor feedback, use a similar approach to above\u00a0and just change the callback to array( edd_reviews()->fes, 'hide_feedback' )<\/code>.<\/p>\nNew Templating<\/h3>\n
Similar to Easy Digital Downloads, we have introduced a\u00a0template system to allow easy modifications to certain elements of the plugins. These\u00a0files are located in the templates folder of\u00a0the plugin directory.<\/p>\n
Template files bundled with the plugin are:<\/p>\n
\nreviews-fes-vendor-feedback.php<\/code>:\u00a0This template\u00a0is used to render\u00a0all the\u00a0Vendor Feedback submitted. \u00a0The output generated by this template is on the Vendor Feedback page of the FES\u00a0Vendor\u00a0Dashboard.<\/li>\nreviews-reply.php<\/code>: This template\u00a0builds the reply form\u00a0which is\u00a0displayed when replying to a review<\/li>\nreviews.php<\/code>: This template is\u00a0used for displaying the reviews and the review submission form<\/li>\nshortcode-vendor-feedback.php<\/code>:\u00a0This template\u00a0handles the output of the [edd_vendor_feedback]<\/code> shortcode and displays the form used to submit vendor feedback<\/li>\n<\/ul>\nAll the templates bundled with the plugin can be edited by creating a file of the same name under the edd_templates folder of your active theme. \u00a0The\u00a0file inside the edd_templates<\/code> folder will override the file bundled in the plugin.<\/p>\nUpdated Widgets and Shortcodes<\/h3>\n
The markup for the widgets and shortcodes has been altered\u00a0to follow the same markup as a review displayed under\u00a0downloads.<\/p>\n
Featured Review Widget<\/strong><\/p>\nhttps:\/\/gist.github.com\/sunnyratilal\/0f1067984f860c8906a712967edf89c1<\/p>\n
The updated widget will be displayed like this:<\/p>\n
![\"Screen](\"https:\/\/easydigitaldownloads.com\/development\/files\/2016\/06\/Screen-Shot-2016-07-08-at-21.12.07.png\")
<\/p>\n
Per Product Reviews Widget<\/strong><\/p>\nhttps:\/\/gist.github.com\/sunnyratilal\/26edcf6f5edc9a9de95ede937b6354e2<\/p>\n
The updated widget will be displayed like this:<\/p>\n
![\"Screen](\"https:\/\/easydigitaldownloads.com\/development\/files\/2016\/06\/Screen-Shot-2016-07-08-at-21.13.06.png\")
<\/p>\n
Recent Reviews<\/strong><\/p>\nhttps:\/\/gist.github.com\/sunnyratilal\/817912f590a395c278216369b8af23b7<\/p>\n
The updated\u00a0widget will be displayed exactly like the Per Product Review widget.<\/p>\n
Review Shortcode<\/strong><\/p>\nNote: previous custom\u00a0styling for the review shortcode has been removed and has been replaced with a very simple CSS\u00a0rule to add a border\u00a0around the review with some padding and a margin.<\/strong><\/p>\nhttps:\/\/gist.github.com\/sunnyratilal\/499ce552b314102b0fe3385a6dd74959<\/p>\n
As you can see from the above snippets, the markup is now consistent across all widgets and shortcodes but this all means that custom styling previous\u00a0applied to the widgets and shortcode will break and again, as aforementioned, themes will need to be tested.<\/p>\n
Other Notable Fixes\/Changes<\/h3>\n\n- TinyMCE widget to embed reviews into posts has been rewritten\u00a0and redesigned to work better with the WordPress Editor<\/li>\n
- HTML 5 microdata\u00a0has been fixed and validated<\/li>\n
- Markup to display the star rating for each rating has been changed from using images to using\u00a0WordPress Dashicons.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"
Easy Digital Downloads Reviews version 2.0 is getting close to being ready. There are numerous significant improvements in 2.0 which change the way reviews will be handled and displayed. We encourage all theme and plugin developers to familiarize themselves with the important changes coming.<\/p>\n","protected":false},"author":650,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[3],"tags":[12],"class_list":["post-78","post","type-post","status-publish","format-standard","hentry","category-extensions","tag-reviews"],"_links":{"self":[{"href":"https:\/\/easydigitaldownloads.com\/development\/wp-json\/wp\/v2\/posts\/78","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/easydigitaldownloads.com\/development\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/easydigitaldownloads.com\/development\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/easydigitaldownloads.com\/development\/wp-json\/wp\/v2\/users\/650"}],"replies":[{"embeddable":true,"href":"https:\/\/easydigitaldownloads.com\/development\/wp-json\/wp\/v2\/comments?post=78"}],"version-history":[{"count":2,"href":"https:\/\/easydigitaldownloads.com\/development\/wp-json\/wp\/v2\/posts\/78\/revisions"}],"predecessor-version":[{"id":1116,"href":"https:\/\/easydigitaldownloads.com\/development\/wp-json\/wp\/v2\/posts\/78\/revisions\/1116"}],"wp:attachment":[{"href":"https:\/\/easydigitaldownloads.com\/development\/wp-json\/wp\/v2\/media?parent=78"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/easydigitaldownloads.com\/development\/wp-json\/wp\/v2\/categories?post=78"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/easydigitaldownloads.com\/development\/wp-json\/wp\/v2\/tags?post=78"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}