Changeset 25130 for trunk/src/wp-includes/taxonomy.php

Timestamp:

08/26/2013 08:23:34 PM (12 years ago)

Author:

ocean90

Message:

Improve inline docs for register_post_type() and register_taxonomy().

• register_taxonomy: Use the same doc format for the associative array arg as used for register_post_type()
• register_taxonomy: Improve docs for _builtin, capabilities, hierarchical and rewrite args
• register_taxonomy: Use the same order in $defaults as in docblock
• register_taxonomy: Replace is_null with null ===, to be consistent
• register_post_type: Use the same order in $defaults as in docblock
• register_post_type: Improve docs for @uses and default fallbacks

And while we're on it: Whitespaces.

fixes #25150.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (4 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -271 +271 @@
  * Optional $args contents:
  *
- * label - Name of the taxonomy shown in the menu. Usually plural. If not set, labels['name'] will be used.
- *
- * hierarchical - has some defined purpose at other parts of the API and is a
- * boolean value.
- *
- * update_count_callback - works much like a hook, in that it will be called when the count is updated.
- *  Defaults to _update_post_term_count() for taxonomies attached to post types, which then confirms
- *  that the objects are published before counting them.
- *  Defaults to _update_generic_term_count() for taxonomies attached to other object types, such as links.
- *
- * rewrite - false to prevent rewrite, or array('slug'=>$slug) to customize
- * permastruct; default will use $taxonomy as slug.
- *
- * query_var - false to prevent queries, or string to customize query var
- * (?$query_var=$term); default will use $taxonomy as query var.
- *
- * public - If the taxonomy should be publicly queryable; //@TODO not implemented.
- * defaults to true.
- *
- * show_ui - If the WordPress UI admin tags UI should apply to this taxonomy;
- * defaults to public.
- *
- * show_in_nav_menus - true makes this taxonomy available for selection in navigation menus.
- * Defaults to public.
- *
- * show_tagcloud - false to prevent the taxonomy being listed in the Tag Cloud Widget;
- * defaults to show_ui which defaults to public.
- *
- * labels - An array of labels for this taxonomy. You can see accepted values in {@link get_taxonomy_labels()}. By default tag labels are used for non-hierarchical types and category labels for hierarchical ones.
- *
- * description - A short descriptive summary of what the taxonomy is for. Defaults to blank.
- *
- * @package WordPress
- * @subpackage Taxonomy
+ * - label - Name of the taxonomy shown in the menu. Usually plural. If not set, labels['name'] will be used.
+ * - labels - An array of labels for this taxonomy.
+ *     * By default tag labels are used for non-hierarchical types and category labels for hierarchical ones.
+ *     * You can see accepted values in {@link get_taxonomy_labels()}.
+ * - description - A short descriptive summary of what the taxonomy is for. Defaults to blank.
+ * - public - If the taxonomy should be publicly queryable; //@TODO not implemented.
+ *     * Defaults to true.
+ * - hierarchical - Whether the taxonomy is hierarchical (e.g. category). Defaults to false.
+ * - show_ui -Whether to generate a default UI for managing this taxonomy in the admin.
+ *     * If not set, the default is inherited from public.
+ * - show_in_nav_menus - Makes this taxonomy available for selection in navigation menus.
+ *     * If not set, the default is inherited from public.
+ * - show_tagcloud - Whether to list the taxonomy in the Tag Cloud Widget.
+ *     * If not set, the default is inherited from show_ui.
+ * - capabilities - Array of capabilities for this taxonomy.
+ *     * You can see accepted values in this function.
+ * - rewrite - Triggers the handling of rewrites for this taxonomy. Defaults to true, using $taxonomy as slug.
+ *     * To prevent rewrite, set to false.
+ *     * To specify rewrite rules, an array can be passed with any of these keys
+ *         * 'slug' => string Customize the permastruct slug. Defaults to $taxonomy key
+ *         * 'with_front' => bool Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true.
+ *         * 'hierarchical' => bool Either hierarchical rewrite tag or not. Defaults to false.
+ *         * 'ep_mask' => const Assign an endpoint mask.
+ *             * If not specified, defaults to EP_NONE.
+ * - query_var - Sets the query_var key for this taxonomy. Defaults to $taxonomy key
+ *     * If false, a taxonomy cannot be loaded at ?{query_var}={term_slug}
+ *     * If specified as a string, the query ?{query_var_string}={term_slug} will be valid.
+ * - update_count_callback - Works much like a hook, in that it will be called when the count is updated.
+ *     * Defaults to _update_post_term_count() for taxonomies attached to post types, which then confirms
+ *       that the objects are published before counting them.
+ *     * Defaults to _update_generic_term_count() for taxonomies attached to other object types, such as links.
+ * - _builtin - true if this taxonomy is a native or "built-in" taxonomy. THIS IS FOR INTERNAL USE ONLY!
+ *
  * @since 2.3.0
  * @uses $wp_taxonomies Inserts new taxonomy object into the list
  * @uses $wp Adds query vars
  *
