Networks and sites: Replace "blog" usage with "site" in docs.

Multisite functions use the term "blog" to refer to what we now call a "site," e.g. `get_current_blog_id()`. These functions are here to stay because of our commitment to backwards compatibility. What we can do is set the documentation straight.

See #35417.


git-svn-id: https://develop.svn.wordpress.org/trunk@36417 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Eric Andrew Lewis 2016-01-28 03:50:26 +00:00
parent 3fde994152
commit 27361e6ffe
5 changed files with 18 additions and 18 deletions

View File

@ -326,7 +326,7 @@ function get_author_posts_url( $author_id, $author_nicename = '' ) {
}
/**
* List all the authors of the blog, with several options available.
* List all the authors of the site, with several options available.
*
* @link https://codex.wordpress.org/Template_Tags/wp_list_authors
*

View File

@ -140,7 +140,7 @@ class WP_User_Query {
* @param string|array $query {
* Optional. Array or string of Query parameters.
*
* @type int $blog_id The site ID. Default is the global blog id.
* @type int $blog_id The site ID. Default is the current site.
* @type string|array $role An array or a comma-separated list of role names that users must match
* to be included in results. Note that this is an inclusive list: users
* must match *each* role. Default empty.

View File

@ -113,7 +113,7 @@ class WP_User {
*
* @param int|string|stdClass|WP_User $id User's ID, a WP_User object, or a user object from the DB.
* @param string $name Optional. User's username
* @param int $blog_id Optional Blog ID, defaults to current blog.
* @param int $blog_id Optional Site ID, defaults to current site.
*/
public function __construct( $id = 0, $name = '', $blog_id = '' ) {
if ( ! isset( self::$back_compat_keys ) ) {
@ -768,13 +768,13 @@ class WP_User {
}
/**
* Set the blog to operate on. Defaults to the current blog.
* Set the site to operate on. Defaults to the current site.
*
* @since 3.0.0
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int $blog_id Optional Blog ID, defaults to current blog.
* @param int $blog_id Optional. Site ID, defaults to current site.
*/
public function for_blog( $blog_id = '' ) {
global $wpdb;

View File

@ -1334,7 +1334,7 @@ function do_robots() {
}
/**
* Test whether blog is already installed.
* Test whether WordPress is already installed.
*
* The cache will be checked first. If you have a cache plugin, which saves
* the cache values, then this will work. If you use the default WordPress
@ -1346,7 +1346,7 @@ function do_robots() {
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @return bool Whether the blog is already installed.
* @return bool Whether the site is already installed.
*/
function is_blog_installed() {
global $wpdb;

View File

@ -258,7 +258,7 @@ function validate_user_form() {
* @since MU
*
* @param string $blogname The new site name
* @param string $blog_title The new blog title
* @param string $blog_title The new site title.
* @param array $errors
*/
function signup_another_blog( $blogname = '', $blog_title = '', $errors = '' ) {
@ -335,11 +335,11 @@ function signup_another_blog( $blogname = '', $blog_title = '', $errors = '' ) {
}
/**
* Validate a new blog signup
* Validate a new site signup.
*
* @since MU
*
* @return null|bool True if blog signup was validated, false if error.
* @return null|bool True if site signup was validated, false if error.
* The function halts all execution if the user is not logged in.
*/
function validate_another_blog_signup() {
@ -420,18 +420,18 @@ function validate_another_blog_signup() {
}
/**
* Confirm a new site signup
* Confirm a new site signup.
*
* @since MU
* @since 4.4.0 Added the `$blog_id` parameter.
*
* @param string $domain The domain URL
* @param string $path The site root path
* @param string $blog_title The blog title
* @param string $user_name The username
* @param string $user_email The user's email address
* @param array $meta Any additional meta from the 'add_signup_meta' filter in validate_blog_signup()
* @param int $blog_id The blog ID
* @param string $domain The domain URL.
* @param string $path The site root path.
* @param string $blog_title The site title.
* @param string $user_name The username.
* @param string $user_email The user's email address.
* @param array $meta Any additional meta from the 'add_signup_meta' filter in validate_blog_signup().
* @param int $blog_id The site ID.
*/
function confirm_another_blog_signup( $domain, $path, $blog_title, $user_name, $user_email = '', $meta = array(), $blog_id = 0 ) {