Automattic\WooCommerce\Admin\API

ProductForm{} │ WC 1.0

ProductForm Controller.

No Hooks.

Usage

$ProductForm = new ProductForm();
// use class methods

Methods

1. public get_fields( $request )
2. public get_form_config( $request )
3. public get_product_form_permission_check( $request )
4. public register_routes()

ProductForm{} ProductForm{} code ^{WC 10.7.0}

class ProductForm extends \WC_REST_Data_Controller {
	/**
	 * Endpoint namespace.
	 *
	 * @var string
	 */
	protected $namespace = 'wc-admin';

	/**
	 * Route base.
	 *
	 * @var string
	 */
	protected $rest_base = 'product-form';

	/**
	 * Register routes.
	 */
	public function register_routes() {
		register_rest_route(
			$this->namespace,
			'/' . $this->rest_base,
			array(
				array(
					'methods'             => \WP_REST_Server::READABLE,
					'callback'            => array( $this, 'get_form_config' ),
					'permission_callback' => array( $this, 'get_product_form_permission_check' ),
				),
				'schema' => array( $this, 'get_public_item_schema' ),
			)
		);
		register_rest_route(
			$this->namespace,
			'/' . $this->rest_base . '/fields',
			array(
				array(
					'methods'             => \WP_REST_Server::READABLE,
					'callback'            => array( $this, 'get_fields' ),
					'permission_callback' => array( $this, 'get_product_form_permission_check' ),
				),
				'schema' => array( $this, 'get_public_item_schema' ),
			)
		);
	}

	/**
	 * Check if a given request has access to manage woocommerce.
	 *
	 * @param  WP_REST_Request $request Full details about the request.
	 * @return WP_Error|boolean
	 */
	public function get_product_form_permission_check( $request ) {
		if ( ! current_user_can( 'manage_woocommerce' ) ) {
			return new \WP_Error( 'woocommerce_rest_cannot_create', __( 'Sorry, you are not allowed to retrieve product form data.', 'woocommerce' ), array( 'status' => rest_authorization_required_code() ) );
		}

		return true;
	}

	/**
	 * Get the form fields.
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return WP_REST_Response|WP_Error
	 */
	public function get_fields( $request ) {
		$json = array_map(
			function( $field ) {
				return $field->get_json();
			},
			FormFactory::get_fields()
		);

		return rest_ensure_response( $json );
	}

	/**
	 * Get the form config.
	 *
	 * @param WP_REST_Request $request Full details about the request.
	 * @return WP_REST_Response|WP_Error
	 */
	public function get_form_config( $request ) {
		$fields      = array_map(
			function( $field ) {
				return $field->get_json();
			},
			FormFactory::get_fields()
		);
		$subsections = array_map(
			function( $subsection ) {
				return $subsection->get_json();
			},
			FormFactory::get_subsections()
		);
		$sections    = array_map(
			function( $section ) {
				return $section->get_json();
			},
			FormFactory::get_sections()
		);
		$tabs        = array_map(
			function( $tab ) {
				return $tab->get_json();
			},
			FormFactory::get_tabs()
		);

		return rest_ensure_response(
			array(
				'fields'      => $fields,
				'subsections' => $subsections,
				'sections'    => $sections,
				'tabs'        => $tabs,
			)
		);
	}
}