Changeset 45083

Timestamp:

04/01/2019 12:46:04 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for postbox_classes().

Rename $page and $id variables to $screen_id and $box_id for clarity.

Props sharifkiberu, DrewAPicture.
Fixes #45179.

File:

• trunk/src/wp-admin/includes/post.php (modified) (3 diffs)

trunk/src/wp-admin/includes/post.php

@@ -1292 +1292 @@
  * @since 2.5.0
  *
- * @param string $id
- * @param string $page
- * @return string
- */
-function postbox_classes( $id, $page ) {
-    if ( isset( $_GET['edit'] ) && $_GET['edit'] == $id ) {
+ * @param string $box_id    Meta box ID (used in the 'id' attribute for the meta box).
+ * @param string $screen_id The screen on which the meta box is shown.
+ * @return string Space-separated string of class names.
+ */
+function postbox_classes( $box_id, $screen_id ) {
+    if ( isset( $_GET['edit'] ) && $_GET['edit'] == $box_id ) {
         $classes = array( '' );
-    } elseif ( $closed = get_user_option( 'closedpostboxes_' . $page ) ) {
+    } elseif ( $closed = get_user_option( 'closedpostboxes_' . $screen_id ) ) {
         if ( ! is_array( $closed ) ) {
             $classes = array( '' );
         } else {
-            $classes = in_array( $id, $closed ) ? array( 'closed' ) : array( '' );
+            $classes = in_array( $box_id, $closed ) ? array( 'closed' ) : array( '' );
         }
     } else {
@@ -1310 +1310 @@
 
     /**
-     * Filters the postbox classes for a specific screen and screen ID combo.
-     *
-     * The dynamic portions of the hook name, `$page` and `$id`, refer to
-     * the screen and screen ID, respectively.
+     * Filters the postbox classes for a specific screen and box ID combo.
+     *
+     * The dynamic portions of the hook name, `$screen_id` and `$box_id`, refer to
+     * the screen ID and meta box ID, respectively.
      *
      * @since 3.2.0
@@ -1319 +1319 @@
      * @param string[] $classes An array of postbox classes.
      */
-    $classes = apply_filters( "postbox_classes_{$page}_{$id}", $classes );
+    $classes = apply_filters( "postbox_classes_{$screen_id}_{$box_id}", $classes );
     return implode( ' ', $classes );
 }