$sessiongetIP()

Get the IP address of the current user

Example

$ip = $session->getIP();
echo $ip; // outputs 111.222.333.444

Usage

// basic usage
$string = $session->getIP();

// usage with all arguments
$string = $session->getIP(bool $int = false, $useClient = false);

Arguments

NameType(s)Description
$int (optional)bool

Return as a long integer? Default:false

  • IPv6 addresses cannot be represented as an integer, so please note that using this int option makes it return a CRC32 integer when using IPv6 addresses 3.0.184+.
$useClient (optional)bool int

Give preference to client headers for IP? HTTP_CLIENT_IP and HTTP_X_FORWARDED_FOR Default:false

  • Specify integer 2 to include potential multiple CSV separated IPs (when provided by client).

Return value

string int

Returns string by default, or integer if $int argument indicates to.


$session methods and properties

API reference based on ProcessWire core version 3.0.252