mirror of
https://github.com/WordPress/WordPress.git
synced 2024-11-05 10:22:23 +01:00
cb58f19135
Props kpdesign for the initial patch. Fixes #27433. Built from https://develop.svn.wordpress.org/trunk@27674 git-svn-id: http://core.svn.wordpress.org/trunk@27517 1a063a9b-81f0-0310-95a4-ce76da25c4cd
266 lines
6.0 KiB
PHP
266 lines
6.0 KiB
PHP
<?php
|
|
/**
|
|
* WordPress Taxonomy Administration API.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage Administration
|
|
*/
|
|
|
|
//
|
|
// Category
|
|
//
|
|
|
|
/**
|
|
* {@internal Missing Short Description}}
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param unknown_type $cat_name
|
|
* @return unknown
|
|
*/
|
|
function category_exists($cat_name, $parent = 0) {
|
|
$id = term_exists($cat_name, 'category', $parent);
|
|
if ( is_array($id) )
|
|
$id = $id['term_id'];
|
|
return $id;
|
|
}
|
|
|
|
/**
|
|
* {@internal Missing Short Description}}
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param unknown_type $id
|
|
* @return unknown
|
|
*/
|
|
function get_category_to_edit( $id ) {
|
|
$category = get_term( $id, 'category', OBJECT, 'edit' );
|
|
_make_cat_compat( $category );
|
|
return $category;
|
|
}
|
|
|
|
/**
|
|
* {@internal Missing Short Description}}
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param unknown_type $cat_name
|
|
* @param unknown_type $parent
|
|
* @return unknown
|
|
*/
|
|
function wp_create_category( $cat_name, $parent = 0 ) {
|
|
if ( $id = category_exists($cat_name, $parent) )
|
|
return $id;
|
|
|
|
return wp_insert_category( array('cat_name' => $cat_name, 'category_parent' => $parent) );
|
|
}
|
|
|
|
/**
|
|
* {@internal Missing Short Description}}
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param unknown_type $categories
|
|
* @param unknown_type $post_id
|
|
* @return unknown
|
|
*/
|
|
function wp_create_categories($categories, $post_id = '') {
|
|
$cat_ids = array ();
|
|
foreach ($categories as $category) {
|
|
if ($id = category_exists($category))
|
|
$cat_ids[] = $id;
|
|
else
|
|
if ($id = wp_create_category($category))
|
|
$cat_ids[] = $id;
|
|
}
|
|
|
|
if ( $post_id )
|
|
wp_set_post_categories($post_id, $cat_ids);
|
|
|
|
return $cat_ids;
|
|
}
|
|
|
|
/**
|
|
* Updates an existing Category or creates a new Category.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @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 bool $wp_error Optional, since 2.5.0. Set this to true if the caller handles WP_Error return values.
|
|
* @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) {
|
|
$cat_defaults = array('cat_ID' => 0, 'taxonomy' => 'category', 'cat_name' => '', 'category_description' => '', 'category_nicename' => '', 'category_parent' => '');
|
|
$catarr = wp_parse_args($catarr, $cat_defaults);
|
|
extract($catarr, EXTR_SKIP);
|
|
|
|
if ( trim( $cat_name ) == '' ) {
|
|
if ( ! $wp_error )
|
|
return 0;
|
|
else
|
|
return new WP_Error( 'cat_name', __('You did not enter a category name.') );
|
|
}
|
|
|
|
$cat_ID = (int) $cat_ID;
|
|
|
|
// Are we updating or creating?
|
|
if ( !empty ($cat_ID) )
|
|
$update = true;
|
|
else
|
|
$update = false;
|
|
|
|
$name = $cat_name;
|
|
$description = $category_description;
|
|
$slug = $category_nicename;
|
|
$parent = $category_parent;
|
|
|
|
$parent = (int) $parent;
|
|
if ( $parent < 0 )
|
|
$parent = 0;
|
|
|
|
if ( empty( $parent ) || ! term_exists( $parent, $taxonomy ) || ( $cat_ID && term_is_ancestor_of( $cat_ID, $parent, $taxonomy ) ) )
|
|
$parent = 0;
|
|
|
|
$args = compact('name', 'slug', 'parent', 'description');
|
|
|
|
if ( $update )
|
|
$cat_ID = wp_update_term($cat_ID, $taxonomy, $args);
|
|
else
|
|
$cat_ID = wp_insert_term($cat_name, $taxonomy, $args);
|
|
|
|
if ( is_wp_error($cat_ID) ) {
|
|
if ( $wp_error )
|
|
return $cat_ID;
|
|
else
|
|
return 0;
|
|
}
|
|
|
|
return $cat_ID['term_id'];
|
|
}
|
|
|
|
/**
|
|
* Aliases wp_insert_category() with minimal args.
|
|
*
|
|
* If you want to update only some fields of an existing category, call this
|
|
* function with only the new values set inside $catarr.
|
|
*
|
|
* @since 2.0.0
|
|
*
|
|
* @param array $catarr The 'cat_ID' value is required. All other keys are optional.
|
|
* @return int|bool The ID number of the new or updated Category on success. Zero or FALSE on failure.
|
|
*/
|
|
function wp_update_category($catarr) {
|
|
$cat_ID = (int) $catarr['cat_ID'];
|
|
|
|
if ( isset($catarr['category_parent']) && ($cat_ID == $catarr['category_parent']) )
|
|
return false;
|
|
|
|
// First, get all of the original fields
|
|
$category = get_term( $cat_ID, 'category', ARRAY_A );
|
|
_make_cat_compat( $category );
|
|
|
|
// Escape data pulled from DB.
|
|
$category = wp_slash($category);
|
|
|
|
// Merge old and new fields with new fields overwriting old ones.
|
|
$catarr = array_merge($category, $catarr);
|
|
|
|
return wp_insert_category($catarr);
|
|
}
|
|
|
|
//
|
|
// Tags
|
|
//
|
|
|
|
/**
|
|
* {@internal Missing Short Description}}
|
|
*
|
|
* @since 2.3.0
|
|
*
|
|
* @param unknown_type $tag_name
|
|
* @return unknown
|
|
*/
|
|
function tag_exists($tag_name) {
|
|
return term_exists($tag_name, 'post_tag');
|
|
}
|
|
|
|
/**
|
|
* {@internal Missing Short Description}}
|
|
*
|
|
* @since 2.3.0
|
|
*
|
|
* @param unknown_type $tag_name
|
|
* @return unknown
|
|
*/
|
|
function wp_create_tag($tag_name) {
|
|
return wp_create_term( $tag_name, 'post_tag');
|
|
}
|
|
|
|
/**
|
|
* {@internal Missing Short Description}}
|
|
*
|
|
* @since 2.3.0
|
|
*
|
|
* @param unknown_type $post_id
|
|
* @return unknown
|
|
*/
|
|
function get_tags_to_edit( $post_id, $taxonomy = 'post_tag' ) {
|
|
return get_terms_to_edit( $post_id, $taxonomy);
|
|
}
|
|
|
|
/**
|
|
* {@internal Missing Short Description}}
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @param unknown_type $post_id
|
|
* @return unknown
|
|
*/
|
|
function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) {
|
|
$post_id = (int) $post_id;
|
|
if ( !$post_id )
|
|
return false;
|
|
|
|
$tags = wp_get_post_terms($post_id, $taxonomy, array());
|
|
|
|
if ( !$tags )
|
|
return false;
|
|
|
|
if ( is_wp_error($tags) )
|
|
return $tags;
|
|
|
|
foreach ( $tags as $tag )
|
|
$tag_names[] = $tag->name;
|
|
$tags_to_edit = join( ',', $tag_names );
|
|
$tags_to_edit = esc_attr( $tags_to_edit );
|
|
|
|
/**
|
|
* Filter the comma-separated list of terms available to edit.
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @see get_terms_to_edit()
|
|
*
|
|
* @param array $tags_to_edit An array of terms.
|
|
* @param string $taxonomy The taxonomy for which to retrieve terms. Default 'post_tag'.
|
|
*/
|
|
$tags_to_edit = apply_filters( 'terms_to_edit', $tags_to_edit, $taxonomy );
|
|
|
|
return $tags_to_edit;
|
|
}
|
|
|
|
/**
|
|
* {@internal Missing Short Description}}
|
|
*
|
|
* @since 2.8.0
|
|
*
|
|
* @param unknown_type $tag_name
|
|
* @return unknown
|
|
*/
|
|
function wp_create_term($tag_name, $taxonomy = 'post_tag') {
|
|
if ( $id = term_exists($tag_name, $taxonomy) )
|
|
return $id;
|
|
|
|
return wp_insert_term($tag_name, $taxonomy);
|
|
}
|