Add documentation for wp_version_check(). Fixes #5233 props darkdragon.

git-svn-id: http://svn.automattic.com/wordpress/trunk@6297 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
westi 2007-10-30 21:40:30 +00:00
parent e236161cf9
commit bccb7897d7
1 changed files with 18 additions and 2 deletions

View File

@ -1,7 +1,23 @@
<?php
/**
* A simple set of functions to check our version 1.0 update service
*
* @package WordPress
* @since 2.3
*/
// A simple set of functions to check our version 1.0 update service
/**
* wp_version_check() - Check WordPress version against the newest version.
*
* The WordPress version, PHP version, and Locale is sent. Checks against the WordPress server at
* api.wordpress.org server. Will only check if PHP has fsockopen enabled and WordPress isn't installing.
*
* @package WordPress
* @since 2.3
* @uses $wp_version Used to check against the newest WordPress version.
*
* @return mixed Returns null if update is unsupported. Returns false if check is too soon.
*/
function wp_version_check() {
if ( !function_exists('fsockopen') || strpos($_SERVER['PHP_SELF'], 'install.php') !== false || defined('WP_INSTALLING') )
return;