get_terms
函数
get_terms ( $args = array(), $deprecated = '' )
- 参数
-
-
(array|string)
$args
Optional. Array or string of arguments. See WP_Term_Query::__construct() for information on accepted arguments. Default empty array.
- Required: 否
- Default: array()
-
(array|string)
$deprecated
Optional. Argument array, when using the legacy function parameter format. If present, this parameter will be interpreted as `$args`, and the first function parameter will be parsed as a taxonomy or array of taxonomies. Default empty.
- Required: 否
- Default: (empty)
-
(array|string)
$args
Optional. Array or string of arguments. See WP_Term_Query::__construct() for information on accepted arguments. Default empty array.
- 返回值
-
- (WP_Term[]|int[]|string[]|string|WP_Error) Array of terms, a count thereof as a numeric string, or WP_Error if any of the taxonomies do not exist. See the function description for more information.
- 定义位置
-
- wp-includes/taxonomy.php , line 1267
- 引入
- 2.3.0
- 弃用
- -
get_terms: 这个函数为特定的分类法检索一个术语(类别、标签等)对象的数组。它需要两个参数:要检索术语的分类法,以及用于过滤结果的可选参数阵列。它返回一个术语对象的数组。
检索一个给定的分类法或分类法列表中的术语。
你可以在发送查询之前完全注入任何定制的内容,也可以用过滤器控制输出。
返回类型根据传递给`$args[‘fields’]`的值而变化。详情见WP_Term_Query::get_terms()。在所有情况下,如果请求一个无效的分类法,将返回一个`WP_Error’对象。
{@see ‘get_terms’}过滤器将在缓存有术语时被调用,并将找到的术语与$taxonomies数组和$args数组一起传递。这个过滤器也会在传递术语数组之前被调用,并将传递术语数组,以及$taxonomies和$args。
{@see ‘list_terms_exclusions’}过滤器会将编译好的排除项与$args一起传递。
{@see ‘get_terms_orderby’}过滤器将查询的`ORDER BY’子句与$args数组一起传递。
在4.5.0之前,`get_terms()`的第一个参数是一个分类标准或分类标准列表。
$terms = get_terms( ‘post_tag’, array( ‘hide_empty’ => false, ) ) 。
从4.5.0开始,分类法应该通过`$args`数组中的’taxonomy’参数传递。
$terms = get_terms( array( ‘taxonomy’ => ‘post_tag’, ‘hide_empty’ => false, ) ) 。
function get_terms( $args = array(), $deprecated = '' ) {
$term_query = new WP_Term_Query();
$defaults = array(
'suppress_filter' => false,
);
/*
* Legacy argument format ($taxonomy, $args) takes precedence.
*
* We detect legacy argument format by checking if
* (a) a second non-empty parameter is passed, or
* (b) the first parameter shares no keys with the default array (ie, it's a list of taxonomies)
*/
$_args = wp_parse_args( $args );
$key_intersect = array_intersect_key( $term_query->query_var_defaults, (array) $_args );
$do_legacy_args = $deprecated || empty( $key_intersect );
if ( $do_legacy_args ) {
$taxonomies = (array) $args;
$args = wp_parse_args( $deprecated, $defaults );
$args['taxonomy'] = $taxonomies;
} else {
$args = wp_parse_args( $args, $defaults );
if ( isset( $args['taxonomy'] ) && null !== $args['taxonomy'] ) {
$args['taxonomy'] = (array) $args['taxonomy'];
}
}
if ( ! empty( $args['taxonomy'] ) ) {
foreach ( $args['taxonomy'] as $taxonomy ) {
if ( ! taxonomy_exists( $taxonomy ) ) {
return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
}
}
}
// Don't pass suppress_filter to WP_Term_Query.
$suppress_filter = $args['suppress_filter'];
unset( $args['suppress_filter'] );
$terms = $term_query->query( $args );
// Count queries are not filtered, for legacy reasons.
if ( ! is_array( $terms ) ) {
return $terms;
}
if ( $suppress_filter ) {
return $terms;
}
/**
* Filters the found terms.
*
* @since 2.3.0
* @since 4.6.0 Added the `$term_query` parameter.
*
* @param array $terms Array of found terms.
* @param array|null $taxonomies An array of taxonomies if known.
* @param array $args An array of get_terms() arguments.
* @param WP_Term_Query $term_query The WP_Term_Query object.
*/
return apply_filters( 'get_terms', $terms, $term_query->query_vars['taxonomy'], $term_query->query_vars, $term_query );
}
常见问题
FAQs-
如何使用get_users获取所有用户列表?
要使用`
get_users`函数获取所有用户列表,可以按照以下步骤进行:1. 使用`
get_users`函数调用获取用户列表:$users = get_users();
2. 您可以按需使用参数来过滤结果。例如,您可以通过角色、用户ID、用户登录名等过滤用户列表。以下是一个根据用户角色为过滤条件的示例:
$users = get_users( array( 'role' => 'subscriber' // 将角色名称替换为您要过滤的角色 ) );在上述示例中,将`
role`参数设置为所需的角色名称来过滤用户列表。3. 您可以使用循环遍历获取的用户列表,并访问每个用户的属性。例如,以下示例将显示每个用户的用户名和电子邮件地址:
foreach( $users as $user ) { echo '用户名:' . $user->user_login . ', 电子邮件:' . $user->user_email . ; }在上述示例中,通过`
$user->user_login`和`$user->user_email`访问每个用户的用户名和电子邮件地址。请注意,`
get_users`函数默认返回所有用户,并可以根据需要使用更多参数进行过滤。您可以参阅WordPress官方文档中的`get_users`函数文档,了解更多可用参数和用法示例。总结起来,使用`
get_users`函数获取所有用户列表的步骤是:- 调用`
get_users`函数获取用户列表。 - 使用可选的过滤参数,根据需要过滤用户列表。
- 使用循环遍历用户列表,并访问每个用户的属性。
- 调用`
-
如何使用WP_PLUGIN_DIR和WP_PLUGIN_URL定义插件的目录和URL?
在WordPress中,可以使用WP_PLUGIN_DIR和WP_PLUGIN_URL常量来定义插件的目录路径和URL。
1. `WP_PLUGIN_DIR`:这是一个常量,用于定义插件的目录路径(文件系统路径)。您可以使用以下代码在插件文件中访问该常量:
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/';
在上述代码中,将"your-plugin-folder"替换为您插件的实际文件夹名称。使用该常量,您可以获取插件文件的完整路径。
2. `WP_PLUGIN_URL`:这是一个常量,用于定义插件的URL(用于在网页上访问插件文件)。以下是一个使用该常量的示例:
$plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
同样,请将"your-plugin-folder"替换为您插件的实际文件夹名称。使用该常量,您可以获取插件在网页上的完整URL。
请注意,`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量在WordPress版本2.6之后引入。从WordPress 5.5版本开始,这两个常量被标记为过时(deprecated),因为WordPress更倾向于使用新的插件文件结构。如果您正在开发新插件,建议使用新的插件文件结构和相关函数。
在新的插件文件结构中,可以使用以下函数来获取插件的目录路径和URL:
- `plugin_dir_path()`:获取插件目录路径。
- `plugin_dir_url()`:获取插件URL。这些函数会自动将插件的版本、多站点和SSL等考虑因素纳入计算。
总结起来,使用`WP_PLUGIN_DIR`和`WP_PLUGIN_URL`常量定义插件的目录和URL的方法是:
$plugin_dir = WP_PLUGIN_DIR . '/your-plugin-folder/'; $plugin_url = WP_PLUGIN_URL . '/your-plugin-folder/';
但请注意,这两个常量已被标记为过时,建议使用新的插件文件结构和相关函数来获取插件的路径和URL。
-
如何使用PHP在WordPress中添加自定义功能?
使用PHP在WordPress中添加自定义功能可以通过以下方式实现:
- 创建一个自定义插件,将功能代码添加到插件中。
- 使用WordPress的钩子系统,将自定义功能绑定到适当的钩子上。
- 在主题文件中添加自定义功能代码,例如functions.php文件。
- 使用WordPress的短代码功能,将自定义功能封装为短代码。
- 使用WordPress的插件或主题编辑器,将自定义功能代码添加到适当的位置。
下面是一个实操示例。
要在WordPress中添加自定义功能,可以按照以下步骤使用PHP编写并添加自定义功能:
- 打开WordPress安装目录中的主题文件夹,通常位于wp-content/themes/下,找到正在使用的主题文件夹。
- 在主题文件夹中,可以创建一个名为functions.php的文件。如果该文件已经存在,可以直接编辑它。
- 在functions.php文件中,可以使用PHP代码添加自定义功能。以下是一些常见的示例:
// 添加自定义功能示例 // 1. 创建自定义短代码 function custom_shortcode() { return '这是我的自定义短代码内容'; } add_shortcode('custom', 'custom_shortcode'); // 2. 自定义小工具 function custom_widget() { echo '这是我的自定义小工具内容'; } register_widget('custom_widget'); // 3. 自定义菜单 function custom_menu() { register_nav_menu('custom-menu', '自定义菜单'); } add_action('after_setup_theme', 'custom_menu'); // 4. 自定义页面模板 function custom_page_template() { /* Template Name: 自定义模板 */ // 自定义模板的内容和样式 } - 编辑完functions.php文件后,保存并上传到WordPress主题文件夹中。
请注意,修改主题文件可以在主题更新时丢失,因此建议在进行任何更改之前备份functions.php文件。此外,为避免不必要的错误和冲突,建议在添加自定义功能前先了解WordPress开发文档和最佳实践,以确保正确、安全地实现所需的自定义功能。
-
如何进行WordPress数据库查询优化?
-
如何使用do_action来触发一个钩子函数?
使用
do_action函数可以触发一个钩子函数。do_action函数的参数与要触发的钩子函数的参数相同。例如,触发save_post钩子函数的代码如下:
do_action( 'save_post', $post_ID, $post );
这里,
$post_ID和$post是传递给钩子函数的参数。 -
如何使用wp_get_current_user获取当前登录用户的信息?
使用
wp_get_current_user获取当前登录用户的信息:$current_user = wp_get_current_user(); // 获取当前用户的ID $user_id = $current_user->ID; // 获取当前用户的用户名 $user_login = $current_user->user_login; // 获取当前用户的邮箱 $user_email = $current_user->user_email; // 获取当前用户的显示名称 $display_name = $current_user->display_name;
