JavaScript configuration variables

Configuration variables are used as parameters for Disqus' behaviors and settings. They are defined within the HTML of the page on which Disqus is loaded.

These variables must be defined on each page on which Disqus is loaded, so include them in your dynamic templates which render pages.

Placing configuration variables

Configuration variables are added anywhere on the page before the embed.js script, and are wrapped in script tags. For example:

<script type="text/javascript">
    /* * * CONFIGURATION VARIABLES: THIS CODE IS ONLY AN EXAMPLE * * */
    var disqus_shortname = 'example'; // Required - Replace example with your forum shortname
    var disqus_identifier = 'a unique identifier for each page where Disqus is present';
    var disqus_title = 'a unique title for each page where Disqus is present';
    var disqus_url = 'a unique URL for each page where Disqus is present';

    /* * * DON'T EDIT BELOW THIS LINE * * */
    (function() {
        var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
        dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
    })();
</script>

If you're using one of our plugins such as Wordpress, it's best to put this in your "header.php" template (or equivalent) rather than editing the plugin files.

disqus_shortname

Tells the Disqus service your forum's shortname, which is the unique identifier for your website as registered on Disqus. If undefined, the Disqus embed will not load.

Usage: Specify your forum shortname as string.

Example: var disqus_shortname = 'example';

disqus_identifier

Tells the Disqus service how to identify the current page. When the Disqus embed is loaded, the identifier is used to look up the correct thread. If disqus_identifier is undefined, the page's URL will be used. The URL can be unreliable, such as when renaming an article slug or changing domains, so we recommend using your own unique way of identifying a thread.

Be careful not to assign multiple identifiers to the same thread URL, as it will result in Identifier Conflict.

Plugins, such as Disqus for WordPress, will automatically have this defined as the id of the blog post.

Usage: Specify a string or an integer as your unique identifier. This can be dynamically rendered server-side.

Benefits:

  • You'll be able to reference the same thread regardless of the URL where it is loaded.

 

Example:

The following uses an article slug as the identifier. var disqus_identifier = '/december-2010/the-best-day-of-my-life/';

The following uses a unique id as an identifier. var disqus_identifier = '2583573';

Most likely you will be rendering the values dynamically server-side in your platform or CMS. The following is an example using PHP.

var disqus_identifier = '<? php echo $my_identifier; ?>';

disqus_title

Tells the Disqus service the title of the current page. This is used when creating the thread on Disqus for the first time. If undefined, Disqus will use the <title> attribute of the page. If that attribute could not be used, Disqus will use the URL of the page.

Benefits:

  • You can set a friendlier title to be shown in Discovery.
  • Your thread's title is set instantly rather than waiting on the Disqus system queue.

 

Having comment threads titled http://example.com/helloworld.html isn't very pretty!

disqus_url

Tells the Disqus service the URL of the current page. If undefined, Disqus will take the window.location.href. This URL is used to look up or create a thread if disqus_identifier is undefined. In addition, this URL is always saved when a thread is being created so that Disqus knows what page a thread belongs to.

While the window.location.href is used in absence of disqus_url, we highly recommend defining this variable. If a user visits your page at the URL http://example.com/helloworld.html?123, Disqus may in fact load a different thread than if the user came from http://example.com/helloworld.html.

To make sure the right thread is always displayed, you should define on your page, using an absolute URL, var disqus_url = 'http://example.com/helloworld.html';

disqus_category_id

Tells the Disqus service the category to be used for the current page. This is used when creating the thread on Disqus for the first time.

Categories are primarily used with our API for results filtering; categories are not used for moderation (e.g., to filter comments by category in the moderation panel). New categories can be created at the Settings > Advanced page or with our categories API endpoints. If you try using a category ID that hasn't been created within your forum settings, you'll receive a 400 Bad Request error.

JavaScript Usage: Specify a category ID (not title). If undefined, Disqus will use the forum's default General category.

Example: var disqus_category_id = '123456'; // using category Sports which has ID 123456

API Usage: Filter results by category.

Example: Utilize the categories/listPosts endpoint (or the category parameter in conjunction with the posts/list endpoint) to list comments only from a certain category.

disqus_disable_mobile

Tells the Disqus service to never use the mobile optimized version of Disqus.

Usage: Specify using `true`.

Example: var disqus_disable_mobile = true;

Contact us

We welcome all questions, feedback and bug reports. If you're having an issue, we usually need the following information:

  • A brief description of the issue
  • Link to any page where you saw the issue
  • Screenshots that illustrate the problem - How do I take a screenshot?