Changeset 62088

Timestamp:

03/22/2026 10:12:17 PM (5 days ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing parameter descriptions in wp-admin/includes/misc.php.

Props ravikhadka.
Fixes #64920.

File:

• trunk/src/wp-admin/includes/misc.php (modified) (6 diffs)

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

@@ -335 +335 @@
  * @since 1.5.0
  *
- * @param string $file
+ * @param string $file Path to the recently edited file.
  */
 function update_recently_edited( $file ) {
@@ -564 +564 @@
  * @since 2.1.0
  *
- * @param string $old_value
- * @param string $value
+ * @param string $old_value The old value of the option. Unused.
+ * @param string $value     The new value of the option. Unused.
  */
 function update_home_siteurl( $old_value, $value ) {
@@ -609 +609 @@
  * @since 2.1.0
  *
- * @param string|WP_Error $message
+ * @param string|WP_Error $message The message to display, or a WP_Error object.
  */
 function show_message( $message ) {
@@ -626 +626 @@
 
 /**
+ * Parses the PHP content and finds function calls to be used for documentation linking.
+ *
  * @since 2.8.0
  *
- * @param string $content
+ * @param string $content The PHP content to parse.
  * @return string[] Array of function names.
  */
@@ -979 +981 @@
  * @since 2.8.0
  *
- * @param DOMDocument $doc
- * @param string      $filename
+ * @param DOMDocument $doc      The DOMDocument object to save.
+ * @param string      $filename The file path to save the XML document to.
  */
 function saveDomDocument( $doc, $filename ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
@@ -1056 +1058 @@
 
 /**
+ * Outputs the JavaScript for the admin color scheme settings.
  *
  * @since 3.8.0