get_attached_file

函数
get_attached_file ( $attachment_id, $unfiltered = false )
参数
  • (int) $attachment_id Attachment ID.
    Required:
  • (bool) $unfiltered Optional. Whether to apply filters. Default false.
    Required:
    Default: false
返回值
  • (string|false) The file path to where the attached file should be, false otherwise.
定义位置
相关方法
update_attached_fileget_attached_mediaget_the_titleget_attachment_linkget_attachment_icon
引入
2.0.0
弃用
-

get_attached_file: 这个函数返回给定附件ID的附件文件的路径。

根据附件ID检索附件文件的路径。

默认情况下,路径将通过”get_attached_file”过滤器,但给get_attached_file()的$unfiltered参数传递一个true将返回未过滤的文件路径。

该函数的工作原理是获取单一的文章元名称,命名为’_wp_attached_file’并返回它: 这是一个方便的函数,以防止查找元名称,并提供一个机制,通过过滤器发送附件文件名。

function get_attached_file( $attachment_id, $unfiltered = false ) {
	$file = get_post_meta( $attachment_id, '_wp_attached_file', true );

	// If the file is relative, prepend upload dir.
	if ( $file ) {
		$uploads = wp_get_upload_dir();

		if ( false === $uploads['error'] ) {
			$file = path_join( $uploads['basedir'], $file );
		}
	}

	if ( $unfiltered ) {
		return $file;
	}

	/**
	 * Filters the attached file based on the given ID.
	 *
	 * @since 2.1.0
	 *
	 * @param string|false $file          The file path to where the attached file should be, false otherwise.
	 * @param int          $attachment_id Attachment ID.
	 */
	return apply_filters( 'get_attached_file', $file, $attachment_id );
}

常见问题

FAQs
查看更多 >