vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 14:20:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Improve comments in some wp-admin files per the documentation standards.

Browse Source 
Follow-up to [47084].

Props passoniate, apedog.
Fixes #49223, #49227.

git-svn-id: https://develop.svn.wordpress.org/trunk@47119 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2020-01-29 00:33:45 +00:00
parent 48110faf25
commit 6bdc961d5f
9 changed files with 186 additions and 152 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
src/wp-admin/includes/post.php
View File

@@ -92,7 +92,7 @@ function _wp_translate_postdata( $update = false, $post_data = null ) {
if ( ! empty( $post_data['post_status'] ) ) {
$post_data['post_status'] = sanitize_key( $post_data['post_status'] );
// No longer an auto-draft
// No longer an auto-draft.
if ( 'auto-draft' === $post_data['post_status'] ) {
$post_data['post_status'] = 'draft';
}
@@ -102,7 +102,7 @@ function _wp_translate_postdata( $update = false, $post_data = null ) {
}
}
// What to do based on which button they pressed
// What to do based on which button they pressed.
if ( isset( $post_data['saveasdraft'] ) && '' != $post_data['saveasdraft'] ) {
$post_data['post_status'] = 'draft';
}
@@ -132,7 +132,7 @@ function _wp_translate_postdata( $update = false, $post_data = null ) {
$published_statuses = array( 'publish', 'future' );
// Posts 'submitted for approval' present are submitted to $_POST the same as if they were being published.
// Posts 'submitted for approval' are submitted to $_POST the same as if they were being published.
// Change status from 'publish' to 'pending' if user lacks permissions to publish or to resave published posts.
if ( isset( $post_data['post_status'] ) && ( in_array( $post_data['post_status'], $published_statuses ) && ! current_user_can( $ptype->cap->publish_posts ) ) ) {
if ( ! in_array( $previous_status, $published_statuses ) || ! current_user_can( 'edit_post', $post_id ) ) {
@@ -208,7 +208,7 @@ function _wp_get_allowed_postdata( $post_data = null ) {
$post_data = $_POST;
}
// Pass through errors
// Pass through errors.
if ( is_wp_error( $post_data ) ) {
return $post_data;
}
@@ -268,7 +268,7 @@ function edit_post( $post_data = null ) {
);
$revision = current( $revisions );
// Check if the revisions have been upgraded
// Check if the revisions have been upgraded.
if ( $revisions && _wp_get_post_revision_version( $revision ) < 1 ) {
_wp_upgrade_revisions_of_post( $post, wp_get_post_revisions( $post_ID ) );
}
@@ -296,7 +296,7 @@ function edit_post( $post_data = null ) {
}
$translated = _wp_get_allowed_postdata( $post_data );
// Post Formats
// Post formats.
if ( isset( $post_data['post_format'] ) ) {
set_post_format( $post_ID, $post_data['post_format'] );
}
@@ -336,7 +336,7 @@ function edit_post( $post_data = null ) {
wp_update_attachment_metadata( $post_ID, $id3data );
}
// Meta Stuff
// Meta stuff.
if ( isset( $post_data['meta'] ) && $post_data['meta'] ) {
foreach ( $post_data['meta'] as $key => $value ) {
$meta = get_post_meta_by_id( $key );
@@ -372,13 +372,15 @@ function edit_post( $post_data = null ) {
}
}
// Attachment stuff
// Attachment stuff.
if ( 'attachment' == $post_data['post_type'] ) {
if ( isset( $post_data['_wp_attachment_image_alt'] ) ) {
$image_alt = wp_unslash( $post_data['_wp_attachment_image_alt'] );
if ( $image_alt != get_post_meta( $post_ID, '_wp_attachment_image_alt', true ) ) {
$image_alt = wp_strip_all_tags( $image_alt, true );
// update_meta expects slashed.
// update_post_meta() expects slashed.
update_post_meta( $post_ID, '_wp_attachment_image_alt', wp_slash( $image_alt ) );
}
}
@@ -405,7 +407,8 @@ function edit_post( $post_data = null ) {
update_post_meta( $post_ID, '_edit_last', get_current_user_id() );
$success = wp_update_post( $translated );
// If the save failed, see if we can sanity check the main fields and try again
// If the save failed, see if we can sanity check the main fields and try again.
if ( ! $success && is_callable( array( $wpdb, 'strip_invalid_text_for_column' ) ) ) {
$fields = array( 'post_title', 'post_content', 'post_excerpt' );
@@ -418,7 +421,7 @@ function edit_post( $post_data = null ) {
wp_update_post( $translated );
}
// Now that we have an ID we can fix any attachment anchor hrefs
// Now that we have an ID we can fix any attachment anchor hrefs.
_fix_attachment_links( $post_ID );
wp_set_post_lock( $post_ID );
@@ -676,7 +679,7 @@ function get_default_post_to_edit( $post_type = 'post', $create_in_db = false )
set_post_format( $post, get_option( 'default_post_format' ) );
}
// Schedule auto-draft cleanup
// Schedule auto-draft cleanup.
if ( ! wp_next_scheduled( 'wp_scheduled_auto_draft_delete' ) ) {
wp_schedule_event( time(), 'daily', 'wp_scheduled_auto_draft_delete' );
}
@@ -816,7 +819,7 @@ function wp_write_post() {
// Clear out any data in internal vars.
unset( $_POST['filter'] );
// Edit don't write if we have a post id.
// Edit, don't write, if we have a post ID.
if ( isset( $_POST['post_ID'] ) ) {
return edit_post();
}
@@ -857,7 +860,7 @@ function wp_write_post() {
add_post_meta( $post_ID, '_edit_last', $GLOBALS['current_user']->ID );
// Now that we have an ID we can fix any attachment anchor hrefs
// Now that we have an ID we can fix any attachment anchor hrefs.
_fix_attachment_links( $post_ID );
wp_set_post_lock( $post_ID );
@@ -882,7 +885,7 @@ function write_post() {
}
//
// Post Meta
// Post Meta.
//
/**
@@ -913,7 +916,7 @@ function add_meta( $post_ID ) {
}
if ( $metakeyinput ) {
$metakey = $metakeyinput; // default
$metakey = $metakeyinput; // Default.
}
if ( is_protected_meta( $metakey, 'post' ) || ! current_user_can( 'add_post_meta', $post_ID, $metakey ) ) {
@@ -926,7 +929,7 @@ function add_meta( $post_ID ) {
}
return false;
} // add_meta
}
/**
* Delete post meta data by meta ID.
@@ -1017,7 +1020,7 @@ function update_meta( $meta_id, $meta_key, $meta_value ) {
}
//
// Private
// Private.
//
/**
@@ -1038,13 +1041,13 @@ function _fix_attachment_links( $post ) {
return;
}
// Short if there aren't any links or no '?attachment_id=' strings (strpos cannot be zero)
// Short if there aren't any links or no '?attachment_id=' strings (strpos cannot be zero).
if ( ! strpos( $content, '?attachment_id=' ) || ! preg_match_all( '/<a ([^>]+)>[\s\S]+?<\/a>/', $content, $link_matches ) ) {
return;
}
$site_url = get_bloginfo( 'url' );
$site_url = substr( $site_url, (int) strpos( $site_url, '://' ) ); // remove the http(s)
$site_url = substr( $site_url, (int) strpos( $site_url, '://' ) ); // Remove the http(s).
$replace = '';
foreach ( $link_matches[1] as $key => $value ) {
@@ -1054,7 +1057,7 @@ function _fix_attachment_links( $post ) {
continue;
}
$quote = $url_match[1]; // the quote (single or double)
$quote = $url_match[1]; // The quote (single or double).
$url_id = (int) $url_match[2];
$rel_id = (int) $rel_match[1];
@@ -1344,8 +1347,8 @@ function get_sample_permalink( $id, $title = null, $name = null ) {
$post->post_name = sanitize_title( $post->post_name ? $post->post_name : $post->post_title, $post->ID );
}
// If the user wants to set a new name -- override the current one
// Note: if empty name is supplied -- use the title instead, see #6072
// If the user wants to set a new name -- override the current one.
// Note: if empty name is supplied -- use the title instead, see #6072.
if ( ! is_null( $name ) ) {
$post->post_name = sanitize_title( $name ? $name : $title, $post->ID );
}
@@ -1356,10 +1359,10 @@ function get_sample_permalink( $id, $title = null, $name = null ) {
$permalink = get_permalink( $post, true );
// Replace custom post_type Token with generic pagename token for ease of use.
// Replace custom post_type token with generic pagename token for ease of use.
$permalink = str_replace( "%$post->post_type%", '%pagename%', $permalink );
// Handle page hierarchy
// Handle page hierarchy.
if ( $ptype->hierarchical ) {
$uri = get_page_uri( $post );
if ( $uri ) {
@@ -1431,13 +1434,13 @@ function get_sample_permalink_html( $id, $new_title = null, $new_slug = null ) {
if ( 'publish' === $post->post_status || 'attachment' === $post->post_type ) {
$view_link = get_permalink( $post );
} else {
// Allow non-published (private, future) to be viewed at a pretty permalink, in case $post->post_name is set
// Allow non-published (private, future) to be viewed at a pretty permalink, in case $post->post_name is set.
$view_link = str_replace( array( '%pagename%', '%postname%' ), $post->post_name, $permalink );
}
}
}
// Permalinks without a post/page name placeholder don't have anything to edit
// Permalinks without a post/page name placeholder don't have anything to edit.
if ( false === strpos( $permalink, '%postname%' ) && false === strpos( $permalink, '%pagename%' ) ) {
$return = '<strong>' . __( 'Permalink:' ) . "</strong>\n";
@@ -1448,7 +1451,7 @@ function get_sample_permalink_html( $id, $new_title = null, $new_slug = null ) {
$return .= '<span id="sample-permalink">' . $permalink . "</span>\n";
}
// Encourage a pretty permalink setting
// Encourage a pretty permalink setting.
if ( '' == get_option( 'permalink_structure' ) && current_user_can( 'manage_options' ) && ! ( 'page' == get_option( 'show_on_front' ) && $id == get_option( 'page_on_front' ) ) ) {
$return .= '<span id="change-permalinks"><a href="options-permalink.php" class="button button-small" target="_blank">' . __( 'Change Permalinks' ) . "</a></span>\n";
}
@@ -1692,7 +1695,7 @@ function _admin_notice_post_locked() {
$query_args = array();
if ( get_post_type_object( $post->post_type )->public ) {
if ( 'publish' == $post->post_status || $user->ID != $post->post_author ) {
// Latest content is in autosave
// Latest content is in autosave.
$nonce = wp_create_nonce( 'post_preview_' . $post->ID );
$query_args['preview_id'] = $post->ID;
$query_args['preview_nonce'] = $nonce;
@@ -1747,7 +1750,7 @@ function _admin_notice_post_locked() {
<?php
}
// Allow plugins to prevent some users overriding the post lock
// Allow plugins to prevent some users overriding the post lock.
if ( $override ) {
?>
<a class="button button-primary wp-tab-last" href="<?php echo esc_url( add_query_arg( 'get-post-lock', '1', wp_nonce_url( get_edit_post_link( $post->ID, 'url' ), 'lock-post_' . $post->ID ) ) ); ?>"><?php _e( 'Take over' ); ?></a>
@@ -1819,8 +1822,9 @@ function wp_create_post_autosave( $post_data ) {
$new_autosave['ID'] = $old_autosave->ID;
$new_autosave['post_author'] = $post_author;
$post = get_post( $post_id );
// If the new autosave has the same content as the post, delete the autosave.
$post = get_post( $post_id );
$autosave_is_different = false;
foreach ( array_intersect( array_keys( $new_autosave ), array_keys( _wp_post_revision_fields( $post ) ) ) as $field ) {
if ( normalize_whitespace( $new_autosave[ $field ] ) != normalize_whitespace( $post->$field ) ) {
@@ -1849,7 +1853,7 @@ function wp_create_post_autosave( $post_data ) {
// _wp_put_post_revision() expects unescaped.
$post_data = wp_unslash( $post_data );
// Otherwise create the new autosave as a special post revision
// Otherwise create the new autosave as a special post revision.
return _wp_put_post_revision( $post_data, true );
}
@@ -1922,7 +1926,7 @@ function post_preview() {
* The ID can be the draft post_id or the autosave revision post_id.
*/
function wp_autosave( $post_data ) {
// Back-compat
// Back-compat.
if ( ! defined( 'DOING_AUTOSAVE' ) ) {
define( 'DOING_AUTOSAVE', true );
}
@@ -1950,10 +1954,11 @@ function wp_autosave( $post_data ) {
}
if ( ! wp_check_post_lock( $post->ID ) && get_current_user_id() == $post->post_author && ( 'auto-draft' == $post->post_status || 'draft' == $post->post_status ) ) {
// Drafts and auto-drafts are just overwritten by autosave for the same user if the post is not locked
// Drafts and auto-drafts are just overwritten by autosave for the same user if the post is not locked.
return edit_post( wp_slash( $post_data ) );
} else {
// Non drafts or other users drafts are not overwritten. The autosave is stored in a special post revision for each user.
// Non-drafts or other users' drafts are not overwritten.
// The autosave is stored in a special post revision for each user.
return wp_create_post_autosave( wp_slash( $post_data ) );
}
}