wp-debugging / readme.txt

readme.txt in WP Debugging 2.10.1, at readme.txt

196 lines 7.0 KB

Raw Download Zip

1	# WP Debugging
2
3	Contributors: afragen
4	Tags: debug, support, wp-config
5	Requires at least: 4.6
6	Requires PHP: 5.6
7	Tested up to: 5.8
8	Stable tag: 2.10.1
9	Donate link: https://thefragens.com/git-updater-donate
10	License: MIT
11
12	A support/troubleshooting plugin for WordPress.
13
14	## Description
15
16	This plugin sets the following debug constants in `wp-config.php` on plugin activation and removes them on plugin deactivation. Any errors will result in a PHP Exception being thrown. Debug constants per [Debugging in WordPress](https://codex.wordpress.org/Debugging_in_WordPress).
17
18	Default settings:
19
20	define( 'WP_DEBUG_LOG', true );
21	define( 'SCRIPT_DEBUG', true );
22	define( 'SAVEQUERIES', true );
23
24
25	`@ini_set( 'display_errors', 1 );` is set when the plugin is active. `WP_DEBUG` is set to true when the plugin is first run, thereafter it can be turned off in the Settings.
26
27	The Settings page allows the user to set the following.
28
29	define( 'WP_DEBUG', true ); // Default on initial plugin installation.
30	define( 'WP_DEBUG_DISPLAY', false ); // Default when not declared is true.
31	define( 'WP_DISABLE_FATAL_ERROR_HANDLER', true ); // WordPress 5.2 WSOD Override.
32
33	When the plugin is deactivated best efforts are made to re-add pre-existing constants to their former state. When the plugin is activated the default settings and any saved settings are restored.
34
35	This plugin uses the [wp-cli/wp-config-transformer](https://github.com/wp-cli/wp-config-transformer) command for writing constants to `wp-config.php`.
36
37	[Debug Quick Look](https://github.com/norcross/debug-quick-look) from Andrew Norcross is included with this plugin to assist in reading the debug.log file. If you already have this plugin installed you should delete it when WP Debugging is not active.
38
39	[Query Monitor](https://wordpress.org/plugins/query-monitor/) and [Debug Bar](https://wordpress.org/plugins/debug-bar/) plugins are optional dependencies to aid in debugging and troubleshooting. The notice for installation will recur 45 days after being dismissed.
40
41	If you have a non-standard location for your `wp-config.php` file you can use the filter `wp_debugging_config_path` to return the file path for your installation.
42
43	The filter `wp_debugging_add_constants` allows the user to add constants to `wp-config.php`.
44
45	The filter returns an array where the key is the name of the constant and the value is an array of data containing the value as a string and a boolean to indicate whether or not the value should be passed without quotes.
46
47	$my_constants = [
48	'my_test_constant' =>
49	[
50	'value' => 'abc123',
51	'raw' => false,
52	],
53	'another_test_constant' => [ 'value' => 'true' ],
54	];
55
56	The `value` option contains the constant's value as a string.
57
58	The `raw` option means that instead of placing the value inside the config as a string it will become unquoted. The default is `true`. Set as `false` for non-boolean values.
59
60	Example:
61
62	add_filter(
63	'wp_debugging_add_constants',
64	function( $added_constants ) {
65	$my_constants = [
66	'my_test_constant' => [
67	'value' => '124xyz',
68	'raw' => false,
69	],
70	'another_test_constant' => [ 'value' => 'true' ],
71	];
72	return array_merge( $added_constants, $my_constants );
73	},
74	10,
75	1
76	);
77
78	This will create the following constants.
79
80	define( 'MY_TEST_CONSTANT', '124xyz' );
81	define( 'ANOTHER_TEST_CONSTANT', true );
82
83	## Screenshots
84
85	1. Settings Screen
86
87	## Development
88
89	PRs are welcome against the [develop branch on GitHub](https://github.com/afragen/wp-debugging).
90
91	## Changelog
92
93	#### 2.10.1 / 2021-07-23
94	* fix PHP Notice, `Settings:line 68`
95	* update Debug Quick Look admin bar menu for mobile
96
97	#### 2.10.0 / 2021-06-30
98	* update Debug Quick Look to show menu on mobile
99
100	#### 2.9.3 / 2021-06-22
101	* update WPConfigTransformer to use alternate anchor if default not present
102	* add @10up GitHub Actions for WordPress svn integration
103
104	#### 2.9.1 / 2020-11-17
105	* update `wp-dependency-installer` library
106	* update `wp-cli/wp-config-transformer`
107	* comment out quote normalization in `set_pre_activation_constants()`, not sure why I did that but it can cause problems [#10](https://github.com/afragen/wp-debugging/issues/10)
108
109	#### 2.9.0 / 2020-08-15
110	* use try/catch around use of `WPConfigTransformer` object
111
112	#### 2.8.0 / 2020-08-01
113	* exit if called directly
114	* NB: I have seen the `WPConfigTransformer` Exception error live. The issue seems to be that a `file_get_contents()` on the `wp-config.php` file path, at random times, returns an empty value. I'm done chasing this random error in `wp-cli/wp-config-transformer`. Modified version of `wp-cli/wp-config-transformer` present
115
116	#### 2.7.2 / 2020-06-01
117	* test `wp-config.php` everywhere, still occasional WSOD reports.
118
119	#### 2.7.1 / 2020-5-15
120	* return early if `wp-config.php` is empty before calling `WPConfigTransformer`
121
122	#### 2.7.0 / 2020-04-30
123	* start loading in `init` hook
124	* run `process_filter_constants()` as chained method in `Bootstrap`
125
126	#### 2.6.1 / 2020-03-28
127	* move `Settings` action link to front
128	* change test for `wp-config.php` file empty
129
130	#### 2.6.0 / 2020-02-28
131	* load autoloader in main file
132	* update composer dependencies
133
134	#### 2.5.8 / 2019-12-23
135	* badly messed up check for empty `wp-config.php`
136
137	#### 2.5.7 / 2019-12-20
138	* check and exit early if `wp-config.php` is empty
139	* return empty array for the above exit
140
141	#### 2.5.6 / 2019-11-02
142	* early exit if `wp-config.php` not set in specific functions
143
144	#### 2.5.5 / 2019-09-17
145	* update composer.json for wp-dependency-installer update, now requires at least PHP 5.6 for spread operator
146	* composer update
147
148	#### 2.5.4 / 2019-04-25
149	* added check for writable `wp-config.php`, exit with notice if not found
150
151	#### 2.5.3 / 2019-04-01
152	* update `Debug Quick Look` to display error log file path
153
154	#### 2.5.1 / 2019-04-01
155	* updated version of wp-cli/wp-config-transformer
156
157	#### 2.5.0 / 2019-03-25
158	* added `wp_debugging_add_constants` filter for users to add their own constants
159
160	#### 2.4.3 / 2019-03-09
161	* missed an output escape
162
163	#### 2.4.2 / 2019-02-26
164	* add `Domain Path` header
165
166	#### 2.4.1 / 2019-02-10
167	* refactor set/restore pre-activation constants
168
169	#### 2.4.0 / 2019-02-06
170	* save pre-activation constants for re-installation on deactivation ( say that 5x fast )
171
172	#### 2.3.0 / 2019-02-04
173	* look for `wp-config.php` in directory above `ABSPATH`
174	* add filter `wp_debugging_config_path` to set non-standard path to `wp-config.php`
175
176	#### 2.2.0 / 2019-02-02 🏈
177	* initial release on dot org
178
179	#### 2.1.1 / 2019-02-01
180	* only show WSOD bypass when appropriate
181	* update dependencies
182
183	#### 2.1.0 / 2019-01-26
184	* update Debug Quick Look, minor CSS changes
185	* Improve messaging
186	* add setting for WP_DISABLE_FATAL_ERROR_HANDLER constant (WSOD)
187	* add default setting of WP_DEBUG to true, can be changed
188
189	#### 2.0.0 / 2019-01-18
190	* total re-write
191	* add settings page
192	* use `wp-cli/wp-config-transformer` to change `wp-config.php`
193	* include `norcross/debug-quick-look` as dependency via composer but use my fork
194	* update POT via `composer.json` and wp-cli
195	* add image assets
196