enmi-conf.org: comparison wp/wp-admin/includes/post.php

equal deleted inserted replaced

-:be944660c56a
+:3d72ae0968f4
 * @package WordPress
 * @subpackage Administration
 */
 /**
-* Rename $_POST data from form names to DB post columns.
+* Renames `$_POST` data from form names to DB post columns.
 *
-* Manipulates $_POST directly.
+* Manipulates `$_POST` directly.
 *
 * @since 2.6.0
 *
-* @param bool  $update    Are we updating a pre-existing post?
+* @param bool       $update    Whether the post already exists.
-* @param array $post_data Array of post data. Defaults to the contents of $_POST.
+* @param array|null $post_data Optional. The array of post data to process.
+*                              Defaults to the `$_POST` superglobal.
 * @return array|WP_Error Array of post data on success, WP_Error on failure.
 */
 function _wp_translate_postdata( $update = false, $post_data = null ) {
 	if ( empty( $post_data ) ) {
 	return $post_data;
 }
 /**
-* Returns only allowed post data fields
+* Returns only allowed post data fields.
 *
 * @since 5.0.1
 *
-* @param array $post_data Array of post data. Defaults to the contents of $_POST.
+* @param array|WP_Error|null $post_data The array of post data to process, or an error object.
+*                                       Defaults to the `$_POST` superglobal.
 * @return array|WP_Error Array of post data on success, WP_Error on failure.
 */
 function _wp_get_allowed_postdata( $post_data = null ) {
 	if ( empty( $post_data ) ) {
 		$post_data = $_POST;
 	return array_diff_key( $post_data, array_flip( array( 'meta_input', 'file', 'guid' ) ) );
 }
 /**
-* Update an existing post with values provided in $_POST.
+* Updates an existing post with values provided in `$_POST`.
 *
 * If post data is passed as an argument, it is treated as an array of data
 * keyed appropriately for turning into a post object.
 *
-* If post data is not passed, the $_POST global variable is used instead.
+* If post data is not passed, the `$_POST` global variable is used instead.
 *
 * @since 1.5.0
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @param array $post_data Optional. Defaults to the $_POST global.
+* @param array|null $post_data Optional. The array of post data to process.
+*                              Defaults to the `$_POST` superglobal.
 * @return int Post ID.
 */
 function edit_post( $post_data = null ) {
 	global $wpdb;
 	return $post_ID;
 }
 /**
-* Process the post data for the bulk editing of posts.
+* Processes the post data for the bulk editing of posts.
 *
 * Updates all bulk edited posts/pages, adding (but not removing) tags and
 * categories. Skips pages when they would be their own parent or child.
 *
 * @since 2.7.0
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @param array $post_data Optional, the array of post data to process if not provided will use $_POST superglobal.
+* @param array|null $post_data Optional. The array of post data to process.
+*                              Defaults to the `$_POST` superglobal.
 * @return array
 */
 function bulk_edit_posts( $post_data = null ) {
 	global $wpdb;
 		}
 		// Prevent wp_insert_post() from overwriting post format with the old data.
 		unset( $post_data['tax_input']['post_format'] );
-		$updated[] = wp_update_post( $post_data );
+		$post_id = wp_update_post( $post_data );
+		update_post_meta( $post_id, '_edit_last', get_current_user_id() );
+		$updated[] = $post_id;
 		if ( isset( $post_data['sticky'] ) && current_user_can( $ptype->cap->edit_others_posts ) ) {
 			if ( 'sticky' === $post_data['sticky'] ) {
 				stick_post( $post_ID );
 			} else {
 		'locked'  => $locked,
 	);
 }
 /**
-* Default post information to use when populating the "Write Post" form.
+* Returns default post information to use when populating the "Write Post" form.
 *
 * @since 2.0.0
 *
 * @param string $post_type    Optional. A post type string. Default 'post'.
 * @param bool   $create_in_db Optional. Whether to insert the post into database. Default false.
 * @since 5.8.0 Added the `$status` parameter.
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
 * @param string $title   Post title.
-* @param string $content Optional post content.
+* @param string $content Optional. Post content.
-* @param string $date    Optional post date.
+* @param string $date    Optional. Post date.
-* @param string $type    Optional post type.
+* @param string $type    Optional. Post type.
-* @param string $status  Optional post status.
+* @param string $status  Optional. Post status.
 * @return int Post ID if post exists, 0 otherwise.
 */
 function post_exists( $title, $content = '', $date = '', $type = '', $status = '' ) {
 	global $wpdb;
 	return 0;
 }
 /**
-* Creates a new post from the "Write Post" form using $_POST information.
+* Creates a new post from the "Write Post" form using `$_POST` information.
 *
 * @since 2.1.0
 *
 * @global WP_User $current_user
 *
 //
 // Post Meta.
 //
 /**
-* Add post meta data defined in $_POST superglobal for post with given ID.
+* Adds post meta data defined in the `$_POST` superglobal for a post with given ID.
 *
 * @since 1.2.0
 *
 * @param int $post_ID
 * @return int|bool
 	return false;
 }
 /**
-* Delete post meta data by meta ID.
+* Deletes post meta data by meta ID.
 *
 * @since 1.2.0
 *
 * @param int $mid
 * @return bool
 function delete_meta( $mid ) {
 	return delete_metadata_by_mid( 'post', $mid );
 }
 /**
-* Get a list of previously defined keys.
+* Returns a list of previously defined keys.
 *
 * @since 1.2.0
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @return mixed
+* @return string[] Array of meta key names.
 */
 function get_meta_keys() {
 	global $wpdb;
 	$keys = $wpdb->get_col(
 	return $keys;
 }
 /**
-* Get post meta data by meta ID.
+* Returns post meta data by meta ID.
 *
 * @since 2.1.0
 *
 * @param int $mid
 * @return object|bool
 function get_post_meta_by_id( $mid ) {
 	return get_metadata_by_mid( 'post', $mid );
 }
 /**
-* Get meta data for the given post ID.
+* Returns meta data for the given post ID.
 *
 * @since 1.2.0
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @param int $postid
+* @param int $postid A post ID.
-* @return mixed
+* @return array[] {
+*     Array of meta data arrays for the given post ID.
+*
+*     @type array ...$0 {
+*         Associative array of meta data.
+*
+*         @type string $meta_key   Meta key.
+*         @type mixed  $meta_value Meta value.
+*         @type string $meta_id    Meta ID as a numeric string.
+*         @type string $post_id    Post ID as a numeric string.
+*     }
+* }
 */
 function has_meta( $postid ) {
 	global $wpdb;
 	return $wpdb->get_results(
 		ARRAY_A
 	);
 }
 /**
-* Update post meta data by meta ID.
+* Updates post meta data by meta ID.
 *
 * @since 1.2.0
 *
-* @param int    $meta_id
+* @param int    $meta_id    Meta ID.
-* @param string $meta_key Expect Slashed
+* @param string $meta_key   Meta key. Expect slashed.
-* @param string $meta_value Expect Slashed
+* @param string $meta_value Meta value. Expect slashed.
 * @return bool
 */
 function update_meta( $meta_id, $meta_key, $meta_value ) {
 	$meta_key   = wp_unslash( $meta_key );
 	$meta_value = wp_unslash( $meta_value );
 //
 // Private.
 //
 /**
-* Replace hrefs of attachment anchors with up-to-date permalinks.
+* Replaces hrefs of attachment anchors with up-to-date permalinks.
 *
 * @since 2.3.0
 * @access private
 *
 * @param int|object $post Post ID or post object.
 		return wp_update_post( $post );
 	}
 }
 /**
-* Get all the possible statuses for a post_type
+* Returns all the possible statuses for a post type.
 *
 * @since 2.5.0
 *
 * @param string $type The post_type you want the statuses for. Default 'post'.
 * @return string[] An array of all the statuses for the supplied post type.
 	return array_keys( get_object_vars( $stati ) );
 }
 /**
-* Run the wp query to fetch the posts for listing on the edit posts page
+* Runs the query to fetch the posts for listing on the edit posts page.
 *
 * @since 2.5.0
 *
-* @param array|false $q Array of query variables to use to build the query or false to use $_GET superglobal.
+* @param array|false $q Optional. Array of query variables to use to build the query.
+*                       Defaults to the `$_GET` superglobal.
 * @return array
 */
 function wp_edit_posts_query( $q = false ) {
 	if ( false === $q ) {
 		$q = $_GET;
 	return $avail_post_stati;
 }
 /**
-* Get the query variables for the current attachments request.
+* Returns the query variables for the current attachments request.
 *
 * @since 4.2.0
 *
-* @param array|false $q Optional. Array of query variables to use to build the query or false
+* @param array|false $q Optional. Array of query variables to use to build the query.
-*                       to use $_GET superglobal. Default false.
+*                       Defaults to the `$_GET` superglobal.
 * @return array The parsed query vars.
 */
 function wp_edit_attachments_query_vars( $q = false ) {
 	if ( false === $q ) {
 		$q = $_GET;
 * Executes a query for attachments. An array of WP_Query arguments
 * can be passed in, which will override the arguments set by this function.
 *
 * @since 2.5.0
 *
-* @param array|false $q Array of query variables to use to build the query or false to use $_GET superglobal.
+* @param array|false $q Optional. Array of query variables to use to build the query.
+*                       Defaults to the `$_GET` superglobal.
 * @return array
 */
 function wp_edit_attachments_query( $q = false ) {
 	wp( wp_edit_attachments_query_vars( $q ) );
 	 * @since 3.2.0
 	 *
 	 * @param string[] $classes An array of postbox classes.
 	 */
 	$classes = apply_filters( "postbox_classes_{$screen_id}_{$box_id}", $classes );
 	return implode( ' ', $classes );
 }
 /**
-* Get a sample permalink based off of the post name.
+* Returns a sample permalink based on the post name.
 *
 * @since 2.5.0
 *
 * @param int|WP_Post $id    Post ID or post object.
-* @param string      $title Optional. Title to override the post's current title when generating the post name. Default null.
+* @param string|null $title Optional. Title to override the post's current title
-* @param string      $name  Optional. Name to override the post name. Default null.
+*                           when generating the post name. Default null.
+* @param string|null $name  Optional. Name to override the post name. Default null.
 * @return array {
 *     Array containing the sample permalink with placeholder for the post name, and the post name.
 *
 *     @type string $0 The permalink with placeholder for the post name.
 *     @type string $1 The post name.
 	 *     Array containing the sample permalink with placeholder for the post name, and the post name.
 	 *
 	 *     @type string $0 The permalink with placeholder for the post name.
 	 *     @type string $1 The post name.
 	 * }
-	 * @param int     $post_id   Post ID.
+	 * @param int     $post_id Post ID.
-	 * @param string  $title     Post title.
+	 * @param string  $title   Post title.
-	 * @param string  $name      Post name (slug).
+	 * @param string  $name    Post name (slug).
-	 * @param WP_Post $post      Post object.
+	 * @param WP_Post $post    Post object.
 	 */
 	return apply_filters( 'get_sample_permalink', $permalink, $post->ID, $title, $name, $post );
 }
 /**
 * Returns the HTML of the sample permalink slug editor.
 *
 * @since 2.5.0
 *
-* @param int    $id        Post ID or post object.
+* @param int|WP_Post $id        Post ID or post object.
-* @param string $new_title Optional. New title. Default null.
+* @param string|null $new_title Optional. New title. Default null.
-* @param string $new_slug  Optional. New slug. Default null.
+* @param string|null $new_slug  Optional. New slug. Default null.
 * @return string The HTML of the sample permalink slug editor.
 */
 function get_sample_permalink_html( $id, $new_title = null, $new_slug = null ) {
 	$post = get_post( $id );
 	if ( ! $post ) {
 		// Encourage a pretty permalink setting.
 		if ( ! get_option( 'permalink_structure' ) && current_user_can( 'manage_options' )
 			&& ! ( 'page' === get_option( 'show_on_front' ) && get_option( 'page_on_front' ) == $id )
 		) {
-			$return .= '<span id="change-permalinks"><a href="options-permalink.php" class="button button-small" target="_blank">' . __( 'Change Permalinks' ) . "</a></span>\n";
+			$return .= '<span id="change-permalinks"><a href="options-permalink.php" class="button button-small">' . __( 'Change Permalink Structure' ) . "</a></span>\n";
 		}
 	} else {
 		if ( mb_strlen( $post_name ) > 34 ) {
 			$post_name_abridged = mb_substr( $post_name, 0, 16 ) . '&hellip;' . mb_substr( $post_name, -16 );
 		} else {
 /**
 * Returns HTML for the post thumbnail meta box.
 *
 * @since 2.9.0
 *
-* @param int         $thumbnail_id ID of the attachment used for thumbnail
+* @param int|null         $thumbnail_id Optional. Thumbnail attachment ID. Default null.
-* @param int|WP_Post $post         Optional. The post ID or object associated with the thumbnail, defaults to global $post.
+* @param int|WP_Post|null $post         Optional. The post ID or object associated
+*                                       with the thumbnail. Defaults to global $post.
 * @return string The post thumbnail HTML.
 */
 function _wp_post_thumbnail_html( $thumbnail_id = null, $post = null ) {
 	$_wp_additional_image_sizes = wp_get_additional_image_sizes();
 	 */
 	return apply_filters( 'admin_post_thumbnail_html', $content, $post->ID, $thumbnail_id );
 }
 /**
-* Check to see if the post is currently being edited by another user.
+* Determines whether the post is currently being edited by another user.
 *
 * @since 2.5.0
 *
 * @param int|WP_Post $post_id ID or object of the post to check for editing.
 * @return int|false ID of the user with lock. False if the post does not exist, post is not locked,
 	return false;
 }
 /**
-* Mark the post as currently being edited by the current user
+* Marks the post as currently being edited by the current user.
 *
 * @since 2.5.0
 *
 * @param int|WP_Post $post_id ID or object of the post being edited.
-* @return array|false Array of the lock time and user ID. False if the post does not exist, or
+* @return array|false {
-*                     there is no current user.
+*     Array of the lock time and user ID. False if the post does not exist, or there
+*     is no current user.
+*
+*     @type int $0 The current time as a Unix timestamp.
+*     @type int $1 The ID of the current user.
+* }
 */
 function wp_set_post_lock( $post_id ) {
 	$post = get_post( $post_id );
 	if ( ! $post ) {
 		return false;
 	</div>
 	<?php
 }
 /**
-* Creates autosave data for the specified post from $_POST data.
+* Creates autosave data for the specified post from `$_POST` data.
 *
 * @since 2.6.0
 *
-* @param array|int $post_data Associative array containing the post data or int post ID.
+* @param array|int $post_data Associative array containing the post data, or integer post ID.
+*                             If a numeric post ID is provided, will use the `$_POST` superglobal.
 * @return int|WP_Error The autosave revision ID. WP_Error or 0 on error.
 */
 function wp_create_post_autosave( $post_data ) {
 	if ( is_numeric( $post_data ) ) {
 		$post_id   = $post_data;
 	return get_preview_post_link( $post, $query_args );
 }
 /**
-* Save a post submitted with XHR
+* Saves a post submitted with XHR.
 *
 * Intended for use with heartbeat and autosave.js
 *
 * @since 3.9.0
 *
 		return wp_create_post_autosave( wp_slash( $post_data ) );
 	}
 }
 /**
-* Redirect to previous page.
+* Redirects to previous page.
 *
 * @since 2.7.0
 *
 * @param int $post_id Optional. Post ID.
 */
 	return $clean_terms;
 }
 /**
-* Return whether the post can be edited in the block editor.
+* Returns whether the post can be edited in the block editor.
 *
 * @since 5.0.0
 *
 * @param int|WP_Post $post Post ID or WP_Post object.
 * @return bool Whether the post can be edited in the block editor.
 	 */
 	return apply_filters( 'use_block_editor_for_post', $use_block_editor, $post );
 }
 /**
-* Return whether a post type is compatible with the block editor.
+* Returns whether a post type is compatible with the block editor.
 *
 * The block editor depends on the REST API, and if the post type is not shown in the
 * REST API, then it won't work with the block editor.
 *
 * @since 5.0.0
 		'supports'         => 'supports',
 		'category'         => 'category',
 		'styles'           => 'styles',
 		'textdomain'       => 'textdomain',
 		'parent'           => 'parent',
+		'ancestor'         => 'ancestor',
 		'keywords'         => 'keywords',
 		'example'          => 'example',
 		'variations'       => 'variations',
 	);
 				);
 			}
 		}
 	}
-	/**
+	/*
-	 * Sadly we probably can not add this data directly into editor settings.
+	 * Sadly we probably cannot add this data directly into editor settings.
 	 *
-	 * Some meta boxes need admin_head to fire for meta box registry.
+	 * Some meta boxes need `admin_head` to fire for meta box registry.
-	 * admin_head fires after admin_enqueue_scripts, which is where we create our
+	 * `admin_head` fires after `admin_enqueue_scripts`, which is where we create
-	 * editor instance.
+	 * our editor instance.
 	 */
 	$script = 'window._wpLoadBlockEditor.then( function() {
 		wp.data.dispatch( \'core/edit-post\' ).setAvailableMetaBoxesPerLocation( ' . wp_json_encode( $meta_boxes_per_location ) . ' );
 	} );';
 	wp_add_inline_script( 'wp-edit-post', $script );
-	/**
+	/*
-	 * When `wp-edit-post` is output in the `<head>`, the inline script needs to be manually printed. Otherwise,
+	 * When `wp-edit-post` is output in the `<head>`, the inline script needs to be manually printed.
-	 * meta boxes will not display because inline scripts for `wp-edit-post` will not be printed again after this point.
+	 * Otherwise, meta boxes will not display because inline scripts for `wp-edit-post`
+	 * will not be printed again after this point.
 	 */
 	if ( wp_script_is( 'wp-edit-post', 'done' ) ) {
 		printf( "<script type='text/javascript'>\n%s\n</script>\n", trim( $script ) );
 	}
-	/**
+	/*
-	 * If the 'postcustom' meta box is enabled, then we need to perform some
+	 * If the 'postcustom' meta box is enabled, then we need to perform
-	 * extra initialization on it.
+	 * some extra initialization on it.
 	 */
 	$enable_custom_fields = (bool) get_user_meta( get_current_user_id(), 'enable_custom_fields', true );
 	if ( $enable_custom_fields ) {
 		$script = "( function( $ ) {
 			if ( $('#postcustom').length ) {
 				$( '#the-list' ).wpList( {
 					addBefore: function( s ) {
 	$current_user = wp_get_current_user();
 	$user_id      = $current_user->ID;
 	wp_nonce_field( $nonce_action );
 	/*
-	 * Some meta boxes hook into these actions to add hidden input fields in the classic post form. For backwards
+	 * Some meta boxes hook into these actions to add hidden input fields in the classic post form.
-	 * compatibility, we can capture the output from these actions, and extract the hidden input fields.
+	 * For backward compatibility, we can capture the output from these actions,
+	 * and extract the hidden input fields.
 	 */
 	ob_start();
 	/** This filter is documented in wp-admin/edit-form-advanced.php */
 	do_action( 'edit_form_after_title', $post );
 	/** This filter is documented in wp-admin/edit-form-advanced.php */
 	wp_nonce_field( 'closedpostboxes', 'closedpostboxesnonce', false );
 	// Permalink title nonce.
 	wp_nonce_field( 'samplepermalink', 'samplepermalinknonce', false );
 	/**
-	 * Add hidden input fields to the meta box save form.
+	 * Adds hidden input fields to the meta box save form.
 	 *
 	 * Hook into this action to print `<input type="hidden" ... />` fields, which will be POSTed back to
 	 * the server when meta boxes are saved.
 	 *
 	 * @since 5.0.0
 	 *
 	 * @param WP_Post $post The post that is being edited.
 	 */
 	do_action( 'block_editor_meta_box_hidden_fields', $post );
 }
+/**
+* Disables block editor for wp_navigation type posts so they can be managed via the UI.
+*
+* @since 5.9.0
+* @access private
+*
+* @param bool   $value Whether the CPT supports block editor or not.
+* @param string $post_type Post type.
+* @return bool Whether the block editor should be disabled or not.
+*/
+function _disable_block_editor_for_navigation_post_type( $value, $post_type ) {
+	if ( 'wp_navigation' === $post_type ) {
+		return false;
+	}
+	return $value;
+}
+/**
+* This callback disables the content editor for wp_navigation type posts.
+* Content editor cannot handle wp_navigation type posts correctly.
+* We cannot disable the "editor" feature in the wp_navigation's CPT definition
+* because it disables the ability to save navigation blocks via REST API.
+*
+* @since 5.9.0
+* @access private
+*
+* @param WP_Post $post An instance of WP_Post class.
+*/
+function _disable_content_editor_for_navigation_post_type( $post ) {
+	$post_type = get_post_type( $post );
+	if ( 'wp_navigation' !== $post_type ) {
+		return;
+	}
+	remove_post_type_support( $post_type, 'editor' );
+}
+/**
+* This callback enables content editor for wp_navigation type posts.
+* We need to enable it back because we disable it to hide
+* the content editor for wp_navigation type posts.
+*
+* @since 5.9.0
+* @access private
+*
+* @see _disable_content_editor_for_navigation_post_type
+*
+* @param WP_Post $post An instance of WP_Post class.
+*/
+function _enable_content_editor_for_navigation_post_type( $post ) {
+	$post_type = get_post_type( $post );
+	if ( 'wp_navigation' !== $post_type ) {
+		return;
+	}
+	add_post_type_support( $post_type, 'editor' );
+}

changeset 19	3d72ae0968f4
parent 18	be944660c56a
child 21	48c4eec2b7e6