wpseek.com
A WordPress-centric search engine for devs and theme authors



postbox_classes › WordPress Function

Since2.5.0
Deprecatedn/a
› postbox_classes ( $box_id, $screen_id )
Parameters: (2)
  • (string) $box_id Meta box ID (used in the 'id' attribute for the meta box).
    Required: Yes
  • (string) $screen_id The screen on which the meta box is shown.
    Required: Yes
Returns:
  • (string) Space-separated string of class names.
Defined at:
Codex:

Returns the list of classes to be used by a meta box.



Related Functions: post_class, get_post_class, body_class, get_body_class, _post_states

Source 

function postbox_classes( $box_id, $screen_id ) {
	if ( isset( $_GET['edit'] ) && $_GET['edit'] === $box_id ) {
		$classes = array( '' );
	} elseif ( get_user_option( 'closedpostboxes_' . $screen_id ) ) {
		$closed = get_user_option( 'closedpostboxes_' . $screen_id );
		if ( ! is_array( $closed ) ) {
			$classes = array( '' );
		} else {
			$classes = in_array( $box_id, $closed, true ) ? array( 'closed' ) : array( '' );
		}
	} else {
		$classes = array( '' );
	}

	/**
	 * 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
	 *
	 * @param string[] $classes An array of postbox classes.
	 */
	$classes = apply_filters( "postbox_classes_{$screen_id}_{$box_id}", $classes );

	return implode( ' ', $classes );
}