67% eazydocs

Code Review | EazyDocs - Most Powerful Knowledge base, wiki, Documentation Builder Plugin (easy docs, knowledgebase)

WordPress plugin EazyDocs - Most Powerful Knowledge base, wiki, Documentation Builder Plugin (easy docs, knowledgebase) scored67%from 54 tests.

About plugin

  • Plugin page: eazydocs
  • Plugin version: 2.3.5
  • PHP compatiblity: 7.4+
  • PHP version: 7.4.16
  • WordPress compatibility: 5.0-6.4
  • WordPress version: 6.3.1
  • First release: Apr 13, 2022
  • Latest release: Nov 16, 2023
  • Number of updates: 83
  • Update frequency: every 7.0 days
  • Top authors: spiderdevs (100%)

Code review

54 tests

User reviews

30 reviews

Install metrics

2,000+ active /26,367 total downloads

Benchmarks

Plugin footprint 65% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | All plugins must install correctly, without throwing any errors, warnings, or notices
Install script ran successfully

Server metrics [RAM: ▲6.33MB] [CPU: ▲51.48ms] 75% from 4 tests

An overview of server-side resources used by EazyDocs - Most Powerful Knowledge base, wiki, Documentation Builder Plugin (easy docs, knowledgebase)
Please have a look at the following items
  • Extra RAM: The extra memory usage should kept under 5MB (currently 6.33MB on /wp-admin/admin.php?page=freemius)
PageMemory (MB)CPU Time (ms)
Home /9.69 ▲6.2389.40 ▲51.75
Dashboard /wp-admin9.65 ▲6.3595.74 ▲46.60
Posts /wp-admin/edit.php9.77 ▲6.41108.23 ▲61.08
Add New Post /wp-admin/post-new.php12.45 ▲6.56148.19 ▲47.96
Media Library /wp-admin/upload.php9.58 ▲6.3593.44 ▲59.59
Freemius Debug [v.2.6.0] /wp-admin/admin.php?page=freemius9.8281.51

Server storage [IO: ▲10.34MB] [DB: ▲0.01MB] Passed 3 tests

How much does this plugin use your filesystem and database?
This plugin was installed successfully
Filesystem: 574 new files
Database: no new tables, 12 new options
New WordPress options
fs_debug_mode
EazyDocs_version
fs_active_plugins
db_upgraded
widget_theysaidso_widget
widget_recent-posts
widget_recent-comments
eazyDocs_installed
fs_accounts
theysaidso_admin_options
...

Browser metrics Passed 4 tests

An overview of browser requirements for EazyDocs - Most Powerful Knowledge base, wiki, Documentation Builder Plugin (easy docs, knowledgebase)
Minimal impact on browser resources
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,964 ▲20213.41 ▼0.838.78 ▲7.1728.09 ▼16.22
Dashboard /wp-admin2,276 ▲1025.56 ▼0.0699.37 ▼0.4347.55 ▲3.19
Posts /wp-admin/edit.php2,185 ▲852.15 ▲0.2042.30 ▲3.4838.46 ▲0.58
Add New Post /wp-admin/post-new.php1,744 ▲21622.30 ▼0.58658.87 ▼62.3836.40 ▼19.23
Media Library /wp-admin/upload.php1,481 ▲814.44 ▲0.27104.00 ▲5.7848.55 ▲5.31
Freemius Debug [v.2.6.0] /wp-admin/admin.php?page=freemius1,1161.6930.6832.36

Uninstaller [IO: ▲0.00MB] [DB: ▲0.01MB] 50% from 4 tests

🔸 Tests weight: 35 | The uninstall procedure must remove all plugin files and extra database tables
You still need to fix the following
  • Uninstall procedure validation failed for this plugin
    • > Notice in wp-content/plugins/eazydocs/includes/fs/includes/class-freemius.php+8546
    Undefined property: stdClass::$plugins
  • Zombie WordPress options were found after uninstall: 12 options
    • eazydocs_settings
    • fs_active_plugins
    • widget_theysaidso_widget
    • widget_recent-comments
    • theysaidso_admin_options
    • can_compress_scripts
    • db_upgraded
    • fs_accounts
    • fs_debug_mode
    • EazyDocs_version
    • ...

Smoke tests 50% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | A smoke test targeting server-side errors
Even though everything seems fine, this is not an exhaustive test

SRP 0% from 2 tests