- * @param string $taxonomy Name of taxonomy object
+ * @param string $taxonomy Taxonomy key, must not exceed 32 characters.
  * @param array|string $object_type Name of the object type for the taxonomy object.
- * @param array|string $args See above description for the two keys values.
+ * @param array|string $args See optional args description above.
  * @return null|WP_Error WP_Error if errors, otherwise null.
  */
@@ -317 +316 @@
     global $wp_taxonomies, $wp;
 
-    if ( ! is_array($wp_taxonomies) )
+    if ( ! is_array( $wp_taxonomies ) )
         $wp_taxonomies = array();
 
     $defaults = array(
-        'hierarchical' => false,
+        'labels'                => array(),
+        'description'           => '',
+        'public'                => true,
+        'hierarchical'          => false,
+        'show_ui'               => null,
+        'show_in_nav_menus'     => null,
+        'show_tagcloud'         => null,
+        'capabilities'          => array(),
+        'rewrite'               => true,
+        'query_var'             => $taxonomy,
         'update_count_callback' => '',
-        'rewrite' => true,
-        'query_var' => $taxonomy,
-        'public' => true,
-        'show_ui' => null,
-        'show_tagcloud' => null,
-        '_builtin' => false,
-        'labels' => array(),
-        'capabilities' => array(),
-        'show_in_nav_menus' => null,
-        'description' => '',
+        '_builtin'              => false,
     );
-    $args = wp_parse_args($args, $defaults);
+    $args = wp_parse_args( $args, $defaults );
 
     if ( strlen( $taxonomy ) > 32 )
         return new WP_Error( 'taxonomy_too_long', __( 'Taxonomies cannot exceed 32 characters in length' ) );
 
-    if ( false !== $args['query_var'] && !empty($wp) ) {
+    if ( false !== $args['query_var'] && ! empty( $wp ) ) {
         if ( true === $args['query_var'] )
             $args['query_var'] = $taxonomy;
         else
-            $args['query_var'] = sanitize_title_with_dashes($args['query_var']);
-        $wp->add_query_var($args['query_var']);
-    }
-
-    if ( false !== $args['rewrite'] && ( is_admin() || '' != get_option('permalink_structure') ) ) {
-        $args['rewrite'] = wp_parse_args($args['rewrite'], array(
-            'slug' => sanitize_title_with_dashes($taxonomy),
+            $args['query_var'] = sanitize_title_with_dashes( $args['query_var'] );
+        $wp->add_query_var( $args['query_var'] );
+    }
+
+    if ( false !== $args['rewrite'] && ( is_admin() || '' != get_option( 'permalink_structure' ) ) ) {
+        $args['rewrite'] = wp_parse_args( $args['rewrite'], array(
+            'slug' => sanitize_title_with_dashes( $taxonomy ),
             'with_front' => true,
             'hierarchical' => false,
             'ep_mask' => EP_NONE,
-        ));
+        ) );
 
         if ( $args['hierarchical'] && $args['rewrite']['hierarchical'] )
@@ -364 +363 @@
     }
 
-    if ( is_null($args['show_ui']) )
+    // If not set, default to the setting for public.
+    if ( null === $args['show_ui'] )
         $args['show_ui'] = $args['public'];
 
-    // Whether to show this type in nav-menus.php. Defaults to the setting for public.
+    // If not set, default to the setting for public.
     if ( null === $args['show_in_nav_menus'] )
         $args['show_in_nav_menus'] = $args['public'];
 
-    if ( is_null($args['show_tagcloud']) )
+    // If not set, default to the setting for show_ui.
+    if ( null === $args['show_tagcloud'] )
         $args['show_tagcloud'] = $args['show_ui'];
 
@@ -384 +385 @@
 
     $args['name'] = $taxonomy;
-    $args['object_type'] =  array_unique( (array)$object_type );
+    $args['object_type'] = array_unique( (array) $object_type );
 
     $args['labels'] = get_taxonomy_labels( (object) $args );
     $args['label'] = $args['labels']->name;
 
-    $wp_taxonomies[$taxonomy] = (object) $args;
+    $wp_taxonomies[ $taxonomy ] = (object) $args;
 
     // register callback handling for metabox
-    add_filter('wp_ajax_add-' . $taxonomy, '_wp_ajax_add_hierarchical_term');
+    add_filter( 'wp_ajax_add-' . $taxonomy, '_wp_ajax_add_hierarchical_term' );
 
     do_action( 'registered_taxonomy', $taxonomy, $object_type, $args );