Make WordPress Core

Changeset 55075


Ignore:
Timestamp:
01/15/2023 05:50:13 PM (18 months ago)
Author:
audrasjb
Message:

Docs: Various docblock fixes in Multisite WordPress API related functions.

Follow-up to [55074].

See #56792.

File:
1 edited

Legend:

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

    r55074 r55075  
    146146 * @param int    $blog_id ID of the blog the user is being added to.
    147147 * @param int    $user_id ID of the user being added.
    148  * @param string $role    The role you want the user to have.
     148 * @param string $role    User role.
    149149 * @return true|WP_Error True on success or a WP_Error object if the user doesn't exist
    150150 *                       or could not be added.
     
    308308 * @param int $blog_id ID of the source blog.
    309309 * @param int $post_id ID of the desired post.
    310  * @return string The post's permalink
     310 * @return string The post's permalink.
    311311 */
    312312function get_blog_permalink( $blog_id, $post_id ) {
     
    330330 * @global wpdb $wpdb WordPress database abstraction object.
    331331 *
    332  * @param string $domain
     332 * @param string $domain Website domain.
    333333 * @param string $path   Optional. Not required for subdomain installations.
    334  * @return int 0 if no blog found, otherwise the ID of the matching blog
     334 * @return int 0 if no blog found, otherwise the ID of the matching blog.
    335335 */
    336336function get_blog_id_from_url( $domain, $path = '/' ) {
     
    914914 * @param string $user_login The user's login name.
    915915 * @param string $user_email The user's email address.
    916  * @param string $key        The activation key created in wpmu_signup_blog()
     916 * @param string $key        The activation key created in wpmu_signup_blog().
    917917 * @param array  $meta       Optional. Signup meta data. By default, contains the requested privacy setting and lang_id.
    918918 * @return bool
     
    11531153 *
    11541154 * @param string $key The activation key provided to the user.
    1155  * @return array|WP_Error An array containing information about the activated user and/or blog
     1155 * @return array|WP_Error An array containing information about the activated user and/or blog.
    11561156 */
    11571157function wpmu_activate_signup( $key ) {
     
    13051305 * @param string $password  The new user's password.
    13061306 * @param string $email     The new user's email address.
    1307  * @return int|false Returns false on failure, or int $user_id on success
     1307 * @return int|false Returns false on failure, or int $user_id on success.
    13081308 */
    13091309function wpmu_create_user( $user_name, $password, $email ) {
     
    19091909 * @since MU (3.0.0)
    19101910 *
    1911  * @global WP_Network $current_site
    1912  *
    1913  * @return WP_Network
     1911 * @global WP_Network $current_site The current network.
     1912 *
     1913 * @return WP_Network The current network.
    19141914 */
    19151915function get_current_site() {
     
    19281928 * @global wpdb $wpdb WordPress database abstraction object.
    19291929 *
    1930  * @param int $user_id
    1931  * @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts
     1930 * @param int $user_id User ID.
     1931 * @return array Contains the blog_id, post_id, post_date_gmt, and post_gmt_ts.
    19321932 */
    19331933function get_most_recent_post_of_user( $user_id ) {
     
    20762076 * @blessed
    20772077 *
    2078  * @param array $upload
     2078 * @param array $upload An array of information about the newly-uploaded file.
    20792079 * @return string|array If the upload is under the size limit, $upload is returned. Otherwise returns an error message.
    20802080 */
     
    22632263
    22642264/**
    2265  * Corrects From host on outgoing mail to match the site domain
     2265 * Corrects From host on outgoing mail to match the site domain.
    22662266 *
    22672267 * @since MU (3.0.0)
     
    23012301 * @since MU (3.0.0)
    23022302 *
    2303  * @param int $old_value
    2304  * @param int $value     The new public value
     2303 * @param int $old_value The old public value.
     2304 * @param int $value     The new public value.
    23052305 */
    23062306function update_blog_public( $old_value, $value ) {
     
    23792379 * @since 2.8.5
    23802380 *
    2381  * @param string $url URL
    2382  * @return string URL with https as the scheme
     2381 * @param string $url URL.
     2382 * @return string URL with https as the scheme.
    23832383 */
    23842384function filter_SSL( $url ) {  // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
     
    25462546 * @since MU (3.0.0)
    25472547 *
    2548  * @return int Quota in megabytes
     2548 * @return int Quota in megabytes.
    25492549 */
    25502550function get_space_allowed() {
     
    25742574 * @since 3.0.0
    25752575 *
    2576  * @return int of upload space available in bytes
     2576 * @return int of upload space available in bytes.
    25772577 */
    25782578function get_upload_space_available() {
Note: See TracChangeset for help on using the changeset viewer.