Changeset 54883 for trunk/src/wp-admin/includes/template.php

Timestamp:

11/26/2022 10:16:27 PM (2 years ago)

Author:

audrasjb

Message:

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

Props mahekkalola, costdev, audrasjb, riccardodicurti.
Fixes #57208.
See #56792.

File:

• trunk/src/wp-admin/includes/template.php (modified) (5 diffs)

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

@@ -261 +261 @@
  * @since 2.5.1
  *
- * @param int $link_id
+ * @param int $link_id Optional. The link ID. Default 0.
  */
 function wp_link_category_checklist( $link_id = 0 ) {
@@ -403 +403 @@
  * @global WP_List_Table $wp_list_table
  *
- * @param int    $position
- * @param bool   $checkbox
- * @param string $mode
- * @param bool   $table_row
+ * @param int    $position  Optional. The value of the 'position' input field. Default 1.
+ * @param bool   $checkbox  Optional. The value of the 'checkbox' input field. Default false.
+ * @param string $mode      Optional. If set to 'single', will use WP_Post_Comments_List_Table,
+ *                          otherwise WP_Comments_List_Table. Default 'single'.
+ * @param bool   $table_row Optional. Whether to use a table instead of a div element. Default true.
  */
 function wp_comment_reply( $position = 1, $checkbox = false, $mode = 'single', $table_row = true ) {
@@ -566 +567 @@
  * @since 1.2.0
  *
- * @param array $meta
+ * @param array[] $meta An array of meta data arrays keyed on 'meta_key' and 'meta_value'.
  */
 function list_meta( $meta ) {
@@ -610 +611 @@
  * @since 2.5.0
  *
- * @param array $entry
- * @param int   $count
- * @return string
+ * @param array $entry An array of meta data keyed on 'meta_key' and 'meta_value'.
+ * @param int   $count Reference to the row number.
+ * @return string A single row of public meta data.
  */
 function _list_meta_row( $entry, &$count ) {
@@ -1970 +1971 @@
  * @since 2.7.0
  *
- * @param string $found_action
+ * @param string $found_action Optional. The value of the 'found_action' input field. Default empty string.
  */
 function find_posts_div( $found_action = '' ) {