搜尋

首頁  >  文章  >  CMS教程  >  為前端的 WordPress 貼文清單建立自訂指令

為前端的 WordPress 貼文清單建立自訂指令

王林
王林原創
2023-08-30 08:13:13634瀏覽

重写后的标题为：Creating a Custom Directive for WordPress Post Listing on the Front End

在本系列的前一部分中，我們引導了 AngularJS 應用程序，為不同視圖配置了路由，並圍繞帖子、用戶和類別的路由構建了服務。使用這些服務，我們現在終於能夠從伺服器獲取資料來為前端提供動力。

#在本系列的這一部分中，我們將致力於為帖子列表功能建立自訂 AngularJS 指令。在本系列的當前部分中，我們將：

  • 介紹 AngularJS 指令以及為什麼我們應該創建一個
  • 規劃貼文清單功能的指令及其所需的參數

  • 為貼文清單建立自訂 AngularJS 指令及其範本

#所以讓我們先介紹一下 AngularJS 指令以及為什麼我們需要它們。

#AngularJS 指令簡介

#AngularJS 中的指令是一種修改 HTML 元素行為和重複使用可重複程式碼區塊的方法。它們可用於修改 HTML 元素及其子元素的結構，因此它們是引入自訂 UI 小部件的完美方式。

#在分析本系列第一部分中的線框圖時，我們注意到貼文清單功能在三個視圖中使用，即：

  1. 發布清單
  2. 作者簡介

  3. 類別貼文清單

因此，我們可以建立一個自訂 AngularJS 指令，其中包含使用我們在本系列前面部分創建的服務來檢索帖子的業務邏輯，而不是編寫單獨的功能來列出這三個頁面上的帖子。除了業務邏輯之外，指令還將包含在某些視圖上列出貼文的渲染邏輯。在該指令中也定義了貼文分頁和根據某些條件檢索貼文的功能。

#因此，為帖子列表功能建立自訂AngularJS 指令允許我們僅在一個位置定義該功能，這將使我們將來更容易擴展或修改此功能，而無需更改其中的程式碼使用它的所有三個實例。

#話雖如此，讓我們開始為帖子列表功能編寫自訂指令。

#規劃貼文清單的自訂 AngularJS 指令

在我們開始編寫用於建立貼文清單功能指令的任何程式碼之前，讓我們先分析一下指令中所需的功能。

#在最基本的層面上，我們需要一個可以在貼文清單、作者個人資料和類別頁面的視圖上使用的指令。這意味著我們將創建一個放置在 HTML 中的自訂 UI 小部件（或 DOM 標記），AngularJS 將根據我們為指令的特定實例提供的選項來處理其餘的事情。

#因此，我們將建立一個由以下標記標識的自訂 UI 小工具：

<post-listing></post-listing>

但是我們還需要這個指令是靈活的，即將參數作為輸入並採取相應的行動。考慮使用者個人資料頁面，我們只希望顯示屬於該特定使用者的帖子，或類別頁面，其中將列出屬於該類別的帖子。這些參數可以透過以下兩種方式提供：

  1. 在 URL 中作為參數
  2. 直接將指令當作屬性值

#在 URL 中提供參數似乎是 API 的本機，因為我們已經熟悉這樣做了。因此，用戶可以透過以下方式檢索屬於特定用戶的一組貼文：

https://127.0.0.1:8080/#/posts?author=1

上述功能可以透過AngularJS提供的$routeParams服務來實現。我們可以在此處存取使用者在 URL 中提供的參數。我們在本系列的前一部分中註冊路由時已經研究過它。

#至於直接向指令提供參數作為屬性值，我們可以使用以下內容：

<post-listing post-args="{author=1}"></post-listing>

上面程式碼片段中的 post-args 屬性採用參數來檢索一組特定的帖子，目前它採用作者 ID。此屬性可以採用任意數量的參數來檢索 /wp/v2/posts 路由支援的貼文。因此，如果我們要檢索由 ID 為 1 且屬於 ID 10 類別的使用者撰寫的一組帖子，我們可以執行以下操作：

<post-listing post-args="{author=1, filter[cat]=10}"></post-listing>

上述程式碼中的 filter[cat] 參數用於檢索屬於某個類別的一組貼文。

#分頁也是使用貼文清單頁面時的基本功能。該指令將處理後分頁，並​​且此功能將由伺服器傳回的 X-WP-Total 和 X-WP-TotalPages 標頭的值驅動與回應主體。因此，用戶將能夠在上一組貼文和下一組貼文之間來回導航。

確定了用於發布清單的自訂指令的實質內容後，我們現在已經有了相當堅實的基礎來開始編寫程式碼。

