Docs: Correct various docblocks documentation.

See #48303
Built from https://develop.svn.wordpress.org/trunk@46821


git-svn-id: http://core.svn.wordpress.org/trunk@46621 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2019-12-06 22:23:04 +00:00
parent 7d84502589
commit aa1fdcbd52
12 changed files with 23 additions and 24 deletions

View File

@ -580,7 +580,7 @@ class WP_List_Table {
* *
* @since 3.7.0 * @since 3.7.0
* *
* @param object $months The months drop-down query results. * @param object[] $months Array of the months drop-down query results.
* @param string $post_type The post type. * @param string $post_type The post type.
*/ */
$months = apply_filters( 'months_dropdown_results', $months, $post_type ); $months = apply_filters( 'months_dropdown_results', $months, $post_type );

View File

@ -219,7 +219,7 @@ function wp_nav_menu_post_type_meta_boxes() {
* *
* @since 3.0.0 * @since 3.0.0
* *
* @param object $meta_box_object The current object to add a menu items * @param WP_Post_Type|false $post_type The current object to add a menu items
* meta box for. * meta box for.
*/ */
$post_type = apply_filters( 'nav_menu_meta_box_object', $post_type ); $post_type = apply_filters( 'nav_menu_meta_box_object', $post_type );

View File

@ -104,7 +104,7 @@ else :
* @since MU (3.0.0) * @since MU (3.0.0)
* *
* @param string $settings_html The settings HTML markup. Default empty. * @param string $settings_html The settings HTML markup. Default empty.
* @param object $context Context of the setting (global or site-specific). Default 'global'. * @param string $context Context of the setting (global or site-specific). Default 'global'.
*/ */
$settings_html = apply_filters( 'myblogs_options', '', 'global' ); $settings_html = apply_filters( 'myblogs_options', '', 'global' );
if ( $settings_html != '' ) { if ( $settings_html != '' ) {

View File

@ -4569,7 +4569,7 @@ final class WP_Customize_Manager {
* *
* @since 4.7.0 * @since 4.7.0
* *
* @returns array Allowed URLs. * @return array Allowed URLs.
*/ */
public function get_allowed_urls() { public function get_allowed_urls() {
$allowed_urls = array( home_url( '/' ) ); $allowed_urls = array( home_url( '/' ) );
@ -5700,7 +5700,7 @@ final class WP_Customize_Manager {
* *
* @since 4.7.0 * @since 4.7.0
* *
* @returns bool Whether there are published (or to be published) pages. * @return bool Whether there are published (or to be published) pages.
*/ */
public function has_published_pages() { public function has_published_pages() {

View File

@ -1282,7 +1282,7 @@ final class WP_Customize_Nav_Menus {
* @since 4.7.0 * @since 4.7.0
* *
* @param array $value Post IDs. * @param array $value Post IDs.
* @returns array Post IDs. * @return array Post IDs.
*/ */
public function sanitize_nav_menus_created_posts( $value ) { public function sanitize_nav_menus_created_posts( $value ) {
$post_ids = array(); $post_ids = array();

View File

@ -1719,7 +1719,7 @@ function get_comment_reply_link( $args = array(), $comment = null, $post = null
* *
* @param string $link The HTML markup for the comment reply link. * @param string $link The HTML markup for the comment reply link.
* @param array $args An array of arguments overriding the defaults. * @param array $args An array of arguments overriding the defaults.
* @param object $comment The object of the comment being replied. * @param WP_Comment $comment The object of the comment being replied.
* @param WP_Post $post The WP_Post object. * @param WP_Post $post The WP_Post object.
*/ */
return apply_filters( 'comment_reply_link', $args['before'] . $link . $args['after'], $args, $comment, $post ); return apply_filters( 'comment_reply_link', $args['before'] . $link . $args['after'], $args, $comment, $post );
@ -1733,7 +1733,7 @@ function get_comment_reply_link( $args = array(), $comment = null, $post = null
* @see get_comment_reply_link() * @see get_comment_reply_link()
* *
* @param array $args Optional. Override default options. * @param array $args Optional. Override default options.
* @param int $comment Comment being replied to. Default current comment. * @param int|WP_Comment $comment Comment being replied to. Default current comment.
* @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on. * @param int|WP_Post $post Post ID or WP_Post object the comment is going to be displayed on.
* Default current post. * Default current post.
*/ */

View File

@ -299,7 +299,7 @@ class WP_Customize_Nav_Menu_Item_Setting extends WP_Customize_Setting {
* @since 4.7.0 * @since 4.7.0
* *
* @param object $item Nav menu item. * @param object $item Nav menu item.
* @returns string The type label. * @return string The type label.
*/ */
protected function get_type_label( $item ) { protected function get_type_label( $item ) {
if ( 'post_type' === $item->type ) { if ( 'post_type' === $item->type ) {

View File

@ -179,7 +179,7 @@ class WP_REST_Taxonomies_Controller extends WP_REST_Controller {
* *
* @since 4.7.0 * @since 4.7.0
* *
* @param stdClass $taxonomy Taxonomy data. * @param WP_Taxonomy $taxonomy Taxonomy data.
* @param WP_REST_Request $request Full details about the request. * @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response Response object. * @return WP_REST_Response Response object.
*/ */
@ -262,7 +262,7 @@ class WP_REST_Taxonomies_Controller extends WP_REST_Controller {
* @since 4.7.0 * @since 4.7.0
* *
* @param WP_REST_Response $response The response object. * @param WP_REST_Response $response The response object.
* @param object $item The original taxonomy object. * @param WP_Taxonomy $item The original taxonomy object.
* @param WP_REST_Request $request Request used to generate the response. * @param WP_REST_Request $request Request used to generate the response.
*/ */
return apply_filters( 'rest_prepare_taxonomy', $response, $taxonomy, $request ); return apply_filters( 'rest_prepare_taxonomy', $response, $taxonomy, $request );

View File

@ -444,7 +444,7 @@ function wp_delete_post_revision( $revision_id ) {
* @since 2.6.0 * @since 2.6.0
* *
* @param int $revision_id Post revision ID. * @param int $revision_id Post revision ID.
* @param object|array $revision Post revision object or array. * @param WP_Post $revision Post revision object.
*/ */
do_action( 'wp_delete_post_revision', $revision->ID, $revision ); do_action( 'wp_delete_post_revision', $revision->ID, $revision );
} }

View File

@ -3144,7 +3144,7 @@ function _wp_customize_publish_changeset( $new_status, $old_status, $changeset_p
* *
* @param array $post_data An array of slashed post data. * @param array $post_data An array of slashed post data.
* @param array $supplied_post_data An array of sanitized, but otherwise unmodified post data. * @param array $supplied_post_data An array of sanitized, but otherwise unmodified post data.
* @returns array Filtered data. * @return array Filtered data.
*/ */
function _wp_customize_changeset_filter_insert_post_data( $post_data, $supplied_post_data ) { function _wp_customize_changeset_filter_insert_post_data( $post_data, $supplied_post_data ) {
if ( isset( $post_data['post_type'] ) && 'customize_changeset' === $post_data['post_type'] ) { if ( isset( $post_data['post_type'] ) && 'customize_changeset' === $post_data['post_type'] ) {

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.4-alpha-46820'; $wp_version = '5.4-alpha-46821';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

View File

@ -239,7 +239,6 @@ class WP_Widget_Custom_HTML extends WP_Widget {
* *
* @see WP_Widget_Custom_HTML::render_control_template_scripts() * @see WP_Widget_Custom_HTML::render_control_template_scripts()
* @param array $instance Current instance. * @param array $instance Current instance.
* @returns void
*/ */
public function form( $instance ) { public function form( $instance ) {
$instance = wp_parse_args( (array) $instance, $this->default_instance ); $instance = wp_parse_args( (array) $instance, $this->default_instance );