oberonlai / wp-admin-custom-filter

v1.0.0 2021-04-07 13:18 UTC

Requires

• php: >=7.2

MIT

• Oberon Lai

Published on Packagist.org on 2021-04-07 13:19 UTC

README

Simple WordPress custom filter for admin page.

Requirements

• PHP >=7.2
• Composer
• WordPress >=5.4

Installation

Install with composer

Run the following in your terminal to install with Composer.

$ composer require oberonlai/wp-admin-custom-filter

WP Admin Custom Filter PSR-4 autoloading and can be used with the Composer's autoloader. Below is a basic example of getting started, though your setup may be different depending on how you are using Composer.

require __DIR__ . '/vendor/autoload.php';

use ODS\CustomFilter;

$options = array( ... );

$books = new CustomFilter( $options );

See Composer's basic usage guide for details on working with Composer and autoloading.

Basic Usage

Below is a basic example of setting up a simple custom filter with a post meta field.

// Require the Composer autoloader.
require __DIR__ . '/vendor/autoload.php';

// Import PostTypes.
use ODS\CustomFilter;

$option = array(
    'name'     => 'send_status',     // form select name
    'key'      => 'meta_key',        // post meta field name
    'compare'  => '=',               // the compare rule
    'posttype' => 'cptname',         // which post type support with
    'option'   => array(             // dropdown menu
        'all'       =>  __( 'ALL', ''),
        'option1'   =>  __( 'Option1', ''),
        'option2'   =>  __( 'Option2', ''),
    )
);

new CustomFilter( $option );

Then you can see the custom dropdown filter in your admin edit page.