78% notice-faq

Code Review | Notice - AI-powered editor for FAQ, blog, documentation & more

WordPress plugin Notice - AI-powered editor for FAQ, blog, documentation & more scored78%from 54 tests.

About plugin

  • Plugin page: notice-faq
  • Plugin version: 1.3.1
  • PHP compatiblity: 5.6+
  • PHP version: 7.4.16
  • WordPress compatibility: 4.9-6.1.1
  • WordPress version: 6.3.1
  • First release: Mar 16, 2022
  • Latest release: May 25, 2023
  • Number of updates: 72
  • Update frequency: every 6.1 days
  • Top authors: rajatwgc (100%)

Code review

54 tests

User reviews

3 reviews

Install metrics

100+ active /2,396 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Checking the installer triggered no errors
Installer ran successfully

Server metrics [RAM: ▲0.08MB] [CPU: ▼7.93ms] Passed 4 tests

A check of server-side resources used by Notice - AI-powered editor for FAQ, blog, documentation & more
This plugin does not affect your website's performance
PageMemory (MB)CPU Time (ms)
Home /3.54 ▲0.0840.36 ▼4.07
Dashboard /wp-admin3.38 ▲0.0849.25 ▼4.77
Posts /wp-admin/edit.php3.49 ▲0.1446.46 ▼4.36
Add New Post /wp-admin/post-new.php5.98 ▲0.0982.15 ▼18.51
Media Library /wp-admin/upload.php3.30 ▲0.0734.63 ▼3.49

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

Input-output and database impact of this plugin
This plugin was installed successfully
Filesystem: 41 new files
Database: no new tables, 6 new options
New WordPress options
can_compress_scripts
widget_theysaidso_widget
widget_recent-comments
db_upgraded
theysaidso_admin_options
widget_recent-posts

Browser metrics Passed 4 tests

This is an overview of browser requirements for Notice - AI-powered editor for FAQ, blog, documentation & more
Normal browser usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,917 ▲13113.49 ▼0.749.60 ▲7.8344.44 ▲3.35
Dashboard /wp-admin2,214 ▲435.66 ▼0.0386.34 ▼4.8042.69 ▼0.80
Posts /wp-admin/edit.php2,116 ▲162.06 ▲0.0637.07 ▲0.3736.73 ▲1.11
Add New Post /wp-admin/post-new.php6,208 ▲4,65918.80 ▲0.37895.77 ▲253.3139.50 ▼13.94
Media Library /wp-admin/upload.php1,413 ▲104.29 ▲0.01106.86 ▲2.3945.87 ▲0.65

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

🔸 Tests weight: 35 | All plugins must uninstall correctly, removing their source code and extra database tables they might have created
It is recommended to fix the following
  • The uninstall procedure has failed, leaving 6 options in the database
    • theysaidso_admin_options
    • can_compress_scripts
    • db_upgraded
    • widget_recent-comments
    • widget_recent-posts
    • widget_theysaidso_widget

Smoke tests 50% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | This is a short smoke test looking for 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
  • 2× PHP files perform the action of outputting non-empty strings when accessed directly:
    • > /wp-content/plugins/notice-faq/public/partials/noticefaq-public-display.php
    • > /wp-content/plugins/notice-faq/admin/partials/noticefaq-admin-display.php
  • 1× PHP files trigger server-side errors or warnings when accessed directly:
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_action() in wp-content/plugins/notice-faq/blocks/noticefaq-block.php:28

User-side errors Passed 1 test

🔹 Test weight: 20 | This is a smoke test targeting browser errors/issues
There were no browser issues found

Optimizations

Plugin configuration 93% from 29 tests

readme.txt Passed 16 tests

The readme.txt file is an important file in your plugin as it is parsed by WordPress.org to prepare the public listing of your plugin
7 plugin tags: notice, blog, seo, wiki, rich snippet...

notice-faq/noticefaq.php 85% from 13 tests

"Notice - AI-powered editor for FAQ, blog, documentation & more" version 1.3.1's primary PHP file adds more information about the plugin and serves as the entry point for WordPress
You should first fix the following items:
  • Text Domain: You no longer need to specify the text domain since WordPress 4.6; it must be the same as the plugin slug
  • Main file name: Even though not officially enforced, the main plugin file should be the same as the plugin slug ("notice-faq.php" instead of "noticefaq.php")

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | Executable files are not allowed as they can serve as attack vectors
Everything looks great! No dangerous files found in this plugin698 lines of code in 19 files:
LanguageFilesBlank linesComment linesLines of code
PHP13124532379
CSS31627260
JavaScript3118559

PHP code Passed 2 tests

An short overview of logical lines of code, cyclomatic complexity, and other code metrics
Great job! No cyclomatic complexity issues were detected in this plugin
Cyclomatic complexity
Average complexity per logical line of code0.06
Average class complexity1.43
▷ Minimum class complexity1.00
▷ Maximum class complexity3.00
Average method complexity1.11
▷ Minimum method complexity1.00
▷ Maximum method complexity3.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes7
▷ Abstract classes00.00%
▷ Concrete classes7100.00%
▷ Final classes00.00%
Methods27
▷ Static methods27.41%
▷ Public methods2281.48%
▷ Protected methods00.00%
▷ Private methods518.52%
Functions4
▷ Named functions4100.00%
▷ Anonymous functions00.00%
Constants1
▷ Global constants1100.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

All PNG images should be compressed to minimize bandwidth usage for end users
16 PNG files occupy 0.03MB with 0.01MB in potential savings
Potential savings
Compression of 5 random PNG files using pngquant
FileSize - originalSize - compressedSavings
assets/images/youtubelogo.png2.29KB1.32KB▼ 42.21%
assets/images/youtube.png0.45KB0.34KB▼ 23.91%
assets/images/linkedin.png0.47KB0.34KB▼ 26.76%
assets/images/like.png1.06KB0.62KB▼ 41.62%
assets/images/vector.png2.83KB1.46KB▼ 48.33%