Docs: Misc corrections and additions to inline documentation.
See #39130 Props keesiemeijer Built from https://develop.svn.wordpress.org/trunk@39639 git-svn-id: http://core.svn.wordpress.org/trunk@39579 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn
parent
d327c92e4b
commit
80a839de13
|
|
@ -718,7 +718,7 @@ function wp_tag_cloud( $args = '' ) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Default topic count scaling for tag links
|
||||
* Default topic count scaling for tag links.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
|
|
|
|||
|
|
@ -5392,7 +5392,7 @@ function wp_delete_file( $file ) {
|
|||
*
|
||||
* @since 2.1.0
|
||||
*
|
||||
* @param string $medium Path to the file to delete.
|
||||
* @param string $file Path to the file to delete.
|
||||
*/
|
||||
$delete = apply_filters( 'wp_delete_file', $file );
|
||||
if ( ! empty( $delete ) ) {
|
||||
|
|
|
|||
|
|
@ -3545,9 +3545,9 @@ function wp_admin_css( $file = 'wp-admin', $force_echo = false ) {
|
|||
* will be used instead.
|
||||
*
|
||||
* @since 2.3.0
|
||||
*
|
||||
* @param string $file Style handle name or filename (without ".css" extension)
|
||||
* relative to wp-admin/. Defaults to 'wp-admin'.
|
||||
* @param string $stylesheet_link HTML link element for the stylesheet.
|
||||
* @param string $file Style handle name or filename (without ".css" extension)
|
||||
* relative to wp-admin/. Defaults to 'wp-admin'.
|
||||
*/
|
||||
echo apply_filters( 'wp_admin_css', "<link rel='stylesheet' href='" . esc_url( wp_admin_css_uri( $file ) ) . "' type='text/css' />\n", $file );
|
||||
|
||||
|
|
|
|||
|
|
@ -846,7 +846,7 @@ function get_term_feed_link( $term_id, $taxonomy = 'category', $feed = '' ) {
|
|||
*
|
||||
* @param string $link The taxonomy feed link.
|
||||
* @param string $feed Feed type.
|
||||
* @param string $feed The taxonomy name.
|
||||
* @param string $taxonomy The taxonomy name.
|
||||
*/
|
||||
$link = apply_filters( 'taxonomy_feed_link', $link, $feed, $taxonomy );
|
||||
}
|
||||
|
|
@ -3583,8 +3583,8 @@ function wp_get_canonical_url( $post = null ) {
|
|||
*
|
||||
* @since 4.6.0
|
||||
*
|
||||
* @param string $string The post's canonical URL.
|
||||
* @param WP_Post $post Post object.
|
||||
* @param string $canonical_url The post's canonical URL.
|
||||
* @param WP_Post $post Post object.
|
||||
*/
|
||||
return apply_filters( 'get_canonical_url', $canonical_url, $post );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -761,7 +761,7 @@ function wp_print_media_templates() {
|
|||
<# } #>
|
||||
>
|
||||
<?php
|
||||
// This filter is documented in wp-admin/includes/media.php
|
||||
/** This filter is documented in wp-admin/includes/media.php */
|
||||
$size_names = apply_filters( 'image_size_names_choose', array(
|
||||
'thumbnail' => __( 'Thumbnail' ),
|
||||
'medium' => __( 'Medium' ),
|
||||
|
|
|
|||
|
|
@ -2240,7 +2240,7 @@ function wp_schedule_update_network_counts() {
|
|||
}
|
||||
|
||||
/**
|
||||
* Update the network-wide counts for the current network.
|
||||
* Update the network-wide counts for the current network.
|
||||
*
|
||||
* @since 3.1.0
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -2412,8 +2412,10 @@ function get_avatar( $id_or_email, $size = 96, $default = '', $alt = '', $args =
|
|||
* @param mixed $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
|
||||
* user email, WP_User object, WP_Post object, or WP_Comment object.
|
||||
* @param int $size Square avatar width and height in pixels to retrieve.
|
||||
* @param string $alt Alternative text to use in the avatar image tag.
|
||||
* Default empty.
|
||||
* @param string $default URL for the default image or a default type. Accepts '404', 'retro', 'monsterid',
|
||||
* 'wavatar', 'indenticon','mystery' (or 'mm', or 'mysteryman'), 'blank', or 'gravatar_default'.
|
||||
* Default is the value of the 'avatar_default' option, with a fallback of 'mystery'.
|
||||
* @param string $alt Alternative text to use in the avatar image tag. Default empty.
|
||||
* @param array $args Arguments passed to get_avatar_data(), after processing.
|
||||
*/
|
||||
return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );
|
||||
|
|
|
|||
|
|
@ -1593,6 +1593,7 @@ class WP_REST_Comments_Controller extends WP_REST_Controller {
|
|||
* string is allowed when a comment is being updated.
|
||||
*
|
||||
* @since 4.7.0
|
||||
* @access public
|
||||
*
|
||||
* @param string $value Author email value submitted.
|
||||
* @param WP_REST_Request $request Full details about the request.
|
||||
|
|
|
|||
|
|
@ -1166,6 +1166,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
|
|||
* Checks whether current user can assign all terms sent with the current request.
|
||||
*
|
||||
* @since 4.7.0
|
||||
* @access protected
|
||||
*
|
||||
* @param WP_REST_Request $request The request object with post and terms data.
|
||||
* @return bool Whether the current user can assign the provided terms.
|
||||
|
|
@ -1519,6 +1520,7 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
|
|||
* in a machine readable format, we remove the "Protected: " prefix.
|
||||
*
|
||||
* @since 4.7.0
|
||||
* @access public
|
||||
*
|
||||
* @return string Protected title format.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -306,6 +306,7 @@ class WP_REST_Settings_Controller extends WP_REST_Controller {
|
|||
* provide a wrapper sanitizer to whitelist the use of `null`.
|
||||
*
|
||||
* @since 4.7.0
|
||||
* @access public
|
||||
*
|
||||
* @param mixed $value The value for the setting.
|
||||
* @param WP_REST_Request $request The request object.
|
||||
|
|
|
|||
|
|
@ -142,6 +142,7 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
|
|||
* The value can be an integer, 'false', false, or ''.
|
||||
*
|
||||
* @since 4.7.0
|
||||
* @access public
|
||||
*
|
||||
* @param int|bool $value The value passed to the reassign parameter.
|
||||
* @param WP_REST_Request $request Full details about the request.
|
||||
|
|
@ -1054,6 +1055,7 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
|
|||
* Performs a couple of checks like edit_user() in wp-admin/includes/user.php.
|
||||
*
|
||||
* @since 4.7.0
|
||||
* @access public
|
||||
*
|
||||
* @param mixed $value The username submitted in the request.
|
||||
* @param WP_REST_Request $request Full details about the request.
|
||||
|
|
@ -1083,6 +1085,7 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
|
|||
* Performs a couple of checks like edit_user() in wp-admin/includes/user.php.
|
||||
*
|
||||
* @since 4.7.0
|
||||
* @access public
|
||||
*
|
||||
* @param mixed $value The password submitted in the request.
|
||||
* @param WP_REST_Request $request Full details about the request.
|
||||
|
|
|
|||
|
|
@ -2943,7 +2943,7 @@ function clean_object_term_cache($object_ids, $object_type) {
|
|||
* @since 2.5.0
|
||||
*
|
||||
* @param array $object_ids An array of object IDs.
|
||||
* @param string $objet_type Object type.
|
||||
* @param string $object_type Object type.
|
||||
*/
|
||||
do_action( 'clean_object_term_cache', $object_ids, $object_type );
|
||||
}
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
*
|
||||
* @global string $wp_version
|
||||
*/
|
||||
$wp_version = '4.8-alpha-39638';
|
||||
$wp_version = '4.8-alpha-39639';
|
||||
|
||||
/**
|
||||
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
|
||||
|
|
|
|||
Loading…
Reference in New Issue