Skip to content

Commit 54e97c4

Browse files
committed
Docs: Various improvements to inline documentation.
See #62281 git-svn-id: https://develop.svn.wordpress.org/trunk@59865 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 4a00fd7 commit 54e97c4

File tree

7 files changed

+17
-7
lines changed

7 files changed

+17
-7
lines changed

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -496,11 +496,19 @@ protected function get_timestamp_as_date( $timestamp ) {
496496
*/
497497
public function column_default( $item, $column_name ) {
498498
/**
499-
* Fires for each custom column of a specific request type in the Requests list table.
499+
* Fires for each custom column of a specific request type in the Privacy Requests list table.
500500
*
501501
* Custom columns are registered using the {@see 'manage_export-personal-data_columns'}
502502
* and the {@see 'manage_erase-personal-data_columns'} filters.
503503
*
504+
* The dynamic portion of the hook name, `$this->screen->id`, refers to the ID given to the list table
505+
* according to which screen it's displayed on.
506+
*
507+
* Possible hook names include:
508+
*
509+
* - `manage_export-personal-data_custom_column`
510+
* - `manage_erase-personal-data_custom_column`
511+
*
504512
* @since 5.7.0
505513
*
506514
* @param string $column_name The name of the column to display.

src/wp-admin/nav-menus.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -674,6 +674,8 @@
674674
/**
675675
* @global int $_wp_nav_menu_max_depth
676676
*
677+
* @since 3.0.0
678+
*
677679
* @param string $classes
678680
* @return string
679681
*/

src/wp-includes/https-detection.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,6 @@ function wp_get_https_detection_errors() {
102102
*
103103
* @param null|WP_Error $pre Error object to short-circuit detection,
104104
* or null to continue with the default behavior.
105-
* @return null|WP_Error Error object if HTTPS detection errors are found, null otherwise.
106105
*/
107106
$support_errors = apply_filters( 'pre_wp_get_https_detection_errors', null );
108107
if ( is_wp_error( $support_errors ) ) {

src/wp-includes/link-template.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3051,7 +3051,6 @@ function _navigation_markup( $links, $css_class = 'posts-navigation', $screen_re
30513051
*
30523052
* @param string $template The default template.
30533053
* @param string $css_class The class passed by the calling function.
3054-
* @return string Navigation template.
30553054
*/
30563055
$template = apply_filters( 'navigation_markup_template', $template, $css_class );
30573056

src/wp-includes/media.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5471,6 +5471,8 @@ function attachment_url_to_postid( $url ) {
54715471
* Use the === operator for testing the post ID when developing filters using
54725472
* this hook.
54735473
*
5474+
* @since 6.7.0
5475+
*
54745476
* @param int|null $post_id The result of the post ID lookup. Null to indicate
54755477
* no lookup has been attempted. Default null.
54765478
* @param string $url The URL being looked up.

src/wp-includes/option.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1168,7 +1168,7 @@ function add_option( $option, $value = '', $deprecated = '', $autoload = null )
11681168
*
11691169
* The dynamic portion of the hook name, `$option`, refers to the option name.
11701170
*
1171-
* @since 2.5.0 As "add_option_{$name}"
1171+
* @since 2.5.0 As `add_option_{$name}`
11721172
* @since 3.0.0
11731173
*
11741174
* @param string $option Name of the option to add.

src/wp-includes/update.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
/**
1515
* Checks WordPress version against the newest version.
1616
*
17-
* The WordPress version, PHP version, and locale is sent.
17+
* The WordPress version, PHP version, and locale is sent to api.wordpress.org.
1818
*
1919
* Checks against the WordPress server at api.wordpress.org. Will only check
2020
* if WordPress isn't installing.
@@ -306,7 +306,7 @@ function wp_version_check( $extra_stats = array(), $force_check = false ) {
306306
*
307307
* Despite its name this function does not actually perform any updates, it only checks for available updates.
308308
*
309-
* A list of all plugins installed is sent to WP, along with the site locale.
309+
* A list of all plugins installed is sent to api.wordpress.org, along with the site locale.
310310
*
311311
* Checks against the WordPress server at api.wordpress.org. Will only check
312312
* if WordPress isn't installing.
@@ -578,7 +578,7 @@ function wp_update_plugins( $extra_stats = array() ) {
578578
*
579579
* Despite its name this function does not actually perform any updates, it only checks for available updates.
580580
*
581-
* A list of all themes installed is sent to WP, along with the site locale.
581+
* A list of all themes installed is sent to api.wordpress.org, along with the site locale.
582582
*
583583
* Checks against the WordPress server at api.wordpress.org. Will only check
584584
* if WordPress isn't installing.

0 commit comments

Comments
 (0)