-
Notifications
You must be signed in to change notification settings - Fork 3.4k
PHP 8.6: Add polyfills for clamp() function for PHP compatibility #11669
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Soean
wants to merge
2
commits into
WordPress:trunk
Choose a base branch
from
Soean:65143
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+67
−2
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -535,6 +535,71 @@ function array_last( array $array ) { // phpcs:ignore Universal.NamingConvention | |
| } | ||
| } | ||
|
|
||
| /** | ||
| * Throws a ValueError (PHP 8.0+) or an InvalidArgumentException (PHP 7.x) with the given message. | ||
| * | ||
| * Helper for polyfills that need to throw ValueError but must also run on PHP 7.4. | ||
| * | ||
| * @ignore | ||
| * @since 7.1.0 | ||
| * @access private | ||
| * | ||
| * @param string $message The error message. | ||
| * @throws ValueError On PHP 8.0 and later. | ||
| * @throws InvalidArgumentException On PHP 7.x as a fallback. | ||
| */ | ||
| function _wp_throw_value_error( $message ) { | ||
| if ( ! class_exists( 'ValueError' ) ) { | ||
|
|
||
| throw new InvalidArgumentException( $message ); | ||
| } | ||
|
|
||
| throw new ValueError( $message ); | ||
| } | ||
|
|
||
| if ( ! function_exists( 'clamp' ) ) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add some unit tests coverage for the function |
||
| /** | ||
| * Polyfill for `clamp()` function added in PHP 8.6. | ||
| * | ||
| * Clamps a value to be within the range of a given minimum and maximum. | ||
| * | ||
| * If the value is within the bounds, the original value is returned. | ||
| * If it is not within the bounds, the closest bound is returned. | ||
| * | ||
| * @since 7.1.0 | ||
| * | ||
| * @param mixed $value The value to clamp. | ||
| * @param mixed $min The minimum bound. Must be less than or equal to `$max`. | ||
| * @param mixed $max The maximum bound. Must be greater than or equal to `$min`. | ||
| * @return mixed The clamped value. | ||
| * | ||
| * @throws ValueError On PHP 8.0+: if `$min` is greater than `$max`, or if `$min` or `$max` is NAN. | ||
| * @throws InvalidArgumentException On PHP 7.x: if `$min` is greater than `$max`, or if `$min` or `$max` is NAN. | ||
| */ | ||
| function clamp( $value, $min, $max ) { | ||
| if ( is_float( $min ) && is_nan( $min ) ) { | ||
| _wp_throw_value_error( 'clamp(): Argument #2 ($min) cannot be NAN' ); | ||
| } | ||
|
|
||
| if ( is_float( $max ) && is_nan( $max ) ) { | ||
| _wp_throw_value_error( 'clamp(): Argument #3 ($max) cannot be NAN' ); | ||
| } | ||
|
|
||
| if ( $max < $min ) { | ||
| _wp_throw_value_error( 'clamp(): Argument #2 ($min) must be smaller than or equal to argument #3 ($max)' ); | ||
| } | ||
|
Comment on lines
+559
to
+589
|
||
|
|
||
| if ( $value < $min ) { | ||
| return $min; | ||
| } | ||
|
|
||
| if ( $value > $max ) { | ||
| return $max; | ||
| } | ||
|
|
||
| return $value; | ||
| } | ||
| } | ||
|
|
||
| // IMAGETYPE_AVIF constant is only defined in PHP 8.x or later. | ||
| if ( ! defined( 'IMAGETYPE_AVIF' ) ) { | ||
| define( 'IMAGETYPE_AVIF', 19 ); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why ignore?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
@ignorePHPDoc tag tells documentation generators to exclude the function from the generated documentation.It's only used by
clamp(). External code (plugins/themes) should never need to call it — they can throw their own exceptions directly.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