Changeset 38747

Timestamp:

10/07/2016 05:11:02 PM (8 years ago)

Author:

swissspidy

Message:

Taxonomy: Introduce WP_Taxonomy and use it in register_taxonomy() and unregister_taxonomy().

This changes the global $wp_taxonomies to an array of WP_Taxonomy objects. WP_Taxonomy includes methods to handle rewrite rules and hooks.
Each taxonomy argument becomes a property of WP_Taxonomy. Introducing such a class makes further improvements in the future much more feasible.

Props boonebgorges for review.
Fixes #36224. See #36217.

Location:

trunk

Files:

• src/wp-admin/includes/ajax-actions.php (modified) (1 diff)
• src/wp-includes/class-wp-taxonomy.php (added)
• src/wp-includes/class-wp-xmlrpc-server.php (modified) (1 diff)
• src/wp-includes/taxonomy.php (modified) (7 diffs)
• src/wp-settings.php (modified) (1 diff)
• tests/phpunit/tests/term/wpTaxonomy.php (added)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -135 +135 @@
      * @since 4.0.0
      *
-     * @param int    $characters The minimum number of characters required. Default 2.
-     * @param object $tax        The taxonomy object.
-     * @param string $s          The search term.
+     * @param int         $characters The minimum number of characters required. Default 2.
+     * @param WP_Taxonomy $tax        The taxonomy object.
+     * @param string      $s          The search term.
      */
     $term_search_min_chars = (int) apply_filters( 'term_search_min_chars', 2, $tax, $s );

trunk/src/wp-includes/class-wp-xmlrpc-server.php

@@ -718 +718 @@
          * @since 3.4.0
          *
-         * @param array  $_taxonomy An array of taxonomy data.
-         * @param object $taxonomy  Taxonomy object.
-         * @param array  $fields    The subset of taxonomy fields to return.
+         * @param array       $_taxonomy An array of taxonomy data.
+         * @param WP_Taxonomy $taxonomy  Taxonomy object.
+         * @param array       $fields    The subset of taxonomy fields to return.
          */
         return apply_filters( 'xmlrpc_prepare_taxonomy', $_taxonomy, $taxonomy, $fields );

trunk/src/wp-includes/taxonomy.php

@@ -224 +224 @@
  *
  * @param string $taxonomy Name of taxonomy object to return.
