Changeset 7380 for trunk/src/includes/core/update.php

Timestamp:

12/05/2025 02:27:53 AM (6 months ago)

Author:

johnjamesjacoby

Message:

Tools - Code Improvement: docs & code formatting improvements.

Props johnjamesjacoby, noruzzaman.

Fixes #3659.

File:

• trunk/src/includes/core/update.php (modified) (20 diffs)

trunk/src/includes/core/update.php

@@ -2 +2 @@
 
 /**
- * bbPress Updater
+ * bbPress Updater.
  *
  * @package bbPress
@@ -12 +12 @@
 
 /**
- * If there is no raw DB version, this is the first installation
+ * If there is no raw DB version, this is the first installation.
  *
  * @since 2.1.0 bbPress (r3764)
  *
- * @return bool True if update, False if not
+ * @return bool True if update, False if not.
  */
 function bbp_is_install() {
@@ -23 +23 @@
 
 /**
- * Compare the bbPress version to the DB version to determine if updating
+ * Compare the bbPress version to the DB version to determine if updating.
  *
  * @since 2.0.0 bbPress (r3421)
  *
- * @return bool True if update, False if not
+ * @return bool True if update, False if not.
  */
 function bbp_is_update() {
@@ -37 +37 @@
 
 /**
- * Determine if bbPress is being activated
+ * Determine if bbPress is being activated.
  *
  * Note that this function currently is not used in bbPress core and is here
@@ -46 +46 @@
  * @global string $pagenow The filename of the current screen.
  *
- * @return bool True if activating bbPress, false if not
+ * @param string $basename Plugin base name.
+ *
+ * @return bool True if activating bbPress, false if not.
  */
 function bbp_is_activation( $basename = '' ) {
@@ -92 +94 @@
 
 /**
- * Determine if bbPress is being deactivated
+ * Determine if bbPress is being deactivated.
  *
  * @since 2.0.0 bbPress (r3421)
@@ -98 +100 @@
  * @global string $pagenow The filename of the current screen.
  *
- * @return bool True if deactivating bbPress, false if not
+ * @param string $basename Plugin base name.
+ *
+ * @return bool True if deactivating bbPress, false if not.
  */
 function bbp_is_deactivation( $basename = '' ) {
@@ -144 +148 @@
 
 /**
- * Update the DB to the latest version
+ * Update the DB to the latest version.
  *
  * @since 2.0.0 bbPress (r3421)
@@ -153 +157 @@
 
 /**
- * Setup the bbPress updater
+ * Setup the bbPress updater.
  *
  * @since 2.0.0 bbPress (r3419)
@@ -170 +174 @@
 /**
  * Runs when a new site is created in a multisite network, and bbPress is active
- * on that site (hooked to `bbp_new_site`)
+ * on that site (hooked to `bbp_new_site`).
  *
  * @since 2.6.0 bbPress (r6779)
+ *
+ * @param int $site_id Side id.
  */
 function bbp_setup_new_site( $site_id = 0 ) {
@@ -193 +199 @@
 
 /**
- * Create a default forum, topic, and reply
+ * Create a default forum, topic, and reply.
  *
  * @since 2.1.0 bbPress (r3767)
  *
- * @param array $args Array of arguments to override default values
+ * @param array $args Array of arguments to override default values.
  */
 function bbp_create_initial_content( $args = array() ) {
@@ -425 +431 @@
 
 /**
- * Redirect user to the "What's New" page on activation
+ * Redirect user to the "What's New" page on activation.
  *
  * @since 2.2.0 bbPress (r4389)
  *
- * @internal Used internally to redirect bbPress to the about page on activation
- *
- * @return If network admin or bulk activation
+ * @internal Used internally to redirect bbPress to the about page on activation.
+ *
+ * @return If network admin or bulk activation.
  */
 function bbp_add_activation_redirect() {
@@ -445 +451 @@
 
 /**
- * Redirect user to "What's New" page on activation
+ * Redirect user to "What's New" page on activation.
  *
  * @since 2.2.0 bbPress (r4389)
  *
- * @internal Used internally to redirect bbPress to the about page on activation
- *
- * @return If no transient, or in network admin, or is bulk activation
+ * @internal Used internally to redirect bbPress to the about page on activation.
+ *
+ * @return If no transient, or in network admin, or is bulk activation.
  */
 function bbp_do_activation_redirect() {
@@ -484 +490 @@
  * @since 2.4.0 bbPress (r4910)
  *
- * @internal Used to internally make the current user a keymaster on activation
- *
- * @return If user can't activate plugins or is already a keymaster
+ * @internal Used to internally make the current user a keymaster on activation.
+ *
+ * @return If user can't activate plugins or is already a keymaster.
  */
 function bbp_make_current_user_keymaster() {
@@ -532 +538 @@
 
 /**
- * Return the number of pending upgrades
+ * Return the number of pending upgrades.
  *
  * @since 2.6.0 bbPress (r6895)
  *
- * @param string $type Type of pending upgrades (upgrade|repair|empty)
+ * @param string $type Type of pending upgrades (upgrade|repair|empty).
  *
  * @return int
@@ -545 +551 @@
 
 /**
- * Return an array of pending upgrades
+ * Return an array of pending upgrades.
  *
  * @since 2.6.0 bbPress (r6895)
  *
- * @param string $type Type of pending upgrades (upgrade|repair|empty)
+ * @param string $type Type of pending upgrades (upgrade|repair|empty).
  *
  * @return array
@@ -569 +575 @@
 
 /**
- * Add an upgrade ID to pending upgrades array
+ * Add an upgrade ID to pending upgrades array.
  *
  * @since 2.6.0 bbPress (r6895)
@@ -590 +596 @@
 
 /**
- * Add an upgrade ID to pending upgrades array
+ * Add an upgrade ID to pending upgrades array.
  *
  * @since 2.6.0 bbPress (r6895)
@@ -614 +620 @@
 
 /**
- * Delete all pending upgrades
+ * Delete all pending upgrades.
  *
  * @since 2.6.0 bbPress (r6895)
@@ -623 +629 @@
 
 /**
- * Maybe append an upgrade count to a string
+ * Maybe append an upgrade count to a string.
  *
  * @since 2.6.0 bbPress (r6896)
  *
- * @param string $text Text to append count to
- * @param string $type Type of pending upgrades (upgrade|repair|empty)
+ * @param string $text Text to append count to.
+ * @param string $type Type of pending upgrades (upgrade|repair|empty).
  *
  * @return string