WordPress - pre_get_posts代替页面上的query_posts
我的情况有点复杂，我会尽量简洁地解释一下。
我目前正在使用query_posts来修改我网站上自定义网页上的主要查询，据我所知，虽然我已经知道使用query_posts是一个不好的做法不同的原因。
那么，为什么我使用query_posts而不是创建您可能会问的WP_Query对象？
这是因为我使用的是无限滚动插件，无限滚动对WP_query不起作用，但是当你只使用query_posts修改主查询时，它就可以正常工作。例如，使用无限滚动+ WP_query（主要关注点）分页不起作用。
在一个页面上，我正在修改查询以获取查看次数最多的帖子。
<?php $paged = get_query_var( 'paged' ) ? get_query_var( 'paged' ) : 1; ?>
<?php query_posts( array( 'meta_key' => 'wpb_post_views_count', 'orderby' => 'meta_value_num', 'order' => 'DESC' , 'paged' => $paged, ) ); ?>
<?php if (have_posts()) : ?>
<?php while ( have_posts() ) : the_post() ?>
<?php if ( has_post_format( 'video' )) {
get_template_part( 'video-post' );
}elseif ( has_post_format( 'image' )) {
get_template_part( 'image-post' );
} else {
get_template_part( 'standard-post' );
}
?>
<?php endwhile;?>
<?php endif; ?>
所以经过大量阅读后，我收集到我修改主要查询的其他选项是使用pre_get_posts，尽管我有点不确定如何解决这个问题。
以此为例： -
function textdomain_exclude_category( $query ) {
if ( $query->is_home() && $query->is_main_query() ) {
$query->set( 'cat', '-1,-2' );
}
}
add_action( 'pre_get_posts', 'textdomain_exclude_category' );
好吧，这么简单 - 如果它是主页，修改主查询并排除两个类别。
我对此感到困惑并且无法弄清楚： -
-
自定义页面模板的用例场景。通过我的
query_posts修改，我可以在if (have_posts())之前放入数组，选择我的页面模板，发布它然后离开。 使用pre_get_posts我无法弄清楚如何说$query->most-viewed等 -
array( 'meta_key' => 'wpb_post_views_count', 'orderby' => 'meta_value_num', 'order' => 'DESC' , 'paged' => $paged, ) );
我如何使用pre_get_posts做到这一点，并确保它是分页的，即。与无限卷轴一起工作？在我用pre_get_posts看到的所有例子中都没有数组。
2 个答案:
答案 0 :(得分：13)
如何使用pre_get_posts挂钩通过自定义页面模板显示页面上的帖子列表？
我一直在玩pre_get_posts钩子，这是一个想法
第1步：
使用slug：
创建一个名为 Show 的页面example.com/show
第2步：
创建自定义页面模板：
tpl_show.php
位于当前主题目录中。
第3步：
我们构建了以下pre_get_posts动作回调：
function b2e_pre_get_posts( $query )
{
$target_page = 'show'; // EDIT to your needs
if ( ! is_admin() // front-end only
&& $query->is_main_query() // main query only
&& $target_page === $query->get( 'pagename' ) // matching pagename only
) {
// modify query_vars:
$query->set( 'post_type', 'post' ); // override 'post_type'
$query->set( 'pagename', null ); // override 'pagename'
$query->set( 'posts_per_page', 10 );
$query->set( 'meta_key', 'wpb_post_views_count' );
$query->set( 'orderby', 'meta_value_num' );
$query->set( 'order', 'DESC' );
// Support for paging
$query->is_singular = 0;
// custom page template
add_filter( 'template_include', 'b2e_template_include', 99 );
}
}
add_action( 'pre_get_posts', 'b2e_pre_get_posts' );
，其中
function b2e_template_include( $template )
{
$target_tpl = 'tpl_show.php'; // EDIT to your needs
remove_filter( 'template_include', 'b2e_template_include', 99 );
$new_template = locate_template( array( $target_tpl ) );
if ( ! empty( $new_template ) )
$template = $new_template; ;
return $template;
}
这也应该给我们分页：
example.com/show/page/2
example.com/show/page/3
等
备注
我根据@PieterGoosen的建议更新了答案并删除了查询对象部分修改，因为它可以例如打破他的设置上的面包屑。
同时删除了is_page()钩子中的pre_get_posts检查，因为在某些情况下它可能仍然存在一些违规行为。原因是查询对象并不总是可用。这正在研究中，参见例如#27015。如果我们想要使用is_page()或is_front_page()。
我构建了下表，只是为了更好地概述主WP_Query个对象的某些属性和查询变量蛞蝓：
WP_Query nopaging中的分页取决于// Paging
if ( empty($q['nopaging']) && !$this->is_singular ) {
$page = absint($q['paged']);
if ( !$page )
$page = 1;
// If 'offset' is provided, it takes precedence over 'paged'.
if ( isset( $q['offset'] ) && is_numeric( $q['offset'] ) ) {
$q['offset'] = absint( $q['offset'] );
$pgstrt = $q['offset'] . ', ';
} else {
$pgstrt = absint( ( $page - 1 ) * $q['posts_per_page'] ) . ', ';
}
$limits = 'LIMIT ' . $pgstrt . $q['posts_per_page'];
}
未设置且当前页面不是单数 interesting to note （来自4.4 source）：
LIMIT我们可以看到生成的SQL查询的is_singular部分在条件检查范围内。这解释了为什么我们修改上面的pre_get_posts属性。
我们可以使用其他过滤器/钩子，但是在这里我们使用了OP提到的{{1}}。
希望得到这个帮助。
答案 1 :(得分：2)
从@birgire回答的灵感来看，我提出了以下想法。 （注意：This is a copy of my answer from this answer over at WPSE ）
我在这里尝试做的是宁愿使用后期注入而不是完全改变主要查询并且遇到所有上述问题，例如直接改变全局变量，全局值问题和重新分配页面模板。
通过使用帖子注入，我可以保持完整的帖子完整性，因此$wp_the_query->post，$wp_query->post，$posts和$post在整个模板中保持不变，它们都只保存当前页面对象，就像真实页面的情况一样。这样，像breadcrumbs这样的函数仍然认为当前页面是真正的页面而不是某种存档
我不得不稍微改变主要查询（通过过滤器和操作）以调整分页，但我们将会这样做。
POST INJECTION QUERY
为了完成后期注入，我使用自定义查询来返回注入所需的帖子。我还使用自定义查询的$found_pages属性来调整主查询的属性，以便从主查询中获取分页功能。帖子通过loop_end操作注入主查询。
为了使自定义查询可以在课外访问和使用，我介绍了几个操作。
-
分页挂钩以挂钩分页功能：
-
pregetgostsforgages_before_loop_pagination -
pregetgostsforgages_after_loop_pagination
-
-
自定义计数器，用于计算循环中的帖子。这些操作可用于根据帖子编号
更改帖子在循环内的显示方式-
pregetgostsforgages_counter_before_template_part -
pregetgostsforgages_counter_after_template_part
-
-
用于访问查询对象和当前帖子对象的常规挂钩
-
pregetgostsforgages_current_post_and_object
-
这些钩子为您提供完全不干涉的体验，因为您无需更改页面模板本身的任何内容，这从一开始就是我的初衷。页面可以完全从插件或函数文件中更改，这使得这非常动态
我还使用了get_template_part()来加载将用于显示帖子的模板部分。今天的大多数主题都使用模板部分，这使得它在课堂上非常有用。如果您的主题使用content.php，则只需将content传递给$templatePart即可加载content.php。
如果您需要对模板部件提供帖子格式支持，这很容易，您仍然可以将content传递给$templatePart，只需将$postFormatSupport设置为true和模板将为帖子格式为content-video.php
video
主要问题
通过相应的过滤器和操作
对主查询进行了以下更改-
为了对主要查询进行分页：
-
通过
$found_posts过滤器 将进样器查询的 -
通过
posts_per_page将用户传递的参数 -
$max_num_pages使用$found_posts和posts_per_page中的帖子数量计算得出。因为页面上is_singular为真，所以它会禁止设置LIMIT子句。简单地将is_singular设置为false会导致一些问题，因此我决定通过LIMIT过滤器设置post_limits子句。我将offset条款的LIMIT设置为0，以避免在分页页面上显示404
found_posts属性值传递给主查询对象的属性值pre_get_posts的值设置为主查询 -
这会照顾分页和注射后可能出现的任何问题
页面对象
当前页面对象可以通过使用页面上的默认循环显示为帖子，单独并在注入的帖子之上。如果您不需要，只需将$removePageFromLoop设置为true，这将隐藏页面内容的显示。
在此阶段，我使用CSS通过loop_start和loop_end操作隐藏页面对象，因为我无法找到另一种方法。使用此方法的缺点是，如果隐藏页面对象，默认情况下，隐藏在主查询中的the_post操作挂钩的任何内容都将被隐藏。
THE CLASS
PreGetPostsForPages类可以改进，并且应该正确地命名空间虽然您可以将其放在主题的函数文件中，但最好将其放入自定义插件中。
根据需要使用，修改和滥用。代码评论很好，所以应该很容易遵循和调整
class PreGetPostsForPages
{
/**
* @var string|int $pageID
* @access protected
* @since 1.0.0
*/
protected $pageID;
/**
* @var string $templatePart
* @access protected
* @since 1.0.0
*/
protected $templatePart;
/**
* @var bool $postFormatSupport
* @access protected
* @since 1.0.0
*/
protected $postFormatSupport;
/**
* @var bool $removePageFromLoop
* @access protected
* @since 1.0.0
*/
protected $removePageFromLoop;
/**
* @var array $args
* @access protected
* @since 1.0.0
*/
protected $args;
/**
* @var array $mergedArgs
* @access protected
* @since 1.0.0
*/
protected $mergedArgs = [];
/**
* @var NULL|\stdClass $injectorQuery
* @access protected
* @since 1.0.0
*/
protected $injectorQuery = NULL;
/**
* @var int $validatedPageID
* @access protected
* @since 1.0.0
*/
protected $validatedPageID = 0;
/**
* Constructor method
*
* @param string|int $pageID The ID of the page we would like to target
* @param string $templatePart The template part which should be used to display posts
* @param string $postFormatSupport Should get_template_part support post format specific template parts
* @param bool $removePageFromLoop Should the page content be displayed or not
* @param array $args An array of valid arguments compatible with WP_Query
*
* @since 1.0.0
*/
public function __construct(
$pageID = NULL,
$templatePart = NULL,
$postFormatSupport = false,
$removePageFromLoop = false,
$args = []
) {
$this->pageID = $pageID;
$this->templatePart = $templatePart;
$this->postFormatSupport = $postFormatSupport;
$this->removePageFromLoop = $removePageFromLoop;
$this->args = $args;
}
/**
* Public method init()
*
* The init method will be use to initialize our pre_get_posts action
*
* @since 1.0.0
*/
public function init()
{
// Initialise our pre_get_posts action
add_action( 'pre_get_posts', [$this, 'preGetPosts'] );
}
/**
* Private method validatePageID()
*
* Validates the page ID passed
*
* @since 1.0.0
*/
private function validatePageID()
{
$validatedPageID = filter_var( $this->pageID, FILTER_VALIDATE_INT );
$this->validatedPageID = $validatedPageID;
}
/**
* Private method mergedArgs()
*
* Merge the default args with the user passed args
*
* @since 1.0.0
*/
private function mergedArgs()
{
// Set default arguments
if ( get_query_var( 'paged' ) ) {
$currentPage = get_query_var( 'paged' );
} elseif ( get_query_var( 'page' ) ) {
$currentPage = get_query_var( 'page' );
} else {
$currentPage = 1;
}
$default = [
'suppress_filters' => true,
'ignore_sticky_posts' => 1,
'paged' => $currentPage,
'posts_per_page' => get_option( 'posts_per_page' ), // Set posts per page here to set the LIMIT clause etc
'nopaging' => false
];
$mergedArgs = wp_parse_args( (array) $this->args, $default );
$this->mergedArgs = $mergedArgs;
}
/**
* Public method preGetPosts()
*
* This is the callback method which will be hooked to the
* pre_get_posts action hook. This method will be used to alter
* the main query on the page specified by ID.
*
* @param \stdClass WP_Query The query object passed by reference
* @since 1.0.0
*/
public function preGetPosts( \WP_Query $q )
{
if ( !is_admin() // Only target the front end
&& $q->is_main_query() // Only target the main query
&& $q->is_page( filter_var( $this->validatedPageID, FILTER_VALIDATE_INT ) ) // Only target our specified page
) {
// Remove the pre_get_posts action to avoid unexpected issues
remove_action( current_action(), [$this, __METHOD__] );
// METHODS:
// Initialize our method which will return the validated page ID
$this->validatePageID();
// Initiale our mergedArgs() method
$this->mergedArgs();
// Initiale our custom query method
$this->injectorQuery();
/**
* We need to alter a couple of things here in order for this to work
* - Set posts_per_page to the user set value in order for the query to
* to properly calculate the $max_num_pages property for pagination
* - Set the $found_posts property of the main query to the $found_posts
* property of our custom query we will be using to inject posts
* - Set the LIMIT clause to the SQL query. By default, on pages, `is_singular`
* returns true on pages which removes the LIMIT clause from the SQL query.
* We need the LIMIT clause because an empty limit clause inhibits the calculation
* of the $max_num_pages property which we need for pagination
*/
if ( $this->mergedArgs['posts_per_page']
&& true !== $this->mergedArgs['nopaging']
) {
$q->set( 'posts_per_page', $this->mergedArgs['posts_per_page'] );
} elseif ( true === $this->mergedArgs['nopaging'] ) {
$q->set( 'posts_per_page', -1 );
}
// FILTERS:
add_filter( 'found_posts', [$this, 'foundPosts'], PHP_INT_MAX, 2 );
add_filter( 'post_limits', [$this, 'postLimits']);
// ACTIONS:
/**
* We can now add all our actions that we will be using to inject our custom
* posts into the main query. We will not be altering the main query or the
* main query's $posts property as we would like to keep full integrity of the
* $post, $posts globals as well as $wp_query->post. For this reason we will use
* post injection
*/
add_action( 'loop_start', [$this, 'loopStart'], 1 );
add_action( 'loop_end', [$this, 'loopEnd'], 1 );
}
}
/**
* Public method injectorQuery
*
* This will be the method which will handle our custom
* query which will be used to
* - return the posts that should be injected into the main
* query according to the arguments passed
* - alter the $found_posts property of the main query to make
* pagination work
*
* @link https://codex.wordpress.org/Class_Reference/WP_Query
* @since 1.0.0
* @return \stdClass $this->injectorQuery
*/
public function injectorQuery()
{
//Define our custom query
$injectorQuery = new \WP_Query( $this->mergedArgs );
$this->injectorQuery = $injectorQuery;
return $this->injectorQuery;
}
/**
* Public callback method foundPosts()
*
* We need to set found_posts in the main query to the $found_posts
* property of the custom query in order for the main query to correctly
* calculate $max_num_pages for pagination
*
* @param string $found_posts Passed by reference by the filter
* @param stdClass \WP_Query Sq The current query object passed by refence
* @since 1.0.0
* @return $found_posts
*/
public function foundPosts( $found_posts, \WP_Query $q )
{
if ( !$q->is_main_query() )
return $found_posts;
remove_filter( current_filter(), [$this, __METHOD__] );
// Make sure that $this->injectorQuery actually have a value and is not NULL
if ( $this->injectorQuery instanceof \WP_Query
&& 0 != $this->injectorQuery->found_posts
)
return $found_posts = $this->injectorQuery->found_posts;
return $found_posts;
}
/**
* Public callback method postLimits()
*
* We need to set the LIMIT clause as it it is removed on pages due to
* is_singular returning true. Witout the limit clause, $max_num_pages stays
* set 0 which avoids pagination.
*
* We will also leave the offset part of the LIMIT cluase to 0 to avoid paged
* pages returning 404's
*
* @param string $limits Passed by reference in the filter
* @since 1.0.0
* @return $limits
*/
public function postLimits( $limits )
{
$posts_per_page = (int) $this->mergedArgs['posts_per_page'];
if ( $posts_per_page
&& -1 != $posts_per_page // Make sure that posts_per_page is not set to return all posts
&& true !== $this->mergedArgs['nopaging'] // Make sure that nopaging is not set to true
) {
$limits = "LIMIT 0, $posts_per_page"; // Leave offset at 0 to avoid 404 on paged pages
}
return $limits;
}
/**
* Public callback method loopStart()
*
* Callback function which will be hooked to the loop_start action hook
*
* @param \stdClass \WP_Query $q Query object passed by reference
* @since 1.0.0
*/
public function loopStart( \WP_Query $q )
{
/**
* Although we run this action inside our preGetPosts methods and
* and inside a main query check, we need to redo the check here aswell
* because failing to do so sets our div in the custom query output as well
*/
if ( !$q->is_main_query() )
return;
/**
* Add inline style to hide the page content from the loop
* whenever $removePageFromLoop is set to true. You can
* alternatively alter the page template in a child theme by removing
* everything inside the loop, but keeping the loop
* Example of how your loop should look like:
* while ( have_posts() ) {
* the_post();
* // Add nothing here
* }
*/
if ( true === $this->removePageFromLoop )
echo '<div style="display:none">';
}
/**
* Public callback method loopEnd()
*
* Callback function which will be hooked to the loop_end action hook
*
* @param \stdClass \WP_Query $q Query object passed by reference
* @since 1.0.0
*/
public function loopEnd( \WP_Query $q )
{
/**
* Although we run this action inside our preGetPosts methods and
* and inside a main query check, we need to redo the check here as well
* because failing to do so sets our custom query into an infinite loop
*/
if ( !$q->is_main_query() )
return;
// See the note in the loopStart method
if ( true === $this->removePageFromLoop )
echo '</div>';
//Make sure that $this->injectorQuery actually have a value and is not NULL
if ( !$this->injectorQuery instanceof \WP_Query )
return;
// Setup a counter as wee need to run the custom query only once
static $count = 0;
/**
* Only run the custom query on the first run of the loop. Any consecutive
* runs (like if the user runs the loop again), the custom posts won't show.
*/
if ( 0 === (int) $count ) {
// We will now add our custom posts on loop_end
$this->injectorQuery->rewind_posts();
// Create our loop
if ( $this->injectorQuery->have_posts() ) {
/**
* Fires before the loop to add pagination.
*
* @since 1.0.0
*
* @param \stdClass $this->injectorQuery Current object (passed by reference).
*/
do_action( 'pregetgostsforgages_before_loop_pagination', $this->injectorQuery );
// Add a static counter for those who need it
static $counter = 0;
while ( $this->injectorQuery->have_posts() ) {
$this->injectorQuery->the_post();
/**
* Fires before get_template_part.
*
* @since 1.0.0
*
* @param int $counter (passed by reference).
*/
do_action( 'pregetgostsforgages_counter_before_template_part', $counter );
/**
* Fires before get_template_part.
*
* @since 1.0.0
*
* @param \stdClass $this->injectorQuery-post Current post object (passed by reference).
* @param \stdClass $this->injectorQuery Current object (passed by reference).
*/
do_action( 'pregetgostsforgages_current_post_and_object', $this->injectorQuery->post, $this->injectorQuery );
/**
* Load our custom template part as set by the user
*
* We will also add template support for post formats. If $this->postFormatSupport
* is set to true, get_post_format() will be automatically added in get_template part
*
* If you have a template called content-video.php, you only need to pass 'content'
* to $template part and then set $this->postFormatSupport to true in order to load
* content-video.php for video post format posts
*/
$part = '';
if ( true === $this->postFormatSupport )
$part = get_post_format( $this->injectorQuery->post->ID );
get_template_part(
filter_var( $this->templatePart, FILTER_SANITIZE_STRING ),
$part
);
/**
* Fires after get_template_part.
*
* @since 1.0.0
*
* @param int $counter (passed by reference).
*/
do_action( 'pregetgostsforgages_counter_after_template_part', $counter );
$counter++; //Update the counter
}
wp_reset_postdata();
/**
* Fires after the loop to add pagination.
*
* @since 1.0.0
*
* @param \stdClass $this->injectorQuery Current object (passed by reference).
*/
do_action( 'pregetgostsforgages_after_loop_pagination', $this->injectorQuery );
}
}
// Update our static counter
$count++;
}
}
USAGE
您现在可以启动课程（也在您的插件或功能文件中），如下所示，定位ID为251的页面，我们将在post每页显示2个帖子发布类型
$query = new PreGetPostsForPages(
251, // Page ID we will target
'content', //Template part which will be used to display posts, name should be without .php extension
true, // Should get_template_part support post formats
false, // Should the page object be excluded from the loop
[ // Array of valid arguments that will be passed to WP_Query/pre_get_posts
'post_type' => 'post',
'posts_per_page' => 2
]
);
$query->init();
添加分页和定制风格
正如我所说，注入器查询中有一些操作可以添加分页或自定义样式。在这里，我使用my own pagination function from the linked answer在循环后添加了分页。此外，使用内置计数器，我添加了一个div来显示我的帖子在两个列中。
以下是我使用的操作
add_action( 'pregetgostsforgages_counter_before_template_part', function ( $counter )
{
$class = $counter%2 ? ' right' : ' left';
echo '<div class="entry-column' . $class . '">';
});
add_action( 'pregetgostsforgages_counter_after_template_part', function ( $counter )
{
echo '</div>';
});
add_action( 'pregetgostsforgages_after_loop_pagination', function ( \WP_Query $q )
{
paginated_numbers();
});
请注意，分页是由主查询设置的，而不是注入器查询，所以像the_posts_pagination()这样的内置函数也应该有效。
这是最终结果
静态前页
静态首页上的所有内容与我的分页功能一起正常工作，而无需进行任何修改
结论
这可能看起来像很多开销，而且可能是，但专业人士超过了骗局的大时间
BIG PRO＆＃39;
-
您无需以任何方式更改特定页面的页面模板。这使得一切都变得动态，并且可以在主题之间轻松转移，而无需修改代码，如果一切都在插件中完成的话。
-
如果您的主题还没有主题，您最多只需要在主题中创建
content.php模板部分 -
任何适用于主查询的分页都可以在页面上运行，不会有任何类型的更改或查询传递给函数的任何额外内容。
现在还有更多我不能想到的专业人士，但这些是重要人物
我希望这将有助于将来的某个人
- 从query_posts中排除“页面”
- WordPress query_posts（）
- WordPress - pre_get_posts代替页面上的query_posts
- Wordpress，不包括带有pre_get_posts的页面
- Wordpress，pre_get_posts中的多个meta_key
- Wordpress'pre_get_posts'没有在ajax上工作？
- pre_get_posts（）阻止页面在WordPress中工作
- 带有pre_get_posts的wp_nav_menu_objects
- WPML Query_posts
- 分页不适用于query_posts函数（查询页面）
- 我写了这段代码，但我无法理解我的错误
- 我无法从一个代码实例的列表中删除 None 值，但我可以在另一个实例中。为什么它适用于一个细分市场而不适用于另一个细分市场？
- 是否有可能使 loadstring 不可能等于打印？卢阿
- java中的random.expovariate()
- Appscript 通过会议在 Google 日历中发送电子邮件和创建活动
- 为什么我的 Onclick 箭头功能在 React 中不起作用？
- 在此代码中是否有使用“this”的替代方法？
- 在 SQL Server 和 PostgreSQL 上查询，我如何从第一个表获得第二个表的可视化
- 每千个数字得到
- 更新了城市边界 KML 文件的来源？