wp_stream_image

函数


      wp_stream_image ( $image, $mime_type, $attachment_id )

参数

(WP_Image_Editor) $image The image editor instance.

Required: 是
(string) $mime_type The mime type of the image.

Required: 是
(int) $attachment_id The image's attachment post ID.

Required: 是

返回值

(bool) True on success, false on failure.

定义位置

wp-admin/includes/image-edit.php , line 295

相关方法: wp_save_image wp_crop_image wp_restore_image wp_load_image stream_preview_image

引入: 2.9.0

弃用: -

wp_stream_image: 它检索了一个流图像: 该函数为一个给定的URL检索图像流。

将WP_image_Editor中的图像流式传输到浏览器。

function wp_stream_image( $image, $mime_type, $attachment_id ) {
	if ( $image instanceof WP_Image_Editor ) {

		/**
		 * Filters the WP_Image_Editor instance for the image to be streamed to the browser.
		 *
		 * @since 3.5.0
		 *
		 * @param WP_Image_Editor $image         The image editor instance.
		 * @param int             $attachment_id The attachment post ID.
		 */
		$image = apply_filters( 'image_editor_save_pre', $image, $attachment_id );

		if ( is_wp_error( $image->stream( $mime_type ) ) ) {
			return false;
		}

		return true;
	} else {
		/* translators: 1: $image, 2: WP_Image_Editor */
		_deprecated_argument( __FUNCTION__, '3.5.0', sprintf( __( '%1$s needs to be a %2$s object.' ), '$image', 'WP_Image_Editor' ) );

		/**
		 * Filters the GD image resource to be streamed to the browser.
		 *
		 * @since 2.9.0
		 * @deprecated 3.5.0 Use {@see 'image_editor_save_pre'} instead.
		 *
		 * @param resource|GdImage $image         Image resource to be streamed.
		 * @param int              $attachment_id The attachment post ID.
		 */
		$image = apply_filters_deprecated( 'image_save_pre', array( $image, $attachment_id ), '3.5.0', 'image_editor_save_pre' );

		switch ( $mime_type ) {
			case 'image/jpeg':
				header( 'Content-Type: image/jpeg' );
				return imagejpeg( $image, null, 90 );
			case 'image/png':
				header( 'Content-Type: image/png' );
				return imagepng( $image );
			case 'image/gif':
				header( 'Content-Type: image/gif' );
				return imagegif( $image );
			case 'image/webp':
				if ( function_exists( 'imagewebp' ) ) {
					header( 'Content-Type: image/webp' );
					return imagewebp( $image, null, 90 );
				}
				return false;
			default:
				return false;
		}
	}
}

常见问题

FAQs

钩子函数和过滤器函数的主要区别是什么？
钩子函数和过滤器函数的主要区别是它们的行为方式。钩子函数是在特定的时间点被调用的函数，它们可以执行各种任务，但通常不会返回值。而过滤器函数则是对特定的值进行过滤和修改的函数，它们会接收一个值作为输入，然后返回一个新的值作为输出。

钩子函数（Hooks）和过滤器函数（Filters）是用于修改和扩展WordPress（和其他编程环境）功能的核心概念。它们的主要区别在于它们的用途和工作方式。

1. 钩子函数（Hooks）：
- 用途：钩子函数用于在特定时机执行自定义代码。它们提供了一种将自定义功能插入到程序执行过程中的方法。
- 工作方式：主要分为两种类型，动作（Actions）和过滤器（Filters）。动作钩子允许您在特定事件发生时执行代码，而过滤器钩子允许您修改数据或结果并返回修改后的值。
2. 过滤器函数（Filters）：
- 用途：过滤器函数用于修改或过滤数据，通常是在数据输出前对其进行处理或修改。
- 工作方式：过滤器函数接受一个输入值，并返回一个经过修改后的输出值。它们可以用于修改文本、替换内容、修改HTML标记等。
主要区别在于它们的目的和使用场景：
- 钩子函数（Hooks）用于在特定事件发生时执行自定义代码，它们常用于添加新功能、执行操作或触发其他事件。它们更关注对程序执行流程的控制。
- 过滤器函数（Filters）用于修改或过滤数据，通常用于修改页面内容、数据存储或输出结果。它们更关注在给定的数据或结果上进行处理和修改。
重要的是要理解钩子函数和过滤器函数在编程环境中的作用，以便正确使用它们来实现自定义功能和修改数据。
如何使用apply_filters来应用一个过滤器函数？
apply_filters 函数用于调用一个钩子上的所有过滤器函数。它的基本用法如下：
```
$value = apply_filters( 'hook_name', $value, $var1, $var2, ... );
```
其中：

'hook_name' 是你要应用过滤器函数的钩子名称。
$value 是你要传递给过滤器函数的值。
$var1, $var2, … 是你要传递给过滤器函数的其他参数。
常量的命名规则和约定是什么？
常量的命名有一些约定和规则。首先，常量的名称应该全部大写，用下划线分隔单词。例如，MY_CONSTANT_NAME。其次，常量的名称应该是有意义的，能够清晰地描述常量的用途或值。最后，避免使用已经被PHP或WordPress定义的常量名称，以避免冲突。

