Changeset 11240

Timestamp:

11/05/2016 08:49:49 PM (8 years ago)

Author:

tw2113

Message:

Adds better documentation to arguments that are arrays and involved keys. See #7059.

Location:

trunk/src/bp-members

Files:

• bp-members-template.php (modified) (3 diffs)
• classes/class-bp-signup.php (modified) (4 diffs)

trunk/src/bp-members/bp-members-template.php

@@ -1002 +1002 @@
  * @since 1.2.0
  *
- * @param array|string $args Array of arguments for latest update.
+ * @param array|string $args {@see bp_get_member_latest_update()}.
  */
 function bp_member_latest_update( $args = '' ) {
@@ -1525 +1525 @@
  * @see bp_get_loggedin_user_avatar() for a description of params.
  *
- * @param array|string $args Array of arguments for logged in user avatar.
+ * @param array|string $args {@see bp_get_loggedin_user_avatar()}.
  */
 function bp_loggedin_user_avatar( $args = '' ) {
@@ -1580 +1580 @@
  * @see bp_get_displayed_user_avatar() for a description of params.
  *
- * @param array|string $args Array of arguments for displayed user avatar.
+ * @param array|string $args {@see bp_get_displayed_user_avatar()}.
  */
 function bp_displayed_user_avatar( $args = '' ) {

trunk/src/bp-members/classes/class-bp-signup.php

@@ -123 +123 @@
      * @since 2.0.0
      *
-     * @param array $args the argument to retrieve desired signups.
+     * @param array $args {
+     *     The argument to retrieve desired signups.
+     *     @type int         $offset         Offset amount. Default 0.
+     *     @type int         $number         How many to fetch. Default 1.
+     *     @type bool|string $usersearch     Whether or not to search for a username. Default false.
+     *     @type string      $orderby        Order By parameter. Default 'signup_id'.
+     *     @type string      $order          Order direction. Default 'DESC'.
+     *     @type bool        $include        Whether or not to include more specific query params.
+     *     @type string      $activation_key Activation key to search for.
+     *     @type string      $user_login     Specific user login to return.
+     * }
      * @return array {
      *     @type array $signups Located signups.
@@ -262 +272 @@
 
         return array( 'signups' => $paged_signups, 'total' => $total_signups );
+
     }
 
@@ -269 +280 @@
      * @since 2.0.0
      *
-     * @param array $args Array of arguments for signup addition.
-     * @return int|bool ID of newly created signup on success, false on
-     *                  failure.
+     * @param array $args {
+     *     Array of arguments for signup addition.
+     *     @type string     $domain         New user's domain.
+     *     @type string     $path           New user's path.
+     *     @type string     $title          New user's title.
+     *     @type string     $user_login     New user's user_login.
+     *     @type string     $user_email     New user's email address.
+     *     @type int|string $registered     Time the user registered.
+     *     @type string     $activation_key New user's activation key.
+     *     @type string     $meta           New user's user meta.
+     * }
+     * @return int|bool ID of newly created signup on success, false on failure.
      */
     public static function add( $args = array() ) {
@@ -490 +510 @@
      * @since 2.0.0
      *
-     * @param array $args Array of arguments for the signup update.
+     * @param array $args {
+     *     Array of arguments for the signup update.
+     *     @type int $signup_id User signup ID.
+     *     @type array $meta Meta to update.
+     * }
      * @return int The signup id.
      */