Guide

Report Package REST fields

Read-only REST fields registered on post types (see source for which types get each field). There is no separate custom route namespace; consumers read these on core post responses. Source: includes/class-rest-api.php.

Field index

FieldTypical post typesPayload
table_of_contentsPublic post typesOrdered chapters from get_package_chapters()
report_materialspostMaterials from get_package_materials()
report_paginationpost{ current_post, next_post, previous_post, pagination_items }
parent_infopost{ parent_id, parent_title } for children

Package meta (multiSectionReport, reportMaterials, package_parts, package_parts__enabled) is also registered on post with show_in_rest and revisions enabled.

Was this helpful?