Changeset 42875 for trunk/src/wp-includes/capabilities.php

Timestamp:

03/25/2018 06:09:56 PM (7 years ago)

Author:

johnbillion

Message:

Docs: Document more parameters and properties using typed array notation.

See #41756

File:

• trunk/src/wp-includes/capabilities.php (modified) (4 diffs)

trunk/src/wp-includes/capabilities.php

@@ -325 +325 @@
                  * @since 4.6.0
                  *
-                 * @param bool   $allowed   Whether the user can add the object meta. Default false.
-                 * @param string $meta_key  The meta key.
-                 * @param int    $object_id Object ID.
-                 * @param int    $user_id   User ID.
-                 * @param string $cap       Capability name.
-                 * @param array  $caps      User capabilities.
+                 * @param bool     $allowed   Whether the user can add the object meta. Default false.
+                 * @param string   $meta_key  The meta key.
+                 * @param int      $object_id Object ID.
+                 * @param int      $user_id   User ID.
+                 * @param string   $cap       Capability name.
+                 * @param string[] $caps      Array of the user's capabilities.
                  */
                 $allowed = apply_filters( "auth_{$object_type}_meta_{$meta_key}", false, $meta_key, $object_id, $user_id, $cap, $caps );
@@ -346 +346 @@
                  * @since 4.7.0
                  *
-                 * @param bool   $allowed   Whether the user can add the object meta. Default false.
-                 * @param string $meta_key  The meta key.
-                 * @param int    $object_id Object ID.
-                 * @param int    $user_id   User ID.
-                 * @param string $cap       Capability name.
-                 * @param array  $caps      User capabilities.
+                 * @param bool     $allowed   Whether the user can add the object meta. Default false.
+                 * @param string   $meta_key  The meta key.
+                 * @param int      $object_id Object ID.
+                 * @param int      $user_id   User ID.
+                 * @param string   $cap       Capability name.
+                 * @param string[] $caps      Array of the user's capabilities.
                  */
                 $allowed = apply_filters( "auth_{$object_type}_{$sub_type}_meta_{$meta_key}", $allowed, $meta_key, $object_id, $user_id, $cap, $caps );
@@ -573 +573 @@
      * @since 2.8.0
      *
-     * @param array  $caps    Returns the user's actual capabilities.
-     * @param string $cap     Capability name.
-     * @param int    $user_id The user ID.
-     * @param array  $args    Adds the context to the cap. Typically the object ID.
+     * @param string[] $caps    Array of the user's capabilities.
+     * @param string   $cap     Capability name.
+     * @param int      $user_id The user ID.
+     * @param array    $args    Adds the context to the cap. Typically the object ID.
      */
     return apply_filters( 'map_meta_cap', $caps, $cap, $user_id, $args );
@@ -913 +913 @@
  * @since 4.9.0
  *
- * @param array $allcaps An array of all the user's capabilities.
- * @return array Filtered array of the user's capabilities.
+ * @param bool[] $allcaps An array of all the user's capabilities.
+ * @return bool[] Filtered array of the user's capabilities.
  */
 function wp_maybe_grant_install_languages_cap( $allcaps ) {