Changeset 61594 for trunk/src/wp-admin/includes/media.php

Timestamp:

02/07/2026 06:05:09 AM (4 months ago)

Author:

westonruter

Message:

Docs: Add descriptions and improved typing to @return tags in various admin and includes files.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/10863

Props huzaifaalmesbah, westonruter, noruzzaman, mukesh27.
See #64224.

File:

• trunk/src/wp-admin/includes/media.php (modified) (10 diffs)

trunk/src/wp-admin/includes/media.php

@@ -869 +869 @@
  * @since 2.5.0
  *
- * @return null|string
+ * @return null|string The form handler result or null.
  */
 function wp_media_upload_handler() {
@@ -1097 +1097 @@
  * @since 2.5.0
  *
- * @return string|null
+ * @return string|null The form handler result or null.
  */
 function media_upload_gallery() {
@@ -1123 +1123 @@
  * @since 2.5.0
  *
- * @return string|null
+ * @return string|null The form handler result or null.
  */
 function media_upload_library() {
@@ -1149 +1149 @@
  * @param WP_Post $post
  * @param string  $checked
- * @return string
+ * @return string HTML for the image alignment radio buttons.
  */
 function image_align_input_fields( $post, $checked = '' ) {
@@ -1187 +1187 @@
  * @param WP_Post     $post
  * @param bool|string $check
- * @return array
+ * @return array<string, string> An array of data for the image size input fields.
  */
 function image_size_input_fields( $post, $check = '' ) {
@@ -1265 +1265 @@
  * @param WP_Post $post
  * @param string  $url_type
- * @return string
+ * @return string HTML markup for the link URL buttons.
  */
 function image_link_input_fields( $post, $url_type = '' ) {
@@ -1314 +1314 @@
  * @param array  $form_fields
  * @param object $post
- * @return array
+ * @return array<string, array<string, mixed>> The attachment form fields.
  */
 function image_attachment_fields_to_edit( $form_fields, $post ) {
@@ -1356 +1356 @@
  * @param int     $attachment_id
  * @param array   $attachment
- * @return string
+ * @return string HTML markup for the media element.
  */
 function image_media_send_to_editor( $html, $attachment_id, $attachment ) {
@@ -1381 +1381 @@
  * @param WP_Post $post
  * @param array   $errors
- * @return array
+ * @return array<string, array<string, mixed>> The attachment fields.
  */
 function get_attachment_fields_to_edit( $post, $errors = null ) {
@@ -1866 +1866 @@
 
 /**
+ * Retrieves the media markup for an attachment.
+ *
  * @since 3.5.0
  *
  * @param int   $attachment_id
  * @param array $args
- * @return array
+ * @return array<string, string> An array containing the media item and its metadata.
  */
 function get_compat_media_markup( $attachment_id, $args = null ) {