fetcher = new PostFetcher(); } /** * Creates a new post. * * ## OPTIONS * * [--post_author=] * : The ID of the user who added the post. Default is the current user ID. * * [--post_date=] * : The date of the post. Default is the current time. * * [--post_date_gmt=] * : The date of the post in the GMT timezone. Default is the value of $post_date. * * [--post_content=] * : The post content. Default empty. * * [--post_content_filtered=] * : The filtered post content. Default empty. * * [--post_title=] * : The post title. Default empty. * * [--post_excerpt=] * : The post excerpt. Default empty. * * [--post_status=] * : The post status. Default 'draft'. * * [--post_type=] * : The post type. Default 'post'. * * [--comment_status=] * : Whether the post can accept comments. Accepts 'open' or 'closed'. Default is the value of 'default_comment_status' option. * * [--ping_status=] * : Whether the post can accept pings. Accepts 'open' or 'closed'. Default is the value of 'default_ping_status' option. * * [--post_password=] * : The password to access the post. Default empty. * * [--post_name=] * : The post name. Default is the sanitized post title when creating a new post. * * [--from-post=] * : Post id of a post to be duplicated. * * [--to_ping=] * : Space or carriage return-separated list of URLs to ping. Default empty. * * [--pinged=] * : Space or carriage return-separated list of URLs that have been pinged. Default empty. * * [--post_modified=] * : The date when the post was last modified. Default is the current time. * * [--post_modified_gmt=] * : The date when the post was last modified in the GMT timezone. Default is the current time. * * [--post_parent=] * : Set this for the post it belongs to, if any. Default 0. * * [--menu_order=] * : The order the post should be displayed in. Default 0. * * [--post_mime_type=] * : The mime type of the post. Default empty. * * [--guid=] * : Global Unique ID for referencing the post. Default empty. * * [--post_category=] * : Array of category names, slugs, or IDs. Defaults to value of the 'default_category' option. * * [--tags_input=] * : Array of tag names, slugs, or IDs. Default empty. * * [--tax_input=] * : Array of taxonomy terms keyed by their taxonomy name. Default empty. * * Note: In WordPress core, this normally requires a user context to satisfy capability checks. WP-CLI bypasses this for convenience. See https://core.trac.wordpress.org/ticket/19373 * * [--meta_input=] * : Array in JSON format of post meta values keyed by their post meta key. Default empty. * * [--page_template=] * : Page template to use. * * [--import_id=] * : The post ID to be used when inserting a new post. If specified, must not * match any existing post ID. * * [] * : Read post content from . If this value is present, the * `--post_content` argument will be ignored. * * Passing `-` as the filename will cause post content to * be read from STDIN. * * [--=] * : Associative args for the new post. See wp_insert_post(). * * [--edit] * : Immediately open system's editor to write or edit post content. * * If content is read from a file, from STDIN, or from the `--post_content` * argument, that text will be loaded into the editor. * * [--porcelain] * : Output just the new post id. * * * ## EXAMPLES * * # Create post and schedule for future * $ wp post create --post_type=post --post_title='A future post' --post_status=future --post_date='2030-12-01 07:00:00' * Success: Created post 1921. * * # Create post with content from given file * $ wp post create ./post-content.txt --post_category=201,345 --post_title='Post from file' * Success: Created post 1922. * * # Create a post with multiple meta values. * $ wp post create --post_title='A post' --post_content='Just a small post.' --meta_input='{"key1":"value1","key2":"value2"}' * Success: Created post 1923. * * # Create a duplicate post from existing posts. * $ wp post create --from-post=123 --post_title='Different Title' * Success: Created post 2350. */ public function create( $args, $assoc_args ) { if ( ! empty( $args[0] ) ) { $assoc_args['post_content'] = $this->read_from_file_or_stdin( $args[0] ); } if ( Utils\get_flag_value( $assoc_args, 'edit' ) ) { $input = Utils\get_flag_value( $assoc_args, 'post_content', '' ); $output = $this->_edit( $input, 'WP-CLI: New Post' ); if ( $output ) { $assoc_args['post_content'] = $output; } else { $assoc_args['post_content'] = $input; } } if ( isset( $assoc_args['post_category'] ) ) { $assoc_args['post_category'] = $this->get_category_ids( $assoc_args['post_category'] ); } $array_arguments = [ 'meta_input', 'tax_input' ]; $assoc_args = Utils\parse_shell_arrays( $assoc_args, $array_arguments ); if ( isset( $assoc_args['from-post'] ) ) { $post = $this->fetcher->get_check( $assoc_args['from-post'] ); $post_arr = get_object_vars( $post ); $post_id = $post_arr['ID']; unset( $post_arr['post_date'] ); unset( $post_arr['post_date_gmt'] ); unset( $post_arr['post_modified'] ); unset( $post_arr['post_modified_gmt'] ); unset( $post_arr['guid'] ); unset( $post_arr['ID'] ); if ( empty( $assoc_args['meta_input'] ) ) { $assoc_args['meta_input'] = $this->get_metadata( $post_id ); } if ( empty( $assoc_args['post_category'] ) ) { $post_arr['post_category'] = $this->get_category( $post_id ); } if ( empty( $assoc_args['tags_input'] ) ) { $post_arr['tags_input'] = $this->get_tags( $post_id ); } $assoc_args = array_merge( $post_arr, $assoc_args ); } $assoc_args = wp_slash( $assoc_args ); parent::_create( $args, $assoc_args, function ( $params ) { $modified_callback = self::add_post_modified_filter( $params ); if ( is_wp_error( $modified_callback ) ) { return $modified_callback; } $filter_callback = null; if ( 0 === get_current_user_id() && ! empty( $params['tax_input'] ) ) { $allowed_caps = []; /** * @var string $taxonomy */ foreach ( array_keys( $params['tax_input'] ) as $taxonomy ) { $tax_obj = get_taxonomy( $taxonomy ); if ( $tax_obj ) { $primitive_caps = map_meta_cap( $tax_obj->cap->assign_terms, 0 ); $allowed_caps = array_merge( $allowed_caps, $primitive_caps ); } } if ( ! empty( $allowed_caps ) ) { $filter_callback = function ( $allcaps, $caps ) use ( $allowed_caps ) { foreach ( $caps as $cap ) { if ( in_array( $cap, $allowed_caps, true ) ) { $allcaps[ $cap ] = true; } } return $allcaps; }; add_filter( 'user_has_cap', $filter_callback, 10, 2 ); } } $result = wp_insert_post( $params, true ); if ( $modified_callback ) { self::remove_post_modified_filter( $modified_callback ); } if ( $filter_callback ) { remove_filter( 'user_has_cap', $filter_callback ); } return $result; } ); } /** * Applies an explicitly requested modification date. * * wp_insert_post() derives post_modified and post_modified_gmt itself and * never reads them back from $postarr — on update they are unconditionally * the current time — so the documented parameters have to be applied to the * post data on its way to the database. * * The filter runs after core has validated post_date, and both * get_gmt_from_date() and get_date_from_gmt() fall back to the epoch for a * value they cannot parse, so the supplied dates are validated here the same * way core validates post_date. * * @param array $params Parameters passed to wp_insert_post() or wp_update_post(). * @return callable|WP_Error|null The registered callback, for the caller to remove; a WP_Error * when a supplied date is invalid; or null when no modification * date was requested. */ private static function add_post_modified_filter( $params ) { $local = ! empty( $params['post_modified'] ) && is_scalar( $params['post_modified'] ) ? (string) $params['post_modified'] : null; $gmt = ! empty( $params['post_modified_gmt'] ) && is_scalar( $params['post_modified_gmt'] ) ? (string) $params['post_modified_gmt'] : null; if ( null === $local && null === $gmt ) { return null; } foreach ( [ $local, $gmt ] as $date ) { if ( null !== $date && ! self::is_valid_post_date( $date ) ) { return new WP_Error( 'invalid_date', __( 'Invalid date.' ) ); } } // Keep the pair consistent when only one of the two was given. if ( null === $gmt ) { $gmt = get_gmt_from_date( $local ); } elseif ( null === $local ) { $local = get_date_from_gmt( $gmt ); } $modified = [ 'post_modified' => $local, 'post_modified_gmt' => $gmt, ]; $callback = static function ( $data ) use ( $modified, &$callback ) { // The first post to reach this filter is the command's own. A save hook // can insert further posts before the outer call returns, and those must // keep their own dates, so the filter unhooks itself right away. self::remove_post_modified_filter( $callback ); return array_merge( $data, $modified ); }; // Attachments go through wp_insert_attachment_data instead. add_filter( 'wp_insert_post_data', $callback ); add_filter( 'wp_insert_attachment_data', $callback ); return $callback; } /** * Removes the callback registered by add_post_modified_filter(). * * The callback removes itself once it has run; this is the fallback for when * it never ran, for instance because wp_insert_post() bailed out early. * * @param callable $callback The callback to remove. * @return void */ private static function remove_post_modified_filter( $callback ) { remove_filter( 'wp_insert_post_data', $callback ); remove_filter( 'wp_insert_attachment_data', $callback ); } /** * Checks a date the way core checks post_date in wp_resolve_post_date(). * * @param string $date Date in MySQL format. * @return bool Whether the date is valid. */ private static function is_valid_post_date( $date ) { if ( ! preg_match( '/^(\d{4})-(\d{1,2})-(\d{1,2})/', $date, $matches ) ) { return false; } return wp_checkdate( (int) $matches[2], (int) $matches[3], (int) $matches[1], $date ); } /** * Updates one or more existing posts. * * ## OPTIONS * * ... * : One or more IDs of posts to update. * * [--post_author=] * : The ID of the user who added the post. Default is the current user ID. * * [--post_date=] * : The date of the post. Default is the current time. * * [--post_date_gmt=] * : The date of the post in the GMT timezone. Default is the value of $post_date. * * [--post_content=] * : The post content. Default empty. * * [--post_content_filtered=] * : The filtered post content. Default empty. * * [--post_title=] * : The post title. Default empty. * * [--post_excerpt=] * : The post excerpt. Default empty. * * [--post_status=] * : The post status. Default 'draft'. * * [--post_type=] * : The post type. Default 'post'. * * [--comment_status=] * : Whether the post can accept comments. Accepts 'open' or 'closed'. Default is the value of 'default_comment_status' option. * * [--ping_status=] * : Whether the post can accept pings. Accepts 'open' or 'closed'. Default is the value of 'default_ping_status' option. * * [--post_password=] * : The password to access the post. Default empty. * * [--post_name=] * : The post name. Default is the sanitized post title when creating a new post. * * [--to_ping=] * : Space or carriage return-separated list of URLs to ping. Default empty. * * [--pinged=] * : Space or carriage return-separated list of URLs that have been pinged. Default empty. * * [--post_modified=] * : The date when the post was last modified. Default is the current time. * * [--post_modified_gmt=] * : The date when the post was last modified in the GMT timezone. Default is the current time. * * [--post_parent=] * : Set this for the post it belongs to, if any. Default 0. * * [--menu_order=] * : The order the post should be displayed in. Default 0. * * [--post_mime_type=] * : The mime type of the post. Default empty. * * [--guid=] * : Global Unique ID for referencing the post. Default empty. * * [--post_category=] * : Array of category names, slugs, or IDs. Defaults to value of the 'default_category' option. * * [--tags_input=] * : Array of tag names, slugs, or IDs. Default empty. * * [--tax_input=] * : Array of taxonomy terms keyed by their taxonomy name. Default empty. * * Note: In WordPress core, this normally requires a user context to satisfy capability checks. WP-CLI bypasses this for convenience. See https://core.trac.wordpress.org/ticket/19373 * * [--meta_input=] * : Array in JSON format of post meta values keyed by their post meta key. Default empty. * * [--page_template=] * : Page template to use. * * [] * : Read post content from . If this value is present, the * `--post_content` argument will be ignored. * * Passing `-` as the filename will cause post content to * be read from STDIN. * * --= * : One or more fields to update. See wp_insert_post(). * * [--defer-term-counting] * : Recalculate term count in batch, for a performance boost. * * ## EXAMPLES * * $ wp post update 123 --post_name=something --post_status=draft * Success: Updated post 123. * * # Update a post with multiple meta values. * $ wp post update 123 --meta_input='{"key1":"value1","key2":"value2"}' * Success: Updated post 123. * * # Update multiple posts at once. * $ wp post update 123 456 --post_author=789 * Success: Updated post 123. * Success: Updated post 456. * * # Update all posts of a given post type at once. * $ wp post update $(wp post list --post_type=page --format=ids) --post_author=123 * Success: Updated post 123. * Success: Updated post 456. */ public function update( $args, $assoc_args ) { foreach ( $args as $key => $arg ) { if ( is_numeric( $arg ) ) { continue; } $assoc_args['post_content'] = $this->read_from_file_or_stdin( $arg ); unset( $args[ $key ] ); break; } if ( isset( $assoc_args['post_category'] ) ) { $assoc_args['post_category'] = $this->get_category_ids( $assoc_args['post_category'] ); } $array_arguments = [ 'meta_input', 'tax_input' ]; $assoc_args = Utils\parse_shell_arrays( $assoc_args, $array_arguments ); $assoc_args = wp_slash( $assoc_args ); parent::_update( $args, $assoc_args, function ( $params ) { $modified_callback = self::add_post_modified_filter( $params ); if ( is_wp_error( $modified_callback ) ) { return $modified_callback; } $filter_callback = null; if ( 0 === get_current_user_id() && ! empty( $params['tax_input'] ) ) { $allowed_caps = []; /** * @var string $taxonomy */ foreach ( array_keys( $params['tax_input'] ) as $taxonomy ) { $tax_obj = get_taxonomy( $taxonomy ); if ( $tax_obj ) { $primitive_caps = map_meta_cap( $tax_obj->cap->assign_terms, 0 ); $allowed_caps = array_merge( $allowed_caps, $primitive_caps ); } } if ( ! empty( $allowed_caps ) ) { $filter_callback = function ( $allcaps, $caps ) use ( $allowed_caps ) { foreach ( $caps as $cap ) { if ( in_array( $cap, $allowed_caps, true ) ) { $allcaps[ $cap ] = true; } } return $allcaps; }; add_filter( 'user_has_cap', $filter_callback, 10, 2 ); } } $result = wp_update_post( $params, true ); if ( $modified_callback ) { self::remove_post_modified_filter( $modified_callback ); } if ( $filter_callback ) { remove_filter( 'user_has_cap', $filter_callback ); } return $result; } ); } /** * Launches system editor to edit post content. * * ## OPTIONS * * * : The ID of the post to edit. * * ## EXAMPLES * * # Launch system editor to edit post * $ wp post edit 123 */ public function edit( $args, $assoc_args ) { $post = $this->fetcher->get_check( $args[0] ); $result = $this->_edit( $post->post_content, "WP-CLI post {$post->ID}" ); if ( false === $result ) { WP_CLI::warning( 'No change made to post content.' ); } else { $this->update( $args, [ 'post_content' => $result ] ); } } // phpcs:ignore PSR2.Methods.MethodDeclaration.Underscore -- Whitelisting to provide backward compatibility to classes possibly extending this class. protected function _edit( $content, $title ) { // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound -- Calling native WordPress hook. $content = apply_filters( 'the_editor_content', $content ); $output = Utils\launch_editor_for_input( $content, $title ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedHooknameFound -- Calling native WordPress hook. return ( is_string( $output ) ) ? apply_filters( 'content_save_pre', $output ) : $output; } /** * Gets details about a post. * * ## OPTIONS * * * : The ID of the post to get. * * [--field=] * : Instead of returning the whole post, returns the value of a single field. * * [--fields=] * : Limit the output to specific fields. Defaults to all fields. * * [--format=] * : Render output in a particular format. * --- * default: table * options: * - table * - csv * - json * - yaml * --- * * ## EXAMPLES * * # Save the post content to a file * $ wp post get 123 --field=content > file.txt * * # Get the block version of a post (1 = has blocks, 0 = no blocks) * # Requires WordPress 5.0+. * $ wp post get 123 --field=block_version * 1 */ public function get( $args, $assoc_args ) { $post = $this->fetcher->get_check( $args[0] ); $post_arr = get_object_vars( $post ); unset( $post_arr['filter'] ); if ( ! isset( $post_arr['url'] ) ) { $post_arr['url'] = get_permalink( $post->ID ); } if ( function_exists( 'block_version' ) ) { $post_arr['block_version'] = block_version( $post->post_content ); } if ( empty( $assoc_args['fields'] ) ) { $assoc_args['fields'] = array_keys( $post_arr ); } $formatter = $this->get_formatter( $assoc_args ); $formatter->display_item( $post_arr ); } /** * Deletes an existing post. * * ## OPTIONS * * ... * : One or more IDs of posts to delete. * * [--force] * : Skip the trash bin. * * [--defer-term-counting] * : Recalculate term count in batch, for a performance boost. * * ## EXAMPLES * * # Delete post skipping trash * $ wp post delete 123 --force * Success: Deleted post 123. * * # Delete multiple posts * $ wp post delete 123 456 789 * Success: Trashed post 123. * Success: Trashed post 456. * Success: Trashed post 789. * * # Delete all pages * $ wp post delete $(wp post list --post_type='page' --format=ids) * Success: Trashed post 1164. * Success: Trashed post 1186. * * # Delete all posts in the trash * $ wp post delete $(wp post list --post_status=trash --format=ids) * Success: Deleted post 1268. * Success: Deleted post 1294. */ public function delete( $args, $assoc_args ) { $defaults = [ 'force' => false ]; $assoc_args = array_merge( $defaults, $assoc_args ); parent::_delete( $args, $assoc_args, [ $this, 'delete_callback' ] ); } /** * Callback used to delete a post. * * @param $post_id * @param $assoc_args * @return array */ protected function delete_callback( $post_id, $assoc_args ) { $status = get_post_status( $post_id ); $post_type = get_post_type( $post_id ); $force_delete = $assoc_args['force'] || 'trash' === $status || 'revision' === $post_type; if ( $force_delete || ! EMPTY_TRASH_DAYS ) { if ( ! wp_delete_post( $post_id, true ) ) { return [ 'error', "Failed deleting post {$post_id}." ]; } return [ 'success', "Deleted post {$post_id}." ]; } // Use wp_trash_post() directly because wp_delete_post() only auto-trashes // 'post' and 'page' types, permanently deleting all other post types even // when $force_delete is false. wp_trash_post() works for all post types. if ( wp_trash_post( $post_id ) ) { return [ 'success', "Trashed post {$post_id}." ]; } return [ 'error', "Failed trashing post {$post_id}." ]; } /** * Gets a list of posts. * * Display posts based on all arguments supported by [WP_Query()](https://developer.wordpress.org/reference/classes/wp_query/). * Only shows post types marked as post by default. * * ## OPTIONS * * [--=] * : One or more args to pass to WP_Query. The arguments below are the ones * that filter on what this command displays; anything else WP_Query accepts * still works and is documented with WP_Query itself. * * [--p=|ID] * : Filter by post ID. `--ID` is the name of the column this filters and is * accepted as an alias. * * [--title=