wp_set_post_categories() – Sets categories for a post.

You appear to be a bot. Output may be restricted

Description

Sets categories for a post.

If no categories are provided, the default category is used.

Usage

$array|false|WP_Error = wp_set_post_categories( $post_id, $post_categories, $append );

Parameters

$post_id
( int ) optional – Optional. The Post ID. Does not default to the ID of the global $post. Default 0.
$post_categories
( int[]|int ) optional – Optional. List of category IDs, or the ID of a single category. Default empty array.
$append
( bool ) optional – If true, don't delete existing categories, just add on. If false, replace the categories with the new categories.

Returns

array|false|WP_Error Array of term taxonomy IDs of affected categories. WP_Error or false on failure.

Source

File name: wordpress/wp-includes/post.php


Lines:

1 to 38 of 38
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 );
}
 

 View on GitHub View on Trac