Skip to content

Commit 82b3854

Browse files
committed
Docs: Various docblock fixes in wp-includes/update.php, as per documentation standards.
This addresses some files modified in changeset [54113]. See #55646. git-svn-id: https://develop.svn.wordpress.org/trunk@54115 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 3be54dc commit 82b3854

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

src/wp-includes/update.php

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<?php
22
/**
3-
* A simple set of functions to check our version 1.0 update service.
3+
* A simple set of functions to check our Version Update service.
44
*
55
* @package WordPress
66
* @since 2.3.0
77
*/
88

99
/**
10-
* Check WordPress version against the newest version.
10+
* Checks WordPress version against the newest version.
1111
*
1212
* The WordPress version, PHP version, and locale is sent.
1313
*
@@ -21,7 +21,8 @@
2121
* @global string $wp_local_package Locale code of the package.
2222
*
2323
* @param array $extra_stats Extra statistics to report to the WordPress.org API.
24-
* @param bool $force_check Whether to bypass the transient cache and force a fresh update check. Defaults to false, true if $extra_stats is set.
24+
* @param bool $force_check Whether to bypass the transient cache and force a fresh update check.
25+
* Defaults to false, true if $extra_stats is set.
2526
*/
2627
function wp_version_check( $extra_stats = array(), $force_check = false ) {
2728
global $wpdb, $wp_local_package;
@@ -880,7 +881,7 @@ function wp_get_translation_updates() {
880881
}
881882

882883
/**
883-
* Collect counts and UI strings for available updates
884+
* Collects counts and UI strings for available updates.
884885
*
885886
* @since 3.3.0
886887
*
@@ -998,7 +999,7 @@ function _maybe_update_core() {
998999
wp_version_check();
9991000
}
10001001
/**
1001-
* Check the last time plugins were run before checking plugin versions.
1002+
* Checks the last time plugins were run before checking plugin versions.
10021003
*
10031004
* This might have been backported to WordPress 2.6.1 for performance reasons.
10041005
* This is used for the wp-admin to check only so often instead of every page
@@ -1020,7 +1021,7 @@ function _maybe_update_plugins() {
10201021
}
10211022

10221023
/**
1023-
* Check themes versions only after a duration of time.
1024+
* Checks themes versions only after a duration of time.
10241025
*
10251026
* This is for performance reasons to make sure that on the theme version
10261027
* checker is not run on every page load.
@@ -1041,7 +1042,7 @@ function _maybe_update_themes() {
10411042
}
10421043

10431044
/**
1044-
* Schedule core, theme, and plugin update checks.
1045+
* Schedules core, theme, and plugin update checks.
10451046
*
10461047
* @since 3.1.0
10471048
*/
@@ -1060,7 +1061,7 @@ function wp_schedule_update_checks() {
10601061
}
10611062

10621063
/**
1063-
* Clear existing update caches for plugins, themes, and core.
1064+
* Clears existing update caches for plugins, themes, and core.
10641065
*
10651066
* @since 4.1.0
10661067
*/

0 commit comments

Comments
 (0)