Skip to content

Commit 5bbce56

Browse files
Docs: Add missing parameter descriptions in wp-admin/includes/misc.php.
Props ravikhadka. Fixes #64920. git-svn-id: https://develop.svn.wordpress.org/trunk@62088 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 4a43c27 commit 5bbce56

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

src/wp-admin/includes/misc.php

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ function iis7_save_url_rewrite_rules() {
334334
*
335335
* @since 1.5.0
336336
*
337-
* @param string $file
337+
* @param string $file Path to the recently edited file.
338338
*/
339339
function update_recently_edited( $file ) {
340340
$oldfiles = (array) get_option( 'recently_edited' );
@@ -563,8 +563,8 @@ function wp_print_plugin_file_tree( $tree, $label = '', $level = 2, $size = 1, $
563563
*
564564
* @since 2.1.0
565565
*
566-
* @param string $old_value
567-
* @param string $value
566+
* @param string $old_value The old value of the option. Unused.
567+
* @param string $value The new value of the option. Unused.
568568
*/
569569
function update_home_siteurl( $old_value, $value ) {
570570
if ( wp_installing() ) {
@@ -608,7 +608,7 @@ function wp_reset_vars( $vars ) {
608608
*
609609
* @since 2.1.0
610610
*
611-
* @param string|WP_Error $message
611+
* @param string|WP_Error $message The message to display, or a WP_Error object.
612612
*/
613613
function show_message( $message ) {
614614
if ( is_wp_error( $message ) ) {
@@ -625,9 +625,11 @@ function show_message( $message ) {
625625
}
626626

627627
/**
628+
* Parses the PHP content and finds function calls to be used for documentation linking.
629+
*
628630
* @since 2.8.0
629631
*
630-
* @param string $content
632+
* @param string $content The PHP content to parse.
631633
* @return string[] Array of function names.
632634
*/
633635
function wp_doc_link_parse( $content ) {
@@ -978,8 +980,8 @@ function iis7_add_rewrite_rule( $filename, $rewrite_rule ) {
978980
*
979981
* @since 2.8.0
980982
*
981-
* @param DOMDocument $doc
982-
* @param string $filename
983+
* @param DOMDocument $doc The DOMDocument object to save.
984+
* @param string $filename The file path to save the XML document to.
983985
*/
984986
function saveDomDocument( $doc, $filename ) { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
985987
$config = $doc->saveXML();
@@ -1055,6 +1057,7 @@ function admin_color_scheme_picker( $user_id ) {
10551057
}
10561058

10571059
/**
1060+
* Outputs the JavaScript for the admin color scheme settings.
10581061
*
10591062
* @since 3.8.0
10601063
*

0 commit comments

Comments
 (0)