WP-UserOnline 2.40 Readme

» Index

Plugin Information

Author:
» Lester 'GaMerZ' Chan

Features:
» Enable you to display how many users are online on your Wordpress blog with detailed statistics of where they are and who there are(Members/Guests/Search Bots).

Download:
» WP-UserOnline 2.40 For 2.7.x
» WP-UserOnline 2.31 For WordPress 2.5.x And 2.6.x
» WP-UserOnline 2.20 For WordPress 2.3.x
» WP-UserOnline 2.11 For WordPress 2.1.x And 2.2.x
» WP-UserOnline 2.06 For WordPress 2.0.x
» WP-UserOnline 1.00 For WordPress 1.5.2

Screenshots:
» http://lesterchan.net/wordpress/screenshots/browse/wp-useronline/

Demo:
» http://lesterchan.net/wordpress/useronline/

Development:
» http://dev.wp-plugins.org/browser/wp-useronline/

Translations:
» http://dev.wp-plugins.org/browser/wp-useronline/i18n/

Support Forums:
» http://forums.lesterchan.net/index.php?board=21.0

Credits:
» __ngetext() by Anna Ozeritskaya.
» Right To Left Language Support by Kambiz R. Khojasteh.

Note:
» The Changelog, Installation, Upgrade, Usage Tab at the top of the page.

Donations:
» I spent most of my free time creating, updating, maintaining and supporting these plugins, if you really love my plugins and could spare me a couple of bucks as my school allowance, I will really appericiate it. If not feel free to use it without any obligations. Thank You. My Paypal account is

» Changelog

