wp-debugging / readme.txt

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

261 lines 8.4 KB

Raw Download Zip

1	# WP Debugging
2
3	Contributors: afragen
4	Tags: debug, support, wp-config
5	Requires at least: 5.2
6	Requires PHP: 5.6
7	Tested up to: 6.2
8	Stable tag: 2.11.20
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://wordpress.org/support/article/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.11.18, 2.11.19, 2.11.20 / 2023-02-07
94	* composer update
95
96	#### 2.11.17 / 2023-01-27
97	* updated link to _Debugging in WordPress_ and improved text for translators
98	* composer update
99
100	#### 2.11.16 / 2023-01-19
101	* composer update
102
103	#### 2.11.15 / 2023-01-02
104	* composer update
105
106	#### 2.11.14 / 2022-07-15
107	* composer update
108
109	#### 2.11.13 / 2022-06-23
110	* make anchor `preg_match` more greedy
111
112	#### 2.11.12 / 2022-05-29
113	* update to latest `afragen/debug-quick-look`
114
115	#### 2.11.11 / 2022--5-16
116	* update `wp-dismiss-notice` with transient and only poll `wp_remote_get()` weekly
117
118	#### 2.11.10 / 2022-05-10
119	* use `sanitize_key()` for nonces
120	* composer update
121
122	#### 2.11.9 / 2022-02-05
123	* composer update
124
125	#### 2.11.8 / 2022-01-24
126	* load call to `WP_Dependency_Installer()` in `plugins_loaded` hook to avoid loading `pluggable.php`.
127	* update `WP_Dependency_Installer`
128
129	#### 2.11.7 / 2022-01-18
130	* fix logic in verify nonce conditional
131
132	#### 2.11.6 /2022-01-18
133	* proper nonce verification
134	* composer updates
135
136	#### 2.11.5 / 2022-01-11
137	* I messed up the release 🤦‍♂️
138
139	#### 2.11.4 / 2022-01-10
140	* composer updates
141
142	#### 2.11.3 / 2021-12-19
143	* more fixes via composer update
144
145	#### 2.11.2 / 2021-09-24
146	* composer update, cause of course I needed to fix something
147
148	#### 2.11.1 / 2021-09-24
149	* init in `plugins_loaded` hook
150	* composer update
151
152	#### 2.11.0 / 2021-09-23
153	* fix security issue for capabilities check, possible CSRF, and nonce checks.
154
155	#### 2.10.2 / 2021-09-04
156	* only use `esc_attr_e` for translating strings
157
158	#### 2.10.1 / 2021-07-23
159	* fix PHP Notice, `Settings:line 68`
160	* update Debug Quick Look admin bar menu for mobile
161
162	#### 2.10.0 / 2021-06-30
163	* update Debug Quick Look to show menu on mobile
164
165	#### 2.9.3 / 2021-06-22
166	* update WPConfigTransformer to use alternate anchor if default not present
167	* add @10up GitHub Actions for WordPress svn integration
168
169	#### 2.9.1 / 2020-11-17
170	* update `wp-dependency-installer` library
171	* update `wp-cli/wp-config-transformer`
172	* 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)
173
174	#### 2.9.0 / 2020-08-15
175	* use try/catch around use of `WPConfigTransformer` object
176
177	#### 2.8.0 / 2020-08-01
178	* exit if called directly
179	* 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
180
181	#### 2.7.2 / 2020-06-01
182	* test `wp-config.php` everywhere, still occasional WSOD reports.
183
184	#### 2.7.1 / 2020-5-15
185	* return early if `wp-config.php` is empty before calling `WPConfigTransformer`
186
187	#### 2.7.0 / 2020-04-30
188	* start loading in `init` hook
189	* run `process_filter_constants()` as chained method in `Bootstrap`
190
191	#### 2.6.1 / 2020-03-28
192	* move `Settings` action link to front
193	* change test for `wp-config.php` file empty
194
195	#### 2.6.0 / 2020-02-28
196	* load autoloader in main file
197	* update composer dependencies
198
199	#### 2.5.8 / 2019-12-23
200	* badly messed up check for empty `wp-config.php`
201
202	#### 2.5.7 / 2019-12-20
203	* check and exit early if `wp-config.php` is empty
204	* return empty array for the above exit
205
206	#### 2.5.6 / 2019-11-02
207	* early exit if `wp-config.php` not set in specific functions
208
209	#### 2.5.5 / 2019-09-17
210	* update composer.json for wp-dependency-installer update, now requires at least PHP 5.6 for spread operator
211	* composer update
212
213	#### 2.5.4 / 2019-04-25
214	* added check for writable `wp-config.php`, exit with notice if not found
215
216	#### 2.5.3 / 2019-04-01
217	* update `Debug Quick Look` to display error log file path
218
219	#### 2.5.1 / 2019-04-01
220	* updated version of wp-cli/wp-config-transformer
221
222	#### 2.5.0 / 2019-03-25
223	* added `wp_debugging_add_constants` filter for users to add their own constants
224
225	#### 2.4.3 / 2019-03-09
226	* missed an output escape
227
228	#### 2.4.2 / 2019-02-26
229	* add `Domain Path` header
230
231	#### 2.4.1 / 2019-02-10
232	* refactor set/restore pre-activation constants
233
234	#### 2.4.0 / 2019-02-06
235	* save pre-activation constants for re-installation on deactivation ( say that 5x fast )
236
237	#### 2.3.0 / 2019-02-04
238	* look for `wp-config.php` in directory above `ABSPATH`
239	* add filter `wp_debugging_config_path` to set non-standard path to `wp-config.php`
240
241	#### 2.2.0 / 2019-02-02 🏈
242	* initial release on dot org
243
244	#### 2.1.1 / 2019-02-01
245	* only show WSOD bypass when appropriate
246	* update dependencies
247
248	#### 2.1.0 / 2019-01-26
249	* update Debug Quick Look, minor CSS changes
250	* Improve messaging
251	* add setting for WP_DISABLE_FATAL_ERROR_HANDLER constant (WSOD)
252	* add default setting of WP_DEBUG to true, can be changed
253
254	#### 2.0.0 / 2019-01-18
255	* total re-write
256	* add settings page
257	* use `wp-cli/wp-config-transformer` to change `wp-config.php`
258	* include `norcross/debug-quick-look` as dependency via composer but use my fork
259	* update POT via `composer.json` and wp-cli
260	* add image assets
261