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

Timestamp:

06/20/2017 06:27:53 PM (8 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing @param and @return descriptions for has_term_meta(), wp_delete_category(), and wp_term_is_shared().

Props keesiemeijer.
Fixes #41096.

File:

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

trunk/src/wp-includes/taxonomy.php

@@ -1248 +1248 @@
  * @global wpdb $wpdb WordPress database abstraction object.
  *
- * @param int $term_id
- * @return array|false
+ * @param int $term_id Term ID.
+ * @return array|false Array with meta data, or false when the meta table is not installed.
  */
 function has_term_meta( $term_id ) {
@@ -1817 +1817 @@
  * @since 2.0.0
  *
- * @param int $cat_ID
+ * @param int $cat_ID Category term ID.
  * @return bool|int|WP_Error Returns true if completes delete action; false if term doesn't exist;
  *  Zero on attempted deletion of default Category; WP_Error object is also a possibility.
@@ -3821 +3821 @@
  * @since 4.4.0
  *
- * @param int $term_id
- * @return bool
+ * @param int $term_id Term ID.
+ * @return bool Returns false if a term is not shared between multiple taxonomies or
+ *              if splittng shared taxonomy terms is finished. 
  */
 function wp_term_is_shared( $term_id ) {