WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Add missing descriptions for function parameters in `wp-admin/includes/meta-boxes.php`. 

See #54729.
Built from https://develop.svn.wordpress.org/trunk@53200


git-svn-id: http://core.svn.wordpress.org/trunk@52789 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov 2022-04-17 17:47:13 +00:00
parent 6c36a0867d
commit 9043ef83ef
2 changed files with 33 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
wp-admin/includes/meta-boxes.php
View File

@ -386,7 +386,7 @@ function post_submit_meta_box( $post, $args = array() ) {
* *
* @since 3.5.0 * @since 3.5.0
* *
* @param WP_Post $post * @param WP_Post $post Current post object.
*/ */
function attachment_submit_meta_box( $post ) { function attachment_submit_meta_box( $post ) {
?> ?>
@ -466,7 +466,7 @@ function attachment_submit_meta_box( $post ) {
* *
* @since 3.1.0 * @since 3.1.0
* *
* @param WP_Post $post Post object. * @param WP_Post $post Current post object.
* @param array $box { * @param array $box {
* Post formats meta box arguments. * Post formats meta box arguments.
* *
@ -511,7 +511,7 @@ endif;
* *
* @todo Create taxonomy-agnostic wrapper for this. * @todo Create taxonomy-agnostic wrapper for this.
* *
* @param WP_Post $post Post object. * @param WP_Post $post Current post object.
* @param array $box { * @param array $box {
* Tags meta box arguments. * Tags meta box arguments.
* *
@ -574,7 +574,7 @@ function post_tags_meta_box( $post, $box ) {
* *
* @todo Create taxonomy-agnostic wrapper for this. * @todo Create taxonomy-agnostic wrapper for this.
* *
* @param WP_Post $post Post object. * @param WP_Post $post Current post object.
* @param array $box { * @param array $box {
* Categories meta box arguments. * Categories meta box arguments.
* *
@ -696,7 +696,7 @@ function post_categories_meta_box( $post, $box ) {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param WP_Post $post * @param WP_Post $post Current post object.
*/ */
function post_excerpt_meta_box( $post ) { function post_excerpt_meta_box( $post ) {
?> ?>
@ -718,7 +718,7 @@ function post_excerpt_meta_box( $post ) {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param WP_Post $post * @param WP_Post $post Current post object.
*/ */
function post_trackback_meta_box( $post ) { function post_trackback_meta_box( $post ) {
$form_trackback = '<input type="text" name="trackback_url" id="trackback_url" class="code" value="' . $form_trackback = '<input type="text" name="trackback_url" id="trackback_url" class="code" value="' .
@ -759,7 +759,7 @@ function post_trackback_meta_box( $post ) {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param WP_Post $post * @param WP_Post $post Current post object.
*/ */
function post_custom_meta_box( $post ) { function post_custom_meta_box( $post ) {
?> ?>
@ -793,7 +793,7 @@ function post_custom_meta_box( $post ) {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param WP_Post $post * @param WP_Post $post Current post object.
*/ */
function post_comment_status_meta_box( $post ) { function post_comment_status_meta_box( $post ) {
?> ?>
@ -815,7 +815,7 @@ function post_comment_status_meta_box( $post ) {
* *
* @since 3.1.0 * @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 do_action( 'post_comment_status_meta_box-options', $post ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
?> ?>
@ -828,7 +828,7 @@ function post_comment_status_meta_box( $post ) {
* *
* @since 3.0.0 * @since 3.0.0
* *
* @param array $result table header rows * @param array $result Table header rows.
* @return array * @return array
*/ */
function post_comment_meta_box_thead( $result ) { function post_comment_meta_box_thead( $result ) {
@ -841,7 +841,7 @@ function post_comment_meta_box_thead( $result ) {
* *
* @since 2.8.0 * @since 2.8.0
* *
* @param WP_Post $post * @param WP_Post $post Current post object.
*/ */
function post_comment_meta_box( $post ) { function post_comment_meta_box( $post ) {
wp_nonce_field( 'get-comments', 'add_comment_nonce', false ); wp_nonce_field( 'get-comments', 'add_comment_nonce', false );
@ -882,7 +882,7 @@ function post_comment_meta_box( $post ) {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param WP_Post $post * @param WP_Post $post Current post object.
*/ */
function post_slug_meta_box( $post ) { function post_slug_meta_box( $post ) {
/** This filter is documented in wp-admin/edit-tag-form.php */ /** This filter is documented in wp-admin/edit-tag-form.php */
@ -899,7 +899,7 @@ function post_slug_meta_box( $post ) {
* *
* @global int $user_ID * @global int $user_ID
* *
* @param WP_Post $post * @param WP_Post $post Current post object.
*/ */
function post_author_meta_box( $post ) { function post_author_meta_box( $post ) {
global $user_ID; global $user_ID;
@ -924,7 +924,7 @@ function post_author_meta_box( $post ) {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param WP_Post $post * @param WP_Post $post Current post object.
*/ */
function post_revisions_meta_box( $post ) { function post_revisions_meta_box( $post ) {
wp_list_post_revisions( $post ); wp_list_post_revisions( $post );
@ -939,7 +939,7 @@ function post_revisions_meta_box( $post ) {
* *
* @since 2.7.0 * @since 2.7.0
* *
* @param WP_Post $post * @param WP_Post $post Current post object.
*/ */
function page_attributes_meta_box( $post ) { function page_attributes_meta_box( $post ) {
if ( is_post_type_hierarchical( $post->post_type ) ) : if ( is_post_type_hierarchical( $post->post_type ) ) :
@ -1036,7 +1036,7 @@ function page_attributes_meta_box( $post ) {
* *
* @since 2.7.0 * @since 2.7.0
* *
* @param object $link * @param object $link Current link object.
*/ */
function link_submit_meta_box( $link ) { function link_submit_meta_box( $link ) {
?> ?>
@ -1112,7 +1112,7 @@ function link_submit_meta_box( $link ) {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param object $link * @param object $link Current link object.
*/ */
function link_categories_meta_box( $link ) { function link_categories_meta_box( $link ) {
?> ?>
@ -1159,7 +1159,7 @@ function link_categories_meta_box( $link ) {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param object $link * @param object $link Current link object.
*/ */
function link_target_meta_box( $link ) { function link_target_meta_box( $link ) {
@ -1184,11 +1184,14 @@ function link_target_meta_box( $link ) {
* *
* @since 1.0.1 * @since 1.0.1
* *
* @global object $link * @global object $link Current link object.
* *
* @param string $xfn_relationship * @param string $xfn_relationship XFN relationship category. Possible values are:
* @param string $xfn_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
* if it matches the current link's relationship.
* @param mixed $deprecated Deprecated. Not used.
*/ */
function xfn_check( $xfn_relationship, $xfn_value = '', $deprecated = '' ) { function xfn_check( $xfn_relationship, $xfn_value = '', $deprecated = '' ) {
global $link; global $link;
@ -1200,13 +1203,13 @@ function xfn_check( $xfn_relationship, $xfn_value = '', $deprecated = '' ) {
$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 ?: '';
$link_rels = preg_split( '/\s+/', $link_rel ); $link_rels = preg_split( '/\s+/', $link_rel );
// Mark the specified value as checked if it matches the link relationship. // Mark the specified value as checked if it matches the current link's relationship.
if ( '' !== $xfn_value && in_array( $xfn_value, $link_rels, true ) ) { if ( '' !== $xfn_value && in_array( $xfn_value, $link_rels, true ) ) {
echo ' checked="checked"'; echo ' checked="checked"';
} }
if ( '' === $xfn_value ) { if ( '' === $xfn_value ) {
// Mark the 'none' value as checked if the link does not match the specified relationship. // Mark the 'none' value as checked if the current link does not match the specified relationship.
if ( 'family' === $xfn_relationship if ( 'family' === $xfn_relationship
&& ! array_intersect( $link_rels, array( 'child', 'parent', 'sibling', 'spouse', 'kin' ) ) && ! array_intersect( $link_rels, array( 'child', 'parent', 'sibling', 'spouse', 'kin' ) )
) { ) {
@ -1225,7 +1228,7 @@ function xfn_check( $xfn_relationship, $xfn_value = '', $deprecated = '' ) {
echo ' checked="checked"'; echo ' checked="checked"';
} }
// Mark the 'me' value as checked if it matches the link relationship. // Mark the 'me' value as checked if it matches the current link's relationship.
if ( 'identity' === $xfn_relationship if ( 'identity' === $xfn_relationship
&& in_array( 'me', $link_rels, true ) && in_array( 'me', $link_rels, true )
) { ) {
@ -1239,7 +1242,7 @@ function xfn_check( $xfn_relationship, $xfn_value = '', $deprecated = '' ) {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param object $link * @param object $link Current link object.
*/ */
function link_xfn_meta_box( $link ) { function link_xfn_meta_box( $link ) {
?> ?>
@ -1357,7 +1360,7 @@ function link_xfn_meta_box( $link ) {
* *
* @since 2.6.0 * @since 2.6.0
* *
* @param object $link * @param object $link Current link object.
*/ */
function link_advanced_meta_box( $link ) { function link_advanced_meta_box( $link ) {
?> ?>
@ -1398,7 +1401,7 @@ function link_advanced_meta_box( $link ) {
* *
* @since 2.9.0 * @since 2.9.0
* *
* @param WP_Post $post A post object. * @param WP_Post $post Current post object.
*/ */
function post_thumbnail_meta_box( $post ) { function post_thumbnail_meta_box( $post ) {
$thumbnail_id = get_post_meta( $post->ID, '_thumbnail_id', true ); $thumbnail_id = get_post_meta( $post->ID, '_thumbnail_id', true );
@ -1410,7 +1413,7 @@ function post_thumbnail_meta_box( $post ) {
* *
* @since 3.9.0 * @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 ) { function attachment_id3_data_meta_box( $post ) {
$meta = array(); $meta = array();

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.0-beta1-53199'; $wp_version = '6.0-beta1-53200';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.