Changeset 590367

Timestamp:

08/25/2012 09:50:27 PM (14 years ago)

Author:

MartyThornley

Message:

Cleaner code and added cache for tweets

Location:

wp-list-tweets/trunk

Files:

• readme.txt (modified) (3 diffs)
• wp_list_tweets.php (modified) (2 diffs)

wp-list-tweets/trunk/readme.txt

@@ -3 +3 @@
 Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=11225299
 Tags: twitter
-Tested up to: 2.9.1
+Tested up to: 3.4.2
 Stable tag: trunk
 
@@ -86 +86 @@
 Yes. It was programmed with this in mind. Each instance adds a class of the username to the containing ul element.
 
-Add the follwing to your CSS to style each user:
+Add the following to your CSS to style each user:
 
     ul.username { }
@@ -94 +94 @@
 == Changelog ==
 
+= 1.3 =
+* Tested up to 3.4.2
+* Cleaned up code
+* CACHING! Added caching for tweets. Tweets will now only be grabbed once per 30 minutes.
+
 = 1.2 =
 * Added a quick check to make sure the plugin was actually being used on each page. Before, it was trying to talk to twitter with empty user info ion every page and it really slowed down page loads. Much faster now. :)

wp-list-tweets/trunk/wp_list_tweets.php

@@ -4 +4 @@
 Plugin URI: http://martythornley.com/downloads/wp-list-tweets
 Description: Easily List any number of latest Tweets from any user.
-Version: 1.2
+Version: 1.3
 Author: Marty Thornley
 Author URI: http://martythornley.com
@@ -87 +87 @@
 /       this plugin has been used on a given page.
 /
