WordPress.org

Make WordPress Core

Changeset 36417


Ignore:
Timestamp:
01/28/2016 03:50:26 AM (5 years ago)
Author:
ericlewis
Message:

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.

Location:
trunk/src
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/author-template.php

    r35993 r36417  
    327327
    328328/**
    329  * List all the authors of the blog, with several options available.
     329 * List all the authors of the site, with several options available.
    330330 *
    331331 * @link https://codex.wordpress.org/Template_Tags/wp_list_authors
  • trunk/src/wp-includes/class-wp-user-query.php

    r35916 r36417  
    141141     *     Optional. Array or string of Query parameters.
    142142     *
    143      *     @type int          $blog_id             The site ID. Default is the global blog id.
     143     *     @type int          $blog_id             The site ID. Default is the current site.
    144144     *     @type string|array $role                An array or a comma-separated list of role names that users must match
    145145     *                                             to be included in results. Note that this is an inclusive list: users
  • trunk/src/wp-includes/class-wp-user.php

    r36416 r36417  
    114114     * @param int|string|stdClass|WP_User $id User's ID, a WP_User object, or a user object from the DB.
    115115     * @param string $name Optional. User's username
    116      * @param int $blog_id Optional Blog ID, defaults to current blog.
     116     * @param int $blog_id Optional Site ID, defaults to current site.
    117117     */
    118118    public function __construct( $id = 0, $name = '', $blog_id = '' ) {
     
    769769
    770770    /**
    771      * Set the blog to operate on. Defaults to the current blog.
     771     * Set the site to operate on. Defaults to the current site.
    772772     *
    773773     * @since 3.0.0
     
    775775     * @global wpdb $wpdb WordPress database abstraction object.
    776776     *
    777      * @param int $blog_id Optional Blog ID, defaults to current blog.
     777     * @param int $blog_id Optional. Site ID, defaults to current site.
    778778     */
    779779    public function for_blog( $blog_id = '' ) {
  • trunk/src/wp-includes/functions.php

    r36336 r36417  
    13351335
    13361336/**
    1337  * Test whether blog is already installed.
     1337 * Test whether WordPress is already installed.
    13381338 *
    13391339 * The cache will be checked first. If you have a cache plugin, which saves
     
    13471347 * @global wpdb $wpdb WordPress database abstraction object.
    13481348 *
    1349  * @return bool Whether the blog is already installed.
     1349 * @return bool Whether the site is already installed.
    13501350 */
    13511351function is_blog_installed() {
  • trunk/src/wp-signup.php

    r35451 r36417  
    259259 *
    260260 * @param string $blogname The new site name
    261  * @param string $blog_title The new blog title
     261 * @param string $blog_title The new site title.
    262262 * @param array $errors
    263263 */
     
    336336
    337337/**
    338  * Validate a new blog signup
    339  *
    340  * @since MU
    341  *
    342  * @return null|bool True if blog signup was validated, false if error.
     338 * Validate a new site signup.
     339 *
     340 * @since MU
     341 *
     342 * @return null|bool True if site signup was validated, false if error.
    343343 *                   The function halts all execution if the user is not logged in.
    344344 */
     
    421421
    422422/**
    423  * Confirm a new site signup
     423 * Confirm a new site signup.
    424424 *
    425425 * @since MU
    426426 * @since 4.4.0 Added the `$blog_id` parameter.
    427427 *
    428  * @param string $domain The domain URL
    429  * @param string $path The site root path
    430  * @param string $blog_title The blog title
    431  * @param string $user_name The username
    432  * @param string $user_email The user's email address
    433  * @param array  $meta Any additional meta from the 'add_signup_meta' filter in validate_blog_signup()
    434  * @param int    $blog_id The blog ID
     428 * @param string $domain     The domain URL.
     429 * @param string $path       The site root path.
     430 * @param string $blog_title The site title.
     431 * @param string $user_name  The username.
     432 * @param string $user_email The user's email address.
     433 * @param array  $meta       Any additional meta from the 'add_signup_meta' filter in validate_blog_signup().
     434 * @param int    $blog_id    The site ID.
    435435 */
    436436function confirm_another_blog_signup( $domain, $path, $blog_title, $user_name, $user_email = '', $meta = array(), $blog_id = 0 ) {
Note: See TracChangeset for help on using the changeset viewer.