Changeset 32348

Timestamp:

05/05/2015 02:00:18 AM (8 years ago)

Author:

DrewAPicture

Message:

Improve inline documentation in wp-includes/taxonomy.php.

• Adds missing @since versions
• Adds @global tags and descriptions to DocBlocks where appropriate

Props ChaseWiseman.
See #31800.

File:

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

trunk/src/wp-includes/taxonomy.php

@@ -2 +2 @@
 /**
  * Taxonomy API
+ *
+ * @since 2.3.0
  *
  * @package WordPress
  * @subpackage Taxonomy
- * @since 2.3.0
  */
 
@@ -16 +17 @@
  *
  * This function fires twice: in wp-settings.php before plugins are loaded (for
- * backwards compatibility reasons), and again on the 'init' action. We must avoid
- * registering rewrite rules before the 'init' action.
+ * backwards compatibility reasons), and again on the {@see 'init'} action. We must
+ * avoid registering rewrite rules before the {@see 'init'} action.
+ *
+ * @since 2.8.0
+ *
+ * @global WP_Rewrite $wp_rewrite The WordPress rewrite class.
  */
 function create_initial_taxonomies() {
@@ -130 +135 @@
 
 /**
- * Get a list of registered taxonomy objects.
+ * Retrieves a list of registered taxonomy names or objects.
  *
  * @since 3.0.0
- * @uses $wp_taxonomies
+ *
+ * @global array $wp_taxonomies The registered taxonomies.
  *
  * @param array $args An array of key => value arguments to match against the taxonomy objects.
@@ -160 +166 @@
  * @since 2.3.0
  *
- * @uses $wp_taxonomies
+ * @global array $wp_taxonomies The registered taxonomies.
  *
  * @param array|string|object $object Name of the type of taxonomy object, or an object (row from posts)
@@ -198 +204 @@
  * @since 2.3.0
  *
- * @uses $wp_taxonomies
+ * @global array $wp_taxonomies The registered taxonomies.
  *
  * @param string $taxonomy Name of taxonomy object to return
@@ -219 +225 @@
  * @since 3.0.0
  *
- * @uses $wp_taxonomies
+ * @global array $wp_taxonomies The registered taxonomies.
  *
  * @param string $taxonomy Name of taxonomy object
@@ -465 +471 @@
  *
  * @since 3.0.0
+ *
  * @param object $tax Taxonomy object
  * @return object object with all the labels as member variables
@@ -505 +512 @@
  *
  * @since 3.0.0
- * @uses $wp_taxonomies Modifies taxonomy object
+ *
+ * @global array $wp_taxonomies The registered taxonomies.
  *
  * @param string $taxonomy Name of taxonomy object
@@ -530 +538 @@
  *
  * @since 3.7.0
+ *
+ * @global array $wp_taxonomies The registered taxonomies.
  *
  * @param string $taxonomy    Name of taxonomy object.
@@ -1002 +1012 @@
      * @access public
      *
+     * @global wpdb $wpdb The WordPress database abstraction object.
+     *
      * @param array $clause       Query clause, passed by reference
      * @param array $parent_query Parent query array.
@@ -1209 +1221 @@
      *
      * @since 3.2.0
+     *
+     * @global wpdb $wpdb The WordPress database abstraction object.
      *
      * @param array  &$query          The single query.
@@ -1461 +1475 @@
  *
  * @since 2.3.0
- *
- * @global wpdb $wpdb WordPress database abstraction object.
  *
  * @param string $term_id ID of Term to get children
@@ -3053 +3065 @@
  * @since 2.3.0
  *
+ * @global wpdb $wpdb The WordPress database abstraction object.
+ *
  * @param int              $object_id The object to relate to.
  * @param array|int|string $terms     A single term slug, single term id, or array of either term slugs or ids.