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

equal deleted inserted replaced

-:be944660c56a
+:3d72ae0968f4
 			</div>
 			<?php
 		endif;
 		/**
-		 * Fires before the post time/date setting in the Publish meta box.
+		 * Fires after the Save Draft (or Save as Pending) and Preview (or Preview Changes) buttons
+		 * in the Publish meta box.
 		 *
 		 * @since 4.4.0
 		 *
 		 * @param WP_Post $post WP_Post object for the current post.
 		 */
 			<div class="notice notice-info notice-alt inline">
 				<p>
 					<?php
 					printf(
 						/* translators: %s: URL to the Customizer. */
-						__( 'This draft comes from your <a href="%s">unpublished customization changes</a>. You can edit, but there&#8217;s no need to publish now. It will be published automatically with those changes.' ),
+						__( 'This draft comes from your <a href="%s">unpublished customization changes</a>. You can edit, but there is no need to publish now. It will be published automatically with those changes.' ),
 						esc_url(
 							add_query_arg(
 								'changeset_uuid',
 								rawurlencode( get_post_meta( $post_id, '_customize_changeset_uuid', true ) ),
 								admin_url( 'customize.php' )
 </div>
 	<?php
 }
 /**
-* Display attachment submit form fields.
+* Displays attachment submit form fields.
 *
 * @since 3.5.0
 *
-* @param WP_Post $post
+* @param WP_Post $post Current post object.
 */
 function attachment_submit_meta_box( $post ) {
 	?>
 <div class="submitbox" id="submitpost">
 	<?php
 }
 /**
-* Display post format form elements.
+* Displays post format form elements.
 *
 * @since 3.1.0
 *
-* @param WP_Post $post Post object.
+* @param WP_Post $post Current post object.
 * @param array   $box {
 *     Post formats meta box arguments.
 *
 *     @type string   $id       Meta box 'id' attribute.
 *     @type string   $title    Meta box title.
 		if ( is_array( $post_formats[0] ) ) :
 			$post_format = get_post_format( $post->ID );
 			if ( ! $post_format ) {
 				$post_format = '0';
 			}
-			// Add in the current one if it isn't there yet, in case the current theme doesn't support it.
+			// Add in the current one if it isn't there yet, in case the active theme doesn't support it.
 			if ( $post_format && ! in_array( $post_format, $post_formats[0], true ) ) {
 				$post_formats[0][] = $post_format;
 			}
 			?>
 		<div id="post-formats-select">
 	endif;
 endif;
 }
 /**
-* Display post tags form fields.
+* Displays post tags form fields.
 *
 * @since 2.6.0
 *
 * @todo Create taxonomy-agnostic wrapper for this.
 *
-* @param WP_Post $post Post object.
+* @param WP_Post $post Current post object.
 * @param array   $box {
 *     Tags meta box arguments.
 *
 *     @type string   $id       Meta box 'id' attribute.
 *     @type string   $title    Meta box title.
 <?php endif; ?>
 	<?php
 }
 /**
-* Display post categories form fields.
+* Displays post categories form fields.
 *
 * @since 2.6.0
 *
 * @todo Create taxonomy-agnostic wrapper for this.
 *
-* @param WP_Post $post Post object.
+* @param WP_Post $post Current post object.
 * @param array   $box {
 *     Categories meta box arguments.
 *
 *     @type string   $id       Meta box 'id' attribute.
 *     @type string   $title    Meta box title.
 	</div>
 	<?php
 }
 /**
-* Display post excerpt form fields.
+* Displays post excerpt form fields.
 *
 * @since 2.6.0
 *
-* @param WP_Post $post
+* @param WP_Post $post Current post object.
 */
 function post_excerpt_meta_box( $post ) {
 	?>
 <label class="screen-reader-text" for="excerpt"><?php _e( 'Excerpt' ); ?></label><textarea rows="1" cols="40" name="excerpt" id="excerpt"><?php echo $post->post_excerpt; // textarea_escaped ?></textarea>
 <p>
 </p>
 	<?php
 }
 /**
-* Display trackback links form fields.
+* Displays trackback links form fields.
 *
 * @since 2.6.0
 *
-* @param WP_Post $post
+* @param WP_Post $post Current post object.
 */
 function post_trackback_meta_box( $post ) {
 	$form_trackback = '<input type="text" name="trackback_url" id="trackback_url" class="code" value="' .
 		esc_attr( str_replace( "\n", ' ', $post->to_ping ) ) . '" aria-describedby="trackback-url-desc" />';
 		echo $pings;
 	}
 }
 /**
-* Display custom fields form fields.
+* Displays custom fields form fields.
 *
 * @since 2.6.0
 *
-* @param WP_Post $post
+* @param WP_Post $post Current post object.
 */
 function post_custom_meta_box( $post ) {
 	?>
 <div id="postcustomstuff">
 <div id="ajax-response"></div>
 </p>
 	<?php
 }
 /**
-* Display comments status form fields.
+* Displays comments status form fields.
 *
 * @since 2.6.0
 *
-* @param WP_Post $post
+* @param WP_Post $post Current post object.
 */
 function post_comment_status_meta_box( $post ) {
 	?>
 <input name="advanced_view" type="hidden" value="1" />
 <p class="meta-options">
 	/**
 	 * Fires at the end of the Discussion meta box on the post editing screen.
 	 *
 	 * @since 3.1.0
 	 *
-	 * @param WP_Post $post WP_Post object of the current post.
+	 * @param WP_Post $post WP_Post object for the current post.
 	 */
 	do_action( 'post_comment_status_meta_box-options', $post ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
 	?>
 </p>
 	<?php
 }
 /**
-* Display comments for post table header
+* Displays comments for post table header
 *
 * @since 3.0.0
 *
-* @param array $result table header rows
+* @param array $result Table header rows.
 * @return array
 */
 function post_comment_meta_box_thead( $result ) {
 	unset( $result['cb'], $result['response'] );
 	return $result;
 }
 /**
-* Display comments for post.
+* Displays comments for post.
 *
 * @since 2.8.0
 *
-* @param WP_Post $post
+* @param WP_Post $post Current post object.
 */
 function post_comment_meta_box( $post ) {
 	wp_nonce_field( 'get-comments', 'add_comment_nonce', false );
 	?>
 	<p class="hide-if-no-js" id="add-new-comment"><button type="button" class="button" onclick="window.commentReply && commentReply.addcomment(<?php echo $post->ID; ?>);"><?php _e( 'Add Comment' ); ?></button></p>
 		echo '<p id="no-comments">' . __( 'No comments yet.' ) . '</p>';
 	} else {
 		$hidden = get_hidden_meta_boxes( get_current_screen() );
 		if ( ! in_array( 'commentsdiv', $hidden, true ) ) {
 			?>
-			<script type="text/javascript">jQuery(document).ready(function(){commentsBox.get(<?php echo $total; ?>, 10);});</script>
+			<script type="text/javascript">jQuery(function(){commentsBox.get(<?php echo $total; ?>, 10);});</script>
 			<?php
 		}
 		?>
 		<p class="hide-if-no-js" id="show-comments"><a href="#commentstatusdiv" onclick="commentsBox.load(<?php echo $total; ?>);return false;"><?php _e( 'Show comments' ); ?></a> <span class="spinner"></span></p>
 	wp_comment_trashnotice();
 }
 /**
-* Display slug form fields.
+* Displays slug form fields.
 *
 * @since 2.6.0
 *
-* @param WP_Post $post
+* @param WP_Post $post Current post object.
 */
 function post_slug_meta_box( $post ) {
 	/** This filter is documented in wp-admin/edit-tag-form.php */
 	$editable_slug = apply_filters( 'editable_slug', $post->post_name, $post );
 	?>
 <label class="screen-reader-text" for="post_name"><?php _e( 'Slug' ); ?></label><input name="post_name" type="text" size="13" id="post_name" value="<?php echo esc_attr( $editable_slug ); ?>" />
 	<?php
 }
 /**
-* Display form field with list of authors.
+* Displays form field with list of authors.
 *
 * @since 2.6.0
 *
 * @global int $user_ID
 *
-* @param WP_Post $post
+* @param WP_Post $post Current post object.
 */
 function post_author_meta_box( $post ) {
 	global $user_ID;
+	$post_type_object = get_post_type_object( $post->post_type );
 	?>
 <label class="screen-reader-text" for="post_author_override"><?php _e( 'Author' ); ?></label>
 	<?php
 	wp_dropdown_users(
 		array(
-			'who'              => 'authors',
+			'capability'       => array( $post_type_object->cap->edit_posts ),
 			'name'             => 'post_author_override',
 			'selected'         => empty( $post->ID ) ? $user_ID : $post->post_author,
 			'include_selected' => true,
 			'show'             => 'display_name_with_login',
 		)
 	);
 }
 /**
-* Display list of revisions.
+* Displays list of revisions.
 *
 * @since 2.6.0
 *
-* @param WP_Post $post
+* @param WP_Post $post Current post object.
 */
 function post_revisions_meta_box( $post ) {
 	wp_list_post_revisions( $post );
 }
 //
 // Page-related Meta Boxes.
 //
 /**
-* Display page attributes form fields.
+* Displays page attributes form fields.
 *
 * @since 2.7.0
 *
-* @param WP_Post $post
+* @param WP_Post $post Current post object.
 */
 function page_attributes_meta_box( $post ) {
 	if ( is_post_type_hierarchical( $post->post_type ) ) :
 		$dropdown_args = array(
 			'post_type'        => $post->post_type,
 		 * Fires immediately after the label inside the 'Template' section
 		 * of the 'Page Attributes' meta box.
 		 *
 		 * @since 4.4.0
 		 *
-		 * @param string  $template The template used for the current post.
+		 * @param string|false $template The template used for the current post.
-		 * @param WP_Post $post     The current post.
+		 * @param WP_Post      $post     The current post.
 		 */
 		do_action( 'page_attributes_meta_box_template', $template, $post );
 		?>
 </p>
 <select name="page_template" id="page_template">
 //
 // Link-related Meta Boxes.
 //
 /**
-* Display link create form fields.
+* Displays link create form fields.
 *
 * @since 2.7.0
 *
-* @param object $link
+* @param object $link Current link object.
 */
 function link_submit_meta_box( $link ) {
 	?>
 <div class="submitbox" id="submitlink">
 </div>
 	<?php
 }
 /**
-* Display link categories form fields.
+* Displays link categories form fields.
 *
 * @since 2.6.0
 *
-* @param object $link
+* @param object $link Current link object.
 */
 function link_categories_meta_box( $link ) {
 	?>
 <div id="taxonomy-linkcategory" class="categorydiv">
 	<ul id="category-tabs" class="category-tabs">
 </div>
 	<?php
 }
 /**
-* Display form fields for changing link target.
+* Displays form fields for changing link target.
 *
 * @since 2.6.0
 *
-* @param object $link
+* @param object $link Current link object.
 */
 function link_target_meta_box( $link ) {
 	?>
 <fieldset><legend class="screen-reader-text"><span><?php _e( 'Target' ); ?></span></legend>
 <p><?php _e( 'Choose the target frame for your link.' ); ?></p>
 	<?php
 }
 /**
-* Display checked checkboxes attribute for xfn microformat options.
+* Displays 'checked' checkboxes attribute for XFN microformat options.
 *
 * @since 1.0.1
 *
-* @global object $link
+* @global object $link Current link object.
 *
-* @param string $class
+* @param string $xfn_relationship XFN relationship category. Possible values are:
-* @param string $value
+*                                 'friendship', 'physical', 'professional',
-* @param mixed  $deprecated Never used.
+*                                 'geographical', 'family', 'romantic', 'identity'.
-*/
+* @param string $xfn_value        Optional. The XFN value to mark as checked
-function xfn_check( $class, $value = '', $deprecated = '' ) {
+*                                 if it matches the current link's relationship.
+*                                 Default empty string.
+* @param mixed  $deprecated       Deprecated. Not used.
+*/
+function xfn_check( $xfn_relationship, $xfn_value = '', $deprecated = '' ) {
 	global $link;
 	if ( ! empty( $deprecated ) ) {
 		_deprecated_argument( __FUNCTION__, '2.5.0' ); // Never implemented.
 	}
-	$link_rel = isset( $link->link_rel ) ? $link->link_rel : ''; // In PHP 5.3: $link_rel = $link->link_rel ?: '';
+	$link_rel  = isset( $link->link_rel ) ? $link->link_rel : ''; // In PHP 5.3: $link_rel = $link->link_rel ?: '';
-	$rels     = preg_split( '/\s+/', $link_rel );
+	$link_rels = preg_split( '/\s+/', $link_rel );
-	if ( '' !== $value && in_array( $value, $rels, true ) ) {
+	// Mark the specified value as checked if it matches the current link's relationship.
+	if ( '' !== $xfn_value && in_array( $xfn_value, $link_rels, true ) ) {
 		echo ' checked="checked"';
 	}
-	if ( '' === $value ) {
+	if ( '' === $xfn_value ) {
-		if ( 'family' === $class && strpos( $link_rel, 'child' ) === false && strpos( $link_rel, 'parent' ) === false && strpos( $link_rel, 'sibling' ) === false && strpos( $link_rel, 'spouse' ) === false && strpos( $link_rel, 'kin' ) === false ) {
+		// Mark the 'none' value as checked if the current link does not match the specified relationship.
+		if ( 'family' === $xfn_relationship
+			&& ! array_intersect( $link_rels, array( 'child', 'parent', 'sibling', 'spouse', 'kin' ) )
+		) {
 			echo ' checked="checked"';
 		}
-		if ( 'friendship' === $class && strpos( $link_rel, 'friend' ) === false && strpos( $link_rel, 'acquaintance' ) === false && strpos( $link_rel, 'contact' ) === false ) {
+		if ( 'friendship' === $xfn_relationship
+			&& ! array_intersect( $link_rels, array( 'friend', 'acquaintance', 'contact' ) )
+		) {
 			echo ' checked="checked"';
 		}
-		if ( 'geographical' === $class && strpos( $link_rel, 'co-resident' ) === false && strpos( $link_rel, 'neighbor' ) === false ) {
+		if ( 'geographical' === $xfn_relationship
+			&& ! array_intersect( $link_rels, array( 'co-resident', 'neighbor' ) )
+		) {
 			echo ' checked="checked"';
 		}
-		if ( 'identity' === $class && in_array( 'me', $rels, true ) ) {
+		// Mark the 'me' value as checked if it matches the current link's relationship.
+		if ( 'identity' === $xfn_relationship
+			&& in_array( 'me', $link_rels, true )
+		) {
 			echo ' checked="checked"';
 		}
 	}
 }
 /**
-* Display xfn form fields.
+* Displays XFN form fields.
 *
 * @since 2.6.0
 *
-* @param object $link
+* @param object $link Current link object.
 */
 function link_xfn_meta_box( $link ) {
 	?>
 <table class="links-table">
 	<tr>
 <p><?php _e( 'If the link is to a person, you can specify your relationship with them using the above form. If you would like to learn more about the idea check out <a href="https://gmpg.org/xfn/">XFN</a>.' ); ?></p>
 	<?php
 }
 /**
-* Display advanced link options form fields.
+* Displays advanced link options form fields.
 *
 * @since 2.6.0
 *
-* @param object $link
+* @param object $link Current link object.
 */
 function link_advanced_meta_box( $link ) {
 	?>
 <table class="links-table" cellpadding="0">
 	<tr>
 	</tr>
 	<tr>
 		<th scope="row"><label for="link_rating"><?php _e( 'Rating' ); ?></label></th>
 		<td><select name="link_rating" id="link_rating" size="1">
 		<?php
-		for ( $parsed_args = 0; $parsed_args <= 10; $parsed_args++ ) {
+		for ( $rating = 0; $rating <= 10; $rating++ ) {
-			echo '<option value="' . $parsed_args . '"';
+			echo '<option value="' . $rating . '"';
-			if ( isset( $link->link_rating ) && $link->link_rating == $parsed_args ) {
+			if ( isset( $link->link_rating ) && $link->link_rating == $rating ) {
 				echo ' selected="selected"';
 			}
-			echo( '>' . $parsed_args . '</option>' );
+			echo '>' . $rating . '</option>';
 		}
 		?>
 		</select>&nbsp;<?php _e( '(Leave at 0 for no rating.)' ); ?>
 		</td>
 	</tr>
 </table>
 	<?php
 }
 /**
-* Display post thumbnail meta box.
+* Displays post thumbnail meta box.
 *
 * @since 2.9.0
 *
-* @param WP_Post $post A post object.
+* @param WP_Post $post Current post object.
 */
 function post_thumbnail_meta_box( $post ) {
 	$thumbnail_id = get_post_meta( $post->ID, '_thumbnail_id', true );
 	echo _wp_post_thumbnail_html( $thumbnail_id, $post->ID );
 }
 /**
-* Display fields for ID3 data
+* Displays fields for ID3 data.
 *
 * @since 3.9.0
 *
-* @param WP_Post $post A post object.
+* @param WP_Post $post Current post object.
 */
 function attachment_id3_data_meta_box( $post ) {
 	$meta = array();
 	if ( ! empty( $post->ID ) ) {
 		$meta = wp_get_attachment_metadata( $post->ID );
 	do_action( 'add_meta_boxes', $post_type, $post );
 	/**
 	 * Fires after all built-in meta boxes have been added, contextually for the given post type.
 	 *
-	 * The dynamic portion of the hook, `$post_type`, refers to the post type of the post.
+	 * The dynamic portion of the hook name, `$post_type`, refers to the post type of the post.
+	 *
+	 * Possible hook names include:
+	 *
+	 *  - `add_meta_boxes_post`
+	 *  - `add_meta_boxes_page`
+	 *  - `add_meta_boxes_attachment`
 	 *
 	 * @since 3.0.0
 	 *
 	 * @param WP_Post $post Post object.
 	 */

changeset 19	3d72ae0968f4
parent 18	be944660c56a
child 21	48c4eec2b7e6