From 7e879f48f13c2693baea99f247eaf7881e455c17 Mon Sep 17 00:00:00 2001 From: Rachel Baker Date: Wed, 8 Aug 2018 21:44:31 +0000 Subject: [PATCH] =?UTF-8?q?Docs:=20Update=20$meta=5Ftype=20descriptions=20?= =?UTF-8?q?to=20include=20=E2=80=99term=E2=80=99=20as=20a=20valid=20type?= =?UTF-8?q?=20in=20meta.php=20and=20class-wp-term-query.php.=20Props=20mac?= =?UTF-8?q?bookandrew.=20Merges=20[43557]=20to=20trunk.=20Fixes=20#44751.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit git-svn-id: https://develop.svn.wordpress.org/trunk@43560 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/meta.php | 44 ++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/src/wp-includes/meta.php b/src/wp-includes/meta.php index 7d44fe6222..7d51b20b92 100644 --- a/src/wp-includes/meta.php +++ b/src/wp-includes/meta.php @@ -17,7 +17,7 @@ * * @global wpdb $wpdb WordPress database abstraction object. * - * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user) + * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user). * @param int $object_id ID of the object metadata is for * @param string $meta_key Metadata key * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. @@ -57,7 +57,7 @@ function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique = * Filters whether to add metadata of a specific type. * * The dynamic portion of the hook, `$meta_type`, refers to the meta - * object type (comment, post, or user). Returning a non-null value + * object type (comment, post, term, or user). Returning a non-null value * will effectively short-circuit the function. * * @since 3.1.0 @@ -90,7 +90,7 @@ function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique = * Fires immediately before meta of a specific type is added. * * The dynamic portion of the hook, `$meta_type`, refers to the meta - * object type (comment, post, or user). + * object type (comment, post, term, or user). * * @since 3.1.0 * @@ -120,7 +120,7 @@ function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique = * Fires immediately after meta of a specific type is added. * * The dynamic portion of the hook, `$meta_type`, refers to the meta - * object type (comment, post, or user). + * object type (comment, post, term, or user). * * @since 2.9.0 * @@ -142,7 +142,7 @@ function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique = * * @global wpdb $wpdb WordPress database abstraction object. * - * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user) + * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user). * @param int $object_id ID of the object metadata is for * @param string $meta_key Metadata key * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. @@ -183,7 +183,7 @@ function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_ * Filters whether to update metadata of a specific type. * * The dynamic portion of the hook, `$meta_type`, refers to the meta - * object type (comment, post, or user). Returning a non-null value + * object type (comment, post, term, or user). Returning a non-null value * will effectively short-circuit the function. * * @since 3.1.0 @@ -235,7 +235,7 @@ function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_ * Fires immediately before updating metadata of a specific type. * * The dynamic portion of the hook, `$meta_type`, refers to the meta - * object type (comment, post, or user). + * object type (comment, post, term, or user). * * @since 2.9.0 * @@ -273,7 +273,7 @@ function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_ * Fires immediately after updating metadata of a specific type. * * The dynamic portion of the hook, `$meta_type`, refers to the meta - * object type (comment, post, or user). + * object type (comment, post, term, or user). * * @since 2.9.0 * @@ -309,7 +309,7 @@ function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_ * * @global wpdb $wpdb WordPress database abstraction object. * - * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user) + * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user). * @param int $object_id ID of the object metadata is for * @param string $meta_key Metadata key * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete @@ -349,7 +349,7 @@ function delete_metadata( $meta_type, $object_id, $meta_key, $meta_value = '', $ * Filters whether to delete metadata of a specific type. * * The dynamic portion of the hook, `$meta_type`, refers to the meta - * object type (comment, post, or user). Returning a non-null value + * object type (comment, post, term, or user). Returning a non-null value * will effectively short-circuit the function. * * @since 3.1.0 @@ -397,7 +397,7 @@ function delete_metadata( $meta_type, $object_id, $meta_key, $meta_value = '', $ * Fires immediately before deleting metadata of a specific type. * * The dynamic portion of the hook, `$meta_type`, refers to the meta - * object type (comment, post, or user). + * object type (comment, post, term, or user). * * @since 3.1.0 * @@ -440,7 +440,7 @@ function delete_metadata( $meta_type, $object_id, $meta_key, $meta_value = '', $ * Fires immediately after deleting metadata of a specific type. * * The dynamic portion of the hook name, `$meta_type`, refers to the meta - * object type (comment, post, or user). + * object type (comment, post, term, or user). * * @since 2.9.0 * @@ -471,7 +471,7 @@ function delete_metadata( $meta_type, $object_id, $meta_key, $meta_value = '', $ * * @since 2.9.0 * - * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user) + * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user). * @param int $object_id ID of the object metadata is for * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for * the specified object. @@ -494,7 +494,7 @@ function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) * Filters whether to retrieve metadata of a specific type. * * The dynamic portion of the hook, `$meta_type`, refers to the meta - * object type (comment, post, or user). Returning a non-null value + * object type (comment, post, term, or user). Returning a non-null value * will effectively short-circuit the function. * * @since 3.1.0 @@ -545,7 +545,7 @@ function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) * * @since 3.3.0 * - * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user) + * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user). * @param int $object_id ID of the object metadata is for * @param string $meta_key Metadata key. * @return bool True of the key is set, false if not. @@ -630,7 +630,7 @@ function get_metadata_by_mid( $meta_type, $meta_id ) { * * @global wpdb $wpdb WordPress database abstraction object. * - * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user) + * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user). * @param int $meta_id ID for a specific meta row * @param string $meta_value Metadata value * @param string $meta_key Optional, you can provide a meta key to update it @@ -813,7 +813,7 @@ function delete_metadata_by_mid( $meta_type, $meta_id ) { * * @global wpdb $wpdb WordPress database abstraction object. * - * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user) + * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user). * @param int|array $object_ids Array or comma delimited list of object IDs to update cache for * @return array|false Metadata cache for the specified objects, or false on failure. */ @@ -931,7 +931,7 @@ function get_meta_sql( $meta_query, $type, $primary_table, $primary_id_column, $ * * @global wpdb $wpdb WordPress database abstraction object. * - * @param string $type Type of object to get metadata table for (e.g., comment, post, or user) + * @param string $type Type of object to get metadata table for (e.g., comment, post, term, or user). * @return string|false Metadata table name, or false if no metadata table exists */ function _get_meta_table( $type ) { @@ -952,7 +952,7 @@ function _get_meta_table( $type ) { * @since 3.1.3 * * @param string $meta_key Meta key. - * @param string|null $meta_type Optional. Type of object metadata is for (e.g., comment, post, or user). + * @param string|null $meta_type Optional. Type of object metadata is for (e.g., comment, post, term, or user). * @return bool Whether the meta key is considered protected. */ function is_protected_meta( $meta_key, $meta_type = null ) { @@ -965,7 +965,7 @@ function is_protected_meta( $meta_key, $meta_type = null ) { * * @param bool $protected Whether the key is considered protected. * @param string $meta_key Meta key. - * @param string|null $meta_type Type of object metadata is for (e.g., comment, post, or user). + * @param string|null $meta_type Type of object metadata is for (e.g., comment, post, term, or user). */ return apply_filters( 'is_protected_meta', $protected, $meta_key, $meta_type ); } @@ -990,7 +990,7 @@ function sanitize_meta( $meta_key, $meta_value, $object_type, $object_subtype = * Filters the sanitization of a specific meta key of a specific meta type and subtype. * * The dynamic portions of the hook name, `$object_type`, `$meta_key`, - * and `$object_subtype`, refer to the metadata object type (comment, post, term or user), + * and `$object_subtype`, refer to the metadata object type (comment, post, term, or user), * the meta key value, and the object subtype respectively. * * @since 4.9.8 @@ -1007,7 +1007,7 @@ function sanitize_meta( $meta_key, $meta_value, $object_type, $object_subtype = * Filters the sanitization of a specific meta key of a specific meta type. * * The dynamic portions of the hook name, `$meta_type`, and `$meta_key`, - * refer to the metadata object type (comment, post, or user) and the meta + * refer to the metadata object type (comment, post, term, or user) and the meta * key value, respectively. * * @since 3.3.0