retrieve_widgets

函数


      retrieve_widgets ( $theme_changed = false )

参数

(string|bool) $theme_changed Whether the theme was changed as a boolean. A value of 'customize' defers updates for the Customizer.

Required: 否

Default: false

返回值

(array) Updated sidebars widgets.

定义位置

wp-includes/widgets.php , line 1313

相关方法: register_widget the_widget unregister_widget is_active_widget wp_render_widget

引入: 2.8.0

弃用: -

retrieve_widgets: 这是一个WordPress的函数，用来检索特定侧边栏的小工具。小工具是一些小的内容块，可以添加到网站的不同区域，如侧边栏。 retrieve_widgets检索已经添加到一个特定侧边栏的小工具。

验证并重新映射任何”orphaned”小工具到wp_inactive_widgets侧边栏，并保存小工具设置。这至少要在每次更换主题时运行。

例如，假设主题A有一个”footer”侧边栏，而主题B没有。从主题A切换到主题B后，所有之前分配给页脚的小工具都将无法使用: 这个函数可以检测到这种情况，并将之前分配给页脚的所有小工具移到wp_inactive_widgets下。

尽管名字中有”retrieve”一词，这个函数实际上是在更新数据库和全局的`$sidebars_widgets`。由于这个原因，它不应该在前端运行，除非`$theme_changed`的值是’customize’（以绕过数据库的写入）。

function retrieve_widgets( $theme_changed = false ) {
	global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets;

	$registered_sidebars_keys = array_keys( $wp_registered_sidebars );
	$registered_widgets_ids   = array_keys( $wp_registered_widgets );

	if ( ! is_array( get_theme_mod( 'sidebars_widgets' ) ) ) {
		if ( empty( $sidebars_widgets ) ) {
			return array();
		}

		unset( $sidebars_widgets['array_version'] );

		$sidebars_widgets_keys = array_keys( $sidebars_widgets );
		sort( $sidebars_widgets_keys );
		sort( $registered_sidebars_keys );

		if ( $sidebars_widgets_keys === $registered_sidebars_keys ) {
			$sidebars_widgets = _wp_remove_unregistered_widgets( $sidebars_widgets, $registered_widgets_ids );

			return $sidebars_widgets;
		}
	}

	// Discard invalid, theme-specific widgets from sidebars.
	$sidebars_widgets = _wp_remove_unregistered_widgets( $sidebars_widgets, $registered_widgets_ids );
	$sidebars_widgets = wp_map_sidebars_widgets( $sidebars_widgets );

	// Find hidden/lost multi-widget instances.
	$shown_widgets = array_merge( ...array_values( $sidebars_widgets ) );
	$lost_widgets  = array_diff( $registered_widgets_ids, $shown_widgets );

	foreach ( $lost_widgets as $key => $widget_id ) {
		$number = preg_replace( '/.+?-([0-9]+)$/', '$1', $widget_id );

		// Only keep active and default widgets.
		if ( is_numeric( $number ) && (int) $number < 2 ) {
			unset( $lost_widgets[ $key ] );
		}
	}
	$sidebars_widgets['wp_inactive_widgets'] = array_merge( $lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets'] );

	if ( 'customize' !== $theme_changed ) {
		// Update the widgets settings in the database.
		wp_set_sidebars_widgets( $sidebars_widgets );
	}

	return $sidebars_widgets;
}

常见问题

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 `函数获取所有用户列表的步骤是：
1. 调用` get_users `函数获取用户列表。
2. 使用可选的过滤参数，根据需要过滤用户列表。
3. 使用循环遍历用户列表，并访问每个用户的属性。
如何使用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编写并添加自定义功能：
1. 打开WordPress安装目录中的主题文件夹，通常位于wp-content/themes/下，找到正在使用的主题文件夹。
2. 在主题文件夹中，可以创建一个名为functions.php的文件。如果该文件已经存在，可以直接编辑它。
3. 在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: 自定义模板 */
    // 自定义模板的内容和样式
}
```
4. 编辑完functions.php文件后，保存并上传到WordPress主题文件夹中。
请注意，修改主题文件可以在主题更新时丢失，因此建议在进行任何更改之前备份functions.php文件。此外，为避免不必要的错误和冲突，建议在添加自定义功能前先了解WordPress开发文档和最佳实践，以确保正确、安全地实现所需的自定义功能。
如何进行WordPress数据库查询优化？
进行WordPress数据库查询优化可以通过以下方式实现：
- 使用WordPress提供的内置查询函数，例如 WP_Query 、 get_posts 等。
- 使用适当的查询参数和过滤器，减少查询次数和数据量。
- 编写自定义的数据库查询语句，使用适当的索引和缓存。
- 优化数据库服务器配置和性能。
- 定期清理和优化数据库表。
如何使用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;

retrieve_widgets

常见问题

相关文章