-*********************************************************************/?>
-<?php
-
-// Empty the constant on each page load to store this page's info:
-
-function empty_twitter_info() {
-    $GLOBALS['twitter_info_store'] = '';
-    $GLOBALS['twitter_list_count'] = 1;
-
-};
-
-add_action ('wp_head','empty_twitter_info');
-add_action ('admin_head','empty_twitter_info');
-
-function wp_list_tweets($user='', $number='3', $element = '') { 
-    ob_start(); 
-
-// get needed global info
-    
-    global $post;
-    
-    $defaultUser = get_option('wp_list_tweets_user');
-    
-    if ($user != '') :
-        $tweet_user = $user;
-    elseif ($defaultUser != '') :
-        $tweet_user = $defaultUser;
-    else : 
-        $tweet_user = 'martythornley';
-    endif;
-
-    $tweet_number = $number;
-    
-    if ($element == '') :
-        $tweet_element = 'twitterList-' . $tweet_user . '-' . $GLOBALS['twitter_list_count'];
-    else : 
-        $tweet_element = 'twitterList-' . $tweet_user . '-' . $element;
-    endif; 
-    
-    echo '<ul id="' . $tweet_element. '" class="twitterList ' . $user . '"></ul>';
-    
-    $wp_twitter_info['tweet_user'] = $tweet_user;
-    $wp_twitter_info['tweet_number'] = $tweet_number;
-    $wp_twitter_info['tweet_element'] = $tweet_element;
-    
-    $old = $GLOBALS['twitter_info_store'];
-    
-    if ( $old == '' ) :
-        $new = serialize($wp_twitter_info);
-    else : 
-        $new = $old . ',' . serialize($wp_twitter_info);
-    endif; 
-    
-    $GLOBALS['twitter_info_store'] = $new;  
-
-    $GLOBALS['twitter_list_count'] ++;
-    
-    $output_string=ob_get_contents();;
-    ob_end_clean();
-
-    echo $output_string;
-    
-};
-
-function add_twitter_js_to_footer () {
-
-    $wp_twitter_infos = $GLOBALS['twitter_info_store'];
-    
-    $wp_twitter_infos = explode( ',' ,  $wp_twitter_infos );
-    
-    foreach ($wp_twitter_infos as $wp_twitter_info) {
-        $instances[] = unserialize ($wp_twitter_info);
+*********************************************************************/
+
+    add_action ( 'wp_head',         'empty_twitter_info' );
+    add_action ( 'admin_head',      'empty_twitter_info' );
+    add_action ( 'admin_menu' ,     'wp_list_tweets_admin_menu');
+    
+    add_action ( 'wp_footer' ,      'add_twitter_js_to_footer' );
+    add_action ( 'admin_footer' ,   'add_twitter_js_to_footer' );
+    add_filter ( 'wp_head',         'default_wp_list_tweets_style' );
+    add_filter ( 'admin_head',      'default_wp_list_tweets_style' );
+
+    add_shortcode('wp_list_tweets', 'wp_list_tweets_shortcode');
+        
+    /*
+     * Empty the constant on each page load to store this page's info
+     */     
+    function empty_twitter_info() {
+        $GLOBALS['twitter_info_store'] = '';
+        $GLOBALS['twitter_list_count'] = 1;
+    };
+    
+    /*
+     * Function that creates ul holder for tweets
+     */ 
+    function wp_list_tweets($user='', $number='3', $element = '') { 
+        ob_start(); 
+    
+        // get needed global info
+        global $post;
+        
+        $defaultUser = get_option('wp_list_tweets_user');
+        
+        if ($user != '') :
+            $tweet_user = $user;
+        elseif ($defaultUser != '') :
+            $tweet_user = $defaultUser;
+        else : 
+            $tweet_user = 'martythornley';
+        endif;
+    
+        $tweet_number = $number;
+        
+        if ($element == '') :
+            $tweet_element = 'twitterList-' . $tweet_user . '-' . $GLOBALS['twitter_list_count'];
+        else : 
+            $tweet_element = 'twitterList-' . $tweet_user . '-' . $element;
+        endif; 
+        
+        echo '<ul id="' . $tweet_element. '" class="twitterList ' . $user . '"></ul>';
+        
+        $wp_twitter_info['tweet_user'] = $tweet_user;
+        $wp_twitter_info['tweet_number'] = $tweet_number;
+        $wp_twitter_info['tweet_element'] = $tweet_element;
+        
+        $old = $GLOBALS['twitter_info_store'];
+        
+        if ( $old == '' ) :
+            $new = serialize($wp_twitter_info);
+        else : 
+            $new = $old . ',' . serialize($wp_twitter_info);
+        endif; 
+        
+        $GLOBALS['twitter_info_store'] = $new;  
+    
+        $GLOBALS['twitter_list_count'] ++;
+        
+        $output_string=ob_get_contents();;
+        ob_end_clean();
+    
+        echo $output_string;
+        
+    };
+    
+    /*
+     * Adds Javascript to footer on front end
+     */     
+    function add_twitter_js_to_footer () {
+    
+        $wp_twitter_infos = $GLOBALS['twitter_info_store'];
+        
+        $wp_twitter_infos = explode( ',' ,  $wp_twitter_infos );
+        
+        foreach ($wp_twitter_infos as $wp_twitter_info) {
+            $instances[] = unserialize ($wp_twitter_info);
+        }
+        
+        foreach ( $instances as $instance ) {
+        
+            $tweet_user = $instance['tweet_user'];
+            $tweet_number  = $instance['tweet_number'];
+            $tweet_element  = $instance['tweet_element'];
+    
+            if ($instance['tweet_user'] !='') {
+            ?>
+        
+                <script type="text/javascript">
+                /* <![CDATA[ */
+                
+                    function twitterCallback<?php echo $tweet_user; ?>(C) {
+                        var A=[];
+                        for(var D=0;D<C.length;D++) {
+                        var E=C[D].user.screen_name;
+                        var B=C[D].text.replace(/((https?|s?ftp|ssh)\:\/\/[^"\s\<\>]*[^.,;'">\:\s\<\>\)\]\!])/g,
+                
+                        function(F) { return'<a href="'+F+'">'+F+"</a>"}).replace(/\B@([_a-z0-9]+)/ig, function(F) { return F.charAt(0)+'<a href="http://www.twitter.com/'+F.substring(1)+'">'+F.substring(1)+"</a>" } );
+                
+                        A.push("<li><span>"+B+'</span> <a style="font-size:85%" href="http://twitter.com/'+E+"/statuses/"+C[D].id+'">'+relative_time(C[D].created_at)+"</a></li>")}document.getElementById("<?php echo $tweet_element; ?>").innerHTML=A.join("")}
+                                                
+                        function relative_time(C) {
+                        var B=C.split(" ");C=B[1]+" "+B[2]+", "+B[5]+" "+B[3];
+                        var A=Date.parse(C);
+                        var D=(arguments.length>1)?arguments[1]:new Date();
+                        var E=parseInt((D.getTime()-A)/1000);
+                        E=E+(D.getTimezoneOffset()*60);
+                
+                        if (E<60) { return"less than a minute ago" }
+                
+                        else {
+                            if (E<120) { return"about a minute ago" }
+                
+                        else {
+                            if(E<(60*60)) { return(parseInt(E/60)).toString()+" minutes ago" }
+                 
+                        else {
+                            if(E<(120*60)) {return"about an hour ago" }
+                
+                        else {
+                            if (E<(24*60*60)){return"about "+(parseInt(E/3600)).toString()+" hours ago" }
+                    
+                        else {
+                            if (E<(48*60*60)){return"1 day ago"}else{return(parseInt(E/86400)).toString()+" days ago"}}}}}
+                        }
+                    };
+                    
+                    function setCookie(name, value, expires) {
+                        document.cookie = name + "=" + escape(value) + "; path=/" + ((expires == null) ? "" : "; expires=" + expires.toGMTString());
+                    }
+                     
+                    function getCookie(name) {
+                        if (document.cookie.length > 0) {
+                          var start = document.cookie.indexOf(name + "=");
+                          if (start != -1) { 
+                            start = start + name.length + 1; 
+                            var end = document.cookie.indexOf(";", start);
+                            if (end == -1) {
+                              end = document.cookie.length;
+                            }
+                            return unescape(document.cookie.substring(start, end));
+                          } 
+                        }
+                        return "";
+                    }
+                     
+                    function twitterCachedCallback<?php echo $tweet_user; ?>(c) {
+                        
+                        var cachedContent = getCookie('twitter_content_<?php echo $tweet_user; ?>_<?php echo $tweet_number; ?>');
+                        // set content immediately if cached
+                        if (cachedContent) {
+                            document.getElementById("<?php echo $tweet_element; ?>").innerHTML = cachedContent;
+                        } else {
+                            twitterCallback<?php echo $tweet_user; ?>(c);
+                            var content = document.getElementById("<?php echo $tweet_element; ?>").innerHTML;
+                            // expire cookie after 30 minutes
+                            var exp = new Date();
+                            exp.setTime(exp.getTime() + (1000 * 60 * 30));
+                            setCookie('twitter_content_<?php echo $tweet_user; ?>_<?php echo $tweet_number; ?>', content, exp);
+                        }
+                    }
+                                
+                /* ]]> */
+                </script>
+    
+            <?php
+            
+                $js = '<script type="text/javascript" src="http://twitter.com/statuses/user_timeline/'; 
+                $js .= $tweet_user;
+                $js .= '.json?callback=twitterCachedCallback' . $tweet_user .'&amp;count=' . $tweet_number . '"></script>';
+            
+                echo $js;
+            }
+        }
+    };
+    
+    
+    
+    /*
+     * Adds Shortcode
+     */ 
+    function wp_list_tweets_shortcode($atts) {
+            
+        extract(shortcode_atts(array(
+            'user' => get_option('wp_list_tweets_user'),
+            'num' => '1',
+            'element' => $GLOBALS['twitter_list_count'],
+        ), $atts));
+        
+        ob_start(); 
+    
+        wp_list_tweets($user, $num, $element);
+        $output_string=ob_get_contents();;
+        ob_end_clean();
+    
+        return $output_string;
+    };
+    
+    /*
+     * Adds default styling
+     */ 
+    function default_wp_list_tweets_style (){
+        echo '
+    <style type="text/css">
+        ul.twitterList { 
+            background:#E5E5E5 none repeat scroll 0 0;
+            border:1px solid #C5C5C5;
+            float:left;
+            height:auto;
+            margin:10px 20px 10px 0;
+            padding:0;
+            overflow:hidden;
+            width:300px;
+            text-align:left;
+            width:200px; 
+        }
+    
+        ul.twitterList li {
+            padding: 6px 10px;
+            text-indent:0;
+            margin:0;
+        }   
+    </style>';
+    };
+
+    /*
+     * Adds menu item and creates settings page
+     */ 
+    function wp_list_tweets_admin_menu() {
+        add_options_page('WP List Tweets', 'WP List Tweets', 'edit_themes', __FILE__, 'wp_list_tweets_admin');
     }
