mirror of
https://github.com/WordPress/WordPress.git
synced 2024-12-22 17:18:32 +01:00
Fix typos in documentation (wp-includes/[i-z]). See #18560.
git-svn-id: http://svn.automattic.com/wordpress/trunk@18639 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
duck_
parent
d6fe2825c9
commit
2f51b9be0d
@ -67,7 +67,7 @@ var tinyMCEPopup = {
|
||||
* Returns a window argument/parameter by name.
|
||||
*
|
||||
* @method getWindowArg
|
||||
* @param {String} n Name of the window argument to retrive.
|
||||
* @param {String} n Name of the window argument to retrieve.
|
||||
* @param {String} dv Optional default value to return.
|
||||
* @return {String} Argument value or default value if it wasn't found.
|
||||
*/
|
||||
@ -81,7 +81,7 @@ var tinyMCEPopup = {
|
||||
* Returns a editor parameter/config option value.
|
||||
*
|
||||
* @method getParam
|
||||
* @param {String} n Name of the editor config option to retrive.
|
||||
* @param {String} n Name of the editor config option to retrieve.
|
||||
* @param {String} dv Optional default value to return.
|
||||
* @return {String} Parameter value or default value if it wasn't found.
|
||||
*/
|
||||
|
||||
@ -398,7 +398,7 @@ function load_default_textdomain() {
|
||||
* @param string $domain Unique identifier for retrieving translated strings
|
||||
* @param string $abs_rel_path Optional. Relative path to ABSPATH of a folder,
|
||||
* where the .mo file resides. Deprecated, but still functional until 2.7
|
||||
* @param string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR. This is the preferred argument to use. It takes precendence over $abs_rel_path
|
||||
* @param string $plugin_rel_path Optional. Relative path to WP_PLUGIN_DIR. This is the preferred argument to use. It takes precedence over $abs_rel_path
|
||||
*/
|
||||
function load_plugin_textdomain( $domain, $abs_rel_path = false, $plugin_rel_path = false ) {
|
||||
$locale = apply_filters( 'plugin_locale', get_locale(), $domain );
|
||||
|
||||
@ -2415,7 +2415,7 @@ function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Inject rel=sortlink into head if a shortlink is defined for the current page.
|
||||
* Inject rel=shortlink into head if a shortlink is defined for the current page.
|
||||
*
|
||||
* Attached to the wp_head action.
|
||||
*
|
||||
|
||||
@ -65,7 +65,7 @@ class WP_Locale {
|
||||
/**
|
||||
* Stores the translated strings for 'am' and 'pm'.
|
||||
*
|
||||
* Also the capalized versions.
|
||||
* Also the capitalized versions.
|
||||
*
|
||||
* @since 2.1.0
|
||||
* @var array
|
||||
|
||||
@ -260,7 +260,7 @@ function wp_load_image( $file ) {
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates the new dimentions for a downsampled image.
|
||||
* Calculates the new dimensions for a downsampled image.
|
||||
*
|
||||
* If either width or height are empty, no constraint is applied on
|
||||
* that dimension.
|
||||
@ -305,7 +305,7 @@ function wp_constrain_dimensions( $current_width, $current_height, $max_width=0,
|
||||
$h = intval( $current_height * $ratio );
|
||||
|
||||
// Sometimes, due to rounding, we'll end up with a result like this: 465x700 in a 177x177 box is 117x176... a pixel short
|
||||
// We also have issues with recursive calls resulting in an ever-changing result. Contraining to the result of a constraint should yield the original result.
|
||||
// We also have issues with recursive calls resulting in an ever-changing result. Constraining to the result of a constraint should yield the original result.
|
||||
// Thus we look for dimensions that are one pixel shy of the max value and bump them up
|
||||
if ( $did_width && $w == $max_width - 1 )
|
||||
$w = $max_width; // Round it up
|
||||
@ -1144,7 +1144,7 @@ class WP_Embed {
|
||||
* @uses update_post_meta()
|
||||
*
|
||||
* @param array $attr Shortcode attributes.
|
||||
* @param string $url The URL attempting to be embeded.
|
||||
* @param string $url The URL attempting to be embedded.
|
||||
* @return string The embed HTML on success, otherwise the original URL.
|
||||
*/
|
||||
function shortcode( $attr, $url = '' ) {
|
||||
@ -1372,7 +1372,7 @@ function wp_expand_dimensions( $example_width, $example_height, $max_width, $max
|
||||
* @uses _wp_oembed_get_object()
|
||||
* @uses WP_oEmbed::get_html()
|
||||
*
|
||||
* @param string $url The URL that should be embeded.
|
||||
* @param string $url The URL that should be embedded.
|
||||
* @param array $args Addtional arguments and parameters.
|
||||
* @return string The original URL on failure or the embed HTML on success.
|
||||
*/
|
||||
|
||||
@ -1086,7 +1086,7 @@ function wp_notify_moderator($comment_id) {
|
||||
$comment = get_comment($comment_id);
|
||||
$post = get_post($comment->comment_post_ID);
|
||||
$user = get_userdata( $post->post_author );
|
||||
// Send to the administation and to the post author if the author can modify the comment.
|
||||
// Send to the administration and to the post author if the author can modify the comment.
|
||||
$email_to = array( get_option('admin_email') );
|
||||
if ( user_can($user->ID, 'edit_comment', $comment_id) && !empty($user->user_email) && ( get_option('admin_email') != $user->user_email) )
|
||||
$email_to[] = $user->user_email;
|
||||
@ -1432,7 +1432,7 @@ if ( !function_exists('wp_check_password') ) :
|
||||
*
|
||||
* Maintains compatibility between old version and the new cookie authentication
|
||||
* protocol using PHPass library. The $hash parameter is the encrypted password
|
||||
* and the function compares the plain text password when encypted similarly
|
||||
* and the function compares the plain text password when encrypted similarly
|
||||
* against the already encrypted password to see if they match.
|
||||
*
|
||||
* For integration with other applications, this function can be overwritten to
|
||||
|
||||
@ -251,7 +251,7 @@ function apply_filters_ref_array($tag, $args) {
|
||||
* @param string $tag The filter hook to which the function to be removed is hooked.
|
||||
* @param callback $function_to_remove The name of the function which should be removed.
|
||||
* @param int $priority optional. The priority of the function (default: 10).
|
||||
* @param int $accepted_args optional. The number of arguments the function accpets (default: 1).
|
||||
* @param int $accepted_args optional. The number of arguments the function accepts (default: 1).
|
||||
* @return boolean Whether the function existed before it was removed.
|
||||
*/
|
||||
function remove_filter($tag, $function_to_remove, $priority = 10, $accepted_args = 1) {
|
||||
@ -520,7 +520,7 @@ function has_action($tag, $function_to_check = false) {
|
||||
* @param string $tag The action hook to which the function to be removed is hooked.
|
||||
* @param callback $function_to_remove The name of the function which should be removed.
|
||||
* @param int $priority optional The priority of the function (default: 10).
|
||||
* @param int $accepted_args optional. The number of arguments the function accpets (default: 1).
|
||||
* @param int $accepted_args optional. The number of arguments the function accepts (default: 1).
|
||||
* @return boolean Whether the function is removed.
|
||||
*/
|
||||
function remove_action($tag, $function_to_remove, $priority = 10, $accepted_args = 1) {
|
||||
@ -745,7 +745,7 @@ function _wp_call_all_hook($args) {
|
||||
* @param string $tag Used in counting how many hooks were applied
|
||||
* @param callback $function Used for creating unique id
|
||||
* @param int|bool $priority Used in counting how many hooks were applied. If === false and $function is an object reference, we return the unique id only if it already has one, false otherwise.
|
||||
* @return string|bool Unique ID for usage as array key or false if $priority === false and $function is an object reference, and it does not already have a uniqe id.
|
||||
* @return string|bool Unique ID for usage as array key or false if $priority === false and $function is an object reference, and it does not already have a unique id.
|
||||
*/
|
||||
function _wp_filter_build_unique_id($tag, $function, $priority) {
|
||||
global $wp_filter;
|
||||
|
||||
@ -1155,7 +1155,7 @@ function _post_type_meta_capabilities( $capabilities = null ) {
|
||||
* Builds an object with all post type labels out of a post type object
|
||||
*
|
||||
* Accepted keys of the label array in the post type object:
|
||||
* - name - general name for the post type, usually plural. The same and overriden by $post_type_object->label. Default is Posts/Pages
|
||||
* - name - general name for the post type, usually plural. The same and overridden by $post_type_object->label. Default is Posts/Pages
|
||||
* - singular_name - name for one object of this post type. Default is Post/Page
|
||||
* - add_new - Default is Add New for both hierarchical and non-hierarchical types. When internationalizing this string, please use a {@link http://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context gettext context} matching your post type. Example: <code>_x('Add New', 'product');</code>
|
||||
* - add_new_item - Default is Add New Post/Add New Page
|
||||
@ -1249,7 +1249,7 @@ add_action( 'admin_menu', '_add_post_type_submenus' );
|
||||
* 'excerpt', 'page-attributes', 'thumbnail', and 'custom-fields'.
|
||||
*
|
||||
* Additionally, the 'revisions' feature dictates whether the post type will store revisions,
|
||||
* and the 'comments' feature dicates whether the comments count will show on the edit screen.
|
||||
* and the 'comments' feature dictates whether the comments count will show on the edit screen.
|
||||
*
|
||||
* @since 3.0.0
|
||||
* @param string $post_type The post type for which to add the feature
|
||||
@ -3269,7 +3269,7 @@ function &get_page_hierarchy( &$pages, $page_id = 0 ) {
|
||||
|
||||
/**
|
||||
* function to traverse and return all the nested children post names of a root page.
|
||||
* $children contains parent-chilren relations
|
||||
* $children contains parent-children relations
|
||||
*
|
||||
* @since 2.9.0
|
||||
*/
|
||||
@ -3911,7 +3911,7 @@ function wp_get_attachment_url( $post_id = 0 ) {
|
||||
}
|
||||
}
|
||||
|
||||
if ( empty($url) ) //If any of the above options failed, Fallback on the GUID as used pre-2.7, not recomended to rely upon this.
|
||||
if ( empty($url) ) //If any of the above options failed, Fallback on the GUID as used pre-2.7, not recommended to rely upon this.
|
||||
$url = get_the_guid( $post->ID );
|
||||
|
||||
$url = apply_filters( 'wp_get_attachment_url', $url, $post->ID );
|
||||
@ -4466,7 +4466,7 @@ function update_postmeta_cache($post_ids) {
|
||||
/**
|
||||
* Will clean the attachment in the cache.
|
||||
*
|
||||
* Cleaning means delete from the cache. Optionaly will clean the term
|
||||
* Cleaning means delete from the cache. Optionally will clean the term
|
||||
* object cache associated with the attachment ID.
|
||||
*
|
||||
* This function will not run if $_wp_suspend_cache_invalidation is not empty. See
|
||||
@ -4664,7 +4664,7 @@ function _get_post_ancestors(&$_post) {
|
||||
* Determines which fields of posts are to be saved in revisions.
|
||||
*
|
||||
* Does two things. If passed a post *array*, it will return a post array ready
|
||||
* to be insterted into the posts table as a post revision. Otherwise, returns
|
||||
* to be inserted into the posts table as a post revision. Otherwise, returns
|
||||
* an array whose keys are the post fields to be saved for post revisions.
|
||||
*
|
||||
* @package WordPress
|
||||
|
||||
@ -2137,7 +2137,7 @@ class WP_Query {
|
||||
if ( intval($q['comments_popup']) )
|
||||
$q['p'] = absint($q['comments_popup']);
|
||||
|
||||
// If an attachment is requested by number, let it supercede any post number.
|
||||
// If an attachment is requested by number, let it supersede any post number.
|
||||
if ( $q['attachment_id'] )
|
||||
$q['p'] = absint($q['attachment_id']);
|
||||
|
||||
@ -2288,7 +2288,7 @@ class WP_Query {
|
||||
if ( $q['author_name'][ count($q['author_name'])-1 ] ) {
|
||||
$q['author_name'] = $q['author_name'][count($q['author_name'])-1]; // no trailing slash
|
||||
} else {
|
||||
$q['author_name'] = $q['author_name'][count($q['author_name'])-2]; // there was a trailling slash
|
||||
$q['author_name'] = $q['author_name'][count($q['author_name'])-2]; // there was a trailing slash
|
||||
}
|
||||
}
|
||||
$q['author_name'] = sanitize_title_for_query( $q['author_name'] );
|
||||
|
||||
@ -159,7 +159,7 @@ function wp_default_scripts( &$scripts ) {
|
||||
if ( empty($max_upload_size) )
|
||||
$max_upload_size = __('not configured');
|
||||
|
||||
// error messagoe for both plupload and swfupload
|
||||
// error message for both plupload and swfupload
|
||||
$uploader_l10n = array(
|
||||
'queue_limit_exceeded' => __('You have attempted to queue too many files.'),
|
||||
'file_exceeds_size_limit' => __('This file exceeds the maximum upload size for this site.'),
|
||||
@ -439,7 +439,7 @@ function wp_default_styles( &$styles ) {
|
||||
*
|
||||
* @since 2.3.1
|
||||
*
|
||||
* @param array $js_array JavaScript scripst array
|
||||
* @param array $js_array JavaScript scripts array
|
||||
* @return array Reordered array, if needed.
|
||||
*/
|
||||
function wp_prototype_before_jquery( $js_array ) {
|
||||
|
||||
@ -157,7 +157,7 @@ function do_shortcode($content) {
|
||||
* The regular expression combines the shortcode tags in the regular expression
|
||||
* in a regex class.
|
||||
*
|
||||
* The regular expresion contains 6 different sub matches to help with parsing.
|
||||
* The regular expression contains 6 different sub matches to help with parsing.
|
||||
*
|
||||
* 1/6 - An extra [ or ] to allow for escaping shortcodes with double [[]]
|
||||
* 2 - The shortcode name
|
||||
|
||||
@ -266,7 +266,7 @@ function is_taxonomy_hierarchical($taxonomy) {
|
||||
* query_var - false to prevent queries, or string to customize query var
|
||||
* (?$query_var=$term); default will use $taxonomy as query var.
|
||||
*
|
||||
* public - If the taxonomy should be publically queryable; //@TODO not implemented.
|
||||
* public - If the taxonomy should be publicly queryable; //@TODO not implemented.
|
||||
* defaults to true.
|
||||
*
|
||||
* show_ui - If the WordPress UI admin tags UI should apply to this taxonomy;
|
||||
@ -276,7 +276,7 @@ function is_taxonomy_hierarchical($taxonomy) {
|
||||
* Defaults to public.
|
||||
*
|
||||
* show_tagcloud - false to prevent the taxonomy being listed in the Tag Cloud Widget;
|
||||
* defaults to show_ui which defalts to public.
|
||||
* defaults to show_ui which defaults to public.
|
||||
*
|
||||
* labels - An array of labels for this taxonomy. You can see accepted values in {@link get_taxonomy_labels()}. By default tag labels are used for non-hierarchical types and category labels for hierarchical ones.
|
||||
*
|
||||
@ -369,7 +369,7 @@ function register_taxonomy( $taxonomy, $object_type, $args = array() ) {
|
||||
* Builds an object with all taxonomy labels out of a taxonomy object
|
||||
*
|
||||
* Accepted keys of the label array in the taxonomy object:
|
||||
* - name - general name for the taxonomy, usually plural. The same as and overriden by $tax->label. Default is Post Tags/Categories
|
||||
* - name - general name for the taxonomy, usually plural. The same as and overridden by $tax->label. Default is Post Tags/Categories
|
||||
* - singular_name - name for one object of this taxonomy. Default is Post Tag/Category
|
||||
* - search_items - Default is Search Tags/Search Categories
|
||||
* - popular_items - This string isn't used on hierarchical taxonomies. Default is Popular Tags
|
||||
@ -1496,7 +1496,7 @@ function term_exists($term, $taxonomy = '', $parent = 0) {
|
||||
/**
|
||||
* Sanitize Term all fields.
|
||||
*
|
||||
* Relys on sanitize_term_field() to sanitize the term. The difference is that
|
||||
* Relies on sanitize_term_field() to sanitize the term. The difference is that
|
||||
* this function will sanitize <strong>all</strong> fields. The context is based
|
||||
* on sanitize_term_field().
|
||||
*
|
||||
@ -1785,7 +1785,7 @@ function wp_delete_term( $term, $taxonomy, $args = array() ) {
|
||||
* @uses wp_delete_term()
|
||||
*
|
||||
* @param int $cat_ID
|
||||
* @return mixed Returns true if completes delete action; false if term doesnt exist;
|
||||
* @return mixed Returns true if completes delete action; false if term doesn't exist;
|
||||
* Zero on attempted deletion of default Category; WP_Error object is also a possibility.
|
||||
*/
|
||||
function wp_delete_category( $cat_ID ) {
|
||||
@ -1810,7 +1810,7 @@ function wp_delete_category( $cat_ID ) {
|
||||
* 'all_with_object_id'.
|
||||
*
|
||||
* The fields argument also decides what will be returned. If 'all' or
|
||||
* 'all_with_object_id' is choosen or the default kept intact, then all matching
|
||||
* 'all_with_object_id' is chosen or the default kept intact, then all matching
|
||||
* terms objects will be returned. If either 'ids' or 'names' is used, then an
|
||||
* array of all matching term ids or term names will be returned respectively.
|
||||
*
|
||||
@ -1918,7 +1918,7 @@ function wp_get_object_terms($object_ids, $taxonomies, $args = array()) {
|
||||
/**
|
||||
* Adds a new term to the database. Optionally marks it as an alias of an existing term.
|
||||
*
|
||||
* Error handling is assigned for the nonexistance of the $taxonomy and $term
|
||||
* Error handling is assigned for the nonexistence of the $taxonomy and $term
|
||||
* parameters before inserting. If both the term id and taxonomy exist
|
||||
* previously, then an array will be returned that contains the term id and the
|
||||
* contents of what is returned. The keys of the array are 'term_id' and
|
||||
@ -2179,7 +2179,7 @@ function wp_set_object_terms($object_id, $terms, $taxonomy, $append = false) {
|
||||
* hierarchical and has a parent, it will append that parent to the $slug.
|
||||
*
|
||||
* If that still doesn't return an unique slug, then it try to append a number
|
||||
* until it finds a number that is truely unique.
|
||||
* until it finds a number that is truly unique.
|
||||
*
|
||||
* The only purpose for $term is for appending a parent, if one exists.
|
||||
*
|
||||
@ -2385,7 +2385,7 @@ function wp_defer_term_counting($defer=null) {
|
||||
/**
|
||||
* Updates the amount of terms in taxonomy.
|
||||
*
|
||||
* If there is a taxonomy callback applyed, then it will be called for updating
|
||||
* If there is a taxonomy callback applied, then it will be called for updating
|
||||
* the count.
|
||||
*
|
||||
* The default action is to count what the amount of terms have the relationship
|
||||
|
||||
@ -469,7 +469,7 @@ function get_themes() {
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @return array|string An arry of theme roots keyed by template/stylesheet or a single theme root if all themes have the same root.
|
||||
* @return array|string An array of theme roots keyed by template/stylesheet or a single theme root if all themes have the same root.
|
||||
*/
|
||||
function get_theme_roots() {
|
||||
global $wp_theme_directories;
|
||||
|
||||
@ -1443,8 +1443,8 @@ function wp_update_user($userdata) {
|
||||
/**
|
||||
* A simpler way of inserting an user into the database.
|
||||
*
|
||||
* Creates a new user with just the username, password, and email. For a more
|
||||
* detail creation of a user, use wp_insert_user() to specify more infomation.
|
||||
* Creates a new user with just the username, password, and email. For more
|
||||
* complex user creation use wp_insert_user() to specify more information.
|
||||
*
|
||||
* @since 2.0.0
|
||||
* @see wp_insert_user() More complete way to create a new user
|
||||
|
||||
@ -139,7 +139,7 @@ class WP_Widget {
|
||||
}
|
||||
|
||||
if ( $empty ) {
|
||||
// If there are none, we register the widget's existance with a
|
||||
// If there are none, we register the widget's existence with a
|
||||
// generic template
|
||||
$this->_set(1);
|
||||
$this->_register_one();
|
||||
@ -297,7 +297,7 @@ class WP_Widget {
|
||||
$settings = array();
|
||||
|
||||
if ( !array_key_exists('_multiwidget', $settings) ) {
|
||||
// old format, conver if single widget
|
||||
// old format, convert if single widget
|
||||
$settings = wp_convert_widget_settings($this->id_base, $this->option_name, $settings);
|
||||
}
|
||||
|
||||
@ -461,7 +461,7 @@ function unregister_widget($widget_class) {
|
||||
* The default for the name is "Sidebar #", with '#' being replaced with the
|
||||
* number the sidebar is currently when greater than one. If first sidebar, the
|
||||
* name will be just "Sidebar". The default for id is "sidebar-" followed by the
|
||||
* number the sidebar creation is currently at. If the id is provided, and mutliple
|
||||
* number the sidebar creation is currently at. If the id is provided, and multiple
|
||||
* sidebars are being defined, the id will have "-2" appended, and so on.
|
||||
*
|
||||
* @since 2.2.0
|
||||
|
||||
@ -640,7 +640,7 @@ class wpdb {
|
||||
* Returns an array of WordPress tables.
|
||||
*
|
||||
* Also allows for the CUSTOM_USER_TABLE and CUSTOM_USER_META_TABLE to
|
||||
* override the WordPress users and usersmeta tables that would otherwise
|
||||
* override the WordPress users and usermeta tables that would otherwise
|
||||
* be determined by the prefix.
|
||||
*
|
||||
* The scope argument can take one of the following:
|
||||
@ -1289,7 +1289,7 @@ class wpdb {
|
||||
* @param string $output Optional. one of ARRAY_A | ARRAY_N | OBJECT constants. Return an associative array (column => value, ...),
|
||||
* a numerically indexed array (0 => value, ...) or an object ( ->column = value ), respectively.
|
||||
* @param int $y Optional. Row to return. Indexed from 0.
|
||||
* @return mixed Database query result in format specifed by $output or null on failure
|
||||
* @return mixed Database query result in format specified by $output or null on failure
|
||||
*/
|
||||
function get_row( $query = null, $output = OBJECT, $y = 0 ) {
|
||||
$this->func_call = "\$db->get_row(\"$query\",$output,$y)";
|
||||
|
||||
Loading…
Reference in New Issue
Block a user