fix/270: undefined array offset #292

Sidsector9 · 2022-05-21T10:06:26Z

Description of the Change

This PR checks if the value returned by transient is an array before accessing an offset.
Also replaces the deprecated filter block_categories with block_categories_all

Closes #270

Verification Process

Set WP_DEBUG and WP_DEBUG_LOG to true
Using develop, open a page that uses the Sophi Automation Block
Delete all transients (wp transient delete --all) and reload the page
Observe the error on the page
Checkout to branch fix/270 and repeat (3)
Observe the error no longer exists on the page

Checklist:

I have read the CONTRIBUTING document.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have added tests to cover my change.
All new and existing tests passed.

Changelog Entry

Fixed: replace deprecated block_categories filter with block_categories_all.
Fixed: fix warning shown due to access of undefined array

Credits

Props @Sidsector9

cadic

@Sidsector9 thank you for the fix. Loogs good, just a concern about the better approach to test array offset

cadic · 2022-05-22T16:50:28Z

includes/classes/SiteAutomation/Request.php

@@ -176,7 +176,7 @@ private function set_status( $data ) {
 		);

 		if ( empty( $data['success'] ) ) {
-			$data['retry'] = $this->status['retry'] + 1;
+			$data['retry'] = is_array( $this->status ) ? $this->status['retry'] + 1 : 1;


Despite the fact that checking $this->status is array will resolve the issue, but it still a potential warning if retry offset doesn't exist in the array. Could we check for isset( $this->status['retry'] )?

@cadic I had similar thoughts, but checking the code I found $this->status is either set to a boolean or it is set to an array that always contains the retry key.

https://github.com/globeandmail/sophi-for-wordpress/blob/a4e6207727a7c82fc2b6d563f38f3da432bab406/includes/classes/SiteAutomation/Request.php#L169-L176

https://github.com/globeandmail/sophi-for-wordpress/blob/a4e6207727a7c82fc2b6d563f38f3da432bab406/includes/classes/SiteAutomation/Request.php#L184