forked from cabrerahector/wordpress-popular-posts
-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
183 lines (134 loc) · 9.63 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
=== WordPress Popular Posts ===
Contributors: hcabrera
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=hcabrerab%40gmail%2ecom&lc=GB&item_name=WordPress%20Popular%20Posts%20Plugin¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG_global%2egif%3aNonHosted
Tags: popular, posts, widget, popularity, top
Requires at least: 4.1
Tested up to: 4.8.2
Stable tag: 4.0.7
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
A highly customizable, easy-to-use popular posts widget!
== Description ==
WordPress Popular Posts is a highly customizable widget that displays your most popular posts.
= Main Features =
* **Multi-widget capable** - You can have several widgets of WordPress Popular Posts on your blog, each with its own settings!
* **Time Range** - List those posts of your blog that have been the most popular ones within a specific time range (eg. last 24 hours, last 7 days, last 30 days, etc)!
* **Custom Post-type support** - Wanna show other stuff than just posts and pages?
* **Thumbnails!** - Display a thumbnail of your posts! (*see the [FAQ section](http://wordpress.org/extend/plugins/wordpress-popular-posts/faq/) for technical requirements*.)
* **Statistics dashboard** - See how your popular posts are doing directly from your admin area.
* **Sorting options** - Order your popular list by comments, views (default) or average views per day!
* **Use your own layout!** - WPP is flexible enough to let you customize the look and feel of your popular posts! (see [customizing WPP's HTML markup](https://github.com/cabrerahector/wordpress-popular-posts/wiki/5.-FAQ#how-can-i-use-my-own-html-markup-with-your-plugin) and [How to style WordPress Popular Posts](https://github.com/cabrerahector/wordpress-popular-posts/wiki/6.-Styling-the-list) for more.)
* **Disqus support** - Sort your popular posts by Disqus comments count!
* **Polylang & WPML support!**
* **WordPress Multisite support** - Each site on the network can have its own popular posts!
= Other Features =
* **Shortcode support** - Use the [wpp] shortcode to showcase your most popular posts on pages, too! For usage and instructions, please refer to the [installation section](http://wordpress.org/extend/plugins/wordpress-popular-posts/installation/).
* **Template tags** - Don't feel like using widgets? No problem! You can still embed your most popular entries on your theme using the *wpp_get_mostpopular()* template tag. Additionally, the *wpp_get_views()* template tag allows you to retrieve the views count for a particular post. For usage and instructions, please refer to the [installation section](http://wordpress.org/extend/plugins/wordpress-popular-posts/installation/).
* **Localization** - Translate WPP to your own language (*See the [FAQ section](http://wordpress.org/extend/plugins/wordpress-popular-posts/faq/) for more info*).
* **[WP-PostRatings](http://wordpress.org/extend/plugins/wp-postratings/) support** - Show your visitors how your readers are rating your posts!
**WordPress Popular Posts** is now also on [GitHub](https://github.com/cabrerahector/wordpress-popular-posts)!
== Installation ==
Please make sure your site meets the [minimum requirements](https://github.com/cabrerahector/wordpress-popular-posts#requirements) before proceeding.
= Automatic installation =
1. Log in into your WordPress dashboard.
2. Go to Plugins > Add New.
3. In the "Search Plugins" field, type in **WordPress Popular Posts** and hit Enter.
4. Find the plugin in the search results list and click on the "Install Now" button.
= Manual installation =
1. Download the plugin and extract its contents.
2. Upload the `wordpress-popular-posts` folder to the `/wp-content/plugins/` directory.
3. Activate the **WordPress Popular Posts** plugin through the "Plugins" menu in WordPress.
= Done! What's next? =
1. Go to Appearance > Widgets, drag and drop the **WordPress Popular Posts** widget to your sidebar. Once you're done configuring it, hit the Save button.
2. If you have a caching plugin installed on your site, flush its cache now so WPP can start tracking your site.
3. Go to Appearance > Editor. Under "Templates", click on `header.php` and make sure that the `<?php wp_head(); ?>` tag is present (should be right before the closing `</head>` tag).
4. (Optional, but highly recommended for large / high traffic sites) Enabling [Data Sampling](https://github.com/cabrerahector/wordpress-popular-posts/wiki/7.-Performance#data-sampling) and/or [Caching](https://github.com/cabrerahector/wordpress-popular-posts/wiki/7.-Performance#caching) might be a good idea. Check [here](https://github.com/cabrerahector/wordpress-popular-posts/wiki/7.-Performance) for more.
That's it!
= USAGE =
WordPress Popular Posts can be used in three different ways:
1. As a [widget](http://codex.wordpress.org/WordPress_Widgets): simply drag and drop it into your theme's sidebar and configure it.
2. As a template tag: you can place it anywhere on your theme with [wpp_get_mostpopular()](https://github.com/cabrerahector/wordpress-popular-posts/wiki/2.-Template-tags#wpp_get_mostpopular).
3. Via [shortcode](https://github.com/cabrerahector/wordpress-popular-posts/wiki/1.-Using-WPP-on-posts-&-pages), so you can embed it inside a post or a page.
Make sure to stop by the **[Wiki](https://github.com/cabrerahector/wordpress-popular-posts/wiki)** as well, you'll find even more info there!
== Frequently Asked Questions ==
The FAQ section has been moved [here](https://github.com/cabrerahector/wordpress-popular-posts/wiki/5.-FAQ).
== Screenshots ==
1. Widgets Control Panel.
2. WordPress Popular Posts Widget.
3. WordPress Popular Posts Widget on theme's sidebar.
4. WordPress Popular Posts Stats panel.
== Changelog ==
= 4.0.6 =
- Improves compatibility with Multisite.
- Fixes a bug that prevented upgrade process from running on MU (props Greg Sullivan!)
- Improves compatibility with Beaver Builder.
= 4.0.5 =
- Fixes the taxonomy filter for Custom Post Types.
- Updates summary table structure and indexes.
- Adds back ability to use custom wpp.css from theme.
- Dashboard: adds a Debug screen to help with support inquiries.
- Other minor bug fixes and improvements.
= 4.0.3 =
**This is a hotfix release.**
- Dashboard: escapes post titles to prevent potential XSS (props Delta!)
- Restores ability to use a custom default thumbnail.
= 4.0.2 =
**This is a hotfix release.**
- Dashboard: fixes thumbnail picker on HTTPS.
- Adds the wpp_custom_html filter back.
= 4.0.1 =
**This is a hotfix release.**
- Fixes a warning message triggered on old PHP versions.
- Fixes undefined default_thumbnail_sizes warning message.
- Removes a hardcoded table prefix causing issues on sites that uses a different prefix than the stock one.
= 4.0.0 =
**If you're using a caching plugin, flushing its cache after installing / upgrading to this version is highly recommended.**
- Plugin code refactored!
- Dashboard section redesigned (now mobile-friendly, too!)
- New Statistics chart and other goodies.
- Adds ability to pick a Custom Time Range!
- Adds ability to filter posts by other taxonomies than just categories!
- Adds Relative Date Format.
- Fixes broken views tracking caused by changeset 41508 https://core.trac.wordpress.org/changeset/41508 (props hykw!)
- Improves PHP7+ compatibility.
- Improves compatibility with WP-SpamShield, WooCommerce, Polylang and WPML.
- Drops qTranslate support (that plugin has been long removed from WordPress.org anyways.)
- New content tags added: {img_url}, {taxonomy}.
- New filters: wpp_post_class, wpp_post_exclude_terms.
- French and German translation files became too outdated and so support has been dropped for now (want to help? Contact me!)
- Tons of minor bug fixes and improvements.
Also, see [Release notes](https://cabrerahector.com/development/wordpress-popular-posts-4-0-is-finally-out/).
= 3.3.4 =
- Attempt to convert tables to InnoDB during upgrade if other engine is being used.
- Adds a check to prevent the upgrade process from running too many times.
- Minor improvements and bug fixes.
- Documentation updated.
= 3.3.3 =
- Fixes potential XSS exploit in WPP's admin dashboard.
- Adds filter to set which post types should be tracked by WPP ([details](https://github.com/cabrerahector/wordpress-popular-posts/wiki/3.-Filters#wpp_trackable_post_types)).
- Adds ability to select first attached image as thumbnail source (thanks, [@serglopatin](https://github.com/serglopatin)!)
= 3.3.2 =
- Fixes warning message: 'stream does not support seeking in...'
- Removes excerpt HTML encoding.
- Passes widget ID to the instance variable for customization.
- Adds CSS class current.
- Documentation cleanup.
- Other minor bug fixes / improvements.
= 3.3.1 =
- Fixes undefined index notice.
- Makes sure legacy tables are deleted on plugin upgrade.
= 3.3.0 =
- Adds the ability to limit the amount of data logged by WPP (see Settings > WordPress Popular Posts > Tools for more).
- Adds Polylang support (thanks, [@Chouby](https://github.com/Chouby)!)
- Removes post data from DB on deletion.
- Fixes whitespaces from post_type argument (thanks, [@getdave](https://github.com/getdave)!)
- WPP now handles SSL detection for images.
- Removes legacy datacache and datacache_backup tables.
- Adds Settings page advertisement support.
- FAQ section has been moved over to Github.
See [full changelog](https://github.com/cabrerahector/wordpress-popular-posts/blob/master/changelog.md).
== Credits ==
* Flame graphic by freevector/Vecteezy.com.
== Upgrade Notice ==
= 4.0.6 =
If you're using a caching plugin, flush its cache before upgrading to this version.