Docs: Further type corrections and improvements for various docblocks.

See #53399

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


git-svn-id: http://core.svn.wordpress.org/trunk@50911 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2021-07-01 22:02:57 +00:00
parent e4cfebe92e
commit ec4eb88e0f
6 changed files with 26 additions and 13 deletions

View File

@ -373,11 +373,11 @@ function wp_save_image_file( $filename, $image, $mime_type, $post_id ) {
* @since 2.9.0 * @since 2.9.0
* @deprecated 3.5.0 Use {@see 'wp_save_image_editor_file'} instead. * @deprecated 3.5.0 Use {@see 'wp_save_image_editor_file'} instead.
* *
* @param mixed $override Value to return instead of saving. Default null. * @param bool|null $override Value to return instead of saving. Default null.
* @param string $filename Name of the file to be saved. * @param string $filename Name of the file to be saved.
* @param WP_Image_Editor $image The image editor instance. * @param resource|GdImage $image The image editor instance.
* @param string $mime_type The mime type of the image. * @param string $mime_type The mime type of the image.
* @param int $post_id Attachment post ID. * @param int $post_id Attachment post ID.
*/ */
$saved = apply_filters_deprecated( $saved = apply_filters_deprecated(
'wp_save_image_file', 'wp_save_image_file',

View File

@ -715,7 +715,7 @@ function get_upload_iframe_src( $type = null, $post_id = null, $tab = null ) {
* *
* @since 2.5.0 * @since 2.5.0
* *
* @return mixed void|object WP_Error on failure * @return null|array|void Array of error messages keyed by attachment ID, null or void on success.
*/ */
function media_upload_form_handler() { function media_upload_form_handler() {
check_admin_referer( 'media-form' ); check_admin_referer( 'media-form' );

View File

@ -978,7 +978,7 @@ function delete_meta( $mid ) {
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @return mixed * @return string[] Array of meta key names.
*/ */
function get_meta_keys() { function get_meta_keys() {
global $wpdb; global $wpdb;
@ -1013,8 +1013,19 @@ function get_post_meta_by_id( $mid ) {
* *
* @global wpdb $wpdb WordPress database abstraction object. * @global wpdb $wpdb WordPress database abstraction object.
* *
* @param int $postid * @param int $postid A post ID.
* @return mixed * @return array {
* Array of meta data arrays for the given post ID.
*
* @type array ...$0 {
* Associative array of meta data.
*
* @type string $meta_key Meta key.
* @type mixed $meta_value Meta value.
* @type string $meta_id Meta ID as a numeric string.
* @type string $post_id Post ID as a numeric string.
* }
* }
*/ */
function has_meta( $postid ) { function has_meta( $postid ) {
global $wpdb; global $wpdb;

View File

@ -19,7 +19,7 @@
* *
* @param int|string $cat_name Category name. * @param int|string $cat_name Category name.
* @param int $parent Optional. ID of parent term. * @param int $parent Optional. ID of parent term.
* @return mixed * @return string|null Returns the category ID as a numeric string if the pairing exists, null if not.
*/ */
function category_exists( $cat_name, $parent = null ) { function category_exists( $cat_name, $parent = null ) {
$id = term_exists( $cat_name, 'category', $parent ); $id = term_exists( $cat_name, 'category', $parent );
@ -215,7 +215,9 @@ function wp_update_category( $catarr ) {
* @since 2.3.0 * @since 2.3.0
* *
* @param int|string $tag_name * @param int|string $tag_name
* @return mixed * @return mixed Returns null if the term does not exist.
* Returns an array of the term ID and the term taxonomy ID if the pairing exists.
* Returns 0 if term ID 0 is passed to the function.
*/ */
function tag_exists( $tag_name ) { function tag_exists( $tag_name ) {
return term_exists( $tag_name, 'post_tag' ); return term_exists( $tag_name, 'post_tag' );

View File

@ -50,7 +50,7 @@ class WP_REST_Search_Controller extends WP_REST_Controller {
* Search handlers used by the controller. * Search handlers used by the controller.
* *
* @since 5.0.0 * @since 5.0.0
* @var array * @var WP_REST_Search_Handler[]
*/ */
protected $search_handlers = array(); protected $search_handlers = array();

View File

@ -13,7 +13,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.9-alpha-51301'; $wp_version = '5.9-alpha-51302';
/** /**
* 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.