vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-11 12:20:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Various inline documentation corrections and improvements.

Browse Source 
See #53399


git-svn-id: https://develop.svn.wordpress.org/trunk@52332 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn
2021-12-07 12:18:50 +00:00
parent bccb23ca03
commit ba518c2d86
38 changed files with 146 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/wp-includes/taxonomy.php
+13 -15
View File
@@ -823,28 +823,26 @@ function unregister_taxonomy_for_object_type( $taxonomy, $object_type ) {
//
/**
* Retrieve object_ids of valid taxonomy and term.
* Retrieve object IDs of valid taxonomy and term.
*
* The strings of $taxonomies must exist before this function will continue.
* On failure of finding a valid taxonomy, it will return a WP_Error class,
* kind of like Exceptions in PHP 5, except you can't catch them. Even so,
* you can still test for the WP_Error class and get the error message.
* The strings of `$taxonomies` must exist before this function will continue.
* On failure of finding a valid taxonomy, it will return a WP_Error.
*
* The $terms aren't checked the same as $taxonomies, but still need to exist
* for $object_ids to be returned.
* The `$terms` aren't checked the same as `$taxonomies`, but still need to exist
* for object IDs to be returned.
*
* It is possible to change the order that object_ids is returned by either
* using PHP sort family functions or using the database by using $args with
* either ASC or DESC array. The value should be in the key named 'order'.
* It is possible to change the order that object IDs are returned by using `$args`
* with either ASC or DESC array. The value should be in the key named 'order'.
*
* @since 2.3.0
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int|array $term_ids Term ID or array of term IDs of terms that will be used.
* @param string|array $taxonomies String of taxonomy name or Array of string values of taxonomy names.
* @param array|string $args Change the order of the object_ids, either ASC or DESC.
* @return array|WP_Error An array of $object_ids on success, WP_Error if the taxonomy does not exist.
* @param int|int[] $term_ids Term ID or array of term IDs of terms that will be used.
* @param string|string[] $taxonomies String of taxonomy name or Array of string values of taxonomy names.
* @param array|string $args Change the order of the object IDs, either ASC or DESC.
* @return string[]|WP_Error An array of object IDs as numeric strings on success,
* WP_Error if the taxonomy does not exist.
*/
function get_objects_in_term( $term_ids, $taxonomies, $args = array() ) {
global $wpdb;
@@ -899,7 +897,7 @@ function get_objects_in_term( $term_ids, $taxonomies, $args = array() ) {
* @param array $tax_query A compact tax query
* @param string $primary_table
* @param string $primary_id_column
* @return array
* @return string[]
*/
function get_tax_sql( $tax_query, $primary_table, $primary_id_column ) {
$tax_query_obj = new WP_Tax_Query( $tax_query );