Skip to:
Content

BuddyPress.org

Changeset 11289


Ignore:
Timestamp:
12/12/2016 09:35:32 PM (3 years ago)
Author:
slaffik
Message:

Inline documentation: bp-core-attachments.php

Improved inline documentation in phpdoc for several functions.

See #7377.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/bp-core-attachments.php

    r11091 r11289  
    513513     *
    514514     * @param bool $value Whether or not to delete the BuddyPress attachment.
    515      * @param array Array of arguments for the attachment deletion.
     515`    * @param array $args Array of arguments for the attachment deletion.
    516516     */
    517517    if ( ! apply_filters( 'bp_attachments_pre_delete_file', true, $args ) ) {
     
    950950 *
    951951 * @param string $component The component to get the settings for ("xprofile" for user or "groups").
    952  * @return array The cover image settings.
     952 * @return array|bool The cover image settings in array, false on failure.
    953953 */
    954954function bp_attachments_get_cover_image_settings( $component = 'xprofile' ) {
     
    10011001 *
    10021002 * @param string $component The BuddyPress component concerned ("xprofile" for user or "groups").
    1003  * @return array An associative array containing the advised width and height for the cover image.
     1003 * @return array|bool An associative array containing the advised width and height for the cover image. False if settings are empty.
    10041004 */
    10051005function bp_attachments_get_cover_image_dimensions( $component = 'xprofile' ) {
     
    11861186 * @since 2.4.0
    11871187 *
    1188  * @return string|null A json object containing success data if the upload succeeded
     1188 * @return string|null A json object containing success data if the upload succeeded,
    11891189 *                     error message otherwise.
    11901190 */
Note: See TracChangeset for help on using the changeset viewer.