stream_wrapper_register

Function • Params and return types changed in PHP 8.0

Register a URL wrapper implemented as a PHP class.

PHP 5
PHP 7
PHP 8.0
Improved
PHP 8.1
PHP 8.2-8.3
PHP 8.4
PHP 8.5
PHP 8.6

stream_wrapper_register Function synopsis

stream_wrapper_register(
    string $protocol,
    string $class,
    int $flags = 0
  ): bool

Parameters

$protocol

Typestring

The wrapper name to be registered. Valid protocol names must contain alphanumerics, dots (.), plusses (+), or hyphens (-) only.

$class

Typestring

The classname which implements the $protocol.

$flags

OptionalTypeintDefault value0

Should be set to STREAM_IS_URL if $protocol is a URL protocol. Default is 0, local stream.

$flags accepts the following constant value

Return value

Typebool

Returns true on success, false on failure

stream_wrapper_register will return false if the $protocol already has a handler.

Changes to the stream_wrapper_register Function

PHP 8.0

  • Return type added: bool
  • Parameter type added for parameter #1 ($protocol): string
  • Parameter name of parameter #2 changed: $classname to $class
  • Parameter type added for parameter #2 ($class): string
  • Parameter type added for parameter #3 ($flags): int
  • Parameter default value added for position #3 ($flags): 0
  stream_wrapper_register(
-     $protocol,
+     string $protocol,
-     $classname,
+     string $class,
-     $flags
+     int $flags = 0
-   )
+   ): bool

stream_wrapper_register Function Availability

PHP VersionAvailability
PHP 8.6Upcoming Release Yes
PHP 8.5Supported (Latest) Yes
PHP 8.4Supported Yes
PHP 8.3Security-Fixes Only Yes
PHP 8.2Security-Fixes Only Yes
PHP 8.1Unsupported Yes
PHP 8.0Unsupported Yes
PHP 7.4Unsupported Yes
PHP 7.3Unsupported Yes
PHP 7.2Unsupported Yes
PHP 7.1Unsupported Yes
PHP 7.0Unsupported Yes
PHP 5.6Unsupported Yes
PHP 5.5Unsupported Yes
PHP 5.4Unsupported Yes
PHP 5.3Unsupported Yes