pcntl_getpriority

Function • Params and return types changed in PHP 8.0

Get 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_getpriority Function synopsis

pcntl_getpriority(?int $process_id = null, int $mode = PRIO_PROCESS): int|false

Parameters

$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

Typeint|false

pcntl_getpriority returns the priority of the process or false on error. A lower numerical value causes more favorable scheduling.

Changes to the pcntl_getpriority Function

PHP 8.0

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

pcntl_getpriority 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