Make WordPress Core


Ignore:
Timestamp:
01/28/2016 03:34:02 AM (8 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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/ms.php

    r35885 r36416  
    4949
    5050/**
    51  * Delete a blog.
     51 * Delete a site.
    5252 *
    5353 * @since 3.0.0
     
    5555 * @global wpdb $wpdb WordPress database abstraction object.
    5656 *
    57  * @param int  $blog_id Blog ID.
    58  * @param bool $drop    True if blog's table should be dropped. Default is false.
     57 * @param int  $blog_id Site ID.
     58 * @param bool $drop    True if site's database tables should be dropped. Default is false.
    5959 */
    6060function wpmu_delete_blog( $blog_id, $drop = false ) {
     
    6969    $blog = get_blog_details( $blog_id );
    7070    /**
    71      * Fires before a blog is deleted.
     71     * Fires before a site is deleted.
    7272     *
    7373     * @since MU
    7474     *
    75      * @param int  $blog_id The blog ID.
    76      * @param bool $drop    True if blog's table should be dropped. Default is false.
     75     * @param int  $blog_id The site ID.
     76     * @param bool $drop    True if site's table should be dropped. Default is false.
    7777     */
    7878    do_action( 'delete_blog', $blog_id, $drop );
     
    113113        $tables = $wpdb->tables( 'blog' );
    114114        /**
    115          * Filter the tables to drop when the blog is deleted.
     115         * Filter the tables to drop when the site is deleted.
    116116         *
    117117         * @since MU
    118118         *
    119          * @param array $tables  The blog tables to be dropped.
    120          * @param int   $blog_id The ID of the blog to drop tables for.
     119         * @param array $tables  The site tables to be dropped.
     120         * @param int   $blog_id The ID of the site to drop tables for.
    121121         */
    122122        $drop_tables = apply_filters( 'wpmu_drop_tables', $tables, $blog_id );
     
    129129
    130130        /**
    131          * Filter the upload base directory to delete when the blog is deleted.
     131         * Filter the upload base directory to delete when the site is deleted.
    132132         *
    133133         * @since MU
    134134         *
    135135         * @param string $uploads['basedir'] Uploads path without subdirectory. @see wp_upload_dir()
    136          * @param int    $blog_id            The blog ID.
     136         * @param int    $blog_id            The site ID.
    137137         */
    138138        $dir = apply_filters( 'wpmu_delete_blog_upload_dir', $uploads['basedir'], $blog_id );
     
    411411
    412412/**
    413  * Check whether a blog has used its allotted upload space.
     413 * Check whether a site has used its allotted upload space.
    414414 *
    415415 * @since MU
     
    438438
    439439/**
    440  * Displays the amount of disk space used by the current blog. Not used in core.
     440 * Displays the amount of disk space used by the current site. Not used in core.
    441441 *
    442442 * @since MU
     
    463463
    464464/**
    465  * Get the remaining upload space for this blog.
     465 * Get the remaining upload space for this site.
    466466 *
    467467 * @since MU
     
    479479
    480480/**
    481  * Displays the edit blog upload space setting form on the Edit Blog screen.
    482  *
    483  * @since 3.0.0
    484  *
    485  * @param int $id The ID of the blog to display the setting for.
     481 * Displays the site upload space quota setting form on the Edit Site Settings screen.
     482 *
     483 * @since 3.0.0
     484 *
     485 * @param int $id The ID of the site to display the setting for.
    486486 */
    487487function upload_space_setting( $id ) {
Note: See TracChangeset for help on using the changeset viewer.