-    
-    foreach ( $instances as $instance ) {
-        $tweet_user = $instance['tweet_user'];
-        $tweet_number  = $instance['tweet_number'];
-        $tweet_element  = $instance['tweet_element'];
-
-    if ($instance['tweet_user'] !='') {
-    
-    
+
+    /*
+     * Adds admin page
+     */ 
+    function wp_list_tweets_admin() {
+
+        if ( strtoupper( $_POST['Action'] ) == 'UPDATE' ) {
+            if ( !wp_verify_nonce( $_POST[ 'wp_list_tweets_admin' ], plugin_basename(__FILE__) ) ) {
+                echo '<div class="updated"><p>There was a problem. Please try again.</p></div>';
+            } else {
+                $tweet_user = esc_html( $_POST['tweet_user'] );
+                update_option('wp_list_tweets_user', $tweet_user );
+            };      
+        }
+        
+        $tweet_user = get_option('wp_list_tweets_user');
     ?>
     
-        <script type="text/javascript">
-        /* <![CDATA[ */
-        function twitterCallback<?php echo $tweet_user; ?>(C) {
-
-        var A=[];
-        for(var D=0;D<C.length;D++) {
-        var E=C[D].user.screen_name;
-        var B=C[D].text.replace(/((https?|s?ftp|ssh)\:\/\/[^"\s\<\>]*[^.,;'">\:\s\<\>\)\]\!])/g,
-
-        function(F) { return'<a href="'+F+'">'+F+"</a>"}).replace(/\B@([_a-z0-9]+)/ig, function(F) { return F.charAt(0)+'<a href="http://www.twitter.com/'+F.substring(1)+'">'+F.substring(1)+"</a>" } );
-
-        A.push("<li><span>"+B+'</span> <a style="font-size:85%" href="http://twitter.com/'+E+"/statuses/"+C[D].id+'">'+relative_time(C[D].created_at)+"</a></li>")}document.getElementById("<?php echo $tweet_element; ?>").innerHTML=A.join("")}
-
-        function relative_time(C) {
-        var B=C.split(" ");C=B[1]+" "+B[2]+", "+B[5]+" "+B[3];
-        var A=Date.parse(C);
-        var D=(arguments.length>1)?arguments[1]:new Date();
-        var E=parseInt((D.getTime()-A)/1000);
-        E=E+(D.getTimezoneOffset()*60);
-
-        if (E<60) { return"less than a minute ago" }
-
-        else {
-            if (E<120) { return"about a minute ago" }
-
-        else {
-            if(E<(60*60)) { return(parseInt(E/60)).toString()+" minutes ago" }
- 
-        else {
-            if(E<(120*60)) {return"about an hour ago" }
-
-        else {
-            if (E<(24*60*60)){return"about "+(parseInt(E/3600)).toString()+" hours ago" }
-    
-        else {
-            if (E<(48*60*60)){return"1 day ago"}else{return(parseInt(E/86400)).toString()+" days ago"}}}}}}};
-        /* ]]> */
-        </script>
-
+    <h2>WP List Tweets</h2>
+    
+    <form method="post" action="">
+    <?php wp_nonce_field( plugin_basename( __FILE__ ), 'wp_list_tweets_admin', false, true ); ?>
+    
+    <table class="form-table">
+      <tr valign="top">
+        <th scope="row"><label for="Username">Default Username:</label></th>
+        <td><input type="text" name="tweet_user" id="tweet_user" value="<?php echo $tweet_user; ?>"/></td>
+      </tr>
+    </table>
+    
+    <p align="center"><input type="submit" name="Action" value="Update" class="button-primary"/></p>
+    
+    </form>
+    
+    <h2>Current Default Tweets Display</h2>
+    <p>This is what you would see using wp_list_tweets(); or shortcode [wp_list_tweets] without any variables.</p>
+    
+    <?php wp_list_tweets(); ?>
+    
     <?php
-        
-        echo '<script type="text/javascript" src="http://twitter.com/statuses/user_timeline/'; 
-        echo $tweet_user;
-        echo '.json?callback=twitterCallback' . $tweet_user .'&amp;count=' . $tweet_number . '"></script>';
-    }
-    }
-};
-
-add_action ('wp_footer' , 'add_twitter_js_to_footer' );
-add_action ('admin_footer' , 'add_twitter_js_to_footer' );
-
-
-// SHORTCODE *************************************************
-
-function wp_list_tweets_shortcode($atts) {
-        
-    extract(shortcode_atts(array(
-        'user' => 'martythornley',
-        'num' => '1',
-        'element' => $GLOBALS['twitter_list_count'],
-    ), $atts));
-    
-    ob_start(); 
-
-    wp_list_tweets($user, $num, $element);
-    $output_string=ob_get_contents();;
-    ob_end_clean();
-
-    return $output_string;
-};
-
-add_shortcode('wp_list_tweets', 'wp_list_tweets_shortcode');
-
-// Default style *********************************************
-
-function default_wp_list_tweets_style (){
-    echo '
-<style type="text/css">
-ul.twitterList { 
-    background:#E5E5E5 none repeat scroll 0 0;
-    border:1px solid #C5C5C5;
-    float:left;
-    height:auto;
-    margin:10px 20px 10px 0;
-    padding:0;
-    overflow:hidden;
-    width:300px;
-    text-align:left;
-    width:200px; 
-}
-
-ul.twitterList li {
-    padding: 6px 10px;
-    text-indent:0;
-    margin:0;
-}   
-</style>';
-
-};
-
-add_filter ('wp_head', 'default_wp_list_tweets_style');
-add_filter ('admin_head', 'default_wp_list_tweets_style');
-
-// ADMIN MENU ****************************************************
-
-add_action('admin_menu' , 'wp_list_tweets_admin_menu');
-
-function wp_list_tweets_admin_menu() {
-    add_options_page('WP List Tweets', 'WP List Tweets', 'edit_themes', __FILE__, 'wp_list_tweets_admin');
-}
-
-function wp_list_tweets_admin() {
-    if (strtoupper($_POST['Action']) == 'UPDATE') {
-    if ( !wp_verify_nonce( $_POST[ 'wp_list_tweets_admin' ], plugin_basename(__FILE__) ) ) : ?>
-        <div class="updated">
-            <p>There was a problem. Please try again.</p>
-        </div>
-    <?php else :
-    
-        $tweet_user = $_POST['tweet_user'];
-        update_option('wp_list_tweets_user', $tweet_user );
-    endif;      
     }
 ?>
-<h2>WP List Tweets</h2>
-
-<form method="post" action="">
-<?php wp_nonce_field( plugin_basename( __FILE__ ), 'wp_list_tweets_admin', false, true ); ?>
-
-<table class="form-table">
-  <tr valign="top">
-    <th scope="row"><label for="Username">Default Username:</label></th>
-    <td><input type="text" name="tweet_user" id="tweet_user" value="<?php echo $tweet_user; ?>"/></td>
-  </tr>
-</table>
-
-<p align="center"><input type="submit" name="Action" value="Update" class="button-primary"/></p>
-
-</form>
-
-<h2>Current Default Tweets Display</h2>
-<p>This is what you would see using wp_list_tweets(); or shortcode [wp_list_tweets] without any variables.</p>
-
-<?php wp_list_tweets(); ?>
-
-<?php
-        
-}
-
-?>