| 1 |
=== Code Profiler - WordPress Performance Profiling and Debugging Made Easy === |
| 2 |
Contributors: bruandet, nintechnet |
| 3 |
Tags: profiler, debug, optimize, performance, seo, benchmark, statistics, debugging, speed, profiling |
| 4 |
Requires at least: 5.0 |
| 5 |
Tested up to: 6.4 |
| 6 |
Stable tag: 1.6.6 |
| 7 |
License: GPLv3 or later |
| 8 |
Requires PHP: 7.1 |
| 9 |
License URI: https://www.gnu.org/licenses/gpl-3.0.html |
| 10 |
|
| 11 |
A profiler to measure the performance of your WordPress plugins and themes. |
| 12 |
|
| 13 |
== Description == |
| 14 |
|
| 15 |
= A profiler to measure the performance of your WordPress plugins and themes. = |
| 16 |
|
| 17 |
Code Profiler helps you to measure the performance of your plugins and themes at the PHP level and to quickly find any potential problem in your WordPress installation. |
| 18 |
|
| 19 |
You can profile the frontend and backend of WordPress, a custom URL, or even send a POST payload, custom cookies and HTTP headers to profile a contact form, a checkout process or an AJAX action among many other possibilities. |
| 20 |
|
| 21 |
It generates an extremely detailed and easy to read analysis in the form of charts and tables that shows not only which plugin or theme, but also which PHP script, class, method and function is slowing down your website. It displays many useful additional information such as database queries, file I/O operations and disk I/O usage as well. |
| 22 |
|
| 23 |
It makes it very simple to locate any bottleneck problem in your themes or plugins in order to solve it and speed up your website. |
| 24 |
Install, activate it and you can start profiling your site right away. |
| 25 |
|
| 26 |
|
| 27 |
[youtube https://www.youtube.com/watch?v=3PLDk-ZvQtU] |
| 28 |
|
| 29 |
|
| 30 |
= Features = |
| 31 |
|
| 32 |
* Plugins & themes performance profiling. |
| 33 |
* [Pro] Scripts performance profiling. |
| 34 |
* [Pro] Methods & functions performance profiling. |
| 35 |
* [Pro] Database queries performance. |
| 36 |
* [Pro] Remote connections monitoring. |
| 37 |
* [Pro] File I/O operations monitoring. |
| 38 |
* File I/O statistics. |
| 39 |
* Disk I/O monitoring. |
| 40 |
* WP-CLI integration. |
| 41 |
* Export charts in PNG image format. |
| 42 |
* GET/POST methods, custom cookies and HTTP headers. |
| 43 |
* [Pro] Export all tables and charts in CSV file format. |
| 44 |
* [Pro] Filtering options |
| 45 |
|
| 46 |
Learn more about [Code Profiler Pro](https://code-profiler.com/). |
| 47 |
|
| 48 |
== Frequently Asked Questions == |
| 49 |
|
| 50 |
= What are the differences between Code Profiler and services such as Google PageSpeed or GTmetrix? = |
| 51 |
|
| 52 |
They are completely different: Code Profiler analyzes the code performance of your plugins and themes on your server, at the PHP level. Google PageSpeed and GTmetrix, instead, analyze the content of a web page from a browser's perspective. |
| 53 |
|
| 54 |
= Do I need to deactivate Code Profiler when I'm not using it ? = |
| 55 |
|
| 56 |
There's no need to deactivate Code Profiler when you don't use it, it has no performance impact on your site. |
| 57 |
Because an update can affect the performance of your site, you should consider running it after every plugin or theme update. |
| 58 |
|
| 59 |
= Is Code Profiler multisite compatible? = |
| 60 |
|
| 61 |
Code Profiler is multisite compatible. Note however that for security reasons, only the superadmin can run it. |
| 62 |
|
| 63 |
= What are the requirements for running Code Profiler? = |
| 64 |
|
| 65 |
* WordPress >=5.0. |
| 66 |
* PHP >=7.1 or 8.x. |
| 67 |
|
| 68 |
= What is your Privacy Policy? = |
| 69 |
|
| 70 |
Code Profiler does not collect any private data from you or your visitors. It does not use cookies either. Your website can run Code Profiler and be compliant with the General Data Protection Regulation (GDPR) or other similar privacy laws. |
| 71 |
|
| 72 |
|
| 73 |
== Installation == |
| 74 |
|
| 75 |
1. Upload the ZIP file from the WordPress "Plugins > Add New" menu. |
| 76 |
2. Activate the plugin. |
| 77 |
3. Plugin settings are located in the 'Code Profiler' menu. |
| 78 |
|
| 79 |
== Screenshots == |
| 80 |
|
| 81 |
1. Running the profiler. |
| 82 |
2. Plugins and Themes performance section. |
| 83 |
3. WP-CLI integration. |
| 84 |
4. File I/O statistics. |
| 85 |
5. Disk I/O statistics. |
| 86 |
6. [Pro version]: Scripts performance. |
| 87 |
7. [Pro version]: Methods and Functions performance. |
| 88 |
8. [Pro version]: CSV Export. |
| 89 |
9. [Pro version]: CSV Export. |
| 90 |
10. [Pro version]: File I/O List |
| 91 |
11. [Pro version]: Database queries performance. |
| 92 |
12. [Pro version]: Remote connections monitoring. |
| 93 |
|
| 94 |
== Changelog == |
| 95 |
|
| 96 |
= 1.6.6 (December 6, 2023) = |
| 97 |
|
| 98 |
* You can now profile JSON-encoded payloads: In the profiler's main page, click the "Advanced Options" button, then select "HTTP Method > POST > Content-type > application/json". |
| 99 |
* The Accuracy/precision level is now displayed in the tooltip when viewing a profile. |
| 100 |
* Performance and memory optimization. |
| 101 |
* [Pro version] : In the "Methods and Functions Performance" section "{main}" is now replaced with the corresponding include/require function (e.g., {include_once} , {require} etc). |
| 102 |
* [Pro version] : 2 new columns were added to the "File I/O List": Status and Resource id. The former will display if the file was closed or not, which could be helpful to detect plugins or themes that open files but don't close them before exiting, the latter the ID of that resource. |
| 103 |
* [Free version]: The directory were the profiler stores its logs can be user-defined, by adding the `CODE_PROFILER_UPLOAD_DIR` constant to your wp-config.php (e.g., `define('CODE_PROFILER_UPLOAD_DIR', '/full/path/to/folder');`. |
| 104 |
* [Pro version]: The directory were the profiler stores its logs can be user-defined, by adding the `CODE_PROFILER_PRO_UPLOAD_DIR` constant to your wp-config.php (e.g., `define('CODE_PROFILER_PRO_UPLOAD_DIR', '/full/path/to/folder');`. |
| 105 |
* Several small fixes and adjustments. |
| 106 |
|
| 107 |
= 1.6.5 (October 5, 2023) = |
| 108 |
|
| 109 |
* Updated Charts.js libraries. |
| 110 |
* Fixed potential PHP error when calling number_format function. |
| 111 |
* Small fixes and adjustments. |
| 112 |
|
| 113 |
= 1.6.4 (August 3, 2023) = |
| 114 |
|
| 115 |
* Added the possibility to send custom HTTP headers when profiling a site. See "Advanced Options > HTTP headers" in the profiler's main page. |
| 116 |
* Several small fixes and adjustments. |
| 117 |
* Updated Charts.js libraries. |
| 118 |
|
| 119 |
= 1.6.3 (June 18, 2023) = |
| 120 |
|
| 121 |
* A new option was added to tweak the size of the memory buffer used by the profiler. It can be found in "Settings > Buffer size". |
| 122 |
* The profiler will disable the PHP display_errors directive so that potential notice, warning and error messages won't mess up with the AJAX response. |
| 123 |
* Small fixes and adjustments. |
| 124 |
|
| 125 |
= 1.6.2 (May 20, 2023) = |
| 126 |
|
| 127 |
* Fixed an issue where the execution time in the "Plugins & Theme Performance" section did not include any occurred remote connection. |
| 128 |
* Updated Charts.js libraries. |
| 129 |
* Updated FAQ and Help sections. |
| 130 |
* Small fixes and adjustments. |
| 131 |
|
| 132 |
= 1.6.1 (April 22, 2023) = |
| 133 |
|
| 134 |
* Added a hook to prevent a timeout if a plugin changed cURL timeout options (props @davidbawiec). |
| 135 |
* Several small fixes and adjustments. |
| 136 |
|
| 137 |
= 1.6 (March 12, 2023) = |
| 138 |
|
| 139 |
* [Pro version]: We added a new section: Remote Connections. It shows all HTTP connections originating from your WordPress website and includes the URL, the HTTP status code, the duration and, as usual, a full backtrace. |
| 140 |
* Updated browser's signatures. |
| 141 |
* Updated Charts.js libraries. |
| 142 |
* Small fixes and adjustments. |
| 143 |
|
| 144 |
= 1.5.5 (February 24, 2023) = |
| 145 |
|
| 146 |
* Improved the system information report. |
| 147 |
* [Pro version] : When viewing a file, its name will be displayed in the title bar of the browser. |
| 148 |
* The log will be automatically deleted when it reaches 100KB. |
| 149 |
* Added a "Debug" checkbox below the log that can be used to increase its verbosity. |
| 150 |
* Updated Charts.js libraries. |
| 151 |
* Added a warning if the WordPress MU folder is not writable. |
| 152 |
* Several small fixes and adjustments. |
| 153 |
|
| 154 |
= 1.5.4 (January 18, 2023) = |
| 155 |
|
| 156 |
* Fixed a potential "404 Not Found" HTTP error when the site home page is different from the WordPress installation directory. |
| 157 |
|
| 158 |
= 1.5.3 (January 10, 2023) = |
| 159 |
|
| 160 |
* It is possible to edit the name of a profile by clicking the "Quick Edit" row action link below its name in the profiles list. |
| 161 |
* Updated Charts.js libraries. |
| 162 |
* Small fixes and adjustments. |
| 163 |
|
| 164 |
= 1.5.2 (December 07, 2022) = |
| 165 |
|
| 166 |
* Added screen reader accessibility to all 3 graphs (Plugins and Theme, File I/O, Disk I/O). |
| 167 |
* The timeout of the profiler's process was increased from 180 to 300 seconds. |
| 168 |
* [Pro version] : Fixed a bug where the file viewer couldn't locate a function in a script if there was a namespace declared, because it was looking for a method instead of a function. |
| 169 |
* Updated Charts.js libraries. |
| 170 |
* Small fixes and adjustments. |
| 171 |
|
| 172 |
= 1.5.1 (October 29, 2022) = |
| 173 |
|
| 174 |
* [Pro version] : The profiler can display a full backtrace for each caller function. That option can be enabled in "Settings > Methods & Functions > Generate a PHP backtrace for each caller function". |
| 175 |
* Compatibility with PHP 8.2. |
| 176 |
* Improved anonymous functions detection. |
| 177 |
* Updated Charts.js libraries. |
| 178 |
* [Pro version] : Updated Code Mirror libraries. |
| 179 |
* Small fixes and adjustments. |
| 180 |
|
| 181 |
= 1.5 (September 12, 2022) = |
| 182 |
|
| 183 |
* You can select the accuracy and precision level of the profiler. If you have a slow WordPress site with a lot of plugins installed and your server or reverse proxy is timing out when Code Profiler is running, you can lower the accuracy level in order to speed up the profiling process and avoid the server timeout. This option can be found in the "Settings" tab. |
| 184 |
* [Free version] : Similarly to the Pro version, the profiler will display a warning below the "Plugins and Themes Performance" chart if it detects that multiple plugins are using Composer dependency manager. |
| 185 |
* Added reverse proxy/CDN detection to the system information report. |
| 186 |
* Updated Charts.js libraries. |
| 187 |
* [Pro version] : Updated Code Mirror libraries. |
| 188 |
* Updated the user-agent signatures. |
| 189 |
* Small fixes and adjustments. |
| 190 |
|
| 191 |
= 1.4.4 (July 28, 2022) = |
| 192 |
|
| 193 |
* Mu-plugins are now processed by the profiler. They will have the "MU" abbreviation displayed beside their name on all graphs and tables. |
| 194 |
* We added a new "Support" tab in the profiler's page that displays a system information report. When contacting the support for help, please copy and paste it in your ticket. |
| 195 |
* [Pro version] : Code Profiler will temporarily disable any "wp-content/db.php" script found on your site to prevent it from interfering with the profiler and database queries. That option can be changed in the "Settings" page. |
| 196 |
* Fixed a potential "Serialization of Closure is not allowed" PHP error. |
| 197 |
* Small fixes and adjustments. |
| 198 |
|
| 199 |
= 1.4.3 (July 02, 2022) = |
| 200 |
|
| 201 |
* When running the profiler as an authenticated user, you can now enter the name of that user. |
| 202 |
* [Pro version] : Fixed a bug in the "File I/O List" section where files located outside the ABSPATH had their name truncated. |
| 203 |
* Updated Charts.js libraries. |
| 204 |
* [Pro version] : Updated Code Mirror libraries. |
| 205 |
* Small fixes and adjustments. |
| 206 |
|
| 207 |
= 1.4.2 (June 02, 2022) = |
| 208 |
|
| 209 |
* The profiler will memorize the settings used for the last profile. |
| 210 |
* In the "Profiles List" section, the "Filter" input field will also apply to the profiles name. |
| 211 |
* Added Edge browser to the user-agent signatures list box. |
| 212 |
* [Pro version] : You can export the list of profiles. Click on the "Download as a CSV file" button below the table in the "Profiles List" section. |
| 213 |
* Updated Charts.js libraries. |
| 214 |
* [Pro version] : Updated Code Mirror libraries. |
| 215 |
* Small fixes and adjustments. |
| 216 |
|
| 217 |
= 1.4.1 (April 26, 2022) = |
| 218 |
|
| 219 |
* Added an "Advanced Options" button in the profiler's main page that allows you to select the HTTP method (GET or POST), send a POST payload as well as custom cookies. Those features are helpful if, for instance, you want to profile a contact form, a checkout process or an AJAX action etc. |
| 220 |
* Small fixes and adjustments. |
| 221 |
* [Pro version]: Updated Code Mirror libraries. |
| 222 |
|
| 223 |
= 1.4 (March 30, 2022) = |
| 224 |
|
| 225 |
* [Pro version]: We added a new section: "Database queries performances". It shows all database queries for the plugins and the theme, their processing time and a backtrace that lists the scripts and function calls that lead to the query. |
| 226 |
* [Pro version]: All "Name" columns were renamed to "Component". |
| 227 |
* Fixed an issue in the "Plugins and Theme" graph where special characters were wrongly replaced with their HTML entities. |
| 228 |
* WP-CLI: Fixed an issue where all error and warning messages were json-encoded. |
| 229 |
* The cURL timeout was increased from 90 to 180 seconds. |
| 230 |
* Updated Charts.js libraries. |
| 231 |
* [Pro version]: Updated Code Mirror libraries. |
| 232 |
* Small fixes and adjustments. |
| 233 |
|
| 234 |
= 1.3.1 (February 26, 2022) = |
| 235 |
|
| 236 |
* Fixed some bugs with right-to-left (RTL) WordPress sites: the tooltip in the profiler main page and the checkboxes below the log were all messed up. |
| 237 |
* By default, the profiler will always abort and throw an error if the server didn't return a "200 OK" HTTP status code. You can change that behaviour in the "Settings" section if the page you are profiling needs to return a different code (3xx, 4xx or 5xx). |
| 238 |
* WP-CLI: Added support for HTTP basic authentication with the `--u` and `--p` parameters. Run `wp code-profiler help` for more details. |
| 239 |
* WP-CLI: Added support for WordPress user authentication with the `--user` parameter. Run `wp code-profiler help` for more details. |
| 240 |
* [Pro version]: WP-CLI: You can now profile any page/post with the `--dest` parameter. Run `wp code-profiler-pro help` for more details. |
| 241 |
* When disabling the plugin, it will delete its MU plugin. |
| 242 |
* The list of posts has been removed from the dropdown menu. To profile a post, please use the new "Custom post" input field that was introduced in v1.2. |
| 243 |
* [Pro version]: Fixed a bug in the "Method & Function" table where the action links were not working on smartphones because of a wrong value used for the colspan attribute. |
| 244 |
* [Pro version] : Replaced strcmp() with strnatcmp() to sort some table columns with a "natural order" algorithm. |
| 245 |
* You can exclude a plugin during the profiling by using the "Freesoul Deactivate Plugins" plugin available in the WordPress.org repo. See "Is it possible to exclude a plugin during the profiling?" in the "FAQ" section. |
| 246 |
* Small fixes and adjustments. |
| 247 |
|
| 248 |
= 1.3 (February 21, 2022) = |
| 249 |
|
| 250 |
* The "Profiles List" table has now 5 new sortable columns that will display several important metrics: "Items" (number of plugins + the current theme), "Time" (execution time in seconds), "Memory" (peak memory in megabytes), "File I/O" (sum of all file I/O operations) and "SQL" (number of database queries). Note that those metrics will be displayed on profiles created with this new version of Code Profiler, not on older profiles. The same metrics can be seen on each profile's page (click on the tooltip beside the profile's name) and also when running the profiler from the WP-CLI command line tool. |
| 251 |
* [Pro version] : The "Methods & Functions Performance" section now shows all callers of a function. Clicking on the "View Call" action link opens a new row with the list of callers and, for each one, the full path and line number. |
| 252 |
* [Pro version] : Fixed a bug in the "File I/O List" section where it was not possible to open a renamed file in the file viewer. |
| 253 |
* [Pro version] : It's possible to enter your license from WP-CLI command line (`wp code-profiler-pro license`). |
| 254 |
* Fixed a bug where temporary files were not deleted after an HTTP error. |
| 255 |
* Fixed a bug where the columns sorting order was not remembered after deleting a profile in the "Profiles List" table. |
| 256 |
* Small fixes and adjustments. |
| 257 |
|
| 258 |
= 1.2 (January 30, 2022) = |
| 259 |
|
| 260 |
* Added the possibility to profile custom post types and custom URI. |
| 261 |
* Added support for HTTP Basic authentication. If you're running Code Profiler on a staging site that is password protected, the profiler should automatically detect it. |
| 262 |
* Added an option to disable WordPress WP-Cron when running the profiler. This option will prevent WP-Cron to run scheduled tasks in the background that could affect the results of the profiler. It is enabled by default. |
| 263 |
* Small fixes and adjustments. |
| 264 |
|
| 265 |
= 1.1.1 (January 12, 2022) = |
| 266 |
|
| 267 |
* Fixed a potential error when running the profiler. |
| 268 |
|
| 269 |
= 1.1 (January 11, 2022) = |
| 270 |
|
| 271 |
* Added support for WP-CLI: you can run the profiler from a terminal. Enter `wp code-profiler help` to display the available command line options. WP-CLI integration can be turned on/off in the plugin "Settings" page. |
| 272 |
* Updated Chart.js library. |
| 273 |
* [Pro version]: Updated Codemirror libraries. |
| 274 |
* Small fixes and adjustments. |
| 275 |
|
| 276 |
= 1.0.1 (December 26, 2021) = |
| 277 |
|
| 278 |
* Added compatibility with blogs that have permalinks disabled (e.g., `?page_id=1` or `?p=1`). |
| 279 |
* Added compatibility with child pages (e.g., `/foo/bar/`). |
| 280 |
* Added some extra HTTP headers to prevent aggressive caching. |
| 281 |
|
| 282 |
= 1.0 (December 12, 2021) = |
| 283 |
|
| 284 |
* Initial release. |
| 285 |
|
