Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
06/23/2016 06:31:58 AM (8 years ago)
Author:
tw2113
Message:

Many PHPDocs cleanup for Core component.

See #6398.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/classes/class-bp-attachment.php

    r10825 r10899  
    198198     * @since 2.3.0
    199199     *
    200      *
    201      * @param  array       $file              The appropriate entry the from $_FILES superglobal.
    202      * @param  string      $upload_dir_filter A specific filter to be applied to 'upload_dir' (optional).
    203      * @param  string|null $time              Optional. Time formatted in 'yyyy/mm'. Default null.
     200     * @param array       $file              The appropriate entry the from $_FILES superglobal.
     201     * @param string      $upload_dir_filter A specific filter to be applied to 'upload_dir' (optional).
     202     * @param string|null $time              Optional. Time formatted in 'yyyy/mm'. Default null.
    204203     * @return array On success, returns an associative array of file attributes.
    205204     *               On failure, returns an array containing the error message
     
    208207    public function upload( $file, $upload_dir_filter = '', $time = null ) {
    209208        /**
    210          * Upload action and the file input name are required parameters
     209         * Upload action and the file input name are required parameters.
     210         *
    211211         * @see BP_Attachment:__construct()
    212212         */
     
    321321     * @since 2.3.0
    322322     *
    323      * @param  array $file The temporary file attributes (before it has been moved).
     323     * @param array $file The temporary file attributes (before it has been moved).
    324324     * @return array The file.
    325325     */
     
    346346     *       regarding to context
    347347     *
    348      * @param  array $upload_dir The original Uploads dir.
     348     * @param array $upload_dir The original Uploads dir.
    349349     * @return array The upload directory data.
    350350     */
     
    523523     * Get full data for an image
    524524     *
    525      * @since  2.4.0
    526      *
    527      * @param  string $file Absolute path to the uploaded image.
     525     * @since 2.4.0
     526     *
     527     * @param string $file Absolute path to the uploaded image.
    528528     * @return bool|array   An associate array containing the width, height and metadatas.
    529529     *                      False in case an important image attribute is missing.
     
    575575         * Filter here to add/remove/edit data to the image full data
    576576         *
    577          * @since  2.4.0
     577         * @since 2.4.0
    578578         *
    579          * @param  array $image_data An associate array containing the width, height and metadatas.
     579         * @param array $image_data An associate array containing the width, height and metadatas.
    580580         */
    581581        return apply_filters( 'bp_attachments_get_image_data', $image_data );
     
    585585     * Edit an image file to resize it or rotate it
    586586     *
    587      * @since  2.4.0
     587     * @since 2.4.0
    588588     *
    589589     * @param string $attachment_type The attachment type (eg: avatar or cover_image). Required.
Note: See TracChangeset for help on using the changeset viewer.