Skip to content

Latest commit

 

History

History
132 lines (79 loc) · 9.05 KB

README.md

File metadata and controls

132 lines (79 loc) · 9.05 KB

Simple Page Ordering

Simple Page Ordering

Support Level Required PHP Version Required WP Version WordPress tested up to version GPLv2 License Dependency Review E2E test PHP Compatibility PHPCS JS Lint CodeQL WordPress Playground Demo

Order your pages and other hierarchical post types with simple drag and drop right from the standard page list.

Overview

Order your pages and other custom post types that support "page-attributes" with drag and drop right from the built in page list.

Drag and drop the page into the desired position. No new admin menus pages, no clunky, bolted on user interfaces. Drag and drop on the page or post-type screen.

The plug-in is "capabilities aware" - only users with the ability to edit others' pages (editors and administrators) will be able to reorder content.

Integrated help is included: click the "help" tab at the top right of the screen.

Please note that the plug-in is not compatible with Internet Explorer 7 and earlier, due to limitations within those browsers.

Want to help? Check out our contributing guidelines to get started.

Installation

  1. Install either via the WordPress.org plugin directory, or by uploading the files to your server.
  2. Activate the plugin through the 'Plugins' menu in WordPress.
  3. Get to work reordering your content!

Frequently Asked Questions

Why can't I reorder my posts?

Generic posts are not displayed by menu order - they're displayed by chronology. You can theoretically add menu ordering to posts in your code (theme functions.php, plug-in) by using:

add_post_type_support( 'post', 'page-attributes' );

Can I make my custom post type take advantage of this plug-in?

Yep. When you register the post type, include the page-attributes feature in the support list. This will add a Sort by Order option to the filter links above the drop downs. Once you sort by order, you can drag and drop the content.

'supports' => array( 'title', 'editor', 'page-attributes' ),

Alternatively, when you register the post type, set hierarchical to true - hierarchical post types natively order by menu order.

You can also take advantage of the simple_page_ordering_is_sortable filter, which passes the result of the default check and the post type name, to override default behavior.

I want my non-hierarchical post type to be sortable. Help!

See the previous two answers - just add page-attributes to the list of supported post type features.

I reordered my posts, but the order didn't change on the front end of my site!

This plug-in doesn't change any behavior on the front end, it simply changes the menu order stored in WordPress.

If you want a list of pages or custom post types to display in that defined order, you must change the post query's orderby parameter to menu_order (if it's not already).

I reordered my content, it seemed to work, but when I refreshed, it went back to the old order!

This most likely means the AJAX request - the server side code - failed after you dropped the content into the new position. Some shared hosts aggressively time out and limit AJAX requests. Version 2.0 batches these requests so you can try reducing the number of items it updates on each request using a filter in your theme's functions.php or a custom plug-in:

add_filter( 'simple_page_ordering_limit', function($number) { return 5; } );

Where 5 is the number of items to batch on each request (the default is 50). Note that this example uses PHP 5.3+ callback functions, so if you're still on PHP 5.2, you'll need to add a traditional callback.

What happened to the drop down box that let me change the number of items on each page in the admin?

This feature is already built into WordPress natively, but a bit tucked away. If you pull down the "Screen Options" tab up top (on the list of post objects) there's a field where you can specify the number of items to show per page. I decided it was not a very good practice to duplicate this.

How can I modify sortable post types?

Post types can be included or excluded by using the simple_page_ordering_is_sortable filter.

For example, to exclude the excluded_post_type custom post type, add the following snippet in the theme function file or custom plugin:

add_filter( 'simple_page_ordering_is_sortable', function( $sortable, $post_type ) {
	if ( 'excluded_post_type' === $post_type ) {
		return false;
	}
	return $sortable;
}, 10, 2 );

To include the include_post_type custom post type, add the following snippet in the theme function file or custom plugin:

add_filter( 'simple_page_ordering_is_sortable', function( $sortable, $post_type ) {
    if ( 'include_post_type' === $post_type ) {
        return true;
    }
    return $sortable;
}, 10, 2 );

Can I use REST to order posts?

Yes. The plugin registers the REST endpoint simple-page-ordering/v1/page_ordering.

Input parameters

Name Type Description Mandatory Default value
id integer The ID of the post you are positioning yes
previd integer The ID of the post previous to the one you want to position yes
nextid integer The ID of the post next to the one you want to position yes
start integer The start index no 1
exclude array Array of post IDs to be excluded no empty array

Example request

Type URL
post /wp-json/simple-page-ordering/v1/page_ordering/?id=2&previd=13&nextid=14&excluded=[]

Support Level

Stable: 10up is not planning to develop any new features for this, but will still respond to bug reports and security concerns. We welcome PRs, but any that include new features should be small and easy to integrate and should not include breaking changes. We otherwise intend to keep this tested up to the most recent version of WordPress.

Changelog

A complete listing of all notable changes to Simple Page Ordering are documented in CHANGELOG.md.

Contributing

Please read CODE_OF_CONDUCT.md for details on our code of conduct, CONTRIBUTING.md for details on the process for submitting pull requests to us, and CREDITS.md for a listing of maintainers, contributors, and libraries for Simple Page Ordering.

Like what you see?