#為帖子列表建立自訂指令

#為貼文清單功能建立指令包含兩個步驟：

  1. 创建用于检索帖子和处理其他内容的业务逻辑。
  2. 为这些帖子创建一个渲染视图以显示在页面上。

我们的自定义指令的业务逻辑将在指令声明中处理。为了在 DOM 上呈现数据，我们将创建一个用于列出帖子的自定义模板。让我们从指令声明开始。

指令声明

AngularJS 中的指令可以使用以下语法为模块声明：

/**
 * Creating a custom directive for posts listing
 */
quiescentApp.directive( 'postListing', [function() {
    return {

    };
}] );

在这里，我们使用模块中可用的 .directive() 方法在模块上声明指令。该方法将指令的名称作为第一个参数，并且该名称与元素标签的名称密切相关。由于我们希望 HTML 元素为 <post-listing></post-listing>，因此我们提供了标签名称的驼峰式表示形式。您可以在官方文档中了解有关 AngularJS 执行的规范化过程以匹配指令名称的更多信息。

我们在上面的代码中使用的用于声明指令的符号称为安全样式的依赖注入。在这种表示法中，我们提供了一个依赖项数组作为指令所需的第二个参数。目前，我们尚未为自定义指令定义任何依赖项。但由于我们需要 Posts 服务来检索帖子（我们在本系列的上一部分中创建的）以及本机 AngularJS 的 $routeParams 和 $location服务用于访问URL参数和当前路径，我们定义如下：

/**
 * Creating a custom directive for posts listing
 */
quiescentApp.directive( 'postListing', ['$routeParams', '$location', 'Posts', function( $routeParams, $location, Posts ) {
    return {
        restrict: 'E',
        scope: {
            postArgs: '='
        },
        link: function( $scope, $elem, $attr ) {
        
        }
    };
}] );

然后，这些依赖项可供定义为数组最后一个元素的函数使用。该函数返回一个包含指令定义的对象。目前，我们在指令定义对象中有两个属性，即 restrict 和 link。

restrict 选项定义了我们在代码中使用指令的方式，该选项可以有四个可能的值：

  1. A：用于将指令用作现有 HTML 元素的属性。
  2. E：用于使用指令作为元素名称。

  3. C：用于使用指令作为类名。

  4. M：用于将该指令用作 HTML 注释。

restrict 选项也可以接受上述四个值的任意组合。

由于我们希望指令成为新元素 <post-listing></post-listing>，因此我们将限制选项设置为 E。如果我们要使用预先存在的 HTML 元素上的属性来定义指令，那么我们可以将此选项设置为 A。在这种情况下，我们可以使用 在 HTML 代码中定义该指令。

第二个 <code class="inline">scope 属性用于修改指令的范围。默认情况下， <code class="inline">scope 属性的值为 false，这意味着指令的范围与其父级的范围相同。当我们向它传递一个对象时，会为该指令创建一个隔离的范围，并且需要由其父级传递给该指令的任何数据都通过 HTML 属性传递。这就是我们在代码中所做的，我们使用的属性是 post-args，它被标准化为 postArgs。

p>

<code class="inline">scope 对象中的 postArgs 属性可以接受以下三个值中的任意一个：

  1. =：表示传递给属性的值将被视为对象。
  2. @：这意味着传递到属性的值将被视为纯字符串。

  3. &：表示传递给属性的值将被视为函数。

由于我们选择使用 = 值，因此传递到 post-args 属性的任何值都将被视为 JSON 对象，我们可以使用该对象作为检索帖子的参数。

第三个属性 link 用于定义一个函数，该函数用于操作 DOM 并定义该指令所需的 API 和函数。该函数是处理指令所有逻辑的地方。

link 函数接受作用域对象、指令的 HTML 元素以及指令的 HTML 元素上定义的属性的对象的参数。目前，我们分别为范围对象和 HTML 元素传递两个参数 $scope 和 $elem 。

让我们在 $scope 属性上定义一些变量，我们将使用该变量在 DOM 上呈现帖子列表功能。

/**
 * Creating a custom directive for posts listing
 */
quiescentApp.directive( 'postListing', ['$routeParams', '$location', 'Posts', function( $routeParams, $location, Posts ) {
    return {
        restrict: 'E',
        scope: {
            postArgs: '='
        },
        link: function( $scope, $elem, $attr ) {
            // defining variables on the $scope object
            $scope.posts = [];
            $scope.postHeaders = {};
            $scope.currentPage = $routeParams.page ? Math.abs( $routeParams.page ) : 1;
            $scope.nextPage = null;
            $scope.previousPage = null;
            $scope.routeContext = $location.path();
        }
    };
}] );

