pcntl_setpriority

Function • Params and return types changed in PHP 8.0

Change the priority of any process.

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

pcntl_setpriority Function synopsis

pcntl_setpriority(
    int $priority,
    ?int $process_id = null,
    int $mode = PRIO_PROCESS
  ): bool

Parameters

$priority

Typeint

$priority is generally a value in the range -20 to 20. The default priority is 0 while a lower numerical value causes more favorable scheduling. Because priority levels can differ between system types and kernel versions, please see your system's setpriority(2) man page for specific details.

$process_id

OptionalType?intDefault valuenull

If null, the process id of the current process is used.

$mode

OptionalTypeintDefault valuePRIO_PROCESS

One of PRIO_PGRP, PRIO_USER, PRIO_PROCESS, PRIO_DARWIN_BG or PRIO_DARWIN_THREAD.

Return value

Typebool

Returns true on success, false on failure

Changes to the pcntl_setpriority Function

PHP 8.0

  • Return type added: bool
  • Parameter type added for parameter #1 ($priority): int
  • Parameter name of parameter #2 changed: $pid to $process_id
  • Parameter type added for parameter #2 ($process_id): ?int
  • Parameter default value added for position #2 ($process_id): null
  • Parameter name of parameter #3 changed: $process_identifier to $mode
  • Parameter type added for parameter #3 ($mode): int
  • Parameter default value added for position #3 ($mode): PRIO_PROCESS
  pcntl_setpriority(
-     $priority,
+     int $priority,
-     $pid,
+     ?int $process_id = null,
-     $process_identifier
+     int $mode = PRIO_PROCESS
-   )
+   ): bool

pcntl_setpriority 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