by
Janeth Kent
Date: 27-06-2013
This script will create a configurable widget that will display the latest Disqus comments from your site.
Note: You need to signup with Disqus and register a new application in order to use this script.
Using the Script
This script should work on any server running PHP v5+.I haven't tested it on PHPv4, but I wouldn't be surprised if it worked on that as well. I think the script works best if it functions as it's own php page and has it's contents embedded via a php include, iframe, or ajax call. If you look at the echoComments you'll notice that all of the elements in the commentHtml string have a css class. This should make it easy for you to customize the look and feel of your recent comments.
<?php
//stops uneeded warnings from displaying
error_reporting(E_ALL ^ E_NOTICE);
try {
//Parameters - Feel free to modify these
$publicKey="[YOUR_PUBLIC_KEY]";
$forumName="[YOUR_FORUM_NAME]";
$commentLimit=15;
$filterUsers="";
// zero default = 3x comment limit
$filterLimit=0;
$useRelativeTime=false;
$dateFormat='F j, Y \a\t g:iA';
$commentLength=95;
$apiVersion="3.0";
$resource="posts/list";
$outputType="json";
// put style parameters in an array
$styleParameter=array(
"commentLimit"=>$commentLimit,
"useRelativeTime"=>$useRelativeTime,
"dateFormat"=>$dateFormat,
"commentLength"=>$commentLength,
"filterUsers"=>$filterUsers
);
//put request parameters in an array
$dqParameter=array(
"api_key"=>$publicKey,
"forum"=>$forumName,
"include"=>"approved",
"limit"=> $commentLimit
);
//change limit used if users are being filter out.
if(strlen(trim($filterUsers)))
{
if($filterLimit!=0)
{
$dqParameter["limit"]=$filterLimit;
}
else
{
$dqParameter["limit"]=3*$commentLimit;
}
}
//Create base request string
$dqRequest="http://disqus.com/api/".$apiVersion."/".$resource.".".$outputType;
//add parameters to request string
$dqRequest= addQueryStr($dqRequest,$dqParameter);
// get response with finished request url
$dqResponse= file_get_contents_curl($dqRequest);
//check repsonse
if($dqResponse!=false)
{
// convert response to php object
$dqResponse=@json_decode($dqResponse,true);
// get comment items from response
$dqComment=$dqResponse["response"];
//check comment count
if(count($dqComment)>0)
{
echoComments(
$dqComment,
$publicKey,
$styleParameter
);
}
else
{
noComments();
}
}
else
{
noComments();
}
}
catch(Exception $e)
{
noComments();
//echo($e);
}
function echoComments($comment,$publicKey,$styleParameter)
{
//basic counter
$commentCounter=0;
//filtered user array
$filteredUsers=explode(",",$styleParameter["filterUsers"]);
//create html string
$recentComments='<div id="dqRecentComments">';
foreach($commentas$commentObj)
{
// first skip to next if user is filtered
$authorName=$commentObj["author"]["name"];
if($filteredUsers!=null)
{
if(in_array($authorName,$filteredUsers))
{
//we don't like this user. skip to next
continue;
}
}
//everything is fine, let's keep going
$commentCounter++;
//alternate class
if($commentCounter%2!==0)
{
$wrapClass="dqCommentWrap";
}
else
{
$wrapClass="dqCommentWrap alter";
}
//get rest of comment data
$authorProfile=$commentObj["author"]["profileUrl"];
$authorAvatar=$commentObj["author"]["avatar"]["large"]["cache"];
$message=$commentObj["raw_message"];
if($styleParameter["useRelativeTime"]==true)
{
$postTime= relative_time(strtotime($commentObj["createdAt"].'+0000'));
}
else
{
$postTime=date(
$styleParameter["dateFormat"],
strtotime($commentObj["createdAt"].'+0000')
);
}
$threadInfo= getThreadInfo(
$commentObj["thread"],
$publicKey
);
$threadTitle=$threadInfo["title"];
$threadLink=$threadInfo["link"];
// shorten comment
$message= shortenComment(
$message,
$styleParameter["commentLength"]
);
//create comment html
$commentHtml='<div class="'.$wrapClass.'">
<div class="dqCommentHead">
<div class="dqAvatarWrap">
<img class="dqCommentAvatar" src="'.$authorAvatar.'" alt="'.$authorName.'"/>
</div>
<div class="dqCommentMeta">
<span class="dqCommentAuthor">
<a class="dqProfileLink" href="'.$authorProfile.'">'.$authorName.'</a>
</span>
<span class="dqCommentTime">'.$postTime.'</span>
</div>
<div class="dqClear"></div>
</div>
<div class="dqCommentBody">
<a class="dqCommentThread" href="'.$threadLink.'">'.$threadTitle.'</a>
<div class="dqCommentText">'.$message.'</div>
</div>
</div>';
$recentComments.=$commentHtml;
//stop loop when we reach limit
if($commentCounter==$styleParameter["commentLimit"])
{
break;
}
}
$recentComments.='</div>';
echo($recentComments);
}
function noComments()
{
echo(
'<div id="dqRecentComments">
<span id="dqNoComments">No Recent Comments Found</span>
</div>'
);
}
function shortenComment($comment,$commentLength)
{
if($commentLength!=0)
{
if(strlen($comment)>$commentLength)
{
$comment=preg_replace(
'/\s+?(\S+)?$/','',
substr($comment,0,$commentLength+1)
)."...";
}
}
return$comment;
}
function getThreadInfo(
$threadId,
$publicKey,
$apiVersion="3.0",
$resource="threads/details",
$outputType="json"
)
{
$dqRequest="http://disqus.com/api/".$apiVersion."/".$resource.".".$outputType;
$dqParameter=array(
"api_key"=>$publicKey,
"thread"=>$threadId
);
$dqRequest= addQueryStr($dqRequest,$dqParameter);
// convert response to php object
$dqResponse= file_get_contents_curl($dqRequest);
if($dqResponse!==false)
{
$dqResponse=@json_decode($dqResponse,true);
$dqThread=$dqResponse["response"];
return$dqThread;
}
else
{
$dqThread=array(
title=>"Article not found",
link=>"#"
);
return$dqThread;
}
}
function addQueryStr($baseUrl,$parameters)
{
$i=0;
if(count($parameters)>0)
{
$newUrl=$baseUrl;
foreach($parametersas$key=>$value)
{
if($i==0)
{
$newUrl.="?".$key."=".$value;
}
else
{
$newUrl.="&".$key."=".$value;
}
$i+=1;
}
return$newUrl;
}
else
{
return$baseUrl;
}
}
function file_get_contents_curl($url)
{
//Source: http://www.codeproject.com/Questions/171271/file_get_contents-url-failed-to-open-stream
$ch=curl_init();
curl_setopt($ch, CURLOPT_HEADER,0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);//Set curl to return the data instead of printing it to the browser.
curl_setopt($ch, CURLOPT_URL,$url);
curl_setopt($ch, CURLOPT_FORBID_REUSE,1); // don't use cached ver. of url
curl_setopt($ch, CURLOPT_FRESH_CONNECT,1);// seriously...don't use cached ver. of url
$data=curl_exec($ch);
curl_close($ch);
return$data;
}
function relative_time($date)
{
//Source: http://stackoverflow.com/questions/2690504/php-producing-relative-date-time-from-timestamps
$now=time();
$diff=$now-$date;
if($diff<60){
returnsprintf($diff>1 ? '%s seconds ago':'a second ago',$diff);
}
$diff=floor($diff/60);
if($diff<60){
returnsprintf($diff>1 ? '%s minutes ago':'one minute ago',$diff);
}
$diff=floor($diff/60);
if($diff<24){
returnsprintf($diff>1 ? '%s hours ago':'an hour ago',$diff);
}
$diff=floor($diff/24);
if($diff<7){
returnsprintf($diff>1 ? '%s days ago':'yesterday',$diff);
}
if($diff<30)
{
$diff=floor($diff/7);
returnsprintf($diff>1 ? '%s weeks ago':'one week ago',$diff);
}
$diff=floor($diff/30);
if($diff<12){
returnsprintf($diff>1 ? '%s months ago':'last month',$diff);
}
$diff=date('Y',$now)-date('Y',$date);
return sprintf($diff>1 ? '%s years ago':'last year',$diff);
}
?>
Adding Your Parameters
- publicKey - Your public Disqus api key.
- forumName - Forum name Disqus identifies your site by.
- commentLimit - Max amount of recent comments you want to fetch.
- filterUsers - A comma delimited list of author names whose comments you do not want to show in the recent comment list.
- No spaces before or after the commas. $filterUsers = "One Name,Two Name" not $filterUsers = "One Name, SpaceBefore Name"
- Author names are different from usernames in Disqus. The author name is what shows up when someone makes a comment.
- filterLimit - If filterUsers is used this is the numer of comments we ask the Disqus API to send back. By default the number zero is 3 times your comment limit
- Why 3 times the comment limit? Imagine you want to display 5 recent comments, but you don't want comments to show up from user "Joe Smoe". If "Joe Smoe" posted the last 5 comments you wouldn't see anything unless you asked the Disqus API to send more comments then you actually wanted to display.
- dateFormat - Format you want to use for comment post dates. Check php manual for formatting options.
- commentLength - Max character count of comments
- apiVersion - Version of Disqus api
- resource - Disqus resource to grad data from. Probably want to leave this alone.
- outputType - Format of response from Disqus. You'll have to change script if you want to use xml.
In the older script a few people noted that they were getting warning messages from php. I have added error_reporting(E_ALL ^ E_NOTICE); to the top of the script to suppress the warnings.
To find your "forum" name do this:
- Login to Disqus
- Click "Admin"
- Click the "Settings" tab to the right
- Scroll down under Site Identity and find the Shortname attribute. This is what you should use in the script to replace [YOUR _FORUM_NAME]
by
Janeth Kent Date:
27-06-2013
hits :
4326
Janeth Kent
Licenciada en Bellas Artes y programadora por pasión. Cuando tengo un rato retoco fotos, edito vídeos y diseño cosas. El resto del tiempo escribo en MA-NO WEB DESIGN AND DEVELOPMENT.