XProfile_Field

Manage XProfile Fields.


Source Source

File: cli/src/xprofile-field.php

class XProfile_Field extends BuddyPressCommand {

	/**
	 * XProfile object fields.
	 *
	 * @var array
	 */
	protected $obj_fields = array(
		'id',
		'name',
		'description',
		'type',
		'group_id',
		'is_required',
	);

	/**
	 * Get a list of XProfile fields.
	 *
	 * ## OPTIONS
	 *
	 * [--<field>=<value>]
	 * : One or more parameters to pass. See bp_xprofile_get_groups()
	 *
	 * ## EXAMPLE
	 *
	 *     $ wp bp xprofile field list
	 *
	 * @subcommand list
	 */
	public function list_( $args, $assoc_args ) { // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore
		$args = array_merge(
			$assoc_args,
			array(
				'fields'       => 'id,name',
				'fetch_fields' => true,
			)
		);

		$fields = array();
		$groups = bp_xprofile_get_groups( $args );

		// Reformat so that field_group_id is a property of fields.
		foreach ( $groups as $group ) {
			foreach ( $group->fields as $field ) {
				$fields[ $field->id ] = $field;
			}
		}

		ksort( $fields );

		$this->get_formatter( $assoc_args )->display_items( $fields );
	}

	/**
	 * Create an XProfile field.
	 *
	 * ## OPTIONS
	 *
	 * [--type=<type>]
	 * : Field type.
	 * ---
	 * default: textbox
	 * ---
	 *
	 * --field-group-id=<field-group-id>
	 * : ID of the field group where the new field will be created.
	 *
	 * --name=<name>
	 * : Name of the new field.
	 *
	 * [--porcelain]
	 * : Output just the new field id.
	 *
	 * ## EXAMPLES
	 *
	 *     $ wp bp xprofile field create --type=checkbox --field-group-id=508 --name="Field Name"
	 *     Success: Created XProfile field "Field Name" (ID 24564).
	 *
	 *     $ wp bp xprofile field add --field-group-id=165 --name="Another Field"
	 *     Success: Created XProfile field "Another Field" (ID 5465).
	 *
	 * @alias add
	 */
	public function create( $args, $assoc_args ) {
		// Check this is a non-empty, valid field type.
		if ( ! in_array( $assoc_args['type'], (array) buddypress()->profile->field_types, true ) ) {
			WP_CLI::error( 'Not a valid field type.' );
		}

		$create_args = array(
			'type'           => $assoc_args['type'],
			'name'           => $assoc_args['name'],
			'field_group_id' => $assoc_args['field-group-id'],
		);

		$field_id = xprofile_insert_field( $create_args );
		if ( ! $field_id ) {
			WP_CLI::error( 'Could not create XProfile field.' );
		}

		if ( WP_CLI\Utils\get_flag_value( $assoc_args, 'porcelain' ) ) {
			WP_CLI::log( $field_id );
		} else {
			$field = new \BP_XProfile_Field( $field_id );

			WP_CLI::success(
				sprintf(
					'Created XProfile field "%s" (ID %d).',
					$field->name,
					$field->id
				)
			);
		}
	}

	/**
	 * Get an XProfile field.
	 *
	 * ## OPTIONS
	 *
	 * <field-id>
	 * : Identifier for the field. Accepts either the name of the field or a numeric ID.
	 *
	 * [--fields=<fields>]
	 * : Limit the output to specific fields.
	 *
	 * [--format=<format>]
	 * : Render output in a particular format.
	 *  ---
	 * default: table
	 * options:
	 *   - table
	 *   - json
	 *   - haml
	 * ---
	 *
	 * ## EXAMPLES
	 *
	 *     $ wp bp xprofile field get 500
	 *     $ wp bp xprofile field see 56 --format=json
	 *
	 * @alias see
	 */
	public function get( $args, $assoc_args ) {
		$field_id = $this->get_field_id( $args[0] );
		$object   = xprofile_get_field( $field_id );

		if ( empty( $object->id ) && ! is_object( $object ) ) {
			WP_CLI::error( 'No XProfile field found.' );
		}

		$object_arr = get_object_vars( $object );
		if ( empty( $assoc_args['fields'] ) ) {
			$assoc_args['fields'] = array_keys( $object_arr );
		}

		$this->get_formatter( $assoc_args )->display_item( $object_arr );
	}

	/**
	 * Delete an XProfile field.
	 *
	 * ## OPTIONS
	 *
	 * <field-id>...
	 * : ID or IDs for the field. Accepts either the name of the field or a numeric ID.
	 *
	 * [--delete-data]
	 * : Delete user data for the field as well.
	 *
	 * [--yes]
	 * : Answer yes to the confirmation message.
	 *
	 * ## EXAMPLES
	 *
	 *     $ wp bp xprofile field delete 500 --yes
	 *     Success: Deleted XProfile field "Field Name" (ID 500).
	 *
	 *     $ wp bp xprofile field remove 458 --delete-data --yes
	 *     Success: Deleted XProfile field "Another Field Name" (ID 458).
	 *
	 * @alias remove
	 */
	public function delete( $args, $assoc_args ) {
		$delete_data = WP_CLI\Utils\get_flag_value( $assoc_args, 'delete-data' );

		WP_CLI::confirm( 'Are you sure you want to delete this field?', $assoc_args );

		parent::_delete( $args, $assoc_args, function( $field_id ) use ( $delete_data ) {
			$field = new \BP_XProfile_Field( $field_id );
			$name  = $field->name;
			$id    = $field->id;

			if ( $field->delete( $delete_data ) ) {
				return array( 'success', sprintf( 'Deleted XProfile field "%s" (ID %d).', $name, $id ) );
			} else {
				return array( 'error', sprintf( 'Failed deleting XProfile field (ID %d).', $field_id ) );
			}
		} );
	}
}

Methods Methods

  • create — Create an XProfile field.
  • delete — Delete an XProfile field.
  • get — Get an XProfile field.
  • list_ — Get a list of XProfile fields.

Top ↑

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.