🔹 Tests weight: 20 | The single-responsibility principle applies for WordPress plugins as well - please make sure your PHP files perform no actions when accessed directly
Please fix the following items
  • 1× PHP files perform the task of outputting text when accessed with GET requests:
    • > /wp-content/plugins/eazydocs/includes/Elementor/Docs/docs-6.php
  • 61× PHP files trigger server-side errors or warnings when accessed directly (only 10 are shown):
    • > PHP Fatal error
      Uncaught Error: Call to undefined function get_option() in wp-content/plugins/eazydocs/includes/Elementor/Docs/docs-1.php:2
    • > PHP Fatal error
      Uncaught Error: Call to undefined function wp_enqueue_style() in wp-content/plugins/eazydocs/templates/ezd-login.php:3
    • > PHP Fatal error
      Uncaught Error: Call to undefined function ezd_get_opt() in wp-content/plugins/eazydocs/templates/tools/edit-add-doc.php:2
    • > PHP Fatal error
      Uncaught Error: Call to undefined function get_option() in wp-content/plugins/eazydocs/templates/docs-right-sidebar.php:2
    • > PHP Fatal error
      Uncaught Error: Call to undefined function esc_attr() in wp-content/plugins/eazydocs/includes/Elementor/Single_Doc/single-doc-3.php:5
    • > PHP Fatal error
      Uncaught Error: Call to undefined function get_option() in wp-content/plugins/eazydocs/templates/search-banner.php:2
    • > PHP Fatal error
      Uncaught Error: Call to undefined function esc_attr() in wp-content/plugins/eazydocs/includes/Elementor/Docs/docs-2.php:1
    • > PHP Notice
      Trying to get property 'post_parent' of non-object in wp-content/plugins/eazydocs/templates/docs-sidebar.php on line 5
    • > PHP Fatal error
      Uncaught Error: Call to undefined function esc_attr_e() in wp-content/plugins/eazydocs/includes/Elementor/Search/ajax-sarch-results.php:1
    • > PHP Fatal error
      Uncaught Error: Call to undefined function get_option() in wp-content/plugins/eazydocs/templates/keywords.php:6

User-side errors Passed 1 test

🔹 Test weight: 20 | This is just a short smoke test looking for browser issues
Everything seems fine on the user side

Optimizations

Plugin configuration 93% from 29 tests

readme.txt 88% from 16 tests

The readme.txt file describes your plugin functionality and requirements and it is parsed to prepare the your plugin's listing
Attributes that need to be fixed:
  • Tags: Too many tags (16 tag instead of maximum 10); only the first 5 tags are used in your directory listing
  • Screenshots: Add a description for screenshot #8 in eazydocs/assets to your readme.txt
The official readme.txt is a good inspiration

eazydocs/eazydocs.php Passed 13 tests

The main PHP file in "EazyDocs - Most Powerful Knowledge base, wiki, Documentation Builder Plugin (easy docs, knowledgebase)" ver. 2.3.5 adds more information about the plugin and also serves as the entry point for this plugin
68 characters long description:
A powerful & beautiful documentation, knowledge base builder plugin.

Code Analysis 97% from 3 tests

File types Passed 1 test

🔸 Test weight: 35 | This is a short overview of programming languages used in this plugin, detecting executable files
No dangerous file extensions were detected148,558 lines of code in 472 files:
LanguageFilesBlank linesComment linesLines of code
PHP27111,95819,91552,098
XML17911,16436,016
CSS441,51485918,739
Sass642,67332417,550
PO File84,7206,63410,972
JavaScript442,0651,53810,805
SVG32031,992
Markdown1680214
JSON700172

PHP code 50% from 2 tests

This is a short overview of cyclomatic complexity and code structure for this plugin
Please fix the following
  • Class cyclomatic complexity should be reduced to less than 1000 (currently 3,096)
Cyclomatic complexity
Average complexity per logical line of code0.58
Average class complexity47.04
▷ Minimum class complexity1.00
▷ Maximum class complexity3,096.00
Average method complexity4.88
▷ Minimum method complexity1.00
▷ Maximum method complexity94.00
Code structure
Namespaces9
Interfaces1
Traits0
Classes137
▷ Abstract classes42.92%
▷ Concrete classes13397.08%
▷ Final classes10.75%
Methods1,667
▷ Static methods26215.72%
▷ Public methods1,25875.46%
▷ Protected methods231.38%
▷ Private methods38623.16%
Functions198
▷ Named functions18693.94%
▷ Anonymous functions126.06%
Constants154
▷ Global constants10668.83%
▷ Class constants4831.17%
▷ Public constants48100.00%

Plugin size 50% from 2 tests

Image compression 50% from 2 tests

All PNG images should be compressed to minimize bandwidth usage for end users
17 PNG files occupy 0.71MB with 0.32MB in potential savings
Potential savings
Compression of 5 random PNG files using pngquant
FileSize - originalSize - compressedSavings
includes/fs/assets/img/plugin-icon.png9.16KB5.26KB▼ 42.58%
assets/images/icon/folder.png0.64KB0.62KB▼ 2.92%
assets/images/docs-4.png81.50KB38.24KB▼ 53.08%
assets/images/customizer/1.png1.04KB0.73KB▼ 29.85%
assets/images/search-bg.png546.15KB17.90KB▼ 96.72%