Docs: Further corrections and promotions for docblocks relating to `object` types.

See #50768

Built from https://develop.svn.wordpress.org/trunk@49197


git-svn-id: http://core.svn.wordpress.org/trunk@48959 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2020-10-18 20:53:08 +00:00
parent b2515abd45
commit 727922c8eb
11 changed files with 30 additions and 30 deletions

View File

@ -62,11 +62,11 @@ class Walker_Category_Checklist extends Walker {
*
* @since 2.5.1
*
* @param string $output Used to append additional content (passed by reference).
* @param object $category The current term object.
* @param int $depth Depth of the term in reference to parents. Default 0.
* @param array $args An array of arguments. @see wp_terms_checklist()
* @param int $id ID of the current term.
* @param string $output Used to append additional content (passed by reference).
* @param WP_Term $category The current term object.
* @param int $depth Depth of the term in reference to parents. Default 0.
* @param array $args An array of arguments. @see wp_terms_checklist()
* @param int $id ID of the current term.
*/
public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
if ( empty( $args['taxonomy'] ) ) {
@ -121,10 +121,10 @@ class Walker_Category_Checklist extends Walker {
*
* @since 2.5.1
*
* @param string $output Used to append additional content (passed by reference).
* @param object $category The current term object.
* @param int $depth Depth of the term in reference to parents. Default 0.
* @param array $args An array of arguments. @see wp_terms_checklist()
* @param string $output Used to append additional content (passed by reference).
* @param WP_Term $category The current term object.
* @param int $depth Depth of the term in reference to parents. Default 0.
* @param array $args An array of arguments. @see wp_terms_checklist()
*/
public function end_el( &$output, $category, $depth = 0, $args = array() ) {
$output .= "</li>\n";

View File

@ -163,7 +163,7 @@ class WP_Application_Passwords_List_Table extends WP_List_Table {
*
* @since 5.6.0
*
* @param object $item The current item.
* @param array $item The current item.
*/
public function single_row( $item ) {
echo '<tr data-uuid="' . esc_attr( $item['uuid'] ) . '">';

View File

@ -1372,7 +1372,7 @@ class WP_List_Table {
*
* @since 3.1.0
*
* @param object $item The current item
* @param object|array $item The current item
*/
public function single_row( $item ) {
echo '<tr>';
@ -1381,13 +1381,13 @@ class WP_List_Table {
}
/**
* @param object $item
* @param object|array $item
* @param string $column_name
*/
protected function column_default( $item, $column_name ) {}
/**
* @param object $item
* @param object|array $item
*/
protected function column_cb( $item ) {}
@ -1396,7 +1396,7 @@ class WP_List_Table {
*
* @since 3.1.0
*
* @param object $item The current item.
* @param object|array $item The current item.
*/
protected function single_row_columns( $item ) {
list( $columns, $hidden, $sortable, $primary ) = $this->get_column_info();
@ -1448,9 +1448,9 @@ class WP_List_Table {
*
* @since 4.3.0
*
* @param object $item The item being acted upon.
* @param string $column_name Current column name.
* @param string $primary Primary column name.
* @param object|array $item The item being acted upon.
* @param string $column_name Current column name.
* @param string $primary Primary column name.
* @return string The row actions HTML, or an empty string
* if the current column is not the primary column.
*/

View File

@ -664,7 +664,7 @@ class WP_MS_Sites_List_Table extends WP_List_Table {
*
* @since 4.3.0
*
* @param object $blog Site being acted upon.
* @param array $blog Site being acted upon.
* @param string $column_name Current column name.
* @param string $primary Primary column name.
* @return string Row actions output for sites in Multisite, or an empty string

View File

@ -1085,7 +1085,7 @@ function _media_button($title, $icon, $type, $id) {
* @see get_post()
*
* @param int $id
* @return object
* @return WP_Post
*/
function get_post_to_edit( $id ) {
_deprecated_function( __FUNCTION__, '3.5.0', 'get_post()' );

View File

@ -489,8 +489,8 @@ function default_password_nag_handler( $errors = false ) {
/**
* @since 2.8.0
*
* @param int $user_ID
* @param object $old_data
* @param int $user_ID
* @param WP_User $old_data
*/
function default_password_nag_edit_user( $user_ID, $old_data ) {
// Short-circuit it.

View File

@ -1303,7 +1303,7 @@ function get_category_children( $id, $before = '/', $after = '', $visited = arra
*
* @link https://developer.wordpress.org/reference/functions/get_all_category_ids/
*
* @return object List of all of the category IDs.
* @return int[] List of all of the category IDs.
*/
function get_all_category_ids() {
_deprecated_function( __FUNCTION__, '4.0.0', 'get_terms()' );

View File

@ -517,8 +517,8 @@ function ms_not_installed( $domain, $path ) {
* @since 3.0.0
* @deprecated 3.9.0 Use get_current_site() instead.
*
* @param object $current_site
* @return object
* @param WP_Network $current_site
* @return WP_Network
*/
function get_current_site_name( $current_site ) {
_deprecated_function( __FUNCTION__, '3.9.0', 'get_current_site()' );
@ -535,9 +535,9 @@ function get_current_site_name( $current_site ) {
* @since 3.0.0
* @deprecated 3.9.0
*
* @global object $current_site
* @global WP_Network $current_site
*
* @return object
* @return WP_Network
*/
function wpmu_current_site() {
global $current_site;

View File

@ -37,7 +37,7 @@ function get_query_var( $var, $default = '' ) {
*
* @global WP_Query $wp_query WordPress Query object.
*
* @return object Queried object.
* @return WP_Term|WP_Post_Type|WP_Post|WP_User|null The queried object.
*/
function get_queried_object() {
global $wp_query;
@ -996,7 +996,7 @@ function have_comments() {
*
* @global WP_Query $wp_query WordPress Query object.
*
* @return object
* @return null
*/
function the_comment() {
global $wp_query;

View File

@ -1526,7 +1526,7 @@ function sanitize_user_field( $field, $value, $user_id, $context ) {
*
* @since 3.0.0
*
* @param WP_User $user User object to be cached
* @param object|WP_User $user User object or database row to be cached
* @return bool|null Returns false on failure.
*/
function update_user_caches( $user ) {

View File

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