field-fragments
6 months ago
fields
2 months ago
common.schema.json
6 months ago
field-group.schema.json
2 months ago
field.schema.json
6 months ago
internal-properties.schema.json
6 months ago
post-type.schema.json
2 months ago
scf-identifier.schema.json
6 months ago
taxonomy.schema.json
2 months ago
ui-options-page.schema.json
6 months ago
taxonomy.schema.json
457 lines
| 1 | { |
| 2 | "$schema": "http://json-schema.org/draft-07/schema#", |
| 3 | "$id": "https://raw.githubusercontent.com/WordPress/secure-custom-fields/trunk/schemas/taxonomy.schema.json", |
| 4 | "title": "SCF Taxonomy(s)", |
| 5 | "description": "Schema for Secure Custom Fields taxonomy definitions - accepts single object or array. Properties marked '[SCF Export Only]' are preserved during export but not used functionally during import.", |
| 6 | "oneOf": [ |
| 7 | { |
| 8 | "description": "Single taxonomy object", |
| 9 | "$ref": "#/definitions/taxonomy" |
| 10 | }, |
| 11 | { |
| 12 | "description": "Array of taxonomy objects (export format)", |
| 13 | "type": "array", |
| 14 | "items": { "$ref": "#/definitions/taxonomy" }, |
| 15 | "minItems": 1 |
| 16 | } |
| 17 | ], |
| 18 | "definitions": { |
| 19 | "taxonomy": { |
| 20 | "type": "object", |
| 21 | "required": [ "key", "title", "taxonomy" ], |
| 22 | "additionalProperties": false, |
| 23 | "properties": { |
| 24 | "key": { |
| 25 | "type": "string", |
| 26 | "pattern": "^taxonomy_.+$", |
| 27 | "minLength": 1, |
| 28 | "description": "Unique identifier for the taxonomy with taxonomy_ prefix (e.g. 'taxonomy_genre')" |
| 29 | }, |
| 30 | "title": { "$ref": "common.schema.json#/definitions/title" }, |
| 31 | "taxonomy": { |
| 32 | "type": "string", |
| 33 | "pattern": "^[a-z0-9_-]*$", |
| 34 | "minLength": 1, |
| 35 | "maxLength": 32, |
| 36 | "not": { |
| 37 | "$ref": "common.schema.json#/definitions/wordpressReservedTerms" |
| 38 | }, |
| 39 | "description": "The taxonomy key passed to register_taxonomy() (e.g. 'genre', 'product_tag'). Max 32 characters, lowercase letters/numbers/underscores/dashes only, cannot be WordPress reserved terms." |
| 40 | }, |
| 41 | |
| 42 | "menu_order": { "$ref": "common.schema.json#/definitions/menu_order" }, |
| 43 | "active": { "$ref": "common.schema.json#/definitions/active" }, |
| 44 | "advanced_configuration": { "$ref": "common.schema.json#/definitions/advanced_configuration" }, |
| 45 | "modified": { "$ref": "common.schema.json#/definitions/modified" }, |
| 46 | "import_source": { "$ref": "common.schema.json#/definitions/import_source" }, |
| 47 | "import_date": { "$ref": "common.schema.json#/definitions/import_date" }, |
| 48 | |
| 49 | "object_type": { |
| 50 | "type": "array", |
| 51 | "items": { "type": "string" }, |
| 52 | "uniqueItems": true, |
| 53 | "default": [], |
| 54 | "description": "Post types to which this taxonomy should be attached (e.g. ['post', 'page', 'book']). If empty, taxonomy exists but isn't usable from any post type." |
| 55 | }, |
| 56 | |
| 57 | "labels": { |
| 58 | "type": "object", |
| 59 | "description": "Labels for the taxonomy in various contexts. If omitted, WordPress auto-generates labels from 'title'.", |
| 60 | "additionalProperties": false, |
| 61 | "properties": { |
| 62 | "name": { |
| 63 | "type": "string", |
| 64 | "description": "General name for the taxonomy, usually plural" |
| 65 | }, |
| 66 | "singular_name": { |
| 67 | "type": "string", |
| 68 | "description": "Name for one object of this taxonomy" |
| 69 | }, |
| 70 | "menu_name": { |
| 71 | "type": "string", |
| 72 | "description": "The menu name text" |
| 73 | }, |
| 74 | "search_items": { |
| 75 | "type": "string", |
| 76 | "description": "The 'Search Items' text" |
| 77 | }, |
| 78 | "popular_items": { |
| 79 | "type": "string", |
| 80 | "description": "The 'Popular Items' text (used for non-hierarchical taxonomies)" |
| 81 | }, |
| 82 | "all_items": { |
| 83 | "type": "string", |
| 84 | "description": "The 'All Items' text" |
| 85 | }, |
| 86 | "parent_item": { |
| 87 | "type": "string", |
| 88 | "description": "The 'Parent Item' text (used for hierarchical taxonomies)" |
| 89 | }, |
| 90 | "parent_item_colon": { |
| 91 | "type": "string", |
| 92 | "description": "The 'Parent Item:' text" |
| 93 | }, |
| 94 | "name_field_description": { |
| 95 | "type": "string", |
| 96 | "description": "Description for the Name field on the term edit screen" |
| 97 | }, |
| 98 | "slug_field_description": { |
| 99 | "type": "string", |
| 100 | "description": "Description for the Slug field on the term edit screen" |
| 101 | }, |
| 102 | "parent_field_description": { |
| 103 | "type": "string", |
| 104 | "description": "Description for the Parent field on the term edit screen" |
| 105 | }, |
| 106 | "desc_field_description": { |
| 107 | "type": "string", |
| 108 | "description": "Description for the Description field on the term edit screen" |
| 109 | }, |
| 110 | "edit_item": { |
| 111 | "type": "string", |
| 112 | "description": "The 'Edit Item' text" |
| 113 | }, |
| 114 | "view_item": { |
| 115 | "type": "string", |
| 116 | "description": "The 'View Item' text" |
| 117 | }, |
| 118 | "update_item": { |
| 119 | "type": "string", |
| 120 | "description": "The 'Update Item' text" |
| 121 | }, |
| 122 | "add_new_item": { |
| 123 | "type": "string", |
| 124 | "description": "The 'Add New Item' text" |
| 125 | }, |
| 126 | "new_item_name": { |
| 127 | "type": "string", |
| 128 | "description": "The 'New Item Name' text" |
| 129 | }, |
| 130 | "separate_items_with_commas": { |
| 131 | "type": "string", |
| 132 | "description": "The 'Separate items with commas' text (used for non-hierarchical taxonomies)" |
| 133 | }, |
| 134 | "add_or_remove_items": { |
| 135 | "type": "string", |
| 136 | "description": "The 'Add or remove items' text (used for non-hierarchical taxonomies)" |
| 137 | }, |
| 138 | "choose_from_most_used": { |
| 139 | "type": "string", |
| 140 | "description": "The 'Choose from most used' text (used for non-hierarchical taxonomies)" |
| 141 | }, |
| 142 | "not_found": { |
| 143 | "type": "string", |
| 144 | "description": "The 'Not Found' text" |
| 145 | }, |
| 146 | "no_terms": { |
| 147 | "type": "string", |
| 148 | "description": "The 'No terms' text" |
| 149 | }, |
| 150 | "filter_by_item": { |
| 151 | "type": "string", |
| 152 | "description": "The 'Filter by item' text (used for hierarchical taxonomies)" |
| 153 | }, |
| 154 | "items_list_navigation": { |
| 155 | "type": "string", |
| 156 | "description": "The 'Items list navigation' text" |
| 157 | }, |
| 158 | "items_list": { |
| 159 | "type": "string", |
| 160 | "description": "The 'Items list' text" |
| 161 | }, |
| 162 | "most_used": { |
| 163 | "type": "string", |
| 164 | "description": "The 'Most Used' text" |
| 165 | }, |
| 166 | "back_to_items": { |
| 167 | "type": "string", |
| 168 | "description": "The 'Back to items' text" |
| 169 | }, |
| 170 | "item_link": { |
| 171 | "type": "string", |
| 172 | "description": "The 'Item Link' text" |
| 173 | }, |
| 174 | "item_link_description": { |
| 175 | "type": "string", |
| 176 | "description": "The 'Item Link Description' text" |
| 177 | } |
| 178 | } |
| 179 | }, |
| 180 | "description": { |
| 181 | "type": "string", |
| 182 | "description": "A short description of what your taxonomy is" |
| 183 | }, |
| 184 | |
| 185 | "public": { |
| 186 | "type": "boolean", |
| 187 | "default": true, |
| 188 | "description": "Whether a taxonomy is intended for use publicly either via the admin interface or by front-end users" |
| 189 | }, |
| 190 | "publicly_queryable": { |
| 191 | "type": "boolean", |
| 192 | "default": true, |
| 193 | "description": "Whether the taxonomy is publicly queryable" |
| 194 | }, |
| 195 | "hierarchical": { |
| 196 | "type": "boolean", |
| 197 | "default": false, |
| 198 | "description": "Whether the taxonomy is hierarchical (like categories) or flat (like tags)" |
| 199 | }, |
| 200 | |
| 201 | "show_ui": { |
| 202 | "type": "boolean", |
| 203 | "default": true, |
| 204 | "description": "Whether to generate and allow a UI for managing this taxonomy in the admin" |
| 205 | }, |
| 206 | "show_in_menu": { |
| 207 | "type": "boolean", |
| 208 | "default": true, |
| 209 | "description": "Whether to show the taxonomy in the admin menu" |
| 210 | }, |
| 211 | "show_in_nav_menus": { |
| 212 | "type": "boolean", |
| 213 | "default": true, |
| 214 | "description": "Whether the taxonomy is available for selection in navigation menus" |
| 215 | }, |
| 216 | "show_tagcloud": { |
| 217 | "type": "boolean", |
| 218 | "default": true, |
| 219 | "description": "Whether to allow the Tag Cloud widget to use this taxonomy" |
| 220 | }, |
| 221 | "show_in_quick_edit": { |
| 222 | "type": "boolean", |
| 223 | "default": true, |
| 224 | "description": "Whether to show the taxonomy in the quick/bulk edit panel" |
| 225 | }, |
| 226 | "show_admin_column": { |
| 227 | "type": "boolean", |
| 228 | "default": false, |
| 229 | "description": "Whether to show a column for this taxonomy on the associated post type listing screens" |
| 230 | }, |
| 231 | |
| 232 | "capabilities": { |
| 233 | "type": "object", |
| 234 | "description": "Capabilities for this taxonomy", |
| 235 | "additionalProperties": false, |
| 236 | "properties": { |
| 237 | "manage_terms": { |
| 238 | "type": "string", |
| 239 | "default": "manage_categories", |
| 240 | "description": "Capability for managing terms" |
| 241 | }, |
| 242 | "edit_terms": { |
| 243 | "type": "string", |
| 244 | "default": "manage_categories", |
| 245 | "description": "Capability for editing terms" |
| 246 | }, |
| 247 | "delete_terms": { |
| 248 | "type": "string", |
| 249 | "default": "manage_categories", |
| 250 | "description": "Capability for deleting terms" |
| 251 | }, |
| 252 | "assign_terms": { |
| 253 | "type": "string", |
| 254 | "default": "edit_posts", |
| 255 | "description": "Capability for assigning terms to posts" |
| 256 | } |
| 257 | } |
| 258 | }, |
| 259 | |
| 260 | "rewrite": { |
| 261 | "type": [ "object", "boolean" ], |
| 262 | "description": "Triggers the handling of rewrites for this taxonomy", |
| 263 | "oneOf": [ |
| 264 | { "type": "boolean" }, |
| 265 | { |
| 266 | "type": "object", |
| 267 | "additionalProperties": false, |
| 268 | "properties": { |
| 269 | "permalink_rewrite": { |
| 270 | "type": "string", |
| 271 | "description": "[SCF] SCF-specific permalink rewrite option" |
| 272 | }, |
| 273 | "slug": { |
| 274 | "type": "string", |
| 275 | "description": "Customize the permalink structure slug" |
| 276 | }, |
| 277 | "with_front": { |
| 278 | "type": [ "boolean", "string" ], |
| 279 | "default": true, |
| 280 | "description": "Whether the permalink structure should be prepended with WP_Rewrite::$front (accepts boolean or string '0'/'1' for backward compatibility)" |
| 281 | }, |
| 282 | "rewrite_hierarchical": { |
| 283 | "type": [ "boolean", "string" ], |
| 284 | "default": false, |
| 285 | "description": "Whether hierarchical URLs should be used (accepts boolean or string '0'/'1' for backward compatibility)" |
| 286 | } |
| 287 | } |
| 288 | } |
| 289 | ] |
| 290 | }, |
| 291 | "query_var": { |
| 292 | "type": [ "boolean", "string" ], |
| 293 | "description": "Sets the query_var key for this taxonomy" |
| 294 | }, |
| 295 | "query_var_name": { |
| 296 | "type": "string", |
| 297 | "description": "[SCF] SCF-specific query variable name" |
| 298 | }, |
| 299 | |
| 300 | "default_term": { |
| 301 | "type": "object", |
| 302 | "description": "Default term configuration for this taxonomy", |
| 303 | "additionalProperties": false, |
| 304 | "properties": { |
| 305 | "default_term_enabled": { |
| 306 | "type": "boolean", |
| 307 | "default": false, |
| 308 | "description": "Whether a default term is enabled" |
| 309 | }, |
| 310 | "default_term_name": { |
| 311 | "type": "string", |
| 312 | "description": "Name of the default term" |
| 313 | }, |
| 314 | "default_term_slug": { |
| 315 | "type": "string", |
| 316 | "description": "Slug of the default term" |
| 317 | }, |
| 318 | "default_term_description": { |
| 319 | "type": "string", |
| 320 | "description": "Description of the default term" |
| 321 | } |
| 322 | } |
| 323 | }, |
| 324 | "sort": { |
| 325 | "type": [ "boolean", "null" ], |
| 326 | "description": "Whether terms in this taxonomy should be sorted in the order they are provided to wp_set_object_terms()" |
| 327 | }, |
| 328 | |
| 329 | "meta_box": { |
| 330 | "type": "string", |
| 331 | "description": "[SCF] Meta box display setting. Options: 'default', 'custom', 'disabled'." |
| 332 | }, |
| 333 | "meta_box_cb": { |
| 334 | "type": "string", |
| 335 | "description": "Callback function name for custom meta box" |
| 336 | }, |
| 337 | "meta_box_sanitize_cb": { |
| 338 | "type": "string", |
| 339 | "description": "Callback function name for sanitizing taxonomy data saved from the meta box" |
| 340 | }, |
| 341 | |
| 342 | "show_in_rest": { |
| 343 | "type": "boolean", |
| 344 | "default": true, |
| 345 | "description": "Whether to include the taxonomy in the REST API" |
| 346 | }, |
| 347 | "allow_ai_access": { |
| 348 | "type": [ "boolean", "integer" ], |
| 349 | "default": false, |
| 350 | "description": "Whether to expose this taxonomy to AI integrations" |
| 351 | }, |
| 352 | "ai_description": { |
| 353 | "type": "string", |
| 354 | "default": "", |
| 355 | "description": "Description that helps AI integrations understand how to use this taxonomy" |
| 356 | }, |
| 357 | "rest_base": { |
| 358 | "type": "string", |
| 359 | "description": "To change the base URL of REST API route" |
| 360 | }, |
| 361 | "rest_namespace": { |
| 362 | "type": "string", |
| 363 | "default": "wp/v2", |
| 364 | "description": "To change the namespace URL of REST API route" |
| 365 | }, |
| 366 | "rest_controller_class": { |
| 367 | "type": "string", |
| 368 | "default": "WP_REST_Terms_Controller", |
| 369 | "description": "REST API Controller to use for this taxonomy" |
| 370 | } |
| 371 | } |
| 372 | } |
| 373 | }, |
| 374 | "examples": [ |
| 375 | { |
| 376 | "key": "taxonomy_682abc123def", |
| 377 | "title": "Genres", |
| 378 | "menu_order": 0, |
| 379 | "active": true, |
| 380 | "taxonomy": "genre", |
| 381 | "object_type": [ "book", "movie" ], |
| 382 | "advanced_configuration": 0, |
| 383 | "import_source": "", |
| 384 | "import_date": "", |
| 385 | "labels": { |
| 386 | "name": "Genres", |
| 387 | "singular_name": "Genre", |
| 388 | "menu_name": "Genres", |
| 389 | "all_items": "All Genres", |
| 390 | "edit_item": "Edit Genre", |
| 391 | "view_item": "View Genre", |
| 392 | "update_item": "Update Genre", |
| 393 | "add_new_item": "Add New Genre", |
| 394 | "new_item_name": "New Genre Name", |
| 395 | "parent_item": "Parent Genre", |
| 396 | "parent_item_colon": "Parent Genre:", |
| 397 | "search_items": "Search Genres", |
| 398 | "popular_items": "", |
| 399 | "separate_items_with_commas": "", |
| 400 | "add_or_remove_items": "", |
| 401 | "choose_from_most_used": "", |
| 402 | "not_found": "No genres found", |
| 403 | "no_terms": "No genres", |
| 404 | "filter_by_item": "Filter by genre", |
| 405 | "items_list_navigation": "Genres list navigation", |
| 406 | "items_list": "Genres list", |
| 407 | "most_used": "Most Used", |
| 408 | "back_to_items": "Back to Genres", |
| 409 | "item_link": "Genre Link", |
| 410 | "item_link_description": "A link to a genre.", |
| 411 | "name_field_description": "", |
| 412 | "slug_field_description": "", |
| 413 | "parent_field_description": "", |
| 414 | "desc_field_description": "" |
| 415 | }, |
| 416 | "description": "Categorize content by genre", |
| 417 | "public": true, |
| 418 | "publicly_queryable": true, |
| 419 | "hierarchical": true, |
| 420 | "show_ui": true, |
| 421 | "show_in_menu": true, |
| 422 | "show_in_nav_menus": true, |
| 423 | "show_in_rest": true, |
| 424 | "rest_base": "", |
| 425 | "rest_namespace": "wp/v2", |
| 426 | "rest_controller_class": "WP_REST_Terms_Controller", |
| 427 | "show_tagcloud": true, |
| 428 | "show_in_quick_edit": true, |
| 429 | "show_admin_column": true, |
| 430 | "capabilities": { |
| 431 | "manage_terms": "manage_categories", |
| 432 | "edit_terms": "manage_categories", |
| 433 | "delete_terms": "manage_categories", |
| 434 | "assign_terms": "edit_posts" |
| 435 | }, |
| 436 | "rewrite": { |
| 437 | "permalink_rewrite": "taxonomy_key", |
| 438 | "slug": "", |
| 439 | "with_front": true, |
| 440 | "rewrite_hierarchical": false |
| 441 | }, |
| 442 | "query_var": "taxonomy_key", |
| 443 | "query_var_name": "", |
| 444 | "default_term": { |
| 445 | "default_term_enabled": false, |
| 446 | "default_term_name": "", |
| 447 | "default_term_slug": "", |
| 448 | "default_term_description": "" |
| 449 | }, |
| 450 | "sort": null, |
| 451 | "meta_box": "default", |
| 452 | "meta_box_cb": "", |
| 453 | "meta_box_sanitize_cb": "" |
| 454 | } |
| 455 | ] |
| 456 | } |
| 457 |