78% inlinemanual

Code Review | Inline Manual

WordPress plugin Inline Manual scored 78% from 54 tests.

About plugin

  • Plugin page: inlinemanual
  • Plugin version: 0.9
  • PHP version: 7.4.16
  • WordPress compatibility: 3.3-4.3.1
  • WordPress version: 6.3.1
  • First release: Apr 30, 2013
  • Latest release: Dec 4, 2015
  • Number of updates: 34
  • Update frequency: every 28.0 days
  • Top authors: mareksotak (76.47%)o----o (23.53%)wojtha (5.88%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active / 2,160 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Checking the installer triggered no errors
The plugin installed successfully, without throwing any errors or notices

Server metrics [RAM: ▼0.15MB] [CPU: ▼7.35ms] Passed 4 tests

An overview of server-side resources used by Inline Manual
This plugin has minimal impact on server resources
PageMemory (MB)CPU Time (ms)
Home /2.74 ▼0.7217.34 ▼24.06
Dashboard /wp-admin3.35 ▲0.0452.49 ▲3.94
Posts /wp-admin/edit.php3.40 ▲0.0446.59 ▲2.86
Add New Post /wp-admin/post-new.php5.93 ▲0.0486.50 ▼12.15
Media Library /wp-admin/upload.php3.27 ▲0.0438.69 ▲5.33
Inline Manual /wp-admin/options-general.php?page=inlinemanual3.2130.11

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

Filesystem and database footprint
There were no storage issued detected upon installing this plugin
Filesystem: 10 new files
Database: no new tables, 7 new options
New WordPress options
widget_recent-posts
widget_recent-comments
db_upgraded
can_compress_scripts
widget_theysaidso_widget
im_admin_roles
theysaidso_admin_options

Browser metrics Passed 4 tests

This is an overview of browser requirements for Inline Manual
Normal browser usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /3,046 ▲31116.61 ▲2.252.11 ▲0.1939.22 ▼5.22
Dashboard /wp-admin2,440 ▲2527.85 ▲2.77169.70 ▲54.0342.64 ▼5.24
Posts /wp-admin/edit.php2,302 ▲2135.18 ▲3.1893.56 ▲57.6836.87 ▲1.35
Add New Post /wp-admin/post-new.php1,703 ▲16424.48 ▲1.43741.78 ▲143.2860.00 ▲8.77
Media Library /wp-admin/upload.php1,616 ▲2286.71 ▲2.49161.96 ▲63.7543.93 ▲0.19
Inline Manual /wp-admin/options-general.php?page=inlinemanual1,2316.59132.7940.41

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

🔸 Tests weight: 35 | Checking the uninstaller removed all traces of the plugin
You still need to fix the following
  • This plugin does not fully uninstall, leaving 7 options in the database
    • widget_recent-posts
    • widget_theysaidso_widget
    • db_upgraded
    • can_compress_scripts
    • widget_recent-comments
    • im_admin_roles
    • theysaidso_admin_options

Smoke tests 50% from 4 tests

Server-side errors 0% from 1 test

🔹 Test weight: 20 | This is a shallow check for server-side errors
These server-side errors were triggered
  • 6 occurences, only the last one shown
    • > GET request to /wp-admin/options-general.php?page=inlinemanual
    • > Notice in wp-content/plugins/inlinemanual/class.inlinemanual-admin.php+46
    Trying to access array offset on value of type bool
    • > GET request to /wp-admin/options-general.php?page=inlinemanual
    • > Notice in wp-content/plugins/inlinemanual/class.inlinemanual-admin.php+63
    Undefined index: editor
    • > GET request to /wp-admin/options-general.php?page=inlinemanual
    • > Notice in wp-content/plugins/inlinemanual/class.inlinemanual-admin.php+63
    Undefined index: author
    • > GET request to /wp-admin/options-general.php?page=inlinemanual
    • > Notice in wp-content/plugins/inlinemanual/class.inlinemanual-admin.php+63
    Undefined index: contributor
    • > GET request to /wp-admin/options-general.php?page=inlinemanual
    • > Notice in wp-content/plugins/inlinemanual/class.inlinemanual-admin.php+63
    Undefined index: subscriber

SRP 50% from 2 tests

🔹 Tests weight: 20 | It is important to ensure that your PHP files perform no action when accessed directly, respecting the single-responsibility principle
The following issues need your attention
  • 1× PHP files output non-empty strings when accessed directly via GET requests:
    • > /wp-content/plugins/inlinemanual/inlinemanual.php

User-side errors Passed 1 test

🔹 Test weight: 20 | Just a short smoke test targeting errors on the browser (console and network errors and warnings)
No browser errors were detected

Optimizations

Plugin configuration 90% from 29 tests

readme.txt 81% from 16 tests

The readme.txt file uses markdown syntax to describe your plugin to the world
These attributes need to be fixed:
  • Tags: Too many tags (23 tag instead of maximum 10); only the first 5 tags are used in your directory listing
  • Donate link: Please fix this invalid url: ""
  • Screenshots: Add an image for screenshot #1 (Walkthrough example)
Please take inspiration from this readme.txt

inlinemanual/inlinemanual.php Passed 13 tests

The principal PHP file in "Inline Manual" v. 0.9 is loaded by WordPress automatically on each request
28 characters long description:
Inline Manual for Wordpress.

Code Analysis Passed 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
Good job! No executable or dangerous file extensions detected190 lines of code in 5 files:
LanguageFilesBlank linesComment linesLines of code
PHP41920144
CSS11046

PHP code Passed 2 tests

This is a short overview of cyclomatic complexity and code structure for this plugin
Although this was not an exhaustive test, there were no cyclomatic complexity issues detected
Cyclomatic complexity
Average complexity per logical line of code0.14
Average class complexity6.50
▷ Minimum class complexity6.00
▷ Maximum class complexity7.00
Average method complexity2.22
▷ Minimum method complexity1.00
▷ Maximum method complexity6.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes2
▷ Abstract classes00.00%
▷ Concrete classes2100.00%
▷ Final classes00.00%
Methods9
▷ Static methods9100.00%
▷ Public methods9100.00%
▷ Protected methods00.00%
▷ Private methods00.00%
Functions0
▷ Named functions00.00%
▷ Anonymous functions00.00%
Constants2
▷ Global constants2100.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

Often times overlooked, PNG files can occupy unnecessary space in your plugin
3 PNG files occupy 0.20MB with 0.08MB in potential savings
Potential savings
Compression of 3 random PNG files using pngquant
FileSize - originalSize - compressedSavings
img/logo-full-2x.png2.69KB1.76KB▼ 34.72%
screenshot-1.png206.05KB60.85KB▼ 70.47%
inlinemanual.png0.29KB0.26KB▼ 8.75%