This page is In Progress

Notice: The WebPlatform project, supported by various stewards between 2012 and 2015, has been discontinued. This site is now available on github.

referrer

Summary

Gets the URL of the location that referred the user to the current document.

Property of dom/Documentdom/Document

Syntax

Note: This property is read-only.

var referrerURL = document.referrer;

Return Value

Returns an object of type StringString

The URL of the referring document, or an empty string.

Notes

  • It returns a value only when the user reaches the current document through a link from the previous document. Otherwise, it returns an empty string.

For example, if DocumentA.htm includes a link to DocumentB.htm, and the user clicks that link, the document.referrer on DocumentB.htm returns “DocumentA.htm.” However, if the user is on DocumentA.htm and types DocumentB.htm into the address line or using some kind of “Open” method of the browser to get to DocumentB.htm, it returns the empty string.

  • It also returns an empty string when the link is from a secure site.

Related specifications

DOM Level 2 HTML
Recommendation

Attributions