How to use edit_posts_per_page filter in WordPress

edit_posts_per_page filter

Filters the number of posts displayed per page when specifically listing “posts”.

To use the edit_posts_per_page filter, first, you have to register it using add_filter. You can write this code into the functions.php of your activated theme or in a custom WordPress Plugin.

At WePlugins, we always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_edit_posts_per_page_defaults which takes 2 parameters and we registered using add_filter. The first parameter edit_posts_per_page is the name of the hook, The second parameter weplugins_modify_edit_posts_per_page_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook so you can use remove_filter to remove the edit_posts_per_page filter.

Parameters

Below are the 2 parameters required to use this hook.

• $posts_per_page: (int) Number of posts to be displayed. Default 20.
• $post_type: (string) The post type.

Live Example

apply_filters( 'edit_posts_per_page', int $posts_per_page, string $post_type )

Below is an example of how you can use this hook.

Example 1: Modify Posts Per Page

In this example, we modify the number of posts displayed per page according to our website requirements.

    function weplugins_modify_edit_posts_per_page_defaults($posts_per_page, $post_type) {
        // Update the $posts_per_page variable according to your website requirements and return this variable. You can modify the $posts_per_page variable conditionally too if you want.
        return $posts_per_page;
    }
    // Add the filter
    add_filter("edit_posts_per_page", "weplugins_modify_edit_posts_per_page_defaults", 10, 2);
    

Example 2: Conditional Posts Per Page

This example shows how to conditionally modify the number of posts per page based on post type.

    function weplugins_modify_edit_posts_per_page_defaults($posts_per_page, $post_type) {
        if ($post_type == 'custom_post_type') {
            $posts_per_page = 10; // Custom post type has 10 posts per page
        } else {
            $posts_per_page = 20; // Default posts per page
        }
        return $posts_per_page;
    }
    // Add the filter
    add_filter("edit_posts_per_page", "weplugins_modify_edit_posts_per_page_defaults", 10, 2);
    

Example 3: Remove the Hook Callback

To remove a hook callback, use the example below. Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

    remove_filter("edit_posts_per_page", "weplugins_modify_edit_posts_per_page_defaults", 10, 2);
    

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.