Docs: Further docblock corrections and improvements.

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


git-svn-id: http://core.svn.wordpress.org/trunk@46626 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2019-12-07 13:23:01 +00:00
parent 0f971e68ec
commit d53103ed62
5 changed files with 9 additions and 9 deletions

View File

@ -970,7 +970,7 @@ function wp_save_nav_menu_items( $menu_id = 0, $menu_data = array() ) {
* @access private * @access private
* *
* @param object $object The post type or taxonomy meta-object. * @param object $object The post type or taxonomy meta-object.
* @return object The post type of taxonomy object. * @return object The post type or taxonomy object.
*/ */
function _wp_nav_menu_meta_box_object( $object = null ) { function _wp_nav_menu_meta_box_object( $object = null ) {
if ( isset( $object->name ) ) { if ( isset( $object->name ) ) {

View File

@ -15,7 +15,7 @@
* *
* @param bool $update Are we updating a pre-existing post? * @param bool $update Are we updating a pre-existing post?
* @param array $post_data Array of post data. Defaults to the contents of $_POST. * @param array $post_data Array of post data. Defaults to the contents of $_POST.
* @return object|bool WP_Error on failure, true on success. * @return array|WP_Error Array of post data on success, WP_Error on failure.
*/ */
function _wp_translate_postdata( $update = false, $post_data = null ) { function _wp_translate_postdata( $update = false, $post_data = null ) {
@ -201,7 +201,7 @@ function _wp_translate_postdata( $update = false, $post_data = null ) {
* @since 5.0.1 * @since 5.0.1
* *
* @param array $post_data Array of post data. Defaults to the contents of $_POST. * @param array $post_data Array of post data. Defaults to the contents of $_POST.
* @return object|bool WP_Error on failure, true on success. * @return array|WP_Error Array of post data on success, WP_Error on failure.
*/ */
function _wp_get_allowed_postdata( $post_data = null ) { function _wp_get_allowed_postdata( $post_data = null ) {
if ( empty( $post_data ) ) { if ( empty( $post_data ) ) {

View File

@ -48,7 +48,7 @@ function get_column_headers( $screen ) {
* @since 2.7.0 * @since 2.7.0
* *
* @param string|WP_Screen $screen The screen you want the hidden columns for * @param string|WP_Screen $screen The screen you want the hidden columns for
* @return array * @return string[] Array of IDs of hidden columns.
*/ */
function get_hidden_columns( $screen ) { function get_hidden_columns( $screen ) {
if ( is_string( $screen ) ) { if ( is_string( $screen ) ) {
@ -67,7 +67,7 @@ function get_hidden_columns( $screen ) {
* *
* @since 4.4.0 * @since 4.4.0
* *
* @param array $hidden An array of columns hidden by default. * @param string[] $hidden Array of IDs of columns hidden by default.
* @param WP_Screen $screen WP_Screen object of the current screen. * @param WP_Screen $screen WP_Screen object of the current screen.
*/ */
$hidden = apply_filters( 'default_hidden_columns', $hidden, $screen ); $hidden = apply_filters( 'default_hidden_columns', $hidden, $screen );
@ -79,8 +79,8 @@ function get_hidden_columns( $screen ) {
* @since 4.4.0 * @since 4.4.0
* @since 4.4.1 Added the `use_defaults` parameter. * @since 4.4.1 Added the `use_defaults` parameter.
* *
* @param array $hidden An array of hidden columns. * @param string[] $hidden Array of IDs of hidden columns.
* @param WP_Screen $screen WP_Screen object of the current screen. * @param WP_Screen $screen WP_Screen object of the current screen.
* @param bool $use_defaults Whether to show the default columns. * @param bool $use_defaults Whether to show the default columns.
*/ */
return apply_filters( 'hidden_columns', $hidden, $screen, $use_defaults ); return apply_filters( 'hidden_columns', $hidden, $screen, $use_defaults );

View File

@ -551,7 +551,7 @@ jQuery(document).ready( function($) {
* *
* @since 2.7.0 * @since 2.7.0
* *
* @param object $user User data object. * @param WP_User $user User data object.
*/ */
function use_ssl_preference( $user ) { function use_ssl_preference( $user ) {
?> ?>

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.4-alpha-46824'; $wp_version = '5.4-alpha-46826';
/** /**
* 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.