因此，我们在 $scope 对象上定义了六个属性，我们可以在 DOM 中访问它们。这些属性是：

  1. $posts：保存服务器返回的 post 对象的数组。
  2. $postHeaders：用于保存服务器将与响应正文一起返回的标头的对象。我们将使用它们来处理导航。

  3. $currentPage：保存当前页码的整型变量。

  4. $previousPage：保存上一页页码的变量。

  5. $nextPage：保存下一页编号的变量。

  6. $routeContext：用于使用 $location 服务访问当前路径。

我们之前为 HTML 属性定义的 postArgs 属性已在指令内的 $scope 对象上可用。

现在我们准备使用 Posts 服务向服务器发出请求以检索帖子。但在此之前，我们必须考虑用户作为 URL 参数提供的参数以及 post-args 属性中提供的参数。为此，我们将创建一个函数，使用 $routeParams 服务来提取 URL 参数，并将它们与通过 post-args 属性提供的参数合并： p> 

/**
 * Creating a custom directive for posts listing
 */
quiescentApp.directive( 'postListing', ['$routeParams', '$location', 'Posts', function( $routeParams, $location, Posts ) {
    return {
        restrict: 'E',
        scope: {
            postArgs: '='
        },
        link: function( $scope, $elem, $attr ) {
            // defining variables on the $scope object
            $scope.posts = [];
            $scope.postHeaders = {};
            $scope.currentPage = $routeParams.page ? Math.abs( $routeParams.page ) : 1;
            $scope.nextPage = null;
            $scope.previousPage = null;
            $scope.routeContext = $location.path();
            
            // preparing query arguments
            var prepareQueryArgs = function() {
                var tempParams = $routeParams;
                delete tempParams.id;
                return angular.merge( {}, $scope.postArgs, tempParams );
            };
        }
    };
}] );

上述代码中的 prepareQueryArgs() 方法使用 angular.merge() 方法，该方法扩展了 $scope。 postArgs 对象与 $routeParams 对象。但在合并这两个对象之前，它首先使用 delete 运算符从 $routeParams 对象中删除 id 属性。这是必要的，因为我们将在类别和用户视图上使用此指令，并且我们不希望类别和用户 ID 被错误地解释为帖子 ID。

准备好查询参数后，我们终于准备好调用服务器并检索帖子，我们使用 Posts.query() 方法来执行此操作，该方法采用两个参数：

  1. 包含用于进行查询的参数的对象。
  2. 查询完成后执行的回调函数。

因此，我们将使用 prepareQueryArgs() 函数为查询参数准备一个对象，并在回调函数中设置 上某些变量的值$scope 属性：

// make the request and query posts
Posts.query( prepareQueryArgs(), function( data, headers ) {
    $scope.posts = data;
    $scope.postHeaders = headers();
    $scope.previousPage = ( ( $scope.currentPage + 1 ) > $scope.postHeaders['x-wp-totalpages'] ) ? null : ( $scope.currentPage + 1 );
    $scope.nextPage = ( ( $scope.currentPage - 1 ) > 0 ) ? ( $scope.currentPage - 1 ) : null;
});

回调函数获取响应正文和响应标头的两个参数。这些分别由 data 和 headers 参数表示。

headers 参数是一个函数，它返回一个包含服务器响应标头的对象。

剩下的代码非常不言自明，因为我们正在设置 $scope.posts 数组的值。为了设置 $scope.previousPage 和 $scope.nextPage 变量的值，我们使用 x-wp-totalpages 属性postHeaders 对象。

现在我们准备使用指令的自定义模板在前端渲染这些数据。

为指令创建自定义模板

为了使我们的指令发挥作用，我们需要做的最后一件事是为帖子列表制作一个单独的模板并将其链接到指令。为此，我们需要修改指令声明并包含 templateUrl 属性，如下所示：

/**
 * Creating a custom directive for posts listing
 */
quiescentApp.directive( 'postListing', ['$routeParams', '$location', 'Posts', function( $routeParams, $location, Posts ) {
    return {
        restrict: 'E',
        scope: {
            postArgs: '='
        },
        templateUrl: 'views/directive-post-listing.html',
        link: function( $scope, $elem, $attr ) {
        
        }
    };
}] );

上面代码中的 templateUrl 属性引用了 views 目录中名为 directive-post-listing.html 的文件。因此，在 views 文件夹中创建此文件并粘贴以下 HTML 代码：

