From 24adb71a5637586ed97a97c54c586e8ebff57051 Mon Sep 17 00:00:00 2001 From: Eric Lewis Date: Thu, 28 Jan 2016 03:51:26 +0000 Subject: [PATCH] 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. Built from https://develop.svn.wordpress.org/trunk@36417 git-svn-id: http://core.svn.wordpress.org/trunk@36384 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/author-template.php | 2 +- wp-includes/class-wp-user-query.php | 2 +- wp-includes/class-wp-user.php | 6 +++--- wp-includes/functions.php | 4 ++-- wp-includes/version.php | 2 +- wp-signup.php | 22 +++++++++++----------- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/wp-includes/author-template.php b/wp-includes/author-template.php index ef5d104d86..ba609ab275 100644 --- a/wp-includes/author-template.php +++ b/wp-includes/author-template.php @@ -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 * diff --git a/wp-includes/class-wp-user-query.php b/wp-includes/class-wp-user-query.php index 0e3d7c59f2..02cae108c8 100644 --- a/wp-includes/class-wp-user-query.php +++ b/wp-includes/class-wp-user-query.php @@ -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. diff --git a/wp-includes/class-wp-user.php b/wp-includes/class-wp-user.php index 08a4a6739c..210919d6e4 100644 --- a/wp-includes/class-wp-user.php +++ b/wp-includes/class-wp-user.php @@ -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; diff --git a/wp-includes/functions.php b/wp-includes/functions.php index fb2d20f683..3d8a43ae6c 100644 --- a/wp-includes/functions.php +++ b/wp-includes/functions.php @@ -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; diff --git a/wp-includes/version.php b/wp-includes/version.php index a4c42d03d6..4979e0b6da 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.5-alpha-36416'; +$wp_version = '4.5-alpha-36417'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. diff --git a/wp-signup.php b/wp-signup.php index 6852bb88cb..bd46d02c2f 100644 --- a/wp-signup.php +++ b/wp-signup.php @@ -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 ) {