10% wp-users-guide

Code Review | WP Users Guide

WordPress plugin WP Users Guide scored10%from 54 tests.

About plugin

  • Plugin page: wp-users-guide
  • Plugin version: 1.01
  • PHP version: 7.4.16
  • WordPress compatibility: 4.2.4-4.4.1
  • WordPress version: 6.3.1
  • First release: Jan 15, 2016
  • Latest release: Mar 9, 2016
  • Number of updates: 11
  • Update frequency: every 5.0 days
  • Top authors: is-planning (100%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active /516 total downloads

Benchmarks

Plugin footprint 40% from 16 tests

Installer 0% from 1 test

🔺 Critical test (weight: 50) | Verifying that this plugin installs correctly without errors
The following installer errors require your attention
  • Install procedure had errors
    • > User deprecated in wp-includes/functions.php+5737
    Function WP_User_Query was called with an argument that is deprecated since version 5.9.0! who is deprecated. Use capability instead.

Server metrics [RAM: ▲0.04MB] [CPU: ▼6.22ms] Passed 4 tests

A check of server-side resources used by WP Users Guide
This plugin does not affect your website's performance
PageMemory (MB)CPU Time (ms)
Home /3.50 ▲0.0334.68 ▼5.27
Dashboard /wp-admin3.36 ▲0.0545.38 ▼2.49
Posts /wp-admin/edit.php3.39 ▲0.0349.16 ▲0.87
Add New Post /wp-admin/post-new.php5.94 ▲0.0581.41 ▼17.99
Media Library /wp-admin/upload.php3.28 ▲0.0435.19 ▲2.89
ユーザーマニュアル /wp-admin/options-general.php?page=user-guide-setting3.2530.40

Server storage [IO: ▲1.05MB] [DB: ▲0.00MB] Passed 3 tests

Analyzing filesystem and database footprints of this plugin
The plugin installed successfully
Filesystem: 125 new files
Database: no new tables, 7 new options
New WordPress options
widget_recent-comments
theysaidso_admin_options
widget_recent-posts
widget_theysaidso_widget
can_compress_scripts
db_upgraded
user_guide_option

Browser metrics Passed 4 tests

WP Users Guide: an overview of browser usage
This plugin has a minimal impact on browser resources
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /3,012 ▲26613.80 ▼0.581.89 ▲0.0741.44 ▼2.95
Dashboard /wp-admin2,418 ▲2305.52 ▼0.34108.34 ▼0.1656.32 ▲8.58
Posts /wp-admin/edit.php2,232 ▲1462.46 ▲0.4145.01 ▲7.3581.91 ▲40.97
Add New Post /wp-admin/post-new.php1,688 ▲16022.84 ▲4.40685.27 ▲84.8742.01 ▼6.16
Media Library /wp-admin/upload.php1,491 ▲1004.74 ▲0.56106.10 ▲7.1752.81 ▲7.23
ユーザーマニュアル /wp-admin/options-general.php?page=user-guide-setting1,0332.4036.3176.37

Uninstaller [IO: ▲0.00MB] [DB: ▲0.00MB] 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
  • The plugin did not uninstall gracefully
    • > Warning in wp-includes/class-wp-hook.php+310
    call_user_func_array() expects parameter 1 to be a valid callback, class 'ISP_UserGuide' not found
  • Zombie WordPress options were found after uninstall: 7 options
    • widget_recent-comments
    • user_guide_option
    • theysaidso_admin_options
    • db_upgraded
    • widget_theysaidso_widget
    • widget_recent-posts
    • can_compress_scripts

Smoke tests Passed 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for server-side errors
Good news, no errors were detected

SRP Passed 2 tests

🔹 Tests weight: 20 | SRP (Single-Responsibility Principle) - PHP files must act as libraries and never output text or perform any action when accessed directly in a browser
The SRP test was a success

User-side errors Passed 1 test

🔹 Test weight: 20 | A shallow check that no browser errors were triggered
No browser issues were found

Optimizations

Plugin configuration 93% from 29 tests

readme.txt 94% from 16 tests

The readme.txt file uses markdown syntax to describe your plugin to the world
Please fix the following attributes:
  • Screenshots: Please add images for these screenshots: #1 (ダッシュボードを開いた時に「ようこそ」画面を表示します。 This is "Welcome Screen" on the dashboard.), #2 (ツールチップによる簡易的なヘルプを表示します。 It will display a simple help by the tooltip.), #3 (ヘルプ画面のインデックス。 Index of help.), #4 (詳細なヘルプ画面。 show help.)
You can take inspiration from this readme.txt

wp-users-guide/users-guide.php 92% from 13 tests

The main file in "WP Users Guide" v. 1.01 serves as a complement to information provided in readme.txt and as the entry point to the plugin
Please take the time to fix the following:
  • Main file name: Name the main plugin file the same as the plugin slug ("wp-users-guide.php" instead of "users-guide.php")

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | A short glimpse at programming languages used with this plugin and a check that no dangerous files are present
Good job! No executable or dangerous file extensions detected2,587 lines of code in 12 files:
LanguageFilesBlank linesComment linesLines of code
PHP699981,559
JavaScript24053524
SVG100288
CSS31424216

PHP code Passed 2 tests

This is a very shot review of cyclomatic complexity and code structure
Everything seems fine, there were no complexity issues found
Cyclomatic complexity
Average complexity per logical line of code0.47
Average class complexity18.00
▷ Minimum class complexity18.00
▷ Maximum class complexity18.00
Average method complexity2.70
▷ Minimum method complexity1.00
▷ Maximum method complexity11.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes1
▷ Abstract classes00.00%
▷ Concrete classes1100.00%
▷ Final classes00.00%
Methods10
▷ Static methods00.00%
▷ Public methods10100.00%
▷ Protected methods00.00%
▷ Private methods00.00%
Functions2
▷ Named functions2100.00%
▷ Anonymous functions00.00%
Constants0
▷ Global constants00.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size 50% from 2 tests

Image compression 50% from 2 tests

It is recommended to compress PNG files in your plugin to minimize bandwidth usage
108 PNG files occupy 0.61MB with 0.22MB in potential savings
Potential savings
Compression of 5 random PNG files using pngquant
FileSize - originalSize - compressedSavings
images/category-edit007.png5.88KB4.28KB▼ 27.22%
css/images/ui-icons_888888_256x240.png6.83KB4.17KB▼ 38.92%
images/image007.png11.24KB9.34KB▼ 16.86%
images/visual-editor029.png0.40KB0.21KB▼ 47.22%
images/image-edit009.png0.46KB0.24KB▼ 48.11%