display_site_states

Filter Hook

Description

Filters the default site display states for items in the Sites list table.

Hook Information

File Location	`wp-admin/includes/class-wp-ms-sites-list-table.php` View on GitHub
Hook Type	Filter
Line Number	`673`

Hook Parameters

Type	Name	Description
`string[]`	`$site_states`	An array of site states. Default 'Main', 'Archived', 'Mature', 'Spam', 'Deleted'.
`WP_Site`	`$site`	The current site object.

Usage Examples

Basic Usage

<?php
// Hook into display_site_states
add_filter('display_site_states', 'my_custom_filter', 10, 2);

function my_custom_filter($site_states, $site) {
    // Your custom filtering logic here
    return $site_states;
}

Source Code Context

wp-admin/includes/class-wp-ms-sites-list-table.php:673 - How this hook is used in WordPress core

<?php
 668  		 *
 669  		 * @param string[] $site_states An array of site states. Default 'Main',
 670  		 *                              'Archived', 'Mature', 'Spam', 'Deleted'.
 671  		 * @param WP_Site  $site        The current site object.
 672  		 */
 673  		$site_states = apply_filters( 'display_site_states', $site_states, $_site );
 674  
 675  		if ( ! empty( $site_states ) ) {
 676  			$state_count = count( $site_states );
 677  
 678  			$i = 0;

PHP Documentation

<?php
/**
		 * 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.
		 */

Quick Info

Hook Type: Filter
Parameters: 2
File: wp-admin/includes/class-wp-ms-sites-list-table.php

Links

WordPress Docs View Source Code Search Examples

Related Hooks

Related hooks will be displayed here in future updates.