WordPress.org
Get WordPress

Make WordPress Core

Opened 10 years ago

Closed 10 years ago

Last modified 10 years ago

#39023 closed task (blessed) (fixed)

REST API: show_in_rest property missing from the register_post_type() and register_taxonomy() args docblocks

Reported by: johnbillion Owned by: pento
Priority: normal Milestone: 4.7
Component: REST API Version: 4.7
Severity: normal Keywords: has-patch commit dev-reviewed
Cc: Focuses: docs, rest-api

Description

[38832] (#38373) introduced a show_in_rest property for post types and taxonomies. This property is not documented in the args docblocks of the register_post_type() and register_taxonomy() functions.

Attachments (2)

39023.patch​ (1.9 KB ) - added by ketuchetan 10 years ago.
39023.2.patch​ (20.7 KB ) - added by rahulsprajapati 10 years ago.
Add args docblocks of the register_post_type() and register_taxonomy() for 'show_in_rest', 'rest_base', and 'rest_controller_class' arguments.

Download all attachments as: .zip

Change History (12)

#1 @ketuchetan
10 years ago

  • Keywords has-patch added; needs-patch removed

Hi @johnbillion

I have added my patch can you please look into it and please let me know if I understand the ticket correctly or not.

If I am wrong then please can you please tell me the more description about this ticket please.

Thanks,
Chetan

@ketuchetan
10 years ago

@rahulsprajapati
10 years ago

Add args docblocks of the register_post_type() and register_taxonomy() for 'show_in_rest', 'rest_base', and 'rest_controller_class' arguments.

#2 @rahulsprajapati
10 years ago

@johnbillion
There are 'rest_base', and 'rest_controller_class' arguments also missing from arg docblock.
I've added in 39023.2.

#3 @rahulsprajapati
10 years ago

  • Keywords needs-docs removed

#4 @pento
10 years ago

  • Keywords dev-feedback commit added

This looks good to me. @DrewAPicture, could you confirm that you're cool with the whitespace changes?

#5 @johnbillion
10 years ago

  • Summary show_in_rest property missing from the register_post_type() and register_taxonomy() args docblocks → REST API: show_in_rest property missing from the register_post_type() and register_taxonomy() args docblocks

This ticket was mentioned in ​Slack in #core by chetansatasiya. ​View the logs.
10 years ago

#7 @nacin
10 years ago

  • Keywords dev-reviewed added; dev-feedback removed

#8 @pento
10 years ago

  • Owner set to pento
  • Status new → assigned

#9 @pento
10 years ago

  • Resolution → fixed
  • Status assigned → closed

In 39462:

Docs: Add missing REST API-related args to register_post_type() and register_taxonomy().

These functions now accept the show_in_rest, rest_base, and rest_controller_class args.

Props ketuchetan, rahulsprajapati.
Fixes #39023.

#10 @pento
10 years ago

In 39463:

Docs: Add missing REST API-related args to register_post_type() and register_taxonomy().

These functions now accept the show_in_rest, rest_base, and rest_controller_class args.

Merges [39462] to the 4.7 branch.

Props ketuchetan, rahulsprajapati.
Fixes #39023.

Note: See TracTickets for help on using tickets.