WordPress.org
Get WordPress

Make WordPress Core

Changeset 53200


Ignore:
Timestamp:
04/17/2022 05:45:05 PM (3 years ago)
Author:
SergeyBiryukov
Message:

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

See #54729.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-admin/includes/meta-boxes.php

    r53199 r53200  
    387387 * @since 3.5.0
    388388 *
    389  * @param WP_Post $post
     389 * @param WP_Post $post Current post object.
    390390 */
    391391function attachment_submit_meta_box( $post ) {
    … …  
    467467 * @since 3.1.0
    468468 *
    469  * @param WP_Post $post Post object.
     469 * @param WP_Post $post Current post object.
    470470 * @param array   $box {
    471471 *     Post formats meta box arguments.
    … …  
    512512 * @todo Create taxonomy-agnostic wrapper for this.
    513513 *
    514  * @param WP_Post $post Post object.
     514 * @param WP_Post $post Current post object.
    515515 * @param array   $box {
    516516 *     Tags meta box arguments.
    … …  
    575575 * @todo Create taxonomy-agnostic wrapper for this.
    576576 *
    577  * @param WP_Post $post Post object.
     577 * @param WP_Post $post Current post object.
    578578 * @param array   $box {
    579579 *     Categories meta box arguments.
    … …  
    697697 * @since 2.6.0
    698698 *
    699  * @param WP_Post $post
     699 * @param WP_Post $post Current post object.
    700700 */
    701701function post_excerpt_meta_box( $post ) {
    … …  
    719719 * @since 2.6.0
    720720 *
    721  * @param WP_Post $post
     721 * @param WP_Post $post Current post object.
    722722 */
    723723function post_trackback_meta_box( $post ) {
    … …  
    760760 * @since 2.6.0
    761761 *
    762  * @param WP_Post $post
     762 * @param WP_Post $post Current post object.
    763763 */
    764764function post_custom_meta_box( $post ) {
    … …  
    794794 * @since 2.6.0
    795795 *
    796  * @param WP_Post $post
     796 * @param WP_Post $post Current post object.
    797797 */
    798798function post_comment_status_meta_box( $post ) {
    … …  
    816816     * @since 3.1.0
    817817     *
    818      * @param WP_Post $post WP_Post object of the current post.
     818     * @param WP_Post $post WP_Post object for the current post.
    819819     */
    820820    do_action( 'post_comment_status_meta_box-options', $post ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
    … …  
    829829 * @since 3.0.0
    830830 *
    831  * @param array $result table header rows
     831 * @param array $result Table header rows.
    832832 * @return array
    833833 */
    … …  
    842842 * @since 2.8.0
    843843 *
    844  * @param WP_Post $post
     844 * @param WP_Post $post Current post object.
    845845 */
    846846function post_comment_meta_box( $post ) {
    … …  
    883883 * @since 2.6.0
    884884 *
    885  * @param WP_Post $post
     885 * @param WP_Post $post Current post object.
    886886 */
    887887function post_slug_meta_box( $post ) {
    … …  
    900900 * @global int $user_ID
    901901 *
    902  * @param WP_Post $post
     902 * @param WP_Post $post Current post object.
    903903 */
    904904function post_author_meta_box( $post ) {
    … …  
    925925 * @since 2.6.0
    926926 *
    927  * @param WP_Post $post
     927 * @param WP_Post $post Current post object.
    928928 */
    929929function post_revisions_meta_box( $post ) {
    … …  
    940940 * @since 2.7.0
    941941 *
    942  * @param WP_Post $post
     942 * @param WP_Post $post Current post object.
    943943 */
    944944function page_attributes_meta_box( $post ) {
    … …  
    10371037 * @since 2.7.0
    10381038 *
    1039  * @param object $link
     1039 * @param object $link Current link object.
    10401040 */
    10411041function link_submit_meta_box( $link ) {
    … …  
    11131113 * @since 2.6.0
    11141114 *
    1115  * @param object $link
     1115 * @param object $link Current link object.
    11161116 */
    11171117function link_categories_meta_box( $link ) {
    … …  
    11601160 * @since 2.6.0
    11611161 *
    1162  * @param object $link
     1162 * @param object $link Current link object.
    11631163 */
    11641164function link_target_meta_box( $link ) {
    … …  
    11851185 * @since 1.0.1
    11861186 *
    1187  * @global object $link
    1188  *
    1189  * @param string $xfn_relationship
    1190  * @param string $xfn_value
    1191  * @param mixed  $deprecated       Never used.
     1187 * @global object $link Current link object.
     1188 *
     1189 * @param string $xfn_relationship XFN relationship category. Possible values are:
     1190 *                                 'friendship', 'physical', 'professional',
     1191 *                                 'geographical', 'family', 'romantic', 'identity'.
     1192 * @param string $xfn_value        Optional. The XFN value to mark as checked
     1193 *                                 if it matches the current link's relationship.
     1194 * @param mixed  $deprecated       Deprecated. Not used.
    11921195 */
    11931196function xfn_check( $xfn_relationship, $xfn_value = '', $deprecated = '' ) {
    … …  
    12011204    $link_rels = preg_split( '/\s+/', $link_rel );
    12021205
    1203     // Mark the specified value as checked if it matches the link relationship.
     1206    // Mark the specified value as checked if it matches the current link's relationship.
    12041207    if ( '' !== $xfn_value && in_array( $xfn_value, $link_rels, true ) ) {
    12051208        echo ' checked="checked"';
    … …  
    12071210
    12081211    if ( '' === $xfn_value ) {
    1209         // Mark the 'none' value as checked if the link does not match the specified relationship.
     1212        // Mark the 'none' value as checked if the current link does not match the specified relationship.
    12101213        if ( 'family' === $xfn_relationship
    12111214            && ! array_intersect( $link_rels, array( 'child', 'parent', 'sibling', 'spouse', 'kin' ) )
    … …  
    12261229        }
    12271230
    1228         // Mark the 'me' value as checked if it matches the link relationship.
     1231        // Mark the 'me' value as checked if it matches the current link's relationship.
    12291232        if ( 'identity' === $xfn_relationship
    12301233            && in_array( 'me', $link_rels, true )
    … …  
    12401243 * @since 2.6.0
    12411244 *
    1242  * @param object $link
     1245 * @param object $link Current link object.
    12431246 */
    12441247function link_xfn_meta_box( $link ) {
    … …  
    13581361 * @since 2.6.0
    13591362 *
    1360  * @param object $link
     1363 * @param object $link Current link object.
    13611364 */
    13621365function link_advanced_meta_box( $link ) {
    … …  
    13991402 * @since 2.9.0
    14001403 *
    1401  * @param WP_Post $post A post object.
     1404 * @param WP_Post $post Current post object.
    14021405 */
    14031406function post_thumbnail_meta_box( $post ) {
    … …  
    14111414 * @since 3.9.0
    14121415 *
    1413  * @param WP_Post $post A post object.
     1416 * @param WP_Post $post Current post object.
    14141417 */
    14151418function attachment_id3_data_meta_box( $post ) {
Note: See TracChangeset for help on using the changeset viewer.