jboullion, Author at JBoullion

Multiple Custom Query with paginate_links

I sometimes have a need to have multiple paginations for multiple queries on a single page. Whenever possible I like to use the build in WordPress helper functions for this purpose rather than rolling my own. However, WordPress’ built in pageinate_links is really meant for WP custom queries…and preferably one query per page.

Here is an example of how you can use this built in function for your own queries! We are using an example which involves three different email lists we need to display.

First, setup your queries:

global $wpdb;

$page_limit = 10;

$email_types = array('need', 'have', 'news');
$results = array();


foreach($email_types as $email_type){
	$results[$email_type] = array();
	$results[$email_type]['count'] = $wpdb->get_var("SELECT COUNT(email_id) FROM {$wpdb->prefix}email_{$email_type} ORDER BY CREATED DESC");

	$results[$email_type]['total'] = ceil($results[$email_type]['count'] / $page_limit);

	// Check if we are on the 2+ page of this type
	if(! empty($_GET['type']) && $_GET['type'] === $email_type){
		$results[$email_type]['current'] = max(1, get_query_var('paged'));
	}else{
		$results[$email_type]['current'] = 1;
	}

	$offset = ($results[$email_type]['current'] - 1) * $page_limit;
	$results[$email_type]['emails'] = $wpdb->get_results("SELECT * FROM {$wpdb->prefix}email_{$email_type} ORDER BY CREATED DESC LIMIT {$offset},{$page_limit}  ");
}

global $wpdb;

$page_limit = 10;

$email_types = array('need', 'have', 'news');

$results = array();

foreach($email_types as $email_type){

$results[$email_type] = array();

$results[$email_type]['count'] = $wpdb->get_var("SELECT COUNT(email_id) FROM {$wpdb->prefix}email_{$email_type} ORDER BY CREATED DESC");

$results[$email_type]['total'] = ceil($results[$email_type]['count'] / $page_limit);

// Check if we are on the 2+ page of this type

if(! empty($_GET['type']) && $_GET['type'] === $email_type){

$results[$email_type]['current'] = max(1, get_query_var('paged'));

}else{

$results[$email_type]['current'] = 1;

}

$offset = ($results[$email_type]['current'] - 1) * $page_limit;

$results[$email_type]['emails'] = $wpdb->get_results("SELECT * FROM {$wpdb->prefix}email_{$email_type} ORDER BY CREATED DESC LIMIT {$offset},{$page_limit} ");

}

Second, display your results: Note, I am leaving out a lot of the display code, but all the relevant pagination code should be here.

foreach($email_types as $key => $email_type){
	$active = '';
	if(! empty($_GET['type'])){
		if($_GET['type'] === $email_type){
			$active = 'active';
		}
	}else if($key === 0){
		$active = 'active';
	}

	echo '<div class="tab-pane fade show '.$active.'" id="archive-'.$email_type.'">';

	foreach($results[$email_type]['emails'] as $email){
		switch($email_type){
			case 'need':
				jb_display_need_email($email);
				break;
			case 'have':
				jb_display_have_email($email);
				break;
			case 'news':
				jb_display_news_email($email);
				break;
		}
	}


	jb_custom_email_pagination($results[$email_type]['total'], $results[$email_type]['current'], $email_type);


	echo '</div>';

}

