Skip to:
Content

BuddyPress.org

Changeset 10418


Ignore:
Timestamp:
12/22/2015 05:33:22 AM (5 years ago)
Author:
tw2113
Message:

Scrutinizr feedback cleanup.

See #6406.

Location:
trunk/src/bp-xprofile
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-xprofile/bp-xprofile-admin.php

    r10417 r10418  
    758758     * @since 2.0.0
    759759     *
    760      * @param int    $user_id       ID of the user being edited.
    761      * @param string $screen_id     Screen ID to load the metabox in.
    762      * @param object $stats_metabox Context and priority for the stats metabox.
     760     * @param int         $user_id       ID of the user being edited.
     761     * @param string      $screen_id     Screen ID to load the metabox in.
     762     * @param object|null $stats_metabox Context and priority for the stats metabox.
    763763     */
    764764    public function register_metaboxes( $user_id = 0, $screen_id = '', $stats_metabox = null ) {
     
    960960     * @since 2.0.0
    961961     *
    962      * @param WP_User $user The WP_User object for the user being edited.
    963      * @param array   $args Aray of arguments for metaboxes.
     962     * @param WP_User|null $user The WP_User object for the user being edited.
     963     * @param array        $args Aray of arguments for metaboxes.
    964964     */
    965965    public function user_admin_profile_metaboxes( $user = null, $args = array() ) {
     
    10711071     * @since 2.0.0
    10721072     *
    1073      * @param WP_User $user The WP_User object for the user being edited.
     1073     * @param WP_User|null $user The WP_User object for the user being edited.
    10741074     */
    10751075    public function user_admin_spammer_metabox( $user = null ) {
     
    10841084     * @since 2.0.0
    10851085     *
    1086      * @param WP_User $user The WP_User object for the user being edited.
     1086     * @param WP_User|null $user The WP_User object for the user being edited.
    10871087     */
    10881088    public function user_admin_avatar_metabox( $user = null ) {
  • trunk/src/bp-xprofile/bp-xprofile-filters.php

    r10417 r10418  
    115115 * Run profile field values through kses with filterable allowed tags.
    116116 *
    117  * @param string $content  Content to filter.
    118  * @param object $data_obj The BP_XProfile_ProfileData object.
     117 * @param string      $content  Content to filter.
     118 * @param object|null $data_obj The BP_XProfile_ProfileData object.
    119119 *
    120120 * @return string $content
     
    155155 * Safely runs profile field data through kses and force_balance_tags.
    156156 *
    157  * @param string $field_value Field value being santized.
    158  * @param int    $field_id    Field ID being sanitized.
    159  * @param bool   $reserialize Whether to reserialize arrays before returning. Defaults to true.
    160  * @param object $data_obj    The BP_XProfile_ProfileData object.
     157 * @param string      $field_value Field value being santized.
     158 * @param int         $field_id    Field ID being sanitized.
     159 * @param bool        $reserialize Whether to reserialize arrays before returning. Defaults to true.
     160 * @param object|null $data_obj    The BP_XProfile_ProfileData object.
    161161 *
    162162 * @return string
     
    240240 * @since 2.4.0 Added `$field_id` parameter.
    241241 *
    242  * @param mixed  $field_value Field value.
    243  * @param string $field_type  Field type.
    244  * @param int    $field_id    Optional. ID of the field.
     242 * @param mixed      $field_value Field value.
     243 * @param string     $field_type  Field type.
     244 * @param string|int $field_id    Optional. ID of the field.
    245245 *
    246246 * @return mixed
  • trunk/src/bp-xprofile/bp-xprofile-functions.php

    r10417 r10418  
    667667 * @param int    $user_id   The user ID. Optional.
    668668 *
    669  * @return array() Array containing the path, URL, and other helpful settings.
     669 * @return array Array containing the path, URL, and other helpful settings.
    670670 */
    671671function xprofile_avatar_upload_dir( $directory = 'avatars', $user_id = 0 ) {
     
    10281028 * @since 2.4.0
    10291029 *
    1030  * @param int $field_id Optional. Default current field ID.
     1030 * @param int|null $field_id Optional. Default current field ID.
    10311031 * @return bool
    10321032 */
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-datebox.php

    r10417 r10418  
    308308     * @since 2.4.0 Added the `$field_id` parameter.
    309309     *
    310      * @param string $field_value The date value, as saved in the database. Typically, this is a MySQL-formatted
    311      *                            date string (Y-m-d H:i:s).
    312      * @param int    $field_id    Optional. ID of the field.
     310     * @param string     $field_value The date value, as saved in the database. Typically, this is a MySQL-formatted
     311     *                                date string (Y-m-d H:i:s).
     312     * @param string|int $field_id    Optional. ID of the field.
    313313     *
    314314     * @return string Date formatted by bp_format_time().
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-url.php

    r10417 r10418  
    129129     * @since 2.4.0 Added the `$field_id` parameter.
    130130     *
    131      * @param string $submitted_value Raw value submitted by the user.
    132      * @param int    $field_id        Optional. ID of the field.
     131     * @param string     $submitted_value Raw value submitted by the user.
     132     * @param string|int $field_id        Optional. ID of the field.
    133133     *
    134134     * @return string
     
    159159     * @since 2.4.0 Added the `$field_id` parameter.
    160160     *
    161      * @param string $field_value The URL value, as saved in the database.
    162      * @param int    $field_id    Optional. ID of the field.
     161     * @param string     $field_value The URL value, as saved in the database.
     162     * @param string|int $field_id    Optional. ID of the field.
    163163     *
    164164     * @return string URL converted to a link.
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type.php

    r10417 r10418  
    119119     * @param string $replace_format Optional; if 'replace', replaces the format instead of adding to it.
    120120     *                               Defaults to 'add'.
    121      *
    122121     * @return BP_XProfile_Field_Type
    123122     */
     
    154153     *
    155154     * @param string|array $values Whitelisted values.
    156      *
    157155     * @return BP_XProfile_Field_Type
    158156     */
     
    183181     *
    184182     * @param string|array $values Value to check against the registered formats.
    185      *
    186183     * @return bool True if the value validates
    187184     */
     
    236233     *
    237234     * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
     235     * @return void
    238236     */
    239237    abstract public function edit_field_html( array $raw_properties = array() );
     
    244242     * Must be used inside the {@link bp_profile_fields()} template loop.
    245243     *
     244     * @since 2.0.0
     245     *
    246246     * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    247      * @since 2.0.0
     247     * @return void
    248248     */
    249249    abstract public function admin_field_html( array $raw_properties = array() );
     
    419419     * @since 2.4.0 Added the `$field_id` parameter.
    420420     *
    421      * @param mixed $field_value Submitted field value.
    422      * @param int   $field_id    Optional. ID of the field.
    423      *
     421     * @param mixed      $field_value Submitted field value.
     422     * @param string|int $field_id    Optional. ID of the field.
    424423     * @return mixed
    425424     */
     
    438437     * @since 2.4.0 Added `$field_id` parameter.
    439438     *
    440      * @param mixed $field_value Field value.
    441      * @param int   $field_id    ID of the field.
    442      *
     439     * @param mixed      $field_value Field value.
     440     * @param string|int $field_id    ID of the field.
    443441     * @return mixed
    444442     */
     
    458456     *
    459457     * @param array $properties Optional key/value array of attributes for this edit field.
    460      *
    461458     * @return string
    462459     */
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

    r10417 r10418  
    196196     * @global object $userdata
    197197     *
    198      * @param int  $id Field ID.
    199      * @param int  $user_id User ID.
    200      * @param bool $get_data Get data.
     198     * @param int      $id Field ID.
     199     * @param int|null $user_id User ID.
     200     * @param bool     $get_data Get data.
    201201     */
    202202    public function populate( $id, $user_id = null, $get_data = true ) {
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-meta-query.php

    r10417 r10418  
    9797     * @since 2.3.0
    9898     *
    99      * @param string $type              Type of meta, eg 'user', 'post'.
    100      * @param string $primary_table     Database table where the object being filtered is stored (eg wp_users).
    101      * @param string $primary_id_column ID column for the filtered object in $primary_table.
    102      * @param object $context           Optional. The main query object.
     99     * @param string      $type              Type of meta, eg 'user', 'post'.
     100     * @param string      $primary_table     Database table where the object being filtered is stored (eg wp_users).
     101     * @param string      $primary_id_column ID column for the filtered object in $primary_table.
     102     * @param object|null $context           Optional. The main query object.
    103103     *
    104104     * @return array {
Note: See TracChangeset for help on using the changeset viewer.