<!-- post listing starts -->
<article class="post-entry">
    <h2 class="post-title"><a href="post-single.html">Good design is a lot like clear thinking made visual.</a></h2>
    <figure class="post-thumbnail">
        <img src="img/img-712-348.jpg" alt="Featured Image">
    </figure>
    <p class="post-meta">
        By <a href="author.html">Bilal Shahid</a> in <a href="category.html">Quotes</a>
    </p>
    <div class="post-content">
        <p>Created days forth. Dominion. Subdue very hath spirit us sixth fish creepeth also. First meat one forth above. You'll Fill for. Can't evening one lights won't. Great of make firmament image. Life his beginning blessed lesser meat spirit blessed seas created green great beginning can't doesn't void moving. Subdue evening make spirit lesser greater all living green firmament winged saw tree one divide wherein divided shall dry very lesser saw, earth the. Light their the.</p>
    </div>
</article>
<!-- post listing ends -->


<!-- pagination links start -->
<div class="post-pagination">
    <a href="#" class="button">Older Posts</a>
    <a href="#" class="button">Newer Posts</a>
</div>		
<!-- pagination links end -->

这是非常基本的 HTML 代码，表示单个帖子条目和帖子分页。我已从 views/listing.html 文件中复制了它。我们将使用一些 AngularJS 指令，包括 ng-repeat、ng-href、ng-src 和 ng -bind-html，显示当前驻留在指令的 $scope 属性中的数据。

将 HTML 代码修改为以下内容：

<!-- post listing starts -->
<article class="post-entry" ng-repeat="post in posts">
    <h2 class="post-title"><a ng-href="#/posts/{{post.slug}}">{{post.title.rendered}}</a></h2>
    <figure class="post-thumbnail" ng-show="post.quiescent_featured_image">
        <img ng-src="{{post.quiescent_featured_image}}" alt="Featured Image">
    </figure>
    <p class="post-meta">
        By <a ng-href="#/users/{{post.author}}">{{post.quiescent_author_name}}</a> 
        in <a ng-href="#/categories/{{category.term_id}}" ng-repeat="category in post.quiescent_categories">{{category.name}}{{$last ? '' : ', '}}</a>
    </p>
    <div class="post-content" ng-bind-html="post.excerpt.rendered"></div>
    </article>
<!-- post listing ends -->

上面的代码使用 ng-repeat 指令来迭代 $scope.posts 数组。指令声明中 $scope 对象上定义的任何属性都可以直接在模板中使用。因此，我们在模板中将 $scope.posts 数组直接引用为 posts 。

通过使用 ng-repeat 指令，我们确保 article.post-entry 容器将在 中的每个帖子中重复posts 数组，每个帖子在内循环中被称为 post 。这个 post 对象包含服务器返回的 JSON 格式的数据，包含帖子标题、帖子 ID、帖子内容和特色图像链接等属性，这是同伴添加的附加字段插件。

在下一步中，我们将帖子标题、帖子链接和特色图像链接等值替换为 post 对象中的属性。

对于分页，将之前的代码替换为以下代码：

<!-- pagination links start -->
<div class="post-pagination">
    <a ng-href="#{{routeContext}}?page={{nextPage}}" class="button" ng-class="{'disabled': !nextPage}">Newer Posts</a>
    <a ng-href="#{{routeContext}}?page={{previousPage}}" class="button" ng-class="{'disabled': !previousPage}">Older Posts</a>
</div>		
<!-- pagination links end -->

我们首先访问我们在指令声明中定义的 routeContext 属性，并使用 ?page= 参数作为后缀，并使用 nextPage 和 previousPage 变量用于在帖子之间来回导航。我们还检查下一页或上一页链接是否不是 null，否则我们将 .disabled 类添加到 Zurb Foundation 提供的按钮。

现在我们已经完成了该指令，是时候对其进行测试了。我们通过在 HTML 中放置一个 &lt;post-listing&gt;&lt;/post-listing&gt; 标签来实现这一点，最好位于 <footer></footer> 的上方标签。这样做意味着帖子列表将出现在页脚上方。不要担心格式和样式，我们将在本系列的下一部分中处理它们。

这就是为帖子列表功能创建自定义 AngularJS 指令的过程。

接下来会发生什么？

在有关使用 WP REST API 和 AngularJS 创建前端的系列的当前部分中，我们为帖子列表功能构建了一个自定义 AngularJS 指令。该指令使用我们在本系列前面部分创建的 Posts 服务。该指令还以 HTML 属性和 URL 参数的形式获取用户输入。

在本系列的最后部分，我们将开始研究项目的最后一部分，即帖子、用户和类别的控制器及其各自的模板。

以上是為前端的 WordPress 貼文清單建立自訂指令的詳細內容。更多資訊請關注PHP中文網其他相關文章！

陳述：
本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn
上一篇：頂級免費 JavaScript 圖表庫下一篇：頂級免費 JavaScript 圖表庫

相關文章

看更多