WordPress.org

Make WordPress Core


Ignore:
Timestamp:
04/22/2020 10:29:34 AM (5 months ago)
Author:
SergeyBiryukov
Message:

Docs: Synchronize parameter documentation for various metadata functions, update per the documentation standards.

See #49572.

File:
1 edited

Legend:

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

    r47610 r47611  
    386386 *
    387387 * @param array $site_ids List of site IDs.
    388  * @return array|false Returns false if there is nothing to update. Returns an array of metadata on success.
     388 * @return array|false An array of metadata on success, false if there is nothing to update.
    389389 */
    390390function update_sitemeta_cache( $site_ids ) {
     
    10601060 * @param int    $site_id    Site ID.
    10611061 * @param string $meta_key   Metadata name.
    1062  * @param mixed  $meta_value Optional. Metadata value. Must be serializable if
    1063  *                           non-scalar. Default empty.
     1062 * @param mixed  $meta_value Optional. Metadata value. If provided,
     1063 *                           rows will only be removed that match the value.
     1064 *                           Must be serializable if non-scalar. Default empty.
    10641065 * @return bool True on success, false on failure.
    10651066 */
     
    10741075 *
    10751076 * @param int    $site_id Site ID.
    1076  * @param string $key     Optional. The meta key to retrieve. By default, returns
    1077  *                        data for all keys. Default empty.
    1078  * @param bool   $single  Optional. Whether to return a single value. Default false.
    1079  * @return mixed Will be an array if $single is false. Will be value of meta data
    1080  *               field if $single is true.
     1077 * @param string $key     Optional. The meta key to retrieve. By default,
     1078 *                        returns data for all keys. Default empty.
     1079 * @param bool   $single  Optional. Whether to return a single value.
     1080 *                        This parameter has no effect if $key is not specified.
     1081 *                        Default false.
     1082 * @return mixed An array if $single is false. The value of meta data field
     1083 *               if $single is true.
    10811084 */
    10821085function get_site_meta( $site_id, $key = '', $single = false ) {
Note: See TracChangeset for help on using the changeset viewer.