Skip to content

Commit

Permalink
Docs: Various improvements to inline documentation.
Browse files Browse the repository at this point in the history
See #62281

git-svn-id: https://develop.svn.wordpress.org/trunk@59865 602fd350-edb4-49c9-b593-d223f7449a82
  • Loading branch information
johnbillion committed Feb 24, 2025
1 parent 4a00fd7 commit 54e97c4
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 7 deletions.
10 changes: 9 additions & 1 deletion src/wp-admin/includes/class-wp-privacy-requests-table.php
Original file line number Diff line number Diff line change
Expand Up @@ -496,11 +496,19 @@ protected function get_timestamp_as_date( $timestamp ) {
*/
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
*
* @param string $column_name The name of the column to display.
Expand Down
2 changes: 2 additions & 0 deletions src/wp-admin/nav-menus.php
Original file line number Diff line number Diff line change
Expand Up @@ -674,6 +674,8 @@
/**
* @global int $_wp_nav_menu_max_depth
*
* @since 3.0.0
*
* @param string $classes
* @return string
*/
Expand Down
1 change: 0 additions & 1 deletion src/wp-includes/https-detection.php
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,6 @@ function wp_get_https_detection_errors() {
*
* @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 );
if ( is_wp_error( $support_errors ) ) {
Expand Down
1 change: 0 additions & 1 deletion src/wp-includes/link-template.php
Original file line number Diff line number Diff line change
Expand Up @@ -3051,7 +3051,6 @@ function _navigation_markup( $links, $css_class = 'posts-navigation', $screen_re
*
* @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 );

Expand Down
2 changes: 2 additions & 0 deletions src/wp-includes/media.php
Original file line number Diff line number Diff line change
Expand Up @@ -5471,6 +5471,8 @@ function attachment_url_to_postid( $url ) {
* Use the === operator for testing the post ID when developing filters using
* 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.
* @param string $url The URL being looked up.
Expand Down
2 changes: 1 addition & 1 deletion src/wp-includes/option.php
Original file line number Diff line number Diff line change
Expand Up @@ -1168,7 +1168,7 @@ function add_option( $option, $value = '', $deprecated = '', $autoload = null )
*
* 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
*
* @param string $option Name of the option to add.
Expand Down
6 changes: 3 additions & 3 deletions src/wp-includes/update.php
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
/**
* 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
* if WordPress isn't installing.
Expand Down Expand Up @@ -306,7 +306,7 @@ function wp_version_check( $extra_stats = array(), $force_check = false ) {
*
* 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
* if WordPress isn't installing.
Expand Down Expand Up @@ -578,7 +578,7 @@ function wp_update_plugins( $extra_stats = array() ) {
*
* 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
* if WordPress isn't installing.
Expand Down

0 comments on commit 54e97c4

Please sign in to comment.