soderlind/class-wp-list-table-custom-column-toggle

Add a toggle column to WP_Table or its siblings.

2.0.0 2021-01-12 00:11 UTC

Requires

• php: >=5.6
• composer/installers: ~1.0

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: *
• squizlabs/php_codesniffer: ^3.3
• wp-coding-standards/wpcs: *

GPL-2.0-or-later

• Per Søderlind

• wordpress
• table
• wp
• toggle

README

Add a toggle column to WP_List_Table or its siblings.

Use

$toggled = \WP_List_Table_Custom_Column_Toggle::create( $propterties );

Where default properties are:

[
    'meta_key'        => 'column_meta_key',  // "toggle" for a single site is saved using post meta
    'column_id'       => 'column_id',
    'column_name'     => 'Column Toggle',
    'column_hooks'    => [
        'header'  => 'manage_page_posts_columns',
        'content' => 'manage_page_posts_custom_column',
    ],
    'use_siteoptions' => false,
]

Get toggled IDs using $toggled->get_values();

Example, note use of column hooks:

$subsite_maintenance_sites = \WP_List_Table_Custom_Column_Toggle::create(
	[
		'column_id'       => 'subsite_maintenance',
		'column_name'     => '<span class="dashicons dashicons-hammer"></span>',
		'column_hooks'    => [
			'header'  => 'wpmu_blogs_columns',
			'content' => 'manage_sites_custom_column',
		],
		'use_siteoptions' => true,
	]
);
$subsite_maintenance = \Subsite_Maintenance::create( $subsite_maintenance_sites );

Working example at: https://github.com/soderlind/subsite-maintenance-mode/

Copyright and License

WP_List_Table Custom Toggle Column is copyright 2021 Per Soderlind

WP_List_Table Custom Toggle Column is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

WP_List_Table Custom Toggle Column is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with the Extension. If not, see http://www.gnu.org/licenses/.