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

See #56792.

Built from https://develop.svn.wordpress.org/trunk@55123


git-svn-id: http://core.svn.wordpress.org/trunk@54656 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2023-01-24 12:57:15 +00:00
parent 215de3c5f3
commit 037d3406ee
2 changed files with 20 additions and 20 deletions

View File

@ -12,7 +12,7 @@ require_once ABSPATH . WPINC . '/ms-site.php';
require_once ABSPATH . WPINC . '/ms-network.php'; require_once ABSPATH . WPINC . '/ms-network.php';
/** /**
* Update the last_updated field for the current site. * Updates the last_updated field for the current site.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
*/ */
@ -31,7 +31,7 @@ function wpmu_update_blogs_date() {
} }
/** /**
* Get a full blog URL, given a blog ID. * Gets a full blog URL, given a blog ID.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
@ -52,11 +52,11 @@ function get_blogaddress_by_id( $blog_id ) {
} }
/** /**
* Get a full blog URL, given a blog name. * Gets a full blog URL, given a blog name.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
* @param string $blogname The (subdomain or directory) name * @param string $blogname Name of the subdomain or directory.
* @return string * @return string
*/ */
function get_blogaddress_by_name( $blogname ) { function get_blogaddress_by_name( $blogname ) {
@ -113,7 +113,7 @@ function get_id_from_blogname( $slug ) {
} }
/** /**
* 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) * @since MU (3.0.0)
* *
@ -273,7 +273,7 @@ function get_blog_details( $fields = null, $get_all = true ) {
} }
/** /**
* Clear the blog details cache. * Clears the blog details cache.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
@ -289,7 +289,7 @@ function refresh_blog_details( $blog_id = 0 ) {
} }
/** /**
* 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) * @since MU (3.0.0)
* *
@ -337,7 +337,7 @@ function clean_site_details_cache( $site_id = 0 ) {
} }
/** /**
* 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 * If the option does not exist or does not have a value, then the return value
* will be false. This is useful to check whether you need to install an option * will be false. This is useful to check whether you need to install an option
@ -382,7 +382,7 @@ function get_blog_option( $id, $option, $default_value = false ) {
} }
/** /**
* 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 * You do not need to serialize values. If the value needs to be serialized, then
* it will be serialized before it is inserted into the database. Remember, * it will be serialized before it is inserted into the database. Remember,
@ -446,7 +446,7 @@ function delete_blog_option( $id, $option ) {
} }
/** /**
* Update an option for a particular blog. * Updates an option for a particular blog.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
@ -475,7 +475,7 @@ function update_blog_option( $id, $option, $value, $deprecated = null ) {
} }
/** /**
* Switch the current blog. * Switches the current blog.
* *
* This function is useful if you need to pull posts, or other information, * This function is useful if you need to pull posts, or other information,
* from other blogs. You can switch back afterwards using restore_current_blog(). * from other blogs. You can switch back afterwards using restore_current_blog().
@ -588,7 +588,7 @@ function switch_to_blog( $new_blog_id, $deprecated = null ) {
} }
/** /**
* Restore the current blog, after calling switch_to_blog(). * Restores the current blog, after calling switch_to_blog().
* *
* @see switch_to_blog() * @see switch_to_blog()
* @since MU (3.0.0) * @since MU (3.0.0)
@ -701,7 +701,7 @@ function wp_switch_roles_and_user( $new_site_id, $old_site_id ) {
} }
/** /**
* Determines if switch_to_blog() is in effect * Determines if switch_to_blog() is in effect.
* *
* @since 3.5.0 * @since 3.5.0
* *
@ -714,7 +714,7 @@ function ms_is_switched() {
} }
/** /**
* Check if a particular blog is archived. * Checks if a particular blog is archived.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
@ -726,7 +726,7 @@ function is_archived( $id ) {
} }
/** /**
* Update the 'archived' status of a particular blog. * Updates the 'archived' status of a particular blog.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
@ -740,7 +740,7 @@ function update_archived( $id, $archived ) {
} }
/** /**
* Update a blog details field. * Updates a blog details field.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* @since 5.1.0 Use wp_update_site() internally. * @since 5.1.0 Use wp_update_site() internally.
@ -781,7 +781,7 @@ function update_blog_status( $blog_id, $pref, $value, $deprecated = null ) {
} }
/** /**
* Get a blog details field. * Gets a blog details field.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
@ -803,7 +803,7 @@ function get_blog_status( $id, $pref ) {
} }
/** /**
* Get a list of most recently updated blogs. * Gets a list of most recently updated blogs.
* *
* @since MU (3.0.0) * @since MU (3.0.0)
* *
@ -917,7 +917,7 @@ function _update_posts_count_on_transition_post_status( $new_status, $old_status
} }
/** /**
* Count number of sites grouped by site status. * Counts number of sites grouped by site status.
* *
* @since 5.3.0 * @since 5.3.0
* *

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.2-alpha-55122'; $wp_version = '6.2-alpha-55123';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.