{"id":293,"date":"2016-01-16T17:31:55","date_gmt":"2016-01-16T17:31:55","guid":{"rendered":"http:\/\/buddydev.com\/mediapress\/?p=293"},"modified":"2016-01-16T17:32:32","modified_gmt":"2016-01-16T17:32:32","slug":"mpp_gallery_query","status":"publish","type":"post","link":"https:\/\/buddydev.com\/mediapress\/core\/mpp_gallery_query\/","title":{"rendered":"MPP_Gallery_Query"},"content":{"rendered":"

MPP_Gallery_Query<\/strong> class is defined in mediapress\/core\/common\/class-mpp-gallery-query.php. MPP_Gallery_Query<\/strong> extends WP_Query<\/strong> to provide a familiar API for retrieving and listing galleries.<\/p>\n

MediaPress uses an object of MPP_Gallery_Query internally to keep track of current page(is single gallery, archive \u00a0etc). MediaPress sets up the internal object on MediaPress singleton instance in setup_globals<\/strong>() method in MPP_Core_Component<\/strong> class.<\/p>\n

Interacting with MPP_Gallery_Query<\/h3>\n

In general, \u00a0you don’t need to worry about the internals. This class is very useful when you want to retrieve galleries\u00a0based on certain parameters. Most of the time, you will be using MPP_Gallery_Query<\/strong> while creating a custom gallery\u00a0loop.<\/p>\n

Standard Loop:-<\/h3>\n
\/\/ The Query\r\n$the_gallery_query = new MPP_Gallery_Query( $args );\r\n\r\n\/\/ The Loop\r\nif ( $the_gallery_query->have_galleries() ) {\r\n\techo '<ul>';\r\n\twhile ( $the_gallery_query->have_galleries() ) {\r\n\t\t$the_gallery_query->the_gallery();\r\n\t\techo '<li>' . mpp_get_gallery_title() . '<\/li>';\r\n\t}\r\n\techo '<\/ul>';\r\n} else {\r\n\t\/\/ no posts found\r\n}\r\n\/* Restore original galler\/post data *\/\r\nmpp_reset_gallery_data();<\/pre>\n
Another Loop:-<\/h3>\n
\/\/ the query\r\n$the_gallery_query = new MPP_Gallery_Query( $args ); ?>\r\n\r\n<?php if ( $the_gallery_query->have_galleries() ) : ?>\r\n\r\n\t\r\n\t<!-- the loop -->\r\n\t<?php while ( $the_gallery_query->have_galleries() ) : $the_gallery_query->the_gallery(); ?>\r\n\t<h2><?php mpp_get_gallery_title(); ?><\/h2>\r\n\t<?php endwhile; ?>\r\n\t<!-- end of the loop -->\r\n\r\n\t<?php mpp_reset_gallery_data(); ?>\r\n\r\n<?php else : ?>\r\n\t<p><?php _e( 'Sorry, no gallery found.' ); ?><\/p>\r\n<?php endif; ?>\r\n\r\n<\/pre>\n
Whatever style you like. I recommend the second one.<\/p>\n
Multiple Loop:-<\/h3>\n
Though it is not recommended to create many loops( because each query needs multiple database queries), If needed, you can create as many loop as you want.<\/p>\n
Methods & properties:-<\/h3>\n
It inherits all the properties and methods from WP_Query<\/a>. Other than that, It adds a few of its own.<\/p>\n
query( $args )<\/strong><\/p>\n
It uses parent::query() and only allows limited options with query. Not all WP_Query parameters are supported by MPP_Gallery_Query.<\/p>\n
get_galleries()<\/strong><\/p>\n
Equivalent of get_posts()<\/p>\n
next_gallery()<\/strong><\/p>\n
Equivalent of next_post()<\/p>\n
the_gallery()<\/strong><\/p>\n
Equivalent of the_post(). sets up current gallery.<\/p>\n
have_galleries()<\/strong><\/p>\n
Same as have_posts()<\/p>\n
rewind_galleries()<\/strong><\/p>\n
Same as rewind_posts()<\/p>\n
is_main_query()<\/strong><\/p>\n
Are you working with the MediaPress main gallery\u00a0query or a custom gallery\u00a0query.<\/p>\n
reset_gallery_data()<\/strong><\/p>\n
Resets current media. same as wp_reset_postdata()<\/p>\n
paginate()<\/strong><\/p>\n
Generates pagination links for the current loop.<\/p>\n
pagination_count()<\/strong><\/p>\n
prints \u00a0the pagination count for the current loop(e.g viewing 1 to 5 of 20 galleries)<\/p>\n
get_ids()<\/strong><\/p>\n
Get an array containing all the gallery\u00a0ids fetched by current query.<\/p>\n
Parameters:-<\/h3>\n
Type parameters<\/h4>\n
type<\/strong> (array) – array of media types\u00a0e.g array (‘photo’, ‘audio’, ‘doc’)<\/p>\n
Component parameters:-<\/h4>\n