Skip to:
Content

BuddyPress.org

Ticket #6789: 6789.docs.02.patch

File 6789.docs.02.patch, 2.2 KB (added by Offereins, 2 years ago)

Filter docs for BP_XProfile_ProfileData::save

  • src/bp-xprofile/classes/class-bp-xprofile-profiledata.php

    diff --git a/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php b/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php
    index 62603e7..4ad7a6c 100644
    a b class BP_XProfile_ProfileData { 
    184184
    185185                $bp = buddypress();
    186186
    187                 $this->user_id      = apply_filters( 'xprofile_data_user_id_before_save',      $this->user_id,         $this->id );
    188                 $this->field_id     = apply_filters( 'xprofile_data_field_id_before_save',     $this->field_id,        $this->id );
    189                 $this->value        = apply_filters( 'xprofile_data_value_before_save',        $this->value,           $this->id, true, $this );
     187                /**
     188                 * Filters the data's user ID before saving to the database.
     189                 *
     190                 * @since 1.0.0
     191                 *
     192                 * @param int $user_id The user ID.
     193                 * @param int $data_id The field data ID.
     194                 */
     195                $this->user_id = apply_filters( 'xprofile_data_user_id_before_save', $this->user_id, $this->id );
     196
     197                /**
     198                 * Filters the data's field ID before saving to the database.
     199                 *
     200                 * @since 1.0.0
     201                 *
     202                 * @param int $field_id The field ID.
     203                 * @param int $data_id  The field data ID.
     204                 */
     205                $this->field_id = apply_filters( 'xprofile_data_field_id_before_save', $this->field_id, $this->id );
     206
     207                /**
     208                 * Filters the data's value before saving to the database.
     209                 *
     210                 * @since 1.0.0
     211                 *
     212                 * @param string                  $field_value The field value.
     213                 * @param int                     $data_id     The field data ID.
     214                 * @param bool                    $reserialize Whether to reserialize the array before returning. Defaults to true.
     215                 * @param BP_XProfile_ProfileData $data_obj    The current field data object.
     216                 */
     217                $this->value = apply_filters( 'xprofile_data_value_before_save', $this->value, $this->id, true, $this );
     218
     219                /**
     220                 * Filters the data's last updated timestamp before saving to the database.
     221                 *
     222                 * @since 1.0.0
     223                 *
     224                 * @param int $last_updated The last updated timestamp.
     225                 * @param int $data_id      The field data ID.
     226                 */
    190227                $this->last_updated = apply_filters( 'xprofile_data_last_updated_before_save', bp_core_current_time(), $this->id );
    191228
    192229                /**