Changeset 37884

Timestamp:

06/28/2016 06:36:24 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Improve the $post_type parameter description in the DocBlock for register_post_type().

See #32246.

File:

• trunk/src/wp-includes/post.php (modified) (2 diffs)

trunk/src/wp-includes/post.php

@@ -898 +898 @@
  * @since 2.9.0
  * @since 3.0.0 The `show_ui` argument is now enforced on the new post screen.
- * @since 4.4.0 The `show_ui` argument is now enforced on the post type listing screen and post editing screen.
+ * @since 4.4.0 The `show_ui` argument is now enforced on the post type listing
+ *              screen and post editing screen.
  *
  * @global array      $wp_post_types List of post types.
@@ -904 +905 @@
  * @global WP         $wp            Used to add query vars.
  *
- * @param string $post_type Post type key, must not exceed 20 characters.
+ * @param string $post_type Post type key. Must not exceed 20 characters and may
+ *                          only contain lowercase alphanumeric characters, dashes,
+ *                          and underscores. See sanitize_key().
  * @param array|string $args {
  *     Array or string of arguments for registering a post type.