php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Doc Bug #78163 preg_quote() documented as accepting null for $delimiter, which actually throws
Submitted: 2019-06-14 15:29 UTC Modified: 2019-06-17 11:32 UTC
From: sp at fp dot de Assigned: cmb (profile)
Status: Closed Package: PCRE related
PHP Version: 7.3.6 OS:
Private report: No CVE-ID: None
View Developer Edit
Welcome back! If you're the original bug submitter, here's where you can edit the bug or add additional notes.
If you forgot your password, you can retrieve your password here.
Password:
Status:
Package:
Bug Type:
Summary:
From: sp at fp dot de
New email:
PHP Version: OS:

 

 [2019-06-14 15:29 UTC] sp at fp dot de 
Description:
------------
Referring to Nikitas post:
https://www.mail-archive.com/internals@lists.php.net/msg98043.html

> If you see something that is documented as =null, but does not behave the
> same when null is passed, please do report a bug.

preg_quote() seems to fall under that category:
https://www.php.net/manual/en/function.preg-quote.php

It is documented as:
preg_quote ( string $str [, string $delimiter = NULL ] ) : string

But actually passing NULL as second argument throws TypeError with strict_types=1:
"Fatal error: Uncaught TypeError: preg_quote() expects parameter 2 to be string, null given"

Test script:
---------------
https://3v4l.org/ufjFF

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2019-06-14 15:33 UTC] requinix@php.net 
Per the source, the actual default value is "\0" (which is always quoted anyways).
 [2019-06-14 16:07 UTC] cmb@php.net
-Status: Open +Status: Verified -Assigned To: +Assigned To: cmb
 [2019-06-14 16:11 UTC] cmb@php.net 
Automatic comment from SVN on behalf of cmb
Revision: http://svn.php.net/viewvc/?view=revision&revision=347600
Log: Fix #78163: preg_quote() documented as accepting null for $delimiter, which actually throws
 [2019-06-14 16:15 UTC] salathe@php.net 
Automatic comment on behalf of cmb
Revision: http://git.php.net/?p=doc/en.git;a=commit;h=8a69739e04cbd1ad962d32609bc961c153572590
Log: Fix #78163: preg_quote() documented as accepting null for $delimiter, which actually throws
 [2019-06-14 16:15 UTC] salathe@php.net
-Status: Verified +Status: Closed
 [2019-06-17 11:32 UTC] nikic@php.net 
Fixed in php-src in https://github.com/php/php-src/commit/03db04c3aba03fd55c94c9d834a6c151e351cfc5.

I'd recommend reverting the docs change for clarity. "\0" is a convenient value for internal use, but not a good choice for a user-facing default.
 [2019-06-17 12:35 UTC] cmb@php.net 
Automatic comment from SVN on behalf of cmb
Revision: http://svn.php.net/viewvc/?view=revision&revision=347611
Log: Merged revision(s) 347600 from phpdoc/en/trunk:
Fix #78163: preg_quote() documented as accepting null for $delimiter, which actually throws
........
Cf. <https://bugs.php.net/bug.php?id=78163#1560771170>.
 [2019-06-17 12:40 UTC] salathe@php.net 
Automatic comment on behalf of cmb
Revision: http://git.php.net/?p=doc/en.git;a=commit;h=6b9ffc2ffc7f740c8a92b57e8b78b69f937d1f8a
Log: Merged revision(s) 347600 from phpdoc/en/trunk: Fix #78163: preg_quote() documented as accepting null for $delimiter, which actually throws ........ Cf. <https://bugs.php.net/bug.php?id=78163#1560771170>.
 [2020-02-07 06:04 UTC] phpdocbot@php.net 
Automatic comment on behalf of cmb
Revision: http://git.php.net/?p=doc/en.git;a=commit;h=82cff784b0822fc8d51cd93338e2dad58732f0c8
Log: Merged revision(s) 347600 from phpdoc/en/trunk: Fix #78163: preg_quote() documented as accepting null for $delimiter, which actually throws ........ Cf. <https://bugs.php.net/bug.php?id=78163#1560771170>.
 [2020-02-07 06:05 UTC] phpdocbot@php.net 
Automatic comment on behalf of cmb
Revision: http://git.php.net/?p=doc/en.git;a=commit;h=568cd695298b68e72670addcac0f78d4834114c2
Log: Fix #78163: preg_quote() documented as accepting null for $delimiter, which actually throws
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved. 		Last updated: Sun Dec 22 01:01:30 2024 UTC