Refines handling of 0 and empty height/width attributes #979
Conversation
|
@davisshaver in #974 you call out numbers with decimals specifically but I don't see any tests that have float dimensions. |
|
opps! fixing.. |
|
@westonruter Updated, sry about that. |
| @@ -174,14 +174,25 @@ protected function get_body_node() { | |||
| * @return float|int|string Returns a numeric dimension value, or an empty string. | |||
| */ | |||
| public function sanitize_dimension( $value, $dimension ) { | |||
| if ( empty( $value ) ) { | |||
|
|
|||
| /** | |||
There was a problem hiding this comment.
Minor thing, but this should be just:
// Allows 0 as valid dimension.Same for the comment below.
The /** comments are for phpdoc specifically, and there is no need for multi-line here.
| * Allows floats but parses them to integers. | ||
| */ | ||
| if ( false !== filter_var( $value, FILTER_VALIDATE_FLOAT ) ) { | ||
| return absint( $value ); |
There was a problem hiding this comment.
Should this not be floor( $value )?
There was a problem hiding this comment.
@westonruter Maybe? I am looking at the docs for floor() and round(). Both return floats. What about return absint( round( $value, 0 ) )?
There was a problem hiding this comment.
absint( -1.5 ) is 1 but floor( -1.5 ) is -1. In other words, we don't want to lose the sign, do we?
Somewhat strange in the docs there for floor():
Returns the next lowest integer value (as float)
So I suppose then this is what should be done:
return (int) floor( $value );The @return phpdoc should be updated to remove float?
There was a problem hiding this comment.
Correction: floor( -1.5 ) is 2, as is floor( -1.1 ). Maybe round() is better then:
return (int) round( $value, 0 );There was a problem hiding this comment.
@davisshaver Hold on. I don't see how decimals are invalid AMP:
There was a problem hiding this comment.
Agree about updating the @return statement.
I'd lean towards absint() to match the behavior on values that are already int, otherwise we may pass a negative height/width.
There was a problem hiding this comment.
True, negative numbers are illegal. But decimal-point values are allowed. So then I think it should be the following with the two conditionals being combined:
if ( is_numeric( $value ) ) {
return max( 0, floatval( $value ) );
}There was a problem hiding this comment.
Thanks for the discussion. I will update the PR tomorrow for another consideration
| $node->setAttribute( 'class', $class ); | ||
| } elseif ( | ||
| ! is_numeric( $node->getAttribute( 'width' ) ) | ||
| ) { |
There was a problem hiding this comment.
Indentation of this elseif line is inconsistent with the previous multi-line elseif.
| 'image_with_zero_width' => array( | ||
| '<p><img src="http://placehold.it/300x300" width="0" height="300" /></p>', | ||
| '<p><amp-img src="http://placehold.it/300x300" width="0" height="300" sizes="(min-width: 0px) 0px, 100vw" class="amp-wp-enforced-sizes"></amp-img></p>', | ||
| ), |
There was a problem hiding this comment.
Please also include a test with a zero width and height so we can ensure that the support topic is covered:
<img src="https://example.com/img.jpg" width="0" height="0" border="0">There was a problem hiding this comment.
Could you add a test for this?
|
Thanks for the review, will clean this up tomorrow AM! |
|
@westonruter all set for another 👀 ! Much appreciated |
westonruter
changed the title
|
Found this while searching for a solution where images have fractional value for the height property. It is weird but it happened during migration from Drupal to WP. Is there any way to tackle such images? Thanks. |
|
@sach-patel I wasn't able to see floats causing any validation errors. |
|
@davisshaver I have a related bug if you're interested: #1030 |
|
@westonruter img src="https://i.imgur.com/d1NBb20.gif" alt="" width="425" height="238.85" tag has been converted to amp-anim src="https://i.imgur.com/d1NBb20.gif" alt="" width="425" height="" sizes="(min-width: 425px) 425px, 100vw" class="amp-wp-enforced-sizes" Google SC is reporting this as "Invalid value for attribute in layout 'height' in tag 'amp-anim'". Is there any quick solution or patch? Thanks. |
|
@sach-patel the fix is coming in the 0.7 version of the plugin. I suggest testing 0.7-beta2 which should be out this week. |
| // Provide default dimensions for images whose dimensions we couldn't fetch. | ||
| if ( false !== $dimensions ) { | ||
| $node->setAttribute( 'width', $dimensions['width'] ); | ||
| $node->setAttribute( 'height', $dimensions['height'] ); |
There was a problem hiding this comment.
These should not have been removed. See #1117.
Alternate branch of #978 (comment) w/ spacing update.
Fixes #974