Benchmarks
Plugin footprint 65% from 16 tests
Installer Passed 1 test
🔺 Critical test (weight: 50) | The install procedure must perform silently
Install script ran successfully
Server metrics [RAM: ▲3.30MB] [CPU: ▲32.21ms] 75% from 4 tests
This is a short check of server-side resources used by BetterDocs - Best Documentation & Knowledge Base Plugin
Please fix the following
- RAM: Try to keep total memory usage under 10MB (currently 10.02MB on /wp-admin/post-new.php?post_type=docs)
| Page | Memory (MB) | CPU Time (ms) |
|---|---|---|
| Home / | 6.43 ▲2.97 | 60.84 ▲22.21 |
| Dashboard /wp-admin | 6.73 ▲3.43 | 79.67 ▲31.01 |
| Posts /wp-admin/edit.php | 6.76 ▲3.41 | 88.07 ▲41.51 |
| Add New Post /wp-admin/post-new.php | 10.02 ▲4.13 | 135.74 ▲43.05 |
| Media Library /wp-admin/upload.php | 6.63 ▲3.40 | 69.49 ▲34.09 |
| Analytics /wp-admin/admin.php?page=betterdocs-analytics | 6.63 | 62.29 |
| Categories /wp-admin/edit-tags.php?taxonomy=doc_category&post_type=docs | 6.66 | 70.13 |
| Settings /wp-admin/admin.php?page=betterdocs-settings | 6.72 | 70.05 |
| Tags /wp-admin/edit-tags.php?taxonomy=doc_tag&post_type=docs | 6.63 | 62.98 |
| FAQ Builder /wp-admin/admin.php?page=betterdocs-faq | 6.60 | 61.00 |
| Quick Setup /wp-admin/admin.php?page=betterdocs-setup | 6.65 | 63.97 |
| Add New /wp-admin/post-new.php?post_type=docs | 10.02 | 125.84 |
| All Docs /wp-admin/admin.php?page=betterdocs-admin | 6.67 | 68.20 |
Server storage [IO: ▲16.67MB] [DB: ▲0.01MB] Passed 3 tests
Filesystem and database footprint
The plugin installed successfully
Filesystem: 873 new files
Database: 3 new tables, 8 new options
| New tables |
|---|
| wp_betterdocs_search_log |
| wp_betterdocs_search_keyword |
| wp_betterdocs_analytics |
| New WordPress options |
|---|
| can_compress_scripts |
| db_upgraded |
| theysaidso_admin_options |
| widget_recent-comments |
| betterdocs_version |
| widget_recent-posts |
| betterdocs_db_version |
| widget_theysaidso_widget |
Browser metrics Passed 4 tests
BetterDocs - Best Documentation & Knowledge Base Plugin: an overview of browser usage
There were no issues detected in relation to browser resource usage
| Page | Nodes | Memory (MB) | Script (ms) | Layout (ms) |
|---|---|---|---|---|
| Home / | 2,962 ▲200 | 14.33 ▼0.00 | 1.97 ▲0.10 | 36.30 ▼8.99 |
| Dashboard /wp-admin | 2,342 ▲162 | 5.69 ▲0.05 | 95.45 ▼4.04 | 80.68 ▲39.03 |
| Posts /wp-admin/edit.php | 2,247 ▲147 | 2.11 ▲0.17 | 43.07 ▲9.27 | 41.63 ▲5.28 |
| Add New Post /wp-admin/post-new.php | 1,707 ▲173 | 25.22 ▼0.21 | 739.52 ▲115.74 | 48.11 ▼10.38 |
| Media Library /wp-admin/upload.php | 1,541 ▲141 | 4.12 ▼0.08 | 98.05 ▲2.12 | 79.76 ▲36.30 |
| Analytics /wp-admin/admin.php?page=betterdocs-analytics | 1,241 | 2.49 | 47.68 | 57.88 |
| Categories /wp-admin/edit-tags.php?taxonomy=doc_category&post_type=docs | 1,639 | 3.27 | 46.48 | 76.23 |
| Settings /wp-admin/admin.php?page=betterdocs-settings | 2,534 | 10.61 | 454.77 | 110.56 |
| Tags /wp-admin/edit-tags.php?taxonomy=doc_tag&post_type=docs | 1,414 | 2.16 | 28.90 | 36.20 |
| FAQ Builder /wp-admin/admin.php?page=betterdocs-faq | 1,100 | 6.10 | 160.93 | 41.55 |
| Quick Setup /wp-admin/admin.php?page=betterdocs-setup | 1,359 | 11.05 | 244.08 | 78.32 |
| Add New /wp-admin/post-new.php?post_type=docs | 6,510 | 52.01 | 969.12 | 175.22 |
| All Docs /wp-admin/admin.php?page=betterdocs-admin | 1,183 | 2.70 | 42.36 | 36.22 |
Uninstaller [IO: ▲0.00MB] [DB: ▲0.01MB] 50% from 4 tests
🔸 Tests weight: 35 | All plugins must uninstall correctly, removing their source code and extra database tables they might have created
You still need to fix the following
- The uninstall procedure failed, leaving 3 tables in the database
- wp_betterdocs_search_log
- wp_betterdocs_search_keyword
- wp_betterdocs_analytics
- This plugin did not uninstall successfully, leaving 8 options in the database
- widget_theysaidso_widget
- betterdocs_db_version
- can_compress_scripts
- theysaidso_admin_options
- betterdocs_version
- widget_recent-posts
- widget_recent-comments
- db_upgraded
Smoke tests 50% from 4 tests
Server-side errors Passed 1 test
🔹 Test weight: 20 | A smoke test targeting server-side errors
Even though no errors were found, this is by no means an exhaustive test
SRP 0% from 2 tests
🔹 Tests weight: 20 | A shallow check of the single-responsibility principle; PHP files should perform no action - including output of placeholder text - and trigger no errors when accessed directly
Please fix the following items
- 23× PHP files perform the task of outputting text when accessed with GET requests (only 10 are shown):
- > /wp-content/plugins/betterdocs/views/widgets/social.php
- > /wp-content/plugins/betterdocs/views/admin/template-parts/settings-header.php
- > /wp-content/plugins/betterdocs/views/templates/parts/sticky-toc.php
- > /wp-content/plugins/betterdocs/views/admin/email/footer.php
- > /wp-content/plugins/betterdocs/includes/Admin/Customizer/controls.css.php
- > /wp-content/plugins/betterdocs/views/test.php
- > /wp-content/plugins/betterdocs/views/templates/parts/faq.php
- > /wp-content/plugins/betterdocs/views/widgets/reactions.php
- > /wp-content/plugins/betterdocs/views/admin/partials/mode-switch.php
- > /wp-content/plugins/betterdocs/views/icons/collapse.php
- 453× PHP files trigger errors when accessed directly with GET requests (only 10 are shown):
- > PHP Fatal error
Uncaught Error: Class 'WPDeveloper\\BetterDocs\\Dependencies\\PhpParser\ode\\Scalar\\MagicConst' not found in wp-content/plugins/betterdocs/includes/Dependencies/PhpParser/Node/Scalar/MagicConst/File.php:7
- > PHP Fatal error
Uncaught Error: Class 'WPDeveloper\\BetterDocs\\Utils\\Helper' not found in wp-content/plugins/betterdocs/views/admin/docs-ui/classic-partials/filter.php:7
- > PHP Fatal error
Uncaught Error: Class 'WPDeveloper\\BetterDocs\\Dependencies\\PhpParser\ode\\Expr' not found in wp-content/plugins/betterdocs/includes/Dependencies/PhpParser/Node/Expr/New_.php:8
- > PHP Fatal error
Uncaught Error: Class 'WPDeveloper\\BetterDocs\\Editors\\BlockEditor\\Block' not found in wp-content/plugins/betterdocs/includes/Editors/BlockEditor/Blocks/Navigation.php:7
- > PHP Fatal error
Uncaught Error: Interface 'WPDeveloper\\BetterDocs\\Dependencies\\DI\\Definition\\Definition' not found in wp-content/plugins/betterdocs/includes/Dependencies/DI/Definition/ExtendsPreviousDefinition.php:12
- > PHP Fatal error
Uncaught Error: Interface 'WPDeveloper\\BetterDocs\\Dependencies\\Psr\\Container\\ContainerExceptionInterface' not found in wp-content/plugins/betterdocs/includes/Dependencies/Psr/Container/NotFoundExceptionInterface.php:8
- > PHP Fatal error
Uncaught Error: Call to undefined function esc_attr() in wp-content/plugins/betterdocs/views/admin/customizer/controls/multidimension.php:25
- > PHP Fatal error
Uncaught Error: Interface 'WPDeveloper\\BetterDocs\\Dependencies\\PhpParser\\Builder' not found in wp-content/plugins/betterdocs/includes/Dependencies/PhpParser/BuilderAbstract.php:12
- > PHP Notice
Undefined variable: blockId in wp-content/plugins/betterdocs/views/widgets/print-icon.php on line 1
- > PHP Fatal error
Uncaught Error: Call to undefined function is_front_page() in wp-content/plugins/betterdocs/views/widgets/breadcrumbs.php:2
- > PHP Fatal error
User-side errors Passed 1 test
🔹 Test weight: 20 | This is a smoke test targeting browser errors/issues
No browser issues were found
Optimizations
Plugin configuration 86% from 29 tests
readme.txt 81% from 16 tests
Often overlooked, readme.txt is one of the most important files in your plugin
Attributes that require attention:
- Tags: Please reduce the number of tags, currently 33 tag instead of maximum 10
- Screenshots: No descriptions were found for these screenshots #1, #2, #3, #4, #5, #6 in betterdocs/assets to your readme.txt
- Tags: Please reduce the number of tags, currently 33 tag instead of maximum 10
betterdocs/betterdocs.php 92% from 13 tests
The main PHP file in "BetterDocs - Best Documentation & Knowledge Base Plugin" ver. 3.0.1 adds more information about the plugin and also serves as the entry point for this plugin
It is important to fix the following:
- Description: Please keep the plugin description shorter than 140 characters (currently 195 characters long)
Code Analysis Passed 3 tests
File types Passed 1 test
🔸 Test weight: 35 | Executable files are considered dangerous and should not be included with any WordPress plugin
No dangerous file extensions were detected73,578 lines of code in 763 files:
| Language | Files | Blank lines | Comment lines | Lines of code |
|---|---|---|---|---|
| PHP | 610 | 9,996 | 9,768 | 52,811 |
| SVG | 40 | 0 | 16 | 11,776 |
| CSS | 54 | 198 | 59 | 6,419 |
| JSON | 16 | 0 | 0 | 1,737 |
| JavaScript | 35 | 54 | 58 | 346 |
| HTML | 5 | 21 | 71 | 299 |
| Sass | 2 | 7 | 0 | 117 |
| XML | 1 | 0 | 0 | 73 |
PHP code Passed 2 tests
Analyzing cyclomatic complexity and code structure
No cyclomatic complexity issues were detected for this plugin
| Cyclomatic complexity | |
|---|---|
| Average complexity per logical line of code | 0.28 |
| Average class complexity | 7.90 |
| ▷ Minimum class complexity | 1.00 |
| ▷ Maximum class complexity | 132.00 |
| Average method complexity | 1.85 |
| ▷ Minimum method complexity | 1.00 |
| ▷ Maximum method complexity | 43.00 |
| Code structure | ||
|---|---|---|
| Namespaces | 73 | |
| Interfaces | 26 | |
| Traits | 6 | |
| Classes | 406 | |
| ▷ Abstract classes | 27 | 6.65% |
| ▷ Concrete classes | 379 | 93.35% |
| ▷ Final classes | 9 | 2.37% |
| Methods | 3,418 | |
| ▷ Static methods | 104 | 3.04% |
| ▷ Public methods | 1,933 | 56.55% |
| ▷ Protected methods | 1,361 | 39.82% |
| ▷ Private methods | 124 | 3.63% |
| Functions | 89 | |
| ▷ Named functions | 13 | 14.61% |
| ▷ Anonymous functions | 76 | 85.39% |
| Constants | 212 | |
| ▷ Global constants | 15 | 7.08% |
| ▷ Class constants | 197 | 92.92% |
| ▷ Public constants | 196 | 99.49% |
Plugin size Passed 2 tests
Image compression Passed 2 tests
It is recommended to compress PNG files in your plugin to minimize bandwidth usage
68 compressed PNG files occupy 0.90MB
Potential savings
| Compression of 5 random PNG files using pngquant | |||
|---|---|---|---|
| File | Size - original | Size - compressed | Savings |
| assets/images/social/reports/graph.png | 13.14KB | 14.68KB | 0.00% |
| assets/admin/images/customizer/docs-page/layout-1.png | 3.17KB | 1.79KB | ▼ 43.53% |
| assets/admin/images/icons/author.png | 0.54KB | 0.37KB | ▼ 30.97% |
| assets/images/social/reports/web.png | 0.36KB | 0.55KB | 0.00% |
| assets/images/social/reports/youtube.png | 0.34KB | 0.35KB | 0.00% |