Changeset 61594 for trunk/src/wp-admin/includes/update.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/update.php (modified) (11 diffs)

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

@@ -35 +35 @@
  * @param array $options Set $options['dismissed'] to true to show dismissed upgrades too,
  *                       set $options['available'] to false to skip not-dismissed updates.
- * @return array|false Array of the update objects on success, false on failure.
+ * @return array<object>|false Array of the update objects on success, false on failure.
  */
 function get_core_updates( $options = array() ) {
@@ -127 +127 @@
  * @param string $version Version string to query.
  * @param string $locale  Locale to query.
- * @return array|false An array of checksums on success, false on failure.
+ * @return array<string, string>|false An array of checksums on success, false on failure.
  */
 function get_core_checksums( $version, $locale ) {
@@ -179 +179 @@
  *
  * @param object $update
- * @return bool
+ * @return bool True if the option was updated, false otherwise.
  */
 function dismiss_core_update( $update ) {
@@ -195 +195 @@
  * @param string $version
  * @param string $locale
- * @return bool
+ * @return bool True if the option was updated, false otherwise.
  */
 function undismiss_core_update( $version, $locale ) {
@@ -243 +243 @@
  *
  * @param string $msg
- * @return string
+ * @return string The core update footer message.
  */
 function core_update_footer( $msg = '' ) {
@@ -298 +298 @@
  *
  * @global string $pagenow The filename of the current screen.
- * @return void|false
+ * @return void|false Void on success, false if the update nag should not be displayed.
  */
 function update_nag() {
@@ -402 +402 @@
  * @since 2.9.0
  *
- * @return object[]
+ * @return array<string, object> Array of plugin objects with available updates.
  */
 function get_plugin_updates() {
@@ -447 +447 @@
  * @param string $file        Plugin basename.
  * @param array  $plugin_data Plugin information.
- * @return void|false
+ * @return void|false Void on success, false if the plugin update is not available.
  */
 function wp_plugin_update_row( $file, $plugin_data ) {
@@ -625 +625 @@
  * @since 2.9.0
  *
- * @return WP_Theme[]
+ * @return array<string, WP_Theme> Array of theme objects with available updates.
  */
 function get_theme_updates() {
@@ -672 +672 @@
  * @param string   $theme_key Theme stylesheet.
  * @param WP_Theme $theme     Theme object.
- * @return void|false
+ * @return void|false Void on success, false if the theme update is not available.
  */
 function wp_theme_update_row( $theme_key, $theme ) {
@@ -849 +849 @@
  * @global int $upgrading
  *
- * @return void|false
+ * @return void|false Void on success, false if the maintenance nag should not be displayed.
  */
 function maintenance_nag() {