Add a check to ensure we have a valid PHP version before loading plugin functionality and output an admin notice if needed by kmgalanakis · Pull Request #210 · 10up/insert-special-characters

kmgalanakis · 2023-08-14T07:56:41Z

Description of the Change

In this PR, I'm adding a check for the minimum required PHP version before attempting to load the plugin files. If the condition is not met an admin notice is displayed and the plugin files are not loaded.

Closes #205

How to test the Change

To see the admin notice and have the plugin functionality not loaded, try to load the plugin on a site with PHP version lower that 7.4.

Changelog Entry

Added - Check for minimum required PHP version before loading the plugin

Credits

Props @kmgalanakis

Checklist:

I agree to follow this project's Code of Conduct.
I have updated the documentation accordingly.
I have added tests to cover my change.
All new and existing tests pass.

…in functionality and output an admin notice if needed

peterwilsoncc

I've added some notes about keeping the main file compatible with 5.6 while moving the functionality in to another file.

In .github/workflows/php-compatibility.yml I suggest modifying the compatibility checks to:

- name: Run PHP Compatibility on all files.
  run: vendor/bin/phpcs inc --standard=PHPCompatibilityWP --extensions=php --runtime-set testVersion 7.4-

- name: Run PHP Compatibility on main file.
  run: vendor/bin/phpcs insert-special-characters.php --standard=PHPCompatibilityWP --extensions=php --runtime-set testVersion 5.6-

peterwilsoncc · 2023-09-01T02:54:37Z

insert-special-characters.php

+ *
+ * @return string Minimum version required.
+ */
+function minimum_php_requirement(): string {


Suggested change

function minimum_php_requirement(): string {

function minimum_php_requirement() {

The PHP version check needs to run in PHP 5.6+ (as we support pre 6.3 versions of WP).

peterwilsoncc · 2023-09-01T02:54:52Z

insert-special-characters.php

+ *
+ * @return bool True if meets minimum requirements, false otherwise.
+ */
+function site_meets_php_requirements(): bool {


Suggested change

function site_meets_php_requirements(): bool {

function site_meets_php_requirements() {

As above.

peterwilsoncc · 2023-09-01T02:59:15Z

insert-special-characters.php

+	);
+	return;
+}
+


I suggest moving everything below this point in to /inc/plugin.php or similar.

This will allow the team to keep this file compatible with older versions of PHP while using newer PHP features in the rest of the plugin. If everything is kept in the one file, we risk syntax errors causing a fatal error and preventing the compatibility check from running.

You can see the approach in the Distributor main plugin file.

peterwilsoncc · 2023-09-01T03:02:43Z

insert-special-characters.php

+					<?php
+					echo wp_kses_post(
+						sprintf(
+						/* translators: %s: Minimum required PHP version */


Nit: increase indentation of this line.

…nality in a separate file

kmgalanakis · 2023-09-15T15:13:45Z

I've added some notes about keeping the main file compatible with 5.6 while moving the functionality in to another file.

In .github/workflows/php-compatibility.yml I suggest modifying the compatibility checks to:
- name: Run PHP Compatibility on all files.
  run: vendor/bin/phpcs inc --standard=PHPCompatibilityWP --extensions=php --runtime-set testVersion 7.4-

- name: Run PHP Compatibility on main file.
  run: vendor/bin/phpcs insert-special-characters.php --standard=PHPCompatibilityWP --extensions=php --runtime-set testVersion 5.6-

Done @peterwilsoncc thank you

…he rest of the plugin

jeffpaul · 2023-09-15T20:22:00Z

@peterwilsoncc back to you for review/testing

inc/plugin.php

peterwilsoncc

LGTM, Thank you!

Testing notes:

WP 6.2, PHP 5.6: Warning shows
WP 6.2, PHP 7.4: Warning does not show

peterwilsoncc · 2023-09-19T00:44:02Z

E2E tests are failing on the develop branch for the same versions of WP, I presume due to markup changes.

Merging in.

kmgalanakis requested a review from a team as a code owner August 14, 2023 07:56

kmgalanakis requested review from peterwilsoncc and removed request for a team August 14, 2023 07:56

kmgalanakis mentioned this pull request Aug 14, 2023

Add PHP checks #205

Closed

jeffpaul added this to the 1.1.0 milestone Aug 14, 2023

jeffpaul assigned kmgalanakis Aug 14, 2023

Add a check to ensure we have a valid PHP version before loading plug…

d96e05c

…in functionality and output an admin notice if needed

kmgalanakis force-pushed the feature/add-php-checks branch from eac6ee5 to d96e05c Compare August 18, 2023 05:21

Merge branch 'develop' into feature/add-php-checks

8fd7f2c

peterwilsoncc requested changes Sep 1, 2023

View reviewed changes

Make main plugin file PHP 5.6 compatible and move main plugin functio…

3f189d4

…nality in a separate file

kmgalanakis requested a review from jeffpaul as a code owner September 15, 2023 15:13

kmgalanakis force-pushed the feature/add-php-checks branch 2 times, most recently from 0081529 to 2e21681 Compare September 15, 2023 15:25

Add PHP Compatibility check for 5.6 on the main file and fo 7.4 for t…

501dc62

…he rest of the plugin

kmgalanakis force-pushed the feature/add-php-checks branch from 2e21681 to 501dc62 Compare September 15, 2023 15:29

kmgalanakis requested a review from peterwilsoncc September 15, 2023 16:00

jeffpaul removed their request for review September 18, 2023 13:17

Merge branch 'develop' into feature/add-php-checks

ab4ecb9

peterwilsoncc reviewed Sep 19, 2023

View reviewed changes

inc/plugin.php Show resolved Hide resolved

CS: Whitespace cleanup.

0db1ff1

peterwilsoncc approved these changes Sep 19, 2023

View reviewed changes

peterwilsoncc merged commit c3dc156 into develop Sep 19, 2023

peterwilsoncc deleted the feature/add-php-checks branch September 19, 2023 00:44

	function minimum_php_requirement(): string {
	function minimum_php_requirement() {

	function site_meets_php_requirements(): bool {
	function site_meets_php_requirements() {

Conversation

kmgalanakis commented Aug 14, 2023

Description of the Change

How to test the Change

Changelog Entry

Credits

Checklist:

Uh oh!

peterwilsoncc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kmgalanakis commented Sep 15, 2023

Uh oh!

jeffpaul commented Sep 15, 2023

Uh oh!

Uh oh!

peterwilsoncc left a comment

Choose a reason for hiding this comment

Uh oh!

peterwilsoncc commented Sep 19, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants