Changeset 55123

Timestamp:

01/24/2023 12:55:14 PM (21 months ago)

Author:

audrasjb

Message:

Docs: Various improvements in ms-blogs.php function descriptions, as per docblocks standards.

See #56792.

File:

• trunk/src/wp-includes/ms-blogs.php (modified) (18 diffs)

trunk/src/wp-includes/ms-blogs.php

@@ -13 +13 @@
 
 /**
- * Update the last_updated field for the current site.
+ * Updates the last_updated field for the current site.
  *
  * @since MU (3.0.0)
@@ -32 +32 @@
 
 /**
- * Get a full blog URL, given a blog ID.
+ * Gets a full blog URL, given a blog ID.
  *
  * @since MU (3.0.0)
@@ -53 +53 @@
 
 /**
- * Get a full blog URL, given a blog name.
- *
- * @since MU (3.0.0)
- *
- * @param string $blogname The (subdomain or directory) name
+ * Gets a full blog URL, given a blog name.
+ *
+ * @since MU (3.0.0)
+ *
+ * @param string $blogname Name of the subdomain or directory.
  * @return string
  */
@@ -114 +114 @@
 
 /**
- * Retrieve the details for a blog from the blogs table and blog options.
+ * Retrieves the details for a blog from the blogs table and blog options.
  *
  * @since MU (3.0.0)
@@ -274 +274 @@
 
 /**
- * Clear the blog details cache.
+ * Clears the blog details cache.
  *
  * @since MU (3.0.0)
@@ -290 +290 @@
 
 /**
- * Update the details for a blog. Updates the blogs table for a given blog ID.
+ * Updates the details for a blog and the blogs table for a given blog ID.
  *
  * @since MU (3.0.0)
@@ -338 +338 @@
 
 /**
- * Retrieve option value for a given blog id based on name of option.
+ * Retrieves option value for a given blog id based on name of option.
  *
  * If the option does not exist or does not have a value, then the return value
@@ -383 +383 @@
 
 /**
- * Add a new option for a given blog ID.
+ * Adds a new option for a given blog ID.
  *
  * You do not need to serialize values. If the value needs to be serialized, then
@@ -447 +447 @@
 
 /**
- * Update an option for a particular blog.
+ * Updates an option for a particular blog.
  *
  * @since MU (3.0.0)
@@ -476 +476 @@
 
 /**
- * Switch the current blog.
+ * Switches the current blog.
  *
  * This function is useful if you need to pull posts, or other information,
@@ -589 +589 @@
 
 /**
- * Restore the current blog, after calling switch_to_blog().
+ * Restores the current blog, after calling switch_to_blog().
  *
  * @see switch_to_blog()
@@ -702 +702 @@
 
 /**
- * Determines if switch_to_blog() is in effect
+ * Determines if switch_to_blog() is in effect.
  *
  * @since 3.5.0
@@ -715 +715 @@
 
 /**
- * Check if a particular blog is archived.
+ * Checks if a particular blog is archived.
  *
  * @since MU (3.0.0)
@@ -727 +727 @@
 
 /**
- * Update the 'archived' status of a particular blog.
+ * Updates the 'archived' status of a particular blog.
  *
  * @since MU (3.0.0)
@@ -741 +741 @@
 
 /**
- * Update a blog details field.
+ * Updates a blog details field.
  *
  * @since MU (3.0.0)
@@ -782 +782 @@
 
 /**
- * Get a blog details field.
+ * Gets a blog details field.
  *
  * @since MU (3.0.0)
@@ -804 +804 @@
 
 /**
- * Get a list of most recently updated blogs.
+ * Gets a list of most recently updated blogs.
  *
  * @since MU (3.0.0)
@@ -918 +918 @@
 
 /**
- * Count number of sites grouped by site status.
+ * Counts number of sites grouped by site status.
  *
  * @since 5.3.0