- * @return object|false The Taxonomy Object or false if $taxonomy doesn't exist.
+ * @return WP_Taxonomy|false The Taxonomy Object or false if $taxonomy doesn't exist.
  */
 function get_taxonomy( $taxonomy ) {
@@ -291 +291 @@
  *
  * @global array $wp_taxonomies Registered taxonomies.
- * @global WP    $wp            WP instance.
  *
  * @param string       $taxonomy    Taxonomy key, must not exceed 32 characters.
@@ -360 +359 @@
  */
 function register_taxonomy( $taxonomy, $object_type, $args = array() ) {
-    global $wp_taxonomies, $wp;
+    global $wp_taxonomies;
 
     if ( ! is_array( $wp_taxonomies ) )
@@ -366 +365 @@
 
     $args = wp_parse_args( $args );
-
-    /**
-     * Filters the arguments for registering a taxonomy.
-     *
-     * @since 4.4.0
-     *
-     * @param array  $args        Array of arguments for registering a taxonomy.
-     * @param string $taxonomy    Taxonomy key.
-     * @param array  $object_type Array of names of object types for the taxonomy.
-     */
-    $args = apply_filters( 'register_taxonomy_args', $args, $taxonomy, (array) $object_type );
-
-    $defaults = array(
-        'labels'                => array(),
-        'description'           => '',
-        'public'                => true,
-        'publicly_queryable'    => null,
-        'hierarchical'          => false,
-        'show_ui'               => null,
-        'show_in_menu'          => null,
-        'show_in_nav_menus'     => null,
-        'show_tagcloud'         => null,
-        'show_in_quick_edit'    => null,
-        'show_admin_column'     => false,
-        'meta_box_cb'           => null,
-        'capabilities'          => array(),
-        'rewrite'               => true,
-        'query_var'             => $taxonomy,
-        'update_count_callback' => '',
-        '_builtin'              => false,
-    );
-    $args = array_merge( $defaults, $args );
 
     if ( empty( $taxonomy ) || strlen( $taxonomy ) > 32 ) {
@@ -404 +371 @@
     }
 
-    // If not set, default to the setting for public.
-    if ( null === $args['publicly_queryable'] ) {
-        $args['publicly_queryable'] = $args['public'];
-    }
-
-    // Non-publicly queryable taxonomies should not register query vars, except in the admin.
-    if ( false !== $args['query_var'] && ( is_admin() || false !== $args['publicly_queryable'] ) && ! 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'] );
-    } else {
-        // Force query_var to false for non-public taxonomies.
-        $args['query_var'] = false;
-    }
-
-    if ( false !== $args['rewrite'] && ( is_admin() || '' != get_option( 'permalink_structure' ) ) ) {
-        $args['rewrite'] = wp_parse_args( $args['rewrite'], array(
-            'with_front' => true,
-            'hierarchical' => false,
-            'ep_mask' => EP_NONE,
-        ) );
-
-        if ( empty( $args['rewrite']['slug'] ) )
-            $args['rewrite']['slug'] = sanitize_title_with_dashes( $taxonomy );
-
-        if ( $args['hierarchical'] && $args['rewrite']['hierarchical'] )
-            $tag = '(.+?)';
-        else
-            $tag = '([^/]+)';
-
-        add_rewrite_tag( "%$taxonomy%", $tag, $args['query_var'] ? "{$args['query_var']}=" : "taxonomy=$taxonomy&term=" );
-        add_permastruct( $taxonomy, "{$args['rewrite']['slug']}/%$taxonomy%", $args['rewrite'] );
-    }
-
-    // If not set, default to the setting for public.
-    if ( null === $args['show_ui'] )
-        $args['show_ui'] = $args['public'];
-
-    // If not set, default to the setting for show_ui.
-    if ( null === $args['show_in_menu' ] || ! $args['show_ui'] )
-        $args['show_in_menu' ] = $args['show_ui'];
-
-    // If not set, default to the setting for public.
-    if ( null === $args['show_in_nav_menus'] )
-        $args['show_in_nav_menus'] = $args['public'];
-
-    // If not set, default to the setting for show_ui.
-    if ( null === $args['show_tagcloud'] )
-        $args['show_tagcloud'] = $args['show_ui'];
-
-    // If not set, default to the setting for show_ui.
-    if ( null === $args['show_in_quick_edit'] ) {
-        $args['show_in_quick_edit'] = $args['show_ui'];
-    }
-
-    $default_caps = array(
-        'manage_terms' => 'manage_categories',
-        'edit_terms'   => 'manage_categories',
-        'delete_terms' => 'manage_categories',
-        'assign_terms' => 'edit_posts',
-    );
-    $args['cap'] = (object) array_merge( $default_caps, $args['capabilities'] );
-    unset( $args['capabilities'] );
-
-    $args['name'] = $taxonomy;
-    $args['object_type'] = array_unique( (array) $object_type );
-
-    $args['labels'] = get_taxonomy_labels( (object) $args );
-    $args['label'] = $args['labels']->name;
-
-    // If not set, use the default meta box
-    if ( null === $args['meta_box_cb'] ) {
-        if ( $args['hierarchical'] )
-            $args['meta_box_cb'] = 'post_categories_meta_box';
-        else
-            $args['meta_box_cb'] = 'post_tags_meta_box';
-    }
-
-    $wp_taxonomies[ $taxonomy ] = (object) $args;
-
-    // Register callback handling for meta box.
-    add_filter( 'wp_ajax_add-' . $taxonomy, '_wp_ajax_add_hierarchical_term' );
+    $taxonomy_object = new WP_Taxonomy( $taxonomy, $object_type, $args );
+    $taxonomy_object->add_rewrite_rules();
+
+    $wp_taxonomies[ $taxonomy ] = $taxonomy_object;
+
+    $taxonomy_object->add_hooks();
+
 
     /**
@@ -519 +409 @@
     }
 
-    $taxonomy_args = get_taxonomy( $taxonomy );
+    $taxonomy_object = get_taxonomy( $taxonomy );
 
     // Do not allow unregistering internal taxonomies.
-    if ( $taxonomy_args->_builtin ) {
+    if ( $taxonomy_object->_builtin ) {
         return new WP_Error( 'invalid_taxonomy', __( 'Unregistering a built-in taxonomy is not allowed' ) );
     }
 
-    global $wp, $wp_taxonomies;
-
-    // Remove query var.
-    if ( false !== $taxonomy_args->query_var ) {
-        $wp->remove_query_var( $taxonomy_args->query_var );
-    }
-
-    // Remove rewrite tags and permastructs.
-    if ( false !== $taxonomy_args->rewrite ) {
-        remove_rewrite_tag( "%$taxonomy%" );
-        remove_permastruct( $taxonomy );
-    }
-
-    // Unregister callback handling for meta box.
-    remove_filter( 'wp_ajax_add-' . $taxonomy, '_wp_ajax_add_hierarchical_term' );
+    global $wp_taxonomies;
+
+    $taxonomy_object->remove_rewrite_rules();
+    $taxonomy_object->remove_hooks();
 
     // Remove the taxonomy.
@@ -590 +469 @@
  * @since 4.4.0 Added the `items_list_navigation` and `items_list` labels.
  *
- * @param object $tax Taxonomy object.
+ * @param WP_Taxonomy $tax Taxonomy object.
  * @return object object with all the labels as member variables.
  */

trunk/src/wp-settings.php

@@ -188 +188 @@
 require( ABSPATH . WPINC . '/script-loader.php' );
 require( ABSPATH . WPINC . '/taxonomy.php' );
+require( ABSPATH . WPINC . '/class-wp-taxonomy.php' );
 require( ABSPATH . WPINC . '/class-wp-term.php' );
 require( ABSPATH . WPINC . '/class-wp-term-query.php' );