WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

phpdoc tuneup from darkdragon. see #5611 

git-svn-id: http://svn.automattic.com/wordpress/trunk@6585 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
ryan 2008-01-09 17:48:00 +00:00
parent d3e7affa4b
commit 479fc2e2b3
4 changed files with 56 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-includes/l10n.php
View File

@ -53,7 +53,7 @@ function get_locale() {
* the 'gettext' filter hook, along with the untranslated text as * the 'gettext' filter hook, along with the untranslated text as
* the second parameter. * the second parameter.
* *
* If the domain is not set, the the $text is just returned. * If the domain is not set, the $text is just returned.
* *
* @since 2.2.0 * @since 2.2.0
* @uses $l10n Gets list of domain translated string (gettext_reader) objects * @uses $l10n Gets list of domain translated string (gettext_reader) objects

13
wp-includes/plugin.php
View File

@ -73,7 +73,7 @@ function add_filter($tag, $function_to_add, $priority = 10, $accepted_args = 1)
* *
* @package WordPress * @package WordPress
* @subpackage Plugin * @subpackage Plugin
* @since 2.4 * @since 2.5
* @global array $wp_filter Stores all of the filters * @global array $wp_filter Stores all of the filters
* *
* @param string $tag The name of the filter hook. * @param string $tag The name of the filter hook.
@ -212,7 +212,7 @@ function remove_filter($tag, $function_to_remove, $priority = 10, $accepted_args
* *
* @package WordPress * @package WordPress
* @subpackage Plugin * @subpackage Plugin
* @since 2.4 * @since 2.5
* *
* @return string Hook name of the current filter or action. * @return string Hook name of the current filter or action.
*/ */
@ -395,7 +395,7 @@ function do_action_ref_array($tag, $args) {
* *
* @package WordPress * @package WordPress
* @subpackage Plugin * @subpackage Plugin
* @since 2.4 * @since 2.5
* @see has_filter() has_action() is an alias of has_filter(). * @see has_filter() has_action() is an alias of has_filter().
* *
* @param string $tag The name of the action hook. * @param string $tag The name of the action hook.
@ -508,16 +508,15 @@ function register_deactivation_hook($file, $function) {
* _wp_call_all_hook() - Calls the 'all' hook, which will process the functions hooked into it. * _wp_call_all_hook() - Calls the 'all' hook, which will process the functions hooked into it.
* *
* The 'all' hook passes all of the arguments or parameters that were used for the * The 'all' hook passes all of the arguments or parameters that were used for the
* hook, which this function was called for. The first parameter will have to be tested * hook, which this function was called for.
* as it will be the hook name.
* *
* This function is used internally for apply_filters(), do_action(), and do_action_ref_array() * This function is used internally for apply_filters(), do_action(), and do_action_ref_array()
* and is not meant to be used from outside those functions. This function does not check for the * and is not meant to be used from outside those functions. This function does not check for the
* existent of the all hook, so it will fail unless the all hook exists prior to this function call. * existence of the all hook, so it will fail unless the all hook exists prior to this function call.
* *
* @package WordPress * @package WordPress
* @subpackage Plugin * @subpackage Plugin
* @since 2.4 * @since 2.5
* @access private * @access private
* *
* @uses $wp_filter Used to process all of the functions in the 'all' hook * @uses $wp_filter Used to process all of the functions in the 'all' hook

21
wp-includes/rss.php
View File

@ -1,13 +1,22 @@
<?php <?php
do_action('load_feed_engine'); /**
* MagpieRSS: a simple RSS integration tool
*
* A compiled file for RSS syndication
*
* @author Kellan Elliott-McCrea <kellan@protest.net>
* @version 0.51
* @license GPL
*
* @package External
* @subpackage MagpieRSS
*/
/* /*
* Project: MagpieRSS: a simple RSS integration tool * Hook to use another RSS object instead of MagpieRSS
* File: A compiled file for RSS syndication
* Author: Kellan Elliott-McCrea <kellan@protest.net>
* Version: 0.51
* License: GPL
*/ */
do_action('load_feed_engine');
define('RSS', 'RSS'); define('RSS', 'RSS');
define('ATOM', 'Atom'); define('ATOM', 'Atom');

62
wp-settings.php
View File

@ -3,19 +3,17 @@
* Used to setup and fix common variables and include * Used to setup and fix common variables and include
* the WordPress procedural and class library. * the WordPress procedural and class library.
* *
* You should not have to change this file and allows for some configuration * You should not have to change this file and allows
* in wp-config.php. * for some configuration in wp-config.php.
* *
* @package WordPress * @package WordPress
* @since 1.5
*/ */
/** /**
* Turn register globals off * wp_unregister_GLOBALS() - Turn register globals off
* *
* @access private * @access private
* @package WordPress * @since 2.1.0
* @since 2.0
* @return null Will return null if register_globals PHP directive was disabled * @return null Will return null if register_globals PHP directive was disabled
*/ */
function wp_unregister_GLOBALS() { function wp_unregister_GLOBALS() {
@ -38,14 +36,14 @@ function wp_unregister_GLOBALS() {
wp_unregister_GLOBALS(); wp_unregister_GLOBALS();
unset( $wp_filter, $wp_action, $cache_lastcommentmodified, $cache_lastpostdate ); unset( $wp_filter, $cache_lastcommentmodified, $cache_lastpostdate );
/** /**
* The $blog_id global, which you can change in the config allows you to create a simple * The $blog_id global, which you can change in the config allows you to create a simple
* multiple blog installation using just one WordPress and changing $blog_id around. * multiple blog installation using just one WordPress and changing $blog_id around.
* *
* @global int $blog_id * @global int $blog_id
* @since 2.0 * @since 2.0.0
*/ */
if ( ! isset($blog_id) ) if ( ! isset($blog_id) )
$blog_id = 1; $blog_id = 1;
@ -97,13 +95,12 @@ if ( !extension_loaded('mysql') && !file_exists(ABSPATH . 'wp-content/db.php') )
die( 'Your PHP installation appears to be missing the MySQL which is required for WordPress.' ); die( 'Your PHP installation appears to be missing the MySQL which is required for WordPress.' );
/** /**
* PHP 4 standard microtime start capture * timer_start() - PHP 4 standard microtime start capture
* *
* @access private * @access private
* @package WordPress * @since 0.71
* @global int $timestart Seconds and Microseconds added together from when function is called * @global int $timestart Seconds and Microseconds added together from when function is called
* @return bool Always returns true * @return bool Always returns true
* @since 0.71
*/ */
function timer_start() { function timer_start() {
global $timestart; global $timestart;
@ -114,7 +111,7 @@ function timer_start() {
} }
/** /**
* Return and/or display the time from the page start to when function is called. * timer_stop() - Return and/or display the time from the page start to when function is called.
* *
* You can get the results and print them by doing: * You can get the results and print them by doing:
* <code> * <code>
@ -129,7 +126,6 @@ function timer_start() {
* which will do what the above does. If you need the result, you can assign it to a variable, but * which will do what the above does. If you need the result, you can assign it to a variable, but
* most cases, you only need to echo it. * most cases, you only need to echo it.
* *
* @package WordPress
* @since 0.71 * @since 0.71
* @global int $timestart Seconds and Microseconds added together from when timer_start() is called * @global int $timestart Seconds and Microseconds added together from when timer_start() is called
* @global int $timeend Seconds and Microseconds added together from when function is called * @global int $timeend Seconds and Microseconds added together from when function is called
@ -166,7 +162,7 @@ if ( defined('WP_CACHE') )
/** /**
* Stores the location of the WordPress directory of functions, classes, and core content. * Stores the location of the WordPress directory of functions, classes, and core content.
* *
* @since 1.5 * @since 1.0.0
*/ */
define('WPINC', 'wp-includes'); define('WPINC', 'wp-includes');
@ -175,7 +171,7 @@ if ( !defined('LANGDIR') ) {
* Stores the location of the language directory. First looks for language folder in wp-content * Stores the location of the language directory. First looks for language folder in wp-content
* and uses that folder if it exists. Or it uses the "languages" folder in WPINC. * and uses that folder if it exists. Or it uses the "languages" folder in WPINC.
* *
* @since 1.5 * @since 2.1.0
*/ */
if ( file_exists(ABSPATH . 'wp-content/languages') && @is_dir(ABSPATH . 'wp-content/languages') ) if ( file_exists(ABSPATH . 'wp-content/languages') && @is_dir(ABSPATH . 'wp-content/languages') )
define('LANGDIR', 'wp-content/languages'); // no leading slash, no trailing slash define('LANGDIR', 'wp-content/languages'); // no leading slash, no trailing slash
@ -186,6 +182,9 @@ if ( !defined('LANGDIR') ) {
/** /**
* Allows for the plugins directory to be moved from the default location. * Allows for the plugins directory to be moved from the default location.
* *
* This isn't used everywhere. Constant is not used in plugin_basename()
* which might cause conflicts with changing this.
*
* @since 2.1 * @since 2.1
*/ */
if ( !defined('PLUGINDIR') ) if ( !defined('PLUGINDIR') )
@ -270,49 +269,49 @@ if (strpos($_SERVER['PHP_SELF'], 'install.php') === false) {
/** /**
* It is possible to define this in wp-config.php * It is possible to define this in wp-config.php
* @since 2.0 * @since 2.0.0
*/ */
if ( !defined('USER_COOKIE') ) if ( !defined('USER_COOKIE') )
define('USER_COOKIE', 'wordpressuser_' . COOKIEHASH); define('USER_COOKIE', 'wordpressuser_' . COOKIEHASH);
/** /**
* It is possible to define this in wp-config.php * It is possible to define this in wp-config.php
* @since 2.0 * @since 2.0.0
*/ */
if ( !defined('PASS_COOKIE') ) if ( !defined('PASS_COOKIE') )
define('PASS_COOKIE', 'wordpresspass_' . COOKIEHASH); define('PASS_COOKIE', 'wordpresspass_' . COOKIEHASH);
/** /**
* It is possible to define this in wp-config.php * It is possible to define this in wp-config.php
* @since 2.4 * @since 2.5
*/ */
if ( !defined('AUTH_COOKIE') ) if ( !defined('AUTH_COOKIE') )
define('AUTH_COOKIE', 'wordpress_' . COOKIEHASH); define('AUTH_COOKIE', 'wordpress_' . COOKIEHASH);
/** /**
* It is possible to define this in wp-config.php * It is possible to define this in wp-config.php
* @since 2.3 * @since 2.3.0
*/ */
if ( !defined('TEST_COOKIE') ) if ( !defined('TEST_COOKIE') )
define('TEST_COOKIE', 'wordpress_test_cookie'); define('TEST_COOKIE', 'wordpress_test_cookie');
/** /**
* It is possible to define this in wp-config.php * It is possible to define this in wp-config.php
* @since 2.0 * @since 1.2.0
*/ */
if ( !defined('COOKIEPATH') ) if ( !defined('COOKIEPATH') )
define('COOKIEPATH', preg_replace('|https?://[^/]+|i', '', get_option('home') . '/' ) ); define('COOKIEPATH', preg_replace('|https?://[^/]+|i', '', get_option('home') . '/' ) );
/** /**
* It is possible to define this in wp-config.php * It is possible to define this in wp-config.php
* @since 2.0 * @since 1.5.0
*/ */
if ( !defined('SITECOOKIEPATH') ) if ( !defined('SITECOOKIEPATH') )
define('SITECOOKIEPATH', preg_replace('|https?://[^/]+|i', '', get_option('siteurl') . '/' ) ); define('SITECOOKIEPATH', preg_replace('|https?://[^/]+|i', '', get_option('siteurl') . '/' ) );
/** /**
* It is possible to define this in wp-config.php * It is possible to define this in wp-config.php
* @since 2.0 * @since 2.0.0
*/ */
if ( !defined('COOKIE_DOMAIN') ) if ( !defined('COOKIE_DOMAIN') )
define('COOKIE_DOMAIN', false); define('COOKIE_DOMAIN', false);
@ -360,7 +359,7 @@ do_action('sanitize_comment_cookies');
/** /**
* WordPress Query object * WordPress Query object
* @global object $wp_the_query * @global object $wp_the_query
* @since 2.0 * @since 2.0.0
*/ */
$wp_the_query =& new WP_Query(); $wp_the_query =& new WP_Query();
@ -368,21 +367,21 @@ $wp_the_query =& new WP_Query();
* Holds the reference to @see $wp_the_query * Holds the reference to @see $wp_the_query
* Use this global for WordPress queries * Use this global for WordPress queries
* @global object $wp_query * @global object $wp_query
* @since 2.0 * @since 1.5.0
*/ */
$wp_query =& $wp_the_query; $wp_query =& $wp_the_query;
/** /**
* Holds the WordPress Rewrite object for creating pretty URLs * Holds the WordPress Rewrite object for creating pretty URLs
* @global object $wp_rewrite * @global object $wp_rewrite
* @since 2.0 * @since 1.5.0
*/ */
$wp_rewrite =& new WP_Rewrite(); $wp_rewrite =& new WP_Rewrite();
/** /**
* WordPress Object * WordPress Object
* @global object $wp * @global object $wp
* @since 2.0 * @since 2.0.0
*/ */
$wp =& new WP(); $wp =& new WP();
@ -402,6 +401,10 @@ define('STYLESHEETPATH', get_stylesheet_directory());
// Load the default text localization domain. // Load the default text localization domain.
load_default_textdomain(); load_default_textdomain();
/**
* The locale of the blog
* @since 1.5.0
*/
$locale = get_locale(); $locale = get_locale();
$locale_file = ABSPATH . LANGDIR . "/$locale.php"; $locale_file = ABSPATH . LANGDIR . "/$locale.php";
if ( is_readable($locale_file) ) if ( is_readable($locale_file) )
@ -413,7 +416,7 @@ require_once(ABSPATH . WPINC . '/locale.php');
/** /**
* WordPress Locale object for loading locale domain date and various strings. * WordPress Locale object for loading locale domain date and various strings.
* @global object $wp_locale * @global object $wp_locale
* @since 2.1 * @since 2.1.0
*/ */
$wp_locale =& new WP_Locale(); $wp_locale =& new WP_Locale();
@ -424,11 +427,10 @@ if ( file_exists(TEMPLATEPATH . '/functions.php') )
include(TEMPLATEPATH . '/functions.php'); include(TEMPLATEPATH . '/functions.php');
/** /**
* Runs just before PHP shuts down execution. * shutdown_action_hook() - Runs just before PHP shuts down execution.
* *
* @access private * @access private
* @package WordPress * @since 1.2
* @since 1.5
*/ */
function shutdown_action_hook() { function shutdown_action_hook() {
do_action('shutdown'); do_action('shutdown');