[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> class-wp-post-type.php (source)

   1  <?php
   2  /**
   3   * Post API: WP_Post_Type class
   4   *
   5   * @package WordPress
   6   * @subpackage Post
   7   * @since 4.6.0
   8   */
   9  
  10  /**
  11   * Core class used for interacting with post types.
  12   *
  13   * @since 4.6.0
  14   *
  15   * @see register_post_type()
  16   */
  17  final class WP_Post_Type {
  18      /**
  19       * Post type key.
  20       *
  21       * @since 4.6.0
  22       * @var string $name
  23       */
  24      public $name;
  25  
  26      /**
  27       * Name of the post type shown in the menu. Usually plural.
  28       *
  29       * @since 4.6.0
  30       * @var string $label
  31       */
  32      public $label;
  33  
  34      /**
  35       * Labels object for this post type.
  36       *
  37       * If not set, post labels are inherited for non-hierarchical types
  38       * and page labels for hierarchical ones.
  39       *
  40       * @see get_post_type_labels()
  41       *
  42       * @since 4.6.0
  43       * @var object $labels
  44       */
  45      public $labels;
  46  
  47      /**
  48       * A short descriptive summary of what the post type is.
  49       *
  50       * Default empty.
  51       *
  52       * @since 4.6.0
  53       * @var string $description
  54       */
  55      public $description = '';
  56  
  57      /**
  58       * Whether a post type is intended for use publicly either via the admin interface or by front-end users.
  59       *
  60       * While the default settings of $exclude_from_search, $publicly_queryable, $show_ui, and $show_in_nav_menus
  61       * are inherited from public, each does not rely on this relationship and controls a very specific intention.
  62       *
  63       * Default false.
  64       *
  65       * @since 4.6.0
  66       * @var bool $public
  67       */
  68      public $public = false;
  69  
  70      /**
  71       * Whether the post type is hierarchical (e.g. page).
  72       *
  73       * Default false.
  74       *
  75       * @since 4.6.0
  76       * @var bool $hierarchical
  77       */
  78      public $hierarchical = false;
  79  
  80      /**
  81       * Whether to exclude posts with this post type from front end search
  82       * results.
  83       *
  84       * Default is the opposite value of $public.
  85       *
  86       * @since 4.6.0
  87       * @var bool $exclude_from_search
  88       */
  89      public $exclude_from_search = null;
  90  
  91      /**
  92       * Whether queries can be performed on the front end for the post type as part of `parse_request()`.
  93       *
  94       * Endpoints would include:
  95       * - `?post_type={post_type_key}`
  96       * - `?{post_type_key}={single_post_slug}`
  97       * - `?{post_type_query_var}={single_post_slug}`
  98       *
  99       * Default is the value of $public.
 100       *
 101       * @since 4.6.0
 102       * @var bool $publicly_queryable
 103       */
 104      public $publicly_queryable = null;
 105  
 106      /**
 107       * Whether to generate and allow a UI for managing this post type in the admin.
 108       *
 109       * Default is the value of $public.
 110       *
 111       * @since 4.6.0
 112       * @var bool $show_ui
 113       */
 114      public $show_ui = null;
 115  
 116      /**
 117       * Where to show the post type in the admin menu.
 118       *
 119       * To work, $show_ui must be true. If true, the post type is shown in its own top level menu. If false, no menu is
 120       * shown. If a string of an existing top level menu (eg. 'tools.php' or 'edit.php?post_type=page'), the post type
 121       * will be placed as a sub-menu of that.
 122       *
 123       * Default is the value of $show_ui.
 124       *
 125       * @since 4.6.0
 126       * @var bool $show_in_menu
 127       */
 128      public $show_in_menu = null;
 129  
 130      /**
 131       * Makes this post type available for selection in navigation menus.
 132       *
 133       * Default is the value $public.
 134       *
 135       * @since 4.6.0
 136       * @var bool $show_in_nav_menus
 137       */
 138      public $show_in_nav_menus = null;
 139  
 140      /**
 141       * Makes this post type available via the admin bar.
 142       *
 143       * Default is the value of $show_in_menu.
 144       *
 145       * @since 4.6.0
 146       * @var bool $show_in_admin_bar
 147       */
 148      public $show_in_admin_bar = null;
 149  
 150      /**
 151       * The position in the menu order the post type should appear.
 152       *
 153       * To work, $show_in_menu must be true. Default null (at the bottom).
 154       *
 155       * @since 4.6.0
 156       * @var int $menu_position
 157       */
 158      public $menu_position = null;
 159  
 160      /**
 161       * The URL to the icon to be used for this menu.
 162       *
 163       * Pass a base64-encoded SVG using a data URI, which will be colored to match the color scheme.
 164       * This should begin with 'data:image/svg+xml;base64,'. Pass the name of a Dashicons helper class
 165       * to use a font icon, e.g. 'dashicons-chart-pie'. Pass 'none' to leave div.wp-menu-image empty
 166       * so an icon can be added via CSS.
 167       *
 168       * Defaults to use the posts icon.
 169       *
 170       * @since 4.6.0
 171       * @var string $menu_icon
 172       */
 173      public $menu_icon = null;
 174  
 175      /**
 176       * The string to use to build the read, edit, and delete capabilities.
 177       *
 178       * May be passed as an array to allow for alternative plurals when using
 179       * this argument as a base to construct the capabilities, e.g.
 180       * array( 'story', 'stories' ). Default 'post'.
 181       *
 182       * @since 4.6.0
 183       * @var string $capability_type
 184       */
 185      public $capability_type = 'post';
 186  
 187      /**
 188       * Whether to use the internal default meta capability handling.
 189       *
 190       * Default false.
 191       *
 192       * @since 4.6.0
 193       * @var bool $map_meta_cap
 194       */
 195      public $map_meta_cap = false;
 196  
 197      /**
 198       * Provide a callback function that sets up the meta boxes for the edit form.
 199       *
 200       * Do `remove_meta_box()` and `add_meta_box()` calls in the callback. Default null.
 201       *
 202       * @since 4.6.0
 203       * @var string $register_meta_box_cb
 204       */
 205      public $register_meta_box_cb = null;
 206  
 207      /**
 208       * An array of taxonomy identifiers that will be registered for the post type.
 209       *
 210       * Taxonomies can be registered later with `register_taxonomy()` or `register_taxonomy_for_object_type()`.
 211       *
 212       * Default empty array.
 213       *
 214       * @since 4.6.0
 215       * @var array $taxonomies
 216       */
 217      public $taxonomies = array();
 218  
 219      /**
 220       * Whether there should be post type archives, or if a string, the archive slug to use.
 221       *
 222       * Will generate the proper rewrite rules if $rewrite is enabled. Default false.
 223       *
 224       * @since 4.6.0
 225       * @var bool|string $has_archive
 226       */
 227      public $has_archive = false;
 228  
 229      /**
 230       * Sets the query_var key for this post type.
 231       *
 232       * Defaults to $post_type key. If false, a post type cannot be loaded at `?{query_var}={post_slug}`.
 233       * If specified as a string, the query `?{query_var_string}={post_slug}` will be valid.
 234       *
 235       * @since 4.6.0
 236       * @var string|bool $query_var
 237       */
 238      public $query_var;
 239  
 240      /**
 241       * Whether to allow this post type to be exported.
 242       *
 243       * Default true.
 244       *
 245       * @since 4.6.0
 246       * @var bool $can_export
 247       */
 248      public $can_export = true;
 249  
 250      /**
 251       * Whether to delete posts of this type when deleting a user.
 252       *
 253       * If true, posts of this type belonging to the user will be moved to Trash when then user is deleted.
 254       * If false, posts of this type belonging to the user will *not* be trashed or deleted.
 255       * If not set (the default), posts are trashed if post_type_supports( 'author' ).
 256       * Otherwise posts are not trashed or deleted. Default null.
 257       *
 258       * @since 4.6.0
 259       * @var bool $delete_with_user
 260       */
 261      public $delete_with_user = null;
 262  
 263      /**
 264       * Whether this post type is a native or "built-in" post_type.
 265       *
 266       * Default false.
 267       *
 268       * @since 4.6.0
 269       * @var bool $_builtin
 270       */
 271      public $_builtin = false;
 272  
 273      /**
 274       * URL segment to use for edit link of this post type.
 275       *
 276       * Default 'post.php?post=%d'.
 277       *
 278       * @since 4.6.0
 279       * @var string $_edit_link
 280       */
 281      public $_edit_link = 'post.php?post=%d';
 282  
 283      /**
 284       * Post type capabilities.
 285       *
 286       * @since 4.6.0
 287       * @var object $cap
 288       */
 289      public $cap;
 290  
 291      /**
 292       * Triggers the handling of rewrites for this post type.
 293       *
 294       * Defaults to true, using $post_type as slug.
 295       *
 296       * @since 4.6.0
 297       * @var array|false $rewrite
 298       */
 299      public $rewrite;
 300  
 301      /**
 302       * The features supported by the post type.
 303       *
 304       * @since 4.6.0
 305       * @var array|bool $supports
 306       */
 307      public $supports;
 308  
 309      /**
 310       * Whether this post type should appear in the REST API.
 311       *
 312       * Default false. If true, standard endpoints will be registered with
 313       * respect to $rest_base and $rest_controller_class.
 314       *
 315       * @since 4.7.4
 316       * @var bool $show_in_rest
 317       */
 318      public $show_in_rest;
 319  
 320      /**
 321       * The base path for this post type's REST API endpoints.
 322       *
 323       * @since 4.7.4
 324       * @var string|bool $rest_base
 325       */
 326      public $rest_base;
 327  
 328      /**
 329       * The controller for this post type's REST API endpoints.
 330       *
 331       * Custom controllers must extend WP_REST_Controller.
 332       *
 333       * @since 4.7.4
 334       * @var string|bool $rest_controller_class
 335       */
 336      public $rest_controller_class;
 337  
 338      /**
 339       * The controller instance for this post type's REST API endpoints.
 340       *
 341       * Lazily computed. Should be accessed using {@see WP_Post_Type::get_rest_controller()}.
 342       *
 343       * @since 5.3.0
 344       * @var WP_REST_Controller $rest_controller
 345       */
 346      public $rest_controller;
 347  
 348      /**
 349       * Constructor.
 350       *
 351       * Will populate object properties from the provided arguments and assign other
 352       * default properties based on that information.
 353       *
 354       * @since 4.6.0
 355       *
 356       * @see register_post_type()
 357       *
 358       * @param string       $post_type Post type key.
 359       * @param array|string $args      Optional. Array or string of arguments for registering a post type.
 360       *                                Default empty array.
 361       */
 362  	public function __construct( $post_type, $args = array() ) {
 363          $this->name = $post_type;
 364  
 365          $this->set_props( $args );
 366      }
 367  
 368      /**
 369       * Sets post type properties.
 370       *
 371       * @since 4.6.0
 372       *
 373       * @param array|string $args Array or string of arguments for registering a post type.
 374       */
 375  	public function set_props( $args ) {
 376          $args = wp_parse_args( $args );
 377  
 378          /**
 379           * Filters the arguments for registering a post type.
 380           *
 381           * @since 4.4.0
 382           *
 383           * @param array  $args      Array of arguments for registering a post type.
 384           * @param string $post_type Post type key.
 385           */
 386          $args = apply_filters( 'register_post_type_args', $args, $this->name );
 387  
 388          $has_edit_link = ! empty( $args['_edit_link'] );
 389  
 390          // Args prefixed with an underscore are reserved for internal use.
 391          $defaults = array(
 392              'labels'                => array(),
 393              'description'           => '',
 394              'public'                => false,
 395              'hierarchical'          => false,
 396              'exclude_from_search'   => null,
 397              'publicly_queryable'    => null,
 398              'show_ui'               => null,
 399              'show_in_menu'          => null,
 400              'show_in_nav_menus'     => null,
 401              'show_in_admin_bar'     => null,
 402              'menu_position'         => null,
 403              'menu_icon'             => null,
 404              'capability_type'       => 'post',
 405              'capabilities'          => array(),
 406              'map_meta_cap'          => null,
 407              'supports'              => array(),
 408              'register_meta_box_cb'  => null,
 409              'taxonomies'            => array(),
 410              'has_archive'           => false,
 411              'rewrite'               => true,
 412              'query_var'             => true,
 413              'can_export'            => true,
 414              'delete_with_user'      => null,
 415              'show_in_rest'          => false,
 416              'rest_base'             => false,
 417              'rest_controller_class' => false,
 418              '_builtin'              => false,
 419              '_edit_link'            => 'post.php?post=%d',
 420          );
 421  
 422          $args = array_merge( $defaults, $args );
 423  
 424          $args['name'] = $this->name;
 425  
 426          // If not set, default to the setting for 'public'.
 427          if ( null === $args['publicly_queryable'] ) {
 428              $args['publicly_queryable'] = $args['public'];
 429          }
 430  
 431          // If not set, default to the setting for 'public'.
 432          if ( null === $args['show_ui'] ) {
 433              $args['show_ui'] = $args['public'];
 434          }
 435  
 436          // If not set, default to the setting for 'show_ui'.
 437          if ( null === $args['show_in_menu'] || ! $args['show_ui'] ) {
 438              $args['show_in_menu'] = $args['show_ui'];
 439          }
 440  
 441          // If not set, default to the setting for 'show_in_menu'.
 442          if ( null === $args['show_in_admin_bar'] ) {
 443              $args['show_in_admin_bar'] = (bool) $args['show_in_menu'];
 444          }
 445  
 446          // If not set, default to the setting for 'public'.
 447          if ( null === $args['show_in_nav_menus'] ) {
 448              $args['show_in_nav_menus'] = $args['public'];
 449          }
 450  
 451          // If not set, default to true if not public, false if public.
 452          if ( null === $args['exclude_from_search'] ) {
 453              $args['exclude_from_search'] = ! $args['public'];
 454          }
 455  
 456          // Back compat with quirky handling in version 3.0. #14122.
 457          if ( empty( $args['capabilities'] )
 458              && null === $args['map_meta_cap'] && in_array( $args['capability_type'], array( 'post', 'page' ), true )
 459          ) {
 460              $args['map_meta_cap'] = true;
 461          }
 462  
 463          // If not set, default to false.
 464          if ( null === $args['map_meta_cap'] ) {
 465              $args['map_meta_cap'] = false;
 466          }
 467  
 468          // If there's no specified edit link and no UI, remove the edit link.
 469          if ( ! $args['show_ui'] && ! $has_edit_link ) {
 470              $args['_edit_link'] = '';
 471          }
 472  
 473          $this->cap = get_post_type_capabilities( (object) $args );
 474          unset( $args['capabilities'] );
 475  
 476          if ( is_array( $args['capability_type'] ) ) {
 477              $args['capability_type'] = $args['capability_type'][0];
 478          }
 479  
 480          if ( false !== $args['query_var'] ) {
 481              if ( true === $args['query_var'] ) {
 482                  $args['query_var'] = $this->name;
 483              } else {
 484                  $args['query_var'] = sanitize_title_with_dashes( $args['query_var'] );
 485              }
 486          }
 487  
 488          if ( false !== $args['rewrite'] && ( is_admin() || get_option( 'permalink_structure' ) ) ) {
 489              if ( ! is_array( $args['rewrite'] ) ) {
 490                  $args['rewrite'] = array();
 491              }
 492              if ( empty( $args['rewrite']['slug'] ) ) {
 493                  $args['rewrite']['slug'] = $this->name;
 494              }
 495              if ( ! isset( $args['rewrite']['with_front'] ) ) {
 496                  $args['rewrite']['with_front'] = true;
 497              }
 498              if ( ! isset( $args['rewrite']['pages'] ) ) {
 499                  $args['rewrite']['pages'] = true;
 500              }
 501              if ( ! isset( $args['rewrite']['feeds'] ) || ! $args['has_archive'] ) {
 502                  $args['rewrite']['feeds'] = (bool) $args['has_archive'];
 503              }
 504              if ( ! isset( $args['rewrite']['ep_mask'] ) ) {
 505                  if ( isset( $args['permalink_epmask'] ) ) {
 506                      $args['rewrite']['ep_mask'] = $args['permalink_epmask'];
 507                  } else {
 508                      $args['rewrite']['ep_mask'] = EP_PERMALINK;
 509                  }
 510              }
 511          }
 512  
 513          foreach ( $args as $property_name => $property_value ) {
 514              $this->$property_name = $property_value;
 515          }
 516  
 517          $this->labels = get_post_type_labels( $this );
 518          $this->label  = $this->labels->name;
 519      }
 520  
 521      /**
 522       * Sets the features support for the post type.
 523       *
 524       * @since 4.6.0
 525       */
 526  	public function add_supports() {
 527          if ( ! empty( $this->supports ) ) {
 528              foreach ( $this->supports as $feature => $args ) {
 529                  if ( is_array( $args ) ) {
 530                      add_post_type_support( $this->name, $feature, $args );
 531                  } else {
 532                      add_post_type_support( $this->name, $args );
 533                  }
 534              }
 535              unset( $this->supports );
 536          } elseif ( false !== $this->supports ) {
 537              // Add default features.
 538              add_post_type_support( $this->name, array( 'title', 'editor' ) );
 539          }
 540      }
 541  
 542      /**
 543       * Adds the necessary rewrite rules for the post type.
 544       *
 545       * @since 4.6.0
 546       *
 547       * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 548       * @global WP         $wp         Current WordPress environment instance.
 549       */
 550  	public function add_rewrite_rules() {
 551          global $wp_rewrite, $wp;
 552  
 553          if ( false !== $this->query_var && $wp && is_post_type_viewable( $this ) ) {
 554              $wp->add_query_var( $this->query_var );
 555          }
 556  
 557          if ( false !== $this->rewrite && ( is_admin() || get_option( 'permalink_structure' ) ) ) {
 558              if ( $this->hierarchical ) {
 559                  add_rewrite_tag( "%$this->name%", '(.+?)', $this->query_var ? "{$this->query_var}=" : "post_type=$this->name&pagename=" );
 560              } else {
 561                  add_rewrite_tag( "%$this->name%", '([^/]+)', $this->query_var ? "{$this->query_var}=" : "post_type=$this->name&name=" );
 562              }
 563  
 564              if ( $this->has_archive ) {
 565                  $archive_slug = true === $this->has_archive ? $this->rewrite['slug'] : $this->has_archive;
 566                  if ( $this->rewrite['with_front'] ) {
 567                      $archive_slug = substr( $wp_rewrite->front, 1 ) . $archive_slug;
 568                  } else {
 569                      $archive_slug = $wp_rewrite->root . $archive_slug;
 570                  }
 571  
 572                  add_rewrite_rule( "{$archive_slug}/?$", "index.php?post_type=$this->name", 'top' );
 573                  if ( $this->rewrite['feeds'] && $wp_rewrite->feeds ) {
 574                      $feeds = '(' . trim( implode( '|', $wp_rewrite->feeds ) ) . ')';
 575                      add_rewrite_rule( "{$archive_slug}/feed/$feeds/?$", "index.php?post_type=$this->name" . '&feed=$matches[1]', 'top' );
 576                      add_rewrite_rule( "{$archive_slug}/$feeds/?$", "index.php?post_type=$this->name" . '&feed=$matches[1]', 'top' );
 577                  }
 578                  if ( $this->rewrite['pages'] ) {
 579                      add_rewrite_rule( "{$archive_slug}/{$wp_rewrite->pagination_base}/([0-9]{1,})/?$", "index.php?post_type=$this->name" . '&paged=$matches[1]', 'top' );
 580                  }
 581              }
 582  
 583              $permastruct_args         = $this->rewrite;
 584              $permastruct_args['feed'] = $permastruct_args['feeds'];
 585              add_permastruct( $this->name, "{$this->rewrite['slug']}/%$this->name%", $permastruct_args );
 586          }
 587      }
 588  
 589      /**
 590       * Registers the post type meta box if a custom callback was specified.
 591       *
 592       * @since 4.6.0
 593       */
 594  	public function register_meta_boxes() {
 595          if ( $this->register_meta_box_cb ) {
 596              add_action( 'add_meta_boxes_' . $this->name, $this->register_meta_box_cb, 10, 1 );
 597          }
 598      }
 599  
 600      /**
 601       * Adds the future post hook action for the post type.
 602       *
 603       * @since 4.6.0
 604       */
 605  	public function add_hooks() {
 606          add_action( 'future_' . $this->name, '_future_post_hook', 5, 2 );
 607      }
 608  
 609      /**
 610       * Registers the taxonomies for the post type.
 611       *
 612       * @since 4.6.0
 613       */
 614  	public function register_taxonomies() {
 615          foreach ( $this->taxonomies as $taxonomy ) {
 616              register_taxonomy_for_object_type( $taxonomy, $this->name );
 617          }
 618      }
 619  
 620      /**
 621       * Removes the features support for the post type.
 622       *
 623       * @since 4.6.0
 624       *
 625       * @global array $_wp_post_type_features Post type features.
 626       */
 627  	public function remove_supports() {
 628          global $_wp_post_type_features;
 629  
 630          unset( $_wp_post_type_features[ $this->name ] );
 631      }
 632  
 633      /**
 634       * Removes any rewrite rules, permastructs, and rules for the post type.
 635       *
 636       * @since 4.6.0
 637       *
 638       * @global WP_Rewrite $wp_rewrite          WordPress rewrite component.
 639       * @global WP         $wp                  Current WordPress environment instance.
 640       * @global array      $post_type_meta_caps Used to remove meta capabilities.
 641       */
 642  	public function remove_rewrite_rules() {
 643          global $wp, $wp_rewrite, $post_type_meta_caps;
 644  
 645          // Remove query var.
 646          if ( false !== $this->query_var ) {
 647              $wp->remove_query_var( $this->query_var );
 648          }
 649  
 650          // Remove any rewrite rules, permastructs, and rules.
 651          if ( false !== $this->rewrite ) {
 652              remove_rewrite_tag( "%$this->name%" );
 653              remove_permastruct( $this->name );
 654              foreach ( $wp_rewrite->extra_rules_top as $regex => $query ) {
 655                  if ( false !== strpos( $query, "index.php?post_type=$this->name" ) ) {
 656                      unset( $wp_rewrite->extra_rules_top[ $regex ] );
 657                  }
 658              }
 659          }
 660  
 661          // Remove registered custom meta capabilities.
 662          foreach ( $this->cap as $cap ) {
 663              unset( $post_type_meta_caps[ $cap ] );
 664          }
 665      }
 666  
 667      /**
 668       * Unregisters the post type meta box if a custom callback was specified.
 669       *
 670       * @since 4.6.0
 671       */
 672  	public function unregister_meta_boxes() {
 673          if ( $this->register_meta_box_cb ) {
 674              remove_action( 'add_meta_boxes_' . $this->name, $this->register_meta_box_cb, 10 );
 675          }
 676      }
 677  
 678      /**
 679       * Removes the post type from all taxonomies.
 680       *
 681       * @since 4.6.0
 682       */
 683  	public function unregister_taxonomies() {
 684          foreach ( get_object_taxonomies( $this->name ) as $taxonomy ) {
 685              unregister_taxonomy_for_object_type( $taxonomy, $this->name );
 686          }
 687      }
 688  
 689      /**
 690       * Removes the future post hook action for the post type.
 691       *
 692       * @since 4.6.0
 693       */
 694  	public function remove_hooks() {
 695          remove_action( 'future_' . $this->name, '_future_post_hook', 5 );
 696      }
 697  
 698      /**
 699       * Gets the REST API controller for this post type.
 700       *
 701       * Will only instantiate the controller class once per request.
 702       *
 703       * @since 5.3.0
 704       *
 705       * @return WP_REST_Controller|null The controller instance, or null if the post type
 706       *                                 is set not to show in rest.
 707       */
 708  	public function get_rest_controller() {
 709          if ( ! $this->show_in_rest ) {
 710              return null;
 711          }
 712  
 713          $class = $this->rest_controller_class ? $this->rest_controller_class : WP_REST_Posts_Controller::class;
 714  
 715          if ( ! class_exists( $class ) ) {
 716              return null;
 717          }
 718  
 719          if ( ! is_subclass_of( $class, WP_REST_Controller::class ) ) {
 720              return null;
 721          }
 722  
 723          if ( ! $this->rest_controller ) {
 724              $this->rest_controller = new $class( $this->name );
 725          }
 726  
 727          if ( ! ( $this->rest_controller instanceof $class ) ) {
 728              return null;
 729          }
 730  
 731          return $this->rest_controller;
 732      }
 733  }


Generated: Mon Jul 6 01:00:03 2020 Cross-referenced by PHPXref 0.7.1