Skip to content

Docs: Add missing inline doc descriptions in wp-admin/includes/misc.php #11326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
meravi wants to merge 2 commits into from
+10 −7
Closed

Docs: Add missing inline doc descriptions in wp-admin/includes/misc.php #11326

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f65b88a
Docs: Add missing inline doc description for wp_doc_link_parse()
meravi Mar 20, 2026
3f4922c
Docs: Add missing inline doc descriptions in wp-admin/includes/misc.php
meravi Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions src/wp-admin/includes/misc.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@
*
* @since 1.5.0
*
* @param string $file
* @param string $file Path to the recently edited file.

Check failure on line 337 in src/wp-admin/includes/misc.php

View workflow job for this annotation

GitHub Actions / Coding standards / PHP checks 

Whitespace found at end of line
*/
function update_recently_edited( $file ) {
$oldfiles = (array) get_option( 'recently_edited' );
Expand Down Expand Up @@ -563,8 +563,8 @@
*
* @since 2.1.0
*
* @param string $old_value
* @param string $value
* @param string $old_value The old value of the option.
* @param string $value The new value of the option.
*/
function update_home_siteurl( $old_value, $value ) {
if ( wp_installing() ) {
Expand Down Expand Up @@ -608,7 +608,7 @@
*
* @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 ) {
if ( is_wp_error( $message ) ) {
Expand All @@ -625,9 +625,11 @@
}

/**
* 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.
*/
function wp_doc_link_parse( $content ) {
Expand Down Expand Up @@ -978,8 +980,8 @@
*
* @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
$config = $doc->saveXML();
Expand Down Expand Up @@ -1055,6 +1057,7 @@
}

/**
* Outputs the JavaScript for the admin color scheme settings.
*
* @since 3.8.0
*
Expand Down
Loading