Context Navigation

← Previous Changeset
Next Changeset →

Changeset 52992

Timestamp:

03/25/2022 04:51:06 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Use third-person singular verbs for function descriptions in wp-includes/taxonomy.php, per the documentation standards.

See #54729.

File:

: 1 edited

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

Legend:

: Unmodified
: Added
: Removed

trunk/src/wp-includes/taxonomy.php

-                      r52991
+                      r52992
 /**
  * Return the names or objects of the taxonomies which are registered for the requested object or object type, such as
  * a post object or post type name.
+ * Returns the names or objects of the taxonomies which are registered for the requested object or object type,
+ * such as a post object or post type name.
+ *
  * Example:
 …
+ *
  * @param string $taxonomy Name of taxonomy object to return.
  * @return WP_Taxonomy|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 ) {
 …
  * @since 4.5.0 Introduced `publicly_queryable` argument.
  * @since 4.7.0 Introduced `show_in_rest`, 'rest_base' and 'rest_controller_class'
  *              arguments to register the Taxonomy in REST API.
+ *              arguments to register the taxonomy in REST API.
  * @since 5.1.0 Introduced `meta_box_sanitize_cb` argument.
  * @since 5.4.0 Added the registered taxonomy object as a return value.
 …
 /**
  * Add an already registered taxonomy to an object type.
+ * Adds an already registered taxonomy to an object type.
+ *
  * @since 3.0.0
 …
 /**
  * Remove an already registered taxonomy from an object type.
+ * Removes an already registered taxonomy from an object type.
+ *
  * @since 3.7.0
 …
 /**
  * Retrieve object IDs of valid taxonomy and term.
+ * Retrieves object IDs of valid taxonomy and term.
+ *
  * The strings of `$taxonomies` must exist before this function will continue.
 …
 /**
  * Get all Term data from database by Term ID.
+ * Gets all term data from database by term ID.
+ *
  * The usage of the get_term function is to apply filters to a term object. It
 …
  * the second is for the taxonomy name, 'term_$taxonomy'. Both hooks gets the
  * term object, and the taxonomy name as parameters. Both hooks are expected to
  * return a Term object.
+ * return a term object.
+ *
  * {@see 'get_term'} hook - Takes two parameters the term Object and the taxonomy name.
 …
 /**
  * Get all Term data from database by Term field and data.
+ * Gets all term data from database by term field and data.
+ *
  * Warning: $value is not escaped for 'name' $field. You must do it yourself, if
 …
+ *
  * If $value does not exist, the return value will be false. If $taxonomy exists
  * and $field and $value combinations exist, the Term will be returned.
+ * and $field and $value combinations exist, the term will be returned.
+ *
  * This function will always return the first term that matches the `$field`-
 …
 /**
  * Merge all term children into a single array of their IDs.
+ * Merges all term children into a single array of their IDs.
+ *
  * This recursive function will merge all of the children of $term into the same
 …
  * @param int    $term_id  ID of term to get children.
  * @param string $taxonomy Taxonomy name.
  * @return array|WP_Error List of Term IDs. WP_Error returned if `$taxonomy` does not exist.
+ * @return array|WP_Error List of term IDs. WP_Error returned if `$taxonomy` does not exist.
  */
 function get_term_children( $term_id, $taxonomy ) {
 …
 /**
  * Get sanitized Term field.
+ * Gets sanitized term field.
+ *
  * The function is for contextual reasons and for simplicity of usage.
 …
 /**
  * Sanitizes Term for editing.
+ * Sanitizes term for editing.
+ *
  * Return value is sanitize_term() and usage is for sanitizing the term for
 …
 /**
  * Get all meta data, including meta IDs, for the given term ID.
+ * Gets all meta data, including meta IDs, for the given term ID.
+ *
  * @since 4.9.0
 …
 /**
  * Check if a term is an ancestor of another term.
+ * Checks if a term is an ancestor of another term.
+ *
  * You can use either an ID or the term object for both parameters.
 …
 /**
  * Sanitize all term fields.
+ * Sanitizes all term fields.
+ *
  * Relies on sanitize_term_field() to sanitize the term. The difference is that
 …
 /**
  * Cleanse the field value in the term based on the context.
+ * Sanitizes the field value in the term based on the context.
+ *
  * Passing a term field value through the function should be assumed to have
 …
 /**
  * Count how many terms are in Taxonomy.
+ * Counts how many terms are in taxonomy.
+ *
  * Default $args is 'hide_empty' which can be 'hide_empty=true' or array('hide_empty' => true).
 …
 /**
  * Will unlink the object from the taxonomy or taxonomies.
+ * Unlinks the object from the taxonomy or taxonomies.
+ *
  * Will remove all relationships between the object and any terms in
 …
 /**
  * Add a new term to the database.
+ * Adds a new term to the database.
+ *
  * A non-existent term is inserted in the following sequence:
 …
      * Filters the duplicate term check that takes place during term creation.
+     *
      * Term parent+taxonomy+slug combinations are meant to be unique, and wp_insert_term()
+     * Term parent + taxonomy + slug combinations are meant to be unique, and wp_insert_term()
      * performs a last-minute confirmation of this uniqueness before allowing a new term
      * to be created. Plugins with different uniqueness requirements may use this filter
 …
 /**
  * Create Term and Taxonomy Relationships.
+ *
  * Relates an object (post, link etc) to a term and taxonomy type. Creates the
+ * Creates term and taxonomy relationships.
+ *
+ * Relates an object (post, link, etc.) to a term and taxonomy type. Creates the
  * term and taxonomy relationship if it doesn't already exist. Creates a term if
  * it doesn't exist (using the slug).
 …
 /**
  * Add term(s) associated with a given object.
+ * Adds term(s) associated with a given object.
+ *
  * @since 3.6.0
 …
 /**
  * Remove term(s) associated with a given object.
+ * Removes term(s) associated with a given object.
+ *
  * @since 3.6.0
 …
 /**
  * Will make slug unique, if it isn't already.
+ * Makes term slug unique, if it isn't already.
+ *
  * The `$slug` has to be unique global to every taxonomy, meaning that one
 …
 /**
  * Update term based on arguments provided.
+ * Updates term based on arguments provided.
+ *
  * The `$args` will indiscriminately override all values with the same field name.
 …
      * @since 2.9.0
+     *
      * @param int    $term_id  Term ID
+     * @param int    $term_id  Term ID.
      * @param string $taxonomy Taxonomy slug.
      */
 …
 /**
  * Enable or disable term counting.
+ * Enables or disables term counting.
+ *
  * @since 2.5.0
 …
 /**
  * Perform term count update immediately.
+ * Performs term count update immediately.
+ *
  * @since 2.5.0
 …
 /**
  * Will remove all of the term IDs from the cache.
+ * Removes all of the term IDs from the cache.
+ *
  * @since 2.3.0
 …
 /**
  * Clean the caches for a taxonomy.
+ * Cleans the caches for a taxonomy.
+ *
  * @since 4.9.0
 …
 /**
  * Updates Terms to Taxonomy in cache.
+ * Updates terms in cache.
+ *
  * @since 2.3.0
 …
 /**
  * Retrieves children of taxonomy as Term IDs.
+ * Retrieves children of taxonomy as term IDs.
+ *
  * @access private
 …
+ *
  * @param string $taxonomy Taxonomy name.
  * @return array Empty if $taxonomy isn't hierarchical or returns children as Term IDs.
+ * @return array Empty if $taxonomy isn't hierarchical or returns children as term IDs.
  */
 function _get_term_hierarchy( $taxonomy ) {
 …
 /**
  * Get the subset of $terms that are descendants of $term_id.
+ * Gets the subset of $terms that are descendants of $term_id.
+ *
  * If `$terms` is an array of objects, then _get_term_children() returns an array of objects.
 …
 /**
  * Add count of children to parent count.
+ * Adds count of children to parent count.
+ *
  * Recalculates term counts by including items from child terms. Assumes all
 …
 /**
  * Will update term count based on object types of the current taxonomy.
+ * Updates term count based on object types of the current taxonomy.
+ *
  * Private function for the default callback for post_tag and category
 …
  * @global wpdb $wpdb WordPress database abstraction object.
+ *
  * @param int[]       $terms    List of Term taxonomy IDs.
+ * @param int[]       $terms    List of term taxonomy IDs.
  * @param WP_Taxonomy $taxonomy Current taxonomy object of terms.
  */
 …
 /**
  * Will update term count based on number of objects.
+ * Updates term count based on number of objects.
+ *
  * Default callback for the 'link_category' taxonomy.
 …
 /**
  * Create a new term for a term_taxonomy item that currently shares its term
+ * Creates a new term for a term_taxonomy item that currently shares its term
  * with another term_taxonomy.
+ *
 …
 /**
  * In order to avoid the _wp_batch_split_terms() job being accidentally removed,
  * check that it's still scheduled while we haven't finished splitting terms.
+ * checks that it's still scheduled while we haven't finished splitting terms.
+ *
  * @ignore
 …
 /**
  * Check default categories when a term gets split to see if any of them need to be updated.
+ * Checks default categories when a term gets split to see if any of them need to be updated.
+ *
  * @ignore
 …
 /**
  * Check menu items when a term gets split to see if any of them need to be updated.
+ * Checks menu items when a term gets split to see if any of them need to be updated.
+ *
  * @ignore
 …
 /**
  * If the term being split is a nav_menu, change associations.
+ * If the term being split is a nav_menu, changes associations.
+ *
  * @ignore
 …
 /**
  * Get data about terms that previously shared a single term_id, but have since been split.
+ * Gets data about terms that previously shared a single term_id, but have since been split.
+ *
  * @since 4.2.0
 …
 /**
  * Get the new term ID corresponding to a previously split term.
+ * Gets the new term ID corresponding to a previously split term.
+ *
  * @since 4.2.0
 …
 /**
  * Determine whether a term is shared between multiple taxonomies.
+ * Determines whether a term is shared between multiple taxonomies.
+ *
  * Shared taxonomy terms began to be split in 4.3, but failed cron tasks or
 …
 /**
  * Generate a permalink for a taxonomy term archive.
+ * Generates a permalink for a taxonomy term archive.
+ *
  * @since 2.5.0
 …
 /**
  * Display the taxonomies of a post with available options.
+ * Displays the taxonomies of a post with available options.
+ *
  * This function can be used within the loop to display the taxonomies for a
 …
 /**
  * Retrieve all taxonomies associated with a post.
+ * Retrieves all taxonomies associated with a post.
+ *
  * This function can be used within the loop. It will also return an array of
 …
 /**
  * Retrieve all taxonomy names for the given post.
+ * Retrieves all taxonomy names for the given post.
+ *
  * @since 2.5.0
 …
 /**
  * Determine if the given object is associated with any of the given terms.
+ * Determines if the given object is associated with any of the given terms.
+ *
  * The given terms are checked against the object's terms' term_ids, names and slugs.
 …
 /**
  * Determine if the given object type is associated with the given taxonomy.
+ * Determines if the given object type is associated with the given taxonomy.
+ *
  * @since 3.0.0
 …
 /**
  * Get an array of ancestor IDs for a given object.
+ * Gets an array of ancestor IDs for a given object.
+ *
  * @since 3.1.0
 …
 /**
  * Returns the term's parent's term_ID.
+ * Returns the term's parent's term ID.
+ *
  * @since 3.1.0

Note: See TracChangeset for help on using the changeset viewer.

Trac UI Preferences

Make WordPress Core

Context Navigation

Changeset 52992

Legend:

trunk/src/wp-includes/taxonomy.php

Download in other formats: