Fix typos in documentation (wp-includes/[a-h]). See #18560.
git-svn-id: http://svn.automattic.com/wordpress/trunk@18633 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
duck_
parent
c1d1590171
commit
e4ed63fc6f
|
|
@ -38,7 +38,7 @@ function get_the_author($deprecated = '') {
|
|||
* still use the old behavior will also pass the value from get_the_author().
|
||||
*
|
||||
* The normal, expected behavior of this function is to echo the author and not
|
||||
* return it. However, backwards compatiability has to be maintained.
|
||||
* return it. However, backwards compatibility has to be maintained.
|
||||
*
|
||||
* @since 0.71
|
||||
* @see get_the_author()
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* Adds data to the cache, if the cache key doesn't aleady exist.
|
||||
* Adds data to the cache, if the cache key doesn't already exist.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @uses $wp_object_cache Object Cache Class
|
||||
|
|
@ -31,7 +31,7 @@ function wp_cache_add($key, $data, $flag = '', $expire = 0) {
|
|||
* Closes the cache.
|
||||
*
|
||||
* This function has ceased to do anything since WordPress 2.5. The
|
||||
* functionality was removed along with the rest of the persistant cache. This
|
||||
* functionality was removed along with the rest of the persistent cache. This
|
||||
* does not mean that plugins can't implement this function when they need to
|
||||
* make sure that the cache is cleaned up after WordPress no longer needs it.
|
||||
*
|
||||
|
|
@ -282,7 +282,7 @@ class WP_Object_Cache {
|
|||
*
|
||||
* @uses WP_Object_Cache::get Checks to see if the cache already has data.
|
||||
* @uses WP_Object_Cache::set Sets the data after the checking the cache
|
||||
* contents existance.
|
||||
* contents existence.
|
||||
*
|
||||
* @since 2.0.0
|
||||
*
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@
|
|||
*
|
||||
* Search engines consider www.somedomain.com and somedomain.com to be two
|
||||
* different URLs when they both go to the same location. This SEO enhancement
|
||||
* prevents penality for duplicate content by redirecting all incoming links to
|
||||
* prevents penalty for duplicate content by redirecting all incoming links to
|
||||
* one or the other.
|
||||
*
|
||||
* Prevents redirection for feeds, trackbacks, searches, comment popup, and
|
||||
|
|
@ -175,10 +175,10 @@ function redirect_canonical( $requested_url = null, $do_redirect = true ) {
|
|||
|
||||
// Create the destination url for this taxonomy
|
||||
$tax_url = parse_url($tax_url);
|
||||
if ( ! empty($tax_url['query']) ) { // Taxonomy accessable via ?taxonomy=..&term=.. or any custom qv..
|
||||
if ( ! empty($tax_url['query']) ) { // Taxonomy accessible via ?taxonomy=..&term=.. or any custom qv..
|
||||
parse_str($tax_url['query'], $query_vars);
|
||||
$redirect['query'] = add_query_arg($query_vars, $redirect['query']);
|
||||
} else { // Taxonomy is accessable via a "pretty-URL"
|
||||
} else { // Taxonomy is accessible via a "pretty-URL"
|
||||
$redirect['path'] = $tax_url['path'];
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -524,7 +524,7 @@ class WP_User {
|
|||
}
|
||||
|
||||
/**
|
||||
* Magic method for checking the existance of a certain custom field
|
||||
* Magic method for checking the existence of a certain custom field
|
||||
*
|
||||
* @since 3.3.0
|
||||
*/
|
||||
|
|
@ -827,7 +827,7 @@ class WP_User {
|
|||
*
|
||||
* This is useful for looking up whether the user has a specific role
|
||||
* assigned to the user. The second optional parameter can also be used to
|
||||
* check for capabilities against a specfic post.
|
||||
* check for capabilities against a specific post.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @access public
|
||||
|
|
|
|||
|
|
@ -222,7 +222,7 @@ class WP_Http {
|
|||
/**
|
||||
* Dispatches a HTTP request to a supporting transport.
|
||||
*
|
||||
* Tests each transport in order to find a transport which matches the request arguements.
|
||||
* Tests each transport in order to find a transport which matches the request arguments.
|
||||
* Also caches the transport instance to be used later.
|
||||
*
|
||||
* The order for blocking requests is cURL, Streams, and finally Fsockopen.
|
||||
|
|
@ -631,7 +631,7 @@ class WP_Http_Fsockopen {
|
|||
|
||||
$endDelay = time();
|
||||
|
||||
// If the delay is greater than the timeout then fsockopen should't be used, because it will
|
||||
// If the delay is greater than the timeout then fsockopen shouldn't be used, because it will
|
||||
// cause a long delay.
|
||||
$elapseDelay = ($endDelay-$startDelay) > $r['timeout'];
|
||||
if ( true === $elapseDelay )
|
||||
|
|
@ -915,7 +915,7 @@ class WP_Http_Streams {
|
|||
else
|
||||
$processedHeaders = WP_Http::processHeaders($meta['wrapper_data']);
|
||||
|
||||
// Streams does not provide an error code which we can use to see why the request stream stoped.
|
||||
// Streams does not provide an error code which we can use to see why the request stream stopped.
|
||||
// We can however test to see if a location header is present and return based on that.
|
||||
if ( isset($processedHeaders['headers']['location']) && 0 !== $args['_redirection'] )
|
||||
return new WP_Error('http_request_failed', __('Too many redirects.'));
|
||||
|
|
@ -1031,7 +1031,7 @@ class WP_Http_Curl {
|
|||
|
||||
|
||||
// CURLOPT_TIMEOUT and CURLOPT_CONNECTTIMEOUT expect integers. Have to use ceil since
|
||||
// a value of 0 will allow an ulimited timeout.
|
||||
// a value of 0 will allow an unlimited timeout.
|
||||
$timeout = (int) ceil( $r['timeout'] );
|
||||
curl_setopt( $handle, CURLOPT_CONNECTTIMEOUT, $timeout );
|
||||
curl_setopt( $handle, CURLOPT_TIMEOUT, $timeout );
|
||||
|
|
@ -1679,7 +1679,7 @@ class WP_Http_Encoding {
|
|||
}
|
||||
|
||||
/**
|
||||
* What enconding the content used when it was compressed to send in the headers.
|
||||
* What encoding the content used when it was compressed to send in the headers.
|
||||
*
|
||||
* @since 2.8
|
||||
*
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ class WP_oEmbed {
|
|||
function __construct() {
|
||||
// List out some popular sites that support oEmbed.
|
||||
// The WP_Embed class disables discovery for non-unfiltered_html users, so only providers in this array will be used for them.
|
||||
// Add to this list using the wp_oembed_add_provider() function (see it's PHPDoc for details).
|
||||
// Add to this list using the wp_oembed_add_provider() function (see its PHPDoc for details).
|
||||
$this->providers = apply_filters( 'oembed_providers', array(
|
||||
'#http://(www\.)?youtube.com/watch.*#i' => array( 'http://www.youtube.com/oembed', true ),
|
||||
'http://youtu.be/*' => array( 'http://www.youtube.com/oembed', false ),
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ class PasswordHash {
|
|||
|
||||
$this->portable_hashes = $portable_hashes;
|
||||
|
||||
$this->random_state = microtime() . uniqid(rand(), TRUE); // removed getmypid() for compability reasons
|
||||
$this->random_state = microtime() . uniqid(rand(), TRUE); // removed getmypid() for compatibility reasons
|
||||
}
|
||||
|
||||
function get_random_bytes($count)
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ class WP_Error {
|
|||
* @since 2.1.0
|
||||
* @access public
|
||||
*
|
||||
* @return array List of error codes, if avaiable.
|
||||
* @return array List of error codes, if available.
|
||||
*/
|
||||
function get_error_codes() {
|
||||
if ( empty($this->errors) )
|
||||
|
|
@ -102,7 +102,7 @@ class WP_Error {
|
|||
* @since 2.1.0
|
||||
*
|
||||
* @param string|int $code Optional. Retrieve messages matching code, if exists.
|
||||
* @return array Error strings on success, or empty array on failure (if using codee parameter).
|
||||
* @return array Error strings on success, or empty array on failure (if using code parameter).
|
||||
*/
|
||||
function get_error_messages($code = '') {
|
||||
// Return all messages if no code specified.
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
/**
|
||||
* WordPress XMLRPC server implementation.
|
||||
*
|
||||
* Implements compatability for Blogger API, MetaWeblog API, MovableType, and
|
||||
* Implements compatibility for Blogger API, MetaWeblog API, MovableType, and
|
||||
* pingback. Additional WordPress API for managing comments, pages, posts,
|
||||
* options, etc.
|
||||
*
|
||||
|
|
@ -747,7 +747,7 @@ class wp_xmlrpc_server extends IXR_Server {
|
|||
ORDER BY ID
|
||||
");
|
||||
|
||||
// The date needs to be formated properly.
|
||||
// The date needs to be formatted properly.
|
||||
$num_pages = count($page_list);
|
||||
for ( $i = 0; $i < $num_pages; $i++ ) {
|
||||
$post_date = mysql2date('Ymd\TH:i:s', $page_list[$i]->post_date, false);
|
||||
|
|
@ -1551,7 +1551,7 @@ class wp_xmlrpc_server extends IXR_Server {
|
|||
* - username
|
||||
* - password
|
||||
* - attachment_id
|
||||
* @return array. Assocciative array containing:
|
||||
* @return array. Associative array containing:
|
||||
* - 'date_created_gmt'
|
||||
* - 'parent'
|
||||
* - 'link'
|
||||
|
|
@ -1661,7 +1661,7 @@ class wp_xmlrpc_server extends IXR_Server {
|
|||
}
|
||||
|
||||
/**
|
||||
* Retrives a list of post formats used by the site
|
||||
* Retrieves a list of post formats used by the site
|
||||
*
|
||||
* @since 3.1
|
||||
*
|
||||
|
|
@ -3445,7 +3445,7 @@ class wp_xmlrpc_server extends IXR_Server {
|
|||
} elseif ( isset($urltest['fragment']) ) {
|
||||
// an #anchor is there, it's either...
|
||||
if ( intval($urltest['fragment']) ) {
|
||||
// ...an integer #XXXX (simpliest case)
|
||||
// ...an integer #XXXX (simplest case)
|
||||
$post_ID = (int) $urltest['fragment'];
|
||||
$way = 'from the fragment (numeric)';
|
||||
} elseif ( preg_match('/post-[0-9]+/',$urltest['fragment']) ) {
|
||||
|
|
|
|||
|
|
@ -569,7 +569,7 @@ class WP_MatchesMapRegex {
|
|||
*
|
||||
* @access public
|
||||
* @param string $subject subject
|
||||
* @param array $matches data used for subsitution
|
||||
* @param array $matches data used for substitution
|
||||
* @return string
|
||||
*/
|
||||
function apply($subject, $matches) {
|
||||
|
|
|
|||
|
|
@ -362,7 +362,7 @@ function get_comment_class( $class = '', $comment_id = null, $post_id = null ) {
|
|||
* Retrieve the comment date of the current comment.
|
||||
*
|
||||
* @since 1.5.0
|
||||
* @uses apply_filters() Calls 'get_comment_date' hook with the formated date and the $d parameter respectively
|
||||
* @uses apply_filters() Calls 'get_comment_date' hook with the formatted date and the $d parameter respectively
|
||||
* @uses $comment
|
||||
*
|
||||
* @param string $d The format of the date (defaults to user's config)
|
||||
|
|
@ -832,7 +832,7 @@ function wp_comment_form_unfiltered_html_nonce() {
|
|||
*
|
||||
* The $file path is passed through a filter hook called, 'comments_template'
|
||||
* which includes the TEMPLATEPATH and $file combined. Tries the $filtered path
|
||||
* first and if it fails it will require the default comment themplate from the
|
||||
* first and if it fails it will require the default comment template from the
|
||||
* default theme. If either does not exist, then the WordPress process will be
|
||||
* halted. It is advised for that reason, that the default theme is not deleted.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -2073,7 +2073,7 @@ function sanitize_url( $url, $protocols = null ) {
|
|||
* Checks and cleans a URL.
|
||||
*
|
||||
* A number of characters are removed from the URL. If the URL is for displaying
|
||||
* (the default behaviour) amperstands are also replaced. The 'clean_url' filter
|
||||
* (the default behaviour) ampersands are also replaced. The 'clean_url' filter
|
||||
* is applied to the returned cleaned URL.
|
||||
*
|
||||
* @since 1.2.0
|
||||
|
|
|
|||
|
|
@ -2228,7 +2228,7 @@ function esc_sql( $sql ) {
|
|||
* Checks and cleans a URL.
|
||||
*
|
||||
* A number of characters are removed from the URL. If the URL is for displaying
|
||||
* (the default behaviour) amperstands are also replaced. The 'clean_url' filter
|
||||
* (the default behaviour) ampersands are also replaced. The 'clean_url' filter
|
||||
* is applied to the returned cleaned URL.
|
||||
*
|
||||
* @since 2.8.0
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@
|
|||
* @param string $dateformatstring Either 'G', 'U', or php date format.
|
||||
* @param string $mysqlstring Time from mysql DATETIME field.
|
||||
* @param bool $translate Optional. Default is true. Will switch format to locale.
|
||||
* @return string Date formated by $dateformatstring or locale (if available).
|
||||
* @return string Date formatted by $dateformatstring or locale (if available).
|
||||
*/
|
||||
function mysql2date( $dateformatstring, $mysqlstring, $translate = true ) {
|
||||
$m = $mysqlstring;
|
||||
|
|
@ -3586,7 +3586,7 @@ function iis7_supports_permalinks() {
|
|||
/* First we check if the DOMDocument class exists. If it does not exist,
|
||||
* which is the case for PHP 4.X, then we cannot easily update the xml configuration file,
|
||||
* hence we just bail out and tell user that pretty permalinks cannot be used.
|
||||
* This is not a big issue because PHP 4.X is going to be depricated and for IIS it
|
||||
* This is not a big issue because PHP 4.X is going to be deprecated and for IIS it
|
||||
* is recommended to use PHP 5.X NTS.
|
||||
* Next we check if the URL Rewrite Module 1.1 is loaded and enabled for the web site. When
|
||||
* URL Rewrite 1.1 is loaded it always sets a server variable called 'IIS_UrlRewriteModule'.
|
||||
|
|
|
|||
|
|
@ -130,7 +130,7 @@ function wp_remote_retrieve_headers(&$response) {
|
|||
*
|
||||
* @param array $response
|
||||
* @param string $header Header name to retrieve value from.
|
||||
* @return string The header value. Empty string on if incorrect parameter given, or if the header doesnt exist.
|
||||
* @return string The header value. Empty string on if incorrect parameter given, or if the header doesn't exist.
|
||||
*/
|
||||
function wp_remote_retrieve_header(&$response, $header) {
|
||||
if ( is_wp_error($response) || ! isset($response['headers']) || ! is_array($response['headers']))
|
||||
|
|
|
|||
Loading…
Reference in New Issue