Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-29 07:37:44 +02:00
Code Issues Projects Releases Wiki Activity

Add inline documentation for default arguments in wp_insert_category().

Browse Source 
See #28298.

Built from https://develop.svn.wordpress.org/trunk@28474


git-svn-id: http://core.svn.wordpress.org/trunk@28301 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-05-18 07:28:14 +00:00
parent c453340a49
commit d75ca7aaaf
1 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
wp-admin/includes/taxonomy.php
View File

@ -84,10 +84,23 @@ function wp_create_categories($categories, $post_id = '') {
* Updates an existing Category or creates a new Category. * Updates an existing Category or creates a new Category.
* *
* @since 2.0.0 * @since 2.0.0
* @since 2.5.0 $wp_error parameter was added.
* @since 3.0.0 The 'taxonomy' argument was added.
* *
* @param mixed $catarr See defaults below. Set 'cat_ID' to a non-zero value to update an existing category. The 'taxonomy' key was added in 3.0.0. * @param array $catarr {
* @param bool $wp_error Optional, since 2.5.0. Set this to true if the caller handles WP_Error return values. * Array of arguments for inserting a new category.
* @return int|object The ID number of the new or updated Category on success. Zero or a WP_Error on failure, depending on param $wp_error. *
* @type int $cat_ID Categoriy ID. A non-zero value updates an existing category.
* Default 0.
* @type string $taxonomy Taxonomy slug. Defualt 'category'.
* @type string $cat_nam Category name. Default empty.
* @type string $category_description Category description. Default empty.
* @type string $category_nicename Category nice (display) name. Default empty.
* @type int|string $category_parent Category parent ID. Default empty.
* }
* @param bool $wp_error Optional. Default false.
* @return int|object The ID number of the new or updated Category on success. Zero or a WP_Error on failure,
* depending on param $wp_error.
*/ */
function wp_insert_category( $catarr, $wp_error = false ) { function wp_insert_category( $catarr, $wp_error = false ) {
$cat_defaults = array( 'cat_ID' => 0, 'taxonomy' => 'category', 'cat_name' => '', 'category_description' => '', 'category_nicename' => '', 'category_parent' => '' ); $cat_defaults = array( 'cat_ID' => 0, 'taxonomy' => 'category', 'cat_name' => '', 'category_description' => '', 'category_nicename' => '', 'category_parent' => '' );