Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-12-22 09:07:59 +01:00
Code Issues Projects Releases Wiki Activity

phpdoc typo and readability fixes. Props SergeyBiryukov. fixes #18560

Browse Source 
git-svn-id: http://svn.automattic.com/wordpress/trunk@18827 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
ryan 2011-09-29 22:57:43 +00:00
parent 4171ea192b
commit 32e25b6aec
9 changed files with 117 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
wp-includes/deprecated.php
View File

@ -2731,9 +2731,9 @@ function sanitize_user_object($user, $context = 'display') {
* @deprecated 3.3
*
* @param string $title Optional. Link title format.
* @param bool $in_same_cat Optional. Whether link should be in same category.
* @param bool $in_same_cat Optional. Whether link should be in a same category.
* @param string $excluded_categories Optional. Excluded categories IDs.
* @param bool $start Optional, default is true. Whether display link to first or last post.
* @param bool $start Optional, default is true. Whether to display link to first or last post.
* @return string
*/
function get_boundary_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '', $start = true) {
@ -2771,7 +2771,7 @@ function get_boundary_post_rel_link($title = '%title', $in_same_cat = false, $ex
* @deprecated 3.3
*
* @param string $title Optional. Link title format.
* @param bool $in_same_cat Optional. Whether link should be in same category.
* @param bool $in_same_cat Optional. Whether link should be in a same category.
* @param string $excluded_categories Optional. Excluded categories IDs.
*/
function start_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') {

18
wp-includes/kses.php
View File

@ -842,7 +842,7 @@ function wp_kses_hair($attr, $allowed_protocols) {
* Performs different checks for attribute values.
*
* The currently implemented checks are "maxlen", "minlen", "maxval", "minval"
* and "valueless" with even more checks to come soon.
* and "valueless".
*
* @since 1.0.0
*
@ -887,7 +887,7 @@ function wp_kses_check_attr_val($value, $vless, $checkname, $checkvalue) {
break;
case 'minval' :
# The minval check checks that the attribute value is a positive integer,
# The minval check makes sure that the attribute value is a positive integer,
# and that it is not smaller than the given value.
if (!preg_match('/^\s{0,6}[0-9]{1,6}\s{0,6}$/', $value))
@ -897,7 +897,7 @@ function wp_kses_check_attr_val($value, $vless, $checkname, $checkvalue) {
break;
case 'valueless' :
# The valueless check checks if the attribute has a value
# The valueless check makes sure if the attribute has a value
# (like <a href="blah">) or not (<option selected>). If the given value
# is a "y" or a "Y", the attribute must not have a value.
# If the given value is an "n" or an "N", the attribute must have one.
@ -954,14 +954,14 @@ function wp_kses_no_null($string) {
/**
* Strips slashes from in front of quotes.
*
* This function changes the character sequence \" to just ". It leaves all
* This function changes the character sequence \" to just ". It leaves all
* other slashes alone. It's really weird, but the quoting from
* preg_replace(//e) seems to require this.
*
* @since 1.0.0
*
* @param string $string String to strip slashes
* @return string Fixed strings with quoted slashes
* @return string Fixed string with quoted slashes
*/
function wp_kses_stripslashes($string) {
return preg_replace('%\\\\"%', '"', $string);
@ -1042,7 +1042,7 @@ function wp_kses_bad_protocol_once($string, $allowed_protocols) {
* Callback for wp_kses_bad_protocol_once() regular expression.
*
* This function processes URL protocols, checks to see if they're in the
* white-list or not, and returns different data depending on the answer.
* whitelist or not, and returns different data depending on the answer.
*
* @access private
* @since 1.0.0
@ -1119,7 +1119,7 @@ function wp_kses_named_entities($matches) {
/**
* Callback for wp_kses_normalize_entities() regular expression.
*
* This function helps wp_kses_normalize_entities() to only accept 16 bit values
* This function helps wp_kses_normalize_entities() to only accept 16-bit values
* and nothing more for &#number; entities.
*
* @access private
@ -1166,7 +1166,7 @@ function wp_kses_normalize_entities3($matches) {
* Helper function to determine if a Unicode value is valid.
*
* @param int $i Unicode value
* @return bool true if the value was a valid Unicode number
* @return bool True if the value was a valid Unicode number
*/
function valid_unicode($i) {
return ( $i == 0x9 || $i == 0xa || $i == 0xd ||
@ -1342,7 +1342,7 @@ function kses_remove_filters() {
* will be added.
*
* First removes all of the Kses filters in case the current user does not need
* to have Kses filter the content. If the user does not have unfiltered html
* to have Kses filter the content. If the user does not have unfiltered_html
* capability, then Kses filters are added.
*
* @uses kses_remove_filters() Removes the Kses filters

28
wp-includes/l10n.php
View File

@ -16,7 +16,7 @@
* defined. Then it is filtered through the 'locale' filter hook and the value
* for the locale global set and the locale is returned.
*
* The process to get the locale should only be done once but the locale will
* The process to get the locale should only be done once, but the locale will
* always be filtered using the 'locale' hook.
*
* @since 1.5.0
@ -53,7 +53,7 @@ function get_locale() {
/**
* Retrieves the translation of $text. If there is no translation, or
* the domain isn't loaded the original text is returned.
* the domain isn't loaded, the original text is returned.
*
* @see __() Don't use translate() directly, use __()
* @since 2.2.0
@ -84,7 +84,7 @@ function translate_with_gettext_context( $text, $context, $domain = 'default' )
/**
* Retrieves the translation of $text. If there is no translation, or
* the domain isn't loaded the original text is returned.
* the domain isn't loaded, the original text is returned.
*
* @see translate() An alias of translate()
* @since 2.1.0
@ -99,7 +99,7 @@ function __( $text, $domain = 'default' ) {
/**
* Retrieves the translation of $text and escapes it for safe use in an attribute.
* If there is no translation, or the domain isn't loaded the original text is returned.
* If there is no translation, or the domain isn't loaded, the original text is returned.
*
* @see translate() An alias of translate()
* @see esc_attr()
@ -115,7 +115,7 @@ function esc_attr__( $text, $domain = 'default' ) {
/**
* Retrieves the translation of $text and escapes it for safe use in HTML output.
* If there is no translation, or the domain isn't loaded the original text is returned.
* If there is no translation, or the domain isn't loaded, the original text is returned.
*
* @see translate() An alias of translate()
* @see esc_html()
@ -177,7 +177,7 @@ function esc_html_e( $text, $domain = 'default' ) {
* found in more than two places but with different translated context.
*
* By including the context in the pot file translators can translate the two
* string differently.
* strings differently.
*
* @since 2.8.0
*
@ -257,7 +257,7 @@ function _nx($single, $plural, $number, $context, $domain = 'default') {
/**
* Register plural strings in POT file, but don't translate them.
*
* Used when you want do keep structures with translatable plural strings and
* Used when you want to keep structures with translatable plural strings and
* use them later.
*
* Example:
@ -291,8 +291,8 @@ function _nx_noop( $singular, $plural, $context ) {
* Translate the result of _n_noop() or _nx_noop()
*
* @since 3.1
* @param array $nooped_plural array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop()
* @param int $count number of objects
* @param array $nooped_plural Array with singular, plural and context keys, usually the result of _n_noop() or _nx_noop()
* @param int $count Number of objects
* @param string $domain Optional. The domain identifier the text should be retrieved in
*/
function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' ) {
@ -316,7 +316,7 @@ function translate_nooped_plural( $nooped_plural, $count, $domain = 'default' )
*
* @param string $domain Unique identifier for retrieving translated strings
* @param string $mofile Path to the .mo file
* @return bool true on success, false on failure
* @return bool True on success, false on failure
*/
function load_textdomain( $domain, $mofile ) {
global $l10n;
@ -373,7 +373,7 @@ function unload_textdomain( $domain ) {
* Loads default translated strings based on locale.
*
* Loads the .mo file in WP_LANG_DIR constant path from WordPress root. The
* translated (.mo) file is named based off of the locale.
* translated (.mo) file is named based on the locale.
*
* @since 1.5.0
*/
@ -422,8 +422,8 @@ function load_plugin_textdomain( $domain, $abs_rel_path = false, $plugin_rel_pat
* @since 3.0.0
*
* @param string $domain Unique identifier for retrieving translated strings
* @param strings $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which
* the MO file resides. Defaults is empty string.
* @param string $mu_plugin_rel_path Relative to WPMU_PLUGIN_DIR directory in which
* the MO file resides. Defaults to empty string.
*/
function load_muplugin_textdomain( $domain, $mu_plugin_rel_path = '' ) {
$locale = apply_filters( 'plugin_locale', get_locale(), $domain );
@ -520,7 +520,7 @@ function translate_user_role( $name ) {
* @since 3.0.0
*
* @param string $dir A directory in which to search for language files. The default directory is WP_LANG_DIR.
* @return array Array of language codes or an empty array if no languages are present. Language codes are formed by stripping the .mo extension from the language file names.
* @return array Array of language codes or an empty array if no languages are present. Language codes are formed by stripping the .mo extension from the language file names.
*/
function get_available_languages( $dir = null ) {
$languages = array();

134
wp-includes/link-template.php
View File

@ -560,7 +560,7 @@ function get_author_feed_link( $author_id, $feed = '' ) {
/**
* Retrieve the feed link for a category.
*
* Returns a link to the feed for all post in a given category. A specific feed
* Returns a link to the feed for all posts in a given category. A specific feed
* can be requested or left blank to get the default feed.
*
* @package WordPress
@ -576,9 +576,9 @@ function get_category_feed_link($cat_id, $feed = '') {
}
/**
* Retrieve the feed link for a taxonomy.
* Retrieve the feed link for a term.
*
* Returns a link to the feed for all post in a given term. A specific feed
* Returns a link to the feed for all posts in a given term. A specific feed
* can be requested or left blank to get the default feed.
*
* @since 3.0
@ -586,7 +586,7 @@ function get_category_feed_link($cat_id, $feed = '') {
* @param int $term_id ID of a category.
* @param string $taxonomy Optional. Taxonomy of $term_id
* @param string $feed Optional. Feed type.
* @return string Link to the feed for the taxonomy specified by $term_id and $taxonomy.
* @return string Link to the feed for the term specified by $term_id and $taxonomy.
*/
function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
global $wp_rewrite;
@ -895,7 +895,7 @@ function get_post_type_archive_feed_link( $post_type, $feed = '' ) {
* @since 2.3.0
*
* @param int $id Optional. Post ID.
* @param string $context Optional, default to display. How to write the '&', defaults to '&amp;'.
* @param string $context Optional, defaults to display. How to write the '&', defaults to '&amp;'.
* @return string
*/
function get_edit_post_link( $id = 0, $context = 'display' ) {
@ -1064,7 +1064,7 @@ function edit_bookmark_link( $link = '', $before = '', $after = '', $bookmark =
*
* @since 1.5.0
*
* @param bool $in_same_cat Optional. Whether post should be in same category.
* @param bool $in_same_cat Optional. Whether post should be in a same category.
* @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
* @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
*/
@ -1077,7 +1077,7 @@ function get_previous_post($in_same_cat = false, $excluded_categories = '') {
*
* @since 1.5.0
*
* @param bool $in_same_cat Optional. Whether post should be in same category.
* @param bool $in_same_cat Optional. Whether post should be in a same category.
* @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
* @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
*/
@ -1092,7 +1092,7 @@ function get_next_post($in_same_cat = false, $excluded_categories = '') {
*
* @since 2.5.0
*
* @param bool $in_same_cat Optional. Whether post should be in same category.
* @param bool $in_same_cat Optional. Whether post should be in a same category.
* @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
* @param bool $previous Optional. Whether to retrieve previous post.
* @return mixed Post object if successful. Null if global $post is not set. Empty string if no corresponding post exists.
@ -1170,9 +1170,9 @@ function get_adjacent_post( $in_same_cat = false, $excluded_categories = '', $pr
* @since 2.8.0
*
* @param string $title Optional. Link title format.
* @param bool $in_same_cat Optional. Whether link should be in same category.
* @param bool $in_same_cat Optional. Whether link should be in a same category.
* @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
* @param bool $previous Optional, default is true. Whether display link to previous post.
* @param bool $previous Optional, default is true. Whether to display link to previous or next post.
* @return string
*/
function get_adjacent_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '', $previous = true) {
@ -1207,7 +1207,7 @@ function get_adjacent_post_rel_link($title = '%title', $in_same_cat = false, $ex
* @since 2.8.0
*
* @param string $title Optional. Link title format.
* @param bool $in_same_cat Optional. Whether link should be in same category.
* @param bool $in_same_cat Optional. Whether link should be in a same category.
* @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
*/
function adjacent_posts_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') {
@ -1218,7 +1218,7 @@ function adjacent_posts_rel_link($title = '%title', $in_same_cat = false, $exclu
/**
* Display relational links for the posts adjacent to the current post for single post pages.
*
* This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins or theme templates.
* This is meant to be attached to actions like 'wp_head'. Do not call this directly in plugins or theme templates.
* @since 3.0.0
*
*/
@ -1234,7 +1234,7 @@ function adjacent_posts_rel_link_wp_head() {
* @since 2.8.0
*
* @param string $title Optional. Link title format.
* @param bool $in_same_cat Optional. Whether link should be in same category.
* @param bool $in_same_cat Optional. Whether link should be in a same category.
* @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
*/
function next_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') {
@ -1247,7 +1247,7 @@ function next_post_rel_link($title = '%title', $in_same_cat = false, $excluded_c
* @since 2.8.0
*
* @param string $title Optional. Link title format.
* @param bool $in_same_cat Optional. Whether link should be in same category.
* @param bool $in_same_cat Optional. Whether link should be in a same category.
* @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
*/
function prev_post_rel_link($title = '%title', $in_same_cat = false, $excluded_categories = '') {
@ -1258,11 +1258,11 @@ function prev_post_rel_link($title = '%title', $in_same_cat = false, $excluded_c
* Retrieve boundary post.
*
* Boundary being either the first or last post by publish date within the constraints specified
* by in same category or excluded categories.
* by $in_same_cat or $excluded_categories.
*
* @since 2.8.0
*
* @param bool $in_same_cat Optional. Whether returned post should be in same category.
* @param bool $in_same_cat Optional. Whether returned post should be in a same category.
* @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
* @param bool $start Optional. Whether to retrieve first or last post.
* @return object
@ -1306,7 +1306,7 @@ function get_boundary_post( $in_same_cat = false, $excluded_categories = '', $st
*
* @param string $format Optional. Link anchor format.
* @param string $link Optional. Link permalink format.
* @param bool $in_same_cat Optional. Whether link should be in same category.
* @param bool $in_same_cat Optional. Whether link should be in a same category.
* @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
*/
function previous_post_link($format='&laquo; %link', $link='%title', $in_same_cat = false, $excluded_categories = '') {
@ -1320,7 +1320,7 @@ function previous_post_link($format='&laquo; %link', $link='%title', $in_same_ca
*
* @param string $format Optional. Link anchor format.
* @param string $link Optional. Link permalink format.
* @param bool $in_same_cat Optional. Whether link should be in same category.
* @param bool $in_same_cat Optional. Whether link should be in a same category.
* @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
*/
function next_post_link($format='%link &raquo;', $link='%title', $in_same_cat = false, $excluded_categories = '') {
@ -1336,9 +1336,9 @@ function next_post_link($format='%link &raquo;', $link='%title', $in_same_cat =
*
* @param string $format Link anchor format.
* @param string $link Link permalink format.
* @param bool $in_same_cat Optional. Whether link should be in same category.
* @param bool $in_same_cat Optional. Whether link should be in a same category.
* @param array|string $excluded_categories Optional. Array or comma-separated list of excluded category IDs.
* @param bool $previous Optional, default is true. Whether display link to previous post.
* @param bool $previous Optional, default is true. Whether to display link to previous or next post.
*/
function adjacent_post_link($format, $link, $in_same_cat = false, $excluded_categories = '', $previous = true) {
if ( $previous && is_attachment() )
@ -1370,7 +1370,7 @@ function adjacent_post_link($format, $link, $in_same_cat = false, $excluded_cate
}
/**
* Retrieve get links for page numbers.
* Retrieve links for page numbers.
*
* @since 1.5.0
*
@ -1432,7 +1432,7 @@ function get_pagenum_link($pagenum = 1) {
}
/**
* Retrieve next posts pages link.
* Retrieve next posts page link.
*
* Backported from 2.1.3 to 2.0.10.
*
@ -1454,7 +1454,7 @@ function get_next_posts_page_link($max_page = 0) {
}
/**
* Display or return the next posts pages link.
* Display or return the next posts page link.
*
* @since 0.71
*
@ -1471,7 +1471,7 @@ function next_posts( $max_page = 0, $echo = true ) {
}
/**
* Return the next posts pages link.
* Return the next posts page link.
*
* @since 2.7.0
*
@ -1500,7 +1500,7 @@ function get_next_posts_link( $label = null, $max_page = 0 ) {
}
/**
* Display the next posts pages link.
* Display the next posts page link.
*
* @since 0.71
* @uses get_next_posts_link()
@ -1513,7 +1513,7 @@ function next_posts_link( $label = null, $max_page = 0 ) {
}
/**
* Retrieve previous post pages link.
* Retrieve previous posts page link.
*
* Will only return string, if not on a single page or post.
*
@ -1535,7 +1535,7 @@ function get_previous_posts_page_link() {
}
/**
* Display or return the previous posts pages link.
* Display or return the previous posts page link.
*
* @since 0.71
*
@ -1551,7 +1551,7 @@ function previous_posts( $echo = true ) {
}
/**
* Return the previous posts pages link.
* Return the previous posts page link.
*
* @since 2.7.0
*
@ -1636,7 +1636,7 @@ function posts_nav_link( $sep = '', $prelabel = '', $nxtlabel = '' ) {
}
/**
* Retrieve page numbers links.
* Retrieve comments page number link.
*
* @since 2.7.0
*
@ -1672,7 +1672,7 @@ function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
}
/**
* Return the link to next comments pages.
* Return the link to next comments page.
*
* @since 2.7.1
*
@ -1706,7 +1706,7 @@ function get_next_comments_link( $label = '', $max_page = 0 ) {
}
/**
* Display the link to next comments pages.
* Display the link to next comments page.
*
* @since 2.7.0
*
@ -1759,7 +1759,7 @@ function previous_comments_link( $label = '' ) {
* @see paginate_links()
* @since 2.7.0
*
* @param string|array $args Optional args. See paginate_links.
* @param string|array $args Optional args. See paginate_links().
* @return string Markup for pagination links.
*/
function paginate_comments_links($args = array()) {
@ -1825,7 +1825,7 @@ function get_shortcut_link() {
/**
* Retrieve the home url for the current site.
*
* Returns the 'home' option with the appropriate protocol, 'https' if
* Returns the 'home' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
@ -1835,7 +1835,7 @@ function get_shortcut_link() {
* @uses get_home_url()
*
* @param string $path (optional) Path relative to the home url.
* @param string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
* @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https'.
* @return string Home url link with optional path appended.
*/
function home_url( $path = '', $scheme = null ) {
@ -1845,7 +1845,7 @@ function home_url( $path = '', $scheme = null ) {
/**
* Retrieve the home url for a given site.
*
* Returns the 'home' option with the appropriate protocol, 'https' if
* Returns the 'home' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
@ -1854,7 +1854,7 @@ function home_url( $path = '', $scheme = null ) {
*
* @param int $blog_id (optional) Blog ID. Defaults to current blog.
* @param string $path (optional) Path relative to the home url.
* @param string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
* @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https'.
* @return string Home url link with optional path appended.
*/
function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
@ -1880,7 +1880,7 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
/**
* Retrieve the site url for the current site.
*
* Returns the 'site_url' option with the appropriate protocol, 'https' if
* Returns the 'site_url' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
@ -1890,7 +1890,7 @@ function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
* @uses get_site_url()
*
* @param string $path Optional. Path relative to the site url.
* @param string $scheme Optional. Scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'.
* @param string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', or 'admin'.
* @return string Site url link with optional path appended.
*/
function site_url( $path = '', $scheme = null ) {
@ -1900,7 +1900,7 @@ function site_url( $path = '', $scheme = null ) {
/**
* Retrieve the site url for a given site.
*
* Returns the 'site_url' option with the appropriate protocol, 'https' if
* Returns the 'site_url' option with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
@ -1909,7 +1909,7 @@ function site_url( $path = '', $scheme = null ) {
*
* @param int $blog_id (optional) Blog ID. Defaults to current blog.
* @param string $path Optional. Path relative to the site url.
* @param string $scheme Optional. Scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'.
* @param string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', or 'admin'.
* @return string Site url link with optional path appended.
*/
function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
@ -1946,9 +1946,9 @@ function get_site_url( $blog_id = null, $path = '', $scheme = null ) {
* @package WordPress
* @since 2.6.0
*
* @param string $path Optional path relative to the admin url
* @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended
* @return string Admin url link with optional path appended.
*/
function admin_url( $path = '', $scheme = 'admin' ) {
return get_admin_url(null, $path, $scheme);
@ -1961,9 +1961,9 @@ function admin_url( $path = '', $scheme = 'admin' ) {
* @since 3.0.0
*
* @param int $blog_id (optional) Blog ID. Defaults to current blog.
* @param string $path Optional path relative to the admin url
* @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended
* @return string Admin url link with optional path appended.
*/
function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
$url = get_site_url($blog_id, 'wp-admin/', $scheme);
@ -2054,7 +2054,7 @@ function plugins_url($path = '', $plugin = '') {
/**
* Retrieve the site url for the current network.
*
* Returns the site url with the appropriate protocol, 'https' if
* Returns the site url with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
@ -2062,7 +2062,7 @@ function plugins_url($path = '', $plugin = '') {
* @since 3.0.0
*
* @param string $path Optional. Path relative to the site url.
* @param string $scheme Optional. Scheme to give the site url context. Currently 'http','https', 'login', 'login_post', or 'admin'.
* @param string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', or 'admin'.
* @return string Site url link with optional path appended.
*/
function network_site_url( $path = '', $scheme = null ) {
@ -2094,7 +2094,7 @@ function network_site_url( $path = '', $scheme = null ) {
/**
* Retrieve the home url for the current network.
*
* Returns the home url with the appropriate protocol, 'https' if
* Returns the home url with the appropriate protocol, 'https' if
* is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
* overridden.
*
@ -2102,7 +2102,7 @@ function network_site_url( $path = '', $scheme = null ) {
* @since 3.0.0
*
* @param string $path (optional) Path relative to the home url.
* @param string $scheme (optional) Scheme to give the home url context. Currently 'http','https'
* @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https'.
* @return string Home url link with optional path appended.
*/
function network_home_url( $path = '', $scheme = null ) {
@ -2130,9 +2130,9 @@ function network_home_url( $path = '', $scheme = null ) {
* @package WordPress
* @since 3.0.0
*
* @param string $path Optional path relative to the admin url
* @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended
* @return string Admin url link with optional path appended.
*/
function network_admin_url( $path = '', $scheme = 'admin' ) {
if ( ! is_multisite() )
@ -2152,9 +2152,9 @@ function network_admin_url( $path = '', $scheme = 'admin' ) {
* @package WordPress
* @since 3.0.0
*
* @param string $path Optional path relative to the admin url
* @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended
* @return string Admin url link with optional path appended.
*/
function user_admin_url( $path = '', $scheme = 'admin' ) {
$url = network_site_url('wp-admin/user/', $scheme);
@ -2171,9 +2171,9 @@ function user_admin_url( $path = '', $scheme = 'admin' ) {
* @package WordPress
* @since 3.1.0
*
* @param string $path Optional path relative to the admin url
* @param string $path Optional path relative to the admin url.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Admin url link with optional path appended
* @return string Admin url link with optional path appended.
*/
function self_admin_url($path = '', $scheme = 'admin') {
if ( is_network_admin() )
@ -2187,16 +2187,16 @@ function self_admin_url($path = '', $scheme = 'admin') {
/**
* Get the URL to the user's dashboard.
*
* If a user does not belong to any sites, the global user dashboard is used. If the user belongs to the current site,
* the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's
* If a user does not belong to any site, the global user dashboard is used. If the user belongs to the current site,
* the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's
* primary blog is returned.
*
* @since 3.1.0
*
* @param int $user_id User ID
* @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins.
* @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins.
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Dashboard url link with optional path appended
* @return string Dashboard url link with optional path appended.
*/
function get_dashboard_url( $user_id, $path = '', $scheme = 'admin' ) {
$user_id = (int) $user_id;
@ -2229,7 +2229,7 @@ function get_dashboard_url( $user_id, $path = '', $scheme = 'admin' ) {
*
* @param int $user User ID
* @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
* @return string Dashboard url link with optional path appended
* @return string Dashboard url link with optional path appended.
*/
function get_edit_profile_url( $user, $scheme = 'admin' ) {
$user = (int) $user;
@ -2245,7 +2245,7 @@ function get_edit_profile_url( $user, $scheme = 'admin' ) {
}
/**
* Output rel=canonical for singular queries
* Output rel=canonical for singular queries.
*
* @package WordPress
* @since 2.9.0
@ -2265,14 +2265,14 @@ function rel_canonical() {
/**
* Return a shortlink for a post, page, attachment, or blog.
*
* This function exists to provide a shortlink tag that all themes and plugins can target. A plugin must hook in to
* provide the actual shortlinks. Default shortlink support is limited to providing ?p= style links for posts.
* Plugins can short circuit this function via the pre_get_shortlink filter or filter the output
* This function exists to provide a shortlink tag that all themes and plugins can target. A plugin must hook in to
* provide the actual shortlinks. Default shortlink support is limited to providing ?p= style links for posts.
* Plugins can short-circuit this function via the pre_get_shortlink filter or filter the output
* via the get_shortlink filter.
*
* @since 3.0.0.
*
* @param int $id A post or blog id. Default is 0, which means the current post or blog.
* @param int $id A post or blog id. Default is 0, which means the current post or blog.
* @param string $context Whether the id is a 'blog' id, 'post' id, or 'media' id. If 'post', the post_type of the post is consulted. If 'query', the current query is consulted to determine the id and context. Default is 'post'.
* @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
* @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.
@ -2352,10 +2352,10 @@ function wp_shortlink_header() {
*
* @since 3.0.0
*
* @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
* @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
* @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
* @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
* @param string $before Optional HTML to display before the link.
* @param string $before Optional HTML to display after the link.
* @param string $after Optional HTML to display after the link.
*/
function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
global $post;

16
wp-includes/load.php
View File

@ -186,7 +186,7 @@ function wp_maintenance() {
*
* @access private
* @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.
*/
function timer_start() {
@ -210,11 +210,11 @@ function timer_start() {
* timer_stop(1);
* </code>
* 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.
* in most cases, you only need to echo it.
*
* @since 0.71
* @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 $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
*
* @param int $display Use '0' or null to not echo anything and 1 to echo the total time
* @param int $precision The amount of digits from the right of the decimal to display. Default is 3.
@ -287,9 +287,9 @@ function wp_debug_mode() {
*
* To set directory manually, define <code>WP_LANG_DIR</code> in wp-config.php.
*
* If the language directory exists within WP_CONTENT_DIR that is used
* Otherwise if the language directory exists within WPINC, that's used
* Finally, If neither of the preceeding directories is found,
* If the language directory exists within WP_CONTENT_DIR, that is used.
* Otherwise if the language directory exists within WPINC, that's used.
* Finally, if neither of the preceding directories are found,
* WP_CONTENT_DIR/languages is used.
*
* The WP_LANG_DIR constant was introduced in 2.1.0.
@ -396,7 +396,7 @@ function wp_start_object_cache() {
} else if ( !$_wp_using_ext_object_cache && file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) {
// Sometimes advanced-cache.php can load object-cache.php before it is loaded here.
// This breaks the function_exists check above and can result in $_wp_using_ext_object_cache
// being set incorrectly. Double check if an external cache exists.
// being set incorrectly. Double check if an external cache exists.
$_wp_using_ext_object_cache = true;
}

2
wp-includes/locale.php
View File

@ -25,7 +25,7 @@ class WP_Locale {
* Stores the translated strings for the one character weekday names.
*
* There is a hack to make sure that Tuesday and Thursday, as well
* as Sunday and Saturday don't conflict. See init() method for more.
* as Sunday and Saturday, don't conflict. See init() method for more.
*
* @see WP_Locale::init() for how to handle the hack.
*

22
wp-includes/media.php
View File

@ -17,7 +17,7 @@
* than the supported will result in the content_width size or 500 if that is
* not set.
*
* Finally, there is a filter named, 'editor_max_image_size' that will be called
* Finally, there is a filter named 'editor_max_image_size', that will be called
* on the calculated array for width and height, respectively. The second
* parameter will be the value that was in the $size parameter. The returned
* type for the hook is an array with the width as the first element and the
@ -177,6 +177,8 @@ function image_downsize($id, $size = 'medium') {
/**
* Registers a new image size
*
* @since 2.9.0
*/
function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
global $_wp_additional_image_sizes;
@ -185,6 +187,8 @@ function add_image_size( $name, $width = 0, $height = 0, $crop = false ) {
/**
* Registers an image size for the post thumbnail
*
* @since 2.9.0
*/
function set_post_thumbnail_size( $width = 0, $height = 0, $crop = false ) {
add_image_size( 'post-thumbnail', $width, $height, $crop );
@ -329,7 +333,7 @@ function wp_constrain_dimensions( $current_width, $current_height, $max_width=0,
* @param int $dest_w New width.
* @param int $dest_h New height.
* @param bool $crop Optional, default is false. Whether to crop image or resize.
* @return bool|array False, on failure. Returned array matches parameters for imagecopyresampled() PHP function.
* @return bool|array False on failure. Returned array matches parameters for imagecopyresampled() PHP function.
*/
function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = false) {
@ -398,7 +402,7 @@ function image_resize_dimensions($orig_w, $orig_h, $dest_w, $dest_h, $crop = fal
* @param int $max_w Maximum width to resize to.
* @param int $max_h Maximum height to resize to.
* @param bool $crop Optional. Whether to crop image or resize.
* @param string $suffix Optional. File Suffix.
* @param string $suffix Optional. File suffix.
* @param string $dest_path Optional. New image file path.
* @param int $jpeg_quality Optional, default is 90. Image quality percentage.
* @return mixed WP_Error on failure. String with new destination path.
@ -669,9 +673,9 @@ function wp_get_attachment_image($attachment_id, $size = 'thumbnail', $icon = fa
}
/**
* Adds a 'wp-post-image' class to post thumbnail thumbnails
* Adds a 'wp-post-image' class to post thumbnails
* Uses the begin_fetch_post_thumbnail_html and end_fetch_post_thumbnail_html action hooks to
* dynamically add/remove itself so as to only filter post thumbnail thumbnails
* dynamically add/remove itself so as to only filter post thumbnails
*
* @since 2.9.0
* @param array $attr Attributes including src, class, alt, title
@ -752,7 +756,7 @@ add_shortcode('gallery', 'gallery_shortcode');
*
* @since 2.5.0
*
* @param array $attr Attributes attributed to the shortcode.
* @param array $attr Attributes of the shortcode.
* @return string HTML content to display gallery.
*/
function gallery_shortcode($attr) {
@ -906,7 +910,7 @@ function next_image_link($size = 'thumbnail', $text = false) {
*
* @since 2.5.0
*
* @param bool $prev Optional. Default is true to display previous link, true for next.
* @param bool $prev Optional. Default is true to display previous link, false for next.
*/
function adjacent_image_link($prev = true, $size = 'thumbnail', $text = false) {
global $post;
@ -1079,7 +1083,7 @@ class WP_Embed {
}
/**
* If a post/page was saved, then output Javascript to make
* If a post/page was saved, then output JavaScript to make
* an AJAX request that will call WP_Embed::cache_oembed().
*/
function maybe_run_ajax_cache() {
@ -1373,7 +1377,7 @@ function wp_expand_dimensions( $example_width, $example_height, $max_width, $max
* @uses WP_oEmbed::get_html()
*
* @param string $url The URL that should be embedded.
* @param array $args Addtional arguments and parameters.
* @param array $args Additional arguments and parameters.
* @return string The original URL on failure or the embed HTML on success.
*/
function wp_oembed_get( $url, $args = '' ) {

2
wp-includes/pomo/translations.php
View File

@ -81,7 +81,7 @@ class Translations {
/**
* Given the number of items, returns the 0-based index of the plural form to use
*
* Here, in the base Translations class, the commong logic for English is implmented:
* Here, in the base Translations class, the common logic for English is implemented:
* 0 if there is one element, 1 otherwise
*
* This function should be overrided by the sub-classes. For example MO/PO can derive the logic

2
wp-includes/post-thumbnail-template.php
View File

@ -50,7 +50,7 @@ function the_post_thumbnail( $size = 'post-thumbnail', $attr = '' ) {
/**
* Update cache for thumbnails in the current loop
*
* @sicne 3.2
* @since 3.2
*/
function update_post_thumbnail_cache() {
global $wp_query;