foreach($email_types as $key => $email_type){

$active = '';

if(! empty($_GET['type'])){

if($_GET['type'] === $email_type){

$active = 'active';

}

}else if($key === 0){

$active = 'active';

}

echo '<div class="tab-pane fade show '.$active.'" id="archive-'.$email_type.'">';

foreach($results[$email_type]['emails'] as $email){

switch($email_type){

case 'need':

jb_display_need_email($email);

break;

case 'have':

jb_display_have_email($email);

break;

case 'news':

jb_display_news_email($email);

break;

}

jb_custom_email_pagination($results[$email_type]['total'], $results[$email_type]['current'], $email_type);

echo '</div>';

}

Notice at the bottom of this loop we are calling our pagination function for each list. The important thing to note here is that we are using a separate ‘type’ variable so we know which list we are paginating.

Lastly, here is the actual pagination function:

function jb_custom_email_pagination($total, $current, $type){
	echo '<div class="pagination-wrapper">
			<div class="pagination">'.paginate_links( array(
				'base' => str_replace( 9999, '%#%', esc_url( get_pagenum_link( 9999 ) ) ),
				'format' => '&paged=%#%',
				'prev_text' => __('<i class="fas fa-angle-left"></i>'),
				'next_text' => __('<i class="fas fa-angle-right"></i>'),
				'total' => $total,
				'current' => $current,
				'add_args' => array( 'type' => $type )
			)).'</div>
			</div>';
}

function jb_custom_email_pagination($total, $current, $type){

echo '<div class="pagination-wrapper">

<div class="pagination">'.paginate_links( array(

'base' => str_replace( 9999, '%#%', esc_url( get_pagenum_link( 9999 ) ) ),

'format' => '&paged=%#%',

'prev_text' => __('<i class="fas fa-angle-left"></i>'),

'next_text' => __('<i class="fas fa-angle-right"></i>'),

'total' => $total,

'current' => $current,

'add_args' => array( 'type' => $type )

)).'</div>

</div>';

}

ACF Gallery Saved to Specific Folder

Recently we had a client that wanted to make sure all of the files in one of their galleries was in a specific directory instead of the default upload/year/month directory.

Here is a simple function to make sure that happens, including updating all previous files uploaded to that gallery.

/**
 * Update the file path of Custom files so that they always are located in the Custom folder
 */
add_action('acf/save_post', 'jb_update_gallery_fields', 1);
function jb_update_gallery_fields( $post_id ) {

	// specific new field value
	$gallery = $_POST['acf']['field_234567890dfghj'];

	if(! empty($gallery)){
		$folder = sanitize_file_name( get_the_title($post_id) );
		$model_dir = '/Custom/'.$folder.'/';
		$uploads = wp_upload_dir();
		$path = $uploads['basedir'] . $model_dir;

		if (! file_exists($path)) {
			mkdir($path, 0777, true);
		}
		
		foreach($gallery as $attachment_id){
			$fullsize_path = get_attached_file( $attachment_id );
			
			//is this attachment in the Custom folder?
			if (strpos($fullsize_path, 'Custom') === false) {
				$new_filepath = $path.basename($fullsize_path);

				//Not in the Custom folder
				rename($fullsize_path, $new_filepath);
				update_attached_file( $attachment_id, $new_filepath );
			}
		}
	}
}

/**

* Update the file path of Custom files so that they always are located in the Custom folder

add_action('acf/save_post', 'jb_update_gallery_fields', 1);

function jb_update_gallery_fields( $post_id ) {

// specific new field value

$gallery = $_POST['acf']['field_234567890dfghj'];

if(! empty($gallery)){

$folder = sanitize_file_name( get_the_title($post_id) );

$model_dir = '/Custom/'.$folder.'/';

$uploads = wp_upload_dir();

$path = $uploads['basedir'] . $model_dir;

if (! file_exists($path)) {

mkdir($path, 0777, true);

}

foreach($gallery as $attachment_id){

$fullsize_path = get_attached_file( $attachment_id );

//is this attachment in the Custom folder?

if (strpos($fullsize_path, 'Custom') === false) {

$new_filepath = $path.basename($fullsize_path);

//Not in the Custom folder

rename($fullsize_path, $new_filepath);

update_attached_file( $attachment_id, $new_filepath );

}

JS Capitalize a String

Just a simple String prototype to capitalize the first letter of the string.

/**
 * Capitalize the first letter of a string
 * usage: str.capitalize()
 */
String.prototype.capitalize = function() {
	return this.charAt(0).toUpperCase() + this.slice(1);
}

