Changeset 9712 for trunk/src/bp-xprofile/bp-xprofile-functions.php

Timestamp:

04/07/2015 12:58:09 AM (10 years ago)

Author:

boonebgorges

Message:

Documentation improvements for xprofile_insert_field().

File:

• trunk/src/bp-xprofile/bp-xprofile-functions.php (modified) (1 diff)

trunk/src/bp-xprofile/bp-xprofile-functions.php

@@ -190 +190 @@
 
 /**
- * Insert an xprofile field.
+ * Insert or update an xprofile field.
  *
  * @param array $args {
  *     Array of arguments.
- *     @type int $field_id Optional. Pass the ID of an existing field to edit
- *           that field.
- *     @type int $field_group_id ID of the associated field group.
- *     @type int $parent_id Optional. ID of the parent field.
- *     @type string $type Field type. Checked against a field_types whitelist.
- *     @type string $name Name of the new field.
- *     @type string $description Optional. Descriptive text for the field.
- *     @type bool $is_required Optional. Whether users must provide a value for
- *           the field. Default: false.
- *     @type bool $can_delete Optional. Whether admins can delete this field in
- *           the Dashboard interface. Generally this is true only for the Name
- *           field, which is required throughout BP. Default: true.
- *     @type string $order_by Optional. For field types that support options
- *           (such as 'radio'), this flag determines whether the sort order of
- *           the options will be 'default' (order created) or 'custom'.
- *     @type bool $is_default_option Optional. For the 'option' field type,
- *           setting this value to true means that it'll be the default value
- *           for the parent field when the user has not yet overridden.
- *     @type int $option_order Optional. For the 'option' field type, this
- *           determines the order in which the options appear.
+ *     @type int    $field_id          Optional. Pass the ID of an existing field to edit that field.
+ *     @type int    $field_group_id    ID of the associated field group.
+ *     @type int    $parent_id         Optional. ID of the parent field.
+ *     @type string $type              Field type. Checked against a field_types whitelist.
+ *     @type string $name              Name of the new field.
+ *     @type string $description       Optional. Descriptive text for the field.
+ *     @type bool   $is_required       Optional. Whether users must provide a value for the field. Default: false.
+ *     @type bool   $can_delete        Optional. Whether admins can delete this field in the Dashboard interface.
+ *                                     Generally this is false only for the Name field, which is required throughout BP.
+ *                                     Default: true.
+ *     @type string $order_by          Optional. For field types that support options (such as 'radio'), this flag
+ *                                     determines whether the sort order of the options will be 'default'
+ *                                     (order created) or 'custom'.
+ *     @type bool   $is_default_option Optional. For the 'option' field type, setting this value to true means that
+ *                                     it'll be the default value for the parent field when the user has not yet
+ *                                     overridden. Default: true.
+ *     @type int    $option_order      Optional. For the 'option' field type, this determines the order in which the
+ *                                     options appear.
  * }
  * @return bool|int False on failure, ID of new field on success.