• Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar
  • Skip to footer
WooCommerce a2z

WooCommerce a2z

WooCommerce

  • Home
  • Plugins
  • Blocks
  • Shortcodes
  • APIs
  • Classes
  • Files
  • Hooks
  • Sitemap
  • Blog
Home / APIs / Controller::get_export_public_schema() – Get the Report Export’s schema, conforming to JSON Schema.

You appear to be a bot. Output may be restricted

Description

Get the Report Export's schema, conforming to JSON Schema.

Usage

$array = Controller::get_export_public_schema();

Parameters

Returns

array

Source

File name: woocommerce/packages/woocommerce-admin/src/API/Reports/Export/Controller.php


Lines:

1 to 30 of 30
  public function get_export_public_schema() {
    $schema = array(
      '$schema'    => 'http://json-schema.org/draft-04/schema#',
      'title'      => 'report_export',
      'type'       => 'object',
      'properties' => array(
        'status'    => array(
          'description' => __( 'Export status.', 'woocommerce' ),
          'type'        => 'string',
          'context'     => array( 'view', 'edit' ),
          'readonly'    => true,
        ),
        'message'   => array(
          'description' => __( 'Export status message.', 'woocommerce' ),
          'type'        => 'string',
          'context'     => array( 'view', 'edit' ),
          'readonly'    => true,
        ),
        'export_id' => array(
          'description' => __( 'Export ID.', 'woocommerce' ),
          'type'        => 'string',
          'context'     => array( 'view', 'edit' ),
          'readonly'    => true,
        ),
      ),
    );

    return $this->add_additional_fields_schema( $schema );
  }
 

 View on GitHub View on Trac

Published: 6th April 2020 | Last updated: 10th December 2020

Primary Sidebar

Information

Function name: Controller::get_export_public_schema
Class ref: Controller
Plugin ref: WooCommerce
Version: 5.2.2
Sourcefile: packages/woocommerce-admin/src/API/Reports/Export/Controller.php
File ref: packages/woocommerce-admin/src/API/Reports/Export/Controller.php
Deprecated?: No
API Letters: C,E,G,P,S

Footer

WooCommerce a2z
WooCommerce a2z
WooCommerce
WordPress 5.7.1
WordPress a2z
WordPress core a2z
Genesis Theme Framework a2z
Jetpack a2z
WordPress develop tests
Easy Digital Downloads a2z
WooCommerce a2z
Yoast SEO a2z
WordPress Blocks

Site:  woocommerce.wp-a2z.org
© Copyright WooCommerce a2z 2014-2021. All rights reserved.


Website designed and developed by Herb Miller
Proudly powered by WordPress and oik plugins

  • Home
  • Blog
  • Sitemap
  • Sites