在WordPress中，常量的命名规则和约定如下：
1. 全大写字母：WordPress中的常量通常以全大写字母表示，例如： ABSPATH 。
2. 使用下划线分隔单词：常量的单词之间使用下划线 _ 进行分隔，例如： WP_DEBUG .
3. 常量的前缀：建议为常量添加一个特定的前缀以避免与其他常量或变量发生冲突。例如，WordPress核心常量通常使用前缀 WP_ ，例如： WP_CONTENT_DIR 。
4. 描述性命名：常量的名称应该具有描述性，以便能够清楚地表达其用途和含义。这有助于提高代码的可读性和可维护性。
5. 避免硬编码：常量的作用是提供一个不可更改的值，因此应避免在代码中直接硬编码常量的值。相反，应该通过定义常量并赋予其一个有意义的值来使用它们。
例如，以下是符合WordPress常量命名规则的示例：
```
define( 'WP_DEBUG', true );
define( 'WP_CONTENT_DIR', '/var/www/html/wp-content' );
define( 'MY_CUSTOM_CONSTANT', 'Hello World' );
```
遵循这些命名规则和约定可以帮助保持代码的一致性和可读性，使得WordPress主题或插件更易于理解、维护和扩展。
如何使用WordPress REST API？
要使用WordPress REST API，可以按照以下步骤进行操作：
1. 检查WordPress版本：确保你使用的WordPress版本在4.7或更高，因为REST API是从该版本开始集成到WordPress核心中的。
2. 启用REST API：默认情况下，WordPress REST API已经启用。如果你需要确认是否启用，可以访问WordPress的后台管理页面，转到“设置” > “固定链接” ，然后确保“常规设置”中的“启用REST API”选项被勾选。
3. 授权和身份验证：REST API通常需要进行身份验证。你可以使用OAuth、基本身份验证（用户名和密码）或cookie进行身份验证。根据你的需求选择合适的身份验证方式。
4. 使用REST API终点：WordPress REST API提供了各种终点（endpoints），用于执行不同的操作，如检索帖子、页面、分类目录、评论等。你可以通过GET、POST、PUT、DELETE等请求方法与这些终点进行交互。
  - 例如，要获取帖子列表，可以发出GET请求到`/wp-json/wp/v2/posts`。
  - 要获取特定帖子的详细信息，例如ID为1的帖子，可以发出GET请求到`/wp-json/wp/v2/posts/1`。
  - 要创建新的帖子，可以发出POST请求到`/wp-json/wp/v2/posts`并提供所需的参数。
5. 处理响应数据：REST API通常返回JSON格式的数据。你可以使用编程语言、HTTP客户端或浏览器工具来处理和解析返回的JSON数据。
这些是使用WordPress REST API的基本步骤。你可以根据具体需求进行深入学习和实践，探索更多可用的终点和功能。对于详细的API文档和参考，请查阅WordPress官方文档或REST API官方手册。
钩子函数可以在哪些地方使用？
在WordPress中，钩子函数可以在以下几个地方使用：
1. 插件（Plugins）：WordPress的插件是一种扩展机制，允许开发者在WordPress的核心功能之上添加自定义功能。插件可以使用钩子函数来注册和处理特定的WordPress事件或动作。例如，可以使用`add_action()`函数来注册在特定动作点（action hooks）上执行的钩子函数，或使用` add_filter() `函数注册在特定过滤器（filter hooks）上执行的钩子函数。
2. 主题（Themes）：WordPress的主题是用于控制网站外观和功能的模板系统。开发者可以在主题中使用钩子函数来修改主题输出的内容或行为。例如，可以使用` add_action() `函数在特定的动作点上添加自定义内容，或使用` add_filter() `函数修改主题函数的输出。
3. 自定义功能文件（Custom Functions File）：可以在主题文件夹或子主题文件夹中创建一个名为` functions.php `的文件，用于添加自定义功能和修改WordPress行为。该文件中可以使用钩子函数来注册特定的动作点和过滤器，并添加相应的钩子函数来处理这些事件。
4. WordPress核心文件：尽管不推荐修改WordPress核心文件，但在某些情况下，可以通过修改核心文件的方式使用钩子函数。例如，可以在WordPress核心文件中的特定位置添加自定义的` do_action() `或` apply_filters() `函数调用，然后在需要的地方注册相应的钩子函数。
总结起来，WordPress中的钩子函数可以在插件、主题、自定义功能文件以及WordPress核心文件中使用，用于注册和处理特定的WordPress事件或动作。这允许开发者在这些地方插入自定义逻辑，以实现个性化的功能和修改WordPress的行为。
如何使用wp_insert_post插入新的文章？
wp_insert_post() 函数用于插入新的文章。你需要传递一个关联数组，包含文章的各项参数，如标题、内容、分类等。例如：
```
$post_data = array(  
    'post_title' => '新的文章',  
    'post_content' => '这是一篇新的文章。',  
    'post_status' => 'publish', // 设置为 'publish' 以立即发布文章  
    'post_type' => 'post', // 也可以设置为 'page' 或其他自定义的文章类型  
);  
$post_id = wp_insert_post($post_data);
```
如果你想要插入更复杂的文章，例如包含多个分类或标签，你可以在 $post_data 数组中添加更多的键值对。

wp_stream_image

常见问题

相关文章