SCF_Rest_Types_Endpoint
目录
- Methods
- __construct
- is_valid_source
- request_has_permission
- filter_types_request
- filter_post_type
- get_source_post_types
- register_extra_fields
- get_scf_fields
- get_scf_post_id
- get_field_schema
- register_parameters
- get_source_param_definition
- add_parameter_to_endpoints
- add_collection_params
- clean_types_response
Class SCF_Rest_Types_Endpoint
- Extends the /wp/v2/types endpoint to include SCF fields and source filtering.
- @since SCF 6.5.0
Methods
__construct
Initialize the class and register hooks.
- @since SCF 6.5.0
- @since 6.7.0 Simplified hook registration.
is_valid_source
Validate source parameter.
- @since 6.7.0
- @param string $source The source value to validate.
- @return bool True if valid, false otherwise.
request_has_permission
Checks whether the matched REST route permits the request.
- @since SCF 6.8.0
- @param array $handler The matched REST route handler.
- @param WP_REST_Request $request The request object.
- @return bool True when the route permission callback allows the request.
filter_types_request
Filter post types requests for individual post type requests.
- @since SCF 6.5.0
- @since 6.7.0 Use is_valid_source() helper method.
- @param mixed $response The current response.
- @param array $handler The handler for the route.
- @param WP_REST_Request $request The request object.
- @return mixed The response or WP_Error.
filter_post_type
Filter individual post type in the response.
- @since SCF 6.5.0
- @since 6.7.0 Use is_valid_source() helper method.
- @param WP_REST_Response $response The response object.
- @param WP_Post_Type $post_type The post type object.
- @param WP_REST_Request $request The request object.
- @return WP_REST_Response|null The filtered response or null.
get_source_post_types
Get post types for a specific source.
- @since SCF 6.5.0
- @param string $source The source to get post types for (core, scf, other).
- @return array An array of post type names for the specified source.
register_extra_fields
Register extra SCF fields for the post types endpoint.
- @since SCF 6.5.0
- @return void
get_scf_fields
Get SCF fields for a post type.
- @since SCF 6.5.0
- @param array $post_type_object The post type object.
- @return array Array of field data.
get_scf_post_id
Get the SCF internal post ID for a post type.
- Only exposed to users who can edit the post type definition, so that consumers (e.g. Command Palette commands) can rely on its presence as a capability check.
- @since SCF 6.8.3
- @param array $post_type_object The post type object.
- @return int|null The post ID if managed by SCF and editable by the current user, null otherwise.
get_field_schema
Get the schema for the SCF fields.
- @since SCF 6.5.0
- @return array The schema for the SCF fields.
register_parameters
Register the source parameter for the post types endpoint.
- @since SCF 6.5.0
get_source_param_definition
Get the source parameter definition
- @since SCF 6.5.0
- @since 6.7.0 Use VALID_SOURCES constant.
- @return array Parameter definition
add_parameter_to_endpoints
Add source parameter directly to the endpoints for proper documentation
- @since SCF 6.5.0
- @param array $endpoints The REST API endpoints.
- @return array Modified endpoints
add_collection_params
Add source parameter to the collection parameters for the types endpoint.
- @since SCF 6.5.0
- @param array $query_params JSON Schema-formatted collection parameters.
- @return array Modified collection parameters.
clean_types_response
Clean up null entries from the response
- @since SCF 6.5.0
- @param array $response The response data.
- @param WP_REST_Server $server The REST server instance.
- @param WP_REST_Request $request The original request.
- @return array The filtered response data.