wp_set_post_categories() │ WP 2.1.0
Set categories for a post.
If no categories are provided, the default category is used.
Return
Array|false|WP_Error
. Array of term taxonomy IDs of affected categories. WP_Error or false on failure.
Usage
wp_set_post_categories( $post_ID, $post_categories, $append );
- $post_ID(int)
- The Post ID. Does not default to the ID of the global $post.
- $post_categories(int[]|int)
- List of category IDs, or the ID of a single category.
Default: empty array
- $append(true|false)
- If true, don't delete existing categories, just add on. If false, replace the categories with the new categories.
Default: false
Changelog
Code of wp_set_post_categories() wp set post categories
WP 5.9.3
function wp_set_post_categories( $post_ID = 0, $post_categories = array(), $append = false ) {
$post_ID = (int) $post_ID;
$post_type = get_post_type( $post_ID );
$post_status = get_post_status( $post_ID );
// If $post_categories isn't already an array, make it one.
$post_categories = (array) $post_categories;
if ( empty( $post_categories ) ) {
/**
* Filters post types (in addition to 'post') that require a default category.
*
* @since 5.5.0
*
* @param string[] $post_types An array of post type names. Default empty array.
*/
$default_category_post_types = apply_filters( 'default_category_post_types', array() );
// Regular posts always require a default category.
$default_category_post_types = array_merge( $default_category_post_types, array( 'post' ) );
if ( in_array( $post_type, $default_category_post_types, true )
&& is_object_in_taxonomy( $post_type, 'category' )
&& 'auto-draft' !== $post_status
) {
$post_categories = array( get_option( 'default_category' ) );
$append = false;
} else {
$post_categories = array();
}
} elseif ( 1 === count( $post_categories ) && '' === reset( $post_categories ) ) {
return true;
}
return wp_set_post_terms( $post_ID, $post_categories, 'category', $append );
}
Related Functions