Get CubeWP

Docy

How to Get Data Using WP Rest API in CubeWP?

Estimated reading: 5 minutes 622 views
CubeWP allows users to view and manage custom fields via the WordPress REST API. This allows developers to access and edit their custom field data using default WP REST API endpoints

Enable Your Rest API for your Custom Fields

By default, custom fields are not visible in the WP REST API. You must turn it on if you want them to show in the WP REST API. You can enable REST API data for a specific field while creating a field.

What values do you access in CubeWP with WP Rest API?

We are using the default WordPress API in CubeWP, and we extend the default WordPress options get_post_meta and update_post_meta in cubewp_post_meta.
As we are using WP Rest API and rendering the data, users can use the below arguments to get the data.
get_taxonomies -> taxonomies
get_user_meta -> cubewp_user_meta
get_term_meta -> cubewp_term_meta
The WP Rest API exposes various endpoints and parameters to get and update the data. Among these parameters, fields_type, field_name, and post_id are essential for extracting custom field data from CubeWP Custom Fields. 
"cubewp_post_meta":{
      "cwp_field_845583830869":{
         "type":"number",
         "meta_key":"cwp_field_845583830869",
         "meta_value":"76",
         "label":"Property Size"
      },
      "cwp_field_671099090382":{
         "type":"number",
         "meta_key":"cwp_field_671099090382",
         "meta_value":"166",
         "label":"Price"
      },
      "cwp_field_605099778660":{
         "type":"google_address",
         "meta_key":"cwp_field_605099778660",
         "meta_value":{
            "address":"",
            "lat":"",
            "lng":""
         },
         "label":"Plot location"
      },
      "cwp_field_569484225099":{
         "type":"dropdown",
         "meta_key":"cwp_field_569484225099",
         "meta_value":"Hostel",
         "label":"Property Type"
      },
      "cwp_field_353853771873":{
         "type":"number",
         "meta_key":"cwp_field_353853771873",
         "meta_value":"1974",
         "label":"Year in built"
      },
      "cwp_field_740709386705":{
         "type":"dropdown",
         "meta_key":"cwp_field_740709386705",
         "meta_value":"6",
         "label":"Bedroom"
      },
      "cwp_field_740709386705356085c78c":{
         "type":"dropdown",
         "meta_key":"cwp_field_740709386705356085c78c",
         "meta_value":"3",
         "label":"Bathrooms"
      },
      "cwp_field_740709386705356085f69d":{
         "type":"dropdown",
         "meta_key":"cwp_field_740709386705356085f69d",
         "meta_value":"3",
         "label":"Car Parking"
      },
      "cwp_field_183772329365":{
         "type":"gallery",
         "meta_key":"cwp_field_183772329365",
         "meta_value":"",
         "label":"Property Images"
      },
      "cwp-gender":{
         "type":"radio",
         "meta_key":"cwp-gender",
         "meta_value":"Male",
         "label":"Gender"
      },
      "cwp_field_574701259039":{
         "type":"number",
         "meta_key":"cwp_field_574701259039",
         "meta_value":"",
         "label":"paternity leaves"
      },
      "cwp_field_816102110789":{
         "type":"text",
         "meta_key":"cwp_field_816102110789",
         "meta_value":"Voluptatem odit sint",
         "label":"male dependent"
      }
   },

Custom routes to fetch Custom Fields and their render values

For all custom fields of custom post type or user custom fields by field type.

site_url/wp-json/cubewp-custom-fields/v1/custom_fields?fields_type={fields_type_value}&fields_source={custom_post_type_slug}&fields_input_type={field_type}
This route is used to fetch all custom fields of custom post type or user custom fields by field type.

Parameters:

fields_type{fields_type_value}:

  • Developers can replace {fields_type_value} with either post_custom_fields or user_custom_fields based on their requirements.
  • Choosing post_custom_fields instructs the API to retrieve custom fields associated with posts, while user_custom_fields would fetch custom fields linked to user profiles.

fields_source{custom_post_type_slug}:

  • The {custom_post_type_slug} placeholder represents the slug of a custom post type created using CubeWP Custom Fields.
  • By specifying the slug of a custom post type, developers can target custom fields associated specifically with that post type.
fields_input_type{fields_type}:
  • Replace {field_type} with the desired input type of the custom fields, such as text, dropdown, number, radio, or checkbox.

To fetch the value of custom fields from posts:

site_url/wp-json/cubewp-custom-fields/v1/custom_fields?fields_type={fields_type_value}&fields_source={custom_post_type_slug}&fields_input_type={field_type}

Parameters:

fields_type:

The fields_type parameter specifies the type of fields to retrieve from the CubeWP Custom Fields plugin. In the context of CubeWP, this parameter can have two main values:

  • post_custom_fields: This value instructs the API to retrieve custom fields associated with a specific post.
  • user_custom_fields: Alternatively, if CubeWP extends its functionality to user profiles, this value could retrieve custom fields associated with user profiles.

field_name:

The field_name parameter allows developers to specify the name of the custom field they want to extract. CubeWP Custom Fields enables users to create and manage custom fields with unique identifiers. By providing the field_name parameter, developers can retrieve the value of a specific custom field associated with a post or user.

post_id:

The post_id parameter specifies the ID of the post from which custom field data should be retrieved. Each post in WordPress has a unique numerical identifier, and providing this ID ensures that the API fetches custom field data for the specified post.


/wp-json/cubewp-custom-fields/v1/render?fields_type=post_custom_fields&field_name=cwp_field_845583830869&post_id=113

In this example:

  • fields_type is set to post_custom_fields, indicating that we want to retrieve custom fields associated with a post.
  • field_name is specified as cwp_field_845583830869, denoting the unique identifier of the custom field we’re interested in.
  • post_id is set to 113, indicating the specific post from which we want to fetch the custom field data.

Share this Doc
CONTENTS