-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Add logic to sort posts by hierarchy #8014
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
oandregal
wants to merge
7
commits into
WordPress:trunk
Choose a base branch
from
oandregal:add/post-controller-hierarchy
base: trunk
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
e1545b5
Add logic to sort posts by hierarchy
oandregal 09fb57b
Declare orderby_hierarchy in post controller test
oandregal 48b3a53
Update wp-api-generated fixture
oandregal cd2f956
Do not use filters
oandregal a6000fc
Use class directly and remove static cache
oandregal b4a54ef
Fix PHP lint issues
oandregal ec420bb
Update unit tests to latest changes
oandregal File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Use class directly and remove static cache
- Loading branch information
commit a6000fc2f920ad73fcc0d74d28e9292db6e9de87
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,19 +14,22 @@ | |
| */ | ||
| class Hierarchical_Sort { | ||
|
|
||
| private static $post_ids = array(); | ||
| private static $levels = array(); | ||
| private static $instance; | ||
|
|
||
| public static function get_instance() { | ||
| if ( null === self::$instance ) { | ||
| self::$instance = new self(); | ||
| /** | ||
| * Check if the request is eligible for hierarchical sorting. | ||
| * | ||
| * @param array $request The request data. | ||
| * | ||
| * @return bool Return true if the request is eligible for hierarchical sorting. | ||
| */ | ||
| public static function is_eligible( $request ) { | ||
| if ( ! isset( $request['orderby_hierarchy'] ) || true !== $request['orderby_hierarchy'] ) { | ||
| return false; | ||
| } | ||
|
|
||
| return self::$instance; | ||
| return true; | ||
| } | ||
|
|
||
| public function run( $args ) { | ||
| public static function run( $args ) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. PHPdocs required. |
||
| $new_args = array_merge( | ||
| $args, | ||
| array( | ||
|
|
@@ -36,28 +39,11 @@ public function run( $args ) { | |
| ); | ||
| $query = new WP_Query( $new_args ); | ||
| $posts = $query->posts; | ||
| $result = self::sort( $posts ); | ||
|
|
||
| self::$post_ids = $result['post_ids']; | ||
| self::$levels = $result['levels']; | ||
| } | ||
|
|
||
| /** | ||
| * Check if the request is eligible for hierarchical sorting. | ||
| * | ||
| * @param array $request The request data. | ||
| * | ||
| * @return bool Return true if the request is eligible for hierarchical sorting. | ||
| */ | ||
| public static function is_eligible( $request ) { | ||
| if ( ! isset( $request['orderby_hierarchy'] ) || true !== $request['orderby_hierarchy'] ) { | ||
| return false; | ||
| } | ||
|
|
||
| return true; | ||
| return self::sort( $posts ); | ||
| } | ||
|
|
||
| public static function get_ancestor( $post_id ) { | ||
| private static function get_ancestor( $post_id ) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Php docs required. |
||
| return get_post( $post_id )->post_parent ?? 0; | ||
| } | ||
|
|
||
|
|
@@ -93,7 +79,7 @@ public static function get_ancestor( $post_id ) { | |
| * @type array $levels Array of levels for the corresponding post ID in the same index | ||
| * } | ||
| */ | ||
| public static function sort( $posts ) { | ||
| private static function sort( $posts ) { | ||
| /* | ||
| * Arrange pages in two arrays: | ||
| * | ||
|
|
@@ -152,38 +138,4 @@ private static function add_hierarchical_ids( &$ids, &$levels, $level, $to_proce | |
| } | ||
| } | ||
| } | ||
|
|
||
| public static function get_post_ids() { | ||
| return self::$post_ids; | ||
| } | ||
|
|
||
| public static function get_levels() { | ||
| return self::$levels; | ||
| } | ||
| } | ||
|
|
||
| function rest_page_query_hierarchical_sort_filter_by_post_in( $args, $request ) { | ||
| if ( ! Hierarchical_Sort::is_eligible( $request ) ) { | ||
| return $args; | ||
| } | ||
|
|
||
| $hs = Hierarchical_Sort::get_instance(); | ||
| $hs->run( $args ); | ||
|
|
||
| // Reconfigure the args to display only the ids in the list. | ||
| $args['post__in'] = $hs->get_post_ids(); | ||
| $args['orderby'] = 'post__in'; | ||
|
|
||
| return $args; | ||
| } | ||
|
|
||
| function rest_prepare_page_hierarchical_sort_add_levels( $response, $post, $request ) { | ||
| if ( ! Hierarchical_Sort::is_eligible( $request ) ) { | ||
| return $response; | ||
| } | ||
|
|
||
| $hs = Hierarchical_Sort::get_instance(); | ||
| $response->data['level'] = $hs->get_levels()[ $post->ID ]; | ||
|
|
||
| return $response; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do any of the methods in this class need to be static? Static methods have a number of downside, including performance as static methods are not garbage collected in the same way that other methods are. For this one place where the class is used, we could just create an instance of the class and use public methods.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why does this need to be another class? Why can't this be part of the
WP_REST_Posts_Controllerclass?