DEV Community: Mithun Biswas

How to Customize Paginated Links for BuddyPress Members & Groups Directory Pages

Mithun Biswas — Mon, 24 Jun 2019 07:34:37 +0000

BuddyPress is using the paginate_links() function for building paginated navigation links on members and groups directory pages. The paginate_links() function is working fine on directory pages but we want to customize the output a little bit.

We’d like to add the following changes to the default output of the paginate_links() function.

We will display the number of total items.
Instead of disabling the current page link, we will add text input so the user can put any number to navigate pages easily.
We have links for previous and next page but will also add two additional links to navigate to the first and last page easily and remove unnecessary links.

Let’s start.‌

First, we will prepare our main function which will display pagination links based on parameters. We have customized the WordPress’s existing paginate_links() function to create our own my_theme_buddypress_paginate_links() function.‌

You can check WordPress Codex to learn more about how paginate_links() function works.‌

Let’s start with my_theme_buddypress_paginate_links() function which will return empty string for now instead of paginated links.

We will define our default arguments which will be parsed with the arguments you pass when calling the function. You can pass an array of arguments for generating paginated links, and your arguments will be parsed with the defaults.

Conditionally we have to disable first, previous, next and last buttons, so the user can’t click on these buttons to navigate. Let’s add conditions to update our arguments.

Now update the $output variable to display the number of total items.

We will save our paginated links in an array and add these to the output using the join() function.

We have added a class button to each link, this will prevent running BuddyPress’s default JavaScript function for our custom paginated links.‌

Now we have our own my_theme_buddypress_paginate_links() function, and it’s ready to use when filtering the BuddyPress members and groups pagination links before getting displayed.‌

We will filter bp_get_members_pagination_links and bp_get_groups_pagination_links hooks.‌

The following code is for adding a hook callback to filter the members’ pagination links.

We are almost done! ‌

Pagination links will not work properly until we add some Javascript to send Ajax request to update the results.‌

Let’s add inline Javascript in the footer of your website with WordPress wp_footerhook.

The above Javascript will listen to onclick JavaScript event when you click on paginated links and send Ajax filter request to display the updated results of the current page.‌

Let’s update the my_theme_footer_scripts callback function with the following code.

The above Javascript will listen to onchange JavaScript event when you enter a new value in the input field of the current page and send Ajax filter request to display the updated results of the current page.‌

Full source code is available to download on GitHub as a WordPress plugin, you can download or clone the repository easily.‌

Enjoy!

The post How to Customize Paginated Links for BuddyPress Members & Groups Directory Pages appeared first on upnrunn® | Build & Deploy Powerful Application.

How To Extend WP REST API From Your Custom Plugin: Part 4

Mithun Biswas — Wed, 17 Oct 2018 06:14:25 +0000

This is article 4 of 5 in the series “How To Extend WP REST API From Your Custom Plugin”. In case you missed the previous tutorials check the list below:

We have created a controller class in the last tutorial to fetch restaurant items and a single restaurant item. A controller class helps to handle the functionality of an endpoint easily. You can learn more about the controller class by reading the REST API Handbook regarding Controller Classes.

In this tutorial, we will write a few controller methods to update or delete a single restaurant item. Make sure you have installed WP Restaurant Listings and the custom plugins we created in the last tutorials.

First, we will add a delete method to the existing route where we can send HTTP request to delete a restaurant item.

The delete method we have just added accepts one argument to choose whether to bypass trash and force deletion. However, we have to add two missing methods delete_item and delete_item_permissions_check also.

Now, our delete_item method is ready which is responsible for deleting a restaurant item. We will write logic in delete_item_permissions_check method to check if a given request has access to delete a restaurant item.

You have noticed that we are using the get_restaurant method, let us add this method also.

Finally, everything is ready to delete a restaurant item by sending a simple HTTP DELETE request.

Let’s send a HTTP DELETE request to wp-json/rest-tutorial/v1/restaurants/{id} endpoint. If the restaurant has been deleted successfully you will get the following response.

When sending a request using Postman make sure you have installed Basic Auth plugin for basic authentication.

You also can set param force=true to permanently delete item instead of moving to trash.

In the next tutorials, we will learn how to create and update a restaurant item by sending the HTTP POST method.

The post How To Extend WP REST API From Your Custom Plugin: Part 4 appeared first on upnrunn® | Build & Deploy Powerful Application.

How To Extend WP REST API From Your Custom Plugin: Part 3

Mithun Biswas — Wed, 11 Apr 2018 14:09:47 +0000

This is article 3 of 5 in the series “How To Extend WP REST API From Your Custom Plugin”. In case you missed the previous tutorials check the list below:

In the previous tutorials, we have created a basic plugin where we can write our code and learned how to extend REST API by modifying responses.

WordPress REST API has default routes and endpoints. It also allows developers to add custom routes and endpoints. That’s great. In this tutorial, we will learn how to add custom endpoints.

Recently, we have released a plugin called WP Restaurant Listings which you can use to add restaurant listing functionality to your WordPress site. This plugin doesn’t have builtin custom endpoints to access your restaurant site’s data through WP REST API. So, We are going to add custom endpoints in our plugin to access data by sending HTTP request easily.

We will use the controller pattern, so we can organize our code easily. You can learn more about the controller pattern here.

First, create a file called class-rest-tutorial-restaurant-endpoint.php inside the includes folder of the plugin we created in the previous tutorials with the following content.

We did not register the route yet. To register the new route we will use the register_rest_route function. We will pass in three parameters: the namespace, the route we want, and the options (an array of arrays for multiple methods) to this function. Inside the register_routes method, let’s add the following code.

We are using WP_REST_Server constants to set the method, it a common practice. So we are using WP_REST_Server::READABLE to set the method to ‘GET’. When users send ‘GET’ request to the registered route get_items method of the class will be called. Let’s add that method.

We also need to add get_items_permissions_check method. To make restaurants readable by all users we need to make sure that get_items_permissions_check return true.

Next, we are going to add a method which will return an array of parameters. Our newly registered route will accept these parameters when sending ‘GET’ request to WP REST API.

Finally, we need to add another method which will prepare restaurant data and return as an object.

Now, our class REST_TUTORIAL_Restaurnt_Endpoint is ready to do some cool things. We did not include this class yet, so we need to include it first. Add the following code inside the rest-api-tutorial.php file.

We are checking if the WP_Restaurant_Listings plugin is installed or not. If the the plugin is not installed and active we will not include the REST_TUTORIAL_Restaurnt_Endpoint class. So, it is required to install and activate WP_Restaurant_Listings plugin to make it work.

We did an awesome job. Now if we send “GET’ request to wp-json/rest-tutorial/v1/restaurants we will get the restaurants in simple JSON format as pictured below.

Similarly, we can register another route to get single restaurant item. We’re going to have the route match anything with /restaurants/{id}, where {id} is an integer. Check the following code.

We are using the get_items_permissions_check again to make restaurant readable by all users. Now, it’s time to retrieve the restaurant by adding the get_item method.

Now, you can now easily get a restaurant data by sending HTTP “GET” request to wp-json/rest-tutorial/v1/restaurants/{id} endpoint.

In the next tutorials, I will show you how to register route with POST, PUT, DELETE methods to update or delete a restaurant.

The post How To Extend WP REST API From Your Custom Plugin: Part 3 appeared first on upnrunn® | Build & Deploy Powerful Application.