Skip to content

Commit 2629cd9

Browse files
docs: Add missing parameter descriptions to docblocks
1 parent d676a07 commit 2629cd9

File tree

5 files changed

+13
-11
lines changed

5 files changed

+13
-11
lines changed

src/wp-admin/includes/ajax-actions.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -454,8 +454,8 @@ function wp_ajax_logged_in() {
454454
* @since 2.7.0
455455
* @access private
456456
*
457-
* @param int $comment_id
458-
* @param int $delta
457+
* @param int $comment_id Comment ID.
458+
* @param int $delta Change in the number of total comments. Default -1.
459459
*/
460460
function _wp_ajax_delete_comment_response( $comment_id, $delta = -1 ) {
461461
$total = isset( $_POST['_total'] ) ? (int) $_POST['_total'] : 0;

src/wp-admin/includes/class-wp-importer.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -289,9 +289,9 @@ public function stop_the_insanity() {
289289
* Returns value of command line params.
290290
* Exits when a required param is not set.
291291
*
292-
* @param string $param
293-
* @param bool $required
294-
* @return mixed
292+
* @param string $param The parameter name to retrieve.
293+
* @param bool $required Whether the parameter is required. Default false.
294+
* @return mixed The parameter value if found, null otherwise.
295295
*/
296296
function get_cli_args( $param, $required = false ) {
297297
$args = $_SERVER['argv'];

src/wp-admin/install.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
*
5353
* @since 2.5.0
5454
*
55-
* @param string $body_classes
55+
* @param string $body_classes CSS classes to add to the body tag.
5656
*/
5757
function display_header( $body_classes = '' ) {
5858
header( 'Content-Type: text/html; charset=utf-8' );
@@ -85,7 +85,7 @@ function display_header( $body_classes = '' ) {
8585
*
8686
* @global wpdb $wpdb WordPress database abstraction object.
8787
*
88-
* @param string|null $error
88+
* @param string|null $error Error message to display, if any.
8989
*/
9090
function display_setup_form( $error = null ) {
9191
global $wpdb;

src/wp-admin/nav-menus.php

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -672,12 +672,14 @@
672672
}
673673

674674
/**
675+
* Adds a CSS class to display the max depth of the navigation menu.
676+
*
675677
* @since 3.0.0
676678
*
677-
* @global int $_wp_nav_menu_max_depth
679+
* @global int $_wp_nav_menu_max_depth Maximum depth of the navigation menu.
678680
*
679-
* @param string $classes
680-
* @return string
681+
* @param string $classes Existing CSS classes for the body tag.
682+
* @return string Modified CSS classes including the menu max depth class.
681683
*/
682684
function wp_nav_menu_max_depth( $classes ) {
683685
global $_wp_nav_menu_max_depth;

src/wp-admin/update-core.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -840,7 +840,7 @@ function list_translation_updates() {
840840
*
841841
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
842842
*
843-
* @param bool $reinstall
843+
* @param bool $reinstall Optional. Whether to reinstall WordPress. Default false.
844844
*/
845845
function do_core_upgrade( $reinstall = false ) {
846846
global $wp_filesystem;

0 commit comments

Comments
 (0)