Changeset 59865

Timestamp:

02/24/2025 01:41:07 PM (4 months ago)

Author:

johnbillion

Message:

Docs: Various improvements to inline documentation.

See #62281

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-privacy-requests-table.php (modified) (1 diff)
• wp-admin/nav-menus.php (modified) (1 diff)
• wp-includes/https-detection.php (modified) (1 diff)
• wp-includes/link-template.php (modified) (1 diff)
• wp-includes/media.php (modified) (1 diff)
• wp-includes/option.php (modified) (1 diff)
• wp-includes/update.php (modified) (3 diffs)

trunk/src/wp-admin/includes/class-wp-privacy-requests-table.php

@@ -497 +497 @@
     public function column_default( $item, $column_name ) {
         /**
-         * Fires for each custom column of a specific request type in the Requests list table.
+         * Fires for each custom column of a specific request type in the Privacy Requests list table.
          *
          * Custom columns are registered using the {@see 'manage_export-personal-data_columns'}
          * and the {@see 'manage_erase-personal-data_columns'} filters.
+         *
+         * The dynamic portion of the hook name, `$this->screen->id`, refers to the ID given to the list table
+         * according to which screen it's displayed on.
+         *
+         * Possible hook names include:
+         *
+         *  - `manage_export-personal-data_custom_column`
+         *  - `manage_erase-personal-data_custom_column`
          *
          * @since 5.7.0

trunk/src/wp-admin/nav-menus.php

@@ -674 +674 @@
 /**
  * @global int $_wp_nav_menu_max_depth
+ *
+ * @since 3.0.0
  *
  * @param string $classes

trunk/src/wp-includes/https-detection.php

@@ -103 +103 @@
      * @param null|WP_Error $pre Error object to short-circuit detection,
      *                           or null to continue with the default behavior.
-     * @return null|WP_Error Error object if HTTPS detection errors are found, null otherwise.
      */
     $support_errors = apply_filters( 'pre_wp_get_https_detection_errors', null );

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

@@ -3052 +3052 @@
      * @param string $template  The default template.
      * @param string $css_class The class passed by the calling function.
-     * @return string Navigation template.
      */
     $template = apply_filters( 'navigation_markup_template', $template, $css_class );

trunk/src/wp-includes/media.php

@@ -5472 +5472 @@
      * this hook.
      *
+     * @since 6.7.0
+     *
      * @param int|null $post_id The result of the post ID lookup. Null to indicate
      *                          no lookup has been attempted. Default null.

trunk/src/wp-includes/option.php

@@ -1169 +1169 @@
      * The dynamic portion of the hook name, `$option`, refers to the option name.
      *
-     * @since 2.5.0 As "add_option_{$name}"
+     * @since 2.5.0 As `add_option_{$name}`
      * @since 3.0.0
      *

trunk/src/wp-includes/update.php

@@ -15 +15 @@
  * Checks WordPress version against the newest version.
  *
- * The WordPress version, PHP version, and locale is sent.
+ * The WordPress version, PHP version, and locale is sent to api.wordpress.org.
  *
  * Checks against the WordPress server at api.wordpress.org. Will only check
@@ -307 +307 @@
  * Despite its name this function does not actually perform any updates, it only checks for available updates.
  *
- * A list of all plugins installed is sent to WP, along with the site locale.
+ * A list of all plugins installed is sent to api.wordpress.org, along with the site locale.
  *
  * Checks against the WordPress server at api.wordpress.org. Will only check
@@ -579 +579 @@
  * Despite its name this function does not actually perform any updates, it only checks for available updates.
  *
- * A list of all themes installed is sent to WP, along with the site locale.
+ * A list of all themes installed is sent to api.wordpress.org, along with the site locale.
  *
  * Checks against the WordPress server at api.wordpress.org. Will only check