/**

* Capitalize the first letter of a string

* usage: str.capitalize()

String.prototype.capitalize = function() {

return this.charAt(0).toUpperCase() + this.slice(1);

}

Convert Form to JS Object

This function will take your entire HTML form and convert all the inputs into a single JS object! Thanks to Dave over at Stack Overflow!

/**
 * Take a form and convert it into a Object for easy manipulation
 * 
 * @link https://stackoverflow.com/a/23315254
 * @link http://jsfiddle.net/akhildave/sxGtM/5002/
 */
$.fn.serializeObject = function() {
	var o = {};
	var a = this.serializeArray();
	$.each(a, function() {
		if (o[this.name] !== undefined) {
			if (!o[this.name].push) {
				o[this.name] = [o[this.name]];
			}
			o[this.name].push(this.value || '');
		} else {
			o[this.name] = this.value || '';
		}
	});
	return o;
};

/**

* Take a form and convert it into a Object for easy manipulation

* @link https://stackoverflow.com/a/23315254

* @link http://jsfiddle.net/akhildave/sxGtM/5002/

$.fn.serializeObject = function() {

var o = {};

var a = this.serializeArray();

$.each(a, function() {

if (o[this.name] !== undefined) {

if (!o[this.name].push) {

o[this.name] = [o[this.name]];

}

o[this.name].push(this.value || '');

} else {

o[this.name] = this.value || '';

}

});

return o;

};

Usage is as simple as:

var formObject= $(‘form’).serializeObject();

Requires jQuery

Search Post Title and Meta

Unfortunately when you are doing a custom query in WordPress by default you can’t search by the “s” parameter and a meta_query. A common technique was to just do two queries and merge them. That works, but it is not efficient.

User Satbir Kira over at StackOverflow posted this great solution. Simply add this function to your functions.php file and replace the “s” parameter in your custom query with a “_meta_or_title” parameter.

add_action( 'pre_get_posts', function( $q ) {
	if( $title = $q->get( '_meta_or_title' ) )
	{
		add_filter( 'get_meta_sql', function( $sql ) use ( $title )
		{
			global $wpdb;

			// Only run once:
			static $nr = 0; 
			if( 0 != $nr++ ) return $sql;

			// Modified WHERE
			$sql['where'] = sprintf(
				" AND ( %s OR %s ) ",
				$wpdb->prepare( "{$wpdb->posts}.post_title like '%%%s%%'", $title),
				mb_substr( $sql['where'], 5, mb_strlen( $sql['where'] ) )
			);

			return $sql;
		});
	}
});

add_action( 'pre_get_posts', function( $q ) {

if( $title = $q->get( '_meta_or_title' ) )

{

add_filter( 'get_meta_sql', function( $sql ) use ( $title )

{

global $wpdb;

// Only run once:

static $nr = 0;

if( 0 != $nr++ ) return $sql;

// Modified WHERE

$sql['where'] = sprintf(

" AND ( %s OR %s ) ",

$wpdb->prepare( "{$wpdb->posts}.post_title like '%%%s%%'", $title),

mb_substr( $sql['where'], 5, mb_strlen( $sql['where'] ) )

);

return $sql;

});

}

});

Here is what an example query might look like.

$search_value = 'Search Me';
$paged = ( get_query_var( 'paged' ) ) ? get_query_var( 'paged' ) : 1;

$args = array(
		'post_type' 	=> 'contacts',
		'paged' 	=> $paged,
        '_meta_or_title' => $search_value,
        'meta_query' => array(
	        'relation'  => 'OR',
	        array(
		        'key' => 'office',
		        'value' => $search_value,
		        'compare' => 'LIKE'
	        ),
	        array(
		        'key' => 'title',
		        'value' => $search_value,
		        'compare' => 'LIKE'
	        ),
	        array(
		        'key' => 'email',
		        'value' => $search_value,
		        'compare' => 'LIKE'
	        )
        )
	);

//$results = new WP_Query( $args ); //need pagination?
$results = get_posts( $args ); //simple listing?

$search_value = 'Search Me';

$paged = ( get_query_var( 'paged' ) ) ? get_query_var( 'paged' ) : 1;

$args = array(

'post_type' => 'contacts',

'paged' => $paged,

'_meta_or_title' => $search_value,

'meta_query' => array(

'relation' => 'OR',

array(

'key' => 'office',

'value' => $search_value,

'compare' => 'LIKE'

array(

'key' => 'title',

'value' => $search_value,

'compare' => 'LIKE'

array(

'key' => 'email',

'value' => $search_value,

'compare' => 'LIKE'

)

);

//$results = new WP_Query( $args ); //need pagination?

$results = get_posts( $args ); //simple listing?

Limit User Role to Certain Posts

There are a variety of plugins out there for managing user role access. User Role Editor (URE) and Advanced Access Manager (AAM) are both good plugins I can recommend.URE is great for…editing roles. The problem with URE is that it doesn’t allow more narrow scope restrictions…like a single post. AAM is great at limiting individual posts and hiding admin menus. AAM however requires a LOT of setup if you have a lot of pages / a lot of roles and starts to become unpractical for highly restrictive page editing.

All that said, I ended up turning to good ol’ taxonomies.

First, setup your taxonomy for your posts. In this case I am targeting a “Departments” custom post type.

jb_register_cpt(array('name' => 'department', 'icon' => 'dashicons-admin-multisite', 'position' => 30, 'hierarchical' => true ));
jb_register_taxonomy('dept_admin', 'departments', 'Department Administration');

1 2	jb_register_cpt(array('name' => 'department', 'icon' => 'dashicons-admin-multisite', 'position' => 30, 'hierarchical' => true )); jb_register_taxonomy('dept_admin', 'departments', 'Department Administration');

See jp_register_cpt and jb_register_taxonomy for info on these functions.

Second, setup your roles with URE. I’ll leave this to you, but I usually start with copying either the “Contributor” or the “Subscriber” default roles and going from there. Mine looks like this:

Third, Add a new admin taxonomy in the new taxonomy you just created. Make sure to give it the same slug as the user role ID, this is just for ease of use later and for reference. Example:

Forth, add this function to your PHP file.

add_action( 'pre_get_posts', 'jb_limit_admin_posts', 1 );
function jb_limit_admin_posts( $query ) {
	global $current_user;
        
        //jb_site_admin just checks if the current user has any 'admin' roles. You could also just check for 'manage_options' capability if you want
	if ( ! jb_is_site_admin($current_user) 
		&& is_admin() 
		&& $query->is_main_query()
		&& $query->get('post_type') == 'departments' ){
			
			$tax_query = array();
			$tax_query['relation'] = 'OR';

			//Some users will have more than one role so we need to allow multiple taxonomies to be used
			if(! empty($current_user->roles)){
				foreach($current_user->roles as $role) {
					$tax_query[] = array(
						'taxonomy' => 'dept_admin',
						'field'    => 'slug',
						'terms'    => $role,
					);
				}
			}
		
			$query->set( 'tax_query', $tax_query );
	}
}

add_action( 'pre_get_posts', 'jb_limit_admin_posts', 1 );

function jb_limit_admin_posts( $query ) {

global $current_user;

//jb_site_admin just checks if the current user has any 'admin' roles. You could also just check for 'manage_options' capability if you want

if ( ! jb_is_site_admin($current_user)

&& is_admin()

&& $query->is_main_query()

&& $query->get('post_type') == 'departments' ){

$tax_query = array();

$tax_query['relation'] = 'OR';

//Some users will have more than one role so we need to allow multiple taxonomies to be used

if(! empty($current_user->roles)){

foreach($current_user->roles as $role) {

$tax_query[] = array(

'taxonomy' => 'dept_admin',

'field' => 'slug',

'terms' => $role,

);

}

$query->set( 'tax_query', $tax_query );

}

All done! Now this user role should not be able to view or edit any posts that do not have this category.