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

socket_getsockname( Socket$socket, stringaddress, [intport = null] ): bool

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.



A Socket instance created with socket_create or socket_accept.


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. 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.


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.


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

Related Functions