Changeset 47611 for trunk/src/wp-includes/ms-site.php

Timestamp:

04/22/2020 10:29:34 AM (5 years ago)

Author:

SergeyBiryukov

Message:

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

See #49572.

File:

• trunk/src/wp-includes/ms-site.php (modified) (3 diffs)

trunk/src/wp-includes/ms-site.php

@@ -386 +386 @@
  *
  * @param array $site_ids List of site IDs.
- * @return array|false Returns false if there is nothing to update. Returns an array of metadata on success.
+ * @return array|false An array of metadata on success, false if there is nothing to update.
  */
 function update_sitemeta_cache( $site_ids ) {
@@ -1060 +1060 @@
  * @param int    $site_id    Site ID.
  * @param string $meta_key   Metadata name.
- * @param mixed  $meta_value Optional. Metadata value. Must be serializable if
- *                           non-scalar. Default empty.
+ * @param mixed  $meta_value Optional. Metadata value. If provided,
+ *                           rows will only be removed that match the value.
+ *                           Must be serializable if non-scalar. Default empty.
  * @return bool True on success, false on failure.
  */
@@ -1074 +1075 @@
  *
  * @param int    $site_id Site ID.
- * @param string $key     Optional. The meta key to retrieve. By default, returns
- *                        data for all keys. Default empty.
- * @param bool   $single  Optional. Whether to return a single value. Default false.
- * @return mixed Will be an array if $single is false. Will be value of meta data
- *               field if $single is true.
+ * @param string $key     Optional. The meta key to retrieve. By default,
+ *                        returns data for all keys. Default empty.
+ * @param bool   $single  Optional. Whether to return a single value.
+ *                        This parameter has no effect if $key is not specified.
+ *                        Default false.
+ * @return mixed An array if $single is false. The value of meta data field
+ *               if $single is true.
  */
 function get_site_meta( $site_id, $key = '', $single = false ) {