WP_MS_Sites_List_Table::site_states() WordPress Method

The WP_MS_Sites_List_Table::site_states() method is used to list the various states of a site in a WordPress network. The possible states are: all, active, archived, and spammed. This method is called by the WP_MS_Sites_List_Table::prepare_items() method.

WP_MS_Sites_List_Table::site_states( array $site ) #

Maybe output comma-separated site states.


Parameters

$site

(array)(Required)


Top ↑

Source

File: wp-admin/includes/class-wp-ms-sites-list-table.php

	protected function site_states( $site ) {
		$site_states = array();

		// $site is still an array, so get the object.
		$_site = WP_Site::get_instance( $site['blog_id'] );

		if ( is_main_site( $_site->id ) ) {
			$site_states['main'] = __( 'Main' );
		}

		reset( $this->status_list );

		$site_status = isset( $_REQUEST['status'] ) ? wp_unslash( trim( $_REQUEST['status'] ) ) : '';
		foreach ( $this->status_list as $status => $col ) {
			if ( ( 1 === (int) $_site->{$status} ) && ( $site_status !== $status ) ) {
				$site_states[ $col[0] ] = $col[1];
			}
		}

		/**
		 * Filters the default site display states for items in the Sites list table.
		 *
		 * @since 5.3.0
		 *
		 * @param string[] $site_states An array of site states. Default 'Main',
		 *                              'Archived', 'Mature', 'Spam', 'Deleted'.
		 * @param WP_Site  $site        The current site object.
		 */
		$site_states = apply_filters( 'display_site_states', $site_states, $_site );

		if ( ! empty( $site_states ) ) {
			$state_count = count( $site_states );

			$i = 0;

			echo ' — ';

			foreach ( $site_states as $state ) {
				++$i;

				$sep = ( $i < $state_count ) ? ', ' : '';

				echo "<span class='post-state'>{$state}{$sep}</span>";
			}
		}
	}


Top ↑

Changelog

Changelog
VersionDescription
5.3.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.