Changeset 11289

Timestamp:

12/12/2016 09:35:32 PM (8 years ago)

Author:

slaffik

Message:

Inline documentation: bp-core-attachments.php

Improved inline documentation in phpdoc for several functions.

See #7377.

File:

• trunk/src/bp-core/bp-core-attachments.php (modified) (4 diffs)

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

@@ -513 +513 @@
      *
      * @param bool $value Whether or not to delete the BuddyPress attachment.
-     * @param array Array of arguments for the attachment deletion.
+`    * @param array $args Array of arguments for the attachment deletion.
      */
     if ( ! apply_filters( 'bp_attachments_pre_delete_file', true, $args ) ) {
@@ -950 +950 @@
  *
  * @param string $component The component to get the settings for ("xprofile" for user or "groups").
- * @return array The cover image settings.
+ * @return array|bool The cover image settings in array, false on failure.
  */
 function bp_attachments_get_cover_image_settings( $component = 'xprofile' ) {
@@ -1001 +1001 @@
  *
  * @param string $component The BuddyPress component concerned ("xprofile" for user or "groups").
- * @return array An associative array containing the advised width and height for the cover image.
+ * @return array|bool An associative array containing the advised width and height for the cover image. False if settings are empty.
  */
 function bp_attachments_get_cover_image_dimensions( $component = 'xprofile' ) {
@@ -1186 +1186 @@
  * @since 2.4.0
  *
- * @return string|null A json object containing success data if the upload succeeded
+ * @return string|null A json object containing success data if the upload succeeded,
  *                     error message otherwise.
  */