This document refers to an outdated version of Graph API. Please use the latest version.
Graph API Version

Initialization

The method FB.init() is used to initialize and setup the SDK. If you have followed our SDK quickstart guide, you won't need to re-use this method, but you may want to customize the parameters used.

All other SDK methods must be called after this one, because they won't exist until you do.

FB.init(params)

Parameters

NameTypeDescription

params

object

A collection of initialization parameters that control the setup of the SDK. Click for more info.

appId

string

Your application ID. If you don't have one find it in the App dashboard or go there to create a new app. Defaults to null.

version

string

Determines which versions of the Graph API and any API dialogs or plugins are invoked when using the .api() and .ui() functions. Valid values are determined by currently available versions, such as 'v2.0'. This is a required parameter.

cookie

bool

Determines whether a cookie is created for the session or not. If enabled, it can be accessed by server-side code. Defaults to false.

status

bool

Determines whether the current login status of the user is freshly retrieved on every page load. If this is disabled, that status will have to be manually retrieved using .getLoginStatus(). Defaults to false.

xfbml

bool

Determines whether XFBML tags used by social plugins are parsed, and therefore whether the plugins are rendered or not. Defaults to false.

frictionlessRequests

bool

Frictionless Requests are available to games on Facebook.com or on mobile web using the JavaScript SDK. This parameter determines whether they are enabled. Defaults to false.

hideFlashCallback

function

This specifies a function that is called whenever it is necessary to hide Adobe Flash objects on a page. This is used when .api() requests are made, as Flash objects will always have a higher z-index than any other DOM element. See our Custom Flash Hide Callback for more details on what to put in this function. Defaults to null.

Examples

Example: Standard initialization code:

  FB.init({
    appId      : '{your-app-id}',
    status     : true,
    xfbml      : true,
    version    : 'v2.7' // or v2.6, v2.5, v2.4, v2.3
  });