PHP 8.6: Add polyfills for clamp() function for PHP compatibility#11669
PHP 8.6: Add polyfills for clamp() function for PHP compatibility#11669Soean wants to merge 2 commits intoWordPress:trunkfrom
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Soean
changed the title
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
| * | ||
| * Helper for polyfills that need to throw ValueError but must also run on PHP 7.4. | ||
| * | ||
| * @ignore |
There was a problem hiding this comment.
The @ignore PHPDoc 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.
Soean
changed the title
There was a problem hiding this comment.
Pull request overview
This PR introduces a WordPress core polyfill for the upcoming PHP clamp() function (PHP 8.6) to preserve compatibility with older PHP versions, and updates core call sites to use clamp() for value bounding.
Changes:
- Added
_wp_throw_value_error()helper to throwValueErroron PHP 8.0+ andInvalidArgumentExceptionon PHP 7.x. - Added a
clamp()polyfill with validation for NaN bounds and$min > $max. - Replaced manual
min(max())clamping logic withclamp()in embed and typography calculations.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/wp-includes/embed.php | Replaces manual width bounding with clamp() for oEmbed width calculation. |
| src/wp-includes/compat.php | Adds _wp_throw_value_error() and a PHP 8.6 clamp() polyfill. |
| src/wp-includes/block-supports/typography.php | Uses clamp() to constrain the computed minimum font size factor. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * @throws InvalidArgumentException On PHP 7.x as a fallback. | ||
| */ | ||
| function _wp_throw_value_error( $message ) { | ||
| if ( ! class_exists( 'ValueError' ) ) { |
| if ( ! function_exists( 'clamp' ) ) { | ||
| /** | ||
| * 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)' ); | ||
| } |
This pull request adds a polyfill for the new PHP 8.6
clamp()function to ensure compatibility with older PHP versions. It also introduces a helper function to throw the appropriate error type depending on the PHP version.New function polyfills and helpers:
_wp_throw_value_error()to throw aValueErroron PHP 8.0+ or anInvalidArgumentExceptionon PHP 7.x, providing consistent error handling for polyfills.clamp()function, which restricts a value within a specified minimum and maximum, including input validation and appropriate error throwing for invalid arguments.Trac ticket: https://core.trac.wordpress.org/ticket/65143
Use of AI Tools
AI assistance: Yes
Tool(s): GitHub Copilot
Model(s): Claude Opus 4.6
Used for: Code docs.
This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.