top-10 / README.md

README.md in WebberZone Top 10 — Popular Posts 4.4.3, at README.md

153 lines 10.3 KB

Raw Download Zip

1	# WebberZone Top 10 Pro — Popular Posts
2
3	[](https://wordpress.org/plugins/top-10/![Top 10](https://raw.githubusercontent.com/WebberZone/top-10/master/wporg-assets/banner-1544x500.png)](https://wordpress.org/plugins/top-10/](https://wordpress.org/plugins/top-10/)
4
5	[](https://wordpress.org/plugins/top-10/![WordPress Plugin Version](https://img.shields.io/wordpress/plugin/v/top-10.svg?style=flat-square)](https://wordpress.org/plugins/top-10/](https://wordpress.org/plugins/top-10/)
6	[](https://opensource.org/licenses/GPL-2.0![License](https://img.shields.io/badge/license-GPL_v2%2B-orange.svg?style=flat-square)](https://opensource.org/licenses/GPL-2.0](https://opensource.org/licenses/GPL-2.0)
7	[](https://wordpress.org/plugins/top-10/![WordPress Tested](https://img.shields.io/wordpress/v/top-10.svg?style=flat-square)](https://wordpress.org/plugins/top-10/](https://wordpress.org/plugins/top-10/)
8	[](https://wordpress.org/plugins/top-10/![Required PHP](https://img.shields.io/wordpress/plugin/required-php/top-10?style=flat-square)](https://wordpress.org/plugins/top-10/](https://wordpress.org/plugins/top-10/)
9	[](https://wordpress.org/plugins/top-10/![Active installs](https://img.shields.io/wordpress/plugin/installs/top-10?style=flat-square)](https://wordpress.org/plugins/top-10/](https://wordpress.org/plugins/top-10/)
10
11	__Requires:__ 6.6
12
13	__Tested up to:__ 7.0
14
15	__Requires PHP:__ 7.4
16
17	__License:__ [](http://www.gnu.org/licenses/gpl-2.0.htmlGPL-2.0+](http://www.gnu.org/licenses/gpl-2.0.html](http://www.gnu.org/licenses/gpl-2.0.html)
18
19	__Plugin page:__ [](https://webberzone.com/plugins/top-10/Top 10](https://webberzone.com/plugins/top-10/](https://webberzone.com/plugins/top-10/) \| [](https://wordpress.org/plugins/top-10/WordPress.org plugin page](https://wordpress.org/plugins/top-10/](https://wordpress.org/plugins/top-10/)
20
21	Track post views and page views, and display popular posts and trending content on your WordPress site.
22
23	## Description
24
25	WordPress lacks built-in page view tracking or a popular posts feature. [](https://webberzone.com/plugins/top-10/Top 10](https://webberzone.com/plugins/top-10/](https://webberzone.com/plugins/top-10/) solves this by counting views across posts, pages, and custom post types, then letting you showcase your most popular content.
26
27	Top 10 provides blocks, widgets, shortcodes, and template functions for displaying popular posts and view counts across your site. All tracking data is stored locally in your WordPress database, with no external services involved.
28
29	Top 10 includes comprehensive features such as thumbnail support, flexible display options, custom post type support, and developer-friendly extensibility. A built-in caching layer reduces server load, while AJAX-based tracking avoids page cache interference and works with most popular caching plugins.
30
31	Top 10 also exposes a powerful API with WordPress actions and filters, allowing developers to customise queries, tracking behaviour, and output rendering without modifying core plugin files.
32
33	### Features
34
35	* __Page Counter__: Tracks hourly post views on posts, pages, and custom post types. Display counts automatically using blocks, shortcodes, or template functions
36	* __Popular Posts__: Display most viewed posts by total counts or within custom time periods
37	* __Gutenberg Support__: Dedicated "Popular Posts [Top 10]" block with configurable display options
38	* __Multisite Dashboard__: Network-wide aggregated statistics across all sites in a multisite installation
39	* __Widgets__: Sidebar widgets for daily and overall popular posts with extensive customisation
40	* __Shortcodes__: Use `[tptn_list]` to display popular post lists and `[tptn_views]` to show view counts
41	* __Thumbnails__:
42	* WordPress post thumbnail support with custom `tptn_thumbnail` image size
43	* Automatic extraction of the first image from post content
44	* Manual thumbnail URLs via Edit Post screens
45	* __Exclusions__: Exclude posts by category or post ID from popular post lists
46	* __Styling__: Output wrapped in semantic CSS classes. Add custom CSS via settings or use included styles
47	* __Admin Interface__: View daily and overall popular posts from the dashboard. Adds sortable view-count columns to post and page lists
48	* __Export/Import__: Export count tables and settings, and restore them on the same site or other installs
49	* __Caching Compatibility__: Works with WP Super Cache, W3 Total Cache, Quick Cache, and similar plugins
50	* __Developer-Friendly__: Extensive filters and actions to customise queries, tracking behaviour, and output rendering
51
52	### Features in Top 10 Pro
53
54	* __Enhanced Tracking and Performance__
55	* __Fast and High-Traffic Trackers__: Alternative tracking methods for improved performance on busy sites
56	* __Buffered Visit Tracking__: Every page view is written to a lightweight funnel table first, then aggregated into the count tables by a background cron job every 5 minutes. This eliminates write contention on high-traffic posts where many simultaneous visitors would otherwise compete to update the same row
57	* __Query Optimisation__: MySQL `MAX_EXECUTION_TIME` directive to prevent long-running queries, configurable via settings and the `top_ten_query_max_execution_time` filter
58	* __Data Retention Override__: Customizable data retention period (default 180 days via `TOP_TEN_STORE_DATA`)
59
60	* __Advanced Blocks and Widgets__
61	* __Top 10 Query Block__: Query and display popular posts directly from the block or site editor
62	* __Enhanced Top 10 Featured Image Block__: Support for multiple image sources with fallbacks
63	* __Popular Posts Block Enhancements__:
64	* Save and clear default block settings with a single click
65	* Auto-insert default and global settings attributes with an option to disable
66
67	* __Enhanced Admin Tools__
68	* __Admin Bar Integration__: Admin bar menu item to view daily, total, and overall post counts, access admin pages, and clear cache
69	* __Disable Admin Bar menu__: Setting to disable the Admin Bar menu
70	* __Dashboard Access Control__: Setting to control which user roles can view the Top 10 dashboard
71	* __Display Settings__: Setting to choose which post type screens display admin columns
72	* __Mini "Top 10 Views Overview" widget__: Compact views-over-time chart on the WordPress Dashboard
73	* __Multisite Settings Copy__: Tool to copy settings between sites in a multisite network
74
75	* __Custom Display Options__
76	* __Taxonomy-Specific Displays__: `display_only_on_tax_ids` parameter to restrict popular post displays to specific taxonomy terms
77	* __Category Inclusion__: Edit Post meta box option to include popular posts from specific categories
78	* __RSS Feed Filtering__: Filter RSS feeds by category or post type via settings or URL parameters
79
80	* __WP-CLI Integration__
81	* __`wp top10 counts`__: View, get, set, reset, export, and import post view counts from the command line
82	* __`wp top10 db`__: Manage database tables — check status, create, update, recreate, prune old rows, force aggregation, truncate, and clean up orphaned counts
83	* __`wp top10 cache`__: Flush, enable, disable, and check the status of the output cache
84	* __`wp top10 settings`__: Get, set, export, and import plugin settings as JSON
85	* __`wp top10 cron`__: View, enable, disable, and manually trigger the maintenance and aggregation cron jobs
86	* __`wp top10 popular`__: List popular posts with counts using the same query as the front end
87	* __`wp top10 status`__: Print a full plugin status overview
88	* All destructive commands support `--dry-run` and `--force`; multisite commands support `--network` and `--blog-id`
89
90	* __Developer-Friendly Features__
91	* __Custom Post Type Sortable Columns__: Admin columns on supported custom post types with sortable functionality
92
93	### GDPR
94
95	Top 10 does not collect personal visitor data out of the box. Tracking data is stored locally in the `wp_top_ten` and `wp_top_ten_daily` database tables (table prefix may vary).
96
97	You are responsible for ensuring GDPR compliance on your website.
98
99	### Translations
100
101	Top 10 is available for [](https://translate.wordpress.org/projects/wp-plugins/top-10translation directly on WordPress.org](https://translate.wordpress.org/projects/wp-plugins/top-10](https://translate.wordpress.org/projects/wp-plugins/top-10). Check out the official [](https://make.wordpress.org/polyglots/handbook/rosetta/theme-plugin-directories/Translator Handbook](https://make.wordpress.org/polyglots/handbook/rosetta/theme-plugin-directories/](https://make.wordpress.org/polyglots/handbook/rosetta/theme-plugin-directories/) to contribute.
102
103	### Other plugins from WebberZone
104
105	Top 10 - Popular Posts is one of the many plugins developed by WebberZone. Check out our other plugins:
106
107	* [](https://wordpress.org/plugins/contextual-related-posts/Contextual Related Posts](https://wordpress.org/plugins/contextual-related-posts/](https://wordpress.org/plugins/contextual-related-posts/) - Display related posts on your WordPress blog and feed
108	* [](https://wordpress.org/plugins/add-to-all/WebberZone Snippetz](https://wordpress.org/plugins/add-to-all/](https://wordpress.org/plugins/add-to-all/) - The ultimate snippet manager for WordPress to create and manage custom HTML, CSS or JS code snippets
109	* [](https://wordpress.org/plugins/knowledgebase/Knowledge Base](https://wordpress.org/plugins/knowledgebase/](https://wordpress.org/plugins/knowledgebase/) - Create a knowledge base or FAQ section on your WordPress site
110	* [](https://wordpress.org/plugins/better-search/Better Search](https://wordpress.org/plugins/better-search/](https://wordpress.org/plugins/better-search/) - Enhance the default WordPress search with contextual results sorted by relevance
111	* [](https://wordpress.org/plugins/autoclose/Auto-Close](https://wordpress.org/plugins/autoclose/](https://wordpress.org/plugins/autoclose/) - Automatically close comments, pingbacks and trackbacks and manage revisions
112	* [](https://wordpress.org/plugins/popular-authors/Popular Authors](https://wordpress.org/plugins/popular-authors/](https://wordpress.org/plugins/popular-authors/) - Display popular authors in your WordPress widget
113	* [](https://wordpress.org/plugins/where-did-they-go-from-here/Followed Posts](https://wordpress.org/plugins/where-did-they-go-from-here/](https://wordpress.org/plugins/where-did-they-go-from-here/) - Show a list of related posts based on what your users have read
114
115	## Screenshots
116
117	![Top 10 Popular Posts](https://raw.github.com/WebberZone/top-10/master/wporg-assets/screenshot-1.png)
118	Top 10 Popular Posts
119
120	For more screenshots visit the [](http://wordpress.org/plugins/top-10/screenshots/WordPress plugin page](http://wordpress.org/plugins/top-10/screenshots/](http://wordpress.org/plugins/top-10/screenshots/).
121
122	## Installation
123
124	### WordPress install (the easy way)
125
126	1. Navigate to Plugins within your WordPress Admin Area
127
128	2. Click "Add new" and in the search box enter "Top 10"
129
130	3. Find the plugin in the list (usually the first result) and click "Install Now"
131
132	### Manual install
133
134	1. Download the __top-10.zip__ file from this release post
135	2. Visit __Plugins__ in your Admin Area
136	3. Hit the __Add New__ button next to the Plugins heading
137	4. Hit the __Upload__ button next to the Add Plugins heading
138	5. Select the __top-10.zip__ file that you downloaded and hit Install Now
139	6. Activate the Plugin in WP-Admin.
140	7. Go to __Top 10 » Settings__ to configure
141	8. Go to __Appearance » Widgets__ to add the Popular Posts sidebar widget to your theme
142	9. Go to __Top 10 » View Popular Posts__ to view the list of popular posts
143
144	## Frequently Asked Questions
145
146	Check out the [](http://wordpress.org/plugins/top-10/faq/FAQ on the plugin page](http://wordpress.org/plugins/top-10/faq/](http://wordpress.org/plugins/top-10/faq/) and the [](https://webberzone.com/support/section/top-10/FAQ on the WebberZone knowledgebase](https://webberzone.com/support/section/top-10/](https://webberzone.com/support/section/top-10/).
147
148	If your question isn't listed there, please create a new post at the [](http://wordpress.org/support/plugin/top-10WordPress.org support forum](http://wordpress.org/support/plugin/top-10](http://wordpress.org/support/plugin/top-10). It is the fastest way to get support as I monitor the forums regularly.
149
150	## About this repository
151
152	This GitHub repository always holds the latest development version of the plugin. If you're looking for an official WordPress release, you can find this on the [](http://wordpress.org/plugins/top-10WordPress.org repository](http://wordpress.org/plugins/top-10](http://wordpress.org/plugins/top-10). In addition to stable releases, latest beta versions are made available under [](https://github.com/WebberZone/top-10/releasesreleases](https://github.com/WebberZone/top-10/releases](https://github.com/WebberZone/top-10/releases).
153