Version 2.40 (12-12-2008)
- NEW: Works For WordPress 2.7 Only
- NEW: Uses plugins_url() And site_url()
- NEW: Cache IPs of ip2nation by Kambiz R. Khojasteh
- NEW: Country Flags Images Are Now Included As Part Of The Plugin
- NEW: Right To Left Language Support by Kambiz R. Khojasteh
- NEW: Better Translation Using __ngetext() by Anna Ozeritskaya
- NEW: Output Of useronline_page() Applied To "useronline_page" Filter by Kambiz R. Khojasteh
- NEW: Called useronline_textdomain() In create_useronline_table() by Kambiz R. Khojasteh
- FIXED: SSL Support
Version 2.31 (16-07-2008)
- NEW: Works For WordPress 2.6
- FIXED: MYSQL Charset Issue Should Be Solved
- FIXED: Do Not Show WP-Stats Link If There Is No WP-Stats
Version 2.30 (01-06-2008)
- NEW: Works For WordPress 2.5 Only
- NEW: Uses Shortcode API
- NEW: Uses /wp-useronline/ Folder Instead Of /useronline/
- NEW: Uses wp-useronline.php Instead Of useronline.php
- NEW: Uses wp-useronline-widget.php Instead Of useronline-widget.php
- NEW: Renamed useronline-js.php To useronline-js.js and Move The Dynamic Javascript Variables To The PHP Pages
- NEW: Uses useronline-js-packed.js
- NEW: Added Users Online To Dashboard "Right Now"
- NEW: Use number_format_i18n() Instead
- FIXED: Should Use display_name Instead Of user_name If WP-Stats Is Not Installed
- FIXED: XSS Vulnerability
Version 2.20 (01-10-2007)
- NEW: Works For WordPress 2.3 Only
- NEW:Templates Options Added
- NEW: Ability To Uninstall WP-UserOnline
- NEW: Uses WP-Stats Filter To Add Stats Into WP-Stats Page
Version 2.11 (01-06-2007)
- NEW: Referral Link Is Now Shown On The UserOnline Page
- FIXED: Uses WordPress's Default Date And Time Format
- FIXED: Able To Leave Blank For 'UserOnline URL' Option To Disable Link To UserOnline Page
Version 2.10 (01-02-2007)
- NEW: Works For WordPress 2.1 Only
- NEW: Renamed useronline-js.js to useronline-js.php To Enable PHP Parsing
Version 2.06 (02-01-2007)
- NEW: useronline.php Now Handles The AJAX Processing Instead Of index.php
- NEW: Localize WP-UserOnline
- FIXED: JavaScript onLoad Function Conflict By zeug
- FIXED: AJAX Not Working On Servers Running On PHP CGI
- FIXED: IP2Nation Will Now Work Whether Or Not WP-Stats Is Activated
Version 2.05 (01-10-2006)
- NEW: UserOnline Is Now Embedded Into A Page, And Hence No More Integrating Of UserOnline Page (Removed wp-useronline.php)
- NEW: Changed In WP-UserOnline Structure: Members Mean Registered Users and Guests Mean Comment Authors
- NEW: get_users_browsing_site(false) And get_users_browsing_page(false) Will Now Return An Array Containing Total Users, Total Members, Total Guests and Total Bots Online
- NEW: Added Widget Title Option To WP-UserOnline Widget
- FIXED: Invalid IP Error
- FIXED: If Site URL Doesn't Match WP Option's Site URL, WP-UserOnline Will Not Work
Version 2.04 (01-07-2006)
- NEW: AJAX Is Now Used For Updating Users Online Every 1 Minute Without Refreshing The Page
- NEW: You Can Now Place Users Online Count And Users Browsing Site Data On The Sidebar As A Widget
- NEW: UserOnline Options Panel And The Code That WP-UserOnline Generated Is XHTML 1.0 Transitional
- NEW: Added Useronline Options In WP Administration Panel Under 'Options -> Useronline'
- NEW: If You Have ip2nation Plugin Installed, The User's/Guest's Country Flag Will Be Displayed
Version 2.03 (01-04-2006)
- NEW: Added get_users_browsing_site(); To Display Users Browsing The Site
- FIXED: wp-stats.php Link
- FIXED: Some Grammer Errors, Credit To xclouds (http://www.xclouds.com/)
Version 2.02 (01-03-2006)
- NEW: No More Install/Upgrade File, It Will Install/Upgrade When You Activate The Plugin.
- FIXED: IP 'Unknown' Error, Credit To Brian Layman (http://www.knitchat.com/)
- FIXED: ON DUPLICATE KEY Error, Credit To Brian Layman (http://www.knitchat.com/)
- FIXED: DUPLICATE KEY Error By Using DELETE First, Credit To Jody Cairns (http://steelwhitetable.org/blog/)
Version 2.01 (01-02-2006)
- NEW: Added Users Browsing Page
- NEW: Added Most Users Ever Online
- FIXED: Added UNIQUE Key Instead Of Primary Key To Test Whether It Will Solve Duplicate Entry Errors
- FIXED: Quotes Issue In Page Title
Version 2.00 (01-01-2006)
- NEW: Compatible With Only WordPress 2.0
- NEW: Better Installer
- NEW: GPL License Added
- NEW: Page Title Added To wp-useronline.php
- NEW: Added Extra Bots, Credit To Greg Perry (http://www.gregrperry.com/)
- FIXED: Cleaner Codes

» Usage Instructions

General Usage (Without Widget)

Open wp-content/themes/<YOUR THEME NAME>/sidebar.php
Add Anywhere:
<?php if (function_exists('useronline')): ?>
   <li>
      <h2>UserOnline</h2>
      <ul>
         <li><div id="useronline-count"><?php get_useronline(); ?></div></li>
      </ul>
   </li>
<?php endif; ?>

General Usage (With Widget)

Activate WP-UserOnline Widget Plugin
Go to 'WP-Admin -> Appearance -> Widgets'
You can add the UserOnline Widget by clicking on the 'Add' link besides it.
After adding, you can configure the UserOnline Widget by clicking on the 'Edit' link besides it.
Click 'Save Changes'
Scroll down for instructions on how to create a UserOnline Page.

UserOnline Page

Go to 'WP-Admin -> Pages -> Add New'
Type any title you like in the post's title area
If you ARE using nice permalinks, after typing the title, WordPress will generate the permalink to the page. You will see an 'Edit' link just beside the permalink.
Click 'Edit' and type in 'useronline' in the text field (without the quotes) and click 'Save'.
Type '[page_useronline]' in the post's content area (without the quotes)
Click 'Publish'
If you ARE NOT using nice permalinks, you need to go to 'WP-Admin -> Settings -> Useronline' and under 'UserOnline URL', you need to fill in the URL to the UserOnline Page you created above.

UserOnline Stats (Outside WP Loop)

To Display Most Number Of Users Online
Use:
<?php if (function_exists('get_most_useronline')): ?>
<p>Most Users Ever Online Is <?php echo get_most_useronline(); ?> On <?php echo get_most_useronline_date(); ?></p>
<?php endif; ?>
To Display Users Browsing Site
Use:
<?php if (function_exists('get_users_browsing_site')): ?>
<div id="useronline-browsing-site"><?php echo get_users_browsing_site(); ?></div>
<?php endif; ?>
To Display Users Browsing A Page
Use:
<?php if (function_exists('get_users_browsing_page')): ?>
<div id="useronline-browsing-page"><?php echo get_users_browsing_page(); ?></div>
<?php endif; ?>