Changeset 10497 for trunk/src/bp-core/bp-core-avatars.php

Timestamp:

02/03/2016 05:01:13 AM (9 years ago)

Author:

tw2113

Message:

Adds many missing @since tags to the BP Core component.

See #6398.

File:

• trunk/src/bp-core/bp-core-avatars.php (modified) (15 diffs)

trunk/src/bp-core/bp-core-avatars.php

@@ -13 +13 @@
 /**
  * Set up the constants we need for avatar support.
+ *
+ * @since 1.2.0
  */
 function bp_core_set_avatar_constants() {
@@ -105 +107 @@
  *    add_filter( 'bp_core_fetch_avatar_no_grav', '__return_true' );
  *
+ * @since 1.1.0
  * @since 2.4.0 Added 'extra_attr', 'scheme', 'rating' and 'force_default' for $args.
  *              These are inherited from WordPress 4.2.0. See {@link get_avatar()}.
@@ -634 +637 @@
             $url_args['r'] = strtolower( $params['rating'] );
         }
-        // Only set default image if 'Gravatar Logo' is not requested
+        // Only set default image if 'Gravatar Logo' is not requested.
         if ( 'gravatar_default' !== $default_grav ) {
             $url_args['d'] = $default_grav;
@@ -674 +677 @@
 /**
  * Delete an existing avatar.
+ *
+ * @since 1.1.0
  *
  * @param array|string $args {
@@ -819 +824 @@
  * location.
  *
+ * @since 1.1.0
+ *
  * @see bp_core_check_avatar_upload()
  * @see bp_core_check_avatar_type()
@@ -1117 +1124 @@
  *  crop_x - The horizontal starting point of the crop
  *  crop_y - The vertical starting point of the crop
+ *
+ * @since 1.1.0
  *
  * @param array|string $args {
@@ -1318 +1327 @@
  * See 'get_avatar' filter description in wp-includes/pluggable.php.
  *
+ * @since 1.1.0
  * @since 2.4.0 Added $args parameter to coincide with WordPress 4.2.0.
  *
@@ -1414 +1424 @@
  * Is the current avatar upload error-free?
  *
+ * @since 1.0.0
+ *
  * @param array $file The $_FILES array.
  * @return bool True if no errors are found. False if there are errors.
@@ -1426 +1438 @@
 /**
  * Is the file size of the current avatar upload permitted?
+ *
+ * @since 1.0.0
  *
  * @param array $file The $_FILES array.
@@ -1478 +1492 @@
  *
  * Permitted file types are JPG, GIF and PNG.
+ *
+ * @since 1.0.0
  *
  * @param array $file The $_FILES array.
@@ -1566 +1582 @@
  * Get the absolute upload path for the WP installation.
  *
+ * @since 1.2.0
+ *
  * @uses bp_core_get_upload_dir() To get upload directory info.
  *
@@ -1584 +1602 @@
 /**
  * Get the raw base URL for root site upload location.
+ *
+ * @since 1.2.0
  *
  * @uses bp_core_get_upload_dir() To get upload directory info.
@@ -1850 +1870 @@
  * @since  2.2.0
  *
- * @param  WP_Query|null $posts_query the main query object.
- *
  * @uses   bp_is_group_create()
  * @uses   bp_is_group_admin_page()
@@ -1857 +1875 @@
  * @uses   bp_action_variable() to check for the group's avatar creation step
  * @uses   bp_is_user_change_avatar() to check for the user's change profile screen
+ *
+ * @param WP_Query|null $posts_query The main query object.
  */
 function bp_core_avatar_reset_query( $posts_query = null ) {
@@ -1934 +1954 @@
  * @global $is_safari
  * @global $is_IE
+ *
  * @return bool True to load the Webcam Avatar UI part. False otherwise.
  */