Queries the local side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type

# socket_getsockname

(PHP 4 >= 4.1.0, PHP 5, PHP 7, PHP 8)

socket_getsockname — Queries the local side of the given socket which may either result in host/port or in a Unix filesystem path, dependent on its type

### Description

socket_getsockname(Socket `$socket`, string `&$address`, int `&$port` = `null`): bool

> Note: socket_getsockname() should not be used with `AF_UNIX` sockets created with socket_connect(). Only sockets created with socket_accept() or a primary server socket following a call to socket_bind() will return meaningful values.

### Parameters

`socket`

  A Socket instance created with socket_create() or socket_accept().

`address`

  If the given socket is of type `AF_INET` or `AF_INET6`, socket_getsockname() will return the local IP address in appropriate notation (e.g. `127.0.0.1` or `fe80::1`) in the `address` parameter and, if the optional `port` parameter is present, also the associated port.

  If the given socket is of type `AF_UNIX`, socket_getsockname() will return the Unix filesystem path (e.g. `/var/run/daemon.sock`) in the `address` parameter.

`port`

  If provided, this will hold the associated port.

### Return Values

Returns `true` on success or `false` on failure. socket_getsockname() may also return `false` if the socket type is not any of `AF_INET`, `AF_INET6`, or `AF_UNIX`, in which case the last socket error code is not updated.

### Changelog

Version | Description
--- | ---
8.0.0 | `socket` is a Socket instance now; previously, it was a resource.

### See Also

- socket_getpeername() - Queries the remote side of the given socket
- socket_last_error() - Returns the last error on the socket
- socket_strerror() - Return a string describing a socket error

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open