Skip to content

ext/standard: Deprecate passing string which are not one byte long to ord() #19440

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 14, 2025
Merged

ext/standard: Deprecate passing string which are not one byte long to ord() #19440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0d74d09
ext/standard: Deprecate passing string which are not one byte long to…
Girgias Aug 9, 2025
908534d
fix?
nielsdos Sep 11, 2025
000fe44
Review
Girgias Sep 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Zend/tests/constants/class_constants_005.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ String interning during constants substitution
opcache.enable_cli=0
--FILE--
<?php
define ("A", "." . ord(26) . ".");
define ("A", "." . ord(2) . ".");
eval("class A {const a = A;}");
var_dump(A::a);
?>
Expand Down
Binary file modified Zend/tests/nullsafe_operator/013.phpt
View file
Open in desktop
Binary file not shown.
16 changes: 10 additions & 6 deletions Zend/zend_compile.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4186,14 +4186,18 @@ static zend_result zend_compile_func_chr(znode *result, const zend_ast_list *arg
}
/* }}} */

static zend_result zend_compile_func_ord(znode *result, zend_ast_list *args) /* {{{ */
static zend_result zend_compile_func_ord(znode *result, const zend_ast_list *args) /* {{{ */
{
if (args->children == 1 &&
args->child[0]->kind == ZEND_AST_ZVAL &&
Z_TYPE_P(zend_ast_get_zval(args->child[0])) == IS_STRING) {

zval *str;
if (
args->children == 1
&& args->child[0]->kind == ZEND_AST_ZVAL
&& (str = zend_ast_get_zval(args->child[0]))
&& Z_TYPE_P(str) == IS_STRING
&& Z_STRLEN_P(str) == 1
) {
result->op_type = IS_CONST;
ZVAL_LONG(&result->u.constant, (unsigned char)Z_STRVAL_P(zend_ast_get_zval(args->child[0]))[0]);
ZVAL_LONG(&result->u.constant, (unsigned char)Z_STRVAL_P(str)[0]);
return SUCCESS;
} else {
return FAILURE;
Expand Down
2 changes: 1 addition & 1 deletion ext/mbstring/tests/gb18030_2022_encoding.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ readGB18030_2022_ConversionTable(__DIR__ . '/data/GB18030-2022MappingTableBMP.tx
findInvalidChars($toUnicode, $invalid, $truncated);

function notFourByteCode($gb) {
return ((ord($gb) < 0x81 || ord($gb) > 0x84) && (ord($gb) < 0x90 || ord($gb) > 0xE3)) ||
return ((ord($gb[0]) < 0x81 || ord($gb[0]) > 0x84) && (ord($gb[0]) < 0x90 || ord($gb[0]) > 0xE3)) ||
(strlen($gb) > 1 && (ord($gb[1]) < 0x30 || ord($gb[1]) > 0x39));
}

Expand Down
2 changes: 1 addition & 1 deletion ext/mbstring/tests/gb18030_encoding.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ $gb18030_BMP_Mappings = [
findInvalidChars($toUnicode, $invalid, $truncated);

function notFourByteCode($gb) {
return ((ord($gb) < 0x81 || ord($gb) > 0x84) && (ord($gb) < 0x90 || ord($gb) > 0xE3)) ||
return ((ord($gb[0]) < 0x81 || ord($gb[0]) > 0x84) && (ord($gb[0]) < 0x90 || ord($gb[0]) > 0xE3)) ||
(strlen($gb) > 1 && (ord($gb[1]) < 0x30 || ord($gb[1]) > 0x39));
}

Expand Down
9 changes: 9 additions & 0 deletions ext/standard/string.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2655,6 +2655,15 @@ PHP_FUNCTION(ord)
Z_PARAM_STR(str)
ZEND_PARSE_PARAMETERS_END();

if (UNEXPECTED(ZSTR_LEN(str) != 1)) {
if (ZSTR_LEN(str) == 0) {
php_error_docref(NULL, E_DEPRECATED,
"Providing an empty string is deprecated");
} else {
php_error_docref(NULL, E_DEPRECATED,
"Providing a string that is not one byte long is deprecated. Use ord($str[0]) instead");
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what happens if the deprecation is converted to an exception - should RETURN_LONG still be used? Can you add a test case for that?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case of a conversion, the return value is simply discarded by the VM or JIT. So no special exception handling is needed

RETURN_LONG((unsigned char) ZSTR_VAL(str)[0]);
}
/* }}} */
Expand Down
2 changes: 1 addition & 1 deletion ext/standard/tests/strings/get_html_translation_table_basic6.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Test get_html_translation_table() function : basic functionality - HTML 5/Window
--FILE--
<?php

function so($a,$b) { return ord($a) - ord($b); }
function so($a,$b) { return ord($a[0]) - ord($b[0]); }

echo "*** Testing get_html_translation_table() : basic functionality - HTML 5/Windows-1251 ***\n";

Expand Down
2 changes: 0 additions & 2 deletions ext/standard/tests/strings/ord_basic.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ var_dump(ord("@"));
var_dump(ord("\n"));
var_dump(ord("\x0A"));
var_dump(ord("\xFF"));
var_dump(ord("Hello"));

// Make sure all valid ascii chars round trip
for ($i = 0; $i < 255; $i++) {
Expand All @@ -37,4 +36,3 @@ int(64)
int(10)
int(10)
int(255)
int(72)
15 changes: 15 additions & 0 deletions ext/standard/tests/strings/ord_not_1_byte.phpt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
--TEST--
ord() with values not one byte long
--FILE--
<?php

var_dump(ord(""));
var_dump(ord("Hello"));

?>
--EXPECTF--
Deprecated: ord(): Providing an empty string is deprecated in %s on line 3
int(0)

Deprecated: ord(): Providing a string that is not one byte long is deprecated. Use ord($str[0]) instead in %s on line 4
int(72)
Loading